Translates KiCad board geometry to and from the planegcs solver (issue #2329). More...

#include <board_constraint_adapter.h>

Classes
struct	ANCHOR_PARAMS
	Param indices of an anchor coordinates a rect corner aliases mixed start end params so y is not always x plus 1. More...

struct	RIGID_RADIUS_HOLD

struct	RIGID_STATE

struct	SHAPE_VARS
	Per-shape indices into m_params. More...

Public Types
using	SNAPSHOT = CONSTRAINT_SYSTEM_2D::SNAPSHOT

Public Member Functions
	BOARD_CONSTRAINT_ADAPTER ()

	~BOARD_CONSTRAINT_ADAPTER ()

	BOARD_CONSTRAINT_ADAPTER (const BOARD_CONSTRAINT_ADAPTER &)=delete

BOARD_CONSTRAINT_ADAPTER &	operator= (const BOARD_CONSTRAINT_ADAPTER &)=delete

bool	Build (const std::vector< PCB_SHAPE * > &aShapes, const std::vector< PCB_CONSTRAINT * > &aConstraints, const std::set< KIID > aFixedShapes=nullptr, const std::vector< PCB_DIMENSION_BASE > &aDimensions={})
	Translate a cluster into a planegcs system.

const std::vector< KIID > &	UnmappedConstraints () const
	Constraints from the last Build() that could not be mapped onto a solver primitive (wrong member count/kind for their type, e.g.

bool	Solve (const CONSTRAINT_MEMBER &aDragged, const VECTOR2I &aCursor, bool aStabilize=false, const std::set< KIID > &aEdited={}, const std::optional< std::pair< CONSTRAINT_MEMBER, VECTOR2I > > &aCoDragged=std::nullopt, bool aHoldDraggedRigid=false)
	Solve the system, pinning a dragged anchor to a cursor position.

bool	SolveSnapRelations (const CONSTRAINT_MEMBER &aDragged, const std::vector< SNAP_CANDIDATE > &aCandidates, const VECTOR2I &aCursor)

bool	SolveRigidTranslation (const std::set< KIID > &aEditedShapes, const VECTOR2I &aTranslation)

bool	SolveRigidSnapRelations (const std::set< KIID > &aEditedShapes, const VECTOR2I &aReference, const std::vector< SNAP_CANDIDATE > &aCandidates, const VECTOR2I &aCursor, VECTOR2I &aResolvedCursor)

bool	Solve (bool aStabilize=false)
	Solve with no drag pin. `aStabilize` holds free segment lengths (see the dragged overload).

bool	SolveAfterResize (const KIID &aResizedShape)
	Solve after a resize.

std::vector< PCB_SHAPE * >	Apply (const std::function< void(BOARD_ITEM *)> &aBeforeWrite={})
	Write the solved coordinates back into the shapes, de-normalized to IU.

void	ApplyReferenceValues (const std::function< void(BOARD_ITEM *)> &aBeforeWrite={})
	Propagate solved reference (non-driving) constraint values back into their m_value so a reference dimension tracks the geometry it measures.

CONSTRAINT_DIAGNOSIS	Diagnose ()
	Report degrees of freedom and conflicting/redundant constraints.

SNAPSHOT	Snapshot () const

bool	Restore (const SNAPSHOT &aSnapshot)

std::optional< VECTOR2I >	AnchorPosition (const CONSTRAINT_MEMBER &aMember) const

bool	QuantizedRelationsSatisfied ()

bool	CurrentRelationsSatisfied () const

Private Types
enum class	SHAPE_KIND { SEGMENT , BEZIER , CIRCLE , ARC , ELLIPSE , ELLIPSE_ARC , POINT_PAIR , RECT , POLYGON }

Private Member Functions
int	pushParam (double aValue)
	Append a normalized coordinate to the backing store, returning its stable index.

int	temporaryParam (double aValue)

void	beginTemporaryParameters ()

bool	addSnapRelations (const ANCHOR_PARAMS &aAnchor, const std::vector< SNAP_CANDIDATE > &aCandidates, const VECTOR2I &aOffset)

RIGID_STATE	collectRigidState (const std::set< KIID > &aEditedShapes) const

void	holdRigidRadii (const std::vector< RIGID_RADIUS_HOLD > &aRadii, int aTag)

void	recordReferenceValue (PCB_CONSTRAINT *aConstraint)
	Note a non-driving valued constraint so its measured value can be read back after a solve.

void	holdFreeSegmentLengths (int aTag, const std::set< KIID > &aShapes)
	Length hold on the free segments in `aShapes` tagged `aTag` so only those shapes are protected while a merely dragged-along neighbour keeps its own stay-put pins instead.

void	holdFreeArcRadii (int aTag, const std::set< KIID > &aShapes)
	Radius hold on the free arcs in `aShapes` tagged `aTag` so an angle change rotates an endpoint instead of collapsing the arc a real FIXED_RADIUS still wins.

void	holdShapesRigid (int aTag, const std::set< KIID > &aShapes)
	Hold the shapes in `aShapes` rigid, tagged `aTag`, so a shape the solve moves translates instead of stretching.

void	holdArcRadius (const SHAPE_VARS &aVars, int aTag)
	Hold `aVars's` arc at its current radius (tagged `aTag`).

void	softPinPoint (const ANCHOR_PARAMS &aPoint, int aTag, std::optional< double > aWeight=std::nullopt)
	Pin the point at `aPoint` where it sits tagged `aTag` with `aWeight` rescaling the tier or the default weight overriding the stay-put tier when unset an invalid point is ignored.

void	softPinPoint (int aPointX, int aTag, std::optional< double > aWeight=std::nullopt)
	As above for the point whose x param is `aPointX` and whose y param follows it.

void	holdPolygonVertices (const std::set< KIID > &aShapes, int aTag)
	Soft-pin every vertex of each POLYGON in `aShapes` tagged `aTag` for edited shapes pinUneditedShapes excludes so unbound vertices keep their null-space minimal-movement pins.

void	pinDraggedShapeRest (const CONSTRAINT_MEMBER &aDragged, int aTag, const CONSTRAINT_MEMBER *aCoDragged=nullptr)
	Hold the parts of the dragged shape meant to stay put tagged `aTag` a segment holds its far endpoint an arc holds centre radius and far endpoint or both endpoints on a centre drag.

void	pinUneditedShapes (const std::set< KIID > &aEdited, int aTag)
	Soft-pin every cluster shape not in `aEdited` at its current geometry tagged `aTag` for a minimal-movement solve `aEdited` must list every edited shape or a neighbour gets held back.

bool	solveSucceeded (int aSolveResult)
	Decide whether a solve reached a usable result a raw Success or Converged always qualifies while a Failed code is accepted only when every driving hard constraint is still satisfied.

bool	hardRelationsSatisfied () const

ANCHOR_PARAMS	anchorParams (const CONSTRAINT_MEMBER &aMember) const
	Indices into m_params of the coordinates an anchor maps to invalid if the shape has no such anchor for example a circle has no endpoints.

PCB_DIM_ORTHOGONAL *	orthogonalDimensionForMembers (const std::vector< CONSTRAINT_MEMBER > &aMembers) const
	The orthogonal dimension a two-point length constraint drives or nullptr requires both members to be the same dimension START and END in either order.

double	normalizeX (int aIU) const
	IU <-> normalized (millimetre, cluster-centred) frame, per axis.

double	normalizeY (int aIU) const

double	denormalizeX (double aNorm) const

double	denormalizeY (double aNorm) const

Private Attributes
CONSTRAINT_SYSTEM_2D	m_system

GCS::System *	m_gcs

std::deque< double > &	m_params

std::map< KIID, SHAPE_VARS >	m_shapeVars

std::map< int, KIID >	m_tagToConstraint

std::set< int >	m_nonDrivingTags
	Measurement-only; excluded from conflict residuals.

std::map< int, std::vector< KIID > >	m_tagMembers
	Member items per tag, for collapse attribution.

std::vector< PCB_CONSTRAINT * >	m_referenceConstraints
	Non-driving valued, read back after a solve.

std::vector< KIID >	m_unmapped
	Constraints Build() could not map (not enforced).

std::set< KIID >	m_angleConstrainedShapes
	Shapes a direction or angle constraint could collapse to a point only these get a stabilize length or radius hold.

double	m_scale = 1.0
	IU per normalized unit.

double	m_invScale = 1.0
	1 / m_scale.

int	m_dragTargetX = -1
	Stable backing slot for the drag pin's x target (-1 = unset).

int	m_dragTargetY = -1
	Stable backing slot for the drag pin's y target.

int	m_coDragTargetX = -1
	Backing slot for the co-dragged pin x target.

int	m_coDragTargetY = -1
	Backing slot for the co-dragged pin y target.

std::vector< int >	m_temporaryParams

size_t	m_nextTemporaryParam = 0

int	m_lengthHoldTag = -1

int	m_resizeRadiusTag = -1

bool	m_built = false

Detailed Description

Translates KiCad board geometry to and from the planegcs solver (issue #2329).

Build() translates a cluster of #PCB_SHAPEs and the #PCB_CONSTRAINTs among them into a planegcs system, scaled into a millimetre frame because raw IU (nanometres) squared in the residuals is badly conditioned. Solve() runs the solver (optionally pinning a dragged anchor to a cursor position), Apply() writes the solution back to the shapes in IU, and Diagnose() reports the constraint state.

CONSTRAINT_SYSTEM_2D owns the normalized coordinate frame, planegcs system, and pointer-stable parameter storage. This adapter maps board geometry and authored constraints into that shared solver-neutral lifetime.

Definition at line 106 of file board_constraint_adapter.h.

Member Typedef Documentation

◆ SNAPSHOT

using BOARD_CONSTRAINT_ADAPTER::SNAPSHOT = CONSTRAINT_SYSTEM_2D::SNAPSHOT

Definition at line 198 of file board_constraint_adapter.h.

Member Enumeration Documentation

◆ SHAPE_KIND

enum class BOARD_CONSTRAINT_ADAPTER::SHAPE_KIND

strongprivate

Enumerator
SEGMENT
BEZIER	A cubic bezier only its start and end endpoints are exposed as free points.
CIRCLE
ARC
ELLIPSE
ELLIPSE_ARC
POINT_PAIR	A dimension's two feature points (start + end); no line/curve geometry.
RECT	An axis-aligned rectangle whose four corners alias the two stored corners params so rectness holds by construction with no extra DOF.
POLYGON	A single hole-free outline with one free param pair per vertex since write-back rebuilds one outline only.

Definition at line 207 of file board_constraint_adapter.h.

Constructor & Destructor Documentation

◆ BOARD_CONSTRAINT_ADAPTER() [1/2]

BOARD_CONSTRAINT_ADAPTER::BOARD_CONSTRAINT_ADAPTER ( )

Definition at line 287 of file board_constraint_adapter.cpp.

References m_gcs, m_params, and m_system.

Referenced by BOARD_CONSTRAINT_ADAPTER(), and operator=().

◆ ~BOARD_CONSTRAINT_ADAPTER()

BOARD_CONSTRAINT_ADAPTER::~BOARD_CONSTRAINT_ADAPTER ( )

Definition at line 294 of file board_constraint_adapter.cpp.

◆ BOARD_CONSTRAINT_ADAPTER() [2/2]

BOARD_CONSTRAINT_ADAPTER::BOARD_CONSTRAINT_ADAPTER ( const BOARD_CONSTRAINT_ADAPTER & )

delete

References BOARD_CONSTRAINT_ADAPTER().

Member Function Documentation

◆ addSnapRelations()

bool BOARD_CONSTRAINT_ADAPTER::addSnapRelations	(	const ANCHOR_PARAMS &	aAnchor,
		const std::vector< SNAP_CANDIDATE > &	aCandidates,
		const VECTOR2I &	aOffset )

private

Definition at line 1624 of file board_constraint_adapter.cpp.

References anchor, ANGLE, BBOX_ALIGNMENT, BBOX_EQUAL_GAP, center, CIRCLE, circle(), COINCIDENCE, GRID_X, GRID_Y, KiROUND(), m_gcs, m_invScale, m_params, NORMAL, normalizeX(), normalizeY(), POINT_ON_ARC, POINT_ON_CIRCLE, POINT_ON_LINE, POINT_ON_RAY, POINT_ON_SEGMENT, radius, TANGENT, temporaryParam(), BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::x, VECTOR2< T >::x, X_COORDINATE, BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::y, VECTOR2< T >::y, and Y_COORDINATE.

Referenced by SolveRigidSnapRelations(), and SolveSnapRelations().

◆ anchorParams()

BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS BOARD_CONSTRAINT_ADAPTER::anchorParams ( const CONSTRAINT_MEMBER & aMember ) const

private

Indices into m_params of the coordinates an anchor maps to invalid if the shape has no such anchor for example a circle has no endpoints.

Definition at line 443 of file board_constraint_adapter.cpp.

Referenced by AnchorPosition(), ApplyReferenceValues(), Build(), pinDraggedShapeRest(), Solve(), and SolveSnapRelations().

◆ AnchorPosition()

std::optional< VECTOR2I > BOARD_CONSTRAINT_ADAPTER::AnchorPosition ( const CONSTRAINT_MEMBER & aMember ) const

Definition at line 1989 of file board_constraint_adapter.cpp.

References anchorParams(), denormalizeX(), denormalizeY(), BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::IsValid(), KiROUND(), m_params, BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::x, and BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::y.

◆ Apply()

std::vector< PCB_SHAPE * > BOARD_CONSTRAINT_ADAPTER::Apply ( const std::function< void(BOARD_ITEM *)> & aBeforeWrite = {} )

Write the solved coordinates back into the shapes, de-normalized to IU.

Only shapes whose geometry actually changed are written. aBeforeWrite, if set, is invoked with each such shape immediately before it is mutated, so a caller can stage it in an undo commit (BOARD_COMMIT::Modify) before the change.

Returns: the shapes that were changed.

Definition at line 2346 of file board_constraint_adapter.cpp.

References std::abs(), ARC, BEZIER, center, CIRCLE, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), denormalizeX(), denormalizeY(), ELLIPSE, ELLIPSE_ARC, end, PCB_DIM_RADIAL::GetKnee(), PCB_TEXT::GetTextPos(), SHAPE_POLY_SET::HoleCount(), KiROUND(), m_built, m_params, M_PI, m_scale, m_shapeVars, moved, SHAPE_POLY_SET::OutlineCount(), PCB_DIM_RADIAL_T, POINT_PAIR, SHAPE_LINE_CHAIN::PointCount(), POLYGON, RADIANS_T, radius, RECT, EDA_TEXT::SetTextPos(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

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_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(), ReSolveAfterShapeResize(), KI_TEST::solveAndApply(), and SolveCluster().

◆ ApplyReferenceValues()

void BOARD_CONSTRAINT_ADAPTER::ApplyReferenceValues ( const std::function< void(BOARD_ITEM *)> & aBeforeWrite = {} )

Propagate solved reference (non-driving) constraint values back into their m_value so a reference dimension tracks the geometry it measures.

Call after Apply(); the value is measured from the written shape geometry (not the raw solver param, which rounds separately), so a settled solve re-measures the same value and stages nothing. The value is always written when it changed; aBeforeWrite, if set, stages that constraint (BOARD_COMMIT::Modify) first so the write is undoable. Driving constraints are never touched.

Definition at line 329 of file board_constraint_adapter.cpp.

References std::abs(), anchor, anchorParams(), ANGULAR_DIMENSION, ARC_ANGLE, EDA_ANGLE::AsDegrees(), denormalizeX(), denormalizeY(), FIXED_LENGTH, FIXED_RADIUS, EDA_SHAPE::GetArcAngle(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetStart(), PCB_DIM_ORTHOGONAL::HORIZONTAL, KiROUND(), m_built, m_params, m_referenceConstraints, m_shapeVars, MeasureCornerAngle(), ortho, and orthogonalDimensionForMembers().

Referenced by ReSolveAfterShapeResize(), and SolveCluster().

◆ beginTemporaryParameters()

void BOARD_CONSTRAINT_ADAPTER::beginTemporaryParameters ( )

private

Definition at line 316 of file board_constraint_adapter.cpp.

References m_nextTemporaryParam.

Referenced by Solve(), Solve(), SolveAfterResize(), SolveRigidSnapRelations(), SolveRigidTranslation(), and SolveSnapRelations().

◆ Build()

bool BOARD_CONSTRAINT_ADAPTER::Build	(	const std::vector< PCB_SHAPE * > &	aShapes,
		const std::vector< PCB_CONSTRAINT * > &	aConstraints,
		const std::set< KIID > *	aFixedShapes = nullptr,
		const std::vector< PCB_DIMENSION_BASE * > &	aDimensions = {} )

Translate a cluster into a planegcs system.

Parameters

aShapes	the shapes referenced by the constraints (resolved by the caller).
aConstraints	the constraints relating those shapes.
aFixedShapes	shapes to treat as immovable references (their whole span is frozen).
aDimensions	dimensions referenced by the constraints; each contributes its two feature points, so a coincident constraint can drag a dimension along with a shape.

Returns: true if the system was built; unmappable constraints are skipped rather than fatal, and are listed by UnmappedConstraints() so the caller can flag them.

Definition at line 542 of file board_constraint_adapter.cpp.

◆ collectRigidState()

BOARD_CONSTRAINT_ADAPTER::RIGID_STATE BOARD_CONSTRAINT_ADAPTER::collectRigidState ( const std::set< KIID > & aEditedShapes ) const

private

◆ CurrentRelationsSatisfied()

bool BOARD_CONSTRAINT_ADAPTER::CurrentRelationsSatisfied ( ) const

inline

Definition at line 204 of file board_constraint_adapter.h.

References hardRelationsSatisfied().

◆ denormalizeX()

double BOARD_CONSTRAINT_ADAPTER::denormalizeX ( double aNorm ) const

inlineprivate

Definition at line 338 of file board_constraint_adapter.h.

References m_system.

Referenced by AnchorPosition(), Apply(), ApplyReferenceValues(), QuantizedRelationsSatisfied(), SolveRigidSnapRelations(), and SolveRigidTranslation().

◆ denormalizeY()

double BOARD_CONSTRAINT_ADAPTER::denormalizeY ( double aNorm ) const

inlineprivate

Definition at line 339 of file board_constraint_adapter.h.

References m_system.

Referenced by AnchorPosition(), Apply(), ApplyReferenceValues(), QuantizedRelationsSatisfied(), SolveRigidSnapRelations(), and SolveRigidTranslation().

◆ Diagnose()

CONSTRAINT_DIAGNOSIS BOARD_CONSTRAINT_ADAPTER::Diagnose ( )

Report degrees of freedom and conflicting/redundant constraints.

The residual check reads the last solve's params; a contradictory cluster diverges under the stabilize holds, and the finite residuals it leaves behind are what flag the conflict.

Definition at line 2642 of file board_constraint_adapter.cpp.

References std::abs(), CONSTRAINT_DIAGNOSIS::conflicting, CONSTRAINT_DIAGNOSIS::freeDof, m_built, m_gcs, m_invScale, m_nonDrivingTags, m_params, m_shapeVars, m_tagMembers, m_tagToConstraint, CONSTRAINT_DIAGNOSIS::redundant, and SEGMENT.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), diagnoseSingleCluster(), and SolveCluster().

◆ hardRelationsSatisfied()

bool BOARD_CONSTRAINT_ADAPTER::hardRelationsSatisfied ( ) const

private

Definition at line 2010 of file board_constraint_adapter.cpp.

References std::abs(), m_gcs, m_nonDrivingTags, and m_tagToConstraint.

Referenced by CurrentRelationsSatisfied(), QuantizedRelationsSatisfied(), and solveSucceeded().

◆ holdArcRadius()

void BOARD_CONSTRAINT_ADAPTER::holdArcRadius	(	const SHAPE_VARS &	aVars,
		int	aTag )

private

Hold aVars's arc at its current radius (tagged aTag).

Definition at line 2285 of file board_constraint_adapter.cpp.

References circle(), m_gcs, m_params, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::radius, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::startX, and temporaryParam().

Referenced by holdFreeArcRadii(), and pinDraggedShapeRest().

◆ holdFreeArcRadii()

void BOARD_CONSTRAINT_ADAPTER::holdFreeArcRadii	(	int	aTag,
		const std::set< KIID > &	aShapes )

private

Radius hold on the free arcs in aShapes tagged aTag so an angle change rotates an endpoint instead of collapsing the arc a real FIXED_RADIUS still wins.

Definition at line 2296 of file board_constraint_adapter.cpp.

References ARC, ConstraintItemIsLocked(), holdArcRadius(), and m_shapeVars.

Referenced by Solve(), and Solve().

◆ holdFreeSegmentLengths()

void BOARD_CONSTRAINT_ADAPTER::holdFreeSegmentLengths	(	int	aTag,
		const std::set< KIID > &	aShapes )

private

Length hold on the free segments in aShapes tagged aTag so only those shapes are protected while a merely dragged-along neighbour keeps its own stay-put pins instead.

Definition at line 2264 of file board_constraint_adapter.cpp.

References ConstraintItemIsLocked(), m_gcs, m_params, m_shapeVars, SEGMENT, and temporaryParam().

Referenced by Solve(), and Solve().

◆ holdPolygonVertices()

void BOARD_CONSTRAINT_ADAPTER::holdPolygonVertices	(	const std::set< KIID > &	aShapes,
		int	aTag )

private

Soft-pin every vertex of each POLYGON in aShapes tagged aTag for edited shapes pinUneditedShapes excludes so unbound vertices keep their null-space minimal-movement pins.

Definition at line 2248 of file board_constraint_adapter.cpp.

References ConstraintItemIsLocked(), m_shapeVars, POLYGON, softPinPoint(), and STAY_PUT_WEIGHT.

Referenced by Solve(), and SolveAfterResize().

◆ holdRigidRadii()

void BOARD_CONSTRAINT_ADAPTER::holdRigidRadii	(	const std::vector< RIGID_RADIUS_HOLD > &	aRadii,
		int	aTag )

private

Definition at line 1802 of file board_constraint_adapter.cpp.

References circle(), m_gcs, m_params, and temporaryParam().

Referenced by holdShapesRigid(), SolveRigidSnapRelations(), and SolveRigidTranslation().

◆ holdShapesRigid()

void BOARD_CONSTRAINT_ADAPTER::holdShapesRigid	(	int	aTag,
		const std::set< KIID > &	aShapes )

private

Hold the shapes in aShapes rigid, tagged aTag, so a shape the solve moves translates instead of stretching.

Definition at line 2313 of file board_constraint_adapter.cpp.

References collectRigidState(), ConstraintItemIsLocked(), holdRigidRadii(), m_gcs, m_params, m_shapeVars, BOARD_CONSTRAINT_ADAPTER::RIGID_STATE::points, BOARD_CONSTRAINT_ADAPTER::RIGID_STATE::radii, and temporaryParam().

Referenced by Solve().

◆ normalizeX()

double BOARD_CONSTRAINT_ADAPTER::normalizeX ( int aIU ) const

inlineprivate

IU <-> normalized (millimetre, cluster-centred) frame, per axis.

Definition at line 336 of file board_constraint_adapter.h.

References m_system.

Referenced by addSnapRelations(), Build(), QuantizedRelationsSatisfied(), Solve(), SolveRigidSnapRelations(), and SolveSnapRelations().

◆ normalizeY()

double BOARD_CONSTRAINT_ADAPTER::normalizeY ( int aIU ) const

inlineprivate

Definition at line 337 of file board_constraint_adapter.h.

References m_system.

Referenced by addSnapRelations(), Build(), QuantizedRelationsSatisfied(), Solve(), SolveRigidSnapRelations(), and SolveSnapRelations().

◆ operator=()

BOARD_CONSTRAINT_ADAPTER & BOARD_CONSTRAINT_ADAPTER::operator= ( const BOARD_CONSTRAINT_ADAPTER & )

delete

References BOARD_CONSTRAINT_ADAPTER().

◆ orthogonalDimensionForMembers()

PCB_DIM_ORTHOGONAL * BOARD_CONSTRAINT_ADAPTER::orthogonalDimensionForMembers ( const std::vector< CONSTRAINT_MEMBER > & aMembers ) const

private

The orthogonal dimension a two-point length constraint drives or nullptr requires both members to be the same dimension START and END in either order.

Definition at line 516 of file board_constraint_adapter.cpp.

References END, m_shapeVars, PCB_DIM_ORTHOGONAL_T, POINT_PAIR, and START.

Referenced by ApplyReferenceValues(), and Build().

◆ pinDraggedShapeRest()

void BOARD_CONSTRAINT_ADAPTER::pinDraggedShapeRest	(	const CONSTRAINT_MEMBER &	aDragged,
		int	aTag,
		const CONSTRAINT_MEMBER *	aCoDragged = nullptr )

private

Hold the parts of the dragged shape meant to stay put tagged aTag a segment holds its far endpoint an arc holds centre radius and far endpoint or both endpoints on a centre drag.

Definition at line 2120 of file board_constraint_adapter.cpp.

References anchorParams(), ARC, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::arcEndX, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::arcStartX, BEZIER, CENTER, END, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::endX, holdArcRadius(), BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::kind, CONSTRAINT_MEMBER::m_anchor, CONSTRAINT_MEMBER::m_index, CONSTRAINT_MEMBER::m_item, m_shapeVars, POLYGON, RECT, SEGMENT, softPinPoint(), START, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::startX, VERTEX, and BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::vertexCount.

Referenced by Solve(), and SolveSnapRelations().

◆ pinUneditedShapes()

void BOARD_CONSTRAINT_ADAPTER::pinUneditedShapes	(	const std::set< KIID > &	aEdited,
		int	aTag )

private

Soft-pin every cluster shape not in aEdited at its current geometry tagged aTag for a minimal-movement solve aEdited must list every edited shape or a neighbour gets held back.

Definition at line 2182 of file board_constraint_adapter.cpp.

References ARC, BEZIER, CIRCLE, circle(), ConstraintItemIsLocked(), ELLIPSE, ELLIPSE_ARC, m_gcs, m_params, m_shapeVars, POINT_PAIR, POLYGON, RECT, SEGMENT, softPinPoint(), STAY_PUT_WEIGHT, and temporaryParam().

Referenced by Solve(), Solve(), SolveAfterResize(), SolveRigidSnapRelations(), SolveRigidTranslation(), and SolveSnapRelations().

◆ pushParam()

int BOARD_CONSTRAINT_ADAPTER::pushParam ( double aValue )

private

Append a normalized coordinate to the backing store, returning its stable index.

Definition at line 299 of file board_constraint_adapter.cpp.

References m_system.

Referenced by Build(), and temporaryParam().

◆ QuantizedRelationsSatisfied()

bool BOARD_CONSTRAINT_ADAPTER::QuantizedRelationsSatisfied ( )

Definition at line 2040 of file board_constraint_adapter.cpp.

References denormalizeX(), denormalizeY(), hardRelationsSatisfied(), index, KiROUND(), m_invScale, m_params, m_scale, m_shapeVars, normalizeX(), normalizeY(), POLYGON, Restore(), and Snapshot().

Referenced by SolveRigidSnapRelations(), and SolveRigidTranslation().

◆ recordReferenceValue()

void BOARD_CONSTRAINT_ADAPTER::recordReferenceValue ( PCB_CONSTRAINT * aConstraint )

private

Note a non-driving valued constraint so its measured value can be read back after a solve.

A driving constraint is ignored here – its value is an input, never overwritten.

Definition at line 322 of file board_constraint_adapter.cpp.

References PCB_CONSTRAINT::IsDriving(), and m_referenceConstraints.

Referenced by Build().

◆ Restore()

bool BOARD_CONSTRAINT_ADAPTER::Restore ( const SNAPSHOT & aSnapshot )

inline

Definition at line 201 of file board_constraint_adapter.h.

References m_system.

Referenced by QuantizedRelationsSatisfied().

◆ Snapshot()

SNAPSHOT BOARD_CONSTRAINT_ADAPTER::Snapshot ( ) const

inline

Definition at line 200 of file board_constraint_adapter.h.

References m_system.

Referenced by QuantizedRelationsSatisfied().

◆ softPinPoint() [1/2]

void BOARD_CONSTRAINT_ADAPTER::softPinPoint	(	const ANCHOR_PARAMS &	aPoint,
		int	aTag,
		std::optional< double >	aWeight = std::nullopt )

private

Pin the point at aPoint where it sits tagged aTag with aWeight rescaling the tier or the default weight overriding the stay-put tier when unset an invalid point is ignored.

Definition at line 2090 of file board_constraint_adapter.cpp.

References BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::IsValid(), m_gcs, m_params, temporaryParam(), BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::x, and BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::y.

Referenced by holdPolygonVertices(), pinDraggedShapeRest(), pinUneditedShapes(), softPinPoint(), and SolveRigidTranslation().

◆ softPinPoint() [2/2]

void BOARD_CONSTRAINT_ADAPTER::softPinPoint	(	int	aPointX,
		int	aTag,
		std::optional< double >	aWeight = std::nullopt )

private

As above for the point whose x param is aPointX and whose y param follows it.

Definition at line 2113 of file board_constraint_adapter.cpp.

References softPinPoint().

◆ Solve() [1/2]

bool BOARD_CONSTRAINT_ADAPTER::Solve ( bool aStabilize = false )

Solve with no drag pin. aStabilize holds free segment lengths (see the dragged overload).

Definition at line 1394 of file board_constraint_adapter.cpp.

References beginTemporaryParameters(), holdFreeArcRadii(), holdFreeSegmentLengths(), m_angleConstrainedShapes, m_built, m_gcs, m_lengthHoldTag, pinUneditedShapes(), and solveSucceeded().

◆ Solve() [2/2]

bool BOARD_CONSTRAINT_ADAPTER::Solve	(	const CONSTRAINT_MEMBER &	aDragged,
		const VECTOR2I &	aCursor,
		bool	aStabilize = false,
		const std::set< KIID > &	aEdited = {},
		const std::optional< std::pair< CONSTRAINT_MEMBER, VECTOR2I > > &	aCoDragged = std::nullopt,
		bool	aHoldDraggedRigid = false )

Solve the system, pinning a dragged anchor to a cursor position.

The pin is a temporary (negatively tagged) constraint, so it yields to the real ones and an over-constrained drag leaves the geometry where the rules allow.

Parameters

aDragged	the anchor being dragged.
aCursor	the cursor target, in IU.
aEdited	other shapes edited alongside the dragged one excluded from stay-put pins
aCoDragged	second anchor moved by the same handle with its own target pinned at the same weight since a polygon edge drag needs two independent points `aStabilize` holds free segment lengths so an angle constraint rotates a segment instead of collapsing it. Off for live dragging. `aHoldDraggedRigid` holds the dragged shape's own geometry, so it travels whole instead of stretching to meet the relation.

Definition at line 1486 of file board_constraint_adapter.cpp.

References anchor, anchorParams(), ARC, beginTemporaryParameters(), END, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::endX, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::fixedLengthParam, holdFreeArcRadii(), holdFreeSegmentLengths(), holdPolygonVertices(), holdShapesRigid(), BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::IsValid(), CONSTRAINT_MEMBER::m_anchor, m_angleConstrainedShapes, m_built, m_coDragTargetX, m_coDragTargetY, m_dragTargetX, m_dragTargetY, m_gcs, CONSTRAINT_MEMBER::m_item, m_params, m_shapeVars, normalizeX(), normalizeY(), pinDraggedShapeRest(), pinUneditedShapes(), BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::radius, radius, SEGMENT, solveSucceeded(), START, BOARD_CONSTRAINT_ADAPTER::SHAPE_VARS::startX, BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::x, VECTOR2< T >::x, BOARD_CONSTRAINT_ADAPTER::ANCHOR_PARAMS::y, and VECTOR2< T >::y.

◆ SolveAfterResize()

bool BOARD_CONSTRAINT_ADAPTER::SolveAfterResize ( const KIID & aResizedShape )

Solve after a resize.

Holds the resized radius, pins its centre (yielding), and holds the other radii (yielding), so neighbours translate and the resized shape moves only if forced.

Definition at line 1427 of file board_constraint_adapter.cpp.

References beginTemporaryParameters(), holdPolygonVertices(), m_built, m_gcs, m_params, m_resizeRadiusTag, m_shapeVars, pinUneditedShapes(), solveSucceeded(), and temporaryParam().

Referenced by ReSolveAfterShapeResize().

◆ SolveRigidSnapRelations()

bool BOARD_CONSTRAINT_ADAPTER::SolveRigidSnapRelations	(	const std::set< KIID > &	aEditedShapes,
		const VECTOR2I &	aReference,
		const std::vector< SNAP_CANDIDATE > &	aCandidates,
		const VECTOR2I &	aCursor,
		VECTOR2I &	aResolvedCursor )

◆ SolveRigidTranslation()

bool BOARD_CONSTRAINT_ADAPTER::SolveRigidTranslation	(	const std::set< KIID > &	aEditedShapes,
		const VECTOR2I &	aTranslation )

Definition at line 1854 of file board_constraint_adapter.cpp.

References beginTemporaryParameters(), collectRigidState(), denormalizeX(), denormalizeY(), holdRigidRadii(), KiROUND(), m_built, m_gcs, m_invScale, m_params, pinUneditedShapes(), BOARD_CONSTRAINT_ADAPTER::RIGID_STATE::points, QuantizedRelationsSatisfied(), BOARD_CONSTRAINT_ADAPTER::RIGID_STATE::radii, softPinPoint(), solveSucceeded(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ SolveSnapRelations()

bool BOARD_CONSTRAINT_ADAPTER::SolveSnapRelations	(	const CONSTRAINT_MEMBER &	aDragged,
		const std::vector< SNAP_CANDIDATE > &	aCandidates,
		const VECTOR2I &	aCursor )

◆ solveSucceeded()

bool BOARD_CONSTRAINT_ADAPTER::solveSucceeded ( int aSolveResult )

private

Decide whether a solve reached a usable result a raw Success or Converged always qualifies while a Failed code is accepted only when every driving hard constraint is still satisfied.

Definition at line 2001 of file board_constraint_adapter.cpp.

References hardRelationsSatisfied().

Referenced by Solve(), Solve(), SolveAfterResize(), SolveRigidSnapRelations(), SolveRigidTranslation(), and SolveSnapRelations().