openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgParticle::Emitter Class Referenceabstract
Inheritance diagram for osgParticle::Emitter:
osgParticle::ParticleProcessor osg::Node osg::Object osg::Referenced osgParticle::ModularEmitter

Public Member Functions

 Emitter ()
 
 Emitter (const Emitter &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
virtual void accept (osg::NodeVisitor &nv)
 
const ParticlegetParticleTemplate () const
 Get the particle template. More...
 
void setParticleTemplate (const Particle &p)
 Set the particle template (particle is copied). More...
 
bool getUseDefaultTemplate () const
 Return whether the particle system's default template should be used. More...
 
void setUseDefaultTemplate (bool v)
 
- Public Member Functions inherited from osgParticle::ParticleProcessor
 ParticleProcessor ()
 
 ParticleProcessor (const ParticleProcessor &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
ReferenceFrame getReferenceFrame () const
 Get the reference frame. More...
 
void setReferenceFrame (ReferenceFrame rf)
 Set the reference frame. More...
 
bool getEnabled () const
 Get whether this processor is enabled or not. More...
 
bool isEnabled () const
 
void setEnabled (bool v)
 Set whether this processor is enabled or not. More...
 
ParticleSystemgetParticleSystem ()
 Get a pointer to the destination particle system. More...
 
const ParticleSystemgetParticleSystem () const
 Get a const pointer to the destination particle system. More...
 
void setParticleSystem (ParticleSystem *ps)
 Set the destination particle system. More...
 
void setEndless (bool type)
 Set the endless flag of this processor. More...
 
bool getEndless () const
 Check whether this processor is endless. More...
 
bool isEndless () const
 
void setLifeTime (double t)
 Set the lifetime of this processor. More...
 
double getLifeTime () const
 Get the lifetime of this processor. More...
 
void setStartTime (double t)
 Set the start time of this processor. More...
 
double getStartTime () const
 Get the start time of this processor. More...
 
void setCurrentTime (double t)
 Set the current time of this processor. More...
 
double getCurrentTime () const
 Get the current time of this processor. More...
 
void setResetTime (double t)
 Set the reset time of this processor. A value of 0 disables reset. More...
 
double getResetTime () const
 Get the reset time of this processor. More...
 
bool isAlive () const
 
void traverse (osg::NodeVisitor &nv)
 
const osg::MatrixgetLocalToWorldMatrix ()
 Get the current local-to-world transformation matrix (valid only during cull traversal). More...
 
const osg::MatrixgetWorldToLocalMatrix ()
 Get the current world-to-local transformation matrix (valid only during cull traversal). More...
 
const osg::MatrixgetPreviousLocalToWorldMatrix ()
 Get the previous local-to-world transformation matrix (valid only during cull traversal). More...
 
const osg::MatrixgetPreviousWorldToLocalMatrix ()
 Get the previous world-to-local transformation matrix (valid only during cull traversal). More...
 
osg::Vec3 transformLocalToWorld (const osg::Vec3 &P)
 Transform a point from local to world coordinates (valid only during cull traversal). More...
 
osg::Vec3 rotateLocalToWorld (const osg::Vec3 &P)
 Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal). More...
 
osg::Vec3 transformWorldToLocal (const osg::Vec3 &P)
 Transform a point from world to local coordinates (valid only during cull traversal). More...
 
osg::Vec3 rotateWorldToLocal (const osg::Vec3 &P)
 Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal). More...
 
virtual osg::BoundingSphere computeBound () const
 
- Public Member Functions inherited from osg::Node
 Node ()
 
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const
 
virtual Objectclone (const CopyOp &copyop) const
 
virtual GroupasGroup ()
 
virtual const GroupasGroup () const
 
virtual TransformasTransform ()
 
virtual const TransformasTransform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual SwitchasSwitch ()
 
virtual const SwitchasSwitch () const
 
virtual GeodeasGeode ()
 
virtual const GeodeasGeode () const
 
virtual osgTerrain::TerrainasTerrain ()
 
virtual const osgTerrain::TerrainasTerrain () const
 
virtual void ascend (NodeVisitor &nv)
 
const ParentListgetParents () const
 
ParentList getParents ()
 
GroupgetParent (unsigned int i)
 
const GroupgetParent (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 (NodeCallback *nc)
 
NodeCallbackgetUpdateCallback ()
 
const NodeCallbackgetUpdateCallback () const
 
void addUpdateCallback (NodeCallback *nc)
 
void removeUpdateCallback (NodeCallback *nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (NodeCallback *nc)
 
NodeCallbackgetEventCallback ()
 
const NodeCallbackgetEventCallback () const
 
void addEventCallback (NodeCallback *nc)
 
void removeEventCallback (NodeCallback *nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (NodeCallback *nc)
 
NodeCallbackgetCullCallback ()
 
const NodeCallbackgetCullCallback () const
 
void addCullCallback (NodeCallback *nc)
 
void removeCullCallback (NodeCallback *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::StateSetgetOrCreateStateSet ()
 
osg::StateSetgetStateSet ()
 
const osg::StateSetgetStateSet () const
 
void setDescriptions (const DescriptionList &descriptions)
 
DescriptionListgetDescriptions ()
 
const DescriptionListgetDescriptions () 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 BoundingSpheregetInitialBound () const
 
void dirtyBound ()
 
const BoundingSpheregetBound () const
 
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (osg::State *=0) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::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 Member Functions

virtual ~Emitter ()
 
Emitteroperator= (const Emitter &)
 
void process (double dt)
 
virtual void emitParticles (double dt)=0
 
- Protected Member Functions inherited from osgParticle::ParticleProcessor
virtual ~ParticleProcessor ()
 
ParticleProcessoroperator= (const ParticleProcessor &)
 
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
 
void addParent (osg::Group *node)
 
void removeParent (osg::Group *node)
 
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

bool _usedeftemp
 
Particle _ptemp
 
- Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
 
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
 
BoundingSphere _boundingSphere
 
bool _boundingSphereComputed
 
ParentList _parents
 
ref_ptr< NodeCallback_updateCallback
 
unsigned int _numChildrenRequiringUpdateTraversal
 
ref_ptr< NodeCallback_eventCallback
 
unsigned int _numChildrenRequiringEventTraversal
 
ref_ptr< NodeCallback_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

- Public Types inherited from osgParticle::ParticleProcessor
enum  ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF }
 
- 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 }
 
- 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 ()
 

Detailed Description

An abstract base class for particle emitters. Descendant classes must override the emitParticles() method to generate new particles by calling the ParticleSystem::createParticle() method on the particle system associated to the emitter.

Constructor & Destructor Documentation

◆ Emitter() [1/2]

osgParticle::Emitter::Emitter ( )

◆ Emitter() [2/2]

osgParticle::Emitter::Emitter ( const Emitter copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)

◆ ~Emitter()

virtual osgParticle::Emitter::~Emitter ( )
inlineprotectedvirtual

Member Function Documentation

◆ accept()

virtual void osgParticle::Emitter::accept ( osg::NodeVisitor nv)
inlinevirtual

Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.

Reimplemented from osgParticle::ParticleProcessor.

◆ className()

virtual const char* osgParticle::Emitter::className ( ) const
inlinevirtual

return the name of the node's class type.

Reimplemented from osgParticle::ParticleProcessor.

◆ emitParticles()

virtual void osgParticle::Emitter::emitParticles ( double  dt)
protectedpure virtual

Implemented in osgParticle::ModularEmitter.

◆ getParticleTemplate()

const Particle & osgParticle::Emitter::getParticleTemplate ( ) const
inline

Get the particle template.

◆ getUseDefaultTemplate()

bool osgParticle::Emitter::getUseDefaultTemplate ( ) const
inline

Return whether the particle system's default template should be used.

◆ isSameKindAs()

virtual bool osgParticle::Emitter::isSameKindAs ( const osg::Object obj) const
inlinevirtual

return true if this and obj are of the same kind of object.

Reimplemented from osgParticle::ParticleProcessor.

◆ libraryName()

virtual const char* osgParticle::Emitter::libraryName ( ) const
inlinevirtual

return the name of the node's library.

Reimplemented from osgParticle::ParticleProcessor.

◆ operator=()

Emitter& osgParticle::Emitter::operator= ( const Emitter )
inlineprotected

◆ process()

void osgParticle::Emitter::process ( double  dt)
inlineprotectedvirtual

◆ setParticleTemplate()

void osgParticle::Emitter::setParticleTemplate ( const Particle p)
inline

Set the particle template (particle is copied).

◆ setUseDefaultTemplate()

void osgParticle::Emitter::setUseDefaultTemplate ( bool  v)
inline

Set whether the default particle template should be used. When this flag is true, the particle template is ignored, and the particle system's default template is used instead.

Member Data Documentation

◆ _ptemp

Particle osgParticle::Emitter::_ptemp
protected

◆ _usedeftemp

bool osgParticle::Emitter::_usedeftemp
protected

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