Navigation
API > API/Plugins > API/Plugins/UVEditorTools
Allows tools to interact with the 3d preview viewport, which has a separate world and input router.
| Name | UUVToolLivePreviewAPI |
| Type | class |
| Header File | /Engine/Plugins/Editor/UVEditor/Source/UVEditorTools/Public/ContextObjects/UVToolContextObjects.h |
| Include Path | #include "ContextObjects/UVToolContextObjects.h" |
Syntax
UCLASS (MinimalAPI)
class UUVToolLivePreviewAPI : public UUVToolContextObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UUVToolContextObject → UUVToolLivePreviewAPI
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnDrawHUD | TMulticastDelegate_TwoParams< void, FCanvas *Canvas, IToolsContextRenderAPI *RenderAPI > | Broadcast by the 3D live preview viewport on DrawHUD() so that mechanics/tools can draw there. | ContextObjects/UVToolContextObjects.h |
| FOnRender | TMulticastDelegate_OneParam< void, IToolsContextRenderAPI *RenderAPI > | Broadcast by the 3D live preview viewport on Render() so that mechanics/tools can render there. | ContextObjects/UVToolContextObjects.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnDrawHUD | FOnDrawHUD | ContextObjects/UVToolContextObjects.h | ||
| OnRender | FOnRender | ContextObjects/UVToolContextObjects.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GizmoManager | TWeakObjectPtr< UInteractiveGizmoManager > | ContextObjects/UVToolContextObjects.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearCursorOverride() |
ContextObjects/UVToolContextObjects.h | ||
UInteractiveGizmoManager * GetGizmoManager() |
ContextObjects/UVToolContextObjects.h | ||
void GetLivePreviewCameraState
(
FViewCameraState& CameraStateOut |
ContextObjects/UVToolContextObjects.h | ||
UInputRouter * GetLivePreviewInputRouter() |
ContextObjects/UVToolContextObjects.h | ||
UWorld * GetLivePreviewWorld() |
ContextObjects/UVToolContextObjects.h | ||
void Initialize
(
UWorld* WorldIn, |
ContextObjects/UVToolContextObjects.h | ||
void SetCursorOverride
(
const EMouseCursor::Type Cursor |
ContextObjects/UVToolContextObjects.h | ||
void SetLivePreviewCameraToLookAtVolume
(
const UE::Geometry::FAxisAlignedBox3d& BoundingBox |
ContextObjects/UVToolContextObjects.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/UVToolContextObjects.h |