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 KiCad Developers, see AUTHORS.txt for contributors.
6  * Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
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"
31 #include "pns_routing_settings.h"
32 #include "pns_algo_base.h"
33 #include "pns_logger.h"
34 #include "range.h"
35 
36 namespace PNS {
37 
38 class LINE;
39 class NODE;
40 class ROUTER;
41 
48 class SHOVE : public ALGO_BASE
49 {
50 public:
51 
53  {
54  SH_OK = 0,
59  };
60 
61  SHOVE( NODE* aWorld, ROUTER* aRouter );
62  ~SHOVE();
63 
64  virtual LOGGER* Logger() override
65  {
66  return &m_logger;
67  }
68 
69  SHOVE_STATUS ShoveLines( const LINE& aCurrentHead );
70  SHOVE_STATUS ShoveMultiLines( const ITEM_SET& aHeadSet );
71 
72  SHOVE_STATUS ShoveDraggingVia( const VIA_HANDLE aOldVia, const VECTOR2I& aWhere, VIA_HANDLE& aNewVia );
73  SHOVE_STATUS ShoveObstacleLine( const LINE& aCurLine, const LINE& aObstacleLine, LINE& aResultLine );
74 
75  void ForceClearance ( bool aEnabled, int aClearance )
76  {
77  if( aEnabled )
78  m_forceClearance = aClearance;
79  else
80  m_forceClearance = -1;
81  }
82 
83  NODE* CurrentNode();
84 
85  const LINE NewHead() const;
86 
87  void SetInitialLine( LINE& aInitial );
88 
89  bool AddLockedSpringbackNode( NODE* aNode );
90  void UnlockSpringbackNode( NODE* aNode );
91  bool RewindSpringbackTo( NODE* aNode );
92 
93 private:
94  typedef std::vector<SHAPE_LINE_CHAIN> HULL_SET;
96  typedef std::pair<LINE, LINE> LINE_PAIR;
97  typedef std::vector<LINE_PAIR> LINE_PAIR_VEC;
98 
100  {
102  m_length( 0 ),
103  m_draggedVia(),
104  m_node( nullptr ),
105  m_seq( 0 ),
106  m_locked( false )
107  {}
108 
109  int64_t m_length;
114  int m_seq;
115  bool m_locked;
116  };
117 
118  SHOVE_STATUS shoveLineToHullSet( const LINE& aCurLine, const LINE& aObstacleLine,
119  LINE& aResultLine, const HULL_SET& aHulls );
120 
121  NODE* reduceSpringback( const ITEM_SET& aHeadSet, VIA_HANDLE& aDraggedVia );
122 
123  bool pushSpringback( NODE* aNode, const OPT_BOX2I& aAffectedArea, VIA* aDraggedVia );
124 
125  SHOVE_STATUS shoveLineFromLoneVia( const LINE& aCurLine, const LINE& aObstacleLine,
126  LINE& aResultLine );
127  bool checkShoveDirection( const LINE& aCurLine, const LINE& aObstacleLine,
128  const LINE& aShovedLine ) const;
129 
130  SHOVE_STATUS onCollidingArc( LINE& aCurrent, ARC* aObstacleArc );
131  SHOVE_STATUS onCollidingLine( LINE& aCurrent, LINE& aObstacle );
132  SHOVE_STATUS onCollidingSegment( LINE& aCurrent, SEGMENT* aObstacleSeg );
133  SHOVE_STATUS onCollidingSolid( LINE& aCurrent, ITEM* aObstacle );
134  SHOVE_STATUS onCollidingVia( ITEM* aCurrent, VIA* aObstacleVia );
135  SHOVE_STATUS onReverseCollidingVia( LINE& aCurrent, VIA* aObstacleVia );
136  SHOVE_STATUS pushOrShoveVia( VIA* aVia, const VECTOR2I& aForce, int aCurrentRank );
137 
139 
140  void unwindLineStack( LINKED_ITEM* aSeg );
141  void unwindLineStack( ITEM* aItem );
142 
143  void runOptimizer( NODE* aNode );
144 
145  bool pushLineStack( const LINE& aL, bool aKeepCurrentOnTop = false );
146  void popLineStack();
147 
148  LINE assembleLine( const LINKED_ITEM* aSeg, int* aIndex = NULL );
149 
150  void replaceItems( ITEM* aOld, std::unique_ptr< ITEM > aNew );
151  void replaceLine( LINE& aOld, LINE& aNew, bool aIncludeInChangedArea = true, NODE *aNode = nullptr );
152 
153  LINE* findRootLine( LINE *aLine );
154 
156 
157  SHOVE_STATUS shoveIteration( int aIter );
159 
160  int getClearance( const ITEM* aA, const ITEM* aB ) const;
161  int getHoleClearance( const ITEM* aA, const ITEM* aB ) const;
162 
163  std::vector<SPRINGBACK_TAG> m_nodeStack;
164  std::vector<LINE> m_lineStack;
165  std::vector<LINE> m_optimizerQueue;
166  std::unordered_map<const LINKED_ITEM*, LINE*> m_rootLineHistory;
167 
171 
173 
176 
177  int m_iter;
180  void sanityCheck( LINE* aOld, LINE* aNew );
181 };
182 
183 }
184 
185 #endif // __PNS_SHOVE_H
LINE * findRootLine(LINE *aLine)
Definition: pns_shove.cpp:1652
bool pushLineStack(const LINE &aL, bool aKeepCurrentOnTop=false)
Definition: pns_shove.cpp:1121
Base class for PNS router board items.
Definition: pns_item.h:55
LINE assembleLine(const LINKED_ITEM *aSeg, int *aIndex=NULL)
Definition: pns_shove.cpp:182
void popLineStack()
Definition: pns_shove.cpp:1140
int m_restrictSpringbackTagId
Definition: pns_shove.h:170
Keep the router "world" - i.e.
Definition: pns_node.h:144
SHOVE_STATUS onCollidingSolid(LINE &aCurrent, ITEM *aObstacle)
Definition: pns_shove.cpp:631
void unwindLineStack(LINKED_ITEM *aSeg)
Definition: pns_shove.cpp:1087
OPT< LINE > OPT_LINE
Definition: pns_shove.h:95
SHOVE.
Definition: pns_shove.h:48
const LINE NewHead() const
Definition: pns_shove.cpp:1759
SHOVE_STATUS shoveLineToHullSet(const LINE &aCurLine, const LINE &aObstacleLine, LINE &aResultLine, const HULL_SET &aHulls)
Definition: pns_shove.cpp:260
SHOVE_STATUS onCollidingArc(LINE &aCurrent, ARC *aObstacleArc)
Definition: pns_shove.cpp:527
Base class for all P&S algorithms (shoving, walkaround, line placement, dragging, etc....
Definition: pns_algo_base.h:42
std::vector< LINE > m_optimizerQueue
Definition: pns_shove.h:165
bool RewindSpringbackTo(NODE *aNode)
Definition: pns_shove.cpp:1785
NODE * m_root
Definition: pns_shove.h:168
std::pair< LINE, LINE > LINE_PAIR
Definition: pns_shove.h:96
Represents a track on a PCB, connecting two non-trivial joints (that is, vias, pads,...
Definition: pns_line.h:60
SHOVE_STATUS ShoveObstacleLine(const LINE &aCurLine, const LINE &aObstacleLine, LINE &aResultLine)
Definition: pns_shove.cpp:376
SHOVE_STATUS pushOrShoveVia(VIA *aVia, const VECTOR2I &aForce, int aCurrentRank)
Definition: pns_shove.cpp:822
std::vector< LINE_PAIR > LINE_PAIR_VEC
Definition: pns_shove.h:97
SHOVE_STATUS onCollidingLine(LINE &aCurrent, LINE &aObstacle)
Definition: pns_shove.cpp:590
SHOVE_STATUS onReverseCollidingVia(LINE &aCurrent, VIA *aObstacleVia)
Definition: pns_shove.cpp:1004
std::vector< SHAPE_LINE_CHAIN > HULL_SET
Definition: pns_shove.h:94
OPT_BOX2I totalAffectedArea() const
Definition: pns_shove.cpp:1351
NODE * reduceSpringback(const ITEM_SET &aHeadSet, VIA_HANDLE &aDraggedVia)
Definition: pns_shove.cpp:757
SHOVE_STATUS ShoveLines(const LINE &aCurrentHead)
Definition: pns_shove.cpp:1367
bool AddLockedSpringbackNode(NODE *aNode)
Definition: pns_shove.cpp:1774
#define NULL
SHOVE_STATUS onCollidingVia(ITEM *aCurrent, VIA *aObstacleVia)
Definition: pns_shove.cpp:947
void runOptimizer(NODE *aNode)
Definition: pns_shove.cpp:1669
void sanityCheck(LINE *aOld, LINE *aNew)
Definition: pns_shove.cpp:144
SHOVE_STATUS shoveIteration(int aIter)
Definition: pns_shove.cpp:1169
SHOVE(NODE *aWorld, ROUTER *aRouter)
Definition: pns_shove.cpp:151
std::unordered_map< const LINKED_ITEM *, LINE * > m_rootLineHistory
Definition: pns_shove.h:166
bool pushSpringback(NODE *aNode, const OPT_BOX2I &aAffectedArea, VIA *aDraggedVia)
Definition: pns_shove.cpp:785
SHOVE_STATUS onCollidingSegment(LINE &aCurrent, SEGMENT *aObstacleSeg)
Definition: pns_shove.cpp:460
void UnlockSpringbackNode(NODE *aNode)
Definition: pns_shove.cpp:1813
void replaceLine(LINE &aOld, LINE &aNew, bool aIncludeInChangedArea=true, NODE *aNode=nullptr)
Definition: pns_shove.cpp:61
SHOVE_STATUS ShoveDraggingVia(const VIA_HANDLE aOldVia, const VECTOR2I &aWhere, VIA_HANDLE &aNewVia)
Definition: pns_shove.cpp:1582
std::vector< SPRINGBACK_TAG > m_nodeStack
Definition: pns_shove.h:163
VIA * m_draggedVia
Definition: pns_shove.h:175
OPT_BOX2I m_affectedArea
Definition: pns_shove.h:155
void ForceClearance(bool aEnabled, int aClearance)
Definition: pns_shove.h:75
virtual LOGGER * Logger() override
Definition: pns_shove.h:64
bool checkShoveDirection(const LINE &aCurLine, const LINE &aObstacleLine, const LINE &aShovedLine) const
Definition: pns_shove.cpp:195
SHOVE_STATUS shoveMainLoop()
Definition: pns_shove.cpp:1309
OPT< BOX2I > OPT_BOX2I
Definition: box2.h:515
void SetInitialLine(LINE &aInitial)
Definition: pns_shove.cpp:1767
boost::optional< T > OPT
Definition: optional.h:7
int getClearance(const ITEM *aA, const ITEM *aB) const
Definition: pns_shove.cpp:127
int getHoleClearance(const ITEM *aA, const ITEM *aB) const
Definition: pns_shove.cpp:135
void replaceItems(ITEM *aOld, std::unique_ptr< ITEM > aNew)
Definition: pns_shove.cpp:51
bool m_multiLineMode
Definition: pns_shove.h:179
OPT_LINE m_newHead
Definition: pns_shove.h:172
std::vector< LINE > m_lineStack
Definition: pns_shove.h:164
SHOVE_STATUS ShoveMultiLines(const ITEM_SET &aHeadSet)
Definition: pns_shove.cpp:1483
NODE * m_currentNode
Definition: pns_shove.h:169
Push and Shove diff pair dimensions (gap) settings dialog.
LOGGER m_logger
Definition: pns_shove.h:174
int m_iter
Definition: pns_shove.h:177
SHOVE_STATUS shoveLineFromLoneVia(const LINE &aCurLine, const LINE &aObstacleLine, LINE &aResultLine)
Definition: pns_shove.cpp:215
NODE * CurrentNode()
Definition: pns_shove.cpp:1753
int m_forceClearance
Definition: pns_shove.h:178