OpenSceneGraph  3.0.1
Public Member Functions | Protected Member Functions | Protected Attributes
osgParticle::ConnectedParticleSystem Class Reference

ConnectConnectedParticleSystem is a specialise ConnectedParticleSystem for effects like missle trails, where the individual particles are rendered as single ribbon. More...

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

List of all members.

Public Member Functions

 ConnectedParticleSystem ()
 ConnectedParticleSystem (const ConnectedParticleSystem &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Object (osgParticle, ConnectedParticleSystem)
virtual ParticlecreateParticle (const Particle *ptemplate)
 Create a new particle from the specified template (or the default one if ptemplate is null).
virtual void reuseParticle (int i)
 Reuse the i-th particle.
virtual void drawImplementation (osg::RenderInfo &renderInfo) const
 Draw the connected particles as either a line or a quad strip, depending upon viewing distance. .
const osgParticle::ParticlegetStartParticle () const
 Get the (const) particle from where the line or quadstrip starts to be drawn.
osgParticle::ParticlegetStartParticle ()
 Get the particle from where the line or quadstrip starts to be drawn.
void setMaxNumberOfParticlesToSkip (unsigned int maxNumberofParticlesToSkip)
 Set the maximum numbers of particles to be skipped during the predraw filtering.
unsigned int getMaxNumberOfParticlesToSkip ()
 Get the maximum numbers of particles to be skipped during the predraw filtering.
- Public Member Functions inherited from osgParticle::ParticleSystem
 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 void destroyParticle (int i)
 Destroy 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 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 Member Functions

virtual ~ConnectedParticleSystem ()
ConnectedParticleSystemoperator= (const ConnectedParticleSystem &)
- Protected Member Functions inherited from osgParticle::ParticleSystem
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

int _lastParticleCreated
unsigned int _maxNumberOfParticlesToSkip
int _startParticle
- Protected Attributes inherited from osgParticle::ParticleSystem
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

- Public Types inherited from osgParticle::ParticleSystem
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 }
- Protected Types inherited from osgParticle::ParticleSystem
typedef std::vector< ParticleParticle_vector
typedef std::stack< Particle * > Death_stack
- Protected Types inherited from osg::Drawable
typedef osg::buffered_value
< GLuint > 
GLObjectList

Detailed Description

ConnectConnectedParticleSystem is a specialise ConnectedParticleSystem for effects like missle trails, where the individual particles are rendered as single ribbon.


Constructor & Destructor Documentation

osgParticle::ConnectedParticleSystem::ConnectedParticleSystem ( )
osgParticle::ConnectedParticleSystem::ConnectedParticleSystem ( const ConnectedParticleSystem copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgParticle::ConnectedParticleSystem::~ConnectedParticleSystem ( )
protectedvirtual

Member Function Documentation

virtual Particle* osgParticle::ConnectedParticleSystem::createParticle ( const Particle ptemplate)
virtual

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

Reimplemented from osgParticle::ParticleSystem.

virtual void osgParticle::ConnectedParticleSystem::drawImplementation ( osg::RenderInfo renderInfo) const
virtual

Draw the connected particles as either a line or a quad strip, depending upon viewing distance. .

Reimplemented from osgParticle::ParticleSystem.

unsigned int osgParticle::ConnectedParticleSystem::getMaxNumberOfParticlesToSkip ( )
inline

Get the maximum numbers of particles to be skipped during the predraw filtering.

const osgParticle::Particle* osgParticle::ConnectedParticleSystem::getStartParticle ( ) const
inline

Get the (const) particle from where the line or quadstrip starts to be drawn.

References osgParticle::Particle::INVALID_INDEX.

osgParticle::Particle* osgParticle::ConnectedParticleSystem::getStartParticle ( )
inline

Get the particle from where the line or quadstrip starts to be drawn.

References osgParticle::Particle::INVALID_INDEX.

osgParticle::ConnectedParticleSystem::META_Object ( osgParticle  ,
ConnectedParticleSystem   
)
ConnectedParticleSystem& osgParticle::ConnectedParticleSystem::operator= ( const ConnectedParticleSystem )
inlineprotected
virtual void osgParticle::ConnectedParticleSystem::reuseParticle ( int  i)
virtual

Reuse the i-th particle.

Reimplemented from osgParticle::ParticleSystem.

void osgParticle::ConnectedParticleSystem::setMaxNumberOfParticlesToSkip ( unsigned int  maxNumberofParticlesToSkip)
inline

Set the maximum numbers of particles to be skipped during the predraw filtering.


Member Data Documentation

int osgParticle::ConnectedParticleSystem::_lastParticleCreated
protected
unsigned int osgParticle::ConnectedParticleSystem::_maxNumberOfParticlesToSkip
protected
int osgParticle::ConnectedParticleSystem::_startParticle
protected

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

osg logo
Generated at Sat Jan 12 2013 03:06:09 for the OpenSceneGraph by doxygen 1.8.1.1.