#include <Placer.h>

Inheritance diagram for osgParticle::Placer:

Collaboration diagram for osgParticle::Placer:

Public Member Functions
	Placer ()

	Placer (const Placer &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	place (Particle *P) const =0
	Place a particle. Must be implemented in descendant classes. More...

virtual float	volume () const
	Volume of the placer. Can be implemented in descendant classes. More...

virtual osg::Vec3	getControlPosition () const =0
	Return the control position of particles that placer will generate. Must be implemented in descendant classes. More...

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

Placer &	operator= (const Placer &)

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

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

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

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 for implementing particle placers. A placer is an object which take a particle as input, and places it somewhere by setting its position vector. Placer objects are used by the ModularEmitter class as part of the particle emission process.

Definition at line 31 of file Placer.h.

Constructor & Destructor Documentation

osgParticle::Placer::Placer ( )

inline

Definition at line 56 of file Placer.h.

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

inline

Definition at line 61 of file Placer.h.

osgParticle::Placer::~Placer ( )

inlineprotected

Definition at line 50 of file Placer.h.

Member Function Documentation

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

inlinevirtual

return the name of the object's class type. Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osgParticle::CenteredPlacer.

Definition at line 37 of file Placer.h.

virtual osg::Vec3 osgParticle::Placer::getControlPosition ( ) const

pure virtual

Return the control position of particles that placer will generate. Must be implemented in descendant classes.

Implemented in osgParticle::BoxPlacer, osgParticle::MultiSegmentPlacer, osgParticle::SectorPlacer, osgParticle::SegmentPlacer, osgParticle::CompositePlacer, and osgParticle::PointPlacer.

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

inlinevirtual

Reimplemented from osg::Object.

Reimplemented in osgParticle::CenteredPlacer.

Definition at line 38 of file Placer.h.

virtual const char* osgParticle::Placer::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.

Reimplemented in osgParticle::CenteredPlacer.

Definition at line 36 of file Placer.h.

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

inlineprotected

Definition at line 51 of file Placer.h.

virtual void osgParticle::Placer::place ( Particle * P ) const

pure virtual

Place a particle. Must be implemented in descendant classes.

Implemented in osgParticle::BoxPlacer, osgParticle::MultiSegmentPlacer, osgParticle::SectorPlacer, osgParticle::SegmentPlacer, osgParticle::CompositePlacer, and osgParticle::PointPlacer.