KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_edit_frame.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 2013 Wayne Stambaugh <[email protected]>
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software: you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation, either version 3 of the License, or (at your
12 * option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <https://www.gnu.org/licenses/>.
21 */
22
23#include <algorithm>
24#include <type_traits>
25#include <unordered_map>
26#include <unordered_set>
27#include <vector>
28
29#include <wx/log.h>
30#include <wx/filename.h>
31#include <wx/filedlg.h>
32#include <wx/hyperlink.h>
33#include <wx/socket.h>
34#include <wx/wupdlock.h>
35
36#include <advanced_config.h>
38#include <kiface_base.h>
39#include <kiway.h>
42#include <pgm_base.h>
43#include <pcb_edit_frame.h>
47#include <api/api_handler_pcb.h>
49#include <api/api_server.h>
50#include <api/api_utils.h>
52#include <bitmaps.h>
53#include <confirm.h>
54#include <footprint.h>
55#include <footprint_utils.h>
57#include <project_pcb.h>
58#include <lset.h>
59#include <trace_helpers.h>
60#include <pcbnew_id.h>
61#include <pcbnew_settings.h>
64#include <dialog_find.h>
70#include <dialog_board_setup.h>
73#include <pcb_drill_chart.h>
74#include <pcb_drill_map.h>
79#include <pad.h>
80#include <pcb_target.h>
81#include <pcb_point.h>
82#include <pcb_track.h>
83#include <layer_pairs.h>
86#include <text_var_dependency.h>
87#include <view/view.h>
89#include <functional>
90#include <pcb_barcode.h>
91#include <pcb_grid_item.h>
92#include <pcb_painter.h>
97#include <local_history.h>
98#include <tool/tool_manager.h>
100#include <tool/action_toolbar.h>
101#include <tool/common_control.h>
102#include <tool/common_tools.h>
103#include <tool/embed_tool.h>
104#include <tool/properties_tool.h>
105#include <tool/selection.h>
106#include <tool/zoom_tool.h>
107#include <tools/array_tool.h>
112#include <tools/edit_tool.h>
114#include <tools/pcb_group_tool.h>
115#include <tools/generator_tool.h>
118#include <tools/drc_tool.h>
121#include <tools/convert_tool.h>
123#include <tools/drawing_tool.h>
124#include <tools/pcb_control.h>
132#include <tools/pad_tool.h>
134#include <properties/property.h>
141#include <router/router_tool.h>
144#include <dialog_drc.h> // for DIALOG_DRC_WINDOW_NAME definition
150#include <widgets/wx_infobar.h>
154#include <widgets/wx_aui_utils.h>
155#include <kiplatform/app.h>
156#include <kiplatform/ui.h>
157#include <core/profile.h>
158#include <math/box2_minmax.h>
162#include <toolbars_pcb_editor.h>
164
165#include <richio.h>
166
167using namespace std::placeholders;
168
169wxDEFINE_EVENT( EDA_EVT_PCB_LAST_SCH_SHEET_CHANGED, wxCommandEvent );
170
171
172#define INSPECT_DRC_ERROR_DIALOG_NAME wxT( "InspectDrcErrorDialog" )
173#define INSPECT_CLEARANCE_DIALOG_NAME wxT( "InspectClearanceDialog" )
174#define INSPECT_CONSTRAINTS_DIALOG_NAME wxT( "InspectConstraintsDialog" )
175#define FOOTPRINT_DIFF_DIALOG_NAME wxT( "FootprintDiffDialog" )
176
177
178BEGIN_EVENT_TABLE( PCB_EDIT_FRAME, PCB_BASE_FRAME )
181
184
185 EVT_SIZE( PCB_EDIT_FRAME::OnSize )
186
187 // Menu Files:
190
191 EVT_MENU( wxID_EXIT, PCB_EDIT_FRAME::OnQuit )
192 EVT_MENU( wxID_CLOSE, PCB_EDIT_FRAME::OnQuit )
193
194 // Horizontal toolbar
199
200 // Tracks and vias sizes general options
202 PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event )
203
204 // User interface update event handlers.
205 EVT_UPDATE_UI( ID_AUX_TOOLBAR_PCB_TRACK_WIDTH, PCB_EDIT_FRAME::OnUpdateSelectTrackWidth )
206 EVT_UPDATE_UI( ID_AUX_TOOLBAR_PCB_VIA_SIZE, PCB_EDIT_FRAME::OnUpdateSelectViaSize )
208 PCB_EDIT_FRAME::OnUpdateSelectTrackWidth )
210 PCB_EDIT_FRAME::OnUpdateSelectViaSize )
211 // Drop files event
212 EVT_DROP_FILES( PCB_EDIT_FRAME::OnDropFiles )
213END_EVENT_TABLE()
214
215
216PCB_EDIT_FRAME::PCB_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
217 PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_PCB_EDITOR, _( "PCB Editor" ), wxDefaultPosition, wxDefaultSize,
219 m_exportNetlistAction( nullptr ),
220 m_findDialog( nullptr ),
221 m_findByPropertiesDialog( nullptr ),
222 m_inspectDrcErrorDlg( nullptr ),
223 m_inspectClearanceDlg( nullptr ),
224 m_inspectConstraintsDlg( nullptr ),
225 m_footprintDiffDlg( nullptr ),
226 m_boardSetupDlg( nullptr ),
227 m_footprintFieldsTableDialog( nullptr ),
228 m_designBlocksPane( nullptr ),
229 m_importProperties( nullptr ),
230 m_eventCounterTimer( nullptr )
231{
232 m_maximizeByDefault = true;
233 m_showBorderAndTitleBlock = true; // true to display sheet references
234 m_SelTrackWidthBox = nullptr;
235 m_SelViaSizeBox = nullptr;
236 m_SelViaStackBox = nullptr;
237 m_CurrentVariantCtrl = nullptr;
238 m_ShowLayerManagerTools = true;
239 m_supportsAutoSave = true;
240 m_ProbingSchToPcb = false;
241 m_ShowSearch = false;
242 m_ShowNetInspector = false;
243 // Ensure timer has an owner before binding so it generates events.
244 m_crossProbeFlashTimer.SetOwner( this );
245 Bind( wxEVT_TIMER, &PCB_EDIT_FRAME::OnCrossProbeFlashTimer, this, m_crossProbeFlashTimer.GetId() );
246
247 // We don't know what state board was in when it was last saved, so we have to
248 // assume dirty
249 m_ZoneFillsDirty = true;
250
251 m_aboutTitle = _HKI( "KiCad PCB Editor" );
252
253 // Must be created before the menus are created.
254 if( ADVANCED_CFG::GetCfg().m_ShowPcbnewExportNetlist )
255 {
256 m_exportNetlistAction = new TOOL_ACTION( "pcbnew.EditorControl.exportNetlist",
257 AS_GLOBAL, 0, "", _( "Netlist..." ),
258 _( "Export netlist used to update schematics" ) );
259 }
260
261 // Create GAL canvas
262 PCB_DRAW_PANEL_GAL* canvas = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
263 GetGalDisplayOptions(),
265
266 SetCanvas( canvas );
267 SetBoard( new BOARD() );
268
269 wxIcon icon;
270 wxIconBundle icon_bundle;
271
272 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbnew, 48 ) );
273 icon_bundle.AddIcon( icon );
274 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbnew, 128 ) );
275 icon_bundle.AddIcon( icon );
276 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbnew, 256 ) );
277 icon_bundle.AddIcon( icon );
278 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbnew_32 ) );
279 icon_bundle.AddIcon( icon );
280 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbnew_16 ) );
281 icon_bundle.AddIcon( icon );
282
283 SetIcons( icon_bundle );
284
285 // LoadSettings() *after* creating m_LayersManager, because LoadSettings()
286 // initialize parameters in m_LayersManager
287 LoadSettings( config() );
288
289 SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS ) ) );
290
291 // PCB drawings start in the upper left corner.
292 GetScreen()->m_Center = false;
293
294 setupTools();
295 setupUIConditions();
296
297 m_toolbarSettings = GetToolbarSettings<PCB_EDIT_TOOLBAR_SETTINGS>( "pcbnew-toolbars" );
298 configureToolbars();
299 RecreateToolbars();
300 PrepareLayerIndicator( true );
301
302 ReCreateMenuBar();
303
306
307 // Fetch a COPY of the config as a lot of these initializations are going to overwrite our
308 // data.
309 PCBNEW_SETTINGS::AUI_PANELS aui_cfg = GetPcbNewSettings()->m_AuiPanels;
310
311 m_propertiesPanel = new PCB_PROPERTIES_PANEL( this, this );
312 m_propertiesPanel->SetSplitterProportion( aui_cfg.properties_splitter );
313
314 m_selectionFilterPanel = new PANEL_SELECTION_FILTER( this );
315
316 m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas() );
317 m_searchPane = new PCB_SEARCH_PANE( this );
318 m_netInspectorPanel = new PCB_NET_INSPECTOR_PANEL( this, this );
319 m_designBlocksPane = new PCB_DESIGN_BLOCK_PANE( this, nullptr, m_designBlockHistoryList );
320 m_constraintsPanel = new PANEL_CONSTRAINTS( this );
321
322 m_auimgr.SetManagedWindow( this );
323
324 CreateInfoBar();
325
326 // Secondary infobar stacked above the main one. Load-time notices (such as
327 // the WRL -> STEP migration prompt) belong here so they aren't clobbered by
328 // the main infobar's read-only warnings, DRC rule errors, etc.
329 m_loadNoticeInfoBar = new WX_INFOBAR( GetToolCanvas(), wxID_ANY, true );
330
331 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
332#if !defined( _WIN32 )
333 // Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds
334 // of graphical glitches.
335 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
336#endif
337 m_auimgr.SetFlags( auiFlags );
338
339 // Rows; layers 4 - 6
340 m_auimgr.AddPane( m_tbTopMain, EDA_PANE().HToolbar().Name( wxS( "TopMainToolbar" ) )
341 .Top().Layer( 6 ) );
342 m_auimgr.AddPane( m_tbTopAux, EDA_PANE().HToolbar().Name( wxS( "TopAuxToolbar" ) )
343 .Top().Layer( 5 ) );
344 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( wxS( "MsgPanel" ) )
345 .Bottom().Layer( 6 ) );
346
347 // Columns; layers 1 - 3
348 m_auimgr.AddPane( m_tbLeft, EDA_PANE().VToolbar().Name( wxS( "LeftToolbar" ) )
349 .Left().Layer( 3 ) );
350
351 m_auimgr.AddPane( m_tbRight, EDA_PANE().VToolbar().Name( wxS( "RightToolbar" ) )
352 .Right().Layer( 3 ) );
353
354 m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( wxS( "LayersManager" ) )
355 .Right().Layer( 4 )
356 .Caption( _( "Appearance" ) ).PaneBorder( false )
357 // Don't use -1 for don't-change-height on a growable panel; it has side-effects.
358 .MinSize( m_appearancePanel->GetMinSize().x, FromDIP( 60 ) )
359#ifdef __WXMAC__
360 // Best size for this pane is calculated larger than necessary on wxMac
361 .BestSize( m_appearancePanel->GetMinSize().x, -1 )
362#else
363 .BestSize( m_appearancePanel->GetBestSize().x, -1 )
364#endif
365 .FloatingSize( m_appearancePanel->GetBestSize() )
366 .CloseButton( false ) );
367
368 m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Name( wxS( "SelectionFilter" ) )
369 .Right().Layer( 4 ).Position( 2 )
370 .Caption( _( "Selection Filter" ) ).PaneBorder( false )
371 // Fixed-size pane; -1 for MinSize height is required
372 .MinSize( m_selectionFilterPanel->GetMinSize().x, -1 )
373 .BestSize( m_selectionFilterPanel->GetBestSize().x, -1 )
374 .FloatingSize( m_selectionFilterPanel->GetBestSize() )
375 .CloseButton( false ) );
376
377 m_auimgr.AddPane( m_designBlocksPane, EDA_PANE().Name( DesignBlocksPaneName() )
378 .Right().Layer( 5 )
379 .Caption( _( "Design Blocks" ) )
380 .CaptionVisible( true )
381 .PaneBorder( true )
382 .TopDockable( false )
383 .BottomDockable( false )
384 .CloseButton( true )
385 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
386 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
387 .FloatingSize( FromDIP( wxSize( 800, 600 ) ) )
388 .FloatingPosition( FromDIP( wxPoint( 50, 200 ) ) )
389 .Show( true ) );
390
391 m_auimgr.AddPane( m_propertiesPanel, EDA_PANE().Name( PropertiesPaneName() )
392 .Left().Layer( 5 )
393 .Caption( _( "Properties" ) ).PaneBorder( false )
394 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
395 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
396 .FloatingSize( wxSize( 300, 200 ) )
397 .CloseButton( true ) );
398
399 // Center
400 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( wxS( "DrawFrame" ) )
401 .Center() );
402
403 m_auimgr.AddPane( m_netInspectorPanel, EDA_PANE().Name( NetInspectorPanelName() )
404 .Bottom()
405 .Caption( _( "Net Inspector" ) )
406 .PaneBorder( false )
407 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
408 .BestSize( FromDIP( wxSize( 300, 200 ) ) )
409 .FloatingSize( wxSize( 300, 200 ) )
410 .CloseButton( true ) );
411
412 m_auimgr.AddPane( m_searchPane, EDA_PANE().Name( SearchPaneName() )
413 .Bottom()
414 .Caption( _( "Search" ) ).PaneBorder( false )
415 .MinSize( FromDIP( wxSize ( 180, 60 ) ) )
416 .BestSize( FromDIP( wxSize ( 180, 100 ) ) )
417 .FloatingSize( FromDIP( wxSize( 480, 200 ) ) )
418 .DestroyOnClose( false )
419 .CloseButton( true ) );
420
421 m_auimgr.AddPane( m_constraintsPanel, EDA_PANE().Name( ConstraintsPaneName() )
422 .Bottom().Layer( 1 )
423 .Caption( _( "Geometric Constraints" ) ).PaneBorder( false )
424 .MinSize( FromDIP( wxSize( 360, 120 ) ) )
425 .BestSize( FromDIP( wxSize( 600, 200 ) ) )
426 .FloatingSize( FromDIP( wxSize( 600, 240 ) ) )
427 .DestroyOnClose( false )
428 .CloseButton( true )
429 .Hide() );
430
431 RestoreAuiLayout();
432
433 m_auimgr.GetPane( "LayersManager" ).Show( m_ShowLayerManagerTools );
434 m_auimgr.GetPane( "SelectionFilter" ).Show( m_ShowLayerManagerTools );
435 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.show_properties );
436 m_auimgr.GetPane( NetInspectorPanelName() ).Show( m_ShowNetInspector );
437 m_auimgr.GetPane( SearchPaneName() ).Show( m_ShowSearch );
438 m_auimgr.GetPane( DesignBlocksPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.design_blocks_show );
439
440 wxAuiPaneInfo& selectionFilterPane = m_auimgr.GetPane( wxS( "SelectionFilter" ) );
441
442 // The selection filter doesn't need to grow in the vertical direction when docked
443 selectionFilterPane.dock_proportion = 0;
444
445 // wx 3.3.3 turns a -1 min height into 1, and a legacy perspective restores one
446 selectionFilterPane.min_size.y = m_selectionFilterPanel->GetBestSize().y;
447 FinishAUIInitialization();
448
449 if( aui_cfg.right_panel_width > 0 )
450 {
451 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( wxS( "LayersManager" ) );
452 SetAuiPaneSize( m_auimgr, layersManager, aui_cfg.right_panel_width, -1 );
453
454 wxAuiPaneInfo& designBlocksPane = m_auimgr.GetPane( DesignBlocksPaneName() );
455 SetAuiPaneSize( m_auimgr, designBlocksPane, aui_cfg.design_blocks_panel_docked_width, -1 );
456 }
457
458 if( aui_cfg.properties_panel_width > 0 && m_propertiesPanel )
459 {
460 wxAuiPaneInfo& propertiesPanel = m_auimgr.GetPane( PropertiesPaneName() );
461 SetAuiPaneSize( m_auimgr, propertiesPanel, aui_cfg.properties_panel_width, -1 );
462 }
463
464 if( aui_cfg.search_panel_height > 0
465 && ( aui_cfg.search_panel_dock_direction == wxAUI_DOCK_TOP
466 || aui_cfg.search_panel_dock_direction == wxAUI_DOCK_BOTTOM ) )
467 {
468 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
469 searchPane.Direction( aui_cfg.search_panel_dock_direction );
470 SetAuiPaneSize( m_auimgr, searchPane, -1, aui_cfg.search_panel_height );
471 }
472 else if( aui_cfg.search_panel_width > 0
473 && ( aui_cfg.search_panel_dock_direction == wxAUI_DOCK_LEFT
474 || aui_cfg.search_panel_dock_direction == wxAUI_DOCK_RIGHT ) )
475 {
476 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
477 searchPane.Direction( aui_cfg.search_panel_dock_direction );
478 SetAuiPaneSize( m_auimgr, searchPane, aui_cfg.search_panel_width, -1 );
479 }
480
481 m_appearancePanel->SetTabIndex( aui_cfg.appearance_panel_tab );
482
483 m_layerPairSettings = std::make_unique<LAYER_PAIR_SETTINGS>();
484
485 m_layerPairSettings->Bind( PCB_LAYER_PAIR_PRESETS_CHANGED,
486 [&]( wxCommandEvent& aEvt )
487 {
488 // Update the project file list
489 std::span<const LAYER_PAIR_INFO> newPairInfos = m_layerPairSettings->GetLayerPairs();
490 Prj().GetProjectFile().m_LayerPairInfos = std::vector<LAYER_PAIR_INFO>{ newPairInfos.begin(),
491 newPairInfos.end() };
492 } );
493
494 m_layerPairSettings->Bind( PCB_CURRENT_LAYER_PAIR_CHANGED,
495 [&]( wxCommandEvent& aEvt )
496 {
497 const LAYER_PAIR& layerPair = m_layerPairSettings->GetCurrentLayerPair();
498 PCB_SCREEN& screen = *GetScreen();
499
500 screen.m_Route_Layer_TOP = layerPair.GetLayerA();
501 screen.m_Route_Layer_BOTTOM = layerPair.GetLayerB();
502
503 // Update the toolbar icon
504 PrepareLayerIndicator();
505 } );
506
507 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
508
509 // This is used temporarily to fix a client size issue on GTK that causes zoom to fit
510 // to calculate the wrong zoom size. See PCB_EDIT_FRAME::onSize().
511 Bind( wxEVT_SIZE, &PCB_EDIT_FRAME::onSize, this );
512
513 Bind( wxEVT_IDLE,
514 [this]( wxIdleEvent& aEvent )
515 {
516 BOX2D viewport = GetCanvas()->GetView()->GetViewport();
517
518 if( viewport != m_lastNetnamesViewport )
519 {
520 redrawNetnames();
521 m_lastNetnamesViewport = viewport;
522 }
523
524 // Do not forget to pass the Idle event to other clients:
525 aEvent.Skip();
526 } );
527
528 setupUnits( config() );
529
530 // Ensure the DRC engine is initialized so that constraints can be resolved even before a
531 // board is loaded or saved
532 try
533 {
534 m_toolManager->GetTool<DRC_TOOL>()->GetDRCEngine()->InitEngine( wxFileName() );
535 }
536 catch( PARSE_ERROR& )
537 {
538 }
539
540 // Sync action plugins in case they changed since the last time the frame opened
541 GetToolManager()->RunAction( ACTIONS::pluginsReload );
542
543 m_apiHandler = std::make_unique<API_HANDLER_PCB>( this );
544 Pgm().GetApiServer().RegisterHandler( m_apiHandler.get() );
545
546 if( Kiface().IsSingle() )
547 {
548 m_apiHandlerCommon = std::make_unique<API_HANDLER_COMMON>();
549 Pgm().GetApiServer().RegisterHandler( m_apiHandlerCommon.get() );
550 m_apiLibrariesHandler = std::make_unique<API_HANDLER_LIBRARIES>( LIBRARY_TABLE_TYPE::DESIGN_BLOCK );
551 Pgm().GetApiServer().RegisterHandler( m_apiLibrariesHandler.get() );
552 }
553
554 resolveCanvasType();
555 ActivateGalCanvas();
556
557 // Default shutdown reason until a file is loaded
558 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "New PCB file is unsaved" ) );
559
560 // disable Export STEP item if kicad2step does not exist
561 wxString strK2S = Pgm().GetExecutablePath();
562
563#ifdef __WXMAC__
564 if( strK2S.Find( wxT( "pcbnew.app" ) ) != wxNOT_FOUND )
565 {
566 // On macOS, we have standalone applications inside the main bundle, so we handle that here:
567 strK2S += wxT( "../../" );
568 }
569
570 strK2S += wxT( "Contents/MacOS/" );
571#endif
572
573 wxFileName appK2S( strK2S, wxT( "kicad2step" ) );
574
575#ifdef _WIN32
576 appK2S.SetExt( wxT( "exe" ) );
577#endif
578
579 // Ensure the window is on top
580 Raise();
581
582// if( !appK2S.FileExists() )
583 // GetMenuBar()->FindItem( ID_GEN_EXPORT_FILE_STEP )->Enable( false );
584
585 // AUI doesn't refresh properly on wxMac after changes in eb7dc6dd, so force it to
586#ifdef __WXMAC__
587 if( Kiface().IsSingle() )
588 {
589 CallAfter( [this]()
590 {
591 m_appearancePanel->OnBoardChanged();
592 } );
593 }
594#endif
595
596 // Register a call to update the toolbar sizes. It can't be done immediately because
597 // it seems to require some sizes calculated that aren't yet (at least on GTK).
598 CallAfter( [this]()
599 {
600 // Ensure the controls on the toolbars all are correctly sized
601 UpdateToolbarControlSizes();
602
603 // Update the angle snap mode toolbar button to reflect the current preference
604 GetToolManager()->RunAction( PCB_ACTIONS::angleSnapModeChanged );
605 } );
606
607 if( ADVANCED_CFG::GetCfg().m_ShowEventCounters )
608 {
609 m_eventCounterTimer = new wxTimer( this );
610
611 Bind( wxEVT_TIMER,
612 [&]( wxTimerEvent& aEvent )
613 {
614 GetCanvas()->m_PaintEventCounter->Show();
615 GetCanvas()->m_PaintEventCounter->Reset();
616
618 static_cast<KIGFX::WX_VIEW_CONTROLS*>( GetCanvas()->GetViewControls() );
621
622 },
623 m_eventCounterTimer->GetId() );
624
625 m_eventCounterTimer->Start( 1000 );
626 }
627
630 m_acceptedExts.emplace( wxS( "dxf" ), &PCB_ACTIONS::ddImportGraphics );
632 DragAcceptFiles( true );
633
634 Bind( EDA_EVT_CLOSE_DIALOG_BOOK_REPORTER, &PCB_EDIT_FRAME::onCloseModelessBookReporterDialogs, this );
635 Bind( EDA_EVT_CLOSE_DIALOG_FOOTPRINT_FIELDS_TABLE, &PCB_EDIT_FRAME::onCloseFootprintFieldsTableDialog, this );
636}
637
638
639void PCB_EDIT_FRAME::StartCrossProbeFlash( const std::vector<BOARD_ITEM*>& aItems )
640{
641 if( !GetPcbNewSettings()->m_CrossProbing.flash_selection )
642 {
643 wxLogTrace( traceCrossProbeFlash, "StartCrossProbeFlash(PCB): aborted (setting disabled) items=%zu",
644 aItems.size() );
645 return;
646 }
647
648 if( aItems.empty() )
649 {
650 wxLogTrace( traceCrossProbeFlash, "StartCrossProbeFlash(PCB): aborted (no items)" );
651 return;
652 }
653
654 // Don't start flashing if any of the items are being moved. The flash timer toggles
655 // selection hide/show which corrupts the VIEW overlay state during an active move.
656 for( const BOARD_ITEM* item : aItems )
657 {
658 if( item->IsMoving() )
659 {
660 wxLogTrace( traceCrossProbeFlash,
661 "StartCrossProbeFlash(PCB): aborted (items are moving)" );
662 return;
663 }
664 }
665
667 {
668 wxLogTrace( traceCrossProbeFlash, "StartCrossProbeFlash(PCB): restarting existing flash (phase=%d)",
671 }
672
673 wxLogTrace( traceCrossProbeFlash, "StartCrossProbeFlash(PCB): starting with %zu items", aItems.size() );
674
675 // Store uuids
677 for( BOARD_ITEM* it : aItems )
678 m_crossProbeFlashItems.push_back( it->m_Uuid );
679
682
683 if( !m_crossProbeFlashTimer.GetOwner() )
684 m_crossProbeFlashTimer.SetOwner( this );
685
686 // 0.5s intervals -> 3s total for 6 phases
687 [[maybe_unused]] bool started = m_crossProbeFlashTimer.Start( 500, wxTIMER_CONTINUOUS );
688 wxLogTrace( traceCrossProbeFlash, "StartCrossProbeFlash(PCB): timer start=%d id=%d",
689 (int) started, m_crossProbeFlashTimer.GetId() );
690}
691
692
693void PCB_EDIT_FRAME::OnCrossProbeFlashTimer( wxTimerEvent& aEvent )
694{
695 wxLogTrace( traceCrossProbeFlash, "Timer(PCB) fired: phase=%d running=%d items=%zu",
697
699 {
700 wxLogTrace( traceCrossProbeFlash, "Timer(PCB) fired but not flashing (ignored)" );
701 return;
702 }
703
705
706 if( !selTool )
707 return;
708
709 // Don't manipulate the selection while items are being moved. The move tool holds a
710 // live reference to the selection and toggling hide/show on selected items corrupts
711 // the VIEW overlay state, causing crashes.
712 for( const KIID& id : m_crossProbeFlashItems )
713 {
714 if( EDA_ITEM* item = GetBoard()->ResolveItem( id, true ) )
715 {
716 if( item->IsMoving() )
717 {
718 wxLogTrace( traceCrossProbeFlash, "Timer(PCB) phase=%d: items are moving, stopping flash",
720 m_crossProbeFlashing = false;
722 return;
723 }
724 }
725 }
726
727 // Prevent recursion / IPC during flashing
728 bool prevGuard = m_ProbingSchToPcb;
729 m_ProbingSchToPcb = true;
730
731 if( m_crossProbeFlashPhase % 2 == 0 )
732 {
733 // Hide selection
734 selTool->ClearSelection( true );
735 wxLogTrace( traceCrossProbeFlash, "Phase %d (PCB): cleared selection", m_crossProbeFlashPhase );
736 }
737 else
738 {
739 // Restore selection
740 for( const KIID& id : m_crossProbeFlashItems )
741 {
742 if( EDA_ITEM* item = GetBoard()->ResolveItem( id, true ) )
743 selTool->AddItemToSel( item, true );
744 }
745
746 wxLogTrace( traceCrossProbeFlash, "Phase %d (PCB): restored %zu items",
748 }
749
750 // Force a redraw even if the canvas / frame does not currently have focus (mouse elsewhere)
751 if( GetCanvas() )
752 {
754 wxLogTrace( traceCrossProbeFlash, "Phase %d (PCB): forced canvas refresh", m_crossProbeFlashPhase );
755 }
756
757 m_ProbingSchToPcb = prevGuard;
758
760
761 if( m_crossProbeFlashPhase > 6 )
762 {
763 // Ensure final state (selected)
764 for( const KIID& id : m_crossProbeFlashItems )
765 {
766 if( EDA_ITEM* item = GetBoard()->ResolveItem( id, true ) )
767 selTool->AddItemToSel( item, true );
768 }
769
770 m_crossProbeFlashing = false;
772
773 wxLogTrace( traceCrossProbeFlash, "Flashing complete (PCB). Final selection size=%zu",
774 m_crossProbeFlashItems.size() );
775 }
776}
777
778
780{
781 // Always ensure that we are unregistered even in a close without graceful doCloseWindow()
782 if( GetBoard() )
784
785 // PCB_BASE_FRAME's dtor deletes m_pcb; canvas children outlive it. Drop
786 // every cached TEXT_VAR_TRACKER* before the tracker is freed.
788
789 if( Kiface().IsSingle() )
790 {
793 }
794
795 if( ADVANCED_CFG::GetCfg().m_ShowEventCounters )
796 {
797 // Stop the timer during destruction early to avoid potential event race conditions (that
798 // do happen on windows)
799 m_eventCounterTimer->Stop();
800 delete m_eventCounterTimer;
801 }
802
803 // Close modeless dialogs
804 wxWindow* drcDlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
805
806 if( drcDlg )
807 drcDlg->Close( true );
808
809 wxWindow* ruleEditorDlg = wxWindow::FindWindowByName( DIALOG_DRC_RULE_EDITOR_WINDOW_NAME );
810
811 if( ruleEditorDlg )
812 ruleEditorDlg->Close( true );
813
814 // Shutdown all running tools
815 if( m_toolManager )
816 m_toolManager->ShutdownAllTools();
817
818 if( GetBoard() )
820
821 // We passed ownership of these to wxAuiManager.
822 // delete m_selectionFilterPanel;
823 // delete m_appearancePanel;
824 // delete m_propertiesPanel;
825 // delete m_netInspectorPanel;
826
828}
829
830
832{
833 wxAuiPaneInfo& pane = m_auimgr.GetPane( ConstraintsPaneName() );
834
835 if( !pane.IsOk() )
836 return;
837
838 bool show = !pane.IsShown();
839 pane.Show( show );
840
841 if( show && m_constraintsPanel )
842 m_constraintsPanel->RefreshList();
843
844 m_auimgr.Update();
845}
846
847
849{
850 if( GetCanvas() )
851 {
852 if( DS_PROXY_VIEW_ITEM* sheet = GetCanvas()->GetDrawingSheet() )
853 sheet->AttachToTracker( nullptr );
854 }
855
857 {
858 m_textVarListenerTracker->RemoveInvalidateListener( m_textVarListenerHandle );
860 m_textVarListenerTracker = nullptr;
861 }
862}
863
864
865void PCB_EDIT_FRAME::SetBoard( BOARD* aBoard, bool aBuildConnectivity, PROGRESS_REPORTER* aReporter )
866{
867 // PCB_BASE_FRAME::SetBoard() deletes m_pcb; detach tracker consumers first.
868 if( m_pcb )
869 {
871 m_pcb->ClearProject();
873 }
874
875 PCB_BASE_EDIT_FRAME::SetBoard( aBoard, aReporter );
876
877 aBoard->SetProject( &Prj() );
878
879 if( aBuildConnectivity )
880 aBoard->BuildConnectivity();
881
882 // reload the drawing-sheet
883 SetPageSettings( aBoard->GetPageSettings() );
884
886}
887
888
893
894
895std::unique_ptr<GRID_HELPER> PCB_EDIT_FRAME::MakeGridHelper()
896{
897 return std::make_unique<PCB_GRID_HELPER>( m_toolManager, GetMagneticItemsSettings() );
898}
899
900
902{
903 /*
904 * While new items being scrolled into the view will get painted, they will only get
905 * annotated with netname instances currently within the view. Subsequent panning will not
906 * draw newly-visible netname instances because the item has already been drawn.
907 *
908 * This routine, fired on idle if the viewport has changed, looks for visible items that
909 * might have multiple netname instances and redraws them. (It does not need to handle pads
910 * and vias because they only ever have a single netname instance drawn on them.)
911 */
912 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() );
913
914 if( !cfg || cfg->m_Display.m_NetNames < 2 )
915 return;
916
917 KIGFX::VIEW* view = GetCanvas()->GetView();
918 BOX2D viewport = view->GetViewport();
919
920 view->SyncLayerVisibilityCache(); // Required for ViewGetLOD() calls.
921
922 // Inflate to catch most of the track width
923 BOX2I_MINMAX clipbox( BOX2ISafe( viewport.Inflate( pcbIUScale.mmToIU( 2.0 ) ) ) );
924
925 for( PCB_TRACK* track : GetBoard()->Tracks() )
926 {
927 // Don't need to update vias
928 if( track->Type() == PCB_VIA_T )
929 continue;
930
931 // Don't update invisible tracks
932 if( !clipbox.Intersects( BOX2I_MINMAX( track->GetStart(), track->GetEnd() ) ) )
933 continue;
934
935 if( track->ViewGetLOD( GetNetnameLayer( track->GetLayer() ), view ) < view->GetScale() )
936 view->Update( track, KIGFX::REPAINT );
937 }
938}
939
940
941void PCB_EDIT_FRAME::SetPageSettings( const PAGE_INFO& aPageSettings )
942{
943 PCB_BASE_FRAME::SetPageSettings( aPageSettings );
944
945 // Prepare drawing-sheet template
947 &m_pcb->GetPageSettings(),
948 m_pcb->GetProject(),
949 &m_pcb->GetTitleBlock(),
950 &m_pcb->GetProperties() );
951
952 drawingSheet->SetSheetName( std::string( GetScreenDesc().mb_str() ) );
953 drawingSheet->SetSheetPath( std::string( GetFullScreenDesc().mb_str() ) );
954
955 // A board is not like a schematic having a main page and sub sheets.
956 // So for the drawing sheet, use only the first page option to display items
957 drawingSheet->SetIsFirstPage( true );
958
959 BASE_SCREEN* screen = GetScreen();
960
961 if( screen != nullptr )
962 {
963 drawingSheet->SetPageNumber(TO_UTF8( screen->GetPageNumber() ) );
964 drawingSheet->SetSheetCount( screen->GetPageCount() );
965 }
966
967 if( BOARD* board = GetBoard() )
968 {
969 drawingSheet->SetFileName( TO_UTF8( board->GetFileName() ) );
970 wxString currentVariant = board->GetCurrentVariant();
971 wxString variantDesc = board->GetVariantDescription( currentVariant );
972 drawingSheet->SetVariantName( TO_UTF8( currentVariant ) );
973 drawingSheet->SetVariantDesc( TO_UTF8( variantDesc ) );
974 }
975
976 // PCB_DRAW_PANEL_GAL takes ownership of the drawing-sheet
977 GetCanvas()->SetDrawingSheet( drawingSheet );
978
979 // Reactive title-block repaint: register the proxy with the BOARD's
980 // text-var tracker so source changes fan out to a repaint. The one-time
981 // listener installation is idempotent; calling AddInvalidateListener
982 // here each time would accumulate stale listeners across SetPageSettings
983 // calls, which is why the listener check below is guarded.
984 if( BOARD* board = GetBoard() )
985 {
986 if( BOARD_TEXT_VAR_ADAPTER* adapter = board->GetTextVarAdapter() )
987 {
988 TEXT_VAR_TRACKER* tracker = &adapter->Tracker();
989
990 drawingSheet->AttachToTracker( tracker );
991
992 // Project reload / board swap can point GetBoard() at a new
993 // tracker; detach from the previous one first so we don't leak
994 // a stale lambda that still captures `this`.
995 if( m_textVarListenerTracker != tracker
997 {
998 m_textVarListenerTracker->RemoveInvalidateListener( m_textVarListenerHandle );
1000 m_textVarListenerTracker = nullptr;
1001 }
1002
1004 {
1005 KIGFX::VIEW* view = GetCanvas()->GetView();
1006 m_textVarListenerTracker = tracker;
1008 [this, view]( EDA_ITEM* aDep, const TEXT_VAR_REF_KEY& )
1009 {
1010 if( !aDep )
1011 return;
1012
1014
1015 if( aDep == current )
1016 {
1017 view->Update( current, KIGFX::REPAINT );
1018 return;
1019 }
1020
1021 if( aDep->IsBOARD_ITEM() )
1022 view->Update( aDep, KIGFX::REPAINT );
1023 } );
1024 }
1025 }
1026 }
1027}
1028
1029
1031{
1032 return GetScreen() && GetScreen()->IsContentModified();
1033}
1034
1035
1037{
1038 return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
1039}
1040
1041
1043{
1044 // Create the manager and dispatcher & route draw panel events to the dispatcher
1046 m_toolManager->SetEnvironment( m_pcb, GetCanvas()->GetView(),
1047 GetCanvas()->GetViewControls(), config(), this );
1048 m_actions = new PCB_ACTIONS();
1050
1051 // Register tools
1052 m_toolManager->RegisterTool( new COMMON_CONTROL );
1053 m_toolManager->RegisterTool( new COMMON_TOOLS );
1054 m_toolManager->RegisterTool( new PCB_SELECTION_TOOL );
1055 m_toolManager->RegisterTool( new ZOOM_TOOL );
1056 m_toolManager->RegisterTool( new PCB_PICKER_TOOL );
1057 m_toolManager->RegisterTool( new ROUTER_TOOL );
1058 m_toolManager->RegisterTool( new EDIT_TOOL );
1059 m_toolManager->RegisterTool( new PCB_EDIT_TABLE_TOOL );
1060 m_toolManager->RegisterTool( new GLOBAL_EDIT_TOOL );
1061 m_toolManager->RegisterTool( new PAD_TOOL );
1062 m_toolManager->RegisterTool( new DRAWING_TOOL );
1063 m_toolManager->RegisterTool( new PCB_POINT_EDITOR );
1064 m_toolManager->RegisterTool( new PCB_CONTROL );
1065 m_toolManager->RegisterTool( new PCB_DESIGN_BLOCK_CONTROL );
1066 m_toolManager->RegisterTool( new BOARD_EDITOR_CONTROL );
1067 m_toolManager->RegisterTool( new BOARD_INSPECTION_TOOL );
1068 m_toolManager->RegisterTool( new BOARD_REANNOTATE_TOOL );
1069 m_toolManager->RegisterTool( new ALIGN_DISTRIBUTE_TOOL );
1070 m_toolManager->RegisterTool( new MICROWAVE_TOOL );
1071 m_toolManager->RegisterTool( new POSITION_RELATIVE_TOOL );
1072 m_toolManager->RegisterTool( new ARRAY_TOOL );
1073 m_toolManager->RegisterTool( new ZONE_FILLER_TOOL );
1074 m_toolManager->RegisterTool( new AUTOPLACE_TOOL );
1075 m_toolManager->RegisterTool( new DRC_TOOL );
1076 m_toolManager->RegisterTool( new PCB_VIEWER_TOOLS );
1077 m_toolManager->RegisterTool( new CONVERT_TOOL );
1078 m_toolManager->RegisterTool( new PCB_GROUP_TOOL );
1079 m_toolManager->RegisterTool( new CONSTRAINT_EDIT_TOOL );
1080 m_toolManager->RegisterTool( new GENERATOR_TOOL );
1081 m_toolManager->RegisterTool( new VIA_STITCH_TOOL );
1082 m_toolManager->RegisterTool( new PROPERTIES_TOOL );
1083 m_toolManager->RegisterTool( new MULTICHANNEL_TOOL );
1084 m_toolManager->RegisterTool( new MATCH_PROPERTIES_TOOL );
1085 m_toolManager->RegisterTool( new GRAPHIC_EDIT_TOOL );
1086 m_toolManager->RegisterTool( new EMBED_TOOL );
1087 m_toolManager->RegisterTool( new DRC_RULE_EDITOR_TOOL );
1088 m_toolManager->RegisterTool( new DIFF_PHASE_SKEW_TOOL );
1089 m_toolManager->InitTools();
1090
1091 for( TOOL_BASE* tool : m_toolManager->Tools() )
1092 {
1093 if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
1094 pcbTool->SetIsBoardEditor( true );
1095 }
1096
1097 // Run the selection tool, it is supposed to be always active
1098 m_toolManager->InvokeTool( "common.InteractiveSelection" );
1099}
1100
1101
1103{
1105
1106 ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
1107 PCB_EDITOR_CONDITIONS cond( this );
1108
1109 auto undoCond =
1110 [ this ] (const SELECTION& aSel )
1111 {
1112 DRAWING_TOOL* drawingTool = m_toolManager->GetTool<DRAWING_TOOL>();
1113
1114 if( drawingTool && drawingTool->GetDrawingMode() != DRAWING_TOOL::MODE::NONE )
1115 return true;
1116
1117 ROUTER_TOOL* routerTool = m_toolManager->GetTool<ROUTER_TOOL>();
1118
1119 if( routerTool && routerTool->RoutingInProgress() )
1120 return true;
1121
1122 return GetUndoCommandCount() > 0;
1123 };
1124
1125 auto groupWithDesignBlockLink =
1126 [] ( const SELECTION& aSel )
1127 {
1128 if( aSel.Size() != 1 )
1129 return false;
1130
1131 if( aSel[0]->Type() != PCB_GROUP_T )
1132 return false;
1133
1134 PCB_GROUP* group = static_cast<PCB_GROUP*>( aSel.GetItem( 0 ) );
1135
1136 return group->HasDesignBlockLink();
1137 };
1138
1139 wxASSERT( mgr );
1140
1141#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1142#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1143// clang-format off
1144
1146 mgr->SetConditions( ACTIONS::undo, ENABLE( undoCond ) );
1148
1152
1153 mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
1154 mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
1161
1162 // Keep immediate-mode dispatch alive while a tool is mid-edit on an empty board, where
1163 // HasItems() is still false but an item is under construction under the cursor.
1164 auto hasElements =
1165 [ this ] ( const SELECTION& aSel )
1166 {
1167 return GetBoard() &&
1168 ( !GetBoard()->IsEmpty() || !SELECTION_CONDITIONS::Idle( aSel ) );
1169 };
1170
1172 ENABLE( SELECTION_CONDITIONS::NotEmpty ).HotkeyEnable( hasElements ) );
1174 ENABLE( SELECTION_CONDITIONS::NotEmpty ).HotkeyEnable( hasElements ) );
1176 ENABLE( SELECTION_CONDITIONS::NotEmpty ).HotkeyEnable( hasElements ) );
1178 ENABLE( SELECTION_CONDITIONS::NotEmpty ).HotkeyEnable( hasElements ) );
1179
1180 static const std::vector<KICAD_T> groupTypes = { PCB_GROUP_T, PCB_GENERATOR_T };
1181
1186
1187 mgr->SetConditions( PCB_ACTIONS::placeLinkedDesignBlock, ENABLE( groupWithDesignBlockLink) );
1188 mgr->SetConditions( PCB_ACTIONS::saveToLinkedDesignBlock, ENABLE( groupWithDesignBlockLink) );
1189
1195
1196 auto enableZoneControlCondition =
1197 [this] ( const SELECTION& )
1198 {
1201 };
1202
1204 ENABLE( enableZoneControlCondition )
1207 ENABLE( enableZoneControlCondition )
1210 ENABLE( enableZoneControlCondition )
1213 ENABLE( enableZoneControlCondition )
1215
1217
1218 auto autoConstraintsCond =
1219 []( const SELECTION& )
1220 {
1222 return cfg && cfg->m_AutoConstraints;
1223 };
1224
1225 mgr->SetConditions( PCB_ACTIONS::toggleAutoConstraints, CHECK( autoConstraintsCond ) );
1226
1227 auto boardFlippedCond =
1228 [this]( const SELECTION& )
1229 {
1231 };
1232
1233 auto layerManagerCond =
1234 [this] ( const SELECTION& )
1235 {
1236 return LayerManagerShown();
1237 };
1238
1239 auto propertiesCond =
1240 [this] ( const SELECTION& )
1241 {
1242 return PropertiesShown();
1243 };
1244
1245 auto netInspectorCond =
1246 [this] ( const SELECTION& )
1247 {
1248 return NetInspectorShown();
1249 };
1250
1251 auto searchPaneCond =
1252 [this] ( const SELECTION& )
1253 {
1254 return m_auimgr.GetPane( SearchPaneName() ).IsShown();
1255 };
1256
1257 auto constraintsPaneCond =
1258 [this] ( const SELECTION& )
1259 {
1260 return m_auimgr.GetPane( ConstraintsPaneName() ).IsShown();
1261 };
1262
1263 auto designBlockCond =
1264 [ this ] (const SELECTION& aSel )
1265 {
1266 return m_auimgr.GetPane( DesignBlocksPaneName() ).IsShown();
1267 };
1268
1269 auto highContrastCond =
1270 [this] ( const SELECTION& )
1271 {
1273 };
1274
1275 auto globalRatsnestCond =
1276 [this] (const SELECTION& )
1277 {
1279 return cfg && cfg->m_Display.m_ShowGlobalRatsnest;
1280 };
1281
1282 auto curvedRatsnestCond =
1283 [this] (const SELECTION& )
1284 {
1286 return cfg && cfg->m_Display.m_DisplayRatsnestLinesCurved;
1287 };
1288
1289 auto netHighlightCond =
1290 [this]( const SELECTION& )
1291 {
1292 if( PCB_DRAW_PANEL_GAL* canvas = GetCanvas() )
1293 {
1294 if( KIGFX::PCB_VIEW* view = canvas->GetView() )
1295 {
1296 if( KIGFX::PAINTER* painter = view->GetPainter() )
1297 {
1298 if( RENDER_SETTINGS* settings = painter->GetSettings() )
1299 return !settings->GetHighlightNetCodes().empty();
1300 }
1301 }
1302 }
1303
1304 return false;
1305 };
1306
1307 auto enableNetHighlightCond =
1308 [this]( const SELECTION& )
1309 {
1311 return tool && tool->IsNetHighlightSet();
1312 };
1313
1314 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
1315 mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
1316 mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
1317 mgr->SetConditions( PCB_ACTIONS::showRatsnest, CHECK( globalRatsnestCond ) );
1318 mgr->SetConditions( PCB_ACTIONS::ratsnestLineMode, CHECK( curvedRatsnestCond ) );
1319 mgr->SetConditions( PCB_ACTIONS::toggleNetHighlight, CHECK( netHighlightCond )
1320 .Enable( enableNetHighlightCond ) );
1321 mgr->SetConditions( ACTIONS::showProperties, CHECK( propertiesCond ) );
1322 mgr->SetConditions( PCB_ACTIONS::showNetInspector, CHECK( netInspectorCond ) );
1323 mgr->SetConditions( PCB_ACTIONS::showSearch, CHECK( searchPaneCond ) );
1324 mgr->SetConditions( PCB_ACTIONS::showConstraintsPanel, CHECK( constraintsPaneCond ) );
1325 mgr->SetConditions( PCB_ACTIONS::showDesignBlockPanel, CHECK( designBlockCond ) );
1326
1329
1330 const auto isArcKeepCenterMode =
1331 [this]( const SELECTION& )
1332 {
1335 };
1336
1337 const auto isArcKeepEndpointMode =
1338 [this]( const SELECTION& )
1339 {
1342 };
1343
1344 const auto isArcKeepRadiusMode =
1345 [this]( const SELECTION& )
1346 {
1349 };
1350
1351 mgr->SetConditions( ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
1352 mgr->SetConditions( ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
1353 mgr->SetConditions( ACTIONS::pointEditorArcKeepRadius, CHECK( isArcKeepRadiusMode ) );
1354
1355 auto isHighlightMode =
1356 [this]( const SELECTION& )
1357 {
1358 ROUTER_TOOL* tool = m_toolManager->GetTool<ROUTER_TOOL>();
1359 return tool && tool->GetRouterMode() == PNS::RM_MarkObstacles;
1360 };
1361
1362 auto isShoveMode =
1363 [this]( const SELECTION& )
1364 {
1365 ROUTER_TOOL* tool = m_toolManager->GetTool<ROUTER_TOOL>();
1366 return tool && tool->GetRouterMode() == PNS::RM_Shove;
1367 };
1368
1369 auto isWalkaroundMode =
1370 [this]( const SELECTION& )
1371 {
1372 ROUTER_TOOL* tool = m_toolManager->GetTool<ROUTER_TOOL>();
1373 return tool && tool->GetRouterMode() == PNS::RM_Walkaround;
1374 };
1375
1376 mgr->SetConditions( PCB_ACTIONS::routerHighlightMode, CHECK( isHighlightMode ) );
1377 mgr->SetConditions( PCB_ACTIONS::routerShoveMode, CHECK( isShoveMode ) );
1378 mgr->SetConditions( PCB_ACTIONS::routerWalkaroundMode, CHECK( isWalkaroundMode ) );
1379
1380 auto isAutoTrackWidth =
1381 [this]( const SELECTION& )
1382 {
1384 };
1385
1386 mgr->SetConditions( PCB_ACTIONS::autoTrackWidth, CHECK( isAutoTrackWidth ) );
1387
1388 auto haveNetCond =
1389 [] ( const SELECTION& aSel )
1390 {
1391 for( EDA_ITEM* item : aSel )
1392 {
1393 if( BOARD_CONNECTED_ITEM* bci = dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
1394 {
1395 if( bci->GetNetCode() > 0 )
1396 return true;
1397 }
1398 }
1399
1400 return false;
1401 };
1402
1403 auto connectedOrFootprintCond =
1404 [] ( const SELECTION& aSel )
1405 {
1406 if( aSel.Empty() )
1407 return false;
1408
1409 for( EDA_ITEM* item : aSel )
1410 {
1411 if( item->Type() == PCB_FOOTPRINT_T )
1412 continue;
1413
1414 if( !dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
1415 return false;
1416 }
1417
1418 return true;
1419 };
1420
1421 mgr->SetConditions( PCB_ACTIONS::showNetInRatsnest, ENABLE( haveNetCond ) );
1422 mgr->SetConditions( PCB_ACTIONS::hideNetInRatsnest, ENABLE( haveNetCond ) );
1425
1426 static const std::vector<KICAD_T> trackTypes = { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T };
1427 static const std::vector<KICAD_T> padOwnerTypes = { PCB_FOOTPRINT_T, PCB_PAD_T };
1428 static const std::vector<KICAD_T> footprintTypes = { PCB_FOOTPRINT_T };
1429 static const std::vector<KICAD_T> crossProbeTypes = { PCB_PAD_T, PCB_FOOTPRINT_T, PCB_GROUP_T };
1430 static const std::vector<KICAD_T> zoneTypes = { PCB_ZONE_T };
1431
1435 mgr->SetConditions( PCB_ACTIONS::grabUnconnected, ENABLE( connectedOrFootprintCond ) );
1438
1439
1441 && SELECTION_CONDITIONS::OnlyTypes( zoneTypes );
1442
1444 && SELECTION_CONDITIONS::OnlyTypes( zoneTypes );
1445
1446 mgr->SetConditions( PCB_ACTIONS::zoneDuplicate, ENABLE( singleZoneCond ) );
1447 mgr->SetConditions( PCB_ACTIONS::drawZoneCutout, ENABLE( singleZoneCond ) );
1448 mgr->SetConditions( PCB_ACTIONS::drawSimilarZone, ENABLE( singleZoneCond ) );
1449 mgr->SetConditions( PCB_ACTIONS::zoneMerge, ENABLE( zoneMergeCond ) );
1450
1453
1454#define CURRENT_TOOL( action ) mgr->SetConditions( action, CHECK( cond.CurrentTool( action ) ) )
1455
1456 // These tools can be used at any time to inspect the board
1461
1462 auto isDRCIdle =
1463 [this] ( const SELECTION& )
1464 {
1465 DRC_TOOL* tool = m_toolManager->GetTool<DRC_TOOL>();
1466 return !( tool && tool->IsDRCRunning() );
1467 };
1468
1469#define CURRENT_EDIT_TOOL( action ) \
1470 mgr->SetConditions( action, ACTION_CONDITIONS().Check( cond.CurrentTool( action ) ) \
1471 .Enable( isDRCIdle ) )
1472
1473 // These tools edit the board, so they must be disabled during some operations
1511
1530
1536
1537#undef CURRENT_TOOL
1538#undef CURRENT_EDIT_TOOL
1539#undef ENABLE
1540#undef CHECK
1541// clang-format on
1542}
1543
1544
1545void PCB_EDIT_FRAME::OnQuit( wxCommandEvent& event )
1546{
1547 if( event.GetId() == wxID_EXIT )
1548 Kiway().OnKiCadExit();
1549
1550 if( event.GetId() == wxID_CLOSE || Kiface().IsSingle() )
1551 Close( false );
1552}
1553
1554
1555void PCB_EDIT_FRAME::ResolveDRCExclusions( bool aCreateMarkers )
1556{
1557 BOARD_COMMIT commit( this );
1558
1559 for( PCB_MARKER* marker : GetBoard()->ResolveDRCExclusions( aCreateMarkers ) )
1560 {
1561 if( marker->GetMarkerType() == MARKER_BASE::MARKER_DRAWING_SHEET )
1562 marker->GetRCItem()->SetItems( GetCanvas()->GetDrawingSheet() );
1563
1564 commit.Add( marker );
1565 }
1566
1567 commit.Push( wxEmptyString, SKIP_UNDO | SKIP_SET_DIRTY );
1568
1569 for( PCB_MARKER* marker : GetBoard()->Markers() )
1570 {
1571 if( marker->GetSeverity() == RPT_SEVERITY_EXCLUSION )
1572 GetCanvas()->GetView()->Update( marker );
1573 }
1574
1576}
1577
1578
1579bool PCB_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
1580{
1581 // Shutdown blocks must be determined and vetoed as early as possible
1582 if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION
1583 && IsContentModified() )
1584 {
1585 return false;
1586 }
1587
1588 ZONE_FILLER_TOOL* zoneFillerTool = m_toolManager->GetTool<ZONE_FILLER_TOOL>();
1589
1590 if( zoneFillerTool->IsBusy() )
1591 {
1592 wxBell();
1593
1594 if( wxWindow* reporter = dynamic_cast<wxWindow*>( zoneFillerTool->GetProgressReporter() ) )
1595 reporter->ShowWithEffect( wxSHOW_EFFECT_EXPAND );
1596
1597 return false;
1598 }
1599
1600 // Don't allow closing while the modal footprint chooser is open
1601 // Use C-style cast due to Mac's inability to dynamic cast between compile modules
1603
1604 if( chooser && chooser->IsModal() ) // Can close footprint chooser?
1605 return false;
1606
1607 if( Kiface().IsSingle() )
1608 {
1609 // Use C-style cast due to Mac's inability to dynamic cast between compile modules
1611
1612 if( fpEditor )
1613 {
1614 bool cancel = !fpEditor->Close(); // Can close footprint editor?
1615
1616 // If fp editor had unsaved changes it will have been fronted. Bring board editor back to front.
1617 Raise();
1618
1619 if( cancel )
1620 return false;
1621 }
1622
1623 // Use C-style cast due to Mac's inability to dynamic cast between compile modules
1625
1626 if( fpViewer && !fpViewer->Close() ) // Can close footprint viewer?
1627 return false;
1628 }
1629 else
1630 {
1631 // Use C-style cast due to Mac's inability to dynamic cast between compile modules
1633
1634 if( fpEditor )
1635 {
1636 bool cancel = !fpEditor->HandleUnsavedChanges( true );
1637
1638 // If fp editor had unsaved changes it will have been fronted. Bring board editor back to front.
1639 Raise();
1640
1641 if( cancel )
1642 return false;
1643 }
1644 }
1645
1647 return false;
1648
1649 if( IsContentModified() )
1650 {
1651 wxFileName fileName = GetBoard()->GetFileName();
1652 wxString msg = _( "Save changes to '%s' before closing?" );
1653
1654 wxSafeYield( this, true ); // Allow frame to come to front before showing "Save Changes?"
1655
1656 if( !HandleUnsavedChanges( this, wxString::Format( msg, fileName.GetFullName() ),
1657 [&]() -> bool
1658 {
1659 return SaveBoard();
1660 } ) )
1661 {
1662 return false;
1663 }
1664
1665 // If user discarded changes, create a duplicate commit of last saved PCB state and
1666 // advance Last_Save_pcb tag for explicit history event.
1667 if( GetLastUnsavedChangesResponse() == wxID_NO )
1668 {
1669 wxString projPath = Prj().GetProjectPath();
1670
1671 if( !projPath.IsEmpty() && Kiway().LocalHistory().HistoryExists( projPath ) )
1672 {
1673 Kiway().LocalHistory().CommitDuplicateOfLastSave( projPath, wxS( "pcb" ),
1674 wxS( "Discard unsaved pcb changes" ) );
1675 }
1676 }
1677 }
1678
1679 return PCB_BASE_EDIT_FRAME::canCloseWindow( aEvent );
1680}
1681
1682
1684{
1685 // Unregister the autosave saver before any cleanup that might invalidate the board
1686 if( GetBoard() )
1688
1689 // On Windows 7 / 32 bits, on OpenGL mode only, Pcbnew crashes
1690 // when closing this frame if a footprint was selected, and the footprint editor called
1691 // to edit this footprint, and when closing pcbnew if this footprint is still selected
1692 // See https://bugs.launchpad.net/kicad/+bug/1655858
1693 // I think this is certainly a OpenGL event fired after frame deletion, so this workaround
1694 // avoid the crash (JPC)
1695 GetCanvas()->SetEvtHandlerEnabled( false );
1696
1698
1701
1702 // Clean up mode-less dialogs.
1703 Unbind( EDA_EVT_CLOSE_DIALOG_BOOK_REPORTER, &PCB_EDIT_FRAME::onCloseModelessBookReporterDialogs, this );
1704 Unbind( EDA_EVT_CLOSE_DIALOG_FOOTPRINT_FIELDS_TABLE, &PCB_EDIT_FRAME::onCloseFootprintFieldsTableDialog, this );
1705
1706 wxWindow* drcDlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
1707
1708 if( drcDlg )
1709 drcDlg->Close( true );
1710
1711 wxWindow* ruleEditorDlg = wxWindow::FindWindowByName( DIALOG_DRC_RULE_EDITOR_WINDOW_NAME );
1712
1713 if( ruleEditorDlg )
1714 ruleEditorDlg->Close( true );
1715
1716 if( m_findDialog )
1717 {
1718 m_findDialog->Destroy();
1719 m_findDialog = nullptr;
1720 }
1721
1723 {
1724 m_findByPropertiesDialog->Destroy();
1725 m_findByPropertiesDialog = nullptr;
1726 }
1727
1729 {
1730 m_inspectDrcErrorDlg->Destroy();
1731 m_inspectDrcErrorDlg = nullptr;
1732 }
1733
1735 {
1736 m_inspectClearanceDlg->Destroy();
1737 m_inspectClearanceDlg = nullptr;
1738 }
1739
1741 {
1742 m_inspectConstraintsDlg->Destroy();
1743 m_inspectConstraintsDlg = nullptr;
1744 }
1745
1746 if( m_footprintDiffDlg )
1747 {
1748 m_footprintDiffDlg->Destroy();
1749 m_footprintDiffDlg = nullptr;
1750 }
1751
1753 {
1756 }
1757
1758 // Delete the auto save file if it exists. Only sweep when the board was actually dirtied in this session;
1759 // otherwise an existing autosave is a previous-session leftover the user explicitly deferred in the recovery
1760 // dialog.
1761 if( !Prj().IsNullProject() && GetBoard() && IsContentModified() )
1762 {
1763 Kiway().LocalHistory().RemoveAutosaveFiles( Prj().GetProjectPath(), { GetBoard()->GetFileName() } );
1764 }
1765
1766 // Make sure local settings are persisted
1767 if( Prj().GetLocalSettings().ShouldAutoSave() )
1768 {
1769 m_netInspectorPanel->SaveSettings();
1771 }
1772 else
1773 {
1774 wxLogTrace( traceAutoSave, wxT( "Skipping auto-save of migrated local settings" ) );
1775 }
1776
1777 // Do not show the layer manager during closing to avoid flicker on some platforms (Windows) that
1778 // generate useless redraw of items in the Layer Manager
1780 {
1781 m_auimgr.GetPane( wxS( "LayersManager" ) ).Show( false );
1782 m_auimgr.GetPane( wxS( "TabbedPanel" ) ).Show( false );
1783 }
1784
1785 // Unlink the old project if needed
1787
1788 // Delete board structs and undo/redo lists, to avoid crash on exit when deleting some structs
1789 // (mainly in undo/redo lists) too late
1790 Clear_Pcb( false, true );
1791
1792 // do not show the window because ScreenPcb will be deleted and we do not want any paint event
1793 Show( false );
1794
1796}
1797
1798
1805
1806
1808{
1809 BOARD* board = GetBoard();
1810 KIGFX::VIEW* view = GetCanvas()->GetView();
1811
1812 board->RefreshDrillSymbolLayers();
1813
1814 for( PCB_TRACK* track : board->Tracks() )
1815 {
1816 if( track->Type() == PCB_VIA_T )
1817 view->Update( track, aUpdateFlags );
1818 }
1819
1820 for( FOOTPRINT* footprint : board->Footprints() )
1821 {
1822 for( PAD* pad : footprint->Pads() )
1823 {
1824 if( pad->HasHole() )
1825 view->Update( pad, aUpdateFlags );
1826 }
1827 }
1828
1829 GetCanvas()->Refresh();
1830}
1831
1832
1833void PCB_EDIT_FRAME::ShowBoardSetupDialog( const wxString& aInitialPage, wxWindow* aParent )
1834{
1835 static std::mutex dialogMutex; // Local static mutex
1836
1837 std::unique_lock<std::mutex> dialogLock( dialogMutex, std::try_to_lock );
1838
1839 // One dialog at a time.
1840 if( !dialogLock.owns_lock() )
1841 {
1842 if( m_boardSetupDlg && m_boardSetupDlg->IsShown() )
1843 {
1844 m_boardSetupDlg->Raise(); // Brings the existing dialog to the front
1845 }
1846
1847 return;
1848 }
1849
1850 // Make sure everything's up-to-date
1852
1853 DIALOG_BOARD_SETUP dlg( this, aParent );
1854
1855 if( !aInitialPage.IsEmpty() )
1856 dlg.SetInitialPage( aInitialPage, wxEmptyString );
1857
1858 // Assign dlg to the m_boardSetupDlg pointer to track its status.
1859 m_boardSetupDlg = &dlg;
1860
1861 // QuasiModal required for Scintilla auto-complete
1862 if( dlg.ShowQuasiModal() == wxID_OK )
1863 {
1864 // Note: We must synchronise time domain properties before nets and classes, otherwise the updates
1865 // called by the board listener events are using stale data
1868
1869 if( !GetBoard()->SynchronizeComponentClasses( std::unordered_set<wxString>() ) )
1870 {
1871 m_infoBar->RemoveAllButtons();
1872 m_infoBar->AddCloseButton();
1873 m_infoBar->ShowMessage( _( "Could not load component class assignment rules" ), wxICON_WARNING,
1874 WX_INFOBAR::MESSAGE_TYPE::GENERIC );
1875 }
1876
1877 // We don't know if anything was modified, so err on the side of requiring a save
1878 OnModify();
1879
1881
1884
1885 // CROSS_REF keys deliberately excluded — those are driven by per-item
1886 // BOARD_COMMIT changes.
1887 if( BOARD_TEXT_VAR_ADAPTER* adapter = GetBoard()->GetTextVarAdapter() )
1888 adapter->Tracker().InvalidateProjectScoped();
1889
1890 PCBNEW_SETTINGS* settings = GetPcbNewSettings();
1891 static LSET maskAndPasteLayers = LSET( { F_Mask, F_Paste, B_Mask, B_Paste } );
1892
1894 [&]( KIGFX::VIEW_ITEM* aItem ) -> int
1895 {
1896 int flags = 0;
1897
1898 if( !aItem->IsBOARD_ITEM() )
1899 return flags;
1900
1901 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( aItem );
1902
1903 if( item->Type() == PCB_VIA_T || item->Type() == PCB_PAD_T )
1904 {
1905 // Note: KIGFX::REPAINT isn't enough for things that go from invisible
1906 // to visible as they won't be found in the view layer's itemset for
1907 // re-painting.
1908 if( ( GetBoard()->GetVisibleLayers() & maskAndPasteLayers ).any() )
1909 flags |= KIGFX::ALL;
1910 }
1911
1912 if( item->Type() == PCB_TRACE_T || item->Type() == PCB_ARC_T || item->Type() == PCB_VIA_T )
1913 {
1915 flags |= KIGFX::REPAINT;
1916 }
1917
1918 if( item->Type() == PCB_PAD_T )
1919 {
1920 if( settings->m_Display.m_PadClearance )
1921 flags |= KIGFX::REPAINT;
1922 }
1923
1924 if( EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( aItem ) )
1925 {
1926 if( text->HasTextVars() )
1927 {
1928 text->ClearRenderCache();
1929 text->ClearBoundingBoxCache();
1931 }
1932 }
1933
1934 return flags;
1935 } );
1936
1937 GetCanvas()->Refresh();
1938
1942
1943 //this event causes the routing tool to reload its design rules information
1945 toolEvent.SetHasPosition( false );
1946 m_toolManager->ProcessEvent( toolEvent );
1947 }
1948
1949 GetCanvas()->SetFocus();
1950
1951 // Reset m_boardSetupDlg after the dialog is closed
1952 m_boardSetupDlg = nullptr;
1953}
1954
1955
1957{
1958 m_searchPane->FocusSearch();
1959}
1960
1961
1963{
1965
1966 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
1967 wxASSERT( cfg );
1968
1969 if( cfg )
1970 {
1974 }
1975}
1976
1977
1979{
1981
1982 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
1983 wxASSERT( cfg );
1984
1985 if( cfg )
1986 {
1987 wxAuiPaneInfo& apperancePane = m_auimgr.GetPane( AppearancePanelName() );
1988 cfg->m_AuiPanels.show_layer_manager = apperancePane.IsShown();
1989
1990 if( m_propertiesPanel )
1991 {
1992 cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
1994 cfg->m_AuiPanels.properties_splitter = m_propertiesPanel->SplitterProportion();
1995 }
1996
1997 // ensure m_ShowSearch is up to date (the pane can be closed)
1998 wxAuiPaneInfo& searchPaneInfo = m_auimgr.GetPane( SearchPaneName() );
1999 m_ShowSearch = searchPaneInfo.IsShown();
2001 cfg->m_AuiPanels.search_panel_height = m_searchPane->GetSize().y;
2002 cfg->m_AuiPanels.search_panel_width = m_searchPane->GetSize().x;
2003 cfg->m_AuiPanels.search_panel_dock_direction = searchPaneInfo.dock_direction;
2004
2006 {
2007 wxAuiPaneInfo& netInspectorhPaneInfo = m_auimgr.GetPane( NetInspectorPanelName() );
2008 m_ShowNetInspector = netInspectorhPaneInfo.IsShown();
2010 }
2011
2012 if( m_appearancePanel )
2013 {
2016 cfg->m_AuiPanels.appearance_expand_layer_display = m_appearancePanel->IsLayerOptionsExpanded();
2017 cfg->m_AuiPanels.appearance_expand_net_display = m_appearancePanel->IsNetOptionsExpanded();
2018 }
2019
2020 wxAuiPaneInfo& designBlocksPane = m_auimgr.GetPane( DesignBlocksPaneName() );
2021 cfg->m_AuiPanels.design_blocks_show = designBlocksPane.IsShown();
2022
2023 if( designBlocksPane.IsDocked() )
2024 {
2026 }
2027 else
2028 {
2029 cfg->m_AuiPanels.design_blocks_panel_float_height = designBlocksPane.floating_size.y;
2030 cfg->m_AuiPanels.design_blocks_panel_float_width = designBlocksPane.floating_size.x;
2031 }
2032
2033 m_designBlocksPane->SaveSettings();
2034 }
2035}
2036
2037
2039{
2040 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( config() );
2041
2042 return cfg ? cfg->m_RotationAngle : ANGLE_90;
2043}
2044
2045
2050
2051
2053{
2054
2055 GetColorSettings()->SetColor( LAYER_GRID, aColor );
2056 GetCanvas()->GetGAL()->SetGridColor( aColor );
2057}
2058
2059
2060void PCB_EDIT_FRAME::SetActiveLayer( PCB_LAYER_ID aLayer, bool aForceRedraw )
2061{
2062 const PCB_LAYER_ID oldLayer = GetActiveLayer();
2063
2064 if( oldLayer == aLayer && !aForceRedraw )
2065 return;
2066
2068
2069 m_appearancePanel->OnLayerChanged();
2070
2071 m_toolManager->PostAction( PCB_ACTIONS::layerChanged ); // notify other tools
2072 GetCanvas()->SetFocus(); // allow capture of hotkeys
2073 GetCanvas()->SetHighContrastLayer( aLayer );
2074
2075 /*
2076 * Only show pad, via and track clearances when a copper layer is active
2077 * and then only show the clearance layer for that copper layer. For
2078 * front/back non-copper layers, show the clearance layer for the outer
2079 * layer on that side.
2080 *
2081 * For pads/vias, this is to avoid clutter when there are pad/via layers
2082 * that vary in flash (i.e. clearance from the hole or pad edge), padstack
2083 * shape on each layer or clearances on each layer.
2084 *
2085 * For tracks, this follows the same logic as pads/vias, but in theory could
2086 * have their own set of independent clearance layers to allow track clearance
2087 * to be shown for more layers.
2088 */
2089 const auto getClearanceLayerForActive =
2090 []( PCB_LAYER_ID aActiveLayer ) -> std::optional<int>
2091 {
2092 if( IsCopperLayer( aActiveLayer ) )
2093 return CLEARANCE_LAYER_FOR( aActiveLayer );
2094
2095 return std::nullopt;
2096 };
2097
2098 if( std::optional<int> oldClearanceLayer = getClearanceLayerForActive( oldLayer ) )
2099 GetCanvas()->GetView()->SetLayerVisible( *oldClearanceLayer, false );
2100
2101 if( std::optional<int> newClearanceLayer = getClearanceLayerForActive( aLayer ) )
2102 GetCanvas()->GetView()->SetLayerVisible( *newClearanceLayer, true );
2103
2104 // per-layer view groups already hold each layer geometry so an active-layer change needs no
2105 // re-tessellation just clearance visibility above and the recolour in SetHighContrastLayer
2106
2107 // idle refresh coalesces mashed hotkeys into one repaint forced redraws stay immediate
2108 if( aForceRedraw )
2109 GetCanvas()->Refresh();
2110 else
2112}
2113
2114
2116{
2117 wxFileName fn( GetBoard()->GetFileName() );
2118
2120
2121 layerEnum.Choices().Clear();
2122 layerEnum.Undefined( UNDEFINED_LAYER );
2123
2124 for( PCB_LAYER_ID layer : LSET::AllLayersMask() )
2125 {
2126 // Canonical name
2127 layerEnum.Map( layer, LSET::Name( layer ) );
2128
2129 // User name
2130 layerEnum.Map( layer, GetBoard()->GetLayerName( layer ) );
2131 }
2132
2133 DRC_TOOL* drcTool = m_toolManager->GetTool<DRC_TOOL>();
2134
2135 try
2136 {
2137 drcTool->GetDRCEngine()->InitEngine( GetBoard()->GetDesignRulesPath() );
2138 }
2139 catch( PARSE_ERROR& )
2140 {
2141 // Not sure this is the best place to tell the user their rules are buggy, so
2142 // we'll stay quiet for now. Feel free to revisit this decision....
2143 }
2144
2146
2147 // Migrate obsolete WRL 3D model references to current STEP models. Only
2148 // runs in the GUI: CLI and scripting load paths must not mutate board
2149 // state on load. The STEP exporter does its own WRL->STEP substitution at
2150 // export time via the --subst-models flag, and the 3D cache quietly falls
2151 // back to sibling STEP files for missing WRLs in headless contexts.
2152 if( Pgm().IsGUI() )
2153 {
2154 // Silently replace references whose filename uniquely identifies a
2155 // STEP sibling. Leaves ambiguous cases for the infobar below.
2157
2158 if( int unresolved = DIALOG_MIGRATE_3D_MODELS::CountUnresolvedWrlReferences( this ) )
2159 {
2160 wxString msg = _( "WRL 3D model could not be matched to equivalent STEP model." );
2161
2162 if( unresolved > 1 )
2163 {
2164 msg = wxString::Format( _( "%d WRL 3D models could not be matched to equivalent STEP models." ),
2165 unresolved );
2166 }
2167
2168 m_loadNoticeInfoBar->RemoveAllButtons();
2169 m_loadNoticeInfoBar->AddLink( _( "Show options" ),
2170 [this]( wxHyperlinkEvent& )
2171 {
2172 DIALOG_MIGRATE_3D_MODELS dlg( this );
2173 dlg.ShowModal();
2174
2175 // Dismiss the infobar if nothing remains to resolve;
2176 // otherwise leave it so the user can try again.
2178 m_loadNoticeInfoBar->Dismiss();
2179 } );
2180 m_loadNoticeInfoBar->AddCloseButton();
2181 m_loadNoticeInfoBar->ShowMessageFor( msg, 10000, wxICON_INFORMATION );
2182 }
2183 }
2184
2185 UpdateTitle();
2186
2187 // Display a warning that the file is read only
2188 if( fn.FileExists() && !fn.IsFileWritable() )
2189 {
2190 m_infoBar->RemoveAllButtons();
2191 m_infoBar->AddCloseButton();
2192 m_infoBar->ShowMessage( _( "Board file is read only." ), wxICON_WARNING,
2193 WX_INFOBAR::MESSAGE_TYPE::OUTDATED_SAVE );
2194 }
2195
2197
2198 // Sync layer and item visibility
2200
2201 SetElementVisibility( LAYER_RATSNEST, GetPcbNewSettings()->m_Display.m_ShowGlobalRatsnest );
2202
2203 m_appearancePanel->OnBoardChanged();
2204
2205 // Apply saved display state to the appearance panel after it has been set up
2206 PROJECT_LOCAL_SETTINGS& localSettings = Prj().GetLocalSettings();
2207
2208 m_appearancePanel->ApplyLayerPreset( localSettings.m_ActiveLayerPreset );
2209
2210 if( GetBoard()->GetDesignSettings().IsLayerEnabled( localSettings.m_ActiveLayer ) )
2211 SetActiveLayer( localSettings.m_ActiveLayer, true );
2212 else
2213 SetActiveLayer( GetActiveLayer(), true ); // Make sure to repaint even if not switching
2214
2215 PROJECT_FILE& projectFile = Prj().GetProjectFile();
2216
2217 m_layerPairSettings->SetLayerPairs( projectFile.m_LayerPairInfos );
2218 m_layerPairSettings->SetCurrentLayerPair( LAYER_PAIR{ F_Cu, B_Cu } );
2219
2220 // Updates any auto dimensions and the auxiliary toolbar tracks/via sizes
2222
2223 // Sync the net inspector now we have connectivity calculated
2225 m_netInspectorPanel->OnBoardChanged();
2226
2227 // Display the loaded board:
2228 Zoom_Automatique( false );
2229
2230 // The DRC engine above makes clearances computable, so only the items that draw a
2231 // clearance outline are stale; marking every item re-tessellates the whole board
2232 {
2233 KIGFX::VIEW* view = GetCanvas()->GetView();
2234 const auto& opts = GetPcbNewSettings()->m_Display;
2235
2236 for( FOOTPRINT* footprint : GetBoard()->Footprints() )
2237 {
2238 for( PAD* pad : footprint->Pads() )
2239 view->Update( pad, KIGFX::REPAINT );
2240 }
2241
2242 if( opts.m_TrackClearance == SHOW_WITH_VIA_ALWAYS )
2243 {
2244 for( PCB_TRACK* track : GetBoard()->Tracks() )
2245 view->Update( track, KIGFX::REPAINT );
2246 }
2247 }
2248
2249 Refresh();
2250
2251 SetMsgPanel( GetBoard() );
2252 SetStatusText( wxEmptyString );
2253
2254 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "PCB file changes are unsaved" ) );
2255}
2256
2257
2259{
2260 m_appearancePanel->UpdateDisplayOptions();
2261}
2262
2263
2265{
2266 return GetBoard()->IsElementVisible( aElement );
2267}
2268
2269
2271{
2272 // Force the RATSNEST visible
2273 if( aElement == LAYER_RATSNEST )
2274 GetCanvas()->GetView()->SetLayerVisible( aElement, true );
2275 else
2276 GetCanvas()->GetView()->SetLayerVisible( aElement , aNewState );
2277
2278 GetBoard()->SetElementVisibility( aElement, aNewState );
2279}
2280
2281
2283{
2284 // call my base class
2286
2287 m_auimgr.GetPane( m_appearancePanel ).Caption( _( "Appearance" ) );
2288 m_auimgr.GetPane( m_selectionFilterPanel ).Caption( _( "Selection Filter" ) );
2289 m_auimgr.GetPane( m_propertiesPanel ).Caption( _( "Properties" ) );
2290 m_auimgr.GetPane( m_netInspectorPanel ).Caption( _( "Net Inspector" ) );
2291 m_auimgr.Update();
2292
2293 UpdateTitle();
2294}
2295
2296
2298{
2300
2301 if( project.m_PcbLastPath[ aType ].IsEmpty() )
2302 return wxEmptyString;
2303
2304 wxFileName absoluteFileName = project.m_PcbLastPath[ aType ];
2305 wxFileName pcbFileName = GetBoard()->GetFileName();
2306
2307 absoluteFileName.MakeAbsolute( pcbFileName.GetPath() );
2308 return absoluteFileName.GetFullPath();
2309}
2310
2311
2312void PCB_EDIT_FRAME::SetLastPath( LAST_PATH_TYPE aType, const wxString& aLastPath )
2313{
2315
2316 wxFileName relativeFileName = aLastPath;
2317 wxFileName pcbFileName = GetBoard()->GetFileName();
2318
2319 relativeFileName.MakeRelativeTo( pcbFileName.GetPath() );
2320
2321 if( relativeFileName.GetFullPath() != project.m_PcbLastPath[ aType ] )
2322 {
2323 project.m_PcbLastPath[ aType ] = relativeFileName.GetFullPath();
2324 OnModify();
2325 }
2326}
2327
2328
2330{
2332 Kiway().LocalHistory().NoteFileChange( GetBoard()->GetFileName() );
2333 m_ZoneFillsDirty = true;
2334
2335 if( m_isClosing )
2336 return;
2337
2338 // A chart reports the board, so an edit that moved a hole has already made it wrong.
2339 // Costs one integer comparison per chart when nothing drill related changed.
2341
2342 Update3DView( true, GetPcbNewSettings()->m_Display.m_Live3DRefresh );
2343
2344 if( !GetTitle().StartsWith( wxT( "*" ) ) )
2345 UpdateTitle();
2346}
2347
2348
2350{
2351 // The libraries were read once and then cached. A refresh is where they need to be refreshed
2353
2354 Update3DView( true, true );
2355
2356 std::shared_ptr<CONNECTIVITY_DATA> connectivity = GetBoard()->GetConnectivity();
2357 connectivity->RecalculateRatsnest( nullptr );
2359
2360 std::vector<MSG_PANEL_ITEM> msg_list;
2361 GetBoard()->GetMsgPanelInfo( this, msg_list );
2362 SetMsgPanel( msg_list );
2363}
2364
2365
2367{
2368 wxFileName fn = GetBoard()->GetFileName();
2369 bool readOnly = false;
2370 bool unsaved = false;
2371
2372 if( fn.IsOk() && fn.FileExists() )
2373 readOnly = !fn.IsFileWritable();
2374 else
2375 unsaved = true;
2376
2377 wxString title;
2378
2379 if( IsContentModified() )
2380 title = wxT( "*" );
2381
2382 title += fn.GetName();
2383
2384 if( readOnly )
2385 title += wxS( " " ) + _( "[Read Only]" );
2386
2387 if( unsaved )
2388 title += wxS( " " ) + _( "[Unsaved]" );
2389
2390 title += wxT( " \u2014 " ) + _( "PCB Editor" );
2391
2392 SetTitle( title );
2393}
2394
2395
2397{
2398 // Update the layer manager and other widgets from the board setup
2399 // (layer and items visibility, colors ...)
2400
2401 // Rebuild list of nets (full ratsnest rebuild)
2403
2404 // Update info shown by the horizontal toolbars
2406
2407 LSET activeLayers = GetBoard()->GetEnabledLayers();
2408
2409 if( !activeLayers.test( GetActiveLayer() ) )
2410 SetActiveLayer( activeLayers.Seq().front() );
2411
2412 // The layer selector lives on the top auxiliary toolbar. Users can remove every
2413 // entry from that toolbar via Preferences, in which case the control is destroyed
2414 // and m_SelLayerBox is null. Avoid dereferencing it here.
2415 if( m_SelLayerBox )
2416 m_SelLayerBox->SetLayerSelection( GetActiveLayer() );
2417
2419
2420 layerEnum.Choices().Clear();
2421 layerEnum.Undefined( UNDEFINED_LAYER );
2422
2423 for( PCB_LAYER_ID layer : LSET::AllLayersMask() )
2424 {
2425 // Canonical name
2426 layerEnum.Map( layer, LSET::Name( layer ) );
2427
2428 // User name
2429 layerEnum.Map( layer, GetBoard()->GetLayerName( layer ) );
2430 }
2431
2433
2434 // Sync visibility with canvas
2435 for( PCB_LAYER_ID layer : LSET::AllLayersMask() )
2436 GetCanvas()->GetView()->SetLayerVisible( layer, GetBoard()->IsLayerVisible( layer ) );
2437
2438 // Stackup and/or color theme may have changed
2439 m_appearancePanel->OnBoardChanged();
2440 m_netInspectorPanel->OnParentSetupChanged();
2441}
2442
2443
2445{
2446 // switches currently used canvas (Cairo / OpenGL).
2447 PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
2448}
2449
2450
2452{
2453 if( !m_findDialog )
2454 {
2455 m_findDialog = new DIALOG_FIND( this );
2456 m_findDialog->SetCallback( std::bind( &PCB_SELECTION_TOOL::FindItem,
2457 m_toolManager->GetTool<PCB_SELECTION_TOOL>(), _1 ) );
2458 }
2459
2460 wxString findString;
2461
2462 PCB_SELECTION& selection = m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
2463
2464 if( selection.Size() == 1 && selection.Front() != m_findDialog->GetItem() )
2465 {
2466 EDA_ITEM* front = selection.Front();
2467
2468 switch( front->Type() )
2469 {
2470 case PCB_FOOTPRINT_T:
2471 findString = UnescapeString( static_cast<FOOTPRINT*>( front )->GetValue() );
2472 break;
2473
2474 case PCB_FIELD_T:
2475 case PCB_TEXT_T:
2476 findString = UnescapeString( static_cast<PCB_TEXT*>( front )->GetText() );
2477
2478 if( findString.Contains( wxT( "\n" ) ) )
2479 findString = findString.Before( '\n' );
2480
2481 break;
2482
2483 default:
2484 break;
2485 }
2486 }
2487
2488 m_findDialog->Preload( findString );
2489
2490 m_findDialog->Show( true );
2491}
2492
2493
2502
2503
2509
2510
2516
2517
2518void PCB_EDIT_FRAME::FindNext( bool reverse )
2519{
2520 if( !m_findDialog )
2522
2523 m_findDialog->FindNext( reverse );
2524}
2525
2526
2528{
2529 if( Kiface().IsSingle() )
2530 return 0;
2531
2532 // Update PCB requires a netlist. Therefore the schematic editor must be running
2533 // If this is not the case, open the schematic editor
2534 KIWAY_PLAYER* frame = Kiway().Player( FRAME_SCH, true );
2535
2536 // If Kiway() cannot create the eeschema frame, it shows a error message, and
2537 // frame is null
2538 if( !frame )
2539 return -1;
2540
2541 if( !frame->IsShownOnScreen() )
2542 {
2543 wxEventBlocker blocker( this );
2544 wxFileName fn( Prj().GetProjectPath(), Prj().GetProjectName(), FILEEXT::KiCadSchematicFileExtension );
2545
2546 // Maybe the file hasn't been converted to the new s-expression file format so
2547 // see if the legacy schematic file is still in play.
2548 if( !fn.FileExists() )
2549 {
2551
2552 if( !fn.FileExists() )
2553 {
2554 DisplayErrorMessage( this, _( "The schematic for this board cannot be found." ) );
2555 return -2;
2556 }
2557 }
2558
2559 frame->OpenProjectFiles( std::vector<wxString>( 1, fn.GetFullPath() ) );
2560
2561 // we show the schematic editor frame, because do not show is seen as
2562 // a not yet opened schematic by Kicad manager, which is not the case
2563 frame->Show( true );
2564
2565 // bring ourselves back to the front
2566 Raise();
2567 }
2568
2569 return 1; //Success!
2570}
2571
2572
2573bool PCB_EDIT_FRAME::FetchNetlistFromSchematic( NETLIST& aNetlist, const wxString& aAnnotateMessage )
2574{
2575 int standalone = TestStandalone();
2576
2577 if( standalone == 0 )
2578 {
2579 DisplayErrorMessage( this, _( "Cannot update the PCB because PCB editor is opened in stand-alone mode. "
2580 "In order to create or update PCBs from schematics, you must launch the "
2581 "KiCad project manager and create a project." ) );
2582 return false; // Not in standalone mode
2583 }
2584
2585 if( standalone < 0 ) // Problem with Eeschema or the schematic
2586 return false;
2587
2588 Raise(); // Show
2589
2590 std::string payload( aAnnotateMessage );
2591
2592 Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_GET_NETLIST, payload, this );
2593
2594 // Sentinel reply means the user explicitly aborted; silently cancel and return focus to
2595 // the schematic rather than re-showing the annotation error
2596 if( payload == MAIL_SCH_GET_NETLIST_CANCELLED )
2597 {
2598 if( KIWAY_PLAYER* schFrame = Kiway().Player( FRAME_SCH, false ) )
2599 {
2600 if( schFrame->IsIconized() )
2601 schFrame->Iconize( false );
2602
2603 schFrame->Raise();
2604
2605 // Raising the window does not set the focus on Linux. This should work on
2606 // any platform.
2607 if( wxWindow::FindFocus() != schFrame )
2608 schFrame->SetFocus();
2609 }
2610
2611 return false;
2612 }
2613
2614 if( payload == aAnnotateMessage )
2615 {
2616 Raise();
2617 DisplayErrorMessage( this, aAnnotateMessage );
2618 return false;
2619 }
2620
2621 try
2622 {
2623 STRING_LINE_READER* lineReader = new STRING_LINE_READER( payload, _( "Eeschema netlist" ) );
2624 KICAD_NETLIST_READER netlistReader( lineReader, &aNetlist );
2625 netlistReader.LoadNetlist();
2626 }
2627 catch( const IO_ERROR& e )
2628 {
2629 Raise();
2630
2631 // Do not translate extra_info strings. These are for developers
2632 wxString extra_info = e.Problem() + wxT( " : " ) + e.What() + wxT( " at " ) + e.Where();
2633
2634 DisplayErrorMessage( this, _( "Received an error while reading netlist. Please report this issue to "
2635 "the KiCad team using the menu Help->Report Bug." ),
2636 extra_info );
2637 return false;
2638 }
2639
2640 return true;
2641}
2642
2643
2645{
2646 if( aFootprint == nullptr )
2647 return;
2648
2650
2651 /*
2652 * Make sure dlg is destroyed before GetCanvas->Refresh is called
2653 * later or the refresh will try to modify its properties since
2654 * they share a GL context.
2655 */
2656 {
2657 DIALOG_FOOTPRINT_PROPERTIES dlg( this, aFootprint );
2658
2659 dlg.ShowQuasiModal();
2660 retvalue = dlg.GetReturnValue();
2661 }
2662
2663 /*
2664 * retvalue =
2665 * FP_PROPS_UPDATE_FP to show Update Footprints dialog
2666 * FP_PROPS_CHANGE_FP to show Change Footprints dialog
2667 * FP_PROPS_OK for normal edit
2668 * FP_PROPS_CANCEL if aborted
2669 * FP_PROPS_EDIT_BOARD_FP to load board footprint into Footprint Editor
2670 * FP_PROPS_EDIT_LIBRARY_FP to load library footprint into Footprint Editor
2671 */
2672
2674 {
2675 // If something edited, push a refresh request
2676 GetCanvas()->Refresh();
2677 }
2679 {
2680 if( KIWAY_PLAYER* frame = Kiway().Player( FRAME_FOOTPRINT_EDITOR, true ) )
2681 {
2682 FOOTPRINT_EDIT_FRAME* fp_editor = static_cast<FOOTPRINT_EDIT_FRAME*>( frame );
2683
2684 fp_editor->LoadFootprintFromBoard( aFootprint );
2685 fp_editor->Show( true );
2686 fp_editor->Raise(); // Iconize( false );
2687 }
2688 }
2690 {
2691 if( KIWAY_PLAYER* frame = Kiway().Player( FRAME_FOOTPRINT_EDITOR, true ) )
2692 {
2693 FOOTPRINT_EDIT_FRAME* fp_editor = static_cast<FOOTPRINT_EDIT_FRAME*>( frame );
2694
2695 fp_editor->LoadFootprintFromLibrary( aFootprint->GetFPID() );
2696 fp_editor->Show( true );
2697 fp_editor->Raise(); // Iconize( false );
2698 }
2699 }
2701 {
2702 ShowExchangeFootprintsDialog( aFootprint, true, true );
2703 }
2705 {
2706 ShowExchangeFootprintsDialog( aFootprint, false, true );
2707 }
2708}
2709
2710
2712 bool aSelectedMode )
2713{
2714 DIALOG_EXCHANGE_FOOTPRINTS dialog( this, aFootprint, aUpdateMode, aSelectedMode );
2715
2716 return dialog.ShowQuasiModal();
2717}
2718
2719
2721{
2723 m_appearancePanel->CommonSettingsChanged( aFlags );
2724
2726
2728
2729 SetElementVisibility( LAYER_RATSNEST, GetPcbNewSettings()->m_Display.m_ShowGlobalRatsnest );
2730
2732
2733 // Netclass definitions could have changed, either by us or by Eeschema, so we need to
2734 // recompile the implicit rules
2735 DRC_TOOL* drcTool = m_toolManager->GetTool<DRC_TOOL>();
2736 WX_INFOBAR* infobar = GetInfoBar();
2737
2738 try
2739 {
2740 drcTool->GetDRCEngine()->InitEngine( GetBoard()->GetDesignRulesPath() );
2741
2742 if( infobar->GetMessageType() == WX_INFOBAR::MESSAGE_TYPE::DRC_RULES_ERROR )
2743 infobar->Dismiss();
2744 }
2745 catch( PARSE_ERROR& )
2746 {
2747 infobar->RemoveAllButtons();
2748 infobar->AddLink( _( "Edit design rules" ),
2749 [&]( wxHyperlinkEvent& aEvent )
2750 {
2751 ShowBoardSetupDialog( _( "Custom Rules" ) );
2752 } );
2753 infobar->AddCloseButton();
2754 infobar->ShowMessage( _( "Could not compile custom design rules." ), wxICON_ERROR,
2755 WX_INFOBAR::MESSAGE_TYPE::DRC_RULES_ERROR );
2756 }
2757
2760
2761 Layout();
2762 SendSizeEvent();
2763}
2764
2765
2770
2771
2773{
2774 // Register autosave history saver for the board.
2775 // Saver serializes the in-memory BOARD into HISTORY_FILE_DATA. Prettify and
2776 // file I/O happen on a background thread to avoid blocking the UI.
2777 if( GetBoard() )
2778 {
2780 GetBoard(),
2781 [this]( const wxString& aProjectPath, std::vector<HISTORY_FILE_DATA>& aFileData )
2782 {
2783 // See SCHEMATIC::SaveToHistory: the dirty check is only valid in ZIP
2784 // mode. In INCREMENTAL mode the manual-save flow clears the dirty
2785 // flag before the saver runs, so filtering would drop the snapshot.
2786 bool filterClean = !Pgm().GetCommonSettings()->AutosaveUsesLocalHistory();
2787
2788 if( filterClean && !IsContentModified() )
2789 return;
2790
2791 GetBoard()->SaveToHistory( aProjectPath, aFileData );
2792 },
2794 }
2795}
2796
2797
2799{
2801
2802 if( !mgr )
2803 return false;
2804
2805 TOOL_BASE* currentTool = mgr->GetCurrentTool();
2806
2807 // When a single item that can be point-edited is selected, the point editor
2808 // tool will be active instead of the selection tool. It blocks undo/redo
2809 // while the user is actually dragging points around, though, so we can use
2810 // this as an initial check.
2811 if( UndoRedoBlocked() )
2812 return true;
2813
2814 // A tool other than passive selection or point editing is actively modifying
2815 // the model (drawing, dragging, routing, etc.).
2816 if( currentTool != mgr->GetTool<PCB_SELECTION_TOOL>()
2817 && currentTool != mgr->GetTool<PCB_POINT_EDITOR>() )
2818 {
2819 return true;
2820 }
2821
2822 if( ZONE_FILLER_TOOL* zoneFillerTool = mgr->GetTool<ZONE_FILLER_TOOL>();
2823 zoneFillerTool && zoneFillerTool->IsBusy() )
2824 {
2825 return true;
2826 }
2827
2828 if( ROUTER_TOOL* routerTool = mgr->GetTool<ROUTER_TOOL>();
2829 routerTool && routerTool->RoutingInProgress() )
2830 {
2831 return true;
2832 }
2833
2834 return false;
2835}
2836
2837
2839{
2841 return false;
2842
2844}
2845
2846
2848{
2849 // Serializing a large board on the UI thread freezes the editor; never do it while the
2850 // user is mid-operation or the deferred input gets misinterpreted (e.g. a routed track
2851 // ending where the cursor lands once the editor unfreezes).
2853}
2854
2855
2861
2862
2863bool PCB_EDIT_FRAME::GetPluginActionButtonVisible( const wxString& aPluginPath, bool aPluginDefault )
2864{
2865 if( PCBNEW_SETTINGS* cfg = GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" ) )
2866 {
2867 for( const auto& [identifier, visible] : cfg->m_Plugins.actions )
2868 {
2869 if( identifier == aPluginPath )
2870 return visible;
2871 }
2872 }
2873
2874 // Plugin is not in settings, return default.
2875 return aPluginDefault;
2876}
2877
2878
2880{
2881 return GetBoard()->GetFileName();
2882}
2883
2884
2886{
2887 return m_auimgr.GetPane( wxS( "LayersManager" ) ).IsShown();
2888}
2889
2890
2892{
2893 return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
2894}
2895
2896
2898{
2899 return m_auimgr.GetPane( NetInspectorPanelName() ).IsShown();
2900}
2901
2902
2903void PCB_EDIT_FRAME::onSize( wxSizeEvent& aEvent )
2904{
2905 if( IsShownOnScreen() )
2906 {
2907 // We only need this until the frame is done resizing and the final client size is
2908 // established.
2909 Unbind( wxEVT_SIZE, &PCB_EDIT_FRAME::onSize, this );
2911 }
2912
2913 // Skip() is called in the base class.
2914 EDA_DRAW_FRAME::OnSize( aEvent );
2915}
2916
2917
2928
2929
2940
2941
2952
2953
2955{
2956 if( !m_footprintDiffDlg )
2957 {
2959 _( "Compare Footprint with Library" ) );
2960
2961 m_footprintDiffDlg->m_sdbSizerApply->SetLabel( _( "Update Footprint from Library..." ) );
2962 m_footprintDiffDlg->m_sdbSizerApply->PostSizeEventToParent();
2963 m_footprintDiffDlg->m_sdbSizerApply->Show();
2964 }
2965
2966 return m_footprintDiffDlg;
2967}
2968
2969
2971{
2973 {
2974 auto* dlg = new DIALOG_FOOTPRINT_FIELDS_TABLE( this );
2975
2976 if( dlg->WasAborted() )
2977 {
2978 dlg->Destroy();
2979 return nullptr;
2980 }
2981
2983 }
2984
2986}
2987
2988
2990{
2991 if( m_inspectDrcErrorDlg && aEvent.GetString() == INSPECT_DRC_ERROR_DIALOG_NAME )
2992 {
2993 m_inspectDrcErrorDlg->Destroy();
2994 m_inspectDrcErrorDlg = nullptr;
2995 }
2996 else if( m_inspectClearanceDlg && aEvent.GetString() == INSPECT_CLEARANCE_DIALOG_NAME )
2997 {
2998 m_inspectClearanceDlg->Destroy();
2999 m_inspectClearanceDlg = nullptr;
3000 }
3001 else if( m_inspectConstraintsDlg && aEvent.GetString() == INSPECT_CONSTRAINTS_DIALOG_NAME )
3002 {
3003 m_inspectConstraintsDlg->Destroy();
3004 m_inspectConstraintsDlg = nullptr;
3005 }
3006 else if( m_footprintDiffDlg && aEvent.GetString() == FOOTPRINT_DIFF_DIALOG_NAME )
3007 {
3008 if( aEvent.GetId() == wxID_APPLY )
3009 {
3010 KIID fpUUID = m_footprintDiffDlg->GetUserItemID();
3011
3012 CallAfter(
3013 [this, fpUUID]()
3014 {
3015 BOARD_ITEM* item = m_pcb->ResolveItem( fpUUID );
3016
3017 if( FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( item ) )
3018 {
3019 m_toolManager->RunAction<EDA_ITEM*>( ACTIONS::selectItem, footprint );
3020
3021 DIALOG_EXCHANGE_FOOTPRINTS dialog( this, footprint, true, true );
3022 dialog.ShowQuasiModal();
3023 }
3024 } );
3025 }
3026
3027 m_footprintDiffDlg->Destroy();
3028 m_footprintDiffDlg = nullptr;
3029 }
3030}
3031
3032
3034{
3036 return true;
3037
3039
3040 if( !dlg->Close( false ) )
3041 return false;
3042
3043 if( m_footprintFieldsTableDialog == dlg )
3044 {
3045 dlg->Destroy();
3047 }
3048
3049 return true;
3050}
3051
3052
3054{
3056 {
3059 }
3060}
3061
3062
3064{
3065 wxLogTrace( traceApi, "PCB frame: EDA_EVT_PLUGIN_AVAILABILITY_CHANGED" );
3068 aEvt.Skip();
3069}
3070
3071
3073{
3074 PCB_LAYER_ID curLayer = GetActiveLayer();
3075 const PCB_DISPLAY_OPTIONS& displ_opts = GetDisplayOptions();
3076
3077 // Check if the specified layer matches the present layer
3078 if( layer == curLayer )
3079 return;
3080
3081 // Copper layers cannot be selected unconditionally; how many of those layers are currently
3082 // enabled needs to be checked.
3083 if( IsCopperLayer( layer ) )
3084 {
3085 if( layer > GetBoard()->GetCopperLayerStackMaxId() )
3086 return;
3087 }
3088
3089 // Is yet more checking required? E.g. when the layer to be selected is a non-copper layer,
3090 // or when switching between a copper layer and a non-copper layer, or vice-versa?
3091
3092 SetActiveLayer( layer );
3093
3095 GetCanvas()->Refresh();
3096}
3097
3098
3100{
3101 switch( aItem->Type() )
3102 {
3105 break;
3106
3107 case PCB_BARCODE_T:
3108 ShowBarcodePropertiesDialog( static_cast<PCB_BARCODE*>( aItem ) );
3109 break;
3110
3111 case PCB_FIELD_T:
3112 case PCB_TEXT_T:
3113 ShowTextPropertiesDialog( static_cast<PCB_TEXT*>( aItem ) );
3114 break;
3115
3116 case PCB_TEXTBOX_T:
3117 ShowTextBoxPropertiesDialog( static_cast<PCB_TEXTBOX*>( aItem ) );
3118 break;
3119
3120 case PCB_TABLE_T:
3121 {
3122 DIALOG_TABLE_PROPERTIES dlg( this, static_cast<PCB_TABLE*>( aItem ) );
3123
3124 //QuasiModal required for Scintilla auto-complete
3125 dlg.ShowQuasiModal();
3126 break;
3127 }
3128
3129 case PCB_DRILL_CHART_T:
3130 {
3131 // Not the generic table dialog, which would offer copper layers and direct editing of
3132 // cells that the next rebuild discards
3133 DIALOG_GENERATED_TABLE_PROPERTIES dlg( this, static_cast<PCB_DRILL_CHART*>( aItem ),
3134 []( wxWindow* aParent )
3135 {
3136 return new PANEL_DRILL_CHART_OPTIONS( aParent );
3137 } );
3138 dlg.ShowModal();
3139 break;
3140 }
3141
3142 case PCB_PAD_T:
3143 ShowPadPropertiesDialog( static_cast<PAD*>( aItem ) );
3144 break;
3145
3146 case PCB_FOOTPRINT_T:
3147 ShowFootprintPropertiesDialog( static_cast<FOOTPRINT*>( aItem ) );
3148 break;
3149
3150 case PCB_TARGET_T:
3151 ShowTargetOptionsDialog( static_cast<PCB_TARGET*>( aItem ) );
3152 break;
3153
3154 case PCB_DIM_ALIGNED_T:
3155 case PCB_DIM_CENTER_T:
3156 case PCB_DIM_RADIAL_T:
3158 case PCB_DIM_LEADER_T:
3159 {
3160 DIALOG_DIMENSION_PROPERTIES dlg( this, static_cast<PCB_DIMENSION_BASE*>( aItem ) );
3161
3162 dlg.ShowModal();
3163 break;
3164 }
3165
3166 case PCB_SHAPE_T:
3167 ShowGraphicItemPropertiesDialog( static_cast<PCB_SHAPE*>( aItem ) );
3168 break;
3169
3170 case PCB_GRID_ITEM_T:
3171 ShowGridItemPropertiesDialog( static_cast<PCB_GRID_ITEM*>( aItem ) );
3172 break;
3173
3174 case PCB_ZONE_T:
3175 Edit_Zone_Params( static_cast<ZONE*>( aItem ) );
3176 break;
3177
3178 case PCB_GROUP_T:
3180 static_cast<EDA_GROUP*>( static_cast<PCB_GROUP*>( aItem ) ) );
3181 break;
3182
3183 case PCB_GENERATOR_T:
3184 static_cast<PCB_GENERATOR*>( aItem )->ShowPropertiesDialog( this );
3185 break;
3186
3187 case PCB_MARKER_T:
3188 m_toolManager->GetTool<DRC_TOOL>()->CrossProbe( static_cast<PCB_MARKER*>( aItem ) );
3189 break;
3190
3191 case PCB_POINT_T:
3192 break;
3193
3194 default:
3195 break;
3196 }
3197}
3198
3199
3201{
3202 // For now we just delegate to the base implementation which commits any pending
3203 // local history snapshots. If PCB-specific preconditions are later needed (e.g.
3204 // flushing zone fills or router state) they can be added here before calling the
3205 // base class method.
3207}
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
Definition base_units.h:128
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...
Definition bitmap.cpp:100
@ NORMAL
Inactive layers are shown normally (no high-contrast mode)
constexpr BOX2I BOX2ISafe(const BOX2D &aInput)
Definition box2.h:921
BOX2< VECTOR2D > BOX2D
Definition box2.h:915
static TOOL_ACTION toggleGrid
Definition actions.h:194
static TOOL_ACTION paste
Definition actions.h:76
static TOOL_ACTION unselectAll
Definition actions.h:79
static TOOL_ACTION selectItem
Select an item (specified as the event parameter).
Definition actions.h:223
static TOOL_ACTION togglePolarCoords
Definition actions.h:205
static TOOL_ACTION copy
Definition actions.h:74
static TOOL_ACTION pluginsReload
Definition actions.h:293
static TOOL_ACTION selectSetLasso
Definition actions.h:217
static TOOL_ACTION selectSetRect
Set lasso selection mode.
Definition actions.h:216
static TOOL_ACTION group
Definition actions.h:235
static TOOL_ACTION pasteSpecial
Definition actions.h:77
static TOOL_ACTION groupProperties
Definition actions.h:243
static TOOL_ACTION pointEditorArcKeepCenter
Definition actions.h:272
static TOOL_ACTION ungroup
Definition actions.h:236
static TOOL_ACTION toggleBoundingBoxes
Definition actions.h:153
static TOOL_ACTION pointEditorArcKeepRadius
Definition actions.h:274
static TOOL_ACTION showSearch
Definition actions.h:112
static TOOL_ACTION undo
Definition actions.h:71
static TOOL_ACTION duplicate
Definition actions.h:80
static TOOL_ACTION highContrastMode
Definition actions.h:151
static TOOL_ACTION embeddedFiles
Definition actions.h:297
static TOOL_ACTION measureTool
Definition actions.h:248
static TOOL_ACTION doDelete
Definition actions.h:81
static TOOL_ACTION selectionTool
Definition actions.h:247
static TOOL_ACTION save
Definition actions.h:54
static TOOL_ACTION zoomFitScreen
Definition actions.h:138
static TOOL_ACTION redo
Definition actions.h:72
static TOOL_ACTION deleteTool
Definition actions.h:82
static TOOL_ACTION zoomTool
Definition actions.h:142
static TOOL_ACTION showProperties
Definition actions.h:262
static TOOL_ACTION cut
Definition actions.h:73
static TOOL_ACTION gridSetOrigin
Definition actions.h:191
static TOOL_ACTION toggleGridOverrides
Definition actions.h:195
static TOOL_ACTION selectAll
Definition actions.h:78
static TOOL_ACTION pointEditorArcKeepEndpoint
Definition actions.h:273
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.
The array tool.
Definition array_tool.h:44
Tool responsible for automagic placement of footprints.
Handles how to draw a screen (a board, a schematic ...)
Definition base_screen.h:37
int GetPageCount() const
Definition base_screen.h:68
bool IsContentModified() const
Definition base_screen.h:56
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,...
Handle actions specific to the board editor in PcbNew.
Tool for pcb inspection.
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...
Definition board_item.h:84
Bridges BOARD's listener stream into the generic TEXT_VAR_TRACKER.
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:410
void BuildListOfNets()
Definition board.h:1178
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition board.cpp:1252
void RemoveAllListeners()
Remove all listeners.
Definition board.cpp:4014
const PAGE_INFO & GetPageSettings() const
Definition board.h:1018
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
Definition board.cpp:1246
void InitializeClearanceCache()
Initialize the clearance cache for all board items.
Definition board.cpp:1323
void SaveToHistory(const wxString &aProjectPath, std::vector< HISTORY_FILE_DATA > &aFileData)
Serialize board into HISTORY_FILE_DATA for non-blocking history commit.
Definition board.cpp:4531
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
Definition board.cpp:367
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition board.cpp:3423
std::weak_ptr< void > GetHistoryLifetimeToken() const
Liveness token handed to LOCAL_HISTORY::RegisterSaver so a shared autosave timer skips this board's s...
Definition board.h:1696
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
Definition board.cpp:377
const wxString & GetFileName() const
Definition board.h:453
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
Definition board.cpp:1258
void ClearProject()
Definition board.cpp:418
bool IsEmpty() const
Definition board.cpp:809
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.
Definition board.cpp:2811
const LSET & GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition board.cpp:1185
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
Definition board.cpp:539
void SynchronizeTuningProfileProperties()
Ensure that all time domain properties providers are in sync with current settings.
Definition board.cpp:3377
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition board.h:759
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition box2.h:553
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.
Definition commit.h:74
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...
Handles action that are shared between different applications.
Interactive authoring of geometric constraints (issue #2329).
enum FP_PROPS_RETVALUE GetReturnValue()
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).
int ShowModal() override
Tool responsible for displaying an overlay of incremental phase difference between differential pair ...
Tool responsible for drawing graphical elements like lines, arcs, circles, etc.
MODE GetDrawingMode() const
Return the current drawing mode of the DRAWING_TOOL or NONE if not currently in any drawing mode.
void InitEngine(const wxFileName &aRulePath)
Initialize the DRC engine.
std::shared_ptr< DRC_ENGINE > GetDRCEngine()
Definition drc_tool.h:83
bool IsDRCRunning() const
Check to see if the DRC engine is running the tests.
Definition drc_tool.h:70
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.
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.
WX_INFOBAR * m_infoBar
wxAuiManager m_auimgr
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 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 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
virtual void UpdateProperties()
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.
void SetFocus() override
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.
Definition eda_item.h:98
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
Specialization of the wxAuiPaneInfo class for KiCad panels.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition eda_text.h:94
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.
The interactive edit tool.
Definition edit_tool.h:54
ENUM_MAP & Map(T aValue, const wxString &aName)
Definition property.h:789
static ENUM_MAP< T > & Instance()
Definition property.h:783
ENUM_MAP & Undefined(T aValue)
Definition property.h:796
wxPGChoices & Choices()
Definition property.h:834
void LoadFootprintFromLibrary(LIB_ID aFPID)
bool HandleUnsavedChanges(bool aFromBoardOnly)
Prompt to save each dirty tab that meets the requirements.
bool LoadFootprintFromBoard(FOOTPRINT *aFootprint)
Load a footprint from the main board into the Footprint Editor.
Component library viewer main window.
const LIB_ID & GetFPID() const
Definition footprint.h:474
void ReadWindowSettings(WINDOW_SETTINGS &aCfg)
Read GAL config options from application-level config.
bool Contains(GAL_LAYER_ID aPos)
Definition layer_ids.h:459
Handle actions specific to filling copper zones.
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
Definition kiface_base.h:92
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:101
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
Contains all the knowledge about how to draw graphical object onto any particular output device.
Definition painter.h:55
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...
Definition pcb_view.cpp:87
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.
Definition view_item.h:82
bool IsBOARD_ITEM() const
Definition view_item.h:98
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition view.h:63
double GetScale() const
Definition view.h:283
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition view.cpp:611
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...
Definition view.cpp:1892
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition view.h:407
void SyncLayerVisibilityCache()
Definition view.cpp:1957
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition view.h:661
void UpdateAllItemsConditionally(int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
Update items in the view according to the given flags and condition.
Definition view.cpp:1759
An implementation of class VIEW_CONTROLS for wxWidgets library.
std::unique_ptr< PROF_COUNTER > m_MotionEventCounter
Definition kiid.h:46
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...
Definition kiway.h:348
void OnKiCadExit()
Definition kiway.cpp:790
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition kiway.cpp:388
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr, bool aFromOtherThread=false)
Send aPayload to aDestination from aSource.
Definition kiway.cpp:486
LOCAL_HISTORY & LocalHistory()
Return the LOCAL_HISTORY associated with this KIWAY.
Definition kiway.h:459
virtual void CommonSettingsChanged(int aFlags=0)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
Definition kiway.cpp:580
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.
Definition lset.h:37
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition lset.cpp:309
static const LSET & AllLayersMask()
Definition lset.cpp:637
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition lset.cpp:184
@ MARKER_DRAWING_SHEET
Definition marker_base.h:52
Tool responsible for adding microwave features to PCBs.
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
Definition pad.h:61
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.
Definition page_info.h:75
Dockable panel listing the board's geometric constraints (issue #2329).
DISPLAY_OPTIONS m_Display
EDA_ANGLE m_RotationAngle
ARC_EDIT_MODE m_ArcEditMode
AUI_PANELS m_AuiPanels
Gather all the actions that are shared by tools.
Definition pcb_actions.h:51
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.
Definition pcb_actions.h:94
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.
Definition pcb_actions.h:91
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.
Definition pcb_actions.h:82
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 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.
Definition pcb_actions.h:85
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 lock
static TOOL_ACTION addConstraintConcentric
Common, abstract interface for edit frames.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
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.
BOARD * GetBoard() const
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.
Definition pcb_control.h:47
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 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.
Definition edit.cpp:95
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.
Definition edit.cpp:68
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.
void onSize(wxSizeEvent &aEvent)
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.
Definition initpcb.cpp:38
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.
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.
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).
Definition pcb_group.h:51
PCB net inspection panel.
Generic tool for picking an item.
Tool that displays edit points allowing to modify items by dragging the points.
PCB_LAYER_ID m_Route_Layer_TOP
Definition pcb_screen.h:39
PCB_LAYER_ID m_Route_Layer_BOTTOM
Definition pcb_screen.h:40
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.
The selection tool: currently supports:
int ClearSelection(const TOOL_EVENT &aEvent)
Clear current selection event handler.
void FindItem(BOARD_ITEM *aItem)
Take necessary actions to mark an item as found.
Tool useful for viewing footprints.
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition pgm_base.cpp:546
KICAD_API_SERVER & GetApiServer()
Definition pgm_base.h:141
virtual const wxString & GetExecutablePath() const
Definition pgm_base.cpp:872
The interactive edit tool.
void Show(std::ostream &aStream=std::cerr)
Definition profile.h:287
void Reset()
Definition profile.h:277
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.
Definition project.cpp:183
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition project.h:207
void IncrementNetclassesTicker()
Definition project.h:115
virtual PROJECT_FILE & GetProjectFile() const
Definition project.h:201
void IncrementTextVarsTicker()
Definition project.h:112
Action handler for the Properties panel.
PNS::PNS_MODE GetRouterMode()
bool RoutingInProgress()
Returns whether routing is currently active.
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 AddItemToSel(const TOOL_EVENT &aEvent)
EDA_ITEM * Front() const
Definition selection.h:176
int Size() const
Returns the number of selected parts.
Definition selection.h:120
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition richio.h:225
Coordinates the dependency index with change notifications.
ListenerHandle AddInvalidateListener(InvalidateCallback aCallback)
Register a listener that fires for every invalidation.
static constexpr ListenerHandle INVALID_LISTENER
TOOL_MANAGER * m_toolManager
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
ACTIONS * m_actions
Represent a single user action.
Base abstract interface for all kinds of tools.
Definition tool_base.h:62
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition tool_base.h:76
Generic, UI-independent tool event.
Definition tool_event.h:167
void SetHasPosition(bool aHasPosition)
Definition tool_event.h:257
Master controller class:
T * GetTool()
Return the tool of given type or nullptr if there is no such tool registered.
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
TOOL_BASE * GetCurrentTool() const
Return the tool that is on the top of the active tools stack (was invoked the most recently).
Tool that owns actions specific to via-stitch generators.
A modified version of the wxInfoBar class that allows us to:
Definition wx_infobar.h:76
Handle actions specific to filling copper zones.
PROGRESS_REPORTER * GetProgressReporter()
A type-safe container of any type.
Definition ki_any.h:92
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition confirm.cpp:146
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition confirm.cpp:217
int GetLastUnsavedChangesResponse()
Return the result code from the last call to HandleUnsavedChanges(): wxID_YES, wxID_NO or wxID_CANCEL...
Definition confirm.cpp:159
This file is part of the common library.
#define CHECK(x)
#define ENABLE(x)
#define DIALOG_DRC_WINDOW_NAME
Definition dialog_drc.h:40
#define DIALOG_DRC_RULE_EDITOR_WINDOW_NAME
#define _(s)
Declaration of the eda_3d_viewer class.
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:450
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define PCB_EDIT_FRAME_NAME
static const std::vector< KICAD_T > footprintTypes
static const std::vector< KICAD_T > groupTypes
static const std::vector< KICAD_T > trackTypes
EVT_MENU_RANGE(ID_GERBVIEW_DRILL_FILE1, ID_GERBVIEW_DRILL_FILEMAX, GERBVIEW_FRAME::OnDrlFileHistory) EVT_MENU_RANGE(ID_GERBVIEW_ZIP_FILE1
#define CURRENT_EDIT_TOOL(action)
Collection of reusable/testable functions for footprint manipulation.
@ FRAME_PCB_EDITOR
Definition frame_type.h:38
@ FRAME_FOOTPRINT_VIEWER
Definition frame_type.h:41
@ FRAME_SCH
Definition frame_type.h:30
@ FRAME_FOOTPRINT_CHOOSER
Definition frame_type.h:40
@ FRAME_FOOTPRINT_EDITOR
Definition frame_type.h:39
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 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.
Definition api_utils.cpp:33
@ ID_ON_GRID_SELECT
Definition id.h:113
@ ID_FILE_LIST_CLEAR
Definition id.h:58
@ ID_EDA_SOCKET_EVENT
Definition id.h:133
@ ID_EDA_SOCKET_EVENT_SERV
Definition id.h:132
@ ID_ON_ZOOM_SELECT
Definition id.h:112
@ ID_FILEMAX
Definition id.h:56
@ ID_FILE1
Definition id.h:55
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition idf_helpers.h:37
PROJECT & Prj()
Definition kicad.cpp:733
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.
Definition layer_ids.h:880
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:703
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition layer_ids.h:224
@ LAYER_GRID
Definition layer_ids.h:250
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored).
Definition layer_ids.h:291
@ LAYER_RATSNEST
Definition layer_ids.h:249
#define CLEARANCE_LAYER_FOR(boardLayer)
Definition layer_ids.h:390
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:56
@ F_Paste
Definition layer_ids.h:100
@ B_Mask
Definition layer_ids.h:94
@ B_Cu
Definition layer_ids.h:61
@ F_Mask
Definition layer_ids.h:93
@ B_Paste
Definition layer_ids.h:101
@ UNDEFINED_LAYER
Definition layer_ids.h:57
@ F_Cu
Definition layer_ids.h:60
@ MAIL_SCH_GET_NETLIST
Definition mail_type.h:45
#define MAIL_SCH_GET_NETLIST_CANCELLED
Reply payload for MAIL_SCH_GET_NETLIST when the user deliberately aborts netlist generation (for exam...
Definition mail_type.h:68
@ REPAINT
Item needs to be redrawn.
Definition view_item.h:54
@ GEOMETRY
Position or shape has changed.
Definition view_item.h:51
@ ALL
All except INITIAL_ADD.
Definition view_item.h:55
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition definitions.h:34
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition unix/app.cpp:102
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition unix/app.cpp:91
@ RM_MarkObstacles
Ignore collisions, mark obstacles.
@ RM_Walkaround
Only walk around.
@ RM_Shove
Only shove.
#define _HKI(x)
Definition page_info.cpp:40
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
Definition pcbnew_id.h:21
@ ID_POPUP_PCB_SELECT_WIDTH1
Definition pcbnew_id.h:25
@ ID_POPUP_PCB_SELECT_VIASIZE8
Definition pcbnew_id.h:48
@ ID_AUX_TOOLBAR_PCB_VARIANT_SELECT
Definition pcbnew_id.h:20
@ ID_AUX_TOOLBAR_PCB_VIA_SIZE
Definition pcbnew_id.h:17
@ ID_POPUP_PCB_SELECT_WIDTH_END_RANGE
Definition pcbnew_id.h:78
@ ID_POPUP_PCB_SELECT_VIASIZE1
Definition pcbnew_id.h:41
@ ID_AUX_TOOLBAR_PCB_VIA_STACK
Definition pcbnew_id.h:19
@ ID_AUX_TOOLBAR_PCB_TRACK_WIDTH
Definition pcbnew_id.h:18
@ SHOW_WITH_VIA_ALWAYS
PGM_BASE & Pgm()
The global program "get" accessor.
see class PGM_BASE
LAST_PATH_TYPE
For storing PcbNew MRU paths of various types.
@ RPT_SEVERITY_EXCLUSION
#define SKIP_SET_DIRTY
Definition sch_commit.h:40
#define SKIP_UNDO
Definition sch_commit.h:38
#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.
Definition box2_minmax.h:33
bool Intersects(const BOX2I_MINMAX &aOther) const
Definition box2_minmax.h:69
A filename or source description, a problem input line, a line number, a byte offset,...
TRACK_CLEARANCE_MODE m_TrackClearance
Identifies a single resolvable source that a text item's ${...} reference depends on.
else
IbisParser parser & reporter
@ AS_GLOBAL
Global action (toolbar/main menu event, global shortcut)
Definition tool_action.h:45
@ AS_ACTIVE
All active tools.
Definition tool_action.h:44
@ TA_MODEL_CHANGE
Model has changed (partial update).
Definition tool_event.h:117
@ TC_COMMAND
Definition tool_event.h:53
#define TEXTVARS_CHANGED
wxLogTrace helper definitions.
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition typeinfo.h:80
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition typeinfo.h:98
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition typeinfo.h:95
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition typeinfo.h:83
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:89
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition typeinfo.h:96
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition typeinfo.h:103
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition typeinfo.h:85
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition typeinfo.h:100
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:84
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
Definition typeinfo.h:81
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition typeinfo.h:82
@ PCB_MARKER_T
class PCB_MARKER, a marker used to show something
Definition typeinfo.h:91
@ PCB_BARCODE_T
class PCB_BARCODE, a barcode (graphic item)
Definition typeinfo.h:93
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition typeinfo.h:99
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition typeinfo.h:78
@ PCB_GRID_ITEM_T
a subgrid placed on a board
Definition typeinfo.h:238
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition typeinfo.h:94
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:79
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition typeinfo.h:90
@ PCB_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
Definition typeinfo.h:86
@ PCB_POINT_T
class PCB_POINT, a 0-dimensional point
Definition typeinfo.h:105
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition typeinfo.h:88
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
Definition typeinfo.h:97
@ PCB_DRILL_CHART_T
class PCB_DRILL_CHART, a live drill chart derived from PCB_TABLE
Definition typeinfo.h:239
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.