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 <wxPcbStruct.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 TOOL_ACTION TOOL_BASE::ACT_RouterOptions( "pcbnew.InteractiveRouter.RouterOptions",
66  _( "Routing Options..." ),
67  _( "Shows a dialog containing router options." ), tools_xpm );
68 
69 
70 TOOL_BASE::TOOL_BASE( const std::string& aToolName ) :
71  PCB_TOOL( aToolName )
72 {
73  m_gridHelper = nullptr;
74  m_iface = nullptr;
75  m_router = nullptr;
76 
77  m_startItem = nullptr;
78  m_startLayer = 0;
79 
80  m_endItem = nullptr;
81  m_gridHelper = nullptr;
82 }
83 
84 
86 {
87  delete m_gridHelper;
88  delete m_iface;
89  delete m_router;
90 }
91 
92 
93 
95 {
96  delete m_gridHelper;
97  delete m_iface;
98  delete m_router;
99 
100  m_iface = new PNS_KICAD_IFACE;
101  m_iface->SetBoard( board() );
102  m_iface->SetView( getView() );
103  m_iface->SetHostFrame( frame() );
104 
105  m_router = new ROUTER;
107  m_router->ClearWorld();
108  m_router->SyncWorld();
111 
112  m_gridHelper = new GRID_HELPER( frame() );
113 }
114 
115 
116 ITEM* TOOL_BASE::pickSingleItem( const VECTOR2I& aWhere, int aNet, int aLayer )
117 {
118  int tl = getView()->GetTopLayer();
119 
120  if( aLayer > 0 )
121  tl = aLayer;
122 
123  ITEM* prioritized[4];
124 
125  for( int i = 0; i < 4; i++ )
126  prioritized[i] = 0;
127 
128  ITEM_SET candidates = m_router->QueryHoverItems( aWhere );
129 
130  for( ITEM* item : candidates.Items() )
131  {
132  if( !IsCopperLayer( item->Layers().Start() ) )
133  continue;
134 
135  // fixme: this causes flicker with live loop removal...
136  //if( item->Parent() && !item->Parent()->ViewIsVisible() )
137  // continue;
138 
139  if( aNet < 0 || item->Net() == aNet )
140  {
141  if( item->OfKind( ITEM::VIA_T | ITEM::SOLID_T ) )
142  {
143  if( !prioritized[2] )
144  prioritized[2] = item;
145  if( item->Layers().Overlaps( tl ) )
146  prioritized[0] = item;
147  }
148  else
149  {
150  if( !prioritized[3] )
151  prioritized[3] = item;
152  if( item->Layers().Overlaps( tl ) )
153  prioritized[1] = item;
154  }
155  }
156  }
157 
158  ITEM* rv = NULL;
159  PCB_EDIT_FRAME* frame = getEditFrame<PCB_EDIT_FRAME>();
160  DISPLAY_OPTIONS* displ_opts = (DISPLAY_OPTIONS*)frame->GetDisplayOptions();
161 
162  for( int i = 0; i < 4; i++ )
163  {
164  ITEM* item = prioritized[i];
165 
166  if( displ_opts->m_ContrastModeDisplay )
167  if( item && !item->Layers().Overlaps( tl ) )
168  item = NULL;
169 
170  if( item )
171  {
172  rv = item;
173  break;
174  }
175  }
176 
177  if( rv && aLayer >= 0 && !rv->Layers().Overlaps( aLayer ) )
178  rv = NULL;
179 
180  if( rv )
181  {
182  wxLogTrace( "PNS", "%s, layer : %d, tl: %d", rv->KindStr().c_str(), rv->Layers().Start(), tl );
183  }
184 
185  return rv;
186 }
187 
188 
189 void TOOL_BASE::highlightNet( bool aEnabled, int aNetcode )
190 {
192 
193  if( aNetcode >= 0 && aEnabled )
194  rs->SetHighlight( true, aNetcode );
195  else
196  rs->SetHighlight( false );
197 
199 }
200 
202 {
203  bool doSnap = false;
204 
205  // Sync PNS engine settings with the general PCB editor options. I know the code below is awful, but...
206  auto& pnss = m_router->Settings();
207  const auto& gens = frame()->Settings();
208 
209  pnss.SetSnapToTracks( false );
210  pnss.SetSnapToPads( false );
211 
212  if( gens.m_magneticPads == CAPTURE_CURSOR_IN_TRACK_TOOL || gens.m_magneticPads == CAPTURE_ALWAYS )
213  pnss.SetSnapToPads( true );
214 
215  if( gens.m_magneticTracks == CAPTURE_CURSOR_IN_TRACK_TOOL || gens.m_magneticTracks == CAPTURE_ALWAYS )
216  pnss.SetSnapToTracks( true );
217 
218  if( aItem )
219  {
220  if( ( aItem->OfKind( ITEM::VIA_T ) || aItem->OfKind( ITEM::SEGMENT_T ) ) && pnss.GetSnapToTracks() )
221  doSnap = true;
222  else if( aItem->OfKind( ITEM::SOLID_T ) && pnss.GetSnapToPads() )
223  doSnap = true;
224  }
225 
226  return doSnap;
227 }
228 
230 {
231  int tl = getView()->GetTopLayer();
233  VECTOR2I p;
234 
235  controls()->ForceCursorPosition( false );
236 
237  bool snapEnabled = true;
238 
239  if( aEvent.IsMotion() || aEvent.IsClick() )
240  {
241  snapEnabled = !aEvent.Modifier( MD_SHIFT );
242  p = aEvent.Position();
243  }
244  else
245  {
246  p = cp;
247  }
248 
250 
251  if( !snapEnabled && m_startItem && !m_startItem->Layers().Overlaps( tl ) )
252  m_startItem = nullptr;
253 
254  m_startSnapPoint = snapToItem( snapEnabled, m_startItem, p );
255 
256  if( checkSnap ( m_startItem ))
257  {
259  }
260 }
261 
262 
264 {
265  controls()->ForceCursorPosition( false );
266 
267  VECTOR2I mousePos = controls()->GetMousePosition();
268  VECTOR2I cursorPos = controls()->GetCursorPosition();
269 
270  int layer;
271  bool snapEnabled = !aEvent.Modifier( MD_SHIFT );
272 
273  if( m_router->GetCurrentNets().empty() || m_router->GetCurrentNets().front() < 0 )
274  {
275  m_endSnapPoint = snapToItem( snapEnabled, nullptr, mousePos );
277  m_endItem = nullptr;
278 
279  return;
280  }
281 
282  if( m_router->IsPlacingVia() )
283  layer = -1;
284  else
285  layer = m_router->GetCurrentLayer();
286 
287  ITEM* endItem = nullptr;
288 
289  std::vector<int> nets = m_router->GetCurrentNets();
290 
291  for( int net : nets )
292  {
293  endItem = pickSingleItem( mousePos, net, layer );
294 
295  if( endItem )
296  break;
297  }
298 
299  if( checkSnap( endItem ) )
300  {
301  VECTOR2I p = snapToItem( snapEnabled, endItem, mousePos );
302  controls()->ForceCursorPosition( true, p );
303  m_endItem = endItem;
304  m_endSnapPoint = p;
305  } else {
306  m_endItem = nullptr;
307  m_endSnapPoint = cursorPos;
308  }
309 
310  if( m_endItem )
311  {
312  wxLogTrace( "PNS", "%s, layer : %d", m_endItem->KindStr().c_str(), m_endItem->Layers().Start() );
313  }
314 }
315 
316 
317 void TOOL_BASE::deleteTraces( ITEM* aStartItem, bool aWholeTrack )
318 {
319  NODE *node = m_router->GetWorld()->Branch();
320 
321  if( !aStartItem )
322  return;
323 
324  if( !aWholeTrack )
325  {
326  node->Remove( aStartItem );
327  }
328  else
329  {
330  TOPOLOGY topo( node );
331  ITEM_SET path = topo.AssembleTrivialPath( aStartItem );
332 
333  for( auto ent : path.Items() )
334  node->Remove( ent.item );
335  }
336 
337  m_router->CommitRouting( node );
338 }
339 
340 
342 {
343  return m_router;
344 }
345 
346 
347 const VECTOR2I TOOL_BASE::snapToItem( bool aEnabled, ITEM* aItem, VECTOR2I aP)
348 {
349  VECTOR2I anchor;
350 
351  if( !aItem || !aEnabled )
352  {
353  return m_gridHelper->Align( aP );
354  }
355 
356  switch( aItem->Kind() )
357  {
358  case ITEM::SOLID_T:
359  anchor = static_cast<SOLID*>( aItem )->Pos();
360  break;
361 
362  case ITEM::VIA_T:
363  anchor = static_cast<VIA*>( aItem )->Pos();
364  break;
365 
366  case ITEM::SEGMENT_T:
367  {
368  SEGMENT* seg = static_cast<SEGMENT*>( aItem );
369  const SEG& s = seg->Seg();
370  int w = seg->Width();
371 
372 
373  if( ( aP - s.A ).EuclideanNorm() < w / 2 )
374  anchor = s.A;
375  else if( ( aP - s.B ).EuclideanNorm() < w / 2 )
376  anchor = s.B;
377  else
378  anchor = m_gridHelper->AlignToSegment( aP, s );
379 
380  break;
381  }
382 
383  default:
384  break;
385  }
386 
387  return anchor;
388 }
389 
390 }
Class ITEM.
Definition: pns_item.h:53
int GetTopLayer() const
Definition: view.cpp:721
void SetView(KIGFX::VIEW *aView)
Class NODE.
Definition: pns_node.h:137
GRID_HELPER * m_gridHelper
Definition: pns_tool_base.h:76
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:58
const LAYER_RANGE & Layers() const
Function Layers()
Definition: pns_item.h:207
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:290
VECTOR2I Align(const VECTOR2I &aPoint) const
VIEW_CONTROLS class definition.
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:71
const ITEM_SET QueryHoverItems(const VECTOR2I &aP)
Definition: pns_router.cpp:118
Class BOARD to handle a board.
ENTRIES & Items()
Definition: pns_itemset.h:137
SIZES_SETTINGS m_savedSizes
Stores sizes settings between router invocations.
Definition: pns_tool_base.h:68
void SyncWorld()
Definition: pns_router.cpp:91
VECTOR2I AlignToSegment(const VECTOR2I &aPoint, const SEG &aSeg)
static int LegacyHotKey(int aHotKey)
Creates a hot key code that refers to a legacy hot key setting, instead of a particular key...
Definition: tool_action.h:174
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:311
const VECTOR2D & Position() const
Returns mouse cursor position in world coordinates.
Definition: tool_event.h:248
bool IsPlacingVia() const
Definition: pns_router.cpp:468
const std::vector< int > GetCurrentNets() const
Definition: pns_router.cpp:428
NODE * Branch()
Function Branch()
Definition: pns_node.cpp:109
const VECTOR2I snapToItem(bool aEnabled, ITEM *aItem, VECTOR2I aP)
NODE * GetWorld() const
Definition: pns_router.h:143
void * GetDisplayOptions() override
Function GetDisplayOptions returns the display options current in use Display options are relative to...
Pcbnew hotkeys.
This file contains miscellaneous commonly used macros and functions.
void ClearWorld()
Definition: pns_router.cpp:100
bool OfKind(int aKindMask) const
Function OfKind()
Definition: pns_item.h:130
void SetHostFrame(PCB_EDIT_FRAME *aFrame)
KIGFX::VIEW_CONTROLS * controls() const
Definition: pcb_tool.h:124
virtual void updateEndItem(const TOOL_EVENT &aEvent)
virtual void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
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:125
Class TOOL_EVENT.
Definition: tool_event.h:162
ITEM * m_startItem
Definition: pns_tool_base.h:69
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:67
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:196
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:492
void Remove(SOLID *aSolid)
Function Remove()
Definition: pns_node.cpp:729
Class DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
Definition: pcbstruct.h:62
PnsKind Kind() const
Function Kind()
Definition: pns_item.h:120
KIGFX::VIEW * getView() const
Function getView()
Definition: tool_base.cpp:35
virtual void highlightNet(bool aEnabled, int aNetcode=-1)
Definition: seg.h:37
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:287
void CommitRouting(NODE *aNode)
Definition: pns_router.cpp:326
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:74
void deleteTraces(ITEM *aStartItem, bool aWholeTrack)
Class TOOL_ACTION.
Definition: tool_action.h:46
VECTOR2I A
Definition: seg.h:47
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
virtual ITEM * pickSingleItem(const VECTOR2I &aWhere, int aNet=-1, int aLayer=-1)
int GetCurrentLayer() const
Definition: pns_router.cpp:437
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:675
ROUTER * Router() const
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:268
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:126
virtual void updateStartItem(TOOL_EVENT &aEvent)
VECTOR2I B
Definition: seg.h:48