26#include <api/board/board_types.pb.h>
29#include <magic_enum.hpp>
75 for( std::shared_ptr<PCB_SHAPE>& shape :
CopperLayer( aLayer ).custom_shapes )
169 bool copperMatches =
true;
175 copperMatches =
false;
178 return copperMatches;
205 if( aProto.chamfered_corners().top_left() )
208 if( aProto.chamfered_corners().top_right() )
211 if( aProto.chamfered_corners().bottom_left() )
214 if( aProto.chamfered_corners().bottom_right() )
218 google::protobuf::Any a;
220 for(
const BoardGraphicShape& shapeProto : aProto.custom_shapes() )
222 a.PackFrom( shapeProto );
223 std::unique_ptr<PCB_SHAPE> shape = std::make_unique<PCB_SHAPE>(
m_parent );
225 if( shape->Deserialize( a ) )
238 auto unpackOptional = []<
typename ProtoEnum>(
const ProtoEnum& aProto,
239 std::optional<bool>& aDest, ProtoEnum aTrueValue,
240 ProtoEnum aFalseValue )
242 if( aProto == aTrueValue )
244 else if( aProto == aFalseValue )
247 aDest = std::nullopt;
250 auto unpackPostMachining = [](
const PostMachiningProperties& aProto,
253 switch( aProto.mode() )
258 default: aDest.mode = std::nullopt;
break;
261 aDest.size = aProto.size();
262 aDest.depth = aProto.depth();
263 aDest.angle = aProto.angle();
266 if( !aContainer.UnpackTo( &padstack ) )
276 unpackOptional( padstack.drill().capped(),
Drill().is_capped, VDCM_CAPPED, VDCM_UNCAPPED );
277 unpackOptional( padstack.drill().filled(),
Drill().is_filled, VDFM_FILLED, VDFM_UNFILLED );
279 if( padstack.has_front_post_machining() )
282 if( padstack.has_back_post_machining() )
287 if( padstack.has_secondary_drill() )
289 const DrillProperties& secondary = padstack.secondary_drill();
296 unpackOptional( secondary.capped(),
SecondaryDrill().is_capped, VDCM_CAPPED, VDCM_UNCAPPED );
297 unpackOptional( secondary.filled(),
SecondaryDrill().is_filled, VDFM_FILLED, VDFM_UNFILLED );
309 if( padstack.has_tertiary_drill() )
311 const DrillProperties& tertiary = padstack.tertiary_drill();
318 unpackOptional( tertiary.capped(),
TertiaryDrill().is_capped, VDCM_CAPPED, VDCM_UNCAPPED );
319 unpackOptional( tertiary.filled(),
TertiaryDrill().is_filled, VDFM_FILLED, VDFM_UNFILLED );
331 for(
const PadStackLayer& layer : padstack.copper_layers() )
340 if( padstack.has_zone_settings() )
345 if( padstack.zone_settings().has_thermal_spokes() )
347 const ThermalSpokeSettings& thermals = padstack.zone_settings().thermal_spokes();
349 if( thermals.has_gap() )
352 if( thermals.has_width() )
367 unpackOptional( padstack.front_outer_layers().solder_mask_mode(),
370 unpackOptional( padstack.back_outer_layers().solder_mask_mode(),
373 unpackOptional( padstack.front_outer_layers().covering_mode(),
FrontOuterLayers().has_covering,
374 VCM_COVERED, VCM_UNCOVERED );
376 unpackOptional( padstack.back_outer_layers().covering_mode(),
BackOuterLayers().has_covering,
377 VCM_COVERED, VCM_UNCOVERED );
379 unpackOptional( padstack.front_outer_layers().plugging_mode(),
FrontOuterLayers().has_plugging,
380 VPM_PLUGGED, VPM_UNPLUGGED );
382 unpackOptional( padstack.back_outer_layers().plugging_mode(),
BackOuterLayers().has_plugging,
383 VPM_PLUGGED, VPM_UNPLUGGED );
385 unpackOptional( padstack.front_outer_layers().solder_paste_mode(),
388 unpackOptional( padstack.back_outer_layers().solder_paste_mode(),
391 if( padstack.front_outer_layers().has_solder_mask_settings()
392 && padstack.front_outer_layers().solder_mask_settings().has_solder_mask_margin() )
395 padstack.front_outer_layers().solder_mask_settings().solder_mask_margin().value_nm();
402 if( padstack.back_outer_layers().has_solder_mask_settings()
403 && padstack.back_outer_layers().solder_mask_settings().has_solder_mask_margin() )
406 padstack.back_outer_layers().solder_mask_settings().solder_mask_margin().value_nm();
413 if( padstack.front_outer_layers().has_solder_paste_settings()
414 && padstack.front_outer_layers().solder_paste_settings().has_solder_paste_margin() )
417 padstack.front_outer_layers().solder_paste_settings().solder_paste_margin().value_nm();
424 if( padstack.back_outer_layers().has_solder_paste_settings()
425 && padstack.back_outer_layers().solder_paste_settings().has_solder_paste_margin() )
428 padstack.back_outer_layers().solder_paste_settings().solder_paste_margin().value_nm();
435 if( padstack.front_outer_layers().has_solder_paste_settings()
436 && padstack.front_outer_layers().solder_paste_settings().has_solder_paste_margin_ratio() )
439 padstack.front_outer_layers().solder_paste_settings().solder_paste_margin_ratio().value();
446 if( padstack.back_outer_layers().has_solder_paste_settings()
447 && padstack.back_outer_layers().solder_paste_settings().has_solder_paste_margin_ratio() )
450 padstack.back_outer_layers().solder_paste_settings().solder_paste_margin_ratio().value();
467 if( !hasSecondary && !hasTertiary )
470 if( hasSecondary && hasTertiary )
497 if( aDrill.
size.
x <= 0 )
501 aDrill.
start = aStart;
506 aDrill.
start = aStart;
580 if( aSize.has_value() )
582 target->
size = { *aSize, *aSize };
589 target->
size = { 0, 0 };
627 target->
end = aLayer;
638 padstack.mutable_angle()->set_value_degrees(
m_orientation.AsDegrees() );
645 if(
m_drill.is_capped.has_value() )
646 padstack.mutable_drill()->set_capped(
m_drill.is_capped.value() ? VDCM_CAPPED : VDCM_UNCAPPED );
648 if(
m_drill.is_filled.has_value() )
649 padstack.mutable_drill()->set_filled(
m_drill.is_filled.value() ? VDFM_FILLED : VDFM_UNFILLED );
653 DrillProperties* secondary = padstack.mutable_secondary_drill();
660 secondary->set_capped(
m_secondaryDrill.is_capped.value() ? VDCM_CAPPED : VDCM_UNCAPPED );
663 secondary->set_filled(
m_secondaryDrill.is_filled.value() ? VDFM_FILLED : VDFM_UNFILLED );
668 DrillProperties* tertiary = padstack.mutable_tertiary_drill();
675 tertiary->set_capped(
m_tertiaryDrill.is_capped.value() ? VDCM_CAPPED : VDCM_UNCAPPED );
678 tertiary->set_filled(
m_tertiaryDrill.is_filled.value() ? VDFM_FILLED : VDFM_UNFILLED );
682 PostMachiningProperties* aProto )
684 if( aProps.
mode.has_value() )
686 switch( aProps.
mode.value() )
695 aProto->set_size( aProps.
size );
696 aProto->set_depth( aProps.
depth );
697 aProto->set_angle( aProps.
angle );
709 PadStackLayer* layer = padstack.add_copper_layers();
724 layer->mutable_chamfered_corners()->set_top_left(
true );
727 layer->mutable_chamfered_corners()->set_top_right(
true );
730 layer->mutable_chamfered_corners()->set_bottom_left(
true );
733 layer->mutable_chamfered_corners()->set_bottom_right(
true );
735 for(
const std::shared_ptr<PCB_SHAPE>& shape : props.
custom_shapes )
737 google::protobuf::Any a;
738 shape->Serialize( a );
739 a.UnpackTo( layer->add_custom_shapes() );
745 padstack.mutable_zone_settings()->set_zone_connection(
751 padstack.mutable_zone_settings()->mutable_thermal_spokes()->mutable_gap()->set_value_nm(
757 padstack.mutable_zone_settings()->mutable_thermal_spokes()->mutable_width()->set_value_nm(
763 padstack.mutable_zone_settings()->mutable_thermal_spokes()->mutable_angle()->set_value_degrees(
772 padstack.mutable_front_outer_layers()->set_solder_mask_mode(
778 padstack.mutable_back_outer_layers()->set_solder_mask_mode(
779 BackOuterLayers().has_solder_mask.value() ? SMM_MASKED : SMM_UNMASKED );
784 padstack.mutable_front_outer_layers()->set_covering_mode(
790 padstack.mutable_back_outer_layers()->set_covering_mode(
791 BackOuterLayers().has_covering.value() ? VCM_COVERED : VCM_UNCOVERED );
796 padstack.mutable_front_outer_layers()->set_plugging_mode(
802 padstack.mutable_back_outer_layers()->set_plugging_mode(
803 BackOuterLayers().has_plugging.value() ? VPM_PLUGGED : VPM_UNPLUGGED );
808 padstack.mutable_front_outer_layers()->set_solder_paste_mode(
814 padstack.mutable_back_outer_layers()->set_solder_paste_mode(
815 BackOuterLayers().has_solder_paste.value() ? SPM_PASTE : SPM_NO_PASTE );
820 padstack.mutable_front_outer_layers()->mutable_solder_mask_settings()->mutable_solder_mask_margin()->set_value_nm(
826 padstack.mutable_back_outer_layers()->mutable_solder_mask_settings()->mutable_solder_mask_margin()->set_value_nm(
832 padstack.mutable_front_outer_layers()->mutable_solder_paste_settings()->mutable_solder_paste_margin()->set_value_nm(
838 padstack.mutable_back_outer_layers()->mutable_solder_paste_settings()->mutable_solder_paste_margin()->set_value_nm(
844 padstack.mutable_front_outer_layers()->mutable_solder_paste_settings()->mutable_solder_paste_margin_ratio()->set_value(
850 padstack.mutable_back_outer_layers()->mutable_solder_paste_settings()->mutable_solder_paste_margin_ratio()->set_value(
854 aContainer.PackFrom( padstack );
960 int min_r = std::min( size.
x, size.
y );
1125 if(
CopperLayer( aLayer ).thermal_spoke_angle.has_value() )
1161 for(
const std::shared_ptr<PCB_SHAPE>& item : aList )
1165 list.emplace_back( new_shape );
1247 std::vector<PCB_LAYER_ID> layers;
1299 std::optional<bool>( !
FrontOuterLayers().has_solder_mask.value() ) : std::nullopt;
1302 std::optional<bool>( !
BackOuterLayers().has_solder_mask.value() ) : std::nullopt;
1304 return std::nullopt;
1315 return std::nullopt;
1326 return std::nullopt;
1345 if( aLeft == aRight )
1411 if( !(
shape == aOther.
shape ) )
return false;
types::KiCadObjectType ToProtoEnum(KICAD_T aValue)
KICAD_T FromProtoEnum(types::KiCadObjectType aValue)
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
BASE_SET & set(size_t pos)
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual void SetParent(EDA_ITEM *aParent)
LSET is a set of PCB_LAYER_IDs.
std::optional< bool > IsFilled() const
bool operator==(const PADSTACK &aOther) const
std::optional< int > & Clearance(PCB_LAYER_ID aLayer=F_Cu)
void AddPrimitive(PCB_SHAPE *aShape, PCB_LAYER_ID aLayer)
Adds a custom shape primitive to the padstack.
void ReplacePrimitives(const std::vector< std::shared_ptr< PCB_SHAPE > > &aPrimitivesList, PCB_LAYER_ID aLayer)
Clears the existing primitive list (freeing the owned shapes) and adds copies of the given shapes to ...
void SetBackdrillMode(BACKDRILL_MODE aMode)
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
MASK_LAYER_PROPS & FrontOuterLayers()
double Similarity(const PADSTACK &aOther) const
Return a measure of how likely the other object is to represent the same object.
int RoundRectRadius(PCB_LAYER_ID aLayer) const
void SetDrillShape(PAD_DRILL_SHAPE aShape)
std::optional< double > & SolderPasteMarginRatio(PCB_LAYER_ID aLayer=F_Cu)
wxString m_customName
! An override for the IPC-7351 padstack name
void SetBackdrillSize(bool aTop, std::optional< int > aSize)
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 SetThermalSpokeAngle(EDA_ANGLE aAngle, PCB_LAYER_ID aLayer=F_Cu)
void SetRoundRectRadiusRatio(double aRatio, PCB_LAYER_ID aLayer)
UNCONNECTED_LAYER_MODE m_unconnectedLayerMode
void ClearPrimitives(PCB_LAYER_ID aLayer)
void SetUnconnectedLayerMode(UNCONNECTED_LAYER_MODE aMode)
std::optional< bool > IsTented(PCB_LAYER_ID aSide) const
Checks if this padstack is tented (covered in soldermask) on the given side.
std::optional< int > & ThermalSpokeWidth(PCB_LAYER_ID aLayer=F_Cu)
std::optional< int > & SolderPasteMargin(PCB_LAYER_ID aLayer=F_Cu)
POST_MACHINING_PROPS m_backPostMachining
std::optional< int > & SolderMaskMargin(PCB_LAYER_ID aLayer=F_Cu)
void SetChamferRatio(double aRatio, PCB_LAYER_ID aLayer)
PCB_LAYER_ID EffectiveLayerFor(PCB_LAYER_ID aLayer) const
Determines which geometry layer should be used for the given input layer.
PADSTACK & operator=(const PADSTACK &aOther)
void SetShape(PAD_SHAPE aShape, PCB_LAYER_ID aLayer)
EDA_ANGLE DefaultThermalSpokeAngleForShape(PCB_LAYER_ID aLayer=F_Cu) const
VECTOR2I & TrapezoidDeltaSize(PCB_LAYER_ID aLayer)
DRILL_PROPS m_secondaryDrill
! Secondary drill, used to define back-drilling starting from the bottom side
VECTOR2I & Offset(PCB_LAYER_ID aLayer)
MASK_LAYER_PROPS m_backMaskProps
! The overrides applied to back outer technical layers
COPPER_LAYER_PROPS & CopperLayer(PCB_LAYER_ID aLayer)
EDA_ANGLE ThermalSpokeAngle(PCB_LAYER_ID aLayer=F_Cu) const
void FlipLayers(int aCopperLayerCount)
Flips the padstack layers in the case that the pad's parent footprint is flipped to the other side of...
CUSTOM_SHAPE_ZONE_MODE m_customShapeInZoneMode
How to build the custom shape in zone, to create the clearance area: CUSTOM_SHAPE_ZONE_MODE::OUTLINE ...
bool unpackCopperLayer(const kiapi::board::types::PadStackLayer &aProto)
PAD_DRILL_SHAPE DrillShape() const
void SetChamferPositions(int aPositions, PCB_LAYER_ID aLayer)
POST_MACHINING_PROPS & FrontPostMachining()
DRILL_PROPS m_tertiaryDrill
! Tertiary drill, used to define back-drilling starting from the top side
void SetRoundRectRadius(double aRadius, PCB_LAYER_ID aLayer)
std::optional< bool > IsPlugged(PCB_LAYER_ID aSide) const
LSET RelevantShapeLayers(const PADSTACK &aOther) const
Returns the set of layers that must be considered if checking one padstack against another.
std::optional< int > & ThermalGap(PCB_LAYER_ID aLayer=F_Cu)
DRILL_PROPS & TertiaryDrill()
PAD_SHAPE Shape(PCB_LAYER_ID aLayer) const
void SetAnchorShape(PAD_SHAPE aShape, PCB_LAYER_ID aLayer)
BOARD_ITEM * m_parent
! The BOARD_ITEM this PADSTACK belongs to; will be used as the parent for owned shapes
PADSTACK(BOARD_ITEM *aParent)
std::optional< bool > IsCapped() const
std::vector< PCB_LAYER_ID > UniqueLayers() const
void SetBackdrillEndLayer(bool aTop, PCB_LAYER_ID aLayer)
LSET m_layerSet
! The board layers that this padstack is active on
std::optional< int > GetBackdrillSize(bool aTop) const
std::unordered_map< PCB_LAYER_ID, COPPER_LAYER_PROPS > m_copperProps
! The properties applied to copper layers if they aren't overridden
BACKDRILL_MODE GetBackdrillMode() const
static int Compare(const PADSTACK *aPadstackRef, const PADSTACK *aPadstackCmp)
Compare two padstacks and return 0 if they are equal.
PCB_LAYER_ID EndLayer() const
std::optional< bool > IsCovered(PCB_LAYER_ID aSide) const
int & ChamferPositions(PCB_LAYER_ID aLayer)
MASK_LAYER_PROPS m_frontMaskProps
! The overrides applied to front outer technical layers
const VECTOR2I & Size(PCB_LAYER_ID aLayer) const
MODE
! Copper geometry mode: controls how many unique copper layer shapes this padstack has
@ NORMAL
Shape is the same on all layers.
@ FRONT_INNER_BACK
Up to three shapes can be defined (F_Cu, inner copper layers, B_Cu)
void AppendPrimitives(const std::vector< std::shared_ptr< PCB_SHAPE > > &aPrimitivesList, PCB_LAYER_ID aLayer)
Appends a copy of each shape in the given list to this padstack's custom shape list.
DRILL_PROPS & SecondaryDrill()
double RoundRectRadiusRatio(PCB_LAYER_ID aLayer) const
PCB_LAYER_ID GetBackdrillEndLayer(bool aTop) const
PCB_LAYER_ID StartLayer() const
POST_MACHINING_PROPS & BackPostMachining()
POST_MACHINING_PROPS m_frontPostMachining
PAD_SHAPE AnchorShape(PCB_LAYER_ID aLayer) const
MASK_LAYER_PROPS & BackOuterLayers()
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
wxString Name() const
! Returns the name of this padstack in IPC-7351 format
void SetSize(const VECTOR2I &aSize, PCB_LAYER_ID aLayer)
double ChamferRatio(PCB_LAYER_ID aLayer) const
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
static constexpr PCB_LAYER_ID INNER_LAYERS
! The layer identifier to use for "inner layers" on top/inner/bottom padstacks
void SetLayerSet(const LSET &aSet)
std::optional< ZONE_CONNECTION > & ZoneConnection(PCB_LAYER_ID aLayer=F_Cu)
@ NORMAL
Padstack for a footprint pad.
MODE m_mode
! The copper layer variation mode this padstack is in
EDA_ANGLE m_orientation
! The rotation of the pad relative to an outer reference frame
std::vector< std::shared_ptr< PCB_SHAPE > > & Primitives(PCB_LAYER_ID aLayer)
@ RECT_CHAMFER_BOTTOM_RIGHT
@ RECT_CHAMFER_BOTTOM_LEFT
static constexpr EDA_ANGLE ANGLE_0
static constexpr EDA_ANGLE ANGLE_90
static constexpr EDA_ANGLE ANGLE_45
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
PCB_LAYER_ID
A quick note on layer IDs:
This file contains miscellaneous commonly used macros and functions.
void PackLayerSet(google::protobuf::RepeatedField< int > &aOutput, const LSET &aLayerSet)
LSET UnpackLayerSet(const google::protobuf::RepeatedField< int > &aProtoLayerSet)
KICOMMON_API VECTOR2I UnpackVector2(const types::Vector2 &aInput)
KICOMMON_API void PackVector2(types::Vector2 &aOutput, const VECTOR2I &aInput)
PAD_DRILL_POST_MACHINING_MODE
PAD_DRILL_SHAPE
The set of pad drill shapes, used with PAD::{Set,Get}DrillShape()
PAD_SHAPE
The set of pad shapes, used with PAD::{Set,Get}Shape()
#define IMPLEMENT_ENUM_TO_WXANY(type)
The features of a padstack that can vary between copper layers All parameters are optional; leaving t...
std::optional< ZONE_CONNECTION > zone_connection
std::optional< int > thermal_spoke_width
std::vector< std::shared_ptr< PCB_SHAPE > > custom_shapes
bool operator==(const COPPER_LAYER_PROPS &aOther) const
std::optional< EDA_ANGLE > thermal_spoke_angle
std::optional< int > clearance
std::optional< int > thermal_gap
! The properties of a padstack drill. Drill position is always the pad position (origin).
bool operator==(const DRILL_PROPS &aOther) const
VECTOR2I size
Drill diameter (x == y) or slot dimensions (x != y)
std::optional< bool > is_capped
True if the drill hole should be capped.
std::optional< bool > is_filled
True if the drill hole should be filled completely.
bool operator==(const MASK_LAYER_PROPS &aOther) const
std::optional< int > solder_mask_margin
std::optional< bool > has_covering
True if the pad on this side should have covering.
std::optional< int > solder_paste_margin
std::optional< double > solder_paste_margin_ratio
std::optional< bool > has_solder_mask
True if this outer layer has mask (is not tented)
std::optional< bool > has_solder_paste
True if this outer layer has solder paste.
std::optional< bool > has_plugging
True if the drill hole should be plugged on this side.
std::optional< PAD_DRILL_POST_MACHINING_MODE > mode
bool operator==(const POST_MACHINING_PROPS &aOther) const
int chamfered_rect_positions
VECTOR2I trapezoid_delta_size
Delta for PAD_SHAPE::TRAPEZOID; half the delta squeezes one end and half expands the other.
VECTOR2I offset
Offset of the shape center from the pad center.
bool operator==(const SHAPE_PROPS &aOther) const
VECTOR2I size
Size of the shape, or of the anchor pad for custom shape pads.
double chamfered_rect_ratio
Size of chamfer: ratio of smallest of X,Y size.
double round_rect_radius_ratio
PAD_SHAPE shape
Shape of the pad.
PAD_SHAPE anchor_shape
Shape of the anchor when shape == PAD_SHAPE::CUSTOM.
VECTOR2< int32_t > VECTOR2I