OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osgParticle::ParticleSystem Class Reference

The heart of this class library; its purpose is to hold a set of particles and manage particle creation, update, rendering and destruction. More...

Inheritance diagram for osgParticle::ParticleSystem:
Inheritance graph
[legend]

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 std::vector< Node * > ParentList
 A vector of osg::Node pointers which is used to store the parent(s) of drawable.
typedef unsigned int AttributeType
- 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.
void setParticleAlignment (Alignment a)
 Set the alignment type of particles.
const osg::Vec3getAlignVectorX () const
 Get the X-axis alignment vector.
void setAlignVectorX (const osg::Vec3 &v)
 Set the X-axis alignment vector.
const osg::Vec3getAlignVectorY () const
 Get the Y-axis alignment vector.
void setAlignVectorY (const osg::Vec3 &v)
 Set the Y-axis alignment vector.
void setAlignVectors (const osg::Vec3 &X, const osg::Vec3 &Y)
 Set the alignment vectors.
void setParticleScaleReferenceFrame (ParticleScaleReferenceFrame rf)
 Set whether the particles should be scaled relative to world coordaintes or local coordinates.
ParticleScaleReferenceFrame getParticleScaleReferenceFrame () const
 Get whether the particles should be scaled relative to world coordaintes or local coordinates.
const osg::BoundingBoxgetDefaultBoundingBox () const
 Get the default bounding box.
void setDefaultBoundingBox (const osg::BoundingBox &bbox)
 Set the default bounding box.
bool getUseVertexArray () const
 Return true if we use vertex arrays for rendering particles.
void setUseVertexArray (bool v)
 Set to use vertex arrays for rendering particles.
bool getUseShaders () const
 Return true if shaders are required.
void setUseShaders (bool v)
 Set to use GLSL shaders for rendering particles.
bool getDoublePassRendering () const
 Get the double pass rendering flag.
void setDoublePassRendering (bool v)
 Set the double pass rendering flag.
bool getFrozen () const
 Return true if the particle system is frozen.
bool isFrozen () const
void setFrozen (bool v)
 Set or reset the frozen state.
int numParticles () const
 Get the number of allocated particles (alive + dead).
int numDeadParticles () const
 Get the number of dead particles.
bool areAllParticlesDead () const
 Get whether all particles are dead.
ParticlegetParticle (int i)
 Get a pointer to the i-th particle.
const ParticlegetParticle (int i) const
 Get a const pointer to the i-th particle.
virtual ParticlecreateParticle (const Particle *ptemplate)
 Create a new particle from the specified template (or the default one if ptemplate is null).
virtual void destroyParticle (int i)
 Destroy the i-th particle.
virtual void reuseParticle (int i)
 Reuse the i-th particle.
unsigned int getLastFrameNumber () const
 Get the last frame number.
double & getDeltaTime (double currentTime)
 Get the unique delta time for emitters and updaters to use.
ParticlegetDefaultParticleTemplate ()
 Get a reference to the default particle template.
const ParticlegetDefaultParticleTemplate () const
 Get a const reference to the default particle template.
void setDefaultParticleTemplate (const Particle &p)
 Set the default particle template (particle is copied).
bool getFreezeOnCull () const
 Get whether the particle system can freeze when culled.
void setFreezeOnCull (bool v)
 Set whether the particle system can freeze when culled (default is true)
void 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.
void 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.
int getLevelOfDetail () const
 (EXPERIMENTAL) Get the level of detail.
void setLevelOfDetail (int v)
 (EXPERIMENTAL) Set the level of detail.
SortMode getSortMode () const
 Get the sort mode.
void setSortMode (SortMode mode)
 Set the sort mode.
double getVisibilityDistance () const
 Get the visibility distance.
void setVisibilityDistance (double distance)
 Set the visibility distance which allows the particles to be rendered only when depth is inside the distance.
virtual void update (double dt, osg::NodeVisitor &nv)
 Update the particles. Don't call this directly, use a ParticleSystemUpdater instead.
virtual void drawImplementation (osg::RenderInfo &renderInfo) const
 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.
virtual osg::BoundingBox computeBound () const
 Compute the bounding box around Drawables's geometry.
ReadWriterMutexgetReadWriteMutex () const
- Public Member Functions inherited from osg::Drawable
 Drawable ()
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
 return the name of the object's library.
virtual const char * className () const
 return the name of the object's class type.
virtual GeometryasGeometry ()
 Convert 'this' into a Geometry pointer if Drawable is a Geometry, otherwise return 0.
virtual const GeometryasGeometry () const
 Convert 'const this' into a const Geometry pointer if Drawable is a Geometry, otherwise return 0.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
const ParentListgetParents () const
 Get the parent list of drawable.
ParentList getParents ()
 Get the a copy of parent list of node.
NodegetParent (unsigned int i)
 Get a single parent of Drawable.
const NodegetParent (unsigned int i) const
 Get a single const parent of Drawable.
unsigned int getNumParents () const
 Get the number of parents of node.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setStateSet (StateSet *stateset)
 Set the StateSet attached to the Drawable.
StateSetgetStateSet ()
 Get the attached StateSet.
const StateSetgetStateSet () const
 Get the attached const StateSet.
StateSetgetOrCreateStateSet ()
 Get the attached const StateSet, if one is not already attached create one, attach it to the drawable and return a pointer to it.
void setInitialBound (const osg::BoundingBox &bbox)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingBoxgetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
void dirtyBound ()
 Dirty the bounding box, forcing a computeBound() on the next call to getBound().
const BoundingBoxgetBound () const
 Get BoundingBox of Drawable.
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 Set the compute bound callback to override the default computeBound.
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 Get the compute bound callback.
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 Get the const compute bound callback.
void setShape (Shape *shape)
 Set the Shape of the Drawable.
ShapegetShape ()
 Get the Shape of the Drawable.
const ShapegetShape () const
 Get the const Shape of the const Drawable.
void setSupportsDisplayList (bool flag)
 Set the drawable so that it can or cannot be used in conjunction with OpenGL display lists.
bool getSupportsDisplayList () const
 Get whether display lists are supported for this drawable instance.
void setUseDisplayList (bool flag)
 When set to true, force the draw method to use OpenGL Display List for rendering.
bool getUseDisplayList () const
 Return whether OpenGL display lists are being used for rendering.
GLuint & getDisplayList (unsigned int contextID) const
 Return OpenGL display list for specified contextID.
virtual void setUseVertexBufferObjects (bool flag)
 When set to true, ignore the setUseDisplayList() settings, and hints to the drawImplementation method to use OpenGL vertex buffer objects for rendering.
bool getUseVertexBufferObjects () const
 Return whether OpenGL vertex buffer objects should be used when supported by OpenGL driver.
virtual void dirtyDisplayList ()
 Force a recompile on next draw() of any OpenGL display list associated with this geoset.
virtual unsigned int getGLObjectSizeHint () const
 Return the estimated size of GLObjects (display lists/vertex buffer objects) that are associated with this drawable.
void draw (RenderInfo &renderInfo) const
 Draw OpenGL primitives.
virtual void compileGLObjects (RenderInfo &renderInfo) const
 Immediately compile this Drawable into an OpenGL Display List/VertexBufferObjects.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.
virtual void setUpdateCallback (UpdateCallback *ac)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
UpdateCallbackgetUpdateCallback ()
 Get the non const UpdateCallback.
const UpdateCallbackgetUpdateCallback () const
 Get the const UpdateCallback.
bool requiresUpdateTraversal () const
 Return whether this Drawable has update callbacks associated with it, and therefore must be traversed.
virtual void setEventCallback (EventCallback *ac)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
EventCallbackgetEventCallback ()
 Get the non const EventCallback.
const EventCallbackgetEventCallback () const
 Get the const EventCallback.
bool requiresEventTraversal () const
 Return whether this Drawable has event callbacks associated with it, and therefore must be traversed.
virtual void setCullCallback (CullCallback *cc)
 Set the CullCallback which allows users to customize the culling of Drawable during the cull traversal.
CullCallbackgetCullCallback ()
 Get the non const CullCallback.
const CullCallbackgetCullCallback () const
 Get the const CullCallback.
virtual void setDrawCallback (DrawCallback *dc)
 Set the DrawCallback which allows users to attach customize the drawing of existing Drawable object.
DrawCallbackgetDrawCallback ()
 Get the non const DrawCallback.
const DrawCallbackgetDrawCallback () const
 Get the const DrawCallback.
virtual bool supports (const AttributeFunctor &) const
 Return true if the Drawable subclass supports accept(AttributeFunctor&).
virtual void accept (AttributeFunctor &)
 accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool supports (const ConstAttributeFunctor &) const
 Return true if the Drawable subclass supports accept(ConstAttributeFunctor&).
virtual void accept (ConstAttributeFunctor &) const
 Accept an AttributeFunctor and call its methods to tell it about the internal attributes that this Drawable has.
virtual bool supports (const PrimitiveFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveFunctor&).
virtual void accept (PrimitiveFunctor &) const
 Accept a PrimitiveFunctor and call its methods to tell it about the internal primitives that this Drawable has.
virtual bool supports (const PrimitiveIndexFunctor &) const
 Return true if the Drawable subclass supports accept(PrimitiveIndexFunctor&).
virtual void accept (PrimitiveIndexFunctor &) const
 Accept a PrimitiveIndexFunctor and call its methods to tell it about the internal primitives that this Drawable has.
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 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.
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 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.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
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.
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.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Types

typedef std::vector< ParticleParticle_vector
typedef std::stack< Particle * > Death_stack
- Protected Types inherited from osg::Drawable
typedef osg::buffered_value
< GLuint > 
GLObjectList

Protected Member Functions

virtual ~ParticleSystem ()
ParticleSystemoperator= (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
Drawableoperator= (const Drawable &)
virtual ~Drawable ()
void setBound (const BoundingBox &bb) const
 set the bounding box .
void addParent (osg::Node *node)
void removeParent (osg::Node *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setNumChildrenRequiringEventTraversal (unsigned int num)
unsigned int getNumChildrenRequiringEventTraversal () const
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
- 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
ParentList _parents
ref_ptr< StateSet_stateset
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_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< EventCallback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< CullCallback_cullCallback
ref_ptr< DrawCallback_drawCallback
- 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)
 Return a OpenGL display list handle a newly generated or reused from display list cache.
static void setMinimumNumberOfDisplayListsToRetainInCache (unsigned int minimum)
 Set the minimum number of display lists to retain in the deleted display list cache.
static unsigned int getMinimumNumberOfDisplayListsToRetainInCache ()
 Get the minimum number of display lists to retain in the deleted display list cache.
static void deleteDisplayList (unsigned int contextID, GLuint globj, unsigned int sizeHint=0)
 Use deleteDisplayList instead of glDeleteList to allow OpenGL display list to be cached until they can be deleted by the OpenGL context in which they were created, specified by contextID.
static void flushAllDeletedDisplayLists (unsigned int contextID)
 Flush all the cached display list which need to be deleted in the OpenGL context related to contextID.
static void discardAllDeletedDisplayLists (unsigned int contextID)
 Flush all the cached display list which need to be deleted in the OpenGL context related to contextID.
static void flushDeletedDisplayLists (unsigned int contextID, double &availableTime)
 Flush the cached display list which need to be deleted in the OpenGL context related to contextID.
static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
 Function to call to get the extension of a specified context.
static void setExtensions (unsigned int contextID, Extensions *extensions)
 setExtensions allows users to override the extensions across graphics contexts.
- 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).

Member Typedef Documentation

typedef std::stack<Particle*> osgParticle::ParticleSystem::Death_stack
protected
typedef OpenThreads::ScopedLock<OpenThreads::Mutex> osgParticle::ParticleSystem::ScopedReadLock
typedef OpenThreads::ScopedLock<OpenThreads::Mutex> osgParticle::ParticleSystem::ScopedWriteLock

Member Enumeration Documentation

Enumerator:
BILLBOARD 
FIXED 
Enumerator:
LOCAL_COORDINATES 
WORLD_COORDINATES 
Enumerator:
NO_SORT 
SORT_FRONT_TO_BACK 
SORT_BACK_TO_FRONT 

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.

virtual osg::BoundingBox osgParticle::ParticleSystem::computeBound ( ) 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.

References _deadparts, _def_ptemp, and _particles.

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

Destroy the i-th particle.

References _particles.

virtual void osgParticle::ParticleSystem::drawImplementation ( osg::RenderInfo 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
renderInfoThe osg::RenderInfo object that encapsulates the current rendering information including the osg::State OpenGL state for the current graphics context.

Implements osg::Drawable.

Reimplemented in osgParticle::ConnectedParticleSystem.

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

Get the X-axis alignment vector.

References _align_X_axis.

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

Get the Y-axis alignment vector.

References _align_Y_axis.

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

Get the default bounding box.

References _def_bbox.

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

Get a reference to the default particle template.

References _def_ptemp.

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

Get a const reference to the default particle template.

References _def_ptemp.

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

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

References _dirty_dt, _dt, and _t0.

bool osgParticle::ParticleSystem::getDoublePassRendering ( ) const
inline

Get the double pass rendering flag.

References _doublepass.

bool osgParticle::ParticleSystem::getFreezeOnCull ( ) const
inline

Get whether the particle system can freeze when culled.

References _freeze_on_cull.

bool osgParticle::ParticleSystem::getFrozen ( ) const
inline

Return true if the particle system is frozen.

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

Get the last frame number.

References _last_frame.

int osgParticle::ParticleSystem::getLevelOfDetail ( ) const
inline

(EXPERIMENTAL) Get the level of detail.

References _detail.

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

Get a pointer to the i-th particle.

References _particles.

Referenced by osgParticle::Operator::operateParticles().

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

Get a const pointer to the i-th particle.

References _particles.

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

Get the alignment type of particles.

References _alignment.

ParticleScaleReferenceFrame osgParticle::ParticleSystem::getParticleScaleReferenceFrame ( ) const
inline

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

ReadWriterMutex* osgParticle::ParticleSystem::getReadWriteMutex ( ) const
inline
ParticleSystem::SortMode osgParticle::ParticleSystem::getSortMode ( ) const
inline

Get the sort mode.

References _sortMode.

bool osgParticle::ParticleSystem::getUseShaders ( ) const
inline

Return true if shaders are required.

bool osgParticle::ParticleSystem::getUseVertexArray ( ) const
inline

Return true if we use vertex arrays for rendering particles.

double osgParticle::ParticleSystem::getVisibilityDistance ( ) const
inline

Get the visibility distance.

References _visibilityDistance.

bool osgParticle::ParticleSystem::isFrozen ( ) const
inline

References _frozen.

osgParticle::ParticleSystem::META_Object ( osgParticle  ,
ParticleSystem   
)
int osgParticle::ParticleSystem::numDeadParticles ( ) const
inline

Get the number of dead particles.

References _deadparts.

int osgParticle::ParticleSystem::numParticles ( ) const
inline

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

References _particles.

Referenced by osgParticle::Operator::operateParticles().

ParticleSystem& osgParticle::ParticleSystem::operator= ( const ParticleSystem )
inlineprotected
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.

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

Set the alignment vectors.

References _align_X_axis, and _align_Y_axis.

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

Set the X-axis alignment vector.

References _align_X_axis.

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

Set the Y-axis alignment vector.

References _align_Y_axis.

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.

References _def_bbox.

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

Set the default particle template (particle is copied).

References _def_ptemp.

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.

References _doublepass.

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

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

References _freeze_on_cull.

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.

References _frozen.

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.

References _detail.

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

Set the alignment type of particles.

References _alignment.

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

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

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

References _sortMode.

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.

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

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.

References _dirty_uniforms, _useShaders, and _visibilityDistance.

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

Member Data Documentation

osg::Vec3 osgParticle::ParticleSystem::_align_X_axis
protected
osg::Vec3 osgParticle::ParticleSystem::_align_Y_axis
protected
Alignment osgParticle::ParticleSystem::_alignment
protected
osg::Vec3 osgParticle::ParticleSystem::_bmax
protected

Referenced by update_bounds().

osg::Vec3 osgParticle::ParticleSystem::_bmin
protected

Referenced by update_bounds().

bool osgParticle::ParticleSystem::_bounds_computed
protected

Referenced by update_bounds().

Death_stack osgParticle::ParticleSystem::_deadparts
protected

Referenced by createParticle(), and numDeadParticles().

osg::BoundingBox osgParticle::ParticleSystem::_def_bbox
protected
Particle osgParticle::ParticleSystem::_def_ptemp
protected
int osgParticle::ParticleSystem::_detail
protected
bool osgParticle::ParticleSystem::_dirty_dt
mutableprotected

Referenced by getDeltaTime().

bool osgParticle::ParticleSystem::_dirty_uniforms
protected

Referenced by setVisibilityDistance().

bool osgParticle::ParticleSystem::_doublepass
protected
int osgParticle::ParticleSystem::_draw_count
mutableprotected
double osgParticle::ParticleSystem::_dt
protected

Referenced by getDeltaTime().

bool osgParticle::ParticleSystem::_freeze_on_cull
protected

Referenced by getFreezeOnCull(), and setFreezeOnCull().

bool osgParticle::ParticleSystem::_frozen
protected

Referenced by isFrozen(), and setFrozen().

unsigned int osgParticle::ParticleSystem::_last_frame
mutableprotected

Referenced by getLastFrameNumber().

Particle_vector osgParticle::ParticleSystem::_particles
protected
ParticleScaleReferenceFrame osgParticle::ParticleSystem::_particleScaleReferenceFrame
protected
ReadWriterMutex osgParticle::ParticleSystem::_readWriteMutex
mutableprotected
bool osgParticle::ParticleSystem::_reset_bounds_flag
protected

Referenced by update_bounds().

SortMode osgParticle::ParticleSystem::_sortMode
protected

Referenced by getSortMode(), and setSortMode().

double osgParticle::ParticleSystem::_t0
protected

Referenced by getDeltaTime().

bool osgParticle::ParticleSystem::_useShaders
protected

Referenced by setVisibilityDistance().

bool osgParticle::ParticleSystem::_useVertexArray
protected
double osgParticle::ParticleSystem::_visibilityDistance
protected

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

osg logo
Generated at Tue Sep 4 2012 06:14:42 for the OpenSceneGraph by doxygen 1.8.1.2.