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

A model of a decal ribbon. More...

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

Public Member Functions

 DtOsgDecalModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtOsgDecalModel ()
 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 setColor (float r, float g, float b, float a)
 set the model's color
virtual void initializeModelInstance ()
 Push any state maintained by the model to the model instance.
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.
- Public Member Functions inherited from makVrv::DtDecalModel
 DtDecalModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtDecalModel ()
 DTOR.
- 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 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 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 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 removedFromSceneObject ()
 Called when the model was removed from a scene object.
virtual DtModelInstancemodelInstance ()
 Get the model instance.
virtual const DtModelInstancemodelInstance () const
 Get the model instance.
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.

Protected Attributes

DtOsgSceneConnectormySceneConnector
DtDecalModelInstancemyDecalModelCast
bool myOcclusionEnabled
bool myColorSet
osg::Vec4 myColor

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 addToSceneAsProp (const DtUniqueID &sceneObjectId)
 Add this model to the scene as a prop.
void slot_modelInstanceChanged (DtModelInstance *instance)
 Called when the model instance changed.

Detailed Description

A model of a decal ribbon.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtOsgDecalModel::~DtOsgDecalModel ( )
virtual

DTOR.

Member Function Documentation

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

Override the default model definition function.

Implements makVrv::DtDecalModel.

virtual void makVrv::DtOsgDecalModel::setModelInstance ( DtModelInstance modelInstance)
virtual

Override to provide casted pointer.

Reimplemented from makVrv::DtModel.

virtual std::string makVrv::DtOsgDecalModel::className ( ) const
virtual

Get the class name of the model instance owner.

This is used to control how model instances are created.

Implements makVrv::DtDecalModel.

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

Set the orientation of the model.

Reimplemented from makVrv::DtModel.

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

Set the position of the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgDecalModel::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::DtOsgDecalModel::removeFromScene ( )
virtual

Remove the animation from the scene.

Implements makVrv::DtModel.

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

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

Implements makVrv::DtDecalModel.

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

set the model's color

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgDecalModel::initializeModelInstance ( )
virtual

Push any state maintained by the model to the model instance.

Reimplemented from makVrv::DtModel.

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

Override to call setVisible on the scene connector.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgDecalModel::setSolid ( bool  solid)
virtual

Set the geometry of the model as solid.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgDecalModel::update ( )
virtual

Update the position of the ribbon.

Implements makVrv::DtDecalModel.

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsgDecalModel::mySceneConnector
protected
DtDecalModelInstance* makVrv::DtOsgDecalModel::myDecalModelCast
protected
bool makVrv::DtOsgDecalModel::myOcclusionEnabled
protected
bool makVrv::DtOsgDecalModel::myColorSet
protected
osg::Vec4 makVrv::DtOsgDecalModel::myColor
protected

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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)