|
KiCad PCB EDA Suite
|
One block edit session, holding several anchors and one travel offset at once. More...
#include <board_constraint_adapter.h>
Public Member Functions | |
| bool | Build (BOARD *aBoard, const std::vector< BOARD_ITEM * > &aBlockItems) |
Build one adapter over the clusters holding aBlockItems. | |
| CONSTRAINT_BLOCK_RESULT | Solve (const std::vector< std::pair< CONSTRAINT_MEMBER, VECTOR2I > > &aPinnedAnchors, const std::set< KIID > &aTranslatedShapes, const VECTOR2I &aTranslation, std::vector< PCB_SHAPE * > *aModified, const std::function< void(BOARD_ITEM *)> &aBeforeModify) |
| Solve one frame of the block edit and apply it. | |
| 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 |
One block edit session, holding several anchors and one travel offset at once.
A block drag reshapes some shapes by their picked anchors while carrying others whole, so it needs more than the drag session's single anchor and more than the move session's one rigid step. The session is built once, over every cluster the block touches, and every frame solves from the same starting geometry, so the result depends only on where the drag ends and not on the path the cursor took.
Definition at line 576 of file board_constraint_adapter.h.
|
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 3294 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().
| bool BOARD_CONSTRAINT_BLOCK_SESSION::Build | ( | BOARD * | aBoard, |
| const std::vector< BOARD_ITEM * > & | aBlockItems ) |
Build one adapter over the clusters holding aBlockItems.
False when none of them are constrained, which tells the caller to edit without the solver.
Definition at line 3450 of file board_constraint_adapter.cpp.
References BOARD_CONSTRAINT_SESSION::buildCluster(), buildShapeConstraintMap(), collectConstraintCluster(), CollectResolvedConstraints(), BOARD_CONSTRAINT_SESSION::m_adapter, BOARD_CONSTRAINT_SESSION::m_baseConflict, 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(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), 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().
|
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 3254 of file board_constraint_adapter.cpp.
References m_adapter, m_baseConflict, m_baseline, m_board, reset(), resolveClusterDimensions(), resolveClusterPads(), and resolveClusterShapes().
Referenced by BOARD_CONSTRAINT_BLOCK_SESSION::Build(), BOARD_CONSTRAINT_DRAG_SESSION::Build(), and BOARD_CONSTRAINT_MOVE_SESSION::Build().
|
inlineinherited |
Definition at line 489 of file board_constraint_adapter.h.
References m_baseConflict.
Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and BOARD_CONSTRAINT_MOVE_SESSION::Solve().
|
protectedinherited |
Drop the built cluster, leaving the session unusable until the next successful build.
Definition at line 3246 of file board_constraint_adapter.cpp.
References m_adapter, m_baseConflict, and m_baseline.
Referenced by BOARD_CONSTRAINT_BLOCK_SESSION::Build(), BOARD_CONSTRAINT_DRAG_SESSION::Build(), BOARD_CONSTRAINT_MOVE_SESSION::Build(), and buildCluster().
|
inlineprotectedinherited |
Rewind to the state the next speculative solve starts from.
Definition at line 507 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_BLOCK_SESSION::Solve(), BOARD_CONSTRAINT_DRAG_SESSION::Solve(), and BOARD_CONSTRAINT_MOVE_SESSION::Solve().
| CONSTRAINT_BLOCK_RESULT BOARD_CONSTRAINT_BLOCK_SESSION::Solve | ( | const std::vector< std::pair< CONSTRAINT_MEMBER, VECTOR2I > > & | aPinnedAnchors, |
| const std::set< KIID > & | aTranslatedShapes, | ||
| const VECTOR2I & | aTranslation, | ||
| std::vector< PCB_SHAPE * > * | aModified, | ||
| const std::function< void(BOARD_ITEM *)> & | aBeforeModify ) |
Solve one frame of the block edit and apply it.
| aPinnedAnchors | the frame's anchors with their targets in IU. | |
| aTranslatedShapes | shapes the frame carried whole. | |
| aTranslation | how far they travelled from the starting geometry. | |
| [out] | aModified | the shapes the solve moved, for the caller to stage and redraw. |
| aBeforeModify | called with each item just before it is written, for the undo commit. |
Definition at line 3494 of file board_constraint_adapter.cpp.
References BOARD_CONSTRAINT_SESSION::m_adapter, NOT_MODELED, result, BOARD_CONSTRAINT_SESSION::rewind(), SOLVED, and BOARD_CONSTRAINT_SESSION::usable().
Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), 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().
|
protectedinherited |
Seed a snap result at the cursor, rejecting a cluster that was already broken.
Definition at line 3280 of file board_constraint_adapter.cpp.
References BASE_CONFLICT, INCOMPATIBLE, m_adapter, m_baseConflict, result, and SNAP_SOURCE_CONTEXT::sourcePoint.
Referenced by BOARD_CONSTRAINT_DRAG_SESSION::ResolveCandidates(), and BOARD_CONSTRAINT_MOVE_SESSION::ResolveCandidates().
|
inlineprotectedinherited |
Definition at line 504 of file board_constraint_adapter.h.
References m_adapter, and m_baseConflict.
Referenced by BOARD_CONSTRAINT_MOVE_SESSION::feasibleAt(), BOARD_CONSTRAINT_DRAG_SESSION::IsExactFeasible(), and BOARD_CONSTRAINT_BLOCK_SESSION::Solve().
|
protectedinherited |
Definition at line 522 of file board_constraint_adapter.h.
Referenced by BOARD_CONSTRAINT_BLOCK_SESSION::Build(), buildCluster(), BOARD_CONSTRAINT_MOVE_SESSION::feasibleAt(), BOARD_CONSTRAINT_DRAG_SESSION::IsExactFeasible(), BOARD_CONSTRAINT_DRAG_SESSION::Matches(), reset(), BOARD_CONSTRAINT_DRAG_SESSION::ResolveCandidates(), BOARD_CONSTRAINT_MOVE_SESSION::ResolveCandidates(), rewind(), BOARD_CONSTRAINT_BLOCK_SESSION::Solve(), BOARD_CONSTRAINT_DRAG_SESSION::Solve(), BOARD_CONSTRAINT_MOVE_SESSION::Solve(), startResult(), and usable().
|
protectedinherited |
Definition at line 524 of file board_constraint_adapter.h.
Referenced by BOARD_CONSTRAINT_BLOCK_SESSION::Build(), buildCluster(), HasBaseConflict(), reset(), BOARD_CONSTRAINT_DRAG_SESSION::Solve(), startResult(), and usable().
|
protectedinherited |
Definition at line 523 of file board_constraint_adapter.h.
Referenced by buildCluster(), reset(), rewind(), and BOARD_CONSTRAINT_DRAG_SESSION::Solve().
|
protectedinherited |
Definition at line 521 of file board_constraint_adapter.h.
Referenced by BOARD_CONSTRAINT_DRAG_SESSION::Build(), and buildCluster().