Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UAnimCompress_PerTrackCompression

UAnimCompress_PerTrackCompression

Keyframe reduction algorithm that removes keys which are linear interpolations of surrounding keys, as well as choosing the best bitwise compression for each track independently.

API > API/Runtime > API/Runtime/Engine

Keyframe reduction algorithm that removes keys which are linear interpolations of surrounding keys, as well as choosing the best bitwise compression for each track independently.

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

Syntax

UCLASS (HideCategories=AnimCompress)  
class UAnimCompress_PerTrackCompression : public UAnimCompress_RemoveLinearKeys

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAnimCompress_PerTrackCompression ( const FObjectInitializer& ObjectInitializer
)

   Animation/AnimCompress_PerTrackCompression.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllowedRotationFormats TArray< TEnumAsByte< enum AnimationCompressionFormat > > Which encoding formats is the per-track compressor allowed to try on rotation keys Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=PerTrack
AllowedScaleFormats TArray< TEnumAsByte< enum AnimationCompressionFormat > > Which encoding formats is the per-track compressor allowed to try on scale keys Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=PerTrack
  • Meta=(InvalidEnumValues="ACF_Fixed32NoW,ACF_Float32NoW")
AllowedTranslationFormats TArray< TEnumAsByte< enum AnimationCompressionFormat > > Which encoding formats is the per-track compressor allowed to try on translation keys Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=PerTrack
bResampleAnimation uint32 If true, resample the animation to ResampleFramerate frames per second Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=Resampling
bUseAdaptiveError uint32 If true, adjust the error thresholds based on the 'height' within the skeleton Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError
bUseAdaptiveError2 uint32 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. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError2
bUseOverrideForEndEffectors uint32 If true, uses MinEffectorDiff as the threshold for end effectors Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError
  • Meta=(editcondition="bUseAdaptiveError")
MaxAngleDiffBitwise float Maximum angle difference to use when testing if an animation key may be removed. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=PerTrack
MaxErrorPerTrackRatio float A fraction that determines how much of the total error budget can be introduced by any particular track Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError2
  • Meta=(ClampMin="0.0", ClampMax="1.0", editcondition="bUseAdaptiveError2")
MaxPosDiffBitwise float Maximum position difference to use when testing if an animation key may be removed. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=PerTrack
MaxScaleDiffBitwise float Maximum position difference to use when testing if an animation key may be removed. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=PerTrack
MaxZeroingThreshold float Maximum threshold to use when replacing a component with zero. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=PerTrack
MinKeysForResampling int32 Animations with fewer keys than MinKeysForResampling will not be resampled. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=Resampling
  • Meta=(editcondition="bResampleAnimation")
ParentingDivisor float 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 Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError
  • Meta=(ClampMin="1.0", editcondition="bUseAdaptiveError")
ParentingDivisorExponent float 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 Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError
  • Meta=(ClampMin="0.1", editcondition="bUseAdaptiveError")
PerturbationProbeSize float How big of a perturbation should be made when probing error propagation Animation/AnimCompress_PerTrackCompression.h  
ResampledFramerate float When bResampleAnimation is true, this defines the desired framerate Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=Resampling
  • Meta=(ClampMin="1.0", ClampMax="30.0", editcondition="bResampleAnimation")
RotationErrorSourceRatio float This ratio determines how much error in end effector rotation can come from a given track's rotation error or translation error. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError2
  • Meta=(ClampMin="0.0", ClampMax="1.0", editcondition="bUseAdaptiveError2")
ScaleErrorSourceRatio float This ratio determines how much error in end effector scale can come from a given track's rotation error or scale error. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError2
  • Meta=(ClampMin="0.0", ClampMax="1.0", editcondition="bUseAdaptiveError2")
TrackHeightBias int32 A bias added to the track height before using it to calculate the adaptive error Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError
  • Meta=(editcondition="bUseAdaptiveError")
TranslationErrorSourceRatio float This ratio determines how much error in end effector translation can come from a given track's rotation error or translation error. Animation/AnimCompress_PerTrackCompression.h
  • EditAnywhere
  • Category=AdaptiveError2
  • Meta=(ClampMin="0.0", ClampMax="1.0", editcondition="bUseAdaptiveError2")

Functions

Public

Overridden from UAnimBoneCompressionCodec

Name Remarks Include Path Unreal Specifiers

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

 Decompress a single bone. Animation/AnimCompress_PerTrackCompression.h  

Protected

Overridden from UAnimCompress_RemoveLinearKeys

Name Remarks Include Path Unreal Specifiers

virtual void CompressUsingUnderlyingCompressor ( const FCompressibleAnimData& CompressibleAnimData,
FCompressibleAnimDataResult& OutCompressedData,
const TArray< FTranslationTrack >& TranslationData,
const TArray< FRotationTrack >& RotationData,
const TArray< FScaleTrack >& ScaleData,
const bool bFinalPass
)

 Compresses the tracks passed in using the underlying compressor for this key removal codec Animation/AnimCompress_PerTrackCompression.h  

virtual void * FilterBeforeMainKeyRemoval ( const FCompressibleAnimData& CompressibleAnimData,
TArray< FTranslationTrack >& TranslationData,
TArray< FRotationTrack >& RotationData,
TArray< FScaleTrack >& ScaleData
)

 Pre-filters the tracks before running the main key removal algorithm Animation/AnimCompress_PerTrackCompression.h  

Overridden from UAnimCompress

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_PerTrackCompression.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_PerTrackCompression.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Animation/AnimCompress_PerTrackCompression.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page