openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgParticle::ParticleEffect Class Reference
Inheritance diagram for osgParticle::ParticleEffect:
osg::Group osg::Node osg::Object osg::Referenced osgParticle::ExplosionDebrisEffect osgParticle::ExplosionEffect osgParticle::FireEffect osgParticle::SmokeEffect osgParticle::SmokeTrailEffect

Public Member Functions

 ParticleEffect (bool automaticSetup=true)
 ParticleEffect (const ParticleEffect &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)
void setAutomaticSetup (bool flag)
bool getAutomaticSetup () const
void setUseLocalParticleSystem (bool local)
bool getUseLocalParticleSystem () const
void setTextureFileName (const std::string &filename)
const std::string & getTextureFileName () const
void setDefaultParticleTemplate (const Particle &p)
const ParticlegetDefaultParticleTemplate () const
void setPosition (const osg::Vec3 &position)
const osg::Vec3getPosition () const
void setScale (float scale)
float getScale () const
void setIntensity (float intensity)
float getIntensity () const
void setStartTime (double startTime)
double getStartTime () const
void setEmitterDuration (double duration)
double getEmitterDuration () const
void setParticleDuration (double duration)
double getParticleDuration () const
void setWind (const osg::Vec3 &wind)
const osg::Vec3getWind () const
bool areAllParticlesDead () const
 Get whether all particles are dead.
virtual EmittergetEmitter ()=0
virtual const EmittergetEmitter () const =0
virtual ProgramgetProgram ()=0
virtual const ProgramgetProgram () const =0
void setParticleSystem (ParticleSystem *ps)
ParticleSystemgetParticleSystem ()
const ParticleSystemgetParticleSystem () const
virtual void setDefaults ()
virtual void setUpEmitterAndProgram ()=0
virtual void buildEffect ()
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Group)
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual void traverse (NodeVisitor &nv)
virtual bool addChild (Node *child)
virtual bool insertChild (unsigned int index, Node *child)
bool removeChild (Node *child)
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool replaceChild (Node *origChild, Node *newChild)
unsigned int getNumChildren () const
virtual bool setChild (unsigned int i, Node *node)
NodegetChild (unsigned int i)
const NodegetChild (unsigned int i) const
bool containsNode (const Node *node) const
unsigned int getChildIndex (const Node *node) const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *=0) const
virtual 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 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
- 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 ~ParticleEffect ()
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
virtual void childRemoved (unsigned int, unsigned int)
virtual void childInserted (unsigned int)
- 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 _automaticSetup
osg::ref_ptr< ParticleSystem_particleSystem
bool _useLocalParticleSystem
std::string _textureFileName
Particle _defaultParticleTemplate
osg::Vec3 _position
float _scale
float _intensity
double _startTime
double _emitterDuration
osg::Vec3 _wind
- Protected Attributes inherited from osg::Group
NodeList _children
- 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 osg::Node
typedef std::vector< Group * > ParentList
typedef unsigned int NodeMask
typedef std::vector< std::string > DescriptionList
- 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 ()

Constructor & Destructor Documentation

osgParticle::ParticleEffect::ParticleEffect ( bool  automaticSetup = true)
inlineexplicit
osgParticle::ParticleEffect::ParticleEffect ( const ParticleEffect copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgParticle::ParticleEffect::~ParticleEffect ( )
inlineprotectedvirtual

Member Function Documentation

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

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

Reimplemented from osg::Node.

References osg::NodeVisitor::apply(), osg::NodeVisitor::popFromNodePath(), osg::NodeVisitor::pushOntoNodePath(), and osg::NodeVisitor::validNodeMask().

bool osgParticle::ParticleEffect::areAllParticlesDead ( ) const
inline

Get whether all particles are dead.

virtual void osgParticle::ParticleEffect::buildEffect ( )
virtual
virtual const char* osgParticle::ParticleEffect::className ( ) const
inlinevirtual

return the name of the node's class type.

Reimplemented from osg::Node.

bool osgParticle::ParticleEffect::getAutomaticSetup ( ) const
inline
const Particle& osgParticle::ParticleEffect::getDefaultParticleTemplate ( ) const
inline
virtual Emitter* osgParticle::ParticleEffect::getEmitter ( )
pure virtual
virtual const Emitter* osgParticle::ParticleEffect::getEmitter ( ) const
pure virtual
double osgParticle::ParticleEffect::getEmitterDuration ( ) const
inline
float osgParticle::ParticleEffect::getIntensity ( ) const
inline
double osgParticle::ParticleEffect::getParticleDuration ( ) const
inline
ParticleSystem* osgParticle::ParticleEffect::getParticleSystem ( )
inline
const ParticleSystem* osgParticle::ParticleEffect::getParticleSystem ( ) const
inline
const osg::Vec3& osgParticle::ParticleEffect::getPosition ( ) const
inline
virtual Program* osgParticle::ParticleEffect::getProgram ( )
pure virtual
virtual const Program* osgParticle::ParticleEffect::getProgram ( ) const
pure virtual
float osgParticle::ParticleEffect::getScale ( ) const
inline
double osgParticle::ParticleEffect::getStartTime ( ) const
inline
const std::string& osgParticle::ParticleEffect::getTextureFileName ( ) const
inline
bool osgParticle::ParticleEffect::getUseLocalParticleSystem ( ) const
inline
const osg::Vec3& osgParticle::ParticleEffect::getWind ( ) const
inline
virtual bool osgParticle::ParticleEffect::isSameKindAs ( const osg::Object obj) const
inlinevirtual

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

Reimplemented from osg::Node.

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

return the name of the node's library.

Reimplemented from osg::Node.

void osgParticle::ParticleEffect::setAutomaticSetup ( bool  flag)
inline
void osgParticle::ParticleEffect::setDefaultParticleTemplate ( const Particle p)
virtual void osgParticle::ParticleEffect::setDefaults ( )
virtual
void osgParticle::ParticleEffect::setEmitterDuration ( double  duration)
void osgParticle::ParticleEffect::setIntensity ( float  intensity)
void osgParticle::ParticleEffect::setParticleDuration ( double  duration)
void osgParticle::ParticleEffect::setParticleSystem ( ParticleSystem ps)
void osgParticle::ParticleEffect::setPosition ( const osg::Vec3 position)
void osgParticle::ParticleEffect::setScale ( float  scale)
void osgParticle::ParticleEffect::setStartTime ( double  startTime)
void osgParticle::ParticleEffect::setTextureFileName ( const std::string &  filename)
virtual void osgParticle::ParticleEffect::setUpEmitterAndProgram ( )
pure virtual
void osgParticle::ParticleEffect::setUseLocalParticleSystem ( bool  local)
void osgParticle::ParticleEffect::setWind ( const osg::Vec3 wind)

Member Data Documentation

bool osgParticle::ParticleEffect::_automaticSetup
protected
Particle osgParticle::ParticleEffect::_defaultParticleTemplate
protected
double osgParticle::ParticleEffect::_emitterDuration
protected
float osgParticle::ParticleEffect::_intensity
protected
osg::ref_ptr<ParticleSystem> osgParticle::ParticleEffect::_particleSystem
protected
osg::Vec3 osgParticle::ParticleEffect::_position
protected
float osgParticle::ParticleEffect::_scale
protected
double osgParticle::ParticleEffect::_startTime
protected
std::string osgParticle::ParticleEffect::_textureFileName
protected
bool osgParticle::ParticleEffect::_useLocalParticleSystem
protected
osg::Vec3 osgParticle::ParticleEffect::_wind
protected

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