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

Public Member Functions

 BoxPlacer ()
 BoxPlacer (const BoxPlacer &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
const rangefgetXRange () const
 Get the range of possible values along the X axis.
void setXRange (const rangef &r)
 Set the range of possible values along the X axis.
void setXRange (float r1, float r2)
 Set the range of possible values along the X axis.
const rangefgetYRange () const
 Get the range of possible values along the Y axis.
void setYRange (const rangef &r)
 Set the range of possible values along the Y axis.
void setYRange (float r1, float r2)
 Set the range of possible values along the Y axis.
const rangefgetZRange () const
 Get the range of possible values along the Z axis.
void setZRange (const rangef &r)
 Set the range of possible values along the Z axis.
void setZRange (float r1, float r2)
 Set the range of possible values along the Z axis.
 META_Object (osgParticle, BoxPlacer)
void place (Particle *P) const
 Place a particle. Do not call it manually.
float volume () const
 return the volume of the box
osg::Vec3 getControlPosition () const
 return the control position
- Public Member Functions inherited from osgParticle::CenteredPlacer
 CenteredPlacer ()
 CenteredPlacer (const CenteredPlacer &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
const osg::Vec3getCenter () const
 Get the center point.
void setCenter (const osg::Vec3 &v)
 Set the center point.
void setCenter (float x, float y, float z)
 Set the center point.
- Public Member Functions inherited from osgParticle::Placer
 Placer ()
 Placer (const Placer &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
- 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

virtual ~BoxPlacer ()
BoxPlaceroperator= (const BoxPlacer &)
- Protected Member Functions inherited from osgParticle::CenteredPlacer
virtual ~CenteredPlacer ()
- Protected Member Functions inherited from osgParticle::Placer
 ~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

A box-shaped particle placer.
This placer sets the initial position of incoming particle by choosing a random position 
within the volume of a box; this placer is defined by four parameters: a <I>center point</I>, 
which is inherited directly from <CODE>osgParticle::CenteredPlacer</CODE>, and three ranges of values 

for the valid X, Y, and Z coordinates.

Constructor & Destructor Documentation

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

Member Function Documentation

osg::Vec3 osgParticle::BoxPlacer::getControlPosition ( ) const
inlinevirtual

return the control position

Implements osgParticle::Placer.

References osgParticle::CenteredPlacer::getCenter().

const rangef & osgParticle::BoxPlacer::getXRange ( ) const
inline

Get the range of possible values along the X axis.

const rangef & osgParticle::BoxPlacer::getYRange ( ) const
inline

Get the range of possible values along the Y axis.

const rangef & osgParticle::BoxPlacer::getZRange ( ) const
inline

Get the range of possible values along the Z axis.

osgParticle::BoxPlacer::META_Object ( osgParticle  ,
BoxPlacer   
)
BoxPlacer& osgParticle::BoxPlacer::operator= ( const BoxPlacer )
inlineprotected
void osgParticle::BoxPlacer::place ( Particle P) const
inlinevirtual
void osgParticle::BoxPlacer::setXRange ( const rangef r)
inline

Set the range of possible values along the X axis.

void osgParticle::BoxPlacer::setXRange ( float  r1,
float  r2 
)
inline

Set the range of possible values along the X axis.

References osgParticle::range< ValueType >::maximum, and osgParticle::range< ValueType >::minimum.

void osgParticle::BoxPlacer::setYRange ( const rangef r)
inline

Set the range of possible values along the Y axis.

void osgParticle::BoxPlacer::setYRange ( float  r1,
float  r2 
)
inline

Set the range of possible values along the Y axis.

References osgParticle::range< ValueType >::maximum, and osgParticle::range< ValueType >::minimum.

void osgParticle::BoxPlacer::setZRange ( const rangef r)
inline

Set the range of possible values along the Z axis.

void osgParticle::BoxPlacer::setZRange ( float  r1,
float  r2 
)
inline

Set the range of possible values along the Z axis.

References osgParticle::range< ValueType >::maximum, and osgParticle::range< ValueType >::minimum.

float osgParticle::BoxPlacer::volume ( ) const
inlinevirtual

return the volume of the box

Reimplemented from osgParticle::Placer.

References osgParticle::range< ValueType >::maximum, and osgParticle::range< ValueType >::minimum.


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