75 m_LegacyDesignSettingsLoaded( false ),
76 m_LegacyCopperEdgeClearanceLoaded( false ),
77 m_LegacyNetclassesLoaded( false ),
108 int infinity = ( std::numeric_limits<int>::max() / 2 ) -
pcbIUScale.
mmToIU( 1 );
120 bds.
m_NetSettings->m_DefaultNetClass->SetDescription(
_(
"This is the default net class." ) );
139 item->SetParentGroup(
nullptr );
144 for(
BOARD_ITEM* item : generator->GetItems() )
145 item->SetParentGroup(
nullptr );
165 ownedItems.insert( g );
193 if( aProject && !aReferenceOnly )
210 std::shared_ptr<NET_SETTINGS>& projectSettings =
project.NetSettings();
212 projectSettings->m_DefaultNetClass = legacySettings->m_DefaultNetClass;
213 projectSettings->m_NetClasses = legacySettings->m_NetClasses;
214 projectSettings->m_NetClassPatternAssignments =
215 std::move( legacySettings->m_NetClassPatternAssignments );
216 projectSettings->m_NetClassPatternAssignmentCache.clear();
236 project.m_BoardSettings =
nullptr;
259 std::unique_lock<std::shared_mutex> writeLock(
m_CachesMutex );
288 std::set<std::pair<KIID, KIID>> m_ratsnestExclusions;
294 const std::shared_ptr<RC_ITEM>& rcItem = marker->GetRCItem();
295 m_ratsnestExclusions.emplace( rcItem->GetMainItemID(), rcItem->GetAuxItemID() );
296 m_ratsnestExclusions.emplace( rcItem->GetAuxItemID(), rcItem->GetMainItemID() );
306 std::pair<KIID, KIID> ids = { aEdge.GetSourceNode()->Parent()->m_Uuid,
307 aEdge.GetTargetNode()->Parent()->m_Uuid };
309 aEdge.
SetVisible( m_ratsnestExclusions.count( ids ) == 0 );
324 if( marker->IsExcluded() )
326 wxString serialized = marker->SerializeToString();
328 m_designSettings->m_DrcExclusionComments[ serialized ] = marker->GetComment();
337 std::map<wxString, wxString> comments =
m_designSettings->m_DrcExclusionComments;
344 wxString serialized = marker->SerializeToString();
345 std::set<wxString>::iterator it = exclusions.find( serialized );
347 if( it != exclusions.end() )
349 marker->SetExcluded(
true, comments[ serialized ] );
353 m_designSettings->m_DrcExclusionComments[ serialized ] = comments[ serialized ];
355 exclusions.erase( it );
359 std::vector<PCB_MARKER*> newMarkers;
363 for(
const wxString& serialized : exclusions )
383 marker->
SetExcluded(
true, comments[ serialized ] );
384 newMarkers.push_back( marker );
388 m_designSettings->m_DrcExclusionComments[ serialized ] = comments[ serialized ];
400 [&](
const wxString& aVar )
403 aVars->push_back( aVar );
406 add( wxT(
"LAYER" ) );
407 add( wxT(
"FILENAME" ) );
408 add( wxT(
"FILEPATH" ) );
409 add( wxT(
"PROJECTNAME" ) );
423 if( token->Contains(
':' ) )
426 wxString ref = token->BeforeFirst(
':', &remainder );
441 if( token->IsSameAs( wxT(
"FILENAME" ) ) )
444 *token = fn.GetFullName();
447 else if( token->IsSameAs( wxT(
"FILEPATH" ) ) )
450 *token = fn.GetFullPath();
453 else if( token->IsSameAs( wxT(
"PROJECTNAME" ) ) &&
GetProject() )
459 wxString var = *token;
486 wxLogWarning( wxT(
"This should not be called on the BOARD object") );
493 [&] (
EDA_ITEM* item,
void* testData )
499 if( !board_item->GetParentGroup() && !board_item->GetParentFootprint() )
500 board_item->Move( aMoveVector );
503 return INSPECT_RESULT::CONTINUE;
521 return INSPECT_RESULT::CONTINUE;
549 if (
m_layers[ layer ].m_name == aLayerName ||
m_layers[ layer ].m_userName == aLayerName )
572 if( !
m_layers[aLayer].m_userName.IsEmpty() )
582 wxCHECK( !aLayerName.IsEmpty(),
false );
585 if( aLayerName.Find( wxChar(
'"' ) ) != wxNOT_FOUND )
640 if( strcmp( aType,
"signal" ) == 0 )
642 else if( strcmp( aType,
"power" ) == 0 )
644 else if( strcmp( aType,
"mixed" ) == 0 )
646 else if( strcmp( aType,
"jumper" ) == 0 )
667 if( aStartLayer > aEndLayer )
668 std::swap( aStartLayer, aEndLayer );
670 if( aEndLayer ==
B_Cu )
673 return aEndLayer - aStartLayer;
721 for(
size_t i = 0; i < aSet.size(); i++ )
762 track->SetLocalRatsnestVisible( isEnabled );
766 for(
PAD*
pad : footprint->Pads() )
767 pad->SetLocalRatsnestVisible( isEnabled );
771 zone->SetLocalRatsnestVisible( isEnabled );
788 default: wxFAIL_MSG( wxT(
"BOARD::IsModuleLayerVisible(): bad layer" ) );
return true;
804 std::unique_lock<std::shared_mutex> writeLock(
m_CachesMutex );
809 worstClearance = std::max( worstClearance, zone->GetLocalClearance().value() );
813 for(
PAD*
pad : footprint->Pads() )
815 std::optional<int>
override =
pad->GetClearanceOverrides(
nullptr );
817 if(
override.has_value() )
818 worstClearance = std::max( worstClearance,
override.value() );
821 for(
ZONE* zone : footprint->Zones() )
822 worstClearance = std::max( worstClearance, zone->GetLocalClearance().value() );
834 std::vector<ZONE*> zones = aZones;
843 aReporter->
Report(
_(
"Tessellating copper zones..." ) );
846 std::vector<std::future<size_t>> returns;
848 returns.reserve( zones.size() );
850 auto cache_zones = [aReporter](
ZONE* aZone ) ->
size_t
855 aZone->CacheTriangulation();
863 for(
ZONE* zone : zones )
864 returns.emplace_back(
tp.submit( cache_zones, zone ) );
867 for(
const std::future<size_t>& ret : returns )
869 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
871 while( status != std::future_status::ready )
876 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
884 if( aBoardItem ==
nullptr )
886 wxFAIL_MSG( wxT(
"BOARD::Add() param error: aBoardItem nullptr" ) );
892 switch( aBoardItem->
Type() )
925 wxFAIL_MSG( wxT(
"BOARD::Add() Cannot place Track on non-copper layer" ) );
929 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
940 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
965 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
987 msg.Printf( wxT(
"BOARD::Add() needs work: BOARD_ITEM type (%d) not handled" ),
988 aBoardItem->
Type() );
998 if( !aSkipConnectivity )
1001 if( aMode != ADD_MODE::BULK_INSERT && aMode != ADD_MODE::BULK_APPEND )
1023 wxASSERT( aBoardItem );
1027 switch( aBoardItem->
Type() )
1036 if( boardItem->GetNet() == netItem )
1037 boardItem->SetNet( unconnected );
1109 wxFAIL_MSG( wxT(
"BOARD::Remove() needs more ::Type() support" ) );
1121 if( aRemoveMode != REMOVE_MODE::BULK )
1128 std::vector<BOARD_ITEM*> removed;
1130 for(
const KICAD_T& type : aTypes )
1136 removed.emplace_back( item );
1147 std::copy(
m_groups.begin(),
m_groups.end(), std::back_inserter( removed ) );
1152 std::copy(
m_zones.begin(),
m_zones.end(), std::back_inserter( removed ) );
1167 std::copy(
m_tracks.begin(),
m_tracks.end(), std::back_inserter( removed ) );
1173 wxFAIL_MSG( wxT(
"Use PCB_TRACE_T to remove all tracks, arcs, and vias" ) );
1192 wxFAIL_MSG( wxT(
"Use PCB_SHAPE_T to remove all graphics and text" ) );
1196 wxFAIL_MSG( wxT(
"BOARD::RemoveAll() needs more ::Type() support" ) );
1209 return wxString::Format(
_(
"PCB" ) );
1216 [&](
EDA_ITEM* descendant,
void* aTestData )
1220 if( dimension->
GetUnitsMode() == DIM_UNITS_MODE::AUTOMATIC )
1225 aView->
Update( dimension );
1228 return INSPECT_RESULT::CONTINUE;
1269 remaining.push_back( marker );
1300 if( track->m_Uuid == aID )
1306 if( footprint->m_Uuid == aID )
1309 for(
PAD*
pad : footprint->Pads() )
1311 if(
pad->m_Uuid == aID )
1315 for(
PCB_FIELD* field : footprint->Fields() )
1317 if( field->m_Uuid == aID )
1321 for(
BOARD_ITEM* drawing : footprint->GraphicalItems() )
1323 if( drawing->m_Uuid == aID )
1329 if( zone->m_Uuid == aID )
1335 if(
group->m_Uuid == aID )
1342 if( zone->m_Uuid == aID )
1352 if( cell->m_Uuid == aID )
1357 if( drawing->m_Uuid == aID )
1363 if( marker->m_Uuid == aID )
1369 if(
group->m_Uuid == aID )
1375 if( generator->m_Uuid == aID )
1382 if( netInfo->m_Uuid == aID )
1387 return const_cast<BOARD*
>( this );
1400 aMap[ track->m_Uuid ] = track;
1404 aMap[ footprint->m_Uuid ] = footprint;
1406 for(
PAD*
pad : footprint->Pads() )
1407 aMap[
pad->m_Uuid ] =
pad;
1409 aMap[ footprint->Reference().m_Uuid ] = &footprint->Reference();
1410 aMap[ footprint->Value().m_Uuid ] = &footprint->Value();
1412 for(
BOARD_ITEM* drawing : footprint->GraphicalItems() )
1413 aMap[ drawing->m_Uuid ] = drawing;
1417 aMap[ zone->m_Uuid ] = zone;
1420 aMap[ drawing->m_Uuid ] = drawing;
1423 aMap[ marker->m_Uuid ] = marker;
1429 aMap[ generator->m_Uuid ] = generator;
1436 size_t sourceLen = aSource.length();
1438 for(
size_t i = 0; i < sourceLen; ++i )
1440 if( aSource[i] ==
'$' && i + 1 < sourceLen && aSource[i+1] ==
'{' )
1443 bool isCrossRef =
false;
1445 for( i = i + 2; i < sourceLen; ++i )
1447 if( aSource[i] ==
'}' )
1450 if( aSource[i] ==
':' )
1453 token.append( aSource[i] );
1459 wxString ref = token.BeforeFirst(
':', &remainder );
1463 if( footprint->GetReference().CmpNoCase( ref ) == 0 )
1465 wxString
test( remainder );
1467 if( footprint->ResolveTextVar( &
test ) )
1468 token = footprint->m_Uuid.AsString() + wxT(
":" ) + remainder;
1475 newbuf.append( wxT(
"${" ) + token + wxT(
"}" ) );
1479 newbuf.append( aSource[i] );
1490 size_t sourceLen = aSource.length();
1492 for(
size_t i = 0; i < sourceLen; ++i )
1494 if( aSource[i] ==
'$' && i + 1 < sourceLen && aSource[i+1] ==
'{' )
1497 bool isCrossRef =
false;
1499 for( i = i + 2; i < sourceLen; ++i )
1501 if( aSource[i] ==
'}' )
1504 if( aSource[i] ==
':' )
1507 token.append( aSource[i] );
1513 wxString ref = token.BeforeFirst(
':', &remainder );
1518 token =
static_cast<FOOTPRINT*
>( refItem )->GetReference() + wxT(
":" )
1523 newbuf.append( wxT(
"${" ) + token + wxT(
"}" ) );
1527 newbuf.append( aSource[i] );
1537 unsigned retval = 0;
1541 for(
PAD*
pad : footprint->Pads() )
1543 if( ( aNet == -1 &&
pad->GetNetCode() > 0 ) || aNet ==
pad->GetNetCode() )
1562 if( aBoardEdgesOnly )
1571 if( ( item->GetLayerSet() & visible ).any() )
1572 bbox.
Merge( item->GetBoundingBox() );
1578 if( !( footprint->GetLayerSet() & visible ).any() )
1581 if( aBoardEdgesOnly )
1583 for(
const BOARD_ITEM* edge : footprint->GraphicalItems() )
1586 bbox.
Merge( edge->GetBoundingBox() );
1591 bbox.
Merge( footprint->GetBoundingBox(
true, aIncludeHiddenText ) );
1595 if( !aBoardEdgesOnly )
1600 if( ( track->GetLayerSet() & visible ).any() )
1601 bbox.
Merge( track->GetBoundingBox() );
1607 if( ( aZone->GetLayerSet() & visible ).any() )
1608 bbox.
Merge( aZone->GetBoundingBox() );
1620 int trackSegmentCount = 0;
1621 std::set<int> netCodes;
1629 trackSegmentCount++;
1631 if( item->GetNetCode() > 0 )
1632 netCodes.insert( item->GetNetCode() );
1637 for(
PAD*
pad : footprint->Pads() )
1641 if(
pad->GetNetCode() > 0 )
1642 netCodes.insert(
pad->GetNetCode() );
1646 aList.emplace_back(
_(
"Pads" ), wxString::Format( wxT(
"%d" ), padCount ) );
1647 aList.emplace_back(
_(
"Vias" ), wxString::Format( wxT(
"%d" ), viaCount ) );
1648 aList.emplace_back(
_(
"Track Segments" ), wxString::Format( wxT(
"%d" ), trackSegmentCount ) );
1649 aList.emplace_back(
_(
"Nets" ), wxString::Format( wxT(
"%d" ), (
int) netCodes.size() ) );
1650 aList.emplace_back(
_(
"Unrouted" ), wxString::Format( wxT(
"%d" ), unconnected ) );
1655 const std::vector<KICAD_T>& scanTypes )
1657#if 0 && defined(DEBUG)
1658 std::cout <<
GetClass().mb_str() <<
' ';
1661 bool footprintsScanned =
false;
1662 bool drawingsScanned =
false;
1663 bool tracksScanned =
false;
1665 for(
KICAD_T scanType : scanTypes )
1670 if( inspector(
this, testData ) == INSPECT_RESULT::QUIT )
1671 return INSPECT_RESULT::QUIT;
1696 if( !footprintsScanned )
1698 if( IterateForward<FOOTPRINT*>(
m_footprints, inspector, testData, scanTypes )
1699 == INSPECT_RESULT::QUIT )
1701 return INSPECT_RESULT::QUIT;
1704 footprintsScanned =
true;
1707 if( !drawingsScanned )
1709 if( IterateForward<BOARD_ITEM*>(
m_drawings, inspector, testData, scanTypes )
1710 == INSPECT_RESULT::QUIT )
1712 return INSPECT_RESULT::QUIT;
1715 drawingsScanned =
true;
1723 if( !tracksScanned )
1725 if( IterateForward<PCB_TRACK*>(
m_tracks, inspector, testData, scanTypes )
1726 == INSPECT_RESULT::QUIT )
1728 return INSPECT_RESULT::QUIT;
1731 tracksScanned =
true;
1739 if( marker->Visit( inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
1740 return INSPECT_RESULT::QUIT;
1746 if( !footprintsScanned )
1748 if( IterateForward<FOOTPRINT*>(
m_footprints, inspector, testData, scanTypes )
1749 == INSPECT_RESULT::QUIT )
1751 return INSPECT_RESULT::QUIT;
1754 footprintsScanned =
true;
1759 if( zone->Visit( inspector, testData, { scanType } ) == INSPECT_RESULT::QUIT )
1760 return INSPECT_RESULT::QUIT;
1766 if( !footprintsScanned )
1768 if( IterateForward<FOOTPRINT*>(
m_footprints, inspector, testData, scanTypes )
1769 == INSPECT_RESULT::QUIT )
1771 return INSPECT_RESULT::QUIT;
1774 footprintsScanned =
true;
1777 if( IterateForward<PCB_GENERATOR*>(
m_generators, inspector, testData, { scanType } )
1778 == INSPECT_RESULT::QUIT )
1780 return INSPECT_RESULT::QUIT;
1786 if( IterateForward<PCB_GROUP*>(
m_groups, inspector, testData, { scanType } )
1787 == INSPECT_RESULT::QUIT )
1789 return INSPECT_RESULT::QUIT;
1799 return INSPECT_RESULT::CONTINUE;
1829 for(
auto it = aNetName.rbegin(); it != aNetName.rend() && rv == 0; ++it, ++count )
1833 if( ( ch >=
'0' && ch <=
'9' ) || ch ==
'_' )
1837 else if( ch ==
'+' )
1839 aComplementNet = wxT(
"-" );
1842 else if( ch ==
'-' )
1844 aComplementNet = wxT(
"+" );
1847 else if( ch ==
'N' )
1849 aComplementNet = wxT(
"P" );
1852 else if ( ch ==
'P' )
1854 aComplementNet = wxT(
"N" );
1863 if( rv != 0 && count >= 1 )
1865 aComplementNet = aNetName.Left( aNetName.length() - count )
1867 + aNetName.Right( count - 1 );
1879 wxString coupledNetName;
1882 return FindNet( coupledNetName );
1893 if( aReference == footprint->GetReference() )
1905 if( footprint->GetPath() == aPath )
1915 std::set<wxString> names;
1919 if( !net->GetNetname().IsEmpty() )
1920 names.insert( net->GetNetname() );
1942 std::shared_ptr<NETCLASS>& defaultNetClass = bds.
m_NetSettings->m_DefaultNetClass;
1945 net->SetNetClass( bds.
m_NetSettings->GetEffectiveNetClass( net->GetNetname() ) );
1947 if( aResetTrackAndViaSizes )
1966 int error_count = 0;
1970 if( !zone->IsOnCopperLayer() )
1976 if( zone->GetNetCode() != 0 )
1989 zone->SetNetCode( -1 );
2000 if( !aLayerSet.any() )
2007 if( footprint->HitTest( aPosition ) )
2008 pad = footprint->GetPad( aPosition, aLayerSet );
2024 return GetPad( aPosition, lset );
2032 for(
PAD*
pad : footprint->Pads() )
2034 if(
pad->GetPosition() != aPosition )
2038 if( (
pad->GetLayerSet() & aLayerSet ).any() )
2051 int idxmax = aPadList.size() - 1;
2053 int delta = aPadList.size();
2066 PAD*
pad = aPadList[idx];
2068 if(
pad->GetPosition() == aPosition )
2071 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
2078 for(
int ii = idx+1; ii <= idxmax; ii++ )
2082 if(
pad->GetPosition() != aPosition )
2085 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
2089 for(
int ii = idx - 1 ;ii >=0; ii-- )
2093 if(
pad->GetPosition() != aPosition )
2096 if( ( aLayerSet &
pad->GetLayerSet() ).any() )
2104 if(
pad->GetPosition().x == aPosition.
x )
2106 if(
pad->GetPosition().y < aPosition.
y )
2121 else if(
pad->GetPosition().x < aPosition.
x )
2159 for(
PAD*
pad : footprint->Pads( ) )
2161 if( aNetCode < 0 || pad->GetNetCode() == aNetCode )
2162 aVector.push_back(
pad );
2184 double length = 0.0;
2185 double package_length = 0.0;
2193 { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T } ) )
2199 if( track->Type() ==
PCB_VIA_T && useHeight )
2209 length += track->GetLength();
2214 SEG trackSeg( track->GetStart(), track->GetEnd() );
2215 double segLen = trackSeg.
Length();
2216 double segInPadLen = 0;
2218 for(
auto pad_it : connectivity->GetConnectedPads( item ) )
2222 bool hitStart =
pad->HitTest( track->GetStart(), track->GetWidth() / 2 );
2223 bool hitEnd =
pad->HitTest( track->GetEnd(), track->GetWidth() / 2 );
2225 if( hitStart && hitEnd )
2230 else if( hitStart || hitEnd )
2235 if(
pad->GetEffectivePolygon(
ERROR_INSIDE )->Collide( trackSeg, 0,
nullptr, &loc ) )
2243 segLen = trackSeg.
Length();
2252 length += segLen + segInPadLen;
2254 else if(
PAD*
pad =
dynamic_cast<PAD*
>( item ) )
2256 package_length +=
pad->GetPadToDieLength();
2260 return std::make_tuple( count, length, package_length );
2265 bool aVisibleOnly,
bool aIgnoreLocked )
const
2269 int min_dim = 0x7FFFFFFF;
2270 int alt_min_dim = 0x7FFFFFFF;
2271 bool current_layer_back =
IsBackLayer( aActiveLayer );
2276 if( !candidate->HitTest( aPosition ) )
2280 if( aIgnoreLocked && candidate->IsLocked() )
2288 BOX2I bb = candidate->GetBoundingBox(
false,
false );
2294 int dist = ( aPosition.
x - offx ) * ( aPosition.
x - offx ) +
2295 ( aPosition.
y - offy ) * ( aPosition.
y - offy );
2299 if( dist <= min_dim )
2302 footprint = candidate;
2308 if( dist <= alt_min_dim )
2311 alt_footprint = candidate;
2322 return alt_footprint;
2330 std::list<ZONE*> zones;
2333 zones.push_back( zone );
2335 if( aIncludeZonesInFootprints )
2339 for(
ZONE* zone : footprint->Zones() )
2340 zones.push_back( zone );
2356 m_zones.push_back( new_area );
2365 ITEM_PICKER picker(
nullptr, new_area, UNDO_REDO::NEWITEM );
2375 bool aAllowUseArcsInPolygons,
2376 bool aIncludeNPTHAsOutlines )
2382 chainingEpsilon, aErrorHandler,
2383 aAllowUseArcsInPolygons );
2386 if( aIncludeNPTHAsOutlines )
2390 for(
PAD*
pad : fp->Pads() )
2392 if(
pad->GetAttribute () != PAD_ATTRIB::NPTH )
2408 aOutlines.
AddHole( pad_hole, jj );
2425 std::vector<PAD*> allPads;
2429 for(
PAD*
pad : footprint->Pads() )
2430 allPads.push_back(
pad );
2439 std::vector<BOARD_CONNECTED_ITEM*> items;
2442 items.push_back( track );
2446 for(
PAD*
pad : footprint->Pads() )
2447 items.push_back(
pad );
2451 items.push_back( zone );
2456 items.push_back( bci );
2470 item->SetNet( netInfo );
2474 aDestBoard->
Add( newNet );
2475 item->SetNet( newNet );
2486 if(
FindNet( item->GetNetCode() ) ==
nullptr )
2530 std::vector<BOARD_ITEM*>& aRemovedItems,
2531 std::vector<BOARD_ITEM*>& aChangedItems )
2583 return wxEmptyString;
2602 std::unordered_set<PCB_GROUP*> knownCycleFreeGroups;
2604 std::unordered_set<PCB_GROUP*> currentChainGroups;
2606 std::unordered_set<PCB_GROUP*> toCheckGroups;
2610 toCheckGroups.insert(
group );
2613 toCheckGroups.insert( gen );
2615 while( !toCheckGroups.empty() )
2617 currentChainGroups.clear();
2622 if( currentChainGroups.find(
group ) != currentChainGroups.end() )
2627 return "Cycle detected in group membership";
2629 else if( knownCycleFreeGroups.find(
group ) != knownCycleFreeGroups.end() )
2635 currentChainGroups.insert(
group );
2637 toCheckGroups.erase(
group );
2650 knownCycleFreeGroups.insert( currentChainGroups.begin(), currentChainGroups.end() );
2660 bool hasGroup =
false;
2661 bool hasMember =
false;
2670 if( board_item->GetParentGroup() )
2709 if( aFirst->
Type() != aSecond->
Type() )
2710 return aFirst->
Type() < aSecond->
Type();
2719 return shape->
Compare( other );
2725 return text->Compare( other );
2732 return textbox->PCB_SHAPE::Compare( other ) && textbox->EDA_TEXT::Compare( other );
2754 if( !track->IsOnLayer( aLayer ) )
2757 track->TransformShapeToPolygon( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE );
2763 footprint->TransformPadsToPolySet( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE );
2765 footprint->TransformFPShapesToPolySet( aOutlines, aLayer, 0, maxError,
ERROR_INSIDE,
2770 for(
const ZONE* zone : footprint->Zones() )
2772 if( zone->GetLayerSet().test( aLayer ) )
2773 zone->TransformSolidAreasShapesToPolygon( aLayer, aOutlines );
2780 if( zone->GetLayerSet().test( aLayer ) )
2781 zone->TransformSolidAreasShapesToPolygon( aLayer, aOutlines );
2787 if( !item->IsOnLayer( aLayer ) )
2790 switch( item->Type() )
2812 textbox->PCB_SHAPE::TransformShapeToPolygon( aOutlines, aLayer, 0, maxError,
2851 std::copy(
m_tracks.begin(),
m_tracks.end(), std::inserter( items, items.end() ) );
2852 std::copy(
m_zones.begin(),
m_zones.end(), std::inserter( items, items.end() ) );
2855 std::copy(
m_markers.begin(),
m_markers.end(), std::inserter( items, items.end() ) );
2856 std::copy(
m_groups.begin(),
m_groups.end(), std::inserter( items, items.end() ) );
2867 const BOARD& other =
static_cast<const BOARD&
>( aItem );
2878 for(
auto it1 = thisNetNames.begin(), it2 = otherNetNames.begin();
2879 it1 != thisNetNames.end() && it2 != otherNetNames.end(); ++it1, ++it2 )
2883 if( it1->first != it2->first )
2918 wxArrayString ourVars;
2921 wxArrayString otherVars;
2924 if( ourVars != otherVars )
@ 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 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.
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 const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
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
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
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.
LAYER m_layers[PCB_LAYER_ID_COUNT]
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
BOX2I ComputeBoundingBox(bool aBoardEdgesOnly=false, bool aIncludeHiddenText=false) const
Calculate the bounding box containing all board items (or board edge segments).
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 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
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()
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
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.
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.
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.
const DRAWINGS & Drawings() const
size_type GetHeight() const
size_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
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)
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, 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.
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(POLYGON_MODE aFastMode)
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections) For aFastMo...
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(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< 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_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
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.
BS::thread_pool thread_pool
thread_pool & GetKiCadThreadPool()
Get a reference to the current 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_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
ZONE_BORDER_DISPLAY_STYLE
Zone border styles.