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 <netinfo.h>
40 #include <class_pad.h>
41 #include <colors_design_settings.h>
42 #include <board_design_settings.h>
43 #include <title_block.h>
44 #include <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 class COMPONENT;
67 
72 enum LAYER_T
73 {
79 };
80 
81 
86 struct LAYER
87 {
89  {
90  clear();
91  }
92 
93  void clear()
94  {
95  m_type = LT_SIGNAL;
96  m_visible = true;
97  m_number = 0;
98  m_name.clear();
99  }
100 
101  /*
102  LAYER( const wxString& aName = wxEmptyString,
103  LAYER_T aType = LT_SIGNAL, bool aVisible = true, int aNumber = -1 ) :
104  m_name( aName ),
105  m_type( aType ),
106  m_visible( aVisible ),
107  m_number( aNumber )
108  {
109  }
110  */
111 
112  wxString m_name;
113 
115 
116  bool m_visible;
117 
118  int m_number;
119 
126  static const char* ShowType( LAYER_T aType );
127 
135  static LAYER_T ParseType( const char* aType );
136 };
137 
138 
139 // Helper class to handle high light nets
141 {
142  friend class BOARD;
143 
144 protected:
145  int m_netCode; // net selected for highlight (-1 when no net selected )
146  bool m_highLightOn; // highlight active
147 
148  void Clear()
149  {
150  m_netCode = -1;
151  m_highLightOn = false;
152  }
153 
155  {
156  Clear();
157  }
158 };
159 
160 
161 DECL_VEC_FOR_SWIG(MARKERS, MARKER_PCB*)
162 DECL_VEC_FOR_SWIG(ZONE_CONTAINERS, ZONE_CONTAINER*)
163 DECL_VEC_FOR_SWIG(TRACKS, TRACK*)
164 
165 
166 
171 {
172  friend class PCB_EDIT_FRAME;
173 
174 private:
176  wxString m_fileName;
177 
179  MARKERS m_markers;
180 
182  ZONE_CONTAINERS m_ZoneDescriptorList;
183 
185 
186  // if true m_highLight_NetCode is used
187  HIGH_LIGHT_INFO m_highLight; // current high light data
188  HIGH_LIGHT_INFO m_highLightPrevious; // a previously stored high light data
189 
191 
192  std::shared_ptr<CONNECTIVITY_DATA> m_connectivity;
193 
201 
212  void chainMarkedSegments( TRACK* aTrackList, wxPoint aPosition,
213  const LSET& aLayerSet, TRACKS* aList );
214 
215  // The default copy constructor & operator= are inadequate,
216  // either write one or do not use it at all
217  BOARD( const BOARD& aOther ) :
218  BOARD_ITEM_CONTAINER( aOther ), m_NetInfo( this )
219  {
220  assert( false );
221  }
222 
223  BOARD& operator=( const BOARD& aOther )
224  {
225  assert( false );
226  return *this; // just to mute warning
227  }
228 
229 public:
230  static inline bool ClassOf( const EDA_ITEM* aItem )
231  {
232  return aItem && PCB_T == aItem->Type();
233  }
234 
235  void SetFileName( const wxString& aFileName ) { m_fileName = aFileName; }
236 
237  const wxString &GetFileName() const { return m_fileName; }
238 
241 
242 
243 private:
244  DLIST<BOARD_ITEM> m_Drawings; // linked list of lines & texts
245 
246 public:
247 
248  DLIST<MODULE> m_Modules; // linked list of MODULEs
249  DLIST<TRACK> m_Track; // linked list of TRACKs and VIAs
250  DLIST<SEGZONE> m_SegZoneDeprecated; // linked list of SEGZONEs, for really very old boards
251  // should be removed one day
252 
256  ZONE_CONTAINERS& Zones() { return m_ZoneDescriptorList; }
257  const std::vector<BOARD_CONNECTED_ITEM*> AllConnectedItems();
258 
259  // will be deprecated as soon as append board functionality is fixed
260  DLIST<BOARD_ITEM>& DrawingsList() { return m_Drawings; }
261 
264 
265  BOARD();
266  ~BOARD();
267 
268  virtual const wxPoint GetPosition() const override;
269 
270  virtual void SetPosition( const wxPoint& aPos ) override;
271 
272  bool IsEmpty() const
273  {
274  return m_Drawings.GetCount() == 0 && m_Modules.GetCount() == 0 &&
275  m_Track.GetCount() == 0 && m_SegZoneDeprecated.GetCount() == 0;
276  }
277 
278  void Move( const wxPoint& aMoveVector ) override;
279 
280  void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
281  int GetFileFormatVersionAtLoad() const { return m_fileFormatVersionAtLoad; }
282 
283  void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_INSERT ) override;
284 
285  void Remove( BOARD_ITEM* aBoardItem ) override;
286 
287  BOARD_ITEM* GetItem( void* aWeakReference );
288 
289  BOARD_ITEM* Duplicate( const BOARD_ITEM* aItem, bool aAddToBoard = false );
290 
296  std::shared_ptr<CONNECTIVITY_DATA> GetConnectivity() const
297  {
298  return m_connectivity;
299  }
300 
306  void BuildConnectivity();
307 
308 
313  void DeleteMARKERs();
314 
319  void DeleteZONEOutlines();
320 
327  MARKER_PCB* GetMARKER( int index ) const
328  {
329  if( (unsigned) index < m_markers.size() )
330  return m_markers[index];
331 
332  return NULL;
333  }
334 
339  int GetMARKERCount() const
340  {
341  return (int) m_markers.size();
342  }
343 
348  void SetAuxOrigin( const wxPoint& aPoint ) { m_designSettings.m_AuxOrigin = aPoint; }
349  const wxPoint& GetAuxOrigin() const { return m_designSettings.m_AuxOrigin; }
350 
355  void SetGridOrigin( const wxPoint& aPoint ) { m_designSettings.m_GridOrigin = aPoint; }
356  const wxPoint& GetGridOrigin() const { return m_designSettings.m_GridOrigin; }
357 
363  {
364  m_highLight.Clear();
365  m_highLightPrevious.Clear();
366  }
367 
372  int GetHighLightNetCode() const { return m_highLight.m_netCode; }
373 
378  void SetHighLightNet( int aNetCode)
379  {
380  m_highLight.m_netCode = aNetCode;
381  }
382 
387  bool IsHighLightNetON() const { return m_highLight.m_highLightOn; }
388 
393  void HighLightOFF() { m_highLight.m_highLightOn = false; }
394 
400  void HighLightON() { m_highLight.m_highLightOn = true; }
401 
406  void PushHighLight();
407 
412  void PopHighLight();
413 
418  int GetCopperLayerCount() const;
419 
420  void SetCopperLayerCount( int aCount );
421 
428  LSET GetEnabledLayers() const;
429 
436  void SetEnabledLayers( LSET aLayerMask );
437 
445  bool IsLayerEnabled( PCB_LAYER_ID aLayer ) const
446  {
447  return m_designSettings.IsLayerEnabled( aLayer );
448  }
449 
457  bool IsLayerVisible( PCB_LAYER_ID aLayer ) const
458  {
459  return m_designSettings.IsLayerVisible( aLayer );
460  }
461 
468  LSET GetVisibleLayers() const;
469 
476  void SetVisibleLayers( LSET aLayerMask );
477 
478  // these 2 functions are not tidy at this time, since there are PCB_LAYER_IDs that
479  // are not stored in the bitmap.
480 
488  int GetVisibleElements() const;
489 
497  void SetVisibleElements( int aMask );
498 
504  void SetVisibleAlls();
505 
514  bool IsElementVisible( GAL_LAYER_ID aLayer ) const;
515 
523  void SetElementVisibility( GAL_LAYER_ID aLayer, bool aNewState );
524 
532  bool IsModuleLayerVisible( PCB_LAYER_ID aLayer );
533 
539  {
540  // remove const-ness with cast.
541  return (BOARD_DESIGN_SETTINGS&) m_designSettings;
542  }
543 
548  void SetDesignSettings( const BOARD_DESIGN_SETTINGS& aDesignSettings )
549  {
550  m_designSettings = aDesignSettings;
551  }
552 
553  const PAGE_INFO& GetPageSettings() const { return m_paper; }
554  void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
555 
556  const PCB_PLOT_PARAMS& GetPlotOptions() const { return m_plotOptions; }
557  void SetPlotOptions( const PCB_PLOT_PARAMS& aOptions ) { m_plotOptions = aOptions; }
558 
559  TITLE_BLOCK& GetTitleBlock() { return m_titles; }
560  void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
561 
562  const ZONE_SETTINGS& GetZoneSettings() const { return m_zoneSettings; }
563  void SetZoneSettings( const ZONE_SETTINGS& aSettings ) { m_zoneSettings = aSettings; }
564 
569  const COLORS_DESIGN_SETTINGS& Colors() const { return *m_colorsSettings; }
570 
575  void SetColorsSettings( COLORS_DESIGN_SETTINGS* aColorsSettings )
576  {
577  m_colorsSettings = aColorsSettings;
578  }
591  bool GetBoardPolygonOutlines( SHAPE_POLY_SET& aOutlines,
592  wxString* aErrorText = NULL );
593 
605  void ConvertBrdLayerToPolygonalContours( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aOutlines );
606 
617  const PCB_LAYER_ID GetLayerID( const wxString& aLayerName ) const;
618 
629  const wxString GetLayerName( PCB_LAYER_ID aLayer ) const;
630 
640  bool SetLayerName( PCB_LAYER_ID aLayer, const wxString& aLayerName );
641 
653  static wxString GetStandardLayerName( PCB_LAYER_ID aLayerId )
654  {
655  // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
656  return LSET::Name( aLayerId );
657  }
658 
667  bool SetLayerDescr( PCB_LAYER_ID aIndex, const LAYER& aLayer );
668 
677  LAYER_T GetLayerType( PCB_LAYER_ID aLayer ) const;
678 
687  bool SetLayerType( PCB_LAYER_ID aLayer, LAYER_T aLayerType );
688 
690  int GetNumSegmTrack() const;
691 
693  int GetNumSegmZone() const;
694 
700  unsigned GetNodesCount( int aNet = -1 );
701 
706  unsigned GetUnconnectedNetCount() const;
707 
712  unsigned GetPadCount();
713 
718  D_PAD* GetPad( unsigned aIndex ) const;
719 
727  const std::vector<D_PAD*> GetPads();
728 
730  {
731  m_NetInfo.buildListOfNets();
732  }
733 
740  NETINFO_ITEM* FindNet( int aNetcode ) const;
741 
748  NETINFO_ITEM* FindNet( const wxString& aNetname ) const;
749 
751  {
752  return m_NetInfo;
753  }
754 
755 #ifndef SWIG
756 
761  {
762  return m_NetInfo.begin();
763  }
764 
770  {
771  return m_NetInfo.end();
772  }
773 #endif
774 
779  unsigned GetNetCount() const
780  {
781  return m_NetInfo.GetNetCount();
782  }
783 
790  EDA_RECT ComputeBoundingBox( bool aBoardEdgesOnly = false ) const;
791 
792  const EDA_RECT GetBoundingBox() const override
793  {
794  return ComputeBoundingBox( false );
795  }
796 
805  {
806  return ComputeBoundingBox( true );
807  }
808 
809  void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
810 
819  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC,
820  GR_DRAWMODE aDrawMode, const wxPoint& aOffset = ZeroOffset ) override;
821 
831  void DrawHighLight( EDA_DRAW_PANEL* aDrawPanel, wxDC* aDC, int aNetCode );
832 
846  SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
847 
857  MODULE* FindModuleByReference( const wxString& aReference ) const;
858 
868  MODULE* FindModule( const wxString& aRefOrTimeStamp, bool aSearchByTimeStamp = false ) const;
869 
902  void ReplaceNetlist( NETLIST& aNetlist, bool aDeleteSinglePadNets,
903  std::vector<MODULE*>* aNewFootprints, REPORTER& aReporter );
904 
905  void updateComponentPadConnections( NETLIST& aNetlist, MODULE* footprint,
906  COMPONENT* component, REPORTER& aReporter );
914  int SortedNetnamesList( wxArrayString& aNames, bool aSortbyPadsCount );
915 
923  void SynchronizeNetsAndNetClasses();
924 
925  /***************************************************************************/
926 
927  wxString GetClass() const override
928  {
929  return wxT( "BOARD" );
930  }
931 
932 #if defined(DEBUG)
933  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
934 #endif
935 
936 
937  /*************************/
938  /* Copper Areas handling */
939  /*************************/
940 
952  ZONE_CONTAINER* HitTestForAnyFilledArea( const wxPoint& aRefPos,
953  PCB_LAYER_ID aStartLayer,
954  PCB_LAYER_ID aEndLayer,
955  int aNetCode );
956 
961  void RedrawAreasOutlines( EDA_DRAW_PANEL* aPanel,
962  wxDC* aDC,
963  GR_DRAWMODE aDrawMode,
964  PCB_LAYER_ID aLayer );
965 
970  void RedrawFilledAreas( EDA_DRAW_PANEL* aPanel, wxDC* aDC, GR_DRAWMODE aDrawMode,
971  PCB_LAYER_ID aLayer );
972 
983  int SetAreasNetCodesFromNetNames( void );
984 
991  ZONE_CONTAINER* GetArea( int index ) const
992  {
993  if( (unsigned) index < m_ZoneDescriptorList.size() )
994  return m_ZoneDescriptorList[index];
995 
996  return NULL;
997  }
998 
1005  int GetAreaIndex( const ZONE_CONTAINER* aArea ) const
1006  {
1007  for( int ii = 0; ii < GetAreaCount(); ii++ ) // Search for aArea in list
1008  {
1009  if( aArea == GetArea( ii ) ) // Found !
1010  return ii;
1011  }
1012 
1013  return -1;
1014  }
1015 
1020  int GetAreaCount() const
1021  {
1022  return (int) m_ZoneDescriptorList.size();
1023  }
1024 
1025  /* Functions used in test, merge and cut outlines */
1026 
1038  ZONE_CONTAINER* AddArea( PICKED_ITEMS_LIST* aNewZonesList, int aNetcode,
1039  PCB_LAYER_ID aLayer, wxPoint aStartPointPosition, int aHatch );
1040 
1051  ZONE_CONTAINER* InsertArea( int aNetcode, int aAreaIdx, PCB_LAYER_ID aLayer,
1052  int aCornerX, int aCornerY, int aHatch );
1053 
1063  bool NormalizeAreaPolygon( PICKED_ITEMS_LIST* aNewZonesList, ZONE_CONTAINER* aCurrArea );
1064 
1075  bool OnAreaPolygonModified( PICKED_ITEMS_LIST* aModifiedZonesList,
1076  ZONE_CONTAINER* modified_area );
1077 
1088  bool CombineAllAreasInNet( PICKED_ITEMS_LIST* aDeletedList,
1089  int aNetCode,
1090  bool aUseLocalFlags );
1091 
1099  void RemoveArea( PICKED_ITEMS_LIST* aDeletedList, ZONE_CONTAINER* area_to_remove );
1100 
1106  bool TestAreaIntersections( ZONE_CONTAINER* area_to_test );
1107 
1116  bool TestAreaIntersection( ZONE_CONTAINER* area_ref, ZONE_CONTAINER* area_to_test );
1117 
1129  bool CombineAreas( PICKED_ITEMS_LIST* aDeletedList,
1130  ZONE_CONTAINER* area_ref,
1131  ZONE_CONTAINER* area_to_combine );
1132 
1145  VIA* GetViaByPosition( const wxPoint& aPosition,
1146  PCB_LAYER_ID aLayer = PCB_LAYER_ID( -1 ) ) const;
1147 
1156  std::list<TRACK*> GetTracksByPosition( const wxPoint& aPosition, PCB_LAYER_ID aLayer = PCB_LAYER_ID( -1 ) ) const;
1157 
1166  D_PAD* GetPad( const wxPoint& aPosition, LSET aLayerMask );
1167  D_PAD* GetPad( const wxPoint& aPosition )
1168  {
1169  return GetPad( aPosition, LSET().set() );
1170  }
1171 
1180  D_PAD* GetPad( TRACK* aTrace, ENDPOINT_T aEndPoint );
1181 
1192  D_PAD* GetPadFast( const wxPoint& aPosition, LSET aLayerMask );
1193 
1209  D_PAD* GetPad( std::vector<D_PAD*>& aPadList, const wxPoint& aPosition, LSET aLayerMask );
1210 
1217  void PadDelete( D_PAD* aPad );
1218 
1231  void GetSortedPadListByXthenYCoord( std::vector<D_PAD*>& aVector, int aNetCode = -1 );
1232 
1246  TRACK* GetVisibleTrack( TRACK* aStartingTrace, const wxPoint& aPosition, LSET aLayerSet ) const;
1247 
1274  TRACK* MarkTrace( TRACK* aTrackList, TRACK* aTrace, int* aCount, double* aTraceLength,
1275  double* aInPackageLength, bool aReorder );
1276 
1284  TRACKS TracksInNet( int aNetCode );
1285 
1303  TRACKS TracksInNetBetweenPoints( const wxPoint& aStartPos, const wxPoint& aGoalPos, int aNetCode );
1304 
1319  MODULE* GetFootprint( const wxPoint& aPosition, PCB_LAYER_ID aActiveLayer,
1320  bool aVisibleOnly, bool aIgnoreLocked = false );
1321 
1335  BOARD_CONNECTED_ITEM* GetLockPoint( const wxPoint& aPosition, LSET aLayerMask );
1336 
1354  TRACK* CreateLockPoint( wxPoint& aPosition, TRACK* aSegment, PICKED_ITEMS_LIST* aList );
1355 
1360  void ClearAllNetCodes();
1361 
1362  void SanitizeNetcodes();
1363 };
1364 
1365 #endif // CLASS_BOARD_H_
void SetColorsSettings(COLORS_DESIGN_SETTINGS *aColorsSettings)
Function SetColorsSettings.
Definition: class_board.h:575
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString, NETINFO_ITEM*>
Definition: netinfo.h:478
void SetFileFormatVersionAtLoad(int aVersion)
Definition: class_board.h:280
D_PAD * GetPad(const wxPoint &aPosition)
Definition: class_board.h:1167
void BuildListOfNets()
Definition: class_board.h:729
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
Definition: class_board.h:792
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
NETINFO_LIST::iterator BeginNets() const
Function BeginNets.
Definition: class_board.h:760
void SetZoneSettings(const ZONE_SETTINGS &aSettings)
Definition: class_board.h:563
MARKER_PCB * GetMARKER(int index) const
Function GetMARKER returns the MARKER at a given index.
Definition: class_board.h:327
void SetElementVisibility(GAL_LAYER_ID aElement, bool aNewState)
Function SetElementVisibility changes the visibility of an element category.
static bool ClassOf(const EDA_ITEM *aItem)
Definition: class_board.h:230
const ZONE_SETTINGS & GetZoneSettings() const
Definition: class_board.h:562
Definition: typeinfo.h:85
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:355
BOARD(const BOARD &aOther)
Definition: class_board.h:217
wxString m_name
The name of the layer, there should be no spaces in this name.
Definition: class_board.h:112
const wxPoint & GetGridOrigin() const
Definition: class_board.h:356
wxString m_fileName
the board filename
Definition: class_board.h:176
Handle colors used to draw all items or layers.
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...
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: class_board.h:560
PAGE_INFO m_paper
Definition: class_board.h:197
DLIST< BOARD_ITEM > & DrawingsList()
Definition: class_board.h:260
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:445
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: class_board.h:554
LAYER_T m_type
The type of the layer.
Definition: class_board.h:114
COLORS_DESIGN_SETTINGS * m_colorsSettings
Definition: class_board.h:196
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:362
ZONE_CONTAINER * m_CurrentZoneContour
zone contour currently in progress
Definition: class_board.h:263
unsigned GetNetCount() const
Function GetNetCount.
Definition: netinfo.h:434
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
void HighLightOFF()
Function HighLightOFF Disable highlight.
Definition: class_board.h:393
LAYER()
Definition: class_board.h:88
BOARD & operator=(const BOARD &aOther)
Definition: class_board.h:223
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:187
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:200
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:188
NETINFO_LIST::iterator EndNets() const
Function EndNets.
Definition: class_board.h:769
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:39
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:199
void SetVisibleAlls()
Function SetVisibleAlls Set the status of all visible element categories and layers to VISIBLE...
void SetAuxOrigin(const wxPoint &aPoint)
Function SetAuxOrigin sets the origin point used for plotting.
Definition: class_board.h:348
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
ENDPOINT_T
Flag used in locate routines (from which endpoint work)
Definition: pcbnew.h:58
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:804
const INSPECTOR_FUNC & INSPECTOR
Definition: base_struct.h:102
ZONE_SETTINGS m_zoneSettings
Definition: class_board.h:195
bool IsElementVisible(GAL_LAYER_ID aElement) const
Function IsElementVisible tests whether a given element category is visible.
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:214
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:254
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.
Definition: netinfo.h:407
const wxString & GetFileName() const
Definition: class_board.h:237
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
Class SHAPE_POLY_SET.
const COLORS_DESIGN_SETTINGS & Colors() const
Function GetColorSettings.
Definition: class_board.h:569
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
bool IsEmpty() const
Definition: class_board.h:272
DLIST< SEGZONE > m_SegZoneDeprecated
Definition: class_board.h:250
LAYER_T
Enum LAYER_T gives the allowed types of layers, same as Specctra DSN spec.
Definition: class_board.h:72
TITLE_BLOCK m_titles
text in lower right of screen and plots
Definition: class_board.h:198
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: class_board.h:556
bool m_visible
Definition: class_board.h:116
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:538
#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:244
void SetDesignSettings(const BOARD_DESIGN_SETTINGS &aDesignSettings)
Function SetDesignSettings.
Definition: class_board.h:548
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1020
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:179
void SetFileName(const wxString &aFileName)
Definition: class_board.h:235
void SetPlotOptions(const PCB_PLOT_PARAMS &aOptions)
Definition: class_board.h:557
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:750
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:553
Pad object description.
int GetFileFormatVersionAtLoad() const
Definition: class_board.h:281
void HighLightON()
Function HighLightON Enable highlight.
Definition: class_board.h:400
Class COMPONENT is used to store components and all of their related information found in a netlist...
Definition: pcb_netlist.h:83
Class ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:48
const wxPoint & GetAuxOrigin() const
Definition: class_board.h:349
void SetHighLightNet(int aNetCode)
Function SetHighLightNet.
Definition: class_board.h:378
void clear()
Definition: class_board.h:93
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:69
iterator begin() const
Definition: netinfo.h:524
ZONE_CONTAINERS & Zones()
Definition: class_board.h:256
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:559
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:991
Board layer functions and definitions.
int m_fileFormatVersionAtLoad
the version loaded from the file
Definition: class_board.h:190
iterator end() const
Definition: netinfo.h:529
Class LAYER holds information pertinent to a layer of a BOARD.
Definition: class_board.h:86
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
DLIST< MODULE > m_Modules
Definition: class_board.h:248
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:182
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:192
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class PCB_EDIT_FRAME is the main frame for Pcbnew.
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:927
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:387
DLIST_ITERATOR_WRAPPER< TRACK > Tracks()
Definition: class_board.h:253
int GetHighLightNetCode() const
Function GetHighLightNetCode.
Definition: class_board.h:372
DLIST< TRACK > m_Track
Definition: class_board.h:249
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:194
Abstract interface for BOARD_ITEMs capable of storing other items inside.
int m_number
Definition: class_board.h:118
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:66
int GetAreaIndex(const ZONE_CONTAINER *aArea) const
Function GetAreaIndex returns the Area Index for the given Zone Container.
Definition: class_board.h:1005
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:296
wxPoint m_AuxOrigin
origin for plot exports
class PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer...
EDA_UNITS_T
Definition: common.h:159
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:255
int GetMARKERCount() const
Function GetMARKERCount.
Definition: class_board.h:339
unsigned GetNetCount() const
Function GetNetCount.
Definition: class_board.h:779
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:653
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:457
int m_Status_Pcb
Flags used in ratsnest calculation and update.
Definition: class_board.h:240