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 Colorized model sets.

Inheritance diagram for makVrv::DtEntityFacade:

[legend]

Public Member Functions
	DtEntityFacade (DtAgentManagerInterface &sceneInterface, DtSharedSettingsManager &settingsManager, DtElementID id, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute=false, bool useImageFor2d=false)

	DtEntityFacade (DtAgentManagerInterface &sceneInterface, DtSharedSettingsManager &settingsManager, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute=false, bool useImageFor2d=false)

virtual	~DtEntityFacade ()

Entity Facade functions
These functions get parameters of the entity facade. representing the entity.
virtual void	setVisible (bool visible)

virtual bool	visible () const

virtual DtElementID	elementId () const

const DtEntity3dFacade *	findFacadeFor3d () const

DtEntity3dFacade *	findFacadeFor3d ()


const DtEntity3dFacade *	findFacadeForColorized () const

DtEntity3dFacade *	findFacadeForColorized ()


const DtEntity2dFacade *	findFacadeFor2d () const

DtEntity2dFacade *	findFacadeFor2d ()


const DtEntity2dImageFacade *	findFacadeFor2dImage () const

DtEntity2dImageFacade *	findFacadeFor2dImage ()

Spacial Functions
These functions control the spacial parameters of the entity.
virtual void	setPosition (const DtVector &position)

virtual DtVector	position () const

virtual void	setVelocity (const DtVector32 &velocity)

virtual DtVector32	velocity () const

virtual void	setAcceleration (const DtVector32 &acceleration)

virtual DtVector32	acceleration () const

virtual void	setOrientation (const DtTaitBryan &orientation)

virtual DtTaitBryan	orientation () const

virtual void	setAngularVelocity (const DtVector32 &angularVelocity)

virtual DtVector32	angularVelocity () const

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)

virtual void	setSmoothingEnabled (bool enabled)

virtual void	setSmoothingPeriod (float period)

virtual void	setGroundClampingMode (DtGroundClampingUpdater::GroundClampingMode mode)

virtual void	SetGroundClampingCullCylinderRadiusScale (float scale)

void	setDisplayName (const std::string &displayName)

const std::string &	displayName () const

virtual void	setLightpointMaxDistance (float distance)

Protected Member Functions
void	buildFacade (DtAgentManagerInterface &sceneInterface, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute, bool useImageFor2d)

Protected Attributes
DtSharedSettingsManager &	mySharedSettingsManager

DtElementID	myElementId

std::string	myDisplayName

DtEntity3dFacade *	my3dFacade

DtEntity3dFacade *	myColorizedFacade

DtEntity2dFacadeBase *	my2dFacade

Constructor & Destructor Documentation

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

CTOR.

makVrv::DtEntityFacade::DtEntityFacade	(	DtAgentManagerInterface &	sceneInterface,
		DtSharedSettingsManager &	settingsManager,
		const DtModelSetRealizationManager::ModelSetRealizations &	modelSets,
		bool	distribute = `false`,
		bool	useImageFor2d = `false`
	)

CTOR (will supply elementID)

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

Get the facade created for the 3D modelset, if requested in the modelsets list provided to the constructor.

DtEntity3dFacade* makVrv::DtEntityFacade::findFacadeFor3d ( )

set the entity's model hidden or visible

const DtEntity3dFacade* makVrv::DtEntityFacade::findFacadeForColorized ( ) const

Get the facade created for the colorized modelset, if requested in the modelsets list provided to the constructor.

DtEntity3dFacade* makVrv::DtEntityFacade::findFacadeForColorized ( )

Get the facade created for the colorized modelset, if requested in the modelsets list provided to the constructor.

const DtEntity2dFacade* makVrv::DtEntityFacade::findFacadeFor2d ( ) const

Get the facade created for the 2D modelset, if requested in the modelsets list provided to the constructor and if useImageFor2d is false (the default)

DtEntity2dFacade* makVrv::DtEntityFacade::findFacadeFor2d ( )

Get the facade created for the 2D modelset, if requested in the modelsets list provided to the constructor and if useImageFor2d is false (the default)

const DtEntity2dImageFacade* makVrv::DtEntityFacade::findFacadeFor2dImage ( ) const

Get the facade created for the 2D modelset, if requested in the modelsets list provided to the constructor and if useImageFor2d is true.

DtEntity2dImageFacade* makVrv::DtEntityFacade::findFacadeFor2dImage ( )

Get the facade created for the 2D modelset, if requested in the modelsets list provided to the constructor and if useImageFor2d is true.

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 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::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 DtVector32 & acceleration )

virtual

Set the acceleration of the entity.

virtual DtVector32 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 DtVector32 & angularVelocity )

virtual

Set the angular velocity of the entity.

virtual DtVector32 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.

virtual void makVrv::DtEntityFacade::SetGroundClampingCullCylinderRadiusScale ( float scale )

virtual

Set the scale multiplier used to determine whether or not to cull the target according to its distance from the eye-point. This is used by the DtEntity3dFacade DtGroundClampingUpdater agents associated with this facade.

void makVrv::DtEntityFacade::setDisplayName ( const std::string & displayName )

Set the display name for the entity.

const std::string& makVrv::DtEntityFacade::displayName ( ) const

Get the display name for this entity.

virtual void makVrv::DtEntityFacade::setLightpointMaxDistance ( float distance )

virtual

Lightpoint range control.

void makVrv::DtEntityFacade::buildFacade	(	DtAgentManagerInterface &	sceneInterface,
		const DtModelSetRealizationManager::ModelSetRealizations &	modelSets,
		bool	distribute,
		bool	useImageFor2d
	)

protected

Member Data Documentation

DtSharedSettingsManager& makVrv::DtEntityFacade::mySharedSettingsManager

protected

DtElementID makVrv::DtEntityFacade::myElementId

protected

std::string makVrv::DtEntityFacade::myDisplayName

protected

DtEntity3dFacade* makVrv::DtEntityFacade::my3dFacade

protected

DtEntity3dFacade* makVrv::DtEntityFacade::myColorizedFacade

protected

DtEntity2dFacadeBase* makVrv::DtEntityFacade::my2dFacade

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtEntityFacade.h

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation