UMeshSelectionMechanic

Mechanic for selecting elements of a dynamic mesh.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractionMechanic

UMeshSelectionMechanic

References

Module	ModelingComponents
Header	/Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Selection/MeshSelectionMechanic.h
Include	#include "Selection/MeshSelectionMechanic.h"

Syntax

UCLASS()
class UMeshSelectionMechanic :
public UInteractionMechanic,
public IClickBehaviorTarget

Remarks

Mechanic for selecting elements of a dynamic mesh.

TODO: Currently only able to select unoccluded elements.

Variables

	Name	Description
bool	bCtrlToggle
bool	bShiftToggle
FViewCameraStat...	CameraState
int32	CentroidTimestamp
FDynamicMeshSel...	CurrentSelection
FVector3d	CurrentSelectionCentroid
int32	CurrentSelectionIndex
TUniqueFunction...	EmitSelectionChange	Function to use for emitting selection change events.
TObjectPtr< APr...	HoverGeometryActor
TObjectPtr< ULi...	HoverLineSet
TObjectPtr< UPo...	HoverPointSet
TObjectPtr< UTr...	HoverTriangleSet
TObjectPtr< UMa...	HoverTriangleSetMaterial
TObjectPtr< ULi...	LineSet
TObjectPtr< URe...	MarqueeMechanic
TArray< TShared...	MeshSpatials
TArray< FTransf...	MeshTransforms
FSimpleMulticas...	OnSelectionChanged
TObjectPtr< UPo...	PointSet
FDynamicMeshSel...	PreDragSelection
TObjectPtr< APr...	PreviewGeometryActor
EMeshSelectionM...	SelectionMode
TObjectPtr< UMe...	Settings
TObjectPtr< UTr...	TriangleSet
TObjectPtr< UMa...	TriangleSetMaterial	The material being displayed for selected triangles
FMeshSelectionM...	VisualizationStyle

Destructors

	Name	Description
	~UMeshSelectionMechanic()

Functions

	Name	Description
void	AddSpatial ( TSharedPtr< FDynamicMeshAABBTree3 >..., const FTransform& TransformIn )	Use this to initialize the meshes we want to hit test.
void	ChangeSelectionMode ( const EMeshSelectionMechanicMode& ... )
void	DrawHUD ( FCanvas* Canvas, IToolsContextRenderAPI* Render... )
const FDynam...	GetCurrentSelection()
FVector3d	GetCurrentSelectionCentroid()
void	OnDragRectangleChanged ( const FCameraRectangle& CurrentRec... )
void	OnDragRectangleFinished ( const FCameraRectangle& Rectangle, bool bCancelled )
void	OnDragRectangleStarted()
TSet< int32 ...	RayCast ( const FInputDeviceRay& ClickPos, EMeshSelectionMechanicMode Mode )
void	RebuildDrawnElements ( const FTransform& StartTransform )	Rebuilds the drawn selection highlights, and intializes them in such a way that their transform is equal to StartTransform (useful so that their transform can later be changed)
void	SetDrawnElementsTransform ( const FTransform& Transform )	Changes the transform of the selection highlights.
void	SetSelection ( const FDynamicMeshSelection& Selec..., bool bBroadcast, bool bEmitChange )
void	SetVisualizationStyle ( const FMeshSelectionMechanicStyle&... )
void	SetWorld ( UWorld* World )
bool	ShouldAddToSelection()	All four combinations of shift/ctrl down are assigned a behaviour.
bool	ShouldRemoveFromSelection()
bool	ShouldRestartSelection()
bool	ShouldToggleFromSelection()
void	UpdateCentroid()

Overridden from UInteractionMechanic

	Name	Description
void	Render ( IToolsContextRenderAPI* Render... )	Allow the Mechanic to do any custom drawing (ie via PDI/RHI)
void	Setup ( UInteractiveTool* ParentTool )	Called to initialize the InteractionMechanic
void	Shutdown()	Called to clean up the InteractionMechanic

Overridden from IClickBehaviorTarget

		Name	Description
	FInputRayHit	IsHitByClick ( const FInputDeviceRay& ClickPos )	IClickBehaviorTarget implementation.
	void	OnClicked ( const FInputDeviceRay& ClickPos )	Notify Target that click ocurred

Overridden from IModifierToggleBehaviorTarget

		Name	Description
	void	OnUpdateModifierState ( int ModifierID, bool bIsOn )	IModifierToggleBehaviorTarget implementation.

Typedefs

Name	Description
FDynamicMeshAABBTree3
FDynamicMeshSelection

Constants

Name	Description
CtrlModifierID
ShiftModifierID