openscenegraph
Public Member Functions | Protected Member Functions | List of all members
osgParticle::Placer Class Reference
Inheritance diagram for osgParticle::Placer:
osg::Object osg::Referenced osgParticle::CenteredPlacer osgParticle::CompositePlacer osgParticle::MultiSegmentPlacer osgParticle::SegmentPlacer osgParticle::BoxPlacer osgParticle::PointPlacer osgParticle::SectorPlacer

Public Member Functions

 Placer ()
 Placer (const Placer &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 place (Particle *P) const =0
 Place a particle. Must be implemented in descendant classes.
virtual float volume () const
 Volume of the placer. Can be implemented in descendant classes.
virtual osg::Vec3 getControlPosition () const =0
 Return the control position of particles that placer will generate. Must be implemented in descendant classes.
- 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 setThreadSafeRefUnref (bool threadSafe)
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)
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (osg::State *=0) 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

 ~Placer ()
Placeroperator= (const Placer &)
- 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 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 ()
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer

Detailed Description

An abstract base class for implementing particle placers. A placer is an object which take a particle as input, and places it somewhere by setting its position vector. Placer objects are used by the ModularEmitter class as part of the particle emission process.

Constructor & Destructor Documentation

osgParticle::Placer::Placer ( )
inline
osgParticle::Placer::Placer ( const Placer copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
inline
osgParticle::Placer::~Placer ( )
inlineprotected

Member Function Documentation

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

return the name of the object's class type. Must be defined by derived classes.

Implements osg::Object.

Reimplemented in osgParticle::CenteredPlacer.

virtual osg::Vec3 osgParticle::Placer::getControlPosition ( ) const
pure virtual

Return the control position of particles that placer will generate. Must be implemented in descendant classes.

Implemented in osgParticle::BoxPlacer, osgParticle::MultiSegmentPlacer, osgParticle::SectorPlacer, osgParticle::SegmentPlacer, osgParticle::CompositePlacer, and osgParticle::PointPlacer.

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

Reimplemented from osg::Object.

Reimplemented in osgParticle::CenteredPlacer.

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

return the name of the object's library. Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Implements osg::Object.

Reimplemented in osgParticle::CenteredPlacer.

Placer& osgParticle::Placer::operator= ( const Placer )
inlineprotected
virtual void osgParticle::Placer::place ( Particle P) const
pure virtual
virtual float osgParticle::Placer::volume ( ) const
inlinevirtual

Volume of the placer. Can be implemented in descendant classes.

Reimplemented in osgParticle::BoxPlacer, osgParticle::MultiSegmentPlacer, osgParticle::SectorPlacer, osgParticle::SegmentPlacer, and osgParticle::CompositePlacer.


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