makVrv::Dt3DTextStateVisualizer Class Reference

Dt3DTextStateVisualizer objects are responsible for displaying 3D text. More...

Inheritance diagram for makVrv::Dt3DTextStateVisualizer:

List of all members.

Public Member Functions
	Dt3DTextStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	Constructor.
virtual	~Dt3DTextStateVisualizer ()
	Destructor.
virtual void	setLocation (const DtVector &loc)
	Sets the position of the cuboid in database coordinates, or body coordinates (if attached)
virtual void	setColor (float r, float g, float b, float a)
	Sets the color of the text.
virtual void	setFlashing (bool flashing)
	Sets whether the text is flashing.
virtual void	setText (const std::string &str)
	Sets the actual text.
virtual void	setAttached (DtUniqueID id, int vtx, double percentage)
	Attaches the text to the unique ID specified.
virtual void	setHostId (const std::string &id, int vtx, double percentage)
	Sets the host ID attached to. Overridden by child classes.
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
Dt3DTextModelAgent *	myTextModelAgent
DtAttachableUpdaterAgent *	myAttachableUpdater
DtVisibilityAdapter < Dt3DTextModelAgent > *	myVisibilityAdapter

---

Detailed Description

Dt3DTextStateVisualizer objects are responsible for displaying 3D text.

---

Constructor & Destructor Documentation

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

Constructor.

virtual makVrv::Dt3DTextStateVisualizer::~Dt3DTextStateVisualizer

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void makVrv::Dt3DTextStateVisualizer::setLocation

(

const DtVector &

loc

)

[virtual]

Sets the position of the cuboid in database coordinates, or body coordinates (if attached)

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

Sets the color of the text.

virtual void makVrv::Dt3DTextStateVisualizer::setFlashing

(

bool

flashing

)

[virtual]

Sets whether the text is flashing.

Implements makVrv::DtRemoteGraphicVisualizerAttributes.

virtual void makVrv::Dt3DTextStateVisualizer::setText

(

const std::string &

str

)

[virtual]

Sets the actual text.

virtual void makVrv::Dt3DTextStateVisualizer::setAttached	(	DtUniqueID	id,
		int	vtx,
		double	percentage
	)		[virtual]

Attaches the text to the unique ID specified.

Parameters:

id	Unique ID of the object attached to, if 0, detaches
vtx	ignored
percentage	Specifies the percentage between 2 vertices if attached to a line or cylinder

virtual void makVrv::Dt3DTextStateVisualizer::setHostId	(	const std::string &	id,
		int	vtx,
		double	percentage
	)		[virtual]

Sets the host ID attached to. Overridden by child classes.

virtual const DtStateVisualizer::TypeInfo& makVrv::Dt3DTextStateVisualizer::typeInfo

(

)

const [virtual]

The instance's type info.

Implements makVrv::DtStateVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::Dt3DTextStateVisualizer::theTypeInfo

(

)

[static]

This class's type info.

virtual void makVrv::Dt3DTextStateVisualizer::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::Dt3DTextStateVisualizer::createModelAgents

(

)

[protected, virtual]

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

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::Dt3DTextStateVisualizer::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).

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::Dt3DTextStateVisualizer::setModelDefinitionForAgents

(

)

[protected, virtual]

Not implemented.

Reimplemented from makVrv::DtSceneObjectVisualizer.

---

Member Data Documentation

Dt3DTextModelAgent* makVrv::Dt3DTextStateVisualizer::myTextModelAgent [protected]

DtAttachableUpdaterAgent* makVrv::Dt3DTextStateVisualizer::myAttachableUpdater [protected]

DtVisibilityAdapter<Dt3DTextModelAgent>* makVrv::Dt3DTextStateVisualizer::myVisibilityAdapter [protected]

---

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

• include/vrvCore/Dt3DTextStateVisualizer.h