class_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-2018 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 "zones.h"
#include <board_connected_item.h>
#include <class_board_item.h>
#include <config_params.h> // PARAM_CFG_ARRAY
#include <convert_to_biu.h>
#include <geometry/shape_poly_set.h>
#include <pad_shapes.h>
#include <pcbnew.h>

class DRAWSEGMENT;

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 MODULE;
class EDGE_MODULE;
class TRACK;
class MSG_PANEL_INFO;

namespace KIGFX
{
    class VIEW;
}

// Helper class to store parameters used to draw a pad
class PAD_DRAWINFO
{
public:
    COLOR4D m_Color;              // color used to draw the pad shape , from pad layers and
                                  // visible layers
    COLOR4D m_HoleColor;          // color used to draw the pad hole
    COLOR4D m_NPHoleColor;        // color used to draw a pad Not Plated hole
    COLOR4D m_NoNetMarkColor;     // color used to draw a mark on pads having no net
    int m_PadClearance;           // clearance value, used to draw the pad area outlines
    wxSize m_Mask_margin;         // margin, used to draw solder paste when only one layer is shown
    bool m_Display_padnum;        // true to show pad number
    bool m_Display_netname;       // true to show net name
    bool m_ShowPadFilled;         // true to show pad as solid area, false to show pas in
                                  // sketch mode
    bool m_ShowNCMark;            // true to show pad not connected mark
    bool m_ShowNotPlatedHole;     // true when the pad hole in not plated, to draw a specific
                                  // pad shape
    bool m_IsPrinting;            // true to print, false to display on screen.
    wxPoint m_Offset;             // general draw offset

    PAD_DRAWINFO();
};

class PAD_CS_PRIMITIVE
{
public:
    STROKE_T m_Shape;   
    int m_Thickness;    
                        // if thickness is not = 0 S_CIRCLE shape is a ring
    int m_Radius;       
    double m_ArcAngle;  
    wxPoint m_Start;    
    wxPoint m_End;      
    wxPoint m_Ctrl1;    
    wxPoint m_Ctrl2;    
    std::vector<wxPoint> m_Poly;

    PAD_CS_PRIMITIVE( STROKE_T aShape ):
        m_Shape( aShape ), m_Thickness( 0 ), m_Radius( 0 ), m_ArcAngle( 0 )
    {
    }

    // Accessors (helpers for arc and circle shapes)
    wxPoint GetCenter() { return m_Start; }     
    wxPoint GetArcStart() { return m_End; }     

    // Geometric transform
    void Move( wxPoint aMoveVector );

    void Rotate( const wxPoint& aRotCentre, double aAngle );

    void ExportTo( DRAWSEGMENT* aTarget );

    void ExportTo( EDGE_MODULE* aTarget );
};


class D_PAD : public BOARD_CONNECTED_ITEM
{
public:
    static int  m_PadSketchModePenSize; 

public:
    D_PAD( MODULE* parent );

    // Do not create a copy constructor & operator=.
    // The ones generated by the compiler are adequate.

    /* 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 StandardMask();     
    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();
    }

    MODULE* GetParent() const { return (MODULE*) m_Parent; }

    void ImportSettingsFrom( const D_PAD& aMasterPad );

    bool IsFlipped() const;

    void SetName( const wxString& aName )
    {
        m_name = aName;
    }

    const wxString& GetName() const
    {
        return m_name;
    }

    bool IncrementPadName( bool aSkipUnconnectable, bool aFillSequenceGaps );

    bool PadNameEqual( const D_PAD* other ) const
    {
        return m_name == other->m_name; // hide tricks behind sensible API
    }

    PAD_SHAPE_T GetShape() const                { return m_padShape; }
    void SetShape( PAD_SHAPE_T aShape )         { m_padShape = aShape; m_boundingRadius = -1; }

    void SetPosition( const wxPoint& aPos ) override { m_Pos = aPos; }
    const wxPoint GetPosition() const override { return m_Pos; }

    PAD_SHAPE_T 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_T aShape )
    {
        m_anchorPadShape = ( aShape ==  PAD_SHAPE_RECT ) ? PAD_SHAPE_RECT : PAD_SHAPE_CIRCLE;
        m_boundingRadius = -1;
    }

    void SetY( int y )                          { m_Pos.y = y; }
    void SetX( int x )                          { m_Pos.x = x; }

    void SetPos0( const wxPoint& aPos )         { m_Pos0 = aPos; }
    const wxPoint& GetPos0() const              { return m_Pos0; }

    void SetY0( int y )                         { m_Pos0.y = y; }
    void SetX0( int x )                         { m_Pos0.x = x; }

    void SetSize( const wxSize& aSize )         { m_Size = aSize;  m_boundingRadius = -1; }
    const wxSize& GetSize() const               { return m_Size; }

    void SetDelta( const wxSize& aSize )        { m_DeltaSize = aSize;  m_boundingRadius = -1; }
    const wxSize& GetDelta() const              { return m_DeltaSize; }

    void SetDrillSize( const wxSize& aSize )    { m_Drill = aSize; }
    const wxSize& GetDrillSize() const          { return m_Drill; }

    void SetOffset( const wxPoint& aOffset )    { m_Offset = aOffset; }
    const wxPoint& GetOffset() const            { return m_Offset; }

    void AddPrimitive( const SHAPE_POLY_SET& aPoly, int aThickness );  
    void AddPrimitive( const std::vector<wxPoint>& aPoly, int aThickness );  
    void AddPrimitive( wxPoint aStart, wxPoint aEnd, int aThickness ); 
    void AddPrimitive( wxPoint aCenter, int aRadius, int aThickness ); 
    void AddPrimitive( wxPoint aCenter, wxPoint aStart,
                        int aArcAngle, int aThickness );    
    void AddPrimitive( wxPoint aStart, wxPoint aEnd, wxPoint aCtrl1,
                        wxPoint aCtrl2, int aThickness );              


    bool GetBestAnchorPosition( VECTOR2I& aPos );

    bool MergePrimitivesAsPolygon( SHAPE_POLY_SET* aMergedPolygon = NULL );

    void DeletePrimitivesList();

    void CustomShapeAsPolygonToBoardPosition( SHAPE_POLY_SET * aMergedPolygon,
                                    wxPoint aPosition, double aRotation ) const;

    const std::vector<PAD_CS_PRIMITIVE>& GetPrimitives() const { return m_basicShapes; }

    const SHAPE_POLY_SET& GetCustomShapeAsPolygon() const { return m_customShapeAsPolygon; }

    void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;

    void FlipPrimitives();

    void MirrorXPrimitives( int aX );

    bool SetPrimitives( const std::vector<PAD_CS_PRIMITIVE>& aPrimitivesList );

    bool AddPrimitives( const std::vector<PAD_CS_PRIMITIVE>& aPrimitivesList );


    void SetOrientation( double aAngle );

    void SetOrientationDegrees( double aOrientation ) { SetOrientation( aOrientation*10.0 ); }

    double GetOrientation() const { return m_Orient; }
    double GetOrientationDegrees() const   { return m_Orient/10.0; }
    double GetOrientationRadians() const   { return m_Orient*M_PI/1800; }

    void SetDrillShape( PAD_DRILL_SHAPE_T aDrillShape )
        { m_drillShape = aDrillShape; }
    PAD_DRILL_SHAPE_T GetDrillShape() const     { return m_drillShape; }

    void GetOblongDrillGeometry( wxPoint& aStartPoint, wxPoint& aEndPoint, int& aWidth ) const;

    void SetLayerSet( LSET aLayerMask )         { m_layerMask = aLayerMask; }
    LSET GetLayerSet() const override           { return m_layerMask; }

    void SetAttribute( PAD_ATTR_T aAttribute );
    PAD_ATTR_T GetAttribute() const             { return m_Attribute; }

    // 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; }

    int GetLocalSolderMaskMargin() const        { return m_LocalSolderMaskMargin; }
    void SetLocalSolderMaskMargin( int aMargin ) { m_LocalSolderMaskMargin = aMargin; }

    int GetLocalClearance() const               { return m_LocalClearance; }
    void SetLocalClearance( int aClearance )    { m_LocalClearance = aClearance; }

    int GetLocalSolderPasteMargin() const       { return m_LocalSolderPasteMargin; }
    void SetLocalSolderPasteMargin( int aMargin ) { m_LocalSolderPasteMargin = aMargin; }

    double GetLocalSolderPasteMarginRatio() const { return m_LocalSolderPasteMarginRatio; }
    void SetLocalSolderPasteMarginRatio( double aRatio ) { m_LocalSolderPasteMarginRatio = aRatio; }


    void TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer, int aClearanceValue,
            int aMaxError = ARC_HIGH_DEF, bool ignoreLineWidth = false ) const override;

    int GetClearance( BOARD_CONNECTED_ITEM* aItem = NULL ) const override;

   // Mask margins handling:

    int GetSolderMaskMargin() const;

    wxSize GetSolderPasteMargin() const;

    void SetZoneConnection( ZoneConnection aType ) { m_ZoneConnection = aType; }
    ZoneConnection GetZoneConnection() const;

    void SetThermalWidth( int aWidth ) { m_ThermalWidth = aWidth; }
    int GetThermalWidth() const;

    void SetThermalGap( int aGap ) { m_ThermalGap = aGap; }
    int GetThermalGap() const;

    void Print( PCB_BASE_FRAME* aFrame, wxDC* aDC, const wxPoint& aOffset = ZeroOffset ) override;

    void PrintShape( wxDC* aDC, PAD_DRAWINFO& aDrawInfo );

    void BuildPadPolygon( wxPoint aCoord[4], wxSize aInflateValue, double aRotation ) const;

    int GetRoundRectCornerRadius() const
    {
        return GetRoundRectCornerRadius( m_Size );
    }

    int GetRoundRectCornerRadius( const wxSize& aSize ) const;

    void SetRoundRectCornerRadius( double aRadius );

    void BuildPadShapePolygon(
            SHAPE_POLY_SET& aCornerBuffer, wxSize aInflateValue, int aError = ARC_HIGH_DEF ) const;

    bool BuildPadDrillShapePolygon(
            SHAPE_POLY_SET& aCornerBuffer, int aInflateValue, int aError = ARC_HIGH_DEF ) const;

    int BuildSegmentFromOvalShape( wxPoint& aSegStart, wxPoint& aSegEnd,
                                   double aRotation, const wxSize& aMargin ) const;

    int GetBoundingRadius() const
    {
        // Any member function which would affect this calculation should set
        // m_boundingRadius to -1 to re-trigger the calculation from here.
        // Currently that is only m_Size, m_DeltaSize, and m_padShape accessors.
        if( m_boundingRadius == -1 )
        {
            m_boundingRadius = boundingRadius();
        }

        return m_boundingRadius;
    }

    wxPoint ShapePos() const;

    double GetRoundRectRadiusRatio() const
    {
        return m_padRoundRectRadiusScale;
    }

    void SetRoundRectRadiusRatio( double aRadiusScale )
    {
        if( aRadiusScale < 0.0 )
            aRadiusScale = 0.0;

        m_padRoundRectRadiusScale = std::min( aRadiusScale, 0.5 );
    }

    double GetChamferRectRatio() const
    {
        return m_padChamferRectScale;
    }

    void SetChamferRectRatio( double aChamferScale )
    {
        if( aChamferScale < 0.0 )
            aChamferScale = 0.0;

        m_padChamferRectScale = std::min( aChamferScale, 0.5 );
    }

    int GetChamferPositions() const { return m_chamferPositions; }

    void SetChamferPositions( int aChamferPositions )
    {
        m_chamferPositions = aChamferPositions;
    }

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

    void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;

    bool IsOnLayer( PCB_LAYER_ID aLayer ) const override
    {
        return m_layerMask[aLayer];
    }

    bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
    bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;

    wxString GetClass() const override
    {
        return wxT( "PAD" );
    }

    // Virtual function:
    const EDA_RECT GetBoundingBox() const override;

    void SetDrawCoord();

    //todo: Remove SetLocalCoord along with m_pos
    void SetLocalCoord();

    static int Compare( const D_PAD* padref, const D_PAD* padcmp );

    void Move( const wxPoint& aMoveVector ) override
    {
        m_Pos += aMoveVector;
        SetLocalCoord();
    }

    void Rotate( const wxPoint& aRotCentre, double aAngle ) override;

    wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;

    BITMAP_DEF GetMenuImage() const override;

    wxString ShowPadShape() const;

    wxString ShowPadAttr() const;

    void AppendConfigs( PARAM_CFG_ARRAY* aResult );

    EDA_ITEM* Clone() const override;

    D_PAD* Duplicate() const
    {
        return (D_PAD*) Clone();
    }

    bool PadShouldBeNPTH() const;

    virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;

    virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;

    virtual const BOX2I ViewBBox() const override;

    virtual void SwapData( BOARD_ITEM* aImage ) override;

#if defined(DEBUG)
    virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif


private:
    int boundingRadius() const;

    bool buildCustomPadPolygon( SHAPE_POLY_SET* aMergedPolygon, int aError );

private:    // Private variable members:

    // Actually computed and cached on demand by the accessor
    mutable int m_boundingRadius;  

    wxString    m_name;

    // TODO: Remove m_Pos from Pad or make private.  View positions calculated from m_Pos0
    wxPoint     m_Pos;              

    PAD_SHAPE_T m_padShape;         

    std::vector<PAD_CS_PRIMITIVE> m_basicShapes;

    SHAPE_POLY_SET m_customShapeAsPolygon;

    CUST_PAD_SHAPE_IN_ZONE  m_customShapeClearanceArea;

    int         m_SubRatsnest;      

    wxSize      m_Drill;            

    wxSize      m_Size;             

    PAD_DRILL_SHAPE_T m_drillShape; 

    double      m_padRoundRectRadiusScale;  
    double      m_padChamferRectScale;      
    int m_chamferPositions;                 

    PAD_SHAPE_T m_anchorPadShape;         

    wxPoint     m_Offset;

    LSET        m_layerMask;        

    wxSize      m_DeltaSize;        

    wxPoint     m_Pos0;             

    PAD_ATTR_T  m_Attribute;        
    double      m_Orient;           

    int         m_LengthPadToDie;   

    int         m_LocalClearance;


    int         m_LocalSolderMaskMargin;        
    int         m_LocalSolderPasteMargin;       

    double      m_LocalSolderPasteMarginRatio;  
    ZoneConnection m_ZoneConnection;

    int         m_ThermalWidth;
    int         m_ThermalGap;
};

#endif  // PAD_H_