VR-Forces 4.3 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
makVrv::DtEnvironmentalLineVisualizer Class Reference
vrvCore

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

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

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 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 DtVector & origin () 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.
virtual const TypeInfo & typeInfo () const =0
 Get the type info.
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.
DtStateListener & listener ()
DtBaseConnection & simulation ()
 Get the connection for this visualizer.
void setDistribute (bool b)
 Whether or not to distribute over the network.
bool distribute () const

Protected Member Functions

virtual void destroyModelAgents ()
 Destroys any model agents currently created.
virtual void setModelDefinitionForAgents ()
 Sets model definitions for agents.
virtual DtLineFacadeInterface * createLineFacade ()=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.
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

DtTacticalGraphicStateListener & myLineListener
DtLineFacadeInterface * myLineFacade
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
DtBaseConnection & mySimulation
DtStateListener & myListener
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
DtStateVisualizer * myParent
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

DtEnvironmentalLineVisualizer display a line that contains at least two points.

Constructor & Destructor Documentation

makVrv::DtEnvironmentalLineVisualizer::DtEnvironmentalLineVisualizer ( DtBaseConnection &  simulation,
DtStateListener &  listener,
int  modelSet 
)

Constructor.

virtual makVrv::DtEnvironmentalLineVisualizer::~DtEnvironmentalLineVisualizer ( )
virtual

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::useDefaultColor ( )
virtual

Sets color to default color.

virtual void makVrv::DtEnvironmentalLineVisualizer::getColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const
virtual

Returns the color.

virtual void makVrv::DtEnvironmentalLineVisualizer::addPoint ( int  index,
const DtVector &   
)
virtual

Adds a point to the line.

If index is -1, appends else places at given point

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

virtual void makVrv::DtEnvironmentalLineVisualizer::removePoint ( int  index)
virtual

Removes point at the given index.

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

Modifies the point at the given index.

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

virtual void makVrv::DtEnvironmentalLineVisualizer::setPoints ( const DtEnvironmentalStateListener::ControlPointsList &  )
virtual

Sets the control points to the specified list, adding, removing and changing as needed.

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

virtual void makVrv::DtEnvironmentalLineVisualizer::setSelected ( bool  b)
virtual

Selects the entire line.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::resetSpatial ( )
virtual

Resets geometry of line.

virtual void makVrv::DtEnvironmentalLineVisualizer::createModelAgents ( )
virtual

Creates the model agents associated with the line.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::setStipplePattern ( unsigned  short)
virtual

Sets the stipple pattern style.

virtual unsigned short makVrv::DtEnvironmentalLineVisualizer::lineStipple ( ) const
virtual

Returns the currently set stipple pattern.

virtual void makVrv::DtEnvironmentalLineVisualizer::setPenStyle ( vrvTacticalGraphicUtilities::PenStyle  )
virtual

Takes the pen style and translates it to a stipple pattern.

See vrvTacticalGraphicUtilities for styles

virtual void makVrv::DtEnvironmentalLineVisualizer::setLineStyle ( vrvTacticalGraphicUtilities::LineStyle  )
virtual

Sets the style of the line. See DtLineFacadeInterface.h for styles.

virtual void makVrv::DtEnvironmentalLineVisualizer::setLineWidth ( int  )
virtual

Sets the line width.

If 0, uses the default as defined in the visual definition

virtual void makVrv::DtEnvironmentalLineVisualizer::setOrigin ( const DtVector &  )
virtual

Sets the origin of the line.

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

virtual const DtVector& makVrv::DtEnvironmentalLineVisualizer::origin ( ) const
virtual

Get the origin of the line.

virtual void makVrv::DtEnvironmentalLineVisualizer::setArrowHeadPlacement ( vrvTacticalGraphicUtilities::ArrowHeadPlacement  )
virtual

Sets how often the arrows should be displayed.

See Also
makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement
virtual vrvTacticalGraphicUtilities::ArrowHeadPlacement makVrv::DtEnvironmentalLineVisualizer::arrowHeadPlacement ( ) const
virtual

Returns the current arrow head placement strategy.

virtual void makVrv::DtEnvironmentalLineVisualizer::setArrowStyle ( vrvTacticalGraphicUtilities::ArrowStyle  )
virtual

Sets the style of arrows for the line.

virtual vrvTacticalGraphicUtilities::ArrowStyle makVrv::DtEnvironmentalLineVisualizer::arrowStyle ( ) const
virtual

Returns the arrow style.

virtual void makVrv::DtEnvironmentalLineVisualizer::setArrowSize ( double  )
virtual

Sets the size of the arrow. In 3D this is meters, in 2D this is pixels.

virtual double makVrv::DtEnvironmentalLineVisualizer::arrowSize ( ) const
virtual

Returns the size of the awwow.

virtual void makVrv::DtEnvironmentalLineVisualizer::setFixedWidthSizing ( bool  )
virtual

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).

Default is fixed width. If changing modes, be sure to change the arrow size

virtual bool makVrv::DtEnvironmentalLineVisualizer::fixedWidthSizing ( ) const
virtual

Returns whether or not this line will be sized with fixed width sizing.

virtual void makVrv::DtEnvironmentalLineVisualizer::destroyModelAgents ( )
protectedvirtual

Destroys any model agents currently created.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::setModelDefinitionForAgents ( )
protectedvirtual

Sets model definitions for agents.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual DtLineFacadeInterface* makVrv::DtEnvironmentalLineVisualizer::createLineFacade ( )
protectedpure virtual

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

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

virtual void makVrv::DtEnvironmentalLineVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition &  visDef)
protectedvirtual

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

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt2DAirCorridorLineVisualizer, and makVrv::Dt3DAirCorridorLineVisualizer.

virtual DtVector makVrv::DtEnvironmentalLineVisualizer::offsetAtPosition ( const DtVector &  origin) const
protectedvirtual

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, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalLineVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DAirCorridorLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DAirCorridorLineVisualizer.

virtual void makVrv::DtEnvironmentalLineVisualizer::setSolid ( bool  )
protectedvirtual

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

virtual void makVrv::DtEnvironmentalLineVisualizer::setupLine ( )
protectedvirtual

Sets the line facade up with default data.

Reimplemented in makVrv::Dt2DAirCorridorLineVisualizer, and makVrv::Dt3DAirCorridorLineVisualizer.

Member Data Documentation

DtTacticalGraphicStateListener& makVrv::DtEnvironmentalLineVisualizer::myLineListener
protected
DtLineFacadeInterface* makVrv::DtEnvironmentalLineVisualizer::myLineFacade
protected
DtEnvironmentalStateListener::ControlPointsList makVrv::DtEnvironmentalLineVisualizer::myControlPoints
protected
int makVrv::DtEnvironmentalLineVisualizer::myLineWidth
protected
DtVector makVrv::DtEnvironmentalLineVisualizer::myPointOffset
protected
bool makVrv::DtEnvironmentalLineVisualizer::myOriginSet
protected
DtVector makVrv::DtEnvironmentalLineVisualizer::myOrigin
protected
int makVrv::DtEnvironmentalLineVisualizer::myDefaultLineWidth
protected
float makVrv::DtEnvironmentalLineVisualizer::myDefaultColor[4]
protected
float makVrv::DtEnvironmentalLineVisualizer::myColor[4]
protected
vrvTacticalGraphicUtilities::ArrowStyle makVrv::DtEnvironmentalLineVisualizer::myArrowStyle
protected
vrvTacticalGraphicUtilities::ArrowHeadPlacement makVrv::DtEnvironmentalLineVisualizer::myArrowHeadPlacement
protected
vrvTacticalGraphicUtilities::LineStyle makVrv::DtEnvironmentalLineVisualizer::myLineStyle
protected
double makVrv::DtEnvironmentalLineVisualizer::myArrowSize
protected
unsigned short makVrv::DtEnvironmentalLineVisualizer::myLineStipple
protected
bool makVrv::DtEnvironmentalLineVisualizer::myFixedWidthSizing
protected
bool makVrv::DtEnvironmentalLineVisualizer::myScribed
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)