UAnimCompress_PerTrackCompression Class Reference

Public Member Functions
Functions
void	SetbUseAdaptiveError (bool Value)
	If true, adjust the error thresholds based on the 'height' within the skeleton.
void	SetbUseOverrideForEndEffectors (bool Value)
	If true, uses MinEffectorDiff as the threshold for end effectors.
void	SetbUseAdaptiveError2 (bool Value)
	If true, the adaptive error system will determine how much error to allow for each track, based on the error introduced in end effectors due to errors in the track.
void	SetbResampleAnimation (bool Value)
	If true, resample the animation to ResampleFramerate frames per second.
Public Member Functions inherited from UAnimCompress_RemoveLinearKeys
void	SetbActuallyFilterLinearKeys (bool Value)
	Controls whether the final filtering step will occur, or only the retargetting after bitwise compression. If both this and bRetarget are false, then the linear compressor will do no better than the underlying bitwise compressor, extremely slowly.
void	SetbRetarget (bool Value)
	true = As the animation is compressed, adjust animated nodes to compensate for compression error. false= Do not adjust animated nodes.
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UAnimCompress_RemoveLinearKeys
static UClass	StaticClass ()
Static Public Member Functions inherited from UAnimCompress
static UClass	StaticClass ()
Static Public Member Functions inherited from UAnimBoneCompressionCodec
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Public Attributes
AdaptiveError
float32	ParentingDivisorExponent
	Reduces the error tolerance the further up the tree that a key occurs EffectiveErrorTolerance = Max(BaseErrorTolerance / Power(ParentingDivisor, Max(Height+Bias,0) * ParentingDivisorExponent), ZeroingThreshold) Only has an effect bUseAdaptiveError is true.
float32	ParentingDivisor
	Reduces the error tolerance the further up the tree that a key occurs EffectiveErrorTolerance = Max(BaseErrorTolerance / Power(ParentingDivisor, Max(Height+Bias,0) * ParentingDivisorExponent), ZeroingThreshold) Only has an effect bUseAdaptiveError is true.
int	TrackHeightBias
	A bias added to the track height before using it to calculate the adaptive error.
AdaptiveError2
float32	MaxErrorPerTrackRatio
	A fraction that determines how much of the total error budget can be introduced by any particular track.
float32	TranslationErrorSourceRatio
	This ratio determines how much error in end effector translation can come from a given track's rotation error or translation error. If 1, all of it must come from rotation error, if 0.5, half can come from each, and if 0.0, all must come from translation error.
float32	RotationErrorSourceRatio
	This ratio determines how much error in end effector rotation can come from a given track's rotation error or translation error. If 1, all of it must come from rotation error, if 0.5, half can come from each, and if 0.0, all must come from translation error.
float32	ScaleErrorSourceRatio
	This ratio determines how much error in end effector scale can come from a given track's rotation error or scale error. If 1, all of it must come from rotation error, if 0.5, half can come from each, and if 0.0, all must come from scale error.
PerTrack
float32	MaxPosDiffBitwise
	Maximum position difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.
TArray< AnimationCompressionFormat >	AllowedTranslationFormats
	Which encoding formats is the per-track compressor allowed to try on translation keys.
TArray< AnimationCompressionFormat >	AllowedRotationFormats
	Which encoding formats is the per-track compressor allowed to try on rotation keys.
float32	MaxAngleDiffBitwise
	Maximum angle difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.
TArray< AnimationCompressionFormat >	AllowedScaleFormats
	Which encoding formats is the per-track compressor allowed to try on scale keys.
float32	MaxZeroingThreshold
	Maximum threshold to use when replacing a component with zero. Lower values retain more keys, but yield less compression.
float32	MaxScaleDiffBitwise
	Maximum position difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.
Resampling
float32	ResampledFramerate
	When bResampleAnimation is true, this defines the desired framerate.
int	MinKeysForResampling
	Animations with fewer keys than MinKeysForResampling will not be resampled.
Public Attributes inherited from UAnimCompress_RemoveLinearKeys
float32	MaxAngleDiff
	Maximum angle difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.
float32	MaxScaleDiff
	Maximum Scale difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.
float32	MaxEffectorDiff
	As keys are tested for removal, we monitor the effects all the way down to the end effectors. If their position changes by more than this amount as a result of removing a key, the key will be retained. This value is used for all bones except the end-effectors parent.
float32	MinEffectorDiff
	As keys are tested for removal, we monitor the effects all the way down to the end effectors. If their position changes by more than this amount as a result of removing a key, the key will be retained. This value is used for the end-effectors parent, allowing tighter restrictions near the end of a skeletal chain.
float32	EffectorDiffSocket
	Error threshold for End Effectors with Sockets attached to them. Typically more important bone, where we want to be less aggressive with compression.
float32	ParentKeyScale
	A scale value which increases the likelihood that a bone will retain a key if it's parent also had a key at the same time position. Higher values can remove shaking artifacts from the animation, at the cost of compression.
float32	MaxPosDiff
	Maximum position difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.
Public Attributes inherited from UAnimCompress
AnimationCompressionFormat	RotationCompressionFormat
	Format for bitwise compression of rotation data.
AnimationCompressionFormat	ScaleCompressionFormat
	Format for bitwise compression of scale data.
AnimationCompressionFormat	TranslationCompressionFormat
	Format for bitwise compression of translation data.
Public Attributes inherited from UAnimBoneCompressionCodec
FString	Description
	Description for this codec.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Member Function Documentation

SetbResampleAnimation()

void SetbResampleAnimation

(

bool

Value

)

If true, resample the animation to ResampleFramerate frames per second.

SetbUseAdaptiveError()

void SetbUseAdaptiveError

(

bool

Value

)

If true, adjust the error thresholds based on the 'height' within the skeleton.

SetbUseAdaptiveError2()

void SetbUseAdaptiveError2

(

bool

Value

)

If true, the adaptive error system will determine how much error to allow for each track, based on the error introduced in end effectors due to errors in the track.

SetbUseOverrideForEndEffectors()

void SetbUseOverrideForEndEffectors

(

bool

Value

)

If true, uses MinEffectorDiff as the threshold for end effectors.

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

AllowedRotationFormats

TArray<AnimationCompressionFormat> AllowedRotationFormats

Which encoding formats is the per-track compressor allowed to try on rotation keys.

AllowedScaleFormats

TArray<AnimationCompressionFormat> AllowedScaleFormats

Which encoding formats is the per-track compressor allowed to try on scale keys.

AllowedTranslationFormats

TArray<AnimationCompressionFormat> AllowedTranslationFormats

Which encoding formats is the per-track compressor allowed to try on translation keys.

MaxAngleDiffBitwise

float32 MaxAngleDiffBitwise

Maximum angle difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

MaxErrorPerTrackRatio

float32 MaxErrorPerTrackRatio

A fraction that determines how much of the total error budget can be introduced by any particular track.

MaxPosDiffBitwise

float32 MaxPosDiffBitwise

Maximum position difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

MaxScaleDiffBitwise

float32 MaxScaleDiffBitwise

Maximum position difference to use when testing if an animation key may be removed. Lower values retain more keys, but yield less compression.

MaxZeroingThreshold

float32 MaxZeroingThreshold

Maximum threshold to use when replacing a component with zero. Lower values retain more keys, but yield less compression.

MinKeysForResampling

int MinKeysForResampling

Animations with fewer keys than MinKeysForResampling will not be resampled.

ParentingDivisor

float32 ParentingDivisor

Reduces the error tolerance the further up the tree that a key occurs EffectiveErrorTolerance = Max(BaseErrorTolerance / Power(ParentingDivisor, Max(Height+Bias,0) * ParentingDivisorExponent), ZeroingThreshold) Only has an effect bUseAdaptiveError is true.

ParentingDivisorExponent

float32 ParentingDivisorExponent

Reduces the error tolerance the further up the tree that a key occurs EffectiveErrorTolerance = Max(BaseErrorTolerance / Power(ParentingDivisor, Max(Height+Bias,0) * ParentingDivisorExponent), ZeroingThreshold) Only has an effect bUseAdaptiveError is true.

ResampledFramerate

float32 ResampledFramerate

When bResampleAnimation is true, this defines the desired framerate.

RotationErrorSourceRatio

float32 RotationErrorSourceRatio

This ratio determines how much error in end effector rotation can come from a given track's rotation error or translation error. If 1, all of it must come from rotation error, if 0.5, half can come from each, and if 0.0, all must come from translation error.

ScaleErrorSourceRatio

float32 ScaleErrorSourceRatio

This ratio determines how much error in end effector scale can come from a given track's rotation error or scale error. If 1, all of it must come from rotation error, if 0.5, half can come from each, and if 0.0, all must come from scale error.

TrackHeightBias

int TrackHeightBias

A bias added to the track height before using it to calculate the adaptive error.

TranslationErrorSourceRatio

float32 TranslationErrorSourceRatio

This ratio determines how much error in end effector translation can come from a given track's rotation error or translation error. If 1, all of it must come from rotation error, if 0.5, half can come from each, and if 0.0, all must come from translation error.