openscenegraph
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osgParticle::ParticleSystem Class Reference
Inheritance diagram for osgParticle::ParticleSystem:
osg::Drawable osg::Object osg::Referenced osgParticle::ConnectedParticleSystem

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
 
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. More...
 
void setParticleAlignment (Alignment a)
 Set the alignment type of particles. More...
 
const osg::Vec3getAlignVectorX () const
 Get the X-axis alignment vector. More...
 
void setAlignVectorX (const osg::Vec3 &v)
 Set the X-axis alignment vector. More...
 
const osg::Vec3getAlignVectorY () 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::BoundingBoxgetDefaultBoundingBox () 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...
 
ParticlegetParticle (int i)
 Get a pointer to the i-th particle. More...
 
const ParticlegetParticle (int i) const
 Get a const pointer to the i-th particle. More...
 
virtual ParticlecreateParticle (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...
 
ParticlegetDefaultParticleTemplate ()
 Get a reference to the default particle template. More...
 
const ParticlegetDefaultParticleTemplate () 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 computeBound () const
 
ReadWriterMutexgetReadWriteMutex () const
 
- Public Member Functions inherited from osg::Drawable
 Drawable ()
 
 Drawable (const Drawable &drawable, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual GeometryasGeometry ()
 
virtual const GeometryasGeometry () const
 
virtual void computeDataVariance ()
 
const ParentListgetParents () const
 
ParentList getParents ()
 
NodegetParent (unsigned int i)
 
const NodegetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 
void setStateSet (StateSet *stateset)
 
StateSetgetStateSet ()
 
const StateSetgetStateSet () const
 
StateSetgetOrCreateStateSet ()
 
void setInitialBound (const osg::BoundingBox &bbox)
 
const BoundingBoxgetInitialBound () const
 
void dirtyBound ()
 
const BoundingBoxgetBound () const
 
void setComputeBoundingBoxCallback (ComputeBoundingBoxCallback *callback)
 
ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback ()
 
const ComputeBoundingBoxCallbackgetComputeBoundingBoxCallback () const
 
void setShape (Shape *shape)
 
ShapegetShape ()
 
const ShapegetShape () 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 setUpdateCallback (UpdateCallback *ac)
 
UpdateCallbackgetUpdateCallback ()
 
const UpdateCallbackgetUpdateCallback () const
 
bool requiresUpdateTraversal () const
 
virtual void setEventCallback (EventCallback *ac)
 
EventCallbackgetEventCallback ()
 
const EventCallbackgetEventCallback () const
 
bool requiresEventTraversal () const
 
virtual void setCullCallback (CullCallback *cc)
 
CullCallbackgetCullCallback ()
 
const CullCallbackgetCullCallback () const
 
virtual void setDrawCallback (DrawCallback *dc)
 
DrawCallbackgetDrawCallback ()
 
const DrawCallbackgetDrawCallback () 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::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
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::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () 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 bool 
getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

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
 
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 ()
 
- 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)
 
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 ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
 
static void setExtensions (unsigned int contextID, Extensions *extensions)
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 
- 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

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: