#include <footprint.h>

Inheritance diagram for FOOTPRINT:

Classes
struct	cmp_drawings

struct	cmp_pads

struct	cmp_zones

Public Member Functions
	FOOTPRINT (BOARD *parent)

	FOOTPRINT (const FOOTPRINT &aFootprint)

	FOOTPRINT (FOOTPRINT &&aFootprint)

	~FOOTPRINT ()

FOOTPRINT &	operator= (const FOOTPRINT &aOther)

FOOTPRINT &	operator= (FOOTPRINT &&aOther)

LSET	GetPrivateLayers () const

void	SetPrivateLayers (LSET aLayers)
	Adds an item to the container. More...

void	Add (BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
	Removes an item from the container. More...

void	Remove (BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
	Removes an item from the container. More...

void	ClearAllNets ()
	Clear (i.e. More...

bool	FixUuids ()
	Old footprints do not always have a valid UUID (some can be set to null uuid) However null UUIDs, having a special meaning in editor, create issues when editing a footprint So all null uuids a re replaced by a valid uuid. More...

BOX2I	GetFpPadsLocalBbox () const
	Return the bounding box containing pads when the footprint is on the front side, orientation 0, position 0,0. More...

SHAPE_POLY_SET	GetBoundingHull () const
	Return a bounding polygon for the shapes and pads in the footprint. More...

const BOX2I	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes. More...

const BOX2I	GetBoundingBox (bool aIncludeText, bool aIncludeInvisibleText) const

PADS &	Pads ()

const PADS &	Pads () const

DRAWINGS &	GraphicalItems ()

const DRAWINGS &	GraphicalItems () const

FP_ZONES &	Zones ()

const FP_ZONES &	Zones () const

FP_GROUPS &	Groups ()

const FP_GROUPS &	Groups () const

bool	HasThroughHolePads () const

std::vector< FP_3DMODEL > &	Models ()

const std::vector< FP_3DMODEL > &	Models () const

void	SetPosition (const VECTOR2I &aPos) override

VECTOR2I	GetPosition () const override

void	SetOrientation (const EDA_ANGLE &aNewAngle)

EDA_ANGLE	GetOrientation () const

void	SetLayerAndFlip (PCB_LAYER_ID aLayer)
	Used as Layer property setter – performs a flip if necessary to set the footprint layer. More...

PCB_LAYER_ID	GetLayer () const override
	Return the primary layer this item is on. More...

void	SetOrientationDegrees (double aOrientation)

double	GetOrientationDegrees () const

const LIB_ID &	GetFPID () const

void	SetFPID (const LIB_ID &aFPID)

wxString	GetFPIDAsString () const

void	SetFPIDAsString (const wxString &aFPID)

wxString	GetDescription () const

void	SetDescription (const wxString &aDoc)

wxString	GetKeywords () const

void	SetKeywords (const wxString &aKeywords)

const KIID_PATH &	GetPath () const

void	SetPath (const KIID_PATH &aPath)

int	GetLocalSolderMaskMargin () const

void	SetLocalSolderMaskMargin (int aMargin)

int	GetLocalClearance () const

void	SetLocalClearance (int aClearance)

int	GetLocalClearance (wxString *aSource) const

int	GetLocalSolderPasteMargin () const

void	SetLocalSolderPasteMargin (int aMargin)

double	GetLocalSolderPasteMarginRatio () const

void	SetLocalSolderPasteMarginRatio (double aRatio)

void	SetZoneConnection (ZONE_CONNECTION aType)

ZONE_CONNECTION	GetZoneConnection () const

int	GetAttributes () const

void	SetAttributes (int aAttributes)

void	SetFlag (int aFlag)

void	IncrementFlag ()

int	GetFlag () const

bool	IsNetTie () const

const std::vector< wxString > &	GetNetTiePadGroups () const

void	ClearNetTiePadGroups ()

void	AddNetTiePadGroup (const wxString &aGroup)

std::map< wxString, int >	MapPadNumbersToNetTieGroups () const

std::vector< PAD * >	GetNetTiePads (PAD *aPad) const

int	GetLikelyAttribute () const
	Returns the most likely attribute based on pads Either FP_THROUGH_HOLE/FP_SMD/OTHER(0) More...

void	Move (const VECTOR2I &aMoveVector) override
	Move this object. More...

void	Rotate (const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
	Rotate this object. More...

void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight) override
	Flip this object, i.e. More...

void	MoveAnchorPosition (const VECTOR2I &aMoveVector)
	Move the reference point of the footprint. More...

bool	IsFlipped () const

bool	IsOnLayer (PCB_LAYER_ID aLayer) const override
	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. More...

bool	IsLocked () const override

void	SetLocked (bool isLocked) override
	Set the #MODULE_is_LOCKED bit in the m_ModuleStatus. More...

bool	IsConflicting () const

bool	IsPlaced () const

void	SetIsPlaced (bool isPlaced)

bool	NeedsPlaced () const

void	SetNeedsPlaced (bool needsPlaced)

bool	LegacyPadsLocked () const

void	CheckFootprintAttributes (const std::function< void(const wxString &)> &aErrorHandler)
	Test if footprint attributes for type (SMD/Through hole/Other) match the expected type based on the pads in the footprint. More...

void	CheckPads (const std::function< void(const PAD *, int, const wxString &)> &aErrorHandler)
	Run non-board-specific DRC checks on footprint's pads. More...

void	CheckShortingPads (const std::function< void(const PAD , const PAD , const VECTOR2I &)> &aErrorHandler)
	Check for overlapping, different-numbered, non-net-tie pads. More...

void	CheckNetTies (const std::function< void(const BOARD_ITEM aItem, const BOARD_ITEM bItem, const BOARD_ITEM *cItem, const VECTOR2I &)> &aErrorHandler)
	Check for un-allowed shorting of pads in net-tie footprints. More...

void	CheckNetTiePadGroups (const std::function< void(const wxString &)> &aErrorHandler)
	Sanity check net-tie pad groups. More...

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
	Generate pads shapes on layer aLayer as polygons and adds these polygons to aBuffer. More...

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
	Generate shapes of graphic items (outlines) on layer aLayer as polygons and adds these polygons to aBuffer. More...

void	TransformFPTextToPolySet (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc) const
	This function is the same as TransformFPShapesToPolySet but only generates text. More...

void	GetContextualTextVars (wxArrayString *aVars) const
	Return the list of system text vars for this footprint. More...

bool	ResolveTextVar (wxString *token, int aDepth=0) const
	Resolve any references to system tokens supported by the component. More...

void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...

bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const override
	Test if aPosition is inside or on the boundary of this item. More...

bool	HitTestAccurate (const VECTOR2I &aPosition, int aAccuracy=0) const
	Test if a point is inside the bounding polygon of the footprint. More...

bool	HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects this item. More...

const wxString &	GetReference () const

void	SetReference (const wxString &aReference)

wxString	GetReferenceAsString () const

void	IncrementReference (int aDelta)
	Bump the current reference by aDelta. More...

const wxString &	GetValue () const

void	SetValue (const wxString &aValue)

wxString	GetValueAsString () const

FP_TEXT &	Value ()
	read/write accessors: More...

FP_TEXT &	Reference ()

FP_TEXT &	Value () const
	The const versions to keep the compiler happy. More...

FP_TEXT &	Reference () const

const std::map< wxString, wxString > &	GetProperties () const

void	SetProperties (const std::map< wxString, wxString > &aProps)

const wxString &	GetProperty (const wxString &aKey)

bool	HasProperty (const wxString &aKey)

void	SetProperty (const wxString &aKey, const wxString &aVal)

bool	IsBoardOnly () const

void	SetBoardOnly (bool aIsBoardOnly=true)

bool	IsExcludedFromPosFiles () const

void	SetExcludedFromPosFiles (bool aExclude=true)

bool	IsExcludedFromBOM () const

void	SetExcludedFromBOM (bool aExclude=true)

bool	AllowMissingCourtyard () const

void	SetAllowMissingCourtyard (bool aAllow=true)

void	SetFileFormatVersionAtLoad (int aVersion)

int	GetFileFormatVersionAtLoad () const

PAD *	FindPadByNumber (const wxString &aPadNumber, PAD *aSearchAfterMe=nullptr) const
	Return a PAD with a matching number. More...

PAD *	GetPad (const VECTOR2I &aPosition, LSET aLayerMask=LSET::AllLayersMask())
	Get a pad at aPosition on aLayerMask in the footprint. More...

unsigned	GetPadCount (INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
	Return the number of pads. More...

unsigned	GetUniquePadCount (INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
	Return the number of unique non-blank pads. More...

wxString	GetNextPadNumber (const wxString &aLastPadName) const
	Return the next available pad number in the footprint. More...

wxString	GetTypeName () const
	Get the type of footprint. More...

double	GetArea (int aPadding=0) const

KIID	GetLink () const

void	SetLink (const KIID &aLink)

BOARD_ITEM *	Duplicate () const override
	Create a copy of this BOARD_ITEM. More...

BOARD_ITEM *	DuplicateItem (const BOARD_ITEM *aItem, bool aAddToFootprint=false)
	Duplicate a given item within the footprint, optionally adding it to the board. More...

void	Add3DModel (FP_3DMODEL *a3DModel)
	Add a3DModel definition to the end of the 3D model list. More...

INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) override
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

wxString	GetClass () const override
	Return the class name. More...

wxString	GetItemDescription (UNITS_PROVIDER *aUnitsProvider) const override
	Return a user-visible description string of this item. More...

BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus. More...

EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL. More...

void	RunOnChildren (const std::function< void(BOARD_ITEM *)> &aFunction) const
	Invoke a function on all BOARD_ITEMs that belong to the footprint (pads, drawings, texts). More...

virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

double	ViewGetLOD (int aLayer, KIGFX::VIEW *aView) const override
	Return the level of detail (LOD) of the item. More...

virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...

bool	FootprintNeedsUpdate (const FOOTPRINT *aLibFootprint)
	Return true if a board footprint differs from the library version. More...

void	SetInitialComments (wxArrayString *aInitialComments)
	Take ownership of caller's heap allocated aInitialComments block. More...

double	CoverageRatio (const GENERAL_COLLECTOR &aCollector) const
	Calculate the ratio of total area of the footprint pads and graphical items to the area of the footprint. More...

const wxArrayString *	GetInitialComments () const

const SHAPE_POLY_SET &	GetCourtyard (PCB_LAYER_ID aLayer) const
	Used in DRC to test the courtyard area (a complex polygon). More...

void	BuildCourtyardCaches (OUTLINE_ERROR_HANDLER *aErrorHandler=nullptr)
	Build complex polygons of the courtyard areas from graphic items on the courtyard layers. More...

std::shared_ptr< SHAPE >	GetEffectiveShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
	Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes. More...

virtual void	Delete (BOARD_ITEM *aItem)
	Removes an item from the container and deletes it. More...

virtual const ZONE_SETTINGS &	GetZoneSettings () const
	Fetch the zone settings for this container. More...

virtual void	SetZoneSettings (const ZONE_SETTINGS &aSettings)
	Set the zone settings for this container. More...

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

virtual VECTOR2I	GetCenter () const
	This defaults to the center of the bounding box if not overridden. More...

void	SetX (int aX)

void	SetY (int aY)

virtual bool	IsConnected () const
	Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...

virtual bool	IsOnCopperLayer () const

virtual bool	HasHole () const

virtual bool	IsTented () const

virtual std::shared_ptr< SHAPE_SEGMENT >	GetEffectiveHoleShape () const

BOARD_ITEM_CONTAINER *	GetParent () const

BOARD_ITEM_CONTAINER *	GetParentFootprint () const

virtual bool	HasLineStroke () const
	Check if this item has line stoke properties. More...

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

virtual LSET	GetLayerSet () const
	Return a std::bitset of all layers on which the item physically resides. More...

virtual void	SetLayerSet (LSET aLayers)

virtual void	SetLayer (PCB_LAYER_ID aLayer)
	Set the layer this item is on. More...

void	SwapItemData (BOARD_ITEM *aImage)
	Swap data between aItem and aImage. More...

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

void	DeleteStructure ()
	Delete this object after removing from its parent if it has one. More...

virtual const BOARD *	GetBoard () const
	Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...

virtual BOARD *	GetBoard ()

wxString	GetLayerName () const
	Return the name of the PCB layer on which the item resides. More...

virtual void	TransformShapeToPolygon (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const
	Convert the item shape to a closed polygon. More...

KICAD_T	Type () const
	Returns the type of object. More...

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

virtual bool	IsType (const std::vector< KICAD_T > &aScanTypes) const
	Check whether the item is one of the listed types. More...

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

virtual wxString	GetFriendlyName () const

virtual const VECTOR2I	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...

virtual VECTOR2I	GetSortPosition () const
	Return the coordinates that should be used for sorting this element visually compared to other elements. More...

wxString	GetTypeDesc () const
	Return a translated description of the type for this EDA_ITEM for display in user facing messages. More...

virtual bool	Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...

virtual bool	Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...

virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace. More...

bool	operator< (const EDA_ITEM &aItem) const
	Test if another item is less than this object. More...

virtual void	ViewDraw (int aLayer, VIEW *aView) const
	Draw the parts of the object belonging to layer aLayer. More...

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)

template<typename T >
bool	Set (const wxString &aProperty, T aValue)

wxAny	Get (PROPERTY_BASE *aProperty) const

template<typename T >
T	Get (PROPERTY_BASE *aProperty) const

template<typename T >
std::optional< T >	Get (const wxString &aProperty) const

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)

static bool	IsLibNameValid (const wxString &aName)
	Test for validity of a name of a footprint to be used in a footprint library ( no spaces, dir separators ... ). More...

static const wxChar *	StringLibNameInvalidChars (bool aUserReadable)
	Test for validity of the name in a library of the footprint ( no spaces, dir separators ... ). More...

static double	GetCoverageArea (const BOARD_ITEM *aItem, const GENERAL_COLLECTOR &aCollector)
	Return the initial comments block or NULL if none, without transfer of ownership. More...

template<class T >
static INSPECT_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	This changes first parameter to avoid the DList and use the main queue instead. More...

template<class T >
static INSPECT_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	Change first parameter to avoid the DList and use std::vector instead. More...

static bool	Replace (const EDA_SEARCH_DATA &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...

static bool	Sort (const EDA_ITEM aLeft, const EDA_ITEM aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...

Public Attributes
const KIID	m_Uuid

Static Public Attributes
static VECTOR2I	ZeroOffset
	A value of wxPoint(0,0) which can be passed to the Draw() functions. More...

Protected Member Functions
virtual void	swapData (BOARD_ITEM *aImage) override

virtual wxString	layerMaskDescribe () const
	Return a string (to be shown to the user) describing a layer mask. More...

bool	Matches (const wxString &aText, const EDA_SEARCH_DATA &aSearchData) const
	Compare aText against search criteria in aSearchData. More...

Protected Attributes
PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Attributes
DRAWINGS	m_drawings

PADS	m_pads

FP_ZONES	m_fp_zones

FP_GROUPS	m_fp_groups

EDA_ANGLE	m_orient

VECTOR2I	m_pos

FP_TEXT *	m_reference

FP_TEXT *	m_value

LIB_ID	m_fpid

int	m_attributes

int	m_fpStatus

int	m_fileFormatVersionAtLoad

BOX2I	m_cachedBoundingBox

int	m_boundingBoxCacheTimeStamp

BOX2I	m_cachedVisibleBBox

int	m_visibleBBoxCacheTimeStamp

BOX2I	m_cachedTextExcludedBBox

int	m_textExcludedBBoxCacheTimeStamp

SHAPE_POLY_SET	m_cachedHull

int	m_hullCacheTimeStamp

std::vector< wxString >	m_netTiePadGroups

ZONE_CONNECTION	m_zoneConnection

int	m_localClearance

int	m_localSolderMaskMargin

int	m_localSolderPasteMargin

double	m_localSolderPasteMarginRatio

wxString	m_doc

wxString	m_keywords

KIID_PATH	m_path

timestamp_t	m_lastEditTime

int	m_arflag

KIID	m_link

LSET	m_privateLayers

std::vector< FP_3DMODEL >	m_3D_Drawings

std::map< wxString, wxString >	m_properties

wxArrayString *	m_initial_comments

SHAPE_POLY_SET	m_courtyard_cache_front

SHAPE_POLY_SET	m_courtyard_cache_back

int	m_courtyard_cache_timestamp

ZONE_SETTINGS	m_zoneSettings

KICAD_T	m_structType
	Run time identification, keep private so it can never be changed after a ctor sets it. More...

VIEW_ITEM_DATA *	m_viewPrivData

Detailed Description

Definition at line 100 of file footprint.h.

Constructor & Destructor Documentation

◆ FOOTPRINT() [1/3]

FOOTPRINT::FOOTPRINT ( BOARD * parent )

Definition at line 55 of file footprint.cpp.

 :
 BOARD_ITEM_CONTAINER((BOARD_ITEM*) parent, PCB_FOOTPRINT_T ),
 m_boundingBoxCacheTimeStamp( 0 ),
 m_visibleBBoxCacheTimeStamp( 0 ),
 m_textExcludedBBoxCacheTimeStamp( 0 ),
 m_hullCacheTimeStamp( 0 ),
 m_initial_comments( nullptr ),
 m_courtyard_cache_timestamp( 0 )
{
 m_attributes = 0;
 m_layer = F_Cu;
 m_orient = ANGLE_0;
 m_fpStatus = FP_PADS_are_LOCKED;
 m_arflag = 0;
 m_link = 0;
 m_lastEditTime = 0;
 m_localClearance = 0;
 m_localSolderMaskMargin = 0;
 m_localSolderPasteMargin = 0;
 m_localSolderPasteMarginRatio = 0.0;
 m_zoneConnection = ZONE_CONNECTION::INHERITED;
 m_fileFormatVersionAtLoad = 0;
 
 // These are special and mandatory text fields
 m_reference = new FP_TEXT( this, FP_TEXT::TEXT_is_REFERENCE );
 m_value = new FP_TEXT( this, FP_TEXT::TEXT_is_VALUE );
 
 m_3D_Drawings.clear();
}

References ANGLE_0, F_Cu, FP_PADS_are_LOCKED, INHERITED, m_3D_Drawings, m_arflag, m_attributes, m_fileFormatVersionAtLoad, m_fpStatus, m_lastEditTime, BOARD_ITEM::m_layer, m_link, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_orient, m_reference, m_value, m_zoneConnection, FP_TEXT::TEXT_is_REFERENCE, and FP_TEXT::TEXT_is_VALUE.

Referenced by Clone().

◆ FOOTPRINT() [2/3]

FOOTPRINT::FOOTPRINT ( const FOOTPRINT & aFootprint )

Definition at line 86 of file footprint.cpp.

 :
 BOARD_ITEM_CONTAINER( aFootprint )
{
 m_pos = aFootprint.m_pos;
 m_fpid = aFootprint.m_fpid;
 m_attributes = aFootprint.m_attributes;
 m_fpStatus = aFootprint.m_fpStatus;
 m_orient = aFootprint.m_orient;
 m_lastEditTime = aFootprint.m_lastEditTime;
 m_link = aFootprint.m_link;
 m_path = aFootprint.m_path;
 
 m_cachedBoundingBox = aFootprint.m_cachedBoundingBox;
 m_boundingBoxCacheTimeStamp = aFootprint.m_boundingBoxCacheTimeStamp;
 m_cachedVisibleBBox = aFootprint.m_cachedVisibleBBox;
 m_visibleBBoxCacheTimeStamp = aFootprint.m_visibleBBoxCacheTimeStamp;
 m_cachedTextExcludedBBox = aFootprint.m_cachedTextExcludedBBox;
 m_textExcludedBBoxCacheTimeStamp = aFootprint.m_textExcludedBBoxCacheTimeStamp;
 m_cachedHull = aFootprint.m_cachedHull;
 m_hullCacheTimeStamp = aFootprint.m_hullCacheTimeStamp;
 
 m_localClearance = aFootprint.m_localClearance;
 m_localSolderMaskMargin = aFootprint.m_localSolderMaskMargin;
 m_localSolderPasteMargin = aFootprint.m_localSolderPasteMargin;
 m_localSolderPasteMarginRatio = aFootprint.m_localSolderPasteMarginRatio;
 m_zoneConnection = aFootprint.m_zoneConnection;
 m_netTiePadGroups = aFootprint.m_netTiePadGroups;
 m_fileFormatVersionAtLoad = aFootprint.m_fileFormatVersionAtLoad;
 
 std::map<BOARD_ITEM*, BOARD_ITEM*> ptrMap;
 
 // Copy reference and value.
 m_reference = new FP_TEXT( *aFootprint.m_reference );
 m_reference->SetParent( this );
 ptrMap[ aFootprint.m_reference ] = m_reference;
 
 m_value = new FP_TEXT( *aFootprint.m_value );
 m_value->SetParent( this );
 ptrMap[ aFootprint.m_value ] = m_value;
 
 // Copy pads
 for( PAD* pad : aFootprint.Pads() )
 {
 PAD* newPad = static_cast<PAD*>( pad->Clone() );
 ptrMap[ pad ] = newPad;
 Add( newPad, ADD_MODE::APPEND ); // Append to ensure indexes are identical
 }
 
 // Copy zones
 for( FP_ZONE* zone : aFootprint.Zones() )
 {
 FP_ZONE* newZone = static_cast<FP_ZONE*>( zone->Clone() );
 ptrMap[ zone ] = newZone;
 Add( newZone, ADD_MODE::APPEND ); // Append to ensure indexes are identical
 
 // Ensure the net info is OK and especially uses the net info list
 // living in the current board
 // Needed when copying a fp from fp editor that has its own board
 // Must be NETINFO_LIST::ORPHANED_ITEM for a keepout that has no net.
 newZone->SetNetCode( -1 );
 }
 
 // Copy drawings
 for( BOARD_ITEM* item : aFootprint.GraphicalItems() )
 {
 BOARD_ITEM* newItem = static_cast<BOARD_ITEM*>( item->Clone() );
 ptrMap[ item ] = newItem;
 Add( newItem, ADD_MODE::APPEND ); // Append to ensure indexes are identical
 }
 
 // Copy groups
 for( PCB_GROUP* group : aFootprint.Groups() )
 {
 PCB_GROUP* newGroup = static_cast<PCB_GROUP*>( group->Clone() );
 ptrMap[ group ] = newGroup;
 Add( newGroup, ADD_MODE::APPEND ); // Append to ensure indexes are identical
 }
 
 // Rebuild groups
 for( PCB_GROUP* group : aFootprint.Groups() )
 {
 PCB_GROUP* newGroup = static_cast<PCB_GROUP*>( ptrMap[ group ] );
 
 newGroup->GetItems().clear();
 
 for( BOARD_ITEM* member : group->GetItems() )
 {
 if( ptrMap.count( member ) )
 newGroup->AddItem( ptrMap[ member ] );
 }
 }
 
 // Copy auxiliary data
 m_3D_Drawings = aFootprint.m_3D_Drawings;
 m_doc = aFootprint.m_doc;
 m_keywords = aFootprint.m_keywords;
 m_properties = aFootprint.m_properties;
 m_privateLayers = aFootprint.m_privateLayers;
 
 m_arflag = 0;
 
 m_initial_comments = aFootprint.m_initial_comments ?
 new wxArrayString( *aFootprint.m_initial_comments ) : nullptr;
}

References Add(), PCB_GROUP::AddItem(), APPEND, PCB_GROUP::GetItems(), GraphicalItems(), group, Groups(), m_3D_Drawings, m_arflag, m_attributes, m_boundingBoxCacheTimeStamp, m_cachedBoundingBox, m_cachedHull, m_cachedTextExcludedBBox, m_cachedVisibleBBox, m_doc, m_fileFormatVersionAtLoad, m_fpid, m_fpStatus, m_hullCacheTimeStamp, m_initial_comments, m_keywords, m_lastEditTime, m_link, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_netTiePadGroups, m_orient, m_path, m_pos, m_privateLayers, m_properties, m_reference, m_textExcludedBBoxCacheTimeStamp, m_value, m_visibleBBoxCacheTimeStamp, m_zoneConnection, pad, Pads(), BOARD_CONNECTED_ITEM::SetNetCode(), EDA_ITEM::SetParent(), and Zones().

◆ FOOTPRINT() [3/3]

FOOTPRINT::FOOTPRINT ( FOOTPRINT && aFootprint )

Definition at line 192 of file footprint.cpp.

 :
 BOARD_ITEM_CONTAINER( aFootprint )
{
 *this = std::move( aFootprint );
}

◆ ~FOOTPRINT()

FOOTPRINT::~FOOTPRINT ( )

Definition at line 199 of file footprint.cpp.

{
 // Untangle group parents before doing any deleting
 for( PCB_GROUP* group : m_fp_groups )
 {
 for( BOARD_ITEM* item : group->GetItems() )
 item->SetParentGroup( nullptr );
 }
 
 // Clean up the owned elements
 delete m_reference;
 delete m_value;
 delete m_initial_comments;
 
 for( PAD* p : m_pads )
 delete p;
 
 m_pads.clear();
 
 for( FP_ZONE* zone : m_fp_zones )
 delete zone;
 
 m_fp_zones.clear();
 
 for( PCB_GROUP* group : m_fp_groups )
 delete group;
 
 m_fp_groups.clear();
 
 for( BOARD_ITEM* d : m_drawings )
 delete d;
 
 m_drawings.clear();
 
 if( BOARD* board = GetBoard() )
 board->IncrementTimeStamp();
}

References BOARD_ITEM::GetBoard(), group, m_drawings, m_fp_groups, m_fp_zones, m_initial_comments, m_pads, m_reference, and m_value.

Member Function Documentation

◆ Add()

void FOOTPRINT::Add	(	BOARD_ITEM *	aItem,
		ADD_MODE	aMode = `ADD_MODE::INSERT`,
		bool	aSkipConnectivity = `false`
	)

overridevirtual

Removes an item from the container.

Implements BOARD_ITEM_CONTAINER.

Definition at line 567 of file footprint.cpp.

{
 switch( aBoardItem->Type() )
 {
 case PCB_FP_TEXT_T:
 // Only user text can be added this way.
 wxASSERT( static_cast<FP_TEXT*>( aBoardItem )->GetType() == FP_TEXT::TEXT_is_DIVERS );
 KI_FALLTHROUGH;
 
 case PCB_FP_DIM_ALIGNED_T:
 case PCB_FP_DIM_LEADER_T:
 case PCB_FP_DIM_CENTER_T:
 case PCB_FP_DIM_RADIAL_T:
 case PCB_FP_DIM_ORTHOGONAL_T:
 case PCB_FP_SHAPE_T:
 case PCB_FP_TEXTBOX_T:
 case PCB_BITMAP_T:
 if( aMode == ADD_MODE::APPEND )
 m_drawings.push_back( aBoardItem );
 else
 m_drawings.push_front( aBoardItem );
 break;
 
 case PCB_PAD_T:
 if( aMode == ADD_MODE::APPEND )
 m_pads.push_back( static_cast<PAD*>( aBoardItem ) );
 else
 m_pads.push_front( static_cast<PAD*>( aBoardItem ) );
 break;
 
 case PCB_FP_ZONE_T:
 if( aMode == ADD_MODE::APPEND )
 m_fp_zones.push_back( static_cast<FP_ZONE*>( aBoardItem ) );
 else
 m_fp_zones.insert( m_fp_zones.begin(), static_cast<FP_ZONE*>( aBoardItem ) );
 break;
 
 case PCB_GROUP_T:
 if( aMode == ADD_MODE::APPEND )
 m_fp_groups.push_back( static_cast<PCB_GROUP*>( aBoardItem ) );
 else
 m_fp_groups.insert( m_fp_groups.begin(), static_cast<PCB_GROUP*>( aBoardItem ) );
 break;
 
 default:
 {
 wxString msg;
 msg.Printf( wxT( "FOOTPRINT::Add() needs work: BOARD_ITEM type (%d) not handled" ),
 aBoardItem->Type() );
 wxFAIL_MSG( msg );
 
 return;
 }
 }
 
 aBoardItem->ClearEditFlags();
 aBoardItem->SetParent( this );
}

References APPEND, EDA_ITEM::ClearEditFlags(), KI_FALLTHROUGH, m_drawings, m_fp_groups, m_fp_zones, m_pads, PCB_BITMAP_T, PCB_FP_DIM_ALIGNED_T, PCB_FP_DIM_CENTER_T, PCB_FP_DIM_LEADER_T, PCB_FP_DIM_ORTHOGONAL_T, PCB_FP_DIM_RADIAL_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, EDA_ITEM::SetParent(), FP_TEXT::TEXT_is_DIVERS, and EDA_ITEM::Type().

◆ Add3DModel()

void FOOTPRINT::Add3DModel ( FP_3DMODEL * a3DModel )

Add a3DModel definition to the end of the 3D model list.

Parameters

a3DModel A pointer to a FP_3DMODEL to add to the list.

Definition at line 1260 of file footprint.cpp.

{
 if( nullptr == a3DModel )
 return;
 
 if( !a3DModel->m_Filename.empty() )
 m_3D_Drawings.push_back( *a3DModel );
}

References m_3D_Drawings, and FP_3DMODEL::m_Filename.

◆ AddNetTiePadGroup()

void FOOTPRINT::AddNetTiePadGroup ( const wxString & aGroup )

inline

Definition at line 279 of file footprint.h.

 {
 m_netTiePadGroups.emplace_back( aGroup );
 }

References m_netTiePadGroups.

Referenced by DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow().

◆ AllowMissingCourtyard()

bool FOOTPRINT::AllowMissingCourtyard ( ) const

inline

Definition at line 610 of file footprint.h.

610{ return m_attributes & FP_ALLOW_MISSING_COURTYARD; }

FP_ALLOW_MISSING_COURTYARD

@ FP_ALLOW_MISSING_COURTYARD

Definition: footprint.h:75

References FP_ALLOW_MISSING_COURTYARD, and m_attributes.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ BuildCourtyardCaches()

void FOOTPRINT::BuildCourtyardCaches ( OUTLINE_ERROR_HANDLER * aErrorHandler = nullptr )

Build complex polygons of the courtyard areas from graphic items on the courtyard layers.

Note: Set the MALFORMED_F_COURTYARD and MALFORMED_B_COURTYARD status flags if the given courtyard layer does not contain a (single) closed shape.

Definition at line 2227 of file footprint.cpp.

{
 m_courtyard_cache_front.RemoveAllContours();
 m_courtyard_cache_back.RemoveAllContours();
 ClearFlags( MALFORMED_COURTYARDS );
 
 m_courtyard_cache_timestamp = GetBoard()->GetTimeStamp();
 
 // Build the courtyard area from graphic items on the courtyard.
 // Only PCB_FP_SHAPE_T have meaning, graphic texts are ignored.
 // Collect items:
 std::vector<PCB_SHAPE*> list_front;
 std::vector<PCB_SHAPE*> list_back;
 
 for( BOARD_ITEM* item : GraphicalItems() )
 {
 if( item->GetLayer() == B_CrtYd && item->Type() == PCB_FP_SHAPE_T )
 list_back.push_back( static_cast<PCB_SHAPE*>( item ) );
 
 if( item->GetLayer() == F_CrtYd && item->Type() == PCB_FP_SHAPE_T )
 list_front.push_back( static_cast<PCB_SHAPE*>( item ) );
 }
 
 if( !list_front.size() && !list_back.size() )
 return;
 
 int errorMax = pcbIUScale.mmToIU( 0.02 ); // max error for polygonization
 int chainingEpsilon = pcbIUScale.mmToIU( 0.02 ); // max dist from one endPt to next startPt
 
 if( ConvertOutlineToPolygon( list_front, m_courtyard_cache_front, errorMax, chainingEpsilon,
 true, aErrorHandler ) )
 {
 // Touching courtyards, or courtyards -at- the clearance distance are legal.
 m_courtyard_cache_front.Inflate( -1, SHAPE_POLY_SET::CHAMFER_ACUTE_CORNERS );
 
 m_courtyard_cache_front.CacheTriangulation( false );
 }
 else
 {
 SetFlags( MALFORMED_F_COURTYARD );
 }
 
 if( ConvertOutlineToPolygon( list_back, m_courtyard_cache_back, errorMax, chainingEpsilon,
 true, aErrorHandler ) )
 {
 // Touching courtyards, or courtyards -at- the clearance distance are legal.
 m_courtyard_cache_back.Inflate( -1, SHAPE_POLY_SET::CHAMFER_ACUTE_CORNERS );
 
 m_courtyard_cache_back.CacheTriangulation( false );
 }
 else
 {
 SetFlags( MALFORMED_B_COURTYARD );
 }
}

References B_CrtYd, SHAPE_POLY_SET::CacheTriangulation(), SHAPE_POLY_SET::CHAMFER_ACUTE_CORNERS, EDA_ITEM::ClearFlags(), ConvertOutlineToPolygon(), F_CrtYd, BOARD_ITEM::GetBoard(), BOARD::GetTimeStamp(), GraphicalItems(), SHAPE_POLY_SET::Inflate(), m_courtyard_cache_back, m_courtyard_cache_front, m_courtyard_cache_timestamp, MALFORMED_B_COURTYARD, MALFORMED_COURTYARDS, MALFORMED_F_COURTYARD, EDA_IU_SCALE::mmToIU(), PCB_FP_SHAPE_T, pcbIUScale, SHAPE_POLY_SET::RemoveAllContours(), and EDA_ITEM::SetFlags().

Referenced by AR_AUTOPLACER::buildFpAreas(), GetCourtyard(), BOARD_INSPECTION_TOOL::makeDRCEngine(), and DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ CheckFootprintAttributes()

void FOOTPRINT::CheckFootprintAttributes ( const std::function< void(const wxString &)> & aErrorHandler )

Test if footprint attributes for type (SMD/Through hole/Other) match the expected type based on the pads in the footprint.

Footprints with plated through-hole pads should usually be marked through hole even if they also have SMD because they might not be auto-placed. Exceptions to this might be shielded connectors. Otherwise, footprints with SMD pads should be marked SMD. Footprints with no connecting pads should be marked "Other"

Parameters

aErrorHandler callback to handle the error messages generated

Definition at line 2361 of file footprint.cpp.

{
 int likelyAttr = ( GetLikelyAttribute() & ( FP_SMD | FP_THROUGH_HOLE ) );
 int setAttr = ( GetAttributes() & ( FP_SMD | FP_THROUGH_HOLE ) );
 
 if( setAttr && likelyAttr && setAttr != likelyAttr )
 {
 wxString msg;
 
 switch( likelyAttr )
 {
 case FP_THROUGH_HOLE:
 msg.Printf( _( "(expected 'Through hole'; actual '%s')" ), GetTypeName() );
 break;
 case FP_SMD:
 msg.Printf( _( "(expected 'SMD'; actual '%s')" ), GetTypeName() );
 break;
 }
 
 if( aErrorHandler )
 (aErrorHandler)( msg );
 }
}

References _, FP_SMD, FP_THROUGH_HOLE, GetAttributes(), GetLikelyAttribute(), and GetTypeName().

Referenced by DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ CheckNetTiePadGroups()

void FOOTPRINT::CheckNetTiePadGroups ( const std::function< void(const wxString &)> & aErrorHandler )

Sanity check net-tie pad groups.

Pads cannot be listed more than once, and pad numbers must correspond to a pad.

Parameters

aErrorHandler callback to handle the error messages generated

Definition at line 2617 of file footprint.cpp.

{
 std::set<wxString> padNumbers;
 wxString msg;
 
 auto ret = MapPadNumbersToNetTieGroups();
 
 for( auto [ padNumber, _ ] : ret )
 {
 const PAD* pad = FindPadByNumber( padNumber );
 
 if( !pad )
 {
 msg.Printf( _( "(net-tie pad group contains unknown pad number %s)" ), padNumber );
 aErrorHandler( msg );
 }
 else if( !padNumbers.insert( pad->GetNumber() ).second )
 {
 msg.Printf( _( "(pad %s appears in more than one net-tie pad group)" ), padNumber );
 aErrorHandler( msg );
 }
 }
}

References _, FindPadByNumber(), MapPadNumbersToNetTieGroups(), and pad.

Referenced by DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ CheckNetTies()

void FOOTPRINT::CheckNetTies ( const std::function< void(const BOARD_ITEM *aItem, const BOARD_ITEM *bItem, const BOARD_ITEM *cItem, const VECTOR2I &)> & aErrorHandler )

Check for un-allowed shorting of pads in net-tie footprints.

If two pads are shorted, they must both appear in one of the allowed-shorting lists.

Parameters

aErrorHandler callback to handle the error messages generated

Definition at line 2511 of file footprint.cpp.

{
 // First build a map from pad numbers to allowed-shorting-group indexes. This ends up being
 // something like O(3n), but it still beats O(n^2) for large numbers of pads.
 
 std::map<wxString, int> padNumberToGroupIdxMap = MapPadNumbersToNetTieGroups();
 
 // Now collect all the footprint items which are on copper layers
 
 std::vector<BOARD_ITEM*> copperItems;
 
 for( BOARD_ITEM* item : m_drawings )
 {
 if( item->IsOnCopperLayer() )
 copperItems.push_back( item );
 }
 
 for( ZONE* zone : m_fp_zones )
 {
 if( !zone->GetIsRuleArea() && zone->IsOnCopperLayer() )
 copperItems.push_back( zone );
 }
 
 if( m_reference->IsOnCopperLayer() )
 copperItems.push_back( m_reference );
 
 if( m_value->IsOnCopperLayer() )
 copperItems.push_back( m_value );
 
  for( PCB_LAYER_ID layer : { F_Cu, In1_Cu, B_Cu } )
 {
 // Next, build a polygon-set for the copper on this layer. We don't really care about
 // nets here, we just want to end up with a set of outlines describing the distinct
 // copper polygons of the footprint.
 
 SHAPE_POLY_SET copperOutlines;
 std::map<int, std::vector<const PAD*>> outlineIdxToPadsMap;
 
 for( BOARD_ITEM* item : copperItems )
 {
 if( item->IsOnLayer( layer ) )
 {
 item->TransformShapeToPolygon( copperOutlines, layer, 0, ARC_HIGH_DEF,
 ERROR_OUTSIDE );
 }
 }
 
 copperOutlines.Simplify( SHAPE_POLY_SET::PM_FAST );
 
 // Index each pad to the outline in the set that it is part of.
 
 for( const PAD* pad : m_pads )
 {
 for( int ii = 0; ii < copperOutlines.OutlineCount(); ++ii )
 {
 if( pad->GetEffectiveShape( layer )->Collide( &copperOutlines.Outline( ii ), 0 ) )
 outlineIdxToPadsMap[ ii ].emplace_back( pad );
 }
 }
 
 // Finally, ensure that each outline which contains multiple pads has all its pads
 // listed in an allowed-shorting group.
 
 for( const auto& [ outlineIdx, pads ] : outlineIdxToPadsMap )
 {
 if( pads.size() > 1 )
 {
 const PAD* firstPad = pads[0];
 int firstGroupIdx = padNumberToGroupIdxMap[ firstPad->GetNumber() ];
 
 for( size_t ii = 1; ii < pads.size(); ++ii )
 {
 const PAD* thisPad = pads[ii];
 int thisGroupIdx = padNumberToGroupIdxMap[ thisPad->GetNumber() ];
 
 if( thisGroupIdx < 0 || thisGroupIdx != firstGroupIdx )
 {
 BOARD_ITEM* shortingItem = nullptr;
 VECTOR2I pos = ( firstPad->GetPosition() + thisPad->GetPosition() ) / 2;
 
 pos = copperOutlines.Outline( outlineIdx ).NearestPoint( pos );
 
 for( BOARD_ITEM* item : copperItems )
 {
 if( item->HitTest( pos, 1 ) )
 {
 shortingItem = item;
 break;
 }
 }
 
 if( shortingItem )
 aErrorHandler( shortingItem, firstPad, thisPad, pos );
 else
 aErrorHandler( firstPad, thisPad, nullptr, pos );
 }
 }
 }
 }
 }
}

References ARC_HIGH_DEF, B_Cu, ERROR_OUTSIDE, F_Cu, PAD::GetNumber(), PAD::GetPosition(), In1_Cu, BOARD_ITEM::IsOnCopperLayer(), m_drawings, m_fp_zones, m_pads, m_reference, m_value, MapPadNumbersToNetTieGroups(), SHAPE_LINE_CHAIN::NearestPoint(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), pad, SHAPE_POLY_SET::PM_FAST, and SHAPE_POLY_SET::Simplify().

Referenced by DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ CheckPads()

void FOOTPRINT::CheckPads ( const std::function< void(const PAD *, int, const wxString &)> & aErrorHandler )

Run non-board-specific DRC checks on footprint's pads.

These are the checks supported by both the PCB DRC and the Footprint Editor Footprint Checker.

Parameters

aErrorHandler callback to handle the error messages generated

Definition at line 2386 of file footprint.cpp.

{
 if( aErrorHandler == nullptr )
 return;
 
 for( PAD* pad: Pads() )
 {
 if( pad->GetAttribute() == PAD_ATTRIB::PTH || pad->GetAttribute() == PAD_ATTRIB::NPTH )
 {
 if( pad->GetDrillSizeX() < 1 || pad->GetDrillSizeY() < 1 )
 (aErrorHandler)( pad, DRCE_PAD_TH_WITH_NO_HOLE, wxEmptyString );
 }
 
 if( pad->GetAttribute() == PAD_ATTRIB::PTH )
 {
 if( !pad->IsOnCopperLayer() )
 {
 (aErrorHandler)( pad, DRCE_PADSTACK, _( "(PTH pad has no copper layers)" ) );
 }
 else
 {
 LSET lset = pad->GetLayerSet() & LSET::AllCuMask();
 PCB_LAYER_ID layer = lset.Seq().at( 0 );
 SHAPE_POLY_SET padOutline;
 
 pad->TransformShapeToPolygon( padOutline, layer, 0, ARC_HIGH_DEF, ERROR_INSIDE );
 
 std::shared_ptr<SHAPE_SEGMENT> hole = pad->GetEffectiveHoleShape();
 SHAPE_POLY_SET holeOutline;
 
 TransformOvalToPolygon( holeOutline, hole->GetSeg().A, hole->GetSeg().B,
 hole->GetWidth(), ARC_HIGH_DEF, ERROR_INSIDE );
 
 padOutline.BooleanSubtract( holeOutline, SHAPE_POLY_SET::POLYGON_MODE::PM_FAST );
 
 if( padOutline.IsEmpty() )
 aErrorHandler( pad, DRCE_PADSTACK, _( "(PTH pad's hole leaves no copper)" ) );
 }
 }
 
 if( pad->GetAttribute() == PAD_ATTRIB::SMD )
 {
 if( pad->IsOnLayer( F_Cu ) && pad->IsOnLayer( B_Cu ) )
 {
 aErrorHandler( pad, DRCE_PADSTACK,
 _( "(SMD pad appears on both front and back copper)" ) );
 }
 else if( pad->IsOnLayer( F_Cu ) )
 {
 if( pad->IsOnLayer( B_Mask ) )
 {
 aErrorHandler( pad, DRCE_PADSTACK,
 _( "(SMD pad copper and mask layers don't match)" ) );
 }
 else if( pad->IsOnLayer( B_Paste ) )
 {
 aErrorHandler( pad, DRCE_PADSTACK,
 _( "(SMD pad copper and paste layers don't match)" ) );
 }
 }
 else if( pad->IsOnLayer( B_Cu ) )
 {
 if( pad->IsOnLayer( F_Mask ) )
 {
 aErrorHandler( pad, DRCE_PADSTACK,
 _( "(SMD pad copper and mask layers don't match)" ) );
 }
 else if( pad->IsOnLayer( F_Paste ) )
 {
 aErrorHandler( pad, DRCE_PADSTACK,
 _( "(SMD pad copper and paste layers don't match)" ) );
 }
 }
 }
 }
}

References _, LSET::AllCuMask(), ARC_HIGH_DEF, B_Cu, B_Mask, B_Paste, SHAPE_POLY_SET::BooleanSubtract(), DRCE_PAD_TH_WITH_NO_HOLE, DRCE_PADSTACK, ERROR_INSIDE, F_Cu, F_Mask, F_Paste, SHAPE_POLY_SET::IsEmpty(), NPTH, pad, Pads(), PTH, LSET::Seq(), SMD, and TransformOvalToPolygon().

Referenced by DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ CheckShortingPads()

void FOOTPRINT::CheckShortingPads ( const std::function< void(const PAD *, const PAD *, const VECTOR2I &)> & aErrorHandler )

Check for overlapping, different-numbered, non-net-tie pads.

Parameters

aErrorHandler callback to handle the error messages generated

Definition at line 2465 of file footprint.cpp.

{
 std::unordered_map<PTR_PTR_CACHE_KEY, int> checkedPairs;
 
 for( PAD* pad : Pads() )
 {
 std::vector<PAD*> netTiePads = GetNetTiePads( pad );
 
 for( PAD* other : Pads() )
 {
 if( other == pad || pad->SameLogicalPadAs( other ) )
 continue;
 
 if( alg::contains( netTiePads, other ) )
 continue;
 
 if( !( ( pad->GetLayerSet() & other->GetLayerSet() ) & LSET::AllCuMask() ).any() )
 continue;
 
 // store canonical order so we don't collide in both directions (a:b and b:a)
 PAD* a = pad;
 PAD* b = other;
 
 if( static_cast<void*>( a ) > static_cast<void*>( b ) )
 std::swap( a, b );
 
 if( checkedPairs.find( { a, b } ) == checkedPairs.end() )
 {
 checkedPairs[ { a, b } ] = 1;
 
 if( pad->GetBoundingBox().Intersects( other->GetBoundingBox() ) )
 {
 VECTOR2I pos;
 SHAPE* padShape = pad->GetEffectiveShape().get();
 SHAPE* otherShape = other->GetEffectiveShape().get();
 
 if( padShape->Collide( otherShape, 0, nullptr, &pos ) )
 aErrorHandler( pad, other, pos );
 }
 }
 }
 }
}

References LSET::AllCuMask(), SHAPE::Collide(), alg::contains(), GetNetTiePads(), pad, and Pads().

Referenced by DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ ClassOf()

static bool FOOTPRINT::ClassOf ( const EDA_ITEM * aItem )

inlinestatic

Definition at line 115 of file footprint.h.

 {
 return aItem && aItem->Type() == PCB_FOOTPRINT_T;
 }

References PCB_FOOTPRINT_T, and EDA_ITEM::Type().

◆ ClearAllNets()

void FOOTPRINT::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

Definition at line 558 of file footprint.cpp.

{
 // Force the ORPHANED dummy net info for all pads.
 // ORPHANED dummy net does not depend on a board
 for( PAD* pad : m_pads )
 pad->SetNetCode( NETINFO_LIST::ORPHANED );
}

References m_pads, NETINFO_LIST::ORPHANED, and pad.

Referenced by PCB_BASE_FRAME::loadFootprint(), and FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ ClearFlags( BRIGHTENED ); }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 158 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

References EDA_ITEM::ClearFlags(), and EDA_ITEM::GetEditFlags().

Referenced by BOARD::Add(), Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 141 of file eda_item.h.

141{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearNetTiePadGroups()

void FOOTPRINT::ClearNetTiePadGroups ( )

inline

Definition at line 274 of file footprint.h.

 {
 m_netTiePadGroups.clear();
 }

References m_netTiePadGroups.

Referenced by DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:47

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 153 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT );
 }

References CANDIDATE, EDA_ITEM::ClearFlags(), IS_LINKED, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * FOOTPRINT::Clone ( ) const

overridevirtual

Create a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 1373 of file footprint.cpp.

{
 return new FOOTPRINT( *this );
}

References FOOTPRINT().

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), PCB_PLUGIN::FootprintLoad(), FootprintNeedsUpdate(), PCB_PLUGIN::FootprintSave(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ CoverageRatio()

double FOOTPRINT::CoverageRatio ( const GENERAL_COLLECTOR & aCollector ) const

Calculate the ratio of total area of the footprint pads and graphical items to the area of the footprint.

Used by selection tool heuristics.

Returns: the ratio.

Definition at line 2111 of file footprint.cpp.

{
 int textMargin = KiROUND( 5 * aCollector.GetGuide()->OnePixelInIU() );
 
 SHAPE_POLY_SET footprintRegion( GetBoundingHull() );
 SHAPE_POLY_SET coveredRegion;
 
 TransformPadsToPolySet( coveredRegion, UNDEFINED_LAYER, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
 
 TransformFPShapesToPolySet( coveredRegion, UNDEFINED_LAYER, textMargin, ARC_LOW_DEF,
 ERROR_OUTSIDE,
 true, /* include text */
 false, /* include shapes */
 false /* include private items */ );
 
 for( int i = 0; i < aCollector.GetCount(); ++i )
 {
 const BOARD_ITEM* item = aCollector[i];
 
 switch( item->Type() )
 {
 case PCB_FP_TEXT_T:
 case PCB_FP_TEXTBOX_T:
 case PCB_FP_SHAPE_T:
 if( item->GetParent() != this )
 {
 item->TransformShapeToPolygon( coveredRegion, UNDEFINED_LAYER, 0, ARC_LOW_DEF,
 ERROR_OUTSIDE );
 }
 break;
 
 case PCB_TEXT_T:
 case PCB_TEXTBOX_T:
 case PCB_SHAPE_T:
 case PCB_TRACE_T:
 case PCB_ARC_T:
 case PCB_VIA_T:
 item->TransformShapeToPolygon( coveredRegion, UNDEFINED_LAYER, 0, ARC_LOW_DEF,
 ERROR_OUTSIDE );
 break;
 
 case PCB_FOOTPRINT_T:
 if( item != this )
 {
 const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( item );
 coveredRegion.AddOutline( footprint->GetBoundingHull().Outline( 0 ) );
 }
 break;
 
 default:
 break;
 }
 }
 
 double footprintRegionArea = polygonArea( footprintRegion );
 double uncoveredRegionArea = footprintRegionArea - polygonArea( coveredRegion );
 double coveredArea = footprintRegionArea - uncoveredRegionArea;
 double ratio = ( coveredArea / footprintRegionArea );
 
 // Test for negative ratio (should not occur).
 // better to be conservative (this will result in the disambiguate dialog)
 if( ratio < 0.0 )
 return 1.0;
 
 return std::min( ratio, 1.0 );
}

References SHAPE_POLY_SET::AddOutline(), ARC_LOW_DEF, ERROR_OUTSIDE, GetBoundingHull(), COLLECTOR::GetCount(), GENERAL_COLLECTOR::GetGuide(), BOARD_ITEM::GetParent(), KiROUND(), COLLECTORS_GUIDE::OnePixelInIU(), SHAPE_POLY_SET::Outline(), PCB_ARC_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, polygonArea(), TransformFPShapesToPolySet(), TransformPadsToPolySet(), BOARD_ITEM::TransformShapeToPolygon(), EDA_ITEM::Type(), and UNDEFINED_LAYER.

◆ Delete()

virtual void BOARD_ITEM_CONTAINER::Delete ( BOARD_ITEM * aItem )

inlinevirtualinherited

Removes an item from the container and deletes it.

Definition at line 77 of file board_item_container.h.

 {
 Remove( aItem );
 delete aItem;
 }

References BOARD_ITEM_CONTAINER::Remove().

Referenced by DRC_ITEMS_PROVIDER::DeleteItem(), PCB_PARSER::parseBOARD_unchecked(), and BOARD_COMMIT::Push().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

Delete this object after removing from its parent if it has one.

Definition at line 150 of file board_item.cpp.

{
 BOARD_ITEM_CONTAINER* parent = GetParent();
 
 if( parent )
 parent->Remove( this );
 
 delete this;
}

References BOARD_ITEM::GetParent(), and BOARD_ITEM_CONTAINER::Remove().

Referenced by DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Duplicate()

BOARD_ITEM * FOOTPRINT::Duplicate ( ) const

overridevirtual

Create a copy of this BOARD_ITEM.

Reimplemented from BOARD_ITEM.

Definition at line 1856 of file footprint.cpp.

{
 FOOTPRINT* dupe = static_cast<FOOTPRINT*>( BOARD_ITEM::Duplicate() );
 
 dupe->RunOnChildren( [&]( BOARD_ITEM* child )
 {
 const_cast<KIID&>( child->m_Uuid ) = KIID();
 });
 
 return dupe;
}

References BOARD_ITEM::Duplicate(), EDA_ITEM::m_Uuid, and RunOnChildren().

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), GPCB_PLUGIN::FootprintLoad(), PCB_PLUGIN::FootprintLoad(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), and CADSTAR_PCB_ARCHIVE_LOADER::loadComponents().

◆ DuplicateItem()

BOARD_ITEM * FOOTPRINT::DuplicateItem	(	const BOARD_ITEM *	aItem,
		bool	aAddToFootprint = `false`
	)

Duplicate a given item within the footprint, optionally adding it to the board.

Returns: the new item, or NULL if the item could not be duplicated.

Definition at line 1869 of file footprint.cpp.

{
 BOARD_ITEM* new_item = nullptr;
 FP_ZONE* new_zone = nullptr;
 
 switch( aItem->Type() )
 {
 case PCB_PAD_T:
 {
 PAD* new_pad = new PAD( *static_cast<const PAD*>( aItem ) );
 const_cast<KIID&>( new_pad->m_Uuid ) = KIID();
 
 if( aAddToFootprint )
 m_pads.push_back( new_pad );
 
 new_item = new_pad;
 break;
 }
 
 case PCB_FP_ZONE_T:
 {
 new_zone = new FP_ZONE( *static_cast<const FP_ZONE*>( aItem ) );
 const_cast<KIID&>( new_zone->m_Uuid ) = KIID();
 
 if( aAddToFootprint )
 m_fp_zones.push_back( new_zone );
 
 new_item = new_zone;
 break;
 }
 
 case PCB_FP_TEXT_T:
 {
 FP_TEXT* new_text = new FP_TEXT( *static_cast<const FP_TEXT*>( aItem ) );
 const_cast<KIID&>( new_text->m_Uuid ) = KIID();
 
 if( new_text->GetType() == FP_TEXT::TEXT_is_REFERENCE )
 {
 new_text->SetText( wxT( "${REFERENCE}" ) );
 new_text->SetType( FP_TEXT::TEXT_is_DIVERS );
 }
 else if( new_text->GetType() == FP_TEXT::TEXT_is_VALUE )
 {
 new_text->SetText( wxT( "${VALUE}" ) );
 new_text->SetType( FP_TEXT::TEXT_is_DIVERS );
 }
 
 if( aAddToFootprint )
 Add( new_text );
 
 new_item = new_text;
 
 break;
 }
 
 case PCB_FP_SHAPE_T:
 {
 FP_SHAPE* new_shape = new FP_SHAPE( *static_cast<const FP_SHAPE*>( aItem ) );
 const_cast<KIID&>( new_shape->m_Uuid ) = KIID();
 
 if( aAddToFootprint )
 Add( new_shape );
 
 new_item = new_shape;
 break;
 }
 
 case PCB_FP_TEXTBOX_T:
 {
 FP_TEXTBOX* new_textbox = new FP_TEXTBOX( *static_cast<const FP_TEXTBOX*>( aItem ) );
 const_cast<KIID&>( new_textbox->m_Uuid ) = KIID();
 
 if( aAddToFootprint )
 Add( new_textbox );
 
 new_item = new_textbox;
 break;
 }
 
 case PCB_FP_DIM_ALIGNED_T:
 case PCB_FP_DIM_LEADER_T:
 case PCB_FP_DIM_CENTER_T:
 case PCB_FP_DIM_RADIAL_T:
 case PCB_FP_DIM_ORTHOGONAL_T:
 {
 PCB_DIMENSION_BASE* dimension = static_cast<PCB_DIMENSION_BASE*>( aItem->Duplicate() );
 
 if( aAddToFootprint )
 Add( dimension );
 
 new_item = dimension;
 break;
 }
 
 case PCB_GROUP_T:
 new_item = static_cast<const PCB_GROUP*>( aItem )->DeepDuplicate();
 break;
 
 case PCB_FOOTPRINT_T:
 // Ignore the footprint itself
 break;
 
 default:
 // Un-handled item for duplication
 wxFAIL_MSG( wxT( "Duplication not supported for items of class " ) + aItem->GetClass() );
 break;
 }
 
 return new_item;
}

References Add(), BOARD_ITEM::Duplicate(), EDA_ITEM::GetClass(), FP_TEXT::GetType(), m_fp_zones, m_pads, EDA_ITEM::m_Uuid, PAD, PCB_FOOTPRINT_T, PCB_FP_DIM_ALIGNED_T, PCB_FP_DIM_CENTER_T, PCB_FP_DIM_LEADER_T, PCB_FP_DIM_ORTHOGONAL_T, PCB_FP_DIM_RADIAL_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, EDA_TEXT::SetText(), FP_TEXT::SetType(), FP_TEXT::TEXT_is_DIVERS, FP_TEXT::TEXT_is_REFERENCE, FP_TEXT::TEXT_is_VALUE, and EDA_ITEM::Type().

Referenced by EDIT_TOOL::Duplicate(), and ARRAY_CREATOR::Invoke().

◆ FindPadByNumber()

PAD * FOOTPRINT::FindPadByNumber	(	const wxString &	aPadNumber,
		PAD *	aSearchAfterMe = `nullptr`
	)		const

Return a PAD with a matching number.

Note: Numbers may not be unique depending on how the footprint was created.

Parameters

aPadNumber	the pad number to find.
aSearchAfterMe	= not nullptr to find a pad living after aAfterMe

Returns: the first matching numbered PAD is returned or NULL if not found.

Definition at line 1174 of file footprint.cpp.

{
 bool can_select = aSearchAfterMe ? false : true;
 
 for( PAD* pad : m_pads )
 {
 if( !can_select && pad == aSearchAfterMe )
 {
 can_select = true;
 continue;
 }
 
 if( can_select && pad->GetNumber() == aPadNumber )
 return pad;
 }
 
 return nullptr;
}

References m_pads, and pad.

Referenced by CheckNetTiePadGroups(), PCB_EDIT_FRAME::ExchangeFootprint(), BOARD_NETLIST_UPDATER::testConnectivity(), and DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist().

◆ FixUuids()

bool FOOTPRINT::FixUuids ( )

Old footprints do not always have a valid UUID (some can be set to null uuid) However null UUIDs, having a special meaning in editor, create issues when editing a footprint So all null uuids a re replaced by a valid uuid.

Returns: true if at least one uuid is changed, false if no change

Definition at line 238 of file footprint.cpp.

{
 // replace null UUIDs if any by a valid uuid
 std::vector< BOARD_ITEM* > item_list;
 
 item_list.push_back( m_reference );
 item_list.push_back( m_value );
 
 for( PAD* pad : m_pads )
 item_list.push_back( pad );
 
 for( BOARD_ITEM* gr_item : m_drawings )
 item_list.push_back( gr_item );
 
 // Note: one cannot fix null UUIDs inside the group, but it should not happen
 // because null uuids can be found in old footprints, therefore without group
 for( PCB_GROUP* group : m_fp_groups )
 item_list.push_back( group );
 
 // Probably notneeded, because old fp do not have zones. But just in case.
 for( FP_ZONE* zone : m_fp_zones )
 item_list.push_back( zone );
 
 bool changed = false;
 
 for( BOARD_ITEM* item : item_list )
 {
 if( item->m_Uuid == niluuid )
 {
 const_cast<KIID&>( item->m_Uuid ) = KIID();
 changed = true;
 }
 }
 
 return changed;
}

References group, m_drawings, m_fp_groups, m_fp_zones, m_pads, m_reference, m_value, niluuid, and pad.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard().

◆ Flip()

void FOOTPRINT::Flip	(	const VECTOR2I &	aCentre,
		bool	aFlipLeftRight
	)

overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipLeftRight	mirror across Y axis instead of X (the default).

Mirror the Y position (around the X axis)

Reimplemented from BOARD_ITEM.

Definition at line 1586 of file footprint.cpp.

{
 // Move footprint to its final position:
 VECTOR2I finalPos = m_pos;
 
 // Now Flip the footprint.
 // Flipping a footprint is a specific transform: it is not mirrored like a text.
 // We have to change the side, and ensure the footprint rotation is modified according to the
 // transform, because this parameter is used in pick and place files, and when updating the
 // footprint from library.
 // When flipped around the X axis (Y coordinates changed) orientation is negated
 // When flipped around the Y axis (X coordinates changed) orientation is 180 - old orient.
 // Because it is specific to a footprint, we flip around the X axis, and after rotate 180 deg
 
 MIRROR( finalPos.y, aCentre.y ); 
 
 SetPosition( finalPos );
 
 // Flip layer
 BOARD_ITEM::SetLayer( FlipLayer( GetLayer() ) );
 
 // Reverse mirror orientation.
 m_orient = -m_orient;
 m_orient.Normalize180();
 
 // Mirror pads to other side of board.
 for( PAD* pad : m_pads )
 pad->Flip( m_pos, false );
 
 // Mirror zones to other side of board.
 for( ZONE* zone : m_fp_zones )
 zone->Flip( m_pos, false );
 
 // Mirror reference and value.
 m_reference->Flip( m_pos, false );
 m_value->Flip( m_pos, false );
 
 // Reverse mirror footprint graphics and texts.
 for( BOARD_ITEM* item : m_drawings )
 {
 switch( item->Type() )
 {
 case PCB_FP_SHAPE_T:
 static_cast<FP_SHAPE*>( item )->Flip( m_pos, false );
 break;
 
 case PCB_FP_TEXT_T:
 static_cast<FP_TEXT*>( item )->Flip( m_pos, false );
 break;
 
 case PCB_FP_TEXTBOX_T:
 static_cast<FP_TEXTBOX*>( item )->Flip( m_pos, false );
 break;
 
 case PCB_FP_DIM_ALIGNED_T:
 case PCB_FP_DIM_ORTHOGONAL_T:
 case PCB_FP_DIM_RADIAL_T:
 case PCB_FP_DIM_CENTER_T:
 case PCB_FP_DIM_LEADER_T:
 static_cast<PCB_DIMENSION_BASE*>( item )->Flip( m_pos, false );
 break;
 
 default:
 wxMessageBox( wxString::Format( wxT( "FOOTPRINT::Flip() error: Unknown Draw Type %d" ),
 (int)item->Type() ) );
 break;
 }
 }
 
 // Now rotate 180 deg if required
 if( aFlipLeftRight )
 Rotate( aCentre, ANGLE_180 );
 
 m_boundingBoxCacheTimeStamp = 0;
 m_visibleBBoxCacheTimeStamp = 0;
 m_textExcludedBBoxCacheTimeStamp = 0;
 m_courtyard_cache_timestamp = 0;
 
 m_cachedHull.Mirror( aFlipLeftRight, !aFlipLeftRight, m_pos );
 
 std::swap( m_courtyard_cache_front, m_courtyard_cache_back );
}

References ANGLE_180, Flip(), FP_TEXT::Flip(), FlipLayer(), Format(), GetLayer(), m_boundingBoxCacheTimeStamp, m_cachedHull, m_courtyard_cache_back, m_courtyard_cache_front, m_courtyard_cache_timestamp, m_drawings, m_fp_zones, m_orient, m_pads, m_pos, m_reference, m_textExcludedBBoxCacheTimeStamp, m_value, m_visibleBBoxCacheTimeStamp, SHAPE_POLY_SET::Mirror(), MIRROR(), EDA_ANGLE::Normalize180(), pad, PCB_FP_DIM_ALIGNED_T, PCB_FP_DIM_CENTER_T, PCB_FP_DIM_LEADER_T, PCB_FP_DIM_ORTHOGONAL_T, PCB_FP_DIM_RADIAL_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, Rotate(), BOARD_ITEM::SetLayer(), SetPosition(), and VECTOR2< T >::y.

Referenced by PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_EDIT_FRAME::ExchangeFootprint(), Flip(), PCB_PLUGIN::FootprintSave(), DSN::SPECCTRA_DB::FromSESSION(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FABMASTER::loadFootprints(), EAGLE_PLUGIN::orientFootprintAndText(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SetLayerAndFlip(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ FootprintNeedsUpdate()

bool FOOTPRINT::FootprintNeedsUpdate ( const FOOTPRINT * aLibFootprint )

Return true if a board footprint differs from the library version.

Definition at line 348 of file drc_test_provider_library_parity.cpp.

{
#define TEST_ATTR( a, b, attr ) TEST( ( a & attr ), ( b & attr ) );
 wxASSERT( aLibFootprint );
 
 if( IsFlipped() )
 {
 std::unique_ptr<FOOTPRINT> temp( static_cast<FOOTPRINT*>( Clone() ) );
 temp->Flip( {0,0}, false );
 temp->SetParentGroup( nullptr );
 return temp->FootprintNeedsUpdate( aLibFootprint );
 }
 
 TEST( GetDescription(), aLibFootprint->GetDescription() );
 TEST( GetKeywords(), aLibFootprint->GetKeywords() );
 
 TEST_ATTR( GetAttributes(), aLibFootprint->GetAttributes(), FP_THROUGH_HOLE );
 TEST_ATTR( GetAttributes(), aLibFootprint->GetAttributes(), FP_SMD );
 TEST_ATTR( GetAttributes(), aLibFootprint->GetAttributes(), FP_ALLOW_SOLDERMASK_BRIDGES );
 TEST_ATTR( GetAttributes(), aLibFootprint->GetAttributes(), FP_ALLOW_MISSING_COURTYARD );
 
 // Clearance and zone connection overrides are as likely to be set at the board level as in
 // the library.
 //
 // If we ignore them and someone *does* change one of them in the library, then stale
 // footprints won't be caught.
 //
 // On the other hand, if we report them then boards that override at the board level are
 // going to be VERY noisy.
#if 0
 TEST( GetLocalClearance(), aLibFootprint->GetLocalClearance() );
 TEST( GetLocalSolderMaskMargin(), aLibFootprint->GetLocalSolderMaskMargin() );
 TEST( GetLocalSolderPasteMargin(), aLibFootprint->GetLocalSolderPasteMargin() );
 TEST_D( GetLocalSolderPasteMarginRatio(), aLibFootprint->GetLocalSolderPasteMarginRatio() );
 
 TEST( GetZoneConnection(), aLibFootprint->GetZoneConnection() );
#endif
 
 TEST( GetNetTiePadGroups().size(), aLibFootprint->GetNetTiePadGroups().size() );
 
 for( size_t ii = 0; ii < GetNetTiePadGroups().size(); ++ii )
 TEST( GetNetTiePadGroups()[ii], aLibFootprint->GetNetTiePadGroups()[ii] );
 
 // Text items are really problematic. We don't want to test the reference, but after that
 // it gets messy.
 //
 // What about the value? Depends on whether or not it's a singleton part.
 //
 // And what about other texts? They might be added only to instances on the board, or even
 // changed for instances on the board. Or they might want to be tested for equality.
 //
 // Currently we punt and ignore all the text items.
 
 // Drawings and pads are also somewhat problematic as there's no guarantee that they'll be
 // in the same order in the two footprints. Rather than building some sophisticated hashing
 // algorithm we use the footprint sorting functions to attempt to sort them in the same
 // order.
 
 std::set<BOARD_ITEM*, FOOTPRINT::cmp_drawings> aShapes;
 std::copy_if( GraphicalItems().begin(), GraphicalItems().end(),
 std::inserter( aShapes, aShapes.begin() ),
 []( BOARD_ITEM* item )
 {
 return item->Type() == PCB_FP_SHAPE_T;
 } );
 std::set<BOARD_ITEM*, FOOTPRINT::cmp_drawings> bShapes;
 std::copy_if( aLibFootprint->GraphicalItems().begin(), aLibFootprint->GraphicalItems().end(),
 std::inserter( bShapes, bShapes.begin() ),
 []( BOARD_ITEM* item )
 {
 return item->Type() == PCB_FP_SHAPE_T;
 } );
 
 std::set<PAD*, FOOTPRINT::cmp_pads> aPads( Pads().begin(), Pads().end() );
 std::set<PAD*, FOOTPRINT::cmp_pads> bPads( aLibFootprint->Pads().begin(), aLibFootprint->Pads().end() );
 
 std::set<FP_ZONE*, FOOTPRINT::cmp_zones> aZones( Zones().begin(), Zones().end() );
 std::set<FP_ZONE*, FOOTPRINT::cmp_zones> bZones( aLibFootprint->Zones().begin(), aLibFootprint->Zones().end() );
 
 TEST( aPads.size(), bPads.size() );
 TEST( aZones.size(), bZones.size() );
 TEST( aShapes.size(), bShapes.size() );
 
 for( auto aIt = aPads.begin(), bIt = bPads.begin(); aIt != aPads.end(); aIt++, bIt++ )
 TEST_PADS( *aIt, *bIt );
 
 for( auto aIt = aShapes.begin(), bIt = bShapes.begin(); aIt != aShapes.end(); aIt++, bIt++ )
 {
 if( ( *aIt )->Type() == PCB_FP_SHAPE_T )
 TEST_SHAPES( static_cast<FP_SHAPE*>( *aIt ), static_cast<FP_SHAPE*>( *bIt ) );
 }
 
 for( auto aIt = aZones.begin(), bIt = bZones.begin(); aIt != aZones.end(); aIt++, bIt++ )
 TEST_ZONES( *aIt, *bIt );
 
 TEST( Models().size(), aLibFootprint->Models().size() );
 
 for( size_t ii = 0; ii < Models().size(); ++ii )
 TEST_MODELS( Models()[ii], aLibFootprint->Models()[ii] );
 
 return false;
}

References Clone(), FP_ALLOW_MISSING_COURTYARD, FP_ALLOW_SOLDERMASK_BRIDGES, FP_SMD, FP_THROUGH_HOLE, GetAttributes(), GetDescription(), GetKeywords(), GetLocalClearance(), GetLocalSolderMaskMargin(), GetLocalSolderPasteMargin(), GetLocalSolderPasteMarginRatio(), GetNetTiePadGroups(), GetZoneConnection(), GraphicalItems(), IsFlipped(), Models(), Pads(), PCB_FP_SHAPE_T, TEST, TEST_ATTR, TEST_D, TEST_MODELS, TEST_PADS, TEST_SHAPES, TEST_ZONES, and Zones().

Referenced by DIALOG_EXCHANGE_FOOTPRINTS::processFootprint().

◆ Get() [1/3]

template<typename T >

std::optional< T > INSPECTABLE::Get ( const wxString & aProperty ) const

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 std::optional<T> ret;
 
 if( prop )
 {
 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 ret = prop->get<T>( object );
 }
 
 return ret;
 }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PROPERTIES_PANEL::getItemValue(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetArea()

double FOOTPRINT::GetArea ( int aPadding = 0 ) const

Definition at line 709 of file footprint.cpp.

{
 BOX2I bbox = GetBoundingBox( false, false );
 
 double w = std::abs( static_cast<double>( bbox.GetWidth() ) ) + aPadding;
 double h = std::abs( static_cast<double>( bbox.GetHeight() ) ) + aPadding;
 return w * h;
}

References std::abs(), GetBoundingBox(), BOX2< Vec >::GetHeight(), and BOX2< Vec >::GetWidth().

Referenced by sortFootprintsByComplexity(), and sortFootprintsByRatsnestSize().

◆ GetAttributes()

int FOOTPRINT::GetAttributes ( ) const

inline

Definition at line 250 of file footprint.h.

250{ return m_attributes; }

References m_attributes.

Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), KI_TEST::CheckFootprint(), CheckFootprintAttributes(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), EXPORTER_STEP::composePCB(), EDIT_TOOL::doMoveSelection(), PCB_EDIT_FRAME::ExchangeFootprint(), FootprintNeedsUpdate(), FootprintWriteShape(), PCB_PLUGIN::format(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 57 of file board_item.cpp.

{
 if( Type() == PCB_T )
 return static_cast<BOARD*>( this );
 
 BOARD_ITEM* parent = GetParent();
 
 if( parent )
 return parent->GetBoard();
 
 return nullptr;
}

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), PCB_T, and EDA_ITEM::Type().

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

Return the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 43 of file board_item.cpp.

{
 if( Type() == PCB_T )
 return static_cast<const BOARD*>( this );
 
 BOARD_ITEM* parent = GetParent();
 
 if( parent )
 return parent->GetBoard();
 
 return nullptr;
}

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), PCB_T, and EDA_ITEM::Type().

Referenced by BOARD_ADAPTER::addShape(), BuildCourtyardCaches(), PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), ZONE::CacheBoundingBox(), collidesWithArea(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), existsOnLayerFunc(), PCB_VIA::FlashLayer(), PAD::FlashLayer(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_SHAPE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), ZONE::Flip(), PCB_PLUGIN::format(), fromToFunc(), BOARD_ITEM::GetBoard(), PCB_EXPR_CONTEXT::GetBoard(), NETINFO_ITEM::GetBoundingBox(), ZONE::GetBoundingBox(), GetBoundingBox(), GetBoundingHull(), GetCourtyard(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), getFieldFunc(), ZONE::GetInteractingZones(), ZONE::GetItemDescription(), BOARD_ITEM::GetLayerName(), PCB_VIA::GetMinAnnulus(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), PCB_MARKER::GetSeverity(), PAD::GetSolderMaskExpansion(), PCB_VIA::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), PCB_TRACK::GetWidthConstraint(), inDiffPairFunc(), ROUTER_TOOL::Init(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), BOARD_ITEM::IsLocked(), PCB_VIA::IsTented(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), PAD::MergePrimitivesAsPolygon(), ZONE::Move(), DIALOG_TEXTBOX_PROPERTIES::onBorderChecked(), EAGLE_PLUGIN::packageWire(), padsNeedUpdate(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), ResolveTextVar(), BOARD_CONNECTED_ITEM::SetNetCode(), TEARDROP_DIALOG::TEARDROP_DIALOG(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), BOARD::UpdateRatsnestExclusions(), ViewBBox(), PAD::ViewBBox(), PCB_TRACK::ViewBBox(), PAD::ViewGetLOD(), PCB_BITMAP::ViewGetLOD(), PCB_VIA::ViewGetLOD(), ~FOOTPRINT(), and ZONE::~ZONE().

◆ GetBoundingBox() [1/2]

const BOX2I FOOTPRINT::GetBoundingBox ( ) const

overridevirtual

Return the orthogonal bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 804 of file footprint.cpp.

{
 return GetBoundingBox( true, true );
}

References GetBoundingBox().

Referenced by AR_AUTOPLACER::buildFpAreas(), PCB_GRID_HELPER::computeAnchors(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), GetArea(), GetBoundingBox(), GetBoundingBoxes(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), AR_AUTOPLACER::getOptimalFPPlacement(), HitTest(), PCB_SELECTION_TOOL::hitTestDistance(), SpreadFootprints(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), AR_AUTOPLACER::testFootprintOnBoard(), and ViewBBox().

◆ GetBoundingBox() [2/2]

const BOX2I FOOTPRINT::GetBoundingBox	(	bool	aIncludeText,
		bool	aIncludeInvisibleText
	)		const

Definition at line 810 of file footprint.cpp.

{
 const BOARD* board = GetBoard();
 bool isFPEdit = board && board->IsFootprintHolder();
 
 if( board )
 {
 if( aIncludeText && aIncludeInvisibleText )
 {
 if( m_boundingBoxCacheTimeStamp >= board->GetTimeStamp() )
 return m_cachedBoundingBox;
 }
 else if( aIncludeText )
 {
 if( m_visibleBBoxCacheTimeStamp >= board->GetTimeStamp() )
 return m_cachedVisibleBBox;
 }
 else
 {
 if( m_textExcludedBBoxCacheTimeStamp >= board->GetTimeStamp() )
 return m_cachedTextExcludedBBox;
 }
 }
 
 BOX2I bbox( m_pos );
 bbox.Inflate( pcbIUScale.mmToIU( 0.25 ) ); // Give a min size to the bbox
 
 for( BOARD_ITEM* item : m_drawings )
 {
 if( m_privateLayers.test( item->GetLayer() ) && !isFPEdit )
 continue;
 
 // We want the bitmap bounding box just in the footprint editor
 // so it will start with the correct initial zoom
 if( item->Type() == PCB_BITMAP_T && !isFPEdit )
 continue;
 
 // Handle text separately
 if( item->Type() == PCB_FP_TEXT_T )
 continue;
 
 bbox.Merge( item->GetBoundingBox() );
 }
 
 for( PAD* pad : m_pads )
 bbox.Merge( pad->GetBoundingBox() );
 
 for( FP_ZONE* zone : m_fp_zones )
 bbox.Merge( zone->GetBoundingBox() );
 
 bool noDrawItems = ( m_drawings.empty() && m_pads.empty() && m_fp_zones.empty() );
 
 // Groups do not contribute to the rect, only their members
 if( aIncludeText || noDrawItems )
 {
 for( BOARD_ITEM* item : m_drawings )
 {
 if( !isFPEdit && m_privateLayers.test( item->GetLayer() ) )
 continue;
 
 // Only FP_TEXT items are independently selectable; FP_TEXTBOX items go in with
 // other graphic items above.
 if( item->Type() == PCB_FP_TEXT_T )
 bbox.Merge( item->GetBoundingBox() );
 }
 
 // This can be further optimized when aIncludeInvisibleText is true, but currently
 // leaving this as is until it's determined there is a noticeable speed hit.
 bool valueLayerIsVisible = true;
 bool refLayerIsVisible = true;
 
 if( board )
 {
 // The first "&&" conditional handles the user turning layers off as well as layers
 // not being present in the current PCB stackup. Values, references, and all
 // footprint text can also be turned off via the GAL meta-layers, so the 2nd and
 // 3rd "&&" conditionals handle that.
 valueLayerIsVisible = board->IsLayerVisible( m_value->GetLayer() )
 && board->IsElementVisible( LAYER_MOD_VALUES )
 && board->IsElementVisible( LAYER_MOD_TEXT );
 
 refLayerIsVisible = board->IsLayerVisible( m_reference->GetLayer() )
 && board->IsElementVisible( LAYER_MOD_REFERENCES )
 && board->IsElementVisible( LAYER_MOD_TEXT );
 }
 
 
 if( ( m_value->IsVisible() && valueLayerIsVisible )
 || aIncludeInvisibleText
 || noDrawItems )
 {
 bbox.Merge( m_value->GetBoundingBox() );
 }
 
 if( ( m_reference->IsVisible() && refLayerIsVisible )
 || aIncludeInvisibleText
 || noDrawItems )
 {
 bbox.Merge( m_reference->GetBoundingBox() );
 }
 }
 
 if( board )
 {
 if( ( aIncludeText && aIncludeInvisibleText ) || noDrawItems )
 {
 m_boundingBoxCacheTimeStamp = board->GetTimeStamp();
 m_cachedBoundingBox = bbox;
 }
 else if( aIncludeText )
 {
 m_visibleBBoxCacheTimeStamp = board->GetTimeStamp();
 m_cachedVisibleBBox = bbox;
 }
 else
 {
 m_textExcludedBBoxCacheTimeStamp = board->GetTimeStamp();
 m_cachedTextExcludedBBox = bbox;
 }
 }
 
 return bbox;
}

References BOARD_ITEM::GetBoard(), FP_TEXT::GetBoundingBox(), BOARD_ITEM::GetLayer(), BOARD::GetTimeStamp(), BOX2< Vec >::Inflate(), BOARD::IsElementVisible(), BOARD::IsFootprintHolder(), BOARD::IsLayerVisible(), EDA_TEXT::IsVisible(), LAYER_MOD_REFERENCES, LAYER_MOD_TEXT, LAYER_MOD_VALUES, m_boundingBoxCacheTimeStamp, m_cachedBoundingBox, m_cachedTextExcludedBBox, m_cachedVisibleBBox, m_drawings, m_fp_zones, m_pads, m_pos, m_privateLayers, m_reference, m_textExcludedBBoxCacheTimeStamp, m_value, m_visibleBBoxCacheTimeStamp, BOX2< Vec >::Merge(), EDA_IU_SCALE::mmToIU(), pad, PCB_BITMAP_T, PCB_FP_TEXT_T, and pcbIUScale.

◆ GetBoundingHull()

SHAPE_POLY_SET FOOTPRINT::GetBoundingHull ( ) const

Return a bounding polygon for the shapes and pads in the footprint.

This operation is slower but more accurate than calculating a bounding box.

Definition at line 935 of file footprint.cpp.

{
 const BOARD* board = GetBoard();
 bool isFPEdit = board && board->IsFootprintHolder();
 
 if( board )
 {
 if( m_hullCacheTimeStamp >= board->GetTimeStamp() )
 return m_cachedHull;
 }
 
 SHAPE_POLY_SET rawPolys;
 SHAPE_POLY_SET hull;
 
 for( BOARD_ITEM* item : m_drawings )
 {
 if( !isFPEdit && m_privateLayers.test( item->GetLayer() ) )
 continue;
 
 if( item->Type() != PCB_FP_TEXT_T && item->Type() != PCB_BITMAP_T )
 {
 item->TransformShapeToPolygon( rawPolys, UNDEFINED_LAYER, 0, ARC_LOW_DEF,
 ERROR_OUTSIDE );
 }
 
 // We intentionally exclude footprint text from the bounding hull.
 }
 
 for( PAD* pad : m_pads )
 {
 pad->TransformShapeToPolygon( rawPolys, UNDEFINED_LAYER, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
 // In case hole is larger than pad
 pad->TransformHoleToPolygon( rawPolys, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
 }
 
 for( FP_ZONE* zone : m_fp_zones )
 {
 for( PCB_LAYER_ID layer : zone->GetLayerSet().Seq() )
 {
 const SHAPE_POLY_SET& layerPoly = *zone->GetFilledPolysList( layer );
 
 for( int ii = 0; ii < layerPoly.OutlineCount(); ii++ )
 {
 const SHAPE_LINE_CHAIN& poly = layerPoly.COutline( ii );
 rawPolys.AddOutline( poly );
 }
 }
 }
 
 // If there are some graphic items, build the actual hull.
 // However if no items, create a minimal polygon (can happen if a footprint
 // is created with no item: it contains only 2 texts.
 if( rawPolys.OutlineCount() == 0 )
 {
 // generate a small dummy rectangular outline around the anchor
 const int halfsize = pcbIUScale.mmToIU( 1.0 );
 
 rawPolys.NewOutline();
 
 // add a square:
 rawPolys.Append( GetPosition().x - halfsize, GetPosition().y - halfsize );
 rawPolys.Append( GetPosition().x + halfsize, GetPosition().y - halfsize );
 rawPolys.Append( GetPosition().x + halfsize, GetPosition().y + halfsize );
 rawPolys.Append( GetPosition().x - halfsize, GetPosition().y + halfsize );
 }
 
 std::vector<VECTOR2I> convex_hull;
 BuildConvexHull( convex_hull, rawPolys );
 
 m_cachedHull.RemoveAllContours();
 m_cachedHull.NewOutline();
 
 for( const VECTOR2I& pt : convex_hull )
 m_cachedHull.Append( pt );
 
 if( board )
 m_hullCacheTimeStamp = board->GetTimeStamp();
 
 return m_cachedHull;
}

References SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::Append(), ARC_LOW_DEF, BuildConvexHull(), SHAPE_POLY_SET::COutline(), ERROR_OUTSIDE, BOARD_ITEM::GetBoard(), GetPosition(), BOARD::GetTimeStamp(), BOARD::IsFootprintHolder(), m_cachedHull, m_drawings, m_fp_zones, m_hullCacheTimeStamp, m_pads, m_privateLayers, EDA_IU_SCALE::mmToIU(), SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::OutlineCount(), pad, PCB_BITMAP_T, PCB_FP_TEXT_T, pcbIUScale, SHAPE_POLY_SET::RemoveAllContours(), and UNDEFINED_LAYER.

Referenced by CoverageRatio(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), GetCoverageArea(), HitTestAccurate(), and PCB_SELECTION_TOOL::hitTestDistance().

◆ GetCenter()

virtual VECTOR2I BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

This defaults to the center of the bounding box if not overridden.

Returns: center point of the item

Reimplemented in PAD, PCB_MARKER, PCB_SHAPE, and PCB_ARC.

Definition at line 93 of file board_item.h.

 {
 return GetBoundingBox().GetCenter();
 }

References EDA_ITEM::GetBoundingBox(), and BOX2< Vec >::GetCenter().

Referenced by PCB_GRID_HELPER::computeAnchors(), PCB_SELECTION_TOOL::FindItem(), and ALTIUM_PCB::HelperParseDimensions6Radial().

◆ GetClass()

wxString FOOTPRINT::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 702 of file footprint.h.

 {
 return wxT( "FOOTPRINT" );
 }

Referenced by Visit().

◆ GetContextualTextVars()

void FOOTPRINT::GetContextualTextVars ( wxArrayString * aVars ) const

Return the list of system text vars for this footprint.

Definition at line 480 of file footprint.cpp.

{
 aVars->push_back( wxT( "REFERENCE" ) );
 aVars->push_back( wxT( "VALUE" ) );
 aVars->push_back( wxT( "LAYER" ) );
 aVars->push_back( wxT( "FOOTPRINT_LIBRARY" ) );
 aVars->push_back( wxT( "FOOTPRINT_NAME" ) );
 aVars->push_back( wxT( "NET_NAME(<pad_number>)" ) );
 aVars->push_back( wxT( "NET_CLASS(<pad_number>)" ) );
 aVars->push_back( wxT( "PIN_NAME(<pad_number>)" ) );
}

◆ GetCourtyard()

const SHAPE_POLY_SET & FOOTPRINT::GetCourtyard ( PCB_LAYER_ID aLayer ) const

Used in DRC to test the courtyard area (a complex polygon).

Returns: the courtyard polygon.

Definition at line 2215 of file footprint.cpp.

{
 if( GetBoard() && GetBoard()->GetTimeStamp() > m_courtyard_cache_timestamp )
 const_cast<FOOTPRINT*>( this )->BuildCourtyardCaches();
 
 if( IsBackLayer( aLayer ) )
 return m_courtyard_cache_back;
 else
 return m_courtyard_cache_front;
}

References BuildCourtyardCaches(), BOARD_ITEM::GetBoard(), IsBackLayer(), m_courtyard_cache_back, m_courtyard_cache_front, and m_courtyard_cache_timestamp.

Referenced by AR_AUTOPLACER::buildFpAreas(), collidesWithArea(), collidesWithCourtyard(), KIGFX::PCB_PAINTER::draw(), DRC_ENGINE::EvalRules(), GetEffectiveShape(), BOARD_INSPECTION_TOOL::InspectClearance(), and DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances().

◆ GetCoverageArea()

double FOOTPRINT::GetCoverageArea	(	const BOARD_ITEM *	aItem,
		const GENERAL_COLLECTOR &	aCollector
	)

static

Return the initial comments block or NULL if none, without transfer of ownership.

Definition at line 2028 of file footprint.cpp.

{
 int textMargin = KiROUND( 5 * aCollector.GetGuide()->OnePixelInIU() );
 SHAPE_POLY_SET poly;
 
 if( aItem->Type() == PCB_MARKER_T )
 {
 const PCB_MARKER* marker = static_cast<const PCB_MARKER*>( aItem );
 SHAPE_LINE_CHAIN markerShape;
 
 marker->ShapeToPolygon( markerShape );
 return markerShape.Area();
 }
 else if( aItem->Type() == PCB_GROUP_T )
 {
 double combinedArea = 0.0;
 
 for( BOARD_ITEM* member : static_cast<const PCB_GROUP*>( aItem )->GetItems() )
 combinedArea += GetCoverageArea( member, aCollector );
 
 return combinedArea;
 }
 if( aItem->Type() == PCB_FOOTPRINT_T )
 {
 const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( aItem );
 
 poly = footprint->GetBoundingHull();
 }
 else if( aItem->Type() == PCB_FP_TEXT_T )
 {
 const FP_TEXT* text = static_cast<const FP_TEXT*>( aItem );
 
 text->TransformTextToPolySet( poly, UNDEFINED_LAYER, textMargin, ARC_LOW_DEF, ERROR_OUTSIDE );
 }
 else if( aItem->Type() == PCB_FP_TEXTBOX_T )
 {
 const FP_TEXTBOX* tb = static_cast<const FP_TEXTBOX*>( aItem );
 
 tb->TransformTextToPolySet( poly, UNDEFINED_LAYER, textMargin, ARC_LOW_DEF, ERROR_OUTSIDE );
 }
 else if( aItem->Type() == PCB_SHAPE_T )
 {
 // Approximate "linear" shapes with just their width squared, as we don't want to consider
 // a linear shape as being much bigger than another for purposes of selection filtering
 // just because it happens to be really long.
 
 const PCB_SHAPE* shape = static_cast<const PCB_SHAPE*>( aItem );
 
 switch( shape->GetShape() )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::ARC:
 case SHAPE_T::BEZIER:
 return shape->GetWidth() * shape->GetWidth();
 
 case SHAPE_T::RECT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::POLY:
 {
 if( !shape->IsFilled() )
 return shape->GetWidth() * shape->GetWidth();
 
 KI_FALLTHROUGH;
 }
 
 default:
 shape->TransformShapeToPolygon( poly, UNDEFINED_LAYER, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
 }
 }
 else if( aItem->Type() == PCB_TRACE_T || aItem->Type() == PCB_ARC_T )
 {
 double width = static_cast<const PCB_TRACK*>( aItem )->GetWidth();
 return width * width;
 }
 else
 {
 aItem->TransformShapeToPolygon( poly, UNDEFINED_LAYER, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
 }
 
 return polygonArea( poly );
}

References ARC, ARC_LOW_DEF, SHAPE_LINE_CHAIN::Area(), BEZIER, CIRCLE, ERROR_OUTSIDE, GetBoundingHull(), GetCoverageArea(), GENERAL_COLLECTOR::GetGuide(), PCB_GROUP::GetItems(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetWidth(), EDA_SHAPE::IsFilled(), KI_FALLTHROUGH, KiROUND(), COLLECTORS_GUIDE::OnePixelInIU(), PCB_ARC_T, PCB_FOOTPRINT_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, PCB_GROUP_T, PCB_MARKER_T, PCB_SHAPE_T, PCB_TRACE_T, POLY, polygonArea(), RECT, SEGMENT, MARKER_BASE::ShapeToPolygon(), text, BOARD_ITEM::TransformShapeToPolygon(), PCB_SHAPE::TransformShapeToPolygon(), FP_TEXTBOX::TransformTextToPolySet(), EDA_ITEM::Type(), and UNDEFINED_LAYER.

Referenced by GetCoverageArea(), and PCB_SELECTION_TOOL::GuessSelectionCandidates().

◆ GetDescription()

wxString FOOTPRINT::GetDescription ( ) const

inline

Definition at line 218 of file footprint.h.

218{ return m_doc; }

References m_doc.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), KI_TEST::CheckFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_PLUGIN::format(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), GetMsgPanelInfo(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FOOTPRINT_INFO_IMPL::load(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

 {
 constexpr int mask =
 ( IS_NEW | IS_PASTED | IS_MOVING | IS_BROKEN | IS_CHANGED | STRUCT_DELETED );
 
 return m_flags & mask;
 }

References IS_BROKEN, IS_CHANGED, IS_MOVING, IS_NEW, IS_PASTED, EDA_ITEM::m_flags, and STRUCT_DELETED.

◆ GetEffectiveHoleShape()

std::shared_ptr< SHAPE_SEGMENT > BOARD_ITEM::GetEffectiveHoleShape ( ) const

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 229 of file board_item.cpp.

{
 static std::shared_ptr<SHAPE_SEGMENT> slot;
 
 UNIMPLEMENTED_FOR( GetClass() );
 
 return slot;
}

References EDA_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

Referenced by collidesWithArea(), DRAWING_TOOL::DrawVia(), DRC_RTREE::Insert(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > FOOTPRINT::GetEffectiveShape	(	PCB_LAYER_ID	aLayer = `UNDEFINED_LAYER`,
		FLASHING	aFlash = `FLASHING::DEFAULT`
	)		const

overridevirtual

Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.

This routine returns a COMPOUND shape (set of simple shapes which make up the pad for use with routing, collision determination, etc).

Note: This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of multiple outlines and/or holes).

Parameters

aLayer	in case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.
aFlash	optional parameter allowing a caller to force the pad to be flashed (or not flashed) on the current layer (default is to honour the pad's setting and the current connections for the given layer).

Reimplemented from BOARD_ITEM.

Definition at line 2179 of file footprint.cpp.

{
 std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
 
 // There are several possible interpretations here:
 // 1) the bounding box (without or without invisible items)
 // 2) just the pads and "edges" (ie: non-text graphic items)
 // 3) the courtyard
 
 // We'll go with (2) for now, unless the caller is clearly looking for (3)
 
 if( aLayer == F_CrtYd || aLayer == B_CrtYd )
 {
 const SHAPE_POLY_SET& courtyard = GetCourtyard( aLayer );
 
 if( courtyard.OutlineCount() == 0 ) // malformed/empty polygon
 return shape;
 
 shape->AddShape( new SHAPE_SIMPLE( courtyard.COutline( 0 ) ) );
 }
 else
 {
 for( PAD* pad : Pads() )
 shape->AddShape( pad->GetEffectiveShape( aLayer, aFlash )->Clone() );
 
 for( BOARD_ITEM* item : GraphicalItems() )
 {
 if( item->Type() == PCB_FP_SHAPE_T )
 shape->AddShape( item->GetEffectiveShape( aLayer, aFlash )->Clone() );
 }
 }
 
 return shape;
}

References B_CrtYd, SHAPE_POLY_SET::COutline(), F_CrtYd, GetCourtyard(), GraphicalItems(), SHAPE_POLY_SET::OutlineCount(), pad, Pads(), and PCB_FP_SHAPE_T.

◆ GetFileFormatVersionAtLoad()

int FOOTPRINT::GetFileFormatVersionAtLoad ( ) const

inline

Definition at line 620 of file footprint.h.

620{ return m_fileFormatVersionAtLoad; }

References m_fileFormatVersionAtLoad.

◆ GetFlag()

int FOOTPRINT::GetFlag ( ) const

inline

Definition at line 255 of file footprint.h.

255{ return m_arflag; }

References m_arflag.

Referenced by KI_TEST::CheckFootprint(), AR_AUTOPLACER::pickFootprint(), and sortFootprintsByRatsnestSize().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

142{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), BOARD_COMMIT::dirtyIntersectingZones(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 256 of file eda_item.h.

256{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetFPID()

const LIB_ID & FOOTPRINT::GetFPID ( ) const

inline

Definition at line 212 of file footprint.h.

212{ return m_fpid; }

References m_fpid.

◆ GetFPIDAsString()

wxString FOOTPRINT::GetFPIDAsString ( ) const

inline

Definition at line 215 of file footprint.h.

215{ return m_fpid.Format(); }

LIB_ID::Format

UTF8 Format() const

Definition: lib_id.cpp:117

References LIB_ID::Format(), and m_fpid.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ GetFpPadsLocalBbox()

BOX2I FOOTPRINT::GetFpPadsLocalBbox ( ) const

Return 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 footprint outline when the courtyard is missing or broken.

Returns: The rectangle containing the pads for the normalized footprint.

Definition at line 781 of file footprint.cpp.

{
 BOX2I bbox;
 
 // We want the bounding box of the footprint pads at rot 0, not flipped
 // Create such a image:
 FOOTPRINT dummy( *this );
 
 dummy.SetPosition( VECTOR2I( 0, 0 ) );
 dummy.SetOrientation( ANGLE_0 );
 
 if( dummy.IsFlipped() )
 dummy.Flip( VECTOR2I( 0, 0 ), false );
 
 for( PAD* pad : dummy.Pads() )
 bbox.Merge( pad->GetBoundingBox() );
 
 dummy.SetParent( nullptr );
 
 return bbox;
}

References ANGLE_0, dummy, BOX2< Vec >::Merge(), and pad.

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TRACK, and ZONE.

Definition at line 310 of file eda_item.cpp.

{
 return GetTypeDesc();
}

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::rebuildProperties().

◆ GetInitialComments()

const wxArrayString * FOOTPRINT::GetInitialComments ( ) const

inline

Definition at line 784 of file footprint.h.

784{ return m_initial_comments; }

References m_initial_comments.

Referenced by PCB_PLUGIN::format().

◆ GetItemDescription()

wxString FOOTPRINT::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

Return a user-visible description string of this item.

This description is used in disambiguation menus, the message panel, ERC/DRC reports, etc.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1356 of file footprint.cpp.

{
 wxString reference = GetReference();
 
 if( reference.IsEmpty() )
 reference = _( "<no reference designator>" );
 
 return wxString::Format( _( "Footprint %s" ), reference );
}

References _, Format(), and GetReference().

Referenced by DRC_ENGINE::EvalRules().

◆ GetKeywords()

wxString FOOTPRINT::GetKeywords ( ) const

inline

Definition at line 221 of file footprint.h.

221{ return m_keywords; }

References m_keywords.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), KI_TEST::CheckFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_PLUGIN::format(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), GetMsgPanelInfo(), FOOTPRINT_INFO_IMPL::load(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow().

◆ GetLayer()

PCB_LAYER_ID FOOTPRINT::GetLayer ( ) const

inlineoverridevirtual

Return the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Definition at line 200 of file footprint.h.

200{ return BOARD_ITEM::GetLayer(); }

References BOARD_ITEM::GetLayer().

Referenced by AR_AUTOPLACER::buildFpAreas(), EXPORTER_STEP::composePCB(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_EDIT_FRAME::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_PLUGIN::FootprintSave(), PCB_PLUGIN::format(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromSESSION(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), AR_AUTOPLACER::getOptimalFPPlacement(), idf_export_footprint(), GENERAL_COLLECTOR::Inspect(), IsFlipped(), PAD::IsFlipped(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), EAGLE_PLUGIN::packagePad(), SetLayerAndFlip(), AR_AUTOPLACER::testFootprintOnBoard(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

Return the name of the PCB layer on which the item resides.

Returns: the layer name associated with this item.

Definition at line 94 of file board_item.cpp.

{
 const BOARD* board = GetBoard();
 
 if( board )
 return board->GetLayerName( m_layer );
 
 // If no parent, return standard name
 return BOARD::GetStandardLayerName( m_layer );
}

References BOARD_ITEM::GetBoard(), BOARD::GetLayerName(), BOARD::GetStandardLayerName(), and BOARD_ITEM::m_layer.

Referenced by FP_SHAPE::GetItemDescription(), PCB_DIMENSION_BASE::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TEXT::GetItemDescription(), PCB_TEXTBOX::GetItemDescription(), PCB_TRACK::GetItemDescription(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), and ResolveTextVar().

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

Return a std::bitset of all layers on which the item physically resides.

Reimplemented in PCB_GROUP, PAD, PCB_VIA, and ZONE.

Definition at line 185 of file board_item.h.

 {
 if( m_layer == UNDEFINED_LAYER )
 return LSET();
 else
 return LSET( m_layer );
 }

References BOARD_ITEM::m_layer, and UNDEFINED_LAYER.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), KI_TEST::CheckFpShape(), collidesWithArea(), BOARD_COMMIT::dirtyIntersectingZones(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), existsOnLayerFunc(), extractDiffPairCoupledItems(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), hash_board_item(), BOARD_INSPECTION_TOOL::InspectClearance(), PNS_KICAD_IFACE::IsItemVisible(), isMaskAperture(), BOARD_ITEM::layerMaskDescribe(), FABMASTER::loadZone(), PCB_DIMENSION_BASE::Mirror(), PCB_GRID_HELPER::nearestAnchor(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), DRC_ENGINE::ProcessAssertions(), EDIT_TOOL::Properties(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetLikelyAttribute()

int FOOTPRINT::GetLikelyAttribute ( ) const

Returns the most likely attribute based on pads Either FP_THROUGH_HOLE/FP_SMD/OTHER(0)

Returns: 0/FP_SMD/FP_THROUGH_HOLE

Definition at line 719 of file footprint.cpp.

{
 int smd_count = 0;
 int tht_count = 0;
 
 for( PAD* pad : m_pads )
 {
 switch( pad->GetProperty() )
 {
 case PAD_PROP::FIDUCIAL_GLBL:
 case PAD_PROP::FIDUCIAL_LOCAL:
 continue;
 
 case PAD_PROP::HEATSINK:
 case PAD_PROP::CASTELLATED:
 continue;
 
 case PAD_PROP::NONE:
 case PAD_PROP::BGA:
 case PAD_PROP::TESTPOINT:
 break;
 }
 
 switch( pad->GetAttribute() )
 {
 case PAD_ATTRIB::PTH:
 tht_count++;
 break;
 
 case PAD_ATTRIB::SMD:
 if( pad->IsOnCopperLayer() )
 smd_count++;
 
 break;
 
 default:
 break;
 }
 }
 
 if( smd_count > 0 )
 return FP_SMD;
 
 if( tht_count > 0 )
 return FP_THROUGH_HOLE;
 
 return 0;
}

References BGA, CASTELLATED, FIDUCIAL_GLBL, FIDUCIAL_LOCAL, FP_SMD, FP_THROUGH_HOLE, HEATSINK, m_pads, NONE, pad, PTH, SMD, and TESTPOINT.

Referenced by CheckFootprintAttributes().

◆ GetLink()

KIID FOOTPRINT::GetLink ( ) const

inline

Definition at line 680 of file footprint.h.

680{ return m_link; }

References m_link.

Referenced by footprintIsFromBoard(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ GetLocalClearance() [1/2]

int FOOTPRINT::GetLocalClearance ( ) const

inline

Definition at line 230 of file footprint.h.

230{ return m_localClearance; }

References m_localClearance.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_PLUGIN::format(), PAD::GetLocalClearanceOverrides(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow().

◆ GetLocalClearance() [2/2]

int FOOTPRINT::GetLocalClearance ( wxString * aSource ) const

inline

Definition at line 233 of file footprint.h.

 {
 if( aSource )
 *aSource = wxString::Format( _( "footprint %s" ), GetReference() );
 
 return m_localClearance;
 }

References _, Format(), GetReference(), and m_localClearance.

◆ GetLocalSolderMaskMargin()

int FOOTPRINT::GetLocalSolderMaskMargin ( ) const

inline

Definition at line 227 of file footprint.h.

227{ return m_localSolderMaskMargin; }

References m_localSolderMaskMargin.

Referenced by FootprintNeedsUpdate(), PCB_PLUGIN::format(), PAD::GetSolderMaskExpansion(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow().

◆ GetLocalSolderPasteMargin()

int FOOTPRINT::GetLocalSolderPasteMargin ( ) const

inline

Definition at line 241 of file footprint.h.

241{ return m_localSolderPasteMargin; }

References m_localSolderPasteMargin.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_PLUGIN::format(), PAD::GetSolderPasteMargin(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow().

◆ GetLocalSolderPasteMarginRatio()

double FOOTPRINT::GetLocalSolderPasteMarginRatio ( ) const

inline

Definition at line 244 of file footprint.h.

244{ return m_localSolderPasteMarginRatio; }

References m_localSolderPasteMarginRatio.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_PLUGIN::format(), PAD::GetSolderPasteMargin(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow().

◆ GetMenuImage()

BITMAPS FOOTPRINT::GetMenuImage ( ) const

overridevirtual

Return a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1367 of file footprint.cpp.

{
 return BITMAPS::module;
}

References module.

◆ GetMsgPanelInfo()

void FOOTPRINT::GetMsgPanelInfo	(	EDA_DRAW_FRAME *	aFrame,
		std::vector< MSG_PANEL_ITEM > &	aList
	)

overridevirtual

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1017 of file footprint.cpp.

{
 wxString msg, msg2;
 
 aList.emplace_back( m_reference->GetShownText(), m_value->GetShownText() );
 
 if( aFrame->IsType( FRAME_FOOTPRINT_VIEWER )
 || aFrame->IsType( FRAME_FOOTPRINT_VIEWER_MODAL )
 || aFrame->IsType( FRAME_FOOTPRINT_EDITOR ) )
 {
 size_t padCount = GetPadCount( DO_NOT_INCLUDE_NPTH );
 
 aList.emplace_back( _( "Library" ), GetFPID().GetLibNickname().wx_str() );
 
 aList.emplace_back( _( "Footprint Name" ), GetFPID().GetLibItemName().wx_str() );
 
 aList.emplace_back( _( "Pads" ), wxString::Format( wxT( "%zu" ), padCount ) );
 
 aList.emplace_back( wxString::Format( _( "Doc: %s" ), GetDescription() ),
 wxString::Format( _( "Keywords: %s" ), GetKeywords() ) );
 
 return;
 }
 
 // aFrame is the board editor:
 aList.emplace_back( _( "Board Side" ), IsFlipped() ? _( "Back (Flipped)" ) : _( "Front" ) );
 
 auto addToken = []( wxString* aStr, const wxString& aAttr )
 {
 if( !aStr->IsEmpty() )
 *aStr += wxT( ", " );
 
 *aStr += aAttr;
 };
 
 wxString status;
 wxString attrs;
 
 if( IsLocked() )
 addToken( &status, _( "Locked" ) );
 
 if( m_fpStatus & FP_is_PLACED )
 addToken( &status, _( "autoplaced" ) );
 
 if( m_attributes & FP_BOARD_ONLY )
 addToken( &attrs, _( "not in schematic" ) );
 
 if( m_attributes & FP_EXCLUDE_FROM_POS_FILES )
 addToken( &attrs, _( "exclude from pos files" ) );
 
 if( m_attributes & FP_EXCLUDE_FROM_BOM )
 addToken( &attrs, _( "exclude from BOM" ) );
 
 aList.emplace_back( _( "Status: " ) + status, _( "Attributes:" ) + wxS( " " ) + attrs );
 
 aList.emplace_back( _( "Rotation" ), wxString::Format( wxT( "%.4g" ),
 GetOrientation().AsDegrees() ) );
 
 msg.Printf( _( "Footprint: %s" ), m_fpid.GetUniStringLibId() );
 msg2.Printf( _( "3D-Shape: %s" ), m_3D_Drawings.empty() ? _( "<none>" )
 : m_3D_Drawings.front().m_Filename );
 aList.emplace_back( msg, msg2 );
 
 msg.Printf( _( "Doc: %s" ), m_doc );
 msg2.Printf( _( "Keywords: %s" ), m_keywords );
 aList.emplace_back( msg, msg2 );
}

References _, DO_NOT_INCLUDE_NPTH, Format(), FP_BOARD_ONLY, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_is_PLACED, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, GetDescription(), GetFPID(), GetKeywords(), GetOrientation(), GetPadCount(), FP_TEXT::GetShownText(), LIB_ID::GetUniStringLibId(), IsFlipped(), IsLocked(), EDA_BASE_FRAME::IsType(), m_3D_Drawings, m_attributes, m_doc, m_fpid, m_fpStatus, m_keywords, m_reference, and m_value.

Referenced by PCB_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_EDIT_FRAME::UpdateMsgPanel(), and FOOTPRINT_VIEWER_FRAME::UpdateMsgPanel().

◆ GetNetTiePadGroups()

const std::vector< wxString > & FOOTPRINT::GetNetTiePadGroups ( ) const

inline

Returns: 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.

Definition at line 272 of file footprint.h.

272{ return m_netTiePadGroups; }

References m_netTiePadGroups.

Referenced by FootprintNeedsUpdate(), PCB_PLUGIN::format(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow().

◆ GetNetTiePads()

std::vector< PAD * > FOOTPRINT::GetNetTiePads ( PAD * aPad ) const

Returns: a list of pads that appear in aPad's net-tie pad group.

Definition at line 2339 of file footprint.cpp.

{
 // First build a map from pad numbers to allowed-shorting-group indexes. This ends up being
 // something like O(3n), but it still beats O(n^2) for large numbers of pads.
 
 std::map<wxString, int> padToNetTieGroupMap = MapPadNumbersToNetTieGroups();
 int groupIdx = padToNetTieGroupMap[ aPad->GetNumber() ];
 std::vector<PAD*> otherPads;
 
 if( groupIdx >= 0 )
 {
 for( PAD* pad : m_pads )
 {
 if( padToNetTieGroupMap[ pad->GetNumber() ] == groupIdx )
 otherPads.push_back( pad );
 }
 }
 
 return otherPads;
}

References PAD::GetNumber(), m_pads, MapPadNumbersToNetTieGroups(), and pad.

Referenced by CheckShortingPads().

◆ GetNextPadNumber()

wxString FOOTPRINT::GetNextPadNumber ( const wxString & aLastPadName ) const

Return the next available pad number in the footprint.

Parameters

aFillSequenceGaps true if the numbering should "fill in" gaps in the sequence, else return the highest value + 1

Returns: the next available pad number

Definition at line 1981 of file footprint.cpp.

{
 std::set<wxString> usedNumbers;
 
 // Create a set of used pad numbers
 for( PAD* pad : m_pads )
 usedNumbers.insert( pad->GetNumber() );
 
 // Pad numbers aren't technically reference designators, but the formatting is close enough
 // for these to give us what we need.
 wxString prefix = UTIL::GetRefDesPrefix( aLastPadNumber );
 int num = GetTrailingInt( aLastPadNumber );
 
 while( usedNumbers.count( wxString::Format( wxT( "%s%d" ), prefix, num ) ) )
 num++;
 
 return wxString::Format( wxT( "%s%d" ), prefix, num );
}

References Format(), UTIL::GetRefDesPrefix(), GetTrailingInt(), m_pads, and pad.

Referenced by EDIT_TOOL::Duplicate().

◆ GetOrientation()

EDA_ANGLE FOOTPRINT::GetOrientation ( ) const

inline

Definition at line 191 of file footprint.h.

191{ return m_orient; }

References m_orient.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_PAD::AddToFootprint(), KI_TEST::CheckFootprint(), EXPORTER_STEP::composePCB(), ConvertOutlineToPolygon(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), PCB_PLUGIN::format(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_SHAPE::getParentOrientation(), hash_fp_item(), ALTIUM_PCB::HelperShapeSetLocalCoord(), idf_export_footprint(), PAD::ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineDrag(), LEGACY_PLUGIN::loadPAD(), DSN::SPECCTRA_DB::makeIMAGE(), MoveAnchorPosition(), EAGLE_PLUGIN::orientFPText(), padsNeedUpdate(), ALTIUM_PCB::ParseComponentsBodies6Data(), pasteFootprintItemsToFootprintEditor(), BRDITEMS_PLOTTER::PlotFootprintShape(), RENDER_3D_OPENGL::renderFootprint(), Rotate(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), EAGLE_PLUGIN::transferPad(), and zonesNeedUpdate().

◆ GetOrientationDegrees()

double FOOTPRINT::GetOrientationDegrees ( ) const

inline

Definition at line 207 of file footprint.h.

 {
 return m_orient.AsDegrees();
 }

References EDA_ANGLE::AsDegrees(), and m_orient.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ GetPad()

PAD * FOOTPRINT::GetPad	(	const VECTOR2I &	aPosition,
		LSET	aLayerMask = `LSET::AllLayersMask()`
	)

Get a pad at aPosition on aLayerMask in the footprint.

Parameters

aPosition	A VECTOR2I object containing the position to hit test.
aLayerMask	A layer or layers to mask the hit test.

Returns: A pointer to a PAD object if found otherwise NULL.

Definition at line 1194 of file footprint.cpp.

{
 for( PAD* pad : m_pads )
 {
 // ... and on the correct layer.
 if( !( pad->GetLayerSet() & aLayerMask ).any() )
 continue;
 
 if( pad->HitTest( aPosition ) )
 return pad;
 }
 
 return nullptr;
}

References m_pads, and pad.

◆ GetPadCount()

unsigned FOOTPRINT::GetPadCount ( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const

Return the number of pads.

Parameters

aIncludeNPTH includes non-plated through holes when true. Does not include non-plated through holes when false.

Returns: the number of pads according to aIncludeNPTH.

Definition at line 1210 of file footprint.cpp.

{
 if( aIncludeNPTH )
 return m_pads.size();
 
 unsigned cnt = 0;
 
 for( PAD* pad : m_pads )
 {
 if( pad->GetAttribute() == PAD_ATTRIB::NPTH )
 continue;
 
 cnt++;
 }
 
 return cnt;
}

References m_pads, NPTH, and pad.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), GetMsgPanelInfo(), FOOTPRINT_INFO_IMPL::load(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), sortFootprintsByComplexity(), and AR_AUTOPLACER::testFootprintOnBoard().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 163 of file board_item.h.

163{ return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:496

References EDA_ITEM::m_parent.

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 239 of file board_item.cpp.

{
 BOARD_ITEM_CONTAINER* ancestor = GetParent();
 
 while( ancestor && ancestor->Type() == PCB_GROUP_T )
 ancestor = ancestor->GetParent();
 
 return ( ancestor && ancestor->Type() == PCB_FOOTPRINT_T ) ? ancestor : nullptr;
}

References BOARD_ITEM::GetParent(), PCB_FOOTPRINT_T, PCB_GROUP_T, and EDA_ITEM::Type().

Referenced by CN_CONNECTIVITY_ALGO::Add(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), PNS::ITEM::collideSimple(), CONVERT_TOOL::CreatePolys(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), PCB_SHAPE::GetParentFootprint(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), DRC_ENGINE::IsNetTieExclusion(), LEGACY_PLUGIN::loadMODULE_TEXT(), PAD_TOOL::RecombinePad(), PAD::SameLogicalPadAs(), PAD::SharesNetTieGroup(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), and zonesNeedUpdate().

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 72 of file board_item.h.

72{ return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:334

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), BOARD_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), getClosestGroup(), BOARD::GroupLegalOps(), BOARD_ITEM::IsLocked(), memberOfFunc(), BOARD::Move(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_COMMIT::Push(), BOARD::Remove(), Remove(), GROUP_TOOL::RemoveFromGroup(), BOARD_ITEM::SwapItemData(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and PCB_GROUP::WithinScope().

◆ GetPath()

const KIID_PATH & FOOTPRINT::GetPath ( ) const

inline

Definition at line 224 of file footprint.h.

224{ return m_path; }

References m_path.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), BOARD_EDITOR_CONTROL::ExportNetlist(), PCB_PLUGIN::format(), PCB_SELECTION_TOOL::selectSameSheet(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetPosition()

VECTOR2I FOOTPRINT::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 188 of file footprint.h.

188{ return m_pos; }

References m_pos.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCAD2KICAD::PCB_PAD::AddToFootprint(), KI_TEST::CheckFootprint(), PNS_KICAD_IFACE::Commit(), EXPORTER_STEP::composePCB(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), PCB_PLUGIN::FootprintSave(), PCB_PLUGIN::format(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromSESSION(), GetBoundingHull(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), AR_AUTOPLACER::getOptimalFPPlacement(), PCB_SHAPE::getParentPosition(), hash_fp_item(), ALTIUM_PCB::HelperShapeSetLocalCoord(), idf_export_footprint(), ROUTER_TOOL::InlineDrag(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FABMASTER::loadFootprints(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), LEGACY_PLUGIN::loadPAD(), DSN::SPECCTRA_DB::makeIMAGE(), EAGLE_PLUGIN::orientFootprintAndText(), EAGLE_PLUGIN::packageHole(), EAGLE_PLUGIN::packageText(), PAD::PAD(), ALTIUM_PCB::ParseComponentsBodies6Data(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BRDITEMS_PLOTTER::PlotFootprintShape(), RENDER_3D_OPENGL::renderFootprint(), CLIPBOARD_IO::SaveSelection(), DRAWING_TOOL::SetAnchor(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SetLayerAndFlip(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), SetOrientation(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), EAGLE_PLUGIN::transferPad(), and zonesNeedUpdate().

◆ GetPrivateLayers()

LSET FOOTPRINT::GetPrivateLayers ( ) const

inline

Definition at line 120 of file footprint.h.

120{ return m_privateLayers; }

References m_privateLayers.

Referenced by KIGFX::PCB_PAINTER::Draw(), PCB_PLUGIN::format(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), and TransformFPShapesToPolySet().

◆ GetProperties()

const std::map< wxString, wxString > & FOOTPRINT::GetProperties ( ) const

inline

Definition at line 574 of file footprint.h.

574{ return m_properties; }

References m_properties.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), PCB_PLUGIN::format(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetProperty()

const wxString & FOOTPRINT::GetProperty ( const wxString & aKey )

inline

Definition at line 576 of file footprint.h.

576{ return m_properties[ aKey ]; }

References m_properties.

Referenced by getFieldFunc().

◆ GetReference()

const wxString & FOOTPRINT::GetReference ( void ) const

inline

Returns: reference designator text.

Definition at line 519 of file footprint.h.

 {
 return m_reference->GetText();
 }

References EDA_TEXT::GetText(), and m_reference.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AR_AUTOPLACER::AutoplaceFootprints(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), KI_TEST::CheckFootprint(), collectItemsForSyncParts(), CollisionMatchesExpected(), compareFootprintsbyRef(), EXPORTER_STEP::composePCB(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), EDIT_TOOL::doMoveSelection(), BOARD_EDITOR_CONTROL::ExportNetlist(), FormatProbeItem(), GetItemDescription(), GetLocalClearance(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), CADSTAR_PCB_ARCHIVE_LOADER::getPadReference(), GetReferenceAsString(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), getShapeName(), IncrementReference(), GENERAL_COLLECTOR::Inspect(), InvalidMatchesExpected(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), EAGLE_PLUGIN::loadElements(), CADSTAR_PCB_ARCHIVE_LOADER::loadNets(), EDA_3D_CANVAS::OnMouseMove(), EAGLE_PLUGIN::packageText(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPad(), DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), BOARD_NETLIST_UPDATER::replaceFootprint(), CLIPBOARD_IO::SaveSelection(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetReferenceAsString()

wxString FOOTPRINT::GetReferenceAsString ( ) const

inline

Definition at line 534 of file footprint.h.

 {
 return GetReference();
 }

References GetReference().

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 265 of file eda_item.h.

265{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 123 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

136{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 82 of file board_item.cpp.

{
 wxCHECK( false, STROKE_PARAMS( pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ) ) );
}

References DEFAULT_LINE_WIDTH, EDA_IU_SCALE::mmToIU(), and pcbIUScale.

Referenced by CONVERT_TOOL::CreatePolys(), and PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

Return a translated description of the type for this EDA_ITEM for display in user facing messages.

Definition at line 301 of file eda_item.cpp.

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

References ENUM_MAP< T >::Instance(), and EDA_ITEM::Type().

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::doMoveSelection(), and EDA_ITEM::GetFriendlyName().

◆ GetTypeName()

wxString FOOTPRINT::GetTypeName ( ) const

Get the type of footprint.

Returns: "SMD"/"Through hole"/"Other" based on attributes

Definition at line 769 of file footprint.cpp.

{
 if( ( m_attributes & FP_SMD ) == FP_SMD )
 return _( "SMD" );
 
 if( ( m_attributes & FP_THROUGH_HOLE ) == FP_THROUGH_HOLE )
 return _( "Through hole" );
 
 return _( "Other" );
}

References _, FP_SMD, FP_THROUGH_HOLE, and m_attributes.

Referenced by KI_TEST::CheckFootprint(), and CheckFootprintAttributes().

◆ GetUniquePadCount()

unsigned FOOTPRINT::GetUniquePadCount ( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const

Return the number of unique non-blank 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.

Parameters

aIncludeNPTH includes non-plated through holes when true. Does not include non-plated through holes when false.

Returns: the number of unique pads according to aIncludeNPTH.

Definition at line 1229 of file footprint.cpp.

{
 std::set<wxString> usedNumbers;
 
 // Create a set of used pad numbers
 for( PAD* pad : m_pads )
 {
 // Skip pads not on copper layers (used to build complex
 // solder paste shapes for instance)
 if( ( pad->GetLayerSet() & LSET::AllCuMask() ).none() )
 continue;
 
 // Skip pads with no name, because they are usually "mechanical"
 // pads, not "electrical" pads
 if( pad->GetNumber().IsEmpty() )
 continue;
 
 if( !aIncludeNPTH )
 {
 // skip NPTH
 if( pad->GetAttribute() == PAD_ATTRIB::NPTH )
 continue;
 }
 
 usedNumbers.insert( pad->GetNumber() );
 }
 
 return usedNumbers.size();
}

References LSET::AllCuMask(), m_pads, NPTH, and pad.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), and FOOTPRINT_INFO_IMPL::load().

◆ GetValue()

const wxString & FOOTPRINT::GetValue ( ) const

inline

◆ GetValueAsString()

wxString FOOTPRINT::GetValueAsString ( ) const

inline

Definition at line 561 of file footprint.h.

 {
 return GetValue();
 }

References GetValue().

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 76 of file board_item.h.

 {
 VECTOR2I p = GetPosition();
 return p.x;
 }

References EDA_ITEM::GetPosition(), and VECTOR2< T >::x.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), BOARD_ITEM::SetY(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 82 of file board_item.h.

 {
 VECTOR2I p = GetPosition();
 return p.y;
 }

References EDA_ITEM::GetPosition(), and VECTOR2< T >::y.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), BOARD_ITEM::SetX(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ GetZoneConnection()

ZONE_CONNECTION FOOTPRINT::GetZoneConnection ( ) const

inline

Definition at line 248 of file footprint.h.

248{ return m_zoneConnection; }

References m_zoneConnection.

Referenced by DRC_ENGINE::EvalRules(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_PLUGIN::format(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow().

◆ GetZoneSettings()

virtual const ZONE_SETTINGS & BOARD_ITEM_CONTAINER::GetZoneSettings ( ) const

inlinevirtualinherited

Fetch the zone settings for this container.

Reimplemented in BOARD.

Definition at line 86 of file board_item_container.h.

 {
 return m_zoneSettings;
 }

References BOARD_ITEM_CONTAINER::m_zoneSettings.

Referenced by ZONE::ZONE().

◆ GraphicalItems() [1/2]

DRAWINGS & FOOTPRINT::GraphicalItems ( )

inline

Definition at line 173 of file footprint.h.

173{ return m_drawings; }

References m_drawings.

Referenced by BOARD_ADAPTER::addFootprintShapes(), BuildCourtyardCaches(), KI_TEST::CheckFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), FOOTPRINT(), FootprintNeedsUpdate(), FootprintWriteShape(), PCB_PLUGIN::format(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), GetEffectiveShape(), hash_fp_item(), hashFootprint(), ROUTER_TOOL::InlineDrag(), MoveAnchorPosition(), operator=(), pasteFootprintItemsToFootprintEditor(), PCB_CONTROL::placeBoardItems(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), PCB_CONTROL::pruneItemLayers(), PAD_TOOL::RecombinePad(), BOARD_EDITOR_CONTROL::RepairBoard(), FOOTPRINT_EDITOR_CONTROL::RepairFootprint(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), PCB_SELECTION_TOOL::Selectable(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolySet(), and TransformFPShapesToPolySet().

◆ GraphicalItems() [2/2]

const DRAWINGS & FOOTPRINT::GraphicalItems ( ) const

inline

Definition at line 174 of file footprint.h.

174{ return m_drawings; }

References m_drawings.

◆ Groups() [1/2]

FP_GROUPS & FOOTPRINT::Groups ( )

inline

Definition at line 179 of file footprint.h.

179{ return m_fp_groups; }

References m_fp_groups.

Referenced by KI_TEST::CheckFootprint(), FOOTPRINT(), PCB_PLUGIN::format(), operator=(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::RepairBoard(), and FOOTPRINT_EDITOR_CONTROL::RepairFootprint().

◆ Groups() [2/2]

const FP_GROUPS & FOOTPRINT::Groups ( ) const

inline

Definition at line 180 of file footprint.h.

180{ return m_fp_groups; }

References m_fp_groups.

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 143 of file eda_item.h.

143{ return ( m_flags & aFlag ) == aFlag; }

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), IsConflicting(), ZONE::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and EE_SELECTION_TOOL::selectMultiple().

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 128 of file board_item.h.

 {
 return false;
 }

Referenced by DRAWING_TOOL::DrawVia(), hasDrilledHole(), DRC_RTREE::Insert(), BOARD_INSPECTION_TOOL::InspectClearance(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and PCB_CONTROL::UpdateMessagePanel().

◆ HasLineStroke()

virtual bool BOARD_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this item has line stoke properties.

See also: STROKE_PARAMS

Reimplemented in PCB_SHAPE.

Definition at line 172 of file board_item.h.

172{ return false; }

◆ HasProperty()

bool FOOTPRINT::HasProperty ( const wxString & aKey )

inline

Definition at line 577 of file footprint.h.

 {
 return m_properties.find( aKey ) != m_properties.end();
 }

References m_properties.

Referenced by getFieldFunc().

◆ HasThroughHolePads()

bool FOOTPRINT::HasThroughHolePads ( ) const

Definition at line 2650 of file footprint.cpp.

{
 for( PAD* pad : Pads() )
 {
 if( pad->GetAttribute() != PAD_ATTRIB::SMD )
 return true;
 }
 
 return false;
}

References pad, Pads(), and SMD.

◆ HitTest() [1/2]

bool FOOTPRINT::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

overridevirtual

Test if aRect intersects this item.

Parameters

aRect	A reference to a BOX2I object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1122 of file footprint.cpp.

{
 BOX2I arect = aRect;
 arect.Inflate( aAccuracy );
 
 if( aContained )
 {
 return arect.Contains( GetBoundingBox( false, false ) );
 }
 else
 {
 // If the rect does not intersect the bounding box, skip any tests
 if( !aRect.Intersects( GetBoundingBox( false, false ) ) )
 return false;
 
 // The empty footprint dummy rectangle intersects the selection area.
 if( m_pads.empty() && m_fp_zones.empty() && m_drawings.empty() )
 return GetBoundingBox( true, false ).Intersects( arect );
 
 // Determine if any elements in the FOOTPRINT intersect the rect
 for( PAD* pad : m_pads )
 {
 if( pad->HitTest( arect, false, 0 ) )
 return true;
 }
 
 for( FP_ZONE* zone : m_fp_zones )
 {
 if( zone->HitTest( arect, false, 0 ) )
 return true;
 }
 
 for( BOARD_ITEM* item : m_drawings )
 {
 // Text items are selectable on their own, and are therefore excluded from this
 // test. TextBox items are NOT selectable on their own, and so MUST be included
 // here. Bitmaps aren't selectable since they aren't displayed.
 if( item->Type() != PCB_FP_TEXT_T && item->Type() != PCB_FP_TEXT_T
 && item->HitTest( arect, false, 0 ) )
 {
 return true;
 }
 }
 
 // Groups are not hit-tested; only their members
 
 // No items were hit
 return false;
 }
}

References BOX2< Vec >::Contains(), GetBoundingBox(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), m_drawings, m_fp_zones, m_pads, pad, and PCB_FP_TEXT_T.

◆ HitTest() [2/2]

bool FOOTPRINT::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy = `0`
	)		const

overridevirtual

Test if aPosition is inside or on the boundary of this item.

Parameters

aPosition	A reference to a VECTOR2I object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns: True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1109 of file footprint.cpp.

{
 BOX2I rect = GetBoundingBox( false, false );
 return rect.Inflate( aAccuracy ).Contains( aPosition );
}

References BOX2< Vec >::Contains(), GetBoundingBox(), and BOX2< Vec >::Inflate().

Referenced by GENERAL_COLLECTOR::Inspect().

◆ HitTestAccurate()

bool FOOTPRINT::HitTestAccurate	(	const VECTOR2I &	aPosition,
		int	aAccuracy = `0`
	)		const

Test 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.

Parameters

aPosition is the point to test

Returns: true if aPosition is inside the bounding polygon

Definition at line 1116 of file footprint.cpp.

{
 return GetBoundingHull().Collide( aPosition, aAccuracy );
}

References SHAPE_POLY_SET::Collide(), and GetBoundingHull().

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IncrementFlag()

void FOOTPRINT::IncrementFlag ( )

inline

Definition at line 254 of file footprint.h.

254{ m_arflag += 1; }

References m_arflag.

◆ IncrementReference()

void FOOTPRINT::IncrementReference ( int aDelta )

Bump the current reference by aDelta.

Definition at line 2001 of file footprint.cpp.

{
 const wxString& refdes = GetReference();
 
 SetReference( wxString::Format( wxT( "%s%i" ),
 UTIL::GetRefDesPrefix( refdes ),
 GetTrailingInt( refdes ) + aDelta ) );
}

References Format(), UTIL::GetRefDesPrefix(), GetReference(), GetTrailingInt(), and SetReference().

◆ IsBoardOnly()

bool FOOTPRINT::IsBoardOnly ( ) const

inline

Definition at line 583 of file footprint.h.

583{ return m_attributes & FP_BOARD_ONLY; }

References FP_BOARD_ONLY, and m_attributes.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ IsConflicting()

bool FOOTPRINT::IsConflicting ( ) const

Returns: true if the footprint is flagged with conflicting with some item

Definition at line 474 of file footprint.cpp.

{
 return HasFlag( COURTYARD_CONFLICT );
}

References COURTYARD_CONFLICT, and EDA_ITEM::HasFlag().

Referenced by ViewGetLayers(), and ViewGetLOD().

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

Returns: True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Reimplemented in BOARD_CONNECTED_ITEM, and ZONE.

Definition at line 115 of file board_item.h.

 {
 return false;
 }

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), DRC_ENGINE::EvalRules(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), inDiffPairFunc(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), and DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ IsExcludedFromBOM()

bool FOOTPRINT::IsExcludedFromBOM ( ) const

inline

Definition at line 601 of file footprint.h.

601{ return m_attributes & FP_EXCLUDE_FROM_BOM; }

References FP_EXCLUDE_FROM_BOM, and m_attributes.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ IsExcludedFromPosFiles()

bool FOOTPRINT::IsExcludedFromPosFiles ( ) const

inline

Definition at line 592 of file footprint.h.

592{ return m_attributes & FP_EXCLUDE_FROM_POS_FILES; }

References FP_EXCLUDE_FROM_POS_FILES, and m_attributes.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ IsFlipped()

bool FOOTPRINT::IsFlipped ( ) const

inline

Returns: true if the footprint is flipped, i.e. on the back side of the board

Definition at line 324 of file footprint.h.

324{ return GetLayer() == B_Cu; }

References B_Cu, and GetLayer().

Referenced by PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), FootprintNeedsUpdate(), GetMsgPanelInfo(), DIALOG_PAD_PROPERTIES::initValues(), ALTIUM_PCB::ParseComponentsBodies6Data(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PCB_CONTROL::pruneItemLayers(), RENDER_3D_OPENGL::renderFootprint(), and PCB_SELECTION_TOOL::Selectable().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 201 of file eda_item.h.

201{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:497

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Definition at line 250 of file board_item.h.

250{ return m_isKnockout; }

BOARD_ITEM::m_isKnockout

bool m_isKnockout

Definition: board_item.h:330

References BOARD_ITEM::m_isKnockout.

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), PCB_TEXT::GetBoundingBox(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), PCB_TEXT_DESC::PCB_TEXT_DESC(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotPcbGraphicItem(), PNS_KICAD_IFACE_BASE::syncTextItem(), and PCB_TEXT::TextHitTest().

◆ IsLibNameValid()

bool FOOTPRINT::IsLibNameValid ( const wxString & aName )

static

Test for validity of a name of a footprint to be used in a footprint library ( no spaces, dir separators ... ).

Parameters

aName is the name in library to validate.

Returns: true if the given name is valid

Definition at line 1516 of file footprint.cpp.

{
 const wxChar * invalids = StringLibNameInvalidChars( false );
 
 if( aName.find_first_of( invalids ) != std::string::npos )
 return false;
 
 return true;
}

References StringLibNameInvalidChars().

Referenced by DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::checkFootprintName().

◆ IsLocked()

bool FOOTPRINT::IsLocked ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 340 of file footprint.h.

 {
 return ( m_fpStatus & FP_is_LOCKED ) != 0;
 }

References FP_is_LOCKED, and m_fpStatus.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), PCB_PLUGIN::format(), GetMsgPanelInfo(), itemIsIncludedByFilter(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and ViewGetLayers().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

◆ IsNetTie()

bool FOOTPRINT::IsNetTie ( ) const

inline

Definition at line 257 of file footprint.h.

 {
 for( const wxString& group : m_netTiePadGroups )
 {
 if( !group.IsEmpty() )
 return true;
 }
 
 return false;
 }

References group, and m_netTiePadGroups.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), PCB_PLUGIN::format(), DRC_ENGINE::IsNetTieExclusion(), DIALOG_FOOTPRINT_CHECKER::runChecks(), and PAD::SharesNetTieGroup().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

Returns: true if the object is on any copper layer, false otherwise.

Reimplemented in PAD, PCB_TRACK, and ZONE.

Definition at line 123 of file board_item.h.

 {
 return IsCopperLayer( GetLayer() );
 }

References BOARD_ITEM::GetLayer(), and IsCopperLayer().

Referenced by CN_CONNECTIVITY_ALGO::Add(), CheckNetTies(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_CONNECTED_ITEM::SetNetCode(), and PCB_CONTROL::UpdateMessagePanel().

◆ IsOnLayer()

bool FOOTPRINT::IsOnLayer ( PCB_LAYER_ID aLayer ) const

overridevirtual

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.

Reimplemented from BOARD_ITEM.

Definition at line 1086 of file footprint.cpp.

{
 // If we have any pads, fall back on normal checking
 if( !m_pads.empty() )
 return m_layer == aLayer;
 
 // No pads? Check if this entire footprint exists on the given layer
 for( FP_ZONE* zone : m_fp_zones )
 {
 if( !zone->IsOnLayer( aLayer ) )
 return false;
 }
 
 for( BOARD_ITEM* item : m_drawings )
 {
 if( !item->IsOnLayer( aLayer ) )
 return false;
 }
 
 return true;
}

References m_drawings, m_fp_zones, BOARD_ITEM::m_layer, and m_pads.

◆ IsPlaced()

bool FOOTPRINT::IsPlaced ( ) const

inline

Definition at line 363 of file footprint.h.

363{ return m_fpStatus & FP_is_PLACED; }

References FP_is_PLACED, and m_fpStatus.

Referenced by PCB_PLUGIN::format().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

Override this method in any derived object that supports test find and replace.

Returns: True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented in LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 420 of file eda_item.h.

420{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 173 of file eda_item.h.

173{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:54

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( ) const

inlinevirtualinherited

Reimplemented in PCB_VIA.

Definition at line 133 of file board_item.h.

 {
 return false;
 }

Referenced by BOARD_INSPECTION_TOOL::InspectClearance(), and DRC_TEST_PROVIDER_SILK_CLEARANCE::Run().

◆ IsType()

virtual bool EDA_ITEM::IsType ( const std::vector< KICAD_T > & aScanTypes ) const

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented in SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 181 of file eda_item.h.

 {
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
 return true;
 }
 
 return false;
 }

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_FIELD::GetName(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::GetShownText(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_ITEM::IsType(), FP_TEXT::IsType(), FP_TEXTBOX::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ IterateForward() [1/2]

template<class T >

static INSPECT_RESULT EDA_ITEM::IterateForward	(	std::deque< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

inlinestaticinherited

This changes first parameter to avoid the DList and use the main queue instead.

Definition at line 302 of file eda_item.h.

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

static INSPECT_RESULT EDA_ITEM::IterateForward	(	std::vector< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

inlinestaticinherited

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 322 of file eda_item.h.

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

Return a string (to be shown to the user) describing a layer mask.

Reimplemented in PCB_VIA.

Definition at line 106 of file board_item.cpp.

{
 const BOARD* board = GetBoard();
 LSET layers = GetLayerSet();
 
 // Try to be smart and useful. Check all copper first.
 if( layers[F_Cu] && layers[B_Cu] )
 return _( "all copper layers" );
 
 LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
 LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
 
 for( LSET testLayers : { copperLayers, techLayers, layers } )
 {
 for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
 {
 if( testLayers[ bit ] )
 {
 wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
 
 if( testLayers.count() > 1 )
 layerInfo << wxS( " " ) + _( "and others" );
 
 return layerInfo;
 }
 }
 }
 
 // No copper, no technicals: no layer
 return _( "no layers" );
}

References _, LSET::AllCuMask(), LSET::AllTechMask(), B_Cu, F_Cu, BOARD_ITEM::GetBoard(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD_ITEM::GetLayerSet(), PCB_LAYER_ID_COUNT, and PCBNEW_LAYER_ID_START.

Referenced by PAD::GetItemDescription(), PAD::GetMsgPanelInfo(), and PCB_TRACK::GetMsgPanelInfo().

◆ LegacyPadsLocked()

bool FOOTPRINT::LegacyPadsLocked ( ) const

inline

Definition at line 381 of file footprint.h.

381{ return m_fpStatus & FP_PADS_are_LOCKED; }

References FP_PADS_are_LOCKED, and m_fpStatus.

◆ MapPadNumbersToNetTieGroups()

std::map< wxString, int > FOOTPRINT::MapPadNumbersToNetTieGroups ( ) const

Returns: a map from pad numbers to net-tie group indices. If a pad is not a member of a net-tie group its index will be -1.

Definition at line 2284 of file footprint.cpp.

{
 std::map<wxString, int> padNumberToGroupIdxMap;
 
 for( const PAD* pad : m_pads )
 padNumberToGroupIdxMap[ pad->GetNumber() ] = -1;
 
 auto processPad =
 [&]( wxString aPad, int aGroup )
 {
 aPad.Trim( true ).Trim( false );
 
 if( !aPad.IsEmpty() )
 padNumberToGroupIdxMap[ aPad ] = aGroup;
 };
 
 for( int ii = 0; ii < (int) m_netTiePadGroups.size(); ++ii )
 {
 wxString group( m_netTiePadGroups[ ii ] );
 bool esc = false;
 wxString pad;
 
 for( wxUniCharRef ch : group )
 {
 if( esc )
 {
 esc = false;
 pad.Append( ch );
 continue;
 }
 
 switch( static_cast<unsigned char>( ch ) )
 {
 case '\\':
 esc = true;
 break;
 
 case ',':
 processPad( pad, ii );
 pad.Clear();
 break;
 
 default:
 pad.Append( ch );
 break;
 }
 }
 
 processPad( pad, ii );
 }
 
 return padNumberToGroupIdxMap;
}

References group, m_netTiePadGroups, m_pads, and pad.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), CheckNetTiePadGroups(), CheckNetTies(), GetNetTiePads(), DRC_ENGINE::IsNetTieExclusion(), GRAPHICS_CLEANER::mergePads(), PAD::SharesNetTieGroup(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ Matches() [1/2]

virtual bool EDA_ITEM::Matches	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData
	)		const

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns: True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_MARKER, LIB_TEXTBOX, SCH_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 382 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_FIND_REPLACE_TOOL::HasMatch(), SCH_MARKER::Matches(), LIB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_LABEL_BASE::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), FP_TEXT::Matches(), FP_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ Matches() [2/2]

bool EDA_ITEM::Matches	(	const wxString &	aText,
		const EDA_SEARCH_DATA &	aSearchData
	)		const

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 117 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 return false;
 
 ii = next;
 next += searchText.length();
 
 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
 if( startOK && endOK )
 return true;
 else
 ii++;
 }
 
 return false;
 }
 else if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ Models() [1/2]

std::vector< FP_3DMODEL > & FOOTPRINT::Models ( )

inline

Definition at line 184 of file footprint.h.

184{ return m_3D_Drawings; }

References m_3D_Drawings.

Referenced by KI_TEST::CheckFootprint(), EXPORTER_STEP::composePCB(), PCB_EDIT_FRAME::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), FootprintNeedsUpdate(), PCB_PLUGIN::format(), idf_export_footprint(), LEGACY_PLUGIN::load3D(), MoveAnchorPosition(), ALTIUM_PCB::ParseComponentsBodies6Data(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), RENDER_3D_OPENGL::renderFootprint(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), and PANEL_PREVIEW_3D_MODEL::UpdateDummyFootprint().

◆ Models() [2/2]

const std::vector< FP_3DMODEL > & FOOTPRINT::Models ( ) const

inline

Definition at line 185 of file footprint.h.

185{ return m_3D_Drawings; }

References m_3D_Drawings.

◆ Move()

void FOOTPRINT::Move ( const VECTOR2I & aMoveVector )

overridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 1544 of file footprint.cpp.

{
 VECTOR2I newpos = m_pos + aMoveVector;
 SetPosition( newpos );
}

References m_pos, and SetPosition().

Referenced by ROUTER_TOOL::InlineDrag(), CLIPBOARD_IO::SaveSelection(), and SpreadFootprints().

◆ MoveAnchorPosition()

void FOOTPRINT::MoveAnchorPosition ( const VECTOR2I & aMoveVector )

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)

Definition at line 1728 of file footprint.cpp.

{
 /*
 * Move the reference point of the footprint
 * the footprints elements (pads, outlines, edges .. ) are moved
 * but:
 * - the footprint position is not modified.
 * - the relative (local) coordinates of these items are modified
 * - Draw coordinates are updated
 */
 
 // Update (move) the relative coordinates relative to the new anchor point.
 VECTOR2I moveVector = aMoveVector;
 RotatePoint( moveVector, -GetOrientation() );
 
 // Update of the reference and value.
 m_reference->SetPos0( m_reference->GetPos0() + moveVector );
 m_reference->SetDrawCoord();
 m_value->SetPos0( m_value->GetPos0() + moveVector );
 m_value->SetDrawCoord();
 
 // Update the pad local coordinates.
 for( PAD* pad : m_pads )
 {
 pad->SetPos0( pad->GetPos0() + moveVector );
 pad->SetDrawCoord();
 }
 
 // Update the draw element coordinates.
 for( BOARD_ITEM* item : GraphicalItems() )
 {
 switch( item->Type() )
 {
 case PCB_FP_SHAPE_T:
 case PCB_FP_TEXTBOX_T:
 {
 FP_SHAPE* shape = static_cast<FP_SHAPE*>( item );
 shape->Move( moveVector );
 break;
 }
 
 case PCB_FP_TEXT_T:
 {
 FP_TEXT* text = static_cast<FP_TEXT*>( item );
 text->SetPos0( text->GetPos0() + moveVector );
 text->SetDrawCoord();
 break;
 }
 
 default:
 break;
 }
 }
 
 // Update the keepout zones
 for( ZONE* zone : Zones() )
 {
 zone->Move( moveVector );
 }
 
 // Update the 3D models
 for( FP_3DMODEL& model : Models() )
 {
 model.m_Offset.x += pcbIUScale.IUTomm( moveVector.x );
 model.m_Offset.y -= pcbIUScale.IUTomm( moveVector.y );
 }
 
 m_cachedBoundingBox.Move( moveVector );
 m_cachedVisibleBBox.Move( moveVector );
 m_cachedTextExcludedBBox.Move( moveVector );
 m_cachedHull.Move( moveVector );
}

References GetOrientation(), FP_TEXT::GetPos0(), GraphicalItems(), EDA_IU_SCALE::IUTomm(), m_cachedBoundingBox, m_cachedHull, m_cachedTextExcludedBBox, m_cachedVisibleBBox, m_pads, m_reference, m_value, Models(), BOX2< Vec >::Move(), FP_SHAPE::Move(), SHAPE_POLY_SET::Move(), pad, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_TEXTBOX_T, pcbIUScale, RotatePoint(), FP_TEXT::SetDrawCoord(), FP_TEXT::SetPos0(), text, VECTOR2< T >::x, VECTOR2< T >::y, and Zones().

Referenced by CLIPBOARD_IO::SaveSelection(), and DRAWING_TOOL::SetAnchor().

◆ NeedsPlaced()

bool FOOTPRINT::NeedsPlaced ( ) const

inline

Definition at line 372 of file footprint.h.

372{ return m_fpStatus & FP_to_PLACE; }

FP_to_PLACE

#define FP_to_PLACE

In autoplace: footprint waiting for autoplace.

Definition: footprint.h:336

References FP_to_PLACE, and m_fpStatus.

Referenced by AR_AUTOPLACER::pickFootprint().

◆ operator<()

bool EDA_ITEM::operator< ( const EDA_ITEM & aItem ) const

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

Returns: - True if aItem is less than the item.

Definition at line 231 of file eda_item.cpp.

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
  GetClass() ) );
 
 return false;
}

References Format(), and EDA_ITEM::GetClass().

◆ operator=() [1/2]

FOOTPRINT & FOOTPRINT::operator= ( const FOOTPRINT & aOther )

Definition at line 373 of file footprint.cpp.

{
 BOARD_ITEM::operator=( aOther );
 
 m_pos = aOther.m_pos;
 m_fpid = aOther.m_fpid;
 m_attributes = aOther.m_attributes;
 m_fpStatus = aOther.m_fpStatus;
 m_orient = aOther.m_orient;
 m_lastEditTime = aOther.m_lastEditTime;
 m_link = aOther.m_link;
 m_path = aOther.m_path;
 
 m_cachedBoundingBox = aOther.m_cachedBoundingBox;
 m_boundingBoxCacheTimeStamp = aOther.m_boundingBoxCacheTimeStamp;
 m_cachedVisibleBBox = aOther.m_cachedVisibleBBox;
 m_visibleBBoxCacheTimeStamp = aOther.m_visibleBBoxCacheTimeStamp;
 m_cachedTextExcludedBBox = aOther.m_cachedTextExcludedBBox;
 m_textExcludedBBoxCacheTimeStamp = aOther.m_textExcludedBBoxCacheTimeStamp;
 m_cachedHull = aOther.m_cachedHull;
 m_hullCacheTimeStamp = aOther.m_hullCacheTimeStamp;
 
 m_localClearance = aOther.m_localClearance;
 m_localSolderMaskMargin = aOther.m_localSolderMaskMargin;
 m_localSolderPasteMargin = aOther.m_localSolderPasteMargin;
 m_localSolderPasteMarginRatio = aOther.m_localSolderPasteMarginRatio;
 m_zoneConnection = aOther.m_zoneConnection;
 m_netTiePadGroups = aOther.m_netTiePadGroups;
 
 // Copy reference and value
 *m_reference = *aOther.m_reference;
 m_reference->SetParent( this );
 *m_value = *aOther.m_value;
 m_value->SetParent( this );
 
 std::map<BOARD_ITEM*, BOARD_ITEM*> ptrMap;
 
 // Copy pads
 m_pads.clear();
 
 for( PAD* pad : aOther.Pads() )
 {
 PAD* newPad = new PAD( *pad );
 ptrMap[ pad ] = newPad;
 Add( newPad );

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FOOTPRINT() [1/3]

◆ FOOTPRINT() [2/3]

◆ FOOTPRINT() [3/3]

◆ ~FOOTPRINT()

Member Function Documentation

◆ Add()

◆ Add3DModel()

◆ AddNetTiePadGroup()

◆ AllowMissingCourtyard()

◆ BuildCourtyardCaches()

◆ CheckFootprintAttributes()

◆ CheckNetTiePadGroups()

◆ CheckNetTies()

◆ CheckPads()

◆ CheckShortingPads()

◆ ClassOf()

◆ ClearAllNets()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearNetTiePadGroups()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ CoverageRatio()

◆ Delete()

◆ DeleteStructure()

◆ Duplicate()

◆ DuplicateItem()

◆ FindPadByNumber()

◆ FixUuids()

◆ Flip()

◆ FootprintNeedsUpdate()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetArea()

◆ GetAttributes()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox() [1/2]

◆ GetBoundingBox() [2/2]

◆ GetBoundingHull()

◆ GetCenter()

◆ GetClass()

◆ GetContextualTextVars()

◆ GetCourtyard()

◆ GetCoverageArea()

◆ GetDescription()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveShape()

◆ GetFileFormatVersionAtLoad()

◆ GetFlag()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFPID()

◆ GetFPIDAsString()

◆ GetFpPadsLocalBbox()

◆ GetFriendlyName()

◆ GetInitialComments()

◆ GetItemDescription()

◆ GetKeywords()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetLikelyAttribute()

◆ GetLink()

◆ GetLocalClearance() [1/2]