KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_base_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) 2014 CERN
5 * Copyright (C) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Maciej Suminski <[email protected]>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <kiface_base.h>
27#include <kiplatform/ui.h>
28#include <pcb_base_edit_frame.h>
30#include <tool/tool_manager.h>
31#include <tools/pcb_actions.h>
33#include <pgm_base.h>
34#include <board.h>
37#include <pcb_dimension.h>
38#include <footprint.h>
39#include <footprint_info_impl.h>
40#include <project.h>
48
49
51 FRAME_T aFrameType, const wxString& aTitle,
52 const wxPoint& aPos, const wxSize& aSize, long aStyle,
53 const wxString& aFrameName ) :
54 PCB_BASE_FRAME( aKiway, aParent, aFrameType, aTitle, aPos, aSize, aStyle, aFrameName ),
55 m_undoRedoBlocked( false ),
56 m_selectionFilterPanel( nullptr ),
57 m_appearancePanel( nullptr ),
58 m_tabbedPanel( nullptr )
59{
61
62 Bind( wxEVT_IDLE,
63 [this]( wxIdleEvent& aEvent )
64 {
65 // Handle cursor adjustments. While we can get motion and key events through
66 // wxWidgets, we can't get modifier-key-up events.
67 if( m_toolManager )
68 {
70
71 if( selTool )
72 selTool->OnIdle( aEvent );
73 }
74
76 {
79 }
80 } );
81}
82
83
85{
86 GetCanvas()->GetView()->Clear();
87}
88
89
91{
93 wxFileName projectName( Prj().GetProjectFullName() );
94
95 if( mgr->IsProjectOpen() && wxFileName::IsDirWritable( projectName.GetPath() )
96 && projectName.Exists() )
97 {
98 GFootprintList.WriteCacheToFile( Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
99 }
100
101 // Close the project if we are standalone, so it gets cleaned up properly
102 if( mgr->IsProjectOpen() && Kiface().IsSingle() )
103 mgr->UnloadProject( &Prj(), false );
104}
105
106
107bool PCB_BASE_EDIT_FRAME::TryBefore( wxEvent& aEvent )
108{
109 static bool s_presetSwitcherShown = false;
110 static bool s_viewportSwitcherShown = false;
111
112 // wxWidgets generates no key events for the tab key when the ctrl key is held down. One
113 // way around this is to look at all events and inspect the keyboard state of the tab key.
114 // However, this runs into issues on some linux VMs where querying the keyboard state is
115 // very slow. Fortunately we only use ctrl-tab on Mac, so we implement this lovely hack:
116#ifdef __WXMAC__
117 if( wxGetKeyState( WXK_TAB ) )
118#else
119 if( ( aEvent.GetEventType() == wxEVT_CHAR || aEvent.GetEventType() == wxEVT_CHAR_HOOK )
120 && static_cast<wxKeyEvent&>( aEvent ).GetKeyCode() == WXK_TAB )
121#endif
122 {
123 if( !s_presetSwitcherShown && wxGetKeyState( PRESET_SWITCH_KEY ) )
124 {
125 if( m_appearancePanel && this->IsActive() )
126 {
127 const wxArrayString& mru = m_appearancePanel->GetLayerPresetsMRU();
128
129 if( mru.size() > 0 )
130 {
131 EDA_VIEW_SWITCHER switcher( this, mru, PRESET_SWITCH_KEY );
132
133 s_presetSwitcherShown = true;
134 switcher.ShowModal();
135 s_presetSwitcherShown = false;
136
137 int idx = switcher.GetSelection();
138
139 if( idx >= 0 && idx < (int) mru.size() )
141
142 return true;
143 }
144 }
145 }
146 else if( !s_viewportSwitcherShown && wxGetKeyState( VIEWPORT_SWITCH_KEY ) )
147 {
148 if( m_appearancePanel && this->IsActive() )
149 {
150 const wxArrayString& mru = m_appearancePanel->GetViewportsMRU();
151
152 if( mru.size() > 0 )
153 {
154 EDA_VIEW_SWITCHER switcher( this, mru, VIEWPORT_SWITCH_KEY );
155
156 s_viewportSwitcherShown = true;
157 switcher.ShowModal();
158 s_viewportSwitcherShown = false;
159
160 int idx = switcher.GetSelection();
161
162 if( idx >= 0 && idx < (int) mru.size() )
163 m_appearancePanel->ApplyViewport( mru[idx] );
164
165 return true;
166 }
167 }
168 }
169 }
170
171 return PCB_BASE_FRAME::TryBefore( aEvent );
172}
173
174
176{
177 // Return a default angle (90 degrees) used for rotate operations.
178 return ANGLE_90;
179}
180
181
183{
185
187}
188
189
191{
192 bool is_new_board = ( aBoard != m_pcb );
193
194 if( is_new_board )
195 {
196 if( m_toolManager )
198
199 GetCanvas()->GetView()->Clear();
201 }
202
203 PCB_BASE_FRAME::SetBoard( aBoard, aReporter );
204
206
207 if( is_new_board )
208 {
210 bds.m_DRCEngine = std::make_shared<DRC_ENGINE>( aBoard, &bds );
211 }
212
213 // update the tool manager with the new board and its view.
214 if( m_toolManager )
215 {
216 GetCanvas()->DisplayBoard( aBoard, aReporter );
217
219 m_toolManager->SetEnvironment( aBoard, GetCanvas()->GetView(),
220 GetCanvas()->GetViewControls(), config(), this );
221
222 if( is_new_board )
224 }
225}
226
227
229{
231
232 if( BOARD* board = GetBoard() )
233 {
234 board->UpdateUserUnits( board, GetCanvas()->GetView() );
236 }
237
240}
241
242
244{
246
247 // Update the grid checkbox in the layer widget
250}
251
252
254{
256 m_appearancePanel->SetObjectVisible( aLayer, aVisible );
257}
258
259
261{
262 return Pgm().GetSettingsManager().GetColorSettings( GetPcbNewSettings()->m_ColorTheme );
263}
264
265
267{
268 if( !GetBoard() )
269 return wxEmptyString;
270
271 wxFileName fn = GetBoard()->GetFileName();
273 return Prj().AbsolutePath( fn.GetFullName() );
274}
275
276
277void PCB_BASE_EDIT_FRAME::handleActivateEvent( wxActivateEvent& aEvent )
278{
280
281 // The text in the collapsible pane headers need to be updated
284}
285
286
288{
290
292
293 if( viewer )
294 viewer->OnDarkModeToggle();
295}
296
297
299{
300 if( !m_propertiesPanel )
301 return;
302
303 bool show = !m_propertiesPanel->IsShownOnScreen();
304
305 wxAuiPaneInfo& propertiesPaneInfo = m_auimgr.GetPane( PropertiesPaneName() );
306 propertiesPaneInfo.Show( show );
307
309
310 if( show )
311 {
312 SetAuiPaneSize( m_auimgr, propertiesPaneInfo,
313 settings->m_AuiPanels.properties_panel_width, -1 );
314 }
315 else
316 {
318 m_auimgr.Update();
319 }
320}
321
322
323void PCB_BASE_EDIT_FRAME::GetContextualTextVars( BOARD_ITEM* aSourceItem, const wxString& aCrossRef,
324 wxArrayString* aTokens )
325{
326 BOARD* board = aSourceItem->GetBoard();
327
328 if( !aCrossRef.IsEmpty() )
329 {
330 for( FOOTPRINT* candidate : board->Footprints() )
331 {
332 if( candidate->GetReference() == aCrossRef )
333 {
334 candidate->GetContextualTextVars( aTokens );
335 break;
336 }
337 }
338 }
339 else
340 {
341 board->GetContextualTextVars( aTokens );
342
343 if( FOOTPRINT* footprint = aSourceItem->GetParentFootprint() )
344 footprint->GetContextualTextVars( aTokens );
345 }
346}
347
348
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
void ApplyLayerPreset(const wxString &aPresetName)
const wxArrayString & GetViewportsMRU()
void RefreshCollapsiblePanes()
Function to force a redraw of the collapsible panes in this control.
const wxArrayString & GetLayerPresetsMRU()
Return a list of viewports created by the user.
void OnDarkModeToggle()
Update the widget when the active board layer is changed.
void SetObjectVisible(GAL_LAYER_ID aLayer, bool isVisible=true)
void ApplyViewport(const wxString &aPresetName)
Container for design settings for a BOARD object.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
const VECTOR2I & GetGridOrigin()
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
FOOTPRINT * GetParentFootprint() const
Definition: board_item.cpp:248
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:276
void GetContextualTextVars(wxArrayString *aVars) const
Definition: board.cpp:372
FOOTPRINTS & Footprints()
Definition: board.h:318
const wxString & GetFileName() const
Definition: board.h:313
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:769
Color settings are a bit different than most of the settings objects in that there can be more than o...
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
SETTINGS_MANAGER * GetSettingsManager() const
wxAuiManager m_auimgr
static const wxString PropertiesPaneName()
virtual void ReCreateAuxiliaryToolbar()
virtual void SetGridVisibility(bool aVisible)
PROPERTIES_PANEL * m_propertiesPanel
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
int GetSelection() const
static const TOOL_EVENT SelectedItemsModified
Selected items were moved, this can be very high frequency on the canvas, use with care.
Definition: actions.h:260
void WriteCacheToFile(const wxString &aFilePath) override
void SetGridOrigin(const VECTOR2D &aGridOrigin)
Set the origin point for the grid.
void Clear()
Remove all items from the view.
Definition: view.cpp:1116
void InitPreview()
Definition: view.cpp:1656
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
AUI_PANELS m_AuiPanels
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
bool m_darkMode
Panel with Layers and Object Inspector tabs.
void doCloseWindow() override
void SetGridVisibility(bool aVisible) override
Override this function in the PCB_BASE_EDIT_FRAME to refill the layer widget.
virtual EDA_ANGLE GetRotationAngle() const
Return the angle used for rotate operations.
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
bool TryBefore(wxEvent &aEvent) override
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 ToggleProperties() 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
void SetObjectVisible(GAL_LAYER_ID aLayer, bool aVisible=true)
void GetContextualTextVars(BOARD_ITEM *aSourceItem, const wxString &aCrossRef, wxArrayString *aTokens)
void handleActivateEvent(wxActivateEvent &aEvent) override
Handle a window activation event.
virtual void onDarkModeToggle()
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.
void handleActivateEvent(wxActivateEvent &aEvent) override
Handle a window activation event.
virtual void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
PCBNEW_SETTINGS * GetPcbNewSettings() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
virtual void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
BOARD * GetBoard() const
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
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.
void SyncLayersVisibility(const BOARD *aBoard)
Update "visibility" property of each layer of a given BOARD.
The selection tool: currently supports:
void OnIdle(wxIdleEvent &aEvent)
A progress reporter interface for use in multi-threaded environments.
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Definition: project.cpp:320
bool IsProjectOpen() const
Helper for checking if we have a project open TODO: This should be deprecated along with Prj() once w...
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:167
@ MODEL_RELOAD
Model changes (the sheet for a schematic)
Definition: tool_base.h:80
void PostEvent(const TOOL_EVENT &aEvent)
Put an event to the event queue to be processed at the end of event processing cycle.
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Set the work environment (model, view, view controls and the parent window).
Declaration of the eda_3d_viewer class.
static constexpr EDA_ANGLE ANGLE_90
Definition: eda_angle.h:437
#define VIEWPORT_SWITCH_KEY
#define PRESET_SWITCH_KEY
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition: cvpcb.cpp:175
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
static const std::string DesignRulesFileExtension
PROJECT & Prj()
Definition: kicad.cpp:591
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:193
@ LAYER_GRID
Definition: layer_ids.h:208
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition: gtk/ui.cpp:48
see class PGM_BASE
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:119
VECTOR2< double > VECTOR2D
Definition: vector2d.h:587
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.