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_general_settings.h>
44 #include <pcb_draw_panel_gal.h>
45 #include <lib_id.h>
46 
47 /* Forward declarations of classes. */
48 class BOARD;
50 class MODULE;
51 class TRACK;
52 class D_PAD;
53 class TEXTE_MODULE;
54 class EDA_3D_VIEWER;
55 class GENERAL_COLLECTOR;
58 class ZONE_SETTINGS;
59 class PCB_PLOT_PARAMS;
60 class FP_LIB_TABLE;
61 
67 {
68 public:
70 
71  int m_FastGrid1; // 1st fast grid setting (index in EDA_DRAW_FRAME::m_gridSelectBox)
72  int m_FastGrid2; // 2nd fast grid setting (index in EDA_DRAW_FRAME::m_gridSelectBox)
73 
74 protected:
76 
78 
80 
81  void updateZoomSelectBox();
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& GetAuxOrigin() const override;
145  void SetAuxOrigin( const wxPoint& aPoint ) override;
146 
147  const wxPoint& GetGridOrigin() const override;
148  void SetGridOrigin( const wxPoint& aPoint ) override;
149 
150  const TITLE_BLOCK& GetTitleBlock() const override;
151  void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
152 
158  virtual BOARD_DESIGN_SETTINGS& GetDesignSettings() const;
159  virtual void SetDesignSettings( const BOARD_DESIGN_SETTINGS& aSettings );
160 
161  void SetDrawBgColor( COLOR4D aColor ) override;
162 
170  {
171  return m_DisplayOptions;
172  }
173 
174  void SetDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions )
175  {
176  m_DisplayOptions = aOptions;
177  }
178 
179  const ZONE_SETTINGS& GetZoneSettings() const;
180  void SetZoneSettings( const ZONE_SETTINGS& aSettings );
181 
187  virtual const PCB_PLOT_PARAMS& GetPlotSettings() const;
188  virtual void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings );
189 
196  virtual void SetBoard( BOARD* aBoard );
197 
198  BOARD* GetBoard() const
199  {
200  wxASSERT( m_Pcb );
201  return m_Pcb;
202  }
203 
204  // General
205  virtual void OnCloseWindow( wxCloseEvent& Event ) = 0;
206  virtual void ReCreateOptToolbar() override { }
207  virtual void ShowChangedLanguage() override;
208  virtual void ReCreateMenuBar() override;
209  virtual void UpdateStatusBar() override;
210 
211  PCB_SCREEN* GetScreen() const override { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
212 
213  void UpdateGridSelectBox();
214 
221  const wxString GetZoomLevelIndicator() const override;
222 
229 
236 
244  wxString SelectLibrary( const wxString& aNicknameExisting );
245 
253 
263  virtual void OnModify();
264 
265  // Modules (footprints)
266 
278  MODULE* CreateNewModule( const wxString& aModuleName );
279 
280  void Edit_Module( MODULE* module, wxDC* DC );
281 
290  void PlaceModule( MODULE* aModule, bool aRecreateRatsnest = true );
291 
292  void InstallPadOptionsFrame( D_PAD* pad );
293 
300  MODULE* SelectFootprintFromLibTree( LIB_ID aPreselect = LIB_ID() );
301 
307  virtual void AddModuleToBoard( MODULE* module );
308 
316 
317  // ratsnest functions
326  void Compile_Ratsnest( bool aDisplayStatus );
327 
328  /* Functions relative to Undo/redo commands: */
329 
339  virtual void SaveCopyInUndoList( BOARD_ITEM* aItemToCopy,
340  UNDO_REDO_T aTypeCommand,
341  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) = 0;
342 
352  virtual void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
353  UNDO_REDO_T aTypeCommand,
354  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) = 0;
355 
356 
364  PCB_LAYER_ID SelectLayer( PCB_LAYER_ID aDefaultLayer,
365  LSET aNotAllowedLayersMask = LSET(),
366  wxPoint aDlgPosition = wxDefaultPosition );
367 
368  virtual void SwitchLayer( wxDC* DC, PCB_LAYER_ID layer );
369 
374  virtual void SetActiveLayer( PCB_LAYER_ID aLayer )
375  {
376  GetScreen()->m_Active_Layer = aLayer;
377  }
378 
383  virtual PCB_LAYER_ID GetActiveLayer() const
384  {
385  return GetScreen()->m_Active_Layer;
386  }
387 
388  void LoadSettings( wxConfigBase* aCfg ) override;
389  void SaveSettings( wxConfigBase* aCfg ) override;
390 
391  void CommonSettingsChanged( bool aEnvVarsChanged ) override;
392 
393  void OnTogglePadDrawMode( wxCommandEvent& aEvent );
394  void OnToggleGraphicDrawMode( wxCommandEvent& aEvent );
395  void OnToggleEdgeDrawMode( wxCommandEvent& aEvent );
396  void OnToggleTextDrawMode( wxCommandEvent& aEvent );
397 
398  // User interface update event handlers.
399  void OnUpdateSelectZoom( wxUpdateUIEvent& aEvent );
400 
401  virtual void OnUpdateLayerAlpha( wxUpdateUIEvent& aEvent ) {}
402 
408  void SetFastGrid1();
409 
415  void SetFastGrid2();
416 
422  virtual bool IsGridVisible() const override;
423 
432  virtual void SetGridVisibility( bool aVisible ) override;
433 
439  void DisplayGridMsg();
440 
441  PCB_DRAW_PANEL_GAL* GetCanvas() const override;
442 
444  virtual void ActivateGalCanvas() override;
445 
447  {
448  return m_configSettings;
449  }
450 
452  static const wxChar AUTO_ZOOM_KEY[];
453  static const wxChar ZOOM_KEY[];
454 
455  DECLARE_EVENT_TABLE()
456 };
457 
458 #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 OnTogglePadDrawMode(wxCommandEvent &aEvent)
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings returns the BOARD_DESIGN_SETTINGS for the BOARD owned by this frame.
virtual void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void OnToggleTextDrawMode(wxCommandEvent &aEvent)
virtual bool IsGridVisible() const override
Function IsGridVisible()
void SetGridOrigin(const wxPoint &aPoint) override
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
void OnToggleEdgeDrawMode(wxCommandEvent &aEvent)
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
void SetFastGrid2()
Function SetFastGrid2()
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.
void OnToggleGraphicDrawMode(wxCommandEvent &aEvent)
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
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
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 returns the display options current in use Display options are relative to...
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...
void OnUpdateSelectZoom(wxUpdateUIEvent &aEvent)
const wxPoint & GetAuxOrigin() const override
Return the origin of the axis used for plotting and various exports.
static const wxChar AUTO_ZOOM_KEY[]
Key in KifaceSettings to store the canvas type.
void SetFastGrid1()
Function SetFastGrid1()
virtual PCB_LAYER_ID GetActiveLayer() const
Function GetActiveLayer returns the active layer.
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.
virtual void ActivateGalCanvas() override
EDA_3D_VIEWER * CreateAndShow3D_Frame()
Shows the 3D view frame.
PCB_GENERAL_SETTINGS & Settings()
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:274
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...
PCB_GENERAL_SETTINGS m_configSettings
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
Function SetActiveLayer will change the currently active layer to aLayer.
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
void SaveSettings(wxConfigBase *aCfg) override
Saves common frame parameters to a configuration data file.
wxPoint m_UserGridSize
virtual void ReCreateMenuBar() override
Recreates the menu bar.
PCB_PLOT_PARAMS handles plot parameters and options when plotting/printing a board.
PCB_DISPLAY_OPTIONS m_DisplayOptions
void UpdateGridSelectBox()
virtual void SwitchLayer(wxDC *DC, PCB_LAYER_ID layer)
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:58
virtual void OnCloseWindow(wxCloseEvent &Event)=0
void DisplayGridMsg()
Function DisplayGridMsg()
const TITLE_BLOCK & GetTitleBlock() const override
virtual void OnModify()
Function OnModify Virtual Must be called after a change in order to set the "modify" flag of the curr...
virtual void UpdateStatusBar() override
Update the status bar information.
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:160
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
Used when the right click button is pressed, or when the select tool is in effect.
Definition: collectors.h:240
virtual void SetDesignSettings(const BOARD_DESIGN_SETTINGS &aSettings)
virtual void SetGridVisibility(bool aVisible) override
Function SetGridVisibility() Turn the display of the canvas grid on/off.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
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.
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...
void SetZoneSettings(const ZONE_SETTINGS &aSettings)
void SetAuxOrigin(const wxPoint &aPoint) override
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
Definition: eda_3d_viewer.h:56
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.
void Edit_Module(MODULE *module, wxDC *DC)
BOARD * GetBoard() const
void updateZoomSelectBox()
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:205
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.
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
const BOX2I GetDocumentExtents() const override
static const wxChar ZOOM_KEY[]
BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
const wxString GetZoomLevelIndicator() const override
Function GetZoomLevelIndicator returns a human readable value which can be displayed as zoom level in...
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39