UInteractiveToolBuilder

A [UInteractiveToolBuilder](API\Runtime\InteractiveToolsFramework\UInteractiveToolBuilder) creates a new instance of an InteractiveTool (basically this is a Factory).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveToolBuilder

UAddPatchToolBuilder

UAddPrimitiveToolBuilder

UBspConversionToolBuilder

UClickDragToolBuilder

UDrawAndRevolveToolBuilder

UDrawPolygonToolBuilder

UGroomToMeshToolBuilder

UInteractiveToolWithToolTargetsBuilder

UBaseMeshProcessingToolBuilder

UOffsetMeshToolBuilder

USmoothMeshToolBuilder

UCubeGridToolBuilder

UMeshSurfacePointToolBuilder

UDrawPolyPathToolBuilder

UMeshSurfacePointMeshEditingToolBuilder

UDeformMeshPolygonsToolBuilder

UDynamicMeshSculptToolBuilder

UEditUVIslandsToolBuilder

UGroomCardsEditorToolBuilder

UMeshAttributePaintToolBuilder

UMeshGroupPaintToolBuilder

UMeshSelectionToolBuilder

UEditMeshMaterialsToolBuilder

UMeshVertexSculptToolBuilder

USeamSculptToolBuilder

UShapeSprayToolBuilder

USkinWeightsPaintToolBuilder

UMultiSelectionMeshEditingToolBuilder

UAddPivotActorToolBuilder

UAlignObjectsToolBuilder

UAttributeEditorToolBuilder

UBakeMeshAttributeMapsToolBuilder

UBakeMeshAttributeVertexToolBuilder

UBakeMultiMeshAttributeMapsToolBuilder

UBakeTransformToolBuilder

UBaseCreateFromSelectedToolBuilder

UCSGMeshesToolBuilder

UCutMeshWithMeshToolBuilder

USelfUnionMeshesToolBuilder

UVoxelBlendMeshesToolBuilder

UVoxelMorphologyMeshesToolBuilder

UVoxelSolidifyMeshesToolBuilder

UCombineMeshesToolBuilder

UConvertMeshesToolBuilder

UEditNormalsToolBuilder

UEditPivotToolBuilder

UGenerateStaticMeshLODAssetToolBuilder

ULODManagerToolBuilder

UMergeMeshesToolBuilder

UMirrorToolBuilder

UPhysicsInspectorToolBuilder

UPlaneCutToolBuilder

UProjectToTargetToolBuilder

URemeshMeshToolBuilder

URemoveOccludedTrianglesToolBuilder

USetCollisionGeometryToolBuilder

USkinWeightsBindingToolBuilder

USplitMeshesToolBuilder

UTransferMeshToolBuilder

UTransformMeshesToolBuilder

UUVLayoutToolBuilder

UVoxelCSGMeshesToolBuilder

USingleSelectionMeshEditingToolBuilder

UConvertToPolygonsToolBuilder

UDisplaceMeshToolBuilder

UEditMeshPolygonsToolBuilder

UEditMeshPolygonsActionModeToolBuilder

UEditMeshPolygonsSelectionModeToolBuilder

UExtractCollisionGeometryToolBuilder

UGenerateLODMeshesToolBuilder

UHoleFillToolBuilder

ULatticeDeformerToolBuilder

UMeshInspectorToolBuilder

UMeshSpaceDeformerToolBuilder

UMeshTangentsToolBuilder

UMeshToVolumeToolBuilder

UParameterizeMeshToolBuilder

UPolygonOnMeshToolBuilder

URecomputeUVsToolBuilder

URevolveBoundaryToolBuilder

USimplifyMeshToolBuilder

USubdividePolyToolBuilder

UUVProjectionToolBuilder

UWeldMeshEdgesToolBuilder

UMeshColorPaintingToolBuilder

UMeshTexturePaintingToolBuilder

UMeshWeightPaintingToolBuilder

UMotionTrailToolBuilder

USequencerPivotToolBuilder

USingleClickToolBuilder

UTextureAdapterClickToolBuilder

UVertexAdapterClickToolBuilder

UUVEditorChannelEditToolBuilder

UUVEditorLayoutToolBuilder

UUVEditorParameterizeMeshToolBuilder

UUVEditorRecomputeUVsToolBuilder

UUVEditorSeamToolBuilder

UUVSelectToolBuilder

UVolumeToMeshToolBuilder

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolBuilder.h

Include

#include "InteractiveToolBuilder.h"

Syntax

class UInteractiveToolBuilder : public UObject

Remarks

A UInteractiveToolBuilder creates a new instance of an InteractiveTool (basically this is a Factory). These are registered with the InteractiveToolManager, which calls BuildTool() if CanBuildTool() returns true. In addition CanBuildTool() will be queried to (for example) enable/disable UI buttons, etc. This is an abstract base class, you must subclass it in order to create your particular Tool instance

Functions

Name Description

Public function Virtual Const

UInteractive...

 

BuildTool

(
    const FToolBuilderState& SceneStat...
)

Create a new instance of this builder's Tool

Public function Virtual Const

bool

 

CanBuildTool

(
    const FToolBuilderState& SceneStat...
)

Check if, given the current scene state, a new instance of this builder's Tool can be created

Public function Virtual Const

void

 

PostBuildTool

(
    UInteractiveTool* Tool,
    const FToolBuilderState& SceneStat...
)

PostBuildTool is called by the ToolManager after a new Tool instance has been built.

Public function Virtual Const

void

 

PostSetupTool

(
    UInteractiveTool* Tool,
    const FToolBuilderState& SceneStat...
)

PostBuildTool is called by the ToolManager after a new Tool instance has been built and Setup() has been called.