VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
makVrv::DtOsgRibbonModel Class Reference

A model of a ribbon. More...

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

List of all members.

Public Member Functions

 DtOsgRibbonModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtOsgRibbonModel ()
 DTOR.
virtual void setModelDefinition (const std::string &str)
 Override the default model definition function.
virtual void setModelInstance (DtModelInstance *modelInstance)
 Override to provide casted pointer.
virtual std::string className () const
 Get the class name of the model instance owner.
virtual void setOrientation (int vtx, const DtTaitBryan &ori)
 Set the orientation of the model.
virtual void setPosition (int vtx, const DtVector &pos)
 Set the position of the model.
virtual void addToScene (const DtUniqueID &id, int modelSet, int visualizerType)
 Add the animation to the scene, as part of the scene object with the specified unique ID.
virtual void removeFromScene ()
 Remove the animation from the scene.
virtual void setOcclusionEnabled (bool enabled)
 Enable or disable occlusion of the ribbon by other objects in the scene.
virtual void setRibbonSpacing (float sampleSpacing)
 Sets the spacing between sample points along the ribbon (in meters).
virtual void setRibbonLength (int maxSamples)
 Sets the maximum length of the ribbon (in samples).
virtual void setColor (float r, float g, float b, float a)
 Sets the color of the ribbon.
virtual void initializeModelInstance ()
 Initializes the ribbon model instance with the current settings.
virtual void setVisible (bool isVisible)
 Override to call setVisible on the scene connector.
virtual void setSolid (bool solid)
 Set the geometry of the model as solid.
virtual void update ()
 Update the position of the ribbon.

Protected Attributes

DtOsgSceneConnectormySceneConnector
DtRibbonModelInstancemyRibbonModelCast
bool myOcclusionEnabled
float myRibbonSpacing
int myRibbonLength
bool myColorSet
osg::Vec4 myColor

Detailed Description

A model of a ribbon.


Constructor & Destructor Documentation

CTOR.

DTOR.


Member Function Documentation

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 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,
int  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::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::setColor ( float  r,
float  g,
float  b,
float  a 
) [virtual]

Sets the color of the ribbon.

Reimplemented from makVrv::DtModel.

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::setSolid ( bool  solid) [virtual]

Set the geometry of the model as solid.

Implements makVrv::DtModel.

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

Update the position of the ribbon.

Implements makVrv::DtRibbonModel.


Member Data Documentation

osg::Vec4 makVrv::DtOsgRibbonModel::myColor [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)