DtVrfObjectIntersectionRecord Class Reference

Instances of DtVrfObjectIntersectionRecord are used to record the results of DtVrfObject/DtChord intersection attempts. More...

List of all members.

Public Member Functions
	DtVrfObjectIntersectionRecord ()
	DtVrfObjectIntersectionRecord (DtPoint &intersectionPoint, double intersectionTime, const DtSurface &surface, DtVrfObject *intersectedObject)
virtual	~DtVrfObjectIntersectionRecord ()
bool	intersectionFound () const
	Copy constructor and Assignment operator left to compiler generate implementations.
void	setIntersectionFound (bool arg)
const DtPoint	intersectionPoint () const
void	setIntersectionPoint (const DtPoint &pt)
const double	intersectionTime () const
void	setIntersectionTime (double t)
const DtSurface	surface () const
void	setSurface (const DtSurface &s)
DtVrfObject *	intersectedVrfObject ()
	Get a pointer to the intersecting vrfObject.
const DtVrfObject *	intersectedVrfObject () const
void	setIntersectedVrfObject (DtVrfObject *vrfObj)
unsigned int	numberOfIntersectionTests () const
	The number of intersection tests that were performed in order to fill in this class can be kept, for instrumentation purposes.
void	incrementNumberOfIntersectionTests ()
	Increments the current number of intersection tests by one.
void	setNumberOfIntersectionTests (unsigned int newNumberOfTests)
	Set outright the number of intersection tests.
Protected Member Functions
bool	testInvariant () const
Private Attributes
bool	myIntersectionFound
DtPoint	myIntersectionPoint
double	myIntersectionTime
DtSurface	mySurface
DtVrfObject *	myIntersectedVrfObject
unsigned int	myNumberOfIntersectionTests
	This represents the total number of intersection tests that were performed to fill in this intersection record.

---

Detailed Description

Instances of DtVrfObjectIntersectionRecord are used to record the results of DtVrfObject/DtChord intersection attempts.

This class is copyable and assignable.

---

Constructor & Destructor Documentation

DtVrfObjectIntersectionRecord::DtVrfObjectIntersectionRecord

(

)

DtVrfObjectIntersectionRecord::DtVrfObjectIntersectionRecord	(	DtPoint &	intersectionPoint,
		double	intersectionTime,
		const DtSurface &	surface,
		DtVrfObject *	intersectedObject
	)

virtual DtVrfObjectIntersectionRecord::~DtVrfObjectIntersectionRecord

(

)

[virtual]

---

Member Function Documentation

bool DtVrfObjectIntersectionRecord::intersectionFound

(

)

const [inline]

Copy constructor and Assignment operator left to compiler generate implementations.

DtVrfObjectIntersectionRecord(const DtVrfObjectIntersectionRecord& original); const DtVrfObjectIntersectionRecord& operator=(const DtVrfObjectIntersectionRecord& original);

References myIntersectionFound, and testInvariant().

void DtVrfObjectIntersectionRecord::setIntersectionFound

(

bool

arg

)

[inline]

References myIntersectionFound, and testInvariant().

const DtPoint DtVrfObjectIntersectionRecord::intersectionPoint

(

)

const [inline]

References myIntersectionPoint, and testInvariant().

void DtVrfObjectIntersectionRecord::setIntersectionPoint

(

const DtPoint &

pt

)

[inline]

References myIntersectionPoint, and testInvariant().

const double DtVrfObjectIntersectionRecord::intersectionTime

(

)

const [inline]

References myIntersectionTime, and testInvariant().

void DtVrfObjectIntersectionRecord::setIntersectionTime

(

double

t

)

[inline]

References myIntersectionTime, and testInvariant().

const DtSurface DtVrfObjectIntersectionRecord::surface

(

)

const [inline]

References mySurface, and testInvariant().

void DtVrfObjectIntersectionRecord::setSurface

(

const DtSurface &

s

)

[inline]

References mySurface, and testInvariant().

DtVrfObject * DtVrfObjectIntersectionRecord::intersectedVrfObject

(

)

[inline]

Get a pointer to the intersecting vrfObject.

References myIntersectedVrfObject, and testInvariant().

const DtVrfObject * DtVrfObjectIntersectionRecord::intersectedVrfObject

(

)

const [inline]

References myIntersectedVrfObject, and testInvariant().

void DtVrfObjectIntersectionRecord::setIntersectedVrfObject

(

DtVrfObject *

vrfObj

)

[inline]

References myIntersectedVrfObject, and testInvariant().

unsigned int DtVrfObjectIntersectionRecord::numberOfIntersectionTests

(

)

const [inline]

The number of intersection tests that were performed in order to fill in this class can be kept, for instrumentation purposes.

These are the accessor functions.

Returns:

The number of intersection tests associated with this record.

References myNumberOfIntersectionTests, and testInvariant().

void DtVrfObjectIntersectionRecord::incrementNumberOfIntersectionTests

(

)

[inline]

Increments the current number of intersection tests by one.

References myNumberOfIntersectionTests, and testInvariant().

void DtVrfObjectIntersectionRecord::setNumberOfIntersectionTests

(

unsigned int

newNumberOfTests

)

[inline]

Set outright the number of intersection tests.

References myNumberOfIntersectionTests, and testInvariant().

bool DtVrfObjectIntersectionRecord::testInvariant

(

)

const [protected]

Referenced by incrementNumberOfIntersectionTests(), intersectedVrfObject(), intersectionFound(), intersectionPoint(), intersectionTime(), numberOfIntersectionTests(), setIntersectedVrfObject(), setIntersectionFound(), setIntersectionPoint(), setIntersectionTime(), setNumberOfIntersectionTests(), setSurface(), and surface().

---

Member Data Documentation

bool DtVrfObjectIntersectionRecord::myIntersectionFound [private]

Referenced by intersectionFound(), and setIntersectionFound().

DtPoint DtVrfObjectIntersectionRecord::myIntersectionPoint [private]

Referenced by intersectionPoint(), and setIntersectionPoint().

double DtVrfObjectIntersectionRecord::myIntersectionTime [private]

Referenced by intersectionTime(), and setIntersectionTime().

DtSurface DtVrfObjectIntersectionRecord::mySurface [private]

Referenced by setSurface(), and surface().

DtVrfObject* DtVrfObjectIntersectionRecord::myIntersectedVrfObject [private]

Referenced by intersectedVrfObject(), and setIntersectedVrfObject().

unsigned int DtVrfObjectIntersectionRecord::myNumberOfIntersectionTests [private]

This represents the total number of intersection tests that were performed to fill in this intersection record.

This is intended to be used for instrumentation purposes, and is included because of the very low overhead.

Referenced by incrementNumberOfIntersectionTests(), numberOfIntersectionTests(), and setNumberOfIntersectionTests().

---

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

• include/vrfobjcore/vrfObjectIntersectionRecord.h