2011-10-17 20:01:27 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2016-06-05 12:26:39 +00:00
|
|
|
* Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
2018-03-13 21:59:46 +00:00
|
|
|
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@gmail.com>
|
2018-01-08 04:05:03 +00:00
|
|
|
* Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors.
|
2011-10-17 20:01:27 +00:00
|
|
|
*
|
2018-01-08 04:05:03 +00:00
|
|
|
* 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.
|
2011-10-17 20:01:27 +00:00
|
|
|
*
|
2018-01-08 04:05:03 +00:00
|
|
|
* 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.
|
2011-10-17 20:01:27 +00:00
|
|
|
*
|
2018-01-08 04:05:03 +00:00
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
2011-10-17 20:01:27 +00:00
|
|
|
*/
|
|
|
|
|
2011-09-23 13:57:12 +00:00
|
|
|
/**
|
|
|
|
* @file gerbview_frame.h
|
|
|
|
*/
|
2009-07-29 13:10:36 +00:00
|
|
|
|
|
|
|
#ifndef WX_GERBER_STRUCT_H
|
|
|
|
#define WX_GERBER_STRUCT_H
|
|
|
|
|
2009-09-22 12:27:57 +00:00
|
|
|
|
2018-08-20 13:46:38 +00:00
|
|
|
#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 <draw_frame.h>
|
2017-03-13 03:19:33 +00:00
|
|
|
#include <layers_id_colors_and_visibility.h>
|
2012-09-12 17:28:55 +00:00
|
|
|
#include <gerbview.h>
|
2017-09-17 22:43:20 +00:00
|
|
|
#include <convert_to_biu.h>
|
2018-01-29 12:26:58 +00:00
|
|
|
#include <gbr_layout.h>
|
|
|
|
#include <gbr_screen.h>
|
2018-01-29 10:37:29 +00:00
|
|
|
#include <page_info.h>
|
2018-01-29 12:26:58 +00:00
|
|
|
#include <gbr_display_options.h>
|
2018-01-31 08:23:20 +00:00
|
|
|
#include <colors_design_settings.h>
|
2017-08-04 12:43:02 +00:00
|
|
|
|
|
|
|
extern COLORS_DESIGN_SETTINGS g_ColorsSettings;
|
2011-03-02 15:24:39 +00:00
|
|
|
|
2013-03-31 13:27:46 +00:00
|
|
|
#define NO_AVAILABLE_LAYERS UNDEFINED_LAYER
|
2011-03-02 15:24:39 +00:00
|
|
|
|
2010-12-17 20:34:29 +00:00
|
|
|
class DCODE_SELECTION_BOX;
|
2011-09-23 13:57:12 +00:00
|
|
|
class GERBER_LAYER_WIDGET;
|
2012-05-04 17:44:42 +00:00
|
|
|
class GBR_LAYER_BOX_SELECTOR;
|
2011-09-23 13:57:12 +00:00
|
|
|
class GERBER_DRAW_ITEM;
|
2016-06-17 18:00:29 +00:00
|
|
|
class GERBER_FILE_IMAGE;
|
|
|
|
class GERBER_FILE_IMAGE_LIST;
|
2017-01-26 09:45:28 +00:00
|
|
|
class REPORTER;
|
2011-09-23 13:57:12 +00:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class GERBVIEW_FRAME
|
2011-09-30 18:15:37 +00:00
|
|
|
* is the main window used in GerbView.
|
2011-09-23 13:57:12 +00:00
|
|
|
*/
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2015-03-02 17:29:18 +00:00
|
|
|
#define GERBVIEW_FRAME_NAME wxT( "GerberFrame" )
|
|
|
|
|
2012-05-04 17:44:42 +00:00
|
|
|
class GERBVIEW_FRAME : public EDA_DRAW_FRAME // PCB_BASE_FRAME
|
2009-07-29 13:10:36 +00:00
|
|
|
{
|
2013-08-03 05:15:23 +00:00
|
|
|
GBR_LAYOUT* m_gerberLayout;
|
|
|
|
wxPoint m_grid_origin;
|
2014-12-23 13:01:59 +00:00
|
|
|
PAGE_INFO m_paper; // used only to show paper limits to screen
|
2013-08-03 05:15:23 +00:00
|
|
|
|
2012-05-04 17:44:42 +00:00
|
|
|
public:
|
|
|
|
GBR_DISPLAY_OPTIONS m_DisplayOptions;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function SetLayout
|
2013-06-27 19:12:01 +00:00
|
|
|
* sets the m_gerberLayout member in such as way as to ensure deleting any previous
|
2012-05-04 17:44:42 +00:00
|
|
|
* GBR_LAYOUT.
|
|
|
|
* @param aLayout The GBR_LAYOUT to put into the frame.
|
|
|
|
*/
|
|
|
|
void SetLayout( GBR_LAYOUT* aLayout )
|
|
|
|
{
|
2013-06-27 19:12:01 +00:00
|
|
|
delete m_gerberLayout;
|
|
|
|
m_gerberLayout = aLayout;
|
2012-05-04 17:44:42 +00:00
|
|
|
}
|
|
|
|
|
2013-06-27 19:12:01 +00:00
|
|
|
GBR_LAYOUT* GetGerberLayout() const
|
2012-05-04 17:44:42 +00:00
|
|
|
{
|
2013-06-27 19:12:01 +00:00
|
|
|
wxASSERT( m_gerberLayout );
|
|
|
|
return m_gerberLayout;
|
2012-05-04 17:44:42 +00:00
|
|
|
}
|
|
|
|
|
2016-06-17 18:00:29 +00:00
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
|
2012-05-04 17:44:42 +00:00
|
|
|
|
|
|
|
/**
|
2013-06-27 19:12:01 +00:00
|
|
|
* Function GetGerberLayoutBoundingBox
|
2012-05-04 17:44:42 +00:00
|
|
|
* calculates the bounding box containing all gerber items.
|
|
|
|
* @return EDA_RECT - the items bounding box
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
EDA_RECT GetGerberLayoutBoundingBox();
|
2012-05-04 17:44:42 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
|
|
|
|
const PAGE_INFO& GetPageSettings() const override;
|
|
|
|
const wxSize GetPageSizeIU() const override;
|
2012-05-04 17:44:42 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
const wxPoint& GetAuxOrigin() const override;
|
|
|
|
void SetAuxOrigin( const wxPoint& aPoint ) override;
|
2013-08-03 05:15:23 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
const wxPoint& GetGridOrigin() const override { return m_grid_origin; }
|
|
|
|
void SetGridOrigin( const wxPoint& aPoint ) override
|
2013-08-03 05:15:23 +00:00
|
|
|
{
|
|
|
|
m_grid_origin = aPoint;
|
|
|
|
}
|
2012-05-04 17:44:42 +00:00
|
|
|
|
2016-09-25 17:06:49 +00:00
|
|
|
const TITLE_BLOCK& GetTitleBlock() const override;
|
2018-03-13 21:59:46 +00:00
|
|
|
void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
|
2012-05-04 17:44:42 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function SetCurItem
|
|
|
|
* sets the currently selected item and displays it in the MsgPanel.
|
|
|
|
* If the given item is NULL then the MsgPanel is erased and there is no
|
|
|
|
* currently selected item. This function is intended to make the process
|
|
|
|
* of "selecting" an item more formal, and to indivisibly tie the operation
|
|
|
|
* of selecting an item to displaying it using GERBER_DRAW_ITEM::Display_Infos().
|
|
|
|
* @param aItem The GERBER_DRAW_ITEM to make the selected item or NULL if none.
|
|
|
|
* @param aDisplayInfo = true to display item info, false if not (default = true)
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void SetCurItem( GERBER_DRAW_ITEM* aItem, bool aDisplayInfo = true );
|
2012-05-04 17:44:42 +00:00
|
|
|
|
|
|
|
/** Install the dialog box for layer selection
|
2013-03-31 13:27:46 +00:00
|
|
|
* @param aDefaultLayer = Preselection (NB_PCB_LAYERS for "(Deselect)" layer)
|
2012-05-04 17:44:42 +00:00
|
|
|
* @param aCopperLayerCount = number of copper layers
|
|
|
|
* @param aShowDeselectOption = display a "(Deselect)" radiobutton (when set to true)
|
2013-03-31 13:27:46 +00:00
|
|
|
* @return new layer value (NB_PCB_LAYERS when "(Deselect)" radiobutton selected),
|
2012-05-04 17:44:42 +00:00
|
|
|
* or -1 if canceled
|
|
|
|
*
|
|
|
|
* 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).
|
|
|
|
*/
|
2014-06-27 17:07:42 +00:00
|
|
|
int SelectPCBLayer( int aDefaultLayer, int aOpperLayerCount, bool aNullLayer = false );
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2017-09-17 22:43:20 +00:00
|
|
|
///> @copydoc EDA_DRAW_FRAME::SetGridColor()
|
|
|
|
virtual void SetGridColor( COLOR4D aColor ) override;
|
|
|
|
|
2010-02-03 14:05:17 +00:00
|
|
|
protected:
|
2012-05-04 17:44:42 +00:00
|
|
|
GERBER_LAYER_WIDGET* m_LayersManager;
|
2011-09-23 13:57:12 +00:00
|
|
|
|
2017-01-26 09:45:28 +00:00
|
|
|
// Auxiliary file history used to store zip files history.
|
2018-08-20 13:46:38 +00:00
|
|
|
FILE_HISTORY m_zipFileHistory;
|
2017-01-26 09:45:28 +00:00
|
|
|
|
2011-09-23 13:57:12 +00:00
|
|
|
// Auxiliary file history used to store drill files history.
|
2018-08-20 13:46:38 +00:00
|
|
|
FILE_HISTORY m_drillFileHistory;
|
2017-01-26 09:45:28 +00:00
|
|
|
|
2017-08-19 16:28:11 +00:00
|
|
|
// Auxiliary file history used to store job files history.
|
2018-08-20 13:46:38 +00:00
|
|
|
FILE_HISTORY m_jobFileHistory;
|
2017-08-19 16:28:11 +00:00
|
|
|
|
2012-08-29 16:59:50 +00:00
|
|
|
/// The last filename chosen to be proposed to the user
|
|
|
|
wxString m_lastFileName;
|
2016-08-16 10:56:20 +00:00
|
|
|
|
2009-07-29 13:10:36 +00:00
|
|
|
public:
|
2016-08-16 10:56:20 +00:00
|
|
|
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
|
2012-05-04 17:44:42 +00:00
|
|
|
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..)
|
2016-08-16 10:56:20 +00:00
|
|
|
|
2017-09-17 22:43:20 +00:00
|
|
|
COLORS_DESIGN_SETTINGS* m_colorsSettings;
|
|
|
|
|
2010-02-03 14:05:17 +00:00
|
|
|
private:
|
2011-09-23 13:57:12 +00:00
|
|
|
// list of PARAM_CFG_xxx to read/write parameters saved in config
|
2012-05-04 17:44:42 +00:00
|
|
|
PARAM_CFG_ARRAY m_configSettings;
|
2011-09-23 13:57:12 +00:00
|
|
|
|
2010-12-17 20:34:29 +00:00
|
|
|
int m_displayMode; // Gerber images ("layers" in Gerbview) can be drawn:
|
2012-05-04 17:44:42 +00:00
|
|
|
// - in fast mode (write mode) but if there are negative
|
2011-03-02 15:24:39 +00:00
|
|
|
// items only the last image is correctly drawn (no
|
|
|
|
// problem to see only one image or when no negative items)
|
2012-05-04 17:44:42 +00:00
|
|
|
// - in "exact" mode (but slower) in write mode:
|
|
|
|
// last image covers previous images
|
|
|
|
// - in "exact" mode (also slower) in OR mode
|
|
|
|
// (transparency mode)
|
2010-12-17 20:34:29 +00:00
|
|
|
// m_displayMode = 0, 1 or 2
|
2011-09-23 13:57:12 +00:00
|
|
|
|
2012-05-04 17:44:42 +00:00
|
|
|
bool m_show_layer_manager_tools;
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2016-08-16 10:56:20 +00:00
|
|
|
void updateComponentListSelectBox();
|
|
|
|
void updateNetnameListSelectBox();
|
|
|
|
void updateAperAttributesSelectBox();
|
2016-08-17 08:19:10 +00:00
|
|
|
void updateDCodeSelectBox();
|
2018-07-11 12:56:05 +00:00
|
|
|
void updateGridSelectBox();
|
|
|
|
void updateZoomSelectBox();
|
2018-07-07 08:50:13 +00:00
|
|
|
void unitsChangeRefresh() override; // See class EDA_DRAW_FRAME
|
2016-08-16 10:56:20 +00:00
|
|
|
|
2017-09-17 22:43:20 +00:00
|
|
|
// The Tool Framework initalization
|
|
|
|
void setupTools();
|
|
|
|
|
|
|
|
/// Updates the GAL with display settings changes
|
|
|
|
void applyDisplaySettingsToGAL();
|
|
|
|
|
2018-02-21 02:58:53 +00:00
|
|
|
/**
|
2018-11-26 11:49:13 +00:00
|
|
|
* Loads a list of Gerber and NC drill files and updates the view based on them
|
2018-02-21 02:58:53 +00:00
|
|
|
* @param aPath is the base path for the filenames if they are relative
|
|
|
|
* @param aFilenameList is a list of filenames to load
|
2018-11-26 11:49:13 +00:00
|
|
|
* @param aFileType is a list of type of files to load (0 = Gerber, 1 = NC drill)
|
|
|
|
* if nullptr, files are expected Gerber type.
|
2018-02-21 02:58:53 +00:00
|
|
|
* @return true if every file loaded successfully
|
|
|
|
*/
|
2018-11-26 11:49:13 +00:00
|
|
|
bool loadListOfGerberAndDrillFiles( const wxString& aPath,
|
|
|
|
const wxArrayString& aFilenameList,
|
|
|
|
const std::vector<int>* aFileType = nullptr );
|
2018-02-21 02:58:53 +00:00
|
|
|
|
* 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
|
|
|
public:
|
|
|
|
GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent );
|
2011-03-12 09:50:21 +00:00
|
|
|
~GERBVIEW_FRAME();
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnCloseWindow( wxCloseEvent& Event );
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl ) override;
|
* 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
|
|
|
|
2011-03-14 21:19:13 +00:00
|
|
|
// Virtual basic functions:
|
2018-03-13 21:59:46 +00:00
|
|
|
void RedrawActiveWindow( wxDC* DC, bool EraseBg ) override;
|
|
|
|
void ReCreateHToolbar() override;
|
|
|
|
void ReCreateAuxiliaryToolbar() override;
|
2011-10-17 20:01:27 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function ReCreateVToolbar
|
|
|
|
* creates or updates the right vertical toolbar.
|
|
|
|
*
|
|
|
|
* @note This is currently not used.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void ReCreateVToolbar() override;
|
2011-10-17 20:01:27 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Create or update the left vertical toolbar (option toolbar
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void ReCreateOptToolbar();
|
2011-10-17 20:01:27 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void ReCreateMenuBar() override;
|
|
|
|
void OnLeftClick( wxDC* aDC, const wxPoint& aMousePos ) override;
|
|
|
|
void OnLeftDClick( wxDC* aDC, const wxPoint& aMousePos ) override;
|
|
|
|
bool OnRightClick( const wxPoint& aMousePos, wxMenu* aPopMenu ) override;
|
|
|
|
void OnUpdateSelectTool( wxUpdateUIEvent& aEvent );
|
2018-07-11 12:56:05 +00:00
|
|
|
void OnUpdateSelectZoom( wxUpdateUIEvent& aEvent );
|
2018-03-13 21:59:46 +00:00
|
|
|
double BestZoom() override;
|
|
|
|
void UpdateStatusBar() override;
|
2011-03-14 21:19:13 +00:00
|
|
|
|
2015-01-06 07:38:58 +00:00
|
|
|
/**
|
|
|
|
* Function GetZoomLevelIndicator
|
|
|
|
* returns a human readable value which can be displayed as zoom
|
|
|
|
* level indicator in dialogs.
|
|
|
|
* Virtual from the base class
|
|
|
|
*/
|
2016-09-24 18:53:15 +00:00
|
|
|
const wxString GetZoomLevelIndicator() const override;
|
2015-01-06 07:38:58 +00:00
|
|
|
|
2010-12-15 20:15:24 +00:00
|
|
|
/**
|
|
|
|
* Function GetDisplayMode
|
|
|
|
* @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)
|
|
|
|
*/
|
2010-12-17 20:34:29 +00:00
|
|
|
int GetDisplayMode() { return m_displayMode; }
|
2010-12-15 20:15:24 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function SetDisplayMode
|
|
|
|
* @param aMode = 0 for fast mode
|
|
|
|
* 1 for exact mode, write mode
|
|
|
|
* 2 for exact mode, OR mode (transparency mode)
|
|
|
|
*/
|
2010-12-17 20:34:29 +00:00
|
|
|
void SetDisplayMode( int aMode ) { m_displayMode = aMode; }
|
2010-12-15 20:15:24 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2012-05-04 17:44:42 +00:00
|
|
|
* Function IsElementVisible
|
|
|
|
* tests whether a given element category is visible. Keep this as an
|
|
|
|
* inline function.
|
2018-07-07 08:50:13 +00:00
|
|
|
* @param aLayerID is an item id from the enum GERBVIEW_LAYER_ID
|
2012-05-04 17:44:42 +00:00
|
|
|
* @return bool - true if the element is visible.
|
2010-02-03 14:05:17 +00:00
|
|
|
*/
|
2018-07-07 08:50:13 +00:00
|
|
|
bool IsElementVisible( int aLayerID ) const;
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2012-05-04 17:44:42 +00:00
|
|
|
* Function SetElementVisibility
|
|
|
|
* changes the visibility of an element category
|
2017-03-13 03:19:33 +00:00
|
|
|
* @param aItemIdVisible is an item id from the enum GERBVIEW_LAYER_ID
|
2012-05-04 17:44:42 +00:00
|
|
|
* @param aNewState = The new visibility state of the element category
|
2017-03-13 03:19:33 +00:00
|
|
|
* (see enum PCB)
|
2012-05-04 17:44:42 +00:00
|
|
|
*/
|
2018-07-07 08:50:13 +00:00
|
|
|
void SetElementVisibility( int aLayerID, bool aNewState );
|
2012-05-04 17:44:42 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function SetGridVisibility(), virtual from EDA_DRAW_FRAME
|
2010-02-03 14:05:17 +00:00
|
|
|
* It may be overloaded by derived classes
|
|
|
|
* @param aVisible = true if the grid must be shown
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void SetGridVisibility( bool aVisible ) override;
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2012-05-04 17:44:42 +00:00
|
|
|
* Function GetVisibleLayers
|
|
|
|
* is a proxy function that calls the correspondent function in m_BoardSettings
|
|
|
|
* Returns a bit-mask of all the layers that are visible
|
2014-06-27 17:07:42 +00:00
|
|
|
* @return long - the visible layers in bit-mapped form.
|
2010-02-03 14:05:17 +00:00
|
|
|
*/
|
2014-06-27 17:07:42 +00:00
|
|
|
long GetVisibleLayers() const;
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2012-05-04 17:44:42 +00:00
|
|
|
* Function SetVisibleLayers
|
|
|
|
* is a proxy function that calls the correspondent function in m_BoardSettings
|
|
|
|
* changes the bit-mask of visible layers
|
|
|
|
* @param aLayerMask = The new bit-mask of visible layers
|
2010-02-03 14:05:17 +00:00
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void SetVisibleLayers( long aLayerMask );
|
2010-02-03 14:05:17 +00:00
|
|
|
|
|
|
|
/**
|
2012-05-04 17:44:42 +00:00
|
|
|
* Function IsLayerVisible
|
|
|
|
* tests whether a given layer is visible
|
2017-09-17 22:43:20 +00:00
|
|
|
* @param aLayer = The layer to be tested (still 0-31!)
|
2012-05-04 17:44:42 +00:00
|
|
|
* @return bool - true if the layer is visible.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
bool IsLayerVisible( int aLayer ) const;
|
2012-05-04 17:44:42 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function GetVisibleElementColor
|
2012-09-12 17:28:55 +00:00
|
|
|
* returns the color of a gerber visible element.
|
2010-02-03 14:05:17 +00:00
|
|
|
*/
|
2018-07-07 08:50:13 +00:00
|
|
|
COLOR4D GetVisibleElementColor( int aLayerID );
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2018-07-07 08:50:13 +00:00
|
|
|
void SetVisibleElementColor( int aLayerID, COLOR4D aColor );
|
2010-12-17 20:34:29 +00:00
|
|
|
|
2010-02-03 14:05:17 +00:00
|
|
|
/**
|
2012-05-04 17:44:42 +00:00
|
|
|
* Function GetLayerColor
|
2013-01-06 13:31:49 +00:00
|
|
|
* gets a layer color for any valid layer.
|
2010-02-03 14:05:17 +00:00
|
|
|
*/
|
2017-02-20 16:57:41 +00:00
|
|
|
COLOR4D GetLayerColor( int aLayer ) const;
|
2010-02-03 14:05:17 +00:00
|
|
|
|
|
|
|
/**
|
2012-05-04 17:44:42 +00:00
|
|
|
* Function SetLayerColor
|
2013-01-06 13:31:49 +00:00
|
|
|
* changes a layer color for any valid layer.
|
2010-02-03 14:05:17 +00:00
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void SetLayerColor( int aLayer, COLOR4D aColor );
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2013-01-06 13:31:49 +00:00
|
|
|
/**
|
|
|
|
* Function GetNegativeItemsColor
|
|
|
|
* @return the color of negative items.
|
2018-04-08 10:28:59 +00:00
|
|
|
* This is usually the background color, but can be another color
|
2013-01-06 13:31:49 +00:00
|
|
|
* in order to see negative objects
|
|
|
|
*/
|
2017-08-04 12:43:02 +00:00
|
|
|
COLOR4D GetNegativeItemsColor();
|
2013-01-06 13:31:49 +00:00
|
|
|
|
2010-02-03 14:05:17 +00:00
|
|
|
/**
|
|
|
|
* Function ReFillLayerWidget
|
|
|
|
* changes out all the layers in m_Layers and may be called upon
|
2013-06-28 10:49:43 +00:00
|
|
|
* loading new gerber files.
|
2010-02-03 14:05:17 +00:00
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void ReFillLayerWidget();
|
2010-02-03 14:05:17 +00:00
|
|
|
|
2010-02-04 09:08:08 +00:00
|
|
|
/**
|
2017-09-17 22:43:20 +00:00
|
|
|
* Function SetActiveLayer
|
2010-02-04 09:08:08 +00:00
|
|
|
* will change the currently active layer to \a aLayer and also
|
2013-06-28 10:49:43 +00:00
|
|
|
* update the GERBER_LAYER_WIDGET.
|
2010-02-04 09:08:08 +00:00
|
|
|
*/
|
2017-09-17 22:43:20 +00:00
|
|
|
void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true );
|
2010-12-17 20:34:29 +00:00
|
|
|
|
2010-02-04 09:08:08 +00:00
|
|
|
/**
|
2017-09-17 22:43:20 +00:00
|
|
|
* Function SetActiveLayer
|
2010-02-04 09:08:08 +00:00
|
|
|
* returns the active layer
|
|
|
|
*/
|
2017-09-17 22:43:20 +00:00
|
|
|
int GetActiveLayer();
|
2010-12-17 20:34:29 +00:00
|
|
|
|
2011-03-02 15:24:39 +00:00
|
|
|
/**
|
|
|
|
* Function getNextAvailableLayer
|
|
|
|
* finds 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.
|
|
|
|
*/
|
2014-06-27 17:07:42 +00:00
|
|
|
int getNextAvailableLayer( int aLayer = 0 ) const;
|
2011-03-02 15:24:39 +00:00
|
|
|
|
2012-05-04 17:44:42 +00:00
|
|
|
bool hasAvailableLayers() const
|
|
|
|
{
|
|
|
|
return getNextAvailableLayer() != NO_AVAILABLE_LAYERS;
|
|
|
|
}
|
2011-03-02 15:24:39 +00:00
|
|
|
|
2010-02-04 09:08:08 +00:00
|
|
|
/**
|
|
|
|
* Function syncLayerWidget
|
2013-06-28 10:49:43 +00:00
|
|
|
* updates the currently "selected" layer within the GERBER_LAYER_WIDGET.
|
2017-09-17 22:43:20 +00:00
|
|
|
* The currently active layer is defined by the return value of GetActiveLayer().
|
2010-02-04 09:08:08 +00:00
|
|
|
* <p>
|
|
|
|
* This function cannot be inline without including layer_widget.h in
|
|
|
|
* here and we do not want to do that.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void syncLayerWidget();
|
2010-02-04 09:08:08 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function syncLayerBox
|
|
|
|
* updates the currently "selected" layer within m_SelLayerBox
|
|
|
|
* The currently active layer, as defined by the return value of
|
2017-09-17 22:43:20 +00:00
|
|
|
* GetActiveLayer().
|
2016-05-23 15:47:16 +00:00
|
|
|
* @param aRebuildLayerBox = true to rebuild the layer box
|
|
|
|
* false to just updates the selection.
|
2010-02-04 09:08:08 +00:00
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void syncLayerBox( bool aRebuildLayerBox = false );
|
2010-02-04 09:08:08 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function UpdateTitleAndInfo
|
2010-10-06 17:28:07 +00:00
|
|
|
* displays the short filename (if exists) of the selected layer
|
2011-09-30 18:15:37 +00:00
|
|
|
* on the caption of the main GerbView window
|
2010-10-06 17:28:07 +00:00
|
|
|
* and some other parameters
|
2010-12-14 15:56:30 +00:00
|
|
|
* Name of the layer (found in the gerber file: LN <name> command) in the status bar
|
|
|
|
* Name of the Image (found in the gerber file: IN <name> command) in the status bar
|
2010-10-06 17:28:07 +00:00
|
|
|
* and other data in toolbar
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void UpdateTitleAndInfo();
|
2010-10-06 17:28:07 +00:00
|
|
|
|
2011-03-12 09:50:21 +00:00
|
|
|
/**
|
|
|
|
* Function GetConfigurationSettings
|
2011-09-30 18:15:37 +00:00
|
|
|
* Populates the GerbView applications settings list.
|
|
|
|
* (list of parameters that must be saved in GerbView parameters)
|
2011-10-17 20:01:27 +00:00
|
|
|
* Currently, only the settings that are needed at start up by the main window are
|
|
|
|
* defined here. There are other locally used settings scattered throughout the
|
|
|
|
* GerbView source code (mainly in dialogs). If you need to define a configuration
|
|
|
|
* setting that need to be loaded at run time, this is the place to define it.
|
2011-03-12 09:50:21 +00:00
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
PARAM_CFG_ARRAY& GetConfigurationSettings( void );
|
2011-03-12 09:50:21 +00:00
|
|
|
|
2016-09-25 17:06:49 +00:00
|
|
|
void LoadSettings( wxConfigBase* aCfg ) override;
|
2009-11-22 20:55:05 +00:00
|
|
|
|
2016-09-25 17:06:49 +00:00
|
|
|
void SaveSettings( wxConfigBase* aCfg ) override;
|
2009-11-22 20:55:05 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnToggleCoordType( wxCommandEvent& aEvent );
|
|
|
|
void OnToggleFlashItemDrawMode( wxCommandEvent& aEvent );
|
|
|
|
void OnToggleLineDrawMode( wxCommandEvent& aEvent );
|
|
|
|
void OnTogglePolygonDrawMode( wxCommandEvent& aEvent );
|
|
|
|
void OnToggleShowLayerManager( wxCommandEvent& aEvent );
|
2010-12-17 20:34:29 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void ShowChangedLanguage() override;
|
|
|
|
|
|
|
|
void Process_Special_Functions( wxCommandEvent& event );
|
|
|
|
void OnSelectOptionToolbar( wxCommandEvent& event );
|
2017-09-20 08:30:48 +00:00
|
|
|
|
|
|
|
/// Handles the changing of the highlighted component/net/attribute
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnSelectHighlightChoice( wxCommandEvent& event );
|
2010-12-17 20:34:29 +00:00
|
|
|
|
2011-03-16 10:47:15 +00:00
|
|
|
/**
|
|
|
|
* Function OnSelectActiveDCode
|
|
|
|
* Selects the active DCode for the current active layer.
|
2011-10-17 20:01:27 +00:00
|
|
|
* Items using this DCode are highlighted.
|
2011-03-16 10:47:15 +00:00
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnSelectActiveDCode( wxCommandEvent& event );
|
2011-03-16 10:47:15 +00:00
|
|
|
|
2011-03-14 21:19:13 +00:00
|
|
|
/**
|
|
|
|
* Function OnSelectActiveLayer
|
|
|
|
* Selects the active layer:
|
|
|
|
* - if a file is loaded, it is loaded in this layer
|
|
|
|
* _ this layer is displayed on top of other layers
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnSelectActiveLayer( wxCommandEvent& event );
|
2011-03-14 21:19:13 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function OnShowGerberSourceFile
|
|
|
|
* Call the preferred editor to show (and edit) the gerber source file
|
|
|
|
* loaded in the active layer
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnShowGerberSourceFile( wxCommandEvent& event );
|
2011-03-14 21:19:13 +00:00
|
|
|
|
2010-12-15 20:15:24 +00:00
|
|
|
/**
|
|
|
|
* Function OnSelectDisplayMode
|
|
|
|
* called on a display mode selection
|
|
|
|
* Mode selection can be fast display,
|
|
|
|
* or exact mode with stacked images or with transparency
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnSelectDisplayMode( wxCommandEvent& event );
|
2011-03-14 21:19:13 +00:00
|
|
|
|
2011-04-06 13:52:47 +00:00
|
|
|
/**
|
|
|
|
* Function OnQuit
|
|
|
|
* called on request of application quit
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnQuit( wxCommandEvent& event );
|
2011-04-06 13:52:47 +00:00
|
|
|
|
2015-05-05 18:39:42 +00:00
|
|
|
///> @copydoc EDA_DRAW_FRAME::GetHotKeyDescription()
|
2016-09-24 18:53:15 +00:00
|
|
|
EDA_HOTKEY* GetHotKeyDescription( int aCommand ) const override;
|
2015-05-05 18:39:42 +00:00
|
|
|
|
2011-04-06 13:52:47 +00:00
|
|
|
/**
|
2012-05-19 19:04:03 +00:00
|
|
|
* Function OnHotKey.
|
|
|
|
* ** Commands are case insensitive **
|
|
|
|
* Some commands are relatives to the item under the mouse cursor
|
|
|
|
* @param aDC = current device context
|
|
|
|
* @param aHotkeyCode = hotkey code (ascii or wxWidget code for special keys)
|
|
|
|
* @param aPosition The cursor position in logical (drawing) units.
|
|
|
|
* @param aItem = NULL or pointer on a EDA_ITEM under the mouse cursor
|
2011-04-06 13:52:47 +00:00
|
|
|
*/
|
2016-09-24 18:53:15 +00:00
|
|
|
bool OnHotKey( wxDC* aDC, int aHotkeyCode, const wxPoint& aPosition, EDA_ITEM* aItem = NULL ) override;
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
GERBER_DRAW_ITEM* Locate( const wxPoint& aPosition, int typeloc );
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void Process_Config( wxCommandEvent& event );
|
2011-03-02 15:24:39 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnUpdateDrawMode( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateCoordType( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateFlashedItemsDrawMode( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateLineDrawMode( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdatePolygonDrawMode( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateShowDCodes( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateShowNegativeItems( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateShowLayerManager( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateDiffMode( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateHighContrastMode( wxUpdateUIEvent& aEvent );
|
2011-02-21 13:54:29 +00:00
|
|
|
|
2011-11-10 15:55:05 +00:00
|
|
|
/**
|
* 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
|
|
|
* Function BlockCommand
|
2011-11-10 15:55:05 +00:00
|
|
|
* returns the block command (BLOCK_MOVE, BLOCK_COPY...) corresponding to
|
|
|
|
* the \a aKey (ALT, SHIFT ALT ..)
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
virtual int BlockCommand( EDA_KEY key ) override;
|
2011-11-10 15:55:05 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function HandleBlockPlace
|
|
|
|
* handles the block place command.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
virtual void HandleBlockPlace( wxDC* DC ) override;
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2011-11-10 15:55:05 +00:00
|
|
|
/**
|
2018-03-13 21:59:46 +00:00
|
|
|
* Function HandleBlockEnd
|
2011-11-10 15:55:05 +00:00
|
|
|
* handles the end of a block command,
|
|
|
|
* It is called at the end of the definition of the area of a block.
|
|
|
|
* Depending on the current block command, this command is executed
|
|
|
|
* or parameters are initialized to prepare a call to HandleBlockPlace
|
|
|
|
* in GetScreen()->m_BlockLocate
|
|
|
|
*
|
|
|
|
* @return false if no item selected, or command finished,
|
|
|
|
* true if some items found and HandleBlockPlace must be called later.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
virtual bool HandleBlockEnd( wxDC* DC ) override;
|
2009-09-22 12:27:57 +00:00
|
|
|
|
2009-07-31 05:33:11 +00:00
|
|
|
/**
|
|
|
|
* Function Block_Move
|
|
|
|
* moves all tracks and segments within the selected block.
|
2009-09-22 12:27:57 +00:00
|
|
|
* New location is determined by the current offset from the selected
|
|
|
|
* block's original location.
|
2009-07-31 05:33:11 +00:00
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void Block_Move();
|
2009-07-31 05:33:11 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function ToPrinter
|
2010-01-01 13:30:39 +00:00
|
|
|
* Open a dialog frame to print layers
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void ToPrinter( wxCommandEvent& event );
|
2012-05-04 17:44:42 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void Files_io( wxCommandEvent& event );
|
2011-09-26 20:32:56 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function OnGbrFileHistory
|
|
|
|
* deletes the current data and loads a Gerber file selected from history list on
|
|
|
|
* current layer.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnGbrFileHistory( wxCommandEvent& event );
|
2011-09-26 20:32:56 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function OnDrlFileHistory
|
|
|
|
* deletes the current data and load a drill file in Excellon format selected from
|
|
|
|
* history list on current layer.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnDrlFileHistory( wxCommandEvent& event );
|
2010-05-17 20:35:46 +00:00
|
|
|
|
2017-01-26 09:45:28 +00:00
|
|
|
/**
|
|
|
|
* Function OnZipFileHistory
|
|
|
|
* deletes the current data and load a zip archive file selected from the
|
|
|
|
* history list. The archive is expected coantaining a set of gerber and drill file
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnZipFileHistory( wxCommandEvent& event );
|
2017-01-26 09:45:28 +00:00
|
|
|
|
2017-08-19 16:28:11 +00:00
|
|
|
/**
|
|
|
|
* deletes the current data and load a gerber job file selected from the
|
|
|
|
* history list.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void OnJobFileHistory( wxCommandEvent& event );
|
2017-08-19 16:28:11 +00:00
|
|
|
|
2017-01-26 09:45:28 +00:00
|
|
|
/**
|
|
|
|
* Extracts 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
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr );
|
2017-01-26 09:45:28 +00:00
|
|
|
|
2010-05-17 20:35:46 +00:00
|
|
|
/**
|
2010-12-15 20:15:24 +00:00
|
|
|
* function LoadGerberFiles
|
|
|
|
* Load a photoplot (Gerber) file or many files.
|
2011-03-02 15:24:39 +00:00
|
|
|
* @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
|
2010-12-15 20:15:24 +00:00
|
|
|
* if void string: user will be prompted for filename(s)
|
|
|
|
* @return true if file was opened successfully.
|
2010-05-17 20:35:46 +00:00
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
bool LoadGerberFiles( const wxString& aFileName );
|
|
|
|
bool Read_GERBER_File( const wxString& GERBER_FullFileName );
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2011-03-16 20:51:20 +00:00
|
|
|
/**
|
2017-01-26 09:45:28 +00:00
|
|
|
* function LoadExcellonFiles
|
2011-03-16 20:51:20 +00:00
|
|
|
* 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
|
2017-01-26 09:45:28 +00:00
|
|
|
* if empty string: user will be prompted for filename(s)
|
2011-03-16 20:51:20 +00:00
|
|
|
* @return true if file was opened successfully.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
bool LoadExcellonFiles( const wxString& aFileName );
|
|
|
|
bool Read_EXCELLON_File( const wxString& aFullFileName );
|
2011-03-16 20:51:20 +00:00
|
|
|
|
2017-01-26 09:45:28 +00:00
|
|
|
/**
|
|
|
|
* function LoadZipArchiveFileLoadZipArchiveFile
|
|
|
|
* 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.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
bool LoadZipArchiveFile( const wxString& aFileName );
|
2017-01-26 09:45:28 +00:00
|
|
|
|
2017-08-19 16:28:11 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
bool LoadGerberJobFile( const wxString& aFileName );
|
2017-08-19 16:28:11 +00:00
|
|
|
|
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
bool GeneralControl( wxDC* aDC, const wxPoint& aPosition, EDA_KEY aHotKey = 0 ) override;
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2011-10-17 20:01:27 +00:00
|
|
|
/**
|
|
|
|
* Set Size Items (Lines, Flashes) from DCodes List
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void Liste_D_Codes();
|
2009-07-29 13:10:36 +00:00
|
|
|
|
|
|
|
// PCB handling
|
2018-03-13 21:59:46 +00:00
|
|
|
bool Clear_DrawLayers( bool query );
|
|
|
|
void Erase_Current_DrawLayer( bool query );
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2018-03-13 21:59:46 +00:00
|
|
|
void SortLayersByX2Attributes();
|
2018-02-28 02:33:41 +00:00
|
|
|
|
2018-03-04 21:59:12 +00:00
|
|
|
/**
|
|
|
|
* Updates the display options and refreshes the view as needed
|
|
|
|
* @param aOptions is the new options to apply
|
|
|
|
*/
|
2018-03-13 21:59:46 +00:00
|
|
|
void UpdateDisplayOptions( const GBR_DISPLAY_OPTIONS& aOptions );
|
2018-03-04 21:59:12 +00:00
|
|
|
|
2009-07-29 13:10:36 +00:00
|
|
|
// Conversion function
|
2018-03-13 21:59:46 +00:00
|
|
|
void ExportDataInPcbnewFormat( wxCommandEvent& event );
|
2009-07-29 13:10:36 +00:00
|
|
|
|
|
|
|
/* SaveCopyInUndoList() virtual
|
2011-09-30 18:15:37 +00:00
|
|
|
* currently: do nothing in GerbView.
|
2009-07-29 13:10:36 +00:00
|
|
|
*/
|
2012-05-04 17:44:42 +00:00
|
|
|
void SaveCopyInUndoList( GERBER_DRAW_ITEM* aItemToCopy,
|
|
|
|
UNDO_REDO_T aTypeCommand = UR_UNSPECIFIED,
|
|
|
|
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) { }
|
2009-09-22 12:27:57 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function SaveCopyInUndoList (overloaded).
|
2009-08-03 18:54:48 +00:00
|
|
|
* Creates a new entry in undo list of commands.
|
|
|
|
* add a list of pickers to handle a list of items
|
|
|
|
* @param aItemsList = the list of items modified by the command to undo
|
2011-04-05 14:46:51 +00:00
|
|
|
* @param aTypeCommand = command type (see enum UNDO_REDO_T)
|
2009-09-22 12:27:57 +00:00
|
|
|
* @param aTransformPoint = the reference point of the transformation,
|
|
|
|
* for commands like move
|
2009-08-03 18:54:48 +00:00
|
|
|
*/
|
2013-12-18 12:27:18 +00:00
|
|
|
void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
|
2012-05-04 17:44:42 +00:00
|
|
|
UNDO_REDO_T aTypeCommand,
|
|
|
|
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) )
|
2009-08-03 18:54:48 +00:00
|
|
|
{
|
2011-09-30 18:15:37 +00:00
|
|
|
// currently: do nothing in GerbView.
|
2009-08-03 18:54:48 +00:00
|
|
|
}
|
2009-07-29 13:10:36 +00:00
|
|
|
|
2017-09-17 22:43:20 +00:00
|
|
|
///> @copydoc EDA_DRAW_FRAME::UseGalCanvas
|
|
|
|
virtual void UseGalCanvas( bool aEnable ) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* switches currently used canvas (default / Cairo / OpenGL).
|
|
|
|
*/
|
2018-01-21 11:04:04 +00:00
|
|
|
void OnSwitchCanvas( wxCommandEvent& aEvent );
|
2017-09-17 22:43:20 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Update UI called when switches currently used canvas (default / Cairo / OpenGL).
|
|
|
|
*/
|
|
|
|
void OnUpdateSwitchCanvas( wxUpdateUIEvent& aEvent );
|
|
|
|
|
2018-05-14 17:34:18 +00:00
|
|
|
/**
|
|
|
|
* Allows Gerbview to install its preferences panels into the preferences dialog.
|
|
|
|
*/
|
|
|
|
void InstallPreferences( PAGED_DIALOG* aParent ) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Called after the preferences dialog is run.
|
|
|
|
*/
|
|
|
|
void CommonSettingsChanged() override;
|
2018-01-08 04:05:03 +00:00
|
|
|
|
2009-07-29 13:10:36 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
|
|
|
};
|
|
|
|
|
2012-05-04 17:44:42 +00:00
|
|
|
#endif /* WX_GERBER_STRUCT_H */
|