KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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, [email protected]
5 * Copyright (C) 1992-2023 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
25#ifndef CLASS_BOARD_H_
26#define CLASS_BOARD_H_
27
29#include <common.h> // Needed for stl hash extensions
30#include <convert_shape_list_to_polygon.h> // for OUTLINE_ERROR_HANDLER
31#include <hash.h>
32#include <layer_ids.h>
33#include <netinfo.h>
34#include <pcb_item_containers.h>
35#include <pcb_plot_params.h>
36#include <title_block.h>
37#include <tools/pcb_selection.h>
38#include <shared_mutex>
39#include <list>
40
43class BOARD_COMMIT;
44class DRC_RTREE;
45class PCB_BASE_FRAME;
46class PCB_EDIT_FRAME;
48class BOARD;
49class FOOTPRINT;
50class ZONE;
51class PCB_TRACK;
52class PAD;
53class PCB_GROUP;
54class PCB_GENERATOR;
55class PCB_MARKER;
56class MSG_PANEL_ITEM;
57class NETLIST;
58class REPORTER;
59class SHAPE_POLY_SET;
61class COMPONENT;
62class PROJECT;
64struct ISOLATED_ISLANDS;
65
66// The default value for m_outlinesChainingEpsilon to convert a board outlines to polygons
67// It is the max dist between 2 end points to see them connected
68#define DEFAULT_CHAINING_EPSILON_MM 0.01
69
70// Forward declare endpoint from class_track.h
71enum ENDPOINT_T : int;
72
73
75{
78
79 bool operator==(const PTR_PTR_CACHE_KEY& other) const
80 {
81 return A == other.A && B == other.B;
82 }
83};
84
86{
89
90 bool operator==(const PTR_LAYER_CACHE_KEY& other) const
91 {
92 return A == other.A && Layer == other.Layer;
93 }
94};
95
97{
101
102 bool operator==(const PTR_PTR_LAYER_CACHE_KEY& other) const
103 {
104 return A == other.A && B == other.B && Layer == other.Layer;
105 }
106};
107
108namespace std
109{
110 template <>
111 struct hash<PTR_PTR_CACHE_KEY>
112 {
113 std::size_t operator()( const PTR_PTR_CACHE_KEY& k ) const
114 {
115 std::size_t seed = 0xa82de1c0;
116 hash_combine( seed, k.A, k.B );
117 return seed;
118 }
119 };
120
121 template <>
123 {
124 std::size_t operator()( const PTR_LAYER_CACHE_KEY& k ) const
125 {
126 std::size_t seed = 0xa82de1c0;
127 hash_combine( seed, k.A, k.Layer );
128 return seed;
129 }
130 };
131
132 template <>
134 {
135 std::size_t operator()( const PTR_PTR_LAYER_CACHE_KEY& k ) const
136 {
137 std::size_t seed = 0xa82de1c0;
138 hash_combine( seed, k.A, k.B, k.Layer );
139 return seed;
140 }
141 };
142}
143
144
149{
156
157
161struct LAYER
162{
164 {
165 clear();
166 }
167
168 void clear()
169 {
171 m_visible = true;
172 m_number = 0;
173 m_name.clear();
174 m_userName.clear();
175 }
176
177 /*
178 LAYER( const wxString& aName = wxEmptyString,
179 LAYER_T aType = LT_SIGNAL, bool aVisible = true, int aNumber = -1 ) :
180 m_name( aName ),
181 m_type( aType ),
182 m_visible( aVisible ),
183 m_number( aNumber )
184 {
185 }
186 */
187
188 wxString m_name;
189 wxString m_userName;
193
200 static const char* ShowType( LAYER_T aType );
201
209 static LAYER_T ParseType( const char* aType );
210};
211
212
213// Helper class to handle high light nets
215{
216protected:
217 std::set<int> m_netCodes; // net(s) selected for highlight (-1 when no net selected )
218 bool m_highLightOn; // highlight active
219
220 void Clear()
221 {
222 m_netCodes.clear();
223 m_highLightOn = false;
224 }
225
227 {
228 Clear();
229 }
230
231private:
232 friend class BOARD;
233};
234
240class BOARD;
241
243{
244public:
245 virtual ~BOARD_LISTENER() { }
246 virtual void OnBoardItemAdded( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
247 virtual void OnBoardItemsAdded( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
248 virtual void OnBoardItemRemoved( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
249 virtual void OnBoardItemsRemoved( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
250 virtual void OnBoardNetSettingsChanged( BOARD& aBoard ) { }
251 virtual void OnBoardItemChanged( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
252 virtual void OnBoardItemsChanged( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
253 virtual void OnBoardHighlightNetChanged( BOARD& aBoard ) { }
254 virtual void OnBoardRatsnestChanged( BOARD& aBoard ) { }
255 virtual void OnBoardCompositeUpdate( BOARD& aBoard, std::vector<BOARD_ITEM*>& aAddedItems,
256 std::vector<BOARD_ITEM*>& aRemovedItems,
257 std::vector<BOARD_ITEM*>& aDeletedItems )
258 {
259 }
260};
261
265typedef std::set<BOARD_ITEM*, CompareByUuid> BOARD_ITEM_SET;
266
270enum class BOARD_USE
271{
272 NORMAL, // A normal board
273 FPHOLDER // A board that holds a single footprint
274};
275
276
281{
282public:
283 static inline bool ClassOf( const EDA_ITEM* aItem )
284 {
285 return aItem && PCB_T == aItem->Type();
286 }
287
293 void SetBoardUse( BOARD_USE aUse ) { m_boardUse = aUse; }
294
300 BOARD_USE GetBoardUse() const { return m_boardUse; }
301
302 void IncrementTimeStamp();
303
304 int GetTimeStamp() const { return m_timeStamp; }
305
311 bool IsFootprintHolder() const
312 {
313 return m_boardUse == BOARD_USE::FPHOLDER;
314 }
315
316 void SetFileName( const wxString& aFileName ) { m_fileName = aFileName; }
317
318 const wxString &GetFileName() const { return m_fileName; }
319
320 const TRACKS& Tracks() const { return m_tracks; }
321
322 const FOOTPRINTS& Footprints() const { return m_footprints; }
323
324 const DRAWINGS& Drawings() const { return m_drawings; }
325
326 const ZONES& Zones() const { return m_zones; }
327
328 const GENERATORS& Generators() const { return m_generators; }
329
330 const MARKERS& Markers() const { return m_markers; }
331
332 // SWIG requires non-const accessors for some reason to make the custom iterators in board.i
333 // work. It would be good to remove this if we can figure out how to fix that.
334#ifdef SWIG
335 DRAWINGS& Drawings() { return m_drawings; }
336 TRACKS& Tracks() { return m_tracks; }
337#endif
338
340
349 const GROUPS& Groups() const { return m_groups; }
350
351 const std::vector<BOARD_CONNECTED_ITEM*> AllConnectedItems();
352
353 const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
354 void SetProperties( const std::map<wxString, wxString>& aProps ) { m_properties = aProps; }
355
356 void GetContextualTextVars( wxArrayString* aVars ) const;
357 bool ResolveTextVar( wxString* token, int aDepth ) const;
358
362
366
369
370 BOARD();
371 ~BOARD();
372
373 VECTOR2I GetPosition() const override;
374 void SetPosition( const VECTOR2I& aPos ) override;
375 const VECTOR2I GetFocusPosition() const override { return GetBoundingBox().GetCenter(); }
376
377 bool IsEmpty() const
378 {
379 return m_drawings.empty() && m_footprints.empty() && m_tracks.empty() && m_zones.empty();
380 }
381
382 void Move( const VECTOR2I& aMoveVector ) override;
383
384 void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
386
387 void SetGenerator( const wxString& aGenerator ) { m_generator = aGenerator; }
388 const wxString& GetGenerator() const { return m_generator; }
389
391 void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT,
392 bool aSkipConnectivity = false ) override;
393
395 void Remove( BOARD_ITEM* aBoardItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) override;
396
405 void RemoveAll( std::initializer_list<KICAD_T> aTypes = { PCB_NETINFO_T, PCB_MARKER_T,
409
414 void FinalizeBulkAdd( std::vector<BOARD_ITEM*>& aNewItems );
415
420 void FinalizeBulkRemove( std::vector<BOARD_ITEM*>& aRemovedItems );
421
422 void CacheTriangulation( PROGRESS_REPORTER* aReporter = nullptr,
423 const std::vector<ZONE*>& aZones = {} );
424
433 {
434 return m_footprints.empty() ? nullptr : m_footprints.front();
435 }
436
440 void DeleteAllFootprints();
441
445 BOARD_ITEM* GetItem( const KIID& aID ) const;
446
447 void FillItemMap( std::map<KIID, EDA_ITEM*>& aMap );
448
452 wxString ConvertCrossReferencesToKIIDs( const wxString& aSource ) const;
453 wxString ConvertKIIDsToCrossReferences( const wxString& aSource ) const;
454
459 std::shared_ptr<CONNECTIVITY_DATA> GetConnectivity() const { return m_connectivity; }
460
466 bool BuildConnectivity( PROGRESS_REPORTER* aReporter = nullptr );
467
471 void DeleteMARKERs();
472
473 void DeleteMARKERs( bool aWarningsAndErrors, bool aExclusions );
474
475 PROJECT* GetProject() const { return m_project; }
476
485 void SetProject( PROJECT* aProject, bool aReferenceOnly = false );
486
487 void ClearProject();
488
496 std::vector<PCB_MARKER*> ResolveDRCExclusions( bool aCreateMarkers );
497
501 void RecordDRCExclusions();
502
507
511 void ResetNetHighLight();
512
516 const std::set<int>& GetHighLightNetCodes() const
517 {
518 return m_highLight.m_netCodes;
519 }
520
527 void SetHighLightNet( int aNetCode, bool aMulti = false );
528
533
541 void HighLightON( bool aValue = true );
542
547 {
548 HighLightON( false );
549 }
550
554 int GetCopperLayerCount() const;
555 void SetCopperLayerCount( int aCount );
556
557 int LayerDepth( PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer ) const;
558
564 LSET GetEnabledLayers() const;
565
571 void SetEnabledLayers( LSET aLayerMask );
572
579 bool IsLayerEnabled( PCB_LAYER_ID aLayer ) const;
580
588 bool IsLayerVisible( PCB_LAYER_ID aLayer ) const;
589
595 LSET GetVisibleLayers() const;
596
603 void SetVisibleLayers( LSET aLayerMask );
604
605 // these 2 functions are not tidy at this time, since there are PCB_LAYER_IDs that
606 // are not stored in the bitmap.
607
615
622 void SetVisibleElements( const GAL_SET& aMask );
623
629 void SetVisibleAlls();
630
638 bool IsElementVisible( GAL_LAYER_ID aLayer ) const;
639
647 void SetElementVisibility( GAL_LAYER_ID aLayer, bool aNewState );
648
656 bool IsFootprintLayerVisible( PCB_LAYER_ID aLayer ) const;
657
662
663 // Tented vias are vias covered by solder mask. So because the solder mask is a negative
664 // layer, tented vias are NOT plotted on solder mask layers
666 void SetTentVias( bool aFlag ) { m_plotOptions.SetPlotViaOnMaskLayer( !aFlag ); }
667
668 const PAGE_INFO& GetPageSettings() const { return m_paper; }
669 void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
670
672 void SetPlotOptions( const PCB_PLOT_PARAMS& aOptions ) { m_plotOptions = aOptions; }
673
675 const TITLE_BLOCK& GetTitleBlock() const { return m_titles; }
676 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
677
678 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
679
681 void SetUserUnits( EDA_UNITS aUnits ) { m_userUnits = aUnits; }
682
687 void UpdateUserUnits( BOARD_ITEM* aItem, KIGFX::VIEW* aView );
688
707 OUTLINE_ERROR_HANDLER* aErrorHandler = nullptr,
708 bool aAllowUseArcsInPolygons = false,
709 bool aIncludeNPTHAsOutlines = false );
710
720
731 void ConvertBrdLayerToPolygonalContours( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aOutlines ) const;
732
736 PCB_LAYER_ID GetLayerID( const wxString& aLayerName ) const;
737
744 const wxString GetLayerName( PCB_LAYER_ID aLayer ) const;
745
753 bool SetLayerName( PCB_LAYER_ID aLayer, const wxString& aLayerName );
754
765 static wxString GetStandardLayerName( PCB_LAYER_ID aLayerId )
766 {
767 // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
768 return LayerName( aLayerId );
769 }
770
778 bool SetLayerDescr( PCB_LAYER_ID aIndex, const LAYER& aLayer );
779
786 LAYER_T GetLayerType( PCB_LAYER_ID aLayer ) const;
787
795 bool SetLayerType( PCB_LAYER_ID aLayer, LAYER_T aLayerType );
796
801 unsigned GetNodesCount( int aNet = -1 ) const;
802
811 const std::vector<PAD*> GetPads() const;
812
814 {
816 }
817
824 NETINFO_ITEM* FindNet( int aNetcode ) const;
825
832 NETINFO_ITEM* FindNet( const wxString& aNetname ) const;
833
843 int MatchDpSuffix( const wxString& aNetName, wxString& aComplementNet );
844
848 NETINFO_ITEM* DpCoupledNet( const NETINFO_ITEM* aNet );
849
851 {
852 return m_NetInfo;
853 }
854
856 {
857 m_NetInfo.RemoveUnusedNets( aCommit );
858 }
859
860#ifndef SWIG
865 {
866 return m_NetInfo.begin();
867 }
868
873 {
874 return m_NetInfo.end();
875 }
876#endif
877
881 unsigned GetNetCount() const
882 {
883 return m_NetInfo.GetNetCount();
884 }
885
892 BOX2I ComputeBoundingBox( bool aBoardEdgesOnly = false ) const;
893
894 const BOX2I GetBoundingBox() const override
895 {
896 return ComputeBoundingBox( false );
897 }
898
909 {
910 return ComputeBoundingBox( true );
911 }
912
913 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
914
926 INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
927 const std::vector<KICAD_T>& scanTypes ) override;
928
937 FOOTPRINT* FindFootprintByReference( const wxString& aReference ) const;
938
945 FOOTPRINT* FindFootprintByPath( const KIID_PATH& aPath ) const;
946
950 std::set<wxString> GetNetClassAssignmentCandidates() const;
951
959 void SynchronizeNetsAndNetClasses( bool aResetTrackAndViaSizes );
960
965
969 double Similarity( const BOARD_ITEM& aOther ) const override
970 {
971 return 1.0;
972 }
973
974 bool operator==( const BOARD_ITEM& aOther ) const override;
975
976 wxString GetClass() const override
977 {
978 return wxT( "BOARD" );
979 }
980
981#if defined(DEBUG)
982 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
983#endif
984
985
986 /*************************/
987 /* Copper Areas handling */
988 /*************************/
989
1000
1007 ZONE* GetArea( int index ) const
1008 {
1009 if( (unsigned) index < m_zones.size() )
1010 return m_zones[index];
1011
1012 return nullptr;
1013 }
1014
1018 std::list<ZONE*> GetZoneList( bool aIncludeZonesInFootprints = false ) const;
1019
1023 int GetAreaCount() const
1024 {
1025 return static_cast<int>( m_zones.size() );
1026 }
1027
1028 /* Functions used in test, merge and cut outlines */
1029
1042 ZONE* AddArea( PICKED_ITEMS_LIST* aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer,
1043 VECTOR2I aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch );
1044
1052 bool TestZoneIntersection( ZONE* aZone1, ZONE* aZone2 );
1053
1061 PAD* GetPad( const VECTOR2I& aPosition, LSET aLayerMask ) const;
1062 PAD* GetPad( const VECTOR2I& aPosition ) const
1063 {
1064 return GetPad( aPosition, LSET().set() );
1065 }
1066
1074 PAD* GetPad( const PCB_TRACK* aTrace, ENDPOINT_T aEndPoint ) const;
1075
1085 PAD* GetPadFast( const VECTOR2I& aPosition, LSET aLayerMask ) const;
1086
1101 PAD* GetPad( std::vector<PAD*>& aPadList, const VECTOR2I& aPosition, LSET aLayerMask ) const;
1102
1114 void GetSortedPadListByXthenYCoord( std::vector<PAD*>& aVector, int aNetCode = -1 ) const;
1115
1123 std::tuple<int, double, double> GetTrackLength( const PCB_TRACK& aTrack ) const;
1124
1132 TRACKS TracksInNet( int aNetCode );
1133
1146 FOOTPRINT* GetFootprint( const VECTOR2I& aPosition, PCB_LAYER_ID aActiveLayer,
1147 bool aVisibleOnly, bool aIgnoreLocked = false ) const;
1148
1155 {
1156 return m_maxClearanceValue;
1157 };
1158
1164 void MapNets( BOARD* aDestBoard );
1165
1166 void SanitizeNetcodes();
1167
1176 void AddListener( BOARD_LISTENER* aListener );
1177
1182 void RemoveListener( BOARD_LISTENER* aListener );
1183
1187 void RemoveAllListeners();
1188
1193 void OnItemChanged( BOARD_ITEM* aItem );
1194
1199 void OnItemsChanged( std::vector<BOARD_ITEM*>& aItems );
1200
1205 void OnItemsCompositeUpdate( std::vector<BOARD_ITEM*>& aAddedItems,
1206 std::vector<BOARD_ITEM*>& aRemovedItems,
1207 std::vector<BOARD_ITEM*>& aChangedItems );
1208
1212 void OnRatsnestChanged();
1213
1220 wxString GroupsSanityCheck( bool repair = false );
1221
1227 wxString GroupsSanityCheckInternal( bool repair );
1228
1230 {
1231 bool create : 1;
1232 bool ungroup : 1;
1233 bool removeItems : 1;
1234 };
1235
1241 GroupLegalOpsField GroupLegalOps( const PCB_SELECTION& selection ) const;
1242
1243 bool LegacyTeardrops() const { return m_legacyTeardrops; }
1244 void SetLegacyTeardrops( bool aFlag ) { m_legacyTeardrops = aFlag; }
1245
1246 // --------- Item order comparators ---------
1247
1249 {
1250 bool operator() ( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
1251 };
1252
1254 {
1255 bool operator()( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
1256 };
1257
1258 // ------------ Run-time caches -------------
1259 mutable std::shared_mutex m_CachesMutex;
1260 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsCourtyardCache;
1261 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsFCourtyardCache;
1262 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsBCourtyardCache;
1263 std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, bool> m_IntersectsAreaCache;
1264 std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, bool> m_EnclosedByAreaCache;
1265 std::unordered_map< wxString, LSET > m_LayerExpressionCache;
1266 std::unordered_map<ZONE*, std::unique_ptr<DRC_RTREE>> m_CopperZoneRTreeCache;
1267 std::shared_ptr<DRC_RTREE> m_CopperItemRTreeCache;
1268 mutable std::unordered_map<const ZONE*, BOX2I> m_ZoneBBoxCache;
1269
1270 // ------------ DRC caches -------------
1271 std::vector<ZONE*> m_DRCZones;
1272 std::vector<ZONE*> m_DRCCopperZones;
1275 ZONE* m_SolderMaskBridges; // A container to build bridges on solder mask layers
1276 std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>> m_ZoneIsolatedIslandsMap;
1277
1278private:
1279 // The default copy constructor & operator= are inadequate,
1280 // either write one or do not use it at all
1281 BOARD( const BOARD& aOther ) = delete;
1282
1283 BOARD& operator=( const BOARD& aOther ) = delete;
1284
1285 template <typename Func, typename... Args>
1286 void InvokeListeners( Func&& aFunc, Args&&... args )
1287 {
1288 for( auto&& l : m_listeners )
1289 ( l->*aFunc )( std::forward<Args>( args )... );
1290 }
1291
1292
1294
1295 friend class PCB_EDIT_FRAME;
1296
1297
1300
1303 int m_timeStamp; // actually a modification counter
1304
1305 wxString m_fileName;
1306
1307 // These containers only have const accessors and must only be modified by Add()/Remove()
1308 MARKERS m_markers;
1309 DRAWINGS m_drawings;
1310 FOOTPRINTS m_footprints;
1311 TRACKS m_tracks;
1312 GROUPS m_groups;
1314 GENERATORS m_generators;
1315
1316 // Cache for fast access to items in the containers above by KIID, including children
1317 std::unordered_map<KIID, BOARD_ITEM*> m_itemByIdCache;
1318
1320
1321 HIGH_LIGHT_INFO m_highLight; // current high light data
1322 HIGH_LIGHT_INFO m_highLightPrevious; // a previously stored high light data
1323
1324 int m_fileFormatVersionAtLoad; // the version loaded from the file
1325 wxString m_generator; // the generator tag from the file
1326
1327 std::map<wxString, wxString> m_properties;
1328 std::shared_ptr<CONNECTIVITY_DATA> m_connectivity;
1329
1331 TITLE_BLOCK m_titles; // text in lower right of screen and plots
1333 PROJECT* m_project; // project this board is a part of
1335
1346 std::unique_ptr<BOARD_DESIGN_SETTINGS> m_designSettings;
1347
1352 bool m_legacyTeardrops = false;
1353
1355 int m_maxClearanceValue; // cached value
1356
1357 NETINFO_LIST m_NetInfo; // net info list (name, design constraints...
1358
1359 std::vector<BOARD_LISTENER*> m_listeners;
1360};
1361
1362
1363#endif // CLASS_BOARD_H_
BOARD_USE
Flags to specify how the board is being used.
Definition: board.h:271
LAYER_T
The allowed types of layers, same as Specctra DSN spec.
Definition: board.h:149
@ LT_POWER
Definition: board.h:152
@ LT_MIXED
Definition: board.h:153
@ LT_UNDEFINED
Definition: board.h:150
@ LT_JUMPER
Definition: board.h:154
@ LT_SIGNAL
Definition: board.h:151
std::set< BOARD_ITEM *, CompareByUuid > BOARD_ITEM_SET
Set of BOARD_ITEMs ordered by UUID.
Definition: board.h:265
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
Container for design settings for a BOARD object.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:103
virtual void OnBoardNetSettingsChanged(BOARD &aBoard)
Definition: board.h:250
virtual void OnBoardItemsAdded(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:247
virtual void OnBoardRatsnestChanged(BOARD &aBoard)
Definition: board.h:254
virtual void OnBoardCompositeUpdate(BOARD &aBoard, std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aDeletedItems)
Definition: board.h:255
virtual void OnBoardItemsChanged(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:252
virtual void OnBoardItemChanged(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:251
virtual void OnBoardItemRemoved(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:248
virtual void OnBoardItemAdded(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:246
virtual void OnBoardHighlightNetChanged(BOARD &aBoard)
Definition: board.h:253
virtual ~BOARD_LISTENER()
Definition: board.h:245
virtual void OnBoardItemsRemoved(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:249
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:281
INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes) override
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: board.cpp:1661
ZONE * m_SolderMaskBridges
Definition: board.h:1275
void GetContextualTextVars(wxArrayString *aVars) const
Definition: board.cpp:400
bool IsFootprintLayerVisible(PCB_LAYER_ID aLayer) const
Expect either of the two layers on which a footprint can reside, and returns whether that layer is vi...
Definition: board.cpp:785
void SetPlotOptions(const PCB_PLOT_PARAMS &aOptions)
Definition: board.h:672
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_EnclosedByAreaCache
Definition: board.h:1264
std::map< ZONE *, std::map< PCB_LAYER_ID, ISOLATED_ISLANDS > > m_ZoneIsolatedIslandsMap
Definition: board.h:1276
GENERATORS m_generators
Definition: board.h:1314
bool GetBoardPolygonOutlines(SHAPE_POLY_SET &aOutlines, OUTLINE_ERROR_HANDLER *aErrorHandler=nullptr, bool aAllowUseArcsInPolygons=false, bool aIncludeNPTHAsOutlines=false)
Extract the board outlines and build a closed polygon from lines, arcs and circle items on edge cut l...
Definition: board.cpp:2369
void OnItemChanged(BOARD_ITEM *aItem)
Notify the board and its listeners that an item on the board has been modified in some way.
Definition: board.cpp:2513
const NETINFO_LIST & GetNetInfo() const
Definition: board.h:850
bool m_LegacyDesignSettingsLoaded
True if the legacy board design settings were loaded from a file.
Definition: board.h:364
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
Definition: board.h:311
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:680
void SetPosition(const VECTOR2I &aPos) override
Definition: board.cpp:487
std::map< wxString, wxString > m_properties
Definition: board.h:1327
int m_fileFormatVersionAtLoad
Definition: board.h:1324
NETINFO_ITEM * DpCoupledNet(const NETINFO_ITEM *aNet)
Definition: board.cpp:1881
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:694
void SetTentVias(bool aFlag)
Definition: board.h:666
std::vector< ZONE * > m_DRCCopperZones
Definition: board.h:1272
BOARD_USE GetBoardUse() const
Get what the board use is.
Definition: board.h:300
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition: board.cpp:882
const std::set< int > & GetHighLightNetCodes() const
Definition: board.h:516
void MapNets(BOARD *aDestBoard)
Map all nets in the given board to nets with the same name (if any) in the destination board.
Definition: board.cpp:2459
bool m_legacyTeardrops
Teardrops in 7.0 were applied as a post-processing step (rather than from pad and via properties).
Definition: board.h:1352
TITLE_BLOCK m_titles
Definition: board.h:1331
GAL_SET m_LegacyVisibleItems
Definition: board.h:361
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:293
ZONE * GetArea(int index) const
Return the Zone at a given index.
Definition: board.h:1007
const BOX2I GetBoardEdgesBoundingBox() const
Return the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition: board.h:908
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: board.h:894
void BuildListOfNets()
Definition: board.h:813
PAD * GetPadFast(const VECTOR2I &aPosition, LSET aLayerMask) const
Return pad found at aPosition on aLayerMask using the fast search method.
Definition: board.cpp:2035
LAYER m_layers[PCB_LAYER_ID_COUNT]
Definition: board.h:1319
const GENERATORS & Generators() const
Definition: board.h:328
void SetFileName(const wxString &aFileName)
Definition: board.h:316
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:765
const std::vector< BOARD_CONNECTED_ITEM * > AllConnectedItems()
Definition: board.cpp:2433
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:746
int m_outlinesChainingEpsilon
the max distance between 2 end point to see them connected when building the board outlines
Definition: board.h:1299
std::set< wxString > GetNetClassAssignmentCandidates() const
Return the set of netname candidates for netclass assignment.
Definition: board.cpp:1920
BOARD_USE m_boardUse
What is this board being used for.
Definition: board.h:1302
PAGE_INFO m_paper
Definition: board.h:1330
void RemoveAllListeners()
Remove all listeners.
Definition: board.cpp:2507
FOOTPRINTS m_footprints
Definition: board.h:1310
std::unique_ptr< BOARD_DESIGN_SETTINGS > m_designSettings
All of the board design settings are stored as a JSON object inside the project file.
Definition: board.h:1346
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:700
void AddListener(BOARD_LISTENER *aListener)
Add a listener to the board to receive calls whenever something on the board has been modified.
Definition: board.cpp:2488
const PAGE_INFO & GetPageSettings() const
Definition: board.h:668
void UpdateUserUnits(BOARD_ITEM *aItem, KIGFX::VIEW *aView)
Update any references within aItem (or its descendants) to the user units.
Definition: board.cpp:1213
void SetProperties(const std::map< wxString, wxString > &aProps)
Definition: board.h:354
BOARD(const BOARD &aOther)=delete
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
Definition: board.cpp:740
void SetHighLightNet(int aNetCode, bool aMulti=false)
Select the netcode to be highlighted.
Definition: board.cpp:2549
HIGH_LIGHT_INFO m_highLight
Definition: board.h:1321
bool SetLayerDescr(PCB_LAYER_ID aIndex, const LAYER &aLayer)
Return the type of the copper layer given by aLayer.
Definition: board.cpp:535
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
Definition: board.cpp:1810
EDA_UNITS m_userUnits
Definition: board.h:1334
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:1293
const ZONES & Zones() const
Definition: board.h:326
void InvokeListeners(Func &&aFunc, Args &&... args)
Definition: board.h:1286
void SanitizeNetcodes()
Definition: board.cpp:2478
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
Definition: board.cpp:1207
ZONE * AddArea(PICKED_ITEMS_LIST *aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer, VECTOR2I aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch)
Add an empty copper area to board areas list.
Definition: board.cpp:2344
const GROUPS & Groups() const
The groups must maintain the following invariants.
Definition: board.h:349
~BOARD()
Definition: board.cpp:135
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
Definition: board.cpp:180
bool IsLayerEnabled(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition: board.cpp:706
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Return the type of the copper layer given by aLayer.
Definition: board.cpp:601
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
Definition: board.cpp:320
DRAWINGS m_drawings
Definition: board.h:1309
void OnItemsCompositeUpdate(std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aChangedItems)
Notify the board and its listeners that items on the board have been modified in a composite operatio...
Definition: board.cpp:2525
int SetAreasNetCodesFromNetNames()
Set the .m_NetCode member of all copper areas, according to the area Net Name The SetNetCodesFromNetN...
Definition: board.cpp:1971
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition: board.cpp:1943
EDA_UNITS GetUserUnits()
Definition: board.h:680
void ResetNetHighLight()
Reset all high light data to the init state.
Definition: board.cpp:2540
PCB_PLOT_PARAMS m_plotOptions
Definition: board.h:1332
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition: board.cpp:583
std::list< ZONE * > GetZoneList(bool aIncludeZonesInFootprints=false) const
Definition: board.cpp:2324
void ConvertBrdLayerToPolygonalContours(PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aOutlines) const
Build a set of polygons which are the outlines of copper items (pads, tracks, vias,...
Definition: board.cpp:2742
bool ResolveTextVar(wxString *token, int aDepth) const
Definition: board.cpp:424
const MARKERS & Markers() const
Definition: board.h:330
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:432
const std::vector< PAD * > GetPads() const
Return a reference to a list of all the pads.
Definition: board.cpp:2419
void Move(const VECTOR2I &aMoveVector) override
Move this object.
Definition: board.cpp:493
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:674
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
Definition: board.cpp:1555
int GetMaxClearanceValue() const
Returns the maximum clearance value for any object on the board.
Definition: board.h:1154
ZONES m_zones
Definition: board.h:1313
PAD * GetPad(const VECTOR2I &aPosition) const
Definition: board.h:1062
PCB_LAYER_ID GetLayerID(const wxString &aLayerName) const
Return the ID of a layer.
Definition: board.cpp:547
HIGH_LIGHT_INFO m_highLightPrevious
Definition: board.h:1322
const VECTOR2I GetFocusPosition() const override
Similar to GetPosition, but allows items to return their visual center rather than their anchor.
Definition: board.h:375
void HighLightOFF()
Disable net highlight.
Definition: board.h:546
NETINFO_LIST m_NetInfo
Definition: board.h:1357
LSET m_LegacyVisibleLayers
Visibility settings stored in board prior to 6.0, only used for loading legacy files.
Definition: board.h:360
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition: board.cpp:729
void SetOutlinesChainingEpsilon(int aValue)
Definition: board.h:719
NETINFO_LIST::iterator EndNets() const
Definition: board.h:872
GroupLegalOpsField GroupLegalOps(const PCB_SELECTION &selection) const
Check which selection tool group operations are legal given the selection.
Definition: board.cpp:2654
int GetCopperLayerCount() const
Definition: board.cpp:656
int m_timeStamp
Definition: board.h:1303
std::vector< BOARD_LISTENER * > m_listeners
Definition: board.h:1359
const std::map< wxString, wxString > & GetProperties() const
Definition: board.h:353
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsCourtyardCache
Definition: board.h:1260
void IncrementTimeStamp()
Definition: board.cpp:249
int MatchDpSuffix(const wxString &aNetName, wxString &aComplementNet)
Fetch the coupled netname for a given net.
Definition: board.cpp:1831
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsFCourtyardCache
Definition: board.h:1261
void RemoveUnusedNets(BOARD_COMMIT *aCommit)
Definition: board.h:855
const FOOTPRINTS & Footprints() const
Definition: board.h:322
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: board.h:1328
void RemoveAll(std::initializer_list< KICAD_T > aTypes={ PCB_NETINFO_T, PCB_MARKER_T, PCB_GROUP_T, PCB_ZONE_T, PCB_GENERATOR_T, PCB_FOOTPRINT_T, PCB_TRACE_T, PCB_SHAPE_T })
An efficient way to remove all items of a certain type from the board.
Definition: board.cpp:1126
const BOARD_ITEM_SET GetItemSet()
Definition: board.cpp:2843
const TRACKS & Tracks() const
Definition: board.h:320
int m_DRCMaxPhysicalClearance
Definition: board.h:1274
FOOTPRINT * FindFootprintByPath(const KIID_PATH &aPath) const
Search for a FOOTPRINT within this board with the given path.
Definition: board.cpp:1908
void FinalizeBulkRemove(std::vector< BOARD_ITEM * > &aRemovedItems)
Must be used if Remove() is used using a BULK_x REMOVE_MODE to generate a change event for listeners.
Definition: board.cpp:1014
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: board.h:669
bool GetTentVias() const
Definition: board.h:665
std::unordered_map< wxString, LSET > m_LayerExpressionCache
Definition: board.h:1265
wxString GroupsSanityCheckInternal(bool repair)
Definition: board.cpp:2585
void OnRatsnestChanged()
Notify the board and its listeners that the ratsnest has been recomputed.
Definition: board.cpp:2534
wxString ConvertCrossReferencesToKIIDs(const wxString &aSource) const
Convert cross-references back and forth between ${refDes:field} and ${kiid:field}.
Definition: board.cpp:1436
wxString GetClass() const override
Return the class name.
Definition: board.h:976
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition: board.cpp:712
NETINFO_LIST::iterator BeginNets() const
Definition: board.h:864
bool m_LegacyNetclassesLoaded
True if netclasses were loaded from the file.
Definition: board.h:368
void SetCopperLayerCount(int aCount)
Definition: board.cpp:662
std::unordered_map< const ZONE *, BOX2I > m_ZoneBBoxCache
Definition: board.h:1268
wxString m_generator
Definition: board.h:1325
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsBCourtyardCache
Definition: board.h:1262
TRACKS TracksInNet(int aNetCode)
Collect all the TRACKs and VIAs that are members of a net given by aNetCode.
Definition: board.cpp:513
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
Definition: board.cpp:190
PROJECT * m_project
Definition: board.h:1333
FOOTPRINT * GetFootprint(const VECTOR2I &aPosition, PCB_LAYER_ID aActiveLayer, bool aVisibleOnly, bool aIgnoreLocked=false) const
Get a footprint by its bounding rectangle at aPosition on aLayer.
Definition: board.cpp:2260
const wxString & GetFileName() const
Definition: board.h:318
bool operator==(const BOARD_ITEM &aOther) const override
Definition: board.cpp:2858
bool m_skipMaxClearanceCacheUpdate
Definition: board.h:1354
std::vector< PCB_MARKER * > ResolveDRCExclusions(bool aCreateMarkers)
Rebuild DRC markers from the serialized data in BOARD_DESIGN_SETTINGS.
Definition: board.cpp:337
FOOTPRINT * FindFootprintByReference(const wxString &aReference) const
Search for a FOOTPRINT within this board with the given reference designator.
Definition: board.cpp:1896
unsigned GetNodesCount(int aNet=-1) const
Definition: board.cpp:1538
bool IsHighLightNetON() const
Definition: board.h:532
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
Definition: board.cpp:1397
int GetFileFormatVersionAtLoad() const
Definition: board.h:385
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
Definition: board.cpp:752
std::shared_ptr< DRC_RTREE > m_CopperItemRTreeCache
Definition: board.h:1267
bool SetLayerType(PCB_LAYER_ID aLayer, LAYER_T aLayerType)
Change the type of the layer given by aLayer.
Definition: board.cpp:613
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: board.h:671
BOARD & operator=(const BOARD &aOther)=delete
wxString m_fileName
Definition: board.h:1305
const wxString & GetGenerator() const
Adds an item to the container.
Definition: board.h:388
int GetAreaCount() const
Definition: board.h:1023
void SetLegacyTeardrops(bool aFlag)
Definition: board.h:1244
int GetOutlinesChainingEpsilon()
Definition: board.h:718
void GetSortedPadListByXthenYCoord(std::vector< PAD * > &aVector, int aNetCode=-1) const
First empties then fills the vector with all pads and sorts them by increasing x coordinate,...
Definition: board.cpp:2162
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition: board.cpp:686
int m_DRCMaxClearance
Definition: board.h:1273
void ClearProject()
Definition: board.cpp:229
std::unordered_map< ZONE *, std::unique_ptr< DRC_RTREE > > m_CopperZoneRTreeCache
Definition: board.h:1266
void FinalizeBulkAdd(std::vector< BOARD_ITEM * > &aNewItems)
Must be used if Add() is used using a BULK_x ADD_MODE to generate a change event for listeners.
Definition: board.cpp:1008
int LayerDepth(PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) const
Definition: board.cpp:668
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition: board.cpp:1277
PROJECT * GetProject() const
Definition: board.h:475
bool IsEmpty() const
Definition: board.h:377
bool LegacyTeardrops() const
Definition: board.h:1243
std::tuple< int, double, double > GetTrackLength(const PCB_TRACK &aTrack) const
Return data on the length and number of track segments connected to a given track.
Definition: board.cpp:2177
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: board.cpp:1623
const TITLE_BLOCK & GetTitleBlock() const
Definition: board.h:675
void UpdateMaxClearanceCache()
Definition: board.cpp:803
wxString GroupsSanityCheck(bool repair=false)
Consistency check of internal m_groups structure.
Definition: board.cpp:2572
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:797
std::vector< ZONE * > m_DRCZones
Definition: board.h:1271
PAD * GetPad(const VECTOR2I &aPosition, LSET aLayerMask) const
Find a pad aPosition on aLayer.
Definition: board.cpp:2005
void SetGenerator(const wxString &aGenerator)
Definition: board.h:387
BOARD()
Definition: board.cpp:73
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
Definition: board.cpp:289
wxString ConvertKIIDsToCrossReferences(const wxString &aSource) const
Definition: board.cpp:1490
void SynchronizeProperties()
Copy the current project's text variables into the boards property cache.
Definition: board.cpp:1934
std::unordered_map< KIID, BOARD_ITEM * > m_itemByIdCache
Definition: board.h:1317
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
Definition: board.cpp:2495
std::shared_mutex m_CachesMutex
Definition: board.h:1259
unsigned GetNetCount() const
Definition: board.h:881
void DeleteMARKERs()
Delete all MARKERS from the board.
Definition: board.cpp:1239
void Remove(BOARD_ITEM *aBoardItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
Removes an item from the container.
Definition: board.cpp:1020
GROUPS m_groups
Definition: board.h:1312
MARKERS m_markers
Definition: board.h:1308
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_IntersectsAreaCache
Definition: board.h:1263
void HighLightON(bool aValue=true)
Enable or disable net highlighting.
Definition: board.cpp:2562
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: board.h:676
int m_maxClearanceValue
Definition: board.h:1355
bool TestZoneIntersection(ZONE *aZone1, ZONE *aZone2)
Test for intersection of 2 copper areas.
TRACKS m_tracks
Definition: board.h:1311
bool m_LegacyCopperEdgeClearanceLoaded
Definition: board.h:365
int GetTimeStamp() const
Definition: board.h:304
void OnItemsChanged(std::vector< BOARD_ITEM * > &aItems)
Notify the board and its listeners that an item on the board has been modified in some way.
Definition: board.cpp:2519
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:459
VECTOR2I GetPosition() const override
Definition: board.cpp:481
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition: board.cpp:832
static bool ClassOf(const EDA_ITEM *aItem)
Definition: board.h:283
void SetUserUnits(EDA_UNITS aUnits)
Definition: board.h:681
void SetVisibleElements(const GAL_SET &aMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:719
double Similarity(const BOARD_ITEM &aOther) const override
Return the Similarity.
Definition: board.h:969
const DRAWINGS & Drawings() const
Definition: board.h:324
void SetFileFormatVersionAtLoad(int aVersion)
Definition: board.h:384
const Vec GetCenter() const
Definition: box2.h:196
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:86
Implement an R-tree for fast spatial and layer indexing of connectable items.
Definition: drc_rtree.h:48
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:100
Helper for storing and iterating over GAL_LAYER_IDs.
Definition: layer_ids.h:307
void Clear()
Definition: board.h:220
HIGH_LIGHT_INFO()
Definition: board.h:226
std::set< int > m_netCodes
Definition: board.h:217
bool m_highLightOn
Definition: board.h:218
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
Definition: kiid.h:49
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:574
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
Handle the data for a net.
Definition: netinfo.h:56
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString,...
Definition: netinfo.h:401
Container for NETINFO_ITEM elements, which are the nets.
Definition: netinfo.h:342
void RemoveUnusedNets(BOARD_COMMIT *aCommit)
iterator begin() const
Definition: netinfo.h:446
unsigned GetNetCount() const
Definition: netinfo.h:365
iterator end() const
Definition: netinfo.h:451
void buildListOfNets()
Rebuild the list of NETINFO_ITEMs.
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
Definition: pcb_netlist.h:223
Definition: pad.h:59
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:59
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
The main frame for Pcbnew.
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:51
Parameters and options when plotting/printing a board.
void SetPlotViaOnMaskLayer(bool aFlag)
bool GetPlotViaOnMaskLayer() const
A holder to handle information on schematic or board items.
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
Definition: project.h:62
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
Represent a set of closed polygons.
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:41
Handle a list of polygons defining a copper zone.
Definition: zone.h:72
The common library.
const std::function< void(const wxString &msg, BOARD_ITEM *itemA, BOARD_ITEM *itemB, const VECTOR2I &pt)> OUTLINE_ERROR_HANDLER
INSPECT_RESULT
Definition: eda_item.h:43
const INSPECTOR_FUNC & INSPECTOR
Definition: eda_item.h:81
EDA_UNITS
Definition: eda_units.h:46
static void hash_combine(std::size_t &seed)
This is a dummy function to take the final case of hash_combine below.
Definition: hash.h:34
wxString LayerName(int aLayer)
Returns the default display name for a given layer.
Definition: layer_id.cpp:30
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:194
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ PCB_LAYER_ID_COUNT
Definition: layer_ids.h:137
STL namespace.
std::vector< ZONE * > ZONES
Definition: pcb_io_eagle.h:46
ENDPOINT_T
Definition: pcb_track.h:57
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition: board.cpp:2702
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition: board.cpp:2681
A struct recording the isolated and single-pad islands within a zone.
Definition: zone.h:59
Container to hold information pertinent to a layer of a BOARD.
Definition: board.h:162
static LAYER_T ParseType(const char *aType)
Convert a string to a LAYER_T.
Definition: board.cpp:641
void clear()
Definition: board.h:168
LAYER_T m_type
The type of the layer.
Definition: board.h:190
static const char * ShowType(LAYER_T aType)
Convert a LAYER_T enum to a string representation of the layer type.
Definition: board.cpp:628
LAYER()
Definition: board.h:163
wxString m_name
The canonical name of the layer.
Definition: board.h:188
wxString m_userName
The user defined name of the layer.
Definition: board.h:189
bool m_visible
Definition: board.h:191
int m_number
The layer ID.
Definition: board.h:192
BOARD_ITEM * A
Definition: board.h:87
bool operator==(const PTR_LAYER_CACHE_KEY &other) const
Definition: board.h:90
PCB_LAYER_ID Layer
Definition: board.h:88
BOARD_ITEM * A
Definition: board.h:76
BOARD_ITEM * B
Definition: board.h:77
bool operator==(const PTR_PTR_CACHE_KEY &other) const
Definition: board.h:79
bool operator==(const PTR_PTR_LAYER_CACHE_KEY &other) const
Definition: board.h:102
BOARD_ITEM * B
Definition: board.h:99
BOARD_ITEM * A
Definition: board.h:98
PCB_LAYER_ID Layer
Definition: board.h:100
std::size_t operator()(const PTR_LAYER_CACHE_KEY &k) const
Definition: board.h:124
std::size_t operator()(const PTR_PTR_CACHE_KEY &k) const
Definition: board.h:113
std::size_t operator()(const PTR_PTR_LAYER_CACHE_KEY &k) const
Definition: board.h:135
@ PCB_T
Definition: typeinfo.h:82
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:88
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition: typeinfo.h:91
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:110
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition: typeinfo.h:107
@ PCB_MARKER_T
class PCB_MARKER, a marker used to show something
Definition: typeinfo.h:99
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:86
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:109
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.
Definition: zone_settings.h:49