InteractiveToolsFramework

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

Name

Description

Public class

AInternalToolFrameworkActor

AInternalToolFrameworkActor is a base class for internal Actors that the ToolsFramework may spawn (for gizmos, mesh previews, etc).

Public class

FActivateToolChange

FActivateToolChange is used by UInteractiveToolManager to change the active tool.

Public struct

FActiveGizmo

Public class

FBeginToolChange

FBeginToolChange is used by UInteractiveToolManager to back out of a Tool on Undo.

Public struct

FBehaviorInfo

This is an internal structure used by UInputBehaviorSet.

Public class

FComponentTargetFactory

Public struct

FDeviceButtonState

Current State of a physical device button (mouse, key, etc) at a point in time.

Public struct

FInputCaptureData

An active capturing behavior may need to keep track of additional data that cannot be stored within the behavior (for example if the same behavior instance is capturing for Left and Right separately).

Public struct

FInputCapturePriority

Each UInputBehavior provides a priority that is used to help resolve situations when multiple Behaviors want to capture based on the same input event

Public struct

FInputCaptureRequest

UInputBehavior returns an FInputCaptureRequest from WantsCapture() to indicate whether it wants to capture or ignore an input event

Public struct

FInputCaptureUpdate

IInputBehavior returns an FInputCaptureUpdate from BeginCapture() and UpdateCapture(), which indicates to the InputRouter what the Behavior would like to have happen.

Public struct

FInputDeviceRay

FInputDeviceRay represents a 3D ray created based on an input device.

Public struct

FInputDeviceState

Current state of physical input devices at a point in time.

Public struct

FInputRayHit

FInputRayHit is returned by various hit-test interface functions.

Public struct

FInteractiveToolAction

FInteractiveToolAction is returned by a UInteractiveTool to represent an "Action" the Tool can execute.

Public class

FInteractiveToolActionSet

FInteractiveToolActionSet maintains a list of FInteractiveToolAction.

Public struct

FInteractiveToolInfo

FInteractiveToolInfo provides information about a tool (name, tooltip, etc)

Public class

FInteractiveToolsFrameworkModule

Public struct

FKeyboardInputDeviceState

Current state of active keyboard key at a point in time

Public struct

FMouseInputDeviceState

Current State of a physical Mouse device at a point in time.

Public class

FPrimitiveComponentTarget

Wrapper around a UObject Component that can provide a MeshDescription, and (optionally) bake a modified MeshDescription back to this Component.

Public struct

FSelectedOjectsChangeList

Represents a change to a set of selected Actors and Components

Public struct

FToolBuilderState

FToolBuilderState is a bucket of state information that a ToolBuilder might need to construct a Tool.

Public class

FToolChangeWrapperChange

FToolChangeWrapperChange wraps an FChange emitted by an InteractiveTool, allowing us to Expire the change without each FChange implementation needing to handle this explicitly.

Public class

FToolCommandChange

FToolCommandChange is a base class for command changes used by the Tools Framework.

Public struct

FToolContextSnappingConfiguration

Snapping configuration settings/state

Public class

FToolDataVisualizer

FToolDataVisualizer is a utility class for Tool and Gizmo implementations to use to draw 3D lines, points, etc.

Public struct

FViewCameraState

FViewCameraState is a bucket of state information that a Tool might need to implement interactions that depend on the current scene view.

Public class

FWatchablePropertySet

Public class

IInputBehaviorSource

UObjects that implement IInputBehaviorSource have an UInputBehaviorSet that they can provide (to UInputRouter, primarily)

Public class

IInteractiveToolCameraFocusAPI

IInteractiveToolCameraFocusAPI provides two functions that can be used to extract "Focus" / "Region of Interest" information about an active Tool:

Public class

IInteractiveToolExclusiveToolAPI

IInteractiveToolExclusiveToolAPI provides an API to inform the ToolManager about tool exclusivity.

Public class

IInteractiveToolNestedAcceptCancelAPI

IInteractiveToolNestedAcceptCancelAPI provides an API for a Tool to publish intent and ability to Accept or Cancel sub-operations.

Public class

IToolCommandChangeSource

IToolCommandChangeSource is a generic interface for generating a change object.

Public class

IToolContextTransactionProvider

IToolContextTransactionProvider is a UInterface that defines several functions that InteractiveTool code uses to interface with the higher-level transaction system.

Public class

IToolFrameworkComponent

IToolFrameworkComponent is an interface we can attach to custom Components used in the Tools framework.

Public class

IToolsContextQueriesAPI

Users of the Tools Framework need to implement IToolsContextQueriesAPI to provide access to scene state information like the current UWorld, active USelections, etc.

Public class

IToolsContextRenderAPI

Users of the Tools Framework need to implement IToolsContextRenderAPI to allow Tools, Indicators, and Gizmos to make low-level rendering calls for things like line drawing.

Public class

IToolsContextTransactionsAPI

Users of the Tools Framework need to implement IToolsContextTransactionsAPI so that the Tools have the ability to create Transactions and emit Changes.

Public class

TWrappedToolCommandChange

Holds another Change and forwards Apply/Revert to it, with calls to Before/After lambas, allowing client classes to respond to a change without having to intercept it explicitly.

Public class

UContextObjectStore

A context object store allows tools to get access to arbitrary objects which expose data or APIs to enable additional functionality.

Public class

UInputBehavior

An InputBehavior implements a state machine for a user interaction.

Public class

UInputBehaviorSet

UInputBehaviorSet manages a set of UInputBehaviors, and provides various functions to query and forward events to the set.

Public class

UInputBehaviorSource

UInterface for IInputBehavior.

Public class

UInputRouter

UInputRouter mediates between a higher-level input event source (eg like an FEdMode) and a set of InputBehaviors that respond to those events.

Public class

UInteractionMechanic

A UInteractionMechanic implements a "user interaction".

Public class

UInteractiveGizmo

UInteractiveGizmo is the base class for all Gizmos in the InteractiveToolsFramework.

Public class

UInteractiveGizmoBuilder

A UInteractiveGizmoBuilder creates a new instance of an InteractiveGizmo (basically this is a Factory).

Public class

UInteractiveGizmoManager

UInteractiveGizmoManager allows users of the Tools framework to create and operate Gizmo instances.

Public class

UInteractiveTool

UInteractiveTool is the base class for all Tools in the InteractiveToolsFramework.

Public class

UInteractiveToolBuilder

A UInteractiveToolBuilder creates a new instance of an InteractiveTool (basically this is a Factory).

Public class

UInteractiveToolCameraFocusAPI

UInterface for IInteractiveToolCameraFocusAPI.

Public class

UInteractiveToolExclusiveToolAPI

UInterface for IInteractiveToolExclusiveToolAPI.

Public class

UInteractiveToolManager

UInteractiveToolManager allows users of the tools framework to create and operate Tool instances.

Public class

UInteractiveToolNestedAcceptCancelAPI

UInterface for IInteractiveToolNestedAcceptCancelAPI.

Public class

UInteractiveToolPropertySet

A UInteractiveTool contains a set of UObjects that contain "properties" of the Tool, ie the configuration flags, parameters, etc that control the Tool.

Public class

UInteractiveToolsContext

InteractiveToolsContext owns the core parts of an Interactive Tools Framework implementation - the InputRouter, ToolManager, GizmoManager, TargetManager, and ContextStore.

Public class

UInteractiveToolWithToolTargetsBuilder

A UInteractiveToolWithToolTargetsBuilder creates a new instance of an InteractiveTool that uses tool targets.

Public class

ULocalInputBehaviorSource

An implementation of IInputBehaviorSource that forwards to a user provided-lambda, to allow a tool to supply a behavior source different from the one it is implementing itself.

Public class

UMeshSelectionSet

UMeshSelectionSet is an implementation of USelectionSet that represents selections on indexed meshes.

Public class

UMultiSelectionTool

Public class

USelectionSet

USelectionSet is a base class for Selection objects.

Public class

USingleSelectionTool

Public class

UToolContextTransactionProvider

Public class

UToolFrameworkComponent

UInterface for IToolFrameworkComponent.

Public class

UToolTargetManager

TODO: Do we need more control over factory order to prioritize which gets used if we can make multiple qualifying targets? It should theoretically not matter, but in practice, one target or another could be more efficient for certain tasks.

Typedefs

Enums

Name

Description

Public enum

EInputCaptureRequestType

Used by FInputCaptureRequest to indicate whether the InputBehavior wants to capture or ignore an input event

Public enum

EInputCaptureSide

Input can be captured separately for Left and Right sides (eg for VR controllers) Currently mouse is Left.

Public enum

EInputCaptureState

FInputCaptureUpdate uses this type to indicate what state the capturing Behavior would like to transition to, based on the input event

Public enum

EInputDevices

Input event data can be applicable to many possible input devices.

Public enum

EMeshSelectionElementType

Public enum

ESelectedObjectsModificationType

Type of change we want to apply to a selection

Public enum

EStandardToolActions

Standard Actions that can be shared across multiple Tools.

Public enum

EStandardToolContextMaterials

Types of standard materials that Tools may request from Context

Public enum

EToolChangeTrackingMode

UInteractiveToolManager can emit change events for the active tool in various ways.

Public enum

EToolContextCoordinateSystem

Types of coordinate systems that a Tool/Gizmo might use

Public enum

EToolMessageLevel

Level of severity of messages emitted by Tool framework

Public enum

EToolShutdownType

Passed to UInteractiveTool::Shutdown to indicate how Tool should shut itself down

Public enum

EToolSide

A Tool can be activated on a particular input device, currently identified by a "side"

Public enum

ETransformGizmoSubElements

ETransformGizmoSubElements identifies the sub-elements of a standard 3-axis transformation Gizmo.

Public enum

EViewInteractionState

Functions

Name Description

Public function

int32

 

AddComponentTargetFactory

(
    TUniquePtr< FComponentTargetFactory...
)

Add tool target factories to the tool target manager instead.

Public function

bool

 

CanMakeComponentTarget

(
    UActorComponent* Component
)

Ask your tool target manager instead.

Public function

FComponentTa...

 

FindComponentTargetFactoryByKey

(
    int32 Key
)

Public function

TUniquePtr< ...

 

MakeComponentTarget

(
    UPrimitiveComponent* Component
)

Ask your tool target manager to build a target for you instead.

Public function

constexpr bo...

 

operator!

(
    EViewInteractionState E
)

Public function

constexpr bo...

 

operator!

(
    ETransformGizmoSubElements E
)

Public function

constexpr bo...

 

operator!

(
    EInputDevices E
)

Public function

constexpr EV...

 

operator&

(
    EViewInteractionState Lhs,
    EViewInteractionState Rhs
)

Public function

constexpr ET...

 

operator&

(
    ETransformGizmoSubElements Lhs,
    ETransformGizmoSubElements Rhs
)

Public function

constexpr EI...

 

operator&

(
    EInputDevices Lhs,
    EInputDevices Rhs
)

Public function

EViewInterac...

 

operator&=

(
    EViewInteractionState& Lhs,
    EViewInteractionState Rhs
)

Public function

EInputDevice...

 

operator&=

(
    EInputDevices& Lhs,
    EInputDevices Rhs
)

Public function

ETransformGi...

 

operator&=

(
    ETransformGizmoSubElements& Lhs,
    ETransformGizmoSubElements Rhs
)

Public function

constexpr EV...

 

operator^

(
    EViewInteractionState Lhs,
    EViewInteractionState Rhs
)

Public function

constexpr ET...

 

operator^

(
    ETransformGizmoSubElements Lhs,
    ETransformGizmoSubElements Rhs
)

Public function

constexpr EI...

 

operator^

(
    EInputDevices Lhs,
    EInputDevices Rhs
)

Public function

EViewInterac...

 

operator^=

(
    EViewInteractionState& Lhs,
    EViewInteractionState Rhs
)

Public function

ETransformGi...

 

operator^=

(
    ETransformGizmoSubElements& Lhs,
    ETransformGizmoSubElements Rhs
)

Public function

EInputDevice...

 

operator^=

(
    EInputDevices& Lhs,
    EInputDevices Rhs
)

Public function

constexpr EV...

 

operator|

(
    EViewInteractionState Lhs,
    EViewInteractionState Rhs
)

Public function

constexpr ET...

 

operator|

(
    ETransformGizmoSubElements Lhs,
    ETransformGizmoSubElements Rhs
)

Public function

constexpr EI...

 

operator|

(
    EInputDevices Lhs,
    EInputDevices Rhs
)

Public function

EViewInterac...

 

operator|=

(
    EViewInteractionState& Lhs,
    EViewInteractionState Rhs
)

Public function

ETransformGi...

 

operator|=

(
    ETransformGizmoSubElements& Lhs,
    ETransformGizmoSubElements Rhs
)

Public function

EInputDevice...

 

operator|=

(
    EInputDevices& Lhs,
    EInputDevices Rhs
)

Public function

constexpr EI...

 

operator~

(
    EInputDevices E
)

Public function

constexpr EV...

 

operator~

(
    EViewInteractionState E
)

Public function

constexpr ET...

 

operator~

(
    ETransformGizmoSubElements E
)

Public function

void

 

RemoveAllComponentTargetFactoryies()

Remove all registered ComponentTargetFactory objects

Public function

bool

 

RemoveComponentTargetFactoryByKey

(
    int32 Key
)

Public function

INTERACTIVET...

 

ToolBuilderUtil::CountActors

(
    const FToolBuilderState& InputStat...,
    const TFunction< bool*)...
)

Count number of selected Actors that pass predicate.

Public function

INTERACTIVET...

 

ToolBuilderUtil::CountComponents

(
    const FToolBuilderState& InputStat...,
    const TFunction< bool...
)

Count number of selected components that pass predicate.

Public function

int

 

ToolBuilderUtil::CountSelectedActorsOfType

(
    const FToolBuilderState& InputStat...
)

Count number of selected Actors of given type.

Public function

int

 

ToolBuilderUtil::CountSelectedComponentsOfType

(
    const FToolBuilderState& InputStat...
)

Count number of components of given type.

Public function

INTERACTIVET...

 

ToolBuilderUtil::EnumerateComponents

(
    const FToolBuilderState& InputStat...,
    TFunctionRef< void ...
)

Public function

INTERACTIVET...

 

ToolBuilderUtil::FindAllActors

(
    const FToolBuilderState& InputStat...,
    const TFunction< bool*)...
)

First all Actors that pass predicate. Searches Actors selection list.

Public function

INTERACTIVET...

 

ToolBuilderUtil::FindAllComponents

(
    const FToolBuilderState& InputStat...,
    const TFunction< bool...
)

First all components that passes predicate.

Public function

INTERACTIVET...

 

ToolBuilderUtil::FindFirstActor

(
    const FToolBuilderState& InputStat...,
    const TFunction< bool*)...
)

First first available Actor that passes predicate. Searches Actors selection list.

Public function

ActorType &#...

 

ToolBuilderUtil::FindFirstActorOfType

(
    const FToolBuilderState& InputStat...
)

Find first first available Actor of given type, or return nullptr if not found

Public function

INTERACTIVET...

 

ToolBuilderUtil::FindFirstComponent

(
    const FToolBuilderState& InputStat...,
    const TFunction< bool...
)

First first available component that passes predicate.

Public function

ComponentTyp...

 

ToolBuilderUtil::FindFirstComponentOfType

(
    const FToolBuilderState& InputStat...
)

First first available component of given type.