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

Contains makVrv:DtEntityIndicatorVisualizer.h class to show indicator and info widget for entities. More...

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

Public Member Functions

 DtEntityIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtEntityIndicatorVisualizer ()
 DTOR.
virtual void setWidgetEventsEnabled (bool b)
virtual void setIndicatorPinned (bool b)
virtual void setColor (float r, float g, float b, float a)
 Sets the color of the info box.
DtEntityIndicatorWidgetindicator () const
 indicator accessor
DtEntityStateListenerentityStateListener ()
 Get the entity state listener.
virtual const
DtStateVisualizer::TypeInfo
typeInfo () const
 The instance's type info.
virtual void setHoverSignalsActive (bool active)
 Call to set whether or not the info popup will show/hide given the fact that the mouse is hovering over the object.
virtual void setShowInfoPopupOnSelect (bool show)
 If true turn of hover signals so popup will only show if item is selected.
- Public Member Functions inherited from makVrv::DtIndicatorVisualizer
 DtIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtIndicatorVisualizer ()
 DTOR.
void setIndicatorVisible (bool visible)
 Set whether the indicator is visible or not.
bool indicatorVisible () const
 Get whether the indicator is visible.
bool infoPinned () const
virtual void setSelected (bool selected)
 Sets selected state.
virtual bool showInfoPopupOnSelect () const
virtual void setInfoPinned (bool pinned)
DtEntityInfoWidgetinfoWidget () const
virtual void setInfoVisible (bool)
 This call will also call createModelAgents() or destroyModelAgents()
virtual void setInfoText (const DtUnicode &text)
 Set the info text.
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtStateVisualizer ()
 DTOR.
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
DtUniqueID uniqueID () const
int visualizerType () const
void setShowHideContext (const std::vector< int > &s)
 Set show/hide context without changing visibility of item.
DtStateListenerlistener ()
DtBaseConnectionsimulation ()
 Get the connection for this visualizer.
void setDistribute (bool b)
 Whether or not to distribute over the network.
bool distribute () const

Static Public Member Functions

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

Protected Member Functions

virtual void createIndicator ()
 Override to create and destroy indicators.
virtual void destroyIndicator ()
 destroy the indicator agent
virtual DtUnicode generateInfoString () const
 Generates information string to display in info box.
- Protected Member Functions inherited from makVrv::DtIndicatorVisualizer
virtual void postUpdate ()
 Update entity info text.
virtual void updateIndicator ()
virtual void createModelAgents ()
 Override to create model agents that will be used to display data from the listener.
virtual void destroyModelAgents ()
 Destroy the distributed agents This function cannot be called from DtIndicatorVisualizer's destructor.
virtual void setModelDefinitionForAgents ()
 Sets model definition for all the agents that this visualizer might be using.
virtual void setUniqueID (DtUniqueID id)
virtual void setVisualizerDefinition (const DtVisualizerDefinition &visDef)
 Set any other additional visualizer information from the visual record.
virtual void slot_mouseInChanged (bool isMouseInIndicator)
virtual void setUpdateInfo (bool b)
virtual const DtUnicodeinfoString () const
 Returns the member myInfoString.
- 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

DtEntityIndicatorWidgetmyIndicator
DtEntityStateListenermyEntityListener
 Same as myListener, but casted for convenience.
- Protected Attributes inherited from makVrv::DtIndicatorVisualizer
DtEntityInfoWidgetmyInfoWidget
bool myIndicatorVisible
bool myWidgetEventsEnabled
bool myIndicatorPinned
bool myShowInfoOnSelect
bool myInfoPinned
bool myInfoVisible
DtUnicode myInfoString
bool myUpdateInfo
double myR
double myG
double myB
double myA
- 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< intmyShowHideContexts
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::DtIndicatorVisualizer
boost::signal< void(bool)> signal_infoVisibleChanged
 Signaled when info visibility has changed.

Detailed Description

Contains makVrv:DtEntityIndicatorVisualizer.h class to show indicator and info widget for entities.

Override to implement the generateInfoString() method to return information about this object

Examples

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtEntityIndicatorVisualizer::~DtEntityIndicatorVisualizer ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEntityIndicatorVisualizer::setWidgetEventsEnabled ( bool  b)
virtual

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEntityIndicatorVisualizer::setIndicatorPinned ( bool  b)
virtual

Reimplemented from makVrv::DtIndicatorVisualizer.

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

Sets the color of the info box.

Reimplemented from makVrv::DtIndicatorVisualizer.

DtEntityIndicatorWidget* makVrv::DtEntityIndicatorVisualizer::indicator ( ) const

indicator accessor

DtEntityStateListener& makVrv::DtEntityIndicatorVisualizer::entityStateListener ( )

Get the entity state listener.

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

The instance's type info.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtAggregateIndicatorVisualizer.

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

This class's type info.

Reimplemented in makVrv::DtAggregateIndicatorVisualizer.

virtual void makVrv::DtEntityIndicatorVisualizer::setHoverSignalsActive ( bool  active)
virtual

Call to set whether or not the info popup will show/hide given the fact that the mouse is hovering over the object.

Will be active unless indicator is pinned or shown only when selected

virtual void makVrv::DtEntityIndicatorVisualizer::setShowInfoPopupOnSelect ( bool  show)
virtual

If true turn of hover signals so popup will only show if item is selected.

If false, turn hover signals back on if popup is not pinned

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEntityIndicatorVisualizer::createIndicator ( )
protectedvirtual

Override to create and destroy indicators.

Implements makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEntityIndicatorVisualizer::destroyIndicator ( )
protectedvirtual

destroy the indicator agent

Implements makVrv::DtIndicatorVisualizer.

virtual DtUnicode makVrv::DtEntityIndicatorVisualizer::generateInfoString ( ) const
protectedvirtual

Member Data Documentation

DtEntityIndicatorWidget* makVrv::DtEntityIndicatorVisualizer::myIndicator
protected
DtEntityStateListener* makVrv::DtEntityIndicatorVisualizer::myEntityListener
protected

Same as myListener, but casted for convenience.


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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)