#include <MeshDeformer.h>
Inherits EMotionFX::BaseObject.
Inherited by EMotionFX::DualQuatSkinDeformer, EMotionFX::MorphMeshDeformer, and EMotionFX::SoftSkinDeformer.
The mesh deformer base class. A mesh deformer can deform (apply modifications) on a given mesh. Examples of deformers could be a TwistDeformer, SoftSkinDeformer, MorphDeformer, etc. Every deformer has its own unique type ID number and the MeshDeformerStack contains a list of deformers which are executed in the specified order.
◆ MeshDeformer()
EMotionFX::MeshDeformer::MeshDeformer |
( |
Mesh * |
mesh | ) |
|
|
protected |
Default constructor.
- Parameters
-
mesh | A pointer to the mesh to deform. |
◆ ~MeshDeformer()
virtual EMotionFX::MeshDeformer::~MeshDeformer |
( |
| ) |
|
|
protectedvirtual |
◆ Clone()
◆ GetIsEnabled()
bool EMotionFX::MeshDeformer::GetIsEnabled |
( |
| ) |
const |
Check if the controller is enabled or not.
- Returns
- Returns true when the controller is active (enabled) or false when the controller is inactive (disabled).
◆ GetSubType()
virtual uint32 EMotionFX::MeshDeformer::GetSubType |
( |
| ) |
const |
|
pure virtual |
Returns the sub type identification number. This number is used to identify special specilizations of a given deformer, like the same type of deformer, but with P4 optimizations. In that case the type will be the same, but the subtype will be different for each specialization.
- Returns
- The unique subtype identification number.
Implemented in EMotionFX::DualQuatSkinDeformer, EMotionFX::MorphMeshDeformer, and EMotionFX::SoftSkinDeformer.
◆ GetType()
virtual uint32 EMotionFX::MeshDeformer::GetType |
( |
| ) |
const |
|
pure virtual |
◆ Reinitialize()
virtual void EMotionFX::MeshDeformer::Reinitialize |
( |
Actor * |
actor, |
|
|
Node * |
node, |
|
|
size_t |
lodLevel, |
|
|
uint16 |
highestJointIndex |
|
) |
| |
|
virtual |
◆ SetIsEnabled()
void EMotionFX::MeshDeformer::SetIsEnabled |
( |
bool |
enabled | ) |
|
Enable or disable the controller. Disabling a controller just results in the Update method of the controller not being called during the Actor::Update() call.
- Parameters
-
enabled | Set to true when you want to enable the controller or to false when you want to disable the controller. |
◆ Update()
virtual void EMotionFX::MeshDeformer::Update |
( |
ActorInstance * |
actorInstance, |
|
|
Node * |
node, |
|
|
float |
timeDelta |
|
) |
| |
|
pure virtual |
◆ m_isEnabled
bool EMotionFX::MeshDeformer::m_isEnabled |
|
protected |
When set to true, this mesh deformer will be processed, otherwise it will be skipped during update.
◆ m_mesh
Mesh* EMotionFX::MeshDeformer::m_mesh |
|
protected |
Pointer to the mesh to which the deformer belongs to.
The documentation for this class was generated from the following file:
- Gems/EMotionFX/Code/EMotionFX/Source/MeshDeformer.h