1. Epic GamesDeveloper
  3. FAnimationRuntime

FAnimationRuntime

In AnimationRunTime Library, we extract animation data based on Skeleton hierarchy, not ref pose hierarchy.

API > API/Runtime > API/Runtime/Engine

References

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

Syntax

class FAnimationRuntime

Remarks

In AnimationRunTime Library, we extract animation data based on Skeleton hierarchy, not ref pose hierarchy. Ref pose will need to be re-mapped later

Functions

  Type Name Description
Public function Static void

AccumulateAdditivePose ( FAnimationPoseData& BaseAnimationPoseData,
const FAnimationPoseData& AdditiveAnimationPoseData,
float Weight,
enum EAdditiveAnimationType AdditiveType
)

  
Public function Static void

AccumulateLocalSpaceAdditivePose ( FAnimationPoseData& BaseAnimationPoseData,
const FAnimationPoseData& AdditiveAnimationPoseData,
float Weight
)

  
Public function Static void

AccumulateMeshSpaceRotationAdditiveToLocalPose ( FAnimationPoseData& BaseAnimationPoseData,
const FAnimationPoseData& MeshSpaceRotationAdditiveAnimationPoseData,
float Weight
)

  
Public function Static ETypeAdvanceAnim

AdvanceTime ( const bool& bAllowLooping,
const float& MoveDelta,
float& InOutTime,
const float& EndTime
)

 Advance CurrentTime to CurrentTime + MoveDelta.
Public function Static void

AppendActiveMorphTargets ( const USkeletalMesh* InSkeletalMesh,
const TMap< FName, float >& InMorphCurveAnims,
FMorphTargetWeightMap& InOutActiveMorphTargets,
TArray< float >& InOutMorphTargetWeights
)

 Combine CurveKeys (that reference morph targets by name) and ActiveAnims (that reference morphs by reference) into the ActiveMorphTargets array.
Public function Static void

ApplyWeightToTransform ( const FBoneContainer& RequiredBones,
FTransformArrayA2& Atoms,
float Weight
)

 Apply Weight to the Transform Atoms = Weight * Atoms at the end
Public function Static void

BlendPosesPerBoneFilter ( FCompactPose& BasePose,
const TArray< FCompactPose >& BlendPoses,
FBlendedCurve& BaseCurve,
const TArray< FBlendedCurve >& BlendCurves,
UE::Anim::FStackAttributeContainer& CustomAttributes,
const TArray< UE::Anim::FStackAttributeContainer >& BlendAttributes,
FAnimationPoseData& OutAnimationPoseData,
TArray< FPerBoneBlendWeight >& BoneBlendWeights,
EBlendPosesPerBoneFilterFlags blendFlags,
enum ECurveBlendOption::Type CurveBlendOption
)

  
Public function Static void

BlendPosesTogether ( TArrayView< const FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
TArrayView< const UE::Anim::FStackAttributeContainer > SourceAttributes,
TArrayView< const float > SourceWeights,
FAnimationPoseData& OutAnimationPoseData
)

  
Public function Static void

BlendPosesTogether ( TArrayView< const FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
TArrayView< const UE::Anim::FStackAttributeContainer > SourceAttributes,
TArrayView< const float > SourceWeights,
TArrayView< const int32 > SourceWeightsIndices,
FAnimationPoseData& OutPoseData
)

  
Public function Static void

BlendPosesTogetherIndirect ( TArrayView< const FCompactPose*const > SourcePoses,
TArrayView< const FBlendedCurve*const > SourceCurves,
TArrayView< const UE::Anim::FStackAttributeContainer*const > SourceAttributes,
TArrayView< const float > SourceWeights,
FAnimationPoseData& OutPoseData
)

  
Public function Static void

BlendPosesTogetherPerBone ( TArrayView< const FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
TArrayView< const UE::Anim::FStackAttributeContainer > SourceAttributes,
const IInterpolationIndexProvider* InterpolationIndexProvider,
TArrayView< const FBlendSampleData > BlendSampleDataCache,
TArrayView< const int32 > BlendSampleDataCacheIndices,
FAnimationPoseData& OutAnimationPoseData
)

  
Public function Static void

BlendPosesTogetherPerBone ( TArrayView< const FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
TArrayView< const UE::Anim::FStackAttributeContainer > SourceAttributes,
const IInterpolationIndexProvider* InterpolationIndexProvider,
TArrayView< const FBlendSampleData > BlendSampleDataCache,
FAnimationPoseData& OutAnimationPoseData
)

  
Public function Static void

BlendPosesTogetherPerBoneInMeshSpace ( TArrayView< FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
TArrayView< const UE::Anim::FStackAttributeContainer > SourceAttributes,
const UBlendSpace* BlendSpace,
TArrayView< const FBlendSampleData > BlendSampleDataCache,
FAnimationPoseData& OutAnimationPoseData
)

 Blends together a set of local space (not mesh space) poses, each with a given weight.
Public function Static void

BlendTwoPosesTogether ( const FAnimationPoseData& SourcePoseOneData,
const FAnimationPoseData& SourcePoseTwoData,
const float WeightOfPoseOne,
FAnimationPoseData& OutAnimationPoseData
)

  
Public function Static void

BlendTwoPosesTogetherPerBone ( const FAnimationPoseData& SourcePoseOneData,
const FAnimationPoseData& SourcePoseTwoData,
const TArray< float >& WeightsOfSource2,
FAnimationPoseData& OutAnimationPoseData
)

  
Public function Static void

CombineWithAdditiveAnimations ( int32 NumAdditivePoses,
const FTransformArrayA2** SourceAdditivePoses,
const float* SourceAdditiveWeights,
const FBoneContainer& RequiredBones,
FTransformArrayA2& Atoms
)

  
Public function Static bool

ContainsNaN ( TArray< FBoneIndexType >& RequiredBoneIndices,
FA2Pose& Pose
)

  
Public function Static void

ConvertBoneSpaceTransformToCS ( const FTransform& ComponentTransform,
FCSPose< FCompactPose >& MeshBases,
FTransform& InOutBoneSpaceTM,
FCompactPoseBoneIndex BoneIndex,
EBoneControlSpace Space
)

 Convert a FTransform in a specified bone space to ComponentSpace.
Public function Static void

ConvertCSTransformToBoneSpace ( const FTransform& ComponentTransform,
FCSPose< FCompactPose >& MeshBases,
FTransform& InOutCSBoneTM,
FCompactPoseBoneIndex BoneIndex,
EBoneControlSpace Space
)

 Convert a ComponentSpace FTransform to specified bone space.
Public function Static void Convert a MeshSpaceRotation pose to Local Space. Rotations are NOT normalized.
Public function Static void

ConvertPoseToAdditive ( FCompactPose& TargetPose,
const FCompactPose& BasePose
)

 Convert TargetPose into an AdditivePose, by doing TargetPose = TargetPose - BasePose
Public function Static void Convert LocalPose into MeshSpaceRotations. Rotations are NOT normalized.
Public function Static void

ConvertPoseToMeshSpace ( const TArray< FTransform >& LocalTransforms,
TArray< FTransform >& MeshSpaceTransforms,
const FBoneContainer& RequiredBones
)

 Convert LocalTransforms into MeshSpaceTransforms over RequiredBones.
Public function Static void

ConvertTransformToAdditive ( FTransform& TargetTrasnform,
const FTransform& BaseTransform
)

 Convert transform to additive
Public function Static void

CreateMaskWeights ( TArray< FPerBoneBlendWeight >& BoneBlendWeights,
const TArray< FInputBlendPose >& BlendFilters,
const USkeleton* Skeleton
)

 Create Mask Weight for skeleton joints, not per mesh or per required bones You'll have to filter properly with correct mesh joint or required bones The depth should not change based on LOD or mesh or skeleton They still should contain same depth
Public function Static void

CreateMaskWeights ( TArray< FPerBoneBlendWeight >& BoneBlendWeights,
const TArray< class UBlendProfile* >& BlendMasks,
const USkeleton* Skeleton
)

 Create Mask Weight for skeleton joints, not per mesh or per required bones Individual alphas are read from a BlendProfile using a BlendMask mode
Public function Static void

EnsureParentsPresent ( TArray< FBoneIndexType >& BoneIndices,
const FReferenceSkeleton& RefSkeleton
)

 Utility for taking an array of bone indices and ensuring that all parents are present (ie. all bones between those in the array and the root are present).
Public function Static void

ExcludeBonesWithNoParents ( const TArray< int32 >& BoneIndices,
const FReferenceSkeleton& RefSkeleton,
TArray< int32 >& FilteredRequiredBones
)

  
Public function Static void

FillUpComponentSpaceTransforms ( const FReferenceSkeleton& RefSkeleton,
const TArrayView< const FTransform >& BoneSpaceTransforms,
TArray< FTransform >& ComponentSpaceTransforms
)

  
Public function Static void

FillUpComponentSpaceTransformsRefPose ( const USkeleton* Skeleton,
TArray< FTransform >& ComponentSpaceTransforms
)

  
Public function Static void

FillUpComponentSpaceTransformsRetargetBasePose ( const USkeleton* Skeleton,
TArray< FTransform >& ComponentSpaceTransforms
)

  
Public function Static void

FillUpComponentSpaceTransformsRetargetBasePose ( const USkeletalMesh* Mesh,
TArray< FTransform >& ComponentSpaceTransforms
)

  
Public function Static void

FillWithRefPose ( TArray< FTransform >& OutAtoms,
const FBoneContainer& RequiredBones
)

 Fill ref pose
Public function Static void Fill with retarget base ref pose but this isn't used during run-time, so it always copies all of them
Public function Static FTransform

GetComponentSpaceRefPose ( const FCompactPoseBoneIndex& CompactPoseBoneIndex,
const FBoneContainer& BoneContainer
)

 Get Reference Component Space Transform
Public function Static FTransform

GetComponentSpaceTransform ( const FReferenceSkeleton& RefSkeleton,
const TArrayView< const FTransform >& BoneSpaceTransforms,
int32 BoneIndex
)

 Space bases
Public function Static FTransform

GetComponentSpaceTransformRefPose ( const FReferenceSkeleton& RefSkeleton,
int32 BoneIndex
)

 Space bases
Public function Static const FTransform &

GetComponentSpaceTransformWithCache ( const FReferenceSkeleton& InRefSkeleton,
const TArray< FTransform >& InBoneSpaceTransforms,
int32 BoneIndex,
TArray< FTransform >& CachedTransforms,
TArray< bool >& CachedTransformReady
)

 Calculate the component-space bone transform for the specified bone.
Public function Static void

GetKeyIndicesFromTime ( int32& OutKeyIndex1,
int32& OutKeyIndex2,
float& OutAlpha,
const double Time,
const int32 NumKeys,
const double SequenceLength,
double FramesPerSecond
)

 Get Key Indices (start/end with alpha from start) with input parameter Time, NumKeys from % from StartKeyIndex, meaning (CurrentKeyIndex(float)-StartKeyIndex)/(EndKeyIndex-StartKeyIndex) by this Start-End, it will be between 0-(NumKeys-1), not number of Pos/Rot key tracks The FramesPerSecond parameter must be the sample rate of the animation data, for example 30.
Public function Static void

GetKeyIndicesFromTime ( int32& OutKeyIndex1,
int32& OutKeyIndex2,
float& OutAlpha,
const double Time,
const FFrameRate& FrameRate,
const int32 NumberOfKeys
)

 Get KeyIndices using FFrameRate::AsFrameTime to calculate the keys and alpha value
Public function Static FTransform

GetSpaceTransform ( FA2CSPose& Pose,
int32 Index
)

 FA2Pose/FA2CSPose Interfaces for template functions.
Public function Static FTransform

GetSpaceTransform ( FA2Pose& Pose,
int32 Index
)

 FA2Pose/FA2CSPose Interfaces for template functions.
Public function Static int32

GetStringDistance ( const FString& First,
const FString& Second
)

 Calculate distance how close two strings are.
Public function Static bool

HasWeight ( float Weight
)

  
Public function Static void

InitializeTransform ( const FBoneContainer& RequiredBones,
FTransformArrayA2& Atoms
)

  
Public function Static bool

IsFullWeight ( float Weight
)

 Weight utility functions
Public function Static void

LerpBoneTransforms ( TArray< FTransform >& A,
const TArray< FTransform >& B,
float Alpha,
const TArray< FBoneIndexType >& RequiredBonesArray
)

 Lerp for BoneTransforms. Stores results in A. Performs A = Lerp(A, B, Alpha);
Public function Static void

LerpPoses ( FCompactPose& PoseA,
const FCompactPose& PoseB,
FBlendedCurve& CurveA,
const FBlendedCurve& CurveB,
float Alpha
)

 Lerp for FCompactPose.
Public function Static void

LerpPosesPerBone ( FCompactPose& PoseA,
const FCompactPose& PoseB,
FBlendedCurve& CurveA,
const FBlendedCurve& CurveB,
float Alpha,
const TArray< float >& PerBoneWeights
)

 Lerp for FCompactPose.
Public function Static void

LerpPosesWithBoneIndexList ( FCompactPose& PoseA,
const FCompactPose& PoseB,
FBlendedCurve& CurveA,
const FBlendedCurve& CurveB,
float Alpha,
const TArray< FCompactPoseBoneIndex >& BoneIndices
)

 Lerp for FCompactPose.
Public function Static void

MakeSkeletonRefPoseFromMesh ( const USkeletalMesh* InMesh,
const USkeleton* InSkeleton,
TArray< FTransform >& OutBoneBuffer
)

  
Public function Static void

MirrorCurves ( FBlendedCurve& Curves,
const UMirrorDataTable& MirrorDataTable
)

 Mirror (swap) curves with the specified MirrorDataTable.
Public function Static void

MirrorPose ( FCompactPose& Pose,
const UMirrorDataTable& MirrorDataTable
)

 Mirror a pose with the specified MirrorDataTable.
Public function Static void

MirrorPose ( FCompactPose& Pose,
EAxis::Type MirrorAxis,
const TArray< FCompactPoseBoneIndex >& CompactPoseMirrorBones,
const TCustomBoneIndexArray< FQuat, FCompactPoseBoneIndex >& ComponentSpaceRefRotations
)

 Mirror Pose using cached mirror bones and components space arrays.
Public function Static FQuat

MirrorQuat ( const FQuat& Q,
EAxis::Type MirrorAxis
)

 Mirror a quaternion across the specified mirror axis
Public function Static FVector

MirrorVector ( const FVector& V,
EAxis::Type MirrorAxis
)

 Mirror a vector across the specified mirror axis
Public function Static void

NormalizeRotations ( FTransformArrayA2& Atoms
)

  
Public function Static void

NormalizeRotations ( const FBoneContainer& RequiredBones,
FTransformArrayA2& Atoms
)

  
Public function Static void

RetargetBoneTransform ( const USkeleton* SourceSkeleton,
const FName& RetargetSource,
FTransform& BoneTransform,
const int32 SkeletonBoneIndex,
const FCompactPoseBoneIndex& BoneIndex,
const FBoneContainer& RequiredBones,
const bool bIsBakedAdditive
)

 Retarget a single bone transform, to apply right after extraction.
Public function Static void

RetargetBoneTransform ( const USkeleton* MySkeleton,
const FName& SourceName,
const TArray< FTransform >& RetargetTransforms,
FTransform& BoneTransform,
const int32 SkeletonBoneIndex,
const FCompactPoseBoneIndex& BoneIndex,
const FBoneContainer& RequiredBones,
const bool bIsBakedAdditive
)

 Retarget a single bone transform, to apply right after extraction.
Public function Static void

SetSpaceTransform ( FA2Pose& Pose,
int32 Index,
FTransform& NewTransform
)

  
Public function Static void

SetSpaceTransform ( FA2CSPose& Pose,
int32 Index,
FTransform& NewTransform
)

  
Public function Static void

TickBlendWeight ( float DeltaTime,
float DesiredWeight,
float& Weight,
float& BlendTime
)

  
Public function Static void

UpdateDesiredBoneWeight ( const TArray< FPerBoneBlendWeight >& SrcBoneBlendWeights,
TArray< FPerBoneBlendWeight >& TargetBoneBlendWeights,
const TArray< float >& BlendWeights
)

  

Enums

  Type Name Description
Public enum EBlendPosesPerBoneFilterFlags Blending flags for BlendPosesPerBoneFilter  

Deprecated Functions

  Type Name Description
Public function Static void

AccumulateAdditivePose ( FCompactPose& BasePose,
const FCompactPose& AdditivePose,
FBlendedCurve& BaseCurve,
const FBlendedCurve& AdditiveCurve,
float Weight,
enum EAdditiveAnimationType AdditiveType
)

 Use AccumulateAdditivePose with other signature
Public function Static void

AccumulateLocalSpaceAdditivePose ( FCompactPose& BasePose,
const FCompactPose& AdditivePose,
FBlendedCurve& BaseCurve,
const FBlendedCurve& AdditiveCurve,
float Weight
)

 Use AccumulateAdditivePose with other signature
Public function Static void

AccumulateMeshSpaceRotationAdditiveToLocalPose ( FCompactPose& BasePose,
const FCompactPose& MeshSpaceRotationAdditive,
FBlendedCurve& BaseCurve,
const FBlendedCurve& AdditiveCurve,
float Weight
)

 Use AccumulateAdditivePose with other signature
Public function Static void

BlendPosesPerBoneFilter ( FCompactPose& BasePose,
const TArray< FCompactPose >& BlendPoses,
FBlendedCurve& BaseCurve,
const TArray< FBlendedCurve >& BlendCurves,
FCompactPose& OutPose,
FBlendedCurve& OutCurve,
TArray< FPerBoneBlendWeight >& BoneBlendWeights,
EBlendPosesPerBoneFilterFlags blendFlags,
enum ECurveBlendOption::Type CurveBlendOption
)

 Please use the BlendPosesPerBoneFilterwith different signature.
Public function Static void

BlendPosesTogether ( TArrayView< const FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
TArrayView< const float > SourceWeights,
FCompactPose& ResultPose,
FBlendedCurve& ResultCurve
)

 Use BlendPosesTogether with other signature
Public function Static void

BlendPosesTogether ( TArrayView< const FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
TArrayView< const float > SourceWeights,
TArrayView< const int32 > SourceWeightsIndices,
FCompactPose& ResultPose,
FBlendedCurve& ResultCurve
)

 Use BlendPosesTogether with other signature
Public function Static void

BlendPosesTogetherIndirect ( TArrayView< const FCompactPose*const > SourcePoses,
TArrayView< const FBlendedCurve*const > SourceCurves,
TArrayView< const float > SourceWeights,
FCompactPose& ResultPose,
FBlendedCurve& ResultCurve
)

 Use BlendPosesTogetherIndirect with other signature
Public function Static void

BlendPosesTogetherPerBone ( TArrayView< const FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
const IInterpolationIndexProvider* InterpolationIndexProvider,
TArrayView< const FBlendSampleData > BlendSampleDataCache,
FCompactPose& ResultPose,
FBlendedCurve& ResultCurve
)

 Use BlendPosesTogetherPerBone with other signature
Public function Static void

BlendPosesTogetherPerBone ( TArrayView< const FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
const IInterpolationIndexProvider* InterpolationIndexProvider,
TArrayView< const FBlendSampleData > BlendSampleDataCache,
TArrayView< const int32 > BlendSampleDataCacheIndices,
FCompactPose& ResultPose,
FBlendedCurve& ResultCurve
)

 Use BlendPosesTogetherPerBone with other signature
Public function Static void

BlendPosesTogetherPerBoneInMeshSpace ( TArrayView< FCompactPose > SourcePoses,
TArrayView< const FBlendedCurve > SourceCurves,
const UBlendSpace* BlendSpace,
TArrayView< const FBlendSampleData > BlendSampleDataCache,
FCompactPose& OutResultPose,
FBlendedCurve& OutResultCurve
)

 Use BlendPosesTogetherPerBone with other signature
Public function Static void

BlendTransformsByWeight ( FTransform& OutTransform,
const TArray< FTransform >& Transforms,
const TArray< float >& Weights
)

 Please use BlendTransform() for weighted blending
Public function Static void

BlendTwoPosesTogether ( const FCompactPose& SourcePose1,
const FCompactPose& SourcePose2,
const FBlendedCurve& SourceCurve1,
const FBlendedCurve& SourceCurve2,
const float WeightOfPose1,
FCompactPose& ResultPose,
FBlendedCurve& ResultCurve
)

 Use BlendTwoPosesTogether with other signature
Public function Static void

BlendTwoPosesTogetherPerBone ( const FCompactPose& SourcePose1,
const FCompactPose& SourcePose2,
const FBlendedCurve& SourceCurve1,
const FBlendedCurve& SourceCurve2,
const TArray< float >& WeightsOfSource2,
FCompactPose& ResultPose,
FBlendedCurve& ResultCurve
)

 Use BlendTwoPosesTogether with other signature

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page