OpenSceneGraph  3.5.1
Public Member Functions | Protected Member Functions | List of all members
osgParticle::SectorPlacer Class Reference

A sector-shaped particle placer. More...

Inheritance diagram for osgParticle::SectorPlacer:
Inheritance graph
[legend]

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. More...
 
void setRadiusRange (const rangef &r)
 Set the range of possible values for radius. More...
 
void setRadiusRange (float r1, float r2)
 Set the range of possible values for radius. More...
 
const rangefgetPhiRange () const
 Get the range of possible values for the central angle. More...
 
void setPhiRange (const rangef &r)
 Set the range of possible values for the central angle. More...
 
void setPhiRange (float r1, float r2)
 Set the range of possible values for the central angle. More...
 
 META_Object (osgParticle, SectorPlacer)
 
void place (Particle *P) const
 Place a particle. Do not call it manually. More...
 
float volume () const
 return the area of the sector 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
 return the name of the object's library. More...
 
virtual const char * className () const
 return the name of the object's class type. More...
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
const osg::Vec3getCenter () 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 ()
 Construct an object. More...
 
 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. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience 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. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

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 ()
 Object destructor. More...
 
- 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. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- 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

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

Member Function Documentation

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

return the control position

Implements osgParticle::Placer.

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

Get the range of possible values for the central angle.

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

Get the range of possible values for radius.

osgParticle::SectorPlacer::META_Object ( osgParticle  ,
SectorPlacer   
)
SectorPlacer& osgParticle::SectorPlacer::operator= ( const SectorPlacer )
inlineprotected
void osgParticle::SectorPlacer::place ( Particle P) const
inlinevirtual

Place a particle. Do not call it manually.

Implements osgParticle::Placer.

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

Set the range of possible values for the central angle.

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

Set the range of possible values for the central angle.

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

Set the range of possible values for radius.

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

Set the range of possible values for radius.

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:

osg logo
Generated at Wed Nov 11 2015 22:15:05 for the OpenSceneGraph by doxygen 1.8.10.