46#include <dialogs/dialog_table_properties.h>
56#include <python_scripting.h>
99#include <wx/wupdlock.h>
127#include "../scripting/python_scripting.h"
129#include <wx/filedlg.h>
131using namespace std::placeholders;
134#define INSPECT_DRC_ERROR_DIALOG_NAME wxT( "InspectDrcErrorDialog" )
135#define INSPECT_CLEARANCE_DIALOG_NAME wxT( "InspectClearanceDialog" )
136#define INSPECT_CONSTRAINTS_DIALOG_NAME wxT( "InspectConstraintsDialog" )
137#define FOOTPRINT_DIFF_DIALOG_NAME wxT( "FootprintDiffDialog" )
180 m_exportNetlistAction(
nullptr ),
181 m_findDialog(
nullptr ),
182 m_inspectDrcErrorDlg(
nullptr ),
183 m_inspectClearanceDlg(
nullptr ),
184 m_inspectConstraintsDlg(
nullptr ),
185 m_footprintDiffDlg(
nullptr ),
186 m_boardSetupDlg(
nullptr ),
187 m_designBlocksPane(
nullptr ),
188 m_importProperties(
nullptr ),
189 m_eventCounterTimer(
nullptr )
191 m_maximizeByDefault =
true;
192 m_showBorderAndTitleBlock =
true;
193 m_SelTrackWidthBox =
nullptr;
194 m_SelViaSizeBox =
nullptr;
195 m_show_layer_manager_tools =
true;
196 m_supportsAutoSave =
true;
197 m_probingSchToPcb =
false;
198 m_show_search =
false;
199 m_show_net_inspector =
false;
203 m_ZoneFillsDirty =
true;
205 m_aboutTitle =
_HKI(
"KiCad PCB Editor" );
210 m_exportNetlistAction =
new TOOL_ACTION(
"pcbnew.EditorControl.exportNetlist",
212 _(
"Export netlist used to update schematics" ) );
217 GetGalDisplayOptions(),
221 SetBoard(
new BOARD() );
224 wxIconBundle icon_bundle;
227 icon_bundle.AddIcon( icon );
229 icon_bundle.AddIcon( icon );
231 icon_bundle.AddIcon( icon );
233 icon_bundle.AddIcon( icon );
235 icon_bundle.AddIcon( icon );
237 SetIcons( icon_bundle );
246 GetScreen()->m_Center =
false;
251 m_toolbarSettings = GetToolbarSettings<PCB_EDIT_TOOLBAR_SETTINGS>(
"pcbnew-toolbars" );
254 PrepareLayerIndicator(
true );
260 &PCB_EDIT_FRAME::onPluginAvailabilityChanged,
this );
277 m_auimgr.SetManagedWindow(
this );
281 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
282#if !defined( _WIN32 )
285 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
287 m_auimgr.SetFlags( auiFlags );
290 m_auimgr.AddPane( m_tbTopMain,
EDA_PANE().HToolbar().Name( wxS(
"TopMainToolbar" ) )
292 m_auimgr.AddPane( m_tbTopAux,
EDA_PANE().HToolbar().Name( wxS(
"TopAuxToolbar" ) )
294 m_auimgr.AddPane( m_messagePanel,
EDA_PANE().Messages().Name( wxS(
"MsgPanel" ) )
295 .Bottom().Layer( 6 ) );
298 m_auimgr.AddPane( m_tbLeft,
EDA_PANE().VToolbar().Name( wxS(
"LeftToolbar" ) )
299 .Left().Layer( 3 ) );
301 m_auimgr.AddPane( m_tbRight,
EDA_PANE().VToolbar().Name( wxS(
"RightToolbar" ) )
302 .Right().Layer( 3 ) );
304 m_auimgr.AddPane( m_appearancePanel,
EDA_PANE().Name( wxS(
"LayersManager" ) )
306 .Caption(
_(
"Appearance" ) ).PaneBorder(
false )
307 .MinSize( m_appearancePanel->GetMinSize().x, -1 )
310 .BestSize( m_appearancePanel->GetMinSize().x, -1 )
312 .BestSize( m_appearancePanel->GetBestSize().x, -1 )
314 .FloatingSize( m_appearancePanel->GetBestSize() )
315 .CloseButton(
false ) );
317 m_auimgr.AddPane( m_selectionFilterPanel,
EDA_PANE().Name( wxS(
"SelectionFilter" ) )
318 .Right().Layer( 4 ).Position( 2 )
319 .Caption(
_(
"Selection Filter" ) ).PaneBorder(
false )
320 .MinSize( m_selectionFilterPanel->GetMinSize().x, -1 )
321 .BestSize( m_selectionFilterPanel->GetBestSize().x, -1 )
322 .FloatingSize( m_selectionFilterPanel->GetBestSize() )
323 .CloseButton(
false ) );
325 m_auimgr.AddPane( m_designBlocksPane,
EDA_PANE().Name( DesignBlocksPaneName() )
327 .Caption(
_(
"Design Blocks" ) )
328 .CaptionVisible(
true )
330 .TopDockable(
false )
331 .BottomDockable(
false )
333 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
334 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
335 .FloatingSize( FromDIP( wxSize( 800, 600 ) ) )
336 .FloatingPosition( FromDIP( wxPoint( 50, 200 ) ) )
339 m_auimgr.AddPane( m_propertiesPanel,
EDA_PANE().Name( PropertiesPaneName() )
341 .Caption(
_(
"Properties" ) ).PaneBorder(
false )
342 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
343 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
344 .FloatingSize( wxSize( 300, 200 ) )
345 .CloseButton(
true ) );
348 m_auimgr.AddPane( GetCanvas(),
EDA_PANE().Canvas().Name( wxS(
"DrawFrame" ) )
351 m_auimgr.AddPane( m_netInspectorPanel,
EDA_PANE().Name( NetInspectorPanelName() )
353 .Caption(
_(
"Net Inspector" ) )
355 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
356 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
357 .FloatingSize( wxSize( 300, 200 ) )
358 .CloseButton(
true ) );
360 m_auimgr.AddPane( m_searchPane,
EDA_PANE().Name( SearchPaneName() )
362 .Caption(
_(
"Search" ) ).PaneBorder(
false )
363 .MinSize( FromDIP( wxSize ( 180, 60 ) ) )
364 .BestSize( FromDIP( wxSize ( 180, 100 ) ) )
365 .FloatingSize( FromDIP( wxSize( 480, 200 ) ) )
366 .DestroyOnClose(
false )
367 .CloseButton(
true ) );
370 m_auimgr.GetPane(
"LayersManager" ).Show( m_show_layer_manager_tools );
371 m_auimgr.GetPane(
"SelectionFilter" ).Show( m_show_layer_manager_tools );
372 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.show_properties );
373 m_auimgr.GetPane( NetInspectorPanelName() ).Show( m_show_net_inspector );
374 m_auimgr.GetPane( SearchPaneName() ).Show( m_show_search );
375 m_auimgr.GetPane( DesignBlocksPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.design_blocks_show );
378 m_auimgr.GetPane(
"SelectionFilter" ).dock_proportion = 0;
380 FinishAUIInitialization();
384 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( wxS(
"LayersManager" ) );
387 wxAuiPaneInfo& designBlocksPane = m_auimgr.GetPane( DesignBlocksPaneName() );
393 wxAuiPaneInfo& propertiesPanel = m_auimgr.GetPane( PropertiesPaneName() );
401 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
409 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
417 m_layerPairSettings = std::make_unique<LAYER_PAIR_SETTINGS>();
419 m_layerPairSettings->Bind( PCB_LAYER_PAIR_PRESETS_CHANGED, [&]( wxCommandEvent& aEvt )
422 std::span<const LAYER_PAIR_INFO> newPairInfos = m_layerPairSettings->GetLayerPairs();
424 std::vector<LAYER_PAIR_INFO>{ newPairInfos.begin(), newPairInfos.end() };
427 m_layerPairSettings->Bind( PCB_CURRENT_LAYER_PAIR_CHANGED, [&]( wxCommandEvent& aEvt )
429 const LAYER_PAIR& layerPair = m_layerPairSettings->GetCurrentLayerPair();
436 PrepareLayerIndicator();
447 [
this]( wxIdleEvent& aEvent )
449 BOX2D viewport = GetCanvas()->GetView()->GetViewport();
451 if( viewport != m_lastNetnamesViewport )
454 m_lastNetnamesViewport = viewport;
469 m_toolManager->GetTool<
DRC_TOOL>()->GetDRCEngine()->InitEngine( wxFileName() );
476 PythonSyncEnvironmentVariables();
477 PythonSyncProjectName();
483 m_apiHandler = std::make_unique<API_HANDLER_PCB>(
this );
484 Pgm().GetApiServer().RegisterHandler( m_apiHandler.get() );
488 m_apiHandlerCommon = std::make_unique<API_HANDLER_COMMON>();
489 Pgm().GetApiServer().RegisterHandler( m_apiHandlerCommon.get() );
493 GetCanvas()->SwitchBackend( m_canvasType );
503 if( strK2S.Find( wxT(
"pcbnew.app" ) ) != wxNOT_FOUND )
506 strK2S += wxT(
"../../" );
509 strK2S += wxT(
"Contents/MacOS/" );
512 wxFileName appK2S( strK2S, wxT(
"kicad2step" ) );
515 appK2S.SetExt( wxT(
"exe" ) );
530 m_appearancePanel->OnBoardChanged();
540 UpdateToolbarControlSizes();
545 m_eventCounterTimer =
new wxTimer(
this );
548 [&]( wxTimerEvent& aEvent )
550 GetCanvas()->m_PaintEventCounter->Show();
551 GetCanvas()->m_PaintEventCounter->Reset();
559 m_eventCounterTimer->GetId() );
561 m_eventCounterTimer->Start( 1000 );
566 DragAcceptFiles(
true );
588 open_dlg->Close(
true );
617 if( aBuildConnectivity )
695 if( screen !=
nullptr )
768 pcbTool->SetIsBoardEditor(
true );
799 auto groupWithDesignBlockLink =
802 if( aSel.Size() != 1 )
810 return group->HasDesignBlockLink();
815#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
816#define CHECK( x ) ACTION_CONDITIONS().Check( x )
856 if( SCRIPTING::IsWxAvailable() )
859 auto enableZoneControlCondition =
867 ENABLE( enableZoneControlCondition )
870 ENABLE( enableZoneControlCondition )
871 .Check( cond.
ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_ZONE_OUTLINE ) ) );
873 ENABLE( enableZoneControlCondition )
874 .Check( cond.
ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_FRACTURE_BORDERS ) ) );
876 ENABLE( enableZoneControlCondition )
877 .Check( cond.
ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_TRIANGULATION ) ) );
888 auto constrainedDrawingModeCond =
894 auto boardFlippedCond =
900 auto layerManagerCond =
906 auto propertiesCond =
912 auto netInspectorCond =
918 auto searchPaneCond =
924 auto designBlockCond =
930 auto highContrastCond =
936 auto globalRatsnestCond =
942 auto curvedRatsnestCond =
948 auto netHighlightCond =
955 auto enableNetHighlightCond =
969 .Enable( enableNetHighlightCond ) );
978 const auto isArcKeepCenterMode =
984 const auto isArcKeepEndpointMode =
990 const auto isArcKeepRadiusMode =
1000 auto isHighlightMode =
1014 auto isWalkaroundMode =
1025 auto isAutoTrackWidth =
1040 if( bci->GetNetCode() > 0 )
1057 static const std::vector<KICAD_T> zoneTypes = {
PCB_ZONE_T };
1079#define CURRENT_TOOL( action ) mgr->SetConditions( action, CHECK( cond.CurrentTool( action ) ) )
1094#define CURRENT_EDIT_TOOL( action ) \
1095 mgr->SetConditions( action, ACTION_CONDITIONS().Check( cond.CurrentTool( action ) ) \
1096 .Enable( isDRCIdle ) )
1137#undef CURRENT_EDIT_TOOL
1146 if( event.GetId() == wxID_EXIT )
1149 if( event.GetId() == wxID_CLOSE ||
Kiface().IsSingle() )
1161 marker->GetRCItem()->SetItems(
GetCanvas()->GetDrawingSheet() );
1163 commit.
Add( marker );
1189 if( zoneFillerTool->
IsBusy() )
1193 if( wxWindow* reporter =
dynamic_cast<wxWindow*
>( zoneFillerTool->
GetProgressReporter() ) )
1194 reporter->ShowWithEffect( wxSHOW_EFFECT_EXPAND );
1199 if(
Kiface().IsSingle() )
1203 if( fpEditor && !fpEditor->Close() )
1208 if( fpViewer && !fpViewer->Close() )
1215 if( chooser && !chooser->Close() )
1222 if( fpEditor && fpEditor->IsCurrentFPFromBoard() )
1224 if( !fpEditor->CanCloseFPFromBoard(
true ) )
1232 wxString msg =
_(
"Save changes to '%s' before closing?" );
1256 GetCanvas()->SetEvtHandlerEnabled(
false );
1261 Pgm().GetApiServer().DeregisterHandler( m_apiHandler.get() );
1263 &PCB_EDIT_FRAME::onPluginAvailabilityChanged,
this );
1273 open_dlg->Close(
true );
1313 if( !fn.IsOk() || !fn.IsDirWritable() )
1314 fn.SetPath( wxFileName::GetTempDir() );
1316 wxLogTrace(
traceAutoSave, wxT(
"Deleting auto save file <" ) + fn.GetFullPath() + wxT(
">" ) );
1319 if( fn.FileExists() && !wxRemoveFile( fn.GetFullPath() ) )
1321 wxLogTrace(
traceAutoSave, wxT(
"The auto save file could not be removed!" ) );
1325 if(
Prj().GetLocalSettings().ShouldAutoSave() )
1332 wxLogTrace(
traceAutoSave, wxT(
"Skipping auto-save of migrated local settings" ) );
1340 m_auimgr.GetPane( wxS(
"LayersManager" ) ).Show(
false );
1341 m_auimgr.GetPane( wxS(
"TabbedPanel" ) ).Show(
false );
1369 static std::mutex dialogMutex;
1371 std::unique_lock<std::mutex> dialogLock( dialogMutex, std::try_to_lock );
1374 if( !dialogLock.owns_lock() )
1389 if( !aInitialPage.IsEmpty() )
1403 if( !
GetBoard()->SynchronizeComponentClasses( std::unordered_set<wxString>() ) )
1437 if( ( GetBoard()->GetVisibleLayers() & maskAndPasteLayers ).any() )
1438 flags |= KIGFX::ALL;
1443 if( settings->m_Display.m_TrackClearance == SHOW_WITH_VIA_ALWAYS )
1444 flags |= KIGFX::REPAINT;
1449 if( settings->m_Display.m_PadClearance )
1450 flags |= KIGFX::REPAINT;
1455 if( text->HasTextVars() )
1457 text->ClearRenderCache();
1458 text->ClearBoundingBoxCache();
1459 flags |= KIGFX::GEOMETRY | KIGFX::REPAINT;
1478 GetCanvas()->SetFocus();
1481 m_boardSetupDlg =
nullptr;
1552 if( designBlocksPane.IsDocked() )
1591 if( oldLayer == aLayer && !aForceRedraw )
1616 const auto getClearanceLayerForActive = [](
PCB_LAYER_ID aActiveLayer ) -> std::optional<int>
1621 return std::nullopt;
1624 if( std::optional<int> oldClearanceLayer = getClearanceLayerForActive( oldLayer ) )
1627 if( std::optional<int> newClearanceLayer = getClearanceLayerForActive( aLayer ) )
1642 if( item->IsOnLayer( oldLayer ) || item->IsOnLayer( aLayer ) )
1648 PCB_VIA* via = static_cast<PCB_VIA*>( item );
1652 if( via->GetViaType() == VIATYPE::BLIND_BURIED
1653 || via->GetViaType() == VIATYPE::MICROVIA )
1655 return KIGFX::REPAINT;
1658 if(
via->GetRemoveUnconnected() )
1663 PAD* pad = static_cast<PAD*>( item );
1665 if( pad->GetRemoveUnconnected() )
1672 GetCanvas()->Refresh();
1689 layerEnum.
Map( layer,
GetBoard()->GetLayerName( layer ) );
1709 if( fn.FileExists() && !fn.IsFileWritable() )
1757 SetStatusText( wxEmptyString );
1806 if(
project.m_PcbLastPath[ aType ].IsEmpty() )
1807 return wxEmptyString;
1809 wxFileName absoluteFileName =
project.m_PcbLastPath[ aType ];
1812 absoluteFileName.MakeAbsolute( pcbFileName.GetPath() );
1813 return absoluteFileName.GetFullPath();
1821 wxFileName relativeFileName = aLastPath;
1824 relativeFileName.MakeRelativeTo( pcbFileName.GetPath() );
1826 if( relativeFileName.GetFullPath() !=
project.m_PcbLastPath[ aType ] )
1828 project.m_PcbLastPath[ aType ] = relativeFileName.GetFullPath();
1844 if( !GetTitle().StartsWith( wxT(
"*" ) ) )
1855 connectivity->RecalculateRatsnest(
nullptr );
1858 std::vector<MSG_PANEL_ITEM> msg_list;
1867 bool readOnly =
false;
1868 bool unsaved =
false;
1870 if( fn.IsOk() && fn.FileExists() )
1871 readOnly = !fn.IsFileWritable();
1880 title += fn.GetName();
1883 title += wxS(
" " ) +
_(
"[Read Only]" );
1886 title += wxS(
" " ) +
_(
"[Unsaved]" );
1888 title += wxT(
" \u2014 " ) +
_(
"PCB Editor" );
1923 layerEnum.
Map( layer,
GetBoard()->GetLayerName( layer ) );
1952 wxString findString;
1956 if( selection.
Size() == 1 )
1960 switch( front->
Type() )
1970 if( findString.Contains( wxT(
"\n" ) ) )
1971 findString = findString.Before(
'\n' );
1997 if(
Kiface().IsSingle() )
2009 if( !frame->IsShownOnScreen() )
2011 wxEventBlocker blocker(
this );
2012 wxFileName fn(
Prj().GetProjectPath(),
Prj().GetProjectName(),
2017 if( !fn.FileExists() )
2021 if( !fn.FileExists() )
2032 frame->Show(
true );
2043 const wxString& aAnnotateMessage )
2047 if( standalone == 0 )
2050 "stand-alone mode. In order to create or update PCBs from "
2051 "schematics, you must launch the KiCad project manager and "
2052 "create a project." ) );
2056 if( standalone < 0 )
2061 std::string payload( aAnnotateMessage );
2065 if( payload == aAnnotateMessage )
2083 wxString extra_info = e.
Problem() + wxT(
" : " ) + e.
What() + wxT(
" at " ) + e.
Where();
2086 "report this issue to the KiCad team using the menu "
2087 "Help->Report Bug."), extra_info );
2101 for(
const std::pair<const wxString, ENV_VAR_ITEM>& var : vars )
2102 UpdatePythonEnvVar( var.first, var.second.GetValue() );
2106 for(
const std::pair<const wxString, ENV_VAR_ITEM>& var : vars )
2107 wxSetEnv( var.first, var.second.GetValue() );
2125 if( aFootprint ==
nullptr )
2164 fp_editor->Show(
true );
2175 fp_editor->Show(
true );
2191 bool aSelectedMode )
2211 bool aResetText,
bool aResetTextLayers,
bool aResetTextEffects,
2219 if( aResetTextLayers )
2230 if( aResetTextEffects )
2253 std::vector<PCB_TEXT*> candidates;
2260 candidates.push_back( candidate );
2263 if( candidates.size() == 0 )
2266 if( candidates.size() == 1 )
2267 return candidates[0];
2270 std::vector<PCB_TEXT*> candidatesOnSameLayer;
2272 for(
PCB_TEXT* candidate : candidates )
2274 if( candidate->GetLayer() == aRefItem->
GetLayer() )
2275 candidatesOnSameLayer.push_back( candidate );
2278 if( candidatesOnSameLayer.size() == 1 )
2279 return candidatesOnSameLayer[0];
2282 std::vector<PCB_TEXT*> candidatesAtSamePos;
2284 for(
PCB_TEXT* candidate : candidatesOnSameLayer.size() ? candidatesOnSameLayer : candidates )
2287 candidatesAtSamePos.push_back( candidate );
2290 if( candidatesAtSamePos.size() > 0 )
2291 return candidatesAtSamePos[0];
2292 else if( candidatesOnSameLayer.size() > 0 )
2293 return candidatesOnSameLayer[0];
2295 return candidates[0];
2301 bool deleteExtraTexts,
2302 bool resetTextLayers,
2303 bool resetTextEffects,
2304 bool resetTextContent,
2305 bool resetFabricationAttrs,
2306 bool resetClearanceOverrides,
2311 bool dummyBool =
false;
2314 aUpdated = &dummyBool;
2318 aCommit.
Modify( parentGroup->
AsEdaItem(),
nullptr, RECURSE_MODE::NO_RECURSE );
2340 for(
PAD* newPad : aNew->
Pads() )
2342 PAD* oldPad =
nullptr;
2346 if( newPad->GetNumber().IsEmpty() )
2353 PAD* last_pad =
nullptr;
2370 const_cast<KIID&
>( newPad->m_Uuid ) = oldPad->
m_Uuid;
2376 if( newPad->IsOnCopperLayer() )
2382 std::set<PCB_TEXT*> handledTextItems;
2398 handledTextItems.insert( newTextItem );
2399 processTextItem( *oldTextItem, *newTextItem, resetTextContent, resetTextLayers,
2400 resetTextEffects, aUpdated );
2402 else if( deleteExtraTexts )
2408 newTextItem =
static_cast<PCB_TEXT*
>( oldTextItem->
Clone() );
2409 handledTextItems.insert( newTextItem );
2410 aNew->
Add( newTextItem );
2426 if( !handledTextItems.contains( newTextItem ) )
2436 resetTextEffects, aUpdated );
2443 resetTextLayers, resetTextEffects, aUpdated );
2445 std::set<PCB_FIELD*> handledFields;
2451 if( oldField->IsReference() || oldField->IsValue() )
2458 handledFields.insert( newField );
2459 processTextItem( *oldField, *newField, resetTextContent, resetTextLayers,
2460 resetTextEffects, aUpdated );
2462 else if( deleteExtraTexts )
2469 handledFields.insert( newField );
2470 aNew->
Add( newField );
2478 if( newField->IsReference() || newField->IsValue() )
2481 if( !handledFields.contains( newField ) )
2488 if( resetFabricationAttrs )
2500 if( resetClearanceOverrides )
2528 if( aNew->
Models().size() != aExisting->
Models().size() )
2534 for(
size_t ii = 0; ii < aNew->
Models().size(); ++ii )
2557 if( *aUpdated ==
false )
2564 aCommit.
Remove( aExisting );
2565 aCommit.
Add( aNew );
2595 wxHyperlinkCtrl* button =
new wxHyperlinkCtrl( infobar, wxID_ANY,
_(
"Edit design rules" ),
2598 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<
void( wxHyperlinkEvent& aEvent )>(
2599 [&]( wxHyperlinkEvent& aEvent )
2604 infobar->RemoveAllButtons();
2605 infobar->AddButton( button );
2606 infobar->AddCloseButton();
2607 infobar->ShowMessage(
_(
"Could not compile custom design rules." ), wxICON_ERROR,
2643 if( zoneFillerTool->
IsBusy() )
2664 return m_auimgr.GetPane( wxS(
"LayersManager" ) ).IsShown();
2682 if( IsShownOnScreen() )
2700 _(
"Violation Report" ) );
2712 _(
"Clearance Report" ) );
2724 _(
"Constraints Report" ) );
2736 _(
"Compare Footprint with Library" ) );
2768void PCB_EDIT_FRAME::onPluginAvailabilityChanged( wxCommandEvent& aEvt )
2770 wxLogTrace(
traceApi,
"PCB frame: EDA_EVT_PLUGIN_AVAILABILITY_CHANGED" );
2783 if( layer == curLayer )
2790 if( layer >
GetBoard()->GetCopperLayerStackMaxId() )
2806 switch( aItem->
Type() )
2869 static_cast<PCB_GENERATOR*
>( aItem )->ShowPropertiesDialog(
this );
Class PCBNEW_ACTION_PLUGINS.
const KICOMMON_API wxEventTypeTag< wxCommandEvent > EDA_EVT_PLUGIN_AVAILABILITY_CHANGED
Notifies other parts of KiCad when plugin availability changes.
constexpr EDA_IU_SCALE pcbIUScale
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
constexpr BOX2I BOX2ISafe(const BOX2D &aInput)
static TOOL_ACTION toggleGrid
static TOOL_ACTION millimetersUnits
static TOOL_ACTION unselectAll
static TOOL_ACTION togglePolarCoords
static TOOL_ACTION pluginsReload
static TOOL_ACTION pasteSpecial
static TOOL_ACTION groupProperties
static TOOL_ACTION pointEditorArcKeepCenter
static TOOL_ACTION milsUnits
static TOOL_ACTION ungroup
static TOOL_ACTION toggleBoundingBoxes
static TOOL_ACTION pointEditorArcKeepRadius
static TOOL_ACTION showSearch
static TOOL_ACTION duplicate
static TOOL_ACTION inchesUnits
static TOOL_ACTION highContrastMode
static TOOL_ACTION embeddedFiles
static TOOL_ACTION toggleCursorStyle
static TOOL_ACTION measureTool
static TOOL_ACTION doDelete
static TOOL_ACTION selectionTool
static TOOL_ACTION zoomFitScreen
static TOOL_ACTION deleteTool
static TOOL_ACTION zoomTool
static TOOL_ACTION showProperties
static TOOL_ACTION gridSetOrigin
static TOOL_ACTION toggleGridOverrides
static TOOL_ACTION selectAll
static TOOL_ACTION pointEditorArcKeepEndpoint
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
void ApplyLayerPreset(const wxString &aPresetName)
int GetTabIndex() const
Set the current notebook tab.
bool IsLayerOptionsExpanded()
void UpdateDisplayOptions()
Return a list of the layer presets created by the user.
void OnColorThemeChanged()
Respond to change in OS's DarkMode.
bool IsNetOptionsExpanded()
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Handles how to draw a screen (a board, a schematic ...)
bool IsContentModified() const
const wxString & GetPageNumber() const
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Execute the changes.
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.
bool GetLocalRatsnestVisible() const
bool m_UseConnectedTrackWidth
Handle actions specific to the board editor in PcbNew.
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.
void SetLocked(bool aLocked) override
bool IsLocked() const override
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
VECTOR2I GetFPRelativePosition() const
void SetFPRelativePosition(const VECTOR2I &aPos)
Information pertinent to a Pcbnew printed circuit board.
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
void RemoveAllListeners()
Remove all listeners.
const PAGE_INFO & GetPageSettings() const
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
void SynchronizeTimeDomainProperties()
Ensure that all time domain properties providers are in sync with current settings.
TITLE_BLOCK & GetTitleBlock()
const std::map< wxString, wxString > & GetProperties() const
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
const wxString & GetFileName() const
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
PROJECT * GetProject() const
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.
const LSET & GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
void SetColor(int aLayer, const COLOR4D &aColor)
COLOR4D GetColor(int aLayer) const
COMMIT & Remove(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Remove a new item from the model.
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Add a new item to the model.
Handle actions that are shared between different applications.
void SetCallback(std::function< void(BOARD_ITEM *)> aCallback)
Function to be called on each found event.
bool Show(bool show=true) override
The Show method is overridden to make the search combobox focused by default.
void Preload(const wxString &aFindString)
void FindNext(bool reverse)
Finds the next item.
void SetSheetPath(const std::string &aSheetPath)
Set the sheet path displayed in the title block.
void SetSheetCount(int aSheetCount)
Change the sheet-count number displayed in the title block.
void SetPageNumber(const std::string &aPageNumber)
Change the page number displayed in the title block.
void SetSheetName(const std::string &aSheetName)
Set the sheet name displayed in the title block.
void SetIsFirstPage(bool aIsFirstPage)
Change if this is first page.
void SetFileName(const std::string &aFileName)
Set the file name displayed in the title block.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
virtual void ThemeChanged()
Process light/dark theme change.
virtual bool CanAcceptApiCommands()
Check if this frame is ready to accept API commands.
virtual void OnSize(wxSizeEvent &aEvent)
virtual bool canCloseWindow(wxCloseEvent &aCloseEvent)
virtual int GetUndoCommandCount() const
bool m_isClosing
Set by the close window event handler after frames are asked if they can close.
WX_INFOBAR * GetInfoBar()
static const wxString AppearancePanelName()
virtual wxString GetFullScreenDesc() const
void OnSelectGrid(wxCommandEvent &event)
Command event handler for selecting grid sizes.
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Change the current rendering backend.
virtual void OnSize(wxSizeEvent &event) override
Recalculate the size of toolbars and display panel when the frame size changes.
virtual void OnSelectZoom(wxCommandEvent &event)
Set the zoom factor when selected by the zoom list box in the main tool bar.
GAL_DISPLAY_OPTIONS_IMPL & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
virtual wxString GetScreenDesc() const
static const wxString PropertiesPaneName()
virtual void ReCreateAuxiliaryToolbar()
virtual void ReCreateHToolbar()
virtual void Zoom_Automatique(bool aWarpPointer)
Redraw the screen with best zoom level and the best centering that shows all the page or the board.
NET_INSPECTOR_PANEL * m_netInspectorPanel
static const wxString NetInspectorPanelName()
SEARCH_PANE * m_searchPane
static const wxString DesignBlocksPaneName()
PROPERTIES_PANEL * m_propertiesPanel
static constexpr GAL_TYPE GAL_FALLBACK
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
void ForceRefresh()
Force a redraw.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
A set of EDA_ITEMs (i.e., without duplicates).
void RemoveItem(EDA_ITEM *aItem)
Remove item from group.
void AddItem(EDA_ITEM *aItem)
Add item to group.
virtual EDA_ITEM * AsEdaItem()=0
A base class for most all the KiCad significant classes used in schematics and boards.
virtual EDA_GROUP * GetParentGroup() const
KICAD_T Type() const
Returns the type of object.
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
virtual void SetParent(EDA_ITEM *aParent)
Specialization of the wxAuiPaneInfo class for KiCad panels.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
const EDA_ANGLE & GetTextAngle() const
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual bool IsVisible() const
void SetAttributes(const EDA_TEXT &aSrc, bool aSetPosition=true)
Set the text attributes from another instance.
GR_TEXT_H_ALIGN_T GetHorizJustify() const
virtual void SetVisible(bool aVisible)
GR_TEXT_V_ALIGN_T GetVertJustify() const
virtual void SetText(const wxString &aText)
int GetTextThickness() const
VECTOR2I GetTextSize() const
SELECTION_CONDITION NoActiveTool()
Create a functor testing if there are no tools active in the frame.
SELECTION_CONDITION BoundingBoxes()
SELECTION_CONDITION RedoAvailable()
Create a functor that tests if there are any items in the redo queue.
SELECTION_CONDITION ScriptingConsoleVisible()
Create a functor testing if the python scripting console window is visible.
SELECTION_CONDITION Units(EDA_UNITS aUnit)
Create a functor that tests if the frame has the specified units.
SELECTION_CONDITION GridVisible()
Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION PolarCoordinates()
Create a functor testing if polar coordinates are current being used.
SELECTION_CONDITION GridOverrides()
Create a functor testing if the grid overrides wires is enabled in a frame.
SELECTION_CONDITION FullscreenCursor()
Create a functor testing if the cursor is full screen in a frame.
ENUM_MAP & Map(T aValue, const wxString &aName)
static ENUM_MAP< T > & Instance()
ENUM_MAP & Undefined(T aValue)
void ReadWindowSettings(WINDOW_SETTINGS &aCfg)
Read GAL config options from application-level config.
bool Contains(GAL_LAYER_ID aPos)
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
virtual const wxString Problem() const
what was the problem?
virtual const wxString Where() const
where did the Problem() occur?
Read the new s-expression based KiCad netlist format.
virtual void LoadNetlist() override
Load the contents of the netlist file into aNetlist.
APP_SETTINGS_BASE * KifaceSettings() const
A color representation with 4 components: red, green, blue, alpha.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
const std::set< int > & GetHighlightNetCodes() const
Return the netcode of currently highlighted net.
An abstract base class for deriving all objects that can be added to a VIEW.
bool IsBOARD_ITEM() const
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
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...
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
bool IsMirroredX() const
Return true if view is flipped across the X axis.
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
void UpdateAllItemsConditionally(int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
Update items in the view according to the given flags and condition.
An implementation of class VIEW_CONTROLS for wxWidgets library.
std::unique_ptr< PROF_COUNTER > m_MotionEventCounter
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
virtual bool OpenProjectFiles(const std::vector< wxString > &aFileList, int aCtl=0)
Open a project or set of files given by aFileList.
void OnSockRequestServer(wxSocketEvent &evt)
void OnSockRequest(wxSocketEvent &evt)
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
virtual void CommonSettingsChanged(int aFlags=0)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
int SetLayerSelection(int layer)
PCB_LAYER_ID GetLayerA() const
PCB_LAYER_ID GetLayerB() const
const UTF8 & GetLibItemName() const
LSET is a set of PCB_LAYER_IDs.
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
static const LSET & AllLayersMask()
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
virtual void OnBoardChanged()
Notification from file loader when board changed and connectivity rebuilt.
virtual void SaveSettings()
Save the net inspector settings - called from EDA_EDIT_FRAME when hiding the panel.
virtual void OnParentSetupChanged()
Rebuild inspector data if project settings updated.
const wxString & GetPinType() const
const wxString & GetPinFunction() const
bool IsOnCopperLayer() const override
void SetInitialPage(const wxString &aPage, const wxString &aParentPage=wxEmptyString)
Describe the page size and margins of a paper page on which to eventually print or plot.
DISPLAY_OPTIONS m_Display
EDA_ANGLE m_RotationAngle
ARC_EDIT_MODE m_ArcEditMode
Gather all the actions that are shared by tools.
static TOOL_ACTION toggleHV45Mode
static TOOL_ACTION drawRuleArea
static TOOL_ACTION microwaveCreateGap
static TOOL_ACTION drawBezier
static TOOL_ACTION placeText
static TOOL_ACTION drawOrthogonalDimension
static TOOL_ACTION drawRectangle
static TOOL_ACTION padDisplayMode
static TOOL_ACTION placeReferenceImage
static TOOL_ACTION showRatsnest
static TOOL_ACTION showLayersManager
static TOOL_ACTION toggleNetHighlight
static TOOL_ACTION saveSelectionAsDesignBlock
static TOOL_ACTION drawCircle
static TOOL_ACTION routeDiffPair
Activation of the Push and Shove router (differential pair mode)
static TOOL_ACTION tuneDiffPair
static TOOL_ACTION saveToLinkedDesignBlock
static TOOL_ACTION layerChanged
static TOOL_ACTION ddAppendBoard
Drag and drop.
static TOOL_ACTION highlightNet
static TOOL_ACTION autoTrackWidth
static TOOL_ACTION drawTable
static TOOL_ACTION drawTextBox
static TOOL_ACTION routerHighlightMode
Actions to enable switching modes via hotkey assignments.
static TOOL_ACTION routerWalkaroundMode
static TOOL_ACTION routerShoveMode
static TOOL_ACTION drawZoneCutout
static TOOL_ACTION drawPolygon
static TOOL_ACTION hideNetInRatsnest
static TOOL_ACTION zoneDisplayFilled
static TOOL_ACTION showNetInRatsnest
static TOOL_ACTION drawRadialDimension
static TOOL_ACTION tuneSingleTrack
static TOOL_ACTION viaDisplayMode
static TOOL_ACTION drawLeader
static TOOL_ACTION saveBoardAsDesignBlock
static TOOL_ACTION drillOrigin
static TOOL_ACTION tuneSkew
static TOOL_ACTION trackDisplayMode
static TOOL_ACTION showNetInspector
static TOOL_ACTION microwaveCreateStubArc
static TOOL_ACTION zoneDisplayTriangulated
static TOOL_ACTION placeDesignBlock
static TOOL_ACTION selectUnconnected
Select unconnected footprints from ratsnest of selection.
static TOOL_ACTION zoneDisplayFractured
static TOOL_ACTION drawVia
static TOOL_ACTION drawArc
static TOOL_ACTION zoneDuplicate
Duplicate zone onto another layer.
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
static TOOL_ACTION drawSimilarZone
static TOOL_ACTION showDesignBlockPanel
static TOOL_ACTION drawCenterDimension
static TOOL_ACTION selectSameSheet
Select all components on the same sheet as the selected footprint.
static TOOL_ACTION microwaveCreateStub
static TOOL_ACTION selectNet
Select all connections belonging to a single net.
static TOOL_ACTION microwaveCreateLine
static TOOL_ACTION flipBoard
static TOOL_ACTION zoneDisplayOutline
static TOOL_ACTION ratsnestLineMode
static TOOL_ACTION textOutlines
Display texts as lines.
static TOOL_ACTION highlightNetSelection
static TOOL_ACTION microwaveCreateFunctionShape
static TOOL_ACTION zoneMerge
static TOOL_ACTION unlock
static TOOL_ACTION placeFootprint
static TOOL_ACTION routeSingleTrack
Activation of the Push and Shove router.
static TOOL_ACTION createArray
Tool for creating an array of objects.
static TOOL_ACTION deselectNet
Remove all connections belonging to a single net from the active selection.
static TOOL_ACTION showPythonConsole
static TOOL_ACTION drawLine
static TOOL_ACTION placeLinkedDesignBlock
static TOOL_ACTION localRatsnestTool
static TOOL_ACTION drawAlignedDimension
static TOOL_ACTION drawZone
static TOOL_ACTION selectOnSchematic
Select symbols/pins on schematic corresponding to selected footprints/pads.
Common, abstract interface for edit frames.
void ShowTextPropertiesDialog(PCB_TEXT *aText)
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
void doCloseWindow() override
int ShowTextBoxPropertiesDialog(PCB_TEXTBOX *aTextBox)
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
PCB_LAYER_BOX_SELECTOR * m_SelLayerBox
virtual void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
std::unique_ptr< LAYER_PAIR_SETTINGS > m_layerPairSettings
APPEARANCE_CONTROLS * GetAppearancePanel()
APPEARANCE_CONTROLS * m_appearancePanel
void ShowReferenceImagePropertiesDialog(BOARD_ITEM *aBitmap)
Set the angle used for rotate operations.
PANEL_SELECTION_FILTER * m_selectionFilterPanel
void ShowGraphicItemPropertiesDialog(PCB_SHAPE *aShape)
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
void ShowPadPropertiesDialog(PAD *aPad)
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual PCB_LAYER_ID GetActiveLayer() const
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
virtual MAGNETIC_SETTINGS * GetMagneticItemsSettings()
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Return the BOARD_DESIGN_SETTINGS for the open project.
void PlaceFootprint(FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
Place aFootprint at the current cursor position and updates footprint coordinates with the new positi...
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
Handle actions that are shared between different frames in PcbNew.
Handle design block actions in the PCB editor.
double m_ZoneOpacity
Opacity override for filled zone areas.
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
void UpdateColors()
Update the color settings in the painter and GAL.
void SetDrawingSheet(DS_PROXY_VIEW_ITEM *aDrawingSheet)
Sets (or updates) drawing-sheet used by the draw panel.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void SyncLayersVisibility(const BOARD *aBoard)
Update "visibility" property of each layer of a given BOARD.
virtual void SetHighContrastLayer(int aLayer) override
SetHighContrastLayer(), with some extra smarts for PCB.
void RedrawRatsnest()
Return the bounding box of the view that should be used if model is not valid.
Group generic conditions for PCB editor states.
SELECTION_CONDITION PadFillDisplay()
Create a functor that tests if the frame fills the pads.
SELECTION_CONDITION TrackFillDisplay()
Create a functor that tests if the frame fills tracks.
SELECTION_CONDITION HasItems()
Create a functor that tests if there are items in the board.
SELECTION_CONDITION GraphicsFillDisplay()
Create a functor that tests if the frame fills graphics items.
SELECTION_CONDITION ZoneDisplayMode(ZONE_DISPLAY_MODE aMode)
Create a functor that tests the current zone display mode in the frame.
SELECTION_CONDITION ViaFillDisplay()
Create a functor that tests if the frame fills vias.
SELECTION_CONDITION Get45degMode()
Create a functor that tests whether only 45 degree lines should be allowed.
SELECTION_CONDITION TextFillDisplay()
Create a functor that tests if the frame fills text items.
The main frame for Pcbnew.
void HardRedraw() override
Rebuild the GAL and redraws the screen.
void OnDisplayOptionsChanged() override
void OnEditItemRequest(BOARD_ITEM *aItem) override
Install the corresponding dialog editor for the given item.
void ShowBoardSetupDialog(const wxString &aInitialPage=wxEmptyString)
void SetLastPath(LAST_PATH_TYPE aType, const wxString &aLastPath)
Set the path of the last file successfully read.
void FindNext(bool reverse=false)
Find the next item using our existing search parameters.
void ResolveDRCExclusions(bool aCreateMarkers)
If aCreateMarkers then create DRC exclusion markers from the serialized data.
void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void SetActiveLayer(PCB_LAYER_ID aLayer) override
Change the currently active layer to aLayer and also update the APPEARANCE_CONTROLS.
void OnModify() override
Must be called after a board change to set the modified flag.
void ThemeChanged() override
Called when light/dark theme is changed.
void SwitchLayer(PCB_LAYER_ID layer) override
Change the active layer in the editor.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void SetElementVisibility(GAL_LAYER_ID aElement, bool aNewState)
Change the visibility of an element category.
DIALOG_BOOK_REPORTER * m_inspectDrcErrorDlg
void OnClearFileHistory(wxCommandEvent &aEvent)
std::unique_ptr< GRID_HELPER > MakeGridHelper() override
virtual ~PCB_EDIT_FRAME()
void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
Switch currently used canvas (Cairo / OpenGL).
void CommonSettingsChanged(int aFlags) override
Called after the preferences dialog is run.
BOARD_ITEM_CONTAINER * GetModel() const override
DIALOG_BOOK_REPORTER * GetInspectDrcErrorDialog()
void ShowTargetOptionsDialog(PCB_TARGET *aTarget)
void ExchangeFootprint(FOOTPRINT *aExisting, FOOTPRINT *aNew, BOARD_COMMIT &aCommit, bool deleteExtraTexts=true, bool resetTextLayers=true, bool resetTextEffects=true, bool resetFabricationAttrs=true, bool resetTextContent=true, bool resetClearanceOverrides=true, bool reset3DModels=true, bool *aUpdated=nullptr)
Replace aExisting footprint by aNew footprint using the Existing footprint settings (position,...
DIALOG_FIND * m_findDialog
DIALOG_BOOK_REPORTER * m_inspectConstraintsDlg
void SetPageSettings(const PAGE_INFO &aPageSettings) override
bool IsElementVisible(GAL_LAYER_ID aElement) const
Test whether a given element category is visible.
bool CanAcceptApiCommands() override
Check if this frame is ready to accept API commands.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
void SetGridColor(const COLOR4D &aColor) override
void ProjectChanged() override
Notification event that the project has changed.
wxString GetLastPath(LAST_PATH_TYPE aType)
Get the last path for a particular type.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
void doCloseWindow() override
void ReCreateLayerBox(bool aForceResizeToolbar=true)
Recreate the layer box by clearing the old list and building a new one from the new layer names and c...
void SaveProjectLocalSettings() override
Save changes to the project local settings.
void PythonSyncProjectName()
Synchronize the project name from KiCad's environment into the Python interpreter.
bool m_show_layer_manager_tools
void ShowFindDialog()
Show the Find dialog.
void onSize(wxSizeEvent &aEvent)
int ShowExchangeFootprintsDialog(FOOTPRINT *aFootprint, bool aUpdateMode, bool aSelectedMode)
int TestStandalone()
Test if standalone mode.
void ShowFootprintPropertiesDialog(FOOTPRINT *aFootprint)
bool IsContentModified() const override
Get if the current board has been modified but not saved.
void PythonSyncEnvironmentVariables()
Synchronize the environment variables from KiCad's environment into the Python interpreter.
bool Clear_Pcb(bool doAskAboutUnsavedChanges, bool aFinal=false)
Delete all and reinitialize the current board.
TOOL_ACTION * m_exportNetlistAction
The export board netlist tool action object.
void OnBoardLoaded()
Update the state of the GUI after a new board is loaded or created.
void Edit_Zone_Params(ZONE *zone_container)
Edit params (layer, clearance, ...) for a zone outline.
bool m_show_net_inspector
bool FetchNetlistFromSchematic(NETLIST &aNetlist, const wxString &aAnnotateMessage)
wxString GetCurrentFileName() const override
Get the full filename + path of the currently opened file in the frame.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
DIALOG_BOOK_REPORTER * GetFootprintDiffDialog()
EDA_ANGLE GetRotationAngle() const override
Return the angle used for rotate operations.
COLOR4D GetGridColor() override
void UpdateTitle()
Set the main window title bar text.
DIALOG_BOOK_REPORTER * m_footprintDiffDlg
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
void OnQuit(wxCommandEvent &event)
void onCloseModelessBookReporterDialogs(wxCommandEvent &aEvent)
PCB_DESIGN_BLOCK_PANE * m_designBlocksPane
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
DIALOG_BOARD_SETUP * m_boardSetupDlg
DIALOG_BOOK_REPORTER * GetInspectClearanceDialog()
wxTimer * m_eventCounterTimer
void Tracks_and_Vias_Size_Event(wxCommandEvent &event)
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
static const wxString SearchPaneName()
DIALOG_BOOK_REPORTER * m_inspectClearanceDlg
void OnFileHistory(wxCommandEvent &event)
DIALOG_BOOK_REPORTER * GetInspectConstraintsDialog()
A set of BOARD_ITEMs (i.e., without duplicates).
PCB net inspection panel.
Tool that displays edit points allowing to modify items by dragging the points.
PCB_LAYER_ID m_Route_Layer_TOP
PCB_LAYER_ID m_Route_Layer_BOTTOM
static bool HasUnlockedItems(const SELECTION &aSelection)
Test if any selected items are unlocked.
static bool HasLockedItems(const SELECTION &aSelection)
Test if any selected items are locked.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
virtual ENV_VAR_MAP & GetLocalEnvVariables() const
virtual const wxString & GetExecutablePath() const
A progress reporter interface for use in multi-threaded environments.
The backing store for a PROJECT, in JSON format.
std::vector< LAYER_PAIR_INFO > m_LayerPairInfos
List of stored 3D viewports (view matrixes)
The project local settings are things that are attached to a particular project, but also might be pa...
wxString m_ActiveLayerPreset
The name of a LAYER_PRESET that is currently activated (or blank if none)
PCB_LAYER_ID m_ActiveLayer
The current (active) board layer for editing.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
void IncrementNetclassesTicker()
virtual PROJECT_FILE & GetProjectFile() const
void IncrementTextVarsTicker()
float SplitterProportion() const
static SELECTION_CONDITION HasTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if among the selected items there is at least one of a given types.
static bool NotEmpty(const SELECTION &aSelection)
Test if there are any items selected.
static SELECTION_CONDITION MoreThan(int aNumber)
Create a functor that tests if the number of selected items is greater than the value given as parame...
static bool Idle(const SELECTION &aSelection)
Test if there no items selected or being edited.
static SELECTION_CONDITION Count(int aNumber)
Create a functor that tests if the number of selected items is equal to the value given as parameter.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
static SELECTION_CONDITION OnlyTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if the selected items are only of given types.
int Size() const
Returns the number of selected parts.
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
A modified version of the wxInfoBar class that allows us to:
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
@ OUTDATED_SAVE
OUTDATED_SAVE Messages that should be cleared on save.
@ GENERIC
GENERIC Are messages that do not have special handling.
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Handle a list of polygons defining a copper zone.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
#define DIALOG_DRC_WINDOW_NAME
Declaration of the eda_3d_viewer class.
static constexpr EDA_ANGLE ANGLE_90
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define PCB_EDIT_FRAME_NAME
@ FRAME_FOOTPRINT_CHOOSER
bool m_ShowEventCounters
Shows debugging event counters in various places.
static const std::string LegacySchematicFileExtension
static const std::string LegacyPcbFileExtension
static const std::string KiCadSchematicFileExtension
static const std::string AutoSaveFilePrefix
static const std::string KiCadPcbFileExtension
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
const wxChar *const traceApi
Flag to enable debug output related to the IPC API and its plugin system.
@ ID_EDA_SOCKET_EVENT_SERV
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
int GetNetnameLayer(int aLayer)
Return a netname layer corresponding to the given layer.
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored).
#define CLEARANCE_LAYER_FOR(boardLayer)
PCB_LAYER_ID
A quick note on layer IDs:
@ REPAINT
Item needs to be redrawn.
@ ALL
All except INITIAL_ADD.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
@ RM_MarkObstacles
Ignore collisions, mark obstacles.
@ RM_Walkaround
Only walk around.
static void processTextItem(const PCB_TEXT &aSrc, PCB_TEXT &aDest, bool aResetText, bool aResetTextLayers, bool aResetTextEffects, bool *aUpdated)
copy text settings from aSrc to aDest
#define FOOTPRINT_DIFF_DIALOG_NAME
static PCB_TEXT * getMatchingTextItem(PCB_TEXT *aRefItem, FOOTPRINT *aFootprint)
EVT_MENU_RANGE(ID_POPUP_PCB_SELECT_WIDTH_START_RANGE, ID_POPUP_PCB_SELECT_WIDTH_END_RANGE, PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event) EVT_UPDATE_UI_RANGE(ID_POPUP_PCB_SELECT_WIDTH1
ID_POPUP_PCB_SELECT_WIDTH8
#define INSPECT_CLEARANCE_DIALOG_NAME
PCB_EDIT_FRAME::OnUpdateSelectTrackWidth EVT_UPDATE_UI_RANGE(ID_POPUP_PCB_SELECT_VIASIZE1, ID_POPUP_PCB_SELECT_VIASIZE8, PCB_EDIT_FRAME::OnUpdateSelectViaSize) PCB_EDIT_FRAME
#define INSPECT_DRC_ERROR_DIALOG_NAME
#define INSPECT_CONSTRAINTS_DIALOG_NAME
@ ID_POPUP_PCB_SELECT_WIDTH_START_RANGE
@ ID_POPUP_PCB_SELECT_WIDTH1
@ ID_POPUP_PCB_SELECT_VIASIZE8
@ ID_AUX_TOOLBAR_PCB_VIA_SIZE
@ ID_POPUP_PCB_SELECT_WIDTH_END_RANGE
@ ID_POPUP_PCB_SELECT_VIASIZE1
@ ID_AUX_TOOLBAR_PCB_TRACK_WIDTH
void ScriptingOnDestructPcbEditFrame(PCB_EDIT_FRAME *aPcbEditFrame)
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
PGM_BASE & Pgm()
The global program "get" accessor.
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
LAST_PATH_TYPE
For storing PcbNew MRU paths of various types.
#define CURRENT_TOOL(action)
std::function< bool(const SELECTION &)> SELECTION_CONDITION
Functor type that checks a specific condition for selected items.
KIWAY Kiway(KFCTL_STANDALONE)
wxString UnescapeString(const wxString &aSource)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
A min-max version of BOX2 for fast intersection checking.
bool Intersects(const BOX2I_MINMAX &aOther) const
constexpr int mmToIU(double mm) const
A filename or source description, a problem input line, a line number, a byte offset,...
float properties_splitter
int properties_panel_width
int design_blocks_panel_float_height
bool appearance_expand_layer_display
bool appearance_expand_net_display
int design_blocks_panel_docked_width
int search_panel_dock_direction
int design_blocks_panel_float_width
bool m_DisplayRatsnestLinesCurved
bool m_ShowGlobalRatsnest
wxLogTrace helper definitions.
@ 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_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_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
Definition of file extensions used in Kicad.
void SetAuiPaneSize(wxAuiManager &aManager, wxAuiPaneInfo &aPane, int aWidth, int aHeight)
Sets the size of an AUI pane, working around http://trac.wxwidgets.org/ticket/13180.
WX_VIEW_CONTROLS class definition.