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

Inheritance diagram for makVrv::DtIndicatorVisualizer:

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 Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtStateVisualizer ()
	DTOR.
virtual const TypeInfo &	typeInfo () const =0
	Get the type info.
virtual void	setParent (DtStateVisualizer *)
	Override to set the parent of this visualizer.
void	setModelDefinition (const std::string &definition)
	Sets the model definition and creates agent(s) based on that definition.
const std::string &	modelDefinition () const
	Gets the current model definition.
virtual bool	setVisible (bool visible, int context)
	Returns true if this context wants to show or hide the item.
virtual void	initialize ()
	Initialize the visualizer.
virtual bool	isVisible () const
	Returns true if visible.
virtual bool	selected () const
void	setName (const std::string &)
	Internal name of state visualizer.
const std::string &	name () const
virtual void	setPickable (bool)
	Sets pickable state.
virtual bool	pickable () const
DtUniqueID	uniqueID () const
int	visualizerType () const
void	setShowHideContext (const std::vector< int > &s)
	Set show/hide context without changing visibility of item.
DtStateListener &	listener ()
DtBaseConnection &	simulation ()
	Get the connection for this visualizer.
void	setDistribute (bool b)
	Whether or not to distribute over the network.
bool	distribute () const

Public Attributes
boost::signal< void(bool)>	signal_infoVisibleChanged
	Signaled when info visibility has changed.
Public Attributes inherited from makVrv::DtStateVisualizer
boost::signal< void(DtStateVisualizer , DtStateVisualizer , DtStateVisualizer *)>	signal_reparented
	Signaled when the parent of this item changes, called before destroying any model agents.
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDown
	Emitted when the entity's indicator is clicked.
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseUp
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDblClick

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 Member Functions inherited from makVrv::DtStateVisualizer
virtual void	slot_mouseDown (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
	Called when the mouse is clicked in this visualizer.
virtual void	slot_mouseUp (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual void	slot_mouseDblClick (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual bool	hide (int context)
	Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
virtual bool	show (int context)
	Will call createModelAgents(), if, when context is removed from myShowHideContexts, the list size is zero.
virtual bool	supportsShowHideContext (int) const
	Default returns true.
template<typename T , typename C >
void	connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
	Connect a signal and update the entity.

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
Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection &	mySimulation
DtStateListener &	myListener
bool	myDistributeFlag
DtUniqueID	myUniqueID
std::string	myName
std::string	myModelDefinition
DtSignalConnectionManager	myConnections
int	myModelSet
int	myVisualizerType
std::vector< int >	myShowHideContexts
bool	mySelected
bool	myPickable
bool	myVisible
DtStateVisualizer *	myParent
DtSceneObjectAgent *	mySceneObjectAgent

Additional Inherited Members
Public Types inherited from makVrv::DtStateVisualizer
enum	Type { AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType, AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000 }
	Visualizer class types that are supportable via visualizers. More...

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::DtEntityIndicatorVisualizer, and 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 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 ( )

protectedvirtual

Update entity info text.

virtual void makVrv::DtIndicatorVisualizer::updateIndicator ( )

protectedvirtual

virtual void makVrv::DtIndicatorVisualizer::createModelAgents ( )

protectedvirtual

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

protectedvirtual

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

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

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 )

protectedvirtual

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition & )

protectedvirtual

Set any other additional visualizer information from the visual record.

Reimplemented from makVrv::DtStateVisualizer.

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

protectedvirtual

Reimplemented in makVrv::DtEnvironmentalIndicatorVisualizer.

virtual void makVrv::DtIndicatorVisualizer::setUpdateInfo ( bool b )

protectedvirtual

virtual const DtUnicode& makVrv::DtIndicatorVisualizer::infoString ( ) const

protectedvirtual

Returns the member myInfoString.

virtual DtUnicode makVrv::DtIndicatorVisualizer::generateInfoString ( ) const

protectedvirtual

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, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateIndicatorVisualizer.

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtIndicatorVisualizer.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation