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 (C) 2020-2023 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#include <common.h>
23#include <layer_ids.h>
24#include <pgm_base.h>
25#include <eda_text.h>
28#include <settings/parameters.h>
30#include <wx/config.h>
31#include <base_units.h>
32#include <wx/log.h>
33
34
36const int fpEditSchemaVersion = 2;
37
38
41 m_DesignSettings( nullptr, "fpedit.settings" ),
42 m_MagneticItems(),
43 m_Display(),
44 m_UserGrid(),
45 m_PolarCoords( false ),
46 m_RotationAngle( ANGLE_90 ),
47 m_Use45Limit( true ),
49 m_LibWidth( 250 ),
50 m_LastExportPath(),
51 m_FootprintTextShownColumns()
52{
53 m_MagneticItems.pads = MAGNETIC_OPTIONS::CAPTURE_ALWAYS;
54 m_MagneticItems.tracks = MAGNETIC_OPTIONS::NO_EFFECT;
57
61
62 m_params.emplace_back( new PARAM<int>( "window.lib_width",
63 &m_LibWidth, 250 ) );
64
65 m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
67
68 m_params.emplace_back( new PARAM<int>( "aui.right_panel_width",
70
71 m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
73
74 m_params.emplace_back( new PARAM<int>( "aui.properties_panel_width",
76
77 m_params.emplace_back( new PARAM<float>( "aui.properties_splitter_proportion",
79
80 m_params.emplace_back( new PARAM<bool>( "aui.show_properties",
81 &m_AuiPanels.show_properties, false ) );
82
83 m_params.emplace_back( new PARAM<int>( "library.sort_mode",
84 &m_LibrarySortMode, 0 ) );
85
86 m_params.emplace_back( new PARAM<wxString>( "system.last_import_export_path",
87 &m_LastExportPath, "" ) );
88
89 m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
90 &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
91
92 m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
93 reinterpret_cast<int*>( &m_MagneticItems.pads ),
94 static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_ALWAYS ) ) );
95
96 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
97 &m_MagneticItems.graphics, true ) );
98
99 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_all_layers",
100 &m_MagneticItems.allLayers, false ) );
101
102 m_params.emplace_back( new PARAM<bool>( "editing.polar_coords",
103 &m_PolarCoords, false ) );
104
105 m_params.emplace_back( new PARAM_LAMBDA<int>( "editing.rotation_angle",
106 [this] () -> int
107 {
109 },
110 [this] ( int aVal )
111 {
112 if( aVal )
114 },
115 900 ) );
116
117 m_params.emplace_back( new PARAM<bool>( "editing.fp_use_45_degree_limit",
118 &m_Use45Limit, false ) );
119
120 m_params.emplace_back( new PARAM_LAYER_PRESET( "pcb_display.layer_presets", &m_LayerPresets ) );
121
122 m_params.emplace_back( new PARAM<wxString>( "pcb_display.active_layer_preset",
123 &m_ActiveLayerPreset, "" ) );
124
125 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>(
126 "design_settings.default_footprint_text_items",
127 [&] () -> nlohmann::json
128 {
129 nlohmann::json js = nlohmann::json::array();
130
132 {
133 js.push_back( nlohmann::json( { item.m_Text.ToUTF8(),
134 item.m_Visible,
135 item.m_Layer } ) );
136 }
137
138 return js;
139 },
140 [&] ( const nlohmann::json& aObj )
141 {
143
144 if( !aObj.is_array() )
145 return;
146
147 for( const nlohmann::json& entry : aObj )
148 {
149 if( entry.empty() || !entry.is_array() )
150 continue;
151
152 TEXT_ITEM_INFO textInfo( wxT( "" ), true, F_SilkS );
153
154 textInfo.m_Text = entry.at(0).get<wxString>();
155 textInfo.m_Visible = entry.at(1).get<bool>();
156 textInfo.m_Layer = entry.at(2).get<int>();
157
158 m_DesignSettings.m_DefaultFPTextItems.push_back( std::move( textInfo ) );
159 }
160 },
161 nlohmann::json::array( {
162 { "REF**", true, F_SilkS },
163 { "", true, F_Fab },
164 { "${REFERENCE}", true, F_Fab }
165 } ) ) );
166
167 int minTextSize = pcbIUScale.MilsToIU( TEXT_MIN_SIZE_MILS );
168 int maxTextSize = pcbIUScale.MilsToIU( TEXT_MAX_SIZE_MILS );
169 int minStroke = 1;
170 int maxStroke = pcbIUScale.mmToIU( 100 );
171
172 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_line_width",
174 pcbIUScale.mmToIU( DEFAULT_SILK_LINE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
175
176 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_h",
178 pcbIUScale.mmToIU( DEFAULT_SILK_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
179
180 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_v",
182 pcbIUScale.mmToIU( DEFAULT_SILK_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
183
184 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_thickness",
187
188 m_params.emplace_back( new PARAM<bool>( "design_settings.silk_text_italic",
190
191 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_line_width",
193 pcbIUScale.mmToIU( DEFAULT_COPPER_LINE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
194
195 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_h",
197 pcbIUScale.mmToIU( DEFAULT_COPPER_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
198
199 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_v",
201 pcbIUScale.mmToIU( DEFAULT_COPPER_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
202
203 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_thickness",
205 pcbIUScale.mmToIU( DEFAULT_COPPER_TEXT_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
206
207 m_params.emplace_back( new PARAM<bool>( "design_settings.copper_text_italic",
209
210 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.edge_line_width",
212 pcbIUScale.mmToIU( DEFAULT_EDGE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
213
214 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.courtyard_line_width",
216 pcbIUScale.mmToIU( DEFAULT_COURTYARD_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
217
218 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_line_width",
220 pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
221
222 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_h",
224 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
225
226 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_v",
228 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
229
230 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_thickness",
233
234 m_params.emplace_back( new PARAM<bool>( "design_settings.fab_text_italic",
236
237 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_line_width",
239 pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ), minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
240
241 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_h",
243 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
244
245 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_v",
247 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ), minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
248
249 m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_thickness",
252
253 m_params.emplace_back( new PARAM<bool>( "design_settings.others_text_italic",
255
256 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "editing.selection_filter",
257 [&]() -> nlohmann::json
258 {
259 nlohmann::json ret;
260
261 ret["lockedItems"] = m_SelectionFilter.lockedItems;
262 ret["footprints"] = m_SelectionFilter.footprints;
263 ret["text"] = m_SelectionFilter.text;
264 ret["tracks"] = m_SelectionFilter.tracks;
265 ret["vias"] = m_SelectionFilter.vias;
266 ret["pads"] = m_SelectionFilter.pads;
267 ret["graphics"] = m_SelectionFilter.graphics;
268 ret["zones"] = m_SelectionFilter.zones;
269 ret["keepouts"] = m_SelectionFilter.keepouts;
270 ret["dimensions"] = m_SelectionFilter.dimensions;
271 ret["otherItems"] = m_SelectionFilter.otherItems;
272
273 return ret;
274 },
275 [&]( const nlohmann::json& aVal )
276 {
277 if( aVal.empty() || !aVal.is_object() )
278 return;
279
280 SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
281 SetIfPresent( aVal, "footprints", m_SelectionFilter.footprints );
282 SetIfPresent( aVal, "text", m_SelectionFilter.text );
283 SetIfPresent( aVal, "tracks", m_SelectionFilter.tracks );
284 SetIfPresent( aVal, "vias", m_SelectionFilter.vias );
285 SetIfPresent( aVal, "pads", m_SelectionFilter.pads );
286 SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
287 SetIfPresent( aVal, "zones", m_SelectionFilter.zones );
288 SetIfPresent( aVal, "keepouts", m_SelectionFilter.keepouts );
289 SetIfPresent( aVal, "dimensions", m_SelectionFilter.dimensions );
290 SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
291 },
292 {
293 { "lockedItems", false },
294 { "footprints", true },
295 { "text", true },
296 { "tracks", true },
297 { "vias", true },
298 { "pads", true },
299 { "graphics", true },
300 { "zones", true },
301 { "keepouts", true },
302 { "dimensions", true },
303 { "otherItems", true }
304 } ) );
305
307
308 registerMigration( 1, 2,
309 [&]() -> bool
310 {
311 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
312 return migrateLibTreeWidth();
313 } );
314}
315
316
318{
319 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
320
321 //
322 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
323 //
324 ret &= fromLegacy<int>( aCfg, "ModeditLibWidth", "window.lib_width" );
325 ret &= fromLegacyString( aCfg, "import_last_path", "system.last_import_export_path" );
326 ret &= fromLegacyString( aCfg, "LibFootprintTextShownColumns", "window.footprint_text_shown_columns" );
327
328 ret &= fromLegacy<int>( aCfg, "FpEditorMagneticPads", "editing.magnetic_pads" );
329 ret &= fromLegacy<bool>( aCfg, "FpEditorDisplayPolarCoords", "editing.polar_coords" );
330 ret &= fromLegacy<int>( aCfg, "FpEditorUse45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
331
332 ret &= fromLegacy<bool>( aCfg, "FpEditorGraphicLinesDisplayMode", "pcb_display.graphic_items_fill" );
333 ret &= fromLegacy<bool>( aCfg, "FpEditorPadDisplayMode", "pcb_display.pad_fill" );
334 ret &= fromLegacy<bool>( aCfg, "FpEditorTextsDisplayMode", "pcb_display.footprint_text" );
335
336 ret &= fromLegacy<double>( aCfg, "FpEditorSilkLineWidth", "design_settings.silk_line_width" );
337 ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeH", "design_settings.silk_text_size_h" );
338 ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeV", "design_settings.silk_text_size_v" );
339 ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextThickness", "design_settings.silk_text_thickness" );
340 ret &= fromLegacy<bool>( aCfg, "FpEditorSilkTextItalic", "design_settings.silk_text_italic" );
341 ret &= fromLegacy<double>( aCfg, "FpEditorCopperLineWidth", "design_settings.copper_line_width" );
342 ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeH", "design_settings.copper_text_size_h" );
343 ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeV", "design_settings.copper_text_size_v" );
344 ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextThickness", "design_settings.copper_text_thickness" );
345 ret &= fromLegacy<bool>( aCfg, "FpEditorCopperTextItalic", "design_settings.copper_text_italic" );
346 ret &= fromLegacy<double>( aCfg, "FpEditorEdgeCutLineWidth", "design_settings.edge_line_width" );
347 ret &= fromLegacy<double>( aCfg, "FpEditorCourtyardLineWidth", "design_settings.courtyard_line_width" );
348 ret &= fromLegacy<double>( aCfg, "FpEditorOthersLineWidth", "design_settings.others_line_width" );
349 ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeH", "design_settings.others_text_size_h" );
350 ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeV", "design_settings.others_text_size_v" );
351 ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextThickness", "design_settings.others_text_thickness" );
352 ret &= fromLegacy<bool>( aCfg, "FpEditorOthersTextItalic", "design_settings.others_text_italic" );
353
354 nlohmann::json textItems = nlohmann::json::array( {
355 { "REF**", true, F_SilkS },
356 { "", true, F_Fab }
357 } );
358
359 Set( "design_settings.default_footprint_text_items", textItems );
360
361 ret &= fromLegacyString( aCfg, "FpEditorRefDefaultText", "design_settings.default_footprint_text_items.0.0" );
362 ret &= fromLegacy<bool>( aCfg, "FpEditorRefDefaultVisibility", "design_settings.default_footprint_text_items.0.1" );
363 ret &= fromLegacy<int>( aCfg, "FpEditorRefDefaultLayer", "design_settings.default_footprint_text_items.0.2" );
364 ret &= fromLegacyString( aCfg, "FpEditorValueDefaultText", "design_settings.default_footprint_text_items.1.0" );
365 ret &= fromLegacy<bool>( aCfg, "FpEditorValueDefaultVisibility", "design_settings.default_footprint_text_items.1.1" );
366 ret &= fromLegacy<int>( aCfg, "FpEditorValueDefaultLayer", "design_settings.default_footprint_text_items.1.2" );
367
368
369 std::string f = "ModEdit";
370
371 // Migrate color settings that were stored in the pcbnew config file
372 // We create a copy of the user scheme for the footprint editor context
373
374 SETTINGS_MANAGER& manager = Pgm().GetSettingsManager();
375 COLOR_SETTINGS* cs = manager.AddNewColorSettings( "user_footprints" );
376
377 cs->SetName( wxT( "User (Footprints)" ) );
378 manager.Save( cs );
379
380 auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId )
381 {
382 wxString str;
383
384 if( aCfg->Read( aKey, &str ) )
385 cs->SetColor( aLayerId, COLOR4D( str ) );
386 };
387
388 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
389 {
390 wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
391 migrateLegacyColor( f + "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
392 }
393
394 migrateLegacyColor( f + "Color4DAnchorEx", LAYER_ANCHOR );
395 migrateLegacyColor( f + "Color4DAuxItems", LAYER_AUX_ITEMS );
396 migrateLegacyColor( f + "Color4DGrid", LAYER_GRID );
397 migrateLegacyColor( f + "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
398 migrateLegacyColor( f + "Color4DPadThruHoleEx", LAYER_PADS_TH );
399 migrateLegacyColor( f + "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
400 migrateLegacyColor( f + "Color4DPCBCursor", LAYER_CURSOR );
401 migrateLegacyColor( f + "Color4DRatsEx", LAYER_RATSNEST );
402 migrateLegacyColor( f + "Color4DTxtInvisEx", LAYER_HIDDEN_TEXT );
403 migrateLegacyColor( f + "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
404 migrateLegacyColor( f + "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
405 migrateLegacyColor( f + "Color4DViaThruEx", LAYER_VIA_THROUGH );
406 migrateLegacyColor( f + "Color4DWorksheet", LAYER_DRAWINGSHEET );
407
408 manager.SaveColorSettings( cs, "board" );
409
410 ( *m_internals )[m_internals->PointerFromString( "appearance.color_theme" )] = "user_footprints";
411
412 double x = 0, y = 0;
413 f = "ModEditFrame";
414
415 if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
416 {
417 EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
418 static_cast<long>( EDA_UNITS::INCHES ) ) );
419
420 // Convert to internal units
423
424 Set( "window.grid.user_grid_x", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, x ) );
425 Set( "window.grid.user_grid_y", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, y ) );
426 }
427
428 return ret;
429}
430
431
433{
441 if( !m_manager )
442 {
443 wxLogTrace( traceSettings,
444 wxT( "Error: FOOTPRINT_EDITOR_SETTINGS migration cannot run unmanaged!" ) );
445 return false;
446 }
447
448 std::string theme_ptr( "appearance.color_theme" );
449
450 if( !Contains( theme_ptr ) )
451 return true;
452
453 wxString selected = At( theme_ptr ).get<wxString>();
454 wxString search = selected + wxT( "_footprints" );
455
456 for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
457 {
458 if( settings->GetFilename() == search )
459 {
460 wxLogTrace( traceSettings, wxT( "Updating footprint editor theme from %s to %s" ),
461 selected, search );
462 Set( theme_ptr, search );
463 return true;
464 }
465 }
466
467 return true;
468}
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:109
#define DEFAULT_TEXT_WIDTH
#define DEFAULT_COPPER_TEXT_WIDTH
#define DEFAULT_SILK_TEXT_SIZE
#define DEFAULT_COPPER_LINE_WIDTH
#define DEFAULT_SILK_LINE_WIDTH
@ LAYER_CLASS_OTHERS
@ LAYER_CLASS_FAB
@ LAYER_CLASS_COURTYARD
@ LAYER_CLASS_SILK
@ LAYER_CLASS_COPPER
@ LAYER_CLASS_EDGES
#define DEFAULT_SILK_TEXT_WIDTH
#define DEFAULT_EDGE_WIDTH
#define DEFAULT_COPPER_TEXT_SIZE
#define DEFAULT_LINE_WIDTH
#define DEFAULT_COURTYARD_WIDTH
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
bool migrateLibTreeWidth()
Migrates the library tree width setting from a single column (Item) to multi-column.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
int m_TextThickness[LAYER_CLASS_COUNT]
int m_LineThickness[LAYER_CLASS_COUNT]
VECTOR2I m_TextSize[LAYER_CLASS_COUNT]
bool m_TextItalic[LAYER_CLASS_COUNT]
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)
int AsTenthsOfADegree() const
Definition: eda_angle.h:151
BOARD_DESIGN_SETTINGS m_DesignSettings
Only some of these settings are actually used for footprint editing.
std::vector< LAYER_PRESET > m_LayerPresets
SELECTION_FILTER_OPTIONS m_SelectionFilter
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.
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
bool Contains(const std::string &aPath) const
static bool SetIfPresent(const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
Sets the given string if the given key/path is present.
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...
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::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
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:82
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:282
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition: parameters.h:335
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 * AddNewColorSettings(const wxString &aFilename)
Registers 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.
@ TENTHS_OF_A_DEGREE_T
Definition: eda_angle.h:30
static constexpr EDA_ANGLE & ANGLE_90
Definition: eda_angle.h:439
#define TEXT_MIN_SIZE_MILS
Minimum text size in mils.
Definition: eda_text.h:42
#define TEXT_MAX_SIZE_MILS
Maximum text size in mils (10 inches)
Definition: eda_text.h:43
EDA_UNITS
Definition: eda_units.h:44
const int fpEditSchemaVersion
! Update the schema version whenever a migration is required
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
@ LAYER_GRID
Definition: layer_ids.h:206
@ LAYER_NON_PLATEDHOLES
handle color for not plated holes (holes, not pads)
Definition: layer_ids.h:198
@ LAYER_DRAWINGSHEET
drawingsheet frame and titleblock
Definition: layer_ids.h:218
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition: layer_ids.h:221
@ LAYER_HIDDEN_TEXT
text marked as invisible
Definition: layer_ids.h:201
@ LAYER_CURSOR
PCB cursor.
Definition: layer_ids.h:222
@ LAYER_AUX_ITEMS
Auxiliary items (guides, rule, etc)
Definition: layer_ids.h:223
@ LAYER_RATSNEST
Definition: layer_ids.h:205
@ LAYER_ANCHOR
anchor of items having an anchor point (texts, footprints)
Definition: layer_ids.h:202
@ LAYER_PADS_TH
multilayer pads, usually with holes
Definition: layer_ids.h:214
@ LAYER_VIA_MICROVIA
to draw micro vias
Definition: layer_ids.h:195
@ LAYER_VIA_THROUGH
to draw usual through hole vias
Definition: layer_ids.h:197
@ LAYER_VIA_BBLIND
to draw blind/buried vias
Definition: layer_ids.h:196
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ F_Fab
Definition: layer_ids.h:121
@ F_SilkS
Definition: layer_ids.h:105
@ PCB_LAYER_ID_COUNT
Definition: layer_ids.h:138
KICOMMON_API double FromUserUnit(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnit, double aValue)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".
Definition: eda_units.cpp:385
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:225
SETTINGS_MANAGER * GetSettingsManager()
see class PGM_BASE
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:115
const double MM_PER_IU
Definition: base_units.h:79
constexpr int MilsToIU(int mils) const
Definition: base_units.h:94
constexpr int mmToIU(double mm) const
Definition: base_units.h:89
MAGNETIC_OPTIONS tracks
MAGNETIC_OPTIONS pads
bool graphics
Graphic lines, shapes, polygons.
bool text
Text (free or attached to a footprint)
bool lockedItems
Allow selecting locked items.
bool footprints
Allow selecting entire footprints.
bool dimensions
Dimension items.
bool otherItems
Anything not fitting one of the above categories.