Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FAnimationUtils

Light Theme

Dark Theme

FAnimationUtils

A collection of useful functions for skeletal mesh animation.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/AnimationUtils.h
Include	#include "AnimationUtils.h"

Syntax

class FAnimationUtils

Remarks

A collection of useful functions for skeletal mesh animation.

Functions

	Name	Description
void	BuildComponentSpaceTransform ( FTransform& OutTransform, int32 BoneIndex, const TArray< FTransform >& BoneSp..., const TArray< FBoneData >& BoneDat... )	Builds the local-to-component matrix for the specified bone.
void	BuildSkeletonMetaData ( USkeleton* Skeleton, TArray< FBoneData >& OutBoneData )	Array to keep track of SkeletalMeshes we have built metadata for, and log out the results just once.
void	CalculateTrackHeights ( const FCompressibleAnimData& Compr..., int NumTracks, TArray< int32 >& TrackHeights )	Computes the 'height' of each track, relative to a given animation linkup.
bool	CompressAnimBones ( FCompressibleAnimData& AnimSeq, FCompressibleAnimDataResult& Targe... )	Compresses the animation bones within a sequence with the chosen settings.
bool	CompressAnimCurves ( FCompressibleAnimData& AnimSeq, FCompressedAnimSequence& Target )	Compresses the animation curves within a sequence with the chosen settings.
void	ComputeCompressionError ( const FCompressibleAnimData& Compr..., FCompressibleAnimDataResult& Compr..., AnimationErrorStats& ErrorStats )	Utility function to measure the accuracy of a compressed animation.
void	EnsureAnimSequenceLoaded ( UAnimSequence& AnimSeq )	Makes sure that the animation sequence and all its dependencies required for compression are loaded.
void	ExtractTransformForFrameFromTrack ( const FRawAnimSequenceTrack& RawTr..., int32 Frame, FTransform& OutAtom )	Extract specific frame from raw track and place in OutAtom.
void	ExtractTransformForFrameFromTrackSafe ( const FRawAnimSequenceTrack& RawTr..., int32 Frame, FTransform& OutAtom )	Extract specific frame from raw track and place in OutAtom (return identity if track is malformed)
void	ExtractTransformFromCompressionData ( const FCompressibleAnimData& Compr..., FCompressibleAnimDataResult& Compr..., float Time, int32 TrackIndex, bool bUseRawData, FTransform& OutBoneTransform )
void	ExtractTransformFromTrack ( float Time, int32 NumFrames, float SequenceLength, const FRawAnimSequenceTrack& RawTr..., EAnimInterpolationType Interpolatio..., FTransform& OutAtom )
FString	GetAnimationCompressionFormatString ( enum AnimationCompressionFormat InF... )	Converts an animation compression type into a human readable string
FString	GetAnimationKeyFormatString ( enum AnimationKeyFormat InFormat )	Converts an animation codec format into a human readable string
int32	GetAnimTrackIndexForSkeletonBone ( const int32 InSkeletonBoneIndex, const TArray< FTrackToSkeletonMap >... )
UAnimBoneCom...	GetDefaultAnimationBoneCompressionSettings()	Returns the default animation bone compression settings, can never by null.
UAnimCurveCo...	GetDefaultAnimationCurveCompressionSettings()	Returns the default animation curve compression settings, can never by null.
UAnimBoneCom...	GetDefaultAnimationRecorderBoneCompressionSettings()	Returns the default animation bone compression settings for the FAnimRecorder, can never by null.
UObject *...	GetDefaultAnimSequenceOuter ( UAnimSet* InAnimSet, bool bCreateIfNotFound )	Get default Outer for AnimSequences contained in this AnimSet.
bool	GetForcedRecompressionSetting()	Determines the current setting for recompressing all animations upon load.
bool	HasUniformKeySpacing ( int32 NumFrames, const TArray< float >& Times )	Checks a set of key times to see if the spacing is uniform or non-uniform.
void	TallyErrorsFromPerturbation ( const FCompressibleAnimData& Compr..., int32 NumTracks, const FVector& PositionNudge, const FQuat& RotationNudge, const FVector& ScaleNudge, TArray< FAnimPerturbationError >& ... )	Perturbs the bone(s) associated with each track in turn, measuring the maximum error introduced in end effectors as a result

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss