include/basegfx/point/b3dpoint.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_POINT_B3DPOINT_HXX
  21 #define INCLUDED_BASEGFX_POINT_B3DPOINT_HXX
  22
  23 #include <basegfx/tuple/b3dtuple.hxx>
  24 #include <basegfx/basegfxdllapi.h>
  25
  26 namespace basegfx
  27 {
  28     class B3DHomMatrix;
  29
  30     /** Base Point class with three double values
  31
  32         This class derives all operators and common handling for
  33         a 3D data class from B3DTuple. All necessary extensions
  34         which are special for points will be added here.
  35
  36         @see B3DTuple
  37     */
  38     class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC B3DPoint : public ::basegfx::B3DTuple
  39     {
  40     public:
  41         /** Create a 3D Point
  42
  43             The point is initialized to (0.0, 0.0, 0.0)
  44         */
  45         B3DPoint()
  46         :   B3DTuple()
  47         {}
  48
  49         /** Create a 3D Point
  50
  51             @param fX
  52             This parameter is used to initialize the X-coordinate
  53             of the 3D Point.
  54
  55             @param fY
  56             This parameter is used to initialize the Y-coordinate
  57             of the 3D Point.
  58
  59             @param fZ
  60             This parameter is used to initialize the Z-coordinate
  61             of the 3D Point.
  62         */
  63         B3DPoint(double fX, double fY, double fZ)
  64         :   B3DTuple(fX, fY, fZ)
  65         {}
  66
  67         /** Create a copy of a 3D Point
  68
  69             @param rVec
  70             The 3D Point which will be copied.
  71         */
  72         B3DPoint(const B3DPoint& rVec)
  73         :   B3DTuple(rVec)
  74         {}
  75
  76         /** constructor with tuple to allow copy-constructing
  77             from B3DTuple-based classes
  78         */
  79         B3DPoint(const ::basegfx::B3DTuple& rTuple)
  80         :   B3DTuple(rTuple)
  81         {}
  82
  83         /** *=operator to allow usage from B3DPoint, too
  84         */
  85         B3DPoint& operator*=( const B3DPoint& rPnt )
  86         {
  87             mfX *= rPnt.mfX;
  88             mfY *= rPnt.mfY;
  89             mfZ *= rPnt.mfZ;
  90             return *this;
  91         }
  92
  93         /** *=operator to allow usage from B3DPoint, too
  94         */
  95         B3DPoint& operator*=(double t)
  96         {
  97             mfX *= t;
  98             mfY *= t;
  99             mfZ *= t;
 100             return *this;
 101         }
 102
 103         /** assignment operator to allow assigning the results
 104             of B3DTuple calculations
 105         */
 106         B3DPoint& operator=( const ::basegfx::B3DTuple& rVec )
 107         {
 108             mfX = rVec.getX();
 109             mfY = rVec.getY();
 110             mfZ = rVec.getZ();
 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 B3DVector, applied.
 118         */
 119         B3DPoint& operator*=( const ::basegfx::B3DHomMatrix& rMat );
 120     };
 121
 122     // external operators
 123
 124
 125     /** Transform B3DPoint by given transformation matrix.
 126
 127         Since this is a Point, translational components of the
 128         matrix are used.
 129     */
 130     BASEGFX_DLLPUBLIC B3DPoint operator*( const B3DHomMatrix& rMat, const B3DPoint& rPoint );
 131
 132 } // end of namespace basegfx
 133
 134 #endif // INCLUDED_BASEGFX_POINT_B3DPOINT_HXX
 135
 136 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */