openscenegraph
Public Member Functions | Protected Member Functions | List of all members
osgParticle::Placer Class Referenceabstract

#include <Placer>

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 Object * cloneType () const =0
virtual Object * clone (const CopyOp &) const =0
std::string getCompoundClassName () const
virtual Node * asNode ()
virtual const Node * asNode () const
virtual NodeVisitor * asNodeVisitor ()
virtual const NodeVisitor * asNodeVisitor () const
virtual StateSet * asStateSet ()
virtual const StateSet * asStateSet () const
virtual StateAttribute * asStateAttribute ()
virtual const StateAttribute * asStateAttribute () const
virtual Uniform * asUniform ()
virtual const Uniform * asUniform () const
virtual Camera * asCamera ()
virtual const Camera * asCamera () const
virtual Drawable * asDrawable ()
virtual const Drawable * asDrawable () const
virtual Callback * asCallback ()
virtual const Callback * asCallback () const
virtual CallbackObject * asCallbackObject ()
virtual const CallbackObject * asCallbackObject () const
virtual UserDataContainer * asUserDataContainer ()
virtual const UserDataContainer * asUserDataContainer () const
virtual ValueObject * asValueObject ()
virtual const ValueObject * asValueObject () const
virtual Image * asImage ()
virtual const Image * asImage () const
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)
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer * getUserDataContainer ()
const osg::UserDataContainer * getUserDataContainer () const
osg::UserDataContainer * getOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual Referenced * getUserData ()
virtual const Referenced * getUserData () 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
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referenced & operator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::Mutex * getRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSet * getObserverSet () const
ObserverSet * getOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Member Functions

 ~Placer ()
Placer & operator= (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::Mutex * getGlobalReferencedMutex ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandler * getDeleteHandler ()
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

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

◆ Placer() [1/2]

osgParticle::Placer::Placer ( )
inline

References osg::Object::Object().

Referenced by osgParticle::CompositePlacer::addPlacer(), osgParticle::CenteredPlacer::CenteredPlacer(), osgParticle::CenteredPlacer::CenteredPlacer(), osgParticle::CompositePlacer::CompositePlacer(), osgParticle::CompositePlacer::CompositePlacer(), osgParticle::CompositePlacer::getPlacer(), osgParticle::CompositePlacer::getPlacer(), osgParticle::CenteredPlacer::isSameKindAs(), isSameKindAs(), operator=(), Placer(), osgParticle::SegmentPlacer::SegmentPlacer(), osgParticle::SegmentPlacer::SegmentPlacer(), and osgParticle::CompositePlacer::setPlacer().

◆ Placer() [2/2]

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

References osg::Object::Object(), and Placer().

◆ ~Placer()

osgParticle::Placer::~Placer ( )
inlineprotected

Member Function Documentation

◆ className()

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.

◆ getControlPosition()

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::CompositePlacer, osgParticle::MultiSegmentPlacer, osgParticle::PointPlacer, osgParticle::SectorPlacer, and osgParticle::SegmentPlacer.

◆ isSameKindAs()

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

Reimplemented from osg::Object.

Reimplemented in osgParticle::CenteredPlacer.

References Placer().

◆ libraryName()

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.

◆ operator=()

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

References Placer().

◆ place()

virtual void osgParticle::Placer::place ( Particle * P) const
pure virtual

Place a particle. Must be implemented in descendant classes.

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

◆ volume()

virtual float osgParticle::Placer::volume ( ) const
inlinevirtual

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

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

The documentation for this class was generated from the following file:
Generated by doxygen 1.15.0