KiCad PCB EDA Suite
class_module.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 2015 Wayne Stambaugh <stambaughw@gmail.com>
7  * Copyright (C) 1992-2019 KiCad Developers, see AUTHORS.txt for contributors.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
32 #include <fctsys.h>
33 #include <gr_basic.h>
34 #include <plotter.h>
35 #include <class_drawpanel.h>
36 #include <trigo.h>
37 #include <confirm.h>
38 #include <kicad_string.h>
39 #include <pcbnew.h>
40 #include <refdes_utils.h>
41 #include <richio.h>
42 #include <filter_reader.h>
43 #include <macros.h>
44 #include <msgpanel.h>
45 #include <bitmaps.h>
46 #include <unordered_set>
47 
48 #include <pcb_edit_frame.h>
49 #include <class_board.h>
50 #include <class_edge_mod.h>
51 #include <class_module.h>
53 
54 #include <view/view.h>
55 
56 MODULE::MODULE( BOARD* parent ) :
58  m_initial_comments( 0 )
59 {
61  m_Layer = F_Cu;
62  m_Orient = 0;
64  m_arflag = 0;
65  m_CntRot90 = m_CntRot180 = 0;
66  m_Link = 0;
67  m_LastEditTime = 0;
68  m_LocalClearance = 0;
72  m_ZoneConnection = PAD_ZONE_CONN_INHERITED; // Use zone setting by default
73  m_ThermalWidth = 0; // Use zone setting by default
74  m_ThermalGap = 0; // Use zone setting by default
75 
76  // These are special and mandatory text fields
79 
80  m_3D_Drawings.clear();
81 }
82 
83 
84 MODULE::MODULE( const MODULE& aModule ) :
85  BOARD_ITEM_CONTAINER( aModule )
86 {
87  m_Pos = aModule.m_Pos;
88  m_fpid = aModule.m_fpid;
89  m_Attributs = aModule.m_Attributs;
91  m_Orient = aModule.m_Orient;
92  m_BoundaryBox = aModule.m_BoundaryBox;
93  m_CntRot90 = aModule.m_CntRot90;
94  m_CntRot180 = aModule.m_CntRot180;
96  m_Link = aModule.m_Link;
97  m_Path = aModule.m_Path; // is this correct behavior?
98 
104  m_ThermalWidth = aModule.m_ThermalWidth;
105  m_ThermalGap = aModule.m_ThermalGap;
106 
107  // Copy reference and value.
108  m_Reference = new TEXTE_MODULE( *aModule.m_Reference );
109  m_Reference->SetParent( this );
110  m_Value = new TEXTE_MODULE( *aModule.m_Value );
111  m_Value->SetParent( this );
112 
113  // Copy auxiliary data: Pads
114  for( D_PAD* pad = aModule.m_Pads; pad; pad = pad->Next() )
115  {
116  Add( new D_PAD( *pad ) );
117  }
118 
119  // Copy auxiliary data: Drawings
120  for( BOARD_ITEM* item = aModule.m_Drawings; item; item = item->Next() )
121  {
122  switch( item->Type() )
123  {
124  case PCB_MODULE_TEXT_T:
125  case PCB_MODULE_EDGE_T:
126  Add( static_cast<BOARD_ITEM*>( item->Clone() ) );
127  break;
128 
129  default:
130  wxLogMessage( wxT( "Class MODULE copy constructor internal error: unknown type" ) );
131  break;
132  }
133  }
134 
135  // Copy auxiliary data: 3D_Drawings info
136  m_3D_Drawings = aModule.m_3D_Drawings;
137 
138  m_Doc = aModule.m_Doc;
139  m_KeyWord = aModule.m_KeyWord;
140 
141  m_arflag = 0;
142 
143  // Ensure auxiliary data is up to date
145 
147  new wxArrayString( *aModule.m_initial_comments ) : 0;
148 }
149 
150 
152 {
153  delete m_Reference;
154  delete m_Value;
155  delete m_initial_comments;
156 }
157 
158 
159 MODULE& MODULE::operator=( const MODULE& aOther )
160 {
161  BOARD_ITEM::operator=( aOther );
162 
163  m_Pos = aOther.m_Pos;
164  m_fpid = aOther.m_fpid;
165  m_Attributs = aOther.m_Attributs;
167  m_Orient = aOther.m_Orient;
168  m_BoundaryBox = aOther.m_BoundaryBox;
169  m_CntRot90 = aOther.m_CntRot90;
170  m_CntRot180 = aOther.m_CntRot180;
172  m_Link = aOther.m_Link;
173  m_Path = aOther.m_Path; //is this correct behavior?
174 
181  m_ThermalGap = aOther.m_ThermalGap;
182 
183  // Copy reference and value
184  *m_Reference = *aOther.m_Reference;
185  m_Reference->SetParent( this );
186  *m_Value = *aOther.m_Value;
187  m_Value->SetParent( this );
188 
189  // Copy auxiliary data: Pads
190  m_Pads.DeleteAll();
191 
192  for( D_PAD* pad = aOther.m_Pads; pad; pad = pad->Next() )
193  {
194  Add( new D_PAD( *pad ) );
195  }
196 
197  // Copy auxiliary data: Drawings
199 
200  for( BOARD_ITEM* item = aOther.m_Drawings; item; item = item->Next() )
201  {
202  switch( item->Type() )
203  {
204  case PCB_MODULE_TEXT_T:
205  case PCB_MODULE_EDGE_T:
206  Add( static_cast<BOARD_ITEM*>( item->Clone() ) );
207  break;
208 
209  default:
210  wxLogMessage( wxT( "MODULE::operator=() internal error: unknown type" ) );
211  break;
212  }
213  }
214 
215  // Copy auxiliary data: 3D_Drawings info
216  m_3D_Drawings.clear();
217  m_3D_Drawings = aOther.m_3D_Drawings;
218  m_Doc = aOther.m_Doc;
219  m_KeyWord = aOther.m_KeyWord;
220 
221  // Ensure auxiliary data is up to date
223 
224  return *this;
225 }
226 
227 
229 {
230  // Force the ORPHANED dummy net info for all pads.
231  // ORPHANED dummy net does not depend on a board
232  for( D_PAD* pad = PadsList(); pad; pad = pad->Next() )
233  pad->SetNetCode( NETINFO_LIST::ORPHANED );
234 }
235 
236 
237 void MODULE::DrawAncre( EDA_DRAW_PANEL* panel, wxDC* DC, const wxPoint& offset,
238  int dim_ancre, GR_DRAWMODE draw_mode )
239 {
240  auto frame = (PCB_EDIT_FRAME*) panel->GetParent();
241 
242  GRSetDrawMode( DC, draw_mode );
243 
244  if( GetBoard()->IsElementVisible( LAYER_ANCHOR ) )
245  {
246  GRDrawAnchor( panel->GetClipBox(), DC, m_Pos.x, m_Pos.y,
247  dim_ancre,
248  frame->Settings().Colors().GetItemColor( LAYER_ANCHOR ) );
249  }
250 }
251 
252 
253 void MODULE::Add( BOARD_ITEM* aBoardItem, ADD_MODE aMode )
254 {
255  switch( aBoardItem->Type() )
256  {
257  case PCB_MODULE_TEXT_T:
258  // Only user texts can be added this way. Reference and value are not hold in the DLIST.
259  assert( static_cast<TEXTE_MODULE*>( aBoardItem )->GetType() == TEXTE_MODULE::TEXT_is_DIVERS );
260 
261  // no break
262 
263  case PCB_MODULE_EDGE_T:
264  if( aMode == ADD_APPEND )
265  m_Drawings.PushBack( aBoardItem );
266  else
267  m_Drawings.PushFront( aBoardItem );
268  break;
269 
270  case PCB_PAD_T:
271  if( aMode == ADD_APPEND )
272  m_Pads.PushBack( static_cast<D_PAD*>( aBoardItem ) );
273  else
274  m_Pads.PushFront( static_cast<D_PAD*>( aBoardItem ) );
275  break;
276 
277  default:
278  {
279  wxString msg;
280  msg.Printf( wxT( "MODULE::Add() needs work: BOARD_ITEM type (%d) not handled" ),
281  aBoardItem->Type() );
282  wxFAIL_MSG( msg );
283 
284  return;
285  }
286  }
287 
288  aBoardItem->SetParent( this );
289 }
290 
291 
292 void MODULE::Remove( BOARD_ITEM* aBoardItem )
293 {
294  switch( aBoardItem->Type() )
295  {
296  case PCB_MODULE_TEXT_T:
297  // Only user texts can be removed this way. Reference and value are not hold in the DLIST.
298  assert( static_cast<TEXTE_MODULE*>( aBoardItem )->GetType() == TEXTE_MODULE::TEXT_is_DIVERS );
299 
300  // no break
301 
302  case PCB_MODULE_EDGE_T:
303  m_Drawings.Remove( aBoardItem );
304  break;
305 
306  case PCB_PAD_T:
307  m_Pads.Remove( static_cast<D_PAD*>( aBoardItem ) );
308  break;
309 
310  default:
311  {
312  wxString msg;
313  msg.Printf( wxT( "MODULE::Remove() needs work: BOARD_ITEM type (%d) not handled" ),
314  aBoardItem->Type() );
315  wxFAIL_MSG( msg );
316  }
317  }
318 }
319 
320 
321 void MODULE::CopyNetlistSettings( MODULE* aModule, bool aCopyLocalSettings )
322 {
323  // Don't do anything foolish like trying to copy to yourself.
324  wxCHECK_RET( aModule != NULL && aModule != this, wxT( "Cannot copy to NULL or yourself." ) );
325 
326  // Not sure what to do with the value field. Use netlist for now.
327  aModule->SetPosition( GetPosition() );
328 
329  if( aModule->GetLayer() != GetLayer() )
330  aModule->Flip( aModule->GetPosition() );
331 
332  if( aModule->GetOrientation() != GetOrientation() )
333  aModule->Rotate( aModule->GetPosition(), GetOrientation() );
334 
335  aModule->SetLocked( IsLocked() );
336 
337  if( aCopyLocalSettings )
338  {
340  aModule->SetLocalClearance( GetLocalClearance() );
343  aModule->SetZoneConnection( GetZoneConnection() );
344  aModule->SetThermalWidth( GetThermalWidth() );
345  aModule->SetThermalGap( GetThermalGap() );
346  }
347 
348  for( D_PAD* pad = aModule->PadsList(); pad; pad = pad->Next() )
349  {
350  // Fix me: if aCopyLocalSettings == true, for "multiple" pads
351  // (set of pads having the same name/number) this is broken
352  // because we copy settings from the first pad found.
353  // When old and new footprints have very few differences, a better
354  // algo can be used.
355  D_PAD* oldPad = FindPadByName( pad->GetName() );
356 
357  if( oldPad )
358  oldPad->CopyNetlistSettings( pad, aCopyLocalSettings );
359  }
360 
361  // Not sure about copying description, keywords, 3D models or any other
362  // local user changes to footprint. Stick with the new footprint settings
363  // called out in the footprint loaded in the netlist.
364  aModule->CalculateBoundingBox();
365 }
366 
367 
368 void MODULE::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, GR_DRAWMODE aDrawMode,
369  const wxPoint& aOffset )
370 {
371  if( (m_Flags & DO_NOT_DRAW) || (IsMoving()) )
372  return;
373 
374  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
375  {
376  if( pad->IsMoving() )
377  continue;
378 
379  pad->Draw( aPanel, aDC, aDrawMode, aOffset );
380  }
381 
382  BOARD* brd = GetBoard();
383 
384  // Draws footprint anchor
385  DrawAncre( aPanel, aDC, aOffset, DIM_ANCRE_MODULE, aDrawMode );
386 
387  // Draw graphic items
389  {
390  if( !(m_Reference->IsMoving()) )
391  m_Reference->Draw( aPanel, aDC, aDrawMode, aOffset );
392  }
393 
394  if( brd->IsElementVisible( LAYER_MOD_VALUES ) )
395  {
396  if( !(m_Value->IsMoving()) )
397  m_Value->Draw( aPanel, aDC, aDrawMode, aOffset );
398  }
399 
400  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
401  {
402  if( item->IsMoving() )
403  continue;
404 
405  switch( item->Type() )
406  {
407  case PCB_MODULE_TEXT_T:
408  case PCB_MODULE_EDGE_T:
409  item->Draw( aPanel, aDC, aDrawMode, aOffset );
410  break;
411 
412  default:
413  break;
414  }
415  }
416 
417  // Enable these line to draw m_BoundaryBox (debug tests purposes only)
418 #if 0
419  GRRect( aPanel->GetClipBox(), aDC, m_BoundaryBox, 0, BROWN );
420 #endif
421 
422 }
423 
424 
425 void MODULE::DrawEdgesOnly( EDA_DRAW_PANEL* panel, wxDC* DC, const wxPoint& offset,
426  GR_DRAWMODE draw_mode )
427 {
428  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
429  {
430  switch( item->Type() )
431  {
432  case PCB_MODULE_EDGE_T:
433  item->Draw( panel, DC, draw_mode, offset );
434  break;
435 
436  default:
437  break;
438  }
439  }
440 }
441 
442 
444 {
446 }
447 
448 
449 double MODULE::GetArea( int aPadding ) const
450 {
451  double w = std::abs( m_BoundaryBox.GetWidth() ) + aPadding;
452  double h = std::abs( m_BoundaryBox.GetHeight() ) + aPadding;
453  return w * h;
454 }
455 
456 
458 {
459  EDA_RECT area;
460 
461  area.SetOrigin( m_Pos );
462  area.SetEnd( m_Pos );
463  area.Inflate( Millimeter2iu( 0.25 ) ); // Give a min size to the area
464 
465  for( const BOARD_ITEM* item = m_Drawings.GetFirst(); item; item = item->Next() )
466  {
467  if( item->Type() == PCB_MODULE_EDGE_T )
468  area.Merge( item->GetBoundingBox() );
469  }
470 
471  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
472  area.Merge( pad->GetBoundingBox() );
473 
474  return area;
475 }
476 
477 
479 {
480  EDA_RECT area = GetFootprintRect();
481 
482  // Add in items not collected by GetFootprintRect():
483  for( const BOARD_ITEM* item = m_Drawings.GetFirst(); item; item = item->Next() )
484  {
485  if( item->Type() != PCB_MODULE_EDGE_T )
486  area.Merge( item->GetBoundingBox() );
487  }
488 
489  area.Merge( m_Value->GetBoundingBox() );
490  area.Merge( m_Reference->GetBoundingBox() );
491 
492  return area;
493 }
494 
495 
511 {
512  SHAPE_POLY_SET poly;
513 
514  double orientation = GetOrientationRadians();
515 
516  MODULE temp = *this;
517  temp.SetOrientation( 0.0 );
518  BOX2I area = temp.GetFootprintRect();
519 
520  poly.NewOutline();
521 
522  VECTOR2I p = area.GetPosition();
523  poly.Append( p );
524  p.x = area.GetRight();
525  poly.Append( p );
526  p.y = area.GetBottom();
527  poly.Append( p );
528  p.x = area.GetX();
529  poly.Append( p );
530 
531  BOARD* board = GetBoard();
532  if( board )
533  {
534  int biggest_clearance = board->GetDesignSettings().GetBiggestClearanceValue();
535  poly.Inflate( biggest_clearance, 4 );
536  }
537 
538  poly.Inflate( Millimeter2iu( 0.01 ), 4 );
539  poly.Rotate( -orientation, m_Pos );
540 
541  return poly;
542 }
543 
544 
545 void MODULE::GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList )
546 {
547  int nbpad;
548  wxString msg;
549 
550  aList.push_back( MSG_PANEL_ITEM( m_Reference->GetShownText(), m_Value->GetShownText(), DARKCYAN ) );
551 
552  // Display last date the component was edited (useful in Module Editor).
553  wxDateTime date( static_cast<time_t>( m_LastEditTime ) );
554 
555  if( m_LastEditTime && date.IsValid() )
556  // Date format: see http://www.cplusplus.com/reference/ctime/strftime
557  msg = date.Format( wxT( "%b %d, %Y" ) ); // Abbreviated_month_name Day, Year
558  else
559  msg = _( "Unknown" );
560 
561  aList.push_back( MSG_PANEL_ITEM( _( "Last Change" ), msg, BROWN ) );
562 
563  // display schematic path
564  aList.push_back( MSG_PANEL_ITEM( _( "Netlist Path" ), m_Path, BROWN ) );
565 
566  // display the board side placement
567  aList.push_back( MSG_PANEL_ITEM( _( "Board Side" ),
568  IsFlipped()? _( "Back (Flipped)" ) : _( "Front" ), RED ) );
569 
570  EDA_ITEM* PtStruct = m_Pads;
571  nbpad = 0;
572 
573  while( PtStruct )
574  {
575  nbpad++;
576  PtStruct = PtStruct->Next();
577  }
578 
579  msg.Printf( wxT( "%d" ), nbpad );
580  aList.push_back( MSG_PANEL_ITEM( _( "Pads" ), msg, BLUE ) );
581 
582  msg = wxT( ".." );
583 
584  if( IsLocked() )
585  msg[0] = 'L';
586 
588  msg[1] = 'P';
589 
590  aList.push_back( MSG_PANEL_ITEM( _( "Status" ), msg, MAGENTA ) );
591 
592  msg.Printf( wxT( "%.1f" ), GetOrientationDegrees() );
593  aList.push_back( MSG_PANEL_ITEM( _( "Rotation" ), msg, BROWN ) );
594 
595  // Controls on right side of the dialog
596  switch( m_Attributs & 255 )
597  {
598  case 0:
599  msg = _( "Normal" );
600  break;
601 
602  case MOD_CMS:
603  msg = _( "Insert" );
604  break;
605 
606  case MOD_VIRTUAL:
607  msg = _( "Virtual" );
608  break;
609 
610  default:
611  msg = wxT( "???" );
612  break;
613  }
614 
615  aList.push_back( MSG_PANEL_ITEM( _( "Attributes" ), msg, BROWN ) );
616  aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), FROM_UTF8( m_fpid.Format().c_str() ), BLUE ) );
617 
618  if( m_3D_Drawings.empty() )
619  msg = _( "No 3D shape" );
620  else
621  msg = m_3D_Drawings.front().m_Filename;
622 
623  // Search the first active 3D shape in list
624 
625  aList.push_back( MSG_PANEL_ITEM( _( "3D-Shape" ), msg, RED ) );
626 
627  wxString doc, keyword;
628  doc.Printf( _( "Doc: %s" ), GetChars( m_Doc ) );
629  keyword.Printf( _( "Key Words: %s" ), GetChars( m_KeyWord ) );
630  aList.push_back( MSG_PANEL_ITEM( doc, keyword, BLACK ) );
631 }
632 
633 
634 bool MODULE::HitTest( const wxPoint& aPosition ) const
635 {
636  return m_BoundaryBox.Contains( aPosition );
637 }
638 
639 
640 bool MODULE::HitTestAccurate( const wxPoint& aPosition ) const
641 {
642  auto shape = GetBoundingPoly();
643  return shape.Contains( aPosition, -1, true );
644 }
645 
646 
647 bool MODULE::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const
648 {
649  EDA_RECT arect = aRect;
650  arect.Inflate( aAccuracy );
651 
652  if( aContained )
653  return arect.Contains( m_BoundaryBox );
654  else
655  {
656  // If the rect does not intersect the bounding box, skip any tests
657  if( !aRect.Intersects( GetBoundingBox() ) )
658  return false;
659 
660  // Determine if any elements in the MODULE intersect the rect
661  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
662  {
663  if( pad->HitTest( arect, false, 0 ) )
664  return true;
665  }
666 
667  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
668  {
669  if( item->HitTest( arect, false, 0 ) )
670  return true;
671  }
672 
673  // No items were hit
674  return false;
675  }
676 }
677 
678 
679 D_PAD* MODULE::FindPadByName( const wxString& aPadName ) const
680 {
681  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
682  {
683  if( pad->GetName().CmpNoCase( aPadName ) == 0 ) // why case insensitive?
684  return pad;
685  }
686 
687  return NULL;
688 }
689 
690 
691 D_PAD* MODULE::GetPad( const wxPoint& aPosition, LSET aLayerMask )
692 {
693  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
694  {
695  // ... and on the correct layer.
696  if( !( pad->GetLayerSet() & aLayerMask ).any() )
697  continue;
698 
699  if( pad->HitTest( aPosition ) )
700  return pad;
701  }
702 
703  return NULL;
704 }
705 
706 
708 {
709  D_PAD* topLeftPad = m_Pads;
710 
711  for( D_PAD* p = m_Pads->Next(); p; p = p->Next() )
712  {
713  wxPoint pnt = p->GetPosition(); // GetPosition() returns the center of the pad
714 
715  if( ( pnt.x < topLeftPad->GetPosition().x ) ||
716  ( ( topLeftPad->GetPosition().x == pnt.x ) &&
717  ( pnt.y < topLeftPad->GetPosition().y ) ) )
718  {
719  topLeftPad = p;
720  }
721  }
722 
723  return topLeftPad;
724 }
725 
726 
727 unsigned MODULE::GetPadCount( INCLUDE_NPTH_T aIncludeNPTH ) const
728 {
729  if( aIncludeNPTH )
730  return m_Pads.GetCount();
731 
732  unsigned cnt = 0;
733 
734  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
735  {
736  if( pad->GetAttribute() == PAD_ATTRIB_HOLE_NOT_PLATED )
737  continue;
738 
739  cnt++;
740  }
741 
742  return cnt;
743 }
744 
745 
746 unsigned MODULE::GetUniquePadCount( INCLUDE_NPTH_T aIncludeNPTH ) const
747 {
748  std::set<wxString> usedNames;
749 
750  // Create a set of used pad numbers
751  for( D_PAD* pad = PadsList(); pad; pad = pad->Next() )
752  {
753  // Skip pads not on copper layers (used to build complex
754  // solder paste shapes for instance)
755  if( ( pad->GetLayerSet() & LSET::AllCuMask() ).none() )
756  continue;
757 
758  // Skip pads with no name, because they are usually "mechanical"
759  // pads, not "electrical" pads
760  if( pad->GetName().IsEmpty() )
761  continue;
762 
763  if( !aIncludeNPTH )
764  {
765  // skip NPTH
766  if( pad->GetAttribute() == PAD_ATTRIB_HOLE_NOT_PLATED )
767  {
768  continue;
769  }
770  }
771 
772  usedNames.insert( pad->GetName() );
773  }
774 
775  return usedNames.size();
776 }
777 
778 
780 {
781  if( NULL == a3DModel )
782  return;
783 
784  if( !a3DModel->m_Filename.empty() )
785  m_3D_Drawings.push_back( *a3DModel );
786 
787  delete a3DModel;
788 }
789 
790 
791 // see class_module.h
792 SEARCH_RESULT MODULE::Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] )
793 {
794  KICAD_T stype;
796  const KICAD_T* p = scanTypes;
797  bool done = false;
798 
799 #if 0 && defined(DEBUG)
800  std::cout << GetClass().mb_str() << ' ';
801 #endif
802 
803  while( !done )
804  {
805  stype = *p;
806 
807  switch( stype )
808  {
809  case PCB_MODULE_T:
810  result = inspector( this, testData ); // inspect me
811  ++p;
812  break;
813 
814  case PCB_PAD_T:
815  result = IterateForward( m_Pads, inspector, testData, p );
816  ++p;
817  break;
818 
819  case PCB_MODULE_TEXT_T:
820  result = inspector( m_Reference, testData );
821 
822  if( result == SEARCH_QUIT )
823  break;
824 
825  result = inspector( m_Value, testData );
826 
827  if( result == SEARCH_QUIT )
828  break;
829 
830  // m_Drawings can hold TYPETEXTMODULE also, so fall thru
831 
832  case PCB_MODULE_EDGE_T:
833  result = IterateForward( m_Drawings, inspector, testData, p );
834 
835  // skip over any types handled in the above call.
836  for( ; ; )
837  {
838  switch( stype = *++p )
839  {
840  case PCB_MODULE_TEXT_T:
841  case PCB_MODULE_EDGE_T:
842  continue;
843 
844  default:
845  ;
846  }
847 
848  break;
849  }
850 
851  break;
852 
853  default:
854  done = true;
855  break;
856  }
857 
858  if( result == SEARCH_QUIT )
859  break;
860  }
861 
862  return result;
863 }
864 
865 
866 wxString MODULE::GetSelectMenuText( EDA_UNITS_T aUnits ) const
867 {
868  wxString reference = GetReference();
869 
870  if( reference.IsEmpty() )
871  reference = _( "<no reference>" );
872 
873  return wxString::Format( _( "Footprint %s on %s" ), reference, GetLayerName() );
874 }
875 
876 
877 BITMAP_DEF MODULE::GetMenuImage() const
878 {
879  return module_xpm;
880 }
881 
882 
884 {
885  return new MODULE( *this );
886 }
887 
888 
889 void MODULE::RunOnChildren( const std::function<void (BOARD_ITEM*)>& aFunction )
890 {
891  try
892  {
893  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
894  aFunction( static_cast<BOARD_ITEM*>( pad ) );
895 
896  for( BOARD_ITEM* drawing = m_Drawings; drawing; drawing = drawing->Next() )
897  aFunction( drawing );
898 
899  aFunction( static_cast<BOARD_ITEM*>( m_Reference ) );
900  aFunction( static_cast<BOARD_ITEM*>( m_Value ) );
901  }
902  catch( std::bad_function_call& )
903  {
904  DisplayError( NULL, wxT( "Error running MODULE::RunOnChildren" ) );
905  }
906 }
907 
908 
909 void MODULE::GetAllDrawingLayers( int aLayers[], int& aCount, bool aIncludePads ) const
910 {
911  std::unordered_set<int> layers;
912 
913  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
914  {
915  layers.insert( static_cast<int>( item->GetLayer() ) );
916  }
917 
918  if( aIncludePads )
919  {
920  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
921  {
922  int pad_layers[KIGFX::VIEW::VIEW_MAX_LAYERS], pad_layers_count;
923  pad->ViewGetLayers( pad_layers, pad_layers_count );
924 
925  for( int i = 0; i < pad_layers_count; i++ )
926  layers.insert( pad_layers[i] );
927  }
928  }
929 
930  aCount = layers.size();
931  int i = 0;
932 
933  for( auto layer : layers )
934  aLayers[i++] = layer;
935 }
936 
937 
938 void MODULE::ViewGetLayers( int aLayers[], int& aCount ) const
939 {
940  aCount = 2;
941  aLayers[0] = LAYER_ANCHOR;
942 
943  switch( m_Layer )
944  {
945 
946  default:
947  wxASSERT_MSG( false, "Illegal layer" ); // do you really have modules placed on other layers?
948  // pass through
949  case F_Cu:
950  aLayers[1] = LAYER_MOD_FR;
951  break;
952 
953  case B_Cu:
954  aLayers[1] = LAYER_MOD_BK;
955  break;
956  }
957 
958  // If there are no pads, and only drawings on a silkscreen layer, then
959  // report the silkscreen layer as well so that the component can be edited
960  // with the silkscreen layer
961  bool f_silk = false, b_silk = false, non_silk = false;
962 
963  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
964  {
965  if( item->GetLayer() == F_SilkS )
966  f_silk = true;
967  else if( item->GetLayer() == B_SilkS )
968  b_silk = true;
969  else
970  non_silk = true;
971  }
972 
973  if( ( f_silk || b_silk ) && !non_silk && m_Pads.GetCount() == 0 )
974  {
975  if( f_silk )
976  aLayers[ aCount++ ] = F_SilkS;
977 
978  if( b_silk )
979  aLayers[ aCount++ ] = B_SilkS;
980  }
981 }
982 
983 
984 unsigned int MODULE::ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const
985 {
986  int layer = ( m_Layer == F_Cu ) ? LAYER_MOD_FR :
988 
989  // Currently it is only for anchor layer
990  if( aView->IsLayerVisible( layer ) )
991  return 3;
992 
994 }
995 
996 
997 const BOX2I MODULE::ViewBBox() const
998 {
999  EDA_RECT area = GetFootprintRect();
1000 
1001  // Calculate extended area including text fields
1002  area.Merge( m_Reference->GetBoundingBox() );
1003  area.Merge( m_Value->GetBoundingBox() );
1004 
1005  // Add the Clearance shape size: (shape around the pads when the
1006  // clearance is shown. Not optimized, but the draw cost is small
1007  // (perhaps smaller than optimization).
1008  BOARD* board = GetBoard();
1009  if( board )
1010  {
1011  int biggest_clearance = board->GetDesignSettings().GetBiggestClearanceValue();
1012  area.Inflate( biggest_clearance );
1013  }
1014 
1015  return area;
1016 }
1017 
1018 
1019 bool MODULE::IsLibNameValid( const wxString & aName )
1020 {
1021  const wxChar * invalids = StringLibNameInvalidChars( false );
1022 
1023  if( aName.find_first_of( invalids ) != std::string::npos )
1024  return false;
1025 
1026  return true;
1027 }
1028 
1029 
1030 const wxChar* MODULE::StringLibNameInvalidChars( bool aUserReadable )
1031 {
1032  static const wxChar invalidChars[] = wxT("%$\t\n\r \"\\/:");
1033  static const wxChar invalidCharsReadable[] = wxT("% $ 'tab' 'return' 'line feed' 'space' \\ \" / :");
1034 
1035  if( aUserReadable )
1036  return invalidCharsReadable;
1037  else
1038  return invalidChars;
1039 }
1040 
1041 
1042 void MODULE::Move( const wxPoint& aMoveVector )
1043 {
1044  wxPoint newpos = m_Pos + aMoveVector;
1045  SetPosition( newpos );
1046 }
1047 
1048 
1049 void MODULE::Rotate( const wxPoint& aRotCentre, double aAngle )
1050 {
1051  wxPoint newpos = m_Pos;
1052  RotatePoint( &newpos, aRotCentre, aAngle );
1053  SetPosition( newpos );
1054  SetOrientation( GetOrientation() + aAngle );
1055 }
1056 
1057 
1058 void MODULE::Flip( const wxPoint& aCentre )
1059 {
1060  // Move module to its final position:
1061  wxPoint finalPos = m_Pos;
1062  MIRROR( finalPos.y, aCentre.y );
1063  SetPosition( finalPos );
1064 
1065  // Flip layer
1066  SetLayer( FlipLayer( GetLayer() ) );
1067 
1068  // Reverse mirror orientation.
1069  m_Orient = -m_Orient;
1071 
1072  // Mirror pads to other side of board about the x axis, i.e. vertically.
1073  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
1074  pad->Flip( m_Pos );
1075 
1076  // Mirror reference and value.
1077  m_Reference->Flip( m_Pos );
1078  m_Value->Flip( m_Pos );
1079 
1080  // Reverse mirror module graphics and texts.
1081  for( EDA_ITEM* item = m_Drawings; item; item = item->Next() )
1082  {
1083  switch( item->Type() )
1084  {
1085  case PCB_MODULE_EDGE_T:
1086  ( (EDGE_MODULE*) item )->Flip( m_Pos );
1087  break;
1088 
1089  case PCB_MODULE_TEXT_T:
1090  static_cast<TEXTE_MODULE*>( item )->Flip( m_Pos );
1091  break;
1092 
1093  default:
1094  wxMessageBox( wxT( "MODULE::Flip() error: Unknown Draw Type" ) );
1095  break;
1096  }
1097  }
1098 
1100 }
1101 
1102 
1103 void MODULE::SetPosition( const wxPoint& newpos )
1104 {
1105  wxPoint delta = newpos - m_Pos;
1106 
1107  m_Pos += delta;
1108 
1109  m_Reference->EDA_TEXT::Offset( delta );
1110  m_Value->EDA_TEXT::Offset( delta );
1111 
1112  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
1113  {
1114  pad->SetPosition( pad->GetPosition() + delta );
1115  }
1116 
1117  for( EDA_ITEM* item = m_Drawings; item; item = item->Next() )
1118  {
1119  switch( item->Type() )
1120  {
1121  case PCB_MODULE_EDGE_T:
1122  {
1123  EDGE_MODULE* pt_edgmod = (EDGE_MODULE*) item;
1124  pt_edgmod->SetDrawCoord();
1125  break;
1126  }
1127 
1128  case PCB_MODULE_TEXT_T:
1129  {
1130  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( item );
1131  text->EDA_TEXT::Offset( delta );
1132  break;
1133  }
1134 
1135  default:
1136  wxMessageBox( wxT( "Draw type undefined." ) );
1137  break;
1138  }
1139  }
1140 
1142 }
1143 
1144 
1145 void MODULE::MoveAnchorPosition( const wxPoint& aMoveVector )
1146 {
1147  /* Move the reference point of the footprint
1148  * the footprints elements (pads, outlines, edges .. ) are moved
1149  * but:
1150  * - the footprint position is not modified.
1151  * - the relative (local) coordinates of these items are modified
1152  * - Draw coordinates are updated
1153  */
1154 
1155 
1156  // Update (move) the relative coordinates relative to the new anchor point.
1157  wxPoint moveVector = aMoveVector;
1158  RotatePoint( &moveVector, -GetOrientation() );
1159 
1160  // Update of the reference and value.
1161  m_Reference->SetPos0( m_Reference->GetPos0() + moveVector );
1163  m_Value->SetPos0( m_Value->GetPos0() + moveVector );
1164  m_Value->SetDrawCoord();
1165 
1166  // Update the pad local coordinates.
1167  for( D_PAD* pad = PadsList(); pad; pad = pad->Next() )
1168  {
1169  pad->SetPos0( pad->GetPos0() + moveVector );
1170  pad->SetDrawCoord();
1171  }
1172 
1173  // Update the draw element coordinates.
1174  for( EDA_ITEM* item = GraphicalItemsList(); item; item = item->Next() )
1175  {
1176  switch( item->Type() )
1177  {
1178  case PCB_MODULE_EDGE_T:
1179  {
1180  EDGE_MODULE* edge = static_cast<EDGE_MODULE*>( item );
1181  edge->Move( moveVector );
1182  }
1183  break;
1184 
1185  case PCB_MODULE_TEXT_T:
1186  {
1187  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( item );
1188  text->SetPos0( text->GetPos0() + moveVector );
1189  text->SetDrawCoord();
1190  }
1191  break;
1192 
1193  default:
1194  break;
1195  }
1196  }
1197 
1199 }
1200 
1201 
1202 void MODULE::SetOrientation( double newangle )
1203 {
1204  double angleChange = newangle - m_Orient; // change in rotation
1205 
1206  NORMALIZE_ANGLE_POS( newangle );
1207 
1208  m_Orient = newangle;
1209 
1210  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
1211  {
1212  pad->SetOrientation( pad->GetOrientation() + angleChange );
1213  pad->SetDrawCoord();
1214  }
1215 
1216  // Update of the reference and value.
1218  m_Value->SetDrawCoord();
1219 
1220  // Displace contours and text of the footprint.
1221  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
1222  {
1223  if( item->Type() == PCB_MODULE_EDGE_T )
1224  {
1225  static_cast<EDGE_MODULE*>( item )->SetDrawCoord();
1226  }
1227  else if( item->Type() == PCB_MODULE_TEXT_T )
1228  {
1229  static_cast<TEXTE_MODULE*>( item )->SetDrawCoord();
1230  }
1231  }
1232 
1234 }
1235 
1237  bool aIncrementPadNumbers,
1238  bool aAddToModule )
1239 {
1240  BOARD_ITEM* new_item = NULL;
1241  D_PAD* new_pad = NULL;
1242 
1243  switch( aItem->Type() )
1244  {
1245  case PCB_PAD_T:
1246  {
1247  new_pad = new D_PAD( *static_cast<const D_PAD*>( aItem ) );
1248 
1249  if( aAddToModule )
1250  PadsList().PushBack( new_pad );
1251 
1252  new_item = new_pad;
1253  break;
1254  }
1255 
1256  case PCB_MODULE_TEXT_T:
1257  {
1258  const TEXTE_MODULE* old_text = static_cast<const TEXTE_MODULE*>( aItem );
1259 
1260  // do not duplicate value or reference fields
1261  // (there can only be one of each)
1262  if( old_text->GetType() == TEXTE_MODULE::TEXT_is_DIVERS )
1263  {
1264  TEXTE_MODULE* new_text = new TEXTE_MODULE( *old_text );
1265 
1266  if( aAddToModule )
1267  GraphicalItemsList().PushBack( new_text );
1268 
1269  new_item = new_text;
1270  }
1271  break;
1272  }
1273 
1274  case PCB_MODULE_EDGE_T:
1275  {
1276  EDGE_MODULE* new_edge = new EDGE_MODULE(
1277  *static_cast<const EDGE_MODULE*>(aItem) );
1278 
1279  if( aAddToModule )
1280  GraphicalItemsList().PushBack( new_edge );
1281 
1282  new_item = new_edge;
1283  break;
1284  }
1285 
1286  case PCB_MODULE_T:
1287  // Ignore the module itself
1288  break;
1289 
1290  default:
1291  // Un-handled item for duplication
1292  wxASSERT_MSG( false, "Duplication not supported for items of class "
1293  + aItem->GetClass() );
1294  break;
1295  }
1296 
1297  if( aIncrementPadNumbers && new_pad && !new_pad->IsAperturePad() )
1298  {
1299  new_pad->IncrementPadName( true, true );
1300  }
1301 
1302  return new_item;
1303 }
1304 
1305 
1306 wxString MODULE::GetNextPadName( bool aFillSequenceGaps ) const
1307 {
1308  std::set<int> usedNumbers;
1309 
1310  // Create a set of used pad numbers
1311  for( D_PAD* pad = PadsList(); pad; pad = pad->Next() )
1312  {
1313  int padNumber = GetTrailingInt( pad->GetName() );
1314  usedNumbers.insert( padNumber );
1315  }
1316 
1317  const int nextNum = getNextNumberInSequence( usedNumbers, aFillSequenceGaps );
1318 
1319  return wxString::Format( wxT( "%i" ), nextNum );
1320 }
1321 
1322 
1323 void MODULE::IncrementReference( int aDelta )
1324 {
1325  const auto& refdes = GetReference();
1326  SetReference( wxString::Format( wxT( "%s%i" ), UTIL::GetReferencePrefix( refdes ),
1327  GetTrailingInt( refdes ) + aDelta ) );
1328 }
1329 
1330 
1331 // Calculate the area of aPolySet, after fracturation, because
1332 // polygons with no hole are expected.
1333 static double polygonArea( SHAPE_POLY_SET& aPolySet )
1334 {
1335  double area = 0.0;
1336  for( int ii = 0; ii < aPolySet.OutlineCount(); ii++ )
1337  {
1338  SHAPE_LINE_CHAIN& outline = aPolySet.Outline( ii );
1339  // Ensure the curr outline is closed, to calculate area
1340  outline.SetClosed( true );
1341 
1342  area += outline.Area();
1343  }
1344 
1345  return area;
1346 }
1347 
1348 // a helper function to add a rectangular polygon aRect to aPolySet
1349 static void addRect( SHAPE_POLY_SET& aPolySet, wxRect aRect )
1350 {
1351  aPolySet.NewOutline();
1352 
1353  aPolySet.Append( aRect.GetX(), aRect.GetY() );
1354  aPolySet.Append( aRect.GetX()+aRect.width, aRect.GetY() );
1355  aPolySet.Append( aRect.GetX()+aRect.width, aRect.GetY()+aRect.height );
1356  aPolySet.Append( aRect.GetX(), aRect.GetY()+aRect.height );
1357 }
1358 
1359 double MODULE::CoverageRatio( const GENERAL_COLLECTOR& aCollector ) const
1360 {
1361  double moduleArea = GetFootprintRect().GetArea();
1362  SHAPE_POLY_SET coveredRegion;
1363  addRect( coveredRegion, GetFootprintRect() );
1364 
1365  // build list of holes (covered areas not available for selection)
1366  SHAPE_POLY_SET holes;
1367 
1368  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
1369  addRect( holes, pad->GetBoundingBox() );
1370 
1371  addRect( holes, m_Reference->GetBoundingBox() );
1372  addRect( holes, m_Value->GetBoundingBox() );
1373 
1374  for( int i = 0; i < aCollector.GetCount(); ++i )
1375  {
1376  BOARD_ITEM* item = aCollector[i];
1377 
1378  switch( item->Type() )
1379  {
1380  case PCB_TEXT_T:
1381  case PCB_MODULE_TEXT_T:
1382  case PCB_TRACE_T:
1383  case PCB_VIA_T:
1384  addRect( holes, item->GetBoundingBox() );
1385  break;
1386  default:
1387  break;
1388  }
1389  }
1390 
1391  SHAPE_POLY_SET uncoveredRegion;
1392  uncoveredRegion.BooleanSubtract( coveredRegion, holes, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
1393  uncoveredRegion.Simplify( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
1394  uncoveredRegion.Fracture( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
1395 
1396  double uncoveredRegionArea = polygonArea( uncoveredRegion );
1397  double coveredArea = moduleArea - uncoveredRegionArea;
1398  double ratio = ( coveredArea / moduleArea );
1399 
1400  return std::min( ratio, 1.0 );
1401 }
1402 
1403 
1404 // see convert_drawsegment_list_to_polygon.cpp:
1405 extern bool ConvertOutlineToPolygon( std::vector<DRAWSEGMENT*>& aSegList, SHAPE_POLY_SET& aPolygons,
1406  wxString* aErrorText, unsigned int aTolerance, wxPoint* aErrorLocation = nullptr );
1407 
1409 {
1412  // Build the courtyard area from graphic items on the courtyard.
1413  // Only PCB_MODULE_EDGE_T have meaning, graphic texts are ignored.
1414  // Collect items:
1415  std::vector< DRAWSEGMENT* > list_front;
1416  std::vector< DRAWSEGMENT* > list_back;
1417 
1418  for( BOARD_ITEM* item = GraphicalItemsList(); item; item = item->Next() )
1419  {
1420  if( item->GetLayer() == B_CrtYd && item->Type() == PCB_MODULE_EDGE_T )
1421  list_back.push_back( static_cast< DRAWSEGMENT* > ( item ) );
1422 
1423  if( item->GetLayer() == F_CrtYd && item->Type() == PCB_MODULE_EDGE_T )
1424  list_front.push_back( static_cast< DRAWSEGMENT* > ( item ) );
1425  }
1426 
1427  // Note: if no item found on courtyard layers, return true.
1428  // false is returned only when the shape defined on courtyard layers
1429  // is not convertible to a polygon
1430  if( !list_front.size() && !list_back.size() )
1431  return true;
1432 
1433  wxString error_msg;
1434 
1435  bool success = ConvertOutlineToPolygon( list_front, m_poly_courtyard_front,
1436  &error_msg, (unsigned) Millimeter2iu( 0.05 ) );
1437 
1438  if( success )
1439  {
1440  success = ConvertOutlineToPolygon( list_back, m_poly_courtyard_back,
1441  &error_msg, (unsigned) Millimeter2iu( 0.05 ) );
1442  }
1443 
1444  if( !error_msg.IsEmpty() )
1445  {
1446  wxLogMessage( wxString::Format( _( "Processing courtyard of \"%s\": %s" ),
1447  GetChars( GetFPID().Format() ),
1448  error_msg) );
1449  }
1450 
1451  return success;
1452 }
1453 
1455 {
1456  assert( aImage->Type() == PCB_MODULE_T );
1457 
1458  std::swap( *((MODULE*) this), *((MODULE*) aImage) );
1459 }
unsigned GetPadCount(INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
GetPadCount returns the number of pads.
wxString GetNextPadName(bool aFillSequenceGaps) const
Function GetNextPadName returns the next available pad name in the module.
LIB_ID m_fpid
The LIB_ID of the MODULE.
Definition: class_module.h:728
Definition: colors.h:57
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:676
bool BuildPolyCourtyard()
Used in DRC to build the courtyard area (a complex polygon) from graphic items put on the courtyard.
bool IncrementPadName(bool aSkipUnconnectable, bool aFillSequenceGaps)
Function IncrementPadName.
Definition: class_pad.cpp:577
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
double GetOrientation() const
Definition: class_module.h:188
static SEARCH_RESULT IterateForward(EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function IterateForward walks through the object tree calling the inspector() on each object type req...
double GetArea(int aPadding=0) const
void SetThermalGap(int aGap)
Definition: class_module.h:222
int m_CntRot90
Horizontal automatic placement cost ( 0..10 ).
Definition: class_module.h:743
int OutlineCount() const
Returns the number of outlines in the set
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction)
Function RunOnChildren.
void Rotate(const wxPoint &aRotCentre, double aAngle) override
Function Rotate Rotate this object.
unsigned GetUniquePadCount(INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
GetUniquePadCount returns the number of unique pads.
SHAPE_POLY_SET m_poly_courtyard_back
Definition: class_module.h:761
T * Remove(T *aElement)
Function Remove removes aElement from the list, but does not delete it.
Definition: dlist.h:211
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:53
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:223
void SetLocalClearance(int aClearance)
Definition: class_module.h:208
like PAD_STANDARD, but not plated mechanical use only, no connection allowed
Definition: pad_shapes.h:66
void PushFront(T *aNewElement)
Function PushFront puts aNewElement at front of list sequence.
Definition: dlist.h:240
bool IsFlipped() const
function IsFlipped
Definition: class_module.h:258
wxString m_KeyWord
Search keywords to find module in library.
Definition: class_module.h:737
wxString m_Path
Definition: class_module.h:738
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
This file is part of the common library.
coord_type GetX() const
Definition: box2.h:188
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
void GetAllDrawingLayers(int aLayers[], int &aCount, bool aIncludePads=true) const
Returns a set of all layers that this module has drawings on similar to ViewGetLayers()
SHAPE_POLY_SET GetBoundingPoly() const
Returns a bounding polygon for the shapes and pads in the module This operation is slower but more ac...
bool ConvertOutlineToPolygon(std::vector< DRAWSEGMENT * > &aSegList, SHAPE_POLY_SET &aPolygons, wxString *aErrorText, unsigned int aTolerance, wxPoint *aErrorLocation=nullptr)
Function ConvertOutlineToPolygon build a polygon (with holes) from a DRAWSEGMENT list,...
int m_ThermalWidth
Definition: class_module.h:734
int GetBiggestClearanceValue()
Function GetBiggestClearanceValue.
double CoverageRatio(const GENERAL_COLLECTOR &aCollector) const
Function CoverageRatio Calculates the ratio of total area of the footprint pads and graphical items t...
anchor of items having an anchor point (texts, footprints)
static double polygonArea(SHAPE_POLY_SET &aPolySet)
void CalculateBoundingBox()
Function CalculateBoundingBox calculates the bounding box in board coordinates.
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset=ZeroOffset) override
Function Draw draws the footprint to the aDC.
double m_LocalSolderPasteMarginRatio
Solder mask margin ratio value of pad size.
Definition: class_module.h:752
void Flip(const wxPoint &aCentre) override
Function Flip Flip this object, i.e.
Class BOARD to handle a board.
Definition: colors.h:61
bool IsMoving() const
Definition: base_struct.h:221
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:475
BOARD_ITEM * Duplicate(const BOARD_ITEM *aItem, bool aIncrementPadNumbers, bool aAddToModule=false)
Function Duplicate Duplicate a given item within the module, without adding to the board.
unsigned GetCount() const
Function GetCount returns the number of elements in the list.
Definition: dlist.h:126
int m_LocalSolderPasteMargin
Solder paste margin absolute value.
Definition: class_module.h:751
int m_ThermalGap
Definition: class_module.h:735
Collection of utility functions for component reference designators (refdes)
int GetWidth() const
Definition: eda_rect.h:117
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:76
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
coord_type GetRight() const
Definition: box2.h:197
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
show modules values (when texts are visibles)
void GRDrawAnchor(EDA_RECT *aClipBox, wxDC *aDC, int x, int y, int aSize, COLOR4D aColor)
Definition: gr_basic.cpp:1193
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:539
EDA_RECT GetFootprintRect() const
Function GetFootprintRect() Returns the area of the module footprint excluding any text.
void SetZoneConnection(ZoneConnection aType)
Definition: class_module.h:216
MODULE(BOARD *parent)
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
void Add3DModel(MODULE_3D_SETTINGS *a3DModel)
Function Add3DModel adds a3DModel definition to the end of the 3D model list.
const LIB_ID & GetFPID() const
Definition: class_module.h:192
static const wxChar * StringLibNameInvalidChars(bool aUserReadable)
static function StringLibNameInvalidChars Test for validity of the name in a library of the footprint...
virtual EDA_RECT * GetClipBox()
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
coord_type GetBottom() const
Definition: box2.h:198
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:241
void DeleteAll()
Function DeleteAll deletes all items on the list and leaves the list empty.
Definition: dlist.cpp:44
virtual wxString GetShownText() const override
Returns the string actually shown after processing of the base text.
int GetLocalSolderMaskMargin() const
Definition: class_module.h:204
void MoveAnchorPosition(const wxPoint &aMoveVector)
Function MoveAnchorPosition Move the reference point of the footprint It looks like a move footprint:...
#define abs(a)
Definition: auxiliary.h:84
wxArrayString * m_initial_comments
leading s-expression comments in the module, lazily allocated only if needed for speed
Definition: class_module.h:755
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_module.h:214
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
void DrawAncre(EDA_DRAW_PANEL *panel, wxDC *DC, const wxPoint &offset, int dim_ancre, GR_DRAWMODE draw_mode)
Function DrawAncre Draw the anchor cross (vertical) Must be done after the pads, because drawing the ...
bool Contains(const wxPoint &aPoint) const
Function Contains.
#define MODULE_PADS_LOCKED
In autoplace: module waiting for autoplace.
Definition: class_module.h:264
static const int delta[8][2]
Definition: solve.cpp:112
static int getNextNumberInSequence(const std::set< int > &aSeq, bool aFillSequenceGaps)
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
static constexpr int VIEW_MAX_LAYERS
maximum number of layers that may be shown
Definition: view.h:712
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
wxString m_Doc
File name and path for documentation file.
Definition: class_module.h:736
timestamp_t m_LastEditTime
Definition: class_module.h:740
#define DIM_ANCRE_MODULE
Definition: pcbnew.h:63
This file contains miscellaneous commonly used macros and functions.
const char * c_str() const
Definition: utf8.h:107
#define MODULE_is_PLACED
In autoplace: module automatically placed.
Definition: class_module.h:262
EDA_ITEM * Next() const
Definition: base_struct.h:209
void PushBack(T *aNewElement)
Function PushBack puts aNewElement at the end of the list sequence.
Definition: dlist.h:250
show modules on front
int m_LocalClearance
Definition: class_module.h:749
virtual EDA_DRAW_FRAME * GetParent() const =0
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:102
PCB_LAYER_ID m_Layer
double m_Orient
Orientation in tenths of a degree, 900=90.0 degrees.
Definition: class_module.h:724
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:114
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:114
static void addRect(SHAPE_POLY_SET &aPolySet, wxRect aRect)
class MODULE, a footprint
Definition: typeinfo.h:89
void SetClosed(bool aClosed)
Function SetClosed()
void ClearAllNets()
Function ClearAllNets Clear (i.e.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1003
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.
D_PAD * FindPadByName(const wxString &aPadName) const
Function FindPadByName returns a D_PAD* with a matching name.
EDA_RECT m_BoundaryBox
Bounding box : coordinates on board, real orientation.
Definition: class_module.h:731
Class LSET is a set of PCB_LAYER_IDs.
void Inflate(int aFactor, int aCircleSegmentsCount)
Performs outline inflation/deflation, using round corners.
int GetLocalClearance() const
Definition: class_module.h:207
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:216
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
Class SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
void SetEnd(int x, int y)
Definition: eda_rect.h:134
TEXT_TYPE GetType() const
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
const wxString & GetReference() const
Function GetReference.
Definition: class_module.h:462
timestamp_t m_Link
Temporary logical link used during editing.
Definition: class_module.h:742
void SetThermalWidth(int aWidth)
Definition: class_module.h:219
int m_LocalSolderMaskMargin
Solder mask margin.
Definition: class_module.h:750
std::list< MODULE_3D_SETTINGS > m_3D_Drawings
Linked list of 3D models.
Definition: class_module.h:723
double GetOrientationRadians() const
Definition: class_module.h:190
int m_arflag
Use to trace ratsnest and auto routing.
Definition: class_module.h:741
double GetOrientationDegrees() const
Definition: class_module.h:189
Definition: colors.h:60
void Flip(const wxPoint &aCentre) override
Flip entity during module flip.
void Simplify(POLYGON_MODE aFastMode)
Simplifies the polyset (merges overlapping polys, eliminates degeneracy/self-intersections) For aFast...
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:472
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
SHAPE_POLY_SET m_poly_courtyard_front
Used in DRC to test the courtyard area (a polygon which can be not basic Note also a footprint can ha...
Definition: class_module.h:760
virtual void SetPosition(const wxPoint &aPos) override
void Remove(BOARD_ITEM *aItem) override
virtual unsigned int ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Function ViewGetLOD() Returns the level of detail (LOD) of the item.
void SetPosition(const wxPoint &aPos) override
double GetArea() const
Function GetArea returns the area of the rectangle.
T * GetFirst() const
Function GetFirst returns the first T* in the list without removing it, or NULL if the list is empty.
Definition: dlist.h:163
void DrawEdgesOnly(EDA_DRAW_PANEL *panel, wxDC *DC, const wxPoint &offset, GR_DRAWMODE draw_mode)
Function DrawEdgesOnly Draws the footprint edges only to the current Device Context.
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset=ZeroOffset) override
Function Draw Draw the text according to the footprint pos and orient.
int NewOutline()
Creates a new empty polygon in the set and returns its index
bool IsLocked() const override
Function IsLocked.
Definition: class_module.h:267
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
void Fracture(POLYGON_MODE aFastMode)
Converts a set of polygons with holes to a singe outline with "slits"/"fractures" connecting the oute...
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_module.h:205
int GetHeight() const
Definition: eda_rect.h:118
D_PAD * GetTopLeftPad()
void SetPos0(const wxPoint &aPos)
UTF8 Format() const
Definition: lib_id.cpp:237
int GetLocalSolderPasteMargin() const
Definition: class_module.h:210
static const int ORPHANED
Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) whe...
Definition: netinfo.h:473
MODULE & operator=(const MODULE &aOther)
double Area() const
wxString m_Filename
The 3D shape filename in 3D library.
Definition: class_module.h:102
default
Definition: class_module.h:75
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
const wxPoint & GetPos0() const
const Vec & GetPosition() const
Definition: box2.h:192
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
static bool IsLibNameValid(const wxString &aName)
static function IsLibNameValid Test for validity of a name of a footprint to be used in a footprint l...
D_PAD * GetPad(const wxPoint &aPosition, LSET aLayerMask=LSET::AllLayersMask())
Function GetPad get a pad at aPosition on aLayerMask in the footprint.
void SetLocalSolderPasteMargin(int aMargin)
Definition: class_module.h:211
double GetLocalSolderPasteMarginRatio() const
Definition: class_module.h:213
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
int m_CntRot180
Vertical automatic placement cost ( 0..10 ).
Definition: class_module.h:744
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
virtual wxString GetClass() const =0
Function GetClass returns the class name.
BOARD_ITEM * Next() const
void SetLocked(bool isLocked) override
Function SetLocked sets the MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: class_module.h:277
wxString GetReferencePrefix(const wxString &aRefDes)
Get the (non-numeric) prefix from a refdes - e.g.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void IncrementReference(int aDelta)
Function IncrementReference Bumps the current reference by aDelta.
SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
DLIST< BOARD_ITEM > m_Drawings
Linked list of graphical items.
Definition: class_module.h:722
#define max(a, b)
Definition: auxiliary.h:86
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:171
int m_ModuleStatus
For autoplace: flags (LOCKED, AUTOPLACED)
Definition: class_module.h:730
Class SHAPE_LINE_CHAIN.
void Move(const wxPoint &aMoveVector) override
Function Move move this object.
void SetOrientation(double newangle)
Virtual component: when created by copper shapes on board (Like edge card connectors,...
Definition: class_module.h:78
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:245
virtual void SwapData(BOARD_ITEM *aImage) override
Swap data between aItem and aImage.
void Move(const wxPoint &aMoveVector) override
Move an edge of the footprint.
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
size_t i
Definition: json11.cpp:597
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_module.h:595
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
void SetDrawCoord()
Set absolute coordinates.
void SetDrawCoord()
Set draw coordinates (absolute values ) from relative coordinates.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class PCB_EDIT_FRAME is the main frame for Pcbnew.
TEXTE_MODULE * m_Value
Component value (74LS00, 22K..)
Definition: class_module.h:727
bool IsAperturePad() const
Definition: class_pad.h:416
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
wxPoint m_Pos
Position of module on the board in internal units.
Definition: class_module.h:725
int GetTrailingInt(const wxString &aStr)
Gets the trailing int, if any, from a string.
Definition: string.cpp:609
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
bool HitTestAccurate(const wxPoint &aPosition) const
Tests if a point is inside the bounding polygon of the module.
DLIST< BOARD_ITEM > & GraphicalItemsList()
Definition: class_module.h:165
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
TEXTE_MODULE * m_Reference
Component reference designator value (U34, R18..)
Definition: class_module.h:726
void CopyNetlistSettings(MODULE *aModule, bool aCopyLocalSettings)
Function CopyNetlistSettings copies the netlist settings to aModule.
DLIST< D_PAD > & PadsList()
Definition: class_module.h:162
void BooleanSubtract(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Performs boolean polyset difference For aFastMode meaning, see function booleanOp
Module description (excepted pads)
Definition: colors.h:45
Abstract interface for BOARD_ITEMs capable of storing other items inside.
virtual const EDA_RECT GetBoundingBox() const
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
Class VIEW.
Definition: view.h:61
SEARCH_RESULT
Definition: base_struct.h:66
DLIST< D_PAD > m_Pads
Linked list of pads.
Definition: class_module.h:721
const wxPoint GetPosition() const override
Definition: class_pad.h:220
int GetThermalWidth() const
Definition: class_module.h:220
EDGE_MODULE class definition.
ZoneConnection m_ZoneConnection
Definition: class_module.h:739
Message panel definition file.
void Rotate(double aAngle, const VECTOR2I &aCenter)
Function Rotate rotates all vertices by a given angle.
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.
INCLUDE_NPTH_T
Definition: class_module.h:61
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:243
const wxPoint GetPosition() const override
Definition: class_module.h:183
int GetThermalGap() const
Definition: class_module.h:223
void CopyNetlistSettings(D_PAD *aPad, bool aCopyLocalSettings)
Function CopyNetlistSettings copies the netlist settings to aPad, and the net name.
Definition: class_pad.cpp:588
EDA_UNITS_T
Definition: common.h:160
show modules references (when texts are visibles)
ZoneConnection GetZoneConnection() const
Definition: class_module.h:217
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:126
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
#define min(a, b)
Definition: auxiliary.h:85
int m_Attributs
Flag bits ( see Mod_Attribut )
Definition: class_module.h:729
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:427
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)
bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item.
Definition: colors.h:62