VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtEntity2dFacade Class Reference

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

List of all members.

Public Member Functions

 DtEntity2dFacade (DtAgentManagerInterface &sceneInterface, DtElementID id, bool distribute=false)
 CTOR.
virtual ~DtEntity2dFacade ()
 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, 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.
Icon functions

These functions control the icon display of the entity.

virtual void setIconModelDefinition (const std::string &modelDefinitionName)
 Set the model definition for the icon.
virtual void setOutlineColor (const float color[4])
 Set the model definition for the icon.
virtual void setFillColor (const float color[4])
 Set the model definition for the icon.
virtual void setOutlineGlyph (DtUnicodeChar glyph)
 Set the model definition for the icon.
virtual void setFillGlyph (DtUnicodeChar glyph)
 Set the model definition for the icon.
virtual void setDamageGlyph (DtUnicodeChar glyph)
 Set the model definition for the icon.
virtual void setDamaged (bool damaged)
 Set the model definition for the icon.
bool damaged () const
 Set the model definition for the icon.

Protected Member Functions

virtual void updateIcon ()
virtual DtUnicode generateSymbolString (float fillColor[4], float outlineColor[4]) const

Protected Attributes

DtElementID myElementId
unsigned int myModelSet
DtSceneObjectAgent * mySceneObjectAgent
DtProjectedWidgetModelAgent * myProjectIconModelAgent
DtWidgetLabelAgent * mySymbolLabelAgent
DtDeadReckonUpdaterAgent * mySceneObjectUpdaterAgent
DtUnicodeChar myOutlineGlyph
DtUnicodeChar myFillGlyph
DtUnicodeChar myDamageGlyph
DtUnicode mySymbolString
bool myDamagedFlag
float myFillColor [4]
float myOutlineColor [4]

Detailed Description

The DtEntity2dFacade is a facade around agents that make up an entity in the 2D Icon model set.


Constructor & Destructor Documentation

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

CTOR.

DTOR.


Member Function Documentation

virtual void makVrv::DtEntity2dFacade::setVisible ( bool  visible) [virtual]

set the entity's model hidden or visible

virtual bool makVrv::DtEntity2dFacade::visible ( ) const [virtual]

Get the visibility of the entity.

virtual DtElementID makVrv::DtEntity2dFacade::elementID ( ) const [virtual]

Get the element id for the entity facade.

virtual int makVrv::DtEntity2dFacade::modelSet ( ) const [virtual]

Returns the model set being visualized.

Returns the scene object agent for this facade.

virtual void makVrv::DtEntity2dFacade::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::DtEntity2dFacade::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::DtEntity2dFacade::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::DtEntity2dFacade::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::DtEntity2dFacade::setAcceleration ( const DtVector acceleration) [virtual]

Set the acceleration of the entity.

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

Set the orientation of the entity.

virtual DtTaitBryan makVrv::DtEntity2dFacade::orientation ( ) const [virtual]

Get the current orientation of the entity.

virtual void makVrv::DtEntity2dFacade::setAngularVelocity ( const DtVector angularVelocity) [virtual]

Set the angular velocity of the entity.

Set the orientation of the entity.

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

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

virtual void makVrv::DtEntity2dFacade::setSmoothingEnabled ( bool  enabled) [virtual]

Set whether the Entity smooths.

virtual void makVrv::DtEntity2dFacade::setSmoothingPeriod ( float  period) [virtual]

Set the period for entity smoothing.

virtual void makVrv::DtEntity2dFacade::setIconModelDefinition ( const std::string &  modelDefinitionName) [virtual]

Set the model definition for the icon.

virtual void makVrv::DtEntity2dFacade::setOutlineColor ( const float  color[4]) [virtual]

Set the model definition for the icon.

virtual void makVrv::DtEntity2dFacade::setFillColor ( const float  color[4]) [virtual]

Set the model definition for the icon.

virtual void makVrv::DtEntity2dFacade::setOutlineGlyph ( DtUnicodeChar  glyph) [virtual]

Set the model definition for the icon.

virtual void makVrv::DtEntity2dFacade::setFillGlyph ( DtUnicodeChar  glyph) [virtual]

Set the model definition for the icon.

virtual void makVrv::DtEntity2dFacade::setDamageGlyph ( DtUnicodeChar  glyph) [virtual]

Set the model definition for the icon.

virtual void makVrv::DtEntity2dFacade::setDamaged ( bool  damaged) [virtual]

Set the model definition for the icon.

Set the model definition for the icon.

virtual void makVrv::DtEntity2dFacade::updateIcon ( ) [protected, virtual]
virtual DtUnicode makVrv::DtEntity2dFacade::generateSymbolString ( float  fillColor[4],
float  outlineColor[4] 
) const [protected, virtual]

Member Data Documentation

unsigned int makVrv::DtEntity2dFacade::myModelSet [protected]
DtSceneObjectAgent* makVrv::DtEntity2dFacade::mySceneObjectAgent [protected]
DtProjectedWidgetModelAgent* makVrv::DtEntity2dFacade::myProjectIconModelAgent [protected]
DtWidgetLabelAgent* makVrv::DtEntity2dFacade::mySymbolLabelAgent [protected]
DtDeadReckonUpdaterAgent* makVrv::DtEntity2dFacade::mySceneObjectUpdaterAgent [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)