kicad/pcbnew/footprint.h

745 lines
28 KiB
C
Raw Normal View History

/*
* 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
2020-02-20 12:11:04 +00:00
* Copyright (C) 1992-2020 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
*/
2020-11-13 00:43:45 +00:00
#ifndef FOOTPRINT_H
#define FOOTPRINT_H
2019-06-01 23:23:36 +00:00
#include <deque>
2016-05-13 15:31:54 +00:00
#include <board_item_container.h>
2020-11-14 18:11:28 +00:00
#include <board_item.h>
#include <collectors.h>
#include <convert_to_biu.h>
#include <layers_id_colors_and_visibility.h> // ALL_LAYERS definition.
#include <lib_id.h>
#include <list>
#include <zones.h>
#include <convert_drawsegment_list_to_polygon.h>
#include <fp_text.h>
#include <zone.h>
#include <functional>
class LINE_READER;
2011-09-17 15:31:21 +00:00
class EDA_3D_CANVAS;
2020-11-12 22:30:02 +00:00
class PAD;
class BOARD;
class MSG_PANEL_ITEM;
class SHAPE;
namespace KIGFX {
class VIEW;
2017-11-02 20:41:29 +00:00
}
2015-01-04 07:19:04 +00:00
enum INCLUDE_NPTH_T
{
DO_NOT_INCLUDE_NPTH = false,
INCLUDE_NPTH = true
};
2011-12-12 08:37:05 +00:00
/**
* Enum FOOTPRINT_ATTR_T
* is the set of attributes allowed within a FOOTPRINT, using FOOTPRINT::SetAttributes()
* and FOOTPRINT::GetAttributes(). These are to be ORed together when calling
* FOOTPRINT::SetAttributes()
2011-12-12 08:37:05 +00:00
*/
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
};
2020-11-13 00:43:45 +00:00
class FP_3DMODEL
{
public:
2020-11-13 00:43:45 +00:00
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 )
{
}
struct VECTOR3D
{
double x, y, z;
};
VECTOR3D m_Scale; ///< 3D model scaling factor (dimensionless)
VECTOR3D m_Rotation; ///< 3D model rotation (degrees)
VECTOR3D m_Offset; ///< 3D model offset (mm)
double m_Opacity;
wxString m_Filename; ///< The 3D shape filename in 3D library
2020-11-13 02:57:11 +00:00
bool m_Show; ///< Include model in rendering
};
2020-11-12 22:30:02 +00:00
DECL_DEQ_FOR_SWIG( PADS, PAD* )
2019-06-01 23:23:36 +00:00
DECL_DEQ_FOR_SWIG( DRAWINGS, BOARD_ITEM* )
DECL_VEC_FOR_SWIG( FP_ZONES, FP_ZONE* )
2020-11-13 15:15:52 +00:00
DECL_VEC_FOR_SWIG( FP_GROUPS, PCB_GROUP* )
DECL_DEQ_FOR_SWIG( FOOTPRINTS, FOOTPRINT* )
2019-06-01 23:23:36 +00:00
2020-11-13 15:15:52 +00:00
class FOOTPRINT : public BOARD_ITEM_CONTAINER
{
public:
2020-11-13 15:15:52 +00:00
FOOTPRINT( BOARD* parent );
2020-11-13 15:15:52 +00:00
FOOTPRINT( const FOOTPRINT& aFootprint );
2020-11-13 02:57:11 +00:00
// Move constructor and operator needed due to std containers inside the footprint
2020-11-13 15:15:52 +00:00
FOOTPRINT( FOOTPRINT&& aFootprint );
2020-11-13 15:15:52 +00:00
~FOOTPRINT();
2020-11-13 15:15:52 +00:00
FOOTPRINT& operator=( const FOOTPRINT& aOther );
FOOTPRINT& operator=( FOOTPRINT&& aOther );
static inline bool ClassOf( const EDA_ITEM* aItem )
{
2020-11-13 12:21:02 +00:00
return aItem && aItem->Type() == PCB_FOOTPRINT_T;
}
2016-05-13 15:31:54 +00:00
///> @copydoc BOARD_ITEM_CONTAINER::Add()
2019-12-28 00:55:11 +00:00
void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT ) override;
2016-05-13 15:31:54 +00:00
///> @copydoc BOARD_ITEM_CONTAINER::Remove()
void Remove( BOARD_ITEM* aItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) override;
/**
* Function ClearAllNets
* Clear (i.e. force the ORPHANED dummy net info) the net info which
* depends on a given board for all pads of the footprint.
* This is needed when a footprint is copied between the fp editor and
* the board editor for instance, because net info become fully broken
*/
void ClearAllNets();
/**
* Function CalculateBoundingBox
* calculates the bounding box in board coordinates.
*/
void CalculateBoundingBox();
/**
* Function GetFootprintRect()
2020-11-13 02:57:11 +00:00
* Build and returns the boundary box of the footprint excluding any text.
* @return EDA_RECT - The rectangle containing the footprint.
*/
EDA_RECT GetFootprintRect() const;
/**
* Returns the last calculated bounding box of the footprint (does not recalculate it).
* (call CalculateBoundingBox() to recalculate it)
* @return EDA_RECT - The rectangle containing the footprint
*/
2020-11-13 02:57:11 +00:00
EDA_RECT GetBoundingBoxBase() const { return m_boundingBox; }
/**
* Returns the bounding box containing pads when the footprint
* is on the front side, orientation 0, position 0,0.
* mainly used in Gerber place file to draw a fp outline when the coutyard
* is missing or broken
* @return EDA_RECT - The rectangle containing the pads for the normalized footprint.
*/
EDA_RECT GetFpPadsLocalBbox() const;
/**
2020-11-13 02:57:11 +00:00
* Returns a bounding polygon for the shapes and pads in the footprint
* This operation is slower but more accurate than calculating a bounding box
*/
SHAPE_POLY_SET GetBoundingHull() const;
// Virtual function
2016-09-24 18:53:15 +00:00
const EDA_RECT GetBoundingBox() const override;
const EDA_RECT GetBoundingBox( bool aIncludeInvisibleText ) const;
PADS& Pads() { return m_pads; }
const PADS& Pads() const { return m_pads; }
2019-06-01 23:23:36 +00:00
DRAWINGS& GraphicalItems() { return m_drawings; }
const DRAWINGS& GraphicalItems() const { return m_drawings; }
FP_ZONES& Zones() { return m_fp_zones; }
const FP_ZONES& Zones() const { return m_fp_zones; }
2020-11-13 15:15:52 +00:00
FP_GROUPS& Groups() { return m_fp_groups; }
const FP_GROUPS& Groups() const { return m_fp_groups; }
2017-03-22 13:11:08 +00:00
bool HasThroughHolePads() const;
2019-09-15 09:10:53 +00:00
2020-11-13 00:43:45 +00:00
std::list<FP_3DMODEL>& Models() { return m_3D_Drawings; }
const std::list<FP_3DMODEL>& Models() const { return m_3D_Drawings; }
2016-09-24 18:53:15 +00:00
void SetPosition( const wxPoint& aPos ) override;
2020-11-13 02:57:11 +00:00
wxPoint GetPosition() const override { return m_pos; }
2007-12-01 03:42:52 +00:00
void SetOrientation( double aNewAngle );
void SetOrientationDegrees( double aOrientation ) { SetOrientation( aOrientation * 10.0 ); }
2020-11-13 02:57:11 +00:00
double GetOrientation() const { return m_orient; }
double GetOrientationDegrees() const { return m_orient / 10.0; }
double GetOrientationRadians() const { return m_orient * M_PI / 1800; }
const LIB_ID& GetFPID() const { return m_fpid; }
void SetFPID( const LIB_ID& aFPID ) { m_fpid = aFPID; }
2011-12-12 08:37:05 +00:00
2020-11-13 02:57:11 +00:00
const wxString& GetDescription() const { return m_doc; }
void SetDescription( const wxString& aDoc ) { m_doc = aDoc; }
2011-12-12 08:37:05 +00:00
2020-11-13 02:57:11 +00:00
const wxString& GetKeywords() const { return m_keywords; }
void SetKeywords( const wxString& aKeywords ) { m_keywords = aKeywords; }
2011-12-12 08:37:05 +00:00
2020-11-13 02:57:11 +00:00
const KIID_PATH& GetPath() const { return m_path; }
void SetPath( const KIID_PATH& aPath ) { m_path = aPath; }
2011-12-12 08:37:05 +00:00
2020-11-13 02:57:11 +00:00
int GetLocalSolderMaskMargin() const { return m_localSolderMaskMargin; }
void SetLocalSolderMaskMargin( int aMargin ) { m_localSolderMaskMargin = aMargin; }
2011-12-12 08:37:05 +00:00
2020-11-13 02:57:11 +00:00
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() );
2020-11-13 02:57:11 +00:00
return m_localClearance;
}
2020-11-13 02:57:11 +00:00
int GetLocalSolderPasteMargin() const { return m_localSolderPasteMargin; }
void SetLocalSolderPasteMargin( int aMargin ) { m_localSolderPasteMargin = aMargin; }
2011-12-12 08:37:05 +00:00
2020-11-13 02:57:11 +00:00
double GetLocalSolderPasteMarginRatio() const { return m_localSolderPasteMarginRatio; }
void SetLocalSolderPasteMarginRatio( double aRatio ) { m_localSolderPasteMarginRatio = aRatio; }
2011-12-12 08:37:05 +00:00
2020-11-13 02:57:11 +00:00
void SetZoneConnection( ZONE_CONNECTION aType ) { m_zoneConnection = aType; }
ZONE_CONNECTION GetZoneConnection() const { return m_zoneConnection; }
2020-11-13 02:57:11 +00:00
void SetThermalWidth( int aWidth ) { m_thermalWidth = aWidth; }
int GetThermalWidth() const { return m_thermalWidth; }
2020-11-13 02:57:11 +00:00
void SetThermalGap( int aGap ) { m_thermalGap = aGap; }
int GetThermalGap() const { return m_thermalGap; }
2020-11-13 02:57:11 +00:00
int GetAttributes() const { return m_attributes; }
void SetAttributes( int aAttributes ) { m_attributes = aAttributes; }
2011-12-12 08:37:05 +00:00
void SetFlag( int aFlag ) { m_arflag = aFlag; }
void IncrementFlag() { m_arflag += 1; }
int GetFlag() const { return m_arflag; }
// A bit of a hack until net ties are supported as first class citizens
bool IsNetTie() const { return GetKeywords().StartsWith( wxT( "net tie" ) ); }
2016-09-24 18:53:15 +00:00
void Move( const wxPoint& aMoveVector ) override;
2016-09-24 18:53:15 +00:00
void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
2009-08-01 19:26:05 +00:00
void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;
/**
* Function MoveAnchorPosition
* Move the reference point of the footprint
* It looks like a move footprint:
* the footprints elements (pads, outlines, edges .. ) are moved
* However:
* - the footprint position is not modified.
* - the relative (local) coordinates of these items are modified
* (a move footprint does not change these local coordinates,
* but changes the footprint position)
*/
void MoveAnchorPosition( const wxPoint& aMoveVector );
/**
* function IsFlipped
2020-11-13 02:57:11 +00:00
* @return true if the footprint is flipped, i.e. on the back side of the board
*/
bool IsFlipped() const { return GetLayer() == B_Cu; }
/**
* A special IsOnLayer for footprints: return true if the footprint contains only items on the
* given layer, even if that layer is not one of the valid footprint layers F_Cu and B_Cu.
* This allows selection of "graphic" footprints that contain only silkscreen, for example.
*/
bool IsOnLayer( PCB_LAYER_ID aLayer ) const override;
2020-11-13 02:57:11 +00:00
// m_footprintStatus bits:
#define FP_is_LOCKED 0x01 ///< footprint LOCKED: no autoplace allowed
#define FP_is_PLACED 0x02 ///< In autoplace: footprint automatically placed
#define FP_to_PLACE 0x04 ///< In autoplace: footprint waiting for autoplace
#define FP_PADS_are_LOCKED 0x08
2016-09-24 18:53:15 +00:00
bool IsLocked() const override
{
2020-11-13 11:17:15 +00:00
return ( m_fpStatus & FP_is_LOCKED ) != 0;
}
/**
* Function SetLocked
* sets the MODULE_is_LOCKED bit in the m_ModuleStatus
2011-12-12 08:37:05 +00:00
* @param isLocked When true means turn on locked status, else unlock
*/
2016-09-24 18:53:15 +00:00
void SetLocked( bool isLocked ) override
{
2011-12-12 08:37:05 +00:00
if( isLocked )
2020-11-13 11:17:15 +00:00
m_fpStatus |= FP_is_LOCKED;
else
2020-11-13 11:17:15 +00:00
m_fpStatus &= ~FP_is_LOCKED;
}
2020-11-13 11:17:15 +00:00
bool IsPlaced() const { return m_fpStatus & FP_is_PLACED; }
void SetIsPlaced( bool isPlaced )
{
if( isPlaced )
2020-11-13 11:17:15 +00:00
m_fpStatus |= FP_is_PLACED;
else
2020-11-13 11:17:15 +00:00
m_fpStatus &= ~FP_is_PLACED;
}
2020-11-13 11:17:15 +00:00
bool NeedsPlaced() const { return m_fpStatus & FP_to_PLACE; }
void SetNeedsPlaced( bool needsPlaced )
{
if( needsPlaced )
2020-11-13 11:17:15 +00:00
m_fpStatus |= FP_to_PLACE;
else
2020-11-13 11:17:15 +00:00
m_fpStatus &= ~FP_to_PLACE;
}
2020-11-13 11:17:15 +00:00
bool PadsLocked() const { return m_fpStatus & FP_PADS_are_LOCKED; }
2015-02-18 16:53:46 +00:00
void SetPadsLocked( bool aPadsLocked )
{
if( aPadsLocked )
2020-11-13 11:17:15 +00:00
m_fpStatus |= FP_PADS_are_LOCKED;
else
2020-11-13 11:17:15 +00:00
m_fpStatus &= ~FP_PADS_are_LOCKED;
}
2020-11-13 02:57:11 +00:00
void SetLastEditTime( timestamp_t aTime ) { m_lastEditTime = aTime; }
void SetLastEditTime() { m_lastEditTime = time( NULL ); }
timestamp_t GetLastEditTime() const { return m_lastEditTime; }
/* drawing functions */
/**
* function TransformPadsShapesWithClearanceToPolygon
* generate pads shapes on layer aLayer as polygons and adds these polygons to aCornerBuffer
* Useful to generate a polygonal representation of a footprint in 3D view and plot functions,
* when a full polygonal approach is needed
* @param aLayer = the layer to consider, or UNDEFINED_LAYER to consider all
* @param aCornerBuffer = the buffer to store polygons
* @param aClearance = an additionnal size to add to pad shapes
* @param aMaxError = Maximum deviation from true for arcs
* @param aSkipNPTHPadsWihNoCopper = if true, do not add a NPTH pad shape, if the shape has
* same size and position as the hole. Usually, these pads are not drawn on copper
* layers, because there is actually no copper
* Due to diff between layers and holes, these pads must be skipped to be sure
* there is no copper left on the board (for instance when creating Gerber Files or
* 3D shapes). Defaults to false.
* @param aSkipPlatedPads = used on 3D-Viewer to extract plated and nontplated pads.
* @param aSkipNonPlatedPads = used on 3D-Viewer to extract plated and plated pads.
*/
2020-11-13 00:43:45 +00:00
void TransformPadsWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer,
PCB_LAYER_ID aLayer, int aClearance,
int aMaxError, ERROR_LOC aErrorLoc,
bool aSkipNPTHPadsWihNoCopper = false,
bool aSkipPlatedPads = false,
bool aSkipNonPlatedPads = false ) const;
/**
2020-11-13 00:43:45 +00:00
* function TransformFPShapesWithClearanceToPolygon
* generate shapes of graphic items (outlines) on layer aLayer as polygons and adds these
* polygons to aCornerBuffer
* Useful to generate a polygonal representation of a footprint in 3D view and plot functions,
* when a full polygonal approach is needed
* @param aLayer = the layer to consider, or UNDEFINED_LAYER to consider all
* @param aCornerBuffer = the buffer to store polygons
* @param aClearance = a value to inflate shapes
* @param aError = Maximum error between true arc and polygon approx
* @param aIncludeText = True to transform text shapes
2020-11-13 02:57:11 +00:00
* @param aIncludeShapes = True to transform footprint shapes
*/
2020-11-13 00:43:45 +00:00
void TransformFPShapesWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer,
PCB_LAYER_ID aLayer, int aClearance,
int aError, ERROR_LOC aErrorLoc,
bool aIncludeText = true,
2020-11-13 02:57:11 +00:00
bool aIncludeShapes = true ) const;
/**
2020-11-13 00:43:45 +00:00
* @brief TransformFPTextWithClearanceToPolygonSet
* This function is the same as TransformGraphicShapesWithClearanceToPolygonSet
* but only generate text
*/
2020-11-13 00:43:45 +00:00
void TransformFPTextWithClearanceToPolygonSet( SHAPE_POLY_SET& aCornerBuffer,
PCB_LAYER_ID aLayer, int aClearance,
int aError, ERROR_LOC aErrorLoc ) const
{
2020-11-13 00:43:45 +00:00
TransformFPShapesWithClearanceToPolygon( aCornerBuffer, aLayer, aClearance, aError,
aErrorLoc, true, false );
}
/**
* Return the list of system text vars for this footprint.
*/
void GetContextualTextVars( wxArrayString* aVars ) const;
/**
* Resolve any references to system tokens supported by the component.
* @param aDepth a counter to limit recursion and circular references.
*/
bool ResolveTextVar( wxString* token, int aDepth = 0 ) const;
///> @copydoc EDA_ITEM::GetMsgPanelInfo
void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
2007-08-08 03:50:44 +00:00
/**
2020-11-13 02:57:11 +00:00
* Tests if a point is inside the bounding polygon of the footprint
*
* The other hit test methods are just checking the bounding box, which
* can be quite inaccurate for rotated or oddly-shaped footprints.
*
* @param aPosition is the point to test
* @return true if aPosition is inside the bounding polygon
*/
bool HitTestAccurate( const wxPoint& aPosition, int aAccuracy = 0 ) const;
bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
2008-01-06 12:43:57 +00:00
/**
* Function GetReference
* @return const wxString& - the reference designator text.
*/
const wxString GetReference() const
{
2020-11-13 02:57:11 +00:00
return m_reference->GetText();
}
/**
* Function SetReference
* @param aReference A reference to a wxString object containing the reference designator
* text.
*/
void SetReference( const wxString& aReference )
{
2020-11-13 02:57:11 +00:00
m_reference->SetText( aReference );
}
/**
* Function IncrementReference
* Bumps the current reference by aDelta.
*/
void IncrementReference( int aDelta );
/**
* Function GetValue
* @return const wxString& - the value text.
*/
const wxString GetValue() const
{
2020-11-13 02:57:11 +00:00
return m_value->GetText();
}
/**
* Function SetValue
* @param aValue A reference to a wxString object containing the value text.
*/
void SetValue( const wxString& aValue )
{
2020-11-13 02:57:11 +00:00
m_value->SetText( aValue );
}
2008-03-04 04:22:27 +00:00
2012-05-22 17:51:18 +00:00
/// read/write accessors:
2020-11-13 02:57:11 +00:00
FP_TEXT& Value() { return *m_value; }
FP_TEXT& Reference() { return *m_reference; }
2012-05-22 17:51:18 +00:00
/// The const versions to keep the compiler happy.
2020-11-13 02:57:11 +00:00
FP_TEXT& Value() const { return *m_value; }
FP_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; }
2008-03-04 04:22:27 +00:00
/**
* Function FindPadByName
2020-11-12 22:30:02 +00:00
* returns a PAD* with a matching name. Note that names may not be
2008-03-04 04:22:27 +00:00
* unique, depending on how the foot print was created.
2010-12-29 17:47:32 +00:00
* @param aPadName the pad name to find
2020-11-12 22:30:02 +00:00
* @return PAD* - The first matching name is returned, or NULL if not found.
2008-03-04 04:22:27 +00:00
*/
2020-11-12 22:30:02 +00:00
PAD* FindPadByName( const wxString& aPadName ) const;
2008-03-04 04:22:27 +00:00
/**
* Function GetPad
* get a pad at \a aPosition on \a aLayerMask in the footprint.
*
* @param aPosition A wxPoint object containing the position to hit test.
* @param aLayerMask A layer or layers to mask the hit test.
2020-11-12 22:30:02 +00:00
* @return A pointer to a PAD object if found otherwise NULL.
*/
2020-11-12 22:30:02 +00:00
PAD* GetPad( const wxPoint& aPosition, LSET aLayerMask = LSET::AllLayersMask() );
2008-03-04 04:22:27 +00:00
2020-11-12 22:30:02 +00:00
PAD* GetTopLeftPad();
2019-06-01 23:23:36 +00:00
/**
* Gets the first pad in the list or NULL if none
* @return first pad or null pointer
*/
2020-11-12 22:30:02 +00:00
PAD* GetFirstPad() const
2019-06-01 23:23:36 +00:00
{
return m_pads.empty() ? nullptr : m_pads.front();
}
2012-04-16 03:18:41 +00:00
/**
* GetPadCount
2012-04-16 03:18:41 +00:00
* returns the number of pads.
*
* @param aIncludeNPTH includes non-plated through holes when true. Does not include
* non-plated through holes when false.
* @return the number of pads according to \a aIncludeNPTH.
2012-04-16 03:18:41 +00:00
*/
unsigned GetPadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
/**
* GetUniquePadCount
* returns the number of unique pads.
* A complex pad can be built with many pads having the same pad name
* to create a complex shape or fragmented solder paste areas.
*
* GetUniquePadCount calculate the count of not blank pad names
*
* @param aIncludeNPTH includes non-plated through holes when true. Does not include
* non-plated through holes when false.
* @return the number of unique pads according to \a aIncludeNPTH.
*/
unsigned GetUniquePadCount( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const;
2012-04-16 03:18:41 +00:00
/**
* Function GetNextPadName
2020-11-13 02:57:11 +00:00
* returns the next available pad name in the footprint
*
* @param aFillSequenceGaps true if the numbering should "fill in" gaps in the sequence,
* else return the highest value + 1
* @return the next available pad name
*/
wxString GetNextPadName( const wxString& aLastPadName ) const;
double GetArea( int aPadding = 0 ) const;
2020-11-13 02:57:11 +00:00
KIID GetLink() const { return m_link; }
void SetLink( const KIID& aLink ) { m_link = aLink; }
2020-11-13 02:57:11 +00:00
int GetPlacementCost180() const { return m_rot180Cost; }
void SetPlacementCost180( int aCost ) { m_rot180Cost = aCost; }
2020-11-13 02:57:11 +00:00
int GetPlacementCost90() const { return m_rot90Cost; }
void SetPlacementCost90( int aCost ) { m_rot90Cost = aCost; }
BOARD_ITEM* Duplicate() const override;
/**
2020-02-20 12:11:04 +00:00
* Function DuplicateItem
2020-11-13 02:57:11 +00:00
* Duplicate a given item within the footprint, optionally adding it to the board
* @return the new item, or NULL if the item could not be duplicated
*/
2020-11-13 02:57:11 +00:00
BOARD_ITEM* DuplicateItem( const BOARD_ITEM* aItem, bool aAddToFootprint = false );
/**
* Function Add3DModel
* adds \a a3DModel definition to the end of the 3D model list.
*
2020-11-13 00:43:45 +00:00
* @param a3DModel A pointer to a #FP_3DMODEL to add to the list.
*/
2020-11-13 00:43:45 +00:00
void Add3DModel( FP_3DMODEL* a3DModel );
SEARCH_RESULT Visit( INSPECTOR inspector, void* testData, const KICAD_T scanTypes[] ) override;
2016-09-24 18:53:15 +00:00
wxString GetClass() const override
{
return wxT( "FOOTPRINT" );
}
2019-12-20 14:11:39 +00:00
wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
BITMAP_DEF GetMenuImage() const override;
2016-09-24 18:53:15 +00:00
EDA_ITEM* Clone() const override;
2013-12-18 12:39:11 +00:00
/**
* Function RunOnChildren
*
2020-11-13 02:57:11 +00:00
* Invokes a function on all BOARD_ITEMs that belong to the footprint (pads, drawings, texts).
* Note that this function should not add or remove items to the footprint
2013-12-18 12:39:11 +00:00
* @param aFunction is the function to be invoked.
*/
2020-10-27 11:03:35 +00:00
void RunOnChildren( const std::function<void (BOARD_ITEM*)>& aFunction ) const;
2013-12-18 12:39:11 +00:00
/**
2020-11-13 02:57:11 +00:00
* Returns a set of all layers that this footprint has drawings on similar to ViewGetLayers()
*
* @param aLayers is an array to store layer ids
* @param aCount is the number of layers stored in the array
* @param aIncludePads controls whether to also include pad layers
*/
void GetAllDrawingLayers( int aLayers[], int& aCount, bool aIncludePads = true ) const;
2016-09-24 18:53:15 +00:00
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
2016-09-24 18:53:15 +00:00
virtual const BOX2I ViewBBox() const override;
/**
* static function IsLibNameValid
* Test for validity of a name of a footprint to be used in a footprint library
* ( no spaces, dir separators ... )
* @param aName = the name in library to validate
* @return true if the given name is valid
*/
static bool IsLibNameValid( const wxString& aName );
/**
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
* static function StringLibNameInvalidChars
* Test for validity of the name in a library of the footprint
* ( no spaces, dir separators ... )
2012-12-18 13:54:44 +00:00
* @param aUserReadable = false to get the list of invalid chars
* true to get a readable form (i.e ' ' = 'space' '\\t'= 'tab')
* @return a constant std::string giving the list of invalid chars in lib name
*/
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
static const wxChar* StringLibNameInvalidChars( bool aUserReadable );
/**
* Function SetInitialComments
* takes ownership of caller's heap allocated aInitialComments block. The comments
* are single line strings already containing the s-expression comments with optional
* leading whitespace and then a '#' character followed by optional single line text
* (text with no line endings, not even one).
* This block of single line comments will be output upfront of any generated
* s-expression text in the PCBIO::Format() function.
* <p>
* Note that a block of single line comments constitutes a multiline block of single
* line comments. That is, the block is made of consecutive single line comments.
* @param aInitialComments is a heap allocated wxArrayString or NULL, which the caller
* gives up ownership of over to this FOOTPRINT.
*/
void SetInitialComments( wxArrayString* aInitialComments )
{
delete m_initial_comments;
m_initial_comments = aInitialComments;
}
2015-02-18 16:53:46 +00:00
/**
* Function CoverageRatio
* Calculates the ratio of total area of the footprint pads and graphical items
* to the area of the footprint. Used by selection tool heuristics.
* @return the ratio
*/
double CoverageRatio( const GENERAL_COLLECTOR& aCollector ) const;
static double GetCoverageArea( const BOARD_ITEM* aItem, const GENERAL_COLLECTOR& aCollector );
/// Return the initial comments block or NULL if none, without transfer of ownership.
const wxArrayString* GetInitialComments() const { return m_initial_comments; }
/** Used in DRC to test the courtyard area (a complex polygon)
* @return the courtyard polygon
*/
SHAPE_POLY_SET& GetPolyCourtyardFront() { return m_poly_courtyard_front; }
SHAPE_POLY_SET& GetPolyCourtyardBack() { return m_poly_courtyard_back; }
/**
* Builds complex polygons of the courtyard areas from graphic items on the courtyard layers
* @remark sets the MALFORMED_F_COURTYARD and MALFORMED_B_COURTYARD status flags if the given
* courtyard layer does not contain a (single) closed shape
*/
void BuildPolyCourtyards( OUTLINE_ERROR_HANDLER* aErrorHandler = nullptr );
virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER ) const override;
virtual void SwapData( BOARD_ITEM* aImage ) override;
struct cmp_drawings
{
bool operator()( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
};
struct cmp_pads
{
2020-11-12 22:30:02 +00:00
bool operator()( const PAD* aFirst, const PAD* aSecond ) const;
};
2011-12-12 08:37:05 +00:00
#if defined(DEBUG)
2016-09-24 18:53:15 +00:00
virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
private:
2020-11-13 02:57:11 +00:00
DRAWINGS m_drawings; // BOARD_ITEMs for drawings on the board, owned by pointer.
PADS m_pads; // PAD items, owned by pointer
FP_ZONES m_fp_zones; // FP_ZONE items, owned by pointer
2020-11-13 15:15:52 +00:00
FP_GROUPS m_fp_groups; // PCB_GROUP items, owned by pointer
2020-11-13 02:57:11 +00:00
double m_orient; // Orientation in tenths of a degree, 900=90.0 degrees.
wxPoint m_pos; // Position of footprint on the board in internal units.
FP_TEXT* m_reference; // Component reference designator value (U34, R18..)
FP_TEXT* m_value; // Component value (74LS00, 22K..)
LIB_ID m_fpid; // The #LIB_ID of the FOOTPRINT.
2020-11-13 02:57:11 +00:00
int m_attributes; // Flag bits ( see FOOTPRINT_ATTR_T )
2020-11-13 11:17:15 +00:00
int m_fpStatus; // For autoplace: flags (LOCKED, FIELDS_AUTOPLACED)
2020-11-13 02:57:11 +00:00
EDA_RECT m_boundingBox; // Bounding box : coordinates on board, real orientation.
ZONE_CONNECTION m_zoneConnection;
int m_thermalWidth;
int m_thermalGap;
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
int m_rot90Cost; // Horizontal automatic placement cost ( 0..10 ).
int m_rot180Cost; // Vertical automatic placement cost ( 0..10 ).
2020-11-13 00:43:45 +00:00
std::list<FP_3DMODEL> m_3D_Drawings; // Linked list of 3D models.
std::map<wxString, wxString> m_properties;
2020-11-13 02:57:11 +00:00
wxArrayString* m_initial_comments; // s-expression comments in the footprint,
// lazily allocated only if needed for speed
2020-11-13 02:57:11 +00:00
SHAPE_POLY_SET m_poly_courtyard_front; // Note that a footprint can have both front and back
SHAPE_POLY_SET m_poly_courtyard_back; // courtyards populated.
};
2020-11-13 00:43:45 +00:00
#endif // FOOTPRINT_H