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

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

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

Syntax

class FAnimationRuntime

Enums

Public

Name Remarks
EBlendPosesPerBoneFilterFlags Blending flags for BlendPosesPerBoneFilter

Functions

Static

Name Remarks Include Path Unreal Specifiers

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

   AnimationRuntime.h  

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

 Accumulate Additive Pose based on AdditiveType AnimationRuntime.h  

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

   AnimationRuntime.h  

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

 Accumulates weighted AdditivePose to BasePose. Rotations are NOT normalized. AnimationRuntime.h  

static void AccumulateLocalSpaceAdditivePoseInternal ( FCompactPose& BasePose,
const FCompactPose& AdditivePose,
float Weight
)

 Accumulates weighted AdditivePose to BasePose. Rotations are NOT normalized. AnimationRuntime.h  

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

 Accumulate a MeshSpaceRotation Additive pose to a local pose. Rotations are NOT normalized AnimationRuntime.h  

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

   AnimationRuntime.h  

static void AccumulateMeshSpaceRotationAdditiveToLocalPoseInternal ( FCompactPose& BasePose,
const FCompactPose& MeshSpaceRotationAdditive,
float Weight
)

 Accumulate a MeshSpaceRotation Additive pose to a local pose. Rotations are NOT normalized AnimationRuntime.h  

static void AccumulateRootSpaceAdditivePoseInternal ( FCompactPose& BasePose,
const FCompactPose& RootSpaceAdditivePose,
float Weight
)

 Accumulate a RootSpaceRotation Additive pose to a local pose. Rotations are NOT normalized AnimationRuntime.h  

static void AccumulateRootSpaceRotationAdditiveToLocalPose ( FAnimationPoseData& BaseAnimationPoseData,
const FAnimationPoseData& MeshSpaceRotationAdditiveAnimationPoseData,
float Weight
)

   AnimationRuntime.h  

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

 Advance CurrentTime to CurrentTime + MoveDelta. AnimationRuntime.h  

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

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

 Apply Weight to the Transform Atoms = Weight * Atoms at the end AnimationRuntime.h  

static void BlendPosesPerBoneFilter ( FCompactPose& BasePose,
const TConstArrayView< FCompactPose > BlendPoses,
FBlendedCurve& BaseCurve,
const TConstArrayView< FBlendedCurve > BlendedCurves,
UE::Anim::FStackAttributeContainer& BaseAttributes,
const TArrayView< UE::Anim::FStackAttributeContainer > BlendAttributes,
FAnimationPoseData& OutAnimationPoseData,
const TArrayView< FPerBoneBlendWeight > BoneBlendWeights,
EBlendPosesPerBoneFilterFlags BlendFlags,
enum ECurveBlendOption::Type CurveBlendOption
)

 Blend Poses per bone weights : The BasePoses + BlendPoses(SourceIndex) * Blend Weights(BoneIndex) Please note BlendWeights are array, so you can define per bone base This supports multi per bone blending, but only one pose as blend at a time per track PerBoneBlendWeights.Num() == Atoms.Num() AnimationRuntime.h  

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

   AnimationRuntime.h  

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

 Blends together a set of poses, each with a given weight. AnimationRuntime.h  

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

 Blends together a set of poses, each with a given weight. AnimationRuntime.h  

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
)

   AnimationRuntime.h  

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
)

   AnimationRuntime.h  

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

 Blends together a set of poses, each with a given weight. AnimationRuntime.h  

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

 Blends together a set of poses, each with a given weight. AnimationRuntime.h  

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
)

   AnimationRuntime.h  

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
)

 Blends together a set of poses, each with a given weight. AnimationRuntime.h  

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
)

   AnimationRuntime.h  

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

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

 Blends together a set of local space (not mesh space) poses, each with a given weight. AnimationRuntime.h  

static void BlendPosesTogetherPerBoneRemapped ( 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,
const FSkeletonRemapping& SkeletonRemapping,
FAnimationPoseData& OutAnimationPoseData
)

   AnimationRuntime.h  

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

 Blend Array of Transforms by weight AnimationRuntime.h  

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

   AnimationRuntime.h  

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

 Blends together two poses. AnimationRuntime.h  

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

   AnimationRuntime.h  

static void BlendTwoPosesTogetherPerBone ( const FCompactPose& SourcePoseOneData,
const FCompactPose& SourcePoseTwoData,
const TArray< float >& WeightsOfSource2,
FCompactPose& OutAnimationPoseData
)

   AnimationRuntime.h  

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

 Blends together a set of poses, each with a given weight. AnimationRuntime.h  

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

   AnimationRuntime.h  

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

   AnimationRuntime.h  

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

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

 Convert a ComponentSpace FTransform to specified bone space. AnimationRuntime.h  

static void ConvertMeshRotationPoseToLocalSpace ( FCompactPose& Pose
)

 Convert a MeshSpaceRotation pose to Local Space. Rotations are NOT normalized. AnimationRuntime.h  

static void ConvertPoseToAdditive ( FCompactPose& TargetPose,
const FCompactPose& BasePose
)

 Convert TargetPose into an AdditivePose, by doing TargetPose = TargetPose - BasePose AnimationRuntime.h  

static void ConvertPoseToMeshRotation ( FCompactPose& LocalPose
)

 Convert LocalPose into MeshSpaceRotations. Rotations are NOT normalized. AnimationRuntime.h  

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

 Convert LocalTransforms into MeshSpaceTransforms over RequiredBones. AnimationRuntime.h  

static void ConvertTransformToAdditive ( FTransform& TargetTrasnform,
const FTransform& BaseTransform
)

 Convert transform to additive AnimationRuntime.h  

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

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

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

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

   AnimationRuntime.h  

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

   AnimationRuntime.h  

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

   AnimationRuntime.h  

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

 Fill ref pose AnimationRuntime.h  

static EBoneTranslationRetargetingMode::Type GetBoneTranslationRetargetingMode ( const bool bUseSourceRetargetModes,
const int32 SourceSkeletonBoneIndex,
const int32 TargetSkeletonBoneIndex,
const USkeleton* SourceSkeleton,
const USkeleton* TargetSkeleton,
const bool bDisableRetargeting
)

 Get the translational retargeting mode for a given bone on the target skeleton when sampling a given source animation. AnimationRuntime.h  

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

 Get Reference Component Space Transform AnimationRuntime.h  

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

   AnimationRuntime.h  

static FTransform GetComponentSpaceTransformRefPose ( const FReferenceSkeleton& RefSkeleton,
int32 BoneIndex
)

 Space bases AnimationRuntime.h  

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

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

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

static FTransform GetSpaceTransform ( FA2CSPose& Pose,
int32 Index
)

   AnimationRuntime.h  

static FTransform GetSpaceTransform ( FA2Pose& Pose,
int32 Index
)

 FA2Pose/FA2CSPose Interfaces for template functions. AnimationRuntime.h  

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

 Calculate distance how close two strings are. AnimationRuntime.h  

static bool HasWeight ( float Weight
)

   AnimationRuntime.h  

static void InitializeTransform ( const FBoneContainer& RequiredBones,
FTransformArrayA2& Atoms
)

   AnimationRuntime.h  

static bool IsFullWeight ( float Weight
)

 Weight utility functions AnimationRuntime.h  

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

 Lerp for BoneTransforms. AnimationRuntime.h  

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

 Lerp for FCompactPose. AnimationRuntime.h  

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

 Lerp for FCompactPose. AnimationRuntime.h  

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

 Lerp for FCompactPose. AnimationRuntime.h  

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

   AnimationRuntime.h  

static void MirrorCurves ( FBlendedCurve& Curves,
const UMirrorDataTable& MirrorDataTable
)

 Mirror (swap) curves with the specified MirrorDataTable. AnimationRuntime.h  

static void MirrorPose ( FCompactPose& Pose,
const UMirrorDataTable& MirrorDataTable
)

 Mirror a pose with the specified MirrorDataTable. AnimationRuntime.h  

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

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

 Mirror a quaternion across the specified mirror axis AnimationRuntime.h  

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

 Mirror a vector across the specified mirror axis AnimationRuntime.h  

static void NormalizeRotations ( FTransformArrayA2& Atoms
)

   AnimationRuntime.h  

static void NormalizeRotations ( const FBoneContainer& RequiredBones,
FTransformArrayA2& Atoms
)

   AnimationRuntime.h  

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

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
)

   AnimationRuntime.h  

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

   AnimationRuntime.h  

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

   AnimationRuntime.h  

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

   AnimationRuntime.h  

static void UpdateDesiredBoneWeight ( const TArrayView< FPerBoneBlendWeight > SrcBoneBlendWeights,
TArrayView< FPerBoneBlendWeight > TargetBoneBlendWeights,
const TArrayView< float > BlendWeights
)

   AnimationRuntime.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page