kicad/pcbnew/pcbnew_settings.h

463 lines
11 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Jon Evans <jon@craftyjon.com>
* Copyright (C) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef PCBNEW_SETTINGS_H_
#define PCBNEW_SETTINGS_H_
#include <geometry/eda_angle.h>
#include <settings/app_settings.h>
#include <pcb_display_options.h>
namespace PNS
{
class ROUTING_SETTINGS;
}
// Settings for the CONVERT_TOOL.
enum CONVERT_STRATEGY
{
COPY_LINEWIDTH,
CENTERLINE,
BOUNDING_HULL
};
struct CONVERT_SETTINGS
{
CONVERT_STRATEGY m_Strategy;
int m_Gap;
int m_LineWidth;
bool m_DeleteOriginals;
};
enum class MAGNETIC_OPTIONS
{
NO_EFFECT = 0,
CAPTURE_CURSOR_IN_TRACK_TOOL,
CAPTURE_ALWAYS
};
struct MAGNETIC_SETTINGS
{
MAGNETIC_OPTIONS pads;
MAGNETIC_OPTIONS tracks;
bool graphics;
bool allLayers;
MAGNETIC_SETTINGS() :
pads( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ),
tracks( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ),
graphics( false ),
allLayers( false )
{ }
};
enum class TRACK_DRAG_ACTION
{
MOVE,
DRAG,
DRAG_FREE_ANGLE
};
enum TRACK_CLEARANCE_MODE
{
DO_NOT_SHOW_CLEARANCE = 0,
SHOW_WHILE_ROUTING,
SHOW_WITH_VIA_WHILE_ROUTING,
SHOW_WITH_VIA_WHILE_ROUTING_OR_DRAGGING,
SHOW_WITH_VIA_ALWAYS
};
enum PCB_DISPLAY_ORIGIN
{
PCB_ORIGIN_PAGE = 0,
PCB_ORIGIN_AUX,
PCB_ORIGIN_GRID,
};
typedef std::vector<std::pair<wxString, bool>> ACTION_PLUGIN_SETTINGS_LIST;
// base class to handle Pcbnew SETTINGS also used in Cvpcb
class PCB_VIEWERS_SETTINGS_BASE : public APP_SETTINGS_BASE
{
public:
struct VIEWERS_DISPLAY_OPTIONS
{
bool m_DisplayGraphicsFill;
bool m_DisplayTextFill;
bool m_DisplayPadNumbers;
bool m_DisplayPadFill;
};
VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay;
PCB_VIEWERS_SETTINGS_BASE( const std::string& aFilename, int aSchemaVersion ):
APP_SETTINGS_BASE( aFilename, aSchemaVersion )
{
m_ViewersDisplay.m_DisplayGraphicsFill = true;
m_ViewersDisplay.m_DisplayTextFill = true;
m_ViewersDisplay.m_DisplayPadNumbers = true;
m_ViewersDisplay.m_DisplayPadFill = true;
}
virtual ~PCB_VIEWERS_SETTINGS_BASE() {};
};
class PCBNEW_SETTINGS : public PCB_VIEWERS_SETTINGS_BASE
{
public:
struct AUI_PANELS
{
int appearance_panel_tab;
bool appearance_expand_layer_display;
bool appearance_expand_net_display;
int right_panel_width;
int properties_panel_width;
float properties_splitter;
int search_panel_height;
int search_panel_width;
int search_panel_dock_direction;
bool show_layer_manager;
bool show_properties;
bool show_search;
};
struct DIALOG_CLEANUP
{
bool cleanup_vias;
bool delete_dangling_vias;
bool cleanup_tracks_in_pad;
bool cleanup_unconnected;
bool cleanup_short_circuits;
bool merge_segments;
};
struct DIALOG_DRC
{
bool refill_zones;
bool test_all_track_errors;
bool test_footprints;
int severities;
};
struct DIALOG_EXPORT_IDF
{
bool auto_adjust;
int ref_units;
double ref_x;
double ref_y;
bool units_mils;
};
struct DIALOG_EXPORT_STEP
{
int origin_mode;
int origin_units;
double origin_x;
double origin_y;
bool no_unspecified;
bool no_dnp;
bool replace_models;
bool overwrite_file;
};
struct DIALOG_EXPORT_2581
{
int precision;
int units;
int version;
bool compress;
};
struct DIALOG_EXPORT_SVG
{
bool black_and_white;
bool mirror;
bool one_file;
bool plot_board_edges;
int page_size;
wxString output_dir; // legacy; now in project settings
std::vector<int> layers;
bool use_selected_theme;// color theme option to use for export
// false = board theme, true = selected theme
wxString color_theme; // color theme used for export
};
struct DIALOG_EXPORT_VRML
{
int units;
bool copy_3d_models;
bool use_relative_paths;
int ref_units;
double ref_x;
double ref_y;
int origin_mode;
};
struct DIALOG_FOOTPRINT_WIZARD_LIST
{
int width;
int height;
};
struct DIALOG_GENERATE_DRILL
{
bool merge_pth_npth;
bool minimal_header;
bool mirror;
bool unit_drill_is_inch;
bool use_route_for_oval_holes;
int drill_file_type;
int map_file_type;
int zeros_format;
};
struct DIALOG_IMPORT_GRAPHICS
{
int layer;
bool use_dlg_layer_selection;
bool interactive_placement;
bool group_items;
bool fix_discontinuities;
double tolerance;
wxString last_file;
double dxf_line_width;
int dxf_line_width_units;
int origin_units;
double origin_x;
double origin_y;
int dxf_units;
};
struct DIALOG_NETLIST
{
int report_filter;
bool update_footprints;
bool delete_shorting_tracks;
bool delete_extra_footprints;
bool associate_by_ref_sch;
};
struct DIALOG_PLACE_FILE
{
wxString output_directory; // legacy; now in project settings
int units;
int file_options;
int file_format;
bool include_board_edge;
bool exclude_TH;
bool only_SMD;
bool use_aux_origin;
bool negate_xcoord;
};
struct DIALOG_PLOT
{
int all_layers_on_one_page;
bool edgecut_on_all_layers;
int pads_drill_mode;
double fine_scale_x;
double fine_scale_y;
double ps_fine_width_adjust;
bool check_zones_before_plotting;
bool mirror;
bool as_item_checkboxes;
};
struct DIALOG_REANNOTATE
{
bool sort_on_fp_location;
bool remove_front_prefix;
bool remove_back_prefix;
bool exclude_locked;
int grid_index;
int sort_code;
int annotation_choice;
int report_severity;
wxString front_refdes_start;
wxString back_refdes_start;
wxString front_prefix;
wxString back_prefix;
wxString exclude_list;
wxString report_file_name;
};
struct DIALOG_NET_INSPECTOR
{
wxString group_by_text;
bool group_by;
int group_by_kind;
};
struct FOOTPRINT_CHOOSER
{
int width;
int height;
int sash_h;
int sash_v;
int sort_mode;
bool use_fp_filters;
bool filter_on_pin_count;
};
struct ZONES
{
int net_sort_mode;
};
struct DISPLAY_OPTIONS
{
// Note: Display options common to Cvpcb and Pcbnew are stored in
// VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay, because the section DISPLAY_OPTIONS
// exists only for Pcbnew
bool m_DisplayViaFill;
bool m_DisplayPcbTrackFill;
TRACK_CLEARANCE_MODE m_TrackClearance;
bool m_PadClearance;
int m_NetNames;
RATSNEST_MODE m_RatsnestMode;
int m_MaxLinksShowed;
bool m_ShowModuleRatsnest;
bool m_ShowGlobalRatsnest;
bool m_DisplayRatsnestLinesCurved;
double m_RatsnestThickness;
PCB_DISPLAY_ORIGIN m_DisplayOrigin;
bool m_DisplayInvertXAxis;
bool m_DisplayInvertYAxis;
bool m_ForceShowFieldsWhenFPSelected;
bool m_Live3DRefresh;
};
PCBNEW_SETTINGS();
virtual ~PCBNEW_SETTINGS();
virtual bool MigrateFromLegacy( wxConfigBase* aLegacyConfig ) override;
AUI_PANELS m_AuiPanels;
DIALOG_CLEANUP m_Cleanup;
DIALOG_DRC m_DrcDialog;
DIALOG_EXPORT_IDF m_ExportIdf;
DIALOG_EXPORT_STEP m_ExportStep;
DIALOG_EXPORT_2581 m_Export2581;
DIALOG_EXPORT_SVG m_ExportSvg;
DIALOG_EXPORT_VRML m_ExportVrml;
DIALOG_FOOTPRINT_WIZARD_LIST m_FootprintWizardList;
DIALOG_GENERATE_DRILL m_GenDrill;
DIALOG_IMPORT_GRAPHICS m_ImportGraphics;
DIALOG_NETLIST m_NetlistDialog;
DIALOG_PLACE_FILE m_PlaceFile;
DIALOG_PLOT m_Plot;
DIALOG_REANNOTATE m_Reannotate;
DIALOG_NET_INSPECTOR m_NetInspector;
FOOTPRINT_CHOOSER m_FootprintChooser;
ZONES m_Zones;
WINDOW_SETTINGS m_FootprintViewer;
WINDOW_SETTINGS m_FootprintWizard;
DISPLAY_OPTIONS m_Display;
MAGNETIC_SETTINGS m_MagneticItems;
TRACK_DRAG_ACTION m_TrackDragAction;
ARC_EDIT_MODE m_ArcEditMode;
bool m_CtrlClickHighlight;
bool m_Use45DegreeLimit; // True to constrain tool actions to horizontal,
// vertical and 45deg
bool m_FlipLeftRight; // True: Flip footprints across Y axis
bool m_ESCClearsNetHighlight;
bool m_PolarCoords;
EDA_ANGLE m_RotationAngle;
bool m_ShowPageLimits;
bool m_ShowCourtyardCollisions;
///<@todo Implement real auto zone filling (not just after zone properties are edited)
bool m_AutoRefillZones; // Fill zones after editing the zone using the Zone Properties dialog
bool m_AllowFreePads; // True: unlocked pads can be moved freely with respect to the footprint.
// False (default): all pads are treated as locked for the purposes of
// movement and any attempt to move them will move the footprint instead.
wxString m_FootprintTextShownColumns;
std::unique_ptr<PNS::ROUTING_SETTINGS> m_PnsSettings;
double m_FootprintViewerZoom; ///< The last zoom level used (0 for auto)
bool m_FootprintViewerAutoZoomOnSelect; ///< true to use automatic zoom on fp selection
int m_FootprintViewerLibListWidth;
int m_FootprintViewerFPListWidth;
wxString m_lastFootprintLibDir;
wxString m_lastFootprint3dDir;
ACTION_PLUGIN_SETTINGS_LIST m_VisibleActionPlugins;
protected:
virtual std::string getLegacyFrameName() const override { return "PcbFrame"; }
};
#endif