KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Static Public Member Functions | Public Attributes | List of all members
SNAP_CANDIDATE Struct Reference

#include <snap_resolver.h>

Static Public Member Functions

static SNAP_CANDIDATE Point (SNAP_STABLE_ID aId, SNAP_PRIORITY_TIER aPriority, SNAP_CANDIDATE_SUBTYPE aSubtype, const VECTOR2I &aPoint, double aResidual)
 
static SNAP_CANDIDATE Line (SNAP_STABLE_ID aId, SNAP_PRIORITY_TIER aPriority, SNAP_CANDIDATE_SUBTYPE aSubtype, const VECTOR2I &aOrigin, const VECTOR2D &aDirection, double aResidual)
 
static SNAP_CANDIDATE AxisX (SNAP_STABLE_ID aId, SNAP_PRIORITY_TIER aPriority, SNAP_CANDIDATE_SUBTYPE aSubtype, int aCoordinate, double aResidual)
 
static SNAP_CANDIDATE AxisY (SNAP_STABLE_ID aId, SNAP_PRIORITY_TIER aPriority, SNAP_CANDIDATE_SUBTYPE aSubtype, int aCoordinate, double aResidual)
 

Public Attributes

SNAP_STABLE_ID id
 
SNAP_PRIORITY_TIER priority = SNAP_PRIORITY_TIER::CURSOR
 
SNAP_CANDIDATE_SUBTYPE subtype = SNAP_CANDIDATE_SUBTYPE::CURSOR
 
SNAP_RELATION relation = SNAP_RELATION::COINCIDENCE
 
VECTOR2D origin
 
VECTOR2D direction
 
double normalizedScreenResidual = 0.0
 
int referenceAffinity = 0
 
int consumedDof = 0
 
bool finite = false
 
double domainStart = 0.0
 
double domainEnd = 0.0
 
std::vector< SNAP_GUIDE > guides
 
std::optional< INTERSECTABLE_GEOM > manifold
 

Detailed Description

Definition at line 213 of file snap_resolver.h.

Member Function Documentation

◆ AxisX()

SNAP_CANDIDATE SNAP_CANDIDATE::AxisX ( SNAP_STABLE_ID aId,
SNAP_PRIORITY_TIER aPriority,
SNAP_CANDIDATE_SUBTYPE aSubtype,
int aCoordinate,
double aResidual )
static

Definition at line 534 of file snap_resolver.cpp.

References consumedDof, direction, GRID, GRID_X, id, normalizedScreenResidual, origin, priority, relation, subtype, and X_COORDINATE.

Referenced by authoredSnapRelation(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and GRID_HELPER::emitSelfAndGridCandidates().

◆ AxisY()

SNAP_CANDIDATE SNAP_CANDIDATE::AxisY ( SNAP_STABLE_ID aId,
SNAP_PRIORITY_TIER aPriority,
SNAP_CANDIDATE_SUBTYPE aSubtype,
int aCoordinate,
double aResidual )
static

Definition at line 550 of file snap_resolver.cpp.

References consumedDof, direction, GRID, GRID_Y, id, normalizedScreenResidual, origin, priority, relation, subtype, and Y_COORDINATE.

Referenced by authoredSnapRelation(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and GRID_HELPER::emitSelfAndGridCandidates().

◆ Line()

SNAP_CANDIDATE SNAP_CANDIDATE::Line ( SNAP_STABLE_ID aId,
SNAP_PRIORITY_TIER aPriority,
SNAP_CANDIDATE_SUBTYPE aSubtype,
const VECTOR2I & aOrigin,
const VECTOR2D & aDirection,
double aResidual )
static

Definition at line 517 of file snap_resolver.cpp.

References ANGLE, consumedDof, direction, id, normalizedScreenResidual, origin, POINT_ON_LINE, priority, relation, and subtype.

Referenced by authoredSnapRelation(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and GRID_HELPER::emitAngleBranchCandidates().

◆ Point()

SNAP_CANDIDATE SNAP_CANDIDATE::Point ( SNAP_STABLE_ID aId,
SNAP_PRIORITY_TIER aPriority,
SNAP_CANDIDATE_SUBTYPE aSubtype,
const VECTOR2I & aPoint,
double aResidual )
static

Definition at line 502 of file snap_resolver.cpp.

References COINCIDENCE, consumedDof, id, normalizedScreenResidual, origin, priority, relation, and subtype.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SNAP_INFERENCE_PROVIDER::CollectObjectGeometry(), SNAP_INFERENCE_PROVIDER::CollectTangentNormal(), GRID_HELPER::emitSelfAndGridCandidates(), EE_GRID_HELPER::ResolveSnap(), and PCB_GRID_HELPER::ResolveSnap().

Member Data Documentation

◆ consumedDof

int SNAP_CANDIDATE::consumedDof = 0

Definition at line 223 of file snap_resolver.h.

Referenced by BOARD_CONSTRAINT_SESSION::accept(), authoredSnapRelation(), AxisX(), AxisY(), Line(), and Point().

◆ direction

VECTOR2D SNAP_CANDIDATE::direction

Definition at line 220 of file snap_resolver.h.

Referenced by AxisX(), AxisY(), BOOST_FIXTURE_TEST_CASE(), and Line().

◆ domainEnd

double SNAP_CANDIDATE::domainEnd = 0.0

Definition at line 226 of file snap_resolver.h.

◆ domainStart

double SNAP_CANDIDATE::domainStart = 0.0

Definition at line 225 of file snap_resolver.h.

◆ finite

bool SNAP_CANDIDATE::finite = false

Definition at line 224 of file snap_resolver.h.

◆ guides

std::vector<SNAP_GUIDE> SNAP_CANDIDATE::guides

Definition at line 227 of file snap_resolver.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SNAP_INFERENCE_PROVIDER::CollectAlignment(), SNAP_INFERENCE_PROVIDER::CollectEqualSpacing(), and SNAP_INFERENCE_PROVIDER::CollectTangentNormal().

◆ id

SNAP_STABLE_ID SNAP_CANDIDATE::id

Definition at line 215 of file snap_resolver.h.

Referenced by authoredSnapRelation(), AxisX(), AxisY(), SNAP_INFERENCE_PROVIDER::CollectEqualSpacing(), Line(), Point(), and SNAP_RESOLVER::Resolve().

◆ manifold

std::optional<INTERSECTABLE_GEOM> SNAP_CANDIDATE::manifold

Definition at line 228 of file snap_resolver.h.

Referenced by authoredSnapRelation().

◆ normalizedScreenResidual

double SNAP_CANDIDATE::normalizedScreenResidual = 0.0

Definition at line 221 of file snap_resolver.h.

Referenced by AxisX(), AxisY(), SNAP_INFERENCE_PROVIDER::CollectEqualSpacing(), Line(), Point(), and SNAP_RESOLVER::Resolve().

◆ origin

VECTOR2D SNAP_CANDIDATE::origin

Definition at line 219 of file snap_resolver.h.

Referenced by authoredSnapRelation(), AxisX(), AxisY(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), Line(), Point(), and SNAP_RESOLVER::Resolve().

◆ priority

SNAP_PRIORITY_TIER SNAP_CANDIDATE::priority = SNAP_PRIORITY_TIER::CURSOR

Definition at line 216 of file snap_resolver.h.

Referenced by authoredSnapRelation(), AxisX(), AxisY(), Line(), Point(), and SNAP_RESOLVER::Resolve().

◆ referenceAffinity

int SNAP_CANDIDATE::referenceAffinity = 0

Definition at line 222 of file snap_resolver.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SNAP_INFERENCE_PROVIDER::CollectAlignment(), and SNAP_RESOLVER::Resolve().

◆ relation

SNAP_RELATION SNAP_CANDIDATE::relation = SNAP_RELATION::COINCIDENCE

Definition at line 218 of file snap_resolver.h.

Referenced by authoredSnapRelation(), AxisX(), AxisY(), BOOST_FIXTURE_TEST_CASE(), SNAP_INFERENCE_PROVIDER::CollectAlignment(), SNAP_INFERENCE_PROVIDER::CollectEqualSpacing(), SNAP_INFERENCE_PROVIDER::CollectTangentNormal(), Line(), Point(), and SNAP_RESOLVER::Resolve().

◆ subtype

SNAP_CANDIDATE_SUBTYPE SNAP_CANDIDATE::subtype = SNAP_CANDIDATE_SUBTYPE::CURSOR

Definition at line 217 of file snap_resolver.h.

Referenced by authoredSnapRelation(), AxisX(), AxisY(), Line(), and Point().

The documentation for this struct was generated from the following files: