makVrv::DtEntityFacade Class Reference

The DtEntityFacade is a facade around agents that make up an entity. More...

List of all members.

Public Member Functions
	DtEntityFacade (DtAgentManagerInterface &sceneInterface, DtElementID id, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute=false)
	CTOR.
virtual	~DtEntityFacade ()
	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.
const DtEntity3dFacade *	findFacadeFor3d () const
	set the entity's model hidden or visible
DtEntity3dFacade *	findFacadeFor3d ()
	set the entity's model hidden or visible
const DtEntity3dFacade *	findFacadeForColorized () const
	set the entity's model hidden or visible
DtEntity3dFacade *	findFacadeForColorized ()
	set the entity's model hidden or visible
const DtEntity2dFacade *	findFacadeFor2d () const
	set the entity's model hidden or visible
DtEntity2dFacade *	findFacadeFor2d ()
	set the entity's model hidden or visible
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 DtVector &velocity)
	Set the velocity of the entity.
virtual DtVector	velocity () const
	Gets the current velocity of the entity.
virtual void	setAcceleration (const DtVector &acceleration)
	Set the acceleration of the entity.
virtual DtVector	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 DtVector &angularVelocity)
	Set the angular velocity of the entity.
virtual DtVector	angularVelocity () const
	Set the orientation of the entity.
Advanced Spacial Functions
These functions control the advanced spacial behavior including dead-reckoning, smoothing and ground clamping.
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	setGroundClampingMode (DtGroundClampingUpdater::GroundClampingMode mode)
	Set ground clamping mode using bit flags defined in DtGroundClampingUpdater::GroundClampingMode.
Protected Attributes
DtElementID	myElementId
DtEntity3dFacade *	my3dFacade
DtEntity3dFacade *	myColorizedFacade
DtEntity2dFacade *	my2dFacade

---

Detailed Description

The DtEntityFacade is a facade around agents that make up an entity.

This entity facade represents a scene objects and models in the 3D, 2D, and XR model sets.

---

Constructor & Destructor Documentation

makVrv::DtEntityFacade::DtEntityFacade	(	DtAgentManagerInterface &	sceneInterface,
		DtElementID	id,
		const DtModelSetRealizationManager::ModelSetRealizations &	modelSets,
		bool	distribute = false
	)

CTOR.

virtual makVrv::DtEntityFacade::~DtEntityFacade

(

)

[virtual]

DTOR.

---

Member Function Documentation

virtual void makVrv::DtEntityFacade::setVisible

(

bool

visible

)

[virtual]

set the entity's model hidden or visible

virtual bool makVrv::DtEntityFacade::visible

(

)

const [virtual]

Get the visibility of the entity.

virtual DtElementID makVrv::DtEntityFacade::elementId

(

)

const [virtual]

Get the element id for the entity facade.

const DtEntity3dFacade* makVrv::DtEntityFacade::findFacadeFor3d

(

)

const

set the entity's model hidden or visible

DtEntity3dFacade* makVrv::DtEntityFacade::findFacadeFor3d

(

)

set the entity's model hidden or visible

const DtEntity3dFacade* makVrv::DtEntityFacade::findFacadeForColorized

(

)

const

set the entity's model hidden or visible

DtEntity3dFacade* makVrv::DtEntityFacade::findFacadeForColorized

(

)

set the entity's model hidden or visible

const DtEntity2dFacade* makVrv::DtEntityFacade::findFacadeFor2d

(

)

const

set the entity's model hidden or visible

DtEntity2dFacade* makVrv::DtEntityFacade::findFacadeFor2d

(

)

set the entity's model hidden or visible

virtual void makVrv::DtEntityFacade::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::DtEntityFacade::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::DtEntityFacade::setVelocity

(

const DtVector &

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 DtVector makVrv::DtEntityFacade::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::DtEntityFacade::setAcceleration

(

const DtVector &

acceleration

)

[virtual]

Set the acceleration of the entity.

virtual DtVector makVrv::DtEntityFacade::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::DtEntityFacade::setOrientation

(

const DtTaitBryan &

orientation

)

[virtual]

Set the orientation of the entity.

virtual DtTaitBryan makVrv::DtEntityFacade::orientation

(

)

const [virtual]

Get the current orientation of the entity.

virtual void makVrv::DtEntityFacade::setAngularVelocity

(

const DtVector &

angularVelocity

)

[virtual]

Set the angular velocity of the entity.

virtual DtVector makVrv::DtEntityFacade::angularVelocity

(

)

const [virtual]

Set the orientation of the entity.

virtual void makVrv::DtEntityFacade::setDeadReckoningEnabled	(	bool	position,
		bool	velocity,
		bool	orientation
	)		[virtual]

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

virtual void makVrv::DtEntityFacade::setSmoothingEnabled

(

bool

enabled

)

[virtual]

Set whether the Entity smooths.

virtual void makVrv::DtEntityFacade::setSmoothingPeriod

(

float

period

)

[virtual]

Set the period for entity smoothing.

virtual void makVrv::DtEntityFacade::setGroundClampingMode

(

DtGroundClampingUpdater::GroundClampingMode

mode

)

[virtual]

Set ground clamping mode using bit flags defined in DtGroundClampingUpdater::GroundClampingMode.

---

Member Data Documentation

DtElementID makVrv::DtEntityFacade::myElementId [protected]

DtEntity3dFacade* makVrv::DtEntityFacade::my3dFacade [protected]

DtEntity3dFacade* makVrv::DtEntityFacade::myColorizedFacade [protected]

DtEntity2dFacade* makVrv::DtEntityFacade::my2dFacade [protected]

---

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

• include/vrvCore/DtEntityFacade.h