FAnimationCompression_PerTrackUtils

This class contains helper methods for dealing with animations compressed with the per-track codec

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/AnimationCompression.h

Include

#include "AnimationCompression.h"

Syntax

class FAnimationCompression_PerTrackUtils

Remarks

This class contains helper methods for dealing with animations compressed with the per-track codec

Functions

Name Description

Public function Static

uint16

 

CompressFixed16

(
    float Value,
    int32 Log2MaxValue
)

Log2MaxValue of 0 => -1..1 Log2MaxValue of 7 => -128..128 Can be 0..15 Compresses a float into a signed fixed point number, which can range from the symmetrical values of -2^Log2MaxValue ..

Public function Static

void

 

DecomposeHeader

(
    int32 Header,
    int32& KeyFormat,
    int32& NumKeys,
    int32& FormatFlags
)

Decomposes a header created with MakeHeader into three/four fields (two are still left packed into FormatFlags):

Public function Static

void

 

DecomposeHeader

(
    int32 Header,
    int32& KeyFormat,
    int32& NumKeys,
    int32& FormatFlags,
    int32& BytesPerKey,
    int32& FixedBytes
)

Decomposes a header created with MakeHeader into three/four fields (two are still left packed into FormatFlags):

Public function Static

float

 

DecompressFixed16

(
    uint16 Value
)

Decompresses a fixed point number encoded by ComrpessFixed16

Public function

float

 

DecompressFixed16

(
    uint16 Value
)

Public function Static

void

 

DecompressRotation

(
    int32 Format,
    int32 FormatFlags,
    FQuat& Out,
    const uint8*restrict TopOfSt...,
    const uint8*restrict KeyData
)

Decompress a single rotation key from a single track that was compressed with the PerTrack codec (scalar)

Public function Static

void

 

DecompressScale

(
    int32 Format,
    int32 FormatFlags,
    FVector& Out,
    const uint8*restrict TopOfSt...,
    const uint8*restrict KeyData
)

Decompress a single Scale key from a single track that was compressed with the PerTrack codec (scalar)

Public function Static

void

 

DecompressTranslation

(
    int32 Format,
    int32 FormatFlags,
    FVector& Out,
    const uint8*restrict TopOfSt...,
    const uint8*restrict KeyData
)

Decompress a single translation key from a single track that was compressed with the PerTrack codec (scalar)

Public function Static

void

 

GetAllSizesFromFormat

(
    int32 KeyFormat,
    int32 FormatFlags,
    int32& KeyComponentCount,
    int32& KeyComponentSize,
    int32& FixedComponentCount,
    int32& FixedComponentSize
)

Figures out the size of various parts of a compressed track from the format and format flags combo

Public function Static

void

 

GetByteSizesFromFormat

(
    int32 KeyFormat,
    int32 FormatFlags,
    int32& BytesPerKey,
    int32& FixedBytes
)

Public function Static

int32

 

GetKeyCountFromHeader

(
    int32 Header
)

Extracts the number of keys from a header created by MakeHeader

Public function Static

int32

 

MakeHeader

(
    const int32 NumKeys,
    const int32 KeyFormat,
    const int32 KeyFlags,
    bool bReallyNeedsFrameTable
)

Creates a header integer with four fields: NumKeys can be no more than 24 bits (positions 0..23) KeyFlags can be no more than 3 bits (positions 24..27) bReallyNeedsFrameTable is a single bit (position 27) KeyFormat can be no more than 4 bits (positions 31..28)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss