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 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;
48
49#ifndef __linux__
51#else
52class SPNAV_2D_PLUGIN;
53#endif
54
55
59
60#define GERBVIEW_FRAME_NAME wxT( "GerberFrame" )
61
63{
64public:
65 GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent );
67
68 void doCloseWindow() override;
69
70 bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl ) override;
71
81 bool LoadListOfGerberAndDrillFiles( const wxString& aPath, const wxArrayString& aFilenameList,
82 std::vector<int>* aFileType );
83
84 void UpdateStatusBar() override;
85
87
90
97 bool IsElementVisible( int aLayerID ) const;
98
106 void SetElementVisibility( int aLayerID, bool aNewState );
107
111 void SetGridVisibility( bool aVisible ) override;
112
118 LSET GetVisibleLayers() const;
119
125 void SetVisibleLayers( const LSET& aLayerMask );
126
133 bool IsLayerVisible( int aLayer ) const;
134
138 COLOR4D GetVisibleElementColor( int aLayerID );
139
140 void SetVisibleElementColor( int aLayerID, const COLOR4D& aColor );
141
142 COLOR4D GetLayerColor( int aLayer ) const;
143 void SetLayerColor( int aLayer, const COLOR4D& aColor );
144
148 void ReFillLayerWidget();
149
153 void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true );
154
158 int GetActiveLayer() const { return m_activeLayer; }
159
167 int getNextAvailableLayer() const;
168
176 void syncLayerWidget();
177
184 void syncLayerBox( bool aRebuildLayerBox = false );
185
194 void UpdateTitleAndInfo();
195
199 void DisplayGridMsg() override;
200
201 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
202 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
203
204 COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
205
206 void ToggleLayerManager();
207
208 void ShowChangedLanguage() override;
209
211 void OnSelectHighlightChoice( wxCommandEvent& event );
212
217 void OnSelectActiveDCode( wxCommandEvent& event );
218
224 void OnSelectActiveLayer( wxCommandEvent& event );
225
229 void OnQuit( wxCommandEvent& event );
230
231 void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent );
232
236 void OnGbrFileHistory( wxCommandEvent& event );
237
242 void OnDrlFileHistory( wxCommandEvent& event );
243
248 void OnZipFileHistory( wxCommandEvent& event );
249
253 void OnJobFileHistory( wxCommandEvent& event );
254
262 bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr );
263
272 bool LoadAutodetectedFiles( const wxString& aFileName );
273
282 bool LoadGerberFiles( const wxString& aFileName );
283 bool Read_GERBER_File( const wxString& GERBER_FullFileName );
284
293 bool LoadExcellonFiles( const wxString& aFileName );
294 bool Read_EXCELLON_File( const wxString& aFullFileName );
295
304 bool LoadZipArchiveFile( const wxString& aFileName );
305
309 void ClearFileHistory() override;
310
319 bool LoadGerberJobFile( const wxString& aFileName );
320
321 // PCB handling
322 bool Clear_DrawLayers( bool query );
323 void Erase_Current_DrawLayer( bool query );
324
327
328 // Adjust draw params: draw offset and draw rotation for a gerber file image
329 void SetLayerDrawPrms();
330
337 void RemapLayers( const std::unordered_map<int, int>& remapping );
338
343 void UpdateXORLayers();
344
345 /*
346 * Do nothing in GerbView.
347 */
349 UNDO_REDO aTypeCommand = UNDO_REDO::UNSPECIFIED ) { }
350
360 void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
361 UNDO_REDO aTypeCommand )
362 {
363 // currently: do nothing in GerbView.
364 }
365
367 void ActivateGalCanvas() override;
368
372 void CommonSettingsChanged( int aFlags ) override;
373
374 SELECTION& GetCurrentSelection() override;
375
381 void SetLayout( GBR_LAYOUT* aLayout )
382 {
383 delete m_gerberLayout;
384 m_gerberLayout = aLayout;
385 }
386
388 {
389 wxASSERT( m_gerberLayout );
390 return m_gerberLayout;
391 }
392
397 {
398 return m_gerberLayout->GetImagesList();
399 }
400
401 GERBER_FILE_IMAGE* GetGbrImage( int aIdx ) const;
402
403 unsigned ImagesMaxCount() const;
404
405
406 void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
407 const PAGE_INFO& GetPageSettings() const override;
408 const VECTOR2I GetPageSizeIU() const override;
409
410 const VECTOR2I& GetGridOrigin() const override { return m_grid_origin; }
411 void SetGridOrigin( const VECTOR2I& aPoint ) override { m_grid_origin = aPoint; }
412
413 const TITLE_BLOCK& GetTitleBlock() const override;
414 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
415
433 int SelectPCBLayer( int aDefaultLayer, int aCopperLayerCount, const wxString& aGerberName );
434
438 COLOR4D GetGridColor() override;
439
441 virtual void SetGridColor( const COLOR4D& aColor ) override;
442
443 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override
444 {
445 wxASSERT( m_gerberLayout );
446 return m_gerberLayout->ViewBBox();
447 }
448
449 DECLARE_EVENT_TABLE()
450
451protected:
452 void configureToolbars() override;
453 void setupUIConditions() override;
454 void doReCreateMenuBar() override;
455
456 void handleActivateEvent( wxActivateEvent& aEvent ) override;
457 void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
458
459private:
464 void unitsChangeRefresh() override; // See class EDA_DRAW_FRAME
465
466 void OnClearJobFileHistory( wxCommandEvent& aEvent );
467 void OnClearZipFileHistory( wxCommandEvent& aEvent );
468 void OnClearDrlFileHistory( wxCommandEvent& aEvent );
469 void OnClearGbrFileHistory( wxCommandEvent& aEvent );
470
471 void DoWithAcceptedFiles() override;
472
483 bool LoadFileOrShowDialog( const wxString& aFileName, const wxString& dialogFiletypes,
484 const wxString& dialogTitle, const int filetype );
485
486 // The Tool Framework initialization
487 void setupTools();
488
489public:
490 wxChoice* m_SelComponentBox; // a choice box to display and highlight component
491 // graphic items
492 wxChoice* m_SelNetnameBox; // a choice box to display and highlight netlist
493 // graphic items
494 wxChoice* m_SelAperAttributesBox; // a choice box to display aperture attributes and
495 // highlight items
496 GBR_LAYER_BOX_SELECTOR* m_SelLayerBox; // The combobox to select the current active
497 // graphic layer
498 // (which is drawn on top on the other layers
499 DCODE_SELECTION_BOX* m_DCodeSelector; // a list box to select the dcode Id to highlight.
500 wxTextCtrl* m_TextInfo; // a wxTextCtrl used to display some info about
501 // gerber data (format..)
502
504
505protected:
509
510 wxString m_lastFileName; // The last filename chosen to be proposed to the
511 // user.
512
513private:
515
519 PAGE_INFO m_paper; // used only to show paper limits to screen
520 wxStaticText* m_cmpText; // a message on the auxiliary toolbar,
521 // relative to the m_SelComponentBox
522 wxStaticText* m_netText; // a message on the auxiliary toolbar,
523 // relative to the m_SelNetnameBox
524 wxStaticText* m_apertText; // a message on the auxiliary toolbar,
525 // relative to the m_SelAperAttributesBox
526 wxStaticText* m_dcodeText; // a message on the auxiliary toolbar,
527 // relative to the m_DCodeSelector
528
529#ifndef __linux__
530 std::unique_ptr<NL_GERBVIEW_PLUGIN> m_spaceMouse;
531#else
532 std::unique_ptr<SPNAV_2D_PLUGIN> m_spaceMouse;
533#endif
534};
535
536#endif /* WX_GERBER_STRUCT_H */
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
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.
EDA_DRAW_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName, const EDA_IU_SCALE &aIuScale)
This class implements a file history object to store a list of files, that can then be added to a men...
A list of GERBER_DRAW_ITEM objects currently loaded.
Definition gbr_layout.h:46
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
Redraw the menus and what not in current language.
GBR_LAYOUT * m_gerberLayout
void SetPageSettings(const PAGE_INFO &aPageSettings) override
void ApplyDisplaySettingsToGAL()
Updates the GAL with display settings changes.
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)
void ClearFileHistory() override
Remove all files from the file history.
GERBVIEW_FRAME(KIWAY *aKiway, wxWindow *aParent)
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:41
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:286
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:79
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.
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695