KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_base_frame.h
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) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2008-2016 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 2023 CERN
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef PCB_BASE_FRAME_H
28#define PCB_BASE_FRAME_H
29
30#include <eda_units.h>
31#include <eda_draw_frame.h>
32#include <lib_id.h>
33#include <pcb_display_options.h>
34#include <pcb_draw_panel_gal.h>
36#include <pcb_screen.h>
37#include <vector>
38
39#include <wx/datetime.h>
40#include <wx/timer.h>
41
42/* Forward declarations of classes. */
44class BOARD;
46class COLOR_SETTINGS;
47class EDA_ITEM;
48class FOOTPRINT;
49class PAD;
54class LSET;
55class ZONE_SETTINGS;
56class PCB_PLOT_PARAMS;
57class FP_LIB_TABLE;
59class PCBNEW_SETTINGS;
64
65#ifndef __linux__
67#else
68class SPNAV_2D_PLUGIN;
69#endif
70
71#ifdef wxHAS_INOTIFY
72#define wxFileSystemWatcher wxInotifyFileSystemWatcher
73#elif defined( wxHAS_KQUEUE ) && defined( wxHAVE_FSEVENTS_FILE_NOTIFICATIONS )
74#define wxFileSystemWatcher wxFsEventsFileSystemWatcher
75#elif defined( wxHAS_KQUEUE )
76#define wxFileSystemWatcher wxKqueueFileSystemWatcher
77#elif defined( __WINDOWS__ )
78#define wxFileSystemWatcher wxMSWFileSystemWatcher
79#else
80#define wxFileSystemWatcher wxPollingFileSystemWatcher
81#endif
82
84class wxFileSystemWatcherEvent;
85
86wxDECLARE_EVENT( EDA_EVT_BOARD_CHANGED, wxCommandEvent );
87
92{
93public:
94 PCB_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
95 const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
96 long aStyle, const wxString& aFrameName );
97
99
104
112 virtual void Update3DView( bool aMarkDirty, bool aRefresh, const wxString* aTitle = nullptr );
113
121 FOOTPRINT* LoadFootprint( const LIB_ID& aFootprintId );
122
129 BOX2I GetBoardBoundingBox( bool aBoardEdgesOnly = false ) const;
130
131 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override;
132
133 virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
134 const PAGE_INFO& GetPageSettings() const override;
135 const VECTOR2I GetPageSizeIU() const override;
136
137 const VECTOR2I& GetGridOrigin() const override;
138 void SetGridOrigin( const VECTOR2I& aPoint ) override;
139
140 const VECTOR2I& GetAuxOrigin() const;
141
142 const VECTOR2I GetUserOrigin() const;
143
148
149 wxString MessageTextFromCoord( int aValue, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType ) const
150 {
151 return MessageTextFromValue( m_originTransforms.ToDisplay( aValue, aCoordType ) );
152 }
153
154 const TITLE_BLOCK& GetTitleBlock() const override;
155 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
156
161
165 virtual COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override
166 {
167 wxFAIL_MSG( wxT( "Color settings requested for a PCB_BASE_FRAME that does not "
168 "override!" ) );
169 return nullptr;
170 }
171
172 void SetDrawBgColor( const COLOR4D& aColor ) override;
173
179
186 void SetDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions, bool aRefresh = true );
187
191 virtual const PCB_PLOT_PARAMS& GetPlotSettings() const;
192 virtual void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings );
193
199 virtual void ReloadFootprint( FOOTPRINT* aFootprint )
200 {
201 wxFAIL_MSG( wxT( "Attempted to reload a footprint for PCB_BASE_FRAME that does not "
202 "override!" ) );
203 }
204
208 virtual void SetBoard( BOARD* aBoard, PROGRESS_REPORTER* aReporter = nullptr );
209
211 {
212 wxASSERT( m_pcb );
213 return m_pcb;
214 }
215
219 virtual BOARD_ITEM_CONTAINER* GetModel() const = 0;
220
221 EDA_ITEM* ResolveItem( const KIID& aId, bool aAllowNullptrReturn = false ) const override;
222
223 void FocusOnItem( EDA_ITEM* aItem, bool aAllowScroll = true ) override;
224 void FocusOnItem( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer = UNDEFINED_LAYER, bool aAllowScroll = true );
225 void FocusOnItems( std::vector<BOARD_ITEM*> aItems, PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
226 bool aAllowScroll = true );
227
228 void HideSolderMask();
229 void ShowSolderMask();
230
231 // General
232 virtual void ShowChangedLanguage() override;
233 virtual void UpdateStatusBar() override;
234
235 PCB_SCREEN* GetScreen() const override { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
236
243
248
253 void OnModify() override;
254
268 FOOTPRINT* CreateNewFootprint( wxString aFootprintName, const wxString& aLibName );
269
276 void PlaceFootprint( FOOTPRINT* aFootprint, bool aRecreateRatsnest = true );
277
278 void ShowPadPropertiesDialog( PAD* aPad );
279
286
292 virtual void AddFootprintToBoard( FOOTPRINT* aFootprint );
293
302 void Compile_Ratsnest( bool aDisplayStatus );
303
310 virtual void SaveCopyInUndoList( EDA_ITEM* aItemToCopy, UNDO_REDO aTypeCommand ) {};
311
318 virtual void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
319 UNDO_REDO aTypeCommand ) {};
320
324 virtual void AppendCopyToUndoList( const PICKED_ITEMS_LIST& aItemsList,
325 UNDO_REDO aTypeCommand ) {};
326
327
339 const LSET& aNotAllowedLayersMask = LSET(),
340 wxPoint aDlgPosition = wxDefaultPosition );
341
347 virtual void SwitchLayer( PCB_LAYER_ID aLayer );
348
349 virtual void SetActiveLayer( PCB_LAYER_ID aLayer ) { GetScreen()->m_Active_Layer = aLayer; }
351
352 SEVERITY GetSeverity( int aErrorCode ) const override;
353
354 virtual void OnDisplayOptionsChanged() {}
355
356 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
357 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
358
360
362
364
366
367 void CommonSettingsChanged( int aFlags ) override;
368
369 PCB_DRAW_PANEL_GAL* GetCanvas() const override;
370
371 virtual void ActivateGalCanvas() override;
372
382 void AddBoardChangeListener( wxEvtHandler* aListener );
383
387 void RemoveBoardChangeListener( wxEvtHandler* aListener );
388
392 void OnFPChange( wxFileSystemWatcherEvent& aEvent );
393
397 void OnFpChangeDebounceTimer( wxTimerEvent& aEvent );
398
399 void GetLibraryItemsForListDialog( wxArrayString& aHeaders,
400 std::vector<wxArrayString>& aItemsToDisplay );
401
402protected:
403 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
404
405 void handleActivateEvent( wxActivateEvent& aEvent ) override;
406
407 void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
408
409 virtual void doReCreateMenuBar() override;
410
420 FOOTPRINT* loadFootprint( const LIB_ID& aFootprintId );
421
422 virtual void unitsChangeRefresh() override;
423
424 void rebuildConnectivity();
425
431 void setFPWatcher( FOOTPRINT* aFootprint );
432
433protected:
437
438private:
439#ifndef __linux__
440 std::unique_ptr<NL_PCBNEW_PLUGIN> m_spaceMouse;
441#else
442 std::unique_ptr<SPNAV_2D_PLUGIN> m_spaceMouse;
443#endif
444
445 std::unique_ptr<wxFileSystemWatcher> m_watcher;
450
451 std::vector<wxEvtHandler*> m_boardChangeListeners;
452};
453
454#endif // PCB_BASE_FRAME_H
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
Container for design settings for a BOARD object.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:79
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:317
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 BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
EDA_DRAW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName, const EDA_IU_SCALE &aIuScale)
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
A general implementation of a COLLECTORS_GUIDE.
Definition collectors.h:324
Used when the right click button is pressed, or when the select tool is in effect.
Definition collectors.h:207
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:104
Definition kiid.h:49
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:286
A logical library item identifier and consists of various portions much like a URI.
Definition lib_id.h:49
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
The class that implements the public interface to the SpaceMouse plug-in.
A class to perform either relative or absolute display origin transforms for a single axis of a point...
COORD_TYPES_T
The supported Display Origin Transform types.
Definition pad.h:54
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition page_info.h:79
SEVERITY GetSeverity(int aErrorCode) const override
std::unique_ptr< wxFileSystemWatcher > m_watcher
virtual void SaveCopyInUndoList(const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)
Create a new entry in undo list of commands.
virtual void ReloadFootprint(FOOTPRINT *aFootprint)
Reload the footprint from the library.
virtual void OnDisplayOptionsChanged()
void handleIconizeEvent(wxIconizeEvent &aEvent) override
Handle a window iconize event.
ORIGIN_TRANSFORMS & GetOriginTransforms() override
Return a reference to the default ORIGIN_TRANSFORMS object.
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
std::unique_ptr< NL_PCBNEW_PLUGIN > m_spaceMouse
void ShowPadPropertiesDialog(PAD *aPad)
wxDateTime m_watcherLastModified
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 RemoveBoardChangeListener(wxEvtHandler *aListener)
Remove aListener to from the board changed listener list.
void handleActivateEvent(wxActivateEvent &aEvent) override
Handle a window activation event.
void setFPWatcher(FOOTPRINT *aFootprint)
Create or removes a watcher on the specified footprint.
virtual void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Return bounding box of document with option to not include some items.
const VECTOR2I GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
FOOTPRINT * CreateNewFootprint(wxString aFootprintName, const wxString &aLibName)
Create a new footprint at position 0,0.
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual void SwitchLayer(PCB_LAYER_ID aLayer)
Change the active layer in the frame.
virtual PCB_LAYER_ID GetActiveLayer() const
PCB_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
const VECTOR2I & GetAuxOrigin() const
virtual void SaveCopyInUndoList(EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand)
Create a new entry in undo list of commands.
virtual PCB_VIEWERS_SETTINGS_BASE * GetViewerSettingsBase() const
FOOTPRINT * loadFootprint(const LIB_ID &aFootprintId)
Attempt to load aFootprintId from the footprint library table.
const VECTOR2I GetUserOrigin() const
virtual MAGNETIC_SETTINGS * GetMagneticItemsSettings()
std::vector< wxEvtHandler * > m_boardChangeListeners
FOOTPRINT * SelectFootprintFromLibrary(LIB_ID aPreselect=LIB_ID())
Open a dialog to select a footprint.
void FocusOnItems(std::vector< BOARD_ITEM * > aItems, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, bool aAllowScroll=true)
void GetLibraryItemsForListDialog(wxArrayString &aHeaders, std::vector< wxArrayString > &aItemsToDisplay)
void OnFPChange(wxFileSystemWatcherEvent &aEvent)
Handler for FP change events.
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
const VECTOR2I & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
const TITLE_BLOCK & GetTitleBlock() const override
const PAGE_INFO & GetPageSettings() const override
BOX2I GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
EDA_ITEM * ResolveItem(const KIID &aId, bool aAllowNullptrReturn=false) const override
Fetch an item by KIID.
FOOTPRINT * LoadFootprint(const LIB_ID &aFootprintId)
Attempt to load aFootprintId from the footprint library table.
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.
void SetDrawBgColor(const COLOR4D &aColor) override
void OnFpChangeDebounceTimer(wxTimerEvent &aEvent)
Handler for the filesystem watcher debounce timer.
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.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock) 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 BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Return the BOARD_DESIGN_SETTINGS for the open project.
virtual void ShowChangedLanguage() override
Redraw the menus and what not in current language.
void AddBoardChangeListener(wxEvtHandler *aListener)
Add aListener to post #EDA_EVT_BOARD_CHANGED command events to.
virtual void AddFootprintToBoard(FOOTPRINT *aFootprint)
Add the given footprint to the board.
virtual void doReCreateMenuBar() override
void SetDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions, bool aRefresh=true)
Update the current display options.
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide()
virtual void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings)
virtual BOARD_ITEM_CONTAINER * GetModel() const =0
void PlaceFootprint(FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
Place aFootprint at the current cursor position and updates footprint coordinates with the new positi...
wxString MessageTextFromCoord(int aValue, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType) const
void FocusOnItem(EDA_ITEM *aItem, bool aAllowScroll=true) override
Focus on a particular canvas item.
PCB_DISPLAY_OPTIONS m_displayOptions
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings() const
PCB_LAYER_ID SelectOneLayer(PCB_LAYER_ID aDefaultLayer, const LSET &aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
Show the dialog box for a layer selection.
void SetGridOrigin(const VECTOR2I &aPoint) override
PCB_ORIGIN_TRANSFORMS m_originTransforms
EDA_3D_VIEWER_FRAME * CreateAndShow3D_Frame()
Show the 3D view frame.
wxTimer m_watcherDebounceTimer
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
virtual COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
void Compile_Ratsnest(bool aDisplayStatus)
Create the entire board ratsnest.
Definition ratsnest.cpp:35
wxFileName m_watcherFileName
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
virtual void UpdateStatusBar() override
Update the status bar information.
virtual void AppendCopyToUndoList(const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)
As SaveCopyInUndoList, but appends the changes to the last undo item on the stack.
Class to display a pcb layer list in a wxBitmapComboBox.
Parameters and options when plotting/printing a board.
PCB_LAYER_ID m_Active_Layer
Definition pcb_screen.h:42
A holder to handle information on schematic or board items.
A progress reporter interface for use in multi-threaded environments.
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition title_block.h:41
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
ZONE_SETTINGS handles zones parameters.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition frame_type.h:33
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ UNDEFINED_LAYER
Definition layer_ids.h:61
wxDECLARE_EVENT(EDA_EVT_BOARD_CHANGED, wxCommandEvent)
SEVERITY
#define wxFileSystemWatcher
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695