 |
VR-Forces 4.6.1 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.6.1 Class Documentation
|
A model of a ribbon effect. More...
Public Member Functions | |
| DtRibbonModel (DtDe &de, DtUniqueID id) | |
| CTOR. | |
| virtual | ~DtRibbonModel () |
| DTOR. | |
| virtual void | setModelDefinition (const std::string &str)=0 |
| Override the default model definition function. | |
| virtual std::string | className () const =0 |
| Get the class name of the model instance owner. | |
| virtual void | setOcclusionEnabled (bool enabled)=0 |
| Enable or disable occlusion of the ribbon by other objects in the scene. | |
| virtual void | setRibbonSpacing (float sampleSpacing)=0 |
| Sets the spacing between sample points along the ribbon (in meters). | |
| virtual void | setRibbonLength (int maxSamples)=0 |
| Sets the maximum length of the ribbon (in samples). | |
| virtual void | update ()=0 |
| Update the ribbon. | |
 Public Member Functions inherited from makVrv::DtModel | |
| DtModel (DtDe &de, DtUniqueID id) | |
| CTOR. | |
| virtual | ~DtModel () |
| DTOR. | |
| virtual void | saveModelToFile (const std::string &filename) |
| 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 DtVector & | position (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 | setColor (float r, float g, float b, float a) |
| set the model's color | |
| 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 DtVector & | boundingBoxExtents () 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 DtVector & | boundingBoxCenter () 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. | |
| DtDe & | de () |
| 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 DtModelInstance * | modelInstance () |
| Get the model instance. | |
| virtual const DtModelInstance * | modelInstance () 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 | |
| DtDe & | myDe |
| const DtUniqueID | myUniqueId |
| bool | myColorBlendingEnabled |
A model of a ribbon effect.
| makVrv::DtRibbonModel::DtRibbonModel | ( | DtDe & | de, |
| DtUniqueID | id | ||
| ) |
CTOR.
|
virtual |
DTOR.
|
pure virtual |
Override the default model definition function.
Reimplemented from makVrv::DtModel.
Implemented in makVrv::DtOsgRibbonModel.
|
pure virtual |
Get the class name of the model instance owner.
This is used to control how model instances are created.
Reimplemented from makVrv::DtModel.
Implemented in makVrv::DtOsgRibbonModel.
|
pure virtual |
Enable or disable occlusion of the ribbon by other objects in the scene.
Implemented in makVrv::DtOsgRibbonModel.
|
pure virtual |
Sets the spacing between sample points along the ribbon (in meters).
Implemented in makVrv::DtOsgRibbonModel.
|
pure 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.
Implemented in makVrv::DtOsgRibbonModel.
|
pure virtual |
Update the ribbon.
Implemented in makVrv::DtOsgRibbonModel.