makVrv::DtIndicatorVisualizer Class Reference

DtIndicatorVisualizer is used to visualize 2D indicators and associated Info boxes (usually called labels). More...

Inheritance diagram for makVrv::DtIndicatorVisualizer:

List of all members.

Public Member Functions
	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.
virtual void	setWidgetEventsEnabled (bool enabled)
virtual void	setIndicatorPinned (bool)
bool	infoPinned () const
virtual void	setSelected (bool selected)
	Sets selected state.
virtual void	setShowInfoPopupOnSelect (bool enabled)
virtual bool	showInfoPopupOnSelect () const
virtual void	setInfoPinned (bool pinned)
virtual void	createIndicator ()=0
	Override to create and destroy indicators.
virtual void	destroyIndicator ()=0
	destroy the indicator agent
DtEntityInfoWidget *	infoWidget () const
virtual void	setInfoVisible (bool)
	This call will also call createModelAgents() or destroyModelAgents()
virtual void	setInfoText (const DtUnicode &text)
	Set the info text.
virtual void	setColor (float r, float g, float b, float a)
	Sets the color of the info box.
Public Attributes
boost::signal< void(bool)>	signal_infoVisibleChanged
	Signaled when info visibility has changed.
Protected Member Functions
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 DtUnicode &	infoString () const
	Returns the member myInfoString.
virtual DtUnicode	generateInfoString () const
	Generates information string to display in info box.
Protected Attributes
DtEntityInfoWidget *	myInfoWidget
bool	myIndicatorVisible
bool	myWidgetEventsEnabled
bool	myIndicatorPinned
bool	myShowInfoOnSelect
bool	myInfoPinned
bool	myInfoVisible
DtUnicode	myInfoString
bool	myUpdateInfo
double	myR
double	myG
double	myB
double	myA

---

Detailed Description

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

---

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtIndicatorVisualizer::~DtIndicatorVisualizer

(

)

[virtual]

DTOR.

---

Member Function Documentation

void makVrv::DtIndicatorVisualizer::setIndicatorVisible

(

bool

visible

)

Set whether the indicator is visible or not.

bool makVrv::DtIndicatorVisualizer::indicatorVisible

(

)

const

Get whether the indicator is visible.

virtual void makVrv::DtIndicatorVisualizer::setWidgetEventsEnabled

(

bool

enabled

)

[virtual]

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

virtual void makVrv::DtIndicatorVisualizer::setIndicatorPinned

(

bool

)

[virtual]

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

bool makVrv::DtIndicatorVisualizer::infoPinned

(

)

const

virtual void makVrv::DtIndicatorVisualizer::setSelected

(

bool

)

[virtual]

Sets selected state.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setShowInfoPopupOnSelect

(

bool

enabled

)

[virtual]

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual bool makVrv::DtIndicatorVisualizer::showInfoPopupOnSelect

(

)

const [virtual]

virtual void makVrv::DtIndicatorVisualizer::setInfoPinned

(

bool

pinned

)

[virtual]

virtual void makVrv::DtIndicatorVisualizer::createIndicator

(

)

[pure virtual]

Override to create and destroy indicators.

Implemented in makVrf::DtVrfVrlinkEnvironmentalIndicatorVisualizer, 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()

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkTacticalGraphicIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setInfoText

(

const DtUnicode &

text

)

[virtual]

Set the info text.

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

Sets the color of the info box.

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

virtual void makVrv::DtIndicatorVisualizer::postUpdate

(

)

[protected, virtual]

Update entity info text.

virtual void makVrv::DtIndicatorVisualizer::updateIndicator

(

)

[protected, virtual]

virtual void makVrv::DtIndicatorVisualizer::createModelAgents

(

)

[protected, virtual]

Override to create model agents that will be used to display data from the listener.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityIndicatorVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::destroyModelAgents

(

)

[protected, virtual]

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

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setModelDefinitionForAgents

(

)

[protected, virtual]

Sets model definition for all the agents that this visualizer might be using.

If model agents are not created, should create them. Should not call this directly, but rather call setModelDefinition

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setUniqueID

(

DtUniqueID

id

)

[protected, virtual]

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setVisualizerDefinition

(

const DtVisualizerDefinition &

)

[protected, virtual]

Set any other additional visualizer information from the visual record.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtIndicatorVisualizer::slot_mouseInChanged

(

bool

isMouseInIndicator

)

[protected, virtual]

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setUpdateInfo

(

bool

b

)

[protected, virtual]

Reimplemented in makVrv::vrvExampleVisualDefinitionSetPlugin::DtExampleIndicatorVisualizer.

virtual const DtUnicode& makVrv::DtIndicatorVisualizer::infoString

(

)

const [protected, virtual]

Returns the member myInfoString.

virtual DtUnicode makVrv::DtIndicatorVisualizer::generateInfoString

(

)

const [protected, virtual]

Generates information string to display in info box.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer, makVrv::DtEntityIndicatorVisualizer, makVrv::DtAggregateIndicatorVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityIndicatorVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkTacticalGraphicIndicatorVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateIndicatorVisualizer, and makVrv::vrvExampleVisualDefinitionSetPlugin::DtExampleIndicatorVisualizer.

---

Member Data Documentation

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

Signaled when info visibility has changed.

DtEntityInfoWidget* makVrv::DtIndicatorVisualizer::myInfoWidget [protected]

bool makVrv::DtIndicatorVisualizer::myIndicatorVisible [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]

DtUnicode makVrv::DtIndicatorVisualizer::myInfoString [protected]

bool makVrv::DtIndicatorVisualizer::myUpdateInfo [protected]

double makVrv::DtIndicatorVisualizer::myR [protected]

double makVrv::DtIndicatorVisualizer::myG [protected]

double makVrv::DtIndicatorVisualizer::myB [protected]

double makVrv::DtIndicatorVisualizer::myA [protected]

---

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

• include/vrvCore/DtIndicatorVisualizer.h