VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makVrv::DtAnimationModelInstance Class Reference

An effect model instance creates a particle effect from a model definition. More...

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

Public Member Functions

virtual ~DtAnimationModelInstance ()
 DTOR.
virtual void setIntensity (float intensity)
 Set the effect intensity.
virtual void setScale (float scale)
 Set the effect scale.
virtual void setDuration (double seconds)
 Set the effect duration.
virtual void setWind (const DtVector &windVector)
 Set the effect wind.
virtual void setPosition (const DtVector &position)
 Set the position of the effect, either in world coordinates or in local coordinates.
virtual bool realize (DtModelDefinition &definition)
 Attempt to realize a definition.
virtual void addToConnector (DtOsgSceneConnector *connector)
 Brief Tell the model instance to add itself to the provided node.
virtual bool removeFromConnector (DtOsgSceneConnector *connector)
 Brief Tell the model instance to remove itself from the provided node.
virtual void stop ()
 Stop the animation.
virtual void start ()
 Start the animation.
virtual void pause ()
 Pause the animation.
virtual void resume ()
 Resume the animation after it was paused.
virtual void setLoopMode (bool loopOn)
 Set the animation looping on or off.
virtual void setReverseAnimation (bool reverse)
 Reverse the direction of the animation.
virtual void setVisible (bool isVisible)
 no-op
- Public Member Functions inherited from makVrv::DtOsgModelInstance
virtual ~DtOsgModelInstance ()
 DTOR.
virtual bool saveModelToFile (const std::string &filename) const
 Attempt to save the model to a file.
virtual void enableColorBlending (bool b)
 Enable / disable coloring on all models in the scene object.
virtual void setBlendColor (float r, float g, float b, float a)
 set the model's color
virtual void enableTexture (bool onOff)
virtual osg::Node * rootNode ()
 Get the model instance's root node.
virtual const osg::Node * rootNode () const
 Get the model instance's root node.
- Public Member Functions inherited from makVrv::DtModelInstance
 DtModelInstance (DtDe &de)
 CTOR.
virtual ~DtModelInstance ()
 DTOR.
const std::string & realizedDefinitionName () const
 Get the name of the definition that this model instance was realized with.
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.
void getBoundingBoxCenter (double &x, double &y, double &z) const
 Get the bounding box center of the model instance.
void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
virtual 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.

Protected Member Functions

 DtAnimationModelInstance (DtDe &de)
osg::BoundingBox calculateParentExtents (osg::Node *parent)
osg::Node * findFromCache (DtModelDefinition &definition)
 Try to find an effect model instance in cache to copy.
osg::Node * loadNode (const std::string &filenameParam, const std::string &resourcePathList)
 Try to load a filename as a node.
- Protected Member Functions inherited from makVrv::DtOsgModelInstance
virtual void updateColorBlending ()
 calls update color blending with the model root.
virtual void updateColorBlending (osg::Node *node)
virtual void enableTexture (osg::Node *root, bool onOff)
virtual void updateBoundingBoxViaContents ()
 DtOsgModelInstance (DtDe &de)
 CTOR.
virtual void setRootNode (osg::Node *node)
 Set the model instance's root node.

Protected Attributes

osg::ref_ptr< DtParticleEffectmyEffect
- Protected Attributes inherited from makVrv::DtOsgModelInstance
osg::ref_ptr< osg::Node > myModelRoot
osg::ref_ptr< osg::StateSet > myCachedState
- Protected Attributes inherited from makVrv::DtModelInstance
DtDemyDe
std::string myRealizedModelDefinitionName
DtVector myBoundingBoxCenter
DtVector myBoundingBoxExtents
DtVector myBoundingBoxMinimum
DtVector myBoundingBoxMaximum
bool myContributesToBound
bool myColorBlendingEnabled
float myBlendRed
float myBlendBlue
float myBlendGreen
float myBlendAlpha

Friends

class DtAnimationModelInstanceCreator

Additional Inherited Members

- Static Public Member Functions inherited from makVrv::DtOsgModelInstance
static osg::Vec4 readVec4 (const std::string &paramName, const DtModelDefinition &definition)
static osg::Vec3 readVec3 (const std::string &paramName, const DtModelDefinition &definition)
- Public Attributes inherited from makVrv::DtModelInstance
boost::signal< void(DtModelInstance *)> signal_modelInstanceChanged

Detailed Description

An effect model instance creates a particle effect from a model definition.

Constructor & Destructor Documentation

virtual makVrv::DtAnimationModelInstance::~DtAnimationModelInstance ( )
virtual

DTOR.

makVrv::DtAnimationModelInstance::DtAnimationModelInstance ( DtDe de)
protected

Member Function Documentation

virtual void makVrv::DtAnimationModelInstance::setIntensity ( float  intensity)
virtual

Set the effect intensity.

virtual void makVrv::DtAnimationModelInstance::setScale ( float  scale)
virtual

Set the effect scale.

virtual void makVrv::DtAnimationModelInstance::setDuration ( double  seconds)
virtual

Set the effect duration.

virtual void makVrv::DtAnimationModelInstance::setWind ( const DtVector windVector)
virtual

Set the effect wind.

virtual void makVrv::DtAnimationModelInstance::setPosition ( const DtVector position)
virtual

Set the position of the effect, either in world coordinates or in local coordinates.

virtual bool makVrv::DtAnimationModelInstance::realize ( DtModelDefinition definition)
virtual

Attempt to realize a definition.

If the model instance can't realize the definition it should return false.

Reimplemented from makVrv::DtModelInstance.

virtual void makVrv::DtAnimationModelInstance::addToConnector ( DtOsgSceneConnector connector)
virtual

Brief Tell the model instance to add itself to the provided node.

Reimplemented from makVrv::DtOsgModelInstance.

virtual bool makVrv::DtAnimationModelInstance::removeFromConnector ( DtOsgSceneConnector connector)
virtual

Brief Tell the model instance to remove itself from the provided node.

Reimplemented from makVrv::DtOsgModelInstance.

virtual void makVrv::DtAnimationModelInstance::stop ( )
virtual

Stop the animation.

virtual void makVrv::DtAnimationModelInstance::start ( )
virtual

Start the animation.

virtual void makVrv::DtAnimationModelInstance::pause ( )
virtual

Pause the animation.

virtual void makVrv::DtAnimationModelInstance::resume ( )
virtual

Resume the animation after it was paused.

virtual void makVrv::DtAnimationModelInstance::setLoopMode ( bool  loopOn)
virtual

Set the animation looping on or off.

virtual void makVrv::DtAnimationModelInstance::setReverseAnimation ( bool  reverse)
virtual

Reverse the direction of the animation.

virtual void makVrv::DtAnimationModelInstance::setVisible ( bool  isVisible)
inlinevirtual

no-op

Implements makVrv::DtModelInstance.

osg::BoundingBox makVrv::DtAnimationModelInstance::calculateParentExtents ( osg::Node *  parent)
protected
osg::Node* makVrv::DtAnimationModelInstance::findFromCache ( DtModelDefinition definition)
protected

Try to find an effect model instance in cache to copy.

osg::Node* makVrv::DtAnimationModelInstance::loadNode ( const std::string &  filenameParam,
const std::string &  resourcePathList 
)
protected

Try to load a filename as a node.

Friends And Related Function Documentation

friend class DtAnimationModelInstanceCreator
friend

Member Data Documentation

osg::ref_ptr<DtParticleEffect> makVrv::DtAnimationModelInstance::myEffect
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)