UAnimBoneCompressionCodec

Base class for all bone compression codecs.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Animation/AnimBoneCompressionCodec.h

Include

#include "Animation/AnimBoneCompressionCodec.h"

Syntax

class UAnimBoneCompressionCodec : public UObject

Remarks

Base class for all bone compression codecs.

Variables

Name Description

Public variable

FString

 

Description

Description for this codec.

Constructors

Name Description

Public function

UAnimBoneCompressionCodec

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual Const

TUniquePtr< ...

 

AllocateAnimData()

Allocates the necessary anim data structure used for decompression.

Public function Virtual Const

void

 

ByteSwapIn

(
    ICompressedAnimData& AnimData,
    TArrayView< uint8 > CompressedData,
    FMemoryReader& MemoryStream
)

Handles Byte-swapping incoming animation data from a MemoryReader

Public function Virtual Const

void

 

ByteSwapOut

(
    ICompressedAnimData& AnimData,
    TArrayView< uint8 > CompressedData,
    FMemoryWriter& MemoryStream
)

Handles Byte-swapping outgoing animation data to an array of BYTEs

Public function Virtual

bool

 

Compress

(
    const FCompressibleAnimData& Compr...,
    FCompressibleAnimDataResult& OutRe...
)

Compresses the curve data from an animation sequence.

Public function Virtual Const

void

 

DecompressBone

(
    FAnimSequenceDecompressionContext&...,
    int32 TrackIndex,
    FTransform& OutAtom
)

Decompress a single bone.

Public function Virtual Const

void

 

DecompressPose

(
    FAnimSequenceDecompressionContext&...,
    const BoneTrackArray& RotationPair...,
    const BoneTrackArray& TranslationP...,
    const BoneTrackArray& ScalePairs,
    TArrayView< FTransform >& OutAtoms
)

Decompresses all the specified bone tracks.

Public function Virtual

UAnimBoneCom...

 

GetCodec

(
    const FString& DDCHandle
)

Allow us to convert DDC serialized path back into codec object

Public function Virtual Const

FString

 

GetCodecDDCHandle()

Returns a unique path relative to the parent settings asset

Public function Virtual Const

bool

 

IsCodecValid()

Returns whether or not we can use this codec to compress.

Public function Virtual

void

 

PopulateDDCKey

(
    FArchive& Ar
)

Called to generate a unique DDC key for this codec instance.