KiCad PCB EDA Suite
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
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 The 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#include <memory>
34
35#define NO_AVAILABLE_LAYERS UNDEFINED_LAYER
36
44class LSET;
45class REPORTER;
46class SELECTION;
47class wxStaticText;
49
50
55#define GERBVIEW_FRAME_NAME wxT( "GerberFrame" )
56
58{
59public:
60 GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent );
62
63 void doCloseWindow() override;
64
65 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl ) override;
66
76 bool LoadListOfGerberAndDrillFiles( const wxString& aPath, const wxArrayString& aFilenameList,
77 std::vector<int>* aFileType );
78
79 void UpdateStatusBar() override;
80
82
85
92 bool IsElementVisible( int aLayerID ) const;
93
101 void SetElementVisibility( int aLayerID, bool aNewState );
102
106 void SetGridVisibility( bool aVisible ) override;
107
113 LSET GetVisibleLayers() const;
114
120 void SetVisibleLayers( const LSET& aLayerMask );
121
128 bool IsLayerVisible( int aLayer ) const;
129
133 COLOR4D GetVisibleElementColor( int aLayerID );
134
135 void SetVisibleElementColor( int aLayerID, const COLOR4D& aColor );
136
137 COLOR4D GetLayerColor( int aLayer ) const;
138 void SetLayerColor( int aLayer, const COLOR4D& aColor );
139
143 void ReFillLayerWidget();
144
148 void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true );
149
153 int GetActiveLayer() const { return m_activeLayer; }
154
162 int getNextAvailableLayer() const;
163
171 void syncLayerWidget();
172
179 void syncLayerBox( bool aRebuildLayerBox = false );
180
189 void UpdateTitleAndInfo();
190
194 void DisplayGridMsg() override;
195
196 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
197 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
198
199 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
200
201 void ToggleLayerManager();
202
203 void ShowChangedLanguage() override;
204
206 void OnSelectHighlightChoice( wxCommandEvent& event );
207
212 void OnSelectActiveDCode( wxCommandEvent& event );
213
219 void OnSelectActiveLayer( wxCommandEvent& event );
220
224 void OnQuit( wxCommandEvent& event );
225
226 void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent );
227
231 void OnGbrFileHistory( wxCommandEvent& event );
232
237 void OnDrlFileHistory( wxCommandEvent& event );
238
243 void OnZipFileHistory( wxCommandEvent& event );
244
248 void OnJobFileHistory( wxCommandEvent& event );
249
257 bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr );
258
267 bool LoadAutodetectedFiles( const wxString& aFileName );
268
277 bool LoadGerberFiles( const wxString& aFileName );
278 bool Read_GERBER_File( const wxString& GERBER_FullFileName );
279
288 bool LoadExcellonFiles( const wxString& aFileName );
289 bool Read_EXCELLON_File( const wxString& aFullFileName );
290
299 bool LoadZipArchiveFile( const wxString& aFileName );
300
301
310 bool LoadGerberJobFile( const wxString& aFileName );
311
312 // PCB handling
313 bool Clear_DrawLayers( bool query );
314 void Erase_Current_DrawLayer( bool query );
315
318
319 // Adjust draw params: draw offset and draw rotation for a gerber file image
320 void SetLayerDrawPrms();
321
328 void RemapLayers( const std::unordered_map<int, int>& remapping );
329
334 void UpdateXORLayers();
335
336 /*
337 * Do nothing in GerbView.
338 */
340 UNDO_REDO aTypeCommand = UNDO_REDO::UNSPECIFIED ) { }
341
351 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
352 UNDO_REDO aTypeCommand )
353 {
354 // currently: do nothing in GerbView.
355 }
356
358 void ActivateGalCanvas() override;
359
363 void CommonSettingsChanged( int aFlags ) override;
364
365 SELECTION& GetCurrentSelection() override;
366
372 void SetLayout( GBR_LAYOUT* aLayout )
373 {
374 delete m_gerberLayout;
375 m_gerberLayout = aLayout;
376 }
377
379 {
380 wxASSERT( m_gerberLayout );
381 return m_gerberLayout;
382 }
383
388 {
390 }
391
392 GERBER_FILE_IMAGE* GetGbrImage( int aIdx ) const;
393
394 unsigned ImagesMaxCount() const;
395
396
397 void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
398 const PAGE_INFO& GetPageSettings() const override;
399 const VECTOR2I GetPageSizeIU() const override;
400
401 const VECTOR2I& GetGridOrigin() const override { return m_grid_origin; }
402 void SetGridOrigin( const VECTOR2I& aPoint ) override { m_grid_origin = aPoint; }
403
404 const TITLE_BLOCK& GetTitleBlock() const override;
405 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
406
424 int SelectPCBLayer( int aDefaultLayer, int aCopperLayerCount, const wxString& aGerberName );
425
429 COLOR4D GetGridColor() override;
430
432 virtual void SetGridColor( const COLOR4D& aColor ) override;
433
434 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override
435 {
436 wxASSERT( m_gerberLayout );
437 return m_gerberLayout->ViewBBox();
438 }
439
440 DECLARE_EVENT_TABLE()
441
442protected:
443 void configureToolbars() override;
444 void setupUIConditions() override;
445 void doReCreateMenuBar() override;
446
447 void handleActivateEvent( wxActivateEvent& aEvent ) override;
448 void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
449
450private:
455 void unitsChangeRefresh() override; // See class EDA_DRAW_FRAME
456
457 void OnClearJobFileHistory( wxCommandEvent& aEvent );
458 void OnClearZipFileHistory( wxCommandEvent& aEvent );
459 void OnClearDrlFileHistory( wxCommandEvent& aEvent );
460 void OnClearGbrFileHistory( wxCommandEvent& aEvent );
461
462 void DoWithAcceptedFiles() override;
463
474 bool LoadFileOrShowDialog( const wxString& aFileName, const wxString& dialogFiletypes,
475 const wxString& dialogTitle, const int filetype );
476
477 // The Tool Framework initialization
478 void setupTools();
479
480public:
481 wxChoice* m_SelComponentBox; // a choice box to display and highlight component
482 // graphic items
483 wxChoice* m_SelNetnameBox; // a choice box to display and highlight netlist
484 // graphic items
485 wxChoice* m_SelAperAttributesBox; // a choice box to display aperture attributes and
486 // highlight items
487 GBR_LAYER_BOX_SELECTOR* m_SelLayerBox; // The combobox to select the current active
488 // graphic layer
489 // (which is drawn on top on the other layers
490 DCODE_SELECTION_BOX* m_DCodeSelector; // a list box to select the dcode Id to highlight.
491 wxTextCtrl* m_TextInfo; // a wxTextCtrl used to display some info about
492 // gerber data (format..)
493
495
496protected:
500
501 wxString m_lastFileName; // The last filename chosen to be proposed to the
502 // user.
503
504private:
506
510 PAGE_INFO m_paper; // used only to show paper limits to screen
511 wxStaticText* m_cmpText; // a message on the auxiliary toolbar,
512 // relative to the m_SelComponentBox
513 wxStaticText* m_netText; // a message on the auxiliary toolbar,
514 // relative to the m_SelNetnameBox
515 wxStaticText* m_apertText; // a message on the auxiliary toolbar,
516 // relative to the m_SelAperAttributesBox
517 wxStaticText* m_dcodeText; // a message on the auxiliary toolbar,
518 // relative to the m_DCodeSelector
519
521};
522
523#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:315
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.
wxStaticText * m_dcodeText
wxChoice * m_SelAperAttributesBox
void UpdateXORLayers()
Update each layers' differential option.
void UpdateStatusBar() override
Update the status bar information.
void configureToolbars() override
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 SortLayersByX2Attributes()
void SetLayout(GBR_LAYOUT *aLayout)
Set the m_gerberLayout member in such as way as to ensure deleting any previous GBR_LAYOUT.
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
GBR_LAYER_BOX_SELECTOR * m_SelLayerBox
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 doCloseWindow() override
wxChoice * m_SelComponentBox
FILE_HISTORY m_jobFileHistory
std::unique_ptr< NL_GERBVIEW_PLUGIN > m_spaceMouse
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 SetVisibleLayers(const LSET &aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings.
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()
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
wxStaticText * m_apertText
void OnSelectHighlightChoice(wxCommandEvent &event)
Handles the changing of the highlighted component/net/attribute.
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 handleActivateEvent(wxActivateEvent &aEvent) override
Handle a window activation event.
void updateComponentListSelectBox()
void SetGridVisibility(bool aVisible) override
const BOX2I GetDocumentExtents(bool aIncludeAllVisible=true) const override
Return bounding box 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 CommonSettingsChanged(int aFlags) override
Called after the preferences dialog is run.
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 handleIconizeEvent(wxIconizeEvent &aEvent) override
Handle a window iconize event.
void OnClearZipFileHistory(wxCommandEvent &aEvent)
void DoWithAcceptedFiles() override
Execute action on accepted dropped file.
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:285
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
The class that implements the public interface to the SpaceMouse plug-in.
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:73
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.
STL namespace.
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...