KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint_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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2015 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 2015-2016 Wayne Stambaugh <[email protected]>
7 * Copyright (C) 1992-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 "tools/convert_tool.h"
24#include "tools/drawing_tool.h"
25#include "tools/edit_tool.h"
28#include "tools/pad_tool.h"
29#include "tools/pcb_actions.h"
30#include "tools/pcb_control.h"
37#include <bitmaps.h>
38#include <board.h>
39#include <footprint.h>
40#include <confirm.h>
43#include <footprint_info_impl.h>
44#include <footprint_tree_pane.h>
45#include <fp_lib_table.h>
47#include <kiface_base.h>
48#include <kiplatform/app.h>
49#include <kiway.h>
50#include <macros.h>
51#include <pcb_draw_panel_gal.h>
52#include <pcb_edit_frame.h>
53#include <pcbnew_id.h>
54#include <pgm_base.h>
55#include <project.h>
56#include <project_pcb.h>
58#include <tool/action_toolbar.h>
59#include <tool/common_control.h>
60#include <tool/common_tools.h>
62#include <tool/selection.h>
64#include <tool/tool_manager.h>
65#include <tool/zoom_tool.h>
68#include <tools/group_tool.h>
71#include <widgets/lib_tree.h>
76#include <wx/filedlg.h>
78
79BEGIN_EVENT_TABLE( FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME )
80 EVT_MENU( wxID_CLOSE, FOOTPRINT_EDIT_FRAME::CloseFootprintEditor )
81 EVT_MENU( wxID_EXIT, FOOTPRINT_EDIT_FRAME::OnExitKiCad )
82
84
87
89
92
93 // Horizontal toolbar
95
96 // UI update events.
98 FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard )
100 FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard )
102
103 // Drop files event
104 EVT_DROP_FILES( FOOTPRINT_EDIT_FRAME::OnDropFiles )
105
106END_EVENT_TABLE()
107
108
109FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
110 PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
111 wxDefaultPosition, wxDefaultSize,
112 KICAD_DEFAULT_DRAWFRAME_STYLE, GetFootprintEditorFrameName() ),
113 m_show_layer_manager_tools( true )
114{
115 m_showBorderAndTitleBlock = false; // true to show the frame references
116 m_aboutTitle = _HKI( "KiCad Footprint Editor" );
117 m_selLayerBox = nullptr;
118 m_editorSettings = nullptr;
119
120 // Give an icon
121 wxIcon icon;
122 wxIconBundle icon_bundle;
123
124 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 48 ) );
125 icon_bundle.AddIcon( icon );
126 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 128 ) );
127 icon_bundle.AddIcon( icon );
128 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 256 ) );
129 icon_bundle.AddIcon( icon );
130 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_32 ) );
131 icon_bundle.AddIcon( icon );
132 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_16 ) );
133 icon_bundle.AddIcon( icon );
134
135 SetIcons( icon_bundle );
136
137 // Create GAL canvas
138 m_canvasType = loadCanvasTypeSetting( GetSettings() );
139
140 PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
141 GetGalDisplayOptions(), m_canvasType );
142 SetCanvas( drawPanel );
143
144 CreateInfoBar();
145
146 SetBoard( new BOARD() );
147
148 // This board will only be used to hold a footprint for editing
150
151 // In Footprint Editor, the default net clearance is not known (it depends on the actual
152 // board). So we do not show the default clearance, by setting it to 0. The footprint or
153 // pad specific clearance will be shown.
154 GetBoard()->GetDesignSettings().m_NetSettings->m_DefaultNetClass->SetClearance( 0 );
155
156 // Don't show the default board solder mask expansion in the footprint editor. Only the
157 // footprint or pad mask expansions settings should be shown.
159
160 // Ensure all layers and items are visible:
161 // In footprint editor, some layers have no meaning or cannot be used, but we show all of
162 // them, at least to be able to edit a bad layer
164
165 GetGalDisplayOptions().m_axesEnabled = true;
166
167 // In Footprint Editor, set the default paper size to A4 for plot/print
168 SetPageSettings( PAGE_INFO( PAGE_INFO::A4 ) );
169 SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS ) ) );
170
171 // Create the manager and dispatcher & route draw panel events to the dispatcher
172 setupTools();
173 setupUIConditions();
174
175 initLibraryTree();
176 m_treePane = new FOOTPRINT_TREE_PANE( this );
177
178 // restore the last footprint from the project, if any, after the library has been init'ed
179 restoreLastFootprint();
180
181 ReCreateMenuBar();
182 ReCreateHToolbar();
183 ReCreateVToolbar();
184 ReCreateOptToolbar();
185
186 m_selectionFilterPanel = new PANEL_SELECTION_FILTER( this );
187 m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas(), true );
188 m_propertiesPanel = new PCB_PROPERTIES_PANEL( this, this );
189
190 // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
191 // parameters in m_LayersManager
192 // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
193 LoadSettings( GetSettings() );
194
195 float proportion = GetFootprintEditorSettings()->m_AuiPanels.properties_splitter;
196 m_propertiesPanel->SetSplitterProportion( proportion );
197
198 // Must be set after calling LoadSettings() to be sure these parameters are not dependent
199 // on what is read in stored settings. Enable one internal layer, because footprints
200 // support keepout areas that can be on internal layers only (therefore on the first internal
201 // layer). This is needed to handle these keepout in internal layers only.
203 GetBoard()->SetEnabledLayers( GetBoard()->GetEnabledLayers().set( In1_Cu ) );
204 GetBoard()->SetVisibleLayers( GetBoard()->GetEnabledLayers() );
205 GetBoard()->SetLayerName( In1_Cu, _( "Inner layers" ) );
206
207 SetActiveLayer( F_SilkS );
208
209 m_auimgr.SetManagedWindow( this );
210
211 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
212#if !defined( _WIN32 )
213 // Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds
214 // of graphical glitches
215 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
216#endif
217 m_auimgr.SetFlags( auiFlags );
218
219 // Rows; layers 4 - 6
220 m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
221 .Top().Layer( 6 ) );
222
223 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
224 .Bottom().Layer( 6 ) );
225
226 // Columns; layers 1 - 3
227 m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" )
228 .Left().Layer( 4 )
229 .Caption( _( "Libraries" ) )
230 .MinSize( FromDIP( 250 ), -1 ).BestSize( FromDIP( 250 ), -1 ) );
231 m_auimgr.AddPane( m_propertiesPanel, EDA_PANE().Name( PropertiesPaneName() )
232 .Left().Layer( 3 )
233 .Caption( _( "Properties" ) ).PaneBorder( false )
234 .MinSize( FromDIP( wxSize( 240, 60 ) ) ).BestSize( FromDIP( wxSize( 300, 200 ) ) ) );
235 m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
236 .Left().Layer( 2 ) );
237
238 m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
239 .Right().Layer(2) );
240 m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( "LayersManager" )
241 .Right().Layer( 3 )
242 .Caption( _( "Appearance" ) ).PaneBorder( false )
243 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
244 m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Palette().Name( "SelectionFilter" )
245 .Right().Layer( 3 ).Position( 2 )
246 .Caption( _( "Selection Filter" ) ).PaneBorder( false )
247 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
248
249 // Center
250 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
251 .Center() );
252
253 m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
254 m_auimgr.GetPane( "SelectionFilter" ).Show( m_show_layer_manager_tools );
255 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetSettings()->m_AuiPanels.show_properties );
256
257 // The selection filter doesn't need to grow in the vertical direction when docked
258 m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
259
262 DragAcceptFiles( true );
263
264 ActivateGalCanvas();
265
266 FinishAUIInitialization();
267
268 // Apply saved visibility stuff at the end
269 if( FOOTPRINT_EDITOR_SETTINGS* cfg = dynamic_cast<FOOTPRINT_EDITOR_SETTINGS*>( GetSettings() ) )
270 {
271 wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
272 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
273
274 if( cfg->m_LibWidth > 0 )
275 SetAuiPaneSize( m_auimgr, treePane, cfg->m_LibWidth, -1 );
276
277 if( cfg->m_AuiPanels.right_panel_width > 0 )
278 SetAuiPaneSize( m_auimgr, layersManager, cfg->m_AuiPanels.right_panel_width, -1 );
279
280 m_appearancePanel->SetUserLayerPresets( cfg->m_LayerPresets );
281 m_appearancePanel->ApplyLayerPreset( cfg->m_ActiveLayerPreset );
282 m_appearancePanel->SetTabIndex( cfg->m_AuiPanels.appearance_panel_tab );
283 }
284
285 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
286 UpdateTitle();
287 setupUnits( GetSettings() );
288
289 resolveCanvasType();
290
291 // Default shutdown reason until a file is loaded
292 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
293
294 // Catch unhandled accelerator command characters that were no handled by the library tree
295 // panel.
296 Bind( wxEVT_CHAR, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
297 Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
298
299 // Ensure the window is on top
300 Raise();
301 Show( true );
302
303 // Register a call to update the toolbar sizes. It can't be done immediately because
304 // it seems to require some sizes calculated that aren't yet (at least on GTK).
305 CallAfter(
306 [this]()
307 {
308 // Ensure the controls on the toolbars all are correctly sized
309 UpdateToolbarControlSizes();
310 m_treePane->FocusSearchFieldIfExists();
311 } );
312}
313
314
316{
317 // Shutdown all running tools
318 if( m_toolManager )
320
321 // save the footprint in the PROJECT
323
324 // Clear the watched file
325 setFPWatcher( nullptr );
326
328 delete m_appearancePanel;
329 delete m_treePane;
330}
331
332
334{
336
337 FOOTPRINT* fp = static_cast<FOOTPRINT*>( GetModel() );
338
339 if( fp )
340 {
341 std::vector<MSG_PANEL_ITEM> msgItems;
342 fp->GetMsgPanelInfo( this, msgItems );
343 SetMsgPanel( msgItems );
344 }
345}
346
347
349{
350 return GetScreen() && GetScreen()->IsContentModified()
352}
353
354
356{
357 return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
358}
359
360
362{
363 // switches currently used canvas (Cairo / OpenGL).
364 PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
365
366 GetCanvas()->GetGAL()->SetAxesEnabled( true );
367
368 // The base class method *does not reinit* the layers manager. We must update the layer
369 // widget to match board visibility states, both layers and render columns, and and some
370 // settings dependent on the canvas.
372}
373
374
376{
377 SyncLibraryTree( true );
379}
380
381
383{
384 wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
385 treePane.Show( !IsSearchTreeShown() );
386
387 if( IsSearchTreeShown() )
388 {
389 // SetAuiPaneSize also updates m_auimgr
391 }
392 else
393 {
394 m_editorSettings->m_LibWidth = m_treePane->GetSize().x;
395 m_auimgr.Update();
396 }
397}
398
399
401{
403 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
404 wxAuiPaneInfo& selectionFilter = m_auimgr.GetPane( "SelectionFilter" );
405
406 // show auxiliary Vertical layers and visibility manager toolbar
408 layersManager.Show( m_show_layer_manager_tools );
409 selectionFilter.Show( m_show_layer_manager_tools );
410
412 {
413 SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
414 }
415 else
416 {
417 settings->m_AuiPanels.right_panel_width = m_appearancePanel->GetSize().x;
418 m_auimgr.Update();
419 }
420}
421
422
424{
425 return const_cast<wxAuiManager&>( m_auimgr ).GetPane( m_treePane ).IsShown();
426}
427
428
430{
431 return GetBoard()->GetFirstFootprint();
432}
433
434
436{
438}
439
440
442{
444}
445
446
448{
449 LIB_ID id;
450
451 if( IsSearchTreeShown() )
452 id = GetTreeFPID();
453
454 if( id.GetLibNickname().empty() )
455 id = GetLoadedFPID();
456
457 return id;
458}
459
460
462{
463 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
464
465 if( footprint )
466 return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
467 else
468 return LIB_ID();
469}
470
471
473{
474 if( GetBoard()->GetFirstFootprint() )
475 {
478 }
479
480 GetScreen()->SetContentModified( false );
481}
482
483
485{
486 // If we've already vetted closing this window, then we have no FP anymore
487 if( m_isClosing || !GetBoard() )
488 return false;
489
490 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
491
492 return ( footprint && footprint->GetLink() != niluuid );
493}
494
495
497{
498 LIB_ID id = GetLoadedFPID();
499
500 if( id.IsValid() )
501 {
503 Prj().SetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, id.GetLibItemName() );
504 }
505}
506
507
509{
510 const wxString& footprintName = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME );
511 const wxString& libNickname = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME );
512
513 if( libNickname.Length() && footprintName.Length() )
514 {
515 LIB_ID id;
516 id.SetLibNickname( libNickname );
517 id.SetLibItemName( footprintName );
518
519 FOOTPRINT* footprint = loadFootprint( id );
520
521 if( footprint )
522 AddFootprintToBoard( footprint );
523 }
524}
525
526
528{
530
531 m_originalFootprintCopy.reset( static_cast<FOOTPRINT*>( aFootprint->Clone() ) );
532 m_originalFootprintCopy->SetParent( nullptr );
533
535
537 // Ensure item UUIDs are valid
538 // ("old" footprints can have null uuids that create issues in fp editor)
539 aFootprint->FixUuids();
540
542 {
543 wxString msg;
544 msg.Printf( _( "Editing %s from board. Saving will update the board only." ),
545 aFootprint->GetReference() );
546
547 if( WX_INFOBAR* infobar = GetInfoBar() )
548 {
549 infobar->RemoveAllButtons();
550 infobar->AddCloseButton();
551 infobar->ShowMessage( msg, wxICON_INFORMATION );
552 }
553 }
554 else
555 {
556 if( WX_INFOBAR* infobar = GetInfoBar() )
557 infobar->Dismiss();
558 }
559
561}
562
563
565{
566 ReloadFootprint( aFootprint );
567
569 setFPWatcher( nullptr );
570 else
571 setFPWatcher( aFootprint );
572}
573
574
576{
578}
579
580
582{
583 return GetBoard()->GetDesignSettings();
584}
585
586
588{
589 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
590
592}
593
594
596{
597 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
598}
599
600
602{
603 if( !m_editorSettings )
605
606 return m_editorSettings;
607}
608
609
611{
614}
615
616
618{
619 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
620 // compile unit
622
623 if( cfg )
624 {
626
628
631
634
636 }
637}
638
639
641{
642 // Load canvas type from the FOOTPRINT_EDITOR_SETTINGS:
644
645 // If we had an OpenGL failure this session, use the fallback GAL but don't update the
646 // user preference silently:
647
650}
651
652
654{
656
657 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
658 // compile unit
660
661 if( cfg )
662 {
664
667 cfg->m_LibWidth = m_treePane->GetSize().x;
669
671
673 {
674 cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
677 }
678
680
682 {
687 }
688 }
689}
690
691
692
694{
695 FOOTPRINT_EDITOR_SETTINGS* cfg = const_cast<FOOTPRINT_EDIT_FRAME*>( this )->GetSettings();
696
697 return cfg ? cfg->m_RotationAngle : ANGLE_90;
698}
699
700
701
703{
704 wxString currentTheme = GetFootprintEditorSettings()->m_ColorTheme;
705 return Pgm().GetSettingsManager().GetColorSettings( currentTheme );
706}
707
708
710{
711 // Get the actual frame settings for magnetic items
713 wxCHECK( cfg, nullptr );
714 return &cfg->m_MagneticItems;
715}
716
717
718const BOX2I FOOTPRINT_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
719{
720 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
721
722 if( footprint )
723 {
724 bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
725
726 if( !hasGraphicalItem )
727 {
728 for( const BOARD_ITEM* item : footprint->GraphicalItems() )
729 {
730 if( item->Type() == PCB_TEXT_T || item->Type() == PCB_TEXTBOX_T )
731 continue;
732
733 hasGraphicalItem = true;
734 break;
735 }
736 }
737
738 if( hasGraphicalItem )
739 {
740 return footprint->GetBoundingBox( false, false );
741 }
742 else
743 {
744 BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
745 newFootprintBB.Inflate( pcbIUScale.mmToIU( 12 ) );
746 return newFootprintBB;
747 }
748 }
749
750 return GetBoardBoundingBox( false );
751}
752
753
755{
756 if( IsContentModified() )
757 {
758 wxString footprintName = GetBoard()->GetFirstFootprint()->GetReference();
759 wxString msg = _( "Save changes to '%s' before closing?" );
760
761 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
762 [&]() -> bool
763 {
764 return SaveFootprint( GetBoard()->GetFirstFootprint() );
765 } ) )
766 {
767 return false;
768 }
769 }
770
771 if( doClose )
772 {
773 GetInfoBar()->ShowMessageFor( wxEmptyString, 1 );
774 Clear_Pcb( false );
775 UpdateTitle();
776 }
777
778 return true;
779}
780
781
782bool FOOTPRINT_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
783{
784 if( IsContentModified() )
785 {
786 // Shutdown blocks must be determined and vetoed as early as possible
788 aEvent.GetId() == wxEVT_QUERY_END_SESSION )
789 {
790 aEvent.Veto();
791 return false;
792 }
793
794 wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
795
797 footprintName = GetBoard()->GetFirstFootprint()->GetReference();
798
799 wxString msg = _( "Save changes to '%s' before closing?" );
800
801 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
802 [&]() -> bool
803 {
804 return SaveFootprint( GetBoard()->GetFirstFootprint() );
805 } ) )
806 {
807 aEvent.Veto();
808 return false;
809 }
810 }
811
812 PAD_TOOL* padTool = m_toolManager->GetTool<PAD_TOOL>();
813
814 if( padTool->InPadEditMode() )
815 padTool->ExitPadEditMode();
816
817 // Save footprint tree column widths
818 m_adapter->SaveSettings();
819
821}
822
823
825{
826 // No more vetos
827 GetCanvas()->SetEventDispatcher( nullptr );
829
830 // Do not show the layer manager during closing to avoid flicker
831 // on some platforms (Windows) that generate useless redraw of items in
832 // the Layer Manager
833 m_auimgr.GetPane( wxT( "LayersManager" ) ).Show( false );
834 m_auimgr.GetPane( wxT( "SelectionFilter" ) ).Show( false );
835
836 Clear_Pcb( false );
837
839
840 if( mgr->IsProjectOpen() && wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
841 {
842 GFootprintList.WriteCacheToFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
843 }
844}
845
846
847void FOOTPRINT_EDIT_FRAME::OnExitKiCad( wxCommandEvent& event )
848{
849 Kiway().OnKiCadExit();
850}
851
852
854{
855 Close();
856}
857
858
860{
862
863 aEvent.Enable( frame != nullptr );
864}
865
866
868{
870
871 FOOTPRINT* editorFootprint = GetBoard()->GetFirstFootprint();
872 bool canInsert = frame && editorFootprint && editorFootprint->GetLink() == niluuid;
873
874 // If the source was deleted, the footprint can inserted but not updated in the board.
875 if( frame && editorFootprint && editorFootprint->GetLink() != niluuid )
876 {
877 BOARD* mainpcb = frame->GetBoard();
878 canInsert = true;
879
880 // search if the source footprint was not deleted:
881 for( FOOTPRINT* candidate : mainpcb->Footprints() )
882 {
883 if( editorFootprint->GetLink() == candidate->m_Uuid )
884 {
885 canInsert = false;
886 break;
887 }
888 }
889 }
890
891 aEvent.Enable( canInsert );
892}
893
894
896{
897 // call my base class
899
900 // We have 2 panes to update.
901 // For some obscure reason, the AUI manager hides the first modified pane.
902 // So force show panes
903 wxAuiPaneInfo& tree_pane_info = m_auimgr.GetPane( m_treePane );
904 bool tree_shown = tree_pane_info.IsShown();
905 tree_pane_info.Caption( _( "Libraries" ) );
906
907 wxAuiPaneInfo& lm_pane_info = m_auimgr.GetPane( m_appearancePanel );
908 bool lm_shown = lm_pane_info.IsShown();
909 lm_pane_info.Caption( _( "Appearance" ) );
910 wxAuiPaneInfo& sf_pane_info = m_auimgr.GetPane( m_selectionFilterPanel );
911 sf_pane_info.Caption( _( "Selection Filter" ) );
912
913 // update the layer manager
915
916 // Now restore the visibility:
917 lm_pane_info.Show( lm_shown );
918 tree_pane_info.Show( tree_shown );
919 m_auimgr.Update();
920
922
923 UpdateTitle();
924}
925
926
928{
930 Update3DView( true, true );
932
933 if( !GetTitle().StartsWith( wxT( "*" ) ) )
934 UpdateTitle();
935}
936
937
939{
940 wxString title;
941 LIB_ID fpid = GetLoadedFPID();
942 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
943 bool writable = true;
944
946 {
947 if( IsContentModified() )
948 title = wxT( "*" );
949
950 title += footprint->GetReference();
951 title += wxS( " " ) + wxString::Format( _( "[from %s]" ), Prj().GetProjectName()
952 + wxT( "." )
953 + FILEEXT::PcbFileExtension );
954 }
955 else if( fpid.IsValid() )
956 {
957 try
958 {
960 }
961 catch( const IO_ERROR& )
962 {
963 // best efforts...
964 }
965
966 // Note: don't used GetLoadedFPID(); footprint name may have been edited
967 if( IsContentModified() )
968 title = wxT( "*" );
969
970 title += From_UTF8( footprint->GetFPID().Format().c_str() );
971
972 if( !writable )
973 title += wxS( " " ) + _( "[Read Only]" );
974 }
975 else if( !fpid.GetLibItemName().empty() )
976 {
977 // Note: don't used GetLoadedFPID(); footprint name may have been edited
978 if( IsContentModified() )
979 title = wxT( "*" );
980
981 title += From_UTF8( footprint->GetFPID().GetLibItemName().c_str() );
982 title += wxS( " " ) + _( "[Unsaved]" );
983 }
984 else
985 {
986 title = _( "[no footprint loaded]" );
987 }
988
989 title += wxT( " \u2014 " ) + _( "Footprint Editor" );
990
991 SetTitle( title );
992}
993
994
996{
998}
999
1000
1002{
1006 UpdateTitle();
1007}
1008
1009
1011{
1013
1014 WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Footprint Libraries" ), 2 );
1015
1016 if( GFootprintList.GetCount() == 0 )
1017 GFootprintList.ReadCacheFromFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
1018
1019 GFootprintList.ReadFootprintFiles( fpTable, nullptr, &progressReporter );
1020 progressReporter.Show( false );
1021
1024
1026 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1027
1028 adapter->AddLibraries( this );
1029}
1030
1031
1033{
1035 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1036 LIB_ID target = GetTargetFPID();
1037 bool targetSelected = ( target == m_treePane->GetLibTree()->GetSelectedLibId() );
1038
1039 // Sync FOOTPRINT_INFO list to the libraries on disk
1040 if( aProgress )
1041 {
1042 WX_PROGRESS_REPORTER progressReporter( this, _( "Updating Footprint Libraries" ), 2 );
1043 GFootprintList.ReadFootprintFiles( fpTable, nullptr, &progressReporter );
1044 progressReporter.Show( false );
1045 }
1046 else
1047 {
1048 GFootprintList.ReadFootprintFiles( fpTable, nullptr, nullptr );
1049 }
1050
1051 // Sync the LIB_TREE to the FOOTPRINT_INFO list
1052 adapter->Sync( fpTable );
1053
1055 m_treePane->GetLibTree()->Regenerate( true );
1056
1057 if( target.IsValid() )
1058 {
1059 if( adapter->FindItem( target ) )
1060 {
1061 if( targetSelected )
1062 m_treePane->GetLibTree()->SelectLibId( target );
1063 else
1064 m_treePane->GetLibTree()->CenterLibId( target );
1065 }
1066 else
1067 {
1068 // Try to focus on parent
1069 target.SetLibItemName( wxEmptyString );
1070 m_treePane->GetLibTree()->CenterLibId( target );
1071 }
1072 }
1073}
1074
1075
1077{
1078 LIB_ID target = GetTargetFPID();
1079
1080 m_treePane->GetLibTree()->Regenerate( true );
1081
1082 if( target.IsValid() )
1083 m_treePane->GetLibTree()->CenterLibId( target );
1084}
1085
1086
1088{
1090}
1091
1092
1094{
1095 m_treePane->GetLibTree()->SelectLibId( aLibID );
1096}
1097
1098
1100{
1102}
1103
1104
1106{
1107 // Create the manager and dispatcher & route draw panel events to the dispatcher
1110 GetCanvas()->GetViewControls(), config(), this );
1111 m_actions = new PCB_ACTIONS();
1113
1115
1125 m_toolManager->RegisterTool( new PCB_CONTROL ); // copy/paste
1135
1136 for( TOOL_BASE* tool : m_toolManager->Tools() )
1137 {
1138 if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
1139 pcbTool->SetIsFootprintEditor( true );
1140 }
1141
1142 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
1144
1145 m_toolManager->InvokeTool( "pcbnew.InteractiveSelection" );
1146
1147 // Load or reload wizard plugins in case they changed since the last time the frame opened
1148 // Because the board editor has also a plugin python menu,
1149 // call the PCB_EDIT_FRAME RunAction() if the board editor is running
1150 // Otherwise run the current RunAction().
1151 PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1152
1153 if( pcbframe )
1155 else
1157}
1158
1159
1161{
1163
1165 PCB_EDITOR_CONDITIONS cond( this );
1166
1167 wxASSERT( mgr );
1168
1169#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1170#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1171
1172 auto haveFootprintCond =
1173 [this]( const SELECTION& )
1174 {
1175 return GetBoard() && GetBoard()->GetFirstFootprint() != nullptr;
1176 };
1177
1178 auto footprintTargettedCond =
1179 [this]( const SELECTION& )
1180 {
1181 return !GetTargetFPID().GetLibItemName().empty();
1182 };
1183
1184 mgr->SetConditions( ACTIONS::saveAs, ENABLE( footprintTargettedCond ) );
1187
1190
1194 mgr->SetConditions( ACTIONS::millimetersUnits, CHECK( cond.Units( EDA_UNITS::MILLIMETRES ) ) );
1195 mgr->SetConditions( ACTIONS::inchesUnits, CHECK( cond.Units( EDA_UNITS::INCHES ) ) );
1196 mgr->SetConditions( ACTIONS::milsUnits, CHECK( cond.Units( EDA_UNITS::MILS ) ) );
1197
1198 mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
1199 mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
1206
1213
1217
1220
1221 auto constrainedDrawingModeCond =
1222 [this]( const SELECTION& )
1223 {
1224 return GetSettings()->m_Use45Limit;
1225 };
1226
1227 auto highContrastCond =
1228 [this]( const SELECTION& )
1229 {
1230 return GetDisplayOptions().m_ContrastModeDisplay != HIGH_CONTRAST_MODE::NORMAL;
1231 };
1232
1233 auto boardFlippedCond =
1234 [this]( const SELECTION& )
1235 {
1236 return GetCanvas() && GetCanvas()->GetView()->IsMirroredX();
1237 };
1238
1239 auto footprintTreeCond =
1240 [this](const SELECTION& )
1241 {
1242 return IsSearchTreeShown();
1243 };
1244
1245 auto layerManagerCond =
1246 [this]( const SELECTION& )
1247 {
1248 return m_auimgr.GetPane( "LayersManager" ).IsShown();
1249 };
1250
1251 auto propertiesCond =
1252 [this] ( const SELECTION& )
1253 {
1254 return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
1255 };
1256
1257 mgr->SetConditions( PCB_ACTIONS::toggleHV45Mode, CHECK( constrainedDrawingModeCond ) );
1258 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
1259 mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
1261
1262 mgr->SetConditions( PCB_ACTIONS::showFootprintTree, CHECK( footprintTreeCond ) );
1263 mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
1264 mgr->SetConditions( PCB_ACTIONS::showProperties, CHECK( propertiesCond ) );
1265
1266 mgr->SetConditions( ACTIONS::print, ENABLE( haveFootprintCond ) );
1267 mgr->SetConditions( PCB_ACTIONS::exportFootprint, ENABLE( haveFootprintCond ) );
1268 mgr->SetConditions( PCB_ACTIONS::placeImportedGraphics, ENABLE( haveFootprintCond ) );
1269
1270 mgr->SetConditions( PCB_ACTIONS::footprintProperties, ENABLE( haveFootprintCond ) );
1271 mgr->SetConditions( PCB_ACTIONS::editTextAndGraphics, ENABLE( haveFootprintCond ) );
1272 mgr->SetConditions( PCB_ACTIONS::checkFootprint, ENABLE( haveFootprintCond ) );
1273 mgr->SetConditions( PCB_ACTIONS::repairFootprint, ENABLE( haveFootprintCond ) );
1274 mgr->SetConditions( PCB_ACTIONS::cleanupGraphics, ENABLE( haveFootprintCond ) );
1275
1276 auto isArcKeepCenterMode =
1277 [this]( const SELECTION& )
1278 {
1279 return GetSettings()->m_ArcEditMode == ARC_EDIT_MODE::KEEP_CENTER_ADJUST_ANGLE_RADIUS;
1280 };
1281
1282 auto isArcKeepEndpointMode =
1283 [this]( const SELECTION& )
1284 {
1285 return GetSettings()->m_ArcEditMode == ARC_EDIT_MODE::KEEP_ENDPOINTS_OR_START_DIRECTION;
1286 };
1287
1288 mgr->SetConditions( PCB_ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
1289 mgr->SetConditions( PCB_ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
1290
1291
1292// Only enable a tool if the part is edtable
1293#define CURRENT_EDIT_TOOL( action ) \
1294 mgr->SetConditions( action, ACTION_CONDITIONS().Enable( haveFootprintCond ) \
1295 .Check( cond.CurrentTool( action ) ) )
1296
1316
1317#undef CURRENT_EDIT_TOOL
1318#undef ENABLE
1319#undef CHECK
1320}
1321
1322
1324{
1326
1327 // Be sure the axis are enabled
1328 GetCanvas()->GetGAL()->SetAxesEnabled( true );
1329
1330 UpdateView();
1331
1332 // Ensure the m_Layers settings are using the canvas type:
1334}
1335
1336
1337void FOOTPRINT_EDIT_FRAME::CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged )
1338{
1339 PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1340
1342 GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
1343
1344 GetBoard()->GetDesignSettings() = cfg->m_DesignSettings;
1345
1349
1351
1352 if( aEnvVarsChanged )
1353 SyncLibraryTree( true );
1354
1355 Layout();
1356 SendSizeEvent();
1357}
1358
1359
1361{
1362 LIB_ID id = GetLoadedFPID();
1363
1364 if( id.empty() )
1365 {
1366 DisplayErrorMessage( this, _( "No footprint selected." ) );
1367 return;
1368 }
1369
1370 wxFileName fn( id.GetLibItemName() );
1371 fn.SetExt( wxT( "png" ) );
1372
1373 wxString projectPath = wxPathOnly( Prj().GetProjectFullName() );
1374
1375 wxFileDialog dlg( this, _( "Export View as PNG" ), projectPath, fn.GetFullName(),
1376 FILEEXT::PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1377
1378 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetPath().IsEmpty() )
1379 return;
1380
1381 // calling wxYield is mandatory under Linux, after closing the file selector dialog
1382 // to refresh the screen before creating the PNG or JPEG image from screen
1383 wxYield();
1384 this->SaveCanvasImageToFile( dlg.GetPath(), BITMAP_TYPE::PNG );
1385}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
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_modedit_32
@ icon_modedit
@ icon_modedit_16
static TOOL_ACTION toggleGrid
Definition: actions.h:172
static TOOL_ACTION paste
Definition: actions.h:70
static TOOL_ACTION millimetersUnits
Definition: actions.h:180
static TOOL_ACTION unselectAll
Definition: actions.h:73
static TOOL_ACTION revert
Definition: actions.h:55
static TOOL_ACTION saveAs
Definition: actions.h:52
static TOOL_ACTION copy
Definition: actions.h:69
static TOOL_ACTION pluginsReload
Cursor control event types.
Definition: actions.h:224
static TOOL_ACTION pasteSpecial
Definition: actions.h:71
static TOOL_ACTION milsUnits
Definition: actions.h:179
static TOOL_ACTION toggleBoundingBoxes
Definition: actions.h:135
static TOOL_ACTION undo
Definition: actions.h:66
static TOOL_ACTION duplicate
Definition: actions.h:74
static TOOL_ACTION inchesUnits
Definition: actions.h:178
static TOOL_ACTION highContrastMode
Definition: actions.h:133
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:132
static TOOL_ACTION measureTool
Definition: actions.h:188
static TOOL_ACTION doDelete
Definition: actions.h:75
static TOOL_ACTION selectionTool
Definition: actions.h:187
static TOOL_ACTION save
Definition: actions.h:51
static TOOL_ACTION zoomFitScreen
Definition: actions.h:124
static TOOL_ACTION redo
Definition: actions.h:67
static TOOL_ACTION deleteTool
Definition: actions.h:76
static TOOL_ACTION zoomTool
Definition: actions.h:127
static TOOL_ACTION print
Definition: actions.h:57
static TOOL_ACTION showProperties
Definition: actions.h:201
static TOOL_ACTION cut
Definition: actions.h:68
static TOOL_ACTION gridSetOrigin
Definition: actions.h:169
static TOOL_ACTION ddAddLibrary
Definition: actions.h:60
static TOOL_ACTION toggleGridOverrides
Definition: actions.h:173
static TOOL_ACTION selectAll
Definition: actions.h:72
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...
std::vector< LAYER_PRESET > GetUserLayerPresets() const
Update the current layer presets from those saved in the project file.
int GetTabIndex() const
Set the current notebook tab.
void UpdateDisplayOptions()
Return a list of the layer presets created by the user.
wxString GetActiveLayerPreset() const
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:173
bool IsContentModified() const
Definition: base_screen.h:60
void SetContentModified(bool aModified=true)
Definition: base_screen.h:59
Container for design settings for a BOARD object.
std::shared_ptr< NET_SETTINGS > m_NetSettings
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
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:281
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:293
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:700
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition: board.cpp:583
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:432
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition: board.cpp:729
const FOOTPRINTS & Footprints() const
Definition: board.h:322
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition: board.cpp:712
void SetCopperLayerCount(int aCount)
Definition: board.cpp:662
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition: board.cpp:1277
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:797
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:507
Color settings are a bit different than most of the settings objects in that there can be more than o...
Handle actions that are shared between different applications.
Handles action that are shared between different applications.
Definition: common_tools.h:38
Tool responsible for drawing graphical elements like lines, arcs, circles, etc.
Definition: drawing_tool.h:55
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.
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)
bool m_isClosing
Set by NonUserClose() to indicate that the user did not request the current close.
WX_INFOBAR * GetInfoBar()
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
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.
bool SaveCanvasImageToFile(const wxString &aFileName, BITMAP_TYPE aBitmapType)
Save the current view as an image file.
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting(APP_SETTINGS_BASE *aCfg=nullptr)
Returns the canvas type stored in the application settings.
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.
static bool m_openGLFailureOccured
Has any failure occured when switching to OpenGL in any EDA_DRAW_FRAME?
static const wxString PropertiesPaneName()
virtual void UpdateMsgPanel()
Redraw the message panel.
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.
@ GAL_TYPE_OPENGL
OpenGL implementation.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
Specialization of the wxAuiPaneInfo class for KiCad panels.
SELECTION_CONDITION NoActiveTool()
Create a functor testing if there are no tools active in the frame.
SELECTION_CONDITION BoundingBoxes()
SELECTION_CONDITION RedoAvailable()
Create a functor that tests if there are any items in the redo queue.
SELECTION_CONDITION CurrentTool(const TOOL_ACTION &aTool)
Create a functor testing if the specified tool is the current active tool in the frame.
virtual SELECTION_CONDITION UndoAvailable()
Create a functor that tests if there are any items in the undo queue.
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 ContentModified()
Create a functor that tests if the content of the frame is modified.
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:56
Module editor specific tools.
BOARD_DESIGN_SETTINGS m_DesignSettings
Only some of these settings are actually used for footprint editing.
std::vector< LAYER_PRESET > m_LayerPresets
PCB_SELECTION_FILTER_OPTIONS m_SelectionFilter
void CloseFootprintEditor(wxCommandEvent &Event)
BOARD_DESIGN_SETTINGS & GetDesignSettings() const override
Returns the BOARD_DESIGN_SETTINGS for the open project.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void HardRedraw() override
Refresh the library tree and redraw the window.
static const wxChar * GetFootprintEditorFrameName()
void SyncLibraryTree(bool aProgress)
Synchronize the footprint library tree to the current state of the footprint library table.
void OnSaveFootprintAsPng(wxCommandEvent &event)
BOARD_ITEM_CONTAINER * GetModel() const override
bool canCloseWindow(wxCloseEvent &Event) override
void UpdateMsgPanel() override
Redraw the message panel.
LIB_ID GetTargetFPID() const
Return the LIB_ID of the part selected in the footprint tree, or the loaded part if there is no selec...
LIB_ID GetLoadedFPID() const
Return the LIB_ID of the part being edited.
APP_SETTINGS_BASE * config() const override
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void SelectLayer(wxCommandEvent &event)
LIB_TREE_NODE * GetCurrentTreeNode() const
void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings) override
bool SaveFootprint(FOOTPRINT *aFootprint)
Save in an existing library a given footprint.
LIB_ID GetTreeFPID() const
Return the LIB_ID of the part or library selected in the footprint tree.
void initLibraryTree()
Make sure the footprint info list is loaded (with a progress dialog) and then initialize the footprin...
void OnLoadFootprintFromBoard(wxCommandEvent &event)
Called from the main toolbar to load a footprint from board mainly to edit it.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Called after the preferences dialog is run.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void ShowChangedLanguage() override
Update visible items after a language change.
void resolveCanvasType() override
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
void OnSaveFootprintToBoard(wxCommandEvent &event)
bool IsContentModified() const override
Get if any footprints or libraries have been modified but not saved.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter
FOOTPRINT_EDITOR_SETTINGS * m_editorSettings
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Returns bbox of document with option to not include some items.
bool Clear_Pcb(bool doAskAboutUnsavedChanges)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:103
void OnUpdateLoadFootprintFromBoard(wxUpdateUIEvent &aEvent)
void OnUpdateSaveFootprintToBoard(wxUpdateUIEvent &aEvent)
Install the corresponding dialog editor for the given item.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
bool CanCloseFPFromBoard(bool doClose)
void RegenerateLibraryTree()
Filter, sort, and redisplay the library tree.
void AddFootprintToBoard(FOOTPRINT *aFootprint) override
Override from PCB_BASE_EDIT_FRAME which adds a footprint to the editor's dummy board,...
void OnModify() override
Must be called after a footprint change in order to set the "modify" flag of the current screen and p...
FOOTPRINT_TREE_PANE * m_treePane
void OnDisplayOptionsChanged() override
void FocusOnLibID(const LIB_ID &aLibID)
const PCB_PLOT_PARAMS & GetPlotSettings() const override
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
std::unique_ptr< FOOTPRINT > m_originalFootprintCopy
void ReloadFootprint(FOOTPRINT *aFootprint) override
Override from PCB_BASE_FRAME which reloads the footprint from the library without setting the footpri...
EDA_ANGLE GetRotationAngle() const override
Return the angle used for rotate operations.
void RefreshLibraryTree()
Redisplay the library tree.
void OnExitKiCad(wxCommandEvent &aEvent)
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
MAGNETIC_SETTINGS * GetMagneticItemsSettings() override
FOOTPRINT_EDITOR_SETTINGS * GetSettings()
void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
Switch the currently used canvas (Cairo / OpenGL).
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
bool ReadFootprintFiles(FP_LIB_TABLE *aTable, const wxString *aNickname=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr) override
Read all the footprints provided by the combination of aTable and aNickname.
void WriteCacheToFile(const wxString &aFilePath) override
void ReadCacheFromFile(const wxString &aFilePath) override
void DisplayErrors(wxTopLevelWindow *aCaller=nullptr)
unsigned GetErrorCount() const
unsigned GetCount() const
Footprint Editor pane with footprint library tree.
LIB_TREE * GetLibTree() const
bool FixUuids()
Old footprints do not always have a valid UUID (some can be set to null uuid) However null UUIDs,...
Definition: footprint.cpp:636
ZONES & Zones()
Definition: footprint.h:197
EDA_ITEM * Clone() const override
Invoke a function on all children.
Definition: footprint.cpp:1987
PADS & Pads()
Definition: footprint.h:191
const LIB_ID & GetFPID() const
Definition: footprint.h:233
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: footprint.cpp:1506
KIID GetLink() const
Definition: footprint.h:835
const wxString & GetReference() const
Definition: footprint.h:588
DRAWINGS & GraphicalItems()
Definition: footprint.h:194
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: footprint.cpp:1222
bool IsFootprintLibWritable(const wxString &aNickname)
Return true if the library given by aNickname is writable.
void AddLibraries(EDA_BASE_FRAME *aParent)
static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > Create(FOOTPRINT_EDIT_FRAME *aFrame, FP_LIB_TABLE *aLibs)
void ReadWindowSettings(WINDOW_SETTINGS &aCfg)
Read GAL config options from application-level config.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
bool m_axesEnabled
Fullscreen crosshair or small cross.
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:766
bool IsMirroredX() const
Return true if view is flipped across the X axis.
Definition: view.h:245
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:619
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
void OnKiCadExit()
Definition: kiway.cpp:717
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:406
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:110
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:172
int SetLibNickname(const UTF8 &aLibNickname)
Override the logical library name portion of the LIB_ID to aLibNickname.
Definition: lib_id.cpp:99
UTF8 Format() const
Definition: lib_id.cpp:118
const wxString GetUniStringLibItemName() const
Get strings for display messages in dialogs.
Definition: lib_id.h:112
const UTF8 & GetLibItemName() const
Definition: lib_id.h:102
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:87
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
Definition: lib_tree.cpp:438
LIB_TREE_NODE * GetCurrentTreeNode() const
Definition: lib_tree.cpp:332
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferably centered).
Definition: lib_tree.cpp:349
void ShowChangedLanguage()
Definition: lib_tree.cpp:291
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:343
LIB_TREE_MODEL_ADAPTER::SORT_MODE GetSortMode() const
Definition: lib_tree.h:141
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
Definition: lib_tree.cpp:355
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit,...
Definition: lib_tree.cpp:301
void Regenerate(bool aKeepState)
Regenerate the tree.
Definition: lib_tree.cpp:420
void SetSortMode(LIB_TREE_MODEL_ADAPTER::SORT_MODE aMode)
Save/restore the sorting mode.
Definition: lib_tree.h:140
Tool relating to pads and pad settings.
Definition: pad_tool.h:37
void ExitPadEditMode()
Definition: pad_tool.cpp:776
bool InPadEditMode()
Definition: pad_tool.h:65
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:59
static const wxChar A4[]
Definition: page_info.h:68
void SetCheckboxesFromFilter(PCB_SELECTION_FILTER_OPTIONS &aOptions)
Gather all the actions that are shared by tools.
Definition: pcb_actions.h:50
static TOOL_ACTION toggleHV45Mode
Definition: pcb_actions.h:511
static TOOL_ACTION drawRuleArea
Definition: pcb_actions.h:215
static TOOL_ACTION placeText
Definition: pcb_actions.h:201
static TOOL_ACTION pointEditorArcKeepCenter
Definition: pcb_actions.h:290
static TOOL_ACTION drawOrthogonalDimension
Definition: pcb_actions.h:211
static TOOL_ACTION drawRectangle
Definition: pcb_actions.h:197
static TOOL_ACTION setAnchor
Definition: pcb_actions.h:222
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:325
static TOOL_ACTION placeReferenceImage
Definition: pcb_actions.h:200
static TOOL_ACTION showLayersManager
Definition: pcb_actions.h:437
static TOOL_ACTION drawCircle
Definition: pcb_actions.h:198
static TOOL_ACTION mirrorH
Mirroring of selected items.
Definition: pcb_actions.h:139
static TOOL_ACTION exportFootprint
Definition: pcb_actions.h:462
static TOOL_ACTION showFootprintTree
Definition: pcb_actions.h:444
static TOOL_ACTION drawTextBox
Definition: pcb_actions.h:202
static TOOL_ACTION drawPolygon
Definition: pcb_actions.h:196
static TOOL_ACTION placePad
Activation of the drawing tool (placing a PAD)
Definition: pcb_actions.h:471
static TOOL_ACTION group
Definition: pcb_actions.h:519
static TOOL_ACTION drawRadialDimension
Definition: pcb_actions.h:210
static TOOL_ACTION editTextAndGraphics
Definition: pcb_actions.h:407
static TOOL_ACTION drawLeader
Definition: pcb_actions.h:212
static TOOL_ACTION ddImportFootprint
Definition: pcb_actions.h:577
static TOOL_ACTION ungroup
Definition: pcb_actions.h:520
static TOOL_ACTION placeImportedGraphics
Definition: pcb_actions.h:221
static TOOL_ACTION drawArc
Definition: pcb_actions.h:199
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
Definition: pcb_actions.h:483
static TOOL_ACTION pointEditorArcKeepEndpoint
Definition: pcb_actions.h:291
static TOOL_ACTION drawCenterDimension
Definition: pcb_actions.h:209
static TOOL_ACTION footprintProperties
Definition: pcb_actions.h:465
static TOOL_ACTION flipBoard
Definition: pcb_actions.h:378
static TOOL_ACTION textOutlines
Display texts as lines.
Definition: pcb_actions.h:486
static TOOL_ACTION checkFootprint
Definition: pcb_actions.h:468
static TOOL_ACTION mirrorV
Definition: pcb_actions.h:140
static TOOL_ACTION repairFootprint
Definition: pcb_actions.h:537
static TOOL_ACTION drawLine
Definition: pcb_actions.h:195
static TOOL_ACTION cleanupGraphics
Definition: pcb_actions.h:411
static TOOL_ACTION rotateCw
Rotation of selected objects.
Definition: pcb_actions.h:132
static TOOL_ACTION rotateCcw
Definition: pcb_actions.h:133
static TOOL_ACTION drawAlignedDimension
Definition: pcb_actions.h:208
Common, abstract interface for edit frames.
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 setFPWatcher(FOOTPRINT *aFootprint)
Creates (or removes) a watcher on the specified footprint.
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
FOOTPRINT * loadFootprint(const LIB_ID &aFootprintId)
Attempts to load aFootprintId from the footprint library table.
BOX2I GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
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 void AddFootprintToBoard(FOOTPRINT *aFootprint)
Add the given footprint to the board.
PCB_DISPLAY_OPTIONS m_displayOptions
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings() const
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
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
void UpdateColors()
Update the color settings in the painter and GAL.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void DisplayBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
Add all items from the current board to the VIEW, so they can be displayed by GAL.
Group generic conditions for PCB editor states.
SELECTION_CONDITION PadFillDisplay()
Create a functor that tests if the frame fills the pads.
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 TextFillDisplay()
Create a functor that tests if the frame fills text items.
The main frame for Pcbnew.
Generic tool for picking an item.
Parameters and options when plotting/printing a board.
Tool that displays edit points allowing to modify items by dragging the points.
The selection tool: currently supports:
Tool useful for viewing footprints.
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
The interactive edit tool.
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
Definition: project_pcb.cpp:37
@ PCB_FOOTPRINT_EDITOR_FP_NAME
Definition: project.h:192
@ PCB_FOOTPRINT_EDITOR_LIB_NICKNAME
Definition: project.h:193
virtual void SetRString(RSTRING_T aStringId, const wxString &aString)
Store a "retained string", which is any session and project specific string identified in enum RSTRIN...
Definition: project.cpp:269
virtual const wxString & GetRString(RSTRING_T aStringId)
Return a "retained string", which is any session and project specific string identified in enum RSTRI...
Definition: project.cpp:280
float SplitterProportion() const
Action handler for the Properties panel.
Tool relating to pads and pad settings.
static SELECTION_CONDITION HasType(KICAD_T aType)
Create a functor that tests if among the selected items there is at least one of a given type.
static bool NotEmpty(const SELECTION &aSelection)
Test if there are any items selected.
static bool Idle(const SELECTION &aSelection)
Test if there no items selected or being edited.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
T * GetAppSettings()
Returns a handle to the a given settings by type If the settings have already been loaded,...
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
bool IsProjectOpen() const
Helper for checking if we have a project open TODO: This should be deprecated along with Prj() once w...
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:167
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:169
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
ACTIONS * m_actions
Definition: tools_holder.h:168
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
virtual void DispatchWxEvent(wxEvent &aEvent)
Process wxEvents (mostly UI events), translate them to TOOL_EVENTs, and make tools handle those.
Master controller class:
Definition: tool_manager.h:57
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:297
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
std::vector< TOOL_BASE * > Tools()
Definition: tool_manager.h:332
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...
bool empty() const
Definition: utf8.h:104
const char * c_str() const
Definition: utf8.h:103
A modified version of the wxInfoBar class that allows us to:
Definition: wx_infobar.h:75
void ShowMessageFor(const wxString &aMessage, int aTime, int aFlags=wxICON_INFORMATION, MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the infobar with the provided message and icon for a specific period of time.
Definition: wx_infobar.cpp:140
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
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 _HKI(x)
static bool empty(const wxTextEntryBase *aCtrl)
#define _(s)
Declaration of the eda_3d_viewer class.
static constexpr EDA_ANGLE ANGLE_90
Definition: eda_angle.h:437
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define FOOTPRINT_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
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)
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition: cvpcb.cpp:156
@ FRAME_PCB_EDITOR
Definition: frame_type.h:42
@ FRAME_FOOTPRINT_EDITOR
Definition: frame_type.h:43
static const std::string KiCadFootprintLibPathExtension
static const std::string KiCadFootprintFileExtension
static wxString PngFileWildcard()
@ ID_ON_GRID_SELECT
Definition: id.h:145
@ ID_ON_ZOOM_SELECT
Definition: id.h:143
PROJECT & Prj()
Definition: kicad.cpp:595
KIID niluuid(0)
@ F_SilkS
Definition: layer_ids.h:104
@ In1_Cu
Definition: layer_ids.h:65
This file contains miscellaneous commonly used macros and functions.
@ 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
@ ID_FPEDIT_SAVE_PNG
Definition: pcbnew_id.h:98
@ ID_ADD_FOOTPRINT_TO_BOARD
Definition: pcbnew_id.h:116
@ ID_LOAD_FOOTPRINT_FROM_BOARD
Definition: pcbnew_id.h:117
@ ID_TOOLBARH_PCB_SELECT_LAYER
Definition: pcbnew_id.h:96
SETTINGS_MANAGER * GetSettingsManager()
BOARD * GetBoard()
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE
KIWAY Kiway(KFCTL_STANDALONE)
wxString From_UTF8(const char *cstring)
const double IU_PER_MILS
Definition: base_units.h:77
constexpr int mmToIU(double mm) const
Definition: base_units.h:88
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:110
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition: typeinfo.h:93
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
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.