DtTaskVisualizationSet Class Reference

Inheritance diagram for DtTaskVisualizationSet:

Public Member Functions
	DtTaskVisualizationSet (const DtString &name, const DtString &taskComp, DtVrfObject *taskedObject)
	Constructor.
virtual DtTaskVisualizationSetPtr	taskVisualizationSet (DtString name)
	Finds an existing or creates a new set task visualization with the given name.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (DtString name)
	Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (DtString name)
	Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (DtString name)
	Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (DtString name)
	Finds an existing or creates a new text task visualization with the given name.
virtual void	update (DtBoost::shared_ptr< DtBulkEnvironmentProcessManager > bulkMgr)
	Updates the visualization object data.
virtual void	stopUpdates ()
	Stops updating the task visualization object data.
Public Member Functions inherited from DtTaskVisualization
	DtTaskVisualization (const DtString &name, const DtString &taskComp, DtVrfObject *taskedObject)
	Constructor.
virtual	~DtTaskVisualization ()
	Destructor.
virtual const DtString &	name () const
	Returns the visualization name.
virtual const DtString &	taskComponent () const
	Returns the task component name.
virtual const DtUUID &	taskedObject () const
	Returns the UUID of the object being tasked.
virtual unsigned	red () const
	Color of the visualization object.
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.
virtual void	setLocationOffset (const DtVector64 &offset)

Protected Types
typedef std::map< DtString, DtTaskVisualizationPtr >	SubTaskVisMap
typedef SubTaskVisMap::value_type	SubTaskVisMapValue

Protected Member Functions
virtual bool	isPublished () const
	Returns true if the visualization is already published.
virtual void	publishDrawControlObjects (DtBoost::shared_ptr< DtBulkEnvironmentProcessManager > bulkMgr)
	Creates the visualization object for publication to the network.
virtual void	createDrawControlObjects (DtExerciseConn *exConn)
	Creates the draw control objects for 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.
virtual DtString	combineNames (DtString name) const
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
SubTaskVisMap	mySubTaskVisMap
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

Member Typedef Documentation

typedef std::map<DtString, DtTaskVisualizationPtr> DtTaskVisualizationSet::SubTaskVisMap

protected

typedef SubTaskVisMap::value_type DtTaskVisualizationSet::SubTaskVisMapValue

protected

Constructor & Destructor Documentation

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

Constructor.

Member Function Documentation

virtual DtTaskVisualizationSetPtr DtTaskVisualizationSet::taskVisualizationSet ( DtString  name )

virtual

Finds an existing or creates a new set task visualization with the given name.

virtual DtPointTaskVisualizationPtr DtTaskVisualizationSet::pointTaskVisualization ( DtString  name )

virtual

Finds an existing or creates a new point task visualization with the given name.

virtual DtLineTaskVisualizationPtr DtTaskVisualizationSet::lineTaskVisualization ( DtString  name )

virtual

Finds an existing or creates a new line task visualization with the given name.

virtual DtAreaTaskVisualizationPtr DtTaskVisualizationSet::areaTaskVisualization ( DtString  name )

virtual

Finds an existing or creates a new area task visualization with the given name.

virtual DtTextTaskVisualizationPtr DtTaskVisualizationSet::textTaskVisualization ( DtString  name )

virtual

Finds an existing or creates a new text task visualization with the given name.

virtual void DtTaskVisualizationSet::update ( DtBoost::shared_ptr< DtBulkEnvironmentProcessManager >  bulkMgr )

virtual

Updates the visualization object data.

Reimplemented from DtTaskVisualization.

virtual void DtTaskVisualizationSet::stopUpdates ( )

virtual

Stops updating the task visualization object data.

Reimplemented from DtTaskVisualization.

virtual bool DtTaskVisualizationSet::isPublished ( ) const

protectedvirtual

Returns true if the visualization is already published.

Implements DtTaskVisualization.

virtual void DtTaskVisualizationSet::publishDrawControlObjects ( DtBoost::shared_ptr< 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 DtTaskVisualizationSet::createDrawControlObjects ( DtExerciseConn *  exConn )

protectedvirtual

Creates the draw control objects for this task visualization.

Implements DtTaskVisualization.

virtual void DtTaskVisualizationSet::unpublishDrawControlObjects ( )

protectedvirtual

Removes the visualization object from the network.

Implements DtTaskVisualization.

virtual void DtTaskVisualizationSet::updateDrawControlObjects ( )

protectedvirtual

Updates the visualization object data. Must call publish first.

Implements DtTaskVisualization.

virtual DtString DtTaskVisualizationSet::combineNames ( DtString  name ) const

protectedvirtual

Member Data Documentation

SubTaskVisMap DtTaskVisualizationSet::mySubTaskVisMap

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/taskVisualizationSet.h