DtLineTaskVisualization Class Reference

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

Inheritance diagram for DtLineTaskVisualization:

Classes
class	LineVertex

Public Member Functions
	DtLineTaskVisualization (const DtString &name, const DtString &taskComp, DtVrfObject *taskedObject)
virtual	~DtLineTaskVisualization ()
virtual void	setVertex (unsigned index, const DtVector &location)
	Sets location of vertex to specific geocentric location.
virtual void	setVertices (const std::vector< DtVector > &locations)
	Sets location of all vertices to specific geocentric locations.
virtual void	setVertex (unsigned index, const DtGlobalObjectDesignator &obj)
	Attaches a vertex to an object.
virtual void	setVertices (const std::vector< DtGlobalObjectDesignator > &objs)
	Attaches all vertices to specified objects.
virtual void	setVertices (const std::vector< LineVertex > &locations)
	Attaches all vertices to specified locations and/or objects.
virtual const std::vector < LineVertex > &	vertices () const
	Gets the location of all vertices.
virtual const LineVertex &	vertex (unsigned index) const
	Gets the location of a single vertex.
virtual bool	arrowAtEnd () const
	Whether the line ends with an arrow.
virtual void	setArrowAtEnd (bool drawArrow)
	Whether the line ends with an arrow.
virtual bool	arrowAtStart () const
	Whether the line starts with an arrow.
virtual void	setArrowAtStart (bool drawArrow)
	Whether the line starts with an arrow.
virtual unsigned	thickness () const
	Thickness of the line.
virtual void	setThickness (unsigned thickness)
	Thickness of the line.
Public Member Functions inherited from DtTaskVisualization
	DtTaskVisualization (const DtString &name, const DtString &taskComp, DtVrfObject *taskedObject)
	Constructor.
virtual	~DtTaskVisualization ()
	Destructor.
virtual const DtString &	name ()
	Returns the visualization name.
virtual const DtString &	taskComponent ()
	Returns the task component name.
virtual const DtUUID &	taskedObject ()
	Returns the UUID of the object being tasked.
virtual void	update (DtBulkEnvironmentProcessManager *bulkMgr)
	Updates the visualization object data.
virtual void	stopUpdates ()
	Stops updating the task visualization object data.
virtual unsigned	red () const
	Color of the visualization object.
virtual unsigned	green () const
	Color of the visualization object.
virtual unsigned	blue () const
	Color of the visualization object.
virtual unsigned	alpha () const
	Color of the visualization object.
virtual void	setColor (unsigned red, unsigned green, unsigned blue, unsigned alpha)
	Color of the visualization object.
virtual const DtVector64 &	locationOffset () const
	The location offset of the vertex in the visualization.
virtual void	setLocationOffset (const DtVector64 &offset)
	The location offset of the vertex in the visualization.

Protected Member Functions
virtual bool	isPublished () const
	Returns true if the visualization is already published.
virtual void	publishDrawControlObjects (DtBulkEnvironmentProcessManager *bulkMgr)
	Creates the visualization object for publication to the network.
virtual void	createDrawControlObjects (DtExerciseConn *exConn)
	Creates the draw control objects that display this task visualization.
virtual void	unpublishDrawControlObjects ()
	Removes the visualization object from the network.
virtual void	updateDrawControlObjects ()
	Updates the visualization object data. Must call publish first.
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.
virtual unsigned	nextId ()
	Returns an ID number to be used when creating remote draw objects.

Protected Attributes
bool	myLocationsDirty
std::vector< LineVertex >	myVertices
bool	myArrowAtEnd
bool	myArrowAtStart
unsigned	myThickness
DtBulkEnvironmentProcessManager *	myBulkManager
std::vector < vrvControlToolkit::DtLine3DObject * >	mySegmentObjects
Protected Attributes inherited from DtTaskVisualization
DtString	myName
DtString	myTaskComponent
DtVrfObject *	myTaskedObject
unsigned	myRed
unsigned	myGreen
unsigned	myBlue
unsigned	myAlpha
DtVector64	myLocationOffset
	Location offset in forward, right, down entity coordinates.
DtTaskVisualizationPublisherCreator *	myEnvProcPublisherCreator

Detailed Description

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

Constructor & Destructor Documentation

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

virtual DtLineTaskVisualization::~DtLineTaskVisualization ( )

virtual

Member Function Documentation

virtual void DtLineTaskVisualization::setVertex ( unsigned  index, const DtVector &  location  )

virtual

Sets location of vertex to specific geocentric location.

virtual void DtLineTaskVisualization::setVertices ( const std::vector< DtVector > &  locations )

virtual

Sets location of all vertices to specific geocentric locations.

virtual void DtLineTaskVisualization::setVertex ( unsigned  index, const DtGlobalObjectDesignator &  obj  )

virtual

Attaches a vertex to an object.

virtual void DtLineTaskVisualization::setVertices ( const std::vector< DtGlobalObjectDesignator > &  objs )

virtual

Attaches all vertices to specified objects.

virtual void DtLineTaskVisualization::setVertices ( const std::vector< LineVertex > &  locations )

virtual

Attaches all vertices to specified locations and/or objects.

virtual const std::vector<LineVertex>& DtLineTaskVisualization::vertices ( ) const

virtual

Gets the location of all vertices.

virtual const LineVertex& DtLineTaskVisualization::vertex ( unsigned  index ) const

virtual

Gets the location of a single vertex.

virtual bool DtLineTaskVisualization::arrowAtEnd ( ) const

virtual

Whether the line ends with an arrow.

virtual void DtLineTaskVisualization::setArrowAtEnd ( bool  drawArrow )

virtual

Whether the line ends with an arrow.

virtual bool DtLineTaskVisualization::arrowAtStart ( ) const

virtual

Whether the line starts with an arrow.

virtual void DtLineTaskVisualization::setArrowAtStart ( bool  drawArrow )

virtual

Whether the line starts with an arrow.

virtual unsigned DtLineTaskVisualization::thickness ( ) const

virtual

Thickness of the line.

virtual void DtLineTaskVisualization::setThickness ( unsigned  thickness )

virtual

Thickness of the line.

virtual bool DtLineTaskVisualization::isPublished ( ) const

protectedvirtual

Returns true if the visualization is already published.

Implements DtTaskVisualization.

virtual void DtLineTaskVisualization::publishDrawControlObjects ( DtBulkEnvironmentProcessManager *  bulkMgr )

protectedvirtual

Creates the visualization object for publication to the network.

Object is added to the given bulk environment process manager.

Reimplemented from DtTaskVisualization.

virtual void DtLineTaskVisualization::createDrawControlObjects ( DtExerciseConn *  exConn )

protectedvirtual

Creates the draw control objects that display this task visualization.

Implements DtTaskVisualization.

virtual void DtLineTaskVisualization::unpublishDrawControlObjects ( )

protectedvirtual

Removes the visualization object from the network.

Implements DtTaskVisualization.

virtual void DtLineTaskVisualization::updateDrawControlObjects ( )

protectedvirtual

Updates the visualization object data. Must call publish first.

Implements DtTaskVisualization.

Member Data Documentation

bool DtLineTaskVisualization::myLocationsDirty

protected

std::vector<LineVertex> DtLineTaskVisualization::myVertices

protected

bool DtLineTaskVisualization::myArrowAtEnd

protected

bool DtLineTaskVisualization::myArrowAtStart

protected

unsigned DtLineTaskVisualization::myThickness

protected

DtBulkEnvironmentProcessManager* DtLineTaskVisualization::myBulkManager

protected

std::vector<vrvControlToolkit::DtLine3DObject*> DtLineTaskVisualization::mySegmentObjects

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfobjcore/lineTaskVisualization.h