Public Member Functions | Protected Member Functions | Protected Attributes
AttractOperator Class Reference

#include <DredgeTool.h>

List of all members.

Public Member Functions

 AttractOperator ()
 AttractOperator (const AttractOperator &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
bool getKillSink () const
 Get whether the attractor kills the particles once they arrive.
float getMagnitude () const
 Get the acceleration scale.
 META_Object (spin, AttractOperator)
void operate (osgParticle::Particle *P, double dt)
 Apply attraction to a particle. Do not call this method manually.
void setKillSink (bool kill)
 Set whether the attractor kills the particles once they arrive.
void setMagnitude (float mag)
 Set the acceleration scale.

Protected Member Functions

AttractOperatoroperator= (const AttractOperator &)
virtual ~AttractOperator ()

Protected Attributes

bool _killSink
float _magnitude

Detailed Description

Definition at line 31 of file DredgeTool.h.


Constructor & Destructor Documentation

Definition at line 34 of file DredgeTool.h.

AttractOperator::AttractOperator ( const AttractOperator copy,
const osg::CopyOp &  copyop = osg::CopyOp::SHALLOW_COPY 
) [inline]

Definition at line 35 of file DredgeTool.h.

virtual AttractOperator::~AttractOperator ( ) [inline, protected, virtual]

Definition at line 52 of file DredgeTool.h.


Member Function Documentation

bool AttractOperator::getKillSink ( ) const [inline]

Get whether the attractor kills the particles once they arrive.

Definition at line 47 of file DredgeTool.h.

float AttractOperator::getMagnitude ( ) const [inline]

Get the acceleration scale.

Definition at line 43 of file DredgeTool.h.

void AttractOperator::operate ( osgParticle::Particle *  P,
double  dt 
) [inline]

Apply attraction to a particle. Do not call this method manually.

Definition at line 19 of file DredgeTool.cpp.

AttractOperator& AttractOperator::operator= ( const AttractOperator ) [inline, protected]

Definition at line 53 of file DredgeTool.h.

void AttractOperator::setKillSink ( bool  kill) [inline]

Set whether the attractor kills the particles once they arrive.

Definition at line 45 of file DredgeTool.h.

void AttractOperator::setMagnitude ( float  mag) [inline]

Set the acceleration scale.

Definition at line 41 of file DredgeTool.h.


Member Data Documentation

bool AttractOperator::_killSink [protected]

Definition at line 55 of file DredgeTool.h.

float AttractOperator::_magnitude [protected]

Definition at line 54 of file DredgeTool.h.


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


uwsim
Author(s): Mario Prats , Javier Perez
autogenerated on Fri Aug 28 2015 13:28:58