1. Epic GamesDeveloper
  3. InteractiveToolsFramework

InteractiveToolsFramework

API > API/Runtime

Filters

Classes

  Type Name Description
Public class UClass MinimalAPI NotPlaceable Transient hidden, notblueprintable, notblueprinttype 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 UStruct FActiveGizmo    
Public class FBeginToolChange FBeginToolChange is used by UInteractiveToolManager to back out of a Tool on Undo.  
Public struct UStruct FBehaviorInfo This is an internal structure used by UInputBehaviorSet.  
Public class FComponentTargetFactory    
Public struct UStruct BlueprintType 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 UStruct BlueprintType FInputDeviceRay FInputDeviceRay represents a 3D ray created based on an input device.  
Public struct UStruct BlueprintType FInputDeviceState Current state of physical input devices at a point in time.  
Public struct UStruct BlueprintType 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 UStruct BlueprintType FKeyboardInputDeviceState Current state of active keyboard key at a point in time  
Public struct UStruct BlueprintType 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 FSelectedObjectsChangeList 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 IInteractiveToolEditorGizmoAPI IInteractiveToolEditorGizmoAPI provides an API to indicate whether the standard editor gizmos can be enabled while this tool is active.  
Public class IInteractiveToolExclusiveToolAPI IInteractiveToolExclusiveToolAPI provides an API to inform the ToolManager about tool exclusivity.  
Public class IInteractiveToolManageGeometrySelectionAPI Provides an API to allow a tool to report how it has affected (updated or invalidated) geometry selections on the tool's targets  
Public class IInteractiveToolNestedAcceptCancelAPI IInteractiveToolNestedAcceptCancelAPI provides an API for a Tool to publish intent and ability to Accept or Cancel sub-operations.  
Public class IInteractiveToolShutdownQueryAPI Allows an interactive tool to influence the way it is shut down, if the tool host supports that kind of customization.  
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 UClass MinimalAPI Transient UContextObjectStore A context object store allows tools to get access to arbitrary objects which expose data or APIs to enable additional functionality.  
Public class UClass MinimalAPI Transient UInputBehavior An InputBehavior implements a state machine for a user interaction.  
Public class UClass MinimalAPI Transient 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 UClass MinimalAPI Transient 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 UClass MinimalAPI Transient UInteractionMechanic A UInteractionMechanic implements a "user interaction".  
Public class UClass Abstract, MinimalAPI UInteractiveCommand A UInteractiveCommand is an atomic action that can be executed via some user interaction.  
Public class UClass MinimalAPI UInteractiveCommandArguments UInteractiveCommandArguments are arguments passed to a UInteractiveCommand.  
Public class UClass MinimalAPI UInteractiveCommandResult UInteractiveCommandResult subclasses are returned from UInteractiveCommands, to allow commands to return custom information.  
Public class UClass MinimalAPI Transient UInteractiveGizmo UInteractiveGizmo is the base class for all Gizmos in the InteractiveToolsFramework.  
Public class UClass Abstract, MinimalAPI Transient UInteractiveGizmoBuilder A UInteractiveGizmoBuilder creates a new instance of an InteractiveGizmo (basically this is a Factory).  
Public class UClass MinimalAPI Transient UInteractiveGizmoManager UInteractiveGizmoManager allows users of the Tools framework to create and operate Gizmo instances.  
Public class UClass MinimalAPI Transient UInteractiveTool UInteractiveTool is the base class for all Tools in the InteractiveToolsFramework.  
Public class UClass Abstract, MinimalAPI Transient UInteractiveToolBuilder A UInteractiveToolBuilder creates a new instance of an InteractiveTool (basically this is a Factory).  
Public class UInteractiveToolCameraFocusAPI UInterface for IInteractiveToolCameraFocusAPI.  
Public class UInteractiveToolEditorGizmoAPI UInterface for IInteractiveToolEditorGizmoAPI.  
Public class UInteractiveToolExclusiveToolAPI UInterface for IInteractiveToolExclusiveToolAPI.  
Public class UInteractiveToolManageGeometrySelectionAPI UInterface for IInteractiveToolManageGeometrySelectionAPI.  
Public class UClass MinimalAPI Transient UInteractiveToolManager UInteractiveToolManager allows users of the tools framework to create and operate Tool instances.  
Public class UInteractiveToolNestedAcceptCancelAPI UInterface for IInteractiveToolNestedAcceptCancelAPI.  
Public class UClass MinimalAPI Transient 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 UClass MinimalAPI Transient UInteractiveToolsContext InteractiveToolsContext owns the core parts of an Interactive Tools Framework implementation - the InputRouter, ToolManager, GizmoManager, TargetManager, and ContextStore.  
Public class UInteractiveToolShutdownQueryAPI UInterface for IInteractiveToolShutdownQueryAPI.  
Public class UClass Abstract, MinimalAPI Transient UInteractiveToolWithToolTargetsBuilder A UInteractiveToolWithToolTargetsBuilder creates a new instance of an InteractiveTool that uses tool targets.  
Public class UClass MinimalAPI Transient 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 UClass MinimalAPI Transient UMeshSelectionSet UMeshSelectionSet is an implementation of USelectionSet that represents selections on indexed meshes.  
Public class UClass MinimalAPI Transient UMultiSelectionTool    
Public class UClass MinimalAPI Transient USelectionSet USelectionSet is a base class for Selection objects.  
Public class UClass MinimalAPI Transient USingleSelectionTool    
Public class UToolContextTransactionProvider    
Public class UToolFrameworkComponent UInterface for IToolFrameworkComponent.  
Public class UClass UToolsContextCursorAPI Users of the Tools Framework can use UToolsContextCursorAPI to access to setting and retrieving cursor overrides for tool activities.  
Public class UClass MinimalAPI Transient 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

Name Description
FInteractiveToolPropertySetModifiedSignature This delegate is used by UInteractiveToolPropertySet
FSelectedOjectsChangeList  
FSelectionSetModifiedSignature This delegate is used by UInteractiveToolPropertySet

Enums

  Type Name Description
Public enum UEnum EInputCaptureRequestType Used by FInputCaptureRequest to indicate whether the InputBehavior wants to capture or ignore an input event  
Public enum UEnum EInputCaptureSide Input can be captured separately for Left and Right sides (eg for VR controllers) Currently mouse is Left.  
Public enum UEnum EInputCaptureState FInputCaptureUpdate uses this type to indicate what state the capturing Behavior would like to transition to, based on the input event  
Public enum UEnum EInputDevices Input event data can be applicable to many possible input devices.  
Public enum EMeshSelectionElementType    
Public enum UEnum 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 UEnum EStandardToolContextMaterials Types of standard materials that Tools may request from Context  
Public enum UEnum EToolChangeTrackingMode UInteractiveToolManager can emit change events for the active tool in various ways.  
Public enum UEnum EToolContextCoordinateSystem Types of coordinate systems that a Tool/Gizmo might use  
Public enum UEnum EToolContextTransformGizmoMode High-level configuration options for a standard 3D translate/rotate/scale Gizmo, like is commonly used in 3D DCC tools, game editors, etc This is meant to be used to convey UI-level settings to Tools/Gizmos, eg like the W/E/R toggles for Rranslate/Rotate/Scale in Maya or UE Editor.  
Public enum UEnum EToolManagerToolSwitchMode Determines how a currently active tool is shutdown when switching to another tool.  
Public enum UEnum EToolMessageLevel Level of severity of messages emitted by Tool framework  
Public enum UEnum BlueprintType EToolShutdownType Passed to UInteractiveTool::Shutdown to indicate how Tool should shut itself down  
Public enum UEnum EToolSide A Tool can be activated on a particular input device, currently identified by a "side"  
Public enum UEnum ETransformGizmoSubElements ETransformGizmoSubElements identifies the sub-elements of a standard 3-axis transformation Gizmo.  
Public enum UEnum EViewInteractionState    

Functions

  Type Name Description
Public function int32 Add a factory method to make ComponentTarget from UPrimitiveComponent*
Public function bool

CanMakeComponentTarget ( UActorComponent* Component
)

 Determine whether a TargetComponent can be created for the given Component
Public function    
Public function    
Public function    
Public function FComponentTargetFactory *  
Public function TUniquePtr< FPrimitiveComponentTarget >

MakeComponentTarget ( UPrimitiveComponent* Component
)

 Create a TargetComponent for the given Component
Public function void Remove all registered ComponentTargetFactory objects
Public function bool  
Public function INTERACTIVETOOLSFRAMEWORK_API bool

ToolBuilderUtil::ComponentTypeCouldHaveUVs ( const UActorComponent& Component
)

 Determine if component support UVs.
Public function INTERACTIVETOOLSFRAMEWORK_API int32

ToolBuilderUtil::CountActors ( const FToolBuilderState& InputState,
const TFunction< bool(AActor*)>& Predicate
)

 Count number of selected Actors that pass predicate.
Public function INTERACTIVETOOLSFRAMEWORK_API int

ToolBuilderUtil::CountComponents ( const FToolBuilderState& InputState,
const TFunction< bool(UActorComponent*)>& Predicate
)

 Count number of selected components that pass predicate.
Public function int Count number of selected Actors of given type.
Public function int Count number of components of given type.
Public function INTERACTIVETOOLSFRAMEWORK_API void

ToolBuilderUtil::EnumerateComponents ( const FToolBuilderState& InputState,
TFunctionRef< void(UActorComponent*)> ComponentFunc
)

  
Public function INTERACTIVETOOLSFRAMEWORK_API TArray< AActor * >

ToolBuilderUtil::FindAllActors ( const FToolBuilderState& InputState,
const TFunction< bool(AActor*)>& Predicate
)

 First all Actors that pass predicate. Searches Actors selection list.
Public function INTERACTIVETOOLSFRAMEWORK_API TArray< UActorComponent * >

ToolBuilderUtil::FindAllComponents ( const FToolBuilderState& InputState,
const TFunction< bool(UActorComponent*)>& Predicate
)

 First all components that passes predicate.
Public function INTERACTIVETOOLSFRAMEWORK_API AActor *

ToolBuilderUtil::FindFirstActor ( const FToolBuilderState& InputState,
const TFunction< bool(AActor*)>& Predicate
)

 First first available Actor that passes predicate. Searches Actors selection list.
Public function ActorType * Find first first available Actor of given type, or return nullptr if not found
Public function INTERACTIVETOOLSFRAMEWORK_API UActorComponent *

ToolBuilderUtil::FindFirstComponent ( const FToolBuilderState& InputState,
const TFunction< bool(UActorComponent*)>& Predicate
)

 First first available component that passes predicate.
Public function ComponentType * First first available component of given type.
Public function INTERACTIVETOOLSFRAMEWORK_API bool

ToolBuilderUtil::IsVolume ( const UActorComponent& Component
)

 Determine if component is a volume or not.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page