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

DtAggregateExtentVisualizer visualize bounding boxes for aggregates. More...

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

Public Member Functions

 DtAggregateExtentVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 Constructor.
virtual ~DtAggregateExtentVisualizer ()
 Destructor.
virtual void setDimensions (const DtVector &dim)
 Sets the dimensions of the cuboid (length is X, width is Y, height is Z)
virtual void setColor (float r, float g, float b, float a)
 Sets the color of the cuboid.
virtual void setShowExtents (bool)
 Different in setVisible in that it will do a show/hide with the show/hide context of HiddenBySetting.
virtual void setShowOnlyIfSelected (bool)
 Will show only if the item is also selected.
bool showOnlyIfSelected () const
virtual void setVisible (bool yesNo)
virtual void setSelected (bool)
 Override to show/hide if show only if selected mode is on.
virtual void setLockUpdates (bool b)
bool updatesLocked () const
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtStateVisualizer ()
 DTOR.
virtual const TypeInfotypeInfo () const =0
 Get the type info.
virtual void setParent (DtStateVisualizer *)
 Override to set the parent of this visualizer.
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 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)
DtUniqueID uniqueID () const
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

Protected Member Functions

virtual void createModelAgents ()
 Override to create model agents that will be used to display data from the listener.
virtual void destroyModelAgents ()
 Destroys all currently created definitions.
virtual void setModelDefinitionForAgents ()
 Sets model definition for all the agents that this visualizer might be using.
virtual DtModelAgent * createExtentModelAgent ()=0
 Creates and returns the extent model agent.
- 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 hide (int context)
 Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
virtual bool show (int context)
 Will call createModelAgents(), if, when context is removed from myShowHideContexts, the list size is zero.
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

DtModelAgent * myAggregateExtentModelAgent
float myColor [4]
DtVector myDimensions
bool myShowOnlyIfSelected
bool myLockUpdates
- 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

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

DtAggregateExtentVisualizer visualize bounding boxes for aggregates.

Constructor & Destructor Documentation

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

Constructor.

virtual makVrv::DtAggregateExtentVisualizer::~DtAggregateExtentVisualizer ( )
virtual

Destructor.

Member Function Documentation

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

Sets the dimensions of the cuboid (length is X, width is Y, height is Z)

Reimplemented in makVrv::Dt2DAggregateExtentVisualizer, and makVrv::Dt3DAggregateExtentVisualizer.

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

Sets the color of the cuboid.

Reimplemented in makVrv::Dt2DAggregateExtentVisualizer, and makVrv::Dt3DAggregateExtentVisualizer.

virtual void makVrv::DtAggregateExtentVisualizer::setShowExtents ( bool  )
virtual

Different in setVisible in that it will do a show/hide with the show/hide context of HiddenBySetting.

virtual void makVrv::DtAggregateExtentVisualizer::setShowOnlyIfSelected ( bool  )
virtual

Will show only if the item is also selected.

bool makVrv::DtAggregateExtentVisualizer::showOnlyIfSelected ( ) const
inline
virtual void makVrv::DtAggregateExtentVisualizer::setVisible ( bool  yesNo)
virtual
virtual void makVrv::DtAggregateExtentVisualizer::setSelected ( bool  )
virtual

Override to show/hide if show only if selected mode is on.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtAggregateExtentVisualizer::setLockUpdates ( bool  b)
virtual
bool makVrv::DtAggregateExtentVisualizer::updatesLocked ( ) const
virtual void makVrv::DtAggregateExtentVisualizer::createModelAgents ( )
protectedvirtual

Override to create model agents that will be used to display data from the listener.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt2DAggregateExtentVisualizer, and makVrv::Dt3DAggregateExtentVisualizer.

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

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt2DAggregateExtentVisualizer, and makVrv::Dt3DAggregateExtentVisualizer.

virtual void makVrv::DtAggregateExtentVisualizer::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

Implements makVrv::DtStateVisualizer.

virtual DtModelAgent* makVrv::DtAggregateExtentVisualizer::createExtentModelAgent ( )
protectedpure virtual

Creates and returns the extent model agent.

Implemented in makVrv::Dt2DAggregateExtentVisualizer, and makVrv::Dt3DAggregateExtentVisualizer.

Member Data Documentation

DtModelAgent* makVrv::DtAggregateExtentVisualizer::myAggregateExtentModelAgent
protected
float makVrv::DtAggregateExtentVisualizer::myColor[4]
protected
DtVector makVrv::DtAggregateExtentVisualizer::myDimensions
protected
bool makVrv::DtAggregateExtentVisualizer::myShowOnlyIfSelected
protected
bool makVrv::DtAggregateExtentVisualizer::myLockUpdates
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)