AnimationUtils.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    AnimationUtils.h: Skeletal mesh animation utilities.
=============================================================================*/ 
 
#pragma once
 
#include "CoreMinimal.h"
#include "Animation/AnimSequence.h"
 
ENGINE_API DECLARE_LOG_CATEGORY_EXTERN(LogAnimNotify, Warning, All);
ENGINE_API DECLARE_LOG_CATEGORY_EXTERN(LogAnimMontage, Warning, All);
ENGINE_API DECLARE_LOG_CATEGORY_EXTERN(LogAnimMarkerSync, Warning, All);
 
// Forward declarations.
class UAnimSet;
class UVariableFrameStrippingSettings;
 
struct FAnimPerturbationError
{
    float MaxErrorInTransDueToTrans;
    float MaxErrorInRotDueToTrans;
    //float MaxErrorInScaleDueToTrans; // Not used TODO: Either use or remove
    float MaxErrorInTransDueToRot;
    float MaxErrorInRotDueToRot;
    //float MaxErrorInScaleDueToRot; // Not used TODO: Either use or remove
    float MaxErrorInTransDueToScale; 
    float MaxErrorInRotDueToScale;
    //float MaxErrorInScaleDueToScale; // Not used TODO: Either use or remove
};
 
using AnimationErrorStats = FAnimationErrorStats;
 
enum EConvertToAdditive
{
    CTA_RefPose,
    CTA_AnimFirstFrame,
    CTA_AnimScaled,
    CTA_MAX // Always last one
};
 
class FAnimationUtils
{
public:
 
 
    static void BuildComponentSpaceTransform(FTransform& OutTransform,
                                                int32 BoneIndex,
                                                const TArray<FTransform>& BoneSpaceTransforms,
                                                const TArray<FBoneData>& BoneData);
 
    ENGINE_API static void BuildSkeletonMetaData(USkeleton* Skeleton, TArray<FBoneData>& OutBoneData);
 
    static int32 GetAnimTrackIndexForSkeletonBone(const int32 InSkeletonBoneIndex, const TArray<FTrackToSkeletonMap>& TrackToSkelMap);
 
#if WITH_EDITOR
    ENGINE_API static void ComputeCompressionError(const FCompressibleAnimData& CompressibleAnimData, FCompressibleAnimDataResult& CompressedData, AnimationErrorStats& ErrorStats);
#endif
    
    static bool GetForcedRecompressionSetting();
 
    static UObject* GetDefaultAnimSequenceOuter(UAnimSet* InAnimSet, bool bCreateIfNotFound);
 
    static FString GetAnimationKeyFormatString(enum AnimationKeyFormat InFormat);
 
    ENGINE_API static FString GetAnimationCompressionFormatString(enum AnimationCompressionFormat InFormat);
 
#if WITH_EDITOR
    static void CalculateTrackHeights(const FCompressibleAnimData& CompressibleAnimData, int NumTracks, TArray<int32>& TrackHeights);
#endif // WITH_EDITOR
 
    static bool HasUniformKeySpacing(int32 NumFrames, const TArray<float>& Times);
 
#if WITH_EDITOR
    static void TallyErrorsFromPerturbation(
        const FCompressibleAnimData& CompressibleAnimData,
        int32 NumTracks,
        const FVector& PositionNudge,
        const FQuat& RotationNudge,
        const FVector& ScaleNudge,
        TArray<FAnimPerturbationError>& InducedErrors);
 
    ENGINE_API static void PreloadCompressionSettings();
#endif
    
    ENGINE_API static UAnimBoneCompressionSettings* GetDefaultAnimationBoneCompressionSettings();
 
    ENGINE_API static UAnimBoneCompressionSettings* GetDefaultAnimationRecorderBoneCompressionSettings();
 
    ENGINE_API static UAnimCurveCompressionSettings* GetDefaultAnimationCurveCompressionSettings();
 
    ENGINE_API static UVariableFrameStrippingSettings* GetDefaultVariableFrameStrippingSettings();
 
    ENGINE_API static void EnsureAnimSequenceLoaded(UAnimSequence& AnimSeq);
 
    // Extract specific frame from raw track and place in OutAtom (return identity if track is malformed)
    ENGINE_API static void ExtractTransformForFrameFromTrackSafe(const FRawAnimSequenceTrack& RawTrack, int32 Frame, FTransform& OutAtom);
 
    // Extract specific frame from raw track and place in OutAtom
    ENGINE_API static void ExtractTransformForFrameFromTrack(const FRawAnimSequenceTrack& RawTrack, int32 Frame, FTransform& OutAtom);
 
    UE_DEPRECATED(5.1, "ExtractTransformFromTrack has been deprecated, use different signature")
    ENGINE_API static void ExtractTransformFromTrack(float Time, int32 NumFrames, float SequenceLength, const struct FRawAnimSequenceTrack& RawTrack, EAnimInterpolationType Interpolation, FTransform &OutAtom);
 
    ENGINE_API static void ExtractTransformFromTrack(const struct FRawAnimSequenceTrack& RawTrack, double Time, int32 NumFrames, double SequenceLength, EAnimInterpolationType Interpolation, FTransform &OutAtom);
 
#if WITH_EDITOR
    UE_DEPRECATED(5.1, "ExtractTransformFromCompressionData has been deprecated, use different signature")
    static void ExtractTransformFromCompressionData(const FCompressibleAnimData& CompressibleAnimData, FCompressibleAnimDataResult& CompressedAnimData, float Time, int32 TrackIndex, bool bUseRawData, FTransform& OutBoneTransform);
    
    static void ExtractTransformFromCompressionData(const FCompressibleAnimData& CompressibleAnimData, FCompressibleAnimDataResult& CompressedAnimData, double Time, int32 TrackIndex, bool bUseRawData, FTransform& OutBoneTransform);
 
    ENGINE_API static bool CompressAnimBones(FCompressibleAnimData& AnimSeq, FCompressibleAnimDataResult& Target);
 
    ENGINE_API static bool CompressAnimCurves(FCompressibleAnimData& AnimSeq, FCompressedAnimSequence& Target);
#endif
};