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 The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software: you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation, either version 3 of the License, or (at your
12 * option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License 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"
39#include <bitmaps.h>
40#include <board.h>
41#include <footprint.h>
42#include <confirm.h>
45#include <footprint_info_impl.h>
48#include <kiface_base.h>
49#include <kiplatform/app.h>
50#include <kiway.h>
51#include <macros.h>
52#include <pcbnew_id.h>
53#include <pgm_base.h>
54#include <project.h>
55#include <project_pcb.h>
57#include <tool/action_toolbar.h>
58#include <tool/common_control.h>
59#include <tool/common_tools.h>
61#include <tool/selection.h>
64#include <tool/tool_manager.h>
65#include <tool/zoom_tool.h>
66#include <tools/array_tool.h>
73#include <widgets/lib_tree.h>
80
81#include <wx/filedlg.h>
82#include <wx/hyperlink.h>
83
84BEGIN_EVENT_TABLE( FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME )
85 EVT_MENU( wxID_CLOSE, FOOTPRINT_EDIT_FRAME::CloseFootprintEditor )
86 EVT_MENU( wxID_EXIT, FOOTPRINT_EDIT_FRAME::OnExitKiCad )
87
89
92
94
95 // Drop files event
96 EVT_DROP_FILES( FOOTPRINT_EDIT_FRAME::OnDropFiles )
97
98END_EVENT_TABLE()
99
100
101FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
102 PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
103 wxDefaultPosition, wxDefaultSize,
106{
107 m_showBorderAndTitleBlock = false; // true to show the frame references
108 m_aboutTitle = _HKI( "KiCad Footprint Editor" );
109 m_editorSettings = nullptr;
110
111 // Give an icon
112 wxIcon icon;
113 wxIconBundle icon_bundle;
114
115 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 48 ) );
116 icon_bundle.AddIcon( icon );
117 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 128 ) );
118 icon_bundle.AddIcon( icon );
119 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 256 ) );
120 icon_bundle.AddIcon( icon );
121 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_32 ) );
122 icon_bundle.AddIcon( icon );
123 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_16 ) );
124 icon_bundle.AddIcon( icon );
125
126 SetIcons( icon_bundle );
127
128 // Create GAL canvas
130
131 PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
133 SetCanvas( drawPanel );
134
136
137 SetBoard( new BOARD() );
138
139 // This board will only be used to hold a footprint for editing
141
142 // In Footprint Editor, the default net clearance is not known (it depends on the actual
143 // board). So we do not show the default clearance, by setting it to 0. The footprint or
144 // pad specific clearance will be shown.
146
147 // Don't show the default board solder mask expansion in the footprint editor. Only the
148 // footprint or pad mask expansions settings should be shown.
150
151 // Ensure all layers and items are visible:
152 // In footprint editor, some layers have no meaning or cannot be used, but we show all of
153 // them, at least to be able to edit a bad layer
155
156 GetGalDisplayOptions().m_axesEnabled = true;
157
158 // In Footprint Editor, set the default paper size to A4 for plot/print
160 SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS ) ) );
161
162 // Create the manager and dispatcher & route draw panel events to the dispatcher
163 setupTools();
165
167 m_treePane = new FOOTPRINT_TREE_PANE( this );
168
172 ReCreateLayerBox( false );
173
175
177 m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas(), true );
178 m_propertiesPanel = new PCB_PROPERTIES_PANEL( this, this );
179
180 // LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
181 // parameters in m_LayersManager
182 // NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
184
186
187 float proportion = GetFootprintEditorSettings()->m_AuiPanels.properties_splitter;
188 m_propertiesPanel->SetSplitterProportion( proportion );
189
191
192 // Fetch a COPY of the config as a lot of these initializations are going to overwrite our
193 // data.
194 int libWidth = 0;
196
198 {
199 libWidth = cfg->m_LibWidth;
200 aui_cfg = cfg->m_AuiPanels;
201 }
202 else
203 {
204 // keep gcc quiet about uninitalized vars:
205 aui_cfg.appearance_panel_tab = 0;
206 aui_cfg.right_panel_width = -1;
207 }
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_tbTopMain, EDA_PANE().HToolbar().Name( "TopMainToolbar" )
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 ) );
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_tbLeft, EDA_PANE().VToolbar().Name( "LeftToolbar" )
236 .Left().Layer( 2 ) );
237
238 m_auimgr.AddPane( m_tbRight, EDA_PANE().VToolbar().Name( "RightToolbar" )
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
254
255 m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
256 m_auimgr.GetPane( "SelectionFilter" ).Show( m_show_layer_manager_tools );
257 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetSettings()->m_AuiPanels.show_properties );
258
259 // The selection filter doesn't need to grow in the vertical direction when docked
260 m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
261
264 DragAcceptFiles( true );
265
267
268 // Apply saved visibility stuff at the end
269 wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
270 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
271
272 if( libWidth > 0 )
273 SetAuiPaneSize( m_auimgr, treePane, libWidth, -1 );
274
275 if( aui_cfg.right_panel_width > 0 )
276 SetAuiPaneSize( m_auimgr, layersManager, aui_cfg.right_panel_width, -1 );
277
278 m_appearancePanel->SetTabIndex( aui_cfg.appearance_panel_tab );
279
281 {
282 m_appearancePanel->SetUserLayerPresets( cfg->m_LayerPresets );
283 m_appearancePanel->ApplyLayerPreset( cfg->m_ActiveLayerPreset );
284 }
285
286 // restore the last footprint from the project, if any, after the library has been init'ed
287 // N.B. This needs to happen after the AUI manager has been initialized so that we can
288 // properly call the WX_INFOBAR without crashing on some systems.
290
291 // This displays the last footprint loaded, if any, so it must be done after restoreLastFootprint()
293
294 GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
295 UpdateTitle();
297
299
300 // Default shutdown reason until a file is loaded
301 KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
302
303 // Catch unhandled accelerator command characters that were no handled by the library tree
304 // panel.
306 Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
307
308 // Ensure the window is on top
309 Raise();
310 Show( true );
311
312 // Register a call to update the toolbar sizes. It can't be done immediately because
313 // it seems to require some sizes calculated that aren't yet (at least on GTK).
314 CallAfter(
315 [this]()
316 {
317 // Ensure the controls on the toolbars all are correctly sized
319 m_treePane->FocusSearchFieldIfExists();
320
321 // Update the angle snap mode toolbar button to reflect the current preference
323 } );
324}
325
326
328{
329 // Shutdown all running tools
330 if( m_toolManager )
331 m_toolManager->ShutdownAllTools();
332
333 // save the footprint in the PROJECT
335
336 // Clear the watched file
337 setFPWatcher( nullptr );
338
339 // We passed ownership of these to wxAuiManager.
340 // delete m_selectionFilterPanel;
341 // delete m_appearancePanel;
342 // delete m_treePane;
343}
344
345
347{
349
350 FOOTPRINT* fp = static_cast<FOOTPRINT*>( GetModel() );
351
352 if( fp )
353 {
354 std::vector<MSG_PANEL_ITEM> msgItems;
355 fp->GetMsgPanelInfo( this, msgItems );
356 SetMsgPanel( msgItems );
357 }
358}
359
360
366
367
369{
370 return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
371}
372
373
375{
376 // switches currently used canvas (Cairo / OpenGL).
377 PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
378
379 GetCanvas()->GetGAL()->SetAxesEnabled( true );
380
381 // The base class method *does not reinit* the layers manager. We must update the layer
382 // widget to match board visibility states, both layers and render columns, and and some
383 // settings dependent on the canvas.
385}
386
387
393
394
396{
397 wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
398 treePane.Show( !IsLibraryTreeShown() );
399
400 if( IsLibraryTreeShown() )
401 {
402 // SetAuiPaneSize also updates m_auimgr
403 SetAuiPaneSize( m_auimgr, treePane, m_editorSettings->m_LibWidth, -1 );
404 }
405 else
406 {
407 m_editorSettings->m_LibWidth = m_treePane->GetSize().x;
408 m_auimgr.Update();
409 }
410}
411
412
414{
415 m_treePane->FocusSearchFieldIfExists();
416}
417
418
420{
422 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
423 wxAuiPaneInfo& selectionFilter = m_auimgr.GetPane( "SelectionFilter" );
424
425 // show auxiliary Vertical layers and visibility manager toolbar
427 layersManager.Show( m_show_layer_manager_tools );
428 selectionFilter.Show( m_show_layer_manager_tools );
429
431 {
432 SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
433 }
434 else
435 {
436 settings->m_AuiPanels.right_panel_width = m_appearancePanel->GetSize().x;
437 m_auimgr.Update();
438 }
439}
440
441
443{
444 return const_cast<wxAuiManager&>( m_auimgr ).GetPane( m_treePane ).IsShown();
445}
446
447
452
453
455{
456 LIB_ID id;
457
458 if( IsLibraryTreeShown() )
460
461 if( id.GetLibNickname().empty() )
462 id = GetLoadedFPID();
463
464 return id;
465}
466
467
469{
470 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
471
472 if( footprint )
473 return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
474 else
475 return LIB_ID();
476}
477
478
480{
481 if( GetBoard()->GetFirstFootprint() )
482 {
485 }
486
487 GetScreen()->SetContentModified( false );
488}
489
490
492{
493 // If we've already vetted closing this window, then we have no FP anymore
494 if( m_isClosing || !GetBoard() )
495 return false;
496
497 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
498
499 return ( footprint && footprint->GetLink() != niluuid );
500}
501
502
504{
505 LIB_ID id = GetLoadedFPID();
506
507 if( id.IsValid() )
508 {
510 Prj().SetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, id.GetLibItemName() );
511 }
512}
513
514
516{
517 const wxString& footprintName = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME );
518 const wxString& libNickname = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME );
519
520 if( libNickname.Length() && footprintName.Length() )
521 {
522 LIB_ID id;
523 id.SetLibNickname( libNickname );
524 id.SetLibItemName( footprintName );
525
526 FOOTPRINT* footprint = loadFootprint( id );
527
528 if( footprint )
529 AddFootprintToBoard( footprint );
530 }
531}
532
533
535{
536 FOOTPRINT* footprint = static_cast<FOOTPRINT*>( GetModel() );
537 BOARD& board = *GetBoard();
538
539 // All FPs have these layers enabled
540 LSET enabledLayers = LSET::AllTechMask() | LSET::UserMask();
541
542 const auto configureStackup = [&]( FOOTPRINT_STACKUP aMode, const LSET& aLayerSet )
543 {
544 const LSET cuLayers = aLayerSet & LSET::AllCuMask();
545 board.SetCopperLayerCount( cuLayers.count() );
546
547 switch( aMode )
548 {
550 {
551 enabledLayers |= LSET{ F_Cu, In1_Cu, B_Cu };
552 enabledLayers |= LSET::UserDefinedLayersMask( 4 );
553 board.SetLayerName( In1_Cu, _( "Inner layers" ) );
554 break;
555 }
557 {
558 // Nothing extra to add
559
560 // Clear layer name defaults
561 board.SetLayerName( In1_Cu, wxEmptyString );
562 break;
563 }
564 }
565
566 enabledLayers |= aLayerSet;
567 };
568
569 if( footprint )
570 {
571 configureStackup( footprint->GetStackupMode(), footprint->GetStackupLayers() );
572 }
573 else
574 {
575 // If no footprint is loaded, we assume the default stackup mode
576 configureStackup( FOOTPRINT_STACKUP::EXPAND_INNER_LAYERS, LSET{} );
577 }
578
580 {
581 m_originalFootprintCopy->RunOnChildren(
582 [&]( BOARD_ITEM* child )
583 {
584 LSET childLayers = child->GetLayerSet() & LSET::UserDefinedLayersMask();
585
586 for( PCB_LAYER_ID layer : childLayers )
587 enabledLayers.set( layer );
588 },
590 }
591
592 // Enable any layers that the user has gone to the trouble to name
594 {
595 for( const PCB_LAYER_ID& user : LSET::UserDefinedLayersMask() )
596 {
597 if( cfg->m_DesignSettings.m_UserLayerNames.contains( LSET::Name( user ).ToStdString() ) )
598 enabledLayers.set( user );
599 }
600 }
601
602 board.SetEnabledLayers( enabledLayers );
603
604 // Footprint Editor layer visibility is kept in the view, not the board (because the board
605 // just delegates to the project file, which we don't have).
606 for( const PCB_LAYER_ID& layer : GetBoard()->GetEnabledLayers() )
607 GetCanvas()->GetView()->SetLayerVisible( layer, true );
608}
609
610
612{
614
615 m_originalFootprintCopy.reset( static_cast<FOOTPRINT*>( aFootprint->Clone() ) );
616 m_originalFootprintCopy->SetParent( nullptr );
617
619
621 // Ensure item UUIDs are valid
622 // ("old" footprints can have null uuids that create issues in fp editor)
623 aFootprint->FixUuids();
624
626
627 // Use CallAfter so that we update the canvas before waiting for the infobar animation
628 CallAfter(
629 [this]()
630 {
632 wxString libName = fp->GetFPID().GetLibNickname();
633 wxString msg, link;
634
636 {
637 msg.Printf( _( "Editing %s from board. Saving will update the board only." ), fp->GetReference() );
638 link.Printf( _( "Open in library %s" ), UnescapeString( libName ) );
639
640 const auto openLibraryCopy =
641 [this]( wxHyperlinkEvent& aEvent )
642 {
644 };
645
646 if( WX_INFOBAR* infobar = GetInfoBar() )
647 {
648 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, link, wxEmptyString );
649 button->Bind( wxEVT_COMMAND_HYPERLINK, openLibraryCopy );
650
651 infobar->RemoveAllButtons();
652 infobar->AddButton( button );
653 infobar->AddCloseButton();
654 infobar->ShowMessage( msg, wxICON_INFORMATION );
655 }
656 }
657 // An empty libname is OK - you get that when creating a new footprint from the main menu
658 // In that case. treat is as editable, and the user will be prompted for save-as when saving.
659 else if( !libName.empty()
660 && !PROJECT_PCB::FootprintLibAdapter( &Prj() )->IsFootprintLibWritable( libName ) )
661 {
662 msg.Printf( _( "Editing footprint from read-only library %s." ), UnescapeString( libName ) );
663
664 if( WX_INFOBAR* infobar = GetInfoBar() )
665 {
666 link = _( "Save as editable copy" );
667
668 const auto saveAsEditableCopy =
669 [this]( wxHyperlinkEvent& aEvent )
670 {
671 SaveFootprintAs( GetBoard()->GetFirstFootprint() );
672 GetCanvas()->GetView()->Update( GetBoard()->GetFirstFootprint() );
673 ClearModify();
674
675 // Get rid of the save-will-update-board-only (or any other dismissable warning)
676 WX_INFOBAR* infobar = GetInfoBar();
677
678 if( infobar->IsShownOnScreen() && infobar->HasCloseButton() )
679 infobar->Dismiss();
680
682 SyncLibraryTree( true );
683 };
684
685 wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, link, wxEmptyString );
686 button->Bind( wxEVT_COMMAND_HYPERLINK, saveAsEditableCopy );
687
688 infobar->RemoveAllButtons();
689 infobar->AddButton( button );
690 infobar->AddCloseButton();
691 infobar->ShowMessage( msg, wxICON_INFORMATION );
692 }
693 }
694 else
695 {
696 if( WX_INFOBAR* infobar = GetInfoBar() )
697 infobar->Dismiss();
698 }
699 } );
700
703}
704
705
707{
708 ReloadFootprint( aFootprint );
709
711 setFPWatcher( nullptr );
712 else
713 setFPWatcher( aFootprint );
714}
715
716
721
722
727
728
730{
731 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
732
734}
735
736
738{
739 wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
740}
741
742
750
751
759
760
762{
763 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
764 // compile unit
766
767 if( cfg )
768 {
770
772
775
777 m_selectionFilterPanel->SetCheckboxesFromFilter( cfg->m_SelectionFilter );
778
780
781 for( auto& [source_name, dest_name] : cfg->m_DesignSettings.m_UserLayerNames )
782 {
783 wxString wx_source_name = source_name;
784 PCB_LAYER_ID layer = static_cast<PCB_LAYER_ID>( LSET::NameToLayer( wx_source_name ) );
785
786 if( IsUserLayer( layer ) )
787 GetBoard()->SetLayerName( layer, dest_name );
788 }
789
790 }
791}
792
793
795{
796 // Load canvas type from the FOOTPRINT_EDITOR_SETTINGS:
798
799 // If we had an OpenGL failure this session, use the fallback GAL but don't update the
800 // user preference silently:
801
804}
805
806
808{
810
811 // Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
812 // compile unit
814
815 if( cfg )
816 {
818
821 cfg->m_LibWidth = m_treePane->GetSize().x;
823
825
827 {
828 cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
830 cfg->m_AuiPanels.properties_splitter = m_propertiesPanel->SplitterProportion();
831 }
832
834
836 {
839 cfg->m_LayerPresets = m_appearancePanel->GetUserLayerPresets();
840 cfg->m_ActiveLayerPreset = m_appearancePanel->GetActiveLayerPreset();
841 }
842 }
843}
844
845
846
848{
849 FOOTPRINT_EDITOR_SETTINGS* cfg = const_cast<FOOTPRINT_EDIT_FRAME*>( this )->GetSettings();
850
851 return cfg ? cfg->m_RotationAngle : ANGLE_90;
852}
853
854
855
857{
859 return ::GetColorSettings( cfg ? cfg->m_ColorTheme : DEFAULT_THEME );
860}
861
862
864{
865 static MAGNETIC_SETTINGS fallback;
866
868 return &cfg->m_MagneticItems;
869
870 return &fallback;
871}
872
873
874const BOX2I FOOTPRINT_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
875{
876 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
877
878 if( footprint )
879 {
880 bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
881
882 if( !hasGraphicalItem )
883 {
884 for( const BOARD_ITEM* item : footprint->GraphicalItems() )
885 {
886 if( item->Type() == PCB_TEXT_T || item->Type() == PCB_TEXTBOX_T )
887 continue;
888
889 hasGraphicalItem = true;
890 break;
891 }
892 }
893
894 if( hasGraphicalItem )
895 {
896 return footprint->GetBoundingBox( false );
897 }
898 else
899 {
900 BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
901 newFootprintBB.Inflate( pcbIUScale.mmToIU( 12 ) );
902 return newFootprintBB;
903 }
904 }
905
906 return GetBoardBoundingBox( false );
907}
908
909
911{
912 if( IsContentModified() )
913 {
914 wxString footprintName = GetBoard()->GetFirstFootprint()->GetReference();
915 wxString msg = _( "Save changes to '%s' before closing?" );
916
917 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
918 [&]() -> bool
919 {
920 return SaveFootprint( GetBoard()->GetFirstFootprint() );
921 } ) )
922 {
923 return false;
924 }
925 }
926
927 if( doClose )
928 {
929 GetInfoBar()->ShowMessageFor( wxEmptyString, 1 );
930 Clear_Pcb( false );
931 UpdateTitle();
932 }
933
934 return true;
935}
936
937
938bool FOOTPRINT_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
939{
940 if( IsContentModified() )
941 {
942 // Shutdown blocks must be determined and vetoed as early as possible
944 aEvent.GetId() == wxEVT_QUERY_END_SESSION )
945 {
946 aEvent.Veto();
947 return false;
948 }
949
950 wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
951
953 footprintName = GetBoard()->GetFirstFootprint()->GetReference();
954
955 wxString msg = _( "Save changes to '%s' before closing?" );
956
957 if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
958 [&]() -> bool
959 {
960 return SaveFootprint( GetBoard()->GetFirstFootprint() );
961 } ) )
962 {
963 aEvent.Veto();
964 return false;
965 }
966 }
967
968 PAD_TOOL* padTool = m_toolManager->GetTool<PAD_TOOL>();
969
970 if( padTool->InPadEditMode() )
971 padTool->ExitPadEditMode();
972
973 // Save footprint tree column widths
974 m_adapter->SaveSettings();
975
977}
978
979
981{
982 // No more vetos
983 GetCanvas()->SetEventDispatcher( nullptr );
985
986 if( GetLibTree() )
988
989 // Do not show the layer manager during closing to avoid flicker
990 // on some platforms (Windows) that generate useless redraw of items in
991 // the Layer Manager
992 m_auimgr.GetPane( wxT( "LayersManager" ) ).Show( false );
993 m_auimgr.GetPane( wxT( "SelectionFilter" ) ).Show( false );
994
995 Clear_Pcb( false );
996
998
999 if( mgr->IsProjectOpen() && wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
1000 {
1001 GFootprintList.WriteCacheToFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
1002 }
1003}
1004
1005
1006void FOOTPRINT_EDIT_FRAME::OnExitKiCad( wxCommandEvent& event )
1007{
1008 Kiway().OnKiCadExit();
1009}
1010
1011
1013{
1014 Close();
1015}
1016
1017
1019{
1020 // call my base class
1022
1023 // We have 2 panes to update.
1024 // For some obscure reason, the AUI manager hides the first modified pane.
1025 // So force show panes
1026 wxAuiPaneInfo& tree_pane_info = m_auimgr.GetPane( m_treePane );
1027 bool tree_shown = tree_pane_info.IsShown();
1028 tree_pane_info.Caption( _( "Libraries" ) );
1029
1030 wxAuiPaneInfo& lm_pane_info = m_auimgr.GetPane( m_appearancePanel );
1031 bool lm_shown = lm_pane_info.IsShown();
1032 lm_pane_info.Caption( _( "Appearance" ) );
1033 wxAuiPaneInfo& sf_pane_info = m_auimgr.GetPane( m_selectionFilterPanel );
1034 sf_pane_info.Caption( _( "Selection Filter" ) );
1035
1036 // update the layer manager
1038
1039 // Now restore the visibility:
1040 lm_pane_info.Show( lm_shown );
1041 tree_pane_info.Show( tree_shown );
1042 m_auimgr.Update();
1043
1045
1046 UpdateTitle();
1047}
1048
1049
1051{
1053
1054 if( m_isClosing )
1055 return;
1056
1057 Update3DView( true, true );
1059
1060 if( !GetTitle().StartsWith( wxT( "*" ) ) )
1061 UpdateTitle();
1062}
1063
1064
1066{
1067 wxString title;
1068 LIB_ID fpid = GetLoadedFPID();
1069 FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
1070 bool writable = true;
1071
1072 if( IsCurrentFPFromBoard() )
1073 {
1074 if( IsContentModified() )
1075 title = wxT( "*" );
1076
1077 title += footprint->GetReference();
1078 title += wxS( " " ) + wxString::Format( _( "[from %s]" ), Prj().GetProjectName()
1079 + wxT( "." )
1080 + FILEEXT::PcbFileExtension );
1081 }
1082 else if( fpid.IsValid() )
1083 {
1084 try
1085 {
1087 }
1088 catch( const IO_ERROR& )
1089 {
1090 // best efforts...
1091 }
1092
1093 // Note: don't used GetLoadedFPID(); footprint name may have been edited
1094 if( IsContentModified() )
1095 title = wxT( "*" );
1096
1097 title += From_UTF8( footprint->GetFPID().Format().c_str() );
1098
1099 if( !writable )
1100 title += wxS( " " ) + _( "[Read Only]" );
1101 }
1102 else if( !fpid.GetLibItemName().empty() )
1103 {
1104 // Note: don't used GetLoadedFPID(); footprint name may have been edited
1105 if( IsContentModified() )
1106 title = wxT( "*" );
1107
1108 title += From_UTF8( footprint->GetFPID().GetLibItemName().c_str() );
1109 title += wxS( " " ) + _( "[Unsaved]" );
1110 }
1111 else
1112 {
1113 title = _( "[no footprint loaded]" );
1114 }
1115
1116 title += wxT( " \u2014 " ) + _( "Footprint Editor" );
1117
1118 SetTitle( title );
1119}
1120
1121
1123{
1124 m_appearancePanel->OnBoardChanged();
1125}
1126
1127
1129{
1133 m_propertiesPanel->UpdateData();
1134 UpdateTitle();
1135}
1136
1137
1139{
1141
1142 WX_PROGRESS_REPORTER progressReporter( this, _( "Load Footprint Libraries" ), 1, PR_CAN_ABORT );
1143
1144 if( GFootprintList.GetCount() == 0 )
1145 GFootprintList.ReadCacheFromFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
1146
1147 GFootprintList.ReadFootprintFiles( footprints, nullptr, &progressReporter );
1148 progressReporter.Show( false );
1149
1150 if( GFootprintList.GetErrorCount() )
1151 GFootprintList.DisplayErrors( this );
1152
1154 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1155
1156 adapter->AddLibraries( this );
1157}
1158
1159
1161{
1163 auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
1164 LIB_ID target = GetTargetFPID();
1165 bool targetSelected = ( target == GetLibTree()->GetSelectedLibId() );
1166
1167 // Sync FOOTPRINT_INFO list to the libraries on disk
1168 if( aProgress )
1169 {
1170 WX_PROGRESS_REPORTER progressReporter( this, _( "Update Footprint Libraries" ), 1, PR_CAN_ABORT );
1171 GFootprintList.ReadFootprintFiles( footprints, nullptr, &progressReporter );
1172 progressReporter.Show( false );
1173 }
1174 else
1175 {
1176 GFootprintList.ReadFootprintFiles( footprints, nullptr, nullptr );
1177 }
1178
1179 // Unselect before syncing to avoid null reference in the adapter
1180 // if a selected item is removed during the sync
1181 GetLibTree()->Unselect();
1182
1183 // Sync the LIB_TREE to the FOOTPRINT_INFO list
1184 adapter->Sync( footprints );
1185
1186 GetLibTree()->Regenerate( true );
1187
1188 if( target.IsValid() )
1189 {
1190 if( adapter->FindItem( target ) )
1191 {
1192 if( targetSelected )
1193 GetLibTree()->SelectLibId( target );
1194 else
1195 GetLibTree()->CenterLibId( target );
1196 }
1197 else
1198 {
1199 // Try to focus on parent
1200 target.SetLibItemName( wxEmptyString );
1201 GetLibTree()->CenterLibId( target );
1202 }
1203 }
1204}
1205
1206
1211
1212
1214{
1215 GetLibTree()->SelectLibId( aLibID );
1216}
1217
1218
1220{
1221 m_appearancePanel->UpdateDisplayOptions();
1222}
1223
1224
1226{
1227 // Create the manager and dispatcher & route draw panel events to the dispatcher
1229 m_toolManager->SetEnvironment( GetBoard(), GetCanvas()->GetView(),
1230 GetCanvas()->GetViewControls(), config(), this );
1231 m_actions = new PCB_ACTIONS();
1233
1235
1236 m_toolManager->RegisterTool( new COMMON_CONTROL );
1237 m_toolManager->RegisterTool( new COMMON_TOOLS );
1238 m_toolManager->RegisterTool( new PCB_SELECTION_TOOL );
1239 m_toolManager->RegisterTool( new ZOOM_TOOL );
1240 m_toolManager->RegisterTool( new EDIT_TOOL );
1241 m_toolManager->RegisterTool( new PCB_EDIT_TABLE_TOOL );
1242 m_toolManager->RegisterTool( new PAD_TOOL );
1243 m_toolManager->RegisterTool( new DRAWING_TOOL );
1244 m_toolManager->RegisterTool( new PCB_POINT_EDITOR );
1245 m_toolManager->RegisterTool( new PCB_CONTROL ); // copy/paste
1246 m_toolManager->RegisterTool( new LIBRARY_EDITOR_CONTROL );
1247 m_toolManager->RegisterTool( new FOOTPRINT_EDITOR_CONTROL );
1248 m_toolManager->RegisterTool( new ALIGN_DISTRIBUTE_TOOL );
1249 m_toolManager->RegisterTool( new PCB_PICKER_TOOL );
1250 m_toolManager->RegisterTool( new POSITION_RELATIVE_TOOL );
1251 m_toolManager->RegisterTool( new ARRAY_TOOL );
1252 m_toolManager->RegisterTool( new PCB_VIEWER_TOOLS );
1253 m_toolManager->RegisterTool( new PCB_GROUP_TOOL );
1254 m_toolManager->RegisterTool( new CONVERT_TOOL );
1255 m_toolManager->RegisterTool( new SCRIPTING_TOOL );
1256 m_toolManager->RegisterTool( new PROPERTIES_TOOL );
1257 m_toolManager->RegisterTool( new EMBED_TOOL );
1258
1259 for( TOOL_BASE* tool : m_toolManager->Tools() )
1260 {
1261 if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
1262 pcbTool->SetIsFootprintEditor( true );
1263 }
1264
1265 m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
1266 m_toolManager->InitTools();
1267
1268 m_toolManager->InvokeTool( "common.InteractiveSelection" );
1269
1270 // Load or reload wizard plugins in case they changed since the last time the frame opened
1271 // Because the board editor has also a plugin python menu,
1272 // call the PCB_EDIT_FRAME RunAction() if the board editor is running
1273 // Otherwise run the current RunAction().
1274 PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1275
1276 if( pcbframe )
1278 else
1280}
1281
1282
1284{
1286
1287 ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
1288 PCB_EDITOR_CONDITIONS cond( this );
1289
1290 wxASSERT( mgr );
1291
1292#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
1293#define CHECK( x ) ACTION_CONDITIONS().Check( x )
1294
1295 auto haveFootprintCond =
1296 [this]( const SELECTION& )
1297 {
1298 return GetBoard() && GetBoard()->GetFirstFootprint() != nullptr;
1299 };
1300
1301 auto footprintTargettedCond =
1302 [this]( const SELECTION& )
1303 {
1304 return !GetTargetFPID().GetLibItemName().empty();
1305 };
1306
1307 auto footprintSelectedInTreeCond =
1308 [this]( const SELECTION& )
1309 {
1311 return !sel.GetLibNickname().empty() && !sel.GetLibItemName().empty();
1312 };
1313
1314 const auto footprintFromBoardCond =
1315 [this]( const SELECTION& )
1316 {
1317 return IsCurrentFPFromBoard();
1318 };
1319
1320 auto pcbFrameExistsCond =
1321 [this]( const SELECTION& )
1322 {
1323 PCB_EDIT_FRAME* frame = dynamic_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1324
1325 return ( frame != nullptr );
1326 };
1327
1328 auto boardFootprintExistsCond =
1329 [this]( const SELECTION& )
1330 {
1331 PCB_EDIT_FRAME* frame = dynamic_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
1332
1333 FOOTPRINT* editorFootprint = GetBoard()->GetFirstFootprint();
1334 bool canInsert = frame && editorFootprint && editorFootprint->GetLink() == niluuid;
1335
1336 // If the source was deleted, the footprint can inserted but not updated in the board.
1337 if( frame && editorFootprint && editorFootprint->GetLink() != niluuid )
1338 {
1339 BOARD* mainpcb = frame->GetBoard();
1340 canInsert = true;
1341
1342 // search if the source footprint was not deleted:
1343 for( FOOTPRINT* candidate : mainpcb->Footprints() )
1344 {
1345 if( editorFootprint->GetLink() == candidate->m_Uuid )
1346 {
1347 canInsert = false;
1348 break;
1349 }
1350 }
1351 }
1352
1353 return canInsert;
1354 };
1355
1356 // clang-format off
1357 mgr->SetConditions( ACTIONS::saveAs, ENABLE( footprintTargettedCond ) );
1360 mgr->SetConditions( PCB_ACTIONS::editLibFpInFpEditor,ENABLE( footprintFromBoardCond ) );
1361
1362 mgr->SetConditions( PCB_ACTIONS::saveFpToBoard, ENABLE( boardFootprintExistsCond ) );
1363 mgr->SetConditions( PCB_ACTIONS::loadFpFromBoard, ENABLE( pcbFrameExistsCond ) );
1364
1367
1370
1371 mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
1372 mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
1379
1386
1390
1393 // clang-format on
1394
1395 auto highContrastCond =
1396 [this]( const SELECTION& )
1397 {
1399 };
1400
1401 auto boardFlippedCond =
1402 [this]( const SELECTION& )
1403 {
1404 return GetCanvas() && GetCanvas()->GetView()->IsMirroredX();
1405 };
1406
1407 auto libraryTreeCond =
1408 [this](const SELECTION& )
1409 {
1410 return IsLibraryTreeShown();
1411 };
1412
1413 auto layerManagerCond =
1414 [this]( const SELECTION& )
1415 {
1416 return m_auimgr.GetPane( "LayersManager" ).IsShown();
1417 };
1418
1419 auto propertiesCond =
1420 [this] ( const SELECTION& )
1421 {
1422 return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
1423 };
1424
1425 mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
1426 mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
1428
1429 mgr->SetConditions( ACTIONS::showLibraryTree, CHECK( libraryTreeCond ) );
1430 mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
1431 mgr->SetConditions( ACTIONS::showProperties, CHECK( propertiesCond ) );
1432
1433 mgr->SetConditions( ACTIONS::print, ENABLE( haveFootprintCond ) );
1434 mgr->SetConditions( PCB_ACTIONS::exportFootprint, ENABLE( haveFootprintCond ) );
1435 mgr->SetConditions( PCB_ACTIONS::placeImportedGraphics, ENABLE( haveFootprintCond ) );
1436
1437 mgr->SetConditions( PCB_ACTIONS::footprintProperties, ENABLE( footprintSelectedInTreeCond || haveFootprintCond ) );
1438 mgr->SetConditions( PCB_ACTIONS::padTable, ENABLE( haveFootprintCond ) );
1439 mgr->SetConditions( PCB_ACTIONS::editTextAndGraphics, ENABLE( haveFootprintCond ) );
1440 mgr->SetConditions( PCB_ACTIONS::checkFootprint, ENABLE( haveFootprintCond ) );
1441 mgr->SetConditions( PCB_ACTIONS::repairFootprint, ENABLE( haveFootprintCond ) );
1442 mgr->SetConditions( PCB_ACTIONS::cleanupGraphics, ENABLE( haveFootprintCond ) );
1443 mgr->SetConditions( ACTIONS::showDatasheet, ENABLE( haveFootprintCond ) );
1444
1445 const auto isArcKeepCenterMode =
1446 [this]( const SELECTION& )
1447 {
1449 };
1450
1451 const auto isArcKeepEndpointMode =
1452 [this]( const SELECTION& )
1453 {
1455 };
1456
1457 const auto isArcKeepRadiusMode =
1458 [this]( const SELECTION& )
1459 {
1461 };
1462
1463 // clang-format off
1464 mgr->SetConditions( ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
1465 mgr->SetConditions( ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
1466 mgr->SetConditions( ACTIONS::pointEditorArcKeepRadius, CHECK( isArcKeepRadiusMode ) );
1467 // clang-format on
1468
1469// Only enable a tool if the part is edtable
1470#define CURRENT_EDIT_TOOL( action ) \
1471 mgr->SetConditions( action, ACTION_CONDITIONS().Enable( haveFootprintCond ) \
1472 .Check( cond.CurrentTool( action ) ) )
1473
1498
1499#undef CURRENT_EDIT_TOOL
1500#undef ENABLE
1501#undef CHECK
1502}
1503
1504
1506{
1508
1509 // Be sure the axis are enabled
1510 GetCanvas()->GetGAL()->SetAxesEnabled( true );
1511
1512 UpdateView();
1513
1514 // Ensure the m_Layers settings are using the canvas type:
1516}
1517
1518
1520{
1522
1524 {
1525 GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
1526
1527 GetBoard()->GetDesignSettings() = cfg->m_DesignSettings;
1529 }
1530
1534
1536
1537 if( aFlags & ENVVARS_CHANGED )
1538 SyncLibraryTree( true );
1539
1540 Layout();
1541 SendSizeEvent();
1542}
1543
1544
1545std::unique_ptr<GRID_HELPER> FOOTPRINT_EDIT_FRAME::MakeGridHelper()
1546{
1547 return std::make_unique<PCB_GRID_HELPER>( m_toolManager, GetMagneticItemsSettings() );
1548}
1549
1550
1552{
1553 LIB_ID id = GetLoadedFPID();
1554
1555 if( id.empty() )
1556 {
1557 DisplayErrorMessage( this, _( "No footprint selected." ) );
1558 return;
1559 }
1560
1561 wxFileName fn( id.GetLibItemName() );
1562 fn.SetExt( wxT( "png" ) );
1563
1564 wxString projectPath = wxPathOnly( Prj().GetProjectFullName() );
1565
1566 wxFileDialog dlg( this, _( "Export View as PNG" ), projectPath, fn.GetFullName(),
1567 FILEEXT::PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1568
1569 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetPath().IsEmpty() )
1570 return;
1571
1572 // calling wxYield is mandatory under Linux, after closing the file selector dialog
1573 // to refresh the screen before creating the PNG or JPEG image from screen
1574 wxYield();
1575 this->SaveCanvasImageToFile( dlg.GetPath(), BITMAP_TYPE::PNG );
1576}
@ KEEP_ENDPOINTS_OR_START_DIRECTION
Whe editing endpoints, the other end remains in place.
@ KEEP_CENTER_ENDS_ADJUST_ANGLE
When editing endpoints, only the angle is adjusted.
@ KEEP_CENTER_ADJUST_ANGLE_RADIUS
When editing endpoints, the angle and radius are adjusted.
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
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_16
@ FPHOLDER
Definition board.h:314
@ NORMAL
Inactive layers are shown normally (no high-contrast mode)
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
static TOOL_ACTION toggleGrid
Definition actions.h:198
static TOOL_ACTION paste
Definition actions.h:80
static TOOL_ACTION unselectAll
Definition actions.h:83
static TOOL_ACTION revert
Definition actions.h:62
static TOOL_ACTION showLibraryTree
Definition actions.h:164
static TOOL_ACTION saveAs
Definition actions.h:59
static TOOL_ACTION copy
Definition actions.h:78
static TOOL_ACTION pluginsReload
Definition actions.h:294
static TOOL_ACTION group
Definition actions.h:239
static TOOL_ACTION pasteSpecial
Definition actions.h:81
static TOOL_ACTION showDatasheet
Definition actions.h:267
static TOOL_ACTION pointEditorArcKeepCenter
Definition actions.h:273
static TOOL_ACTION ungroup
Definition actions.h:240
static TOOL_ACTION toggleBoundingBoxes
Definition actions.h:157
static TOOL_ACTION pointEditorArcKeepRadius
Definition actions.h:275
static TOOL_ACTION undo
Definition actions.h:75
static TOOL_ACTION duplicate
Definition actions.h:84
static TOOL_ACTION highContrastMode
Definition actions.h:155
static TOOL_ACTION embeddedFiles
Definition actions.h:297
static TOOL_ACTION measureTool
Definition actions.h:252
static TOOL_ACTION doDelete
Definition actions.h:85
static TOOL_ACTION selectionTool
Definition actions.h:251
static TOOL_ACTION save
Definition actions.h:58
static TOOL_ACTION zoomFitScreen
Definition actions.h:142
static TOOL_ACTION redo
Definition actions.h:76
static TOOL_ACTION deleteTool
Definition actions.h:86
static TOOL_ACTION zoomTool
Definition actions.h:146
static TOOL_ACTION print
Definition actions.h:64
static TOOL_ACTION showProperties
Definition actions.h:266
static TOOL_ACTION cut
Definition actions.h:77
static TOOL_ACTION gridSetOrigin
Definition actions.h:195
static TOOL_ACTION ddAddLibrary
Definition actions.h:67
static TOOL_ACTION toggleGridOverrides
Definition actions.h:199
static TOOL_ACTION selectAll
Definition actions.h:82
static TOOL_ACTION pointEditorArcKeepEndpoint
Definition actions.h:274
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...
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
wxString m_ColorTheme
Active color theme name.
The array tool.
Definition array_tool.h:48
bool IsContentModified() const
Definition base_screen.h:60
void SetContentModified(bool aModified=true)
Definition base_screen.h:59
BASE_SET & set(size_t pos)
Definition base_set.h:116
Container for design settings for a BOARD object.
std::shared_ptr< NET_SETTINGS > m_NetSettings
std::map< std::string, wxString > m_UserLayerNames
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:83
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition board_item.h:256
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:322
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition board.h:334
bool SetLayerName(PCB_LAYER_ID aLayer, const wxString &aLayerName)
Changes the name of the layer given by aLayer.
Definition board.cpp:733
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition board.h:505
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition board.cpp:1003
const FOOTPRINTS & Footprints() const
Definition board.h:363
void SetCopperLayerCount(int aCount)
Definition board.cpp:912
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition board.cpp:1724
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition board.cpp:1069
void SetEnabledLayers(const LSET &aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
Definition board.cpp:974
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.
Tool responsible for drawing graphical elements like lines, arcs, circles, etc.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
virtual void UpdateToolbarControlSizes()
Update the sizes of any controls in the toolbars of the frame.
ACTION_TOOLBAR * m_tbRight
TOOLBAR_SETTINGS * m_toolbarSettings
wxAuiManager m_auimgr
virtual void RecreateToolbars()
ACTION_TOOLBAR * m_tbLeft
virtual void OnSize(wxSizeEvent &aEvent)
virtual bool canCloseWindow(wxCloseEvent &aCloseEvent)
virtual void OnDropFiles(wxDropFilesEvent &aEvent)
Handle event fired when a file is dropped to the window.
std::map< const wxString, TOOL_ACTION * > m_acceptedExts
Associate file extensions with action to execute.
ACTION_TOOLBAR * m_tbTopMain
wxString m_aboutTitle
bool m_isClosing
Set by the close window event handler after frames are asked if they can close.
void ReCreateMenuBar()
Recreate the menu bar.
WX_INFOBAR * GetInfoBar()
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
The current canvas type.
void OnSelectGrid(wxCommandEvent &event)
Command event handler for selecting grid sizes.
void setupUnits(APP_SETTINGS_BASE *aCfg)
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)
Change the current rendering backend.
virtual void OnSelectZoom(wxCommandEvent &event)
Set the zoom factor when selected by the zoom list box in the main tool bar.
GAL_DISPLAY_OPTIONS_IMPL & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
static bool m_openGLFailureOccured
Has any failure occurred when switching to OpenGL in any EDA_DRAW_FRAME?
static const wxString PropertiesPaneName()
EDA_MSG_PANEL * m_messagePanel
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
virtual void SetScreen(BASE_SCREEN *aScreen)
virtual void UpdateMsgPanel()
Redraw the message panel.
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting()
Return the canvas type stored in the application settings.
PROPERTIES_PANEL * m_propertiesPanel
bool m_showBorderAndTitleBlock
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 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.
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
Return 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)
bool SaveFootprintAs(FOOTPRINT *aFootprint)
void FocusLibraryTreeInput() override
BOARD_ITEM_CONTAINER * GetModel() const override
void ReCreateLayerBox(bool aForceResizeToolbar=true)
Re create the layer Box by clearing the old list, and building a new one from the new layers names an...
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
Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
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 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 CommonSettingsChanged(int aFlags) override
Called after the preferences dialog is run.
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
Return bounding box of document with option to not include some items.
bool Clear_Pcb(bool doAskAboutUnsavedChanges)
Delete all and reinitialize the current board.
Definition initpcb.cpp:108
FOOTPRINT_EDIT_FRAME(KIWAY *aKiway, wxWindow *aParent)
protected so only friend PCB::IFACE::CreateWindow() can act as sole factory.
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
bool CanCloseFPFromBoard(bool doClose)
void SetActiveLayer(PCB_LAYER_ID aLayer) override
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
std::unique_ptr< GRID_HELPER > MakeGridHelper() override
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.
An interface to the global shared library manager that is schematic-specific and linked to one projec...
bool IsFootprintLibWritable(const wxString &aNickname)
Return true if the library given by aNickname is writable.
Footprint Editor pane with footprint library tree.
bool FixUuids()
Old footprints do not always have a valid UUID (some can be set to null uuid) However null UUIDs,...
ZONES & Zones()
Definition footprint.h:230
EDA_ITEM * Clone() const override
Invoke a function on all children.
std::deque< PAD * > & Pads()
Definition footprint.h:224
const LIB_ID & GetFPID() const
Definition footprint.h:269
const LSET & GetStackupLayers() const
Definition footprint.h:325
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.
KIID GetLink() const
Definition footprint.h:886
const wxString & GetReference() const
Definition footprint.h:661
FOOTPRINT_STACKUP GetStackupMode() const
Definition footprint.h:318
DRAWINGS & GraphicalItems()
Definition footprint.h:227
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
void AddLibraries(EDA_BASE_FRAME *aParent)
static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > Create(FOOTPRINT_EDIT_FRAME *aFrame, FOOTPRINT_LIBRARY_ADAPTER *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.
bool m_axesEnabled
Crosshair drawing mode.
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition pcb_view.cpp:91
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition view.cpp:775
void SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
Definition view.h:400
bool IsMirroredX() const
Return true if view is flipped across the X axis.
Definition view.h:250
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
Definition view.h:639
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:292
void OnKiCadExit()
Definition kiway.cpp:756
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition kiway.cpp:403
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:111
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:100
UTF8 Format() const
Definition lib_id.cpp:119
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()
Refresh the tree (mainly to update highlighting and asterisking)
Definition lib_tree.cpp:472
void CenterLibId(const LIB_ID &aLibId)
Ensure that an item is visible (preferably centered).
Definition lib_tree.cpp:381
void ShutdownPreviews()
Definition lib_tree.cpp:287
void ShowChangedLanguage()
Definition lib_tree.cpp:304
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition lib_tree.cpp:375
LIB_TREE_MODEL_ADAPTER::SORT_MODE GetSortMode() const
Definition lib_tree.h:154
void Unselect()
Unselect currently selected item in wxDataViewCtrl.
Definition lib_tree.cpp:387
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:314
void Regenerate(bool aKeepState)
Regenerate the tree.
Definition lib_tree.cpp:454
void SetSortMode(LIB_TREE_MODEL_ADAPTER::SORT_MODE aMode)
Save/restore the sorting mode.
Definition lib_tree.h:153
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & UserMask()
Definition lset.cpp:673
static int NameToLayer(wxString &aName)
Return the layer number from a layer name.
Definition lset.cpp:117
static const LSET & AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition lset.cpp:659
static LSET UserDefinedLayersMask(int aUserDefinedLayerCount=MAX_USER_DEFINED_LAYERS)
Return a mask with the requested number of user defined layers.
Definition lset.cpp:687
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:591
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition lset.cpp:188
void SetClearance(int aClearance)
Definition netclass.h:119
std::shared_ptr< NETCLASS > GetDefaultNetclass()
Gets the default netclass for the project.
void ExitPadEditMode()
Definition pad_tool.cpp:834
bool InPadEditMode()
Definition pad_tool.h:63
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition page_info.h:79
Gather all the actions that are shared by tools.
Definition pcb_actions.h:51
static TOOL_ACTION drawRuleArea
static TOOL_ACTION drawBezier
static TOOL_ACTION placeText
static TOOL_ACTION drawOrthogonalDimension
static TOOL_ACTION drawRectangle
static TOOL_ACTION setAnchor
static TOOL_ACTION padDisplayMode
static TOOL_ACTION placeReferenceImage
static TOOL_ACTION showLayersManager
static TOOL_ACTION drawCircle
static TOOL_ACTION mirrorH
Mirroring of selected items.
static TOOL_ACTION exportFootprint
static TOOL_ACTION drawTable
static TOOL_ACTION drawTextBox
static TOOL_ACTION drawPolygon
static TOOL_ACTION placePad
Activation of the drawing tool (placing a PAD)
static TOOL_ACTION drawRadialDimension
static TOOL_ACTION padTable
static TOOL_ACTION editTextAndGraphics
static TOOL_ACTION drawLeader
static TOOL_ACTION angleSnapModeChanged
Notification event when angle mode changes.
static TOOL_ACTION ddImportFootprint
static TOOL_ACTION placeImportedGraphics
static TOOL_ACTION drawArc
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
static TOOL_ACTION loadFpFromBoard
static TOOL_ACTION drawCenterDimension
static TOOL_ACTION footprintProperties
static TOOL_ACTION flipBoard
static TOOL_ACTION textOutlines
Display texts as lines.
static TOOL_ACTION checkFootprint
static TOOL_ACTION placeBarcode
static TOOL_ACTION placePoint
static TOOL_ACTION editLibFpInFpEditor
static TOOL_ACTION mirrorV
static TOOL_ACTION repairFootprint
static TOOL_ACTION saveFpToBoard
static TOOL_ACTION drawLine
static TOOL_ACTION cleanupGraphics
static TOOL_ACTION rotateCw
Rotation of selected objects.
static TOOL_ACTION rotateCcw
static TOOL_ACTION drawAlignedDimension
virtual void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void configureToolbars() override
PCB_BASE_EDIT_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
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)
Create 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)
Attempt to load aFootprintId from the footprint library table.
const PAGE_INFO & GetPageSettings() const override
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.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const
virtual 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:129
The interactive edit tool.
static FOOTPRINT_LIBRARY_ADAPTER * FootprintLibAdapter(PROJECT *aProject)
@ PCB_FOOTPRINT_EDITOR_FP_NAME
Definition project.h:226
@ PCB_FOOTPRINT_EDITOR_LIB_NICKNAME
Definition project.h:227
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:339
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:350
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(const char *aFilename)
Return a handle to the a given settings by type.
bool IsProjectOpen() const
Helper for checking if we have a project open.
TOOL_MANAGER * m_toolManager
TOOL_DISPATCHER * m_toolDispatcher
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
ACTIONS * m_actions
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:
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
bool empty() const
Definition utf8.h:109
const char * c_str() const
Definition utf8.h:108
A modified version of the wxInfoBar class that allows us to:
Definition wx_infobar.h:76
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.
bool HasCloseButton() const
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
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:131
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition confirm.cpp:202
This file is part of the common library.
#define CHECK(x)
#define ENABLE(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:413
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define FOOTPRINT_EDIT_FRAME_NAME
@ RECURSE
Definition eda_item.h:51
FOOTPRINT_STACKUP
Definition footprint.h:91
@ EXPAND_INNER_LAYERS
The 'normal' stackup handling, where there is a single inner layer (In1) and rule areas using it expa...
Definition footprint.h:96
@ CUSTOM_LAYERS
Stackup handling where the footprint can have any number of copper layers, and objects on those layer...
Definition footprint.h:101
#define CURRENT_EDIT_TOOL(action)
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition cvpcb.cpp:138
@ FRAME_PCB_EDITOR
Definition frame_type.h:42
@ FRAME_FOOTPRINT_EDITOR
Definition frame_type.h:43
a few functions useful in geometry calculations.
static const std::string KiCadFootprintLibPathExtension
static const std::string KiCadFootprintFileExtension
static wxString PngFileWildcard()
@ ID_ON_GRID_SELECT
Definition id.h:114
@ ID_ON_ZOOM_SELECT
Definition id.h:112
PROJECT & Prj()
Definition kicad.cpp:629
KIID niluuid(0)
bool IsUserLayer(PCB_LAYER_ID aLayerId)
Test whether a layer is a non copper and a non tech layer.
Definition layer_ids.h:759
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ B_Cu
Definition layer_ids.h:65
@ F_SilkS
Definition layer_ids.h:100
@ In1_Cu
Definition layer_ids.h:66
@ F_Cu
Definition layer_ids.h:64
This file contains miscellaneous commonly used macros and functions.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition definitions.h:38
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
#define _HKI(x)
Definition page_info.cpp:44
@ ID_FPEDIT_SAVE_PNG
Definition pcbnew_id.h:80
SETTINGS_MANAGER * GetSettingsManager()
BOARD * GetBoard()
PGM_BASE & Pgm()
The global program "get" accessor.
Definition pgm_base.cpp:946
see class PGM_BASE
#define DEFAULT_THEME
T * GetToolbarSettings(const wxString &aFilename)
T * GetAppSettings(const char *aFilename)
KIWAY Kiway(KFCTL_STANDALONE)
wxString UnescapeString(const wxString &aSource)
wxString From_UTF8(const char *cstring)
#define EDIT_TOOL(tool)
#define ENVVARS_CHANGED
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition typeinfo.h:111
@ 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.
#define PR_CAN_ABORT