VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
makVrv::DtOsgRibbonModel Class Reference
vrvOsg

A model of a ribbon.

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

Public Member Functions

 DtOsgRibbonModel (DtDe &de, DtUniqueID id)
 
virtual ~DtOsgRibbonModel ()
 
virtual void setModelDefinition (const std::string &str)
 
virtual void setModelInstance (DtModelInstance *modelInstance)
 
virtual const std::string & className () const
 
virtual void setOrientation (int vtx, const DtTaitBryan &ori)
 
virtual void setPosition (int vtx, const DtVector &pos)
 
virtual void addToScene (const DtUniqueID &id, DtModelSetId modelSet, int visualizerType)
 
virtual void removeFromScene ()
 
virtual void setOcclusionEnabled (bool enabled)
 
virtual void setHeightLinesEnabled (bool enabled) override
 
virtual void setHeightLinesColor (float r, float g, float b, float a) override
 
virtual void setHeightLinesSpacing (float spacing) override
 
virtual void setRibbonSpacing (float sampleSpacing)
 
virtual void setRibbonLength (int maxSamples)
 
virtual void setRibbonTimeout (float duration)
 
virtual void setColor (float r, float g, float b, float a)
 
virtual void initializeModelInstance ()
 
virtual void setVisible (bool isVisible)
 
virtual void setIsSupportModel (bool isSupport)
 
virtual void update ()
 
- Public Member Functions inherited from makVrv::DtRibbonModel
 DtRibbonModel (DtDe &de, DtUniqueID id)
 
virtual ~DtRibbonModel ()
 
- Public Member Functions inherited from makVrv::DtModel
 DtModel (DtDe &de, DtUniqueID id)
 
virtual ~DtModel ()
 
DtModelInstance * createModelInstance (const std::string &modelDefName, bool realize=true)
 
virtual const std::string & modelDefinitionName ()
 
virtual void saveModelToFile (const std::string &filename)
 
virtual DtUniqueID uniqueId () const
 
unsigned int transformSize () const
 
virtual const DtVector & position (int vtx=0) const
 
virtual void removePosition (int vtx)
 
virtual void setPositionOffset (const DtVector &positionOffset)
 
virtual const DtVector & positionOffset () const
 
virtual void setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
 
virtual const DtTaitBryan & orientation (int vtx=0) const
 
virtual void setOrientationOffset (const DtTaitBryan &orientationOffset)
 
virtual const DtTaitBryan & orientationOffset () const
 
virtual void enableColorBlending (bool b)
 
virtual void setBlendColor (float r, float g, float b, float a)
 
virtual void getBlendColor (float &r, float &g, float &b, float &a)
 
virtual bool colorBlendingEnabled () const
 
virtual void enableLighting (bool l)
 
virtual DtModelSetId modelSet () const
 
const DtVector & boundingBoxExtents () const
 
void getBoundingBoxExtents (double &x, double &y, double &z) const
 
const DtVector & boundingBoxCenter () const
 
virtual void getBoundingBoxCenter (double &x, double &y, double &z) const
 
virtual void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 
void setContributesToBound (bool trueOrFalse)
 
bool contributesToBound () const
 
DtDe & de ()
 
virtual void promoteBackgroundModelInstance (const DtModelDefinition &defintion)
 
virtual bool visible () const
 
DtUniqueID sceneObjectId () const
 
virtual void addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
 
virtual void addedToSceneObject (const DtUniqueID &sceneObj, DtModelSetId modelSet, int visualizerType)
 
virtual void setElementId (DtElementID id)
 
virtual void removedFromSceneObject ()
 
virtual void setSolid (bool isSolid)
 
virtual bool isProp ()
 
virtual void updateMinLastFrameDistance (float distance)
 
virtual void resetLastFrameDistance ()
 
virtual float minLastFrameDistance () const
 
virtual DtModelInstance * modelInstance ()
 
virtual const DtModelInstance * modelInstance () const
 
int visualizerType () const
 
virtual bool supportsMultithreadedLoad ()
 
virtual void backgroundLoad ()
 
virtual void foregroundLoad ()
 
virtual bool isActivelyBackgroundLoading ()
 
virtual DtLoaderHandle * getLoadQueueHandle ()
 

Protected Attributes

DtOsgSceneConnector * mySceneConnector
 
DtRibbonModelInstance * myRibbonModelCast
 
bool myOcclusionEnabled
 
bool myHeightLinesEnabled
 
float myHeightLinesColor [4]
 
float myHeightLinesSpacing
 
float myRibbonSpacing
 
int myRibbonLength
 
float myRibbonTimeout
 
bool myColorSet
 
osg::Vec4 myColor
 
- Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle * myInLoadQueueHandle
 
DtDe & myDe
 
const DtUniqueID myUniqueId
 
DtUniqueID myElementId
 
DtUniqueID myParentSceneObjectID
 
bool myColorBlendingEnabled
 
DtModelInstance * myBackgroundModelInstance
 
float myMinLastFrameDistance
 
TransformList myTransforms
 
DtModelInstance * myModelInstance
 
DtModelSetId myModelSet
 
int myVisualizerType
 
bool myContributesToBound
 
bool myIsPropFlag
 
float myBlendColor [4]
 
bool myVisibleFlag
 
DtVector myPositionOffset
 
DtTaitBryan myOrientationOffset
 
std::string myModelDefinitionName
 
bool myRequireModelInstance = true
 

Private Member Functions

 DtOsgRibbonModel ()
 
 DtOsgRibbonModel (const DtOsgRibbonModel &)
 
DtOsgRibbonModel & operator= (const DtOsgRibbonModel &)
 

Additional Inherited Members

- Public Attributes inherited from makVrv::DtModel
boost::signalslib::signal
< void(DtModel *)> 		signal_modelToBeDestroyed
 
boost::signalslib::signal
< void(DtModel *)> 		signal_modelChanged
 
boost::signalslib::signal
< bool(DtModel *, bool),
SlotReturnOR > 		signal_visibilityChangeRequested
 
boost::signalslib::signal
< void(DtModelInstance
*, DtModel *)> 		signal_modelInstanceCreated
 
boost::signalslib::signal
< void(DtModelInstance
*, DtModel *)> 		signal_modelInstanceToBeDestroyed
 
- Protected Types inherited from makVrv::DtModel
typedef std::vector
< ObjectTransform > 		TransformList
 
- Protected Member Functions inherited from makVrv::DtModel
virtual void addToSceneAsProp (const DtUniqueID &sceneObjectId)
 
void slot_modelInstanceChanged (DtModelInstance *instance)
 
virtual void waitAndClearLoadHandle ()
 
virtual void removedFromLoadQueue ()
 
virtual void setDoneBackgroundLoading ()
 
virtual void setActivelyBackgroundLoading ()
 
- Static Protected Attributes inherited from makVrv::DtModel
static bool theInittedState
 

Constructor & Destructor Documentation

makVrv::DtOsgRibbonModel::DtOsgRibbonModel ( DtDe &  de,
DtUniqueID  id 
)

CTOR.

virtual makVrv::DtOsgRibbonModel::~DtOsgRibbonModel ( )
virtual

DTOR.

makVrv::DtOsgRibbonModel::DtOsgRibbonModel ( )
private

unimplemented private default constructor

makVrv::DtOsgRibbonModel::DtOsgRibbonModel ( const DtOsgRibbonModel &  )
private

Copy Constructor not implemented – Copy not allowed.

Member Function Documentation

DtOsgRibbonModel& makVrv::DtOsgRibbonModel::operator= ( const DtOsgRibbonModel &  )
private

Assignment Operator not implemented – Copy not allowed.

virtual void makVrv::DtOsgRibbonModel::setModelDefinition ( const std::string &  str)
virtual

Override the default model definition function.

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setModelInstance ( DtModelInstance *  modelInstance)
virtual

Override to provide casted pointer.

Reimplemented from makVrv::DtModel.

virtual const std::string& makVrv::DtOsgRibbonModel::className ( ) const
virtual

Get the class name of the model instance owner. This is used to control how model instances are created.

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setOrientation ( int  vtx,
const DtTaitBryan &  ori 
)
virtual

Set the orientation of the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgRibbonModel::setPosition ( int  vtx,
const DtVector &  pos 
)
virtual

Set the position of the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgRibbonModel::addToScene ( const DtUniqueID &  id,
DtModelSetId  modelSet,
int  visualizerType 
)
virtual

Add the animation to the scene, as part of the scene object with the specified unique ID.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgRibbonModel::removeFromScene ( )
virtual

Remove the animation from the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgRibbonModel::setOcclusionEnabled ( bool  enabled)
virtual

Enable or disable occlusion of the ribbon by other objects in the scene.

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setHeightLinesEnabled ( bool  enabled)
overridevirtual

Enable or disable height lines applied along the ribbon segments.

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setHeightLinesColor ( float  r,
float  g,
float  b,
float  a 
)
overridevirtual

Sets the color for height lines applied along the ribbon segments.

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setHeightLinesSpacing ( float  spacing)
overridevirtual

Sets the desired spacing for height lines applied along ribbon segments.

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setRibbonSpacing ( float  sampleSpacing)
virtual

Sets the spacing between sample points along the ribbon (in meters).

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setRibbonLength ( int  maxSamples)
virtual

Sets the maximum length of the ribbon (in samples). If the given value (max number of samples in the ribbon), is negative or zero, the ribbon is unbounded and can be infinitely (or at least maximally) long.

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setRibbonTimeout ( float  duration)
virtual

Sets the timeout of a ribbon segment (in seconds). If the given value, is negative or zero, the ribbon is unbounded and will not timeout.

Implements makVrv::DtRibbonModel.

virtual void makVrv::DtOsgRibbonModel::setColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Sets the color of the ribbon.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgRibbonModel::initializeModelInstance ( )
virtual

Initializes the ribbon model instance with the current settings. Applies the ribbon length, spacing, and color to the model instance.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgRibbonModel::setVisible ( bool  isVisible)
virtual

Override to call setVisible on the scene connector.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgRibbonModel::setIsSupportModel ( bool  isSupport)
virtual

Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)

Implements makVrv::DtModel.

virtual void makVrv::DtOsgRibbonModel::update ( )
virtual

Update the position of the ribbon.

Implements makVrv::DtRibbonModel.

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsgRibbonModel::mySceneConnector
protected
DtRibbonModelInstance* makVrv::DtOsgRibbonModel::myRibbonModelCast
protected
bool makVrv::DtOsgRibbonModel::myOcclusionEnabled
protected
bool makVrv::DtOsgRibbonModel::myHeightLinesEnabled
protected
float makVrv::DtOsgRibbonModel::myHeightLinesColor[4]
protected
float makVrv::DtOsgRibbonModel::myHeightLinesSpacing
protected
float makVrv::DtOsgRibbonModel::myRibbonSpacing
protected
int makVrv::DtOsgRibbonModel::myRibbonLength
protected
float makVrv::DtOsgRibbonModel::myRibbonTimeout
protected
bool makVrv::DtOsgRibbonModel::myColorSet
protected
osg::Vec4 makVrv::DtOsgRibbonModel::myColor
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)