#include <ParticleSystem.h>

Inheritance diagram for osgParticle::ParticleSystem:

Collaboration diagram for osgParticle::ParticleSystem:

Public Types
enum	Alignment { BILLBOARD, FIXED }

enum	ParticleScaleReferenceFrame { LOCAL_COORDINATES, WORLD_COORDINATES }

enum	SortMode { NO_SORT, SORT_FRONT_TO_BACK, SORT_BACK_TO_FRONT }

typedef OpenThreads::Mutex	ReadWriterMutex

typedef OpenThreads::ScopedLock < OpenThreads::Mutex >	ScopedReadLock

typedef OpenThreads::ScopedLock < OpenThreads::Mutex >	ScopedWriteLock

Public Types inherited from osg::Drawable
enum	AttributeTypes { VERTICES = 0, WEIGHTS = 1, NORMALS = 2, COLORS = 3, SECONDARY_COLORS = 4, FOG_COORDS = 5, ATTRIBUTE_6 = 6, ATTRIBUTE_7 = 7, TEXTURE_COORDS = 8, TEXTURE_COORDS_0 = TEXTURE_COORDS, TEXTURE_COORDS_1 = TEXTURE_COORDS_0+1, TEXTURE_COORDS_2 = TEXTURE_COORDS_0+2, TEXTURE_COORDS_3 = TEXTURE_COORDS_0+3, TEXTURE_COORDS_4 = TEXTURE_COORDS_0+4, TEXTURE_COORDS_5 = TEXTURE_COORDS_0+5, TEXTURE_COORDS_6 = TEXTURE_COORDS_0+6, TEXTURE_COORDS_7 = TEXTURE_COORDS_0+7 }

typedef unsigned int	AttributeType

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 }

Public Member Functions
	ParticleSystem ()

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

	META_Object (osgParticle, ParticleSystem)

Alignment	getParticleAlignment () const
	Get the alignment type of particles. More...

void	setParticleAlignment (Alignment a)
	Set the alignment type of particles. More...

const osg::Vec3 &	getAlignVectorX () const
	Get the X-axis alignment vector. More...

void	setAlignVectorX (const osg::Vec3 &v)
	Set the X-axis alignment vector. More...

const osg::Vec3 &	getAlignVectorY () const
	Get the Y-axis alignment vector. More...

void	setAlignVectorY (const osg::Vec3 &v)
	Set the Y-axis alignment vector. More...

void	setAlignVectors (const osg::Vec3 &X, const osg::Vec3 &Y)
	Set the alignment vectors. More...

void	setParticleScaleReferenceFrame (ParticleScaleReferenceFrame rf)

ParticleScaleReferenceFrame	getParticleScaleReferenceFrame () const

const osg::BoundingBox &	getDefaultBoundingBox () const
	Get the default bounding box. More...

void	setDefaultBoundingBox (const osg::BoundingBox &bbox)

bool	getUseVertexArray () const
	Return true if we use vertex arrays for rendering particles. More...

void	setUseVertexArray (bool v)

bool	getUseShaders () const
	Return true if shaders are required. More...

void	setUseShaders (bool v)

bool	getDoublePassRendering () const
	Get the double pass rendering flag. More...

void	setDoublePassRendering (bool v)

bool	getFrozen () const
	Return true if the particle system is frozen. More...

bool	isFrozen () const

void	setFrozen (bool v)

int	numParticles () const
	Get the number of allocated particles (alive + dead). More...

int	numDeadParticles () const
	Get the number of dead particles. More...

bool	areAllParticlesDead () const
	Get whether all particles are dead. More...

Particle *	getParticle (int i)
	Get a pointer to the i-th particle. More...

const Particle *	getParticle (int i) const
	Get a const pointer to the i-th particle. More...

virtual Particle *	createParticle (const Particle *ptemplate)
	Create a new particle from the specified template (or the default one if `ptemplate` is null). More...

virtual void	destroyParticle (int i)
	Destroy the i-th particle. More...

virtual void	reuseParticle (int i)
	Reuse the i-th particle. More...

unsigned int	getLastFrameNumber () const
	Get the last frame number. More...

double &	getDeltaTime (double currentTime)
	Get the unique delta time for emitters and updaters to use. More...

Particle &	getDefaultParticleTemplate ()
	Get a reference to the default particle template. More...

const Particle &	getDefaultParticleTemplate () const
	Get a const reference to the default particle template. More...

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

bool	getFreezeOnCull () const
	Get whether the particle system can freeze when culled. More...

void	setFreezeOnCull (bool v)
	Set whether the particle system can freeze when culled (default is true) More...

void	setDefaultAttributes (const std::string &texturefile="", bool emissive_particles=true, bool lighting=false, int texture_unit=0)

void	setDefaultAttributesUsingShaders (const std::string &texturefile="", bool emissive_particles=true, int texture_unit=0)

int	getLevelOfDetail () const
	(EXPERIMENTAL) Get the level of detail. More...

void	setLevelOfDetail (int v)

SortMode	getSortMode () const
	Get the sort mode. More...

void	setSortMode (SortMode mode)

double	getVisibilityDistance () const
	Get the visibility distance. More...

void	setVisibilityDistance (double distance)

virtual void	update (double dt, osg::NodeVisitor &nv)
	Update the particles. Don't call this directly, use a `ParticleSystemUpdater` instead. More...

virtual void	drawImplementation (osg::RenderInfo &renderInfo) const

virtual osg::BoundingBox	computeBoundingBox () const

ReadWriterMutex *	getReadWriteMutex () const

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

	Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

	META_Node (osg, Drawable)

virtual Drawable *	asDrawable ()

virtual const Drawable *	asDrawable () const

virtual void	computeDataVariance ()

MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const

void	setInitialBound (const osg::BoundingBox &bbox)

const BoundingBox &	getInitialBound () const

const BoundingSphere &	getBound () const

const BoundingBox &	getBoundingBox () const

virtual BoundingSphere	computeBound () const

void	setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)

ComputeBoundingBoxCallback *	getComputeBoundingBoxCallback ()

const ComputeBoundingBoxCallback *	getComputeBoundingBoxCallback () const

void	setShape (Shape *shape)

Shape *	getShape ()

const Shape *	getShape () const

void	setSupportsDisplayList (bool flag)

bool	getSupportsDisplayList () const

void	setUseDisplayList (bool flag)

bool	getUseDisplayList () const

GLuint &	getDisplayList (unsigned int contextID) const

virtual void	setUseVertexBufferObjects (bool flag)

bool	getUseVertexBufferObjects () const

virtual void	dirtyDisplayList ()

virtual unsigned int	getGLObjectSizeHint () const

void	draw (RenderInfo &renderInfo) const

virtual void	compileGLObjects (RenderInfo &renderInfo) const

virtual void	setThreadSafeRefUnref (bool threadSafe)

virtual void	resizeGLObjectBuffers (unsigned int maxSize)

virtual void	releaseGLObjects (State *state=0) const

virtual void	setDrawCallback (DrawCallback *dc)

DrawCallback *	getDrawCallback ()

const DrawCallback *	getDrawCallback () const

virtual bool	supports (const AttributeFunctor &) const

virtual void	accept (AttributeFunctor &)

virtual bool	supports (const ConstAttributeFunctor &) const

virtual void	accept (ConstAttributeFunctor &) const

virtual bool	supports (const PrimitiveFunctor &) const

virtual void	accept (PrimitiveFunctor &) const

virtual bool	supports (const PrimitiveIndexFunctor &) const

virtual void	accept (PrimitiveIndexFunctor &) 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 bool	isSameKindAs (const Object *obj) const

virtual const char *	libraryName () const

virtual const char *	className () const

virtual Node *	asNode ()

virtual const Node *	asNode () 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	accept (NodeVisitor &nv)

virtual void	ascend (NodeVisitor &nv)

virtual void	traverse (NodeVisitor &)

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

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

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 Types
typedef std::vector< Particle >	Particle_vector

typedef std::stack< Particle * >	Death_stack

Protected Types inherited from osg::Drawable
typedef osg::buffered_value < GLuint >	GLObjectList

Protected Member Functions
virtual	~ParticleSystem ()

ParticleSystem &	operator= (const ParticleSystem &)

void	update_bounds (const osg::Vec3 &p, float r)

void	single_pass_render (osg::RenderInfo &renderInfo, const osg::Matrix &modelview) const

void	render_vertex_array (osg::RenderInfo &renderInfo) const

Protected Member Functions inherited from osg::Drawable
Drawable &	operator= (const Drawable &)

virtual	~Drawable ()

void	setBound (const BoundingBox &bb) const

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

Death_stack	_deadparts

osg::BoundingBox	_def_bbox

Alignment	_alignment

osg::Vec3	_align_X_axis

osg::Vec3	_align_Y_axis

ParticleScaleReferenceFrame	_particleScaleReferenceFrame

bool	_useVertexArray

bool	_useShaders

bool	_dirty_uniforms

bool	_doublepass

bool	_frozen

osg::Vec3	_bmin

osg::Vec3	_bmax

bool	_reset_bounds_flag

bool	_bounds_computed

Particle	_def_ptemp

unsigned int	_last_frame

bool	_dirty_dt

bool	_freeze_on_cull

double	_t0

double	_dt

int	_detail

SortMode	_sortMode

double	_visibilityDistance

int	_draw_count

ReadWriterMutex	_readWriteMutex

Protected Attributes inherited from osg::Drawable
BoundingBox	_initialBound

ref_ptr < ComputeBoundingBoxCallback >	_computeBoundCallback

BoundingBox	_boundingBox

bool	_boundingBoxComputed

ref_ptr< Shape >	_shape

bool	_supportsDisplayList

bool	_useDisplayList

bool	_supportsVertexBufferObjects

bool	_useVertexBufferObjects

GLObjectList	_globjList

ref_ptr< UpdateCallback >	_drawableUpdateCallback

ref_ptr< EventCallback >	_drawableEventCallback

ref_ptr< CullCallback >	_drawableCullCallback

ref_ptr< DrawCallback >	_drawCallback

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
Static Public Member Functions inherited from osg::Drawable
static GLuint	generateDisplayList (unsigned int contextID, unsigned int sizeHint=0)

static void	setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)

static unsigned int	getMinimumNumberOfDisplayListsToRetainInCache ()

static void	deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)

static void	flushAllDeletedDisplayLists (unsigned int contextID)

static void	discardAllDeletedDisplayLists (unsigned int contextID)

static void	flushDeletedDisplayLists (unsigned int contextID, double &availableTime)

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

Static Public Attributes inherited from osg::Drawable
static unsigned int	s_numberDrawablesReusedLastInLastFrame

static unsigned int	s_numberNewDrawablesInLastFrame

static unsigned int	s_numberDeletedDrawablesInLastFrame

Detailed Description

The heart of this class library; its purpose is to hold a set of particles and manage particle creation, update, rendering and destruction. You can add this drawable to any Geode as you usually do with other Drawable classes. Each instance of ParticleSystem is a separate set of particles; it provides the interface for creating particles and iterating through them (see the Emitter and Program classes).

Definition at line 54 of file ParticleSystem.h.

Member Typedef Documentation

typedef std::stack<Particle*> osgParticle::ParticleSystem::Death_stack

protected

Definition at line 271 of file ParticleSystem.h.

typedef std::vector<Particle> osgParticle::ParticleSystem::Particle_vector

protected

Definition at line 270 of file ParticleSystem.h.

typedef OpenThreads::Mutex osgParticle::ParticleSystem::ReadWriterMutex

Definition at line 253 of file ParticleSystem.h.

typedef OpenThreads::ScopedLock<OpenThreads::Mutex> osgParticle::ParticleSystem::ScopedReadLock

Definition at line 254 of file ParticleSystem.h.

typedef OpenThreads::ScopedLock<OpenThreads::Mutex> osgParticle::ParticleSystem::ScopedWriteLock

Definition at line 255 of file ParticleSystem.h.

Member Enumeration Documentation

enum osgParticle::ParticleSystem::Alignment

Enumerator
BILLBOARD
FIXED

Definition at line 57 of file ParticleSystem.h.

enum osgParticle::ParticleSystem::ParticleScaleReferenceFrame

Enumerator
LOCAL_COORDINATES
WORLD_COORDINATES

Definition at line 90 of file ParticleSystem.h.

enum osgParticle::ParticleSystem::SortMode

Enumerator
NO_SORT
SORT_FRONT_TO_BACK
SORT_BACK_TO_FRONT

Definition at line 218 of file ParticleSystem.h.

Constructor & Destructor Documentation

osgParticle::ParticleSystem::ParticleSystem ( )

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

virtual osgParticle::ParticleSystem::~ParticleSystem ( )

protectedvirtual

Member Function Documentation

bool osgParticle::ParticleSystem::areAllParticlesDead ( ) const

inline

Get whether all particles are dead.

Definition at line 161 of file ParticleSystem.h.

virtual osg::BoundingBox osgParticle::ParticleSystem::computeBoundingBox ( ) const

virtual

Compute the bounding box around Drawables's geometry.

Reimplemented from osg::Drawable.

Particle * osgParticle::ParticleSystem::createParticle ( const Particle * ptemplate )

inlinevirtual

Create a new particle from the specified template (or the default one if ptemplate is null).

Reimplemented in osgParticle::ConnectedParticleSystem.

Definition at line 501 of file ParticleSystem.h.

void osgParticle::ParticleSystem::destroyParticle ( int i )

inlinevirtual

Destroy the i-th particle.

Definition at line 401 of file ParticleSystem.h.

virtual void osgParticle::ParticleSystem::drawImplementation ( osg::RenderInfo & ) const

virtual

drawImplementation(RenderInfo&) is a pure virtual method for the actual implementation of OpenGL drawing calls, such as vertex arrays and primitives, that must be implemented in concrete subclasses of the Drawable base class, examples include osg::Geometry and osg::ShapeDrawable. drawImplementation(RenderInfo&) is called from the draw(RenderInfo&) method, with the draw method handling management of OpenGL display lists, and drawImplementation(RenderInfo&) handling the actual drawing itself.

Parameters

renderInfo The osg::RenderInfo object that encapsulates the current rendering information including the osg::State OpenGL state for the current graphics context.

Reimplemented from osg::Drawable.

Reimplemented in osgParticle::ConnectedParticleSystem.

const osg::Vec3 & osgParticle::ParticleSystem::getAlignVectorX ( ) const

inline

Get the X-axis alignment vector.

Definition at line 325 of file ParticleSystem.h.

const osg::Vec3 & osgParticle::ParticleSystem::getAlignVectorY ( ) const

inline

Get the Y-axis alignment vector.

Definition at line 335 of file ParticleSystem.h.

const osg::BoundingBox & osgParticle::ParticleSystem::getDefaultBoundingBox ( ) const

inline

Get the default bounding box.

Definition at line 361 of file ParticleSystem.h.

Particle & osgParticle::ParticleSystem::getDefaultParticleTemplate ( )

inline

Get a reference to the default particle template.

Definition at line 442 of file ParticleSystem.h.

const Particle & osgParticle::ParticleSystem::getDefaultParticleTemplate ( ) const

inline

Get a const reference to the default particle template.

Definition at line 447 of file ParticleSystem.h.

double & osgParticle::ParticleSystem::getDeltaTime ( double currentTime )

inline

Get the unique delta time for emitters and updaters to use.

Definition at line 411 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::getDoublePassRendering ( ) const

inline

Get the double pass rendering flag.

Definition at line 371 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::getFreezeOnCull ( ) const

inline

Get whether the particle system can freeze when culled.

Definition at line 457 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::getFrozen ( ) const

inline

Return true if the particle system is frozen.

Definition at line 146 of file ParticleSystem.h.

unsigned int osgParticle::ParticleSystem::getLastFrameNumber ( ) const

inline

Get the last frame number.

Definition at line 406 of file ParticleSystem.h.

int osgParticle::ParticleSystem::getLevelOfDetail ( ) const

inline

(EXPERIMENTAL) Get the level of detail.

Definition at line 467 of file ParticleSystem.h.

Particle * osgParticle::ParticleSystem::getParticle ( int i )

inline

Get a pointer to the i-th particle.

Definition at line 391 of file ParticleSystem.h.

Here is the caller graph for this function:

const Particle * osgParticle::ParticleSystem::getParticle ( int i ) const

inline

Get a const pointer to the i-th particle.

Definition at line 396 of file ParticleSystem.h.

ParticleSystem::Alignment osgParticle::ParticleSystem::getParticleAlignment ( ) const

inline

Get the alignment type of particles.

Definition at line 315 of file ParticleSystem.h.

ParticleScaleReferenceFrame osgParticle::ParticleSystem::getParticleScaleReferenceFrame ( ) const

inline

Get whether the particles should be scaled relative to world coordaintes or local coordinates.

Definition at line 100 of file ParticleSystem.h.

ReadWriterMutex* osgParticle::ParticleSystem::getReadWriteMutex ( ) const

inline

Definition at line 258 of file ParticleSystem.h.

ParticleSystem::SortMode osgParticle::ParticleSystem::getSortMode ( ) const

inline

Get the sort mode.

Definition at line 478 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::getUseShaders ( ) const

inline

Return true if shaders are required.

Definition at line 125 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::getUseVertexArray ( ) const

inline

Return true if we use vertex arrays for rendering particles.

Definition at line 114 of file ParticleSystem.h.

double osgParticle::ParticleSystem::getVisibilityDistance ( ) const

inline

Get the visibility distance.

Definition at line 488 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::isFrozen ( ) const

inline

Definition at line 351 of file ParticleSystem.h.

osgParticle::ParticleSystem::META_Object	(	osgParticle	,
		ParticleSystem
	)

int osgParticle::ParticleSystem::numDeadParticles ( ) const

inline

Get the number of dead particles.

Definition at line 386 of file ParticleSystem.h.

int osgParticle::ParticleSystem::numParticles ( ) const

inline

Get the number of allocated particles (alive + dead).

Definition at line 381 of file ParticleSystem.h.

Here is the caller graph for this function:

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

inlineprotected

Definition at line 264 of file ParticleSystem.h.

void osgParticle::ParticleSystem::render_vertex_array ( osg::RenderInfo & renderInfo ) const

protected

virtual void osgParticle::ParticleSystem::reuseParticle ( int i )

inlinevirtual

Reuse the i-th particle.

Reimplemented in osgParticle::ConnectedParticleSystem.

Definition at line 176 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setAlignVectors	(	const osg::Vec3 &	X,
		const osg::Vec3 &	Y
	)

inline

Set the alignment vectors.

Definition at line 345 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setAlignVectorX ( const osg::Vec3 & v )

inline

Set the X-axis alignment vector.

Definition at line 330 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setAlignVectorY ( const osg::Vec3 & v )

inline

Set the Y-axis alignment vector.

Definition at line 340 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setDefaultAttributes	(	const std::string &	texturefile = `""`,
		bool	emissive_particles = `true`,
		bool	lighting = `false`,
		int	texture_unit = `0`
	)

A useful method to set the most common StateAttribute's in one call. If texturefile is empty, then texturing is turned off.

void osgParticle::ParticleSystem::setDefaultAttributesUsingShaders	(	const std::string &	texturefile = `""`,
		bool	emissive_particles = `true`,
		int	texture_unit = `0`
	)

A useful method to set the most common StateAttribute and use GLSL shaders to draw particles. At present, when enabling shaders in the particle system, user-defined shapes will not be usable. If texturefile is empty, then texturing is turned off.

void osgParticle::ParticleSystem::setDefaultBoundingBox ( const osg::BoundingBox & bbox )

inline

Set the default bounding box. The default bounding box is used when a real bounding box cannot be computed, for example because no particles has been updated yet.

Definition at line 366 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setDefaultParticleTemplate ( const Particle & p )

inline

Set the default particle template (particle is copied).

Definition at line 452 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setDoublePassRendering ( bool v )

inline

Set the double pass rendering flag. Double pass rendering avoids overdraw problems between particle systems and other opaque objects. If you can render all the particle systems after the opaque objects, then double pass is not necessary and can be turned off (best choice). If you set the default attributes with setDefaultAttributes, then the particle system will fall into a transparent bin.

Definition at line 376 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setFreezeOnCull ( bool v )

inline

Set whether the particle system can freeze when culled (default is true)

Definition at line 462 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setFrozen ( bool v )

inline

Set or reset the frozen state. When the particle system is frozen, emitters and programs won't do anything on it.

Definition at line 356 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setLevelOfDetail ( int v )

inline

(EXPERIMENTAL) Set the level of detail. The total number of particles is divided by the detail value to get the actual number of particles to be drawn. This value must be greater than zero.

Definition at line 472 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setParticleAlignment ( Alignment a )

inline

Set the alignment type of particles.

Definition at line 320 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setParticleScaleReferenceFrame ( ParticleScaleReferenceFrame rf )

inline

Set whether the particles should be scaled relative to world coordaintes or local coordinates.

Definition at line 97 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setSortMode ( SortMode mode )

inline

Set the sort mode. It will force resorting the particle list by the Z direction of the view coordinates. This can be used for the purpose of transparent rendering or setVisibilityDistance().

Definition at line 483 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setUseShaders ( bool v )

inline

Set to use GLSL shaders for rendering particles. Particles' parameters will be used as shader attribute arrays, and necessary variables, including the visibility distance, texture, etc, will be used and updated as uniforms.

Definition at line 131 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setUseVertexArray ( bool v )

inline

Set to use vertex arrays for rendering particles. Lots of variables will be omitted: particles' shape, alive or not, visibility distance, and so on, so the rendering result is not as good as we wish (although it's fast than using glBegin/glEnd). We had better use this for GLSL shaders, in which particle parameters will be kept as uniforms. This method is called automatically by setDefaultAttributesUsingShaders().

Definition at line 122 of file ParticleSystem.h.

void osgParticle::ParticleSystem::setVisibilityDistance ( double distance )

inline

Set the visibility distance which allows the particles to be rendered only when depth is inside the distance. When using shaders, it can work well directly; otherwise the sort mode should also be set to pre-compute depth.

Definition at line 493 of file ParticleSystem.h.

void osgParticle::ParticleSystem::single_pass_render	(	osg::RenderInfo &	renderInfo,
		const osg::Matrix &	modelview
	)		const

protected

virtual void osgParticle::ParticleSystem::update	(	double	dt,
		osg::NodeVisitor &	nv
	)

virtual

Update the particles. Don't call this directly, use a ParticleSystemUpdater instead.

void osgParticle::ParticleSystem::update_bounds	(	const osg::Vec3 &	p,
		float	r
	)

inlineprotected

Definition at line 424 of file ParticleSystem.h.

Here is the call graph for this function:

Member Data Documentation

osg::Vec3 osgParticle::ParticleSystem::_align_X_axis

protected

Definition at line 279 of file ParticleSystem.h.

osg::Vec3 osgParticle::ParticleSystem::_align_Y_axis

protected

Definition at line 280 of file ParticleSystem.h.

Alignment osgParticle::ParticleSystem::_alignment

protected

Definition at line 278 of file ParticleSystem.h.

osg::Vec3 osgParticle::ParticleSystem::_bmax

protected

Definition at line 291 of file ParticleSystem.h.

osg::Vec3 osgParticle::ParticleSystem::_bmin

protected

Definition at line 290 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_bounds_computed

protected

Definition at line 294 of file ParticleSystem.h.

Death_stack osgParticle::ParticleSystem::_deadparts

protected

Definition at line 274 of file ParticleSystem.h.

osg::BoundingBox osgParticle::ParticleSystem::_def_bbox

protected

Definition at line 276 of file ParticleSystem.h.

Particle osgParticle::ParticleSystem::_def_ptemp

protected

Definition at line 296 of file ParticleSystem.h.

int osgParticle::ParticleSystem::_detail

protected

Definition at line 304 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_dirty_dt

mutableprotected

Definition at line 298 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_dirty_uniforms

protected

Definition at line 285 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_doublepass

protected

Definition at line 287 of file ParticleSystem.h.

int osgParticle::ParticleSystem::_draw_count

mutableprotected

Definition at line 308 of file ParticleSystem.h.

double osgParticle::ParticleSystem::_dt

protected

Definition at line 302 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_freeze_on_cull

protected

Definition at line 299 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_frozen

protected

Definition at line 288 of file ParticleSystem.h.

unsigned int osgParticle::ParticleSystem::_last_frame

mutableprotected

Definition at line 297 of file ParticleSystem.h.

Particle_vector osgParticle::ParticleSystem::_particles

protected

Definition at line 273 of file ParticleSystem.h.

ParticleScaleReferenceFrame osgParticle::ParticleSystem::_particleScaleReferenceFrame

protected

Definition at line 281 of file ParticleSystem.h.

ReadWriterMutex osgParticle::ParticleSystem::_readWriteMutex

mutableprotected

Definition at line 310 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_reset_bounds_flag

protected

Definition at line 293 of file ParticleSystem.h.

SortMode osgParticle::ParticleSystem::_sortMode

protected

Definition at line 305 of file ParticleSystem.h.

double osgParticle::ParticleSystem::_t0

protected

Definition at line 301 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_useShaders

protected

Definition at line 284 of file ParticleSystem.h.

bool osgParticle::ParticleSystem::_useVertexArray

protected

Definition at line 283 of file ParticleSystem.h.

double osgParticle::ParticleSystem::_visibilityDistance

protected

Definition at line 306 of file ParticleSystem.h.

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

osg_head/include/osgParticle/ParticleSystem.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation