VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtCuboidStateVisualizer Class Reference

DtCuboidStateVisualizer objects are responsible for displaying cuboid object. More...

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

Public Member Functions

 DtCuboidStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 Constructor.
virtual ~DtCuboidStateVisualizer ()
 Destructor.
virtual void setDimensions (const DtVector &dim)
 Sets the dimensions of the cuboid.
virtual void setColor (float r, float g, float b, float a)
 Sets the color of the cuboid.
virtual void setFlashing (bool flashing)
 Sets whether the cuboid is flashing.
virtual void setPosition (const DtVector &pos)
 Sets the position of the cuboid in database coordinates, or body coordinates (if attached)
virtual void setOrientation (const DtTaitBryan &orientation)
 Sets the orientation of the cuboid in database coordinates.
virtual void setAttached (DtUniqueID id, int vtx, double percentage)
 Attaches the cuboid to the unique ID specified.
virtual void setHostId (const std::string &id, int vtx, double percentage)
 Sets the host ID attached to. Overridden by child classes.
virtual const
DtStateVisualizer::TypeInfo
typeInfo () const
 The instance's type info.
- Public Member Functions inherited from makVrv::DtSceneObjectVisualizer
 DtSceneObjectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
virtual ~DtSceneObjectVisualizer ()
virtual DtUniqueID uniqueID () const
 Return unique id of mySceneObjectAgent, if it exists, else returns 0;.
virtual DtSceneObjectAgent * sceneObjectAgent ()
virtual void setParent (DtStateVisualizer *p)
 Override of base class setParent to simply set the parent without destroying/recreating model agents.
virtual void setSceneObjectAgent (DtSceneObjectAgent *)
virtual void setElementID (const DtElementID &elementID)
DtElementID elementID () const
virtual bool show (int)
 Override to show/hide scene object agent (if it exists)
virtual bool hide (int)
 Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtStateVisualizer ()
 DTOR.
void setModelDefinition (const std::string &definition)
 Sets the model definition and creates agent(s) based on that definition.
const std::string & modelDefinition () const
 Gets the current model definition.
virtual bool setVisible (bool visible, int context)
 Returns true if this context wants to show or hide the item.
virtual void initialize ()
 Initialize the visualizer.
virtual bool isVisible () const
 Returns true if visible.
virtual void setSelected (bool)
 Sets selected state.
virtual bool selected () const
void setName (const std::string &)
 Internal name of state visualizer.
const std::string & name () const
virtual void setPickable (bool)
 Sets pickable state.
virtual bool pickable () const
virtual void setUniqueID (DtUniqueID id)
int visualizerType () const
void setShowHideContext (const std::vector< int > &s)
 Set show/hide context without changing visibility of item.
virtual void setVisualizerDefinition (const DtVisualizerDefinition &)
 Set any other additional visualizer information from the visual record.
DtStateListenerlistener ()
DtBaseConnectionsimulation ()
 Get the connection for this visualizer.
void setDistribute (bool b)
 Whether or not to distribute over the network.
bool distribute () const
- Public Member Functions inherited from makVrv::DtRemoteGraphicVisualizerAttributes
 DtRemoteGraphicVisualizerAttributes ()
 CTOR.
virtual ~DtRemoteGraphicVisualizerAttributes ()
 DTOR.
virtual void setActive (bool active)
 Set the graphic active or inactive.
virtual void setLayerName (const std::string &layerName)
 Sets the layer that the graphic is in.

Static Public Member Functions

static const
DtStateVisualizer::TypeInfo
theTypeInfo ()
 This class's type info.

Protected Member Functions

virtual void setVisible (bool yesNo)
virtual void createModelAgents ()
 Creates the model agent. If already created, makes it visible.
virtual void destroyModelAgents ()
 Model agent is only destroyed in destructor.
virtual void setModelDefinitionForAgents ()
 Sets model definition for all the agents that this visualizer might be using.
- Protected Member Functions inherited from makVrv::DtSceneObjectVisualizer
virtual DtSceneObjectAgent * createObjectAgent ()
- Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void slot_mouseDown (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
 Called when the mouse is clicked in this visualizer.
virtual void slot_mouseUp (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual void slot_mouseDblClick (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual bool supportsShowHideContext (int) const
 Default returns true.
template<typename T , typename C >
void connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
 Connect a signal and update the entity.

Protected Attributes

DtAttachableCuboidModelAgent * myCuboidModelAgent
DtAttachableDeadReckonUpdaterAgent * myAttachedUpdaterAgent
DtVisibilityAdapter
< DtAttachableCuboidModelAgent > * 
myVisibilityAdapter
- Protected Attributes inherited from makVrv::DtSceneObjectVisualizer
DtElementID myElementID
- Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnectionmySimulation
DtStateListenermyListener
bool myDistributeFlag
DtUniqueID myUniqueID
std::string myName
std::string myModelDefinition
DtSignalConnectionManager myConnections
int myModelSet
int myVisualizerType
std::vector< int > myShowHideContexts
bool mySelected
bool myPickable
bool myVisible
DtStateVisualizermyParent
DtSceneObjectAgent * mySceneObjectAgent
- Protected Attributes inherited from makVrv::DtRemoteGraphicVisualizerAttributes
bool myActive
bool myFlashing
std::vector< std::string > myLayers
std::string myLayerName
bool myEnabled

Additional Inherited Members

- Public Types inherited from makVrv::DtStateVisualizer
enum  Type {
  AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType,
  AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000
}
 Visualizer class types that are supportable via visualizers. More...
- Public Attributes inherited from makVrv::DtStateVisualizer
boost::signal< void(DtStateVisualizer
*, DtStateVisualizer
*, DtStateVisualizer *)> 
signal_reparented
 Signaled when the parent of this item changes, called before destroying any model agents.
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseDown
 Emitted when the entity's indicator is clicked.
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseUp
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseDblClick

Detailed Description

DtCuboidStateVisualizer objects are responsible for displaying cuboid object.

Constructor & Destructor Documentation

makVrv::DtCuboidStateVisualizer::DtCuboidStateVisualizer ( DtBaseConnection simulation,
DtStateListener listener,
int  modelSet 
)

Constructor.

virtual makVrv::DtCuboidStateVisualizer::~DtCuboidStateVisualizer ( )
virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtCuboidStateVisualizer::setDimensions ( const DtVector dim)
virtual

Sets the dimensions of the cuboid.

virtual void makVrv::DtCuboidStateVisualizer::setColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Sets the color of the cuboid.

virtual void makVrv::DtCuboidStateVisualizer::setFlashing ( bool  flashing)
virtual

Sets whether the cuboid is flashing.

Implements makVrv::DtRemoteGraphicVisualizerAttributes.

virtual void makVrv::DtCuboidStateVisualizer::setPosition ( const DtVector pos)
virtual

Sets the position of the cuboid in database coordinates, or body coordinates (if attached)

virtual void makVrv::DtCuboidStateVisualizer::setOrientation ( const DtTaitBryan &  orientation)
virtual

Sets the orientation of the cuboid in database coordinates.

virtual void makVrv::DtCuboidStateVisualizer::setAttached ( DtUniqueID  id,
int  vtx,
double  percentage 
)
virtual

Attaches the cuboid to the unique ID specified.

Parameters
idUnique ID of the object attached to, if 0, detaches
vtxignored
percentageSpecifies the percentage between 2 vertices if attached to a line or cylinder
virtual void makVrv::DtCuboidStateVisualizer::setHostId ( const std::string &  id,
int  vtx,
double  percentage 
)
virtual

Sets the host ID attached to. Overridden by child classes.

virtual const DtStateVisualizer::TypeInfo& makVrv::DtCuboidStateVisualizer::typeInfo ( ) const
virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::DtCuboidStateVisualizer::theTypeInfo ( )
static

This class's type info.

virtual void makVrv::DtCuboidStateVisualizer::setVisible ( bool  yesNo)
protectedvirtual
virtual void makVrv::DtCuboidStateVisualizer::createModelAgents ( )
protectedvirtual

Creates the model agent. If already created, makes it visible.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtCuboidStateVisualizer::destroyModelAgents ( )
protectedvirtual

Model agent is only destroyed in destructor.

Here, it will be hidden (if it has been created)

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtCuboidStateVisualizer::setModelDefinitionForAgents ( )
protectedvirtual

Sets model definition for all the agents that this visualizer might be using.

If model agents are not created, should create them. Should not call this directly, but rather call setModelDefinition

Reimplemented from makVrv::DtSceneObjectVisualizer.

Member Data Documentation

DtAttachableCuboidModelAgent* makVrv::DtCuboidStateVisualizer::myCuboidModelAgent
protected
DtAttachableDeadReckonUpdaterAgent* makVrv::DtCuboidStateVisualizer::myAttachedUpdaterAgent
protected
DtVisibilityAdapter<DtAttachableCuboidModelAgent>* makVrv::DtCuboidStateVisualizer::myVisibilityAdapter
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)