InteractiveToolsFramework

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public struct

FActiveGizmo

Public struct

FBehaviorInfo

This is an internal structure used by UInputBehaviorSet.

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

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 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 struct

FSceneSnapQueryRequest

Configuration variables for a IToolsContextQueriesAPI snap query request.

Public struct

FSceneSnapQueryResult

Computed result of a IToolsContextQueriesAPI snap query request

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 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

IComponentSourceFactory

Interface to a Factory that knows how to build Sources for UObjects.

Public class

IInputBehaviorSource

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

Public class

IMeshDescriptionSource

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

Public class

IToolsContextAssetAPI

Users of the Tools Framework need to provide an IToolsContextAssetAPI implementation that allows Packages and Assets to be created/saved.

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

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

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

UInteractiveToolManager

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

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 a ToolManager and an InputRouter.

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

ESceneSnapQueryTargetType

Types of snap targets that a Tool may want to run snap queries against.

Public enum

ESceneSnapQueryType

Types of Snap Queries that a ToolsContext parent may support, that Tools may request

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

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"

Functions

Name Description

Public function

constexpr bo...

 

operator!

(
    EInputDevices E
)

Public function

constexpr bo...

 

operator!

Public function

constexpr EI...

 

operator&

(
    EInputDevices Lhs,
    EInputDevices Rhs
)

Public function

constexpr ES...

 

operator&

Public function

EInputDevice...

 

operator&=

(
    EInputDevices& Lhs,
    EInputDevices Rhs
)

Public function

ESceneSnapQu...

 

operator&=

Public function

constexpr EI...

 

operator^

(
    EInputDevices Lhs,
    EInputDevices Rhs
)

Public function

constexpr ES...

 

operator^

Public function

ESceneSnapQu...

 

operator^=

Public function

EInputDevice...

 

operator^=

(
    EInputDevices& Lhs,
    EInputDevices Rhs
)

Public function

constexpr ES...

 

operator|

Public function

constexpr EI...

 

operator|

(
    EInputDevices Lhs,
    EInputDevices Rhs
)

Public function

ESceneSnapQu...

 

operator|=

Public function

EInputDevice...

 

operator|=

(
    EInputDevices& Lhs,
    EInputDevices Rhs
)

Public function

constexpr ES...

 

operator~

Public function

constexpr EI...

 

operator~

(
    EInputDevices E
)

Public function

INTERACTIVET...

 

ToolBuilderUtil::CountComponents

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

Count number of selected components that pass predicate.

Public function

int

 

ToolBuilderUtil::CountSelectedComponentsOfType

(
    const FToolBuilderState& InputStat...
)

Count number of components of given type.

Public function

INTERACTIVET...

 

ToolBuilderUtil::FindAllComponents

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

First all components that passes predicate.

Public function

INTERACTIVET...

 

ToolBuilderUtil::FindFirstComponent

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

First first available component that passes predicate.

Public function

ComponentTyp...

 

ToolBuilderUtil::FindFirstComponentOfType

(
    const FToolBuilderState& InputStat...
)

First first available component of given type.

Public function

INTERACTIVET...

 

ToolBuilderUtil::IsMeshDescriptionSourceComponent

(
    UActorComponent* ComponentObje...
)

Returns true if this UObject can provide a FMeshDescription

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback