makVrv::Dt2DTextStateVisualizer Class Reference

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

Inheritance diagram for makVrv::Dt2DTextStateVisualizer:

List of all members.

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.
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 Attributes
DtWindowTextAgent *	myTextAgent
DtVisibilityAdapter < DtWindowTextAgent > *	myVisibilityAdapter

---

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

)

[protected, virtual]

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

(

)

[protected, virtual]

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

Implements makVrv::DtStateVisualizer.

virtual void makVrv::Dt2DTextStateVisualizer::destroyModelAgents

(

)

[protected, virtual]

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

(

)

[protected, virtual]

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:

• include/vrvCore/Dt2DTextStateVisualizer.h