2011-10-13 19:56:32 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2013-10-14 15:29:16 +00:00
|
|
|
* Copyright (C) 2010 Jean-Pierre Charras, jp.charras@wanadoo.fr
|
2019-05-26 22:22:03 +00:00
|
|
|
* Copyright (C) 1992-2019 KiCad Developers, see AUTHORS.txt for contributors.
|
2011-10-13 19:56:32 +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-13 19:56:32 +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-13 19:56:32 +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-13 19:56:32 +00:00
|
|
|
*/
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2012-10-15 22:30:01 +00:00
|
|
|
#ifndef WXPCB_STRUCT_H_
|
|
|
|
#define WXPCB_STRUCT_H_
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2018-02-27 17:02:10 +00:00
|
|
|
#include <unordered_map>
|
2018-08-15 09:26:32 +00:00
|
|
|
#include <map>
|
2017-08-24 15:56:15 +00:00
|
|
|
#include "pcb_base_edit_frame.h"
|
|
|
|
#include "config_params.h"
|
2018-01-31 08:23:20 +00:00
|
|
|
#include "undo_redo_container.h"
|
2017-08-24 15:56:15 +00:00
|
|
|
#include "zones.h"
|
2008-01-01 11:58:14 +00:00
|
|
|
|
|
|
|
/* Forward declarations of classes. */
|
2018-08-15 09:26:32 +00:00
|
|
|
class ACTION_PLUGIN;
|
2008-01-01 11:58:14 +00:00
|
|
|
class PCB_SCREEN;
|
|
|
|
class BOARD;
|
2016-08-17 15:24:04 +00:00
|
|
|
class BOARD_COMMIT;
|
2016-05-13 15:31:54 +00:00
|
|
|
class BOARD_ITEM_CONTAINER;
|
2008-01-01 11:58:14 +00:00
|
|
|
class TEXTE_PCB;
|
|
|
|
class MODULE;
|
|
|
|
class TRACK;
|
2014-04-25 06:00:04 +00:00
|
|
|
class VIA;
|
2008-01-01 11:58:14 +00:00
|
|
|
class D_PAD;
|
|
|
|
class TEXTE_MODULE;
|
2011-09-07 19:41:04 +00:00
|
|
|
class PCB_TARGET;
|
2010-04-23 09:54:40 +00:00
|
|
|
class DIMENSION;
|
2008-01-01 11:58:14 +00:00
|
|
|
class EDGE_MODULE;
|
|
|
|
class DRC;
|
2018-02-22 15:25:31 +00:00
|
|
|
class DIALOG_PLOT;
|
2008-01-01 11:58:14 +00:00
|
|
|
class ZONE_CONTAINER;
|
2009-02-04 15:25:03 +00:00
|
|
|
class DRAWSEGMENT;
|
|
|
|
class GENERAL_COLLECTOR;
|
|
|
|
class GENERAL_COLLECTORS_GUIDE;
|
2010-01-24 02:05:07 +00:00
|
|
|
class PCB_LAYER_WIDGET;
|
2011-09-20 13:57:40 +00:00
|
|
|
class MARKER_PCB;
|
|
|
|
class BOARD_ITEM;
|
2012-05-04 17:44:42 +00:00
|
|
|
class PCB_LAYER_BOX_SELECTOR;
|
2013-04-25 16:29:35 +00:00
|
|
|
class NETLIST;
|
|
|
|
class REPORTER;
|
2014-03-16 17:40:23 +00:00
|
|
|
struct PARSE_ERROR;
|
2016-09-21 02:58:20 +00:00
|
|
|
class IO_ERROR;
|
2013-05-20 14:49:20 +00:00
|
|
|
class FP_LIB_TABLE;
|
2019-04-18 02:10:56 +00:00
|
|
|
class BOARD_NETLIST_UPDATER;
|
2019-06-03 13:49:17 +00:00
|
|
|
class ACTION_MENU;
|
2008-01-01 11:58:14 +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
|
|
|
namespace PCB { struct IFACE; } // KIFACE_I is in pcbnew.cpp
|
|
|
|
|
2019-02-08 15:21:48 +00:00
|
|
|
/**
|
|
|
|
* Enum to signify the result of editing tracks and vias
|
|
|
|
*/
|
|
|
|
enum TRACK_ACTION_RESULT
|
|
|
|
{
|
|
|
|
TRACK_ACTION_DRC_ERROR = -1,//!< TRACK_ACTION_DRC_ERROR - Track not changed to to DRC
|
|
|
|
TRACK_ACTION_SUCCESS, //!< TRACK_ACTION_SUCCESS - Track changed successfully
|
|
|
|
TRACK_ACTION_NONE //!< TRACK_ACTION_NONE - Nothing to change
|
|
|
|
};
|
|
|
|
|
2019-08-03 03:03:03 +00:00
|
|
|
enum LAST_PATH_TYPE
|
|
|
|
{
|
|
|
|
LAST_PATH_NETLIST = 0,
|
|
|
|
LAST_PATH_STEP,
|
|
|
|
LAST_PATH_IDF,
|
|
|
|
LAST_PATH_VRML,
|
|
|
|
LAST_PATH_SPECCTRADSN,
|
|
|
|
LAST_PATH_GENCAD,
|
|
|
|
|
|
|
|
LAST_PATH_SIZE
|
|
|
|
};
|
|
|
|
|
2009-07-30 11:04:07 +00:00
|
|
|
/**
|
2020-01-10 14:31:00 +00:00
|
|
|
* PCB_EDIT_FRAME
|
* 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
|
|
|
* is the main frame for Pcbnew.
|
2011-09-26 20:32:56 +00:00
|
|
|
*
|
2011-09-30 18:15:37 +00:00
|
|
|
* See also class PCB_BASE_FRAME(): Basic class for Pcbnew and GerbView.
|
2009-11-23 20:18:47 +00:00
|
|
|
*/
|
2015-03-02 17:29:18 +00:00
|
|
|
|
2016-08-11 19:13:47 +00:00
|
|
|
|
2014-07-09 11:50:27 +00:00
|
|
|
class PCB_EDIT_FRAME : public PCB_BASE_EDIT_FRAME
|
2008-01-01 11:58:14 +00:00
|
|
|
{
|
2014-11-15 13:43:23 +00:00
|
|
|
friend struct PCB::IFACE;
|
2010-01-24 02:05:07 +00:00
|
|
|
friend class PCB_LAYER_WIDGET;
|
|
|
|
|
2011-12-14 20:03:15 +00:00
|
|
|
/// The auxiliary right vertical tool bar used to access the microwave tools.
|
2019-06-24 15:27:05 +00:00
|
|
|
ACTION_TOOLBAR* m_microWaveToolBar;
|
2011-12-14 20:03:15 +00:00
|
|
|
|
2010-01-21 07:41:30 +00:00
|
|
|
protected:
|
2019-08-03 03:03:03 +00:00
|
|
|
PARAM_CFG_ARRAY m_configParams; // List of Pcbnew configuration settings.
|
2019-03-06 13:01:40 +00:00
|
|
|
PARAM_CFG_ARRAY m_projectFileParams;
|
2010-04-23 14:46:00 +00:00
|
|
|
|
2019-08-03 03:03:03 +00:00
|
|
|
wxString m_lastPath[ LAST_PATH_SIZE ];
|
2010-04-23 14:46:00 +00:00
|
|
|
|
2019-08-05 15:10:58 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Store the previous layer toolbar icon state information
|
|
|
|
*/
|
|
|
|
struct LAYER_TOOLBAR_ICON_VALUES
|
|
|
|
{
|
|
|
|
int previous_requested_scale;
|
|
|
|
COLOR4D previous_active_layer_color;
|
|
|
|
COLOR4D previous_Route_Layer_TOP_color;
|
|
|
|
COLOR4D previous_Route_Layer_BOTTOM_color;
|
|
|
|
COLOR4D previous_via_color;
|
|
|
|
COLOR4D previous_background_color;
|
|
|
|
|
|
|
|
LAYER_TOOLBAR_ICON_VALUES()
|
|
|
|
: previous_requested_scale( 0 ),
|
|
|
|
previous_active_layer_color( COLOR4D::UNSPECIFIED ),
|
|
|
|
previous_Route_Layer_TOP_color( COLOR4D::UNSPECIFIED ),
|
|
|
|
previous_Route_Layer_BOTTOM_color( COLOR4D::UNSPECIFIED ),
|
|
|
|
previous_via_color( COLOR4D::UNSPECIFIED ),
|
|
|
|
previous_background_color( COLOR4D::UNSPECIFIED )
|
|
|
|
{
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
LAYER_TOOLBAR_ICON_VALUES m_prevIconVal;
|
|
|
|
|
2014-07-09 13:02:56 +00:00
|
|
|
// The Tool Framework initalization
|
2013-08-02 15:25:53 +00:00
|
|
|
void setupTools();
|
2013-11-12 01:05:23 +00:00
|
|
|
|
2019-03-18 12:22:33 +00:00
|
|
|
wxString createBackupFile( const wxString& aFileName );
|
|
|
|
|
2017-08-09 07:48:56 +00:00
|
|
|
/**
|
2019-05-28 13:51:47 +00:00
|
|
|
* switches currently used canvas (Cairo / OpenGL).
|
2018-08-11 11:16:41 +00:00
|
|
|
* It also reinit the layers manager that slightly changes with canvases
|
2017-08-09 07:48:56 +00:00
|
|
|
*/
|
2019-05-28 13:51:47 +00:00
|
|
|
void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType ) override;
|
2017-08-09 07:48:56 +00:00
|
|
|
|
2017-01-22 09:05:46 +00:00
|
|
|
#if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU)
|
|
|
|
/**
|
2019-06-03 13:49:17 +00:00
|
|
|
* Function buildActionPluginMenus
|
2018-08-15 09:26:32 +00:00
|
|
|
* Fill action menu with all registered action plugins
|
2017-01-22 09:05:46 +00:00
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
void buildActionPluginMenus( ACTION_MENU* aActionMenu );
|
2017-01-22 09:05:46 +00:00
|
|
|
|
|
|
|
/**
|
2018-08-15 09:26:32 +00:00
|
|
|
* Function AddActionPluginTools
|
|
|
|
* Append action plugin buttons to main toolbar
|
|
|
|
*/
|
|
|
|
void AddActionPluginTools();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function RunActionPlugin
|
|
|
|
* Executes action plugin's Run() method and updates undo buffer
|
|
|
|
* @param aActionPlugin action plugin
|
|
|
|
*/
|
|
|
|
void RunActionPlugin( ACTION_PLUGIN* aActionPlugin );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function OnActionPluginMenu
|
2017-01-22 09:05:46 +00:00
|
|
|
* Launched by the menu when an action is called
|
|
|
|
* @param aEvent sent by wx
|
|
|
|
*/
|
2018-08-15 09:26:32 +00:00
|
|
|
void OnActionPluginMenu( wxCommandEvent& aEvent);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function OnActionPluginButton
|
|
|
|
* Launched by the button when an action is called
|
|
|
|
* @param aEvent sent by wx
|
|
|
|
*/
|
|
|
|
void OnActionPluginButton( wxCommandEvent& aEvent );
|
2017-01-22 09:05:46 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function OnActionPluginRefresh
|
|
|
|
* Refresh plugin list (reload Python plugins)
|
|
|
|
* @param aEvent sent by wx
|
|
|
|
*/
|
2017-01-29 11:25:19 +00:00
|
|
|
void OnActionPluginRefresh( wxCommandEvent& aEvent)
|
|
|
|
{
|
|
|
|
PythonPluginsReload();
|
|
|
|
}
|
2017-01-22 09:05:46 +00:00
|
|
|
#endif
|
|
|
|
|
2017-01-28 17:47:11 +00:00
|
|
|
/** Has meaning only if KICAD_SCRIPTING_WXPYTHON option is
|
|
|
|
* not defined
|
2014-10-31 07:51:22 +00:00
|
|
|
* @return the frame name identifier for the python console frame
|
|
|
|
*/
|
|
|
|
static const wxChar * pythonConsoleNameId()
|
|
|
|
{
|
|
|
|
return wxT( "PythonConsole" );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return a pointer to the python console frame, or NULL if not exist
|
|
|
|
*/
|
|
|
|
static wxWindow * findPythonConsole()
|
|
|
|
{
|
|
|
|
return FindWindowByName( pythonConsoleNameId() );
|
|
|
|
}
|
|
|
|
|
2018-02-25 17:52:52 +00:00
|
|
|
/**
|
|
|
|
* Updates the state of the GUI after a new board is loaded or created
|
|
|
|
*/
|
|
|
|
void onBoardLoaded();
|
|
|
|
|
2010-01-24 02:05:07 +00:00
|
|
|
/**
|
2012-02-06 05:44:19 +00:00
|
|
|
* Function syncLayerWidgetLayer
|
2012-03-12 00:40:48 +00:00
|
|
|
* updates the currently layer "selection" within the PCB_LAYER_WIDGET.
|
2014-03-21 10:17:47 +00:00
|
|
|
* The currently selected layer is defined by the return value of GetActiveLayer().
|
2010-01-24 02:05:07 +00:00
|
|
|
* <p>
|
|
|
|
* This function cannot be inline without including layer_widget.h in
|
|
|
|
* here and we do not want to do that.
|
2011-02-21 13:54:29 +00:00
|
|
|
* </p>
|
2010-01-24 02:05:07 +00:00
|
|
|
*/
|
2012-02-06 05:44:19 +00:00
|
|
|
void syncLayerWidgetLayer();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function syncRenderStates
|
|
|
|
* updates the "Render" checkboxes in the layer widget according
|
|
|
|
* to current toggle values determined by IsElementVisible(), and is helpful
|
|
|
|
* immediately after loading a BOARD which may have state information in it.
|
|
|
|
*/
|
|
|
|
void syncRenderStates();
|
2010-01-24 02:05:07 +00:00
|
|
|
|
2012-03-12 00:40:48 +00:00
|
|
|
/**
|
|
|
|
* Function syncLayerVisibilities
|
|
|
|
* updates each "Layer" checkbox in the layer widget according
|
|
|
|
* to each layer's current visibility determined by IsLayerVisible(), and is
|
|
|
|
* helpful immediately after loading a BOARD which may have state information in it.
|
|
|
|
*/
|
|
|
|
void syncLayerVisibilities();
|
|
|
|
|
2011-10-13 19:56:32 +00:00
|
|
|
/**
|
|
|
|
* Function doAutoSave
|
|
|
|
* performs auto save when the board has been modified and not saved within the
|
|
|
|
* auto save interval.
|
|
|
|
*
|
|
|
|
* @return true if the auto save was successful.
|
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
bool doAutoSave() override;
|
2011-10-13 19:56:32 +00:00
|
|
|
|
|
|
|
/**
|
2011-10-15 13:25:57 +00:00
|
|
|
* Function isautoSaveRequired
|
2011-10-13 19:56:32 +00:00
|
|
|
* returns true if the board has been modified.
|
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
bool isAutoSaveRequired() const override;
|
2015-02-12 03:22:24 +00:00
|
|
|
|
2018-02-26 10:34:36 +00:00
|
|
|
/**
|
|
|
|
* Load the given filename but sets the path to the current project path.
|
|
|
|
* @param full filepath of file to be imported.
|
|
|
|
* @param aFileType PCB_FILE_T value for filetype
|
|
|
|
*/
|
|
|
|
bool importFile( const wxString& aFileName, int aFileType );
|
|
|
|
|
2019-04-05 16:10:59 +00:00
|
|
|
/**
|
|
|
|
* Use the existing edge_cut line thicknesses to infer the edge clearace.
|
|
|
|
*/
|
|
|
|
int inferLegacyEdgeClearance( BOARD* aBoard );
|
|
|
|
|
2018-02-26 10:34:36 +00:00
|
|
|
/**
|
|
|
|
* Rematch orphaned zones and vias to schematic nets.
|
|
|
|
*/
|
2018-02-27 17:02:10 +00:00
|
|
|
bool fixEagleNets( const std::unordered_map<wxString, wxString>& aRemap );
|
2018-02-26 10:34:36 +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
|
|
|
// protected so that PCB::IFACE::CreateWindow() is the only factory.
|
|
|
|
PCB_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent );
|
|
|
|
|
2008-01-01 11:58:14 +00:00
|
|
|
public:
|
2012-05-04 17:44:42 +00:00
|
|
|
PCB_LAYER_BOX_SELECTOR* m_SelLayerBox; // a combo box to display and select active layer
|
2019-01-28 14:15:32 +00:00
|
|
|
wxChoice* m_SelTrackWidthBox; // a choice box to display and select current track width
|
|
|
|
wxChoice* m_SelViaSizeBox; // a choice box to display and select current via diameter
|
2009-11-23 20:18:47 +00:00
|
|
|
|
2011-09-15 17:58:35 +00:00
|
|
|
bool m_show_microwave_tools;
|
|
|
|
bool m_show_layer_manager_tools;
|
2009-10-14 19:43:31 +00:00
|
|
|
|
2018-05-03 22:23:47 +00:00
|
|
|
bool m_ZoneFillsDirty; // Board has been modified since last zone fill.
|
|
|
|
|
2013-11-25 15:50:03 +00:00
|
|
|
virtual ~PCB_EDIT_FRAME();
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2016-01-29 10:21:13 +00:00
|
|
|
/**
|
|
|
|
* Function loadFootprints
|
|
|
|
* loads the footprints for each #COMPONENT in \a aNetlist from the list of libraries.
|
|
|
|
*
|
|
|
|
* @param aNetlist is the netlist of components to load the footprints into.
|
|
|
|
* @param aReporter is the #REPORTER object to report to.
|
|
|
|
* @throw IO_ERROR if an I/O error occurs or a #PARSE_ERROR if a file parsing error
|
|
|
|
* occurs while reading footprint library files.
|
|
|
|
*/
|
2018-09-17 09:54:49 +00:00
|
|
|
void LoadFootprints( NETLIST& aNetlist, REPORTER& aReporter );
|
2016-01-29 10:21:13 +00:00
|
|
|
|
2019-05-26 22:22:03 +00:00
|
|
|
void OnQuit( wxCommandEvent& event );
|
|
|
|
|
2019-12-19 15:34:01 +00:00
|
|
|
/**
|
|
|
|
* Get if the current board has been modified but not saved.
|
|
|
|
*
|
|
|
|
* @return true if the any changes have not been saved
|
|
|
|
*/
|
|
|
|
bool IsContentModified() override;
|
|
|
|
|
2017-01-28 17:47:11 +00:00
|
|
|
/**
|
|
|
|
* Reload the Python plugins if they are newer than
|
|
|
|
* the already loaded, and load new plugins if any
|
|
|
|
* Do nothing if KICAD_SCRIPTING is not defined
|
|
|
|
*/
|
|
|
|
void PythonPluginsReload();
|
|
|
|
|
2017-08-27 06:04:12 +00:00
|
|
|
/**
|
|
|
|
* Update the layer manager and other widgets from the board setup
|
|
|
|
* (layer and items visibility, colors ...)
|
|
|
|
*/
|
|
|
|
void UpdateUserInterface();
|
|
|
|
|
2014-01-08 14:18:51 +00:00
|
|
|
/**
|
|
|
|
* Execute a remote command send by Eeschema via a socket,
|
|
|
|
* port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242)
|
|
|
|
* this is a virtual function called by EDA_DRAW_FRAME::OnSockRequest().
|
|
|
|
* @param cmdline = received command from socket
|
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
void ExecuteRemoteCommand( const char* cmdline ) override;
|
2014-01-08 14:18:51 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void KiwayMailIn( KIWAY_EXPRESS& aEvent ) override;
|
2014-04-21 06:51:33 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function ToPlotter
|
2018-04-28 15:22:25 +00:00
|
|
|
* Open a dialog frame to create plot and drill files relative to the current board.
|
2010-01-01 13:30:39 +00:00
|
|
|
*/
|
2019-06-04 20:59:59 +00:00
|
|
|
void ToPlotter( int aID );
|
2010-01-01 13:30:39 +00:00
|
|
|
|
2011-08-26 17:01:17 +00:00
|
|
|
/**
|
|
|
|
* Function SVG_Print
|
2018-04-28 15:22:25 +00:00
|
|
|
* Shows the Export to SVG file dialog.
|
2011-08-26 17:01:17 +00:00
|
|
|
*/
|
2018-06-13 12:20:29 +00:00
|
|
|
void ExportSVG( wxCommandEvent& event );
|
2010-11-17 21:47:27 +00:00
|
|
|
|
2011-02-21 13:54:29 +00:00
|
|
|
// User interface update command event handlers.
|
2011-03-01 19:26:17 +00:00
|
|
|
void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent );
|
2019-05-14 19:21:10 +00:00
|
|
|
bool LayerManagerShown();
|
|
|
|
bool MicrowaveToolbarShown();
|
2011-03-01 19:26:17 +00:00
|
|
|
void OnUpdateSelectViaSize( wxUpdateUIEvent& aEvent );
|
|
|
|
void OnUpdateSelectTrackWidth( wxUpdateUIEvent& aEvent );
|
2014-07-09 09:59:23 +00:00
|
|
|
void OnLayerColorChange( wxCommandEvent& aEvent );
|
2019-07-08 23:43:08 +00:00
|
|
|
|
|
|
|
void RunEeschema();
|
2011-02-21 13:54:29 +00:00
|
|
|
|
2019-06-03 13:49:17 +00:00
|
|
|
void UpdateTrackWidthSelectBox( wxChoice* aTrackWidthSelectBox, bool aEdit = true );
|
|
|
|
void UpdateViaSizeSelectBox( wxChoice* aViaSizeSelectBox, bool aEdit = true );
|
2016-01-22 12:30:44 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function GetGridColor() , virtual
|
2010-02-01 21:23:27 +00:00
|
|
|
* @return the color of the grid
|
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
COLOR4D GetGridColor() override;
|
2010-02-01 21:23:27 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function SetGridColor() , virtual
|
2010-02-01 21:23:27 +00:00
|
|
|
* @param aColor = the new color of the grid
|
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
void SetGridColor( COLOR4D aColor ) override;
|
2015-07-28 08:30:06 +00:00
|
|
|
|
2008-01-01 11:58:14 +00:00
|
|
|
// Configurations:
|
2011-09-15 17:58:35 +00:00
|
|
|
void Process_Config( wxCommandEvent& event );
|
2009-11-23 20:18:47 +00:00
|
|
|
|
2018-08-15 09:26:32 +00:00
|
|
|
#if defined(KICAD_SCRIPTING) && defined(KICAD_SCRIPTING_ACTION_MENU)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function SetActionPluginSettings
|
|
|
|
* Set a set of plugins that have visible buttons on toolbar
|
|
|
|
* Plugins are identified by their module path
|
|
|
|
*/
|
|
|
|
void SetActionPluginSettings( const std::vector< std::pair<wxString, wxString> >& aPluginsWithButtons );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function GetActionPluginSettings
|
|
|
|
* Get a set of plugins that have visible buttons on toolbar
|
|
|
|
*/
|
|
|
|
std::vector< std::pair<wxString, wxString> > GetActionPluginSettings();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function GetActionPluginButtonVisible
|
|
|
|
* Returns true if button visibility action plugin setting was set to true
|
|
|
|
* or it is unset and plugin defaults to true.
|
|
|
|
*/
|
|
|
|
bool GetActionPluginButtonVisible( const wxString& aPluginPath, bool aPluginDefault );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function GetOrderedActionPlugins
|
|
|
|
* Returns ordered list of plugins in sequence in which they should appear on toolbar or in settings
|
|
|
|
*/
|
|
|
|
std::vector<ACTION_PLUGIN*> GetOrderedActionPlugins();
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
2011-09-26 20:32:56 +00:00
|
|
|
/**
|
|
|
|
* Function GetProjectFileParameters
|
++PCBNew
* Removed Pcb_Frame argument from BOARD() constructor, since it precludes
having a BOARD being edited by more than one editor, it was a bad design.
And this meant removing m_PcbFrame from BOARD.
* removed BOARD::SetWindowFrame(), and BOARD::m_PcbFrame
* Removed the global BOARD_DESIGN_SETTINGS which was in class_board.cpp
* added BOARD_DESIGN_SETTINGS to the BOARD class, a full instance
* a couple dialogs now only change BOARD_DESIGN_SETTINGS when OK is pressed,
such as dialog_mask_clearance, dialog_drc, etc.
* Removed common/pcbcommon.cpp's int g_CurrentVersionPCB = 1 and replaced it
with build_version.h's #define BOARD_FILE_VERSION, although there may be a
better place for this constant.
* Made the public functions in PARAM_CFG_ARRAY be type const.
void SaveParam(..) const and void ReadParam(..) const
* PARAM_CFG_BASE now has virtual destructor since we have various way of
destroying the derived class and boost::ptr_vector must be told about this.
* Pass const PARAM_CFG_ARRAY& instead of PARAM_CFG_ARRAY so that we can use
an automatic PARAM_CFG_ARRAY which is on the stack.\
* PCB_EDIT_FRAME::GetProjectFileParameters() may no longer cache the array,
since it has to access the current BOARD and the BOARD can change.
Remember BOARD_DESIGN_SETTINGS are now in the BOARD.
* Made the m_BoundingBox member private, this was a brutally hard task,
and indicative of the lack of commitment to accessors and object oriented
design on the part of KiCad developers. We must do better.
Added BOARD::GetBoundingBox, SetBoundingBox(), ComputeBoundingBox().
* Added PCB_BASE_FRAME::GetBoardBoundingBox() which calls BOARD::ComputeBoundingBox()
2011-12-05 06:15:33 +00:00
|
|
|
* returns a project file parameter list for Pcbnew.
|
2011-09-26 20:32:56 +00:00
|
|
|
* <p>
|
++PCBNew
* Removed Pcb_Frame argument from BOARD() constructor, since it precludes
having a BOARD being edited by more than one editor, it was a bad design.
And this meant removing m_PcbFrame from BOARD.
* removed BOARD::SetWindowFrame(), and BOARD::m_PcbFrame
* Removed the global BOARD_DESIGN_SETTINGS which was in class_board.cpp
* added BOARD_DESIGN_SETTINGS to the BOARD class, a full instance
* a couple dialogs now only change BOARD_DESIGN_SETTINGS when OK is pressed,
such as dialog_mask_clearance, dialog_drc, etc.
* Removed common/pcbcommon.cpp's int g_CurrentVersionPCB = 1 and replaced it
with build_version.h's #define BOARD_FILE_VERSION, although there may be a
better place for this constant.
* Made the public functions in PARAM_CFG_ARRAY be type const.
void SaveParam(..) const and void ReadParam(..) const
* PARAM_CFG_BASE now has virtual destructor since we have various way of
destroying the derived class and boost::ptr_vector must be told about this.
* Pass const PARAM_CFG_ARRAY& instead of PARAM_CFG_ARRAY so that we can use
an automatic PARAM_CFG_ARRAY which is on the stack.\
* PCB_EDIT_FRAME::GetProjectFileParameters() may no longer cache the array,
since it has to access the current BOARD and the BOARD can change.
Remember BOARD_DESIGN_SETTINGS are now in the BOARD.
* Made the m_BoundingBox member private, this was a brutally hard task,
and indicative of the lack of commitment to accessors and object oriented
design on the part of KiCad developers. We must do better.
Added BOARD::GetBoundingBox, SetBoundingBox(), ComputeBoundingBox().
* Added PCB_BASE_FRAME::GetBoardBoundingBox() which calls BOARD::ComputeBoundingBox()
2011-12-05 06:15:33 +00:00
|
|
|
* Populate a project file parameter array specific to Pcbnew.
|
2011-09-26 20:32:56 +00:00
|
|
|
* Creating the parameter list at run time has the advantage of being able
|
|
|
|
* to define local variables. The old method of statically building the array
|
|
|
|
* at compile time requiring global variable definitions by design.
|
|
|
|
* </p>
|
++PCBNew
* Removed Pcb_Frame argument from BOARD() constructor, since it precludes
having a BOARD being edited by more than one editor, it was a bad design.
And this meant removing m_PcbFrame from BOARD.
* removed BOARD::SetWindowFrame(), and BOARD::m_PcbFrame
* Removed the global BOARD_DESIGN_SETTINGS which was in class_board.cpp
* added BOARD_DESIGN_SETTINGS to the BOARD class, a full instance
* a couple dialogs now only change BOARD_DESIGN_SETTINGS when OK is pressed,
such as dialog_mask_clearance, dialog_drc, etc.
* Removed common/pcbcommon.cpp's int g_CurrentVersionPCB = 1 and replaced it
with build_version.h's #define BOARD_FILE_VERSION, although there may be a
better place for this constant.
* Made the public functions in PARAM_CFG_ARRAY be type const.
void SaveParam(..) const and void ReadParam(..) const
* PARAM_CFG_BASE now has virtual destructor since we have various way of
destroying the derived class and boost::ptr_vector must be told about this.
* Pass const PARAM_CFG_ARRAY& instead of PARAM_CFG_ARRAY so that we can use
an automatic PARAM_CFG_ARRAY which is on the stack.\
* PCB_EDIT_FRAME::GetProjectFileParameters() may no longer cache the array,
since it has to access the current BOARD and the BOARD can change.
Remember BOARD_DESIGN_SETTINGS are now in the BOARD.
* Made the m_BoundingBox member private, this was a brutally hard task,
and indicative of the lack of commitment to accessors and object oriented
design on the part of KiCad developers. We must do better.
Added BOARD::GetBoundingBox, SetBoundingBox(), ComputeBoundingBox().
* Added PCB_BASE_FRAME::GetBoardBoundingBox() which calls BOARD::ComputeBoundingBox()
2011-12-05 06:15:33 +00:00
|
|
|
* @return PARAM_CFG_ARRAY - it is only good until SetBoard() is called, so
|
|
|
|
* don't keep it around past that event.
|
2011-09-26 20:32:56 +00:00
|
|
|
*/
|
2019-03-06 13:01:40 +00:00
|
|
|
PARAM_CFG_ARRAY& GetProjectFileParameters();
|
2011-09-26 20:32:56 +00:00
|
|
|
|
2013-07-19 18:27:22 +00:00
|
|
|
/**
|
|
|
|
* Function SaveProjectSettings
|
|
|
|
* saves changes to the project settings to the project (.pro) file.
|
|
|
|
* @param aAskForSave = true to open a dialog before saving the settings
|
|
|
|
*/
|
2016-09-24 18:53:15 +00:00
|
|
|
void SaveProjectSettings( bool aAskForSave ) override;
|
2010-04-23 14:46:00 +00:00
|
|
|
|
|
|
|
/**
|
Modular KiCad Blueprint Milestone B), major portions:
*) When kicad.exe closes a project, close any open KIFACEs so that they cannot
get disassociated from their true PROJECT.
*) Allow loading eeschema library editor from kicad.exe
*) Allow loading pcbnew library editor from kicad.exe
*) Rename LIB_COMPONENT to LIB_PART.
*) Add class PART_LIBS, and PART_LIB.
*) Make PART_LIBS non-global, i.e. PROJECT specific.
*) Implement "data on demand" for PART_LIBS
*) Implement "data on demand" for schematic SEARCH_STACK.
*) Use RSTRINGs to retain eeschema editor's notion of last library and part being edited.
*) Get rid of library search on every SCH_COMPONENT::Draw() call, instead use
a weak pointer.
*) Remove all chdir() calls so projects don't need to be CWD.
*) Romove APPEND support from OpenProjectFiles().
*) Make OpenProjectFiles() robust, even for creating new projects.
*) Load EESCHEMA colors in the KIWAY::OnKiwayStart() rather in window open,
and save them in the .eeschema config file, not in the project file.
*) Fix bug with wxDir() while accessing protected dirs in kicad.exe
*) Consolidate template copying into PROJECT class, not in kicad.exe source.
*) Generally untangle eeschema, making its libraries not global but rather
held in the PROJECT.
2014-08-13 20:28:54 +00:00
|
|
|
* Load the current project's file configuration settings which are pertinent
|
|
|
|
* to this PCB_EDIT_FRAME instance.
|
2010-04-23 14:46:00 +00:00
|
|
|
*
|
|
|
|
* @return always returns true.
|
|
|
|
*/
|
Modular KiCad Blueprint Milestone B), major portions:
*) When kicad.exe closes a project, close any open KIFACEs so that they cannot
get disassociated from their true PROJECT.
*) Allow loading eeschema library editor from kicad.exe
*) Allow loading pcbnew library editor from kicad.exe
*) Rename LIB_COMPONENT to LIB_PART.
*) Add class PART_LIBS, and PART_LIB.
*) Make PART_LIBS non-global, i.e. PROJECT specific.
*) Implement "data on demand" for PART_LIBS
*) Implement "data on demand" for schematic SEARCH_STACK.
*) Use RSTRINGs to retain eeschema editor's notion of last library and part being edited.
*) Get rid of library search on every SCH_COMPONENT::Draw() call, instead use
a weak pointer.
*) Remove all chdir() calls so projects don't need to be CWD.
*) Romove APPEND support from OpenProjectFiles().
*) Make OpenProjectFiles() robust, even for creating new projects.
*) Load EESCHEMA colors in the KIWAY::OnKiwayStart() rather in window open,
and save them in the .eeschema config file, not in the project file.
*) Fix bug with wxDir() while accessing protected dirs in kicad.exe
*) Consolidate template copying into PROJECT class, not in kicad.exe source.
*) Generally untangle eeschema, making its libraries not global but rather
held in the PROJECT.
2014-08-13 20:28:54 +00:00
|
|
|
bool LoadProjectSettings();
|
2010-04-23 14:46:00 +00:00
|
|
|
|
|
|
|
/**
|
2011-09-26 20:32:56 +00:00
|
|
|
* Function GetConfigurationSettings
|
2011-09-30 18:15:37 +00:00
|
|
|
* returns the Pcbnew applications settings list.
|
2011-09-26 20:32:56 +00:00
|
|
|
*
|
++PCBNew
* Removed Pcb_Frame argument from BOARD() constructor, since it precludes
having a BOARD being edited by more than one editor, it was a bad design.
And this meant removing m_PcbFrame from BOARD.
* removed BOARD::SetWindowFrame(), and BOARD::m_PcbFrame
* Removed the global BOARD_DESIGN_SETTINGS which was in class_board.cpp
* added BOARD_DESIGN_SETTINGS to the BOARD class, a full instance
* a couple dialogs now only change BOARD_DESIGN_SETTINGS when OK is pressed,
such as dialog_mask_clearance, dialog_drc, etc.
* Removed common/pcbcommon.cpp's int g_CurrentVersionPCB = 1 and replaced it
with build_version.h's #define BOARD_FILE_VERSION, although there may be a
better place for this constant.
* Made the public functions in PARAM_CFG_ARRAY be type const.
void SaveParam(..) const and void ReadParam(..) const
* PARAM_CFG_BASE now has virtual destructor since we have various way of
destroying the derived class and boost::ptr_vector must be told about this.
* Pass const PARAM_CFG_ARRAY& instead of PARAM_CFG_ARRAY so that we can use
an automatic PARAM_CFG_ARRAY which is on the stack.\
* PCB_EDIT_FRAME::GetProjectFileParameters() may no longer cache the array,
since it has to access the current BOARD and the BOARD can change.
Remember BOARD_DESIGN_SETTINGS are now in the BOARD.
* Made the m_BoundingBox member private, this was a brutally hard task,
and indicative of the lack of commitment to accessors and object oriented
design on the part of KiCad developers. We must do better.
Added BOARD::GetBoundingBox, SetBoundingBox(), ComputeBoundingBox().
* Added PCB_BASE_FRAME::GetBoardBoundingBox() which calls BOARD::ComputeBoundingBox()
2011-12-05 06:15:33 +00:00
|
|
|
* This replaces the old statically defined list that had the project
|
2011-09-26 20:32:56 +00:00
|
|
|
* file settings and the application settings mixed together. This
|
|
|
|
* was confusing and caused some settings to get saved and loaded
|
|
|
|
* incorrectly. Currently, only the settings that are needed at start
|
|
|
|
* up by the main window are defined here. There are other locally used
|
++PCBNew
* Removed Pcb_Frame argument from BOARD() constructor, since it precludes
having a BOARD being edited by more than one editor, it was a bad design.
And this meant removing m_PcbFrame from BOARD.
* removed BOARD::SetWindowFrame(), and BOARD::m_PcbFrame
* Removed the global BOARD_DESIGN_SETTINGS which was in class_board.cpp
* added BOARD_DESIGN_SETTINGS to the BOARD class, a full instance
* a couple dialogs now only change BOARD_DESIGN_SETTINGS when OK is pressed,
such as dialog_mask_clearance, dialog_drc, etc.
* Removed common/pcbcommon.cpp's int g_CurrentVersionPCB = 1 and replaced it
with build_version.h's #define BOARD_FILE_VERSION, although there may be a
better place for this constant.
* Made the public functions in PARAM_CFG_ARRAY be type const.
void SaveParam(..) const and void ReadParam(..) const
* PARAM_CFG_BASE now has virtual destructor since we have various way of
destroying the derived class and boost::ptr_vector must be told about this.
* Pass const PARAM_CFG_ARRAY& instead of PARAM_CFG_ARRAY so that we can use
an automatic PARAM_CFG_ARRAY which is on the stack.\
* PCB_EDIT_FRAME::GetProjectFileParameters() may no longer cache the array,
since it has to access the current BOARD and the BOARD can change.
Remember BOARD_DESIGN_SETTINGS are now in the BOARD.
* Made the m_BoundingBox member private, this was a brutally hard task,
and indicative of the lack of commitment to accessors and object oriented
design on the part of KiCad developers. We must do better.
Added BOARD::GetBoundingBox, SetBoundingBox(), ComputeBoundingBox().
* Added PCB_BASE_FRAME::GetBoardBoundingBox() which calls BOARD::ComputeBoundingBox()
2011-12-05 06:15:33 +00:00
|
|
|
* settings that are scattered throughout the Pcbnew source code. If you need
|
|
|
|
* to define a configuration setting that needs to be loaded at run time,
|
2011-09-26 20:32:56 +00:00
|
|
|
* this is the place to define it.
|
2010-04-23 14:46:00 +00:00
|
|
|
*
|
|
|
|
* @return - Reference to the list of applications settings.
|
|
|
|
*/
|
|
|
|
PARAM_CFG_ARRAY& GetConfigurationSettings();
|
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void LoadSettings( wxConfigBase* aCfg ) override;
|
2010-04-23 14:46:00 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void SaveSettings( wxConfigBase* aCfg ) override;
|
2010-04-23 14:46:00 +00:00
|
|
|
|
2015-07-02 14:11:15 +00:00
|
|
|
wxConfigBase* GetSettings() { return config(); };
|
2015-07-02 14:09:51 +00:00
|
|
|
|
2010-04-23 14:46:00 +00:00
|
|
|
/**
|
2019-08-03 03:03:03 +00:00
|
|
|
* Get the last path for a particular type.
|
|
|
|
* @return - Absolute path and file name of the last file successfully read.
|
2009-10-21 19:16:25 +00:00
|
|
|
*/
|
2019-08-03 03:03:03 +00:00
|
|
|
wxString GetLastPath( LAST_PATH_TYPE aType );
|
2010-04-23 14:46:00 +00:00
|
|
|
|
|
|
|
/**
|
2019-08-03 03:03:03 +00:00
|
|
|
* Set the path of the last file successfully read.
|
2010-04-23 14:46:00 +00:00
|
|
|
*
|
|
|
|
* Note: the file path is converted to a path relative to the project file path. If
|
|
|
|
* the path cannot be made relative, than m_lastNetListRead is set to and empty
|
|
|
|
* string. This could happen when the net list file is on a different drive than
|
|
|
|
* the project file. The advantage of relative paths is that is more likely to
|
|
|
|
* work when opening the same project from both Windows and Linux.
|
|
|
|
*
|
2019-08-03 03:03:03 +00:00
|
|
|
* @param aLastPath - The last file with full path successfully read.
|
2010-04-23 14:46:00 +00:00
|
|
|
*/
|
2019-08-03 03:03:03 +00:00
|
|
|
void SetLastPath( LAST_PATH_TYPE aType, const wxString& aLastPath );
|
2009-10-21 19:16:25 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void OnCloseWindow( wxCloseEvent& Event ) override;
|
2011-09-15 17:58:35 +00:00
|
|
|
void Process_Special_Functions( wxCommandEvent& event );
|
|
|
|
void Tracks_and_Vias_Size_Event( wxCommandEvent& event );
|
2009-01-15 08:12:03 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void ReCreateHToolbar() override;
|
|
|
|
void ReCreateAuxiliaryToolbar() override;
|
|
|
|
void ReCreateVToolbar() override;
|
2011-09-15 17:58:35 +00:00
|
|
|
void ReCreateMicrowaveVToolbar();
|
2018-02-03 22:55:13 +00:00
|
|
|
void ReCreateOptToolbar() override;
|
2016-09-24 18:53:15 +00:00
|
|
|
void ReCreateMenuBar() override;
|
2013-09-02 15:26:52 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Re create the layer Box by clearing the old list, and building
|
|
|
|
* le new one, from the new layers names and cole layers
|
|
|
|
* @param aForceResizeToolbar = true to resize the parent toolbar
|
|
|
|
* false if not needed (mainly in parent toolbar creation,
|
|
|
|
* or when the layers names are not modified)
|
|
|
|
*/
|
|
|
|
void ReCreateLayerBox( bool aForceResizeToolbar = true );
|
2008-04-29 13:35:26 +00:00
|
|
|
|
2014-09-28 14:44:47 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function SetCurrentNetClass
|
|
|
|
* Must be called after a netclass selection (or after a netclass parameter change
|
|
|
|
* calls BOARD_DESIGN_SETTINGS::SetCurrentNetClass() and update trace width and via size
|
|
|
|
* combo boxes on main toolbar
|
|
|
|
* Initialize vias and tracks values displayed in comb boxes of the auxiliary toolbar
|
|
|
|
* and some others parameters (netclass name ....)
|
|
|
|
* @param aNetClassName = the new netclass name
|
|
|
|
* @return true if lists of tracks and vias sizes are modified
|
|
|
|
*/
|
|
|
|
bool SetCurrentNetClass( const wxString& aNetClassName );
|
|
|
|
|
2011-08-26 17:01:17 +00:00
|
|
|
/**
|
|
|
|
* Function OnModify
|
|
|
|
* must be called after a board change to set the modified flag.
|
|
|
|
* <p>
|
|
|
|
* Reloads the 3D view if required and calls the base PCB_BASE_FRAME::OnModify function
|
|
|
|
* to update auxiliary information.
|
2011-09-15 17:58:35 +00:00
|
|
|
* </p>
|
2010-05-01 12:46:33 +00:00
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
void OnModify() override;
|
2010-05-01 12:46:33 +00:00
|
|
|
|
2014-03-21 10:17:47 +00:00
|
|
|
/**
|
|
|
|
* Function SetActiveLayer
|
|
|
|
* will change the currently active layer to \a aLayer and also
|
|
|
|
* update the PCB_LAYER_WIDGET.
|
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
void SetActiveLayer( PCB_LAYER_ID aLayer ) override;
|
2014-03-21 10:17:47 +00:00
|
|
|
|
2018-03-16 02:42:38 +00:00
|
|
|
PCB_LAYER_WIDGET* GetLayerManager() { return m_Layers; }
|
|
|
|
|
2018-02-21 16:29:24 +00:00
|
|
|
/**
|
|
|
|
* Update the UI to reflect changes to the current layer's transparency.
|
|
|
|
*/
|
|
|
|
void OnUpdateLayerAlpha( wxUpdateUIEvent& aEvent ) override;
|
|
|
|
|
2010-01-21 20:53:01 +00:00
|
|
|
/**
|
2010-01-30 20:17:56 +00:00
|
|
|
* Function IsElementVisible
|
|
|
|
* tests whether a given element category is visible. Keep this as an
|
|
|
|
* inline function.
|
2011-09-20 13:57:40 +00:00
|
|
|
* @param aElement is from the enum by the same name
|
2010-01-30 20:17:56 +00:00
|
|
|
* @return bool - true if the element is visible.
|
2017-03-13 03:19:33 +00:00
|
|
|
* @see enum GAL_LAYER_ID
|
2010-01-30 20:17:56 +00:00
|
|
|
*/
|
2017-03-13 03:19:33 +00:00
|
|
|
bool IsElementVisible( GAL_LAYER_ID aElement ) const;
|
2010-01-30 20:17:56 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function SetElementVisibility
|
|
|
|
* changes the visibility of an element category
|
2011-09-20 13:57:40 +00:00
|
|
|
* @param aElement is from the enum by the same name
|
2017-06-16 00:31:42 +00:00
|
|
|
* @param aNewState The new visibility state of the element category
|
|
|
|
* @see enum PCB_LAYER_ID
|
2010-01-30 20:17:56 +00:00
|
|
|
*/
|
2017-03-13 03:19:33 +00:00
|
|
|
void SetElementVisibility( GAL_LAYER_ID aElement, bool aNewState );
|
2010-01-30 20:17:56 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function SetVisibleAlls
|
|
|
|
* Set the status of all visible element categories and layers to VISIBLE
|
|
|
|
*/
|
2011-08-26 17:01:17 +00:00
|
|
|
void SetVisibleAlls();
|
2010-01-30 20:17:56 +00:00
|
|
|
|
|
|
|
/**
|
2010-01-21 20:53:01 +00:00
|
|
|
* Function ReFillLayerWidget
|
|
|
|
* changes out all the layers in m_Layers and may be called upon
|
|
|
|
* loading a new BOARD.
|
|
|
|
*/
|
2011-09-15 17:58:35 +00:00
|
|
|
void ReFillLayerWidget();
|
2010-01-21 20:53:01 +00:00
|
|
|
|
2015-08-07 17:15:36 +00:00
|
|
|
///> @copydoc EDA_DRAW_FRAME::UseGalCanvas()
|
2019-05-30 12:25:08 +00:00
|
|
|
void ActivateGalCanvas() override;
|
2013-11-25 15:50:03 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2018-04-28 15:22:25 +00:00
|
|
|
* Function ShowBoardSetupDialog
|
2009-07-18 11:44:19 +00:00
|
|
|
*/
|
2018-11-17 00:33:20 +00:00
|
|
|
void DoShowBoardSetupDialog( const wxString& aInitialPage = wxEmptyString,
|
|
|
|
const wxString& aInitialParentPage = wxEmptyString );
|
2009-07-18 11:44:19 +00:00
|
|
|
|
2009-09-27 11:00:21 +00:00
|
|
|
/* toolbars update UI functions: */
|
2009-11-23 20:18:47 +00:00
|
|
|
|
2019-07-28 22:39:24 +00:00
|
|
|
void PrepareLayerIndicator( bool aForceRebuild = false );
|
2009-09-27 11:00:21 +00:00
|
|
|
|
2019-06-04 21:29:51 +00:00
|
|
|
void ToggleLayersManager();
|
|
|
|
void ToggleMicrowaveToolbar();
|
2012-02-15 10:41:16 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function DoGenFootprintsPositionFile
|
|
|
|
* Creates an ascii footprint position file
|
2012-03-17 14:39:27 +00:00
|
|
|
* @param aFullFileName = the full file name of the file to create
|
2012-02-15 10:41:16 +00:00
|
|
|
* @param aUnitsMM = false to use inches, true to use mm in coordinates
|
|
|
|
* @param aForceSmdItems = true to force all footprints with smd pads in list
|
|
|
|
* = false to put only footprints with option "INSERT" in list
|
2019-06-30 11:54:35 +00:00
|
|
|
* @param aTopSide true to list footprints on front (top) side,
|
|
|
|
* @param BottomSide true to list footprints on back (bottom) side,
|
|
|
|
* if aTopSide and aTopSide are true, list footprints on both sides
|
2016-04-26 12:16:16 +00:00
|
|
|
* @param aFormatCSV = true to use a comma separated file (CSV) format; defautl = false
|
2012-02-15 10:41:16 +00:00
|
|
|
* @return the number of footprints found on aSide side,
|
|
|
|
* or -1 if the file could not be created
|
|
|
|
*/
|
|
|
|
int DoGenFootprintsPositionFile( const wxString& aFullFileName, bool aUnitsMM,
|
2019-06-30 11:54:35 +00:00
|
|
|
bool aForceSmdItems, bool aTopSide, bool BottomSide, bool aFormatCSV = false );
|
2012-02-15 10:41:16 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function GenFootprintsReport
|
|
|
|
* Calls DoGenFootprintsReport to create a footprint reprot file
|
|
|
|
* See DoGenFootprintsReport for file format
|
|
|
|
*/
|
|
|
|
void GenFootprintsReport( wxCommandEvent& event );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function DoGenFootprintsReport
|
|
|
|
* Creates an ascii footprint report file giving some infos on footprints
|
|
|
|
* and board outlines
|
|
|
|
* @param aFullFilename = the full file name of the file to create
|
|
|
|
* @param aUnitsMM = false to use inches, true to use mm in coordinates
|
|
|
|
* @return true if OK, false if error
|
|
|
|
*/
|
|
|
|
bool DoGenFootprintsReport( const wxString& aFullFilename, bool aUnitsMM );
|
|
|
|
|
2013-09-13 09:49:55 +00:00
|
|
|
void GenD356File( wxCommandEvent& event );
|
2009-01-15 08:12:03 +00:00
|
|
|
|
2009-11-23 20:18:47 +00:00
|
|
|
void OnFileHistory( wxCommandEvent& event );
|
2011-08-26 17:01:17 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Function Files_io
|
2015-03-17 07:34:02 +00:00
|
|
|
* @param event is the command event handler.
|
|
|
|
* do nothing else than call Files_io_from_id with the
|
|
|
|
* wxCommandEvent id
|
2011-08-26 17:01:17 +00:00
|
|
|
*/
|
2009-11-23 20:18:47 +00:00
|
|
|
void Files_io( wxCommandEvent& event );
|
2010-05-17 20:35:46 +00:00
|
|
|
|
2015-03-17 07:34:02 +00:00
|
|
|
/**
|
|
|
|
* Function Files_io_from_id
|
|
|
|
* Read and write board files
|
|
|
|
* @param aId is an event ID ciming from file command events:
|
|
|
|
* ID_LOAD_FILE
|
|
|
|
* ID_MENU_READ_BOARD_BACKUP_FILE
|
|
|
|
* ID_MENU_RECOVER_BOARD_AUTOSAVE
|
|
|
|
* ID_NEW_BOARD
|
|
|
|
* ID_SAVE_BOARD
|
|
|
|
* ID_COPY_BOARD_AS
|
|
|
|
* ID_SAVE_BOARD_AS
|
|
|
|
* Files_io_from_id prepare parameters and calls the specialized function
|
|
|
|
*/
|
2018-08-11 20:46:03 +00:00
|
|
|
bool Files_io_from_id( int aId );
|
2015-03-17 07:34:02 +00:00
|
|
|
|
2010-11-12 15:17:10 +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 OpenProjectFiles (was LoadOnePcbFile)
|
|
|
|
* loads a KiCad board (.kicad_pcb) from \a aFileName.
|
2010-05-17 20:35:46 +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
|
|
|
* @param aFileSet - hold the BOARD file to load, a vector of one element.
|
2010-05-17 20:35:46 +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
|
|
|
* @param aCtl - KICTL_ bits, one to indicate that an append of the board file
|
|
|
|
* aFileName to the currently loaded file is desired.
|
|
|
|
* @see #KIWAY_PLAYER for bit defines.
|
|
|
|
*
|
|
|
|
* @return bool - false if file load fails, otherwise true.
|
2010-05-30 09:46:37 +00:00
|
|
|
bool LoadOnePcbFile( const wxString& aFileName, bool aAppend = false,
|
2010-05-17 20:35:46 +00:00
|
|
|
bool aForceFileDialog = false );
|
* 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
|
|
|
*/
|
2016-09-24 18:53:15 +00:00
|
|
|
bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl = 0 ) override;
|
2010-01-21 07:41:30 +00:00
|
|
|
|
2011-08-26 17:01:17 +00:00
|
|
|
/**
|
|
|
|
* Function SavePcbFile
|
|
|
|
* writes the board data structures to \a a aFileName
|
2015-02-14 12:43:11 +00:00
|
|
|
* Creates backup when requested and update flags (modified and saved flgs)
|
2011-08-26 17:01:17 +00:00
|
|
|
*
|
|
|
|
* @param aFileName The file name to write or wxEmptyString to prompt user for
|
|
|
|
* file name.
|
2011-10-13 19:56:32 +00:00
|
|
|
* @param aCreateBackupFile Creates a back of \a aFileName if true. Helper
|
|
|
|
* definitions #CREATE_BACKUP_FILE and #NO_BACKUP_FILE
|
|
|
|
* are defined for improved code readability.
|
2011-08-26 17:01:17 +00:00
|
|
|
* @return True if file was saved successfully.
|
|
|
|
*/
|
2011-10-13 19:56:32 +00:00
|
|
|
bool SavePcbFile( const wxString& aFileName, bool aCreateBackupFile = CREATE_BACKUP_FILE );
|
2011-08-26 17:01:17 +00:00
|
|
|
|
2015-02-14 12:43:11 +00:00
|
|
|
/**
|
|
|
|
* Function SavePcbCopy
|
|
|
|
* writes the board data structures to \a a aFileName
|
|
|
|
* but unlike SavePcbFile, does not make anything else
|
|
|
|
* (no backup, borad fliename change, no flag changes ...)
|
|
|
|
* Used under a project mgr to save under a new name the current board
|
|
|
|
*
|
|
|
|
* When not under a project mgr, the full SavePcbFile is used.
|
|
|
|
* @param aFileName The file name to write.
|
|
|
|
* @return True if file was saved successfully.
|
|
|
|
*/
|
|
|
|
bool SavePcbCopy( const wxString& aFileName );
|
2009-03-30 15:36:41 +00:00
|
|
|
|
2009-08-06 15:42:09 +00:00
|
|
|
// BOARD handling
|
2009-11-23 20:18:47 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2010-11-12 16:59:16 +00:00
|
|
|
* Function Clear_Pcb
|
2009-08-06 15:42:09 +00:00
|
|
|
* delete all and reinitialize the current board
|
2011-02-21 13:54:29 +00:00
|
|
|
* @param aQuery = true to prompt user for confirmation, false to initialize silently
|
2019-06-02 02:27:17 +00:00
|
|
|
* @param aFinal = if true, we are clearing the board to exit, so don't run more events
|
2009-08-06 15:42:09 +00:00
|
|
|
*/
|
2019-06-02 02:27:17 +00:00
|
|
|
bool Clear_Pcb( bool aQuery, bool aFinal = false );
|
2009-09-22 12:27:57 +00:00
|
|
|
|
2014-09-08 12:06:38 +00:00
|
|
|
///> @copydoc PCB_BASE_FRAME::SetBoard()
|
2016-09-24 18:53:15 +00:00
|
|
|
void SetBoard( BOARD* aBoard ) override;
|
2013-11-25 15:50:03 +00:00
|
|
|
|
2016-05-13 15:31:54 +00:00
|
|
|
///> @copydoc PCB_BASE_EDIT_FRAME::GetModel()
|
|
|
|
BOARD_ITEM_CONTAINER* GetModel() const override;
|
|
|
|
|
2014-09-08 12:06:38 +00:00
|
|
|
///> @copydoc PCB_BASE_FRAME::SetPageSettings()
|
2016-09-24 18:53:15 +00:00
|
|
|
void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
|
2014-09-08 12:06:38 +00:00
|
|
|
|
2009-03-30 15:36:41 +00:00
|
|
|
/**
|
|
|
|
* Function RecreateBOMFileFromBoard
|
|
|
|
* Recreates a .cmp file from the current loaded board
|
2011-09-30 18:15:37 +00:00
|
|
|
* this is the same as created by CvPcb.
|
2009-03-30 15:36:41 +00:00
|
|
|
* can be used if this file is lost
|
|
|
|
*/
|
2011-09-15 17:58:35 +00:00
|
|
|
void RecreateCmpFileFromBoard( wxCommandEvent& aEvent );
|
2009-03-30 15:36:41 +00:00
|
|
|
|
2012-01-06 19:00:59 +00:00
|
|
|
/**
|
|
|
|
* Function ArchiveModulesOnBoard
|
|
|
|
* Save modules in a library:
|
2015-09-28 08:46:00 +00:00
|
|
|
* @param aStoreInNewLib:
|
|
|
|
* true : save modules in a existing lib. Existing footprints will be kept
|
|
|
|
* or updated.
|
|
|
|
* This lib should be in fp lib table, and is type is .pretty
|
|
|
|
* false: save modules in a new lib. It it is an existing lib,
|
|
|
|
* previous footprints will be removed
|
2017-08-26 12:04:56 +00:00
|
|
|
*
|
|
|
|
* @param aLibName:
|
|
|
|
* optional library name to create, stops dialog call.
|
|
|
|
* must be called with aStoreInNewLib as true
|
2015-09-28 08:46:00 +00:00
|
|
|
*/
|
2018-04-28 15:22:25 +00:00
|
|
|
void ArchiveModulesOnBoard( bool aStoreInNewLib, const wxString& aLibName = wxEmptyString,
|
|
|
|
wxString* aLibPath = NULL );
|
2012-01-06 19:00:59 +00:00
|
|
|
|
2009-03-30 15:36:41 +00:00
|
|
|
/**
|
|
|
|
* Function RecreateBOMFileFromBoard
|
|
|
|
* Creates a BOM file from the current loaded board
|
|
|
|
*/
|
2011-09-15 17:58:35 +00:00
|
|
|
void RecreateBOMFileFromBoard( wxCommandEvent& aEvent );
|
2009-01-15 08:12:03 +00:00
|
|
|
|
2011-11-10 15:55:05 +00:00
|
|
|
/**
|
|
|
|
* Function ExportToGenCAD
|
|
|
|
* creates a file in GenCAD 1.4 format from the current board.
|
|
|
|
*/
|
2011-09-15 17:58:35 +00:00
|
|
|
void ExportToGenCAD( wxCommandEvent& event );
|
2008-03-04 04:22:27 +00:00
|
|
|
|
2010-04-19 06:21:56 +00:00
|
|
|
/**
|
|
|
|
* Function OnExportVRML
|
|
|
|
* will export the current BOARD to a VRML file.
|
|
|
|
*/
|
|
|
|
void OnExportVRML( wxCommandEvent& event );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function ExportVRML_File
|
|
|
|
* Creates the file(s) exporting current BOARD to a VRML file.
|
2013-03-28 16:51:22 +00:00
|
|
|
*
|
|
|
|
* @note When copying 3D shapes files, the new filename is build from the full path
|
|
|
|
* name, changing the separators by underscore. This is needed because files
|
|
|
|
* with the same shortname can exist in different directories
|
|
|
|
* @note ExportVRML_File generates coordinates in board units (BIU) inside the file.
|
|
|
|
* @todo Use mm inside the file. A general scale transform is applied to the whole
|
|
|
|
* file (1.0 to have the actual WRML unit im mm, 0.001 to have the actual WRML
|
|
|
|
* unit in meters.
|
2014-12-20 16:13:51 +00:00
|
|
|
* @note For 3D models built by a 3D modeler, the unit is 0,1 inches. A specific scale
|
2013-03-28 16:51:22 +00:00
|
|
|
* is applied to 3D models to convert them to internal units.
|
|
|
|
*
|
2010-04-19 06:21:56 +00:00
|
|
|
* @param aFullFileName = the full filename of the file to create
|
2013-01-13 16:55:07 +00:00
|
|
|
* @param aMMtoWRMLunit = the VRML scaling factor:
|
|
|
|
* 1.0 to export in mm. 0.001 for meters
|
2010-04-19 06:21:56 +00:00
|
|
|
* @param aExport3DFiles = true to copy 3D shapes in the subir a3D_Subdir
|
2014-10-17 23:28:12 +00:00
|
|
|
* @param aUseRelativePaths set to true to use relative paths instead of absolute paths
|
|
|
|
* in the board VRML file URLs.
|
2014-12-20 16:13:51 +00:00
|
|
|
* @param aUsePlainPCB set to true to export a board with no copper or silkskreen;
|
|
|
|
* this is useful for generating a VRML file which can be
|
|
|
|
* converted to a STEP model.
|
2014-10-17 23:28:12 +00:00
|
|
|
* @param a3D_Subdir = sub directory where 3D shapes files are copied. This is only used
|
|
|
|
* when aExport3DFiles == true
|
2015-08-13 13:13:34 +00:00
|
|
|
* @param aXRef = X value of PCB (0,0) reference point
|
|
|
|
* @param aYRef = Y value of PCB (0,0) reference point
|
2010-04-19 06:21:56 +00:00
|
|
|
* @return true if Ok.
|
|
|
|
*/
|
2013-01-13 16:55:07 +00:00
|
|
|
bool ExportVRML_File( const wxString & aFullFileName, double aMMtoWRMLunit,
|
2019-05-27 16:16:54 +00:00
|
|
|
bool aExport3DFiles, bool aUseRelativePaths, bool aUsePlainPCB,
|
|
|
|
const wxString & a3D_Subdir, double aXRef, double aYRef );
|
2010-04-19 06:21:56 +00:00
|
|
|
|
2014-01-02 09:26:03 +00:00
|
|
|
/**
|
2016-07-19 17:35:25 +00:00
|
|
|
* Function OnExportIDF3
|
2014-01-02 09:26:03 +00:00
|
|
|
* will export the current BOARD to a IDFv3 board and lib files.
|
|
|
|
*/
|
2016-07-19 17:35:25 +00:00
|
|
|
void OnExportIDF3( wxCommandEvent& event );
|
|
|
|
|
2019-04-08 00:09:07 +00:00
|
|
|
/**
|
|
|
|
* Function OnExportHyperlynx
|
|
|
|
* will export the current BOARD to a Hyperlynx HYP file.
|
|
|
|
*/
|
|
|
|
void OnExportHyperlynx( wxCommandEvent& event );
|
|
|
|
|
2016-07-19 17:35:25 +00:00
|
|
|
/**
|
|
|
|
* Function Export_IDF3
|
|
|
|
* Creates an IDF3 compliant BOARD (*.emn) and LIBRARY (*.emp) file.
|
|
|
|
*
|
|
|
|
* @param aPcb = a pointer to the board to be exported to IDF
|
|
|
|
* @param aFullFileName = the full filename of the export file
|
|
|
|
* @param aUseThou = set to true if the desired IDF unit is thou (mil)
|
|
|
|
* @param aXRef = the board Reference Point in mm, X value
|
|
|
|
* @param aYRef = the board Reference Point in mm, Y value
|
|
|
|
* @return true if OK
|
|
|
|
*/
|
|
|
|
bool Export_IDF3( BOARD* aPcb, const wxString& aFullFileName,
|
|
|
|
bool aUseThou, double aXRef, double aYRef );
|
2014-01-02 09:26:03 +00:00
|
|
|
|
2016-09-19 07:40:36 +00:00
|
|
|
/**
|
|
|
|
* Function OnExportSTEP
|
|
|
|
* Exports the current BOARD to a STEP assembly.
|
|
|
|
*/
|
|
|
|
void OnExportSTEP( wxCommandEvent& event );
|
|
|
|
|
2014-03-27 17:45:05 +00:00
|
|
|
/**
|
|
|
|
* Function ExportSpecctraFile
|
|
|
|
* will export the current BOARD to a specctra dsn file.
|
2008-01-21 22:16:45 +00:00
|
|
|
* See http://www.autotraxeda.com/docs/SPECCTRA/SPECCTRA.pdf for the
|
|
|
|
* specification.
|
2014-03-27 17:45:05 +00:00
|
|
|
* @return true if OK
|
2008-01-21 22:16:45 +00:00
|
|
|
*/
|
2014-03-27 17:45:05 +00:00
|
|
|
bool ExportSpecctraFile( const wxString& aFullFilename );
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2019-04-15 22:54:47 +00:00
|
|
|
/**
|
|
|
|
* Function ImportSpecctraSession
|
|
|
|
* will import a specctra *.ses file and use it to relocate MODULEs and
|
|
|
|
* to replace all vias and tracks in an existing and loaded BOARD.
|
|
|
|
* See http://www.autotraxeda.com/docs/SPECCTRA/SPECCTRA.pdf for the
|
|
|
|
* specification.
|
|
|
|
*/
|
|
|
|
bool ImportSpecctraSession( const wxString& aFullFilename );
|
|
|
|
|
2018-06-22 13:05:11 +00:00
|
|
|
// Footprint editing (see also PCB_BASE_FRAME)
|
2019-05-28 23:23:58 +00:00
|
|
|
void InstallFootprintPropertiesDialog( MODULE* Module );
|
2012-09-11 07:33:17 +00:00
|
|
|
|
2018-10-22 15:01:29 +00:00
|
|
|
int InstallExchangeModuleFrame( MODULE* aModule, bool updateMode, bool selectedMode );
|
2009-08-06 07:11:04 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function Exchange_Module
|
2009-08-06 07:11:04 +00:00
|
|
|
* Replaces OldModule by NewModule, using OldModule settings:
|
|
|
|
* position, orientation, pad netnames ...)
|
|
|
|
* OldModule is deleted or put in undo list.
|
2018-04-18 09:31:33 +00:00
|
|
|
* @param aSrc = footprint to replace
|
|
|
|
* @param aDest = footprint to put
|
2016-08-17 15:24:04 +00:00
|
|
|
* @param aCommit = commit that should store the changes
|
2009-08-06 07:11:04 +00:00
|
|
|
*/
|
2018-04-18 09:31:33 +00:00
|
|
|
void Exchange_Module( MODULE* aSrc, MODULE* aDest, BOARD_COMMIT& aCommit,
|
|
|
|
bool deleteExtraTexts = true,
|
2019-08-25 21:10:15 +00:00
|
|
|
bool resetTextLayers = true, bool resetTextEffects = true,
|
|
|
|
bool reset3DModels = true );
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2011-03-01 19:26:17 +00:00
|
|
|
// loading modules: see PCB_BASE_FRAME
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function OnEditItemRequest
|
2010-08-10 18:34:26 +00:00
|
|
|
* Install the corresponding dialog editor for the given item
|
2011-02-22 16:43:03 +00:00
|
|
|
* @param aDC = the current device context
|
2010-08-10 18:34:26 +00:00
|
|
|
* @param aItem = a pointer to the BOARD_ITEM to edit
|
|
|
|
*/
|
2019-05-28 23:23:58 +00:00
|
|
|
void OnEditItemRequest( BOARD_ITEM* aItem ) override;
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2017-03-13 03:19:33 +00:00
|
|
|
void SwitchLayer( wxDC* DC, PCB_LAYER_ID layer ) override;
|
2011-09-15 17:58:35 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
|
|
|
* Function SetTrackSegmentWidth
|
2009-08-08 06:07:08 +00:00
|
|
|
* Modify one track segment width or one via diameter (using DRC control).
|
2019-02-08 15:21:48 +00:00
|
|
|
* Basic routine used by other routines when editing tracks or vias.
|
|
|
|
* Note that casting this to boolean will allow you to determine whether any action
|
|
|
|
* happened.
|
2009-08-08 06:07:08 +00:00
|
|
|
* @param aTrackItem = the track segment or via to modify
|
2009-11-23 20:18:47 +00:00
|
|
|
* @param aItemsListPicker = the list picker to use for an undo command
|
|
|
|
* (can be NULL)
|
|
|
|
* @param aUseNetclassValue = true to use NetClass value, false to use
|
2010-01-31 20:01:46 +00:00
|
|
|
* current designSettings value
|
2019-02-08 15:21:48 +00:00
|
|
|
* @return 0 if items successfully changed,
|
|
|
|
* -1 if there was a DRC error,
|
|
|
|
* 1 if items were changed successfully
|
2009-08-08 06:07:08 +00:00
|
|
|
*/
|
2019-02-08 15:21:48 +00:00
|
|
|
int SetTrackSegmentWidth( TRACK* aTrackItem,
|
2009-11-23 20:18:47 +00:00
|
|
|
PICKED_ITEMS_LIST* aItemsListPicker,
|
|
|
|
bool aUseNetclassValue );
|
2009-08-08 06:07:08 +00:00
|
|
|
|
|
|
|
|
2008-01-05 13:37:51 +00:00
|
|
|
/**
|
|
|
|
* Function Edit_Zone_Params
|
|
|
|
* Edit params (layer, clearance, ...) for a zone outline
|
|
|
|
*/
|
2019-05-28 23:23:58 +00:00
|
|
|
void Edit_Zone_Params( ZONE_CONTAINER* zone_container );
|
2008-01-05 13:37:51 +00:00
|
|
|
|
2019-05-30 09:16:05 +00:00
|
|
|
// Properties dialogs
|
2019-05-28 23:23:58 +00:00
|
|
|
void ShowTargetOptionsDialog( PCB_TARGET* aTarget );
|
|
|
|
void ShowDimensionPropertyDialog( DIMENSION* aDimension );
|
|
|
|
void InstallNetlistFrame();
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2019-03-27 22:37:26 +00:00
|
|
|
/**
|
|
|
|
* Function FetchNetlistFromSchematic
|
|
|
|
* @param aNetlist a NETLIST owned by the caller. This function fills it in.
|
|
|
|
* @return true if a netlist was fetched.
|
|
|
|
*/
|
|
|
|
enum FETCH_NETLIST_MODE { NO_ANNOTATION, QUIET_ANNOTATION, ANNOTATION_DIALOG };
|
|
|
|
bool FetchNetlistFromSchematic( NETLIST& aNetlist, FETCH_NETLIST_MODE aMode );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Function DoUpdatePCBFromNetlist
|
|
|
|
* An automated version of UpdatePCBFromNetlist which skips the UI dialog.
|
|
|
|
* @param aNetlist
|
|
|
|
* @param aUseTimestamps
|
|
|
|
*/
|
|
|
|
void DoUpdatePCBFromNetlist( NETLIST& aNetlist, bool aUseTimestamps );
|
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2019-04-18 02:10:56 +00:00
|
|
|
* Reads a netlist from a file into a NETLIST object.
|
2013-04-25 16:29:35 +00:00
|
|
|
*
|
2019-04-18 02:10:56 +00:00
|
|
|
* @param aFilename is the netlist to load
|
|
|
|
* @param aNetlist is the object to populate with data
|
|
|
|
* @param aReporter is a #REPORTER object to display messages
|
|
|
|
* @return true if the netlist was read successfully
|
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
bool ReadNetlistFromFile( const wxString &aFilename, NETLIST& aNetlist, REPORTER& aReporter );
|
2019-04-18 02:10:56 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Called after netlist is updated
|
|
|
|
* @param aUpdater is the updater object that was run
|
|
|
|
* @param aRunDragCommand is set to true if the drag command was invoked by this call
|
|
|
|
*/
|
|
|
|
void OnNetlistChanged( BOARD_NETLIST_UPDATER& aUpdater, bool* aRunDragCommand );
|
2010-04-16 16:28:35 +00:00
|
|
|
|
|
|
|
|
2015-12-21 15:39:36 +00:00
|
|
|
#if defined( KICAD_SCRIPTING_WXPYTHON )
|
2012-08-10 21:53:50 +00:00
|
|
|
/**
|
|
|
|
* Function ScriptingConsoleEnableDisable
|
|
|
|
* enables or disabled the scripting console
|
|
|
|
*/
|
2019-06-03 13:49:17 +00:00
|
|
|
void ScriptingConsoleEnableDisable();
|
2015-12-21 15:39:36 +00:00
|
|
|
#endif
|
|
|
|
|
2011-09-15 17:58:35 +00:00
|
|
|
void LockModule( MODULE* aModule, bool aLocked );
|
2013-11-27 13:20:42 +00:00
|
|
|
|
2008-01-01 11:58:14 +00:00
|
|
|
/**
|
|
|
|
* Function SendMessageToEESCHEMA
|
|
|
|
* sends a message to the schematic editor so that it may move its cursor
|
|
|
|
* to a part with the same reference as the objectToSync
|
2011-09-30 18:15:37 +00:00
|
|
|
* @param objectToSync The object whose reference is used to synchronize Eeschema.
|
2008-01-01 11:58:14 +00:00
|
|
|
*/
|
2011-09-15 17:58:35 +00:00
|
|
|
void SendMessageToEESCHEMA( BOARD_ITEM* objectToSync );
|
2008-01-01 11:58:14 +00:00
|
|
|
|
2018-01-06 20:50:49 +00:00
|
|
|
/**
|
|
|
|
* Sends a net name to eeschema for highlighting
|
|
|
|
*
|
|
|
|
* @param aNetName is the name of a net, or empty string to clear highlight
|
|
|
|
*/
|
|
|
|
void SendCrossProbeNetName( const wxString& aNetName );
|
|
|
|
|
2011-11-10 15:55:05 +00:00
|
|
|
/**
|
2015-01-28 10:00:48 +00:00
|
|
|
* Function CreateMuWaveBaseFootprint
|
|
|
|
* create a basic footprint for micro wave applications.
|
|
|
|
* @param aValue = the text value
|
|
|
|
* @param aTextSize = the size of ref and value texts ( <= 0 to use board default values )
|
|
|
|
* @param aPadCount = number of pads
|
|
|
|
* Pads settings are:
|
2015-08-23 19:40:33 +00:00
|
|
|
* PAD_ATTRIB_SMD, rectangular, H size = V size = current track width.
|
2011-11-10 15:55:05 +00:00
|
|
|
*/
|
2015-01-28 10:00:48 +00:00
|
|
|
MODULE* CreateMuWaveBaseFootprint( const wxString& aValue, int aTextSize, int aPadCount );
|
2011-11-10 15:55:05 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Create_MuWaveComponent
|
|
|
|
* creates a module "GAP" or "STUB" used in micro wave designs.
|
|
|
|
* This module has 2 pads:
|
2015-08-23 19:40:33 +00:00
|
|
|
* PAD_ATTRIB_SMD, rectangular, H size = V size = current track width.
|
2011-11-10 15:55:05 +00:00
|
|
|
* the "gap" is isolation created between this 2 pads
|
|
|
|
*/
|
2011-09-15 17:58:35 +00:00
|
|
|
MODULE* Create_MuWaveComponent( int shape_type );
|
2011-11-10 15:55:05 +00:00
|
|
|
|
2011-09-15 17:58:35 +00:00
|
|
|
MODULE* Create_MuWavePolygonShape();
|
2011-11-10 15:55:05 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
void ShowChangedLanguage() override;
|
2010-04-16 16:28:35 +00:00
|
|
|
|
2011-08-26 17:01:17 +00:00
|
|
|
/**
|
|
|
|
* Function UpdateTitle
|
|
|
|
* sets the main window title bar text.
|
|
|
|
* <p>
|
|
|
|
* If file name defined by PCB_SCREEN::m_FileName is not set, the title is set to the
|
|
|
|
* application name appended with no file. Otherwise, the title is set to the full path
|
|
|
|
* and file name and read only is appended to the title if the user does not have write
|
|
|
|
* access to the file.
|
2011-09-15 17:58:35 +00:00
|
|
|
* </p>
|
2011-08-26 17:01:17 +00:00
|
|
|
*/
|
|
|
|
void UpdateTitle();
|
|
|
|
|
2019-06-09 21:57:23 +00:00
|
|
|
void On3DShapeLibWizard( wxCommandEvent& event );
|
2019-06-30 11:54:35 +00:00
|
|
|
|
2018-05-14 17:34:18 +00:00
|
|
|
/**
|
|
|
|
* Allows Pcbnew to install its preferences panel into the preferences dialog.
|
|
|
|
*/
|
2019-06-09 21:57:23 +00:00
|
|
|
void InstallPreferences( PAGED_DIALOG* aParent, PANEL_HOTKEYS_EDITOR* aHotkeysPanel ) override;
|
2018-05-14 17:34:18 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Called after the preferences dialog is run.
|
|
|
|
*/
|
2019-06-24 09:22:49 +00:00
|
|
|
void CommonSettingsChanged( bool aEnvVarsChanged ) override;
|
2018-01-08 04:05:03 +00:00
|
|
|
|
2019-06-10 14:35:01 +00:00
|
|
|
void SyncToolbars() override;
|
2018-02-26 12:00:08 +00:00
|
|
|
|
2008-01-01 11:58:14 +00:00
|
|
|
DECLARE_EVENT_TABLE()
|
|
|
|
};
|
|
|
|
|
2012-10-15 22:30:01 +00:00
|
|
|
#endif // WXPCB_STRUCT_H_
|