An abstract base class for particle emitters. More...

Inheritance 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
	return the name of the node's library. More...

virtual const char *	className () const
	return the name of the node's class type. More...

virtual bool	isSameKindAs (const osg::Object *obj) const
	return true if this and obj are of the same kind of object. More...

virtual void	accept (osg::NodeVisitor &nv)
	Visitor Pattern : calls the apply method of a NodeVisitor with this node's type. More...

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)
	Set whether the default particle template should be used. More...

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
	Check whether the processor is alive with respect to start time and life duration. More...

void	traverse (osg::NodeVisitor &nv)
	Traverse downwards : calls children's accept method with NodeVisitor. More...

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
	Compute the bounding sphere around Node's geometry or children. More...

Public Member Functions inherited from osg::Node
	Node ()
	Construct a node. More...

	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

virtual Object *	cloneType () const
	clone an object of the same type as the node. More...

virtual Object *	clone (const CopyOp &copyop) const
	return a clone of a node, with Object* return type. More...

virtual Group *	asGroup ()
	convert 'this' into a Group pointer if Node is a Group, otherwise return 0. More...

virtual const Group *	asGroup () const
	convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0. More...

virtual Transform *	asTransform ()
	Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0. More...

virtual const Transform *	asTransform () const
	convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0. More...

virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...

virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...

virtual Switch *	asSwitch ()
	Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0. More...

virtual const Switch *	asSwitch () const
	convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0. More...

virtual Geode *	asGeode ()
	Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0. More...

virtual const Geode *	asGeode () const
	convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0. More...

virtual osgTerrain::Terrain *	asTerrain ()
	Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0. More...

virtual const osgTerrain::Terrain *	asTerrain () const
	convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0. More...

virtual void	ascend (NodeVisitor &nv)
	Traverse upwards : calls parents' accept method with NodeVisitor. More...

const ParentList &	getParents () const
	Get the parent list of node. More...

ParentList	getParents ()
	Get the a copy of parent list of node. More...

Group *	getParent (unsigned int i)

const Group *	getParent (unsigned int i) const
	Get a single const parent of node. More...

unsigned int	getNumParents () const
	Get the number of parents of node. More...

NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
	Get the list of node paths parent paths. More...

MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
	Get the list of matrices that transform this node from local coordinates to world coordinates. More...

void	setUpdateCallback (NodeCallback *nc)
	Set update node callback, called during update traversal. More...

NodeCallback *	getUpdateCallback ()
	Get update node callback, called during update traversal. More...

const NodeCallback *	getUpdateCallback () const
	Get const update node callback, called during update traversal. More...

void	addUpdateCallback (NodeCallback *nc)
	Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one. More...

void	removeUpdateCallback (NodeCallback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

unsigned int	getNumChildrenRequiringUpdateTraversal () const
	Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children. More...

void	setEventCallback (NodeCallback *nc)
	Set event node callback, called during event traversal. More...

NodeCallback *	getEventCallback ()
	Get event node callback, called during event traversal. More...

const NodeCallback *	getEventCallback () const
	Get const event node callback, called during event traversal. More...

void	addEventCallback (NodeCallback *nc)
	Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one. More...

void	removeEventCallback (NodeCallback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

unsigned int	getNumChildrenRequiringEventTraversal () const
	Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children. More...

void	setCullCallback (NodeCallback *nc)
	Set cull node callback, called during cull traversal. More...

NodeCallback *	getCullCallback ()
	Get cull node callback, called during cull traversal. More...

const NodeCallback *	getCullCallback () const
	Get const cull node callback, called during cull traversal. More...

void	addCullCallback (NodeCallback *nc)
	Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one. More...

void	removeCullCallback (NodeCallback *nc)
	Convenience method that removes a given callback from a node, even if that callback is nested. More...

void	setCullingActive (bool active)
	Set the view frustum/small feature culling of this node to be active or inactive. More...

bool	getCullingActive () const
	Get the view frustum/small feature _cullingActive flag for this node. More...

unsigned int	getNumChildrenWithCullingDisabled () const
	Get the number of Children of this node which have culling disabled. More...

bool	isCullingActive () const
	Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal. More...

unsigned int	getNumChildrenWithOccluderNodes () const
	Get the number of Children of this node which are or have OccluderNode's. More...

bool	containsOccluderNodes () const
	return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes. More...

void	setNodeMask (NodeMask nm)
	Set the node mask. More...

NodeMask	getNodeMask () const
	Get the node Mask. More...

void	setStateSet (osg::StateSet *stateset)
	Set the node's StateSet. More...

osg::StateSet *	getOrCreateStateSet ()
	return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet. More...

osg::StateSet *	getStateSet ()
	Return the node's StateSet. More...

const osg::StateSet *	getStateSet () const
	Return the node's const StateSet. More...

void	setDescriptions (const DescriptionList &descriptions)
	Set the list of string descriptions. More...

DescriptionList &	getDescriptions ()
	Get the description list of the node. More...

const DescriptionList &	getDescriptions () const
	Get the const description list of the const node. More...

const std::string &	getDescription (unsigned int i) const
	Get a single const description of the const node. More...

std::string &	getDescription (unsigned int i)
	Get a single description of the node. More...

unsigned int	getNumDescriptions () const
	Get the number of descriptions of the node. More...

void	addDescription (const std::string &desc)
	Add a description string to the node. More...

void	setInitialBound (const osg::BoundingSphere &bsphere)
	Set the initial bounding volume to use when computing the overall bounding volume. More...

const BoundingSphere &	getInitialBound () const
	Set the initial bounding volume to use when computing the overall bounding volume. More...

void	dirtyBound ()
	Mark this node's bounding sphere dirty. More...

const BoundingSphere &	getBound () const
	Get the bounding sphere of node. More...

void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
	Set the compute bound callback to override the default computeBound. More...

ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
	Get the compute bound callback. More...

const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const
	Get the const compute bound callback. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...

virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size. More...

virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...

Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...

virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...

void	setName (const char *name)
	Set the name of object using a C style string. More...

const std::string &	getName () const
	Get the name of object. More...

void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...

DataVariance	getDataVariance () const
	Get the data variance of this object. More...

virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...

void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...

osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...

virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...

virtual Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () const
	Get const user data. More...

template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...

template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template More...

Public Member Functions inherited from osg::Referenced
	Referenced ()

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...

OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...

int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	referenceCount () const
	Return the number of pointers currently referencing this object. More...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...

void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...

void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

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 ()
	Node destructor. More...

void	addParent (osg::Group *node)

void	removeParent (osg::Group *node)

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 ()
	Object destructor. More...

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

Additional Inherited Members
Public Types inherited from osgParticle::ParticleProcessor
enum	ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF }

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...

static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...

static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

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.

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

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.

References osg::NodeVisitor::apply(), osg::NodeVisitor::popFromNodePath(), osg::NodeVisitor::pushOntoNodePath(), and osg::NodeVisitor::validNodeMask().

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

inlinevirtual

return the name of the node's class type.

Reimplemented from osgParticle::ParticleProcessor.

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

protectedpure virtual

Implemented in osgParticle::ModularEmitter.

Referenced by process().

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

inline

Get the particle template.

References _ptemp.

bool osgParticle::Emitter::getUseDefaultTemplate ( ) const

inline

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

References _usedeftemp.

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.

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

inlinevirtual

return the name of the node's library.

Reimplemented from osgParticle::ParticleProcessor.

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

inlineprotected

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

inlineprotectedvirtual

Implements osgParticle::ParticleProcessor.

References emitParticles().

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

inline

Set the particle template (particle is copied).

References _ptemp, and _usedeftemp.

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.

References _usedeftemp.

Member Data Documentation

Particle osgParticle::Emitter::_ptemp

protected

Referenced by getParticleTemplate(), and setParticleTemplate().

bool osgParticle::Emitter::_usedeftemp

protected

Referenced by getUseDefaultTemplate(), setParticleTemplate(), and setUseDefaultTemplate().

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

osgParticle/Emitter

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation