sofa::component::ParticleSink< TDataTypes > Class Template Reference
#include <ParticleSink.h>
Public Types | |
| typedef TDataTypes | DataTypes |
| typedef DataTypes::Real | Real |
| typedef DataTypes::Coord | Coord |
| typedef DataTypes::VecCoord | VecCoord |
| typedef DataTypes::Deriv | Deriv |
| typedef DataTypes::VecDeriv | VecDeriv |
| typedef helper::vector< Real > | VecDensity |
| typedef core::componentmodel::behavior::MechanicalState < DataTypes > | MechanicalModel |
Public Member Functions | |
| ParticleSink () | |
| virtual | ~ParticleSink () |
| virtual void | init () |
| Initialization method called at graph modification, during bottom-up traversal. | |
| virtual void | animateBegin (double, double time) |
| void | handleTopologyChange () |
| Handle topological changes. | |
| virtual void | projectResponse (VecDeriv &res) |
| Project dx to constrained space (dx models an acceleration). | |
| virtual void | projectVelocity (VecDeriv &) |
| Project v to constrained space (v models a velocity). | |
| virtual void | projectPosition (VecCoord &x) |
| Project x to constrained space (x models a position). | |
| virtual void | animateEnd (double, double) |
| virtual void | handleEvent (sofa::core::objectmodel::Event *event) |
| Handle an event. | |
| virtual void | draw () |
| Render internal data of this object, for debugging purposes. | |
Data Fields | |
| Data< Deriv > | planeNormal |
| Data< Real > | planeD0 |
| Data< Real > | planeD1 |
| Data< defaulttype::Vec3f > | color |
| Data< bool > | showPlane |
| topology::PointSubset | fixed |
Detailed Description
template<class TDataTypes>
class sofa::component::ParticleSink< TDataTypes >
Definition at line 63 of file ParticleSink.h.
Member Typedef Documentation
| typedef DataTypes::Coord sofa::component::ParticleSink< TDataTypes >::Coord |
Reimplemented from sofa::core::componentmodel::behavior::Constraint< TDataTypes >.
Definition at line 68 of file ParticleSink.h.
| typedef TDataTypes sofa::component::ParticleSink< TDataTypes >::DataTypes |
Definition at line 66 of file ParticleSink.h.
| typedef DataTypes::Deriv sofa::component::ParticleSink< TDataTypes >::Deriv |
Reimplemented from sofa::core::componentmodel::behavior::Constraint< TDataTypes >.
Definition at line 70 of file ParticleSink.h.
| typedef core::componentmodel::behavior::MechanicalState<DataTypes> sofa::component::ParticleSink< TDataTypes >::MechanicalModel |
Definition at line 74 of file ParticleSink.h.
| typedef DataTypes::Real sofa::component::ParticleSink< TDataTypes >::Real |
Reimplemented from sofa::core::componentmodel::behavior::Constraint< TDataTypes >.
Definition at line 67 of file ParticleSink.h.
| typedef DataTypes::VecCoord sofa::component::ParticleSink< TDataTypes >::VecCoord |
Reimplemented from sofa::core::componentmodel::behavior::Constraint< TDataTypes >.
Definition at line 69 of file ParticleSink.h.
| typedef helper::vector<Real> sofa::component::ParticleSink< TDataTypes >::VecDensity |
Definition at line 72 of file ParticleSink.h.
| typedef DataTypes::VecDeriv sofa::component::ParticleSink< TDataTypes >::VecDeriv |
Reimplemented from sofa::core::componentmodel::behavior::Constraint< TDataTypes >.
Definition at line 71 of file ParticleSink.h.
Constructor & Destructor Documentation
| sofa::component::ParticleSink< TDataTypes >::ParticleSink | ( | ) | [inline] |
Definition at line 84 of file ParticleSink.h.
References sofa::core::objectmodel::BaseObject::f_listening, sofa::component::ParticleSink< TDataTypes >::planeNormal, and sofa::core::objectmodel::Data< T >::setValue().
| virtual sofa::component::ParticleSink< TDataTypes >::~ParticleSink | ( | ) | [inline, virtual] |
Definition at line 97 of file ParticleSink.h.
Member Function Documentation
| virtual void sofa::component::ParticleSink< TDataTypes >::animateBegin | ( | double | , | |
| double | time | |||
| ) | [inline, virtual] |
Definition at line 109 of file ParticleSink.h.
References sofa::core::objectmodel::BaseObject::f_printLog, sofa::core::objectmodel::BaseContext::get(), sofa::core::objectmodel::BaseObject::getContext(), sofa::core::objectmodel::BaseContext::getMeshTopology(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getV(), sofa::core::objectmodel::Data< T >::getValue(), sofa::core::componentmodel::behavior::MechanicalState< TDataTypes >::getX(), sofa::core::componentmodel::behavior::Constraint< TDataTypes >::mstate, sofa::component::ParticleSink< TDataTypes >::planeD1, sofa::component::ParticleSink< TDataTypes >::planeNormal, sofa::component::topology::PointSetTopologyModifier::propagateTopologicalChanges(), sofa::component::topology::PointSetTopologyModifier::removePointsProcess(), sofa::component::topology::PointSetTopologyModifier::removePointsWarning(), and sofa::core::componentmodel::behavior::BaseMechanicalState::resize().
Referenced by sofa::component::ParticleSink< TDataTypes >::handleEvent().
| virtual void sofa::component::ParticleSink< TDataTypes >::animateEnd | ( | double | , | |
| double | ||||
| ) | [inline, virtual] |
Definition at line 202 of file ParticleSink.h.
Referenced by sofa::component::ParticleSink< TDataTypes >::handleEvent().
| virtual void sofa::component::ParticleSink< TDataTypes >::draw | ( | ) | [inline, virtual] |
Render internal data of this object, for debugging purposes.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 215 of file ParticleSink.h.
References sofa::component::ParticleSink< TDataTypes >::color, sofa::defaulttype::Vec< N, real >::cross(), sofa::core::objectmodel::Data< T >::getValue(), sofa::helper::gl::glVertexT(), sofa::defaulttype::Vec< N, real >::normalize(), sofa::component::ParticleSink< TDataTypes >::planeD0, sofa::component::ParticleSink< TDataTypes >::planeNormal, and sofa::component::ParticleSink< TDataTypes >::showPlane.
| virtual void sofa::component::ParticleSink< TDataTypes >::handleEvent | ( | sofa::core::objectmodel::Event * | e | ) | [inline, virtual] |
Handle an event.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 207 of file ParticleSink.h.
References sofa::component::ParticleSink< TDataTypes >::animateBegin(), sofa::component::ParticleSink< TDataTypes >::animateEnd(), sofa::core::objectmodel::BaseObject::getContext(), and sofa::core::objectmodel::BaseContext::getTime().
| void sofa::component::ParticleSink< TDataTypes >::handleTopologyChange | ( | ) | [inline, virtual] |
Handle topological changes.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 163 of file ParticleSink.h.
References sofa::core::componentmodel::topology::BaseMeshTopology::firstChange(), sofa::component::ParticleSink< TDataTypes >::fixed, sofa::core::objectmodel::BaseObject::getContext(), sofa::core::objectmodel::BaseContext::getMeshTopology(), sofa::core::componentmodel::behavior::BaseMechanicalState::getSize(), sofa::component::topology::PointSubset::handleTopologyEvents(), sofa::core::componentmodel::topology::BaseMeshTopology::lastChange(), and sofa::core::componentmodel::behavior::Constraint< TDataTypes >::mstate.
| virtual void sofa::component::ParticleSink< TDataTypes >::init | ( | void | ) | [inline, virtual] |
Initialization method called at graph modification, during bottom-up traversal.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 101 of file ParticleSink.h.
References sofa::core::objectmodel::Data< T >::getValue(), sofa::core::componentmodel::behavior::Constraint< TDataTypes >::mstate, sofa::component::ParticleSink< TDataTypes >::planeD0, sofa::component::ParticleSink< TDataTypes >::planeD1, and sofa::component::ParticleSink< TDataTypes >::planeNormal.
| virtual void sofa::component::ParticleSink< TDataTypes >::projectPosition | ( | VecCoord & | x | ) | [inline, virtual] |
Project x to constrained space (x models a position).
This method must be implemented by the component, and is usually called by the generic Constraint::projectPosition() method.
- Parameters:
-
x project x to constrained space (x models a position)
Implements sofa::core::componentmodel::behavior::Constraint< TDataTypes >.
Definition at line 187 of file ParticleSink.h.
References sofa::component::topology::PointSubset::clear(), sofa::component::ParticleSink< TDataTypes >::fixed, sofa::core::objectmodel::Data< T >::getValue(), sofa::core::componentmodel::behavior::Constraint< TDataTypes >::mstate, sofa::component::ParticleSink< TDataTypes >::planeD0, sofa::component::ParticleSink< TDataTypes >::planeNormal, and sofa::component::topology::PointSubset::push_back().
| virtual void sofa::component::ParticleSink< TDataTypes >::projectResponse | ( | VecDeriv & | dx | ) | [inline, virtual] |
Project dx to constrained space (dx models an acceleration).
This method must be implemented by the component, and is usually called by the generic Constraint::projectResponse() method.
- Parameters:
-
dx project dx to constrained space
Implements sofa::core::componentmodel::behavior::Constraint< TDataTypes >.
Definition at line 174 of file ParticleSink.h.
References sofa::component::topology::PointSubset::empty(), sofa::component::ParticleSink< TDataTypes >::fixed, sofa::core::componentmodel::behavior::Constraint< TDataTypes >::mstate, and sofa::component::topology::PointSubset::size().
| virtual void sofa::component::ParticleSink< TDataTypes >::projectVelocity | ( | VecDeriv & | v | ) | [inline, virtual] |
Project v to constrained space (v models a velocity).
This method must be implemented by the component, and is usually called by the generic Constraint::projectVelocity() method.
- Parameters:
-
v project dx to constrained space (dx models a velocity)
Implements sofa::core::componentmodel::behavior::Constraint< TDataTypes >.
Definition at line 183 of file ParticleSink.h.
Field Documentation
| Data<defaulttype::Vec3f> sofa::component::ParticleSink< TDataTypes >::color |
Definition at line 79 of file ParticleSink.h.
Referenced by sofa::component::ParticleSink< TDataTypes >::draw().
| topology::PointSubset sofa::component::ParticleSink< TDataTypes >::fixed |
Definition at line 82 of file ParticleSink.h.
Referenced by sofa::component::ParticleSink< TDataTypes >::handleTopologyChange(), sofa::component::ParticleSink< TDataTypes >::projectPosition(), and sofa::component::ParticleSink< TDataTypes >::projectResponse().
| Data<Real> sofa::component::ParticleSink< TDataTypes >::planeD0 |
Definition at line 77 of file ParticleSink.h.
Referenced by sofa::component::ParticleSink< TDataTypes >::draw(), sofa::component::ParticleSink< TDataTypes >::init(), and sofa::component::ParticleSink< TDataTypes >::projectPosition().
| Data<Real> sofa::component::ParticleSink< TDataTypes >::planeD1 |
Definition at line 78 of file ParticleSink.h.
Referenced by sofa::component::ParticleSink< TDataTypes >::animateBegin(), and sofa::component::ParticleSink< TDataTypes >::init().
| Data<Deriv> sofa::component::ParticleSink< TDataTypes >::planeNormal |
Definition at line 76 of file ParticleSink.h.
Referenced by sofa::component::ParticleSink< TDataTypes >::animateBegin(), sofa::component::ParticleSink< TDataTypes >::draw(), sofa::component::ParticleSink< TDataTypes >::init(), sofa::component::ParticleSink< TDataTypes >::ParticleSink(), and sofa::component::ParticleSink< TDataTypes >::projectPosition().
| Data<bool> sofa::component::ParticleSink< TDataTypes >::showPlane |
Definition at line 80 of file ParticleSink.h.
Referenced by sofa::component::ParticleSink< TDataTypes >::draw().
The documentation for this class was generated from the following file:
- modules/sofa/component/misc/ParticleSink.h
