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

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

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

Public Member Functions

 DtBuoyOrBeaconFacade (DtAgentManagerInterface &sceneInterface, DtSharedSettingsManager &settingsManager, DtElementID id, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute=false, bool useImageFor2d=false)
 CTOR.
 DtBuoyOrBeaconFacade (DtAgentManagerInterface &sceneInterface, DtSharedSettingsManager &settingsManager, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute=false, bool useImageFor2d=false)
 CTOR (will supply elementID)
virtual ~DtBuoyOrBeaconFacade ()
 DTOR.
virtual void setUnlightedIconModelDefinition (const std::string &modelDef)
virtual std::string unlightedIconModelDefinition () const
virtual void setLightedIconModelDefinition (const std::string &modelDef)
virtual std::string lightedIconModelDefinition () const
virtual void set2dIconLighted (bool lighted)
virtual void setTextureAtlasIndex (const std::string &file)
 Set which file is used for this buoy or beacon to look for texture uv offsets.
virtual const std::string & textureAtlasIndex () const
 Retrieve the file containing texture UV offsets for attachable items.
virtual void setTextureAtlasKey (DtBuoyBeaconLayer::AttachableTypes type, const std::string &key)
 Set the key in the texture atlas for each attachable type that might be attached to the buoy or beacon.
virtual const std::string & textureAtlasKey (DtBuoyBeaconLayer::AttachableTypes type) const
 Get the key in the texture atlas for each attachable type.
virtual void setTextureAtlasIndexParser (DtTextureAtlasIndexParser *parser)
 Atlas file parsing should be done by the same object, keep the parser around to look for values later for daymarks and topmarks.
virtual DtTextureAtlasIndexParsertextureAtlasIndexParser ()
 Which parser was used during the set up of this object (ex.
virtual void setDesignator (const std::string &designator)
 Set/Get the designator string for this buoy or beacon In some cases the designator is displayed on an attachable part (like the daymark) so keep track of it here so it can be set if such an item is attached.
virtual const std::string & designator () const
 Set/Get the designator string for this buoy or beacon In some cases the designator is displayed on an attachable part (like the daymark) so keep track of it here so it can be set if such an item is attached.
virtual void setDesignatorTextureAtlasIndex (const std::string &filename)
 Set/Get the texture atlas index file for designators.
virtual const std::string & designatorTextureAtlasIndex () const
 Set/Get the texture atlas index file for designators.
- Public Member Functions inherited from makVrv::DtEntityFacade
 DtEntityFacade (DtAgentManagerInterface &sceneInterface, DtSharedSettingsManager &settingsManager, DtElementID id, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute=false, bool useImageFor2d=false)
 CTOR.
 DtEntityFacade (DtAgentManagerInterface &sceneInterface, DtSharedSettingsManager &settingsManager, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute=false, bool useImageFor2d=false)
 CTOR (will supply elementID)
virtual ~DtEntityFacade ()
 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.
const DtEntity3dFacadefindFacadeFor3d () const
 Get the facade created for the 3D modelset, if requested in the modelsets list provided to the constructor.
DtEntity3dFacadefindFacadeFor3d ()
 set the entity's model hidden or visible
const DtEntity3dFacadefindFacadeForColorized () const
 Get the facade created for the colorized modelset, if requested in the modelsets list provided to the constructor.
DtEntity3dFacadefindFacadeForColorized ()
 Get the facade created for the colorized modelset, if requested in the modelsets list provided to the constructor.
const DtEntity2dFacadefindFacadeFor2d () 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)
DtEntity2dFacadefindFacadeFor2d ()
 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 DtEntity2dImageFacadefindFacadeFor2dImage () const
 Get the facade created for the 2D modelset, if requested in the modelsets list provided to the constructor and if useImageFor2d is true.
DtEntity2dImageFacadefindFacadeFor2dImage ()
 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 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.
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.
void setDisplayName (const std::string displayName)
 Set the display name for the entity.
const std::string & displayName () const
 Get the display name for this entity.

Protected Attributes

std::string myUnlightedIconModelDefinition
std::string myLightedIconModelDefinition
bool myLighted
std::string myTextureAtlasIndex
std::string myTextureAtlasKeys [DtBuoyBeaconLayer::NumAttachableTypes]
DtTextureAtlasIndexParsermyTextureAtlasIndexParser
std::string myDesignator
std::string myDesignatorTextureAtlasIndex
- Protected Attributes inherited from makVrv::DtEntityFacade
DtSharedSettingsManagermySharedSettingsManager
DtElementID myElementId
std::string myDisplayName
DtEntity3dFacademy3dFacade
DtEntity3dFacademyColorizedFacade
DtEntity2dFacadeBasemy2dFacade

Additional Inherited Members

- Protected Member Functions inherited from makVrv::DtEntityFacade
void buildFacade (DtAgentManagerInterface &sceneInterface, const DtModelSetRealizationManager::ModelSetRealizations &modelSets, bool distribute, bool useImageFor2d)

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

Constructor & Destructor Documentation

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

CTOR.

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

CTOR (will supply elementID)

virtual makVrv::DtBuoyOrBeaconFacade::~DtBuoyOrBeaconFacade ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtBuoyOrBeaconFacade::setUnlightedIconModelDefinition ( const std::string &  modelDef)
virtual
virtual std::string makVrv::DtBuoyOrBeaconFacade::unlightedIconModelDefinition ( ) const
virtual
virtual void makVrv::DtBuoyOrBeaconFacade::setLightedIconModelDefinition ( const std::string &  modelDef)
virtual
virtual std::string makVrv::DtBuoyOrBeaconFacade::lightedIconModelDefinition ( ) const
virtual
virtual void makVrv::DtBuoyOrBeaconFacade::set2dIconLighted ( bool  lighted)
virtual
virtual void makVrv::DtBuoyOrBeaconFacade::setTextureAtlasIndex ( const std::string &  file)
virtual

Set which file is used for this buoy or beacon to look for texture uv offsets.

virtual const std::string& makVrv::DtBuoyOrBeaconFacade::textureAtlasIndex ( ) const
virtual

Retrieve the file containing texture UV offsets for attachable items.

virtual void makVrv::DtBuoyOrBeaconFacade::setTextureAtlasKey ( DtBuoyBeaconLayer::AttachableTypes  type,
const std::string &  key 
)
virtual

Set the key in the texture atlas for each attachable type that might be attached to the buoy or beacon.

virtual const std::string& makVrv::DtBuoyOrBeaconFacade::textureAtlasKey ( DtBuoyBeaconLayer::AttachableTypes  type) const
virtual

Get the key in the texture atlas for each attachable type.

virtual void makVrv::DtBuoyOrBeaconFacade::setTextureAtlasIndexParser ( DtTextureAtlasIndexParser parser)
virtual

Atlas file parsing should be done by the same object, keep the parser around to look for values later for daymarks and topmarks.

virtual DtTextureAtlasIndexParser* makVrv::DtBuoyOrBeaconFacade::textureAtlasIndexParser ( )
virtual

Which parser was used during the set up of this object (ex.

buoys should use the same parser)

virtual void makVrv::DtBuoyOrBeaconFacade::setDesignator ( const std::string &  designator)
virtual

Set/Get the designator string for this buoy or beacon In some cases the designator is displayed on an attachable part (like the daymark) so keep track of it here so it can be set if such an item is attached.

virtual const std::string& makVrv::DtBuoyOrBeaconFacade::designator ( ) const
virtual

Set/Get the designator string for this buoy or beacon In some cases the designator is displayed on an attachable part (like the daymark) so keep track of it here so it can be set if such an item is attached.

virtual void makVrv::DtBuoyOrBeaconFacade::setDesignatorTextureAtlasIndex ( const std::string &  filename)
virtual

Set/Get the texture atlas index file for designators.

virtual const std::string& makVrv::DtBuoyOrBeaconFacade::designatorTextureAtlasIndex ( ) const
virtual

Set/Get the texture atlas index file for designators.

Member Data Documentation

std::string makVrv::DtBuoyOrBeaconFacade::myUnlightedIconModelDefinition
protected
std::string makVrv::DtBuoyOrBeaconFacade::myLightedIconModelDefinition
protected
bool makVrv::DtBuoyOrBeaconFacade::myLighted
protected
std::string makVrv::DtBuoyOrBeaconFacade::myTextureAtlasIndex
protected
std::string makVrv::DtBuoyOrBeaconFacade::myTextureAtlasKeys[DtBuoyBeaconLayer::NumAttachableTypes]
protected
DtTextureAtlasIndexParser* makVrv::DtBuoyOrBeaconFacade::myTextureAtlasIndexParser
protected
std::string makVrv::DtBuoyOrBeaconFacade::myDesignator
protected
std::string makVrv::DtBuoyOrBeaconFacade::myDesignatorTextureAtlasIndex
protected

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

Document ID: Generated on Wed Jul 29 00:55:00 EDT 2015 from SVN revision 155257
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)