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