#include <SinkOperator.h>

Inheritance diagram for osgParticle::SinkOperator:

Collaboration diagram for osgParticle::SinkOperator:

Public Types
enum	SinkTarget { SINK_POSITION, SINK_VELOCITY, SINK_ANGULAR_VELOCITY }

enum	SinkStrategy { SINK_INSIDE, SINK_OUTSIDE }

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

Public Member Functions
	SinkOperator ()

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

	META_Object (osgParticle, SinkOperator)

void	setSinkTarget (SinkTarget so)
	Set the sink strategy. More...

SinkTarget	getSinkTarget () const
	Get the sink strategy. More...

void	setSinkStrategy (SinkStrategy ss)
	Set the sink strategy. More...

SinkStrategy	getSinkStrategy () const
	Get the sink strategy. More...

void	beginOperate (Program *prg)
	Perform some initializations. Do not call this method manually. More...

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

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

	META_Object (osgParticle, DomainOperator)

void	addPointDomain (const osg::Vec3 &p)
	Add a point domain. More...

void	addLineSegmentDomain (const osg::Vec3 &v1, const osg::Vec3 &v2)
	Add a line segment domain. More...

void	addTriangleDomain (const osg::Vec3 &v1, const osg::Vec3 &v2, const osg::Vec3 &v3)
	Add a triangle domain. More...

void	addRectangleDomain (const osg::Vec3 &corner, const osg::Vec3 &w, const osg::Vec3 &h)
	Add a rectangle domain. More...

void	addPlaneDomain (const osg::Plane &plane)
	Add a plane domain. More...

void	addSphereDomain (const osg::Vec3 &c, float r)
	Add a sphere domain. More...

void	addBoxDomain (const osg::Vec3 &min, const osg::Vec3 &max)
	Add a box domain. More...

void	addDiskDomain (const osg::Vec3 &c, const osg::Vec3 &n, float r1, float r2=0.0f)
	Add a disk domain. More...

void	addDomain (const Domain &domain)
	Add a domain object directly, used by the .osg wrappers and serializers. More...

const Domain &	getDomain (unsigned int i) const
	Get a domain object directly, used by the .osg wrappers and serializers. More...

void	removeDomain (unsigned int i)
	Remove a domain at specific index. More...

void	removeAllDomains ()
	Remove all existing domains. More...

unsigned int	getNumDomains () const
	Get number of domains. More...

void	operate (Particle *P, double dt)
	Apply the acceleration to a particle. Do not call this method manually. More...

void	endOperate ()
	Perform some post-operations. Do not call this method manually. More...

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

	Operator (const Operator &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

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)

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

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual Object *	cloneType () const =0

virtual Object *	clone (const CopyOp &) const =0

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () 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	setThreadSafeRefUnref (bool threadSafe)

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)

virtual void	resizeGLObjectBuffers (unsigned int)

virtual void	releaseGLObjects (osg::State *=0) const

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	~SinkOperator ()

SinkOperator &	operator= (const SinkOperator &)

virtual void	handlePoint (const Domain &domain, Particle *P, double dt)

virtual void	handleLineSegment (const Domain &domain, Particle *P, double dt)

virtual void	handleTriangle (const Domain &domain, Particle *P, double dt)

virtual void	handleRectangle (const Domain &domain, Particle *P, double dt)

virtual void	handlePlane (const Domain &domain, Particle *P, double dt)

virtual void	handleSphere (const Domain &domain, Particle *P, double dt)

virtual void	handleBox (const Domain &domain, Particle *P, double dt)

virtual void	handleDisk (const Domain &domain, Particle *P, double dt)

const osg::Vec3 &	getValue (Particle *P)

void	kill (Particle *P, bool insideDomain)

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

DomainOperator &	operator= (const DomainOperator &)

void	computeNewBasis (const osg::Vec3 &, const osg::Vec3 &, osg::Vec3 &, osg::Vec3 &)

void	ignore (const std::string &func)

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

Operator &	operator= (const Operator &)

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
SinkTarget	_sinkTarget

SinkStrategy	_sinkStrategy

Protected Attributes inherited from osgParticle::DomainOperator
std::vector< Domain >	_domains

std::vector< Domain >	_backupDomains

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

A sink operator kills particles if positions or velocities inside/outside the specified domain. Refer to David McAllister's Particle System API (http://www.particlesystems.org)

Definition at line 28 of file SinkOperator.h.

Member Enumeration Documentation

enum osgParticle::SinkOperator::SinkStrategy

Enumerator
SINK_INSIDE
SINK_OUTSIDE

Definition at line 32 of file SinkOperator.h.

enum osgParticle::SinkOperator::SinkTarget

Enumerator
SINK_POSITION
SINK_VELOCITY
SINK_ANGULAR_VELOCITY

Definition at line 31 of file SinkOperator.h.

Constructor & Destructor Documentation

osgParticle::SinkOperator::SinkOperator ( )

inline

Definition at line 34 of file SinkOperator.h.

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

inline

Definition at line 38 of file SinkOperator.h.

virtual osgParticle::SinkOperator::~SinkOperator ( )

inlineprotectedvirtual

Definition at line 60 of file SinkOperator.h.

Member Function Documentation

void osgParticle::SinkOperator::beginOperate ( Program * prg )

virtual

Perform some initializations. Do not call this method manually.

Reimplemented from osgParticle::DomainOperator.

SinkStrategy osgParticle::SinkOperator::getSinkStrategy ( ) const

inline

Get the sink strategy.

Definition at line 54 of file SinkOperator.h.

SinkTarget osgParticle::SinkOperator::getSinkTarget ( ) const

inline

Get the sink strategy.

Definition at line 48 of file SinkOperator.h.

const osg::Vec3 & osgParticle::SinkOperator::getValue ( Particle * P )

inlineprotected

Definition at line 81 of file SinkOperator.h.

Here is the call graph for this function:

virtual void osgParticle::SinkOperator::handleBox	(	const Domain &	domain,
		Particle *	P,
		double	dt
	)

protectedvirtual

Reimplemented from osgParticle::DomainOperator.

virtual void osgParticle::SinkOperator::handleDisk	(	const Domain &	domain,
		Particle *	P,
		double	dt
	)

protectedvirtual

Reimplemented from osgParticle::DomainOperator.

virtual void osgParticle::SinkOperator::handleLineSegment	(	const Domain &	domain,
		Particle *	P,
		double	dt
	)

protectedvirtual

Reimplemented from osgParticle::DomainOperator.

virtual void osgParticle::SinkOperator::handlePlane	(	const Domain &	domain,
		Particle *	P,
		double	dt
	)

protectedvirtual

Reimplemented from osgParticle::DomainOperator.

virtual void osgParticle::SinkOperator::handlePoint	(	const Domain &	domain,
		Particle *	P,
		double	dt
	)

protectedvirtual

Reimplemented from osgParticle::DomainOperator.

virtual void osgParticle::SinkOperator::handleRectangle	(	const Domain &	domain,
		Particle *	P,
		double	dt
	)

protectedvirtual

Reimplemented from osgParticle::DomainOperator.

virtual void osgParticle::SinkOperator::handleSphere	(	const Domain &	domain,
		Particle *	P,
		double	dt
	)

protectedvirtual

Reimplemented from osgParticle::DomainOperator.

virtual void osgParticle::SinkOperator::handleTriangle	(	const Domain &	domain,
		Particle *	P,
		double	dt
	)

protectedvirtual

Reimplemented from osgParticle::DomainOperator.

void osgParticle::SinkOperator::kill	(	Particle *	P,
		bool	insideDomain
	)

inlineprotected

Definition at line 91 of file SinkOperator.h.

Here is the call graph for this function:

osgParticle::SinkOperator::META_Object	(	osgParticle	,
		SinkOperator
	)

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

inlineprotected

Definition at line 61 of file SinkOperator.h.

void osgParticle::SinkOperator::setSinkStrategy ( SinkStrategy ss )

inline

Set the sink strategy.

Definition at line 51 of file SinkOperator.h.

void osgParticle::SinkOperator::setSinkTarget ( SinkTarget so )

inline

Set the sink strategy.

Definition at line 45 of file SinkOperator.h.

Member Data Documentation

SinkStrategy osgParticle::SinkOperator::_sinkStrategy

protected

Definition at line 76 of file SinkOperator.h.

SinkTarget osgParticle::SinkOperator::_sinkTarget

protected

Definition at line 75 of file SinkOperator.h.

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

osg_head/include/osgParticle/SinkOperator.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation