VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtTaskVisualization Class Reference

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

Inheritance diagram for DtTaskVisualization:
Inheritance graph
[legend]

Public Member Functions

 DtTaskVisualization (const DtString &name, const DtString &taskComp, DtVrfObject *taskedObject)
 Constructor.
virtual ~DtTaskVisualization ()
 Destructor.
virtual const DtStringname ()
 Returns the visualization name.
virtual const DtStringtaskComponent ()
 Returns the task component name.
virtual const DtUUIDtaskedObject ()
 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 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 bool isPublished () const =0
 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)=0
 Creates the draw control objects for this task visualization.
virtual void unpublishDrawControlObjects ()=0
 Removes the visualization object from the network.
virtual void updateDrawControlObjects ()=0
 Updates the visualization object data. Must call publish first.
virtual unsigned nextId ()
 Returns an ID number to be used when creating remote draw objects.

Protected Attributes

DtString myName
DtString myTaskComponent
DtVrfObjectmyTaskedObject
unsigned myRed
unsigned myGreen
unsigned myBlue
unsigned myAlpha
DtVector64 myLocationOffset
 Location offset in forward, right, down entity coordinates.
DtTaskVisualizationPublisherCreatormyEnvProcPublisherCreator

Detailed Description

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

For instance, it could be a point showing the location where the entity is moving or an arrow indicating the path the entity will take.

Constructor & Destructor Documentation

DtTaskVisualization::DtTaskVisualization ( const DtString name,
const DtString taskComp,
DtVrfObject taskedObject 
)

Constructor.

virtual DtTaskVisualization::~DtTaskVisualization ( )
virtual

Destructor.

Member Function Documentation

virtual const DtString& DtTaskVisualization::name ( void  )
inlinevirtual

Returns the visualization name.

virtual const DtString& DtTaskVisualization::taskComponent ( )
inlinevirtual

Returns the task component name.

virtual const DtUUID& DtTaskVisualization::taskedObject ( )
inlinevirtual

Returns the UUID of the object being tasked.

References DtUUID::uuid().

virtual unsigned DtTaskVisualization::red ( ) const
virtual

Color of the visualization object.

virtual unsigned DtTaskVisualization::green ( ) const
virtual

Color of the visualization object.

virtual unsigned DtTaskVisualization::blue ( ) const
virtual

Color of the visualization object.

virtual unsigned DtTaskVisualization::alpha ( ) const
virtual

Color of the visualization object.

virtual void DtTaskVisualization::setColor ( unsigned  red,
unsigned  green,
unsigned  blue,
unsigned  alpha 
)
virtual

Color of the visualization object.

virtual const DtVector64& DtTaskVisualization::locationOffset ( ) const
virtual

The location offset of the vertex in the visualization.

Offsets are relative to either the simulation object to which the vertex is attached or, for fixed location vertices, the tasked entity.

virtual void DtTaskVisualization::setLocationOffset ( const DtVector64 &  offset)
virtual

The location offset of the vertex in the visualization.

Offsets are relative to either the simulation object to which the vertex is attached or, for fixed location vertices, the tasked entity.

virtual void DtTaskVisualization::update ( DtBulkEnvironmentProcessManager bulkMgr)
virtual

Updates the visualization object data.

virtual void DtTaskVisualization::stopUpdates ( )
virtual

Stops updating the task visualization object data.

virtual void DtTaskVisualization::calculateOffsetLocation ( const DtVector location,
DtVector offsetLocation 
)
protectedvirtual

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 bool DtTaskVisualization::isPublished ( ) const
protectedpure virtual

Returns true if the visualization is already published.

Implemented in DtLineTaskVisualization, DtPointTaskVisualization, DtTextTaskVisualization, and DtAreaTaskVisualization.

virtual void DtTaskVisualization::publishDrawControlObjects ( DtBulkEnvironmentProcessManager bulkMgr)
protectedvirtual

Creates the visualization object for publication to the network.

Object is added to the given bulk environment process manager.

Reimplemented in DtLineTaskVisualization.

virtual void DtTaskVisualization::createDrawControlObjects ( DtExerciseConn *  exConn)
protectedpure virtual

Creates the draw control objects for this task visualization.

Implemented in DtLineTaskVisualization, DtPointTaskVisualization, DtTextTaskVisualization, and DtAreaTaskVisualization.

virtual void DtTaskVisualization::unpublishDrawControlObjects ( )
protectedpure virtual

Removes the visualization object from the network.

Implemented in DtLineTaskVisualization, DtPointTaskVisualization, DtTextTaskVisualization, and DtAreaTaskVisualization.

virtual void DtTaskVisualization::updateDrawControlObjects ( )
protectedpure virtual

Updates the visualization object data. Must call publish first.

Implemented in DtLineTaskVisualization, DtPointTaskVisualization, DtTextTaskVisualization, and DtAreaTaskVisualization.

virtual unsigned DtTaskVisualization::nextId ( )
protectedvirtual

Returns an ID number to be used when creating remote draw objects.

Member Data Documentation

DtString DtTaskVisualization::myName
protected
DtString DtTaskVisualization::myTaskComponent
protected
DtVrfObject* DtTaskVisualization::myTaskedObject
protected
unsigned DtTaskVisualization::myRed
protected
unsigned DtTaskVisualization::myGreen
protected
unsigned DtTaskVisualization::myBlue
protected
unsigned DtTaskVisualization::myAlpha
protected
DtVector64 DtTaskVisualization::myLocationOffset
protected

Location offset in forward, right, down entity coordinates.

DtTaskVisualizationPublisherCreator* DtTaskVisualization::myEnvProcPublisherCreator
protected

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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)