DtTextTaskVisualization Class Reference

A DtTextTaskVisualization describes a text graphic to be displayed in the GUI to visualize the behavior of the current task. More...

Inheritance diagram for DtTextTaskVisualization:

Public Member Functions
	DtTextTaskVisualization (const DtString &name, const DtString &taskComp, const DtVrfObject *taskedObject)
virtual	~DtTextTaskVisualization ()
virtual const DtVector &	location () const
	The location of the text (geocentric). More...
virtual void	setLocation (const DtVector &location)
virtual const DtGlobalObjectDesignator &	attachedObject () const
	The object to which this text is attached. More...
virtual void	setAttachedObject (const DtGlobalObjectDesignator &obj)
virtual const DtString &	text () const
	The text to be displayed. More...
virtual void	setText (const DtString &text)
Public Member Functions inherited from DtTaskVisualization
	DtTaskVisualization (const DtString &name, const DtString &taskComp, const DtVrfObject *taskedObject)
	Constructor. More...
virtual	~DtTaskVisualization ()
	Destructor. More...
virtual const DtString &	name () const
	Returns the visualization name. More...
virtual const DtString &	taskComponent () const
	Returns the task component name. More...
virtual const DtUUID &	taskedObject () const
	Returns the UUID of the object being tasked. More...
virtual void	update (DtBoost::shared_ptr< DtBulkEnvironmentProcessManager > bulkMgr)
	Updates the visualization object data. More...
virtual void	stopUpdates ()
	Stops updating the task visualization object data. More...
virtual unsigned	red () const
	Color of the visualization object. More...
virtual unsigned	green () const
virtual unsigned	blue () const
virtual unsigned	alpha () const
virtual void	setColor (unsigned red, unsigned green, unsigned blue, unsigned alpha)
virtual const DtVector64 &	locationOffset () const
	The location offset of the vertex in the visualization. More...
virtual void	setLocationOffset (const DtVector64 &offset)

Protected Member Functions
virtual bool	isPublished () const
	Returns true if the visualization is already published. More...
virtual void	createDrawControlObjects (DtExerciseConn *exConn)
	Creates the draw control object that displays this task visualization. More...
virtual void	unpublishDrawControlObjects ()
	Removes the visualization object from the network. More...
virtual void	updateDrawControlObjects ()
	Updates the visualization object data. More...
Protected Member Functions inherited from DtTaskVisualization
virtual void	calculateOffsetLocation (const DtVector &location, DtVector &offsetLocation)
	Offsets the given geocentric location using the current location offset and converts it to a new geocentric location suitable for publishing to VR-Vantage. More...
virtual void	publishDrawControlObjects (DtBoost::shared_ptr< DtBulkEnvironmentProcessManager > bulkMgr)
	Creates the visualization object for publication to the network. More...
virtual unsigned	nextId ()
	Returns an ID number to be used when creating remote draw objects. More...

Protected Attributes
bool	myLocationDirty
DtVector	myLocation
DtGlobalObjectDesignator	myAttachedObject
DtString	myText
vrvControlToolkit::DtText3DObject *	myTextObject
Protected Attributes inherited from DtTaskVisualization
DtString	myName
DtString	myTaskComponent
const DtVrfObject *	myTaskedObject
unsigned	myRed
unsigned	myGreen
unsigned	myBlue
unsigned	myAlpha
DtVector64	myLocationOffset
	Location offset in forward, right, down entity coordinates. More...
DtTaskVisualizationPublisherCreator *	myEnvProcPublisherCreator

Detailed Description

A DtTextTaskVisualization describes a text graphic to be displayed in the GUI to visualize the behavior of the current task.

Constructor & Destructor Documentation

DtTextTaskVisualization::DtTextTaskVisualization	(	const DtString &	name,
		const DtString &	taskComp,
		const DtVrfObject *	taskedObject
	)

virtual DtTextTaskVisualization::~DtTextTaskVisualization ( )

virtual

Member Function Documentation

virtual const DtVector& DtTextTaskVisualization::location ( ) const

virtual

The location of the text (geocentric).

If set, the attached object will be cleared.

virtual void DtTextTaskVisualization::setLocation ( const DtVector &  location )

virtual

virtual const DtGlobalObjectDesignator& DtTextTaskVisualization::attachedObject ( ) const

virtual

The object to which this text is attached.

virtual void DtTextTaskVisualization::setAttachedObject ( const DtGlobalObjectDesignator &  obj )

virtual

virtual const DtString& DtTextTaskVisualization::text ( ) const

virtual

The text to be displayed.

virtual void DtTextTaskVisualization::setText ( const DtString &  text )

virtual

virtual bool DtTextTaskVisualization::isPublished ( ) const

protectedvirtual

Returns true if the visualization is already published.

Implements DtTaskVisualization.

virtual void DtTextTaskVisualization::createDrawControlObjects ( DtExerciseConn *  exConn )

protectedvirtual

Creates the draw control object that displays this task visualization.

Implements DtTaskVisualization.

virtual void DtTextTaskVisualization::unpublishDrawControlObjects ( )

protectedvirtual

Removes the visualization object from the network.

Implements DtTaskVisualization.

virtual void DtTextTaskVisualization::updateDrawControlObjects ( )

protectedvirtual

Updates the visualization object data.

Implements DtTaskVisualization.

Member Data Documentation

bool DtTextTaskVisualization::myLocationDirty

protected

DtVector DtTextTaskVisualization::myLocation

protected

DtGlobalObjectDesignator DtTextTaskVisualization::myAttachedObject

protected

DtString DtTextTaskVisualization::myText

protected

vrvControlToolkit::DtText3DObject* DtTextTaskVisualization::myTextObject

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/textTaskVisualization.h