DtEntityCollision Class Reference

Holds all information associated with a (potential) collision with a vrfObject. More...

Inheritance diagram for DtEntityCollision:

List of all members.

Public Member Functions
	DtEntityCollision (DtSimManager &simManager, DtEntityIdentifier entityID, double distanceSquared)
	Constructor.
virtual	~DtEntityCollision ()
	Destructor.
virtual DtCollisionObjectType	collisionType () const
	Returns DtEntityCollision;.
	DtEntityCollision (const DtEntityCollision &original)
DtEntityCollision &	operator= (const DtEntityCollision &original)
bool	operator== (const DtCollision &collision) const
bool	operator!= (const DtCollision &collision) const
bool	operator== (const DtEntityCollision &collision) const
bool	operator!= (const DtEntityCollision &collision) const
bool	valid () const
DtEntityIdentifier	obstructionEntityID () const
void	setObstructionEntityID (const DtEntityIdentifier &entityID)
DtVector	obstructionLocation () const
DtVector	obstructionVelocity () const
const Dt3dBoundingVolume &	obstructionBoundingVolume () const
Dt3dBoundingVolume &	obstructionBoundingVolume ()
void	setDistanceSquared (double distanceSquared)
double	distanceSquared () const
void	addDistance (double extraDistance)
	Adds to the distance...argument is a distance, not a distance-squared.
virtual const DtDcm &	obstructionLocalOrientationMatrix ()
bool	testInvariant () const
void	setSimulationManager (DtSimManager &simManager)
DtSimManager *	simulationManager ()
const DtSimManager *	simulationManager () const
virtual void	processObjectAboutToBeRemoved (DtVrfObject *object)
Static Public Member Functions
static void	objectAboutToBeRemovedCallback (DtVrfObject *object, void *usr)
Protected Attributes
DtEntityIdentifier	myObstructionEntityID
DtSimManager *	mySimulationManager
	Does not own this. Just a convenience pointer.
Static Protected Attributes
static Dt3dBoundingVolume	nullBoundingVolume
	Gets returned if myObject is NULL.
Private Attributes
DtVrfObject *	myObject
	NOT owned by this object. Just a convenience pointer.
double	myDistanceSquared

---

Detailed Description

Holds all information associated with a (potential) collision with a vrfObject.

---

Constructor & Destructor Documentation

DtEntityCollision::DtEntityCollision	(	DtSimManager &	simManager,
		DtEntityIdentifier	entityID,
		double	distanceSquared
	)

Constructor.

virtual DtEntityCollision::~DtEntityCollision

(

)

[virtual]

Destructor.

DtEntityCollision::DtEntityCollision

(

const DtEntityCollision &

original

)

---

Member Function Documentation

virtual DtCollisionObjectType DtEntityCollision::collisionType

(

)

const [virtual]

Returns DtEntityCollision;.

Implements DtCollision.

DtEntityCollision& DtEntityCollision::operator=

(

const DtEntityCollision &

original

)

bool DtEntityCollision::operator==

(

const DtCollision &

collision

)

const [virtual]

Implements DtCollision.

bool DtEntityCollision::operator!=

(

const DtCollision &

collision

)

const [virtual]

Implements DtCollision.

bool DtEntityCollision::operator==

(

const DtEntityCollision &

collision

)

const

bool DtEntityCollision::operator!=

(

const DtEntityCollision &

collision

)

const

bool DtEntityCollision::valid

(

)

const [virtual]

Returns:

A boolean signifying whether or not the collision object is still valid or not.

Implements DtCollision.

DtEntityIdentifier DtEntityCollision::obstructionEntityID

(

)

const [virtual]

Implements DtCollision.

void DtEntityCollision::setObstructionEntityID

(

const DtEntityIdentifier &

entityID

)

[virtual]

Implements DtCollision.

DtVector DtEntityCollision::obstructionLocation

(

)

const [virtual]

Implements DtCollision.

DtVector DtEntityCollision::obstructionVelocity

(

)

const [virtual]

Implements DtCollision.

const Dt3dBoundingVolume& DtEntityCollision::obstructionBoundingVolume

(

)

const [virtual]

Implements DtCollision.

Dt3dBoundingVolume& DtEntityCollision::obstructionBoundingVolume

(

)

[virtual]

Implements DtCollision.

void DtEntityCollision::setDistanceSquared

(

double

distanceSquared

)

[virtual]

Implements DtCollision.

double DtEntityCollision::distanceSquared

(

)

const [virtual]

Implements DtCollision.

void DtEntityCollision::addDistance

(

double

extraDistance

)

Adds to the distance...argument is a distance, not a distance-squared.

So if the distance is 7, then distanceSquared() will return 49; if addDistance(2) is then called, then after distanceSquared() will return 81.

virtual const DtDcm& DtEntityCollision::obstructionLocalOrientationMatrix

(

)

[virtual]

Implements DtCollision.

bool DtEntityCollision::testInvariant

(

)

const [virtual]

Implements DtCollision.

void DtEntityCollision::setSimulationManager

(

DtSimManager &

simManager

)

DtSimManager* DtEntityCollision::simulationManager

(

)

const DtSimManager* DtEntityCollision::simulationManager

(

)

const

static void DtEntityCollision::objectAboutToBeRemovedCallback	(	DtVrfObject *	object,
		void *	usr
	)		[static]

virtual void DtEntityCollision::processObjectAboutToBeRemoved

(

DtVrfObject *

object

)

[virtual]

---

Member Data Documentation

DtEntityIdentifier DtEntityCollision::myObstructionEntityID [protected]

DtSimManager* DtEntityCollision::mySimulationManager [protected]

Does not own this. Just a convenience pointer.

Dt3dBoundingVolume DtEntityCollision::nullBoundingVolume [static, protected]

Gets returned if myObject is NULL.

DtVrfObject* DtEntityCollision::myObject [mutable, private]

NOT owned by this object. Just a convenience pointer.

double DtEntityCollision::myDistanceSquared [private]

---

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

• include/vrfobjcore/entityCollision.h