Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ModelingComponents > Snapping > FPointPlanarSnapSolver

Light Theme

Dark Theme

FPointPlanarSnapSolver

[FPointPlanarSnapSolver](API\Plugins\ModelingComponents\Snapping\FPointPlanarSnapSolver) solves for a Point snap location on a plane, based on an input Point and a set of target points and lines in the plane.

Windows

MacOS

Linux

Inheritance Hierarchy

FBasePositionSnapSolver3

FPointPlanarSnapSolver

References

Module	ModelingComponents
Header	/Engine/Plugins/Experimental/MeshModelingToolset/Source/ModelingComponents/Public/Snapping/PointPlanarSnapSolver.h
Include	#include "Snapping/PointPlanarSnapSolver.h"

Syntax

class FPointPlanarSnapSolver : public FBasePositionSnapSolver3

Remarks

FPointPlanarSnapSolver solves for a Point snap location on a plane, based on an input Point and a set of target points and lines in the plane.

This implementation has the notion of a "history" of previous points, from which line and distance constraints can be inferred. This is useful for snapping in 2D polygon drawing.

See FBasePositionSnapSolver3 for details on how to set up the snap problem and get results.

Variables

	Name	Description
bool	bActiveSnapIsIntersection
bool	bEnableSnapToKnownLengths
int	CardinalAxisPriority
TArray< FSnapTa...	GeneratedLines
TArray< FSnapTa...	GeneratedTargets
TSet< int >	IgnoreTargets
TArray< FSnapTa...	IntersectionPoints
int32	IntersectionPriorityDelta	How much more important an intersection is than the more important of the intersecting lines.
FLine3d	IntersectionSecondLine
TArray< const F...	IntersectionSecondLinePointers
int	KnownLengthPriorityDelta	How much more important a known length is than its line's priority.
int	LastSegmentPriority
FFrame3d	Plane	Configuration variables
TArray< FVector...	PointHistory

Constructors

	Name	Description
	FPointPlanarSnapSolver()

Functions

	Name	Description
void	AppendHistoryPoint ( const FVector3d& Point )
void	DebugRender ( IToolsContextRenderAPI* Render... )	Draws the current snap targets (for debugging)
void	GenerateLineIntersectionTargets()
void	GenerateTargets ( const FVector3d& PointIn )
const FLine3...	GetIntersectionSecondLine()	When the active snap is an intersection, holds the second intersecting line (the first can be obtained with GetActiveSnapLine())
bool	HaveActiveSnapIntersection()	Returns true when the active snap represents an intersection of multiple target lines in the plane.
void	InsertHistoryPoint ( const FVector3d& Point, int32 Index )
int	MinInternalPriority()
int32	PointHistoryLength()
void	RegenerateTargetLines ( bool bCardinalAxes, bool bLastHistorySegment )	Creates snap lines based on the last point in the point history.
void	RegenerateTargetLinesAround ( int32 HistoryIndex, bool bWrapAround, bool bGenerateIntersections )	Sets the snapping lines to be based on the history points adjacent to the point with a given history index.
void	RemoveHistoryPoint ( int32 Index )
void	ResetGenerated()	Clears any existing generated snap targets.
void	UpdatePointHistory ( const TArray< FVector3d >& Points )	Point history manipulation functions. All of them remove the currently generated snap
void	UpdatePointHistory ( const TArray< FVector >& Points )	Point history manipulation functions. All of them remove the currently generated snap
void	UpdateSnappedPoint ( const FVector3d& PointIn )

Overridden from FBasePositionSnapSolver3

		Name	Description
	void	Reset()	Discard the set of snap points and lines and clear the active snap

Constants

Name	Description
CardinalAxisTargetID
IntersectionTargetID
LastSegmentTargetID

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss