include/basegfx/point/b2ipoint.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 <basegfx/tuple/b2ituple.hxx>
  23
  24 namespace basegfx
  25 {
  26     class B2DHomMatrix;
  27
  28     /** Base Point class with two sal_Int32 values
  29
  30         This class derives all operators and common handling for
  31         a 2D data class from B2ITuple. All necessary extensions
  32         which are special for points will be added here.
  33
  34         @see B2ITuple
  35     */
  36     class SAL_WARN_UNUSED B2IPoint : public ::basegfx::B2ITuple
  37     {
  38     public:
  39         /** Create a 2D Point
  40
  41             The point is initialized to (0, 0)
  42         */
  43         B2IPoint()
  44         {}
  45
  46         /** Create a 2D Point
  47
  48             @param nX
  49             This parameter is used to initialize the X-coordinate
  50             of the 2D Point.
  51
  52             @param nY
  53             This parameter is used to initialize the Y-coordinate
  54             of the 2D Point.
  55         */
  56         B2IPoint(sal_Int32 nX, sal_Int32 nY)
  57         :   B2ITuple(nX, nY)
  58         {}
  59
  60         /** constructor with tuple to allow copy-constructing
  61             from B2ITuple-based classes
  62         */
  63         B2IPoint(const ::basegfx::B2ITuple& rTuple)
  64         :   B2ITuple(rTuple)
  65         {}
  66
  67         /** *=operator to allow usage from B2IPoint, too
  68         */
  69         B2IPoint& operator*=( const B2IPoint& rPnt )
  70         {
  71             mnX *= rPnt.mnX;
  72             mnY *= rPnt.mnY;
  73             return *this;
  74         }
  75
  76         /** *=operator to allow usage from B2IPoint, too
  77         */
  78         B2IPoint& operator*=(sal_Int32 t)
  79         {
  80             mnX *= t;
  81             mnY *= t;
  82             return *this;
  83         }
  84
  85         /** assignment operator to allow assigning the results
  86             of B2ITuple calculations
  87         */
  88         B2IPoint& operator=( const ::basegfx::B2ITuple& rPoint );
  89
  90         /** Transform point by given transformation matrix.
  91
  92             The translational components of the matrix are, in
  93             contrast to B2DVector, applied.
  94         */
  95         B2IPoint& operator*=( const ::basegfx::B2DHomMatrix& rMat );
  96     };
  97 } // end of namespace basegfx
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */