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@verizon.net>
7  * Copyright (C) 1992-2017 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 <wxstruct.h>
35 #include <plot_common.h>
36 #include <class_drawpanel.h>
37 #include <trigo.h>
38 #include <confirm.h>
39 #include <kicad_string.h>
40 #include <pcbnew.h>
41 #include <colors_selection.h>
42 #include <richio.h>
43 #include <filter_reader.h>
44 #include <macros.h>
45 #include <msgpanel.h>
46 #include <bitmaps.h>
47 
48 #include <class_board.h>
49 #include <class_edge_mod.h>
50 #include <class_module.h>
52 
53 #include <view/view.h>
54 
55 MODULE::MODULE( BOARD* parent ) :
57  m_initial_comments( 0 )
58 {
60  m_Layer = F_Cu;
61  m_Orient = 0;
63  m_arflag = 0;
64  m_CntRot90 = m_CntRot180 = 0;
65  m_Surface = 0.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 = Pads(); 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  GRSetDrawMode( DC, draw_mode );
241 
242  if( GetBoard()->IsElementVisible( ANCHOR_VISIBLE ) )
243  {
244  GRDrawAnchor( panel->GetClipBox(), DC, m_Pos.x, m_Pos.y,
245  dim_ancre,
247  }
248 }
249 
250 
251 void MODULE::Add( BOARD_ITEM* aBoardItem, ADD_MODE aMode )
252 {
253  switch( aBoardItem->Type() )
254  {
255  case PCB_MODULE_TEXT_T:
256  // Only user texts can be added this way. Reference and value are not hold in the DLIST.
257  assert( static_cast<TEXTE_MODULE*>( aBoardItem )->GetType() == TEXTE_MODULE::TEXT_is_DIVERS );
258 
259  // no break
260 
261  case PCB_MODULE_EDGE_T:
262  if( aMode == ADD_APPEND )
263  m_Drawings.PushBack( aBoardItem );
264  else
265  m_Drawings.PushFront( aBoardItem );
266  break;
267 
268  case PCB_PAD_T:
269  if( aMode == ADD_APPEND )
270  m_Pads.PushBack( static_cast<D_PAD*>( aBoardItem ) );
271  else
272  m_Pads.PushFront( static_cast<D_PAD*>( aBoardItem ) );
273  break;
274 
275  default:
276  {
277  wxString msg;
278  msg.Printf( wxT( "MODULE::Add() needs work: BOARD_ITEM type (%d) not handled" ),
279  aBoardItem->Type() );
280  wxFAIL_MSG( msg );
281 
282  return;
283  }
284  }
285 
286  aBoardItem->SetParent( this );
287 
288  // Update relative coordinates, it can be done only after there is a parent object assigned
289  switch( aBoardItem->Type() )
290  {
291  case PCB_MODULE_TEXT_T:
292  static_cast<TEXTE_MODULE*>( aBoardItem )->SetLocalCoord();
293  break;
294 
295  case PCB_MODULE_EDGE_T:
296  static_cast<EDGE_MODULE*>( aBoardItem )->SetLocalCoord();
297  break;
298 
299  case PCB_PAD_T:
300  static_cast<D_PAD*>( aBoardItem )->SetLocalCoord();
301  break;
302 
303  default:
304  // Huh? It should have been filtered out by the previous switch
305  assert(false);
306  break;
307  }
308 }
309 
310 
311 void MODULE::Remove( BOARD_ITEM* aBoardItem )
312 {
313  switch( aBoardItem->Type() )
314  {
315  case PCB_MODULE_TEXT_T:
316  // Only user texts can be removed this way. Reference and value are not hold in the DLIST.
317  assert( static_cast<TEXTE_MODULE*>( aBoardItem )->GetType() == TEXTE_MODULE::TEXT_is_DIVERS );
318 
319  // no break
320 
321  case PCB_MODULE_EDGE_T:
322  m_Drawings.Remove( aBoardItem );
323  break;
324 
325  case PCB_PAD_T:
326  m_Pads.Remove( static_cast<D_PAD*>( aBoardItem ) );
327  break;
328 
329  default:
330  {
331  wxString msg;
332  msg.Printf( wxT( "MODULE::Remove() needs work: BOARD_ITEM type (%d) not handled" ),
333  aBoardItem->Type() );
334  wxFAIL_MSG( msg );
335  }
336  }
337 }
338 
339 
340 void MODULE::CopyNetlistSettings( MODULE* aModule, bool aCopyLocalSettings )
341 {
342  // Don't do anything foolish like trying to copy to yourself.
343  wxCHECK_RET( aModule != NULL && aModule != this, wxT( "Cannot copy to NULL or yourself." ) );
344 
345  // Not sure what to do with the value field. Use netlist for now.
346  aModule->SetPosition( GetPosition() );
347 
348  if( aModule->GetLayer() != GetLayer() )
349  aModule->Flip( aModule->GetPosition() );
350 
351  if( aModule->GetOrientation() != GetOrientation() )
352  aModule->Rotate( aModule->GetPosition(), GetOrientation() );
353 
354  aModule->SetLocked( IsLocked() );
355 
356  if( aCopyLocalSettings )
357  {
359  aModule->SetLocalClearance( GetLocalClearance() );
362  aModule->SetZoneConnection( GetZoneConnection() );
363  aModule->SetThermalWidth( GetThermalWidth() );
364  aModule->SetThermalGap( GetThermalGap() );
365  }
366 
367  for( D_PAD* pad = aModule->Pads(); pad; pad = pad->Next() )
368  {
369  // Fix me: if aCopyLocalSettings == true, for "multiple" pads
370  // (set of pads having the same name/number) this is broken
371  // because we copy settings from the first pad found.
372  // When old and new footprints have very few differences, a better
373  // algo can be used.
374  D_PAD* oldPad = FindPadByName( pad->GetPadName() );
375 
376  if( oldPad )
377  oldPad->CopyNetlistSettings( pad, aCopyLocalSettings );
378  }
379 
380  // Not sure about copying description, keywords, 3D models or any other
381  // local user changes to footprint. Stick with the new footprint settings
382  // called out in the footprint loaded in the netlist.
383  aModule->CalculateBoundingBox();
384 }
385 
386 
387 void MODULE::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, GR_DRAWMODE aDrawMode,
388  const wxPoint& aOffset )
389 {
390  if( (m_Flags & DO_NOT_DRAW) || (IsMoving()) )
391  return;
392 
393  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
394  {
395  if( pad->IsMoving() )
396  continue;
397 
398  pad->Draw( aPanel, aDC, aDrawMode, aOffset );
399  }
400 
401  BOARD* brd = GetBoard();
402 
403  // Draws footprint anchor
404  DrawAncre( aPanel, aDC, aOffset, DIM_ANCRE_MODULE, aDrawMode );
405 
406  // Draw graphic items
408  {
409  if( !(m_Reference->IsMoving()) )
410  m_Reference->Draw( aPanel, aDC, aDrawMode, aOffset );
411  }
412 
414  {
415  if( !(m_Value->IsMoving()) )
416  m_Value->Draw( aPanel, aDC, aDrawMode, aOffset );
417  }
418 
419  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
420  {
421  if( item->IsMoving() )
422  continue;
423 
424  switch( item->Type() )
425  {
426  case PCB_MODULE_TEXT_T:
427  case PCB_MODULE_EDGE_T:
428  item->Draw( aPanel, aDC, aDrawMode, aOffset );
429  break;
430 
431  default:
432  break;
433  }
434  }
435 
436  // Enable these line to draw m_BoundaryBox (debug tests purposes only)
437 #if 0
438  GRRect( aPanel->GetClipBox(), aDC, m_BoundaryBox, 0, BROWN );
439 #endif
440 
441 }
442 
443 
444 void MODULE::DrawEdgesOnly( EDA_DRAW_PANEL* panel, wxDC* DC, const wxPoint& offset,
445  GR_DRAWMODE draw_mode )
446 {
447  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
448  {
449  switch( item->Type() )
450  {
451  case PCB_MODULE_EDGE_T:
452  item->Draw( panel, DC, draw_mode, offset );
453  break;
454 
455  default:
456  break;
457  }
458  }
459 }
460 
461 
463 {
466 }
467 
468 
470 {
471  EDA_RECT area;
472 
473  area.SetOrigin( m_Pos );
474  area.SetEnd( m_Pos );
475  area.Inflate( Millimeter2iu( 0.25 ) ); // Give a min size to the area
476 
477  for( const BOARD_ITEM* item = m_Drawings.GetFirst(); item; item = item->Next() )
478  {
479  const EDGE_MODULE* edge = dyn_cast<const EDGE_MODULE*>( item );
480 
481  if( edge )
482  area.Merge( edge->GetBoundingBox() );
483  }
484 
485  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
486  area.Merge( pad->GetBoundingBox() );
487 
488  return area;
489 }
490 
491 
493 {
494  EDA_RECT area = GetFootprintRect();
495 
496  // Calculate extended area including text fields
497  area.Merge( m_Reference->GetBoundingBox() );
498  area.Merge( m_Value->GetBoundingBox() );
499 
500  // Add the Clearance shape size: (shape around the pads when the
501  // clearance is shown. Not optimized, but the draw cost is small
502  // (perhaps smaller than optimization).
503  BOARD* board = GetBoard();
504  if( board )
505  {
506  int biggest_clearance = board->GetDesignSettings().GetBiggestClearanceValue();
507  area.Inflate( biggest_clearance );
508  }
509 
510  return area;
511 }
512 
513 
514 void MODULE::GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList )
515 {
516  int nbpad;
517  wxString msg;
518 
519  aList.push_back( MSG_PANEL_ITEM( m_Reference->GetShownText(), m_Value->GetShownText(), DARKCYAN ) );
520 
521  // Display last date the component was edited (useful in Module Editor).
522  wxDateTime date( m_LastEditTime );
523 
524  if( m_LastEditTime && date.IsValid() )
525  // Date format: see http://www.cplusplus.com/reference/ctime/strftime
526  msg = date.Format( wxT( "%b %d, %Y" ) ); // Abbreviated_month_name Day, Year
527  else
528  msg = _( "Unknown" );
529 
530  aList.push_back( MSG_PANEL_ITEM( _( "Last Change" ), msg, BROWN ) );
531 
532  // display schematic path
533  aList.push_back( MSG_PANEL_ITEM( _( "Netlist Path" ), m_Path, BROWN ) );
534 
535  // display the board side placement
536  aList.push_back( MSG_PANEL_ITEM( _( "Board Side" ),
537  IsFlipped()? _( "Back (Flipped)" ) : _( "Front" ), RED ) );
538 
539  EDA_ITEM* PtStruct = m_Pads;
540  nbpad = 0;
541 
542  while( PtStruct )
543  {
544  nbpad++;
545  PtStruct = PtStruct->Next();
546  }
547 
548  msg.Printf( wxT( "%d" ), nbpad );
549  aList.push_back( MSG_PANEL_ITEM( _( "Pads" ), msg, BLUE ) );
550 
551  msg = wxT( ".." );
552 
553  if( IsLocked() )
554  msg[0] = 'L';
555 
557  msg[1] = 'P';
558 
559  aList.push_back( MSG_PANEL_ITEM( _( "Status" ), msg, MAGENTA ) );
560 
561  msg.Printf( wxT( "%.1f" ), GetOrientationDegrees() );
562  aList.push_back( MSG_PANEL_ITEM( _( "Rotation" ), msg, BROWN ) );
563 
564  // Controls on right side of the dialog
565  switch( m_Attributs & 255 )
566  {
567  case 0:
568  msg = _( "Normal" );
569  break;
570 
571  case MOD_CMS:
572  msg = _( "Insert" );
573  break;
574 
575  case MOD_VIRTUAL:
576  msg = _( "Virtual" );
577  break;
578 
579  default:
580  msg = wxT( "???" );
581  break;
582  }
583 
584  aList.push_back( MSG_PANEL_ITEM( _( "Attributes" ), msg, BROWN ) );
585  aList.push_back( MSG_PANEL_ITEM( _( "Footprint" ), FROM_UTF8( m_fpid.Format().c_str() ), BLUE ) );
586 
587  if( m_3D_Drawings.empty() )
588  msg = _( "No 3D shape" );
589  else
590  msg = m_3D_Drawings.front().m_Filename;
591 
592  // Search the first active 3D shape in list
593 
594  aList.push_back( MSG_PANEL_ITEM( _( "3D-Shape" ), msg, RED ) );
595 
596  wxString doc, keyword;
597  doc.Printf( _( "Doc: %s" ), GetChars( m_Doc ) );
598  keyword.Printf( _( "Key Words: %s" ), GetChars( m_KeyWord ) );
599  aList.push_back( MSG_PANEL_ITEM( doc, keyword, BLACK ) );
600 }
601 
602 
603 bool MODULE::HitTest( const wxPoint& aPosition ) const
604 {
605  return m_BoundaryBox.Contains( aPosition );
606 }
607 
608 
609 bool MODULE::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const
610 {
611  EDA_RECT arect = aRect;
612  arect.Inflate( aAccuracy );
613 
614  if( aContained )
615  return arect.Contains( m_BoundaryBox );
616  else
617  return m_BoundaryBox.Intersects( arect );
618 }
619 
620 
621 D_PAD* MODULE::FindPadByName( const wxString& aPadName ) const
622 {
623  wxString buf;
624 
625  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
626  {
627  pad->StringPadName( buf );
628 #if 1
629  if( buf.CmpNoCase( aPadName ) == 0 ) // why case insensitive?
630 #else
631  if( buf == aPadName )
632 #endif
633  return pad;
634  }
635 
636  return NULL;
637 }
638 
639 
640 D_PAD* MODULE::GetPad( const wxPoint& aPosition, LSET aLayerMask )
641 {
642  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
643  {
644  // ... and on the correct layer.
645  if( !( pad->GetLayerSet() & aLayerMask ).any() )
646  continue;
647 
648  if( pad->HitTest( aPosition ) )
649  return pad;
650  }
651 
652  return NULL;
653 }
654 
655 
656 unsigned MODULE::GetPadCount( INCLUDE_NPTH_T aIncludeNPTH ) const
657 {
658  if( aIncludeNPTH )
659  return m_Pads.GetCount();
660 
661  unsigned cnt = 0;
662 
663  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
664  {
665  if( pad->GetAttribute() == PAD_ATTRIB_HOLE_NOT_PLATED )
666  continue;
667 
668  cnt++;
669  }
670 
671  return cnt;
672 }
673 
674 
675 unsigned MODULE::GetUniquePadCount( INCLUDE_NPTH_T aIncludeNPTH ) const
676 {
677  std::set<wxUint32> usedNames;
678 
679  // Create a set of used pad numbers
680  for( D_PAD* pad = Pads(); pad; pad = pad->Next() )
681  {
682  // Skip pads not on copper layers (used to build complex
683  // solder paste shapes for instance)
684  if( ( pad->GetLayerSet() & LSET::AllCuMask() ).none() )
685  continue;
686 
687  // Skip pads with no name, because they are usually "mechanical"
688  // pads, not "electrical" pads
689  if( pad->GetPadName().IsEmpty() )
690  continue;
691 
692  if( !aIncludeNPTH )
693  {
694  // skip NPTH
695  if( pad->GetAttribute() == PAD_ATTRIB_HOLE_NOT_PLATED )
696  {
697  continue;
698  }
699  }
700 
701  usedNames.insert( pad->GetPackedPadName() );
702  }
703 
704  return usedNames.size();
705 }
706 
707 
708 void MODULE::Add3DModel( S3D_INFO* a3DModel )
709 {
710  if( NULL == a3DModel )
711  return;
712 
713  if( !a3DModel->m_Filename.empty() )
714  m_3D_Drawings.push_back( *a3DModel );
715 
716  delete a3DModel;
717 }
718 
719 
720 // see class_module.h
721 SEARCH_RESULT MODULE::Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] )
722 {
723  KICAD_T stype;
725  const KICAD_T* p = scanTypes;
726  bool done = false;
727 
728 #if 0 && defined(DEBUG)
729  std::cout << GetClass().mb_str() << ' ';
730 #endif
731 
732  while( !done )
733  {
734  stype = *p;
735 
736  switch( stype )
737  {
738  case PCB_MODULE_T:
739  result = inspector( this, testData ); // inspect me
740  ++p;
741  break;
742 
743  case PCB_PAD_T:
744  result = IterateForward( m_Pads, inspector, testData, p );
745  ++p;
746  break;
747 
748  case PCB_MODULE_TEXT_T:
749  result = inspector( m_Reference, testData );
750 
751  if( result == SEARCH_QUIT )
752  break;
753 
754  result = inspector( m_Value, testData );
755 
756  if( result == SEARCH_QUIT )
757  break;
758 
759  // m_Drawings can hold TYPETEXTMODULE also, so fall thru
760 
761  case PCB_MODULE_EDGE_T:
762  result = IterateForward( m_Drawings, inspector, testData, p );
763 
764  // skip over any types handled in the above call.
765  for( ; ; )
766  {
767  switch( stype = *++p )
768  {
769  case PCB_MODULE_TEXT_T:
770  case PCB_MODULE_EDGE_T:
771  continue;
772 
773  default:
774  ;
775  }
776 
777  break;
778  }
779 
780  break;
781 
782  default:
783  done = true;
784  break;
785  }
786 
787  if( result == SEARCH_QUIT )
788  break;
789  }
790 
791  return result;
792 }
793 
794 
796 {
797  wxString text;
798  text.Printf( _( "Footprint %s on %s" ),
799  GetChars ( GetReference() ),
800  GetChars ( GetLayerName() ) );
801 
802  return text;
803 }
804 
805 
807 {
808  return module_xpm;
809 }
810 
811 
813 {
814  return new MODULE( *this );
815 }
816 
817 
818 void MODULE::RunOnChildren( std::function<void (BOARD_ITEM*)> aFunction )
819 {
820  try
821  {
822  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
823  aFunction( static_cast<BOARD_ITEM*>( pad ) );
824 
825  for( BOARD_ITEM* drawing = m_Drawings; drawing; drawing = drawing->Next() )
826  aFunction( drawing );
827 
828  aFunction( static_cast<BOARD_ITEM*>( m_Reference ) );
829  aFunction( static_cast<BOARD_ITEM*>( m_Value ) );
830  }
831  catch( std::bad_function_call& )
832  {
833  DisplayError( NULL, wxT( "Error running MODULE::RunOnChildren" ) );
834  }
835 }
836 
837 void MODULE::ViewGetLayers( int aLayers[], int& aCount ) const
838 {
839  aCount = 2;
840  aLayers[0] = ITEM_GAL_LAYER( ANCHOR_VISIBLE );
841 
842  switch( m_Layer )
843  {
844 
845  default:
846  wxASSERT_MSG( false, "Illegal layer" ); // do you really have modules placed on other layers?
847  // pass through
848  case F_Cu:
849  aLayers[1] = ITEM_GAL_LAYER( MOD_FR_VISIBLE );
850  break;
851 
852  case B_Cu:
853  aLayers[1] = ITEM_GAL_LAYER( MOD_BK_VISIBLE );
854  break;
855  }
856 }
857 
858 
859 unsigned int MODULE::ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const
860 {
861  int layer = ( m_Layer == F_Cu ) ? MOD_FR_VISIBLE :
863 
864  // Currently it is only for anchor layer
865  if( aView->IsLayerVisible( ITEM_GAL_LAYER( layer ) ) )
866  return 30;
867 
869 }
870 
871 
872 const BOX2I MODULE::ViewBBox() const
873 {
874  EDA_RECT fpRect = GetFootprintRect();
875 
876  return BOX2I( VECTOR2I( fpRect.GetOrigin() ), VECTOR2I( fpRect.GetSize() ) );
877 }
878 
879 
880 bool MODULE::IsLibNameValid( const wxString & aName )
881 {
882  const wxChar * invalids = StringLibNameInvalidChars( false );
883 
884  if( aName.find_first_of( invalids ) != std::string::npos )
885  return false;
886 
887  return true;
888 }
889 
890 
891 const wxChar* MODULE::StringLibNameInvalidChars( bool aUserReadable )
892 {
893  static const wxChar invalidChars[] = wxT("%$\t \"\\/");
894  static const wxChar invalidCharsReadable[] = wxT("% $ 'tab' 'space' \\ \" /");
895 
896  if( aUserReadable )
897  return invalidCharsReadable;
898  else
899  return invalidChars;
900 }
901 
902 
903 void MODULE::Move( const wxPoint& aMoveVector )
904 {
905  wxPoint newpos = m_Pos + aMoveVector;
906  SetPosition( newpos );
907 }
908 
909 
910 void MODULE::Rotate( const wxPoint& aRotCentre, double aAngle )
911 {
912  wxPoint newpos = m_Pos;
913  RotatePoint( &newpos, aRotCentre, aAngle );
914  SetPosition( newpos );
915  SetOrientation( GetOrientation() + aAngle );
916 }
917 
918 
919 void MODULE::Flip( const wxPoint& aCentre )
920 {
921  // Move module to its final position:
922  wxPoint finalPos = m_Pos;
923  MIRROR( finalPos.y, aCentre.y );
924  SetPosition( finalPos );
925 
926  // Flip layer
927  SetLayer( FlipLayer( GetLayer() ) );
928 
929  // Reverse mirror orientation.
930  m_Orient = -m_Orient;
932 
933  // Mirror pads to other side of board about the x axis, i.e. vertically.
934  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
935  pad->Flip( m_Pos );
936 
937  // Mirror reference and value.
938  m_Reference->Flip( m_Pos );
939  m_Value->Flip( m_Pos );
940 
941  // Reverse mirror module graphics and texts.
942  for( EDA_ITEM* item = m_Drawings; item; item = item->Next() )
943  {
944  switch( item->Type() )
945  {
946  case PCB_MODULE_EDGE_T:
947  ( (EDGE_MODULE*) item )->Flip( m_Pos );
948  break;
949 
950  case PCB_MODULE_TEXT_T:
951  static_cast<TEXTE_MODULE*>( item )->Flip( m_Pos );
952  break;
953 
954  default:
955  wxMessageBox( wxT( "MODULE::Flip() error: Unknown Draw Type" ) );
956  break;
957  }
958  }
959 
961 }
962 
963 
964 void MODULE::SetPosition( const wxPoint& newpos )
965 {
966  wxPoint delta = newpos - m_Pos;
967 
968  m_Pos += delta;
969 
970  m_Reference->EDA_TEXT::Offset( delta );
971  m_Value->EDA_TEXT::Offset( delta );
972 
973  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
974  {
975  pad->SetPosition( pad->GetPosition() + delta );
976  }
977 
978  for( EDA_ITEM* item = m_Drawings; item; item = item->Next() )
979  {
980  switch( item->Type() )
981  {
982  case PCB_MODULE_EDGE_T:
983  {
984  EDGE_MODULE* pt_edgmod = (EDGE_MODULE*) item;
985  pt_edgmod->SetDrawCoord();
986  break;
987  }
988 
989  case PCB_MODULE_TEXT_T:
990  {
991  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( item );
992  text->EDA_TEXT::Offset( delta );
993  break;
994  }
995 
996  default:
997  wxMessageBox( wxT( "Draw type undefined." ) );
998  break;
999  }
1000  }
1001 
1003 }
1004 
1005 
1006 void MODULE::MoveAnchorPosition( const wxPoint& aMoveVector )
1007 {
1008  /* Move the reference point of the footprint
1009  * the footprints elements (pads, outlines, edges .. ) are moved
1010  * but:
1011  * - the footprint position is not modified.
1012  * - the relative (local) coordinates of these items are modified
1013  * - Draw coordinates are updated
1014  */
1015 
1016 
1017  // Update (move) the relative coordinates relative to the new anchor point.
1018  wxPoint moveVector = aMoveVector;
1019  RotatePoint( &moveVector, -GetOrientation() );
1020 
1021  // Update of the reference and value.
1022  m_Reference->SetPos0( m_Reference->GetPos0() + moveVector );
1024  m_Value->SetPos0( m_Value->GetPos0() + moveVector );
1025  m_Value->SetDrawCoord();
1026 
1027  // Update the pad local coordinates.
1028  for( D_PAD* pad = Pads(); pad; pad = pad->Next() )
1029  {
1030  pad->SetPos0( pad->GetPos0() + moveVector );
1031  pad->SetDrawCoord();
1032  }
1033 
1034  // Update the draw element coordinates.
1035  for( EDA_ITEM* item = GraphicalItems(); item; item = item->Next() )
1036  {
1037  switch( item->Type() )
1038  {
1039  case PCB_MODULE_EDGE_T:
1040  {
1041  EDGE_MODULE* edge = static_cast<EDGE_MODULE*>( item );
1042  edge->m_Start0 += moveVector;
1043  edge->m_End0 += moveVector;
1044  edge->SetDrawCoord();
1045  break;
1046  }
1047 
1048  case PCB_MODULE_TEXT_T:
1049  {
1050  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( item );
1051  text->SetPos0( text->GetPos0() + moveVector );
1052  text->SetDrawCoord();
1053  break;
1054  }
1055 
1056  default:
1057  break;
1058  }
1059  }
1060 
1062 }
1063 
1064 
1065 void MODULE::SetOrientation( double newangle )
1066 {
1067  double angleChange = newangle - m_Orient; // change in rotation
1068 
1069  NORMALIZE_ANGLE_POS( newangle );
1070 
1071  m_Orient = newangle;
1072 
1073  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
1074  {
1075  pad->SetOrientation( pad->GetOrientation() + angleChange );
1076  pad->SetDrawCoord();
1077  }
1078 
1079  // Update of the reference and value.
1081  m_Value->SetDrawCoord();
1082 
1083  // Displace contours and text of the footprint.
1084  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
1085  {
1086  if( item->Type() == PCB_MODULE_EDGE_T )
1087  {
1088  static_cast<EDGE_MODULE*>( item )->SetDrawCoord();
1089  }
1090  else if( item->Type() == PCB_MODULE_TEXT_T )
1091  {
1092  static_cast<TEXTE_MODULE*>( item )->SetDrawCoord();
1093  }
1094  }
1095 
1097 }
1098 
1100  bool aIncrementPadNumbers,
1101  bool aAddToModule )
1102 {
1103  BOARD_ITEM* new_item = NULL;
1104  D_PAD* new_pad = NULL;
1105 
1106  switch( aItem->Type() )
1107  {
1108  case PCB_PAD_T:
1109  {
1110  new_pad = new D_PAD( *static_cast<const D_PAD*>( aItem ) );
1111 
1112  if( aAddToModule )
1113  Pads().PushBack( new_pad );
1114 
1115  new_item = new_pad;
1116  break;
1117  }
1118 
1119  case PCB_MODULE_TEXT_T:
1120  {
1121  const TEXTE_MODULE* old_text = static_cast<const TEXTE_MODULE*>( aItem );
1122 
1123  // do not duplicate value or reference fields
1124  // (there can only be one of each)
1125  if( old_text->GetType() == TEXTE_MODULE::TEXT_is_DIVERS )
1126  {
1127  TEXTE_MODULE* new_text = new TEXTE_MODULE( *old_text );
1128 
1129  if( aAddToModule )
1130  GraphicalItems().PushBack( new_text );
1131 
1132  new_item = new_text;
1133  }
1134  break;
1135  }
1136 
1137  case PCB_MODULE_EDGE_T:
1138  {
1139  EDGE_MODULE* new_edge = new EDGE_MODULE(
1140  *static_cast<const EDGE_MODULE*>(aItem) );
1141 
1142  if( aAddToModule )
1143  GraphicalItems().PushBack( new_edge );
1144 
1145  new_item = new_edge;
1146  break;
1147  }
1148 
1149  case PCB_MODULE_T:
1150  // Ignore the module itself
1151  break;
1152 
1153  default:
1154  // Un-handled item for duplication
1155  wxASSERT_MSG( false, "Duplication not supported for items of class "
1156  + aItem->GetClass() );
1157  break;
1158  }
1159 
1160  if( aIncrementPadNumbers && new_pad )
1161  {
1162  new_pad->IncrementPadName( true, true );
1163  }
1164 
1165  return new_item;
1166 }
1167 
1168 
1169 wxString MODULE::GetNextPadName( bool aFillSequenceGaps ) const
1170 {
1171  std::set<int> usedNumbers;
1172 
1173  // Create a set of used pad numbers
1174  for( D_PAD* pad = Pads(); pad; pad = pad->Next() )
1175  {
1176  int padNumber = getTrailingInt( pad->GetPadName() );
1177  usedNumbers.insert( padNumber );
1178  }
1179 
1180  const int nextNum = getNextNumberInSequence( usedNumbers, aFillSequenceGaps );
1181 
1182  return wxString::Format( wxT( "%i" ), nextNum );
1183 }
1184 
1185 
1187 {
1188  wxString prefix = GetReference();
1189 
1190  int strIndex = prefix.length() - 1;
1191  while( strIndex >= 0 )
1192  {
1193  const wxUniChar chr = prefix.GetChar( strIndex );
1194 
1195  // numeric suffix
1196  if( chr >= '0' && chr <= '9' )
1197  break;
1198 
1199  strIndex--;
1200  }
1201 
1202  prefix = prefix.Mid( 0, strIndex );
1203 
1204  return prefix;
1205 }
1206 
1207 
1209 {
1210  double padArea = 0.0;
1211  double moduleArea = GetFootprintRect().GetArea();
1212 
1213  for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
1214  padArea += pad->GetBoundingBox().GetArea();
1215 
1216  if( moduleArea == 0.0 )
1217  return 1.0;
1218 
1219  double ratio = padArea / moduleArea;
1220 
1221  return std::min( ratio, 1.0 );
1222 }
1223 
1224 // see convert_drawsegment_list_to_polygon.cpp:
1225 extern bool ConvertOutlineToPolygon( std::vector< DRAWSEGMENT* >& aSegList,
1226  SHAPE_POLY_SET& aPolygons, int aSegmentsByCircle,
1227  wxString* aErrorText);
1228 
1230 {
1233  // Build the courtyard area from graphic items on the courtyard.
1234  // Only PCB_MODULE_EDGE_T have meaning, graphic texts are ignored.
1235  // Collect items:
1236  std::vector< DRAWSEGMENT* > list_front;
1237  std::vector< DRAWSEGMENT* > list_back;
1238 
1239  for( BOARD_ITEM* item = GraphicalItems(); item; item = item->Next() )
1240  {
1241  if( item->GetLayer() == B_CrtYd && item->Type() == PCB_MODULE_EDGE_T )
1242  list_back.push_back( static_cast< DRAWSEGMENT* > ( item ) );
1243 
1244  if( item->GetLayer() == F_CrtYd && item->Type() == PCB_MODULE_EDGE_T )
1245  list_front.push_back( static_cast< DRAWSEGMENT* > ( item ) );
1246  }
1247 
1248  // Note: if no item found on courtyard layers, return true.
1249  // false is returned only when the shape defined on courtyard layers
1250  // is not convertible to a polygon
1251  if( !list_front.size() && !list_back.size() )
1252  return true;
1253 
1254  wxString error_msg;
1255 
1256  const int STEPS = 36; // for a segmentation of an arc of 360 degrees
1257  bool success = ConvertOutlineToPolygon( list_front, m_poly_courtyard_front,
1258  STEPS, &error_msg );
1259 
1260  if( success )
1261  success = ConvertOutlineToPolygon( list_back, m_poly_courtyard_back,
1262  STEPS, &error_msg );
1263 
1264  if( !error_msg.IsEmpty() )
1265  {
1266  error_msg.Prepend( GetReference() + ": " );
1267  wxLogMessage( error_msg );
1268  }
1269 
1270  return success;
1271 }
show modules on front
LIB_ID m_fpid
The LIB_ID of the MODULE.
Definition: class_module.h:670
Definition: colors.h:57
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu LAYER_IDs.
Definition: lset.cpp:638
void Add(BOARD_ITEM *aBoardItem, ADD_MODE aMode=ADD_INSERT) override
>
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:424
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
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...
BOX2< VECTOR2I > BOX2I
Definition: box2.h:468
void RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)
Function RunOnChildren.
bool IsMoving() const
Definition: base_struct.h:218
wxString GetReferencePrefix() const
Function GetReference prefix Gets the alphabetic prefix of the module reference - e...
void SetThermalGap(int aGap)
Definition: class_module.h:181
int m_CntRot90
Horizontal automatic placement cost ( 0..10 ).
Definition: class_module.h:686
int GetThermalGap() const
Definition: class_module.h:182
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
void Rotate(const wxPoint &aRotCentre, double aAngle) override
Function Rotate Rotate this object.
SHAPE_POLY_SET m_poly_courtyard_back
Definition: class_module.h:704
T * Remove(T *aElement)
Function Remove removes aElement from the list, but does not delete it.
Definition: dlist.h:211
PNG memory record (file in memory).
Definition: bitmap_types.h:38
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:290
void SetLocalClearance(int aClearance)
Definition: class_module.h:167
like PAD_STANDARD, but not plated mechanical use only, no connection allowed
Definition: pad_shapes.h:63
void PushFront(T *aNewElement)
Function PushFront puts aNewElement at front of list sequence.
Definition: dlist.h:240
wxString m_KeyWord
Search keywords to find module in library.
Definition: class_module.h:679
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible() Returns information about visibility of a particular layer.
Definition: view.h:404
wxString m_Path
Definition: class_module.h:680
This file is part of the common library.
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
int GetLocalClearance() const
Definition: class_module.h:166
int m_ThermalWidth
Definition: class_module.h:676
TEXT_TYPE GetType() const
int GetBiggestClearanceValue()
Function GetBiggestClearanceValue.
bool ConvertOutlineToPolygon(std::vector< DRAWSEGMENT * > &aSegList, SHAPE_POLY_SET &aPolygons, int aSegmentsByCircle, wxString *aErrorText)
Function ConvertOutlineToPolygon build a polygon (with holes) from a DRAWSEGMENT list, which is expected to be a outline, therefore a closed main outline with perhaps closed inner outlines.
bool Contains(const wxPoint &aPoint) const
Function Contains.
const wxPoint & GetPos0() const
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:695
void Flip(const wxPoint &aCentre) override
Function Flip Flip this object, i.e.
Class BOARD to handle a board.
const wxPoint & GetPosition() const override
Definition: class_module.h:143
Definition: colors.h:61
D_PAD * FindPadByName(const wxString &aPadName) const
Function FindPadByName returns a D_PAD* with a matching name.
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...
virtual void SetLayer(LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
int m_LocalSolderPasteMargin
Solder paste margin absolute value.
Definition: class_module.h:694
int m_ThermalGap
Definition: class_module.h:677
int GetHeight() const
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:76
void SetOrigin(const wxPoint &pos)
std::list< S3D_INFO > m_3D_Drawings
Linked list of 3D models.
Definition: class_module.h:665
void GRDrawAnchor(EDA_RECT *aClipBox, wxDC *aDC, int x, int y, int aSize, COLOR4D aColor)
Definition: gr_basic.cpp:1259
void SetZoneConnection(ZoneConnection aType)
Definition: class_module.h:175
wxString GetSelectMenuText() const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
MODULE(BOARD *parent)
class D_PAD, a pad in a footprint
Definition: typeinfo.h:102
static const wxChar * StringLibNameInvalidChars(bool aUserReadable)
static function StringLibNameInvalidChars Test for validity of the name in a library of the footprint...
EDA_ITEM * Next() const
Definition: base_struct.h:206
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
double m_Surface
Bounding box area.
Definition: class_module.h:684
ZoneConnection GetZoneConnection() const
Definition: class_module.h:176
time_t m_Link
Temporary logical link used in edition.
Definition: class_module.h:685
void NORMALIZE_ANGLE_POS(T &Angle)
Definition: trigo.h:222
void DeleteAll()
Function DeleteAll deletes all items on the list and leaves the list empty.
Definition: dlist.cpp:41
virtual wxString GetShownText() const override
Returns the string actually shown after processing of the base text.
VECTOR2< int > VECTOR2I
Definition: vector2d.h:590
LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
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:698
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_module.h:173
wxString GetLayerName() const
Function GetLayerName returns the name of the PCB layer on which the item resides.
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:106
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 ...
double GetLocalSolderPasteMarginRatio() const
Definition: class_module.h:172
DLIST< BOARD_ITEM > & GraphicalItems()
Definition: class_module.h:136
#define MODULE_PADS_LOCKED
In autoplace: module waiting for autoplace.
Definition: class_module.h:220
static const int delta[8][2]
Definition: solve.cpp:112
Casted dyn_cast(From aObject)
Function dyn_cast()
Definition: typeinfo.h:73
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:90
wxString m_Doc
File name and path for documentation file.
Definition: class_module.h:678
#define DIM_ANCRE_MODULE
Definition: pcbnew.h:59
wxPoint m_End0
This file contains miscellaneous commonly used macros and functions.
#define MODULE_is_PLACED
In autoplace: module automatically placed.
Definition: class_module.h:218
void PushBack(T *aNewElement)
Function PushBack puts aNewElement at the end of the list sequence.
Definition: dlist.h:250
void GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override
>
BOARD_ITEM * Next() const
COLOR4D GetItemColor(int aItemIdx) const
Function GetItemColor.
int m_LocalClearance
Definition: class_module.h:692
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:104
double m_Orient
Orientation in tenths of a degree, 900=90.0 degrees.
Definition: class_module.h:666
const wxPoint & GetOrigin() const
void MIRROR(T &aPoint, const T &aMirrorRef)
Definition: macros.h:111
class MODULE, a footprint
Definition: typeinfo.h:101
LAYER_ID m_Layer
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...
static int getTrailingInt(wxString aStr)
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1077
void Remove(BOARD_ITEM *aBoardItem) override
>
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
double GetArea() const
Function GetArea returns the area of the rectangle.
EDA_RECT m_BoundaryBox
Bounding box : coordinates on board, real orientation.
Definition: class_module.h:673
Class LSET is a set of LAYER_IDs.
double GetOrientationDegrees() const
Definition: class_module.h:148
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:213
double GetOrientation() const
Definition: class_module.h:147
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:41
Class SHAPE_POLY_SET.
Base window classes and related definitions.
EDA_RECT GetFootprintRect() const
Function GetFootprintRect() Returns the area of the module footprint excluding any text...
void SetEnd(int x, int y)
bool IsFlipped() const
function IsFlipped
Definition: class_module.h:214
virtual const BOX2I ViewBBox() const override
show modules references (when texts are visibles)
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
D_PAD * Next() const
Definition: class_pad.h:106
void SetThermalWidth(int aWidth)
Definition: class_module.h:178
int m_LocalSolderMaskMargin
Solder mask margin.
Definition: class_module.h:693
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:530
int m_arflag
Use to trace ratsnest and auto routing.
Definition: class_module.h:683
EDA_RECT * GetClipBox()
Common plot library Plot settings, and plotting engines (Postscript, Gerber, HPGL and DXF) ...
Definition: colors.h:60
void Flip(const wxPoint &aCentre) override
Flip entity during module flip.
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:703
virtual void SetPosition(const wxPoint &aPos) override
virtual unsigned int ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
void SetPosition(const wxPoint &aPos) override
int GetLocalSolderMaskMargin() const
Definition: class_module.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.
wxString GetNextPadName(bool aFillSequenceGaps) const
Function GetNextPadName returns the next available pad name in the module.
COLORS_DESIGN_SETTINGS g_ColorsSettings
Definition: pcbnew.cpp:68
bool IsLocked() const override
Function IsLocked.
Definition: class_module.h:223
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Operator assignment is used to assign the members of aItem to another object.
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_module.h:164
void SetPos0(const wxPoint &aPos)
static const int ORPHANED
Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) whe...
int GetLocalSolderPasteMargin() const
Definition: class_module.h:169
MODULE & operator=(const MODULE &aOther)
unsigned GetPadCount(INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
GetPadCount returns the number of pads.
default
Definition: class_module.h:75
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:105
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...
time_t m_LastEditTime
Definition: class_module.h:682
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
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:170
#define ITEM_GAL_LAYER(layer)
macro for obtaining layer number for specific item (eg. pad or text)
int m_CntRot180
Vertical automatic placement cost ( 0..10 ).
Definition: class_module.h:687
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.
void SetLocked(bool isLocked) override
Function SetLocked sets the MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: class_module.h:233
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
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:664
#define max(a, b)
Definition: auxiliary.h:86
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:166
LAYER_ID FlipLayer(LAYER_ID aLayerId, int aCopperLayersCount)
Function FlippedLayerNumber.
Definition: lset.cpp:444
const wxString & GetReference() const
Function GetReference.
Definition: class_module.h:411
int m_ModuleStatus
For autoplace: flags (LOCKED, AUTOPLACED)
Definition: class_module.h:672
void Move(const wxPoint &aMoveVector) override
Function Move move this object.
void SetOrientation(double newangle)
bool IsElementVisible(int aPCB_VISIBLE) const
Function IsElementVisible tests whether a given element category is visible.
Virtual component: when created by copper shapes on board (Like edge card connectors, mounting hole...)
Definition: class_module.h:78
double PadCoverageRatio() const
Function PadCoverageRatio Calculates the ratio of total area of the footprint pads to the area of the...
void Add3DModel(S3D_INFO *a3DModel)
Function Add3DModel adds a3DModel definition to the end of the 3D model list.
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_module.h:545
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.
TEXTE_MODULE * m_Value
Component value (74LS00, 22K..)
Definition: class_module.h:669
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
int GetWidth() const
wxPoint m_Pos
Position of module on the board in internal units.
Definition: class_module.h:667
UTF8 Format() const
Function Format.
Definition: lib_id.cpp:263
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
unsigned GetCount() const
Function GetCount returns the number of elements in the list.
Definition: dlist.h:126
TEXTE_MODULE * m_Reference
Component reference designator value (U34, R18..)
Definition: class_module.h:668
void CopyNetlistSettings(MODULE *aModule, bool aCopyLocalSettings)
Function CopyNetlistSettings copies the netlist settings to aModule.
DLIST< D_PAD > & Pads()
Definition: class_module.h:133
unsigned GetUniquePadCount(INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
GetUniquePadCount returns the number of unique pads.
Module description (excepted pads)
Definition: colors.h:45
Abstract interface for BOARD_ITEMs capable of storing other items inside.
wxPoint m_Start0
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:58
void StringPadName(wxString &text) const
Definition: class_pad.cpp:391
SEARCH_RESULT
Definition: base_struct.h:68
DLIST< D_PAD > m_Pads
Linked list of pads.
Definition: class_module.h:663
EDGE_MODULE class definition.
ZoneConnection m_ZoneConnection
Definition: class_module.h:681
Message panel definition file.
const wxSize & GetSize() const
INCLUDE_NPTH_T
Definition: class_module.h:61
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:69
void CopyNetlistSettings(D_PAD *aPad, bool aCopyLocalSettings)
Function CopyNetlistSettings copies the netlist settings to aPad, and the net name.
Definition: class_pad.cpp:435
int GetThermalWidth() const
Definition: class_module.h:179
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:125
show modules values (when texts are visibles)
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
#define min(a, b)
Definition: auxiliary.h:85
int m_Attributs
Flag bits ( see Mod_Attribut )
Definition: class_module.h:671
wxString m_Filename
The 3D shape filename in 3D library.
Definition: 3d_info.h:45
virtual const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
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