makVrv::DtEntityIndicatorVisualizer Class Reference

Contains makVrv:DtEntityIndicatorVisualizer.h class to show indicator and info widget for entities. Creates a DtEntityInfoWidgetUpdaterAgent to update the information shown on the widget. To change the info text, DtEntityInfoWidgetUpdaterAgent must be overloaded with a new agent using a .ocdx and then that new agent must be registered with the agent manager under "DtEntityInfoWidgetUpdater".

Examples

• exampleVisualDefinitionSet

Inheritance diagram for makVrv::DtEntityIndicatorVisualizer:

Public Member Functions
	DtEntityIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	DtEntityIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)
virtual	~DtEntityIndicatorVisualizer ()
	DtEntityIndicatorVisualizer ()=delete
	DtEntityIndicatorVisualizer (const DtEntityIndicatorVisualizer &)=delete
DtEntityIndicatorVisualizer &	operator= (const DtEntityIndicatorVisualizer &)=delete
virtual void	initialize () override
virtual void	setWidgetEventsEnabled (bool b)
virtual void	setIndicatorPinned (bool b)
virtual void	setColor (float r, float g, float b, float a)
virtual void	setIndicatorEnabled (bool enabled, bool instanceOnly=false)
DtEntityIndicatorWidget *	indicator () const
DtEntityStateListener &	entityStateListener ()
const DtEntityStateListener &	entityStateListener () const
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
virtual void	setHoverSignalsActive (bool active)
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 void	implementVisibility (bool visible) override
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 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 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)

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

Protected Member Functions
virtual void	connectToListenerSignals () override
virtual void	createIndicator () override
virtual void	destroyIndicator () override
virtual void	createModelAgents () override
Protected Member Functions inherited from makVrv::DtIndicatorVisualizer
virtual void	updateIndicator ()
virtual void	destroyModelAgents ()
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
DtEntityIndicatorWidget *	myIndicator
bool	myIndicatorsEnabled
bool	myIndicatorInstanceEnabled
DtEntityStateListener *	myEntityListener
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::DtEntityIndicatorVisualizer::DtEntityIndicatorVisualizer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		int	modelSet
	)

CTOR.

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

CTOR.

virtual makVrv::DtEntityIndicatorVisualizer::~DtEntityIndicatorVisualizer ( )

virtual

DTOR.

makVrv::DtEntityIndicatorVisualizer::DtEntityIndicatorVisualizer ( )

delete

not allowed - default constructor

makVrv::DtEntityIndicatorVisualizer::DtEntityIndicatorVisualizer ( const DtEntityIndicatorVisualizer &  )

delete

not allowed - copy constructor

Member Function Documentation

DtEntityIndicatorVisualizer& makVrv::DtEntityIndicatorVisualizer::operator= ( const DtEntityIndicatorVisualizer &  )

delete

not allowed - equals operator

virtual void makVrv::DtEntityIndicatorVisualizer::initialize ( )

overridevirtual

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

Reimplemented from makVrv::DtIndicatorVisualizer.

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

virtual

Reimplemented from makVrv::DtIndicatorVisualizer.

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

virtual

Set/Get whether the indicator widget is pinned.

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.

virtual void makVrv::DtEntityIndicatorVisualizer::setIndicatorEnabled ( bool  enabled, bool  instanceOnly = false  )

virtual

DtEntityIndicatorWidget* makVrv::DtEntityIndicatorVisualizer::indicator

(

)

const

indicator accessor

DtEntityStateListener& makVrv::DtEntityIndicatorVisualizer::entityStateListener

(

)

Get the entity state listener.

const DtEntityStateListener& makVrv::DtEntityIndicatorVisualizer::entityStateListener

(

)

const

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.

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

overrideprotectedvirtual

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

Reimplemented from makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEntityIndicatorVisualizer::createIndicator ( )

overrideprotectedvirtual

Override to create and destroy indicators.

Implements makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEntityIndicatorVisualizer::destroyIndicator ( )

overrideprotectedvirtual

destroy the indicator agent

Implements makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEntityIndicatorVisualizer::createModelAgents ( )

overrideprotectedvirtual

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

Reimplemented from makVrv::DtIndicatorVisualizer.

Reimplemented in makVrv::DtAggregateIndicatorVisualizer.

Member Data Documentation

DtEntityIndicatorWidget* makVrv::DtEntityIndicatorVisualizer::myIndicator

protected

bool makVrv::DtEntityIndicatorVisualizer::myIndicatorsEnabled

protected

bool makVrv::DtEntityIndicatorVisualizer::myIndicatorInstanceEnabled

protected

DtEntityStateListener* makVrv::DtEntityIndicatorVisualizer::myEntityListener

protected

Same as myListener, but casted for convenience.

---

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

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