Navigation
API > API/Plugins > API/Plugins/UVEditorTools > API/Plugins/UVEditorTools/ContextObjects
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UUVToolContextObject
- UUVToolLivePreviewAPI
References
| Module | UVEditorTools |
| Header | /Engine/Plugins/Editor/UVEditor/Source/UVEditorTools/Public/ContextObjects/UVToolContextObjects.h |
| Include | #include "ContextObjects/UVToolContextObjects.h" |
Syntax
UCLASS ()
class UUVToolLivePreviewAPI : public UUVToolContextObject
Remarks
Allows tools to interact with the 3d preview viewport, which has a separate world and input router.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TUniqueFunction< void(FViewCameraState &CameraStateOut)> | GetLivePreviewCameraStateFunc | |
  |
TWeakObjectPtr< UInputRouter > | InputRouter | |
 |
FOnDrawHUD | OnDrawHUD | |
 |
FOnRender | OnRender | |
 |
TUniqueFunction< void(const EMouseCursor::Type Cursor, bool bEnableOverride)> | SetCursorOverrideFunc | |
 |
TUniqueFunction< void(const UE::Geometry::FAxisAlignedBox3d &BoundingBox)> | SetLivePreviewCameraToLookAtVolumeFunc | |
  |
TWeakObjectPtr< UWorld > | World |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ||
 |
UInteractiveGizmoManager * | ||
 |
void | GetLivePreviewCameraState
(
FViewCameraState& CameraStateOut |
|
 |
UInputRouter * | ||
 |
UWorld * | ||
 |
void | Initialize
(
UWorld* WorldIn, |
|
 |
void | SetCursorOverride
(
const EMouseCursor::Type Cursor |
|
 |
void | SetLivePreviewCameraToLookAtVolume
(
const UE::Geometry::FAxisAlignedBox3d& BoundingBox |
Overridden from UUVToolContextObject
| Type | Name | Description | |
|---|---|---|---|
  |
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). |
Typedefs
| Name | Description |
|---|---|
| FOnDrawHUD | Broadcast by the 3D live preview viewport on DrawHUD() so that mechanics/tools can draw there. |
| FOnRender | Broadcast by the 3D live preview viewport on Render() so that mechanics/tools can render there. |