pad.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef PAD_H
#define PAD_H
 
#include <mutex>
#include <array>
#include <zones.h>
#include <board_connected_item.h>
#include <geometry/shape_poly_set.h>
#include <geometry/shape_compound.h>
#include <pad_shapes.h>
#include <geometry/eda_angle.h>
#include <geometry/geometry_utils.h>
#include <core/arraydim.h>
 
class PCB_SHAPE;
class SHAPE;
class SHAPE_SEGMENT;
 
enum CUST_PAD_SHAPE_IN_ZONE
{
 CUST_PAD_SHAPE_IN_ZONE_OUTLINE,
 CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL
};
 
class LINE_READER;
class EDA_3D_CANVAS;
class FOOTPRINT;
 
namespace KIGFX
{
 class VIEW;
}
 
class PAD : public BOARD_CONNECTED_ITEM
{
public:
 PAD( FOOTPRINT* parent );
 
 // Copy constructor & operator= are needed because the list of basic shapes
 // must be duplicated in copy.
 PAD( const PAD& aPad );
 PAD& operator=( const PAD &aOther );
 
 void Serialize( google::protobuf::Any &aContainer ) const override;
 bool Deserialize( const google::protobuf::Any &aContainer ) override;
 
 /*
 * Default layers used for pads, according to the pad type.
 *
 * This is default values only, they can be changed for a given pad.
 */
 static LSET PTHMask(); 
 static LSET SMDMask(); 
 static LSET ConnSMDMask(); 
 static LSET UnplatedHoleMask(); 
 static LSET ApertureMask(); 
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && PCB_PAD_T == aItem->Type();
 }
 
 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
 {
 if( BOARD_CONNECTED_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( HasHole() )
 {
 if( scanType == PCB_LOCATE_HOLE_T )
 return true;
 else if( scanType == PCB_LOCATE_PTH_T && m_attribute != PAD_ATTRIB::NPTH )
 return true;
 else if( scanType == PCB_LOCATE_NPTH_T && m_attribute == PAD_ATTRIB::NPTH )
 return true;
 }
 }
 
 return false;
 }
 
 bool HasHole() const override
 {
 return GetDrillSizeX() > 0 && GetDrillSizeY() > 0;
 }
 
 bool IsLocked() const override;
 
 void ImportSettingsFrom( const PAD& aMasterPad );
 
 bool IsFlipped() const;
 
 void SetNumber( const wxString& aNumber ) { m_number = aNumber; }
 const wxString& GetNumber() const { return m_number; }
 
 bool CanHaveNumber() const;
 
 void SetPinFunction( const wxString& aName ) { m_pinFunction = aName; }
 const wxString& GetPinFunction() const { return m_pinFunction; }
 
 void SetPinType( const wxString& aType ) { m_pinType = aType; }
 const wxString& GetPinType() const { return m_pinType; }
 
 bool SameLogicalPadAs( const PAD* aOther ) const
 {
 // hide tricks behind sensible API
 return GetParentFootprint() == aOther->GetParentFootprint()
 && !m_number.IsEmpty() && m_number == aOther->m_number;
 }
 
 bool SharesNetTieGroup( const PAD* aOther ) const;
 
 bool IsNoConnectPad() const;
 
 bool IsFreePad() const;
 
 void SetShape( PAD_SHAPE aShape )
 {
 m_padShape = aShape;
 SetDirty();
 }
 
 PAD_SHAPE GetShape() const { return m_padShape; }
 
 void SetPosition( const VECTOR2I& aPos ) override
 {
 m_pos = aPos;
 SetDirty();
 }
 
 VECTOR2I GetPosition() const override { return m_pos; }
 
 PAD_SHAPE GetAnchorPadShape() const { return m_anchorPadShape; }
 
 CUST_PAD_SHAPE_IN_ZONE GetCustomShapeInZoneOpt() const
 {
 return m_customShapeClearanceArea;
 }
 
 void SetCustomShapeInZoneOpt( CUST_PAD_SHAPE_IN_ZONE aOption )
 {
 m_customShapeClearanceArea = aOption;
 }
 
 void SetAnchorPadShape( PAD_SHAPE aShape )
 {
 m_anchorPadShape = ( aShape == PAD_SHAPE::RECTANGLE ) ? PAD_SHAPE::RECTANGLE : PAD_SHAPE::CIRCLE;
 SetDirty();
 }
 
 bool IsOnCopperLayer() const override;
 
 void SetY( int y ) { m_pos.y = y; SetDirty(); }
 void SetX( int x ) { m_pos.x = x; SetDirty(); }
 
 void SetSize( const VECTOR2I& aSize ) { m_size = aSize; SetDirty(); }
 const VECTOR2I& GetSize() const { return m_size; }
 void SetSizeX( const int aX ) { if( aX > 0 ) { m_size.x = aX; SetDirty(); } }
 int GetSizeX() const { return m_size.x; }
 void SetSizeY( const int aY ) { if( aY > 0 ) { m_size.y = aY; SetDirty(); } }
 int GetSizeY() const { return m_size.y; }
 
 void SetDelta( const VECTOR2I& aSize ) { m_deltaSize = aSize; SetDirty(); }
 const VECTOR2I& GetDelta() const { return m_deltaSize; }
 
 void SetDrillSize( const VECTOR2I& aSize ) { m_drill = aSize; SetDirty(); }
 const VECTOR2I& GetDrillSize() const { return m_drill; }
 void SetDrillSizeX( const int aX ) { m_drill.x = aX; SetDirty(); }
 int GetDrillSizeX() const { return m_drill.x; }
 void SetDrillSizeY( const int aY ) { m_drill.y = aY; SetDirty(); }
 int GetDrillSizeY() const { return m_drill.y; }
 
 void SetOffset( const VECTOR2I& aOffset ) { m_offset = aOffset; SetDirty(); }
 const VECTOR2I& GetOffset() const { return m_offset; }
 
 VECTOR2I GetCenter() const override { return GetPosition(); }
 
 void AddPrimitivePoly( const SHAPE_POLY_SET& aPoly, int aThickness, bool aFilled );
 void AddPrimitivePoly( const std::vector<VECTOR2I>& aPoly, int aThickness, bool aFilled );
 
 void MergePrimitivesAsPolygon( SHAPE_POLY_SET* aMergedPolygon,
 ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;
 
 void DeletePrimitivesList();
 
 const std::vector<std::shared_ptr<PCB_SHAPE>>& GetPrimitives() const
 {
 return m_editPrimitives;
 }
 
 void Flip( const VECTOR2I& VECTOR2I, bool aFlipLeftRight ) override;
 
 void FlipPrimitives( bool aFlipLeftRight );
 
 void ReplacePrimitives( const std::vector<std::shared_ptr<PCB_SHAPE>>& aPrimitivesList );
 
 void AppendPrimitives( const std::vector<std::shared_ptr<PCB_SHAPE>>& aPrimitivesList );
 
 void AddPrimitive( PCB_SHAPE* aPrimitive );
 
 void SetOrientation( const EDA_ANGLE& aAngle );
 void SetFPRelativeOrientation( const EDA_ANGLE& aAngle );
 
 EDA_ANGLE GetOrientation() const { return m_orient; }
 EDA_ANGLE GetFPRelativeOrientation();
 
 // For property system
 void SetOrientationDegrees( double aOrientation )
 {
 SetOrientation( EDA_ANGLE( aOrientation, DEGREES_T ) );
 }
 double GetOrientationDegrees() const
 {
 return m_orient.AsDegrees();
 }
 
 void SetDrillShape( PAD_DRILL_SHAPE_T aShape ) { m_drillShape = aShape; m_shapesDirty = true; }
 PAD_DRILL_SHAPE_T GetDrillShape() const { return m_drillShape; }
 
 bool IsDirty() const
 {
 return m_shapesDirty || m_polyDirty[ERROR_INSIDE] || m_polyDirty[ERROR_OUTSIDE];
 }
 
 void SetDirty()
 {
 m_shapesDirty = true;
 m_polyDirty[ERROR_INSIDE] = true;
 m_polyDirty[ERROR_OUTSIDE] = true;
 }
 
 void SetLayerSet( LSET aLayers ) override { m_layerMask = aLayers; }
 LSET GetLayerSet() const override { return m_layerMask; }
 
 void SetAttribute( PAD_ATTRIB aAttribute );
 PAD_ATTRIB GetAttribute() const { return m_attribute; }
 
 void SetProperty( PAD_PROP aProperty );
 PAD_PROP GetProperty() const { return m_property; }
 
 // We don't currently have an attribute for APERTURE, and adding one will change the file
 // format, so for now just infer a copper-less pad to be an APERTURE pad.
 bool IsAperturePad() const
 {
 return ( m_layerMask & LSET::AllCuMask() ).none();
 }
 
 void SetPadToDieLength( int aLength ) { m_lengthPadToDie = aLength; }
 int GetPadToDieLength() const { return m_lengthPadToDie; }
 
 std::optional<int> GetLocalClearance() const override { return m_clearance; }
 void SetLocalClearance( std::optional<int> aClearance ) { m_clearance = aClearance; }
 
 std::optional<int> GetLocalSolderMaskMargin() const { return m_solderMaskMargin; }
 void SetLocalSolderMaskMargin( std::optional<int> aMargin ) { m_solderMaskMargin = aMargin; }
 
 std::optional<int> GetLocalSolderPasteMargin() const { return m_solderPasteMargin; }
 void SetLocalSolderPasteMargin( std::optional<int> aMargin ) { m_solderPasteMargin = aMargin; }
 
 std::optional<double> GetLocalSolderPasteMarginRatio() const { return m_solderPasteMarginRatio; }
 void SetLocalSolderPasteMarginRatio( std::optional<double> aRatio ) { m_solderPasteMarginRatio = aRatio; }
 
 void SetLocalZoneConnection( ZONE_CONNECTION aType ) { m_zoneConnection = aType; }
 ZONE_CONNECTION GetLocalZoneConnection() const { return m_zoneConnection; }
 
 int GetOwnClearance( PCB_LAYER_ID aLayer, wxString* aSource = nullptr ) const override;
 
 void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
 int aMaxError, ERROR_LOC aErrorLoc = ERROR_INSIDE,
 bool ignoreLineWidth = false ) const override;
 
 bool TransformHoleToPolygon( SHAPE_POLY_SET& aBuffer, int aClearance, int aError,
 ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;
 
 virtual std::shared_ptr<SHAPE>
 GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
 FLASHING flashPTHPads = FLASHING::DEFAULT ) const override;
 
 const std::shared_ptr<SHAPE_POLY_SET>& GetEffectivePolygon( ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;
 
 std::shared_ptr<SHAPE_SEGMENT> GetEffectiveHoleShape() const override;
 
 int GetBoundingRadius() const;
 
 std::optional<int> GetLocalClearance( wxString* aSource ) const override;
 
 std::optional<int> GetClearanceOverrides( wxString* aSource ) const override;
 
 int GetSolderMaskExpansion() const;
 
 VECTOR2I GetSolderPasteMargin() const;
 
 ZONE_CONNECTION GetZoneConnectionOverrides( wxString* aSource = nullptr ) const;
 
 void SetThermalSpokeWidth( int aWidth ) { m_thermalSpokeWidth = aWidth; }
 int GetThermalSpokeWidth() const { return m_thermalSpokeWidth; }
 
 int GetLocalSpokeWidthOverride( wxString* aSource = nullptr ) const;
 
 void SetThermalSpokeAngle( const EDA_ANGLE& aAngle ) { m_thermalSpokeAngle = aAngle; }
 EDA_ANGLE GetThermalSpokeAngle() const { return m_thermalSpokeAngle; }
 
 // For property system
 void SetThermalSpokeAngleDegrees( double aAngle )
 {
 m_thermalSpokeAngle = EDA_ANGLE( aAngle, DEGREES_T );
 }
 double GetThermalSpokeAngleDegrees() const
 {
 return m_thermalSpokeAngle.AsDegrees();
 }
 
 void SetThermalGap( int aGap ) { m_thermalGap = aGap; }
 int GetThermalGap() const { return m_thermalGap; }
 
 int GetLocalThermalGapOverride( wxString* aSource = nullptr ) const;
 
 void SetRoundRectCornerRadius( double aRadius );
 int GetRoundRectCornerRadius() const;
 
 VECTOR2I ShapePos() const;
 
 void SetRoundRectRadiusRatio( double aRadiusScale );
 double GetRoundRectRadiusRatio() const { return m_roundedCornerScale; }
 
 void SetChamferRectRatio( double aChamferScale );
 double GetChamferRectRatio() const { return m_chamferScale; }
 
 void SetChamferPositions( int aPositions ) { m_chamferPositions = aPositions; }
 int GetChamferPositions() const { return m_chamferPositions; }
 
 int GetSubRatsnest() const { return m_subRatsnest; }
 void SetSubRatsnest( int aSubRatsnest ) { m_subRatsnest = aSubRatsnest; }
 
 void SetRemoveUnconnected( bool aSet ) { m_removeUnconnectedLayer = aSet; }
 bool GetRemoveUnconnected() const { return m_removeUnconnectedLayer; }
 
 void SetKeepTopBottom( bool aSet ) { m_keepTopBottomLayer = aSet; }
 bool GetKeepTopBottom() const { return m_keepTopBottomLayer; }
 
 bool ConditionallyFlashed( PCB_LAYER_ID aLayer ) const
 {
 if( !m_removeUnconnectedLayer )
 return false;
 
 if( m_keepTopBottomLayer && ( aLayer == F_Cu || aLayer == B_Cu ) )
 return false;
 
 return true;
 }
 
 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
 bool IsOnLayer( PCB_LAYER_ID aLayer ) const override
 {
 return m_layerMask[aLayer];
 }
 
 bool FlashLayer( int aLayer, bool aOnlyCheckIfPermitted = false ) const;
 
 bool CanFlashLayer( int aLayer )
 {
 return FlashLayer( aLayer, true );
 }
 
 PCB_LAYER_ID GetLayer() const override;
 
 PCB_LAYER_ID GetPrincipalLayer() const;
 
 bool FlashLayer( LSET aLayers ) const;
 
 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
 wxString GetClass() const override
 {
 return wxT( "PAD" );
 }
 
 const BOX2I GetBoundingBox() const override;
 
 static int Compare( const PAD* aPadRef, const PAD* aPadCmp );
 
 void Move( const VECTOR2I& aMoveVector ) override
 {
 m_pos += aMoveVector;
 SetDirty();
 }
 
 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 wxString ShowPadShape() const;
 
 wxString ShowPadAttr() const;
 
 EDA_ITEM* Clone() const override;
 
 PAD* ClonePad() const
 {
 return (PAD*) Clone();
 }
 
 void BuildEffectiveShapes( PCB_LAYER_ID aLayer ) const;
 void BuildEffectivePolygon( ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;
 
 virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
 
 virtual const BOX2I ViewBBox() const override;
 
 void ClearZoneLayerOverrides()
 {
 m_zoneLayerOverrides.fill( ZLO_NONE );
 }
 
 const ZONE_LAYER_OVERRIDE& GetZoneLayerOverride( PCB_LAYER_ID aLayer ) const
 {
 return m_zoneLayerOverrides.at( aLayer );
 }
 
 void SetZoneLayerOverride( PCB_LAYER_ID aLayer, ZONE_LAYER_OVERRIDE aOverride )
 {
 std::unique_lock<std::mutex> cacheLock( m_zoneLayerOverridesMutex );
 m_zoneLayerOverrides.at( aLayer ) = aOverride;
 }
 
 double Similarity( const BOARD_ITEM& aOther ) const override;
 
 bool operator==( const BOARD_ITEM& aOther ) const override;
 bool operator!=( const BOARD_ITEM& aOther ) const { return !operator==( aOther ); }
 
#if defined(DEBUG)
 virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
protected:
 virtual void swapData( BOARD_ITEM* aImage ) override;
 
private:
 void addPadPrimitivesToPolygon( SHAPE_POLY_SET* aMergedPolygon, int aError,
 ERROR_LOC aErrorLoc ) const;
 
private:
 wxString m_number; // Pad name (pin number in schematic)
 wxString m_pinFunction; // Pin name in schematic
 wxString m_pinType; // Pin electrical type in schematic
 
 VECTOR2I m_pos; // Pad Position on board
 
 PAD_SHAPE m_padShape; // Shape: PAD_SHAPE::CIRCLE, PAD_SHAPE::RECTANGLE,
 // PAD_SHAPE::OVAL, PAD_SHAPE::TRAPEZOID,
 // PAD_SHAPE::ROUNDRECT, PAD_SHAPE::CHAMFERED_RECT,
 // PAD_SHAPE::CUSTOM
 /*
 * Editing definitions of primitives for custom pad shapes. In local coordinates relative
 * to m_Pos (NOT shapePos) at orient 0.
 */
 std::vector<std::shared_ptr<PCB_SHAPE>> m_editPrimitives;
 
 // Must be set to true to force rebuild shapes to draw (after geometry change for instance)
 mutable bool m_shapesDirty;
 mutable std::mutex m_shapesBuildingLock;
 mutable BOX2I m_effectiveBoundingBox;
 mutable std::shared_ptr<SHAPE_COMPOUND> m_effectiveShape;
 mutable std::shared_ptr<SHAPE_SEGMENT> m_effectiveHoleShape;
 
 mutable bool m_polyDirty[2];
 mutable std::mutex m_polyBuildingLock;
 mutable std::shared_ptr<SHAPE_POLY_SET> m_effectivePolygon[2];
 mutable int m_effectiveBoundingRadius;
 
 int m_subRatsnest; // Variable used to handle subnet (block) number in
 // ratsnest computations
 
 VECTOR2I m_drill; // Drill diameter (x == y) or slot dimensions (x != y)
 VECTOR2I m_size; // X and Y size (relative to orient 0)
 
 PAD_DRILL_SHAPE_T m_drillShape; // PAD_DRILL_SHAPE_CIRCLE, PAD_DRILL_SHAPE_OBLONG
 
 double m_roundedCornerScale; // Scaling factor of min(width, height) to corner
 // radius, default 0.25
 double m_chamferScale; // Scaling factor of min(width, height) to chamfer
 // size, default 0.25
 int m_chamferPositions; // The positions of the chamfers (at orient 0)
 
 PAD_SHAPE m_anchorPadShape; // For custom shaped pads: shape of pad anchor,
 // PAD_SHAPE::RECTANGLE, PAD_SHAPE::CIRCLE
 
 /*
 * Most of the time the hole is the center of the shape (m_Offset = 0). But some designers
 * use oblong/rect pads with a hole moved to one of the oblong/rect pad shape ends.
 * In all cases the hole is at the pad position. This offset is from the hole to the center
 * of the pad shape (ie: the copper area around the hole).
 * ShapePos() returns the board shape position according to the offset and the pad rotation.
 */
 VECTOR2I m_offset;
 
 LSET m_layerMask; // Bitwise layer: 1 = copper layer, 15 = cmp,
 // 2..14 = internal layers, 16..31 = technical layers
 
 VECTOR2I m_deltaSize; // Delta for PAD_SHAPE::TRAPEZOID; half the delta squeezes
 // one end and half expands the other. It is only valid
 // to have a single axis be non-0.
 
 PAD_ATTRIB m_attribute; // PAD_ATTRIB_NORMAL, PAD_ATTRIB::SMD, PAD_ATTRIB::CONN,
 // PAD_ATTRIB::NPTH
 PAD_PROP m_property; // Property in fab files (BGA, FIDUCIAL, TESTPOINT, etc.)
 
 EDA_ANGLE m_orient;
 
 int m_lengthPadToDie; // Length net from pad to die, inside the package
 
 bool m_removeUnconnectedLayer;
 
 bool m_keepTopBottomLayer;
 
 /*
 * Pad clearances, margins, etc. exist in a hierarchy. If a given level is specified then
 * the remaining levels are NOT consulted.
 *
 * LEVEL 1: (highest priority) local overrides (pad, footprint, etc.)
 * LEVEL 2: Rules
 * LEVEL 3: Accumulated local settings, netclass settings, & board design settings
 *
 * These are the LEVEL 1 settings (overrides) for a pad.
 */
 std::optional<int> m_clearance;
 std::optional<int> m_solderMaskMargin; // Solder mask margin
 std::optional<int> m_solderPasteMargin; // Solder paste margin absolute value
 std::optional<double> m_solderPasteMarginRatio; // Solder mask margin ratio of pad size
 // The final margin is the sum of these 2 values
 
 /*
 * How to build the custom shape in zone, to create the clearance area:
 * CUST_PAD_SHAPE_IN_ZONE_OUTLINE = use pad shape
 * CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL = use the convex hull of the pad shape
 */
 CUST_PAD_SHAPE_IN_ZONE m_customShapeClearanceArea;
 
 ZONE_CONNECTION m_zoneConnection; // No connection, thermal relief, etc.
 int m_thermalSpokeWidth; // Thermal spoke width.
 EDA_ANGLE m_thermalSpokeAngle; // Rotation of the spokes. 45° will produce an X,
 // while 90° will produce a +.
 int m_thermalGap;
 
 std::mutex m_zoneLayerOverridesMutex;
 std::array<ZONE_LAYER_OVERRIDE, MAX_CU_LAYERS> m_zoneLayerOverrides;
};
 
#endif // PAD_H