1. Epic GamesDeveloper
  3. UUVEditorMeshSelectionMechanic

UUVEditorMeshSelectionMechanic

Mechanic for selecting elements of a dynamic mesh 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/UVEditorMeshSelectionMechanic.h
Include #include "Selection/UVEditorMeshSelectionMechanic.h"

Syntax

UCLASS ()  
class UUVEditorMeshSelectionMechanic : public UInteractionMechanic

Remarks

Mechanic for selecting elements of a dynamic mesh in the UV editor. Interacts heavily with UUVToolSelectionAPI, which actually stores selections.

Variables

  Type Name Description
Protected variable TArray< TSharedPtr< FDynamicMeshAABBTree3 > > AppliedMeshSpatials  
Protected variable TArray< const FUVToolSelection * > AssetIDToPreDragSelection Maps asset id to a pre drag selection so that it is easy to tell which assets started with a selection.
Protected variable TArray< const FUVToolSelection * > AssetIDToPreDragUnsetSelection  
Protected variable bool bCtrlToggle  
Protected variable bool bIsEnabled  
Protected variable bool bShiftToggle  
Protected variable bool bShowHoveredElements  
Protected variable FViewCameraState CameraState  
Protected variable UProperty TObjectPtr< UUVToolEmitChangeAPI > EmitChangeAPI  
Protected variable UProperty TObjectPtr< APreviewGeometryActor > HoverGeometryActor  
Protected variable TWeakObjectPtr< ULineSetComponent > HoverLineSet  
Protected variable TWeakObjectPtr< UPointSetComponent > HoverPointSet  
Protected variable TWeakObjectPtr< UTriangleSetComponent > HoverTriangleSet Weak pointers so that they go away when geometry actor is destroyed.
Protected variable UProperty TObjectPtr< UMaterialInstanceDynamic > HoverTriangleSetMaterial  
Protected variable UProperty TObjectPtr< UUVToolLivePreviewAPI > LivePreviewAPI  
Protected variable UProperty TObjectPtr< UInputBehaviorSet > LivePreviewBehaviorSet  
Protected variable UProperty TObjectPtr< ULocalInputBehaviorSource > LivePreviewBehaviorSource  
Protected variable UProperty TObjectPtr< ULocalSingleClickInputBehavior > LivePreviewClickTargetRouter  
Protected variable UProperty TObjectPtr< ULocalMouseHoverBehavior > LivePreviewHoverBehaviorTargetRouter  
Protected variable UProperty TObjectPtr< APreviewGeometryActor > LivePreviewHoverGeometryActor  
Protected variable TWeakObjectPtr< ULineSetComponent > LivePreviewHoverLineSet  
Protected variable TWeakObjectPtr< UPointSetComponent > LivePreviewHoverPointSet  
Protected variable TWeakObjectPtr< UTriangleSetComponent > LivePreviewHoverTriangleSet Weak pointers so that they go away when geometry actor is destroyed.
Protected variable TWeakObjectPtr< UInputRouter > LivePreviewInputRouter  
Protected variable UProperty TObjectPtr< URectangleMarqueeMechanic > LivePreviewMarqueeMechanic  
Protected variable UProperty TObjectPtr< URectangleMarqueeMechanic > MarqueeMechanic  
Public variable FSimpleMulticastDelegate OnDragSelectionChanged Broadcasted whenever the marquee mechanic rectangle is changed, since these changes don't trigger normal selection broadcasts.
Protected variable TArray< FUVToolSelection > PreDragSelections  
Protected variable TArray< FUVToolSelection > PreDragUnsetSelections  
Protected variable UProperty TObjectPtr< UUVToolSelectionAPI > SelectionAPI  
Protected variable ESelectionMode SelectionMode  
Protected variable TArray< TObjectPtr< UUVEditorToolMeshInput > > Targets  
Protected variable UProperty TObjectPtr< ULocalSingleClickInputBehavior > UnwrapClickTargetRouter  
Protected variable UProperty TObjectPtr< ULocalMouseHoverBehavior > UnwrapHoverBehaviorTargetRouter  
Protected variable TArray< TSharedPtr< FDynamicMeshAABBTree3 > > UnwrapMeshSpatials  
Protected variable UProperty TObjectPtr< UUVToolViewportButtonsAPI > ViewportButtonsAPI  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FInputRayHit

BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos,
bool bSourceIsLivePreview
)

 IHoverBehaviorTarget implementation.
Public function Virtual void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

  
Public function Const TArray< FUVToolSelection >

GetAllCanonicalTrianglesInUnwrapRadius ( const FVector2d& UnwrapWorldHitPoint,
double Radius
)

  
Protected function bool

GetHitTid ( const FInputDeviceRay& ClickPos,
int32& TidOut,
int32& AssetIDOut,
bool bUseUnwrap,
int32* ExistingSelectionObjectIndexOut
)

  
Protected function Const TSharedPtr< FDynamicMeshAABBTree3 >

GetMeshSpatial ( int32 TargetId,
bool bUseUnwrap
)

 Should be the same as the mode-level targets array, indexed by AssetID.
Public function void

Initialize ( UWorld* World,
UWorld* LivePreviewWorld,
UUVToolSelectionAPI* SelectionAPI
)

 Initialization functions.
Public function bool  
Public function Virtual FInputRayHit

IsHitByClick ( const FInputDeviceRay& ClickPos,
bool bSourceIsLivePreview
)

 IClickBehaviorTarget implementation.
Public function Virtual void

LivePreviewDrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

  
Public function Virtual void  
Protected function void

ModifyExistingSelection ( TSet< int32 >& SelectionSetToModify,
const TArray< int32 >& SelectedIDs
)

  
Public function Virtual void

OnBeginHover ( const FInputDeviceRay& DevicePos
)

  
Public function Virtual void

OnClicked ( const FInputDeviceRay& ClickPos,
bool bSourceIsLivePreview
)

  
Protected function void

OnDragRectangleChanged ( const FCameraRectangle& CurrentRectangle,
bool bSourceIsLivePreview
)

  
Protected function void

OnDragRectangleFinished ( const FCameraRectangle& Rectangle,
bool bCancelled,
bool bSourceIsLivePreview
)

  
Protected function void For marquee mechanic.
Public function Virtual void  
Public function Virtual bool

OnUpdateHover ( const FInputDeviceRay& DevicePos,
bool bSourceIsLivePreview
)

  
Public function Virtual void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 IModifierToggleBehaviorTarget implementation.
Public function Const bool

RaycastCanonicals ( const FRay& WorldRay,
bool bRaycastIsForUnwrap,
bool bPreferSelected,
FRaycastResult& HitOut
)

 This is a helper method that doesn't get used in normal selection mechanic operation, but can be used by clients if they need to raycast canonical meshes, since the mechanic already keeps aabb trees for them.
Public function void

SetIsEnabled ( bool bIsEnabled
)

  
Public function void

SetSelectionMode ( ESelectionMode TargetMode,
const FModeChangeOptions& Options
)

 Sets selection mode for the mechanic.
Public function void

SetShowHoveredElements ( bool bShow
)

  
Public function void

SetTargets ( const TArray< TObjectPtr< UUVEditorToolMeshInput > >& TargetsIn
)

  
Protected function Const bool All four combinations of shift/ctrl down are assigned a behaviour.
Protected function Const bool  
Protected function Const bool  
Protected function Const bool  

Overridden from UInteractionMechanic

  Type Name Description
Public function Virtual void Allow the Mechanic to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ( UInteractiveTool* ParentTool
)

 Called to initialize the InteractionMechanic
Public function Virtual void Called to clean up the InteractionMechanic

Classes

  Type Name Description
Public struct FRaycastResult    

Typedefs

Name Description
ESelectionMode  
FDynamicMeshAABBTree3  
FModeChangeOptions  
FUVToolSelection  

Constants

Name Description
CtrlModifierID  
ShiftModifierID  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page