include/basegfx/point/b2dpoint.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 <ostream>
  23
  24 #include <basegfx/tuple/b2dtuple.hxx>
  25 #include <basegfx/point/b2ipoint.hxx>
  26 #include <basegfx/vector/b2dsize.hxx>
  27 #include <basegfx/basegfxdllapi.h>
  28
  29 namespace basegfx
  30 {
  31     class B2DHomMatrix;
  32
  33     /** Base Point class with two double values
  34
  35         This class derives all operators and common handling for
  36         a 2D data class from B2DTuple. All necessary extensions
  37         which are special for points will be added here.
  38
  39         @see B2DTuple
  40     */
  41     class SAL_WARN_UNUSED B2DPoint : public ::basegfx::B2DTuple
  42     {
  43     public:
  44         /** Create a 2D Point
  45
  46             The point is initialized to (0.0, 0.0)
  47         */
  48         B2DPoint()
  49         {}
  50
  51         /** Create a 2D Point
  52
  53             @param fX
  54             This parameter is used to initialize the X-coordinate
  55             of the 2D Point.
  56
  57             @param fY
  58             This parameter is used to initialize the Y-coordinate
  59             of the 2D Point.
  60         */
  61         B2DPoint(double fX, double fY)
  62         :   B2DTuple(fX, fY)
  63         {}
  64
  65         /** Create a copy of a 2D Point
  66
  67             @param rPoint
  68             The 2D Point which will be copied.
  69         */
  70         explicit B2DPoint(const ::basegfx::B2IPoint& rPoint)
  71         :   B2DTuple(rPoint)
  72         {}
  73
  74         /** constructor with tuple to allow copy-constructing
  75             from B2DTuple-based classes
  76         */
  77         B2DPoint(Tuple2D<double> const& rTuple)
  78         :   B2DTuple(rTuple)
  79         {}
  80
  81         /** create a point from a size object */
  82         explicit B2DPoint(Size2D<double> const& rSize)
  83             : B2DTuple(rSize.getWidth(), rSize.getHeight())
  84         {}
  85
  86         /** *=operator to allow usage from B2DPoint, too
  87         */
  88         B2DPoint& operator*=( const B2DPoint& rPnt )
  89         {
  90             mfX *= rPnt.mfX;
  91             mfY *= rPnt.mfY;
  92             return *this;
  93         }
  94
  95         /** *=operator to allow usage from B2DPoint, too
  96         */
  97         B2DPoint& operator*=(double t)
  98         {
  99             mfX *= t;
 100             mfY *= t;
 101             return *this;
 102         }
 103
 104         /** assignment operator to allow assigning the results
 105             of B2DTuple calculations
 106         */
 107         BASEGFX_DLLPUBLIC B2DPoint& operator=(Tuple2D<double>& rPoint)
 108         {
 109             mfX = rPoint.getX();
 110             mfY = rPoint.getY();
 111             return *this;
 112         }
 113
 114         /** Transform point by given transformation matrix.
 115
 116             The translational components of the matrix are, in
 117             contrast to B2DVector, applied.
 118         */
 119         BASEGFX_DLLPUBLIC B2DPoint& operator*=( const ::basegfx::B2DHomMatrix& rMat );
 120
 121         static const B2DPoint& getEmptyPoint()
 122         {
 123             return static_cast<const B2DPoint&>( ::basegfx::B2DTuple::getEmptyTuple() );
 124         }
 125     };
 126
 127     // external operators
 128
 129     /** Transform B2DPoint by given transformation matrix.
 130
 131         Since this is a Point, translational components of the
 132         matrix are used.
 133     */
 134     BASEGFX_DLLPUBLIC B2DPoint operator*( const B2DHomMatrix& rMat, const B2DPoint& rPoint );
 135
 136     template< typename charT, typename traits >
 137     inline std::basic_ostream<charT, traits> & operator <<(
 138         std::basic_ostream<charT, traits> & stream, const B2DPoint& point )
 139     {
 140         return stream << "(" << point.getX() << "," << point.getY() << ")";
 141     }
 142
 143 } // end of namespace basegfx
 144
 145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */