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

Visualize an indicator label for an environmental type object to show indicator and info widget for environmental objects. Creates a DtEnvironmentalInfoWidgetUpdaterAgent to update the info on the widget. To change the info text, DtEnvironmentalInfoWidgetUpdaterAgent must be overloaded with a new agent using a .ocdx and then that new agent must be registered with the agent manager under "DtEnvironmentalInfoWidgetUpdater".

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

Public Member Functions

 DtEnvironmentalIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, DtModelSetId modelSet)
 
virtual ~DtEnvironmentalIndicatorVisualizer ()
 
 DtEnvironmentalIndicatorVisualizer ()=delete
 
 DtEnvironmentalIndicatorVisualizer (const DtEnvironmentalIndicatorVisualizer &)=delete
 
DtEnvironmentalIndicatorVisualizeroperator= (const DtEnvironmentalIndicatorVisualizer &)=delete
 
virtual void initialize () override
 
virtual void connectToListenerSignals () override
 
virtual void setInitialValuesFromVisualizerDefinition () override
 
virtual void setWidgetEventsEnabled (bool b)
 
virtual void setColor (float r, float g, float b, float a)
 
virtual void setIndicatorModelDefinitions (const std::string &normalTheme, const std::string &activeTheme, const std::string &selectedTheme, const std::string &multiSelectedTheme)
 
virtual void setIndicatorsEnabled (bool enable, bool instanceOnly=false)
 
virtual void setVertexElementId (DtElementID elementId)
 
virtual void slot_setMultiSelected (bool trueOrFalse)
 
virtual void slot_setVertexSelected (bool trueOrFalse, DtElementID vertexID)
 
virtual void slot_setObjectSelected (bool trueOrFalse)
 
DtEnvironmentalStateListenerenvironmentalStateListener ()
 
virtual const
DtStateVisualizer::TypeInfo
typeInfo () const
 
- Public Member Functions inherited from makVrv::DtIndicatorVisualizer
 DtIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, DtModelSetId modelSet)
 
virtual ~DtIndicatorVisualizer ()
 
 DtIndicatorVisualizer ()=delete
 
 DtIndicatorVisualizer (const DtIndicatorVisualizer &)=delete
 
DtIndicatorVisualizeroperator= (const DtIndicatorVisualizer &)=delete
 
virtual void slot_setSelected (bool) override
 
virtual void setIndicatorPinned (bool)
 
virtual bool indicatorPinned () const
 
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, DtSceneObjectAgent *sceneObjectAgent, DtModelSetId modelSet)
 
virtual ~DtStateVisualizer ()
 
virtual DtModelSetId modelSet ()
 
virtual void setSceneObjectAgent (DtSceneObjectAgent *sceneObject)
 
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 DtUniqueID sceneObjectID () const
 
int visualizerType () const
 
virtual void setVisualizerDefinition (const DtVisualizerDefinition &)
 
DtStateListenerlistener ()
 
const DtStateListenerlistener () const
 
DtBaseConnectionsimulation ()
 
void setDistribute (bool b)
 
bool distribute () const
 
virtual bool setVisualizerIsVisible (bool vis, DtVisualizerShowHideContext::VisualizerShowHideContext context)
 

Static Public Member Functions

static const
DtStateVisualizer::TypeInfo
theTypeInfo ()
 

Protected Member Functions

virtual void createModelAgents () override
 
virtual void destroyModelAgents () override
 
virtual bool indicatorsRealizable () const
 
virtual bool indicatorsVisible () const
 
virtual void implementVisibility (bool vis) override
 
virtual void updateDefinitionState ()
 
virtual void setHasMouseCursor (bool isMouseInIndicator)
 
virtual bool selected () const
 
- Protected Member Functions inherited from makVrv::DtIndicatorVisualizer
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

DtControlPointWidgetmyIndicator
 
std::string myNormalTheme
 
std::string myActiveTheme
 
std::string myNormalPointTheme
 
std::string myActivePointTheme
 
bool myNeedsDefinitionUpdate
 
bool myIndicatorsEnabled
 
bool myVertexSelected
 
bool myCoupleWithLabel
 
DtElementID myVertexElementId
 
DtEnvironmentalStateListenermyEnvironmentalListener
 
- Protected Attributes inherited from makVrv::DtIndicatorVisualizer
bool myVisibilityOverridden
 
bool myWidgetEventsEnabled
 
bool myIndicatorPinned
 
double myR
 
double myG
 
double myB
 
double myA
 
boost::signalslib::connection myMouseOverSignalConnection
 
DtObjectTypeStateListenermyObjectTypeListener
 
- Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnectionmySimulation
 
DtStateListenermyListener
 
bool myDistributeFlag
 
DtUniqueID mySceneObjectID
 
std::string myName
 
std::string myModelDefinition
 
DtSignalConnectionManager myConnections
 
DtModelSetId myModelSet
 
int myVisualizerType
 
bool myPickable
 
bool myVisible
 
const DtVisualizerDefinitionmyVisualizerDefinition
 
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::DtEnvironmentalIndicatorVisualizer::DtEnvironmentalIndicatorVisualizer ( DtBaseConnection simulation,
DtStateListener listener,
DtSceneObjectAgent *  sceneObject,
DtModelSetId  modelSet 
)

CTOR.

virtual makVrv::DtEnvironmentalIndicatorVisualizer::~DtEnvironmentalIndicatorVisualizer ( )
virtual

DTOR.

makVrv::DtEnvironmentalIndicatorVisualizer::DtEnvironmentalIndicatorVisualizer ( )
delete

not allowed - default constructor

makVrv::DtEnvironmentalIndicatorVisualizer::DtEnvironmentalIndicatorVisualizer ( const DtEnvironmentalIndicatorVisualizer )
delete

not allowed - copy constructor

Member Function Documentation

DtEnvironmentalIndicatorVisualizer& makVrv::DtEnvironmentalIndicatorVisualizer::operator= ( const DtEnvironmentalIndicatorVisualizer )
delete

not allowed = equals operator

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

Initialize the visualizer.

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::connectToListenerSignals ( )
overridevirtual

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

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::setInitialValuesFromVisualizerDefinition ( )
overridevirtual

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

Reimplemented from makVrv::DtIndicatorVisualizer.

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

Reimplemented from makVrv::DtIndicatorVisualizer.

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

Sets the color of the info box.

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::setIndicatorModelDefinitions ( const std::string &  normalTheme,
const std::string &  activeTheme,
const std::string &  selectedTheme,
const std::string &  multiSelectedTheme 
)
virtual
virtual void makVrv::DtEnvironmentalIndicatorVisualizer::setIndicatorsEnabled ( bool  enable,
bool  instanceOnly = false 
)
virtual
virtual void makVrv::DtEnvironmentalIndicatorVisualizer::setVertexElementId ( DtElementID  elementId)
virtual

Set the element ID of the Vertex Element that this visualizer is part of. This is needed to support selection of individual vertices (as opposed to all the vertices selected when the parent shape is selected (called multiSelected here)

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::slot_setMultiSelected ( bool  trueOrFalse)
virtual

Sets whether or not the indicator is multi-selected. Indactors are multiselected when their parents are selected; so this is connected to DtStateListener's signal_objectSelectionChanged signal.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::slot_setVertexSelected ( bool  trueOrFalse,
DtElementID  vertexID 
)
virtual

This is connection the the vertex specific selection signal. It is only true if the selected vertex id is that same as it's unique id.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::slot_setObjectSelected ( bool  trueOrFalse)
virtual
DtEnvironmentalStateListener& makVrv::DtEnvironmentalIndicatorVisualizer::environmentalStateListener ( )
inline
virtual const DtStateVisualizer::TypeInfo& makVrv::DtEnvironmentalIndicatorVisualizer::typeInfo ( ) const
virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

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

This class's type info.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::createModelAgents ( )
overrideprotectedvirtual

This function does nothing if the indicator's model definitions have not been set using setIndicatorModelDefinitions(...).

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::destroyModelAgents ( )
overrideprotectedvirtual

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

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual bool makVrv::DtEnvironmentalIndicatorVisualizer::indicatorsRealizable ( ) const
protectedvirtual
virtual bool makVrv::DtEnvironmentalIndicatorVisualizer::indicatorsVisible ( ) const
protectedvirtual
virtual void makVrv::DtEnvironmentalIndicatorVisualizer::implementVisibility ( bool  visible)
overrideprotectedvirtual

Set whether the indicator is visible or not.

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::updateDefinitionState ( )
protectedvirtual
virtual void makVrv::DtEnvironmentalIndicatorVisualizer::setHasMouseCursor ( bool  isMouseInIndicator)
protectedvirtual
virtual bool makVrv::DtEnvironmentalIndicatorVisualizer::selected ( ) const
protectedvirtual

Member Data Documentation

DtControlPointWidget* makVrv::DtEnvironmentalIndicatorVisualizer::myIndicator
protected
std::string makVrv::DtEnvironmentalIndicatorVisualizer::myNormalTheme
protected
std::string makVrv::DtEnvironmentalIndicatorVisualizer::myActiveTheme
protected
std::string makVrv::DtEnvironmentalIndicatorVisualizer::myNormalPointTheme
protected
std::string makVrv::DtEnvironmentalIndicatorVisualizer::myActivePointTheme
protected
bool makVrv::DtEnvironmentalIndicatorVisualizer::myNeedsDefinitionUpdate
protected
bool makVrv::DtEnvironmentalIndicatorVisualizer::myIndicatorsEnabled
protected
bool makVrv::DtEnvironmentalIndicatorVisualizer::myVertexSelected
protected
bool makVrv::DtEnvironmentalIndicatorVisualizer::myCoupleWithLabel
protected
DtElementID makVrv::DtEnvironmentalIndicatorVisualizer::myVertexElementId
protected
DtEnvironmentalStateListener* makVrv::DtEnvironmentalIndicatorVisualizer::myEnvironmentalListener
protected

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

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)