Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UUVSelectTool

UUVSelectTool

The tool in the UV editor that secretly runs when other tools are not running.

API > API/Plugins > API/Plugins/UVEditorTools

Inheritance Hierarchy

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
Protected variable bool bGizmoTransformNeedsApplication  
Protected variable bool bInDrag  
Protected variable bool bUpdateGizmoOnCanonicalChange  
Protected variable TArray< UE::Geometry::FUVToolSelection > CurrentSelections  
Protected variable UProperty TObjectPtr< UUVToolEmitChangeAPI > EmitChangeAPI  
Protected variable UE::Geometry::FFrame3d InitialGizmoFrame  
Protected variable TArray< TArray< FVector3d > > MovingVertOriginalPositionsPerSelection  
Protected variable TArray< TArray< int32 > > MovingVidsPerSelection Inner arrays for these two are 1:1 with each other.
Protected variable TArray< TArray< int32 > > RenderUpdateTidsPerSelection The outer arrays are 1:1 with the Selections array obtained from the Selection API.
Protected variable UProperty TObjectPtr< UUVToolSelectionAPI > SelectionAPI  
Protected variable UProperty TObjectPtr< UUVEditorMeshSelectionMechanic > SelectionMechanic  
Protected variable UProperty TArray< TObjectPtr< UUVEditorToolMeshInput > > Targets  
Protected variable UProperty TObjectPtr< UCombinedTransformGizmo > TransformGizmo  
Protected variable FTransform UnappliedGizmoTransform  
Protected variable UProperty TObjectPtr< UUVToolViewportButtonsAPI > ViewportButtonsAPI  

Functions

  Type Name Description
Protected function Virtual void Updates previews based off of the current gizmo transform, CurrentSelections, MovingVidsPerSelection, and MovingVertOriginalPositions.
Public function Const FTransform Used by undo/redo.
Protected function Virtual void

GizmoTransformChanged ( UTransformProxy* Proxy,
FTransform Transform
)

 Callbacks we'll receive from the gizmo proxy.
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

OnSelectionChanged ( bool bEmitChangeAllowed,
uint32 SelectionChangeType
)

  
Public function void  
Public function void

SetGizmoTransform ( const FTransform& NewTransform
)

  
Public function Virtual void The tool will operate on the meshes given here.
Protected function Virtual void

UpdateGizmo ( bool bForceRecomputeSelectionCenters
)

  

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

 Allow the Tool to do any custom screen space drawing
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

OnPropertyModified ( UObject* PropertySet,
FProperty* Property
)

 Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
Public function Virtual void

OnTick ( float DeltaTime
)

 Allow the Tool to do any necessary processing on Tick
Public function Virtual void Allow the Tool to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 UInteractiveTool.
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

 Called by ToolManager to shut down the Tool

Overridden from IInteractiveToolNestedAcceptCancelAPI

  Type Name Description
Public function Virtual bool  
Public function Virtual bool Called by Editor levels to tell the implementor (eg Tool) to execute a nested Cancel action
Public function Virtual bool IInteractiveToolNestedAcceptCancelAPI.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page