EMotionFX::MorphSetupInstance::MorphTarget Class Reference

#include <MorphSetupInstance.h>

Public Member Functions
	MorphTarget ()
	~MorphTarget ()
MCORE_INLINE uint32	GetID () const
float	GetWeight () const
bool	GetIsInManualMode () const
void	SetID (uint32 id)
void	SetWeight (float weight)
void	SetManualMode (bool enabled)

Detailed Description

The unique settings per morph target for each actor instance. These values are used in all geometry LOD levels.

Constructor & Destructor Documentation

MorphTarget()

EMotionFX::MorphSetupInstance::MorphTarget::MorphTarget ( )

inline

The constructor.

~MorphTarget()

EMotionFX::MorphSetupInstance::MorphTarget::~MorphTarget ( )

inline

The destructor.

Member Function Documentation

GetID()

MCORE_INLINE uint32 EMotionFX::MorphSetupInstance::MorphTarget::GetID ( ) const

inline

Get the ID of this morph target. This is based on its name. This ID links the MorphTarget class with this local morph target class.

Returns

The ID of this morph target.

GetIsInManualMode()

bool EMotionFX::MorphSetupInstance::MorphTarget::GetIsInManualMode ( ) const

inline

Check if we are in manual mode or not. Manual mode means that we can manually control the weight value. If this is disabled then the motion system will overwrite the weight values.

Returns

Returns true when we are in manual mode, otherwise false is returned.

GetWeight()

float EMotionFX::MorphSetupInstance::MorphTarget::GetWeight ( ) const

inline

Get the weight value of the morph target.

Returns

The weight value.

SetID()

void EMotionFX::MorphSetupInstance::MorphTarget::SetID ( uint32  id )

inline

Set the ID of this morph target. This ID links the MorphTarget class with this local morph target class.

Parameters

id	The ID to use.

SetManualMode()

void EMotionFX::MorphSetupInstance::MorphTarget::SetManualMode ( bool  enabled )

inline

Enable or disable manual mode. Manual mode means that we can manually control the weight value. If this is disabled then the motion system will overwrite the weight values.

Parameters

enabled

Set to true if you wish to enable manual mode on this morph target. Otherwise set to false.

SetWeight()

void EMotionFX::MorphSetupInstance::MorphTarget::SetWeight ( float  weight )

inline

Set the weight value of the morph target.

Parameters

weight

The weight value.

---

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

• Gems/EMotionFX/Code/EMotionFX/Source/MorphSetupInstance.h