KiCad PCB EDA Suite
Loading...
Searching...
No Matches
board.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2007 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef CLASS_BOARD_H_
26#define CLASS_BOARD_H_
27
30#include <embedded_files.h>
31#include <common.h> // Needed for stl hash extensions
32#include <convert_shape_list_to_polygon.h> // for OUTLINE_ERROR_HANDLER
33#include <hash.h>
34#include <layer_ids.h>
35#include <lset.h>
36#include <netinfo.h>
37#include <pcb_item_containers.h>
38#include <pcb_plot_params.h>
39#include <title_block.h>
40#include <tools/pcb_selection.h>
41#include <shared_mutex>
42#include <list>
43
46class BOARD_COMMIT;
47class DRC_RTREE;
48class PCB_BASE_FRAME;
49class PCB_EDIT_FRAME;
51class BOARD;
52class FOOTPRINT;
53class ZONE;
54class PCB_TRACK;
55class PAD;
56class PCB_GROUP;
57class PCB_GENERATOR;
58class PCB_MARKER;
59class MSG_PANEL_ITEM;
60class NETLIST;
61class REPORTER;
62class SHAPE_POLY_SET;
64class COMPONENT;
65class PROJECT;
67struct ISOLATED_ISLANDS;
68
69// The default value for m_outlinesChainingEpsilon to convert a board outlines to polygons
70// It is the max dist between 2 end points to see them connected
71#define DEFAULT_CHAINING_EPSILON_MM 0.01
72
73// Forward declare endpoint from class_track.h
74enum ENDPOINT_T : int;
75
76
78{
81
82 bool operator==(const PTR_PTR_CACHE_KEY& other) const
83 {
84 return A == other.A && B == other.B;
85 }
86};
87
89{
92
93 bool operator==(const PTR_LAYER_CACHE_KEY& other) const
94 {
95 return A == other.A && Layer == other.Layer;
96 }
97};
98
100{
104
105 bool operator==(const PTR_PTR_LAYER_CACHE_KEY& other) const
106 {
107 return A == other.A && B == other.B && Layer == other.Layer;
108 }
109};
110
111namespace std
112{
113 template <>
114 struct hash<PTR_PTR_CACHE_KEY>
115 {
116 std::size_t operator()( const PTR_PTR_CACHE_KEY& k ) const
117 {
118 std::size_t seed = 0xa82de1c0;
119 hash_combine( seed, k.A, k.B );
120 return seed;
121 }
122 };
123
124 template <>
126 {
127 std::size_t operator()( const PTR_LAYER_CACHE_KEY& k ) const
128 {
129 std::size_t seed = 0xa82de1c0;
130 hash_combine( seed, k.A, k.Layer );
131 return seed;
132 }
133 };
134
135 template <>
137 {
138 std::size_t operator()( const PTR_PTR_LAYER_CACHE_KEY& k ) const
139 {
140 std::size_t seed = 0xa82de1c0;
141 hash_combine( seed, k.A, k.B, k.Layer );
142 return seed;
143 }
144 };
145}
146
147
152{
160 LT_BACK
162
163
167struct LAYER
168{
170 {
171 clear();
172 }
173
174 void clear()
175 {
177 m_visible = true;
178 m_number = 0;
179 m_name.clear();
180 m_userName.clear();
182 }
183
184 /*
185 LAYER( const wxString& aName = wxEmptyString,
186 LAYER_T aType = LT_SIGNAL, bool aVisible = true, int aNumber = -1 ) :
187 m_name( aName ),
188 m_type( aType ),
189 m_visible( aVisible ),
190 m_number( aNumber )
191 {
192 }
193 */
194
195 wxString m_name;
196 wxString m_userName;
201
208 static const char* ShowType( LAYER_T aType );
209
217 static LAYER_T ParseType( const char* aType );
218};
219
220
221// Helper class to handle high light nets
223{
224protected:
225 std::set<int> m_netCodes; // net(s) selected for highlight (-1 when no net selected )
226 bool m_highLightOn; // highlight active
227
228 void Clear()
229 {
230 m_netCodes.clear();
231 m_highLightOn = false;
232 }
233
235 {
236 Clear();
237 }
238
239private:
240 friend class BOARD;
241};
242
248class BOARD;
249
251{
252public:
253 virtual ~BOARD_LISTENER() { }
254 virtual void OnBoardItemAdded( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
255 virtual void OnBoardItemsAdded( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
256 virtual void OnBoardItemRemoved( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
257 virtual void OnBoardItemsRemoved( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
258 virtual void OnBoardNetSettingsChanged( BOARD& aBoard ) { }
259 virtual void OnBoardItemChanged( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
260 virtual void OnBoardItemsChanged( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItem ) { }
261 virtual void OnBoardHighlightNetChanged( BOARD& aBoard ) { }
262 virtual void OnBoardRatsnestChanged( BOARD& aBoard ) { }
263 virtual void OnBoardCompositeUpdate( BOARD& aBoard, std::vector<BOARD_ITEM*>& aAddedItems,
264 std::vector<BOARD_ITEM*>& aRemovedItems,
265 std::vector<BOARD_ITEM*>& aDeletedItems )
266 {
267 }
268};
269
273typedef std::set<BOARD_ITEM*, CompareByUuid> BOARD_ITEM_SET;
274
278enum class BOARD_USE
279{
280 NORMAL, // A normal board
281 FPHOLDER // A board that holds a single footprint
282};
283
284
289{
290public:
291 static inline bool ClassOf( const EDA_ITEM* aItem )
292 {
293 return aItem && PCB_T == aItem->Type();
294 }
295
301 void SetBoardUse( BOARD_USE aUse ) { m_boardUse = aUse; }
302
308 BOARD_USE GetBoardUse() const { return m_boardUse; }
309
310 void IncrementTimeStamp();
311
312 int GetTimeStamp() const { return m_timeStamp; }
313
319 bool IsFootprintHolder() const
320 {
321 return m_boardUse == BOARD_USE::FPHOLDER;
322 }
323
324 void SetFileName( const wxString& aFileName ) { m_fileName = aFileName; }
325
326 const wxString &GetFileName() const { return m_fileName; }
327
328 const TRACKS& Tracks() const { return m_tracks; }
329
330 const FOOTPRINTS& Footprints() const { return m_footprints; }
331
332 const DRAWINGS& Drawings() const { return m_drawings; }
333
334 const ZONES& Zones() const { return m_zones; }
335
336 const GENERATORS& Generators() const { return m_generators; }
337
338 const MARKERS& Markers() const { return m_markers; }
339
340 // SWIG requires non-const accessors for some reason to make the custom iterators in board.i
341 // work. It would be good to remove this if we can figure out how to fix that.
342#ifdef SWIG
343 DRAWINGS& Drawings() { return m_drawings; }
344 TRACKS& Tracks() { return m_tracks; }
345#endif
346
348
357 const GROUPS& Groups() const { return m_groups; }
358
359 const std::vector<BOARD_CONNECTED_ITEM*> AllConnectedItems();
360
361 const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
362 void SetProperties( const std::map<wxString, wxString>& aProps ) { m_properties = aProps; }
363
364 void GetContextualTextVars( wxArrayString* aVars ) const;
365 bool ResolveTextVar( wxString* token, int aDepth ) const;
366
370
374
377
378 BOARD();
379 ~BOARD();
380
381 VECTOR2I GetPosition() const override;
382 void SetPosition( const VECTOR2I& aPos ) override;
383 const VECTOR2I GetFocusPosition() const override { return GetBoundingBox().GetCenter(); }
384
385 bool IsEmpty() const
386 {
387 return m_drawings.empty() && m_footprints.empty() && m_tracks.empty() && m_zones.empty();
388 }
389
390 void Move( const VECTOR2I& aMoveVector ) override;
391
392 void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
394
395 void SetGenerator( const wxString& aGenerator ) { m_generator = aGenerator; }
396 const wxString& GetGenerator() const { return m_generator; }
397
399 void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT,
400 bool aSkipConnectivity = false ) override;
401
403 void Remove( BOARD_ITEM* aBoardItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) override;
404
413 void RemoveAll( std::initializer_list<KICAD_T> aTypes = { PCB_NETINFO_T, PCB_MARKER_T,
417
422 void FinalizeBulkAdd( std::vector<BOARD_ITEM*>& aNewItems );
423
428 void FinalizeBulkRemove( std::vector<BOARD_ITEM*>& aRemovedItems );
429
435 void FixupEmbeddedData();
436
437 void CacheTriangulation( PROGRESS_REPORTER* aReporter = nullptr,
438 const std::vector<ZONE*>& aZones = {} );
439
448 {
449 return m_footprints.empty() ? nullptr : m_footprints.front();
450 }
451
455 void DeleteAllFootprints();
456
460 BOARD_ITEM* GetItem( const KIID& aID ) const;
461
462 void FillItemMap( std::map<KIID, EDA_ITEM*>& aMap );
463
467 wxString ConvertCrossReferencesToKIIDs( const wxString& aSource ) const;
468 wxString ConvertKIIDsToCrossReferences( const wxString& aSource ) const;
469
474 std::shared_ptr<CONNECTIVITY_DATA> GetConnectivity() const { return m_connectivity; }
475
481 bool BuildConnectivity( PROGRESS_REPORTER* aReporter = nullptr );
482
486 void DeleteMARKERs();
487
488 void DeleteMARKERs( bool aWarningsAndErrors, bool aExclusions );
489
490 PROJECT* GetProject() const { return m_project; }
491
500 void SetProject( PROJECT* aProject, bool aReferenceOnly = false );
501
502 void ClearProject();
503
511 std::vector<PCB_MARKER*> ResolveDRCExclusions( bool aCreateMarkers );
512
516 void RecordDRCExclusions();
517
522
526 void ResetNetHighLight();
527
531 const std::set<int>& GetHighLightNetCodes() const
532 {
533 return m_highLight.m_netCodes;
534 }
535
542 void SetHighLightNet( int aNetCode, bool aMulti = false );
543
548
556 void HighLightON( bool aValue = true );
557
562 {
563 HighLightON( false );
564 }
565
569 int GetCopperLayerCount() const;
570 void SetCopperLayerCount( int aCount );
571
572 PCB_LAYER_ID FlipLayer( PCB_LAYER_ID aLayer ) const;
573
574 int LayerDepth( PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer ) const;
575
581 LSET GetEnabledLayers() const;
582
588 void SetEnabledLayers( LSET aLayerMask );
589
596 bool IsLayerEnabled( PCB_LAYER_ID aLayer ) const;
597
605 bool IsLayerVisible( PCB_LAYER_ID aLayer ) const;
606
612 LSET GetVisibleLayers() const;
613
620 void SetVisibleLayers( LSET aLayerMask );
621
622 // these 2 functions are not tidy at this time, since there are PCB_LAYER_IDs that
623 // are not stored in the bitmap.
624
632
639 void SetVisibleElements( const GAL_SET& aMask );
640
646 void SetVisibleAlls();
647
655 bool IsElementVisible( GAL_LAYER_ID aLayer ) const;
656
664 void SetElementVisibility( GAL_LAYER_ID aLayer, bool aNewState );
665
673 bool IsFootprintLayerVisible( PCB_LAYER_ID aLayer ) const;
674
679
681
682 const PAGE_INFO& GetPageSettings() const { return m_paper; }
683 void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
684
686 void SetPlotOptions( const PCB_PLOT_PARAMS& aOptions ) { m_plotOptions = aOptions; }
687
689 const TITLE_BLOCK& GetTitleBlock() const { return m_titles; }
690 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
691
692 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
693
695 void SetUserUnits( EDA_UNITS aUnits ) { m_userUnits = aUnits; }
696
701 void UpdateUserUnits( BOARD_ITEM* aItem, KIGFX::VIEW* aView );
702
721 OUTLINE_ERROR_HANDLER* aErrorHandler = nullptr,
722 bool aAllowUseArcsInPolygons = false,
723 bool aIncludeNPTHAsOutlines = false );
724
734
745 void ConvertBrdLayerToPolygonalContours( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aOutlines ) const;
746
750 PCB_LAYER_ID GetLayerID( const wxString& aLayerName ) const;
751
758 const wxString GetLayerName( PCB_LAYER_ID aLayer ) const;
759
767 bool SetLayerName( PCB_LAYER_ID aLayer, const wxString& aLayerName );
768
779 static wxString GetStandardLayerName( PCB_LAYER_ID aLayerId )
780 {
781 // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
782 return LayerName( aLayerId );
783 }
784
792 bool SetLayerDescr( PCB_LAYER_ID aIndex, const LAYER& aLayer );
793
800 LAYER_T GetLayerType( PCB_LAYER_ID aLayer ) const;
801
809 bool SetLayerType( PCB_LAYER_ID aLayer, LAYER_T aLayerType );
810
815 unsigned GetNodesCount( int aNet = -1 ) const;
816
825 const std::vector<PAD*> GetPads() const;
826
828 {
830 }
831
838 NETINFO_ITEM* FindNet( int aNetcode ) const;
839
846 NETINFO_ITEM* FindNet( const wxString& aNetname ) const;
847
857 int MatchDpSuffix( const wxString& aNetName, wxString& aComplementNet );
858
862 NETINFO_ITEM* DpCoupledNet( const NETINFO_ITEM* aNet );
863
865 {
866 return m_NetInfo;
867 }
868
870 {
871 m_NetInfo.RemoveUnusedNets( aCommit );
872 }
873
874#ifndef SWIG
879 {
880 return m_NetInfo.begin();
881 }
882
887 {
888 return m_NetInfo.end();
889 }
890#endif
891
895 unsigned GetNetCount() const
896 {
897 return m_NetInfo.GetNetCount();
898 }
899
906 BOX2I ComputeBoundingBox( bool aBoardEdgesOnly = false, bool aIncludeHiddenText = false ) const;
907
908 const BOX2I GetBoundingBox() const override
909 {
911 }
912
923 {
924 return ComputeBoundingBox( true, false );
925 }
926
927 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
928
940 INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
941 const std::vector<KICAD_T>& scanTypes ) override;
942
951 FOOTPRINT* FindFootprintByReference( const wxString& aReference ) const;
952
959 FOOTPRINT* FindFootprintByPath( const KIID_PATH& aPath ) const;
960
964 std::set<wxString> GetNetClassAssignmentCandidates() const;
965
973 void SynchronizeNetsAndNetClasses( bool aResetTrackAndViaSizes );
974
979
983 double Similarity( const BOARD_ITEM& aOther ) const override
984 {
985 return 1.0;
986 }
987
988 bool operator==( const BOARD_ITEM& aOther ) const override;
989
990 wxString GetClass() const override
991 {
992 return wxT( "BOARD" );
993 }
994
995#if defined(DEBUG)
996 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
997#endif
998
999
1000 /*************************/
1001 /* Copper Areas handling */
1002 /*************************/
1003
1014
1021 ZONE* GetArea( int index ) const
1022 {
1023 if( (unsigned) index < m_zones.size() )
1024 return m_zones[index];
1025
1026 return nullptr;
1027 }
1028
1032 std::list<ZONE*> GetZoneList( bool aIncludeZonesInFootprints = false ) const;
1033
1037 int GetAreaCount() const
1038 {
1039 return static_cast<int>( m_zones.size() );
1040 }
1041
1042 /* Functions used in test, merge and cut outlines */
1043
1056 ZONE* AddArea( PICKED_ITEMS_LIST* aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer,
1057 VECTOR2I aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch );
1058
1066 bool TestZoneIntersection( ZONE* aZone1, ZONE* aZone2 );
1067
1075 PAD* GetPad( const VECTOR2I& aPosition, LSET aLayerMask ) const;
1076 PAD* GetPad( const VECTOR2I& aPosition ) const
1077 {
1078 return GetPad( aPosition, LSET().set() );
1079 }
1080
1088 PAD* GetPad( const PCB_TRACK* aTrace, ENDPOINT_T aEndPoint ) const;
1089
1099 PAD* GetPadFast( const VECTOR2I& aPosition, LSET aLayerMask ) const;
1100
1115 PAD* GetPad( std::vector<PAD*>& aPadList, const VECTOR2I& aPosition, LSET aLayerMask ) const;
1116
1128 void GetSortedPadListByXthenYCoord( std::vector<PAD*>& aVector, int aNetCode = -1 ) const;
1129
1137 std::tuple<int, double, double> GetTrackLength( const PCB_TRACK& aTrack ) const;
1138
1146 TRACKS TracksInNet( int aNetCode );
1147
1160 FOOTPRINT* GetFootprint( const VECTOR2I& aPosition, PCB_LAYER_ID aActiveLayer,
1161 bool aVisibleOnly, bool aIgnoreLocked = false ) const;
1162
1168 int GetMaxClearanceValue() const;
1169
1175 void MapNets( BOARD* aDestBoard );
1176
1177 void SanitizeNetcodes();
1178
1187 void AddListener( BOARD_LISTENER* aListener );
1188
1193 void RemoveListener( BOARD_LISTENER* aListener );
1194
1198 void RemoveAllListeners();
1199
1204 void OnItemChanged( BOARD_ITEM* aItem );
1205
1210 void OnItemsChanged( std::vector<BOARD_ITEM*>& aItems );
1211
1216 void OnItemsCompositeUpdate( std::vector<BOARD_ITEM*>& aAddedItems,
1217 std::vector<BOARD_ITEM*>& aRemovedItems,
1218 std::vector<BOARD_ITEM*>& aChangedItems );
1219
1223 void OnRatsnestChanged();
1224
1231 wxString GroupsSanityCheck( bool repair = false );
1232
1238 wxString GroupsSanityCheckInternal( bool repair );
1239
1241 {
1242 bool create : 1;
1243 bool ungroup : 1;
1244 bool removeItems : 1;
1245 };
1246
1252 GroupLegalOpsField GroupLegalOps( const PCB_SELECTION& selection ) const;
1253
1254 bool LegacyTeardrops() const { return m_legacyTeardrops; }
1255 void SetLegacyTeardrops( bool aFlag ) { m_legacyTeardrops = aFlag; }
1256
1257 EMBEDDED_FILES* GetEmbeddedFiles() override;
1258 const EMBEDDED_FILES* GetEmbeddedFiles() const;
1259
1263 void EmbedFonts() override;
1264
1265 // --------- Item order comparators ---------
1266
1268 {
1269 bool operator() ( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
1270 };
1271
1273 {
1274 bool operator()( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
1275 };
1276
1277public:
1278 // ------------ Run-time caches -------------
1279 mutable std::shared_mutex m_CachesMutex;
1280 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsCourtyardCache;
1281 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsFCourtyardCache;
1282 std::unordered_map<PTR_PTR_CACHE_KEY, bool> m_IntersectsBCourtyardCache;
1283 std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, bool> m_IntersectsAreaCache;
1284 std::unordered_map<PTR_PTR_LAYER_CACHE_KEY, bool> m_EnclosedByAreaCache;
1285 std::unordered_map< wxString, LSET > m_LayerExpressionCache;
1286 std::unordered_map<ZONE*, std::unique_ptr<DRC_RTREE>> m_CopperZoneRTreeCache;
1287 std::shared_ptr<DRC_RTREE> m_CopperItemRTreeCache;
1288 mutable std::unordered_map<const ZONE*, BOX2I> m_ZoneBBoxCache;
1289 mutable std::optional<int> m_maxClearanceValue;
1290
1291 // ------------ DRC caches -------------
1292 std::vector<ZONE*> m_DRCZones;
1293 std::vector<ZONE*> m_DRCCopperZones;
1296 ZONE* m_SolderMaskBridges; // A container to build bridges on solder mask layers
1297 std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>> m_ZoneIsolatedIslandsMap;
1298
1299private:
1300 // The default copy constructor & operator= are inadequate,
1301 // either write one or do not use it at all
1302 BOARD( const BOARD& aOther ) = delete;
1303
1304 BOARD& operator=( const BOARD& aOther ) = delete;
1305
1306 template <typename Func, typename... Args>
1307 void InvokeListeners( Func&& aFunc, Args&&... args )
1308 {
1309 for( auto&& l : m_listeners )
1310 ( l->*aFunc )( std::forward<Args>( args )... );
1311 }
1312
1313 // Refresh user layer opposites.
1314 void recalcOpposites();
1315
1316 friend class PCB_EDIT_FRAME;
1317
1318private:
1321
1324 int m_timeStamp; // actually a modification counter
1325
1326 wxString m_fileName;
1327
1328 // These containers only have const accessors and must only be modified by Add()/Remove()
1329 MARKERS m_markers;
1330 DRAWINGS m_drawings;
1331 FOOTPRINTS m_footprints;
1332 TRACKS m_tracks;
1333 GROUPS m_groups;
1335 GENERATORS m_generators;
1336
1337 // Cache for fast access to items in the containers above by KIID, including children
1338 std::unordered_map<KIID, BOARD_ITEM*> m_itemByIdCache;
1339
1341
1342 HIGH_LIGHT_INFO m_highLight; // current high light data
1343 HIGH_LIGHT_INFO m_highLightPrevious; // a previously stored high light data
1344
1345 int m_fileFormatVersionAtLoad; // the version loaded from the file
1346 wxString m_generator; // the generator tag from the file
1347
1348 std::map<wxString, wxString> m_properties;
1349 std::shared_ptr<CONNECTIVITY_DATA> m_connectivity;
1350
1352 TITLE_BLOCK m_titles; // text in lower right of screen and plots
1354 PROJECT* m_project; // project this board is a part of
1356
1367 std::unique_ptr<BOARD_DESIGN_SETTINGS> m_designSettings;
1368
1373 bool m_legacyTeardrops = false;
1374
1375 NETINFO_LIST m_NetInfo; // net info list (name, design constraints...
1376
1377 std::vector<BOARD_LISTENER*> m_listeners;
1378
1380};
1381
1382
1383#endif // CLASS_BOARD_H_
BOARD_USE
Flags to specify how the board is being used.
Definition: board.h:279
LAYER_T
The allowed types of layers, same as Specctra DSN spec.
Definition: board.h:152
@ LT_POWER
Definition: board.h:155
@ LT_FRONT
Definition: board.h:159
@ LT_MIXED
Definition: board.h:156
@ LT_BACK
Definition: board.h:160
@ LT_UNDEFINED
Definition: board.h:153
@ LT_JUMPER
Definition: board.h:157
@ LT_AUX
Definition: board.h:158
@ LT_SIGNAL
Definition: board.h:154
std::set< BOARD_ITEM *, CompareByUuid > BOARD_ITEM_SET
Set of BOARD_ITEMs ordered by UUID.
Definition: board.h:273
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:104
virtual void OnBoardNetSettingsChanged(BOARD &aBoard)
Definition: board.h:258
virtual void OnBoardItemsAdded(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:255
virtual void OnBoardRatsnestChanged(BOARD &aBoard)
Definition: board.h:262
virtual void OnBoardCompositeUpdate(BOARD &aBoard, std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aDeletedItems)
Definition: board.h:263
virtual void OnBoardItemsChanged(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:260
virtual void OnBoardItemChanged(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:259
virtual void OnBoardItemRemoved(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:256
virtual void OnBoardItemAdded(BOARD &aBoard, BOARD_ITEM *aBoardItem)
Definition: board.h:254
virtual void OnBoardHighlightNetChanged(BOARD &aBoard)
Definition: board.h:261
virtual ~BOARD_LISTENER()
Definition: board.h:253
virtual void OnBoardItemsRemoved(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Definition: board.h:257
Manage layers needed to make a physical board.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:289
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:1751
ZONE * m_SolderMaskBridges
Definition: board.h:1296
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:862
BOARD_STACKUP GetStackupOrDefault() const
Definition: board.cpp:2267
void SetPlotOptions(const PCB_PLOT_PARAMS &aOptions)
Definition: board.h:686
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_EnclosedByAreaCache
Definition: board.h:1284
std::map< ZONE *, std::map< PCB_LAYER_ID, ISOLATED_ISLANDS > > m_ZoneIsolatedIslandsMap
Definition: board.h:1297
GENERATORS m_generators
Definition: board.h:1335
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:2473
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:2667
const NETINFO_LIST & GetNetInfo() const
Definition: board.h:864
bool m_LegacyDesignSettingsLoaded
True if the legacy board design settings were loaded from a file.
Definition: board.h:372
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
Definition: board.h:319
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:757
void recalcOpposites()
Definition: board.cpp:666
void SetPosition(const VECTOR2I &aPos) override
Definition: board.cpp:494
std::map< wxString, wxString > m_properties
Definition: board.h:1348
EMBEDDED_FILES * GetEmbeddedFiles() override
Definition: board.cpp:2523
int m_fileFormatVersionAtLoad
Definition: board.h:1345
NETINFO_ITEM * DpCoupledNet(const NETINFO_ITEM *aNet)
Definition: board.cpp:1971
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:771
std::vector< ZONE * > m_DRCCopperZones
Definition: board.h:1293
BOARD_USE GetBoardUse() const
Get what the board use is.
Definition: board.h:308
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition: board.cpp:982
const std::set< int > & GetHighLightNetCodes() const
Definition: board.h:531
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:2613
bool m_legacyTeardrops
Teardrops in 7.0 were applied as a post-processing step (rather than from pad and via properties).
Definition: board.h:1373
TITLE_BLOCK m_titles
Definition: board.h:1352
GAL_SET m_LegacyVisibleItems
Definition: board.h:369
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:301
ZONE * GetArea(int index) const
Return the Zone at a given index.
Definition: board.h:1021
const BOX2I GetBoardEdgesBoundingBox() const
Return the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition: board.h:922
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: board.h:908
void BuildListOfNets()
Definition: board.h:827
PAD * GetPadFast(const VECTOR2I &aPosition, LSET aLayerMask) const
Return pad found at aPosition on aLayerMask using the fast search method.
Definition: board.cpp:2125
LAYER m_layers[PCB_LAYER_ID_COUNT]
Definition: board.h:1340
const GENERATORS & Generators() const
Definition: board.h:336
void SetFileName(const wxString &aFileName)
Definition: board.h:324
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:779
const std::vector< BOARD_CONNECTED_ITEM * > AllConnectedItems()
Definition: board.cpp:2587
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:823
int m_outlinesChainingEpsilon
the max distance between 2 end point to see them connected when building the board outlines
Definition: board.h:1320
std::set< wxString > GetNetClassAssignmentCandidates() const
Return the set of netname candidates for netclass assignment.
Definition: board.cpp:2010
BOARD_USE m_boardUse
What is this board being used for.
Definition: board.h:1323
PAGE_INFO m_paper
Definition: board.h:1351
void RemoveAllListeners()
Remove all listeners.
Definition: board.cpp:2661
FOOTPRINTS m_footprints
Definition: board.h:1331
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:1367
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:777
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:2642
const PAGE_INFO & GetPageSettings() const
Definition: board.h:682
void UpdateUserUnits(BOARD_ITEM *aItem, KIGFX::VIEW *aView)
Update any references within aItem (or its descendants) to the user units.
Definition: board.cpp:1313
void SetProperties(const std::map< wxString, wxString > &aProps)
Definition: board.h:362
BOARD(const BOARD &aOther)=delete
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
Definition: board.cpp:817
void SetHighLightNet(int aNetCode, bool aMulti=false)
Select the netcode to be highlighted.
Definition: board.cpp:2703
HIGH_LIGHT_INFO m_highLight
Definition: board.h:1342
bool SetLayerDescr(PCB_LAYER_ID aIndex, const LAYER &aLayer)
Return the type of the copper layer given by aLayer.
Definition: board.cpp:542
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
Definition: board.cpp:1900
EDA_UNITS m_userUnits
Definition: board.h:1355
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:1390
const ZONES & Zones() const
Definition: board.h:334
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false, bool aIncludeHiddenText=false) const
Calculate the bounding box containing all board items (or board edge segments).
Definition: board.cpp:1652
void InvokeListeners(Func &&aFunc, Args &&... args)
Definition: board.h:1307
void SanitizeNetcodes()
Definition: board.cpp:2632
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:2448
const GROUPS & Groups() const
The groups must maintain the following invariants.
Definition: board.h:357
~BOARD()
Definition: board.cpp:143
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:186
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:783
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Return the type of the copper layer given by aLayer.
Definition: board.cpp:610
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
Definition: board.cpp:327
DRAWINGS m_drawings
Definition: board.h:1330
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:2679
int SetAreasNetCodesFromNetNames()
Set the .m_NetCode member of all copper areas, according to the area Net Name The SetNetCodesFromNetN...
Definition: board.cpp:2061
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition: board.cpp:2033
EDA_UNITS GetUserUnits()
Definition: board.h:694
void ResetNetHighLight()
Reset all high light data to the init state.
Definition: board.cpp:2694
PCB_PLOT_PARAMS m_plotOptions
Definition: board.h:1353
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition: board.cpp:591
std::list< ZONE * > GetZoneList(bool aIncludeZonesInFootprints=false) const
Definition: board.cpp:2428
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:2896
bool ResolveTextVar(wxString *token, int aDepth) const
Definition: board.cpp:431
const MARKERS & Markers() const
Definition: board.h:338
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:447
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayer) const
Definition: board.cpp:727
const std::vector< PAD * > GetPads() const
Return a reference to a list of all the pads.
Definition: board.cpp:2573
void Move(const VECTOR2I &aMoveVector) override
Move this object.
Definition: board.cpp:500
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:688
void FixupEmbeddedData()
After loading a file from disk, the footprints do not yet contain the full data for their embedded fi...
Definition: board.cpp:962
int GetMaxClearanceValue() const
Returns the maximum clearance value for any object on the board.
Definition: board.cpp:880
ZONES m_zones
Definition: board.h:1334
PAD * GetPad(const VECTOR2I &aPosition) const
Definition: board.h:1076
PCB_LAYER_ID GetLayerID(const wxString &aLayerName) const
Return the ID of a layer.
Definition: board.cpp:555
HIGH_LIGHT_INFO m_highLightPrevious
Definition: board.h:1343
const VECTOR2I GetFocusPosition() const override
Similar to GetPosition, but allows items to return their visual center rather than their anchor.
Definition: board.h:383
void HighLightOFF()
Disable net highlight.
Definition: board.h:561
NETINFO_LIST m_NetInfo
Definition: board.h:1375
LSET m_LegacyVisibleLayers
Visibility settings stored in board prior to 6.0, only used for loading legacy files.
Definition: board.h:368
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition: board.cpp:806
void SetOutlinesChainingEpsilon(int aValue)
Definition: board.h:733
NETINFO_LIST::iterator EndNets() const
Definition: board.h:886
GroupLegalOpsField GroupLegalOps(const PCB_SELECTION &selection) const
Check which selection tool group operations are legal given the selection.
Definition: board.cpp:2808
int GetCopperLayerCount() const
Definition: board.cpp:733
int m_timeStamp
Definition: board.h:1324
std::vector< BOARD_LISTENER * > m_listeners
Definition: board.h:1377
const std::map< wxString, wxString > & GetProperties() const
Definition: board.h:361
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsCourtyardCache
Definition: board.h:1280
void IncrementTimeStamp()
Definition: board.cpp:255
int MatchDpSuffix(const wxString &aNetName, wxString &aComplementNet)
Fetch the coupled netname for a given net.
Definition: board.cpp:1921
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsFCourtyardCache
Definition: board.h:1281
void RemoveUnusedNets(BOARD_COMMIT *aCommit)
Definition: board.h:869
const FOOTPRINTS & Footprints() const
Definition: board.h:330
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: board.h:1349
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:1226
const BOARD_ITEM_SET GetItemSet()
Definition: board.cpp:2997
const TRACKS & Tracks() const
Definition: board.h:328
int m_DRCMaxPhysicalClearance
Definition: board.h:1295
FOOTPRINT * FindFootprintByPath(const KIID_PATH &aPath) const
Search for a FOOTPRINT within this board with the given path.
Definition: board.cpp:1998
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:1114
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: board.h:683
std::unordered_map< wxString, LSET > m_LayerExpressionCache
Definition: board.h:1285
bool m_embedFonts
Definition: board.h:1379
wxString GroupsSanityCheckInternal(bool repair)
Definition: board.cpp:2739
void OnRatsnestChanged()
Notify the board and its listeners that the ratsnest has been recomputed.
Definition: board.cpp:2688
wxString ConvertCrossReferencesToKIIDs(const wxString &aSource) const
Convert cross-references back and forth between ${refDes:field} and ${kiid:field}.
Definition: board.cpp:1533
wxString GetClass() const override
Return the class name.
Definition: board.h:990
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition: board.cpp:789
NETINFO_LIST::iterator BeginNets() const
Definition: board.h:878
bool m_LegacyNetclassesLoaded
True if netclasses were loaded from the file.
Definition: board.h:376
void SetCopperLayerCount(int aCount)
Definition: board.cpp:739
std::unordered_map< const ZONE *, BOX2I > m_ZoneBBoxCache
Definition: board.h:1288
wxString m_generator
Definition: board.h:1346
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsBCourtyardCache
Definition: board.h:1282
TRACKS TracksInNet(int aNetCode)
Collect all the TRACKs and VIAs that are members of a net given by aNetCode.
Definition: board.cpp:520
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
Definition: board.cpp:196
PROJECT * m_project
Definition: board.h:1354
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:2364
const wxString & GetFileName() const
Definition: board.h:326
bool operator==(const BOARD_ITEM &aOther) const override
Definition: board.cpp:3012
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:1986
unsigned GetNodesCount(int aNet=-1) const
Definition: board.cpp:1635
bool IsHighLightNetON() const
Definition: board.h:547
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
Definition: board.cpp:1494
int GetFileFormatVersionAtLoad() const
Definition: board.h:393
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
Definition: board.cpp:829
std::shared_ptr< DRC_RTREE > m_CopperItemRTreeCache
Definition: board.h:1287
bool SetLayerType(PCB_LAYER_ID aLayer, LAYER_T aLayerType)
Change the type of the layer given by aLayer.
Definition: board.cpp:624
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: board.h:685
BOARD & operator=(const BOARD &aOther)=delete
wxString m_fileName
Definition: board.h:1326
const wxString & GetGenerator() const
Adds an item to the container.
Definition: board.h:396
int GetAreaCount() const
Definition: board.h:1037
void SetLegacyTeardrops(bool aFlag)
Definition: board.h:1255
int GetOutlinesChainingEpsilon()
Definition: board.h:732
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:2252
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:763
int m_DRCMaxClearance
Definition: board.h:1294
void ClearProject()
Definition: board.cpp:235
std::unordered_map< ZONE *, std::unique_ptr< DRC_RTREE > > m_CopperZoneRTreeCache
Definition: board.h:1286
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:1108
int LayerDepth(PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) const
Definition: board.cpp:745
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition: board.cpp:1377
PROJECT * GetProject() const
Definition: board.h:490
bool IsEmpty() const
Definition: board.h:385
bool LegacyTeardrops() const
Definition: board.h:1254
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:2278
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:1713
const TITLE_BLOCK & GetTitleBlock() const
Definition: board.h:689
wxString GroupsSanityCheck(bool repair=false)
Consistency check of internal m_groups structure.
Definition: board.cpp:2726
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:874
std::vector< ZONE * > m_DRCZones
Definition: board.h:1292
PAD * GetPad(const VECTOR2I &aPosition, LSET aLayerMask) const
Find a pad aPosition on aLayer.
Definition: board.cpp:2095
void SetGenerator(const wxString &aGenerator)
Definition: board.h:395
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:1587
void SynchronizeProperties()
Copy the current project's text variables into the boards property cache.
Definition: board.cpp:2024
std::unordered_map< KIID, BOARD_ITEM * > m_itemByIdCache
Definition: board.h:1338
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
Definition: board.cpp:2649
std::shared_mutex m_CachesMutex
Definition: board.h:1279
unsigned GetNetCount() const
Definition: board.h:895
void DeleteMARKERs()
Delete all MARKERS from the board.
Definition: board.cpp:1339
void Remove(BOARD_ITEM *aBoardItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
Removes an item from the container.
Definition: board.cpp:1120
GROUPS m_groups
Definition: board.h:1333
MARKERS m_markers
Definition: board.h:1329
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_IntersectsAreaCache
Definition: board.h:1283
std::optional< int > m_maxClearanceValue
Definition: board.h:1289
void HighLightON(bool aValue=true)
Enable or disable net highlighting.
Definition: board.cpp:2716
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: board.h:690
bool TestZoneIntersection(ZONE *aZone1, ZONE *aZone2)
Test for intersection of 2 copper areas.
TRACKS m_tracks
Definition: board.h:1332
bool m_LegacyCopperEdgeClearanceLoaded
Definition: board.h:373
int GetTimeStamp() const
Definition: board.h:312
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:2673
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:474
VECTOR2I GetPosition() const override
Definition: board.cpp:488
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
Definition: board.cpp:912
static bool ClassOf(const EDA_ITEM *aItem)
Definition: board.h:291
void SetUserUnits(EDA_UNITS aUnits)
Definition: board.h:695
void SetVisibleElements(const GAL_SET &aMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:796
void EmbedFonts() override
Finds all fonts used in the board and embeds them in the file if permissions allow.
Definition: board.cpp:2541
double Similarity(const BOARD_ITEM &aOther) const override
Return the Similarity.
Definition: board.h:983
const DRAWINGS & Drawings() const
Definition: board.h:332
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: board.cpp:1307
void SetFileFormatVersionAtLoad(int aVersion)
Definition: board.h:392
const Vec GetCenter() const
Definition: box2.h:220
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:87
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:308
void Clear()
Definition: board.h:228
HIGH_LIGHT_INFO()
Definition: board.h:234
std::set< int > m_netCodes
Definition: board.h:225
bool m_highLightOn
Definition: board.h:226
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
Definition: kiid.h:49
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:35
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:224
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:62
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
Represent a set of closed polygons.
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:41
Handle a list of polygons defining a copper zone.
Definition: zone.h: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
Definition: eda_item.h:82
EDA_UNITS
Definition: eda_units.h:46
static void hash_combine(std::size_t &seed)
This is a dummy function to take the final case of hash_combine below.
Definition: hash.h:34
wxString LayerName(int aLayer)
Returns the default display name for a given layer.
Definition: layer_id.cpp:30
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:194
@ LAYER_HIDDEN_TEXT
text marked as invisible
Definition: layer_ids.h:204
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ PCB_LAYER_ID_COUNT
Definition: layer_ids.h:137
STL namespace.
std::vector< ZONE * > ZONES
Definition: pcb_io_eagle.h:47
ENDPOINT_T
Definition: pcb_track.h:59
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition: board.cpp:2856
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition: board.cpp:2835
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:168
int m_opposite
Similar layer on opposite side of the board, if any.
Definition: board.h:200
static LAYER_T ParseType(const char *aType)
Convert a string to a LAYER_T.
Definition: board.cpp:653
void clear()
Definition: board.h:174
LAYER_T m_type
The type of the layer.
Definition: board.h:197
static const char * ShowType(LAYER_T aType)
Convert a LAYER_T enum to a string representation of the layer type.
Definition: board.cpp:637
LAYER()
Definition: board.h:169
wxString m_name
The canonical name of the layer.
Definition: board.h:195
wxString m_userName
The user defined name of the layer.
Definition: board.h:196
bool m_visible
Definition: board.h:198
int m_number
The layer ID.
Definition: board.h:199
BOARD_ITEM * A
Definition: board.h:90
bool operator==(const PTR_LAYER_CACHE_KEY &other) const
Definition: board.h:93
PCB_LAYER_ID Layer
Definition: board.h:91
BOARD_ITEM * A
Definition: board.h:79
BOARD_ITEM * B
Definition: board.h:80
bool operator==(const PTR_PTR_CACHE_KEY &other) const
Definition: board.h:82
bool operator==(const PTR_PTR_LAYER_CACHE_KEY &other) const
Definition: board.h:105
BOARD_ITEM * B
Definition: board.h:102
BOARD_ITEM * A
Definition: board.h:101
PCB_LAYER_ID Layer
Definition: board.h:103
std::size_t operator()(const PTR_LAYER_CACHE_KEY &k) const
Definition: board.h:127
std::size_t operator()(const PTR_PTR_CACHE_KEY &k) const
Definition: board.h:116
std::size_t operator()(const PTR_PTR_LAYER_CACHE_KEY &k) const
Definition: board.h:138
@ 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