UPoseSearchTrajectoryLibrary

Set of functions to help populate a [FTransformTrajectory](API\Runtime\Engine\FTransformTrajectory) for motion matching.

API > API/Plugins > API/Plugins/PoseSearch

Set of functions to help populate a FTransformTrajectory for motion matching.

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

Syntax

UCLASS (MinimalAPI)  
class UPoseSearchTrajectoryLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActorsToIgnore const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > &   PoseSearch/PoseSearchTrajectoryLibrary.h  
ActorsToIgnore FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > &   PoseSearch/PoseSearchTrajectoryLibrary.h  
AnimInstance const UAnimInstance *   PoseSearch/PoseSearchTrajectoryLibrary.h  
bApplyGravity FVectorbool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bApplyGravity const UAnimInstancebool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bIgnoreSelf FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bIgnoreSelf const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bSimulateCharacterMovement const FAnimMontageInstanceFTransformTrajectory const FPoseSearchTrajectoryData const FPoseSearchTrajectoryData::FDerived const FPoseSearchTrajectoryData::FSampling float boolbool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bSimulateMontages float FTransformTrajectory float int32 float int32bool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bSimulateWarping float FTransformTrajectory float int32 float int32boolbool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bSimulateWarping const FAnimMontageInstanceFTransformTrajectory const FPoseSearchTrajectoryData const FPoseSearchTrajectoryData::FDerived const FPoseSearchTrajectoryData::FSampling float bool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bTraceComplex FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bTraceComplex const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool   PoseSearch/PoseSearchTrajectoryLibrary.h  
CollisionResult const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResults &   PoseSearch/PoseSearchTrajectoryLibrary.h  
CollisionResult FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResults &   PoseSearch/PoseSearchTrajectoryLibrary.h  
CurrentAngularVelocityDegrees FVectorFVectorFQuatFVector   PoseSearch/PoseSearchTrajectoryLibrary.h  
CurrentFacing FVectorFVectorFQuat   PoseSearch/PoseSearchTrajectoryLibrary.h  
CurrentPosition FVector   PoseSearch/PoseSearchTrajectoryLibrary.h  
CurrentVelocity FVectorFVector   PoseSearch/PoseSearchTrajectoryLibrary.h  
DeltaTime const FAnimMontageInstanceFTransformTrajectory const FPoseSearchTrajectoryData const FPoseSearchTrajectoryData::FDerived const FPoseSearchTrajectoryData::FSampling float   PoseSearch/PoseSearchTrajectoryLibrary.h  
DeltaTime FVectorFVectorFQuatFVector const FPoseSearchTrajectoryData::FSampling float   PoseSearch/PoseSearchTrajectoryLibrary.h  
DeltaTime const FPoseSearchTrajectoryData::FSampling float   PoseSearch/PoseSearchTrajectoryLibrary.h  
DrawDebugType const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Type   PoseSearch/PoseSearchTrajectoryLibrary.h  
DrawDebugType FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Type   PoseSearch/PoseSearchTrajectoryLibrary.h  
DrawTime const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool float FLinearColorFLinearColor float   PoseSearch/PoseSearchTrajectoryLibrary.h  
DrawTime FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool float FLinearColorFLinearColor float   PoseSearch/PoseSearchTrajectoryLibrary.h  
FloorCollisionsOffset FVectorboolFVector float   PoseSearch/PoseSearchTrajectoryLibrary.h  
FloorCollisionsOffset const UAnimInstancebool float   PoseSearch/PoseSearchTrajectoryLibrary.h  
GravityAccel FVectorboolFVector   PoseSearch/PoseSearchTrajectoryLibrary.h  
InDeltaTime float   PoseSearch/PoseSearchTrajectoryLibrary.h  
InHistorySamplingInterval float FTransformTrajectory float   PoseSearch/PoseSearchTrajectoryLibrary.h  
InPredictionSamplingInterval float FTransformTrajectory float int32 float   PoseSearch/PoseSearchTrajectoryLibrary.h  
InTrajectoryHistoryCount float FTransformTrajectory float int32   PoseSearch/PoseSearchTrajectoryLibrary.h  
InTrajectoryPredictionCount float FTransformTrajectory float int32 float int32   PoseSearch/PoseSearchTrajectoryLibrary.h  
InWarpingComponent const FAnimMontageInstanceFTransformTrajectory const FPoseSearchTrajectoryData const FPoseSearchTrajectoryData::FDerived const FPoseSearchTrajectoryData::FSampling float boolbool UMotionWarpingComponent *   PoseSearch/PoseSearchTrajectoryLibrary.h  
MaxObstacleHeight FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool float   PoseSearch/PoseSearchTrajectoryLibrary.h  
MaxObstacleHeight const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool float   PoseSearch/PoseSearchTrajectoryLibrary.h  
MontageInstance const FAnimMontageInstance *   PoseSearch/PoseSearchTrajectoryLibrary.h  
OutTrajectory FVectorboolFVector float FTransformTrajectory &   PoseSearch/PoseSearchTrajectoryLibrary.h  
OutTrajectory const UAnimInstancebool float FTransformTrajectory &   PoseSearch/PoseSearchTrajectoryLibrary.h  
OutTrajectory float FTransformTrajectory &   PoseSearch/PoseSearchTrajectoryLibrary.h  
StartingVelocity FVector   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceChannel FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceChannel const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceColor const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool float FLinearColor   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceColor FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool float FLinearColor   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceHitColor FVectorboolFVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool float FLinearColorFLinearColor   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceHitColor const UAnimInstancebool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuerybool const TArray< AActor * > EDrawDebugTrace::Typebool float FLinearColorFLinearColor   PoseSearch/PoseSearchTrajectoryLibrary.h  
Trajectory const FAnimMontageInstanceFTransformTrajectory &   PoseSearch/PoseSearchTrajectoryLibrary.h  
TrajectoryData const FAnimMontageInstanceFTransformTrajectory const FPoseSearchTrajectoryData &   PoseSearch/PoseSearchTrajectoryLibrary.h  
TrajectoryDataDerived const FAnimMontageInstanceFTransformTrajectory const FPoseSearchTrajectoryData const FPoseSearchTrajectoryData::FDerived &   PoseSearch/PoseSearchTrajectoryLibrary.h  
TrajectoryDataSampling FVectorFVectorFQuatFVector const FPoseSearchTrajectoryData::FSampling &   PoseSearch/PoseSearchTrajectoryLibrary.h  
TrajectoryDataSampling const FAnimMontageInstanceFTransformTrajectory const FPoseSearchTrajectoryData const FPoseSearchTrajectoryData::FDerived const FPoseSearchTrajectoryData::FSampling &   PoseSearch/PoseSearchTrajectoryLibrary.h  
TrajectoryDataSampling const FPoseSearchTrajectoryData::FSampling &   PoseSearch/PoseSearchTrajectoryLibrary.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UE_EXPERIMENTAL (

  1. 8,
    "Experimental pose search function,
    API may change in the future"
    ) const
   PoseSearch/PoseSearchTrajectoryLibrary.h  

UE_EXPERIMENTAL (

  1. 7,
    "Experimental pose search function,
    API may change in the future"
    )
 Experimental: Update the history purely based on current position, without taking into account ground velocities. PoseSearch/PoseSearchTrajectoryLibrary.h  

UE_EXPERIMENTAL (

  1. 8,
    "Experimental pose search function,
    API may change in the future"
    ) const
 Update prediction by simulating an active montage's root motion. PoseSearch/PoseSearchTrajectoryLibrary.h  

UE_EXPERIMENTAL (

  1. 8,
    "Experimental pose search function,
    API may change in the future"
    )
 Like UpdateHistory_TransformHistory, but also applies the angular analogue of the ground-translation correction so that history stays anchored to rotating platforms. PoseSearch/PoseSearchTrajectoryLibrary.h  

UE_EXPERIMENTAL (

  1. 6,
    "Solution for CMC based workflow not Mover."
    ) const
 Experimental: Process InTrajectory to apply gravity and handle collisions. PoseSearch/PoseSearchTrajectoryLibrary.h  

UE_EXPERIMENTAL (

  1. 6,
    "Solution for CMC based workflow not Mover."
    ) const
 Experimental: Process InTrajectory to apply gravity and handle collisions. PoseSearch/PoseSearchTrajectoryLibrary.h  

UPARAM ( ref
) const

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintCallable
  • Category="Animation|PoseSearch|Experimental"
  • Meta=(BlueprintThreadSafe, DisplayName="HandleTrajectoryWorldCollisionsWithGravity", WorldContext="WorldContextObject", AutoCreateRefTerm="ActorsToIgnore", AdvancedDisplay="TraceChannel,bTraceComplex,ActorsToIgnore,DrawDebugType,bIgnoreSelf,MaxObstacleHeight,TraceColor,TraceHitColor,DrawTime")

float UPARAM ( ref
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

const UAnimInstance UPARAM ( ref
) const

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintCallable
  • Category="Animation|PoseSearch|Experimental"
  • Meta=(BlueprintThreadSafe, DisplayName="HandleTrajectoryWorldCollisions", WorldContext="WorldContextObject", AutoCreateRefTerm="ActorsToIgnore", AdvancedDisplay="TraceChannel,bTraceComplex,ActorsToIgnore,DrawDebugType,bIgnoreSelf,MaxObstacleHeight,TraceColor,TraceHitColor,DrawTime")

float UPARAM ( ref
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

UPARAM ( ref
) const

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintCallable
  • Category="Animation|PoseSearch|Experimental"
  • Meta=(BlueprintThreadSafe, DisplayName="Pose Search Generate Warped Trajectory (Experimental)")

Static

Name Remarks Include Path Unreal Specifiers

static void DrawTransformTrajectory ( const UObject* WorldContextObject,
UPARAM(ref) const FTransformTrajectory& InTrajectory,
const float DebugThickness,
float HeightOffset
)

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintCallable
  • Category="Animation|PoseSearch|Experimental"
  • Meta=(DisplayName="DrawTrajectory", WorldContext="WorldContextObject")

static void GetTransformTrajectoryAngularVelocity ( UPARAM(ref) const FTransformTrajectory& InTrajectory,
float Time1,
float Time2,
FVector& OutAngularVelocity,
bool bExtrapolate
)

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintPure
  • Category="Animation|PoseSearch"
  • Meta=(BlueprintThreadSafe, DisplayName="GetTrajectoryAngularVelocity")

static void GetTransformTrajectorySampleAtTime ( UPARAM(ref) const FTransformTrajectory& InTrajectory,
float Time,
FTransformTrajectorySample& OutTrajectorySample,
bool bExtrapolate
)

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintPure
  • Category="Animation|PoseSearch"
  • Meta=(BlueprintThreadSafe, DisplayName="GetTrajectorySampleAtTime")

static FTransform GetTransformTrajectorySampleTransform ( UPARAM(ref) const FTransformTrajectorySample& InTrajectorySample
)

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintPure
  • Category="Animation|PoseSearch"
  • Meta=(BlueprintThreadSafe, DisplayName="GetTrajectorySampleTransform")

static void GetTransformTrajectoryVelocity ( UPARAM(ref) const FTransformTrajectory& InTrajectory,
float Time1,
float Time2,
FVector& OutVelocity,
bool bExtrapolate
)

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintPure
  • Category="Animation|PoseSearch"
  • Meta=(BlueprintThreadSafe, DisplayName="GetTrajectoryVelocity")

static void InitTrajectorySamples ( FTransformTrajectory& Trajectory,
FVector DefaultPosition,
FQuat DefaultFacing,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float DeltaTime
)

 Initialize history and predicted samples based on sampling settings and a default state. PoseSearch/PoseSearchTrajectoryLibrary.h  

static void PoseSearchGeneratePredictorTransformTrajectory ( UObject* InPredictor,
UPARAM(ref) const FPoseSearchTrajectoryData& InTrajectoryData,
float InDeltaTime,
UPARAM(ref) FTransformTrajectory& InOutTrajectory,
UPARAM(ref) float& InOutDesiredControllerYawLastUpdate,
FTransformTrajectory& OutTrajectory,
float InHistorySamplingInterval,
int32 InTrajectoryHistoryCount,
float InPredictionSamplingInterval,
int32 InTrajectoryPredictionCount
)

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintCallable
  • Category="Animation|PoseSearch|Experimental"
  • Meta=(BlueprintThreadSafe, DisplayName="Pose Search Generate Trajectory (using Predictor)", DeprecatedFunction, DeprecationMessage="Use PoseSearchGeneratePredictorTrajectory that does not take FPoseSearchTrajectoryData.")

static void PoseSearchGenerateTransformTrajectory ( const UObject* InAnimInstance,
UPARAM(ref) const FPoseSearchTrajectoryData& InTrajectoryData,
float InDeltaTime,
UPARAM(ref) FTransformTrajectory& InOutTrajectory,
UPARAM(ref) float& InOutDesiredControllerYawLastUpdate,
FTransformTrajectory& OutTrajectory,
float InHistorySamplingInterval,
int32 InTrajectoryHistoryCount,
float InPredictionSamplingInterval,
int32 InTrajectoryPredictionCount
)

 Generates a prediction trajectory based of the current character intent. For use with Character actors. PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintCallable
  • Category="Animation|PoseSearch"
  • Meta=(BlueprintThreadSafe, DisplayName="Pose Search Generate Trajectory (for Character)")

static void PoseSearchGenerateTransformTrajectoryWithPredictor ( TScriptInterface< IPoseSearchTrajectoryPredictorInterface > InPredictor,
float InDeltaTime,
UPARAM(ref) FTransformTrajectory& InOutTrajectory,
UPARAM(ref) float& InOutDesiredControllerYawLastUpdate,
FTransformTrajectory& OutTrajectory,
float InHistorySamplingInterval,
int32 InTrajectoryHistoryCount,
float InPredictionSamplingInterval,
int32 InTrajectoryPredictionCount
)

   PoseSearch/PoseSearchTrajectoryLibrary.h
  • BlueprintCallable
  • Category="Animation|PoseSearch|Experimental"
  • Meta=(BlueprintThreadSafe, DisplayName="Pose Search Generate Trajectory (using Predictor)")

static FVector RemapVectorMagnitudeWithCurve ( const FVector& Vector,
bool bUseCurve,
const FRuntimeFloatCurve& Curve
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static void UpdateHistory_TransformHistory ( FTransformTrajectory& Trajectory,
FVector CurrentPosition,
FVector CurrentVelocity,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float DeltaTime,
float CurrentTime
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static void UpdateHistory_TransformHistory ( FTransformTrajectory& Trajectory,
FVector CurrentPosition,
FVector CurrentVelocity,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float DeltaTime
)

 Update history by tracking offsets that result from character intent (e.g. movement component velocity) and applying that to the current world transform. PoseSearch/PoseSearchTrajectoryLibrary.h  

static void UpdateHistory_TransformHistoryInternal ( FTransformTrajectory& Trajectory,
FVector CurrentPosition,
FVector CurrentVelocity,
FQuat CurrentFacing,
FVector CurrentAngularVelocityDegrees,
bool bApplyAngularCorrection,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float DeltaTime
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static void UpdatePrediction_SimulateCharacterMovement ( FTransformTrajectory& Trajectory,
const FPoseSearchTrajectoryData& TrajectoryData,
const FPoseSearchTrajectoryData::FDerived& TrajectoryDataDerived,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float DeltaTime
)

 Update prediction by simulating the movement math for ground locomotion from UCharacterMovementComponent. PoseSearch/PoseSearchTrajectoryLibrary.h  

static void UpdatePrediction_SimulateCharacterMovementInit ( FTransformTrajectory& Trajectory,
FVector& OutCurrentPositionWS,
FVector& OutCurrentVelocityWS,
FVector& OutCurrentAccelerationWS,
FQuat& OutCurrentFacingWS,
const FPoseSearchTrajectoryData& TrajectoryData,
const FPoseSearchTrajectoryData::FDerived& TrajectoryDataDerived
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static void UpdatePrediction_SimulateCharacterMovementStep ( FTransformTrajectory& Trajectory,
FVector& InOutCurrentPositionWS,
FVector& InOutCurrentVelocityWS,
FVector& InOutCurrentAccelerationWS,
FQuat& InOutCurrentFacingWS,
const FPoseSearchTrajectoryData& TrajectoryData,
const FPoseSearchTrajectoryData::FDerived& TrajectoryDataDerived,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float& InOutAccumulatedSeconds
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page