Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
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
| Name | UInteractiveToolBuilder |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolBuilder.h |
| Include Path | #include "InteractiveToolBuilder.h" |
Syntax
UCLASS (Transient, Abstract, MinimalAPI)
class UInteractiveToolBuilder : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveToolBuilder
Derived Classes
UInteractiveToolBuilder derived class hierarchy
- UAddPatchToolBuilder
- UInteractiveToolWithToolTargetsBuilder
- UAddPrimitiveToolBuilder
- UAvaInteractiveToolsToolBuilder
- UBaseMeshFromSplinesToolBuilder
- UBaseScriptableToolBuilder
- UBspConversionToolBuilder
- UClickDragToolBuilder
- UConvertMeshesToolBuilder
- UCreateWidgetToolBuilder
- UDrawAndRevolveToolBuilder
- UDrawPolygonToolBuilder
- UDrawPolyPathToolBuilder
- UDrawSplineToolBuilder
- UGenericUVEditorToolBuilder
- UGroomToMeshToolBuilder
- UISMEditorToolBuilder
- UMeshTextureAssetPaintingToolBuilder
- UMeshTextureColorPaintingToolBuilder
- UMeshVertexColorPaintingToolBuilder
- UMeshVertexWeightPaintingToolBuilder
- USingleClickToolBuilder
- UUVEditorBaseTransformToolBuilder
- UUVEditorChannelEditToolBuilder
- UUVEditorLayoutToolBuilder
- UUVEditorParameterizeMeshToolBuilder
- UUVEditorRecomputeUVsToolBuilder
- UUVEditorSeamToolBuilder
- UUVEditorTexelDensityToolBuilder
- UUVEditorUVSnapshotToolBuilder
- UUVSelectToolBuilder
- UVolumeToMeshToolBuilder
- UMotionTrailToolBuilder
- URectangleSelectToolBuilder
- USequencerPivotToolBuilder
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UInteractiveTool * BuildTool
(
const FToolBuilderState& SceneState |
Create a new instance of this builder's Tool | InteractiveToolBuilder.h | |
virtual bool CanBuildTool
(
const FToolBuilderState& SceneState |
Check if, given the current scene state, a new instance of this builder's Tool can be created | InteractiveToolBuilder.h | |
virtual void PostBuildTool
(
UInteractiveTool* Tool, |
PostBuildTool is called by the ToolManager after a new Tool instance has been built. | InteractiveToolBuilder.h | |
virtual void PostSetupTool
(
UInteractiveTool* Tool, |
PostBuildTool is called by the ToolManager after a new Tool instance has been built and Setup() has been called. | InteractiveToolBuilder.h |