1. Epic GamesDeveloper
  3. UPoseSearchTrajectoryLibrary

UPoseSearchTrajectoryLibrary

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

API > API/Plugins > API/Plugins/PoseSearch

Set of functions to help populate a FPoseSearchQueryTrajectory 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 FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > &   PoseSearch/PoseSearchTrajectoryLibrary.h  
ActorsToIgnore const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > &   PoseSearch/PoseSearchTrajectoryLibrary.h  
AnimInstance const UAnimInstance *   PoseSearch/PoseSearchTrajectoryLibrary.h  
bApplyGravity const UAnimInstance bool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bApplyGravity FVector bool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bIgnoreSelf FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bIgnoreSelf const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bTraceComplex FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool   PoseSearch/PoseSearchTrajectoryLibrary.h  
bTraceComplex const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool   PoseSearch/PoseSearchTrajectoryLibrary.h  
CollisionResult const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResults &   PoseSearch/PoseSearchTrajectoryLibrary.h  
CollisionResult FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResults &   PoseSearch/PoseSearchTrajectoryLibrary.h  
CurrentPosition FVector   PoseSearch/PoseSearchTrajectoryLibrary.h  
CurrentRotation FVectorFQuat   PoseSearch/PoseSearchTrajectoryLibrary.h  
CurrentTime FVectorFQuat const FPoseSearchTrajectoryData::FSampling float float   PoseSearch/PoseSearchTrajectoryLibrary.h  
DeltaTime FVectorFQuat const FPoseSearchTrajectoryData::FSampling float   PoseSearch/PoseSearchTrajectoryLibrary.h  
DrawDebugType FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type   PoseSearch/PoseSearchTrajectoryLibrary.h  
DrawDebugType const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type   PoseSearch/PoseSearchTrajectoryLibrary.h  
DrawTime const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool float FLinearColorFLinearColor float   PoseSearch/PoseSearchTrajectoryLibrary.h  
DrawTime FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool float FLinearColorFLinearColor float   PoseSearch/PoseSearchTrajectoryLibrary.h  
FloorCollisionsOffset const UAnimInstance bool float   PoseSearch/PoseSearchTrajectoryLibrary.h  
FloorCollisionsOffset FVector bool FVector float   PoseSearch/PoseSearchTrajectoryLibrary.h  
GravityAccel FVector bool FVector   PoseSearch/PoseSearchTrajectoryLibrary.h  
MaxObstacleHeight FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool float   PoseSearch/PoseSearchTrajectoryLibrary.h  
MaxObstacleHeight const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool float   PoseSearch/PoseSearchTrajectoryLibrary.h  
OutTrajectory const UAnimInstance bool float FTransformTrajectory &   PoseSearch/PoseSearchTrajectoryLibrary.h  
OutTrajectory FVector bool FVector float FTransformTrajectory &   PoseSearch/PoseSearchTrajectoryLibrary.h  
StartingVelocity FVector   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceChannel FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceChannel const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceColor const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool float FLinearColor   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceColor FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool float FLinearColor   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceHitColor FVector bool FVector float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool float FLinearColorFLinearColor   PoseSearch/PoseSearchTrajectoryLibrary.h  
TraceHitColor const UAnimInstance bool float FTransformTrajectoryFPoseSearchTrajectory_WorldCollisionResultsETraceTypeQuery bool const TArray< AActor * > EDrawDebugTrace::Type bool float FLinearColorFLinearColor   PoseSearch/PoseSearchTrajectoryLibrary.h  
TrajectoryDataSampling FVectorFQuat const FPoseSearchTrajectoryData::FSampling &   PoseSearch/PoseSearchTrajectoryLibrary.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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  

UE_EXPERIMENTAL (

  1. 6,
    "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 DeltaTime is the time since the last call to this method PoseSearch/PoseSearchTrajectoryLibrary.h  

UE_EXPERIMENTAL (

  1. 6,
    "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  

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")

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")

Static

Name Remarks Include Path Unreal Specifiers

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

   PoseSearch/PoseSearchTrajectoryLibrary.h  

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 GetTrajectoryAngularVelocity ( UPARAM(ref) const FPoseSearchQueryTrajectory& InTrajectory,
float Time1,
float Time2,
FVector& OutAngularVelocity,
bool bExtrapolate
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static void GetTrajectorySampleAtTime ( UPARAM(ref) const FPoseSearchQueryTrajectory& InTrajectory,
float Time,
FPoseSearchQueryTrajectorySample& OutTrajectorySample,
bool bExtrapolate
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

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

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static FTransform GetTransform ( UPARAM(ref) const FPoseSearchQueryTrajectorySample& InTrajectorySample
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

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 HandleTrajectoryWorldCollisions ( const UObject* WorldContextObject,
const UAnimInstance* AnimInstance,
UPARAM(ref) const FPoseSearchQueryTrajectory& InTrajectory,
bool bApplyGravity,
float FloorCollisionsOffset,
FPoseSearchQueryTrajectory& OutTrajectory,
FPoseSearchTrajectory_WorldCollisionResults& CollisionResult,
ETraceTypeQuery TraceChannel,
bool bTraceComplex,
const TArray< AActor* >& ActorsToIgnore,
EDrawDebugTrace::Type DrawDebugType,
bool bIgnoreSelf,
float MaxObstacleHeight,
FLinearColor TraceColor,
FLinearColor TraceHitColor,
float DrawTime
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static void HandleTrajectoryWorldCollisionsWithGravity ( const UObject* WorldContextObject,
UPARAM(ref) const FPoseSearchQueryTrajectory& InTrajectory,
FVector StartingVelocity,
bool bApplyGravity,
FVector GravityAccel,
float FloorCollisionsOffset,
FPoseSearchQueryTrajectory& OutTrajectory,
FPoseSearchTrajectory_WorldCollisionResults& CollisionResult,
ETraceTypeQuery TraceChannel,
bool bTraceComplex,
const TArray< AActor* >& ActorsToIgnore,
EDrawDebugTrace::Type DrawDebugType,
bool bIgnoreSelf,
float MaxObstacleHeight,
FLinearColor TraceColor,
FLinearColor TraceHitColor,
float DrawTime
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static void InitTrajectorySamples ( FPoseSearchQueryTrajectory& Trajectory,
const FPoseSearchTrajectoryData& TrajectoryData,
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 PRAGMA_ENABLE_DEPRECATION_WARNINGS void InitTrajectorySamples ( FTransformTrajectory& Trajectory,
FVector DefaultPosition,
FQuat DefaultFacing,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float DeltaTime
)

 NON- DEPRECATED ////////////////////////////////////////////////////////. PoseSearch/PoseSearchTrajectoryLibrary.h  

static PRAGMA_DISABLE_DEPRECATION_WARNINGS void InitTrajectorySamples ( FPoseSearchQueryTrajectory& Trajectory,
const FPoseSearchTrajectoryData& TrajectoryData,
const FPoseSearchTrajectoryData::FDerived& TrajectoryDataDerived,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float DeltaTime
)

 DEPRECATED /////////////////////////////////////////////////////////////. PoseSearch/PoseSearchTrajectoryLibrary.h  

static void InitTrajectorySamples ( FPoseSearchQueryTrajectory& 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 PoseSearchGeneratePredictorTrajectory ( UObject* InPredictor,
UPARAM(ref) const FPoseSearchTrajectoryData& InTrajectoryData,
float InDeltaTime,
UPARAM(ref) FPoseSearchQueryTrajectory& InOutTrajectory,
UPARAM(ref) float& InOutDesiredControllerYawLastUpdate,
FPoseSearchQueryTrajectory& OutTrajectory,
float InHistorySamplingInterval,
int32 InTrajectoryHistoryCount,
float InPredictionSamplingInterval,
int32 InTrajectoryPredictionCount
)

   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 PoseSearchGenerateTrajectory ( const UObject* InAnimInstance,
UPARAM(ref) const FPoseSearchTrajectoryData& InTrajectoryData,
float InDeltaTime,
UPARAM(ref) FPoseSearchQueryTrajectory& InOutTrajectory,
UPARAM(ref) float& InOutDesiredControllerYawLastUpdate,
FPoseSearchQueryTrajectory& OutTrajectory,
float InHistorySamplingInterval,
int32 InTrajectoryHistoryCount,
float InPredictionSamplingInterval,
int32 InTrajectoryPredictionCount
)

 Generates a prediction trajectory based of the current character intent. PoseSearch/PoseSearchTrajectoryLibrary.h  

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

   PoseSearch/PoseSearchTrajectoryLibrary.h  

static PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS 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 ( FPoseSearchQueryTrajectory& Trajectory,
const FPoseSearchTrajectoryData& TrajectoryData,
const FPoseSearchTrajectoryData::FDerived& TrajectoryDataDerived,
const FPoseSearchTrajectoryData::FSampling& TrajectoryDataSampling,
float DeltaTime
)

   PoseSearch/PoseSearchTrajectoryLibrary.h  

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

   PoseSearch/PoseSearchTrajectoryLibrary.h  

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

   PoseSearch/PoseSearchTrajectoryLibrary.h  

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

   PoseSearch/PoseSearchTrajectoryLibrary.h  

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

 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 UpdatePrediction_SimulateCharacterMovement ( FPoseSearchQueryTrajectory& Trajectory,
const FPoseSearchTrajectoryData& TrajectoryData,
const FPoseSearchTrajectoryData::FDerived& TrajectoryDataDerived,
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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page