KiCad PCB EDA Suite
pns_kicad_iface.cpp
Go to the documentation of this file.
1 /*
2  * KiRouter - a push-and-(sometimes-)shove PCB router
3  *
4  * Copyright (C) 2013-2016 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 
23 #include <class_board.h>
25 #include <class_module.h>
26 #include <class_track.h>
27 #include <board_commit.h>
29 #include <geometry/convex_hull.h>
30 #include <wxPcbStruct.h>
31 
32 #include <unordered_set>
33 #include <unordered_map>
34 
35 #include <view/view.h>
36 #include <view/view_item.h>
37 #include <view/view_group.h>
39 
40 #include <pcb_painter.h>
41 
42 #include <geometry/shape.h>
44 #include <geometry/shape_rect.h>
45 #include <geometry/shape_circle.h>
46 #include <geometry/shape_convex.h>
47 #include <geometry/convex_hull.h>
48 
49 #include "tools/pcb_tool.h"
50 
51 #include "pns_kicad_iface.h"
52 #include "pns_routing_settings.h"
53 #include "pns_sizes_settings.h"
54 #include "pns_item.h"
55 #include "pns_solid.h"
56 #include "pns_segment.h"
57 #include "pns_solid.h"
58 #include "pns_itemset.h"
59 #include "pns_node.h"
60 #include "pns_topology.h"
61 #include "pns_router.h"
62 #include "pns_debug_decorator.h"
63 #include "router_preview_item.h"
64 
66 {
67 public:
68  PNS_PCBNEW_RULE_RESOLVER( BOARD* aBoard, PNS::ROUTER* aRouter );
69  virtual ~PNS_PCBNEW_RULE_RESOLVER();
70 
71  virtual int Clearance( const PNS::ITEM* aA, const PNS::ITEM* aB ) const override;
72  virtual int Clearance( int aNetCode ) const override;
73  virtual void OverrideClearance( bool aEnable, int aNetA = 0, int aNetB = 0, int aClearance = 0 ) override;
74  virtual void UseDpGap( bool aUseDpGap ) override { m_useDpGap = aUseDpGap; }
75  virtual int DpCoupledNet( int aNet ) override;
76  virtual int DpNetPolarity( int aNet ) override;
77  virtual bool DpNetPair( PNS::ITEM* aItem, int& aNetP, int& aNetN ) override;
78 
79 private:
81  {
83  int clearance;
84  };
85 
86  int localPadClearance( const PNS::ITEM* aItem ) const;
87  int matchDpSuffix( wxString aNetName, wxString& aComplementNet, wxString& aBaseDpName );
88 
91 
92  std::vector<CLEARANCE_ENT> m_netClearanceCache;
93  std::unordered_map<const D_PAD*, int> m_localClearanceCache;
98  bool m_useDpGap;
99 };
100 
101 
103  m_router( aRouter ),
104  m_board( aBoard )
105 {
106  PNS::NODE* world = m_router->GetWorld();
107 
108  PNS::TOPOLOGY topo( world );
110 
111  // Build clearance cache for net classes
112  for( unsigned int i = 0; i < m_board->GetNetCount(); i++ )
113  {
114  NETINFO_ITEM* ni = m_board->FindNet( i );
115 
116  if( ni == NULL )
117  continue;
118 
119  CLEARANCE_ENT ent;
120  ent.coupledNet = DpCoupledNet( i );
121 
122  wxString netClassName = ni->GetClassName();
123  NETCLASSPTR nc = m_board->GetDesignSettings().m_NetClasses.Find( netClassName );
124 
125  int clearance = nc->GetClearance();
126  ent.clearance = clearance;
127  m_netClearanceCache[i] = ent;
128 
129  wxLogTrace( "PNS", "Add net %u netclass %s clearance %d", i, netClassName.mb_str(), clearance );
130  }
131 
132  // Build clearance cache for pads
133  for( MODULE* mod = m_board->m_Modules; mod ; mod = mod->Next() )
134  {
135  auto moduleClearance = mod->GetLocalClearance();
136 
137  for( D_PAD* pad = mod->PadsList(); pad; pad = pad->Next() )
138  {
139  int padClearance = pad->GetLocalClearance();
140 
141  if( padClearance > 0 )
142  m_localClearanceCache[ pad ] = padClearance;
143 
144  else if( moduleClearance > 0 )
145  m_localClearanceCache[ pad ] = moduleClearance;
146  }
147  }
148 
149  //printf("DefaultCL : %d\n", m_board->GetDesignSettings().m_NetClasses.Find ("Default clearance")->GetClearance());
150 
151  m_overrideEnabled = false;
152  m_defaultClearance = Millimeter2iu( 0.254 ); // m_board->m_NetClasses.Find ("Default clearance")->GetClearance();
153  m_overrideNetA = 0;
154  m_overrideNetB = 0;
156  m_useDpGap = false;
157 }
158 
159 
161 {
162 }
163 
164 
166 {
167  if( !aItem->Parent() || aItem->Parent()->Type() != PCB_PAD_T )
168  return 0;
169 
170  const D_PAD* pad = static_cast<D_PAD*>( aItem->Parent() );
171 
172  auto i = m_localClearanceCache.find( pad );
173 
174  if( i == m_localClearanceCache.end() )
175  return 0;
176 
177  return i->second;
178 }
179 
180 
181 int PNS_PCBNEW_RULE_RESOLVER::Clearance( const PNS::ITEM* aA, const PNS::ITEM* aB ) const
182 {
183  int net_a = aA->Net();
184  int cl_a = ( net_a >= 0 ? m_netClearanceCache[net_a].clearance : m_defaultClearance );
185  int net_b = aB->Net();
186  int cl_b = ( net_b >= 0 ? m_netClearanceCache[net_b].clearance : m_defaultClearance );
187 
188  bool linesOnly = aA->OfKind( PNS::ITEM::SEGMENT_T | PNS::ITEM::LINE_T )
190 
191  if( linesOnly && net_a >= 0 && net_b >= 0 && m_netClearanceCache[net_a].coupledNet == net_b )
192  {
193  cl_a = cl_b = m_router->Sizes().DiffPairGap() - 2 * PNS_HULL_MARGIN;
194  }
195 
196  int pad_a = localPadClearance( aA );
197  int pad_b = localPadClearance( aB );
198 
199  if( pad_a > 0 )
200  cl_a = pad_a;
201 
202  if( pad_b > 0 )
203  cl_b = pad_b;
204 
205  return std::max( cl_a, cl_b );
206 }
207 
208 
209 int PNS_PCBNEW_RULE_RESOLVER::Clearance( int aNetCode ) const
210 {
211  if( aNetCode > 0 && aNetCode < (int) m_netClearanceCache.size() )
212  return m_netClearanceCache[aNetCode].clearance;
213 
214  return m_defaultClearance;
215 }
216 
217 
218 // fixme: ugly hack to make the optimizer respect gap width for currently routed differential pair.
219 void PNS_PCBNEW_RULE_RESOLVER::OverrideClearance( bool aEnable, int aNetA, int aNetB , int aClearance )
220 {
221  m_overrideEnabled = aEnable;
222  m_overrideNetA = aNetA;
223  m_overrideNetB = aNetB;
224  m_overrideClearance = aClearance;
225 }
226 
227 
228 int PNS_PCBNEW_RULE_RESOLVER::matchDpSuffix( wxString aNetName, wxString& aComplementNet, wxString& aBaseDpName )
229 {
230  int rv = 0;
231 
232  if( aNetName.EndsWith( "+" ) )
233  {
234  aComplementNet = "-";
235  rv = 1;
236  }
237  else if( aNetName.EndsWith( "P" ) )
238  {
239  aComplementNet = "N";
240  rv = 1;
241  }
242  else if( aNetName.EndsWith( "-" ) )
243  {
244  aComplementNet = "+";
245  rv = -1;
246  }
247  else if( aNetName.EndsWith( "N" ) )
248  {
249  aComplementNet = "P";
250  rv = -1;
251  }
252  // Match P followed by 2 digits
253  else if( aNetName.Right( 2 ).IsNumber() && aNetName.Right( 3 ).Left( 1 ) == "P" )
254  {
255  aComplementNet = "N" + aNetName.Right( 2 );
256  rv = 1;
257  }
258  // Match P followed by 1 digit
259  else if( aNetName.Right( 1 ).IsNumber() && aNetName.Right( 2 ).Left( 1 ) == "P" )
260  {
261  aComplementNet = "N" + aNetName.Right( 1 );
262  rv = 1;
263  }
264  // Match N followed by 2 digits
265  else if( aNetName.Right( 2 ).IsNumber() && aNetName.Right( 3 ).Left( 1 ) == "N" )
266  {
267  aComplementNet = "P" + aNetName.Right( 2 );
268  rv = -1;
269  }
270  // Match N followed by 1 digit
271  else if( aNetName.Right( 1 ).IsNumber() && aNetName.Right( 2 ).Left( 1 ) == "N" )
272  {
273  aComplementNet = "P" + aNetName.Right( 1 );
274  rv = -1;
275  }
276  if( rv != 0 )
277  {
278  aBaseDpName = aNetName.Left( aNetName.Length() - aComplementNet.Length() );
279  aComplementNet = aBaseDpName + aComplementNet;
280  }
281 
282  return rv;
283 }
284 
285 
287 {
288  wxString refName = m_board->FindNet( aNet )->GetNetname();
289  wxString dummy, coupledNetName;
290 
291  if( matchDpSuffix( refName, coupledNetName, dummy ) )
292  {
293  NETINFO_ITEM* net = m_board->FindNet( coupledNetName );
294 
295  if( !net )
296  return -1;
297 
298  return net->GetNet();
299  }
300 
301  return -1;
302 }
303 
304 
306 {
307  wxString refName = m_board->FindNet( aNet )->GetNetname();
308  wxString dummy1, dummy2;
309 
310  return matchDpSuffix( refName, dummy1, dummy2 );
311 }
312 
313 
314 bool PNS_PCBNEW_RULE_RESOLVER::DpNetPair( PNS::ITEM* aItem, int& aNetP, int& aNetN )
315 {
316  if( !aItem || !aItem->Parent() || !aItem->Parent()->GetNet() )
317  return false;
318 
319  wxString netNameP = aItem->Parent()->GetNet()->GetNetname();
320  wxString netNameN, netNameCoupled, netNameBase;
321 
322  int r = matchDpSuffix( netNameP, netNameCoupled, netNameBase );
323 
324  if( r == 0 )
325  return false;
326  else if( r == 1 )
327  {
328  netNameN = netNameCoupled;
329  }
330  else
331  {
332  netNameN = netNameP;
333  netNameP = netNameCoupled;
334  }
335 
336 // wxLogTrace( "PNS","p %s n %s base %s\n", (const char *)netNameP.c_str(), (const char *)netNameN.c_str(), (const char *)netNameBase.c_str() );
337 
338  NETINFO_ITEM* netInfoP = m_board->FindNet( netNameP );
339  NETINFO_ITEM* netInfoN = m_board->FindNet( netNameN );
340 
341  //wxLogTrace( "PNS","ip %p in %p\n", netInfoP, netInfoN);
342 
343  if( !netInfoP || !netInfoN )
344  return false;
345 
346  aNetP = netInfoP->GetNet();
347  aNetN = netInfoN->GetNet();
348 
349  return true;
350 }
351 
352 
354 {
355 public:
357  m_view( NULL ), m_items( NULL )
358  {
359  SetView( aView );
360  }
361 
363  {
364  Clear();
365  delete m_items;
366  }
367 
368  void SetView( KIGFX::VIEW* aView )
369  {
370  Clear();
371  delete m_items;
372  m_items = NULL;
373  m_view = aView;
374 
375  if( m_view == NULL )
376  return;
377 
380  m_view->Add( m_items );
381  }
382 
383  void AddPoint( VECTOR2I aP, int aColor ) override
384  {
386 
387  l.Append( aP - VECTOR2I( -50000, -50000 ) );
388  l.Append( aP + VECTOR2I( -50000, -50000 ) );
389 
390  AddLine( l, aColor, 10000 );
391 
392  l.Clear();
393  l.Append( aP - VECTOR2I( 50000, -50000 ) );
394  l.Append( aP + VECTOR2I( 50000, -50000 ) );
395 
396  AddLine( l, aColor, 10000 );
397  }
398 
399  void AddBox( BOX2I aB, int aColor ) override
400  {
402 
403  VECTOR2I o = aB.GetOrigin();
404  VECTOR2I s = aB.GetSize();
405 
406  l.Append( o );
407  l.Append( o.x + s.x, o.y );
408  l.Append( o.x + s.x, o.y + s.y );
409  l.Append( o.x, o.y + s.y );
410  l.Append( o );
411 
412  AddLine( l, aColor, 10000 );
413  }
414 
415  void AddSegment( SEG aS, int aColor ) override
416  {
418 
419  l.Append( aS.A );
420  l.Append( aS.B );
421 
422  AddLine( l, aColor, 10000 );
423  }
424 
425  void AddDirections( VECTOR2D aP, int aMask, int aColor ) override
426  {
427  BOX2I b( aP - VECTOR2I( 10000, 10000 ), VECTOR2I( 20000, 20000 ) );
428 
429  AddBox( b, aColor );
430  for( int i = 0; i < 8; i++ )
431  {
432  if( ( 1 << i ) & aMask )
433  {
434  VECTOR2I v = DIRECTION_45( ( DIRECTION_45::Directions ) i ).ToVector() * 100000;
435  AddSegment( SEG( aP, aP + v ), aColor );
436  }
437  }
438  }
439 
440  void AddLine( const SHAPE_LINE_CHAIN& aLine, int aType, int aWidth ) override
441  {
442  ROUTER_PREVIEW_ITEM* pitem = new ROUTER_PREVIEW_ITEM( NULL, m_view );
443 
444  pitem->Line( aLine, aWidth, aType );
445  m_items->Add( pitem ); // Should not be needed, as m_items has been passed as a parent group in alloc;
446  m_view->Update( m_items );
447  }
448 
449  void Clear() override
450  {
451  if( m_view && m_items )
452  {
453  m_items->FreeItems();
454  m_view->Update( m_items );
455  }
456  }
457 
458 private:
461 };
462 
463 
465 {
466  return m_debugDecorator;
467 }
468 
469 
471 {
472  m_ruleResolver = nullptr;
473  m_board = nullptr;
474  m_tool = nullptr;
475  m_view = nullptr;
476  m_previewItems = nullptr;
477  m_world = nullptr;
478  m_router = nullptr;
479  m_debugDecorator = nullptr;
480  m_dispOptions = nullptr;
481 }
482 
483 
485 {
486  delete m_ruleResolver;
487  delete m_debugDecorator;
488 
489  if( m_previewItems )
490  {
492  delete m_previewItems;
493  }
494 }
495 
496 
497 std::unique_ptr<PNS::SOLID> PNS_KICAD_IFACE::syncPad( D_PAD* aPad )
498 {
499  LAYER_RANGE layers( 0, MAX_CU_LAYERS - 1 );
500 
501  // ignore non-copper pads
502  if( ( aPad->GetLayerSet() & LSET::AllCuMask()).none() )
503  return NULL;
504 
505  switch( aPad->GetAttribute() )
506  {
507  case PAD_ATTRIB_STANDARD:
508  break;
509 
510  case PAD_ATTRIB_SMD:
512  case PAD_ATTRIB_CONN:
513  {
514  LSET lmsk = aPad->GetLayerSet();
515  bool is_copper = false;
516 
517  for( int i = 0; i < MAX_CU_LAYERS; i++ )
518  {
519  if( lmsk[i] )
520  {
521  is_copper = true;
522 
524  layers = LAYER_RANGE( i );
525 
526  break;
527  }
528  }
529 
530  if( !is_copper )
531  return NULL;
532  }
533  break;
534 
535  default:
536  wxLogTrace( "PNS", "unsupported pad type 0x%x", aPad->GetAttribute() );
537  return NULL;
538  }
539 
540  std::unique_ptr< PNS::SOLID > solid( new PNS::SOLID );
541 
542  solid->SetLayers( layers );
543  solid->SetNet( aPad->GetNetCode() );
544  solid->SetParent( aPad );
545 
546  wxPoint wx_c = aPad->ShapePos();
547  wxSize wx_sz = aPad->GetSize();
548  wxPoint offset = aPad->GetOffset();
549 
550  VECTOR2I c( wx_c.x, wx_c.y );
551  VECTOR2I sz( wx_sz.x, wx_sz.y );
552 
553  RotatePoint( &offset, aPad->GetOrientation() );
554 
555  solid->SetPos( VECTOR2I( c.x - offset.x, c.y - offset.y ) );
556  solid->SetOffset( VECTOR2I( offset.x, offset.y ) );
557 
558  double orient = aPad->GetOrientation() / 10.0;
559 
560  if( aPad->GetShape() == PAD_SHAPE_CIRCLE )
561  {
562  solid->SetShape( new SHAPE_CIRCLE( c, sz.x / 2 ) );
563  }
564  else
565  {
566  if( orient == 0.0 || orient == 90.0 || orient == 180.0 || orient == 270.0 )
567  {
568  if( orient == 90.0 || orient == 270.0 )
569  sz = VECTOR2I( sz.y, sz.x );
570 
571  switch( aPad->GetShape() )
572  {
573  case PAD_SHAPE_OVAL:
574  if( sz.x == sz.y )
575  solid->SetShape( new SHAPE_CIRCLE( c, sz.x / 2 ) );
576  else
577  {
578  VECTOR2I delta;
579 
580  if( sz.x > sz.y )
581  delta = VECTOR2I( ( sz.x - sz.y ) / 2, 0 );
582  else
583  delta = VECTOR2I( 0, ( sz.y - sz.x ) / 2 );
584 
585  SHAPE_SEGMENT* shape = new SHAPE_SEGMENT( c - delta, c + delta,
586  std::min( sz.x, sz.y ) );
587  solid->SetShape( shape );
588  }
589  break;
590 
591  case PAD_SHAPE_RECT:
592  solid->SetShape( new SHAPE_RECT( c - sz / 2, sz.x, sz.y ) );
593  break;
594 
595  case PAD_SHAPE_TRAPEZOID:
596  {
597  wxPoint coords[4];
598  aPad->BuildPadPolygon( coords, wxSize( 0, 0 ), aPad->GetOrientation() );
599  SHAPE_CONVEX* shape = new SHAPE_CONVEX();
600 
601  for( int ii = 0; ii < 4; ii++ )
602  {
603  shape->Append( wx_c + coords[ii] );
604  }
605 
606  solid->SetShape( shape );
607  break;
608  }
609 
610  case PAD_SHAPE_ROUNDRECT:
611  {
612  SHAPE_POLY_SET outline;
613  const int segmentToCircleCount = 64;
614 
615  aPad->BuildPadShapePolygon( outline, wxSize( 0, 0 ), segmentToCircleCount, 1.0 );
616 
617  // TransformRoundRectToPolygon creates only one convex polygon
618  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
619  SHAPE_CONVEX* shape = new SHAPE_CONVEX();
620 
621  for( int ii = 0; ii < poly.PointCount(); ++ii )
622  {
623  shape->Append( wxPoint( poly.Point( ii ).x, poly.Point( ii ).y ) );
624  }
625 
626  solid->SetShape( shape );
627  }
628  break;
629 
630  case PAD_SHAPE_CUSTOM:
631  {
632  SHAPE_POLY_SET outline;
633  outline.Append( aPad->GetCustomShapeAsPolygon() );
634  aPad->CustomShapeAsPolygonToBoardPosition( &outline, wx_c, aPad->GetOrientation() );
635 
636  for( int jj = 0; jj < outline.OutlineCount(); ++jj )
637  {
638  SHAPE_CONVEX* shape = new SHAPE_CONVEX();
639  const SHAPE_LINE_CHAIN& poly = outline.COutline( jj );
640 
641  for( int ii = 0; ii < poly.PointCount(); ii++ )
642  shape->Append( wxPoint( poly.CPoint( ii ).x, poly.CPoint( ii ).y ) );
643 
644  solid->SetShape( shape );
645  }
646 
647  break;
648  }
649 
650  default:
651  wxLogTrace( "PNS", "unsupported pad shape" );
652  return nullptr;
653  }
654  }
655  else
656  {
657  switch( aPad->GetShape() )
658  {
659  // PAD_SHAPE_CIRCLE already handled above
660 
661  case PAD_SHAPE_OVAL:
662  if( sz.x == sz.y )
663  solid->SetShape( new SHAPE_CIRCLE( c, sz.x / 2 ) );
664  else
665  {
666  wxPoint start;
667  wxPoint end;
668  wxPoint corner;
669 
670  SHAPE_CONVEX* shape = new SHAPE_CONVEX();
671 
672  int w = aPad->BuildSegmentFromOvalShape( start, end, 0.0, wxSize( 0, 0 ) );
673 
674  if( start.y == 0 )
675  corner = wxPoint( start.x, -( w / 2 ) );
676  else
677  corner = wxPoint( w / 2, start.y );
678 
679  RotatePoint( &start, aPad->GetOrientation() );
680  RotatePoint( &corner, aPad->GetOrientation() );
681  shape->Append( wx_c + corner );
682 
683  for( int rot = 100; rot <= 1800; rot += 100 )
684  {
685  wxPoint p( corner );
686  RotatePoint( &p, start, rot );
687  shape->Append( wx_c + p );
688  }
689 
690  if( end.y == 0 )
691  corner = wxPoint( end.x, w / 2 );
692  else
693  corner = wxPoint( -( w / 2 ), end.y );
694 
695  RotatePoint( &end, aPad->GetOrientation() );
696  RotatePoint( &corner, aPad->GetOrientation() );
697  shape->Append( wx_c + corner );
698 
699  for( int rot = 100; rot <= 1800; rot += 100 )
700  {
701  wxPoint p( corner );
702  RotatePoint( &p, end, rot );
703  shape->Append( wx_c + p );
704  }
705 
706  solid->SetShape( shape );
707  }
708  break;
709 
710  case PAD_SHAPE_RECT:
711  case PAD_SHAPE_TRAPEZOID:
712  {
713  wxPoint coords[4];
714  aPad->BuildPadPolygon( coords, wxSize( 0, 0 ), aPad->GetOrientation() );
715 
716  SHAPE_CONVEX* shape = new SHAPE_CONVEX();
717  for( int ii = 0; ii < 4; ii++ )
718  {
719  shape->Append( wx_c + coords[ii] );
720  }
721 
722  solid->SetShape( shape );
723  break;
724  }
725 
726  case PAD_SHAPE_ROUNDRECT:
727  {
728  SHAPE_POLY_SET outline;
729  const int segmentToCircleCount = 32;
730  aPad->BuildPadShapePolygon( outline, wxSize( 0, 0 ),
731  segmentToCircleCount, 1.0 );
732 
733  // TransformRoundRectToPolygon creates only one convex polygon
734  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
735  SHAPE_CONVEX* shape = new SHAPE_CONVEX();
736 
737  for( int ii = 0; ii < poly.PointCount(); ++ii )
738  {
739  shape->Append( wxPoint( poly.Point( ii ).x, poly.Point( ii ).y ) );
740  }
741 
742  solid->SetShape( shape );
743  break;
744  }
745 
746  case PAD_SHAPE_CUSTOM:
747  {
748  SHAPE_POLY_SET outline;
749  outline.Append( aPad->GetCustomShapeAsPolygon() );
750  aPad->CustomShapeAsPolygonToBoardPosition( &outline, wx_c, aPad->GetOrientation() );
751 
752  for( int jj = 0; jj < outline.OutlineCount(); ++jj )
753  {
754  SHAPE_CONVEX* shape = new SHAPE_CONVEX();
755  const SHAPE_LINE_CHAIN& poly = outline.COutline( jj );
756 
757  for( int ii = 0; ii < poly.PointCount(); ii++ )
758  shape->Append( wxPoint( poly.CPoint( ii ).x, poly.CPoint( ii ).y ) );
759 
760  solid->SetShape( shape );
761  }
762 
763  break;
764  }
765 
766  default:
767  wxLogTrace( "PNS", "unsupported pad shape" );
768  return nullptr;
769  }
770  }
771  }
772  return solid;
773 }
774 
775 
776 std::unique_ptr<PNS::SEGMENT> PNS_KICAD_IFACE::syncTrack( TRACK* aTrack )
777 {
778  std::unique_ptr< PNS::SEGMENT > segment(
779  new PNS::SEGMENT( SEG( aTrack->GetStart(), aTrack->GetEnd() ), aTrack->GetNetCode() )
780  );
781 
782  segment->SetWidth( aTrack->GetWidth() );
783  segment->SetLayers( LAYER_RANGE( aTrack->GetLayer() ) );
784  segment->SetParent( aTrack );
785 
786  if( aTrack->IsLocked() )
787  segment->Mark( PNS::MK_LOCKED );
788 
789  return segment;
790 }
791 
792 
793 std::unique_ptr<PNS::VIA> PNS_KICAD_IFACE::syncVia( VIA* aVia )
794 {
795  PCB_LAYER_ID top, bottom;
796  aVia->LayerPair( &top, &bottom );
797  std::unique_ptr<PNS::VIA> via( new PNS::VIA(
798  aVia->GetPosition(),
799  LAYER_RANGE( top, bottom ),
800  aVia->GetWidth(),
801  aVia->GetDrillValue(),
802  aVia->GetNetCode(),
803  aVia->GetViaType() )
804  );
805 
806  via->SetParent( aVia );
807 
808  if( aVia->IsLocked() )
809  via->Mark( PNS::MK_LOCKED );
810 
811  return via;
812 }
813 
814 
816 {
817  m_board = aBoard;
818  wxLogTrace( "PNS", "m_board = %p", m_board );
819 }
820 
821 
823 {
824  if( !m_board )
825  {
826  wxLogTrace( "PNS", "No board attached, aborting sync." );
827  return;
828  }
829 
830  for( MODULE* module = m_board->m_Modules; module; module = module->Next() )
831  {
832  for( D_PAD* pad = module->PadsList(); pad; pad = pad->Next() )
833  {
834  std::unique_ptr< PNS::SOLID > solid = syncPad( pad );
835 
836  if( solid )
837  aWorld->Add( std::move( solid ) );
838  }
839  }
840 
841  for( TRACK* t = m_board->m_Track; t; t = t->Next() )
842  {
843  KICAD_T type = t->Type();
844 
845  if( type == PCB_TRACE_T ) {
846  std::unique_ptr< PNS::SEGMENT > segment = syncTrack( t );
847  if( segment ) {
848  aWorld->Add( std::move( segment ) );
849  }
850  } else if( type == PCB_VIA_T ) {
851  std::unique_ptr< PNS::VIA > via = syncVia( static_cast<VIA*>( t ) );
852  if( via ) {
853  aWorld->Add( std::move( via ) );
854  }
855  }
856  }
857 
858  int worstClearance = m_board->GetDesignSettings().GetBiggestClearanceValue();
859 
860  delete m_ruleResolver;
862 
863  aWorld->SetRuleResolver( m_ruleResolver );
864  aWorld->SetMaxClearance( 4 * worstClearance );
865 }
866 
867 
869 {
870  for( auto item : m_hiddenItems )
871  m_view->SetVisible( item, true );
872 
873  m_hiddenItems.clear();
874 
875  if( m_previewItems )
876  {
879  }
880 
881  if( m_debugDecorator )
883 }
884 
885 
886 void PNS_KICAD_IFACE::DisplayItem( const PNS::ITEM* aItem, int aColor, int aClearance )
887 {
888  wxLogTrace( "PNS", "DisplayItem %p", aItem );
889 
890  ROUTER_PREVIEW_ITEM* pitem = new ROUTER_PREVIEW_ITEM( aItem, m_view );
891 
892  if( aColor >= 0 )
893  pitem->SetColor( KIGFX::COLOR4D( aColor ) );
894 
895  if( aClearance >= 0 )
896  {
897  pitem->SetClearance( aClearance );
898 
899  if( m_dispOptions )
900  {
901  auto clearanceDisp = m_dispOptions->m_ShowTrackClearanceMode;
905  }
906  }
907 
908 
909  m_previewItems->Add( pitem );
911 }
912 
913 
915 {
916  BOARD_CONNECTED_ITEM* parent = aItem->Parent();
917 
918  if( parent )
919  {
920  if( m_view->IsVisible( parent ) )
921  m_hiddenItems.insert( parent );
922 
923  m_view->SetVisible( parent, false );
924  m_view->Update( parent, KIGFX::APPEARANCE );
925  }
926 }
927 
928 
930 {
931  BOARD_CONNECTED_ITEM* parent = aItem->Parent();
932 
933  if( parent )
934  {
935  m_commit->Remove( parent );
936  }
937 }
938 
939 
941 {
942  BOARD_CONNECTED_ITEM* newBI = NULL;
943 
944  switch( aItem->Kind() )
945  {
947  {
948  PNS::SEGMENT* seg = static_cast<PNS::SEGMENT*>( aItem );
949  TRACK* track = new TRACK( m_board );
950  const SEG& s = seg->Seg();
951  track->SetStart( wxPoint( s.A.x, s.A.y ) );
952  track->SetEnd( wxPoint( s.B.x, s.B.y ) );
953  track->SetWidth( seg->Width() );
954  track->SetLayer( ToLAYER_ID( seg->Layers().Start() ) );
955  track->SetNetCode( seg->Net() > 0 ? seg->Net() : 0 );
956  newBI = track;
957  break;
958  }
959 
960  case PNS::ITEM::VIA_T:
961  {
962  VIA* via_board = new VIA( m_board );
963  PNS::VIA* via = static_cast<PNS::VIA*>( aItem );
964  via_board->SetPosition( wxPoint( via->Pos().x, via->Pos().y ) );
965  via_board->SetWidth( via->Diameter() );
966  via_board->SetDrill( via->Drill() );
967  via_board->SetNetCode( via->Net() > 0 ? via->Net() : 0 );
968  via_board->SetViaType( via->ViaType() ); // MUST be before SetLayerPair()
969  via_board->SetLayerPair( ToLAYER_ID( via->Layers().Start() ),
970  ToLAYER_ID( via->Layers().End() ) );
971  newBI = via_board;
972  break;
973  }
974 
975  default:
976  break;
977  }
978 
979  if( newBI )
980  {
981  aItem->SetParent( newBI );
982  newBI->ClearFlags();
983 
984  m_commit->Add( newBI );
985  }
986 }
987 
988 
990 {
991  EraseView();
992  m_commit->Push( wxT( "Added a track" ) );
993  m_commit.reset( new BOARD_COMMIT( m_tool ) );
994 }
995 
996 
998 {
999  wxLogTrace( "PNS", "SetView %p", aView );
1000 
1001  if( m_previewItems )
1002  {
1004  delete m_previewItems;
1005  }
1006 
1007  m_view = aView;
1011 
1012  delete m_debugDecorator;
1015 }
1016 
1017 
1018 void PNS_KICAD_IFACE::UpdateNet( int aNetCode )
1019 {
1020  wxLogTrace( "PNS", "Update-net %d", aNetCode );
1021 }
1022 
1023 
1025 {
1026  return m_ruleResolver;
1027 }
1028 
1029 
1031 {
1032  m_router = aRouter;
1033 }
1034 
1035 
1037 {
1038  m_tool = aTool;
1039  m_commit.reset( new BOARD_COMMIT( m_tool ) );
1040 }
1041 
1043 {
1044  m_dispOptions = aDispOptions;
1045 }
bool IsLocked() const override
Function IsLocked.
Definition: class_track.h:138
const VECTOR2I ToVector() const
Function ToVector()
Definition: direction45.h:295
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:646
const Vec & GetOrigin() const
Definition: box2.h:181
Class ITEM.
Definition: pns_item.h:53
KICAD_T Type() const
Function Type()
Definition: base_struct.h:225
int matchDpSuffix(wxString aNetName, wxString &aComplementNet, wxString &aBaseDpName)
Class BOARD_CONNECTED_ITEM.
void SetView(KIGFX::VIEW *aView)
virtual bool DpNetPair(PNS::ITEM *aItem, int &aNetP, int &aNetN) override
NETCLASSPTR Find(const wxString &aName) const
Function Find searches this container for a NETCLASS given by aName.
PNS_PCBNEW_DEBUG_DECORATOR * m_debugDecorator
Class NODE.
Definition: pns_node.h:137
PAD_ATTR_T GetAttribute() const
Definition: class_pad.h:398
void SetViaType(VIATYPE_T aViaType)
Definition: class_track.h:444
const LAYER_RANGE & Layers() const
Function Layers()
Definition: pns_item.h:207
like PAD_STANDARD, but not plated mechanical use only, no connection allowed
Definition: pad_shapes.h:65
void SetPosition(const wxPoint &aPoint) override
Definition: class_track.h:416
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
void SetEnd(const wxPoint &aEnd)
Definition: class_track.h:119
PNS::NODE * m_world
const SHAPE_POLY_SET & GetCustomShapeAsPolygon() const
Accessor to the custom shape as one polygon.
Definition: class_pad.h:341
int GetBiggestClearanceValue()
Function GetBiggestClearanceValue.
void BuildPadPolygon(wxPoint aCoord[4], wxSize aInflateValue, double aRotation) const
Function BuildPadPolygon Has meaning only for polygonal pads (trapezoid and rectangular) Build the Co...
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
int PointCount() const
Function PointCount()
void AddPoint(VECTOR2I aP, int aColor) override
int Drill() const
Definition: pns_via.h:120
Class BOARD to handle a board.
int Diameter() const
Definition: pns_via.h:109
std::unordered_set< BOARD_CONNECTED_ITEM * > m_hiddenItems
std::unique_ptr< PNS::SOLID > syncPad(D_PAD *aPad)
wxString GetClassName() const
Function GetClassName returns the class name.
void UpdateNet(int aNetCode) override
void AddBox(BOX2I aB, int aColor) override
MODULE * Next() const
Definition: class_module.h:120
void SetRouter(PNS::ROUTER *aRouter) override
Smd pad, appears on the solder paste layer (default)
Definition: pad_shapes.h:61
int localPadClearance(const PNS::ITEM *aItem) const
#define PNS_HULL_MARGIN
Class LINE.
Definition: pns_line.h:58
void SetClearance(int aClearance)
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
Class SHAPE_CONVEX.
Definition: shape_convex.h:42
No updates are required.
Definition: view_item.h:55
Class RULE_RESOLVER.
Definition: pns_node.h:56
PNS_PCBNEW_DEBUG_DECORATOR(KIGFX::VIEW *aView=NULL)
void Line(const SHAPE_LINE_CHAIN &aLine, int aWidth=0, int aStyle=0)
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
void ShowTrackClearance(bool aEnabled)
int OutlineCount() const
Returns the number of outlines in the set
std::unique_ptr< PNS::SEGMENT > syncTrack(TRACK *aTrack)
const VECTOR2I & Pos() const
Definition: pns_via.h:88
void SetRuleResolver(RULE_RESOLVER *aFunc)
Assigns a clerance resolution function object
Definition: pns_node.h:163
SIZES_SETTINGS & Sizes()
Definition: pns_router.h:206
const Vec & GetSize() const
Definition: box2.h:177
void HideItem(PNS::ITEM *aItem) override
VECTOR2< int > VECTOR2I
Definition: vector2d.h:589
PAD_SHAPE_T GetShape() const
Function GetShape.
Definition: class_pad.h:216
PNS::DEBUG_DECORATOR * GetDebugDecorator() override
Class BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected an...
PCB_DISPLAY_OPTIONS * m_dispOptions
static const int delta[8][2]
Definition: solve.cpp:112
const wxPoint & GetEnd() const
Definition: class_track.h:120
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
NODE * GetWorld() const
Definition: pns_router.h:143
Functions relatives to tracks, vias and segments used to fill zones.
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
void Append(int aX, int aY, bool aAllowDuplication=false)
Function Append()
KIGFX::VIEW_GROUP * m_items
TRACE_CLEARANCE_DISPLAY_MODE_T m_ShowTrackClearanceMode
How trace clearances are displayed.
void SetWidth(int aWidth)
Definition: class_track.h:116
virtual int DpNetPolarity(int aNet) override
void SetMaxClearance(int aClearance)
Sets the worst-case clerance between any pair of items
Definition: pns_node.h:157
bool OfKind(int aKindMask) const
Function OfKind()
Definition: pns_item.h:130
VIATYPE_T ViaType() const
Definition: pns_via.h:99
int End() const
Definition: pns_layerset.h:88
void SetParent(BOARD_CONNECTED_ITEM *aParent)
Function SetParent()
Definition: pns_item.h:147
Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings...
PCB_LAYER_ID
A quick note on layer IDs:
void FreeItems()
Function FreeItems() Frees all the items that were added to the group.
Definition: view_group.cpp:141
void Append(int aX, int aY)
Function Append()
Definition: shape_convex.h:151
Class LSET is a set of PCB_LAYER_IDs.
VIEW_ITEM class definition.
void CustomShapeAsPolygonToBoardPosition(SHAPE_POLY_SET *aMergedPolygon, wxPoint aPosition, double aRotation) const
When created, the corners coordinates are relative to the pad position, orientation 0...
VIATYPE_T GetViaType() const
Definition: class_track.h:443
Class SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
std::unique_ptr< BOARD_COMMIT > m_commit
Class DIRECTION_45.
Definition: direction45.h:33
const wxPoint & GetStart() const
Definition: class_track.h:123
virtual int DpCoupledNet(int aNet) override
LSET GetLayerSet() const override
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
Definition: class_pad.h:395
D_PAD * Next() const
Definition: class_pad.h:160
void ShowViaClearance(bool aEnabled)
std::vector< CLEARANCE_ENT > m_netClearanceCache
const wxSize & GetSize() const
Definition: class_pad.h:269
PNS_PCBNEW_RULE_RESOLVER * m_ruleResolver
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:532
bool SetNetCode(int aNetCode, bool aNoAssert=false)
Function SetNetCode sets net using a net code.
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
VIEW_GROUP extends VIEW_ITEM by possibility of grouping items into a single object.
general purpose overlay
KIGFX::VIEW_GROUP * m_previewItems
void SetLayerPair(PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)
Function SetLayerPair For a via m_Layer contains the top layer, the other layer is in m_BottomLayer...
int Width() const
Definition: pns_segment.h:88
int Start() const
Definition: pns_layerset.h:83
int GetNet() const
Function GetNet.
virtual void Add(VIEW_ITEM *aItem)
Function Add() Adds an item to the group.
Definition: view_group.cpp:55
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1385
Like smd, does not appear on the solder paste layer (default) note also has a special attribute in Ge...
Definition: pad_shapes.h:62
void SetColor(const KIGFX::COLOR4D &aColor)
PNS::ROUTER * m_router
virtual void SetLayer(int aLayer)
Function SetLayer() Sets layer used to draw the group.
Definition: view_group.h:115
void DisplayItem(const PNS::ITEM *aItem, int aColor=0, int aClearance=0) override
void Commit() override
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
PNS::RULE_RESOLVER * GetRuleResolver() override
PnsKind Kind() const
Function Kind()
Definition: pns_item.h:120
void EraseView() override
int GetNetCode() const
Function GetNetCode.
Definition: seg.h:36
KIGFX::VIEW * m_view
Class NETINFO_ITEM handles the data for a net.
Definition: class_netinfo.h:69
int BuildSegmentFromOvalShape(wxPoint &aSegStart, wxPoint &aSegEnd, double aRotation, const wxSize &aMargin) const
Function BuildSegmentFromOvalShape Has meaning only for OVAL (and ROUND) pads Build an equivalent seg...
void SyncWorld(PNS::NODE *aWorld) override
TRACK * Next() const
Definition: class_track.h:100
Board layer functions and definitions.
int GetDrillValue() const
Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value ...
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
#define max(a, b)
Definition: auxiliary.h:86
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
DLIST< MODULE > m_Modules
Definition: class_board.h:245
Class SHAPE_LINE_CHAIN.
void RemoveItem(PNS::ITEM *aItem) override
int GetWidth() const
Definition: class_track.h:117
std::unique_ptr< PNS::VIA > syncVia(VIA *aVia)
double GetOrientation() const
Function GetOrientation returns the rotation angle of the pad in tenths of degrees, but soon degrees.
Definition: class_pad.h:375
VECTOR2I A
Definition: seg.h:46
void AddItem(PNS::ITEM *aItem) override
void SetDrill(int aDrill)
Function SetDrill sets the drill value for vias.
Definition: class_track.h:451
void SetView(KIGFX::VIEW *aView)
Usual pad.
Definition: pad_shapes.h:60
NETINFO_ITEM * FindNet(int aNetcode) const
Function FindNet searches for a net with the given netcode.
int Net() const
Function Net()
Definition: pns_item.h:177
virtual void OverrideClearance(bool aEnable, int aNetA=0, int aNetB=0, int aClearance=0) override
void SetHostTool(PCB_TOOL *aTool)
void BuildPadShapePolygon(SHAPE_POLY_SET &aCornerBuffer, wxSize aInflateValue, int aSegmentsPerCircle, double aCorrectionFactor) const
Function BuildPadShapePolygon Build the Corner list of the polygonal shape, depending on shape...
const wxPoint & GetPosition() const override
Definition: class_track.h:415
wxPoint ShapePos() const
Definition: class_pad.cpp:500
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:281
void SetVisible(VIEW_ITEM *aItem, bool aIsVisible=true)
Sets the item visibility.
Definition: view.cpp:1331
void Clear()
Function Clear() Removes all points from the line chain.
void SetStart(const wxPoint &aStart)
Definition: class_track.h:122
const SEG & Seg() const
Definition: pns_segment.h:93
VECTOR2I & Point(int aIndex)
Function Point()
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:312
void AddLine(const SHAPE_LINE_CHAIN &aLine, int aType, int aWidth) override
DLIST< TRACK > m_Track
Definition: class_board.h:246
Module description (excepted pads)
const wxString & GetNetname() const
Function GetNetname.
void AddDirections(VECTOR2D aP, int aMask, int aColor) override
virtual int Clearance(const PNS::ITEM *aA, const PNS::ITEM *aB) const override
Class VIEW.
Definition: view.h:58
bool IsVisible(const VIEW_ITEM *aItem) const
Returns information if the item is visible (or not).
Definition: view.cpp:1371
virtual void UseDpGap(bool aUseDpGap) override
Directions
Enum Directions Represents available directions - there are 8 of them, as on a rectilinear map (north...
Definition: direction45.h:42
void SetDisplayOptions(PCB_DISPLAY_OPTIONS *aDispOptions)
void AddSegment(SEG aS, int aColor) override
Push and Shove diff pair dimensions (gap) settings dialog.
const VECTOR2I & CPoint(int aIndex) const
Function CPoint()
void SetBoard(BOARD *aBoard)
void Add(std::unique_ptr< SEGMENT > aSegment, bool aAllowRedundant=false)
Function Add()
Definition: pns_node.cpp:594
std::unordered_map< const D_PAD *, int > m_localClearanceCache
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:774
#define mod(a, n)
Definition: greymap.cpp:24
PNS_PCBNEW_RULE_RESOLVER(BOARD *aBoard, PNS::ROUTER *aRouter)
const wxPoint & GetOffset() const
Definition: class_pad.h:278
BOARD_CONNECTED_ITEM * Parent() const
Function Parent()
Definition: pns_item.h:157
PCB_TOOL * m_tool
NETINFO_ITEM * GetNet() const
Function GetNet Returns NET_INFO object for a given item.
Class LAYER_RANGE.
Definition: pns_layerset.h:32
NETCLASSES m_NetClasses
List of current netclasses. There is always the default netclass.
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:772
#define min(a, b)
Definition: auxiliary.h:85
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline) ...
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
VECTOR2I B
Definition: seg.h:47