OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgParticle::DomainOperator Class Reference

#include <DomainOperator.h>

Inheritance diagram for osgParticle::DomainOperator:
Inheritance graph
[legend]
Collaboration diagram for osgParticle::DomainOperator:
Collaboration graph
[legend]

Classes

struct  Domain
 

Public Member Functions

 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 beginOperate (Program *prg)
 Perform some initializations. 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
 
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)
 
- 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 StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () 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)
 
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
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 ~DomainOperator ()
 
DomainOperatoroperator= (const DomainOperator &)
 
virtual void handlePoint (const Domain &, Particle *, double)
 
virtual void handleLineSegment (const Domain &, Particle *, double)
 
virtual void handleTriangle (const Domain &, Particle *, double)
 
virtual void handleRectangle (const Domain &, Particle *, double)
 
virtual void handlePlane (const Domain &, Particle *, double)
 
virtual void handleSphere (const Domain &, Particle *, double)
 
virtual void handleBox (const Domain &, Particle *, double)
 
virtual void handleDisk (const Domain &, Particle *, double)
 
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

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

- 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 domain operator which accepts different domain shapes as the parameter. It can be derived to implement operators that require particles interacting with domains. Refer to David McAllister's Particle System API (http://www.particlesystems.org)

Definition at line 30 of file DomainOperator.h.

Constructor & Destructor Documentation

osgParticle::DomainOperator::DomainOperator ( )
inline

Definition at line 60 of file DomainOperator.h.

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

Definition at line 64 of file DomainOperator.h.

virtual osgParticle::DomainOperator::~DomainOperator ( )
inlineprotectedvirtual

Definition at line 120 of file DomainOperator.h.

Member Function Documentation

void osgParticle::DomainOperator::addBoxDomain ( const osg::Vec3 min,
const osg::Vec3 max 
)
inline

Add a box domain.

Definition at line 194 of file DomainOperator.h.

void osgParticle::DomainOperator::addDiskDomain ( const osg::Vec3 c,
const osg::Vec3 n,
float  r1,
float  r2 = 0.0f 
)
inline

Add a disk domain.

Definition at line 202 of file DomainOperator.h.

Here is the call graph for this function:

void osgParticle::DomainOperator::addDomain ( const Domain domain)
inline

Add a domain object directly, used by the .osg wrappers and serializers.

Definition at line 95 of file DomainOperator.h.

void osgParticle::DomainOperator::addLineSegmentDomain ( const osg::Vec3 v1,
const osg::Vec3 v2 
)
inline

Add a line segment domain.

Definition at line 148 of file DomainOperator.h.

void osgParticle::DomainOperator::addPlaneDomain ( const osg::Plane plane)
inline

Add a plane domain.

Definition at line 179 of file DomainOperator.h.

Here is the call graph for this function:

void osgParticle::DomainOperator::addPointDomain ( const osg::Vec3 p)
inline

Add a point domain.

Definition at line 141 of file DomainOperator.h.

void osgParticle::DomainOperator::addRectangleDomain ( const osg::Vec3 corner,
const osg::Vec3 w,
const osg::Vec3 h 
)
inline

Add a rectangle domain.

Definition at line 168 of file DomainOperator.h.

Here is the call graph for this function:

void osgParticle::DomainOperator::addSphereDomain ( const osg::Vec3 c,
float  r 
)
inline

Add a sphere domain.

Definition at line 186 of file DomainOperator.h.

void osgParticle::DomainOperator::addTriangleDomain ( const osg::Vec3 v1,
const osg::Vec3 v2,
const osg::Vec3 v3 
)
inline

Add a triangle domain.

Definition at line 157 of file DomainOperator.h.

Here is the call graph for this function:

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

Perform some initializations. Do not call this method manually.

Reimplemented from osgParticle::Operator.

Reimplemented in osgParticle::SinkOperator.

void osgParticle::DomainOperator::computeNewBasis ( const osg::Vec3 u,
const osg::Vec3 v,
osg::Vec3 s1,
osg::Vec3 s2 
)
inlineprotected

Definition at line 213 of file DomainOperator.h.

Here is the call graph for this function:

Here is the caller graph for this function:

void osgParticle::DomainOperator::endOperate ( )
virtual

Perform some post-operations. Do not call this method manually.

Reimplemented from osgParticle::Operator.

const Domain& osgParticle::DomainOperator::getDomain ( unsigned int  i) const
inline

Get a domain object directly, used by the .osg wrappers and serializers.

Definition at line 98 of file DomainOperator.h.

unsigned int osgParticle::DomainOperator::getNumDomains ( ) const
inline

Get number of domains.

Definition at line 108 of file DomainOperator.h.

virtual void osgParticle::DomainOperator::handleBox ( const Domain ,
Particle ,
double   
)
inlineprotectedvirtual

Reimplemented in osgParticle::SinkOperator.

Definition at line 129 of file DomainOperator.h.

virtual void osgParticle::DomainOperator::handleDisk ( const Domain ,
Particle ,
double   
)
inlineprotectedvirtual

Reimplemented in osgParticle::SinkOperator, and osgParticle::BounceOperator.

Definition at line 130 of file DomainOperator.h.

virtual void osgParticle::DomainOperator::handleLineSegment ( const Domain ,
Particle ,
double   
)
inlineprotectedvirtual

Reimplemented in osgParticle::SinkOperator.

Definition at line 124 of file DomainOperator.h.

virtual void osgParticle::DomainOperator::handlePlane ( const Domain ,
Particle ,
double   
)
inlineprotectedvirtual

Reimplemented in osgParticle::SinkOperator, and osgParticle::BounceOperator.

Definition at line 127 of file DomainOperator.h.

virtual void osgParticle::DomainOperator::handlePoint ( const Domain ,
Particle ,
double   
)
inlineprotectedvirtual

Reimplemented in osgParticle::SinkOperator.

Definition at line 123 of file DomainOperator.h.

virtual void osgParticle::DomainOperator::handleRectangle ( const Domain ,
Particle ,
double   
)
inlineprotectedvirtual

Reimplemented in osgParticle::SinkOperator, and osgParticle::BounceOperator.

Definition at line 126 of file DomainOperator.h.

virtual void osgParticle::DomainOperator::handleSphere ( const Domain ,
Particle ,
double   
)
inlineprotectedvirtual

Reimplemented in osgParticle::SinkOperator, and osgParticle::BounceOperator.

Definition at line 128 of file DomainOperator.h.

virtual void osgParticle::DomainOperator::handleTriangle ( const Domain ,
Particle ,
double   
)
inlineprotectedvirtual

Reimplemented in osgParticle::SinkOperator, and osgParticle::BounceOperator.

Definition at line 125 of file DomainOperator.h.

void osgParticle::DomainOperator::ignore ( const std::string &  func)
inlineprotected

Definition at line 227 of file DomainOperator.h.

Here is the call graph for this function:

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

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

Implements osgParticle::Operator.

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

Definition at line 121 of file DomainOperator.h.

void osgParticle::DomainOperator::removeAllDomains ( )
inline

Remove all existing domains.

Definition at line 105 of file DomainOperator.h.

void osgParticle::DomainOperator::removeDomain ( unsigned int  i)
inline

Remove a domain at specific index.

Definition at line 101 of file DomainOperator.h.

Member Data Documentation

std::vector<Domain> osgParticle::DomainOperator::_backupDomains
protected

Definition at line 136 of file DomainOperator.h.

std::vector<Domain> osgParticle::DomainOperator::_domains
protected

Definition at line 135 of file DomainOperator.h.


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