UAnimBoneCompressionSettings

This object is used to wrap a bone compression codec.

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimBoneCompressionSettings

References

Module

Engine

Header

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

Include

#include "Animation/AnimBoneCompressionSettings.h"

Syntax

class UAnimBoneCompressionSettings : public UObject

Remarks

This object is used to wrap a bone compression codec. It allows a clean integration in the editor by avoiding the need to create asset types and factory wrappers for every codec.

Variables

Name Description

Public variable

bool

 

bForceBelowThreshold

Any codec (even one that increases the size) with a lower error will be used until it falls below the threshold.

Public variable

TArray < UAnimBo ...

 

Codecs

A list of animation bone compression codecs to try.

Public variable

float

 

ErrorThreshold

When compressing, the best codec below this error threshold will be used.

Constructors

Name Description

Public function

UAnimBoneCompressionSettings

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

AreSettingsValid()

Returns whether or not we can use these settings to compress.

Public function Const

bool

 

Compress

(
    const FCompressibleAnimData & AnimS...,
    FCompressibleAnimDataResult & OutCo...
)

Compresses the animation bones inside the supplied sequence.

Public function

UAnimBoneCom ...

 

GetCodec

(
    const FString & DDCHandle
)

Allow us to convert DDC serialized path back into codec object

Public function

void

 

PopulateDDCKey

(
    FArchive & Ar
)

Generates a DDC key that takes into account the current settings and selected codec.

Overridden from UObject

Name Description

Public function Virtual

void

 

GetPreloadDependencies

(
    TArray < UObject * >& OutDeps
)

Called during cooking.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback