AnimNode_DeadBlending.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AnimNode_Inertialization.h"
#include "AnimNode_DeadBlending.generated.h"
 
USTRUCT(BlueprintInternalUseOnly)
struct FAnimNode_DeadBlending : public FAnimNode_Base
#if CPP
    , public IBoneReferenceSkeletonProvider
#endif
{
    GENERATED_BODY()
    friend class UAnimGraphNode_DeadBlending;
 
    // Input Pose
    UPROPERTY(EditAnywhere, Category = Links)
    FPoseLink Source;
 
#if WITH_EDITORONLY_DATA
    void SetTag(FName InTag) { Tag = InTag; }
#endif
    FName GetTag() { return Tag; }
 
private:
 
    // When enabled, the default blend settings will always be used rather than those coming from the inertialization request.
    UPROPERTY(EditAnywhere, Category = Blending)
    bool bAlwaysUseDefaultBlendSettings = false;
 
    // The default blend duration to use when "Always Use Default Blend Settings" is set to true.
    UPROPERTY(EditAnywhere, Category = Blending)
    float DefaultBlendDuration = 0.25f;
 
    // Default blend profile to use when no blend profile is supplied with the inertialization request.
    UPROPERTY(EditAnywhere, Category = Blending, meta = (UseAsBlendProfile = true))
    TObjectPtr<UBlendProfile> DefaultBlendProfile = nullptr;
 
    // Default blend mode to use when no blend mode is supplied with the inertialization request.
    UPROPERTY(EditAnywhere, Category = Blending, DisplayName = "Default Blend Mode")
    EAlphaBlendOption DefaultBlendMode = UE::Anim::DefaultBlendOption;
 
    // Default custom blend curve to use along with the default blend mode.
    UPROPERTY(EditAnywhere, Category = Blending)
    TObjectPtr<UCurveFloat> DefaultCustomBlendCurve = nullptr;
 
    // Multiplier that can be used to scale the overall blend durations coming from inertialization requests.
    UPROPERTY(EditAnywhere, Category = Blending, meta = (Min = "0.0", UIMin = "0.0"))
    float BlendTimeMultiplier = 1.0f;
 
    UPROPERTY(EditAnywhere, Category = Blending)
    bool bLinearlyInterpolateScales = false;
 
    // List of curves that should not use inertial blending. These curves will change instantly when the animation switches.
    UPROPERTY(EditAnywhere, Category = Filter)
    TArray<FName> FilteredCurves;
 
    UPROPERTY(EditAnywhere, Category = Filter)
    TArray<FName> ExtrapolationFilteredCurves;
 
    // List of bones that should not use inertial blending. These bones will change instantly when the animation switches.
    UPROPERTY(EditAnywhere, Category = Filter)
    TArray<FBoneReference> FilteredBones;
 
    UPROPERTY(EditAnywhere, Category = Extrapolation, meta = (Min = "0.0", UIMin = "0.0"), DisplayName = "Extrapolation Half Life")
    float ExtrapolationHalfLife = 1.0f;
 
    UPROPERTY(EditAnywhere, Category = Extrapolation, meta = (Min = "0.0", UIMin = "0.0"), DisplayName = "Minimum Extrapolation Half Life")
    float ExtrapolationHalfLifeMin = 0.05f;
 
    UPROPERTY(EditAnywhere, Category = Extrapolation, meta = (Min = "0.0", UIMin = "0.0"), DisplayName = "Maximum Extrapolation Half Life")
    float ExtrapolationHalfLifeMax = 1.0f;
 
    UPROPERTY(EditAnywhere, Category = Extrapolation, meta = (Min = "0.0", UIMin = "0.0"))
    float MaximumTranslationVelocity = 500.0f;
 
    UPROPERTY(EditAnywhere, Category = Extrapolation, meta = (Min = "0.0", UIMin = "0.0"))
    float MaximumRotationVelocity = 360.0f;
 
    UPROPERTY(EditAnywhere, Category = Extrapolation, meta = (Min = "0.0", UIMin = "0.0"))
    float MaximumScaleVelocity = 4.0f;
 
    UPROPERTY(EditAnywhere, Category = Extrapolation, meta = (Min = "0.0", UIMin = "0.0"))
    float MaximumCurveVelocity = 100.0f;
 
    UPROPERTY(EditAnywhere, Category = Blending)
    bool bResetOnBecomingRelevant = true;
 
    UPROPERTY(EditAnywhere, Category = Requests)
    bool bForwardRequestsThroughSkippedCachedPoseNodes = false;
 
    /* UAnimGraphNode_Deadblending tag to match at runtime for filtering inertialization requests */
    UPROPERTY()
    FName Tag = NAME_None;
 
#if WITH_EDITORONLY_DATA
    
    // This setting can be used to show what the extrapolation of the animation looks like.
    UPROPERTY(EditAnywhere, Category = Debug)
    bool bShowExtrapolations = false;
 
#endif // WITH_EDITORONLY_DATA
 
public: // FAnimNode_DeadBlending
 
    ENGINE_API FAnimNode_DeadBlending();
 
    ENGINE_API virtual void RequestInertialization(const FInertializationRequest& Request);
 
public: // FAnimNode_Base
 
    ENGINE_API virtual void Initialize_AnyThread(const FAnimationInitializeContext& Context) override;
    ENGINE_API virtual void CacheBones_AnyThread(const FAnimationCacheBonesContext& Context) override;
    ENGINE_API virtual void Update_AnyThread(const FAnimationUpdateContext& Context) override;
    ENGINE_API virtual void Evaluate_AnyThread(FPoseContext& Output) override;
    ENGINE_API virtual void GatherDebugData(FNodeDebugData& DebugData) override;
    ENGINE_API virtual bool NeedsDynamicReset() const override;
 
private:
    
    void Deactivate();
 
    void InitFrom(
        const FCompactPose& InPose, 
        const FBlendedCurve& InCurves, 
        const UE::Anim::FStackAttributeContainer& Attributes,
        const FInertializationSparsePose& SrcPosePrev,
        const FInertializationSparsePose& SrcPoseCurr);
 
    void ApplyTo(FCompactPose& InOutPose, FBlendedCurve& InOutCurves, UE::Anim::FStackAttributeContainer& InOutAttributes);
 
public: // IBoneReferenceSkeletonProvider
    ENGINE_API class USkeleton* GetSkeleton(bool& bInvalidSkeletonIsError, const IPropertyHandle* PropertyHandle) override;
 
private:
 
    // Cached curve filter built from FilteredCurves
    UE::Anim::FCurveFilter CurveFilter;
 
    // Cached curve filter built from ExtrapolationFilteredCurves
    UE::Anim::FCurveFilter ExtrapolatedCurveFilter;
 
    // Cache compact pose bone index for FilteredBones
    TArray<FCompactPoseBoneIndex, TInlineAllocator<8>> BoneFilter;
 
    // Snapshots of the actor pose generated as output.
    FInertializationSparsePose PrevPoseSnapshot;
    FInertializationSparsePose CurrPoseSnapshot;
 
    // Pending inertialization requests.
    UPROPERTY(Transient)
    TArray<FInertializationRequest> RequestQueue;
 
    // Update Counter for detecting being relevant
    FGraphTraversalCounter UpdateCounter;
 
private:
 
    // Recorded pose state at point of transition.
 
    TArray<int32> BoneIndices;
    
    TArray<FVector> BoneTranslations;
    TArray<FQuat> BoneRotations;
    TArray<FQuat4f> BoneRotationDirections;
    TArray<FVector> BoneScales;
 
    TArray<FVector3f> BoneTranslationVelocities;
    TArray<FVector3f> BoneRotationVelocities;
    TArray<FVector3f> BoneScaleVelocities;
 
    TArray<FVector3f> BoneTranslationDecayHalfLives;
    TArray<FVector3f> BoneRotationDecayHalfLives;
    TArray<FVector3f> BoneScaleDecayHalfLives;
 
    FVector3f RootTranslationVelocity;
    FVector3f RootRotationVelocity;
    FVector3f RootScaleVelocity;
 
    // Recorded curve state at the point of transition.
 
    struct FDeadBlendingCurveElement : public UE::Anim::FCurveElement
    {
        float Velocity = 0.0f;
        float HalfLife = 0.0f;
 
        FDeadBlendingCurveElement() = default;
    };
 
    // Recorded curve state at the point of transition
    TBaseBlendedCurve<TInlineAllocator<8>, FDeadBlendingCurveElement> CurveData;
 
    // Temporary storage for curve data of the Destination Pose
    TBaseBlendedCurve<TInlineAllocator<8>, UE::Anim::FCurveElement> PoseCurveData;
 
private:
 
    // Variable used to store the elapsed delta time between calls to evaluate.
    float DeltaTime = 0.0f;
 
    // Current Inertialization state.
    EInertializationState InertializationState = EInertializationState::Inactive;
 
    // Time since the last request for inertialization.
    float InertializationTime = 0.0f;
 
    // Current inertialization duration (used for curves).
    float InertializationDuration = 0.0f;
 
    // Current inertialization durations for each bone, indexed by skeleton bone index (used for per-bone blending).
    TCustomBoneIndexArray<float, FSkeletonPoseBoneIndex> InertializationDurationPerBone;
 
    // Maximum of InertializationDuration and all entries in InertializationDurationPerBone (used for knowing when to shutdown the inertialization).
    float InertializationMaxDuration = 0.0f;
 
    // Current blend mode being used for Inertialization.
    EAlphaBlendOption InertializationBlendMode = EAlphaBlendOption::Linear;
 
    // Custom blend curve being used by the current blend mode.
    UPROPERTY(Transient)
    TObjectPtr<UCurveFloat> InertializationCustomBlendCurve = nullptr;
 
 
// if ANIM_TRACE_ENABLED - these properties are only used for debugging when ANIM_TRACE_ENABLED == 1
 
    // Description for the current inertialization request
    FString InertializationRequestDescription;
 
    // Node Id for the current inertialization request
    int32 InertializationRequestNodeId = INDEX_NONE;
 
    // Anim Instance for the current inertialization request
    UPROPERTY(Transient)
    TObjectPtr<UObject> InertializationRequestAnimInstance = nullptr;
 
// endif ANIM_TRACE_ENABLED
};