VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtEnvironmentalLineVisualizer Class Reference

DtEnvironmentalLineVisualizer display a line that contains at least two points. More...

Inheritance diagram for makVrv::DtEnvironmentalLineVisualizer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtEnvironmentalLineVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 Constructor.
virtual ~DtEnvironmentalLineVisualizer ()
 Destructor.
virtual void setColor (float r, float g, float b, float a)
 Sets the color for the line.
virtual void addPoint (int index, const DtVector &)
 Adds a point to the line.
virtual void removePoint (int index)
 Removes point at the given index.
virtual void modifyPoint (int index, const DtVector &)
 Modifies the point at the given index.
virtual void setPoints (const DtEnvironmentalStateListener::ControlPointsList &)
 Sets the control points to the specified list, adding, removing and changing as needed.
virtual void setSelected (bool b)
 Selects the entire line.
virtual void resetSpatial ()
 Resets geometry of line.
virtual void createModelAgents ()
 Creates the model agents associated with the line.
virtual void setLineStyle (int)
 Sets the line style.
virtual void setLineWidth (int)
 Sets the line width.
virtual void setOrigin (const DtVector &)
 Sets the origin of the line.
virtual const DtVectororigin () const
 Get the origin of the line.

Protected Member Functions

virtual void destroyModelAgents ()
 Destroys any model agents currently created.
virtual void setModelDefinitionForAgents ()
 Sets model definitions for agents.
virtual DtLineModelAgent * createLineAgent ()=0
 Used by subclasses to create the line agent used to display the line.
virtual void setVisualizerDefinition (const DtVisualizerDefinition &visDef)
 Set the visualizer definition that defines the parameters of this visualizer.
virtual DtVector offsetAtPosition (const DtVector &origin) const
 Given the origin and the point offset, return an offset that is valid at the given position.
virtual void setSolid (bool)
 Set whether the object created by this visualizer can be ground- clamped to.

Protected Attributes

DtTacticalGraphicStateListenermyLineListener
DtLineModelAgent * myLineModelAgent
DtEnvironmentalStateListener::ControlPointsList myControlPoints
int myLineWidth
DtVector myPointOffset
bool myOriginSet
DtVector myOrigin

Detailed Description

DtEnvironmentalLineVisualizer display a line that contains at least two points.


Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

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

Sets the color for the line.

This will apply to all segments of the line. If the default (all 0's), uses the default as defined in the visual definition

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalLineVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::addPoint ( int  index,
const DtVector  
) [virtual]
virtual void makVrv::DtEnvironmentalLineVisualizer::removePoint ( int  index) [virtual]

Removes point at the given index.

Reimplemented in makVrv::Dt3DEnvironmentalLineVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::modifyPoint ( int  index,
const DtVector  
) [virtual]

Selects the entire line.

Reimplemented from makVrv::DtStateVisualizer.

Resets geometry of line.

Creates the model agents associated with the line.

Reimplemented from makVrv::DtSceneObjectVisualizer.

Reimplemented in makVrv::Dt3DEnvironmentalLineVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::setLineStyle ( int  ) [virtual]
virtual void makVrv::DtEnvironmentalLineVisualizer::setLineWidth ( int  ) [virtual]
virtual void makVrv::DtEnvironmentalLineVisualizer::setOrigin ( const DtVector ) [virtual]
virtual const DtVector& makVrv::DtEnvironmentalLineVisualizer::origin ( ) const [virtual]

Get the origin of the line.

virtual void makVrv::DtEnvironmentalLineVisualizer::destroyModelAgents ( ) [protected, virtual]

Destroys any model agents currently created.

Reimplemented from makVrv::DtSceneObjectVisualizer.

Sets model definitions for agents.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual DtLineModelAgent* makVrv::DtEnvironmentalLineVisualizer::createLineAgent ( ) [protected, pure virtual]

Used by subclasses to create the line agent used to display the line.

Implemented in makVrv::Dt3DEnvironmentalLineVisualizer, and makVrv::Dt2DEnvironmentalLineVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition visDef) [protected, virtual]

Set the visualizer definition that defines the parameters of this visualizer.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalLineVisualizer.

virtual DtVector makVrv::DtEnvironmentalLineVisualizer::offsetAtPosition ( const DtVector origin) const [protected, virtual]

Given the origin and the point offset, return an offset that is valid at the given position.

Default simply returns offset

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalLineVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::setSolid ( bool  ) [protected, virtual]

Set whether the object created by this visualizer can be ground- clamped to.

Reimplemented in makVrv::Dt3DEnvironmentalLineVisualizer.


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)