VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::Dt3DEnvironmentalLineVisualizer Class Reference

Dt3DEnvironmentalLineVisualizer display a line drawn as an overlay if projected or in 3D space if not. More...

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

Public Member Functions

 Dt3DEnvironmentalLineVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 Constructor.
virtual ~Dt3DEnvironmentalLineVisualizer ()
 Destructor.
virtual DtLineFacadeInterfacecreateLineFacade ()
 Create the line facade that will render this line.
virtual void setProjected (bool)
 Sets to use 2D rather than 3D representation of line.
virtual const
DtStateVisualizer::TypeInfo
typeInfo () const
 The instance's type info.
- Public Member Functions inherited from makVrv::DtEnvironmentalLineVisualizer
 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 useDefaultColor ()
 Sets color to default color.
virtual void getColor (float &r, float &g, float &b, float &a) const
 Returns the color.
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 setStipplePattern (unsigned short)
 Sets the stipple pattern style.
virtual unsigned short lineStipple () const
 Returns the currently set stipple pattern.
virtual void setPenStyle (vrvTacticalGraphicUtilities::PenStyle)
 Takes the pen style and translates it to a stipple pattern.
virtual void setLineStyle (vrvTacticalGraphicUtilities::LineStyle)
 Sets the style of the line. See DtLineFacadeInterface.h for styles.
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.
virtual void setArrowHeadPlacement (vrvTacticalGraphicUtilities::ArrowHeadPlacement)
 Sets how often the arrows should be displayed.
virtual
vrvTacticalGraphicUtilities::ArrowHeadPlacement 
arrowHeadPlacement () const
 Returns the current arrow head placement strategy.
virtual void setArrowStyle (vrvTacticalGraphicUtilities::ArrowStyle)
 Sets the style of arrows for the line.
virtual
vrvTacticalGraphicUtilities::ArrowStyle 
arrowStyle () const
 Returns the arrow style.
virtual void setArrowSize (double)
 Sets the size of the arrow. In 3D this is meters, in 2D this is pixels.
virtual double arrowSize () const
 Returns the size of the awwow.
virtual void setFixedWidthSizing (bool)
 For those lines that support it, whether or not the lines sizes when zooming to pixel space (fixed width) or to the database (non-fixed width).
virtual bool fixedWidthSizing () const
 Returns whether or not this line will be sized with fixed width sizing.
- Public Member Functions inherited from makVrv::DtSceneObjectVisualizer
 DtSceneObjectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
virtual ~DtSceneObjectVisualizer ()
virtual DtUniqueID uniqueID () const
 Return unique id of mySceneObjectAgent, if it exists, else returns 0;.
virtual DtSceneObjectAgent * sceneObjectAgent ()
virtual void setParent (DtStateVisualizer *p)
 Override of base class setParent to simply set the parent without destroying/recreating model agents.
virtual void setSceneObjectAgent (DtSceneObjectAgent *)
virtual void setElementID (const DtElementID &elementID)
DtElementID elementID () const
virtual bool show (int)
 Override to show/hide scene object agent (if it exists)
virtual bool hide (int)
 Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtStateVisualizer ()
 DTOR.
void setModelDefinition (const std::string &definition)
 Sets the model definition and creates agent(s) based on that definition.
const std::string & modelDefinition () const
 Gets the current model definition.
virtual bool setVisible (bool visible, int context)
 Returns true if this context wants to show or hide the item.
virtual void initialize ()
 Initialize the visualizer.
virtual bool isVisible () const
 Returns true if visible.
virtual bool selected () const
void setName (const std::string &)
 Internal name of state visualizer.
const std::string & name () const
virtual void setPickable (bool)
 Sets pickable state.
virtual bool pickable () const
virtual void setUniqueID (DtUniqueID id)
int visualizerType () const
void setShowHideContext (const std::vector< int > &s)
 Set show/hide context without changing visibility of item.
DtStateListenerlistener ()
DtBaseConnectionsimulation ()
 Get the connection for this visualizer.
void setDistribute (bool b)
 Whether or not to distribute over the network.
bool distribute () const

Static Public Member Functions

static const
DtStateVisualizer::TypeInfo
theTypeInfo ()
 This class's type info.

Protected Member Functions

virtual DtLineFacadeInterfacecreateLineFacadeInterface ()
 Create the line facade that will render this line.
- Protected Member Functions inherited from makVrv::DtEnvironmentalLineVisualizer
virtual void destroyModelAgents ()
 Destroys any model agents currently created.
virtual void setModelDefinitionForAgents ()
 Sets model definitions for agents.
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.
virtual void setupLine ()
 Sets the line facade up with default data.
- Protected Member Functions inherited from makVrv::DtSceneObjectVisualizer
virtual DtSceneObjectAgent * createObjectAgent ()
- Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void slot_mouseDown (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
 Called when the mouse is clicked in this visualizer.
virtual void slot_mouseUp (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual void slot_mouseDblClick (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual bool supportsShowHideContext (int) const
 Default returns true.
template<typename T , typename C >
void connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
 Connect a signal and update the entity.

Protected Attributes

bool myProjected
- Protected Attributes inherited from makVrv::DtEnvironmentalLineVisualizer
DtTacticalGraphicStateListenermyLineListener
DtLineFacadeInterfacemyLineFacade
DtEnvironmentalStateListener::ControlPointsList myControlPoints
int myLineWidth
DtVector myPointOffset
bool myOriginSet
DtVector myOrigin
int myDefaultLineWidth
float myDefaultColor [4]
float myColor [4]
vrvTacticalGraphicUtilities::ArrowStyle myArrowStyle
vrvTacticalGraphicUtilities::ArrowHeadPlacement myArrowHeadPlacement
vrvTacticalGraphicUtilities::LineStyle myLineStyle
double myArrowSize
unsigned short myLineStipple
bool myFixedWidthSizing
bool myScribed
- Protected Attributes inherited from makVrv::DtSceneObjectVisualizer
DtElementID myElementID
- Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnectionmySimulation
DtStateListenermyListener
bool myDistributeFlag
DtUniqueID myUniqueID
std::string myName
std::string myModelDefinition
DtSignalConnectionManager myConnections
int myModelSet
int myVisualizerType
std::vector< int > myShowHideContexts
bool mySelected
bool myPickable
bool myVisible
DtStateVisualizermyParent
DtSceneObjectAgent * mySceneObjectAgent

Additional Inherited Members

- Public Types inherited from makVrv::DtStateVisualizer
enum  Type {
  AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType,
  AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000
}
 Visualizer class types that are supportable via visualizers. More...
- Public Attributes inherited from makVrv::DtStateVisualizer
boost::signal< void(DtStateVisualizer
*, DtStateVisualizer
*, DtStateVisualizer *)> 
signal_reparented
 Signaled when the parent of this item changes, called before destroying any model agents.
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseDown
 Emitted when the entity's indicator is clicked.
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseUp
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseDblClick

Detailed Description

Dt3DEnvironmentalLineVisualizer display a line drawn as an overlay if projected or in 3D space if not.

Constructor & Destructor Documentation

makVrv::Dt3DEnvironmentalLineVisualizer::Dt3DEnvironmentalLineVisualizer ( DtBaseConnection simulation,
DtStateListener listener,
int  modelSet 
)

Constructor.

virtual makVrv::Dt3DEnvironmentalLineVisualizer::~Dt3DEnvironmentalLineVisualizer ( )
virtual

Destructor.

Member Function Documentation

virtual DtLineFacadeInterface* makVrv::Dt3DEnvironmentalLineVisualizer::createLineFacade ( )
virtual

Create the line facade that will render this line.

Implements makVrv::DtEnvironmentalLineVisualizer.

Reimplemented in makVrv::Dt3DAirCorridorLineVisualizer.

virtual void makVrv::Dt3DEnvironmentalLineVisualizer::setProjected ( bool  )
virtual

Sets to use 2D rather than 3D representation of line.

virtual const DtStateVisualizer::TypeInfo& makVrv::Dt3DEnvironmentalLineVisualizer::typeInfo ( ) const
virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt3DAirCorridorLineVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::Dt3DEnvironmentalLineVisualizer::theTypeInfo ( )
static

This class's type info.

Reimplemented in makVrv::Dt3DAirCorridorLineVisualizer.

virtual DtLineFacadeInterface* makVrv::Dt3DEnvironmentalLineVisualizer::createLineFacadeInterface ( )
protectedvirtual

Create the line facade that will render this line.

Member Data Documentation

bool makVrv::Dt3DEnvironmentalLineVisualizer::myProjected
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)