makVrv::DtParticleEffect Class Reference

This class provides a facade around the osgParticle class hierarchy. More...

Inheritance diagram for makVrv::DtParticleEffect:

List of all members.

Public Member Functions
	DtParticleEffect ()
osg::Group contract functions
Get the name of the object's library/namespace
osg::ref_ptr< osg::Group >	myEmitterGroup
	Get the name of the object's class.
osg::ref_ptr< osg::Group >	myProgramGroup
	Get the name of the object's class.
osg::ref_ptr< osg::Geode >	myParticleSystemGeode
	Get the name of the object's class.
osg::ref_ptr< osg::Group >	myProxyGroup
	Get the name of the object's class.
osg::ref_ptr< osg::Group >	myTransformGroup
	Get the name of the object's class.
std::vector< osg::ref_ptr < osg::Sequence > >	mySequences
	Get the name of the object's class.
bool	mySequencesLooping
	Get the name of the object's class.
bool	mySequencesReverse
	Get the name of the object's class.
osg::ref_ptr < osg::MatrixTransform >	myParticleSystemTransform
	Get the name of the object's class.
bool	myTransformsSet
	Get the name of the object's class.
bool	myUseLocalParticleSystem
	Get the name of the object's class.
osg::Vec3	myPosition
	Get the name of the object's class.
float	myScale
	Get the name of the object's class.
float	myIntensity
	Get the name of the object's class.
double	myStartTime
	Get the name of the object's class.
double	myEmitterDuration
	Get the name of the object's class.
osg::Vec3	myWind
	Get the name of the object's class.
virtual const char *	libraryName () const
	Get the name of the object's class.
virtual const char *	className () const
	Get the name of the object's class.
virtual bool	isSameKindAs (const osg::Object *obj) const
	Test for type sameness.
virtual void	accept (osg::NodeVisitor &v)
	Get the name of the object's class.
virtual osg::Group *	emitterGroup ()
	Get an osg Group containing the emitters for this effect.
virtual osg::Group *	programGroup ()
	Get an osg Group containing the programs for this effect.
virtual osg::Group *	proxyGroup ()
	Get an osg Group containing the effect's proxy nodes.
virtual osg::Group *	transformGroup ()
	Get an osg Group containing transforms placed at the top of the effect.
virtual void	setUpEmittersAndPrograms ()=0
	Set the emitter group and program group appropriately.
virtual void	buildEffect ()
	Build the effect up from its current state.
virtual bool	useLocalParticleSystem ()
	Get the name of the object's class.
virtual void	setUseLocalParticleSystem (bool b)
	Get the name of the object's class.
virtual osg::Vec3	position ()
	Get the name of the object's class.
virtual void	setPosition (const osg::Vec3 &vec)
	Get the name of the object's class.
virtual float	scale ()
	Get the name of the object's class.
virtual void	setScale (float scale)
	Get the name of the object's class.
virtual float	intensity ()
	Get the name of the object's class.
virtual void	setIntensity (float intensity)
	Get the name of the object's class.
virtual double	startTime ()
	Get the name of the object's class.
virtual void	setStartTime (double startTime)
	Get the name of the object's class.
virtual double	emitterDuration ()
	Get the name of the object's class.
virtual void	setEmitterDuration (double emitterDuration)
	Get the name of the object's class.
virtual double	particleLifetime ()
	Find the maximum lifetime of any particle in the system.
virtual osg::Vec3	wind ()
	Get the name of the object's class.
virtual void	setWind (const osg::Vec3 wind)
	Get the name of the object's class.
virtual void	stop ()
	Get the name of the object's class.
virtual void	start ()
	Get the name of the object's class.
virtual void	pause ()
	Get the name of the object's class.
virtual void	resume ()
	Get the name of the object's class.
virtual void	setLoopMode (bool loopOn)
	Get the name of the object's class.
virtual void	setReverseAnimation (bool reverse)
	Get the name of the object's class.
virtual void	traverse (osg::NodeVisitor &nv)
	Interrupt CullVisitors to update the transforms.
virtual osg::Node *	particleSystemNode ()
	Get the node containing the particle system geometry.
virtual osg::Geode *	particleSystemGeode ()
	Get an osg Geode containing drawables for this effect's particle systems.
virtual void	setMatrix (const osg::Matrix &mat)
	Get the name of the object's class.
virtual void	addParent (osg::Group *parent)
	Get the name of the object's class.
virtual	~DtParticleEffect ()
	DTOR.
	DtParticleEffect (const DtParticleEffect &copy, const osg::CopyOp &copyop)
	Copy CTOR.

---

Detailed Description

This class provides a facade around the osgParticle class hierarchy.

It is comparable with osgParticle::ParticleEffect, but with support for multiple particle systems and designed for inheritance.

---

Constructor & Destructor Documentation

makVrv::DtParticleEffect::DtParticleEffect

(

)

virtual makVrv::DtParticleEffect::~DtParticleEffect

(

)

[protected, virtual]

DTOR.

makVrv::DtParticleEffect::DtParticleEffect	(	const DtParticleEffect &	copy,
		const osg::CopyOp &	copyop
	)		[protected]

Copy CTOR.

---

Member Function Documentation

virtual const char* makVrv::DtParticleEffect::libraryName

(

)

const [virtual]

Get the name of the object's class.

virtual const char* makVrv::DtParticleEffect::className

(

)

const [virtual]

Get the name of the object's class.

virtual bool makVrv::DtParticleEffect::isSameKindAs

(

const osg::Object *

obj

)

const [virtual]

Test for type sameness.

virtual void makVrv::DtParticleEffect::accept

(

osg::NodeVisitor &

v

)

[virtual]

Get the name of the object's class.

virtual osg::Group* makVrv::DtParticleEffect::emitterGroup

(

)

[virtual]

Get an osg Group containing the emitters for this effect.

virtual osg::Group* makVrv::DtParticleEffect::programGroup

(

)

[virtual]

Get an osg Group containing the programs for this effect.

virtual osg::Group* makVrv::DtParticleEffect::proxyGroup

(

)

[virtual]

Get an osg Group containing the effect's proxy nodes.

virtual osg::Group* makVrv::DtParticleEffect::transformGroup

(

)

[virtual]

Get an osg Group containing transforms placed at the top of the effect.

virtual void makVrv::DtParticleEffect::setUpEmittersAndPrograms

(

)

[pure virtual]

Set the emitter group and program group appropriately.

Implemented in makVrv::DtCopyableParticleEffect.

virtual void makVrv::DtParticleEffect::buildEffect

(

)

[virtual]

Build the effect up from its current state.

virtual bool makVrv::DtParticleEffect::useLocalParticleSystem

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setUseLocalParticleSystem

(

bool

b

)

[virtual]

Get the name of the object's class.

Reimplemented in makVrv::DtCopyableParticleEffect.

virtual osg::Vec3 makVrv::DtParticleEffect::position

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setPosition

(

const osg::Vec3 &

vec

)

[virtual]

Get the name of the object's class.

virtual float makVrv::DtParticleEffect::scale

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setScale

(

float

scale

)

[virtual]

Get the name of the object's class.

virtual float makVrv::DtParticleEffect::intensity

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setIntensity

(

float

intensity

)

[virtual]

Get the name of the object's class.

virtual double makVrv::DtParticleEffect::startTime

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setStartTime

(

double

startTime

)

[virtual]

Get the name of the object's class.

virtual double makVrv::DtParticleEffect::emitterDuration

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setEmitterDuration

(

double

emitterDuration

)

[virtual]

Get the name of the object's class.

virtual double makVrv::DtParticleEffect::particleLifetime

(

)

[virtual]

Find the maximum lifetime of any particle in the system.

virtual osg::Vec3 makVrv::DtParticleEffect::wind

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setWind

(

const osg::Vec3

wind

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::stop

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::start

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::pause

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::resume

(

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setLoopMode

(

bool

loopOn

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::setReverseAnimation

(

bool

reverse

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::traverse

(

osg::NodeVisitor &

nv

)

[virtual]

Interrupt CullVisitors to update the transforms.

virtual osg::Node* makVrv::DtParticleEffect::particleSystemNode

(

)

[virtual]

Get the node containing the particle system geometry.

virtual osg::Geode* makVrv::DtParticleEffect::particleSystemGeode

(

)

[virtual]

Get an osg Geode containing drawables for this effect's particle systems.

virtual void makVrv::DtParticleEffect::setMatrix

(

const osg::Matrix &

mat

)

[virtual]

Get the name of the object's class.

virtual void makVrv::DtParticleEffect::addParent

(

osg::Group *

parent

)

[protected, virtual]

Get the name of the object's class.

---

Member Data Documentation

osg::ref_ptr<osg::Group> makVrv::DtParticleEffect::myEmitterGroup [protected]

Get the name of the object's class.

osg::ref_ptr<osg::Group> makVrv::DtParticleEffect::myProgramGroup [protected]

Get the name of the object's class.

osg::ref_ptr<osg::Geode> makVrv::DtParticleEffect::myParticleSystemGeode [protected]

Get the name of the object's class.

osg::ref_ptr<osg::Group> makVrv::DtParticleEffect::myProxyGroup [protected]

Get the name of the object's class.

osg::ref_ptr<osg::Group> makVrv::DtParticleEffect::myTransformGroup [protected]

Get the name of the object's class.

std::vector<osg::ref_ptr<osg::Sequence> > makVrv::DtParticleEffect::mySequences [protected]

Get the name of the object's class.

bool makVrv::DtParticleEffect::mySequencesLooping [protected]

Get the name of the object's class.

bool makVrv::DtParticleEffect::mySequencesReverse [protected]

Get the name of the object's class.

osg::ref_ptr<osg::MatrixTransform> makVrv::DtParticleEffect::myParticleSystemTransform [protected]

Get the name of the object's class.

bool makVrv::DtParticleEffect::myTransformsSet [protected]

Get the name of the object's class.

bool makVrv::DtParticleEffect::myUseLocalParticleSystem [protected]

Get the name of the object's class.

osg::Vec3 makVrv::DtParticleEffect::myPosition [protected]

Get the name of the object's class.

float makVrv::DtParticleEffect::myScale [protected]

Get the name of the object's class.

float makVrv::DtParticleEffect::myIntensity [protected]

Get the name of the object's class.

double makVrv::DtParticleEffect::myStartTime [protected]

Get the name of the object's class.

double makVrv::DtParticleEffect::myEmitterDuration [protected]

Get the name of the object's class.

osg::Vec3 makVrv::DtParticleEffect::myWind [protected]

Get the name of the object's class.

---

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

• include/vrvOsg/DtParticleEffect.h