Navigation
API > API/Plugins > API/Plugins/UVEditorTools
Allows tools to interact with buttons in the viewport
| Name | UUVToolViewportButtonsAPI |
| Type | class |
| Header File | /Engine/Plugins/Editor/UVEditor/Source/UVEditorTools/Public/ContextObjects/UVToolViewportButtonsAPI.h |
| Include Path | #include "ContextObjects/UVToolViewportButtonsAPI.h" |
Syntax
UCLASS ()
class UUVToolViewportButtonsAPI : public UUVToolContextObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UUVToolContextObject → UUVToolViewportButtonsAPI
Enums
Public
| Name | Remarks |
|---|---|
| EGizmoMode | |
| ESnapTypeFlag |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ESelectionMode | UUVToolSelectionAPI::EUVEditorSelectionMode | ContextObjects/UVToolViewportButtonsAPI.h | |
| FOnGizmoModeChange | TMulticastDelegate_OneParam< void, EGizmoMode NewGizmoMode > | ContextObjects/UVToolViewportButtonsAPI.h | |
| FOnInitiateFocusCameraOnSelection | TMulticastDelegate_NoParams< void > | ContextObjects/UVToolViewportButtonsAPI.h | |
| FOnSelectionModeChange | TMulticastDelegate_OneParam< void, ESelectionMode NewSelectionMode > | ContextObjects/UVToolViewportButtonsAPI.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnGizmoModeChange | FOnGizmoModeChange | ContextObjects/UVToolViewportButtonsAPI.h | ||
| OnInitiateFocusCameraOnSelection | FOnInitiateFocusCameraOnSelection | ContextObjects/UVToolViewportButtonsAPI.h | ||
| OnSelectionModeChange | FOnSelectionModeChange | ContextObjects/UVToolViewportButtonsAPI.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AreGizmoButtonsEnabled() |
ContextObjects/UVToolViewportButtonsAPI.h | ||
bool AreSelectionButtonsEnabled() |
ContextObjects/UVToolViewportButtonsAPI.h | ||
EGizmoMode GetGizmoMode() |
ContextObjects/UVToolViewportButtonsAPI.h | ||
ESelectionMode GetSelectionMode() |
ContextObjects/UVToolViewportButtonsAPI.h | ||
bool GetSnapEnabled
(
ESnapTypeFlag SnapMode |
ContextObjects/UVToolViewportButtonsAPI.h | ||
float GetSnapValue
(
ESnapTypeFlag SnapMode |
ContextObjects/UVToolViewportButtonsAPI.h | ||
void InitiateFocusCameraOnSelection() |
ContextObjects/UVToolViewportButtonsAPI.h | ||
void SetGizmoButtonsEnabled
(
bool bOn |
ContextObjects/UVToolViewportButtonsAPI.h | ||
void SetGizmoMode
(
EGizmoMode ModeIn, |
ContextObjects/UVToolViewportButtonsAPI.h | ||
void SetSelectionButtonsEnabled
(
bool bOn |
ContextObjects/UVToolViewportButtonsAPI.h | ||
void SetSelectionMode
(
ESelectionMode ModeIn, |
ContextObjects/UVToolViewportButtonsAPI.h | ||
void SetSnapValue
(
ESnapTypeFlag SnapMode, |
ContextObjects/UVToolViewportButtonsAPI.h | ||
void ToggleSnapEnabled
(
ESnapTypeFlag SnapMode |
ContextObjects/UVToolViewportButtonsAPI.h |
Overridden from UUVToolContextObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnToolEnded
(
UInteractiveTool* DeadTool |
Called whenever a tool is ended, for instance to let a context object remove listeners associated with that tool (it shouldn't have to do so, but may choose to for robustness). | ContextObjects/UVToolViewportButtonsAPI.h |