KiCad PCB EDA Suite
pns_tool_base.cpp
Go to the documentation of this file.
1 /*
2  * KiRouter - a push-and-(sometimes-)shove PCB router
3  *
4  * Copyright (C) 2013 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 #include <wx/numdlg.h>
23 
24 #include <functional>
25 using namespace std::placeholders;
26 
27 #include "class_draw_panel_gal.h"
28 #include "class_board.h"
29 
30 #include <pcb_edit_frame.h>
31 #include <id.h>
32 #include <macros.h>
33 #include <pcbnew_id.h>
34 #include <view/view_controls.h>
35 #include <pcb_painter.h>
40 #include <base_units.h>
41 #include <bitmaps.h>
42 #include <hotkeys.h>
43 
44 #include <tool/context_menu.h>
45 #include <tools/pcb_actions.h>
46 #include <tools/grid_helper.h>
47 
48 #include "pns_kicad_iface.h"
49 #include "pns_tool_base.h"
50 #include "pns_segment.h"
51 #include "pns_solid.h"
52 #include "pns_via.h"
53 #include "pns_router.h"
54 #include "pns_meander_placer.h" // fixme: move settings to separate header
55 #include "pns_tune_status_popup.h"
56 #include "pns_topology.h"
57 
58 #include <view/view.h>
59 
60 using namespace KIGFX;
61 
62 namespace PNS {
63 
64 
65 TOOL_BASE::TOOL_BASE( const std::string& aToolName ) :
66  PCB_TOOL( aToolName )
67 {
68  m_gridHelper = nullptr;
69  m_iface = nullptr;
70  m_router = nullptr;
71 
72  m_startItem = nullptr;
73  m_startLayer = 0;
74  m_startHighlight = false;
75 
76  m_endItem = nullptr;
77  m_gridHelper = nullptr;
78 }
79 
80 
82 {
83  delete m_gridHelper;
84  delete m_iface;
85  delete m_router;
86 }
87 
88 
89 
91 {
92  delete m_gridHelper;
93  delete m_iface;
94  delete m_router;
95 
97  m_iface->SetBoard( board() );
98  m_iface->SetView( getView() );
99  m_iface->SetHostTool( this );
100  m_iface->SetDisplayOptions( (PCB_DISPLAY_OPTIONS*) frame()->GetDisplayOptions() );
101 
102  m_router = new ROUTER;
104  m_router->ClearWorld();
105  m_router->SyncWorld();
108 
109  m_gridHelper = new GRID_HELPER( frame() );
110 }
111 
112 
113 ITEM* TOOL_BASE::pickSingleItem( const VECTOR2I& aWhere, int aNet, int aLayer, bool aIgnorePads )
114 {
115  int tl = getView()->GetTopLayer();
116 
117  if( aLayer > 0 )
118  tl = aLayer;
119 
120  static const int candidateCount = 5;
121  ITEM* prioritized[candidateCount];
122  int dist[candidateCount];
123 
124  for( int i = 0; i < candidateCount; i++ )
125  {
126  prioritized[i] = 0;
128  }
129 
130  ITEM_SET candidates = m_router->QueryHoverItems( aWhere );
131 
132  for( ITEM* item : candidates.Items() )
133  {
134  if( !item->IsRoutable() )
135  continue;
136 
137  if( !IsCopperLayer( item->Layers().Start() ) )
138  continue;
139 
140  // fixme: this causes flicker with live loop removal...
141  //if( item->Parent() && !item->Parent()->ViewIsVisible() )
142  // continue;
143 
144  if( aNet <= 0 || item->Net() == aNet )
145  {
146  if( item->OfKind( ITEM::VIA_T | ITEM::SOLID_T ) )
147  {
148  if( item->OfKind( ITEM::SOLID_T ) && aIgnorePads )
149  continue;
150 
151  int itemDist = ( item->Shape()->Centre() - aWhere ).SquaredEuclideanNorm();
152 
153  if( !prioritized[2] || itemDist < dist[2] )
154  {
155  prioritized[2] = item;
156  dist[2] = itemDist;
157  }
158  if( item->Layers().Overlaps( tl ) && itemDist < dist[0] )
159  {
160  prioritized[0] = item;
161  dist[0] = itemDist;
162  }
163  }
164  else
165  {
166  if( !prioritized[3] )
167  prioritized[3] = item;
168  if( item->Layers().Overlaps( tl ) )
169  prioritized[1] = item;
170  }
171  }
172  // Allow unconnected items as last resort in RM_MarkObstacles mode
173  else if ( item->Net() == 0 && m_router->Settings().Mode() == RM_MarkObstacles )
174  {
175  if( item->OfKind( ITEM::SOLID_T ) && aIgnorePads )
176  continue;
177 
178  if( item->Layers().Overlaps( tl ) )
179  prioritized[4] = item;
180  }
181  }
182 
183  ITEM* rv = NULL;
184 
185  for( int i = 0; i < candidateCount; i++ )
186  {
187  ITEM* item = prioritized[i];
188 
190  if( item && !item->Layers().Overlaps( tl ) )
191  item = NULL;
192 
193  if( item && ( aLayer < 0 || item->Layers().Overlaps( aLayer ) ) )
194  {
195  rv = item;
196  break;
197  }
198  }
199 
200  if( rv )
201  {
202  wxLogTrace( "PNS", "%s, layer : %d, tl: %d", rv->KindStr().c_str(), rv->Layers().Start(), tl );
203  }
204 
205  return rv;
206 }
207 
208 
209 void TOOL_BASE::highlightNet( bool aEnabled, int aNetcode )
210 {
212 
213  if( aNetcode >= 0 && aEnabled )
214  {
215  // If the user has previously set the current net to be highlighted,
216  // we assume they want to keep it highlighted after routing
217  m_startHighlight = ( rs->IsHighlightEnabled() && rs->GetHighlightNetCode() == aNetcode );
218 
219  rs->SetHighlight( true, aNetcode );
220  }
221  else
222  {
223  if( !m_startHighlight )
224  rs->SetHighlight( false );
225 
226  m_startHighlight = false;
227  }
228 
230 }
231 
233 {
234  bool doSnap = false;
235 
236  // Sync PNS engine settings with the general PCB editor options. I know the code below is awful, but...
237  auto& pnss = m_router->Settings();
238  const auto& gens = frame()->Settings();
239 
240  pnss.SetSnapToTracks( false );
241  pnss.SetSnapToPads( false );
242 
243  if( gens.m_magneticPads == CAPTURE_CURSOR_IN_TRACK_TOOL || gens.m_magneticPads == CAPTURE_ALWAYS )
244  pnss.SetSnapToPads( true );
245 
246  if( gens.m_magneticTracks == CAPTURE_CURSOR_IN_TRACK_TOOL || gens.m_magneticTracks == CAPTURE_ALWAYS )
247  pnss.SetSnapToTracks( true );
248 
249  if( aItem )
250  {
251  if( ( aItem->OfKind( ITEM::VIA_T ) || aItem->OfKind( ITEM::SEGMENT_T ) ) && pnss.GetSnapToTracks() )
252  doSnap = true;
253  else if( aItem->OfKind( ITEM::SOLID_T ) && pnss.GetSnapToPads() )
254  doSnap = true;
255  }
256 
257  return doSnap;
258 }
259 
260 void TOOL_BASE::updateStartItem( const TOOL_EVENT& aEvent, bool aIgnorePads )
261 {
262  int tl = getView()->GetTopLayer();
264  VECTOR2I p;
265 
266  controls()->ForceCursorPosition( false );
267 
268  bool snapEnabled = true;
269 
270  if( aEvent.IsMotion() || aEvent.IsClick() )
271  {
272  snapEnabled = !aEvent.Modifier( MD_SHIFT );
273  p = aEvent.Position();
274  }
275  else
276  {
277  p = cp;
278  }
279 
280  m_startItem = pickSingleItem( p, -1, -1, aIgnorePads );
281 
282  if( !snapEnabled && m_startItem && !m_startItem->Layers().Overlaps( tl ) )
283  m_startItem = nullptr;
284 
285  m_startSnapPoint = snapToItem( snapEnabled, m_startItem, p );
286 
287  if( checkSnap ( m_startItem ))
288  {
290  }
291 }
292 
293 
295 {
296  controls()->ForceCursorPosition( false );
297 
298  VECTOR2I mousePos = controls()->GetMousePosition();
299  VECTOR2I cursorPos = controls()->GetCursorPosition();
300 
301  int layer;
302  bool snapEnabled = !aEvent.Modifier( MD_SHIFT );
303 
304  if( m_router->Settings().Mode() != RM_MarkObstacles &&
305  ( m_router->GetCurrentNets().empty() || m_router->GetCurrentNets().front() < 0 ) )
306  {
307  m_endSnapPoint = snapToItem( snapEnabled, nullptr, mousePos );
309  m_endItem = nullptr;
310 
311  return;
312  }
313 
314  if( m_router->IsPlacingVia() )
315  layer = -1;
316  else
317  layer = m_router->GetCurrentLayer();
318 
319  ITEM* endItem = nullptr;
320 
321  std::vector<int> nets = m_router->GetCurrentNets();
322 
323  for( int net : nets )
324  {
325  endItem = pickSingleItem( mousePos, net, layer );
326 
327  if( endItem )
328  break;
329  }
330 
331  if( checkSnap( endItem ) )
332  {
333  VECTOR2I p = snapToItem( snapEnabled, endItem, mousePos );
334  controls()->ForceCursorPosition( true, p );
335  m_endItem = endItem;
336  m_endSnapPoint = p;
337  } else {
338  m_endItem = nullptr;
339  m_endSnapPoint = cursorPos;
340  }
341 
342  if( m_endItem )
343  {
344  wxLogTrace( "PNS", "%s, layer : %d", m_endItem->KindStr().c_str(), m_endItem->Layers().Start() );
345  }
346 }
347 
348 
349 void TOOL_BASE::deleteTraces( ITEM* aStartItem, bool aWholeTrack )
350 {
351  NODE *node = m_router->GetWorld()->Branch();
352 
353  if( !aStartItem )
354  return;
355 
356  if( !aWholeTrack )
357  {
358  node->Remove( aStartItem );
359  }
360  else
361  {
362  TOPOLOGY topo( node );
363  ITEM_SET path = topo.AssembleTrivialPath( aStartItem );
364 
365  for( auto ent : path.Items() )
366  node->Remove( ent.item );
367  }
368 
369  m_router->CommitRouting( node );
370 }
371 
372 
374 {
375  return m_router;
376 }
377 
378 
379 const VECTOR2I TOOL_BASE::snapToItem( bool aEnabled, ITEM* aItem, VECTOR2I aP)
380 {
381  VECTOR2I anchor;
382 
383  if( !aItem || !aEnabled )
384  {
385  return m_gridHelper->Align( aP );
386  }
387 
388  switch( aItem->Kind() )
389  {
390  case ITEM::SOLID_T:
391  anchor = static_cast<SOLID*>( aItem )->Pos();
392  break;
393 
394  case ITEM::VIA_T:
395  anchor = static_cast<VIA*>( aItem )->Pos();
396  break;
397 
398  case ITEM::SEGMENT_T:
399  {
400  SEGMENT* seg = static_cast<SEGMENT*>( aItem );
401  const SEG& s = seg->Seg();
402  int w = seg->Width();
403 
404 
405  if( ( aP - s.A ).EuclideanNorm() < w / 2 )
406  anchor = s.A;
407  else if( ( aP - s.B ).EuclideanNorm() < w / 2 )
408  anchor = s.B;
409  else
410  anchor = m_gridHelper->AlignToSegment( aP, s );
411 
412  break;
413  }
414 
415  default:
416  break;
417  }
418 
419  return anchor;
420 }
421 
422 }
PNS_MODE Mode() const
Returns the routing mode.
Class ITEM.
Definition: pns_item.h:53
virtual int GetTopLayer() const
Definition: view.cpp:849
void SetView(KIGFX::VIEW *aView)
Class NODE.
Definition: pns_node.h:136
GRID_HELPER * m_gridHelper
Definition: pns_tool_base.h:76
static const int dist[10][10]
Definition: ar_matrix.cpp:320
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Function GetMousePosition() Returns the current mouse pointer position.
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:57
const LAYER_RANGE & Layers() const
Function Layers()
Definition: pns_item.h:209
void LoadSettings(const ROUTING_SETTINGS &aSettings)
Changes routing settings to ones passed in the parameter.
Definition: pns_router.h:201
Class RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output ...
Definition: painter.h:56
Implementation of conversion functions that require both schematic and board internal units...
bool IsMotion() const
Definition: tool_event.h:299
VECTOR2I Align(const VECTOR2I &aPoint) const
VIEW_CONTROLS class definition.
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:70
const VECTOR2D Position() const
Returns mouse cursor position in world coordinates.
Definition: tool_event.h:259
const ITEM_SET QueryHoverItems(const VECTOR2I &aP)
Definition: pns_router.cpp:118
Class BOARD to handle a board.
ENTRIES & Items()
Definition: pns_itemset.h:140
bool m_startHighlight
Keeps track of whether the net was highlighted before routing.
Definition: pns_tool_base.h:71
SIZES_SETTINGS m_savedSizes
Stores sizes settings between router invocations.
Definition: pns_tool_base.h:67
void SyncWorld()
Definition: pns_router.cpp:91
VECTOR2I AlignToSegment(const VECTOR2I &aPoint, const SEG &aSeg)
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:325
bool IsPlacingVia() const
Definition: pns_router.cpp:492
const std::vector< int > GetCurrentNets() const
Definition: pns_router.cpp:452
NODE * Branch()
Function Branch()
Definition: pns_node.cpp:107
const VECTOR2I snapToItem(bool aEnabled, ITEM *aItem, VECTOR2I aP)
NODE * GetWorld() const
Definition: pns_router.h:143
virtual ITEM * pickSingleItem(const VECTOR2I &aWhere, int aNet=-1, int aLayer=-1, bool aIgnorePads=false)
bool IsHighlightEnabled() const
Function IsHighlightEnabled Returns current highlight setting.
Definition: painter.h:118
Pcbnew hotkeys.
This file contains miscellaneous commonly used macros and functions.
void ClearWorld()
Definition: pns_router.cpp:100
int GetHighlightNetCode() const
Function GetHighlightNetCode Returns netcode of currently highlighted net.
Definition: painter.h:128
bool OfKind(int aKindMask) const
Function OfKind()
Definition: pns_item.h:132
virtual void updateStartItem(const TOOL_EVENT &aEvent, bool aIgnorePads=false)
PCB_DISPLAY_OPTIONS * displayOptions() const
Definition: pcb_tool.cpp:235
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:138
virtual void updateEndItem(const TOOL_EVENT &aEvent)
virtual void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
bool checkSnap(ITEM *aItem)
const ITEM_SET AssembleTrivialPath(ITEM *aStart)
virtual ~TOOL_BASE()
PCB_GENERAL_SETTINGS & Settings()
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
PCB_EDIT_FRAME * frame() const
Definition: pcb_tool.h:139
Class TOOL_EVENT.
Definition: tool_event.h:168
ITEM * m_startItem
Definition: pns_tool_base.h:68
ROUTER * m_router
Definition: pns_tool_base.h:78
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
ROUTING_SETTINGS m_savedSettings
Stores routing settings between router invocations.
Definition: pns_tool_base.h:66
int Width() const
Definition: pns_segment.h:88
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
int Start() const
Definition: pns_layerset.h:83
bool Overlaps(const LAYER_RANGE &aOther) const
Definition: pns_layerset.h:68
void SetInterface(ROUTER_IFACE *aIface)
Definition: pns_router.cpp:516
void Remove(SOLID *aSolid)
Function Remove()
Definition: pns_node.cpp:729
PnsKind Kind() const
Function Kind()
Definition: pns_item.h:122
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:35
virtual void highlightNet(bool aEnabled, int aNetcode=-1)
Definition: seg.h:36
virtual RENDER_SETTINGS * GetSettings()=0
Function GetSettings Returns pointer to current settings that are going to be used when drawing items...
void UpdateSizes(const SIZES_SETTINGS &aSizes)
Applies stored settings.
Definition: pns_router.cpp:311
void CommitRouting(NODE *aNode)
Definition: pns_router.cpp:350
#define max(a, b)
Definition: auxiliary.h:86
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:74
void deleteTraces(ITEM *aStartItem, bool aWholeTrack)
size_t i
Definition: json11.cpp:597
VECTOR2I A
Definition: seg.h:44
void SetHostTool(PCB_TOOL *aTool)
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:80
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
const SEG & Seg() const
Definition: pns_segment.h:93
int GetCurrentLayer() const
Definition: pns_router.cpp:461
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:796
void SetDisplayOptions(PCB_DISPLAY_OPTIONS *aDispOptions)
ROUTER * Router() const
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:277
Push and Shove diff pair dimensions (gap) settings dialog.
void SetHighlight(bool aEnabled, int aNetcode=-1)
Function SetHighlight Turns on/off highlighting - it may be done for the active layer or the specifie...
Definition: painter.h:140
void SetBoard(BOARD *aBoard)
PNS_KICAD_IFACE * m_iface
Definition: pns_tool_base.h:77
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:187
const std::string KindStr() const
Function KindStr()
Definition: pns_item.cpp:63
TOOL_BASE(TOOL_TYPE aType, TOOL_ID aId, const std::string &aName=std::string(""))
Definition: tool_base.h:71
BOARD * board() const
Definition: pcb_tool.h:140
VECTOR2I B
Definition: seg.h:45