openscenegraph
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgParticle::DomainOperator Class Reference

#include <DomainOperator>

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

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.
 
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 beginOperate (Program *prg)
 Perform some initializations. 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 ~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 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)

Constructor & Destructor Documentation

◆ DomainOperator() [1/2]

osgParticle::DomainOperator::DomainOperator ( )
inline

◆ DomainOperator() [2/2]

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

◆ ~DomainOperator()

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

Member Function Documentation

◆ addBoxDomain()

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

Add a box domain.

◆ addDiskDomain()

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

Add a disk domain.

◆ addDomain()

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

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

◆ addLineSegmentDomain()

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

Add a line segment domain.

◆ addPlaneDomain()

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

Add a plane domain.

◆ addPointDomain()

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

Add a point domain.

◆ addRectangleDomain()

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

Add a rectangle domain.

◆ addSphereDomain()

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

Add a sphere domain.

◆ addTriangleDomain()

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

Add a triangle domain.

◆ beginOperate()

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

Perform some initializations. Do not call this method manually.

Reimplemented from osgParticle::Operator.

Reimplemented in osgParticle::SinkOperator.

◆ computeNewBasis()

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

◆ endOperate()

void osgParticle::DomainOperator::endOperate ( )
virtual

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

Reimplemented from osgParticle::Operator.

◆ getDomain()

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

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

◆ getNumDomains()

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

Get number of domains.

◆ handleBox()

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

Reimplemented in osgParticle::SinkOperator.

◆ handleDisk()

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

◆ handleLineSegment()

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

Reimplemented in osgParticle::SinkOperator.

◆ handlePlane()

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

◆ handlePoint()

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

Reimplemented in osgParticle::SinkOperator.

◆ handleRectangle()

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

◆ handleSphere()

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

◆ handleTriangle()

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

◆ ignore()

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

◆ META_Object()

osgParticle::DomainOperator::META_Object ( osgParticle  ,
DomainOperator   
)

◆ operate()

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

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

Implements osgParticle::Operator.

◆ operator=()

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

◆ removeAllDomains()

void osgParticle::DomainOperator::removeAllDomains ( )
inline

Remove all existing domains.

◆ removeDomain()

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

Remove a domain at specific index.

Member Data Documentation

◆ _backupDomains

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

◆ _domains

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

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