EMotionFX::MorphSetupInstance Class Reference

#include <MorphSetupInstance.h>

Inherits EMotionFX::BaseObject.

Classes
class	MorphTarget

Public Member Functions
void	Init (MorphSetup *morphSetup)
MCORE_INLINE size_t	GetNumMorphTargets () const
MCORE_INLINE MorphTarget *	GetMorphTarget (size_t nr)
MCORE_INLINE const MorphTarget *	GetMorphTarget (size_t nr) const
size_t	FindMorphTargetIndexByID (uint32 id) const
MorphTarget *	FindMorphTargetByID (uint32 id)
Public Member Functions inherited from EMotionFX::BaseObject
	BaseObject ()
virtual	~BaseObject ()
Public Member Functions inherited from MCore::MemoryObject
	MemoryObject ()
virtual	~MemoryObject ()
void	IncreaseReferenceCount ()
void	DecreaseReferenceCount ()
void	Destroy ()
uint32	GetReferenceCount () const

Static Public Member Functions
static MorphSetupInstance *	Create ()
static MorphSetupInstance *	Create (MorphSetup *morphSetup)

Additional Inherited Members
Protected Member Functions inherited from EMotionFX::BaseObject
void	Delete () override
virtual void	Delete ()

Detailed Description

The morph setup instance. This contains all unique information per actor instance, which for example allows each actor instance to have different weight values per morph target, while still the real morph targets are being shared between all actor instances.

Member Function Documentation

Create() [1/2]

static MorphSetupInstance * EMotionFX::MorphSetupInstance::Create ( )

static

The default creation method. Be sure to call the Init method later on or use the extended constructor.

Create() [2/2]

static MorphSetupInstance * EMotionFX::MorphSetupInstance::Create ( MorphSetup *  morphSetup )

static

The extended creation method. This automatically calls the Init method.

FindMorphTargetByID()

MorphTarget * EMotionFX::MorphSetupInstance::FindMorphTargetByID

(

uint32

id

)

Find the morph target by its ID.

Parameters

id	The ID value of the morph target to search for.

Returns

Returns a pointer to the morph target with the given ID, or nullptr when not found.

FindMorphTargetIndexByID()

size_t EMotionFX::MorphSetupInstance::FindMorphTargetIndexByID

(

uint32

id

)

const

Find a given morph target number by its ID.

Parameters

id	The ID value to search for.

Returns

Returns the morph target number in range of [0..GetNumMorphTargets()-1], or InvalidIndex when not found.

GetMorphTarget()

MCORE_INLINE MorphTarget * EMotionFX::MorphSetupInstance::GetMorphTarget ( size_t  nr )

inline

Get a specific morph target.

Parameters

nr	The morph target number, which must be in range of [0..GetNumMorphTargets()-1].

Returns

A pointer to the morph target inside this class.

GetNumMorphTargets()

MCORE_INLINE size_t EMotionFX::MorphSetupInstance::GetNumMorphTargets ( ) const

inline

Get the number of morph targets inside this class. This should always be equal to the number of morph targets in the highest detail.

Returns

The number of morph targets.

Init()

void EMotionFX::MorphSetupInstance::Init

(

MorphSetup *

morphSetup

)

Initialize the morph setup instance and link it to a given morph setup. This will automatically create the morph targets locally stored inside this class.

Parameters

morphSetup

The morph setup to initialize from.

---

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

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