#include <Emitter.h>

Inheritance diagram for osgParticle::Emitter:

Collaboration diagram for osgParticle::Emitter:

Public Member Functions
	Emitter ()

	Emitter (const Emitter &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)

const Particle &	getParticleTemplate () const
	Get the particle template. More...

void	setParticleTemplate (const Particle &p)
	Set the particle template (particle is copied). More...

bool	getUseDefaultTemplate () const
	Return whether the particle system's default template should be used. More...

void	setUseDefaultTemplate (bool v)

Public Member Functions inherited from osgParticle::ParticleProcessor
	ParticleProcessor ()

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

ReferenceFrame	getReferenceFrame () const
	Get the reference frame. More...

void	setReferenceFrame (ReferenceFrame rf)
	Set the reference frame. More...

bool	getEnabled () const
	Get whether this processor is enabled or not. More...

bool	isEnabled () const

void	setEnabled (bool v)
	Set whether this processor is enabled or not. More...

ParticleSystem *	getParticleSystem ()
	Get a pointer to the destination particle system. More...

const ParticleSystem *	getParticleSystem () const
	Get a const pointer to the destination particle system. More...

void	setParticleSystem (ParticleSystem *ps)
	Set the destination particle system. More...

void	setEndless (bool type)
	Set the endless flag of this processor. More...

bool	getEndless () const
	Check whether this processor is endless. More...

bool	isEndless () const

void	setLifeTime (double t)
	Set the lifetime of this processor. More...

double	getLifeTime () const
	Get the lifetime of this processor. More...

void	setStartTime (double t)
	Set the start time of this processor. More...

double	getStartTime () const
	Get the start time of this processor. More...

void	setCurrentTime (double t)
	Set the current time of this processor. More...

double	getCurrentTime () const
	Get the current time of this processor. More...

void	setResetTime (double t)
	Set the reset time of this processor. A value of 0 disables reset. More...

double	getResetTime () const
	Get the reset time of this processor. More...

bool	isAlive () const

void	traverse (osg::NodeVisitor &nv)

const osg::Matrix &	getLocalToWorldMatrix ()
	Get the current local-to-world transformation matrix (valid only during cull traversal). More...

const osg::Matrix &	getWorldToLocalMatrix ()
	Get the current world-to-local transformation matrix (valid only during cull traversal). More...

const osg::Matrix &	getPreviousLocalToWorldMatrix ()
	Get the previous local-to-world transformation matrix (valid only during cull traversal). More...

const osg::Matrix &	getPreviousWorldToLocalMatrix ()
	Get the previous world-to-local transformation matrix (valid only during cull traversal). More...

osg::Vec3	transformLocalToWorld (const osg::Vec3 &P)
	Transform a point from local to world coordinates (valid only during cull traversal). More...

osg::Vec3	rotateLocalToWorld (const osg::Vec3 &P)
	Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal). More...

osg::Vec3	transformWorldToLocal (const osg::Vec3 &P)
	Transform a point from world to local coordinates (valid only during cull traversal). More...

osg::Vec3	rotateWorldToLocal (const osg::Vec3 &P)
	Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal). More...

virtual osg::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 Group *	asGroup ()

virtual const Group *	asGroup () 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

virtual void	setThreadSafeRefUnref (bool threadSafe)

virtual void	resizeGLObjectBuffers (unsigned int)

virtual void	releaseGLObjects (osg::State *=0) 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	~Emitter ()

Emitter &	operator= (const Emitter &)

void	process (double dt)

virtual void	emitParticles (double dt)=0

Protected Member Functions inherited from osgParticle::ParticleProcessor
virtual	~ParticleProcessor ()

ParticleProcessor &	operator= (const ParticleProcessor &)

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	_usedeftemp

Particle	_ptemp

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 osgParticle::ParticleProcessor
enum	ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF }

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

An abstract base class for particle emitters. Descendant classes must override the emitParticles() method to generate new particles by calling the ParticleSystem::createParticle() method on the particle system associated to the emitter.

Definition at line 35 of file Emitter.h.

Constructor & Destructor Documentation

osgParticle::Emitter::Emitter ( )

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

virtual osgParticle::Emitter::~Emitter ( )

inlineprotectedvirtual

Definition at line 61 of file Emitter.h.

Member Function Documentation

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

inlinevirtual

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

Reimplemented from osgParticle::ParticleProcessor.

Definition at line 43 of file Emitter.h.

Here is the call graph for this function:

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

inlinevirtual

return the name of the node's class type.

Reimplemented from osgParticle::ParticleProcessor.

Definition at line 41 of file Emitter.h.

virtual void osgParticle::Emitter::emitParticles ( double dt )

protectedpure virtual

Implemented in osgParticle::ModularEmitter.

Here is the caller graph for this function:

const Particle & osgParticle::Emitter::getParticleTemplate ( ) const

inline

Get the particle template.

Definition at line 74 of file Emitter.h.

bool osgParticle::Emitter::getUseDefaultTemplate ( ) const

inline

Return whether the particle system's default template should be used.

Definition at line 85 of file Emitter.h.

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

inlinevirtual

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

Reimplemented from osgParticle::ParticleProcessor.

Definition at line 42 of file Emitter.h.

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

inlinevirtual

return the name of the node's library.

Reimplemented from osgParticle::ParticleProcessor.

Definition at line 40 of file Emitter.h.

Emitter& osgParticle::Emitter::operator= ( const Emitter & )

inlineprotected

Definition at line 62 of file Emitter.h.

void osgParticle::Emitter::process ( double dt )

inlineprotectedvirtual

Implements osgParticle::ParticleProcessor.

Definition at line 95 of file Emitter.h.

Here is the call graph for this function:

void osgParticle::Emitter::setParticleTemplate ( const Particle & p )

inline

Set the particle template (particle is copied).

Definition at line 79 of file Emitter.h.

void osgParticle::Emitter::setUseDefaultTemplate ( bool v )

inline

Set whether the default particle template should be used. When this flag is true, the particle template is ignored, and the particle system's default template is used instead.

Definition at line 90 of file Emitter.h.

Member Data Documentation

Particle osgParticle::Emitter::_ptemp

protected

Definition at line 69 of file Emitter.h.

bool osgParticle::Emitter::_usedeftemp

protected

Definition at line 68 of file Emitter.h.

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

osg_head/include/osgParticle/Emitter.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation