KiCad PCB EDA Suite
class_module.h
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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2019 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
31 #ifndef MODULE_H_
32 #define MODULE_H_
33 
34 #include <deque>
35 
36 #include <board_item_container.h>
37 #include <class_board_item.h>
38 #include <collectors.h>
39 #include <convert_to_biu.h>
40 #include <layers_id_colors_and_visibility.h> // ALL_LAYERS definition.
41 #include <lib_id.h>
42 #include <list>
43 
44 #include <class_text_mod.h>
45 #include "zones.h"
46 
47 #include <core/iterators.h>
48 
49 #include <functional>
50 
51 class LINE_READER;
52 class EDA_3D_CANVAS;
53 class D_PAD;
54 class BOARD;
55 class MSG_PANEL_ITEM;
56 
57 namespace KIGFX {
58 class VIEW;
59 }
60 
62 {
64  INCLUDE_NPTH = true
65 };
66 
74 {
76  MOD_CMS = 1,
77  MOD_VIRTUAL = 2
79 };
81 
83 {
84  public:
86  // Initialize with sensible values
87  m_Scale { 1, 1, 1 },
88  m_Rotation { 0, 0, 0 },
89  m_Offset { 0, 0, 0 },
90  m_Preview( true )
91  {
92  }
93 
94  struct VECTOR3D
95  {
96  double x, y, z;
97  };
98 
102  wxString m_Filename;
103  bool m_Preview;
104 };
105 
106 DECL_DEQ_FOR_SWIG( PADS, D_PAD* )
107 DECL_DEQ_FOR_SWIG( DRAWINGS, BOARD_ITEM* )
108 DECL_DEQ_FOR_SWIG( MODULES, MODULE* )
109 
111 {
112 public:
113  MODULE( BOARD* parent );
114 
115  MODULE( const MODULE& aModule );
116 
117  ~MODULE();
118 
119  MODULE& operator=( const MODULE& aOther );
120 
121  static inline bool ClassOf( const EDA_ITEM* aItem )
122  {
123  return aItem && PCB_MODULE_T == aItem->Type();
124  }
125 
127  void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_INSERT ) override;
128 
130  void Remove( BOARD_ITEM* aItem ) override;
131 
139  void ClearAllNets();
140 
145  void CalculateBoundingBox();
146 
152  EDA_RECT GetFootprintRect() const;
153 
158  SHAPE_POLY_SET GetBoundingPoly() const;
159 
160  // Virtual function
161  const EDA_RECT GetBoundingBox() const override;
162 
163  PADS& Pads()
164  {
165  return m_pads;
166  }
167 
168  const PADS& Pads() const
169  {
170  return m_pads;
171  }
172 
173  DRAWINGS& GraphicalItems()
174  {
175  return m_drawings;
176  }
177 
178  const DRAWINGS& GraphicalItems() const
179  {
180  return m_drawings;
181  }
182 
183  std::list<MODULE_3D_SETTINGS>& Models() { return m_3D_Drawings; }
184  const std::list<MODULE_3D_SETTINGS>& Models() const { return m_3D_Drawings; }
185 
186  void SetPosition( const wxPoint& aPos ) override;
187 
188  const wxPoint GetPosition() const override { return m_Pos; }
189 
190  void SetOrientation( double newangle );
191 
192  void SetOrientationDegrees( double aOrientation ) { SetOrientation( aOrientation * 10.0 ); }
193  double GetOrientation() const { return m_Orient; }
194  double GetOrientationDegrees() const { return m_Orient / 10.0; }
195  double GetOrientationRadians() const { return m_Orient * M_PI / 1800; }
196 
197  const LIB_ID& GetFPID() const { return m_fpid; }
198  void SetFPID( const LIB_ID& aFPID ) { m_fpid = aFPID; }
199 
200  const wxString& GetDescription() const { return m_Doc; }
201  void SetDescription( const wxString& aDoc ) { m_Doc = aDoc; }
202 
203  const wxString& GetKeywords() const { return m_KeyWord; }
204  void SetKeywords( const wxString& aKeywords ) { m_KeyWord = aKeywords; }
205 
206  const wxString& GetPath() const { return m_Path; }
207  void SetPath( const wxString& aPath ) { m_Path = aPath; }
208 
209  int GetLocalSolderMaskMargin() const { return m_LocalSolderMaskMargin; }
210  void SetLocalSolderMaskMargin( int aMargin ) { m_LocalSolderMaskMargin = aMargin; }
211 
212  int GetLocalClearance() const { return m_LocalClearance; }
213  void SetLocalClearance( int aClearance ) { m_LocalClearance = aClearance; }
214 
215  int GetLocalSolderPasteMargin() const { return m_LocalSolderPasteMargin; }
216  void SetLocalSolderPasteMargin( int aMargin ) { m_LocalSolderPasteMargin = aMargin; }
217 
218  double GetLocalSolderPasteMarginRatio() const { return m_LocalSolderPasteMarginRatio; }
219  void SetLocalSolderPasteMarginRatio( double aRatio ) { m_LocalSolderPasteMarginRatio = aRatio; }
220 
221  void SetZoneConnection( ZoneConnection aType ) { m_ZoneConnection = aType; }
222  ZoneConnection GetZoneConnection() const { return m_ZoneConnection; }
223 
224  void SetThermalWidth( int aWidth ) { m_ThermalWidth = aWidth; }
225  int GetThermalWidth() const { return m_ThermalWidth; }
226 
227  void SetThermalGap( int aGap ) { m_ThermalGap = aGap; }
228  int GetThermalGap() const { return m_ThermalGap; }
229 
230  int GetAttributes() const { return m_Attributs; }
231  void SetAttributes( int aAttributes ) { m_Attributs = aAttributes; }
232 
233  void SetFlag( int aFlag ) { m_arflag = aFlag; }
234  void IncrementFlag() { m_arflag += 1; }
235  int GetFlag() const { return m_arflag; }
236 
237  // A bit of a hack until net ties are supported as first class citizens
238  bool IsNetTie() const { return GetKeywords().StartsWith( wxT( "net tie" ) ); }
239 
240  void Move( const wxPoint& aMoveVector ) override;
241 
242  void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
243 
244  void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;
245 
257  void MoveAnchorPosition( const wxPoint& aMoveVector );
258 
263  bool IsFlipped() const { return GetLayer() == B_Cu; }
264 
265 // m_ModuleStatus bits:
266 #define MODULE_is_LOCKED 0x01
267 #define MODULE_is_PLACED 0x02
268 #define MODULE_to_PLACE 0x04
269 #define MODULE_PADS_LOCKED 0x08
270 
271 
272  bool IsLocked() const override
273  {
274  return ( m_ModuleStatus & MODULE_is_LOCKED ) != 0;
275  }
276 
282  void SetLocked( bool isLocked ) override
283  {
284  if( isLocked )
285  m_ModuleStatus |= MODULE_is_LOCKED;
286  else
287  m_ModuleStatus &= ~MODULE_is_LOCKED;
288  }
289 
290  bool IsPlaced() const { return m_ModuleStatus & MODULE_is_PLACED; }
291  void SetIsPlaced( bool isPlaced )
292  {
293  if( isPlaced )
294  m_ModuleStatus |= MODULE_is_PLACED;
295  else
296  m_ModuleStatus &= ~MODULE_is_PLACED;
297  }
298 
299  bool NeedsPlaced() const { return m_ModuleStatus & MODULE_to_PLACE; }
300  void SetNeedsPlaced( bool needsPlaced )
301  {
302  if( needsPlaced )
303  m_ModuleStatus |= MODULE_to_PLACE;
304  else
305  m_ModuleStatus &= ~MODULE_to_PLACE;
306  }
307 
308  bool PadsLocked() const { return m_ModuleStatus & MODULE_PADS_LOCKED; }
309 
310  void SetPadsLocked( bool aPadsLocked )
311  {
312  if( aPadsLocked )
313  m_ModuleStatus |= MODULE_PADS_LOCKED;
314  else
315  m_ModuleStatus &= ~MODULE_PADS_LOCKED;
316  }
317 
318  void SetLastEditTime( timestamp_t aTime ) { m_LastEditTime = aTime; }
319  void SetLastEditTime() { m_LastEditTime = time( NULL ); }
320  timestamp_t GetLastEditTime() const { return m_LastEditTime; }
321 
322  /* drawing functions */
323 
331  void Print( PCB_BASE_FRAME* aFrame, wxDC* aDC, const wxPoint& aOffset = ZeroOffset ) override;
332 
351  void TransformPadsShapesWithClearanceToPolygon( PCB_LAYER_ID aLayer,
352  SHAPE_POLY_SET& aCornerBuffer, int aInflateValue, int aMaxError = ARC_HIGH_DEF,
353  bool aSkipNPTHPadsWihNoCopper = false ) const;
354 
368  void TransformGraphicShapesWithClearanceToPolygonSet( PCB_LAYER_ID aLayer,
369  SHAPE_POLY_SET& aCornerBuffer, int aInflateValue, int aError = ARC_HIGH_DEF,
370  bool aIncludeText = true ) const;
371 
382  void TransformGraphicTextWithClearanceToPolygonSet( PCB_LAYER_ID aLayer,
383  SHAPE_POLY_SET& aCornerBuffer, int aInflateValue, int aError = ARC_HIGH_DEF ) const;
384 
386  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector<MSG_PANEL_ITEM>& aList ) override;
387 
388  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
389 
399  bool HitTestAccurate( const wxPoint& aPosition, int aAccuracy = 0 ) const;
400 
401  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
402 
407  const wxString GetReference() const
408  {
409  return m_Reference->GetText();
410  }
411 
417  void SetReference( const wxString& aReference )
418  {
419  m_Reference->SetText( aReference );
420  }
421 
426  void IncrementReference( int aDelta );
427 
432  const wxString GetValue() const
433  {
434  return m_Value->GetText();
435  }
436 
441  void SetValue( const wxString& aValue )
442  {
443  m_Value->SetText( aValue );
444  }
445 
447  TEXTE_MODULE& Value() { return *m_Value; }
448  TEXTE_MODULE& Reference() { return *m_Reference; }
449 
451  TEXTE_MODULE& Value() const { return *m_Value; }
452  TEXTE_MODULE& Reference() const { return *m_Reference; }
453 
461  D_PAD* FindPadByName( const wxString& aPadName ) const;
462 
471  D_PAD* GetPad( const wxPoint& aPosition, LSET aLayerMask = LSET::AllLayersMask() );
472 
473  D_PAD* GetTopLeftPad();
474 
480  {
481  return m_pads.empty() ? nullptr : m_pads.front();
482  }
483 
492  unsigned GetPadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
493 
506  unsigned GetUniquePadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
507 
516  wxString GetNextPadName( bool aFillSequenceGaps ) const;
517 
518  double GetArea( int aPadding = 0 ) const;
519 
520  timestamp_t GetLink() const { return m_Link; }
521  void SetLink( timestamp_t aLink ) { m_Link = aLink; }
522 
523  int GetPlacementCost180() const { return m_CntRot180; }
524  void SetPlacementCost180( int aCost ) { m_CntRot180 = aCost; }
525 
526  int GetPlacementCost90() const { return m_CntRot90; }
527  void SetPlacementCost90( int aCost ) { m_CntRot90 = aCost; }
528 
534  BOARD_ITEM* Duplicate( const BOARD_ITEM* aItem,
535  bool aIncrementPadNumbers,
536  bool aAddToModule = false );
537 
544  void Add3DModel( MODULE_3D_SETTINGS* a3DModel );
545 
546  SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
547 
548  wxString GetClass() const override
549  {
550  return wxT( "MODULE" );
551  }
552 
553  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
554 
555  BITMAP_DEF GetMenuImage() const override;
556 
557  EDA_ITEM* Clone() const override;
558 
566  void RunOnChildren( const std::function<void (BOARD_ITEM*)>& aFunction );
567 
576  void GetAllDrawingLayers( int aLayers[], int& aCount, bool aIncludePads = true ) const;
577 
578  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
579 
580  virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
581 
582  virtual const BOX2I ViewBBox() const override;
583 
591  static bool IsLibNameValid( const wxString& aName );
592 
601  static const wxChar* StringLibNameInvalidChars( bool aUserReadable );
602 
617  void SetInitialComments( wxArrayString* aInitialComments )
618  {
619  delete m_initial_comments;
620  m_initial_comments = aInitialComments;
621  }
622 
629  double CoverageRatio( const GENERAL_COLLECTOR& aCollector ) const;
630 
632  const wxArrayString* GetInitialComments() const { return m_initial_comments; }
633 
637  SHAPE_POLY_SET& GetPolyCourtyardFront() { return m_poly_courtyard_front; }
638  SHAPE_POLY_SET& GetPolyCourtyardBack() { return m_poly_courtyard_back; }
639 
647  bool BuildPolyCourtyard();
648 
649  virtual void SwapData( BOARD_ITEM* aImage ) override;
650 
651 #if defined(DEBUG)
652  virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
653 #endif
654 
655 private:
656 
658  DRAWINGS m_drawings;
659 
661  PADS m_pads;
662 
663  std::list<MODULE_3D_SETTINGS> m_3D_Drawings;
664  double m_Orient;
665  wxPoint m_Pos;
672 
673  // The final margin is the sum of these 2 values
676  wxString m_Doc;
677  wxString m_KeyWord;
678  wxString m_Path;
681  int m_arflag;
685 
686  // Local tolerances. When zero, this means the corresponding netclass value
687  // is used. Usually theses local tolerances zero, in deference to the
688  // corresponding netclass values.
693 
695  wxArrayString* m_initial_comments;
696 
702 };
703 
704 #endif // MODULE_H_
LIB_ID m_fpid
The LIB_ID of the MODULE.
Definition: class_module.h:668
SHAPE_POLY_SET & GetPolyCourtyardFront()
Used in DRC to test the courtyard area (a complex polygon)
Definition: class_module.h:637
timestamp_t GetLastEditTime() const
Definition: class_module.h:320
const DRAWINGS & GraphicalItems() const
Definition: class_module.h:178
#define MODULE_to_PLACE
In autoplace: module waiting for autoplace.
Definition: class_module.h:268
void SetPlacementCost90(int aCost)
Definition: class_module.h:527
int GetAttributes() const
Definition: class_module.h:230
double GetOrientation() const
Definition: class_module.h:193
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
int GetPlacementCost90() const
Definition: class_module.h:526
TEXTE_MODULE & Reference()
Definition: class_module.h:448
void SetThermalGap(int aGap)
Definition: class_module.h:227
int m_CntRot90
Horizontal automatic placement cost ( 0..10 ).
Definition: class_module.h:683
void IncrementFlag()
Definition: class_module.h:234
SHAPE_POLY_SET m_poly_courtyard_back
Definition: class_module.h:701
void SetLocalClearance(int aClearance)
Definition: class_module.h:213
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:57
bool IsFlipped() const
function IsFlipped
Definition: class_module.h:263
wxString m_KeyWord
Search keywords to find module in library.
Definition: class_module.h:677
wxString m_Path
Definition: class_module.h:678
void SetPlacementCost180(int aCost)
Definition: class_module.h:524
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
int m_ThermalWidth
Definition: class_module.h:674
void SetInitialComments(wxArrayString *aInitialComments)
Function SetInitialComments takes ownership of caller's heap allocated aInitialComments block.
Definition: class_module.h:617
Classes BOARD_ITEM and BOARD_CONNECTED_ITEM.
double m_LocalSolderPasteMarginRatio
Solder mask margin ratio value of pad size.
Definition: class_module.h:692
bool IsPlaced() const
Definition: class_module.h:290
const std::list< MODULE_3D_SETTINGS > & Models() const
Definition: class_module.h:184
ZoneConnection
How pads are covered by copper in zone.
Definition: zones.h:50
int m_LocalSolderPasteMargin
Solder paste margin absolute value.
Definition: class_module.h:691
int m_ThermalGap
Definition: class_module.h:675
const wxString & GetPath() const
Definition: class_module.h:206
PADS & Pads()
Definition: class_module.h:163
void SetNeedsPlaced(bool needsPlaced)
Definition: class_module.h:300
const wxString GetValue() const
Function GetValue.
Definition: class_module.h:432
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:76
Implement a canvas based on a wxGLCanvas.
Definition: eda_3d_canvas.h:52
#define DECL_DEQ_FOR_SWIG(TypeName, MemberType)
Definition: macros.h:160
PADS m_pads
D_PAD items, owned by pointer.
Definition: class_module.h:661
void SetZoneConnection(ZoneConnection aType)
Definition: class_module.h:221
void SetOrientationDegrees(double aOrientation)
Definition: class_module.h:192
const LIB_ID & GetFPID() const
Definition: class_module.h:197
D_PAD * GetFirstPad() const
Gets the first pad in the list or NULL if none.
Definition: class_module.h:479
DRAWINGS & GraphicalItems()
Definition: class_module.h:173
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
int GetLocalSolderMaskMargin() const
Definition: class_module.h:209
bool m_Preview
Include module in 3D preview.
Definition: class_module.h:103
wxArrayString * m_initial_comments
leading s-expression comments in the module, lazily allocated only if needed for speed
Definition: class_module.h:695
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_module.h:219
#define MODULE_PADS_LOCKED
In autoplace: module waiting for autoplace.
Definition: class_module.h:269
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
timestamp_t GetLink() const
Definition: class_module.h:520
VECTOR3D m_Offset
3D model offset (mm)
Definition: class_module.h:101
wxString m_Doc
File name and path for documentation file.
Definition: class_module.h:676
timestamp_t m_LastEditTime
Definition: class_module.h:680
const wxString GetReference() const
Function GetReference.
Definition: class_module.h:407
#define MODULE_is_PLACED
In autoplace: module automatically placed.
Definition: class_module.h:267
int m_LocalClearance
Definition: class_module.h:689
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:108
double m_Orient
Orientation in tenths of a degree, 900=90.0 degrees.
Definition: class_module.h:664
bool IsNetTie() const
Definition: class_module.h:238
class MODULE, a footprint
Definition: typeinfo.h:89
PCB_LAYER_ID
A quick note on layer IDs:
EDA_RECT m_BoundaryBox
Bounding box : coordinates on board, real orientation.
Definition: class_module.h:671
Class LSET is a set of PCB_LAYER_IDs.
Footprint text class description.
int GetLocalClearance() const
Definition: class_module.h:212
void SetLink(timestamp_t aLink)
Definition: class_module.h:521
Class SHAPE_POLY_SET.
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:447
void SetLastEditTime(timestamp_t aTime)
Definition: class_module.h:318
timestamp_t m_Link
Temporary logical link used during editing.
Definition: class_module.h:682
static bool ClassOf(const EDA_ITEM *aItem)
Definition: class_module.h:121
void SetThermalWidth(int aWidth)
Definition: class_module.h:224
int m_LocalSolderMaskMargin
Solder mask margin.
Definition: class_module.h:690
std::list< MODULE_3D_SETTINGS > m_3D_Drawings
Linked list of 3D models.
Definition: class_module.h:663
double GetOrientationRadians() const
Definition: class_module.h:195
int m_arflag
Use to trace ratsnest and auto routing.
Definition: class_module.h:681
double GetOrientationDegrees() const
Definition: class_module.h:194
static LSET AllLayersMask()
Definition: lset.cpp:713
MODULE_ATTR_T
Enum MODULE_ATTR_T is the set of attributes allowed within a MODULE, using MODULE::SetAttributes() an...
Definition: class_module.h:73
void SetPadsLocked(bool aPadsLocked)
Definition: class_module.h:310
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:417
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:700
void SetIsPlaced(bool isPlaced)
Definition: class_module.h:291
bool NeedsPlaced() const
Definition: class_module.h:299
const wxArrayString * GetInitialComments() const
Return the initial comments block or NULL if none, without transfer of ownership.
Definition: class_module.h:632
bool IsLocked() const override
Function IsLocked.
Definition: class_module.h:272
const wxString & GetKeywords() const
Definition: class_module.h:203
DRAWINGS m_drawings
BOARD_ITEMs for drawings on the board, owned by pointer.
Definition: class_module.h:658
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_module.h:210
int GetLocalSolderPasteMargin() const
Definition: class_module.h:215
wxString m_Filename
The 3D shape filename in 3D library.
Definition: class_module.h:102
default
Definition: class_module.h:75
std::unique_ptr< typename std::remove_const< T >::type > Clone(const T &aItem)
Definition: pns_item.h:270
int GetPlacementCost180() const
Definition: class_module.h:523
const wxString & GetDescription() const
Definition: class_module.h:200
void SetLocalSolderPasteMargin(int aMargin)
Definition: class_module.h:216
double GetLocalSolderPasteMarginRatio() const
Definition: class_module.h:218
std::list< MODULE_3D_SETTINGS > & Models()
Definition: class_module.h:183
#define MODULE_is_LOCKED
module LOCKED: no autoplace allowed
Definition: class_module.h:266
int m_CntRot180
Vertical automatic placement cost ( 0..10 ).
Definition: class_module.h:684
Board layer functions and definitions.
void SetLocked(bool isLocked) override
Function SetLocked sets the MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: class_module.h:282
VECTOR3D m_Rotation
3D model rotation (degrees)
Definition: class_module.h:100
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
int GetFlag() const
Definition: class_module.h:235
int m_ModuleStatus
For autoplace: flags (LOCKED, AUTOPLACED)
Definition: class_module.h:670
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:240
const PADS & Pads() const
Definition: class_module.h:168
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_module.h:548
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void SetLastEditTime()
Definition: class_module.h:319
void SetValue(const wxString &aValue)
Function SetValue.
Definition: class_module.h:441
TEXTE_MODULE * m_Value
Component value (74LS00, 22K..)
Definition: class_module.h:667
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
TEXTE_MODULE & Reference() const
Definition: class_module.h:452
VECTOR3D m_Scale
3D model scaling factor (dimensionless)
Definition: class_module.h:99
wxPoint m_Pos
Position of module on the board in internal units.
Definition: class_module.h:665
static bool GetLayer(MODEL_VRML &aModel, LAYER_NUM layer, VRML_LAYER **vlayer)
bool PadsLocked() const
Definition: class_module.h:308
void SetKeywords(const wxString &aKeywords)
Definition: class_module.h:204
TEXTE_MODULE * m_Reference
Component reference designator value (U34, R18..)
Definition: class_module.h:666
uint32_t timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: common.h:50
SHAPE_POLY_SET & GetPolyCourtyardBack()
Definition: class_module.h:638
Abstract interface for BOARD_ITEMs capable of storing other items inside.
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:54
int GetThermalWidth() const
Definition: class_module.h:225
ZoneConnection m_ZoneConnection
Definition: class_module.h:679
INCLUDE_NPTH_T
Definition: class_module.h:61
void Flip(T &aValue)
const wxPoint GetPosition() const override
Definition: class_module.h:188
int GetThermalGap() const
Definition: class_module.h:228
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:198
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
void SetPath(const wxString &aPath)
Definition: class_module.h:207
EDA_UNITS_T
Definition: common.h:154
TEXTE_MODULE & Value() const
The const versions to keep the compiler happy.
Definition: class_module.h:451
void SetFlag(int aFlag)
Definition: class_module.h:233
ZoneConnection GetZoneConnection() const
Definition: class_module.h:222
void SetAttributes(int aAttributes)
Definition: class_module.h:231
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
int m_Attributs
Flag bits ( see Mod_Attribut )
Definition: class_module.h:669
void SetDescription(const wxString &aDoc)
Definition: class_module.h:201