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	bEnableSnapToKnownLengths
int	CardinalAxisPriority
TArray< FSnapTa...	GeneratedLines
TArray< FSnapTa...	GeneratedTargets
TSet< int >	IgnoreTargets
int	KnownLengthPriorityDelta
int	LastSegmentPriority
FFrame3d	Plane	Configuration variables
TArray< FVector...	PointHistory

Constructors

	Name	Description
	FPointPlanarSnapSolver()

Functions

		Name	Description
	void	GenerateTargets ( const FVector3d& PointIn )
	int	MinInternalPriority()
	void	RegenerateTargetLines ( bool bCardinalAxes, bool bLastHistorySegment )
	void	UpdatePointHistory ( const TArray< FVector3d >& Points )
	void	UpdatePointHistory ( const TArray< FVector >& Points )
	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
	void	ResetActiveSnap()	Clear the active snap

Constants

Name	Description
CardinalAxisTargetID
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