KiCad PCB EDA Suite
pns_shove.h
Go to the documentation of this file.
1/*
2 * KiRouter - a push-and-(sometimes-)shove PCB router
3 *
4 * Copyright (C) 2013-2014 CERN
5 * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
6 * Author: Tomasz Wlostowski <[email protected]>
7 *
8 * This program is free software: you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation, either version 3 of the License, or (at your
11 * option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#ifndef __PNS_SHOVE_H
23#define __PNS_SHOVE_H
24
25#include <vector>
26#include <stack>
27
28#include <math/box2.h>
29
30#include "pns_optimizer.h"
32#include "pns_algo_base.h"
33#include "pns_logger.h"
34#include "range.h"
35
36namespace PNS {
37
38class LINE;
39class NODE;
40class ROUTER;
41
45class SHOVE : public ALGO_BASE
46{
47public:
48
50 {
51 SH_OK = 0,
56 };
57
58 SHOVE( NODE* aWorld, ROUTER* aRouter );
59 ~SHOVE();
60
61 virtual LOGGER* Logger() override
62 {
63 return &m_logger;
64 }
65
66 SHOVE_STATUS ShoveLines( const LINE& aCurrentHead );
67 SHOVE_STATUS ShoveMultiLines( const ITEM_SET& aHeadSet );
68
69 SHOVE_STATUS ShoveDraggingVia( const VIA_HANDLE aOldVia, const VECTOR2I& aWhere,
70 VIA_HANDLE& aNewVia );
71 SHOVE_STATUS ShoveObstacleLine( const LINE& aCurLine, const LINE& aObstacleLine,
72 LINE& aResultLine );
73
74 void ForceClearance ( bool aEnabled, int aClearance )
75 {
76 if( aEnabled )
77 m_forceClearance = aClearance;
78 else
80 }
81
83
84 const LINE NewHead() const;
85
86 void SetInitialLine( LINE& aInitial );
87
88 bool AddLockedSpringbackNode( NODE* aNode );
89 void UnlockSpringbackNode( NODE* aNode );
90 bool RewindSpringbackTo( NODE* aNode );
92 void DisablePostShoveOptimizations( int aMask );
93 void SetSpringbackDoNotTouchNode( NODE *aNode );
94
95private:
96 typedef std::vector<SHAPE_LINE_CHAIN> HULL_SET;
98 typedef std::pair<LINE, LINE> LINE_PAIR;
99 typedef std::vector<LINE_PAIR> LINE_PAIR_VEC;
100
102 {
104 m_length( 0 ),
105 m_draggedVia(),
106 m_node( nullptr ),
107 m_seq( 0 ),
108 m_locked( false )
109 {}
110
111 int64_t m_length;
116 int m_seq;
118 };
119
120 SHOVE_STATUS shoveLineToHullSet( const LINE& aCurLine, const LINE& aObstacleLine,
121 LINE& aResultLine, const HULL_SET& aHulls );
122
123 NODE* reduceSpringback( const ITEM_SET& aHeadSet, VIA_HANDLE& aDraggedVia );
124
125 bool pushSpringback( NODE* aNode, const OPT_BOX2I& aAffectedArea, VIA* aDraggedVia );
126
127 SHOVE_STATUS shoveLineFromLoneVia( const LINE& aCurLine, const LINE& aObstacleLine,
128 LINE& aResultLine );
129 bool checkShoveDirection( const LINE& aCurLine, const LINE& aObstacleLine,
130 const LINE& aShovedLine ) const;
131
132 SHOVE_STATUS onCollidingArc( LINE& aCurrent, ARC* aObstacleArc );
133 SHOVE_STATUS onCollidingLine( LINE& aCurrent, LINE& aObstacle );
134 SHOVE_STATUS onCollidingSegment( LINE& aCurrent, SEGMENT* aObstacleSeg );
135 SHOVE_STATUS onCollidingSolid( LINE& aCurrent, ITEM* aObstacle, OBSTACLE& aObstacleInfo );
136 SHOVE_STATUS onCollidingVia( ITEM* aCurrent, VIA* aObstacleVia, OBSTACLE& aObstacleInfo );
137 SHOVE_STATUS onReverseCollidingVia( LINE& aCurrent, VIA* aObstacleVia );
138 SHOVE_STATUS pushOrShoveVia( VIA* aVia, const VECTOR2I& aForce, int aCurrentRank );
139
141
142 void unwindLineStack( LINKED_ITEM* aSeg );
143 void unwindLineStack( ITEM* aItem );
144
145 void runOptimizer( NODE* aNode );
146
147 bool pushLineStack( const LINE& aL, bool aKeepCurrentOnTop = false );
148 void popLineStack();
149
150 LINE assembleLine( const LINKED_ITEM* aSeg, int* aIndex = nullptr );
151
152 void replaceItems( ITEM* aOld, std::unique_ptr< ITEM > aNew );
153 void replaceLine( LINE& aOld, LINE& aNew, bool aIncludeInChangedArea = true,
154 NODE *aNode = nullptr );
155
156 LINE* findRootLine( LINE *aLine );
157
159
160 SHOVE_STATUS shoveIteration( int aIter );
162
163 int getClearance( const ITEM* aA, const ITEM* aB ) const;
164 int getHoleClearance( const ITEM* aA, const ITEM* aB ) const;
165 bool fixupViaCollisions( const LINE* aCurrent, OBSTACLE& obs );
166 void sanityCheck( LINE* aOld, LINE* aNew );
167
168 std::vector<SPRINGBACK_TAG> m_nodeStack;
169 std::vector<LINE> m_lineStack;
170 std::vector<LINE> m_optimizerQueue;
171 std::unordered_map<const LINKED_ITEM*, LINE*> m_rootLineHistory;
172
177
179
182
186
188};
189
190}
191
192#endif // __PNS_SHOVE_H
OPT< BOX2I > OPT_BOX2I
Definition: box2.h:509
Base class for all P&S algorithms (shoving, walkaround, line placement, dragging, etc....
Definition: pns_algo_base.h:43
Base class for PNS router board items.
Definition: pns_item.h:56
Represents a track on a PCB, connecting two non-trivial joints (that is, vias, pads,...
Definition: pns_line.h:61
Keep the router "world" - i.e.
Definition: pns_node.h:150
The actual Push and Shove algorithm.
Definition: pns_shove.h:46
SHOVE_STATUS shoveIteration(int aIter)
Definition: pns_shove.cpp:1322
SHOVE_STATUS shoveMainLoop()
Definition: pns_shove.cpp:1499
std::vector< SHAPE_LINE_CHAIN > HULL_SET
Definition: pns_shove.h:96
int m_iter
Definition: pns_shove.h:183
std::pair< LINE, LINE > LINE_PAIR
Definition: pns_shove.h:98
int getHoleClearance(const ITEM *aA, const ITEM *aB) const
Definition: pns_shove.cpp:141
OPT_BOX2I m_affectedArea
Definition: pns_shove.h:158
std::vector< LINE > m_lineStack
Definition: pns_shove.h:169
void popLineStack()
Definition: pns_shove.cpp:1216
LINE * findRootLine(LINE *aLine)
Definition: pns_shove.cpp:1838
std::vector< SPRINGBACK_TAG > m_nodeStack
Definition: pns_shove.h:168
SHOVE_STATUS onCollidingArc(LINE &aCurrent, ARC *aObstacleArc)
Definition: pns_shove.cpp:556
SHOVE_STATUS ShoveObstacleLine(const LINE &aCurLine, const LINE &aObstacleLine, LINE &aResultLine)
Definition: pns_shove.cpp:405
LINE assembleLine(const LINKED_ITEM *aSeg, int *aIndex=nullptr)
Definition: pns_shove.cpp:192
NODE * m_currentNode
Definition: pns_shove.h:174
void ForceClearance(bool aEnabled, int aClearance)
Definition: pns_shove.h:74
void SetInitialLine(LINE &aInitial)
Definition: pns_shove.cpp:1953
bool checkShoveDirection(const LINE &aCurLine, const LINE &aObstacleLine, const LINE &aShovedLine) const
Definition: pns_shove.cpp:206
int m_forceClearance
Definition: pns_shove.h:184
SHOVE_STATUS pushOrShoveVia(VIA *aVia, const VECTOR2I &aForce, int aCurrentRank)
Definition: pns_shove.cpp:863
SHOVE_STATUS onCollidingSegment(LINE &aCurrent, SEGMENT *aObstacleSeg)
Definition: pns_shove.cpp:492
SHOVE(NODE *aWorld, ROUTER *aRouter)
Definition: pns_shove.cpp:157
void DisablePostShoveOptimizations(int aMask)
Definition: pns_shove.cpp:2029
SHOVE_STATUS ShoveLines(const LINE &aCurrentHead)
Definition: pns_shove.cpp:1561
bool RewindSpringbackTo(NODE *aNode)
Definition: pns_shove.cpp:1971
bool pushLineStack(const LINE &aL, bool aKeepCurrentOnTop=false)
Definition: pns_shove.cpp:1192
@ SH_INCOMPLETE
Definition: pns_shove.h:53
@ SH_HEAD_MODIFIED
Definition: pns_shove.h:54
@ SH_TRY_WALK
Definition: pns_shove.h:55
OPT_BOX2I totalAffectedArea() const
Definition: pns_shove.cpp:1545
bool RewindToLastLockedNode()
Definition: pns_shove.cpp:2000
void replaceLine(LINE &aOld, LINE &aNew, bool aIncludeInChangedArea=true, NODE *aNode=nullptr)
Definition: pns_shove.cpp:62
SHOVE_STATUS ShoveDraggingVia(const VIA_HANDLE aOldVia, const VECTOR2I &aWhere, VIA_HANDLE &aNewVia)
Definition: pns_shove.cpp:1770
void sanityCheck(LINE *aOld, LINE *aNew)
Definition: pns_shove.cpp:150
int m_restrictSpringbackTagId
Definition: pns_shove.h:176
NODE * reduceSpringback(const ITEM_SET &aHeadSet, VIA_HANDLE &aDraggedVia)
Definition: pns_shove.cpp:788
void runOptimizer(NODE *aNode)
Definition: pns_shove.cpp:1855
virtual LOGGER * Logger() override
Definition: pns_shove.h:61
SHOVE_STATUS shoveLineToHullSet(const LINE &aCurLine, const LINE &aObstacleLine, LINE &aResultLine, const HULL_SET &aHulls)
Definition: pns_shove.cpp:273
bool pushSpringback(NODE *aNode, const OPT_BOX2I &aAffectedArea, VIA *aDraggedVia)
Definition: pns_shove.cpp:823
SHOVE_STATUS onCollidingLine(LINE &aCurrent, LINE &aObstacle)
Definition: pns_shove.cpp:614
void UnlockSpringbackNode(NODE *aNode)
Definition: pns_shove.cpp:2012
NODE * m_root
Definition: pns_shove.h:173
bool AddLockedSpringbackNode(NODE *aNode)
Definition: pns_shove.cpp:1960
OPT< LINE > OPT_LINE
Definition: pns_shove.h:97
OPT_LINE m_newHead
Definition: pns_shove.h:178
NODE * m_springbackDoNotTouchNode
Definition: pns_shove.h:175
NODE * CurrentNode()
Definition: pns_shove.cpp:1939
SHOVE_STATUS shoveLineFromLoneVia(const LINE &aCurLine, const LINE &aObstacleLine, LINE &aResultLine)
Definition: pns_shove.cpp:226
int getClearance(const ITEM *aA, const ITEM *aB) const
Definition: pns_shove.cpp:132
bool m_multiLineMode
Definition: pns_shove.h:185
SHOVE_STATUS onReverseCollidingVia(LINE &aCurrent, VIA *aObstacleVia)
Definition: pns_shove.cpp:1063
std::vector< LINE > m_optimizerQueue
Definition: pns_shove.h:170
SHOVE_STATUS onCollidingSolid(LINE &aCurrent, ITEM *aObstacle, OBSTACLE &aObstacleInfo)
Definition: pns_shove.cpp:654
void unwindLineStack(LINKED_ITEM *aSeg)
Definition: pns_shove.cpp:1151
int m_optFlagDisableMask
Definition: pns_shove.h:187
bool fixupViaCollisions(const LINE *aCurrent, OBSTACLE &obs)
Definition: pns_shove.cpp:1242
void replaceItems(ITEM *aOld, std::unique_ptr< ITEM > aNew)
Definition: pns_shove.cpp:51
VIA * m_draggedVia
Definition: pns_shove.h:181
SHOVE_STATUS ShoveMultiLines(const ITEM_SET &aHeadSet)
Definition: pns_shove.cpp:1668
std::unordered_map< const LINKED_ITEM *, LINE * > m_rootLineHistory
Definition: pns_shove.h:171
const LINE NewHead() const
Definition: pns_shove.cpp:1945
LOGGER m_logger
Definition: pns_shove.h:180
std::vector< LINE_PAIR > LINE_PAIR_VEC
Definition: pns_shove.h:99
void SetSpringbackDoNotTouchNode(NODE *aNode)
Definition: pns_shove.cpp:2035
SHOVE_STATUS onCollidingVia(ITEM *aCurrent, VIA *aObstacleVia, OBSTACLE &aObstacleInfo)
Definition: pns_shove.cpp:990
Push and Shove diff pair dimensions (gap) settings dialog.
boost::optional< T > OPT
Definition: optional.h:7
Hold an object colliding with another object, along with some useful data about the collision.
Definition: pns_node.h:107