#include <BoxPlacer.h>

Inheritance diagram for osgParticle::BoxPlacer:

Collaboration 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. More...

void	setXRange (const rangef &r)
	Set the range of possible values along the X axis. More...

void	setXRange (float r1, float r2)
	Set the range of possible values along the X axis. More...

const rangef &	getYRange () const
	Get the range of possible values along the Y axis. More...

void	setYRange (const rangef &r)
	Set the range of possible values along the Y axis. More...

void	setYRange (float r1, float r2)
	Set the range of possible values along the Y axis. More...

const rangef &	getZRange () const
	Get the range of possible values along the Z axis. More...

void	setZRange (const rangef &r)
	Set the range of possible values along the Z axis. More...

void	setZRange (float r1, float r2)
	Set the range of possible values along the Z axis. More...

	META_Object (osgParticle, BoxPlacer)

void	place (Particle *P) const
	Place a particle. Do not call it manually. More...

float	volume () const
	return the volume of the box More...

osg::Vec3	getControlPosition () const
	return the control position More...

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::Vec3 &	getCenter () const
	Get the center point. More...

void	setCenter (const osg::Vec3 &v)
	Set the center point. More...

void	setCenter (float x, float y, float z)
	Set the center point. More...

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 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 StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () 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)

osg::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

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
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 ()

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	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

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

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 center point, which is inherited directly from osgParticle::CenteredPlacer, and three ranges of values for the valid X, Y, and Z coordinates.

Definition at line 36 of file BoxPlacer.h.

Constructor & Destructor Documentation

osgParticle::BoxPlacer::BoxPlacer ( )

inline

Definition at line 91 of file BoxPlacer.h.

osgParticle::BoxPlacer::BoxPlacer	(	const BoxPlacer &	copy,
		const osg::CopyOp &	copyop = `osg::CopyOp::SHALLOW_COPY`
	)

inline

Definition at line 96 of file BoxPlacer.h.

virtual osgParticle::BoxPlacer::~BoxPlacer ( )

inlineprotectedvirtual

Definition at line 80 of file BoxPlacer.h.

Member Function Documentation

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

inlinevirtual

return the control position

Implements osgParticle::Placer.

Definition at line 167 of file BoxPlacer.h.

Here is the call graph for this function:

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

inline

Get the range of possible values along the X axis.

Definition at line 102 of file BoxPlacer.h.

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

inline

Get the range of possible values along the Y axis.

Definition at line 118 of file BoxPlacer.h.

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

inline

Get the range of possible values along the Z axis.

Definition at line 134 of file BoxPlacer.h.

osgParticle::BoxPlacer::META_Object	(	osgParticle	,
		BoxPlacer
	)

BoxPlacer& osgParticle::BoxPlacer::operator= ( const BoxPlacer & )

inlineprotected

Definition at line 81 of file BoxPlacer.h.

void osgParticle::BoxPlacer::place ( Particle * P ) const

inlinevirtual

Place a particle. Do not call it manually.

Implements osgParticle::Placer.

Definition at line 150 of file BoxPlacer.h.

Here is the call graph for this function:

void osgParticle::BoxPlacer::setXRange ( const rangef & r )

inline

Set the range of possible values along the X axis.

Definition at line 107 of file BoxPlacer.h.

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

inline

Set the range of possible values along the X axis.

Definition at line 112 of file BoxPlacer.h.

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

inline

Set the range of possible values along the Y axis.

Definition at line 123 of file BoxPlacer.h.

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

inline

Set the range of possible values along the Y axis.

Definition at line 128 of file BoxPlacer.h.

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

inline

Set the range of possible values along the Z axis.

Definition at line 139 of file BoxPlacer.h.

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

inline

Set the range of possible values along the Z axis.

Definition at line 144 of file BoxPlacer.h.

float osgParticle::BoxPlacer::volume ( ) const

inlinevirtual

return the volume of the box

Reimplemented from osgParticle::Placer.

Definition at line 160 of file BoxPlacer.h.

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

osg_head/include/osgParticle/BoxPlacer.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation