1386 lines
46 KiB
C++
1386 lines
46 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 2015-2016 Wayne Stambaugh <stambaughw@gmail.com>
|
|
* Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation, either version 3 of the License, or (at your
|
|
* option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "tools/convert_tool.h"
|
|
#include "tools/drawing_tool.h"
|
|
#include "tools/edit_tool.h"
|
|
#include "tools/footprint_editor_control.h"
|
|
#include "tools/pad_tool.h"
|
|
#include "tools/pcb_actions.h"
|
|
#include "tools/pcb_control.h"
|
|
#include "tools/pcb_picker_tool.h"
|
|
#include "tools/placement_tool.h"
|
|
#include "tools/pcb_point_editor.h"
|
|
#include "tools/pcb_selection_tool.h"
|
|
#include <python/scripting/pcb_scripting_tool.h>
|
|
#include <3d_viewer/eda_3d_viewer_frame.h>
|
|
#include <bitmaps.h>
|
|
#include <board.h>
|
|
#include <footprint.h>
|
|
#include <confirm.h>
|
|
#include <footprint_edit_frame.h>
|
|
#include <footprint_editor_settings.h>
|
|
#include <footprint_info_impl.h>
|
|
#include <footprint_tree_pane.h>
|
|
#include <fp_lib_table.h>
|
|
#include <gal/graphics_abstraction_layer.h>
|
|
#include <kiface_base.h>
|
|
#include <kiplatform/app.h>
|
|
#include <kiway.h>
|
|
#include <macros.h>
|
|
#include <pcb_draw_panel_gal.h>
|
|
#include <pcb_edit_frame.h>
|
|
#include <pcbnew_id.h>
|
|
#include <pgm_base.h>
|
|
#include <project.h>
|
|
#include <project_pcb.h>
|
|
#include <settings/settings_manager.h>
|
|
#include <tool/action_toolbar.h>
|
|
#include <tool/common_control.h>
|
|
#include <tool/common_tools.h>
|
|
#include <tool/properties_tool.h>
|
|
#include <tool/selection.h>
|
|
#include <tool/tool_dispatcher.h>
|
|
#include <tool/tool_manager.h>
|
|
#include <tool/zoom_tool.h>
|
|
#include <tools/pcb_editor_conditions.h>
|
|
#include <tools/pcb_viewer_tools.h>
|
|
#include <tools/group_tool.h>
|
|
#include <tools/position_relative_tool.h>
|
|
#include <widgets/appearance_controls.h>
|
|
#include <widgets/lib_tree.h>
|
|
#include <widgets/panel_selection_filter.h>
|
|
#include <widgets/pcb_properties_panel.h>
|
|
#include <widgets/wx_progress_reporters.h>
|
|
#include <wildcards_and_files_ext.h>
|
|
#include <wx/filedlg.h>
|
|
#include <widgets/wx_aui_utils.h>
|
|
|
|
BEGIN_EVENT_TABLE( FOOTPRINT_EDIT_FRAME, PCB_BASE_FRAME )
|
|
EVT_MENU( wxID_CLOSE, FOOTPRINT_EDIT_FRAME::CloseFootprintEditor )
|
|
EVT_MENU( wxID_EXIT, FOOTPRINT_EDIT_FRAME::OnExitKiCad )
|
|
|
|
EVT_SIZE( FOOTPRINT_EDIT_FRAME::OnSize )
|
|
|
|
EVT_CHOICE( ID_ON_ZOOM_SELECT, FOOTPRINT_EDIT_FRAME::OnSelectZoom )
|
|
EVT_CHOICE( ID_ON_GRID_SELECT, FOOTPRINT_EDIT_FRAME::OnSelectGrid )
|
|
|
|
EVT_TOOL( ID_FPEDIT_SAVE_PNG, FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng )
|
|
|
|
EVT_TOOL( ID_LOAD_FOOTPRINT_FROM_BOARD, FOOTPRINT_EDIT_FRAME::OnLoadFootprintFromBoard )
|
|
EVT_TOOL( ID_ADD_FOOTPRINT_TO_BOARD, FOOTPRINT_EDIT_FRAME::OnSaveFootprintToBoard )
|
|
|
|
// Horizontal toolbar
|
|
EVT_COMBOBOX( ID_TOOLBARH_PCB_SELECT_LAYER, FOOTPRINT_EDIT_FRAME::SelectLayer )
|
|
|
|
// UI update events.
|
|
EVT_UPDATE_UI( ID_LOAD_FOOTPRINT_FROM_BOARD,
|
|
FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard )
|
|
EVT_UPDATE_UI( ID_ADD_FOOTPRINT_TO_BOARD,
|
|
FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard )
|
|
EVT_UPDATE_UI( ID_TOOLBARH_PCB_SELECT_LAYER, FOOTPRINT_EDIT_FRAME::OnUpdateLayerSelectBox )
|
|
|
|
// Drop files event
|
|
EVT_DROP_FILES( FOOTPRINT_EDIT_FRAME::OnDropFiles )
|
|
|
|
END_EVENT_TABLE()
|
|
|
|
|
|
FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
|
|
PCB_BASE_EDIT_FRAME( aKiway, aParent, FRAME_FOOTPRINT_EDITOR, wxEmptyString,
|
|
wxDefaultPosition, wxDefaultSize,
|
|
KICAD_DEFAULT_DRAWFRAME_STYLE, GetFootprintEditorFrameName() ),
|
|
m_show_layer_manager_tools( true )
|
|
{
|
|
m_showBorderAndTitleBlock = false; // true to show the frame references
|
|
m_aboutTitle = _HKI( "KiCad Footprint Editor" );
|
|
m_selLayerBox = nullptr;
|
|
m_editorSettings = nullptr;
|
|
|
|
// Give an icon
|
|
wxIcon icon;
|
|
wxIconBundle icon_bundle;
|
|
|
|
icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 48 ) );
|
|
icon_bundle.AddIcon( icon );
|
|
icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 128 ) );
|
|
icon_bundle.AddIcon( icon );
|
|
icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit, 256 ) );
|
|
icon_bundle.AddIcon( icon );
|
|
icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_32 ) );
|
|
icon_bundle.AddIcon( icon );
|
|
icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit_16 ) );
|
|
icon_bundle.AddIcon( icon );
|
|
|
|
SetIcons( icon_bundle );
|
|
|
|
// Create GAL canvas
|
|
m_canvasType = loadCanvasTypeSetting( GetSettings() );
|
|
|
|
PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
|
|
GetGalDisplayOptions(), m_canvasType );
|
|
SetCanvas( drawPanel );
|
|
|
|
CreateInfoBar();
|
|
|
|
SetBoard( new BOARD() );
|
|
|
|
// This board will only be used to hold a footprint for editing
|
|
GetBoard()->SetBoardUse( BOARD_USE::FPHOLDER );
|
|
|
|
// In Footprint Editor, the default net clearance is not known (it depends on the actual
|
|
// board). So we do not show the default clearance, by setting it to 0. The footprint or
|
|
// pad specific clearance will be shown.
|
|
GetBoard()->GetDesignSettings().m_NetSettings->m_DefaultNetClass->SetClearance( 0 );
|
|
|
|
// Don't show the default board solder mask expansion in the footprint editor. Only the
|
|
// footprint or pad mask expansions settings should be shown.
|
|
GetBoard()->GetDesignSettings().m_SolderMaskExpansion = 0;
|
|
|
|
// Ensure all layers and items are visible:
|
|
// In footprint editor, some layers have no meaning or cannot be used, but we show all of
|
|
// them, at least to be able to edit a bad layer
|
|
GetBoard()->SetVisibleAlls();
|
|
|
|
GetGalDisplayOptions().m_axesEnabled = true;
|
|
|
|
// In Footprint Editor, set the default paper size to A4 for plot/print
|
|
SetPageSettings( PAGE_INFO( PAGE_INFO::A4 ) );
|
|
SetScreen( new PCB_SCREEN( GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS ) ) );
|
|
|
|
// Create the manager and dispatcher & route draw panel events to the dispatcher
|
|
setupTools();
|
|
setupUIConditions();
|
|
|
|
initLibraryTree();
|
|
m_treePane = new FOOTPRINT_TREE_PANE( this );
|
|
|
|
// restore the last footprint from the project, if any, after the library has been init'ed
|
|
restoreLastFootprint();
|
|
|
|
ReCreateMenuBar();
|
|
ReCreateHToolbar();
|
|
ReCreateVToolbar();
|
|
ReCreateOptToolbar();
|
|
|
|
m_selectionFilterPanel = new PANEL_SELECTION_FILTER( this );
|
|
m_appearancePanel = new APPEARANCE_CONTROLS( this, GetCanvas(), true );
|
|
m_propertiesPanel = new PCB_PROPERTIES_PANEL( this, this );
|
|
|
|
// LoadSettings() *after* creating m_LayersManager, because LoadSettings() initialize
|
|
// parameters in m_LayersManager
|
|
// NOTE: KifaceSettings() will return PCBNEW_SETTINGS if we started from pcbnew
|
|
LoadSettings( GetSettings() );
|
|
|
|
float proportion = GetFootprintEditorSettings()->m_AuiPanels.properties_splitter;
|
|
m_propertiesPanel->SetSplitterProportion( proportion );
|
|
|
|
// Must be set after calling LoadSettings() to be sure these parameters are not dependent
|
|
// on what is read in stored settings. Enable one internal layer, because footprints
|
|
// support keepout areas that can be on internal layers only (therefore on the first internal
|
|
// layer). This is needed to handle these keepout in internal layers only.
|
|
GetBoard()->SetCopperLayerCount( 3 );
|
|
GetBoard()->SetEnabledLayers( GetBoard()->GetEnabledLayers().set( In1_Cu ) );
|
|
GetBoard()->SetVisibleLayers( GetBoard()->GetEnabledLayers() );
|
|
GetBoard()->SetLayerName( In1_Cu, _( "Inner layers" ) );
|
|
|
|
SetActiveLayer( F_SilkS );
|
|
|
|
m_auimgr.SetManagedWindow( this );
|
|
|
|
unsigned int auiFlags = wxAUI_MGR_DEFAULT;
|
|
#if !defined( _WIN32 )
|
|
// Windows cannot redraw the UI fast enough during a live resize and may lead to all kinds
|
|
// of graphical glitches
|
|
auiFlags |= wxAUI_MGR_LIVE_RESIZE;
|
|
#endif
|
|
m_auimgr.SetFlags( auiFlags );
|
|
|
|
// Rows; layers 4 - 6
|
|
m_auimgr.AddPane( m_mainToolBar, EDA_PANE().HToolbar().Name( "MainToolbar" )
|
|
.Top().Layer( 6 ) );
|
|
|
|
m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" )
|
|
.Bottom().Layer( 6 ) );
|
|
|
|
// Columns; layers 1 - 3
|
|
m_auimgr.AddPane( m_treePane, EDA_PANE().Palette().Name( "Footprints" )
|
|
.Left().Layer( 4 )
|
|
.Caption( _( "Libraries" ) )
|
|
.MinSize( FromDIP( 250 ), -1 ).BestSize( FromDIP( 250 ), -1 ) );
|
|
m_auimgr.AddPane( m_propertiesPanel, EDA_PANE().Name( PropertiesPaneName() )
|
|
.Left().Layer( 3 )
|
|
.Caption( _( "Properties" ) ).PaneBorder( false )
|
|
.MinSize( FromDIP( wxSize( 240, 60 ) ) ).BestSize( FromDIP( wxSize( 300, 200 ) ) ) );
|
|
m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" )
|
|
.Left().Layer( 2 ) );
|
|
|
|
m_auimgr.AddPane( m_drawToolBar, EDA_PANE().VToolbar().Name( "ToolsToolbar" )
|
|
.Right().Layer(2) );
|
|
m_auimgr.AddPane( m_appearancePanel, EDA_PANE().Name( "LayersManager" )
|
|
.Right().Layer( 3 )
|
|
.Caption( _( "Appearance" ) ).PaneBorder( false )
|
|
.MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
|
|
m_auimgr.AddPane( m_selectionFilterPanel, EDA_PANE().Palette().Name( "SelectionFilter" )
|
|
.Right().Layer( 3 ).Position( 2 )
|
|
.Caption( _( "Selection Filter" ) ).PaneBorder( false )
|
|
.MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
|
|
|
|
// Center
|
|
m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" )
|
|
.Center() );
|
|
|
|
m_auimgr.GetPane( "LayersManager" ).Show( m_show_layer_manager_tools );
|
|
m_auimgr.GetPane( "SelectionFilter" ).Show( m_show_layer_manager_tools );
|
|
m_auimgr.GetPane( PropertiesPaneName() ).Show( GetSettings()->m_AuiPanels.show_properties );
|
|
|
|
// The selection filter doesn't need to grow in the vertical direction when docked
|
|
m_auimgr.GetPane( "SelectionFilter" ).dock_proportion = 0;
|
|
|
|
m_acceptedExts.emplace( FILEEXT::KiCadFootprintLibPathExtension, &ACTIONS::ddAddLibrary );
|
|
m_acceptedExts.emplace( FILEEXT::KiCadFootprintFileExtension, &PCB_ACTIONS::ddImportFootprint );
|
|
DragAcceptFiles( true );
|
|
|
|
ActivateGalCanvas();
|
|
|
|
FinishAUIInitialization();
|
|
|
|
// Apply saved visibility stuff at the end
|
|
if( FOOTPRINT_EDITOR_SETTINGS* cfg = dynamic_cast<FOOTPRINT_EDITOR_SETTINGS*>( GetSettings() ) )
|
|
{
|
|
wxAuiPaneInfo& treePane = m_auimgr.GetPane( "Footprints" );
|
|
wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
|
|
|
|
if( cfg->m_LibWidth > 0 )
|
|
SetAuiPaneSize( m_auimgr, treePane, cfg->m_LibWidth, -1 );
|
|
|
|
if( cfg->m_AuiPanels.right_panel_width > 0 )
|
|
SetAuiPaneSize( m_auimgr, layersManager, cfg->m_AuiPanels.right_panel_width, -1 );
|
|
|
|
m_appearancePanel->SetUserLayerPresets( cfg->m_LayerPresets );
|
|
m_appearancePanel->ApplyLayerPreset( cfg->m_ActiveLayerPreset );
|
|
m_appearancePanel->SetTabIndex( cfg->m_AuiPanels.appearance_panel_tab );
|
|
}
|
|
|
|
GetToolManager()->PostAction( ACTIONS::zoomFitScreen );
|
|
UpdateTitle();
|
|
setupUnits( GetSettings() );
|
|
|
|
resolveCanvasType();
|
|
|
|
// Default shutdown reason until a file is loaded
|
|
KIPLATFORM::APP::SetShutdownBlockReason( this, _( "Footprint changes are unsaved" ) );
|
|
|
|
// Catch unhandled accelerator command characters that were no handled by the library tree
|
|
// panel.
|
|
Bind( wxEVT_CHAR, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
|
|
Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher );
|
|
|
|
// Ensure the window is on top
|
|
Raise();
|
|
Show( true );
|
|
|
|
// Register a call to update the toolbar sizes. It can't be done immediately because
|
|
// it seems to require some sizes calculated that aren't yet (at least on GTK).
|
|
CallAfter(
|
|
[&]()
|
|
{
|
|
// Ensure the controls on the toolbars all are correctly sized
|
|
UpdateToolbarControlSizes();
|
|
m_treePane->FocusSearchFieldIfExists();
|
|
} );
|
|
}
|
|
|
|
|
|
FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME()
|
|
{
|
|
// Shutdown all running tools
|
|
if( m_toolManager )
|
|
m_toolManager->ShutdownAllTools();
|
|
|
|
// save the footprint in the PROJECT
|
|
retainLastFootprint();
|
|
|
|
// Clear the watched file
|
|
setFPWatcher( nullptr );
|
|
|
|
delete m_selectionFilterPanel;
|
|
delete m_appearancePanel;
|
|
delete m_treePane;
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::UpdateMsgPanel()
|
|
{
|
|
EDA_DRAW_FRAME::UpdateMsgPanel();
|
|
|
|
FOOTPRINT* fp = static_cast<FOOTPRINT*>( GetModel() );
|
|
|
|
if( fp )
|
|
{
|
|
std::vector<MSG_PANEL_ITEM> msgItems;
|
|
fp->GetMsgPanelInfo( this, msgItems );
|
|
SetMsgPanel( msgItems );
|
|
}
|
|
}
|
|
|
|
|
|
bool FOOTPRINT_EDIT_FRAME::IsContentModified() const
|
|
{
|
|
return GetScreen() && GetScreen()->IsContentModified()
|
|
&& GetBoard() && GetBoard()->GetFirstFootprint();
|
|
}
|
|
|
|
|
|
SELECTION& FOOTPRINT_EDIT_FRAME::GetCurrentSelection()
|
|
{
|
|
return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType )
|
|
{
|
|
// switches currently used canvas (Cairo / OpenGL).
|
|
PCB_BASE_FRAME::SwitchCanvas( aCanvasType );
|
|
|
|
GetCanvas()->GetGAL()->SetAxesEnabled( true );
|
|
|
|
// The base class method *does not reinit* the layers manager. We must update the layer
|
|
// widget to match board visibility states, both layers and render columns, and and some
|
|
// settings dependent on the canvas.
|
|
UpdateUserInterface();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::HardRedraw()
|
|
{
|
|
SyncLibraryTree( true );
|
|
GetCanvas()->ForceRefresh();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::ToggleSearchTree()
|
|
{
|
|
wxAuiPaneInfo& treePane = m_auimgr.GetPane( m_treePane );
|
|
treePane.Show( !IsSearchTreeShown() );
|
|
|
|
if( IsSearchTreeShown() )
|
|
{
|
|
// SetAuiPaneSize also updates m_auimgr
|
|
SetAuiPaneSize( m_auimgr, treePane, m_editorSettings->m_LibWidth, -1 );
|
|
}
|
|
else
|
|
{
|
|
m_editorSettings->m_LibWidth = m_treePane->GetSize().x;
|
|
m_auimgr.Update();
|
|
}
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::ToggleLayersManager()
|
|
{
|
|
FOOTPRINT_EDITOR_SETTINGS* settings = GetSettings();
|
|
wxAuiPaneInfo& layersManager = m_auimgr.GetPane( "LayersManager" );
|
|
wxAuiPaneInfo& selectionFilter = m_auimgr.GetPane( "SelectionFilter" );
|
|
|
|
// show auxiliary Vertical layers and visibility manager toolbar
|
|
m_show_layer_manager_tools = !m_show_layer_manager_tools;
|
|
layersManager.Show( m_show_layer_manager_tools );
|
|
selectionFilter.Show( m_show_layer_manager_tools );
|
|
|
|
if( m_show_layer_manager_tools )
|
|
{
|
|
SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
|
|
}
|
|
else
|
|
{
|
|
settings->m_AuiPanels.right_panel_width = m_appearancePanel->GetSize().x;
|
|
m_auimgr.Update();
|
|
}
|
|
}
|
|
|
|
|
|
bool FOOTPRINT_EDIT_FRAME::IsSearchTreeShown() const
|
|
{
|
|
return const_cast<wxAuiManager&>( m_auimgr ).GetPane( m_treePane ).IsShown();
|
|
}
|
|
|
|
|
|
BOARD_ITEM_CONTAINER* FOOTPRINT_EDIT_FRAME::GetModel() const
|
|
{
|
|
return GetBoard()->GetFirstFootprint();
|
|
}
|
|
|
|
|
|
LIB_ID FOOTPRINT_EDIT_FRAME::GetTreeFPID() const
|
|
{
|
|
return m_treePane->GetLibTree()->GetSelectedLibId();
|
|
}
|
|
|
|
|
|
LIB_TREE_NODE* FOOTPRINT_EDIT_FRAME::GetCurrentTreeNode() const
|
|
{
|
|
return m_treePane->GetLibTree()->GetCurrentTreeNode();
|
|
}
|
|
|
|
|
|
LIB_ID FOOTPRINT_EDIT_FRAME::GetTargetFPID() const
|
|
{
|
|
LIB_ID id;
|
|
|
|
if( IsSearchTreeShown() )
|
|
id = GetTreeFPID();
|
|
|
|
if( id.GetLibNickname().empty() )
|
|
id = GetLoadedFPID();
|
|
|
|
return id;
|
|
}
|
|
|
|
|
|
LIB_ID FOOTPRINT_EDIT_FRAME::GetLoadedFPID() const
|
|
{
|
|
FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
|
|
|
|
if( footprint )
|
|
return LIB_ID( footprint->GetFPID().GetLibNickname(), m_footprintNameWhenLoaded );
|
|
else
|
|
return LIB_ID();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::ClearModify()
|
|
{
|
|
if( GetBoard()->GetFirstFootprint() )
|
|
{
|
|
m_footprintNameWhenLoaded =
|
|
GetBoard()->GetFirstFootprint()->GetFPID().GetUniStringLibItemName();
|
|
}
|
|
|
|
GetScreen()->SetContentModified( false );
|
|
}
|
|
|
|
|
|
bool FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard() const
|
|
{
|
|
// If we've already vetted closing this window, then we have no FP anymore
|
|
if( m_isClosing || !GetBoard() )
|
|
return false;
|
|
|
|
FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
|
|
|
|
return ( footprint && footprint->GetLink() != niluuid );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::retainLastFootprint()
|
|
{
|
|
LIB_ID id = GetLoadedFPID();
|
|
|
|
if( id.IsValid() )
|
|
{
|
|
Prj().SetRString( PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME, id.GetLibNickname() );
|
|
Prj().SetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME, id.GetLibItemName() );
|
|
}
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::restoreLastFootprint()
|
|
{
|
|
const wxString& footprintName = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_FP_NAME );
|
|
const wxString& libNickname = Prj().GetRString( PROJECT::PCB_FOOTPRINT_EDITOR_LIB_NICKNAME );
|
|
|
|
if( libNickname.Length() && footprintName.Length() )
|
|
{
|
|
LIB_ID id;
|
|
id.SetLibNickname( libNickname );
|
|
id.SetLibItemName( footprintName );
|
|
|
|
FOOTPRINT* footprint = loadFootprint( id );
|
|
|
|
if( footprint )
|
|
AddFootprintToBoard( footprint );
|
|
}
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::ReloadFootprint( FOOTPRINT* aFootprint )
|
|
{
|
|
GetBoard()->DeleteAllFootprints();
|
|
|
|
m_originalFootprintCopy.reset( static_cast<FOOTPRINT*>( aFootprint->Clone() ) );
|
|
m_originalFootprintCopy->SetParent( nullptr );
|
|
|
|
m_footprintNameWhenLoaded = aFootprint->GetFPID().GetUniStringLibItemName();
|
|
|
|
PCB_BASE_EDIT_FRAME::AddFootprintToBoard( aFootprint );
|
|
// Ensure item UUIDs are valid
|
|
// ("old" footprints can have null uuids that create issues in fp editor)
|
|
aFootprint->FixUuids();
|
|
|
|
if( IsCurrentFPFromBoard() )
|
|
{
|
|
wxString msg;
|
|
msg.Printf( _( "Editing %s from board. Saving will update the board only." ),
|
|
aFootprint->GetReference() );
|
|
|
|
if( WX_INFOBAR* infobar = GetInfoBar() )
|
|
{
|
|
infobar->RemoveAllButtons();
|
|
infobar->AddCloseButton();
|
|
infobar->ShowMessage( msg, wxICON_INFORMATION );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( WX_INFOBAR* infobar = GetInfoBar() )
|
|
infobar->Dismiss();
|
|
}
|
|
|
|
UpdateMsgPanel();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::AddFootprintToBoard( FOOTPRINT* aFootprint )
|
|
{
|
|
ReloadFootprint( aFootprint );
|
|
|
|
if( IsCurrentFPFromBoard() )
|
|
setFPWatcher( nullptr );
|
|
else
|
|
setFPWatcher( aFootprint );
|
|
}
|
|
|
|
|
|
const wxChar* FOOTPRINT_EDIT_FRAME::GetFootprintEditorFrameName()
|
|
{
|
|
return FOOTPRINT_EDIT_FRAME_NAME;
|
|
}
|
|
|
|
|
|
BOARD_DESIGN_SETTINGS& FOOTPRINT_EDIT_FRAME::GetDesignSettings() const
|
|
{
|
|
return GetBoard()->GetDesignSettings();
|
|
}
|
|
|
|
|
|
const PCB_PLOT_PARAMS& FOOTPRINT_EDIT_FRAME::GetPlotSettings() const
|
|
{
|
|
wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
|
|
|
|
return PCB_BASE_FRAME::GetPlotSettings();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::SetPlotSettings( const PCB_PLOT_PARAMS& aSettings )
|
|
{
|
|
wxFAIL_MSG( wxT( "Plotting not supported in Footprint Editor" ) );
|
|
}
|
|
|
|
|
|
FOOTPRINT_EDITOR_SETTINGS* FOOTPRINT_EDIT_FRAME::GetSettings()
|
|
{
|
|
if( !m_editorSettings )
|
|
m_editorSettings = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
|
|
|
|
return m_editorSettings;
|
|
}
|
|
|
|
|
|
APP_SETTINGS_BASE* FOOTPRINT_EDIT_FRAME::config() const
|
|
{
|
|
return m_editorSettings ? m_editorSettings
|
|
: Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::LoadSettings( APP_SETTINGS_BASE* aCfg )
|
|
{
|
|
// Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
|
|
// compile unit
|
|
FOOTPRINT_EDITOR_SETTINGS* cfg = GetSettings();
|
|
|
|
if( cfg )
|
|
{
|
|
PCB_BASE_FRAME::LoadSettings( cfg );
|
|
|
|
GetDesignSettings() = cfg->m_DesignSettings;
|
|
|
|
m_displayOptions = cfg->m_Display;
|
|
m_show_layer_manager_tools = cfg->m_AuiPanels.show_layer_manager;
|
|
|
|
GetToolManager()->GetTool<PCB_SELECTION_TOOL>()->GetFilter() = cfg->m_SelectionFilter;
|
|
m_selectionFilterPanel->SetCheckboxesFromFilter( cfg->m_SelectionFilter );
|
|
|
|
m_treePane->GetLibTree()->SetSortMode( (LIB_TREE_MODEL_ADAPTER::SORT_MODE) cfg->m_LibrarySortMode );
|
|
}
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::resolveCanvasType()
|
|
{
|
|
// Load canvas type from the FOOTPRINT_EDITOR_SETTINGS:
|
|
m_canvasType = loadCanvasTypeSetting( GetSettings() );
|
|
|
|
// If we had an OpenGL failure this session, use the fallback GAL but don't update the
|
|
// user preference silently:
|
|
|
|
if( m_openGLFailureOccured && m_canvasType == EDA_DRAW_PANEL_GAL::GAL_TYPE_OPENGL )
|
|
m_canvasType = EDA_DRAW_PANEL_GAL::GAL_FALLBACK;
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::SaveSettings( APP_SETTINGS_BASE* aCfg )
|
|
{
|
|
GetGalDisplayOptions().m_axesEnabled = true;
|
|
|
|
// Get our own settings; aCfg will be the PCBNEW_SETTINGS because we're part of the pcbnew
|
|
// compile unit
|
|
FOOTPRINT_EDITOR_SETTINGS* cfg = GetSettings();
|
|
|
|
if( cfg )
|
|
{
|
|
PCB_BASE_FRAME::SaveSettings( cfg );
|
|
|
|
cfg->m_DesignSettings = GetDesignSettings();
|
|
cfg->m_Display = m_displayOptions;
|
|
cfg->m_LibWidth = m_treePane->GetSize().x;
|
|
cfg->m_SelectionFilter = GetToolManager()->GetTool<PCB_SELECTION_TOOL>()->GetFilter();
|
|
|
|
cfg->m_AuiPanels.show_layer_manager = m_show_layer_manager_tools;
|
|
|
|
if( m_propertiesPanel )
|
|
{
|
|
cfg->m_AuiPanels.show_properties = m_propertiesPanel->IsShownOnScreen();
|
|
cfg->m_AuiPanels.properties_panel_width = m_propertiesPanel->GetSize().x;
|
|
cfg->m_AuiPanels.properties_splitter = m_propertiesPanel->SplitterProportion();
|
|
}
|
|
|
|
cfg->m_LibrarySortMode = m_treePane->GetLibTree()->GetSortMode();
|
|
|
|
if( m_appearancePanel )
|
|
{
|
|
cfg->m_AuiPanels.right_panel_width = m_appearancePanel->GetSize().x;
|
|
cfg->m_AuiPanels.appearance_panel_tab = m_appearancePanel->GetTabIndex();
|
|
cfg->m_LayerPresets = m_appearancePanel->GetUserLayerPresets();
|
|
cfg->m_ActiveLayerPreset = m_appearancePanel->GetActiveLayerPreset();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
EDA_ANGLE FOOTPRINT_EDIT_FRAME::GetRotationAngle() const
|
|
{
|
|
FOOTPRINT_EDITOR_SETTINGS* cfg = const_cast<FOOTPRINT_EDIT_FRAME*>( this )->GetSettings();
|
|
|
|
return cfg ? cfg->m_RotationAngle : ANGLE_90;
|
|
}
|
|
|
|
|
|
|
|
COLOR_SETTINGS* FOOTPRINT_EDIT_FRAME::GetColorSettings( bool aForceRefresh ) const
|
|
{
|
|
wxString currentTheme = GetFootprintEditorSettings()->m_ColorTheme;
|
|
return Pgm().GetSettingsManager().GetColorSettings( currentTheme );
|
|
}
|
|
|
|
|
|
MAGNETIC_SETTINGS* FOOTPRINT_EDIT_FRAME::GetMagneticItemsSettings()
|
|
{
|
|
// Get the actual frame settings for magnetic items
|
|
FOOTPRINT_EDITOR_SETTINGS* cfg = GetSettings();
|
|
wxCHECK( cfg, nullptr );
|
|
return &cfg->m_MagneticItems;
|
|
}
|
|
|
|
|
|
const BOX2I FOOTPRINT_EDIT_FRAME::GetDocumentExtents( bool aIncludeAllVisible ) const
|
|
{
|
|
FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
|
|
|
|
if( footprint )
|
|
{
|
|
bool hasGraphicalItem = footprint->Pads().size() || footprint->Zones().size();
|
|
|
|
if( !hasGraphicalItem )
|
|
{
|
|
for( const BOARD_ITEM* item : footprint->GraphicalItems() )
|
|
{
|
|
if( item->Type() == PCB_TEXT_T || item->Type() == PCB_TEXTBOX_T )
|
|
continue;
|
|
|
|
hasGraphicalItem = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( hasGraphicalItem )
|
|
{
|
|
return footprint->GetBoundingBox( false, false );
|
|
}
|
|
else
|
|
{
|
|
BOX2I newFootprintBB( { 0, 0 }, { 0, 0 } );
|
|
newFootprintBB.Inflate( pcbIUScale.mmToIU( 12 ) );
|
|
return newFootprintBB;
|
|
}
|
|
}
|
|
|
|
return GetBoardBoundingBox( false );
|
|
}
|
|
|
|
|
|
bool FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard( bool doClose )
|
|
{
|
|
if( IsContentModified() )
|
|
{
|
|
wxString footprintName = GetBoard()->GetFirstFootprint()->GetReference();
|
|
wxString msg = _( "Save changes to '%s' before closing?" );
|
|
|
|
if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
|
|
[&]() -> bool
|
|
{
|
|
return SaveFootprint( GetBoard()->GetFirstFootprint() );
|
|
} ) )
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if( doClose )
|
|
{
|
|
GetInfoBar()->ShowMessageFor( wxEmptyString, 1 );
|
|
Clear_Pcb( false );
|
|
UpdateTitle();
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool FOOTPRINT_EDIT_FRAME::canCloseWindow( wxCloseEvent& aEvent )
|
|
{
|
|
if( IsContentModified() )
|
|
{
|
|
// Shutdown blocks must be determined and vetoed as early as possible
|
|
if( KIPLATFORM::APP::SupportsShutdownBlockReason() &&
|
|
aEvent.GetId() == wxEVT_QUERY_END_SESSION )
|
|
{
|
|
aEvent.Veto();
|
|
return false;
|
|
}
|
|
|
|
wxString footprintName = GetBoard()->GetFirstFootprint()->GetFPID().GetLibItemName();
|
|
|
|
if( IsCurrentFPFromBoard() )
|
|
footprintName = GetBoard()->GetFirstFootprint()->GetReference();
|
|
|
|
wxString msg = _( "Save changes to '%s' before closing?" );
|
|
|
|
if( !HandleUnsavedChanges( this, wxString::Format( msg, footprintName ),
|
|
[&]() -> bool
|
|
{
|
|
return SaveFootprint( GetBoard()->GetFirstFootprint() );
|
|
} ) )
|
|
{
|
|
aEvent.Veto();
|
|
return false;
|
|
}
|
|
}
|
|
|
|
PAD_TOOL* padTool = m_toolManager->GetTool<PAD_TOOL>();
|
|
|
|
if( padTool->InPadEditMode() )
|
|
padTool->ExitPadEditMode();
|
|
|
|
// Save footprint tree column widths
|
|
m_adapter->SaveSettings();
|
|
|
|
return PCB_BASE_EDIT_FRAME::canCloseWindow( aEvent );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::doCloseWindow()
|
|
{
|
|
// No more vetos
|
|
GetCanvas()->SetEventDispatcher( nullptr );
|
|
GetCanvas()->StopDrawing();
|
|
|
|
// Do not show the layer manager during closing to avoid flicker
|
|
// on some platforms (Windows) that generate useless redraw of items in
|
|
// the Layer Manager
|
|
m_auimgr.GetPane( wxT( "LayersManager" ) ).Show( false );
|
|
m_auimgr.GetPane( wxT( "SelectionFilter" ) ).Show( false );
|
|
|
|
Clear_Pcb( false );
|
|
|
|
SETTINGS_MANAGER* mgr = GetSettingsManager();
|
|
|
|
if( mgr->IsProjectOpen() && wxFileName::IsDirWritable( Prj().GetProjectPath() ) )
|
|
{
|
|
GFootprintList.WriteCacheToFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
|
|
}
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::OnExitKiCad( wxCommandEvent& event )
|
|
{
|
|
Kiway().OnKiCadExit();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::CloseFootprintEditor( wxCommandEvent& Event )
|
|
{
|
|
Close();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard( wxUpdateUIEvent& aEvent )
|
|
{
|
|
PCB_EDIT_FRAME* frame = (PCB_EDIT_FRAME*) Kiway().Player( FRAME_PCB_EDITOR, false );
|
|
|
|
aEvent.Enable( frame != nullptr );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard( wxUpdateUIEvent& aEvent )
|
|
{
|
|
PCB_EDIT_FRAME* frame = (PCB_EDIT_FRAME*) Kiway().Player( FRAME_PCB_EDITOR, false );
|
|
|
|
FOOTPRINT* editorFootprint = GetBoard()->GetFirstFootprint();
|
|
bool canInsert = frame && editorFootprint && editorFootprint->GetLink() == niluuid;
|
|
|
|
// If the source was deleted, the footprint can inserted but not updated in the board.
|
|
if( frame && editorFootprint && editorFootprint->GetLink() != niluuid )
|
|
{
|
|
BOARD* mainpcb = frame->GetBoard();
|
|
canInsert = true;
|
|
|
|
// search if the source footprint was not deleted:
|
|
for( FOOTPRINT* candidate : mainpcb->Footprints() )
|
|
{
|
|
if( editorFootprint->GetLink() == candidate->m_Uuid )
|
|
{
|
|
canInsert = false;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
aEvent.Enable( canInsert );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::ShowChangedLanguage()
|
|
{
|
|
// call my base class
|
|
PCB_BASE_EDIT_FRAME::ShowChangedLanguage();
|
|
|
|
// We have 2 panes to update.
|
|
// For some obscure reason, the AUI manager hides the first modified pane.
|
|
// So force show panes
|
|
wxAuiPaneInfo& tree_pane_info = m_auimgr.GetPane( m_treePane );
|
|
bool tree_shown = tree_pane_info.IsShown();
|
|
tree_pane_info.Caption( _( "Libraries" ) );
|
|
|
|
wxAuiPaneInfo& lm_pane_info = m_auimgr.GetPane( m_appearancePanel );
|
|
bool lm_shown = lm_pane_info.IsShown();
|
|
lm_pane_info.Caption( _( "Appearance" ) );
|
|
wxAuiPaneInfo& sf_pane_info = m_auimgr.GetPane( m_selectionFilterPanel );
|
|
sf_pane_info.Caption( _( "Selection Filter" ) );
|
|
|
|
// update the layer manager
|
|
m_appearancePanel->OnLanguageChanged();
|
|
m_selectionFilterPanel->OnLanguageChanged();
|
|
UpdateUserInterface();
|
|
|
|
// Now restore the visibility:
|
|
lm_pane_info.Show( lm_shown );
|
|
tree_pane_info.Show( tree_shown );
|
|
m_auimgr.Update();
|
|
|
|
m_treePane->GetLibTree()->ShowChangedLanguage();
|
|
|
|
UpdateTitle();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::OnModify()
|
|
{
|
|
PCB_BASE_FRAME::OnModify();
|
|
Update3DView( true, true );
|
|
m_treePane->GetLibTree()->RefreshLibTree();
|
|
|
|
if( !GetTitle().StartsWith( wxT( "*" ) ) )
|
|
UpdateTitle();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::UpdateTitle()
|
|
{
|
|
wxString title;
|
|
LIB_ID fpid = GetLoadedFPID();
|
|
FOOTPRINT* footprint = GetBoard()->GetFirstFootprint();
|
|
bool writable = true;
|
|
|
|
if( IsCurrentFPFromBoard() )
|
|
{
|
|
if( IsContentModified() )
|
|
title = wxT( "*" );
|
|
|
|
title += footprint->GetReference();
|
|
title += wxS( " " ) + wxString::Format( _( "[from %s]" ), Prj().GetProjectName()
|
|
+ wxT( "." )
|
|
+ FILEEXT::PcbFileExtension );
|
|
}
|
|
else if( fpid.IsValid() )
|
|
{
|
|
try
|
|
{
|
|
writable = PROJECT_PCB::PcbFootprintLibs( &Prj() )->IsFootprintLibWritable( fpid.GetLibNickname() );
|
|
}
|
|
catch( const IO_ERROR& )
|
|
{
|
|
// best efforts...
|
|
}
|
|
|
|
// Note: don't used GetLoadedFPID(); footprint name may have been edited
|
|
if( IsContentModified() )
|
|
title = wxT( "*" );
|
|
|
|
title += From_UTF8( footprint->GetFPID().Format().c_str() );
|
|
|
|
if( !writable )
|
|
title += wxS( " " ) + _( "[Read Only]" );
|
|
}
|
|
else if( !fpid.GetLibItemName().empty() )
|
|
{
|
|
// Note: don't used GetLoadedFPID(); footprint name may have been edited
|
|
if( IsContentModified() )
|
|
title = wxT( "*" );
|
|
|
|
title += From_UTF8( footprint->GetFPID().GetLibItemName().c_str() );
|
|
title += wxS( " " ) + _( "[Unsaved]" );
|
|
}
|
|
else
|
|
{
|
|
title = _( "[no footprint loaded]" );
|
|
}
|
|
|
|
title += wxT( " \u2014 " ) + _( "Footprint Editor" );
|
|
|
|
SetTitle( title );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::UpdateUserInterface()
|
|
{
|
|
m_appearancePanel->OnBoardChanged();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::UpdateView()
|
|
{
|
|
GetCanvas()->UpdateColors();
|
|
GetCanvas()->DisplayBoard( GetBoard() );
|
|
m_toolManager->ResetTools( TOOL_BASE::MODEL_RELOAD );
|
|
UpdateTitle();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::initLibraryTree()
|
|
{
|
|
FP_LIB_TABLE* fpTable = PROJECT_PCB::PcbFootprintLibs( &Prj() );
|
|
|
|
WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Footprint Libraries" ), 2 );
|
|
|
|
if( GFootprintList.GetCount() == 0 )
|
|
GFootprintList.ReadCacheFromFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
|
|
|
|
GFootprintList.ReadFootprintFiles( fpTable, nullptr, &progressReporter );
|
|
progressReporter.Show( false );
|
|
|
|
if( GFootprintList.GetErrorCount() )
|
|
GFootprintList.DisplayErrors( this );
|
|
|
|
m_adapter = FP_TREE_SYNCHRONIZING_ADAPTER::Create( this, fpTable );
|
|
auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
|
|
|
|
adapter->AddLibraries( this );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::SyncLibraryTree( bool aProgress )
|
|
{
|
|
FP_LIB_TABLE* fpTable = PROJECT_PCB::PcbFootprintLibs( &Prj() );
|
|
auto adapter = static_cast<FP_TREE_SYNCHRONIZING_ADAPTER*>( m_adapter.get() );
|
|
LIB_ID target = GetTargetFPID();
|
|
bool targetSelected = ( target == m_treePane->GetLibTree()->GetSelectedLibId() );
|
|
|
|
// Sync FOOTPRINT_INFO list to the libraries on disk
|
|
if( aProgress )
|
|
{
|
|
WX_PROGRESS_REPORTER progressReporter( this, _( "Updating Footprint Libraries" ), 2 );
|
|
GFootprintList.ReadFootprintFiles( fpTable, nullptr, &progressReporter );
|
|
progressReporter.Show( false );
|
|
}
|
|
else
|
|
{
|
|
GFootprintList.ReadFootprintFiles( fpTable, nullptr, nullptr );
|
|
}
|
|
|
|
// Sync the LIB_TREE to the FOOTPRINT_INFO list
|
|
adapter->Sync( fpTable );
|
|
|
|
m_treePane->GetLibTree()->Unselect();
|
|
m_treePane->GetLibTree()->Regenerate( true );
|
|
|
|
if( target.IsValid() )
|
|
{
|
|
if( adapter->FindItem( target ) )
|
|
{
|
|
if( targetSelected )
|
|
m_treePane->GetLibTree()->SelectLibId( target );
|
|
else
|
|
m_treePane->GetLibTree()->CenterLibId( target );
|
|
}
|
|
else
|
|
{
|
|
// Try to focus on parent
|
|
target.SetLibItemName( wxEmptyString );
|
|
m_treePane->GetLibTree()->CenterLibId( target );
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::RegenerateLibraryTree()
|
|
{
|
|
LIB_ID target = GetTargetFPID();
|
|
|
|
m_treePane->GetLibTree()->Regenerate( true );
|
|
|
|
if( target.IsValid() )
|
|
m_treePane->GetLibTree()->CenterLibId( target );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::RefreshLibraryTree()
|
|
{
|
|
m_treePane->GetLibTree()->RefreshLibTree();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::FocusOnLibID( const LIB_ID& aLibID )
|
|
{
|
|
m_treePane->GetLibTree()->SelectLibId( aLibID );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::OnDisplayOptionsChanged()
|
|
{
|
|
m_appearancePanel->UpdateDisplayOptions();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::setupTools()
|
|
{
|
|
// Create the manager and dispatcher & route draw panel events to the dispatcher
|
|
m_toolManager = new TOOL_MANAGER;
|
|
m_toolManager->SetEnvironment( GetBoard(), GetCanvas()->GetView(),
|
|
GetCanvas()->GetViewControls(), config(), this );
|
|
m_actions = new PCB_ACTIONS();
|
|
m_toolDispatcher = new TOOL_DISPATCHER( m_toolManager );
|
|
|
|
GetCanvas()->SetEventDispatcher( m_toolDispatcher );
|
|
|
|
m_toolManager->RegisterTool( new COMMON_CONTROL );
|
|
m_toolManager->RegisterTool( new COMMON_TOOLS );
|
|
m_toolManager->RegisterTool( new PCB_SELECTION_TOOL );
|
|
m_toolManager->RegisterTool( new ZOOM_TOOL );
|
|
m_toolManager->RegisterTool( new EDIT_TOOL );
|
|
m_toolManager->RegisterTool( new PAD_TOOL );
|
|
m_toolManager->RegisterTool( new DRAWING_TOOL );
|
|
m_toolManager->RegisterTool( new PCB_POINT_EDITOR );
|
|
m_toolManager->RegisterTool( new PCB_CONTROL ); // copy/paste
|
|
m_toolManager->RegisterTool( new FOOTPRINT_EDITOR_CONTROL );
|
|
m_toolManager->RegisterTool( new ALIGN_DISTRIBUTE_TOOL );
|
|
m_toolManager->RegisterTool( new PCB_PICKER_TOOL );
|
|
m_toolManager->RegisterTool( new POSITION_RELATIVE_TOOL );
|
|
m_toolManager->RegisterTool( new PCB_VIEWER_TOOLS );
|
|
m_toolManager->RegisterTool( new GROUP_TOOL );
|
|
m_toolManager->RegisterTool( new CONVERT_TOOL );
|
|
m_toolManager->RegisterTool( new SCRIPTING_TOOL );
|
|
m_toolManager->RegisterTool( new PROPERTIES_TOOL );
|
|
|
|
for( TOOL_BASE* tool : m_toolManager->Tools() )
|
|
{
|
|
if( PCB_TOOL_BASE* pcbTool = dynamic_cast<PCB_TOOL_BASE*>( tool ) )
|
|
pcbTool->SetIsFootprintEditor( true );
|
|
}
|
|
|
|
m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
|
|
m_toolManager->InitTools();
|
|
|
|
m_toolManager->InvokeTool( "pcbnew.InteractiveSelection" );
|
|
|
|
// Load or reload wizard plugins in case they changed since the last time the frame opened
|
|
// Because the board editor has also a plugin python menu,
|
|
// call the PCB_EDIT_FRAME RunAction() if the board editor is running
|
|
// Otherwise run the current RunAction().
|
|
PCB_EDIT_FRAME* pcbframe = static_cast<PCB_EDIT_FRAME*>( Kiway().Player( FRAME_PCB_EDITOR, false ) );
|
|
|
|
if( pcbframe )
|
|
pcbframe->GetToolManager()->RunAction( PCB_ACTIONS::pluginsReload );
|
|
else
|
|
m_toolManager->RunAction( PCB_ACTIONS::pluginsReload );
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::setupUIConditions()
|
|
{
|
|
PCB_BASE_EDIT_FRAME::setupUIConditions();
|
|
|
|
ACTION_MANAGER* mgr = m_toolManager->GetActionManager();
|
|
PCB_EDITOR_CONDITIONS cond( this );
|
|
|
|
wxASSERT( mgr );
|
|
|
|
#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
|
|
#define CHECK( x ) ACTION_CONDITIONS().Check( x )
|
|
|
|
auto haveFootprintCond =
|
|
[this]( const SELECTION& )
|
|
{
|
|
return GetBoard() && GetBoard()->GetFirstFootprint() != nullptr;
|
|
};
|
|
|
|
auto footprintTargettedCond =
|
|
[this]( const SELECTION& )
|
|
{
|
|
return !GetTargetFPID().GetLibItemName().empty();
|
|
};
|
|
|
|
mgr->SetConditions( ACTIONS::saveAs, ENABLE( footprintTargettedCond ) );
|
|
mgr->SetConditions( ACTIONS::revert, ENABLE( cond.ContentModified() ) );
|
|
mgr->SetConditions( ACTIONS::save, ENABLE( SELECTION_CONDITIONS::ShowAlways ) );
|
|
|
|
mgr->SetConditions( ACTIONS::undo, ENABLE( cond.UndoAvailable() ) );
|
|
mgr->SetConditions( ACTIONS::redo, ENABLE( cond.RedoAvailable() ) );
|
|
|
|
mgr->SetConditions( ACTIONS::toggleGrid, CHECK( cond.GridVisible() ) );
|
|
mgr->SetConditions( ACTIONS::toggleGridOverrides, CHECK( cond.GridOverrides() ) );
|
|
mgr->SetConditions( ACTIONS::toggleCursorStyle, CHECK( cond.FullscreenCursor() ) );
|
|
mgr->SetConditions( ACTIONS::millimetersUnits, CHECK( cond.Units( EDA_UNITS::MILLIMETRES ) ) );
|
|
mgr->SetConditions( ACTIONS::inchesUnits, CHECK( cond.Units( EDA_UNITS::INCHES ) ) );
|
|
mgr->SetConditions( ACTIONS::milsUnits, CHECK( cond.Units( EDA_UNITS::MILS ) ) );
|
|
|
|
mgr->SetConditions( ACTIONS::cut, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( ACTIONS::copy, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( ACTIONS::paste, ENABLE( SELECTION_CONDITIONS::Idle && cond.NoActiveTool() ) );
|
|
mgr->SetConditions( ACTIONS::pasteSpecial, ENABLE( SELECTION_CONDITIONS::Idle && cond.NoActiveTool() ) );
|
|
mgr->SetConditions( ACTIONS::doDelete, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( ACTIONS::duplicate, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( ACTIONS::selectAll, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( ACTIONS::unselectAll, ENABLE( cond.HasItems() ) );
|
|
|
|
mgr->SetConditions( PCB_ACTIONS::rotateCw, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( PCB_ACTIONS::rotateCcw, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( PCB_ACTIONS::mirrorH, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( PCB_ACTIONS::mirrorV, ENABLE( cond.HasItems() ) );
|
|
mgr->SetConditions( PCB_ACTIONS::group, ENABLE( SELECTION_CONDITIONS::NotEmpty ) );
|
|
mgr->SetConditions( PCB_ACTIONS::ungroup, ENABLE( SELECTION_CONDITIONS::HasType( PCB_GROUP_T ) ) );
|
|
|
|
mgr->SetConditions( PCB_ACTIONS::padDisplayMode, CHECK( !cond.PadFillDisplay() ) );
|
|
mgr->SetConditions( PCB_ACTIONS::textOutlines, CHECK( !cond.TextFillDisplay() ) );
|
|
mgr->SetConditions( PCB_ACTIONS::graphicsOutlines, CHECK( !cond.GraphicsFillDisplay() ) );
|
|
|
|
mgr->SetConditions( ACTIONS::zoomTool, CHECK( cond.CurrentTool( ACTIONS::zoomTool ) ) );
|
|
mgr->SetConditions( ACTIONS::selectionTool, CHECK( cond.CurrentTool( ACTIONS::selectionTool ) ) );
|
|
|
|
auto constrainedDrawingModeCond =
|
|
[this]( const SELECTION& )
|
|
{
|
|
return GetSettings()->m_Use45Limit;
|
|
};
|
|
|
|
auto highContrastCond =
|
|
[this]( const SELECTION& )
|
|
{
|
|
return GetDisplayOptions().m_ContrastModeDisplay != HIGH_CONTRAST_MODE::NORMAL;
|
|
};
|
|
|
|
auto boardFlippedCond =
|
|
[this]( const SELECTION& )
|
|
{
|
|
return GetCanvas() && GetCanvas()->GetView()->IsMirroredX();
|
|
};
|
|
|
|
auto footprintTreeCond =
|
|
[this](const SELECTION& )
|
|
{
|
|
return IsSearchTreeShown();
|
|
};
|
|
|
|
auto layerManagerCond =
|
|
[this]( const SELECTION& )
|
|
{
|
|
return m_auimgr.GetPane( "LayersManager" ).IsShown();
|
|
};
|
|
|
|
auto propertiesCond =
|
|
[this] ( const SELECTION& )
|
|
{
|
|
return m_auimgr.GetPane( PropertiesPaneName() ).IsShown();
|
|
};
|
|
|
|
mgr->SetConditions( PCB_ACTIONS::toggleHV45Mode, CHECK( constrainedDrawingModeCond ) );
|
|
mgr->SetConditions( ACTIONS::highContrastMode, CHECK( highContrastCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::flipBoard, CHECK( boardFlippedCond ) );
|
|
mgr->SetConditions( ACTIONS::toggleBoundingBoxes, CHECK( cond.BoundingBoxes() ) );
|
|
|
|
mgr->SetConditions( PCB_ACTIONS::showFootprintTree, CHECK( footprintTreeCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::showLayersManager, CHECK( layerManagerCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::showProperties, CHECK( propertiesCond ) );
|
|
|
|
mgr->SetConditions( ACTIONS::print, ENABLE( haveFootprintCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::exportFootprint, ENABLE( haveFootprintCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::placeImportedGraphics, ENABLE( haveFootprintCond ) );
|
|
|
|
mgr->SetConditions( PCB_ACTIONS::footprintProperties, ENABLE( haveFootprintCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::editTextAndGraphics, ENABLE( haveFootprintCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::checkFootprint, ENABLE( haveFootprintCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::repairFootprint, ENABLE( haveFootprintCond ) );
|
|
mgr->SetConditions( PCB_ACTIONS::cleanupGraphics, ENABLE( haveFootprintCond ) );
|
|
|
|
auto isArcKeepCenterMode =
|
|
[this]( const SELECTION& )
|
|
{
|
|
return GetSettings()->m_ArcEditMode == ARC_EDIT_MODE::KEEP_CENTER_ADJUST_ANGLE_RADIUS;
|
|
};
|
|
|
|
auto isArcKeepEndpointMode =
|
|
[this]( const SELECTION& )
|
|
{
|
|
return GetSettings()->m_ArcEditMode == ARC_EDIT_MODE::KEEP_ENDPOINTS_OR_START_DIRECTION;
|
|
};
|
|
|
|
mgr->SetConditions( PCB_ACTIONS::pointEditorArcKeepCenter, CHECK( isArcKeepCenterMode ) );
|
|
mgr->SetConditions( PCB_ACTIONS::pointEditorArcKeepEndpoint, CHECK( isArcKeepEndpointMode ) );
|
|
|
|
|
|
// Only enable a tool if the part is edtable
|
|
#define CURRENT_EDIT_TOOL( action ) \
|
|
mgr->SetConditions( action, ACTION_CONDITIONS().Enable( haveFootprintCond ) \
|
|
.Check( cond.CurrentTool( action ) ) )
|
|
|
|
CURRENT_EDIT_TOOL( ACTIONS::deleteTool );
|
|
CURRENT_EDIT_TOOL( ACTIONS::measureTool );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::placePad );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawLine );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawRectangle );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawCircle );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawArc );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawPolygon );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawRuleArea );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::placeReferenceImage );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::placeText );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawTextBox );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawAlignedDimension );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawOrthogonalDimension );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawCenterDimension );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawRadialDimension );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawLeader );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::setAnchor );
|
|
CURRENT_EDIT_TOOL( PCB_ACTIONS::gridSetOrigin );
|
|
|
|
#undef CURRENT_EDIT_TOOL
|
|
#undef ENABLE
|
|
#undef CHECK
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::ActivateGalCanvas()
|
|
{
|
|
PCB_BASE_EDIT_FRAME::ActivateGalCanvas();
|
|
|
|
// Be sure the axis are enabled
|
|
GetCanvas()->GetGAL()->SetAxesEnabled( true );
|
|
|
|
UpdateView();
|
|
|
|
// Ensure the m_Layers settings are using the canvas type:
|
|
UpdateUserInterface();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged )
|
|
{
|
|
PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
|
|
|
|
auto cfg = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
|
|
GetGalDisplayOptions().ReadWindowSettings( cfg->m_Window );
|
|
|
|
GetBoard()->GetDesignSettings() = cfg->m_DesignSettings;
|
|
|
|
GetCanvas()->GetView()->UpdateAllLayersColor();
|
|
GetCanvas()->GetView()->MarkTargetDirty( KIGFX::TARGET_NONCACHED );
|
|
GetCanvas()->ForceRefresh();
|
|
|
|
UpdateUserInterface();
|
|
|
|
if( aEnvVarsChanged )
|
|
SyncLibraryTree( true );
|
|
|
|
Layout();
|
|
SendSizeEvent();
|
|
}
|
|
|
|
|
|
void FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng( wxCommandEvent& event )
|
|
{
|
|
LIB_ID id = GetLoadedFPID();
|
|
|
|
if( id.empty() )
|
|
{
|
|
DisplayErrorMessage( this, _( "No footprint selected." ) );
|
|
return;
|
|
}
|
|
|
|
wxFileName fn( id.GetLibItemName() );
|
|
fn.SetExt( wxT( "png" ) );
|
|
|
|
wxString projectPath = wxPathOnly( Prj().GetProjectFullName() );
|
|
|
|
wxFileDialog dlg( this, _( "Export View as PNG" ), projectPath, fn.GetFullName(),
|
|
FILEEXT::PngFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
|
|
|
|
if( dlg.ShowModal() == wxID_CANCEL || dlg.GetPath().IsEmpty() )
|
|
return;
|
|
|
|
// calling wxYield is mandatory under Linux, after closing the file selector dialog
|
|
// to refresh the screen before creating the PNG or JPEG image from screen
|
|
wxYield();
|
|
this->SaveCanvasImageToFile( dlg.GetPath(), BITMAP_TYPE::PNG );
|
|
}
|