1. Epic GamesDeveloper
  3. UContextualAnimUtilities

UContextualAnimUtilities

API > API/Plugins > API/Plugins/ContextualAnimation

   
Name UContextualAnimUtilities
Type class
Header File /Engine/Plugins/Experimental/Animation/ContextualAnimation/Source/ContextualAnimation/Public/ContextualAnimUtilities.h
Include Path #include "ContextualAnimUtilities.h"

Syntax

UCLASS (MinimalAPI)  
class UContextualAnimUtilities : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
FDrawLineFunction TFunctionRef< void(const FVector &LineStart, const FVector &LineEnd, const FColor &Color, float LifeTime, float Thickness)>   ContextualAnimUtilities.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool BP_CreateContextualAnimSceneBindings ( const UContextualAnimSceneAsset* SceneAsset,
const TMap< FName, FContextualAnimSceneBindingContext >& Params,
FContextualAnimSceneBindings& OutBindings
)

   ContextualAnimUtilities.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Asset"
  • Meta=(DisplayName="Create Contextual Anim Scene Bindings")

static bool BP_CreateContextualAnimSceneBindingsForTwoActors ( const UContextualAnimSceneAsset* SceneAsset,
const FContextualAnimSceneBindingContext& Primary,
const FContextualAnimSceneBindingContext& Secondary,
FContextualAnimSceneBindings& OutBindings
)

   ContextualAnimUtilities.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Asset"
  • Meta=(DisplayName="Create Contextual Anim Scene Bindings For Two Actors")

static void BP_DrawDebugPose ( const UObject* WorldContextObject,
const UAnimSequenceBase* Animation,
float Time,
FTransform LocalToWorldTransform,
FLinearColor Color,
float LifeTime,
float Thickness
)

   ContextualAnimUtilities.h
  • BlueprintCallable
  • Category="Contextual Anim|Utilities"
  • Meta=(WorldContext="WorldContextObject", DisplayName="Draw Debug Pose")

static float BP_Montage_GetSectionLength ( const UAnimMontage* Montage,
int32 SectionIndex
)

   ContextualAnimUtilities.h
  • BlueprintCallable
  • Category="Contextual Anim|Utilities"
  • Meta=(DisplayName="GetSectionLength")

static void BP_Montage_GetSectionStartAndEndTime ( const UAnimMontage* Montage,
int32 SectionIndex,
float& OutStartTime,
float& OutEndTime
)

   ContextualAnimUtilities.h
  • BlueprintCallable
  • Category="Contextual Anim|Utilities"
  • Meta=(DisplayName="GetSectionStartAndEndTime")

static float BP_Montage_GetSectionTimeLeftFromPos ( const UAnimMontage* Montage,
float Position
)

   ContextualAnimUtilities.h
  • BlueprintCallable
  • Category="Contextual Anim|Utilities"
  • Meta=(DisplayName="GetSectionTimeLeftFromPos")

static AActor * BP_SceneBinding_GetActor ( const FContextualAnimSceneBinding& Binding
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding"
  • Meta=(DisplayName="Get Actor")

static const UAnimSequenceBase * BP_SceneBinding_GetAnimationFromBinding ( const FContextualAnimSceneBindings& Bindings,
const FContextualAnimSceneBinding& Binding
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Animation From Binding")

static FName BP_SceneBinding_GetRoleFromBinding ( const FContextualAnimSceneBindings& Bindings,
const FContextualAnimSceneBinding& Binding
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Role From Binding")

static USkeletalMeshComponent * BP_SceneBinding_GetSkeletalMesh ( const FContextualAnimSceneBinding& Binding
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding"
  • Meta=(DisplayName="Get Skeletal Mesh")

static AActor * BP_SceneBindingContext_GetActor ( const FContextualAnimSceneBindingContext& BindingContext
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Get Actor")

static void BP_SceneBindingContext_GetCurrentSectionAndAnimSetNames ( const FContextualAnimSceneBindingContext& BindingContext,
FName& SectionName,
FName& AnimSetName
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Get Current Section and Anim Set")

static const FGameplayTagContainer & BP_SceneBindingContext_GetGameplayTags ( const FContextualAnimSceneBindingContext& BindingContext
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Get GameplayTags")

static FTransform BP_SceneBindingContext_GetTransform ( const FContextualAnimSceneBindingContext& BindingContext
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Get Transform")

static FVector BP_SceneBindingContext_GetVelocity ( const FContextualAnimSceneBindingContext& BindingContext
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Get Velocity")

static bool BP_SceneBindingContext_HasAllMatchingGameplayTags ( const FContextualAnimSceneBindingContext& BindingContext,
const FGameplayTagContainer& TagContainer
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Has All Matching GameplayTags")

static bool BP_SceneBindingContext_HasAnyMatchingGameplayTags ( const FContextualAnimSceneBindingContext& BindingContext,
const FGameplayTagContainer& TagContainer
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Has Any Matching GameplayTags")

static bool BP_SceneBindingContext_HasMatchingGameplayTag ( const FContextualAnimSceneBindingContext& BindingContext,
const FGameplayTag& TagToCheck
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Has Matching GameplayTag")

static FContextualAnimSceneBindingContext BP_SceneBindingContext_MakeFromActor ( AActor* Actor
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(NativeMakeFunc, DisplayName="Make Contextual Anim Scene Binding Context")

static FContextualAnimSceneBindingContext BP_SceneBindingContext_MakeFromActorWithExternalTransform ( AActor* Actor,
FTransform ExternalTransform
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Binding Context"
  • Meta=(DisplayName="Make Contextual Anim Scene Binding Context With External Transform")

static void BP_SceneBindings_AddOrUpdateWarpTargetsForBindings ( const FContextualAnimSceneBindings& Bindings
)

   ContextualAnimUtilities.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Add Or Update Warp Targets For Bindings")

static void BP_SceneBindings_CalculateWarpPoints ( const FContextualAnimSceneBindings& Bindings,
TArray< FContextualAnimWarpPoint >& OutWarpPoints
)

   ContextualAnimUtilities.h
  • BlueprintCallable
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Calculate Warp Points For Bindings")

static FTransform BP_SceneBindings_GetAlignmentTransformForRoleRelativeToOtherRole ( const FContextualAnimSceneBindings& Bindings,
FName Role,
FName RelativeToRole,
float Time
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Alignment Transform For Role Relative To Other Role")

static FTransform BP_SceneBindings_GetAlignmentTransformForRoleRelativeToWarpPoint ( const FContextualAnimSceneBindings& Bindings,
FName Role,
const FContextualAnimWarpPoint& WarpPoint,
float Time
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Alignment Transform For Role Relative To Warp Point")

static FTransform BP_SceneBindings_GetAlignmentTransformFromBinding ( const FContextualAnimSceneBindings& Bindings,
const FContextualAnimSceneBinding& Binding,
const FContextualAnimWarpPoint& WarpPoint
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Alignment Transform From Binding")

static const FContextualAnimSceneBinding & BP_SceneBindings_GetBindingByActor ( const FContextualAnimSceneBindings& Bindings,
const AActor* Actor
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Binding By Actor")

static const FContextualAnimSceneBinding & BP_SceneBindings_GetBindingByRole ( const FContextualAnimSceneBindings& Bindings,
FName Role
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Binding By Role")

static const TArray< FContextualAnimSceneBinding > & BP_SceneBindings_GetBindings ( const FContextualAnimSceneBindings& Bindings
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Bindings")

static const FContextualAnimSceneBinding & BP_SceneBindings_GetPrimaryBinding ( const FContextualAnimSceneBindings& Bindings
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Primary Binding")

static const UContextualAnimSceneAsset * BP_SceneBindings_GetSceneAsset ( const FContextualAnimSceneBindings& Bindings
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Scene Asset")

static void BP_SceneBindings_GetSectionAndAnimSetIndices ( const FContextualAnimSceneBindings& Bindings,
int32& SectionIdx,
int32& AnimSetIdx
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Section And AnimSet Indices")

static void BP_SceneBindings_GetSectionAndAnimSetNames ( const FContextualAnimSceneBindings& Bindings,
FName& SectionName,
FName& AnimSetName
)

   ContextualAnimUtilities.h
  • BlueprintPure
  • Category="Contextual Anim|Scene Bindings"
  • Meta=(DisplayName="Get Section And AnimSet Names")

static void DrawDebugAnimSet ( const UWorld* World,
const UContextualAnimSceneAsset& SceneAsset,
const FContextualAnimSet& AnimSet,
float Time,
const FTransform& ToWorldTransform,
const FColor& Color,
float LifeTime,
float Thickness
)

   ContextualAnimUtilities.h  

static void DrawPose ( FPrimitiveDrawInterface* PDI,
const UAnimSequenceBase* Animation,
float Time,
FTransform LocalToWorldTransform,
FLinearColor Color,
float Thickness
)

   ContextualAnimUtilities.h  

static void DrawPose ( const UAnimSequenceBase* Animation,
float Time,
FTransform LocalToWorldTransform,
FLinearColor Color,
float LifeTime,
float Thickness,
FDrawLineFunction DrawFunction
)

   ContextualAnimUtilities.h  

static void DrawPose ( const UWorld* World,
const UAnimSequenceBase* Animation,
float Time,
FTransform LocalToWorldTransform,
FLinearColor Color,
float LifeTime,
float Thickness
)

   ContextualAnimUtilities.h  

static void DrawSector ( FPrimitiveDrawInterface& PDI,
const FVector& Origin,
const FVector& Direction,
float MinDistance,
float MaxDistance,
float MinAngle,
float MaxAngle,
const FLinearColor& Color,
uint8 DepthPriority,
float Thickness,
bool bDashedLine
)

   ContextualAnimUtilities.h  

static void ExtractComponentSpacePose ( const UAnimSequenceBase* Animation,
const FBoneContainer& BoneContainer,
float Time,
bool bExtractRootMotion,
FCSPose< FCompactPose >& OutPose
)

 Helper function to extract component space pose from an animation at a given time If the supplied animation is a montage it will extract the pose from the first track IMPORTANT: This function expects you to add a MemMark (FMemMark Mark(FMemStack::Get());) at the correct scope if you are using it from outside world's tick ContextualAnimUtilities.h  

static void ExtractLocalSpacePose ( const UAnimSequenceBase* Animation,
const FBoneContainer& BoneContainer,
float Time,
bool bExtractRootMotion,
FCompactPose& OutPose
)

 Helper function to extract local space pose from an animation at a given time. ContextualAnimUtilities.h  

static FTransform ExtractRootMotionFromAnimation ( const UAnimSequenceBase* Animation,
float StartTime,
float EndTime
)

 Extract Root Motion transform from a contiguous position range ContextualAnimUtilities.h  

static FTransform ExtractRootTransformFromAnimation ( const UAnimSequenceBase* Animation,
float Time
)

 Extract root bone transform at a given time ContextualAnimUtilities.h  

static const FAnimNotifyEvent * FindFirstWarpingWindowForWarpTarget ( const UAnimSequenceBase* Animation,
FName WarpTargetName
)

   ContextualAnimUtilities.h  

static FAnimMontageInstance * TryGetActiveAnimMontageInstance ( const AActor* Actor
)

   ContextualAnimUtilities.h  

static UAnimInstance * TryGetAnimInstance ( const AActor* Actor
)

   ContextualAnimUtilities.h  

static UMeshComponent * TryGetMeshComponentWithSocket ( const AActor* Actor,
FName SocketName
)

   ContextualAnimUtilities.h  

static USkeletalMeshComponent * TryGetSkeletalMeshComponent ( const AActor* Actor
)

   ContextualAnimUtilities.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page