VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
makVrv::DtIndicatorVisualizer Class Referenceabstract
vrvCore

DtIndicatorVisualizer is used to visualize 2D indicators and associated Info boxes (usually called labels). It is an abstract class; deriving classes need to provide implementations for creating and destroying the actual indicator widgets.

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

Public Member Functions

 DtIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 
 DtIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)
 
virtual ~DtIndicatorVisualizer ()
 
virtual void initialize () override
 
virtual void implementVisibility (bool visible) override
 
virtual bool indicatorVisible () const
 
virtual void setWidgetEventsEnabled (bool enabled)
 
virtual void slot_setSelected (bool) override
 
virtual void createIndicator ()=0
 
virtual void destroyIndicator ()=0
 
DtEntityInfoWidget * infoWidget () const
 
virtual void setInfoVisible (bool)
 
virtual void setColor (float r, float g, float b, float a)
 
virtual void slot_forceAdded (int)
 
virtual void setInfoPinned (bool pinned)
 
virtual bool infoPinned () const
 
virtual void setIndicatorPinned (bool)
 
virtual bool indicatorPinned () const
 
virtual void setShowInfoPopupOnSelect (bool enabled)
 
virtual bool showInfoPopupOnSelect () const
 
virtual void slot_setForceType (DtForceType type)
 
virtual void slot_setDisplayName (const std::string &name)
 
virtual void slot_setObjectType (const std::string &type)
 
virtual void slot_setIdentifierString (const std::string &identifier)
 
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, DtSceneObjectAgent *sceneObjectAgent, int modelSet)
 
virtual ~DtStateVisualizer ()
 
virtual DtObserverMode::ModelSets modelSet ()
 
virtual const TypeInfo & typeInfo () const =0
 
virtual void setParent (DtStateVisualizer *)
 
virtual void setSceneObjectAgent (DtSceneObjectAgent *sceneObject)
 
virtual const DtStateVisualizer * parent () const
 
void setModelDefinition (const std::string &definition)
 
const std::string & modelDefinition () const
 
void setName (const std::string &)
 
const std::string & name () const
 
virtual void setPickable (bool)
 
virtual bool pickable () const
 
virtual void setSceneObjectID (DtUniqueID id)
 
virtual DtUniqueID sceneObjectID () const
 
int visualizerType () const
 
virtual void setVisualizerDefinition (const DtVisualizerDefinition &)
 
DtStateListener & listener ()
 
const DtStateListener & listener () const
 
DtBaseConnection & simulation ()
 
void setDistribute (bool b)
 
bool distribute () const
 
virtual bool setVisualizerIsVisible (bool vis, DtVisualizerShowHideContext::VisualizerShowHideContext context)
 

Public Attributes

boost::signalslib::signal
< void(bool)> 		signal_infoVisibleChanged
 
- Public Attributes inherited from makVrv::DtStateVisualizer
boost::signalslib::signal
< void(DtStateVisualizer
*, DtStateVisualizer
*, DtStateVisualizer *)> 		signal_reparented
 

Protected Member Functions

virtual void updateIndicator ()
 
virtual void createModelAgents ()
 
virtual void destroyModelAgents ()
 
virtual void connectToListenerSignals () override
 
virtual void setInitialValuesFromVisualizerDefinition () override
 
virtual void slot_mouseInChanged (bool isMouseInIndicator)
 
virtual void setModelDefinitionForAgents () override
 
- Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void makeVisible ()
 
virtual bool isVisible () const
 
template<typename T , typename C >
void connectAndUpdate (boost::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)
 

Protected Attributes

DtEntityInfoWidget * myInfoWidget
 
DtInfoWidgetUpdaterAgent * myWidgetUpdater
 
bool myIndicatorVisible
 
bool myVisibilityOverridden
 
bool myWidgetEventsEnabled
 
bool myIndicatorPinned
 
bool myShowInfoOnSelect
 
bool myInfoPinned
 
bool myInfoVisible
 
double myR
 
double myG
 
double myB
 
double myA
 
DtForceType myForceType
 
std::string myDisplayName
 
std::string myObjectType
 
std::string myIndentifierString
 
- Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection & mySimulation
 
DtStateListener & myListener
 
bool myDistributeFlag
 
DtUniqueID mySceneObjectID
 
std::string myName
 
std::string myModelDefinition
 
DtSignalConnectionManager myConnections
 
int myModelSet
 
int myVisualizerType
 
bool myPickable
 
bool myVisible
 
const DtVisualizerDefinition * myVisualizerDefinition
 
DtStateVisualizer * myParent
 
DtSceneObjectAgent * mySceneObjectAgent
 
bool myInitialInitializeDone
 
ShowHideContextVector myVisualizerShowHideContexts
 

Additional Inherited Members

- Public Types inherited from makVrv::DtStateVisualizer
enum  Type {
  AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType,
  AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000
}
 
- Protected Types inherited from makVrv::DtStateVisualizer
typedef std::vector
< DtVisualizerShowHideContext::VisualizerShowHideContext > 		ShowHideContextVector
 

Constructor & Destructor Documentation

makVrv::DtIndicatorVisualizer::DtIndicatorVisualizer ( DtBaseConnection &  simulation,
DtStateListener &  listener,
int  modelSet 
)

CTOR.

makVrv::DtIndicatorVisualizer::DtIndicatorVisualizer ( DtBaseConnection &  simulation,
DtStateListener &  listener,
DtSceneObjectAgent *  sceneObject,
int  modelSet 
)

CTOR.

virtual makVrv::DtIndicatorVisualizer::~DtIndicatorVisualizer ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtIndicatorVisualizer::initialize ( )
overridevirtual

called soon after construction to initialize the signals/state from the listener

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEntityIndicatorVisualizer, and makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::implementVisibility ( bool  visible)
overridevirtual

Set whether the indicator is visible or not.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual bool makVrv::DtIndicatorVisualizer::indicatorVisible ( ) const
virtual

Get whether the indicator is visible.

virtual void makVrv::DtIndicatorVisualizer::setWidgetEventsEnabled ( bool  enabled)
virtual

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer, and makVrv::DtEntityIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setInfoPinned ( bool  pinned)
virtual

Set/Get whether the info widget is pinned.

virtual bool makVrv::DtIndicatorVisualizer::infoPinned ( ) const
virtual

Set/Get whether the info widget is pinned.

virtual void makVrv::DtIndicatorVisualizer::setIndicatorPinned ( bool  )
virtual

Set/Get whether the indicator widget is pinned.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer, and makVrv::DtEntityIndicatorVisualizer.

virtual bool makVrv::DtIndicatorVisualizer::indicatorPinned ( ) const
virtual

Set/Get whether the indicator widget is pinned.

virtual void makVrv::DtIndicatorVisualizer::slot_setSelected ( bool  )
overridevirtual

Sets whether or not the indicator is selected. Connected to DtStateListener's signal_objectSelectionChanged signal.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setShowInfoPopupOnSelect ( bool  enabled)
virtual

Set/Get whether the info popup is shown on select.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual bool makVrv::DtIndicatorVisualizer::showInfoPopupOnSelect ( ) const
virtual

Set/Get whether the info popup is shown on select.

virtual void makVrv::DtIndicatorVisualizer::createIndicator ( )
pure virtual

Override to create and destroy indicators.

Implemented in makVrv::DtEnvironmentalIndicatorVisualizer, and makVrv::DtEntityIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::destroyIndicator ( )
pure virtual

destroy the indicator agent

Implemented in makVrv::DtEnvironmentalIndicatorVisualizer, and makVrv::DtEntityIndicatorVisualizer.

DtEntityInfoWidget* makVrv::DtIndicatorVisualizer::infoWidget ( ) const
virtual void makVrv::DtIndicatorVisualizer::setInfoVisible ( bool  )
virtual

This call will also call createModelAgents() or destroyModelAgents()

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

Sets the color of the info box.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer, and makVrv::DtEntityIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::slot_setForceType ( DtForceType  type)
virtual

Derived classes connect these to entity/aggregate/environmental signals The information is passed to the updater.

virtual void makVrv::DtIndicatorVisualizer::slot_setDisplayName ( const std::string &  name)
virtual

Derived classes connect these to entity/aggregate/environmental signals The information is passed to the updater.

virtual void makVrv::DtIndicatorVisualizer::slot_setObjectType ( const std::string &  type)
virtual

Derived classes connect these to entity/aggregate/environmental signals The information is passed to the updater.

virtual void makVrv::DtIndicatorVisualizer::slot_setIdentifierString ( const std::string &  identifier)
virtual

Derived classes connect these to entity/aggregate/environmental signals The information is passed to the updater.

virtual void makVrv::DtIndicatorVisualizer::slot_forceAdded ( int  )
virtual

Called when a force is added, if the force is what this objects force is update the color.

virtual void makVrv::DtIndicatorVisualizer::updateIndicator ( )
protectedvirtual
virtual void makVrv::DtIndicatorVisualizer::createModelAgents ( )
protectedvirtual

Creates the DtEntityInfoWidget, please override to create the correct DtInfoWidgetUpdaterAgent.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer, makVrv::DtEntityIndicatorVisualizer, and makVrv::DtAggregateIndicatorVisualizer.

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

Destroy the distributed agents This function cannot be called from DtIndicatorVisualizer's destructor.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtIndicatorVisualizer::connectToListenerSignals ( )
overrideprotectedvirtual

Connect the visualizer to the listeners signals Called by DtStateVisualizer::initialize()

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEntityIndicatorVisualizer, and makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setInitialValuesFromVisualizerDefinition ( )
overrideprotectedvirtual

Sets member variables from the visualizer definition if they exist Should not call this directly. Called by DtStateVisualizer::initialize.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::slot_mouseInChanged ( bool  isMouseInIndicator)
protectedvirtual

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setModelDefinitionForAgents ( )
overrideprotectedvirtual

Sets up various values such as force type, this is called after initialize and createModelAgents so values and models should be valid.

Implements makVrv::DtStateVisualizer.

Member Data Documentation

boost::signalslib::signal<void (bool)> makVrv::DtIndicatorVisualizer::signal_infoVisibleChanged

Signaled when info visibility has changed.

DtEntityInfoWidget* makVrv::DtIndicatorVisualizer::myInfoWidget
protected
DtInfoWidgetUpdaterAgent* makVrv::DtIndicatorVisualizer::myWidgetUpdater
protected
bool makVrv::DtIndicatorVisualizer::myIndicatorVisible
protected
bool makVrv::DtIndicatorVisualizer::myVisibilityOverridden
protected
bool makVrv::DtIndicatorVisualizer::myWidgetEventsEnabled
protected
bool makVrv::DtIndicatorVisualizer::myIndicatorPinned
protected
bool makVrv::DtIndicatorVisualizer::myShowInfoOnSelect
protected
bool makVrv::DtIndicatorVisualizer::myInfoPinned
protected
bool makVrv::DtIndicatorVisualizer::myInfoVisible
protected
double makVrv::DtIndicatorVisualizer::myR
protected
double makVrv::DtIndicatorVisualizer::myG
protected
double makVrv::DtIndicatorVisualizer::myB
protected
double makVrv::DtIndicatorVisualizer::myA
protected
DtForceType makVrv::DtIndicatorVisualizer::myForceType
protected
std::string makVrv::DtIndicatorVisualizer::myDisplayName
protected
std::string makVrv::DtIndicatorVisualizer::myObjectType
protected
std::string makVrv::DtIndicatorVisualizer::myIndentifierString
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)