KiCad PCB EDA Suite
class_board.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) 2007 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
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 
30 #ifndef CLASS_BOARD_H_
31 #define CLASS_BOARD_H_
32 
33 
34 #include <dlist.h>
35 #include <core/iterators.h>
36 
37 #include <common.h> // PAGE_INFO
39 #include <class_netinfo.h>
40 #include <class_pad.h>
43 #include <class_title_block.h>
44 #include <class_zone_settings.h>
45 #include <pcb_plot_params.h>
46 #include <board_item_container.h>
47 
48 #include <memory>
49 
50 using std::unique_ptr;
51 
52 class PCB_BASE_FRAME;
53 class PCB_EDIT_FRAME;
54 class PICKED_ITEMS_LIST;
55 class BOARD;
56 class ZONE_CONTAINER;
57 class SEGZONE;
58 class TRACK;
59 class D_PAD;
60 class MARKER_PCB;
61 class MSG_PANEL_ITEM;
62 class NETLIST;
63 class REPORTER;
64 class SHAPE_POLY_SET;
65 class CONNECTIVITY_DATA;
66 
71 enum LAYER_T
72 {
78 };
79 
80 
85 struct LAYER
86 {
88  {
89  clear();
90  }
91 
92  void clear()
93  {
94  m_type = LT_SIGNAL;
95  m_visible = true;
96  m_number = 0;
97  m_name.clear();
98  }
99 
100  /*
101  LAYER( const wxString& aName = wxEmptyString,
102  LAYER_T aType = LT_SIGNAL, bool aVisible = true, int aNumber = -1 ) :
103  m_name( aName ),
104  m_type( aType ),
105  m_visible( aVisible ),
106  m_number( aNumber )
107  {
108  }
109  */
110 
111  wxString m_name;
112 
114 
115  bool m_visible;
116 
117  int m_number;
118 
125  static const char* ShowType( LAYER_T aType );
126 
134  static LAYER_T ParseType( const char* aType );
135 };
136 
137 
138 // Helper class to handle high light nets
140 {
141  friend class BOARD;
142 
143 protected:
144  int m_netCode; // net selected for highlight (-1 when no net selected )
145  bool m_highLightOn; // highlight active
146 
147  void Clear()
148  {
149  m_netCode = -1;
150  m_highLightOn = false;
151  }
152 
154  {
155  Clear();
156  }
157 };
158 
159 
160 DECL_VEC_FOR_SWIG(MARKERS, MARKER_PCB*)
161 DECL_VEC_FOR_SWIG(ZONE_CONTAINERS, ZONE_CONTAINER*)
162 DECL_VEC_FOR_SWIG(TRACKS, TRACK*)
163 
164 
170 {
171  friend class PCB_EDIT_FRAME;
172 
173 private:
175  wxString m_fileName;
176 
178  MARKERS m_markers;
179 
181  ZONE_CONTAINERS m_ZoneDescriptorList;
182 
184 
185  // if true m_highLight_NetCode is used
186  HIGH_LIGHT_INFO m_highLight; // current high light data
187  HIGH_LIGHT_INFO m_highLightPrevious; // a previously stored high light data
188 
190 
191  std::shared_ptr<CONNECTIVITY_DATA> m_connectivity;
192 
200 
210  void chainMarkedSegments( wxPoint aPosition, const LSET& aLayerSet, TRACKS* aList );
211 
212  // The default copy constructor & operator= are inadequate,
213  // either write one or do not use it at all
214  BOARD( const BOARD& aOther ) :
215  BOARD_ITEM_CONTAINER( aOther ), m_NetInfo( this )
216  {
217  assert( false );
218  }
219 
220  BOARD& operator=( const BOARD& aOther )
221  {
222  assert( false );
223  return *this; // just to mute warning
224  }
225 
226 public:
227  static inline bool ClassOf( const EDA_ITEM* aItem )
228  {
229  return aItem && PCB_T == aItem->Type();
230  }
231 
232  void SetFileName( const wxString& aFileName ) { m_fileName = aFileName; }
233 
234  const wxString &GetFileName() const { return m_fileName; }
235 
238 
239 
240 private:
241  DLIST<BOARD_ITEM> m_Drawings; // linked list of lines & texts
242 
243 public:
244 
245  DLIST<MODULE> m_Modules; // linked list of MODULEs
246  DLIST<TRACK> m_Track; // linked list of TRACKs and VIAs
247  DLIST<SEGZONE> m_Zone; // linked list of SEGZONEs
248 
252  ZONE_CONTAINERS& Zones() { return m_ZoneDescriptorList; }
253 
254 
255  // will be deprecated as soon as append board functionality is fixed
256  DLIST<BOARD_ITEM>& DrawingsList() { return m_Drawings; }
257 
260 
261  BOARD();
262  ~BOARD();
263 
264  virtual const wxPoint& GetPosition() const override;
265 
266  virtual void SetPosition( const wxPoint& aPos ) override;
267 
268  bool IsEmpty() const
269  {
270  return m_Drawings.GetCount() == 0 && m_Modules.GetCount() == 0 &&
271  m_Track.GetCount() == 0 && m_Zone.GetCount() == 0;
272  }
273 
274  void Move( const wxPoint& aMoveVector ) override;
275 
276  void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
277  int GetFileFormatVersionAtLoad() const { return m_fileFormatVersionAtLoad; }
278 
279  void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_INSERT ) override;
280 
281  void Remove( BOARD_ITEM* aBoardItem ) override;
282 
283  BOARD_ITEM* Duplicate( const BOARD_ITEM* aItem, bool aAddToBoard = false );
284 
290  std::shared_ptr<CONNECTIVITY_DATA> GetConnectivity() const
291  {
292  return m_connectivity;
293  }
294 
300  void BuildConnectivity();
301 
302 
307  void DeleteMARKERs();
308 
313  void DeleteZONEOutlines();
314 
321  MARKER_PCB* GetMARKER( int index ) const
322  {
323  if( (unsigned) index < m_markers.size() )
324  return m_markers[index];
325 
326  return NULL;
327  }
328 
333  int GetMARKERCount() const
334  {
335  return (int) m_markers.size();
336  }
337 
342  void SetAuxOrigin( const wxPoint& aPoint ) { m_designSettings.m_AuxOrigin = aPoint; }
343  const wxPoint& GetAuxOrigin() const { return m_designSettings.m_AuxOrigin; }
344 
349  void SetGridOrigin( const wxPoint& aPoint ) { m_designSettings.m_GridOrigin = aPoint; }
350  const wxPoint& GetGridOrigin() const { return m_designSettings.m_GridOrigin; }
351 
357  {
358  m_highLight.Clear();
359  m_highLightPrevious.Clear();
360  }
361 
366  int GetHighLightNetCode() const { return m_highLight.m_netCode; }
367 
372  void SetHighLightNet( int aNetCode)
373  {
374  m_highLight.m_netCode = aNetCode;
375  }
376 
381  bool IsHighLightNetON() const { return m_highLight.m_highLightOn; }
382 
387  void HighLightOFF() { m_highLight.m_highLightOn = false; }
388 
394  void HighLightON() { m_highLight.m_highLightOn = true; }
395 
400  void PushHighLight();
401 
406  void PopHighLight();
407 
412  int GetCopperLayerCount() const;
413 
414  void SetCopperLayerCount( int aCount );
415 
422  LSET GetEnabledLayers() const;
423 
430  void SetEnabledLayers( LSET aLayerMask );
431 
439  bool IsLayerEnabled( PCB_LAYER_ID aLayer ) const
440  {
441  return m_designSettings.IsLayerEnabled( aLayer );
442  }
443 
451  bool IsLayerVisible( PCB_LAYER_ID aLayer ) const
452  {
453  return m_designSettings.IsLayerVisible( aLayer );
454  }
455 
462  LSET GetVisibleLayers() const;
463 
470  void SetVisibleLayers( LSET aLayerMask );
471 
472  // these 2 functions are not tidy at this time, since there are PCB_LAYER_IDs that
473  // are not stored in the bitmap.
474 
482  int GetVisibleElements() const;
483 
491  void SetVisibleElements( int aMask );
492 
498  void SetVisibleAlls();
499 
508  bool IsElementVisible( GAL_LAYER_ID LAYER_aPCB ) const;
509 
517  void SetElementVisibility( GAL_LAYER_ID LAYER_aPCB, bool aNewState );
518 
526  bool IsModuleLayerVisible( PCB_LAYER_ID layer );
527 
533  {
534  // remove const-ness with cast.
535  return (BOARD_DESIGN_SETTINGS&) m_designSettings;
536  }
537 
542  void SetDesignSettings( const BOARD_DESIGN_SETTINGS& aDesignSettings )
543  {
544  m_designSettings = aDesignSettings;
545  }
546 
547  const PAGE_INFO& GetPageSettings() const { return m_paper; }
548  void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
549 
550  const PCB_PLOT_PARAMS& GetPlotOptions() const { return m_plotOptions; }
551  void SetPlotOptions( const PCB_PLOT_PARAMS& aOptions ) { m_plotOptions = aOptions; }
552 
553  TITLE_BLOCK& GetTitleBlock() { return m_titles; }
554  void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
555 
556  const ZONE_SETTINGS& GetZoneSettings() const { return m_zoneSettings; }
557  void SetZoneSettings( const ZONE_SETTINGS& aSettings ) { m_zoneSettings = aSettings; }
558 
563  const COLORS_DESIGN_SETTINGS& Colors() const { return *m_colorsSettings; }
564 
569  void SetColorsSettings( COLORS_DESIGN_SETTINGS* aColorsSettings )
570  {
571  m_colorsSettings = aColorsSettings;
572  }
585  bool GetBoardPolygonOutlines( SHAPE_POLY_SET& aOutlines,
586  wxString* aErrorText = NULL );
587 
599  void ConvertBrdLayerToPolygonalContours( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aOutlines );
600 
611  const PCB_LAYER_ID GetLayerID( const wxString& aLayerName ) const;
612 
623  const wxString GetLayerName( PCB_LAYER_ID aLayer ) const;
624 
634  bool SetLayerName( PCB_LAYER_ID aLayer, const wxString& aLayerName );
635 
647  static wxString GetStandardLayerName( PCB_LAYER_ID aLayerId )
648  {
649  // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
650  return LSET::Name( aLayerId );
651  }
652 
661  bool SetLayerDescr( PCB_LAYER_ID aIndex, const LAYER& aLayer );
662 
671  LAYER_T GetLayerType( PCB_LAYER_ID aLayer ) const;
672 
681  bool SetLayerType( PCB_LAYER_ID aLayer, LAYER_T aLayerType );
682 
684  int GetNumSegmTrack() const;
685 
687  int GetNumSegmZone() const;
688 
693  unsigned GetNodesCount() const;
694 
699  unsigned GetUnconnectedNetCount() const;
700 
705  unsigned GetPadCount() const;
706 
711  D_PAD* GetPad( unsigned aIndex ) const;
712 
720  const std::vector<D_PAD*> GetPads();
721 
723  {
724  m_NetInfo.buildListOfNets();
725  }
726 
733  NETINFO_ITEM* FindNet( int aNetcode ) const;
734 
741  NETINFO_ITEM* FindNet( const wxString& aNetname ) const;
742 
744  {
745  return m_NetInfo;
746  }
747 
748 #ifndef SWIG
749 
754  {
755  return m_NetInfo.begin();
756  }
757 
763  {
764  return m_NetInfo.end();
765  }
766 #endif
767 
772  unsigned GetNetCount() const
773  {
774  return m_NetInfo.GetNetCount();
775  }
776 
783  EDA_RECT ComputeBoundingBox( bool aBoardEdgesOnly = false ) const;
784 
785  const EDA_RECT GetBoundingBox() const override
786  {
787  return ComputeBoundingBox( false );
788  }
789 
798  {
799  return ComputeBoundingBox( true );
800  }
801 
802  void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList ) override;
803 
812  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC,
813  GR_DRAWMODE aDrawMode, const wxPoint& aOffset = ZeroOffset ) override;
814 
824  void DrawHighLight( EDA_DRAW_PANEL* aDrawPanel, wxDC* aDC, int aNetCode );
825 
839  SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
840 
850  MODULE* FindModuleByReference( const wxString& aReference ) const;
851 
861  MODULE* FindModule( const wxString& aRefOrTimeStamp, bool aSearchByTimeStamp = false ) const;
862 
895  void ReplaceNetlist( NETLIST& aNetlist, bool aDeleteSinglePadNets,
896  std::vector<MODULE*>* aNewFootprints, REPORTER* aReporter = NULL );
897 
905  int SortedNetnamesList( wxArrayString& aNames, bool aSortbyPadsCount );
906 
914  void SynchronizeNetsAndNetClasses();
915 
916  /***************************************************************************/
917 
918  wxString GetClass() const override
919  {
920  return wxT( "BOARD" );
921  }
922 
923 #if defined(DEBUG)
924  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
925 #endif
926 
927 
928  /*************************/
929  /* Copper Areas handling */
930  /*************************/
931 
943  ZONE_CONTAINER* HitTestForAnyFilledArea( const wxPoint& aRefPos,
944  PCB_LAYER_ID aStartLayer,
945  PCB_LAYER_ID aEndLayer,
946  int aNetCode );
947 
952  void RedrawAreasOutlines( EDA_DRAW_PANEL* aPanel,
953  wxDC* aDC,
954  GR_DRAWMODE aDrawMode,
955  PCB_LAYER_ID aLayer );
956 
961  void RedrawFilledAreas( EDA_DRAW_PANEL* aPanel, wxDC* aDC, GR_DRAWMODE aDrawMode,
962  PCB_LAYER_ID aLayer );
963 
974  int SetAreasNetCodesFromNetNames( void );
975 
982  ZONE_CONTAINER* GetArea( int index ) const
983  {
984  if( (unsigned) index < m_ZoneDescriptorList.size() )
985  return m_ZoneDescriptorList[index];
986 
987  return NULL;
988  }
989 
996  int GetAreaIndex( const ZONE_CONTAINER* aArea ) const
997  {
998  for( int ii = 0; ii < GetAreaCount(); ii++ ) // Search for aArea in list
999  {
1000  if( aArea == GetArea( ii ) ) // Found !
1001  return ii;
1002  }
1003 
1004  return -1;
1005  }
1006 
1011  int GetAreaCount() const
1012  {
1013  return (int) m_ZoneDescriptorList.size();
1014  }
1015 
1016  /* Functions used in test, merge and cut outlines */
1017 
1029  ZONE_CONTAINER* AddArea( PICKED_ITEMS_LIST* aNewZonesList, int aNetcode,
1030  PCB_LAYER_ID aLayer, wxPoint aStartPointPosition, int aHatch );
1031 
1042  ZONE_CONTAINER* InsertArea( int aNetcode, int aAreaIdx, PCB_LAYER_ID aLayer,
1043  int aCornerX, int aCornerY, int aHatch );
1044 
1054  bool NormalizeAreaPolygon( PICKED_ITEMS_LIST* aNewZonesList, ZONE_CONTAINER* aCurrArea );
1055 
1066  bool OnAreaPolygonModified( PICKED_ITEMS_LIST* aModifiedZonesList,
1067  ZONE_CONTAINER* modified_area );
1068 
1079  bool CombineAllAreasInNet( PICKED_ITEMS_LIST* aDeletedList,
1080  int aNetCode,
1081  bool aUseLocalFlags );
1082 
1090  void RemoveArea( PICKED_ITEMS_LIST* aDeletedList, ZONE_CONTAINER* area_to_remove );
1091 
1097  bool TestAreaIntersections( ZONE_CONTAINER* area_to_test );
1098 
1107  bool TestAreaIntersection( ZONE_CONTAINER* area_ref, ZONE_CONTAINER* area_to_test );
1108 
1120  bool CombineAreas( PICKED_ITEMS_LIST* aDeletedList,
1121  ZONE_CONTAINER* area_ref,
1122  ZONE_CONTAINER* area_to_combine );
1123 
1135  int Test_Drc_Areas_Outlines_To_Areas_Outlines( ZONE_CONTAINER* aArea_To_Examine,
1136  bool aCreate_Markers );
1137 
1138 
1151  VIA* GetViaByPosition( const wxPoint& aPosition,
1152  PCB_LAYER_ID aLayer = PCB_LAYER_ID( -1 ) ) const;
1153 
1162  std::list<TRACK*> GetTracksByPosition( const wxPoint& aPosition, PCB_LAYER_ID aLayer = PCB_LAYER_ID( -1 ) ) const;
1163 
1172  D_PAD* GetPad( const wxPoint& aPosition, LSET aLayerMask );
1173  D_PAD* GetPad( const wxPoint& aPosition )
1174  {
1175  return GetPad( aPosition, LSET().set() );
1176  }
1177 
1186  D_PAD* GetPad( TRACK* aTrace, ENDPOINT_T aEndPoint );
1187 
1198  D_PAD* GetPadFast( const wxPoint& aPosition, LSET aLayerMask );
1199 
1215  D_PAD* GetPad( std::vector<D_PAD*>& aPadList, const wxPoint& aPosition, LSET aLayerMask );
1216 
1223  void PadDelete( D_PAD* aPad );
1224 
1237  void GetSortedPadListByXthenYCoord( std::vector<D_PAD*>& aVector, int aNetCode = -1 );
1238 
1252  TRACK* GetVisibleTrack( TRACK* aStartingTrace, const wxPoint& aPosition, LSET aLayerSet ) const;
1253 
1278  TRACK* MarkTrace( TRACK* aTrace, int* aCount, double* aTraceLength,
1279  double* aInPackageLength, bool aReorder );
1280 
1288  TRACKS TracksInNet( int aNetCode );
1289 
1307  TRACKS TracksInNetBetweenPoints( const wxPoint& aStartPos, const wxPoint& aGoalPos, int aNetCode );
1308 
1323  MODULE* GetFootprint( const wxPoint& aPosition, PCB_LAYER_ID aActiveLayer,
1324  bool aVisibleOnly, bool aIgnoreLocked = false );
1325 
1339  BOARD_CONNECTED_ITEM* GetLockPoint( const wxPoint& aPosition, LSET aLayerMask );
1340 
1358  TRACK* CreateLockPoint( wxPoint& aPosition, TRACK* aSegment, PICKED_ITEMS_LIST* aList );
1359 };
1360 
1361 #endif // CLASS_BOARD_H_
void SetColorsSettings(COLORS_DESIGN_SETTINGS *aColorsSettings)
Function SetColorsSettings.
Definition: class_board.h:569
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair
void SetFileFormatVersionAtLoad(int aVersion)
Definition: class_board.h:276
D_PAD * GetPad(const wxPoint &aPosition)
Definition: class_board.h:1173
void BuildListOfNets()
Definition: class_board.h:722
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
Definition: class_board.h:785
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:78
NETINFO_LIST::iterator BeginNets() const
Function BeginNets.
Definition: class_board.h:753
void SetZoneSettings(const ZONE_SETTINGS &aSettings)
Definition: class_board.h:557
MARKER_PCB * GetMARKER(int index) const
Function GetMARKER returns the MARKER at a given index.
Definition: class_board.h:321
void SetElementVisibility(GAL_LAYER_ID aElement, bool aNewState)
Function SetElementVisibility changes the visibility of an element category.
Definition: pcbframe.cpp:939
static bool ClassOf(const EDA_ITEM *aItem)
Definition: class_board.h:227
const ZONE_SETTINGS & GetZoneSettings() const
Definition: class_board.h:556
Definition: typeinfo.h:97
wxPoint m_GridOrigin
origin for grid offsets
void SetGridOrigin(const wxPoint &aPoint)
Function SetGridOrigin sets the origin point of the grid.
Definition: class_board.h:349
BOARD(const BOARD &aOther)
Definition: class_board.h:214
wxString m_name
The name of the layer, there should be no spaces in this name.
Definition: class_board.h:111
const wxPoint & GetGridOrigin() const
Definition: class_board.h:350
wxString m_fileName
the board filename
Definition: class_board.h:175
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: class_board.h:554
PAGE_INFO m_paper
Definition: class_board.h:196
DLIST< BOARD_ITEM > & DrawingsList()
Definition: class_board.h:256
bool IsLayerEnabled(PCB_LAYER_ID aLayer) const
Function IsLayerEnabled is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:439
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: class_board.h:548
LAYER_T m_type
The type of the layer.
Definition: class_board.h:113
COLORS_DESIGN_SETTINGS * m_colorsSettings
Definition: class_board.h:195
bool IsLayerEnabled(PCB_LAYER_ID aLayerId) const
Function IsLayerEnabled tests whether a given layer is enabled.
void ResetHighLight()
Function ResetHighLight Reset all high light data to the init state.
Definition: class_board.h:356
ZONE_CONTAINER * m_CurrentZoneContour
zone contour currently in progress
Definition: class_board.h:259
unsigned GetNetCount() const
Function GetNetCount.
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
void HighLightOFF()
Function HighLightOFF Disable highlight.
Definition: class_board.h:387
LAYER()
Definition: class_board.h:87
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
BOARD & operator=(const BOARD &aOther)
Definition: class_board.h:220
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:186
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
bool IsLayerVisible(PCB_LAYER_ID aLayerId) const
Function IsLayerVisible tests whether a given layer is visible.
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
HIGH_LIGHT_INFO m_highLightPrevious
Definition: class_board.h:187
NETINFO_LIST::iterator EndNets() const
Function EndNets.
Definition: class_board.h:762
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot, printout, or editing view.
Class BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected an...
PCB_PLOT_PARAMS m_plotOptions
Definition: class_board.h:198
void SetVisibleAlls()
Function SetVisibleAlls Set the status of all visible element categories and layers to VISIBLE...
Definition: pcbframe.cpp:947
void SetAuxOrigin(const wxPoint &aPoint)
Function SetAuxOrigin sets the origin point used for plotting.
Definition: class_board.h:342
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:90
ENDPOINT_T
Flag used in locate routines (from which endpoint work)
Definition: pcbnew.h:54
static const char * ShowType(LAYER_T aType)
Function ShowType converts a LAYER_T enum to a const char*.
const EDA_RECT GetBoardEdgesBoundingBox() const
Function GetBoardEdgesBoundingBox Returns the board bounding box calculated using exclusively the boa...
Definition: class_board.h:797
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:104
ZONE_SETTINGS m_zoneSettings
Definition: class_board.h:194
bool IsElementVisible(GAL_LAYER_ID aElement) const
Function IsElementVisible tests whether a given element category is visible.
Definition: pcbframe.cpp:933
PCB_LAYER_ID
A quick note on layer IDs:
Class LSET is a set of PCB_LAYER_IDs.
Class NETLIST stores all of information read from a netlist along with the flags used to update the N...
Definition: pcb_netlist.h:205
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:250
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Function Name returns the fixed name association with aLayerId.
Definition: lset.cpp:73
Class NETINFO_LIST is a container class for NETINFO_ITEM elements, which are the nets.
const wxString & GetFileName() const
Definition: class_board.h:234
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:41
Class SHAPE_POLY_SET.
const COLORS_DESIGN_SETTINGS & Colors() const
Function GetColorSettings.
Definition: class_board.h:563
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
bool IsEmpty() const
Definition: class_board.h:268
LAYER_T
Enum LAYER_T gives the allowed types of layers, same as Specctra DSN spec.
Definition: class_board.h:71
TITLE_BLOCK m_titles
text in lower right of screen and plots
Definition: class_board.h:197
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: class_board.h:550
bool m_visible
Definition: class_board.h:115
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:532
#define DECL_VEC_FOR_SWIG(TypeName, MemberType)
Declare a std::vector but no swig template.
Definition: macros.h:146
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:241
void SetDesignSettings(const BOARD_DESIGN_SETTINGS &aDesignSettings)
Function SetDesignSettings.
Definition: class_board.h:542
void SetPosition(wxString aStr, wxString aDefaultMeasurementUnit, int *aX, int *aY, wxString aActualConversion)
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1011
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:178
void SetFileName(const wxString &aFileName)
Definition: class_board.h:232
void SetPlotOptions(const PCB_PLOT_PARAMS &aOptions)
Definition: class_board.h:551
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
static LAYER_T ParseType(const char *aType)
Function ParseType converts a string to a LAYER_T.
Class PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board...
NETINFO_LIST & GetNetInfo()
Definition: class_board.h:743
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:547
Pad object description.
int GetFileFormatVersionAtLoad() const
Definition: class_board.h:277
void HighLightON()
Function HighLightON Enable highlight.
Definition: class_board.h:394
Class ZONE_SETTINGS handles zones parameters.
const wxPoint & GetAuxOrigin() const
Definition: class_board.h:343
void SetHighLightNet(int aNetCode)
Function SetHighLightNet.
Definition: class_board.h:372
void clear()
Definition: class_board.h:92
Class NETINFO_ITEM handles the data for a net.
Definition: class_netinfo.h:69
iterator begin() const
ZONE_CONTAINERS & Zones()
Definition: class_board.h:252
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:553
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:982
Board layer functions and definitions.
int m_fileFormatVersionAtLoad
the version loaded from the file
Definition: class_board.h:189
iterator end() const
Class LAYER holds information pertinent to a layer of a BOARD.
Definition: class_board.h:85
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
Class ZONE_SETTINGS used to handle zones parameters in dialogs.
DLIST< MODULE > m_Modules
Definition: class_board.h:245
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:191
Class EDA_RECT handles the component boundary box.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
The common library.
wxString GetClass() const override
Function GetClass returns the class name.
Definition: class_board.h:918
Class COLORS_DESIGN_SETTINGS is a list of color settings for designs in Pcbnew.
unsigned GetCount() const
Function GetCount returns the number of elements in the list.
Definition: dlist.h:126
bool IsHighLightNetON() const
Function IsHighLightNetON.
Definition: class_board.h:381
DLIST_ITERATOR_WRAPPER< TRACK > Tracks()
Definition: class_board.h:249
int GetHighLightNetCode() const
Function GetHighLightNetCode.
Definition: class_board.h:366
DLIST< TRACK > m_Track
Definition: class_board.h:246
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:193
Abstract interface for BOARD_ITEMs capable of storing other items inside.
int m_number
Definition: class_board.h:117
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
SEARCH_RESULT
Definition: base_struct.h:68
Handle colors used to draw all items or layers.
int GetAreaIndex(const ZONE_CONTAINER *aArea) const
Function GetAreaIndex returns the Area Index for the given Zone Container.
Definition: class_board.h:996
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:290
wxPoint m_AuxOrigin
origin for plot exports
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
void buildListOfNets()
Function buildListOfNets builds or rebuilds the list of NETINFO_ITEMs The list is sorted by names...
DLIST_ITERATOR_WRAPPER< BOARD_ITEM > Drawings()
Definition: class_board.h:251
int GetMARKERCount() const
Function GetMARKERCount.
Definition: class_board.h:333
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:772
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:647
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:451
int m_Status_Pcb
Flags used in ratsnest calculation and update.
Definition: class_board.h:237