1. Epic GamesDeveloper
  3. UAnimCompress

UAnimCompress

Unreal Engine C++ API Reference > Runtime > Engine > Animation

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AnimCompress.h
Include #include "Animation/AnimCompress.h"

Syntax

class UAnimCompress : public UAnimBoneCompressionCodec

Variables

  Type Name Description
Public variable uint32: 1 bNeedsSkeleton Compression algorithms requiring a skeleton should set this value to true.
Public variable TEnumAsByte< AnimationCompressionFormat > RotationCompressionFormat Format for bitwise compression of rotation data.
Public variable TEnumAsByte< AnimationCompressionFormat > ScaleCompressionFormat Format for bitwise compression of scale data.
Public variable TEnumAsByte< AnimationCompressionFormat > TranslationCompressionFormat Format for bitwise compression of translation data.

Constructors

  Type Name Description
Public function  

UAnimCompress ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void

BitwiseCompressAnimationTracks ( const FCompressibleAnimData& CompressibleAnimData,
FCompressibleAnimDataResult& OutCompressedData,
AnimationCompressionFormat TargetTranslationFormat,
AnimationCompressionFormat TargetRotationFormat,
AnimationCompressionFormat TargetScaleFormat,
const TArray< FTranslationTrack >& TranslationData,
const TArray< FRotationTrack >& RotationData,
const TArray< FScaleTrack >& ScaleData,
bool IncludeKeyTable
)

 Encodes individual key arrays into an AnimSequence using the desired bit packing formats.
Protected function Virtual bool

DoReduction ( const FCompressibleAnimData& CompressibleAnimData,
FCompressibleAnimDataResult& OutResult
)

 Implemented by child classes, this function reduces the number of keyframes in the specified sequence, given the specified skeleton (if needed).
Protected function Static void

FilterIntermittentKeys ( TArray< struct FTranslationTrack >& PositionTracks,
TArray< struct FRotationTrack >& RotationTracks,
int32 StartIndex,
int32 Interval
)

 Common compression utility to retain only intermittent animation keys.
Protected function Static void

FilterIntermittentPositionKeys ( FTranslationTrack& Track,
int32 StartIndex,
int32 Interval
)

 Common compression utility to retain only intermittent position keys.
Protected function Static void

FilterIntermittentPositionKeys ( TArray< struct FTranslationTrack >& PositionTracks,
int32 StartIndex,
int32 Interval
)

 Common compression utility to retain only intermittent position keys.
Protected function Static void

FilterIntermittentRotationKeys ( FRotationTrack& Track,
int32 StartIndex,
int32 Interval
)

 Common compression utility to retain only intermittent rotation keys.
Protected function Static void

FilterIntermittentRotationKeys ( TArray< struct FRotationTrack >& RotationTracks,
int32 StartIndex,
int32 Interval
)

 Common compression utility to retain only intermittent rotation keys.
Protected function Static void

FilterTrivialKeys ( TArray< struct FTranslationTrack >& PositionTracks,
TArray< struct FRotationTrack >& RotationTracks,
TArray< struct FScaleTrack >& ScaleTracks,
float MaxPosDelta,
float MaxRotDelta,
float MaxScaleDelta
)

 Common compression utility to remove 'redundant' keys based on the provided delta thresholds
Protected function Static void

FilterTrivialPositionKeys ( FTranslationTrack& Track,
float MaxPosDelta
)

 Common compression utility to remove 'redundant' position keys in a single track based on the provided delta threshold
Protected function Static void

FilterTrivialPositionKeys ( TArray< struct FTranslationTrack >& Track,
float MaxPosDelta
)

 Common compression utility to remove 'redundant' position keys based on the provided delta threshold
Protected function Static void

FilterTrivialRotationKeys ( FRotationTrack& Track,
float MaxRotDelta
)

 Common compression utility to remove 'redundant' rotation keys in a set of tracks based on the provided delta threshold
Protected function Static void

FilterTrivialRotationKeys ( TArray< struct FRotationTrack >& InputTracks,
float MaxRotDelta
)

 Common compression utility to remove 'redundant' rotation keys in a set of tracks based on the provided delta threshold
Protected function Static void

FilterTrivialScaleKeys ( TArray< struct FScaleTrack >& Track,
float MaxScaleDelta
)

 Common compression utility to remove 'redundant' Scale keys based on the provided delta threshold
Protected function Static void

FilterTrivialScaleKeys ( FScaleTrack& Track,
float MaxScaleDelta
)

 Common compression utility to remove 'redundant' Scale keys in a single track based on the provided delta threshold
Protected function Static void

PackQuaternionToStream ( TArray< uint8 >& ByteStream,
AnimationCompressionFormat Format,
const FQuat4f& Quat,
const float* Mins,
const float* Ranges
)

 Utility function to append a packed FQuat to a byte stream.
Protected function Static void

PackVectorToStream ( TArray< uint8 >& ByteStream,
AnimationCompressionFormat Format,
const FVector3f& Vec,
const float* Mins,
const float* Ranges
)

 Utility function to append a packed FVector to a byte stream.
Protected function Static void

PadByteStream ( TArray< uint8 >& ByteStream,
const int32 Alignment,
uint8 Sentinel
)

 Pads a byte stream to force a particular alignment for the data to follow.
Protected function Static void Common compression utility to walk an array of rotation tracks and enforce that all adjacent rotation keys are represented by shortest-arc quaternion pairs.
Protected function Static void

SeparateRawDataIntoTracks ( const TArray< struct FRawAnimSequenceTrack >& RawAnimData,
float SequenceLength,
TArray< struct FTranslationTrack >& OutTranslationData,
TArray< struct FRotationTrack >& OutRotationData,
TArray< struct FScaleTrack >& OutScaleData
)

 Common compression utility to populate individual rotation and translation track arrays from a set of raw animation tracks.
Protected function Static void

UnalignedWriteToStream ( TArray< uint8 >& ByteStream,
const void* Src,
SIZE_T Len
)

 Utility function to append data to a byte stream.
Protected function Static void

UnalignedWriteToStream ( TArray< uint8 >& ByteStream,
int32& StreamOffset,
const void* Src,
SIZE_T Len
)

 Utility function to write data to a byte stream.

Overridden from UAnimBoneCompressionCodec

  Type Name Description
Public function Virtual Const TUniquePtr< ICompressedAnimData > 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& CompressibleAnimData,
FCompressibleAnimDataResult& OutResult
)

 UAnimBoneCompressionCodec implementation
Public function Virtual Const void

DecompressBone ( FAnimSequenceDecompressionContext& DecompContext,
int32 TrackIndex,
FTransform& OutAtom
)

 Decompress a single bone.
Public function Virtual Const void

DecompressPose ( FAnimSequenceDecompressionContext& DecompContext,
const BoneTrackArray& RotationPairs,
const BoneTrackArray& TranslationPairs,
const BoneTrackArray& ScalePairs,
TArrayView< FTransform >& OutAtoms
)

 Decompresses all the specified bone tracks.
Protected function Virtual void 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.

Constants

Name Description
AnimationPadSentinel Default animation padding value.

Deprecated Functions

  Type Name Description
Public function void PopulateDDCKeyArchive has been deprecated

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page