AnimSequencerInstanceProxy.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Animation/AnimInstanceProxy.h"
#include "AnimNodes/AnimNode_SequenceEvaluator.h"
#include "AnimNodes/AnimNode_ApplyAdditive.h"
#include "AnimNodes/AnimNode_MultiWayBlend.h"
#include "AnimNodes/AnimNode_PoseSnapshot.h"
#include "AnimNodes/AnimNode_Mirror.h"
#include "AnimSequencerInstanceProxy.generated.h"
 
UENUM(BlueprintType)
enum class ESwapRootBone : uint8
{
    /* Swap the root bone to the component */
    SwapRootBone_Component,
    /* Swap root bone to the actor root component */
    SwapRootBone_Actor,
    /* Do not swap the root bone */
    SwapRootBone_None
};
 
struct FSequencerPlayerBase
{
public:
    FSequencerPlayerBase()
        : PoseIndex(INDEX_NONE)
        , bAdditive(false)
    {}
 
    template<class TType> 
    bool IsOfType() const 
    {
        return IsOfTypeImpl(TType::GetTypeId());
    }
 
    virtual ~FSequencerPlayerBase() { }
 
public:
    int32 PoseIndex;
 
    bool bAdditive;
 
protected:
    virtual bool IsOfTypeImpl(const FName& Type) const
    {
        return false;
    }
 
};
 
 
struct FRootMotionOverride
{
    FRootMotionOverride() :bBlendFirstChildOfRoot(false), ChildBoneIndex(INDEX_NONE), RootMotion(FTransform::Identity),
    PreviousTransform(FTransform::Identity) {};
    bool bBlendFirstChildOfRoot;
    int32 ChildBoneIndex;
    FTransform RootMotion;
    FTransform PreviousTransform;
};
 
struct FAnimSequencerData
{
    FAnimSequencerData(UAnimSequenceBase* InAnimSequence, int32 InSequenceId, const TOptional<FRootMotionOverride>& InRootMotion, float InFromPosition, float InToPosition, float InWeight, bool bInFireNotifies, ESwapRootBone InSwapRootBone, TOptional<FTransform> InInitialTransform, UMirrorDataTable* InMirrorDataTable)
        : AnimSequence(InAnimSequence)
        , SequenceId(InSequenceId)
        , RootMotion(InRootMotion)
        , FromPosition(InFromPosition)
        , ToPosition(InToPosition)
        , Weight(InWeight)
        , bFireNotifies(bInFireNotifies)
        , SwapRootBone(InSwapRootBone)
        , InitialTransform(InInitialTransform)
        , MirrorDataTable(InMirrorDataTable)
    {
    }
 
    UAnimSequenceBase* AnimSequence;
    int32 SequenceId;
    const TOptional<FRootMotionOverride>& RootMotion;
    float FromPosition;
    float ToPosition;
    float Weight;
    bool bFireNotifies;
    ESwapRootBone SwapRootBone;
    TOptional<FTransform> InitialTransform;
    UMirrorDataTable* MirrorDataTable;
};
 
#define SEQUENCER_INSTANCE_PLAYER_TYPE(TYPE, BASE) \
    static const FName& GetTypeId() { static FName Type(TEXT(#TYPE)); return Type; } \
    virtual bool IsOfTypeImpl(const FName& Type) const override { return GetTypeId() == Type || BASE::IsOfTypeImpl(Type); }
 
struct FSequencerPlayerAnimSequence : public FSequencerPlayerBase
{
    SEQUENCER_INSTANCE_PLAYER_TYPE(FSequencerPlayerAnimSequence, FSequencerPlayerBase)
    TOptional<FRootMotionOverride> RootMotion;
    FAnimNode_SequenceEvaluator_Standalone PlayerNode;
};
 
 
USTRUCT()
struct FAnimSequencerInstanceProxy : public FAnimInstanceProxy
{
    GENERATED_BODY()
 
public:
    FAnimSequencerInstanceProxy()
    {
    }
 
    FAnimSequencerInstanceProxy(UAnimInstance* InAnimInstance)
        : FAnimInstanceProxy(InAnimInstance)
    {
    }
 
    ANIMGRAPHRUNTIME_API virtual ~FAnimSequencerInstanceProxy();
 
    // FAnimInstanceProxy interface
    ANIMGRAPHRUNTIME_API virtual void Initialize(UAnimInstance* InAnimInstance) override;
    ANIMGRAPHRUNTIME_API virtual bool Evaluate(FPoseContext& Output) override;
    ANIMGRAPHRUNTIME_API virtual void PostEvaluate(UAnimInstance* InAnimInstance) override;
    ANIMGRAPHRUNTIME_API virtual void UpdateAnimationNode(const FAnimationUpdateContext& InContext) override;
 
    ANIMGRAPHRUNTIME_API void UpdateAnimTrack(UAnimSequenceBase* InAnimSequence, uint32 SequenceId, float InPosition, float Weight, bool bFireNotifies);
    ANIMGRAPHRUNTIME_API void UpdateAnimTrack(UAnimSequenceBase* InAnimSequence, uint32 SequenceId, TOptional<float> InFromPosition, float InToPosition, float Weight, bool bFireNotifies);
    
    UE_DEPRECATED(5.0, "Please use the UpdateAnimTrackWithRootMotion that takes a MirrorDataTable")
    ANIMGRAPHRUNTIME_API void UpdateAnimTrackWithRootMotion(UAnimSequenceBase* InAnimSequence, int32 SequenceId, const TOptional<FRootMotionOverride>& RootMotion, float InFromPosition, float InToPosition, float Weight, bool bFireNotifies);
    
    UE_DEPRECATED(5.1, "Please use the UpdateAnimTrackWithRootMotion that takes FAnimSequencerData")
    ANIMGRAPHRUNTIME_API void UpdateAnimTrackWithRootMotion(UAnimSequenceBase* InAnimSequence, int32 SequenceId, const TOptional<FRootMotionOverride>& RootMotion, float InFromPosition, float InToPosition, float Weight, bool bFireNotifies, UMirrorDataTable* InMirrorDataTable);
 
    ANIMGRAPHRUNTIME_API void UpdateAnimTrackWithRootMotion(const FAnimSequencerData& InAnimSequencerData);
 
    ANIMGRAPHRUNTIME_API virtual void ResetNodes();
 
    ANIMGRAPHRUNTIME_API virtual void ResetPose();
 
    ANIMGRAPHRUNTIME_API virtual void ConstructNodes();
 
    ANIMGRAPHRUNTIME_API virtual void AddReferencedObjects(UAnimInstance* InAnimInstance, FReferenceCollector& Collector) override;
 
protected:
 
    ANIMGRAPHRUNTIME_API void UpdateAnimTrack(UAnimSequenceBase* InAnimSequence, uint32 SequenceId, const TOptional<FRootMotionOverride>& RootMomtionOverride, TOptional<float> InFromPosition, float InToPosition, float Weight, bool bFireNotifies, UMirrorDataTable* InMirrorDataTable);
 
    template<typename Type>
    Type* FindPlayer(uint32 SequenceId) const
    {
        FSequencerPlayerBase* Player = SequencerToPlayerMap.FindRef(SequenceId);
        if (Player && Player->IsOfType<Type>())
        {
            return static_cast<Type*>(Player);
        }
 
        return nullptr;
    }
 
    struct FAnimNode_ApplyAdditive SequencerRootNode;
    struct FAnimNode_MultiWayBlend FullBodyBlendNode;
    struct FAnimNode_MultiWayBlend AdditiveBlendNode;
    struct FAnimNode_PoseSnapshot  SnapshotNode;
 
    TMap<uint32, FSequencerPlayerBase*> SequencerToPlayerMap;
 
    TMap<uint32, FAnimNode_Mirror_Standalone*> SequencerToMirrorMap;
 
    TOptional<FRootMotionOverride> RootMotionOverride;
 
    ANIMGRAPHRUNTIME_API void InitAnimTrack(UAnimSequenceBase* InAnimSequence, uint32 SequenceId);
    ANIMGRAPHRUNTIME_API void EnsureAnimTrack(UAnimSequenceBase* InAnimSequence, uint32 SequenceId);
    ANIMGRAPHRUNTIME_API void ClearSequencePlayerAndMirrorMaps();
 
    ESwapRootBone SwapRootBone = ESwapRootBone::SwapRootBone_None;
    TOptional<FTransform> InitialTransform;
    TOptional<FTransform> RootBoneTransform;
};