KiCad PCB EDA Suite
pcbnew_settings.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2020 Jon Evans <[email protected]>
5 * Copyright (C) 2020-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#ifndef PCBNEW_SETTINGS_H_
22#define PCBNEW_SETTINGS_H_
23
24#include <geometry/eda_angle.h>
26#include <pcb_display_options.h>
27
28namespace PNS
29{
30 class ROUTING_SETTINGS;
31}
32
33
34// Settings for the CONVERT_TOOL.
36{
40};
41
42
44{
48};
49
50
51
53{
54 NO_EFFECT = 0,
57};
58
59
61{
65
69 graphics( false )
70 { }
71};
72
73
75{
76 MOVE,
77 DRAG,
79};
80
81
83{
89};
90
91
93{
97};
98
99
100typedef std::vector<std::pair<wxString, bool>> ACTION_PLUGIN_SETTINGS_LIST;
101
102
103// base class to handle Pcbnew SETTINGS also used in Cvpcb
105{
106public:
108 {
113 };
114
116
117 PCB_VIEWERS_SETTINGS_BASE( const std::string& aFilename, int aSchemaVersion ):
118 APP_SETTINGS_BASE( aFilename, aSchemaVersion )
119 {
124 }
125
127};
128
129
131{
132public:
134 {
144 };
145
147 {
154 };
155
157 {
162 };
163
165 {
168 double ref_x;
169 double ref_y;
171 };
172
174 {
177 double origin_x;
178 double origin_y;
182 };
183
185 {
187 bool mirror;
191 wxString output_dir;
192 std::vector<int> layers;
193 };
194
196 {
197 int units;
201 double ref_x;
202 double ref_y;
204 };
205
207 {
208 int width;
210 };
211
213 {
216 bool mirror;
222 };
223
225 {
226 int layer;
228 wxString last_file;
232 double origin_x;
233 double origin_y;
235 };
236
238 {
244 };
245
247 {
249 int units;
257 };
258
260 {
268 bool mirror;
269 };
270
272 {
283 wxString front_prefix;
284 wxString back_prefix;
285 wxString exclude_list;
287 };
288
290 {
291 int width;
295 };
296
297 struct ZONES
298 {
300 };
301
303 {
304 // Note: Display options common to Cvpcb and Pcbnew are stored in
305 // VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay, because the section DISPLAY_OPTIONS
306 // exists only for Pcbnew
309
312
314
316
321
325
327 };
328
330
332
333 virtual bool MigrateFromLegacy( wxConfigBase* aLegacyConfig ) override;
334
336
338
340
342
344
346
348
350
352
354
356
358
360
362
364
366
368
370
372
374
376
378
380
381 bool m_Use45DegreeLimit; // True to constrain tool actions to horizontal,
382 // vertical and 45deg
383 bool m_FlipLeftRight; // True: Flip footprints across Y axis
384
386
388
390
392
394
396 bool m_AutoRefillZones; // Fill zones after editing the zone using the Zone Properties dialog
397
398 bool m_AllowFreePads; // True: unlocked pads can be moved freely with respect to the footprint.
399 // False (default): all pads are treated as locked for the purposes of
400 // movement and any attempt to move them will move the footprint instead.
401
403
404 std::unique_ptr<PNS::ROUTING_SETTINGS> m_PnsSettings;
405
410
412
414
416
417protected:
418
419 virtual std::string getLegacyFrameName() const override { return "PcbFrame"; }
420
421};
422
423#endif
ARC_EDIT_MODE
Settings for arc editing.
Definition: app_settings.h:70
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:110
double m_FootprintViewerZoom
The last zoom level used (0 for auto)
DISPLAY_OPTIONS m_Display
DIALOG_NETLIST m_NetlistDialog
DIALOG_CLEANUP m_Cleanup
EDA_ANGLE m_RotationAngle
DIALOG_PLACE_FILE m_PlaceFile
bool m_FootprintViewerAutoZoomOnSelect
true to use automatic zoom on fp selection
DIALOG_FOOTPRINT_WIZARD_LIST m_FootprintWizardList
ARC_EDIT_MODE m_ArcEditMode
FOOTPRINT_CHOOSER m_FootprintChooser
virtual ~PCBNEW_SETTINGS()
DIALOG_EXPORT_VRML m_ExportVrml
DIALOG_EXPORT_IDF m_ExportIdf
TRACK_DRAG_ACTION m_TrackDragAction
wxString m_lastFootprintLibDir
virtual std::string getLegacyFrameName() const override
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
DIALOG_PLOT m_Plot
WINDOW_SETTINGS m_FootprintWizard
ACTION_PLUGIN_SETTINGS_LIST m_VisibleActionPlugins
DIALOG_IMPORT_GRAPHICS m_ImportGraphics
DIALOG_DRC m_DrcDialog
AUI_PANELS m_AuiPanels
DIALOG_EXPORT_STEP m_ExportStep
WINDOW_SETTINGS m_FootprintViewer
wxString m_lastFootprint3dDir
bool m_ShowCourtyardCollisions
DIALOG_GENERATE_DRILL m_GenDrill
MAGNETIC_SETTINGS m_MagneticItems
DIALOG_REANNOTATE m_Reannotate
int m_FootprintViewerFPListWidth
std::unique_ptr< PNS::ROUTING_SETTINGS > m_PnsSettings
DIALOG_EXPORT_SVG m_ExportSvg
wxString m_FootprintTextShownColumns
int m_FootprintViewerLibListWidth
PCB_VIEWERS_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay
Push and Shove diff pair dimensions (gap) settings dialog.
MAGNETIC_OPTIONS
TRACK_CLEARANCE_MODE
@ SHOW_WITH_VIA_WHILE_ROUTING_OR_DRAGGING
@ DO_NOT_SHOW_CLEARANCE
@ SHOW_WHILE_ROUTING
@ SHOW_WITH_VIA_ALWAYS
@ SHOW_WITH_VIA_WHILE_ROUTING
PCB_DISPLAY_ORIGIN
@ PCB_ORIGIN_AUX
@ PCB_ORIGIN_GRID
@ PCB_ORIGIN_PAGE
CONVERT_STRATEGY
@ COPY_LINEWIDTH
@ CENTERLINE
@ BOUNDING_HULL
TRACK_DRAG_ACTION
std::vector< std::pair< wxString, bool > > ACTION_PLUGIN_SETTINGS_LIST
CONVERT_STRATEGY m_Strategy
MAGNETIC_OPTIONS tracks
MAGNETIC_OPTIONS pads
TRACK_CLEARANCE_MODE m_TrackClearance
Stores the common settings that are saved and loaded for each window / frame.
Definition: app_settings.h:92