77 m_LegacyDesignSettingsLoaded( false ),
78 m_LegacyCopperEdgeClearanceLoaded( false ),
79 m_LegacyNetclassesLoaded( false ),
118 int infinity = ( std::numeric_limits<int>::max() / 2 ) -
pcbIUScale.
mmToIU( 1 );
131 _(
"This is the default net class." ) );
150 item->SetParentGroup(
nullptr );
155 for(
BOARD_ITEM* item : generator->GetItems() )
156 item->SetParentGroup(
nullptr );
176 ownedItems.insert( g );
204 if( aProject && !aReferenceOnly )
221 std::shared_ptr<NET_SETTINGS>& projectSettings =
project.NetSettings();
223 projectSettings->SetDefaultNetclass( legacySettings->GetDefaultNetclass() );
224 projectSettings->SetNetclasses( legacySettings->GetNetclasses() );
225 projectSettings->SetNetclassPatternAssignments(
226 std::move( legacySettings->GetNetclassPatternAssignments() ) );
246 project.m_BoardSettings =
nullptr;
269 std::unique_lock<std::shared_mutex> writeLock(
m_CachesMutex );
298 std::set<std::pair<KIID, KIID>> m_ratsnestExclusions;
304 const std::shared_ptr<RC_ITEM>& rcItem = marker->GetRCItem();
305 m_ratsnestExclusions.emplace( rcItem->GetMainItemID(), rcItem->GetAuxItemID() );
306 m_ratsnestExclusions.emplace( rcItem->GetAuxItemID(), rcItem->GetMainItemID() );
316 std::pair<KIID, KIID> ids = { aEdge.GetSourceNode()->Parent()->m_Uuid,
317 aEdge.GetTargetNode()->Parent()->m_Uuid };
319 aEdge.
SetVisible( m_ratsnestExclusions.count( ids ) == 0 );
334 if( marker->IsExcluded() )
336 wxString serialized = marker->SerializeToString();
338 m_designSettings->m_DrcExclusionComments[ serialized ] = marker->GetComment();
347 std::map<wxString, wxString> comments =
m_designSettings->m_DrcExclusionComments;
354 wxString serialized = marker->SerializeToString();
355 std::set<wxString>::iterator it = exclusions.find( serialized );
357 if( it != exclusions.end() )
359 marker->SetExcluded(
true, comments[ serialized ] );
363 m_designSettings->m_DrcExclusionComments[ serialized ] = comments[ serialized ];
365 exclusions.erase( it );
369 std::vector<PCB_MARKER*> newMarkers;
373 for(
const wxString& serialized : exclusions )
393 marker->
SetExcluded(
true, comments[ serialized ] );
394 newMarkers.push_back( marker );
398 m_designSettings->m_DrcExclusionComments[ serialized ] = comments[ serialized ];
410 [&](
const wxString& aVar )
413 aVars->push_back( aVar );
416 add( wxT(
"LAYER" ) );
417 add( wxT(
"FILENAME" ) );
418 add( wxT(
"FILEPATH" ) );
419 add( wxT(
"PROJECTNAME" ) );
420 add( wxT(
"DRC_ERROR <message_text>" ) );
421 add( wxT(
"DRC_WARNING <message_text>" ) );
435 if( token->Contains(
':' ) )
438 wxString ref = token->BeforeFirst(
':', &remainder );
453 if( token->IsSameAs( wxT(
"FILENAME" ) ) )
456 *token = fn.GetFullName();
459 else if( token->IsSameAs( wxT(
"FILEPATH" ) ) )
462 *token = fn.GetFullPath();
465 else if( token->IsSameAs( wxT(
"PROJECTNAME" ) ) &&
GetProject() )
471 wxString var = *token;
498 wxLogWarning( wxT(
"This should not be called on the BOARD object") );
505 [&] (
EDA_ITEM* item,
void* testData )
514 board_item->
Move( aMoveVector );
517 return INSPECT_RESULT::CONTINUE;
540 aFunction( footprint );
541 footprint->RunOnDescendants( aFunction, aDepth + 1 );
547 group->RunOnDescendants( aFunction, aDepth + 1 );
552 aFunction( drawing );
553 drawing->RunOnDescendants( aFunction, aDepth + 1 );
556 catch( std::bad_function_call& )
558 wxFAIL_MSG( wxT(
"Error running BOARD::RunOnDescendants" ) );
574 return INSPECT_RESULT::CONTINUE;
596 for(
auto& [ layer_id, layer ] :
m_layers )
598 if( layer.m_name == aLayerName || layer.m_userName == aLayerName )
623 if( it !=
m_layers.end() && !it->second.m_userName.IsEmpty() )
624 return it->second.m_userName;
633 if( !aLayerName.IsEmpty() )
636 if( aLayerName.Find( wxChar(
'"' ) ) != wxNOT_FOUND )
641 m_layers[aLayer].m_userName = aLayerName;
658 return it->second.m_type;
674 m_layers[aLayer].m_type = aLayerType;
692 case LT_AUX:
return "auxiliary";
701 if( strcmp( aType,
"signal" ) == 0 )
return LT_SIGNAL;
702 else if( strcmp( aType,
"power" ) == 0 )
return LT_POWER;
703 else if( strcmp( aType,
"mixed" ) == 0 )
return LT_MIXED;
704 else if( strcmp( aType,
"jumper" ) == 0 )
return LT_JUMPER;
705 else if( strcmp( aType,
"auxiliary" ) == 0 )
return LT_AUX;
706 else if( strcmp( aType,
"front" ) == 0 )
return LT_FRONT;
707 else if( strcmp( aType,
"back" ) == 0 )
return LT_BACK;
714 for(
int layer =
F_Cu; layer <
User_9; ++layer )
720 if(
m_layers[layer].m_opposite != layer )
726 wxString principalName =
m_layers[layer].m_userName.AfterFirst(
'.' );
739 wxString candidate =
m_layers[ii].m_userName.AfterFirst(
'.' );
741 if( !candidate.IsEmpty() && candidate == principalName )
753 int next = layer + 1;
807 if( aStartLayer > aEndLayer )
808 std::swap( aStartLayer, aEndLayer );
810 if( aEndLayer ==
B_Cu )
813 return aEndLayer - aStartLayer;
861 for(
size_t i = 0; i < aSet.size(); i++ )
902 track->SetLocalRatsnestVisible( isEnabled );
906 for(
PAD*
pad : footprint->Pads() )
907 pad->SetLocalRatsnestVisible( isEnabled );
911 zone->SetLocalRatsnestVisible( isEnabled );
928 default: wxFAIL_MSG( wxT(
"BOARD::IsModuleLayerVisible(): bad layer" ) );
return true;
944 std::unique_lock<std::shared_mutex> writeLock(
m_CachesMutex );
949 worstClearance = std::max( worstClearance, zone->GetLocalClearance().value() );
953 for(
PAD*
pad : footprint->Pads() )
955 std::optional<int>
override =
pad->GetClearanceOverrides(
nullptr );
957 if(
override.has_value() )
958 worstClearance = std::max( worstClearance,
override.value() );
961 for(
ZONE* zone : footprint->Zones() )
962 worstClearance = std::max( worstClearance, zone->GetLocalClearance().value() );
974 std::vector<ZONE*> zones = aZones;
983 aReporter->
Report(
_(
"Tessellating copper zones..." ) );
986 std::vector<std::future<size_t>> returns;
988 returns.reserve( zones.size() );
990 auto cache_zones = [aReporter](
ZONE* aZone ) ->
size_t
995 aZone->CacheTriangulation();
1003 for(
ZONE* zone : zones )
1004 returns.emplace_back(
tp.submit( cache_zones, zone ) );
1007 for(
const std::future<size_t>& ret : returns )
1009 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
1011 while( status != std::future_status::ready )
1016 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
1026 for(
auto& [filename, embeddedFile] : footprint->EmbeddedFileMap() )
1034 embeddedFile->data_hash = file->
data_hash;
1035 embeddedFile->is_valid = file->
is_valid;
1044 if( aBoardItem ==
nullptr )
1046 wxFAIL_MSG( wxT(
"BOARD::Add() param error: aBoardItem nullptr" ) );
1052 switch( aBoardItem->
Type() )
1085 wxFAIL_MSG( wxT(
"BOARD::Add() Cannot place Track on non-copper layer" ) );
1089 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
1100 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
1125 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
1148 wxFAIL_MSG( wxString::Format( wxT(
"BOARD::Add() item type %s not handled" ),
1156 if( !aSkipConnectivity )
1159 if( aMode != ADD_MODE::BULK_INSERT && aMode != ADD_MODE::BULK_APPEND )
1179 wxASSERT( aBoardItem );
1183 switch( aBoardItem->
Type() )
1192 if( boardItem->GetNet() == netItem )
1193 boardItem->SetNet( unconnected );
1269 wxFAIL_MSG( wxString::Format( wxT(
"BOARD::Remove() item type %s not handled" ),
1282 if( aRemoveMode != REMOVE_MODE::BULK )
1289 std::vector<BOARD_ITEM*> removed;
1291 for(
const KICAD_T& type : aTypes )
1297 removed.emplace_back( item );
1308 std::copy(
m_groups.begin(),
m_groups.end(), std::back_inserter( removed ) );
1313 std::copy(
m_zones.begin(),
m_zones.end(), std::back_inserter( removed ) );
1328 std::copy(
m_tracks.begin(),
m_tracks.end(), std::back_inserter( removed ) );
1334 wxFAIL_MSG( wxT(
"Use PCB_TRACE_T to remove all tracks, arcs, and vias" ) );
1353 wxFAIL_MSG( wxT(
"Use PCB_SHAPE_T to remove all graphics and text" ) );
1357 wxFAIL_MSG( wxT(
"BOARD::RemoveAll() needs more ::Type() support" ) );
1370 return wxString::Format(
_(
"PCB" ) );
1377 [&](
EDA_ITEM* descendant,
void* aTestData )
1381 if( dimension->
GetUnitsMode() == DIM_UNITS_MODE::AUTOMATIC )
1386 aView->
Update( dimension );
1389 return INSPECT_RESULT::CONTINUE;
1430 remaining.push_back( marker );
1461 if( track->m_Uuid == aID )
1467 if( footprint->m_Uuid == aID )
1470 for(
PAD*
pad : footprint->Pads() )
1472 if(
pad->m_Uuid == aID )
1476 for(
PCB_FIELD* field : footprint->GetFields() )
1478 if( field && field->m_Uuid == aID )
1482 for(
BOARD_ITEM* drawing : footprint->GraphicalItems() )
1484 if( drawing->m_Uuid == aID )
1490 if( zone->m_Uuid == aID )
1496 if(
group->m_Uuid == aID )
1503 if( zone->m_Uuid == aID )
1513 if( cell->m_Uuid == aID )
1518 if( drawing->m_Uuid == aID )
1524 if( marker->m_Uuid == aID )
1530 if(
group->m_Uuid == aID )
1536 if( generator->m_Uuid == aID )
1543 if( netInfo->m_Uuid == aID )
1548 return const_cast<BOARD*
>( this );
1561 aMap[ track->m_Uuid ] = track;
1565 aMap[ footprint->m_Uuid ] = footprint;
1567 for(
PAD*
pad : footprint->Pads() )
1568 aMap[
pad->m_Uuid ] =
pad;
1570 aMap[ footprint->Reference().m_Uuid ] = &footprint->Reference();
1571 aMap[ footprint->Value().m_Uuid ] = &footprint->Value();
1573 for(
BOARD_ITEM* drawing : footprint->GraphicalItems() )
1574 aMap[ drawing->m_Uuid ] = drawing;
1578 aMap[ zone->m_Uuid ] = zone;
1581 aMap[ drawing->m_Uuid ] = drawing;
1584 aMap[ marker->m_Uuid ] = marker;
1590 aMap[ generator->m_Uuid ] = generator;
1597 size_t sourceLen = aSource.length();
1599 for(
size_t i = 0; i < sourceLen; ++i )
1601 if( aSource[i] ==
'$' && i + 1 < sourceLen && aSource[i+1] ==
'{' )
1604 bool isCrossRef =
false;
1606 for( i = i + 2; i < sourceLen; ++i )
1608 if( aSource[i] ==
'}' )
1611 if( aSource[i] ==
':' )
1614 token.append( aSource[i] );
1620 wxString ref = token.BeforeFirst(
':', &remainder );
1624 if( footprint->GetReference().CmpNoCase( ref ) == 0 )
1626 wxString
test( remainder );
1628 if( footprint->ResolveTextVar( &
test ) )
1629 token = footprint->m_Uuid.AsString() + wxT(
":" ) + remainder;
1636 newbuf.append( wxT(
"${" ) + token + wxT(
"}" ) );
1640 newbuf.append( aSource[i] );
1651 size_t sourceLen = aSource.length();
1653 for(
size_t i = 0; i < sourceLen; ++i )
1655 if( aSource[i] ==
'$' && i + 1 < sourceLen && aSource[i+1] ==
'{' )
1658 bool isCrossRef =
false;
1660 for( i = i + 2; i < sourceLen; ++i )
1662 if( aSource[i] ==
'}' )
1665 if( aSource[i] ==
':' )
1668 token.append( aSource[i] );
1674 wxString ref = token.BeforeFirst(
':', &remainder );
1679 token =
static_cast<FOOTPRINT*
>( refItem )->GetReference() + wxT(
":" )
1684 newbuf.append( wxT(
"${" ) + token + wxT(
"}" ) );
1688 newbuf.append( aSource[i] );
1698 unsigned retval = 0;
1702 for(
PAD*
pad : footprint->Pads() )
1704 if( ( aNet == -1 &&
pad->GetNetCode() > 0 ) || aNet ==
pad->GetNetCode() )
1723 if( aBoardEdgesOnly )
1732 if( ( item->GetLayerSet() & visible ).any() )
1733 bbox.
Merge( item->GetBoundingBox() );
1739 if( aBoardEdgesOnly )
1741 for(
const BOARD_ITEM* edge : footprint->GraphicalItems() )
1744 bbox.
Merge( edge->GetBoundingBox() );
1747 else if( ( footprint->GetLayerSet() & visible ).any() )
1749 bbox.
Merge( footprint->GetBoundingBox(
true ) );
1753 if( !aBoardEdgesOnly )
1758 if( ( track->GetLayerSet() & visible ).any() )
1759 bbox.
Merge( track->GetBoundingBox() );
1765 if( ( aZone->GetLayerSet() & visible ).any() )
1766 bbox.
Merge( aZone->GetBoundingBox() );
1778 int trackSegmentCount = 0;
1779 std::set<int> netCodes;
1787 trackSegmentCount++;
1789 if( item->GetNetCode() > 0 )
1790 netCodes.insert( item->GetNetCode() );
1795 for(
PAD*
pad : footprint->Pads() )
1799 if(
pad->GetNetCode() > 0 )
1800 netCodes.insert(
pad->GetNetCode() );
1804 aList.emplace_back(
_(
"Pads" ), wxString::Format( wxT(
"%d" ), padCount ) );
1805 aList.emplace_back(
_(
"Vias" ), wxString::Format( wxT(
"%d" ), viaCount ) );
1806 aList.emplace_back(
_(
"Track Segments" ), wxString::Format( wxT(
"%d" ), trackSegmentCount ) );
1807 aList.emplace_back(
_(
"Nets" ), wxString::Format( wxT(
"%d" ), (
int) netCodes.size() ) );
1808 aList.emplace_back(
_(
"Unrouted" ), wxString::Format( wxT(
"%d" ), unconnected ) );
1813 const std::vector<KICAD_T>& scanTypes )
1815#if 0 && defined(DEBUG)
1816 std::cout <<
GetClass().mb_str() <<
' ';
1819 bool footprintsScanned =
false;
1820 bool drawingsScanned =
false;
1821 bool tracksScanned =
false;
1823 for(
KICAD_T scanType : scanTypes )
1828 if( inspector(
this, testData ) == INSPECT_RESULT::QUIT )
1829 return INSPECT_RESULT::QUIT;
1854 if( !footprintsScanned )
1856 if( IterateForward<FOOTPRINT*>(
m_footprints, inspector, testData, scanTypes )
1857 == INSPECT_RESULT::QUIT )
1859 return INSPECT_RESULT::QUIT;
1862 footprintsScanned =
true;
1865 if( !drawingsScanned )
1867 if( IterateForward<BOARD_ITEM*>(
m_drawings, inspector, testData, scanTypes )
1868 == INSPECT_RESULT::QUIT )
1870 return INSPECT_RESULT::QUIT;
1873 drawingsScanned =
true;
1881 if( !tracksScanned )
1883 if( IterateForward<PCB_TRACK*>(
m_tracks, inspector, testData, scanTypes )
1884 == INSPECT_RESULT::QUIT )
1886 return INSPECT_RESULT::QUIT;
1889 tracksScanned =
true;
1897 if( marker->Visit( inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
1898 return INSPECT_RESULT::QUIT;
1904 if( !footprintsScanned )
1906 if( IterateForward<FOOTPRINT*>(
m_footprints, inspector, testData, scanTypes )
1907 == INSPECT_RESULT::QUIT )
1909 return INSPECT_RESULT::QUIT;
1912 footprintsScanned =
true;
1917 if( zone->Visit( inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
1918 return INSPECT_RESULT::QUIT;
1924 if( !footprintsScanned )
1926 if( IterateForward<FOOTPRINT*>(
m_footprints, inspector, testData, scanTypes )
1927 == INSPECT_RESULT::QUIT )
1929 return INSPECT_RESULT::QUIT;
1932 footprintsScanned =
true;
1935 if( IterateForward<PCB_GENERATOR*>(
m_generators, inspector, testData, { scanType } )
1936 == INSPECT_RESULT::QUIT )
1938 return INSPECT_RESULT::QUIT;
1944 if( IterateForward<PCB_GROUP*>(
m_groups, inspector, testData, { scanType } )
1945 == INSPECT_RESULT::QUIT )
1947 return INSPECT_RESULT::QUIT;
1957 return INSPECT_RESULT::CONTINUE;
1987 for(
auto it = aNetName.rbegin(); it != aNetName.rend() && rv == 0; ++it, ++count )
1991 if( ( ch >=
'0' && ch <=
'9' ) || ch ==
'_' )
1995 else if( ch ==
'+' )
1997 aComplementNet = wxT(
"-" );
2000 else if( ch ==
'-' )
2002 aComplementNet = wxT(
"+" );
2005 else if( ch ==
'N' )
2007 aComplementNet = wxT(
"P" );
2010 else if ( ch ==
'P' )
2012 aComplementNet = wxT(
"N" );
2021 if( rv != 0 && count >= 1 )
2023 aComplementNet = aNetName.Left( aNetName.length() - count )
2025 + aNetName.Right( count - 1 );
2037 wxString coupledNetName;
2040 return FindNet( coupledNetName );
2051 if( aReference == footprint->GetReference() )
2063 if( footprint->GetPath() == aPath )
2073 std::set<wxString> names;
2077 if( !net->GetNetname().IsEmpty() )
2078 names.insert( net->GetNetname() );
2100 const std::shared_ptr<NETCLASS>& defaultNetClass = bds.
m_NetSettings->GetDefaultNetclass();
2105 net->SetNetClass( bds.
m_NetSettings->GetEffectiveNetClass( net->GetNetname() ) );
2107 if( aResetTrackAndViaSizes )
2126 int error_count = 0;
2130 if( !zone->IsOnCopperLayer() )
2136 if( zone->GetNetCode() != 0 )
2149 zone->SetNetCode( -1 );
2160 if( !aLayerSet.any() )
2167 if( footprint->HitTest( aPosition ) )
2168 pad = footprint->GetPad( aPosition, aLayerSet );
2184 return GetPad( aPosition, lset );
2192 for(
PAD*
pad : footprint->Pads() )
2194 if(
pad->GetPosition() != aPosition )
2198 if( (
pad->GetLayerSet() & aLayerSet ).any() )
2211 int idxmax = aPadList.size() - 1;
2213 int delta = aPadList.size();
2226 PAD*
pad = aPadList[idx];
2228 if(
pad->GetPosition() == aPosition )
2231 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
2238 for(
int ii = idx+1; ii <= idxmax; ii++ )
2242 if(
pad->GetPosition() != aPosition )
2245 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
2249 for(
int ii = idx - 1 ;ii >=0; ii-- )
2253 if(
pad->GetPosition() != aPosition )
2256 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
2264 if(
pad->GetPosition().x == aPosition.
x )
2266 if(
pad->GetPosition().y < aPosition.
y )
2281 else if(
pad->GetPosition().x < aPosition.
x )
2319 for(
PAD*
pad : footprint->Pads( ) )
2321 if( aNetCode < 0 || pad->GetNetCode() == aNetCode )
2322 aVector.push_back(
pad );
2344 double length = 0.0;
2345 double package_length = 0.0;
2362 if( track->Type() ==
PCB_VIA_T && useHeight )
2372 length += track->GetLength();
2377 SEG trackSeg( track->GetStart(), track->GetEnd() );
2378 double segLen = trackSeg.
Length();
2379 double segInPadLen = 0;
2381 for(
auto pad_it : connectivity->GetConnectedPads( item ) )
2385 bool hitStart =
pad->HitTest( track->GetStart(), track->GetWidth() / 2 );
2386 bool hitEnd =
pad->HitTest( track->GetEnd(), track->GetWidth() / 2 );
2388 if( hitStart && hitEnd )
2393 else if( hitStart || hitEnd )
2398 if(
pad->GetEffectivePolygon( track->GetLayer(),
ERROR_INSIDE )->Collide( trackSeg, 0,
nullptr, &loc ) )
2406 segLen = trackSeg.
Length();
2409 segInPadLen += ( loc -
pad->GetPosition() ).EuclideanNorm();
2415 length += segLen + segInPadLen;
2417 else if(
PAD*
pad =
dynamic_cast<PAD*
>( item ) )
2419 package_length +=
pad->GetPadToDieLength();
2423 return std::make_tuple( count, length, package_length );
2428 bool aVisibleOnly,
bool aIgnoreLocked )
const
2432 int min_dim = 0x7FFFFFFF;
2433 int alt_min_dim = 0x7FFFFFFF;
2434 bool current_layer_back =
IsBackLayer( aActiveLayer );
2439 if( !candidate->HitTest( aPosition ) )
2443 if( aIgnoreLocked && candidate->IsLocked() )
2451 BOX2I bb = candidate->GetBoundingBox(
false );
2457 int dist = ( aPosition.
x - offx ) * ( aPosition.
x - offx ) +
2458 ( aPosition.
y - offy ) * ( aPosition.
y - offy );
2462 if( dist <= min_dim )
2465 footprint = candidate;
2471 if( dist <= alt_min_dim )
2474 alt_footprint = candidate;
2485 return alt_footprint;
2493 std::list<ZONE*> zones;
2496 zones.push_back( zone );
2498 if( aIncludeZonesInFootprints )
2502 for(
ZONE* zone : footprint->Zones() )
2503 zones.push_back( zone );
2519 m_zones.push_back( new_area );
2528 ITEM_PICKER picker(
nullptr, new_area, UNDO_REDO::NEWITEM );
2538 bool aAllowUseArcsInPolygons,
2539 bool aIncludeNPTHAsOutlines )
2545 chainingEpsilon, aErrorHandler,
2546 aAllowUseArcsInPolygons );
2549 if( aIncludeNPTHAsOutlines )
2553 for(
PAD*
pad : fp->Pads() )
2555 if(
pad->GetAttribute () != PAD_ATTRIB::NPTH )
2573 aOutlines.
AddHole( pad_hole, jj );
2609 std::set<KIFONT::OUTLINE_FONT*>
fonts;
2623 if( outline->GetEmbeddingPermission() == EMBEDDING_PERMISSION::EDITABLE
2624 || outline->GetEmbeddingPermission() == EMBEDDING_PERMISSION::INSTALLABLE )
2626 fonts.insert( outline );
2649 std::vector<PAD*> allPads;
2653 for(
PAD*
pad : footprint->Pads() )
2654 allPads.push_back(
pad );
2663 std::vector<BOARD_CONNECTED_ITEM*> items;
2666 items.push_back( track );
2670 for(
PAD*
pad : footprint->Pads() )
2671 items.push_back(
pad );
2675 items.push_back( zone );
2680 items.push_back( bci );
2694 item->SetNet( netInfo );
2698 aDestBoard->
Add( newNet );
2699 item->SetNet( newNet );
2710 if(
FindNet( item->GetNetCode() ) ==
nullptr )
2754 std::vector<BOARD_ITEM*>& aRemovedItems,
2755 std::vector<BOARD_ITEM*>& aChangedItems )
2807 return wxEmptyString;
2826 std::unordered_set<PCB_GROUP*> knownCycleFreeGroups;
2828 std::unordered_set<PCB_GROUP*> currentChainGroups;
2830 std::unordered_set<PCB_GROUP*> toCheckGroups;
2834 toCheckGroups.insert(
group );
2837 toCheckGroups.insert( gen );
2839 while( !toCheckGroups.empty() )
2841 currentChainGroups.clear();
2846 if( currentChainGroups.find(
group ) != currentChainGroups.end() )
2851 return "Cycle detected in group membership";
2853 else if( knownCycleFreeGroups.find(
group ) != knownCycleFreeGroups.end() )
2859 currentChainGroups.insert(
group );
2861 toCheckGroups.erase(
group );
2874 knownCycleFreeGroups.insert( currentChainGroups.begin(), currentChainGroups.end() );
2884 bool hasGroup =
false;
2885 bool hasMember =
false;
2889 if( item->IsBOARD_ITEM() )
2935 if( aFirst->
Type() != aSecond->
Type() )
2936 return aFirst->
Type() < aSecond->
Type();
2945 return shape->
Compare( other );
2951 return text->Compare( other );
2958 return textbox->PCB_SHAPE::Compare( other ) && textbox->EDA_TEXT::Compare( other );
2980 if( !track->IsOnLayer( aLayer ) )
2983 track->TransformShapeToPolygon( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE );
2989 footprint->TransformPadsToPolySet( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE );
2991 footprint->TransformFPShapesToPolySet( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE,
2996 for(
const ZONE* zone : footprint->Zones() )
2998 if( zone->GetLayerSet().test( aLayer ) )
2999 zone->TransformSolidAreasShapesToPolygon( aLayer, aOutlines );
3006 if( zone->GetLayerSet().test( aLayer ) )
3007 zone->TransformSolidAreasShapesToPolygon( aLayer, aOutlines );
3013 if( !item->IsOnLayer( aLayer ) )
3016 switch( item->Type() )
3038 textbox->PCB_SHAPE::TransformShapeToPolygon( aOutlines, aLayer, 0, maxError,
3077 std::copy(
m_tracks.begin(),
m_tracks.end(), std::inserter( items, items.end() ) );
3078 std::copy(
m_zones.begin(),
m_zones.end(), std::inserter( items, items.end() ) );
3081 std::copy(
m_markers.begin(),
m_markers.end(), std::inserter( items, items.end() ) );
3082 std::copy(
m_groups.begin(),
m_groups.end(), std::inserter( items, items.end() ) );
3093 const BOARD& other =
static_cast<const BOARD&
>( aItem );
3104 for(
auto it1 = thisNetNames.begin(), it2 = otherNetNames.begin();
3105 it1 != thisNetNames.end() && it2 != otherNetNames.end(); ++it1, ++it2 )
3109 if( it1->first != it2->first )
3144 wxArrayString ourVars;
3147 wxArrayString otherVars;
3150 if( ourVars != otherVars )
@ NORMAL
Use all material properties from model file.
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 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.
std::set< BOARD_ITEM *, CompareByUuid > BOARD_ITEM_SET
Set of BOARD_ITEMs ordered by UUID.
BASE_SET & reset(size_t pos)
BASE_SET & set(size_t pos)
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.
int GetCopperLayerCount() const
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 OnBoardRatsnestChanged(BOARD &aBoard)
virtual void OnBoardCompositeUpdate(BOARD &aBoard, std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aDeletedItems)
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.
void BuildDefaultStackupList(const BOARD_DESIGN_SETTINGS *aSettings, int aActiveCopperLayersCount=0)
Create a default stackup, according to the current BOARD_DESIGN_SETTINGS settings.
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...
ZONE * m_SolderMaskBridges
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...
BOARD_STACKUP GetStackupOrDefault() const
std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool > m_EnclosedByAreaCache
std::map< ZONE *, std::map< PCB_LAYER_ID, ISOLATED_ISLANDS > > m_ZoneIsolatedIslandsMap
PCB_LAYER_ID GetCopperLayerStackMaxId() const
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...
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
EMBEDDED_FILES * GetEmbeddedFiles() override
int m_fileFormatVersionAtLoad
NETINFO_ITEM * DpCoupledNet(const NETINFO_ITEM *aNet)
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
std::vector< ZONE * > m_DRCCopperZones
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
void MapNets(BOARD *aDestBoard)
Map all nets in the given board to nets with the same name (if any) in the destination board.
GAL_SET m_LegacyVisibleItems
PAD * GetPadFast(const VECTOR2I &aPosition, LSET aLayerMask) const
Return pad found at aPosition on aLayerMask using the fast search method.
const GENERATORS & Generators() const
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.
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
const ZONES & Zones() const
void InvokeListeners(Func &&aFunc, Args &&... args)
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 GROUPS & Groups() const
The groups must maintain the following invariants.
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.
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
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...
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 MARKERS & Markers() const
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayer) 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).
void FixupEmbeddedData()
After loading a file from disk, the footprints do not yet contain the full data for their embedded fi...
int GetMaxClearanceValue() const
Returns the maximum clearance value for any object on the board.
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()
int MatchDpSuffix(const wxString &aNetName, wxString &aComplementNet)
Fetch the coupled netname for a given net.
std::unordered_map< PTR_PTR_CACHE_KEY, bool > m_IntersectsFCourtyardCache
const FOOTPRINTS & Footprints() const
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
std::set< KIFONT::OUTLINE_FONT * > GetFonts() const override
Get the list of all outline fonts used in the board.
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.
const BOARD_ITEM_SET GetItemSet()
const TRACKS & Tracks() const
int m_DRCMaxPhysicalClearance
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)
void OnRatsnestChanged()
Notify the board and its listeners that the ratsnest has been recomputed.
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.
const wxString & GetFileName() const
bool operator==(const BOARD_ITEM &aOther) const override
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.
std::map< int, LAYER > m_layers
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.
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction, int aDepth=0) const override
Invoke a function on all descendants.
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.
std::unordered_map< KIID, BOARD_ITEM * > m_itemByIdCache
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
std::shared_mutex m_CachesMutex
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
std::optional< int > m_maxClearanceValue
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.
void EmbedFonts() override
Finds all fonts used in the board and embeds them in the file if permissions allow.
const DRAWINGS & Drawings() const
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
constexpr coord_type GetY() const
constexpr size_type GetWidth() const
constexpr coord_type GetX() const
constexpr BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
constexpr size_type GetHeight() const
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
virtual void ClearEditFlags()
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)
virtual wxString GetClass() const =0
Return the class name.
EDA_ITEM_FLAGS GetFlags() const
int Compare(const EDA_SHAPE *aOther) const
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
EMBEDDED_FILE * GetEmbeddedFile(const wxString &aName) const
Returns the embedded file with the given name or nullptr if it does not exist.
EMBEDDED_FILE * AddFile(const wxFileName &aName, bool aOverwrite)
Load a file from disk and adds it to the collection.
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
FONT is an abstract base class for both outline and stroke fonts.
virtual bool IsStroke() const
Class OUTLINE_FONT implements outline font drawing.
bool IsBOARD_ITEM() const
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, const wxString &aComment=wxEmptyString)
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)
static const char Default[]
the name of the default NETCLASS
Handle the data for a net.
wxString GetClass() const override
Return the class name.
const wxString & GetNetname() const
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 clear()
Delete the list of nets (and free memory).
void AppendNet(NETINFO_ITEM *aNewElement)
Add aNewElement to the end of the net list.
const NETNAMES_MAP & NetsByName() const
Return the name map, at least for python.
VECTOR2I GetPosition() const override
Describe the page size and margins of a paper page on which to eventually print or plot.
const VECTOR2D & GetSizeMils() const
wxPrintOrientation GetWxOrientation() const
static double GetCustomHeightMils()
wxPaperSize GetPaperId() const
static double GetCustomWidthMils()
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=false) const override
Convert the item shape to a closed polygon.
DIM_UNITS_MODE GetUnitsMode() const
A set of BOARD_ITEMs (i.e., without duplicates).
virtual bool RemoveItem(BOARD_ITEM *aItem)
Remove item from group.
static PCB_MARKER * DeserializeFromString(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 TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=false) const override
Convert the item shape to a closed polygon.
static int Compare(const PCB_TABLE *aTable, const PCB_TABLE *aOther)
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction) const override
Invoke a function on all children.
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...
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)
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 const wxString GetProjectName() const
Return the short name of the project.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() 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).
bool PointInside(const VECTOR2I &aPt, int aAccuracy=0, bool aUseBBoxCache=false) const override
Check if point aP lies inside a closed shape.
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
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()
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections)
int AddHole(const SHAPE_LINE_CHAIN &aHole, int aOutline=-1)
Adds a new hole to the given outline (default: last) and returns its index.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
int NewOutline()
Creates a new empty polygon in the set and returns its index.
int OutlineCount() const
Return the number of outlines in the set.
const wxString & GetComment(int aIdx) const
static void GetContextualTextVars(wxArrayString *aVars)
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(const 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)
wxString GetTextVars(const wxString &aSource)
Returns any variables unexpanded, e.g.
bool BuildBoardPolygonOutlines(BOARD *aBoard, SHAPE_POLY_SET &aOutlines, int aErrorMax, int aChainingEpsilon, OUTLINE_ERROR_HANDLER *aErrorHandler, bool aAllowUseArcsInPolygons)
Extract the board outlines and build a closed polygon from lines, arcs and circle items on edge cut l...
const std::function< void(const wxString &msg, BOARD_ITEM *itemA, BOARD_ITEM *itemB, const VECTOR2I &pt)> OUTLINE_ERROR_HANDLER
const INSPECTOR_FUNC & INSPECTOR
std::function passed to nested users by ref, avoids copying std::function.
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)
Test whether a layer is a copper layer.
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
@ GAL_LAYER_ID_BITMASK_END
This is the end of the layers used for visibility bit masks in legacy board files.
@ LAYER_FOOTPRINTS_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
std::vector< char > decompressedData
std::string compressedEncodedData
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.
static const char * ShowType(LAYER_T aType)
Convert a LAYER_T enum to a string representation of the layer type.
thread_pool & GetKiCadThreadPool()
Get a reference to the current thread pool.
BS::thread_pool thread_pool
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_GENERATOR_T
class PCB_GENERATOR, generator on a layer
@ 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_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
@ PCB_MARKER_T
class PCB_MARKER, a marker used to show something
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
@ PCB_TABLECELL_T
class PCB_TABLECELL, PCB_TEXTBOX for use in tables
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
@ 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_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
@ 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
VECTOR2< int32_t > VECTOR2I
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.