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 > FBasePositionSnapSolver3

Light Theme

Dark Theme

FBasePositionSnapSolver3

[FBasePositionSnapSolver3](API\Plugins\ModelingComponents\Snapping\FBasePositionSnapSolver3) is a base class for 3D position snapping implementations.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FBasePositionSnapSolver3

	FPointPlanarSnapSolver
	FRaySpatialSnapSolver

References

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

Syntax

class FBasePositionSnapSolver3

Remarks

FBasePositionSnapSolver3 is a base class for 3D position snapping implementations. It is not usable on its own and the split between this class and the implementations is not incredibly clean. However there is lots of shared functionality that is placed here.

3D Point and Line targets are supported. Targets can also be "ignored".

The actual snap "solve" must be implemented by subclasses, depending on their input data (ray, point, line, etc)

Variables

	Name	Description
FVector3d	ActiveSnapFromPoint
FSnapTargetPoin...	ActiveSnapTarget
FVector3d	ActiveSnapToPoint
bool	bEnableStableSnap	If true, then we will prefer to keep current snap point over a new one
bool	bHaveActiveSnap	Information about active snap
TSet< int >	IgnoreTargets	List of TargetID values to ignore in snap queries
TFunction< doub...	SnapMetricFunc	ParametersThis is the function we use to measure distances between snap points.
double	SnapMetricTolerance	Tolerance for snapping, in unit relative to SnapMetricFunc
double	SnappedPointMetric
double	StableSnapImproveThresh	How much we have to improve the snap metric to discard the current stable snap
TArray< FSnapTa...	TargetCircles
TArray< FSnapTa...	TargetLines
TArray< FSnapTa...	TargetPoints

Constructors

	Name	Description
	FBasePositionSnapSolver3()

Destructors

	Name	Description
	~FBasePositionSnapSolver3()

Functions

	Name	Description
void	AddCircleTarget ( const FCircle3d& Circle, int TargetID, int Priority )	Add a snap target Circle
void	AddIgnoreTarget ( int TargetID )	Add given TargetID to the ignore list, so any points/lines with that ID will not be snapped-to
void	AddLineTarget ( const FLine3d& Line, int TargetID, int Priority )	Add a snap target line
void	AddPointTarget ( const FVector3d& Position, int TargetID, int Priority )	Add a snap target point at the given Position
void	AddPointTarget ( const FVector3d& Position, int TargetID, const FCustomMetric& CustomMetric, int Priority )	Add a snap target point at the given Position
void	ClearActiveSnapData()
const FSnapT...	FindBestSnapInSet ( const TArray< FSnapTargetPoint >& ..., double& MinMetric, int& MinPriority, const TFunction< FVector3d... )
int32	FindIndexOfBestSnapInSet ( const TArray< FSnapTargetPoint >& ..., double& MinMetric, int& MinPriority, const TFunction< FVector3d... )	Snap measurement functions
int	GetActiveSnapDistanceID()
FVector3d	GetActiveSnapFromPoint()
const FLine3...	GetActiveSnapLine()
int	GetActiveSnapTargetID()
FVector3d	GetActiveSnapToPoint()
bool	HaveActiveSnap()	Solving output
bool	HaveActiveSnapDistance()
bool	HaveActiveSnapLine()
bool	IsIgnored ( int TargetID )
bool	RemoveCircleTargetsByID ( int TargetID )	Remove any line targets with this TargetID
void	RemoveIgnoreTarget ( int TargetID )	Add given TargetID from the ignore list
bool	RemoveLineTargetsByID ( int TargetID )	Remove any line targets with this TargetID
bool	RemovePointTargetsByID ( int TargetID )	Remove any point targets with this TargetID
void	Reset()	Discard the set of snap points and lines and clear the active snap
void	ResetActiveSnap()	Clear the active snap
void	SetActiveSnapData ( const FSnapTargetPoint& TargetPoin..., const FVector3d& FromPoint, const FVector3d& ToPoint, double Metric )
bool	TestSnapTarget ( const FSnapTargetPoint& Target, double MinMetric, int MinPriority, const TFunction< FVector3d... )

Classes

	Name	Description
	FCustomMetric	FCustomMetric overrides/modifies the default should-snap-happen metric
	FSnapTargetCircle
	FSnapTargetLine	Target line that might be snapped to
	FSnapTargetPoint	Target point that might be snapped to

Enums

	Name	Description
	ECustomMetricType	SetupECustomMetricType defines how a FCustomMetric should be interpreted

Constants

Name	Description
BaseExternalLineID	Subclasses may have internal TargetID values, so external lines should have IDs larger than this
BaseExternalPointID	Subclasses may have internal TargetID values, so external points should have IDs larger than this