AnimBoneCompressionSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "AnimBoneCompressionSettings.generated.h"
 
class UAnimBoneCompressionCodec;
class UAnimSequenceBase;
 
#if WITH_EDITORONLY_DATA
struct FCompressibleAnimData;
struct FCompressibleAnimDataResult;
namespace UE::Anim::Compression { struct FAnimDDCKeyArgs; }
#endif // WITH_EDITORONLY_DATA
 
/*
 * This object is used to wrap a bone compression codec. It allows a clean integration in the editor by avoiding the need
 * to create asset types and factory wrappers for every codec.
 */
UCLASS(hidecategories = Object, MinimalAPI)
class UAnimBoneCompressionSettings : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(Category = Compression, Instanced, EditAnywhere, meta = (NoElementDuplicate))
    TArray<TObjectPtr<UAnimBoneCompressionCodec>> Codecs;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(Category = Compression, EditAnywhere, meta = (ClampMin = "0"))
    float ErrorThreshold;
 
    UPROPERTY(Category = Compression, EditAnywhere)
    bool bForceBelowThreshold;
#endif
 
    ENGINE_API UAnimBoneCompressionCodec* GetCodec(const FString& DDCHandle);
 
 
#if WITH_EDITORONLY_DATA
    // UObject overrides
    ENGINE_API virtual void GetPreloadDependencies(TArray<UObject*>& OutDeps) override;
 
    ENGINE_API bool AreSettingsValid() const;
 
    ENGINE_API bool IsHighFidelity(const FCompressibleAnimData& CompressibleAnimData) const;
 
    /*
     * Compresses the animation bones inside the supplied sequence.
     * The resultant compressed data is applied to the OutCompressedData structure.
     */
    ENGINE_API bool Compress(const FCompressibleAnimData& AnimSeq, FCompressibleAnimDataResult& OutCompressedData) const;
 
    ENGINE_API void PopulateDDCKey(const UE::Anim::Compression::FAnimDDCKeyArgs& KeyArgs, FArchive& Ar);
 
    UE_DEPRECATED(5.2, "This function has been deprecated. Override the one above instead.")
    ENGINE_API void PopulateDDCKey(const UAnimSequenceBase& AnimSeq, FArchive& Ar);
 
    UE_DEPRECATED(5.1, "This function has been deprecated. Override the one above instead.")
    ENGINE_API void PopulateDDCKey(FArchive& Ar);
#endif
};