makVrv::DtCigiBaseEntity Class Reference

This class provides an abstract base class for CIGI entities. More...

Inheritance diagram for makVrv::DtCigiBaseEntity:

List of all members.

Public Member Functions
	DtCigiBaseEntity (DtCigiConnection &connection, DtAgentManagerInterface &sceneInterface, int entityId, int entityType)
	Constructor takes a DtCigiConnection, scene interface, and the CIGI entity ID/type.
virtual	~DtCigiBaseEntity ()
	Destructor.
virtual DtUniqueID	uniqueId () const
	Returns the unique ID of the entity's scene object.
virtual void	setVisible (bool yesNo)
	Set whether the entity is visible.
virtual void	setDeadReckoningOn (bool onOff)
	Turns dead-reckoning on/off.
virtual void	setPosition (const DtGeodeticCoord &pos)
	Set the entity's geodetic position.
virtual void	setOrientation (const DtTaitBryan &orientation)
	Set the entity's orientation.
virtual void	setLinearRate (const DtVector &rate, bool useWorldCoordinates=true)
	Sets the entity's linear rate.
virtual void	setAngularRate (const DtVector &rate, bool useWorldCoordinates=true)
	Set's the entity's angular rate.
virtual void	setRelativeTo (DtCigiBaseEntity *parent)
	Attachment control.
virtual void	setRelativePosition (const DtVector &pos)
	Sets the entity's relative position (if attached).
virtual void	setRelativeOrientation (const DtTaitBryan &orient)
	Sets the entity's relative orientation (relative to the parent's body coordinates) if attached.
virtual void	setAlpha (int alpha)
	Sets the entity's alpha value.
virtual int	alpha () const
	Returns the entity's alpha value.
virtual void	setInheritAlpha (bool inherit)
	Set whether the entity should inher.
virtual const DtGeodeticCoord &	lastSetPosition () const
	Returns the last position set by a CIGI entity control message.
virtual const DtTaitBryan &	lastSetOrientation () const
	Returns the last orientation set by a CIGI entity control message.
virtual void	slot_alphaChanged (int alpha, DtUniqueID id)
	Slot so we can check if the parent's alpha has changed.
virtual void	setGroundClampingOn (bool trueFalse)
	Turns ground clamping on/off.
Protected Member Functions
void	createDeadReckonGroundClampUpdater ()
Protected Attributes
DtSceneObjectAgent *	mySceneObject
DtModelAgent *	myModel
DtAttachableDeadReckonUpdaterAgent *	myAttachableUpdater
DtDeadReckonGroundClampUpdaterAgent *	myDeadReckonGroundClampUpdater
bool	myDeadReckoningOn
bool	myGroundClampingOn
DtGeodeticCoord	myLastPosition
DtVector	myLastLocalPosition
DtTaitBryan	myLastOrientation
DtTaitBryan	myLastGeocentricOrientation
DtCigiConnection &	myConnection
DtAgentManagerInterface &	mySceneInterface
int	myEntityId
int	myEntityType
DtCigiBaseEntity *	myParent
bool	myInheritAlpha
int	myAlpha

---

Detailed Description

This class provides an abstract base class for CIGI entities.

These are created by the DtCigiEntityVisualizer and updated as CIGI messages that pertain to entities are processed.

---

Constructor & Destructor Documentation

makVrv::DtCigiBaseEntity::DtCigiBaseEntity	(	DtCigiConnection &	connection,
		DtAgentManagerInterface &	sceneInterface,
		int	entityId,
		int	entityType
	)

Constructor takes a DtCigiConnection, scene interface, and the CIGI entity ID/type.

virtual makVrv::DtCigiBaseEntity::~DtCigiBaseEntity

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual DtUniqueID makVrv::DtCigiBaseEntity::uniqueId

(

)

const [virtual]

Returns the unique ID of the entity's scene object.

virtual void makVrv::DtCigiBaseEntity::setVisible

(

bool

yesNo

)

[virtual]

Set whether the entity is visible.

virtual void makVrv::DtCigiBaseEntity::setDeadReckoningOn

(

bool

onOff

)

[virtual]

Turns dead-reckoning on/off.

virtual void makVrv::DtCigiBaseEntity::setPosition

(

const DtGeodeticCoord &

pos

)

[virtual]

Set the entity's geodetic position.

virtual void makVrv::DtCigiBaseEntity::setOrientation

(

const DtTaitBryan &

orientation

)

[virtual]

Set the entity's orientation.

virtual void makVrv::DtCigiBaseEntity::setLinearRate	(	const DtVector &	rate,
		bool	useWorldCoordinates = true
	)		[virtual]

Sets the entity's linear rate.

If useWorldCoordinates is set to true, sets the velocity according to the entity's rate with respect to the tangential reference plane of the entity. Otherwise, sets the velocity with respect to the entity's coordinate system.

virtual void makVrv::DtCigiBaseEntity::setAngularRate	(	const DtVector &	rate,
		bool	useWorldCoordinates = true
	)		[virtual]

Set's the entity's angular rate.

If useWorldCoordinates is set to true, sets the angular velocity with respect to the tangential reference plane of the entity. Otherwise, sets the velocity with respect to the entity's coordinate system.

virtual void makVrv::DtCigiBaseEntity::setRelativeTo

(

DtCigiBaseEntity *

parent

)

[virtual]

Attachment control.

virtual void makVrv::DtCigiBaseEntity::setRelativePosition

(

const DtVector &

pos

)

[virtual]

Sets the entity's relative position (if attached).

virtual void makVrv::DtCigiBaseEntity::setRelativeOrientation

(

const DtTaitBryan &

orient

)

[virtual]

Sets the entity's relative orientation (relative to the parent's body coordinates) if attached.

virtual void makVrv::DtCigiBaseEntity::setAlpha

(

int

alpha

)

[virtual]

Sets the entity's alpha value.

virtual int makVrv::DtCigiBaseEntity::alpha

(

)

const [virtual]

Returns the entity's alpha value.

This needs to be checked if the entity is inheriting its parent's alpha.

virtual void makVrv::DtCigiBaseEntity::setInheritAlpha

(

bool

inherit

)

[virtual]

Set whether the entity should inher.

virtual const DtGeodeticCoord& makVrv::DtCigiBaseEntity::lastSetPosition

(

)

const [virtual]

Returns the last position set by a CIGI entity control message.

virtual const DtTaitBryan& makVrv::DtCigiBaseEntity::lastSetOrientation

(

)

const [virtual]

Returns the last orientation set by a CIGI entity control message.

virtual void makVrv::DtCigiBaseEntity::slot_alphaChanged	(	int	alpha,
		DtUniqueID	id
	)		[virtual]

Slot so we can check if the parent's alpha has changed.

virtual void makVrv::DtCigiBaseEntity::setGroundClampingOn

(

bool

trueFalse

)

[virtual]

Turns ground clamping on/off.

void makVrv::DtCigiBaseEntity::createDeadReckonGroundClampUpdater

(

)

[protected]

---

Member Data Documentation

DtSceneObjectAgent* makVrv::DtCigiBaseEntity::mySceneObject [protected]

DtModelAgent* makVrv::DtCigiBaseEntity::myModel [protected]

DtAttachableDeadReckonUpdaterAgent* makVrv::DtCigiBaseEntity::myAttachableUpdater [protected]

DtDeadReckonGroundClampUpdaterAgent* makVrv::DtCigiBaseEntity::myDeadReckonGroundClampUpdater [protected]

bool makVrv::DtCigiBaseEntity::myDeadReckoningOn [protected]

bool makVrv::DtCigiBaseEntity::myGroundClampingOn [protected]

DtGeodeticCoord makVrv::DtCigiBaseEntity::myLastPosition [protected]

DtVector makVrv::DtCigiBaseEntity::myLastLocalPosition [protected]

DtTaitBryan makVrv::DtCigiBaseEntity::myLastOrientation [protected]

DtTaitBryan makVrv::DtCigiBaseEntity::myLastGeocentricOrientation [protected]

DtCigiConnection& makVrv::DtCigiBaseEntity::myConnection [protected]

DtAgentManagerInterface& makVrv::DtCigiBaseEntity::mySceneInterface [protected]

int makVrv::DtCigiBaseEntity::myEntityId [protected]

int makVrv::DtCigiBaseEntity::myEntityType [protected]

DtCigiBaseEntity* makVrv::DtCigiBaseEntity::myParent [protected]

bool makVrv::DtCigiBaseEntity::myInheritAlpha [protected]

int makVrv::DtCigiBaseEntity::myAlpha [protected]

---

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

• include/vrvCigi/DtCigiBaseEntity.h