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

Public Member Functions

 ModularEmitter ()
 ModularEmitter (const ModularEmitter &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Node (osgParticle, ModularEmitter)
CountergetCounter ()
 Get the counter object.
const CountergetCounter () const
 Get the const Counter object.
void setCounter (Counter *c)
 Set the Counter object.
float getNumParticlesToCreateMovementCompensationRatio () const
 Get the ratio between number of particle to create in compensation for movement of the emitter.
void setNumParticlesToCreateMovementCompensationRatio (float r)
 Set the ratio between number of particle to create in compenstation for movement of the emitter.
PlacergetPlacer ()
 Get the Placer object.
const PlacergetPlacer () const
 Get the const Placer object.
void setPlacer (Placer *p)
 Set the Placer object.
ShootergetShooter ()
 Get the Shooter object.
const ShootergetShooter () const
 Get the const Shooter object.
void setShooter (Shooter *s)
 Set the Shooter object.
- Public Member Functions inherited from osgParticle::Emitter
 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.
void setParticleTemplate (const Particle &p)
 Set the particle template (particle is copied).
bool getUseDefaultTemplate () const
 Return whether the particle system's default template should be used.
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.
void setReferenceFrame (ReferenceFrame rf)
 Set the reference frame.
bool getEnabled () const
 Get whether this processor is enabled or not.
bool isEnabled () const
void setEnabled (bool v)
 Set whether this processor is enabled or not.
ParticleSystemgetParticleSystem ()
 Get a pointer to the destination particle system.
const ParticleSystemgetParticleSystem () const
 Get a const pointer to the destination particle system.
void setParticleSystem (ParticleSystem *ps)
 Set the destination particle system.
void setEndless (bool type)
 Set the endless flag of this processor.
bool getEndless () const
 Check whether this processor is endless.
bool isEndless () const
void setLifeTime (double t)
 Set the lifetime of this processor.
double getLifeTime () const
 Get the lifetime of this processor.
void setStartTime (double t)
 Set the start time of this processor.
double getStartTime () const
 Get the start time of this processor.
void setCurrentTime (double t)
 Set the current time of this processor.
double getCurrentTime () const
 Get the current time of this processor.
void setResetTime (double t)
 Set the reset time of this processor. A value of 0 disables reset.
double getResetTime () const
 Get the reset time of this processor.
bool isAlive () const
void traverse (osg::NodeVisitor &nv)
const osg::MatrixgetLocalToWorldMatrix ()
 Get the current local-to-world transformation matrix (valid only during cull traversal).
const osg::MatrixgetWorldToLocalMatrix ()
 Get the current world-to-local transformation matrix (valid only during cull traversal).
const osg::MatrixgetPreviousLocalToWorldMatrix ()
 Get the previous local-to-world transformation matrix (valid only during cull traversal).
const osg::MatrixgetPreviousWorldToLocalMatrix ()
 Get the previous world-to-local transformation matrix (valid only during cull traversal).
osg::Vec3 transformLocalToWorld (const osg::Vec3 &P)
 Transform a point from local to world coordinates (valid only during cull traversal).
osg::Vec3 rotateLocalToWorld (const osg::Vec3 &P)
 Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal).
osg::Vec3 transformWorldToLocal (const osg::Vec3 &P)
 Transform a point from world to local coordinates (valid only during cull traversal).
osg::Vec3 rotateWorldToLocal (const osg::Vec3 &P)
 Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal).
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 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
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () 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)
- 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 ~ModularEmitter ()
ModularEmitteroperator= (const ModularEmitter &)
virtual void emitParticles (double dt)
- Protected Member Functions inherited from osgParticle::Emitter
virtual ~Emitter ()
Emitteroperator= (const Emitter &)
void process (double dt)
- 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

Additional Inherited Members

- Public Types inherited from osgParticle::ParticleProcessor
enum  ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF }
- 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 ()
- Protected Attributes inherited from osgParticle::Emitter
bool _usedeftemp
Particle _ptemp

Detailed Description

An emitter class that holds three objects to control the creation of particles. These objects are a counter, a placer and a shooter. The counter controls the number of particles to be emitted at each frame; the placer must initialize the particle's position vector, while the shooter initializes its velocity vector. You can use the predefined counter/placer/shooter classes, or you can create your own.

Constructor & Destructor Documentation

osgParticle::ModularEmitter::ModularEmitter ( )
osgParticle::ModularEmitter::ModularEmitter ( const ModularEmitter copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgParticle::ModularEmitter::~ModularEmitter ( )
inlineprotectedvirtual

Member Function Documentation

virtual void osgParticle::ModularEmitter::emitParticles ( double  dt)
protectedvirtual

Implements osgParticle::Emitter.

Counter * osgParticle::ModularEmitter::getCounter ( )
inline

Get the counter object.

References osg::ref_ptr< T >::get().

const Counter * osgParticle::ModularEmitter::getCounter ( ) const
inline

Get the const Counter object.

References osg::ref_ptr< T >::get().

float osgParticle::ModularEmitter::getNumParticlesToCreateMovementCompensationRatio ( ) const
inline

Get the ratio between number of particle to create in compensation for movement of the emitter.

Placer * osgParticle::ModularEmitter::getPlacer ( )
inline

Get the Placer object.

References osg::ref_ptr< T >::get().

const Placer * osgParticle::ModularEmitter::getPlacer ( ) const
inline

Get the const Placer object.

References osg::ref_ptr< T >::get().

Shooter * osgParticle::ModularEmitter::getShooter ( )
inline

Get the Shooter object.

References osg::ref_ptr< T >::get().

const Shooter * osgParticle::ModularEmitter::getShooter ( ) const
inline

Get the const Shooter object.

References osg::ref_ptr< T >::get().

osgParticle::ModularEmitter::META_Node ( osgParticle  ,
ModularEmitter   
)
ModularEmitter& osgParticle::ModularEmitter::operator= ( const ModularEmitter )
inlineprotected
void osgParticle::ModularEmitter::setCounter ( Counter c)
inline

Set the Counter object.

void osgParticle::ModularEmitter::setNumParticlesToCreateMovementCompensationRatio ( float  r)
inline

Set the ratio between number of particle to create in compenstation for movement of the emitter.

void osgParticle::ModularEmitter::setPlacer ( Placer p)
inline

Set the Placer object.

void osgParticle::ModularEmitter::setShooter ( Shooter s)
inline

Set the Shooter object.


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