UCollectSurfacePathMechanic

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractionMechanic

UCollectSurfacePathMechanic

References

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

Syntax

UCLASS()
class UCollectSurfacePathMechanic : public UInteractionMechanic

Variables

		Name	Description
	bool	bCurrentPreviewWillComplete
	bool	bDrawPath
	bool	bGeometricCloseOccurred
	bool	bHaveTargetPlane
	bool	bLoopWasClosed
	bool	bPreviewPathPointValid
	bool	bSnapToTargetMeshVertices
	bool	bSnapToWorldGrid
	double	ConstantSnapDistance
	ECollectSurface...	DoneMode
	int32	FixedPointTargetCount
	TArray< FFrame3...	HitPath
	TUniqueFunction...	IsDoneFunc
	FLinearColor	PathColor
	FLinearColor	PathCompleteColor
	FToolDataVisual...	PathDrawer
	FLinearColor	PreviewColor
	FFrame3d	PreviewPathPoint
	TUniqueFunction...	SpatialSnapPointsFunc
	FFrame3d	TargetPlane
	FDynamicMesh3	TargetSurface
	UE::Geometry::F...	TargetSurfaceAABB

Constructors

	Name	Description
	UCollectSurfacePathMechanic()

Functions

	Name	Description
bool	CheckGeometricClosure ( const FFrame3d& Point, bool* bLoopWasClosedOut )
void	InitializeMeshSurface ( FDynamicMesh3&& TargetSurfaceMesh )	Set the hit target mesh.
void	InitializePlaneSurface ( const FFrame3d& TargetPlane )
bool	IsDone()
bool	IsHitByRay ( const FRay3d& Ray, FFrame3d& HitPoint )
bool	LoopWasClosed()	Whether the path was finished by the user clicking on the first point
bool	PopLastPoint()
bool	RayToPathPoint ( const FRay3d& Ray, FFrame3d& PointOut, bool bEnableSnapping )
void	SetCloseWithLambdaMode()
void	SetDoubleClickOrCloseLoopMode()
void	SetDrawClosedLoopMode()
void	SetFixedNumPointsMode ( int32 NumPoints )
bool	TryAddPointFromRay ( const FRay3d& Ray )
bool	UpdatePreviewPoint ( const FRay3d& Ray )

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

Typedefs

Name	Description
FFrame3d