AnimationLibrary.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <cstdint>
#include <memory>
#include <string>
 
namespace ozz::animation
{
class Animation;
}
 
class CharacterRig;

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,
    // Full-body emotes (one-shot/looping dances played via the override slot).
    EmoteFlair,
    EmoteMaraschino,
    EmoteGangnam,
    EmoteHipHop,
    EmoteNorthernSoul,
    _Count, 
};

const char* clipName(ClipId id);

const char* clipFile(ClipId id);

ClipId emoteClipForIndex(int index);

class AnimationLibrary
{
public:
    AnimationLibrary();
    ~AnimationLibrary();
    AnimationLibrary(const AnimationLibrary&) = delete;
    AnimationLibrary& operator=(const AnimationLibrary&) = delete;
    AnimationLibrary(AnimationLibrary&&) noexcept;
    AnimationLibrary& operator=(AnimationLibrary&&) noexcept;

    bool loadClipFromFBX(const CharacterRig& rig, ClipId id, const std::string& path,
                         bool useRigRestTranslations = false);

    [[nodiscard]] bool has(ClipId id) const;

    [[nodiscard]] const ozz::animation::Animation* get(ClipId id) const;

    [[nodiscard]] float duration(ClipId id) const;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};