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-2017 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 
35 #include <list>
36 #include <dlist.h>
37 #include <layers_id_colors_and_visibility.h> // ALL_LAYERS definition.
38 #include <class_board_item.h>
39 #include <board_item_container.h>
40 #include <collectors.h>
41 #include <lib_id.h>
42 
43 #include <class_text_mod.h>
44 #include <PolyLine.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 EDA_DRAW_PANEL;
54 class D_PAD;
55 class BOARD;
56 class MSG_PANEL_ITEM;
57 
58 namespace KIGFX {
59 class VIEW;
60 }
61 
63 {
65  INCLUDE_NPTH = true
66 };
67 
75 {
77  MOD_CMS = 1,
78  MOD_VIRTUAL = 2
80 };
82 
84 {
85  public:
87  // Initialize with sensible values
88  m_Scale { 1, 1, 1 },
89  m_Rotation { 0, 0, 0 },
90  m_Offset { 0, 0, 0 }
91  {
92  }
93 
94  struct VECTOR3D
95  {
96  double x, y, z;
97  };
98 
102  wxString m_Filename;
103 };
104 
106 {
107 public:
108  MODULE( BOARD* parent );
109 
110  MODULE( const MODULE& aModule );
111 
112  ~MODULE();
113 
114  MODULE& operator=( const MODULE& aOther );
115 
116  static inline bool ClassOf( const EDA_ITEM* aItem )
117  {
118  return PCB_MODULE_T == aItem->Type();
119  }
120 
121  MODULE* Next() const { return static_cast<MODULE*>( Pnext ); }
122  MODULE* Back() const { return static_cast<MODULE*>( Pback ); }
123 
125  void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_INSERT ) override;
126 
128  void Remove( BOARD_ITEM* aItem ) override;
129 
137  void ClearAllNets();
138 
143  void CalculateBoundingBox();
144 
150  EDA_RECT GetFootprintRect() const;
151 
156  SHAPE_POLY_SET GetBoundingPoly() const;
157 
158  // Virtual function
159  const EDA_RECT GetBoundingBox() const override;
160 
161  DLIST<D_PAD>& PadsList() { return m_Pads; }
162  const DLIST<D_PAD>& PadsList() const { return m_Pads; }
163 
164  DLIST<BOARD_ITEM>& GraphicalItemsList() { return m_Drawings; }
165  const DLIST<BOARD_ITEM>& GraphicalItemsList() const { return m_Drawings; }
166 
168  {
169  return DLIST_ITERATOR_WRAPPER<D_PAD>( m_Pads );
170  }
171 
173  {
174  return DLIST_ITERATOR_WRAPPER<BOARD_ITEM>( m_Drawings );
175  }
176 
177  std::list<MODULE_3D_SETTINGS>& Models() { return m_3D_Drawings; }
178  const std::list<MODULE_3D_SETTINGS>& Models() const { return m_3D_Drawings; }
179 
180  void SetPosition( const wxPoint& aPos ) override;
181 
182  const wxPoint GetPosition() const override { return m_Pos; }
183 
184  void SetOrientation( double newangle );
185 
186  void SetOrientationDegrees( double aOrientation ) { SetOrientation( aOrientation * 10.0 ); }
187  double GetOrientation() const { return m_Orient; }
188  double GetOrientationDegrees() const { return m_Orient / 10.0; }
189  double GetOrientationRadians() const { return m_Orient * M_PI / 1800; }
190 
191  const LIB_ID& GetFPID() const { return m_fpid; }
192  void SetFPID( const LIB_ID& aFPID ) { m_fpid = aFPID; }
193 
194  const wxString& GetDescription() const { return m_Doc; }
195  void SetDescription( const wxString& aDoc ) { m_Doc = aDoc; }
196 
197  const wxString& GetKeywords() const { return m_KeyWord; }
198  void SetKeywords( const wxString& aKeywords ) { m_KeyWord = aKeywords; }
199 
200  const wxString& GetPath() const { return m_Path; }
201  void SetPath( const wxString& aPath ) { m_Path = aPath; }
202 
203  int GetLocalSolderMaskMargin() const { return m_LocalSolderMaskMargin; }
204  void SetLocalSolderMaskMargin( int aMargin ) { m_LocalSolderMaskMargin = aMargin; }
205 
206  int GetLocalClearance() const { return m_LocalClearance; }
207  void SetLocalClearance( int aClearance ) { m_LocalClearance = aClearance; }
208 
209  int GetLocalSolderPasteMargin() const { return m_LocalSolderPasteMargin; }
210  void SetLocalSolderPasteMargin( int aMargin ) { m_LocalSolderPasteMargin = aMargin; }
211 
212  double GetLocalSolderPasteMarginRatio() const { return m_LocalSolderPasteMarginRatio; }
213  void SetLocalSolderPasteMarginRatio( double aRatio ) { m_LocalSolderPasteMarginRatio = aRatio; }
214 
215  void SetZoneConnection( ZoneConnection aType ) { m_ZoneConnection = aType; }
216  ZoneConnection GetZoneConnection() const { return m_ZoneConnection; }
217 
218  void SetThermalWidth( int aWidth ) { m_ThermalWidth = aWidth; }
219  int GetThermalWidth() const { return m_ThermalWidth; }
220 
221  void SetThermalGap( int aGap ) { m_ThermalGap = aGap; }
222  int GetThermalGap() const { return m_ThermalGap; }
223 
224  int GetAttributes() const { return m_Attributs; }
225  void SetAttributes( int aAttributes ) { m_Attributs = aAttributes; }
226 
227  void SetFlag( int aFlag ) { m_arflag = aFlag; }
228  void IncrementFlag() { m_arflag += 1; }
229  int GetFlag() const { return m_arflag; }
230 
231  void Move( const wxPoint& aMoveVector ) override;
232 
233  void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
234 
235  void Flip( const wxPoint& aCentre ) override;
236 
248  void MoveAnchorPosition( const wxPoint& aMoveVector );
249 
254  bool IsFlipped() const { return GetLayer() == B_Cu; }
255 
256 // m_ModuleStatus bits:
257 #define MODULE_is_LOCKED 0x01
258 #define MODULE_is_PLACED 0x02
259 #define MODULE_to_PLACE 0x04
260 #define MODULE_PADS_LOCKED 0x08
261 
262 
263  bool IsLocked() const override
264  {
265  return ( m_ModuleStatus & MODULE_is_LOCKED ) != 0;
266  }
267 
273  void SetLocked( bool isLocked ) override
274  {
275  if( isLocked )
276  m_ModuleStatus |= MODULE_is_LOCKED;
277  else
278  m_ModuleStatus &= ~MODULE_is_LOCKED;
279  }
280 
281  bool IsPlaced() const { return m_ModuleStatus & MODULE_is_PLACED; }
282  void SetIsPlaced( bool isPlaced )
283  {
284  if( isPlaced )
285  m_ModuleStatus |= MODULE_is_PLACED;
286  else
287  m_ModuleStatus &= ~MODULE_is_PLACED;
288  }
289 
290  bool NeedsPlaced() const { return m_ModuleStatus & MODULE_to_PLACE; }
291  void SetNeedsPlaced( bool needsPlaced )
292  {
293  if( needsPlaced )
294  m_ModuleStatus |= MODULE_to_PLACE;
295  else
296  m_ModuleStatus &= ~MODULE_to_PLACE;
297  }
298 
299  bool PadsLocked() const { return m_ModuleStatus & MODULE_PADS_LOCKED; }
300 
301  void SetPadsLocked( bool aPadsLocked )
302  {
303  if( aPadsLocked )
304  m_ModuleStatus |= MODULE_PADS_LOCKED;
305  else
306  m_ModuleStatus &= ~MODULE_PADS_LOCKED;
307  }
308 
309  void SetLastEditTime( time_t aTime ) { m_LastEditTime = aTime; }
310  void SetLastEditTime() { m_LastEditTime = time( NULL ); }
311  time_t GetLastEditTime() const { return m_LastEditTime; }
312 
313  /* drawing functions */
314 
323  void Draw( EDA_DRAW_PANEL* aPanel,
324  wxDC* aDC,
325  GR_DRAWMODE aDrawMode,
326  const wxPoint& aOffset = ZeroOffset ) override;
327 
337  void DrawOutlinesWhenMoving( EDA_DRAW_PANEL* aPanel,
338  wxDC* aDC, const wxPoint& aMoveVector );
339 
363  void TransformPadsShapesWithClearanceToPolygon( PCB_LAYER_ID aLayer,
364  SHAPE_POLY_SET& aCornerBuffer,
365  int aInflateValue,
366  int aCircleToSegmentsCount,
367  double aCorrectionFactor,
368  bool aSkipNPTHPadsWihNoCopper = false ) const;
369 
390  void TransformGraphicShapesWithClearanceToPolygonSet( PCB_LAYER_ID aLayer,
391  SHAPE_POLY_SET& aCornerBuffer,
392  int aInflateValue,
393  int aCircleToSegmentsCount,
394  double aCorrectionFactor,
395  int aCircleToSegmentsCountForTexts = 0,
396  bool aIncludeText = true ) const;
397 
409  void TransformGraphicTextWithClearanceToPolygonSet( PCB_LAYER_ID aLayer,
410  SHAPE_POLY_SET& aCornerBuffer,
411  int aInflateValue,
412  int aCircleToSegmentsCount,
413  double aCorrectionFactor,
414  int aCircleToSegmentsCountForTexts = 0 ) const;
415 
424  void DrawEdgesOnly( EDA_DRAW_PANEL* panel, wxDC* DC, const wxPoint& offset,
425  GR_DRAWMODE draw_mode );
426 
433  void DrawAncre( EDA_DRAW_PANEL* panel, wxDC* DC,
434  const wxPoint& offset, int dim_ancre, GR_DRAWMODE draw_mode );
435 
437  void GetMsgPanelInfo( std::vector<MSG_PANEL_ITEM>& aList ) override;
438 
439  bool HitTest( const wxPoint& aPosition ) const override;
440 
450  bool HitTestAccurate( const wxPoint& aPosition ) const;
451 
452  bool HitTest( const EDA_RECT& aRect, bool aContained = true, int aAccuracy = 0 ) const override;
453 
458  const wxString& GetReference() const
459  {
460  return m_Reference->GetText();
461  }
462 
468  void SetReference( const wxString& aReference )
469  {
470  m_Reference->SetText( aReference );
471  }
472 
480  wxString GetReferencePrefix() const;
481 
486  const wxString& GetValue() const
487  {
488  return m_Value->GetText();
489  }
490 
495  void SetValue( const wxString& aValue )
496  {
497  m_Value->SetText( aValue );
498  }
499 
501  TEXTE_MODULE& Value() { return *m_Value; }
502  TEXTE_MODULE& Reference() { return *m_Reference; }
503 
505  TEXTE_MODULE& Value() const { return *m_Value; }
506  TEXTE_MODULE& Reference() const { return *m_Reference; }
507 
516  D_PAD* FindPadByName( const wxString& aPadName ) const;
517 
526  D_PAD* GetPad( const wxPoint& aPosition, LSET aLayerMask = LSET::AllLayersMask() );
527 
528  D_PAD* GetTopLeftPad();
529 
538  unsigned GetPadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
539 
552  unsigned GetUniquePadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
553 
562  wxString GetNextPadName( bool aFillSequenceGaps ) const;
563 
564  double GetArea() const { return m_Surface; }
565 
566  timestamp_t GetLink() const { return m_Link; }
567  void SetLink( timestamp_t aLink ) { m_Link = aLink; }
568 
569  int GetPlacementCost180() const { return m_CntRot180; }
570  void SetPlacementCost180( int aCost ) { m_CntRot180 = aCost; }
571 
572  int GetPlacementCost90() const { return m_CntRot90; }
573  void SetPlacementCost90( int aCost ) { m_CntRot90 = aCost; }
574 
580  BOARD_ITEM* Duplicate( const BOARD_ITEM* aItem,
581  bool aIncrementPadNumbers,
582  bool aAddToModule = false );
583 
590  void Add3DModel( MODULE_3D_SETTINGS* a3DModel );
591 
592  SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
593 
594  wxString GetClass() const override
595  {
596  return wxT( "MODULE" );
597  }
598 
599  wxString GetSelectMenuText() const override;
600 
601  BITMAP_DEF GetMenuImage() const override;
602 
603  EDA_ITEM* Clone() const override;
604 
611  void RunOnChildren( const std::function<void (BOARD_ITEM*)>& aFunction );
612 
613 
614  virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
615 
616  virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
617 
618  virtual const BOX2I ViewBBox() const override;
619 
636  void CopyNetlistSettings( MODULE* aModule, bool aCopyLocalSettings );
637 
645  static bool IsLibNameValid( const wxString& aName );
646 
655  static const wxChar* StringLibNameInvalidChars( bool aUserReadable );
656 
672  void SetInitialComments( wxArrayString* aInitialComments )
673  {
674  delete m_initial_comments;
675  m_initial_comments = aInitialComments;
676  }
677 
684  double CoverageRatio( const GENERAL_COLLECTOR& aCollector ) const;
685 
687  const wxArrayString* GetInitialComments() const { return m_initial_comments; }
688 
692  SHAPE_POLY_SET& GetPolyCourtyardFront() { return m_poly_courtyard_front; }
693  SHAPE_POLY_SET& GetPolyCourtyardBack() { return m_poly_courtyard_back; }
694 
702  bool BuildPolyCourtyard();
703 
704  virtual void SwapData( BOARD_ITEM* aImage ) override;
705 
706 #if defined(DEBUG)
707  virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
708 #endif
709 
710 private:
713  std::list<MODULE_3D_SETTINGS> m_3D_Drawings;
714  double m_Orient;
722 
723  // The final margin is the sum of these 2 values
726  wxString m_Doc;
727  wxString m_KeyWord;
728  wxString m_Path;
731  int m_arflag;
732  double m_Surface;
736 
737  // Local tolerances. When zero, this means the corresponding netclass value
738  // is used. Usually theses local tolerances zero, in deference to the
739  // corresponding netclass values.
744 
746  wxArrayString* m_initial_comments;
747 
753 };
754 
755 #endif // MODULE_H_
int GetFlag() const
Definition: class_module.h:229
LIB_ID m_fpid
The LIB_ID of the MODULE.
Definition: class_module.h:718
SHAPE_POLY_SET & GetPolyCourtyardFront()
Used in DRC to test the courtyard area (a complex polygon)
Definition: class_module.h:692
timestamp_t GetLink() const
Definition: class_module.h:566
#define MODULE_to_PLACE
In autoplace: module waiting for autoplace.
Definition: class_module.h:259
void SetPlacementCost90(int aCost)
Definition: class_module.h:573
KICAD_T Type() const
Function Type()
Definition: base_struct.h:227
long timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: base_struct.h:173
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
const DLIST< D_PAD > & PadsList() const
Definition: class_module.h:162
TEXTE_MODULE & Reference()
Definition: class_module.h:502
void SetThermalGap(int aGap)
Definition: class_module.h:221
int m_CntRot90
Horizontal automatic placement cost ( 0..10 ).
Definition: class_module.h:734
int GetThermalGap() const
Definition: class_module.h:222
time_t GetLastEditTime() const
Definition: class_module.h:311
void IncrementFlag()
Definition: class_module.h:228
SHAPE_POLY_SET m_poly_courtyard_back
Definition: class_module.h:752
PNG memory record (file in memory).
Definition: bitmap_types.h:41
void SetLocalClearance(int aClearance)
Definition: class_module.h:207
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:58
wxString m_KeyWord
Search keywords to find module in library.
Definition: class_module.h:727
wxString m_Path
Definition: class_module.h:728
void SetPlacementCost180(int aCost)
Definition: class_module.h:570
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 GetLocalClearance() const
Definition: class_module.h:206
int m_ThermalWidth
Definition: class_module.h:724
void SetInitialComments(wxArrayString *aInitialComments)
Function SetInitialComments takes ownership of caller&#39;s heap allocated aInitialComments block...
Definition: class_module.h:672
Classes BOARD_ITEM and BOARD_CONNECTED_ITEM.
double m_LocalSolderPasteMarginRatio
Solder mask margin ratio value of pad size.
Definition: class_module.h:743
ZoneConnection
How pads are covered by copper in zone.
Definition: zones.h:55
MODULE * Next() const
Definition: class_module.h:121
int m_LocalSolderPasteMargin
Solder paste margin absolute value.
Definition: class_module.h:742
int m_ThermalGap
Definition: class_module.h:725
DLIST_ITERATOR_WRAPPER< D_PAD > Pads()
Definition: class_module.h:167
void SetNeedsPlaced(bool needsPlaced)
Definition: class_module.h:291
Set for modules listed in the automatic insertion list (usually SMD footprints)
Definition: class_module.h:77
Class EDA_3D_CANVAS Implement a canvas based on a wxGLCanvas.
Definition: eda_3d_canvas.h:53
const wxString & GetValue() const
Function GetValue.
Definition: class_module.h:486
void SetZoneConnection(ZoneConnection aType)
Definition: class_module.h:215
void SetOrientationDegrees(double aOrientation)
Definition: class_module.h:186
bool NeedsPlaced() const
Definition: class_module.h:290
double m_Surface
Bounding box area.
Definition: class_module.h:732
ZoneConnection GetZoneConnection() const
Definition: class_module.h:216
int GetPlacementCost90() const
Definition: class_module.h:572
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
static wxString GetNextPadName(wxString aPadName)
Compute the &#39;next&#39; pad number for autoincrement aPadName is the last pad name used.
void SetLastEditTime(time_t aTime)
Definition: class_module.h:309
wxArrayString * m_initial_comments
leading s-expression comments in the module, lazily allocated only if needed for speed ...
Definition: class_module.h:746
void SetLocalSolderPasteMarginRatio(double aRatio)
Definition: class_module.h:213
double GetLocalSolderPasteMarginRatio() const
Definition: class_module.h:212
#define MODULE_PADS_LOCKED
In autoplace: module waiting for autoplace.
Definition: class_module.h:260
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
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:726
#define MODULE_is_PLACED
In autoplace: module automatically placed.
Definition: class_module.h:258
int m_LocalClearance
Definition: class_module.h:740
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:118
const LIB_ID & GetFPID() const
Definition: class_module.h:191
double m_Orient
Orientation in tenths of a degree, 900=90.0 degrees.
Definition: class_module.h:714
bool PadsLocked() const
Definition: class_module.h:299
DLIST_ITERATOR_WRAPPER< BOARD_ITEM > GraphicalItems()
Definition: class_module.h:172
class MODULE, a footprint
Definition: typeinfo.h:89
TEXTE_MODULE & Reference() const
Definition: class_module.h:506
PCB_LAYER_ID
A quick note on layer IDs:
EDA_RECT m_BoundaryBox
Bounding box : coordinates on board, real orientation.
Definition: class_module.h:721
Class LSET is a set of PCB_LAYER_IDs.
Footprint text class description.
double GetOrientationDegrees() const
Definition: class_module.h:188
void SetLink(timestamp_t aLink)
Definition: class_module.h:567
double GetOrientation() const
Definition: class_module.h:187
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
Class SHAPE_POLY_SET.
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:501
const std::list< MODULE_3D_SETTINGS > & Models() const
Definition: class_module.h:178
bool IsFlipped() const
function IsFlipped
Definition: class_module.h:254
timestamp_t m_Link
Temporary logical link used in edition.
Definition: class_module.h:733
static bool ClassOf(const EDA_ITEM *aItem)
Definition: class_module.h:116
void SetThermalWidth(int aWidth)
Definition: class_module.h:218
int m_LocalSolderMaskMargin
Solder mask margin.
Definition: class_module.h:741
std::list< MODULE_3D_SETTINGS > m_3D_Drawings
Linked list of 3D models.
Definition: class_module.h:713
int GetAttributes() const
Definition: class_module.h:224
int m_arflag
Use to trace ratsnest and auto routing.
Definition: class_module.h:731
const wxString & GetKeywords() const
Definition: class_module.h:197
static LSET AllLayersMask()
Definition: lset.cpp:710
MODULE_ATTR_T
Enum MODULE_ATTR_T is the set of attributes allowed within a MODULE, using MODULE::SetAttributes() an...
Definition: class_module.h:74
void SetPadsLocked(bool aPadsLocked)
Definition: class_module.h:301
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:468
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:751
void SetIsPlaced(bool isPlaced)
Definition: class_module.h:282
MODULE * Back() const
Definition: class_module.h:122
const DLIST< BOARD_ITEM > & GraphicalItemsList() const
Definition: class_module.h:165
int GetLocalSolderMaskMargin() const
Definition: class_module.h:203
bool IsLocked() const override
Function IsLocked.
Definition: class_module.h:263
double GetOrientationRadians() const
Definition: class_module.h:189
void SetLocalSolderMaskMargin(int aMargin)
Definition: class_module.h:204
int GetLocalSolderPasteMargin() const
Definition: class_module.h:209
wxString m_Filename
The 3D shape filename in 3D library.
Definition: class_module.h:102
default
Definition: class_module.h:76
std::unique_ptr< typename std::remove_const< T >::type > Clone(const T &aItem)
Definition: pns_item.h:380
time_t m_LastEditTime
Definition: class_module.h:730
void SetLocalSolderPasteMargin(int aMargin)
Definition: class_module.h:210
std::list< MODULE_3D_SETTINGS > & Models()
Definition: class_module.h:177
#define MODULE_is_LOCKED
module LOCKED: no autoplace allowed
Definition: class_module.h:257
TEXTE_MODULE & Value() const
The const versions to keep the compiler happy.
Definition: class_module.h:505
int m_CntRot180
Vertical automatic placement cost ( 0..10 ).
Definition: class_module.h:735
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:273
const wxString & GetDescription() const
Definition: class_module.h:194
VECTOR3D m_Rotation
3D model rotation (degrees)
Definition: class_module.h:100
DLIST< BOARD_ITEM > m_Drawings
Linked list of graphical items.
Definition: class_module.h:712
double GetArea() const
Definition: class_module.h:564
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
const wxString & GetReference() const
Function GetReference.
Definition: class_module.h:458
int m_ModuleStatus
For autoplace: flags (LOCKED, AUTOPLACED)
Definition: class_module.h:720
Virtual component: when created by copper shapes on board (Like edge card connectors, mounting hole...)
Definition: class_module.h:79
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:232
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_module.h:594
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void SetLastEditTime()
Definition: class_module.h:310
void SetValue(const wxString &aValue)
Function SetValue.
Definition: class_module.h:495
TEXTE_MODULE * m_Value
Component value (74LS00, 22K..)
Definition: class_module.h:717
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:180
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:715
static bool GetLayer(MODEL_VRML &aModel, LAYER_NUM layer, VRML_LAYER **vlayer)
void SetKeywords(const wxString &aKeywords)
Definition: class_module.h:198
DLIST< BOARD_ITEM > & GraphicalItemsList()
Definition: class_module.h:164
TEXTE_MODULE * m_Reference
Component reference designator value (U34, R18..)
Definition: class_module.h:716
DLIST< D_PAD > & PadsList()
Definition: class_module.h:161
SHAPE_POLY_SET & GetPolyCourtyardBack()
Definition: class_module.h:693
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:58
const wxString & GetPath() const
Definition: class_module.h:200
SEARCH_RESULT
Definition: base_struct.h:82
DLIST< D_PAD > m_Pads
Linked list of pads.
Definition: class_module.h:711
ZoneConnection m_ZoneConnection
Definition: class_module.h:729
const wxArrayString * GetInitialComments() const
Return the initial comments block or NULL if none, without transfer of ownership. ...
Definition: class_module.h:687
bool IsPlaced() const
Definition: class_module.h:281
INCLUDE_NPTH_T
Definition: class_module.h:62
void Flip(T &aValue)
int GetPlacementCost180() const
Definition: class_module.h:569
const wxPoint GetPosition() const override
Definition: class_module.h:182
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:192
void SetPath(const wxString &aPath)
Definition: class_module.h:201
int GetThermalWidth() const
Definition: class_module.h:219
void SetFlag(int aFlag)
Definition: class_module.h:227
void SetAttributes(int aAttributes)
Definition: class_module.h:225
int m_Attributs
Flag bits ( see Mod_Attribut )
Definition: class_module.h:719
void SetDescription(const wxString &aDoc)
Definition: class_module.h:195