| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef _BGFX_POINT_B3DPOINT_HXX |
| #define _BGFX_POINT_B3DPOINT_HXX |
| |
| #include <basegfx/tuple/b3dtuple.hxx> |
| |
| namespace basegfx |
| { |
| // predeclaration |
| class B3DHomMatrix; |
| |
| /** Base Point class with three double values |
| |
| This class derives all operators and common handling for |
| a 3D data class from B3DTuple. All necessary extensions |
| which are special for points will be added here. |
| |
| @see B3DTuple |
| */ |
| class B3DPoint : public ::basegfx::B3DTuple |
| { |
| public: |
| /** Create a 3D Point |
| |
| The point is initialized to (0.0, 0.0, 0.0) |
| */ |
| B3DPoint() |
| : B3DTuple() |
| {} |
| |
| /** Create a 3D Point |
| |
| @param fX |
| This parameter is used to initialize the X-coordinate |
| of the 3D Point. |
| |
| @param fY |
| This parameter is used to initialize the Y-coordinate |
| of the 3D Point. |
| |
| @param fZ |
| This parameter is used to initialize the Z-coordinate |
| of the 3D Point. |
| */ |
| B3DPoint(double fX, double fY, double fZ) |
| : B3DTuple(fX, fY, fZ) |
| {} |
| |
| /** Create a copy of a 3D Point |
| |
| @param rVec |
| The 3D Point which will be copied. |
| */ |
| B3DPoint(const B3DPoint& rVec) |
| : B3DTuple(rVec) |
| {} |
| |
| /** constructor with tuple to allow copy-constructing |
| from B3DTuple-based classes |
| */ |
| B3DPoint(const ::basegfx::B3DTuple& rTuple) |
| : B3DTuple(rTuple) |
| {} |
| |
| ~B3DPoint() |
| {} |
| |
| /** *=operator to allow usage from B3DPoint, too |
| */ |
| B3DPoint& operator*=( const B3DPoint& rPnt ) |
| { |
| mfX *= rPnt.mfX; |
| mfY *= rPnt.mfY; |
| mfZ *= rPnt.mfZ; |
| return *this; |
| } |
| |
| /** *=operator to allow usage from B3DPoint, too |
| */ |
| B3DPoint& operator*=(double t) |
| { |
| mfX *= t; |
| mfY *= t; |
| mfZ *= t; |
| return *this; |
| } |
| |
| /** assignment operator to allow assigning the results |
| of B3DTuple calculations |
| */ |
| B3DPoint& operator=( const ::basegfx::B3DTuple& rVec ) |
| { |
| mfX = rVec.getX(); |
| mfY = rVec.getY(); |
| mfZ = rVec.getZ(); |
| return *this; |
| } |
| |
| /** Transform point by given transformation matrix. |
| |
| The translational components of the matrix are, in |
| contrast to B3DVector, applied. |
| */ |
| B3DPoint& operator*=( const ::basegfx::B3DHomMatrix& rMat ); |
| |
| static const B3DPoint& getEmptyPoint() |
| { |
| return (const B3DPoint&) ::basegfx::B3DTuple::getEmptyTuple(); |
| } |
| }; |
| |
| // external operators |
| ////////////////////////////////////////////////////////////////////////// |
| |
| /** Transform B3DPoint by given transformation matrix. |
| |
| Since this is a Point, translational components of the |
| matrix are used. |
| */ |
| B3DPoint operator*( const B3DHomMatrix& rMat, const B3DPoint& rPoint ); |
| |
| } // end of namespace basegfx |
| |
| #endif /* _BGFX_POINT_B3DPOINT_HXX */ |