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>
32#include <drc/drc_item.h>
33#include <drc/drc_engine.h>
35#include <settings/parameters.h>
37#include <advanced_config.h>
38
39const int bdsSchemaVersion = 2;
40
41
42BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath ) :
43 NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aParent, aPath )
44{
45 // We want to leave alone parameters that aren't found in the project JSON as they may be
46 // initialized by the board file parser before NESTED_SETTINGS::LoadFromFile is called.
48
49 // Create a default NET_SETTINGS so that things don't break horribly if there's no project
50 // loaded. This also is used during file load for legacy boards that have netclasses stored
51 // in the file. After load, this information will be moved to the project and the pointer
52 // updated.
53 m_NetSettings = std::make_shared<NET_SETTINGS>( nullptr, "" );
54
55 m_HasStackup = false; // no stackup defined by default
56
57 m_Pad_Master = std::make_unique<PAD>( nullptr );
59
60 LSET all_set = LSET().set();
61 m_enabledLayers = all_set; // All layers enabled at first.
62 // SetCopperLayerCount() will adjust this.
63
64 // Default design is a double layer board with 4 user defined layers
67
69
70 // if true, when creating a new track starting on an existing track, use this track width
73
74 // First is always the reference designator
75 m_DefaultFPTextItems.emplace_back( wxT( "REF**" ), true, F_SilkS );
76 // Second is always the value
77 m_DefaultFPTextItems.emplace_back( wxT( "" ), true, F_Fab );
78 // Any following ones are freebies
79 m_DefaultFPTextItems.emplace_back( wxT( "${REFERENCE}" ), true, F_Fab );
80
87
94
95 // Edges & Courtyards; text properties aren't used but better to have them holding
96 // reasonable values than not.
99 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
103
106 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
110
113 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
115 m_TextItalic[ LAYER_CLASS_FAB ] = false;
117
120 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
124
125 m_StyleFPFields = false;
126 m_StyleFPText = false;
127 m_StyleFPShapes = false;
128 m_StyleFPDimensions = false;
129 m_StyleFPBarcodes = false;
130
139
140 m_useCustomTrackVia = false;
142 m_customViaSize.m_Diameter = pcbIUScale.mmToIU( DEFAULT_VIASMINSIZE );
144
145 m_useCustomDiffPair = false;
149
166
167 for( int errorCode = DRCE_FIRST; errorCode <= DRCE_LAST; ++errorCode )
168 m_DRCSeverities[ errorCode ] = RPT_SEVERITY_ERROR;
169
172
176
179
182
184
192
198
200
203
205
208
211
215
216 // Global mask margins:
220
221 // Solder paste margin absolute value
223 // Solder paste margin as a ratio of pad size
224 // The final margin is the sum of these 2 values
225 // Usually < 0 because the mask is smaller than pad
227
229 m_TentViasFront = true;
230 m_TentViasBack = true;
231
232 m_CoverViasFront = false;
233 m_CoverViasBack = false;
234
235 m_PlugViasFront = false;
236 m_PlugViasBack = false;
237
238 m_CapVias = false;
239
240 m_FillVias = false;
241
242 // Layer thickness for 3D viewer
244
245 // Default spacing for meanders
249
250 m_viaSizeIndex = 0;
252 m_diffPairIndex = 0;
253
254 // Parameters stored in JSON in the project file
255
256 // NOTE: Previously, BOARD_DESIGN_SETTINGS stored the basic board layer information (layer
257 // names and enable/disable state) in the project file even though this information is also
258 // stored in the board file. This was implemented for importing these settings from another
259 // project. Going forward, the import feature will just import from other board files (since
260 // we could have multi-board projects in the future anyway) so this functionality is dropped.
261
262
263 m_params.emplace_back( new PARAM<bool>( "rules.use_height_for_length_calcs",
264 &m_UseHeightForLengthCalcs, true ) );
265
266 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_clearance",
268 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
269
270 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_connection",
272 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
273
274 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_track_width",
276 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
277
278 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_annular_width",
280 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
281
282 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_diameter",
284 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
285
286 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_through_hole_diameter",
288 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
289
290 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_diameter",
292 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
293
294 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_drill",
296 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
297
298 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_to_hole",
300 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
301
302 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_clearance",
304 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
305
306 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_silk_clearance",
308 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
309
310 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_groove_width",
312 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
313
314 // While the maximum *effective* value is 4, we've had users interpret this as the count on
315 // all layers, and enter something like 10. They'll figure it out soon enough *unless* we
316 // enforce a max of 4 (and therefore reset it back to the default of 2), at which point it
317 // just looks buggy.
318 m_params.emplace_back( new PARAM<int>( "rules.min_resolved_spokes",
320
321 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_height",
323 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
324
325 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_thickness",
327 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
328
329 // Note: a clearance of -0.01 is a flag indicating we should use the legacy (pre-6.0) method
330 // based on the edge cut thicknesses.
331 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_copper_edge_clearance",
333 pcbIUScale.mmToIU( -0.01 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
334
335 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
336 [&]() -> nlohmann::json
337 {
338 nlohmann::json ret = {};
339
340 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
341 {
342 wxString name = item.GetSettingsKey();
343 int code = item.GetErrorCode();
344
345 if( name.IsEmpty() || m_DRCSeverities.count( code ) == 0 )
346 continue;
347
348 ret[std::string( name.ToUTF8() )] = SeverityToString( m_DRCSeverities[code] );
349 }
350
351 return ret;
352 },
353 [&]( const nlohmann::json& aJson )
354 {
355 if( !aJson.is_object() )
356 return;
357
358 // Load V8 'hole_near_hole' token first (if present). Any current 'hole_to_hole' token
359 // found will then overwrite it.
360 // We can't use the migration architecture because we forgot to bump the version number
361 // when the change was made. But this is a one-off as any future deprecations should
362 // bump the version number and use registerMigration().
363 if( aJson.contains( "hole_near_hole" ) )
365
366 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
367 {
368 wxString name = item.GetSettingsKey();
369 std::string key( name.ToUTF8() );
370
371 if( aJson.contains( key ) )
372 m_DRCSeverities[item.GetErrorCode()] = SeverityFromString( aJson[key] );
373 }
374 }, {} ) );
375
376 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "drc_exclusions",
377 [&]() -> nlohmann::json
378 {
379 nlohmann::json js = nlohmann::json::array();
380
381 for( const wxString& entry : m_DrcExclusions )
382 js.push_back( { entry, m_DrcExclusionComments[ entry ] } );
383
384 return js;
385 },
386 [&]( const nlohmann::json& aObj )
387 {
388 m_DrcExclusions.clear();
389
390 if( !aObj.is_array() )
391 return;
392
393 for( const nlohmann::json& entry : aObj )
394 {
395 if( entry.is_array() )
396 {
397 wxString serialized = entry[0].get<wxString>();
398 m_DrcExclusions.insert( serialized );
399 m_DrcExclusionComments[ serialized ] = entry[1].get<wxString>();
400 }
401 else if( entry.is_string() )
402 {
403 m_DrcExclusions.insert( entry.get<wxString>() );
404 }
405 }
406 },
407 {} ) );
408
409 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "track_widths",
410 [&]() -> nlohmann::json
411 {
412 nlohmann::json js = nlohmann::json::array();
413
414 for( const int& width : m_TrackWidthList )
415 js.push_back( pcbIUScale.IUTomm( width ) );
416
417 return js;
418 },
419 [&]( const nlohmann::json& aJson )
420 {
421 if( !aJson.is_array() )
422 return;
423
424 m_TrackWidthList.clear();
425
426 for( const nlohmann::json& entry : aJson )
427 {
428 if( entry.empty() )
429 continue;
430
431 m_TrackWidthList.emplace_back( pcbIUScale.mmToIU( entry.get<double>() ) );
432 }
433 },
434 {} ) );
435
436 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "via_dimensions",
437 [&]() -> nlohmann::json
438 {
439 nlohmann::json js = nlohmann::json::array();
440
441 for( const auto& via : m_ViasDimensionsList )
442 {
443 nlohmann::json entry = {};
444
445 entry["diameter"] = pcbIUScale.IUTomm( via.m_Diameter );
446 entry["drill"] = pcbIUScale.IUTomm( via.m_Drill );
447
448 js.push_back( entry );
449 }
450
451 return js;
452 },
453 [&]( const nlohmann::json& aObj )
454 {
455 if( !aObj.is_array() )
456 return;
457
458 m_ViasDimensionsList.clear();
459
460 for( const nlohmann::json& entry : aObj )
461 {
462 if( entry.empty() || !entry.is_object() )
463 continue;
464
465 if( !entry.contains( "diameter" ) || !entry.contains( "drill" ) )
466 continue;
467
468 int diameter = pcbIUScale.mmToIU( entry["diameter"].get<double>() );
469 int drill = pcbIUScale.mmToIU( entry["drill"].get<double>() );
470
471 m_ViasDimensionsList.emplace_back( VIA_DIMENSION( diameter, drill ) );
472 }
473 },
474 {} ) );
475
476 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "diff_pair_dimensions",
477 [&]() -> nlohmann::json
478 {
479 nlohmann::json js = nlohmann::json::array();
480
481 for( const auto& pair : m_DiffPairDimensionsList )
482 {
483 nlohmann::json entry = {};
484
485 entry["width"] = pcbIUScale.IUTomm( pair.m_Width );
486 entry["gap"] = pcbIUScale.IUTomm( pair.m_Gap );
487 entry["via_gap"] = pcbIUScale.IUTomm( pair.m_ViaGap );
488
489 js.push_back( entry );
490 }
491
492 return js;
493 },
494 [&]( const nlohmann::json& aObj )
495 {
496 if( !aObj.is_array() )
497 return;
498
500
501 for( const nlohmann::json& entry : aObj )
502 {
503 if( entry.empty() || !entry.is_object() )
504 continue;
505
506 if( !entry.contains( "width" )
507 || !entry.contains( "gap" )
508 || !entry.contains( "via_gap" ) )
509 {
510 continue;
511 }
512
513 int width = pcbIUScale.mmToIU( entry["width"].get<double>() );
514 int gap = pcbIUScale.mmToIU( entry["gap"].get<double>() );
515 int via_gap = pcbIUScale.mmToIU( entry["via_gap"].get<double>() );
516
517 m_DiffPairDimensionsList.emplace_back( DIFF_PAIR_DIMENSION( width, gap, via_gap ) );
518 }
519 },
520 {} ) );
521
522 // Handle options for teardrops (targets and some others):
523 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_options",
524 [&]() -> nlohmann::json
525 {
526 nlohmann::json js = nlohmann::json::array();
527 nlohmann::json entry = {};
528
529 entry["td_onvia"] = m_TeardropParamsList.m_TargetVias;
530 entry["td_onpthpad"] = m_TeardropParamsList.m_TargetPTHPads;
531 entry["td_onsmdpad"] = m_TeardropParamsList.m_TargetSMDPads;
532 entry["td_ontrackend"] = m_TeardropParamsList.m_TargetTrack2Track;
533 entry["td_onroundshapesonly"] = m_TeardropParamsList.m_UseRoundShapesOnly;
534
535 js.push_back( entry );
536
537 return js;
538 },
539 [&]( const nlohmann::json& aObj )
540 {
541 if( !aObj.is_array() )
542 return;
543
544 for( const nlohmann::json& entry : aObj )
545 {
546 if( entry.empty() || !entry.is_object() )
547 continue;
548
549 if( entry.contains( "td_onvia" ) )
550 m_TeardropParamsList.m_TargetVias = entry["td_onvia"].get<bool>();
551
552 if( entry.contains( "td_onpthpad" ) )
553 m_TeardropParamsList.m_TargetPTHPads = entry["td_onpthpad"].get<bool>();
554
555 if( entry.contains( "td_onsmdpad" ) )
556 m_TeardropParamsList.m_TargetSMDPads = entry["td_onsmdpad"].get<bool>();
557
558 if( entry.contains( "td_ontrackend" ) )
559 m_TeardropParamsList.m_TargetTrack2Track = entry["td_ontrackend"].get<bool>();
560
561 if( entry.contains( "td_onroundshapesonly" ) )
562 m_TeardropParamsList.m_UseRoundShapesOnly = entry["td_onroundshapesonly"].get<bool>();
563
564 // Legacy settings
565 for( int ii = 0; ii < 3; ++ii )
566 {
567 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)ii );
568
569 if( entry.contains( "td_allow_use_two_tracks" ) )
570 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
571
572 if( entry.contains( "td_curve_segcount" ) )
573 {
574 if( entry["td_curve_segcount"].get<int>() > 0 )
575 td_prm->m_CurvedEdges = true;
576 }
577
578 if( entry.contains( "td_on_pad_in_zone" ) )
579 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
580 }
581 }
582 },
583 {} ) );
584
585 // Handle parameters (sizes, shape) for each type of teardrop:
586 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_parameters",
587 [&]() -> nlohmann::json
588 {
589 nlohmann::json js = nlohmann::json::array();
590
591 for( size_t ii = 0; ii < m_TeardropParamsList.GetParametersCount(); ii++ )
592 {
593 nlohmann::json entry = {};
594 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)ii );
595
596 entry["td_target_name"] = GetTeardropTargetCanonicalName( (TARGET_TD)ii );
597 entry["td_maxlen"] = pcbIUScale.IUTomm( td_prm->m_TdMaxLen );
598 entry["td_maxheight"] = pcbIUScale.IUTomm( td_prm->m_TdMaxWidth );
599 entry["td_length_ratio"] = td_prm->m_BestLengthRatio;
600 entry["td_height_ratio"] = td_prm->m_BestWidthRatio;
601 entry["td_curve_segcount"] = td_prm->m_CurvedEdges ? 1 : 0;
602 entry["td_width_to_size_filter_ratio"] = td_prm->m_WidthtoSizeFilterRatio;
603 entry["td_allow_use_two_tracks"] = td_prm->m_AllowUseTwoTracks;
604 entry["td_on_pad_in_zone"] = td_prm->m_TdOnPadsInZones;
605
606 js.push_back( entry );
607 }
608
609 return js;
610 },
611 [&]( const nlohmann::json& aObj )
612 {
613 if( !aObj.is_array() )
614 return;
615
616 for( const nlohmann::json& entry : aObj )
617 {
618 if( entry.empty() || !entry.is_object() )
619 continue;
620
621 if( !entry.contains( "td_target_name" ) )
622 continue;
623
624 int idx = GetTeardropTargetTypeFromCanonicalName( entry["td_target_name"].get<std::string>() );
625
626 if( idx >= 0 && idx < 3 )
627 {
628 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)idx );
629
630 if( entry.contains( "td_maxlen" ) )
631 td_prm->m_TdMaxLen = pcbIUScale.mmToIU( entry["td_maxlen"].get<double>() );
632
633 if( entry.contains( "td_maxheight" ) )
634 td_prm->m_TdMaxWidth = pcbIUScale.mmToIU( entry["td_maxheight"].get<double>() );
635
636 if( entry.contains( "td_length_ratio" ) )
637 td_prm->m_BestLengthRatio = entry["td_length_ratio"].get<double>();
638
639 if( entry.contains( "td_height_ratio" ) )
640 td_prm->m_BestWidthRatio = entry["td_height_ratio"].get<double>();
641
642 if( entry.contains( "td_curve_segcount" ) )
643 {
644 if( entry["td_curve_segcount"].get<int>() > 0 )
645 td_prm->m_CurvedEdges = true;
646 }
647
648 if( entry.contains( "td_width_to_size_filter_ratio" ) )
649 td_prm->m_WidthtoSizeFilterRatio = entry["td_width_to_size_filter_ratio"].get<double>();
650
651 if( entry.contains( "td_allow_use_two_tracks" ) )
652 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
653
654 if( entry.contains( "td_on_pad_in_zone" ) )
655 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
656 }
657 }
658 },
659 {} ) );
660
661 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "tuning_pattern_settings",
662 [&]() -> nlohmann::json
663 {
664 nlohmann::json js = {};
665
666 auto make_settings =
667 []( const PNS::MEANDER_SETTINGS& aSettings )
668 {
669 nlohmann::json entry = {};
670
671 entry["min_amplitude"] = pcbIUScale.IUTomm( aSettings.m_minAmplitude );
672 entry["max_amplitude"] = pcbIUScale.IUTomm( aSettings.m_maxAmplitude );
673 entry["spacing"] = pcbIUScale.IUTomm( aSettings.m_spacing );
674 entry["corner_style"] = aSettings.m_cornerStyle == PNS::MEANDER_STYLE_CHAMFER ? 0 : 1;
675 entry["corner_radius_percentage"] = aSettings.m_cornerRadiusPercentage;
676 entry["single_sided"] = aSettings.m_singleSided;
677
678 return entry;
679 };
680
681 js["single_track_defaults"] = make_settings( m_SingleTrackMeanderSettings );
682 js["diff_pair_defaults"] = make_settings( m_DiffPairMeanderSettings );
683 js["diff_pair_skew_defaults"] = make_settings( m_SkewMeanderSettings );
684
685 return js;
686 },
687 [&]( const nlohmann::json& aObj )
688 {
689 auto read_settings =
690 []( const nlohmann::json& entry ) -> PNS::MEANDER_SETTINGS
691 {
692 PNS::MEANDER_SETTINGS settings;
693
694 if( entry.contains( "min_amplitude" ) )
695 settings.m_minAmplitude = pcbIUScale.mmToIU( entry["min_amplitude"].get<double>() );
696
697 if( entry.contains( "max_amplitude" ) )
698 settings.m_maxAmplitude = pcbIUScale.mmToIU( entry["max_amplitude"].get<double>() );
699
700 if( entry.contains( "spacing" ) )
701 settings.m_spacing = pcbIUScale.mmToIU( entry["spacing"].get<double>() );
702
703 if( entry.contains( "corner_style" ) )
704 {
705 settings.m_cornerStyle = entry["corner_style"] == 0 ? PNS::MEANDER_STYLE_CHAMFER
707 }
708
709 if( entry.contains( "corner_radius_percentage" ) )
710 settings.m_cornerRadiusPercentage = entry["corner_radius_percentage"].get<int>();
711
712 if( entry.contains( "single_sided" ) )
713 settings.m_singleSided = entry["single_sided"].get<bool>();
714
715 return settings;
716 };
717
718 if( aObj.contains( "single_track_defaults" ) )
719 m_SingleTrackMeanderSettings = read_settings( aObj["single_track_defaults"] );
720
721 if( aObj.contains( "diff_pair_defaults" ) )
722 m_DiffPairMeanderSettings = read_settings( aObj["diff_pair_defaults"] );
723
724 if( aObj.contains( "diff_pair_skew_defaults" ) )
725 m_SkewMeanderSettings = read_settings( aObj["diff_pair_skew_defaults"] );
726 },
727 {} ) );
728
729 int minTextSize = pcbIUScale.mmToIU( TEXT_MIN_SIZE_MM );
730 int maxTextSize = pcbIUScale.mmToIU( TEXT_MAX_SIZE_MM );
731 int minStroke = 1;
732 int maxStroke = pcbIUScale.mmToIU( 100 );
733
734 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_line_width",
736 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
737
738 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_v",
740 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
741
742 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_h",
744 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
745
746 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_thickness",
748 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
749
750 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_italic",
751 &m_TextItalic[LAYER_CLASS_SILK], false ) );
752
753 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_upright",
754 &m_TextUpright[ LAYER_CLASS_SILK ], true ) );
755
756 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_line_width",
758 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
759
760 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_v",
762 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
763
764 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_h",
766 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
767
768 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_thickness",
770 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
771
772 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_italic",
773 &m_TextItalic[LAYER_CLASS_COPPER], false ) );
774
775 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_upright",
777
778 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.board_outline_line_width",
780 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
781
782 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.courtyard_line_width",
784 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
785
786 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_line_width",
788 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
789
790 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_v",
792 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
793
794 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_h",
796 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
797
798 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_thickness",
800 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
801
802 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_italic",
803 &m_TextItalic[LAYER_CLASS_FAB], false ) );
804
805 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_upright",
806 &m_TextUpright[LAYER_CLASS_FAB], true ) );
807
808 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_line_width",
810 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
811
812 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_v",
814 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
815
816 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_h",
818 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
819
820 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_thickness",
822 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
823
824 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_italic",
825 &m_TextItalic[LAYER_CLASS_OTHERS], false ) );
826
827 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_upright",
829
830 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_MODE>( "defaults.dimension_units",
833
834 m_params.emplace_back( new PARAM_ENUM<DIM_PRECISION>( "defaults.dimension_precision",
836
837 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_FORMAT>( "defaults.dimensions.units_format",
840
841 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.suppress_zeroes",
842 &m_DimensionSuppressZeroes, true ) );
843
844 // NOTE: excluding DIM_TEXT_POSITION::MANUAL from the valid range here
845 m_params.emplace_back( new PARAM_ENUM<DIM_TEXT_POSITION>( "defaults.dimensions.text_position",
848
849 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.keep_text_aligned",
851
852 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.arrow_length",
855
856 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.extension_offset",
859
860 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_fields",
861 &m_StyleFPFields, false ) );
862 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_text",
863 &m_StyleFPText, false ) );
864 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_shapes",
865 &m_StyleFPShapes, false ) );
866 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_dimensions",
867 &m_StyleFPDimensions, false ) );
868 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_barcodes",
869 &m_StyleFPBarcodes, false ) );
870
871 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.zones.min_clearance",
872 &m_defaultZoneSettings.m_ZoneClearance, pcbIUScale.mmToIU( ZONE_CLEARANCE_MM ),
873 pcbIUScale.mmToIU( 0.0 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
874
875 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "defaults.pads",
876 [&]() -> nlohmann::json
877 {
878 nlohmann::json ret =
879 {
880 { "width", pcbIUScale.IUTomm( m_Pad_Master->GetSize( PADSTACK::ALL_LAYERS ).x ) },
881 { "height", pcbIUScale.IUTomm( m_Pad_Master->GetSize( PADSTACK::ALL_LAYERS ).y ) },
882 { "drill", pcbIUScale.IUTomm( m_Pad_Master->GetDrillSize().x ) }
883 };
884
885 return ret;
886 },
887 [&]( const nlohmann::json& aJson )
888 {
889 if( aJson.contains( "width" ) && aJson.contains( "height" )
890 && aJson.contains( "drill" ) )
891 {
892 VECTOR2I sz;
893 sz.x = pcbIUScale.mmToIU( aJson["width"].get<double>() );
894 sz.y = pcbIUScale.mmToIU( aJson["height"].get<double>() );
895
896 m_Pad_Master->SetSize( PADSTACK::ALL_LAYERS, sz );
897
898 int drill = pcbIUScale.mmToIU( aJson["drill"].get<double>() );
899
900 m_Pad_Master->SetDrillSize( VECTOR2I( drill, drill ) );
901 }
902 }, {} ) );
903
904 m_params.emplace_back( new PARAM_SCALED<int>( "rules.max_error",
906 pcbIUScale.mmToIU( 0.0001 ), pcbIUScale.mmToIU( 1.0 ), pcbIUScale.MM_PER_IU ) );
907
908 m_params.emplace_back( new PARAM_SCALED<int>( "rules.solder_mask_to_copper_clearance",
910 pcbIUScale.mmToIU( 0.0 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
911
912 m_params.emplace_back( new PARAM<bool>( "zones_allow_external_fillets",
913 &m_ZoneKeepExternalFillets, false ) );
914
916
917 registerMigration( 1, 2,
918 [&]() -> bool
919 {
920 // Schema 1 to 2: move mask and paste margin settings back to board.
921 // The parameters are removed, so we just have to manually load them here and
922 // they will get saved with the board
923 if( std::optional<double> optval = Get<double>( "rules.solder_mask_clearance" ) )
924 m_SolderMaskExpansion = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
925
926 if( std::optional<double> optval = Get<double>( "rules.solder_mask_min_width" ) )
927 m_SolderMaskMinWidth = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
928
929 if( std::optional<double> optval = Get<double>( "rules.solder_paste_clearance" ) )
930 m_SolderPasteMargin = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
931
932 if( std::optional<double> optval = Get<double>( "rules.solder_paste_margin_ratio" ) )
933 m_SolderPasteMarginRatio = *optval;
934
935 try
936 {
937 At( "rules" ).erase( "solder_mask_clearance" );
938 At( "rules" ).erase( "solder_mask_min_width" );
939 At( "rules" ).erase( "solder_paste_clearance" );
940 At( "rules" ).erase( "solder_paste_margin_ratio" );
941 }
942 catch( ... )
943 {}
944
945 return true;
946 } );
947}
948
949
951{
952 if( m_parent )
953 {
954 m_parent->ReleaseNestedSettings( this );
955 m_parent = nullptr;
956 }
957}
958
959
961 NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aOther.m_parent,
962 aOther.m_path ),
963 m_Pad_Master( nullptr )
964{
965 initFromOther( aOther );
966}
967
968
970{
971 initFromOther( aOther );
972 return *this;
973}
974
975
977{
978 // Copy of NESTED_SETTINGS around is not allowed, so let's just update the params.
987 m_MinConn = aOther.m_MinConn;
1005 m_MaxError = aOther.m_MaxError;
1018 m_CapVias = aOther.m_CapVias;
1019 m_FillVias = aOther.m_FillVias;
1022
1023 std::copy( std::begin( aOther.m_LineThickness ), std::end( aOther.m_LineThickness ),
1024 std::begin( m_LineThickness ) );
1025
1026 std::copy( std::begin( aOther.m_TextSize ), std::end( aOther.m_TextSize ),
1027 std::begin( m_TextSize ) );
1028
1029 std::copy( std::begin( aOther.m_TextThickness ), std::end( aOther.m_TextThickness ),
1030 std::begin( m_TextThickness ) );
1031
1032 std::copy( std::begin( aOther.m_TextItalic ), std::end( aOther.m_TextItalic ),
1033 std::begin( m_TextItalic ) );
1034
1035 std::copy( std::begin( aOther.m_TextUpright ), std::end( aOther.m_TextUpright ),
1036 std::begin( m_TextUpright ) );
1037
1046
1047 m_auxOrigin = aOther.m_auxOrigin;
1048 m_gridOrigin = aOther.m_gridOrigin;
1049 m_HasStackup = aOther.m_HasStackup;
1051
1065 m_stackup = aOther.m_stackup;
1067 m_Pad_Master = std::make_unique<PAD>( *aOther.m_Pad_Master );
1069
1075}
1076
1077
1079{
1080 if( m_TrackWidthList != aOther.m_TrackWidthList ) return false;
1081 if( m_ViasDimensionsList != aOther.m_ViasDimensionsList ) return false;
1082 if( m_DiffPairDimensionsList != aOther.m_DiffPairDimensionsList ) return false;
1083 if( m_CurrentViaType != aOther.m_CurrentViaType ) return false;
1084 if( m_UseConnectedTrackWidth != aOther.m_UseConnectedTrackWidth ) return false;
1085 if( m_TempOverrideTrackWidth != aOther.m_TempOverrideTrackWidth ) return false;
1086 if( m_MinClearance != aOther.m_MinClearance ) return false;
1087 if( m_MinGrooveWidth != aOther.m_MinGrooveWidth ) return false;
1088 if( m_MinConn != aOther.m_MinConn ) return false;
1089 if( m_TrackMinWidth != aOther.m_TrackMinWidth ) return false;
1090 if( m_ViasMinAnnularWidth != aOther.m_ViasMinAnnularWidth ) return false;
1091 if( m_ViasMinSize != aOther.m_ViasMinSize ) return false;
1092 if( m_MinThroughDrill != aOther.m_MinThroughDrill ) return false;
1093 if( m_MicroViasMinSize != aOther.m_MicroViasMinSize ) return false;
1094 if( m_MicroViasMinDrill != aOther.m_MicroViasMinDrill ) return false;
1095 if( m_CopperEdgeClearance != aOther.m_CopperEdgeClearance ) return false;
1096 if( m_HoleClearance != aOther.m_HoleClearance ) return false;
1097 if( m_HoleToHoleMin != aOther.m_HoleToHoleMin ) return false;
1098 if( m_SilkClearance != aOther.m_SilkClearance ) return false;
1099 if( m_MinResolvedSpokes != aOther.m_MinResolvedSpokes ) return false;
1100 if( m_MinSilkTextHeight != aOther.m_MinSilkTextHeight ) return false;
1101 if( m_MinSilkTextThickness != aOther.m_MinSilkTextThickness ) return false;
1102 if( m_DRCSeverities != aOther.m_DRCSeverities ) return false;
1103 if( m_DrcExclusions != aOther.m_DrcExclusions ) return false;
1104 if( m_DrcExclusionComments != aOther.m_DrcExclusionComments ) return false;
1105 if( m_ZoneKeepExternalFillets != aOther.m_ZoneKeepExternalFillets ) return false;
1106 if( m_MaxError != aOther.m_MaxError ) return false;
1107 if( m_SolderMaskExpansion != aOther.m_SolderMaskExpansion ) return false;
1108 if( m_SolderMaskMinWidth != aOther.m_SolderMaskMinWidth ) return false;
1110 if( m_SolderPasteMargin != aOther.m_SolderPasteMargin ) return false;
1111 if( m_SolderPasteMarginRatio != aOther.m_SolderPasteMarginRatio ) return false;
1113 if( m_TentViasFront != aOther.m_TentViasFront ) return false;
1114 if( m_TentViasBack != aOther.m_TentViasBack ) return false;
1115 if( m_CoverViasFront != aOther.m_CoverViasFront ) return false;
1116 if( m_CoverViasBack != aOther.m_CoverViasBack ) return false;
1117 if( m_PlugViasFront != aOther.m_PlugViasFront ) return false;
1118 if( m_PlugViasBack != aOther.m_PlugViasBack ) return false;
1119 if( m_CapVias != aOther.m_CapVias ) return false;
1120 if( m_FillVias != aOther.m_FillVias ) return false;
1121 if( m_DefaultFPTextItems != aOther.m_DefaultFPTextItems ) return false;
1122 if( m_UserLayerNames != aOther.m_UserLayerNames ) return false;
1123
1124 if( !std::equal( std::begin( m_LineThickness ), std::end( m_LineThickness ),
1125 std::begin( aOther.m_LineThickness ) ) )
1126 return false;
1127
1128 if( !std::equal( std::begin( m_TextSize ), std::end( m_TextSize ),
1129 std::begin( aOther.m_TextSize ) ) )
1130 return false;
1131
1132 if( !std::equal( std::begin( m_TextThickness ), std::end( m_TextThickness ),
1133 std::begin( aOther.m_TextThickness ) ) )
1134 return false;
1135
1136 if( !std::equal( std::begin( m_TextItalic ), std::end( m_TextItalic ),
1137 std::begin( aOther.m_TextItalic ) ) )
1138 return false;
1139
1140 if( !std::equal( std::begin( m_TextUpright ), std::end( m_TextUpright ),
1141 std::begin( aOther.m_TextUpright ) ) )
1142 return false;
1143
1144 if( m_DimensionUnitsMode != aOther.m_DimensionUnitsMode ) return false;
1145 if( m_DimensionPrecision != aOther.m_DimensionPrecision ) return false;
1146 if( m_DimensionUnitsFormat != aOther.m_DimensionUnitsFormat ) return false;
1147 if( m_DimensionSuppressZeroes != aOther.m_DimensionSuppressZeroes ) return false;
1148 if( m_DimensionTextPosition != aOther.m_DimensionTextPosition ) return false;
1149 if( m_DimensionKeepTextAligned != aOther.m_DimensionKeepTextAligned ) return false;
1150 if( m_DimensionArrowLength != aOther.m_DimensionArrowLength ) return false;
1151 if( m_DimensionExtensionOffset != aOther.m_DimensionExtensionOffset ) return false;
1152 if( m_auxOrigin != aOther.m_auxOrigin ) return false;
1153 if( m_gridOrigin != aOther.m_gridOrigin ) return false;
1154 if( m_HasStackup != aOther.m_HasStackup ) return false;
1155 if( m_UseHeightForLengthCalcs != aOther.m_UseHeightForLengthCalcs ) return false;
1156 if( m_trackWidthIndex != aOther.m_trackWidthIndex ) return false;
1157 if( m_viaSizeIndex != aOther.m_viaSizeIndex ) return false;
1158 if( m_diffPairIndex != aOther.m_diffPairIndex ) return false;
1159 if( m_useCustomTrackVia != aOther.m_useCustomTrackVia ) return false;
1160 if( m_customTrackWidth != aOther.m_customTrackWidth ) return false;
1161 if( m_customViaSize != aOther.m_customViaSize ) return false;
1162 if( m_useCustomDiffPair != aOther.m_useCustomDiffPair ) return false;
1163 if( m_customDiffPair != aOther.m_customDiffPair ) return false;
1164 if( m_copperLayerCount != aOther.m_copperLayerCount ) return false;
1165 if( m_userDefinedLayerCount != aOther.m_userDefinedLayerCount ) return false;
1166 if( m_enabledLayers != aOther.m_enabledLayers ) return false;
1167 if( m_boardThickness != aOther.m_boardThickness ) return false;
1168 if( m_currentNetClassName != aOther.m_currentNetClassName ) return false;
1169 if( m_stackup != aOther.m_stackup ) return false;
1170 if( *m_NetSettings != *aOther.m_NetSettings ) return false;
1171 if( *m_Pad_Master != *aOther.m_Pad_Master ) return false;
1172 if( m_defaultZoneSettings != aOther.m_defaultZoneSettings ) return false;
1173
1174 if( m_StyleFPFields != aOther.m_StyleFPFields ) return false;
1175 if( m_StyleFPText != aOther.m_StyleFPText ) return false;
1176 if( m_StyleFPShapes != aOther.m_StyleFPShapes ) return false;
1177 if( m_StyleFPDimensions != aOther.m_StyleFPDimensions ) return false;
1178 if( m_StyleFPBarcodes != aOther.m_StyleFPBarcodes ) return false;
1179
1180 return true;
1181}
1182
1183
1185{
1203 std::string units_ptr( "defaults.dimension_units" );
1204 std::string precision_ptr( "defaults.dimension_precision" );
1205
1206 if( !( Contains( units_ptr )
1207 && Contains( precision_ptr )
1208 && At( units_ptr ).is_number_integer()
1209 && At( precision_ptr ).is_number_integer() ) )
1210 {
1211 // if either is missing or invalid, migration doesn't make sense
1212 return true;
1213 }
1214
1215 int units = *Get<int>( units_ptr );
1216 int precision = *Get<int>( precision_ptr );
1217
1218 // The enum maps directly to precision if the units is mils
1219 int extraDigits = 0;
1220
1221 switch( units )
1222 {
1223 case 0: extraDigits = 3; break;
1224 case 2: extraDigits = 2; break;
1225 default: break;
1226 }
1227
1228 precision += extraDigits;
1229
1230 Set( precision_ptr, precision );
1231
1232 return true;
1233}
1234
1235
1236bool BOARD_DESIGN_SETTINGS::LoadFromFile( const wxString& aDirectory )
1237{
1238 bool ret = NESTED_SETTINGS::LoadFromFile( aDirectory );
1239
1240 // A number of things won't have been translated by the PROJECT_FILE migration because of
1241 // descoped objects required to decode this data. So, it will be in the legacy.pcbnew
1242 // section and needs to be pulled out here
1243
1244 PROJECT_FILE* project = dynamic_cast<PROJECT_FILE*>( GetParent() );
1245
1246 if( !project )
1247 return ret;
1248
1249 bool migrated = false;
1250
1251 auto drcName =
1252 []( int aCode ) -> std::string
1253 {
1254 return std::string( DRC_ITEM::Create( aCode )->GetSettingsKey().ToUTF8() );
1255 };
1256
1257 const std::string rs = "rule_severities.";
1258 const std::string no_courtyard_key = "legacy_no_courtyard_defined";
1259 const std::string courtyard_overlap_key = "legacy_courtyards_overlap";
1260
1261 try
1262 {
1263 nlohmann::json& severities =
1264 project->Internals()->at( "/board/design_settings/rule_severities"_json_pointer );
1265
1266 if( severities.contains( no_courtyard_key ) )
1267 {
1268 if( severities[no_courtyard_key].get<bool>() )
1269 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "error" );
1270 else
1271 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "ignore" );
1272
1273 severities.erase( no_courtyard_key );
1274 migrated = true;
1275 }
1276
1277 if( severities.contains( courtyard_overlap_key ) )
1278 {
1279 if( severities[courtyard_overlap_key].get<bool>() )
1280 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "error" );
1281 else
1282 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "ignore" );
1283
1284 severities.erase( courtyard_overlap_key );
1285 migrated = true;
1286 }
1287 }
1288 catch( ... )
1289 {
1290 }
1291
1292 if( Contains( "legacy" ) )
1293 {
1294 // This defaults to false for new boards, but version 5.1.x and prior kept the fillets
1295 // so we do the same for legacy boards.
1297
1298 project->At( "legacy" ).erase( "pcbnew" );
1299 }
1300
1301 // Now that we have everything, we need to load again
1302 if( migrated )
1303 Load();
1304
1305 return ret;
1306}
1307
1308
1310{
1311 return m_DRCSeverities[ aDRCErrorCode ];
1312}
1313
1314
1315bool BOARD_DESIGN_SETTINGS::Ignore( int aDRCErrorCode )
1316{
1317 return m_DRCSeverities[ aDRCErrorCode ] == RPT_SEVERITY_IGNORE;
1318}
1319
1320
1322{
1323 int biggest = std::max( m_MinClearance, m_HoleClearance );
1324 DRC_CONSTRAINT constraint;
1325
1326 biggest = std::max( biggest, m_HoleToHoleMin );
1327 biggest = std::max( biggest, m_CopperEdgeClearance );
1328
1329 if( m_DRCEngine )
1330 {
1331 m_DRCEngine->QueryWorstConstraint( CLEARANCE_CONSTRAINT, constraint );
1332 biggest = std::max( biggest, constraint.Value().Min() );
1333
1334 m_DRCEngine->QueryWorstConstraint( PHYSICAL_CLEARANCE_CONSTRAINT, constraint );
1335 biggest = std::max( biggest, constraint.Value().Min() );
1336
1337 m_DRCEngine->QueryWorstConstraint( HOLE_CLEARANCE_CONSTRAINT, constraint );
1338 biggest = std::max( biggest, constraint.Value().Min() );
1339
1340 m_DRCEngine->QueryWorstConstraint( EDGE_CLEARANCE_CONSTRAINT, constraint );
1341 biggest = std::max( biggest, constraint.Value().Min() );
1342
1343 m_DRCEngine->QueryWorstConstraint( HOLE_TO_HOLE_CONSTRAINT, constraint );
1344 biggest = std::max( biggest, constraint.Value().Min() );
1345 }
1346
1347 // Clip to avoid integer overflows in subsequent calculations
1348 return std::min( biggest, MAXIMUM_CLEARANCE );
1349}
1350
1351
1353{
1354 int clearance = m_NetSettings->GetDefaultNetclass()->GetClearance();
1355
1356 for( const auto& [name, netclass] : m_NetSettings->GetNetclasses() )
1357 clearance = std::min( clearance, netclass->GetClearance() );
1358
1359 return clearance;
1360}
1361
1362
1364{
1365 m_viaSizeIndex = std::min( aIndex, (int) m_ViasDimensionsList.size() - 1 );
1366 m_useCustomTrackVia = false;
1367}
1368
1369
1371{
1373 return m_customViaSize.m_Diameter;
1375 return m_NetSettings->GetDefaultNetclass()->GetViaDiameter();
1376 else
1377 return m_ViasDimensionsList[ m_viaSizeIndex ].m_Diameter;
1378}
1379
1380
1382{
1383 int drill;
1384
1386 drill = m_customViaSize.m_Drill;
1388 drill = m_NetSettings->GetDefaultNetclass()->GetViaDrill();
1389 else
1390 drill = m_ViasDimensionsList[ m_viaSizeIndex ].m_Drill;
1391
1392 return drill > 0 ? drill : -1;
1393}
1394
1395
1397{
1398 m_trackWidthIndex = std::min( aIndex, (int) m_TrackWidthList.size() - 1 );
1399 m_useCustomTrackVia = false;
1400}
1401
1402
1404{
1406 return m_customTrackWidth;
1408 return m_NetSettings->GetDefaultNetclass()->GetTrackWidth();
1409 else
1411}
1412
1413
1415{
1416 if( !m_DiffPairDimensionsList.empty() )
1417 m_diffPairIndex = std::min( aIndex, (int) m_DiffPairDimensionsList.size() - 1 );
1418
1419 m_useCustomDiffPair = false;
1420}
1421
1422
1424{
1426 {
1427 return m_customDiffPair.m_Width;
1428 }
1430 {
1431 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairWidth() )
1432 return m_NetSettings->GetDefaultNetclass()->GetDiffPairWidth();
1433 else
1434 return m_NetSettings->GetDefaultNetclass()->GetTrackWidth();
1435 }
1436 else
1437 {
1439 }
1440}
1441
1442
1444{
1446 {
1447 return m_customDiffPair.m_Gap;
1448 }
1450 {
1451 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairGap() )
1452 return m_NetSettings->GetDefaultNetclass()->GetDiffPairGap();
1453 else
1454 return m_NetSettings->GetDefaultNetclass()->GetClearance();
1455 }
1456 else
1457 {
1459 }
1460}
1461
1462
1464{
1466 {
1467 return m_customDiffPair.m_ViaGap;
1468 }
1470 {
1471 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairViaGap() )
1472 return m_NetSettings->GetDefaultNetclass()->GetDiffPairViaGap();
1473 else
1474 return GetCurrentDiffPairGap();
1475 }
1476 else
1477 {
1479 }
1480}
1481
1482
1484{
1485 m_copperLayerCount = aNewLayerCount;
1486
1487 // Update only enabled copper layers mask
1488 m_enabledLayers.ClearCopperLayers();
1489
1490 if( aNewLayerCount > 0 )
1491 m_enabledLayers |= LSET::AllCuMask( aNewLayerCount );
1492}
1493
1494
1496{
1497 m_userDefinedLayerCount = aNewLayerCount;
1498
1499 m_enabledLayers.ClearUserDefinedLayers();
1500
1501 if( aNewLayerCount > 0 )
1502 m_enabledLayers |= LSET::UserDefinedLayersMask( aNewLayerCount );
1503}
1504
1505
1507{
1508 m_enabledLayers = aMask;
1509
1510 // Ensures mandatory back and front layers are always enabled regardless of board file
1511 // configuration.
1512 m_enabledLayers.set( B_Cu ).set( F_Cu )
1513 .set( B_CrtYd ).set( F_CrtYd )
1514 .set( Edge_Cuts )
1515 .set( Margin );
1516
1517 // update layer counts to ensure their consistency with m_EnabledLayers
1518 LSET copperLayers = aMask;
1519 copperLayers.ClearNonCopperLayers();
1520
1521 LSET userLayers = aMask & LSET::UserDefinedLayersMask();
1522
1523 m_copperLayerCount = (int) copperLayers.count();
1524 m_userDefinedLayerCount = (int) userLayers.count();
1525}
1526
1527
1528// Return the layer class index { silk, copper, edges & courtyards, fab, others } of the
1529// given layer.
1531{
1532 if( aLayer == F_SilkS || aLayer == B_SilkS )
1533 return LAYER_CLASS_SILK;
1534 else if( IsCopperLayer( aLayer ) )
1535 return LAYER_CLASS_COPPER;
1536 else if( aLayer == Edge_Cuts )
1537 return LAYER_CLASS_EDGES;
1538 else if( aLayer == F_CrtYd || aLayer == B_CrtYd )
1539 return LAYER_CLASS_COURTYARD;
1540 else if( aLayer == F_Fab || aLayer == B_Fab )
1541 return LAYER_CLASS_FAB;
1542 else
1543 return LAYER_CLASS_OTHERS;
1544}
1545
1546
1548{
1549 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_DRCEpsilon );
1550}
1551
1552
1554{
1555 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_HoleWallThickness );
1556}
1557
1558
1560{
1561 return m_LineThickness[ GetLayerClass( aLayer ) ];
1562}
1563
1564
1566{
1567 return m_TextSize[ GetLayerClass( aLayer ) ];
1568}
1569
1570
1572{
1573 return m_TextThickness[ GetLayerClass( aLayer ) ];
1574}
1575
1576
1578{
1579 return m_TextItalic[ GetLayerClass( aLayer ) ];
1580}
1581
1582
1584{
1585 return m_TextUpright[ GetLayerClass( aLayer ) ];
1586}
1587
1589{
1590 m_Pad_Master->SetSizeX( pcbIUScale.mmToIU( DEFAULT_PAD_WIDTH_MM ) );
1591 m_Pad_Master->SetSizeY( pcbIUScale.mmToIU( DEFAULT_PAD_HEIGTH_MM ) );
1592 m_Pad_Master->SetDrillShape( PAD_DRILL_SHAPE::CIRCLE );
1593 m_Pad_Master->SetDrillSize( VECTOR2I( pcbIUScale.mmToIU( DEFAULT_PAD_DRILL_DIAMETER_MM ), 0 ) );
1595
1596 constexpr double RR_RADIUS = DEFAULT_PAD_HEIGTH_MM * DEFAULT_PAD_RR_RADIUS_RATIO;
1597 m_Pad_Master->SetRoundRectCornerRadius( PADSTACK::ALL_LAYERS, pcbIUScale.mmToIU( RR_RADIUS ) );
1598
1599 if( m_Pad_Master->GetFrontShape() == PAD_SHAPE::CIRCLE )
1600 m_Pad_Master->SetThermalSpokeAngle( ANGLE_45 );
1601 else
1602 m_Pad_Master->SetThermalSpokeAngle( ANGLE_90 );
1603}
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:188
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition drc_item.h:141
static std::shared_ptr< DRC_ITEM > Create(int aErrorCode)
Constructs a DRC_ITEM for the given error code.
Definition drc_item.cpp:400
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:951
static LSET UserDefinedLayersMask(int aUserDefinedLayerCount=MAX_USER_DEFINED_LAYERS)
Return a mask with the requested number of user defined layers.
Definition lset.cpp:704
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:608
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:177
Stores an enum as an integer.
Definition parameters.h:230
Like a normal param, but with custom getter and setter functions.
Definition parameters.h:297
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition parameters.h:394
Dimensions for the meandering algorithm.
Definition pns_meander.h:70
int m_minAmplitude
Maximum meandering amplitude.
Definition pns_meander.h:95
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:98
int m_spacing
Amplitude/spacing adjustment step.
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:81
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_TUNING_PROFILE_IMPLICIT_RULES
Definition drc_item.h:114
@ 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_SCHEMATIC_FIELDS_PARITY
Definition drc_item.h:118
@ 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:101
@ DRCE_DRILLED_HOLES_COLOCATED
Definition drc_item.h:54
@ DRCE_EXTRA_FOOTPRINT
Definition drc_item.h:77
@ DRCE_SILK_CLEARANCE
Definition drc_item.h:100
@ DRCE_LAST
Definition drc_item.h:120
@ 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:102
@ 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:54
@ MEANDER_STYLE_CHAMFER
Definition pns_meander.h:55
@ 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:36