EMotionFX::Initializer Class Reference

#include <EMotionFXManager.h>

Classes
struct	InitSettings

Static Public Member Functions
static bool MCORE_CDECL	Init (InitSettings *initSettings=nullptr)
static void MCORE_CDECL	Shutdown ()

Detailed Description

The EMotion FX initializer class. This class is responsible for initializing and shutdown of EMotion FX. Before you make any calls to EMotionFX you have to call the EMotionFX::Initializer::Init() method. Also don't forget to call EMotionFX::Initializer::Shutdown() after you stop using EMotion FX. The EMotionFX::Initializer::Shutdown() method should be called most likely at application shutdown.

Please note that BEFORE you call EMotionFX::Initializer::Init() you also have called MCore::Initializer::Init(). And also be sure that AFTER you call EMotionFX::Initializer::Shutdown() you also call MCore::Initializer::Shutdown(), unless your code still uses other MCore classes/functions after that point.

Member Function Documentation

Init()

static bool MCORE_CDECL EMotionFX::Initializer::Init ( InitSettings *  initSettings = nullptr )

static

Initializes EMotion FX. After calling this method you can use all EMotion FX API functionality. Be sure to call MCore::Initializer::Init() before calling this method, if you haven't initialized MCore yet. If default init settings are used (when no parameter or nullptr is passed to this method) it will use the standard DirectX style coordinate system (right=x+, up=y+, forward=z+) and one 3D unit will be a meter.

Parameters

initSettings

The init settings, or nullptr to use defaults.

Returns

Returns true when initialization has succeeded. Otherwise false is returned.

Shutdown()

static void MCORE_CDECL EMotionFX::Initializer::Shutdown ( )

static

Shutdown EMotion FX. After calling this method calling the EMotion FX API should not be used anymore. Be sure to call MCore::Initializer::Shutdown() AFTER calling this method, and not before.

---

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

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