makVrv::DtEntity3dFacade Class Reference

The DtEntity3dFacade is a facade around agents that make up an entity in the 3D model set. More...

Public Member Functions
	DtEntity3dFacade (DtAgentManagerInterface &sceneInterface, DtElementID id, bool distribute=false)
	CTOR Creates a 3d Facade for the 3D model set.
	DtEntity3dFacade (DtAgentManagerInterface &sceneInterface, DtElementID id, int modelset, bool distribute=false)
	CTOR Creates a 3d Facade for the any model set.
virtual	~DtEntity3dFacade ()
	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 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 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.
Articulated Model Functions
These functions control the appearance of an articulated model representing the entity.
virtual void	setArticulatedModelDefinition (const std::string &modelName)
	Set the entity's model definition names.
virtual void	setModelScalingEnabled (bool enabled)
	Enable/Disable model scaling.
virtual void	setPartOrientation (int partNumber, const DtTaitBryan &orientation, const DtVector &angularVelocity)
	Set an articulated part orientation.
virtual void	setPartTranslation (int partNumber, const DtVector &translation, const DtVector &velocity)
	Set an articulated part translation.
virtual void	setPartVisibility (int partNumber, bool onOff)
	Sets the visibility of an articulated part.

Protected Attributes
DtElementID	myElementId
int	myModelSet
DtSceneObjectAgent *	mySceneObjectAgent
DtArticulatedModelAgent *	myModelAgent
DtDeadReckonGroundClampUpdaterAgent *	mySceneObjectUpdaterAgent

Detailed Description

The DtEntity3dFacade is a facade around agents that make up an entity in the 3D model set.

Constructor & Destructor Documentation

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

CTOR Creates a 3d Facade for the 3D model set.

makVrv::DtEntity3dFacade::DtEntity3dFacade	(	DtAgentManagerInterface &	sceneInterface,
		DtElementID	id,
		int	modelset,
		bool	distribute = false
	)

CTOR Creates a 3d Facade for the any model set.

virtual makVrv::DtEntity3dFacade::~DtEntity3dFacade ( )

virtual

DTOR.

Member Function Documentation

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

virtual

set the entity's model hidden or visible

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

virtual

Get the visibility of the entity.

virtual DtElementID makVrv::DtEntity3dFacade::elementId ( ) const

virtual

Get the element id for the entity facade.

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

virtual

Returns the model set being visualized.

DtSceneObjectAgent& makVrv::DtEntity3dFacade::sceneObjectAgent

(

)

Returns the scene object agent for this facade.

virtual void makVrv::DtEntity3dFacade::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::DtEntity3dFacade::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::DtEntity3dFacade::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::DtEntity3dFacade::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::DtEntity3dFacade::setAcceleration ( const DtVector &  acceleration )

virtual

Set the acceleration of the entity.

virtual DtVector makVrv::DtEntity3dFacade::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::DtEntity3dFacade::setOrientation ( const DtTaitBryan &  orientation )

virtual

Set the orientation of the entity.

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

virtual

Get the current orientation of the entity.

virtual void makVrv::DtEntity3dFacade::setAngularVelocity ( const DtVector &  angularVelocity )

virtual

Set the angular velocity of the entity.

virtual DtVector makVrv::DtEntity3dFacade::angularVelocity ( ) const

virtual

Set the orientation of the entity.

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

virtual

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

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

virtual

Set whether the Entity smooths.

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

virtual

Set the period for entity smoothing.

virtual void makVrv::DtEntity3dFacade::setGroundClampingMode ( DtGroundClampingUpdater::GroundClampingMode  mode )

virtual

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

virtual void makVrv::DtEntity3dFacade::setArticulatedModelDefinition ( const std::string &  modelName )

virtual

Set the entity's model definition names.

virtual void makVrv::DtEntity3dFacade::setModelScalingEnabled ( bool  enabled )

virtual

Enable/Disable model scaling.

virtual void makVrv::DtEntity3dFacade::setPartOrientation ( int  partNumber, const DtTaitBryan &  orientation, const DtVector &  angularVelocity  )

virtual

Set an articulated part orientation.

virtual void makVrv::DtEntity3dFacade::setPartTranslation ( int  partNumber, const DtVector &  translation, const DtVector &  velocity  )

virtual

Set an articulated part translation.

virtual void makVrv::DtEntity3dFacade::setPartVisibility ( int  partNumber, bool  onOff  )

virtual

Sets the visibility of an articulated part.

Member Data Documentation

DtElementID makVrv::DtEntity3dFacade::myElementId

protected

int makVrv::DtEntity3dFacade::myModelSet

protected

DtSceneObjectAgent* makVrv::DtEntity3dFacade::mySceneObjectAgent

protected

DtArticulatedModelAgent* makVrv::DtEntity3dFacade::myModelAgent

protected

DtDeadReckonGroundClampUpdaterAgent* makVrv::DtEntity3dFacade::mySceneObjectUpdaterAgent

protected

---

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

• include/vrvCore/DtEntity3dFacade.h