Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > InteractiveToolsFramework > UInteractiveTool

Light Theme

Dark Theme

UInteractiveTool

[UInteractiveTool](API\Runtime\InteractiveToolsFramework\UInteractiveTool) is the base class for all Tools in the InteractiveToolsFramework.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

UBspConversionTool

UClickDragTool

UDrawAndRevolveTool

UDrawPolygonTool

UDrawPolyPathTool

UGroomToMeshTool

UMultiSelectionTool

USingleClickTool

UAddPatchTool

UAddPrimitiveTool

	UAddArrowPrimitiveTool
	UAddBoxPrimitiveTool
	UAddConePrimitiveTool
	UAddCylinderPrimitiveTool
	UAddDiscPrimitiveTool
	UAddPuncturedDiscPrimitiveTool
	UAddRectanglePrimitiveTool
	UAddRoundedRectanglePrimitiveTool
	UAddSpherePrimitiveTool
	UAddSphericalBoxPrimitiveTool
	UAddTorusPrimitiveTool

UMeshClickTool

	UTextureAdapterClickTool
	UVertexAdapterClickTool

USingleSelectionTool

UBaseMeshProcessingTool

	UOffsetMeshTool
	USmoothMeshTool

UConvertToPolygonsTool

UDisplaceMeshTool

UEdgeLoopInsertionTool

UExtractCollisionGeometryTool

UGenerateLODMeshesTool

UGroupEdgeInsertionTool

UHoleFillTool

UMeshBoundaryToolBase

URevolveBoundaryTool

UMeshInspectorTool

UMeshSurfacePointTool

UMeshTangentsTool

UMeshToVolumeTool

UParameterizeMeshTool

UPolygonOnMeshTool

USimplifyMeshTool

UWeldMeshEdgesTool

UVolumeToMeshTool

References

Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/InteractiveTool.h
Include	#include "InteractiveTool.h"

Syntax

class UInteractiveTool :
public UObject,
public IInputBehaviorSource

Remarks

UInteractiveTool is the base class for all Tools in the InteractiveToolsFramework. A Tool is is a "lightweight mode" that may "own" one or more Actors/Components/etc in the current scene, may capture certain input devices or event streams, and so on. The base implementation essentially does nothing but provide sane default behaviors.

The BaseTools/ subfolder contains implementations of various kinds of standard "tool behavior", like a tool that responds to a mouse click, etc, that can be extended to implement custom behaviors.

In the framework, you do not create instances of UInteractiveTool yourself. You provide a UInteractiveToolBuilder implementation that can properly construct an instance of your Tool, this is where for example default parameters would be set. The ToolBuilder is registered with the ToolManager, and then UInteractiveToolManager::ActivateTool() is used to kick things off.

Variables

	Name	Description
UInputBehaviorS...	InputBehaviors	The current set of InputBehaviors provided by this Tool
OnInteractiveTo...	OnPropertySetsModified
TArray< UObject...	ToolPropertyObjects	The current set of Property UObjects provided by this Tool. May contain pointer to itself.

Constructors

	Name	Description
	UInteractiveTool()

Functions

	Name	Description
void	AddInputBehavior ( UInputBehavior* Behavior )	Input Behaviors support Add an input behavior for this Tool
void	AddToolPropertySource ( UObject* PropertyObject )	Add a Property object for this Tool
void	AddToolPropertySource ( UInteractiveToolPropertySet* P... )	Add a PropertySet object for this Tool
bool	CanAccept()
void	DrawHUD ( FCanvas* Canvas, IToolsContextRenderAPI* Render... )	Allow the Tool to do any custom screen space drawing
void	ExecuteAction ( int32 ActionID )	Request that the Action identified by ActionID be executed.
FInteractive...	GetActionSet()	Get the internal Action Set for this Tool. The action set is created and registered on-demand.
FInteractive...	GetToolInfo()	Tool Information (name, icon, help text, etc)
UInteractive...	GetToolManager()
TArray< UObj...	GetToolProperties ( bool bEnabledOnly )	Property support
bool	HasAccept()
bool	HasCancel()
void	OnPropertyModified ( UObject* PropertySet, FProperty* Property )	Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
void	RegisterActions ( FInteractiveToolActionSet& ActionS... )	Override this function to register the set of Actions this Tool supports, using FInteractiveToolActionSet::RegisterAction.
bool	RemoveToolPropertySource ( UInteractiveToolPropertySet* P... )	Remove a PropertySet object from this Tool. If found, will broadcast OnPropertySetsModified
void	Render ( IToolsContextRenderAPI* Render... )	Allow the Tool to do any custom drawing (ie via PDI/RHI)
bool	ReplaceToolPropertySource ( UInteractiveToolPropertySet* C..., UInteractiveToolPropertySet* R..., bool bSetToEnabled )	Replace a PropertySet object on this Tool with another property set.
void	SetToolDisplayName ( const FText& NewName )	Set Tool name
void	SetToolInfo ( const FInteractiveToolInfo& NewInf... )	Replace existing ToolInfo with new data
bool	SetToolPropertySourceEnabled ( UInteractiveToolPropertySet* P..., bool bEnabled )	Enable/Disable a PropertySet object for this Tool.
void	Setup()	Called by ToolManager to initialize the Tool after ToolBuilder::BuildTool() has been called
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool
void	Tick ( float DeltaTime )	Non overrideable func which does processing and calls the tool's OnTick

Overridden from IInputBehaviorSource

		Name	Description
	const UInput...	GetInputBehaviors()

Typedefs

Name	Description
OnInteractiveToolPropertySetsModified	OnPropertySetsModified is broadcast whenever the contents of the ToolPropertyObjects array is modified

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss