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
109 void SetDisplayMode( int aMode ) { m_displayMode = aMode; }
110
117 bool IsElementVisible( int aLayerID ) const;
118
126 void SetElementVisibility( int aLayerID, bool aNewState );
127
131 void SetGridVisibility( bool aVisible ) override;
132
138 LSET GetVisibleLayers() const;
139
145 void SetVisibleLayers( LSET aLayerMask );
146
153 bool IsLayerVisible( int aLayer ) const;
154
158 COLOR4D GetVisibleElementColor( int aLayerID );
159
160 void SetVisibleElementColor( int aLayerID, const COLOR4D& aColor );
161
162 COLOR4D GetLayerColor( int aLayer ) const;
163 void SetLayerColor( int aLayer, const COLOR4D& aColor );
164
168 void ReFillLayerWidget();
169
173 void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true );
174
178 int GetActiveLayer() const { return m_activeLayer; }
179
187 int getNextAvailableLayer() const;
188
196 void syncLayerWidget();
197
204 void syncLayerBox( bool aRebuildLayerBox = false );
205
214 void UpdateTitleAndInfo();
215
219 void DisplayGridMsg() override;
220
221 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
222 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
223
224 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
225
226 void ToggleLayerManager();
227
228 void ShowChangedLanguage() override;
229
231 void OnSelectHighlightChoice( wxCommandEvent& event );
232
237 void OnSelectActiveDCode( wxCommandEvent& event );
238
244 void OnSelectActiveLayer( wxCommandEvent& event );
245
251 void OnSelectDisplayMode( wxCommandEvent& event );
252
256 void OnQuit( wxCommandEvent& event );
257
258 void OnUpdateDrawMode( wxUpdateUIEvent& aEvent );
259 void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent );
260 void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
261
265 void OnGbrFileHistory( wxCommandEvent& event );
266
271 void OnDrlFileHistory( wxCommandEvent& event );
272
277 void OnZipFileHistory( wxCommandEvent& event );
278
282 void OnJobFileHistory( wxCommandEvent& event );
283
291 bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr );
292
301 bool LoadAutodetectedFiles( const wxString& aFileName );
302
311 bool LoadGerberFiles( const wxString& aFileName );
312 bool Read_GERBER_File( const wxString& GERBER_FullFileName );
313
322 bool LoadExcellonFiles( const wxString& aFileName );
323 bool Read_EXCELLON_File( const wxString& aFullFileName );
324
333 bool LoadZipArchiveFile( const wxString& aFileName );
334
335
344 bool LoadGerberJobFile( const wxString& aFileName );
345
346 // PCB handling
347 bool Clear_DrawLayers( bool query );
348 void Erase_Current_DrawLayer( bool query );
349
352
353 // Adjust draw params: draw offset and draw rotation for a gerber file image
354 void SetLayerDrawPrms();
355
362 void RemapLayers( const std::unordered_map<int, int>& remapping );
363
368 void UpdateXORLayers();
369
370 /*
371 * Do nothing in GerbView.
372 */
374 UNDO_REDO aTypeCommand = UNDO_REDO::UNSPECIFIED ) { }
375
385 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
386 UNDO_REDO aTypeCommand )
387 {
388 // currently: do nothing in GerbView.
389 }
390
392 void ActivateGalCanvas() override;
393
397 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
398
399 SELECTION& GetCurrentSelection() override;
400
406 void SetLayout( GBR_LAYOUT* aLayout )
407 {
408 delete m_gerberLayout;
409 m_gerberLayout = aLayout;
410 }
411
413 {
414 wxASSERT( m_gerberLayout );
415 return m_gerberLayout;
416 }
417
422 {
424 }
425
426 GERBER_FILE_IMAGE* GetGbrImage( int aIdx ) const;
427
428 unsigned ImagesMaxCount() const;
429
430
431 void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
432 const PAGE_INFO& GetPageSettings() const override;
433 const VECTOR2I GetPageSizeIU() const override;
434
435 const VECTOR2I& GetGridOrigin() const override { return m_grid_origin; }
436 void SetGridOrigin( const VECTOR2I& aPoint ) override { m_grid_origin = aPoint; }
437
438 const TITLE_BLOCK& GetTitleBlock() const override;
439 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
440
458 int SelectPCBLayer( int aDefaultLayer, int aCopperLayerCount, const wxString& aGerberName );
459
463 COLOR4D GetGridColor() override;
464
466 virtual void SetGridColor( const COLOR4D& aColor ) override;
467
468 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override
469 {
470 wxASSERT( m_gerberLayout );
471 return m_gerberLayout->ViewBBox();
472 }
473
474 DECLARE_EVENT_TABLE()
475
476protected:
477 void setupUIConditions() override;
478 void doReCreateMenuBar() override;
479
480private:
485 void unitsChangeRefresh() override; // See class EDA_DRAW_FRAME
486
487 void OnClearJobFileHistory( wxCommandEvent& aEvent );
488 void OnClearZipFileHistory( wxCommandEvent& aEvent );
489 void OnClearDrlFileHistory( wxCommandEvent& aEvent );
490 void OnClearGbrFileHistory( wxCommandEvent& aEvent );
491
492 void DoWithAcceptedFiles() override;
493
504 bool LoadFileOrShowDialog( const wxString& aFileName, const wxString& dialogFiletypes,
505 const wxString& dialogTitle, const int filetype );
506
507 // The Tool Framework initialization
508 void setupTools();
509
510public:
511 wxChoice* m_SelComponentBox; // a choice box to display and highlight component
512 // graphic items
513 wxChoice* m_SelNetnameBox; // a choice box to display and highlight netlist
514 // graphic items
515 wxChoice* m_SelAperAttributesBox; // a choice box to display aperture attributes and
516 // highlight items
517 GBR_LAYER_BOX_SELECTOR* m_SelLayerBox; // The combobox to select the current active
518 // graphic layer
519 // (which is drawn on top on the other layers
520 DCODE_SELECTION_BOX* m_DCodeSelector; // a list box to select the dcode Id to highlight.
521 wxTextCtrl* m_TextInfo; // a wxTextCtrl used to display some info about
522 // gerber data (format..)
523
525
526protected:
530
531 wxString m_lastFileName; // The last filename chosen to be proposed to the
532 // user.
533
534private:
535 int m_displayMode; // Gerber images ("layers" in Gerbview) can be drawn:
536 // - in fast mode (write mode) but if there are negative
537 // items only the last image is correctly drawn (no
538 // problem to see only one image or when no negative items)
539 // - in "exact" mode (but slower) in write mode:
540 // last image covers previous images
541 // - in "exact" mode (also slower) in OR mode
542 // (transparency mode)
543 // m_displayMode = 0, 1 or 2
544
546
550 PAGE_INFO m_paper; // used only to show paper limits to screen
551 wxStaticText* m_cmpText; // a message on the auxiliary toolbar,
552 // relative to the m_SelComponentBox
553 wxStaticText* m_netText; // a message on the auxiliary toolbar,
554 // relative to the m_SelNetnameBox
555 wxStaticText* m_apertText; // a message on the auxiliary toolbar,
556 // relative to the m_SelAperAttributesBox
557 wxStaticText* m_dcodeText; // a message on the auxiliary toolbar,
558 // relative to the m_DCodeSelector
559};
560
561#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.
void OnUpdateDrawMode(wxUpdateUIEvent &aEvent)
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)
void SetDisplayMode(int aMode)
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 OnSelectDisplayMode(wxCommandEvent &event)
Called on a display mode selection.
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:573
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...