OpenSceneGraph  3.0.1
Public Member Functions | Protected Member Functions | Protected Attributes
osgParticle::DampingOperator Class Reference

A damping operator applies damping constant to particle's velocity. More...

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

List of all members.

Public Member Functions

 DampingOperator ()
 DampingOperator (const DampingOperator &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Object (osgParticle, DampingOperator)
void setDamping (float x, float y, float z)
 Set the damping factors.
void setDamping (const osg::Vec3 &damping)
void setDamping (float x)
 Set the damping factors to one value.
void getDamping (float &x, float &y, float &z) const
 Get the damping factors.
const osg::Vec3getDamping () const
void setCutoff (float low, float high)
 Set the velocity cutoff factors.
void setCutoffLow (float low)
void setCutoffHigh (float low)
void getCutoff (float &low, float &high) const
 Get the velocity cutoff factors.
float getCutoffLow () const
float getCutoffHigh () const
void operate (Particle *P, double dt)
 Apply the acceleration to a particle. Do not call this method manually.
- Public Member Functions inherited from osgParticle::Operator
 Operator ()
 Operator (const Operator &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
bool isEnabled () const
 Get whether this operator is enabled.
void setEnabled (bool v)
 Enable or disable this operator.
virtual void operateParticles (ParticleSystem *ps, double dt)
 Do something on all emitted particles.
virtual void beginOperate (Program *)
 Do something before processing particles via the operate() method.
virtual void endOperate ()
 Do something after all particles have been processed.
- 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 ObjectcloneType () const =0
 Clone the type of an object, with Object* return type.
virtual Objectclone (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::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 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 ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () 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 &)
Referencedoperator= (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.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () 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 ~DampingOperator ()
DampingOperatoroperator= (const DampingOperator &)
- Protected Member Functions inherited from osgParticle::Operator
virtual ~Operator ()
Operatoroperator= (const Operator &)
- 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

Protected Attributes

osg::Vec3 _damping
float _cutoffLow
float _cutoffHigh

Detailed Description

A damping operator applies damping constant to particle's velocity.

Refer to David McAllister's Particle System API (http://www.particlesystems.org)


Constructor & Destructor Documentation

osgParticle::DampingOperator::DampingOperator ( )
inline

References _damping, and osg::Vec3f::set().

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

Member Function Documentation

void osgParticle::DampingOperator::getCutoff ( float &  low,
float &  high 
) const
inline

Get the velocity cutoff factors.

References _cutoffHigh, and _cutoffLow.

float osgParticle::DampingOperator::getCutoffHigh ( ) const
inline

References _cutoffHigh.

float osgParticle::DampingOperator::getCutoffLow ( ) const
inline

References _cutoffLow.

void osgParticle::DampingOperator::getDamping ( float &  x,
float &  y,
float &  z 
) const
inline

Get the damping factors.

References _damping, osg::Vec3f::x(), osg::Vec3f::y(), and osg::Vec3f::z().

const osg::Vec3& osgParticle::DampingOperator::getDamping ( ) const
inline

References _damping.

osgParticle::DampingOperator::META_Object ( osgParticle  ,
DampingOperator   
)
void osgParticle::DampingOperator::operate ( Particle P,
double  dt 
)
inlinevirtual
DampingOperator& osgParticle::DampingOperator::operator= ( const DampingOperator )
inlineprotected
void osgParticle::DampingOperator::setCutoff ( float  low,
float  high 
)
inline

Set the velocity cutoff factors.

References _cutoffHigh, and _cutoffLow.

void osgParticle::DampingOperator::setCutoffHigh ( float  low)
inline

References _cutoffHigh.

void osgParticle::DampingOperator::setCutoffLow ( float  low)
inline

References _cutoffLow.

void osgParticle::DampingOperator::setDamping ( float  x,
float  y,
float  z 
)
inline

Set the damping factors.

References _damping, and osg::Vec3f::set().

void osgParticle::DampingOperator::setDamping ( const osg::Vec3 damping)
inline

References _damping.

void osgParticle::DampingOperator::setDamping ( float  x)
inline

Set the damping factors to one value.

References _damping, and osg::Vec3f::set().


Member Data Documentation

float osgParticle::DampingOperator::_cutoffHigh
protected
float osgParticle::DampingOperator::_cutoffLow
protected
osg::Vec3 osgParticle::DampingOperator::_damping
protected

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

osg logo
Generated at Fri Nov 2 2012 21:42:45 for the OpenSceneGraph by doxygen 1.8.1.1.