include/basegfx/tuple/b2ituple.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/Tuple2D.hxx>
  25
  26 namespace basegfx
  27 {
  28     /** Base class for all Points/Vectors with two 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 two sal_Int32 values
  35     */
  36     class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC B2ITuple : public Tuple2D<sal_Int32>
  37     {
  38     public:
  39         /** Create a 2D Tuple
  40
  41             The tuple is initialized to (0, 0)
  42         */
  43         B2ITuple()
  44             : Tuple2D(0, 0)
  45         {}
  46
  47         /** Create a 2D Tuple
  48
  49             @param nX
  50             This parameter is used to initialize the X-coordinate
  51             of the 2D Tuple.
  52
  53             @param nY
  54             This parameter is used to initialize the Y-coordinate
  55             of the 2D Tuple.
  56         */
  57         B2ITuple(sal_Int32 nX, sal_Int32 nY)
  58             : Tuple2D(nX, nY)
  59         {}
  60
  61         // operators
  62
  63         B2ITuple operator-(void) const
  64         {
  65             return B2ITuple(-mnX, -mnY);
  66         }
  67     };
  68
  69     // external operators
  70
  71
  72     inline B2ITuple operator+(const B2ITuple& rTupA, const B2ITuple& rTupB)
  73     {
  74         B2ITuple aSum(rTupA);
  75         aSum += rTupB;
  76         return aSum;
  77     }
  78
  79     inline B2ITuple operator-(const B2ITuple& rTupA, const B2ITuple& rTupB)
  80     {
  81         B2ITuple aSub(rTupA);
  82         aSub -= rTupB;
  83         return aSub;
  84     }
  85
  86     inline B2ITuple operator*(sal_Int32 t, const B2ITuple& rTup)
  87     {
  88         B2ITuple aNew(rTup);
  89         aNew *= t;
  90         return aNew;
  91     }
  92
  93 } // end of namespace basegfx
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */