1. Epic GamesDeveloper
  3. UAnimPoseExtensions

UAnimPoseExtensions

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

API > API/Editor > API/Editor/AnimationBlueprintLibrary

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

  Type Name Description
Public function Static void

EvaluateAnimationBlueprintWithInputPose ( const FAnimPose& InputPose,
USkeletalMesh* TargetSkeletalMesh,
UAnimBlueprint* AnimationBlueprint,
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* AnimationSequenceBase,
int32 FrameIndex,
FAnimPoseEvaluationOptions EvaluationOptions,
FAnimPose& Pose
)

 Evaluates an Animation Sequence Base to generate a valid Anim Pose instance
Public function Static void

GetAnimPoseAtTime ( const UAnimSequenceBase* AnimationSequenceBase,
double Time,
FAnimPoseEvaluationOptions EvaluationOptions,
FAnimPose& Pose
)

 Evaluates an Animation Sequence Base to generate a valid Anim Pose instance
Public function Static void

GetAnimPoseAtTimeIntervals ( const UAnimSequenceBase* AnimationSequenceBase,
TArray< double > TimeIntervals,
FAnimPoseEvaluationOptions EvaluationOptions,
TArray< FAnimPose >& InOutPoses
)

 Evaluates an Animation Sequence Base at different time intervals to generate a valid Anim Pose instances
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 FTransform &

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

 Retrieves the transform for the provided bone name from a pose
Public function Static void

GetCurveNames ( const FAnimPose& Pose,
TArray< FName >& Curves
)

 Returns an array of curve names contained by the pose
Public function Static float

GetCurveWeight ( const FAnimPose& Pose,
const FName& CurveName
)

 Returns the weight of an evaluated curve - if found
Public function Static const FTransform &

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 void

GetSocketNames ( const FAnimPose& Pose,
TArray< FName >& Sockets
)

 Returns an array of socket names contained by the pose
Public function Static FTransform

GetSocketPose ( const FAnimPose& Pose,
FName SocketName,
EAnimPoseSpaces Space
)

 Retrieves the transform for the provided socket name from a pose
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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page