include/basegfx/tuple/b2i64tuple.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_BASEGFX_TUPLE_B2I64TUPLE_HXX
  21 #define INCLUDED_BASEGFX_TUPLE_B2I64TUPLE_HXX
  22
  23 #include <sal/types.h>
  24 #include <basegfx/tuple/b2dtuple.hxx>
  25 #include <basegfx/basegfxdllapi.h>
  26
  27
  28 namespace basegfx
  29 {
  30     /** Base class for all Points/Vectors with two sal_Int64 values
  31
  32         This class provides all methods common to Point
  33         avd Vector classes which are derived from here.
  34
  35         @derive Use this class to implement Points or Vectors
  36         which are based on two sal_Int64 values
  37     */
  38     class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC B2I64Tuple
  39     {
  40     protected:
  41         sal_Int64                                       mnX;
  42         sal_Int64                                       mnY;
  43
  44     public:
  45         /** Create a 2D Tuple
  46
  47             The tuple is initialized to (0, 0)
  48         */
  49         B2I64Tuple()
  50         :   mnX(0),
  51             mnY(0)
  52         {}
  53
  54         /** Create a 2D Tuple
  55
  56             @param fX
  57             This parameter is used to initialize the X-coordinate
  58             of the 2D Tuple.
  59
  60             @param fY
  61             This parameter is used to initialize the Y-coordinate
  62             of the 2D Tuple.
  63         */
  64         B2I64Tuple(sal_Int64 fX, sal_Int64 fY)
  65         :   mnX( fX ),
  66             mnY( fY )
  67         {}
  68
  69         /** Create a copy of a 2D Tuple
  70
  71             @param rTup
  72             The 2D Tuple which will be copied.
  73         */
  74         B2I64Tuple(const B2I64Tuple& rTup)
  75         :   mnX( rTup.mnX ),
  76             mnY( rTup.mnY )
  77         {}
  78
  79         ~B2I64Tuple()
  80         {}
  81
  82         /// Get X-Coordinate of 2D Tuple
  83         sal_Int64 getX() const
  84         {
  85             return mnX;
  86         }
  87
  88         /// Get Y-Coordinate of 2D Tuple
  89         sal_Int64 getY() const
  90         {
  91             return mnY;
  92         }
  93
  94         /// Array-access to 2D Tuple
  95         const sal_Int64& operator[] (int nPos) const
  96         {
  97             // Here, normally one if(...) should be used. In the assumption that
  98             // both sal_Int64 members can be accessed as an array a shortcut is used here.
  99             // if(0 == nPos) return mnX; return mnY;
 100             return *((&mnX) + nPos);
 101         }
 102
 103         /// Array-access to 2D Tuple
 104         sal_Int64& operator[] (int nPos)
 105         {
 106             // Here, normally one if(...) should be used. In the assumption that
 107             // both sal_Int64 members can be accessed as an array a shortcut is used here.
 108             // if(0 == nPos) return mnX; return mnY;
 109             return *((&mnX) + nPos);
 110         }
 111
 112         // operators
 113
 114
 115         B2I64Tuple& operator+=( const B2I64Tuple& rTup )
 116         {
 117             mnX += rTup.mnX;
 118             mnY += rTup.mnY;
 119             return *this;
 120         }
 121
 122         B2I64Tuple& operator-=( const B2I64Tuple& rTup )
 123         {
 124             mnX -= rTup.mnX;
 125             mnY -= rTup.mnY;
 126             return *this;
 127         }
 128
 129         B2I64Tuple& operator/=( const B2I64Tuple& rTup )
 130         {
 131             mnX /= rTup.mnX;
 132             mnY /= rTup.mnY;
 133             return *this;
 134         }
 135
 136         B2I64Tuple& operator*=( const B2I64Tuple& rTup )
 137         {
 138             mnX *= rTup.mnX;
 139             mnY *= rTup.mnY;
 140             return *this;
 141         }
 142
 143         B2I64Tuple& operator*=(sal_Int64 t)
 144         {
 145             mnX *= t;
 146             mnY *= t;
 147             return *this;
 148         }
 149
 150         B2I64Tuple& operator/=(sal_Int64 t)
 151         {
 152             mnX /= t;
 153             mnY /= t;
 154             return *this;
 155         }
 156
 157         B2I64Tuple operator-(void) const
 158         {
 159             return B2I64Tuple(-mnX, -mnY);
 160         }
 161
 162         bool operator==( const B2I64Tuple& rTup ) const
 163         {
 164             return this == &rTup || (rTup.mnX == mnX && rTup.mnY == mnY);
 165         }
 166
 167         bool operator!=( const B2I64Tuple& rTup ) const
 168         {
 169             return !(*this == rTup);
 170         }
 171
 172         B2I64Tuple& operator=( const B2I64Tuple& rTup )
 173         {
 174             mnX = rTup.mnX;
 175             mnY = rTup.mnY;
 176             return *this;
 177         }
 178     };
 179
 180 } // end of namespace basegfx
 181
 182 #endif // INCLUDED_BASEGFX_TUPLE_B2I64TUPLE_HXX
 183
 184 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */