KiCad PCB EDA Suite
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 <stambaughw@verizon.net>
6  * Copyright (C) 1992-2019 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 
31 #ifndef PCB_BASE_FRAME_H
32 #define PCB_BASE_FRAME_H
33 
34 
35 #include <vector>
36 
37 #include <eda_draw_frame.h>
38 #include <base_struct.h>
39 #include <eda_text.h> // EDA_DRAW_MODE_T
40 #include <richio.h>
41 #include <pcb_screen.h>
42 #include <pcb_display_options.h>
43 #include <pcb_draw_panel_gal.h>
44 #include <lib_id.h>
45 
46 /* Forward declarations of classes. */
47 class APP_SETTINGS_BASE;
48 class BOARD;
50 class COLOR_SETTINGS;
51 class MODULE;
52 class TRACK;
53 class D_PAD;
54 class TEXTE_MODULE;
55 class EDA_3D_VIEWER;
56 class GENERAL_COLLECTOR;
59 class ZONE_SETTINGS;
60 class PCB_PLOT_PARAMS;
61 class FP_LIB_TABLE;
62 class PCBNEW_SETTINGS;
64 struct MAGNETIC_SETTINGS;
65 
66 
67 wxDECLARE_EVENT( BOARD_CHANGED, wxCommandEvent );
68 
74 {
75 protected:
77 
79 
80  PCBNEW_SETTINGS* m_Settings; // No ownership, just a shortcut
81 
82  virtual void unitsChangeRefresh() override;
83 
94  MODULE* loadFootprint( const LIB_ID& aFootprintId );
95 
96 public:
97  PCB_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
98  const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
99  long aStyle, const wxString& aFrameName );
100 
101  ~PCB_BASE_FRAME();
102 
107 
115  virtual void Update3DView( bool aForceReload, const wxString* aTitle = nullptr );
116 
125  MODULE* LoadFootprint( const LIB_ID& aFootprintId );
126 
133  EDA_RECT GetBoardBoundingBox( bool aBoardEdgesOnly = false ) const;
134 
135  const BOX2I GetDocumentExtents() const override
136  {
137  return GetBoardBoundingBox( false );
138  }
139 
140  virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
141  const PAGE_INFO& GetPageSettings() const override;
142  const wxSize GetPageSizeIU() const override;
143 
144  const wxPoint& GetGridOrigin() const override;
145  void SetGridOrigin( const wxPoint& aPoint ) override;
146 
147  const TITLE_BLOCK& GetTitleBlock() const override;
148  void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
149 
154  virtual BOARD_DESIGN_SETTINGS& GetDesignSettings() const;
155 
160  virtual COLOR_SETTINGS* GetColorSettings() override
161  {
162  wxFAIL_MSG( "Color settings requested for a PCB_BASE_FRAME that does not override!" );
163  return nullptr;
164  }
165 
167 
168  void SetDrawBgColor( COLOR4D aColor ) override;
169 
176  void SetDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions ) { m_DisplayOptions = aOptions; }
177 
178  const ZONE_SETTINGS& GetZoneSettings() const;
179  void SetZoneSettings( const ZONE_SETTINGS& aSettings );
180 
186  virtual const PCB_PLOT_PARAMS& GetPlotSettings() const;
187  virtual void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings );
188 
195  virtual void SetBoard( BOARD* aBoard );
196 
197  BOARD* GetBoard() const
198  {
199  wxASSERT( m_Pcb );
200  return m_Pcb;
201  }
202 
207  virtual BOARD_ITEM_CONTAINER* GetModel() const = 0;
208 
209  EDA_ITEM* GetItem( const KIID& aId ) override;
210 
211  void FocusOnItem( BOARD_ITEM* aItem );
212 
213  // General
214  virtual void OnCloseWindow( wxCloseEvent& Event ) = 0;
215  virtual void ReCreateOptToolbar() override { }
216  virtual void ShowChangedLanguage() override;
217  virtual void ReCreateMenuBar() override;
218  virtual void UpdateStatusBar() override;
219 
220  PCB_SCREEN* GetScreen() const override { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
221 
228 
234 
242  wxString SelectLibrary( const wxString& aNicknameExisting );
243 
251 
259  virtual void OnModify();
260 
261  // Modules (footprints)
262 
274  MODULE* CreateNewModule( const wxString& aModuleName );
275 
284  void PlaceModule( MODULE* aModule, bool aRecreateRatsnest = true );
285 
286  void InstallPadOptionsFrame( D_PAD* pad );
287 
294  MODULE* SelectFootprintFromLibTree( LIB_ID aPreselect = LIB_ID() );
295 
301  virtual void AddModuleToBoard( MODULE* module );
302 
310 
319  void Compile_Ratsnest( bool aDisplayStatus );
320 
321  /* Functions relative to Undo/redo commands: */
322 
332  virtual void SaveCopyInUndoList( BOARD_ITEM* aItemToCopy, UNDO_REDO_T aTypeCommand,
333  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) = 0;
334 
344  virtual void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO_T aTypeCommand,
345  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) = 0;
346 
347 
355  PCB_LAYER_ID SelectLayer( PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask = LSET(),
356  wxPoint aDlgPosition = wxDefaultPosition );
357 
358  virtual void SwitchLayer( wxDC* DC, PCB_LAYER_ID layer );
359 
360  virtual void SetActiveLayer( PCB_LAYER_ID aLayer )
361  {
362  GetScreen()->m_Active_Layer = aLayer;
363  }
364 
365  virtual PCB_LAYER_ID GetActiveLayer() const
366  {
367  return GetScreen()->m_Active_Layer;
368  }
369 
370  int GetSeverity( int aErrorCode ) const override;
371 
372  void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
373  void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
374 
376 
378 
380 
381  void CommonSettingsChanged( bool aEnvVarsChanged ) override;
382 
383  virtual void OnUpdateLayerAlpha( wxUpdateUIEvent& aEvent ) {}
384 
390  void DisplayGridMsg() override;
391 
392  PCB_DRAW_PANEL_GAL* GetCanvas() const override;
393 
395  virtual void ActivateGalCanvas() override;
396 
400  virtual void SetAutoZoom( bool aAutoZoom ) {}
401 
405  virtual bool GetAutoZoom() { return false; }
406 };
407 
408 #endif // PCB_BASE_FRAME_H
wxString SelectFootprintFromLibBrowser()
Function SelectFootprintFromLibBrowser launches the footprint viewer to select the name of a footprin...
virtual void SetBoard(BOARD *aBoard)
Function SetBoard sets the m_Pcb member in such as way as to ensure deleting any previous BOARD.
virtual void ShowChangedLanguage() override
Redraw the menus and what not in current language.
void DisplayGridMsg() override
Function DisplayGridMsg()
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project Overloaded in FOOTPRINT_EDIT_FRAME.
virtual void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetGridOrigin(const wxPoint &aPoint) override
EDA_ITEM * GetItem(const KIID &aId) override
Fetch an item by KIID.
virtual void AddModuleToBoard(MODULE *module)
Adds the given module to the board.
void Compile_Ratsnest(bool aDisplayStatus)
Function Compile_Ratsnest Create the entire board ratsnest.
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
FRAME_T
Enum FRAME_T is the set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:34
FOOTPRINT_EDITOR_SETTINGS * GetFootprintEditorSettings()
virtual COLOR_SETTINGS * GetColorSettings() override
Helper to retrieve the current color settings.
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void CommonSettingsChanged(bool aEnvVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
const wxPoint & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
MODULE * SelectFootprintFromLibTree(LIB_ID aPreselect=LIB_ID())
Function SelectFootprintFromLibTree opens a dialog to select a footprint.
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock) override
void SetDisplayOptions(const PCB_DISPLAY_OPTIONS &aOptions)
void SetDrawBgColor(COLOR4D aColor) override
virtual MAGNETIC_SETTINGS * GetMagneticItemsSettings()
PCBNEW_SETTINGS * GetPcbNewSettings()
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
PCB_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
The base class for create windows for drawing purpose.
MODULE * CreateNewModule(const wxString &aModuleName)
Function CreateNewModule Creates a new module or footprint, at position 0,0 The new module contains o...
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Function GetPlotSettings returns the PCB_PLOT_PARAMS for the BOARD owned by this frame.
PCB_LAYER_ID m_Active_Layer
Definition: pcb_screen.h:44
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Function GetDisplayOptions Display options control the way tracks, vias, outlines and other things ar...
TITLE_BLOCK holds the information shown in the lower right corner of a plot, printout,...
Definition: title_block.h:40
BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected and have...
virtual bool GetAutoZoom()
Always returns false.
virtual PCB_LAYER_ID GetActiveLayer() const
Definition: common.h:68
PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
PCB_LAYER_ID
A quick note on layer IDs:
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide()
Function GetCollectorsGuide.
LSET is a set of PCB_LAYER_IDs.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:91
virtual void ActivateGalCanvas() override
EDA_3D_VIEWER * CreateAndShow3D_Frame()
Shows the 3D view frame.
PAGE_INFO describes the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
const ZONE_SETTINGS & GetZoneSettings() const
virtual void OnUpdateLayerAlpha(wxUpdateUIEvent &aEvent)
KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the s...
Definition: kiway.h:273
virtual void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings)
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge se...
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
virtual void ReCreateMenuBar() override
Recreates the menu bar.
PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
int GetSeverity(int aErrorCode) const override
PCB_DISPLAY_OPTIONS m_DisplayOptions
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Saves common frame parameters to a configuration data file.
virtual void SwitchLayer(wxDC *DC, PCB_LAYER_ID layer)
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:67
virtual BOARD_ITEM_CONTAINER * GetModel() const =0
Function GetModel()
virtual void OnCloseWindow(wxCloseEvent &Event)=0
PCBNEW_SETTINGS * m_Settings
const TITLE_BLOCK & GetTitleBlock() const override
virtual void OnModify()
Function OnModify Must be called after a change in order to set the "modify" flag of the current scre...
virtual void UpdateStatusBar() override
Update the status bar information.
wxDECLARE_EVENT(BOARD_CHANGED, wxCommandEvent)
MODULE * LoadFootprint(const LIB_ID &aFootprintId)
Function LoadFootprint attempts to load aFootprintId from the footprint library table.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:180
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:240
virtual void SetAutoZoom(bool aAutoZoom)
Does nothing.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
PCBNEW_SETTINGS & Settings()
const PAGE_INFO & GetPageSettings() const override
virtual void SaveCopyInUndoList(BOARD_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0))=0
Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands.
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetZoneSettings(const ZONE_SETTINGS &aSettings)
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
Definition: eda_3d_viewer.h:65
wxString SelectLibrary(const wxString &aNicknameExisting)
Function SelectLibrary puts up a dialog and allows the user to pick a library, for unspecified use.
void InstallPadOptionsFrame(D_PAD *pad)
MODULE * GetFootprintFromBoardByReference()
Function GetFootprintFromBoardByReference.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
BOARD * GetBoard() const
void PlaceModule(MODULE *aModule, bool aRecreateRatsnest=true)
Function PlaceModule places aModule at the current cursor position and updates module coordinates wit...
virtual void ReCreateOptToolbar() override
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:385
virtual void Update3DView(bool aForceReload, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
EDA_3D_VIEWER * Get3DViewerFrame()
Definition of PCB_DISPLAY_OPTIONS class.
PCB_LAYER_ID SelectLayer(PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
Install the dialog box for layer selection.
Definition: sel_layer.cpp:206
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
MODULE * loadFootprint(const LIB_ID &aFootprintId)
Function loadFootprint attempts to load aFootprintId from the footprint library table.
void FocusOnItem(BOARD_ITEM *aItem)
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
const BOX2I GetDocumentExtents() const override
BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99