LibreOffice Module basegfx (master) 1
Public Member Functions | List of all members
basegfx::B3DPoint Class Reference

Base Point class with three double values. More...

#include <b3dpoint.hxx>

Inheritance diagram for basegfx::B3DPoint:
[legend]
Collaboration diagram for basegfx::B3DPoint:
[legend]

Public Member Functions

 B3DPoint ()
 Create a 3D Point. More...
 
 B3DPoint (double fX, double fY, double fZ)
 Create a 3D Point. More...
 
 B3DPoint (const ::basegfx::B3DTuple &rTuple)
 constructor with tuple to allow copy-constructing from B3DTuple-based classes More...
 
B3DPointoperator*= (const B3DPoint &rPnt)
 *=operator to allow usage from B3DPoint, too More...
 
B3DPointoperator*= (double t)
 *=operator to allow usage from B3DPoint, too More...
 
B3DPointoperator= (const ::basegfx::B3DTuple &rVec)
 assignment operator to allow assigning the results of B3DTuple calculations More...
 
B3DPointoperator*= (const ::basegfx::B3DHomMatrix &rMat)
 Transform point by given transformation matrix. More...
 
- Public Member Functions inherited from basegfx::B3DTuple
 B3DTuple ()
 Create a 3D Tuple. More...
 
 B3DTuple (double fX, double fY, double fZ)
 Create a 3D Tuple. More...
 
const double & operator[] (int nPos) const
 Array-access to 3D Tuple. More...
 
double & operator[] (int nPos)
 Array-access to 3D Tuple. More...
 
bool equalZero () const
 
bool equal (const B3DTuple &rTup) const
 
B3DTuple operator- (void) const
 
bool operator== (const B3DTuple &rTup) const
 
bool operator!= (const B3DTuple &rTup) const
 
void correctValues (const double fCompareValue=0.0)
 
- Public Member Functions inherited from basegfx::Tuple3D< double >
 Tuple3D (double x, double y, double z)
 Create a 3D Tuple. More...
 
double getX () const
 Get X-Coordinate of 3D Tuple. More...
 
double getY () const
 Get Y-Coordinate of 3D Tuple. More...
 
double getZ () const
 Get Z-Coordinate of 3D Tuple. More...
 
void setX (double fX)
 Set X-Coordinate of 3D Tuple. More...
 
void setY (double fY)
 Set Y-Coordinate of 3D Tuple. More...
 
void setZ (double fZ)
 Set Z-Coordinate of 3D Tuple. More...
 
Tuple3Doperator+= (const Tuple3D &rTup)
 
Tuple3Doperator-= (const Tuple3D &rTup)
 
Tuple3Doperator/= (const Tuple3D &rTup)
 
Tuple3Doperator/= (double t)
 
Tuple3Doperator*= (const Tuple3D &rTup)
 
Tuple3Doperator*= (double t)
 
bool operator== (const Tuple3D &rTup) const
 
bool operator!= (const Tuple3D &rTup) const
 

Additional Inherited Members

- Static Public Member Functions inherited from basegfx::B3DTuple
static const B3DTuplegetEmptyTuple ()
 
- Public Attributes inherited from basegfx::Tuple3D< double >
double mnX
 
double mnY
 
double mnZ
 
double mfX
 
double mfY
 
double mfZ
 
- Protected Attributes inherited from basegfx::Tuple3D< double >
union {
   struct {
      TYPE   mnX
 
      TYPE   mnY
 
      TYPE   mnZ
 
   } 
 
   struct {
      TYPE   mfX
 
      TYPE   mfY
 
      TYPE   mfZ
 
   } 
 
}; 
 

Detailed Description

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 also
B3DTuple

Definition at line 37 of file b3dpoint.hxx.

Constructor & Destructor Documentation

◆ B3DPoint() [1/3]

basegfx::B3DPoint::B3DPoint ( )
inline

Create a 3D Point.

The point is initialized to (0.0, 0.0, 0.0)

Definition at line 44 of file b3dpoint.hxx.

◆ B3DPoint() [2/3]

basegfx::B3DPoint::B3DPoint ( double  fX,
double  fY,
double  fZ 
)
inline

Create a 3D Point.

Parameters
fXThis parameter is used to initialize the X-coordinate of the 3D Point.
fYThis parameter is used to initialize the Y-coordinate of the 3D Point.
fZThis parameter is used to initialize the Z-coordinate of the 3D Point.

Definition at line 61 of file b3dpoint.hxx.

◆ B3DPoint() [3/3]

basegfx::B3DPoint::B3DPoint ( const ::basegfx::B3DTuple rTuple)
inline

constructor with tuple to allow copy-constructing from B3DTuple-based classes

Definition at line 68 of file b3dpoint.hxx.

Member Function Documentation

◆ operator*=() [1/3]

B3DPoint & basegfx::B3DPoint::operator*= ( const ::basegfx::B3DHomMatrix rMat)

Transform point by given transformation matrix.

The translational components of the matrix are, in contrast to B3DVector, applied.

Definition at line 26 of file b3dpoint.cxx.

References basegfx::fTools::equal(), basegfx::fTools::equalZero(), basegfx::Tuple3D< double >::mfX, basegfx::Tuple3D< double >::mfY, and basegfx::Tuple3D< double >::mfZ.

◆ operator*=() [2/3]

B3DPoint & basegfx::B3DPoint::operator*= ( const B3DPoint rPnt)
inline

*=operator to allow usage from B3DPoint, too

Definition at line 74 of file b3dpoint.hxx.

References mfX, basegfx::Tuple3D< TYPE >::mfX, mfY, basegfx::Tuple3D< TYPE >::mfY, and basegfx::Tuple3D< TYPE >::mfZ.

◆ operator*=() [3/3]

B3DPoint & basegfx::B3DPoint::operator*= ( double  t)
inline

*=operator to allow usage from B3DPoint, too

Definition at line 84 of file b3dpoint.hxx.

References mfX, mfY, and t.

◆ operator=()

B3DPoint & basegfx::B3DPoint::operator= ( const ::basegfx::B3DTuple rVec)
inline

assignment operator to allow assigning the results of B3DTuple calculations

Definition at line 95 of file b3dpoint.hxx.

References mfX, and mfY.


The documentation for this class was generated from the following files: