kicad/gerbview/gerbview_frame.h

545 lines
20 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef WX_GERBER_STRUCT_H
#define WX_GERBER_STRUCT_H
#include <filehistory.h>
#include <pgm_base.h>
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
#include <config_params.h>
#include <eda_draw_frame.h>
#include <layers_id_colors_and_visibility.h>
2012-09-12 17:28:55 +00:00
#include <gerbview.h>
#include <convert_to_biu.h>
#include <gbr_layout.h>
2018-01-29 10:37:29 +00:00
#include <page_info.h>
#include <gbr_display_options.h>
#include <undo_redo_container.h>
#define NO_AVAILABLE_LAYERS UNDEFINED_LAYER
class DCODE_SELECTION_BOX;
class GERBER_LAYER_WIDGET;
class GBR_LAYER_BOX_SELECTOR;
class GERBER_DRAW_ITEM;
class GERBER_FILE_IMAGE;
class GERBER_FILE_IMAGE_LIST;
class REPORTER;
class SELECTION;
/**
* The main window used in GerbView.
*/
#define GERBVIEW_FRAME_NAME wxT( "GerberFrame" )
class GERBVIEW_FRAME : public EDA_DRAW_FRAME
{
2020-10-08 23:51:05 +00:00
public:
GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent );
~GERBVIEW_FRAME();
void doCloseWindow() override;
bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl ) override;
/**
* Load a list of Gerber and NC drill files and updates the view based on them.
2020-10-08 23:51:05 +00:00
*
* @param aPath is the base path for the filenames if they are relative
* @param aFilenameList is a list of filenames to load
* @param aFileType is a list of type of files to load (0 = Gerber, 1 = NC drill)
* if nullptr, files are expected Gerber type.
* @return true if every file loaded successfully
*/
2020-10-08 23:51:05 +00:00
bool LoadListOfGerberAndDrillFiles( const wxString& aPath,
const wxArrayString& aFilenameList,
const std::vector<int>* aFileType = nullptr );
// Virtual basic functions:
void ReCreateHToolbar() override;
void ReCreateAuxiliaryToolbar() override;
/**
* Create or update the right vertical toolbar.
*/
void ReCreateVToolbar() override;
/**
* Create or update the left vertical toolbar (option toolbar)
*/
void ReCreateOptToolbar() override;
void ReCreateMenuBar() override;
void UpdateStatusBar() override;
/**
* @return 0 for fast mode (not fully compatible with negative objects)
* 1 for exact mode, write mode
* 2 for exact mode, OR mode (transparency mode)
*/
int GetDisplayMode() { return m_displayMode; }
/**
* @param aMode = 0 for fast mode
* 1 for exact mode, write mode
* 2 for exact mode, OR mode (transparency mode)
*/
void SetDisplayMode( int aMode ) { m_displayMode = aMode; }
2010-11-12 15:17:10 +00:00
/**
* Test whether a given element category is visible. Keep this as an inline function.
*
* @param aLayerID is an item id from the enum GERBVIEW_LAYER_ID
* @return bool - true if the element is visible.
*/
bool IsElementVisible( int aLayerID ) const;
2010-11-12 15:17:10 +00:00
/**
* Change the visibility of an element category.
*
* @param aItemIdVisible is an item id from the enum GERBVIEW_LAYER_ID
* @param aNewState = The new visibility state of the element category
* (see enum PCB)
*/
void SetElementVisibility( int aLayerID, bool aNewState );
/**
* @param aVisible true if the grid must be shown.
*/
void SetGridVisibility( bool aVisible ) override;
2010-11-12 15:17:10 +00:00
/**
* A proxy function that calls the correspondent function in m_BoardSettings.
*
* @return #LSET of the visible layers
*/
LSET GetVisibleLayers() const;
2010-11-12 15:17:10 +00:00
/**
* A proxy function that calls the correspondent function in m_BoardSettings.
*
* @param aLayerMask The new set of visible layers
*/
void SetVisibleLayers( LSET aLayerMask );
/**
* Test whether a given layer is visible.
*
* @param aLayer The layer to be tested (still 0-31!)
* @return true if the layer is visible.
*/
bool IsLayerVisible( int aLayer ) const;
/**
* Return the color of a gerber visible element.
*/
COLOR4D GetVisibleElementColor( int aLayerID );
void SetVisibleElementColor( int aLayerID, COLOR4D aColor );
COLOR4D GetLayerColor( int aLayer ) const;
void SetLayerColor( int aLayer, COLOR4D aColor );
/**
* This is usually the background color, but can be another color in order to see
* negative objects.
*
* @return the color of negative items.
*/
COLOR4D GetNegativeItemsColor();
/**
* Change out all the layers in m_Layers; called upon loading new gerber files.
*/
void ReFillLayerWidget();
/**
* change the currently active layer to \a aLayer and update the #GERBER_LAYER_WIDGET.
*/
void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true );
/**
* Return the active layer.
*/
int GetActiveLayer() const { return m_activeLayer; }
/**
* Find the next empty layer starting at \a aLayer and returns it to the caller.
*
* If no empty layers are found, #NO_AVAILABLE_LAYERS is return.
*
* @param aLayer The first layer to search.
* @return The first empty layer found or #NO_AVAILABLE_LAYERS.
*/
int getNextAvailableLayer( int aLayer = 0 ) const;
/**
* Update the currently "selected" layer within the #GERBER_LAYER_WIDGET.
* The currently active layer is defined by the return value of GetActiveLayer().
* <p>
* This function cannot be inline without including layer_widget.h in here and we do not
* want to do that.
*/
void syncLayerWidget();
/**
* Update the currently "selected" layer within m_SelLayerBox.
* The currently active layer, as defined by the return value of GetActiveLayer().
*
* @param aRebuildLayerBox true to rebuild the layer box of false to just update the selection.
*/
void syncLayerBox( bool aRebuildLayerBox = false );
2010-11-12 15:17:10 +00:00
/**
* Display the short filename (if exists) of the selected layer on the caption of the main
* GerbView window and some other parameters.
*
* - Name of the layer (found in the gerber file: LN &ltname&gt command) in the status bar
* - Name of the Image (found in the gerber file: IN &ltname&gt command) in the status bar
* and other data in toolbar
*/
void UpdateTitleAndInfo();
2019-05-24 13:55:33 +00:00
/**
* Display the current grid pane on the status bar.
*/
void DisplayGridMsg() override;
2019-05-24 13:55:33 +00:00
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
2020-10-08 23:51:05 +00:00
void ToggleLayerManager();
void ShowChangedLanguage() override;
2017-09-20 08:30:48 +00:00
/// Handles the changing of the highlighted component/net/attribute
void OnSelectHighlightChoice( wxCommandEvent& event );
2011-03-16 10:47:15 +00:00
/**
* Select the active DCode for the current active layer.
* Items using this DCode are highlighted.
2011-03-16 10:47:15 +00:00
*/
void OnSelectActiveDCode( wxCommandEvent& event );
2011-03-16 10:47:15 +00:00
/**
* Select the active layer:
* - if a file is loaded, it is loaded in this layer
* - this layer is displayed on top of other layers
*/
void OnSelectActiveLayer( wxCommandEvent& event );
/**
* Called on a display mode selection.
*
* Mode selection can be fast display or exact mode with stacked images or with transparency.
*/
void OnSelectDisplayMode( wxCommandEvent& event );
/**
* Called on request of application quit.
*/
void OnQuit( wxCommandEvent& event );
void OnUpdateDrawMode( wxUpdateUIEvent& aEvent );
void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent );
void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
/**
* Delete the current data and loads a Gerber file selected from history list on current layer.
*/
void OnGbrFileHistory( wxCommandEvent& event );
/**
* Delete the current data and load a drill file in Excellon format selected from
* history list on current layer.
*/
void OnDrlFileHistory( wxCommandEvent& event );
/**
* Delete the current data and load a zip archive file selected from the
* history list. The archive is expected containing a set of gerber and drill file
*/
void OnZipFileHistory( wxCommandEvent& event );
/**
* Delete the current data and load a gerber job file selected from the history list.
*/
void OnJobFileHistory( wxCommandEvent& event );
/**
* Extract gerber and drill files from the zip archive, and load them.
*
* @param aFullFileName is the full filename of the zip archive
* @param aReporter a REPORTER to collect warning and error messages
* @return true if OK, false if a file cannot be readable
*/
bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr );
/**
* Load a photoplot (Gerber) file or many files.
*
* @param aFileName - void string or file name with full path to open or empty string to
* open a new file. In this case one one file is loaded
* if void string: user will be prompted for filename(s)
* @return true if file was opened successfully.
*/
bool LoadGerberFiles( const wxString& aFileName );
bool Read_GERBER_File( const wxString& GERBER_FullFileName );
/**
* Load a drill (EXCELLON) file or many files.
*
* @param aFileName - void string or file name with full path to open or empty string to
* open a new file. In this case one one file is loaded
* if empty string: user will be prompted for filename(s)
* @return true if file was opened successfully.
*/
bool LoadExcellonFiles( const wxString& aFileName );
bool Read_EXCELLON_File( const wxString& aFullFileName );
/**
* Load a zipped archive file.
*
* @param aFileName - void string or file name with full path to open or empty string to
* open a new file.
* if empty string: user will be prompted for filename(s)
* @return true if file was opened successfully.
*/
bool LoadZipArchiveFile( const wxString& aFileName );
/**
* Load a Gerber job file, and load gerber files found in job files.
*
* @param aFileName - void string or file name with full path to open or empty string to
* open a new file.
* if empty string: user will be prompted for filename(s)
* @return true if file(s) was opened successfully.
*/
bool LoadGerberJobFile( const wxString& aFileName );
// PCB handling
bool Clear_DrawLayers( bool query );
void Erase_Current_DrawLayer( bool query );
void SortLayersByX2Attributes();
/**
* Update the display options and refreshes the view as needed.
*
* @param aOptions is the new options to apply
*/
void UpdateDisplayOptions( const GBR_DISPLAY_OPTIONS& aOptions );
/*
* Do nothing in GerbView.
*/
void SaveCopyInUndoList( GERBER_DRAW_ITEM* aItemToCopy,
2020-08-26 18:04:32 +00:00
UNDO_REDO aTypeCommand = UNDO_REDO::UNSPECIFIED,
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) { }
2010-11-12 15:17:10 +00:00
/**
* Create a new entry in undo list of commands and add a list of pickers to handle a list
* of items.
*
* @param aItemsList = the list of items modified by the command to undo
2020-08-26 18:04:32 +00:00
* @param aTypeCommand = command type (see enum UNDO_REDO)
* @param aTransformPoint = the reference point of the transformation,
* for commands like move
*/
void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
2020-08-26 18:04:32 +00:00
UNDO_REDO aTypeCommand,
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) )
{
// currently: do nothing in GerbView.
}
///< @copydoc EDA_DRAW_FRAME::ActivateGalCanvas
void ActivateGalCanvas() override;
/**
* Allow Gerbview to install its preferences panels into the preferences dialog.
*/
2019-06-09 21:57:23 +00:00
void InstallPreferences( PAGED_DIALOG* aParent, PANEL_HOTKEYS_EDITOR* aHotkeysPanel ) override;
/**
* Called after the preferences dialog is run.
*/
void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
SELECTION& GetCurrentSelection() override;
const GBR_DISPLAY_OPTIONS& GetDisplayOptions() const { return m_DisplayOptions; }
void SetDisplayOptions( const GBR_DISPLAY_OPTIONS& aOptions ) { m_DisplayOptions = aOptions; }
/**
* Set the m_gerberLayout member in such as way as to ensure deleting any previous
* GBR_LAYOUT.
* @param aLayout The GBR_LAYOUT to put into the frame.
*/
void SetLayout( GBR_LAYOUT* aLayout )
{
delete m_gerberLayout;
m_gerberLayout = aLayout;
}
GBR_LAYOUT* GetGerberLayout() const
{
wxASSERT( m_gerberLayout );
return m_gerberLayout;
}
/**
* Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data
*/
GERBER_FILE_IMAGE_LIST* GetImagesList() const
{
return m_gerberLayout->GetImagesList();
}
GERBER_FILE_IMAGE* GetGbrImage( int aIdx ) const;
unsigned ImagesMaxCount() const; ///< The max number of file images
void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
const PAGE_INFO& GetPageSettings() const override;
const wxSize GetPageSizeIU() const override;
const wxPoint& GetGridOrigin() const override { return m_grid_origin; }
void SetGridOrigin( const wxPoint& aPoint ) override { m_grid_origin = aPoint; }
const TITLE_BLOCK& GetTitleBlock() const override;
void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
/**
* Show the dialog box for layer selection.
*
* Providing the option to also display a "(Deselect)" radiobutton makes the
* GerbView's "Export to Pcbnew" command) more "user friendly",
* by permitting any layer to be "deselected" immediately after its
* corresponding radiobutton has been clicked on. (It would otherwise be
* necessary to first cancel the "Select Layer:" dialog box (invoked after a
* different radiobutton is clicked on) prior to then clicking on the "Deselect"
* button provided within the "Layer selection:" dialog box).
*
* @param aDefaultLayer = Preselection (NB_PCB_LAYERS for "(Deselect)" layer)
* @param aCopperLayerCount = number of copper layers
* @param aGerberName = Name of Gerber file to select KiCad layer for
* @return new layer value (NB_PCB_LAYERS when "(Deselect)" radiobutton selected),
* or -1 if canceled
*/
int SelectPCBLayer( int aDefaultLayer, int aCopperLayerCount, wxString aGerberName );
/**
* @return the color of the grid
*/
COLOR4D GetGridColor() override;
///< @copydoc EDA_DRAW_FRAME::SetGridColor()
virtual void SetGridColor( COLOR4D aColor ) override;
const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override
{
wxASSERT( m_gerberLayout );
return m_gerberLayout->ViewBBox();
}
DECLARE_EVENT_TABLE()
protected:
void setupUIConditions() override;
private:
void updateComponentListSelectBox();
void updateNetnameListSelectBox();
void updateAperAttributesSelectBox();
void updateDCodeSelectBox();
void unitsChangeRefresh() override; // See class EDA_DRAW_FRAME
void OnClearJobFileHistory( wxCommandEvent& aEvent );
void OnClearZipFileHistory( wxCommandEvent& aEvent );
void OnClearDrlFileHistory( wxCommandEvent& aEvent );
void OnClearGbrFileHistory( wxCommandEvent& aEvent );
// The Tool Framework initialization
void setupTools();
/// Updates the GAL with display settings changes
void applyDisplaySettingsToGAL();
public:
wxChoice* m_SelComponentBox; // a choice box to display and highlight component
// graphic items
wxChoice* m_SelNetnameBox; // a choice box to display and highlight netlist
// graphic items
wxChoice* m_SelAperAttributesBox; // a choice box to display aperture attributes and
// highlight items
GBR_LAYER_BOX_SELECTOR* m_SelLayerBox; // The combobox to select the current active
// graphic layer
// (which is drawn on top on the other layers
DCODE_SELECTION_BOX* m_DCodeSelector; // a list box to select the dcode Id to highlight.
wxTextCtrl* m_TextInfo; // a wxTextCtrl used to display some info about
// gerber data (format..)
protected:
GERBER_LAYER_WIDGET* m_LayersManager;
FILE_HISTORY m_zipFileHistory;
FILE_HISTORY m_drillFileHistory;
FILE_HISTORY m_jobFileHistory;
wxString m_lastFileName; // The last filename chosen to be proposed to the
// user.
private:
int m_displayMode; // Gerber images ("layers" in Gerbview) can be drawn:
// - in fast mode (write mode) but if there are negative
// items only the last image is correctly drawn (no
// problem to see only one image or when no negative items)
// - in "exact" mode (but slower) in write mode:
// last image covers previous images
// - in "exact" mode (also slower) in OR mode
// (transparency mode)
// m_displayMode = 0, 1 or 2
bool m_show_layer_manager_tools;
GBR_LAYOUT* m_gerberLayout;
int m_activeLayer;
wxPoint m_grid_origin;
PAGE_INFO m_paper; // used only to show paper limits to screen
GBR_DISPLAY_OPTIONS m_DisplayOptions;
wxStaticText* m_cmpText; // a message on the auxiliary toolbar,
// relative to the m_SelComponentBox
wxStaticText* m_netText; // a message on the auxiliary toolbar,
// relative to the m_SelNetnameBox
wxStaticText* m_apertText; // a message on the auxiliary toolbar,
// relative to the m_SelAperAttributesBox
wxStaticText* m_dcodeText; // a message on the auxiliary toolbar,
// relative to the m_DCodeSelector
};
#endif /* WX_GERBER_STRUCT_H */