KiCad PCB EDA Suite
Loading...
Searching...
No Matches
board_design_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 The 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 <pcb_dimension.h>
25#include <pcb_track.h>
26#include <layer_ids.h>
27#include <lset.h>
28#include <kiface_base.h>
29#include <pad.h>
31#include <drc/drc_item.h>
32#include <drc/drc_engine.h>
34#include <settings/parameters.h>
36#include <advanced_config.h>
37
38const int bdsSchemaVersion = 2;
39
40
41BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath ) :
42 NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aParent, aPath )
43{
44 // We want to leave alone parameters that aren't found in the project JSON as they may be
45 // initialized by the board file parser before NESTED_SETTINGS::LoadFromFile is called.
47
48 // Create a default NET_SETTINGS so that things don't break horribly if there's no project
49 // loaded. This also is used during file load for legacy boards that have netclasses stored
50 // in the file. After load, this information will be moved to the project and the pointer
51 // updated.
52 m_NetSettings = std::make_shared<NET_SETTINGS>( nullptr, "" );
53
54 m_HasStackup = false; // no stackup defined by default
55
56 m_Pad_Master = std::make_unique<PAD>( nullptr );
58
59 LSET all_set = LSET().set();
60 m_enabledLayers = all_set; // All layers enabled at first.
61 // SetCopperLayerCount() will adjust this.
62
63 // Default design is a double layer board with 4 user defined layers
66
68
69 // if true, when creating a new track starting on an existing track, use this track width
72
73 // First is always the reference designator
74 m_DefaultFPTextItems.emplace_back( wxT( "REF**" ), true, F_SilkS );
75 // Second is always the value
76 m_DefaultFPTextItems.emplace_back( wxT( "" ), true, F_Fab );
77 // Any following ones are freebies
78 m_DefaultFPTextItems.emplace_back( wxT( "${REFERENCE}" ), true, F_Fab );
79
86
93
94 // Edges & Courtyards; text properties aren't used but better to have them holding
95 // reasonable values than not.
98 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
102
105 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
109
112 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
114 m_TextItalic[ LAYER_CLASS_FAB ] = false;
116
119 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
123
124 m_StyleFPFields = false;
125 m_StyleFPText = false;
126 m_StyleFPShapes = false;
127 m_StyleFPDimensions = false;
128 m_StyleFPBarcodes = false;
129
138
139 m_useCustomTrackVia = false;
141 m_customViaSize.m_Diameter = pcbIUScale.mmToIU( DEFAULT_VIASMINSIZE );
143
144 m_useCustomDiffPair = false;
148
165
166 for( int errorCode = DRCE_FIRST; errorCode <= DRCE_LAST; ++errorCode )
167 m_DRCSeverities[ errorCode ] = RPT_SEVERITY_ERROR;
168
171
175
178
181
183
190
196
198
201
203
206
210
211 // Global mask margins:
215
216 // Solder paste margin absolute value
218 // Solder paste margin as a ratio of pad size
219 // The final margin is the sum of these 2 values
220 // Usually < 0 because the mask is smaller than pad
222
224 m_TentViasFront = true;
225 m_TentViasBack = true;
226
227 m_CoverViasFront = false;
228 m_CoverViasBack = false;
229
230 m_PlugViasFront = false;
231 m_PlugViasBack = false;
232
233 m_CapVias = false;
234
235 m_FillVias = false;
236
237 // Layer thickness for 3D viewer
239
240 // Default spacing for meanders
244
245 m_viaSizeIndex = 0;
247 m_diffPairIndex = 0;
248
249 // Parameters stored in JSON in the project file
250
251 // NOTE: Previously, BOARD_DESIGN_SETTINGS stored the basic board layer information (layer
252 // names and enable/disable state) in the project file even though this information is also
253 // stored in the board file. This was implemented for importing these settings from another
254 // project. Going forward, the import feature will just import from other board files (since
255 // we could have multi-board projects in the future anyway) so this functionality is dropped.
256
257
258 m_params.emplace_back( new PARAM<bool>( "rules.use_height_for_length_calcs",
259 &m_UseHeightForLengthCalcs, true ) );
260
261 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_clearance",
263 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
264
265 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_connection",
267 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
268
269 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_track_width",
271 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
272
273 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_annular_width",
275 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
276
277 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_diameter",
279 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
280
281 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_through_hole_diameter",
283 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
284
285 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_diameter",
287 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
288
289 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_drill",
291 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
292
293 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_to_hole",
295 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
296
297 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_clearance",
299 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
300
301 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_silk_clearance",
303 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
304
305 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_groove_width",
307 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
308
309 // While the maximum *effective* value is 4, we've had users interpret this as the count on
310 // all layers, and enter something like 10. They'll figure it out soon enough *unless* we
311 // enforce a max of 4 (and therefore reset it back to the default of 2), at which point it
312 // just looks buggy.
313 m_params.emplace_back( new PARAM<int>( "rules.min_resolved_spokes",
315
316 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_height",
318 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
319
320 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_thickness",
322 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
323
324 // Note: a clearance of -0.01 is a flag indicating we should use the legacy (pre-6.0) method
325 // based on the edge cut thicknesses.
326 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_copper_edge_clearance",
328 pcbIUScale.mmToIU( -0.01 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
329
330 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
331 [&]() -> nlohmann::json
332 {
333 nlohmann::json ret = {};
334
335 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
336 {
337 wxString name = item.GetSettingsKey();
338 int code = item.GetErrorCode();
339
340 if( name.IsEmpty() || m_DRCSeverities.count( code ) == 0 )
341 continue;
342
343 ret[std::string( name.ToUTF8() )] = SeverityToString( m_DRCSeverities[code] );
344 }
345
346 return ret;
347 },
348 [&]( const nlohmann::json& aJson )
349 {
350 if( !aJson.is_object() )
351 return;
352
353 // Load V8 'hole_near_hole' token first (if present). Any current 'hole_to_hole' token
354 // found will then overwrite it.
355 // We can't use the migration architecture because we forgot to bump the version number
356 // when the change was made. But this is a one-off as any future deprecations should
357 // bump the version number and use registerMigration().
358 if( aJson.contains( "hole_near_hole" ) )
360
361 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
362 {
363 wxString name = item.GetSettingsKey();
364 std::string key( name.ToUTF8() );
365
366 if( aJson.contains( key ) )
367 m_DRCSeverities[item.GetErrorCode()] = SeverityFromString( aJson[key] );
368 }
369 }, {} ) );
370
371 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "drc_exclusions",
372 [&]() -> nlohmann::json
373 {
374 nlohmann::json js = nlohmann::json::array();
375
376 for( const wxString& entry : m_DrcExclusions )
377 js.push_back( { entry, m_DrcExclusionComments[ entry ] } );
378
379 return js;
380 },
381 [&]( const nlohmann::json& aObj )
382 {
383 m_DrcExclusions.clear();
384
385 if( !aObj.is_array() )
386 return;
387
388 for( const nlohmann::json& entry : aObj )
389 {
390 if( entry.is_array() )
391 {
392 wxString serialized = entry[0].get<wxString>();
393 m_DrcExclusions.insert( serialized );
394 m_DrcExclusionComments[ serialized ] = entry[1].get<wxString>();
395 }
396 else if( entry.is_string() )
397 {
398 m_DrcExclusions.insert( entry.get<wxString>() );
399 }
400 }
401 },
402 {} ) );
403
404 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "track_widths",
405 [&]() -> nlohmann::json
406 {
407 nlohmann::json js = nlohmann::json::array();
408
409 for( const int& width : m_TrackWidthList )
410 js.push_back( pcbIUScale.IUTomm( width ) );
411
412 return js;
413 },
414 [&]( const nlohmann::json& aJson )
415 {
416 if( !aJson.is_array() )
417 return;
418
419 m_TrackWidthList.clear();
420
421 for( const nlohmann::json& entry : aJson )
422 {
423 if( entry.empty() )
424 continue;
425
426 m_TrackWidthList.emplace_back( pcbIUScale.mmToIU( entry.get<double>() ) );
427 }
428 },
429 {} ) );
430
431 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "via_dimensions",
432 [&]() -> nlohmann::json
433 {
434 nlohmann::json js = nlohmann::json::array();
435
436 for( const auto& via : m_ViasDimensionsList )
437 {
438 nlohmann::json entry = {};
439
440 entry["diameter"] = pcbIUScale.IUTomm( via.m_Diameter );
441 entry["drill"] = pcbIUScale.IUTomm( via.m_Drill );
442
443 js.push_back( entry );
444 }
445
446 return js;
447 },
448 [&]( const nlohmann::json& aObj )
449 {
450 if( !aObj.is_array() )
451 return;
452
453 m_ViasDimensionsList.clear();
454
455 for( const nlohmann::json& entry : aObj )
456 {
457 if( entry.empty() || !entry.is_object() )
458 continue;
459
460 if( !entry.contains( "diameter" ) || !entry.contains( "drill" ) )
461 continue;
462
463 int diameter = pcbIUScale.mmToIU( entry["diameter"].get<double>() );
464 int drill = pcbIUScale.mmToIU( entry["drill"].get<double>() );
465
466 m_ViasDimensionsList.emplace_back( VIA_DIMENSION( diameter, drill ) );
467 }
468 },
469 {} ) );
470
471 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "diff_pair_dimensions",
472 [&]() -> nlohmann::json
473 {
474 nlohmann::json js = nlohmann::json::array();
475
476 for( const auto& pair : m_DiffPairDimensionsList )
477 {
478 nlohmann::json entry = {};
479
480 entry["width"] = pcbIUScale.IUTomm( pair.m_Width );
481 entry["gap"] = pcbIUScale.IUTomm( pair.m_Gap );
482 entry["via_gap"] = pcbIUScale.IUTomm( pair.m_ViaGap );
483
484 js.push_back( entry );
485 }
486
487 return js;
488 },
489 [&]( const nlohmann::json& aObj )
490 {
491 if( !aObj.is_array() )
492 return;
493
495
496 for( const nlohmann::json& entry : aObj )
497 {
498 if( entry.empty() || !entry.is_object() )
499 continue;
500
501 if( !entry.contains( "width" )
502 || !entry.contains( "gap" )
503 || !entry.contains( "via_gap" ) )
504 {
505 continue;
506 }
507
508 int width = pcbIUScale.mmToIU( entry["width"].get<double>() );
509 int gap = pcbIUScale.mmToIU( entry["gap"].get<double>() );
510 int via_gap = pcbIUScale.mmToIU( entry["via_gap"].get<double>() );
511
512 m_DiffPairDimensionsList.emplace_back( DIFF_PAIR_DIMENSION( width, gap, via_gap ) );
513 }
514 },
515 {} ) );
516
517 // Handle options for teardrops (targets and some others):
518 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_options",
519 [&]() -> nlohmann::json
520 {
521 nlohmann::json js = nlohmann::json::array();
522 nlohmann::json entry = {};
523
524 entry["td_onvia"] = m_TeardropParamsList.m_TargetVias;
525 entry["td_onpthpad"] = m_TeardropParamsList.m_TargetPTHPads;
526 entry["td_onsmdpad"] = m_TeardropParamsList.m_TargetSMDPads;
527 entry["td_ontrackend"] = m_TeardropParamsList.m_TargetTrack2Track;
528 entry["td_onroundshapesonly"] = m_TeardropParamsList.m_UseRoundShapesOnly;
529
530 js.push_back( entry );
531
532 return js;
533 },
534 [&]( const nlohmann::json& aObj )
535 {
536 if( !aObj.is_array() )
537 return;
538
539 for( const nlohmann::json& entry : aObj )
540 {
541 if( entry.empty() || !entry.is_object() )
542 continue;
543
544 if( entry.contains( "td_onvia" ) )
545 m_TeardropParamsList.m_TargetVias = entry["td_onvia"].get<bool>();
546
547 if( entry.contains( "td_onpthpad" ) )
548 m_TeardropParamsList.m_TargetPTHPads = entry["td_onpthpad"].get<bool>();
549
550 if( entry.contains( "td_onsmdpad" ) )
551 m_TeardropParamsList.m_TargetSMDPads = entry["td_onsmdpad"].get<bool>();
552
553 if( entry.contains( "td_ontrackend" ) )
554 m_TeardropParamsList.m_TargetTrack2Track = entry["td_ontrackend"].get<bool>();
555
556 if( entry.contains( "td_onroundshapesonly" ) )
557 m_TeardropParamsList.m_UseRoundShapesOnly = entry["td_onroundshapesonly"].get<bool>();
558
559 // Legacy settings
560 for( int ii = 0; ii < 3; ++ii )
561 {
562 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)ii );
563
564 if( entry.contains( "td_allow_use_two_tracks" ) )
565 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
566
567 if( entry.contains( "td_curve_segcount" ) )
568 {
569 if( entry["td_curve_segcount"].get<int>() > 0 )
570 td_prm->m_CurvedEdges = true;
571 }
572
573 if( entry.contains( "td_on_pad_in_zone" ) )
574 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
575 }
576 }
577 },
578 {} ) );
579
580 // Handle parameters (sizes, shape) for each type of teardrop:
581 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_parameters",
582 [&]() -> nlohmann::json
583 {
584 nlohmann::json js = nlohmann::json::array();
585
586 for( size_t ii = 0; ii < m_TeardropParamsList.GetParametersCount(); ii++ )
587 {
588 nlohmann::json entry = {};
589 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)ii );
590
591 entry["td_target_name"] = GetTeardropTargetCanonicalName( (TARGET_TD)ii );
592 entry["td_maxlen"] = pcbIUScale.IUTomm( td_prm->m_TdMaxLen );
593 entry["td_maxheight"] = pcbIUScale.IUTomm( td_prm->m_TdMaxWidth );
594 entry["td_length_ratio"] = td_prm->m_BestLengthRatio;
595 entry["td_height_ratio"] = td_prm->m_BestWidthRatio;
596 entry["td_curve_segcount"] = td_prm->m_CurvedEdges ? 1 : 0;
597 entry["td_width_to_size_filter_ratio"] = td_prm->m_WidthtoSizeFilterRatio;
598 entry["td_allow_use_two_tracks"] = td_prm->m_AllowUseTwoTracks;
599 entry["td_on_pad_in_zone"] = td_prm->m_TdOnPadsInZones;
600
601 js.push_back( entry );
602 }
603
604 return js;
605 },
606 [&]( const nlohmann::json& aObj )
607 {
608 if( !aObj.is_array() )
609 return;
610
611 for( const nlohmann::json& entry : aObj )
612 {
613 if( entry.empty() || !entry.is_object() )
614 continue;
615
616 if( !entry.contains( "td_target_name" ) )
617 continue;
618
619 int idx = GetTeardropTargetTypeFromCanonicalName( entry["td_target_name"].get<std::string>() );
620
621 if( idx >= 0 && idx < 3 )
622 {
623 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)idx );
624
625 if( entry.contains( "td_maxlen" ) )
626 td_prm->m_TdMaxLen = pcbIUScale.mmToIU( entry["td_maxlen"].get<double>() );
627
628 if( entry.contains( "td_maxheight" ) )
629 td_prm->m_TdMaxWidth = pcbIUScale.mmToIU( entry["td_maxheight"].get<double>() );
630
631 if( entry.contains( "td_length_ratio" ) )
632 td_prm->m_BestLengthRatio = entry["td_length_ratio"].get<double>();
633
634 if( entry.contains( "td_height_ratio" ) )
635 td_prm->m_BestWidthRatio = entry["td_height_ratio"].get<double>();
636
637 if( entry.contains( "td_curve_segcount" ) )
638 {
639 if( entry["td_curve_segcount"].get<int>() > 0 )
640 td_prm->m_CurvedEdges = true;
641 }
642
643 if( entry.contains( "td_width_to_size_filter_ratio" ) )
644 td_prm->m_WidthtoSizeFilterRatio = entry["td_width_to_size_filter_ratio"].get<double>();
645
646 if( entry.contains( "td_allow_use_two_tracks" ) )
647 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
648
649 if( entry.contains( "td_on_pad_in_zone" ) )
650 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
651 }
652 }
653 },
654 {} ) );
655
656 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "tuning_pattern_settings",
657 [&]() -> nlohmann::json
658 {
659 nlohmann::json js = {};
660
661 auto make_settings =
662 []( const PNS::MEANDER_SETTINGS& aSettings )
663 {
664 nlohmann::json entry = {};
665
666 entry["min_amplitude"] = pcbIUScale.IUTomm( aSettings.m_minAmplitude );
667 entry["max_amplitude"] = pcbIUScale.IUTomm( aSettings.m_maxAmplitude );
668 entry["spacing"] = pcbIUScale.IUTomm( aSettings.m_spacing );
669 entry["corner_style"] = aSettings.m_cornerStyle == PNS::MEANDER_STYLE_CHAMFER ? 0 : 1;
670 entry["corner_radius_percentage"] = aSettings.m_cornerRadiusPercentage;
671 entry["single_sided"] = aSettings.m_singleSided;
672
673 return entry;
674 };
675
676 js["single_track_defaults"] = make_settings( m_SingleTrackMeanderSettings );
677 js["diff_pair_defaults"] = make_settings( m_DiffPairMeanderSettings );
678 js["diff_pair_skew_defaults"] = make_settings( m_SkewMeanderSettings );
679
680 return js;
681 },
682 [&]( const nlohmann::json& aObj )
683 {
684 auto read_settings =
685 []( const nlohmann::json& entry ) -> PNS::MEANDER_SETTINGS
686 {
687 PNS::MEANDER_SETTINGS settings;
688
689 if( entry.contains( "min_amplitude" ) )
690 settings.m_minAmplitude = pcbIUScale.mmToIU( entry["min_amplitude"].get<double>() );
691
692 if( entry.contains( "max_amplitude" ) )
693 settings.m_maxAmplitude = pcbIUScale.mmToIU( entry["max_amplitude"].get<double>() );
694
695 if( entry.contains( "spacing" ) )
696 settings.m_spacing = pcbIUScale.mmToIU( entry["spacing"].get<double>() );
697
698 if( entry.contains( "corner_style" ) )
699 {
700 settings.m_cornerStyle = entry["corner_style"] == 0 ? PNS::MEANDER_STYLE_CHAMFER
702 }
703
704 if( entry.contains( "corner_radius_percentage" ) )
705 settings.m_cornerRadiusPercentage = entry["corner_radius_percentage"].get<int>();
706
707 if( entry.contains( "single_sided" ) )
708 settings.m_singleSided = entry["single_sided"].get<bool>();
709
710 return settings;
711 };
712
713 if( aObj.contains( "single_track_defaults" ) )
714 m_SingleTrackMeanderSettings = read_settings( aObj["single_track_defaults"] );
715
716 if( aObj.contains( "diff_pair_defaults" ) )
717 m_DiffPairMeanderSettings = read_settings( aObj["diff_pair_defaults"] );
718
719 if( aObj.contains( "diff_pair_skew_defaults" ) )
720 m_SkewMeanderSettings = read_settings( aObj["diff_pair_skew_defaults"] );
721 },
722 {} ) );
723
724 int minTextSize = pcbIUScale.mmToIU( TEXT_MIN_SIZE_MM );
725 int maxTextSize = pcbIUScale.mmToIU( TEXT_MAX_SIZE_MM );
726 int minStroke = 1;
727 int maxStroke = pcbIUScale.mmToIU( 100 );
728
729 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_line_width",
731 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
732
733 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_v",
735 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
736
737 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_h",
739 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
740
741 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_thickness",
743 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
744
745 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_italic",
746 &m_TextItalic[LAYER_CLASS_SILK], false ) );
747
748 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_upright",
749 &m_TextUpright[ LAYER_CLASS_SILK ], true ) );
750
751 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_line_width",
753 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
754
755 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_v",
757 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
758
759 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_h",
761 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
762
763 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_thickness",
765 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
766
767 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_italic",
768 &m_TextItalic[LAYER_CLASS_COPPER], false ) );
769
770 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_upright",
772
773 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.board_outline_line_width",
775 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
776
777 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.courtyard_line_width",
779 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
780
781 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_line_width",
783 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
784
785 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_v",
787 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
788
789 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_h",
791 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
792
793 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_thickness",
795 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
796
797 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_italic",
798 &m_TextItalic[LAYER_CLASS_FAB], false ) );
799
800 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_upright",
801 &m_TextUpright[LAYER_CLASS_FAB], true ) );
802
803 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_line_width",
805 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
806
807 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_v",
809 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
810
811 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_h",
813 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
814
815 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_thickness",
817 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
818
819 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_italic",
820 &m_TextItalic[LAYER_CLASS_OTHERS], false ) );
821
822 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_upright",
824
825 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_MODE>( "defaults.dimension_units",
828
829 m_params.emplace_back( new PARAM_ENUM<DIM_PRECISION>( "defaults.dimension_precision",
831
832 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_FORMAT>( "defaults.dimensions.units_format",
835
836 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.suppress_zeroes",
837 &m_DimensionSuppressZeroes, true ) );
838
839 // NOTE: excluding DIM_TEXT_POSITION::MANUAL from the valid range here
840 m_params.emplace_back( new PARAM_ENUM<DIM_TEXT_POSITION>( "defaults.dimensions.text_position",
843
844 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.keep_text_aligned",
846
847 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.arrow_length",
850
851 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.extension_offset",
854
855 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_fields",
856 &m_StyleFPFields, false ) );
857 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_text",
858 &m_StyleFPText, false ) );
859 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_shapes",
860 &m_StyleFPShapes, false ) );
861 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_dimensions",
862 &m_StyleFPDimensions, false ) );
863 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_barcodes",
864 &m_StyleFPBarcodes, false ) );
865
866 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.zones.min_clearance",
867 &m_defaultZoneSettings.m_ZoneClearance, pcbIUScale.mmToIU( ZONE_CLEARANCE_MM ),
868 pcbIUScale.mmToIU( 0.0 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
869
870 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "defaults.pads",
871 [&]() -> nlohmann::json
872 {
873 nlohmann::json ret =
874 {
875 { "width", pcbIUScale.IUTomm( m_Pad_Master->GetSize( PADSTACK::ALL_LAYERS ).x ) },
876 { "height", pcbIUScale.IUTomm( m_Pad_Master->GetSize( PADSTACK::ALL_LAYERS ).y ) },
877 { "drill", pcbIUScale.IUTomm( m_Pad_Master->GetDrillSize().x ) }
878 };
879
880 return ret;
881 },
882 [&]( const nlohmann::json& aJson )
883 {
884 if( aJson.contains( "width" ) && aJson.contains( "height" )
885 && aJson.contains( "drill" ) )
886 {
887 VECTOR2I sz;
888 sz.x = pcbIUScale.mmToIU( aJson["width"].get<double>() );
889 sz.y = pcbIUScale.mmToIU( aJson["height"].get<double>() );
890
891 m_Pad_Master->SetSize( PADSTACK::ALL_LAYERS, sz );
892
893 int drill = pcbIUScale.mmToIU( aJson["drill"].get<double>() );
894
895 m_Pad_Master->SetDrillSize( VECTOR2I( drill, drill ) );
896 }
897 }, {} ) );
898
899 m_params.emplace_back( new PARAM_SCALED<int>( "rules.max_error",
901 pcbIUScale.mmToIU( 0.0001 ), pcbIUScale.mmToIU( 1.0 ), pcbIUScale.MM_PER_IU ) );
902
903 m_params.emplace_back( new PARAM_SCALED<int>( "rules.solder_mask_to_copper_clearance",
905 pcbIUScale.mmToIU( 0.0 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
906
907 m_params.emplace_back( new PARAM<bool>( "zones_allow_external_fillets",
908 &m_ZoneKeepExternalFillets, false ) );
909
911
912 registerMigration( 1, 2,
913 [&]() -> bool
914 {
915 // Schema 1 to 2: move mask and paste margin settings back to board.
916 // The parameters are removed, so we just have to manually load them here and
917 // they will get saved with the board
918 if( std::optional<double> optval = Get<double>( "rules.solder_mask_clearance" ) )
919 m_SolderMaskExpansion = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
920
921 if( std::optional<double> optval = Get<double>( "rules.solder_mask_min_width" ) )
922 m_SolderMaskMinWidth = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
923
924 if( std::optional<double> optval = Get<double>( "rules.solder_paste_clearance" ) )
925 m_SolderPasteMargin = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
926
927 if( std::optional<double> optval = Get<double>( "rules.solder_paste_margin_ratio" ) )
928 m_SolderPasteMarginRatio = *optval;
929
930 try
931 {
932 At( "rules" ).erase( "solder_mask_clearance" );
933 At( "rules" ).erase( "solder_mask_min_width" );
934 At( "rules" ).erase( "solder_paste_clearance" );
935 At( "rules" ).erase( "solder_paste_margin_ratio" );
936 }
937 catch( ... )
938 {}
939
940 return true;
941 } );
942}
943
944
946{
947 if( m_parent )
948 {
949 m_parent->ReleaseNestedSettings( this );
950 m_parent = nullptr;
951 }
952}
953
954
956 NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aOther.m_parent,
957 aOther.m_path ),
958 m_Pad_Master( nullptr )
959{
960 initFromOther( aOther );
961}
962
963
965{
966 initFromOther( aOther );
967 return *this;
968}
969
970
972{
973 // Copy of NESTED_SETTINGS around is not allowed, so let's just update the params.
982 m_MinConn = aOther.m_MinConn;
1000 m_MaxError = aOther.m_MaxError;
1013 m_CapVias = aOther.m_CapVias;
1014 m_FillVias = aOther.m_FillVias;
1017
1018 std::copy( std::begin( aOther.m_LineThickness ), std::end( aOther.m_LineThickness ),
1019 std::begin( m_LineThickness ) );
1020
1021 std::copy( std::begin( aOther.m_TextSize ), std::end( aOther.m_TextSize ),
1022 std::begin( m_TextSize ) );
1023
1024 std::copy( std::begin( aOther.m_TextThickness ), std::end( aOther.m_TextThickness ),
1025 std::begin( m_TextThickness ) );
1026
1027 std::copy( std::begin( aOther.m_TextItalic ), std::end( aOther.m_TextItalic ),
1028 std::begin( m_TextItalic ) );
1029
1030 std::copy( std::begin( aOther.m_TextUpright ), std::end( aOther.m_TextUpright ),
1031 std::begin( m_TextUpright ) );
1032
1041
1042 m_auxOrigin = aOther.m_auxOrigin;
1043 m_gridOrigin = aOther.m_gridOrigin;
1044 m_HasStackup = aOther.m_HasStackup;
1046
1060 m_stackup = aOther.m_stackup;
1062 m_Pad_Master = std::make_unique<PAD>( *aOther.m_Pad_Master );
1064
1070}
1071
1072
1074{
1075 if( m_TrackWidthList != aOther.m_TrackWidthList ) return false;
1076 if( m_ViasDimensionsList != aOther.m_ViasDimensionsList ) return false;
1077 if( m_DiffPairDimensionsList != aOther.m_DiffPairDimensionsList ) return false;
1078 if( m_CurrentViaType != aOther.m_CurrentViaType ) return false;
1079 if( m_UseConnectedTrackWidth != aOther.m_UseConnectedTrackWidth ) return false;
1080 if( m_TempOverrideTrackWidth != aOther.m_TempOverrideTrackWidth ) return false;
1081 if( m_MinClearance != aOther.m_MinClearance ) return false;
1082 if( m_MinGrooveWidth != aOther.m_MinGrooveWidth ) return false;
1083 if( m_MinConn != aOther.m_MinConn ) return false;
1084 if( m_TrackMinWidth != aOther.m_TrackMinWidth ) return false;
1085 if( m_ViasMinAnnularWidth != aOther.m_ViasMinAnnularWidth ) return false;
1086 if( m_ViasMinSize != aOther.m_ViasMinSize ) return false;
1087 if( m_MinThroughDrill != aOther.m_MinThroughDrill ) return false;
1088 if( m_MicroViasMinSize != aOther.m_MicroViasMinSize ) return false;
1089 if( m_MicroViasMinDrill != aOther.m_MicroViasMinDrill ) return false;
1090 if( m_CopperEdgeClearance != aOther.m_CopperEdgeClearance ) return false;
1091 if( m_HoleClearance != aOther.m_HoleClearance ) return false;
1092 if( m_HoleToHoleMin != aOther.m_HoleToHoleMin ) return false;
1093 if( m_SilkClearance != aOther.m_SilkClearance ) return false;
1094 if( m_MinResolvedSpokes != aOther.m_MinResolvedSpokes ) return false;
1095 if( m_MinSilkTextHeight != aOther.m_MinSilkTextHeight ) return false;
1096 if( m_MinSilkTextThickness != aOther.m_MinSilkTextThickness ) return false;
1097 if( m_DRCSeverities != aOther.m_DRCSeverities ) return false;
1098 if( m_DrcExclusions != aOther.m_DrcExclusions ) return false;
1099 if( m_DrcExclusionComments != aOther.m_DrcExclusionComments ) return false;
1100 if( m_ZoneKeepExternalFillets != aOther.m_ZoneKeepExternalFillets ) return false;
1101 if( m_MaxError != aOther.m_MaxError ) return false;
1102 if( m_SolderMaskExpansion != aOther.m_SolderMaskExpansion ) return false;
1103 if( m_SolderMaskMinWidth != aOther.m_SolderMaskMinWidth ) return false;
1105 if( m_SolderPasteMargin != aOther.m_SolderPasteMargin ) return false;
1106 if( m_SolderPasteMarginRatio != aOther.m_SolderPasteMarginRatio ) return false;
1108 if( m_TentViasFront != aOther.m_TentViasFront ) return false;
1109 if( m_TentViasBack != aOther.m_TentViasBack ) return false;
1110 if( m_CoverViasFront != aOther.m_CoverViasFront ) return false;
1111 if( m_CoverViasBack != aOther.m_CoverViasBack ) return false;
1112 if( m_PlugViasFront != aOther.m_PlugViasFront ) return false;
1113 if( m_PlugViasBack != aOther.m_PlugViasBack ) return false;
1114 if( m_CapVias != aOther.m_CapVias ) return false;
1115 if( m_FillVias != aOther.m_FillVias ) return false;
1116 if( m_DefaultFPTextItems != aOther.m_DefaultFPTextItems ) return false;
1117 if( m_UserLayerNames != aOther.m_UserLayerNames ) return false;
1118
1119 if( !std::equal( std::begin( m_LineThickness ), std::end( m_LineThickness ),
1120 std::begin( aOther.m_LineThickness ) ) )
1121 return false;
1122
1123 if( !std::equal( std::begin( m_TextSize ), std::end( m_TextSize ),
1124 std::begin( aOther.m_TextSize ) ) )
1125 return false;
1126
1127 if( !std::equal( std::begin( m_TextThickness ), std::end( m_TextThickness ),
1128 std::begin( aOther.m_TextThickness ) ) )
1129 return false;
1130
1131 if( !std::equal( std::begin( m_TextItalic ), std::end( m_TextItalic ),
1132 std::begin( aOther.m_TextItalic ) ) )
1133 return false;
1134
1135 if( !std::equal( std::begin( m_TextUpright ), std::end( m_TextUpright ),
1136 std::begin( aOther.m_TextUpright ) ) )
1137 return false;
1138
1139 if( m_DimensionUnitsMode != aOther.m_DimensionUnitsMode ) return false;
1140 if( m_DimensionPrecision != aOther.m_DimensionPrecision ) return false;
1141 if( m_DimensionUnitsFormat != aOther.m_DimensionUnitsFormat ) return false;
1142 if( m_DimensionSuppressZeroes != aOther.m_DimensionSuppressZeroes ) return false;
1143 if( m_DimensionTextPosition != aOther.m_DimensionTextPosition ) return false;
1144 if( m_DimensionKeepTextAligned != aOther.m_DimensionKeepTextAligned ) return false;
1145 if( m_DimensionArrowLength != aOther.m_DimensionArrowLength ) return false;
1146 if( m_DimensionExtensionOffset != aOther.m_DimensionExtensionOffset ) return false;
1147 if( m_auxOrigin != aOther.m_auxOrigin ) return false;
1148 if( m_gridOrigin != aOther.m_gridOrigin ) return false;
1149 if( m_HasStackup != aOther.m_HasStackup ) return false;
1150 if( m_UseHeightForLengthCalcs != aOther.m_UseHeightForLengthCalcs ) return false;
1151 if( m_trackWidthIndex != aOther.m_trackWidthIndex ) return false;
1152 if( m_viaSizeIndex != aOther.m_viaSizeIndex ) return false;
1153 if( m_diffPairIndex != aOther.m_diffPairIndex ) return false;
1154 if( m_useCustomTrackVia != aOther.m_useCustomTrackVia ) return false;
1155 if( m_customTrackWidth != aOther.m_customTrackWidth ) return false;
1156 if( m_customViaSize != aOther.m_customViaSize ) return false;
1157 if( m_useCustomDiffPair != aOther.m_useCustomDiffPair ) return false;
1158 if( m_customDiffPair != aOther.m_customDiffPair ) return false;
1159 if( m_copperLayerCount != aOther.m_copperLayerCount ) return false;
1160 if( m_userDefinedLayerCount != aOther.m_userDefinedLayerCount ) return false;
1161 if( m_enabledLayers != aOther.m_enabledLayers ) return false;
1162 if( m_boardThickness != aOther.m_boardThickness ) return false;
1163 if( m_currentNetClassName != aOther.m_currentNetClassName ) return false;
1164 if( m_stackup != aOther.m_stackup ) return false;
1165 if( *m_NetSettings != *aOther.m_NetSettings ) return false;
1166 if( *m_Pad_Master != *aOther.m_Pad_Master ) return false;
1167 if( m_defaultZoneSettings != aOther.m_defaultZoneSettings ) return false;
1168
1169 if( m_StyleFPFields != aOther.m_StyleFPFields ) return false;
1170 if( m_StyleFPText != aOther.m_StyleFPText ) return false;
1171 if( m_StyleFPShapes != aOther.m_StyleFPShapes ) return false;
1172 if( m_StyleFPDimensions != aOther.m_StyleFPDimensions ) return false;
1173 if( m_StyleFPBarcodes != aOther.m_StyleFPBarcodes ) return false;
1174
1175 return true;
1176}
1177
1178
1180{
1198 std::string units_ptr( "defaults.dimension_units" );
1199 std::string precision_ptr( "defaults.dimension_precision" );
1200
1201 if( !( Contains( units_ptr )
1202 && Contains( precision_ptr )
1203 && At( units_ptr ).is_number_integer()
1204 && At( precision_ptr ).is_number_integer() ) )
1205 {
1206 // if either is missing or invalid, migration doesn't make sense
1207 return true;
1208 }
1209
1210 int units = *Get<int>( units_ptr );
1211 int precision = *Get<int>( precision_ptr );
1212
1213 // The enum maps directly to precision if the units is mils
1214 int extraDigits = 0;
1215
1216 switch( units )
1217 {
1218 case 0: extraDigits = 3; break;
1219 case 2: extraDigits = 2; break;
1220 default: break;
1221 }
1222
1223 precision += extraDigits;
1224
1225 Set( precision_ptr, precision );
1226
1227 return true;
1228}
1229
1230
1231bool BOARD_DESIGN_SETTINGS::LoadFromFile( const wxString& aDirectory )
1232{
1233 bool ret = NESTED_SETTINGS::LoadFromFile( aDirectory );
1234
1235 // A number of things won't have been translated by the PROJECT_FILE migration because of
1236 // descoped objects required to decode this data. So, it will be in the legacy.pcbnew
1237 // section and needs to be pulled out here
1238
1239 PROJECT_FILE* project = dynamic_cast<PROJECT_FILE*>( GetParent() );
1240
1241 if( !project )
1242 return ret;
1243
1244 bool migrated = false;
1245
1246 auto drcName =
1247 []( int aCode ) -> std::string
1248 {
1249 return std::string( DRC_ITEM::Create( aCode )->GetSettingsKey().ToUTF8() );
1250 };
1251
1252 const std::string rs = "rule_severities.";
1253 const std::string no_courtyard_key = "legacy_no_courtyard_defined";
1254 const std::string courtyard_overlap_key = "legacy_courtyards_overlap";
1255
1256 try
1257 {
1258 nlohmann::json& severities =
1259 project->Internals()->at( "/board/design_settings/rule_severities"_json_pointer );
1260
1261 if( severities.contains( no_courtyard_key ) )
1262 {
1263 if( severities[no_courtyard_key].get<bool>() )
1264 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "error" );
1265 else
1266 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "ignore" );
1267
1268 severities.erase( no_courtyard_key );
1269 migrated = true;
1270 }
1271
1272 if( severities.contains( courtyard_overlap_key ) )
1273 {
1274 if( severities[courtyard_overlap_key].get<bool>() )
1275 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "error" );
1276 else
1277 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "ignore" );
1278
1279 severities.erase( courtyard_overlap_key );
1280 migrated = true;
1281 }
1282 }
1283 catch( ... )
1284 {
1285 }
1286
1287 if( Contains( "legacy" ) )
1288 {
1289 // This defaults to false for new boards, but version 5.1.x and prior kept the fillets
1290 // so we do the same for legacy boards.
1292
1293 project->At( "legacy" ).erase( "pcbnew" );
1294 }
1295
1296 // Now that we have everything, we need to load again
1297 if( migrated )
1298 Load();
1299
1300 return ret;
1301}
1302
1303
1305{
1306 return m_DRCSeverities[ aDRCErrorCode ];
1307}
1308
1309
1310bool BOARD_DESIGN_SETTINGS::Ignore( int aDRCErrorCode )
1311{
1312 return m_DRCSeverities[ aDRCErrorCode ] == RPT_SEVERITY_IGNORE;
1313}
1314
1315
1317{
1318 int biggest = std::max( m_MinClearance, m_HoleClearance );
1319 DRC_CONSTRAINT constraint;
1320
1321 biggest = std::max( biggest, m_HoleToHoleMin );
1322 biggest = std::max( biggest, m_CopperEdgeClearance );
1323
1324 if( m_DRCEngine )
1325 {
1326 m_DRCEngine->QueryWorstConstraint( CLEARANCE_CONSTRAINT, constraint );
1327 biggest = std::max( biggest, constraint.Value().Min() );
1328
1329 m_DRCEngine->QueryWorstConstraint( PHYSICAL_CLEARANCE_CONSTRAINT, constraint );
1330 biggest = std::max( biggest, constraint.Value().Min() );
1331
1332 m_DRCEngine->QueryWorstConstraint( HOLE_CLEARANCE_CONSTRAINT, constraint );
1333 biggest = std::max( biggest, constraint.Value().Min() );
1334
1335 m_DRCEngine->QueryWorstConstraint( EDGE_CLEARANCE_CONSTRAINT, constraint );
1336 biggest = std::max( biggest, constraint.Value().Min() );
1337
1338 m_DRCEngine->QueryWorstConstraint( HOLE_TO_HOLE_CONSTRAINT, constraint );
1339 biggest = std::max( biggest, constraint.Value().Min() );
1340 }
1341
1342 // Clip to avoid integer overflows in subsequent calculations
1343 return std::min( biggest, MAXIMUM_CLEARANCE );
1344}
1345
1346
1348{
1349 int clearance = m_NetSettings->GetDefaultNetclass()->GetClearance();
1350
1351 for( const auto& [name, netclass] : m_NetSettings->GetNetclasses() )
1352 clearance = std::min( clearance, netclass->GetClearance() );
1353
1354 return clearance;
1355}
1356
1357
1359{
1360 m_viaSizeIndex = std::min( aIndex, (int) m_ViasDimensionsList.size() - 1 );
1361 m_useCustomTrackVia = false;
1362}
1363
1364
1366{
1368 return m_customViaSize.m_Diameter;
1370 return m_NetSettings->GetDefaultNetclass()->GetViaDiameter();
1371 else
1372 return m_ViasDimensionsList[ m_viaSizeIndex ].m_Diameter;
1373}
1374
1375
1377{
1378 int drill;
1379
1381 drill = m_customViaSize.m_Drill;
1383 drill = m_NetSettings->GetDefaultNetclass()->GetViaDrill();
1384 else
1385 drill = m_ViasDimensionsList[ m_viaSizeIndex ].m_Drill;
1386
1387 return drill > 0 ? drill : -1;
1388}
1389
1390
1392{
1393 m_trackWidthIndex = std::min( aIndex, (int) m_TrackWidthList.size() - 1 );
1394 m_useCustomTrackVia = false;
1395}
1396
1397
1399{
1401 return m_customTrackWidth;
1403 return m_NetSettings->GetDefaultNetclass()->GetTrackWidth();
1404 else
1406}
1407
1408
1410{
1411 if( !m_DiffPairDimensionsList.empty() )
1412 m_diffPairIndex = std::min( aIndex, (int) m_DiffPairDimensionsList.size() - 1 );
1413
1414 m_useCustomDiffPair = false;
1415}
1416
1417
1419{
1421 {
1422 return m_customDiffPair.m_Width;
1423 }
1425 {
1426 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairWidth() )
1427 return m_NetSettings->GetDefaultNetclass()->GetDiffPairWidth();
1428 else
1429 return m_NetSettings->GetDefaultNetclass()->GetTrackWidth();
1430 }
1431 else
1432 {
1434 }
1435}
1436
1437
1439{
1441 {
1442 return m_customDiffPair.m_Gap;
1443 }
1444 else if( m_diffPairIndex == 0 )
1445 {
1446 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairGap() )
1447 return m_NetSettings->GetDefaultNetclass()->GetDiffPairGap();
1448 else
1449 return m_NetSettings->GetDefaultNetclass()->GetClearance();
1450 }
1451 else
1452 {
1454 }
1455}
1456
1457
1459{
1461 {
1462 return m_customDiffPair.m_ViaGap;
1463 }
1464 else if( m_diffPairIndex == 0 )
1465 {
1466 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairViaGap() )
1467 return m_NetSettings->GetDefaultNetclass()->GetDiffPairViaGap();
1468 else
1469 return GetCurrentDiffPairGap();
1470 }
1471 else
1472 {
1474 }
1475}
1476
1477
1479{
1480 m_copperLayerCount = aNewLayerCount;
1481
1482 // Update only enabled copper layers mask
1483 m_enabledLayers.ClearCopperLayers();
1484
1485 if( aNewLayerCount > 0 )
1486 m_enabledLayers |= LSET::AllCuMask( aNewLayerCount );
1487}
1488
1489
1491{
1492 m_userDefinedLayerCount = aNewLayerCount;
1493
1494 m_enabledLayers.ClearUserDefinedLayers();
1495
1496 if( aNewLayerCount > 0 )
1497 m_enabledLayers |= LSET::UserDefinedLayersMask( aNewLayerCount );
1498}
1499
1500
1502{
1503 m_enabledLayers = aMask;
1504
1505 // Ensures mandatory back and front layers are always enabled regardless of board file
1506 // configuration.
1507 m_enabledLayers.set( B_Cu ).set( F_Cu )
1508 .set( B_CrtYd ).set( F_CrtYd )
1509 .set( Edge_Cuts )
1510 .set( Margin );
1511
1512 // update layer counts to ensure their consistency with m_EnabledLayers
1513 LSET copperLayers = aMask;
1514 copperLayers.ClearNonCopperLayers();
1515
1516 LSET userLayers = aMask & LSET::UserDefinedLayersMask();
1517
1518 m_copperLayerCount = (int) copperLayers.count();
1519 m_userDefinedLayerCount = (int) userLayers.count();
1520}
1521
1522
1523// Return the layer class index { silk, copper, edges & courtyards, fab, others } of the
1524// given layer.
1526{
1527 if( aLayer == F_SilkS || aLayer == B_SilkS )
1528 return LAYER_CLASS_SILK;
1529 else if( IsCopperLayer( aLayer ) )
1530 return LAYER_CLASS_COPPER;
1531 else if( aLayer == Edge_Cuts )
1532 return LAYER_CLASS_EDGES;
1533 else if( aLayer == F_CrtYd || aLayer == B_CrtYd )
1534 return LAYER_CLASS_COURTYARD;
1535 else if( aLayer == F_Fab || aLayer == B_Fab )
1536 return LAYER_CLASS_FAB;
1537 else
1538 return LAYER_CLASS_OTHERS;
1539}
1540
1541
1543{
1544 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_DRCEpsilon );
1545}
1546
1547
1549{
1550 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_HoleWallThickness );
1551}
1552
1553
1555{
1556 return m_LineThickness[ GetLayerClass( aLayer ) ];
1557}
1558
1559
1561{
1562 return m_TextSize[ GetLayerClass( aLayer ) ];
1563}
1564
1565
1567{
1568 return m_TextThickness[ GetLayerClass( aLayer ) ];
1569}
1570
1571
1573{
1574 return m_TextItalic[ GetLayerClass( aLayer ) ];
1575}
1576
1577
1579{
1580 return m_TextUpright[ GetLayerClass( aLayer ) ];
1581}
1582
1584{
1585 m_Pad_Master->SetSizeX( pcbIUScale.mmToIU( DEFAULT_PAD_WIDTH_MM ) );
1586 m_Pad_Master->SetSizeY( pcbIUScale.mmToIU( DEFAULT_PAD_HEIGTH_MM ) );
1587 m_Pad_Master->SetDrillShape( PAD_DRILL_SHAPE::CIRCLE );
1588 m_Pad_Master->SetDrillSize( VECTOR2I( pcbIUScale.mmToIU( DEFAULT_PAD_DRILL_DIAMETER_MM ), 0 ) );
1590
1591 constexpr double RR_RADIUS = DEFAULT_PAD_HEIGTH_MM * DEFAULT_PAD_RR_RADIUS_RATIO;
1592 m_Pad_Master->SetRoundRectCornerRadius( PADSTACK::ALL_LAYERS, pcbIUScale.mmToIU( RR_RADIUS ) );
1593
1594 if( m_Pad_Master->GetFrontShape() == PAD_SHAPE::CIRCLE )
1595 m_Pad_Master->SetThermalSpokeAngle( ANGLE_45 );
1596 else
1597 m_Pad_Master->SetThermalSpokeAngle( ANGLE_90 );
1598}
const char * name
constexpr int ARC_HIGH_DEF
Definition base_units.h:129
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
const int bdsSchemaVersion
#define DEFAULT_MICROVIASMINDRILL
#define DEFAULT_SOLDERPASTE_CLEARANCE
#define DEFAULT_SOLDERPASTE_RATIO
#define DEFAULT_CUSTOMDPAIRWIDTH
#define DEFAULT_DP_MEANDER_SPACING
@ LAYER_CLASS_OTHERS
@ LAYER_CLASS_FAB
@ LAYER_CLASS_COURTYARD
@ LAYER_CLASS_SILK
@ LAYER_CLASS_COPPER
@ LAYER_CLASS_EDGES
#define DEFAULT_PAD_WIDTH_MM
#define DEFAULT_VIASMINSIZE
#define DEFAULT_PAD_DRILL_DIAMETER_MM
#define DEFAULT_TEXT_WIDTH
#define DEFAULT_COPPER_TEXT_WIDTH
#define DEFAULT_CUSTOMDPAIRGAP
#define DEFAULT_MINCLEARANCE
#define DEFAULT_HOLECLEARANCE
#define DEFAULT_SOLDERMASK_EXPANSION
#define DEFAULT_SOLDERMASK_MIN_WIDTH
#define DEFAULT_DIMENSION_EXTENSION_OFFSET
#define DEFAULT_COPPEREDGECLEARANCE
#define DEFAULT_PAD_HEIGTH_MM
#define DEFAULT_DIMENSION_ARROW_LENGTH
#define DEFAULT_TRACKMINWIDTH
#define DEFAULT_MINTHROUGHDRILL
#define DEFAULT_PAD_RR_RADIUS_RATIO
#define DEFAULT_SILK_TEXT_SIZE
#define MAXIMUM_CLEARANCE
#define DEFAULT_HOLETOHOLEMIN
#define DEFAULT_MINCONNECTION
#define DEFAULT_COPPER_LINE_WIDTH
#define DEFAULT_SILK_LINE_WIDTH
#define DEFAULT_SILKCLEARANCE
#define DEFAULT_MICROVIASMINSIZE
#define DEFAULT_SILK_TEXT_WIDTH
#define DEFAULT_MINGROOVEWIDTH
#define DEFAULT_TEXT_SIZE
#define DEFAULT_EDGE_WIDTH
#define DEFAULT_CUSTOMTRACKWIDTH
#define DEFAULT_CUSTOMDPAIRVIAGAP
#define DEFAULT_COPPER_TEXT_SIZE
#define DEFAULT_SOLDERMASK_TO_COPPER_CLEARANCE
#define DEFAULT_LINE_WIDTH
#define DEFAULT_MEANDER_SPACING
#define DEFAULT_COURTYARD_WIDTH
#define DEFAULT_BOARD_THICKNESS_MM
#define DEFAULT_MINRESOLVEDSPOKES
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
BASE_SET & set(size_t pos)
Definition base_set.h:116
DIM_PRECISION m_DimensionPrecision
Number of digits after the decimal.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
int GetHolePlatingThickness() const
Pad & via drills are finish size.
VIATYPE m_CurrentViaType
(VIA_BLIND_BURIED, VIA_THROUGH, VIA_MICROVIA)
void SetEnabledLayers(const LSET &aMask)
Change the bit-mask of enabled layers to aMask.
std::shared_ptr< NET_SETTINGS > m_NetSettings
bool operator==(const BOARD_DESIGN_SETTINGS &aOther) const
std::map< wxString, wxString > m_DrcExclusionComments
DIM_UNITS_FORMAT m_DimensionUnitsFormat
void initFromOther(const BOARD_DESIGN_SETTINGS &aOther)
bool GetTextUpright(PCB_LAYER_ID aLayer) const
std::map< int, SEVERITY > m_DRCSeverities
VECTOR2I m_gridOrigin
origin for grid offsets
int GetTextThickness(PCB_LAYER_ID aLayer) const
Return the default text thickness from the layer class for the given layer.
VECTOR2I m_auxOrigin
origin for plot exports
bool m_TextUpright[LAYER_CLASS_COUNT]
BOARD_DESIGN_SETTINGS(JSON_SETTINGS *aParent, const std::string &aPath)
bool GetTextItalic(PCB_LAYER_ID aLayer) const
wxString m_currentNetClassName
Current net class name used to display netclass info.
void SetViaSizeIndex(int aIndex)
Set the current via size list index to aIndex.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
std::vector< DIFF_PAIR_DIMENSION > m_DiffPairDimensionsList
std::set< wxString > m_DrcExclusions
bool Ignore(int aDRCErrorCode)
Return true if the DRC error code's severity is SEVERITY_IGNORE.
std::map< std::string, wxString > m_UserLayerNames
std::unique_ptr< PAD > m_Pad_Master
TEARDROP_PARAMETERS_LIST m_TeardropParamsList
The parameters of teardrops for the different teardrop targets (via/pad, track end).
void SetUserDefinedLayerCount(int aNewLayerCount)
Set the number of user defined layers to aNewLayerCount.
int GetDRCEpsilon() const
Return an epsilon which accounts for rounding errors, etc.
int GetLayerClass(PCB_LAYER_ID aLayer) const
PNS::MEANDER_SETTINGS m_DiffPairMeanderSettings
int m_boardThickness
Board thickness for 3D viewer.
int m_copperLayerCount
Number of copper layers for this design.
int m_userDefinedLayerCount
Number of user defined layers for this design.
bool LoadFromFile(const wxString &aDirectory="") override
Loads the backing file from disk and then calls Load()
PNS::MEANDER_SETTINGS m_SingleTrackMeanderSettings
void SetTrackWidthIndex(int aIndex)
Set the current track width list index to aIndex.
int m_TextThickness[LAYER_CLASS_COUNT]
ZONE_SETTINGS m_defaultZoneSettings
The default settings that will be used for new zones.
SEVERITY GetSeverity(int aDRCErrorCode)
std::vector< int > m_TrackWidthList
DIFF_PAIR_DIMENSION m_customDiffPair
int m_LineThickness[LAYER_CLASS_COUNT]
VECTOR2I GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
int GetLineThickness(PCB_LAYER_ID aLayer) const
Return the default graphic segment thickness from the layer class for the given layer.
bool m_UseHeightForLengthCalcs
Enable inclusion of stackup height in track length measurements and length tuning.
VECTOR2I m_TextSize[LAYER_CLASS_COUNT]
PNS::MEANDER_SETTINGS m_SkewMeanderSettings
LSET m_enabledLayers
Bit-mask for layer enabling.
bool m_TextItalic[LAYER_CLASS_COUNT]
void SetCopperLayerCount(int aNewLayerCount)
Set the copper layer count to aNewLayerCount.
DIM_TEXT_POSITION m_DimensionTextPosition
BOARD_STACKUP m_stackup
The description of layers stackup, for board fabrication only physical layers are in layers stackup.
std::vector< VIA_DIMENSION > m_ViasDimensionsList
BOARD_DESIGN_SETTINGS & operator=(const BOARD_DESIGN_SETTINGS &aOther)
MINOPTMAX< int > & Value()
Definition drc_rule.h:167
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition drc_item.h:133
static std::shared_ptr< DRC_ITEM > Create(int aErrorCode)
Constructs a DRC_ITEM for the given error code.
Definition drc_item.cpp:381
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...
bool Contains(const std::string &aPath) const
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
std::optional< ValueType > Get(const std::string &aPath) const
Fetches a value from within the JSON document.
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...
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
LSET & ClearNonCopperLayers()
Clear the non-copper layers in this set.
Definition lset.cpp:934
static LSET UserDefinedLayersMask(int aUserDefinedLayerCount=MAX_USER_DEFINED_LAYERS)
Return a mask with the requested number of user defined layers.
Definition lset.cpp:687
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:591
T Min() const
Definition minoptmax.h:33
std::string m_path
The path (in pointer format) of where to store this document in the parent.
JSON_SETTINGS * GetParent()
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
NESTED_SETTINGS(const std::string &aName, int aSchemaVersion, JSON_SETTINGS *aParent, const std::string &aPath, bool aLoadFromFile=true)
bool LoadFromFile(const wxString &aDirectory="") override
Loads the JSON document from the parent and then calls Load()
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
Definition padstack.h:145
Stores an enum as an integer.
Definition parameters.h:229
Like a normal param, but with custom getter and setter functions.
Definition parameters.h:296
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition parameters.h:393
Dimensions for the meandering algorithm.
Definition pns_meander.h:68
int m_minAmplitude
Maximum meandering amplitude.
Definition pns_meander.h:93
int m_cornerRadiusPercentage
Place meanders on one side.
bool m_singleSided
Initial side when placing meanders at segment.
MEANDER_STYLE m_cornerStyle
Rounding percentage (0 - 100).
int m_maxAmplitude
Meandering period/spacing (see dialog picture for explanation).
Definition pns_meander.h:96
int m_spacing
Amplitude/spacing adjustment step.
Definition pns_meander.h:99
The backing store for a PROJECT, in JSON format.
A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
Definition rc_item.h:79
TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board thes...
double m_BestWidthRatio
The height of a teardrop as ratio between height and size of pad/via.
int m_TdMaxLen
max allowed length for teardrops in IU. <= 0 to disable
bool m_AllowUseTwoTracks
True to create teardrops using 2 track segments if the first in too small.
int m_TdMaxWidth
max allowed height for teardrops in IU. <= 0 to disable
double m_BestLengthRatio
The length of a teardrop as ratio between length and size of pad/via.
double m_WidthtoSizeFilterRatio
The ratio (H/D) between the via/pad size and the track width max value to create a teardrop 1....
bool m_TdOnPadsInZones
A filter to exclude pads inside zone fills.
bool m_CurvedEdges
True if the teardrop should be curved.
@ DRCE_SILK_EDGE_CLEARANCE
Definition drc_item.h:98
@ DRCE_FOOTPRINT_FILTERS
Definition drc_item.h:79
@ DRCE_SILK_MASK_CLEARANCE
Definition drc_item.h:96
@ DRCE_PADSTACK
Definition drc_item.h:62
@ DRCE_MIRRORED_TEXT_ON_FRONT_LAYER
Definition drc_item.h:109
@ DRCE_LIB_FOOTPRINT_ISSUES
Definition drc_item.h:82
@ DRCE_OVERLAPPING_FOOTPRINTS
Definition drc_item.h:65
@ DRCE_OVERLAPPING_SILK
Definition drc_item.h:101
@ DRCE_MISSING_COURTYARD
Definition drc_item.h:66
@ DRCE_ISOLATED_COPPER
Definition drc_item.h:48
@ DRCE_DRILLED_HOLES_TOO_CLOSE
Definition drc_item.h:52
@ DRCE_COPPER_SLIVER
Definition drc_item.h:92
@ DRCE_PTH_IN_COURTYARD
Definition drc_item.h:69
@ DRCE_FIRST
Definition drc_item.h:38
@ DRCE_DANGLING_VIA
Definition drc_item.h:50
@ DRCE_FOOTPRINT_TYPE_MISMATCH
Definition drc_item.h:81
@ DRCE_NONMIRRORED_TEXT_ON_BACK_LAYER
Definition drc_item.h:110
@ DRCE_DUPLICATE_FOOTPRINT
Definition drc_item.h:75
@ DRCE_DANGLING_TRACK
Definition drc_item.h:51
@ DRCE_TEXT_HEIGHT
Definition drc_item.h:99
@ DRCE_DRILLED_HOLES_COLOCATED
Definition drc_item.h:53
@ DRCE_EXTRA_FOOTPRINT
Definition drc_item.h:76
@ DRCE_LAST
Definition drc_item.h:112
@ DRCE_LIB_FOOTPRINT_MISMATCH
Definition drc_item.h:83
@ DRCE_NET_CONFLICT
Definition drc_item.h:77
@ DRCE_MISSING_FOOTPRINT
Definition drc_item.h:74
@ DRCE_TEXT_THICKNESS
Definition drc_item.h:100
@ DRCE_NPTH_IN_COURTYARD
Definition drc_item.h:70
@ DRCE_CONNECTION_WIDTH
Definition drc_item.h:59
@ DRCE_SCHEMATIC_PARITY
Definition drc_item.h:78
@ EDGE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:53
@ CLEARANCE_CONSTRAINT
Definition drc_rule.h:49
@ HOLE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:51
@ PHYSICAL_CLEARANCE_CONSTRAINT
Definition drc_rule.h:77
@ HOLE_TO_HOLE_CONSTRAINT
Definition drc_rule.h:52
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:413
static constexpr EDA_ANGLE ANGLE_45
Definition eda_angle.h:412
#define TEXT_MIN_SIZE_MM
Minimum text size (1 micron).
Definition eda_text.h:47
#define TEXT_MAX_SIZE_MM
Maximum text size in mm (~10 inches)
Definition eda_text.h:48
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:676
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ F_CrtYd
Definition layer_ids.h:116
@ Edge_Cuts
Definition layer_ids.h:112
@ B_Cu
Definition layer_ids.h:65
@ F_Fab
Definition layer_ids.h:119
@ Margin
Definition layer_ids.h:113
@ F_SilkS
Definition layer_ids.h:100
@ B_CrtYd
Definition layer_ids.h:115
@ B_SilkS
Definition layer_ids.h:101
@ F_Cu
Definition layer_ids.h:64
@ B_Fab
Definition layer_ids.h:118
@ MEANDER_STYLE_ROUND
Definition pns_meander.h:52
@ MEANDER_STYLE_CHAMFER
Definition pns_meander.h:53
@ ROUNDRECT
Definition padstack.h:57
@ OUTSIDE
Text appears outside the dimension line (default)
@ INLINE
Text appears in line with the dimension line.
@ THROUGH
Definition pcb_track.h:68
SEVERITY
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_IGNORE
Container to handle a stock of specific differential pairs each with unique track width,...
Container to handle a stock of specific vias each with unique diameter and drill sizes in the BOARD c...
std::string GetTeardropTargetCanonicalName(TARGET_TD aTdType)
TARGET_TD GetTeardropTargetTypeFromCanonicalName(const std::string &aTargetName)
int clearance
SEVERITY SeverityFromString(const wxString &aSeverity)
Definition ui_common.cpp:56
wxString SeverityToString(const SEVERITY &aSeverity)
Definition ui_common.cpp:67
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695
#define ZONE_CLEARANCE_MM
Definition zones.h:37