basegfx::B3DTuple Class Reference

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

#include <b3dtuple.hxx>

Inheritance diagram for basegfx::B3DTuple:

[legend]

List of all members.

Public Member Functions
	B3DTuple ()
	Create a 3D Tuple.
	B3DTuple (double fX, double fY, double fZ)
	Create a 3D Tuple.
	B3DTuple (const B3DTuple &rTup)
	Create a copy of a 3D Tuple.
	B3DTuple (const B3ITuple &rTup)
	Create a copy of a 3D integer Tuple.
	~B3DTuple ()
double	getX () const
	get X-Coordinate of 3D Tuple
double	getY () const
	get Y-Coordinate of 3D Tuple
double	getZ () const
	get Z-Coordinate of 3D Tuple
void	setX (double fX)
	set X-Coordinate of 3D Tuple
void	setY (double fY)
	set Y-Coordinate of 3D Tuple
void	setZ (double fZ)
	set Z-Coordinate of 3D Tuple
const double &	operator[] (int nPos) const
	Array-access to 3D Tuple.
double &	operator[] (int nPos)
	Array-access to 3D Tuple.
bool	equalZero () const
bool	equalZero (const double &rfSmallValue) const
bool	equal (const B3DTuple &rTup) const
bool	equal (const B3DTuple &rTup, const double &rfSmallValue) const
B3DTuple &	operator+= (const B3DTuple &rTup)
B3DTuple &	operator-= (const B3DTuple &rTup)
B3DTuple &	operator/= (const B3DTuple &rTup)
B3DTuple &	operator*= (const B3DTuple &rTup)
B3DTuple &	operator*= (double t)
B3DTuple &	operator/= (double t)
B3DTuple	operator- (void) const
bool	operator== (const B3DTuple &rTup) const
bool	operator!= (const B3DTuple &rTup) const
B3DTuple &	operator= (const B3DTuple &rTup)
void	correctValues (const double fCompareValue=0.0)
Static Public Member Functions
static const B3DTuple &	getEmptyTuple ()
Protected Attributes
double	mfX
double	mfY
double	mfZ

---

Detailed Description

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

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

Derive:

Use this class to implement Points or Vectors which are based on three double values

Definition at line 47 of file b3dtuple.hxx.

---

Constructor & Destructor Documentation

basegfx::B3DTuple::B3DTuple

(

)

[inline]

Create a 3D Tuple.

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

Definition at line 59 of file b3dtuple.hxx.

Referenced by operator-().

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 79 of file b3dtuple.hxx.

basegfx::B3DTuple::B3DTuple

(

const B3DTuple &

rTup

)

[inline]

Create a copy of a 3D Tuple.

Parameters:

rTup

The 3D Tuple which will be copied.

Definition at line 90 of file b3dtuple.hxx.

basegfx::B3DTuple::B3DTuple

(

const B3ITuple &

rTup

)

[explicit]

Create a copy of a 3D integer Tuple.

Parameters:

rTup

The 3D Tuple which will be copied.

Definition at line 43 of file b3dtuple.cxx.

basegfx::B3DTuple::~B3DTuple

(

)

[inline]

Definition at line 103 of file b3dtuple.hxx.

---

Member Function Documentation

double basegfx::B3DTuple::getX

(

)

const [inline]

get X-Coordinate of 3D Tuple

Definition at line 107 of file b3dtuple.hxx.

References mfX.

Referenced by basegfx::absolute(), basegfx::InterpolatorProvider3D::addNormalInterpolator(), basegfx::areParallel(), basegfx::average(), basegfx::tools::clipPolygonOnPlane(), basegfx::tools::clipPolyPolygonOnPlane(), basegfx::cross(), basegfx::B3DHomMatrix::decompose(), basegfx::B3DRange::expand(), basegfx::fround(), basegfx::B3DHomPoint::getB3DPoint(), CoordinateDataArray3D::getNormal(), basegfx::getPerpendicular2D(), basegfx::tools::getSignedArea(), basegfx::B3DHomPoint::getX(), basegfx::impGetCut(), basegfx::impIsInside(), basegfx::B3DHomPoint::implHomogenize(), basegfx::interpolate(), basegfx::B3DRange::isInside(), basegfx::tools::isInside(), basegfx::tools::isPointOnLine(), basegfx::maximum(), basegfx::minimum(), and basegfx::B3DHomMatrix::orientation().

double basegfx::B3DTuple::getY

(

)

const [inline]

get Y-Coordinate of 3D Tuple

Definition at line 113 of file b3dtuple.hxx.

References mfY.

Referenced by basegfx::absolute(), basegfx::InterpolatorProvider3D::addNormalInterpolator(), basegfx::areParallel(), basegfx::average(), basegfx::tools::clipPolygonOnPlane(), basegfx::tools::clipPolyPolygonOnPlane(), basegfx::cross(), basegfx::B3DHomMatrix::decompose(), basegfx::B3DRange::expand(), basegfx::fround(), basegfx::B3DHomPoint::getB3DPoint(), CoordinateDataArray3D::getNormal(), basegfx::getPerpendicular2D(), basegfx::tools::getSignedArea(), basegfx::B3DHomPoint::getY(), basegfx::B3DHomPoint::getZ(), basegfx::impGetCut(), basegfx::impIsInside(), basegfx::B3DHomPoint::implHomogenize(), basegfx::interpolate(), basegfx::B3DRange::isInside(), basegfx::tools::isInside(), basegfx::tools::isPointOnLine(), basegfx::maximum(), basegfx::minimum(), and basegfx::B3DHomMatrix::orientation().

double basegfx::B3DTuple::getZ

(

)

const [inline]

get Z-Coordinate of 3D Tuple

Definition at line 119 of file b3dtuple.hxx.

References mfZ.

Referenced by basegfx::absolute(), basegfx::InterpolatorProvider3D::addNormalInterpolator(), basegfx::areParallel(), basegfx::average(), basegfx::tools::clipPolygonOnPlane(), basegfx::tools::clipPolyPolygonOnPlane(), basegfx::cross(), basegfx::B3DHomMatrix::decompose(), basegfx::B3DRange::expand(), basegfx::fround(), basegfx::B3DHomPoint::getB3DPoint(), CoordinateDataArray3D::getNormal(), basegfx::getPerpendicular2D(), basegfx::tools::getSignedArea(), basegfx::impGetCut(), basegfx::impIsInside(), basegfx::B3DHomPoint::implHomogenize(), basegfx::interpolate(), basegfx::B3DRange::isInside(), basegfx::tools::isInside(), basegfx::tools::isPointOnLine(), basegfx::maximum(), basegfx::minimum(), and basegfx::B3DHomMatrix::orientation().

void basegfx::B3DTuple::setX

(

double

fX

)

[inline]

set X-Coordinate of 3D Tuple

Definition at line 125 of file b3dtuple.hxx.

References mfX.

Referenced by basegfx::B3DHomMatrix::decompose(), basegfx::B3DHomPoint::implHomogenize(), basegfx::B3DHomPoint::operator+=(), basegfx::B3DHomPoint::operator-=(), and basegfx::B3DHomPoint::setX().

void basegfx::B3DTuple::setY

(

double

fY

)

[inline]

set Y-Coordinate of 3D Tuple

Definition at line 131 of file b3dtuple.hxx.

References mfY.

Referenced by basegfx::B3DHomMatrix::decompose(), basegfx::B3DHomPoint::implHomogenize(), basegfx::B3DHomPoint::operator+=(), basegfx::B3DHomPoint::operator-=(), and basegfx::B3DHomPoint::setY().

void basegfx::B3DTuple::setZ

(

double

fZ

)

[inline]

set Z-Coordinate of 3D Tuple

Definition at line 137 of file b3dtuple.hxx.

References mfZ.

Referenced by basegfx::B3DHomMatrix::decompose(), basegfx::B3DHomPoint::implHomogenize(), basegfx::B3DHomPoint::operator+=(), basegfx::B3DHomPoint::operator-=(), and basegfx::B3DHomPoint::setZ().

const double& basegfx::B3DTuple::operator[]

(

int

nPos

)

const [inline]

Array-access to 3D Tuple.

Definition at line 143 of file b3dtuple.hxx.

References mfX.

double& basegfx::B3DTuple::operator[]

(

int

nPos

)

[inline]

Array-access to 3D Tuple.

Definition at line 152 of file b3dtuple.hxx.

References mfX.

bool basegfx::B3DTuple::equalZero

(

)

const [inline]

Definition at line 163 of file b3dtuple.hxx.

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

Referenced by basegfx::tools::clipPolygonOnPlane(), basegfx::tools::clipPolyPolygonOnPlane(), basegfx::tools::getCutBetweenLineAndPlane(), and basegfx::tools::isInEpsilonRange().

bool basegfx::B3DTuple::equalZero

(

const double &

rfSmallValue

)

const [inline]

Definition at line 171 of file b3dtuple.hxx.

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

bool basegfx::B3DTuple::equal

(

const B3DTuple &

rTup

)

const [inline]

Definition at line 179 of file b3dtuple.hxx.

References basegfx::fTools::equal(), mfX, mfY, and mfZ.

Referenced by basegfx::tools::checkClosed(), basegfx::tools::getCutBetweenLineAndPlane(), basegfx::tools::getCutBetweenLineAndPolygon(), CoordinateDataArray3D::getNormal(), basegfx::tools::isPointOnLine(), basegfx::tools::isPointOnPolygon(), operator!=(), and operator==().

bool basegfx::B3DTuple::equal	(	const B3DTuple &	rTup,
		const double &	rfSmallValue
	)			const [inline]

Definition at line 187 of file b3dtuple.hxx.

References basegfx::fTools::equal(), mfX, mfY, and mfZ.

B3DTuple& basegfx::B3DTuple::operator+=

(

const B3DTuple &

rTup

)

[inline]

Definition at line 198 of file b3dtuple.hxx.

References mfX, mfY, and mfZ.

B3DTuple& basegfx::B3DTuple::operator-=

(

const B3DTuple &

rTup

)

[inline]

Definition at line 206 of file b3dtuple.hxx.

References mfX, mfY, and mfZ.

B3DTuple& basegfx::B3DTuple::operator/=

(

const B3DTuple &

rTup

)

[inline]

Definition at line 214 of file b3dtuple.hxx.

References mfX, mfY, and mfZ.

B3DTuple& basegfx::B3DTuple::operator*=

(

const B3DTuple &

rTup

)

[inline]

Definition at line 222 of file b3dtuple.hxx.

References mfX, mfY, and mfZ.

B3DTuple& basegfx::B3DTuple::operator*=

(

double

t

)

[inline]

Reimplemented in basegfx::BColor, basegfx::B3DPoint, and basegfx::B3DVector.

Definition at line 230 of file b3dtuple.hxx.

References mfX, mfY, and mfZ.

B3DTuple& basegfx::B3DTuple::operator/=

(

double

t

)

[inline]

Definition at line 238 of file b3dtuple.hxx.

References mfX, mfY, and mfZ.

B3DTuple basegfx::B3DTuple::operator-

(

void

)

const [inline]

Definition at line 247 of file b3dtuple.hxx.

References B3DTuple(), mfX, mfY, and mfZ.

bool basegfx::B3DTuple::operator==

(

const B3DTuple &

rTup

)

const [inline]

Definition at line 252 of file b3dtuple.hxx.

References equal().

bool basegfx::B3DTuple::operator!=

(

const B3DTuple &

rTup

)

const [inline]

Definition at line 257 of file b3dtuple.hxx.

References equal().

B3DTuple& basegfx::B3DTuple::operator=

(

const B3DTuple &

rTup

)

[inline]

Definition at line 262 of file b3dtuple.hxx.

References mfX, mfY, and mfZ.

void basegfx::B3DTuple::correctValues

(

const double

fCompareValue = 0.0

)

[inline]

Definition at line 270 of file b3dtuple.hxx.

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

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

const B3DTuple & basegfx::B3DTuple::getEmptyTuple

(

)

[static]

Definition at line 38 of file b3dtuple.cxx.

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

---

Member Data Documentation

double basegfx::B3DTuple::mfX [protected]

Definition at line 50 of file b3dtuple.hxx.

Referenced by basegfx::BColor::blend(), basegfx::BColor::clamp(), basegfx::BColor::colorToDoubleSequence(), correctValues(), equal(), equalZero(), basegfx::B3DVector::getProjectionOnPlane(), basegfx::BColor::getRed(), getX(), basegfx::B3DVector::getXYLength(), basegfx::B3DVector::getXZLength(), basegfx::BColor::invert(), basegfx::BColor::luminance(), basegfx::B3DVector::normalize(), basegfx::BColor::operator*=(), basegfx::B3DVector::operator*=(), operator*=(), basegfx::B3DPoint::operator*=(), operator+=(), operator-(), operator-=(), operator/=(), basegfx::BColor::operator=(), basegfx::B3DVector::operator=(), operator=(), basegfx::B3DPoint::operator=(), operator[](), basegfx::B3DVector::scalar(), basegfx::B3DVector::setLength(), basegfx::BColor::setRed(), and setX().

double basegfx::B3DTuple::mfY [protected]

Definition at line 51 of file b3dtuple.hxx.

Referenced by basegfx::BColor::blend(), basegfx::BColor::clamp(), basegfx::BColor::colorToDoubleSequence(), correctValues(), equal(), equalZero(), basegfx::BColor::getGreen(), basegfx::B3DVector::getProjectionOnPlane(), basegfx::B3DVector::getXYLength(), getY(), basegfx::B3DVector::getYZLength(), basegfx::BColor::invert(), basegfx::BColor::luminance(), basegfx::B3DVector::normalize(), basegfx::BColor::operator*=(), basegfx::B3DVector::operator*=(), operator*=(), basegfx::B3DPoint::operator*=(), operator+=(), operator-(), operator-=(), operator/=(), basegfx::BColor::operator=(), basegfx::B3DVector::operator=(), operator=(), basegfx::B3DPoint::operator=(), basegfx::B3DVector::scalar(), basegfx::BColor::setGreen(), basegfx::B3DVector::setLength(), and setY().

double basegfx::B3DTuple::mfZ [protected]

Definition at line 52 of file b3dtuple.hxx.

Referenced by basegfx::BColor::blend(), basegfx::BColor::clamp(), basegfx::BColor::colorToDoubleSequence(), correctValues(), equal(), equalZero(), basegfx::BColor::getBlue(), basegfx::B3DVector::getProjectionOnPlane(), basegfx::B3DVector::getXZLength(), basegfx::B3DVector::getYZLength(), getZ(), basegfx::BColor::invert(), basegfx::BColor::luminance(), basegfx::B3DVector::normalize(), basegfx::BColor::operator*=(), basegfx::B3DVector::operator*=(), operator*=(), basegfx::B3DPoint::operator*=(), operator+=(), operator-(), operator-=(), operator/=(), basegfx::BColor::operator=(), basegfx::B3DVector::operator=(), operator=(), basegfx::B3DPoint::operator=(), basegfx::B3DVector::scalar(), basegfx::BColor::setBlue(), basegfx::B3DVector::setLength(), and setZ().

---

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

• b3dtuple.hxx
• b3dtuple.cxx