AnimationLibrary.hpp File Reference

Catalog of ozz animation clips shared across all animated entities. More...

#include <cstdint>
#include <memory>
#include <string>

Include dependency graph for AnimationLibrary.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	AnimationLibrary
	Collection of animation clips loaded on top of a shared skeleton. More...

Namespaces
namespace	ozz
namespace	ozz::animation

Enumerations
enum class	ClipId : uint8_t {   Idle , Walk , Run , RunBackward ,   SlowRun , Slide , WallRun , Jump ,   StrafeLeft , StrafeRight , StrafeLeftWalk , StrafeRightWalk ,   TurnLeft90 , TurnRight90 , CrouchIdle , CrouchWalk ,   CrouchWalkLeft , CrouchWalkRight , CrouchWalkBackward , StartForward ,   StartBackward , StartLeft , StartRight , StopForward ,   StopBackward , StopLeft , StopRight , PivotLeft ,   PivotRight , EmoteFlair , EmoteMaraschino , EmoteGangnam ,   EmoteHipHop , EmoteNorthernSoul , _Count }
	Enumerated clip IDs. More...

Functions
const char *	clipName (ClipId id)
	Human-readable name for a clip (for UI / logging).
const char *	clipFile (ClipId id)
	Filename (relative to assets/animations/) for a clip.
ClipId	emoteClipForIndex (int index)
	Map an emote wheel index (0..emotes::kEmoteCount-1) to its ClipId.

Detailed Description

Catalog of ozz animation clips shared across all animated entities.

Enumeration Type Documentation

ClipId

enum class ClipId : uint8_t

strong

Enumerated clip IDs.

See clipFile() for the on-disk filenames.

Any edits here must also extend clipName() and clipFile() in the .cpp.

Enumerator
Idle
Walk
Run
RunBackward
SlowRun
Slide
WallRun
Jump	Airborne jump animation.
StrafeLeft	Running strafe left.
StrafeRight	Running strafe right.
StrafeLeftWalk	Walking strafe left.
StrafeRightWalk	Walking strafe right.
TurnLeft90	90-degree turn left (standing).
TurnRight90	90-degree turn right (standing).
CrouchIdle
CrouchWalk
CrouchWalkLeft
CrouchWalkRight
CrouchWalkBackward
StartForward
StartBackward
StartLeft
StartRight
StopForward
StopBackward
StopLeft
StopRight
PivotLeft
PivotRight
EmoteFlair
EmoteMaraschino
EmoteGangnam
EmoteHipHop
EmoteNorthernSoul
_Count	Sentinel; also used as "no clip / no override".

Function Documentation

clipFile()

const char * clipFile

(

ClipId

id

)

Filename (relative to assets/animations/) for a clip.

Here is the caller graph for this function:

clipName()

const char * clipName

(

ClipId

id

)

Human-readable name for a clip (for UI / logging).

Here is the caller graph for this function:

emoteClipForIndex()

ClipId emoteClipForIndex

(

int

index

)

Map an emote wheel index (0..emotes::kEmoteCount-1) to its ClipId.

Returns ClipId::_Count for out-of-range indices (treated as "no emote").

Here is the caller graph for this function: