56#include <google/protobuf/any.pb.h>
60#include <api/board/board_types.pb.h>
82 *
this = *
static_cast<const PCB_TRACK*
>( aOther );
104 *
this = *
static_cast<const PCB_ARC*
>( aOther );
161 *
this = *
static_cast<const PCB_VIA*
>( aOther );
180 default: formatStr =
_(
"Via %s on %s" );
break;
200 return *
this == other;
222 double similarity = 1.0;
253 return *
this == other;
264 return *
this == other;
287 double similarity = 1.0;
321 return *
this == other;
332 return *
this == other;
354 double similarity = 1.0;
393 m_padStack.SetSize( { aWidth, aWidth }, aLayer );
405 kiapi::board::types::Track track;
407 track.mutable_id()->set_value(
m_Uuid.AsStdString() );
408 track.mutable_start()->set_x_nm(
GetStart().x );
409 track.mutable_start()->set_y_nm(
GetStart().y );
410 track.mutable_end()->set_x_nm(
GetEnd().x );
411 track.mutable_end()->set_y_nm(
GetEnd().y );
412 track.mutable_width()->set_value_nm(
GetWidth() );
414 track.set_locked(
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
415 : kiapi::common::types::LockedState::LS_UNLOCKED );
416 PackNet( track.mutable_net() );
419 aContainer.PackFrom( track );
425 kiapi::board::types::Track track;
427 if( !aContainer.UnpackTo( &track ) )
433 SetWidth( track.width().value_nm() );
436 SetLocked( track.locked() == kiapi::common::types::LockedState::LS_LOCKED );
445 kiapi::board::types::Arc arc;
447 arc.mutable_id()->set_value(
m_Uuid.AsStdString() );
448 arc.mutable_start()->set_x_nm(
GetStart().x );
449 arc.mutable_start()->set_y_nm(
GetStart().y );
450 arc.mutable_mid()->set_x_nm(
GetMid().x );
451 arc.mutable_mid()->set_y_nm(
GetMid().y );
452 arc.mutable_end()->set_x_nm(
GetEnd().x );
453 arc.mutable_end()->set_y_nm(
GetEnd().y );
454 arc.mutable_width()->set_value_nm(
GetWidth() );
456 arc.set_locked(
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
457 : kiapi::common::types::LockedState::LS_UNLOCKED );
461 aContainer.PackFrom( arc );
467 kiapi::board::types::Arc arc;
469 if( !aContainer.UnpackTo( &arc ) )
479 SetLocked( arc.locked() == kiapi::common::types::LockedState::LS_LOCKED );
488 kiapi::board::types::Via
via;
490 via.mutable_id()->set_value(
m_Uuid.AsStdString() );
496 google::protobuf::Any padStackWrapper;
498 padStackWrapper.UnpackTo(
via.mutable_pad_stack() );
501 via.mutable_pad_stack()->clear_layers();
505 via.set_locked(
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
506 : kiapi::common::types::LockedState::LS_UNLOCKED );
509 aContainer.PackFrom(
via );
515 kiapi::board::types::Via
via;
517 if( !aContainer.UnpackTo( &
via ) )
524 google::protobuf::Any padStackWrapper;
525 padStackWrapper.PackFrom(
via.pad_stack() );
527 if( !
m_padStack.Deserialize( padStackWrapper ) )
535 SetLocked(
via.locked() == kiapi::common::types::LockedState::LS_LOCKED );
561 *aSource = constraint.
GetName();
563 return constraint.
Value();
579 *aSource = constraint.
GetName();
581 return constraint.
Value();
597 *aSource = constraint.
GetName();
599 return constraint.
Value();
608 *aSource =
_(
"removed annular ring" );
625 *aSource = constraint.
GetName();
723 if( aDrill.has_value() && *aDrill > 0 )
771 if( aDrill.has_value() && *aDrill > 0 )
825 if( layer == aLayer )
840 if( layer == aLayer )
871 int pmDepth = frontPM.
depth;
875 && frontPM.
angle > 0 )
877 double halfAngleRad = ( frontPM.
angle / 10.0 ) *
M_PI / 180.0 / 2.0;
878 pmDepth =
static_cast<int>( ( frontPM.
size / 2.0 ) / tan( halfAngleRad ) );
886 if( layerDist < pmDepth )
891 double halfAngleRad = ( frontPM.
angle / 10.0 ) *
M_PI / 180.0 / 2.0;
892 int diameterAtLayer = frontPM.
size -
static_cast<int>( 2.0 * layerDist * tan( halfAngleRad ) );
893 return std::max( 0, diameterAtLayer );
910 int pmDepth = backPM.
depth;
914 && backPM.
angle > 0 )
916 double halfAngleRad = ( backPM.
angle / 10.0 ) *
M_PI / 180.0 / 2.0;
917 pmDepth =
static_cast<int>( ( backPM.
size / 2.0 ) / tan( halfAngleRad ) );
925 if( layerDist < pmDepth )
930 double halfAngleRad = ( backPM.
angle / 10.0 ) *
M_PI / 180.0 / 2.0;
931 int diameterAtLayer = backPM.
size -
static_cast<int>( 2.0 * layerDist * tan( halfAngleRad ) );
932 return std::max( 0, diameterAtLayer );
964 double dist =
m_Start.Distance( point );
966 if( min_dist >= dist )
969 dist =
m_End.Distance( point );
971 if( min_dist >= dist )
983 int ymax, xmax, ymin, xmin;
996 BOX2I bbox = arc->BBox();
1020 VECTOR2L( (int64_t) xmax - xmin + 1, (int64_t) ymax - ymin + 1 ) );
1045 VECTOR2L( (int64_t) xmax - xmin + 1, (int64_t) ymax - ymin + 1 ) );
1064 VECTOR2L( (int64_t) xmax - xmin + 1, (int64_t) ymax - ymin + 1 ) );
1084 .MergeTracks =
false,
1085 .OptimiseTracesInPads =
false,
1086 .InferViaInPad =
false
1165 return start_end.
Cross( start_mid ) < 0;
1195 const std::vector<KICAD_T>& aScanTypes )
1197 for(
KICAD_T scanType : aScanTypes )
1199 if( scanType ==
Type() )
1229 if(
m_padStack.FrontOuterLayers().has_solder_mask.has_value() )
1252 if(
m_padStack.BackOuterLayers().has_solder_mask.has_value() )
1275 if(
m_padStack.FrontOuterLayers().has_covering.has_value() )
1298 if(
m_padStack.BackOuterLayers().has_covering.has_value() )
1321 if(
m_padStack.FrontOuterLayers().has_plugging.has_value() )
1344 if(
m_padStack.BackOuterLayers().has_plugging.has_value() )
1367 if(
m_padStack.Drill().is_capped.has_value() )
1390 if(
m_padStack.Drill().is_filled.has_value() )
1403 "Invalid layer passed to IsTented" );
1407 if( front &&
m_padStack.FrontOuterLayers().has_solder_mask.has_value() )
1408 return *
m_padStack.FrontOuterLayers().has_solder_mask;
1410 if( !front &&
m_padStack.BackOuterLayers().has_solder_mask.has_value() )
1411 return *
m_padStack.BackOuterLayers().has_solder_mask;
1415 return front ? board->GetDesignSettings().m_TentViasFront
1416 : board->GetDesignSettings().m_TentViasBack;
1426 return board->GetDesignSettings().m_SolderMaskExpansion;
1437 &&
GetBoard()->GetDesignSettings().m_DRCEngine->HasRulesForConstraintType(
1454 margin = board->GetDesignSettings().m_SolderMaskExpansion;
1459 margin = std::max( margin, -
m_width / 2 );
1498 else if( aLayer ==
B_Mask )
1510 int layer_id = aCopperLayerCount*2;
1514 if(
Padstack().Drill().start > layer_id )
1558 if( layermask.test(
F_Cu ) )
1560 else if( layermask.test(
B_Cu ) )
1587 layermask.
set(
id );
1618 bool top_found =
false;
1619 bool bottom_found =
false;
1629 if( !top_found && layer !=
B_Cu )
1640 bottom_found =
true;
1655 board->InvalidateClearanceCache(
m_Uuid );
1672 board->InvalidateClearanceCache(
m_Uuid );
1680 if( aLayer ==
Padstack().Drill().start )
1689 board->InvalidateClearanceCache(
m_Uuid );
1705 std::swap( b_layer, t_layer );
1709 *top_layer = t_layer;
1712 *bottom_layer = b_layer;
1749 if( copperCount > 0 )
1761 && secondary.
start == secondary.
end )
1768std::optional<PCB_VIA::VIA_PARAMETER_ERROR>
1770 std::optional<int> aPrimaryDrill,
1771 std::optional<PCB_LAYER_ID> aPrimaryStartLayer,
1772 std::optional<PCB_LAYER_ID> aPrimaryEndLayer,
1773 std::optional<int> aSecondaryDrill,
1774 std::optional<PCB_LAYER_ID> aSecondaryStartLayer,
1775 std::optional<PCB_LAYER_ID> aSecondaryEndLayer,
1776 std::optional<int> aTertiaryDrill,
1777 std::optional<PCB_LAYER_ID> aTertiaryStartLayer,
1778 std::optional<PCB_LAYER_ID> aTertiaryEndLayer,
1779 int aCopperLayerCount )
1785 error.
m_Message =
_(
"Via diameter is too small." );
1792 error.
m_Message =
_(
"Via drill is too small." );
1797 if( aDiameter.has_value() && !aPrimaryDrill.has_value() )
1799 error.
m_Message =
_(
"No via hole size defined." );
1804 if( aPrimaryDrill.has_value() && !aDiameter.has_value() )
1806 error.
m_Message =
_(
"No via diameter defined." );
1811 if( aDiameter.has_value() && aPrimaryDrill.has_value()
1812 && aDiameter.value() <= aPrimaryDrill.value() )
1814 error.
m_Message =
_(
"Via hole size must be smaller than via diameter" );
1819 std::optional<LSET> copperMask;
1821 auto validateLayer = [&]( std::optional<PCB_LAYER_ID> aLayer,
1824 if( !aLayer.has_value() )
1834 error.
m_Message =
_(
"Via layer must be a copper layer." );
1839 if( aCopperLayerCount > 0 )
1841 if( !copperMask.has_value() )
1844 if( !copperMask->Contains( layer ) )
1846 error.
m_Message =
_(
"Via layer is outside the board stack." );
1861 if( aPrimaryStartLayer.has_value() && aPrimaryEndLayer.has_value()
1862 && aPrimaryStartLayer.value() == aPrimaryEndLayer.value() )
1864 error.
m_Message =
_(
"Via start layer and end layer cannot be the same" );
1869 if( aSecondaryDrill.has_value() )
1873 error.
m_Message =
_(
"Backdrill diameter is too small." );
1885 if( aTertiaryDrill.has_value() )
1889 error.
m_Message =
_(
"Tertiary backdrill diameter is too small." );
1901 return std::nullopt;
1920 return startOuter ^ endOuter;
1971 switch(
Padstack().UnconnectedLayerMode() )
2041 bool connected =
false;
2047 else if(
GetBoard()->GetConnectivity()->IsConnectedOnLayer(
this, layer, nonZoneTypes ) )
2068 std::vector<int> layers{
2074 layers.reserve( 6 );
2079 layers.push_back(
F_Mask );
2081 layers.push_back(
B_Mask );
2117 if(
VECTOR2I(
end - start ).SquaredEuclideanNorm() < nameSize * nameSize )
2124 if(
VECTOR2I(
end - start ).SquaredEuclideanNorm() == 0 )
2155 bbox.
Inflate( 2 * board->GetDesignSettings().GetBiggestClearanceValue() );
2175 bool isBlindBuried =
2183 cuMask &= board->GetEnabledLayers();
2200 ret_layers.push_back(
F_Mask );
2203 ret_layers.push_back(
B_Mask );
2225 highContrastLayer =
F_Cu;
2227 highContrastLayer =
B_Cu;
2258 if( !visible.any() )
2266 if( !visible.any() )
2324 default:
return _(
"Track" );
2347 aList.emplace_back(
_(
"Angle" ), wxString::Format(
"%.2fdeg",
2348 static_cast<PCB_ARC*
>(
this)->GetAngle().AsDegrees() ) );
2354 if( segmentDelay == 0.0 )
2360 aList.emplace_back(
_(
"Segment Delay" ),
2368 double trackLen = 0.0;
2369 double lenPadToDie = 0.0;
2370 double trackDelay = 0.0;
2371 double delayPadToDie = 0.0;
2373 std::tie( count, trackLen, lenPadToDie, trackDelay, delayPadToDie ) = board->
GetTrackLength( *
this );
2375 if( trackDelay == 0.0 )
2379 if( lenPadToDie != 0 )
2382 aList.emplace_back(
_(
"Pad To Die Length" ), msg );
2385 aList.emplace_back(
_(
"Full Length" ), msg );
2390 aList.emplace_back(
_(
"Routed Delay" ),
2393 if( delayPadToDie != 0.0 )
2396 aList.emplace_back(
_(
"Pad To Die Delay" ), msg );
2399 aList.emplace_back(
_(
"Full Delay" ), msg );
2406 aList.emplace_back(
_(
"Copper Area" ),
2412 aList.emplace_back( wxString::Format(
_(
"Min Clearance: %s" ),
2414 wxString::Format(
_(
"(from %s)" ), source ) );
2419 if( !msg.IsEmpty() )
2421 aList.emplace_back( wxString::Format(
_(
"Width Constraints: %s" ), msg ),
2422 wxString::Format(
_(
"(from %s)" ), source ) );
2437 default: msg =
_(
"Via" );
break;
2440 aList.emplace_back(
_(
"Type" ), msg );
2453 wxString::Format(
_(
"(from %s)" ), source ) );
2457 aList.emplace_back( wxString::Format(
_(
"Min Annular Width: %s" ), aFrame->
MessageTextFromValue( minAnnulus ) ),
2458 wxString::Format(
_(
"(from %s)" ), source ) );
2466 aList.emplace_back(
_(
"Resolved Netclass" ),
2471 aList.emplace_back(
_(
"NetCode" ), fmt::format(
"{}",
GetNetCode() ) );
2473 aList.emplace_back( wxT(
"Flags" ), fmt::format(
"#08X",
m_flags ) );
2475 aList.emplace_back( wxT(
"Start pos" ), fmt::format(
"{} {}",
m_Start.x,
m_Start.y ) );
2476 aList.emplace_back( wxT(
"End pos" ), fmt::format(
"{} {}",
m_End.x,
m_End.y ) );
2480 aList.emplace_back(
_(
"Status" ),
_(
"Locked" ) );
2504 double max_dist = aAccuracy + (
GetWidth() / 2.0 );
2507 if(
GetStart().Distance( aPosition ) <= max_dist ||
GetEnd().Distance( aPosition ) <= max_dist )
2525 arc_hittest -= arc_angle_start;
2531 return arc_hittest >=
ANGLE_360 + arc_angle;
2533 return arc_hittest <= arc_angle;
2547 int max_dist = aAccuracy + (
GetWidth( aLayer ) / 2 );
2551 double dist = rel_pos.x * rel_pos.x + rel_pos.y * rel_pos.y;
2553 if( dist <=
static_cast<double>( max_dist ) * max_dist )
2563 BOX2I arect = aRect;
2575 BOX2I arect = aRect;
2593 BOX2I arect = aRect;
2625 return wxString::Format(
Type() ==
PCB_ARC_T ?
_(
"Track (arc) %s on %s, length %s" )
2626 :
_(
"Track %s on %s, length %s" ),
2649 std::swap( *
this, *
static_cast<PCB_ARC*
>( aImage ) );
2670 return std::min(
center.Distance(
m_Start ), (
double) INT_MAX / 2.0 );
2705 if(
GetRadius() >= (
double)INT_MAX/2.0 )
2714 && (
GetMid() -
GetEnd() ).EuclideanNorm() < aThreshold;
2743 return std::make_shared<SHAPE_SEGMENT>(
m_Start,
m_End, width );
2761 holeSize = std::max( holeSize, frontPM.
size );
2767 holeSize = std::max( holeSize, backPM.
size );
2773 holeSize = std::max( holeSize, secDrill.
size.
x );
2776 return std::make_shared<SHAPE_CIRCLE>(
m_Start, holeSize / 2 );
2791 width = std::max( width,
GetWidth( layer ) );
2802 return std::make_shared<SHAPE_CIRCLE>(
m_Start, width );
2821 return std::make_shared<SHAPE_SEGMENT>(
GetStart(),
GetEnd(), width );
2823 return std::make_shared<SHAPE_ARC>( arc );
2828 int aClearance,
int aError,
ERROR_LOC aErrorLoc,
2829 bool ignoreLineWidth )
const
2831 wxASSERT_MSG( !ignoreLineWidth, wxT(
"IgnoreLineWidth has no meaning for tracks." ) );
2846 int width =
m_width + ( 2 * aClearance );
2852 aError, aErrorLoc );
2858 int width =
m_width + ( 2 * aClearance );
2917 if( layerEnum.
Choices().GetCount() == 0 )
2925 auto viaDiameterPropertyValidator =
2928 if( !aItem || aItem->Type() !=
PCB_VIA_T )
2929 return std::nullopt;
2931 if( !aValue.CheckType<
int>() )
2932 return std::nullopt;
2936 std::optional<int> diameter = aValue.As<
int>();
2937 std::optional<int> drill =
via->GetDrillValue();
2939 std::optional<PCB_LAYER_ID> startLayer;
2942 startLayer =
via->Padstack().Drill().start;
2944 std::optional<PCB_LAYER_ID> endLayer;
2947 endLayer =
via->Padstack().Drill().end;
2949 int copperLayerCount =
via->BoardCopperLayerCount();
2951 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
2953 std::nullopt, std::nullopt, std::nullopt,
2954 std::nullopt, std::nullopt, std::nullopt,
2955 copperLayerCount ) )
2957 return std::make_unique<VALIDATION_ERROR_MSG>( error->m_Message );
2960 return std::nullopt;
2963 auto viaDrillPropertyValidator =
2966 if( !aItem || aItem->Type() !=
PCB_VIA_T )
2967 return std::nullopt;
2969 if( !aValue.CheckType<
int>() )
2970 return std::nullopt;
2974 std::optional<int> diameter =
via->GetFrontWidth();
2975 std::optional<int> drill = aValue.As<
int>();
2977 std::optional<PCB_LAYER_ID> startLayer;
2980 startLayer =
via->Padstack().Drill().start;
2982 std::optional<PCB_LAYER_ID> endLayer;
2985 endLayer =
via->Padstack().Drill().end;
2987 std::optional<int> secondaryDrill =
via->GetSecondaryDrillSize();
2989 std::optional<PCB_LAYER_ID> secondaryStart;
2992 secondaryStart =
via->GetSecondaryDrillStartLayer();
2994 std::optional<PCB_LAYER_ID> secondaryEnd;
2997 secondaryEnd =
via->GetSecondaryDrillEndLayer();
2999 std::optional<int> tertiaryDrill =
via->GetTertiaryDrillSize();
3001 std::optional<PCB_LAYER_ID> tertiaryStart;
3004 tertiaryStart =
via->GetTertiaryDrillStartLayer();
3006 std::optional<PCB_LAYER_ID> tertiaryEnd;
3009 tertiaryEnd =
via->GetTertiaryDrillEndLayer();
3011 int copperLayerCount =
via->BoardCopperLayerCount();
3013 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
3015 secondaryDrill, secondaryStart, secondaryEnd,
3016 tertiaryDrill, tertiaryStart, tertiaryEnd,
3017 copperLayerCount ) )
3019 return std::make_unique<VALIDATION_ERROR_MSG>( error->m_Message );
3022 return std::nullopt;
3025 auto viaStartLayerPropertyValidator =
3028 if( !aItem || aItem->Type() !=
PCB_VIA_T )
3029 return std::nullopt;
3035 else if( aValue.CheckType<
int>() )
3038 return std::nullopt;
3042 std::optional<int> diameter =
via->GetFrontWidth();
3043 std::optional<int> drill =
via->GetDrillValue();
3045 std::optional<PCB_LAYER_ID> endLayer;
3048 endLayer =
via->BottomLayer();
3050 std::optional<int> secondaryDrill =
via->GetSecondaryDrillSize();
3052 std::optional<PCB_LAYER_ID> secondaryStart;
3055 secondaryStart =
via->GetSecondaryDrillStartLayer();
3057 std::optional<PCB_LAYER_ID> secondaryEnd;
3060 secondaryEnd =
via->GetSecondaryDrillEndLayer();
3062 int copperLayerCount =
via->BoardCopperLayerCount();
3064 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
3066 secondaryDrill, secondaryStart, secondaryEnd,
3067 std::nullopt, std::nullopt, std::nullopt,
3068 copperLayerCount ) )
3070 return std::make_unique<VALIDATION_ERROR_MSG>( error->m_Message );
3073 return std::nullopt;
3076 auto viaEndLayerPropertyValidator =
3079 if( !aItem || aItem->Type() !=
PCB_VIA_T )
3080 return std::nullopt;
3086 else if( aValue.CheckType<
int>() )
3089 return std::nullopt;
3093 std::optional<int> diameter =
via->GetFrontWidth();
3094 std::optional<int> drill =
via->GetDrillValue();
3096 std::optional<PCB_LAYER_ID> startLayer;
3099 startLayer =
via->TopLayer();
3101 std::optional<int> secondaryDrill =
via->GetSecondaryDrillSize();
3103 std::optional<PCB_LAYER_ID> secondaryStart;
3106 secondaryStart =
via->GetSecondaryDrillStartLayer();
3108 std::optional<PCB_LAYER_ID> secondaryEnd;
3111 secondaryEnd =
via->GetSecondaryDrillEndLayer();
3113 int copperLayerCount =
via->BoardCopperLayerCount();
3115 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
3117 secondaryDrill, secondaryStart, secondaryEnd,
3118 std::nullopt, std::nullopt, std::nullopt,
3119 copperLayerCount ) )
3121 return std::make_unique<VALIDATION_ERROR_MSG>( error->m_Message );
3124 return std::nullopt;
3150 const wxString groupTechLayers =
_HKI(
"Technical Layers" );
3152 auto isExternalLayerTrack =
3178 const wxString groupVia =
_HKI(
"Via Properties" );
3179 const wxString groupBackdrill =
_HKI(
"Backdrill" );
3180 const wxString groupPostMachining =
_HKI(
"Post-machining" );
3216 auto canHaveBackdrill =
3243 auto mode =
via->GetBackdrillMode();
3256 auto mode =
via->GetBackdrillMode();
3270 auto mode =
via->GetBackdrillMode();
3283 auto mode =
via->GetBackdrillMode();
3294 groupPostMachining )
3300 auto mode =
via->GetFrontPostMachining();
3309 groupPostMachining )
3315 auto mode =
via->GetFrontPostMachining();
3323 groupPostMachining )
3329 auto mode =
via->GetFrontPostMachining();
3340 groupPostMachining )
3346 auto mode =
via->GetBackPostMachining();
3355 groupPostMachining )
3361 auto mode =
via->GetBackPostMachining();
3369 groupPostMachining )
3375 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.
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 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_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.
Information pertinent to a Pcbnew printed circuit board.
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
int GetCopperLayerCount() 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.
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
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 IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
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.
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::...
DRILL_PROPS & SecondaryDrill()
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(PROPERTY_BASE *aProperty, const wxString &aGroup)
Replace an existing property.
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