1. Epic GamesDeveloper
  3. FBasePositionSnapSolver3

FBasePositionSnapSolver3

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

Unreal Engine C++ API Reference > Plugins > ModelingComponents > Snapping

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

AddCircleTarget ( const FCircle3d& Circle,
int TargetID,
int Priority
)

 Add a snap target Circle
Public function Virtual void

AddIgnoreTarget ( int TargetID
)

 Add given TargetID to the ignore list, so any points/lines with that ID will not be snapped-to
Public function Virtual void

AddLineTarget ( const FLine3d& Line,
int TargetID,
int Priority
)

 Add a snap target line
Public function Virtual void

AddPointTarget ( const FVector3d& Position,
int TargetID,
int Priority
)

 Add a snap target point at the given Position
Public function Virtual void

AddPointTarget ( const FVector3d& Position,
int TargetID,
const FCustomMetric& CustomMetric,
int Priority
)

 Add a snap target point at the given Position
Protected function Virtual void  
Protected function const FSnapTargetPoint *

FindBestSnapInSet ( const TArray< FSnapTargetPoint >& TestTargets,
double& MinMetric,
int& MinPriority,
const TFunction< FVector3d(const FVector3d&)>& GetSnapPointFromFunc
)

  
Protected function int32

FindIndexOfBestSnapInSet ( const TArray< FSnapTargetPoint >& TestTargets,
double& MinMetric,
int& MinPriority,
const TFunction< FVector3d(const FVector3d&)>& GetSnapPointFromFunc
)

 Snap measurement functions
Public function Const int  
Public function Const FVector3d  
Public function Const const FLine3d &  
Public function Const int  
Public function Const FVector3d  
Public function Const bool Solving output
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool

IsIgnored ( int TargetID
)

  
Public function Virtual bool

RemoveCircleTargetsByID ( int TargetID
)

 Remove any line targets with this TargetID
Public function Virtual void

RemoveIgnoreTarget ( int TargetID
)

 Add given TargetID from the ignore list
Public function Virtual bool

RemoveLineTargetsByID ( int TargetID
)

 Remove any line targets with this TargetID
Public function Virtual bool

RemovePointTargetsByID ( int TargetID
)

 Remove any point targets with this TargetID
Public function Virtual void

Reset ()

 Discard the set of snap points and lines and clear the active snap
Public function Virtual void Clear the active snap
Protected function Virtual void

SetActiveSnapData ( const FSnapTargetPoint& TargetPoint,
const FVector3d& FromPoint,
const FVector3d& ToPoint,
double Metric
)

  
Protected function bool

TestSnapTarget ( const FSnapTargetPoint& Target,
double MinMetric,
int MinPriority,
const TFunction< FVector3d(const FVector3d&)>& GetSnapPointFromFunc
)

  

Classes

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

Enums

  Type Name Description
Public enum 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page