AnimCurveCompressionCodec.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Animation/AnimTypes.h"
#include "Animation/AnimCompressionTypes.h"
#include "AnimCurveCompressionCodec.generated.h"
 
class UAnimCurveCompressionCodec;
class UAnimSequence;
struct FBlendedCurve;
 
#if WITH_EDITORONLY_DATA
struct FAnimCurveCompressionResult
{
    TArray<uint8> CompressedBytes;
 
    UAnimCurveCompressionCodec* Codec;
 
    FAnimCurveCompressionResult() : CompressedBytes(), Codec(nullptr) {}
};
#endif
 
/*
 * Base class for all curve compression codecs.
 */
UCLASS(abstract, hidecategories = Object, EditInlineNew, MinimalAPI)
class UAnimCurveCompressionCodec : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    virtual UAnimCurveCompressionCodec* GetCodec(const FString& Path) { return this; }
 
 
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
 
    /*
     * Called on load and when cooking to validate that the compressed data is good.
     * Codecs should perform necessary validation and emit an error when appropriate.
     * e.g: UE_LOG(LogAnimationCompression, Error, TEXT("Bad data!"));
     * 
     * Returns true when the data is valid, false otherwise.
     */
    virtual bool ValidateCompressedData(UObject* DataOwner, const FCompressedAnimSequence& AnimSeq) const { return true; }
 
#if WITH_EDITORONLY_DATA
    virtual bool IsCodecValid() const { return true; }
 
    virtual bool Compress(const FCompressibleAnimData& AnimSeq, FAnimCurveCompressionResult& OutResult) PURE_VIRTUAL(UAnimCurveCompressionCodec::Compress, return false;);
 
    ENGINE_API virtual int64 EstimateCompressionMemoryUsage(const UAnimSequence& AnimSequence) const;
 
    /*
     * Called to generate a unique DDC key for this codec instance.
     * A suitable key should be generated from: the InstanceGuid, a codec version, and all relevant properties that drive the behavior.
     */
    ENGINE_API virtual void PopulateDDCKey(FArchive& Ar);
#endif
 
    /*
     * Decompresses all the active blended curves.
     * Note: Codecs should _NOT_ rely on any member properties during decompression. Decompression
     * behavior should entirely be driven by code and the compressed data.
     */
    virtual void DecompressCurves(const FCompressedAnimSequence& AnimSeq, FBlendedCurve& Curves, float CurrentTime) const PURE_VIRTUAL(UAnimCurveCompressionCodec::DecompressCurves, );
 
    /*
     * Decompress a single curve.
     * Note: Codecs should _NOT_ rely on any member properties during decompression. Decompression
     * behavior should entirely be driven by code and the compressed data.
     */
    virtual float DecompressCurve(const FCompressedAnimSequence& AnimSeq, FName CurveName, float CurrentTime) const PURE_VIRTUAL(UAnimCurveCompressionCodec::DecompressCurve, return 0.0f;);
    
    UE_DEPRECATED(5.3, "Please use DecompressCurve that takes an FName.")
    virtual float DecompressCurve(const FCompressedAnimSequence& AnimSeq, SmartName::UID_Type CurveUID, float CurrentTime) const { return 0.0f; }
};