RootMotionPolicy.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
#include "animation/AnimMath.h"
#include "common/Result.h"
 
#include <cstdint>
#include <string_view>
 
namespace eve::animation {
 
class AnimPose;
 
enum class RootMotionLockAxes : std::uint8_t {
    None         = 0,
    X            = 1u << 0,
    Y            = 1u << 1,
    Z            = 1u << 2,
    HorizontalXZ = static_cast<std::uint8_t>(X) | static_cast<std::uint8_t>(Z),
    VerticalY    = Y,
    All          = static_cast<std::uint8_t>(X) | static_cast<std::uint8_t>(Y) | static_cast<std::uint8_t>(Z),
};
 
[[nodiscard]] constexpr RootMotionLockAxes operator|(RootMotionLockAxes a, RootMotionLockAxes b) noexcept {
    return static_cast<RootMotionLockAxes>(static_cast<std::uint8_t>(a) | static_cast<std::uint8_t>(b));
}
 
[[nodiscard]] constexpr RootMotionLockAxes operator&(RootMotionLockAxes a, RootMotionLockAxes b) noexcept {
    return static_cast<RootMotionLockAxes>(static_cast<std::uint8_t>(a) & static_cast<std::uint8_t>(b));
}
 
[[nodiscard]] constexpr bool hasLock(RootMotionLockAxes mask, RootMotionLockAxes axis) noexcept {
    return (static_cast<std::uint8_t>(mask) & static_cast<std::uint8_t>(axis)) != 0;
}
 
enum class RootMotionApplySpace : std::uint8_t {
    BoneLocal        = 0,
    CharacterFacing  = 1,
};
 
struct RootMotionPolicy {
    RootMotionLockAxes   lockAxes                 = RootMotionLockAxes::None;
    RootMotionApplySpace applySpace               = RootMotionApplySpace::BoneLocal;
    bool                 bakeTranslationIntoPose  = false;
    bool                 bakeRotationIntoPose     = false;
    bool                 lockRotation             = false;
    float                characterYaw             = 0.f;
};
 
[[nodiscard]] EVENGINE_API_WORLD eve::Result<void> validateRootMotionPolicy(const RootMotionPolicy& policy);
 
[[nodiscard]] EVENGINE_API_WORLD TransformTRS applyRootMotionPolicy(const TransformTRS& rawDelta,
                                                                    const RootMotionPolicy& policy);
 
[[nodiscard]] EVENGINE_API_WORLD eve::Result<void> bakeRootMotionIntoPose(AnimPose&               pose,
                                                                          int                     boneIndex,
                                                                          const TransformTRS&     referenceRoot,
                                                                          const RootMotionPolicy& policy);
 
[[nodiscard]] EVENGINE_API_WORLD eve::Result<RootMotionLockAxes> parseRootMotionLockAxes(std::string_view name);
 
[[nodiscard]] EVENGINE_API_WORLD eve::Result<RootMotionApplySpace> parseRootMotionApplySpace(std::string_view name);
 
}  // namespace eve::animation