makVrv::DtEnvironmentalIndicatorVisualizer Class Reference

Visualize an indicator label for an environmental type object to show indicator and info widget for environmental objects. More...

Inheritance diagram for makVrv::DtEnvironmentalIndicatorVisualizer:

Public Member Functions
	DtEnvironmentalIndicatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtEnvironmentalIndicatorVisualizer ()
	DTOR.
virtual void	setWidgetEventsEnabled (bool b)
virtual void	setColor (float r, float g, float b, float a)
	Sets the color of the info box.
virtual void	setIndicatorModelDefinitions (const std::string &normalTheme, const std::string &activeTheme, const std::string &selectedTheme, const std::string &multiSelectedTheme)
virtual void	setIndicatorsEnabled (bool)
virtual void	setShowInfoPopupOnSelect (bool b)
virtual void	setUniqueID (DtUniqueID id)
virtual void	setSelected (bool)
	Sets selected state.
virtual void	setMultiSelected (bool)
virtual void	setIndicatorPinned (bool b)
DtEnvironmentalStateListener &	environmentalStateListener ()
bool	multiSelected () const
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
Public Member Functions inherited from makVrv::DtIndicatorVisualizer
	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.
bool	infoPinned () const
virtual bool	showInfoPopupOnSelect () const
virtual void	setInfoPinned (bool pinned)
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.
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtStateVisualizer ()
	DTOR.
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.
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

Static Public Member Functions
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()
	This class's type info.

Protected Member Functions
virtual void	createIndicator ()
	Override to create and destroy indicators.
virtual void	destroyIndicator ()
	destroy the indicator agent
virtual void	createModelAgents ()
	Override to create model agents that will be used to display data from the listener.
virtual DtUnicode	generateInfoString () const
	Generates information string to display in info box.
virtual bool	indicatorsRealizable () const
virtual bool	indicatorsVisible () const
virtual void	updateIndicatorVisibility ()
virtual void	updateDefinitionState ()
virtual bool	selected () const
virtual void	slot_mouseInChanged (bool isMouseInIndicator)
Protected Member Functions inherited from makVrv::DtIndicatorVisualizer
virtual void	postUpdate ()
	Update entity info text.
virtual void	updateIndicator ()
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	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Set any other additional visualizer information from the visual record.
virtual void	setUpdateInfo (bool b)
virtual const DtUnicode &	infoString () const
	Returns the member myInfoString.
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
DtControlPointWidget *	myIndicator
bool	myMultiSelected
std::string	myNormalTheme
std::string	myActiveTheme
std::string	myNormalPointTheme
std::string	myActivePointTheme
bool	myNeedsDefinitionUpdate
DtEnvironmentalStateListener *	myEnvironmentalListener
Protected Attributes inherited from makVrv::DtIndicatorVisualizer
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...
Public Attributes inherited from makVrv::DtIndicatorVisualizer
boost::signal< void(bool)>	signal_infoVisibleChanged
	Signaled when info visibility has changed.

Detailed Description

Visualize an indicator label for an environmental type object to show indicator and info widget for environmental objects.

Override and create this class for environmental visualizers to implement the generateInfoString() method to return information about this environmental

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtEnvironmentalIndicatorVisualizer::~DtEnvironmentalIndicatorVisualizer ( )

virtual

DTOR.

Member Function Documentation

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  )

virtual

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

virtual

Reimplemented from makVrv::DtIndicatorVisualizer.

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

virtual

Reimplemented from makVrv::DtIndicatorVisualizer.

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

virtual

Sets selected state.

Reimplemented from makVrv::DtIndicatorVisualizer.

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

virtual

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

virtual

Reimplemented from makVrv::DtIndicatorVisualizer.

DtEnvironmentalStateListener& makVrv::DtEnvironmentalIndicatorVisualizer::environmentalStateListener ( )

inline

bool makVrv::DtEnvironmentalIndicatorVisualizer::multiSelected ( ) const

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

Override to create and destroy indicators.

Implements makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::destroyIndicator ( )

protectedvirtual

destroy the indicator agent

Implements makVrv::DtIndicatorVisualizer.

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::createModelAgents ( )

protectedvirtual

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

Reimplemented from makVrv::DtIndicatorVisualizer.

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

protectedvirtual

Generates information string to display in info box.

Reimplemented from makVrv::DtIndicatorVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkTacticalGraphicIndicatorVisualizer.

virtual bool makVrv::DtEnvironmentalIndicatorVisualizer::indicatorsRealizable ( ) const

protectedvirtual

virtual bool makVrv::DtEnvironmentalIndicatorVisualizer::indicatorsVisible ( ) const

protectedvirtual

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::updateIndicatorVisibility ( )

protectedvirtual

virtual void makVrv::DtEnvironmentalIndicatorVisualizer::updateDefinitionState ( )

protectedvirtual

virtual bool makVrv::DtEnvironmentalIndicatorVisualizer::selected ( ) const

protectedvirtual

Reimplemented from makVrv::DtStateVisualizer.

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

protectedvirtual

Reimplemented from makVrv::DtIndicatorVisualizer.

Member Data Documentation

DtControlPointWidget* makVrv::DtEnvironmentalIndicatorVisualizer::myIndicator

protected

bool makVrv::DtEnvironmentalIndicatorVisualizer::myMultiSelected

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

DtEnvironmentalStateListener* makVrv::DtEnvironmentalIndicatorVisualizer::myEnvironmentalListener

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCore/DtEnvironmentalIndicatorVisualizer.h