FInteractionIsland

Experimental, this feature might be removed without warning, not for production use [FInteractionIsland](API\Plugins\PoseSearch\FInteractionIsland) contains ticks functions injected between the interacting actors TickActorComponents ([UCharacterMovementComponent](API\Runtime\Engine\UCharacterMovementComponent), or UCharacterMoverComponent) and PostTickComponent ([USkeletalMeshComponent](API\Runtime\Engine\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.

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,
UPoseSearchInteractionSubsystem* Subsystem
)

   PoseSearch/PoseSearchInteractionIsland.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FInteractionIsland()

   PoseSearch/PoseSearchInteractionIsland.h  

Structs

Name Remarks
FClosingTickFunction Running ALL actors animation evaluation
FPostTickFunction Running after main actor animation evaluation, and before any NON main actor animation evaluation
FPreTickFunction Running before main actor animation evaluation

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasTickDependencies bool   PoseSearch/PoseSearchInteractionIsland.h  
bSearchPerfomed bool   PoseSearch/PoseSearchInteractionIsland.h  
ClosingTickFunction FClosingTickFunction   PoseSearch/PoseSearchInteractionIsland.h  
InteractionSubsystem UPoseSearchInteractionSubsystem *   PoseSearch/PoseSearchInteractionIsland.h  
IslandAnimContexts TArray< TObjectPtr< const UObject > > All the AnimContext in this island. Each SearchContexts will contain a subset of IslandAnimContexts PoseSearch/PoseSearchInteractionIsland.h  
PostClosingTickActorComponents TArray< TObjectPtr< UActorComponent > > UActorComponent with an ijected tick dependency to the ClosingTickFunction. 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< TObjectPtr< UActorComponent > >   PoseSearch/PoseSearchInteractionIsland.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddReferencedObjects ( FReferenceCollector& Collector
)

   PoseSearch/PoseSearchInteractionIsland.h  

void AddSearchContext ( const FInteractionSearchContext& SearchContext
)

   PoseSearch/PoseSearchInteractionIsland.h  

bool DoSearch_AnyThread ( const UObject* AnimContext,
FPoseSearchBlueprintResult& Result
)

   PoseSearch/PoseSearchInteractionIsland.h  

bool GetConstraint ( const UObject* AnimContext,
FName SocketName,
float& OutDesiredReach,
FTransform& OutTransform,
bool bCompareOwningActors
) const

   PoseSearch/PoseSearchInteractionIsland.h  

const TArray< const UObject * > & GetIslandAnimContexts()

   PoseSearch/PoseSearchInteractionIsland.h  

bool GetResult_AnyThread ( const UObject* AnimContext,
FPoseSearchBlueprintResult& Result,
bool bCompareOwningActors
)

   PoseSearch/PoseSearchInteractionIsland.h  

const TArray< FInteractionSearchContext > & GetSearchContexts()

   PoseSearch/PoseSearchInteractionIsland.h  

const TArray< FInteractionSearchResult > & GetSearchResults()

   PoseSearch/PoseSearchInteractionIsland.h  

const TArray< UActorComponent * > & GetTickActorComponents()

   PoseSearch/PoseSearchInteractionIsland.h  

bool HasTickDependencies()

   PoseSearch/PoseSearchInteractionIsland.h  

void InjectToActor ( const UObject* AnimContext,
bool bAddTickDependencies
)

   PoseSearch/PoseSearchInteractionIsland.h  

bool IsInitialized()

   PoseSearch/PoseSearchInteractionIsland.h  

UE_NONCOPYABLE ( FInteractionIsland
)

   PoseSearch/PoseSearchInteractionIsland.h  

void Uninitialize ( bool bValidateTickDependencies
)

   PoseSearch/PoseSearchInteractionIsland.h  

void UpdateConstraints ( float DeltaTime
)

   PoseSearch/PoseSearchInteractionIsland.h  

Static

Name Remarks Include Path Unreal Specifiers

static IInteractionIslandDependency * FindCustomDependency ( UActorComponent* InTickComponent
)

   PoseSearch/PoseSearchInteractionIsland.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page