ULatticeControlPointsMechanic

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractionMechanic

ULatticeControlPointsMechanic

References

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

Syntax

UCLASS()
class ULatticeControlPointsMechanic :
    public UInteractionMechanic,
    public IClickBehaviorTarget,
    public IHoverBehaviorTarget

Variables

	Name	Description
bool	bCtrlToggle
bool	bGizmoBeingDragged	Used to make it easy to tell whether the gizmo was moved by the user or by undo/redo or some other change that we shouldn't respond to.
bool	bHasChanged
bool	bShiftToggle	Support for Shift and Ctrl toggle.
FViewCameraStat...	CachedCameraState
TMap< int32, FC...	ColorOverrides
TArray< FVector...	ControlPoints
int32	CurrentChangeStamp	Used for expiring undo/redo changes, which compare this to their stored value and expire themselves if they do not match.
TArray< int32 >	CurrentDragSelection
TObjectPtr< UPo...	DrawnControlPoints
TObjectPtr< ULi...	DrawnLatticeEdges
UE::Geometry::F...	GeometrySet	Used for spatial queries.
TFunction< bool...	GeometrySetToleranceTest	Support for hovering.
FVector	GizmoStartPosition	The starting point of the gizmo is needed to determine the offset by which to move the points.
FQuat	GizmoStartRotation
FVector	GizmoStartScale
FColor	HoverColor
int32	HoveredPointID
TArray< FVector...	LatticeEdges
FTransform3d	LocalToWorldTransform
TObjectPtr< URe...	MarqueeMechanic	Support for selection.
FColor	NormalPointColor
FColor	NormalSegmentColor	Variables for drawing.
OnPointsChanged...	OnPointsChanged
OnSelectionChan...	OnSelectionChanged
float	PointsSize
TObjectPtr< UCo...	PointTransformGizmo
TObjectPtr< UTr...	PointTransformProxy	Support for gizmo.
TSet< int32 >	PreDragSelection
FColor	PreHoverPointColor	Cache previous color while temporarily changing the color of a hovered-over point.
TObjectPtr< APr...	PreviewGeometryActor	Used for displaying points/segments
float	SegmentsThickness
FColor	SelectedColor
TSet< int32 >	SelectedPointIDs
TMap< int32, FV...	SelectedPointStartPositions	We need the selected point start positions so we can move multiple points appropriately.
TFunction< bool...	ShouldAddToSelectionFunc	Default modifier key behavior is consistent with PolygonSelectionMechanic.
TFunction< bool...	ShouldRemoveFromSelectionFunc

Functions

	Name	Description
void	ClearAllPointColorOverrides()
void	ClearHover()
void	ClearPointColorOverride ( int32 Index )
bool	ControlPointIsSelected ( int32 Index )
bool	DeselectPoint ( int32 PointID )
void	DrawHUD ( FCanvas* Canvas, IToolsContextRenderAPI* Render... )
const TArray...	GetControlPoints()
EToolContext...	GetCoordinateSystem()
const TSet< ...	GetSelectedPointIDs()
void	GizmoTransformChanged ( UTransformProxy* Proxy, FTransform Transform )	Callbacks we'll receive from the gizmo proxy.
void	GizmoTransformEnded ( UTransformProxy* Proxy )
void	GizmoTransformStarted ( UTransformProxy* Proxy )
bool	HitTest ( const FInputDeviceRay& ClickPos, FInputRayHit& ResultOut )	All of the following do not issue undo/redo change objects.
void	Initialize ( const TArray< FVector3d >& Points, const TArray< FVector2i >& Edges, const FTransform3d& LocalToWorldTr... )
void	OnDragRectangleChanged ( const FCameraRectangle& Rectangle )
void	OnDragRectangleFinished ( const FCameraRectangle& Rectangle, bool bCancelled )
void	OnDragRectangleStarted()
void	RebuildDrawables()
void	SelectPoint ( int32 PointID )
void	SetCoordinateSystem ( EToolContextCoordinateSystem InCoor... )
void	SetPointColorOverride ( int32 Index, const FColor& NewColor )
void	SetWorld ( UWorld* World )
void	UpdateControlPointPositions ( const TArray< FVector3d >& NewPoin... )
void	UpdateDrawables()
void	UpdateGizmoLocation()
void	UpdatePointLocations ( const TMap< int32, FVector3d >& Ne... )
void	UpdateSetPivotMode ( bool bInSetPivotMode )

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 )	UInteractionMechanic.
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 )	Notify target of current modifier state

Overridden from IHoverBehaviorTarget

	Name	Description
FInputRayHit	BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos )	IHoverBehaviorTarget implementation.
void	OnBeginHover ( const FInputDeviceRay& DevicePos )	Initialize hover sequence at given position
void	OnEndHover()	Terminate active hover sequence
bool	OnUpdateHover ( const FInputDeviceRay& DevicePos )	Update active hover sequence with new input position

Typedefs

Name	Description
FTransform3d
FVector2i
OnPointsChangedEvent	This delegate is called every time the control points are moved.
OnSelectionChangedEvent	This delegate is called every time the control point selection changes.

Constants

Name	Description
CtrlModifierID
ShiftModifierID