UInputBehaviorSet

[UInputBehaviorSet](API\Runtime\InteractiveToolsFramework\UInputBehaviorSet) manages a set of UInputBehaviors, and provides various functions to query and forward events to the set.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/InputBehaviorSet.h

Include

#include "InputBehaviorSet.h"

Syntax

class UInputBehaviorSet : public UObject

Remarks

UInputBehaviorSet manages a set of UInputBehaviors, and provides various functions to query and forward events to the set. Tools and Widgets provide instances of this via IInputBehaviorSource, and UInputRouter collects and manages them (see comments there)

Behaviors in the set each have a source pointer and group tag, which allows sets of behaviors to be managed together. For example one UInputBehaviorSet can be merged into another and removed later.

Variables

Name Description

Protected variable

TArray< FBehavi...

 

Behaviors

Current set of known Behaviors

Constructors

Name Description

Public function

UInputBehaviorSet()

Destructors

Name Description

Public function Virtual

~UInputBehaviorSet()

Functions

Name Description

Public function Virtual

void

 

Add

(
    UInputBehavior* Behavior,
    void* Source,
    const FString& GroupName
)

Add a Behavior to the set

Public function Virtual

void

 

Add

(
    const UInputBehaviorSet* Other...,
    void* NewSource,
    const FString& NewGroupName
)

Merge another BehaviorSet into this Set

Protected function Virtual

void

 

BehaviorsModified()

Called internally when Behaviors list is updated, to re-sort by Priority, etc (

Public function Virtual

void

 

CollectWantsCapture

(
    const FInputDeviceState& InputStat...,
    TArray< FInputCaptureRequest >& Re...
)

Queries and Event Forwarding Call UInputBehavior::WantsCapture() on each valid Behavior and collect up the requests that indicated a Capture was desired.

Public function Virtual

void

 

CollectWantsHoverCapture

(
    const FInputDeviceState& InputStat...,
    TArray< FInputCaptureRequest >& Re...
)

Call UInputBehavior::WantsCapture() on each valid Behavior and collect up the requests that indicated a Capture was desired.

Public function Virtual Const

bool

 

IsEmpty()

Set Management

Public function Virtual

bool

 

Remove

(
    UInputBehavior* Behavior
)

Remove a Behavior from the Set

Public function Virtual

void

 

RemoveAll()

Remove all Behaviors from the set

Public function Virtual

bool

 

RemoveByGroup

(
    const FString& GroupName
)

Remove a group of Behaviors from the Set

Public function Virtual

bool

 

RemoveBySource

(
    void* Source
)

Remove a group of Behaviors from the Set

Protected function

bool

 

SupportsInputType

(
    UInputBehavior* Behavior,
    const FInputDeviceState& InputStat...
)