osgParticle::ParticleEffect Class Reference

Inheritance diagram for osgParticle::ParticleEffect:

[legend]

List of all members.

Public Member Functions
	ParticleEffect (bool automaticSetup=true)
	ParticleEffect (const ParticleEffect &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual const char *	libraryName () const
	return the name of the node's library.
virtual const char *	className () const
	return the name of the node's class type.
virtual bool	isSameKindAs (const osg::Object *obj) const
	return true if this and obj are of the same kind of object.
virtual void	accept (osg::NodeVisitor &nv)
	Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
void	setAutomaticSetup (bool flag)
bool	getAutomaticSetup () const
void	setUseLocalParticleSystem (bool local)
bool	getUseLocalParticleSystem () const
void	setTextureFileName (const std::string &filename)
const std::string &	getTextureFileName () const
void	setDefaultParticleTemplate (const Particle &p)
const Particle &	getDefaultParticleTemplate () const
void	setPosition (const osg::Vec3 &position)
const osg::Vec3 &	getPosition () const
void	setScale (float scale)
float	getScale () const
void	setIntensity (float intensity)
float	getIntensity () const
void	setStartTime (double startTime)
double	getStartTime () const
void	setEmitterDuration (double duration)
double	getEmitterDuration () const
void	setParticleDuration (double duration)
double	getParticleDuration () const
void	setWind (const osg::Vec3 &wind)
const osg::Vec3 &	getWind () const
bool	areAllParticlesDead () const
	Get whether all particles are dead.
virtual Emitter *	getEmitter ()=0
virtual const Emitter *	getEmitter () const =0
virtual Program *	getProgram ()=0
virtual const Program *	getProgram () const =0
void	setParticleSystem (ParticleSystem *ps)
ParticleSystem *	getParticleSystem ()
const ParticleSystem *	getParticleSystem () const
virtual void	setDefaults ()
virtual void	setUpEmitterAndProgram ()=0
virtual void	buildEffect ()
Protected Member Functions
virtual	~ParticleEffect ()
Protected Attributes
bool	_automaticSetup
osg::ref_ptr < ParticleSystem >	_particleSystem
bool	_useLocalParticleSystem
std::string	_textureFileName
Particle	_defaultParticleTemplate
osg::Vec3	_position
float	_scale
float	_intensity
double	_startTime
double	_emitterDuration
osg::Vec3	_wind

---

Constructor & Destructor Documentation

osgParticle::ParticleEffect::ParticleEffect

(

bool

automaticSetup = true

)

[inline, explicit]

osgParticle::ParticleEffect::ParticleEffect	(	const ParticleEffect &	copy,
		const osg::CopyOp &	copyop = osg::CopyOp::SHALLOW_COPY
	)

virtual osgParticle::ParticleEffect::~ParticleEffect

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual const char* osgParticle::ParticleEffect::libraryName

(

)

const [inline, virtual]

return the name of the node's library.

Reimplemented from osg::Node.

virtual const char* osgParticle::ParticleEffect::className

(

)

const [inline, virtual]

return the name of the node's class type.

Reimplemented from osg::Node.

virtual bool osgParticle::ParticleEffect::isSameKindAs

(

const osg::Object *

obj

)

const [inline, virtual]

return true if this and obj are of the same kind of object.

Reimplemented from osg::Node.

virtual void osgParticle::ParticleEffect::accept

(

osg::NodeVisitor &

nv

)

[inline, virtual]

Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.

Reimplemented from osg::Node.

void osgParticle::ParticleEffect::setAutomaticSetup

(

bool

flag

)

[inline]

bool osgParticle::ParticleEffect::getAutomaticSetup

(

)

const [inline]

void osgParticle::ParticleEffect::setUseLocalParticleSystem

(

bool

local

)

bool osgParticle::ParticleEffect::getUseLocalParticleSystem

(

)

const [inline]

void osgParticle::ParticleEffect::setTextureFileName

(

const std::string &

filename

)

const std::string& osgParticle::ParticleEffect::getTextureFileName

(

)

const [inline]

void osgParticle::ParticleEffect::setDefaultParticleTemplate

(

const Particle &

p

)

const Particle& osgParticle::ParticleEffect::getDefaultParticleTemplate

(

)

const [inline]

void osgParticle::ParticleEffect::setPosition

(

const osg::Vec3 &

position

)

const osg::Vec3& osgParticle::ParticleEffect::getPosition

(

)

const [inline]

void osgParticle::ParticleEffect::setScale

(

float

scale

)

float osgParticle::ParticleEffect::getScale

(

)

const [inline]

void osgParticle::ParticleEffect::setIntensity

(

float

intensity

)

float osgParticle::ParticleEffect::getIntensity

(

)

const [inline]

void osgParticle::ParticleEffect::setStartTime

(

double

startTime

)

double osgParticle::ParticleEffect::getStartTime

(

)

const [inline]

void osgParticle::ParticleEffect::setEmitterDuration

(

double

duration

)

double osgParticle::ParticleEffect::getEmitterDuration

(

)

const [inline]

void osgParticle::ParticleEffect::setParticleDuration

(

double

duration

)

double osgParticle::ParticleEffect::getParticleDuration

(

)

const [inline]

void osgParticle::ParticleEffect::setWind

(

const osg::Vec3 &

wind

)

const osg::Vec3& osgParticle::ParticleEffect::getWind

(

)

const [inline]

bool osgParticle::ParticleEffect::areAllParticlesDead

(

)

const [inline]

Get whether all particles are dead.

virtual Emitter* osgParticle::ParticleEffect::getEmitter

(

)

[pure virtual]

Implemented in osgParticle::ExplosionDebrisEffect, osgParticle::ExplosionEffect, osgParticle::FireEffect, osgParticle::SmokeEffect, and osgParticle::SmokeTrailEffect.

virtual const Emitter* osgParticle::ParticleEffect::getEmitter

(

)

const [pure virtual]

Implemented in osgParticle::ExplosionDebrisEffect, osgParticle::ExplosionEffect, osgParticle::FireEffect, osgParticle::SmokeEffect, and osgParticle::SmokeTrailEffect.

virtual Program* osgParticle::ParticleEffect::getProgram

(

)

[pure virtual]

Implemented in osgParticle::ExplosionDebrisEffect, osgParticle::ExplosionEffect, osgParticle::FireEffect, osgParticle::SmokeEffect, and osgParticle::SmokeTrailEffect.

virtual const Program* osgParticle::ParticleEffect::getProgram

(

)

const [pure virtual]

Implemented in osgParticle::ExplosionDebrisEffect, osgParticle::ExplosionEffect, osgParticle::FireEffect, osgParticle::SmokeEffect, and osgParticle::SmokeTrailEffect.

void osgParticle::ParticleEffect::setParticleSystem

(

ParticleSystem *

ps

)

ParticleSystem* osgParticle::ParticleEffect::getParticleSystem

(

)

[inline]

const ParticleSystem* osgParticle::ParticleEffect::getParticleSystem

(

)

const [inline]

virtual void osgParticle::ParticleEffect::setDefaults

(

)

[virtual]

Reimplemented in osgParticle::ExplosionDebrisEffect, osgParticle::ExplosionEffect, osgParticle::FireEffect, osgParticle::SmokeEffect, and osgParticle::SmokeTrailEffect.

virtual void osgParticle::ParticleEffect::setUpEmitterAndProgram

(

)

[pure virtual]

Implemented in osgParticle::ExplosionDebrisEffect, osgParticle::ExplosionEffect, osgParticle::FireEffect, osgParticle::SmokeEffect, and osgParticle::SmokeTrailEffect.

virtual void osgParticle::ParticleEffect::buildEffect

(

)

[virtual]

---

Member Data Documentation

bool osgParticle::ParticleEffect::_automaticSetup [protected]

osg::ref_ptr<ParticleSystem> osgParticle::ParticleEffect::_particleSystem [protected]

bool osgParticle::ParticleEffect::_useLocalParticleSystem [protected]

std::string osgParticle::ParticleEffect::_textureFileName [protected]

Particle osgParticle::ParticleEffect::_defaultParticleTemplate [protected]

osg::Vec3 osgParticle::ParticleEffect::_position [protected]

float osgParticle::ParticleEffect::_scale [protected]

float osgParticle::ParticleEffect::_intensity [protected]

double osgParticle::ParticleEffect::_startTime [protected]

double osgParticle::ParticleEffect::_emitterDuration [protected]

osg::Vec3 osgParticle::ParticleEffect::_wind [protected]

---

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

• ParticleEffect

---