ActionPreview.h

浏览该文件的文档.

#pragma once
 
#include "action/ActionTimeline.h"
 
#include <cstdint>
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
namespace eve::action {
 
enum class ActionPreviewReason : std::uint8_t { Refresh, Seek, Advance };
 
enum class ActionPreviewCueKind : std::uint8_t { Gameplay, Vfx, Audio, Camera, StateEnter, StateExit };
 
enum class RootMotionPreviewState : std::uint8_t { Unavailable, Available };
 
struct ActionPreviewPoint3 {
    float x = 0.0f;
    float y = 0.0f;
    float z = 0.0f;
};
 
struct ActionPreviewCue {
    ActionPreviewCueKind kind = ActionPreviewCueKind::Gameplay;
    LogicalId            itemId;
    LogicalId            type;
    Duration             time;
    Value::Object        payload;
};
 
struct ActionPreviewFrame {
    ActionPreviewReason              reason = ActionPreviewReason::Refresh;
    std::string                      animationUri;
    Duration                         previous;
    Duration                         current;
    std::vector<ActionPreviewCue>    cues;
    std::vector<ActionActiveBlock>   activeBlocks;
    RootMotionPreviewState           rootMotionState = RootMotionPreviewState::Unavailable;
    std::vector<ActionPreviewPoint3> rootMotionPath;
};
 
class IActionPreviewSink {
public:
    virtual ~IActionPreviewSink() = default;
    [[nodiscard]] virtual Result<void> prepare(const ActionPreviewFrame& frame) = 0;
    virtual void present(const ActionPreviewFrame& frame) noexcept = 0;
    virtual void discardPrepared() noexcept = 0;
};
 
class IActionPreviewSinkProvider {
public:
    static constexpr const char* capabilityName = "eve.action.preview-sink-provider";
    virtual ~IActionPreviewSinkProvider() = default;
    [[nodiscard]] virtual Result<std::unique_ptr<IActionPreviewSink>> createActionPreviewSink() = 0;
};
 
class IActionRootMotionSource {
public:
    virtual ~IActionRootMotionSource() = default;
    [[nodiscard]] virtual Result<std::vector<ActionPreviewPoint3>> sampleRootMotion(
        std::string_view animationUri, Duration duration, std::uint32_t sampleCount) const = 0;
};
 
}  // namespace eve::action