KiCad PCB EDA Suite
Loading...
Searching...
No Matches
footprint_editor_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 Jon Evans <[email protected]>
5 * Copyright The 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
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
22
25#include <common.h>
26#include <layer_ids.h>
27#include <lset.h>
28#include <pgm_base.h>
29#include <eda_text.h>
30#include <pcb_dimension.h>
33#include <settings/parameters.h>
35#include <base_units.h>
36
37#include <wx/config.h>
38#include <wx/log.h>
39
40
42const int fpEditSchemaVersion = 5;
43
44
47 m_DesignSettings( nullptr, "fpedit.settings" ),
49 m_Display(),
50 m_UserGrid(),
51 m_PolarCoords( false ),
52 m_DisplayInvertXAxis( false ),
53 m_DisplayInvertYAxis( false ),
57 m_LibWidth( 250 ),
59{
62 m_MagneticItems.graphics = true;
63 m_MagneticItems.allLayers = false;
64
65 m_AuiPanels.appearance_panel_tab = 0;
66 m_AuiPanels.right_panel_width = -1;
67 m_AuiPanels.show_layer_manager = true;
68
69 m_params.emplace_back( new PARAM<int>( "window.lib_width",
70 &m_LibWidth, 250 ) );
71
72 m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
73 &m_AuiPanels.show_layer_manager, true ) );
74
75 m_params.emplace_back( new PARAM<int>( "aui.right_panel_width",
76 &m_AuiPanels.right_panel_width, -1 ) );
77
78 m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
79 &m_AuiPanels.appearance_panel_tab, 0, 0, 2 ) );
80
81 m_params.emplace_back( new PARAM<int>( "aui.properties_panel_width",
82 &m_AuiPanels.properties_panel_width, -1 ) );
83
84 m_params.emplace_back( new PARAM<float>( "aui.properties_splitter_proportion",
85 &m_AuiPanels.properties_splitter, 0.5f ) );
86
87 m_params.emplace_back( new PARAM<bool>( "aui.show_properties",
88 &m_AuiPanels.show_properties, true ) );
89
90 m_params.emplace_back( new PARAM<int>( "library.sort_mode",
91 &m_LibrarySortMode, 0 ) );
92
93 m_params.emplace_back( new PARAM<wxString>( "system.last_import_export_path",
94 &m_LastExportPath, "" ) );
95
96 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphics_fill",
97 &m_ViewersDisplay.m_DisplayGraphicsFill, true ) );
98
99 m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
100 &m_ViewersDisplay.m_DisplayTextFill, true ) );
101
102 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
103 &m_ViewersDisplay.m_DisplayPadFill, true ) );
104
105 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_numbers",
106 &m_ViewersDisplay.m_DisplayPadNumbers, true ) );
107
108 m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
109 reinterpret_cast<int*>( &m_MagneticItems.pads ),
110 static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_ALWAYS ) ) );
111
112 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
113 &m_MagneticItems.graphics, true ) );
114
115 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_all_layers",
116 &m_MagneticItems.allLayers, false ) );
117
118 m_params.emplace_back( new PARAM<bool>( "editing.polar_coords",
119 &m_PolarCoords, false ) );
120
121 m_params.emplace_back( new PARAM<bool>( "origin_invert_x_axis",
122 &m_DisplayInvertXAxis, false ) );
123
124 m_params.emplace_back( new PARAM<bool>( "origin_invert_y_axis",
125 &m_DisplayInvertYAxis, false ) );
126
127 m_params.emplace_back( new PARAM_LAMBDA<int>( "editing.rotation_angle",
128 [this] () -> int
129 {
130 return m_RotationAngle.AsTenthsOfADegree();
131 },
132 [this] ( int aVal )
133 {
134 if( aVal )
135 m_RotationAngle = EDA_ANGLE( aVal, TENTHS_OF_A_DEGREE_T );
136 },
137 900 ) );
138
139 m_params.emplace_back( new PARAM<int>( "editing.fp_angle_snap_mode",
140 reinterpret_cast<int*>( &m_AngleSnapMode ),
141 static_cast<int>( LEADER_MODE::DEG45 ) ) );
142
143 m_params.emplace_back( new PARAM_LAYER_PRESET( "pcb_display.layer_presets", &m_LayerPresets ) );
144
145 m_params.emplace_back( new PARAM<wxString>( "pcb_display.active_layer_preset",
146 &m_ActiveLayerPreset, "" ) );
147
148 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "tabs.open",
149 [&]() -> nlohmann::json
150 {
151 nlohmann::json js = nlohmann::json::array();
152
153 for( const OPEN_TAB& tab : m_OpenTabs )
154 {
155 js.push_back( nlohmann::json( { { "lib", tab.m_lib.ToUTF8() },
156 { "fp_name", tab.m_fpName.ToUTF8() },
157 { "preview", tab.m_preview } } ) );
158 }
159
160 return js;
161 },
162 [&]( const nlohmann::json& aObj )
163 {
164 m_OpenTabs.clear();
165
166 if( !aObj.is_array() )
167 return;
168
169 for( const nlohmann::json& entry : aObj )
170 {
171 if( !entry.is_object() || !entry.contains( "lib" ) || !entry.contains( "fp_name" ) )
172 continue;
173
174 OPEN_TAB tab;
175 tab.m_lib = entry.at( "lib" ).get<wxString>();
176 tab.m_fpName = entry.at( "fp_name" ).get<wxString>();
177
178 // Older configs predate the preview flag and default to a permanent tab.
179 if( entry.contains( "preview" ) )
180 tab.m_preview = entry.at( "preview" ).get<bool>();
181
182 m_OpenTabs.push_back( std::move( tab ) );
183 }
184 },
185 nlohmann::json::array() ) );
186
187 m_params.emplace_back( new PARAM<wxString>( "tabs.active",
188 &m_ActiveTab, "" ) );
189
190 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>(
191 "design_settings.default_footprint_text_items",
192 [&] () -> nlohmann::json
193 {
194 nlohmann::json js = nlohmann::json::array();
195
196 for( const TEXT_ITEM_INFO& item : m_DesignSettings.m_DefaultFPTextItems )
197 {
198 js.push_back( nlohmann::json( { item.m_Text.ToUTF8(),
199 item.m_Visible,
200 LSET::Name( item.m_Layer ) } ) );
201 }
202
203 return js;
204 },
205 [&] ( const nlohmann::json& aObj )
206 {
207 m_DesignSettings.m_DefaultFPTextItems.clear();
208
209 if( !aObj.is_array() )
210 return;
211
212 for( const nlohmann::json& entry : aObj )
213 {
214 if( entry.empty() || !entry.is_array() )
215 continue;
216
217 TEXT_ITEM_INFO textInfo( wxT( "" ), true, F_SilkS );
218
219 textInfo.m_Text = entry.at(0).get<wxString>();
220 textInfo.m_Visible = entry.at(1).get<bool>();
221 wxString layerName = entry.at(2).get<wxString>();
222 int candidateLayer = LSET::NameToLayer( layerName );
223 textInfo.m_Layer = candidateLayer >= 0
224 ? static_cast<PCB_LAYER_ID>(candidateLayer)
225 : F_SilkS;
226
227 m_DesignSettings.m_DefaultFPTextItems.push_back( std::move( textInfo ) );
228 }
229 },
230 nlohmann::json::array( {
231 { "REF**", true, LSET::Name( F_SilkS ) },
232 { "", true, LSET::Name( F_Fab ) },
233 { "${REFERENCE}", true, LSET::Name( F_Fab ) }
234 } ) ) );
235
236 m_params.emplace_back( new PARAM_MAP<wxString>( "design_settings.default_footprint_layer_names",
237 &m_DesignSettings.m_UserLayerNames, {} ) );
238
239 m_params.emplace_back( new PARAM_LAMBDA<int>( "design_settings.user_layer_count",
240 [this]() { return m_DesignSettings.GetUserDefinedLayerCount(); },
241 [this]( int aCount ) { m_DesignSettings.SetUserDefinedLayerCount( aCount ); },
242 4 ) );
243
244 int minTextSize = pcbIUScale.mmToIU( TEXT_MIN_SIZE_MM );
245 int maxTextSize = pcbIUScale.mmToIU( TEXT_MAX_SIZE_MM );
246 int minStroke = 1;
247 int maxStroke = pcbIUScale.mmToIU( 100 );
248
249 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_line_width",
250 &m_DesignSettings.m_LineThickness[ LAYER_CLASS_SILK ],
251 pcbIUScale.mmToIU( DEFAULT_SILK_LINE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
252
253 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_h",
254 &m_DesignSettings.m_TextSize[ LAYER_CLASS_SILK ].x,
255 pcbIUScale.mmToIU( DEFAULT_SILK_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
256
257 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_v",
258 &m_DesignSettings.m_TextSize[ LAYER_CLASS_SILK ].y,
259 pcbIUScale.mmToIU( DEFAULT_SILK_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
260
261 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_thickness",
262 &m_DesignSettings.m_TextThickness[ LAYER_CLASS_SILK ],
263 pcbIUScale.mmToIU( DEFAULT_SILK_TEXT_WIDTH ), 1, maxTextSize, pcbIUScale.MM_PER_IU ) );
264
265 m_params.emplace_back( new PARAM<bool>( "design_settings.silk_text_italic",
266 &m_DesignSettings.m_TextItalic[ LAYER_CLASS_SILK ], false ) );
267
268 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_line_width",
269 &m_DesignSettings.m_LineThickness[ LAYER_CLASS_COPPER ],
270 pcbIUScale.mmToIU( DEFAULT_COPPER_LINE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
271
272 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_h",
273 &m_DesignSettings.m_TextSize[ LAYER_CLASS_COPPER ].x,
274 pcbIUScale.mmToIU( DEFAULT_COPPER_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
275
276 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_v",
277 &m_DesignSettings.m_TextSize[ LAYER_CLASS_COPPER ].y,
278 pcbIUScale.mmToIU( DEFAULT_COPPER_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
279
280 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_thickness",
281 &m_DesignSettings.m_TextThickness[ LAYER_CLASS_COPPER ],
282 pcbIUScale.mmToIU( DEFAULT_COPPER_TEXT_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
283
284 m_params.emplace_back( new PARAM<bool>( "design_settings.copper_text_italic",
285 &m_DesignSettings.m_TextItalic[ LAYER_CLASS_COPPER ], false ) );
286
287 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.edge_line_width",
288 &m_DesignSettings.m_LineThickness[ LAYER_CLASS_EDGES ],
289 pcbIUScale.mmToIU( DEFAULT_EDGE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
290
291 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.courtyard_line_width",
292 &m_DesignSettings.m_LineThickness[ LAYER_CLASS_COURTYARD ],
293 pcbIUScale.mmToIU( DEFAULT_COURTYARD_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
294
295 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_line_width",
296 &m_DesignSettings.m_LineThickness[ LAYER_CLASS_FAB ],
297 pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
298
299 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_h",
300 &m_DesignSettings.m_TextSize[ LAYER_CLASS_FAB ].x,
301 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
302
303 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_v",
304 &m_DesignSettings.m_TextSize[ LAYER_CLASS_FAB ].y,
305 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
306
307 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_thickness",
308 &m_DesignSettings.m_TextThickness[ LAYER_CLASS_FAB ],
309 pcbIUScale.mmToIU( DEFAULT_TEXT_WIDTH ), 1, maxTextSize, pcbIUScale.MM_PER_IU ) );
310
311 m_params.emplace_back( new PARAM<bool>( "design_settings.fab_text_italic",
312 &m_DesignSettings.m_TextItalic[ LAYER_CLASS_FAB ], false ) );
313
314 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_line_width",
315 &m_DesignSettings.m_LineThickness[ LAYER_CLASS_OTHERS ],
316 pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
317
318 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_h",
319 &m_DesignSettings.m_TextSize[ LAYER_CLASS_OTHERS ].x,
320 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
321
322 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_v",
323 &m_DesignSettings.m_TextSize[ LAYER_CLASS_OTHERS ].y,
324 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
325
326 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_thickness",
327 &m_DesignSettings.m_TextThickness[ LAYER_CLASS_OTHERS ],
328 pcbIUScale.mmToIU( DEFAULT_TEXT_WIDTH ), 1, maxTextSize, pcbIUScale.MM_PER_IU ) );
329
330 m_params.emplace_back( new PARAM<bool>( "design_settings.others_text_italic",
331 &m_DesignSettings.m_TextItalic[ LAYER_CLASS_OTHERS ], false ) );
332
333
334 // ---------------------------------------------------------------------------------------------
335 // Dimension settings
336
337 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_MODE>( "design_settings.dimensions.units",
340
341 m_params.emplace_back( new PARAM_ENUM<DIM_PRECISION>( "design_settings.dimensions.precision",
343
344 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_FORMAT>( "design_settings.dimensions.units_format",
347
348 m_params.emplace_back( new PARAM<bool>( "design_settings.dimensions.suppress_zeroes",
349 &m_DesignSettings.m_DimensionSuppressZeroes, true ) );
350
351 // NOTE: excluding DIM_TEXT_POSITION::MANUAL from the valid range here
352 m_params.emplace_back( new PARAM_ENUM<DIM_TEXT_POSITION>( "design_settings.dimensions.text_position",
355
356 m_params.emplace_back( new PARAM<bool>( "design_settings.dimensions.keep_text_aligned",
357 &m_DesignSettings.m_DimensionKeepTextAligned, true ) );
358
359 m_params.emplace_back( new PARAM<int>( "design_settings.dimensions.arrow_length",
360 &m_DesignSettings.m_DimensionArrowLength,
362
363 m_params.emplace_back( new PARAM<int>( "design_settings.dimensions.extension_offset",
364 &m_DesignSettings.m_DimensionExtensionOffset,
366
367 // ---------------------------------------------------------------------------------------------
368
369 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "editing.selection_filter",
370 [&]() -> nlohmann::json
371 {
372 nlohmann::json ret;
373
374 ret["lockedItems"] = m_SelectionFilter.lockedItems;
375 ret["footprints"] = m_SelectionFilter.footprints;
376 ret["text"] = m_SelectionFilter.text;
377 ret["tracks"] = m_SelectionFilter.tracks;
378 ret["vias"] = m_SelectionFilter.vias;
379 ret["pads"] = m_SelectionFilter.pads;
380 ret["graphics"] = m_SelectionFilter.graphics;
381 ret["zones"] = m_SelectionFilter.zones;
382 ret["keepouts"] = m_SelectionFilter.keepouts;
383 ret["dimensions"] = m_SelectionFilter.dimensions;
384 ret["points"] = m_SelectionFilter.points;
385 ret["otherItems"] = m_SelectionFilter.otherItems;
386
387 return ret;
388 },
389 [&]( const nlohmann::json& aVal )
390 {
391 if( aVal.empty() || !aVal.is_object() )
392 return;
393
394 SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
395 SetIfPresent( aVal, "footprints", m_SelectionFilter.footprints );
396 SetIfPresent( aVal, "text", m_SelectionFilter.text );
397 SetIfPresent( aVal, "tracks", m_SelectionFilter.tracks );
398 SetIfPresent( aVal, "vias", m_SelectionFilter.vias );
399 SetIfPresent( aVal, "pads", m_SelectionFilter.pads );
400 SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
401 SetIfPresent( aVal, "zones", m_SelectionFilter.zones );
402 SetIfPresent( aVal, "keepouts", m_SelectionFilter.keepouts );
403 SetIfPresent( aVal, "dimensions", m_SelectionFilter.dimensions );
404 SetIfPresent( aVal, "points", m_SelectionFilter.points );
405 SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
406 },
407 {
408 { "lockedItems", false },
409 { "footprints", true },
410 { "text", true },
411 { "tracks", true },
412 { "vias", true },
413 { "pads", true },
414 { "graphics", true },
415 { "zones", true },
416 { "keepouts", true },
417 { "dimensions", true },
418 { "points", true },
419 { "otherItems", true }
420 } ) );
421
422 registerMigration( 0, 1, std::bind( &FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1, this ) );
423
424 registerMigration( 1, 2,
425 [&]() -> bool
426 {
427 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
428 return migrateLibTreeWidth();
429 } );
430
431 registerMigration( 2, 3, std::bind( &FOOTPRINT_EDITOR_SETTINGS::migrateSchema2To3, this ) );
432 registerMigration( 3, 4, std::bind( &FOOTPRINT_EDITOR_SETTINGS::migrateSchema3To4, this ) );
433 registerMigration( 4, 5, std::bind( &FOOTPRINT_EDITOR_SETTINGS::migrateSchema4To5, this ) );
434}
435
436
438{
439 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
440
441 //
442 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
443 //
444 ret &= fromLegacy<int>( aCfg, "ModeditLibWidth", "window.lib_width" );
445 ret &= fromLegacyString( aCfg, "import_last_path", "system.last_import_export_path" );
446
447 ret &= fromLegacy<int>( aCfg, "FpEditorMagneticPads", "editing.magnetic_pads" );
448 ret &= fromLegacy<bool>( aCfg, "FpEditorDisplayPolarCoords", "editing.polar_coords" );
449 ret &= fromLegacy<int>( aCfg, "FpEditorUse45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
450
451 ret &= fromLegacy<bool>( aCfg, "FpEditorGraphicLinesDisplayMode", "pcb_display.graphic_items_fill" );
452 ret &= fromLegacy<bool>( aCfg, "FpEditorPadDisplayMode", "pcb_display.pad_fill" );
453 ret &= fromLegacy<bool>( aCfg, "FpEditorTextsDisplayMode", "pcb_display.footprint_text" );
454
455 ret &= fromLegacy<double>( aCfg, "FpEditorSilkLineWidth", "design_settings.silk_line_width" );
456 ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeH", "design_settings.silk_text_size_h" );
457 ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeV", "design_settings.silk_text_size_v" );
458 ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextThickness", "design_settings.silk_text_thickness" );
459 ret &= fromLegacy<bool>( aCfg, "FpEditorSilkTextItalic", "design_settings.silk_text_italic" );
460 ret &= fromLegacy<double>( aCfg, "FpEditorCopperLineWidth", "design_settings.copper_line_width" );
461 ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeH", "design_settings.copper_text_size_h" );
462 ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeV", "design_settings.copper_text_size_v" );
463 ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextThickness", "design_settings.copper_text_thickness" );
464 ret &= fromLegacy<bool>( aCfg, "FpEditorCopperTextItalic", "design_settings.copper_text_italic" );
465 ret &= fromLegacy<double>( aCfg, "FpEditorEdgeCutLineWidth", "design_settings.edge_line_width" );
466 ret &= fromLegacy<double>( aCfg, "FpEditorCourtyardLineWidth", "design_settings.courtyard_line_width" );
467 ret &= fromLegacy<double>( aCfg, "FpEditorOthersLineWidth", "design_settings.others_line_width" );
468 ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeH", "design_settings.others_text_size_h" );
469 ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeV", "design_settings.others_text_size_v" );
470 ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextThickness", "design_settings.others_text_thickness" );
471 ret &= fromLegacy<bool>( aCfg, "FpEditorOthersTextItalic", "design_settings.others_text_italic" );
472
473 nlohmann::json textItems = nlohmann::json::array( {
474 { "REF**", true, F_SilkS },
475 { "", true, F_Fab }
476 } );
477
478 Set( "design_settings.default_footprint_text_items", std::move( textItems ) );
479
480 ret &= fromLegacyString( aCfg, "FpEditorRefDefaultText", "design_settings.default_footprint_text_items.0.0" );
481 ret &= fromLegacy<bool>( aCfg, "FpEditorRefDefaultVisibility", "design_settings.default_footprint_text_items.0.1" );
482 ret &= fromLegacy<int>( aCfg, "FpEditorRefDefaultLayer", "design_settings.default_footprint_text_items.0.2" );
483 ret &= fromLegacyString( aCfg, "FpEditorValueDefaultText", "design_settings.default_footprint_text_items.1.0" );
484 ret &= fromLegacy<bool>( aCfg, "FpEditorValueDefaultVisibility", "design_settings.default_footprint_text_items.1.1" );
485 ret &= fromLegacy<int>( aCfg, "FpEditorValueDefaultLayer", "design_settings.default_footprint_text_items.1.2" );
486
487
488 std::string f = "ModEdit";
489
490 // Migrate color settings that were stored in the pcbnew config file
491 // We create a copy of the user scheme for the footprint editor context
492
494 COLOR_SETTINGS* cs = manager.AddNewColorSettings( "user_footprints" );
495
496 cs->SetName( wxT( "User (Footprints)" ) );
497 manager.Save( cs );
498
499 auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId )
500 {
501 wxString str;
502
503 if( aCfg->Read( aKey, &str ) )
504 cs->SetColor( aLayerId, COLOR4D( str ) );
505 };
506
507 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
508 {
509 wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
510 migrateLegacyColor( f + "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
511 }
512
513 migrateLegacyColor( f + "Color4DAnchorEx", LAYER_ANCHOR );
514 migrateLegacyColor( f + "Color4DAuxItems", LAYER_AUX_ITEMS );
515 migrateLegacyColor( f + "Color4DGrid", LAYER_GRID );
516 migrateLegacyColor( f + "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
517 migrateLegacyColor( f + "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
518 migrateLegacyColor( f + "Color4DPCBCursor", LAYER_CURSOR );
519 migrateLegacyColor( f + "Color4DRatsEx", LAYER_RATSNEST );
520 migrateLegacyColor( f + "Color4DViaBBlindEx", LAYER_VIA_BLIND );
521 migrateLegacyColor( f + "Color4DViaBBlindEx", LAYER_VIA_BURIED );
522 migrateLegacyColor( f + "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
523 migrateLegacyColor( f + "Color4DViaThruEx", LAYER_VIA_THROUGH );
524 migrateLegacyColor( f + "Color4DWorksheet", LAYER_DRAWINGSHEET );
525
526 manager.SaveColorSettings( cs, "board" );
527
528 ( *m_internals )[m_internals->PointerFromString( "appearance.color_theme" )] = "user_footprints";
529
530 double x = 0, y = 0;
531 f = "ModEditFrame";
532
533 if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
534 {
535 EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
536 static_cast<long>( EDA_UNITS::INCH ) ) );
537
538 // Convert to internal units
541
542 Set( "window.grid.user_grid_x", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, x ) );
543 Set( "window.grid.user_grid_y", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, y ) );
544 }
545
546 return ret;
547}
548
549
551{
558
559 if( !m_manager )
560 {
561 wxLogTrace( traceSettings,
562 wxT( "Error: FOOTPRINT_EDITOR_SETTINGS migration cannot run unmanaged!" ) );
563 return false;
564 }
565
566 std::string theme_ptr( "appearance.color_theme" );
567
568 if( !Contains( theme_ptr ) )
569 return true;
570
571 wxString selected = At( theme_ptr ).get<wxString>();
572 wxString search = selected + wxT( "_footprints" );
573
574 for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
575 {
576 if( settings->GetFilename() == search )
577 {
578 wxLogTrace( traceSettings, wxT( "Updating footprint editor theme from %s to %s" ),
579 selected, search );
580 Set( theme_ptr, search );
581 return true;
582 }
583 }
584
585 return true;
586}
587
588
594{
595 auto p( "/pcb_display/layer_presets"_json_pointer );
596
597 if( !m_internals->contains( p ) || !m_internals->at( p ).is_array() )
598 return true;
599
600 nlohmann::json& presets = m_internals->at( p );
601
602 for( nlohmann::json& entry : presets )
604
605 return true;
606}
607
608
613{
614 auto p( "/pcb_display/layer_presets"_json_pointer );
615
616 if( !m_internals->contains( p ) || !m_internals->at( p ).is_array() )
617 return true;
618
619 nlohmann::json& presets = m_internals->at( p );
620
621 for( nlohmann::json& entry : presets )
623
624 return true;
625}
626
627
632{
633 auto p( "/design_settings/default_footprint_text_items"_json_pointer );
634
635 if( !m_internals->contains( p ) || !m_internals->at( p ).is_array() )
636 return true;
637
638 nlohmann::json& defaults = m_internals->at( p );
639
640 bool reset = false;
641
642 for( nlohmann::json& entry : defaults )
643 {
644 TEXT_ITEM_INFO textInfo( wxT( "" ), true, F_SilkS );
645
646 textInfo.m_Text = entry.at(0).get<wxString>();
647 textInfo.m_Visible = entry.at(1).get<bool>();
648 textInfo.m_Layer = static_cast<PCB_LAYER_ID>( entry.at(2).get<int>() );
649
650 if( textInfo.m_Layer == Rescue || textInfo.m_Layer >= User_5 )
651 {
652 // KiCad pre-9.0 nightlies would write buggy preferences out with invalid layers.
653 // If we detect that, reset to defaults
654 reset = true;
655 }
656 else
657 {
658 // Coming from 8.0 or earlier, just migrate to named layers
659 entry.at(2) = LSET::Name( textInfo.m_Layer );
660 }
661 }
662
663 if( reset )
664 {
665 defaults = nlohmann::json::array( {
666 { "REF**", true, LSET::Name( F_SilkS ) },
667 { "", true, LSET::Name( F_Fab ) },
668 { "${REFERENCE}", true, LSET::Name( F_Fab ) }
669 } );
670 }
671
672 return true;
673}
ARC_EDIT_MODE
Settings for arc editing.
@ KEEP_CENTER_ADJUST_ANGLE_RADIUS
When editing endpoints, the angle and radius are adjusted.
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:121
@ LAYER_CLASS_OTHERS
@ LAYER_CLASS_FAB
@ LAYER_CLASS_COURTYARD
@ LAYER_CLASS_SILK
@ LAYER_CLASS_COPPER
@ LAYER_CLASS_EDGES
#define DEFAULT_TEXT_WIDTH
#define DEFAULT_COPPER_TEXT_WIDTH
#define DEFAULT_DIMENSION_EXTENSION_OFFSET
#define DEFAULT_DIMENSION_ARROW_LENGTH
#define DEFAULT_SILK_TEXT_SIZE
#define DEFAULT_COPPER_LINE_WIDTH
#define DEFAULT_SILK_LINE_WIDTH
#define DEFAULT_SILK_TEXT_WIDTH
#define DEFAULT_EDGE_WIDTH
#define DEFAULT_COPPER_TEXT_SIZE
#define DEFAULT_LINE_WIDTH
#define DEFAULT_COURTYARD_WIDTH
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetName(const wxString &aName)
void SetColor(int aLayer, const COLOR4D &aColor)
bool migrateSchema3To4()
Schema version 4: move layer presets to use named render layers.
BOARD_DESIGN_SETTINGS m_DesignSettings
Only some of these settings are actually used for footprint editing.
bool migrateSchema2To3()
Schema version 2: Bump for KiCad 9 layer numbering changes Migrate layer presets to use new enum valu...
std::vector< OPEN_TAB > m_OpenTabs
wxString m_ActiveTab
Tab key ("lib:fpName") of the tab that was active when the editor last closed.
std::vector< LAYER_PRESET > m_LayerPresets
bool migrateSchema4To5()
Schema version 5: move text defaults to used named layers.
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.
bool fromLegacy(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig 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...
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
bool Contains(const std::string &aPath) const
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
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...
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:101
static int NameToLayer(wxString &aName)
Return the layer number from a layer name.
Definition lset.cpp:113
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition lset.cpp:184
Stores an enum as an integer.
Definition parameters.h:230
Like a normal param, but with custom getter and setter functions.
Definition parameters.h:297
static void MigrateToV9Layers(nlohmann::json &aJson)
static void MigrateToNamedRenderLayers(nlohmann::json &aJson)
Represents a map of <std::string, Value>.
Definition parameters.h:736
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition parameters.h:394
PCB_VIEWERS_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
VIEWERS_DISPLAY_OPTIONS m_ViewersDisplay
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition pgm_base.h:124
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely save a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
COLOR_SETTINGS * AddNewColorSettings(const wxString &aFilename)
Register a new color settings object with the given filename.
The common library.
#define DEFAULT_TEXT_SIZE
Ratio of the font height to the baseline of the text above the wire.
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:413
#define TEXT_MIN_SIZE_MM
Minimum text size (1 micron).
Definition eda_text.h:56
#define TEXT_MAX_SIZE_MM
Maximum text size in mm (~10 inches)
Definition eda_text.h:57
EDA_UNITS
Definition eda_units.h:44
const int fpEditSchemaVersion
! Update the schema version whenever a migration is required
LEADER_MODE
The kind of the leader line.
@ DEG45
45 Degree only
#define traceSettings
@ LAYER_GRID
Definition layer_ids.h:250
@ LAYER_NON_PLATEDHOLES
Draw usual through hole vias.
Definition layer_ids.h:235
@ LAYER_DRAWINGSHEET
Sheet frame and title block.
Definition layer_ids.h:274
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition layer_ids.h:277
@ LAYER_CURSOR
PCB cursor.
Definition layer_ids.h:278
@ LAYER_AUX_ITEMS
Auxiliary items (guides, rule, etc).
Definition layer_ids.h:279
@ LAYER_RATSNEST
Definition layer_ids.h:249
@ LAYER_ANCHOR
Anchor of items having an anchor point (texts, footprints).
Definition layer_ids.h:244
@ LAYER_VIA_BURIED
Draw blind vias.
Definition layer_ids.h:231
@ LAYER_VIA_BLIND
Draw micro vias.
Definition layer_ids.h:230
@ LAYER_VIA_MICROVIA
Definition layer_ids.h:229
@ LAYER_VIA_THROUGH
Draw buried vias.
Definition layer_ids.h:232
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:56
@ User_5
Definition layer_ids.h:124
@ F_Fab
Definition layer_ids.h:115
@ F_SilkS
Definition layer_ids.h:96
@ Rescue
Definition layer_ids.h:117
@ PCB_LAYER_ID_COUNT
Definition layer_ids.h:167
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",...
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)
Return the string from aValue according to aUnits (inch, mm ...) for display.
@ OUTSIDE
Text appears outside the dimension line (default)
@ INLINE
Text appears in line with the dimension line.
PGM_BASE & Pgm()
The global program "get" accessor.
see class PGM_BASE
One open tab persisted across sessions.