72 m_LegacyDesignSettingsLoaded( false ),
73 m_LegacyCopperEdgeClearanceLoaded( false ),
74 m_LegacyNetclassesLoaded( false ),
102 int infinity = ( std::numeric_limits<int>::max() / 2 ) -
pcbIUScale.
mmToIU( 1 );
114 bds.
m_NetSettings->m_DefaultNetClass->SetDescription(
_(
"This is the default net class." ) );
133 item->SetParentGroup(
nullptr );
185 if( aProject && !aReferenceOnly )
202 std::shared_ptr<NET_SETTINGS>& projectSettings =
project.NetSettings();
204 projectSettings->m_DefaultNetClass = legacySettings->m_DefaultNetClass;
205 projectSettings->m_NetClasses = legacySettings->m_NetClasses;
206 projectSettings->m_NetClassPatternAssignments =
207 std::move( legacySettings->m_NetClassPatternAssignments );
208 projectSettings->m_NetClassPatternAssignmentCache.clear();
228 project.m_BoardSettings =
nullptr;
277 std::set<std::pair<KIID, KIID>> m_ratsnestExclusions;
283 const std::shared_ptr<RC_ITEM>& rcItem = marker->GetRCItem();
284 m_ratsnestExclusions.emplace( rcItem->GetMainItemID(), rcItem->GetAuxItemID() );
285 m_ratsnestExclusions.emplace( rcItem->GetAuxItemID(), rcItem->GetMainItemID() );
295 std::pair<KIID, KIID> ids = { aEdge.GetSourceNode()->Parent()->m_Uuid,
296 aEdge.GetTargetNode()->Parent()->m_Uuid };
298 aEdge.
SetVisible( m_ratsnestExclusions.count( ids ) == 0 );
314 marker->SetExcluded(
true );
319 std::vector<PCB_MARKER*> newMarkers;
344 newMarkers.push_back( marker );
358 [&](
const wxString& aVar )
361 aVars->push_back( aVar );
364 add( wxT(
"LAYER" ) );
368 for( std::pair<wxString, wxString> entry :
GetProject()->GetTextVars() )
375 if( token->Contains(
':' ) )
378 wxString ref = token->BeforeFirst(
':', &remainder );
393 wxString var = *token;
420 wxLogWarning( wxT(
"This should not be called on the BOARD object") );
427 [&] (
EDA_ITEM* item,
void* testData )
435 brdItem->
Move( aMoveVector );
437 return INSPECT_RESULT::CONTINUE;
455 return INSPECT_RESULT::CONTINUE;
483 if (
m_layers[ layer ].m_name == aLayerName ||
m_layers[ layer ].m_userName == aLayerName )
506 if( !
m_layers[aLayer].m_userName.IsEmpty() )
516 wxCHECK( !aLayerName.IsEmpty(),
false );
519 if( aLayerName.Find( wxChar(
'"' ) ) != wxNOT_FOUND )
574 if( strcmp( aType,
"signal" ) == 0 )
576 else if( strcmp( aType,
"power" ) == 0 )
578 else if( strcmp( aType,
"mixed" ) == 0 )
580 else if( strcmp( aType,
"jumper" ) == 0 )
601 if( aStartLayer > aEndLayer )
602 std::swap( aStartLayer, aEndLayer );
604 if( aEndLayer ==
B_Cu )
607 return aEndLayer - aStartLayer;
655 for(
size_t i = 0; i < aSet.size(); i++ )
696 track->SetLocalRatsnestVisible( isEnabled );
700 for(
PAD*
pad : footprint->Pads() )
701 pad->SetLocalRatsnestVisible( isEnabled );
705 zone->SetLocalRatsnestVisible( isEnabled );
722 default: wxFAIL_MSG( wxT(
"BOARD::IsModuleLayerVisible(): bad layer" ) );
return true;
748 std::vector<ZONE*> zones = aZones;
757 aReporter->
Report(
_(
"Tessellating copper zones..." ) );
760 std::vector<std::future<size_t>> returns;
762 returns.reserve( zones.size() );
764 auto cache_zones = [aReporter](
ZONE* aZone ) ->
size_t
769 aZone->CacheTriangulation();
777 for(
ZONE* zone : zones )
778 returns.emplace_back(
tp.submit( cache_zones, zone ) );
781 for(
const std::future<size_t>& ret : returns )
783 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
785 while( status != std::future_status::ready )
790 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
798 if( aBoardItem ==
nullptr )
800 wxFAIL_MSG( wxT(
"BOARD::Add() param error: aBoardItem nullptr" ) );
804 switch( aBoardItem->
Type() )
832 wxFAIL_MSG( wxT(
"BOARD::Add() Cannot place Track on non-copper layer" ) );
836 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
844 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
861 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
872 msg.Printf( wxT(
"BOARD::Add() needs work: BOARD_ITEM type (%d) not handled" ),
873 aBoardItem->
Type() );
883 if( !aSkipConnectivity )
886 if( aMode != ADD_MODE::BULK_INSERT && aMode != ADD_MODE::BULK_APPEND )
908 wxASSERT( aBoardItem );
910 switch( aBoardItem->
Type() )
919 for(
PAD*
pad : fp->Pads() )
921 if(
pad->GetNet() == item )
922 pad->SetNet( unconnected );
928 if( zone->GetNet() == item )
929 zone->SetNet( unconnected );
934 if( track->GetNet() == item )
935 track->SetNet( unconnected );
979 wxFAIL_MSG( wxT(
"BOARD::Remove() needs more ::Type() support" ) );
991 if( aRemoveMode != REMOVE_MODE::BULK )
998 return wxString::Format(
_(
"PCB" ) );
1005 [&](
EDA_ITEM* descendant,
void* aTestData )
1009 if( dimension->
GetUnitsMode() == DIM_UNITS_MODE::AUTOMATIC )
1014 aView->
Update( dimension );
1017 return INSPECT_RESULT::CONTINUE;
1052 remaining.push_back( marker );
1076 if( track->m_Uuid == aID )
1082 if( footprint->m_Uuid == aID )
1085 for(
PAD*
pad : footprint->Pads() )
1087 if(
pad->m_Uuid == aID )
1091 if( footprint->Reference().m_Uuid == aID )
1092 return &footprint->Reference();
1094 if( footprint->Value().m_Uuid == aID )
1095 return &footprint->Value();
1097 for(
BOARD_ITEM* drawing : footprint->GraphicalItems() )
1099 if( drawing->m_Uuid == aID )
1105 if( zone->m_Uuid == aID )
1111 if(
group->m_Uuid == aID )
1118 if( zone->m_Uuid == aID )
1124 if( drawing->m_Uuid == aID )
1130 if( marker->m_Uuid == aID )
1136 if(
group->m_Uuid == aID )
1141 return const_cast<BOARD*
>( this );
1154 aMap[ track->m_Uuid ] = track;
1158 aMap[ footprint->m_Uuid ] = footprint;
1160 for(
PAD*
pad : footprint->Pads() )
1161 aMap[
pad->m_Uuid ] =
pad;
1163 aMap[ footprint->Reference().m_Uuid ] = &footprint->Reference();
1164 aMap[ footprint->Value().m_Uuid ] = &footprint->Value();
1166 for(
BOARD_ITEM* drawing : footprint->GraphicalItems() )
1167 aMap[ drawing->m_Uuid ] = drawing;
1171 aMap[ zone->m_Uuid ] = zone;
1174 aMap[ drawing->m_Uuid ] = drawing;
1177 aMap[ marker->m_Uuid ] = marker;
1187 size_t sourceLen = aSource.length();
1189 for(
size_t i = 0; i < sourceLen; ++i )
1191 if( aSource[i] ==
'$' && i + 1 < sourceLen && aSource[i+1] ==
'{' )
1194 bool isCrossRef =
false;
1196 for( i = i + 2; i < sourceLen; ++i )
1198 if( aSource[i] ==
'}' )
1201 if( aSource[i] ==
':' )
1204 token.append( aSource[i] );
1210 wxString ref = token.BeforeFirst(
':', &remainder );
1214 if( footprint->GetReference().CmpNoCase( ref ) == 0 )
1216 wxString
test( remainder );
1218 if( footprint->ResolveTextVar( &
test ) )
1219 token = footprint->m_Uuid.AsString() + wxT(
":" ) + remainder;
1226 newbuf.append( wxT(
"${" ) + token + wxT(
"}" ) );
1230 newbuf.append( aSource[i] );
1241 size_t sourceLen = aSource.length();
1243 for(
size_t i = 0; i < sourceLen; ++i )
1245 if( aSource[i] ==
'$' && i + 1 < sourceLen && aSource[i+1] ==
'{' )
1248 bool isCrossRef =
false;
1250 for( i = i + 2; i < sourceLen; ++i )
1252 if( aSource[i] ==
'}' )
1255 if( aSource[i] ==
':' )
1258 token.append( aSource[i] );
1264 wxString ref = token.BeforeFirst(
':', &remainder );
1269 token =
static_cast<FOOTPRINT*
>( refItem )->GetReference() + wxT(
":" )
1274 newbuf.append( wxT(
"${" ) + token + wxT(
"}" ) );
1278 newbuf.append( aSource[i] );
1288 unsigned retval = 0;
1292 for(
PAD*
pad : footprint->Pads() )
1294 if( ( aNet == -1 &&
pad->GetNetCode() > 0 ) || aNet ==
pad->GetNetCode() )
1315 if( aBoardEdgesOnly )
1324 if( ( item->GetLayerSet() & visible ).any() )
1325 bbox.
Merge( item->GetBoundingBox() );
1331 if( !( footprint->GetLayerSet() & visible ).any() )
1334 if( aBoardEdgesOnly )
1336 for(
const BOARD_ITEM* edge : footprint->GraphicalItems() )
1339 bbox.
Merge( edge->GetBoundingBox() );
1344 bbox.
Merge( footprint->GetBoundingBox(
true, showInvisibleText ) );
1348 if( !aBoardEdgesOnly )
1353 if( ( track->GetLayerSet() & visible ).any() )
1354 bbox.
Merge( track->GetBoundingBox() );
1360 if( ( aZone->GetLayerSet() & visible ).any() )
1361 bbox.
Merge( aZone->GetBoundingBox() );
1373 int trackSegmentCount = 0;
1374 std::set<int> netCodes;
1382 trackSegmentCount++;
1384 if( item->GetNetCode() > 0 )
1385 netCodes.insert( item->GetNetCode() );
1390 for(
PAD*
pad : footprint->Pads() )
1394 if(
pad->GetNetCode() > 0 )
1395 netCodes.insert(
pad->GetNetCode() );
1399 aList.emplace_back(
_(
"Pads" ), wxString::Format( wxT(
"%d" ), padCount ) );
1400 aList.emplace_back(
_(
"Vias" ), wxString::Format( wxT(
"%d" ), viaCount ) );
1401 aList.emplace_back(
_(
"Track Segments" ), wxString::Format( wxT(
"%d" ), trackSegmentCount ) );
1402 aList.emplace_back(
_(
"Nets" ), wxString::Format( wxT(
"%d" ), (
int) netCodes.size() ) );
1403 aList.emplace_back(
_(
"Unrouted" ), wxString::Format( wxT(
"%d" ), unconnected ) );
1408 const std::vector<KICAD_T>& scanTypes )
1410#if 0 && defined(DEBUG)
1411 std::cout <<
GetClass().mb_str() <<
' ';
1414 bool footprintsScanned =
false;
1415 bool drawingsScanned =
false;
1416 bool tracksScanned =
false;
1418 for(
KICAD_T scanType : scanTypes )
1423 if( inspector(
this, testData ) == INSPECT_RESULT::QUIT )
1424 return INSPECT_RESULT::QUIT;
1446 if( !footprintsScanned )
1448 if( IterateForward<FOOTPRINT*>(
m_footprints, inspector, testData, scanTypes )
1449 == INSPECT_RESULT::QUIT )
1451 return INSPECT_RESULT::QUIT;
1454 footprintsScanned =
true;
1457 if( !drawingsScanned )
1459 if( IterateForward<BOARD_ITEM*>(
m_drawings, inspector, testData, scanTypes )
1460 == INSPECT_RESULT::QUIT )
1462 return INSPECT_RESULT::QUIT;
1465 drawingsScanned =
true;
1473 if( !tracksScanned )
1475 if( IterateForward<PCB_TRACK*>(
m_tracks, inspector, testData, scanTypes )
1476 == INSPECT_RESULT::QUIT )
1478 return INSPECT_RESULT::QUIT;
1481 tracksScanned =
true;
1489 if( marker->Visit( inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
1490 return INSPECT_RESULT::QUIT;
1496 if( !footprintsScanned )
1498 if( IterateForward<FOOTPRINT*>(
m_footprints, inspector, testData, scanTypes )
1499 == INSPECT_RESULT::QUIT )
1501 return INSPECT_RESULT::QUIT;
1504 footprintsScanned =
true;
1509 if( zone->Visit( inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
1510 return INSPECT_RESULT::QUIT;
1516 if( IterateForward<PCB_GROUP*>(
m_groups, inspector, testData, { scanType } )
1517 == INSPECT_RESULT::QUIT )
1519 return INSPECT_RESULT::QUIT;
1529 return INSPECT_RESULT::CONTINUE;
1558 if( aReference == footprint->GetReference() )
1570 if( footprint->GetPath() == aPath )
1580 std::set<wxString> names;
1584 if( !net->GetNetname().IsEmpty() )
1585 names.insert( net->GetNetname() );
1607 std::shared_ptr<NETCLASS>& defaultNetClass = bds.
m_NetSettings->m_DefaultNetClass;
1610 net->SetNetClass( bds.
m_NetSettings->GetEffectiveNetClass( net->GetNetname() ) );
1612 if( aResetTrackAndViaSizes )
1631 int error_count = 0;
1635 if( !zone->IsOnCopperLayer() )
1641 if( zone->GetNetCode() != 0 )
1654 zone->SetNetCode( -1 );
1665 if( !aLayerSet.any() )
1672 if( footprint->HitTest( aPosition ) )
1673 pad = footprint->GetPad( aPosition, aLayerSet );
1689 return GetPad( aPosition, lset );
1697 for(
PAD*
pad : footprint->Pads() )
1699 if(
pad->GetPosition() != aPosition )
1703 if( (
pad->GetLayerSet() & aLayerSet ).any() )
1716 int idxmax = aPadList.size() - 1;
1718 int delta = aPadList.size();
1731 PAD*
pad = aPadList[idx];
1733 if(
pad->GetPosition() == aPosition )
1736 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
1743 for(
int ii = idx+1; ii <= idxmax; ii++ )
1747 if(
pad->GetPosition() != aPosition )
1750 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
1754 for(
int ii = idx - 1 ;ii >=0; ii-- )
1758 if(
pad->GetPosition() != aPosition )
1761 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
1769 if(
pad->GetPosition().x == aPosition.
x )
1771 if(
pad->GetPosition().y < aPosition.
y )
1786 else if(
pad->GetPosition().x < aPosition.
x )
1824 for(
PAD*
pad : footprint->Pads( ) )
1826 if( aNetCode < 0 || pad->GetNetCode() == aNetCode )
1827 aVector.push_back(
pad );
1838 double length = 0.0;
1839 double package_length = 0.0;
1847 { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T } ) )
1853 if( track->Type() ==
PCB_VIA_T && useHeight )
1863 length += track->GetLength();
1868 SEG trackSeg( track->GetStart(), track->GetEnd() );
1869 double segLen = trackSeg.
Length();
1870 double segInPadLen = 0;
1872 for(
auto pad_it : connectivity->GetConnectedPads( item ) )
1876 bool hitStart =
pad->HitTest( track->GetStart(), track->GetWidth() / 2 );
1877 bool hitEnd =
pad->HitTest( track->GetEnd(), track->GetWidth() / 2 );
1879 if( hitStart && hitEnd )
1884 else if( hitStart || hitEnd )
1889 if(
pad->GetEffectivePolygon()->Collide( trackSeg, 0,
nullptr, &loc ) )
1897 segLen = trackSeg.
Length();
1906 length += segLen + segInPadLen;
1908 else if(
PAD*
pad = dyn_cast<PAD*>( item ) )
1910 package_length +=
pad->GetPadToDieLength();
1914 return std::make_tuple( count, length, package_length );
1919 bool aVisibleOnly,
bool aIgnoreLocked )
const
1923 int min_dim = 0x7FFFFFFF;
1924 int alt_min_dim = 0x7FFFFFFF;
1925 bool current_layer_back =
IsBackLayer( aActiveLayer );
1930 if( !candidate->HitTest( aPosition ) )
1934 if( aIgnoreLocked && candidate->IsLocked() )
1942 BOX2I bb = candidate->GetBoundingBox(
false,
false );
1948 int dist = ( aPosition.
x - offx ) * ( aPosition.
x - offx ) +
1949 ( aPosition.
y - offy ) * ( aPosition.
y - offy );
1953 if( dist <= min_dim )
1956 footprint = candidate;
1962 if( dist <= alt_min_dim )
1965 alt_footprint = candidate;
1976 return alt_footprint;
1984 std::list<ZONE*> zones;
1987 zones.push_back( zone );
1989 if( aIncludeZonesInFootprints )
1993 for(
ZONE* zone : footprint->Zones() )
1994 zones.push_back( zone );
2010 m_zones.push_back( new_area );
2019 ITEM_PICKER picker(
nullptr, new_area, UNDO_REDO::NEWITEM );
2029 bool aAllowUseArcsInPolygons )
2035 chainingEpsilon, aErrorHandler, aAllowUseArcsInPolygons );
2046 std::vector<PAD*> allPads;
2050 for(
PAD*
pad : footprint->Pads() )
2051 allPads.push_back(
pad );
2060 std::vector<BOARD_CONNECTED_ITEM*> items;
2063 items.push_back( track );
2067 for(
PAD*
pad : footprint->Pads() )
2068 items.push_back(
pad );
2072 items.push_back( zone );
2085 item->SetNet( netInfo );
2096 if(
FindNet( item->GetNetCode() ) ==
nullptr )
2178 return wxEmptyString;
2197 std::unordered_set<PCB_GROUP*> knownCycleFreeGroups;
2199 std::unordered_set<PCB_GROUP*> currentChainGroups;
2201 std::unordered_set<PCB_GROUP*> toCheckGroups;
2205 toCheckGroups.insert(
group);
2207 while( !toCheckGroups.empty() )
2209 currentChainGroups.clear();
2214 if( currentChainGroups.find(
group ) != currentChainGroups.end() )
2219 return "Cycle detected in group membership";
2221 else if( knownCycleFreeGroups.find(
group ) != knownCycleFreeGroups.end() )
2227 currentChainGroups.insert(
group );
2229 toCheckGroups.erase(
group );
2242 knownCycleFreeGroups.insert( currentChainGroups.begin(), currentChainGroups.end() );
2252 bool hasGroup =
false;
2253 bool hasMember =
false;
2298 if( aFirst->
Type() != aSecond->
Type() )
2299 return aFirst->
Type() < aSecond->
Type();
2308 return shape->
Compare( other );
2314 return text->Compare( other );
2321 return textbox->PCB_SHAPE::Compare( other ) && textbox->EDA_TEXT::Compare( other );
2336 if( !track->IsOnLayer( aLayer ) )
2339 track->TransformShapeToPolygon( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE );
2345 footprint->TransformPadsToPolySet( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE );
2348 footprint->TransformFPShapesToPolySet( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE,
2353 for(
const ZONE* zone : footprint->Zones() )
2355 if( zone->GetLayerSet().test( aLayer ) )
2356 zone->TransformSolidAreasShapesToPolygon( aLayer, aOutlines );
2363 if( zone->GetLayerSet().test( aLayer ) )
2364 zone->TransformSolidAreasShapesToPolygon( aLayer, aOutlines );
2370 if( !item->IsOnLayer( aLayer ) )
2373 switch( item->Type() )
2394 textbox->PCB_SHAPE::TransformShapeToPolygon( aOutlines, aLayer, 0, maxError,
2410 std::set<BOARD_ITEM*> items;
2412#define INSERT_ITEMS( collection ) \
2413 for( BOARD_ITEM * item : collection ) \
2414 items.insert( item );
@ NORMAL
Use all material properties from model file.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
constexpr EDA_IU_SCALE pcbIUScale
bool sortPadsByXthenYCoord(PAD *const &aLH, PAD *const &aRH)
Used by #GetSortedPadListByXCoord to sort a pad list by X coordinate value.
#define INSERT_ITEMS(collection)
#define DEFAULT_CHAINING_EPSILON_MM
BOARD_USE
Flags to specify how the board is being used.
LAYER_T
The allowed types of layers, same as Specctra DSN spec.
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.
Container for design settings for a BOARD object.
void UseCustomTrackViaSize(bool aEnabled)
Enables/disables custom track/via size settings.
void SetCustomDiffPairWidth(int aWidth)
Sets custom track width for differential pairs (i.e.
std::shared_ptr< NET_SETTINGS > m_NetSettings
void SetCustomTrackWidth(int aWidth)
Sets custom width for track (i.e.
void SetEnabledLayers(LSET aMask)
Change the bit-mask of enabled layers to aMask.
LSET GetEnabledLayers() const
Return a bit-mask of all the layers that are enabled.
void SetCustomViaSize(int aSize)
Set custom size for via diameter (i.e.
void SetCustomDiffPairGap(int aGap)
Sets custom gap for differential pairs (i.e.
bool IsLayerEnabled(PCB_LAYER_ID aLayerId) const
Test whether a given layer aLayerId is enabled.
BOARD_STACKUP & GetStackupDescriptor()
void SetCustomViaDrill(int aDrill)
Sets custom size for via drill (i.e.
void SetDefaultZoneSettings(const ZONE_SETTINGS &aSettings)
int GetCopperLayerCount() const
ZONE_SETTINGS & GetDefaultZoneSettings()
bool m_UseHeightForLengthCalcs
Enable inclusion of stackup height in track length measurements and length tuning.
void SetCopperLayerCount(int aNewLayerCount)
Set the copper layer count to aNewLayerCount.
void SetCustomDiffPairViaGap(int aGap)
Sets custom via gap for differential pairs (i.e.
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...
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
PCB_GROUP * GetParentGroup() const
virtual void Move(const VECTOR2I &aMoveVector)
Move this object.
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
static VECTOR2I ZeroOffset
A value of wxPoint(0,0) which can be passed to the Draw() functions.
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
virtual void OnBoardNetSettingsChanged(BOARD &aBoard)
virtual void OnBoardItemsAdded(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
virtual void OnBoardItemsChanged(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
virtual void OnBoardItemChanged(BOARD &aBoard, BOARD_ITEM *aBoardItem)
virtual void OnBoardItemRemoved(BOARD &aBoard, BOARD_ITEM *aBoardItem)
virtual void OnBoardItemAdded(BOARD &aBoard, BOARD_ITEM *aBoardItem)
virtual void OnBoardHighlightNetChanged(BOARD &aBoard)
virtual void OnBoardItemsRemoved(BOARD &aBoard, std::vector< BOARD_ITEM * > &aBoardItem)
Manage layers needed to make a physical board.
int GetLayerDistance(PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer) const
Calculate the distance (height) between the two given copper layers.
Information pertinent to a Pcbnew printed circuit board.
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...
void GetContextualTextVars(wxArrayString *aVars) const
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...
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_EnclosedByAreaCache
std::map< ZONE *, std::map< PCB_LAYER_ID, ISOLATED_ISLANDS > > m_ZoneIsolatedIslandsMap
void OnItemChanged(BOARD_ITEM *aItem)
Notify the board and its listeners that an item on the board has been modified in some way.
bool m_LegacyDesignSettingsLoaded
True if the legacy board design settings were loaded from a file.
bool IsFootprintHolder() const
Find out if the board is being used to hold a single footprint for editing/viewing.
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
void SetPosition(const VECTOR2I &aPos) override
std::map< wxString, wxString > m_properties
int m_fileFormatVersionAtLoad
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
std::vector< ZONE * > m_DRCCopperZones
bool GetBoardPolygonOutlines(SHAPE_POLY_SET &aOutlines, OUTLINE_ERROR_HANDLER *aErrorHandler=nullptr, bool aAllowUseArcsInPolygons=false)
Extract the board outlines and build a closed polygon from lines, arcs and circle items on edge cut l...
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
GAL_SET m_LegacyVisibleItems
void SetZoneSettings(const ZONE_SETTINGS &aSettings) override
Set the zone settings for this container.
PAD * GetPadFast(const VECTOR2I &aPosition, LSET aLayerMask) const
Return pad found at aPosition on aLayerMask using the fast search method.
LAYER m_layers[PCB_LAYER_ID_COUNT]
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
const std::vector< BOARD_CONNECTED_ITEM * > AllConnectedItems()
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
int m_outlinesChainingEpsilon
the max distance between 2 end point to see them connected when building the board outlines
std::set< wxString > GetNetClassAssignmentCandidates() const
Return the set of netname candidates for netclass assignment.
const ZONE_SETTINGS & GetZoneSettings() const override
Fetch the zone settings for this container.
void MapNets(const BOARD *aDestBoard)
Map all nets in the given board to nets with the same name (if any) in the destination board.
void RemoveAllListeners()
Remove all listeners.
std::unique_ptr< BOARD_DESIGN_SETTINGS > m_designSettings
All of the board design settings are stored as a JSON object inside the project file.
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
void AddListener(BOARD_LISTENER *aListener)
Add a listener to the board to receive calls whenever something on the board has been modified.
void UpdateUserUnits(BOARD_ITEM *aItem, KIGFX::VIEW *aView)
Update any references within aItem (or its descendants) to the user units.
void SetProperties(const std::map< wxString, wxString > &aProps)
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
void SetHighLightNet(int aNetCode, bool aMulti=false)
Select the netcode to be highlighted.
HIGH_LIGHT_INFO m_highLight
bool SetLayerDescr(PCB_LAYER_ID aIndex, const LAYER &aLayer)
Return the type of the copper layer given by aLayer.
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
BOARD_ITEM * GetItem(const KIID &aID) const
void InvokeListeners(Func &&aFunc, Args &&... args)
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
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.
const std::set< BOARD_ITEM * > GetItemSet()
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
bool IsLayerEnabled(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Return the type of the copper layer given by aLayer.
int SetAreasNetCodesFromNetNames()
Set the .m_NetCode member of all copper areas, according to the area Net Name The SetNetCodesFromNetN...
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
void ResetNetHighLight()
Reset all high light data to the init state.
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
std::list< ZONE * > GetZoneList(bool aIncludeZonesInFootprints=false) const
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,...
bool ResolveTextVar(wxString *token, int aDepth) const
const std::vector< PAD * > GetPads() const
Return a reference to a list of all the pads.
void Move(const VECTOR2I &aMoveVector) override
Move this object.
TITLE_BLOCK & GetTitleBlock()
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
FOOTPRINTS & Footprints()
PCB_LAYER_ID GetLayerID(const wxString &aLayerName) const
Return the ID of a layer.
HIGH_LIGHT_INFO m_highLightPrevious
LSET m_LegacyVisibleLayers
Visibility settings stored in board prior to 6.0, only used for loading legacy files.
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
GroupLegalOpsField GroupLegalOps(const PCB_SELECTION &selection) const
Check which selection tool group operations are legal given the selection.
int GetCopperLayerCount() const
std::vector< BOARD_LISTENER * > m_listeners
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsCourtyardCache
void IncrementTimeStamp()
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsFCourtyardCache
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
int m_DRCMaxPhysicalClearance
GROUPS & Groups()
The groups must maintain the following invariants.
FOOTPRINT * FindFootprintByPath(const KIID_PATH &aPath) const
Search for a FOOTPRINT within this board with the given path.
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.
std::unordered_map< wxString, LSET > m_LayerExpressionCache
wxString GroupsSanityCheckInternal(bool repair)
wxString ConvertCrossReferencesToKIIDs(const wxString &aSource) const
Convert cross-references back and forth between ${refDes:field} and ${kiid:field}.
wxString GetClass() const override
Return the class name.
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
bool m_LegacyNetclassesLoaded
True if netclasses were loaded from the file.
void SetCopperLayerCount(int aCount)
std::unordered_map< const ZONE *, BOX2I > m_ZoneBBoxCache
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsBCourtyardCache
TRACKS TracksInNet(int aNetCode)
Collect all the TRACKs and VIAs that are members of a net given by aNetCode.
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
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.
std::vector< PCB_MARKER * > ResolveDRCExclusions(bool aCreateMarkers)
Rebuild DRC markers from the serialized data in BOARD_DESIGN_SETTINGS.
FOOTPRINT * FindFootprintByReference(const wxString &aReference) const
Search for a FOOTPRINT within this board with the given reference designator.
unsigned GetNodesCount(int aNet=-1) const
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
std::shared_ptr< DRC_RTREE > m_CopperItemRTreeCache
bool SetLayerType(PCB_LAYER_ID aLayer, LAYER_T aLayerType)
Change the type of the layer given by aLayer.
int GetOutlinesChainingEpsilon()
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,...
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
std::unordered_map< ZONE *, std::unique_ptr< DRC_RTREE > > m_CopperZoneRTreeCache
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.
int LayerDepth(PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) const
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
PROJECT * GetProject() const
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.
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.
wxString GroupsSanityCheck(bool repair=false)
Consistency check of internal m_groups structure.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
std::vector< ZONE * > m_DRCZones
PAD * GetPad(const VECTOR2I &aPosition, LSET aLayerMask) const
Find a pad aPosition on aLayer.
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
wxString ConvertKIIDsToCrossReferences(const wxString &aSource) const
void SynchronizeProperties()
Copy the current project's text variables into the boards property cache.
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
void DeleteMARKERs()
Delete all MARKERS from the board.
void Remove(BOARD_ITEM *aBoardItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
Removes an item from the container.
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_IntersectsAreaCache
void HighLightON(bool aValue=true)
Enable or disable net highlighting.
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.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
VECTOR2I GetPosition() const override
void CacheTriangulation(PROGRESS_REPORTER *aReporter=nullptr, const std::vector< ZONE * > &aZones={})
void SetVisibleElements(const GAL_SET &aMask)
A proxy function that calls the correspondent function in m_BoardSettings.
coord_type GetHeight() const
coord_type GetWidth() const
BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
CN_EDGE represents a point-to-point connection, whether realized or unrealized (ie: tracks etc.
std::shared_ptr< const CN_ANCHOR > GetSourceNode() const
void SetVisible(bool aVisible)
std::shared_ptr< const CN_ANCHOR > GetTargetNode() const
static DELETED_BOARD_ITEM * GetInstance()
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
virtual VECTOR2I GetPosition() const
void SetFlags(EDA_ITEM_FLAGS aMask)
KICAD_T Type() const
Returns the type of object.
virtual INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
May be re-implemented for each derived class in order to handle all the types given by its member dat...
virtual void SetParent(EDA_ITEM *aParent)
EDA_ITEM_FLAGS GetFlags() const
int Compare(const EDA_SHAPE *aOther) const
Helper for storing and iterating over GAL_LAYER_IDs.
static const std::vector< KICAD_T > BoardLevelItems
A scan list for all primary board items, omitting items which are subordinate to a FOOTPRINT,...
static const std::vector< KICAD_T > Tracks
A scan list for only TRACKs and ARCs.
std::set< int > m_netCodes
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
LSET is a set of PCB_LAYER_IDs.
static LSET AllLayersMask()
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
std::shared_ptr< RC_ITEM > GetRCItem() const
void SetExcluded(bool aExcluded)
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)
static const char Default[]
the name of the default NETCLASS
Handle the data for a net.
void SetNetCode(int aNetCode)
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
static const int ORPHANED
Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) whe...
static NETINFO_ITEM * OrphanedItem()
NETINFO_ITEM meaning that there was no net assigned for an item, as there was no board storing net li...
unsigned GetNetCount() const
void RemoveNet(NETINFO_ITEM *aNet)
Remove a net from the net list.
NETINFO_ITEM * GetNetItem(int aNetCode) const
void AppendNet(NETINFO_ITEM *aNewElement)
Add aNewElement to the end of the net list.
VECTOR2I GetPosition() const override
Describe the page size and margins of a paper page on which to eventually print or plot.
DIM_UNITS_MODE GetUnitsMode() const
A set of BOARD_ITEMs (i.e., without duplicates).
bool RemoveItem(BOARD_ITEM *aItem)
Remove item from group.
static PCB_MARKER * Deserialize(const wxString &data)
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the shape to a closed polygon.
void TransformTextToPolySet(SHAPE_POLY_SET &aBuffer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc) const
Function TransformTextToPolySet Convert the text to a polygonSet describing the actual character stro...
const VECTOR2I & GetEndPoint(ENDPOINT_T aEndPoint) const
Return the selected endpoint (start or end)
bool m_Printing
wxWidgets on MSW tends to crash if you spool up more than one print job at a time.
A holder to handle information on schematic or board items.
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
A progress reporter interface for use in multi-threaded environments.
virtual bool IsCancelled() const =0
virtual bool KeepRefreshing(bool aWait=false)=0
Update the UI (if any).
virtual void Report(const wxString &aMessage)=0
Display aMessage in the progress bar dialog.
virtual void AdvanceProgress()=0
Increment the progress bar length (inside the current virtual zone).
The backing store for a PROJECT, in JSON format.
LSET m_VisibleLayers
Board settings.
GAL_SET m_VisibleItems
The GAL layers (aka items) that are turned on for viewing (.
Container for project specific data.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
virtual bool TextVarResolver(wxString *aToken) const
virtual PROJECT_FILE & GetProjectFile() const
virtual std::map< wxString, wxString > & GetTextVars() const
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
int Length() const
Return the length (this).
Represent a set of closed polygons.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)
void Simplify(POLYGON_MODE aFastMode)
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections) For aFastMo...
int NewOutline()
Creates a new empty polygon in the set and returns its index.
bool TextVarResolver(wxString *aToken, const PROJECT *aProject) const
static void GetContextualTextVars(wxArrayString *aVars)
ZONE_SETTINGS handles zones parameters.
Handle a list of polygons defining a copper zone.
void SetMinThickness(int aMinThickness)
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
SHAPE_POLY_SET * Outline()
void SetHatchStyle(ZONE_BORDER_DISPLAY_STYLE aStyle)
void SetLayerSet(LSET aLayerSet) override
bool AppendCorner(VECTOR2I aPosition, int aHoleIdx, bool aAllowDuplication=false)
Add a new corner to the zone outline (to the main outline or a hole)
bool BuildBoardPolygonOutlines(BOARD *aBoard, SHAPE_POLY_SET &aOutlines, int aErrorMax, int aChainingEpsilon, OUTLINE_ERROR_HANDLER *aErrorHandler, bool aAllowUseArcsInPolygons)
Extracts the board outlines and build a closed polygon from lines, arcs and circle items on edge cut ...
const std::function< void(const wxString &msg, BOARD_ITEM *itemA, BOARD_ITEM *itemB, const VECTOR2I &pt)> OUTLINE_ERROR_HANDLER
PGM_BASE * PgmOrNull()
similar to PGM_BASE& Pgm(), but return a reference that can be nullptr when running a shared lib from...
const INSPECTOR_FUNC & INSPECTOR
std::function< INSPECT_RESULT(EDA_ITEM *aItem, void *aTestData) > INSPECTOR_FUNC
Used to inspect and possibly collect the (search) results of iterating over a list or tree of KICAD_T...
#define STRUCT_DELETED
flag indication structures to be erased
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
@ LAYER_MOD_TEXT_INVISIBLE
text marked as invisible
@ GAL_LAYER_ID_BITMASK_END
This is the end of the layers used for visibility bit masks in legacy board files.
@ LAYER_MOD_FR
show footprints on front
@ LAYER_MOD_BK
show footprints on back
PCB_LAYER_ID
A quick note on layer IDs:
#define GAL_LAYER_INDEX(x)
Use this macro to convert a GAL layer to a 0-indexed offset from LAYER_VIAS.
PCB_LAYER_ID ToLAYER_ID(int aLayer)
void delete_matching(_Container &__c, _Value __value)
Covers for the horrifically named std::remove and std::remove_if (neither of which remove anything).
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Class to handle a set of BOARD_ITEMs.
Class that computes missing connections on a PCB.
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
constexpr int mmToIU(double mm) const
Container to hold information pertinent to a layer of a BOARD.
static LAYER_T ParseType(const char *aType)
Convert a string to a LAYER_T.
LAYER_T m_type
The type of the layer.
static const char * ShowType(LAYER_T aType)
Convert a LAYER_T enum to a string representation of the layer type.
wxString m_name
The canonical name of the layer.
wxString m_userName
The user defined name of the layer.
thread_pool & GetKiCadThreadPool()
Get a reference to the current thread pool.
BS::thread_pool thread_pool
double EuclideanNorm(const VECTOR2I &vector)
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
@ PCB_ZONE_T
class ZONE, a copper pour area
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
@ PCB_MARKER_T
class PCB_MARKER, a marker used to show something
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
@ PCB_BITMAP_T
class PCB_BITMAP, bitmap on a layer
@ PCB_PAD_T
class PAD, a pad in a footprint
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.