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 The 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
31#include <embedded_files.h>
32#include <common.h> // Needed for stl hash extensions
33#include <convert_shape_list_to_polygon.h> // for OUTLINE_ERROR_HANDLER
34#include <hash.h>
35#include <layer_ids.h>
36#include <lset.h>
37#include <netinfo.h>
38#include <pcb_item_containers.h>
39#include <pcb_plot_params.h>
40#include <title_block.h>
41#include <tools/pcb_selection.h>
42#include <shared_mutex>
43#include <list>
44
47class BOARD_COMMIT;
48class DRC_RTREE;
49class PCB_BASE_FRAME;
50class PCB_EDIT_FRAME;
52class BOARD;
53class FOOTPRINT;
54class ZONE;
55class PCB_TRACK;
56class PAD;
57class PCB_GROUP;
58class PCB_GENERATOR;
59class PCB_MARKER;
60class MSG_PANEL_ITEM;
61class NETLIST;
62class REPORTER;
63class SHAPE_POLY_SET;
65class COMPONENT;
66class PROJECT;
68struct ISOLATED_ISLANDS;
69
70// The default value for m_outlinesChainingEpsilon to convert a board outlines to polygons
71// It is the max dist between 2 end points to see them connected
72#define DEFAULT_CHAINING_EPSILON_MM 0.01
73
74// Forward declare endpoint from class_track.h
75enum ENDPOINT_T : int;
76
77
79{
82
83 bool operator==(const PTR_PTR_CACHE_KEY& other) const
84 {
85 return A == other.A && B == other.B;
86 }
87};
88
90{
93
94 bool operator==(const PTR_LAYER_CACHE_KEY& other) const
95 {
96 return A == other.A && Layer == other.Layer;
97 }
98};
99
101{
105
106 bool operator==(const PTR_PTR_LAYER_CACHE_KEY& other) const
107 {
108 return A == other.A && B == other.B && Layer == other.Layer;
109 }
110};
111
112namespace std
113{
114 template <>
115 struct hash<PTR_PTR_CACHE_KEY>
116 {
117 std::size_t operator()( const PTR_PTR_CACHE_KEY& k ) const
118 {
119 std::size_t seed = 0xa82de1c0;
120 hash_combine( seed, k.A, k.B );
121 return seed;
122 }
123 };
124
125 template <>
127 {
128 std::size_t operator()( const PTR_LAYER_CACHE_KEY& k ) const
129 {
130 std::size_t seed = 0xa82de1c0;
131 hash_combine( seed, k.A, k.Layer );
132 return seed;
133 }
134 };
135
136 template <>
138 {
139 std::size_t operator()( const PTR_PTR_LAYER_CACHE_KEY& k ) const
140 {
141 std::size_t seed = 0xa82de1c0;
142 hash_combine( seed, k.A, k.B, k.Layer );
143 return seed;
144 }
145 };
146}
147
148
153{
161 LT_BACK
163
164
168struct LAYER
169{
171 {
172 clear();
173 }
174
175 void clear()
176 {
178 m_visible = true;
179 m_number = 0;
180 m_name.clear();
181 m_userName.clear();
183 }
184
185 /*
186 LAYER( const wxString& aName = wxEmptyString,
187 LAYER_T aType = LT_SIGNAL, bool aVisible = true, int aNumber = -1 ) :
188 m_name( aName ),
189 m_type( aType ),
190 m_visible( aVisible ),
191 m_number( aNumber )
192 {
193 }
194 */
195
196 wxString m_name;
197 wxString m_userName;
202
209 static const char* ShowType( LAYER_T aType );
210
218 static LAYER_T ParseType( const char* aType );
219};
220
221
222// Helper class to handle high light nets
224{
225protected:
226 std::set<int> m_netCodes; // net(s) selected for highlight (-1 when no net selected )
227 bool m_highLightOn; // highlight active
228
229 void Clear()
230 {
231 m_netCodes.clear();
232 m_highLightOn = false;
233 }
234
236 {
237 Clear();
238 }
239
240private:
241 friend class BOARD;
242};
243
249class BOARD;
250
252{
253public:
254 virtual ~BOARD_LISTENER() { }
255 virtual void OnBoardItemAdded( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
256 virtual void OnBoardItemsAdded( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
257 virtual void OnBoardItemRemoved( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
258 virtual void OnBoardItemsRemoved( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
259 virtual void OnBoardNetSettingsChanged( BOARD& aBoard ) { }
260 virtual void OnBoardItemChanged( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
261 virtual void OnBoardItemsChanged( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
262 virtual void OnBoardHighlightNetChanged( BOARD& aBoard ) { }
263 virtual void OnBoardRatsnestChanged( BOARD& aBoard ) { }
264 virtual void OnBoardCompositeUpdate( BOARD& aBoard, std::vector<BOARD_ITEM*>& aAddedItems,
265 std::vector<BOARD_ITEM*>& aRemovedItems,
266 std::vector<BOARD_ITEM*>& aDeletedItems )
267 {
268 }
269};
270
274typedef std::set<BOARD_ITEM*, CompareByUuid> BOARD_ITEM_SET;
275
279enum class BOARD_USE
280{
281 NORMAL, // A normal board
282 FPHOLDER // A board that holds a single footprint
283};
284
285
290{
291public:
292 static inline bool ClassOf( const EDA_ITEM* aItem )
293 {
294 return aItem && PCB_T == aItem->Type();
295 }
296
302 void SetBoardUse( BOARD_USE aUse ) { m_boardUse = aUse; }
303
309 BOARD_USE GetBoardUse() const { return m_boardUse; }
310
311 void IncrementTimeStamp();
312
313 int GetTimeStamp() const { return m_timeStamp; }
314
320 bool IsFootprintHolder() const
321 {
322 return m_boardUse == BOARD_USE::FPHOLDER;
323 }
324
325 void SetFileName( const wxString& aFileName ) { m_fileName = aFileName; }
326
327 const wxString &GetFileName() const { return m_fileName; }
328
329 const TRACKS& Tracks() const { return m_tracks; }
330
331 const FOOTPRINTS& Footprints() const { return m_footprints; }
332
333 const DRAWINGS& Drawings() const { return m_drawings; }
334
335 const ZONES& Zones() const { return m_zones; }
336
337 const GENERATORS& Generators() const { return m_generators; }
338
339 const MARKERS& Markers() const { return m_markers; }
340
341 // SWIG requires non-const accessors for some reason to make the custom iterators in board.i
342 // work. It would be good to remove this if we can figure out how to fix that.
343#ifdef SWIG
344 DRAWINGS& Drawings() { return m_drawings; }
345 TRACKS& Tracks() { return m_tracks; }
346#endif
347
349
358 const GROUPS& Groups() const { return m_groups; }
359
360 const std::vector<BOARD_CONNECTED_ITEM*> AllConnectedItems();
361
362 const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
363 void SetProperties( const std::map<wxString, wxString>& aProps ) { m_properties = aProps; }
364
365 void GetContextualTextVars( wxArrayString* aVars ) const;
366 bool ResolveTextVar( wxString* token, int aDepth ) const;
367
371
375
378
379 BOARD();
380 ~BOARD();
381
382 VECTOR2I GetPosition() const override;
383 void SetPosition( const VECTOR2I& aPos ) override;
384 const VECTOR2I GetFocusPosition() const override { return GetBoundingBox().GetCenter(); }
385
386 bool IsEmpty() const
387 {
388 return m_drawings.empty() && m_footprints.empty() && m_tracks.empty() && m_zones.empty();
389 }
390
391 void Move( const VECTOR2I& aMoveVector ) override;
392
393 void RunOnDescendants( const std::function<void ( BOARD_ITEM* )>& aFunction,
394 int aDepth = 0 ) const override;
395
396 void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
398
399 void SetGenerator( const wxString& aGenerator ) { m_generator = aGenerator; }
400 const wxString& GetGenerator() const { return m_generator; }
401
403 void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT,
404 bool aSkipConnectivity = false ) override;
405
407 void Remove( BOARD_ITEM* aBoardItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) override;
408
417 void RemoveAll( std::initializer_list<KICAD_T> aTypes = { PCB_NETINFO_T, PCB_MARKER_T,
421
426 void FinalizeBulkAdd( std::vector<BOARD_ITEM*>& aNewItems );
427
432 void FinalizeBulkRemove( std::vector<BOARD_ITEM*>& aRemovedItems );
433
439 void FixupEmbeddedData();
440
441 void CacheTriangulation( PROGRESS_REPORTER* aReporter = nullptr,
442 const std::vector<ZONE*>& aZones = {} );
443
452 {
453 return m_footprints.empty() ? nullptr : m_footprints.front();
454 }
455
459 void DeleteAllFootprints();
460
464 BOARD_ITEM* GetItem( const KIID& aID ) const;
465
466 void FillItemMap( std::map<KIID, EDA_ITEM*>& aMap );
467
471 wxString ConvertCrossReferencesToKIIDs( const wxString& aSource ) const;
472 wxString ConvertKIIDsToCrossReferences( const wxString& aSource ) const;
473
478 std::shared_ptr<CONNECTIVITY_DATA> GetConnectivity() const { return m_connectivity; }
479
485 bool BuildConnectivity( PROGRESS_REPORTER* aReporter = nullptr );
486
490 void DeleteMARKERs();
491
492 void DeleteMARKERs( bool aWarningsAndErrors, bool aExclusions );
493
494 PROJECT* GetProject() const { return m_project; }
495
504 void SetProject( PROJECT* aProject, bool aReferenceOnly = false );
505
506 void ClearProject();
507
515 std::vector<PCB_MARKER*> ResolveDRCExclusions( bool aCreateMarkers );
516
520 void RecordDRCExclusions();
521
526
530 void ResetNetHighLight();
531
535 const std::set<int>& GetHighLightNetCodes() const
536 {
537 return m_highLight.m_netCodes;
538 }
539
546 void SetHighLightNet( int aNetCode, bool aMulti = false );
547
552
560 void HighLightON( bool aValue = true );
561
566 {
567 HighLightON( false );
568 }
569
573 int GetCopperLayerCount() const;
574 void SetCopperLayerCount( int aCount );
575
581
582 PCB_LAYER_ID FlipLayer( PCB_LAYER_ID aLayer ) const;
583
584 int LayerDepth( PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer ) const;
585
591 LSET GetEnabledLayers() const;
592
598 void SetEnabledLayers( LSET aLayerMask );
599
606 bool IsLayerEnabled( PCB_LAYER_ID aLayer ) const;
607
615 bool IsLayerVisible( PCB_LAYER_ID aLayer ) const;
616
622 LSET GetVisibleLayers() const;
623
630 void SetVisibleLayers( LSET aLayerMask );
631
632 // these 2 functions are not tidy at this time, since there are PCB_LAYER_IDs that
633 // are not stored in the bitmap.
634
642
649 void SetVisibleElements( const GAL_SET& aMask );
650
656 void SetVisibleAlls();
657
665 bool IsElementVisible( GAL_LAYER_ID aLayer ) const;
666
674 void SetElementVisibility( GAL_LAYER_ID aLayer, bool aNewState );
675
683 bool IsFootprintLayerVisible( PCB_LAYER_ID aLayer ) const;
684
689
691
692 const PAGE_INFO& GetPageSettings() const { return m_paper; }
693 void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
694
696 void SetPlotOptions( const PCB_PLOT_PARAMS& aOptions ) { m_plotOptions = aOptions; }
697
699 const TITLE_BLOCK& GetTitleBlock() const { return m_titles; }
700 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
701
702 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
703
705 void SetUserUnits( EDA_UNITS aUnits ) { m_userUnits = aUnits; }
706
711 void UpdateUserUnits( BOARD_ITEM* aItem, KIGFX::VIEW* aView );
712
731 OUTLINE_ERROR_HANDLER* aErrorHandler = nullptr,
732 bool aAllowUseArcsInPolygons = false,
733 bool aIncludeNPTHAsOutlines = false );
734
744
755 void ConvertBrdLayerToPolygonalContours( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aOutlines ) const;
756
760 PCB_LAYER_ID GetLayerID( const wxString& aLayerName ) const;
761
768 const wxString GetLayerName( PCB_LAYER_ID aLayer ) const;
769
777 bool SetLayerName( PCB_LAYER_ID aLayer, const wxString& aLayerName );
778
789 static wxString GetStandardLayerName( PCB_LAYER_ID aLayerId )
790 {
791 // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
792 return LayerName( aLayerId );
793 }
794
802 bool SetLayerDescr( PCB_LAYER_ID aIndex, const LAYER& aLayer );
803
810 LAYER_T GetLayerType( PCB_LAYER_ID aLayer ) const;
811
819 bool SetLayerType( PCB_LAYER_ID aLayer, LAYER_T aLayerType );
820
825 unsigned GetNodesCount( int aNet = -1 ) const;
826
835 const std::vector<PAD*> GetPads() const;
836
838 {
840 }
841
848 NETINFO_ITEM* FindNet( int aNetcode ) const;
849
856 NETINFO_ITEM* FindNet( const wxString& aNetname ) const;
857
867 int MatchDpSuffix( const wxString& aNetName, wxString& aComplementNet );
868
872 NETINFO_ITEM* DpCoupledNet( const NETINFO_ITEM* aNet );
873
875 {
876 return m_NetInfo;
877 }
878
880 {
881 m_NetInfo.RemoveUnusedNets( aCommit );
882 }
883
884#ifndef SWIG
889 {
890 return m_NetInfo.begin();
891 }
892
897 {
898 return m_NetInfo.end();
899 }
900#endif
901
905 unsigned GetNetCount() const
906 {
907 return m_NetInfo.GetNetCount();
908 }
909
916 BOX2I ComputeBoundingBox( bool aBoardEdgesOnly = false ) const;
917
918 const BOX2I GetBoundingBox() const override
919 {
920 return ComputeBoundingBox( false );
921 }
922
933 {
934 return ComputeBoundingBox( true );
935 }
936
937 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
938
950 INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
951 const std::vector<KICAD_T>& scanTypes ) override;
952
961 FOOTPRINT* FindFootprintByReference( const wxString& aReference ) const;
962
969 FOOTPRINT* FindFootprintByPath( const KIID_PATH& aPath ) const;
970
974 std::set<wxString> GetNetClassAssignmentCandidates() const;
975
983 void SynchronizeNetsAndNetClasses( bool aResetTrackAndViaSizes );
984
989
993 double Similarity( const BOARD_ITEM& aOther ) const override
994 {
995 return 1.0;
996 }
997
998 bool operator==( const BOARD_ITEM& aOther ) const override;
999
1000 wxString GetClass() const override
1001 {
1002 return wxT( "BOARD" );
1003 }
1004
1005#if defined(DEBUG)
1006 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
1007#endif
1008
1009
1010 /*************************/
1011 /* Copper Areas handling */
1012 /*************************/
1013
1024
1031 ZONE* GetArea( int index ) const
1032 {
1033 if( (unsigned) index < m_zones.size() )
1034 return m_zones[index];
1035
1036 return nullptr;
1037 }
1038
1042 std::list<ZONE*> GetZoneList( bool aIncludeZonesInFootprints = false ) const;
1043
1047 int GetAreaCount() const
1048 {
1049 return static_cast<int>( m_zones.size() );
1050 }
1051
1052 /* Functions used in test, merge and cut outlines */
1053
1066 ZONE* AddArea( PICKED_ITEMS_LIST* aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer,
1067 VECTOR2I aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch );
1068
1076 bool TestZoneIntersection( ZONE* aZone1, ZONE* aZone2 );
1077
1085 PAD* GetPad( const VECTOR2I& aPosition, LSET aLayerMask ) const;
1086 PAD* GetPad( const VECTOR2I& aPosition ) const
1087 {
1088 return GetPad( aPosition, LSET().set() );
1089 }
1090
1098 PAD* GetPad( const PCB_TRACK* aTrace, ENDPOINT_T aEndPoint ) const;
1099
1109 PAD* GetPadFast( const VECTOR2I& aPosition, LSET aLayerMask ) const;
1110
1125 PAD* GetPad( std::vector<PAD*>& aPadList, const VECTOR2I& aPosition, LSET aLayerMask ) const;
1126
1138 void GetSortedPadListByXthenYCoord( std::vector<PAD*>& aVector, int aNetCode = -1 ) const;
1139
1147 std::tuple<int, double, double> GetTrackLength( const PCB_TRACK& aTrack ) const;
1148
1156 TRACKS TracksInNet( int aNetCode );
1157
1170 FOOTPRINT* GetFootprint( const VECTOR2I& aPosition, PCB_LAYER_ID aActiveLayer,
1171 bool aVisibleOnly, bool aIgnoreLocked = false ) const;
1172
1178 int GetMaxClearanceValue() const;
1179
1185 void MapNets( BOARD* aDestBoard );
1186
1187 void SanitizeNetcodes();
1188
1197 void AddListener( BOARD_LISTENER* aListener );
1198
1203 void RemoveListener( BOARD_LISTENER* aListener );
1204
1208 void RemoveAllListeners();
1209
1214 void OnItemChanged( BOARD_ITEM* aItem );
1215
1220 void OnItemsChanged( std::vector<BOARD_ITEM*>& aItems );
1221
1226 void OnItemsCompositeUpdate( std::vector<BOARD_ITEM*>& aAddedItems,
1227 std::vector<BOARD_ITEM*>& aRemovedItems,
1228 std::vector<BOARD_ITEM*>& aChangedItems );
1229
1233 void OnRatsnestChanged();
1234
1241 wxString GroupsSanityCheck( bool repair = false );
1242
1248 wxString GroupsSanityCheckInternal( bool repair );
1249
1251 {
1252 bool create : 1;
1253 bool ungroup : 1;
1254 bool removeItems : 1;
1255 };
1256
1262 GroupLegalOpsField GroupLegalOps( const PCB_SELECTION& selection ) const;
1263
1264 bool LegacyTeardrops() const { return m_legacyTeardrops; }
1265 void SetLegacyTeardrops( bool aFlag ) { m_legacyTeardrops = aFlag; }
1266
1267 EMBEDDED_FILES* GetEmbeddedFiles() override;
1268 const EMBEDDED_FILES* GetEmbeddedFiles() const;
1269
1273 void EmbedFonts() override;
1274
1279
1280 // --------- Item order comparators ---------
1281
1283 {
1284 bool operator() ( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
1285 };
1286
1288 {
1289 bool operator()( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
1290 };
1291
1292public:
1293 // ------------ Run-time caches -------------
1294 mutable std::shared_mutex m_CachesMutex;
1295 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsCourtyardCache;
1296 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsFCourtyardCache;
1297 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsBCourtyardCache;
1298 std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, bool> m_IntersectsAreaCache;
1299 std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, bool> m_EnclosedByAreaCache;
1300 std::unordered_map< wxString, LSET > m_LayerExpressionCache;
1301 std::unordered_map<ZONE*, std::unique_ptr<DRC_RTREE>> m_CopperZoneRTreeCache;
1302 std::shared_ptr<DRC_RTREE> m_CopperItemRTreeCache;
1303 mutable std::unordered_map<const ZONE*, BOX2I> m_ZoneBBoxCache;
1304 mutable std::optional<int> m_maxClearanceValue;
1305
1306 // ------------ DRC caches -------------
1307 std::vector<ZONE*> m_DRCZones;
1308 std::vector<ZONE*> m_DRCCopperZones;
1311 ZONE* m_SolderMaskBridges; // A container to build bridges on solder mask layers
1312 std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>> m_ZoneIsolatedIslandsMap;
1313
1314private:
1315 // The default copy constructor & operator= are inadequate,
1316 // either write one or do not use it at all
1317 BOARD( const BOARD& aOther ) = delete;
1318
1319 BOARD& operator=( const BOARD& aOther ) = delete;
1320
1321 template <typename Func, typename... Args>
1322 void InvokeListeners( Func&& aFunc, Args&&... args )
1323 {
1324 for( auto&& l : m_listeners )
1325 ( l->*aFunc )( std::forward<Args>( args )... );
1326 }
1327
1328 // Refresh user layer opposites.
1329 void recalcOpposites();
1330
1331 friend class PCB_EDIT_FRAME;
1332
1333private:
1336
1339 int m_timeStamp; // actually a modification counter
1340
1341 wxString m_fileName;
1342
1343 // These containers only have const accessors and must only be modified by Add()/Remove()
1344 MARKERS m_markers;
1345 DRAWINGS m_drawings;
1346 FOOTPRINTS m_footprints;
1348 GROUPS m_groups;
1350 GENERATORS m_generators;
1351
1352 // Cache for fast access to items in the containers above by KIID, including children
1353 std::unordered_map<KIID, BOARD_ITEM*> m_itemByIdCache;
1354
1355 std::map<int, LAYER> m_layers; // layer data
1356
1357 HIGH_LIGHT_INFO m_highLight; // current high light data
1358 HIGH_LIGHT_INFO m_highLightPrevious; // a previously stored high light data
1359
1360 int m_fileFormatVersionAtLoad; // the version loaded from the file
1361 wxString m_generator; // the generator tag from the file
1362
1363 std::map<wxString, wxString> m_properties;
1364 std::shared_ptr<CONNECTIVITY_DATA> m_connectivity;
1365
1367 TITLE_BLOCK m_titles; // text in lower right of screen and plots
1369 PROJECT* m_project; // project this board is a part of
1371
1382 std::unique_ptr<BOARD_DESIGN_SETTINGS> m_designSettings;
1383
1388 bool m_legacyTeardrops = false;
1389
1390 NETINFO_LIST m_NetInfo; // net info list (name, design constraints...
1391
1392 std::vector<BOARD_LISTENER*> m_listeners;
1393
1395
1397};
1398
1399
1400#endif // CLASS_BOARD_H_
BOARD_USE
Flags to specify how the board is being used.
Definition: board.h:280
LAYER_T
The allowed types of layers, same as Specctra DSN spec.
Definition: board.h:153
@ LT_POWER
Definition: board.h:156
@ LT_FRONT
Definition: board.h:160
@ LT_MIXED
Definition: board.h:157
@ LT_BACK
Definition: board.h:161
@ LT_UNDEFINED
Definition: board.h:154
@ LT_JUMPER
Definition: board.h:158
@ LT_AUX
Definition: board.h:159
@ LT_SIGNAL
Definition: board.h:155
std::set< BOARD_ITEM *, CompareByUuid > BOARD_ITEM_SET
Set of BOARD_ITEMs ordered by UUID.
Definition: board.h:274
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:79
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:139
virtual void OnBoardNetSettingsChanged(BOARD &aBoard)
Definition: board.h:259
virtual void OnBoardItemsAdded(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:256
virtual void OnBoardRatsnestChanged(BOARD &aBoard)
Definition: board.h:263
virtual void OnBoardCompositeUpdate(BOARD &aBoard, std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aDeletedItems)
Definition: board.h:264
virtual void OnBoardItemsChanged(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:261
virtual void OnBoardItemChanged(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:260
virtual void OnBoardItemRemoved(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:257
virtual void OnBoardItemAdded(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:255
virtual void OnBoardHighlightNetChanged(BOARD &aBoard)
Definition: board.h:262
virtual ~BOARD_LISTENER()
Definition: board.h:254
virtual void OnBoardItemsRemoved(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:258
Manage layers needed to make a physical board.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:290
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:1812
ZONE * m_SolderMaskBridges
Definition: board.h:1311
void GetContextualTextVars(wxArrayString *aVars) const
Definition: board.cpp:407
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:922
BOARD_STACKUP GetStackupOrDefault() const
Definition: board.cpp:2330
void SetPlotOptions(const PCB_PLOT_PARAMS &aOptions)
Definition: board.h:696
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_EnclosedByAreaCache
Definition: board.h:1299
std::map< ZONE *, std::map< PCB_LAYER_ID, ISOLATED_ISLANDS > > m_ZoneIsolatedIslandsMap
Definition: board.h:1312
PCB_LAYER_ID GetCopperLayerStackMaxId() const
Definition: board.cpp:792
GENERATORS m_generators
Definition: board.h:1350
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:2536
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:2733
const NETINFO_LIST & GetNetInfo() const
Definition: board.h:874
bool m_LegacyDesignSettingsLoaded
True if the legacy board design settings were loaded from a file.
Definition: board.h:373
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
Definition: board.h:320
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:817
void recalcOpposites()
Definition: board.cpp:712
void SetPosition(const VECTOR2I &aPos) override
Definition: board.cpp:496
std::map< wxString, wxString > m_properties
Definition: board.h:1363
EMBEDDED_FILES * GetEmbeddedFiles() override
Definition: board.cpp:2589
int m_fileFormatVersionAtLoad
Definition: board.h:1360
NETINFO_ITEM * DpCoupledNet(const NETINFO_ITEM *aNet)
Definition: board.cpp:2032
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:831
std::vector< ZONE * > m_DRCCopperZones
Definition: board.h:1308
BOARD_USE GetBoardUse() const
Get what the board use is.
Definition: board.h:309
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition: board.cpp:1042
const std::set< int > & GetHighLightNetCodes() const
Definition: board.h:535
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:2679
bool m_legacyTeardrops
Teardrops in 7.0 were applied as a post-processing step (rather than from pad and via properties).
Definition: board.h:1388
TITLE_BLOCK m_titles
Definition: board.h:1367
GAL_SET m_LegacyVisibleItems
Definition: board.h:370
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:302
ZONE * GetArea(int index) const
Return the Zone at a given index.
Definition: board.h:1031
const BOX2I GetBoardEdgesBoundingBox() const
Return the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition: board.h:932
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: board.h:918
void BuildListOfNets()
Definition: board.h:837
PAD * GetPadFast(const VECTOR2I &aPosition, LSET aLayerMask) const
Return pad found at aPosition on aLayerMask using the fast search method.
Definition: board.cpp:2188
const GENERATORS & Generators() const
Definition: board.h:337
void SetFileName(const wxString &aFileName)
Definition: board.h:325
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:789
const std::vector< BOARD_CONNECTED_ITEM * > AllConnectedItems()
Definition: board.cpp:2653
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:883
int m_outlinesChainingEpsilon
the max distance between 2 end point to see them connected when building the board outlines
Definition: board.h:1335
std::set< wxString > GetNetClassAssignmentCandidates() const
Return the set of netname candidates for netclass assignment.
Definition: board.cpp:2071
BOARD_USE m_boardUse
What is this board being used for.
Definition: board.h:1338
PAGE_INFO m_paper
Definition: board.h:1366
void RemoveAllListeners()
Remove all listeners.
Definition: board.cpp:2727
FOOTPRINTS m_footprints
Definition: board.h:1346
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:1382
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:837
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:2708
const PAGE_INFO & GetPageSettings() const
Definition: board.h:692
void UpdateUserUnits(BOARD_ITEM *aItem, KIGFX::VIEW *aView)
Update any references within aItem (or its descendants) to the user units.
Definition: board.cpp:1374
void SetProperties(const std::map< wxString, wxString > &aProps)
Definition: board.h:363
BOARD(const BOARD &aOther)=delete
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
Definition: board.cpp:877
void SetHighLightNet(int aNetCode, bool aMulti=false)
Select the netcode to be highlighted.
Definition: board.cpp:2769
HIGH_LIGHT_INFO m_highLight
Definition: board.h:1357
bool SetLayerDescr(PCB_LAYER_ID aIndex, const LAYER &aLayer)
Return the type of the copper layer given by aLayer.
Definition: board.cpp:585
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
Definition: board.cpp:1961
EDA_UNITS m_userUnits
Definition: board.h:1370
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:1451
const ZONES & Zones() const
Definition: board.h:335
void InvokeListeners(Func &&aFunc, Args &&... args)
Definition: board.h:1322
void SanitizeNetcodes()
Definition: board.cpp:2698
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:2511
const GROUPS & Groups() const
The groups must maintain the following invariants.
Definition: board.h:358
~BOARD()
Definition: board.cpp:144
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:187
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:843
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Return the type of the copper layer given by aLayer.
Definition: board.cpp:651
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
Definition: board.cpp:327
DRAWINGS m_drawings
Definition: board.h:1345
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:2745
int SetAreasNetCodesFromNetNames()
Set the .m_NetCode member of all copper areas, according to the area Net Name The SetNetCodesFromNetN...
Definition: board.cpp:2124
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition: board.cpp:2094
EDA_UNITS GetUserUnits()
Definition: board.h:704
void ResetNetHighLight()
Reset all high light data to the init state.
Definition: board.cpp:2760
PCB_PLOT_PARAMS m_plotOptions
Definition: board.h:1368
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition: board.cpp:631
std::list< ZONE * > GetZoneList(bool aIncludeZonesInFootprints=false) const
Definition: board.cpp:2491
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:2964
bool ResolveTextVar(wxString *token, int aDepth) const
Definition: board.cpp:433
const MARKERS & Markers() const
Definition: board.h:339
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:451
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayer) const
Definition: board.cpp:773
const std::vector< PAD * > GetPads() const
Return a reference to a list of all the pads.
Definition: board.cpp:2639
void Move(const VECTOR2I &aMoveVector) override
Move this object.
Definition: board.cpp:502
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:698
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
Definition: board.cpp:1713
void FixupEmbeddedData()
After loading a file from disk, the footprints do not yet contain the full data for their embedded fi...
Definition: board.cpp:1022
int GetMaxClearanceValue() const
Returns the maximum clearance value for any object on the board.
Definition: board.cpp:940
ZONES m_zones
Definition: board.h:1349
PAD * GetPad(const VECTOR2I &aPosition) const
Definition: board.h:1086
PCB_LAYER_ID GetLayerID(const wxString &aLayerName) const
Return the ID of a layer.
Definition: board.cpp:593
HIGH_LIGHT_INFO m_highLightPrevious
Definition: board.h:1358
const VECTOR2I GetFocusPosition() const override
Similar to GetPosition() but allows items to return their visual center rather than their anchor.
Definition: board.h:384
void HighLightOFF()
Disable net highlight.
Definition: board.h:565
NETINFO_LIST m_NetInfo
Definition: board.h:1390
LSET m_LegacyVisibleLayers
Visibility settings stored in board prior to 6.0, only used for loading legacy files.
Definition: board.h:369
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition: board.cpp:866
void SetOutlinesChainingEpsilon(int aValue)
Definition: board.h:743
NETINFO_LIST::iterator EndNets() const
Definition: board.h:896
GroupLegalOpsField GroupLegalOps(const PCB_SELECTION &selection) const
Check which selection tool group operations are legal given the selection.
Definition: board.cpp:2874
int GetCopperLayerCount() const
Definition: board.cpp:780
int m_timeStamp
Definition: board.h:1339
std::vector< BOARD_LISTENER * > m_listeners
Definition: board.h:1392
const std::map< wxString, wxString > & GetProperties() const
Definition: board.h:362
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsCourtyardCache
Definition: board.h:1295
void IncrementTimeStamp()
Definition: board.cpp:255
int MatchDpSuffix(const wxString &aNetName, wxString &aComplementNet)
Fetch the coupled netname for a given net.
Definition: board.cpp:1982
COMPONENT_CLASS_MANAGER m_componentClassManager
Definition: board.h:1396
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsFCourtyardCache
Definition: board.h:1296
void RemoveUnusedNets(BOARD_COMMIT *aCommit)
Definition: board.h:879
const FOOTPRINTS & Footprints() const
Definition: board.h:331
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: board.h:1364
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:1287
const BOARD_ITEM_SET GetItemSet()
Definition: board.cpp:3065
const TRACKS & Tracks() const
Definition: board.h:329
int m_DRCMaxPhysicalClearance
Definition: board.h:1310
FOOTPRINT * FindFootprintByPath(const KIID_PATH &aPath) const
Search for a FOOTPRINT within this board with the given path.
Definition: board.cpp:2059
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:1170
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: board.h:693
std::unordered_map< wxString, LSET > m_LayerExpressionCache
Definition: board.h:1300
bool m_embedFonts
Definition: board.h:1394
wxString GroupsSanityCheckInternal(bool repair)
Definition: board.cpp:2805
void OnRatsnestChanged()
Notify the board and its listeners that the ratsnest has been recomputed.
Definition: board.cpp:2754
wxString ConvertCrossReferencesToKIIDs(const wxString &aSource) const
Convert cross-references back and forth between ${refDes:field} and ${kiid:field}.
Definition: board.cpp:1594
wxString GetClass() const override
Return the class name.
Definition: board.h:1000
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition: board.cpp:849
NETINFO_LIST::iterator BeginNets() const
Definition: board.h:888
bool m_LegacyNetclassesLoaded
True if netclasses were loaded from the file.
Definition: board.h:377
void SetCopperLayerCount(int aCount)
Definition: board.cpp:786
std::unordered_map< const ZONE *, BOX2I > m_ZoneBBoxCache
Definition: board.h:1303
wxString m_generator
Definition: board.h:1361
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsBCourtyardCache
Definition: board.h:1297
TRACKS TracksInNet(int aNetCode)
Collect all the TRACKs and VIAs that are members of a net given by aNetCode.
Definition: board.cpp:563
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
Definition: board.cpp:197
PROJECT * m_project
Definition: board.h:1369
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:2427
const wxString & GetFileName() const
Definition: board.h:327
bool operator==(const BOARD_ITEM &aOther) const override
Definition: board.cpp:3080
std::vector< PCB_MARKER * > ResolveDRCExclusions(bool aCreateMarkers)
Rebuild DRC markers from the serialized data in BOARD_DESIGN_SETTINGS.
Definition: board.cpp:344
FOOTPRINT * FindFootprintByReference(const wxString &aReference) const
Search for a FOOTPRINT within this board with the given reference designator.
Definition: board.cpp:2047
unsigned GetNodesCount(int aNet=-1) const
Definition: board.cpp:1696
bool IsHighLightNetON() const
Definition: board.h:551
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
Definition: board.cpp:1555
int GetFileFormatVersionAtLoad() const
Definition: board.h:397
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
Definition: board.cpp:889
std::shared_ptr< DRC_RTREE > m_CopperItemRTreeCache
Definition: board.h:1302
bool SetLayerType(PCB_LAYER_ID aLayer, LAYER_T aLayerType)
Change the type of the layer given by aLayer.
Definition: board.cpp:670
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: board.h:695
BOARD & operator=(const BOARD &aOther)=delete
wxString m_fileName
Definition: board.h:1341
const wxString & GetGenerator() const
Adds an item to the container.
Definition: board.h:400
int GetAreaCount() const
Definition: board.h:1047
void SetLegacyTeardrops(bool aFlag)
Definition: board.h:1265
std::map< int, LAYER > m_layers
Definition: board.h:1355
int GetOutlinesChainingEpsilon()
Definition: board.h:742
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:2315
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:823
int m_DRCMaxClearance
Definition: board.h:1309
void ClearProject()
Definition: board.cpp:235
std::unordered_map< ZONE *, std::unique_ptr< DRC_RTREE > > m_CopperZoneRTreeCache
Definition: board.h:1301
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:1164
int LayerDepth(PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) const
Definition: board.cpp:805
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition: board.cpp:1438
PROJECT * GetProject() const
Definition: board.h:494
bool IsEmpty() const
Definition: board.h:386
bool LegacyTeardrops() const
Definition: board.h:1264
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:2341
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:1774
const TITLE_BLOCK & GetTitleBlock() const
Definition: board.h:699
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction, int aDepth=0) const override
Invoke a function on all descendants.
Definition: board.cpp:524
wxString GroupsSanityCheck(bool repair=false)
Consistency check of internal m_groups structure.
Definition: board.cpp:2792
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:934
std::vector< ZONE * > m_DRCZones
Definition: board.h:1307
PAD * GetPad(const VECTOR2I &aPosition, LSET aLayerMask) const
Find a pad aPosition on aLayer.
Definition: board.cpp:2158
void SetGenerator(const wxString &aGenerator)
Definition: board.h:399
BOARD()
Definition: board.cpp:75
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
Definition: board.cpp:296
wxString ConvertKIIDsToCrossReferences(const wxString &aSource) const
Definition: board.cpp:1648
void SynchronizeProperties()
Copy the current project's text variables into the boards property cache.
Definition: board.cpp:2085
std::unordered_map< KIID, BOARD_ITEM * > m_itemByIdCache
Definition: board.h:1353
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
Definition: board.cpp:2715
COMPONENT_CLASS_MANAGER & GetComponentClassManager()
Gets the component class manager.
Definition: board.h:1278
std::shared_mutex m_CachesMutex
Definition: board.h:1294
unsigned GetNetCount() const
Definition: board.h:905
void DeleteMARKERs()
Delete all MARKERS from the board.
Definition: board.cpp:1400
void Remove(BOARD_ITEM *aBoardItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
Removes an item from the container.
Definition: board.cpp:1176
GROUPS m_groups
Definition: board.h:1348
MARKERS m_markers
Definition: board.h:1344
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_IntersectsAreaCache
Definition: board.h:1298
std::optional< int > m_maxClearanceValue
Definition: board.h:1304
void HighLightON(bool aValue=true)
Enable or disable net highlighting.
Definition: board.cpp:2782
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: board.h:700
bool TestZoneIntersection(ZONE *aZone1, ZONE *aZone2)
Test for intersection of 2 copper areas.
TRACKS m_tracks
Definition: board.h:1347
bool m_LegacyCopperEdgeClearanceLoaded
Definition: board.h:374
int GetTimeStamp() const
Definition: board.h:313
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:2739
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:478
VECTOR2I GetPosition() const override
Definition: board.cpp:490
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition: board.cpp:972
static bool ClassOf(const EDA_ITEM *aItem)
Definition: board.h:292
void SetUserUnits(EDA_UNITS aUnits)
Definition: board.h:705
void SetVisibleElements(const GAL_SET &aMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:856
void EmbedFonts() override
Finds all fonts used in the board and embeds them in the file if permissions allow.
Definition: board.cpp:2607
double Similarity(const BOARD_ITEM &aOther) const override
Return the Similarity.
Definition: board.h:993
const DRAWINGS & Drawings() const
Definition: board.h:333
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: board.cpp:1368
void SetFileFormatVersionAtLoad(int aVersion)
Definition: board.h:396
constexpr const Vec GetCenter() const
Definition: box2.h:230
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:88
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:89
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
Helper for storing and iterating over GAL_LAYER_IDs.
Definition: layer_ids.h:355
void Clear()
Definition: board.h:229
HIGH_LIGHT_INFO()
Definition: board.h:235
std::set< int > m_netCodes
Definition: board.h:226
bool m_highLightOn
Definition: board.h:227
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:67
Definition: kiid.h:49
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
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:407
Container for NETINFO_ITEM elements, which are the nets.
Definition: netinfo.h:346
void RemoveUnusedNets(BOARD_COMMIT *aCommit)
iterator begin() const
Definition: netinfo.h:452
unsigned GetNetCount() const
Definition: netinfo.h:369
iterator end() const
Definition: netinfo.h:457
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:241
Definition: pad.h:54
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:52
Parameters and options when plotting/printing a board.
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:64
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:72
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:73
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
std::function passed to nested users by ref, avoids copying std::function.
Definition: eda_item.h:82
EDA_UNITS
Definition: eda_units.h:46
static constexpr void hash_combine(std::size_t &seed)
This is a dummy function to take the final case of hash_combine below.
Definition: hash.h:32
wxString LayerName(int aLayer)
Returns the default display name for a given layer.
Definition: layer_id.cpp:31
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:191
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
STL namespace.
std::vector< ZONE * > ZONES
Definition: pcb_io_eagle.h:47
ENDPOINT_T
Definition: pcb_track.h:59
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition: board.cpp:2924
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition: board.cpp:2903
A struct recording the isolated and single-pad islands within a zone.
Definition: zone.h:60
Container to hold information pertinent to a layer of a BOARD.
Definition: board.h:169
int m_opposite
Similar layer on opposite side of the board, if any.
Definition: board.h:201
static LAYER_T ParseType(const char *aType)
Convert a string to a LAYER_T.
Definition: board.cpp:699
void clear()
Definition: board.h:175
LAYER_T m_type
The type of the layer.
Definition: board.h:198
static const char * ShowType(LAYER_T aType)
Convert a LAYER_T enum to a string representation of the layer type.
Definition: board.cpp:683
LAYER()
Definition: board.h:170
wxString m_name
The canonical name of the layer.
Definition: board.h:196
wxString m_userName
The user defined name of the layer.
Definition: board.h:197
bool m_visible
Definition: board.h:199
int m_number
The layer ID.
Definition: board.h:200
BOARD_ITEM * A
Definition: board.h:91
bool operator==(const PTR_LAYER_CACHE_KEY &other) const
Definition: board.h:94
PCB_LAYER_ID Layer
Definition: board.h:92
BOARD_ITEM * A
Definition: board.h:80
BOARD_ITEM * B
Definition: board.h:81
bool operator==(const PTR_PTR_CACHE_KEY &other) const
Definition: board.h:83
bool operator==(const PTR_PTR_LAYER_CACHE_KEY &other) const
Definition: board.h:106
BOARD_ITEM * B
Definition: board.h:103
BOARD_ITEM * A
Definition: board.h:102
PCB_LAYER_ID Layer
Definition: board.h:104
std::size_t operator()(const PTR_LAYER_CACHE_KEY &k) const
Definition: board.h:128
std::size_t operator()(const PTR_PTR_CACHE_KEY &k) const
Definition: board.h:117
std::size_t operator()(const PTR_PTR_LAYER_CACHE_KEY &k) const
Definition: board.h:139
@ 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:50