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 <project.h>
44#include <list>
45
48class BOARD_COMMIT;
49class DRC_RTREE;
50class PCB_BASE_FRAME;
51class PCB_EDIT_FRAME;
54class BOARD;
55class FOOTPRINT;
56class ZONE;
57class PCB_TRACK;
58class PAD;
59class PCB_GROUP;
60class PCB_GENERATOR;
61class PCB_MARKER;
62class MSG_PANEL_ITEM;
63class NETLIST;
64class REPORTER;
65class SHAPE_POLY_SET;
67class COMPONENT;
68class PROJECT;
71
72
73namespace KIFONT
74{
75 class OUTLINE_FONT;
76}
77
78struct ISOLATED_ISLANDS;
79
80// The default value for m_outlinesChainingEpsilon to convert a board outlines to polygons
81// It is the max dist between 2 end points to see them connected
82#define DEFAULT_CHAINING_EPSILON_MM 0.01
83
84// Forward declare endpoint from class_track.h
85enum ENDPOINT_T : int;
86
87
89{
92
93 bool operator==(const PTR_PTR_CACHE_KEY& other) const
94 {
95 return A == other.A && B == other.B;
96 }
97};
98
100{
103
104 bool operator==(const PTR_LAYER_CACHE_KEY& other) const
105 {
106 return A == other.A && Layer == other.Layer;
107 }
108};
109
111{
115
116 bool operator==(const PTR_PTR_LAYER_CACHE_KEY& other) const
117 {
118 return A == other.A && B == other.B && Layer == other.Layer;
119 }
120};
121
123{
125 layers(),
126 has_error( false )
127 {}
128
130 layers( { aLayer } ),
131 has_error( false )
132 {}
133
136};
137
138
139namespace std
140{
141 template <>
142 struct hash<PTR_PTR_CACHE_KEY>
143 {
144 std::size_t operator()( const PTR_PTR_CACHE_KEY& k ) const
145 {
146 std::size_t seed = 0xa82de1c0;
147 hash_combine( seed, k.A, k.B );
148 return seed;
149 }
150 };
151
152 template <>
154 {
155 std::size_t operator()( const PTR_LAYER_CACHE_KEY& k ) const
156 {
157 std::size_t seed = 0xa82de1c0;
158 hash_combine( seed, k.A, k.Layer );
159 return seed;
160 }
161 };
162
163 template <>
165 {
166 std::size_t operator()( const PTR_PTR_LAYER_CACHE_KEY& k ) const
167 {
168 std::size_t seed = 0xa82de1c0;
169 hash_combine( seed, k.A, k.B, k.Layer );
170 return seed;
171 }
172 };
173}
174
175
190
191
195struct LAYER
196{
198 {
199 clear();
200 }
201
202 void clear()
203 {
205 m_visible = true;
206 m_number = 0;
207 m_name.clear();
208 m_userName.clear();
210 }
211
212 /*
213 LAYER( const wxString& aName = wxEmptyString,
214 LAYER_T aType = LT_SIGNAL, bool aVisible = true, int aNumber = -1 ) :
215 m_name( aName ),
216 m_type( aType ),
217 m_visible( aVisible ),
218 m_number( aNumber )
219 {
220 }
221 */
222
223 wxString m_name;
224 wxString m_userName;
229
236 static const char* ShowType( LAYER_T aType );
237
245 static LAYER_T ParseType( const char* aType );
246};
247
248
249// Helper class to handle high light nets
251{
252protected:
253 std::set<int> m_netCodes; // net(s) selected for highlight (-1 when no net selected )
254 bool m_highLightOn; // highlight active
255
256 void Clear()
257 {
258 m_netCodes.clear();
259 m_highLightOn = false;
260 }
261
263 {
264 Clear();
265 }
266
267private:
268 friend class BOARD;
269};
270
276class BOARD;
277
279{
280public:
281 virtual ~BOARD_LISTENER() { }
282 virtual void OnBoardItemAdded( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
283 virtual void OnBoardItemsAdded( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
284 virtual void OnBoardItemRemoved( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
285 virtual void OnBoardItemsRemoved( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
286 virtual void OnBoardNetSettingsChanged( BOARD& aBoard ) { }
287 virtual void OnBoardItemChanged( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
288 virtual void OnBoardItemsChanged( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
289 virtual void OnBoardHighlightNetChanged( BOARD& aBoard ) { }
290 virtual void OnBoardRatsnestChanged( BOARD& aBoard ) { }
291 virtual void OnBoardCompositeUpdate( BOARD& aBoard, std::vector<BOARD_ITEM*>& aAddedItems,
292 std::vector<BOARD_ITEM*>& aRemovedItems,
293 std::vector<BOARD_ITEM*>& aChangedItems )
294 {
295 }
296};
297
301typedef std::set<BOARD_ITEM*, CompareByUuid> BOARD_ITEM_SET;
302
306enum class BOARD_USE
307{
308 NORMAL, // A normal board
309 FPHOLDER // A board that holds a single footprint
310};
311
312
317{
318public:
319 static inline bool ClassOf( const EDA_ITEM* aItem )
320 {
321 return aItem && PCB_T == aItem->Type();
322 }
323
329 void SetBoardUse( BOARD_USE aUse ) { m_boardUse = aUse; }
330
336 BOARD_USE GetBoardUse() const { return m_boardUse; }
337
338 void IncrementTimeStamp();
339
340 int GetTimeStamp() const { return m_timeStamp; }
341
347 bool IsFootprintHolder() const
348 {
350 }
351
352 void SetFileName( const wxString& aFileName ) { m_fileName = aFileName; }
353
354 const wxString &GetFileName() const { return m_fileName; }
355
356 const TRACKS& Tracks() const { return m_tracks; }
357
358 const FOOTPRINTS& Footprints() const { return m_footprints; }
359
360 const DRAWINGS& Drawings() const { return m_drawings; }
361
362 const ZONES& Zones() const { return m_zones; }
363
364 const GENERATORS& Generators() const { return m_generators; }
365
368 void UpdateBoardOutline();
369
370 const MARKERS& Markers() const { return m_markers; }
371
372 const PCB_POINTS& Points() const { return m_points; }
373
374 // SWIG requires non-const accessors for some reason to make the custom iterators in board.i
375 // work. It would be good to remove this if we can figure out how to fix that.
376#ifdef SWIG
377 DRAWINGS& Drawings() { return m_drawings; }
378 TRACKS& Tracks() { return m_tracks; }
379#endif
380
382
391 const GROUPS& Groups() const { return m_groups; }
392
393 const std::vector<BOARD_CONNECTED_ITEM*> AllConnectedItems();
394
395 const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
396 void SetProperties( const std::map<wxString, wxString>& aProps ) { m_properties = aProps; }
397
398 void GetContextualTextVars( wxArrayString* aVars ) const;
399 bool ResolveTextVar( wxString* token, int aDepth ) const;
400
404
408
411
412 BOARD();
413 ~BOARD();
414
415 VECTOR2I GetPosition() const override;
416 void SetPosition( const VECTOR2I& aPos ) override;
417 const VECTOR2I GetFocusPosition() const override { return GetBoundingBox().GetCenter(); }
418
419 bool IsEmpty() const;
420
421 void Move( const VECTOR2I& aMoveVector ) override;
422
423 void RunOnChildren( const std::function<void( BOARD_ITEM* )>& aFunction, RECURSE_MODE aMode ) const override;
424
425 void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
427
428 void SetGenerator( const wxString& aGenerator ) { m_generator = aGenerator; }
429 const wxString& GetGenerator() const { return m_generator; }
430
432 void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT,
433 bool aSkipConnectivity = false ) override;
434
436 void Remove( BOARD_ITEM* aBoardItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) override;
437
446 void RemoveAll( std::initializer_list<KICAD_T> aTypes = { PCB_NETINFO_T, PCB_MARKER_T,
450
455 void BulkRemoveStaleTeardrops( BOARD_COMMIT& aCommit );
456
461 void FinalizeBulkAdd( std::vector<BOARD_ITEM*>& aNewItems );
462
467 void FinalizeBulkRemove( std::vector<BOARD_ITEM*>& aRemovedItems );
468
474 void FixupEmbeddedData();
475
476 void RunOnNestedEmbeddedFiles( const std::function<void( EMBEDDED_FILES* )>& aFunction ) override;
477
478 void CacheTriangulation( PROGRESS_REPORTER* aReporter = nullptr,
479 const std::vector<ZONE*>& aZones = {} );
480
489 {
490 return m_footprints.empty() ? nullptr : m_footprints.front();
491 }
492
496 void DeleteAllFootprints();
497
501 void DetachAllFootprints();
502
507 BOARD_ITEM* ResolveItem( const KIID& aID, bool aAllowNullptrReturn = false ) const;
508
509 void FillItemMap( std::map<KIID, EDA_ITEM*>& aMap );
510
514 wxString ConvertCrossReferencesToKIIDs( const wxString& aSource ) const;
515 wxString ConvertKIIDsToCrossReferences( const wxString& aSource ) const;
516
521 std::shared_ptr<CONNECTIVITY_DATA> GetConnectivity() const { return m_connectivity; }
522
528 bool BuildConnectivity( PROGRESS_REPORTER* aReporter = nullptr );
529
533 void DeleteMARKERs();
534
535 void DeleteMARKERs( bool aWarningsAndErrors, bool aExclusions );
536
537 PROJECT* GetProject() const { return m_project; }
538
547 void SetProject( PROJECT* aProject, bool aReferenceOnly = false );
548
549 void ClearProject();
550
558 std::vector<PCB_MARKER*> ResolveDRCExclusions( bool aCreateMarkers );
559
563 void RecordDRCExclusions();
564
569
573 void ResetNetHighLight();
574
578 const std::set<int>& GetHighLightNetCodes() const
579 {
580 return m_highLight.m_netCodes;
581 }
582
589 void SetHighLightNet( int aNetCode, bool aMulti = false );
590
594 bool IsHighLightNetON() const { return m_highLight.m_highLightOn; }
595
603 void HighLightON( bool aValue = true );
604
609 {
610 HighLightON( false );
611 }
612
616 int GetCopperLayerCount() const;
617 void SetCopperLayerCount( int aCount );
618
619 int GetUserDefinedLayerCount() const;
620 void SetUserDefinedLayerCount( int aCount );
621
627
628 PCB_LAYER_ID FlipLayer( PCB_LAYER_ID aLayer ) const;
629
630 int LayerDepth( PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer ) const;
631
637 const LSET& GetEnabledLayers() const;
638 LSET GetLayerSet() const override { return GetEnabledLayers(); }
639
645 void SetEnabledLayers( const LSET& aLayerMask );
646 void SetLayerSet( const LSET& aLayerMask ) override { SetEnabledLayers( aLayerMask ); }
647
654 bool IsLayerEnabled( PCB_LAYER_ID aLayer ) const;
655
663 bool IsLayerVisible( PCB_LAYER_ID aLayer ) const;
664
670 const LSET& GetVisibleLayers() const;
671
678 void SetVisibleLayers( const LSET& aLayerMask );
679
680 // these 2 functions are not tidy at this time, since there are PCB_LAYER_IDs that
681 // are not stored in the bitmap.
682
690
697 void SetVisibleElements( const GAL_SET& aMask );
698
704 void SetVisibleAlls();
705
713 bool IsElementVisible( GAL_LAYER_ID aLayer ) const;
714
722 void SetElementVisibility( GAL_LAYER_ID aLayer, bool aNewState );
723
731 bool IsFootprintLayerVisible( PCB_LAYER_ID aLayer ) const;
732
737 void SetDesignSettings( const BOARD_DESIGN_SETTINGS& aSettings );
738
740
741 const PAGE_INFO& GetPageSettings() const { return m_paper; }
742 void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
743
745 void SetPlotOptions( const PCB_PLOT_PARAMS& aOptions ) { m_plotOptions = aOptions; }
746
748 const TITLE_BLOCK& GetTitleBlock() const { return m_titles; }
749 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
750
751 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
752
754 void SetUserUnits( EDA_UNITS aUnits ) { m_userUnits = aUnits; }
755
760 void UpdateUserUnits( BOARD_ITEM* aItem, KIGFX::VIEW* aView );
761
780 OUTLINE_ERROR_HANDLER* aErrorHandler = nullptr,
781 bool aAllowUseArcsInPolygons = false,
782 bool aIncludeNPTHAsOutlines = false );
783
793
804 void ConvertBrdLayerToPolygonalContours( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aOutlines ) const;
805
809 PCB_LAYER_ID GetLayerID( const wxString& aLayerName ) const;
810
817 const wxString GetLayerName( PCB_LAYER_ID aLayer ) const;
818
826 bool SetLayerName( PCB_LAYER_ID aLayer, const wxString& aLayerName );
827
838 static wxString GetStandardLayerName( PCB_LAYER_ID aLayerId )
839 {
840 // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
841 return LayerName( aLayerId );
842 }
843
851 bool SetLayerDescr( PCB_LAYER_ID aIndex, const LAYER& aLayer );
852
856 bool IsFrontLayer( PCB_LAYER_ID aLayer ) const;
857
861 bool IsBackLayer( PCB_LAYER_ID aLayer ) const;
862
869 LAYER_T GetLayerType( PCB_LAYER_ID aLayer ) const;
870
878 bool SetLayerType( PCB_LAYER_ID aLayer, LAYER_T aLayerType );
879
884 unsigned GetNodesCount( int aNet = -1 ) const;
885
894 const std::vector<PAD*> GetPads() const;
895
897 {
898 m_NetInfo.buildListOfNets();
899 }
900
907 NETINFO_ITEM* FindNet( int aNetcode ) const;
908
915 NETINFO_ITEM* FindNet( const wxString& aNetname ) const;
916
926 int MatchDpSuffix( const wxString& aNetName, wxString& aComplementNet );
927
931 NETINFO_ITEM* DpCoupledNet( const NETINFO_ITEM* aNet );
932
934 {
935 return m_NetInfo;
936 }
937
939 {
940 m_NetInfo.RemoveUnusedNets( aCommit );
941 }
942
943#ifndef SWIG
948 {
949 return m_NetInfo.begin();
950 }
951
956 {
957 return m_NetInfo.end();
958 }
959#endif
960
964 unsigned GetNetCount() const
965 {
966 return m_NetInfo.GetNetCount();
967 }
968
973
978
985 BOX2I ComputeBoundingBox( bool aBoardEdgesOnly = false ) const;
986
987 const BOX2I GetBoundingBox() const override
988 {
989 return ComputeBoundingBox( false );
990 }
991
1002 {
1003 return ComputeBoundingBox( true );
1004 }
1005
1006 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
1007
1019 INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
1020 const std::vector<KICAD_T>& scanTypes ) override;
1021
1030 FOOTPRINT* FindFootprintByReference( const wxString& aReference ) const;
1031
1038 FOOTPRINT* FindFootprintByPath( const KIID_PATH& aPath ) const;
1039
1043 std::set<wxString> GetNetClassAssignmentCandidates() const;
1044
1052 void SynchronizeNetsAndNetClasses( bool aResetTrackAndViaSizes );
1053
1057 bool SynchronizeComponentClasses( const std::unordered_set<wxString>& aNewSheetPaths ) const;
1058
1062 void SynchronizeProperties();
1063
1068
1072 double Similarity( const BOARD_ITEM& aOther ) const override
1073 {
1074 return 1.0;
1075 }
1076
1077 bool operator==( const BOARD_ITEM& aOther ) const override;
1078
1079 wxString GetClass() const override
1080 {
1081 return wxT( "BOARD" );
1082 }
1083
1084#if defined(DEBUG)
1085 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
1086#endif
1087
1088
1089 /*************************/
1090 /* Copper Areas handling */
1091 /*************************/
1092
1103
1110 ZONE* GetArea( int index ) const
1111 {
1112 if( (unsigned) index < m_zones.size() )
1113 return m_zones[index];
1114
1115 return nullptr;
1116 }
1117
1121 std::list<ZONE*> GetZoneList( bool aIncludeZonesInFootprints = false ) const;
1122
1126 int GetAreaCount() const
1127 {
1128 return static_cast<int>( m_zones.size() );
1129 }
1130
1131 /* Functions used in test, merge and cut outlines */
1132
1145 ZONE* AddArea( PICKED_ITEMS_LIST* aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer,
1146 VECTOR2I aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch );
1147
1155 bool TestZoneIntersection( ZONE* aZone1, ZONE* aZone2 );
1156
1164 PAD* GetPad( const VECTOR2I& aPosition, const LSET& aLayerMask ) const;
1165 PAD* GetPad( const VECTOR2I& aPosition ) const
1166 {
1167 return GetPad( aPosition, LSET().set() );
1168 }
1169
1177 PAD* GetPad( const PCB_TRACK* aTrace, ENDPOINT_T aEndPoint ) const;
1178
1193 PAD* GetPad( std::vector<PAD*>& aPadList, const VECTOR2I& aPosition, const LSET& aLayerMask ) const;
1194
1206 void GetSortedPadListByXthenYCoord( std::vector<PAD*>& aVector, int aNetCode = -1 ) const;
1207
1215 std::tuple<int, double, double, double, double> GetTrackLength( const PCB_TRACK& aTrack ) const;
1216
1224 TRACKS TracksInNet( int aNetCode );
1225
1238 FOOTPRINT* GetFootprint( const VECTOR2I& aPosition, PCB_LAYER_ID aActiveLayer,
1239 bool aVisibleOnly, bool aIgnoreLocked = false ) const;
1240
1246 int GetMaxClearanceValue() const;
1247
1253 void MapNets( BOARD* aDestBoard );
1254
1255 void SanitizeNetcodes();
1256
1265 void AddListener( BOARD_LISTENER* aListener );
1266
1271 void RemoveListener( BOARD_LISTENER* aListener );
1272
1276 void RemoveAllListeners();
1277
1282 void OnItemChanged( BOARD_ITEM* aItem );
1283
1288 void OnItemsChanged( std::vector<BOARD_ITEM*>& aItems );
1289
1294 void OnItemsCompositeUpdate( std::vector<BOARD_ITEM*>& aAddedItems,
1295 std::vector<BOARD_ITEM*>& aRemovedItems,
1296 std::vector<BOARD_ITEM*>& aChangedItems );
1297
1301 void OnRatsnestChanged();
1302
1309 wxString GroupsSanityCheck( bool repair = false );
1310
1316 wxString GroupsSanityCheckInternal( bool repair );
1317
1318 bool LegacyTeardrops() const { return m_legacyTeardrops; }
1319 void SetLegacyTeardrops( bool aFlag ) { m_legacyTeardrops = aFlag; }
1320
1321 EMBEDDED_FILES* GetEmbeddedFiles() override;
1322 const EMBEDDED_FILES* GetEmbeddedFiles() const;
1323
1325
1329 std::set<KIFONT::OUTLINE_FONT*> GetFonts() const override;
1330
1334 void EmbedFonts() override;
1335
1340
1345
1347
1348 const std::unordered_map<KIID, BOARD_ITEM*>& GetItemByIdCache() const
1349 {
1350 return m_itemByIdCache;
1351 }
1352
1353 // --------- Item order comparators ---------
1354
1356 {
1357 bool operator() ( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
1358 };
1359
1361 {
1362 bool operator()( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
1363 };
1364
1365public:
1366 // ------------ Run-time caches -------------
1367 mutable std::shared_mutex m_CachesMutex;
1368 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsCourtyardCache;
1369 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsFCourtyardCache;
1370 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsBCourtyardCache;
1371 std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, bool> m_IntersectsAreaCache;
1372 std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, bool> m_EnclosedByAreaCache;
1373 std::unordered_map< wxString, LSET > m_LayerExpressionCache;
1374 std::unordered_map<ZONE*, std::unique_ptr<DRC_RTREE>> m_CopperZoneRTreeCache;
1375 std::shared_ptr<DRC_RTREE> m_CopperItemRTreeCache;
1376 mutable std::unordered_map<const ZONE*, BOX2I> m_ZoneBBoxCache;
1377 mutable std::optional<int> m_maxClearanceValue;
1378
1379 // ------------ DRC caches -------------
1380 std::vector<ZONE*> m_DRCZones;
1381 std::vector<ZONE*> m_DRCCopperZones;
1384 ZONE* m_SolderMaskBridges; // A container to build bridges on solder mask layers
1385 std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>> m_ZoneIsolatedIslandsMap;
1386
1387private:
1388 // The default copy constructor & operator= are inadequate,
1389 // either write one or do not use it at all
1390 BOARD( const BOARD& aOther ) = delete;
1391
1392 BOARD& operator=( const BOARD& aOther ) = delete;
1393
1394 template <typename Func, typename... Args>
1395 void InvokeListeners( Func&& aFunc, Args&&... args )
1396 {
1397 for( auto&& l : m_listeners )
1398 ( l->*aFunc )( std::forward<Args>( args )... );
1399 }
1400
1401 // Refresh user layer opposites.
1402 void recalcOpposites();
1403
1404 friend class PCB_EDIT_FRAME;
1405
1406private:
1409
1412 int m_timeStamp; // actually a modification counter
1413
1414 wxString m_fileName;
1415
1416 // These containers only have const accessors and must only be modified by Add()/Remove()
1417 MARKERS m_markers;
1418 DRAWINGS m_drawings;
1419 FOOTPRINTS m_footprints;
1421 GROUPS m_groups;
1423 GENERATORS m_generators;
1425 PCB_POINTS m_points;
1426
1427 // Cache for fast access to items in the containers above by KIID, including children
1428 std::unordered_map<KIID, BOARD_ITEM*> m_itemByIdCache;
1429
1430 std::map<int, LAYER> m_layers; // layer data
1431
1432 HIGH_LIGHT_INFO m_highLight; // current high light data
1433 HIGH_LIGHT_INFO m_highLightPrevious; // a previously stored high light data
1434
1435 int m_fileFormatVersionAtLoad; // the version loaded from the file
1436 wxString m_generator; // the generator tag from the file
1437
1438 std::map<wxString, wxString> m_properties;
1439 std::shared_ptr<CONNECTIVITY_DATA> m_connectivity;
1440
1442 TITLE_BLOCK m_titles; // text in lower right of screen and plots
1444 PROJECT* m_project; // project this board is a part of
1446
1457 std::unique_ptr<BOARD_DESIGN_SETTINGS> m_designSettings;
1458
1463 bool m_legacyTeardrops = false;
1464
1465 NETINFO_LIST m_NetInfo; // net info list (name, design constraints...
1466
1467 std::vector<BOARD_LISTENER*> m_listeners;
1468
1470
1471 // Used for dummy boards, such as a footprint holder, where we don't want to make a copy
1472 // of all the parent's embedded data.
1474
1475 std::unique_ptr<COMPONENT_CLASS_MANAGER> m_componentClassManager;
1476 std::unique_ptr<LENGTH_DELAY_CALCULATION> m_lengthDelayCalc;
1477};
1478
1479
1480#endif // CLASS_BOARD_H_
@ NORMAL
Use all material properties from model file.
Definition 3d_enums.h:72
BOARD_USE
Flags to specify how the board is being used.
Definition board.h:307
@ FPHOLDER
Definition board.h:309
LAYER_T
The allowed types of layers, same as Specctra DSN spec.
Definition board.h:180
@ LT_POWER
Definition board.h:183
@ LT_FRONT
Definition board.h:187
@ LT_MIXED
Definition board.h:184
@ LT_BACK
Definition board.h:188
@ LT_UNDEFINED
Definition board.h:181
@ LT_JUMPER
Definition board.h:185
@ LT_AUX
Definition board.h:186
@ LT_SIGNAL
Definition board.h:182
std::set< BOARD_ITEM *, CompareByUuid > BOARD_ITEM_SET
Set of BOARD_ITEMs ordered by UUID.
Definition board.h:301
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
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.
BOARD_ITEM_CONTAINER(BOARD_ITEM *aParent, KICAD_T aType)
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:79
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype, PCB_LAYER_ID aLayer=F_Cu)
Definition board_item.h:81
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
virtual void OnBoardNetSettingsChanged(BOARD &aBoard)
Definition board.h:286
virtual void OnBoardItemsAdded(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition board.h:283
virtual void OnBoardRatsnestChanged(BOARD &aBoard)
Definition board.h:290
virtual void OnBoardItemsChanged(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition board.h:288
virtual void OnBoardItemChanged(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition board.h:287
virtual void OnBoardItemRemoved(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition board.h:284
virtual void OnBoardItemAdded(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition board.h:282
virtual void OnBoardHighlightNetChanged(BOARD &aBoard)
Definition board.h:289
virtual void OnBoardCompositeUpdate(BOARD &aBoard, std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aChangedItems)
Definition board.h:291
virtual ~BOARD_LISTENER()
Definition board.h:281
virtual void OnBoardItemsRemoved(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition board.h:285
Manage layers needed to make a physical board.
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:317
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:1994
ZONE * m_SolderMaskBridges
Definition board.h:1384
void GetContextualTextVars(wxArrayString *aVars) const
Definition board.cpp:476
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:1028
BOARD_STACKUP GetStackupOrDefault() const
Definition board.cpp:2512
void SetPlotOptions(const PCB_PLOT_PARAMS &aOptions)
Definition board.h:745
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_EnclosedByAreaCache
Definition board.h:1372
std::map< ZONE *, std::map< PCB_LAYER_ID, ISOLATED_ISLANDS > > m_ZoneIsolatedIslandsMap
Definition board.h:1385
PCB_LAYER_ID GetCopperLayerStackMaxId() const
Definition board.cpp:898
GENERATORS m_generators
Definition board.h:1423
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:2657
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:2859
const NETINFO_LIST & GetNetInfo() const
Definition board.h:933
bool m_LegacyDesignSettingsLoaded
True if the legacy board design settings were loaded from a file.
Definition board.h:406
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
Definition board.h:347
PAD * GetPad(const VECTOR2I &aPosition, const LSET &aLayerMask) const
Find a pad aPosition on aLayer.
Definition board.cpp:2362
int GetUserDefinedLayerCount() const
Definition board.cpp:887
void recalcOpposites()
Definition board.cpp:807
void SetPosition(const VECTOR2I &aPos) override
Definition board.cpp:571
std::map< wxString, wxString > m_properties
Definition board.h:1438
EMBEDDED_FILES * GetEmbeddedFiles() override
Definition board.cpp:2710
int m_fileFormatVersionAtLoad
Definition board.h:1435
NETINFO_ITEM * DpCoupledNet(const NETINFO_ITEM *aNet)
Definition board.cpp:2221
std::vector< ZONE * > m_DRCCopperZones
Definition board.h:1381
void SetVisibleLayers(const LSET &aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition board.cpp:955
BOARD_USE GetBoardUse() const
Get what the board use is.
Definition board.h:336
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition board.cpp:1163
const std::set< int > & GetHighLightNetCodes() const
Definition board.h:578
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:2805
bool m_legacyTeardrops
Teardrops in 7.0 were applied as a post-processing step (rather than from pad and via properties).
Definition board.h:1463
TITLE_BLOCK m_titles
Definition board.h:1442
GAL_SET m_LegacyVisibleItems
Definition board.h:403
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition board.h:329
ZONE * GetArea(int index) const
Return the Zone at a given index.
Definition board.h:1110
const BOX2I GetBoardEdgesBoundingBox() const
Return the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition board.h:1001
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition board.h:987
LENGTH_DELAY_CALCULATION * GetLengthCalculation() const
Returns the track length calculator.
Definition board.h:1339
void BuildListOfNets()
Definition board.h:896
void RunOnNestedEmbeddedFiles(const std::function< void(EMBEDDED_FILES *)> &aFunction) override
Provide access to nested embedded files, such as symbols in schematics and footprints in boards.
Definition board.cpp:1135
const GENERATORS & Generators() const
Definition board.h:364
void SetFileName(const wxString &aFileName)
Definition board.h:352
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition board.h:838
const std::vector< BOARD_CONNECTED_ITEM * > AllConnectedItems()
Definition board.cpp:2779
LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition board.h:638
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition board.cpp:989
int m_outlinesChainingEpsilon
the max distance between 2 end point to see them connected when building the board outlines
Definition board.h:1408
std::tuple< int, double, double, 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:2523
std::set< wxString > GetNetClassAssignmentCandidates() const
Return the set of netname candidates for netclass assignment.
Definition board.cpp:2260
BOARD_USE m_boardUse
What is this board being used for.
Definition board.h:1411
PCB_BOARD_OUTLINE * BoardOutline()
Definition board.h:366
PAGE_INFO m_paper
Definition board.h:1441
void RemoveAllListeners()
Remove all listeners.
Definition board.cpp:2853
FOOTPRINTS m_footprints
Definition board.h:1419
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:1457
friend class PCB_EDIT_FRAME
Definition board.h:1404
void SetEmbeddedFilesDelegate(EMBEDDED_FILES *aDelegate)
Definition board.h:1324
const PCB_POINTS & Points() const
Definition board.h:372
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:2834
const PAGE_INFO & GetPageSettings() const
Definition board.h:741
void UpdateUserUnits(BOARD_ITEM *aItem, KIGFX::VIEW *aView)
Update any references within aItem (or its descendants) to the user units.
Definition board.cpp:1534
void SetProperties(const std::map< wxString, wxString > &aProps)
Definition board.h:396
bool IsBackLayer(PCB_LAYER_ID aLayer) const
Definition board.cpp:740
BOARD(const BOARD &aOther)=delete
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
Definition board.cpp:983
void SetHighLightNet(int aNetCode, bool aMulti=false)
Select the netcode to be highlighted.
Definition board.cpp:2895
HIGH_LIGHT_INFO m_highLight
Definition board.h:1432
bool SetLayerDescr(PCB_LAYER_ID aIndex, const LAYER &aLayer)
Return the type of the copper layer given by aLayer.
Definition board.cpp:663
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
Definition board.cpp:2152
EDA_UNITS m_userUnits
Definition board.h:1445
void UpdateBoardOutline()
Definition board.cpp:3246
const ZONES & Zones() const
Definition board.h:362
void BulkRemoveStaleTeardrops(BOARD_COMMIT &aCommit)
Remove all teardrop zones with the STRUCT_DELETED flag set.
Definition board.cpp:1314
void InvokeListeners(Func &&aFunc, Args &&... args)
Definition board.h:1395
void SetDesignSettings(const BOARD_DESIGN_SETTINGS &aSettings)
Definition board.cpp:1046
const LSET & GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
Definition board.cpp:937
void SanitizeNetcodes()
Definition board.cpp:2824
EMBEDDED_FILES * m_embeddedFilesDelegate
Definition board.h:1473
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:2632
bool IsFrontLayer(PCB_LAYER_ID aLayer) const
Definition board.cpp:734
const GROUPS & Groups() const
The groups must maintain the following invariants.
Definition board.h:391
~BOARD()
Definition board.cpp:153
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:188
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:949
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Return the type of the copper layer given by aLayer.
Definition board.cpp:746
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
Definition board.cpp:331
DRAWINGS m_drawings
Definition board.h:1418
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:2871
int SetAreasNetCodesFromNetNames()
Set the .m_NetCode member of all copper areas, according to the area Net Name The SetNetCodesFromNetN...
Definition board.cpp:2328
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition board.cpp:2287
void SynchronizeTimeDomainProperties()
Ensure that all time domain properties providers are in sync with current settings.
Definition board.cpp:2281
EDA_UNITS GetUserUnits()
Definition board.h:753
void ResetNetHighLight()
Reset all high light data to the init state.
Definition board.cpp:2886
PCB_PLOT_PARAMS m_plotOptions
Definition board.h:1443
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition board.cpp:709
std::list< ZONE * > GetZoneList(bool aIncludeZonesInFootprints=false) const
Definition board.cpp:2612
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:3061
bool ResolveTextVar(wxString *token, int aDepth) const
Definition board.cpp:502
const MARKERS & Markers() const
Definition board.h:370
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition board.h:488
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayer) const
Definition board.cpp:868
const std::vector< PAD * > GetPads() const
Return a reference to a list of all the pads.
Definition board.cpp:2765
void Move(const VECTOR2I &aMoveVector) override
Move this object.
Definition board.cpp:577
TITLE_BLOCK & GetTitleBlock()
Definition board.h:747
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
Definition board.cpp:1890
void FixupEmbeddedData()
After loading a file from disk, the footprints do not yet contain the full data for their embedded fi...
Definition board.cpp:1142
int GetMaxClearanceValue() const
Returns the maximum clearance value for any object on the board.
Definition board.cpp:1052
ZONES m_zones
Definition board.h:1422
PAD * GetPad(const VECTOR2I &aPosition) const
Definition board.h:1165
PCB_LAYER_ID GetLayerID(const wxString &aLayerName) const
Return the ID of a layer.
Definition board.cpp:671
HIGH_LIGHT_INFO m_highLightPrevious
Definition board.h:1433
const VECTOR2I GetFocusPosition() const override
Similar to GetPosition() but allows items to return their visual center rather than their anchor.
Definition board.h:417
void HighLightOFF()
Disable net highlight.
Definition board.h:608
NETINFO_LIST m_NetInfo
Definition board.h:1465
LSET m_LegacyVisibleLayers
Visibility settings stored in board prior to 6.0, only used for loading legacy files.
Definition board.h:402
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition board.cpp:972
void SetOutlinesChainingEpsilon(int aValue)
Definition board.h:792
NETINFO_LIST::iterator EndNets() const
Definition board.h:955
int GetCopperLayerCount() const
Definition board.cpp:875
int m_timeStamp
Definition board.h:1412
std::vector< BOARD_LISTENER * > m_listeners
Definition board.h:1467
const std::map< wxString, wxString > & GetProperties() const
Definition board.h:395
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsCourtyardCache
Definition board.h:1368
void IncrementTimeStamp()
Definition board.cpp:256
int MatchDpSuffix(const wxString &aNetName, wxString &aComplementNet)
Fetch the coupled netname for a given net.
Definition board.cpp:2171
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsFCourtyardCache
Definition board.h:1369
PCB_POINTS m_points
Definition board.h:1425
std::unique_ptr< LENGTH_DELAY_CALCULATION > m_lengthDelayCalc
Definition board.h:1476
void RemoveUnusedNets(BOARD_COMMIT *aCommit)
Definition board.h:938
const FOOTPRINTS & Footprints() const
Definition board.h:358
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition board.h:1439
std::set< KIFONT::OUTLINE_FONT * > GetFonts() const override
Get the list of all outline fonts used in the board.
Definition board.cpp:2728
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:1443
const BOARD_ITEM_SET GetItemSet()
Definition board.cpp:3162
const TRACKS & Tracks() const
Definition board.h:356
int m_DRCMaxPhysicalClearance
Definition board.h:1383
const PCB_BOARD_OUTLINE * BoardOutline() const
Definition board.h:367
FOOTPRINT * FindFootprintByPath(const KIID_PATH &aPath) const
Search for a FOOTPRINT within this board with the given path.
Definition board.cpp:2248
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:1308
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition board.h:742
std::unordered_map< wxString, LSET > m_LayerExpressionCache
Definition board.h:1373
bool m_embedFonts
Definition board.h:1469
wxString GroupsSanityCheckInternal(bool repair)
Definition board.cpp:2931
void OnRatsnestChanged()
Notify the board and its listeners that the ratsnest has been recomputed.
Definition board.cpp:2880
wxString ConvertCrossReferencesToKIIDs(const wxString &aSource) const
Convert cross-references back and forth between ${refDes:field} and ${kiid:field}.
Definition board.cpp:1771
wxString GetClass() const override
Return the class name.
Definition board.h:1079
std::unique_ptr< COMPONENT_CLASS_MANAGER > m_componentClassManager
Definition board.h:1475
NETINFO_LIST::iterator BeginNets() const
Definition board.h:947
bool m_LegacyNetclassesLoaded
True if netclasses were loaded from the file.
Definition board.h:410
void SetCopperLayerCount(int aCount)
Definition board.cpp:881
std::unordered_map< const ZONE *, BOX2I > m_ZoneBBoxCache
Definition board.h:1376
wxString m_generator
Definition board.h:1436
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsBCourtyardCache
Definition board.h:1370
TRACKS TracksInNet(int aNetCode)
Collect all the TRACKs and VIAs that are members of a net given by aNetCode.
Definition board.cpp:641
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
Definition board.cpp:198
PROJECT * m_project
Definition board.h:1444
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:2548
const wxString & GetFileName() const
Definition board.h:354
bool operator==(const BOARD_ITEM &aOther) const override
Definition board.cpp:3178
std::vector< PCB_MARKER * > ResolveDRCExclusions(bool aCreateMarkers)
Rebuild DRC markers from the serialized data in BOARD_DESIGN_SETTINGS.
Definition board.cpp:388
int GetPadWithCastellatedAttrCount()
Definition board.cpp:3275
FOOTPRINT * FindFootprintByReference(const wxString &aReference) const
Search for a FOOTPRINT within this board with the given reference designator.
Definition board.cpp:2236
unsigned GetNodesCount(int aNet=-1) const
Definition board.cpp:1873
bool IsHighLightNetON() const
Definition board.h:594
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
Definition board.cpp:1729
int GetFileFormatVersionAtLoad() const
Definition board.h:426
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
Definition board.cpp:995
std::shared_ptr< DRC_RTREE > m_CopperItemRTreeCache
Definition board.h:1375
bool SetLayerType(PCB_LAYER_ID aLayer, LAYER_T aLayerType)
Change the type of the layer given by aLayer.
Definition board.cpp:765
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition board.h:744
BOARD & operator=(const BOARD &aOther)=delete
wxString m_fileName
Definition board.h:1414
const wxString & GetGenerator() const
Adds an item to the container.
Definition board.h:429
int GetAreaCount() const
Definition board.h:1126
void DetachAllFootprints()
Remove all footprints without deleting.
Definition board.cpp:1603
void SetLegacyTeardrops(bool aFlag)
Definition board.h:1319
std::map< int, LAYER > m_layers
Definition board.h:1430
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction, RECURSE_MODE aMode) const override
Invoke a function on all children.
Definition board.cpp:599
int GetOutlinesChainingEpsilon()
Definition board.h:791
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:2497
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:929
int m_DRCMaxClearance
Definition board.h:1382
void ClearProject()
Definition board.cpp:236
void SetLayerSet(const LSET &aLayerMask) override
Definition board.h:646
std::unordered_map< ZONE *, std::unique_ptr< DRC_RTREE > > m_CopperZoneRTreeCache
Definition board.h:1374
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:1302
int LayerDepth(PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) const
Definition board.cpp:911
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition board.cpp:1593
PROJECT * GetProject() const
Definition board.h:537
bool IsEmpty() const
Definition board.cpp:559
int GetPadWithPressFitAttrCount()
Definition board.cpp:3257
bool LegacyTeardrops() const
Definition board.h:1318
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:1956
const TITLE_BLOCK & GetTitleBlock() const
Definition board.h:748
wxString GroupsSanityCheck(bool repair=false)
Consistency check of internal m_groups structure.
Definition board.cpp:2918
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1040
std::vector< ZONE * > m_DRCZones
Definition board.h:1380
const LSET & GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition board.cpp:923
void SetGenerator(const wxString &aGenerator)
Definition board.h:428
BOARD()
Definition board.cpp:80
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
Definition board.cpp:300
wxString ConvertKIIDsToCrossReferences(const wxString &aSource) const
Definition board.cpp:1825
void SynchronizeProperties()
Copy the current project's text variables into the boards property cache.
Definition board.cpp:2274
std::unordered_map< KIID, BOARD_ITEM * > m_itemByIdCache
Definition board.h:1428
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
Definition board.cpp:2841
COMPONENT_CLASS_MANAGER & GetComponentClassManager()
Gets the component class manager.
Definition board.h:1344
std::shared_mutex m_CachesMutex
Definition board.h:1367
unsigned GetNetCount() const
Definition board.h:964
const std::unordered_map< KIID, BOARD_ITEM * > & GetItemByIdCache() const
Definition board.h:1348
bool SynchronizeComponentClasses(const std::unordered_set< wxString > &aNewSheetPaths) const
Copy component class / component class generator information from the project settings.
Definition board.cpp:2317
void DeleteMARKERs()
Delete all MARKERS from the board.
Definition board.cpp:1560
void Remove(BOARD_ITEM *aBoardItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
Removes an item from the container.
Definition board.cpp:1331
GROUPS m_groups
Definition board.h:1421
PROJECT::ELEM ProjectElementType() override
Definition board.h:1346
MARKERS m_markers
Definition board.h:1417
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_IntersectsAreaCache
Definition board.h:1371
std::optional< int > m_maxClearanceValue
Definition board.h:1377
void HighLightON(bool aValue=true)
Enable or disable net highlighting.
Definition board.cpp:2908
void SetEnabledLayers(const LSET &aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition board.cpp:943
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition board.h:749
bool TestZoneIntersection(ZONE *aZone1, ZONE *aZone2)
Test for intersection of 2 copper areas.
TRACKS m_tracks
Definition board.h:1420
BOARD_ITEM * ResolveItem(const KIID &aID, bool aAllowNullptrReturn=false) const
Definition board.cpp:1613
bool m_LegacyCopperEdgeClearanceLoaded
Definition board.h:407
int GetTimeStamp() const
Definition board.h:340
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:2865
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition board.h:521
VECTOR2I GetPosition() const override
Definition board.cpp:565
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition board.cpp:1084
static bool ClassOf(const EDA_ITEM *aItem)
Definition board.h:319
void SetUserUnits(EDA_UNITS aUnits)
Definition board.h:754
void SetVisibleElements(const GAL_SET &aMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition board.cpp:962
void EmbedFonts() override
Finds all fonts used in the board and embeds them in the file if permissions allow.
Definition board.cpp:2755
double Similarity(const BOARD_ITEM &aOther) const override
Return the Similarity.
Definition board.h:1072
PCB_BOARD_OUTLINE * m_boardOutline
Definition board.h:1424
void SetUserDefinedLayerCount(int aCount)
Definition board.cpp:893
const DRAWINGS & Drawings() const
Definition board.h:360
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition board.cpp:1528
void SetFileFormatVersionAtLoad(int aVersion)
Definition board.h:425
constexpr const Vec GetCenter() const
Definition box2.h:230
A class to manage Component Classes in a board context.
Store all of the related footprint information found in a netlist.
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.
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:39
EMBEDDED_FILES()=default
Helper for storing and iterating over GAL_LAYER_IDs.
Definition layer_ids.h:402
void Clear()
Definition board.h:256
friend class BOARD
Definition board.h:268
std::set< int > m_netCodes
Definition board.h:253
bool m_highLightOn
Definition board.h:254
Class OUTLINE_FONT implements outline font drawing.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition view.h:66
Definition kiid.h:49
Class which calculates lengths (and associated routing statistics) in a BOARD context.
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:54
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString,...
Definition netinfo.h:391
Container for NETINFO_ITEM elements, which are the nets.
Definition netinfo.h:330
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
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:79
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:53
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.
A PROJECT can hold stuff it knows nothing about, in the form of _ELEM derivatives.
Definition project.h:97
Container for project specific data.
Definition project.h:65
ELEM
The set of #_ELEMs that a PROJECT can hold.
Definition project.h:71
A pure virtual class used to derive REPORTER objects from.
Definition reporter.h:73
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:74
The common library.
const std::function< void(const wxString &msg, BOARD_ITEM *itemA, BOARD_ITEM *itemB, const VECTOR2I &pt)> OUTLINE_ERROR_HANDLER
#define LAYER(n, l)
RECURSE_MODE
Definition eda_item.h:50
INSPECT_RESULT
Definition eda_item.h:44
const INSPECTOR_FUNC & INSPECTOR
std::function passed to nested users by ref, avoids copying std::function.
Definition eda_item.h:91
EDA_UNITS
Definition eda_units.h:48
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:228
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
STL namespace.
std::vector< ZONE * > ZONES
ENDPOINT_T
Definition pcb_track.h:59
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition board.cpp:3021
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition board.cpp:3000
A struct recording the isolated and single-pad islands within a zone.
Definition zone.h:61
LAYERS_CHECKED(PCB_LAYER_ID aLayer)
Definition board.h:129
bool has_error
Definition board.h:135
LSET layers
Definition board.h:134
int m_opposite
Similar layer on opposite side of the board, if any.
Definition board.h:228
static LAYER_T ParseType(const char *aType)
Convert a string to a LAYER_T.
Definition board.cpp:794
void clear()
Definition board.h:202
LAYER_T m_type
The type of the layer.
Definition board.h:225
static const char * ShowType(LAYER_T aType)
Convert a LAYER_T enum to a string representation of the layer type.
Definition board.cpp:778
LAYER()
Definition board.h:197
wxString m_name
The canonical name of the layer.
Definition board.h:223
wxString m_userName
The user defined name of the layer.
Definition board.h:224
bool m_visible
Definition board.h:226
int m_number
The layer ID.
Definition board.h:227
BOARD_ITEM * A
Definition board.h:101
bool operator==(const PTR_LAYER_CACHE_KEY &other) const
Definition board.h:104
PCB_LAYER_ID Layer
Definition board.h:102
BOARD_ITEM * A
Definition board.h:90
BOARD_ITEM * B
Definition board.h:91
bool operator==(const PTR_PTR_CACHE_KEY &other) const
Definition board.h:93
bool operator==(const PTR_PTR_LAYER_CACHE_KEY &other) const
Definition board.h:116
BOARD_ITEM * B
Definition board.h:113
BOARD_ITEM * A
Definition board.h:112
PCB_LAYER_ID Layer
Definition board.h:114
std::size_t operator()(const PTR_LAYER_CACHE_KEY &k) const
Definition board.h:155
std::size_t operator()(const PTR_PTR_CACHE_KEY &k) const
Definition board.h:144
std::size_t operator()(const PTR_PTR_LAYER_CACHE_KEY &k) const
Definition board.h:166
@ 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
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.