openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgParticle::DampingOperator Class Reference
Inheritance diagram for osgParticle::DampingOperator:
osgParticle::Operator osg::Object osg::Referenced

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. More...
 
void setDamping (const osg::Vec3 &damping)
 
void setDamping (float x)
 Set the damping factors to one value. More...
 
void getDamping (float &x, float &y, float &z) const
 Get the damping factors. More...
 
const osg::Vec3getDamping () const
 
void setCutoff (float low, float high)
 Set the velocity cutoff factors. More...
 
void setCutoffLow (float low)
 
void setCutoffHigh (float low)
 
void getCutoff (float &low, float &high) const
 Get the velocity cutoff factors. More...
 
float getCutoffLow () const
 
float getCutoffHigh () const
 
void operate (Particle *P, double dt)
 Apply the acceleration to a particle. Do not call this method manually. More...
 
- 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
 
virtual const char * className () const
 
virtual bool isSameKindAs (const osg::Object *obj) const
 
bool isEnabled () const
 Get whether this operator is enabled. More...
 
void setEnabled (bool v)
 Enable or disable this operator. More...
 
virtual void operateParticles (ParticleSystem *ps, double dt)
 
virtual void beginOperate (Program *)
 
virtual void endOperate ()
 Do something after all particles have been processed. More...
 
- 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
 
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::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
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 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 ~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 ()
 
- 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
 
- 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
 

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 setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

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

§ DampingOperator() [1/2]

osgParticle::DampingOperator::DampingOperator ( )
inline

§ DampingOperator() [2/2]

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

§ ~DampingOperator()

virtual osgParticle::DampingOperator::~DampingOperator ( )
inlineprotectedvirtual

Member Function Documentation

§ getCutoff()

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

Get the velocity cutoff factors.

§ getCutoffHigh()

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

§ getCutoffLow()

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

§ getDamping() [1/2]

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

Get the damping factors.

§ getDamping() [2/2]

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

§ META_Object()

osgParticle::DampingOperator::META_Object ( osgParticle  ,
DampingOperator   
)

§ operate()

void osgParticle::DampingOperator::operate ( Particle P,
double  dt 
)
inlinevirtual

Apply the acceleration to a particle. Do not call this method manually.

Implements osgParticle::Operator.

§ operator=()

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

§ setCutoff()

void osgParticle::DampingOperator::setCutoff ( float  low,
float  high 
)
inline

Set the velocity cutoff factors.

§ setCutoffHigh()

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

§ setCutoffLow()

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

§ setDamping() [1/3]

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

Set the damping factors.

§ setDamping() [2/3]

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

§ setDamping() [3/3]

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

Set the damping factors to one value.

Member Data Documentation

§ _cutoffHigh

float osgParticle::DampingOperator::_cutoffHigh
protected

§ _cutoffLow

float osgParticle::DampingOperator::_cutoffLow
protected

§ _damping

osg::Vec3 osgParticle::DampingOperator::_damping
protected

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