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 #pragma once
  21
  22 #include <sal/types.h>
  23 #include <basegfx/basegfxdllapi.h>
  24 #include <basegfx/tuple/Tuple3D.hxx>
  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         and 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 : public Tuple3D<sal_Int32>
  37     {
  38     public:
  39         /** Create a 3D Tuple
  40
  41             The tuple is initialized to (0, 0, 0)
  42         */
  43         B3ITuple()
  44             : Tuple3D(0, 0, 0)
  45         {}
  46
  47         /** Create a 3D Tuple
  48
  49             @param nX
  50             This parameter is used to initialize the X-coordinate
  51             of the 3D Tuple.
  52
  53             @param nY
  54             This parameter is used to initialize the Y-coordinate
  55             of the 3D Tuple.
  56
  57             @param nZ
  58             This parameter is used to initialize the Z-coordinate
  59             of the 3D Tuple.
  60         */
  61         B3ITuple(sal_Int32 nX, sal_Int32 nY, sal_Int32 nZ)
  62             : Tuple3D(nX, nY, nZ)
  63         {}
  64
  65         /// Array-access to 3D Tuple
  66         const sal_Int32& operator[] (int nPos) const
  67         {
  68             // Here, normally two if(...)'s should be used. In the assumption that
  69             // both sal_Int32 members can be accessed as an array a shortcut is used here.
  70             // if(0 == nPos) return mnX; if(1 == nPos) return mnY; return mnZ;
  71             return *((&mnX) + nPos);
  72         }
  73
  74         /// Array-access to 3D Tuple
  75         sal_Int32& operator[] (int nPos)
  76         {
  77             // Here, normally two if(...)'s should be used. In the assumption that
  78             // both sal_Int32 members can be accessed as an array a shortcut is used here.
  79             // if(0 == nPos) return mnX; if(1 == nPos) return mnY; return mnZ;
  80             return *((&mnX) + nPos);
  81         }
  82
  83         // operators
  84
  85         B3ITuple operator-(void) const
  86         {
  87             return B3ITuple(-mnX, -mnY, -mnZ);
  88         }
  89     };
  90
  91 } // end of namespace basegfx
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */