basegfx::B3DTuple Class Reference

Base class for all Points/Vectors with three double values. More...

#include <b3dtuple.hxx>

Inheritance diagram for basegfx::B3DTuple:

Collaboration diagram for basegfx::B3DTuple:

Public Member Functions
	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...
Tuple3D &	operator+= (const Tuple3D &rTup)
Tuple3D &	operator-= (const Tuple3D &rTup)
Tuple3D &	operator/= (const Tuple3D &rTup)
Tuple3D &	operator/= (double t)
Tuple3D &	operator*= (const Tuple3D &rTup)
Tuple3D &	operator*= (double t)
bool	operator== (const Tuple3D &rTup) const
bool	operator!= (const Tuple3D &rTup) const

Static Public Member Functions
static const B3DTuple &	getEmptyTuple ()

Additional Inherited Members
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 class for all Points/Vectors with three double values.

This class provides all methods common to Point and Vector classes which are derived from here.

Derive: \n Use this class to implement Points or Vectors

which are based on three double values

Definition at line 39 of file b3dtuple.hxx.

Constructor & Destructor Documentation

B3DTuple() [1/2]

basegfx::B3DTuple::B3DTuple ( )

inline

Create a 3D Tuple.

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

Definition at line 46 of file b3dtuple.hxx.

B3DTuple() [2/2]

basegfx::B3DTuple::B3DTuple ( double  fX, double  fY, double  fZ  )

inline

Create a 3D Tuple.

Parameters

fX	This parameter is used to initialize the X-coordinate of the 3D Tuple.
fY	This parameter is used to initialize the Y-coordinate of the 3D Tuple.
fZ	This parameter is used to initialize the Z-coordinate of the 3D Tuple.

Definition at line 64 of file b3dtuple.hxx.

Member Function Documentation

correctValues()

void basegfx::B3DTuple::correctValues ( const double  fCompareValue = 0.0 )

inline

Definition at line 122 of file b3dtuple.hxx.

References basegfx::fTools::equalZero(), mfX, and mfY.

Referenced by basegfx::B3DHomMatrix::decompose().

equal()

bool basegfx::B3DTuple::equal ( const B3DTuple &  rTup ) const

inline

Definition at line 97 of file b3dtuple.hxx.

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

Referenced by basegfx::utils::checkClosed(), basegfx::utils::getCutBetweenLineAndPlane(), basegfx::utils::implHandleFirstLast(), basegfx::utils::isPointOnLine(), and basegfx::utils::isPointOnPolygon().

equalZero()

bool basegfx::B3DTuple::equalZero ( ) const

inline

Definition at line 89 of file b3dtuple.hxx.

References basegfx::fTools::equalZero(), mfX, and mfY.

Referenced by basegfx::utils::getCutBetweenLineAndPlane(), and basegfx::utils::isInside().

getEmptyTuple()

const B3DTuple & basegfx::B3DTuple::getEmptyTuple ( )

static

Definition at line 25 of file b3dtuple.cxx.

Referenced by basegfx::BColor::getEmptyBColor(), and basegfx::B3DVector::getEmptyVector().

operator!=()

bool basegfx::B3DTuple::operator!= ( const B3DTuple &  rTup ) const

inline

Definition at line 120 of file b3dtuple.hxx.

References operator==().

operator-()

B3DTuple basegfx::B3DTuple::operator- ( void  ) const

inline

Definition at line 108 of file b3dtuple.hxx.

References mfX, and mfY.

operator==()

bool basegfx::B3DTuple::operator== ( const B3DTuple &  rTup ) const

inline

Definition at line 113 of file b3dtuple.hxx.

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

operator[]() [1/2]

double & basegfx::B3DTuple::operator[] ( int  nPos )

inline

Array-access to 3D Tuple.

Definition at line 78 of file b3dtuple.hxx.

References mfX, and nPos.

operator[]() [2/2]

const double & basegfx::B3DTuple::operator[] ( int  nPos ) const

inline

Array-access to 3D Tuple.

Definition at line 69 of file b3dtuple.hxx.

References mfX, and nPos.

---

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

• b3dtuple.hxx
• b3dtuple.cxx