include/basegfx/tuple/Tuple3D.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  */
  10
  11 #pragma once
  12
  13 namespace basegfx
  14 {
  15 template <typename TYPE> class Tuple3D
  16 {
  17 protected:
  18     TYPE mnX;
  19     TYPE mnY;
  20     TYPE mnZ;
  21
  22 public:
  23     /** Create a 3D Tuple
  24
  25             @param x
  26             This parameter is used to initialize the X-coordinate
  27             of the 3D Tuple.
  28
  29             @param y
  30             This parameter is used to initialize the Y-coordinate
  31             of the 3D Tuple.
  32
  33             @param z
  34             This parameter is used to initialize the Z-coordinate
  35             of the 3D Tuple.
  36         */
  37     Tuple3D(TYPE x, TYPE y, TYPE z)
  38         : mnX(x)
  39         , mnY(y)
  40         , mnZ(z)
  41     {
  42     }
  43
  44     /// Get X-Coordinate of 3D Tuple
  45     TYPE getX() const { return mnX; }
  46
  47     /// Get Y-Coordinate of 3D Tuple
  48     TYPE getY() const { return mnY; }
  49
  50     /// Get Z-Coordinate of 3D Tuple
  51     TYPE getZ() const { return mnZ; }
  52
  53     /// Set X-Coordinate of 3D Tuple
  54     void setX(TYPE fX) { mnX = fX; }
  55
  56     /// Set Y-Coordinate of 3D Tuple
  57     void setY(TYPE fY) { mnY = fY; }
  58
  59     /// Set Z-Coordinate of 3D Tuple
  60     void setZ(TYPE fZ) { mnZ = fZ; }
  61
  62     // operators
  63
  64     Tuple3D& operator+=(const Tuple3D& rTup)
  65     {
  66         mnX += rTup.mnX;
  67         mnY += rTup.mnY;
  68         mnZ += rTup.mnZ;
  69         return *this;
  70     }
  71
  72     Tuple3D& operator-=(const Tuple3D& rTup)
  73     {
  74         mnX -= rTup.mnX;
  75         mnY -= rTup.mnY;
  76         mnZ -= rTup.mnZ;
  77         return *this;
  78     }
  79
  80     Tuple3D& operator/=(const Tuple3D& rTup)
  81     {
  82         mnX /= rTup.mnX;
  83         mnY /= rTup.mnY;
  84         mnZ /= rTup.mnZ;
  85         return *this;
  86     }
  87
  88     Tuple3D& operator*=(const Tuple3D& rTup)
  89     {
  90         mnX *= rTup.mnX;
  91         mnY *= rTup.mnY;
  92         mnZ *= rTup.mnZ;
  93         return *this;
  94     }
  95
  96     Tuple3D& operator*=(TYPE t)
  97     {
  98         mnX *= t;
  99         mnY *= t;
 100         mnZ *= t;
 101         return *this;
 102     }
 103
 104     Tuple3D& operator/=(TYPE t)
 105     {
 106         mnX /= t;
 107         mnY /= t;
 108         mnZ /= t;
 109         return *this;
 110     }
 111
 112     bool operator==(const Tuple3D& rTup) const
 113     {
 114         return mnX == rTup.mnX && mnY == rTup.mnY && mnZ == rTup.mnZ;
 115     }
 116
 117     bool operator!=(const Tuple3D& rTup) const { return !operator==(rTup); }
 118 };
 119
 120 } // end of namespace basegfx
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */