56#include <api/board/board_types.pb.h>
60#include <magic_enum.hpp>
135 kiapi::board::types::Pad
pad;
139 pad.set_locked(
IsLocked() ? kiapi::common::types::LockedState::LS_LOCKED
140 : kiapi::common::types::LockedState::LS_UNLOCKED );
141 pad.mutable_net()->mutable_code()->set_value(
GetNetCode() );
144 kiapi::board::types::PadStack* padstack =
pad.mutable_pad_stack();
145 padstack->set_type( kiapi::board::types::PadStackType::PST_THROUGH );
146 padstack->set_start_layer(
147 ToProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>(
m_layer ) );
148 padstack->set_end_layer(
149 ToProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>(
FlipLayer(
m_layer ) ) );
151 { GetDrillSizeX(), GetDrillSizeY() } );
154 kiapi::board::types::PadStackLayer* stackLayer = padstack->add_layers();
157 { GetSizeX(), GetSizeY() } );
158 stackLayer->set_shape(
159 ToProtoEnum<PAD_SHAPE, kiapi::board::types::PadStackShape>(
GetShape() ) );
161 padstack->set_unconnected_layer_removal(
165 kiapi::board::types::DesignRuleOverrides* overrides =
pad.mutable_overrides();
179 overrides->set_zone_connection(
183 kiapi::board::types::ThermalSpokeSettings* thermals =
pad.mutable_thermal_spokes();
189 aContainer.PackFrom(
pad );
195 kiapi::board::types::Pad
pad;
197 if( !aContainer.UnpackTo( &
pad ) )
203 SetLocked(
pad.locked() == kiapi::common::types::LockedState::LS_LOCKED );
205 const kiapi::board::types::PadStack& padstack =
pad.pad_stack();
207 SetLayer( FromProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>(
208 padstack.start_layer() ) );
214 if( padstack.layers_size() == 1 )
216 const kiapi::board::types::PadStackLayer& layer = padstack.layers( 0 );
219 SetShape( FromProtoEnum<PAD_SHAPE>( layer.shape() ) );
223 FromProtoEnum<PADSTACK::UNCONNECTED_LAYER_MODE>( padstack.unconnected_layer_removal() ) );
225 const kiapi::board::types::DesignRuleOverrides& overrides =
pad.overrides();
227 if( overrides.has_clearance() )
232 if( overrides.has_solder_mask_margin() )
237 if( overrides.has_solder_paste_margin() )
242 if( overrides.has_solder_paste_margin_ratio() )
249 const kiapi::board::types::ThermalSpokeSettings& thermals =
pad.thermal_spokes();
289 int thisNetTieGroup = padToNetTieGroupMap[
GetNumber() ];
290 int otherNetTieGroup = padToNetTieGroupMap[ aOther->
GetNumber() ];
292 return thisNetTieGroup >= 0 && thisNetTieGroup == otherNetTieGroup;
301 return m_pinType.Contains( wxT(
"no_connect" ) );
427 && ( aLayer ==
F_Cu || aLayer ==
B_Cu ) )
440 else if( aOnlyCheckIfPermitted )
443 return board->GetConnectivity()->IsConnectedOnLayer(
this, aLayer, types );
495 return std::make_shared<SHAPE_NULL>();
502 if( flashPTHPads == FLASHING::NEVER_FLASHED )
504 else if( flashPTHPads == FLASHING::ALWAYS_FLASHED )
514 return std::make_shared<SHAPE_NULL>();
558 auto add = [
this](
SHAPE* aShape )
567 if(
GetShape() == PAD_SHAPE::CUSTOM )
570 switch( effectiveShape )
572 case PAD_SHAPE::CIRCLE:
576 case PAD_SHAPE::OVAL:
577 if( size.
x == size.
y )
584 int half_width = std::min( half_size.
x, half_size.
y );
585 VECTOR2I half_len( half_size.
x - half_width, half_size.
y - half_width );
587 add(
new SHAPE_SEGMENT( shapePos - half_len, shapePos + half_len, half_width * 2 ) );
592 case PAD_SHAPE::RECTANGLE:
593 case PAD_SHAPE::TRAPEZOID:
594 case PAD_SHAPE::ROUNDRECT:
608 if( half_size.
x < min_len && half_size.
y < min_len )
614 else if( effectiveShape == PAD_SHAPE::TRAPEZOID )
621 corners.
Append( -half_size.
x - trap_delta.
y, half_size.
y + trap_delta.
x );
622 corners.
Append( half_size.
x + trap_delta.
y, half_size.
y - trap_delta.
x );
623 corners.
Append( half_size.
x - trap_delta.
y, -half_size.
y + trap_delta.
x );
624 corners.
Append( -half_size.
x + trap_delta.
y, -half_size.
y - trap_delta.
x );
627 corners.
Move( shapePos );
667 case PAD_SHAPE::CHAMFERED_RECT:
680 wxFAIL_MSG( wxT(
"PAD::buildEffectiveShapes: Unsupported pad shape: PAD_SHAPE::" )
681 + wxString( std::string( magic_enum::enum_name( effectiveShape ) ) ) );
685 if(
GetShape() == PAD_SHAPE::CUSTOM )
689 if( !primitive->IsProxyItem() )
691 for(
SHAPE* shape : primitive->MakeEffectiveShapes() )
694 shape->Move( shapePos );
705 int half_width = std::min( half_size.
x, half_size.
y );
706 VECTOR2I half_len( half_size.
x - half_width, half_size.
y - half_width );
734 effectivePolygon = std::make_shared<SHAPE_POLY_SET>();
745 for(
int cnt = 0; cnt < effectivePolygon->OutlineCount(); ++cnt )
749 for(
int ii = 0; ii < poly.
PointCount(); ++ii )
781 case PAD_ATTRIB::PTH:
786 case PAD_ATTRIB::SMD:
787 case PAD_ATTRIB::CONN:
792 if( copperLayers.count() > 1 )
794 layerMask &=
~LSET::AllCuMask();
796 if( copperLayers.test(
B_Cu ) )
797 layerMask.set(
B_Cu );
799 layerMask.set( copperLayers.
Seq().front() );
807 case PAD_ATTRIB::NPTH:
871 auto mirrorBitFlags = [](
int& aBitfield,
int a,
int b )
873 bool temp = aBitfield & a;
917 primitive->Flip(
VECTOR2I( 0, 0 ), aFlipLeftRight );
947 case PAD_SHAPE::CIRCLE:
956 case PAD_SHAPE::OVAL:
980 *aSource =
_(
"pad" );
992 return parentFootprint->GetClearanceOverrides( aSource );
994 return std::optional<int>();
1034 if( !margin.has_value() )
1037 margin = parentFootprint->GetLocalSolderMaskMargin();
1040 if( !margin.has_value() )
1043 margin = brd->GetDesignSettings().m_SolderMaskExpansion;
1046 int marginValue = margin.value_or( 0 );
1049 if( marginValue < 0 )
1053 if( marginValue < minsize )
1054 marginValue = minsize;
1072 if( !margin.has_value() )
1075 margin = parentFootprint->GetLocalSolderPasteMargin();
1078 if( !margin.has_value() )
1081 margin = board->GetDesignSettings().m_SolderPasteMargin;
1084 if( !mratio.has_value() )
1087 mratio = parentFootprint->GetLocalSolderPasteMarginRatio();
1090 if( !mratio.has_value() )
1093 mratio = board->GetDesignSettings().m_SolderPasteMarginRatio;
1118 if( connection != ZONE_CONNECTION::INHERITED )
1121 *aSource =
_(
"pad" );
1124 if( connection == ZONE_CONNECTION::INHERITED )
1127 connection = parentFootprint->GetZoneConnectionOverrides( aSource );
1137 *aSource =
_(
"pad" );
1146 *aSource =
_(
"pad" );
1159 if( parentFootprint )
1160 aList.emplace_back(
_(
"Footprint" ), parentFootprint->
GetReference() );
1163 aList.emplace_back(
_(
"Pad" ),
m_number );
1169 aList.emplace_back(
_(
"Pin Type" ),
GetPinType() );
1175 aList.emplace_back(
_(
"Resolved Netclass" ),
1179 aList.emplace_back(
_(
"Status" ),
_(
"Locked" ) );
1190 double area = poly->Area();
1204 case PAD_PROP::NONE:
break;
1205 case PAD_PROP::BGA: props +=
_(
"BGA" );
break;
1206 case PAD_PROP::FIDUCIAL_GLBL: props +=
_(
"Fiducial global" );
break;
1207 case PAD_PROP::FIDUCIAL_LOCAL: props +=
_(
"Fiducial local" );
break;
1208 case PAD_PROP::TESTPOINT: props +=
_(
"Test point" );
break;
1209 case PAD_PROP::HEATSINK: props +=
_(
"Heat sink" );
break;
1210 case PAD_PROP::CASTELLATED: props +=
_(
"Castellated" );
break;
1211 case PAD_PROP::MECHANICAL: props +=
_(
"Mechanical" );
break;
1231 if( !fp_orient.
IsZero() )
1236 aList.emplace_back(
_(
"Rotation" ), msg );
1240 aList.emplace_back(
_(
"Length in Package" ),
1246 if( drill.
x > 0 || drill.
y > 0 )
1250 aList.emplace_back(
_(
"Hole" ),
1251 wxString::Format( wxT(
"%s" ),
1256 aList.emplace_back(
_(
"Hole X / Y" ),
1257 wxString::Format( wxT(
"%s / %s" ),
1266 if( !source.IsEmpty() )
1268 aList.emplace_back( wxString::Format(
_(
"Min Clearance: %s" ),
1270 wxString::Format(
_(
"(from %s)" ),
1294 BOX2I arect = aRect;
1313 int count = poly->TotalVertices();
1315 for(
int ii = 0; ii < count; ii++ )
1317 VECTOR2I vertex = poly->CVertex( ii );
1318 VECTOR2I vertexNext = poly->CVertex( ( ii + 1 ) % count );
1340 if( ( diff =
static_cast<int>( aPadRef->
GetShape() ) -
1341 static_cast<int>( aPadCmp->
GetShape() ) ) != 0 )
1344 if( ( diff =
static_cast<int>( aPadRef->
m_attribute ) -
1407#if __cplusplus >= 201103L
1418 std::string s1 = aPadRef->
GetLayerSet().to_string();
1419 std::string s2 = aPadCmp->
GetLayerSet().to_string();
1420 return s1.compare( s2 );
1440 case PAD_SHAPE::CIRCLE:
return _(
"Circle" );
1441 case PAD_SHAPE::OVAL:
return _(
"Oval" );
1442 case PAD_SHAPE::RECTANGLE:
return _(
"Rect" );
1443 case PAD_SHAPE::TRAPEZOID:
return _(
"Trap" );
1444 case PAD_SHAPE::ROUNDRECT:
return _(
"Roundrect" );
1445 case PAD_SHAPE::CHAMFERED_RECT:
return _(
"Chamferedrect" );
1446 case PAD_SHAPE::CUSTOM:
return _(
"CustomShape" );
1447 default:
return wxT(
"???" );
1456 case PAD_ATTRIB::PTH:
return _(
"PTH" );
1457 case PAD_ATTRIB::SMD:
return _(
"SMD" );
1458 case PAD_ATTRIB::CONN:
return _(
"Conn" );
1459 case PAD_ATTRIB::NPTH:
return _(
"NPTH" );
1460 default:
return wxT(
"???" );
1471 return wxString::Format(
_(
"Pad %s of %s on %s" ),
1482 return wxString::Format(
_(
"PTH pad %s of %s" ),
1491 return wxString::Format(
_(
"Pad %s %s of %s on %s" ),
1503 return wxString::Format(
_(
"PTH pad %s %s of %s" ),
1514 return BITMAPS::pad;
1520 return new PAD( *
this );
1570 for (
int internal =
In1_Cu; internal <
In30_Cu; ++internal )
1573 aLayers[aCount++] = internal;
1585 aLayers[aCount++] = each_layer;
1592 constexpr double HIDE = std::numeric_limits<double>::max();
1670 if( cfg && cfg->m_Display.m_PadClearance &&
GetBoard() )
1675 int xMargin = std::max( solderMaskMargin, solderPasteMargin.
x ) + clearance;
1676 int yMargin = std::max( solderMaskMargin, solderPasteMargin.
y ) + clearance;
1727 case PAD_SHAPE::TRAPEZOID:
1731 case PAD_SHAPE::CIRCLE:
1742 case PAD_ATTRIB::SMD:
1743 case PAD_ATTRIB::CONN:
1779 std::swap( *
this, *
static_cast<PAD*
>( aImage ) );
1788 if( !drillsize.
x || !drillsize.
y )
1794 slot->GetWidth() + aClearance * 2, aError, aErrorLoc );
1801 int aMaxError,
ERROR_LOC aErrorLoc,
bool ignoreLineWidth )
const
1803 wxASSERT_MSG( !ignoreLineWidth, wxT(
"IgnoreLineWidth has no meaning for pads." ) );
1808 const int pad_min_seg_per_circle_count = 16;
1817 case PAD_SHAPE::CIRCLE:
1818 case PAD_SHAPE::OVAL:
1820 if( dx == dy || (
GetShape() == PAD_SHAPE::CIRCLE ) )
1823 pad_min_seg_per_circle_count );
1827 int half_width = std::min( dx, dy );
1833 ( half_width + aClearance ) * 2, aMaxError, aErrorLoc,
1834 pad_min_seg_per_circle_count );
1839 case PAD_SHAPE::TRAPEZOID:
1840 case PAD_SHAPE::RECTANGLE:
1847 aMaxError, aErrorLoc );
1848 aBuffer.
Append( outline );
1852 case PAD_SHAPE::CHAMFERED_RECT:
1853 case PAD_SHAPE::ROUNDRECT:
1855 bool doChamfer =
GetShape() == PAD_SHAPE::CHAMFERED_RECT;
1862 aClearance, aMaxError, aErrorLoc );
1863 aBuffer.
Append( outline );
1867 case PAD_SHAPE::CUSTOM:
1877 aClearance += aMaxError;
1879 outline.
Inflate( aClearance, CORNER_STRATEGY::ROUND_ALL_CORNERS, aMaxError );
1882 else if( aClearance < 0 )
1888 outline.
Inflate( aClearance, CORNER_STRATEGY::ALLOW_ACUTE_CORNERS, aMaxError );
1892 aBuffer.
Append( outline );
1897 wxFAIL_MSG( wxT(
"PAD::TransformShapeToPolygon no implementation for " )
1898 + wxString( std::string( magic_enum::enum_name(
GetShape() ) ) ) );
1912 const PAD& other =
static_cast<const PAD&
>( aOther );
2004 const PAD& other =
static_cast<const PAD&
>( aOther );
2006 double similarity = 1.0;
2089 .Map( PAD_ATTRIB::PTH,
_HKI(
"Through-hole" ) )
2090 .Map( PAD_ATTRIB::SMD,
_HKI(
"SMD" ) )
2091 .Map( PAD_ATTRIB::CONN,
_HKI(
"Edge connector" ) )
2092 .Map( PAD_ATTRIB::NPTH,
_HKI(
"NPTH, mechanical" ) );
2095 .Map( PAD_SHAPE::CIRCLE,
_HKI(
"Circle" ) )
2096 .Map( PAD_SHAPE::RECTANGLE,
_HKI(
"Rectangle" ) )
2097 .Map( PAD_SHAPE::OVAL,
_HKI(
"Oval" ) )
2098 .Map( PAD_SHAPE::TRAPEZOID,
_HKI(
"Trapezoid" ) )
2099 .Map( PAD_SHAPE::ROUNDRECT,
_HKI(
"Rounded rectangle" ) )
2100 .Map( PAD_SHAPE::CHAMFERED_RECT,
_HKI(
"Chamfered rectangle" ) )
2101 .Map( PAD_SHAPE::CUSTOM,
_HKI(
"Custom" ) );
2104 .Map( PAD_PROP::NONE,
_HKI(
"None" ) )
2105 .Map( PAD_PROP::BGA,
_HKI(
"BGA pad" ) )
2106 .Map( PAD_PROP::FIDUCIAL_GLBL,
_HKI(
"Fiducial, global to board" ) )
2107 .Map( PAD_PROP::FIDUCIAL_LOCAL,
_HKI(
"Fiducial, local to footprint" ) )
2108 .Map( PAD_PROP::TESTPOINT,
_HKI(
"Test point pad" ) )
2109 .Map( PAD_PROP::HEATSINK,
_HKI(
"Heatsink pad" ) )
2110 .Map( PAD_PROP::CASTELLATED,
_HKI(
"Castellated pad" ) )
2111 .Map( PAD_PROP::MECHANICAL,
_HKI(
"Mechanical pad" ) );
2115 if( zcMap.
Choices().GetCount() == 0 )
2117 zcMap.
Undefined( ZONE_CONNECTION::INHERITED );
2118 zcMap.
Map( ZONE_CONNECTION::INHERITED,
_HKI(
"Inherited" ) )
2119 .
Map( ZONE_CONNECTION::NONE,
_HKI(
"None" ) )
2120 .
Map( ZONE_CONNECTION::THERMAL,
_HKI(
"Thermal reliefs" ) )
2121 .
Map( ZONE_CONNECTION::FULL,
_HKI(
"Solid" ) )
2122 .
Map( ZONE_CONNECTION::THT_THERMAL,
_HKI(
"Thermal reliefs for PTH" ) );
2129 _HKI(
"Front, back and connected layers" ) );
2139 PROPERTY_DISPLAY::PT_DEGREE ) );
2144 if(
PAD*
pad =
dynamic_cast<PAD*
>( aItem ) )
2145 return pad->GetAttribute() != PAD_ATTRIB::NPTH;
2150 auto padCanHaveHole =
2153 if(
PAD*
pad =
dynamic_cast<PAD*
>( aItem ) )
2155 return pad->GetAttribute() == PAD_ATTRIB::PTH
2156 ||
pad->GetAttribute() == PAD_ATTRIB::NPTH;
2163 _HKI(
"Net" ), isCopperPad );
2165 _HKI(
"Net Class" ), isCopperPad );
2167 const wxString groupPad =
_HKI(
"Pad Properties" );
2179 padNumber->SetAvailableFunc( isCopperPad );
2191 PROPERTY_DISPLAY::PT_SIZE ), groupPad );
2194 PROPERTY_DISPLAY::PT_SIZE ), groupPad )
2199 if(
PAD*
pad =
dynamic_cast<PAD*
>( aItem ) )
2200 return pad->GetShape() != PAD_SHAPE::CIRCLE;
2207 roundRadiusRatio->SetAvailableFunc(
2210 if(
PAD*
pad =
dynamic_cast<PAD*
>( aItem ) )
2211 return pad->GetShape() == PAD_SHAPE::ROUNDRECT;
2215 propMgr.
AddProperty( roundRadiusRatio, groupPad );
2219 PROPERTY_DISPLAY::PT_SIZE ), groupPad )
2225 PROPERTY_DISPLAY::PT_SIZE ), groupPad )
2233 _HKI(
"Copper Layers" ),
2239 PROPERTY_DISPLAY::PT_SIZE );
2240 padToDie->SetAvailableFunc( isCopperPad );
2243 const wxString groupOverrides =
_HKI(
"Overrides" );
2246 _HKI(
"Clearance Override" ),
2248 PROPERTY_DISPLAY::PT_SIZE ), groupOverrides );
2251 _HKI(
"Soldermask Margin Override" ),
2253 PROPERTY_DISPLAY::PT_SIZE ), groupOverrides );
2256 _HKI(
"Solderpaste Margin Override" ),
2258 PROPERTY_DISPLAY::PT_SIZE ), groupOverrides );
2261 _HKI(
"Solderpaste Margin Ratio Override" ),
2263 PROPERTY_DISPLAY::PT_RATIO ),
2267 _HKI(
"Zone Connection Style" ),
2274 PROPERTY_DISPLAY::PT_SIZE ), groupOverrides )
2275 .
SetValidator( PROPERTY_VALIDATORS::RangeIntValidator<minZoneWidth, INT_MAX> );
2279 PROPERTY_DISPLAY::PT_DEGREE ), groupOverrides );
2283 PROPERTY_DISPLAY::PT_SIZE ), groupOverrides )
types::KiCadObjectType ToProtoEnum(KICAD_T aValue)
constexpr int ARC_HIGH_DEF
constexpr EDA_IU_SCALE pcbIUScale
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
BITMAPS
A list of all bitmap identifiers.
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.
bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.
wxString GetNetname() const
TEARDROP_PARAMETERS m_teardropParams
Not all BOARD_CONNECTED_ITEMs support teardrops, but we want those that do to share a single section ...
wxString GetShortNetname() const
Container for design settings for a BOARD object.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
virtual void SetLocked(bool aLocked)
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
virtual bool IsLocked() const
BOARD_ITEM_CONTAINER * GetParent() const
virtual wxString layerMaskDescribe() const
Return a string (to be shown to the user) describing a layer mask.
Information pertinent to a Pcbnew printed circuit board.
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
int GetMaxClearanceValue() const
Returns the maximum clearance value for any object on the board.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
const Vec & GetOrigin() const
const SizeVec & GetSize() const
bool Intersects(const BOX2< Vec > &aRect) const
bool Contains(const Vec &aPoint) const
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Modify the position and size of the rectangle in order to contain aRect.
MINOPTMAX< int > & Value()
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
virtual VECTOR2I GetPosition() const
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 * m_parent
Linked list: Link (parent struct)
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
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
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.
wxString AsString() const
std::string AsStdString() const
LSET is a set of PCB_LAYER_IDs.
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
static LSET FrontBoardTechMask()
Return a mask holding technical layers used in a board fabrication (no CU layer) on front side.
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
static LSET PhysicalLayersMask()
Return a mask holding all layers which are physically realized.
static LSET BackBoardTechMask()
Return a mask holding technical layers used in a board fabrication (no CU layer) on Back side.
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
void SetRoundRectRadius(double aRadius, PCB_LAYER_ID aLayer=F_Cu)
std::optional< int > & Clearance(PCB_LAYER_ID aLayer=F_Cu)
void SetChamferRatio(double aRatio, PCB_LAYER_ID aLayer=F_Cu)
void SetChamferPositions(int aPositions, PCB_LAYER_ID aLayer=F_Cu)
std::optional< double > & SolderPasteMarginRatio(PCB_LAYER_ID aLayer=F_Cu)
void SetRoundRectRadiusRatio(double aRatio, PCB_LAYER_ID aLayer=F_Cu)
std::optional< int > & ThermalSpokeWidth(PCB_LAYER_ID aLayer=F_Cu)
std::optional< int > & SolderPasteMargin(PCB_LAYER_ID aLayer=F_Cu)
std::optional< int > & SolderMaskMargin(PCB_LAYER_ID aLayer=F_Cu)
const LSET & LayerSet() const
int RoundRectRadius(PCB_LAYER_ID aLayer=F_Cu) const
int & ChamferPositions(PCB_LAYER_ID aLayer=F_Cu)
UNCONNECTED_LAYER_MODE UnconnectedLayerMode() const
std::optional< int > & ThermalGap(PCB_LAYER_ID aLayer=F_Cu)
double RoundRectRadiusRatio(PCB_LAYER_ID aLayer=F_Cu) const
VECTOR2I & TrapezoidDeltaSize(PCB_LAYER_ID aLayer=F_Cu)
VECTOR2I & Offset(PCB_LAYER_ID aLayer=F_Cu)
VECTOR2I & Size(PCB_LAYER_ID aLayer=F_Cu)
UNCONNECTED_LAYER_MODE
! Whether or not to remove the copper shape for unconnected layers
@ REMOVE_EXCEPT_START_AND_END
double ChamferRatio(PCB_LAYER_ID aLayer=F_Cu) const
PAD_SHAPE Shape(PCB_LAYER_ID aLayer=F_Cu) const
void SetLayerSet(const LSET &aSet)
std::optional< ZONE_CONNECTION > & ZoneConnection(PCB_LAYER_ID aLayer=F_Cu)
bool IsAperturePad() const
void SetAttribute(PAD_ATTRIB aAttribute)
int GetOwnClearance(PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const override
Return the pad's "own" clearance in internal units.
void SetLayerSet(LSET aLayers) override
virtual void swapData(BOARD_ITEM *aImage) override
PAD_PROP GetProperty() const
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
std::optional< int > GetClearanceOverrides(wxString *aSource) const override
Return any clearance overrides set in the "classic" (ie: pre-rule) system.
void SetPinType(const wxString &aType)
Set the pad electrical type.
LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
bool FlashLayer(int aLayer, bool aOnlyCheckIfPermitted=false) const
Check to see whether the pad should be flashed on the specific layer.
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.
const BOX2I GetBoundingBox() const override
The bounding box is cached, so this will be efficient most of the time.
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
int GetSolderMaskExpansion() const
int GetDrillSizeY() const
std::optional< double > GetLocalSolderPasteMarginRatio() const
const wxString & GetPinType() const
const VECTOR2I & GetDrillSize() const
PAD_ATTRIB GetAttribute() const
static LSET PTHMask()
layer set for a through hole pad
static int Compare(const PAD *aPadRef, const PAD *aPadCmp)
Compare two pads and return 0 if they are equal.
void SetUnconnectedLayerMode(PADSTACK::UNCONNECTED_LAYER_MODE aMode)
const wxString & GetPinFunction() const
void BuildEffectiveShapes(PCB_LAYER_ID aLayer) const
Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit.
std::mutex m_shapesBuildingLock
void SetThermalGap(int aGap)
std::shared_ptr< SHAPE_POLY_SET > m_effectivePolygon[2]
bool CanHaveNumber() const
Indicates whether or not the pad can have a number.
void SetThermalSpokeAngle(const EDA_ANGLE &aAngle)
The orientation of the thermal spokes.
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
const wxString & GetNumber() const
void FlipPrimitives(bool aFlipLeftRight)
Flip (mirror) the primitives left to right or top to bottom, around the anchor position in custom pad...
void MergePrimitivesAsPolygon(SHAPE_POLY_SET *aMergedPolygon, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
Merge all basic shapes to a SHAPE_POLY_SET.
int GetRoundRectCornerRadius() const
std::vector< std::shared_ptr< PCB_SHAPE > > m_editPrimitives
void SetLocalSolderPasteMarginRatio(std::optional< double > aRatio)
PAD & operator=(const PAD &aOther)
std::shared_ptr< SHAPE_SEGMENT > m_effectiveHoleShape
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
bool IsLocked() const override
VECTOR2I GetPosition() const override
void SetProperty(PAD_PROP aProperty)
void SetThermalSpokeAngleDegrees(double aAngle)
const std::vector< std::shared_ptr< PCB_SHAPE > > & GetPrimitives() const
Accessor to the basic shape list for custom-shaped pads.
EDA_ANGLE GetThermalSpokeAngle() const
bool operator==(const BOARD_ITEM &aOther) const override
void SetOffset(const VECTOR2I &aOffset)
PCB_LAYER_ID GetPrincipalLayer() const
void SetChamferRectRatio(double aChamferScale)
Has meaning only for chamfered rectangular pads.
const VECTOR2I & GetOffset() const
static LSET UnplatedHoleMask()
layer set for a mechanical unplated through hole pad
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
double GetOrientationDegrees() const
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
void SetRoundRectCornerRadius(double aRadius)
Has meaning only for rounded rectangle pads.
bool IsNoConnectPad() const
int GetDrillSizeX() const
VECTOR2I ShapePos() const
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE, bool ignoreLineWidth=false) const override
Convert the pad shape to a closed polygon.
void SetNumber(const wxString &aNumber)
Set the pad number (note that it can be alphanumeric, such as the array reference "AA12").
int GetLocalThermalGapOverride(wxString *aSource=nullptr) const
wxString ShowPadAttr() const
wxString ShowPadShape() const
void SetDrillShape(PAD_DRILL_SHAPE aShape)
int m_effectiveBoundingRadius
void SetLocalSolderMaskMargin(std::optional< int > aMargin)
const std::shared_ptr< SHAPE_POLY_SET > & GetEffectivePolygon(ERROR_LOC aErrorLoc=ERROR_INSIDE) const
void SetLocalZoneConnection(ZONE_CONNECTION aType)
std::optional< int > GetLocalClearance() const override
Return any local clearances set in the "classic" (ie: pre-rule) system.
void ImportSettingsFrom(const PAD &aMasterPad)
Import the pad settings from aMasterPad.
double Similarity(const BOARD_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
void SetDelta(const VECTOR2I &aSize)
bool IsOnCopperLayer() const override
void SetDrillSizeX(const int aX)
void SetPadstack(const PADSTACK &aPadstack)
void SetPosition(const VECTOR2I &aPos) override
const PADSTACK & Padstack() const
const VECTOR2I & GetDelta() const
void BuildEffectivePolygon(ERROR_LOC aErrorLoc=ERROR_INSIDE) const
static LSET ConnSMDMask()
layer set for a SMD pad on Front layer used for edge board connectors
void SetDrillSize(const VECTOR2I &aSize)
PAD_SHAPE GetShape() const
EDA_ANGLE GetOrientation() const
Return the rotation angle of the pad.
PADSTACK::CUSTOM_SHAPE_ZONE_MODE GetCustomShapeInZoneOpt() const
PAD_DRILL_SHAPE GetDrillShape() const
void Flip(const VECTOR2I &VECTOR2I, bool aFlipLeftRight) override
Flip this object, i.e.
VECTOR2I GetSolderPasteMargin() const
Usually < 0 (mask shape smaller than pad)because the margin can be dependent on the pad size,...
static LSET ApertureMask()
layer set for an aperture pad
virtual const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
std::mutex m_polyBuildingLock
static LSET SMDMask()
layer set for a SMD pad on Front layer
std::optional< int > GetLocalSolderPasteMargin() const
std::optional< int > GetLocalSolderMaskMargin() const
void SetLocalSolderPasteMargin(std::optional< int > aMargin)
void SetShape(PAD_SHAPE aShape)
Set the new shape of this pad.
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
int GetThermalSpokeWidth() const
void SetPinFunction(const wxString &aName)
Set the pad function (pin name in schematic)
EDA_ANGLE GetFPRelativeOrientation() const
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
void SetFPRelativeOrientation(const EDA_ANGLE &aAngle)
void SetCustomShapeInZoneOpt(PADSTACK::CUSTOM_SHAPE_ZONE_MODE aOption)
Set the option for the custom pad shape to use as clearance area in copper zones.
int GetBoundingRadius() const
Return the radius of a minimum sized circle which fully encloses this pad.
void SetRoundRectRadiusRatio(double aRadiusScale)
Has meaning only for rounded rectangle pads.
void SetAnchorPadShape(PAD_SHAPE aShape)
Set the shape of the anchor pad for custom shaped pads.
std::array< ZONE_LAYER_OVERRIDE, MAX_CU_LAYERS > m_zoneLayerOverrides
void SetOrientation(const EDA_ANGLE &aAngle)
Set the rotation angle of the pad.
PADSTACK::UNCONNECTED_LAYER_MODE GetUnconnectedLayerMode() const
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
int GetChamferPositions() const
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
void ReplacePrimitives(const std::vector< std::shared_ptr< PCB_SHAPE > > &aPrimitivesList)
Clear the current custom shape primitives list and import a new list.
void SetLocalClearance(std::optional< int > aClearance)
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING flashPTHPads=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
int GetSubRatsnest() const
void SetSizeX(const int aX)
ZONE_CONNECTION GetLocalZoneConnection() const
void SetThermalSpokeWidth(int aWidth)
Set the width of the thermal spokes connecting the pad to a zone.
void SetSize(const VECTOR2I &aSize)
void SetDrillSizeY(const int aY)
double GetThermalSpokeAngleDegrees() const
double GetRoundRectRadiusRatio() const
int GetThermalGap() const
std::shared_ptr< SHAPE_SEGMENT > GetEffectiveHoleShape() const override
Return a SHAPE_SEGMENT object representing the pad's hole.
void SetOrientationDegrees(double aOrientation)
ZONE_CONNECTION GetZoneConnectionOverrides(wxString *aSource=nullptr) const
bool SharesNetTieGroup(const PAD *aOther) const
const VECTOR2I & GetSize() const
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
void SetSubRatsnest(int aSubRatsnest)
std::shared_ptr< SHAPE_COMPOUND > m_effectiveShape
void SetChamferPositions(int aPositions)
Has meaning only for chamfered rectangular pads.
int GetLocalSpokeWidthOverride(wxString *aSource=nullptr) const
PAD_SHAPE GetAnchorPadShape() const
bool TransformHoleToPolygon(SHAPE_POLY_SET &aBuffer, int aClearance, int aError, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
Build the corner list of the polygonal drill shape in the board coordinate system.
double GetChamferRectRatio() const
void SetPadToDieLength(int aLength)
void SetSizeY(const int aY)
int GetPadToDieLength() const
BOX2I m_effectiveBoundingBox
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
PROPERTY_BASE & SetWriteableFunc(std::function< bool(INSPECTABLE *)> aFunc)
PROPERTY_BASE & SetValidator(PROPERTY_VALIDATOR_FN &&aValidator)
PROPERTY_BASE & SetIsHiddenFromLibraryEditors(bool aIsHidden=true)
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.
void OverrideAvailability(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName, std::function< bool(INSPECTABLE *)> aFunc)
Sets an override availability functor for a base class property of a given derived class.
static VALIDATOR_RESULT PositiveIntValidator(const wxAny &&aValue, EDA_ITEM *aItem)
static SEG::ecoord Square(int a)
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
void Move(const VECTOR2I &aVector) override
int PointCount() const
Return the number of points (vertices) in this line chain.
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
Represent a set of closed polygons.
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
void Fracture(POLYGON_MODE aFastMode)
Convert a set of polygons with holes to a single outline with "slits"/"fractures" connecting the oute...
void Inflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, bool aSimplify=false)
Perform outline inflation/deflation.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)
void Move(const VECTOR2I &aVector) override
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.
An abstract shape on 2D plane.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
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 TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aBuffer, const VECTOR2I &aPosition, const VECTOR2I &aSize, const EDA_ANGLE &aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aInflate, int aError, ERROR_LOC aErrorLoc)
Convert a rectangle with rounded corners and/or chamfered corners to a polygon.
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.
void TransformTrapezoidToPolygon(SHAPE_POLY_SET &aBuffer, const VECTOR2I &aPosition, const VECTOR2I &aSize, const EDA_ANGLE &aRotation, int aDeltaX, int aDeltaY, int aInflate, int aError, ERROR_LOC aErrorLoc)
Convert a rectangle or trapezoid to a polygon.
@ RECT_CHAMFER_BOTTOM_RIGHT
@ RECT_CHAMFER_BOTTOM_LEFT
@ HOLE_CLEARANCE_CONSTRAINT
static constexpr EDA_ANGLE ANGLE_0
#define FOOTPRINT_EDIT_FRAME_NAME
#define PCB_EDIT_FRAME_NAME
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
Some functions to handle hotkeys in KiCad.
@ LAYER_PAD_FR_NETNAMES
Additional netnames layers (not associated with a PCB layer)
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...
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
@ LAYER_FOOTPRINTS_FR
show footprints on front
@ LAYER_NON_PLATEDHOLES
handle color for not plated holes (holes, not pads)
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored)
@ LAYER_PAD_PLATEDHOLES
to draw pad holes (plated)
@ LAYER_FOOTPRINTS_BK
show footprints on back
@ LAYER_PADS_SMD_BK
smd pads, back layer
@ LAYER_PADS_TH
multilayer pads, usually with holes
@ LAYER_PADS_SMD_FR
smd pads, front layer
bool IsNetnameLayer(int aLayer)
Test whether a layer is a netname layer.
bool IsHoleLayer(int aLayer)
PCB_LAYER_ID
A quick note on layer IDs:
LSET FlipLayerMask(LSET aMask, int aCopperLayersCount)
Calculate the mask layer when flipping a footprint.
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
This file contains miscellaneous commonly used macros and functions.
void MIRROR(T &aPoint, const T &aMirrorRef)
Updates aPoint with the mirror of aPoint relative to the aMirrorRef.
Message panel definition file.
constexpr int Mils2IU(const EDA_IU_SCALE &aIuScale, int mils)
T clamp(T min, T value, T max)
void PackLayerSet(google::protobuf::RepeatedField< int > &aOutput, const LSET &aLayerSet)
LSET UnpackLayerSet(const google::protobuf::RepeatedField< int > &aProtoLayerSet)
void PackVector2(kiapi::common::types::Vector2 &aOutput, const VECTOR2I aInput)
VECTOR2I UnpackVector2(const types::Vector2 &aInput)
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
static struct PAD_DESC _PAD_DESC
PAD_ATTRIB
The set of pad shapes, used with PAD::{Set,Get}Attribute().
PAD_SHAPE
The set of pad shapes, used with PAD::{Set,Get}Shape()
PAD_PROP
The set of pad properties used in Gerber files (Draw files, and P&P files) to define some properties ...
#define NO_SETTER(owner, type)
#define ENUM_TO_WXANY(type)
Macro to define read-only fields (no setter method available)
wxString UnescapeString(const wxString &aSource)
constexpr int mmToIU(double mm) const
VECTOR2I size
Drill diameter (x == y) or slot dimensions (x != y)
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.
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ 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)
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
VECTOR2< double > VECTOR2D
ZONE_CONNECTION
How pads are covered by copper in zone.
#define ZONE_THICKNESS_MIN_VALUE_MM