Navigation
API > API/Plugins > API/Plugins/ModelingComponents
An API (to be stored as a context object) that would allow tools to customize aspects of their hosts' appearance. For instance, it can allow a tool to customize tool shutdown accept/cancel buttons to handle some tool sub-action, if the host allows this.
| Name | IToolHostCustomizationAPI |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/ToolHostCustomizationAPI.h |
| Include Path | #include "ToolHostCustomizationAPI.h" |
Syntax
class IToolHostCustomizationAPI
Derived Classes
Structs
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearButtonOverrides () |
Remove any requested button customizations. | ToolHostCustomizationAPI.h | |
virtual bool RequestAcceptCancelButtonOverride
(
FAcceptCancelButtonOverrideParams& Params |
Requests that a tool host's tool shutdown buttons be temporarily overriden to an accept/cancel pair that accepts/cancels some sub action. | ToolHostCustomizationAPI.h | |
virtual bool RequestCompleteButtonOverride
(
FCompleteButtonOverrideParams& Params |
Requests that a tool host's shutdown buttons be temporarily overriden to a complete button that completes some sub action. | ToolHostCustomizationAPI.h | |
virtual bool SupportsAcceptCancelButtonOverride() |
If true, the tool host is able to override its tool shutdown buttons to custom accept/cancel buttons. | ToolHostCustomizationAPI.h | |
virtual bool SupportsCompleteButtonOverride() |
ToolHostCustomizationAPI.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TScriptInterface< IToolHostCustomizationAPI > Find
(
UInteractiveToolManager* ToolManager |
ToolHostCustomizationAPI.h |