25#include <unordered_map>
26#include <unordered_set>
30#include <wx/filename.h>
31#include <wx/filedlg.h>
32#include <wx/hyperlink.h>
34#include <wx/wupdlock.h>
168using namespace std::placeholders;
173#define INSPECT_DRC_ERROR_DIALOG_NAME wxT( "InspectDrcErrorDialog" )
174#define INSPECT_CLEARANCE_DIALOG_NAME wxT( "InspectClearanceDialog" )
175#define INSPECT_CONSTRAINTS_DIALOG_NAME wxT( "InspectConstraintsDialog" )
176#define FOOTPRINT_DIFF_DIALOG_NAME wxT( "FootprintDiffDialog" )
220 m_exportNetlistAction(
nullptr ),
221 m_findDialog(
nullptr ),
222 m_findByPropertiesDialog(
nullptr ),
223 m_inspectDrcErrorDlg(
nullptr ),
224 m_inspectClearanceDlg(
nullptr ),
225 m_inspectConstraintsDlg(
nullptr ),
226 m_footprintDiffDlg(
nullptr ),
227 m_boardSetupDlg(
nullptr ),
228 m_footprintFieldsTableDialog(
nullptr ),
229 m_designBlocksPane(
nullptr ),
230 m_importProperties(
nullptr ),
231 m_eventCounterTimer(
nullptr )
233 m_maximizeByDefault =
true;
234 m_showBorderAndTitleBlock =
true;
235 m_SelTrackWidthBox =
nullptr;
236 m_SelViaSizeBox =
nullptr;
237 m_SelViaStackBox =
nullptr;
238 m_CurrentVariantCtrl =
nullptr;
239 m_ShowLayerManagerTools =
true;
240 m_supportsAutoSave =
true;
241 m_ProbingSchToPcb =
false;
242 m_ShowSearch =
false;
243 m_ShowNetInspector =
false;
245 m_crossProbeFlashTimer.SetOwner(
this );
250 m_ZoneFillsDirty =
true;
252 m_aboutTitle =
_HKI(
"KiCad PCB Editor" );
257 m_exportNetlistAction =
new TOOL_ACTION(
"pcbnew.EditorControl.exportNetlist",
259 _(
"Export netlist used to update schematics" ) );
264 GetGalDisplayOptions(),
268 SetBoard(
new BOARD() );
271 wxIconBundle icon_bundle;
274 icon_bundle.AddIcon( icon );
276 icon_bundle.AddIcon( icon );
278 icon_bundle.AddIcon( icon );
280 icon_bundle.AddIcon( icon );
282 icon_bundle.AddIcon( icon );
284 SetIcons( icon_bundle );
293 GetScreen()->m_Center =
false;
301 PrepareLayerIndicator(
true );
324 m_auimgr.SetManagedWindow(
this );
331 m_loadNoticeInfoBar =
new WX_INFOBAR( GetToolCanvas(), wxID_ANY,
true );
333 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
334#if !defined( _WIN32 )
337 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
339 m_auimgr.SetFlags( auiFlags );
342 m_auimgr.AddPane( m_tbTopMain,
EDA_PANE().HToolbar().Name( wxS(
"TopMainToolbar" ) )
344 m_auimgr.AddPane( m_tbTopAux,
EDA_PANE().HToolbar().Name( wxS(
"TopAuxToolbar" ) )
346 m_auimgr.AddPane( m_messagePanel,
EDA_PANE().Messages().Name( wxS(
"MsgPanel" ) )
347 .Bottom().Layer( 6 ) );
350 m_auimgr.AddPane( m_tbLeft,
EDA_PANE().VToolbar().Name( wxS(
"LeftToolbar" ) )
351 .Left().Layer( 3 ) );
353 m_auimgr.AddPane( m_tbRight,
EDA_PANE().VToolbar().Name( wxS(
"RightToolbar" ) )
354 .Right().Layer( 3 ) );
356 m_auimgr.AddPane( m_appearancePanel,
EDA_PANE().Name( wxS(
"LayersManager" ) )
358 .Caption(
_(
"Appearance" ) ).PaneBorder(
false )
360 .MinSize( m_appearancePanel->GetMinSize().x, FromDIP( 60 ) )
363 .BestSize( m_appearancePanel->GetMinSize().x, -1 )
365 .BestSize( m_appearancePanel->GetBestSize().x, -1 )
367 .FloatingSize( m_appearancePanel->GetBestSize() )
368 .CloseButton(
false ) );
370 m_auimgr.AddPane( m_selectionFilterPanel,
EDA_PANE().Name( wxS(
"SelectionFilter" ) )
371 .Right().Layer( 4 ).Position( 2 )
372 .Caption(
_(
"Selection Filter" ) ).PaneBorder(
false )
374 .MinSize( m_selectionFilterPanel->GetMinSize().x, -1 )
375 .BestSize( m_selectionFilterPanel->GetBestSize().x, -1 )
376 .FloatingSize( m_selectionFilterPanel->GetBestSize() )
377 .CloseButton(
false ) );
379 m_auimgr.AddPane( m_designBlocksPane,
EDA_PANE().Name( DesignBlocksPaneName() )
381 .Caption(
_(
"Design Blocks" ) )
382 .CaptionVisible(
true )
384 .TopDockable(
false )
385 .BottomDockable(
false )
387 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
388 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
389 .FloatingSize( FromDIP( wxSize( 800, 600 ) ) )
390 .FloatingPosition( FromDIP( wxPoint( 50, 200 ) ) )
393 m_auimgr.AddPane( m_propertiesPanel,
EDA_PANE().Name( PropertiesPaneName() )
395 .Caption(
_(
"Properties" ) ).PaneBorder(
false )
396 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
397 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
398 .FloatingSize( wxSize( 300, 200 ) )
399 .CloseButton(
true ) );
402 m_auimgr.AddPane( GetCanvas(),
EDA_PANE().Canvas().Name( wxS(
"DrawFrame" ) )
405 m_auimgr.AddPane( m_netInspectorPanel,
EDA_PANE().Name( NetInspectorPanelName() )
407 .Caption(
_(
"Net Inspector" ) )
409 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
410 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
411 .FloatingSize( wxSize( 300, 200 ) )
412 .CloseButton(
true ) );
414 m_auimgr.AddPane( m_searchPane,
EDA_PANE().Name( SearchPaneName() )
416 .Caption(
_(
"Search" ) ).PaneBorder(
false )
417 .MinSize( FromDIP( wxSize ( 180, 60 ) ) )
418 .BestSize( FromDIP( wxSize ( 180, 100 ) ) )
419 .FloatingSize( FromDIP( wxSize( 480, 200 ) ) )
420 .DestroyOnClose(
false )
421 .CloseButton(
true ) );
423 m_auimgr.AddPane( m_constraintsPanel,
EDA_PANE().Name( ConstraintsPaneName() )
425 .Caption(
_(
"Geometric Constraints" ) ).PaneBorder(
false )
426 .MinSize( FromDIP( wxSize( 360, 120 ) ) )
427 .BestSize( FromDIP( wxSize( 600, 200 ) ) )
428 .FloatingSize( FromDIP( wxSize( 600, 240 ) ) )
429 .DestroyOnClose(
false )
433 m_auimgr.AddPane( m_gitCommitPane,
435 .Name( GitCommitPaneName() )
438 .Caption(
_(
"Version Control" ) )
440 .MinSize( wxSize( m_gitCommitPane->GetMinDockWidth(), FromDIP( 120 ) ) )
441 .BestSize( wxSize( std::max( m_gitCommitPane->GetMinDockWidth(), FromDIP( 300 ) ),
443 .FloatingSize( FromDIP( wxSize( 300, 400 ) ) )
444 .DestroyOnClose(
false )
451 m_auimgr.GetPane( GitCommitPaneName() ).min_size.x = m_gitCommitPane->GetMinDockWidth();
453 m_auimgr.GetPane(
"LayersManager" ).Show( m_ShowLayerManagerTools );
454 m_auimgr.GetPane(
"SelectionFilter" ).Show( m_ShowLayerManagerTools );
455 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.show_properties );
456 m_auimgr.GetPane( NetInspectorPanelName() ).Show( m_ShowNetInspector );
457 m_auimgr.GetPane( SearchPaneName() ).Show( m_ShowSearch );
458 m_auimgr.GetPane( DesignBlocksPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.design_blocks_show );
459 m_auimgr.GetPane( GitCommitPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.show_git_commit_pane );
461 wxAuiPaneInfo& selectionFilterPane = m_auimgr.GetPane( wxS(
"SelectionFilter" ) );
464 selectionFilterPane.dock_proportion = 0;
467 selectionFilterPane.min_size.y = m_selectionFilterPanel->GetBestSize().y;
468 FinishAUIInitialization();
472 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( wxS(
"LayersManager" ) );
475 wxAuiPaneInfo& designBlocksPane = m_auimgr.GetPane( DesignBlocksPaneName() );
481 wxAuiPaneInfo& propertiesPanel = m_auimgr.GetPane( PropertiesPaneName() );
489 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
497 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
504 m_layerPairSettings = std::make_unique<LAYER_PAIR_SETTINGS>();
506 m_layerPairSettings->Bind( PCB_LAYER_PAIR_PRESETS_CHANGED,
507 [&]( wxCommandEvent& aEvt )
510 std::span<const LAYER_PAIR_INFO> newPairInfos = m_layerPairSettings->GetLayerPairs();
512 newPairInfos.end() };
515 m_layerPairSettings->Bind( PCB_CURRENT_LAYER_PAIR_CHANGED,
516 [&]( wxCommandEvent& aEvt )
518 const LAYER_PAIR& layerPair = m_layerPairSettings->GetCurrentLayerPair();
525 PrepareLayerIndicator();
531 [
this]( wxIdleEvent& aEvent )
533 BOX2D viewport = GetCanvas()->GetView()->GetViewport();
535 if( viewport != m_lastNetnamesViewport )
538 m_lastNetnamesViewport = viewport;
539 m_lastNetnamesScale = GetCanvas()->GetView()->GetScale();
552 m_toolManager->GetTool<
DRC_TOOL>()->GetDRCEngine()->InitEngine( wxFileName() );
561 m_apiHandler = std::make_unique<API_HANDLER_PCB>(
this );
566 m_apiHandlerCommon = std::make_unique<API_HANDLER_COMMON>();
582 if( strK2S.Find( wxT(
"pcbnew.app" ) ) != wxNOT_FOUND )
585 strK2S += wxT(
"../../" );
588 strK2S += wxT(
"Contents/MacOS/" );
591 wxFileName appK2S( strK2S, wxT(
"kicad2step" ) );
594 appK2S.SetExt( wxT(
"exe" ) );
609 m_appearancePanel->OnBoardChanged();
619 UpdateToolbarControlSizes();
627 m_eventCounterTimer =
new wxTimer(
this );
630 [&]( wxTimerEvent& aEvent )
632 GetCanvas()->m_PaintEventCounter->Show();
633 GetCanvas()->m_PaintEventCounter->Reset();
641 m_eventCounterTimer->GetId() );
643 m_eventCounterTimer->Start( 1000 );
653 DragAcceptFiles(
true );
664 wxLogTrace(
traceCrossProbeFlash,
"StartCrossProbeFlash(PCB): aborted (setting disabled) items=%zu",
679 if( item->IsMoving() )
682 "StartCrossProbeFlash(PCB): aborted (items are moving)" );
689 wxLogTrace(
traceCrossProbeFlash,
"StartCrossProbeFlash(PCB): restarting existing flash (phase=%d)",
694 wxLogTrace(
traceCrossProbeFlash,
"StartCrossProbeFlash(PCB): starting with %zu items", aItems.size() );
737 if( item->IsMoving() )
828 drcDlg->Close(
true );
833 ruleEditorDlg->Close(
true );
859 bool show = !pane.IsShown();
874 sheet->AttachToTracker(
nullptr );
892 m_pcb->ClearProject();
900 if( aBuildConnectivity )
949 BOX2D reach = viewport;
955 return IsNetnameLayer( aLayer );
959 PCB_TRACK* track = dynamic_cast<PCB_TRACK*>( aItem );
961 if( !track || track->Type() == PCB_VIA_T )
964 const double lod = track->ViewGetLOD( aLayer, view );
966 const BOX2I bbox = track->GetBoundingBox();
968 if( lod < m_lastNetnamesScale && before.Contains( bbox ) && now.Contains( bbox ) )
971 return lod < view->GetScale();
1005 &
m_pcb->GetPageSettings(),
1006 m_pcb->GetProject(),
1007 &
m_pcb->GetTitleBlock(),
1008 &
m_pcb->GetProperties() );
1019 if( screen !=
nullptr )
1028 wxString currentVariant =
board->GetCurrentVariant();
1029 wxString variantDesc =
board->GetVariantDescription( currentVariant );
1073 if( aDep == current )
1083 text->ClearRenderCache();
1084 text->ClearBoundingBoxCache();
1160 pcbTool->SetIsBoardEditor(
true );
1191 auto groupWithDesignBlockLink =
1194 if( aSel.Size() != 1 )
1202 return group->HasDesignBlockLink();
1207#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1208#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1262 auto enableZoneControlCondition =
1270 ENABLE( enableZoneControlCondition )
1273 ENABLE( enableZoneControlCondition )
1276 ENABLE( enableZoneControlCondition )
1279 ENABLE( enableZoneControlCondition )
1284 auto autoConstraintsCond =
1293 auto boardFlippedCond =
1299 auto layerManagerCond =
1305 auto propertiesCond =
1311 auto netInspectorCond =
1317 auto searchPaneCond =
1323 auto constraintsPaneCond =
1329 auto designBlockCond =
1335 auto gitCommitPaneCond =
1341 auto highContrastCond =
1347 auto globalRatsnestCond =
1354 auto curvedRatsnestCond =
1361 auto netHighlightCond =
1371 return !settings->GetHighlightNetCodes().empty();
1379 auto enableNetHighlightCond =
1392 .Enable( enableNetHighlightCond ) );
1403 const auto isArcKeepCenterMode =
1410 const auto isArcKeepEndpointMode =
1417 const auto isArcKeepRadiusMode =
1428 auto isHighlightMode =
1442 auto isWalkaroundMode =
1453 auto isAutoTrackWidth =
1468 if( bci->GetNetCode() > 0 )
1476 auto connectedOrFootprintCond =
1503 static const std::vector<KICAD_T> zoneTypes = {
PCB_ZONE_T };
1527#define CURRENT_TOOL( action ) mgr->SetConditions( action, CHECK( cond.CurrentTool( action ) ) )
1542#define CURRENT_EDIT_TOOL( action ) \
1543 mgr->SetConditions( action, ACTION_CONDITIONS().Check( cond.CurrentTool( action ) ) \
1544 .Enable( isDRCIdle ) )
1611#undef CURRENT_EDIT_TOOL
1620 if( event.GetId() == wxID_EXIT )
1623 if( event.GetId() == wxID_CLOSE ||
Kiface().IsSingle() )
1635 marker->GetRCItem()->SetItems(
GetCanvas()->GetDrawingSheet() );
1637 commit.
Add( marker );
1663 if( zoneFillerTool->
IsBusy() )
1668 reporter->ShowWithEffect( wxSHOW_EFFECT_EXPAND );
1677 if( chooser && chooser->
IsModal() )
1680 if(
Kiface().IsSingle() )
1687 bool cancel = !fpEditor->Close();
1699 if( fpViewer && !fpViewer->Close() )
1725 wxString msg =
_(
"Save changes to '%s' before closing?" );
1727 wxSafeYield(
this,
true );
1744 if( !projPath.IsEmpty() &&
Kiway().LocalHistory().HistoryExists( projPath ) )
1747 wxS(
"Discard unsaved pcb changes" ) );
1768 GetCanvas()->SetEvtHandlerEnabled(
false );
1782 drcDlg->Close(
true );
1787 ruleEditorDlg->Close(
true );
1840 if(
Prj().GetLocalSettings().ShouldAutoSave() )
1847 wxLogTrace(
traceAutoSave, wxT(
"Skipping auto-save of migrated local settings" ) );
1854 m_auimgr.GetPane( wxS(
"LayersManager" ) ).Show(
false );
1855 m_auimgr.GetPane( wxS(
"TabbedPanel" ) ).Show(
false );
1885 board->RefreshDrillSymbolLayers();
1890 view->
Update( track, aUpdateFlags );
1895 for(
PAD*
pad : footprint->Pads() )
1897 if(
pad->HasHole() )
1908 static std::mutex dialogMutex;
1910 std::unique_lock<std::mutex> dialogLock( dialogMutex, std::try_to_lock );
1913 if( !dialogLock.owns_lock() )
1928 if( !aInitialPage.IsEmpty() )
1942 if( !
GetBoard()->SynchronizeComponentClasses( std::unordered_set<wxString>() ) )
1946 m_infoBar->ShowMessage(
_(
"Could not load component class assignment rules" ), wxICON_WARNING,
1947 WX_INFOBAR::MESSAGE_TYPE::GENERIC );
1961 adapter->Tracker().InvalidateProjectScoped();
1981 if( (
GetBoard()->GetVisibleLayers() & maskAndPasteLayers ).
any() )
1999 if(
text->HasTextVars() )
2001 text->ClearRenderCache();
2002 text->ClearBoundingBoxCache();
2098 if( designBlocksPane.IsDocked() )
2139 if( oldLayer == aLayer && !aForceRedraw )
2168 const auto getClearanceLayerForActive =
2174 return std::nullopt;
2177 if( std::optional<int> oldClearanceLayer = getClearanceLayerForActive( oldLayer ) )
2180 if( std::optional<int> newClearanceLayer = getClearanceLayerForActive( aLayer ) )
2196 wxFileName fn(
GetBoard()->GetFileName() );
2209 layerEnum.
Map( layer,
GetBoard()->GetLayerName( layer ) );
2239 wxString msg =
_(
"WRL 3D model could not be matched to equivalent STEP model." );
2241 if( unresolved > 1 )
2243 msg = wxString::Format(
_(
"%d WRL 3D models could not be matched to equivalent STEP models." ),
2249 [
this]( wxHyperlinkEvent& )
2267 if( fn.FileExists() && !fn.IsFileWritable() )
2271 m_infoBar->ShowMessage(
_(
"Board file is read only." ), wxICON_WARNING,
2272 WX_INFOBAR::MESSAGE_TYPE::OUTDATED_SAVE );
2317 for(
PAD*
pad : footprint->Pads() )
2331 SetStatusText( wxEmptyString );
2380 if(
project.m_PcbLastPath[ aType ].IsEmpty() )
2381 return wxEmptyString;
2383 wxFileName absoluteFileName =
project.m_PcbLastPath[ aType ];
2386 absoluteFileName.MakeAbsolute( pcbFileName.GetPath() );
2387 return absoluteFileName.GetFullPath();
2395 wxFileName relativeFileName = aLastPath;
2398 relativeFileName.MakeRelativeTo( pcbFileName.GetPath() );
2400 if( relativeFileName.GetFullPath() !=
project.m_PcbLastPath[ aType ] )
2402 project.m_PcbLastPath[ aType ] = relativeFileName.GetFullPath();
2423 if( !GetTitle().StartsWith( wxT(
"*" ) ) )
2436 connectivity->RecalculateRatsnest(
nullptr );
2439 std::vector<MSG_PANEL_ITEM> msg_list;
2448 bool readOnly =
false;
2449 bool unsaved =
false;
2451 if( fn.IsOk() && fn.FileExists() )
2452 readOnly = !fn.IsFileWritable();
2461 title += fn.GetName();
2464 title += wxS(
" " ) +
_(
"[Read Only]" );
2467 title += wxS(
" " ) +
_(
"[Unsaved]" );
2469 title += wxT(
" \u2014 " ) +
_(
"PCB Editor" );
2508 layerEnum.
Map( layer,
GetBoard()->GetLayerName( layer ) );
2539 wxString findString;
2547 switch( front->
Type() )
2557 if( findString.Contains( wxT(
"\n" ) ) )
2558 findString = findString.Before(
'\n' );
2608 if(
Kiface().IsSingle() )
2620 if( !frame->IsShownOnScreen() )
2622 wxEventBlocker blocker(
this );
2627 if( !fn.FileExists() )
2631 if( !fn.FileExists() )
2642 frame->Show(
true );
2656 if( standalone == 0 )
2658 DisplayErrorMessage(
this,
_(
"Cannot update the PCB because PCB editor is opened in stand-alone mode. "
2659 "In order to create or update PCBs from schematics, you must launch the "
2660 "KiCad project manager and create a project." ) );
2664 if( standalone < 0 )
2669 std::string payload( aAnnotateMessage );
2679 if( schFrame->IsIconized() )
2680 schFrame->Iconize(
false );
2686 if( wxWindow::FindFocus() != schFrame )
2687 schFrame->SetFocus();
2693 if( payload == aAnnotateMessage )
2711 wxString extra_info = e.
Problem() + wxT(
" : " ) + e.
What() + wxT(
" at " ) + e.
Where();
2713 DisplayErrorMessage(
this,
_(
"Received an error while reading netlist. Please report this issue to "
2714 "the KiCad team using the menu Help->Report Bug." ),
2725 if( aFootprint ==
nullptr )
2764 fp_editor->Show(
true );
2775 fp_editor->Show(
true );
2791 bool aSelectedMode )
2821 if( infobar->GetMessageType() == WX_INFOBAR::MESSAGE_TYPE::DRC_RULES_ERROR )
2826 infobar->RemoveAllButtons();
2827 infobar->AddLink(
_(
"Edit design rules" ),
2828 [&]( wxHyperlinkEvent& aEvent )
2832 infobar->AddCloseButton();
2833 infobar->ShowMessage(
_(
"Could not compile custom design rules." ), wxICON_ERROR,
2834 WX_INFOBAR::MESSAGE_TYPE::DRC_RULES_ERROR );
2860 [
this](
const wxString& aProjectPath, std::vector<HISTORY_FILE_DATA>& aFileData )
2902 zoneFillerTool && zoneFillerTool->
IsBusy() )
2946 for(
const auto& [identifier, visible] : cfg->m_Plugins.actions )
2948 if( identifier == aPluginPath )
2954 return aPluginDefault;
2966 return m_auimgr.GetPane( wxS(
"LayersManager" ) ).IsShown();
2987 _(
"Violation Report" ) );
2999 _(
"Clearance Report" ) );
3011 _(
"Constraints Report" ) );
3023 _(
"Compare Footprint with Library" ) );
3040 if( dlg->WasAborted() )
3072 if( aEvent.GetId() == wxID_APPLY )
3086 dialog.ShowQuasiModal();
3104 if( !dlg->Close(
false ) )
3129 wxLogTrace(
traceApi,
"PCB frame: EDA_EVT_PLUGIN_AVAILABILITY_CHANGED" );
3142 if( layer == curLayer )
3149 if( layer >
GetBoard()->GetCopperLayerStackMaxId() )
3165 switch( aItem->
Type() )
3186 DIALOG_TABLE_PROPERTIES dlg(
this,
static_cast<PCB_TABLE*
>( aItem ) );
3189 dlg.ShowQuasiModal();
3197 DIALOG_GENERATED_TABLE_PROPERTIES dlg(
this,
static_cast<PCB_DRILL_CHART*
>( aItem ),
3198 []( wxWindow* aParent )
3200 return new PANEL_DRILL_CHART_OPTIONS( aParent );
3224 DIALOG_DIMENSION_PROPERTIES dlg(
this,
static_cast<PCB_DIMENSION_BASE*
>( aItem ) );
3244 static_cast<EDA_GROUP*
>(
static_cast<PCB_GROUP*
>( aItem ) ) );
3248 static_cast<PCB_GENERATOR*
>( aItem )->ShowPropertiesDialog(
this );
3252 m_toolManager->GetTool<DRC_TOOL>()->CrossProbe(
static_cast<PCB_MARKER*
>( aItem ) );
const KICOMMON_API wxEventTypeTag< wxCommandEvent > EDA_EVT_PLUGIN_AVAILABILITY_CHANGED
Notifies other parts of KiCad when plugin availability changes.
@ KEEP_ENDPOINTS_OR_START_DIRECTION
Whe editing endpoints, the other end remains in place.
@ KEEP_CENTER_ENDS_ADJUST_ANGLE
When editing endpoints, only the angle is adjusted.
@ KEEP_CENTER_ADJUST_ANGLE_RADIUS
When editing endpoints, the angle and radius are adjusted.
constexpr EDA_IU_SCALE pcbIUScale
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
@ NORMAL
Inactive layers are shown normally (no high-contrast mode)
constexpr BOX2I BOX2ISafe(const BOX2D &aInput)
static TOOL_ACTION toggleGrid
static TOOL_ACTION unselectAll
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
static TOOL_ACTION togglePolarCoords
static TOOL_ACTION pluginsReload
static TOOL_ACTION selectSetLasso
static TOOL_ACTION selectSetRect
Set lasso selection mode.
static TOOL_ACTION pasteSpecial
static TOOL_ACTION groupProperties
static TOOL_ACTION pointEditorArcKeepCenter
static TOOL_ACTION ungroup
static TOOL_ACTION toggleBoundingBoxes
static TOOL_ACTION pointEditorArcKeepRadius
static TOOL_ACTION showSearch
static TOOL_ACTION duplicate
static TOOL_ACTION showGitCommitPane
static TOOL_ACTION highContrastMode
static TOOL_ACTION embeddedFiles
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 OnColorThemeChanged()
Update the colors on all the widgets from the new chosen color theme.
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
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 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...
Bridges BOARD's listener stream into the generic TEXT_VAR_TRACKER.
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.
void InitializeClearanceCache()
Initialize the clearance cache for all board items.
void SaveToHistory(const wxString &aProjectPath, std::vector< HISTORY_FILE_DATA > &aFileData)
Serialize board into HISTORY_FILE_DATA for non-blocking history commit.
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.
std::weak_ptr< void > GetHistoryLifetimeToken() const
Liveness token handed to LOCAL_HISTORY::RegisterSaver so a shared autosave timer skips this board's s...
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.
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.
void SynchronizeTuningProfileProperties()
Ensure that all time domain properties providers are in sync with current settings.
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 & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Add a new item to the model.
Handle actions that are shared between different applications.
bool AutosaveUsesLocalHistory() const
The backup format is the single switch that selects the autosave mechanism: the incremental format re...
Dialog that offers to migrate obsolete WRL 3D model references on a loaded board to current STEP mode...
static int AutoMigrateByFilename(PCB_EDIT_FRAME *aFrame)
Silently rewrite unresolvable .wrl/.wrz references to STEP files whose filename stem matches in the s...
static int CountUnresolvedWrlReferences(PCB_EDIT_FRAME *aFrame)
Count of unique unresolvable .wrl/.wrz references on the board (deduplicated by filename).
void InitEngine(const wxFileName &aRulePath)
Initialize the DRC engine.
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 SetVariantName(const std::string &aVariant)
Set the current variant name and description to be shown on the drawing sheet.
void SetVariantDesc(const std::string &aVariantDesc)
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 AttachToTracker(TEXT_VAR_TRACKER *aTracker)
Register this proxy with aTracker as a dependent on every title-block source variable its current tem...
void SetFileName(const std::string &aFileName)
Set the file name displayed in the title block.
virtual bool doAutoSave()
This should be overridden by the derived class to handle the auto save feature.
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.
static const wxString GitCommitPaneName()
Named here rather than beside the editors' other panes, because the project manager docks this one to...
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 RecreateToolbars()
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.
void ReCreateMenuBar()
Recreate the menu bar.
WX_INFOBAR * GetInfoBar()
static std::vector< const PLUGIN_ACTION * > GetOrderedPluginActions(PLUGIN_ACTION_SCOPE aScope, APP_SETTINGS_BASE *aCfg)
Return ordered list of plugin actions for display in the toolbar.
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.
void setArcModeConditions(const TOOL_ACTION &aDrawArc, const std::function< bool(const SELECTION &)> &aEnable)
Check each arc mode's tool action while the arc tool runs in that mode.
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Change the current rendering backend.
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 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
bool IsGitCommitPaneShown()
virtual void UpdateProperties()
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
@ GAL_TYPE_MODERN
RHI implementation, Vulkan or Metal on macOS.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void RequestRefresh()
Make sure a refresh gets done on the next idle event if it hasn't already.
A base class for most all the KiCad significant classes used in schematics and boards.
KICAD_T Type() const
Returns the type of object.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
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 CurrentTool(const TOOL_ACTION &aTool)
Create a functor testing if the specified tool is the current active tool in the frame.
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.
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)
Docked panel for committing: the branch to commit to, a summary and description, the commit options,...
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?
void RegisterHandler(API_HANDLER *aHandler)
Adds a new request handler to the server.
void DeregisterHandler(API_HANDLER *aHandler)
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 bool HasRetainedScene() const
Return true if the backend keeps cached groups in a persistent scene that it patches in place,...
Contains all the knowledge about how to draw graphical object onto any particular output device.
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.
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.
GAL * GetGAL() const
Return the GAL this view is using to draw graphical primitives.
void SyncLayerVisibilityCache()
void RepaintLayers(const BOX2I &aRect, const std::function< bool(int)> &aLayerFilter, const std::function< bool(VIEW_ITEM *, int)> &aItemFilter)
Re-cache only some layers of the items in aRect.
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)
bool IsModal() const override
Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame...
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, bool aFromOtherThread=false)
Send aPayload to aDestination from aSource.
LOCAL_HISTORY & LocalHistory()
Return the LOCAL_HISTORY associated with this KIWAY.
virtual void CommonSettingsChanged(int aFlags=0)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
PCB_LAYER_ID GetLayerA() const
PCB_LAYER_ID GetLayerB() const
bool CommitDuplicateOfLastSave(const wxString &aProjectPath, const wxString &aFileType, const wxString &aMessage)
Create a new commit duplicating the tree pointed to by Last_Save_<fileType> and move the Last_Save_<f...
void NoteFileChange(const wxString &aFile)
Record that a file has been modified and should be included in the next snapshot.
void RegisterSaver(const void *aSaverObject, const std::function< void(const wxString &, std::vector< HISTORY_FILE_DATA > &)> &aSaver, const std::weak_ptr< void > &aLifetime={})
Register a saver callback invoked during autosave history commits.
void UnregisterSaver(const void *aSaverObject)
Unregister a previously registered saver callback.
void RemoveAutosaveFiles(const wxString &aProjectPath) const
Remove every autosave file under the project at aProjectPath regardless of which source it shadowed.
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.
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
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.
Dockable panel listing the board's geometric constraints (issue #2329).
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 showConstraintsPanel
Toggle the docked constraints pane (board editor).
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 addConstraintVertical
static TOOL_ACTION saveSelectionAsDesignBlock
static TOOL_ACTION drawCircle
static TOOL_ACTION mirrorH
Mirroring of selected items.
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 grabUnconnected
Select and move nearest unconnected footprint from ratsnest of selection.
static TOOL_ACTION ddAppendBoard
Drag and drop.
static TOOL_ACTION drawEllipseArc
static TOOL_ACTION highlightNet
static TOOL_ACTION autoTrackWidth
static TOOL_ACTION drawTable
static TOOL_ACTION drawTextBox
static TOOL_ACTION addConstraintPerpendicular
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 addConstraintAngular
static TOOL_ACTION addConstraintArcAngle
static TOOL_ACTION angleSnapModeChanged
Notification event when angle mode changes.
static TOOL_ACTION saveBoardAsDesignBlock
static TOOL_ACTION drillOrigin
static TOOL_ACTION tuneSkew
static TOOL_ACTION addConstraintHorizontal
static TOOL_ACTION trackDisplayMode
static TOOL_ACTION showNetInspector
static TOOL_ACTION microwaveCreateStubArc
static TOOL_ACTION drawEllipse
static TOOL_ACTION placeSubGrid
Grid Item.
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 addConstraintCollinear
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 addConstraintEqualRadius
static TOOL_ACTION addConstraintTangent
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 ddImportGraphics
static TOOL_ACTION microwaveCreateLine
static TOOL_ACTION addConstraintFixedLength
static TOOL_ACTION flipBoard
static TOOL_ACTION zoneDisplayOutline
static TOOL_ACTION ratsnestLineMode
static TOOL_ACTION toggleAutoConstraints
Toggle authoring constraints automatically while drawing.
static TOOL_ACTION textOutlines
Display texts as lines.
static TOOL_ACTION highlightNetSelection
static TOOL_ACTION microwaveCreateFunctionShape
static TOOL_ACTION placePoint
static TOOL_ACTION zoneMerge
static TOOL_ACTION addConstraintSymmetric
static TOOL_ACTION addConstraintFixedPosition
Ground a point, and the cluster holding it.
static TOOL_ACTION mirrorV
static TOOL_ACTION unlock
static TOOL_ACTION addConstraintPointOnLine
static TOOL_ACTION placeFootprint
static TOOL_ACTION routeSingleTrack
Activation of the Push and Shove router.
static TOOL_ACTION ddPlaceReferenceImage
static TOOL_ACTION createArray
Tool for creating an array of objects.
static TOOL_ACTION showDiffPhaseSkew
Display of phase skew between differential pair tracks.
static TOOL_ACTION deselectNet
Remove all connections belonging to a single net from the active selection.
static TOOL_ACTION addConstraintCoincident
static TOOL_ACTION drawLine
static TOOL_ACTION placeLinkedDesignBlock
static TOOL_ACTION localRatsnestTool
static TOOL_ACTION placeViaStack
static TOOL_ACTION rotateCw
Rotation of selected objects.
static TOOL_ACTION rotateCcw
static TOOL_ACTION addConstraintParallel
static TOOL_ACTION drawAlignedDimension
static TOOL_ACTION addConstraintFixedRadius
static TOOL_ACTION addConstraintEqualLength
static TOOL_ACTION drawZone
static TOOL_ACTION selectOnSchematic
Select symbols/pins on schematic corresponding to selected footprints/pads.
static TOOL_ACTION addConstraintMidpoint
static TOOL_ACTION addConstraintConcentric
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.
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 ...
bool UndoRedoBlocked() const
Check if the undo and redo operations are currently blocked.
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)
PANEL_SELECTION_FILTER * m_selectionFilterPanel
void ShowBarcodePropertiesDialog(PCB_BARCODE *aText)
void ShowGridItemPropertiesDialog(PCB_GRID_ITEM *aGridItem)
void ShowGraphicItemPropertiesDialog(PCB_SHAPE *aShape)
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
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 void SetActiveLayer(PCB_LAYER_ID aLayer)
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()
EDA_ITEM * ResolveItem(const KIID &aId, bool aAllowNullptrReturn=false) const override
Fetch an item by KIID.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual PCB_LAYER_ID GetActiveLayer() const
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.
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.
bool m_FlipBoardView
true if the board is flipped to show the mirrored view
double m_ZoneOpacity
Opacity override for filled zone areas.
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
void ChangeHighContrastLayer(PCB_LAYER_ID aLayer)
Follow an active layer change when nothing else that colours items has changed.
void UpdateColors()
Update the color settings in the painter and GAL.
DS_PROXY_VIEW_ITEM * GetDrawingSheet() const
void SetDrawingSheet(DS_PROXY_VIEW_ITEM *aDrawingSheet)
Set or update drawing-sheet used by the draw panel.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the KIGFX::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
Take care of display settings for the given layer to be displayed in high contrast mode.
void RedrawRatsnest()
Force refresh of the ratsnest visual representation.
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 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
std::size_t m_textVarListenerHandle
Reactive text-var invalidation listener state.
static bool GetPluginActionButtonVisible(const wxString &aPluginPath, bool aPluginDefault)
Return true if button visibility action plugin setting was set to true or it is unset and plugin defa...
void OnEditItemRequest(BOARD_ITEM *aItem) override
Install the corresponding dialog editor for the given item.
void SelectViaStack_Event(wxCommandEvent &event)
Handle the via stack preset selector on the auxiliary toolbar.
void SetLastPath(LAST_PATH_TYPE aType, const wxString &aLastPath)
Set the path of the last file successfully read.
bool interactiveOperationInProgress() const
Return true when an interactive tool operation (routing, dragging, point editing, zone filling,...
int m_crossProbeFlashPhase
Phase counter.
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.
wxTimer m_crossProbeFlashTimer
Timer to toggle selection visibility for flash.
void StartCrossProbeFlash(const std::vector< BOARD_ITEM * > &aItems)
void OnCrossProbeFlashTimer(wxTimerEvent &aEvent)
std::unique_ptr< API_HANDLER_PCB > m_apiHandler
bool CloseFootprintFieldsTableDialog()
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
DIALOG_FOOTPRINT_FIELDS_TABLE * m_footprintFieldsTableDialog
void UpdateVariantSelectionCtrl()
Update the variant selection dropdown with the current board's variant names.
bool DoAutoSave()
Perform auto save when the board has been modified and not saved within the auto save interval.
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.
void ShowFindByPropertiesDialog()
Show the Find by Properties dialog.
BOARD_ITEM_CONTAINER * GetModel() const override
DIALOG_BOOK_REPORTER * GetInspectDrcErrorDialog()
void ShowTargetOptionsDialog(PCB_TARGET *aTarget)
void ShowBoardSetupDialog(const wxString &aInitialPage=wxEmptyString, wxWindow *aParent=nullptr)
std::unique_ptr< API_HANDLER_COMMON > m_apiHandlerCommon
DIALOG_FOOTPRINT_FIELDS_TABLE * GetFootprintFieldsTableDialog()
DIALOG_FIND * m_findDialog
DIALOG_BOOK_REPORTER * m_inspectConstraintsDlg
void SetPageSettings(const PAGE_INFO &aPageSettings) override
void onCloseFootprintFieldsTableDialog(wxCommandEvent &aEvent)
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.
static const wxString ConstraintsPaneName()
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
WX_INFOBAR * m_loadNoticeInfoBar
Secondary infobar that stacks above the main one; reserved for load-time notices (currently the WRL -...
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.
static std::vector< const PLUGIN_ACTION * > GetOrderedPluginActions()
Return ordered list of plugins in sequence in which they should appear on toolbar or in settings.
void detachTextVarTracker()
Drop every cached reference into the current BOARD's text-var tracker.
void onPluginAvailabilityChanged(wxCommandEvent &aEvt)
void PrepareLayerIndicator(bool aForceRebuild=false)
void ShowFindDialog()
Show the Find dialog.
int ShowExchangeFootprintsDialog(FOOTPRINT *aFootprint, bool aUpdateMode, bool aSelectedMode)
int TestStandalone()
Test if standalone mode.
void ShowFootprintPropertiesDialog(FOOTPRINT *aFootprint)
void UpdateProperties() override
bool canRunAutoSave() const override
Return true when it is safe to run an autosave snapshot right now.
PANEL_CONSTRAINTS * m_constraintsPanel
Dockable geometric-constraint list (#2329).
bool IsContentModified() const override
Get if the current board has been modified but not saved.
bool Clear_Pcb(bool doAskAboutUnsavedChanges, bool aFinal=false)
Delete all and reinitialize the current board.
std::unique_ptr< API_HANDLER_LIBRARIES > m_apiLibrariesHandler
bool m_crossProbeFlashing
Currently flashing guard.
TOOL_ACTION * m_exportNetlistAction
The export board netlist tool action object.
BOX2D m_lastNetnamesViewport
Keep track of viewport so that track net labels can be adjusted when it changes.
void OnBoardLoaded()
Update the state of the GUI after a new board is loaded or created.
void ReCreateAuxiliaryToolbar() override
void Edit_Zone_Params(ZONE *zone_container)
Edit params (layer, clearance, ...) for a zone outline.
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.
void ToggleConstraintsPanel()
Show/hide the dockable geometric-constraint list pane, refreshing it when shown (#2329).
COLOR4D GetGridColor() override
std::vector< KIID > m_crossProbeFlashItems
Items to flash (by UUID)
void UpdateTitle()
Set the main window title bar text.
void RefreshDrillSymbols(int aUpdateFlags) override
Tell every hole to redraw its drill symbol.
DIALOG_BOOK_REPORTER * m_footprintDiffDlg
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void onVariantSelected(wxCommandEvent &aEvent)
Event handler for variant selection changes in the toolbar.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
void OnQuit(wxCommandEvent &event)
void NotifyFindByPropertiesDialog()
Notify the Find by Properties dialog that the selection has changed.
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.
bool m_ShowLayerManagerTools
static const wxString SearchPaneName()
DIALOG_FIND_BY_PROPERTIES * m_findByPropertiesDialog
DIALOG_BOOK_REPORTER * m_inspectClearanceDlg
void OnFileHistory(wxCommandEvent &event)
DIALOG_BOOK_REPORTER * GetInspectConstraintsDialog()
class TEXT_VAR_TRACKER * m_textVarListenerTracker
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.
virtual COMMON_SETTINGS * GetCommonSettings() const
KICAD_API_SERVER & GetApiServer()
virtual const wxString & GetExecutablePath() const
void Show(std::ostream &aStream=std::cerr)
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.
static FOOTPRINT_LIBRARY_ADAPTER * FootprintLibAdapter(PROJECT *aProject)
virtual const wxString GetProjectPath() const
Return the full path of the project.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
void IncrementNetclassesTicker()
virtual PROJECT_FILE & GetProjectFile() const
void IncrementTextVarsTicker()
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.
Coordinates the dependency index with change notifications.
ListenerHandle AddInvalidateListener(InvalidateCallback aCallback)
Register a listener that fires for every invalidation.
static constexpr ListenerHandle INVALID_LISTENER
A modified version of the wxInfoBar class that allows us to:
A type-safe container of any type.
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.
int GetLastUnsavedChangesResponse()
Return the result code from the last call to HandleUnsavedChanges(): wxID_YES, wxID_NO or wxID_CANCEL...
This file is part of the common library.
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
#define DIALOG_DRC_WINDOW_NAME
#define DIALOG_DRC_RULE_EDITOR_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
EVT_MENU_RANGE(ID_GERBVIEW_DRILL_FILE1, ID_GERBVIEW_DRILL_FILEMAX, GERBVIEW_FRAME::OnDrlFileHistory) EVT_MENU_RANGE(ID_GERBVIEW_ZIP_FILE1
@ FRAME_FOOTPRINT_CHOOSER
int RefreshGeneratedTables(BOARD &aBoard)
Bring every generated table on the board up to date and return how many were rebuilt.
a few functions useful in geometry calculations.
static const std::string LegacySchematicFileExtension
static const std::string JpegFileExtension
static const std::string PngFileExtension
static const std::string LegacyPcbFileExtension
static const std::string KiCadSchematicFileExtension
static const std::string SVGFileExtension
static const std::string KiCadPcbFileExtension
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
const wxChar *const traceCrossProbeFlash
Flag to enable debug output for cross-probe flash operations.
const wxChar *const traceApi
Flag to enable debug output related to the IPC API and its plugin system.
@ ID_EDA_SOCKET_EVENT_SERV
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
EVT_MENU(ID_COMPARE_PROJECT_BRANCHES, KICAD_MANAGER_FRAME::OnCompareProjectBranches) KICAD_MANAGER_FRAME
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:
#define MAIL_SCH_GET_NETLIST_CANCELLED
Reply payload for MAIL_SCH_GET_NETLIST when the user deliberately aborts netlist generation (for exam...
@ REPAINT
Item needs to be redrawn.
@ GEOMETRY
Position or shape has changed.
@ ALL
All except INITIAL_ADD.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
@ RM_MarkObstacles
Ignore collisions, mark obstacles.
@ RM_Walkaround
Only walk around.
BARCODE class definition.
wxDEFINE_EVENT(EDA_EVT_PCB_LAST_SCH_SHEET_CHANGED, wxCommandEvent)
#define FOOTPRINT_DIFF_DIALOG_NAME
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_VARIANT_SELECT
@ ID_AUX_TOOLBAR_PCB_VIA_SIZE
@ ID_POPUP_PCB_SELECT_WIDTH_END_RANGE
@ ID_POPUP_PCB_SELECT_VIASIZE1
@ ID_AUX_TOOLBAR_PCB_VIA_STACK
@ ID_AUX_TOOLBAR_PCB_TRACK_WIDTH
PGM_BASE & Pgm()
The global program "get" accessor.
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.
T * GetToolbarSettings(const wxString &aFilename)
T * GetAppSettings(const char *aFilename)
KIWAY Kiway(KFCTL_STANDALONE)
wxString UnescapeString(const wxString &aSource)
A min-max version of BOX2 for fast intersection checking.
bool Intersects(const BOX2I_MINMAX &aOther) 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 show_git_commit_pane
TRACK_CLEARANCE_MODE m_TrackClearance
bool m_DisplayRatsnestLinesCurved
bool m_ShowGlobalRatsnest
Identifies a single resolvable source that a text item's ${...} reference depends on.
IbisParser parser & reporter
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_BARCODE_T
class PCB_BARCODE, a barcode (graphic item)
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_GRID_ITEM_T
a subgrid placed on a board
@ 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_POINT_T
class PCB_POINT, a 0-dimensional point
@ 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
@ PCB_DRILL_CHART_T
class PCB_DRILL_CHART, a live drill chart derived from PCB_TABLE
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.