Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UAnimCompress

UAnimCompress

API > API/Runtime > API/Runtime/Engine

   
Name UAnimCompress
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Animation/AnimCompress.h
Include Path #include "Animation/AnimCompress.h"

Syntax

UCLASS (Abstract, HideCategories=Object, MinimalAPI, EditInlineNew)  
class UAnimCompress : public UAnimBoneCompressionCodec

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimCompress ( const FObjectInitializer& ObjectInitializer
)

   Animation/AnimCompress.h  

Constants

Name Type Remarks Include Path
AnimationPadSentinel uint8 Default animation padding value. Animation/AnimCompress.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bNeedsSkeleton uint32 Compression algorithms requiring a skeleton should set this value to true. Animation/AnimCompress.h  
RotationCompressionFormat TEnumAsByte< AnimationCompressionFormat > Format for bitwise compression of rotation data. Animation/AnimCompress.h
  • Category=Compression
  • EditAnywhere
ScaleCompressionFormat TEnumAsByte< AnimationCompressionFormat > Format for bitwise compression of scale data. Animation/AnimCompress.h
  • Category=Compression
  • EditAnywhere
TranslationCompressionFormat TEnumAsByte< AnimationCompressionFormat > Format for bitwise compression of translation data. Animation/AnimCompress.h
  • Category=Compression
  • EditAnywhere

Functions

Public

Name Remarks Include Path Unreal Specifiers

void PopulateDDCKeyArchive ( FArchive& Ar
)

   Animation/AnimCompress.h  

Overridden from UAnimBoneCompressionCodec

Name Remarks Include Path Unreal Specifiers
Allocates the necessary anim data structure used for decompression. Animation/AnimCompress.h  

virtual void ByteSwapIn ( ICompressedAnimData& AnimData,
TArrayView< uint8 > CompressedData,
FMemoryReader& MemoryStream
) const

 Handles Byte-swapping incoming animation data from a MemoryReader Animation/AnimCompress.h  

virtual void ByteSwapOut ( ICompressedAnimData& AnimData,
TArrayView< uint8 > CompressedData,
FMemoryWriter& MemoryStream
) const

 Handles Byte-swapping outgoing animation data to an array of BYTEs Animation/AnimCompress.h  

virtual bool Compress ( const FCompressibleAnimData& CompressibleAnimData,
FCompressibleAnimDataResult& OutResult
)

 UAnimBoneCompressionCodec implementation Animation/AnimCompress.h  

virtual void DecompressBone ( FAnimSequenceDecompressionContext& DecompContext,
int32 TrackIndex,
FTransform& OutAtom
) const

 Decompress a single bone. Animation/AnimCompress.h  

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

 Decompresses all the specified bone tracks. Animation/AnimCompress.h  

Protected

Name Remarks Include Path Unreal Specifiers

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). Animation/AnimCompress.h  

Overridden from UAnimBoneCompressionCodec

Name Remarks Include Path Unreal Specifiers

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 and TargetPlatform A suitable key should be generated from: the InstanceGuid, a codec version, and all relevant properties that drive the behavior. Animation/AnimCompress.h  

Static

Name Remarks Include Path Unreal Specifiers

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. Animation/AnimCompress.h  

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

 Common compression utility to retain only intermittent animation keys. Animation/AnimCompress.h  

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

 Common compression utility to retain only intermittent position keys. Animation/AnimCompress.h  

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

 Common compression utility to retain only intermittent position keys. Animation/AnimCompress.h  

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

 Common compression utility to retain only intermittent rotation keys. Animation/AnimCompress.h  

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

 Common compression utility to retain only intermittent rotation keys. Animation/AnimCompress.h  

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 Animation/AnimCompress.h  

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 Animation/AnimCompress.h  

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

 Common compression utility to remove 'redundant' position keys based on the provided delta threshold Animation/AnimCompress.h  

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 Animation/AnimCompress.h  

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 Animation/AnimCompress.h  

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

 Common compression utility to remove 'redundant' Scale keys based on the provided delta threshold Animation/AnimCompress.h  

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 Animation/AnimCompress.h  

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. Animation/AnimCompress.h  

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. Animation/AnimCompress.h  

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. Animation/AnimCompress.h  

static void PrecalculateShortestQuaternionRoutes ( TArray< struct FRotationTrack >& RotationData
)

 Common compression utility to walk an array of rotation tracks and enforce that all adjacent rotation keys are represented by shortest-arc quaternion pairs. Animation/AnimCompress.h  

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. Animation/AnimCompress.h  

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

 Utility function to append data to a byte stream. Animation/AnimCompress.h  

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

 Utility function to write data to a byte stream. Animation/AnimCompress.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page