52#include <google/protobuf/any.pb.h>
56#include <api/board/board_types.pb.h>
78 *
this = *
static_cast<const PCB_TRACK*
>( aOther );
100 *
this = *
static_cast<const PCB_ARC*
>( aOther );
157 *
this = *
static_cast<const PCB_VIA*
>( aOther );
176 default: formatStr =
_(
"Via %s on %s" );
break;
196 return *
this == other;
218 double similarity = 1.0;
249 return *
this == other;
260 return *
this == other;
283 double similarity = 1.0;
317 return *
this == other;
328 return *
this == other;
350 double similarity = 1.0;
389 m_padStack.SetSize( { aWidth, aWidth }, aLayer );
401 kiapi::board::types::Track track;
403 track.mutable_id()->set_value(
m_Uuid.AsStdString() );
404 track.mutable_start()->set_x_nm(
GetStart().x );
405 track.mutable_start()->set_y_nm(
GetStart().y );
406 track.mutable_end()->set_x_nm(
GetEnd().x );
407 track.mutable_end()->set_y_nm(
GetEnd().y );
408 track.mutable_width()->set_value_nm(
GetWidth() );
410 track.set_locked(
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
411 : kiapi::common::types::LockedState::LS_UNLOCKED );
412 PackNet( track.mutable_net() );
415 aContainer.PackFrom( track );
421 kiapi::board::types::Track track;
423 if( !aContainer.UnpackTo( &track ) )
429 SetWidth( track.width().value_nm() );
432 SetLocked( track.locked() == kiapi::common::types::LockedState::LS_LOCKED );
441 kiapi::board::types::Arc arc;
443 arc.mutable_id()->set_value(
m_Uuid.AsStdString() );
444 arc.mutable_start()->set_x_nm(
GetStart().x );
445 arc.mutable_start()->set_y_nm(
GetStart().y );
446 arc.mutable_mid()->set_x_nm(
GetMid().x );
447 arc.mutable_mid()->set_y_nm(
GetMid().y );
448 arc.mutable_end()->set_x_nm(
GetEnd().x );
449 arc.mutable_end()->set_y_nm(
GetEnd().y );
450 arc.mutable_width()->set_value_nm(
GetWidth() );
452 arc.set_locked(
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
453 : kiapi::common::types::LockedState::LS_UNLOCKED );
457 aContainer.PackFrom( arc );
463 kiapi::board::types::Arc arc;
465 if( !aContainer.UnpackTo( &arc ) )
475 SetLocked( arc.locked() == kiapi::common::types::LockedState::LS_LOCKED );
484 kiapi::board::types::Via
via;
486 via.mutable_id()->set_value(
m_Uuid.AsStdString() );
492 google::protobuf::Any padStackWrapper;
494 padStackWrapper.UnpackTo(
via.mutable_pad_stack() );
497 via.mutable_pad_stack()->clear_layers();
501 via.set_locked(
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
502 : kiapi::common::types::LockedState::LS_UNLOCKED );
505 aContainer.PackFrom(
via );
511 kiapi::board::types::Via
via;
513 if( !aContainer.UnpackTo( &
via ) )
520 google::protobuf::Any padStackWrapper;
521 padStackWrapper.PackFrom(
via.pad_stack() );
523 if( !
m_padStack.Deserialize( padStackWrapper ) )
531 SetLocked(
via.locked() == kiapi::common::types::LockedState::LS_LOCKED );
557 *aSource = constraint.
GetName();
559 return constraint.
Value();
575 *aSource = constraint.
GetName();
577 return constraint.
Value();
593 *aSource = constraint.
GetName();
595 return constraint.
Value();
604 *aSource =
_(
"removed annular ring" );
621 *aSource = constraint.
GetName();
719 if( aDrill.has_value() && *aDrill > 0 )
767 if( aDrill.has_value() && *aDrill > 0 )
859 int pmDepth = frontPM.
depth;
863 && frontPM.
angle > 0 )
865 double halfAngleRad = ( frontPM.
angle / 10.0 ) *
M_PI / 180.0 / 2.0;
866 pmDepth =
static_cast<int>( ( frontPM.
size / 2.0 ) / tan( halfAngleRad ) );
874 if( layerDist < pmDepth )
879 double halfAngleRad = ( frontPM.
angle / 10.0 ) *
M_PI / 180.0 / 2.0;
880 int diameterAtLayer = frontPM.
size -
static_cast<int>( 2.0 * layerDist * tan( halfAngleRad ) );
881 return std::max( 0, diameterAtLayer );
898 int pmDepth = backPM.
depth;
902 && backPM.
angle > 0 )
904 double halfAngleRad = ( backPM.
angle / 10.0 ) *
M_PI / 180.0 / 2.0;
905 pmDepth =
static_cast<int>( ( backPM.
size / 2.0 ) / tan( halfAngleRad ) );
913 if( layerDist < pmDepth )
918 double halfAngleRad = ( backPM.
angle / 10.0 ) *
M_PI / 180.0 / 2.0;
919 int diameterAtLayer = backPM.
size -
static_cast<int>( 2.0 * layerDist * tan( halfAngleRad ) );
920 return std::max( 0, diameterAtLayer );
952 double dist =
m_Start.Distance( point );
954 if( min_dist >= dist )
957 dist =
m_End.Distance( point );
959 if( min_dist >= dist )
971 int ymax, xmax, ymin, xmin;
984 BOX2I bbox = arc->BBox();
1008 VECTOR2L( (int64_t) xmax - xmin + 1, (int64_t) ymax - ymin + 1 ) );
1033 VECTOR2L( (int64_t) xmax - xmin + 1, (int64_t) ymax - ymin + 1 ) );
1052 VECTOR2L( (int64_t) xmax - xmin + 1, (int64_t) ymax - ymin + 1 ) );
1072 .MergeTracks =
false,
1073 .OptimiseTracesInPads =
false,
1074 .InferViaInPad =
false
1153 return start_end.
Cross( start_mid ) < 0;
1183 const std::vector<KICAD_T>& aScanTypes )
1185 for(
KICAD_T scanType : aScanTypes )
1187 if( scanType ==
Type() )
1217 if(
m_padStack.FrontOuterLayers().has_solder_mask.has_value() )
1240 if(
m_padStack.BackOuterLayers().has_solder_mask.has_value() )
1263 if(
m_padStack.FrontOuterLayers().has_covering.has_value() )
1286 if(
m_padStack.BackOuterLayers().has_covering.has_value() )
1309 if(
m_padStack.FrontOuterLayers().has_plugging.has_value() )
1332 if(
m_padStack.BackOuterLayers().has_plugging.has_value() )
1355 if(
m_padStack.Drill().is_capped.has_value() )
1378 if(
m_padStack.Drill().is_filled.has_value() )
1391 "Invalid layer passed to IsTented" );
1395 if( front &&
m_padStack.FrontOuterLayers().has_solder_mask.has_value() )
1396 return *
m_padStack.FrontOuterLayers().has_solder_mask;
1398 if( !front &&
m_padStack.BackOuterLayers().has_solder_mask.has_value() )
1399 return *
m_padStack.BackOuterLayers().has_solder_mask;
1403 return front ? board->GetDesignSettings().m_TentViasFront
1404 : board->GetDesignSettings().m_TentViasBack;
1414 return board->GetDesignSettings().m_SolderMaskExpansion;
1425 &&
GetBoard()->GetDesignSettings().m_DRCEngine->HasRulesForConstraintType(
1442 margin = board->GetDesignSettings().m_SolderMaskExpansion;
1447 margin = std::max( margin, -
m_width / 2 );
1486 else if( aLayer ==
B_Mask )
1498 int layer_id = aCopperLayerCount*2;
1502 if(
Padstack().Drill().start > layer_id )
1546 if( layermask.test(
F_Cu ) )
1548 else if( layermask.test(
B_Cu ) )
1575 layermask.
set(
id );
1606 bool top_found =
false;
1607 bool bottom_found =
false;
1617 if( !top_found && layer !=
B_Cu )
1628 bottom_found =
true;
1643 board->InvalidateClearanceCache(
m_Uuid );
1660 board->InvalidateClearanceCache(
m_Uuid );
1668 if( aLayer ==
Padstack().Drill().start )
1677 board->InvalidateClearanceCache(
m_Uuid );
1693 std::swap( b_layer, t_layer );
1697 *top_layer = t_layer;
1700 *bottom_layer = b_layer;
1729 auto sanitizeBackdrill =
1738 if( copperCount > 0 )
1756 aDrill.size = { 0, 0 };
1759 sanitizeBackdrill(
Padstack().SecondaryDrill() );
1760 sanitizeBackdrill(
Padstack().TertiaryDrill() );
1764std::optional<PCB_VIA::VIA_PARAMETER_ERROR>
1766 std::optional<int> aPrimaryDrill,
1767 std::optional<PCB_LAYER_ID> aPrimaryStartLayer,
1768 std::optional<PCB_LAYER_ID> aPrimaryEndLayer,
1769 std::optional<int> aSecondaryDrill,
1770 std::optional<PCB_LAYER_ID> aSecondaryStartLayer,
1771 std::optional<PCB_LAYER_ID> aSecondaryEndLayer,
1772 std::optional<int> aTertiaryDrill,
1773 std::optional<PCB_LAYER_ID> aTertiaryStartLayer,
1774 std::optional<PCB_LAYER_ID> aTertiaryEndLayer,
1775 int aCopperLayerCount )
1781 error.
m_Message =
_(
"Via diameter is too small." );
1788 error.
m_Message =
_(
"Via drill is too small." );
1793 if( aDiameter.has_value() && !aPrimaryDrill.has_value() )
1795 error.
m_Message =
_(
"No via hole size defined." );
1800 if( aPrimaryDrill.has_value() && !aDiameter.has_value() )
1802 error.
m_Message =
_(
"No via diameter defined." );
1807 if( aDiameter.has_value() && aPrimaryDrill.has_value()
1808 && aDiameter.value() <= aPrimaryDrill.value() )
1810 error.
m_Message =
_(
"Via hole size must be smaller than via diameter" );
1815 std::optional<LSET> copperMask;
1817 auto validateLayer = [&]( std::optional<PCB_LAYER_ID> aLayer,
1820 if( !aLayer.has_value() )
1830 error.
m_Message =
_(
"Via layer must be a copper layer." );
1835 if( aCopperLayerCount > 0 )
1837 if( !copperMask.has_value() )
1840 if( !copperMask->Contains( layer ) )
1842 error.
m_Message =
_(
"Via layer is outside the board stack." );
1857 if( aPrimaryStartLayer.has_value() && aPrimaryEndLayer.has_value()
1858 && aPrimaryStartLayer.value() == aPrimaryEndLayer.value() )
1860 error.
m_Message =
_(
"Via start layer and end layer cannot be the same" );
1865 if( aSecondaryDrill.has_value() )
1869 error.
m_Message =
_(
"Backdrill diameter is too small." );
1881 if( aTertiaryDrill.has_value() )
1885 error.
m_Message =
_(
"Tertiary backdrill diameter is too small." );
1897 return std::nullopt;
1916 return startOuter ^ endOuter;
1967 switch(
Padstack().UnconnectedLayerMode() )
2037 bool connected =
false;
2043 else if(
GetBoard()->GetConnectivity()->IsConnectedOnLayer(
this, layer, nonZoneTypes ) )
2064 std::vector<int> layers{
2070 layers.reserve( 6 );
2075 layers.push_back(
F_Mask );
2077 layers.push_back(
B_Mask );
2113 if(
VECTOR2I(
end - start ).SquaredEuclideanNorm() < nameSize * nameSize )
2120 if(
VECTOR2I(
end - start ).SquaredEuclideanNorm() == 0 )
2151 bbox.
Inflate( 2 * board->GetDesignSettings().GetBiggestClearanceValue() );
2171 bool isBlindBuried =
2179 cuMask &= board->GetEnabledLayers();
2196 ret_layers.push_back(
F_Mask );
2199 ret_layers.push_back(
B_Mask );
2221 highContrastLayer =
F_Cu;
2223 highContrastLayer =
B_Cu;
2254 if( !visible.any() )
2262 if( !visible.any() )
2320 default:
return _(
"Track" );
2343 aList.emplace_back(
_(
"Angle" ), wxString::Format(
"%.2fdeg",
2344 static_cast<PCB_ARC*
>(
this)->GetAngle().AsDegrees() ) );
2350 if( segmentDelay == 0.0 )
2356 aList.emplace_back(
_(
"Segment Delay" ),
2364 double trackLen = 0.0;
2365 double lenPadToDie = 0.0;
2366 double trackDelay = 0.0;
2367 double delayPadToDie = 0.0;
2369 std::tie( count, trackLen, lenPadToDie, trackDelay, delayPadToDie ) = board->
GetTrackLength( *
this );
2371 if( trackDelay == 0.0 )
2375 if( lenPadToDie != 0 )
2378 aList.emplace_back(
_(
"Pad To Die Length" ), msg );
2381 aList.emplace_back(
_(
"Full Length" ), msg );
2386 aList.emplace_back(
_(
"Routed Delay" ),
2389 if( delayPadToDie != 0.0 )
2392 aList.emplace_back(
_(
"Pad To Die Delay" ), msg );
2395 aList.emplace_back(
_(
"Full Delay" ), msg );
2402 aList.emplace_back(
_(
"Copper Area" ),
2408 aList.emplace_back( wxString::Format(
_(
"Min Clearance: %s" ),
2410 wxString::Format(
_(
"(from %s)" ), source ) );
2415 if( !msg.IsEmpty() )
2417 aList.emplace_back( wxString::Format(
_(
"Width Constraints: %s" ), msg ),
2418 wxString::Format(
_(
"(from %s)" ), source ) );
2433 default: msg =
_(
"Via" );
break;
2436 aList.emplace_back(
_(
"Type" ), msg );
2449 wxString::Format(
_(
"(from %s)" ), source ) );
2453 aList.emplace_back( wxString::Format(
_(
"Min Annular Width: %s" ), aFrame->
MessageTextFromValue( minAnnulus ) ),
2454 wxString::Format(
_(
"(from %s)" ), source ) );
2464 const wxString& chainName = netInfo->GetNetChain();
2466 if( !chainName.IsEmpty() )
2470 aList.emplace_back(
_(
"Resolved Netclass" ),
2475 aList.emplace_back(
_(
"NetCode" ), fmt::format(
"{}",
GetNetCode() ) );
2477 aList.emplace_back( wxT(
"Flags" ), fmt::format(
"#08X",
m_flags ) );
2479 aList.emplace_back( wxT(
"Start pos" ), fmt::format(
"{} {}",
m_Start.x,
m_Start.y ) );
2480 aList.emplace_back( wxT(
"End pos" ), fmt::format(
"{} {}",
m_End.x,
m_End.y ) );
2484 aList.emplace_back(
_(
"Status" ),
_(
"Locked" ) );
2508 double max_dist = aAccuracy + (
GetWidth() / 2.0 );
2511 if(
GetStart().Distance( aPosition ) <= max_dist ||
GetEnd().Distance( aPosition ) <= max_dist )
2529 arc_hittest -= arc_angle_start;
2535 return arc_hittest >=
ANGLE_360 + arc_angle;
2537 return arc_hittest <= arc_angle;
2551 int max_dist = aAccuracy + (
GetWidth( aLayer ) / 2 );
2555 double dist = rel_pos.x * rel_pos.x + rel_pos.y * rel_pos.y;
2557 if( dist <=
static_cast<double>( max_dist ) * max_dist )
2567 BOX2I arect = aRect;
2579 BOX2I arect = aRect;
2597 BOX2I arect = aRect;
2629 return wxString::Format(
Type() ==
PCB_ARC_T ?
_(
"Track (arc) %s on %s, length %s" )
2630 :
_(
"Track %s on %s, length %s" ),
2655 std::swap( *
this, *
static_cast<PCB_ARC*
>( aImage ) );
2677 return std::min(
center.Distance(
m_Start ), (
double) INT_MAX / 2.0 );
2712 if(
GetRadius() >= (
double)INT_MAX/2.0 )
2721 && (
GetMid() -
GetEnd() ).EuclideanNorm() < aThreshold;
2750 return std::make_shared<SHAPE_SEGMENT>(
m_Start,
m_End, width );
2768 holeSize = std::max( holeSize, frontPM.
size );
2774 holeSize = std::max( holeSize, backPM.
size );
2780 holeSize = std::max( holeSize, secDrill.
size.
x );
2783 return std::make_shared<SHAPE_CIRCLE>(
m_Start, holeSize / 2 );
2798 width = std::max( width,
GetWidth( layer ) );
2809 return std::make_shared<SHAPE_CIRCLE>(
m_Start, width );
2828 return std::make_shared<SHAPE_SEGMENT>(
GetStart(),
GetEnd(), width );
2830 return std::make_shared<SHAPE_ARC>( arc );
2835 int aClearance,
int aError,
ERROR_LOC aErrorLoc,
2836 bool ignoreLineWidth )
const
2838 wxASSERT_MSG( !ignoreLineWidth, wxT(
"IgnoreLineWidth has no meaning for tracks." ) );
2853 int width =
m_width + ( 2 * aClearance );
2859 aError, aErrorLoc );
2865 int width =
m_width + ( 2 * aClearance );
2924 if( layerEnum.
Choices().GetCount() == 0 )
2932 auto viaDiameterPropertyValidator =
2935 if( !aItem || aItem->Type() !=
PCB_VIA_T )
2936 return std::nullopt;
2938 if( !aValue.CheckType<
int>() )
2939 return std::nullopt;
2943 std::optional<int> diameter = aValue.As<
int>();
2944 std::optional<int> drill =
via->GetDrillValue();
2946 std::optional<PCB_LAYER_ID> startLayer;
2949 startLayer =
via->Padstack().Drill().start;
2951 std::optional<PCB_LAYER_ID> endLayer;
2954 endLayer =
via->Padstack().Drill().end;
2956 int copperLayerCount =
via->BoardCopperLayerCount();
2958 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
2960 std::nullopt, std::nullopt, std::nullopt,
2961 std::nullopt, std::nullopt, std::nullopt,
2962 copperLayerCount ) )
2964 return std::make_unique<VALIDATION_ERROR_MSG>( error->m_Message );
2967 return std::nullopt;
2970 auto viaDrillPropertyValidator =
2973 if( !aItem || aItem->Type() !=
PCB_VIA_T )
2974 return std::nullopt;
2976 if( !aValue.CheckType<
int>() )
2977 return std::nullopt;
2981 std::optional<int> diameter =
via->GetFrontWidth();
2982 std::optional<int> drill = aValue.As<
int>();
2984 std::optional<PCB_LAYER_ID> startLayer;
2987 startLayer =
via->Padstack().Drill().start;
2989 std::optional<PCB_LAYER_ID> endLayer;
2992 endLayer =
via->Padstack().Drill().end;
2994 std::optional<int> secondaryDrill =
via->GetSecondaryDrillSize();
2996 std::optional<PCB_LAYER_ID> secondaryStart;
2999 secondaryStart =
via->GetSecondaryDrillStartLayer();
3001 std::optional<PCB_LAYER_ID> secondaryEnd;
3004 secondaryEnd =
via->GetSecondaryDrillEndLayer();
3006 std::optional<int> tertiaryDrill =
via->GetTertiaryDrillSize();
3008 std::optional<PCB_LAYER_ID> tertiaryStart;
3011 tertiaryStart =
via->GetTertiaryDrillStartLayer();
3013 std::optional<PCB_LAYER_ID> tertiaryEnd;
3016 tertiaryEnd =
via->GetTertiaryDrillEndLayer();
3018 int copperLayerCount =
via->BoardCopperLayerCount();
3020 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
3022 secondaryDrill, secondaryStart, secondaryEnd,
3023 tertiaryDrill, tertiaryStart, tertiaryEnd,
3024 copperLayerCount ) )
3026 return std::make_unique<VALIDATION_ERROR_MSG>( error->m_Message );
3029 return std::nullopt;
3032 auto viaStartLayerPropertyValidator =
3035 if( !aItem || aItem->Type() !=
PCB_VIA_T )
3036 return std::nullopt;
3042 else if( aValue.CheckType<
int>() )
3045 return std::nullopt;
3049 std::optional<int> diameter =
via->GetFrontWidth();
3050 std::optional<int> drill =
via->GetDrillValue();
3052 std::optional<PCB_LAYER_ID> endLayer;
3055 endLayer =
via->BottomLayer();
3057 std::optional<int> secondaryDrill =
via->GetSecondaryDrillSize();
3059 std::optional<PCB_LAYER_ID> secondaryStart;
3062 secondaryStart =
via->GetSecondaryDrillStartLayer();
3064 std::optional<PCB_LAYER_ID> secondaryEnd;
3067 secondaryEnd =
via->GetSecondaryDrillEndLayer();
3069 int copperLayerCount =
via->BoardCopperLayerCount();
3071 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
3073 secondaryDrill, secondaryStart, secondaryEnd,
3074 std::nullopt, std::nullopt, std::nullopt,
3075 copperLayerCount ) )
3077 return std::make_unique<VALIDATION_ERROR_MSG>( error->m_Message );
3080 return std::nullopt;
3083 auto viaEndLayerPropertyValidator =
3086 if( !aItem || aItem->Type() !=
PCB_VIA_T )
3087 return std::nullopt;
3093 else if( aValue.CheckType<
int>() )
3096 return std::nullopt;
3100 std::optional<int> diameter =
via->GetFrontWidth();
3101 std::optional<int> drill =
via->GetDrillValue();
3103 std::optional<PCB_LAYER_ID> startLayer;
3106 startLayer =
via->TopLayer();
3108 std::optional<int> secondaryDrill =
via->GetSecondaryDrillSize();
3110 std::optional<PCB_LAYER_ID> secondaryStart;
3113 secondaryStart =
via->GetSecondaryDrillStartLayer();
3115 std::optional<PCB_LAYER_ID> secondaryEnd;
3118 secondaryEnd =
via->GetSecondaryDrillEndLayer();
3120 int copperLayerCount =
via->BoardCopperLayerCount();
3122 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
3124 secondaryDrill, secondaryStart, secondaryEnd,
3125 std::nullopt, std::nullopt, std::nullopt,
3126 copperLayerCount ) )
3128 return std::make_unique<VALIDATION_ERROR_MSG>( error->m_Message );
3131 return std::nullopt;
3157 const wxString groupTechLayers =
_HKI(
"Technical Layers" );
3159 auto isExternalLayerTrack =
3185 const wxString groupVia =
_HKI(
"Via Properties" );
3186 const wxString groupBackdrill =
_HKI(
"Backdrill" );
3187 const wxString groupPostMachining =
_HKI(
"Post-machining" );
3223 auto canHaveBackdrill =
3250 auto mode =
via->GetBackdrillMode();
3263 auto mode =
via->GetBackdrillMode();
3277 auto mode =
via->GetBackdrillMode();
3290 auto mode =
via->GetBackdrillMode();
3301 groupPostMachining )
3307 auto mode =
via->GetFrontPostMachining();
3316 groupPostMachining )
3322 auto mode =
via->GetFrontPostMachining();
3330 groupPostMachining )
3336 auto mode =
via->GetFrontPostMachining();
3347 groupPostMachining )
3353 auto mode =
via->GetBackPostMachining();
3362 groupPostMachining )
3368 auto mode =
via->GetBackPostMachining();
3376 groupPostMachining )
3382 auto mode =
via->GetBackPostMachining();
types::KiCadObjectType ToProtoEnum(KICAD_T aValue)
KICAD_T FromProtoEnum(types::KiCadObjectType aValue)
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
constexpr EDA_IU_SCALE pcbIUScale
constexpr int ARC_LOW_DEF
BITMAPS
A list of all bitmap identifiers.
ZONE_LAYER_OVERRIDE
Conditionally flashed vias and pads that interact with zones of different priority can be very squirr...
constexpr BOX2I BOX2ISafe(const BOX2D &aInput)
BASE_SET & set(size_t pos)
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
wxString GetNetnameMsg() const
virtual NETCLASS * GetEffectiveNetClass() const
Return the NETCLASS for this item.
wxString GetNetname() const
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
BOARD_CONNECTED_ITEM(BOARD_ITEM *aParent, KICAD_T idtype)
void PackNet(kiapi::board::types::Net *aProto) const
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
NETINFO_ITEM * GetNet() const
Return #NET_INFO object for a given item.
const wxString & GetDisplayNetname() const
virtual int GetOwnClearance(PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
Return an item's "own" clearance in internal units.
void UnpackNet(const kiapi::board::types::Net &aProto)
Assigns a net to this item from an API message.
Container for design settings for a BOARD object.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
BOARD_STACKUP & GetStackupDescriptor()
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype, PCB_LAYER_ID aLayer=F_Cu)
void SetUuidDirect(const KIID &aUuid)
Raw UUID assignment.
void SetLocked(bool aLocked) override
bool IsLocked() const override
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
virtual void TransformShapeToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS *aRenderSettings=nullptr) const
Convert the item shape to a polyset.
virtual wxString LayerMaskDescribe() const
Return a string (to be shown to the user) describing a layer mask.
BOARD_ITEM & operator=(const BOARD_ITEM &aOther)
BOARD_ITEM_CONTAINER * GetParent() const
virtual int BoardCopperLayerCount() const
Return the total number of copper layers for the board that this item resides on.
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Manage layers needed to make a physical board.
int GetLayerDistance(PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer) const
Calculate the distance (height) between the two given copper layers.
LENGTH_DELAY_CALCULATION * GetLengthCalculation() const
Returns the track length calculator.
std::tuple< int, double, double, double, double > GetTrackLength(const PCB_TRACK &aTrack) const
Return data on the length and number of track segments connected to a given track.
const LSET & GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayer) const
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
const LSET & GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
constexpr BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
bool IntersectsCircle(const Vec &aCenter, const int aRadius) const
constexpr coord_type GetLeft() const
constexpr bool Contains(const Vec &aPoint) const
constexpr coord_type GetRight() const
constexpr coord_type GetTop() const
constexpr bool Intersects(const BOX2< Vec > &aRect) const
constexpr coord_type GetBottom() const
bool IsConnectedOnLayer(const BOARD_CONNECTED_ITEM *aItem, int aLayer, const std::initializer_list< KICAD_T > &aTypes={}) const
MINOPTMAX< int > & Value()
DRC_CONSTRAINT EvalRules(DRC_CONSTRAINT_T aConstraintType, const BOARD_ITEM *a, const BOARD_ITEM *b, PCB_LAYER_ID aLayer, REPORTER *aReporter=nullptr)
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
KICAD_T Type() const
Returns the type of object.
EDA_ITEM_FLAGS GetFlags() const
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
ENUM_MAP & Map(T aValue, const wxString &aName)
static ENUM_MAP< T > & Instance()
ENUM_MAP & Undefined(T aValue)
Class that other classes need to inherit from, in order to be inspectable.
Contains methods for drawing PCB-specific items.
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
PCB specific render settings.
PCB_LAYER_ID GetPrimaryHighContrastLayer() const
Return the board layer which is in high-contrast mode.
bool GetHighContrast() const
static double lodScaleForThreshold(const KIGFX::VIEW *aView, int aWhatIu, int aThresholdIu)
Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.
static constexpr double LOD_HIDE
Return this constant from ViewGetLOD() to hide the item unconditionally.
static constexpr double LOD_SHOW
Return this constant from ViewGetLOD() to show the item unconditionally.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
bool IsLayerVisibleCached(int aLayer) const
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
static bool Contains(int aStart_layer, int aEnd_layer, int aTest_layer)
Class which calculates lengths (and associated routing statistics) in a BOARD context.
int64_t CalculateDelay(std::vector< LENGTH_DELAY_CALCULATION_ITEM > &aItems, PATH_OPTIMISATIONS aOptimisations, const PAD *aStartPad=nullptr, const PAD *aEndPad=nullptr) const
Calculates the electrical propagation delay of the given items.
LENGTH_DELAY_CALCULATION_ITEM GetLengthCalculationItem(const BOARD_CONNECTED_ITEM *aBoardItem) const
Return a LENGTH_CALCULATION_ITEM constructed from the given BOARD_CONNECTED_ITEM.
LSET is a set of PCB_LAYER_IDs.
static const LSET & AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
void RunOnLayers(const std::function< void(PCB_LAYER_ID)> &aFunction) const
Execute a function on each layer of the LSET.
static const LSET & BackTechMask()
Return a mask holding all technical layers (no CU layer) on back side.
static const LSET & AllLayersMask()
static const LSET & PhysicalLayersMask()
Return a mask holding all layers which are physically realized.
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
bool Contains(PCB_LAYER_ID aLayer) const
See if the layer set contains a PCB layer.
static const LSET & FrontTechMask()
Return a mask holding all technical layers (no CU layer) on front side.
A collection of nets and the parameters used to route or test these nets.
Handle the data for a net.
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
A PADSTACK defines the characteristics of a single or multi-layer pad, in the IPC sense of the word.
void ForEachUniqueLayer(const std::function< void(PCB_LAYER_ID)> &aMethod) const
Runs the given callable for each active unique copper layer in this padstack, meaning F_Cu for MODE::...
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
virtual VECTOR2I GetPosition() const override
bool IsDegenerated(int aThreshold=5) const
virtual void swapData(BOARD_ITEM *aImage) override
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
EDA_ANGLE GetArcAngleStart() const
void Mirror(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Mirror this object relative to a given horizontal axis the layer is not changed.
virtual bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
EDA_ANGLE GetArcAngleEnd() const
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
void SetMid(const VECTOR2I &aMid)
EDA_ANGLE GetAngle() const
const VECTOR2I & GetMid() const
PCB_ARC(BOARD_ITEM *aParent)
double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
VECTOR2I m_Mid
Arc mid point, halfway between start and end.
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
bool operator==(const PCB_ARC &aOther) const
void CopyFrom(const BOARD_ITEM *aOther) override
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
virtual void SetLayerSet(const LSET &aLayers) override
int GetSolderMaskExpansion() const
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
void SetHasSolderMask(bool aVal)
virtual double GetLength() const
Get the length of the track using the hypotenuse calculation.
double ViewGetLOD(int aLayer, const KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
virtual void swapData(BOARD_ITEM *aImage) override
void SetEnd(const VECTOR2I &aEnd)
bool HasSolderMask() const
void SetStart(const VECTOR2I &aStart)
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
virtual void Mirror(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Mirror this object relative to a given horizontal axis the layer is not changed.
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) override
May be re-implemented for each derived class in order to handle all the types given by its member dat...
bool ApproxCollinear(const PCB_TRACK &aTrack)
VECTOR2I m_End
Line end point.
void SetLocalSolderMaskMargin(std::optional< int > aMargin)
std::optional< int > m_solderMaskMargin
void CopyFrom(const BOARD_ITEM *aOther) override
std::optional< int > GetLocalSolderMaskMargin() const
virtual double GetDelay() const
Get the time delay of the track.
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
virtual EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the track shape to a closed polygon.
const VECTOR2I & GetStart() const
virtual bool operator==(const BOARD_ITEM &aOther) const override
VECTOR2I m_Start
Line start point.
wxString GetFriendlyName() const override
virtual std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
virtual double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
const VECTOR2I & GetEnd() const
PCB_TRACK(BOARD_ITEM *aParent, KICAD_T idtype=PCB_TRACE_T)
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
virtual MINOPTMAX< int > GetWidthConstraint(wxString *aSource=nullptr) const
int m_width
Thickness of track (or arc) – no longer the width of a via.
EDA_ITEM_FLAGS IsPointOnEnds(const VECTOR2I &point, int min_dist=0) const
Return STARTPOINT if point if near (dist = min_dist) start point, ENDPOINT if point if near (dist = m...
virtual void SetWidth(int aWidth)
virtual int GetWidth() const
void GetMsgPanelInfoBase_Common(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) const
int GetFrontPostMachiningSize() const
PCB_LAYER_ID BottomLayer() const
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
PLUGGING_MODE GetFrontPluggingMode() const
VECTOR2I GetPosition() const override
bool IsTented(PCB_LAYER_ID aLayer) const override
Checks if the given object is tented (its copper shape is covered by solder mask) on a given side of ...
void CopyFrom(const BOARD_ITEM *aOther) override
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
PCB_LAYER_ID GetTopBackdrillLayer() const
void SetFrontPostMachiningDepth(int aDepth)
void SetCappingMode(CAPPING_MODE aMode)
void SetFrontCoveringMode(COVERING_MODE aMode)
wxString LayerMaskDescribe() const override
Return a string (to be shown to the user) describing a layer mask.
int GetBackPostMachiningDepth() const
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
void SetBackPostMachiningAngle(int aAngle)
int GetBackPostMachiningAngle() const
COVERING_MODE GetBackCoveringMode() const
std::optional< int > GetTertiaryDrillSize() const
void SetTopBackdrillSize(std::optional< int > aSize)
bool FlashLayer(int aLayer) const
Check to see whether the via should have a pad on the specific layer.
void SetBackPostMachiningMode(PAD_DRILL_POST_MACHINING_MODE aMode)
std::optional< int > GetTopBackdrillSize() const
void SetBackdrillMode(BACKDRILL_MODE aMode)
void SetDrillDefault()
Set the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER.
std::map< PCB_LAYER_ID, ZONE_LAYER_OVERRIDE > m_zoneLayerOverrides
void SetBottomBackdrillSize(std::optional< int > aSize)
void ClearZoneLayerOverrides()
CAPPING_MODE GetCappingMode() const
const PADSTACK & Padstack() const
void SetFrontTentingMode(TENTING_MODE aMode)
bool m_isFree
"Free" vias don't get their nets auto-updated
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
int GetFrontPostMachiningDepth() const
TENTING_MODE GetFrontTentingMode() const
int GetPostMachiningKnockout(PCB_LAYER_ID aLayer) const
Get the knockout diameter for a layer affected by post-machining.
void SetBottomLayer(PCB_LAYER_ID aLayer)
void SetPrimaryDrillSize(const VECTOR2I &aSize)
Set the drill value for vias.
bool IsBackdrilledOrPostMachined(PCB_LAYER_ID aLayer) const
Check if a layer is affected by backdrilling or post-machining operations.
std::optional< int > GetSecondaryDrillSize() const
void SetPrimaryDrillCappedFlag(bool aCapped)
int GetSolderMaskExpansion() const
void SetSecondaryDrillStartLayer(PCB_LAYER_ID aLayer)
void SetTertiaryDrillEndLayer(PCB_LAYER_ID aLayer)
void ClearSecondaryDrillSize()
void SetBackPostMachiningDepth(int aDepth)
void SetDrill(int aDrill)
PLUGGING_MODE GetBackPluggingMode() const
void SetBackPluggingMode(PLUGGING_MODE aMode)
MINOPTMAX< int > GetDrillConstraint(wxString *aSource=nullptr) const
void SetBackTentingMode(TENTING_MODE aMode)
void SetFrontPluggingMode(PLUGGING_MODE aMode)
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
void SetFrontPostMachining(const std::optional< PAD_DRILL_POST_MACHINING_MODE > &aMode)
bool operator==(const PCB_VIA &aOther) const
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
void SetSecondaryDrillEndLayer(PCB_LAYER_ID aLayer)
int GetFrontPostMachiningAngle() const
std::mutex m_zoneLayerOverridesMutex
void SetFrontPostMachiningAngle(int aAngle)
void SetTopLayer(PCB_LAYER_ID aLayer)
FILLING_MODE GetFillingMode() const
std::shared_ptr< SHAPE_SEGMENT > GetEffectiveHoleShape() const override
int GetFrontWidth() const
void SetLayerPair(PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)
For a via m_layer contains the top layer, the other layer is in m_bottomLayer/.
PAD_DRILL_POST_MACHINING_MODE GetFrontPostMachiningMode() const
void SetFrontPostMachiningSize(int aSize)
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
void SetTertiaryDrillStartLayer(PCB_LAYER_ID aLayer)
PCB_LAYER_ID GetBottomBackdrillLayer() const
void SetPrimaryDrillShape(PAD_DRILL_SHAPE aShape)
static std::optional< VIA_PARAMETER_ERROR > ValidateViaParameters(std::optional< int > aDiameter, std::optional< int > aPrimaryDrill, std::optional< PCB_LAYER_ID > aPrimaryStartLayer=std::nullopt, std::optional< PCB_LAYER_ID > aPrimaryEndLayer=std::nullopt, std::optional< int > aSecondaryDrill=std::nullopt, std::optional< PCB_LAYER_ID > aSecondaryStartLayer=std::nullopt, std::optional< PCB_LAYER_ID > aSecondaryEndLayer=std::nullopt, std::optional< int > aTertiaryDrill=std::nullopt, std::optional< PCB_LAYER_ID > aTertiaryStartLayer=std::nullopt, std::optional< PCB_LAYER_ID > aTertiaryEndLayer=std::nullopt, int aCopperLayerCount=0)
void SetTertiaryDrillShape(PAD_DRILL_SHAPE aShape)
virtual void SetLayerSet(const LSET &aLayers) override
Note SetLayerSet() initialize the first and last copper layers connected by the via.
void GetOutermostConnectedLayers(PCB_LAYER_ID *aTopmost, PCB_LAYER_ID *aBottommost) const
Return the top-most and bottom-most connected layers.
void SetSecondaryDrillShape(PAD_DRILL_SHAPE aShape)
void SanitizeLayers()
Check so that the layers are correct depending on the type of via, and so that the top actually is on...
int GetWidth() const override
void SetBackPostMachining(const std::optional< PAD_DRILL_POST_MACHINING_MODE > &aMode)
PCB_VIA & operator=(const PCB_VIA &aOther)
void swapData(BOARD_ITEM *aImage) override
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
void SetFillingMode(FILLING_MODE aMode)
PCB_VIA(BOARD_ITEM *aParent)
void SetPrimaryDrillFilledFlag(bool aFilled)
std::optional< int > GetBottomBackdrillSize() const
std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
void SetViaType(VIATYPE aViaType)
int GetMinAnnulus(PCB_LAYER_ID aLayer, wxString *aSource) const
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
TENTING_MODE GetBackTentingMode() const
PCB_LAYER_ID TopLayer() const
void ClearTertiaryDrillSize()
VIATYPE m_viaType
through, blind/buried or micro
void SetBottomBackdrillLayer(PCB_LAYER_ID aLayer)
int GetBackPostMachiningSize() const
void SetTertiaryDrillSize(const VECTOR2I &aSize)
void SetSecondaryDrillSize(const VECTOR2I &aSize)
COVERING_MODE GetFrontCoveringMode() const
int GetDrillValue() const
Calculate the drill value for vias (m_drill if > 0, or default drill value for the board).
void SetZoneLayerOverride(PCB_LAYER_ID aLayer, ZONE_LAYER_OVERRIDE aOverride)
PAD_DRILL_POST_MACHINING_MODE GetBackPostMachiningMode() const
void SetFrontWidth(int aWidth)
VIATYPE GetViaType() const
double ViewGetLOD(int aLayer, const KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
void SetPrimaryDrillCapped(const std::optional< bool > &aCapped)
MINOPTMAX< int > GetWidthConstraint(wxString *aSource=nullptr) const override
BACKDRILL_MODE GetBackdrillMode() const
void SetWidth(int aWidth) override
void SetBackCoveringMode(COVERING_MODE aMode)
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
void SetPrimaryDrillFilled(const std::optional< bool > &aFilled)
void SetTopBackdrillLayer(PCB_LAYER_ID aLayer)
const ZONE_LAYER_OVERRIDE & GetZoneLayerOverride(PCB_LAYER_ID aLayer) const
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Return the 2 layers used by the via (the via actually uses all layers between these 2 layers)
bool HasValidLayerPair(int aCopperLayerCount)
void SetFrontPostMachiningMode(PAD_DRILL_POST_MACHINING_MODE aMode)
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
void SetBackPostMachiningSize(int aSize)
void SetPrimaryDrillEndLayer(PCB_LAYER_ID aLayer)
void SetPrimaryDrillStartLayer(PCB_LAYER_ID aLayer)
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
PROPERTY_BASE & SetValidator(PROPERTY_VALIDATOR_FN &&aValidator)
Provide class metadata.Helper macro to map type hashes to names.
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
void Mask(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName)
Sets a base class property as masked in a derived class.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
PROPERTY_BASE & ReplaceProperty(size_t aBase, const wxString &aName, PROPERTY_BASE *aNew, const wxString &aGroup=wxEmptyString)
Replace an existing property for a specific type.
VECTOR2I::extended_type ecoord
bool ApproxCollinear(const SEG &aSeg, int aDistanceThreshold=1) const
const VECTOR2I & GetArcMid() const
const VECTOR2I & GetP1() const
bool IsEffectiveLine() const
const VECTOR2I & GetP0() const
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Represent a set of closed polygons.
double Area()
Return the area of this poly set.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
wxString MessageTextFromMinOptMax(const MINOPTMAX< int > &aValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
constexpr extended_type Cross(const VECTOR2< T > &aVector) const
Compute cross product of self with aVector.
T EuclideanNorm() const
Compute the Euclidean norm of the vector, which is defined as sqrt(x ** 2 + y ** 2).
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aBuffer, const VECTOR2I &aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a circle to a polygon, using multiple straight lines.
void TransformArcToPolygon(SHAPE_POLY_SET &aBuffer, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, int aWidth, int aError, ERROR_LOC aErrorLoc)
Convert arc to multiple straight segments.
void TransformOvalToPolygon(SHAPE_POLY_SET &aBuffer, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aWidth, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a oblong shape to a polygon, using multiple segments.
@ ANNULAR_WIDTH_CONSTRAINT
@ VIA_DIAMETER_CONSTRAINT
@ SOLDER_MASK_EXPANSION_CONSTRAINT
static constexpr EDA_ANGLE ANGLE_0
static constexpr EDA_ANGLE ANGLE_360
#define PCB_EDIT_FRAME_NAME
const INSPECTOR_FUNC & INSPECTOR
std::function passed to nested users by ref, avoids copying std::function.
#define ROUTER_TRANSIENT
transient items that should NOT be cached
#define ENDPOINT
ends. (Used to support dragging.)
std::uint32_t EDA_ITEM_FLAGS
#define STARTPOINT
When a line is selected, these flags indicate which.
a few functions useful in geometry calculations.
bool ClipLine(const BOX2I *aClipBox, int &x1, int &y1, int &x2, int &y2)
Test if any part of a line falls within the bounds of a rectangle.
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
bool IsSolderMaskLayer(int aLayer)
bool IsCopperLayerLowerThan(PCB_LAYER_ID aLayerA, PCB_LAYER_ID aLayerB)
Return true if copper aLayerA is placed lower than aLayerB, false otherwise.
constexpr PCB_LAYER_ID PCBNEW_LAYER_ID_START
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
@ DEFAULT
Flashing follows connectivity.
@ ALWAYS_FLASHED
Always flashed for connectivity.
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
int GetNetnameLayer(int aLayer)
Return a netname layer corresponding to the given layer.
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
@ LAYER_LOCKED_ITEM_SHADOW
Shadow layer for locked items.
@ LAYER_VIA_COPPER_START
Virtual layers for via copper on a given copper layer.
@ LAYER_CLEARANCE_START
Virtual layers for pad/via/track clearance outlines for a given copper layer.
@ LAYER_VIA_HOLES
Draw via holes (pad holes do not use this layer).
@ LAYER_VIAS
Meta control for all vias opacity/visibility.
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
bool IsHoleLayer(int aLayer)
bool IsExternalCopperLayer(int aLayerId)
Test whether a layer is an external (F_Cu or B_Cu) copper layer.
PCB_LAYER_ID
A quick note on layer IDs:
PCB_LAYER_ID ToLAYER_ID(int aLayer)
constexpr void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
@ LEFT_RIGHT
Flip left to right (around the Y axis)
bool ShapeHitTest(const SHAPE_LINE_CHAIN &aHitter, const SHAPE &aHittee, bool aHitteeContained)
Perform a shape-to-shape hit test.
void PackLayerSet(google::protobuf::RepeatedField< int > &aOutput, const LSET &aLayerSet)
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
PAD_DRILL_SHAPE
The set of pad drill shapes, used with PAD::{Set,Get}DrillShape()
@ REMOVE_EXCEPT_START_AND_END
static struct TRACK_VIA_DESC _TRACK_VIA_DESC
#define GEOMETRY_MIN_SIZE
#define ENUM_TO_WXANY(type)
Macro to define read-only fields (no setter method available)
@ PT_COORD
Coordinate expressed in distance units (mm/inch)
@ PT_DECIDEGREE
Angle expressed in decidegrees.
@ PT_SIZE
Size expressed in distance units (mm/inch)
std::optional< std::unique_ptr< VALIDATION_ERROR > > VALIDATOR_RESULT
Null optional means validation succeeded.
wxString UnescapeString(const wxString &aSource)
! The properties of a padstack drill. Drill position is always the pad position (origin).
VECTOR2I size
Drill diameter (x == y) or slot dimensions (x != y)
std::optional< PAD_DRILL_POST_MACHINING_MODE > mode
Struct to control which optimisations the length calculation code runs on the given path objects.
bool operator()(const PCB_TRACK *aFirst, const PCB_TRACK *aSecond) const
wxString result
Test unit parsing edge cases and error handling.
bool TestSegmentHit(const VECTOR2I &aRefPoint, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aDist)
Test if aRefPoint is with aDistance on the line defined by aStart and aEnd.
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
const VECTOR2I CalcArcCenter(const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd)
Determine the center of an arc or circle given three points on its circumference.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_PAD_T
class PAD, a pad in a footprint
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
VECTOR2< int32_t > VECTOR2I
VECTOR2< double > VECTOR2D
VECTOR2< int64_t > VECTOR2L