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 #include <pcb_origin_transforms.h>
46 
47 /* Forward declarations of classes. */
48 class APP_SETTINGS_BASE;
49 class BOARD;
51 class COLOR_SETTINGS;
52 class MODULE;
53 class TRACK;
54 class D_PAD;
55 class TEXTE_MODULE;
56 class EDA_3D_VIEWER;
57 class GENERAL_COLLECTOR;
60 class ZONE_SETTINGS;
61 class PCB_PLOT_PARAMS;
62 class FP_LIB_TABLE;
63 class PCBNEW_SETTINGS;
65 struct MAGNETIC_SETTINGS;
66 
67 
68 wxDECLARE_EVENT( BOARD_CHANGED, wxCommandEvent );
69 
75 {
76 protected:
78 
80 
82 
83  PCBNEW_SETTINGS* m_Settings; // No ownership, just a shortcut
84 
85  virtual void unitsChangeRefresh() override;
86 
97  MODULE* loadFootprint( const LIB_ID& aFootprintId );
98 
99 public:
100  PCB_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
101  const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
102  long aStyle, const wxString& aFrameName );
103 
104  ~PCB_BASE_FRAME();
105 
110 
118  virtual void Update3DView( bool aForceReload, const wxString* aTitle = nullptr );
119 
128  MODULE* LoadFootprint( const LIB_ID& aFootprintId );
129 
136  EDA_RECT GetBoardBoundingBox( bool aBoardEdgesOnly = false ) const;
137 
138  const BOX2I GetDocumentExtents() const override
139  {
140  return GetBoardBoundingBox( false );
141  }
142 
143  virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
144  const PAGE_INFO& GetPageSettings() const override;
145  const wxSize GetPageSizeIU() const override;
146 
147  const wxPoint& GetGridOrigin() const override;
148  void SetGridOrigin( const wxPoint& aPoint ) override;
149 
150  const wxPoint& GetAuxOrigin() const;
151 
152  const wxPoint GetUserOrigin() const;
153 
158 
159  const TITLE_BLOCK& GetTitleBlock() const override;
160  void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
161 
166  virtual BOARD_DESIGN_SETTINGS& GetDesignSettings() const;
167 
172  virtual COLOR_SETTINGS* GetColorSettings() override
173  {
174  wxFAIL_MSG( "Color settings requested for a PCB_BASE_FRAME that does not override!" );
175  return nullptr;
176  }
177 
179 
180  void SetDrawBgColor( COLOR4D aColor ) override;
181 
188  void SetDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions );
189 
190  const ZONE_SETTINGS& GetZoneSettings() const;
191  void SetZoneSettings( const ZONE_SETTINGS& aSettings );
192 
198  virtual const PCB_PLOT_PARAMS& GetPlotSettings() const;
199  virtual void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings );
200 
207  virtual void SetBoard( BOARD* aBoard );
208 
209  BOARD* GetBoard() const
210  {
211  wxASSERT( m_Pcb );
212  return m_Pcb;
213  }
214 
219  virtual BOARD_ITEM_CONTAINER* GetModel() const = 0;
220 
221  EDA_ITEM* GetItem( const KIID& aId ) override;
222 
223  void FocusOnItem( BOARD_ITEM* aItem );
224 
225  // General
226  virtual void ReCreateOptToolbar() override { }
227  virtual void ShowChangedLanguage() override;
228  virtual void ReCreateMenuBar() override;
229  virtual void UpdateStatusBar() override;
230 
231  PCB_SCREEN* GetScreen() const override { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
232 
239 
245 
253  wxString SelectLibrary( const wxString& aNicknameExisting );
254 
262 
270  virtual void OnModify();
271 
272  // Modules (footprints)
273 
285  MODULE* CreateNewModule( const wxString& aModuleName );
286 
295  void PlaceModule( MODULE* aModule, bool aRecreateRatsnest = true );
296 
297  void InstallPadOptionsFrame( D_PAD* pad );
298 
305  MODULE* SelectFootprintFromLibTree( LIB_ID aPreselect = LIB_ID() );
306 
312  virtual void AddModuleToBoard( MODULE* module );
313 
321 
330  void Compile_Ratsnest( bool aDisplayStatus );
331 
332  /* Functions relative to Undo/redo commands: */
333 
343  virtual void SaveCopyInUndoList( EDA_ITEM* aItemToCopy, UNDO_REDO aTypeCommand,
344  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) = 0;
345 
355  virtual void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO aTypeCommand,
356  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) = 0;
357 
358 
366  PCB_LAYER_ID SelectLayer( PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask = LSET(),
367  wxPoint aDlgPosition = wxDefaultPosition );
368 
369  virtual void SwitchLayer( wxDC* DC, PCB_LAYER_ID layer );
370 
371  virtual void SetActiveLayer( PCB_LAYER_ID aLayer )
372  {
373  GetScreen()->m_Active_Layer = aLayer;
374  }
375 
376  virtual PCB_LAYER_ID GetActiveLayer() const
377  {
378  return GetScreen()->m_Active_Layer;
379  }
380 
381  int GetSeverity( int aErrorCode ) const override;
382 
383  virtual void OnDisplayOptionsChanged() {}
384 
385  void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
386  void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
387 
389 
391 
393 
394  void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
395 
396  virtual void OnUpdateLayerAlpha( wxUpdateUIEvent& aEvent ) {}
397 
403  void DisplayGridMsg() override;
404 
405  PCB_DRAW_PANEL_GAL* GetCanvas() const override;
406 
408  virtual void ActivateGalCanvas() override;
409 
413  virtual void SetAutoZoom( bool aAutoZoom ) {}
414 
418  virtual bool GetAutoZoom() { return false; }
419 };
420 
421 #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.
virtual void OnDisplayOptionsChanged()
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()
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
virtual COLOR_SETTINGS * GetColorSettings() override
Helper to retrieve the current color settings.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
const wxPoint & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
const wxPoint GetUserOrigin() const
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:37
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...
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
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:99
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()
PCB_ORIGIN_TRANSFORMS m_OriginTransforms
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.
A class to perform either relative or absolute display origin transforms for a single axis of a point...
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
ORIGIN_TRANSFORMS & GetOriginTransforms() override
Return a reference to the default ORIGIN_TRANSFORMS object.
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
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.
virtual void SaveCopyInUndoList(EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0))=0
Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands.
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:390
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
const wxPoint & GetAuxOrigin() const