Open 3D Engine EMotionFX Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
EMotionFX::SkinInfluence Class Reference

#include <SkinningInfoVertexAttributeLayer.h>

Public Member Functions

 SkinInfluence ()
 
 SkinInfluence (uint16 nodeNr, float weight, uint16 boneNr=0)
 
MCORE_INLINE float GetWeight () const
 
void SetWeight (float weight)
 
MCORE_INLINE uint16 GetNodeNr () const
 
void SetNodeNr (uint16 nodeNr)
 
void SetBoneNr (uint16 boneNr)
 
MCORE_INLINE uint16 GetBoneNr () const
 

Detailed Description

A soft skinning influence between a vertex and a bone, with a given weight.

Constructor & Destructor Documentation

◆ SkinInfluence() [1/2]

EMotionFX::SkinInfluence::SkinInfluence ( )
inline

Default constructor.

◆ SkinInfluence() [2/2]

EMotionFX::SkinInfluence::SkinInfluence ( uint16  nodeNr,
float  weight,
uint16  boneNr = 0 
)
inline

Constructor.

Parameters
nodeNrThe node number which acts as bone.
weightThe weight value, which must be in range of [0..1].
boneNrThe bone number, used as optimization inside the softskin deformer.

Member Function Documentation

◆ GetBoneNr()

MCORE_INLINE uint16 EMotionFX::SkinInfluence::GetBoneNr ( ) const
inline

Get the bone number, which is used for precalculations.

Returns
The bone number.

◆ GetNodeNr()

MCORE_INLINE uint16 EMotionFX::SkinInfluence::GetNodeNr ( ) const
inline

Get the node number that points inside an actor. So this number is an index you can pass to Actor::GetNode(...) to get the actual node that acts as bone.

Returns
The node number, which points inside the nodes array of the actor.

◆ GetWeight()

MCORE_INLINE float EMotionFX::SkinInfluence::GetWeight ( ) const
inline

Get the weight of this influence.

Returns
The weight, which should be in range of [0..1].

◆ SetBoneNr()

void EMotionFX::SkinInfluence::SetBoneNr ( uint16  boneNr)
inline

Set the bone number, used for precalculations.

Parameters
boneNrThe bone number.

◆ SetNodeNr()

void EMotionFX::SkinInfluence::SetNodeNr ( uint16  nodeNr)
inline

Set the node number that points inside an actor. So this number is an index you can pass to Actor::GetNode(...) to get the actual node that acts as bone.

Parameters
nodeNrThe node number, which points inside the nodes array of the actor.

◆ SetWeight()

void EMotionFX::SkinInfluence::SetWeight ( float  weight)
inline

Adjust the weight value.

Parameters
weightThe weight value, which must be in range of [0..1].

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