makVrv::DtEntity2dFacadeBase Class Reference

The DtEntity2dFacadeBase is the common methods of a facade around agents that make up an entity in the 2D Icon model set. More...

Inheritance diagram for makVrv::DtEntity2dFacadeBase:

Public Member Functions
	DtEntity2dFacadeBase (DtAgentManagerInterface &sceneInterface, DtElementID id, bool distribute=false)
	CTOR.
	DtEntity2dFacadeBase (DtAgentManagerInterface &sceneInterface, int modelSet, DtElementID id, bool distribute=false)
	CTOR with model set id.
virtual	~DtEntity2dFacadeBase ()
	DTOR.
Entity Facade functions
These functions get parameters of the entity facade. representing the entity.
virtual void	setVisible (bool visible)
	set the entity's model hidden or visible
virtual bool	visible () const
	Get the visibility of the entity.
virtual DtElementID	elementID () const
	Get the element id for the entity facade.
virtual makVrv::DtUniqueID	uniqueId () const
	Returns the unique id of the scene object agent.
virtual int	modelSet () const
	Returns the model set being visualized.
DtSceneObjectAgent &	sceneObjectAgent ()
	Returns the scene object agent for this facade.
Spacial Functions
These functions control the spacial parameters of the entity.
virtual void	setPosition (const DtVector &position)
	Set the position of the entity.The change in position will be applied during the DtDe's agent update phase (which occurs during the DtDe tick after the Driver update phase).
virtual DtVector	position () const
	Gets the current position of the entity.
virtual void	setVelocity (const DtVector32 &velocity)
	Set the velocity of the entity.
virtual DtVector32	velocity () const
	Gets the current velocity of the entity.
virtual void	setAcceleration (const DtVector32 &acceleration)
	Set the acceleration of the entity.
virtual DtVector32	acceleration () const
	Gets the current acceleration of the entity.
virtual void	setOrientation (const DtTaitBryan &orientation)
	Set the orientation of the entity.
virtual DtTaitBryan	orientation () const
	Get the current orientation of the entity.
virtual void	setAngularVelocity (const DtVector32 &angularVelocity)
	Set the angular velocity of the entity.
virtual DtVector32	angularVelocity () const
	Set the orientation of the entity.
Advanced Spacial Functions
These functions control the advanced spacial behavior including dead-reckoning, and smoothing.
virtual void	setDeadReckoningEnabled (bool position, bool velocity, bool orientation)
	Set dead reckoning algorithm, whether to dead reckon, position, velocity, and orientation.
virtual void	setSmoothingEnabled (bool enabled)
	Set whether the Entity smooths.
virtual void	setSmoothingPeriod (float period)
	Set the period for entity smoothing.
virtual void	setDamaged (bool damaged)
bool	damaged () const

Protected Member Functions
virtual void	updateIcon ()=0
	Method called to update the visual element when an entity's damage state changes.

Protected Attributes
DtElementID	myElementId
unsigned int	myModelSet
DtSceneObjectAgent *	mySceneObjectAgent
DtDeadReckonUpdaterAgent *	mySceneObjectUpdaterAgent
bool	myDamagedFlag

Detailed Description

The DtEntity2dFacadeBase is the common methods of a facade around agents that make up an entity in the 2D Icon model set.

DtEntity2dFacade extends this to represent the element using a TrueType Font symbol; DtEntity2dImageFacade extends it to represent the element using an image

Constructor & Destructor Documentation

makVrv::DtEntity2dFacadeBase::DtEntity2dFacadeBase	(	DtAgentManagerInterface &	sceneInterface,
		DtElementID	id,
		bool	distribute = false
	)

CTOR.

makVrv::DtEntity2dFacadeBase::DtEntity2dFacadeBase	(	DtAgentManagerInterface &	sceneInterface,
		int	modelSet,
		DtElementID	id,
		bool	distribute = false
	)

CTOR with model set id.

virtual makVrv::DtEntity2dFacadeBase::~DtEntity2dFacadeBase ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEntity2dFacadeBase::setVisible ( bool  visible )

virtual

set the entity's model hidden or visible

virtual bool makVrv::DtEntity2dFacadeBase::visible ( ) const

virtual

Get the visibility of the entity.

virtual DtElementID makVrv::DtEntity2dFacadeBase::elementID ( ) const

virtual

Get the element id for the entity facade.

virtual makVrv::DtUniqueID makVrv::DtEntity2dFacadeBase::uniqueId ( ) const

virtual

Returns the unique id of the scene object agent.

virtual int makVrv::DtEntity2dFacadeBase::modelSet ( ) const

virtual

Returns the model set being visualized.

DtSceneObjectAgent& makVrv::DtEntity2dFacadeBase::sceneObjectAgent

(

)

Returns the scene object agent for this facade.

virtual void makVrv::DtEntity2dFacadeBase::setPosition ( const DtVector &  position )

virtual

Set the position of the entity.The change in position will be applied during the DtDe's agent update phase (which occurs during the DtDe tick after the Driver update phase).

virtual DtVector makVrv::DtEntity2dFacadeBase::position ( ) const

virtual

Gets the current position of the entity.

This value will not update until after the DtDe tick This is not the same as the current velocity. If the entity is being dead-reckoned or smoothed the velocity will change.

virtual void makVrv::DtEntity2dFacadeBase::setVelocity ( const DtVector32 &  velocity )

virtual

Set the velocity of the entity.

The change in velocity will be applied during the DtDe's agent update phase (which occurs during the DtDe tick after the Driver update phase).

virtual DtVector32 makVrv::DtEntity2dFacadeBase::velocity ( ) const

virtual

Gets the current velocity of the entity.

This value will not update until after the DtDe tick. This is not the same as the current velocity. If the entity is being dead-reckoned or smoothed the velocity will change.

virtual void makVrv::DtEntity2dFacadeBase::setAcceleration ( const DtVector32 &  acceleration )

virtual

Set the acceleration of the entity.

virtual DtVector32 makVrv::DtEntity2dFacadeBase::acceleration ( ) const

virtual

Gets the current acceleration of the entity.

This value will not update until after the DtDe tick. This is not the same as the last set acceleration. If the entity is being dead-reckoned or smoothed the velocity will change.

virtual void makVrv::DtEntity2dFacadeBase::setOrientation ( const DtTaitBryan &  orientation )

virtual

Set the orientation of the entity.

virtual DtTaitBryan makVrv::DtEntity2dFacadeBase::orientation ( ) const

virtual

Get the current orientation of the entity.

virtual void makVrv::DtEntity2dFacadeBase::setAngularVelocity ( const DtVector32 &  angularVelocity )

virtual

Set the angular velocity of the entity.

virtual DtVector32 makVrv::DtEntity2dFacadeBase::angularVelocity ( ) const

virtual

Set the orientation of the entity.

virtual void makVrv::DtEntity2dFacadeBase::setDeadReckoningEnabled ( bool  position, bool  velocity, bool  orientation  )

virtual

Set dead reckoning algorithm, whether to dead reckon, position, velocity, and orientation.

virtual void makVrv::DtEntity2dFacadeBase::setSmoothingEnabled ( bool  enabled )

virtual

Set whether the Entity smooths.

virtual void makVrv::DtEntity2dFacadeBase::setSmoothingPeriod ( float  period )

virtual

Set the period for entity smoothing.

virtual void makVrv::DtEntity2dFacadeBase::setDamaged ( bool  damaged )

virtual

bool makVrv::DtEntity2dFacadeBase::damaged

(

)

const

virtual void makVrv::DtEntity2dFacadeBase::updateIcon ( )

protectedpure virtual

Method called to update the visual element when an entity's damage state changes.

Implemented in makVrv::DtEntity2dImageFacade, and makVrv::DtEntity2dFacade.

Member Data Documentation

DtElementID makVrv::DtEntity2dFacadeBase::myElementId

protected

unsigned int makVrv::DtEntity2dFacadeBase::myModelSet

protected

DtSceneObjectAgent* makVrv::DtEntity2dFacadeBase::mySceneObjectAgent

protected

DtDeadReckonUpdaterAgent* makVrv::DtEntity2dFacadeBase::mySceneObjectUpdaterAgent

protected

bool makVrv::DtEntity2dFacadeBase::myDamagedFlag

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtEntity2dFacadeBase.h