KiCad PCB EDA Suite
gerbview_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) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2013 Wayne Stambaugh <stambaughw@gmail.com>
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 modify it
9  * under the terms of the GNU General Public License as published by the
10  * Free Software Foundation, either version 3 of the License, or (at your
11  * option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with this program. If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef WX_GERBER_STRUCT_H
23 #define WX_GERBER_STRUCT_H
24 
25 
26 #include <pgm_base.h>
27 #include <config_params.h>
28 #include <eda_draw_frame.h>
30 #include <gerbview.h>
31 #include <convert_to_biu.h>
32 #include <gbr_layout.h>
33 #include <gbr_screen.h>
34 #include <page_info.h>
35 #include <gbr_display_options.h>
36 #include <colors_design_settings.h>
37 
39 
40 #define NO_AVAILABLE_LAYERS UNDEFINED_LAYER
41 
45 class GERBER_DRAW_ITEM;
46 class GERBER_FILE_IMAGE;
48 class REPORTER;
49 
50 
56 #define GERBVIEW_FRAME_NAME wxT( "GerberFrame" )
57 
58 class GERBVIEW_FRAME : public EDA_DRAW_FRAME // PCB_BASE_FRAME
59 {
61  wxPoint m_grid_origin;
62  PAGE_INFO m_paper; // used only to show paper limits to screen
64 
65 public:
66 
72  {
73  return m_DisplayOptions;
74  }
75 
76  void SetDisplayOptions( const GBR_DISPLAY_OPTIONS& aOptions )
77  {
78  m_DisplayOptions = aOptions;
79  }
80 
87  void SetLayout( GBR_LAYOUT* aLayout )
88  {
89  delete m_gerberLayout;
90  m_gerberLayout = aLayout;
91  }
92 
94  {
95  wxASSERT( m_gerberLayout );
96  return m_gerberLayout;
97  }
98 
103  {
104  return m_gerberLayout->GetImagesList();
105  }
106 
107  GERBER_FILE_IMAGE* GetGbrImage( int aIdx ) const;
108 
109  unsigned ImagesMaxCount() const;
110 
111 
112  void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
113  const PAGE_INFO& GetPageSettings() const override;
114  const wxSize GetPageSizeIU() const override;
115 
116  const wxPoint& GetAuxOrigin() const override;
117  void SetAuxOrigin( const wxPoint& aPoint ) override;
118 
119  const wxPoint& GetGridOrigin() const override { return m_grid_origin; }
120  void SetGridOrigin( const wxPoint& aPoint ) override { m_grid_origin = aPoint; }
121 
122  const TITLE_BLOCK& GetTitleBlock() const override;
123  void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
124 
140  int SelectPCBLayer( int aDefaultLayer, int aOpperLayerCount, bool aNullLayer = false );
141 
143  virtual void SetGridColor( COLOR4D aColor ) override;
144 
145  const BOX2I GetDocumentExtents() const override
146  {
147  wxASSERT( m_gerberLayout );
148  return m_gerberLayout->ViewBBox();
149  }
150 
151 protected:
153 
157 
158  wxString m_lastFileName; // The last filename chosen to be proposed to the user
159 
160 public:
161  wxChoice* m_SelComponentBox; // a choice box to display and highlight component graphic items
162  wxChoice* m_SelNetnameBox; // a choice box to display and highlight netlist graphic items
163  wxChoice* m_SelAperAttributesBox; // a choice box to display aperture attributes and highlight items
164  GBR_LAYER_BOX_SELECTOR* m_SelLayerBox; // The combobox to select the current active graphic layer
165  // (which is drawn on top on the other layers
166  DCODE_SELECTION_BOX* m_DCodeSelector; // a list box to select the dcode Id to highlight.
167  wxTextCtrl* m_TextInfo; // a wxTextCtrl used to display some info about
168  // gerber data (format..)
169 
171 
172 private:
173  // list of PARAM_CFG_xxx to read/write parameters saved in config
175 
176  int m_displayMode; // Gerber images ("layers" in Gerbview) can be drawn:
177  // - in fast mode (write mode) but if there are negative
178  // items only the last image is correctly drawn (no
179  // problem to see only one image or when no negative items)
180  // - in "exact" mode (but slower) in write mode:
181  // last image covers previous images
182  // - in "exact" mode (also slower) in OR mode
183  // (transparency mode)
184  // m_displayMode = 0, 1 or 2
185 
187 
191  void updateDCodeSelectBox();
192  void updateGridSelectBox();
193  void updateZoomSelectBox();
194  void unitsChangeRefresh() override; // See class EDA_DRAW_FRAME
195 
196  // The Tool Framework initalization
197  void setupTools();
198 
201 
210  bool loadListOfGerberAndDrillFiles( const wxString& aPath,
211  const wxArrayString& aFilenameList,
212  const std::vector<int>* aFileType = nullptr );
213 
214 public:
215  GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent );
216  ~GERBVIEW_FRAME();
217 
218  void OnCloseWindow( wxCloseEvent& Event );
219 
220  bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl ) override;
221 
222  // Virtual basic functions:
223  void ReCreateHToolbar() override;
224  void ReCreateAuxiliaryToolbar() override;
225 
232  void ReCreateVToolbar() override;
233 
237  void ReCreateOptToolbar() override;
238 
239  void ReCreateMenuBar() override;
240  void OnUpdateSelectZoom( wxUpdateUIEvent& aEvent );
241  void UpdateStatusBar() override;
242 
249  const wxString GetZoomLevelIndicator() const override;
250 
257  int GetDisplayMode() { return m_displayMode; }
258 
265  void SetDisplayMode( int aMode ) { m_displayMode = aMode; }
266 
274  bool IsElementVisible( int aLayerID ) const;
275 
283  void SetElementVisibility( int aLayerID, bool aNewState );
284 
290  void SetGridVisibility( bool aVisible ) override;
291 
297  LSET GetVisibleLayers() const;
298 
304  void SetVisibleLayers( LSET aLayerMask );
305 
312  bool IsLayerVisible( int aLayer ) const;
313 
318  COLOR4D GetVisibleElementColor( int aLayerID );
319 
320  void SetVisibleElementColor( int aLayerID, COLOR4D aColor );
321 
326  COLOR4D GetLayerColor( int aLayer ) const;
327 
332  void SetLayerColor( int aLayer, COLOR4D aColor );
333 
341 
347  void ReFillLayerWidget();
348 
354  void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true );
355 
360  int GetActiveLayer();
361 
369  int getNextAvailableLayer( int aLayer = 0 ) const;
370 
371  bool hasAvailableLayers() const
372  {
374  }
375 
384  void syncLayerWidget();
385 
394  void syncLayerBox( bool aRebuildLayerBox = false );
395 
405  void UpdateTitleAndInfo();
406 
412  void DisplayGridMsg();
413 
424 
425  void LoadSettings( wxConfigBase* aCfg ) override;
426  void SaveSettings( wxConfigBase* aCfg ) override;
427 
428  void OnToggleShowLayerManager( wxCommandEvent& aEvent );
429 
430  void ShowChangedLanguage() override;
431 
432  void Process_Special_Functions( wxCommandEvent& event );
433 
435  void OnSelectHighlightChoice( wxCommandEvent& event );
436 
442  void OnSelectActiveDCode( wxCommandEvent& event );
443 
450  void OnSelectActiveLayer( wxCommandEvent& event );
451 
457  void OnShowGerberSourceFile( wxCommandEvent& event );
458 
465  void OnSelectDisplayMode( wxCommandEvent& event );
466 
471  void OnQuit( wxCommandEvent& event );
472 
473  GERBER_DRAW_ITEM* Locate( const wxPoint& aPosition, int typeloc );
474 
475  void OnUpdateDrawMode( wxUpdateUIEvent& aEvent );
476  void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent );
477  void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
478 
479  void Files_io( wxCommandEvent& event );
480 
486  void OnGbrFileHistory( wxCommandEvent& event );
487 
493  void OnDrlFileHistory( wxCommandEvent& event );
494 
500  void OnZipFileHistory( wxCommandEvent& event );
501 
506  void OnJobFileHistory( wxCommandEvent& event );
507 
514  bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr );
515 
524  bool LoadGerberFiles( const wxString& aFileName );
525  bool Read_GERBER_File( const wxString& GERBER_FullFileName );
526 
535  bool LoadExcellonFiles( const wxString& aFileName );
536  bool Read_EXCELLON_File( const wxString& aFullFileName );
537 
546  bool LoadZipArchiveFile( const wxString& aFileName );
547 
548 
556  bool LoadGerberJobFile( const wxString& aFileName );
557 
558 
562  void Liste_D_Codes();
563 
564  // PCB handling
565  bool Clear_DrawLayers( bool query );
566  void Erase_Current_DrawLayer( bool query );
567 
569 
574  void UpdateDisplayOptions( const GBR_DISPLAY_OPTIONS& aOptions );
575 
576  // Conversion function
577  void ExportDataInPcbnewFormat( wxCommandEvent& event );
578 
579  /* SaveCopyInUndoList() virtual
580  * currently: do nothing in GerbView.
581  */
583  UNDO_REDO_T aTypeCommand = UR_UNSPECIFIED,
584  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) { }
585 
595  void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
596  UNDO_REDO_T aTypeCommand,
597  const wxPoint& aTransformPoint = wxPoint( 0, 0 ) )
598  {
599  // currently: do nothing in GerbView.
600  }
601 
603  void ActivateGalCanvas() override;
604 
608  void InstallPreferences( PAGED_DIALOG* aParent, PANEL_HOTKEYS_EDITOR* aHotkeysPanel ) override;
609 
613  void CommonSettingsChanged( bool aEnvVarsChanged ) override;
614 
615  void SyncToolbars() override;
616 
617  DECLARE_EVENT_TABLE()
618 };
619 
620 #endif /* WX_GERBER_STRUCT_H */
Class GBR_DISPLAY_OPTIONS is a helper class to handle display options (filling modes and afew other o...
Class GBR_LAYOUT holds list of GERBER_DRAW_ITEM currently loaded.
Definition: gbr_layout.h:53
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock) override
void OnSelectHighlightChoice(wxCommandEvent &event)
Handles the changing of the highlighted component/net/attribute.
Class CLASS_GBR_LAYOUT to handle info to draw loaded Gerber images and page frame reference.
A list of parameters type.
wxString m_lastFileName
void SetVisibleElementColor(int aLayerID, COLOR4D aColor)
void SortLayersByX2Attributes()
bool Clear_DrawLayers(bool query)
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 OnUpdateSelectDCode(wxUpdateUIEvent &aEvent)
void Files_io(wxCommandEvent &event)
void UpdateStatusBar() override
Update the status bar information.
COLOR4D GetNegativeItemsColor()
Function GetNegativeItemsColor.
Handle colors used to draw all items or layers.
void OnToggleShowLayerManager(wxCommandEvent &aEvent)
const BOX2I GetDocumentExtents() const override
void syncLayerBox(bool aRebuildLayerBox=false)
Function syncLayerBox updates the currently "selected" layer within m_SelLayerBox The currently activ...
int GetDisplayMode()
Function GetDisplayMode.
void SetAuxOrigin(const wxPoint &aPoint) override
COLOR4D GetVisibleElementColor(int aLayerID)
Function GetVisibleElementColor returns the color of a gerber visible element.
LSET GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
const wxPoint & GetAuxOrigin() const override
Return the origin of the axis used for plotting and various exports.
void OnQuit(wxCommandEvent &event)
Function OnQuit called on request of application quit.
FILE_HISTORY m_jobFileHistory
void SetPageSettings(const PAGE_INFO &aPageSettings) override
const TITLE_BLOCK & GetTitleBlock() const override
GERBER_LAYER_WIDGET * m_LayersManager
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl) override
Function OpenProjectFiles is abstract, and opens a project or set of files given by aFileList.
bool Read_GERBER_File(const wxString &GERBER_FullFileName)
Definition: readgerb.cpp:40
Class GERBER_FILE_IMAGE holds the Image data and parameters for one gerber file and layer parameters ...
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
Function SetActiveLayer will change the currently active layer to aLayer and also update the GERBER_L...
void OnGbrFileHistory(wxCommandEvent &event)
Function OnGbrFileHistory deletes the current data and loads a Gerber file selected from history list...
bool loadListOfGerberAndDrillFiles(const wxString &aPath, const wxArrayString &aFilenameList, const std::vector< int > *aFileType=nullptr)
Loads a list of Gerber and NC drill files and updates the view based on them.
GBR_LAYER_BOX_SELECTOR * m_SelLayerBox
void SaveCopyInUndoList(GERBER_DRAW_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand=UR_UNSPECIFIED, const wxPoint &aTransformPoint=wxPoint(0, 0))
const GBR_DISPLAY_OPTIONS & GetDisplayOptions() const
Function GetDisplayOptions returns the display options current in use.
The common library.
void OnUpdateLayerSelectBox(wxUpdateUIEvent &aEvent)
void updateNetnameListSelectBox()
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
void Erase_Current_DrawLayer(bool query)
The base class for create windows for drawing purpose.
GERBER_FILE_IMAGE_LIST is a helper class to handle a list of GERBER_FILE_IMAGE files which are loaded...
int GetActiveLayer()
Function SetActiveLayer returns the active layer.
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot,...
Definition: title_block.h:40
void OnSelectActiveDCode(wxCommandEvent &event)
Function OnSelectActiveDCode Selects the active DCode for the current active layer.
wxChoice * m_SelNetnameBox
void SaveSettings(wxConfigBase *aCfg) override
Saves common frame parameters to a configuration data file.
void ActivateGalCanvas() override
void SetGridVisibility(bool aVisible) override
Function SetGridVisibility(), virtual from EDA_DRAW_FRAME It may be overloaded by derived classes.
GERBVIEW_FRAME(KIWAY *aKiway, wxWindow *aParent)
void OnSelectDisplayMode(wxCommandEvent &event)
Function OnSelectDisplayMode called on a display mode selection Mode selection can be fast display,...
void ReCreateHToolbar() override
bool LoadGerberJobFile(const wxString &aFileName)
Load a Gerber job file, and load gerber files found in job files.
void SetGridOrigin(const wxPoint &aPoint) override
FILE_HISTORY m_zipFileHistory
void updateComponentListSelectBox()
void SetDisplayOptions(const GBR_DISPLAY_OPTIONS &aOptions)
bool hasAvailableLayers() const
COLORS_DESIGN_SETTINGS g_ColorsSettings
void UpdateDisplayOptions(const GBR_DISPLAY_OPTIONS &aOptions)
Updates the display options and refreshes the view as needed.
Class LSET is a set of PCB_LAYER_IDs.
unsigned ImagesMaxCount() const
The max number of file images.
bool unarchiveFiles(const wxString &aFullFileName, REPORTER *aReporter=nullptr)
Extracts gerber and drill files from the zip archive, and load them.
PAGE_INFO m_paper
void ReCreateAuxiliaryToolbar() override
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void ReCreateVToolbar() override
Function ReCreateVToolbar creates or updates the right vertical toolbar.
PARAM_CFG_ARRAY m_configSettings
#define NO_AVAILABLE_LAYERS
bool LoadGerberFiles(const wxString &aFileName)
function LoadGerberFiles Load a photoplot (Gerber) file or many files.
void InstallPreferences(PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
Allows Gerbview to install its preferences panels into the preferences dialog.
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
GERBER_FILE_IMAGE * GetGbrImage(int aIdx) const
bool LoadZipArchiveFile(const wxString &aFileName)
function LoadZipArchiveFileLoadZipArchiveFile Load a zipped archive file.
COLORS_DESIGN_SETTINGS * m_colorsSettings
GBR_DISPLAY_OPTIONS m_DisplayOptions
void applyDisplaySettingsToGAL()
Updates the GAL with display settings changes.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
bool IsElementVisible(int aLayerID) const
Function IsElementVisible tests whether a given element category is visible.
GBR_LAYOUT * m_gerberLayout
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:274
const wxPoint & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
Class GERBER_LAYER_WIDGET is here to implement the abtract functions of LAYER_WIDGET so they may be t...
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
void LoadSettings(wxConfigBase *aCfg) override
Load common frame parameters from a configuration file.
void OnCloseWindow(wxCloseEvent &Event)
FILE_HISTORY m_drillFileHistory
void OnShowGerberSourceFile(wxCommandEvent &event)
Function OnShowGerberSourceFile Call the preferred editor to show (and edit) the gerber source file l...
GERBER_DRAW_ITEM * Locate(const wxPoint &aPosition, int typeloc)
Definition: locate.cpp:43
void Process_Special_Functions(wxCommandEvent &event)
void OnUpdateSelectZoom(wxUpdateUIEvent &aEvent)
GBR_LAYOUT * GetGerberLayout() const
wxTextCtrl * m_TextInfo
DCODE_SELECTION_BOX * m_DCodeSelector
void ExportDataInPcbnewFormat(wxCommandEvent &event)
const PAGE_INFO & GetPageSettings() const override
void OnJobFileHistory(wxCommandEvent &event)
deletes the current data and load a gerber job file selected from the history list.
void updateAperAttributesSelectBox()
wxChoice * m_SelAperAttributesBox
see class PGM_BASE
Board layer functions and definitions.
void SyncToolbars() override
Update the toolbars (mostly settings/check buttons/checkboxes) with the current controller state.
PARAM_CFG_ARRAY & GetConfigurationSettings(void)
Function GetConfigurationSettings Populates the GerbView applications settings list.
void OnUpdateDrawMode(wxUpdateUIEvent &aEvent)
void SaveCopyInUndoList(const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO_T aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0))
Function SaveCopyInUndoList (overloaded).
COLOR4D GetLayerColor(int aLayer) const
Function GetLayerColor gets a layer color for any valid layer.
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Definition: gbr_layout.cpp:44
void DisplayGridMsg()
Function DisplayGridMsg()
void SetLayerColor(int aLayer, COLOR4D aColor)
Function SetLayerColor changes a layer color for any valid layer.
virtual void SetGridColor(COLOR4D aColor) override
wxPoint m_grid_origin
void syncLayerWidget()
Function syncLayerWidget updates the currently "selected" layer within the GERBER_LAYER_WIDGET.
Class COLORS_DESIGN_SETTINGS is a list of color settings for designs in Pcbnew.
wxChoice * m_SelComponentBox
void OnDrlFileHistory(wxCommandEvent &event)
Function OnDrlFileHistory deletes the current data and load a drill file in Excellon format selected ...
bool LoadExcellonFiles(const wxString &aFileName)
function LoadExcellonFiles Load a drill (EXCELLON) file or many files.
void OnZipFileHistory(wxCommandEvent &event)
Function OnZipFileHistory deletes the current data and load a zip archive file selected from the hist...
void SetVisibleLayers(LSET aLayerMask)
Function SetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
bool m_show_layer_manager_tools
void ReCreateMenuBar() override
Recreates the menu bar.
int getNextAvailableLayer(int aLayer=0) const
Function getNextAvailableLayer finds the next empty layer starting at aLayer and returns it to the ca...
virtual const BOX2I ViewBBox() const override
Function ViewBBox() returns the bounding box of the item covering all its layers.
void SetLayout(GBR_LAYOUT *aLayout)
Function SetLayout sets the m_gerberLayout member in such as way as to ensure deleting any previous G...
bool IsLayerVisible(int aLayer) const
Function IsLayerVisible tests whether a given layer is visible.
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.
void Liste_D_Codes()
Set Size Items (Lines, Flashes) from DCodes List.
void SetElementVisibility(int aLayerID, bool aNewState)
Function SetElementVisibility changes the visibility of an element category.
void CommonSettingsChanged(bool aEnvVarsChanged) override
Called after the preferences dialog is run.
void ReFillLayerWidget()
Function ReFillLayerWidget changes out all the layers in m_Layers and may be called upon loading new ...
void OnSelectActiveLayer(wxCommandEvent &event)
Function OnSelectActiveLayer Selects the active layer:
void UpdateTitleAndInfo()
Function UpdateTitleAndInfo displays the short filename (if exists) of the selected layer on the capt...
void SetDisplayMode(int aMode)
Function SetDisplayMode.
int SelectPCBLayer(int aDefaultLayer, int aOpperLayerCount, bool aNullLayer=false)
Install the dialog box for layer selection.
const wxString GetZoomLevelIndicator() const override
Function GetZoomLevelIndicator returns a human readable value which can be displayed as zoom level in...
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
bool Read_EXCELLON_File(const wxString &aFullFileName)
void ReCreateOptToolbar() override
Create or update the left vertical toolbar (option toolbar.