sofa::component::mapping::VoidMapping Class Reference
#include <VoidMapping.h>
Public Types | |
| typedef sofa::core::componentmodel::behavior::BaseMechanicalMapping | Inherit |
| typedef sofa::core::componentmodel::behavior::BaseMechanicalState | In |
| typedef sofa::core::componentmodel::behavior::BaseMechanicalState | Out |
Public Member Functions | |
| VoidMapping () | |
| virtual | ~VoidMapping () |
| void | init () |
| Initialization method called at graph modification, during bottom-up traversal. | |
| virtual void | updateMapping () |
| Apply the transformation from the input model to the output model (like apply displacement from BehaviorModel to VisualModel). | |
| virtual sofa::core::objectmodel::BaseObject * | getFrom () |
| Accessor to the input model of this mapping. | |
| virtual sofa::core::objectmodel::BaseObject * | getTo () |
| Accessor to the output model of this mapping. | |
| virtual void | disable () |
| Disable the mapping to get the original coordinates of the mapped model. | |
| virtual sofa::core::componentmodel::behavior::BaseMechanicalState * | getMechFrom () |
| Get the source (upper) model. | |
| virtual sofa::core::componentmodel::behavior::BaseMechanicalState * | getMechTo () |
| Get the destination (lower, mapped) model. | |
| bool | isMechanical () |
| Return false if this mapping should only be used as a regular mapping instead of a mechanical mapping. | |
| virtual void | propagateX () |
| Propagate position from the source model to the destination model. | |
| virtual void | propagateXfree () |
| Propagate free-motion position from the source model to the destination model. | |
| virtual void | propagateV () |
| Propagate velocity from the source model to the destination model. | |
Data Fields | |
| Data< bool > | f_isMechanical |
Protected Attributes | |
| In * | fromModel |
| Out * | toModel |
Detailed Description
Definition at line 42 of file VoidMapping.h.
Member Typedef Documentation
| typedef sofa::core::componentmodel::behavior::BaseMechanicalState sofa::component::mapping::VoidMapping::In |
Definition at line 46 of file VoidMapping.h.
| typedef sofa::core::componentmodel::behavior::BaseMechanicalMapping sofa::component::mapping::VoidMapping::Inherit |
Definition at line 45 of file VoidMapping.h.
| typedef sofa::core::componentmodel::behavior::BaseMechanicalState sofa::component::mapping::VoidMapping::Out |
Definition at line 47 of file VoidMapping.h.
Constructor & Destructor Documentation
| sofa::component::mapping::VoidMapping::VoidMapping | ( | ) | [inline] |
Definition at line 51 of file VoidMapping.h.
| virtual sofa::component::mapping::VoidMapping::~VoidMapping | ( | ) | [inline, virtual] |
Definition at line 57 of file VoidMapping.h.
Member Function Documentation
| virtual void sofa::component::mapping::VoidMapping::disable | ( | ) | [inline, virtual] |
Disable the mapping to get the original coordinates of the mapped model.
Implements sofa::core::BaseMapping.
Definition at line 85 of file VoidMapping.h.
| virtual sofa::core::objectmodel::BaseObject* sofa::component::mapping::VoidMapping::getFrom | ( | ) | [inline, virtual] |
Accessor to the input model of this mapping.
Implements sofa::core::BaseMapping.
Definition at line 73 of file VoidMapping.h.
References fromModel.
| virtual sofa::core::componentmodel::behavior::BaseMechanicalState* sofa::component::mapping::VoidMapping::getMechFrom | ( | ) | [inline, virtual] |
Get the source (upper) model.
Implements sofa::core::componentmodel::behavior::BaseMechanicalMapping.
Definition at line 90 of file VoidMapping.h.
References fromModel.
| virtual sofa::core::componentmodel::behavior::BaseMechanicalState* sofa::component::mapping::VoidMapping::getMechTo | ( | ) | [inline, virtual] |
Get the destination (lower, mapped) model.
Implements sofa::core::componentmodel::behavior::BaseMechanicalMapping.
Definition at line 96 of file VoidMapping.h.
References toModel.
| virtual sofa::core::objectmodel::BaseObject* sofa::component::mapping::VoidMapping::getTo | ( | ) | [inline, virtual] |
Accessor to the output model of this mapping.
Implements sofa::core::BaseMapping.
Definition at line 79 of file VoidMapping.h.
References toModel.
| void sofa::component::mapping::VoidMapping::init | ( | void | ) | [inline, virtual] |
Initialization method called at graph modification, during bottom-up traversal.
Reimplemented from sofa::core::objectmodel::BaseObject.
Definition at line 61 of file VoidMapping.h.
References fromModel, sofa::core::objectmodel::BaseObject::getContext(), sofa::core::objectmodel::BaseContext::getMechanicalState(), and toModel.
| bool sofa::component::mapping::VoidMapping::isMechanical | ( | ) | [inline, virtual] |
Return false if this mapping should only be used as a regular mapping instead of a mechanical mapping.
Implements sofa::core::componentmodel::behavior::BaseMechanicalMapping.
Definition at line 102 of file VoidMapping.h.
References f_isMechanical, and sofa::core::objectmodel::Data< T >::getValue().
| virtual void sofa::component::mapping::VoidMapping::propagateV | ( | ) | [inline, virtual] |
Propagate velocity from the source model to the destination model.
Implements sofa::core::componentmodel::behavior::BaseMechanicalMapping.
Definition at line 121 of file VoidMapping.h.
| virtual void sofa::component::mapping::VoidMapping::propagateX | ( | ) | [inline, virtual] |
Propagate position from the source model to the destination model.
If the MechanicalMapping can be represented as a matrix J, this method computes $ x_out = J x_in $
Implements sofa::core::componentmodel::behavior::BaseMechanicalMapping.
Definition at line 111 of file VoidMapping.h.
| virtual void sofa::component::mapping::VoidMapping::propagateXfree | ( | ) | [inline, virtual] |
Propagate free-motion position from the source model to the destination model.
Implements sofa::core::componentmodel::behavior::BaseMechanicalMapping.
Definition at line 116 of file VoidMapping.h.
| virtual void sofa::component::mapping::VoidMapping::updateMapping | ( | ) | [inline, virtual] |
Apply the transformation from the input model to the output model (like apply displacement from BehaviorModel to VisualModel).
Implements sofa::core::BaseMapping.
Definition at line 68 of file VoidMapping.h.
Field Documentation
In* sofa::component::mapping::VoidMapping::fromModel [protected] |
Out* sofa::component::mapping::VoidMapping::toModel [protected] |
The documentation for this class was generated from the following file:
- modules/sofa/component/mapping/VoidMapping.h
