osgParticle::ParticleEffect Class Reference

#include <ParticleEffect.h>

Inheritance diagram for osgParticle::ParticleEffect:

Collaboration diagram for osgParticle::ParticleEffect:

Public Member Functions
	ParticleEffect (bool automaticSetup=true)
	ParticleEffect (const ParticleEffect &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual const char *	libraryName () const
virtual const char *	className () const
virtual bool	isSameKindAs (const osg::Object *obj) const
virtual void	accept (osg::NodeVisitor &nv)
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. More...
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 ()
Public Member Functions inherited from osg::Group
	Group ()
	Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	META_Node (osg, Group)
virtual Group *	asGroup ()
virtual const Group *	asGroup () const
virtual void	traverse (NodeVisitor &nv)
virtual bool	addChild (Node *child)
virtual bool	insertChild (unsigned int index, Node *child)
virtual bool	removeChild (Node *child)
bool	removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool	removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool	replaceChild (Node *origChild, Node *newChild)
virtual unsigned int	getNumChildren () const
virtual bool	setChild (unsigned int i, Node *node)
Node *	getChild (unsigned int i)
const Node *	getChild (unsigned int i) const
bool	containsNode (const Node *node) const
unsigned int	getChildIndex (const Node *node) const
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	resizeGLObjectBuffers (unsigned int maxSize)
virtual void	releaseGLObjects (osg::State *=0) const
virtual BoundingSphere	computeBound () const
Public Member Functions inherited from osg::Node
	Node ()
	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const
virtual Object *	clone (const CopyOp &copyop) const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual Drawable *	asDrawable ()
virtual const Drawable *	asDrawable () const
virtual Geometry *	asGeometry ()
virtual const Geometry *	asGeometry () const
virtual Transform *	asTransform ()
virtual const Transform *	asTransform () const
virtual Camera *	asCamera ()
virtual const Camera *	asCamera () const
virtual Switch *	asSwitch ()
virtual const Switch *	asSwitch () const
virtual Geode *	asGeode ()
virtual const Geode *	asGeode () const
virtual osgTerrain::Terrain *	asTerrain ()
virtual const osgTerrain::Terrain *	asTerrain () const
virtual void	ascend (NodeVisitor &nv)
const ParentList &	getParents () const
ParentList	getParents ()
Group *	getParent (unsigned int i)
const Group *	getParent (unsigned int i) const
unsigned int	getNumParents () const
NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void	setUpdateCallback (Callback *nc)
Callback *	getUpdateCallback ()
const Callback *	getUpdateCallback () const
void	addUpdateCallback (Callback *nc)
void	removeUpdateCallback (Callback *nc)
unsigned int	getNumChildrenRequiringUpdateTraversal () const
void	setEventCallback (Callback *nc)
Callback *	getEventCallback ()
const Callback *	getEventCallback () const
void	addEventCallback (Callback *nc)
void	removeEventCallback (Callback *nc)
unsigned int	getNumChildrenRequiringEventTraversal () const
void	setCullCallback (Callback *nc)
Callback *	getCullCallback ()
const Callback *	getCullCallback () const
void	addCullCallback (Callback *nc)
void	removeCullCallback (Callback *nc)
void	setCullingActive (bool active)
bool	getCullingActive () const
unsigned int	getNumChildrenWithCullingDisabled () const
bool	isCullingActive () const
unsigned int	getNumChildrenWithOccluderNodes () const
bool	containsOccluderNodes () const
void	setNodeMask (NodeMask nm)
NodeMask	getNodeMask () const
void	setStateSet (osg::StateSet *stateset)
osg::StateSet *	getOrCreateStateSet ()
osg::StateSet *	getStateSet ()
const osg::StateSet *	getStateSet () const
void	setDescriptions (const DescriptionList &descriptions)
DescriptionList &	getDescriptions ()
const DescriptionList &	getDescriptions () const
const std::string &	getDescription (unsigned int i) const
std::string &	getDescription (unsigned int i)
unsigned int	getNumDescriptions () const
void	addDescription (const std::string &desc)
void	setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSphere &	getInitialBound () const
void	dirtyBound ()
const BoundingSphere &	getBound () const
void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
std::string	getCompoundClassName () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
virtual void	setName (const std::string &name)
void	setName (const char *name)
const std::string &	getName () const
void	setDataVariance (DataVariance dv)
DataVariance	getDataVariance () const
virtual void	computeDataVariance ()
void	setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () const
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
template<typename T >
void	setUserValue (const std::string &name, const T &value)
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const

Protected Member Functions
virtual	~ParticleEffect ()
Protected Member Functions inherited from osg::Group
virtual	~Group ()
virtual void	childRemoved (unsigned int, unsigned int)
virtual void	childInserted (unsigned int)
Protected Member Functions inherited from osg::Node
virtual	~Node ()
void	addParent (osg::Group *parent)
void	removeParent (osg::Group *parent)
void	setNumChildrenRequiringUpdateTraversal (unsigned int num)
void	setNumChildrenRequiringEventTraversal (unsigned int num)
void	setNumChildrenWithCullingDisabled (unsigned int num)
void	setNumChildrenWithOccluderNodes (unsigned int num)
Protected Member Functions inherited from osg::Object
virtual	~Object ()
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

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
Protected Attributes inherited from osg::Group
NodeList	_children
Protected Attributes inherited from osg::Node
BoundingSphere	_initialBound
ref_ptr < ComputeBoundingSphereCallback >	_computeBoundCallback
BoundingSphere	_boundingSphere
bool	_boundingSphereComputed
ParentList	_parents
ref_ptr< Callback >	_updateCallback
unsigned int	_numChildrenRequiringUpdateTraversal
ref_ptr< Callback >	_eventCallback
unsigned int	_numChildrenRequiringEventTraversal
ref_ptr< Callback >	_cullCallback
bool	_cullingActive
unsigned int	_numChildrenWithCullingDisabled
unsigned int	_numChildrenWithOccluderNodes
NodeMask	_nodeMask
ref_ptr< StateSet >	_stateset
Protected Attributes inherited from osg::Object
std::string	_name
DataVariance	_dataVariance
osg::UserDataContainer *	_userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Additional Inherited Members
Public Types inherited from osg::Node
typedef std::vector< Group * >	ParentList
typedef unsigned int	NodeMask
typedef std::vector< std::string >	DescriptionList
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()

Detailed Description

Definition at line 23 of file ParticleEffect.h.

Constructor & Destructor Documentation

osgParticle::ParticleEffect::ParticleEffect ( bool  automaticSetup = true )

inlineexplicit

Definition at line 27 of file ParticleEffect.h.

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

virtual osgParticle::ParticleEffect::~ParticleEffect ( )

inlineprotectedvirtual

Definition at line 99 of file ParticleEffect.h.

Member Function Documentation

virtual void osgParticle::ParticleEffect::accept ( osg::NodeVisitor &  nv )

inlinevirtual

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

Reimplemented from osg::Node.

Definition at line 43 of file ParticleEffect.h.

Here is the call graph for this function:

bool osgParticle::ParticleEffect::areAllParticlesDead ( ) const

inline

Get whether all particles are dead.

Definition at line 79 of file ParticleEffect.h.

virtual void osgParticle::ParticleEffect::buildEffect ( )

virtual

virtual const char* osgParticle::ParticleEffect::className ( ) const

inlinevirtual

return the name of the node's class type.

Reimplemented from osg::Node.

Definition at line 41 of file ParticleEffect.h.

bool osgParticle::ParticleEffect::getAutomaticSetup ( ) const

inline

Definition at line 46 of file ParticleEffect.h.

const Particle& osgParticle::ParticleEffect::getDefaultParticleTemplate ( ) const

inline

Definition at line 55 of file ParticleEffect.h.

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.

double osgParticle::ParticleEffect::getEmitterDuration ( ) const

inline

Definition at line 70 of file ParticleEffect.h.

float osgParticle::ParticleEffect::getIntensity ( ) const

inline

Definition at line 64 of file ParticleEffect.h.

double osgParticle::ParticleEffect::getParticleDuration ( ) const

inline

Definition at line 73 of file ParticleEffect.h.

ParticleSystem* osgParticle::ParticleEffect::getParticleSystem ( )

inline

Definition at line 88 of file ParticleEffect.h.

const ParticleSystem* osgParticle::ParticleEffect::getParticleSystem ( ) const

inline

Definition at line 89 of file ParticleEffect.h.

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

inline

Definition at line 58 of file ParticleEffect.h.

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.

float osgParticle::ParticleEffect::getScale ( ) const

inline

Definition at line 61 of file ParticleEffect.h.

double osgParticle::ParticleEffect::getStartTime ( ) const

inline

Definition at line 67 of file ParticleEffect.h.

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

inline

Definition at line 52 of file ParticleEffect.h.

bool osgParticle::ParticleEffect::getUseLocalParticleSystem ( ) const

inline

Definition at line 49 of file ParticleEffect.h.

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

inline

Definition at line 76 of file ParticleEffect.h.

virtual bool osgParticle::ParticleEffect::isSameKindAs ( const osg::Object *  obj ) const

inlinevirtual

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

Reimplemented from osg::Node.

Definition at line 42 of file ParticleEffect.h.

virtual const char* osgParticle::ParticleEffect::libraryName ( ) const

inlinevirtual

return the name of the node's library.

Reimplemented from osg::Node.

Definition at line 40 of file ParticleEffect.h.

void osgParticle::ParticleEffect::setAutomaticSetup ( bool  flag )

inline

Definition at line 45 of file ParticleEffect.h.

void osgParticle::ParticleEffect::setDefaultParticleTemplate

(

const Particle &

p

)

virtual void osgParticle::ParticleEffect::setDefaults ( )

virtual

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

void osgParticle::ParticleEffect::setEmitterDuration

(

double

duration

)

void osgParticle::ParticleEffect::setIntensity

(

float

intensity

)

void osgParticle::ParticleEffect::setParticleDuration

(

double

duration

)

void osgParticle::ParticleEffect::setParticleSystem

(

ParticleSystem *

ps

)

void osgParticle::ParticleEffect::setPosition

(

const osg::Vec3 &

position

)

void osgParticle::ParticleEffect::setScale

(

float

scale

)

void osgParticle::ParticleEffect::setStartTime

(

double

startTime

)

void osgParticle::ParticleEffect::setTextureFileName

(

const std::string &

filename

)

virtual void osgParticle::ParticleEffect::setUpEmitterAndProgram ( )

pure virtual

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

void osgParticle::ParticleEffect::setUseLocalParticleSystem

(

bool

local

)

void osgParticle::ParticleEffect::setWind

(

const osg::Vec3 &

wind

)

Member Data Documentation

bool osgParticle::ParticleEffect::_automaticSetup

protected

Definition at line 101 of file ParticleEffect.h.

Particle osgParticle::ParticleEffect::_defaultParticleTemplate

protected

Definition at line 107 of file ParticleEffect.h.

double osgParticle::ParticleEffect::_emitterDuration

protected

Definition at line 112 of file ParticleEffect.h.

float osgParticle::ParticleEffect::_intensity

protected

Definition at line 110 of file ParticleEffect.h.

osg::ref_ptr<ParticleSystem> osgParticle::ParticleEffect::_particleSystem

protected

Definition at line 103 of file ParticleEffect.h.

osg::Vec3 osgParticle::ParticleEffect::_position

protected

Definition at line 108 of file ParticleEffect.h.

float osgParticle::ParticleEffect::_scale

protected

Definition at line 109 of file ParticleEffect.h.

double osgParticle::ParticleEffect::_startTime

protected

Definition at line 111 of file ParticleEffect.h.

std::string osgParticle::ParticleEffect::_textureFileName

protected

Definition at line 106 of file ParticleEffect.h.

bool osgParticle::ParticleEffect::_useLocalParticleSystem

protected

Definition at line 105 of file ParticleEffect.h.

osg::Vec3 osgParticle::ParticleEffect::_wind

protected

Definition at line 113 of file ParticleEffect.h.

---

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

• osg_head/include/osgParticle/ParticleEffect.h