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 The 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <mutex>
#include <array>
#include <optional>
 
#include <board_connected_item.h>
#include <core/arraydim.h>
#include <core/mirror.h>
#include <geometry/eda_angle.h>
#include <geometry/shape_poly_set.h>
#include <geometry/shape_compound.h>
#include <lset.h>
#include <padstack.h>
#include <zones.h>
 
class PCB_SHAPE;
class SHAPE;
class SHAPE_SEGMENT;
 
class LINE_READER;
class EDA_3D_CANVAS;
class FOOTPRINT;
 
namespace KIGFX
{
    class VIEW;
}
 

enum class PAD_SIM_ELECTRICAL_TYPE : int
{
    NONE = 0,
    SOURCE,
    SINK
};
 
 
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 CopyFrom( const BOARD_ITEM* aOther ) override;
 
    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 HasDrilledHole() const override
    {
        return HasHole() && GetDrillSizeX() == GetDrillSizeY();
    }
 
    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 SetPadstackMode( PADSTACK::MODE aMode ) { m_padStack.SetMode( aMode ); }
    PADSTACK::MODE GetPadstackMode() const { return m_padStack.Mode(); }

    void SetShape( PCB_LAYER_ID aLayer, PAD_SHAPE aShape )
    {
        m_padStack.SetShape( aShape, aLayer );
        SetDirty();
    }

    PAD_SHAPE GetShape( PCB_LAYER_ID aLayer ) const { return m_padStack.Shape( aLayer ); }
 
    // Used for the properties panel, which does not support padstacks at the moment
    void SetFrontShape( PAD_SHAPE aShape );
 
    PAD_SHAPE GetFrontShape() const { return m_padStack.Shape( F_Cu ); }
 
    void     SetPosition( const VECTOR2I& aPos ) override;
    VECTOR2I GetPosition() const override;
    VECTOR2I GetLibraryPosition() const { return m_libPos; }

    PAD_SHAPE GetAnchorPadShape( PCB_LAYER_ID aLayer ) const
    {
        return m_padStack.AnchorShape( aLayer );
    }

    CUSTOM_SHAPE_ZONE_MODE GetCustomShapeInZoneOpt() const
    {
        return m_padStack.CustomShapeInZoneMode();
    }

    void SetCustomShapeInZoneOpt( CUSTOM_SHAPE_ZONE_MODE aOption )
    {
        m_padStack.SetCustomShapeInZoneMode( aOption );
    }

    void SetAnchorPadShape( PCB_LAYER_ID aLayer, PAD_SHAPE aShape )
    {
        m_padStack.SetAnchorShape( aShape == PAD_SHAPE::RECTANGLE ? PAD_SHAPE::RECTANGLE
                                                                  : PAD_SHAPE::CIRCLE,
                                   aLayer );
        SetDirty();
    }

    bool IsOnCopperLayer() const override;
 
    void SetY( int y )
    {
        VECTOR2I p = GetPosition();
        p.y = y;
        SetPosition( p );
    }
 
    void SetX( int x )
    {
        VECTOR2I p = GetPosition();
        p.x = x;
        SetPosition( p );
    }
 
    void     SetSize( PCB_LAYER_ID aLayer, const VECTOR2I& aSize );
    VECTOR2I GetSize( PCB_LAYER_ID aLayer ) const;
 
    // Lib-frame setters used by the parser. These store the value as-is in the
    // padstack without inverse-scaling against the parent FP transform.
    void SetLibSize( PCB_LAYER_ID aLayer, const VECTOR2I& aSize );
    void SetLibDrillSize( const VECTOR2I& aSize );
    void SetLibOffset( PCB_LAYER_ID aLayer, const VECTOR2I& aOffset );
 
    bool HasExplicitDefinitionForLayer( PCB_LAYER_ID aLayer ) const
    {
        return m_padStack.HasExplicitDefinitionForLayer( aLayer );
    }
 
    // These accessors are for the properties panel, which does not have the ability to deal with
    // custom padstacks where the properties can vary by layer.  The properties should be disabled
    // in the GUI when the padstack mode is set to anything other than NORMAL, but so that the code
    // compiles, these are set up to work with the front layer (in other words, assume the mode is
    // NORMAL, where F_Cu stores the whole padstack data)
    void SetSizeX( int aX );
    int  GetSizeX() const;
 
    void SetSizeY( int aY );
    int  GetSizeY() const;
 
    void SetDelta( PCB_LAYER_ID aLayer, const VECTOR2I& aSize )
    {
        m_padStack.TrapezoidDeltaSize( aLayer ) = aSize;
        SetDirty();
    }
 
    const VECTOR2I& GetDelta( PCB_LAYER_ID aLayer ) const
    {
        return m_padStack.TrapezoidDeltaSize( aLayer );
    }
 
    void     SetPrimaryDrillSize( const VECTOR2I& aSize );
    VECTOR2I GetPrimaryDrillSize() const;
    void     SetPrimaryDrillSizeX( int aX );
    int      GetPrimaryDrillSizeX() const { return GetPrimaryDrillSize().x; }
    void     SetPrimaryDrillSizeY( int aY );
    int      GetPrimaryDrillSizeY() const { return GetPrimaryDrillSize().y; }
 
    void     SetDrillSize( const VECTOR2I& aSize ) { SetPrimaryDrillSize( aSize ); }
    VECTOR2I GetDrillSize() const { return GetPrimaryDrillSize(); }
    void     SetDrillSizeX( int aX );
    int      GetDrillSizeX() const { return GetPrimaryDrillSizeX(); }
    void     SetDrillSizeY( int aY );
    int      GetDrillSizeY() const { return GetPrimaryDrillSizeY(); }
 
    void     SetOffset( PCB_LAYER_ID aLayer, const VECTOR2I& aOffset );
    VECTOR2I GetOffset( PCB_LAYER_ID aLayer ) const;
 
    VECTOR2I GetCenter() const override           { return GetPosition(); }
 
    const PADSTACK& Padstack() const              { return m_padStack; }
    PADSTACK& Padstack()                          { return m_padStack; }
    void SetPadstack( const PADSTACK& aPadstack ) { m_padStack = aPadstack; }

    void AddPrimitivePoly( PCB_LAYER_ID aLayer, const SHAPE_POLY_SET& aPoly, int aThickness,
                           bool aFilled );
    void AddPrimitivePoly( PCB_LAYER_ID aLayer, const std::vector<VECTOR2I>& aPoly, int aThickness,
                           bool aFilled );

    void MergePrimitivesAsPolygon( PCB_LAYER_ID aLayer, SHAPE_POLY_SET* aMergedPolygon,
                                   ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;

    void DeletePrimitivesList( PCB_LAYER_ID aLayer = UNDEFINED_LAYER );

    const std::vector<std::shared_ptr<PCB_SHAPE>>& GetPrimitives( PCB_LAYER_ID aLayer ) const
    {
        return m_padStack.Primitives( aLayer );
    }
 
    void Flip( const VECTOR2I& VECTOR2I, FLIP_DIRECTION aFlipDirection ) override;

    void FlipPrimitives( FLIP_DIRECTION aFlipDirection );

    void ReplacePrimitives( PCB_LAYER_ID aLayer,
                            const std::vector<std::shared_ptr<PCB_SHAPE>>& aPrimitivesList );

    void AppendPrimitives( PCB_LAYER_ID aLayer,
                           const std::vector<std::shared_ptr<PCB_SHAPE>>& aPrimitivesList );

    void AddPrimitive( PCB_LAYER_ID aLayer, PCB_SHAPE* aPrimitive );

    void SetOrientation( const EDA_ANGLE& aAngle );
    void SetFPRelativeOrientation( const EDA_ANGLE& aAngle );

    EDA_ANGLE GetOrientation() const;
    EDA_ANGLE GetFPRelativeOrientation() const;
 
    void GetPrimitiveLibScale( double& aScaleX, double& aScaleY ) const;
 
    // For property system
    void SetOrientationDegrees( double aOrientation )
    {
        SetOrientation( EDA_ANGLE( aOrientation, DEGREES_T ) );
    }
    double GetOrientationDegrees() const { return GetOrientation().AsDegrees(); }
 
    void SetPrimaryDrillShape( PAD_DRILL_SHAPE aShape );
    PAD_DRILL_SHAPE GetPrimaryDrillShape() const { return m_padStack.Drill().shape; }
 
    void SetDrillShape( PAD_DRILL_SHAPE aShape ) { SetPrimaryDrillShape( aShape ); }
    PAD_DRILL_SHAPE GetDrillShape() const { return GetPrimaryDrillShape(); }
 
    void SetPrimaryDrillStartLayer( PCB_LAYER_ID aLayer );
    PCB_LAYER_ID GetPrimaryDrillStartLayer() const { return m_padStack.Drill().start; }
    void SetPrimaryDrillEndLayer( PCB_LAYER_ID aLayer );
    PCB_LAYER_ID GetPrimaryDrillEndLayer() const { return m_padStack.Drill().end; }
 
    void SetFrontPostMachining( const std::optional<PAD_DRILL_POST_MACHINING_MODE>& aMode ) { m_padStack.FrontPostMachining().mode = aMode; }
    std::optional<PAD_DRILL_POST_MACHINING_MODE> GetFrontPostMachining() const { return m_padStack.FrontPostMachining().mode; }
 
    void SetFrontPostMachiningMode( PAD_DRILL_POST_MACHINING_MODE aMode )
    {
        m_padStack.FrontPostMachining().mode = aMode;
    }
 
    PAD_DRILL_POST_MACHINING_MODE GetFrontPostMachiningMode() const
    {
        return m_padStack.FrontPostMachining().mode.value_or( PAD_DRILL_POST_MACHINING_MODE::NOT_POST_MACHINED );
    }
 
    void SetFrontPostMachiningSize( int aSize ) { m_padStack.FrontPostMachining().size = aSize; }
    int GetFrontPostMachiningSize() const { return m_padStack.FrontPostMachining().size; }
    void SetFrontPostMachiningDepth( int aDepth ) { m_padStack.FrontPostMachining().depth = aDepth; }
    int GetFrontPostMachiningDepth() const { return m_padStack.FrontPostMachining().depth; }
    void SetFrontPostMachiningAngle( int aAngle ) { m_padStack.FrontPostMachining().angle = aAngle; }
    int GetFrontPostMachiningAngle() const { return m_padStack.FrontPostMachining().angle; }
 
    void SetBackPostMachining( const std::optional<PAD_DRILL_POST_MACHINING_MODE>& aMode ) { m_padStack.BackPostMachining().mode = aMode; }
    std::optional<PAD_DRILL_POST_MACHINING_MODE> GetBackPostMachining() const { return m_padStack.BackPostMachining().mode; }
 
    void SetBackPostMachiningMode( PAD_DRILL_POST_MACHINING_MODE aMode )
    {
        m_padStack.BackPostMachining().mode = aMode;
    }
 
    PAD_DRILL_POST_MACHINING_MODE GetBackPostMachiningMode() const
    {
        return m_padStack.BackPostMachining().mode.value_or( PAD_DRILL_POST_MACHINING_MODE::NOT_POST_MACHINED );
    }
 
    void SetBackPostMachiningSize( int aSize ) { m_padStack.BackPostMachining().size = aSize; }
    int GetBackPostMachiningSize() const { return m_padStack.BackPostMachining().size; }
    void SetBackPostMachiningDepth( int aDepth ) { m_padStack.BackPostMachining().depth = aDepth; }
    int GetBackPostMachiningDepth() const { return m_padStack.BackPostMachining().depth; }
    void SetBackPostMachiningAngle( int aAngle ) { m_padStack.BackPostMachining().angle = aAngle; }
    int GetBackPostMachiningAngle() const { return m_padStack.BackPostMachining().angle; }

    bool IsBackdrilledOrPostMachined( PCB_LAYER_ID aLayer ) const;

    int GetPostMachiningKnockout( PCB_LAYER_ID aLayer ) const;
 
    void SetPrimaryDrillFilled( const std::optional<bool>& aFilled );
    void SetPrimaryDrillFilledFlag( bool aFilled );
    std::optional<bool> GetPrimaryDrillFilled() const { return m_padStack.Drill().is_filled; }
    bool GetPrimaryDrillFilledFlag() const { return m_padStack.Drill().is_filled.value_or( false ); }
 
    void SetPrimaryDrillCapped( const std::optional<bool>& aCapped );
    void SetPrimaryDrillCappedFlag( bool aCapped );
    std::optional<bool> GetPrimaryDrillCapped() const { return m_padStack.Drill().is_capped; }
    bool GetPrimaryDrillCappedFlag() const { return m_padStack.Drill().is_capped.value_or( false ); }
 
    void SetSecondaryDrillSize( const VECTOR2I& aSize );
    const VECTOR2I& GetSecondaryDrillSize() const { return m_padStack.SecondaryDrill().size; }
    void ClearSecondaryDrillSize();
 
    void SetSecondaryDrillSizeX( int aX );
    int GetSecondaryDrillSizeX() const { return m_padStack.SecondaryDrill().size.x; }
    void SetSecondaryDrillSizeY( int aY );
    int GetSecondaryDrillSizeY() const { return m_padStack.SecondaryDrill().size.y; }
 
    void SetSecondaryDrillShape( PAD_DRILL_SHAPE aShape );
    PAD_DRILL_SHAPE GetSecondaryDrillShape() const { return m_padStack.SecondaryDrill().shape; }
 
    void SetSecondaryDrillStartLayer( PCB_LAYER_ID aLayer );
    PCB_LAYER_ID GetSecondaryDrillStartLayer() const { return m_padStack.SecondaryDrill().start; }
    void SetSecondaryDrillEndLayer( PCB_LAYER_ID aLayer );
    PCB_LAYER_ID GetSecondaryDrillEndLayer() const { return m_padStack.SecondaryDrill().end; }
 
    void SetTertiaryDrillSize( const VECTOR2I& aSize );
    const VECTOR2I& GetTertiaryDrillSize() const { return m_padStack.TertiaryDrill().size; }
    void ClearTertiaryDrillSize();
 
    void SetTertiaryDrillSizeX( int aX );
    int GetTertiaryDrillSizeX() const { return m_padStack.TertiaryDrill().size.x; }
    void SetTertiaryDrillSizeY( int aY );
    int GetTertiaryDrillSizeY() const { return m_padStack.TertiaryDrill().size.y; }
 
    void SetTertiaryDrillShape( PAD_DRILL_SHAPE aShape );
    PAD_DRILL_SHAPE GetTertiaryDrillShape() const { return m_padStack.TertiaryDrill().shape; }
 
    void SetTertiaryDrillStartLayer( PCB_LAYER_ID aLayer );
    PCB_LAYER_ID GetTertiaryDrillStartLayer() const { return m_padStack.TertiaryDrill().start; }
    void SetTertiaryDrillEndLayer( PCB_LAYER_ID aLayer );
    PCB_LAYER_ID GetTertiaryDrillEndLayer() const { return m_padStack.TertiaryDrill().end; }
 
    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( const LSET& aLayers ) override;
    LSET GetLayerSet() const override           { return m_padStack.LayerSet(); }
 
    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_padStack.LayerSet() & LSET::AllCuMask() ).none();
    }
 
    void                    SetSimElectricalType( PAD_SIM_ELECTRICAL_TYPE aType ) { m_simElectricalType = aType; }
    PAD_SIM_ELECTRICAL_TYPE GetSimElectricalType() const { return m_simElectricalType; }
 
    bool IsNPTHWithNoCopper() const;
 
    void SetPadToDieLength( int aLength )       { m_lengthPadToDie = aLength; }
    int GetPadToDieLength() const               { return m_lengthPadToDie; }
 
    void SetPadToDieDelay( int aDelay ) { m_delayPadToDie = aDelay; }
    int  GetPadToDieDelay() const { return m_delayPadToDie; }
 
    std::optional<int> GetLocalClearance() const override   { return m_padStack.Clearance(); }
    void SetLocalClearance( std::optional<int> aClearance ) { m_padStack.Clearance() = aClearance; }
 
    std::optional<int> GetLocalSolderMaskMargin() const { return m_padStack.SolderMaskMargin(); }
    void               SetLocalSolderMaskMargin( std::optional<int> aMargin )
    {
        m_padStack.SolderMaskMargin( F_Mask ) = aMargin;
        m_padStack.SolderMaskMargin( B_Mask ) = aMargin;
    }
 
    std::optional<int> GetLocalSolderPasteMargin() const { return m_padStack.SolderPasteMargin(); }
    void               SetLocalSolderPasteMargin( std::optional<int> aMargin )
    {
        m_padStack.SolderPasteMargin( F_Paste ) = aMargin;
        m_padStack.SolderPasteMargin( B_Paste ) = aMargin;
    }
 
    std::optional<double> GetLocalSolderPasteMarginRatio() const
    {
        return m_padStack.SolderPasteMarginRatio();
    }
    void SetLocalSolderPasteMarginRatio( std::optional<double> aRatio )
    {
        m_padStack.SolderPasteMarginRatio( F_Paste ) = aRatio;
        m_padStack.SolderPasteMarginRatio( B_Paste ) = aRatio;
    }
 
    void SetLocalZoneConnection( ZONE_CONNECTION aType ) { m_padStack.ZoneConnection() = aType; }
    ZONE_CONNECTION GetLocalZoneConnection() const
    {
        return m_padStack.ZoneConnection().value_or( ZONE_CONNECTION::INHERITED );
    }

    int GetOwnClearance( PCB_LAYER_ID aLayer, wxString* aSource = nullptr ) const override;
 
    double GetCoverageArea( int aTextMargin ) const override;

    void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
                                  int aMaxError, ERROR_LOC aErrorLoc = ERROR_INSIDE,
                                  bool aIgnoreLineWidth = false ) const override;

    bool TransformHoleToPolygon( SHAPE_POLY_SET& aBuffer, int aClearance, int aError,
                                 ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;

    std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
                                              FLASHING aFlash = FLASHING::DEFAULT,
                                              DRC_CONSTRAINT_T aUsage = NULL_CONSTRAINT ) const override;
 
    const std::shared_ptr<SHAPE_POLY_SET>& GetEffectivePolygon( PCB_LAYER_ID aLayer,
                                                                ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;

    std::shared_ptr<SHAPE_SEGMENT> GetEffectiveHoleShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
                                                          DRC_CONSTRAINT_T aUsage = NULL_CONSTRAINT ) const override;

    int GetBoundingRadius() const;

    std::optional<int> GetLocalClearance( wxString* aSource ) const override;

    std::optional<int> GetClearanceOverrides( wxString* aSource ) const override;

    int GetSolderMaskExpansion( PCB_LAYER_ID aLayer ) const;

    VECTOR2I GetSolderPasteMargin( PCB_LAYER_ID aLayer ) const;
 
    ZONE_CONNECTION GetZoneConnectionOverrides( wxString* aSource = nullptr ) const;

    void SetLocalThermalSpokeWidthOverride( std::optional<int> aWidth )
    {
        m_padStack.ThermalSpokeWidth() = aWidth;
    }
    std::optional<int> GetLocalThermalSpokeWidthOverride() const
    {
        return m_padStack.ThermalSpokeWidth();
    }
 
    int GetLocalSpokeWidthOverride( wxString* aSource = nullptr ) const;

    void SetThermalSpokeAngle( const EDA_ANGLE& aAngle )
    {
        m_padStack.SetThermalSpokeAngle( aAngle );
    }
    EDA_ANGLE GetThermalSpokeAngle() const
    {
        return m_padStack.ThermalSpokeAngle();
    }
 
    // For property system
    void SetThermalSpokeAngleDegrees( double aAngle )
    {
        m_padStack.SetThermalSpokeAngle( EDA_ANGLE( aAngle, DEGREES_T ) );
    }
    double GetThermalSpokeAngleDegrees() const
    {
        return m_padStack.ThermalSpokeAngle().AsDegrees();
    }
 
    void SetThermalGap( int aGap ) { m_padStack.ThermalGap() = aGap; }
    int GetThermalGap() const { return m_padStack.ThermalGap().value_or( 0 ); }
 
    int GetLocalThermalGapOverride( wxString* aSource ) const;
 
    std::optional<int> GetLocalThermalGapOverride() const
    {
        return m_padStack.ThermalGap();
    }
    void SetLocalThermalGapOverride( const std::optional<int>& aOverride )
    {
        m_padStack.ThermalGap() = aOverride;
    }
 
    void SetRoundRectCornerRadius( PCB_LAYER_ID aLayer, double aRadius );

    int GetRoundRectCornerRadius( PCB_LAYER_ID aLayer ) const;
 
    VECTOR2I ShapePos( PCB_LAYER_ID aLayer ) const;

    static void SwapShapePositions( PAD* aLhs, PAD* aRhs );

    void SetRoundRectRadiusRatio( PCB_LAYER_ID aLayer, double aRadiusScale );
    double GetRoundRectRadiusRatio( PCB_LAYER_ID aLayer ) const
    {
        return m_padStack.RoundRectRadiusRatio( aLayer );
    }
 
    // For properties panel, which only supports normal padstacks
    void SetFrontRoundRectRadiusRatio( double aRadiusScale );
    double GetFrontRoundRectRadiusRatio() const
    {
       return m_padStack.RoundRectRadiusRatio( F_Cu );
    }
 
    // For properties panel, which only supports normal padstacks
    void SetFrontRoundRectRadiusSize( int aRadius );
    int  GetFrontRoundRectRadiusSize() const;

    void SetChamferRectRatio( PCB_LAYER_ID aLayer, double aChamferScale );
    double GetChamferRectRatio( PCB_LAYER_ID aLayer ) const
    {
        return m_padStack.ChamferRatio( aLayer );
    }

    void SetChamferPositions( PCB_LAYER_ID aLayer, int aPositions )
    {
        m_padStack.SetChamferPositions( aPositions, aLayer );
    }
 
    int GetChamferPositions( PCB_LAYER_ID aLayer ) const
    {
        return m_padStack.ChamferPositions( aLayer );
    }

    int GetSubRatsnest() const                  { return m_subRatsnest; }
    void SetSubRatsnest( int aSubRatsnest )     { m_subRatsnest = aSubRatsnest; }

    void SetRemoveUnconnected( bool aSet )
    {
        m_padStack.SetUnconnectedLayerMode( aSet ? UNCONNECTED_LAYER_MODE::REMOVE_ALL
                                                 : UNCONNECTED_LAYER_MODE::KEEP_ALL );
    }
 
    bool GetRemoveUnconnected() const
    {
        return m_padStack.UnconnectedLayerMode() != UNCONNECTED_LAYER_MODE::KEEP_ALL;
    }

    void SetKeepTopBottom( bool aSet )
    {
        m_padStack.SetUnconnectedLayerMode( aSet ? UNCONNECTED_LAYER_MODE::REMOVE_EXCEPT_START_AND_END
                                                 : UNCONNECTED_LAYER_MODE::REMOVE_ALL );
    }
 
    bool GetKeepTopBottom() const
    {
        return m_padStack.UnconnectedLayerMode() == UNCONNECTED_LAYER_MODE::REMOVE_EXCEPT_START_AND_END;
    }
 
    void SetUnconnectedLayerMode( UNCONNECTED_LAYER_MODE aMode )
    {
        m_padStack.SetUnconnectedLayerMode( aMode );
    }
 
    UNCONNECTED_LAYER_MODE GetUnconnectedLayerMode() const
    {
        return m_padStack.UnconnectedLayerMode();
    }
 
    bool ConditionallyFlashed( PCB_LAYER_ID aLayer ) const
    {
        switch( m_padStack.UnconnectedLayerMode() )
        {
        case UNCONNECTED_LAYER_MODE::KEEP_ALL:
            return false;
 
        case UNCONNECTED_LAYER_MODE::REMOVE_ALL:
            return true;
 
        case UNCONNECTED_LAYER_MODE::REMOVE_EXCEPT_START_AND_END:
        case UNCONNECTED_LAYER_MODE::START_END_ONLY:
            return aLayer != m_padStack.Drill().start && aLayer != m_padStack.Drill().end;
        }
 
        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_padStack.LayerSet().test( 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( const 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;
    bool HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const override;

    bool HitTest( const VECTOR2I& aPosition, int aAccuracy, PCB_LAYER_ID aLayer ) const;

    std::vector<PCB_SHAPE*> Recombine( bool aIsDryRun, int aMaxError );
 
    wxString GetClass() const override
    {
        return wxT( "PAD" );
    }

    const BOX2I GetBoundingBox() const override;
    const BOX2I GetBoundingBox( PCB_LAYER_ID aLayer ) const;

    static int Compare( const PAD* aPadRef, const PAD* aPadCmp );
 
    void Move( const VECTOR2I& aMoveVector ) override {
        SetPosition( GetPosition() + aMoveVector );
    }
 
    void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
 
    void OnFootprintRescaled( double aRatioX, double aRatioY, double aLinearFactor, const VECTOR2I& aAnchor,
                              const EDA_ANGLE& aParentRotate ) override;
 
    void OnFootprintTransformed() override;
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    BITMAPS GetMenuImage() const override;

    static wxString ShowPadShape( PAD_SHAPE aShape );
    wxString ShowPadShape( PCB_LAYER_ID aLayer ) const;

    wxString ShowLegacyPadShape( PCB_LAYER_ID aLayer ) const;

    wxString ShowPadAttr() const;
 
    EDA_ITEM* Clone() const override;

    PAD* ClonePad() const
    {
        return (PAD*) Clone();
    }

    void BuildEffectiveShapes() const;
    void BuildEffectivePolygon( ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;
 
    virtual std::vector<int> ViewGetLayers() const override;
 
    double ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const override;
 
    virtual const BOX2I ViewBBox() const override;
 
    void ClearZoneLayerOverrides();
 
    const ZONE_LAYER_OVERRIDE& GetZoneLayerOverride( PCB_LAYER_ID aLayer ) const;
 
    void SetZoneLayerOverride( PCB_LAYER_ID aLayer, ZONE_LAYER_OVERRIDE aOverride );
 
    void CheckPad( UNITS_PROVIDER* aUnitsProvider, bool aForPadProperties,
                   const std::function<void( int aErrorCode, const wxString& aMsg )>& aErrorHandler ) const;
 
    BACKDRILL_MODE GetBackdrillMode() const { return m_padStack.GetBackdrillMode(); }
    void SetBackdrillMode( BACKDRILL_MODE aMode ) { m_padStack.SetBackdrillMode( aMode ); }
 
    std::optional<int> GetBottomBackdrillSize() const { return m_padStack.GetBackdrillSize( false ); }
    void SetBottomBackdrillSize( std::optional<int> aSize ) { m_padStack.SetBackdrillSize( false, aSize ); }
 
    PCB_LAYER_ID GetBottomBackdrillLayer() const { return m_padStack.GetBackdrillEndLayer( false ); }
    void SetBottomBackdrillLayer( PCB_LAYER_ID aLayer ) { m_padStack.SetBackdrillEndLayer( false, aLayer ); }
 
    std::optional<int> GetTopBackdrillSize() const { return m_padStack.GetBackdrillSize( true ); }
    void SetTopBackdrillSize( std::optional<int> aSize ) { m_padStack.SetBackdrillSize( true, aSize ); }
 
    PCB_LAYER_ID GetTopBackdrillLayer() const { return m_padStack.GetBackdrillEndLayer( true ); }
    void SetTopBackdrillLayer( PCB_LAYER_ID aLayer ) { m_padStack.SetBackdrillEndLayer( true, aLayer ); }
 
    double Similarity( const BOARD_ITEM& aOther ) const override;
 
    bool operator==( const PAD& aOther ) const;
    bool operator==( const BOARD_ITEM& aBoardItem ) const override;
 
#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:
    const SHAPE_COMPOUND& buildEffectiveShape( PCB_LAYER_ID aLayer ) const;
 
    // Scale a primitive's runtime geometry to the current footprint scale, in the pad frame.
    void rebakePrimitiveToFootprint( PCB_SHAPE* aPrimitive ) const;
 
    struct PAD_DRAW_CACHE_DATA
    {
        // Must be set to true to force rebuild shapes to draw (after geometry change for instance)
        typedef std::map<PCB_LAYER_ID, std::shared_ptr<SHAPE_COMPOUND>> LAYER_SHAPE_MAP;
        typedef std::map<PCB_LAYER_ID, std::array<std::shared_ptr<SHAPE_POLY_SET>, 2>> LAYER_POLYGON_MAP;
 
        BOX2I                          m_effectiveBoundingBox;
        LAYER_SHAPE_MAP                m_effectiveShapes;
        std::shared_ptr<SHAPE_SEGMENT> m_effectiveHoleShape;
        LAYER_POLYGON_MAP              m_effectivePolygons;
        double                         m_lastGalZoomLevel = 0.0;
    };
 
    PAD_DRAW_CACHE_DATA& getDrawCache() const;
 
    void doCheckPad( PCB_LAYER_ID aLayer, UNITS_PROVIDER* aUnitsProvider, bool aForPadProperties,
                     const std::function<void( int aErrorCode, const wxString& aMsg )>& aErrorHandler ) 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_libPos;             // Pad position in parent footprint's library frame
    EDA_ORIENTATION   m_libOrientation;     // Pad orientation in parent footprint's library frame
 
    PADSTACK          m_padStack;
 
    // Mutex for shape building, poly building and zone layer overrides
    mutable std::mutex m_dataMutex;
 
    mutable std::unique_ptr<PAD_DRAW_CACHE_DATA> m_drawCache;
 
    mutable int       m_effectiveBoundingRadius;
 
    int               m_subRatsnest;        // Variable used to handle subnet (block) number in
                                            //   ratsnest computations
 
    PAD_ATTRIB        m_attribute = PAD_ATTRIB::PTH;
 
    PAD_PROP          m_property;           // Property in fab files (BGA, FIDUCIAL, TESTPOINT, etc.)
 
    int               m_lengthPadToDie;     // Length net from pad to die, inside the package
    int               m_delayPadToDie;      // Propagation delay from pad to die
 
    PAD_SIM_ELECTRICAL_TYPE m_simElectricalType{ PAD_SIM_ELECTRICAL_TYPE::NONE };
 
    // Bools at the end for better memory layout
    mutable bool m_polyDirty[2];
    mutable bool m_shapesDirty;
 
    std::map<PCB_LAYER_ID, ZONE_LAYER_OVERRIDE> m_zoneLayerOverrides;
};