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::BARE_SUFFIX;
129 m_DimensionTextPosition = DIM_TEXT_POSITION::OUTSIDE;
133
134 m_useCustomTrackVia = false;
138
139 m_useCustomDiffPair = false;
143
159
160 for( int errorCode = DRCE_FIRST; errorCode <= DRCE_LAST; ++errorCode )
161 m_DRCSeverities[ errorCode ] = RPT_SEVERITY_ERROR;
162
165
169
172
175
177
183
189
191
194
196
200
201 // Global mask margins:
205
206 // Solder paste margin absolute value
208 // Solder paste margin as a ratio of pad size
209 // The final margin is the sum of these 2 values
210 // Usually < 0 because the mask is smaller than pad
212
214 m_TentViasFront = true;
215 m_TentViasBack = true;
216
217 // Layer thickness for 3D viewer
219
220 // Default spacing for meanders
224
225 m_viaSizeIndex = 0;
227 m_diffPairIndex = 0;
228
229 // Parameters stored in JSON in the project file
230
231 // NOTE: Previously, BOARD_DESIGN_SETTINGS stored the basic board layer information (layer
232 // names and enable/disable state) in the project file even though this information is also
233 // stored in the board file. This was implemented for importing these settings from another
234 // project. Going forward, the import feature will just import from other board files (since
235 // we could have multi-board projects in the future anyway) so this functionality is dropped.
236
237
238 m_params.emplace_back( new PARAM<bool>( "rules.use_height_for_length_calcs",
239 &m_UseHeightForLengthCalcs, true ) );
240
241 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_clearance",
244
245 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_connection",
247 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
248
249 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_track_width",
252
253 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_annular_width",
256
257 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_diameter",
260
261 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_through_hole_diameter",
264
265 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_diameter",
268
269 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_drill",
272
273 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_to_hole",
276
277 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_clearance",
279 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
280
281 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_silk_clearance",
283 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
284
285 // While the maximum *effective* value is 4, we've had users interpret this as the count on
286 // all layers, and enter something like 10. They'll figure it out soon enough *unless* we
287 // enforce a max of 4 (and therefore reset it back to the default of 2), at which point it
288 // just looks buggy.
289 m_params.emplace_back( new PARAM<int>( "rules.min_resolved_spokes",
291
292 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_height",
294 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
295
296 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_thickness",
299
300 // Note: a clearance of -0.01 is a flag indicating we should use the legacy (pre-6.0) method
301 // based on the edge cut thicknesses.
302 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_copper_edge_clearance",
304 pcbIUScale.mmToIU( -0.01 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
305
306 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
307 [&]() -> nlohmann::json
308 {
309 nlohmann::json ret = {};
310
311 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
312 {
313 wxString name = item.GetSettingsKey();
314 int code = item.GetErrorCode();
315
316 if( name.IsEmpty() || m_DRCSeverities.count( code ) == 0 )
317 continue;
318
319 ret[std::string( name.ToUTF8() )] = SeverityToString( m_DRCSeverities[code] );
320 }
321
322 return ret;
323 },
324 [&]( const nlohmann::json& aJson )
325 {
326 if( !aJson.is_object() )
327 return;
328
329 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
330 {
331 wxString name = item.GetSettingsKey();
332 std::string key( name.ToUTF8() );
333
334 if( aJson.contains( key ) )
335 m_DRCSeverities[item.GetErrorCode()] = SeverityFromString( aJson[key] );
336 }
337 }, {} ) );
338
339 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "drc_exclusions",
340 [&]() -> nlohmann::json
341 {
342 nlohmann::json js = nlohmann::json::array();
343
344 for( const wxString& entry : m_DrcExclusions )
345 js.push_back( { entry, m_DrcExclusionComments[ entry ] } );
346
347 return js;
348 },
349 [&]( const nlohmann::json& aObj )
350 {
351 m_DrcExclusions.clear();
352
353 if( !aObj.is_array() )
354 return;
355
356 for( const nlohmann::json& entry : aObj )
357 {
358 if( entry.is_array() )
359 {
360 wxString serialized = entry[0].get<wxString>();
361 m_DrcExclusions.insert( serialized );
362 m_DrcExclusionComments[ serialized ] = entry[1].get<wxString>();
363 }
364 else if( entry.is_string() )
365 {
366 m_DrcExclusions.insert( entry.get<wxString>() );
367 }
368 }
369 },
370 {} ) );
371
372 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "track_widths",
373 [&]() -> nlohmann::json
374 {
375 nlohmann::json js = nlohmann::json::array();
376
377 for( const int& width : m_TrackWidthList )
378 js.push_back( pcbIUScale.IUTomm( width ) );
379
380 return js;
381 },
382 [&]( const nlohmann::json& aJson )
383 {
384 if( !aJson.is_array() )
385 return;
386
387 m_TrackWidthList.clear();
388
389 for( const nlohmann::json& entry : aJson )
390 {
391 if( entry.empty() )
392 continue;
393
394 m_TrackWidthList.emplace_back( pcbIUScale.mmToIU( entry.get<double>() ) );
395 }
396 },
397 {} ) );
398
399 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "via_dimensions",
400 [&]() -> nlohmann::json
401 {
402 nlohmann::json js = nlohmann::json::array();
403
404 for( const auto& via : m_ViasDimensionsList )
405 {
406 nlohmann::json entry = {};
407
408 entry["diameter"] = pcbIUScale.IUTomm( via.m_Diameter );
409 entry["drill"] = pcbIUScale.IUTomm( via.m_Drill );
410
411 js.push_back( entry );
412 }
413
414 return js;
415 },
416 [&]( const nlohmann::json& aObj )
417 {
418 if( !aObj.is_array() )
419 return;
420
421 m_ViasDimensionsList.clear();
422
423 for( const nlohmann::json& entry : aObj )
424 {
425 if( entry.empty() || !entry.is_object() )
426 continue;
427
428 if( !entry.contains( "diameter" ) || !entry.contains( "drill" ) )
429 continue;
430
431 int diameter = pcbIUScale.mmToIU( entry["diameter"].get<double>() );
432 int drill = pcbIUScale.mmToIU( entry["drill"].get<double>() );
433
434 m_ViasDimensionsList.emplace_back( VIA_DIMENSION( diameter, drill ) );
435 }
436 },
437 {} ) );
438
439 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "diff_pair_dimensions",
440 [&]() -> nlohmann::json
441 {
442 nlohmann::json js = nlohmann::json::array();
443
444 for( const auto& pair : m_DiffPairDimensionsList )
445 {
446 nlohmann::json entry = {};
447
448 entry["width"] = pcbIUScale.IUTomm( pair.m_Width );
449 entry["gap"] = pcbIUScale.IUTomm( pair.m_Gap );
450 entry["via_gap"] = pcbIUScale.IUTomm( pair.m_ViaGap );
451
452 js.push_back( entry );
453 }
454
455 return js;
456 },
457 [&]( const nlohmann::json& aObj )
458 {
459 if( !aObj.is_array() )
460 return;
461
463
464 for( const nlohmann::json& entry : aObj )
465 {
466 if( entry.empty() || !entry.is_object() )
467 continue;
468
469 if( !entry.contains( "width" ) || !entry.contains( "gap" )
470 || !entry.contains( "via_gap" ) )
471 continue;
472
473 int width = pcbIUScale.mmToIU( entry["width"].get<double>() );
474 int gap = pcbIUScale.mmToIU( entry["gap"].get<double>() );
475 int via_gap = pcbIUScale.mmToIU( entry["via_gap"].get<double>() );
476
477 m_DiffPairDimensionsList.emplace_back(
478 DIFF_PAIR_DIMENSION( width, gap, via_gap ) );
479 }
480 },
481 {} ) );
482
483 // Handle options for teardrops (targets and some others):
484 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_options",
485 [&]() -> nlohmann::json
486 {
487 nlohmann::json js = nlohmann::json::array();
488 nlohmann::json entry = {};
489
490 entry["td_onviapad"] = m_TeardropParamsList.m_TargetViasPads;
491 entry["td_onpadsmd"] = m_TeardropParamsList.m_TargetPadsWithNoHole;
492 entry["td_ontrackend"] = m_TeardropParamsList.m_TargetTrack2Track;
493 entry["td_onroundshapesonly"] = m_TeardropParamsList.m_UseRoundShapesOnly;
494
495 js.push_back( entry );
496
497 return js;
498 },
499 [&]( const nlohmann::json& aObj )
500 {
501 if( !aObj.is_array() )
502 return;
503
504 for( const nlohmann::json& entry : aObj )
505 {
506 if( entry.empty() || !entry.is_object() )
507 continue;
508
509 if( entry.contains( "td_onviapad" ) )
510 m_TeardropParamsList.m_TargetViasPads = entry["td_onviapad"].get<bool>();
511
512 if( entry.contains( "td_onpadsmd" ) )
513 m_TeardropParamsList.m_TargetPadsWithNoHole = entry["td_onpadsmd"].get<bool>();
514
515 if( entry.contains( "td_ontrackend" ) )
516 m_TeardropParamsList.m_TargetTrack2Track = entry["td_ontrackend"].get<bool>();
517
518 if( entry.contains( "td_onroundshapesonly" ) )
519 m_TeardropParamsList.m_UseRoundShapesOnly = entry["td_onroundshapesonly"].get<bool>();
520
521 // Legacy settings
522 for( int ii = 0; ii < 3; ++ii )
523 {
525
526 if( entry.contains( "td_allow_use_two_tracks" ) )
527 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
528
529 if( entry.contains( "td_curve_segcount" ) )
530 td_prm->m_CurveSegCount = entry["td_curve_segcount"].get<int>();
531
532 if( entry.contains( "td_on_pad_in_zone" ) )
533 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
534 }
535 }
536 },
537 {} ) );
538
539 // Handle parameters (sizes, shape) for each type of teardrop:
540 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_parameters",
541 [&]() -> nlohmann::json
542 {
543 nlohmann::json js = nlohmann::json::array();
544
545 for( size_t ii = 0; ii < m_TeardropParamsList.GetParametersCount(); ii++ )
546 {
547 nlohmann::json entry = {};
549
550 entry["td_target_name"] = GetTeardropTargetCanonicalName( (TARGET_TD)ii );
551 entry["td_maxlen"] = pcbIUScale.IUTomm( td_prm->m_TdMaxLen );
552 entry["td_maxheight"] = pcbIUScale.IUTomm( td_prm->m_TdMaxWidth );
553 entry["td_length_ratio"] = td_prm->m_BestLengthRatio;
554 entry["td_height_ratio"] = td_prm->m_BestWidthRatio;
555 entry["td_curve_segcount"] = td_prm->m_CurveSegCount;
556 entry["td_width_to_size_filter_ratio"] = td_prm->m_WidthtoSizeFilterRatio;
557 entry["td_allow_use_two_tracks"] = td_prm->m_AllowUseTwoTracks;
558 entry["td_on_pad_in_zone"] = td_prm->m_TdOnPadsInZones;
559
560 js.push_back( entry );
561 }
562
563 return js;
564 },
565 [&]( const nlohmann::json& aObj )
566 {
567 if( !aObj.is_array() )
568 return;
569
570 for( const nlohmann::json& entry : aObj )
571 {
572 if( entry.empty() || !entry.is_object() )
573 continue;
574
575 if( !entry.contains( "td_target_name" ) )
576 continue;
577
578 int idx = GetTeardropTargetTypeFromCanonicalName( entry["td_target_name"].get<std::string>() );
579
580 if( idx >= 0 && idx < 3 )
581 {
583
584 if( entry.contains( "td_maxlen" ) )
585 td_prm->m_TdMaxLen = pcbIUScale.mmToIU( entry["td_maxlen"].get<double>() );
586
587 if( entry.contains( "td_maxheight" ) )
588 td_prm->m_TdMaxWidth = pcbIUScale.mmToIU( entry["td_maxheight"].get<double>() );
589
590 if( entry.contains( "td_length_ratio" ) )
591 td_prm->m_BestLengthRatio = entry["td_length_ratio"].get<double>();
592
593 if( entry.contains( "td_height_ratio" ) )
594 td_prm->m_BestWidthRatio = entry["td_height_ratio"].get<double>();
595
596 if( entry.contains( "td_curve_segcount" ) )
597 td_prm->m_CurveSegCount = entry["td_curve_segcount"].get<int>();
598
599 if( entry.contains( "td_width_to_size_filter_ratio" ) )
600 td_prm->m_WidthtoSizeFilterRatio = entry["td_width_to_size_filter_ratio"].get<double>();
601
602 if( entry.contains( "td_allow_use_two_tracks" ) )
603 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
604
605 if( entry.contains( "td_on_pad_in_zone" ) )
606 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
607 }
608 }
609 },
610 {} ) );
611
612 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "tuning_pattern_settings",
613 [&]() -> nlohmann::json
614 {
615 nlohmann::json js = {};
616
617 auto make_settings =
618 []( const PNS::MEANDER_SETTINGS& aSettings )
619 {
620 nlohmann::json entry = {};
621
622 entry["min_amplitude"] = pcbIUScale.IUTomm( aSettings.m_minAmplitude );
623 entry["max_amplitude"] = pcbIUScale.IUTomm( aSettings.m_maxAmplitude );
624 entry["spacing"] = pcbIUScale.IUTomm( aSettings.m_spacing );
625 entry["corner_style"] = aSettings.m_cornerStyle == PNS::MEANDER_STYLE_CHAMFER ? 0 : 1;
626 entry["corner_radius_percentage"] = aSettings.m_cornerRadiusPercentage;
627 entry["single_sided"] = aSettings.m_singleSided;
628
629 return entry;
630 };
631
632 js["single_track_defaults"] = make_settings( m_SingleTrackMeanderSettings );
633 js["diff_pair_defaults"] = make_settings( m_DiffPairMeanderSettings );
634 js["diff_pair_skew_defaults"] = make_settings( m_SkewMeanderSettings );
635
636 return js;
637 },
638 [&]( const nlohmann::json& aObj )
639 {
640 auto read_settings =
641 []( const nlohmann::json& entry ) -> PNS::MEANDER_SETTINGS
642 {
643 PNS::MEANDER_SETTINGS settings;
644
645 if( entry.contains( "min_amplitude" ) )
646 settings.m_minAmplitude = pcbIUScale.mmToIU( entry["min_amplitude"].get<double>() );
647
648 if( entry.contains( "max_amplitude" ) )
649 settings.m_maxAmplitude = pcbIUScale.mmToIU( entry["max_amplitude"].get<double>() );
650
651 if( entry.contains( "spacing" ) )
652 settings.m_spacing = pcbIUScale.mmToIU( entry["spacing"].get<double>() );
653
654 if( entry.contains( "corner_style" ) )
655 {
656 settings.m_cornerStyle = entry["corner_style"] == 0 ? PNS::MEANDER_STYLE_CHAMFER
658 }
659
660 if( entry.contains( "corner_radius_percentage" ) )
661 settings.m_cornerRadiusPercentage = entry["corner_radius_percentage"].get<int>();
662
663 if( entry.contains( "single_sided" ) )
664 settings.m_singleSided = entry["single_sided"].get<bool>();
665
666 return settings;
667 };
668
669 if( aObj.contains( "single_track_defaults" ) )
670 m_SingleTrackMeanderSettings = read_settings( aObj["single_track_defaults"] );
671
672 if( aObj.contains( "diff_pair_defaults" ) )
673 m_DiffPairMeanderSettings = read_settings( aObj["diff_pair_defaults"] );
674
675 if( aObj.contains( "diff_pair_skew_defaults" ) )
676 m_SkewMeanderSettings = read_settings( aObj["diff_pair_skew_defaults"] );
677 },
678 {} ) );
679
680 int minTextSize = pcbIUScale.mmToIU( TEXT_MIN_SIZE_MM );
681 int maxTextSize = pcbIUScale.mmToIU( TEXT_MAX_SIZE_MM );
682 int minStroke = 1;
683 int maxStroke = pcbIUScale.mmToIU( 100 );
684
685 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_line_width",
687 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
688
689 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_v",
691 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
692
693 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_h",
695 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
696
697 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_thickness",
699 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
700
701 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_italic",
702 &m_TextItalic[LAYER_CLASS_SILK], false ) );
703
704 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_upright",
705 &m_TextUpright[ LAYER_CLASS_SILK ], true ) );
706
707 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_line_width",
709 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
710
711 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_v",
713 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
714
715 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_h",
717 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
718
719 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_thickness",
721 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
722
723 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_italic",
724 &m_TextItalic[LAYER_CLASS_COPPER], false ) );
725
726 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_upright",
728
729 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.board_outline_line_width",
731 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
732
733 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.courtyard_line_width",
735 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
736
737 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_line_width",
739 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
740
741 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_v",
743 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
744
745 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_h",
747 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
748
749 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_thickness",
751 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
752
753 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_italic",
754 &m_TextItalic[LAYER_CLASS_FAB], false ) );
755
756 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_upright",
757 &m_TextUpright[LAYER_CLASS_FAB], true ) );
758
759 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_line_width",
761 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
762
763 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_v",
765 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
766
767 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_h",
769 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
770
771 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_thickness",
773 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
774
775 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_italic",
776 &m_TextItalic[LAYER_CLASS_OTHERS], false ) );
777
778 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_upright",
780
781 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_MODE>( "defaults.dimension_units",
782 &m_DimensionUnitsMode, DIM_UNITS_MODE::AUTOMATIC, DIM_UNITS_MODE::INCHES,
783 DIM_UNITS_MODE::AUTOMATIC ) );
784
785 m_params.emplace_back( new PARAM_ENUM<DIM_PRECISION>( "defaults.dimension_precision",
786 &m_DimensionPrecision, DIM_PRECISION::X_XXXX, DIM_PRECISION::X, DIM_PRECISION::V_VVVVV ) );
787
788 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_FORMAT>( "defaults.dimensions.units_format",
789 &m_DimensionUnitsFormat, DIM_UNITS_FORMAT::BARE_SUFFIX, DIM_UNITS_FORMAT::NO_SUFFIX,
790 DIM_UNITS_FORMAT::PAREN_SUFFIX ) );
791
792 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.suppress_zeroes",
793 &m_DimensionSuppressZeroes, false ) );
794
795 // NOTE: excluding DIM_TEXT_POSITION::MANUAL from the valid range here
796 m_params.emplace_back( new PARAM_ENUM<DIM_TEXT_POSITION>( "defaults.dimensions.text_position",
797 &m_DimensionTextPosition, DIM_TEXT_POSITION::OUTSIDE, DIM_TEXT_POSITION::OUTSIDE,
798 DIM_TEXT_POSITION::INLINE ) );
799
800 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.keep_text_aligned",
802
803 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.arrow_length",
806
807 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.extension_offset",
810
811 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_fields",
812 &m_StyleFPFields, false ) );
813 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_text",
814 &m_StyleFPText, false ) );
815 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_shapes",
816 &m_StyleFPShapes, false ) );
817
818 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.zones.min_clearance",
821
822 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "defaults.pads",
823 [&]() -> nlohmann::json
824 {
825 nlohmann::json ret =
826 {
827 { "width", pcbIUScale.IUTomm( m_Pad_Master->GetSize().x ) },
828 { "height", pcbIUScale.IUTomm( m_Pad_Master->GetSize().y ) },
829 { "drill", pcbIUScale.IUTomm( m_Pad_Master->GetDrillSize().x ) }
830 };
831
832 return ret;
833 },
834 [&]( const nlohmann::json& aJson )
835 {
836 if( aJson.contains( "width" ) && aJson.contains( "height" )
837 && aJson.contains( "drill" ) )
838 {
839 VECTOR2I sz;
840 sz.x = pcbIUScale.mmToIU( aJson["width"].get<double>() );
841 sz.y = pcbIUScale.mmToIU( aJson["height"].get<double>() );
842
843 m_Pad_Master->SetSize( sz );
844
845 int drill = pcbIUScale.mmToIU( aJson["drill"].get<double>() );
846
847 m_Pad_Master->SetDrillSize( VECTOR2I( drill, drill ) );
848 }
849 }, {} ) );
850
851 m_params.emplace_back( new PARAM_SCALED<int>( "rules.max_error",
853
854 m_params.emplace_back( new PARAM_SCALED<int>( "rules.solder_mask_to_copper_clearance",
857
858 m_params.emplace_back( new PARAM<bool>( "zones_allow_external_fillets",
859 &m_ZoneKeepExternalFillets, false ) );
860
862
863 registerMigration( 1, 2,
864 [&]() -> bool
865 {
866 // Schema 1 to 2: move mask and paste margin settings back to board.
867 // The parameters are removed, so we just have to manually load them here and
868 // they will get saved with the board
869 if( std::optional<double> optval = Get<double>( "rules.solder_mask_clearance" ) )
870 m_SolderMaskExpansion = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
871
872 if( std::optional<double> optval = Get<double>( "rules.solder_mask_min_width" ) )
873 m_SolderMaskMinWidth = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
874
875 if( std::optional<double> optval = Get<double>( "rules.solder_paste_clearance" ) )
876 m_SolderPasteMargin = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
877
878 if( std::optional<double> optval = Get<double>( "rules.solder_paste_margin_ratio" ) )
879 m_SolderPasteMarginRatio = *optval;
880
881 try
882 {
883 At( "rules" ).erase( "solder_mask_clearance" );
884 At( "rules" ).erase( "solder_mask_min_width" );
885 At( "rules" ).erase( "solder_paste_clearance" );
886 At( "rules" ).erase( "solder_paste_margin_ratio" );
887 }
888 catch( ... )
889 {}
890
891 return true;
892 } );
893}
894
895
897{
898 if( m_parent )
899 {
901 m_parent = nullptr;
902 }
903}
904
905
907 NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aOther.m_parent,
908 aOther.m_path ),
909 m_Pad_Master( nullptr )
910{
911 initFromOther( aOther );
912}
913
914
916{
917 initFromOther( aOther );
918 return *this;
919}
920
921
923{
924 // Copy of NESTED_SETTINGS around is not allowed, so let's just update the params.
932 m_MinConn = aOther.m_MinConn;
950 m_MaxError = aOther.m_MaxError;
960
961 std::copy( std::begin( aOther.m_LineThickness ), std::end( aOther.m_LineThickness ),
962 std::begin( m_LineThickness ) );
963
964 std::copy( std::begin( aOther.m_TextSize ), std::end( aOther.m_TextSize ),
965 std::begin( m_TextSize ) );
966
967 std::copy( std::begin( aOther.m_TextThickness ), std::end( aOther.m_TextThickness ),
968 std::begin( m_TextThickness ) );
969
970 std::copy( std::begin( aOther.m_TextItalic ), std::end( aOther.m_TextItalic ),
971 std::begin( m_TextItalic ) );
972
973 std::copy( std::begin( aOther.m_TextUpright ), std::end( aOther.m_TextUpright ),
974 std::begin( m_TextUpright ) );
975
984
985 m_auxOrigin = aOther.m_auxOrigin;
986 m_gridOrigin = aOther.m_gridOrigin;
987 m_HasStackup = aOther.m_HasStackup;
989
1002 m_stackup = aOther.m_stackup;
1004 m_Pad_Master = std::make_unique<PAD>( *aOther.m_Pad_Master );
1006
1010}
1011
1012
1014{
1015 if( m_TrackWidthList != aOther.m_TrackWidthList ) return false;
1016 if( m_ViasDimensionsList != aOther.m_ViasDimensionsList ) return false;
1017 if( m_DiffPairDimensionsList != aOther.m_DiffPairDimensionsList ) return false;
1018 if( m_CurrentViaType != aOther.m_CurrentViaType ) return false;
1019 if( m_UseConnectedTrackWidth != aOther.m_UseConnectedTrackWidth ) return false;
1020 if( m_TempOverrideTrackWidth != aOther.m_TempOverrideTrackWidth ) return false;
1021 if( m_MinClearance != aOther.m_MinClearance ) return false;
1022 if( m_MinConn != aOther.m_MinConn ) return false;
1023 if( m_TrackMinWidth != aOther.m_TrackMinWidth ) return false;
1024 if( m_ViasMinAnnularWidth != aOther.m_ViasMinAnnularWidth ) return false;
1025 if( m_ViasMinSize != aOther.m_ViasMinSize ) return false;
1026 if( m_MinThroughDrill != aOther.m_MinThroughDrill ) return false;
1027 if( m_MicroViasMinSize != aOther.m_MicroViasMinSize ) return false;
1028 if( m_MicroViasMinDrill != aOther.m_MicroViasMinDrill ) return false;
1029 if( m_CopperEdgeClearance != aOther.m_CopperEdgeClearance ) return false;
1030 if( m_HoleClearance != aOther.m_HoleClearance ) return false;
1031 if( m_HoleToHoleMin != aOther.m_HoleToHoleMin ) return false;
1032 if( m_SilkClearance != aOther.m_SilkClearance ) return false;
1033 if( m_MinResolvedSpokes != aOther.m_MinResolvedSpokes ) return false;
1034 if( m_MinSilkTextHeight != aOther.m_MinSilkTextHeight ) return false;
1035 if( m_MinSilkTextThickness != aOther.m_MinSilkTextThickness ) return false;
1036 if( m_DRCSeverities != aOther.m_DRCSeverities ) return false;
1037 if( m_DrcExclusions != aOther.m_DrcExclusions ) return false;
1038 if( m_DrcExclusionComments != aOther.m_DrcExclusionComments ) return false;
1039 if( m_ZoneKeepExternalFillets != aOther.m_ZoneKeepExternalFillets ) return false;
1040 if( m_MaxError != aOther.m_MaxError ) return false;
1041 if( m_SolderMaskExpansion != aOther.m_SolderMaskExpansion ) return false;
1042 if( m_SolderMaskMinWidth != aOther.m_SolderMaskMinWidth ) return false;
1044 if( m_SolderPasteMargin != aOther.m_SolderPasteMargin ) return false;
1045 if( m_SolderPasteMarginRatio != aOther.m_SolderPasteMarginRatio ) return false;
1047 if( m_TentViasFront != aOther.m_TentViasFront ) return false;
1048 if( m_TentViasBack != aOther.m_TentViasBack ) return false;
1049 if( m_DefaultFPTextItems != aOther.m_DefaultFPTextItems ) return false;
1050
1051 if( !std::equal( std::begin( m_LineThickness ), std::end( m_LineThickness ),
1052 std::begin( aOther.m_LineThickness ) ) )
1053 return false;
1054
1055 if( !std::equal( std::begin( m_TextSize ), std::end( m_TextSize ),
1056 std::begin( aOther.m_TextSize ) ) )
1057 return false;
1058
1059 if( !std::equal( std::begin( m_TextThickness ), std::end( m_TextThickness ),
1060 std::begin( aOther.m_TextThickness ) ) )
1061 return false;
1062
1063 if( !std::equal( std::begin( m_TextItalic ), std::end( m_TextItalic ),
1064 std::begin( aOther.m_TextItalic ) ) )
1065 return false;
1066
1067 if( !std::equal( std::begin( m_TextUpright ), std::end( m_TextUpright ),
1068 std::begin( aOther.m_TextUpright ) ) )
1069 return false;
1070
1071 if( m_DimensionUnitsMode != aOther.m_DimensionUnitsMode ) return false;
1072 if( m_DimensionPrecision != aOther.m_DimensionPrecision ) return false;
1073 if( m_DimensionUnitsFormat != aOther.m_DimensionUnitsFormat ) return false;
1074 if( m_DimensionSuppressZeroes != aOther.m_DimensionSuppressZeroes ) return false;
1075 if( m_DimensionTextPosition != aOther.m_DimensionTextPosition ) return false;
1076 if( m_DimensionKeepTextAligned != aOther.m_DimensionKeepTextAligned ) return false;
1077 if( m_DimensionArrowLength != aOther.m_DimensionArrowLength ) return false;
1078 if( m_DimensionExtensionOffset != aOther.m_DimensionExtensionOffset ) return false;
1079 if( m_auxOrigin != aOther.m_auxOrigin ) return false;
1080 if( m_gridOrigin != aOther.m_gridOrigin ) return false;
1081 if( m_HasStackup != aOther.m_HasStackup ) return false;
1082 if( m_UseHeightForLengthCalcs != aOther.m_UseHeightForLengthCalcs ) return false;
1083 if( m_trackWidthIndex != aOther.m_trackWidthIndex ) return false;
1084 if( m_viaSizeIndex != aOther.m_viaSizeIndex ) return false;
1085 if( m_diffPairIndex != aOther.m_diffPairIndex ) return false;
1086 if( m_useCustomTrackVia != aOther.m_useCustomTrackVia ) return false;
1087 if( m_customTrackWidth != aOther.m_customTrackWidth ) return false;
1088 if( m_customViaSize != aOther.m_customViaSize ) return false;
1089 if( m_useCustomDiffPair != aOther.m_useCustomDiffPair ) return false;
1090 if( m_customDiffPair != aOther.m_customDiffPair ) return false;
1091 if( m_copperLayerCount != aOther.m_copperLayerCount ) return false;
1092 if( m_enabledLayers != aOther.m_enabledLayers ) return false;
1093 if( m_boardThickness != aOther.m_boardThickness ) return false;
1094 if( m_currentNetClassName != aOther.m_currentNetClassName ) return false;
1095 if( m_stackup != aOther.m_stackup ) return false;
1096 if( *m_NetSettings != *aOther.m_NetSettings ) return false;
1097 if( *m_Pad_Master != *aOther.m_Pad_Master ) return false;
1098 if( m_defaultZoneSettings != aOther.m_defaultZoneSettings ) return false;
1099
1100 if( m_StyleFPFields != aOther.m_StyleFPFields ) return false;
1101 if( m_StyleFPText != aOther.m_StyleFPText ) return false;
1102 if( m_StyleFPShapes != aOther.m_StyleFPShapes ) return false;
1103
1104 return true;
1105}
1106
1107
1109{
1127 std::string units_ptr( "defaults.dimension_units" );
1128 std::string precision_ptr( "defaults.dimension_precision" );
1129
1130 if( !( Contains( units_ptr ) && Contains( precision_ptr ) &&
1131 At( units_ptr ).is_number_integer() &&
1132 At( precision_ptr ).is_number_integer() ) )
1133 {
1134 // if either is missing or invalid, migration doesn't make sense
1135 return true;
1136 }
1137
1138 int units = *Get<int>( units_ptr );
1139 int precision = *Get<int>( precision_ptr );
1140
1141 // The enum maps directly to precision if the units is mils
1142 int extraDigits = 0;
1143
1144 switch( units )
1145 {
1146 case 0: extraDigits = 3; break;
1147 case 2: extraDigits = 2; break;
1148 default: break;
1149 }
1150
1151 precision += extraDigits;
1152
1153 Set( precision_ptr, precision );
1154
1155 return true;
1156}
1157
1158
1159bool BOARD_DESIGN_SETTINGS::LoadFromFile( const wxString& aDirectory )
1160{
1161 bool ret = NESTED_SETTINGS::LoadFromFile( aDirectory );
1162
1163 // A number of things won't have been translated by the PROJECT_FILE migration because of
1164 // descoped objects required to decode this data. So, it will be in the legacy.pcbnew
1165 // section and needs to be pulled out here
1166
1167 PROJECT_FILE* project = dynamic_cast<PROJECT_FILE*>( GetParent() );
1168
1169 if( !project )
1170 return ret;
1171
1172 bool migrated = false;
1173
1174 auto drcName =
1175 []( int aCode ) -> std::string
1176 {
1177 std::shared_ptr<DRC_ITEM> item = DRC_ITEM::Create( aCode );
1178 wxString name = item->GetSettingsKey();
1179 return std::string( name.ToUTF8() );
1180 };
1181
1182 const std::string rs = "rule_severities.";
1183 const std::string no_courtyard_key = "legacy_no_courtyard_defined";
1184 const std::string courtyard_overlap_key = "legacy_courtyards_overlap";
1185
1186 try
1187 {
1188 nlohmann::json& severities =
1189 project->Internals()->at( "/board/design_settings/rule_severities"_json_pointer );
1190
1191 if( severities.contains( no_courtyard_key ) )
1192 {
1193 if( severities[no_courtyard_key].get<bool>() )
1194 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "error" );
1195 else
1196 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "ignore" );
1197
1198 severities.erase( no_courtyard_key );
1199 migrated = true;
1200 }
1201
1202 if( severities.contains( courtyard_overlap_key ) )
1203 {
1204 if( severities[courtyard_overlap_key].get<bool>() )
1205 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "error" );
1206 else
1207 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "ignore" );
1208
1209 severities.erase( courtyard_overlap_key );
1210 migrated = true;
1211 }
1212 }
1213 catch( ... )
1214 {
1215 }
1216 if( Contains( "legacy" ) )
1217 {
1218 // This defaults to false for new boards, but version 5.1.x and prior kept the fillets
1219 // so we do the same for legacy boards.
1221
1222 project->At( "legacy" ).erase( "pcbnew" );
1223 }
1224
1225 // Now that we have everything, we need to load again
1226 if( migrated )
1227 Load();
1228
1229 return ret;
1230}
1231
1232
1234{
1235 return m_DRCSeverities[ aDRCErrorCode ];
1236}
1237
1238
1239bool BOARD_DESIGN_SETTINGS::Ignore( int aDRCErrorCode )
1240{
1241 return m_DRCSeverities[ aDRCErrorCode ] == RPT_SEVERITY_IGNORE;
1242}
1243
1244
1246{
1247 int biggest = std::max( m_MinClearance, m_HoleClearance );
1248 DRC_CONSTRAINT constraint;
1249
1250 biggest = std::max( biggest, m_HoleToHoleMin );
1251 biggest = std::max( biggest, m_CopperEdgeClearance );
1252
1253 if( m_DRCEngine )
1254 {
1255 m_DRCEngine->QueryWorstConstraint( CLEARANCE_CONSTRAINT, constraint );
1256 biggest = std::max( biggest, constraint.Value().Min() );
1257
1258 m_DRCEngine->QueryWorstConstraint( PHYSICAL_CLEARANCE_CONSTRAINT, constraint );
1259 biggest = std::max( biggest, constraint.Value().Min() );
1260
1261 m_DRCEngine->QueryWorstConstraint( HOLE_CLEARANCE_CONSTRAINT, constraint );
1262 biggest = std::max( biggest, constraint.Value().Min() );
1263
1264 m_DRCEngine->QueryWorstConstraint( EDGE_CLEARANCE_CONSTRAINT, constraint );
1265 biggest = std::max( biggest, constraint.Value().Min() );
1266
1267 m_DRCEngine->QueryWorstConstraint( HOLE_TO_HOLE_CONSTRAINT, constraint );
1268 biggest = std::max( biggest, constraint.Value().Min() );
1269 }
1270
1271 return biggest;
1272}
1273
1274
1276{
1277 int clearance = m_NetSettings->m_DefaultNetClass->GetClearance();
1278
1279 for( const auto& [ name, netclass ] : m_NetSettings->m_NetClasses )
1280 clearance = std::min( clearance, netclass->GetClearance() );
1281
1282 return clearance;
1283}
1284
1285
1287{
1288 m_viaSizeIndex = std::min( aIndex, (unsigned) m_ViasDimensionsList.size() );
1289 m_useCustomTrackVia = false;
1290}
1291
1292
1294{
1297 else if( m_viaSizeIndex == 0 )
1298 return m_NetSettings->m_DefaultNetClass->GetViaDiameter();
1299 else
1300 return m_ViasDimensionsList[ m_viaSizeIndex ].m_Diameter;
1301}
1302
1303
1305{
1306 int drill;
1307
1309 drill = m_customViaSize.m_Drill;
1310 else if( m_viaSizeIndex == 0 )
1311 drill = m_NetSettings->m_DefaultNetClass->GetViaDrill();
1312 else
1313 drill = m_ViasDimensionsList[ m_viaSizeIndex ].m_Drill;
1314
1315 return drill > 0 ? drill : -1;
1316}
1317
1318
1320{
1321 m_trackWidthIndex = std::min( aIndex, (unsigned) m_TrackWidthList.size() );
1322 m_useCustomTrackVia = false;
1323}
1324
1325
1327{
1329 return m_customTrackWidth;
1330 else if( m_trackWidthIndex == 0 )
1331 return m_NetSettings->m_DefaultNetClass->GetTrackWidth();
1332 else
1334}
1335
1336
1338{
1339 if( !m_DiffPairDimensionsList.empty() )
1340 {
1341 m_diffPairIndex = std::min( aIndex,
1342 static_cast<unsigned>( m_DiffPairDimensionsList.size() ) - 1 );
1343 }
1344
1345 m_useCustomDiffPair = false;
1346}
1347
1348
1350{
1352 {
1354 }
1355 else if( m_diffPairIndex == 0 )
1356 {
1357 if( m_NetSettings->m_DefaultNetClass->HasDiffPairWidth() )
1358 return m_NetSettings->m_DefaultNetClass->GetDiffPairWidth();
1359 else
1360 return m_NetSettings->m_DefaultNetClass->GetTrackWidth();
1361 }
1362 else
1363 {
1365 }
1366}
1367
1368
1370{
1372 {
1373 return m_customDiffPair.m_Gap;
1374 }
1375 else if( m_diffPairIndex == 0 )
1376 {
1377 if( m_NetSettings->m_DefaultNetClass->HasDiffPairGap() )
1378 return m_NetSettings->m_DefaultNetClass->GetDiffPairGap();
1379 else
1380 return m_NetSettings->m_DefaultNetClass->GetClearance();
1381 }
1382 else
1383 {
1385 }
1386}
1387
1388
1390{
1392 {
1394 }
1395 else if( m_diffPairIndex == 0 )
1396 {
1397 if( m_NetSettings->m_DefaultNetClass->HasDiffPairViaGap() )
1398 return m_NetSettings->m_DefaultNetClass->GetDiffPairViaGap();
1399 else
1400 return GetCurrentDiffPairGap();
1401 }
1402 else
1403 {
1405 }
1406}
1407
1408
1410{
1411 m_copperLayerCount = aNewLayerCount;
1412
1413 // Update only enabled copper layers mask
1414 m_enabledLayers &= ~LSET::AllCuMask();
1415
1416 if( aNewLayerCount > 0 )
1417 m_enabledLayers |= LSET::AllCuMask( aNewLayerCount );
1418}
1419
1420
1422{
1423 // Back and front layers are always enabled.
1424 aMask.set( B_Cu ).set( F_Cu );
1425
1426 m_enabledLayers = aMask;
1427
1428 // update m_CopperLayerCount to ensure its consistency with m_EnabledLayers
1429 m_copperLayerCount = ( aMask & LSET::AllCuMask() ).count();
1430}
1431
1432
1433// Return the layer class index { silk, copper, edges & courtyards, fab, others } of the
1434// given layer.
1436{
1437 if( aLayer == F_SilkS || aLayer == B_SilkS )
1438 return LAYER_CLASS_SILK;
1439 else if( IsCopperLayer( aLayer ) )
1440 return LAYER_CLASS_COPPER;
1441 else if( aLayer == Edge_Cuts )
1442 return LAYER_CLASS_EDGES;
1443 else if( aLayer == F_CrtYd || aLayer == B_CrtYd )
1444 return LAYER_CLASS_COURTYARD;
1445 else if( aLayer == F_Fab || aLayer == B_Fab )
1446 return LAYER_CLASS_FAB;
1447 else
1448 return LAYER_CLASS_OTHERS;
1449}
1450
1451
1453{
1454 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_DRCEpsilon );
1455}
1456
1457
1459{
1460 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_HoleWallThickness );
1461}
1462
1463
1465{
1466 return m_LineThickness[ GetLayerClass( aLayer ) ];
1467}
1468
1469
1471{
1472 return m_TextSize[ GetLayerClass( aLayer ) ];
1473}
1474
1475
1477{
1478 return m_TextThickness[ GetLayerClass( aLayer ) ];
1479}
1480
1481
1483{
1484 return m_TextItalic[ GetLayerClass( aLayer ) ];
1485}
1486
1487
1489{
1490 return m_TextUpright[ GetLayerClass( aLayer ) ];
1491}
1492
1494{
1495 m_Pad_Master.get()->SetSizeX( pcbIUScale.mmToIU( DEFAULT_PAD_WIDTH_MM ) );
1497 m_Pad_Master.get()->SetDrillShape( PAD_DRILL_SHAPE::CIRCLE );
1498 m_Pad_Master.get()->SetDrillSize(
1500 m_Pad_Master.get()->SetShape( PAD_SHAPE::ROUNDRECT );
1501 m_Pad_Master.get()->SetRoundRectCornerRadius(
1503}
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_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=std::numeric_limits< size_t >::max(), bool value=true)
Definition: base_set.h:61
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:143
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: drc_item.h:126
static std::shared_ptr< DRC_ITEM > Create(int aErrorCode)
Constructs a DRC_ITEM for the given error code.
Definition: drc_item.cpp:352
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:35
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:732
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()
Stores an enum as an integer.
Definition: parameters.h:226
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:293
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition: parameters.h:390
Dimensions for the meandering algorithm.
Definition: pns_meander.h:68
int m_minAmplitude
Maximum meandering amplitude.
Definition: pns_meander.h:82
int m_cornerRadiusPercentage
Place meanders on one side.
Definition: pns_meander.h:108
bool m_singleSided
Initial side when placing meanders at segment.
Definition: pns_meander.h:111
MEANDER_STYLE m_cornerStyle
Rounding percentage (0 - 100).
Definition: pns_meander.h:105
int m_maxAmplitude
Meandering period/spacing (see dialog picture for explanation).
Definition: pns_meander.h:85
int m_spacing
Amplitude/spacing adjustment step.
Definition: pns_meander.h:88
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:70
A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
Definition: rc_item.h:79
bool m_TargetPadsWithNoHole
True to create teardrops for pads without holes (SMD and others.
bool m_TargetViasPads
True to create teardrops for vias and pads with holes.
bool m_UseRoundShapesOnly
True to create teardrops for round shapes only.
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)
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:94
@ DRCE_PADSTACK
Definition: drc_item.h:59
@ DRCE_LIB_FOOTPRINT_ISSUES
Definition: drc_item.h:78
@ DRCE_OVERLAPPING_FOOTPRINTS
Definition: drc_item.h:62
@ DRCE_OVERLAPPING_SILK
Definition: drc_item.h:97
@ DRCE_MISSING_COURTYARD
Definition: drc_item.h:63
@ DRCE_ISOLATED_COPPER
Definition: drc_item.h:47
@ DRCE_DRILLED_HOLES_TOO_CLOSE
Definition: drc_item.h:51
@ DRCE_COPPER_SLIVER
Definition: drc_item.h:88
@ DRCE_PTH_IN_COURTYARD
Definition: drc_item.h:66
@ DRCE_FIRST
Definition: drc_item.h:38
@ DRCE_DANGLING_VIA
Definition: drc_item.h:49
@ DRCE_FOOTPRINT_TYPE_MISMATCH
Definition: drc_item.h:77
@ DRCE_DUPLICATE_FOOTPRINT
Definition: drc_item.h:72
@ DRCE_DANGLING_TRACK
Definition: drc_item.h:50
@ DRCE_TEXT_HEIGHT
Definition: drc_item.h:95
@ DRCE_DRILLED_HOLES_COLOCATED
Definition: drc_item.h:52
@ DRCE_EXTRA_FOOTPRINT
Definition: drc_item.h:73
@ DRCE_SILK_CLEARANCE
Definition: drc_item.h:92
@ DRCE_LAST
Definition: drc_item.h:105
@ DRCE_LIB_FOOTPRINT_MISMATCH
Definition: drc_item.h:79
@ DRCE_NET_CONFLICT
Definition: drc_item.h:74
@ DRCE_MISSING_FOOTPRINT
Definition: drc_item.h:71
@ DRCE_TEXT_THICKNESS
Definition: drc_item.h:96
@ DRCE_NPTH_IN_COURTYARD
Definition: drc_item.h:67
@ DRCE_CONNECTION_WIDTH
Definition: drc_item.h:56
@ DRCE_SCHEMATIC_PARITY_ISSUES
Definition: drc_item.h:75
@ EDGE_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:51
@ CLEARANCE_CONSTRAINT
Definition: drc_rule.h:48
@ HOLE_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:49
@ PHYSICAL_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:71
@ HOLE_TO_HOLE_CONSTRAINT
Definition: drc_rule.h:50
#define TEXT_MIN_SIZE_MM
Minimum text size (1 micron).
Definition: eda_text.h:46
#define TEXT_MAX_SIZE_MM
Maximum text size in mm (~10 inches)
Definition: eda_text.h:47
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:117
@ Edge_Cuts
Definition: layer_ids.h:113
@ B_Cu
Definition: layer_ids.h:95
@ F_Fab
Definition: layer_ids.h:120
@ F_SilkS
Definition: layer_ids.h:104
@ B_CrtYd
Definition: layer_ids.h:116
@ B_SilkS
Definition: layer_ids.h:103
@ F_Cu
Definition: layer_ids.h:64
@ B_Fab
Definition: layer_ids.h:119
@ 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:673
#define ZONE_CLEARANCE_MM
Definition: zones.h:37