UAnimPoseExtensions

Script exposed functionality for populating, retrieving data from and setting data on [FAnimPose](API\Editor\AnimationBlueprintLibrary\FAnimPose)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AnimationBlueprintLibrary

Header

/Engine/Source/Editor/AnimationBlueprintLibrary/Public/AnimPose.h

Include

#include "AnimPose.h"

Syntax

class UAnimPoseExtensions : public UBlueprintFunctionLibrary

Remarks

Script exposed functionality for populating, retrieving data from and setting data on FAnimPose

Functions

Name Description

Public function Static

void

 

EvaluateAnimationBlueprintWithInputPose

(
    const FAnimPose& InputPose,
    USkeletalMesh* TargetSkeletalM...,
    UAnimBlueprint* AnimationBluep...,
    FAnimPose& OutPose
)

Evaluates an Animation Blueprint instance, using the provided Anim Pose and its Input Pose value, generating a valid Anim Pose using the result.

Public function Static

void

 

GetAnimPoseAtFrame

(
    const UAnimSequenceBase* Anima...,
    int32 FrameIndex,
    FAnimPoseEvaluationOptions Evaluati...,
    FAnimPose& Pose
)

Evaluates an Animation Sequence Base to generate a valid Anim Pose instance

Public function Static

void

 

GetAnimPoseAtTime

(
    const UAnimSequenceBase* Anima...,
    float Time,
    FAnimPoseEvaluationOptions Evaluati...,
    FAnimPose& Pose
)

Evaluates an Animation Sequence Base to generate a valid Anim Pose instance

Public function Static

void

 

GetBoneNames

(
    const FAnimPose& Pose,
    TArray< FName >& Bones
)

Returns an array of bone names contained by the pose

Public function Static

const FTrans...

 

GetBonePose

(
    const FAnimPose& Pose,
    FName BoneName,
    EAnimPoseSpaces Space
)

Retrieves the transform for the provided bone name from a pose

Public function Static

const FTrans...

 

GetRefBonePose

(
    const FAnimPose& Pose,
    FName BoneName,
    EAnimPoseSpaces Space
)

Retrieves the reference pose transform for the provided bone name

Public function Static

void

 

GetReferencePose

(
    USkeleton* Skeleton,
    FAnimPose& OutPose
)

Populates an Anim Pose with the reference poses stored for the provided USkeleton

Public function Static

FTransform

 

GetRefPoseRelativeTransform

(
    const FAnimPose& Pose,
    FName FromBoneName,
    FName ToBoneName,
    EAnimPoseSpaces Space
)

Retrieves the relative transform for the reference pose between the two provided bone names

Public function Static

FTransform

 

GetRelativeToRefPoseTransform

(
    const FAnimPose& Pose,
    FName BoneName,
    EAnimPoseSpaces Space
)

Retrieves the relative transform between reference and animated bone transform

Public function Static

FTransform

 

GetRelativeTransform

(
    const FAnimPose& Pose,
    FName FromBoneName,
    FName ToBoneName,
    EAnimPoseSpaces Space
)

Retrieves the relative transform between the two provided bone names

Public function Static

bool

 

IsValid

(
    const FAnimPose& Pose
)

Returns whether the Anim Pose contains valid data

Public function Static

void

 

SetBonePose

(
    FAnimPose& Pose,
    FTransform Transform,
    FName BoneName,
    EAnimPoseSpaces Space
)

Sets the transform for the provided bone name for a pose