VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtEnvironmentalLineVisualizer Class Referenceabstract

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. More...
 
virtual ~DtEnvironmentalLineVisualizer ()
 Destructor. More...
 
virtual void setColor (float r, float g, float b, float a)
 Sets the color for the line. More...
 
virtual void useDefaultColor ()
 Sets color to default color as defined in the visualizer definition. More...
 
virtual void getColor (float &r, float &g, float &b, float &a) const
 Returns the color. More...
 
virtual void addPoint (int index, const DtVector &)
 Adds a point to the line. More...
 
virtual void removePoint (int index)
 Removes point at the given index. More...
 
virtual void modifyPoint (int index, const DtVector &)
 Modifies the point at the given index. More...
 
virtual void setPoints (const DtEnvironmentalStateListener::ControlPointsList &)
 Sets the control points to the specified list, adding, removing and changing as needed. More...
 
virtual void setSelected (bool b)
 Selects the entire line. More...
 
virtual void resetSpatial ()
 Resets geometry of line. More...
 
virtual void createModelAgents ()
 Creates the model agents associated with the line. More...
 
virtual void setStipplePattern (unsigned short)
 Sets the stipple pattern style. More...
 
virtual unsigned short lineStipple () const
 Returns the currently set stipple pattern. More...
 
virtual void setPenStyle (vrvTacticalGraphicUtilities::PenStyle)
 Takes the pen style and translates it to a stipple pattern. More...
 
virtual void setLineStyle (vrvTacticalGraphicUtilities::LineStyle)
 Sets the style of the line. See DtLineFacadeBase.h for styles. More...
 
virtual void setPixelLineWidth (int)
 Sets the width of the outside line. More...
 
virtual void setOrigin (const DtVector &)
 Sets the origin of the line. More...
 
virtual const DtVectororigin () const
 Get the origin of the line. More...
 
virtual void setArrowHeadPlacement (vrvTacticalGraphicUtilities::ArrowHeadPlacement)
 Sets how often the arrows should be displayed. More...
 
virtual
vrvTacticalGraphicUtilities::ArrowHeadPlacement 
arrowHeadPlacement () const
 Returns the current arrow head placement strategy. More...
 
virtual void setArrowStyle (vrvTacticalGraphicUtilities::ArrowStyle)
 Sets the style of arrows for the line. More...
 
virtual
vrvTacticalGraphicUtilities::ArrowStyle 
arrowStyle () const
 Returns the arrow style. More...
 
virtual void setArrowSize (double)
 Sets the size of the arrow. In 3D this is meters, in 2D this is pixels. More...
 
virtual double arrowSize () const
 Returns the size of the awwow. More...
 
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). More...
 
virtual bool fixedWidthSizing () const
 Returns whether or not this line will be sized with fixed width sizing. More...
 
virtual void setScribed (bool)
 Sets whether or not the line is scribed. More...
 
virtual void startAttached ()
 Starts the process of attachment by creating updater for attachment. More...
 
virtual void endAttached ()
 Ends the attachment process. More...
 
DtLineFacadeBaselineFacade () const
 Line facade used by this class. More...
 
virtual void setAttached (DtUniqueID)
 Sets this object to be attached to the specified object. More...
 
virtual void setPickable (bool)
 Whether or not the line can be pickable. More...
 
virtual void setRelativeLocation (const DtVector &)
 
virtual void setOffsetPoints (const std::vector< DtVector > &)
 These are the relative offsets from the origin of this object that the point of this object represent. More...
 
- 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;. More...
 
virtual DtSceneObjectAgent * sceneObjectAgent ()
 
virtual void setParent (DtStateVisualizer *p)
 Override of base class setParent to simply set the parent without destroying/recreating model agents. More...
 
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) More...
 
virtual bool hide (int)
 Will call destroyModelAgents(), if, when the context is added, it is the first context in the list. More...
 
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR. More...
 
virtual ~DtStateVisualizer ()
 DTOR. More...
 
virtual DtObserverMode::ModelSets modelSet ()
 Return the visualizer's model set enum. More...
 
virtual const TypeInfotypeInfo () const =0
 Get the type info. More...
 
virtual const DtStateVisualizerparent () const
 Get a const pointer to the parent visualizer of this visualizer. More...
 
void setModelDefinition (const std::string &definition)
 Sets the model definition and creates agent(s) based on that definition. More...
 
const std::string & modelDefinition () const
 Gets the current model definition. More...
 
virtual void implementVisibility (bool visible)
 Wrap some of the show/hide functionality so that it can be overloaded (ex. More...
 
virtual bool setVisible (bool visible, int context)
 Returns true if this context wants to show or hide the item. More...
 
virtual void initialize ()
 Initialize the visualizer. More...
 
virtual bool isVisible () const
 Returns true if visible. More...
 
virtual void setHasMouseCursor (bool)
 Sets the mouse hover state. More...
 
virtual bool hasMouseCursor () const
 
virtual bool selected () const
 
void setName (const std::string &)
 Internal name of state visualizer. More...
 
const std::string & name () const
 
virtual bool pickable () const
 
virtual void setUniqueID (DtUniqueID id)
 
DtUniqueID uniqueID () const
 
int visualizerType () const
 
void setShowHideContext (const std::vector< int > &s)
 Set show/hide context without changing visibility of item. More...
 
DtStateListenerlistener ()
 
DtBaseConnectionsimulation ()
 Get the connection for this visualizer. More...
 
void setDistribute (bool b)
 Whether or not to distribute over the network. More...
 
bool distribute () const
 

Protected Member Functions

virtual void destroyModelAgents ()
 Destroys any model agents currently created. More...
 
virtual void setModelDefinitionForAgents ()
 Sets model definitions for agents. More...
 
virtual DtLineFacadeBasecreateLineFacade ()=0
 Used by subclasses to create the line agent used to display the line. More...
 
virtual void setVisualizerDefinition (const DtVisualizerDefinition &visDef)
 Set the visualizer definition that defines the parameters of this visualizer. More...
 
virtual DtVector offsetAtPosition (const DtVector &origin) const
 Given the origin and the point offset, return an offset that is valid at the given position. More...
 
virtual void setSolid (bool)
 Set whether the object created by this visualizer can be ground- clamped to. More...
 
virtual void setupLine ()
 Sets the line facade up with default data. More...
 
- 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. More...
 
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. More...
 
template<typename T , typename C >
void connectAndUpdate (boost::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)
 Connect a signal and update the entity. More...
 

Protected Attributes

DtTacticalGraphicStateListenermyLineListener
 
DtLineFacadeBasemyLineFacade
 
DtEnvironmentalStateListener::ControlPointsList myControlPoints
 
int myPixelLineWidth
 
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
 
bool myAttachedFlag
 
DtUniqueID myAttachedToId
 
DtMultiPointEmbarkationUpdaterAgent * myAttachedUpdaterAgent
 
DtVector myRelativeLocation
 
- 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< intmyShowHideContexts
 
bool mySelected
 
bool myHasMouseCursor
 
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::signalslib::signal
< void(DtStateVisualizer
*, DtStateVisualizer
*, DtStateVisualizer *)> 
signal_reparented
 Signaled when the parent of this item changes, called before destroying any model agents. More...
 
boost::signalslib::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. More...
 
boost::signalslib::signal
< void(DtMouseState &, const
DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseUp
 
boost::signalslib::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 as defined in the visualizer definition.

Called when color set is 0, 0, 0, 0

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
virtual void makVrv::DtEnvironmentalLineVisualizer::removePoint ( int  index)
virtual

Removes point at the given index.

virtual void makVrv::DtEnvironmentalLineVisualizer::modifyPoint ( int  index,
const DtVector  
)
virtual
virtual void makVrv::DtEnvironmentalLineVisualizer::setPoints ( const DtEnvironmentalStateListener::ControlPointsList )
virtual
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 DtLineFacadeBase.h for styles.

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

Sets the width of the outside line.

Default is 2. The pixel line width is the line in osg pixel space. This is different than physicalLineWidth which sets the width of the line in datasbe space. If value is 0 will use default pixel line width

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

Sets whether or not the line is scribed.

virtual void makVrv::DtEnvironmentalLineVisualizer::setRelativeLocation ( const DtVector )
virtual

If attached, these will represent the offset from the origin of the entity this object is, such that when the host entity moves this object's origin will move relative to that entity by the offset amount

virtual void makVrv::DtEnvironmentalLineVisualizer::setOffsetPoints ( const std::vector< DtVector > &  )
virtual

These are the relative offsets from the origin of this object that the point of this object represent.

This means that when the object moves because the host object moves, all the points on this object will be reset from the new origin of this entity by the offset points

virtual void makVrv::DtEnvironmentalLineVisualizer::startAttached ( )
virtual

Starts the process of attachment by creating updater for attachment.

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

virtual void makVrv::DtEnvironmentalLineVisualizer::endAttached ( )
virtual

Ends the attachment process.

DtLineFacadeBase* makVrv::DtEnvironmentalLineVisualizer::lineFacade ( ) const

Line facade used by this class.

virtual void makVrv::DtEnvironmentalLineVisualizer::setAttached ( DtUniqueID  )
virtual

Sets this object to be attached to the specified object.

Once attached this object will move its origin offset from the relative location

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

Whether or not the line can be pickable.

Reimplemented from makVrv::DtStateVisualizer.

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 DtLineFacadeBase* makVrv::DtEnvironmentalLineVisualizer::createLineFacade ( )
protectedpure virtual
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::Dt3DEnvironmentalLineVisualizer, makVrv::Dt2DAirCorridorLineVisualizer, and makVrv::Dt3DAirCorridorLineVisualizer.

virtual DtVector makVrv::DtEnvironmentalLineVisualizer::offsetAtPosition ( const DtVector origin) const
protectedvirtual
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

Member Data Documentation

DtTacticalGraphicStateListener& makVrv::DtEnvironmentalLineVisualizer::myLineListener
protected
DtLineFacadeBase* makVrv::DtEnvironmentalLineVisualizer::myLineFacade
protected
DtEnvironmentalStateListener::ControlPointsList makVrv::DtEnvironmentalLineVisualizer::myControlPoints
protected
int makVrv::DtEnvironmentalLineVisualizer::myPixelLineWidth
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
bool makVrv::DtEnvironmentalLineVisualizer::myAttachedFlag
protected
DtUniqueID makVrv::DtEnvironmentalLineVisualizer::myAttachedToId
protected
DtMultiPointEmbarkationUpdaterAgent* makVrv::DtEnvironmentalLineVisualizer::myAttachedUpdaterAgent
protected
DtVector makVrv::DtEnvironmentalLineVisualizer::myRelativeLocation
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)