Navigation
API > API/Plugins > API/Plugins/PoseSearch
Experimental, this feature might be removed without warning, not for production use FInteractionIsland contains ticks functions injected between the interacting actors TickActorComponents (UCharacterMovementComponent, or UCharacterMoverComponent) and PostTickComponent (USkeletalMeshComponent, or UAnimNextComponent) to create a execution threading fence to be able to perform motion matching searches between the involved characters in a thread safe manner. Look at UPoseSearchInteractionSubsystem "Execution model and threading details" for additional information
| Name | FInteractionIsland |
| Type | struct |
| Header File | /Engine/Plugins/Animation/PoseSearch/Source/Runtime/Public/PoseSearch/PoseSearchInteractionIsland.h |
| Include Path | #include "PoseSearch/PoseSearchInteractionIsland.h" |
Syntax
struct FInteractionIsland
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInteractionIsland
(
ULevel* Level, |
PoseSearch/PoseSearchInteractionIsland.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FInteractionIsland() |
PoseSearch/PoseSearchInteractionIsland.h |
Structs
| Name | Remarks |
|---|---|
| FPostTickFunction | |
| FPreTickFunction |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasTickDependencies | bool | PoseSearch/PoseSearchInteractionIsland.h | ||
| bSearchPerfomed | bool | PoseSearch/PoseSearchInteractionIsland.h | ||
| InteractionSubsystem | UPoseSearchInteractionSubsystem * | PoseSearch/PoseSearchInteractionIsland.h | ||
| IslandAnimContexts | TArray< TWeakObjectPtr< const UObject > > | All the AnimContext in this island. Each SearchContexts will contain a subset of IslandAnimContexts | PoseSearch/PoseSearchInteractionIsland.h | |
| PostTickFunction | FPostTickFunction | PoseSearch/PoseSearchInteractionIsland.h | ||
| PreTickFunction | FPreTickFunction | PoseSearch/PoseSearchInteractionIsland.h | ||
| SearchContexts | TArray< FInteractionSearchContext > | There's one FSearchContext for each search we need to perform (including all the possible roles combinations). | PoseSearch/PoseSearchInteractionIsland.h | |
| SearchResults | TArray< FInteractionSearchResult > | SearchResults contains only the best results, and it has not necessarly the same cardinality as SearchContexts. | PoseSearch/PoseSearchInteractionIsland.h | |
| TickActorComponents | TArray< TWeakObjectPtr< UActorComponent > > | PoseSearch/PoseSearchInteractionIsland.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddSearchContext
(
const FInteractionSearchContext& SearchContext |
PoseSearch/PoseSearchInteractionIsland.h | ||
bool DoSearch_AnyThread
(
const UObject* AnimContext, |
PoseSearch/PoseSearchInteractionIsland.h | ||
const FInteractionSearchResult * FindSearchResult
(
const FInteractionSearchContext& SearchContext |
PoseSearch/PoseSearchInteractionIsland.h | ||
const TArray< TWeakObjectPtr< const UObject > > & GetIslandAnimContexts() |
PoseSearch/PoseSearchInteractionIsland.h | ||
bool GetResult_AnyThread
(
const UObject* AnimContext, |
PoseSearch/PoseSearchInteractionIsland.h | ||
const TArray< FInteractionSearchContext > & GetSearchContexts() |
PoseSearch/PoseSearchInteractionIsland.h | ||
const TArray< FInteractionSearchResult > & GetSearchResults() |
PoseSearch/PoseSearchInteractionIsland.h | ||
const TArray< TWeakObjectPtr< UActorComponent > > & GetTickActorComponents() |
PoseSearch/PoseSearchInteractionIsland.h | ||
bool HasTickDependencies() |
PoseSearch/PoseSearchInteractionIsland.h | ||
void InjectToActor
(
const UObject* AnimContext, |
PoseSearch/PoseSearchInteractionIsland.h | ||
bool IsInitialized() |
PoseSearch/PoseSearchInteractionIsland.h | ||
UE_NONCOPYABLE
(
FInteractionIsland |
PoseSearch/PoseSearchInteractionIsland.h | ||
void Uninitialize
(
bool bValidateTickDependencies |
PoseSearch/PoseSearchInteractionIsland.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IInteractionIslandDependency * FindCustomDependency
(
UActorComponent* InTickComponent |
PoseSearch/PoseSearchInteractionIsland.h |