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 (C) 2013-2023 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 along
20 * with this program. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23#include <advanced_config.h>
24#include <kiface_base.h>
25#include <kiway.h>
26#include <pgm_base.h>
27#include <pcb_edit_frame.h>
29#include <fp_lib_table.h>
30#include <bitmaps.h>
31#include <confirm.h>
32#include <trace_helpers.h>
33#include <pcbnew_id.h>
34#include <pcbnew_settings.h>
37#include <dialog_plot.h>
38#include <dialog_find.h>
42#include <dialog_board_setup.h>
43#include <invoke_pcb_dialog.h>
45#include <board.h>
46#include <pcb_group.h>
48#include <footprint.h>
52#include <pcb_draw_panel_gal.h>
53#include <functional>
54#include <pcb_painter.h>
57#include <python_scripting.h>
60#include <tool/tool_manager.h>
62#include <tool/action_toolbar.h>
63#include <tool/common_control.h>
64#include <tool/common_tools.h>
66#include <tool/selection.h>
67#include <tool/zoom_tool.h>
71#include <tools/edit_tool.h>
72#include <tools/group_tool.h>
74#include <tools/drc_tool.h>
76#include <tools/convert_tool.h>
77#include <tools/drawing_tool.h>
78#include <tools/pcb_control.h>
85#include <tools/pad_tool.h>
89#include <tools/pcb_actions.h>
90#include <router/router_tool.h>
93#include <gestfich.h>
94#include <executable_names.h>
96#include <wx/socket.h>
97#include <wx/wupdlock.h>
98#include <dialog_drc.h> // for DIALOG_DRC_WINDOW_NAME definition
102#include <widgets/wx_infobar.h>
105#include <widgets/wx_aui_utils.h>
106#include <kiplatform/app.h>
107#include <core/profile.h>
111
112#include <action_plugin.h>
114#include "../scripting/python_scripting.h"
115
116#include <wx/filedlg.h>
117
118using namespace std::placeholders;
119
120
121#define INSPECT_DRC_ERROR_DIALOG_NAME wxT( "InspectDrcErrorDialog" )
122#define INSPECT_CLEARANCE_DIALOG_NAME wxT( "InspectClearanceDialog" )
123#define INSPECT_CONSTRAINTS_DIALOG_NAME wxT( "InspectConstraintsDialog" )
124#define FOOTPRINT_DIFF_DIALOG_NAME wxT( "FootprintDiffDialog" )
125
126
127BEGIN_EVENT_TABLE( PCB_EDIT_FRAME, PCB_BASE_FRAME )
130
131
134
135 EVT_SIZE( PCB_EDIT_FRAME::OnSize )
136
138
139 // Menu Files:
141
145
151
154
155 EVT_MENU( wxID_EXIT, PCB_EDIT_FRAME::OnQuit )
156 EVT_MENU( wxID_CLOSE, PCB_EDIT_FRAME::OnQuit )
157
158 // menu Postprocess
160
161 // Horizontal toolbar
167
168 // Tracks and vias sizes general options
170 PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event )
171
172 // User interface update event handlers.
178 PCB_EDIT_FRAME::OnUpdateSelectTrackWidth )
180 PCB_EDIT_FRAME::OnUpdateSelectViaSize )
181 // Drop files event
182 EVT_DROP_FILES( PCB_EDIT_FRAME::OnDropFiles )
183END_EVENT_TABLE()
184
185
186PCB_EDIT_FRAME::PCB_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
187 PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_PCB_EDITOR, _( "PCB Editor" ),
188 wxDefaultPosition, wxDefaultSize, KICAD_DEFAULT_DRAWFRAME_STYLE,
190 m_exportNetlistAction( nullptr ),
191 m_findDialog( nullptr ),
192 m_inspectDrcErrorDlg( nullptr ),
193 m_inspectClearanceDlg( nullptr ),
194 m_inspectConstraintsDlg( nullptr ),
195 m_footprintDiffDlg( nullptr ),
196 m_netInspectorDlg( nullptr ),
197 m_importProperties( nullptr )
198{
199 m_maximizeByDefault = true;
200 m_showBorderAndTitleBlock = true; // true to display sheet references
201 m_SelTrackWidthBox = nullptr;
202 m_SelViaSizeBox = nullptr;
203 m_SelLayerBox = nullptr;
204 m_show_layer_manager_tools = true;
205 m_supportsAutoSave = true;
206 m_probingSchToPcb = false;
207 m_show_search = false;
208
209 // We don't know what state board was in when it was last saved, so we have to
210 // assume dirty
211 m_ZoneFillsDirty = true;
212
213 m_aboutTitle = _HKI( "KiCad PCB Editor" );
214
215 // Must be created before the menus are created.
216 if( ADVANCED_CFG::GetCfg().m_ShowPcbnewExportNetlist )
217 m_exportNetlistAction = new TOOL_ACTION( "pcbnew.EditorControl.exportNetlist",
218 AS_GLOBAL, 0, "", _( "Netlist..." ),
219 _( "Export netlist used to update schematics" ) );
220
221 // Create GAL canvas
222 auto canvas = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
223 GetGalDisplayOptions(),
225
226 SetCanvas( canvas );
227 SetBoard( new BOARD() );
228
229 wxIcon icon;
230 wxIconBundle icon_bundle;
231
232 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbnew ) );
233 icon_bundle.AddIcon( icon );
234 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbnew_32 ) );
235 icon_bundle.AddIcon( icon );
236 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_pcbnew_16 ) );
237 icon_bundle.AddIcon( icon );
238
239 SetIcons( icon_bundle );
240
241 // LoadSettings() *after* creating m_LayersManager, because LoadSettings()
242 // initialize parameters in m_LayersManager
243 LoadSettings( config() );
244
245 SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS ) ) );
246
247 // PCB drawings start in the upper left corner.
248 GetScreen()->m_Center = false;
249
250 setupTools();
251 setupUIConditions();
252
253 ReCreateMenuBar();
254 ReCreateHToolbar();
255 ReCreateAuxiliaryToolbar();
256 ReCreateVToolbar();
257 ReCreateOptToolbar();
258
259
260 m_propertiesPanel = new PCB_PROPERTIES_PANEL( this, this );
261
262 float proportion = GetPcbNewSettings()->m_AuiPanels.properties_splitter;
263 m_propertiesPanel->SetSplitterProportion( proportion );
264
265 m_selectionFilterPanel = new PANEL_SELECTION_FILTER( this );
266
267 m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas() );
268 m_searchPane = new PCB_SEARCH_PANE( this );
269
270 m_auimgr.SetManagedWindow( this );
271
272 CreateInfoBar();
273
274 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
275#if !defined( _WIN32 )
276 // Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds
277 // of graphical glitches.
278 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
279#endif
280 m_auimgr.SetFlags( auiFlags );
281
282 // Rows; layers 4 - 6
283 m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( wxS( "MainToolbar" ) )
284 .Top().Layer( 6 ) );
285 m_auimgr.AddPane( m_auxiliaryToolBar, EDA_PANE().HToolbar().Name( wxS( "AuxToolbar" ) )
286 .Top().Layer( 5 ) );
287 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( wxS( "MsgPanel" ) )
288 .Bottom().Layer( 6 ) );
289
290 // Columns; layers 1 - 3
291 m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( wxS( "OptToolbar" ) )
292 .Left().Layer( 3 ) );
293
294 m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( wxS( "ToolsToolbar" ) )
295 .Right().Layer( 3 ) );
296
297 m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( wxS( "LayersManager" ) )
298 .Right().Layer( 4 )
299 .Caption( _( "Appearance" ) ).PaneBorder( false )
300 .MinSize( 180, -1 ).BestSize( 180, -1 ) );
301
302 m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Name( wxS( "SelectionFilter" ) )
303 .Right().Layer( 4 ).Position( 2 )
304 .Caption( _( "Selection Filter" ) ).PaneBorder( false )
305 .MinSize( 180, -1 ).BestSize( 180, -1 ) );
306
307 m_auimgr.AddPane( m_propertiesPanel, EDA_PANE().Name( PropertiesPaneName() )
308 .Left().Layer( 5 )
309 .Caption( _( "Properties" ) ).PaneBorder( false )
310 .MinSize( 240, 60 ).BestSize( 300, 200 ) );
311
312 // Center
313 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( wxS( "DrawFrame" ) )
314 .Center() );
315
316 m_auimgr.AddPane( m_searchPane, EDA_PANE().Name( SearchPaneName() )
317 .Bottom()
318 .Caption( _( "Search" ) ).PaneBorder( false )
319 .MinSize( 180, 60 ).BestSize( 180, 100 )
320 .FloatingSize( 480, 200 )
321 .CloseButton( true )
322 .DestroyOnClose( false ) );
323
324 m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
325 m_auimgr.GetPane( "SelectionFilter" ).Show( m_show_layer_manager_tools );
326 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.show_properties );
327
328 m_auimgr.GetPane( SearchPaneName() ).Show( m_show_search );
329
330 // The selection filter doesn't need to grow in the vertical direction when docked
331 m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
332
333 FinishAUIInitialization();
334
335 if( PCBNEW_SETTINGS* settings = dynamic_cast<PCBNEW_SETTINGS*>( config() ) )
336 {
337 if( settings->m_AuiPanels.right_panel_width > 0 )
338 {
339 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( wxS( "LayersManager" ) );
340 SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
341 }
342
343 if( settings->m_AuiPanels.properties_panel_width > 0 && m_propertiesPanel )
344 {
345 wxAuiPaneInfo& propertiesPanel = m_auimgr.GetPane( PropertiesPaneName() );
346 SetAuiPaneSize( m_auimgr, propertiesPanel,
347 settings->m_AuiPanels.properties_panel_width, -1 );
348 }
349
350 if( settings->m_AuiPanels.search_panel_height > 0
351 && ( settings->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_TOP
352 || settings->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_BOTTOM ) )
353 {
354 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
355 searchPane.Direction( settings->m_AuiPanels.search_panel_dock_direction );
356 SetAuiPaneSize( m_auimgr, searchPane, -1, settings->m_AuiPanels.search_panel_height );
357 }
358 else if( settings->m_AuiPanels.search_panel_width > 0
359 && ( settings->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_LEFT
360 || settings->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_RIGHT ) )
361 {
362 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
363 searchPane.Direction( settings->m_AuiPanels.search_panel_dock_direction );
364 SetAuiPaneSize( m_auimgr, searchPane, settings->m_AuiPanels.search_panel_width, -1 );
365 }
366
367 m_appearancePanel->SetTabIndex( settings->m_AuiPanels.appearance_panel_tab );
368 }
369
370 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
371
372 // This is used temporarily to fix a client size issue on GTK that causes zoom to fit
373 // to calculate the wrong zoom size. See PCB_EDIT_FRAME::onSize().
374 Bind( wxEVT_SIZE, &PCB_EDIT_FRAME::onSize, this );
375
376 // Redraw netnames (so that they fall within the current viewport) after the viewport
377 // has stopped changing. Redrawing them without the timer moves them smoothly with scrolling,
378 // making it look like the tracks are being dragged -- which we don't want.
379 m_redrawNetnamesTimer.SetOwner( this );
380 Connect( wxEVT_TIMER, wxTimerEventHandler( PCB_EDIT_FRAME::redrawNetnames ), nullptr, this );
381
382 Bind( wxEVT_IDLE,
383 [this]( wxIdleEvent& aEvent )
384 {
385 if( GetCanvas()->GetView()->GetViewport() != m_lastViewport )
386 {
387 m_lastViewport = GetCanvas()->GetView()->GetViewport();
388 m_redrawNetnamesTimer.StartOnce( 500 );
389 }
390
391 // Do not forget to pass the Idle event to other clients:
392 aEvent.Skip();
393 } );
394
395 resolveCanvasType();
396
397 setupUnits( config() );
398
399 // Ensure the Python interpreter is up to date with its environment variables
400 PythonSyncEnvironmentVariables();
401 PythonSyncProjectName();
402
403 // Sync action plugins in case they changed since the last time the frame opened
404 GetToolManager()->RunAction( PCB_ACTIONS::pluginsReload );
405
406 GetCanvas()->SwitchBackend( m_canvasType );
407 ActivateGalCanvas();
408
409 // Default shutdown reason until a file is loaded
410 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "New PCB file is unsaved" ) );
411
412 // disable Export STEP item if kicad2step does not exist
413 wxString strK2S = Pgm().GetExecutablePath();
414
415#ifdef __WXMAC__
416 if( strK2S.Find( wxT( "pcbnew.app" ) ) != wxNOT_FOUND )
417 {
418 // On macOS, we have standalone applications inside the main bundle, so we handle that here:
419 strK2S += wxT( "../../" );
420 }
421
422 strK2S += wxT( "Contents/MacOS/" );
423#endif
424
425 wxFileName appK2S( strK2S, wxT( "kicad2step" ) );
426
427#ifdef _WIN32
428 appK2S.SetExt( wxT( "exe" ) );
429#endif
430
431 // Ensure the window is on top
432 Raise();
433
434// if( !appK2S.FileExists() )
435 // GetMenuBar()->FindItem( ID_GEN_EXPORT_FILE_STEP )->Enable( false );
436
437 // AUI doesn't refresh properly on wxMac after changes in eb7dc6dd, so force it to
438#ifdef __WXMAC__
439 if( Kiface().IsSingle() )
440 {
441 CallAfter( [&]()
442 {
443 m_appearancePanel->OnBoardChanged();
444 } );
445 }
446#endif
447
448 // Register a call to update the toolbar sizes. It can't be done immediately because
449 // it seems to require some sizes calculated that aren't yet (at least on GTK).
450 CallAfter( [&]()
451 {
452 // Ensure the controls on the toolbars all are correctly sized
453 UpdateToolbarControlSizes();
454 } );
455
457 {
458 m_eventCounterTimer = new wxTimer( this );
459
460 Bind( wxEVT_TIMER,
461 [&]( wxTimerEvent& aEvent )
462 {
463 GetCanvas()->m_PaintEventCounter->Show();
464 GetCanvas()->m_PaintEventCounter->Reset();
465
467 static_cast<KIGFX::WX_VIEW_CONTROLS*>( GetCanvas()->GetViewControls() );
468 vc->m_MotionEventCounter->Show();
469 vc->m_MotionEventCounter->Reset();
470
471 },
472 m_eventCounterTimer->GetId() );
473
474 m_eventCounterTimer->Start( 1000 );
475 }
476
477 Bind( EDA_EVT_CLOSE_DIALOG_BOOK_REPORTER, &PCB_EDIT_FRAME::onCloseModelessBookReporterDialogs,
478 this );
479 Bind( EDA_EVT_CLOSE_NET_INSPECTOR_DIALOG, &PCB_EDIT_FRAME::onCloseNetInspectorDialog, this );
480 Bind( EDA_EVT_UNITS_CHANGED, &PCB_EDIT_FRAME::onUnitsChanged, this );
481
482 m_acceptedExts.emplace( KiCadPcbFileExtension, &PCB_ACTIONS::ddAppendBoard );
483 m_acceptedExts.emplace( LegacyPcbFileExtension, &PCB_ACTIONS::ddAppendBoard );
484 DragAcceptFiles( true );
485}
486
487
489{
491
492 if( ADVANCED_CFG::GetCfg().m_ShowEventCounters )
493 {
494 // Stop the timer during destruction early to avoid potential event race conditions (that
495 // do happen on windows)
496 m_eventCounterTimer->Stop();
497 delete m_eventCounterTimer;
498 }
499
500 // Shutdown all running tools
501 if( m_toolManager )
503
504 if( GetBoard() )
506
508 delete m_appearancePanel;
510 delete m_propertiesPanel;
511}
512
513
514void PCB_EDIT_FRAME::SetBoard( BOARD* aBoard, bool aBuildConnectivity,
515 PROGRESS_REPORTER* aReporter )
516{
517 if( m_pcb )
519
520 PCB_BASE_EDIT_FRAME::SetBoard( aBoard, aReporter );
521
522 aBoard->SetProject( &Prj() );
523
524 if( aBuildConnectivity )
525 aBoard->BuildConnectivity();
526
527 // reload the drawing-sheet
528 SetPageSettings( aBoard->GetPageSettings() );
529}
530
531
533{
534 return m_pcb;
535}
536
537
538void PCB_EDIT_FRAME::redrawNetnames( wxTimerEvent& aEvent )
539{
540 bool needs_refresh = false;
541
542 // Don't stomp on the auto-save timer event.
543 if( aEvent.GetId() == ID_AUTO_SAVE_TIMER )
544 {
545 aEvent.Skip();
546 return;
547 }
548
549 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() );
550
551 if( !cfg || cfg->m_Display.m_NetNames < 2 )
552 return;
553
554 KIGFX::VIEW* view = GetCanvas()->GetView();
555 double scale = view->GetScale();
556
557 for( PCB_TRACK* track : GetBoard()->Tracks() )
558 {
559 double lod = track->ViewGetLOD( GetNetnameLayer( track->GetLayer() ), view );
560
561 if( lod < scale )
562 continue;
563
564 if( lod != track->GetCachedLOD() || scale != track->GetCachedScale() )
565 {
566 view->Update( track, KIGFX::REPAINT );
567 needs_refresh = true;
568 track->SetCachedLOD( lod );
569 track->SetCachedScale( scale );
570 }
571 }
572
573 if( needs_refresh )
574 GetCanvas()->Refresh();
575}
576
577
578void PCB_EDIT_FRAME::SetPageSettings( const PAGE_INFO& aPageSettings )
579{
580 PCB_BASE_FRAME::SetPageSettings( aPageSettings );
581
582 // Prepare drawing-sheet template
585 m_pcb->GetProject(),
587 &m_pcb->GetProperties() );
588
589 drawingSheet->SetSheetName( std::string( GetScreenDesc().mb_str() ) );
590 drawingSheet->SetSheetPath( std::string( GetFullScreenDesc().mb_str() ) );
591
592 // A board is not like a schematic having a main page and sub sheets.
593 // So for the drawing sheet, use only the first page option to display items
594 drawingSheet->SetIsFirstPage( true );
595
596 BASE_SCREEN* screen = GetScreen();
597
598 if( screen != nullptr )
599 {
600 drawingSheet->SetPageNumber(TO_UTF8( screen->GetPageNumber() ) );
601 drawingSheet->SetSheetCount( screen->GetPageCount() );
602 }
603
604 if( BOARD* board = GetBoard() )
605 drawingSheet->SetFileName( TO_UTF8( board->GetFileName() ) );
606
607 // PCB_DRAW_PANEL_GAL takes ownership of the drawing-sheet
608 GetCanvas()->SetDrawingSheet( drawingSheet );
609}
610
611
613{
614 return GetScreen() && GetScreen()->IsContentModified();
615}
616
617
619{
620 return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
621}
622
623
625{
626 // Create the manager and dispatcher & route draw panel events to the dispatcher
629 GetCanvas()->GetViewControls(), config(), this );
630 m_actions = new PCB_ACTIONS();
632
633 // Register tools
662
663 for( TOOL_BASE* tool : m_toolManager->Tools() )
664 {
665 if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
666 pcbTool->SetIsBoardEditor( true );
667 }
668
669 // Run the selection tool, it is supposed to be always active
670 m_toolManager->InvokeTool( "pcbnew.InteractiveSelection" );
671}
672
673
675{
677
679 PCB_EDITOR_CONDITIONS cond( this );
680
681 auto undoCond =
682 [ this ] (const SELECTION& aSel )
683 {
685
686 if( drawingTool && drawingTool->GetDrawingMode() != DRAWING_TOOL::MODE::NONE )
687 return true;
688
690
691 if( routerTool && routerTool->RoutingInProgress() )
692 return true;
693
694 return GetUndoCommandCount() > 0;
695 };
696
697 wxASSERT( mgr );
698
699#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
700#define CHECK( x ) ACTION_CONDITIONS().Check( x )
701
703 mgr->SetConditions( ACTIONS::undo, ENABLE( undoCond ) );
705
710 mgr->SetConditions( ACTIONS::millimetersUnits, CHECK( cond.Units( EDA_UNITS::MILLIMETRES ) ) );
711 mgr->SetConditions( ACTIONS::inchesUnits, CHECK( cond.Units( EDA_UNITS::INCHES ) ) );
712 mgr->SetConditions( ACTIONS::milsUnits, CHECK( cond.Units( EDA_UNITS::MILS ) ) );
713
714 mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
715 mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
724
727 { PCB_GROUP_T, PCB_GENERATOR_T } ) ) );
730
736
737 if( SCRIPTING::IsWxAvailable() )
739
740 auto enableZoneControlCondition =
741 [this] ( const SELECTION& )
742 {
745 };
746
748 ENABLE( enableZoneControlCondition )
749 .Check( cond.ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_FILLED ) ) );
751 ENABLE( enableZoneControlCondition )
752 .Check( cond.ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_ZONE_OUTLINE ) ) );
754 ENABLE( enableZoneControlCondition )
755 .Check( cond.ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_FRACTURE_BORDERS ) ) );
757 ENABLE( enableZoneControlCondition )
758 .Check( cond.ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_TRIANGULATION ) ) );
759
761
762 auto constrainedDrawingModeCond =
763 [this]( const SELECTION& )
764 {
766 };
767
768 auto boardFlippedCond =
769 [this]( const SELECTION& )
770 {
771 return GetCanvas() && GetCanvas()->GetView()->IsMirroredX();
772 };
773
774 auto layerManagerCond =
775 [this] ( const SELECTION& )
776 {
777 return LayerManagerShown();
778 };
779
780 auto propertiesCond =
781 [this] ( const SELECTION& )
782 {
783 return PropertiesShown();
784 };
785
786 auto searchPaneCond =
787 [this] ( const SELECTION& )
788 {
789 return m_auimgr.GetPane( SearchPaneName() ).IsShown();
790 };
791
792 auto highContrastCond =
793 [this] ( const SELECTION& )
794 {
795 return GetDisplayOptions().m_ContrastModeDisplay != HIGH_CONTRAST_MODE::NORMAL;
796 };
797
798 auto globalRatsnestCond =
799 [this] (const SELECTION& )
800 {
802 };
803
804 auto curvedRatsnestCond =
805 [this] (const SELECTION& )
806 {
808 };
809
810 auto netHighlightCond =
811 [this]( const SELECTION& )
812 {
814 return !settings->GetHighlightNetCodes().empty();
815 };
816
817 auto enableNetHighlightCond =
818 [this]( const SELECTION& )
819 {
821 return tool && tool->IsNetHighlightSet();
822 };
823
824 mgr->SetConditions( PCB_ACTIONS::toggleHV45Mode, CHECK( constrainedDrawingModeCond ) );
825 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
826 mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
827 mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
828 mgr->SetConditions( PCB_ACTIONS::showRatsnest, CHECK( globalRatsnestCond ) );
829 mgr->SetConditions( PCB_ACTIONS::ratsnestLineMode, CHECK( curvedRatsnestCond ) );
830 mgr->SetConditions( PCB_ACTIONS::toggleNetHighlight, CHECK( netHighlightCond )
831 .Enable( enableNetHighlightCond ) );
832 mgr->SetConditions( PCB_ACTIONS::showProperties, CHECK( propertiesCond ) );
833 mgr->SetConditions( PCB_ACTIONS::showSearch, CHECK( searchPaneCond ) );
834
835 auto isArcKeepCenterMode =
836 [this]( const SELECTION& )
837 {
838 return GetPcbNewSettings()->m_ArcEditMode == ARC_EDIT_MODE::KEEP_CENTER_ADJUST_ANGLE_RADIUS;
839 };
840
841 auto isArcKeepEndpointMode =
842 [this]( const SELECTION& )
843 {
844 return GetPcbNewSettings()->m_ArcEditMode == ARC_EDIT_MODE::KEEP_ENDPOINTS_OR_START_DIRECTION;
845 };
846
847 mgr->SetConditions( PCB_ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
848 mgr->SetConditions( PCB_ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
849
850 auto isHighlightMode =
851 [this]( const SELECTION& )
852 {
854 return tool && tool->GetRouterMode() == PNS::RM_MarkObstacles;
855 };
856
857 auto isShoveMode =
858 [this]( const SELECTION& )
859 {
861 return tool && tool->GetRouterMode() == PNS::RM_Shove;
862 };
863
864 auto isWalkaroundMode =
865 [this]( const SELECTION& )
866 {
868 return tool && tool->GetRouterMode() == PNS::RM_Walkaround;
869 };
870
871 mgr->SetConditions( PCB_ACTIONS::routerHighlightMode, CHECK( isHighlightMode ) );
872 mgr->SetConditions( PCB_ACTIONS::routerShoveMode, CHECK( isShoveMode ) );
873 mgr->SetConditions( PCB_ACTIONS::routerWalkaroundMode, CHECK( isWalkaroundMode ) );
874
875 auto haveNetCond =
876 [] ( const SELECTION& aSel )
877 {
878 for( EDA_ITEM* item : aSel )
879 {
880 if( BOARD_CONNECTED_ITEM* bci = dynamic_cast<BOARD_CONNECTED_ITEM*>( item ) )
881 {
882 if( bci->GetNetCode() > 0 )
883 return true;
884 }
885 }
886
887 return false;
888 };
889
894
905
906
909
912
913 mgr->SetConditions( PCB_ACTIONS::zoneDuplicate, ENABLE( singleZoneCond ) );
914 mgr->SetConditions( PCB_ACTIONS::drawZoneCutout, ENABLE( singleZoneCond ) );
915 mgr->SetConditions( PCB_ACTIONS::drawSimilarZone, ENABLE( singleZoneCond ) );
916 mgr->SetConditions( PCB_ACTIONS::zoneMerge, ENABLE( zoneMergeCond ) );
917
919
920#define CURRENT_TOOL( action ) mgr->SetConditions( action, CHECK( cond.CurrentTool( action ) ) )
921
922 // These tools can be used at any time to inspect the board
927
928
929 auto isDRCIdle =
930 [this] ( const SELECTION& )
931 {
933 return !( tool && tool->IsDRCRunning() );
934 };
935
936#define CURRENT_EDIT_TOOL( action ) \
937 mgr->SetConditions( action, ACTION_CONDITIONS().Check( cond.CurrentTool( action ) ) \
938 .Enable( isDRCIdle ) )
939
940 // These tools edit the board, so they must be disabled during some operations
965
971
972#undef CURRENT_TOOL
973#undef CURRENT_EDIT_TOOL
974#undef ENABLE
975#undef CHECK
976}
977
978
979void PCB_EDIT_FRAME::OnQuit( wxCommandEvent& event )
980{
981 if( event.GetId() == wxID_EXIT )
982 Kiway().OnKiCadExit();
983
984 if( event.GetId() == wxID_CLOSE || Kiface().IsSingle() )
985 Close( false );
986}
987
988
990{
992 bds.m_DrcExclusions.clear();
993
994 for( PCB_MARKER* marker : GetBoard()->Markers() )
995 {
996 if( marker->IsExcluded() )
997 bds.m_DrcExclusions.insert( marker->Serialize() );
998 }
999}
1000
1001
1002void PCB_EDIT_FRAME::ResolveDRCExclusions( bool aCreateMarkers )
1003{
1004 BOARD_COMMIT commit( this );
1005
1006 for( PCB_MARKER* marker : GetBoard()->ResolveDRCExclusions( aCreateMarkers ) )
1007 {
1008 if( marker->GetMarkerType() == MARKER_BASE::MARKER_DRAWING_SHEET )
1009 marker->GetRCItem()->SetItems( GetCanvas()->GetDrawingSheet() );
1010
1011 commit.Add( marker );
1012 }
1013
1014 commit.Push( wxEmptyString, SKIP_UNDO | SKIP_SET_DIRTY );
1015
1016 for( PCB_MARKER* marker : GetBoard()->Markers() )
1017 {
1018 if( marker->GetSeverity() == RPT_SEVERITY_EXCLUSION )
1019 GetCanvas()->GetView()->Update( marker );
1020 }
1021
1023}
1024
1025
1026bool PCB_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
1027{
1028 // Shutdown blocks must be determined and vetoed as early as possible
1029 if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION
1030 && IsContentModified() )
1031 {
1032 return false;
1033 }
1034
1036
1037 if( zoneFillerTool->IsBusy() )
1038 {
1039 wxBell();
1040
1041 if( wxWindow* reporter = dynamic_cast<wxWindow*>( zoneFillerTool->GetProgressReporter() ) )
1042 reporter->ShowWithEffect( wxSHOW_EFFECT_EXPAND );
1043
1044 return false;
1045 }
1046
1047 if( Kiface().IsSingle() )
1048 {
1049 auto* fpEditor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false );
1050
1051 if( fpEditor && !fpEditor->Close() ) // Can close footprint editor?
1052 return false;
1053
1054 auto* fpViewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
1055
1056 if( fpViewer && !fpViewer->Close() ) // Can close footprint viewer?
1057 return false;
1058
1059 // FOOTPRINT_CHOOSER_FRAME is always modal so this shouldn't come up, but better safe than
1060 // sorry.
1061 auto* chooser = (FOOTPRINT_CHOOSER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_CHOOSER, false );
1062
1063 if( chooser && !chooser->Close() ) // Can close footprint chooser?
1064 return false;
1065 }
1066 else
1067 {
1068 auto* fpEditor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false );
1069
1070 if( fpEditor && fpEditor->IsCurrentFPFromBoard() )
1071 {
1072 if( !fpEditor->CanCloseFPFromBoard( true ) )
1073 return false;
1074 }
1075 }
1076
1077 if( IsContentModified() )
1078 {
1079 wxFileName fileName = GetBoard()->GetFileName();
1080 wxString msg = _( "Save changes to '%s' before closing?" );
1081
1082 if( !HandleUnsavedChanges( this, wxString::Format( msg, fileName.GetFullName() ),
1083 [&]() -> bool
1084 {
1085 return Files_io_from_id( ID_SAVE_BOARD );
1086 } ) )
1087 {
1088 return false;
1089 }
1090 }
1091
1092 return PCB_BASE_EDIT_FRAME::canCloseWindow( aEvent );
1093}
1094
1095
1097{
1098 // On Windows 7 / 32 bits, on OpenGL mode only, Pcbnew crashes
1099 // when closing this frame if a footprint was selected, and the footprint editor called
1100 // to edit this footprint, and when closing pcbnew if this footprint is still selected
1101 // See https://bugs.launchpad.net/kicad/+bug/1655858
1102 // I think this is certainly a OpenGL event fired after frame deletion, so this workaround
1103 // avoid the crash (JPC)
1104 GetCanvas()->SetEvtHandlerEnabled( false );
1105
1107
1108 // Clean up mode-less dialogs.
1109 Unbind( EDA_EVT_CLOSE_DIALOG_BOOK_REPORTER,
1111 Unbind( EDA_EVT_CLOSE_NET_INSPECTOR_DIALOG, &PCB_EDIT_FRAME::onCloseNetInspectorDialog, this );
1112 Unbind( EDA_EVT_UNITS_CHANGED, &PCB_EDIT_FRAME::onUnitsChanged, this );
1113
1114 wxWindow* open_dlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
1115
1116 if( open_dlg )
1117 open_dlg->Close( true );
1118
1119 if( m_findDialog )
1120 {
1121 m_findDialog->Destroy();
1122 m_findDialog = nullptr;
1123 }
1124
1126 {
1127 m_inspectDrcErrorDlg->Destroy();
1128 m_inspectDrcErrorDlg = nullptr;
1129 }
1130
1132 {
1133 m_inspectClearanceDlg->Destroy();
1134 m_inspectClearanceDlg = nullptr;
1135 }
1136
1138 {
1139 m_inspectConstraintsDlg->Destroy();
1140 m_inspectConstraintsDlg = nullptr;
1141 }
1142
1143 if( m_footprintDiffDlg )
1144 {
1145 m_footprintDiffDlg->Destroy();
1146 m_footprintDiffDlg = nullptr;
1147 }
1148
1149 if( m_netInspectorDlg )
1150 {
1152 m_netInspectorDlg->Destroy();
1153 m_netInspectorDlg = nullptr;
1154 }
1155
1156 // Delete the auto save file if it exists.
1157 wxFileName fn = GetBoard()->GetFileName();
1158
1159 // Auto save file name is the normal file name prefixed with 'GetAutoSaveFilePrefix()'.
1160 fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() );
1161
1162 // When the auto save feature does not have write access to the board file path, it falls
1163 // back to a platform specific user temporary file path.
1164 if( !fn.IsOk() || !fn.IsDirWritable() )
1165 fn.SetPath( wxFileName::GetTempDir() );
1166
1167 wxLogTrace( traceAutoSave, wxT( "Deleting auto save file <" ) + fn.GetFullPath() + wxT( ">" ) );
1168
1169 // Remove the auto save file on a normal close of Pcbnew.
1170 if( fn.FileExists() && !wxRemoveFile( fn.GetFullPath() ) )
1171 {
1172 wxLogTrace( traceAutoSave, wxT( "The auto save file could not be removed!" ) );
1173 }
1174
1175 // Make sure local settings are persisted
1177
1178 // Do not show the layer manager during closing to avoid flicker
1179 // on some platforms (Windows) that generate useless redraw of items in
1180 // the Layer Manager
1182 {
1183 m_auimgr.GetPane( wxS( "LayersManager" ) ).Show( false );
1184 m_auimgr.GetPane( wxS( "TabbedPanel" ) ).Show( false );
1185 }
1186
1187 // Unlink the old project if needed
1189
1190 // Delete board structs and undo/redo lists, to avoid crash on exit
1191 // when deleting some structs (mainly in undo/redo lists) too late
1192 Clear_Pcb( false, true );
1193
1194 // do not show the window because ScreenPcb will be deleted and we do not
1195 // want any paint event
1196 Show( false );
1197
1199}
1200
1201
1203{
1206 GetCanvas()->Refresh();
1207}
1208
1209
1210void PCB_EDIT_FRAME::ShowBoardSetupDialog( const wxString& aInitialPage )
1211{
1212 std::unique_lock<std::mutex> dialogLock( DIALOG_BOARD_SETUP::g_Mutex, std::try_to_lock );
1213
1214 // One DIALOG_BOARD_SETUP dialog at a time.
1215 if( !dialogLock.owns_lock() )
1216 return;
1217
1218 // Make sure everything's up-to-date
1220
1221 DIALOG_BOARD_SETUP dlg( this );
1222
1223 if( !aInitialPage.IsEmpty() )
1224 dlg.SetInitialPage( aInitialPage, wxEmptyString );
1225
1226 if( dlg.ShowQuasiModal() == wxID_OK )
1227 {
1229 // We don't know if anything was modified, so err on the side of requiring a save
1230 OnModify();
1231
1232 Kiway().CommonSettingsChanged( false, true );
1233
1236
1237 PCBNEW_SETTINGS* settings = GetPcbNewSettings();
1238 static LSET maskAndPasteLayers = LSET( 4, F_Mask, F_Paste, B_Mask, B_Paste );
1239
1241 [&]( KIGFX::VIEW_ITEM* aItem ) -> int
1242 {
1243 BOARD_ITEM* item = dynamic_cast<BOARD_ITEM*>( aItem );
1244 int flags = 0;
1245
1246 if( !item )
1247 return flags;
1248
1249 if( item->Type() == PCB_VIA_T || item->Type() == PCB_PAD_T )
1250 {
1251 // Note: KIGFX::REPAINT isn't enough for things that go from invisible
1252 // to visible as they won't be found in the view layer's itemset for
1253 // re-painting.
1254 if( ( GetBoard()->GetVisibleLayers() & maskAndPasteLayers ).any() )
1255 flags |= KIGFX::ALL;
1256 }
1257
1258 if( item->Type() == PCB_TRACE_T || item->Type() == PCB_ARC_T || item->Type() == PCB_VIA_T )
1259 {
1261 flags |= KIGFX::REPAINT;
1262 }
1263
1264 if( item->Type() == PCB_PAD_T )
1265 {
1266 if( settings->m_Display.m_PadClearance )
1267 flags |= KIGFX::REPAINT;
1268 }
1269
1270 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( aItem );
1271
1272 if( text && text->HasTextVars() )
1273 {
1274 text->ClearRenderCache();
1275 text->ClearBoundingBoxCache();
1277 }
1278
1279 return flags;
1280 } );
1281
1282 GetCanvas()->Refresh();
1283
1287
1288 //this event causes the routing tool to reload its design rules information
1290 toolEvent.SetHasPosition( false );
1291 m_toolManager->ProcessEvent( toolEvent );
1292 }
1293
1294 GetCanvas()->SetFocus();
1295}
1296
1297
1299{
1301
1302 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
1303 wxASSERT( cfg );
1304
1305 if( cfg )
1306 {
1309 }
1310}
1311
1312
1314{
1316
1317 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
1318 wxASSERT( cfg );
1319
1320 if( cfg )
1321 {
1323
1324 if( m_propertiesPanel )
1325 {
1326 cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
1329 }
1330
1331 // ensure m_show_search is up to date (the pane can be closed)
1332 wxAuiPaneInfo& searchPaneInfo = m_auimgr.GetPane( SearchPaneName() );
1333 m_show_search = searchPaneInfo.IsShown();
1335 cfg->m_AuiPanels.search_panel_height = m_searchPane->GetSize().y;
1336 cfg->m_AuiPanels.search_panel_width = m_searchPane->GetSize().x;
1337 cfg->m_AuiPanels.search_panel_dock_direction = searchPaneInfo.dock_direction;
1338
1339 if( m_appearancePanel )
1340 {
1345 }
1346 }
1347}
1348
1349
1351{
1352 PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( config() );
1353
1354 return cfg ? cfg->m_RotationAngle : ANGLE_90;
1355}
1356
1357
1359{
1361}
1362
1363
1365{
1366
1367 GetColorSettings()->SetColor( LAYER_GRID, aColor );
1368 GetCanvas()->GetGAL()->SetGridColor( aColor );
1369}
1370
1371
1373{
1374 PCB_LAYER_ID oldLayer = GetActiveLayer();
1375
1376 if( oldLayer == aLayer )
1377 return;
1378
1380
1382
1383 m_toolManager->PostAction( PCB_ACTIONS::layerChanged ); // notify other tools
1384 GetCanvas()->SetFocus(); // allow capture of hotkeys
1385 GetCanvas()->SetHighContrastLayer( aLayer );
1386
1388 [&]( KIGFX::VIEW_ITEM* aItem ) -> int
1389 {
1390 BOARD_ITEM* item = dynamic_cast<BOARD_ITEM*>( aItem );
1391
1392 if( !item )
1393 return 0;
1394
1395 // Note: KIGFX::REPAINT isn't enough for things that go from invisible to visible
1396 // as they won't be found in the view layer's itemset for re-painting.
1397 if( GetDisplayOptions().m_ContrastModeDisplay == HIGH_CONTRAST_MODE::HIDDEN )
1398 {
1399 if( item->IsOnLayer( oldLayer ) || item->IsOnLayer( aLayer ) )
1400 return KIGFX::ALL;
1401 }
1402
1403 if( item->Type() == PCB_VIA_T )
1404 {
1405 PCB_VIA* via = static_cast<PCB_VIA*>( item );
1406
1407 // Vias on a restricted layer set must be redrawn when the active layer
1408 // is changed
1409 if( via->GetViaType() == VIATYPE::BLIND_BURIED
1410 || via->GetViaType() == VIATYPE::MICROVIA )
1411 {
1412 return KIGFX::REPAINT;
1413 }
1414
1415 if( via->GetRemoveUnconnected() )
1416 return KIGFX::ALL;
1417
1418 // Clearances could be layer-dependent so redraw them when the active layer
1419 // is changed
1421 return KIGFX::REPAINT;
1422 }
1423 else if( item->Type() == PCB_PAD_T )
1424 {
1425 PAD* pad = static_cast<PAD*>( item );
1426
1427 if( pad->GetRemoveUnconnected() )
1428 return KIGFX::ALL;
1429
1430 // Clearances could be layer-dependent so redraw them when the active layer
1431 // is changed
1433 {
1434 // Round-corner rects are expensive to draw, but are mostly found on
1435 // SMD pads which only need redrawing on an active-to-not-active
1436 // switch.
1437 if( pad->GetAttribute() == PAD_ATTRIB::SMD )
1438 {
1439 if( ( oldLayer == F_Cu || aLayer == F_Cu ) && pad->IsOnLayer( F_Cu ) )
1440 return KIGFX::REPAINT;
1441
1442 if( ( oldLayer == B_Cu || aLayer == B_Cu ) && pad->IsOnLayer( B_Cu ) )
1443 return KIGFX::REPAINT;
1444 }
1445 else if( pad->IsOnLayer( oldLayer ) || pad->IsOnLayer( aLayer ) )
1446 {
1447 return KIGFX::REPAINT;
1448 }
1449 }
1450 }
1451 else if( item->Type() == PCB_TRACE_T || item->Type() == PCB_ARC_T )
1452 {
1453 PCB_TRACK* track = static_cast<PCB_TRACK*>( item );
1454
1455 // Clearances could be layer-dependent so redraw them when the active layer
1456 // is changed
1458 {
1459 // Tracks aren't particularly expensive to draw, but it's an easy check.
1460 if( track->IsOnLayer( oldLayer ) || track->IsOnLayer( aLayer ) )
1461 return KIGFX::REPAINT;
1462 }
1463 }
1464
1465 return 0;
1466 } );
1467
1468 GetCanvas()->Refresh();
1469}
1470
1471
1473{
1474 // JEY TODO: move this global to the board
1476
1477 layerEnum.Choices().Clear();
1478 layerEnum.Undefined( UNDEFINED_LAYER );
1479
1480 for( LSEQ seq = LSET::AllLayersMask().Seq(); seq; ++seq )
1481 {
1482 // Canonical name
1483 layerEnum.Map( *seq, LSET::Name( *seq ) );
1484
1485 // User name
1486 layerEnum.Map( *seq, GetBoard()->GetLayerName( *seq ) );
1487 }
1488
1489 DRC_TOOL* drcTool = m_toolManager->GetTool<DRC_TOOL>();
1490
1491 try
1492 {
1493 drcTool->GetDRCEngine()->InitEngine( GetDesignRulesPath() );
1494 }
1495 catch( PARSE_ERROR& )
1496 {
1497 // Not sure this is the best place to tell the user their rules are buggy, so
1498 // we'll stay quiet for now. Feel free to revisit this decision....
1499 }
1500
1501 UpdateTitle();
1502
1503 wxFileName fn = GetBoard()->GetFileName();
1504
1505 // Display a warning that the file is read only
1506 if( fn.FileExists() && !fn.IsFileWritable() )
1507 {
1510 m_infoBar->ShowMessage( _( "Board file is read only." ),
1512 }
1513
1515
1516 // Sync layer and item visibility
1518
1519 SetElementVisibility( LAYER_RATSNEST, GetPcbNewSettings()->m_Display.m_ShowGlobalRatsnest );
1520
1522
1523 // Apply saved display state to the appearance panel after it has been set up
1524 PROJECT_LOCAL_SETTINGS& localSettings = Prj().GetLocalSettings();
1525
1527
1528 if( GetBoard()->GetDesignSettings().IsLayerEnabled( localSettings.m_ActiveLayer ) )
1529 SetActiveLayer( localSettings.m_ActiveLayer );
1530
1531 // Updates any auto dimensions and the auxiliary toolbar tracks/via sizes
1533
1534 // Display the loaded board:
1535 Zoom_Automatique( false );
1536
1537 // Invalidate painting as loading the DRC engine will cause clearances to become valid
1539
1540 Refresh();
1541
1542 SetMsgPanel( GetBoard() );
1543 SetStatusText( wxEmptyString );
1544
1545 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "PCB file changes are unsaved" ) );
1546}
1547
1548
1550{
1552}
1553
1554
1556{
1557 return GetBoard()->IsElementVisible( aElement );
1558}
1559
1560
1562{
1563 // Force the RATSNEST visible
1564 if( aElement == LAYER_RATSNEST )
1565 GetCanvas()->GetView()->SetLayerVisible( aElement, true );
1566 else
1567 GetCanvas()->GetView()->SetLayerVisible( aElement , aNewState );
1568
1569 GetBoard()->SetElementVisibility( aElement, aNewState );
1570}
1571
1572
1574{
1575 // call my base class
1577
1578 m_auimgr.GetPane( m_appearancePanel ).Caption( _( "Appearance" ) );
1579 m_auimgr.GetPane( m_selectionFilterPanel ).Caption( _( "Selection Filter" ) );
1580 m_auimgr.GetPane( m_propertiesPanel ).Caption( _( "Properties" ) );
1581 m_auimgr.Update();
1582
1586
1587 UpdateTitle();
1588}
1589
1590
1592{
1594
1595 if( project.m_PcbLastPath[ aType ].IsEmpty() )
1596 return wxEmptyString;
1597
1598 wxFileName absoluteFileName = project.m_PcbLastPath[ aType ];
1599 wxFileName pcbFileName = GetBoard()->GetFileName();
1600
1601 absoluteFileName.MakeAbsolute( pcbFileName.GetPath() );
1602 return absoluteFileName.GetFullPath();
1603}
1604
1605
1606void PCB_EDIT_FRAME::SetLastPath( LAST_PATH_TYPE aType, const wxString& aLastPath )
1607{
1609
1610 wxFileName relativeFileName = aLastPath;
1611 wxFileName pcbFileName = GetBoard()->GetFileName();
1612
1613 relativeFileName.MakeRelativeTo( pcbFileName.GetPath() );
1614
1615 if( relativeFileName.GetFullPath() != project.m_PcbLastPath[ aType ] )
1616 {
1617 project.m_PcbLastPath[ aType ] = relativeFileName.GetFullPath();
1618 OnModify();
1619 }
1620}
1621
1622
1624{
1626
1627 Update3DView( true, GetPcbNewSettings()->m_Display.m_Live3DRefresh );
1628
1629 if( !GetTitle().StartsWith( wxT( "*" ) ) )
1630 UpdateTitle();
1631
1632 m_ZoneFillsDirty = true;
1633}
1634
1635
1637{
1638 Update3DView( true, true );
1639}
1640
1641
1642void PCB_EDIT_FRAME::ExportSVG( wxCommandEvent& event )
1643{
1644 InvokeExportSVG( this, GetBoard() );
1645}
1646
1647
1649{
1650 wxFileName fn = GetBoard()->GetFileName();
1651 bool readOnly = false;
1652 bool unsaved = false;
1653
1654 if( fn.IsOk() && fn.FileExists() )
1655 readOnly = !fn.IsFileWritable();
1656 else
1657 unsaved = true;
1658
1659 wxString title;
1660
1661 if( IsContentModified() )
1662 title = wxT( "*" );
1663
1664 title += fn.GetName();
1665
1666 if( readOnly )
1667 title += wxS( " " ) + _( "[Read Only]" );
1668
1669 if( unsaved )
1670 title += wxS( " " ) + _( "[Unsaved]" );
1671
1672 title += wxT( " \u2014 " ) + _( "PCB Editor" );
1673
1674 SetTitle( title );
1675}
1676
1677
1679{
1680 // Update the layer manager and other widgets from the board setup
1681 // (layer and items visibility, colors ...)
1682
1683 // Rebuild list of nets (full ratsnest rebuild)
1685
1686 // Update info shown by the horizontal toolbars
1688
1689 LSET activeLayers = GetBoard()->GetEnabledLayers();
1690
1691 if( !activeLayers.test( GetActiveLayer() ) )
1692 SetActiveLayer( activeLayers.Seq().front() );
1693
1695
1697
1698 layerEnum.Choices().Clear();
1699 layerEnum.Undefined( UNDEFINED_LAYER );
1700
1701 for( LSEQ seq = LSET::AllLayersMask().Seq(); seq; ++seq )
1702 {
1703 // Canonical name
1704 layerEnum.Map( *seq, LSET::Name( *seq ) );
1705
1706 // User name
1707 layerEnum.Map( *seq, GetBoard()->GetLayerName( *seq ) );
1708 }
1709
1710 // Sync visibility with canvas
1711 for( PCB_LAYER_ID layer : LSET::AllLayersMask().Seq() )
1712 GetCanvas()->GetView()->SetLayerVisible( layer, GetBoard()->IsLayerVisible( layer ) );
1713
1714 // Stackup and/or color theme may have changed
1716}
1717
1718
1720{
1721 // switches currently used canvas (Cairo / OpenGL).
1722 PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
1723}
1724
1725
1727{
1728 if( !m_findDialog )
1729 {
1730 m_findDialog = new DIALOG_FIND( this );
1733 }
1734
1735 wxString findString;
1736
1737 PCB_SELECTION& selection = m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
1738
1739 if( selection.Size() == 1 )
1740 {
1741 EDA_ITEM* front = selection.Front();
1742
1743 switch( front->Type() )
1744 {
1745 case PCB_FOOTPRINT_T:
1746 findString = UnescapeString( static_cast<FOOTPRINT*>( front )->GetValue() );
1747 break;
1748
1749 case PCB_FIELD_T:
1750 case PCB_TEXT_T:
1751 findString = UnescapeString( static_cast<PCB_TEXT*>( front )->GetText() );
1752
1753 if( findString.Contains( wxT( "\n" ) ) )
1754 findString = findString.Before( '\n' );
1755
1756 break;
1757
1758 default:
1759 break;
1760 }
1761 }
1762
1763 m_findDialog->Preload( findString );
1764
1765 m_findDialog->Show( true );
1766}
1767
1768
1769void PCB_EDIT_FRAME::FindNext( bool reverse )
1770{
1771 if( !m_findDialog )
1773
1774 m_findDialog->FindNext( reverse );
1775}
1776
1777
1779{
1780 PCB_PLOT_PARAMS plotSettings = GetPlotSettings();
1781
1782 switch( aID )
1783 {
1784 case ID_GEN_PLOT_GERBER:
1785 plotSettings.SetFormat( PLOT_FORMAT::GERBER );
1786 break;
1787 case ID_GEN_PLOT_DXF:
1788 plotSettings.SetFormat( PLOT_FORMAT::DXF );
1789 break;
1790 case ID_GEN_PLOT_HPGL:
1791 plotSettings.SetFormat( PLOT_FORMAT::HPGL );
1792 break;
1793 case ID_GEN_PLOT_PDF:
1794 plotSettings.SetFormat( PLOT_FORMAT::PDF );
1795 break;
1796 case ID_GEN_PLOT_PS:
1797 plotSettings.SetFormat( PLOT_FORMAT::POST );
1798 break;
1799 case ID_GEN_PLOT:
1800 /* keep the previous setup */
1801 break;
1802 default:
1803 wxFAIL_MSG( wxT( "ToPlotter(): unexpected plot type" ) ); break;
1804 break;
1805 }
1806
1807 SetPlotSettings( plotSettings );
1808
1809 DIALOG_PLOT dlg( this );
1810 dlg.ShowQuasiModal( );
1811}
1812
1813
1815{
1816 if( Kiface().IsSingle() )
1817 return 0;
1818
1819 // Update PCB requires a netlist. Therefore the schematic editor must be running
1820 // If this is not the case, open the schematic editor
1821 KIWAY_PLAYER* frame = Kiway().Player( FRAME_SCH, true );
1822
1823 // If Kiway() cannot create the eeschema frame, it shows a error message, and
1824 // frame is null
1825 if( !frame )
1826 return -1;
1827
1828 if( !frame->IsShownOnScreen() )
1829 {
1830 wxFileName fn( Prj().GetProjectPath(), Prj().GetProjectName(),
1832
1833 // Maybe the file hasn't been converted to the new s-expression file format so
1834 // see if the legacy schematic file is still in play.
1835 if( !fn.FileExists() )
1836 {
1837 fn.SetExt( LegacySchematicFileExtension );
1838
1839 if( !fn.FileExists() )
1840 {
1841 DisplayError( this, _( "The schematic for this board cannot be found." ) );
1842 return -2;
1843 }
1844 }
1845
1846 frame->OpenProjectFiles( std::vector<wxString>( 1, fn.GetFullPath() ) );
1847
1848 // we show the schematic editor frame, because do not show is seen as
1849 // a not yet opened schematic by Kicad manager, which is not the case
1850 frame->Show( true );
1851
1852 // bring ourselves back to the front
1853 Raise();
1854 }
1855
1856 return 1; //Success!
1857}
1858
1859
1861 const wxString& aAnnotateMessage )
1862{
1863 int standalone = TestStandalone();
1864
1865 if( standalone == 0 )
1866 {
1867 DisplayErrorMessage( this, _( "Cannot update the PCB because PCB editor is opened in "
1868 "stand-alone mode. In order to create or update PCBs from "
1869 "schematics, you must launch the KiCad project manager and "
1870 "create a project." ) );
1871 return false; // Not in standalone mode
1872 }
1873
1874 if( standalone < 0 ) // Problem with Eeschema or the schematic
1875 return false;
1876
1877 Raise(); // Show
1878
1879 std::string payload( aAnnotateMessage );
1880
1881 Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_GET_NETLIST, payload, this );
1882
1883 if( payload == aAnnotateMessage )
1884 {
1885 Raise();
1886 DisplayErrorMessage( this, aAnnotateMessage );
1887 return false;
1888 }
1889
1890 try
1891 {
1892 auto lineReader = new STRING_LINE_READER( payload, _( "Eeschema netlist" ) );
1893 KICAD_NETLIST_READER netlistReader( lineReader, &aNetlist );
1894 netlistReader.LoadNetlist();
1895 }
1896 catch( const IO_ERROR& e )
1897 {
1898 Raise();
1899
1900 // Do not translate extra_info strings. These are for developers
1901 wxString extra_info = e.Problem() + wxT( " : " ) + e.What() + wxT( " at " ) + e.Where();
1902
1903 DisplayErrorMessage( this, _( "Received an error while reading netlist. Please "
1904 "report this issue to the KiCad team using the menu "
1905 "Help->Report Bug."), extra_info );
1906 return false;
1907 }
1908
1909 return true;
1910}
1911
1912
1914{
1915 wxString msg;
1916 wxFileName schematic( Prj().GetProjectPath(), Prj().GetProjectName(),
1918
1919 if( !schematic.FileExists() )
1920 {
1921 wxFileName legacySchematic( Prj().GetProjectPath(), Prj().GetProjectName(),
1923
1924 if( legacySchematic.FileExists() )
1925 {
1926 schematic = legacySchematic;
1927 }
1928 else
1929 {
1930 msg.Printf( _( "Schematic file '%s' not found." ), schematic.GetFullPath() );
1931 DisplayErrorMessage( this, msg );
1932 return;
1933 }
1934 }
1935
1936 if( Kiface().IsSingle() )
1937 {
1938 ExecuteFile( EESCHEMA_EXE, schematic.GetFullPath() );
1939 }
1940 else
1941 {
1942 KIWAY_PLAYER* frame = Kiway().Player( FRAME_SCH, false );
1943
1944 // Please: note: DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers() calls
1945 // Kiway.Player( FRAME_SCH, true )
1946 // therefore, the schematic editor is sometimes running, but the schematic project
1947 // is not loaded, if the library editor was called, and the dialog field editor was used.
1948 // On Linux, it happens the first time the schematic editor is launched, if
1949 // library editor was running, and the dialog field editor was open
1950 // On Windows, it happens always after the library editor was called,
1951 // and the dialog field editor was used
1952 if( !frame )
1953 {
1954 try
1955 {
1956 frame = Kiway().Player( FRAME_SCH, true );
1957 }
1958 catch( const IO_ERROR& err )
1959 {
1960 DisplayErrorMessage( this, _( "Eeschema failed to load." ) + wxS( "\n" ) + err.What() );
1961 return;
1962 }
1963 }
1964
1965 // If Kiway() cannot create the eeschema frame, it shows a error message, and
1966 // frame is null
1967 if( !frame )
1968 return;
1969
1970 if( !frame->IsShownOnScreen() ) // the frame exists, (created by the dialog field editor)
1971 // but no project loaded.
1972 {
1973 frame->OpenProjectFiles( std::vector<wxString>( 1, schematic.GetFullPath() ) );
1974 frame->Show( true );
1975 }
1976
1977 // On Windows, Raise() does not bring the window on screen, when iconized or not shown
1978 // On Linux, Raise() brings the window on screen, but this code works fine
1979 if( frame->IsIconized() )
1980 {
1981 frame->Iconize( false );
1982
1983 // If an iconized frame was created by Pcbnew, Iconize( false ) is not enough
1984 // to show the frame at its normal size: Maximize should be called.
1985 frame->Maximize( false );
1986 }
1987
1988 frame->Raise();
1989 }
1990}
1991
1992
1994{
1995 const ENV_VAR_MAP& vars = Pgm().GetLocalEnvVariables();
1996
1997 // Set the environment variables for python scripts
1998 // note: the string will be encoded UTF8 for python env
1999 for( const std::pair<const wxString, ENV_VAR_ITEM>& var : vars )
2000 UpdatePythonEnvVar( var.first, var.second.GetValue() );
2001
2002 // Because the env vars can be modified by the python scripts (rewritten in UTF8),
2003 // regenerate them (in Unicode) for our normal environment
2004 for( const std::pair<const wxString, ENV_VAR_ITEM>& var : vars )
2005 wxSetEnv( var.first, var.second.GetValue() );
2006}
2007
2008
2010{
2011 wxString evValue;
2012 wxGetEnv( PROJECT_VAR_NAME, &evValue );
2013 UpdatePythonEnvVar( wxString( PROJECT_VAR_NAME ).ToStdString(), evValue );
2014
2015 // Because PROJECT_VAR_NAME can be modified by the python scripts (rewritten in UTF8),
2016 // regenerate it (in Unicode) for our normal environment
2017 wxSetEnv( PROJECT_VAR_NAME, evValue );
2018}
2019
2020
2022{
2023 if( aFootprint == nullptr )
2024 return;
2025
2027
2028 /*
2029 * Make sure dlg is destroyed before GetCanvas->Refresh is called
2030 * later or the refresh will try to modify its properties since
2031 * they share a GL context.
2032 */
2033 {
2034 DIALOG_FOOTPRINT_PROPERTIES dlg( this, aFootprint );
2035
2036 dlg.ShowModal();
2037 retvalue = dlg.GetReturnValue();
2038 }
2039
2040 /*
2041 * retvalue =
2042 * FP_PROPS_UPDATE_FP to show Update Footprints dialog
2043 * FP_PROPS_CHANGE_FP to show Change Footprints dialog
2044 * FP_PROPS_OK for normal edit
2045 * FP_PROPS_CANCEL if aborted
2046 * FP_PROPS_EDIT_BOARD_FP to load board footprint into Footprint Editor
2047 * FP_PROPS_EDIT_LIBRARY_FP to load library footprint into Footprint Editor
2048 */
2049
2051 {
2052 // If something edited, push a refresh request
2053 GetCanvas()->Refresh();
2054 }
2056 {
2058
2059 editor->LoadFootprintFromBoard( aFootprint );
2060
2061 editor->Show( true );
2062 editor->Raise(); // Iconize( false );
2063 }
2065 {
2067
2068 editor->LoadFootprintFromLibrary( aFootprint->GetFPID() );
2069
2070 editor->Show( true );
2071 editor->Raise(); // Iconize( false );
2072 }
2074 {
2075 ShowExchangeFootprintsDialog( aFootprint, true, true );
2076 }
2078 {
2079 ShowExchangeFootprintsDialog( aFootprint, false, true );
2080 }
2081}
2082
2083
2085 bool aSelectedMode )
2086{
2087 DIALOG_EXCHANGE_FOOTPRINTS dialog( this, aFootprint, aUpdateMode, aSelectedMode );
2088
2089 return dialog.ShowQuasiModal();
2090}
2091
2092
2104static void processTextItem( const PCB_TEXT& aSrc, PCB_TEXT& aDest,
2105 bool aResetText, bool aResetTextLayers, bool aResetTextEffects,
2106 bool* aUpdated )
2107{
2108 if( aResetText )
2109 *aUpdated |= aSrc.GetText() != aDest.GetText();
2110 else
2111 aDest.SetText( aSrc.GetText() );
2112
2113 if( aResetTextLayers )
2114 {
2115 *aUpdated |= aSrc.GetLayer() != aDest.GetLayer();
2116 *aUpdated |= aSrc.IsVisible() != aDest.IsVisible();
2117 }
2118 else
2119 {
2120 aDest.SetLayer( aSrc.GetLayer() );
2121 aDest.SetVisible( aSrc.IsVisible() );
2122 }
2123
2124 if( aResetTextEffects )
2125 {
2126 *aUpdated |= aSrc.GetHorizJustify() != aDest.GetHorizJustify();
2127 *aUpdated |= aSrc.GetVertJustify() != aDest.GetVertJustify();
2128 *aUpdated |= aSrc.GetTextSize() != aDest.GetTextSize();
2129 *aUpdated |= aSrc.GetTextThickness() != aDest.GetTextThickness();
2130 *aUpdated |= aSrc.GetTextAngle() != aDest.GetTextAngle();
2131 *aUpdated |= aSrc.GetFPRelativePosition() != aDest.GetFPRelativePosition();
2132 }
2133 else
2134 {
2135 // Careful: the visible bit and position are also set by SetAttributes()
2136 bool visible = aDest.IsVisible();
2137 aDest.SetAttributes( aSrc );
2138 aDest.SetVisible( visible );
2140 }
2141
2142 aDest.SetLocked( aSrc.IsLocked() );
2143}
2144
2145
2146static PCB_TEXT* getMatchingTextItem( PCB_TEXT* aRefItem, FOOTPRINT* aFootprint )
2147{
2148 std::vector<PCB_TEXT*> candidates;
2149
2150 for( BOARD_ITEM* item : aFootprint->GraphicalItems() )
2151 {
2152 PCB_TEXT* candidate = dynamic_cast<PCB_TEXT*>( item );
2153
2154 if( candidate && candidate->GetText() == aRefItem->GetText() )
2155 candidates.push_back( candidate );
2156 }
2157
2158 if( candidates.size() == 0 )
2159 return nullptr;
2160
2161 if( candidates.size() == 1 )
2162 return candidates[0];
2163
2164 // Try refining the match by layer
2165 std::vector<PCB_TEXT*> candidatesOnSameLayer;
2166
2167 for( PCB_TEXT* candidate : candidates )
2168 {
2169 if( candidate->GetLayer() == aRefItem->GetLayer() )
2170 candidatesOnSameLayer.push_back( candidate );
2171 }
2172
2173 if( candidatesOnSameLayer.size() == 1 )
2174 return candidatesOnSameLayer[0];
2175
2176 // Last ditch effort: refine by position
2177 std::vector<PCB_TEXT*> candidatesAtSamePos;
2178
2179 for( PCB_TEXT* candidate : candidatesOnSameLayer.size() ? candidatesOnSameLayer : candidates )
2180 {
2181 if( candidate->GetFPRelativePosition() == aRefItem->GetFPRelativePosition() )
2182 candidatesAtSamePos.push_back( candidate );
2183 }
2184
2185 if( candidatesAtSamePos.size() > 0 )
2186 return candidatesAtSamePos[0];
2187 else if( candidatesOnSameLayer.size() > 0 )
2188 return candidatesOnSameLayer[0];
2189 else
2190 return candidates[0];
2191}
2192
2193
2195 BOARD_COMMIT& aCommit, bool deleteExtraTexts,
2196 bool resetTextLayers, bool resetTextEffects,
2197 bool resetFabricationAttrs, bool reset3DModels,
2198 bool* aUpdated )
2199{
2200 PCB_GROUP* parentGroup = aExisting->GetParentGroup();
2201 bool dummyBool = false;
2202
2203 if( !aUpdated )
2204 aUpdated = &dummyBool;
2205
2206 if( parentGroup )
2207 {
2208 parentGroup->RemoveItem( aExisting );
2209 parentGroup->AddItem( aNew );
2210 }
2211
2212 aNew->SetParent( GetBoard() );
2213
2214 PlaceFootprint( aNew, false );
2215
2216 // PlaceFootprint will move the footprint to the cursor position, which we don't want. Copy
2217 // the original position across.
2218 aNew->SetPosition( aExisting->GetPosition() );
2219
2220 if( aNew->GetLayer() != aExisting->GetLayer() )
2221 aNew->Flip( aNew->GetPosition(), GetPcbNewSettings()->m_FlipLeftRight );
2222
2223 if( aNew->GetOrientation() != aExisting->GetOrientation() )
2224 aNew->SetOrientation( aExisting->GetOrientation() );
2225
2226 aNew->SetLocked( aExisting->IsLocked() );
2227
2228 // Now transfer the net info from "old" pads to the new footprint
2229 for( PAD* pad : aNew->Pads() )
2230 {
2231 PAD* pad_model = nullptr;
2232
2233 // Pads with no copper are never connected to a net
2234 if( !pad->IsOnCopperLayer() )
2235 {
2236 pad->SetNetCode( NETINFO_LIST::UNCONNECTED );
2237 continue;
2238 }
2239
2240 // Pads with no numbers are never connected to a net
2241 if( pad->GetNumber().IsEmpty() )
2242 {
2243 pad->SetNetCode( NETINFO_LIST::UNCONNECTED );
2244 continue;
2245 }
2246
2247 // Search for a similar pad on a copper layer, to reuse net info
2248 PAD* last_pad = nullptr;
2249
2250 while( true )
2251 {
2252 pad_model = aExisting->FindPadByNumber( pad->GetNumber(), last_pad );
2253
2254 if( !pad_model )
2255 break;
2256
2257 if( pad_model->IsOnCopperLayer() ) // a candidate is found
2258 break;
2259
2260 last_pad = pad_model;
2261 }
2262
2263 if( pad_model )
2264 {
2265 pad->SetLocalRatsnestVisible( pad_model->GetLocalRatsnestVisible() );
2266 pad->SetPinFunction( pad_model->GetPinFunction() );
2267 pad->SetPinType( pad_model->GetPinType() );
2268 }
2269
2270 pad->SetNetCode( pad_model ? pad_model->GetNetCode() : NETINFO_LIST::UNCONNECTED );
2271 }
2272
2273 for( BOARD_ITEM* item : aExisting->GraphicalItems() )
2274 {
2275 PCB_TEXT* srcItem = dynamic_cast<PCB_TEXT*>( item );
2276
2277 if( srcItem )
2278 {
2279 PCB_TEXT* destItem = getMatchingTextItem( srcItem, aNew );
2280
2281 if( destItem )
2282 {
2283 processTextItem( *srcItem, *destItem, false, resetTextLayers, resetTextEffects,
2284 aUpdated );
2285 }
2286 else if( !deleteExtraTexts )
2287 {
2288 aNew->Add( new PCB_TEXT( *srcItem ) );
2289 }
2290 }
2291 }
2292
2293 // Copy reference. The initial text is always used, never resetted
2294 processTextItem( aExisting->Reference(), aNew->Reference(),
2295 false,
2296 resetTextLayers, resetTextEffects, aUpdated );
2297
2298 // Copy value
2299 processTextItem( aExisting->Value(), aNew->Value(),
2300 // reset value text only when it is a proxy for the footprint ID
2301 // (cf replacing value "MountingHole-2.5mm" with "MountingHole-4.0mm")
2302 aExisting->GetValue() == aExisting->GetFPID().GetLibItemName(),
2303 resetTextLayers, resetTextEffects, aUpdated );
2304
2305 // Copy fields in accordance with the reset* flags
2306 for( PCB_FIELD* field : aExisting->GetFields() )
2307 {
2308 // Reference and value are already handled
2309 if( field->IsReference() || field->IsValue() )
2310 continue;
2311
2312 PCB_FIELD* newField = aNew->GetFieldByName( field->GetName() );
2313
2314 if( !newField )
2315 {
2316 newField = new PCB_FIELD( *field );
2317 aNew->Add( newField );
2318 processTextItem( *field, *newField, true, true, true, aUpdated );
2319 }
2320 else
2321 {
2322 processTextItem( *field, *newField, false, resetTextLayers, resetTextEffects, aUpdated );
2323 }
2324
2325 }
2326
2327 if( resetFabricationAttrs )
2328 {
2329 // We've replaced the existing footprint with the library one, so the fabrication attrs
2330 // are already reset.
2331 //
2332 // We only have to do anything if resetFabricationAttrs is *not* set....
2333 }
2334 else
2335 {
2336 // Careful; allow-soldermask-bridges is in the m_attributes field but is not presented
2337 // as a fabrication attribute in the GUI....
2338 int libraryFlagsToKeep = aNew->GetAttributes() & FP_ALLOW_SOLDERMASK_BRIDGES;
2339 int existingFlagsToKeep = aExisting->GetAttributes() & ~FP_ALLOW_SOLDERMASK_BRIDGES;
2340 aNew->SetAttributes( existingFlagsToKeep | libraryFlagsToKeep );
2341 }
2342
2343 if( reset3DModels )
2344 {
2345 // We've replaced the existing footprint with the library one, so the 3D models are
2346 // already reset.
2347 //
2348 // We only have to do anything if reset3DModels is *not* set....
2349 }
2350 else
2351 {
2352 aNew->Models() = aExisting->Models(); // Linked list of 3D models.
2353 }
2354
2355 // Updating other parameters
2356 const_cast<KIID&>( aNew->m_Uuid ) = aExisting->m_Uuid;
2357 aNew->SetPath( aExisting->GetPath() );
2358
2359 aCommit.Remove( aExisting );
2360 aCommit.Add( aNew );
2361
2362 aNew->ClearFlags();
2363}
2364
2365
2366void PCB_EDIT_FRAME::CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged )
2367{
2368 PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
2369
2371
2372 SetElementVisibility( LAYER_RATSNEST, GetPcbNewSettings()->m_Display.m_ShowGlobalRatsnest );
2373
2375
2376 // Netclass definitions could have changed, either by us or by Eeschema, so we need to
2377 // recompile the implicit rules
2378 DRC_TOOL* drcTool = m_toolManager->GetTool<DRC_TOOL>();
2379 WX_INFOBAR* infobar = GetInfoBar();
2380
2381 try
2382 {
2383 drcTool->GetDRCEngine()->InitEngine( GetDesignRulesPath() );
2384
2385 if( infobar->GetMessageType() == WX_INFOBAR::MESSAGE_TYPE::DRC_RULES_ERROR )
2386 infobar->Dismiss();
2387 }
2388 catch( PARSE_ERROR& )
2389 {
2390 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, _( "Edit design rules" ),
2391 wxEmptyString );
2392
2393 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
2394 [&]( wxHyperlinkEvent& aEvent )
2395 {
2396 ShowBoardSetupDialog( _( "Custom Rules" ) );
2397 } ) );
2398
2399 infobar->RemoveAllButtons();
2400 infobar->AddButton( button );
2401 infobar->AddCloseButton();
2402 infobar->ShowMessage( _( "Could not compile custom design rules." ), wxICON_ERROR,
2404 }
2405
2408
2409 // Update the environment variables in the Python interpreter
2410 if( aEnvVarsChanged )
2412
2413 Layout();
2414 SendSizeEvent();
2415}
2416
2417
2419{
2421}
2422
2423
2425{
2427}
2428
2429
2430bool ExportBoardToHyperlynx( BOARD* aBoard, const wxFileName& aPath );
2431
2432
2433void PCB_EDIT_FRAME::OnExportHyperlynx( wxCommandEvent& event )
2434{
2435 wxString wildcard = wxT( "*.hyp" );
2436 wxFileName fn = GetBoard()->GetFileName();
2437
2438 fn.SetExt( wxT("hyp") );
2439
2440 wxFileDialog dlg( this, _( "Export Hyperlynx Layout" ), fn.GetPath(), fn.GetFullName(),
2441 wildcard, wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
2442
2443 if( dlg.ShowModal() != wxID_OK )
2444 return;
2445
2446 fn = dlg.GetPath();
2447
2448 // always enforce filename extension, user may not have entered it.
2449 fn.SetExt( wxT( "hyp" ) );
2450
2452}
2453
2454
2456{
2457 return GetBoard()->GetFileName();
2458}
2459
2460
2462{
2463 return m_auimgr.GetPane( wxS( "LayersManager" ) ).IsShown();
2464}
2465
2466
2468{
2469 return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
2470}
2471
2472
2473void PCB_EDIT_FRAME::onSize( wxSizeEvent& aEvent )
2474{
2475 if( IsShownOnScreen() )
2476 {
2477 // We only need this until the frame is done resizing and the final client size is
2478 // established.
2479 Unbind( wxEVT_SIZE, &PCB_EDIT_FRAME::onSize, this );
2481 }
2482
2483 // Skip() is called in the base class.
2484 EDA_DRAW_FRAME::OnSize( aEvent );
2485}
2486
2487
2489{
2492 _( "Violation Report" ) );
2493
2494 return m_inspectDrcErrorDlg;
2495}
2496
2497
2499{
2502 _( "Clearance Report" ) );
2503
2504 return m_inspectClearanceDlg;
2505}
2506
2507
2509{
2512 _( "Constraints Report" ) );
2513
2515}
2516
2517
2519{
2520 if( !m_footprintDiffDlg )
2522 _( "Diff Footprint with Library" ) );
2523
2524 return m_footprintDiffDlg;
2525}
2526
2527
2529{
2530 if( m_inspectDrcErrorDlg && aEvent.GetString() == INSPECT_DRC_ERROR_DIALOG_NAME )
2531 {
2532 m_inspectDrcErrorDlg->Destroy();
2533 m_inspectDrcErrorDlg = nullptr;
2534 }
2535 else if( m_inspectClearanceDlg && aEvent.GetString() == INSPECT_CLEARANCE_DIALOG_NAME )
2536 {
2537 m_inspectClearanceDlg->Destroy();
2538 m_inspectClearanceDlg = nullptr;
2539 }
2540 else if( m_inspectConstraintsDlg && aEvent.GetString() == INSPECT_CONSTRAINTS_DIALOG_NAME )
2541 {
2542 m_inspectConstraintsDlg->Destroy();
2543 m_inspectConstraintsDlg = nullptr;
2544 }
2545 else if( m_footprintDiffDlg && aEvent.GetString() == INSPECT_CONSTRAINTS_DIALOG_NAME )
2546 {
2547 m_footprintDiffDlg->Destroy();
2548 m_footprintDiffDlg = nullptr;
2549 }
2550}
2551
2552
2554{
2555 if( !m_netInspectorDlg )
2556 {
2559 }
2560
2561 return m_netInspectorDlg;
2562}
2563
2564
2565void PCB_EDIT_FRAME::onCloseNetInspectorDialog( wxCommandEvent& aEvent )
2566{
2567 if( m_netInspectorDlg )
2568 {
2570 m_netInspectorDlg->Destroy();
2571 m_netInspectorDlg = nullptr;
2572 }
2573}
2574
2575
2576void PCB_EDIT_FRAME::onUnitsChanged( wxCommandEvent& aEvent )
2577{
2578 wxCommandEvent evt( EDA_EVT_UNITS_CHANGED );
2579
2580 if( m_netInspectorDlg )
2581 m_netInspectorDlg->HandleWindowEvent( evt );
2582}
Class PCBNEW_ACTION_PLUGINS.
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:109
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:104
@ icon_pcbnew_32
@ icon_pcbnew_16
static TOOL_ACTION toggleGrid
Definition: actions.h:148
static TOOL_ACTION paste
Definition: actions.h:69
static TOOL_ACTION millimetersUnits
Definition: actions.h:156
static TOOL_ACTION unselectAll
Definition: actions.h:72
static TOOL_ACTION togglePolarCoords
Definition: actions.h:159
static TOOL_ACTION copy
Definition: actions.h:68
static TOOL_ACTION pasteSpecial
Definition: actions.h:70
static TOOL_ACTION milsUnits
Definition: actions.h:155
static TOOL_ACTION toggleBoundingBoxes
Definition: actions.h:111
static TOOL_ACTION showSearch
Definition: actions.h:78
static TOOL_ACTION undo
Definition: actions.h:65
static TOOL_ACTION duplicate
Definition: actions.h:73
static TOOL_ACTION inchesUnits
Definition: actions.h:154
static TOOL_ACTION highContrastMode
Definition: actions.h:109
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:108
static TOOL_ACTION measureTool
Definition: actions.h:164
static TOOL_ACTION doDelete
Definition: actions.h:74
static TOOL_ACTION selectionTool
Definition: actions.h:163
static TOOL_ACTION save
Definition: actions.h:51
static TOOL_ACTION zoomFitScreen
Definition: actions.h:100
static TOOL_ACTION redo
Definition: actions.h:66
static TOOL_ACTION deleteTool
Definition: actions.h:75
static TOOL_ACTION zoomTool
Definition: actions.h:103
static TOOL_ACTION showProperties
Definition: actions.h:177
static TOOL_ACTION cut
Definition: actions.h:67
static TOOL_ACTION gridSetOrigin
Definition: actions.h:145
static TOOL_ACTION toggleGridOverrides
Definition: actions.h:149
static TOOL_ACTION selectAll
Definition: actions.h:71
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
void ApplyLayerPreset(const wxString &aPresetName)
int GetTabIndex() const
Set the current notebook tab.
void UpdateDisplayOptions()
Return a list of the layer presets created by the user.
void OnColorThemeChanged()
Respond to change in OS's DarkMode.
void OnLanguageChanged()
Update the panel contents from the application and board models.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
Tool responsible for automagic placement of components.
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
int GetPageCount() const
Definition: base_screen.h:72
bool IsContentModified() const
Definition: base_screen.h:60
const wxString & GetPageNumber() const
Definition: base_screen.cpp:71
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
bool GetLocalRatsnestVisible() const
Container for design settings for a BOARD object.
std::set< wxString > m_DrcExclusions
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:77
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:225
virtual void SetLocked(bool aLocked)
Definition: board_item.h:299
PCB_GROUP * GetParentGroup() const
Definition: board_item.h:91
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
Definition: board_item.h:290
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:259
VECTOR2I GetFPRelativePosition() const
Definition: board_item.cpp:261
void SetFPRelativePosition(const VECTOR2I &aPos)
Definition: board_item.cpp:275
virtual bool IsLocked() const
Definition: board_item.cpp:73
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:276
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:649
void BuildListOfNets()
Definition: board.h:790
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:715
void RemoveAllListeners()
Remove all listeners.
Definition: board.cpp:2295
const PAGE_INFO & GetPageSettings() const
Definition: board.h:649
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
Definition: board.cpp:709
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:182
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition: board.cpp:1775
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:655
const std::map< wxString, wxString > & GetProperties() const
Definition: board.h:348
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
Definition: board.cpp:192
const wxString & GetFileName() const
Definition: board.h:313
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
Definition: board.cpp:721
void ClearProject()
Definition: board.cpp:231
PROJECT * GetProject() const
Definition: board.h:457
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:766
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
Definition: board.cpp:289
void SetColor(int aLayer, const COLOR4D &aColor)
COLOR4D GetColor(int aLayer) const
COMMIT & Remove(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been removed.
Definition: commit.h:90
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
Definition: commit.h:78
Handle actions that are shared between different applications.
Handles action that are shared between different applications.
Definition: common_tools.h:38
static std::mutex g_Mutex
void SetCallback(std::function< void(BOARD_ITEM *)> aCallback)
Function to be called on each found event.
Definition: dialog_find.h:63
bool Show(bool show=true) override
The Show method is overridden to make the search combobox focused by default.
void Preload(const wxString &aFindString)
Definition: dialog_find.cpp:98
void FindNext(bool reverse)
Finds the next item.
Definition: dialog_find.h:71
enum FP_PROPS_RETVALUE GetReturnValue()
A dialog to set the plot options and create plot files in various formats.
Definition: dialog_plot.h:40
int ShowQuasiModal()
Tool responsible for drawing graphical elements like lines, arcs, circles, etc.
Definition: drawing_tool.h:55
MODE GetDrawingMode() const
Return the current drawing mode of the DRAWING_TOOL or MODE::NONE if not currently in any drawing mod...
std::shared_ptr< DRC_ENGINE > GetDRCEngine()
Definition: drc_tool.h:78
bool IsDRCRunning() const
Check to see if the DRC engine is running the tests.
Definition: drc_tool.h:71
void SetSheetPath(const std::string &aSheetPath)
Set the sheet path displayed in the title block.
void SetSheetCount(int aSheetCount)
Changes the sheet-count number displayed in the title block.
void SetPageNumber(const std::string &aPageNumber)
Changes the page number displayed in the title block.
void SetSheetName(const std::string &aSheetName)
Set the sheet name displayed in the title block.
void SetIsFirstPage(bool aIsFirstPage)
Change if this is first page.
void SetFileName(const std::string &aFileName)
Set the file name displayed in the title block.
void 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
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
virtual void OnSize(wxSizeEvent &aEvent)
virtual bool canCloseWindow(wxCloseEvent &aCloseEvent)
static wxString GetAutoSaveFilePrefix()
virtual int GetUndoCommandCount() const
WX_INFOBAR * GetInfoBar()
virtual wxString GetFullScreenDesc() const
void OnSelectGrid(wxCommandEvent &event)
Command event handler for selecting grid sizes.
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes 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.
SEARCH_PANE * m_searchPane
PROPERTIES_PANEL * m_propertiesPanel
static constexpr GAL_TYPE GAL_FALLBACK
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
void ForceRefresh()
Force a redraw.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void SetFocus() override
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
const KIID m_Uuid
Definition: eda_item.h:482
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:125
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:100
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:80
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:131
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:95
virtual bool IsVisible() const
Definition: eda_text.h:147
void SetAttributes(const EDA_TEXT &aSrc, bool aSetPosition=true)
Set the text attributes from another instance.
Definition: eda_text.cpp:276
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition: eda_text.h:160
virtual void SetVisible(bool aVisible)
Definition: eda_text.cpp:229
GR_TEXT_V_ALIGN_T GetVertJustify() const
Definition: eda_text.h:163
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:183
int GetTextThickness() const
Definition: eda_text.h:123
VECTOR2I GetTextSize() const
Definition: eda_text.h:218
SELECTION_CONDITION NoActiveTool()
Create a functor testing if there are no tools active in the frame.
SELECTION_CONDITION BoundingBoxes()
SELECTION_CONDITION RedoAvailable()
Create a functor that tests if there are any items in the redo queue.
SELECTION_CONDITION ScriptingConsoleVisible()
Create a functor testing if the python scripting console window is visible.
SELECTION_CONDITION Units(EDA_UNITS aUnit)
Create a functor that tests if the frame has the specified units.
SELECTION_CONDITION GridVisible()
Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION PolarCoordinates()
Create a functor testing if polar coordinates are current being used.
SELECTION_CONDITION GridOverrides()
Create a functor testing if the grid overrides wires is enabled in a frame.
SELECTION_CONDITION FullscreenCursor()
Create a functor testing if the cursor is full screen in a frame.
The interactive edit tool.
Definition: edit_tool.h:55
ENUM_MAP & Map(T aValue, const wxString &aName)
Definition: property.h:646
static ENUM_MAP< T > & Instance()
Definition: property.h:640
ENUM_MAP & Undefined(T aValue)
Definition: property.h:653
wxPGChoices & Choices()
Definition: property.h:689
Component library viewer main window.
void SetPosition(const VECTOR2I &aPos) override
Definition: footprint.cpp:1997
void SetLocked(bool isLocked) override
Set the #MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: footprint.h:375
EDA_ANGLE GetOrientation() const
Definition: footprint.h:209
void SetOrientation(const EDA_ANGLE &aNewAngle)
Definition: footprint.cpp:2069
PCB_FIELD * GetFieldByName(const wxString &aFieldName)
Return a field in this symbol.
Definition: footprint.cpp:294
void SetPath(const KIID_PATH &aPath)
Definition: footprint.h:243
void SetAttributes(int aAttributes)
Definition: footprint.h:278
PCB_FIELD & Value()
read/write accessors:
Definition: footprint.h:592
int GetAttributes() const
Definition: footprint.h:277
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: footprint.h:218
PADS & Pads()
Definition: footprint.h:188
const LIB_ID & GetFPID() const
Definition: footprint.h:230
bool IsLocked() const override
Definition: footprint.h:365
void GetFields(std::vector< PCB_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with PCB_TEXTs.
Definition: footprint.cpp:321
PCB_FIELD & Reference()
Definition: footprint.h:593
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
Removes an item from the container.
Definition: footprint.cpp:724
std::vector< FP_3DMODEL > & Models()
Definition: footprint.h:202
void Flip(const VECTOR2I &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: footprint.cpp:1937
const wxString & GetValue() const
Definition: footprint.h:578
const KIID_PATH & GetPath() const
Definition: footprint.h:242
VECTOR2I GetPosition() const override
Definition: footprint.h:206
DRAWINGS & GraphicalItems()
Definition: footprint.h:191
PAD * FindPadByNumber(const wxString &aPadNumber, PAD *aSearchAfterMe=nullptr) const
Return a PAD with a matching number.
Definition: footprint.cpp:1496
void ReadWindowSettings(WINDOW_SETTINGS &aCfg)
Read GAL config options from application-level config.
bool Contains(GAL_LAYER_ID aPos)
Definition: layer_ids.h:334
Handle actions specific to filling copper zones.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
virtual const wxString Problem() const
what was the problem?
Definition: exceptions.cpp:46
virtual const wxString Where() const
where did the Problem() occur?
Definition: exceptions.cpp:40
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:95
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: pcb_view.cpp:77
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
const std::set< int > & GetHighlightNetCodes() const
Return the netcode of currently highlighted net.
An abstract base class for deriving all objects that can be added to a VIEW.
Definition: view_item.h:84
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
double GetScale() const
Definition: view.h:271
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:1618
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition: view.h:395
bool IsMirroredX() const
Return true if view is flipped across the X axis.
Definition: view.h:245
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition: view.cpp:1500
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:215
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:619
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:1510
An implementation of class VIEW_CONTROLS for wxWidgets library.
std::unique_ptr< PROF_COUNTER > m_MotionEventCounter
Definition: kiid.h:49
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:67
virtual bool OpenProjectFiles(const std::vector< wxString > &aFileList, int aCtl=0)
Open a project or set of files given by aFileList.
Definition: kiway_player.h:115
void OnSockRequestServer(wxSocketEvent &evt)
Definition: eda_dde.cpp:99
void OnSockRequest(wxSocketEvent &evt)
Definition: eda_dde.cpp:69
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
void OnKiCadExit()
Definition: kiway.cpp:737
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
Definition: kiway.cpp:637
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:432
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:553
int SetLayerSelection(int layer)
const UTF8 & GetLibItemName() const
Definition: lib_id.h:102
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition: layer_ids.h:513
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:556
static LSET AllLayersMask()
Definition: lset.cpp:817
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:418
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:89
@ MARKER_DRAWING_SHEET
Definition: marker_base.h:55
Tool responsible for adding microwave features to PCBs.
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
Definition: netinfo.h:370
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
Definition: pcb_netlist.h:223
Tool relating to pads and pad settings.
Definition: pad_tool.h:37
Definition: pad.h:59
const wxString & GetPinType() const
Definition: pad.h:148
const wxString & GetPinFunction() const
Definition: pad.h:142
bool IsOnCopperLayer() const override
Definition: pad.cpp:776
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:58
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:50
static TOOL_ACTION toggleHV45Mode
Definition: pcb_actions.h:513
static TOOL_ACTION drawRuleArea
Definition: pcb_actions.h:214
static TOOL_ACTION microwaveCreateGap
Definition: pcb_actions.h:502
static TOOL_ACTION placeText
Definition: pcb_actions.h:201
static TOOL_ACTION pointEditorArcKeepCenter
Definition: pcb_actions.h:288
static TOOL_ACTION drawOrthogonalDimension
Definition: pcb_actions.h:210
static TOOL_ACTION drawRectangle
Definition: pcb_actions.h:197
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:323
static TOOL_ACTION placeReferenceImage
Definition: pcb_actions.h:200
static TOOL_ACTION showRatsnest
Definition: pcb_actions.h:318
static TOOL_ACTION showLayersManager
Definition: pcb_actions.h:437
static TOOL_ACTION toggleNetHighlight
Definition: pcb_actions.h:549
static TOOL_ACTION drawCircle
Definition: pcb_actions.h:198
static TOOL_ACTION routeDiffPair
Activation of the Push and Shove router (differential pair mode)
Definition: pcb_actions.h:245
static TOOL_ACTION layerChanged
Definition: pcb_actions.h:374
static TOOL_ACTION ddAppendBoard
Drag and drop.
Definition: pcb_actions.h:578
static TOOL_ACTION highlightNet
Definition: pcb_actions.h:547
static TOOL_ACTION drawTextBox
Definition: pcb_actions.h:202
static TOOL_ACTION routerHighlightMode
Actions to enable switching modes via hotkey assignments.
Definition: pcb_actions.h:263
static TOOL_ACTION routerWalkaroundMode
Definition: pcb_actions.h:265
static TOOL_ACTION routerShoveMode
Definition: pcb_actions.h:264
static TOOL_ACTION drawZoneCutout
Definition: pcb_actions.h:215
static TOOL_ACTION drawPolygon
Definition: pcb_actions.h:196
static TOOL_ACTION hideNetInRatsnest
Definition: pcb_actions.h:554
static TOOL_ACTION group
Definition: pcb_actions.h:521
static TOOL_ACTION zoneDisplayFilled
Definition: pcb_actions.h:325
static TOOL_ACTION showNetInRatsnest
Definition: pcb_actions.h:555
static TOOL_ACTION drawRadialDimension
Definition: pcb_actions.h:209
static TOOL_ACTION viaDisplayMode
Definition: pcb_actions.h:324
static TOOL_ACTION drawLeader
Definition: pcb_actions.h:211
static TOOL_ACTION drillOrigin
Definition: pcb_actions.h:531
static TOOL_ACTION tuneSkew
Definition: pcb_actions.h:248
static TOOL_ACTION trackDisplayMode
Definition: pcb_actions.h:322
static TOOL_ACTION microwaveCreateStubArc
Definition: pcb_actions.h:506
static TOOL_ACTION zoneDisplayTriangulated
Definition: pcb_actions.h:328
static TOOL_ACTION ungroup
Definition: pcb_actions.h:522
static TOOL_ACTION selectUnconnected
Select unconnected footprints from ratsnest of selection.
Definition: pcb_actions.h:102
static TOOL_ACTION zoneDisplayFractured
Definition: pcb_actions.h:327
static TOOL_ACTION drawVia
Definition: pcb_actions.h:213
static TOOL_ACTION drawArc
Definition: pcb_actions.h:199
static TOOL_ACTION zoneDuplicate
Duplicate zone onto another layer.
Definition: pcb_actions.h:397
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
Definition: pcb_actions.h:485
static TOOL_ACTION pluginsReload
Scripting Actions.
Definition: pcb_actions.h:400
static TOOL_ACTION tuneLength
Definition: pcb_actions.h:247
static TOOL_ACTION drawSimilarZone
Definition: pcb_actions.h:216
static TOOL_ACTION pointEditorArcKeepEndpoint
Definition: pcb_actions.h:289
static TOOL_ACTION drawCenterDimension
Definition: pcb_actions.h:208
static TOOL_ACTION selectSameSheet
Select all components on the same sheet as the selected footprint.
Definition: pcb_actions.h:111
static TOOL_ACTION microwaveCreateStub
Definition: pcb_actions.h:504
static TOOL_ACTION selectNet
Select all connections belonging to a single net.
Definition: pcb_actions.h:96
static TOOL_ACTION microwaveCreateLine
Definition: pcb_actions.h:510
static TOOL_ACTION flipBoard
Definition: pcb_actions.h:376
static TOOL_ACTION zoneDisplayOutline
Definition: pcb_actions.h:326
static TOOL_ACTION ratsnestLineMode
Definition: pcb_actions.h:319
static TOOL_ACTION textOutlines
Display texts as lines.
Definition: pcb_actions.h:488
static TOOL_ACTION highlightNetSelection
Definition: pcb_actions.h:550
static TOOL_ACTION microwaveCreateFunctionShape
Definition: pcb_actions.h:508
static TOOL_ACTION zoneMerge
Definition: pcb_actions.h:394
static TOOL_ACTION unlock
Definition: pcb_actions.h:518
static TOOL_ACTION placeFootprint
Definition: pcb_actions.h:219
static TOOL_ACTION routeSingleTrack
Activation of the Push and Shove router.
Definition: pcb_actions.h:242
static TOOL_ACTION deselectNet
Remove all connections belonging to a single net from the active selection.
Definition: pcb_actions.h:99
static TOOL_ACTION showPythonConsole
Definition: pcb_actions.h:438
static TOOL_ACTION drawLine
Definition: pcb_actions.h:195
static TOOL_ACTION localRatsnestTool
Definition: pcb_actions.h:556
static TOOL_ACTION drawAlignedDimension
Definition: pcb_actions.h:207
static TOOL_ACTION drawZone
Definition: pcb_actions.h:212
static TOOL_ACTION selectOnSchematic
Select symbols/pins on schematic corresponding to selected footprints/pads.
Definition: pcb_actions.h:114
static TOOL_ACTION lock
Definition: pcb_actions.h:517
Common, abstract interface for edit frames.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
void doCloseWindow() override
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
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.
APPEARANCE_CONTROLS * GetAppearancePanel()
APPEARANCE_CONTROLS * m_appearancePanel
PANEL_SELECTION_FILTER * m_selectionFilterPanel
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
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.
void RemoveBoardChangeListener(wxEvtHandler *aListener)
Remove aListener to from the board changed listener list.
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual PCB_LAYER_ID GetActiveLayer() const
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project.
void AddBoardChangeListener(wxEvtHandler *aListener)
Add aListener to post #EDA_EVT_BOARD_CHANGED command events to.
virtual void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings)
void PlaceFootprint(FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
Places aFootprint at the current cursor position and updates footprint coordinates with the new posit...
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
Handle actions that are shared between different frames in PcbNew.
Definition: pcb_control.h:47
double m_ZoneOpacity
Opacity override for filled zone areas.
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
void UpdateColors()
Update the color settings in the painter and GAL.
void SetDrawingSheet(DS_PROXY_VIEW_ITEM *aDrawingSheet)
Sets (or updates) drawing-sheet used by the draw panel.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void SyncLayersVisibility(const BOARD *aBoard)
Update "visibility" property of each layer of a given BOARD.
virtual void SetHighContrastLayer(int aLayer) override
SetHighContrastLayer(), with some extra smarts for PCB.
Group generic conditions for PCB editor states.
SELECTION_CONDITION PadFillDisplay()
Create a functor that tests if the frame fills the pads.
SELECTION_CONDITION TrackFillDisplay()
Create a functor that tests if the frame fills tracks.
SELECTION_CONDITION HasItems()
Create a functor that tests if there are items in the board.
SELECTION_CONDITION GraphicsFillDisplay()
Create a functor that tests if the frame fills graphics items.
SELECTION_CONDITION ZoneDisplayMode(ZONE_DISPLAY_MODE aMode)
Create a functor that tests the current zone display mode in the frame.
SELECTION_CONDITION ViaFillDisplay()
Create a functor that tests if the frame fills vias.
SELECTION_CONDITION Get45degMode()
Create a functor that tests whether only 45 degree lines should be allowed.
SELECTION_CONDITION TextFillDisplay()
Create a functor that tests if the frame fills text items.
The main frame for Pcbnew.
void HardRedraw() override
Rebuild the GAL and redraws the screen.
void OnDisplayOptionsChanged() override
void ShowBoardSetupDialog(const wxString &aInitialPage=wxEmptyString)
void SetLastPath(LAST_PATH_TYPE aType, const wxString &aLastPath)
Set the path of the last file successfully read.
void FindNext(bool reverse=false)
Find the next item using our existing search parameters.
void ResolveDRCExclusions(bool aCreateMarkers)
If aCreateMarkers then create DRC exclusion markers from the serialized data.
void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void SetActiveLayer(PCB_LAYER_ID aLayer) override
Change the currently active layer to aLayer and also update the APPEARANCE_CONTROLS.
void OnModify() override
Must be called after a board change to set the modified flag.
void ThemeChanged() override
Called when light/dark theme is changed.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void RecordDRCExclusions()
Scan existing markers and record data from any that are Excluded.
void SetElementVisibility(GAL_LAYER_ID aElement, bool aNewState)
Change the visibility of an element category.
DIALOG_BOOK_REPORTER * m_inspectDrcErrorDlg
void OnClearFileHistory(wxCommandEvent &aEvent)
void onUnitsChanged(wxCommandEvent &aEvent)
virtual ~PCB_EDIT_FRAME()
void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
Switch currently used canvas (Cairo / OpenGL).
BOARD_ITEM_CONTAINER * GetModel() const override
DIALOG_BOOK_REPORTER * GetInspectDrcErrorDialog()
void OnExportSTEP(wxCommandEvent &event)
Export the current BOARD to a STEP assembly.
DIALOG_FIND * m_findDialog
DIALOG_BOOK_REPORTER * m_inspectConstraintsDlg
void SetPageSettings(const PAGE_INFO &aPageSettings) override
bool IsElementVisible(GAL_LAYER_ID aElement) const
Test whether a given element category is visible.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
void onBoardLoaded()
Update the state of the GUI after a new board is loaded or created.
void SetGridColor(const COLOR4D &aColor) override
void ProjectChanged() override
Notification event that the project has changed.
wxString GetLastPath(LAST_PATH_TYPE aType)
Get the last path for a particular type.
void OnExportIDF3(wxCommandEvent &event)
Export the current BOARD to a IDFv3 board and lib files.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
void doCloseWindow() override
void ReCreateLayerBox(bool aForceResizeToolbar=true)
Recreate the layer box by clearing the old list and building a new one from the new layer names and c...
void SaveProjectLocalSettings() override
Save changes to the project local settings.
void PythonSyncProjectName()
Synchronize the project name from KiCad's environment into the Python interpreter.
bool m_show_layer_manager_tools
void OnExportVRML(wxCommandEvent &event)
Export the current BOARD to a VRML file.
void ShowFindDialog()
Show the Find dialog.
void onSize(wxSizeEvent &aEvent)
int ShowExchangeFootprintsDialog(FOOTPRINT *aFootprint, bool aUpdateMode, bool aSelectedMode)
void onCloseNetInspectorDialog(wxCommandEvent &aEvent)
int TestStandalone()
Test if standalone mode.
void ShowFootprintPropertiesDialog(FOOTPRINT *aFootprint)
void OnExportHyperlynx(wxCommandEvent &event)
Export the current BOARD to a Hyperlynx HYP file.
bool IsContentModified() const override
Get if the current board has been modified but not saved.
void PythonSyncEnvironmentVariables()
Synchronize the environment variables from KiCad's environment into the Python interpreter.
bool Clear_Pcb(bool doAskAboutUnsavedChanges, bool aFinal=false)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:40
DIALOG_NET_INSPECTOR * GetNetInspectorDialog()
TOOL_ACTION * m_exportNetlistAction
The export board netlist tool action object.
void ReCreateAuxiliaryToolbar() override
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.
void ExportSVG(wxCommandEvent &event)
Show the Export to SVG file dialog.
void RecreateCmpFileFromBoard(wxCommandEvent &aEvent)
Recreates a .cmp file from the current loaded board.
DIALOG_BOOK_REPORTER * GetFootprintDiffDialog()
EDA_ANGLE GetRotationAngle() const override
Return the angle used for rotate operations.
COLOR4D GetGridColor() override
void Files_io(wxCommandEvent &event)
Call Files_io_from_id with the wxCommandEvent id.
void UpdateTitle()
Set the main window title bar text.
DIALOG_BOOK_REPORTER * m_footprintDiffDlg
void ExchangeFootprint(FOOTPRINT *aExisting, FOOTPRINT *aNew, BOARD_COMMIT &aCommit, bool deleteExtraTexts=true, bool resetTextLayers=true, bool resetTextEffects=true, bool resetFabricationAttrs=true, bool reset3DModels=true, bool *aUpdated=nullptr)
Replace aExisting footprint by aNew footprint using the Existing footprint settings (position,...
PCB_LAYER_BOX_SELECTOR * m_SelLayerBox
void ExportToGenCAD(wxCommandEvent &event)
Create a file in GenCAD 1.4 format from the current board.
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Called after the preferences dialog is run.
void Process_Special_Functions(wxCommandEvent &event)
Definition: edit.cpp:51
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
void OnQuit(wxCommandEvent &event)
void onCloseModelessBookReporterDialogs(wxCommandEvent &aEvent)
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
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.
void redrawNetnames(wxTimerEvent &aEvent)
static const wxString SearchPaneName()
DIALOG_BOOK_REPORTER * m_inspectClearanceDlg
DIALOG_NET_INSPECTOR * m_netInspectorDlg
void OnFileHistory(wxCommandEvent &event)
void ToPlotter(int aID)
Open a dialog frame to create plot and drill files relative to the current board.
DIALOG_BOOK_REPORTER * GetInspectConstraintsDialog()
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:51
virtual bool RemoveItem(BOARD_ITEM *aItem)
Remove item from group.
Definition: pcb_group.cpp:94
virtual bool AddItem(BOARD_ITEM *aItem)
Add item to group.
Definition: pcb_group.cpp:79
Generic tool for picking an item.
Parameters and options when plotting/printing a board.
void SetFormat(PLOT_FORMAT aFormat)
Tool that displays edit points allowing to modify items by dragging the points.
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:
void FindItem(BOARD_ITEM *aItem)
Take necessary actions to mark an item as found.
Tool useful for viewing footprints.
The interactive edit tool.
A progress reporter interface for use in multi-threaded environments.
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:70
The project local settings are things that are attached to a particular project, but also might be pa...
wxString m_ActiveLayerPreset
The name of a LAYER_PRESET that is currently activated (or blank if none)
PCB_LAYER_ID m_ActiveLayer
The current (active) board layer for editing.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:172
void IncrementNetclassesTicker()
Definition: project.h:98
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:166
void IncrementTextVarsTicker()
Definition: project.h:95
float SplitterProportion() const
Action handler for the Properties panel.
PNS::PNS_MODE GetRouterMode()
bool RoutingInProgress()
Returns whether routing is currently active.
Tool relating to pads and pad settings.
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 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.
EDA_ITEM * Front() const
Definition: selection.h:208
int Size() const
Returns the number of selected parts.
Definition: selection.h:115
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:253
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:165
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:167
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
ACTIONS * m_actions
Definition: tools_holder.h:166
Represent a single user action.
Definition: tool_action.h:269
Base abstract interface for all kinds of tools.
Definition: tool_base.h:66
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition: tool_base.h:80
Generic, UI-independent tool event.
Definition: tool_event.h:167
void SetHasPosition(bool aHasPosition)
Returns if the action associated with this event should be treated as immediate regardless of the cur...
Definition: tool_event.h:257
Master controller class:
Definition: tool_manager.h:57
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagate an event to tools that requested events of matching type(s).
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
Definition: tool_manager.h:145
bool InvokeTool(TOOL_ID aToolId)
Call a tool by sending a tool activation event to tool of given ID.
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:289
bool PostAction(const std::string &aActionName, T aParam)
Run the specified action after the current action (coroutine) ends.
Definition: tool_manager.h:230
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
std::vector< TOOL_BASE * > Tools()
Definition: tool_manager.h:324
void RegisterTool(TOOL_BASE *aTool)
Add a tool to the manager set and sets it up.
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Set the work environment (model, view, view controls and the parent window).
void InitTools()
Initializes all registered tools.
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
A modified version of the wxInfoBar class that allows us to:
Definition: wx_infobar.h:75
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: wx_infobar.cpp:301
@ OUTDATED_SAVE
OUTDATED_SAVE Messages that should be cleared on save.
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
Definition: wx_infobar.cpp:291
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: wx_infobar.cpp:154
Handle actions specific to filling copper zones.
PROGRESS_REPORTER * GetProgressReporter()
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:280
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:240
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:305
This file is part of the common library.
#define CHECK(x)
#define ENABLE(x)
#define DIALOG_DRC_WINDOW_NAME
Definition: dialog_drc.h:41
bool InvokeExportSVG(PCB_EDIT_FRAME *aCaller, BOARD *aBoard)
Function InvokeExportSVG shows the Export SVG dialog.
#define _HKI(x)
#define _(s)
Declaration of the eda_3d_viewer class.
static constexpr EDA_ANGLE & ANGLE_90
Definition: eda_angle.h:439
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define PCB_EDIT_FRAME_NAME
GERBVIEW_FRAME::OnZipFileHistory GERBVIEW_FRAME::OnSelectDisplayMode EVT_CHOICE(ID_GBR_AUX_TOOLBAR_PCB_APERATTRIBUTES_CHOICE, GERBVIEW_FRAME::OnSelectHighlightChoice) EVT_UPDATE_UI(ID_TOOLBARH_GERBVIEW_SELECT_ACTIVE_LAYER
KiCad executable names.
const wxString EESCHEMA_EXE
bool ExportBoardToHyperlynx(BOARD *aBoard, const wxFileName &aPath)
@ FP_ALLOW_SOLDERMASK_BRIDGES
Definition: footprint.h:78
EVT_UPDATE_UI(ID_LOAD_FOOTPRINT_FROM_BOARD, FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard) EVT_UPDATE_UI(ID_ADD_FOOTPRINT_TO_BOARD
#define CURRENT_EDIT_TOOL(action)
@ FRAME_PCB_EDITOR
Definition: frame_type.h:42
@ FRAME_FOOTPRINT_VIEWER
Definition: frame_type.h:45
@ FRAME_SCH
Definition: frame_type.h:34
@ FRAME_FOOTPRINT_CHOOSER
Definition: frame_type.h:44
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:43
@ ID_MAIN_MENUBAR
Definition: gerbview_id.h:38
int ExecuteFile(const wxString &aEditorName, const wxString &aFileName, wxProcess *aCallback)
Call the executable file aEditorName with the parameter aFileName.
Definition: gestfich.cpp:120
bool m_ShowEventCounters
Shows debugging event counters in various places.
const std::string LegacyPcbFileExtension
const std::string LegacySchematicFileExtension
const std::string KiCadPcbFileExtension
const std::string KiCadSchematicFileExtension
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
@ ID_ON_GRID_SELECT
Definition: id.h:145
@ ID_GEN_PLOT_DXF
Definition: id.h:96
@ ID_FILE_LIST_CLEAR
Definition: id.h:87
@ ID_EDA_SOCKET_EVENT
Definition: id.h:163
@ ID_GEN_PLOT_PS
Definition: id.h:92
@ ID_EDA_SOCKET_EVENT_SERV
Definition: id.h:162
@ ID_GEN_PLOT_GERBER
Definition: id.h:94
@ ID_ON_ZOOM_SELECT
Definition: id.h:143
@ ID_GEN_PLOT
Definition: id.h:91
@ ID_GEN_PLOT_SVG
Definition: id.h:95
@ ID_GEN_PLOT_HPGL
Definition: id.h:93
@ ID_FILEMAX
Definition: id.h:85
@ ID_FILE1
Definition: id.h:84
@ ID_GEN_PLOT_PDF
Definition: id.h:97
@ ID_AUTO_SAVE_TIMER
Definition: id.h:79
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
PROJECT & Prj()
Definition: kicad.cpp:576
KIWAY Kiway
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
Definition: layer_ids.h:994
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:191
@ LAYER_GRID
Definition: layer_ids.h:206
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored)
Definition: layer_ids.h:232
@ LAYER_RATSNEST
Definition: layer_ids.h:205
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ F_Paste
Definition: layer_ids.h:102
@ B_Mask
Definition: layer_ids.h:107
@ B_Cu
Definition: layer_ids.h:96
@ F_Mask
Definition: layer_ids.h:108
@ B_Paste
Definition: layer_ids.h:101
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
@ F_Cu
Definition: layer_ids.h:65
@ MAIL_SCH_GET_NETLIST
Definition: mail_type.h:49
@ REPAINT
Item needs to be redrawn.
Definition: view_item.h:57
@ GEOMETRY
Position or shape has changed.
Definition: view_item.h:54
@ ALL
All except INITIAL_ADD.
Definition: view_item.h:58
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition: definitions.h:49
void SetShutdownBlockReason(wxWindow *aWindow, const wxString &aReason)
Sets the block reason why the window/application is preventing OS shutdown.
Definition: gtk/app.cpp:90
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:79
@ RM_MarkObstacles
Ignore collisions, mark obstacles.
@ RM_Walkaround
Only walk around.
@ RM_Shove
Only shove.
static void processTextItem(const PCB_TEXT &aSrc, PCB_TEXT &aDest, bool aResetText, bool aResetTextLayers, bool aResetTextEffects, bool *aUpdated)
copy text settings from aSrc to aDest
#define FOOTPRINT_DIFF_DIALOG_NAME
static PCB_TEXT * getMatchingTextItem(PCB_TEXT *aRefItem, FOOTPRINT *aFootprint)
EVT_MENU_RANGE(ID_POPUP_PCB_SELECT_WIDTH_START_RANGE, ID_POPUP_PCB_SELECT_WIDTH_END_RANGE, PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event) EVT_UPDATE_UI_RANGE(ID_POPUP_PCB_SELECT_WIDTH1
ID_POPUP_PCB_SELECT_WIDTH8
bool ExportBoardToHyperlynx(BOARD *aBoard, const wxFileName &aPath)
#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
Class to handle a set of BOARD_ITEMs.
@ ID_POPUP_PCB_SELECT_WIDTH_START_RANGE
Definition: pcbnew_id.h:25
@ ID_POPUP_PCB_SELECT_WIDTH1
Definition: pcbnew_id.h:29
@ ID_POPUP_PCB_SELECT_VIASIZE8
Definition: pcbnew_id.h:52
@ ID_GEN_EXPORT_FILE_HYPERLYNX
Definition: pcbnew_id.h:88
@ ID_IMPORT_NON_KICAD_BOARD
Definition: pcbnew_id.h:19
@ ID_MENU_RECOVER_BOARD_AUTOSAVE
Definition: pcbnew_id.h:81
@ ID_AUX_TOOLBAR_PCB_VIA_SIZE
Definition: pcbnew_id.h:22
@ ID_AUX_TOOLBAR_PCB_SELECT_AUTO_WIDTH
Definition: pcbnew_id.h:24
@ ID_PCB_GEN_CMP_FILE
Definition: pcbnew_id.h:93
@ ID_MENU_EXPORT_FOOTPRINTS_TO_NEW_LIBRARY
Definition: pcbnew_id.h:83
@ ID_POPUP_PCB_SELECT_WIDTH_END_RANGE
Definition: pcbnew_id.h:79
@ ID_MENU_EXPORT_FOOTPRINTS_TO_LIBRARY
Definition: pcbnew_id.h:82
@ ID_GEN_EXPORT_FILE_VRML
Definition: pcbnew_id.h:86
@ ID_POPUP_PCB_SELECT_VIASIZE1
Definition: pcbnew_id.h:45
@ ID_GEN_EXPORT_FILE_STEP
Definition: pcbnew_id.h:87
@ ID_TOOLBARH_PCB_SELECT_LAYER
Definition: pcbnew_id.h:96
@ ID_GEN_EXPORT_FILE_IDF3
Definition: pcbnew_id.h:85
@ ID_AUX_TOOLBAR_PCB_TRACK_WIDTH
Definition: pcbnew_id.h:23
@ ID_GEN_EXPORT_FILE_GENCADFORMAT
Definition: pcbnew_id.h:89
void ScriptingOnDestructPcbEditFrame(PCB_EDIT_FRAME *aPcbEditFrame)
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
@ SHOW_WITH_VIA_ALWAYS
see class PGM_BASE
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:39
LAST_PATH_TYPE
For storing PcbNew MRU paths of various types.
Definition: project_file.h:47
@ RPT_SEVERITY_EXCLUSION
#define SKIP_SET_DIRTY
Definition: sch_commit.h:42
#define SKIP_UNDO
Definition: sch_commit.h:40
#define CURRENT_TOOL(action)
std::function< bool(const SELECTION &)> SELECTION_CONDITION
< Functor type that checks a specific condition for selected items.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:119
const int scale
wxString UnescapeString(const wxString &aSource)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:391
const double IU_PER_MILS
Definition: base_units.h:78
A filename or source description, a problem input line, a line number, a byte offset,...
Definition: ki_exception.h:120
TRACK_CLEARANCE_MODE m_TrackClearance
@ AS_GLOBAL
Global action (toolbar/main menu event, global shortcut)
Definition: tool_action.h:48
@ AS_ACTIVE
All active tools.
Definition: tool_action.h:47
@ TA_MODEL_CHANGE
Definition: tool_event.h:120
@ TC_COMMAND
Definition: tool_event.h:56
wxLogTrace helper definitions.
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition: typeinfo.h:91
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:95
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:108
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition: typeinfo.h:105
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition: typeinfo.h:90
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:86
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:87
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:96
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:94
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.