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/basegfxdllapi.h>
  25
  26
  27 namespace basegfx
  28 {
  29     /** Base class for all Points/Vectors with two sal_Int64 values
  30
  31         This class provides all methods common to Point
  32         avd Vector classes which are derived from here.
  33
  34         @derive Use this class to implement Points or Vectors
  35         which are based on two sal_Int64 values
  36     */
  37     class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC B2I64Tuple final
  38     {
  39         sal_Int64                                       mnX;
  40         sal_Int64                                       mnY;
  41
  42     public:
  43         /** Create a 2D Tuple
  44
  45             The tuple is initialized to (0, 0)
  46         */
  47         B2I64Tuple()
  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         B2I64Tuple(sal_Int64 fX, sal_Int64 fY)
  63         :   mnX( fX ),
  64             mnY( fY )
  65         {}
  66
  67         /** Create a copy of a 2D Tuple
  68
  69             @param rTup
  70             The 2D Tuple which will be copied.
  71         */
  72         B2I64Tuple(const B2I64Tuple& rTup)
  73         :   mnX( rTup.mnX ),
  74             mnY( rTup.mnY )
  75         {}
  76
  77         /// Get X-Coordinate of 2D Tuple
  78         sal_Int64 getX() const
  79         {
  80             return mnX;
  81         }
  82
  83         /// Get Y-Coordinate of 2D Tuple
  84         sal_Int64 getY() const
  85         {
  86             return mnY;
  87         }
  88
  89         /// Array-access to 2D Tuple
  90         const sal_Int64& operator[] (int nPos) const
  91         {
  92             // Here, normally one if(...) should be used. In the assumption that
  93             // both sal_Int64 members can be accessed as an array a shortcut is used here.
  94             // if(0 == nPos) return mnX; return mnY;
  95             return *((&mnX) + nPos);
  96         }
  97
  98         /// Array-access to 2D Tuple
  99         sal_Int64& operator[] (int nPos)
 100         {
 101             // Here, normally one if(...) should be used. In the assumption that
 102             // both sal_Int64 members can be accessed as an array a shortcut is used here.
 103             // if(0 == nPos) return mnX; return mnY;
 104             return *((&mnX) + nPos);
 105         }
 106
 107         // operators
 108
 109
 110         B2I64Tuple& operator+=( const B2I64Tuple& rTup )
 111         {
 112             mnX += rTup.mnX;
 113             mnY += rTup.mnY;
 114             return *this;
 115         }
 116
 117         B2I64Tuple& operator-=( const B2I64Tuple& rTup )
 118         {
 119             mnX -= rTup.mnX;
 120             mnY -= rTup.mnY;
 121             return *this;
 122         }
 123
 124         B2I64Tuple& operator/=( const B2I64Tuple& rTup )
 125         {
 126             mnX /= rTup.mnX;
 127             mnY /= rTup.mnY;
 128             return *this;
 129         }
 130
 131         B2I64Tuple& operator*=( const B2I64Tuple& rTup )
 132         {
 133             mnX *= rTup.mnX;
 134             mnY *= rTup.mnY;
 135             return *this;
 136         }
 137
 138         B2I64Tuple& operator*=(sal_Int64 t)
 139         {
 140             mnX *= t;
 141             mnY *= t;
 142             return *this;
 143         }
 144
 145         B2I64Tuple& operator/=(sal_Int64 t)
 146         {
 147             mnX /= t;
 148             mnY /= t;
 149             return *this;
 150         }
 151
 152         B2I64Tuple operator-(void) const
 153         {
 154             return B2I64Tuple(-mnX, -mnY);
 155         }
 156
 157         bool operator==( const B2I64Tuple& rTup ) const
 158         {
 159             return this == &rTup || (rTup.mnX == mnX && rTup.mnY == mnY);
 160         }
 161
 162         bool operator!=( const B2I64Tuple& rTup ) const
 163         {
 164             return !(*this == rTup);
 165         }
 166
 167         B2I64Tuple& operator=( const B2I64Tuple& rTup )
 168         {
 169             mnX = rTup.mnX;
 170             mnY = rTup.mnY;
 171             return *this;
 172         }
 173     };
 174
 175 } // end of namespace basegfx
 176
 177 #endif // INCLUDED_BASEGFX_TUPLE_B2I64TUPLE_HXX
 178
 179 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */