1. Epic GamesDeveloper
  3. FAnimationUtils

FAnimationUtils

A collection of useful functions for skeletal mesh animation.

API > API/Runtime > API/Runtime/Engine

A collection of useful functions for skeletal mesh animation.

   
Name FAnimationUtils
Type class
Header File /Engine/Source/Runtime/Engine/Public/AnimationUtils.h
Include Path #include "AnimationUtils.h"

Syntax

class FAnimationUtils

Functions

Static

Name Remarks Include Path Unreal Specifiers

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

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

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

 Computes the 'height' of each track, relative to a given animation linkup. AnimationUtils.h  
Compresses the animation bones within a sequence with the chosen settings. AnimationUtils.h  
Compresses the animation curves within a sequence with the chosen settings. AnimationUtils.h  

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

 Utility function to measure the accuracy of a compressed animation. AnimationUtils.h  

static void EnsureAnimSequenceLoaded ( UAnimSequence& AnimSeq
)

 Makes sure that the animation sequence and all its dependencies required for compression are loaded. AnimationUtils.h  

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

 Extract specific frame from raw track and place in OutAtom. AnimationUtils.h  

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) AnimationUtils.h  

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

   AnimationUtils.h  

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

   AnimationUtils.h  

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

   AnimationUtils.h  

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

   AnimationUtils.h  

static FString GetAnimationCompressionFormatString ( enum AnimationCompressionFormat InFormat
)

 Converts an animation compression type into a human readable string AnimationUtils.h  

static FString GetAnimationKeyFormatString ( enum AnimationKeyFormat InFormat
)

 Converts an animation codec format into a human readable string AnimationUtils.h  

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

   AnimationUtils.h  

static UAnimBoneCompressionSettings * GetDefaultAnimationBoneCompressionSettings()

 Returns the default animation bone compression settings, can never by null. AnimationUtils.h  

static UAnimCurveCompressionSettings * GetDefaultAnimationCurveCompressionSettings()

 Returns the default animation curve compression settings, can never by null. AnimationUtils.h  

static UAnimBoneCompressionSettings * GetDefaultAnimationRecorderBoneCompressionSettings()

 Returns the default animation bone compression settings for the FAnimRecorder, can never by null. AnimationUtils.h  

static UObject * GetDefaultAnimSequenceOuter ( UAnimSet* InAnimSet,
bool bCreateIfNotFound
)

 Get default Outer for AnimSequences contained in this AnimSet. AnimationUtils.h  

static UVariableFrameStrippingSettings * GetDefaultVariableFrameStrippingSettings()

 Returns the default animation variable frame stripping settings, can never by null. AnimationUtils.h  
Determines the current setting for recompressing all animations upon load. AnimationUtils.h  

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

static void PreloadCompressionSettings()

 Preload the bone, curve and recorder compression settings AnimationUtils.h  

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page