KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 <[email protected]>
6 * Copyright (C) 1992-2021 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#include <file_history.h>
26#include <eda_draw_frame.h>
27#include <layer_ids.h>
28#include <gerbview.h>
29#include <gbr_layout.h>
30#include <page_info.h>
31#include <gbr_display_options.h>
32
33#define NO_AVAILABLE_LAYERS UNDEFINED_LAYER
34
42class REPORTER;
43class SELECTION;
44class wxStaticText;
45
46
51#define GERBVIEW_FRAME_NAME wxT( "GerberFrame" )
52
54{
55public:
56 GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent );
58
59 void doCloseWindow() override;
60
61 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl ) override;
62
72 bool LoadListOfGerberAndDrillFiles( const wxString& aPath, const wxArrayString& aFilenameList,
73 std::vector<int>* aFileType );
74
75 // Virtual basic functions:
76 void ReCreateHToolbar() override;
77 void ReCreateAuxiliaryToolbar() override;
78
82 void ReCreateVToolbar() override;
83
87 void ReCreateOptToolbar() override;
88
89 void UpdateStatusBar() override;
90 void UpdateToolbarControlSizes() override;
91
93
96
103 bool IsElementVisible( int aLayerID ) const;
104
112 void SetElementVisibility( int aLayerID, bool aNewState );
113
117 void SetGridVisibility( bool aVisible ) override;
118
124 LSET GetVisibleLayers() const;
125
131 void SetVisibleLayers( LSET aLayerMask );
132
139 bool IsLayerVisible( int aLayer ) const;
140
144 COLOR4D GetVisibleElementColor( int aLayerID );
145
146 void SetVisibleElementColor( int aLayerID, const COLOR4D& aColor );
147
148 COLOR4D GetLayerColor( int aLayer ) const;
149 void SetLayerColor( int aLayer, const COLOR4D& aColor );
150
154 void ReFillLayerWidget();
155
159 void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true );
160
164 int GetActiveLayer() const { return m_activeLayer; }
165
173 int getNextAvailableLayer() const;
174
182 void syncLayerWidget();
183
190 void syncLayerBox( bool aRebuildLayerBox = false );
191
200 void UpdateTitleAndInfo();
201
205 void DisplayGridMsg() override;
206
207 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
208 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
209
210 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
211
212 void ToggleLayerManager();
213
214 void ShowChangedLanguage() override;
215
217 void OnSelectHighlightChoice( wxCommandEvent& event );
218
223 void OnSelectActiveDCode( wxCommandEvent& event );
224
230 void OnSelectActiveLayer( wxCommandEvent& event );
231
235 void OnQuit( wxCommandEvent& event );
236
237 void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent );
238 void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
239
243 void OnGbrFileHistory( wxCommandEvent& event );
244
249 void OnDrlFileHistory( wxCommandEvent& event );
250
255 void OnZipFileHistory( wxCommandEvent& event );
256
260 void OnJobFileHistory( wxCommandEvent& event );
261
269 bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr );
270
279 bool LoadAutodetectedFiles( const wxString& aFileName );
280
289 bool LoadGerberFiles( const wxString& aFileName );
290 bool Read_GERBER_File( const wxString& GERBER_FullFileName );
291
300 bool LoadExcellonFiles( const wxString& aFileName );
301 bool Read_EXCELLON_File( const wxString& aFullFileName );
302
311 bool LoadZipArchiveFile( const wxString& aFileName );
312
313
322 bool LoadGerberJobFile( const wxString& aFileName );
323
324 // PCB handling
325 bool Clear_DrawLayers( bool query );
326 void Erase_Current_DrawLayer( bool query );
327
330
331 // Adjust draw params: draw offset and draw rotation for a gerber file image
332 void SetLayerDrawPrms();
333
340 void RemapLayers( const std::unordered_map<int, int>& remapping );
341
346 void UpdateXORLayers();
347
348 /*
349 * Do nothing in GerbView.
350 */
352 UNDO_REDO aTypeCommand = UNDO_REDO::UNSPECIFIED ) { }
353
363 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
364 UNDO_REDO aTypeCommand )
365 {
366 // currently: do nothing in GerbView.
367 }
368
370 void ActivateGalCanvas() override;
371
375 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
376
377 SELECTION& GetCurrentSelection() override;
378
384 void SetLayout( GBR_LAYOUT* aLayout )
385 {
386 delete m_gerberLayout;
387 m_gerberLayout = aLayout;
388 }
389
391 {
392 wxASSERT( m_gerberLayout );
393 return m_gerberLayout;
394 }
395
400 {
402 }
403
404 GERBER_FILE_IMAGE* GetGbrImage( int aIdx ) const;
405
406 unsigned ImagesMaxCount() const;
407
408
409 void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
410 const PAGE_INFO& GetPageSettings() const override;
411 const VECTOR2I GetPageSizeIU() const override;
412
413 const VECTOR2I& GetGridOrigin() const override { return m_grid_origin; }
414 void SetGridOrigin( const VECTOR2I& aPoint ) override { m_grid_origin = aPoint; }
415
416 const TITLE_BLOCK& GetTitleBlock() const override;
417 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
418
436 int SelectPCBLayer( int aDefaultLayer, int aCopperLayerCount, const wxString& aGerberName );
437
441 COLOR4D GetGridColor() override;
442
444 virtual void SetGridColor( const COLOR4D& aColor ) override;
445
446 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override
447 {
448 wxASSERT( m_gerberLayout );
449 return m_gerberLayout->ViewBBox();
450 }
451
452 DECLARE_EVENT_TABLE()
453
454protected:
455 void setupUIConditions() override;
456 void doReCreateMenuBar() override;
457
458private:
463 void unitsChangeRefresh() override; // See class EDA_DRAW_FRAME
464
465 void OnClearJobFileHistory( wxCommandEvent& aEvent );
466 void OnClearZipFileHistory( wxCommandEvent& aEvent );
467 void OnClearDrlFileHistory( wxCommandEvent& aEvent );
468 void OnClearGbrFileHistory( wxCommandEvent& aEvent );
469
470 void DoWithAcceptedFiles() override;
471
482 bool LoadFileOrShowDialog( const wxString& aFileName, const wxString& dialogFiletypes,
483 const wxString& dialogTitle, const int filetype );
484
485 // The Tool Framework initialization
486 void setupTools();
487
488public:
489 wxChoice* m_SelComponentBox; // a choice box to display and highlight component
490 // graphic items
491 wxChoice* m_SelNetnameBox; // a choice box to display and highlight netlist
492 // graphic items
493 wxChoice* m_SelAperAttributesBox; // a choice box to display aperture attributes and
494 // highlight items
495 GBR_LAYER_BOX_SELECTOR* m_SelLayerBox; // The combobox to select the current active
496 // graphic layer
497 // (which is drawn on top on the other layers
498 DCODE_SELECTION_BOX* m_DCodeSelector; // a list box to select the dcode Id to highlight.
499 wxTextCtrl* m_TextInfo; // a wxTextCtrl used to display some info about
500 // gerber data (format..)
501
503
504protected:
508
509 wxString m_lastFileName; // The last filename chosen to be proposed to the
510 // user.
511
512private:
514
518 PAGE_INFO m_paper; // used only to show paper limits to screen
519 wxStaticText* m_cmpText; // a message on the auxiliary toolbar,
520 // relative to the m_SelComponentBox
521 wxStaticText* m_netText; // a message on the auxiliary toolbar,
522 // relative to the m_SelNetnameBox
523 wxStaticText* m_apertText; // a message on the auxiliary toolbar,
524 // relative to the m_SelAperAttributesBox
525 wxStaticText* m_dcodeText; // a message on the auxiliary toolbar,
526 // relative to the m_DCodeSelector
527};
528
529#endif /* WX_GERBER_STRUCT_H */
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
Color settings are a bit different than most of the settings objects in that there can be more than o...
Helper to display a DCode list and select a DCode id.
The base class for create windows for drawing purpose.
virtual const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: eda_item.cpp:273
This class implements a file history object to store a list of files, that can then be added to a men...
Definition: file_history.h:43
A list of GERBER_DRAW_ITEM objects currently loaded.
Definition: gbr_layout.h:46
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Definition: gbr_layout.cpp:41
GERBER_FILE_IMAGE_LIST is a helper class to handle a list of GERBER_FILE_IMAGE files which are loaded...
Hold the image data and parameters for one gerber file and layer parameters.
Abstract functions of LAYER_WIDGET so they may be tied into the GERBVIEW_FRAME's data and we can add ...
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Returns a pointer to the active color theme settings.
void SetLayerColor(int aLayer, const COLOR4D &aColor)
void OnUpdateSelectDCode(wxUpdateUIEvent &aEvent)
void OnQuit(wxCommandEvent &event)
Called on request of application quit.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Called after the preferences dialog is run.
wxStaticText * m_dcodeText
wxChoice * m_SelAperAttributesBox
void UpdateXORLayers()
Update each layers' differential option.
void UpdateStatusBar() override
Update the status bar information.
COLOR4D GetVisibleElementColor(int aLayerID)
Return the color of a gerber visible element.
GERBVIEW_SETTINGS * gvconfig() const
const PAGE_INFO & GetPageSettings() const override
bool IsLayerVisible(int aLayer) const
Test whether a given layer is visible.
void DisplayGridMsg() override
Display the current grid pane on the status bar.
void OnDrlFileHistory(wxCommandEvent &event)
Delete the current data and load a drill file in Excellon format selected from history list on curren...
void OnUpdateLayerSelectBox(wxUpdateUIEvent &aEvent)
void SortLayersByX2Attributes()
void SetLayout(GBR_LAYOUT *aLayout)
Set the m_gerberLayout member in such as way as to ensure deleting any previous GBR_LAYOUT.
void ReCreateHToolbar() override
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
GBR_LAYER_BOX_SELECTOR * m_SelLayerBox
void UpdateToolbarControlSizes() override
Update the sizes of any controls in the toolbars of the frame.
bool Read_EXCELLON_File(const wxString &aFullFileName)
bool m_show_layer_manager_tools
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void ShowChangedLanguage() override
GBR_LAYOUT * m_gerberLayout
void SetPageSettings(const PAGE_INFO &aPageSettings) override
void ApplyDisplaySettingsToGAL()
Updates the GAL with display settings changes.
PAGE_INFO m_paper
bool LoadFileOrShowDialog(const wxString &aFileName, const wxString &dialogFiletypes, const wxString &dialogTitle, const int filetype)
Loads the file provided or shows a dialog to get the file(s) from the user.
bool LoadGerberJobFile(const wxString &aFileName)
Load a Gerber job file, and load gerber files found in job files.
wxStaticText * m_cmpText
void OnClearDrlFileHistory(wxCommandEvent &aEvent)
GERBER_FILE_IMAGE_LIST * GetImagesList() const
Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data.
int SelectPCBLayer(int aDefaultLayer, int aCopperLayerCount, const wxString &aGerberName)
Show the dialog box for layer selection.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
wxString m_lastFileName
void syncLayerBox(bool aRebuildLayerBox=false)
Update the currently "selected" layer within m_SelLayerBox.
const VECTOR2I & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
GBR_LAYOUT * GetGerberLayout() const
bool LoadGerberFiles(const wxString &aFileName)
Load a given Gerber file or selected file(s), if the filename is empty.
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock) override
bool unarchiveFiles(const wxString &aFullFileName, REPORTER *aReporter=nullptr)
Extract gerber and drill files from the zip archive, and load them.
void ReCreateAuxiliaryToolbar() override
void doCloseWindow() override
void OnSelectHighlightChoice(wxCommandEvent &event)
Handles the changing of the highlighted component/net/attribute.
wxChoice * m_SelComponentBox
FILE_HISTORY m_jobFileHistory
void OnJobFileHistory(wxCommandEvent &event)
Delete the current data and load a gerber job file selected from the history list.
void SetGridOrigin(const VECTOR2I &aPoint) override
wxChoice * m_SelNetnameBox
void OnZipFileHistory(wxCommandEvent &event)
Delete the current data and load a zip archive file selected from the history list.
int GetActiveLayer() const
Return the active layer.
wxTextCtrl * m_TextInfo
bool IsElementVisible(int aLayerID) const
Test whether a given element category is visible.
DCODE_SELECTION_BOX * m_DCodeSelector
GERBER_LAYER_WIDGET * m_LayersManager
void SetActiveLayer(int aLayer, bool doLayerWidgetUpdate=true)
change the currently active layer to aLayer and update the GERBER_LAYER_WIDGET.
wxStaticText * m_netText
void syncLayerWidget()
Update the currently "selected" layer within the GERBER_LAYER_WIDGET.
void SetVisibleElementColor(int aLayerID, const COLOR4D &aColor)
unsigned ImagesMaxCount() const
The max number of file images.
void updateAperAttributesSelectBox()
void ReCreateOptToolbar() override
Create or update the left vertical toolbar (option toolbar)
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
wxStaticText * m_apertText
bool Read_GERBER_File(const wxString &GERBER_FullFileName)
Definition: readgerb.cpp:42
COLOR4D GetLayerColor(int aLayer) const
bool Clear_DrawLayers(bool query)
void SortLayersByFileExtension()
GERBER_FILE_IMAGE * GetGbrImage(int aIdx) const
void updateComponentListSelectBox()
void SetGridVisibility(bool aVisible) override
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Returns bbox of document with option to not include some items.
bool LoadListOfGerberAndDrillFiles(const wxString &aPath, const wxArrayString &aFilenameList, std::vector< int > *aFileType)
Load a list of Gerber and NC drill files and updates the view based on them.
void SaveCopyInUndoList(GERBER_DRAW_ITEM *aItemToCopy, UNDO_REDO aTypeCommand=UNDO_REDO::UNSPECIFIED)
const TITLE_BLOCK & GetTitleBlock() const override
bool LoadAutodetectedFiles(const wxString &aFileName)
Load a given file or selected file(s), if the filename is empty.
VECTOR2I m_grid_origin
void OnSelectActiveLayer(wxCommandEvent &event)
Select the active layer:
void RemapLayers(const std::unordered_map< int, int > &remapping)
Takes a layer remapping and reorders the layers.
void ReFillLayerWidget()
Change out all the layers in m_Layers; called upon loading new gerber files.
void SaveCopyInUndoList(const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand)
Create a new entry in undo list of commands and add a list of pickers to handle a list of items.
FILE_HISTORY m_zipFileHistory
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl) override
Open a project or set of files given by aFileList.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
int getNextAvailableLayer() const
Find the next empty layer.
void Erase_Current_DrawLayer(bool query)
void updateNetnameListSelectBox()
bool LoadZipArchiveFile(const wxString &aFileName)
Load a zipped archive file.
void UpdateTitleAndInfo()
Display the short filename (if exists) of the selected layer on the caption of the main GerbView wind...
void OnClearGbrFileHistory(wxCommandEvent &aEvent)
void SetElementVisibility(int aLayerID, bool aNewState)
Change the visibility of an element category.
virtual void SetGridColor(const COLOR4D &aColor) override
void OnSelectActiveDCode(wxCommandEvent &event)
Select the active DCode for the current active layer.
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
const VECTOR2I GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void OnClearZipFileHistory(wxCommandEvent &aEvent)
void DoWithAcceptedFiles() override
Execute action on accepted dropped file.
void ReCreateVToolbar() override
Create or update the right vertical toolbar.
void OnGbrFileHistory(wxCommandEvent &event)
Delete the current data and loads a Gerber file selected from history list on current layer.
FILE_HISTORY m_drillFileHistory
bool LoadExcellonFiles(const wxString &aFileName)
Load a drill (EXCELLON) file or many files.
void doReCreateMenuBar() override
void OnClearJobFileHistory(wxCommandEvent &aEvent)
COLOR4D GetGridColor() override
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:576
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:59
A holder to handle information on schematic or board items.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:41
Class CLASS_GBR_LAYOUT to handle info to draw loaded Gerber images and page frame reference.
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...