UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
InteractiveTool.h File Reference
#include "Containers/Array.h"
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "InputBehaviorSet.h"
#include "InteractiveToolActionSet.h"
#include "Internationalization/Text.h"
#include "Misc/AssertionMacros.h"
#include "Misc/Optional.h"
#include "Shader.h"
#include "Templates/EnableIf.h"
#include "Templates/Function.h"
#include "Templates/Models.h"
#include "Templates/UniquePtr.h"
#include "Templates/UnrealTemplate.h"
#include "ToolContextInterfaces.h"
#include "UObject/Class.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "UObject/Package.h"
#include "UObject/UObjectGlobals.h"
#include "InteractiveTool.generated.h"

Go to the source code of this file.

Classes

struct  FInteractiveToolInfo
 
class  FWatchablePropertySet
 
class  FWatchablePropertySet::FPropertyWatcher
 
class  FWatchablePropertySet::TPropertyWatcher< PropType >
 
struct  FWatchablePropertySet::TPropertyWatcher< PropType >::CInequalityComparable
 
class  UInteractiveToolPropertySet
 
class  UInteractiveTool
 

Enumerations

enum class  EToolShutdownType : uint8 { Completed = 0 , Accept = 1 , Cancel = 2 }
 
enum class  EToolShutdownReason : uint8 { Unspecified = 0 , SwitchTool = 1 }
 

Functions

 DECLARE_MULTICAST_DELEGATE_TwoParams (FInteractiveToolPropertySetModifiedSignature, UObject *, FProperty *)
 

Enumeration Type Documentation

◆ EToolShutdownReason

enum class EToolShutdownReason : uint8
strong

Used in various ways by the tool manager and some optional tool interfaces to make shutdown responses configurable.

Enumerator
Unspecified 

The reason for the shutdown was left unspecified.

SwitchTool 

Another tool is being activated without the user having explicitly shut down this one.

◆ EToolShutdownType

enum class EToolShutdownType : uint8
strong

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

Enumerator
Completed 

Tool cleans up and exits. Pass this to tools that do not have Accept/Cancel options.

Accept 

Tool commits current preview to scene

Cancel 

Tool discards current preview without modifying scene

Function Documentation

◆ DECLARE_MULTICAST_DELEGATE_TwoParams()

DECLARE_MULTICAST_DELEGATE_TwoParams ( FInteractiveToolPropertySetModifiedSignature  ,
UObject ,
FProperty  
)

This delegate is used by UInteractiveToolPropertySet