VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtSegmentedLineModel Class Reference

This class is a virtual class that all segmented line models must implement. More...

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

Public Member Functions

 DtSegmentedLineModel (DtDe &de, DtUniqueID id)
 Constructor.
virtual ~DtSegmentedLineModel ()
 Destructor.
virtual void setStyleSegments (const std::vector< double > &segmentPercentages)=0
 Set the style segments to percentages of the total line length The values in segmentPercentages must add up to 1.0.
virtual void setSegmentColor (unsigned int segmentIndex, float r, float g, float b, float a)=0
 Set the color of a particular segment.
virtual void setSegmentLightningStyle (unsigned int segmentIndex, bool enableLightningStyle)=0
 Turn on or off lightning bolt style for a particular segment.
virtual void setSegmentStartArrow (unsigned int segmentIndex, bool enableArrow)=0
 Turn on or off the arrow at a segment's start point.
virtual void setSegmentEndArrow (unsigned int segmentIndex, bool enableArrow)=0
 Turn on or off the arrow at a segment's end point.
virtual void setSegmentStipplePattern (unsigned int segmentIndex, unsigned int stipplePattern, int repeatFactor=1)=0
 Set the line stipple pattern for a segment, according to the OpenGL line stippling specification.
virtual void setSegmentWidth (unsigned int segmentIndex, double width)=0
 Set the width of a line segment.
virtual void setSegmentStartColor (unsigned int segmentIndex, float r, float g, float b, float a)=0
 Set the color of the firt vertex in a segment.
virtual void setSegmentEndColor (unsigned int segmentIndex, float r, float g, float b, float a)=0
 Set the color of the end vertex in a segment.
virtual void setArrowSize (double)=0
 Sets the size of the arrow (in pixels)
virtual void setArrowStyle (int)=0
 Sets the style of the arrow. Applies to all segments.
- Public Member Functions inherited from makVrv::DtLineModel
 DtLineModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtLineModel ()
 DTOR.
virtual void setColor (float r, float g, float b, float a)=0
 Set the color of the line.
virtual void setWidth (float width)=0
 Set the width of the line.
virtual void setStipplePattern (unsigned int pattern, int repeatFactor=1)=0
 Set a stipple pattern for the line.
virtual const std::vector
< DtVector > & 
points () const =0
 Returns the vertices (local database coordinates) that are used to draw this linear object.
- Public Member Functions inherited from makVrv::DtModel
 DtModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtModel ()
 DTOR.
virtual void setModelDefinition (const std::string &str)
 Set the model definition.
virtual void saveModelToFile (const std::string &filename)
virtual std::string className () const
 Get the class name of the model instance owner.
unsigned int transformSize () const
 Get the number of position/orientations this model has.
virtual void setPosition (int vtx, const DtVector &position)
 Set the position of a control vertex in the model.
virtual void removePosition (int vtx)
 Remove a transform at the given position.
const DtVectorposition (int vtx=0) const
 Get the Position of a given point.
const DtTaitBryan & orientation (int vtx=0) const
 Get the Orientation of a given point.
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Set the orientation of a vertex in the model.
virtual void enableColorBlending (bool b)
 Enable / disable color blending for this model.
virtual void setBlendColor (float r, float g, float b, float a)
 Set color to use if color blending is enabled.
virtual void getBlendColor (float &r, float &g, float &b, float &a)
 Returns the blend color.
virtual bool colorBlendingEnabled () const
 Returns whether or not blending is enabled.
virtual void enableLighting (bool l)
 set whether the model is lit; this may not be an option on all models
virtual int modelSet () const
 Get the model set this model is part of.
const DtVectorboundingBoxExtents () const
 Get the bounding box extents of the model instance.
void getBoundingBoxExtents (double &x, double &y, double &z) const
 Get the bounding box extents of the model instance.
const DtVectorboundingBoxCenter () const
 Get the bounding box center of the model instance.
virtual void getBoundingBoxCenter (double &x, double &y, double &z) const
 Get the bounding box center of the model instance.
virtual void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 Get the minimum and maximum X,Y,Z components of the bounding box.
void setContributesToBound (bool trueOrFalse)
 Set whether this model instance contributes to an object's overall bounding volume.
bool contributesToBound () const
 Get whether this model instance contributes to an object's overall bounding volume.
DtDede ()
 Get the DtDe object.
virtual void setModelInstance (DtModelInstance *modelInstance)
 Internally set the model instance pointer.
virtual void setVisible (bool isVisible)
 Set the visible state of the model.
virtual bool visible () const
 Get the visible state of the model.
DtUniqueID parentSceneObjectID () const
 Parent of the model.
virtual void addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
 Called when a scene object added the model as a prop.
virtual void addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)
 Called when a scene object added the model with the given model set and visualizer type.
virtual void setElementId (DtUniqueID id)
 Called when the element ID of the model's parent object is set.
virtual void removedFromSceneObject ()
 Called when the model was removed from a scene object.
virtual void setIsSupportModel (bool isSupport)=0
 Is this model part of the support group? (determines whether or not other scene objects can ground clamp to this model)
virtual void setSolid (bool isSolid)
 Set whether or not other this model is drawn filled in.
virtual bool isProp ()
 Return whether or not this model was added as a prop.
virtual DtModelInstancemodelInstance ()
 Get the model instance.
virtual const DtModelInstancemodelInstance () const
int visualizerType () const
 The visualizer type determines which channel-specific group node this model will be parented to, and consequently, which observer setting will cause it to be rendered in which channel.

Additional Inherited Members

- Public Attributes inherited from makVrv::DtModel
boost::signal< void(DtModel *)> signal_modelToBeDestroyed
 Signal emitted when the model is to be destroyed.
boost::signal< void(DtModel *)> signal_modelChanged
boost::signal< bool(DtModel
*, bool), SlotReturnOR
signal_visibilityChangeRequested
 Signal when the visibility has been requested, if any slot returns false, it will not change.
boost::signal< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceCreated
 Signal emitted when the model instance is created.
boost::signal< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceToBeDestroyed
 Signal emitted when the model instance is to be destroyed.
- Protected Types inherited from makVrv::DtModel
typedef std::vector
< ObjectTransform
TransformList
- Protected Member Functions inherited from makVrv::DtModel
virtual void addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)=0
 Virtual Functions to be implemented, add this model to the scene.
virtual void addToSceneAsProp (const DtUniqueID &sceneObjectId)
 Add this model to the scene as a prop.
virtual void removeFromScene ()=0
 Virtual Functions to be implemented, remove this model from the scene.
virtual void initializeModelInstance ()
 Push any state maintained by the model to the model instance.
void slot_modelInstanceChanged (DtModelInstance *instance)
 Called when the model instance changed.
- Protected Attributes inherited from makVrv::DtModel
DtDemyDe
const DtUniqueID myUniqueId
bool myColorBlendingEnabled

Detailed Description

This class is a virtual class that all segmented line models must implement.

Constructor & Destructor Documentation

makVrv::DtSegmentedLineModel::DtSegmentedLineModel ( DtDe de,
DtUniqueID  id 
)

Constructor.

virtual makVrv::DtSegmentedLineModel::~DtSegmentedLineModel ( )
virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtSegmentedLineModel::setStyleSegments ( const std::vector< double > &  segmentPercentages)
pure virtual

Set the style segments to percentages of the total line length The values in segmentPercentages must add up to 1.0.

Implemented in makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgOverlayGreatCircleArcModel, makVrv::DtOsgOverlaySegmentedLineModel, and makVrv::DtOsg3DGreatCircleArcModel.

virtual void makVrv::DtSegmentedLineModel::setSegmentColor ( unsigned int  segmentIndex,
float  r,
float  g,
float  b,
float  a 
)
pure virtual
virtual void makVrv::DtSegmentedLineModel::setSegmentLightningStyle ( unsigned int  segmentIndex,
bool  enableLightningStyle 
)
pure virtual

Turn on or off lightning bolt style for a particular segment.

Lightning style is not currently supported for overlay forms of segmented lines or great circle arc forms

Implemented in makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgOverlaySegmentedLineModel, and makVrv::DtOsg3DGreatCircleArcModel.

virtual void makVrv::DtSegmentedLineModel::setSegmentStartArrow ( unsigned int  segmentIndex,
bool  enableArrow 
)
pure virtual

Turn on or off the arrow at a segment's start point.

Implemented in makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgOverlaySegmentedLineModel, and makVrv::DtOsg3DGreatCircleArcModel.

virtual void makVrv::DtSegmentedLineModel::setSegmentEndArrow ( unsigned int  segmentIndex,
bool  enableArrow 
)
pure virtual

Turn on or off the arrow at a segment's end point.

Start and end point are equivalent to simply turning on an arrow at the end point of the specified segment

Implemented in makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsgOverlaySegmentedLineModel, and makVrv::DtOsg3DGreatCircleArcModel.

virtual void makVrv::DtSegmentedLineModel::setSegmentStipplePattern ( unsigned int  segmentIndex,
unsigned int  stipplePattern,
int  repeatFactor = 1 
)
pure virtual

Set the line stipple pattern for a segment, according to the OpenGL line stippling specification.

Repeat factor is not supported for overlay forms of segmented lines.

Implemented in makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsg3DGreatCircleArcModel, makVrv::DtOsgOverlaySegmentedLineModel, and makVrv::DtOsgOverlayGreatCircleArcModel.

virtual void makVrv::DtSegmentedLineModel::setSegmentWidth ( unsigned int  segmentIndex,
double  width 
)
pure virtual
virtual void makVrv::DtSegmentedLineModel::setSegmentStartColor ( unsigned int  segmentIndex,
float  r,
float  g,
float  b,
float  a 
)
pure virtual

Set the color of the firt vertex in a segment.

This can be used for color blending between vertices.

Implemented in makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsg3DGreatCircleArcModel, and makVrv::DtOsgOverlayGreatCircleArcModel.

virtual void makVrv::DtSegmentedLineModel::setSegmentEndColor ( unsigned int  segmentIndex,
float  r,
float  g,
float  b,
float  a 
)
pure virtual

Set the color of the end vertex in a segment.

This can be used for color blending between vertices.

Implemented in makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsg3DSegmentedLineModel, makVrv::DtOsg3DGreatCircleArcModel, and makVrv::DtOsgOverlayGreatCircleArcModel.

virtual void makVrv::DtSegmentedLineModel::setArrowSize ( double  )
pure virtual
virtual void makVrv::DtSegmentedLineModel::setArrowStyle ( int  )
pure virtual

Sets the style of the arrow. Applies to all segments.

Implemented in makVrv::DtOsgOverlaySegmentedLineModel, makVrv::DtOsg3DGreatCircleArcModel, and makVrv::DtOsg3DSegmentedLineModel.


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

Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)