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  TOOL_INTERACTIVE( 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 
82  m_frame = nullptr;
83  m_ctls = nullptr;
84  m_board = nullptr;
85  m_gridHelper = nullptr;
86 }
87 
88 
90 {
91  delete m_gridHelper;
92  delete m_iface;
93  delete m_router;
94 }
95 
96 
97 
99 {
100  delete m_gridHelper;
101  delete m_iface;
102  delete m_router;
103 
104  m_frame = getEditFrame<PCB_EDIT_FRAME>();
106  m_board = getModel<BOARD>();
107 
108  m_iface = new PNS_KICAD_IFACE;
109  m_iface->SetBoard( m_board );
110  m_iface->SetView( getView() );
111  m_iface->SetHostFrame( m_frame );
112 
113  m_router = new ROUTER;
114  m_router->SetInterface(m_iface);
115  m_router->ClearWorld();
116  m_router->SyncWorld();
119 
121 }
122 
123 
124 ITEM* TOOL_BASE::pickSingleItem( const VECTOR2I& aWhere, int aNet, int aLayer )
125 {
126  int tl = getView()->GetTopLayer();
127 
128  if( aLayer > 0 )
129  tl = aLayer;
130 
131  ITEM* prioritized[4];
132 
133  for( int i = 0; i < 4; i++ )
134  prioritized[i] = 0;
135 
136  ITEM_SET candidates = m_router->QueryHoverItems( aWhere );
137 
138  for( ITEM* item : candidates.Items() )
139  {
140  if( !IsCopperLayer( item->Layers().Start() ) )
141  continue;
142 
143  // fixme: this causes flicker with live loop removal...
144  //if( item->Parent() && !item->Parent()->ViewIsVisible() )
145  // continue;
146 
147  if( aNet < 0 || item->Net() == aNet )
148  {
149  if( item->OfKind( ITEM::VIA_T | ITEM::SOLID_T ) )
150  {
151  if( !prioritized[2] )
152  prioritized[2] = item;
153  if( item->Layers().Overlaps( tl ) )
154  prioritized[0] = item;
155  }
156  else
157  {
158  if( !prioritized[3] )
159  prioritized[3] = item;
160  if( item->Layers().Overlaps( tl ) )
161  prioritized[1] = item;
162  }
163  }
164  }
165 
166  ITEM* rv = NULL;
167  PCB_EDIT_FRAME* frame = getEditFrame<PCB_EDIT_FRAME>();
168  DISPLAY_OPTIONS* displ_opts = (DISPLAY_OPTIONS*)frame->GetDisplayOptions();
169 
170  for( int i = 0; i < 4; i++ )
171  {
172  ITEM* item = prioritized[i];
173 
174  if( displ_opts->m_ContrastModeDisplay )
175  if( item && !item->Layers().Overlaps( tl ) )
176  item = NULL;
177 
178  if( item )
179  {
180  rv = item;
181  break;
182  }
183  }
184 
185  if( rv && aLayer >= 0 && !rv->Layers().Overlaps( aLayer ) )
186  rv = NULL;
187 
188  if( rv )
189  {
190  wxLogTrace( "PNS", "%s, layer : %d, tl: %d", rv->KindStr().c_str(), rv->Layers().Start(), tl );
191  }
192 
193  return rv;
194 }
195 
196 
197 void TOOL_BASE::highlightNet( bool aEnabled, int aNetcode )
198 {
200 
201  if( aNetcode >= 0 && aEnabled )
202  rs->SetHighlight( true, aNetcode );
203  else
204  rs->SetHighlight( false );
205 
207 }
208 
209 
211 {
212  int tl = getView()->GetTopLayer();
214  VECTOR2I p;
215 
216  bool snapEnabled = true;
217 
218  if( aEvent.IsMotion() || aEvent.IsClick() )
219  {
220  snapEnabled = !aEvent.Modifier( MD_SHIFT );
221  p = aEvent.Position();
222  }
223  else
224  {
225  p = cp;
226  }
227 
229 
230  if( !snapEnabled && m_startItem && !m_startItem->Layers().Overlaps( tl ) )
231  m_startItem = nullptr;
232 
233  m_startSnapPoint = snapToItem( snapEnabled, m_startItem, p );
235 }
236 
237 
239 {
241  int layer;
242  bool snapEnabled = !aEvent.Modifier( MD_SHIFT );
243 
244  if( m_router->GetCurrentNets().empty() || m_router->GetCurrentNets().front() < 0 )
245  {
246  m_endSnapPoint = snapToItem( snapEnabled, nullptr, p );
248  m_endItem = nullptr;
249 
250  return;
251  }
252 
253  if( m_router->IsPlacingVia() )
254  layer = -1;
255  else
256  layer = m_router->GetCurrentLayer();
257 
258  ITEM* endItem = nullptr;
259 
260  std::vector<int> nets = m_router->GetCurrentNets();
261 
262  for( int net : nets )
263  {
264  endItem = pickSingleItem( p, net, layer );
265 
266  if( endItem )
267  break;
268  }
269 
270  VECTOR2I cursorPos = snapToItem( snapEnabled, endItem, p );
271  m_ctls->ForceCursorPosition( true, cursorPos );
272  m_endItem = endItem;
273  m_endSnapPoint = cursorPos;
274 
275  if( m_endItem )
276  {
277  wxLogTrace( "PNS", "%s, layer : %d", m_endItem->KindStr().c_str(), m_endItem->Layers().Start() );
278  }
279 }
280 
281 
282 void TOOL_BASE::deleteTraces( ITEM* aStartItem, bool aWholeTrack )
283 {
284  NODE *node = m_router->GetWorld()->Branch();
285 
286  if( !aStartItem )
287  return;
288 
289  if( !aWholeTrack )
290  {
291  node->Remove( aStartItem );
292  }
293  else
294  {
295  TOPOLOGY topo( node );
296  ITEM_SET path = topo.AssembleTrivialPath( aStartItem );
297 
298  for( auto ent : path.Items() )
299  node->Remove( ent.item );
300  }
301 
302  m_router->CommitRouting( node );
303 }
304 
305 
307 {
308  return m_router;
309 }
310 
311 
312 const VECTOR2I TOOL_BASE::snapToItem( bool aEnabled, ITEM* aItem, VECTOR2I aP)
313 {
314  VECTOR2I anchor;
315 
316  if( !aItem || !aEnabled )
317  {
318  return m_gridHelper->Align( aP );
319  }
320 
321  switch( aItem->Kind() )
322  {
323  case ITEM::SOLID_T:
324  anchor = static_cast<SOLID*>( aItem )->Pos();
325  break;
326 
327  case ITEM::VIA_T:
328  anchor = static_cast<VIA*>( aItem )->Pos();
329  break;
330 
331  case ITEM::SEGMENT_T:
332  {
333  SEGMENT* seg = static_cast<SEGMENT*>( aItem );
334  const SEG& s = seg->Seg();
335  int w = seg->Width();
336 
337 
338  if( ( aP - s.A ).EuclideanNorm() < w / 2 )
339  anchor = s.A;
340  else if( ( aP - s.B ).EuclideanNorm() < w / 2 )
341  anchor = s.B;
342  else
343  anchor = m_gridHelper->AlignToSegment( aP, s );
344 
345  break;
346  }
347 
348  default:
349  break;
350  }
351 
352  return anchor;
353 }
354 
355 }
Class ITEM.
Definition: pns_item.h:53
int GetTopLayer() const
Definition: view.cpp:739
Class NODE.
Definition: pns_node.h:137
GRID_HELPER * m_gridHelper
Definition: pns_tool_base.h:83
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:192
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
Definition: grid_helper.cpp:95
VIEW_CONTROLS class definition.
VECTOR2I m_startSnapPoint
Definition: pns_tool_base.h:75
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:72
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:459
const std::vector< int > GetCurrentNets() const
Definition: pns_router.cpp:419
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:134
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
KIGFX::VIEW_CONTROLS * m_ctls
Definition: pns_tool_base.h:81
virtual void updateEndItem(const TOOL_EVENT &aEvent)
virtual void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
const ITEM_SET AssembleTrivialPath(ITEM *aStart)
virtual ~TOOL_BASE()
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
Class TOOL_EVENT.
Definition: tool_event.h:162
ITEM * m_startItem
Definition: pns_tool_base.h:73
ROUTER * m_router
Definition: pns_tool_base.h:85
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:71
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:483
KIGFX::VIEW_CONTROLS * getViewControls() const
Function getViewControls()
Definition: tool_base.cpp:36
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:30
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:278
void CommitRouting(NODE *aNode)
Definition: pns_router.cpp:317
VECTOR2I m_endSnapPoint
Definition: pns_tool_base.h:78
void deleteTraces(ITEM *aStartItem, bool aWholeTrack)
Class TOOL_ACTION.
Definition: tool_action.h:46
VECTOR2I A
Definition: seg.h:47
PCB_EDIT_FRAME * m_frame
Definition: pns_tool_base.h:80
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:428
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:674
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:84
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
virtual void updateStartItem(TOOL_EVENT &aEvent)
VECTOR2I B
Definition: seg.h:48