KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcbnew_settings.cpp
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-2023 KiCad Developers, see AUTHORS.txt for contributors.
5*
6* This program is free software; you can redistribute it and/or
7* modify it under the terms of the GNU General Public License
8* as published by the Free Software Foundation; either version 2
9* of the License, or (at your option) any later version.
10*
11* This program is distributed in the hope that it will be useful,
12* but WITHOUT ANY WARRANTY; without even the implied warranty of
13* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14* GNU General Public License for more details.
15*
16* You should have received a copy of the GNU General Public License
17* along with this program; if not, you may find one here:
18* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19* or you may search the http://www.gnu.org website for the version 2 license,
20* or you may write to the Free Software Foundation, Inc.,
21* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22*/
23
24#include <pybind11/pybind11.h>
25
26#include <common.h>
28#include <layer_ids.h>
29#include <pcbnew_settings.h>
30#include <pgm_base.h>
34#include <settings/parameters.h>
36#include <wx/config.h>
37#include <wx/tokenzr.h>
38#include <zones.h>
39#include <widgets/ui_common.h>
40#include <base_units.h>
41
42#include "../3d-viewer/3d_viewer/eda_3d_viewer_settings.h"
43
44
46const int pcbnewSchemaVersion = 5;
47
48
51 m_AuiPanels(),
52 m_Cleanup(),
53 m_DrcDialog(),
54 m_ExportIdf(),
55 m_ExportStep(),
56 m_ExportSvg(),
57 m_ExportVrml(),
58 m_FootprintWizardList(),
59 m_GenDrill(),
60 m_ImportGraphics(),
61 m_NetlistDialog(),
62 m_PlaceFile(),
63 m_Plot(),
64 m_FootprintChooser(),
65 m_Zones(),
66 m_FootprintViewer(),
67 m_FootprintWizard(),
68 m_Display(),
69 m_TrackDragAction( TRACK_DRAG_ACTION::DRAG ),
71 m_CtrlClickHighlight( false ),
72 m_Use45DegreeLimit( false ),
73 m_FlipLeftRight( false ),
74 m_ESCClearsNetHighlight( true ),
75 m_PolarCoords( false ),
76 m_RotationAngle( ANGLE_90 ),
77 m_ShowPageLimits( true ),
78 m_ShowCourtyardCollisions( true ),
79 m_AutoRefillZones( false ),
80 m_AllowFreePads( false ),
81 m_PnsSettings( nullptr ),
82 m_FootprintViewerZoom( 1.0 ),
83 m_FootprintViewerAutoZoomOnSelect( true ),
84 m_FootprintViewerLibListWidth( 200 ),
85 m_FootprintViewerFPListWidth( 300 )
86{
87 m_MagneticItems.pads = MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL;
88 m_MagneticItems.tracks = MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL;
91
92 m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
94
95 m_params.emplace_back( new PARAM<int>( "aui.right_panel_width",
97
98 m_params.emplace_back( new PARAM<int>( "aui.net_inspector_width",
100
101 m_params.emplace_back( new PARAM<int>( "aui.properties_panel_width",
103
104 m_params.emplace_back( new PARAM<float>( "aui.properties_splitter_proportion",
106
107 m_params.emplace_back( new PARAM<int>( "aui.search_panel_height",
109
110 m_params.emplace_back( new PARAM<int>( "aui.search_panel_width",
112
113 m_params.emplace_back( new PARAM<int>( "aui.search_panel_dock_direction",
115
116 m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
117 &m_AuiPanels.appearance_panel_tab, 0, 0, 2 ) );
118
119 m_params.emplace_back( new PARAM<bool>( "aui.appearance_expand_layer_display",
121
122 m_params.emplace_back( new PARAM<bool>( "aui.appearance_expand_net_display",
124
125 m_params.emplace_back( new PARAM<bool>( "aui.show_properties",
126 &m_AuiPanels.show_properties, false ) );
127
128 m_params.emplace_back( new PARAM<bool>( "aui.show_search",
129 &m_AuiPanels.show_search, false ) );
130
131 m_params.emplace_back( new PARAM<bool>( "aui.show_net_inspector",
132 &m_AuiPanels.show_net_inspector, false ) );
133
134 m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
135 &m_FootprintChooser.width, -1 ) );
136
137 m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
138 &m_FootprintChooser.height, -1 ) );
139
140 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
141 &m_FootprintChooser.sash_h, -1 ) );
142
143 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
144 &m_FootprintChooser.sash_v, -1 ) );
145
146 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sort_mode",
148
149 m_params.emplace_back( new PARAM<bool>( "footprint_chooser.filter_on_pin_count",
151
152 m_params.emplace_back( new PARAM<bool>( "footprint_chooser.use_fp_filters",
154
155 m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right",
156 &m_FlipLeftRight, true ) );
157
158 m_params.emplace_back( new PARAM<bool>( "editing.esc_clears_net_highlight",
159 &m_ESCClearsNetHighlight, true ) );
160
161 m_params.emplace_back( new PARAM<bool>( "editing.show_courtyard_collisions",
162 &m_ShowCourtyardCollisions, true ) );
163
164 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
165 &m_MagneticItems.graphics, true ) );
166
167 m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
168 reinterpret_cast<int*>( &m_MagneticItems.pads ),
169 static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
170
171 m_params.emplace_back( new PARAM<int>( "editing.magnetic_tracks",
172 reinterpret_cast<int*>( &m_MagneticItems.tracks ),
173 static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
174
175 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_all_layers",
176 &m_MagneticItems.allLayers, false ) );
177
178 m_params.emplace_back( new PARAM<bool>( "editing.polar_coords",
179 &m_PolarCoords, false ) );
180
181 m_params.emplace_back( new PARAM<int>( "editing.track_drag_action",
182 reinterpret_cast<int*>( &m_TrackDragAction ),
183 static_cast<int>( TRACK_DRAG_ACTION::DRAG ) ) );
184
185 m_params.emplace_back( new PARAM<int>( "editing.arc_edit_mode",
186 reinterpret_cast<int*>( &m_ArcEditMode ),
187 static_cast<int>( ARC_EDIT_MODE::KEEP_CENTER_ADJUST_ANGLE_RADIUS ) ) );
188
189 m_params.emplace_back( new PARAM<bool>( "editing.ctrl_click_highlight",
190 &m_CtrlClickHighlight, false ) );
191
192 m_params.emplace_back( new PARAM<bool>( "editing.pcb_use_45_degree_limit",
193 &m_Use45DegreeLimit, false ) );
194
195 m_params.emplace_back( new PARAM<bool>( "editing.auto_fill_zones",
196 &m_AutoRefillZones, false ) );
197
198 m_params.emplace_back( new PARAM<bool>( "editing.allow_free_pads",
199 &m_AllowFreePads, false ) );
200
201 m_params.emplace_back( new PARAM_LAMBDA<int>( "editing.rotation_angle",
202 [this] () -> int
203 {
205
206 // Don't store values larger than 360 degrees
207 return rot % 3600;
208 },
209 [this] ( int aVal )
210 {
211 if( aVal )
213
214 // A misconfiguration allowed some angles to be stored as tenth of a degree but read
215 // as tens of degrees. By disallowing storage of values larger than 360, we can weed out
216 // those invalid values here.
217 while( m_RotationAngle > ANGLE_360 )
219
220 },
221 900 ) );
222
223 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
225
226 m_params.emplace_back( new PARAM<int>( "pcb_display.max_links_shown",
227 &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
228
229 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphics_fill",
231
232 m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
234
235 m_params.emplace_back( new PARAM<int>( "pcb_display.net_names_mode",
236 &m_Display.m_NetNames, 3, 0, 3 ) );
237
238 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_clearance",
239 &m_Display.m_PadClearance, true ) );
240
241 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
243
244 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_numbers",
246
247 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_global",
249
250 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_footprint",
252
253 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_curved",
255
256 m_params.emplace_back( new PARAM<double>( "pcb_display.ratsnest_thickness",
258
259 m_params.emplace_back( new PARAM<int>( "pcb_display.track_clearance_mode",
260 reinterpret_cast<int*>( &m_Display.m_TrackClearance ), SHOW_WITH_VIA_WHILE_ROUTING ) );
261
262 m_params.emplace_back( new PARAM<bool>( "pcb_display.track_fill",
264
265 m_params.emplace_back( new PARAM<bool>( "pcb_display.via_fill",
266 &m_Display.m_DisplayViaFill, true ) );
267
268 m_params.emplace_back( new PARAM<int>( "pcb_display.origin_mode",
269 reinterpret_cast<int*>( &m_Display.m_DisplayOrigin ),
270 PCB_DISPLAY_ORIGIN::PCB_ORIGIN_PAGE ) );
271
272 m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_x_axis",
274
275 m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_y_axis",
277
278 m_params.emplace_back( new PARAM<bool>( "pcb_display.force_show_fields_when_fp_selected",
280
281 m_params.emplace_back( new PARAM<bool>( "pcb_display.live_3d_refresh",
282 &m_Display.m_Live3DRefresh, false ) );
283
284 m_params.emplace_back( new PARAM<bool>( "pcb_display.show_page_borders",
285 &m_ShowPageLimits, true ) );
286
287 m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_vias",
288 &m_Cleanup.cleanup_vias, true ) );
289
290 m_params.emplace_back( new PARAM<bool>( "cleanup.delete_dangling_vias",
292
293 m_params.emplace_back( new PARAM<bool>( "cleanup.merge_segments",
294 &m_Cleanup.merge_segments, true ) );
295
296 m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_unconnected",
298
299 m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_short_circuits",
301
302 m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_tracks_in_pad",
304
305 m_params.emplace_back( new PARAM<bool>( "drc_dialog.refill_zones",
306 &m_DrcDialog.refill_zones, true ) );
307
308 m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_all_track_errors",
310
311 m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_footprints",
312 &m_DrcDialog.test_footprints, false ) );
313
314 m_params.emplace_back( new PARAM<int>( "drc_dialog.severities",
316
317 m_params.emplace_back( new PARAM<bool>( "gen_drill.merge_pth_npth",
318 &m_GenDrill.merge_pth_npth, false ) );
319
320 m_params.emplace_back( new PARAM<bool>( "gen_drill.minimal_header",
321 &m_GenDrill.minimal_header, false ) );
322
323 m_params.emplace_back( new PARAM<bool>( "gen_drill.mirror",
324 &m_GenDrill.mirror, false ) );
325
326 m_params.emplace_back( new PARAM<bool>( "gen_drill.unit_drill_is_inch",
328
329 m_params.emplace_back( new PARAM<bool>( "gen_drill.use_route_for_oval_holes",
331
332 m_params.emplace_back( new PARAM<int>( "gen_drill.drill_file_type",
334
335 m_params.emplace_back( new PARAM<int>( "gen_drill.map_file_type",
337
338 m_params.emplace_back( new PARAM<int>( "gen_drill.zeros_format",
339 &m_GenDrill.zeros_format, 0, 0, 3 ) );
340
341 m_params.emplace_back( new PARAM<int>( "export_2581.units",
342 &m_Export2581.units, 0 ) );
343
344 m_params.emplace_back( new PARAM<int>( "export_2581.precision",
345 &m_Export2581.precision, 3 ) );
346
347 m_params.emplace_back( new PARAM<int>( "export_2581.version",
348 &m_Export2581.version, 1 ) );
349
350 m_params.emplace_back( new PARAM<bool>( "export_2581.compress",
351 &m_Export2581.compress, false ) );
352
353 m_params.emplace_back( new PARAM<bool>( "export_idf.auto_adjust",
354 &m_ExportIdf.auto_adjust, false ) );
355
356 m_params.emplace_back( new PARAM<int>( "export_idf.ref_units",
357 &m_ExportIdf.ref_units, 0 ) );
358
359 m_params.emplace_back( new PARAM<double>( "export_idf.ref_x",
360 &m_ExportIdf.ref_x, 0 ) );
361
362 m_params.emplace_back( new PARAM<double>( "export_idf.ref_y",
363 &m_ExportIdf.ref_y, 0 ) );
364
365 m_params.emplace_back( new PARAM<bool>( "export_idf.units_mils",
366 &m_ExportIdf.units_mils, false ) );
367
368 m_params.emplace_back( new PARAM<int>( "export_step.origin_mode",
370
371 m_params.emplace_back( new PARAM<int>( "export_step.origin_units",
373
374 m_params.emplace_back( new PARAM<double>( "export_step.origin_x",
375 &m_ExportStep.origin_x, 0 ) );
376
377 m_params.emplace_back( new PARAM<double>( "export_step.origin_y",
378 &m_ExportStep.origin_y, 0 ) );
379
380 m_params.emplace_back( new PARAM<bool>( "export_step.no_unspecified",
381 &m_ExportStep.no_unspecified, false ) );
382
383 m_params.emplace_back( new PARAM<bool>( "export_step.no_dnp",
384 &m_ExportStep.no_dnp, false ) );
385
386 m_params.emplace_back( new PARAM<bool>( "export_step.replace_models",
387 &m_ExportStep.replace_models, true ) );
388
389 m_params.emplace_back( new PARAM<bool>( "export_step.overwrite_file",
390 &m_ExportStep.overwrite_file, true ) );
391
392 m_params.emplace_back( new PARAM<bool>( "export_svg.black_and_white",
393 &m_ExportSvg.black_and_white, false ) );
394
395 m_params.emplace_back( new PARAM<bool>( "export_svg.use_theme",
397
398 m_params.emplace_back( new PARAM<wxString>( "export_svg.color_theme",
399 &m_ExportSvg.color_theme, "" ) );
400
401 m_params.emplace_back( new PARAM<bool>( "export_svg.mirror",
402 &m_ExportSvg.mirror, false ) );
403
404 m_params.emplace_back( new PARAM<bool>( "export_svg.one_file",
405 &m_ExportSvg.one_file, false ) );
406
407 m_params.emplace_back(new PARAM<bool>( "export_svg.plot_board_edges",
408 &m_ExportSvg.plot_board_edges, true ) );
409
410 m_params.emplace_back( new PARAM<int>( "export_svg.page_size",
411 &m_ExportSvg.page_size, 0 ) );
412
413 m_params.emplace_back( new PARAM<wxString>( "export_svg.output_dir",
414 &m_ExportSvg.output_dir, "" ) );
415
416 m_params.emplace_back( new PARAM_LIST<int>( "export_svg.layers",
417 &m_ExportSvg.layers, {} ) );
418
419 m_params.emplace_back( new PARAM<int>( "export_vrml.units",
420 &m_ExportVrml.units, 1 ) );
421
422 m_params.emplace_back( new PARAM<bool>( "export_vrml.no_unspecified",
423 &m_ExportVrml.no_unspecified, false ) );
424
425 m_params.emplace_back( new PARAM<bool>( "export_vrml.no_dnp",
426 &m_ExportVrml.no_dnp, false ) );
427
428 m_params.emplace_back( new PARAM<bool>( "export_vrml.copy_3d_models",
429 &m_ExportVrml.copy_3d_models, false ) );
430
431 m_params.emplace_back( new PARAM<bool>( "export_vrml.use_relative_paths",
433
434 m_params.emplace_back( new PARAM<int>( "export_vrml.ref_units",
435 &m_ExportVrml.ref_units, 0 ) );
436
437 m_params.emplace_back( new PARAM<double>( "export_vrml.ref_x",
438 &m_ExportVrml.ref_x, 0 ) );
439
440 m_params.emplace_back( new PARAM<double>( "export_vrml.ref_y",
441 &m_ExportVrml.ref_y, 0 ) );
442
443 m_params.emplace_back( new PARAM<int>( "export_vrml.origin_mode",
445
446 m_params.emplace_back( new PARAM<int>( "zones.net_sort_mode",
447 &m_Zones.net_sort_mode, -1 ) );
448
449 m_params.emplace_back( new PARAM<int>( "import_graphics.layer",
451
452 m_params.emplace_back( new PARAM<bool>( "import_graphics.use_dlg_layer_selection",
454
455 m_params.emplace_back( new PARAM<bool>( "import_graphics.interactive_placement",
457
458 m_params.emplace_back( new PARAM<bool>( "import_graphics.group_items",
459 &m_ImportGraphics.group_items, true ) );
460
461 m_params.emplace_back( new PARAM<bool>( "import_graphics.fix_discontinuities",
463
464 m_params.emplace_back( new PARAM<double>( "import_graphics.tolerance",
465 &m_ImportGraphics.tolerance, 1.0, 0.0, 10.0 ) );
466
467 m_params.emplace_back( new PARAM<int>( "import_graphics.line_width_units",
469
470 m_params.emplace_back( new PARAM<double>( "import_graphics.line_width",
472
473 m_params.emplace_back( new PARAM<int>( "import_graphics.origin_units",
475
476 m_params.emplace_back( new PARAM<double>( "import_graphics.origin_x",
478
479 m_params.emplace_back( new PARAM<double>( "import_graphics.origin_y",
481
482 m_params.emplace_back( new PARAM<int>( "import_graphics.dxf_units",
484
485 m_params.emplace_back( new PARAM<int>( "netlist.report_filter",
487
488 m_params.emplace_back( new PARAM<bool>( "netlist.update_footprints",
490
491 m_params.emplace_back( new PARAM<bool>( "netlist.delete_shorting_tracks",
493
494 m_params.emplace_back( new PARAM<bool>( "netlist.delete_extra_footprints",
496
497 m_params.emplace_back( new PARAM<bool>( "netlist.associate_by_ref_sch",
499
500 /*
501 * place_file.output_directory is only used at run-time; actual data is in project file
502 *
503 * m_params.emplace_back( new PARAM<wxString>( "place_file.output_directory",
504 * &m_PlaceFile.output_directory, wxEmptyString ) );
505 */
506
507 m_params.emplace_back( new PARAM<int>( "place_file.units",
508 &m_PlaceFile.units, 1 ) );
509
510 m_params.emplace_back( new PARAM<int>( "place_file.file_options",
512
513 m_params.emplace_back( new PARAM<int>( "place_file.file_format",
514 &m_PlaceFile.file_format, 0 ) );
515
516 m_params.emplace_back( new PARAM<bool>( "place_file.excludeTH",
517 &m_PlaceFile.exclude_TH, false ) );
518
519 m_params.emplace_back( new PARAM<bool>( "place_file.onlySMD",
520 &m_PlaceFile.only_SMD, false ) );
521
522 m_params.emplace_back( new PARAM<bool>( "place_file.include_board_edge",
524
525 m_params.emplace_back( new PARAM<bool>( "place_file.use_place_file_origin",
526 &m_PlaceFile.use_aux_origin, true ) );
527
528 m_params.emplace_back( new PARAM<bool>( "place_file.negate_xcoord",
529 &m_PlaceFile.negate_xcoord, false ) );
530
531 m_params.emplace_back( new PARAM<int>( "plot.all_layers_on_one_page",
533
534 m_params.emplace_back( new PARAM<bool>( "plot.edgecut_on_all_layers",
535 &m_Plot.edgecut_on_all_layers, true ) );
536
537 m_params.emplace_back( new PARAM<int>( "plot.pads_drill_mode",
538 &m_Plot.pads_drill_mode, 2 ) );
539
540 m_params.emplace_back( new PARAM<double>( "plot.fine_scale_x",
541 &m_Plot.fine_scale_x, 0 ) );
542
543 m_params.emplace_back( new PARAM<double>( "plot.fine_scale_y",
544 &m_Plot.fine_scale_y, 0 ) );
545
546 m_params.emplace_back( new PARAM<double>( "plot.ps_fine_width_adjust",
548
549 m_params.emplace_back( new PARAM<bool>( "plot.check_zones_before_plotting",
551
552 m_params.emplace_back( new PARAM<bool>( "plot.mirror",
553 &m_Plot.mirror, false ) );
554
555 m_params.emplace_back( new PARAM<bool>( "plot.as_item_checkboxes",
556 &m_Plot.as_item_checkboxes, false ) );
557
558 m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
559 &m_FootprintTextShownColumns, "0 1 2 3 4 5 7" ) );
560
561 m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.width",
563
564 m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.height",
566
567 m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_sort_on_modules",
569 m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_front_prefix",
571 m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_back_prefix",
573 m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_exclude_locked",
574 &m_Reannotate.exclude_locked, false ) );
575
576 m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_grid_index",
577 &m_Reannotate.grid_index, 0 ) );
578 m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_sort_code",
579 &m_Reannotate.sort_code, 0 ) );
580 m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_choice",
582 m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_report_severity",
584
585 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_refdes_start",
587 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_refdes_start",
589 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_prefix",
590 &m_Reannotate.front_prefix, "" ) );
591 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_prefix",
592 &m_Reannotate.back_prefix, "" ) );
593 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_exclude_list",
594 &m_Reannotate.exclude_list, "" ) );
595 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_report_file_name",
597
598 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "action_plugins",
599 [&]() -> nlohmann::json
600 {
601 nlohmann::json js = nlohmann::json::array();
602
603 for( const auto& pair : m_VisibleActionPlugins )
604 js.push_back( nlohmann::json( { { pair.first.ToUTF8(), pair.second } } ) );
605
606 return js;
607 },
608 [&]( const nlohmann::json& aObj )
609 {
611
612 if( !aObj.is_array() )
613 {
614 return;
615 }
616
617 for( const auto& entry : aObj )
618 {
619 if( entry.empty() || !entry.is_object() )
620 continue;
621
622 for( const auto& pair : entry.items() )
623 {
624 m_VisibleActionPlugins.emplace_back( std::make_pair(
625 wxString( pair.key().c_str(), wxConvUTF8 ), pair.value() ) );
626 }
627 }
628 },
629 nlohmann::json::array() ) );
630
631 addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
632
633 m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
634 &m_FootprintViewerZoom, 1.0 ) );
635
636 m_params.emplace_back( new PARAM<bool>( "footprint_viewer.autozoom",
638
639 m_params.emplace_back( new PARAM<int>( "footprint_viewer.lib_list_width",
641
642 m_params.emplace_back( new PARAM<int>( "footprint_viewer.fp_list_width",
644
645 addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
646
647 m_params.emplace_back( new PARAM<wxString>( "system.last_footprint_lib_dir",
648 &m_lastFootprintLibDir, "" ) );
649
650 m_params.emplace_back( new PARAM<wxString>( "system.last_footprint3d_dir",
651 &m_lastFootprint3dDir, "" ) );
652
653 registerMigration( 0, 1,
654 [&]()
655 {
656 if( std::optional<int> optval = Get<int>( "pcb_display.rotation_angle" ) )
657 Set( "editing.rotation_angle", *optval );
658
659 try
660 {
661 At( "pcb_display" ).erase( "rotation_angle" );
662 }
663 catch( ... )
664 {}
665
666 return true;
667 } );
668
669 registerMigration( 1, 2,
670 [&]()
671 {
672 // In version 1 this meant "after Zone Properties dialog", but it now means
673 // "everywhere" so we knock it off on transition.
674 Set( "editing.auto_fill_zones", false );
675
676 return true;
677 } );
678
679
680 registerMigration( 2, 3,
681 [&]() -> bool
682 {
683 // We used to have a bug on GTK which would set the lib tree column width way
684 // too narrow.
685 if( std::optional<int> optval = Get<int>( "lib_tree.column_width" ) )
686 {
687 if( optval < 150 )
688 Set( "lib_tree.column_width", 300 );
689 }
690
691 return true;
692 } );
693
694 registerMigration( 3, 4,
695 [&]() -> bool
696 {
697 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
698 return migrateLibTreeWidth();
699 } );
700
701 registerMigration( 4, 5,
702 [&]() -> bool
703 {
704 // This default proved to be unpopular; bump it off for everyone
705 Set( "editing.auto_fill_zones", false );
706 return true;
707 } );
708}
709
710
712
713
714bool PCBNEW_SETTINGS::MigrateFromLegacy( wxConfigBase* aCfg )
715{
716 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
717
718 const std::string f = getLegacyFrameName();
719
720 //
721 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
722 //
723 ret &= fromLegacy<bool>( aCfg, "ShowLayerManagerTools", "aui.show_layer_manager" );
724
725 ret &= fromLegacy<int>( aCfg, "FootprintChooserHSashPosition", "footprint_chooser.sash_h" );
726 ret &= fromLegacy<int>( aCfg, "FootprintChooserVSashPosition", "footprint_chooser.sash_v" );
727 ret &= fromLegacy<int>( aCfg, "FootprintChooserWidth", "footprint_chooser.width" );
728 ret &= fromLegacy<int>( aCfg, "FootprintChooserHeight", "footprint_chooser.height" );
729
730 ret &= fromLegacy<bool>( aCfg, "FlipLeftRight", "editing.flip_left_right" );
731 ret &= fromLegacy<bool>( aCfg, "MagneticGraphics", "editing.magnetic_graphics" );
732 ret &= fromLegacy<int>( aCfg, "MagneticPads", "editing.magnetic_pads" );
733 ret &= fromLegacy<int>( aCfg, "MagneticTracks", "editing.magnetic_tracks" );
734 ret &= fromLegacy<bool>( aCfg, "DisplayPolarCoords", "editing.polar_coords" );
735 ret &= fromLegacy<bool>( aCfg, "Use45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
736
737 ret &= fromLegacy<bool>( aCfg, "PcbAffT", "pcb_display.graphic_items_fill" );
738 ret &= fromLegacy<int>( aCfg, "MaxLnkS", "pcb_display.max_links_shown" );
739 ret &= fromLegacy<bool>( aCfg, "ModAffC", "pcb_display.footprint_edge_fill" );
740 ret &= fromLegacy<bool>( aCfg, "ModAffT", "pcb_display.footprint_text_fill" );
741 ret &= fromLegacy<int>( aCfg, "ShowNetNamesMode", "pcb_display.net_names_mode" );
742 ret &= fromLegacy<int>( aCfg, "PcbDisplayOrigin", "pcb_display.origin_mode" );
743 ret &= fromLegacy<bool>( aCfg, "PcbInvertXAxis", "pcb_display.origin_invert_x_axis" );
744 ret &= fromLegacy<bool>( aCfg, "PcbInvertYAxis", "pcb_display.origin_invert_y_axis" );
745 ret &= fromLegacy<bool>( aCfg, "PadAffG", "pcb_display.pad_clearance" );
746 ret &= fromLegacy<bool>( aCfg, "PadFill", "pcb_display.pad_fill" );
747 ret &= fromLegacy<bool>( aCfg, "PadSNum", "pcb_display.pad_numbers" );
748 ret &= fromLegacy<bool>( aCfg, "ShowRatsnestLines", "pcb_display.ratsnest_global" );
749 ret &= fromLegacy<bool>( aCfg, "ShowRatsnestModuleLines", "pcb_display.ratsnest_footprint" );
750 ret &= fromLegacy<bool>( aCfg, "CurvedRatsnestLines", "pcb_display.ratsnest_curved" );
751 ret &= fromLegacy<int>( aCfg, "RotationAngle", "pcb_display.rotation_angle" );
752 ret &= fromLegacy<int>( aCfg, "TrackDisplayClearance", "pcb_display.track_clearance_mode" );
753 ret &= fromLegacy<bool>( aCfg, "DisplayTrackFilled", "pcb_display.track_fill" );
754 ret &= fromLegacy<bool>( aCfg, "ViaFill", "pcb_display.via_fill" );
755 ret &= fromLegacy<int>( aCfg, "PcbShowZonesMode", "pcb_display.zone_mode" );
756
757 ret &= fromLegacy<double>( aCfg, "PlotLineWidth_mm", "plot.line_width" );
758
759 aCfg->SetPath( "/dialogs/cleanup_tracks" );
760 ret &= fromLegacy<bool>( aCfg, "DialogCleanupVias", "cleanup.cleanup_vias" );
761 ret &= fromLegacy<bool>( aCfg, "DialogCleanupMergeSegments", "cleanup.merge_segments" );
762 ret &= fromLegacy<bool>( aCfg, "DialogCleanupUnconnected", "cleanup.cleanup_unconnected" );
763 ret &= fromLegacy<bool>( aCfg, "DialogCleanupShortCircuit", "cleanup.cleanup_short_circuits" );
764 ret &= fromLegacy<bool>( aCfg, "DialogCleanupTracksInPads", "cleanup.cleanup_tracks_in_pad" );
765 aCfg->SetPath( "../.." );
766
767 ret &= fromLegacy<bool>( aCfg, "RefillZonesBeforeDrc", "drc_dialog.refill_zones" );
768 ret &= fromLegacy<bool>( aCfg, "DrcTestFootprints", "drc_dialog.test_footprints" );
769
770 ret &= fromLegacy<bool>( aCfg, "DrillMergePTHNPTH", "gen_drill.merge_pth_npth" );
771 ret &= fromLegacy<bool>( aCfg, "DrillMinHeader", "gen_drill.minimal_header" );
772 ret &= fromLegacy<bool>( aCfg, "DrillMirrorYOpt", "gen_drill.mirror" );
773 ret &= fromLegacy<bool>( aCfg, "DrillUnit", "gen_drill.unit_drill_is_inch" );
774 ret &= fromLegacy<bool>( aCfg, "OvalHolesRouteMode", "gen_drill.use_route_for_oval_holes" );
775 ret &= fromLegacy<int>( aCfg, "DrillFileType", "gen_drill.drill_file_type" );
776 ret &= fromLegacy<int>( aCfg, "DrillMapFileType", "gen_drill.map_file_type" );
777 ret &= fromLegacy<int>( aCfg, "DrillZerosFormat", "gen_drill.zeros_format" );
778
779 ret &= fromLegacy<bool>( aCfg, "IDFRefAutoAdj", "export_idf.auto_adjust" );
780 ret &= fromLegacy<int>( aCfg, "IDFRefUnits", "export_idf.ref_units" );
781 ret &= fromLegacy<double>( aCfg, "IDFRefX", "export_idf.ref_x" );
782 ret &= fromLegacy<double>( aCfg, "IDFRefY", "export_idf.ref_y" );
783 ret &= fromLegacy<bool>( aCfg, "IDFExportThou", "export_idf.units_mils" );
784
785 ret &= fromLegacy<int>( aCfg, "STEP_Origin_Opt", "export_step.origin_mode" );
786 ret &= fromLegacy<int>( aCfg, "STEP_UserOriginUnits", "export_step.origin_units" );
787 ret &= fromLegacy<double>( aCfg, "STEP_UserOriginX", "export_step.origin_x" );
788 ret &= fromLegacy<double>( aCfg, "STEP_UserOriginY", "export_step.origin_y" );
789 ret &= fromLegacy<bool>( aCfg, "STEP_NoVirtual", "export_step.no_virtual" );
790
791 ret &= fromLegacy<bool>( aCfg, "PlotSVGModeColor", "export_svg.black_and_white" );
792 ret &= fromLegacy<bool>( aCfg, "PlotSVGModeMirror", "export_svg.mirror" );
793 ret &= fromLegacy<bool>( aCfg, "PlotSVGModeOneFile", "export_svg.one_file" );
794 ret &= fromLegacy<bool>( aCfg, "PlotSVGBrdEdge", "export_svg.plot_board_edges" );
795 ret &= fromLegacy<int>( aCfg, "PlotSVGPageOpt", "export_svg.page_size" );
796 ret &= fromLegacyString( aCfg, "PlotSVGDirectory", "export_svg.output_dir" );
797
798 {
799 nlohmann::json js = nlohmann::json::array();
800 wxString key;
801 bool val = false;
802
803 for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
804 {
805 key.Printf( wxT( "PlotSVGLayer_%d" ), i );
806
807 if( aCfg->Read( key, &val ) && val )
808 js.push_back( i );
809 }
810
811 Set( "export_svg.layers", js );
812 }
813
814 {
815 nlohmann::json js = nlohmann::json::array();
816
817 wxString packed;
818
819 if( aCfg->Read( "ActionPluginButtons", &packed ) )
820 {
821 wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( packed, ";" );
822
823 while( pluginSettingsTokenizer.HasMoreTokens() )
824 {
825 nlohmann::json row;
826 wxString plugin = pluginSettingsTokenizer.GetNextToken();
827 wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" );
828
829 if( pluginTokenizer.CountTokens() != 2 )
830 {
831 // Bad config
832 continue;
833 }
834
835 std::string key( pluginTokenizer.GetNextToken().ToUTF8() );
836 bool value( pluginTokenizer.GetNextToken().Cmp( wxT( "Visible" ) ) == 0 );
837
838 js.push_back( nlohmann::json( { { key, value } } ) );
839 }
840 }
841
842 Set( "action_plugins", js );
843 }
844
845 //
846 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
847 //
848 ret &= fromLegacy<int>( aCfg, "VrmlExportUnit", "export_vrml.units" );
849 ret &= fromLegacy<bool>( aCfg, "VrmlExportCopyFiles", "export_vrml.copy_3d_models" );
850 ret &= fromLegacy<bool>( aCfg, "VrmlUseRelativePaths", "export_vrml.use_relative_paths" );
851 ret &= fromLegacy<int>( aCfg, "VrmlRefUnits", "export_vrml.ref_units" );
852 ret &= fromLegacy<double>( aCfg, "VrmlRefX", "export_vrml.ref_x" );
853 ret &= fromLegacy<double>( aCfg, "VrmlRefY", "export_vrml.ref_y" );
854 ret &= fromLegacy<int> ( aCfg, "VrmlOriginMode", "export_vrml.origin_mode" );
855
856 ret &= fromLegacy<int>( aCfg, "Zone_Ouline_Hatch_Opt", "zones.hatching_style" );
857 ret &= fromLegacy<int>( aCfg, "Zone_NetSort_Opt", "zones.net_sort_mode" );
858 ret &= fromLegacy<double>( aCfg, "Zone_Clearance", "zones.clearance" );
859 ret &= fromLegacy<double>( aCfg, "Zone_Thickness", "zones.min_thickness" );
860 ret &= fromLegacy<double>( aCfg, "Zone_TH_Gap", "zones.thermal_relief_gap" );
861 ret &= fromLegacy<double>( aCfg, "Zone_TH_Copper_Width", "zones.thermal_relief_copper_width" );
862
863 aCfg->SetPath( "ImportGraphics" );
864 ret &= fromLegacy<int>( aCfg, "BoardLayer", "import_graphics.layer" );
865 ret &= fromLegacy<bool>( aCfg, "InteractivePlacement", "import_graphics.interactive_placement" );
866 ret &= fromLegacyString( aCfg, "LastFile", "import_graphics.last_file" );
867 ret &= fromLegacy<double>( aCfg, "LineWidth", "import_graphics.line_width" );
868 ret &= fromLegacy<int>( aCfg, "LineWidthUnits", "import_graphics.line_width_units" );
869 ret &= fromLegacy<int>( aCfg, "PositionUnits", "import_graphics.origin_units" );
870 ret &= fromLegacy<double>( aCfg, "PositionX", "import_graphics.origin_x" );
871 ret &= fromLegacy<double>( aCfg, "PositionY", "import_graphics.origin_y" );
872 aCfg->SetPath( ".." );
873
874 ret &= fromLegacy<int>( aCfg, "NetlistReportFilterMsg", "netlist.report_filter" );
875 ret &= fromLegacy<bool>( aCfg, "NetlistUpdateFootprints", "netlist.update_footprints" );
876 ret &= fromLegacy<bool>( aCfg, "NetlistDeleteShortingTracks", "netlist.delete_shorting_tracks" );
877 ret &= fromLegacy<bool>( aCfg, "NetlistDeleteExtraFootprints", "netlist.delete_extra_footprints" );
878
879 ret &= fromLegacy<int>( aCfg, "PlaceFileUnits", "place_file.units" );
880 ret &= fromLegacy<int>( aCfg, "PlaceFileOpts", "place_file.file_options" );
881 ret &= fromLegacy<int>( aCfg, "PlaceFileFormat", "place_file.file_format" );
882 ret &= fromLegacy<bool>( aCfg, "PlaceFileIncludeBrdEdge", "place_file.include_board_edge" );
883
884 ret &= fromLegacy<int>( aCfg, "PrintSinglePage", "plot.all_layers_on_one_page" );
885 ret &= fromLegacy<int>( aCfg, "PrintPadsDrillOpt", "plot.pads_drill_mode" );
886 ret &= fromLegacy<double>( aCfg, "PlotXFineScaleAdj", "plot.fine_scale_x" );
887 ret &= fromLegacy<double>( aCfg, "PlotYFineScaleAdj", "plot.fine_scale_y" );
888 ret &= fromLegacy<double>( aCfg, "PSPlotFineWidthAdj", "plot.ps_fine_width_adjust" );
889 ret &= fromLegacy<bool>( aCfg, "CheckZonesBeforePlotting", "plot.check_zones_before_plotting" );
890
891 ret &= fromLegacyString( aCfg, "FootprintTextShownColumns", "window.footprint_text_shown_columns" );
892
893 ret &= fromLegacy<int>( aCfg, "FpWizardListWidth", "footprint_wizard_list.width" );
894 ret &= fromLegacy<int>( aCfg, "FpWizardListHeight", "footprint_wizard_list.height" );
895
896 migrateWindowConfig( aCfg, "ModViewFrame", "footprint_viewer" );
897
898 ret &= fromLegacy<bool>( aCfg, "ModViewFrameAutoZoom", "footprint_viewer.auto_zoom" );
899 ret &= fromLegacy<double>( aCfg, "ModViewFrameZoom", "footprint_viewer.zoom" );
900
901 migrateWindowConfig( aCfg, "FootprintWizard", "footprint_wizard" );
902 ret &= fromLegacyString( aCfg, "Fpwizard_auiPerspective", "footprint_wizard.perspective" );
903
904
905 const std::string p = "pcbnew.InteractiveRouter.";
906
907 Set( "tools.pns.meta", nlohmann::json( {
908 { "filename", "pns" },
909 { "version", 0 }
910 } ) );
911
912 ret &= fromLegacy<int>( aCfg, p + "Mode", "tools.pns.mode" );
913 ret &= fromLegacy<int>( aCfg, p + "OptimizerEffort", "tools.pns.effort" );
914 ret &= fromLegacy<bool>( aCfg, p + "RemoveLoops", "tools.pns.remove_loops" );
915 ret &= fromLegacy<bool>( aCfg, p + "SmartPads", "tools.pns.smart_pads" );
916 ret &= fromLegacy<bool>( aCfg, p + "ShoveVias", "tools.pns.shove_vias" );
917 ret &= fromLegacy<bool>( aCfg, p + "StartDiagonal", "tools.pns.start_diagonal" );
918 ret &= fromLegacy<int>( aCfg, p + "ShoveTimeLimit", "tools.pns.shove_time_limit" );
919 ret &= fromLegacy<int>( aCfg, p + "ShoveIterationLimit", "tools.pns.shove_iteration_limit" );
920 ret &= fromLegacy<int>( aCfg, p + "WalkaroundIterationLimit", "tools.pns.walkaround_iteration_limit" );
921 ret &= fromLegacy<bool>( aCfg, p + "JumpOverObstacles", "tools.pns.jump_over_obstacles" );
922 ret &= fromLegacy<bool>( aCfg, p + "SmoothDraggedSegments", "tools.pns.smooth_dragged_segments" );
923 ret &= fromLegacy<bool>( aCfg, p + "CanViolateDRC", "tools.pns.can_violate_drc" );
924 ret &= fromLegacy<bool>( aCfg, p + "SuggestFinish", "tools.pns.suggest_finish" );
925 ret &= fromLegacy<bool>( aCfg, p + "FreeAngleMode", "tools.pns.free_angle_mode" );
926 ret &= fromLegacy<bool>( aCfg, p + "InlineDragEnabled", "editing.track_drag_action" );
927
928 // Initialize some new PNS settings to legacy behaviors if coming from legacy
929 Set( "tools.pns.fix_all_segments", false );
930
931 // Migrate color settings that were stored in the pcbnew config file
932
934
935 auto migrateLegacyColor =
936 [&] ( const std::string& aKey, int aLayerId )
937 {
938 wxString str;
939
940 if( aCfg->Read( aKey, &str ) )
941 cs->SetColor( aLayerId, COLOR4D( str ) );
942 };
943
944 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
945 {
946 wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
947 migrateLegacyColor( "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
948 }
949
950 migrateLegacyColor( "Color4DAnchorEx", LAYER_ANCHOR );
951 migrateLegacyColor( "Color4DAuxItems", LAYER_AUX_ITEMS );
952 migrateLegacyColor( "Color4DGrid", LAYER_GRID );
953 migrateLegacyColor( "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
954 migrateLegacyColor( "Color4DPadThruHoleEx", LAYER_PADS_TH );
955 migrateLegacyColor( "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
956 migrateLegacyColor( "Color4DPCBCursor", LAYER_CURSOR );
957 migrateLegacyColor( "Color4DRatsEx", LAYER_RATSNEST );
958 migrateLegacyColor( "Color4DTxtInvisEx", LAYER_HIDDEN_TEXT );
959 migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
960 migrateLegacyColor( "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
961 migrateLegacyColor( "Color4DViaThruEx", LAYER_VIA_THROUGH );
962 migrateLegacyColor( "Color4DWorksheet", LAYER_DRAWINGSHEET );
963 migrateLegacyColor( "Color4DGrid", LAYER_PAGE_LIMITS );
964
965 Pgm().GetSettingsManager().SaveColorSettings( cs, "board" );
966
967 Set( "appearance.color_theme", cs->GetFilename() );
968
969 double x = 0, y = 0;
970
971 if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
972 {
973 EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
974 static_cast<long>( EDA_UNITS::INCHES ) ) );
975
976 // Convert to internal units
979
980 Set( "window.grid.user_grid_x", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, x ) );
981 Set( "window.grid.user_grid_y", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, y ) );
982 }
983
984 // Footprint editor settings were stored in pcbnew config file. Migrate them here.
986 fpedit->MigrateFromLegacy( aCfg );
987 fpedit->Load();
988
989 // Same with 3D viewer
991 viewer3d->MigrateFromLegacy( aCfg );
992 viewer3d->Load();
993
994 return ret;
995}
996
997//namespace py = pybind11;
998//
999//PYBIND11_MODULE( pcbnew, m )
1000//{
1001// py::class_<PCBNEW_SETTINGS>( m, "settings" )
1002// .def_readwrite( "Use45DegreeGraphicSegments", &PCBNEW_SETTINGS::m_Use45DegreeGraphicSegments )
1003// .def_readwrite( "FlipLeftRight", &PCBNEW_SETTINGS::m_FlipLeftRight )
1004// .def_readwrite( "AddUnlockedPads", &PCBNEW_SETTINGS::m_AddUnlockedPads)
1005// .def_readwrite( "UsePolarCoords", &PCBNEW_SETTINGS::m_PolarCoords)
1006// .def_readwrite( "RotationAngle", &PCBNEW_SETTINGS::m_RotationAngle)
1007// .def_readwrite( "ShowPageLimits", &PCBNEW_SETTINGS::m_ShowPageLimits)
1008// ;
1009//}
ARC_EDIT_MODE
Settings for arc editing.
Definition: app_settings.h:52
@ KEEP_CENTER_ADJUST_ANGLE_RADIUS
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
bool migrateWindowConfig(wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
Migrates legacy window settings into the JSON document.
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
void addParamsForWindow(WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
Adds parameters for the given window object.
bool migrateLibTreeWidth()
Migrates the library tree width setting from a single column (Item) to multi-column.
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetColor(int aLayer, const COLOR4D &aColor)
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
int AsTenthsOfADegree() const
Definition: eda_angle.h:115
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
wxString GetFilename() const
Definition: json_settings.h:80
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:89
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:293
DIALOG_EXPORT_2581 m_Export2581
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
DIALOG_EXPORT_SVG m_ExportSvg
wxString m_FootprintTextShownColumns
int m_FootprintViewerLibListWidth
VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
T * GetAppSettings()
Returns a handle to the a given settings by type If the settings have already been loaded,...
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely saves a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
COLOR_SETTINGS * GetMigratedColorSettings()
Returns a color theme for storing colors migrated from legacy (5.x and earlier) settings,...
The common library.
static constexpr EDA_ANGLE ANGLE_90
Definition: eda_angle.h:403
@ TENTHS_OF_A_DEGREE_T
Definition: eda_angle.h:30
static constexpr EDA_ANGLE ANGLE_360
Definition: eda_angle.h:407
EDA_UNITS
Definition: eda_units.h:46
@ LAYER_GRID
Definition: layer_ids.h:209
@ LAYER_PAGE_LIMITS
color for drawing the page extents (visibility stored in PCBNEW_SETTINGS::m_ShowPageLimits)
Definition: layer_ids.h:253
@ LAYER_NON_PLATEDHOLES
handle color for not plated holes (holes, not pads)
Definition: layer_ids.h:201
@ LAYER_DRAWINGSHEET
drawingsheet frame and titleblock
Definition: layer_ids.h:221
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition: layer_ids.h:224
@ LAYER_HIDDEN_TEXT
text marked as invisible
Definition: layer_ids.h:204
@ LAYER_CURSOR
PCB cursor.
Definition: layer_ids.h:225
@ LAYER_AUX_ITEMS
Auxiliary items (guides, rule, etc)
Definition: layer_ids.h:226
@ LAYER_RATSNEST
Definition: layer_ids.h:208
@ LAYER_ANCHOR
anchor of items having an anchor point (texts, footprints)
Definition: layer_ids.h:205
@ LAYER_PADS_TH
multilayer pads, usually with holes
Definition: layer_ids.h:217
@ LAYER_VIA_MICROVIA
to draw micro vias
Definition: layer_ids.h:198
@ LAYER_VIA_THROUGH
to draw usual through hole vias
Definition: layer_ids.h:200
@ LAYER_VIA_BBLIND
to draw blind/buried vias
Definition: layer_ids.h:199
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ Dwgs_User
Definition: layer_ids.h:109
@ PCB_LAYER_ID_COUNT
Definition: layer_ids.h:137
KICOMMON_API double FromUserUnit(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnit, double aValue)
Return in internal units the value aValue given in a real unit such as "in", "mm",...
Definition: eda_units.cpp:510
KICOMMON_API wxString StringFromValue(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Returns the string from aValue according to aUnits (inch, mm ...) for display.
Definition: eda_units.cpp:300
const int pcbnewSchemaVersion
! Update the schema version whenever a migration is required
@ SHOW_WITH_VIA_WHILE_ROUTING
TRACK_DRAG_ACTION
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
MAGNETIC_OPTIONS tracks
MAGNETIC_OPTIONS pads
TRACK_CLEARANCE_MODE m_TrackClearance
Functions to provide common constants and other functions to assist in making a consistent UI.