1. Epic GamesDeveloper
  3. FAnimationUtils

FAnimationUtils

A collection of useful functions for skeletal mesh animation.

Unreal Engine C++ API Reference > Runtime > Engine

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

  Type Name Description
Public function Static void

BuildComponentSpaceTransform ( FTransform& OutTransform,
int32 BoneIndex,
const TArray< FTransform >& BoneSpaceTransforms,
const TArray< FBoneData >& BoneData
)

 Builds the local-to-component matrix for the specified bone.
Public function Static 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.
Public function Static void

CalculateTrackHeights ( const FCompressibleAnimData& CompressibleAnimData,
int NumTracks,
TArray< int32 >& TrackHeights
)

 Computes the 'height' of each track, relative to a given animation linkup.
Public function Static bool Compresses the animation bones within a sequence with the chosen settings.
Public function Static bool Compresses the animation curves within a sequence with the chosen settings.
Public function Static void

ComputeCompressionError ( const FCompressibleAnimData& CompressibleAnimData,
FCompressibleAnimDataResult& CompressedData,
AnimationErrorStats& ErrorStats
)

 Utility function to measure the accuracy of a compressed animation.
Public function Static void Makes sure that the animation sequence and all its dependencies required for compression are loaded.
Public function Static void

ExtractTransformForFrameFromTrack ( const FRawAnimSequenceTrack& RawTrack,
int32 Frame,
FTransform& OutAtom
)

 Extract specific frame from raw track and place in OutAtom.
Public function Static void

ExtractTransformForFrameFromTrackSafe ( const FRawAnimSequenceTrack& RawTrack,
int32 Frame,
FTransform& OutAtom
)

 Extract specific frame from raw track and place in OutAtom (return identity if track is malformed)
Public function Static void

ExtractTransformFromCompressionData ( const FCompressibleAnimData& CompressibleAnimData,
FCompressibleAnimDataResult& CompressedAnimData,
double Time,
int32 TrackIndex,
bool bUseRawData,
FTransform& OutBoneTransform
)

  
Public function Static void

ExtractTransformFromTrack ( const FRawAnimSequenceTrack& RawTrack,
double Time,
int32 NumFrames,
double SequenceLength,
EAnimInterpolationType Interpolation,
FTransform& OutAtom
)

  
Public function Static FString

GetAnimationCompressionFormatString ( enum AnimationCompressionFormat InFormat
)

 Converts an animation compression type into a human readable string
Public function Static FString

GetAnimationKeyFormatString ( enum AnimationKeyFormat InFormat
)

 Converts an animation codec format into a human readable string
Public function Static int32

GetAnimTrackIndexForSkeletonBone ( const int32 InSkeletonBoneIndex,
const TArray< FTrackToSkeletonMap >& TrackToSkelMap
)

  
Public function Static UAnimBoneCompressionSettings * Returns the default animation bone compression settings, can never by null.
Public function Static UAnimCurveCompressionSettings * Returns the default animation curve compression settings, can never by null.
Public function Static UAnimBoneCompressionSettings * Returns the default animation bone compression settings for the FAnimRecorder, can never by null.
Public function Static UObject *

GetDefaultAnimSequenceOuter ( UAnimSet* InAnimSet,
bool bCreateIfNotFound
)

 Get default Outer for AnimSequences contained in this AnimSet.
Public function Static UVariableFrameStrippingSettings * Returns the default animation variable frame stripping settings, can never by null.
Public function Static bool Determines the current setting for recompressing all animations upon load.
Public function Static bool

HasUniformKeySpacing ( int32 NumFrames,
const TArray< float >& Times
)

 Checks a set of key times to see if the spacing is uniform or non-uniform.
Public function Static void Preload the bone, curve and recorder compression settings
Public function Static void

TallyErrorsFromPerturbation ( const FCompressibleAnimData& CompressibleAnimData,
int32 NumTracks,
const FVector& PositionNudge,
const FQuat& RotationNudge,
const FVector& ScaleNudge,
TArray< FAnimPerturbationError >& InducedErrors
)

 Perturbs the bone(s) associated with each track in turn, measuring the maximum error introduced in end effectors as a result

Deprecated Functions

  Type Name Description
Public function Static void

ExtractTransformFromCompressionData ( const FCompressibleAnimData& CompressibleAnimData,
FCompressibleAnimDataResult& CompressedAnimData,
float Time,
int32 TrackIndex,
bool bUseRawData,
FTransform& OutBoneTransform
)

 ExtractTransformFromCompressionData has been deprecated, use different signature
Public function Static void

ExtractTransformFromTrack ( float Time,
int32 NumFrames,
float SequenceLength,
const FRawAnimSequenceTrack& RawTrack,
EAnimInterpolationType Interpolation,
FTransform& OutAtom
)

 ExtractTransformFromTrack has been deprecated, use different signature

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page