makVrv::Dt2DTextStateVisualizer Class Reference

Visualizer for 2d text remote graphics. More...

Inheritance diagram for makVrv::Dt2DTextStateVisualizer:

Public Member Functions
	Dt2DTextStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~Dt2DTextStateVisualizer ()
	DTOR.
virtual void	setTopLeftCorner (float x, float y)
	Set the Top left corner of the text in normalized screen coordinates (0..1)
virtual void	setColor (float r, float g, float b, float a)
	Set the text's color.
virtual void	setText (const std::string &textString)
	Set the text to display.
virtual void	setFont (const std::string &fontFile, float sizeInPoints)
	Set the font file and size in points to display the text in.
virtual void	setTextBoxWidth (unsigned int widthInPixels)
	Set the width of the text box in pixels.
virtual void	setAlignment (unsigned int alignment)
	Set the alignment mode of the text.
virtual void	setFlashing (bool blinking)
	Set the text to blink or not blink.
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
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.
virtual void	setSelected (bool)
	Sets selected state.
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
virtual void	setUniqueID (DtUniqueID id)
DtUniqueID	uniqueID () const
int	visualizerType () const
void	setShowHideContext (const std::vector< int > &s)
	Set show/hide context without changing visibility of item.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &)
	Set any other additional visualizer information from the visual record.
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 Member Functions inherited from makVrv::DtRemoteGraphicVisualizerAttributes
	DtRemoteGraphicVisualizerAttributes ()
	CTOR.
virtual	~DtRemoteGraphicVisualizerAttributes ()
	DTOR.
virtual void	setActive (bool active)
	Set the graphic active or inactive.
virtual void	setLayerName (const std::string &layerName)
	Sets the layer that the graphic is in.

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

Protected Member Functions
virtual void	setVisible (bool yesNo)
	Set the visuals visible or invisible.
virtual void	createModelAgents ()
	Create the visual models, or do nothing if they already exist.
virtual void	destroyModelAgents ()
	Destroy the visual models.
virtual void	setModelDefinitionForAgents ()
	Not implemented.
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
DtWindowTextAgent *	myTextAgent
DtVisibilityAdapter < DtWindowTextAgent > *	myVisibilityAdapter
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
Protected Attributes inherited from makVrv::DtRemoteGraphicVisualizerAttributes
bool	myActive
bool	myFlashing
std::vector< std::string >	myLayers
std::string	myLayerName
bool	myEnabled

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::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

Detailed Description

Visualizer for 2d text remote graphics.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::Dt2DTextStateVisualizer::~Dt2DTextStateVisualizer ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::Dt2DTextStateVisualizer::setTopLeftCorner ( float  x, float  y  )

virtual

Set the Top left corner of the text in normalized screen coordinates (0..1)

virtual void makVrv::Dt2DTextStateVisualizer::setColor ( float  r, float  g, float  b, float  a  )

virtual

Set the text's color.

virtual void makVrv::Dt2DTextStateVisualizer::setText ( const std::string &  textString )

virtual

Set the text to display.

virtual void makVrv::Dt2DTextStateVisualizer::setFont ( const std::string &  fontFile, float  sizeInPoints  )

virtual

Set the font file and size in points to display the text in.

virtual void makVrv::Dt2DTextStateVisualizer::setTextBoxWidth ( unsigned int  widthInPixels )

virtual

Set the width of the text box in pixels.

virtual void makVrv::Dt2DTextStateVisualizer::setAlignment ( unsigned int  alignment )

virtual

Set the alignment mode of the text.

virtual void makVrv::Dt2DTextStateVisualizer::setFlashing ( bool  blinking )

virtual

Set the text to blink or not blink.

Implements makVrv::DtRemoteGraphicVisualizerAttributes.

virtual const DtStateVisualizer::TypeInfo& makVrv::Dt2DTextStateVisualizer::typeInfo ( ) const

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::Dt2DTextStateVisualizer::theTypeInfo ( )

static

This class's type info.

virtual void makVrv::Dt2DTextStateVisualizer::setVisible ( bool  yesNo )

protectedvirtual

Set the visuals visible or invisible.

This maintains the state of the visual objects, and calling setVisible(false) should not be expected to provide any performance benefit.

Implements makVrv::DtRemoteGraphicVisualizerAttributes.

virtual void makVrv::Dt2DTextStateVisualizer::createModelAgents ( )

protectedvirtual

Create the visual models, or do nothing if they already exist.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::Dt2DTextStateVisualizer::destroyModelAgents ( )

protectedvirtual

Destroy the visual models.

This does not maintain their state; for example, calling setFlashing(true); destroyModelAgents(); createModelAgents(); will result in models with the default value of flashing, which is false.

Destroying models generally provides some performance benefit, as compared to calling setVisible(false).

Implements makVrv::DtStateVisualizer.

virtual void makVrv::Dt2DTextStateVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

Not implemented.

Implements makVrv::DtStateVisualizer.

Member Data Documentation

DtWindowTextAgent* makVrv::Dt2DTextStateVisualizer::myTextAgent

protected

DtVisibilityAdapter<DtWindowTextAgent>* makVrv::Dt2DTextStateVisualizer::myVisibilityAdapter

protected

---

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

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