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

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

   
Name UAnimPoseExtensions
Type class
Header File /Engine/Source/Editor/AnimationBlueprintLibrary/Public/AnimPose.h
Include Path #include "AnimPose.h"

Syntax

UCLASS (MinimalAPI)  
class UAnimPoseExtensions : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

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. AnimPose.h
  • BlueprintCallable
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

static void GetAnimPoseAtFrame ( const UAnimSequenceBase* AnimationSequenceBase,
int32 FrameIndex,
FAnimPoseEvaluationOptions EvaluationOptions,
FAnimPose& Pose
)

 Evaluates an Animation Sequence Base to generate a valid Anim Pose instance AnimPose.h
  • BlueprintCallable
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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

 Evaluates an Animation Sequence Base to generate a valid Anim Pose instance AnimPose.h
  • BlueprintCallable
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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

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

 Returns an array of bone names contained by the pose AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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

 Retrieves the transform for the provided bone name from a pose AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

static void GetCompactPose ( const FAnimPose& Pose,
FCompactPose& InOutCompactPose
)

 Returns a CompactPose from the given FAnimPose. AnimPose.h  

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

 Returns an array of curve names contained by the pose AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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

 Returns the weight of an evaluated curve - if found AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

static const FTransform & GetRefBonePose ( const FAnimPose& Pose,
FName BoneName,
EAnimPoseSpaces Space
)

 Retrieves the reference pose transform for the provided bone name AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

static void GetReferencePose ( USkeleton* Skeleton,
FAnimPose& OutPose
)

 Populates an Anim Pose with the reference poses stored for the provided USkeleton AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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 AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

static FTransform GetRelativeToRefPoseTransform ( const FAnimPose& Pose,
FName BoneName,
EAnimPoseSpaces Space
)

 Retrieves the relative transform between reference and animated bone transform AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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

 Retrieves the relative transform between the two provided bone names AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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

 Returns an array of socket names contained by the pose AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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

 Retrieves the transform for the provided socket name from a pose AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

static bool IsValid ( const FAnimPose& Pose
)

 Returns whether the Anim Pose contains valid data AnimPose.h
  • BlueprintPure
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

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

 Sets the transform for the provided bone name for a pose AnimPose.h
  • BlueprintCallable
  • Meta=(ScriptMethod)
  • Category="Animation|Pose"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page