VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtEntity2dImageFacade Class Reference

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

Inheritance diagram for makVrv::DtEntity2dImageFacade:
Inheritance graph
[legend]

Public Member Functions

 DtEntity2dImageFacade (DtAgentManagerInterface &sceneInterface, DtElementID id, bool distribute=false)
 CTOR.
 DtEntity2dImageFacade (DtAgentManagerInterface &sceneInterface, int modelSet, DtElementID id, bool distribute=false)
 CTOR with model set id.
virtual ~DtEntity2dImageFacade ()
 DTOR.
Image functions

These functions control the image display of the entity.

virtual void setIconModelDefinition (const std::string &def)
 Set/get the model definition for the image to use for the main icon.
virtual std::string iconModelDefinition () const
virtual void setDestroyedIconModelDefinition (const std::string &def)
 Set/get the model definition for the image to use for the destroyed icon.
virtual std::string destroyedIconModelDefinition () const
virtual void setScale (float scale)
 Set/get a scale factor to by used to scale the main and destroyed images.
float scale () const
virtual void setImageSize (int sizeX, int sizeY)
 Set/get the image size (before scaling) to use for the main and destroyed icons.
virtual void getImageSize (int &sizeX, int &sizeY)
- Public Member Functions inherited from makVrv::DtEntity2dFacadeBase
 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.
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.
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.
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 ()
 Method called to update the visual element when an entity's damage state changes.

Protected Attributes

DtProjectedWidgetModelAgent * myProjectIconModelAgent
DtWidgetAgent * myIcon
DtWidgetAgent * myDestroyedIcon
float myScale
unsigned int myIconGroup
unsigned int myDestroyedIconGroup
int mySizeX
int mySizeY
std::string myIconModelDefinition
std::string myDestroyedIconModelDefinition
- Protected Attributes inherited from makVrv::DtEntity2dFacadeBase
DtElementID myElementId
unsigned int myModelSet
DtSceneObjectAgent * mySceneObjectAgent
DtDeadReckonUpdaterAgent * mySceneObjectUpdaterAgent
bool myDamagedFlag

Detailed Description

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

Constructor & Destructor Documentation

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

CTOR.

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

CTOR with model set id.

virtual makVrv::DtEntity2dImageFacade::~DtEntity2dImageFacade ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEntity2dImageFacade::setIconModelDefinition ( const std::string &  def)
virtual

Set/get the model definition for the image to use for the main icon.

If unset, the default is "2525a_unknown"

virtual std::string makVrv::DtEntity2dImageFacade::iconModelDefinition ( ) const
virtual
virtual void makVrv::DtEntity2dImageFacade::setDestroyedIconModelDefinition ( const std::string &  def)
virtual

Set/get the model definition for the image to use for the destroyed icon.

This icon is drawn OVER the main icon when the facade's damage state is set to true. The default is "Destroyed"

virtual std::string makVrv::DtEntity2dImageFacade::destroyedIconModelDefinition ( ) const
virtual
virtual void makVrv::DtEntity2dImageFacade::setScale ( float  scale)
virtual

Set/get a scale factor to by used to scale the main and destroyed images.

float makVrv::DtEntity2dImageFacade::scale ( ) const
virtual void makVrv::DtEntity2dImageFacade::setImageSize ( int  sizeX,
int  sizeY 
)
virtual

Set/get the image size (before scaling) to use for the main and destroyed icons.

virtual void makVrv::DtEntity2dImageFacade::getImageSize ( int sizeX,
int sizeY 
)
virtual
virtual void makVrv::DtEntity2dImageFacade::updateIcon ( )
protectedvirtual

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

Implements makVrv::DtEntity2dFacadeBase.

Member Data Documentation

DtProjectedWidgetModelAgent* makVrv::DtEntity2dImageFacade::myProjectIconModelAgent
protected
DtWidgetAgent* makVrv::DtEntity2dImageFacade::myIcon
protected
DtWidgetAgent* makVrv::DtEntity2dImageFacade::myDestroyedIcon
protected
float makVrv::DtEntity2dImageFacade::myScale
protected
unsigned int makVrv::DtEntity2dImageFacade::myIconGroup
protected
unsigned int makVrv::DtEntity2dImageFacade::myDestroyedIconGroup
protected
int makVrv::DtEntity2dImageFacade::mySizeX
protected
int makVrv::DtEntity2dImageFacade::mySizeY
protected
std::string makVrv::DtEntity2dImageFacade::myIconModelDefinition
protected
std::string makVrv::DtEntity2dImageFacade::myDestroyedIconModelDefinition
protected

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

Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)