include/basegfx/tuple/b2ituple.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_B2ITUPLE_HXX
  21 #define INCLUDED_BASEGFX_TUPLE_B2ITUPLE_HXX
  22
  23 #include <sal/types.h>
  24 #include <basegfx/basegfxdllapi.h>
  25
  26 namespace basegfx
  27 {
  28     /** Base class for all Points/Vectors with two sal_Int32 values
  29
  30         This class provides all methods common to Point
  31         avd Vector classes which are derived from here.
  32
  33         @derive Use this class to implement Points or Vectors
  34         which are based on two sal_Int32 values
  35     */
  36     class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC B2ITuple
  37     {
  38     protected:
  39         sal_Int32                                       mnX;
  40         sal_Int32                                       mnY;
  41
  42     public:
  43         /** Create a 2D Tuple
  44
  45             The tuple is initialized to (0, 0)
  46         */
  47         B2ITuple()
  48         :   mnX(0),
  49             mnY(0)
  50         {}
  51
  52         /** Create a 2D Tuple
  53
  54             @param fX
  55             This parameter is used to initialize the X-coordinate
  56             of the 2D Tuple.
  57
  58             @param fY
  59             This parameter is used to initialize the Y-coordinate
  60             of the 2D Tuple.
  61         */
  62         B2ITuple(sal_Int32 fX, sal_Int32 fY)
  63         :   mnX( fX ),
  64             mnY( fY )
  65         {}
  66
  67         /// Get X-Coordinate of 2D Tuple
  68         sal_Int32 getX() const
  69         {
  70             return mnX;
  71         }
  72
  73         /// Get Y-Coordinate of 2D Tuple
  74         sal_Int32 getY() const
  75         {
  76             return mnY;
  77         }
  78
  79         /// Set X-Coordinate of 2D Tuple
  80         void setX(sal_Int32 fX)
  81         {
  82             mnX = fX;
  83         }
  84
  85         /// Set Y-Coordinate of 2D Tuple
  86         void setY(sal_Int32 fY)
  87         {
  88             mnY = fY;
  89         }
  90
  91         /// Array-access to 2D Tuple
  92         const sal_Int32& operator[] (int nPos) const
  93         {
  94             // Here, normally one if(...) should be used. In the assumption that
  95             // both sal_Int32 members can be accessed as an array a shortcut is used here.
  96             // if(0 == nPos) return mnX; return mnY;
  97             return *((&mnX) + nPos);
  98         }
  99
 100         /// Array-access to 2D Tuple
 101         sal_Int32& operator[] (int nPos)
 102         {
 103             // Here, normally one if(...) should be used. In the assumption that
 104             // both sal_Int32 members can be accessed as an array a shortcut is used here.
 105             // if(0 == nPos) return mnX; return mnY;
 106             return *((&mnX) + nPos);
 107         }
 108
 109         // operators
 110
 111
 112         B2ITuple& operator+=( const B2ITuple& rTup )
 113         {
 114             mnX += rTup.mnX;
 115             mnY += rTup.mnY;
 116             return *this;
 117         }
 118
 119         B2ITuple& operator-=( const B2ITuple& rTup )
 120         {
 121             mnX -= rTup.mnX;
 122             mnY -= rTup.mnY;
 123             return *this;
 124         }
 125
 126         B2ITuple& operator/=( const B2ITuple& rTup )
 127         {
 128             mnX /= rTup.mnX;
 129             mnY /= rTup.mnY;
 130             return *this;
 131         }
 132
 133         B2ITuple& operator*=( const B2ITuple& rTup )
 134         {
 135             mnX *= rTup.mnX;
 136             mnY *= rTup.mnY;
 137             return *this;
 138         }
 139
 140         B2ITuple& operator*=(sal_Int32 t)
 141         {
 142             mnX *= t;
 143             mnY *= t;
 144             return *this;
 145         }
 146
 147         B2ITuple& operator/=(sal_Int32 t)
 148         {
 149             mnX /= t;
 150             mnY /= t;
 151             return *this;
 152         }
 153
 154         B2ITuple operator-(void) const
 155         {
 156             return B2ITuple(-mnX, -mnY);
 157         }
 158
 159         bool equalZero() const
 160         {
 161             return mnX == 0 && mnY == 0;
 162         }
 163
 164         bool operator==( const B2ITuple& rTup ) const
 165         {
 166             return this == &rTup || (rTup.mnX == mnX && rTup.mnY == mnY);
 167         }
 168
 169         bool operator!=( const B2ITuple& rTup ) const
 170         {
 171             return !(*this == rTup);
 172         }
 173     };
 174
 175     // external operators
 176
 177
 178     inline B2ITuple operator+(const B2ITuple& rTupA, const B2ITuple& rTupB)
 179     {
 180         B2ITuple aSum(rTupA);
 181         aSum += rTupB;
 182         return aSum;
 183     }
 184
 185     inline B2ITuple operator-(const B2ITuple& rTupA, const B2ITuple& rTupB)
 186     {
 187         B2ITuple aSub(rTupA);
 188         aSub -= rTupB;
 189         return aSub;
 190     }
 191
 192     inline B2ITuple operator*(sal_Int32 t, const B2ITuple& rTup)
 193     {
 194         B2ITuple aNew(rTup);
 195         aNew *= t;
 196         return aNew;
 197     }
 198
 199 } // end of namespace basegfx
 200
 201 #endif // INCLUDED_BASEGFX_TUPLE_B2ITUPLE_HXX
 202
 203 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */