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 "tool/embed_tool.h"
24#include "tools/convert_tool.h"
25#include "tools/drawing_tool.h"
26#include "tools/edit_tool.h"
29#include "tools/pad_tool.h"
30#include "tools/pcb_actions.h"
31#include "tools/pcb_control.h"
38#include <bitmaps.h>
39#include <board.h>
40#include <footprint.h>
41#include <confirm.h>
44#include <footprint_info_impl.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 <pcbnew_id.h>
52#include <pgm_base.h>
53#include <project.h>
54#include <project_pcb.h>
56#include <tool/action_toolbar.h>
57#include <tool/common_control.h>
58#include <tool/common_tools.h>
60#include <tool/selection.h>
63#include <tool/tool_manager.h>
64#include <tool/zoom_tool.h>
67#include <tools/group_tool.h>
70#include <widgets/lib_tree.h>
75#include <wx/filedlg.h>
77
78BEGIN_EVENT_TABLE( FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME )
79 EVT_MENU( wxID_CLOSE, FOOTPRINT_EDIT_FRAME::CloseFootprintEditor )
80 EVT_MENU( wxID_EXIT, FOOTPRINT_EDIT_FRAME::OnExitKiCad )
81
83
86
88
91
92 // Horizontal toolbar
94
95 // UI update events.
97 FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard )
99 FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard )
101
102 // Drop files event
103 EVT_DROP_FILES( FOOTPRINT_EDIT_FRAME::OnDropFiles )
104
105END_EVENT_TABLE()
106
107
108FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
109 PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
110 wxDefaultPosition, wxDefaultSize,
111 KICAD_DEFAULT_DRAWFRAME_STYLE, GetFootprintEditorFrameName() ),
112 m_show_layer_manager_tools( true )
113{
114 m_showBorderAndTitleBlock = false; // true to show the frame references
115 m_aboutTitle = _HKI( "KiCad Footprint Editor" );
116 m_selLayerBox = nullptr;
117 m_editorSettings = nullptr;
118
119 // Give an icon
120 wxIcon icon;
121 wxIconBundle icon_bundle;
122
123 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 48 ) );
124 icon_bundle.AddIcon( icon );
125 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 128 ) );
126 icon_bundle.AddIcon( icon );
127 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 256 ) );
128 icon_bundle.AddIcon( icon );
129 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_32 ) );
130 icon_bundle.AddIcon( icon );
131 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_16 ) );
132 icon_bundle.AddIcon( icon );
133
134 SetIcons( icon_bundle );
135
136 // Create GAL canvas
137 m_canvasType = loadCanvasTypeSetting( GetSettings() );
138
139 PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
140 GetGalDisplayOptions(), m_canvasType );
141 SetCanvas( drawPanel );
142
143 CreateInfoBar();
144
145 SetBoard( new BOARD() );
146
147 // This board will only be used to hold a footprint for editing
149
150 // In Footprint Editor, the default net clearance is not known (it depends on the actual
151 // board). So we do not show the default clearance, by setting it to 0. The footprint or
152 // pad specific clearance will be shown.
153 GetBoard()->GetDesignSettings().m_NetSettings->m_DefaultNetClass->SetClearance( 0 );
154
155 // Don't show the default board solder mask expansion in the footprint editor. Only the
156 // footprint or pad mask expansions settings should be shown.
158
159 // Ensure all layers and items are visible:
160 // In footprint editor, some layers have no meaning or cannot be used, but we show all of
161 // them, at least to be able to edit a bad layer
163
164 GetGalDisplayOptions().m_axesEnabled = true;
165
166 // In Footprint Editor, set the default paper size to A4 for plot/print
167 SetPageSettings( PAGE_INFO( PAGE_INFO::A4 ) );
168 SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS ) ) );
169
170 // Create the manager and dispatcher & route draw panel events to the dispatcher
171 setupTools();
172 setupUIConditions();
173
174 initLibraryTree();
175 m_treePane = new FOOTPRINT_TREE_PANE( this );
176
177 // restore the last footprint from the project, if any, after the library has been init'ed
178 restoreLastFootprint();
179
180 ReCreateMenuBar();
181 ReCreateHToolbar();
182 ReCreateVToolbar();
183 ReCreateOptToolbar();
184
185 m_selectionFilterPanel = new PANEL_SELECTION_FILTER( this );
186 m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas(), true );
187 m_propertiesPanel = new PCB_PROPERTIES_PANEL( this, this );
188
189 // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
190 // parameters in m_LayersManager
191 // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
192 LoadSettings( GetSettings() );
193
194 float proportion = GetFootprintEditorSettings()->m_AuiPanels.properties_splitter;
195 m_propertiesPanel->SetSplitterProportion( proportion );
196
197 // Must be set after calling LoadSettings() to be sure these parameters are not dependent
198 // on what is read in stored settings. Enable one internal layer, because footprints
199 // support keepout areas that can be on internal layers only (therefore on the first internal
200 // layer). This is needed to handle these keepout in internal layers only.
202 GetBoard()->SetEnabledLayers( GetBoard()->GetEnabledLayers().set( In1_Cu ) );
203 GetBoard()->SetVisibleLayers( GetBoard()->GetEnabledLayers() );
204 GetBoard()->SetLayerName( In1_Cu, _( "Inner layers" ) );
205
206 SetActiveLayer( F_SilkS );
207
208 m_auimgr.SetManagedWindow( this );
209
210 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
211#if !defined( _WIN32 )
212 // Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds
213 // of graphical glitches
214 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
215#endif
216 m_auimgr.SetFlags( auiFlags );
217
218 // Rows; layers 4 - 6
219 m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
220 .Top().Layer( 6 ) );
221
222 m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
223 .Bottom().Layer( 6 ) );
224
225 // Columns; layers 1 - 3
226 m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" )
227 .Left().Layer( 4 )
228 .Caption( _( "Libraries" ) )
229 .MinSize( FromDIP( 250 ), -1 ).BestSize( FromDIP( 250 ), -1 ) );
230 m_auimgr.AddPane( m_propertiesPanel, EDA_PANE().Name( PropertiesPaneName() )
231 .Left().Layer( 3 )
232 .Caption( _( "Properties" ) ).PaneBorder( false )
233 .MinSize( FromDIP( wxSize( 240, 60 ) ) ).BestSize( FromDIP( wxSize( 300, 200 ) ) ) );
234 m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
235 .Left().Layer( 2 ) );
236
237 m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
238 .Right().Layer(2) );
239 m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( "LayersManager" )
240 .Right().Layer( 3 )
241 .Caption( _( "Appearance" ) ).PaneBorder( false )
242 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
243 m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Palette().Name( "SelectionFilter" )
244 .Right().Layer( 3 ).Position( 2 )
245 .Caption( _( "Selection Filter" ) ).PaneBorder( false )
246 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
247
248 // Center
249 m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
250 .Center() );
251
252 m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
253 m_auimgr.GetPane( "SelectionFilter" ).Show( m_show_layer_manager_tools );
254 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetSettings()->m_AuiPanels.show_properties );
255
256 // The selection filter doesn't need to grow in the vertical direction when docked
257 m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
258
261 DragAcceptFiles( true );
262
263 ActivateGalCanvas();
264
265 FinishAUIInitialization();
266
267 // Apply saved visibility stuff at the end
268 if( FOOTPRINT_EDITOR_SETTINGS* cfg = dynamic_cast<FOOTPRINT_EDITOR_SETTINGS*>( GetSettings() ) )
269 {
270 wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
271 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
272
273 if( cfg->m_LibWidth > 0 )
274 SetAuiPaneSize( m_auimgr, treePane, cfg->m_LibWidth, -1 );
275
276 if( cfg->m_AuiPanels.right_panel_width > 0 )
277 SetAuiPaneSize( m_auimgr, layersManager, cfg->m_AuiPanels.right_panel_width, -1 );
278
279 m_appearancePanel->SetUserLayerPresets( cfg->m_LayerPresets );
280 m_appearancePanel->ApplyLayerPreset( cfg->m_ActiveLayerPreset );
281 m_appearancePanel->SetTabIndex( cfg->m_AuiPanels.appearance_panel_tab );
282 }
283
284 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
285 UpdateTitle();
286 setupUnits( GetSettings() );
287
288 resolveCanvasType();
289
290 // Default shutdown reason until a file is loaded
291 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
292
293 // Catch unhandled accelerator command characters that were no handled by the library tree
294 // panel.
295 Bind( wxEVT_CHAR, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
296 Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
297
298 // Ensure the window is on top
299 Raise();
300 Show( true );
301
302 // Register a call to update the toolbar sizes. It can't be done immediately because
303 // it seems to require some sizes calculated that aren't yet (at least on GTK).
304 CallAfter(
305 [this]()
306 {
307 // Ensure the controls on the toolbars all are correctly sized
308 UpdateToolbarControlSizes();
309 m_treePane->FocusSearchFieldIfExists();
310 } );
311}
312
313
315{
316 // Shutdown all running tools
317 if( m_toolManager )
319
320 // save the footprint in the PROJECT
322
323 // Clear the watched file
324 setFPWatcher( nullptr );
325
327 delete m_appearancePanel;
328 delete m_treePane;
329}
330
331
333{
335
336 FOOTPRINT* fp = static_cast<FOOTPRINT*>( GetModel() );
337
338 if( fp )
339 {
340 std::vector<MSG_PANEL_ITEM> msgItems;
341 fp->GetMsgPanelInfo( this, msgItems );
342 SetMsgPanel( msgItems );
343 }
344}
345
346
348{
349 return GetScreen() && GetScreen()->IsContentModified()
351}
352
353
355{
356 return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
357}
358
359
361{
362 // switches currently used canvas (Cairo / OpenGL).
363 PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
364
365 GetCanvas()->GetGAL()->SetAxesEnabled( true );
366
367 // The base class method *does not reinit* the layers manager. We must update the layer
368 // widget to match board visibility states, both layers and render columns, and and some
369 // settings dependent on the canvas.
371}
372
373
375{
376 SyncLibraryTree( true );
378}
379
380
382{
383 wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
384 treePane.Show( !IsLibraryTreeShown() );
385
386 if( IsLibraryTreeShown() )
387 {
388 // SetAuiPaneSize also updates m_auimgr
390 }
391 else
392 {
393 m_editorSettings->m_LibWidth = m_treePane->GetSize().x;
394 m_auimgr.Update();
395 }
396}
397
398
400{
402}
403
404
406{
408 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
409 wxAuiPaneInfo& selectionFilter = m_auimgr.GetPane( "SelectionFilter" );
410
411 // show auxiliary Vertical layers and visibility manager toolbar
413 layersManager.Show( m_show_layer_manager_tools );
414 selectionFilter.Show( m_show_layer_manager_tools );
415
417 {
418 SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
419 }
420 else
421 {
422 settings->m_AuiPanels.right_panel_width = m_appearancePanel->GetSize().x;
423 m_auimgr.Update();
424 }
425}
426
427
429{
430 return const_cast<wxAuiManager&>( m_auimgr ).GetPane( m_treePane ).IsShown();
431}
432
433
435{
436 return GetBoard()->GetFirstFootprint();
437}
438
439
441{
442 LIB_ID id;
443
444 if( IsLibraryTreeShown() )
446
447 if( id.GetLibNickname().empty() )
448 id = GetLoadedFPID();
449
450 return id;
451}
452
453
455{
456 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
457
458 if( footprint )
459 return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
460 else
461 return LIB_ID();
462}
463
464
466{
467 if( GetBoard()->GetFirstFootprint() )
468 {
471 }
472
473 GetScreen()->SetContentModified( false );
474}
475
476
478{
479 // If we've already vetted closing this window, then we have no FP anymore
480 if( m_isClosing || !GetBoard() )
481 return false;
482
483 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
484
485 return ( footprint && footprint->GetLink() != niluuid );
486}
487
488
490{
491 LIB_ID id = GetLoadedFPID();
492
493 if( id.IsValid() )
494 {
496 Prj().SetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, id.GetLibItemName() );
497 }
498}
499
500
502{
503 const wxString& footprintName = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME );
504 const wxString& libNickname = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME );
505
506 if( libNickname.Length() && footprintName.Length() )
507 {
508 LIB_ID id;
509 id.SetLibNickname( libNickname );
510 id.SetLibItemName( footprintName );
511
512 FOOTPRINT* footprint = loadFootprint( id );
513
514 if( footprint )
515 AddFootprintToBoard( footprint );
516 }
517}
518
519
521{
523
524 m_originalFootprintCopy.reset( static_cast<FOOTPRINT*>( aFootprint->Clone() ) );
525 m_originalFootprintCopy->SetParent( nullptr );
526
528
530 // Ensure item UUIDs are valid
531 // ("old" footprints can have null uuids that create issues in fp editor)
532 aFootprint->FixUuids();
533
535 {
536 wxString msg;
537 msg.Printf( _( "Editing %s from board. Saving will update the board only." ),
538 aFootprint->GetReference() );
539
540 if( WX_INFOBAR* infobar = GetInfoBar() )
541 {
542 infobar->RemoveAllButtons();
543 infobar->AddCloseButton();
544 infobar->ShowMessage( msg, wxICON_INFORMATION );
545 }
546 }
547 else
548 {
549 if( WX_INFOBAR* infobar = GetInfoBar() )
550 infobar->Dismiss();
551 }
552
554}
555
556
558{
559 ReloadFootprint( aFootprint );
560
562 setFPWatcher( nullptr );
563 else
564 setFPWatcher( aFootprint );
565}
566
567
569{
571}
572
573
575{
576 return GetBoard()->GetDesignSettings();
577}
578
579
581{
582 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
583
585}
586
587
589{
590 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
591}
592
593
595{
596 if( !m_editorSettings )
598
599 return m_editorSettings;
600}
601
602
604{
607}
608
609
611{
612 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
613 // compile unit
615
616 if( cfg )
617 {
619
621
624
627
629 }
630}
631
632
634{
635 // Load canvas type from the FOOTPRINT_EDITOR_SETTINGS:
637
638 // If we had an OpenGL failure this session, use the fallback GAL but don't update the
639 // user preference silently:
640
643}
644
645
647{
649
650 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
651 // compile unit
653
654 if( cfg )
655 {
657
660 cfg->m_LibWidth = m_treePane->GetSize().x;
662
664
666 {
667 cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
670 }
671
673
675 {
680 }
681 }
682}
683
684
685
687{
688 FOOTPRINT_EDITOR_SETTINGS* cfg = const_cast<FOOTPRINT_EDIT_FRAME*>( this )->GetSettings();
689
690 return cfg ? cfg->m_RotationAngle : ANGLE_90;
691}
692
693
694
696{
697 wxString currentTheme = GetFootprintEditorSettings()->m_ColorTheme;
698 return Pgm().GetSettingsManager().GetColorSettings( currentTheme );
699}
700
701
703{
704 // Get the actual frame settings for magnetic items
706 wxCHECK( cfg, nullptr );
707 return &cfg->m_MagneticItems;
708}
709
710
711const BOX2I FOOTPRINT_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
712{
713 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
714
715 if( footprint )
716 {
717 bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
718
719 if( !hasGraphicalItem )
720 {
721 for( const BOARD_ITEM* item : footprint->GraphicalItems() )
722 {
723 if( item->Type() == PCB_TEXT_T || item->Type() == PCB_TEXTBOX_T )
724 continue;
725
726 hasGraphicalItem = true;
727 break;
728 }
729 }
730
731 if( hasGraphicalItem )
732 {
733 return footprint->GetBoundingBox( false, false );
734 }
735 else
736 {
737 BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
738 newFootprintBB.Inflate( pcbIUScale.mmToIU( 12 ) );
739 return newFootprintBB;
740 }
741 }
742
743 return GetBoardBoundingBox( false );
744}
745
746
748{
749 if( IsContentModified() )
750 {
751 wxString footprintName = GetBoard()->GetFirstFootprint()->GetReference();
752 wxString msg = _( "Save changes to '%s' before closing?" );
753
754 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
755 [&]() -> bool
756 {
757 return SaveFootprint( GetBoard()->GetFirstFootprint() );
758 } ) )
759 {
760 return false;
761 }
762 }
763
764 if( doClose )
765 {
766 GetInfoBar()->ShowMessageFor( wxEmptyString, 1 );
767 Clear_Pcb( false );
768 UpdateTitle();
769 }
770
771 return true;
772}
773
774
775bool FOOTPRINT_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
776{
777 if( IsContentModified() )
778 {
779 // Shutdown blocks must be determined and vetoed as early as possible
781 aEvent.GetId() == wxEVT_QUERY_END_SESSION )
782 {
783 aEvent.Veto();
784 return false;
785 }
786
787 wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
788
790 footprintName = GetBoard()->GetFirstFootprint()->GetReference();
791
792 wxString msg = _( "Save changes to '%s' before closing?" );
793
794 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
795 [&]() -> bool
796 {
797 return SaveFootprint( GetBoard()->GetFirstFootprint() );
798 } ) )
799 {
800 aEvent.Veto();
801 return false;
802 }
803 }
804
805 PAD_TOOL* padTool = m_toolManager->GetTool<PAD_TOOL>();
806
807 if( padTool->InPadEditMode() )
808 padTool->ExitPadEditMode();
809
810 // Save footprint tree column widths
811 m_adapter->SaveSettings();
812
814}
815
816
818{
819 // No more vetos
820 GetCanvas()->SetEventDispatcher( nullptr );
822
823 // Do not show the layer manager during closing to avoid flicker
824 // on some platforms (Windows) that generate useless redraw of items in
825 // the Layer Manager
826 m_auimgr.GetPane( wxT( "LayersManager" ) ).Show( false );
827 m_auimgr.GetPane( wxT( "SelectionFilter" ) ).Show( false );
828
829 Clear_Pcb( false );
830
832
833 if( mgr->IsProjectOpen() && wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
834 {
835 GFootprintList.WriteCacheToFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
836 }
837}
838
839
840void FOOTPRINT_EDIT_FRAME::OnExitKiCad( wxCommandEvent& event )
841{
842 Kiway().OnKiCadExit();
843}
844
845
847{
848 Close();
849}
850
851
853{
855
856 aEvent.Enable( frame != nullptr );
857}
858
859
861{
863
864 FOOTPRINT* editorFootprint = GetBoard()->GetFirstFootprint();
865 bool canInsert = frame && editorFootprint && editorFootprint->GetLink() == niluuid;
866
867 // If the source was deleted, the footprint can inserted but not updated in the board.
868 if( frame && editorFootprint && editorFootprint->GetLink() != niluuid )
869 {
870 BOARD* mainpcb = frame->GetBoard();
871 canInsert = true;
872
873 // search if the source footprint was not deleted:
874 for( FOOTPRINT* candidate : mainpcb->Footprints() )
875 {
876 if( editorFootprint->GetLink() == candidate->m_Uuid )
877 {
878 canInsert = false;
879 break;
880 }
881 }
882 }
883
884 aEvent.Enable( canInsert );
885}
886
887
889{
890 // call my base class
892
893 // We have 2 panes to update.
894 // For some obscure reason, the AUI manager hides the first modified pane.
895 // So force show panes
896 wxAuiPaneInfo& tree_pane_info = m_auimgr.GetPane( m_treePane );
897 bool tree_shown = tree_pane_info.IsShown();
898 tree_pane_info.Caption( _( "Libraries" ) );
899
900 wxAuiPaneInfo& lm_pane_info = m_auimgr.GetPane( m_appearancePanel );
901 bool lm_shown = lm_pane_info.IsShown();
902 lm_pane_info.Caption( _( "Appearance" ) );
903 wxAuiPaneInfo& sf_pane_info = m_auimgr.GetPane( m_selectionFilterPanel );
904 sf_pane_info.Caption( _( "Selection Filter" ) );
905
906 // update the layer manager
908
909 // Now restore the visibility:
910 lm_pane_info.Show( lm_shown );
911 tree_pane_info.Show( tree_shown );
912 m_auimgr.Update();
913
915
916 UpdateTitle();
917}
918
919
921{
923 Update3DView( true, true );
925
926 if( !GetTitle().StartsWith( wxT( "*" ) ) )
927 UpdateTitle();
928}
929
930
932{
933 wxString title;
934 LIB_ID fpid = GetLoadedFPID();
935 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
936 bool writable = true;
937
939 {
940 if( IsContentModified() )
941 title = wxT( "*" );
942
943 title += footprint->GetReference();
944 title += wxS( " " ) + wxString::Format( _( "[from %s]" ), Prj().GetProjectName()
945 + wxT( "." )
946 + FILEEXT::PcbFileExtension );
947 }
948 else if( fpid.IsValid() )
949 {
950 try
951 {
953 }
954 catch( const IO_ERROR& )
955 {
956 // best efforts...
957 }
958
959 // Note: don't used GetLoadedFPID(); footprint name may have been edited
960 if( IsContentModified() )
961 title = wxT( "*" );
962
963 title += From_UTF8( footprint->GetFPID().Format().c_str() );
964
965 if( !writable )
966 title += wxS( " " ) + _( "[Read Only]" );
967 }
968 else if( !fpid.GetLibItemName().empty() )
969 {
970 // Note: don't used GetLoadedFPID(); footprint name may have been edited
971 if( IsContentModified() )
972 title = wxT( "*" );
973
974 title += From_UTF8( footprint->GetFPID().GetLibItemName().c_str() );
975 title += wxS( " " ) + _( "[Unsaved]" );
976 }
977 else
978 {
979 title = _( "[no footprint loaded]" );
980 }
981
982 title += wxT( " \u2014 " ) + _( "Footprint Editor" );
983
984 SetTitle( title );
985}
986
987
989{
991}
992
993
995{
999 UpdateTitle();
1000}
1001
1002
1004{
1006
1007 WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Footprint Libraries" ), 2 );
1008
1009 if( GFootprintList.GetCount() == 0 )
1010 GFootprintList.ReadCacheFromFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
1011
1012 GFootprintList.ReadFootprintFiles( fpTable, nullptr, &progressReporter );
1013 progressReporter.Show( false );
1014
1017
1019 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1020
1021 adapter->AddLibraries( this );
1022}
1023
1024
1026{
1028 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1029 LIB_ID target = GetTargetFPID();
1030 bool targetSelected = ( target == GetLibTree()->GetSelectedLibId() );
1031
1032 // Sync FOOTPRINT_INFO list to the libraries on disk
1033 if( aProgress )
1034 {
1035 WX_PROGRESS_REPORTER progressReporter( this, _( "Updating Footprint Libraries" ), 2 );
1036 GFootprintList.ReadFootprintFiles( fpTable, nullptr, &progressReporter );
1037 progressReporter.Show( false );
1038 }
1039 else
1040 {
1041 GFootprintList.ReadFootprintFiles( fpTable, nullptr, nullptr );
1042 }
1043
1044 // Unselect before syncing to avoid null reference in the adapter
1045 // if a selected item is removed during the sync
1046 GetLibTree()->Unselect();
1047
1048 // Sync the LIB_TREE to the FOOTPRINT_INFO list
1049 adapter->Sync( fpTable );
1050
1051 GetLibTree()->Regenerate( true );
1052
1053 if( target.IsValid() )
1054 {
1055 if( adapter->FindItem( target ) )
1056 {
1057 if( targetSelected )
1058 GetLibTree()->SelectLibId( target );
1059 else
1060 GetLibTree()->CenterLibId( target );
1061 }
1062 else
1063 {
1064 // Try to focus on parent
1065 target.SetLibItemName( wxEmptyString );
1066 GetLibTree()->CenterLibId( target );
1067 }
1068 }
1069}
1070
1071
1073{
1075}
1076
1077
1079{
1080 GetLibTree()->SelectLibId( aLibID );
1081}
1082
1083
1085{
1087}
1088
1089
1091{
1092 // Create the manager and dispatcher & route draw panel events to the dispatcher
1095 GetCanvas()->GetViewControls(), config(), this );
1096 m_actions = new PCB_ACTIONS();
1098
1100
1110 m_toolManager->RegisterTool( new PCB_CONTROL ); // copy/paste
1122
1123 for( TOOL_BASE* tool : m_toolManager->Tools() )
1124 {
1125 if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
1126 pcbTool->SetIsFootprintEditor( true );
1127 }
1128
1129 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
1131
1132 m_toolManager->InvokeTool( "pcbnew.InteractiveSelection" );
1133
1134 // Load or reload wizard plugins in case they changed since the last time the frame opened
1135 // Because the board editor has also a plugin python menu,
1136 // call the PCB_EDIT_FRAME RunAction() if the board editor is running
1137 // Otherwise run the current RunAction().
1138 PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1139
1140 if( pcbframe )
1142 else
1144}
1145
1146
1148{
1150
1152 PCB_EDITOR_CONDITIONS cond( this );
1153
1154 wxASSERT( mgr );
1155
1156#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1157#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1158
1159 auto haveFootprintCond =
1160 [this]( const SELECTION& )
1161 {
1162 return GetBoard() && GetBoard()->GetFirstFootprint() != nullptr;
1163 };
1164
1165 auto footprintTargettedCond =
1166 [this]( const SELECTION& )
1167 {
1168 return !GetTargetFPID().GetLibItemName().empty();
1169 };
1170
1171 mgr->SetConditions( ACTIONS::saveAs, ENABLE( footprintTargettedCond ) );
1174
1177
1181 mgr->SetConditions( ACTIONS::millimetersUnits, CHECK( cond.Units( EDA_UNITS::MILLIMETRES ) ) );
1182 mgr->SetConditions( ACTIONS::inchesUnits, CHECK( cond.Units( EDA_UNITS::INCHES ) ) );
1183 mgr->SetConditions( ACTIONS::milsUnits, CHECK( cond.Units( EDA_UNITS::MILS ) ) );
1184
1185 mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
1186 mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
1193
1200
1204
1207
1208 auto constrainedDrawingModeCond =
1209 [this]( const SELECTION& )
1210 {
1211 return GetSettings()->m_Use45Limit;
1212 };
1213
1214 auto highContrastCond =
1215 [this]( const SELECTION& )
1216 {
1217 return GetDisplayOptions().m_ContrastModeDisplay != HIGH_CONTRAST_MODE::NORMAL;
1218 };
1219
1220 auto boardFlippedCond =
1221 [this]( const SELECTION& )
1222 {
1223 return GetCanvas() && GetCanvas()->GetView()->IsMirroredX();
1224 };
1225
1226 auto libraryTreeCond =
1227 [this](const SELECTION& )
1228 {
1229 return IsLibraryTreeShown();
1230 };
1231
1232 auto layerManagerCond =
1233 [this]( const SELECTION& )
1234 {
1235 return m_auimgr.GetPane( "LayersManager" ).IsShown();
1236 };
1237
1238 auto propertiesCond =
1239 [this] ( const SELECTION& )
1240 {
1241 return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
1242 };
1243
1244 mgr->SetConditions( PCB_ACTIONS::toggleHV45Mode, CHECK( constrainedDrawingModeCond ) );
1245 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
1246 mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
1248
1249 mgr->SetConditions( ACTIONS::showLibraryTree, CHECK( libraryTreeCond ) );
1250 mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
1251 mgr->SetConditions( PCB_ACTIONS::showProperties, CHECK( propertiesCond ) );
1252
1253 mgr->SetConditions( ACTIONS::print, ENABLE( haveFootprintCond ) );
1254 mgr->SetConditions( PCB_ACTIONS::exportFootprint, ENABLE( haveFootprintCond ) );
1255 mgr->SetConditions( PCB_ACTIONS::placeImportedGraphics, ENABLE( haveFootprintCond ) );
1256
1257 mgr->SetConditions( PCB_ACTIONS::footprintProperties, ENABLE( haveFootprintCond ) );
1258 mgr->SetConditions( PCB_ACTIONS::editTextAndGraphics, ENABLE( haveFootprintCond ) );
1259 mgr->SetConditions( PCB_ACTIONS::checkFootprint, ENABLE( haveFootprintCond ) );
1260 mgr->SetConditions( PCB_ACTIONS::repairFootprint, ENABLE( haveFootprintCond ) );
1261 mgr->SetConditions( PCB_ACTIONS::cleanupGraphics, ENABLE( haveFootprintCond ) );
1262
1263 auto isArcKeepCenterMode =
1264 [this]( const SELECTION& )
1265 {
1266 return GetSettings()->m_ArcEditMode == ARC_EDIT_MODE::KEEP_CENTER_ADJUST_ANGLE_RADIUS;
1267 };
1268
1269 auto isArcKeepEndpointMode =
1270 [this]( const SELECTION& )
1271 {
1272 return GetSettings()->m_ArcEditMode == ARC_EDIT_MODE::KEEP_ENDPOINTS_OR_START_DIRECTION;
1273 };
1274
1275 mgr->SetConditions( PCB_ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
1276 mgr->SetConditions( PCB_ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
1277
1278
1279// Only enable a tool if the part is edtable
1280#define CURRENT_EDIT_TOOL( action ) \
1281 mgr->SetConditions( action, ACTION_CONDITIONS().Enable( haveFootprintCond ) \
1282 .Check( cond.CurrentTool( action ) ) )
1283
1304
1305#undef CURRENT_EDIT_TOOL
1306#undef ENABLE
1307#undef CHECK
1308}
1309
1310
1312{
1314
1315 // Be sure the axis are enabled
1316 GetCanvas()->GetGAL()->SetAxesEnabled( true );
1317
1318 UpdateView();
1319
1320 // Ensure the m_Layers settings are using the canvas type:
1322}
1323
1324
1325void FOOTPRINT_EDIT_FRAME::CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged )
1326{
1327 PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1328
1330 GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
1331
1332 GetBoard()->GetDesignSettings() = cfg->m_DesignSettings;
1333
1337
1339
1340 if( aEnvVarsChanged )
1341 SyncLibraryTree( true );
1342
1343 Layout();
1344 SendSizeEvent();
1345}
1346
1347
1349{
1350 LIB_ID id = GetLoadedFPID();
1351
1352 if( id.empty() )
1353 {
1354 DisplayErrorMessage( this, _( "No footprint selected." ) );
1355 return;
1356 }
1357
1358 wxFileName fn( id.GetLibItemName() );
1359 fn.SetExt( wxT( "png" ) );
1360
1361 wxString projectPath = wxPathOnly( Prj().GetProjectFullName() );
1362
1363 wxFileDialog dlg( this, _( "Export View as PNG" ), projectPath, fn.GetFullName(),
1364 FILEEXT::PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1365
1366 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetPath().IsEmpty() )
1367 return;
1368
1369 // calling wxYield is mandatory under Linux, after closing the file selector dialog
1370 // to refresh the screen before creating the PNG or JPEG image from screen
1371 wxYield();
1372 this->SaveCanvasImageToFile( dlg.GetPath(), BITMAP_TYPE::PNG );
1373}
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:177
static TOOL_ACTION paste
Definition: actions.h:72
static TOOL_ACTION millimetersUnits
Definition: actions.h:185
static TOOL_ACTION unselectAll
Definition: actions.h:75
static TOOL_ACTION revert
Definition: actions.h:55
static TOOL_ACTION showLibraryTree
Definition: actions.h:144
static TOOL_ACTION saveAs
Definition: actions.h:52
static TOOL_ACTION copy
Definition: actions.h:71
static TOOL_ACTION pluginsReload
Definition: actions.h:229
static TOOL_ACTION pasteSpecial
Definition: actions.h:73
static TOOL_ACTION milsUnits
Definition: actions.h:184
static TOOL_ACTION toggleBoundingBoxes
Definition: actions.h:137
static TOOL_ACTION undo
Definition: actions.h:68
static TOOL_ACTION duplicate
Definition: actions.h:76
static TOOL_ACTION inchesUnits
Definition: actions.h:183
static TOOL_ACTION highContrastMode
Definition: actions.h:135
static TOOL_ACTION embeddedFiles
Definition: actions.h:232
static TOOL_ACTION toggleCursorStyle
Definition: actions.h:134
static TOOL_ACTION measureTool
Definition: actions.h:193
static TOOL_ACTION doDelete
Definition: actions.h:77
static TOOL_ACTION selectionTool
Definition: actions.h:192
static TOOL_ACTION save
Definition: actions.h:51
static TOOL_ACTION zoomFitScreen
Definition: actions.h:126
static TOOL_ACTION redo
Definition: actions.h:69
static TOOL_ACTION deleteTool
Definition: actions.h:78
static TOOL_ACTION zoomTool
Definition: actions.h:129
static TOOL_ACTION print
Definition: actions.h:57
static TOOL_ACTION showProperties
Definition: actions.h:206
static TOOL_ACTION cut
Definition: actions.h:70
static TOOL_ACTION gridSetOrigin
Definition: actions.h:174
static TOOL_ACTION ddAddLibrary
Definition: actions.h:60
static TOOL_ACTION toggleGridOverrides
Definition: actions.h:178
static TOOL_ACTION selectAll
Definition: actions.h:74
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:175
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:79
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:289
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:301
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:777
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition: board.cpp:591
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:447
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition: board.cpp:806
const FOOTPRINTS & Footprints() const
Definition: board.h:330
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition: board.cpp:789
void SetCopperLayerCount(int aCount)
Definition: board.cpp:739
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition: board.cpp:1377
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:874
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:541
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)
void FocusLibraryTreeInput() override
void ToggleLibraryTree() override
BOARD_ITEM_CONTAINER * GetModel() const override
LIB_TREE * GetLibTree() 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)
void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings) override
bool SaveFootprint(FOOTPRINT *aFootprint)
Save in an existing library a given footprint.
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
bool IsLibraryTreeShown() const override
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:105
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 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.
void FocusSearchFieldIfExists()
Focus the search widget if it exists.
bool FixUuids()
Old footprints do not always have a valid UUID (some can be set to null uuid) However null UUIDs,...
Definition: footprint.cpp:645
ZONES & Zones()
Definition: footprint.h:201
EDA_ITEM * Clone() const override
Invoke a function on all children.
Definition: footprint.cpp:2032
PADS & Pads()
Definition: footprint.h:195
const LIB_ID & GetFPID() const
Definition: footprint.h:237
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:1535
KIID GetLink() const
Definition: footprint.h:841
const wxString & GetReference() const
Definition: footprint.h:591
DRAWINGS & GraphicalItems()
Definition: footprint.h:198
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: footprint.cpp:1248
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:804
bool IsMirroredX() const
Return true if view is flipped across the X axis.
Definition: view.h:251
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition: view.h:625
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
Module editor specific tools.
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
void RefreshLibTree()
Refreshes the tree (mainly to update highlighting and asterisking)
Definition: lib_tree.cpp:440
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:422
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:778
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:512
static TOOL_ACTION drawRuleArea
Definition: pcb_actions.h:218
static TOOL_ACTION placeText
Definition: pcb_actions.h:203
static TOOL_ACTION pointEditorArcKeepCenter
Definition: pcb_actions.h:293
static TOOL_ACTION drawOrthogonalDimension
Definition: pcb_actions.h:214
static TOOL_ACTION drawRectangle
Definition: pcb_actions.h:199
static TOOL_ACTION setAnchor
Definition: pcb_actions.h:225
static TOOL_ACTION padDisplayMode
Definition: pcb_actions.h:330
static TOOL_ACTION placeReferenceImage
Definition: pcb_actions.h:202
static TOOL_ACTION showLayersManager
Definition: pcb_actions.h:442
static TOOL_ACTION drawCircle
Definition: pcb_actions.h:200
static TOOL_ACTION mirrorH
Mirroring of selected items.
Definition: pcb_actions.h:139
static TOOL_ACTION exportFootprint
Definition: pcb_actions.h:464
static TOOL_ACTION drawTextBox
Definition: pcb_actions.h:204
static TOOL_ACTION drawPolygon
Definition: pcb_actions.h:198
static TOOL_ACTION placePad
Activation of the drawing tool (placing a PAD)
Definition: pcb_actions.h:472
static TOOL_ACTION group
Definition: pcb_actions.h:520
static TOOL_ACTION drawRadialDimension
Definition: pcb_actions.h:213
static TOOL_ACTION editTextAndGraphics
Definition: pcb_actions.h:412
static TOOL_ACTION drawLeader
Definition: pcb_actions.h:215
static TOOL_ACTION ddImportFootprint
Definition: pcb_actions.h:578
static TOOL_ACTION ungroup
Definition: pcb_actions.h:521
static TOOL_ACTION placeImportedGraphics
Definition: pcb_actions.h:224
static TOOL_ACTION drawArc
Definition: pcb_actions.h:201
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
Definition: pcb_actions.h:484
static TOOL_ACTION pointEditorArcKeepEndpoint
Definition: pcb_actions.h:294
static TOOL_ACTION drawCenterDimension
Definition: pcb_actions.h:212
static TOOL_ACTION footprintProperties
Definition: pcb_actions.h:466
static TOOL_ACTION flipBoard
Definition: pcb_actions.h:383
static TOOL_ACTION textOutlines
Display texts as lines.
Definition: pcb_actions.h:487
static TOOL_ACTION checkFootprint
Definition: pcb_actions.h:469
static TOOL_ACTION mirrorV
Definition: pcb_actions.h:140
static TOOL_ACTION repairFootprint
Definition: pcb_actions.h:538
static TOOL_ACTION drawLine
Definition: pcb_actions.h:197
static TOOL_ACTION cleanupGraphics
Definition: pcb_actions.h:416
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:211
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:62
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:150
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:302
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
std::vector< TOOL_BASE * > Tools()
Definition: tool_manager.h:337
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:130
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:195
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:403
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define FOOTPRINT_EDIT_FRAME_NAME
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: unix/app.cpp:90
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: unix/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.