osgParticle::BoxPlacer Class Reference

A box-shaped particle placer. More...

Inheritance diagram for osgParticle::BoxPlacer:

Public Member Functions
	BoxPlacer ()
	BoxPlacer (const BoxPlacer &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
const rangef &	getXRange () 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 rangef &	getYRange () 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 rangef &	getZRange () 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
	return the name of the object's library.
virtual const char *	className () const
	return the name of the object's class type.
virtual bool	isSameKindAs (const osg::Object *obj) const
const osg::Vec3 &	getCenter () 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 ()
	Construct an object.
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type.
virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type.
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string.
void	setName (const char *name)
	Set the name of object using a C style string.
const std::string &	getName () const
	Get the name of object.
void	setDataVariance (DataVariance dv)
	Set the data variance of this object.
DataVariance	getDataVariance () const
	Get the data variance of this object.
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc.
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object.
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object.
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object.
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual Referenced *	getUserData ()
	Get user data.
virtual const Referenced *	getUserData () const
	Get const user data.
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size.
virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref().
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int	referenceCount () const
	Return the number of pointers currently referencing this object.
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object.

Protected Member Functions
virtual	~BoxPlacer ()
BoxPlacer &	operator= (const BoxPlacer &)
Protected Member Functions inherited from osgParticle::CenteredPlacer
virtual	~CenteredPlacer ()
Protected Member Functions inherited from osgParticle::Placer
	~Placer ()
Placer &	operator= (const Placer &)
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor.
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 ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting.
static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active.
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler.
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

Place a particle. Do not call it manually.

Implements osgParticle::Placer.

References osgParticle::range< ValueType >::get_random(), osgParticle::CenteredPlacer::getCenter(), osgParticle::Particle::setPosition(), osg::Vec3f::y(), and osg::Vec3f::z().

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:

• osgParticle/BoxPlacer