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:

Public Member Functions
	DtEnvironmentalIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	DtEnvironmentalIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)
virtual	~DtEnvironmentalIndicatorVisualizer ()
	DtEnvironmentalIndicatorVisualizer ()=delete
	DtEnvironmentalIndicatorVisualizer (const DtEnvironmentalIndicatorVisualizer &)=delete
DtEnvironmentalIndicatorVisualizer &	operator= (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	setShowInfoPopupOnSelect (bool b)
virtual void	setSceneObjectID (DtUniqueID id) override
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)
virtual void	setIndicatorPinned (bool b)
DtEnvironmentalStateListener &	environmentalStateListener ()
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
Public Member Functions inherited from makVrv::DtIndicatorVisualizer
	DtIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	DtIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)
virtual	~DtIndicatorVisualizer ()
virtual bool	indicatorVisible () const
virtual void	slot_setSelected (bool) override
DtEntityInfoWidget *	infoWidget () const
virtual void	setInfoVisible (bool)
virtual void	slot_forceAdded (int)
virtual void	setInfoPinned (bool pinned)
virtual bool	infoPinned () const
virtual bool	indicatorPinned () const
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 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 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)

Static Public Member Functions
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()

Protected Member Functions
virtual void	createIndicator ()
virtual void	destroyIndicator ()
virtual void	createModelAgents ()
virtual bool	indicatorsRealizable () const
virtual bool	indicatorsVisible () const
virtual void	implementVisibility (bool vis) override
virtual void	updateDefinitionState ()
virtual void	slot_mouseInChanged (bool isMouseInIndicator)
virtual bool	selected () const
Protected Member Functions inherited from makVrv::DtIndicatorVisualizer
virtual void	updateIndicator ()
virtual void	destroyModelAgents ()
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
DtControlPointWidget *	myIndicator
std::string	myNormalTheme
std::string	myActiveTheme
std::string	myNormalPointTheme
std::string	myActivePointTheme
bool	myNeedsDefinitionUpdate
bool	myIndicatorsEnabled
bool	myVertexSelected
bool	myCoupleWithLabel
DtElementID	myVertexElementId
DtEnvironmentalStateListener *	myEnvironmentalListener
Protected Attributes inherited from makVrv::DtIndicatorVisualizer
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 }
Public Attributes inherited from makVrv::DtIndicatorVisualizer
boost::signalslib::signal < void(bool)>	signal_infoVisibleChanged
Public Attributes inherited from makVrv::DtStateVisualizer
boost::signalslib::signal < void(DtStateVisualizer *, DtStateVisualizer *, DtStateVisualizer *)>	signal_reparented
Protected Types inherited from makVrv::DtStateVisualizer
typedef std::vector < DtVisualizerShowHideContext::VisualizerShowHideContext >	ShowHideContextVector

Constructor & Destructor Documentation

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

CTOR.

makVrv::DtEnvironmentalIndicatorVisualizer::DtEnvironmentalIndicatorVisualizer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		DtSceneObjectAgent *	sceneObject,
		int	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::setShowInfoPopupOnSelect ( bool  enabled )

virtual

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

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::setSceneObjectID ( DtUniqueID  id )

overridevirtual

Set the scene object ID of the scene object that any models visualized by instances of this class will use.

Reimplemented from makVrv::DtStateVisualizer.

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

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

virtual

Set/Get whether the indicator widget is pinned.

Reimplemented from makVrv::DtIndicatorVisualizer.

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::createIndicator ( )

protectedvirtual

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

Implements makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::destroyIndicator ( )

protectedvirtual

destroy the indicator agent

Implements makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::createModelAgents ( )

protectedvirtual

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

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::slot_mouseInChanged ( bool  isMouseInIndicator )

protectedvirtual

Reimplemented from makVrv::DtIndicatorVisualizer.

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtEnvironmentalIndicatorVisualizer.h