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

A sink operator kills particles if positions or velocities inside/outside the specified domain. More...

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

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. More...
 
SinkTarget getSinkTarget () const
 Get the sink strategy. More...
 
void setSinkStrategy (SinkStrategy ss)
 Set the sink strategy. More...
 
SinkStrategy getSinkStrategy () const
 Get the sink strategy. More...
 
void beginOperate (Program *prg)
 Perform some initializations. Do not call this method manually. More...
 
- 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. More...
 
void addLineSegmentDomain (const osg::Vec3 &v1, const osg::Vec3 &v2)
 Add a line segment domain. More...
 
void addTriangleDomain (const osg::Vec3 &v1, const osg::Vec3 &v2, const osg::Vec3 &v3)
 Add a triangle domain. More...
 
void addRectangleDomain (const osg::Vec3 &corner, const osg::Vec3 &w, const osg::Vec3 &h)
 Add a rectangle domain. More...
 
void addPlaneDomain (const osg::Plane &plane)
 Add a plane domain. More...
 
void addSphereDomain (const osg::Vec3 &c, float r)
 Add a sphere domain. More...
 
void addBoxDomain (const osg::Vec3 &min, const osg::Vec3 &max)
 Add a box domain. More...
 
void addDiskDomain (const osg::Vec3 &c, const osg::Vec3 &n, float r1, float r2=0.0f)
 Add a disk domain. More...
 
void addDomain (const Domain &domain)
 Add a domain object directly, used by the .osg wrappers and serializers. More...
 
const DomaingetDomain (unsigned int i) const
 Get a domain object directly, used by the .osg wrappers and serializers. More...
 
void removeDomain (unsigned int i)
 Remove a domain at specific index. More...
 
void removeAllDomains ()
 Remove all existing domains. More...
 
unsigned int getNumDomains () const
 Get number of domains. More...
 
void operate (Particle *P, double dt)
 Apply the acceleration to a particle. Do not call this method manually. More...
 
void endOperate ()
 Perform some post-operations. 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
 return the name of the object's library. More...
 
virtual const char * className () const
 return the name of the object's class type. More...
 
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)
 Do something on all emitted particles. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 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. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience 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. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- 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. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

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 ()
 Object destructor. More...
 
- 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::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

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

Enumerator
SINK_INSIDE 
SINK_OUTSIDE 
Enumerator
SINK_POSITION 
SINK_VELOCITY 
SINK_ANGULAR_VELOCITY 

Constructor & Destructor Documentation

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

Member Function Documentation

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

Perform some initializations. Do not call this method manually.

Reimplemented from osgParticle::DomainOperator.

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

Get the sink strategy.

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

Get the sink strategy.

const osg::Vec3 & osgParticle::SinkOperator::getValue ( Particle P)
inlineprotected
virtual void osgParticle::SinkOperator::handleBox ( const Domain domain,
Particle P,
double  dt 
)
protectedvirtual

Reimplemented from osgParticle::DomainOperator.

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

Reimplemented from osgParticle::DomainOperator.

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

Reimplemented from osgParticle::DomainOperator.

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

Reimplemented from osgParticle::DomainOperator.

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

Reimplemented from osgParticle::DomainOperator.

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

Reimplemented from osgParticle::DomainOperator.

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

Reimplemented from osgParticle::DomainOperator.

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

Reimplemented from osgParticle::DomainOperator.

void osgParticle::SinkOperator::kill ( Particle P,
bool  insideDomain 
)
inlineprotected
osgParticle::SinkOperator::META_Object ( osgParticle  ,
SinkOperator   
)
SinkOperator& osgParticle::SinkOperator::operator= ( const SinkOperator )
inlineprotected
void osgParticle::SinkOperator::setSinkStrategy ( SinkStrategy  ss)
inline

Set the sink strategy.

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

Set the sink strategy.

Member Data Documentation

SinkStrategy osgParticle::SinkOperator::_sinkStrategy
protected
SinkTarget osgParticle::SinkOperator::_sinkTarget
protected

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

osg logo
Generated at Wed Nov 11 2015 22:15:05 for the OpenSceneGraph by doxygen 1.8.10.