AnimationEvaluation.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Components/SkeletalMeshComponent.h"
#include "Containers/Map.h"
#include "Delegates/IDelegateInstance.h"
#include "Math/Transform.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
namespace UE::Anim
{
 
struct FAnimationEvaluationTask
{
    bool IsValid(const USkeletalMeshComponent* InSkeletalMeshComponent) const
    {
        return Guid.IsValid() && PostEvaluationFunction.IsSet() && InSkeletalMeshComponent && InSkeletalMeshComponent == SkeletalMeshComponent;
    }
 
    FGuid Guid;
    TWeakObjectPtr<USkeletalMeshComponent> SkeletalMeshComponent = nullptr;
    TFunction<void()> PostEvaluationFunction;
};
    
struct FAnimationEvaluator
{
    FAnimationEvaluator(USkeletalMeshComponent* InSkeletalMeshComponent);
    ~FAnimationEvaluator();
 
    void Update(const bool bRefreshBoneTransforms);
    
    bool IsValid(const bool bForTransform = false) const;
    
    CONSTRAINTS_API FTransform GetGlobalTransform(const FName InSocketName) const;
 
    FTransform GetRelativeTransform(const FName InSocketName) const;
 
    bool AddPostEvaluationTask(const FAnimationEvaluationTask& InTask);
    
private:
 
    FAnimationEvaluator() = default;
 
    void UpdateContext();
    
    void EvaluateAnimation();
 
    void RefreshBoneTransforms();
 
    void BoneTransformsFinalized();
    
    TWeakObjectPtr<USkeletalMeshComponent> SkeletalMeshComponent = nullptr;
    FAnimationEvaluationContext Context;
    FDelegateHandle OnBoneTransformsFinalizedHandle;
    TMap<FGuid, FAnimationEvaluationTask> PostEvaluationTasks;
};
 
struct FAnimationEvaluationCache
{
public:
    static FAnimationEvaluationCache& Get();
    ~FAnimationEvaluationCache();
 
    void MarkForEvaluation(const USkeletalMeshComponent* InSkeletalMeshComponent);
    
    const FAnimationEvaluator& GetEvaluator(USkeletalMeshComponent* InSkeletalMeshComponent);
    
    const FAnimationEvaluator& GetEvaluator(USkeletalMeshComponent* InSkeletalMeshComponent, const FAnimationEvaluationTask& InTask);
 
private:
    FAnimationEvaluationCache() = default;
 
    void RegisterNotifications();
 
    void UnregisterNotifications();
 
    TMap<USkeletalMeshComponent*, FAnimationEvaluator> PerSkeletalMeshEvaluator;
 
    FDelegateHandle ConstraintsNotificationHandle;
};
 
struct FEvaluationForCachingScope : public FNoncopyable
{
    CONSTRAINTS_API FEvaluationForCachingScope(const float InDeltaTime = 1.f / 30.f);
    CONSTRAINTS_API ~FEvaluationForCachingScope();
};
 
CONSTRAINTS_API bool IsCaching();
    
}