Navigation
API > API/Plugins > API/Plugins/UVEditorTools
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UInteractiveTool
- UUVSelectTool
References
| Module | UVEditorTools |
| Header | /Engine/Plugins/Editor/UVEditor/Source/UVEditorTools/Public/UVSelectTool.h |
| Include | #include "UVSelectTool.h" |
Syntax
UCLASS&40;&41;
class UUVSelectTool :
public UInteractiveTool,
public IInteractiveToolNestedAcceptCancelAPI,
public IUVToolSupportsSelection
Remarks
The tool in the UV editor that secretly runs when other tools are not running. It uses the selection api to allow the user to select elements, and has a gizmo that can be used to transform these elements.
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bGizmoTransformNeedsApplication | ||
| bool | bInDrag | ||
| bool | bUpdateGizmoOnCanonicalChange | ||
| TArray< UE::Geometry::FUVToolSelection > | CurrentSelections | ||
| TObjectPtr< UUVToolEmitChangeAPI > | EmitChangeAPI | ||
| UE::Geometry::FFrame3d | InitialGizmoFrame | ||
| TArray< TArray< FVector3d > > | MovingVertOriginalPositionsPerSelection | ||
| TArray< TArray< int32 > > | MovingVidsPerSelection | Inner arrays for these two are 1:1 with each other. | |
| TArray< TArray< int32 > > | RenderUpdateTidsPerSelection | The outer arrays are 1:1 with the Selections array obtained from the Selection API. | |
| TObjectPtr< UUVToolSelectionAPI > | SelectionAPI | ||
| TObjectPtr< UUVEditorMeshSelectionMechanic > | SelectionMechanic | ||
| TArray< TObjectPtr< UUVEditorToolMeshInput > > | Targets | ||
| TObjectPtr< UCombinedTransformGizmo > | TransformGizmo | ||
| FTransform | UnappliedGizmoTransform | ||
| TObjectPtr< UUVToolViewportButtonsAPI > | ViewportButtonsAPI |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Updates previews based off of the current gizmo transform, CurrentSelections, MovingVidsPerSelection, and MovingVertOriginalPositions. | ||
| FTransform | Used by undo/redo. | ||
| void | GizmoTransformChanged
(
UTransformProxy* Proxy, |
Callbacks we'll receive from the gizmo proxy. | |
| void | GizmoTransformEnded
(
UTransformProxy* Proxy |
||
| void | GizmoTransformStarted
(
UTransformProxy* Proxy |
||
| void | OnSelectionChanged
(
bool bEmitChangeAllowed, |
||
| void | SelectAll () |
||
| void | SetGizmoTransform
(
const FTransform& NewTransform |
||
| void | SetTargets
(
const TArray< TObjectPtr< UUVEditorToolMeshInput >>& TargetsIn |
The tool will operate on the meshes given here. | |
| void | UpdateGizmo
(
bool bForceRecomputeSelectionCenters |
Overridden from UInteractiveTool
| Type | Name | Description | |
|---|---|---|---|
| void | DrawHUD
(
FCanvas* Canvas, |
Allow the Tool to do any custom screen space drawing | |
| bool | HasAccept () |
||
| bool | HasCancel () |
||
| void | OnPropertyModified
(
UObject* PropertySet, |
Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes | |
| void | OnTick
(
float DeltaTime |
Allow the Tool to do any necessary processing on Tick | |
| void | Render
(
IToolsContextRenderAPI* RenderAPI |
Allow the Tool to do any custom drawing (ie via PDI/RHI) | |
| void | Setup () |
UInteractiveTool. | |
| void | Shutdown
(
EToolShutdownType ShutdownType |
Called by ToolManager to shut down the Tool |
Overridden from IInteractiveToolNestedAcceptCancelAPI
| Type | Name | Description | |
|---|---|---|---|
| bool | |||
| bool | Called by Editor levels to tell the implementor (eg Tool) to execute a nested Cancel action | ||
| bool | IInteractiveToolNestedAcceptCancelAPI. |