An abstract base class used by ModularProgram to perform operations on particles before they are updated. More...

Inheritance diagram for osgParticle::Operator:

[legend]

Public Member Functions
	Operator ()

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

virtual const char *	libraryName () const
	return the name of the object's library. More...

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

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

bool	isEnabled () const
	Get whether this operator is enabled. More...

void	setEnabled (bool v)
	Enable or disable this operator. More...

virtual void	operateParticles (ParticleSystem *ps, double dt)
	Do something on all emitted particles. More...

virtual void	operate (Particle *P, double dt)=0
	Do something on a particle. More...

virtual void	beginOperate (Program *)
	Do something before processing particles via the `operate()` method. More...

virtual void	endOperate ()
	Do something after all particles have been processed. 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 Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...

virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...

std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...

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

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

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. 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...

template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)

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 ()
	Convenience 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...

template<class T >
void	setUserData (const ref_ptr< T > &ud)

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
	Convenience 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)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. 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...

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject 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	~Operator ()

Operator &	operator= (const Operator &)

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

Additional Inherited Members
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

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...

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

Detailed Description

An abstract base class used by ModularProgram to perform operations on particles before they are updated.

To implement a new operator, derive from this class and override the operate() method. You should also override the beginOperate() method to query the calling program for the reference frame used, and initialize the right transformations if needed.

Constructor & Destructor Documentation

osgParticle::Operator::Operator ( )

inline

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

inline

virtual osgParticle::Operator::~Operator ( )

inlineprotectedvirtual

Member Function Documentation

virtual void osgParticle::Operator::beginOperate ( Program * )

inlinevirtual

Do something before processing particles via the operate() method.

Overriding this method could be necessary to query the calling Program object for the current reference frame. If the reference frame is RELATIVE_RF, then your class should prepare itself to do all operations in local coordinates.

Reimplemented in osgParticle::DomainOperator, osgParticle::ExplosionOperator, osgParticle::FluidFrictionOperator, osgParticle::OrbitOperator, osgParticle::SinkOperator, osgParticle::AccelOperator, osgParticle::ForceOperator, and osgParticle::AngularAccelOperator.

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

inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Implements osg::Object.

virtual void osgParticle::Operator::endOperate ( )

inlinevirtual

Do something after all particles have been processed.

Reimplemented in osgParticle::DomainOperator.

bool osgParticle::Operator::isEnabled ( ) const

inline

Get whether this operator is enabled.

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

inlinevirtual

Reimplemented from osg::Object.

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

inlinevirtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

virtual void osgParticle::Operator::operate	(	Particle *	P,
		double	dt
	)

pure virtual

Do something on a particle.

You must override it in descendant classes. Common operations consist of modifying the particle's velocity vector. The dt parameter is the time elapsed from last operation.

Implemented in osgParticle::DomainOperator, osgParticle::ExplosionOperator, osgParticle::FluidFrictionOperator, osgParticle::OrbitOperator, osgParticle::AngularDampingOperator, osgParticle::DampingOperator, osgParticle::AccelOperator, osgParticle::ForceOperator, and osgParticle::AngularAccelOperator.

virtual void osgParticle::Operator::operateParticles	(	ParticleSystem *	ps,
		double	dt
	)

inlinevirtual

Do something on all emitted particles.

This method is called by ModularProgram objects to perform some operations on the particles. By default, it will call the operate() method for each particle. You must override it in descendant classes.

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

inlineprotected

void osgParticle::Operator::setEnabled ( bool v )

inline

Enable or disable this operator.

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

osgParticle/Operator

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation