AnimBoneCompressionCodec.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Animation/AnimEnums.h"
#include "Animation/AnimCompressionTypes.h"
#include "AnimEncoding.h"
#include "AnimBoneCompressionCodec.generated.h"
 
class UAnimBoneCompressionCodec;
class UAnimSequence;
struct FBlendedCurve;
class FBoneData;
 
namespace UE::Anim
{
struct FAnimPoseDecompressionData;
}
 
 
/*
 * Base class for all bone compression codecs.
 */
UCLASS(abstract, hidecategories = Object, EditInlineNew, MinimalAPI)
class UAnimBoneCompressionCodec : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(Category = Compression, EditAnywhere)
    FString Description;
 
 
#if WITH_EDITORONLY_DATA
    virtual bool IsCodecValid() const { return true; }
 
    virtual bool IsHighFidelity(const FCompressibleAnimData& CompressibleAnimData) const { return false; }
 
    virtual bool Compress(const FCompressibleAnimData& CompressibleAnimData, FCompressibleAnimDataResult& 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 and input anim sequence and TargetPlatform
     * 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(const UE::Anim::Compression::FAnimDDCKeyArgs& KeyArgs, FArchive& Ar);
 
    /*
     * Called to generate a unique DDC key for this codec instance and input anim sequence.
     * A suitable key should be generated from: the InstanceGuid, a codec version, and all relevant properties that drive the behavior.
     */
    UE_DEPRECATED(5.2, "This function has been deprecated. Override the one above instead.")
    ENGINE_API virtual void PopulateDDCKey(const UAnimSequenceBase& AnimSeq, FArchive& Ar);
 
    /*
     * 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.
     */
    UE_DEPRECATED(5.1, "This function has been deprecated. Override the one above instead.")
    ENGINE_API virtual void PopulateDDCKey(FArchive& Ar);
#endif
 
    ENGINE_API virtual UAnimBoneCompressionCodec* GetCodec(const FString& DDCHandle);
 
    ENGINE_API virtual FString GetCodecDDCHandle() const;
 
    virtual TUniquePtr<ICompressedAnimData> AllocateAnimData() const PURE_VIRTUAL(UAnimCurveCompressionCodec::AllocateAnimData, return TUniquePtr<ICompressedAnimData>(););
 
    virtual void ByteSwapIn(ICompressedAnimData& AnimData, TArrayView<uint8> CompressedData, FMemoryReader& MemoryStream) const PURE_VIRTUAL(UAnimCurveCompressionCodec::ByteSwapIn, );
 
    virtual void ByteSwapOut(ICompressedAnimData& AnimData, TArrayView<uint8> CompressedData, FMemoryWriter& MemoryStream) const PURE_VIRTUAL(UAnimCurveCompressionCodec::ByteSwapOut, );
 
    virtual void DecompressPose(FAnimSequenceDecompressionContext& DecompContext, const BoneTrackArray& RotationPairs, const BoneTrackArray& TranslationPairs, const BoneTrackArray& ScalePairs, TArrayView<FTransform>& OutAtoms) const PURE_VIRTUAL(UAnimCurveCompressionCodec::DecompressPose, );
 
    virtual void DecompressBone(FAnimSequenceDecompressionContext& DecompContext, int32 TrackIndex, FTransform& OutAtom) const PURE_VIRTUAL(UAnimCurveCompressionCodec::DecompressBone, );
 
    ENGINE_API virtual void DecompressPose(FAnimSequenceDecompressionContext& DecompContext, const UE::Anim::FAnimPoseDecompressionData& DecompressionData) const;
};