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