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) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
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#ifndef PCB_BASE_FRAME_H
27#define PCB_BASE_FRAME_H
28
29
30#include <eda_item.h>
31#include <board.h>
32#include <eda_draw_frame.h>
33#include <outline_mode.h>
34#include <lib_id.h>
35#include <pcb_display_options.h>
36#include <pcb_draw_panel_gal.h>
38#include <pcb_screen.h>
39#include <vector>
40
41#include <wx/fswatcher.h>
42#include <wx/datetime.h>
43#include <wx/timer.h>
44
45/* Forward declarations of classes. */
47class BOARD;
49class COLOR_SETTINGS;
50class FOOTPRINT;
51class PAD;
56class ZONE_SETTINGS;
57class PCB_PLOT_PARAMS;
58class FP_LIB_TABLE;
60class PCBNEW_SETTINGS;
65
66wxDECLARE_EVENT( EDA_EVT_BOARD_CHANGED, wxCommandEvent );
67
72{
73public:
74 PCB_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
75 const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
76 long aStyle, const wxString& aFrameName );
77
79
84
92 virtual void Update3DView( bool aMarkDirty, bool aRefresh, const wxString* aTitle = nullptr );
93
101 FOOTPRINT* LoadFootprint( const LIB_ID& aFootprintId );
102
109 BOX2I GetBoardBoundingBox( bool aBoardEdgesOnly = false ) const;
110
111 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override
112 {
113 /* "Zoom to Fit" calls this with "aIncludeAllVisible" as true. Since that feature
114 * always ignored the page and border, this function returns a bbox without them
115 * as well when passed true. This technically is not all things visible, but it
116 * keeps behavior consistent.
117 *
118 * When passed false, this function returns a bbox of just the board edge. This
119 * allows things like fabrication text or anything else outside the board edge to
120 * be ignored, and just zooms up to the board itself.
121 *
122 * Calling "GetBoardBoundingBox(true)" when edge cuts are turned off will return
123 * the entire page and border, so we call "GetBoardBoundingBox(false)" instead.
124 */
125 if( aIncludeAllVisible || !m_pcb->IsLayerVisible( Edge_Cuts ) )
126 return GetBoardBoundingBox( false );
127 else
128 return GetBoardBoundingBox( true );
129 }
130
131 virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
132 const PAGE_INFO& GetPageSettings() const override;
133 const VECTOR2I GetPageSizeIU() const override;
134
135 const VECTOR2I& GetGridOrigin() const override;
136 void SetGridOrigin( const VECTOR2I& aPoint ) override;
137
138 const VECTOR2I& GetAuxOrigin() const;
139
140 const VECTOR2I GetUserOrigin() const;
141
146
147 const TITLE_BLOCK& GetTitleBlock() const override;
148 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
149
154
158 virtual COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override
159 {
160 wxFAIL_MSG( wxT( "Color settings requested for a PCB_BASE_FRAME that does not override!" ) );
161 return nullptr;
162 }
163
164 void SetDrawBgColor( const COLOR4D& aColor ) override;
165
171
177 void SetDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions, bool aRefresh = true );
178
179 const ZONE_SETTINGS& GetZoneSettings() const;
180 void SetZoneSettings( const ZONE_SETTINGS& aSettings );
181
185 virtual const PCB_PLOT_PARAMS& GetPlotSettings() const;
186 virtual void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings );
187
192 virtual void ReloadFootprint( FOOTPRINT* aFootprint )
193 {
194 wxFAIL_MSG( wxT( "Attempted to reload a footprint for PCB_BASE_FRAME that does not override!" ) );
195 }
196
200 virtual void SetBoard( BOARD* aBoard, PROGRESS_REPORTER* aReporter = nullptr );
201
203 {
204 wxASSERT( m_pcb );
205 return m_pcb;
206 }
207
211 virtual BOARD_ITEM_CONTAINER* GetModel() const = 0;
212
213 EDA_ITEM* GetItem( const KIID& aId ) const override;
214
215 void FocusOnItem( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer = UNDEFINED_LAYER );
216 void FocusOnItems( std::vector<BOARD_ITEM*> aItems, PCB_LAYER_ID aLayer = UNDEFINED_LAYER );
217
218 void HideSolderMask();
219 void ShowSolderMask();
220
221 // General
222 virtual void ShowChangedLanguage() override;
223 virtual void UpdateStatusBar() override;
224
225 PCB_SCREEN* GetScreen() const override { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
226
233
238
245 wxString SelectLibrary( const wxString& aNicknameExisting );
246
253
258 void OnModify() override;
259
274 FOOTPRINT* CreateNewFootprint( const wxString& aFootprintName, const wxString& aLibName,
275 bool aQuiet );
276
283 void PlaceFootprint( FOOTPRINT* aFootprint, bool aRecreateRatsnest = true );
284
285 void ShowPadPropertiesDialog( PAD* aPad );
286
293
299 virtual void AddFootprintToBoard( FOOTPRINT* aFootprint );
300
309 void Compile_Ratsnest( bool aDisplayStatus );
310
317 virtual void SaveCopyInUndoList( EDA_ITEM* aItemToCopy, UNDO_REDO aTypeCommand ) {};
318
325 virtual void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
326 UNDO_REDO aTypeCommand ) {};
327
331 virtual void AppendCopyToUndoList( const PICKED_ITEMS_LIST& aItemsList,
332 UNDO_REDO aTypeCommand ) {};
333
334
345 PCB_LAYER_ID SelectOneLayer( PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask = LSET(),
346 wxPoint aDlgPosition = wxDefaultPosition );
347
353 virtual void SwitchLayer( PCB_LAYER_ID aLayer );
354
355 virtual void SetActiveLayer( PCB_LAYER_ID aLayer ) { GetScreen()->m_Active_Layer = aLayer; }
357
358 SEVERITY GetSeverity( int aErrorCode ) const override;
359
360 virtual void OnDisplayOptionsChanged() {}
361
362 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
363 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
364
366
368
370
372
373 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
374
375 PCB_DRAW_PANEL_GAL* GetCanvas() const override;
376
377 virtual void ActivateGalCanvas() override;
378
388 void AddBoardChangeListener( wxEvtHandler* aListener );
389
393 void RemoveBoardChangeListener( wxEvtHandler* aListener );
394
398 void OnFPChange( wxFileSystemWatcherEvent& aEvent );
399
403 void OnFpChangeDebounceTimer( wxTimerEvent& aEvent );
404
405protected:
406 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;
407
408 void handleActivateEvent( wxActivateEvent& aEvent ) override;
409
410 void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
411
412 virtual void doReCreateMenuBar() override;
413
423 FOOTPRINT* loadFootprint( const LIB_ID& aFootprintId );
424
425 virtual void unitsChangeRefresh() override;
426
427 void rebuildConnectivity();
428
433 void setFPWatcher( FOOTPRINT* aFootprint );
434
435protected:
439
440private:
442
443 std::unique_ptr<wxFileSystemWatcher> m_watcher;
447
448 std::vector<wxEvtHandler*> m_boardChangeListeners;
449};
450
451#endif // PCB_BASE_FRAME_H
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
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:77
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:271
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition: board.cpp:620
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.
The base class for create windows for drawing purpose.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:321
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:204
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:279
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: layer_ids.h:552
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...
Definition: pad.h:58
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
SEVERITY GetSeverity(int aErrorCode) const override
std::unique_ptr< wxFileSystemWatcher > m_watcher
virtual void SaveCopyInUndoList(const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)
Creates a new entry in undo list of commands.
virtual void ReloadFootprint(FOOTPRINT *aFootprint)
Reload the footprint from the library.
PCB_LAYER_ID SelectOneLayer(PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
Show the dialog box for a layer selection.
Definition: sel_layer.cpp:275
virtual void OnDisplayOptionsChanged()
void FocusOnItems(std::vector< BOARD_ITEM * > aItems, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
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.
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.
FOOTPRINT * GetFootprintFromBoardByReference()
void setFPWatcher(FOOTPRINT *aFootprint)
Creates (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 ...
EDA_ITEM * GetItem(const KIID &aId) const override
Fetch an item by KIID.
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Returns bbox 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...
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual void SwitchLayer(PCB_LAYER_ID aLayer)
Change the active layer in the frame.
virtual PCB_LAYER_ID GetActiveLayer() const
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)
Attempts 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 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.
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).
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.
wxString SelectLibrary(const wxString &aNicknameExisting)
Put up a dialog and allows the user to pick a library, for unspecified use.
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
NL_PCBNEW_PLUGIN * m_spaceMouse
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock) override
const ZONE_SETTINGS & GetZoneSettings() const
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.
void SetZoneSettings(const ZONE_SETTINGS &aSettings)
BOARD * GetBoard() const
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns 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)
Updates the current display options from the given options struct.
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)
Places aFootprint at the current cursor position and updates footprint coordinates with the new posit...
PCB_DISPLAY_OPTIONS m_displayOptions
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings() const
void SetGridOrigin(const VECTOR2I &aPoint) override
FOOTPRINT * CreateNewFootprint(const wxString &aFootprintName, const wxString &aLibName, bool aQuiet)
Creates a new footprint, at position 0,0.
PCB_ORIGIN_TRANSFORMS m_originTransforms
EDA_3D_VIEWER_FRAME * CreateAndShow3D_Frame()
Shows 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
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
void FocusOnItem(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
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.
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
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:70
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
@ Edge_Cuts
Definition: layer_ids.h:114
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
wxDECLARE_EVENT(EDA_EVT_BOARD_CHANGED, wxCommandEvent)
SEVERITY
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...