openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgParticle::SinkOperator Class Reference

#include <SinkOperator>

Inheritance diagram for osgParticle::SinkOperator:
osgParticle::DomainOperator osgParticle::Operator osg::Object osg::Referenced

Public Types

enum  SinkTarget { SINK_POSITION , SINK_VELOCITY , SINK_ANGULAR_VELOCITY }
 
enum  SinkStrategy { SINK_INSIDE , SINK_OUTSIDE }
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 

Public Member Functions

 SinkOperator ()
 
 SinkOperator (const SinkOperator &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgParticle, SinkOperator)
 
void setSinkTarget (SinkTarget so)
 Set the sink strategy.
 
SinkTarget getSinkTarget () const
 Get the sink strategy.
 
void setSinkStrategy (SinkStrategy ss)
 Set the sink strategy.
 
SinkStrategy getSinkStrategy () const
 Get the sink strategy.
 
void beginOperate (Program *prg)
 Perform some initializations. Do not call this method manually.
 
- Public Member Functions inherited from osgParticle::DomainOperator
 DomainOperator ()
 
 DomainOperator (const DomainOperator &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
 META_Object (osgParticle, DomainOperator)
 
void addPointDomain (const osg::Vec3 &p)
 Add a point domain.
 
void addLineSegmentDomain (const osg::Vec3 &v1, const osg::Vec3 &v2)
 Add a line segment domain.
 
void addTriangleDomain (const osg::Vec3 &v1, const osg::Vec3 &v2, const osg::Vec3 &v3)
 Add a triangle domain.
 
void addRectangleDomain (const osg::Vec3 &corner, const osg::Vec3 &w, const osg::Vec3 &h)
 Add a rectangle domain.
 
void addPlaneDomain (const osg::Plane &plane)
 Add a plane domain.
 
void addSphereDomain (const osg::Vec3 &c, float r)
 Add a sphere domain.
 
void addBoxDomain (const osg::Vec3 &min, const osg::Vec3 &max)
 Add a box domain.
 
void addDiskDomain (const osg::Vec3 &c, const osg::Vec3 &n, float r1, float r2=0.0f)
 Add a disk domain.
 
void addDomain (const Domain &domain)
 Add a domain object directly, used by the .osg wrappers and serializers.
 
const DomaingetDomain (unsigned int i) const
 Get a domain object directly, used by the .osg wrappers and serializers.
 
void removeDomain (unsigned int i)
 Remove a domain at specific index.
 
void removeAllDomains ()
 Remove all existing domains.
 
unsigned int getNumDomains () const
 Get number of domains.
 
void operate (Particle *P, double dt)
 Apply the acceleration to a particle. Do not call this method manually.
 
void endOperate ()
 Perform some post-operations. 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)
 
- 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
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
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)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
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 BoundingBoxdValueObject BoundingSpheredValueObject 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 ~SinkOperator ()
 
SinkOperatoroperator= (const SinkOperator &)
 
virtual void handlePoint (const Domain &domain, Particle *P, double dt)
 
virtual void handleLineSegment (const Domain &domain, Particle *P, double dt)
 
virtual void handleTriangle (const Domain &domain, Particle *P, double dt)
 
virtual void handleRectangle (const Domain &domain, Particle *P, double dt)
 
virtual void handlePlane (const Domain &domain, Particle *P, double dt)
 
virtual void handleSphere (const Domain &domain, Particle *P, double dt)
 
virtual void handleBox (const Domain &domain, Particle *P, double dt)
 
virtual void handleDisk (const Domain &domain, Particle *P, double dt)
 
const osg::Vec3getValue (Particle *P)
 
void kill (Particle *P, bool insideDomain)
 
- Protected Member Functions inherited from osgParticle::DomainOperator
virtual ~DomainOperator ()
 
DomainOperatoroperator= (const DomainOperator &)
 
void computeNewBasis (const osg::Vec3 &, const osg::Vec3 &, osg::Vec3 &, osg::Vec3 &)
 
void ignore (const std::string &func)
 
- 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

SinkTarget _sinkTarget
 
SinkStrategy _sinkStrategy
 
- Protected Attributes inherited from osgParticle::DomainOperator
std::vector< Domain_domains
 
std::vector< Domain_backupDomains
 
- 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

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 

Detailed Description

A sink operator kills particles if positions or velocities inside/outside the specified domain. Refer to David McAllister's Particle System API (http://www.particlesystems.org)

Member Enumeration Documentation

◆ SinkStrategy

Enumerator
SINK_INSIDE 
SINK_OUTSIDE 

◆ SinkTarget

Enumerator
SINK_POSITION 
SINK_VELOCITY 
SINK_ANGULAR_VELOCITY 

Constructor & Destructor Documentation

◆ SinkOperator() [1/2]

osgParticle::SinkOperator::SinkOperator ( )
inline

◆ SinkOperator() [2/2]

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

◆ ~SinkOperator()

virtual osgParticle::SinkOperator::~SinkOperator ( )
inlineprotectedvirtual

Member Function Documentation

◆ beginOperate()

void osgParticle::SinkOperator::beginOperate ( Program prg)
virtual

Perform some initializations. Do not call this method manually.

Reimplemented from osgParticle::DomainOperator.

◆ getSinkStrategy()

SinkStrategy osgParticle::SinkOperator::getSinkStrategy ( ) const
inline

Get the sink strategy.

◆ getSinkTarget()

SinkTarget osgParticle::SinkOperator::getSinkTarget ( ) const
inline

Get the sink strategy.

◆ getValue()

const osg::Vec3 & osgParticle::SinkOperator::getValue ( Particle P)
inlineprotected

◆ handleBox()

virtual void osgParticle::SinkOperator::handleBox ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

◆ handleDisk()

virtual void osgParticle::SinkOperator::handleDisk ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

◆ handleLineSegment()

virtual void osgParticle::SinkOperator::handleLineSegment ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

◆ handlePlane()

virtual void osgParticle::SinkOperator::handlePlane ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

◆ handlePoint()

virtual void osgParticle::SinkOperator::handlePoint ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

◆ handleRectangle()

virtual void osgParticle::SinkOperator::handleRectangle ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

◆ handleSphere()

virtual void osgParticle::SinkOperator::handleSphere ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

◆ handleTriangle()

virtual void osgParticle::SinkOperator::handleTriangle ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

◆ kill()

void osgParticle::SinkOperator::kill ( Particle P,
bool  insideDomain 
)
inlineprotected

◆ META_Object()

osgParticle::SinkOperator::META_Object ( osgParticle  ,
SinkOperator   
)

◆ operator=()

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

◆ setSinkStrategy()

void osgParticle::SinkOperator::setSinkStrategy ( SinkStrategy  ss)
inline

Set the sink strategy.

◆ setSinkTarget()

void osgParticle::SinkOperator::setSinkTarget ( SinkTarget  so)
inline

Set the sink strategy.

Member Data Documentation

◆ _sinkStrategy

SinkStrategy osgParticle::SinkOperator::_sinkStrategy
protected

◆ _sinkTarget

SinkTarget osgParticle::SinkOperator::_sinkTarget
protected

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