UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | List of all members
UE::Anim::IPoseSearchProvider Class Referenceabstract

#include <AnimPoseSearchProvider.h>

+ Inheritance diagram for UE::Anim::IPoseSearchProvider:

Classes

struct  FSearchFutureAsset
 
struct  FSearchPlayingAsset
 
struct  FSearchResult
 

Public Member Functions

virtual ~IPoseSearchProvider ()
 
virtual FSearchResult Search (const FAnimationBaseContext &GraphContext, TArrayView< const UObject * > AssetsToSearch, const FSearchPlayingAsset &PlayingAsset, const FSearchFutureAsset &FutureAsset) const =0
 

Static Public Member Functions

static UE_API FName GetModularFeatureName ()
 
static UE_API bool IsAvailable ()
 
static UE_API IPoseSearchProvider * Get ()
 

Detailed Description

Modular feature interface for PoseSearch

Constructor & Destructor Documentation

◆ ~IPoseSearchProvider()

virtual UE::Anim::IPoseSearchProvider::~IPoseSearchProvider ( )
inlinevirtual

Member Function Documentation

◆ Get()

IPoseSearchProvider * UE::Anim::IPoseSearchProvider::Get ( )
static

◆ GetModularFeatureName()

FName UE::Anim::IPoseSearchProvider::GetModularFeatureName ( )
static

◆ IsAvailable()

bool UE::Anim::IPoseSearchProvider::IsAvailable ( )
static

◆ Search()

virtual FSearchResult UE::Anim::IPoseSearchProvider::Search ( const FAnimationBaseContext &  GraphContext,
TArrayView< const UObject * >  AssetsToSearch,
const FSearchPlayingAsset &  PlayingAsset,
const FSearchFutureAsset &  FutureAsset 
) const
pure virtual

Finds a matching pose in the input Object given the current graph context

Parameters
GraphContextGraph execution context used to construct a pose search query
AssetsToSearchThe assets to search for the pose query
PlayingAsset.AssetThe currently playing asset, used to bias the score of the eventually found continuing pose
PlayingAsset.AccumulatedTimeThe accumulated time of the currently playing asset
FutureAsset.AssetThe asset that will play in the future after FutureAssetIntervalTime seconds
FutureAsset.AccumulatedTimeThe FutureAsset accumulated time in seconds when it'll start play
FutureAsset.IntervalTimeThe requested time interval before FutureAsset will start playing at FutureAssetAccumulatedTime
Returns
FSearchResult The search result identifying the asset from AssetsToSearch or PlayingAsset that most closely matches the query
The documentation for this class was generated from the following files: