VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtOsgParticleSystemModel Class Reference

A model of a particle system. More...

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

Public Member Functions

 DtOsgParticleSystemModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtOsgParticleSystemModel ()
 DTOR.
virtual void setModelDefinition (const std::string &str)
 Override the default model definition function.
virtual std::string className () const
 Get the class name of the model instance owner.
virtual void setIntensity (float intensity)
 Set the intensity.
virtual void setScale (float scale)
 Set the intensity.
virtual void setDuration (double seconds)
 Set the duration of the effect.
virtual void setWindDirection (const DtVector &direction)
 Set the wind direction.
virtual void stop ()
 Tell the model to stop emitting particles.
virtual void start ()
 Tell the model to start emitting particles.
virtual void pause ()
 Freeze the particle emitters.
virtual void resume ()
 Resume the animation.
virtual void setVisible (bool isVisible)
 Override to call setVisible on the scene connector.
virtual void setSolid (bool solid)
 Set the geometry to be solid.
Set spatial data
virtual void setPosition (int vtx, const DtVector &position)
 Set the position of a control vertex in the model.
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Set the orientation of a vertex in the model.
- Public Member Functions inherited from makVrv::DtParticleSystemModel
 DtParticleSystemModel (DtDe &de, DtUniqueID id)
 CTOR.
virtual ~DtParticleSystemModel ()
 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 setColor (float r, float g, float b, float a)
 set the model's color
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.
void getBoundingBoxCenter (double &x, double &y, double &z) const
 Get the bounding box center of the model instance.
void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
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 void setModelInstance (DtModelInstance *modelInstance)
 Internally set the model instance pointer.
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 Member Functions

virtual void addToScene (const DtUniqueID &id, int modelSet, int visualizerType)
 Virtual Functions to be implemented, add this model to the scene.
virtual void removeFromScene ()
 Virtual Functions to be implemented, remove this model from the scene.

Protected Attributes

DtOsgSceneConnectormySceneConnector
double myIntensity
bool myIntensitySet
double myScale
bool myScaleSet
double myDuration
bool myDurationSet
bool myOrientUp
bool myPositionSet
bool myOrientationSet
DtVector myPosition
DtTaitBryan myOrientation

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

Detailed Description

A model of a particle system.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtOsgParticleSystemModel::~DtOsgParticleSystemModel ( )
virtual

DTOR.

Member Function Documentation

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

Override the default model definition function.

Implements makVrv::DtParticleSystemModel.

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

Get the class name of the model instance owner.

This is used to control how model instances are created.

Implements makVrv::DtParticleSystemModel.

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

Set the intensity.

Implements makVrv::DtParticleSystemModel.

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

Set the intensity.

Implements makVrv::DtParticleSystemModel.

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

Set the duration of the effect.

Implements makVrv::DtParticleSystemModel.

virtual void makVrv::DtOsgParticleSystemModel::setPosition ( int  vtx,
const DtVector position 
)
virtual

Set the position of a control vertex in the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgParticleSystemModel::setOrientation ( int  vtx,
const DtTaitBryan &  orientation 
)
virtual

Set the orientation of a vertex in the model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgParticleSystemModel::setWindDirection ( const DtVector direction)
virtual

Set the wind direction.

Implements makVrv::DtParticleSystemModel.

virtual void makVrv::DtOsgParticleSystemModel::stop ( )
virtual

Tell the model to stop emitting particles.

Implements makVrv::DtParticleSystemModel.

virtual void makVrv::DtOsgParticleSystemModel::start ( )
virtual

Tell the model to start emitting particles.

Implements makVrv::DtParticleSystemModel.

virtual void makVrv::DtOsgParticleSystemModel::pause ( )
virtual

Freeze the particle emitters.

Implements makVrv::DtParticleSystemModel.

virtual void makVrv::DtOsgParticleSystemModel::resume ( )
virtual

Resume the animation.

Implements makVrv::DtParticleSystemModel.

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

Override to call setVisible on the scene connector.

Reimplemented from makVrv::DtModel.

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

Set the geometry to be solid.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgParticleSystemModel::addToScene ( const DtUniqueID sceneObjectId,
int  modelSet,
int  visualizerType 
)
protectedvirtual

Virtual Functions to be implemented, add this model to the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgParticleSystemModel::removeFromScene ( )
protectedvirtual

Virtual Functions to be implemented, remove this model from the scene.

Implements makVrv::DtModel.

Member Data Documentation

DtOsgSceneConnector* makVrv::DtOsgParticleSystemModel::mySceneConnector
protected
double makVrv::DtOsgParticleSystemModel::myIntensity
protected
bool makVrv::DtOsgParticleSystemModel::myIntensitySet
protected
double makVrv::DtOsgParticleSystemModel::myScale
protected
bool makVrv::DtOsgParticleSystemModel::myScaleSet
protected
double makVrv::DtOsgParticleSystemModel::myDuration
protected
bool makVrv::DtOsgParticleSystemModel::myDurationSet
protected
bool makVrv::DtOsgParticleSystemModel::myOrientUp
protected
bool makVrv::DtOsgParticleSystemModel::myPositionSet
protected
bool makVrv::DtOsgParticleSystemModel::myOrientationSet
protected
DtVector makVrv::DtOsgParticleSystemModel::myPosition
protected
DtTaitBryan makVrv::DtOsgParticleSystemModel::myOrientation
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)