include/basegfx/tuple/b3ituple.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_B3ITUPLE_HXX
  21 #define INCLUDED_BASEGFX_TUPLE_B3ITUPLE_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 three 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 three sal_Int32 values
  35     */
  36     class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC B3ITuple
  37     {
  38     protected:
  39         sal_Int32                                       mnX;
  40         sal_Int32                                       mnY;
  41         sal_Int32                                       mnZ;
  42
  43     public:
  44         /** Create a 3D Tuple
  45
  46             The tuple is initialized to (0, 0, 0)
  47         */
  48         B3ITuple()
  49         :   mnX(0),
  50             mnY(0),
  51             mnZ(0)
  52         {}
  53
  54         /** Create a 3D Tuple
  55
  56             @param nX
  57             This parameter is used to initialize the X-coordinate
  58             of the 3D Tuple.
  59
  60             @param nY
  61             This parameter is used to initialize the Y-coordinate
  62             of the 3D Tuple.
  63
  64             @param nZ
  65             This parameter is used to initialize the Z-coordinate
  66             of the 3D Tuple.
  67         */
  68         B3ITuple(sal_Int32 nX, sal_Int32 nY, sal_Int32 nZ)
  69         :   mnX(nX),
  70             mnY(nY),
  71             mnZ(nZ)
  72         {}
  73
  74         /// get X-Coordinate of 3D Tuple
  75         sal_Int32 getX() const
  76         {
  77             return mnX;
  78         }
  79
  80         /// get Y-Coordinate of 3D Tuple
  81         sal_Int32 getY() const
  82         {
  83             return mnY;
  84         }
  85
  86         /// Array-access to 3D Tuple
  87         const sal_Int32& operator[] (int nPos) const
  88         {
  89             // Here, normally two if(...)'s should be used. In the assumption that
  90             // both sal_Int32 members can be accessed as an array a shortcut is used here.
  91             // if(0 == nPos) return mnX; if(1 == nPos) return mnY; return mnZ;
  92             return *((&mnX) + nPos);
  93         }
  94
  95         /// Array-access to 3D Tuple
  96         sal_Int32& operator[] (int nPos)
  97         {
  98             // Here, normally two if(...)'s should be used. In the assumption that
  99             // both sal_Int32 members can be accessed as an array a shortcut is used here.
 100             // if(0 == nPos) return mnX; if(1 == nPos) return mnY; return mnZ;
 101             return *((&mnX) + nPos);
 102         }
 103
 104         // operators
 105
 106
 107         B3ITuple& operator+=( const B3ITuple& rTup )
 108         {
 109             mnX += rTup.mnX;
 110             mnY += rTup.mnY;
 111             mnZ += rTup.mnZ;
 112             return *this;
 113         }
 114
 115         B3ITuple& operator-=( const B3ITuple& rTup )
 116         {
 117             mnX -= rTup.mnX;
 118             mnY -= rTup.mnY;
 119             mnZ -= rTup.mnZ;
 120             return *this;
 121         }
 122
 123         B3ITuple& operator/=( const B3ITuple& rTup )
 124         {
 125             mnX /= rTup.mnX;
 126             mnY /= rTup.mnY;
 127             mnZ /= rTup.mnZ;
 128             return *this;
 129         }
 130
 131         B3ITuple& operator*=( const B3ITuple& rTup )
 132         {
 133             mnX *= rTup.mnX;
 134             mnY *= rTup.mnY;
 135             mnZ *= rTup.mnZ;
 136             return *this;
 137         }
 138
 139         B3ITuple& operator*=(sal_Int32 t)
 140         {
 141             mnX *= t;
 142             mnY *= t;
 143             mnZ *= t;
 144             return *this;
 145         }
 146
 147         B3ITuple& operator/=(sal_Int32 t)
 148         {
 149             mnX /= t;
 150             mnY /= t;
 151             mnZ /= t;
 152             return *this;
 153         }
 154
 155         B3ITuple operator-(void) const
 156         {
 157             return B3ITuple(-mnX, -mnY, -mnZ);
 158         }
 159
 160         bool operator==( const B3ITuple& rTup ) const
 161         {
 162             return this == &rTup || (rTup.mnX == mnX && rTup.mnY == mnY && rTup.mnZ == mnZ);
 163         }
 164
 165         bool operator!=( const B3ITuple& rTup ) const
 166         {
 167             return !(*this == rTup);
 168         }
 169     };
 170
 171 } // end of namespace basegfx
 172
 173 #endif // INCLUDED_BASEGFX_TUPLE_B3ITUPLE_HXX
 174
 175 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */