makVrv::DtEffectModelInstance Class Reference

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

Inheritance diagram for makVrv::DtEffectModelInstance:

List of all members.

Public Member Functions
virtual	~DtEffectModelInstance ()
	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 ()
	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 ()
virtual void	setLoopMode (bool loopOn)
virtual void	setReverseAnimation (bool reverse)
virtual void	setVisible (bool isVisible)
	Call setVisible on the scene connector if one exists.
Protected Member Functions
DtOsgRibbon *	createRibbonEffect (const osg::Vec3 &pointA, const osg::Vec3 &pointB)
	Create the ribbon effect.
	DtEffectModelInstance (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::ref_ptr< osg::Node >	loadNode (const std::string &filenameParam)
	Try to load a filename as a node.
Protected Attributes
osg::ref_ptr< DtParticleEffect >	myEffect
bool	myParentIsDynamic
bool	myScaleToParentY
std::string	myDefinition
osg::ref_ptr< DtOsgRibbon >	myRibbon
DtOsgSceneConnector *	mySceneConnector
Friends
class	DtEffectModelInstanceCreator

---

Detailed Description

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

---

Constructor & Destructor Documentation

virtual makVrv::DtEffectModelInstance::~DtEffectModelInstance

(

)

[virtual]

DTOR.

makVrv::DtEffectModelInstance::DtEffectModelInstance

(

DtDe &

de

)

[protected]

---

Member Function Documentation

virtual void makVrv::DtEffectModelInstance::setIntensity

(

float

intensity

)

[virtual]

Set the effect intensity.

virtual void makVrv::DtEffectModelInstance::setScale

(

float

scale

)

[virtual]

Set the effect scale.

virtual void makVrv::DtEffectModelInstance::setDuration

(

double

seconds

)

[virtual]

Set the effect duration.

virtual void makVrv::DtEffectModelInstance::setWind

(

const DtVector &

windVector

)

[virtual]

Set the effect wind.

virtual void makVrv::DtEffectModelInstance::setPosition

(

const DtVector &

position

)

[virtual]

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

virtual bool makVrv::DtEffectModelInstance::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::DtEffectModelInstance::addToConnector

(

DtOsgSceneConnector *

connector

)

[virtual]

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

Reimplemented from makVrv::DtOsgModelInstance.

virtual bool makVrv::DtEffectModelInstance::removeFromConnector

(

DtOsgSceneConnector *

connector

)

[virtual]

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

Reimplemented from makVrv::DtOsgModelInstance.

virtual void makVrv::DtEffectModelInstance::stop

(

)

[virtual]

Tell the model to stop emitting particles.

virtual void makVrv::DtEffectModelInstance::start

(

)

[virtual]

Tell the model to start emitting particles.

virtual void makVrv::DtEffectModelInstance::pause

(

)

[virtual]

Freeze the particle emitters.

virtual void makVrv::DtEffectModelInstance::resume

(

)

[virtual]

virtual void makVrv::DtEffectModelInstance::setLoopMode

(

bool

loopOn

)

[virtual]

virtual void makVrv::DtEffectModelInstance::setReverseAnimation

(

bool

reverse

)

[virtual]

virtual void makVrv::DtEffectModelInstance::setVisible

(

bool

isVisible

)

[virtual]

Call setVisible on the scene connector if one exists.

Implements makVrv::DtModelInstance.

DtOsgRibbon* makVrv::DtEffectModelInstance::createRibbonEffect	(	const osg::Vec3 &	pointA,
		const osg::Vec3 &	pointB
	)		[protected]

Create the ribbon effect.

osg::BoundingBox makVrv::DtEffectModelInstance::calculateParentExtents

(

osg::Node *

parent

)

[protected]

osg::Node* makVrv::DtEffectModelInstance::findFromCache

(

DtModelDefinition &

definition

)

[protected]

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

osg::ref_ptr<osg::Node> makVrv::DtEffectModelInstance::loadNode

(

const std::string &

filenameParam

)

[protected]

Try to load a filename as a node.

---

Friends And Related Function Documentation

friend class DtEffectModelInstanceCreator [friend]

---

Member Data Documentation

osg::ref_ptr<DtParticleEffect> makVrv::DtEffectModelInstance::myEffect [protected]

bool makVrv::DtEffectModelInstance::myParentIsDynamic [protected]

bool makVrv::DtEffectModelInstance::myScaleToParentY [protected]

std::string makVrv::DtEffectModelInstance::myDefinition [protected]

osg::ref_ptr<DtOsgRibbon> makVrv::DtEffectModelInstance::myRibbon [protected]

DtOsgSceneConnector* makVrv::DtEffectModelInstance::mySceneConnector [protected]

---

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

• include/vrvOsg/DtEffectModelInstance.h