1. Epic GamesDeveloper
  3. UUVToolSelectionAPI

UUVToolSelectionAPI

API for dealing with mode-level selection in the UV editor.

API > API/Plugins > API/Plugins/UVEditorTools > API/Plugins/UVEditorTools/Selection

Inheritance Hierarchy

References

   
Module UVEditorTools
Header /Engine/Plugins/Editor/UVEditor/Source/UVEditorTools/Public/Selection/UVToolSelectionAPI.h
Include #include "Selection/UVToolSelectionAPI.h"

Syntax

UCLASS&40;&41;  
class UUVToolSelectionAPI : public UUVToolContextObject

Remarks

API for dealing with mode-level selection in the UV editor.

Selections are stored in a list of objects, one object per asset that contains a selection, all of the same type (vert/edge/tri), none empty. Selections are considered to be referring to the UnwrapCanonical mesh of the corresponding target.

There are also functions to enable automatic highlighting of the current selection, and to enable a selection mechanic in the viewport (to which tools can respond via OnSelectionChanged broadcasts).

Variables

  Type Name Description
Protected variable bool bCachedUnwrapSelectionBoundingBoxCenterValid  
Protected variable bool bIsActive  
Protected variable FVector3d CachedUnwrapSelectionBoundingBoxCenter  
Protected variable TArray< FUVToolSelection > CurrentSelections  
Protected variable TArray< FUVToolSelection > CurrentUnsetSelections  
Protected variable UProperty TObjectPtr< UUVToolEmitChangeAPI > EmitChangeAPI  
Protected variable UProperty TObjectPtr< UUVToolSelectionHighlightMechanic > HighlightMechanic  
Protected variable FHighlightOptions HighlightOptions  
Protected variable UProperty TObjectPtr< UUVEditorMechanicAdapterTool > MechanicAdapter  
Public variable FSimpleMulticastDelegate OnDragSelectionChanged Broadcasted whenever the marquee rectangle is changed, since these changes don't trigger normal selection broadcasts.
Public variable FOnPreSelectionChange OnPreSelectionChange  
Public variable FOnSelectionChanged OnSelectionChanged  
Protected variable TUniquePtr< FSelectionChange > PendingSelectionChange  
Protected variable TUniquePtr< FUnsetSelectionChange > PendingUnsetSelectionChange  
Protected variable UProperty TObjectPtr< UUVEditorMeshSelectionMechanic > SelectionMechanic  
Protected variable UProperty TArray< TObjectPtr< UUVEditorToolMeshInput > > Targets  
Protected variable TWeakObjectPtr< UInputRouter > UnwrapInputRouter  

Functions

  Type Name Description
Public function void Preps a selection change transaction, if the user wants more control on what the previous and current selection is.
Public function void

ClearHighlight ( bool bClearForUnwrap,
bool bClearForAppliedPreview
)

  
Public function void

ClearSelections ( bool bBroadcast,
bool bEmitChange
)

 Equivalent to calling SetSelections with an empty array.
Public function void

ClearUnsetElementAppliedMeshSelections ( bool bBroadcast,
bool bEmitChange
)

  
Public function Virtual void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

  
Public function bool

EndChangeAndEmitIfModified ( bool bBroadcast
)

 Ends the active change and emits it via the EmitChangeAPI
Public function Const const TArray< FUVToolSelection > & Returns the current selection.
Public function FUVToolSelection::EType Returns type (vertex/edge/triangle) of current selection. Undefined if selection is empty.
Public function const TArray< FUVToolSelection > &  
Public function FTransform  
Public function FVector3d

GetUnwrapSelectionBoundingBoxCenter ( bool bForceRecalculate
)

 Gets the bounding box center of the current selection.
Public function Const bool Returns true when current selection is not empty.
Public function Const bool These are functions that are used if a selection made in the applied mesh cannot be converted to an unwrap mesh selection due to unset UV elements (meaning that the selected portion does not exist in the unwrap mesh).
Public function void

Initialize ( UInteractiveToolManager* ToolManagerIn,
UWorld* UnwrapWorld,
UInputRouter* UnwrapInputRouterIn,
UUVToolLivePreviewAPI* LivePreviewAPI,
UUVToolEmitChangeAPI* EmitChangeAPIIn
)

 Initialization functions:
Public function Const bool Returns true in between Initialize() and Shutdown().
Public function Virtual void  
Public function Virtual void Could have had the api place these into the LivePreviewAPI delegates, but decided against it to align with Render() and DrawHUD() above.
Public function void  
Public function void

RebuildUnwrapHighlight ( const FTransform& StartTransform
)

 Build up a highlight of the current selection in the Unwrap, with a given transform considered as its start transform.
Public function Virtual void Called by the owner of the API.
Public function void  
Public function void

SetHighlightVisible ( bool bUnwrapHighlightVisible,
bool bAppliedHighlightVisible,
bool bRebuild
)

 Changes the visibility of the highlight.
Public function void

SetSelectionMechanicEnabled ( bool bEnabled
)

  
Public function void Sets the mechanic mode of operation.
Public function void  
Public function void

SetSelections ( const TArray< FUVToolSelection >& SelectionsIn,
bool bBroadcast,
bool bEmitChange
)

 Sets the current selection.
Public function void Should be called after Initialize()
Public function void

SetUnsetElementAppliedMeshSelections ( const TArray< FUVToolSelection >& SelectionsIn,
bool bBroadcast,
bool bEmitChange
)

  
Public function void

SetUnwrapHighlightTransform ( const FTransform& NewTransform
)

 Change the transform of the unwrap highlight without rebuilding it (for cheap movement of the highlight when translating the elements).

Overridden from UUVToolContextObject

  Type Name Description
Public function Virtual void 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).
Public function Virtual void UUVToolContextObject.

Classes

  Type Name Description
Public struct FHighlightOptions    
Public class FSelectionChange An object representing a selection that can be as an undo/redo item, usually emitted by the selection API itself.  
Public struct FSelectionMechanicModeChangeOptions Options for how a SetSelectionMechanicMode() call is performed.  
Public struct FSelectionMechanicOptions    
Public class FUnsetSelectionChange An object representing an unset UV selection that can be as an undo/redo item, usually emitted by the selection API itself.  

Enums

  Type Name Description
Public enum EUVEditorSelectionMode Mode of operation for the selection mechanic.  

Typedefs

Name Description
FOnPreSelectionChange Broadcasted right before a selection change is applied (and therefore before a selection change transaction is emitted).
FOnSelectionChanged Broadcasted after a selection change is applied (after the selection change transaction is emitted, if relevant).
FUVToolSelection  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page