openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgParticle::FluidProgram Class Reference
Inheritance diagram for osgParticle::FluidProgram:
osgParticle::Program osgParticle::ParticleProcessor osg::Node osg::Object osg::Referenced

Public Member Functions

 FluidProgram ()
 FluidProgram (const FluidProgram &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Node (osgParticle, FluidProgram)
void setFluidViscosity (float v)
 Set the viscosity of the fluid.
float getFluidViscosity () const
 Get the viscosity of the fluid.
void setFluidDensity (float d)
 Set the density of the fluid.
float getFluidDensity () const
 Get the density of the fluid.
void setWind (const osg::Vec3 &wind)
 Set the wind vector.
const osg::Vec3getWind () const
 Get the wind vector.
void setAcceleration (const osg::Vec3 &v)
 Set the acceleration vector.
const osg::Vec3getAcceleration () const
 Get the acceleration vector.
void setToGravity (float scale=1.0f)
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).
- Public Member Functions inherited from osgParticle::Program
 Program ()
 Program (const Program &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
virtual void accept (osg::NodeVisitor &nv)
- Public Member Functions inherited from osgParticle::ParticleProcessor
 ParticleProcessor ()
 ParticleProcessor (const ParticleProcessor &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
ReferenceFrame getReferenceFrame () const
 Get the reference frame.
void setReferenceFrame (ReferenceFrame rf)
 Set the reference frame.
bool getEnabled () const
 Get whether this processor is enabled or not.
bool isEnabled () const
void setEnabled (bool v)
 Set whether this processor is enabled or not.
ParticleSystemgetParticleSystem ()
 Get a pointer to the destination particle system.
const ParticleSystemgetParticleSystem () const
 Get a const pointer to the destination particle system.
void setParticleSystem (ParticleSystem *ps)
 Set the destination particle system.
void setEndless (bool type)
 Set the endless flag of this processor.
bool getEndless () const
 Check whether this processor is endless.
bool isEndless () const
void setLifeTime (double t)
 Set the lifetime of this processor.
double getLifeTime () const
 Get the lifetime of this processor.
void setStartTime (double t)
 Set the start time of this processor.
double getStartTime () const
 Get the start time of this processor.
void setCurrentTime (double t)
 Set the current time of this processor.
double getCurrentTime () const
 Get the current time of this processor.
void setResetTime (double t)
 Set the reset time of this processor. A value of 0 disables reset.
double getResetTime () const
 Get the reset time of this processor.
bool isAlive () const
void traverse (osg::NodeVisitor &nv)
const osg::MatrixgetLocalToWorldMatrix ()
 Get the current local-to-world transformation matrix (valid only during cull traversal).
const osg::MatrixgetWorldToLocalMatrix ()
 Get the current world-to-local transformation matrix (valid only during cull traversal).
const osg::MatrixgetPreviousLocalToWorldMatrix ()
 Get the previous local-to-world transformation matrix (valid only during cull traversal).
const osg::MatrixgetPreviousWorldToLocalMatrix ()
 Get the previous world-to-local transformation matrix (valid only during cull traversal).
osg::Vec3 transformLocalToWorld (const osg::Vec3 &P)
 Transform a point from local to world coordinates (valid only during cull traversal).
osg::Vec3 rotateLocalToWorld (const osg::Vec3 &P)
 Transform a vector from local to world coordinates, discarding translation (valid only during cull traversal).
osg::Vec3 transformWorldToLocal (const osg::Vec3 &P)
 Transform a point from world to local coordinates (valid only during cull traversal).
osg::Vec3 rotateWorldToLocal (const osg::Vec3 &P)
 Transform a vector from world to local coordinates, discarding translation (valid only during cull traversal).
virtual osg::BoundingSphere computeBound () const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void ascend (NodeVisitor &nv)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
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)
- 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 ~FluidProgram ()
FluidProgramoperator= (const FluidProgram &)
virtual void execute (double dt)
 Execute the program on the particle system. Must be overriden in descendant classes.
- Protected Member Functions inherited from osgParticle::Program
virtual ~Program ()
Programoperator= (const Program &)
void process (double dt)
 Implementation of ParticleProcessor::process(). Do not call this method by yourself.
- Protected Member Functions inherited from osgParticle::ParticleProcessor
virtual ~ParticleProcessor ()
ParticleProcessoroperator= (const ParticleProcessor &)
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
- 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 _acceleration
float _viscosity
float _density
osg::Vec3 _wind
float _viscosityCoefficient
float _densityCoefficient

Additional Inherited Members

- Public Types inherited from osgParticle::ParticleProcessor
enum  ReferenceFrame { RELATIVE_RF, ABSOLUTE_RF }
- 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 program class for performing operations on particles using a sequence of operators. To use a FluidProgram you have to create some Operator objects and add them to the program. All operators will be applied to each particle in the same order they've been added to the program.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void osgParticle::FluidProgram::execute ( double  dt)
protectedvirtual

Execute the program on the particle system. Must be overriden in descendant classes.

Implements osgParticle::Program.

const osg::Vec3& osgParticle::FluidProgram::getAcceleration ( ) const
inline

Get the acceleration vector.

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

Get the density of the fluid.

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

Get the viscosity of the fluid.

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

Get the wind vector.

osgParticle::FluidProgram::META_Node ( osgParticle  ,
FluidProgram   
)
FluidProgram& osgParticle::FluidProgram::operator= ( const FluidProgram )
inlineprotected
void osgParticle::FluidProgram::setAcceleration ( const osg::Vec3 v)
inline

Set the acceleration vector.

void osgParticle::FluidProgram::setFluidDensity ( float  d)
inline

Set the density of the fluid.

References osg::PI.

void osgParticle::FluidProgram::setFluidToAir ( )
inline

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

void osgParticle::FluidProgram::setFluidToWater ( )
inline

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

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

Set the viscosity of the fluid.

References osg::PI.

void osgParticle::FluidProgram::setToGravity ( float  scale = 1.0f)
inline

Set the acceleration vector to the gravity on earth (0, 0, -9.81). The acceleration will be multiplied by the scale parameter.

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

Set the wind vector.

Member Data Documentation

osg::Vec3 osgParticle::FluidProgram::_acceleration
protected
float osgParticle::FluidProgram::_density
protected
float osgParticle::FluidProgram::_densityCoefficient
protected
float osgParticle::FluidProgram::_viscosity
protected
float osgParticle::FluidProgram::_viscosityCoefficient
protected
osg::Vec3 osgParticle::FluidProgram::_wind
protected

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