footprint.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 1992-2023 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 FOOTPRINT_H
#define FOOTPRINT_H
 
#include <deque>
 
#include <board_item_container.h>
#include <board_item.h>
#include <collectors.h>
#include <layer_ids.h> // ALL_LAYERS definition.
#include <lib_id.h>
#include <list>
 
#include <zones.h>
#include <convert_shape_list_to_polygon.h>
#include <pcb_item_containers.h>
#include <pcb_text.h>
#include <functional>
#include <math/vector3.h>
 
class LINE_READER;
class EDA_3D_CANVAS;
class PAD;
class BOARD;
class MSG_PANEL_ITEM;
class SHAPE;
class REPORTER;
 
namespace KIGFX {
class VIEW;
}
 
enum INCLUDE_NPTH_T
{
 DO_NOT_INCLUDE_NPTH = false,
 INCLUDE_NPTH = true
};
 
enum FOOTPRINT_ATTR_T
{
 FP_THROUGH_HOLE = 0x0001,
 FP_SMD = 0x0002,
 FP_EXCLUDE_FROM_POS_FILES = 0x0004,
 FP_EXCLUDE_FROM_BOM = 0x0008,
 FP_BOARD_ONLY = 0x0010, // Footprint has no corresponding symbol
 FP_JUST_ADDED = 0x0020, // Footprint just added by netlist update
 FP_ALLOW_SOLDERMASK_BRIDGES = 0x0040,
 FP_ALLOW_MISSING_COURTYARD = 0x0080,
 FP_DNP = 0x0100
};
 
class FP_3DMODEL
{
public:
 FP_3DMODEL() :
 // Initialize with sensible values
 m_Scale { 1, 1, 1 },
 m_Rotation { 0, 0, 0 },
 m_Offset { 0, 0, 0 },
 m_Opacity( 1.0 ),
 m_Show( true )
 {
 }
 
 VECTOR3D m_Scale; 
 VECTOR3D m_Rotation; 
 VECTOR3D m_Offset; 
 double m_Opacity;
 wxString m_Filename; 
 bool m_Show; 
};
 
 
class FOOTPRINT : public BOARD_ITEM_CONTAINER
{
public:
 FOOTPRINT( BOARD* parent );
 
 FOOTPRINT( const FOOTPRINT& aFootprint );
 
 // Move constructor and operator needed due to std containers inside the footprint
 FOOTPRINT( FOOTPRINT&& aFootprint );
 
 ~FOOTPRINT();
 
 FOOTPRINT& operator=( const FOOTPRINT& aOther );
 FOOTPRINT& operator=( FOOTPRINT&& aOther );
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && aItem->Type() == PCB_FOOTPRINT_T;
 }
 
 LSET GetPrivateLayers() const { return m_privateLayers; }
 void SetPrivateLayers( LSET aLayers ) { m_privateLayers = aLayers; }
 
 void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT,
 bool aSkipConnectivity = false ) override;
 
 void Remove( BOARD_ITEM* aItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) override;
 
 void ClearAllNets();
 
 bool FixUuids();
 
 BOX2I GetFpPadsLocalBbox() const;
 
 SHAPE_POLY_SET GetBoundingHull() const;
 
 // Virtual function
 const BOX2I GetBoundingBox() const override;
 const BOX2I GetBoundingBox( bool aIncludeText, bool aIncludeInvisibleText ) const;
 
 PADS& Pads() { return m_pads; }
 const PADS& Pads() const { return m_pads; }
 
 DRAWINGS& GraphicalItems() { return m_drawings; }
 const DRAWINGS& GraphicalItems() const { return m_drawings; }
 
 ZONES& Zones() { return m_zones; }
 const ZONES& Zones() const { return m_zones; }
 
 GROUPS& Groups() { return m_groups; }
 const GROUPS& Groups() const { return m_groups; }
 
 bool HasThroughHolePads() const;
 
 std::vector<FP_3DMODEL>& Models() { return m_3D_Drawings; }
 const std::vector<FP_3DMODEL>& Models() const { return m_3D_Drawings; }
 
 void SetPosition( const VECTOR2I& aPos ) override;
 VECTOR2I GetPosition() const override { return m_pos; }
 
 void SetOrientation( const EDA_ANGLE& aNewAngle );
 EDA_ANGLE GetOrientation() const { return m_orient; }
 
 void SetLayerAndFlip( PCB_LAYER_ID aLayer );
 
 // to make property magic work
 PCB_LAYER_ID GetLayer() const override { return BOARD_ITEM::GetLayer(); }
 
 // For property system:
 void SetOrientationDegrees( double aOrientation )
 {
 SetOrientation( EDA_ANGLE( aOrientation, DEGREES_T ) );
 }
 double GetOrientationDegrees() const
 {
 return m_orient.AsDegrees();
 }
 
 const LIB_ID& GetFPID() const { return m_fpid; }
 void SetFPID( const LIB_ID& aFPID ) { m_fpid = aFPID; }
 
 wxString GetFPIDAsString() const { return m_fpid.Format(); }
 void SetFPIDAsString( const wxString& aFPID ) { m_fpid.Parse( aFPID ); }
 
 wxString GetDescription() const { return m_doc; }
 void SetDescription( const wxString& aDoc ) { m_doc = aDoc; }
 
 wxString GetKeywords() const { return m_keywords; }
 void SetKeywords( const wxString& aKeywords ) { m_keywords = aKeywords; }
 
 const KIID_PATH& GetPath() const { return m_path; }
 void SetPath( const KIID_PATH& aPath ) { m_path = aPath; }
 
 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 GetLocalClearance( wxString* aSource ) const
 {
 if( aSource )
 *aSource = wxString::Format( _( "footprint %s" ), GetReference() );
 
 return m_localClearance;
 }
 
 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 SetZoneConnection( ZONE_CONNECTION aType ) { m_zoneConnection = aType; }
 ZONE_CONNECTION GetZoneConnection() const { return m_zoneConnection; }
 
 int GetAttributes() const { return m_attributes; }
 void SetAttributes( int aAttributes ) { m_attributes = aAttributes; }
 
 void SetFlag( int aFlag ) { m_arflag = aFlag; }
 void IncrementFlag() { m_arflag += 1; }
 int GetFlag() const { return m_arflag; }
 
 bool IsNetTie() const
 {
 for( const wxString& group : m_netTiePadGroups )
 {
 if( !group.IsEmpty() )
 return true;
 }
 
 return false;
 }
 
 const std::vector<wxString>& GetNetTiePadGroups() const { return m_netTiePadGroups; }
 
 void ClearNetTiePadGroups()
 {
 m_netTiePadGroups.clear();
 }
 
 void AddNetTiePadGroup( const wxString& aGroup )
 {
 m_netTiePadGroups.emplace_back( aGroup );
 }
 
 std::map<wxString, int> MapPadNumbersToNetTieGroups() const;
 
 std::vector<PAD*> GetNetTiePads( PAD* aPad ) const;
 
 int GetLikelyAttribute() const;
 
 void Move( const VECTOR2I& aMoveVector ) override;
 
 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
 
 void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override;
 
 void MoveAnchorPosition( const VECTOR2I& aMoveVector );
 
 bool IsFlipped() const { return GetLayer() == B_Cu; }
 
 bool IsOnLayer( PCB_LAYER_ID aLayer, bool aIncludeCourtyards = false ) const override;
 
// m_footprintStatus bits:
#define FP_is_LOCKED 0x01 
#define FP_is_PLACED 0x02 
#define FP_to_PLACE 0x04 
#define FP_PADS_are_LOCKED 0x08
 
 
 bool IsLocked() const override
 {
 return ( m_fpStatus & FP_is_LOCKED ) != 0;
 }
 
 void SetLocked( bool isLocked ) override
 {
 if( isLocked )
 m_fpStatus |= FP_is_LOCKED;
 else
 m_fpStatus &= ~FP_is_LOCKED;
 }
 
 bool IsConflicting() const;
 
 bool IsPlaced() const { return m_fpStatus & FP_is_PLACED; }
 void SetIsPlaced( bool isPlaced )
 {
 if( isPlaced )
 m_fpStatus |= FP_is_PLACED;
 else
 m_fpStatus &= ~FP_is_PLACED;
 }
 
 bool NeedsPlaced() const { return m_fpStatus & FP_to_PLACE; }
 void SetNeedsPlaced( bool needsPlaced )
 {
 if( needsPlaced )
 m_fpStatus |= FP_to_PLACE;
 else
 m_fpStatus &= ~FP_to_PLACE;
 }
 
 bool LegacyPadsLocked() const { return m_fpStatus & FP_PADS_are_LOCKED; }
 
 void CheckFootprintAttributes( const std::function<void( const wxString& )>& aErrorHandler );
 
 void CheckPads( const std::function<void( const PAD*, int, const wxString& )>& aErrorHandler );
 
 void CheckShortingPads( const std::function<void( const PAD*,
 const PAD*,
 const VECTOR2I& )>& aErrorHandler );
 
 void CheckNetTies( const std::function<void( const BOARD_ITEM* aItem,
 const BOARD_ITEM* bItem,
 const BOARD_ITEM* cItem,
 const VECTOR2I& )>& aErrorHandler );
 
 void CheckNetTiePadGroups( const std::function<void( const wxString& )>& aErrorHandler );
 
 void TransformPadsToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
 int aMaxError, ERROR_LOC aErrorLoc,
 bool aSkipNPTHPadsWihNoCopper = false,
 bool aSkipPlatedPads = false,
 bool aSkipNonPlatedPads = false ) const;
 
 void TransformFPShapesToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
 int aError, ERROR_LOC aErrorLoc,
 bool aIncludeText = true,
 bool aIncludeShapes = true,
 bool aIncludePrivateItems = false ) const;
 
 void TransformFPTextToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
 int aError, ERROR_LOC aErrorLoc ) const
 {
 TransformFPShapesToPolySet( aBuffer, aLayer, aClearance, aError, aErrorLoc, true, false );
 }
 
 void GetContextualTextVars( wxArrayString* aVars ) const;
 
 bool ResolveTextVar( wxString* token, int aDepth = 0 ) const;
 
 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
 
 bool HitTestAccurate( const VECTOR2I& aPosition, int aAccuracy = 0 ) const;
 
 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
 const wxString& GetReference() const
 {
 return m_reference->GetText();
 }
 
 void SetReference( const wxString& aReference )
 {
 m_reference->SetText( aReference );
 }
 
 // Property system doesn't like const references
 wxString GetReferenceAsString() const
 {
 return GetReference();
 }
 
 void IncrementReference( int aDelta );
 
 const wxString& GetValue() const
 {
 return m_value->GetText();
 }
 
 void SetValue( const wxString& aValue )
 {
 m_value->SetText( aValue );
 }
 
 // Property system doesn't like const references
 wxString GetValueAsString() const
 {
 return GetValue();
 }
 
 PCB_TEXT& Value() { return *m_value; }
 PCB_TEXT& Reference() { return *m_reference; }
 
 PCB_TEXT& Value() const { return *m_value; }
 PCB_TEXT& Reference() const { return *m_reference; }
 
 const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
 void SetProperties( const std::map<wxString, wxString>& aProps ) { m_properties = aProps; }
 const wxString& GetProperty( const wxString& aKey) { return m_properties[ aKey ]; }
 bool HasProperty( const wxString& aKey)
 {
 return m_properties.find( aKey ) != m_properties.end();
 }
 void SetProperty( const wxString& aKey, const wxString& aVal ) { m_properties[ aKey ] = aVal; }
 
 bool IsBoardOnly() const { return m_attributes & FP_BOARD_ONLY; }
 void SetBoardOnly( bool aIsBoardOnly = true )
 {
 if( aIsBoardOnly )
 m_attributes |= FP_BOARD_ONLY;
 else
 m_attributes &= ~FP_BOARD_ONLY;
 }
 
 bool IsExcludedFromPosFiles() const { return m_attributes & FP_EXCLUDE_FROM_POS_FILES; }
 void SetExcludedFromPosFiles( bool aExclude = true )
 {
 if( aExclude )
 m_attributes |= FP_EXCLUDE_FROM_POS_FILES;
 else
 m_attributes &= ~FP_EXCLUDE_FROM_POS_FILES;
 }
 
 bool IsExcludedFromBOM() const { return m_attributes & FP_EXCLUDE_FROM_BOM; }
 void SetExcludedFromBOM( bool aExclude = true )
 {
 if( aExclude )
 m_attributes |= FP_EXCLUDE_FROM_BOM;
 else
 m_attributes &= ~FP_EXCLUDE_FROM_BOM;
 }
 
 bool AllowMissingCourtyard() const { return m_attributes & FP_ALLOW_MISSING_COURTYARD; }
 void SetAllowMissingCourtyard( bool aAllow = true )
 {
 if( aAllow )
 m_attributes |= FP_ALLOW_MISSING_COURTYARD;
 else
 m_attributes &= ~FP_ALLOW_MISSING_COURTYARD;
 }
 
 bool IsDNP() const { return m_attributes & FP_DNP; }
 void SetDNP( bool aDNP = true )
 {
 if( aDNP )
 m_attributes |= FP_DNP;
 else
 m_attributes &= ~FP_DNP;
 }
 
 void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
 int GetFileFormatVersionAtLoad() const { return m_fileFormatVersionAtLoad; }
 
 PAD* FindPadByNumber( const wxString& aPadNumber, PAD* aSearchAfterMe = nullptr ) const;
 
 PAD* GetPad( const VECTOR2I& aPosition, LSET aLayerMask = LSET::AllLayersMask() );
 
 unsigned GetPadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
 
 unsigned GetUniquePadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
 
 wxString GetNextPadNumber( const wxString& aLastPadName ) const;
 
 wxString GetTypeName() const;
 
 double GetArea( int aPadding = 0 ) const;
 
 KIID GetLink() const { return m_link; }
 void SetLink( const KIID& aLink ) { m_link = aLink; }
 
 BOARD_ITEM* Duplicate() const override;
 
 BOARD_ITEM* DuplicateItem( const BOARD_ITEM* aItem, bool aAddToFootprint = false );
 
 void Add3DModel( FP_3DMODEL* a3DModel );
 
 INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
 const std::vector<KICAD_T>& aScanTypes ) override;
 
 wxString GetClass() const override
 {
 return wxT( "FOOTPRINT" );
 }
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 EDA_ITEM* Clone() const override;
 
 void RunOnChildren( const std::function<void (BOARD_ITEM*)>& aFunction ) 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;
 
 static bool IsLibNameValid( const wxString& aName );
 
 static const wxChar* StringLibNameInvalidChars( bool aUserReadable );
 
 bool FootprintNeedsUpdate( const FOOTPRINT* aLibFootprint, REPORTER* aReporter = nullptr );
 
 void SetInitialComments( wxArrayString* aInitialComments )
 {
 delete m_initial_comments;
 m_initial_comments = aInitialComments;
 }
 
 double CoverageRatio( const GENERAL_COLLECTOR& aCollector ) const;
 
 static double GetCoverageArea( const BOARD_ITEM* aItem, const GENERAL_COLLECTOR& aCollector );
 
 const wxArrayString* GetInitialComments() const { return m_initial_comments; }
 
 const SHAPE_POLY_SET& GetCourtyard( PCB_LAYER_ID aLayer ) const;
 
 void BuildCourtyardCaches( OUTLINE_ERROR_HANDLER* aErrorHandler = nullptr );
 
 // @copydoc BOARD_ITEM::GetEffectiveShape
 std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
 FLASHING aFlash = FLASHING::DEFAULT ) const override;
 
#if defined(DEBUG)
 virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
 struct cmp_drawings
 {
 bool operator()( const BOARD_ITEM* itemA, const BOARD_ITEM* itemB ) const;
 };
 
 struct cmp_pads
 {
 bool operator()( const PAD* aFirst, const PAD* aSecond ) const;
 };
 
 struct cmp_zones
 {
 bool operator()( const ZONE* aFirst, const ZONE* aSecond ) const;
 };
 
protected:
 virtual void swapData( BOARD_ITEM* aImage ) override;
 
private:
 DRAWINGS m_drawings; // BOARD_ITEMs for drawings on the board, owned by pointer.
 PADS m_pads; // PAD items, owned by pointer
 ZONES m_zones; // PCB_ZONE items, owned by pointer
 GROUPS m_groups; // PCB_GROUP items, owned by pointer
 
 EDA_ANGLE m_orient; // Orientation
 VECTOR2I m_pos; // Position of footprint on the board in internal units.
 PCB_TEXT* m_reference; // Component reference designator value (U34, R18..)
 PCB_TEXT* m_value; // Component value (74LS00, 22K..)
 LIB_ID m_fpid; // The #LIB_ID of the FOOTPRINT.
 int m_attributes; // Flag bits (see FOOTPRINT_ATTR_T)
 int m_fpStatus; // For autoplace: flags (LOCKED, FIELDS_AUTOPLACED)
 int m_fileFormatVersionAtLoad;
 
 // Bounding box caching strategy:
 // While we attempt to notice the low-hanging fruit operations and update the bounding boxes
 // accordingly, we rely mostly on a "if anything changed then the caches are stale" approach.
 // We implement this by having PCB_BASE_FRAME's OnModify() method increment an operation
 // counter, and storing that as a timestamp for the various caches.
 // This means caches will get regenerated often -- but still far less often than if we had no
 // caches at all. The principal opitmization would be to change to dirty flag and make sure
 // that any edit that could affect the bounding boxes (including edits to the footprint
 // children) marked the bounding boxes dirty. It would definitely be faster -- but also more
 // fragile.
 mutable BOX2I m_cachedBoundingBox;
 mutable int m_boundingBoxCacheTimeStamp;
 mutable BOX2I m_cachedVisibleBBox;
 mutable int m_visibleBBoxCacheTimeStamp;
 mutable BOX2I m_cachedTextExcludedBBox;
 mutable int m_textExcludedBBoxCacheTimeStamp;
 mutable SHAPE_POLY_SET m_cachedHull;
 mutable int m_hullCacheTimeStamp;
 
 // A list of pad groups, each of which is allowed to short nets within their group.
 // A pad group is a comma-separated list of pad numbers.
 std::vector<wxString> m_netTiePadGroups;
 
 ZONE_CONNECTION m_zoneConnection;
 int m_localClearance;
 int m_localSolderMaskMargin; // Solder mask margin
 int m_localSolderPasteMargin; // Solder paste margin absolute value
 double m_localSolderPasteMarginRatio; // Solder mask margin ratio value of pad size
 
 wxString m_doc; // File name and path for documentation file.
 wxString m_keywords; // Search keywords to find footprint in library.
 KIID_PATH m_path; // Path to associated symbol ([sheetUUID, .., symbolUUID]).
 timestamp_t m_lastEditTime;
 int m_arflag; // Use to trace ratsnest and auto routing.
 KIID m_link; // Temporary logical link used during editing
 LSET m_privateLayers; // Layers visible only in the footprint editor
 
 std::vector<FP_3DMODEL> m_3D_Drawings; // 3D models.
 std::map<wxString, wxString> m_properties;
 wxArrayString* m_initial_comments; // s-expression comments in the footprint,
 // lazily allocated only if needed for speed
 
 SHAPE_POLY_SET m_courtyard_cache_front; // Note that a footprint can have both front and back
 SHAPE_POLY_SET m_courtyard_cache_back; // courtyards populated.
 mutable int m_courtyard_cache_timestamp;
};
 
#endif // FOOTPRINT_H