openscenegraph
osgParticle::SectorPlacer Class Reference

#include <SectorPlacer>

Inheritance diagram for osgParticle::SectorPlacer:
osgParticle::CenteredPlacer osgParticle::Placer osg::Object osg::Referenced

Public Member Functions

 SectorPlacer ()
 SectorPlacer (const SectorPlacer &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
const rangefgetRadiusRange () const
 Get the range of possible values for radius.
void setRadiusRange (const rangef &r)
 Set the range of possible values for radius.
void setRadiusRange (float r1, float r2)
 Set the range of possible values for radius.
const rangefgetPhiRange () const
 Get the range of possible values for the central angle.
void setPhiRange (const rangef &r)
 Set the range of possible values for the central angle.
void setPhiRange (float r1, float r2)
 Set the range of possible values for the central angle.
 META_Object (osgParticle, SectorPlacer)
void place (Particle *P) const
 Place a particle. Do not call it manually.
float volume () const
 return the area of the sector
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
std::string getCompoundClassName () const
virtual NodeasNode ()
virtual const NodeasNode () const
virtual NodeVisitorasNodeVisitor ()
virtual const NodeVisitorasNodeVisitor () const
virtual StateSetasStateSet ()
virtual const StateSetasStateSet () const
virtual StateAttributeasStateAttribute ()
virtual const StateAttributeasStateAttribute () const
virtual UniformasUniform ()
virtual const UniformasUniform () const
virtual CameraasCamera ()
virtual const CameraasCamera () const
virtual DrawableasDrawable ()
virtual const DrawableasDrawable () const
virtual CallbackasCallback ()
virtual const CallbackasCallback () const
virtual CallbackObjectasCallbackObject ()
virtual const CallbackObjectasCallbackObject () const
virtual UserDataContainerasUserDataContainer ()
virtual const UserDataContainerasUserDataContainer () const
virtual ValueObjectasValueObject ()
virtual const ValueObjectasValueObject () const
virtual ImageasImage ()
virtual const ImageasImage () 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::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
template<class T>
void setUserData (const ref_ptr< T > &ud)
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
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 &)
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 ~SectorPlacer ()
SectorPlaceroperator= (const SectorPlacer &)
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 setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
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 sector-shaped particle placer. This placer sets the initial position of incoming particle by choosing a random position within a circular sector; this sector is defined by three parameters: a center point, which is inherited directly from osgParticle::CenteredPlacer, a range of values for radius, and a range of values for the central angle (sometimes called phi).

Constructor & Destructor Documentation

◆ SectorPlacer() [1/2]

osgParticle::SectorPlacer::SectorPlacer ( )
inline

◆ SectorPlacer() [2/2]

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

◆ ~SectorPlacer()

virtual osgParticle::SectorPlacer::~SectorPlacer ( )
inlineprotectedvirtual

Member Function Documentation

◆ getControlPosition()

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

return the control position

Implements osgParticle::Placer.

References osgParticle::CenteredPlacer::getCenter().

◆ getPhiRange()

const rangef & osgParticle::SectorPlacer::getPhiRange ( ) const
inline

Get the range of possible values for the central angle.

◆ getRadiusRange()

const rangef & osgParticle::SectorPlacer::getRadiusRange ( ) const
inline

Get the range of possible values for radius.

◆ META_Object()

osgParticle::SectorPlacer::META_Object ( osgParticle ,
SectorPlacer  )

References SectorPlacer().

◆ operator=()

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

References SectorPlacer().

◆ place()

void osgParticle::SectorPlacer::place ( Particle * P) const
inlinevirtual

Place a particle. Do not call it manually.

Implements osgParticle::Placer.

References osgParticle::CenteredPlacer::getCenter(), and osgParticle::Particle::setPosition().

◆ setPhiRange() [1/2]

void osgParticle::SectorPlacer::setPhiRange ( const rangef & r)
inline

Set the range of possible values for the central angle.

◆ setPhiRange() [2/2]

void osgParticle::SectorPlacer::setPhiRange ( float r1,
float r2 )
inline

Set the range of possible values for the central angle.

References osgParticle::range< ValueType >::minimum.

◆ setRadiusRange() [1/2]

void osgParticle::SectorPlacer::setRadiusRange ( const rangef & r)
inline

Set the range of possible values for radius.

◆ setRadiusRange() [2/2]

void osgParticle::SectorPlacer::setRadiusRange ( float r1,
float r2 )
inline

Set the range of possible values for radius.

References osgParticle::range< ValueType >::minimum.

◆ volume()

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

return the area of the sector

Reimplemented from osgParticle::Placer.


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