UPoseSearchInteractionLibrary

Experimental, this feature might be removed without warning, not for production use.

API > API/Plugins > API/Plugins/PoseSearch

Experimental, this feature might be removed without warning, not for production use.

   
Name UPoseSearchInteractionLibrary
Type class
Header File /Engine/Plugins/Animation/PoseSearch/Source/Runtime/Public/PoseSearch/PoseSearchInteractionLibrary.h
Include Path #include "PoseSearch/PoseSearchInteractionLibrary.h"

Syntax

UCLASS (MinimalAPI, Experimental)  
class UPoseSearchInteractionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimContext const TArrayView< const FPoseSearchInteractionAvailability > const UObject *   PoseSearch/PoseSearchInteractionLibrary.h  
AnimContexts const UMultiAnimAsset float float bool const FVector const TConstArrayView< TObjectPtr< const UObject > >   PoseSearch/PoseSearchInteractionLibrary.h  
AssetTime const UMultiAnimAsset float float   PoseSearch/PoseSearchInteractionLibrary.h  
Availabilities const TArrayView< const FPoseSearchInteractionAvailability >   PoseSearch/PoseSearchInteractionLibrary.h  
bIsMirrored const UMultiAnimAsset float float bool   PoseSearch/PoseSearchInteractionLibrary.h  
bKeepInteractionAlive const TArrayView< const FPoseSearchInteractionAvailability > const UObjectFName const UE::PoseSearch::IPoseHistoryboolbool   PoseSearch/PoseSearchInteractionLibrary.h  
BlendParameters const UMultiAnimAsset float float bool const FVector &   PoseSearch/PoseSearchInteractionLibrary.h  
BlendTime const TArrayView< const FPoseSearchInteractionAvailability > const UObjectFName const UE::PoseSearch::IPoseHistoryboolbool float   PoseSearch/PoseSearchInteractionLibrary.h  
bValidateResultAgainstAvailabilities const TArrayView< const FPoseSearchInteractionAvailability > const UObjectFName const UE::PoseSearch::IPoseHistorybool   PoseSearch/PoseSearchInteractionLibrary.h  
DeltaTime const TArrayView< const FPoseSearchInteractionAvailability > const UObjectFName const UE::PoseSearch::IPoseHistoryboolbool float float   PoseSearch/PoseSearchInteractionLibrary.h  
DeltaTime const UMultiAnimAsset float   PoseSearch/PoseSearchInteractionLibrary.h  
MultiAnimAsset const UMultiAnimAsset *   PoseSearch/PoseSearchInteractionLibrary.h  
PoseHistory const TArrayView< const FPoseSearchInteractionAvailability > const UObjectFName const UE::PoseSearch::IPoseHistory *   PoseSearch/PoseSearchInteractionLibrary.h  
PoseHistoryName const TArrayView< const FPoseSearchInteractionAvailability > const UObjectFName   PoseSearch/PoseSearchInteractionLibrary.h  
Roles const UMultiAnimAsset float float bool const FVector const TConstArrayView< TObjectPtr< const UObject > > const TConstArrayView< UE::PoseSearch::FRole >   PoseSearch/PoseSearchInteractionLibrary.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UE_EXPERIMENTAL (

  1. 8,
    " Experimental,
    this feature might be removed without warning,
    not for production use"
    )
   PoseSearch/PoseSearchInteractionLibrary.h  

UE_EXPERIMENTAL (

  1. 8,
    " Experimental,
    this feature might be removed without warning,
    not for production use"
    )
   PoseSearch/PoseSearchInteractionLibrary.h  

UE_EXPERIMENTAL (

  1. 8,
    " Experimental,
    this feature might be removed without warning,
    not for production use"
    )
   PoseSearch/PoseSearchInteractionLibrary.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CalculateFullAlignedTransform ( const FPoseSearchBlueprintResult& CurrentResult,
float TimeOffset,
bool bWarpUsingRootBone,
FTransform& OutFullAlignedTransform
)

 This function calculates the mesh space transform for the AnimContext assigned the role CurrentResult.Role as CalculateFullAlignedTransforms does for all the AnimContext(s) PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintCallable
  • Category="Animation|Pose Search"
  • Meta=(BlueprintThreadSafe)

static void CalculateFullAlignedTransforms ( const FPoseSearchBlueprintResult& CurrentResult,
float TimeOffset,
bool bWarpUsingRootBone,
TArray< FTransform >& OutFullAlignedTransforms
)

 This function calculates the mesh space transforms (OutFullAlignedTransforms) the AnimContext(s) should reach within a time of TimeOffset to be consistently aligned to the selected UMultiAnimAsset (CurrentResult.SelectedAnim) at the selected time (CurrentResult.SelectedTime), given the interacting AnimContext(s) transforms (CurrentResult.ActorRootBoneTransforms, CurrentResult.ActorRootTransforms) if bWarpUsingRootBone is true the function will use the AnimContext root bone transforms, otherwise the mesh space transforms PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintCallable
  • Category="Animation|Pose Search"
  • Meta=(BlueprintThreadSafe)

static void CalculateNoAlignedTransform ( const FPoseSearchBlueprintResult& CurrentResult,
float TimeOffset,
bool bWarpUsingRootBone,
FTransform& OutNoAlignedTransform
)

 This function calculates the mesh space transform (OutNoAlignedTransform), or root bone transform if bWarpUsingRootBone is true, the AnimContext will reach within a time of TimeOffset, if it continues playing the CurrentResult.SelectedAnim from CurrentResult.SelectedTime forward PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintCallable
  • Category="Animation|Pose Search"
  • Meta=(BlueprintThreadSafe)

static void GetConstraint ( const TArray< FPoseSearchConstraint >& Constraints,
FName AnimContextRole,
FName SocketName,
float& OutDesiredReach,
FTransform& OutTransform,
bool& IsValid
)

   PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintPure
  • Category="Animation|Pose Search"
  • Meta=(BlueprintThreadSafe)

static FPoseSearchContinuingProperties GetMontageContinuingProperties ( UAnimInstance* AnimInstance
)

   PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintPure
  • Category="Animation|Pose Search"
  • Meta=(BlueprintThreadSafe)

static void GetMotionMatchInteractionConstraint ( const UObject* AnimContext,
FName SocketName,
float& OutDesiredReach,
FTransform& OutTransform,
bool& IsValid,
bool bCompareOwningActors
)

   PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintPure
  • Category="Animation|Pose Search"
  • Meta=(BlueprintThreadSafe)

static FPoseSearchBlueprintResult MotionMatchInteraction ( TArray< FPoseSearchInteractionAvailability > Availabilities,
const UObject* AnimContext,
FName PoseHistoryName,
bool bValidateResultAgainstAvailabilities
)

 BlueprintCallable version of MotionMatchInteraction_Pure. PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintCallable
  • Category="Animation|Pose Search"
  • Meta=(BlueprintThreadSafe)

static FPoseSearchBlueprintResult MotionMatchInteraction_Pure ( TArray< FPoseSearchInteractionAvailability > Availabilities,
const UObject* AnimContext,
FName PoseHistoryName,
bool bValidateResultAgainstAvailabilities
)

 Function publishing this character (via its AnimInstance) FPoseSearchInteractionAvailability to the UPoseSearchInteractionSubsystem, FPoseSearchInteractionAvailability represents the character availability to partecipate in an interaction with other characters for the next frame. PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintPure
  • Category="Animation|Pose Search"
  • Meta=(BlueprintThreadSafe)

static void MotionMatchMulti ( TArray< FPoseSearchMotionMatchMultiQuery > MotionMatchMultiQueries,
const FName PoseHistoryName,
const FPoseSearchContinuingProperties ContinuingProperties,
TArray< FPoseSearchBlueprintResult >& Results
)

 Function performing all the possible MotionMatching searches between the AnimContexts (eg AnimInstance(s)) defined in MotionMatchMultiQueries and compiled from the valid combination of the AnimContexts allowed Roles. PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintCallable
  • Category="Animation|Pose Search"
  • Meta=(AdvancedDisplay="ContinuingProperties, Future, EventToSearch")

static void UpdateConstraints ( UPARAM(ref) TArray< FPoseSearchConstraint >& InOutConstraints,
float DeltaTime,
const UMultiAnimAsset* MultiAnimAsset,
const TArray< UObject* > AnimContexts,
float SelectedTime,
bool bIsMirrored,
FVector BlendParameters
)

   PoseSearch/PoseSearchInteractionLibrary.h
  • Experimental
  • BlueprintCallable
  • Category="Animation|Pose Search"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page