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

Public Member Functions

 FluidFrictionOperator ()
 FluidFrictionOperator (const FluidFrictionOperator &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Object (osgParticle, FluidFrictionOperator)
void setFluidDensity (float d)
 Set the density of the fluid.
float getFluidDensity () const
 Get the density of the fluid.
void setFluidViscosity (float v)
 Set the viscosity of the fluid.
float getFluidViscosity () const
 Get the viscosity of the fluid.
void setWind (const osg::Vec3 &wind)
 Set the wind vector.
const osg::Vec3getWind () const
 Get the wind vector.
void setOverrideRadius (float r)
 Set the overriden radius value (pass 0 if you want to use particle's radius).
float getOverrideRadius () const
 Get the overriden radius value.
void setFluidToAir ()
 Set the fluid parameters as for air (20°C temperature).
void setFluidToWater ()
 Set the fluid parameters as for pure water (20°C temperature).
void operate (Particle *P, double dt)
 Apply the friction forces to a particle. Do not call this method manually.
void beginOperate (Program *prg)
 Perform some initializations. 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
virtual const char * className () const
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)
virtual void endOperate ()
 Do something after all particles have been processed.
- 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
- 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 ~FluidFrictionOperator ()
FluidFrictionOperatoroperator= (const FluidFrictionOperator &)
- 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

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 ()
- Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer

Detailed Description

An operator that simulates the friction of a fluid. By using this operator you can let the particles move in a fluid of a given density and viscosity. There are two functions to quickly setup the parameters for pure water and air. You can decide whether to compute the forces using the particle's physical radius or another value, by calling the setOverrideRadius() method.

Constructor & Destructor Documentation

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

Member Function Documentation

void osgParticle::FluidFrictionOperator::beginOperate ( Program prg)
inlinevirtual

Perform some initializations. Do not call this method manually.

Reimplemented from osgParticle::Operator.

float osgParticle::FluidFrictionOperator::getFluidDensity ( ) const
inline

Get the density of the fluid.

float osgParticle::FluidFrictionOperator::getFluidViscosity ( ) const
inline

Get the viscosity of the fluid.

float osgParticle::FluidFrictionOperator::getOverrideRadius ( ) const
inline

Get the overriden radius value.

const osg::Vec3& osgParticle::FluidFrictionOperator::getWind ( ) const
inline

Get the wind vector.

osgParticle::FluidFrictionOperator::META_Object ( osgParticle  ,
FluidFrictionOperator   
)
void osgParticle::FluidFrictionOperator::operate ( Particle P,
double  dt 
)
virtual

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

Implements osgParticle::Operator.

FluidFrictionOperator& osgParticle::FluidFrictionOperator::operator= ( const FluidFrictionOperator )
inlineprotected
void osgParticle::FluidFrictionOperator::setFluidDensity ( float  d)
inline

Set the density of the fluid.

References osg::PI.

Referenced by setFluidToAir(), and setFluidToWater().

void osgParticle::FluidFrictionOperator::setFluidToAir ( )
inline

Set the fluid parameters as for air (20°C temperature).

References setFluidDensity(), and setFluidViscosity().

void osgParticle::FluidFrictionOperator::setFluidToWater ( )
inline

Set the fluid parameters as for pure water (20°C temperature).

References setFluidDensity(), and setFluidViscosity().

void osgParticle::FluidFrictionOperator::setFluidViscosity ( float  v)
inline

Set the viscosity of the fluid.

References osg::PI.

Referenced by setFluidToAir(), and setFluidToWater().

void osgParticle::FluidFrictionOperator::setOverrideRadius ( float  r)
inline

Set the overriden radius value (pass 0 if you want to use particle's radius).

void osgParticle::FluidFrictionOperator::setWind ( const osg::Vec3 wind)
inline

Set the wind vector.


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