VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Private Attributes
SimpleParticles Class Reference

Class containing all parts of a system for a single type of particle. More...

Inheritance diagram for SimpleParticles:
Inheritance graph
[legend]

Public Member Functions

 SimpleParticles ()
 CTOR.
virtual ~SimpleParticles ()
 DTOR.
osg::PositionAttitudeTransform * positionAttitudeTransform () const
 Accessor to the transform for positioning the emitter.
osgParticle::Particle * particle () const
 Accessor to the particle template.
osgParticle::ParticleSystem * particleSystem () const
 Accessor to the particle system.
osgParticle::ParticleSystemUpdater * particleSystemUpdater () const
 Accessor to the updater.
osgParticle::ModularEmitter * modularEmitter () const
 Accessor to the emitter.
osgParticle::RandomRateCounter * randomRateCounter () const
 Accessor to the counter.
osgParticle::PointPlacer * pointPlacer () const
 Accessor to the placer.
osgParticle::RadialShooter * radialShooter () const
 Accessor to the shooter.
osgParticle::ModularProgram * modularProgram () const
 Accessor to the modular program.

Private Attributes

osg::ref_ptr
< osg::PositionAttitudeTransform > 
myPat
osgParticle::Particle * myParticle
osg::ref_ptr
< osgParticle::ParticleSystem > 
myParticleSystem
osg::ref_ptr
< osgParticle::ParticleSystemUpdater > 
myParticleSystemUpdater
osg::ref_ptr
< osgParticle::ModularEmitter > 
myModularEmitter
osg::ref_ptr
< osgParticle::ModularProgram > 
myModularProgram
osg::ref_ptr
< osgParticle::RandomRateCounter > 
myRandomRateCounter
osg::ref_ptr
< osgParticle::PointPlacer > 
myPointPlacer
osg::ref_ptr
< osgParticle::RadialShooter > 
myRadialShooter

Detailed Description

Class containing all parts of a system for a single type of particle.

This class encompasses all the necessary parts to create a particle system which emits a single type of particle. Though it is not necessary to build a particle system into a single class, this design allows multiple uses within a scene with minimal configuration.

Examples

Constructor & Destructor Documentation

SimpleParticles::SimpleParticles ( )

CTOR.

virtual SimpleParticles::~SimpleParticles ( )
virtual

DTOR.

Member Function Documentation

osg::PositionAttitudeTransform* SimpleParticles::positionAttitudeTransform ( ) const
inline

Accessor to the transform for positioning the emitter.

References myPat.

osgParticle::Particle* SimpleParticles::particle ( ) const
inline

Accessor to the particle template.

Note
Changes to the particle will only take effect when it is set/reset as the template to the osgParticle::ParticleSystem.

References myParticle.

osgParticle::ParticleSystem* SimpleParticles::particleSystem ( ) const
inline

Accessor to the particle system.

Note
The particle system holds a particle as a template and assigns the texture to be used on the particle.

References myParticleSystem.

osgParticle::ParticleSystemUpdater* SimpleParticles::particleSystemUpdater ( ) const
inline

Accessor to the updater.

Note
The updater holds a set of particles and managers their creation, update, rendering and destruction.

References myParticleSystemUpdater.

osgParticle::ModularEmitter* SimpleParticles::modularEmitter ( ) const
inline

Accessor to the emitter.

Note
The emitter provides a single mechanism for controlling many of the elements of the particle system. (Contains the counter, placer, and shooter.)

References myModularEmitter.

osgParticle::RandomRateCounter* SimpleParticles::randomRateCounter ( ) const
inline

Accessor to the counter.

Note
The counter controls how many particles should create each frame.

References myRandomRateCounter.

osgParticle::PointPlacer* SimpleParticles::pointPlacer ( ) const
inline

Accessor to the placer.

Note
The placer sets the initial position of each particle.

References myPointPlacer.

osgParticle::RadialShooter* SimpleParticles::radialShooter ( ) const
inline

Accessor to the shooter.

Note
The shooter assigns the initial velocity of each particle.

References myRadialShooter.

osgParticle::ModularProgram* SimpleParticles::modularProgram ( ) const
inline

Accessor to the modular program.

Note
The ModularParogram can control the position of individual particles during its lifespan. (By default not being used in this exercise, but is include for users to experiment with.)

References myModularProgram.

Member Data Documentation

osg::ref_ptr<osg::PositionAttitudeTransform> SimpleParticles::myPat
private
osgParticle::Particle* SimpleParticles::myParticle
private

Referenced by particle().

osg::ref_ptr<osgParticle::ParticleSystem> SimpleParticles::myParticleSystem
private

Referenced by particleSystem().

osg::ref_ptr<osgParticle::ParticleSystemUpdater> SimpleParticles::myParticleSystemUpdater
private

Referenced by particleSystemUpdater().

osg::ref_ptr<osgParticle::ModularEmitter> SimpleParticles::myModularEmitter
private

Referenced by modularEmitter().

osg::ref_ptr<osgParticle::ModularProgram> SimpleParticles::myModularProgram
private

Referenced by modularProgram().

osg::ref_ptr<osgParticle::RandomRateCounter> SimpleParticles::myRandomRateCounter
private

Referenced by randomRateCounter().

osg::ref_ptr<osgParticle::PointPlacer> SimpleParticles::myPointPlacer
private

Referenced by pointPlacer().

osg::ref_ptr<osgParticle::RadialShooter> SimpleParticles::myRadialShooter
private

Referenced by radialShooter().


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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)