#include <board_constraint_adapter.h>

Inheritance diagram for BOARD_CONSTRAINT_DRAG_SESSION:

Public Member Functions
bool	Build (BOARD *aBoard, const CONSTRAINT_MEMBER &aDragged)

bool	Matches (const CONSTRAINT_MEMBER &aDragged) const

bool	IsExactFeasible (const VECTOR2I &aTarget)

SNAP_RESULT	ResolveCandidates (const SNAP_SOURCE_CONTEXT &aContext, const std::vector< SNAP_CANDIDATE > &aCandidates)

CONSTRAINT_DIAGNOSIS	Solve (const VECTOR2I &aCursor, std::vector< PCB_SHAPE * > aModified, const std::function< void(BOARD_ITEM )> &aBeforeModify, bool aIncludeDragged, bool aStabilize, const std::set< KIID > &aEdited={}, const std::optional< std::pair< CONSTRAINT_MEMBER, VECTOR2I > > &aCoDragged=std::nullopt)

bool	HasBaseConflict () const

Protected Member Functions
bool	buildCluster (BOARD aBoard, const std::unordered_set< KIID > &aClusterShapes, const std::vector< PCB_CONSTRAINT > &aConstraints)
	Assemble the adapter for one cluster and record its baseline.

void	reset ()
	Drop the built cluster, leaving the session unusable until the next successful build.

bool	usable () const

bool	rewind ()
	Rewind to the state the next speculative solve starts from.

SNAP_RESULT	startResult (const SNAP_SOURCE_CONTEXT &aContext) const
	Seed a snap result at the cursor, rejecting a cluster that was already broken.

Static Protected Member Functions
static void	accept (SNAP_RESULT &aResult, const SNAP_CANDIDATE &aCandidate, double aResidual)
	Record one candidate the session honoured.

Protected Attributes
BOARD *	m_board = nullptr

std::unique_ptr< BOARD_CONSTRAINT_ADAPTER >	m_adapter

BOARD_CONSTRAINT_ADAPTER::SNAPSHOT	m_baseline

bool	m_baseConflict = false

Private Attributes
CONSTRAINT_MEMBER	m_dragged

PCB_SHAPE *	m_draggedShape = nullptr

Detailed Description

Definition at line 433 of file board_constraint_adapter.h.

Member Function Documentation

◆ accept()

void BOARD_CONSTRAINT_SESSION::accept	(	SNAP_RESULT &	aResult,
		const SNAP_CANDIDATE &	aCandidate,
		double	aResidual )

staticprotectedinherited

Record one candidate the session honoured.

Only the residual and the freedom consumed belong here. SNAP_RESOLVER appends the id and the guides to whatever a feasibility callback returns, so reporting them again would draw every guide twice and enter the id in the sticky set twice.

Definition at line 2871 of file board_constraint_adapter.cpp.

References SNAP_CANDIDATE::consumedDof, SNAP_RESULT::quantizedResiduals, and SNAP_RESULT::remainingDof.

Referenced by BOARD_CONSTRAINT_DRAG_SESSION::ResolveCandidates(), and BOARD_CONSTRAINT_MOVE_SESSION::ResolveCandidates().

◆ Build()

bool BOARD_CONSTRAINT_DRAG_SESSION::Build	(	BOARD *	aBoard,
		const CONSTRAINT_MEMBER &	aDragged )

Definition at line 3027 of file board_constraint_adapter.cpp.

References BOARD_CONSTRAINT_SESSION::buildCluster(), buildShapeConstraintMap(), collectAllConstraints(), collectConstraintCluster(), BOARD_CONSTRAINT_SESSION::m_board, m_dragged, m_draggedShape, and BOARD_CONSTRAINT_SESSION::reset().

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and BOOST_FIXTURE_TEST_CASE().

◆ buildCluster()

bool BOARD_CONSTRAINT_SESSION::buildCluster	(	BOARD *	aBoard,
		const std::unordered_set< KIID > &	aClusterShapes,
		const std::vector< PCB_CONSTRAINT * > &	aConstraints )

protectedinherited

Assemble the adapter for one cluster and record its baseline.

Sets the base-conflict flag when the cluster's relations were already unsatisfied, which every solve then refuses rather than trying to repair an edit the user did not make.

Definition at line 2832 of file board_constraint_adapter.cpp.

References m_adapter, m_baseConflict, m_baseline, m_board, reset(), resolveClusterDimensions(), and resolveClusterShapes().

Referenced by BOARD_CONSTRAINT_DRAG_SESSION::Build(), and BOARD_CONSTRAINT_MOVE_SESSION::Build().

◆ HasBaseConflict()

bool BOARD_CONSTRAINT_SESSION::HasBaseConflict ( ) const

inlineinherited

Definition at line 394 of file board_constraint_adapter.h.

References m_baseConflict.

Referenced by BOOST_FIXTURE_TEST_CASE(), and BOARD_CONSTRAINT_MOVE_SESSION::Solve().

◆ IsExactFeasible()

bool BOARD_CONSTRAINT_DRAG_SESSION::IsExactFeasible ( const VECTOR2I & aTarget )

Definition at line 3057 of file board_constraint_adapter.cpp.

References BOARD_CONSTRAINT_SESSION::m_adapter, m_dragged, BOARD_CONSTRAINT_SESSION::rewind(), and BOARD_CONSTRAINT_SESSION::usable().

Referenced by BOOST_FIXTURE_TEST_CASE(), and BOOST_FIXTURE_TEST_CASE().

◆ Matches()

bool BOARD_CONSTRAINT_DRAG_SESSION::Matches ( const CONSTRAINT_MEMBER & aDragged ) const

Definition at line 3050 of file board_constraint_adapter.cpp.

References BOARD_CONSTRAINT_SESSION::m_adapter, CONSTRAINT_MEMBER::m_anchor, m_dragged, CONSTRAINT_MEMBER::m_index, and CONSTRAINT_MEMBER::m_item.

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ reset()

void BOARD_CONSTRAINT_SESSION::reset ( )

protectedinherited

Drop the built cluster, leaving the session unusable until the next successful build.

Definition at line 2824 of file board_constraint_adapter.cpp.

References m_adapter, m_baseConflict, and m_baseline.

Referenced by BOARD_CONSTRAINT_DRAG_SESSION::Build(), BOARD_CONSTRAINT_MOVE_SESSION::Build(), and buildCluster().

◆ ResolveCandidates()

SNAP_RESULT BOARD_CONSTRAINT_DRAG_SESSION::ResolveCandidates	(	const SNAP_SOURCE_CONTEXT &	aContext,
		const std::vector< SNAP_CANDIDATE > &	aCandidates )

◆ rewind()

bool BOARD_CONSTRAINT_SESSION::rewind ( )

inlineprotectedinherited

Rewind to the state the next speculative solve starts from.

Definition at line 412 of file board_constraint_adapter.h.

References m_adapter, and m_baseline.

Referenced by BOARD_CONSTRAINT_MOVE_SESSION::feasibleAt(), BOARD_CONSTRAINT_DRAG_SESSION::IsExactFeasible(), BOARD_CONSTRAINT_DRAG_SESSION::ResolveCandidates(), BOARD_CONSTRAINT_MOVE_SESSION::ResolveCandidates(), BOARD_CONSTRAINT_DRAG_SESSION::Solve(), and BOARD_CONSTRAINT_MOVE_SESSION::Solve().

◆ Solve()

CONSTRAINT_DIAGNOSIS BOARD_CONSTRAINT_DRAG_SESSION::Solve	(	const VECTOR2I &	aCursor,
		std::vector< PCB_SHAPE * > *	aModified,
		const std::function< void(BOARD_ITEM *)> &	aBeforeModify,
		bool	aIncludeDragged,
		bool	aStabilize,
		const std::set< KIID > &	aEdited = {},
		const std::optional< std::pair< CONSTRAINT_MEMBER, VECTOR2I > > &	aCoDragged = std::nullopt )