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 (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <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 SetCopperLayerCount( 2 ); // Default design is a double sided board
64 m_CurrentViaType = VIATYPE::THROUGH;
65
66 // if true, when creating a new track starting on an existing track, use this track width
69
70 // First is always the reference designator
71 m_DefaultFPTextItems.emplace_back( wxT( "REF**" ), true, F_SilkS );
72 // Second is always the value
73 m_DefaultFPTextItems.emplace_back( wxT( "" ), true, F_Fab );
74 // Any following ones are freebies
75 m_DefaultFPTextItems.emplace_back( wxT( "${REFERENCE}" ), true, F_Fab );
76
83
90
91 // Edges & Courtyards; text properties aren't used but better to have them holding
92 // reasonable values than not.
99
106
111 m_TextItalic[ LAYER_CLASS_FAB ] = false;
113
120
121 m_StyleFPFields = false;
122 m_StyleFPText = false;
123 m_StyleFPShapes = false;
124
125 m_DimensionPrecision = DIM_PRECISION::X_XXXX;
126 m_DimensionUnitsMode = DIM_UNITS_MODE::AUTOMATIC;
127 m_DimensionUnitsFormat = DIM_UNITS_FORMAT::NO_SUFFIX;
129 m_DimensionTextPosition = DIM_TEXT_POSITION::OUTSIDE;
133
134 m_useCustomTrackVia = false;
138
139 m_useCustomDiffPair = false;
143
160
161 for( int errorCode = DRCE_FIRST; errorCode <= DRCE_LAST; ++errorCode )
162 m_DRCSeverities[ errorCode ] = RPT_SEVERITY_ERROR;
163
166
170
173
176
178
185
191
193
196
198
201
205
206 // Global mask margins:
210
211 // Solder paste margin absolute value
213 // Solder paste margin as a ratio of pad size
214 // The final margin is the sum of these 2 values
215 // Usually < 0 because the mask is smaller than pad
217
219 m_TentViasFront = true;
220 m_TentViasBack = true;
221
222 // Layer thickness for 3D viewer
224
225 // Default spacing for meanders
229
230 m_viaSizeIndex = 0;
232 m_diffPairIndex = 0;
233
234 // Parameters stored in JSON in the project file
235
236 // NOTE: Previously, BOARD_DESIGN_SETTINGS stored the basic board layer information (layer
237 // names and enable/disable state) in the project file even though this information is also
238 // stored in the board file. This was implemented for importing these settings from another
239 // project. Going forward, the import feature will just import from other board files (since
240 // we could have multi-board projects in the future anyway) so this functionality is dropped.
241
242
243 m_params.emplace_back( new PARAM<bool>( "rules.use_height_for_length_calcs",
244 &m_UseHeightForLengthCalcs, true ) );
245
246 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_clearance",
249
250 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_connection",
252 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
253
254 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_track_width",
257
258 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_annular_width",
261
262 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_diameter",
265
266 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_through_hole_diameter",
269
270 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_diameter",
273
274 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_drill",
277
278 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_to_hole",
281
282 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_clearance",
284 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
285
286 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_silk_clearance",
288 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
289
290 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_groove_width",
293
294 // While the maximum *effective* value is 4, we've had users interpret this as the count on
295 // all layers, and enter something like 10. They'll figure it out soon enough *unless* we
296 // enforce a max of 4 (and therefore reset it back to the default of 2), at which point it
297 // just looks buggy.
298 m_params.emplace_back( new PARAM<int>( "rules.min_resolved_spokes",
300
301 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_height",
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_text_thickness",
308
309 // Note: a clearance of -0.01 is a flag indicating we should use the legacy (pre-6.0) method
310 // based on the edge cut thicknesses.
311 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_copper_edge_clearance",
313 pcbIUScale.mmToIU( -0.01 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
314
315 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
316 [&]() -> nlohmann::json
317 {
318 nlohmann::json ret = {};
319
320 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
321 {
322 wxString name = item.GetSettingsKey();
323 int code = item.GetErrorCode();
324
325 if( name.IsEmpty() || m_DRCSeverities.count( code ) == 0 )
326 continue;
327
328 ret[std::string( name.ToUTF8() )] = SeverityToString( m_DRCSeverities[code] );
329 }
330
331 return ret;
332 },
333 [&]( const nlohmann::json& aJson )
334 {
335 if( !aJson.is_object() )
336 return;
337
338 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities( true ) )
339 {
340 wxString name = item.GetSettingsKey();
341 std::string key( name.ToUTF8() );
342
343 if( aJson.contains( key ) )
344 m_DRCSeverities[item.GetErrorCode()] = SeverityFromString( aJson[key] );
345 }
346 }, {} ) );
347
348 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "drc_exclusions",
349 [&]() -> nlohmann::json
350 {
351 nlohmann::json js = nlohmann::json::array();
352
353 for( const wxString& entry : m_DrcExclusions )
354 js.push_back( { entry, m_DrcExclusionComments[ entry ] } );
355
356 return js;
357 },
358 [&]( const nlohmann::json& aObj )
359 {
360 m_DrcExclusions.clear();
361
362 if( !aObj.is_array() )
363 return;
364
365 for( const nlohmann::json& entry : aObj )
366 {
367 if( entry.is_array() )
368 {
369 wxString serialized = entry[0].get<wxString>();
370 m_DrcExclusions.insert( serialized );
371 m_DrcExclusionComments[ serialized ] = entry[1].get<wxString>();
372 }
373 else if( entry.is_string() )
374 {
375 m_DrcExclusions.insert( entry.get<wxString>() );
376 }
377 }
378 },
379 {} ) );
380
381 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "track_widths",
382 [&]() -> nlohmann::json
383 {
384 nlohmann::json js = nlohmann::json::array();
385
386 for( const int& width : m_TrackWidthList )
387 js.push_back( pcbIUScale.IUTomm( width ) );
388
389 return js;
390 },
391 [&]( const nlohmann::json& aJson )
392 {
393 if( !aJson.is_array() )
394 return;
395
396 m_TrackWidthList.clear();
397
398 for( const nlohmann::json& entry : aJson )
399 {
400 if( entry.empty() )
401 continue;
402
403 m_TrackWidthList.emplace_back( pcbIUScale.mmToIU( entry.get<double>() ) );
404 }
405 },
406 {} ) );
407
408 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "via_dimensions",
409 [&]() -> nlohmann::json
410 {
411 nlohmann::json js = nlohmann::json::array();
412
413 for( const auto& via : m_ViasDimensionsList )
414 {
415 nlohmann::json entry = {};
416
417 entry["diameter"] = pcbIUScale.IUTomm( via.m_Diameter );
418 entry["drill"] = pcbIUScale.IUTomm( via.m_Drill );
419
420 js.push_back( entry );
421 }
422
423 return js;
424 },
425 [&]( const nlohmann::json& aObj )
426 {
427 if( !aObj.is_array() )
428 return;
429
430 m_ViasDimensionsList.clear();
431
432 for( const nlohmann::json& entry : aObj )
433 {
434 if( entry.empty() || !entry.is_object() )
435 continue;
436
437 if( !entry.contains( "diameter" ) || !entry.contains( "drill" ) )
438 continue;
439
440 int diameter = pcbIUScale.mmToIU( entry["diameter"].get<double>() );
441 int drill = pcbIUScale.mmToIU( entry["drill"].get<double>() );
442
443 m_ViasDimensionsList.emplace_back( VIA_DIMENSION( diameter, drill ) );
444 }
445 },
446 {} ) );
447
448 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "diff_pair_dimensions",
449 [&]() -> nlohmann::json
450 {
451 nlohmann::json js = nlohmann::json::array();
452
453 for( const auto& pair : m_DiffPairDimensionsList )
454 {
455 nlohmann::json entry = {};
456
457 entry["width"] = pcbIUScale.IUTomm( pair.m_Width );
458 entry["gap"] = pcbIUScale.IUTomm( pair.m_Gap );
459 entry["via_gap"] = pcbIUScale.IUTomm( pair.m_ViaGap );
460
461 js.push_back( entry );
462 }
463
464 return js;
465 },
466 [&]( const nlohmann::json& aObj )
467 {
468 if( !aObj.is_array() )
469 return;
470
472
473 for( const nlohmann::json& entry : aObj )
474 {
475 if( entry.empty() || !entry.is_object() )
476 continue;
477
478 if( !entry.contains( "width" ) || !entry.contains( "gap" )
479 || !entry.contains( "via_gap" ) )
480 continue;
481
482 int width = pcbIUScale.mmToIU( entry["width"].get<double>() );
483 int gap = pcbIUScale.mmToIU( entry["gap"].get<double>() );
484 int via_gap = pcbIUScale.mmToIU( entry["via_gap"].get<double>() );
485
486 m_DiffPairDimensionsList.emplace_back(
487 DIFF_PAIR_DIMENSION( width, gap, via_gap ) );
488 }
489 },
490 {} ) );
491
492 // Handle options for teardrops (targets and some others):
493 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_options",
494 [&]() -> nlohmann::json
495 {
496 nlohmann::json js = nlohmann::json::array();
497 nlohmann::json entry = {};
498
499 entry["td_onvia"] = m_TeardropParamsList.m_TargetVias;
500 entry["td_onpthpad"] = m_TeardropParamsList.m_TargetPTHPads;
501 entry["td_onsmdpad"] = m_TeardropParamsList.m_TargetSMDPads;
502 entry["td_ontrackend"] = m_TeardropParamsList.m_TargetTrack2Track;
503 entry["td_onroundshapesonly"] = m_TeardropParamsList.m_UseRoundShapesOnly;
504
505 js.push_back( entry );
506
507 return js;
508 },
509 [&]( const nlohmann::json& aObj )
510 {
511 if( !aObj.is_array() )
512 return;
513
514 for( const nlohmann::json& entry : aObj )
515 {
516 if( entry.empty() || !entry.is_object() )
517 continue;
518
519 if( entry.contains( "td_onvia" ) )
520 m_TeardropParamsList.m_TargetVias = entry["td_onvia"].get<bool>();
521
522 if( entry.contains( "td_onpthpad" ) )
523 m_TeardropParamsList.m_TargetPTHPads = entry["td_onpthpad"].get<bool>();
524
525 if( entry.contains( "td_onsmdpad" ) )
526 m_TeardropParamsList.m_TargetSMDPads = entry["td_onsmdpad"].get<bool>();
527
528 if( entry.contains( "td_ontrackend" ) )
529 m_TeardropParamsList.m_TargetTrack2Track = entry["td_ontrackend"].get<bool>();
530
531 if( entry.contains( "td_onroundshapesonly" ) )
532 m_TeardropParamsList.m_UseRoundShapesOnly = entry["td_onroundshapesonly"].get<bool>();
533
534 // Legacy settings
535 for( int ii = 0; ii < 3; ++ii )
536 {
538
539 if( entry.contains( "td_allow_use_two_tracks" ) )
540 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
541
542 if( entry.contains( "td_curve_segcount" ) )
543 td_prm->m_CurveSegCount = entry["td_curve_segcount"].get<int>();
544
545 if( entry.contains( "td_on_pad_in_zone" ) )
546 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
547 }
548 }
549 },
550 {} ) );
551
552 // Handle parameters (sizes, shape) for each type of teardrop:
553 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_parameters",
554 [&]() -> nlohmann::json
555 {
556 nlohmann::json js = nlohmann::json::array();
557
558 for( size_t ii = 0; ii < m_TeardropParamsList.GetParametersCount(); ii++ )
559 {
560 nlohmann::json entry = {};
562
563 entry["td_target_name"] = GetTeardropTargetCanonicalName( (TARGET_TD)ii );
564 entry["td_maxlen"] = pcbIUScale.IUTomm( td_prm->m_TdMaxLen );
565 entry["td_maxheight"] = pcbIUScale.IUTomm( td_prm->m_TdMaxWidth );
566 entry["td_length_ratio"] = td_prm->m_BestLengthRatio;
567 entry["td_height_ratio"] = td_prm->m_BestWidthRatio;
568 entry["td_curve_segcount"] = td_prm->m_CurveSegCount;
569 entry["td_width_to_size_filter_ratio"] = td_prm->m_WidthtoSizeFilterRatio;
570 entry["td_allow_use_two_tracks"] = td_prm->m_AllowUseTwoTracks;
571 entry["td_on_pad_in_zone"] = td_prm->m_TdOnPadsInZones;
572
573 js.push_back( entry );
574 }
575
576 return js;
577 },
578 [&]( const nlohmann::json& aObj )
579 {
580 if( !aObj.is_array() )
581 return;
582
583 for( const nlohmann::json& entry : aObj )
584 {
585 if( entry.empty() || !entry.is_object() )
586 continue;
587
588 if( !entry.contains( "td_target_name" ) )
589 continue;
590
591 int idx = GetTeardropTargetTypeFromCanonicalName( entry["td_target_name"].get<std::string>() );
592
593 if( idx >= 0 && idx < 3 )
594 {
596
597 if( entry.contains( "td_maxlen" ) )
598 td_prm->m_TdMaxLen = pcbIUScale.mmToIU( entry["td_maxlen"].get<double>() );
599
600 if( entry.contains( "td_maxheight" ) )
601 td_prm->m_TdMaxWidth = pcbIUScale.mmToIU( entry["td_maxheight"].get<double>() );
602
603 if( entry.contains( "td_length_ratio" ) )
604 td_prm->m_BestLengthRatio = entry["td_length_ratio"].get<double>();
605
606 if( entry.contains( "td_height_ratio" ) )
607 td_prm->m_BestWidthRatio = entry["td_height_ratio"].get<double>();
608
609 if( entry.contains( "td_curve_segcount" ) )
610 td_prm->m_CurveSegCount = entry["td_curve_segcount"].get<int>();
611
612 if( entry.contains( "td_width_to_size_filter_ratio" ) )
613 td_prm->m_WidthtoSizeFilterRatio = entry["td_width_to_size_filter_ratio"].get<double>();
614
615 if( entry.contains( "td_allow_use_two_tracks" ) )
616 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
617
618 if( entry.contains( "td_on_pad_in_zone" ) )
619 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
620 }
621 }
622 },
623 {} ) );
624
625 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "tuning_pattern_settings",
626 [&]() -> nlohmann::json
627 {
628 nlohmann::json js = {};
629
630 auto make_settings =
631 []( const PNS::MEANDER_SETTINGS& aSettings )
632 {
633 nlohmann::json entry = {};
634
635 entry["min_amplitude"] = pcbIUScale.IUTomm( aSettings.m_minAmplitude );
636 entry["max_amplitude"] = pcbIUScale.IUTomm( aSettings.m_maxAmplitude );
637 entry["spacing"] = pcbIUScale.IUTomm( aSettings.m_spacing );
638 entry["corner_style"] = aSettings.m_cornerStyle == PNS::MEANDER_STYLE_CHAMFER ? 0 : 1;
639 entry["corner_radius_percentage"] = aSettings.m_cornerRadiusPercentage;
640 entry["single_sided"] = aSettings.m_singleSided;
641
642 return entry;
643 };
644
645 js["single_track_defaults"] = make_settings( m_SingleTrackMeanderSettings );
646 js["diff_pair_defaults"] = make_settings( m_DiffPairMeanderSettings );
647 js["diff_pair_skew_defaults"] = make_settings( m_SkewMeanderSettings );
648
649 return js;
650 },
651 [&]( const nlohmann::json& aObj )
652 {
653 auto read_settings =
654 []( const nlohmann::json& entry ) -> PNS::MEANDER_SETTINGS
655 {
656 PNS::MEANDER_SETTINGS settings;
657
658 if( entry.contains( "min_amplitude" ) )
659 settings.m_minAmplitude = pcbIUScale.mmToIU( entry["min_amplitude"].get<double>() );
660
661 if( entry.contains( "max_amplitude" ) )
662 settings.m_maxAmplitude = pcbIUScale.mmToIU( entry["max_amplitude"].get<double>() );
663
664 if( entry.contains( "spacing" ) )
665 settings.m_spacing = pcbIUScale.mmToIU( entry["spacing"].get<double>() );
666
667 if( entry.contains( "corner_style" ) )
668 {
669 settings.m_cornerStyle = entry["corner_style"] == 0 ? PNS::MEANDER_STYLE_CHAMFER
671 }
672
673 if( entry.contains( "corner_radius_percentage" ) )
674 settings.m_cornerRadiusPercentage = entry["corner_radius_percentage"].get<int>();
675
676 if( entry.contains( "single_sided" ) )
677 settings.m_singleSided = entry["single_sided"].get<bool>();
678
679 return settings;
680 };
681
682 if( aObj.contains( "single_track_defaults" ) )
683 m_SingleTrackMeanderSettings = read_settings( aObj["single_track_defaults"] );
684
685 if( aObj.contains( "diff_pair_defaults" ) )
686 m_DiffPairMeanderSettings = read_settings( aObj["diff_pair_defaults"] );
687
688 if( aObj.contains( "diff_pair_skew_defaults" ) )
689 m_SkewMeanderSettings = read_settings( aObj["diff_pair_skew_defaults"] );
690 },
691 {} ) );
692
693 int minTextSize = pcbIUScale.mmToIU( TEXT_MIN_SIZE_MM );
694 int maxTextSize = pcbIUScale.mmToIU( TEXT_MAX_SIZE_MM );
695 int minStroke = 1;
696 int maxStroke = pcbIUScale.mmToIU( 100 );
697
698 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_line_width",
700 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
701
702 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_v",
704 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
705
706 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_h",
708 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
709
710 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_thickness",
712 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
713
714 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_italic",
715 &m_TextItalic[LAYER_CLASS_SILK], false ) );
716
717 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_upright",
718 &m_TextUpright[ LAYER_CLASS_SILK ], true ) );
719
720 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_line_width",
722 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
723
724 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_v",
726 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
727
728 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_h",
730 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
731
732 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_thickness",
734 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
735
736 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_italic",
737 &m_TextItalic[LAYER_CLASS_COPPER], false ) );
738
739 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_upright",
741
742 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.board_outline_line_width",
744 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
745
746 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.courtyard_line_width",
748 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
749
750 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_line_width",
752 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
753
754 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_v",
756 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
757
758 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_h",
760 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
761
762 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_thickness",
764 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
765
766 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_italic",
767 &m_TextItalic[LAYER_CLASS_FAB], false ) );
768
769 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_upright",
770 &m_TextUpright[LAYER_CLASS_FAB], true ) );
771
772 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_line_width",
774 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
775
776 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_v",
778 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
779
780 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_h",
782 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
783
784 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_thickness",
786 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
787
788 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_italic",
789 &m_TextItalic[LAYER_CLASS_OTHERS], false ) );
790
791 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_upright",
793
794 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_MODE>( "defaults.dimension_units",
795 &m_DimensionUnitsMode, DIM_UNITS_MODE::AUTOMATIC, DIM_UNITS_MODE::INCHES,
796 DIM_UNITS_MODE::AUTOMATIC ) );
797
798 m_params.emplace_back( new PARAM_ENUM<DIM_PRECISION>( "defaults.dimension_precision",
799 &m_DimensionPrecision, DIM_PRECISION::X_XXXX, DIM_PRECISION::X, DIM_PRECISION::V_VVVVV ) );
800
801 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_FORMAT>( "defaults.dimensions.units_format",
802 &m_DimensionUnitsFormat, DIM_UNITS_FORMAT::NO_SUFFIX, DIM_UNITS_FORMAT::NO_SUFFIX,
803 DIM_UNITS_FORMAT::PAREN_SUFFIX ) );
804
805 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.suppress_zeroes",
806 &m_DimensionSuppressZeroes, true ) );
807
808 // NOTE: excluding DIM_TEXT_POSITION::MANUAL from the valid range here
809 m_params.emplace_back( new PARAM_ENUM<DIM_TEXT_POSITION>( "defaults.dimensions.text_position",
810 &m_DimensionTextPosition, DIM_TEXT_POSITION::OUTSIDE, DIM_TEXT_POSITION::OUTSIDE,
811 DIM_TEXT_POSITION::INLINE ) );
812
813 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.keep_text_aligned",
815
816 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.arrow_length",
819
820 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.extension_offset",
823
824 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_fields",
825 &m_StyleFPFields, false ) );
826 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_text",
827 &m_StyleFPText, false ) );
828 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_shapes",
829 &m_StyleFPShapes, false ) );
830
831 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.zones.min_clearance",
834
835 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "defaults.pads",
836 [&]() -> nlohmann::json
837 {
838 nlohmann::json ret =
839 {
840 { "width", pcbIUScale.IUTomm( m_Pad_Master->GetSize( PADSTACK::ALL_LAYERS ).x ) },
841 { "height", pcbIUScale.IUTomm( m_Pad_Master->GetSize( PADSTACK::ALL_LAYERS ).y ) },
842 { "drill", pcbIUScale.IUTomm( m_Pad_Master->GetDrillSize().x ) }
843 };
844
845 return ret;
846 },
847 [&]( const nlohmann::json& aJson )
848 {
849 if( aJson.contains( "width" ) && aJson.contains( "height" )
850 && aJson.contains( "drill" ) )
851 {
852 VECTOR2I sz;
853 sz.x = pcbIUScale.mmToIU( aJson["width"].get<double>() );
854 sz.y = pcbIUScale.mmToIU( aJson["height"].get<double>() );
855
856 m_Pad_Master->SetSize( PADSTACK::ALL_LAYERS, sz );
857
858 int drill = pcbIUScale.mmToIU( aJson["drill"].get<double>() );
859
860 m_Pad_Master->SetDrillSize( VECTOR2I( drill, drill ) );
861 }
862 }, {} ) );
863
864 m_params.emplace_back( new PARAM_SCALED<int>( "rules.max_error",
866
867 m_params.emplace_back( new PARAM_SCALED<int>( "rules.solder_mask_to_copper_clearance",
870
871 m_params.emplace_back( new PARAM<bool>( "zones_allow_external_fillets",
872 &m_ZoneKeepExternalFillets, false ) );
873
875
876 registerMigration( 1, 2,
877 [&]() -> bool
878 {
879 // Schema 1 to 2: move mask and paste margin settings back to board.
880 // The parameters are removed, so we just have to manually load them here and
881 // they will get saved with the board
882 if( std::optional<double> optval = Get<double>( "rules.solder_mask_clearance" ) )
883 m_SolderMaskExpansion = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
884
885 if( std::optional<double> optval = Get<double>( "rules.solder_mask_min_width" ) )
886 m_SolderMaskMinWidth = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
887
888 if( std::optional<double> optval = Get<double>( "rules.solder_paste_clearance" ) )
889 m_SolderPasteMargin = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
890
891 if( std::optional<double> optval = Get<double>( "rules.solder_paste_margin_ratio" ) )
892 m_SolderPasteMarginRatio = *optval;
893
894 try
895 {
896 At( "rules" ).erase( "solder_mask_clearance" );
897 At( "rules" ).erase( "solder_mask_min_width" );
898 At( "rules" ).erase( "solder_paste_clearance" );
899 At( "rules" ).erase( "solder_paste_margin_ratio" );
900 }
901 catch( ... )
902 {}
903
904 return true;
905 } );
906}
907
908
910{
911 if( m_parent )
912 {
914 m_parent = nullptr;
915 }
916}
917
918
920 NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aOther.m_parent,
921 aOther.m_path ),
922 m_Pad_Master( nullptr )
923{
924 initFromOther( aOther );
925}
926
927
929{
930 initFromOther( aOther );
931 return *this;
932}
933
934
936{
937 // Copy of NESTED_SETTINGS around is not allowed, so let's just update the params.
946 m_MinConn = aOther.m_MinConn;
964 m_MaxError = aOther.m_MaxError;
974
975 std::copy( std::begin( aOther.m_LineThickness ), std::end( aOther.m_LineThickness ),
976 std::begin( m_LineThickness ) );
977
978 std::copy( std::begin( aOther.m_TextSize ), std::end( aOther.m_TextSize ),
979 std::begin( m_TextSize ) );
980
981 std::copy( std::begin( aOther.m_TextThickness ), std::end( aOther.m_TextThickness ),
982 std::begin( m_TextThickness ) );
983
984 std::copy( std::begin( aOther.m_TextItalic ), std::end( aOther.m_TextItalic ),
985 std::begin( m_TextItalic ) );
986
987 std::copy( std::begin( aOther.m_TextUpright ), std::end( aOther.m_TextUpright ),
988 std::begin( m_TextUpright ) );
989
998
999 m_auxOrigin = aOther.m_auxOrigin;
1000 m_gridOrigin = aOther.m_gridOrigin;
1001 m_HasStackup = aOther.m_HasStackup;
1003
1016 m_stackup = aOther.m_stackup;
1018 m_Pad_Master = std::make_unique<PAD>( *aOther.m_Pad_Master );
1020
1024}
1025
1026
1028{
1029 if( m_TrackWidthList != aOther.m_TrackWidthList ) return false;
1030 if( m_ViasDimensionsList != aOther.m_ViasDimensionsList ) return false;
1031 if( m_DiffPairDimensionsList != aOther.m_DiffPairDimensionsList ) return false;
1032 if( m_CurrentViaType != aOther.m_CurrentViaType ) return false;
1033 if( m_UseConnectedTrackWidth != aOther.m_UseConnectedTrackWidth ) return false;
1034 if( m_TempOverrideTrackWidth != aOther.m_TempOverrideTrackWidth ) return false;
1035 if( m_MinClearance != aOther.m_MinClearance ) return false;
1036 if( m_MinGrooveWidth != aOther.m_MinGrooveWidth ) return false;
1037 if( m_MinConn != aOther.m_MinConn ) return false;
1038 if( m_TrackMinWidth != aOther.m_TrackMinWidth ) return false;
1039 if( m_ViasMinAnnularWidth != aOther.m_ViasMinAnnularWidth ) return false;
1040 if( m_ViasMinSize != aOther.m_ViasMinSize ) return false;
1041 if( m_MinThroughDrill != aOther.m_MinThroughDrill ) return false;
1042 if( m_MicroViasMinSize != aOther.m_MicroViasMinSize ) return false;
1043 if( m_MicroViasMinDrill != aOther.m_MicroViasMinDrill ) return false;
1044 if( m_CopperEdgeClearance != aOther.m_CopperEdgeClearance ) return false;
1045 if( m_HoleClearance != aOther.m_HoleClearance ) return false;
1046 if( m_HoleToHoleMin != aOther.m_HoleToHoleMin ) return false;
1047 if( m_SilkClearance != aOther.m_SilkClearance ) return false;
1048 if( m_MinResolvedSpokes != aOther.m_MinResolvedSpokes ) return false;
1049 if( m_MinSilkTextHeight != aOther.m_MinSilkTextHeight ) return false;
1050 if( m_MinSilkTextThickness != aOther.m_MinSilkTextThickness ) return false;
1051 if( m_DRCSeverities != aOther.m_DRCSeverities ) return false;
1052 if( m_DrcExclusions != aOther.m_DrcExclusions ) return false;
1053 if( m_DrcExclusionComments != aOther.m_DrcExclusionComments ) return false;
1054 if( m_ZoneKeepExternalFillets != aOther.m_ZoneKeepExternalFillets ) return false;
1055 if( m_MaxError != aOther.m_MaxError ) return false;
1056 if( m_SolderMaskExpansion != aOther.m_SolderMaskExpansion ) return false;
1057 if( m_SolderMaskMinWidth != aOther.m_SolderMaskMinWidth ) return false;
1059 if( m_SolderPasteMargin != aOther.m_SolderPasteMargin ) return false;
1060 if( m_SolderPasteMarginRatio != aOther.m_SolderPasteMarginRatio ) return false;
1062 if( m_TentViasFront != aOther.m_TentViasFront ) return false;
1063 if( m_TentViasBack != aOther.m_TentViasBack ) return false;
1064 if( m_DefaultFPTextItems != aOther.m_DefaultFPTextItems ) return false;
1065
1066 if( !std::equal( std::begin( m_LineThickness ), std::end( m_LineThickness ),
1067 std::begin( aOther.m_LineThickness ) ) )
1068 return false;
1069
1070 if( !std::equal( std::begin( m_TextSize ), std::end( m_TextSize ),
1071 std::begin( aOther.m_TextSize ) ) )
1072 return false;
1073
1074 if( !std::equal( std::begin( m_TextThickness ), std::end( m_TextThickness ),
1075 std::begin( aOther.m_TextThickness ) ) )
1076 return false;
1077
1078 if( !std::equal( std::begin( m_TextItalic ), std::end( m_TextItalic ),
1079 std::begin( aOther.m_TextItalic ) ) )
1080 return false;
1081
1082 if( !std::equal( std::begin( m_TextUpright ), std::end( m_TextUpright ),
1083 std::begin( aOther.m_TextUpright ) ) )
1084 return false;
1085
1086 if( m_DimensionUnitsMode != aOther.m_DimensionUnitsMode ) return false;
1087 if( m_DimensionPrecision != aOther.m_DimensionPrecision ) return false;
1088 if( m_DimensionUnitsFormat != aOther.m_DimensionUnitsFormat ) return false;
1089 if( m_DimensionSuppressZeroes != aOther.m_DimensionSuppressZeroes ) return false;
1090 if( m_DimensionTextPosition != aOther.m_DimensionTextPosition ) return false;
1091 if( m_DimensionKeepTextAligned != aOther.m_DimensionKeepTextAligned ) return false;
1092 if( m_DimensionArrowLength != aOther.m_DimensionArrowLength ) return false;
1093 if( m_DimensionExtensionOffset != aOther.m_DimensionExtensionOffset ) return false;
1094 if( m_auxOrigin != aOther.m_auxOrigin ) return false;
1095 if( m_gridOrigin != aOther.m_gridOrigin ) return false;
1096 if( m_HasStackup != aOther.m_HasStackup ) return false;
1097 if( m_UseHeightForLengthCalcs != aOther.m_UseHeightForLengthCalcs ) return false;
1098 if( m_trackWidthIndex != aOther.m_trackWidthIndex ) return false;
1099 if( m_viaSizeIndex != aOther.m_viaSizeIndex ) return false;
1100 if( m_diffPairIndex != aOther.m_diffPairIndex ) return false;
1101 if( m_useCustomTrackVia != aOther.m_useCustomTrackVia ) return false;
1102 if( m_customTrackWidth != aOther.m_customTrackWidth ) return false;
1103 if( m_customViaSize != aOther.m_customViaSize ) return false;
1104 if( m_useCustomDiffPair != aOther.m_useCustomDiffPair ) return false;
1105 if( m_customDiffPair != aOther.m_customDiffPair ) return false;
1106 if( m_copperLayerCount != aOther.m_copperLayerCount ) return false;
1107 if( m_enabledLayers != aOther.m_enabledLayers ) return false;
1108 if( m_boardThickness != aOther.m_boardThickness ) return false;
1109 if( m_currentNetClassName != aOther.m_currentNetClassName ) return false;
1110 if( m_stackup != aOther.m_stackup ) return false;
1111 if( *m_NetSettings != *aOther.m_NetSettings ) return false;
1112 if( *m_Pad_Master != *aOther.m_Pad_Master ) return false;
1113 if( m_defaultZoneSettings != aOther.m_defaultZoneSettings ) return false;
1114
1115 if( m_StyleFPFields != aOther.m_StyleFPFields ) return false;
1116 if( m_StyleFPText != aOther.m_StyleFPText ) return false;
1117 if( m_StyleFPShapes != aOther.m_StyleFPShapes ) return false;
1118
1119 return true;
1120}
1121
1122
1124{
1142 std::string units_ptr( "defaults.dimension_units" );
1143 std::string precision_ptr( "defaults.dimension_precision" );
1144
1145 if( !( Contains( units_ptr ) && Contains( precision_ptr ) &&
1146 At( units_ptr ).is_number_integer() &&
1147 At( precision_ptr ).is_number_integer() ) )
1148 {
1149 // if either is missing or invalid, migration doesn't make sense
1150 return true;
1151 }
1152
1153 int units = *Get<int>( units_ptr );
1154 int precision = *Get<int>( precision_ptr );
1155
1156 // The enum maps directly to precision if the units is mils
1157 int extraDigits = 0;
1158
1159 switch( units )
1160 {
1161 case 0: extraDigits = 3; break;
1162 case 2: extraDigits = 2; break;
1163 default: break;
1164 }
1165
1166 precision += extraDigits;
1167
1168 Set( precision_ptr, precision );
1169
1170 return true;
1171}
1172
1173
1174bool BOARD_DESIGN_SETTINGS::LoadFromFile( const wxString& aDirectory )
1175{
1176 bool ret = NESTED_SETTINGS::LoadFromFile( aDirectory );
1177
1178 // A number of things won't have been translated by the PROJECT_FILE migration because of
1179 // descoped objects required to decode this data. So, it will be in the legacy.pcbnew
1180 // section and needs to be pulled out here
1181
1182 PROJECT_FILE* project = dynamic_cast<PROJECT_FILE*>( GetParent() );
1183
1184 if( !project )
1185 return ret;
1186
1187 bool migrated = false;
1188
1189 auto drcName =
1190 []( int aCode ) -> std::string
1191 {
1192 std::shared_ptr<DRC_ITEM> item = DRC_ITEM::Create( aCode );
1193 wxString name = item->GetSettingsKey();
1194 return std::string( name.ToUTF8() );
1195 };
1196
1197 const std::string rs = "rule_severities.";
1198 const std::string no_courtyard_key = "legacy_no_courtyard_defined";
1199 const std::string courtyard_overlap_key = "legacy_courtyards_overlap";
1200
1201 try
1202 {
1203 nlohmann::json& severities =
1204 project->Internals()->at( "/board/design_settings/rule_severities"_json_pointer );
1205
1206 if( severities.contains( no_courtyard_key ) )
1207 {
1208 if( severities[no_courtyard_key].get<bool>() )
1209 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "error" );
1210 else
1211 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "ignore" );
1212
1213 severities.erase( no_courtyard_key );
1214 migrated = true;
1215 }
1216
1217 if( severities.contains( courtyard_overlap_key ) )
1218 {
1219 if( severities[courtyard_overlap_key].get<bool>() )
1220 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "error" );
1221 else
1222 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "ignore" );
1223
1224 severities.erase( courtyard_overlap_key );
1225 migrated = true;
1226 }
1227 }
1228 catch( ... )
1229 {
1230 }
1231 if( Contains( "legacy" ) )
1232 {
1233 // This defaults to false for new boards, but version 5.1.x and prior kept the fillets
1234 // so we do the same for legacy boards.
1236
1237 project->At( "legacy" ).erase( "pcbnew" );
1238 }
1239
1240 // Now that we have everything, we need to load again
1241 if( migrated )
1242 Load();
1243
1244 return ret;
1245}
1246
1247
1249{
1250 return m_DRCSeverities[ aDRCErrorCode ];
1251}
1252
1253
1254bool BOARD_DESIGN_SETTINGS::Ignore( int aDRCErrorCode )
1255{
1256 return m_DRCSeverities[ aDRCErrorCode ] == RPT_SEVERITY_IGNORE;
1257}
1258
1259
1261{
1262 int biggest = std::max( m_MinClearance, m_HoleClearance );
1263 DRC_CONSTRAINT constraint;
1264
1265 biggest = std::max( biggest, m_HoleToHoleMin );
1266 biggest = std::max( biggest, m_CopperEdgeClearance );
1267
1268 if( m_DRCEngine )
1269 {
1270 m_DRCEngine->QueryWorstConstraint( CLEARANCE_CONSTRAINT, constraint );
1271 biggest = std::max( biggest, constraint.Value().Min() );
1272
1273 m_DRCEngine->QueryWorstConstraint( PHYSICAL_CLEARANCE_CONSTRAINT, constraint );
1274 biggest = std::max( biggest, constraint.Value().Min() );
1275
1276 m_DRCEngine->QueryWorstConstraint( HOLE_CLEARANCE_CONSTRAINT, constraint );
1277 biggest = std::max( biggest, constraint.Value().Min() );
1278
1279 m_DRCEngine->QueryWorstConstraint( EDGE_CLEARANCE_CONSTRAINT, constraint );
1280 biggest = std::max( biggest, constraint.Value().Min() );
1281
1282 m_DRCEngine->QueryWorstConstraint( HOLE_TO_HOLE_CONSTRAINT, constraint );
1283 biggest = std::max( biggest, constraint.Value().Min() );
1284 }
1285
1286 return biggest;
1287}
1288
1289
1291{
1292 int clearance = m_NetSettings->GetDefaultNetclass()->GetClearance();
1293
1294 for( const auto& [name, netclass] : m_NetSettings->GetNetclasses() )
1295 clearance = std::min( clearance, netclass->GetClearance() );
1296
1297 return clearance;
1298}
1299
1300
1302{
1303 m_viaSizeIndex = std::min( aIndex, (unsigned) m_ViasDimensionsList.size() );
1304 m_useCustomTrackVia = false;
1305}
1306
1307
1309{
1312 else if( m_viaSizeIndex == 0 )
1313 return m_NetSettings->GetDefaultNetclass()->GetViaDiameter();
1314 else
1315 return m_ViasDimensionsList[ m_viaSizeIndex ].m_Diameter;
1316}
1317
1318
1320{
1321 int drill;
1322
1324 drill = m_customViaSize.m_Drill;
1325 else if( m_viaSizeIndex == 0 )
1326 drill = m_NetSettings->GetDefaultNetclass()->GetViaDrill();
1327 else
1328 drill = m_ViasDimensionsList[ m_viaSizeIndex ].m_Drill;
1329
1330 return drill > 0 ? drill : -1;
1331}
1332
1333
1335{
1336 m_trackWidthIndex = std::min( aIndex, (unsigned) m_TrackWidthList.size() );
1337 m_useCustomTrackVia = false;
1338}
1339
1340
1342{
1344 return m_customTrackWidth;
1345 else if( m_trackWidthIndex == 0 )
1346 return m_NetSettings->GetDefaultNetclass()->GetTrackWidth();
1347 else
1349}
1350
1351
1353{
1354 if( !m_DiffPairDimensionsList.empty() )
1355 {
1356 m_diffPairIndex = std::min( aIndex,
1357 static_cast<unsigned>( m_DiffPairDimensionsList.size() ) - 1 );
1358 }
1359
1360 m_useCustomDiffPair = false;
1361}
1362
1363
1365{
1367 {
1369 }
1370 else if( m_diffPairIndex == 0 )
1371 {
1372 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairWidth() )
1373 return m_NetSettings->GetDefaultNetclass()->GetDiffPairWidth();
1374 else
1375 return m_NetSettings->GetDefaultNetclass()->GetTrackWidth();
1376 }
1377 else
1378 {
1380 }
1381}
1382
1383
1385{
1387 {
1388 return m_customDiffPair.m_Gap;
1389 }
1390 else if( m_diffPairIndex == 0 )
1391 {
1392 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairGap() )
1393 return m_NetSettings->GetDefaultNetclass()->GetDiffPairGap();
1394 else
1395 return m_NetSettings->GetDefaultNetclass()->GetClearance();
1396 }
1397 else
1398 {
1400 }
1401}
1402
1403
1405{
1407 {
1409 }
1410 else if( m_diffPairIndex == 0 )
1411 {
1412 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairViaGap() )
1413 return m_NetSettings->GetDefaultNetclass()->GetDiffPairViaGap();
1414 else
1415 return GetCurrentDiffPairGap();
1416 }
1417 else
1418 {
1420 }
1421}
1422
1423
1425{
1426 m_copperLayerCount = aNewLayerCount;
1427
1428 // Update only enabled copper layers mask
1429 m_enabledLayers &= ~LSET::AllCuMask();
1430
1431 if( aNewLayerCount > 0 )
1432 m_enabledLayers |= LSET::AllCuMask( aNewLayerCount );
1433}
1434
1435
1437{
1438 // Ensures mandatory back and front layers are always enabled
1439 // regardless of board file configuration.
1440 aMask.set( B_Cu ).set( F_Cu )
1441 .set( B_CrtYd ).set( F_CrtYd )
1442 .set( Edge_Cuts ).set( Margin );
1443
1444 m_enabledLayers = aMask;
1445
1446 // update m_CopperLayerCount to ensure its consistency with m_EnabledLayers
1447 m_copperLayerCount = ( aMask & LSET::AllCuMask() ).count();
1448}
1449
1450
1451// Return the layer class index { silk, copper, edges & courtyards, fab, others } of the
1452// given layer.
1454{
1455 if( aLayer == F_SilkS || aLayer == B_SilkS )
1456 return LAYER_CLASS_SILK;
1457 else if( IsCopperLayer( aLayer ) )
1458 return LAYER_CLASS_COPPER;
1459 else if( aLayer == Edge_Cuts )
1460 return LAYER_CLASS_EDGES;
1461 else if( aLayer == F_CrtYd || aLayer == B_CrtYd )
1462 return LAYER_CLASS_COURTYARD;
1463 else if( aLayer == F_Fab || aLayer == B_Fab )
1464 return LAYER_CLASS_FAB;
1465 else
1466 return LAYER_CLASS_OTHERS;
1467}
1468
1469
1471{
1472 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_DRCEpsilon );
1473}
1474
1475
1477{
1478 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_HoleWallThickness );
1479}
1480
1481
1483{
1484 return m_LineThickness[ GetLayerClass( aLayer ) ];
1485}
1486
1487
1489{
1490 return m_TextSize[ GetLayerClass( aLayer ) ];
1491}
1492
1493
1495{
1496 return m_TextThickness[ GetLayerClass( aLayer ) ];
1497}
1498
1499
1501{
1502 return m_TextItalic[ GetLayerClass( aLayer ) ];
1503}
1504
1505
1507{
1508 return m_TextUpright[ GetLayerClass( aLayer ) ];
1509}
1510
1512{
1513 m_Pad_Master.get()->SetSizeX( pcbIUScale.mmToIU( DEFAULT_PAD_WIDTH_MM ) );
1515 m_Pad_Master.get()->SetDrillShape( PAD_DRILL_SHAPE::CIRCLE );
1516 m_Pad_Master.get()->SetDrillSize(
1518 m_Pad_Master.get()->SetShape( PADSTACK::ALL_LAYERS, PAD_SHAPE::ROUNDRECT );
1519 m_Pad_Master.get()->SetRoundRectCornerRadius(
1522}
const char * name
Definition: DXF_plotter.cpp:57
constexpr int ARC_HIGH_DEF
Definition: base_units.h:120
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
const int bdsSchemaVersion
#define DEFAULT_MICROVIASMINDRILL
#define DEFAULT_SOLDERPASTE_CLEARANCE
#define DEFAULT_SOLDERPASTE_RATIO
#define DEFAULT_CUSTOMDPAIRWIDTH
#define DEFAULT_DP_MEANDER_SPACING
#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
@ LAYER_CLASS_OTHERS
@ LAYER_CLASS_FAB
@ LAYER_CLASS_COURTYARD
@ LAYER_CLASS_SILK
@ LAYER_CLASS_COPPER
@ LAYER_CLASS_EDGES
#define DEFAULT_SOLDERMASK_MIN_WIDTH
#define DEFAULT_DIMENSION_EXTENSION_OFFSET
#define DEFAULT_PAD_REACT_RADIUS
#define DEFAULT_COPPEREDGECLEARANCE
#define DEFAULT_PAD_HEIGTH_MM
#define DEFAULT_DIMENSION_ARROW_LENGTH
#define DEFAULT_TRACKMINWIDTH
#define DEFAULT_MINTHROUGHDRILL
#define DEFAULT_SILK_TEXT_SIZE
#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:115
Container for design settings for a BOARD object.
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 SetDiffPairIndex(unsigned aIndex)
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.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
void SetEnabledLayers(LSET aMask)
Change the bit-mask of enabled layers to aMask.
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::unique_ptr< PAD > m_Pad_Master
void SetTrackWidthIndex(unsigned aIndex)
Set the current track width list index to aIndex.
TEARDROP_PARAMETERS_LIST m_TeardropParamsList
The parameters of teardrops for the different teardrop targets (via/pad, track end) 3 set of paramete...
void SetViaSizeIndex(unsigned aIndex)
Set the current via size list index to aIndex.
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.
bool LoadFromFile(const wxString &aDirectory="") override
Loads the backing file from disk and then calls Load()
PNS::MEANDER_SETTINGS m_SingleTrackMeanderSettings
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.
DIM_UNITS_MODE m_DimensionUnitsMode
std::vector< VIA_DIMENSION > m_ViasDimensionsList
BOARD_DESIGN_SETTINGS & operator=(const BOARD_DESIGN_SETTINGS &aOther)
MINOPTMAX< int > & Value()
Definition: drc_rule.h:153
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities(bool aIncludeDeprecated=false)
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:395
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::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 ReleaseNestedSettings(NESTED_SETTINGS *aSettings)
Saves and frees a nested settings object, if it exists within this one.
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:36
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:686
T Min() const
Definition: minoptmax.h:33
NESTED_SETTINGS is a JSON_SETTINGS that lives inside a JSON_SETTINGS.
JSON_SETTINGS * GetParent()
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
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:144
Stores an enum as an integer.
Definition: parameters.h:228
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:295
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition: parameters.h:392
Dimensions for the meandering algorithm.
Definition: pns_meander.h:68
int m_minAmplitude
Maximum meandering amplitude.
Definition: pns_meander.h:83
int m_cornerRadiusPercentage
Place meanders on one side.
Definition: pns_meander.h:109
bool m_singleSided
Initial side when placing meanders at segment.
Definition: pns_meander.h:112
MEANDER_STYLE m_cornerStyle
Rounding percentage (0 - 100).
Definition: pns_meander.h:106
int m_maxAmplitude
Meandering period/spacing (see dialog picture for explanation).
Definition: pns_meander.h:86
int m_spacing
Amplitude/spacing adjustment step.
Definition: pns_meander.h:89
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:72
A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
Definition: rc_item.h:79
bool m_UseRoundShapesOnly
True to create teardrops for round shapes only.
bool m_TargetVias
True to create teardrops for vias.
bool m_TargetPTHPads
True to create teardrops for pads with holes.
bool m_TargetTrack2Track
True to create teardrops at the end of a track connected to the end of another track having a differe...
TEARDROP_PARAMETERS * GetParameters(TARGET_TD aTdType)
bool m_TargetSMDPads
True to create teardrops for pads SMD, edge connectors,.
TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board thes...
int m_CurveSegCount
True if the teardrop should be curved.
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.
@ DRCE_SILK_EDGE_CLEARANCE
Definition: drc_item.h:98
@ DRCE_FOOTPRINT_FILTERS
Definition: drc_item.h:79
@ 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_SILK_CLEARANCE
Definition: drc_item.h:96
@ 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:74
@ HOLE_TO_HOLE_CONSTRAINT
Definition: drc_rule.h:52
#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)
Tests whether a layer is a copper layer.
Definition: layer_ids.h:531
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
SEVERITY
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_IGNORE
Container to handle a stock of specific differential pairs each with unique track width,...
constexpr double IUTomm(int iu) const
Definition: base_units.h:86
const double IU_PER_MM
Definition: base_units.h:76
const double MM_PER_IU
Definition: base_units.h:78
constexpr int MilsToIU(int mils) const
Definition: base_units.h:93
constexpr int mmToIU(double mm) const
Definition: base_units.h:88
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)
wxString SeverityToString(const SEVERITY &aSeverity)
Definition: ui_common.cpp:66
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:691
#define ZONE_CLEARANCE_MM
Definition: zones.h:37