#include <footprint.h>

Inheritance diagram for FOOTPRINT:

Classes
struct	cmp_drawings

struct	cmp_pads

struct	cmp_zones

struct	FP_UNIT_INFO

Public Types
enum	COMPARE_FLAGS : int { DRC = 0x01 , INSTANCE_TO_INSTANCE = 0x02 }

enum class	RETURN_CODE : int { OK , FILE_NOT_FOUND , PERMISSIONS_ERROR , FILE_ALREADY_EXISTS , OUT_OF_MEMORY , CHECKSUM_ERROR }

using	FILE_ADDED_CALLBACK = std::function<void( EMBEDDED_FILE* )>

Public Member Functions
	FOOTPRINT (BOARD *parent)

	FOOTPRINT (const FOOTPRINT &aFootprint)

	FOOTPRINT (FOOTPRINT &&aFootprint)

	~FOOTPRINT ()

FOOTPRINT &	operator= (const FOOTPRINT &aOther)

FOOTPRINT &	operator= (FOOTPRINT &&aOther)

void	CopyFrom (const BOARD_ITEM *aOther) override

void	Serialize (google::protobuf::Any &aContainer) const override
	Serializes this object to the given Any message.

bool	Deserialize (const google::protobuf::Any &aContainer) override
	Deserializes the given protobuf message into this object.

void	SerializeDefinition (kiapi::board::types::Footprint *aOutput) const

bool	DeserializeDefinition (const kiapi::board::types::Footprint &aInput)

void	InvalidateGeometryCaches ()
	Resets the caches for this footprint, for example if it was modified via the API.

LSET	GetPrivateLayers () const

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

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

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

void	ClearAllNets ()
	Clear (i.e.

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.

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

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

SHAPE_POLY_SET	GetBoundingHull (PCB_LAYER_ID aLayer) const

bool	TextOnly () const

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

const BOX2I	GetBoundingBox (bool aIncludeText) const

const BOX2I	GetLayerBoundingBox (const LSET &aLayers) const
	Return the bounding box of the footprint on a given set of layers.

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

std::deque< PAD * > &	Pads ()

const std::deque< PAD * > &	Pads () const

DRAWINGS &	GraphicalItems ()

const DRAWINGS &	GraphicalItems () const

ZONES &	Zones ()

const ZONES &	Zones () const

GROUPS &	Groups ()

const GROUPS &	Groups () const

CONSTRAINTS &	Constraints ()

const CONSTRAINTS &	Constraints () const

PCB_POINTS &	Points ()

const PCB_POINTS &	Points () const

bool	HasThroughHolePads () const

std::vector< FP_3DMODEL > &	Models ()

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

bool	HasExtrudedBody () const

const EXTRUDED_3D_BODY *	GetExtrudedBody () const

EXTRUDED_3D_BODY *	GetExtrudedBody ()

EXTRUDED_3D_BODY &	EnsureExtrudedBody ()

void	SetExtrudedBody (std::unique_ptr< EXTRUDED_3D_BODY > aBody)

void	ClearExtrudedBody ()

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.

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

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

const TRANSFORM_TRS &	GetTransform () const

void	SetTransformScale (double aScaleX, double aScaleY)

double	GetScaleX () const

double	GetScaleY () const

void	SetScaleX (double aScaleX)

void	SetScaleY (double aScaleY)

void	RescaleAroundPoint (const VECTOR2I &aCenter, double aSx, double aSy)

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)

LIB_ID	GetLIB_ID () const override

wxString	GetName () const override

wxString	GetLibNickname () const override

wxString	GetDesc () override

int	GetPinCount () override
	The pin count for symbols or the unique pad count for footprints.

std::vector< SEARCH_TERM > &	GetSearchTerms () override

wxString	GetLibDescription () const

void	SetLibDescription (const wxString &aDesc)

wxString	GetKeywords () const

void	SetKeywords (const wxString &aKeywords)

const KIID_PATH &	GetPath () const

void	SetPath (const KIID_PATH &aPath)

bool	IsWithinSchematicSheet (const KIID_PATH &aSheetPath) const
	Test whether this footprint's symbol lives on aSheetPath or any sheet below it.

wxString	GetSheetname () const

void	SetSheetname (const wxString &aSheetname)

wxString	GetSheetfile () const

void	SetSheetfile (const wxString &aSheetfile)

wxString	GetFilters () const

void	SetFilters (const wxString &aFilters)

std::optional< int >	GetLocalClearance () const

void	SetLocalClearance (std::optional< int > aClearance)

std::optional< int >	GetLocalSolderMaskMargin () const

void	SetLocalSolderMaskMargin (std::optional< int > aMargin)

std::optional< int >	GetLocalSolderPasteMargin () const

void	SetLocalSolderPasteMargin (std::optional< int > aMargin)

std::optional< double >	GetLocalSolderPasteMarginRatio () const

void	SetLocalSolderPasteMarginRatio (std::optional< double > aRatio)

void	SetLocalZoneConnection (ZONE_CONNECTION aType)

ZONE_CONNECTION	GetLocalZoneConnection () const

void	SetStackupMode (FOOTPRINT_STACKUP aMode)
	Set the stackup mode for this footprint.

FOOTPRINT_STACKUP	GetStackupMode () const

void	SetStackupLayers (LSET aLayers)
	If the footprint has a non-default stackup, set the layers that should be used for the stackup.

const LSET &	GetStackupLayers () const

int	GetAttributes () const

void	SetAttributes (int aAttributes)

FOOTPRINT_TYPE	GetFootprintType () const

void	SetFootprintType (FOOTPRINT_TYPE aFootprintType)

bool	AllowMissingCourtyard () const

void	SetAllowMissingCourtyard (bool aAllow)

bool	AllowSolderMaskBridges () const

void	SetAllowSolderMaskBridges (bool aAllow)

void	SetFlag (int aFlag)

void	IncrementFlag ()

int	GetFlag () const

bool	IsNetTie () const

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

std::optional< int >	GetClearanceOverrides (wxString *aSource) const
	Return any local clearance overrides set in the "classic" (ie: pre-rule) system.

ZONE_CONNECTION	GetZoneConnectionOverrides (wxString *aSource) 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)

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

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

void	Flip (const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
	Flip this object, i.e.

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

bool	IsFlipped () const

PCB_LAYER_ID	GetSide () const
	Use instead of IsFlipped() when you also need to account for unsided footprints (those purely on user-layers, etc.).

bool	IsOnLayer (PCB_LAYER_ID aLayer) const override
	Test to see if this object is on the given layer.

bool	IsLocked () const override

bool	IsLayerAgnostic () const override
	Check if this item's layer set must not be confined to a board's enabled layers.

bool	FitsEnabledLayers (const LSET &aEnabledLayers, int aCopperLayerCount) const override
	Check if a board offering aEnabledLayers can hold this item.

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

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.

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

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

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.

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

void	CheckClippedSilk (const std::function< void(BOARD_ITEM aItemA, BOARD_ITEM aItemB, const VECTOR2I &aPt)> &aErrorHandler)

void	BuildNetTieCache ()
	Cache the pads that are allowed to connect to each other in the footprint.

const std::set< int > &	GetNetTieCache (const BOARD_ITEM *aItem) const
	Get the set of net codes that are allowed to connect to a footprint item.

void	TransformPadsToPolySet (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc) const
	Generate pads shapes on layer aLayer as polygons and adds these polygons to aBuffer.

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.

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.

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

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

bool	ResolveTextVar (wxString *token, const wxString &aVariantName, int aDepth=0) const

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.

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

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

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

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

bool	HitTest (const SHAPE_LINE_CHAIN &aPoly, bool aContained) const override
	Test if aPoly intersects this item.

bool	HitTestOnLayer (const VECTOR2I &aPosition, PCB_LAYER_ID aLayer, int aAccuracy=0) const
	Test if the point hits one or more of the footprint elements on a given layer.

bool	HitTestOnLayer (const BOX2I &aRect, bool aContained, PCB_LAYER_ID aLayer, int aAccuracy=0) const

const wxString &	GetReference () const

void	SetReference (const wxString &aReference)

wxString	GetReferenceAsString () const

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

bool	IsAnnotated () const

const wxString &	GetValue () const

void	SetValue (const wxString &aValue)

wxString	GetValueAsString () const

PCB_FIELD &	Value ()
	read/write accessors:

PCB_FIELD &	Reference ()

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

const PCB_FIELD &	Reference () const

PCB_FIELD *	GetField (FIELD_T aFieldType)
	Return a mandatory field in this footprint.

const PCB_FIELD *	GetField (FIELD_T aFieldNdx) const

PCB_FIELD *	GetField (const wxString &aFieldName) const
	Return a field in this symbol.

bool	HasField (const wxString &aFieldName) const

void	GetFields (std::vector< PCB_FIELD * > &aVector, bool aVisibleOnly) const
	Populate a std::vector with PCB_TEXTs.

const std::deque< PCB_FIELD * > &	GetFields () const
	Return a reference to the deque holding the footprint's fields.

std::deque< PCB_FIELD * > &	GetFields ()

void	UpdateFields (const std::vector< PCB_FIELD > &aFields, std::vector< PCB_FIELD * > &aAdded, std::vector< PCB_FIELD * > &aDetached)
	Replace the fields with aFields, reusing the existing mandatory field objects.

int	GetNextFieldOrdinal () const
	Return the next ordinal for a user field for this footprint.

void	ApplyDefaultSettings (const BOARD &board, bool aStyleFields, bool aStyleText, bool aStyleShapes, bool aStyleDimensions, bool aStyleBarcodes)
	Apply default board settings to the footprint field text properties.

void	SetUnitInfo (const std::vector< FP_UNIT_INFO > &aUnits)

const std::vector< FP_UNIT_INFO > &	GetUnitInfo () const

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	IsExcludedFromSim () const

void	SetExcludedFromSim (bool aExclude=true)

bool	IsDNP () const

void	SetDNP (bool aDNP=true)

const FOOTPRINT_VARIANT *	GetVariant (const wxString &aVariantName) const
	Get a variant by name.

FOOTPRINT_VARIANT *	GetVariant (const wxString &aVariantName)
	Get a mutable variant by name.

void	SetVariant (const FOOTPRINT_VARIANT &aVariant)
	Add or update a variant.

FOOTPRINT_VARIANT *	AddVariant (const wxString &aVariantName)
	Add a new variant with the given name.

void	DeleteVariant (const wxString &aVariantName)
	Delete a variant by name.

void	RenameVariant (const wxString &aOldName, const wxString &aNewName)
	Rename a variant.

bool	HasVariant (const wxString &aVariantName) const
	Check if a variant exists.

const CASE_INSENSITIVE_MAP< FOOTPRINT_VARIANT > &	GetVariants () const
	Get all variants.

bool	GetDNPForVariant (const wxString &aVariantName) const
	Get the DNP status for a specific variant.

bool	GetExcludedFromBOMForVariant (const wxString &aVariantName) const
	Get the exclude-from-BOM status for a specific variant.

bool	GetExcludedFromSimForVariant (const wxString &aVariantName) const
	Get the exclude-from-simulation status for a specific variant.

bool	GetExcludedFromPosFilesForVariant (const wxString &aVariantName) const
	Get the exclude-from-position-files status for a specific variant.

wxString	GetFieldValueForVariant (const wxString &aVariantName, const wxString &aFieldName) const
	Get a field value for a specific variant.

void	SetFileFormatVersionAtLoad (int aVersion)

int	GetFileFormatVersionAtLoad () const

std::vector< PROPERTY_BASE * >	GetDynamicProperties () const override
	Return dynamically-computed properties specific to this object instance (e.g.

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

PAD *	FindPadByUuid (const KIID &aUuid) const

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

std::vector< const PAD * >	GetPads (const wxString &aPadNumber, const PAD *aIgnore=nullptr) const

unsigned	GetPadCount () const

std::set< wxString >	GetUniquePadNumbers () const
	A complex pad can be built with many pads having the same pad name to create a complex shape or fragmented solder paste areas.

unsigned	GetNumberedPadCount () const
	Return the number of unique pads whose pad number represents an electrical pin.

wxString	GetNextPadNumber (const wxString &aLastPadName) const

bool	GetDuplicatePadNumbersAreJumpers () const

void	SetDuplicatePadNumbersAreJumpers (bool aEnabled)

std::vector< std::set< wxString > > &	JumperPadGroups ()
	Each jumper pad group is a set of pad numbers that should be treated as internally connected.

const std::vector< std::set< wxString > > &	JumperPadGroups () const

std::optional< const std::set< wxString > >	GetJumperPadGroup (const wxString &aPadNumber) const
	Retrieves the jumper group containing the specified pad number, if one exists.

void	AutoPositionFields ()
	Position Reference and Value fields at the top and bottom of footprint's bounding box.

wxString	GetTypeName () const
	Get the type of footprint.

double	GetArea (int aPadding=0) const

KIID	GetLink () const

void	SetLink (const KIID &aLink)

BOARD_ITEM *	Duplicate (bool addToParentGroup, BOARD_COMMIT *aCommit=nullptr) const override
	Create a copy of this BOARD_ITEM.

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

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

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.

wxString	GetClass () const override
	Return the class name.

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

wxString	DisambiguateItemDescription (UNITS_PROVIDER *aUnitsProvider, bool aFull) const override

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

EDA_ITEM *	Clone () const override
	Invoke a function on all children.

void	RunOnChildren (const std::function< void(BOARD_ITEM *)> &aFunction, RECURSE_MODE aMode) const override
	Invoke a function on all children.

virtual std::vector< int >	ViewGetLayers () const override
	Return the all the layers within the VIEW the object is painted on.

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

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

bool	FootprintNeedsUpdate (const FOOTPRINT aLibFP, int aCompareFlags=0, REPORTER aReporter=nullptr)
	Return true if a board footprint differs from the library version.

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

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.

const wxArrayString *	GetInitialComments () const
	Return the initial comments block or NULL if none, without transfer of ownership.

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

const SHAPE_POLY_SET &	GetCachedCourtyard (PCB_LAYER_ID aLayer) const
	Return the cached courtyard area.

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

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

EMBEDDED_FILES *	GetEmbeddedFiles () override

const EMBEDDED_FILES *	GetEmbeddedFiles () const

std::set< KIFONT::OUTLINE_FONT * >	GetFonts () const override
	Get a list of outline fonts referenced in the footprint.

void	EmbedFonts () override

double	Similarity (const BOARD_ITEM &aOther) const override
	Return a measure of how likely the other object is to represent the same object.

void	SetStaticComponentClass (const COMPONENT_CLASS *aClass) const
	Sets the component class object pointer for this footprint.

const COMPONENT_CLASS *	GetStaticComponentClass () const
	Returns the component class for this footprint.

const COMPONENT_CLASS *	GetComponentClass () const
	Returns the component class for this footprint.

wxString	GetComponentClassAsString () const
	Used for display in the properties panel.

void	RecomputeComponentClass () const
	Forces immediate recalculation of the component class for this footprint.

void	InvalidateComponentClassCache () const
	Forces deferred (on next access) recalculation of the component class for this footprint.

void	SetTransientComponentClassNames (const std::unordered_set< wxString > &classNames)
	Sets the transient component class names.

const std::unordered_set< wxString > &	GetTransientComponentClassNames ()
	Gets the transient component class names.

void	ClearTransientComponentClassNames ()
	Remove the transient component class names.

void	ResolveComponentClassNames (BOARD *aBoard, const std::unordered_set< wxString > &aComponentClassNames)
	Resolves a set of component class names to this footprint's actual component class.

void	FixUpPadsForBoard (BOARD *aBoard)
	Used post-loading of a footprint to adjust the layers on pads to match board inner layers.

bool	operator== (const BOARD_ITEM &aOther) const override

bool	operator== (const FOOTPRINT &aOther) const

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

bool	IsGroupableType () const

int	GetX () const

int	GetY () const

void	SetX (int aX)

void	SetY (int aY)

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

virtual bool	IsOnCopperLayer () const

virtual bool	HasHole () const

virtual bool	HasDrilledHole () const

virtual bool	IsTented (PCB_LAYER_ID aLayer) const
	Checks if the given object is tented (its copper shape is covered by solder mask) on a given side of the board.

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

BOARD_ITEM_CONTAINER *	GetParent () const

FOOTPRINT *	GetParentFootprint () const

void	SetUuidDirect (const KIID &aUuid)
	Raw UUID assignment.

void	ResetUuidDirect ()

void	SetUuid (const KIID &aUuid)

void	ResetUuid ()

virtual void	RemapKIIDs (const std::map< KIID, KIID > &aIdMap)
	Remap KIIDs this item stores to reference other items (e.g.

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

const KIFONT::METRICS &	GetFontMetrics () const

virtual int	BoardLayerCount () const
	Return the total number of layers for the board that this item resides on.

virtual int	BoardCopperLayerCount () const
	Return the total number of copper layers for the board that this item resides on.

virtual LSET	BoardLayerSet () const
	Return the LSET for the board that this item resides on.

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

virtual void	SetLayerSet (const LSET &aLayers)

bool	IsSideSpecific () const

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

bool	IsIndexedInBoard () const

int	GetMaxError () const

virtual void	StyleFromSettings (const BOARD_DESIGN_SETTINGS &settings, bool aCheckSide)

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

virtual void	OnFootprintRescaled (double aRatioX, double aRatioY, double aLinearFactor, const VECTOR2I &aAnchor, const EDA_ANGLE &aParentRotate)
	Apply a parent footprint scale to this item.

virtual void	OnFootprintTransformed ()
	Hook for items inside a footprint to refresh after the FP transform changes (translate, rotate, flip).

virtual void	Mirror (const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection)
	Mirror this object relative to a given horizontal axis the layer is not changed.

virtual void	Normalize ()
	Perform any normalization required after a user rotate and/or flip.

virtual void	NormalizeForCompare ()
	Perform any normalization required to compare 2 graphics, especially if the can be rotated and/or flipped.

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

virtual BOARD *	GetBoard ()

wxString	GetParentAsString () const
	For "parent" property.

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

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.

virtual void	TransformShapeToPolySet (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS *aRenderSettings=nullptr) const
	Convert the item shape to a polyset.

const std::vector< wxString > *	GetEmbeddedFonts () override

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

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParent (EDA_ITEM *aParent)

virtual void	SetParentGroup (EDA_GROUP *aGroup)

virtual EDA_GROUP *	GetParentGroup () const

KIID	GetParentGroupId () const

bool	HasSelectedAncestorGroup () const

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsNetHighlighted () const
	Net highlighting must not clear brightening owned by find or picker tools.

void	SetNetHighlighted (bool aHighlighted)

bool	IsRollover () const

VECTOR2I	GetRolloverPos () const

void	SetIsRollover (bool aIsRollover, const VECTOR2I &aMousePos)

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

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

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

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.

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.

bool	IsForceVisible () const

const std::map< wxString, wxString > &	GetCustomProperties () const
	Custom user-defined string key/value properties attached to this item.

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

void	SetCustomProperty (const wxString &aKey, const wxString &aValue)

bool	HasCustomProperties () const

void	ClearCustomProperties ()

void	RemoveCustomProperty (const wxString &aKey)

std::vector< wxString >	RemoveConflictingCustomProperties ()
	Remove custom properties whose keys collide with an existing field or built-in property name (matched case-insensitively).

bool	GetCustomProperty (const wxString &aKey, wxString &aValue) const

std::vector< PROPERTY_BASE * >	GetCustomPropertiesAsInspectables () 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.

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

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

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.

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

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

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue, bool aNotify=true)

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

bool	Set (PROPERTY_BASE *aProperty, wxVariant aValue, bool aNotify=true)

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

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

void	SetFileAddedCallback (FILE_ADDED_CALLBACK callback)

FILE_ADDED_CALLBACK	GetFileAddedCallback () const

EMBEDDED_FILE *	AddFile (const wxFileName &aName, bool aOverwrite)
	Load a file from disk and adds it to the collection.

EMBEDDED_FILE *	AddFile (EMBEDDED_FILE *aFile)
	Append a file to the collection.

EMBEDDED_FILE *	AddFile (std::shared_ptr< EMBEDDED_FILE > aFile)
	Append a file (already managed by a shared_ptr) to the collection.

void	RemoveFile (const wxString &name, bool aErase=true)
	Remove a file from the collection and frees the memory.

void	AssignSharedFrom (const EMBEDDED_FILES &aSource, const std::set< wxString > &aExcludedNames={})
	Replace this collection's files with references to `aSource's` files, skipping any whose name appears in `aExcludedNames`.

void	WriteEmbeddedFiles (OUTPUTFORMATTER &aOut, bool aWriteData) const
	Output formatter for the embedded files.

wxString	GetEmbeddedFileLink (const EMBEDDED_FILE &aFile) const
	Return the link for an embedded file.

bool	HasFile (const wxString &name) const

bool	IsEmpty () const

virtual void	RunOnNestedEmbeddedFiles (const std::function< void(EMBEDDED_FILES *)> &aFunction)
	Provide access to nested embedded files, such as symbols in schematics and footprints in boards.

const std::vector< wxString > *	UpdateFontFiles ()
	Helper function to get a list of fonts for fontconfig to add to the library.

const std::vector< wxString > *	GetFontFiles () const
	If we just need the cached version of the font files, we can use this function which is const and will not update the font files.

void	ClearEmbeddedFonts ()
	Remove all embedded fonts from the collection.

EMBEDDED_FILE *	GetEmbeddedFile (const wxString &aName) const
	Returns the embedded file with the given name or nullptr if it does not exist.

const std::map< wxString, std::shared_ptr< EMBEDDED_FILE > > &	EmbeddedFileMap () const
	Provide an iterable view of the file collection.

wxFileName	GetTemporaryFileName (const wxString &aName) const

wxFileName	GetTemporaryFileName (EMBEDDED_FILE *aFile) const

void	ClearEmbeddedFiles (bool aDeleteFiles=true)

void	SetAreFontsEmbedded (bool aEmbedFonts)

bool	GetAreFontsEmbedded () const

virtual void	GetChooserFields (std::map< wxString, wxString > &aColumnMap)
	Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc.

virtual bool	IsRoot () const
	For items having aliases, IsRoot() indicates the principal item.

virtual bool	IsPowerSymbol () const
	For symbols that could be a power symbol.

virtual wxString	GetFootprint ()
	For items with footprint fields.

virtual int	GetSubUnitCount () const
	For items with units, return the number of units.

virtual wxString	GetUnitName (int aUnit) const
	For items with units, return an identifier for unit x.

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

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

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

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.

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.

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.

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.

static RETURN_CODE	CompressAndEncode (EMBEDDED_FILE &aFile)
	Take data from the #decompressedData buffer and compresses it using ZSTD into the #compressedEncodedData buffer.

static RETURN_CODE	DecompressAndDecode (EMBEDDED_FILE &aFile, bool aAllowEmptyHash=false)
	Takes data from the #compressedEncodedData buffer and Base64 decodes it.

static RETURN_CODE	ComputeFileHash (const wxFileName &aFileName, std::string &aHash)
	Compute the hash of a file on disk without fully embedding it.

static uint32_t	Seed ()

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.

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

void	addMandatoryFields ()

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

EDA_ITEM *	findParent (KICAD_T aType) const

Static Protected Member Functions
static double	lodScaleForThreshold (const KIGFX::VIEW *aView, int aWhatIu, int aThresholdIu)
	Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

Protected Attributes
PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

BOARD *	m_boardCacheOwner = nullptr

EDA_ITEM_FLAGS	m_flags

EDA_ITEM *	m_parent
	Owner.

EDA_GROUP *	m_group
	The group this item belongs to, if any. No ownership implied.

VECTOR2I	m_rolloverPos

bool	m_isRollover

bool	m_forceVisible

bool	m_netHighlighted = false

std::map< wxString, wxString >	m_customProperties

std::map< wxString, std::unique_ptr< PROPERTY_BASE > >	m_dynamicCustomPropsCache
	Per-key cache of dynamic property descriptors for m_customProperties, owned by this object.

bool	m_embedFonts = false
	If set, fonts will be embedded in the element on save.

Static Protected Attributes
static constexpr double	LOD_HIDE = std::numeric_limits<double>::max()
	Return this constant from ViewGetLOD() to hide the item unconditionally.

static constexpr double	LOD_SHOW = 0.0
	Return this constant from ViewGetLOD() to show the item unconditionally.

Private Attributes
std::deque< PCB_FIELD * >	m_fields

std::deque< BOARD_ITEM * >	m_drawings

std::deque< PAD * >	m_pads

std::vector< ZONE * >	m_zones

std::deque< PCB_GROUP * >	m_groups

std::deque< PCB_CONSTRAINT * >	m_constraints

std::deque< PCB_POINT * >	m_points

TRANSFORM_TRS	m_transform

bool	m_flipped = false

LIB_ID	m_fpid

int	m_attributes

int	m_fpStatus

int	m_fileFormatVersionAtLoad

CASE_INSENSITIVE_MAP< FOOTPRINT_VARIANT >	m_variants
	Variant data for this footprint, keyed by variant name.

std::mutex	m_geometry_cache_mutex

std::unique_ptr< FOOTPRINT_GEOMETRY_CACHE_DATA >	m_geometry_cache

std::map< wxString, std::unique_ptr< PCB_FOOTPRINT_FIELD_PROPERTY > >	m_dynamicPropertyCache

std::vector< wxString >	m_netTiePadGroups

std::map< const BOARD_ITEM *, std::set< int > >	m_netTieCache

std::vector< std::set< wxString > >	m_jumperPadGroups
	A list of jumper pad groups, each of which is a set of pad numbers that should be jumpered together (treated as internally connected for the purposes of connectivity)

bool	m_duplicatePadNumbersAreJumpers
	Flag that this footprint should automatically treat sets of two or more pads with the same number as jumpered pin groups.

bool	m_allowMissingCourtyard

bool	m_allowSolderMaskBridges

ZONE_CONNECTION	m_zoneConnection

std::optional< int >	m_clearance

std::optional< int >	m_solderMaskMargin

std::optional< int >	m_solderPasteMargin

std::optional< double >	m_solderPasteMarginRatio

LSET	m_stackupLayers

FOOTPRINT_STACKUP	m_stackupMode

LSET	m_privateLayers

wxString	m_libDescription

wxString	m_keywords

KIID_PATH	m_path

wxString	m_sheetname

wxString	m_sheetfile

wxString	m_filters

timestamp_t	m_lastEditTime

int	m_arflag

KIID	m_link

std::vector< FP_3DMODEL >	m_3D_Drawings

std::unique_ptr< EXTRUDED_3D_BODY >	m_extrudedBody

wxArrayString *	m_initial_comments

std::unique_ptr< FOOTPRINT_COURTYARD_CACHE_DATA >	m_courtyard_cache

std::mutex	m_courtyard_cache_mutex

std::unordered_set< wxString >	m_transientComponentClassNames

std::unique_ptr< COMPONENT_CLASS_CACHE_PROXY >	m_componentClassCacheProxy

std::vector< FP_UNIT_INFO >	m_unitInfo

std::vector< SEARCH_TERM >	m_searchTerms

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

bool	m_isSCH_ITEM

bool	m_isBOARD_ITEM

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items.

std::map< wxString, std::shared_ptr< EMBEDDED_FILE > >	m_files

std::vector< wxString >	m_fontFiles

FILE_ADDED_CALLBACK	m_fileAddedCallback

Detailed Description

Definition at line 313 of file footprint.h.

Member Typedef Documentation

◆ FILE_ADDED_CALLBACK

using EMBEDDED_FILES::FILE_ADDED_CALLBACK = std::function<void( EMBEDDED_FILE* )>

inherited

Definition at line 94 of file embedded_files.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC
INSTANCE_TO_INSTANCE

Definition at line 556 of file board_item.h.

◆ RETURN_CODE

enum class EMBEDDED_FILES::RETURN_CODE : int

stronginherited

Enumerator
OK	Success.
FILE_NOT_FOUND	File not found on disk.
PERMISSIONS_ERROR	Could not read/write file.
FILE_ALREADY_EXISTS	File already exists in the collection.
OUT_OF_MEMORY	Could not allocate memory.
CHECKSUM_ERROR	Checksum in file does not match data.

Definition at line 76 of file embedded_files.h.

Constructor & Destructor Documentation

◆ FOOTPRINT() [1/3]

FOOTPRINT::FOOTPRINT ( BOARD * parent )

Definition at line 162 of file footprint.cpp.

References B_Cu, BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), BOARD_ITEM_CONTAINER::BOARD_ITEM_CONTAINER(), DATASHEET, DESCRIPTION, EXPAND_INNER_LAYERS, F_Cu, F_Fab, F_SilkS, FP_PADS_are_LOCKED, In1_Cu, INHERITED, m_3D_Drawings, m_allowMissingCourtyard, m_allowSolderMaskBridges, m_arflag, m_attributes, m_componentClassCacheProxy, m_duplicatePadNumbersAreJumpers, EMBEDDED_FILES::m_embedFonts, m_fields, m_fileFormatVersionAtLoad, m_fpStatus, m_initial_comments, m_lastEditTime, BOARD_ITEM::m_layer, m_link, m_stackupLayers, m_stackupMode, m_zoneConnection, PCB_FOOTPRINT_T, REFERENCE, BOARD_ITEM::SetLayer(), EDA_TEXT::SetVisible(), and VALUE.

Referenced by CopyFrom(), CoverageRatio(), Duplicate(), FOOTPRINT(), FOOTPRINT(), FootprintNeedsUpdate(), GetCourtyard(), GetCoverageArea(), GetDynamicProperties(), GetFpPadsLocalBbox(), operator=(), operator=(), operator==(), operator==(), ResolveTextVar(), Similarity(), and swapData().

◆ FOOTPRINT() [2/3]

FOOTPRINT::FOOTPRINT ( const FOOTPRINT & aFootprint )

◆ FOOTPRINT() [3/3]

FOOTPRINT::FOOTPRINT ( FOOTPRINT && aFootprint )

Definition at line 347 of file footprint.cpp.

References BOARD_ITEM_CONTAINER::BOARD_ITEM_CONTAINER(), FOOTPRINT(), and m_componentClassCacheProxy.

◆ ~FOOTPRINT()

FOOTPRINT::~FOOTPRINT ( )

Definition at line 355 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), group, m_constraints, m_drawings, m_fields, m_groups, m_initial_comments, m_pads, m_points, and m_zones.

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 1822 of file footprint.cpp.

References APPEND, BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), EDA_ITEM::ClearEditFlags(), BOARD_ITEM::GetBoard(), InvalidateGeometryCaches(), m_constraints, m_drawings, m_fields, m_groups, m_pads, m_points, m_zones, PCB_BARCODE_T, PCB_CONSTRAINT_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_ZONE_T, EDA_ITEM::SetParent(), 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 3093 of file footprint.cpp.

References m_3D_Drawings, and FP_3DMODEL::m_Filename.

◆ AddFile() [1/3]

EMBEDDED_FILES::EMBEDDED_FILE * EMBEDDED_FILES::AddFile	(	const wxFileName &	aName,
		bool	aOverwrite )

inherited

Load a file from disk and adds it to the collection.

Parameters

aName	is the name of the file to load.
aOverwrite	is true if the file should be overwritten if it already exists.

Definition at line 69 of file embedded_files.cpp.

References CompressAndEncode(), EMBEDDED_FILES::EMBEDDED_FILE::DATASHEET, EMBEDDED_FILES::EMBEDDED_FILE::FONT, HasFile(), m_fileAddedCallback, m_files, EMBEDDED_FILES::EMBEDDED_FILE::MODEL, OK, result, and EMBEDDED_FILES::EMBEDDED_FILE::WORKSHEET.

◆ AddFile() [2/3]

EMBEDDED_FILES::EMBEDDED_FILE * EMBEDDED_FILES::AddFile ( EMBEDDED_FILE * aFile )

inherited

Append a file to the collection.

Ownership of aFile is transferred to the collection.

Returns: as for the shared_ptr overload; note that aFile itself is destroyed when a file of that name is already embedded.

Definition at line 141 of file embedded_files.cpp.

References AddFile().

◆ AddFile() [3/3]

EMBEDDED_FILES::EMBEDDED_FILE * EMBEDDED_FILES::AddFile ( std::shared_ptr< EMBEDDED_FILE > aFile )

inherited

Append a file (already managed by a shared_ptr) to the collection.

Allows multiple collections to share ownership of the same underlying file payload, avoiding deep copies of large embedded blobs such as 3D models when footprints are cloned for undo snapshots.

Returns: the file held by the collection, which is the pre-existing entry when a file of that name is already embedded.

Definition at line 147 of file embedded_files.cpp.

References m_fileAddedCallback, m_files, and name.

◆ addMandatoryFields()

void FOOTPRINT::addMandatoryFields ( )

protected

◆ AddNetTiePadGroup()

void FOOTPRINT::AddNetTiePadGroup ( const wxString & aGroup )

inline

Definition at line 615 of file footprint.h.

References m_netTiePadGroups.

Referenced by DeserializeDefinition().

◆ AddVariant()

FOOTPRINT_VARIANT * FOOTPRINT::AddVariant ( const wxString & aVariantName )

Add a new variant with the given name.

Parameters

aVariantName The name of the variant to add.

Returns: Reference to the newly created variant.

Definition at line 1658 of file footprint.cpp.

References GetDefaultVariantName(), IsDNP(), IsExcludedFromBOM(), IsExcludedFromPosFiles(), IsExcludedFromSim(), m_variants, FOOTPRINT_VARIANT::SetDNP(), FOOTPRINT_VARIANT::SetExcludedFromBOM(), FOOTPRINT_VARIANT::SetExcludedFromPosFiles(), and FOOTPRINT_VARIANT::SetExcludedFromSim().

Referenced by ApplyAltiumProjectVariantsToBoard(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_IO_KICAD_SEXPR_PARSER::parseFootprintVariant(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), PCB_FOOTPRINT_FIELD_PROPERTY::setter(), EDIT_TOOL::ToggleFootprintAttribute(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ AllowMissingCourtyard()

bool FOOTPRINT::AllowMissingCourtyard ( ) const

inline

Definition at line 556 of file footprint.h.

References m_allowMissingCourtyard.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_KICAD_SEXPR::format(), DIALOG_FOOTPRINT_CHECKER::runChecks(), and Serialize().

◆ AllowSolderMaskBridges()

bool FOOTPRINT::AllowSolderMaskBridges ( ) const

inline

Definition at line 559 of file footprint.h.

References m_allowSolderMaskBridges.

Referenced by BOARD::ExchangeFootprint(), FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), DRC_TEST_PROVIDER_SOLDER_MASK::recordMaskAperture(), Serialize(), and DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems().

◆ ApplyDefaultSettings()

void FOOTPRINT::ApplyDefaultSettings	(	const BOARD &	board,
		bool	aStyleFields,
		bool	aStyleText,
		bool	aStyleShapes,
		bool	aStyleDimensions,
		bool	aStyleBarcodes )

Apply default board settings to the footprint field text properties.

This is needed because the board settings are not available when the footprint is being created in the footprint library cache, and we want these fields to have the correct default text properties.

Definition at line 1017 of file footprint.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), m_drawings, m_fields, PCB_BARCODE_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_SHAPE_T, PCB_TEXT_T, and PCB_TEXTBOX_T.

Referenced by LoadFootprintFromProject(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ AssignSharedFrom()

void EMBEDDED_FILES::AssignSharedFrom	(	const EMBEDDED_FILES &	aSource,
		const std::set< wxString > &	aExcludedNames = {} )

inherited

Replace this collection's files with references to aSource's files, skipping any whose name appears in aExcludedNames.

Payloads are shared, not copied.

This leaves aSource untouched, so the operation is idempotent. Editor dialogs commit their working copy on both page change and OK; a destructive commit would wipe the target on the second pass.

Definition at line 179 of file embedded_files.cpp.

References EMBEDDED_FILES(), m_files, and name.

Referenced by BOOST_AUTO_TEST_CASE().

◆ AutoPositionFields()

void FOOTPRINT::AutoPositionFields ( )

Position Reference and Value fields at the top and bottom of footprint's bounding box.

Definition at line 4012 of file footprint.cpp.

References ANGLE_0, BOX2< Vec >::GetBottom(), GetBoundingBox(), BOX2< Vec >::GetCenter(), GetPosition(), BOX2< Vec >::GetTop(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, BOX2< Vec >::Inflate(), pcbIUScale, Reference(), EDA_TEXT::SetHorizJustify(), PCB_TEXT::SetTextAngle(), EDA_TEXT::SetVertJustify(), BOARD_ITEM::SetX(), BOARD_ITEM::SetY(), Value(), and VECTOR2< T >::x.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary().

◆ BoardCopperLayerCount()

int BOARD_ITEM::BoardCopperLayerCount ( ) const

virtualinherited

Return the total number of copper layers for the board that this item resides on.

Definition at line 203 of file board_item.cpp.

References BOARD, GetBoard(), and BOARD::GetCopperLayerCount().

Referenced by PAD::ClearZoneLayerOverrides(), PCB_VIA::GetLayerSet(), PAD::PAD(), PCB_VIA::SanitizeLayers(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ BoardLayerCount()

int BOARD_ITEM::BoardLayerCount ( ) const

virtualinherited

Return the total number of layers for the board that this item resides on.

Definition at line 192 of file board_item.cpp.

References BOARD, GetBoard(), and BOARD::GetLayerSet().

◆ BoardLayerSet()

LSET BOARD_ITEM::BoardLayerSet ( ) const

virtualinherited

Return the LSET for the board that this item resides on.

Definition at line 214 of file board_item.cpp.

References LSET::AllLayersMask(), BOARD, GetBoard(), and BOARD::GetEnabledLayers().

Referenced by ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper().

◆ 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 4324 of file footprint.cpp.

References B_CrtYd, BOARD_ITEM::BOARD_ITEM(), CHAMFER_ACUTE_CORNERS, EDA_ITEM::ClearFlags(), ConvertOutlineToPolygon(), DEFAULT_COURTYARD_WIDTH, F_CrtYd, PCB_SHAPE::GetStroke(), STROKE_PARAMS::GetWidth(), GraphicalItems(), m_courtyard_cache, MALFORMED_B_COURTYARD, MALFORMED_COURTYARDS, MALFORMED_F_COURTYARD, PCB_SHAPE_T, pcbIUScale, and EDA_ITEM::SetFlags().

Referenced by AR_AUTOPLACER::buildFpAreas(), checkCourtyardCloses(), GetCourtyard(), COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), and DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ BuildNetTieCache()

void FOOTPRINT::BuildNetTieCache ( )

Cache the pads that are allowed to connect to each other in the footprint.

Definition at line 4429 of file footprint.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), BOARD_ITEM::GetBoard(), m_drawings, m_netTieCache, and MapPadNumbersToNetTieGroups().

◆ CheckClippedSilk()

void FOOTPRINT::CheckClippedSilk ( const std::function< void(BOARD_ITEM *aItemA, BOARD_ITEM *aItemB, const VECTOR2I &aPt)> & aErrorHandler )

Definition at line 4832 of file footprint.cpp.

References actual, B_Mask, B_SilkS, BOARD_ITEM::BOARD_ITEM(), F_Mask, F_SilkS, BOARD_ITEM::GetEffectiveShape(), PAD::GetEffectiveShape(), BOARD_ITEM::IsOnLayer(), PAD::IsOnLayer(), m_drawings, m_pads, and pad.

Referenced by 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 "Unspecified"

Parameters

aErrorHandler callback to handle the error messages generated

Definition at line 4585 of file footprint.cpp.

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 4809 of file footprint.cpp.

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 4698 of file footprint.cpp.

References B_Cu, BOARD_ITEM::BOARD_ITEM(), ERROR_OUTSIDE, F_Cu, BOARD_ITEM::GetMaxError(), PAD::GetNumber(), PAD::GetPosition(), In1_Cu, BOARD_ITEM::IsOnCopperLayer(), m_drawings, m_fields, m_pads, m_zones, MapPadNumbersToNetTieGroups(), SHAPE_LINE_CHAIN::NearestPoint(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), pad, RECURSE, and SHAPE_POLY_SET::Simplify().

Referenced by DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ CheckPads()

void FOOTPRINT::CheckPads	(	UNITS_PROVIDER *	aUnitsProvider,
		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 4610 of file footprint.cpp.

References pad, and Pads().

Referenced by DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ CheckShortingPads()

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

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

Parameters

aErrorHandler callback to handle the error messages generated

Definition at line 4628 of file footprint.cpp.

References LSET::AllCuMask(), SHAPE::Collide(), alg::contains(), DRCE_DRILLED_HOLES_COLOCATED, DRCE_DRILLED_HOLES_TOO_CLOSE, DRCE_SHORTING_ITEMS, PAD::GetBoundingBox(), PAD::GetEffectiveHoleShape(), PAD::GetEffectiveShape(), PAD::GetLayerSet(), GetNetTiePads(), PAD::GetPosition(), PAD::HasDrilledHole(), HOLE_TO_HOLE_CONSTRAINT, pad, Pads(), PAD::Padstack(), and UNDEFINED_LAYER.

Referenced by DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ ClassOf()

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

inlinestatic

Definition at line 336 of file footprint.h.

References EDA_ITEM::EDA_ITEM(), 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 1806 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), NETINFO_LIST::ORPHANED, RECURSE, and RunOnChildren().

Referenced by FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), PCB_IO_KICAD_SEXPR::FootprintSave(), LoadFootprintFromProject(), and PCB_BASE_FRAME::OnFpChangeDebounceTimer().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 154 of file eda_item.h.

References BRIGHTENED, and ClearFlags().

Referenced by KICAD_DIFF::ConfigureSchDiffCanvasContext(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and PCB_TEST_SELECTION_TOOL::unhighlightInternal().

◆ ClearCustomProperties()

void EDA_ITEM::ClearCustomProperties ( )

inlineinherited

Definition at line 270 of file eda_item.h.

References m_customProperties.

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 178 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

Referenced by BOARD::Add(), FOOTPRINT::Add(), LIB_SYMBOL::ClearEditFlags(), DRAWING_TOOL::drawShape(), SCH_MOVE_TOOL::finalizeMoveOperation(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::Revert(), SCH_ITEM::SwapFlags(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and FOOTPRINT::UpdateFields().

◆ ClearEmbeddedFiles()

void EMBEDDED_FILES::ClearEmbeddedFiles ( bool aDeleteFiles = true )

inlineinherited

Definition at line 267 of file embedded_files.h.

References m_files.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO_KICAD_SEXPR::format(), operator=(), LIB_BUFFER::SaveBuffer(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), and kiapi::board::UnpackEmbeddedFiles().

◆ ClearEmbeddedFonts()

void EMBEDDED_FILES::ClearEmbeddedFonts ( )

inherited

Remove all embedded fonts from the collection.

Definition at line 197 of file embedded_files.cpp.

References EMBEDDED_FILES::EMBEDDED_FILE::FONT, and m_files.

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ ClearExtrudedBody()

void FOOTPRINT::ClearExtrudedBody ( )

inline

Definition at line 432 of file footprint.h.

References m_extrudedBody.

Referenced by BOARD::ExchangeFootprint(), and PANEL_FP_PROPERTIES_3D_MODEL::updateExtrusionPreview().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 160 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, m_flags, and m_netHighlighted.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), AlignSchematicItemsToGrid(), SCH_MOVE_TOOL::AlignToGrid(), BACK_ANNOTATE::applyChangelist(), PCB_CONTROL::ApplyDesignBlockLayout(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT::BuildCourtyardCaches(), ClearBrightened(), ClearEditFlags(), ClearSelected(), ClearTempFlags(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), MULTICHANNEL_TOOL::copyRuleAreaContents(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_TUNING_PATTERN::EditCancel(), PCB_VIA_STACK::EditCancel(), PCB_VIA_STITCH::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_VIA_STACK::EditFinish(), PCB_VIA_STITCH::EditFinish(), BOARD::ExchangeFootprint(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), SCH_IO_KICAD_SEXPR::Format(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SCH_IO_PADS::LoadSchematicFile(), SCH_ALIGN_TOOL::moveItem(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDAPRO_V3_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), DRAWING_TOOL::PlaceMicroviaStack(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_MOVE_TOOL::preprocessBreakOrSliceSelection(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), PAD::Recombine(), FOOTPRINT_EDIT_FRAME::RefreshLibraryFootprintTab(), GERBVIEW_FRAME::RemapLayers(), SCH_COMMIT::Revert(), DRC_TEST_PROVIDER_DISALLOW::Run(), ISSUE22864_FIXTURE::RunAlignmentAndVerify(), ISSUE22864_FIXTURE::RunAlignmentAndVerifyNoSkew(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), HEADLESS_FOOTPRINT_CONTEXT::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_SELECTION_TOOL::SelectMultiple(), SetIsShownAsBitmap(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SELECTION_TOOL::unhighlight(), SCH_SHAPE::UpdateHatching(), and SCOPED_FLAGS_CLEANER::~SCOPED_FLAGS_CLEANER().

◆ ClearNetTiePadGroups()

void FOOTPRINT::ClearNetTiePadGroups ( )

inline

Definition at line 610 of file footprint.h.

References m_netTiePadGroups.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 191 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

Referenced by LIB_SYMBOL::ClearTempFlags(), SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_ITEM::SwapFlags().

◆ ClearTransientComponentClassNames()

void FOOTPRINT::ClearTransientComponentClassNames ( )

inline

Remove the transient component class names.

Definition at line 1444 of file footprint.h.

References m_transientComponentClassNames.

Referenced by PCB_CONTROL::Paste().

◆ Clone()

EDA_ITEM * FOOTPRINT::Clone ( ) const

overridevirtual

Invoke a function on all children.

Note: This function should not add or remove items to the parent.

Reimplemented from EDA_ITEM.

Definition at line 3250 of file footprint.cpp.

References EDA_ITEM::EDA_ITEM(), and FOOTPRINT.

Referenced by EDA_DATA::AddPackage(), PCB_IO_IPC2581::addPackage(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), FOOTPRINT_EDITOR_CONTROL::editFootprintPropertiesFromLibrary(), FOOTPRINT_LIBRARY_ADAPTER::enumerateLibrary(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), PCB_IO_KICAD_SEXPR::FootprintLoad(), FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::FootprintSave(), FOOTPRINT_EDIT_FRAME::installFootprintTabBoard(), PCB_IO_GEDA::loadBoard(), PlotFootprintToSVG(), FOOTPRINT_EDIT_FRAME::RefreshLibraryFootprintTab(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), BOARD_NETLIST_UPDATER::updateComponentClass(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateComponentUnits(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ CompressAndEncode()

EMBEDDED_FILES::RETURN_CODE EMBEDDED_FILES::CompressAndEncode ( EMBEDDED_FILE & aFile )

staticinherited

Take data from the #decompressedData buffer and compresses it using ZSTD into the #compressedEncodedData buffer.

The data is then Base64 encoded. This call is used when adding a new file to the collection from disk.

Definition at line 271 of file embedded_files.cpp.

References MMH3_HASH::add(), EMBEDDED_FILES::EMBEDDED_FILE::compressedEncodedData, EMBEDDED_FILES::EMBEDDED_FILE::data_hash, EMBEDDED_FILES::EMBEDDED_FILE::decompressedData, MMH3_HASH::digest(), OK, OUT_OF_MEMORY, Seed(), and HASH_128::ToString().

Referenced by AddFile(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PADS_SCH_BINARY::PADS_SCH_BINARY_BUILDER::Build(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), and SYMBOL_EMBEDDED_FILES_TEST_FIXTURE::CreateTestEmbeddedFile().

◆ ComputeFileHash()

EMBEDDED_FILES::RETURN_CODE EMBEDDED_FILES::ComputeFileHash	(	const wxFileName &	aFileName,
		std::string &	aHash )

staticinherited

Compute the hash of a file on disk without fully embedding it.

Parameters

aFileName	is the path to the file to hash.
aHash	is the output string to store the computed hash.

Returns: OK on success, FILE_NOT_FOUND if file cannot be read.

Definition at line 403 of file embedded_files.cpp.

References MMH3_HASH::add(), MMH3_HASH::digest(), FILE_NOT_FOUND, OK, OUT_OF_MEMORY, Seed(), and HASH_128::ToString().

Referenced by PANEL_EMBEDDED_FILES::AddEmbeddedFile(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ Constraints() [1/2]

CONSTRAINTS & FOOTPRINT::Constraints ( )

inline

Definition at line 416 of file footprint.h.

References m_constraints.

Referenced by BOOST_AUTO_TEST_CASE(), DeserializeDefinition(), EDIT_TOOL::Duplicate(), Duplicate(), PCB_IO_KICAD_SEXPR::format(), operator=(), pasteFootprintItemsToFootprintEditor(), and CLIPBOARD_IO::SaveSelection().

◆ Constraints() [2/2]

const CONSTRAINTS & FOOTPRINT::Constraints ( ) const

inline

Definition at line 417 of file footprint.h.

References m_constraints.

◆ CopyFrom()

void FOOTPRINT::CopyFrom ( const BOARD_ITEM * aOther )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 1402 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), FOOTPRINT(), m_pads, pad, PCB_FOOTPRINT_T, and EDA_ITEM::Type().

◆ 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 4188 of file footprint.cpp.

References COLLECTORS_GUIDE::Accuracy(), SHAPE_POLY_SET::AddOutline(), ARC_LOW_DEF, BOARD_ITEM::BOARD_ITEM(), SHAPE_POLY_SET::BooleanIntersection(), ERROR_OUTSIDE, FOOTPRINT(), GetBoundingHull(), COLLECTOR::GetCount(), GENERAL_COLLECTOR::GetGuide(), BOARD_ITEM::GetParent(), SHAPE_POLY_SET::Outline(), PCB_ARC_T, PCB_BARCODE_T, PCB_FIELD_T, PCB_FOOTPRINT_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.

◆ DecompressAndDecode()

EMBEDDED_FILES::RETURN_CODE EMBEDDED_FILES::DecompressAndDecode	(	EMBEDDED_FILE &	aFile,
		bool	aAllowEmptyHash = false )

staticinherited

Takes data from the #compressedEncodedData buffer and Base64 decodes it.

The data is then decompressed using ZSTD and stored in the #decompressedData buffer. This call is used when loading the embedded files using the parsers.

Parameters

aAllowEmptyHash will let this succeed if aFile.data_hash is empty

Definition at line 306 of file embedded_files.cpp.

References MMH3_HASH::add(), MMH3_HASH::addDataV1(), CHECKSUM_ERROR, EMBEDDED_FILES::EMBEDDED_FILE::compressedEncodedData, EMBEDDED_FILES::EMBEDDED_FILE::data_hash, EMBEDDED_FILES::EMBEDDED_FILE::decompressedData, MMH3_HASH::digest(), EMBEDDED_FILES::EMBEDDED_FILE::name, OK, OUT_OF_MEMORY, Seed(), and HASH_128::ToString().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EMBEDDED_FILES_PARSER::ParseEmbedded(), and kiapi::board::UnpackEmbeddedFiles().

◆ Delete()

virtual void BOARD_ITEM_CONTAINER::Delete ( BOARD_ITEM * aItem )

inlinevirtualinherited

Removes an item from the container and deletes it.

Definition at line 72 of file board_item_container.h.

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

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 303 of file board_item.cpp.

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

◆ DeleteVariant()

void FOOTPRINT::DeleteVariant ( const wxString & aVariantName )

Delete a variant by name.

Parameters

aVariantName The name of the variant to delete.

Definition at line 1683 of file footprint.cpp.

References m_variants.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ Deserialize()

bool FOOTPRINT::Deserialize ( const google::protobuf::Any & aContainer )

overridevirtual

Deserializes the given protobuf message into this object.

Parameters

aContainer is an Any which should have a concrete type matching this object

Returns: true if unpacking and deserialization succeeded

Reimplemented from SERIALIZABLE.

Definition at line 745 of file footprint.cpp.

References DATASHEET, DESCRIPTION, PCB_FIELD::Deserialize(), DeserializeDefinition(), FP_SMD, FP_THROUGH_HOLE, FromProtoEnum(), GetDefaultVariantName(), GetField(), m_attributes, m_filters, m_path, m_sheetfile, m_sheetname, m_variants, REFERENCE, SetAllowMissingCourtyard(), SetAllowSolderMaskBridges(), SetBoardOnly(), SetDNP(), FOOTPRINT_VARIANT::SetDNP(), SetExcludedFromBOM(), FOOTPRINT_VARIANT::SetExcludedFromBOM(), SetExcludedFromPosFiles(), FOOTPRINT_VARIANT::SetExcludedFromPosFiles(), SetExcludedFromSim(), FOOTPRINT_VARIANT::SetExcludedFromSim(), FOOTPRINT_VARIANT::SetFieldValue(), SetLayer(), SetLocalClearance(), SetLocalSolderMaskMargin(), SetLocalSolderPasteMargin(), SetLocalSolderPasteMarginRatio(), SetLocalZoneConnection(), SetLocked(), FOOTPRINT_VARIANT::SetName(), SetOrientationDegrees(), SetPosition(), BOARD_ITEM::SetUuidDirect(), kiapi::common::UnpackCustomProperties(), kiapi::board::UnpackEmbeddedFiles(), kiapi::common::UnpackSheetPath(), and VALUE.

Referenced by API_TEST_CLIENT::GetFirstFootprint().

◆ DeserializeDefinition()

bool FOOTPRINT::DeserializeDefinition ( const kiapi::board::types::Footprint & aInput )

Definition at line 630 of file footprint.cpp.

References Add(), AddNetTiePadGroup(), APPEND, BOARD_ITEM::BOARD, Constraints(), CreateItemForType(), FromProtoEnum(), BOARD_ITEM::GetBoard(), GraphicalItems(), group, Groups(), JumperPadGroups(), m_fields, m_netTiePadGroups, model, Models(), pad, Pads(), Points(), Remove(), BASE_SET::set(), SetDuplicatePadNumbersAreJumpers(), SetFPID(), SetKeywords(), SetLibDescription(), SetPrivateLayers(), traceApi, kiapi::common::TypeNameFromAny(), UNDEFINED_LAYER, kiapi::common::UnpackLibId(), kiapi::common::UnpackVector3D(), and Zones().

Referenced by Deserialize().

◆ DisambiguateItemDescription()

wxString FOOTPRINT::DisambiguateItemDescription	(	UNITS_PROVIDER *	aUnitsProvider,
		bool	aFull ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 3236 of file footprint.cpp.

References GetFPIDAsString(), and GetItemDescription().

◆ Duplicate()

BOARD_ITEM * FOOTPRINT::Duplicate	(	bool	addToParentGroup,
		BOARD_COMMIT *	aCommit = nullptr ) const

overridevirtual

Create a copy of this BOARD_ITEM.

Parameters

addToParentGroup Indicates whether or not the new item is added to the group containing the old item. If true, aCommit must be provided.

Reimplemented from BOARD_ITEM.

Definition at line 3781 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), Constraints(), BOARD_ITEM::Duplicate(), FOOTPRINT(), EDA_ITEM::m_Uuid, RECURSE, BOARD_ITEM::ResetUuidDirect(), and RunOnChildren().

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOOST_AUTO_TEST_CASE(), PCB_IO_GEDA::FootprintLoad(), PCB_IO_KICAD_SEXPR::FootprintLoad(), and CADSTAR_PCB_ARCHIVE_LOADER::loadComponents().

◆ DuplicateItem()

BOARD_ITEM * FOOTPRINT::DuplicateItem	(	bool	addToParentGroup,
		BOARD_COMMIT *	aCommit,
		const BOARD_ITEM *	aItem,
		bool	addToFootprint = 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 3805 of file footprint.cpp.

References Add(), BOARD_ITEM::BOARD_ITEM(), DATASHEET, BOARD_ITEM::Duplicate(), KIGFX::VIEW_ITEM::GetClass(), group, m_pads, m_points, m_zones, PAD, PCB_BARCODE_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_ZONE_T, RECURSE, REFERENCE, BOARD_ITEM::ResetUuidDirect(), EDA_TEXT::SetText(), EDA_ITEM::Type(), and VALUE.

Referenced by EDIT_TOOL::Duplicate(), and ARRAY_TOOL::onDialogClosed().

◆ EmbeddedFileMap()

const std::map< wxString, std::shared_ptr< EMBEDDED_FILE > > & EMBEDDED_FILES::EmbeddedFileMap ( ) const

inlineinherited

Provide an iterable view of the file collection.

The map stores files via shared_ptr so that the copy constructor (used by Clone()) can share ownership of payloads, keeping transient snapshots cheap. Copy assignment, in contrast, performs a deep copy so callers that mutate file fields through raw pointers after assignment cannot affect the source. Callers that need a guaranteed-unique mutable copy from a const-ref source must allocate a new EMBEDDED_FILE explicitly.

Definition at line 258 of file embedded_files.h.

References m_files.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOARD::ExchangeFootprint(), BOARD::FixupEmbeddedData(), LIB_SYMBOL::Flatten(), PCB_IO_KICAD_SEXPR::format(), API_HANDLER_PCB::handleAddEmbeddedFiles(), ALTIUM_PCB::HelperEmbedModel(), kiapi::board::PackEmbeddedFiles(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ EmbedFonts()

void FOOTPRINT::EmbedFonts ( )

overridevirtual

Reimplemented from EMBEDDED_FILES.

Definition at line 5435 of file footprint.cpp.

References EMBEDDED_FILES::AddFile(), EMBEDDED_FILES::EMBEDDED_FILE::FONT, GetEmbeddedFiles(), GetFonts(), and EMBEDDED_FILES::EMBEDDED_FILE::type.

◆ EnsureExtrudedBody()

EXTRUDED_3D_BODY & FOOTPRINT::EnsureExtrudedBody ( )

Definition at line 3103 of file footprint.cpp.

References m_extrudedBody.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PANEL_FP_PROPERTIES_3D_MODEL::updateExtrusionControls(), and PANEL_FP_PROPERTIES_3D_MODEL::updateExtrusionPreview().

◆ 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 2918 of file footprint.cpp.

References m_pads, and pad.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CheckNetTiePadGroups(), Similarity(), EDIT_TOOL::SwapGateNets(), BOARD_NETLIST_UPDATER::testConnectivity(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ FindPadByUuid()

PAD * FOOTPRINT::FindPadByUuid ( const KIID & aUuid ) const

Definition at line 2938 of file footprint.cpp.

References m_pads, and pad.

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 137 of file eda_item.cpp.

References EDA_ITEM(), GetParent(), and Type().

Referenced by BOARD_ITEM::GetBoard(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParentFootprint(), SCH_ITEM::GetParentSymbol(), SCH_ITEM::GetParentSymbol(), and SCH_ITEM::Schematic().

◆ FitsEnabledLayers()

bool FOOTPRINT::FitsEnabledLayers	(	const LSET &	aEnabledLayers,
		int	aCopperLayerCount ) const

inlineoverridevirtual

Check if a board offering aEnabledLayers can hold this item.

A layer-agnostic item always fits; anything else needs at least one of its own layers enabled. aCopperLayerCount is passed rather than read from the item because the item may still belong to the board it is being copied from. Only the mounting side is judged – the children are exempt per IsLayerAgnostic, but a footprint that names no side at all is malformed and no board can hold it.

Reimplemented from BOARD_ITEM.

Definition at line 693 of file footprint.h.

References B_Cu, F_Cu, and GetLayer().

Referenced by BOOST_AUTO_TEST_CASE().

◆ FixUpPadsForBoard()

void FOOTPRINT::FixUpPadsForBoard ( BOARD * aBoard )

Used post-loading of a footprint to adjust the layers on pads to match board inner layers.

Definition at line 5521 of file footprint.cpp.

References LSET::AllCuMask(), BOARD_ITEM::BOARD, EXPAND_INNER_LAYERS, BOARD::GetCopperLayerCount(), GetStackupMode(), pad, Pads(), and PTH.

Referenced by BOARD_NETLIST_UPDATER::replaceFootprint().

◆ 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 1066 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), group, m_drawings, m_fields, m_groups, m_pads, m_points, m_zones, niluuid, and pad.

Referenced by FOOTPRINT_EDIT_FRAME::ReloadFootprint().

◆ Flip()

void FOOTPRINT::Flip	(	const VECTOR2I &	aCentre,
		FLIP_DIRECTION	aFlipDirection )

overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipDirection	the flip direction

Mirror the Y position (around the X axis)

Reimplemented from BOARD_ITEM.

Definition at line 3460 of file footprint.cpp.

References ANGLE_180, B_Cu, BaseType(), BOARD_ITEM::BOARD_ITEM(), BOARD::FlipLayer(), FlipLayer(), BOARD_ITEM::GetBoard(), GetLayer(), LEFT_RIGHT, m_courtyard_cache, m_drawings, m_extrudedBody, m_fields, m_flipped, m_geometry_cache, m_pads, m_points, m_transform, m_zones, MIRROR(), EDA_ANGLE::Normalize180(), pad, PCB_BARCODE_T, PCB_DIMENSION_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, Rotate(), BOARD_ITEM::SetLayer(), SetPosition(), TOP_BOTTOM, UNDEFINED_LAYER, and VECTOR2< T >::y.

◆ FootprintNeedsUpdate()

bool FOOTPRINT::FootprintNeedsUpdate	(	const FOOTPRINT *	aLibFP,
		int	aCompareFlags = 0,
		REPORTER *	aReporter = nullptr )

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

Definition at line 802 of file drc_test_provider_library_parity.cpp.

References _, AllowSolderMaskBridges(), barcodeNeedsUpdate(), BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), CHECKPOINT, Clone(), BOARD_ITEM::DRC, dummy, end, FOOTPRINT(), footprintVsBoardStackup(), FP_BOARD_ONLY, FP_DNP, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_EXCLUDE_FROM_SIM, FP_SMD, FP_THROUGH_HOLE, GetAttributes(), BOARD_ITEM::GetBoard(), GetLocalClearance(), GetLocalSolderMaskMargin(), GetLocalSolderPasteMargin(), GetLocalSolderPasteMarginRatio(), GetLocalZoneConnection(), GetNetTiePadGroups(), GraphicalItems(), INHERITED, BOARD_ITEM::INSTANCE_TO_INSTANCE, IsFlipped(), ITEM_DESC, padHasOverrides(), padNeedsUpdate(), Pads(), REPORT, shapeNeedsUpdate(), stackupNeedsUpdate(), TEST, TEST_ATTR, TOP_BOTTOM, zoneNeedsUpdate(), and Zones().

Referenced by BOARD_INSPECTION_TOOL::DiffFootprint(), BOARD::ExchangeFootprint(), and DIALOG_EXCHANGE_FOOTPRINTS::processFootprint().

◆ Get() [1/3]

template<typename T>

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

inherited

Definition at line 84 of file inspectable_impl.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

◆ Get() [3/3]

template<typename T>

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

Definition at line 72 of file inspectable_impl.h.

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

◆ GetArea()

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

Definition at line 2056 of file footprint.cpp.

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

Referenced by sortFootprintsByComplexity(), and sortFootprintsByRatsnestSize().

◆ GetAreFontsEmbedded()

bool EMBEDDED_FILES::GetAreFontsEmbedded ( ) const

inlineinherited

Definition at line 288 of file embedded_files.h.

References m_embedFonts.

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), and LIB_SYMBOL::Serialize().

◆ GetAttributes()

int FOOTPRINT::GetAttributes ( ) const

inline

Definition at line 550 of file footprint.h.

References m_attributes.

Referenced by COMPONENTS_MANAGER::AddComponent(), BOARD_NETLIST_UPDATER::addNewFootprint(), EXPORTER_STEP::buildFootprint3DShapes(), KI_TEST::CheckFootprint(), CheckFootprintAttributes(), BOARD::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), FootprintNeedsUpdate(), GENCAD_EXPORTER::footprintWriteShape(), PCB_IO_KICAD_SEXPR::format(), idf_export_footprint(), BOARD_ADAPTER::IsFootprintShown(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 95 of file board_item.cpp.

References BOARD, EDA_ITEM::findParent(), 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 86 of file board_item.cpp.

References BOARD, EDA_ITEM::findParent(), PCB_T, and EDA_ITEM::Type().

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::Add(), COMPONENTS_MANAGER::AddComponent(), BOARD_ADAPTER::addShape(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), PCB_BARCODE::AssembleBarcode(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BoardCopperLayerCount(), BoardLayerCount(), BoardLayerSet(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CN_CONNECTIVITY_ALGO::Build(), FOOTPRINT::BuildNetTieCache(), ZONE::BuildSmoothedPoly(), ZONE::CacheBoundingBox(), TMATCH::checkCandidateNetConsistency(), collidesWithArea(), ConstraintItemIsLocked(), PG_NET_SELECTOR_EDITOR::CreateControls(), PCB_TUNING_PATTERN::CreateNew(), FOOTPRINT::DeserializeDefinition(), PCB_GROUP::DeserializeGroup(), BOARD_INSPECTION_TOOL::DiffFootprint(), DIMENSION_DESC::DIMENSION_DESC(), doIntersectsAreaFunc(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::drawChartSymbols(), KIGFX::PCB_PAINTER::drawDrillMarks(), KIGFX::PCB_PAINTER::drawDrillSymbol(), ZONE::Duplicate(), enclosedByAreaFunc(), existsOnLayerFunc(), ZONE_FILLER::Fill(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), PAD::FlashLayer(), PCB_VIA::FlashLayer(), FOOTPRINT::Flip(), PAD::Flip(), PCB_ARC::Flip(), PCB_BARCODE::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_DRILL_MAP::Flip(), PCB_GENERATOR::Flip(), PCB_POINT::Flip(), PCB_REFERENCE_IMAGE::Flip(), PCB_SHAPE::Flip(), PCB_TABLE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), PCB_VIA::Flip(), PCB_VIA_STACK::Flip(), ZONE::Flip(), FOOTPRINT::FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), fromToFunc(), PCB_DRILL_MAP::GetBoardOutlines(), FOOTPRINT::GetBoundingBox(), NETINFO_ITEM::GetBoundingBox(), PCB_DRILL_MAP::GetBoundingBox(), ZONE::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), FOOTPRINT::GetBoundingHull(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TRACK::GetDelay(), BOARD_CONNECTED_ITEM::GetDisplayNetname(), PCB_VIA::GetDrillConstraint(), FOOTPRINT::GetDynamicProperties(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), GetEmbeddedFonts(), getFieldFunc(), PCB_VIA_STITCH::GetGuardedNetCode(), PCB_SHAPE::getHatchingKnockouts(), ZONE::GetInteractingZones(), PAD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), ZONE::GetItemDescription(), PCB_PROPERTIES_PANEL::getItemValue(), FOOTPRINT::GetLayerBoundingBox(), GetLayerName(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant(), GetMaxError(), PCB_VIA::GetMinAnnulus(), FOOTPRINT::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), PCB_VIA_STITCH::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), PCB_VIA::GetOutermostConnectedLayers(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetPostMachiningKnockout(), PCB_VIA::GetPostMachiningKnockout(), PCB_TUNING_PATTERN::GetPreviewItems(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_MARKER::GetSeverity(), PCB_FIELD::GetShownText(), PCB_TABLECELL::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), FOOTPRINT::GetSide(), PAD::GetSolderMaskExpansion(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_TRACK::GetSolderMaskExpansion(), PCB_VIA::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), PCB_DRILL_MAP::GetSpanChoice(), PCB_DRILL_MAP::GetSymbolExtent(), PCB_FOOTPRINT_FIELD_PROPERTY::getter(), BOARD::GetTrackLength(), PCB_DIMENSION_BASE::GetValueFieldText(), PCB_DIMENSION_BASE::GetValueMode(), DIALOG_FIND_BY_PROPERTIES::getVariantAwareValue(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), PCB_VIA_STITCH::GetZonesNeedingRefillAfterUpdate(), hasExactNetclassFunc(), hasNetChainFunc(), PCB_DRILL_MAP::HitTest(), inDiffPairFunc(), inNetChainClassFunc(), inNetChainFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), PAD::IsBackdrilledOrPostMachined(), PCB_VIA::IsBackdrilledOrPostMachined(), isCoupledDiffPairFunc(), PCB_VIA::IsGhostLayer(), IsLocked(), IsSideSpecific(), PCB_VIA::IsTented(), LayerMaskDescribe(), PCB_VIA::LayerMaskDescribe(), ZONE::Move(), CN_VISITOR::operator()(), FOOTPRINT::operator=(), FOOTPRINT::operator=(), PCB_IO_EAGLE::packageWire(), padNeedsUpdate(), PartitionNetChainAroundNet(), PCB_DRILL_MAP::PCB_DRILL_MAP(), ZONE_PAINTER::PCB_PAINTER(), PCB_DRAW_PANEL_GAL::prepareGridSources(), SPRINT_LAYOUT_PARSER::processCircle(), SPRINT_LAYOUT_PARSER::processLine(), SPRINT_LAYOUT_PARSER::processPad(), SPRINT_LAYOUT_PARSER::processPoly(), PCB_TUNING_PATTERN::recoverBaseline(), FOOTPRINT::Remove(), BOARD::ResolveDRCExclusions(), FOOTPRINT::ResolveTextVar(), FOOTPRINT::ResolveTextVar(), FOOTPRINT::Serialize(), PCB_ARC::Serialize(), PCB_BARCODE::Serialize(), PCB_DIMENSION_BASE::Serialize(), PCB_GROUP::Serialize(), PCB_POINT::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), PCB_SHAPE::Serialize(), PCB_TABLE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TRACK::Serialize(), PCB_VIA::Serialize(), ZONE::Serialize(), PAD::SetAttribute(), PCB_VIA::SetBottomLayer(), PCB_VIA_STITCH::SetGuardedNetCode(), PCB_SHAPE::SetIsProxyItem(), BOARD_CONNECTED_ITEM::SetLayer(), PCB_VIA::SetLayerPair(), PAD::SetLayerSet(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_TUNING_PATTERN::SetNetCode(), PCB_VIA_STITCH::SetNetCode(), PCB_DRILL_MAP::SetSpanChoice(), PCB_FOOTPRINT_FIELD_PROPERTY::setter(), PCB_VIA::SetTopLayer(), PCB_DIMENSION_BASE::SetUnitsMode(), PCB_FIELDS_GRID_TABLE::SetValueAsLong(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), PCB_VIA_STACK::ShowPropertiesDialog(), PCB_VIA_STITCH::ShowPropertiesDialog(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), SwapItemData(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), BOARD_CONNECTED_ITEM::UnpackNet(), ZONE_PRIORITY_CONTEXT_MENU::update(), BOARD::UpdateRatsnestExclusions(), PCB_PROPERTIES_PANEL::valueChanged(), FOOTPRINT::ViewBBox(), PAD::ViewBBox(), PCB_TRACK::ViewBBox(), PAD::ViewGetLayers(), PCB_VIA::ViewGetLayers(), PAD::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_VIA::ViewGetLOD(), ZONE::ZONE(), and zoneNeedsUpdate().

◆ 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 2212 of file footprint.cpp.

References GetBoundingBox().

Referenced by AutoPositionFields(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), AR_AUTOPLACER::buildFpAreas(), CalcPlaceholderLocalBox(), PCB_GRID_HELPER::computeAnchors(), KICAD_DIFF::FP_LIB_DIFFER::Diff(), KIGFX::PCB_PAINTER::draw(), KICAD_DIFF::ExtractFootprintGeometry(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), GetArea(), GetBoundingBox(), PCB_SELECTION::GetBoundingBox(), GetCenter(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), AR_AUTOPLACER::getOptimalFPPlacement(), HitTest(), HitTest(), HitTest(), PCB_SELECTION_TOOL::hitTestDistance(), SpreadFootprints(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), AR_AUTOPLACER::testFootprintOnBoard(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and ViewBBox().

◆ GetBoundingBox() [2/2]

const BOX2I FOOTPRINT::GetBoundingBox ( bool aIncludeText ) const

◆ GetBoundingHull() [1/2]

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 2439 of file footprint.cpp.

References SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::Append(), ARC_LOW_DEF, BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), BuildConvexHull(), SHAPE_POLY_SET::COutline(), ERROR_OUTSIDE, SHAPE_POLY_SET::FullPointCount(), BOARD_ITEM::GetBoard(), GetPosition(), m_drawings, m_geometry_cache, m_geometry_cache_mutex, m_pads, m_privateLayers, m_zones, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::OutlineCount(), pad, PCB_FIELD_T, PCB_REFERENCE_IMAGE_T, pcbIUScale, and UNDEFINED_LAYER.

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

◆ GetBoundingHull() [2/2]

SHAPE_POLY_SET FOOTPRINT::GetBoundingHull ( PCB_LAYER_ID aLayer ) const

Definition at line 2531 of file footprint.cpp.

References SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::Append(), ARC_LOW_DEF, BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), BuildConvexHull(), ERROR_OUTSIDE, BOARD_ITEM::GetBoard(), m_drawings, m_pads, m_privateLayers, m_zones, SHAPE_POLY_SET::NewOutline(), pad, PCB_FIELD_T, PCB_REFERENCE_IMAGE_T, and UNDEFINED_LAYER.

◆ GetCachedCourtyard()

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

Return the cached courtyard area.

No checks are performed.

Returns: the cached courtyard polygon.

Definition at line 4312 of file footprint.cpp.

References IsBackLayer(), and m_courtyard_cache.

Referenced by GetCourtyard().

◆ GetCenter()

VECTOR2I FOOTPRINT::GetCenter ( ) const

inlineoverridevirtual

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

Returns: center point of the item

Reimplemented from BOARD_ITEM.

Definition at line 402 of file footprint.h.

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

◆ GetChooserFields()

virtual void LIB_TREE_ITEM::GetChooserFields ( std::map< wxString, wxString > & aColumnMap )

inlinevirtualinherited

Retrieves a key/value map of the fields on this item that should be exposed to the library browser/chooser for displaying in columns, searching, etc.

Reimplemented in LIB_SYMBOL.

Definition at line 53 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetClass()

wxString FOOTPRINT::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements KIGFX::VIEW_ITEM.

Definition at line 1281 of file footprint.h.

Referenced by Visit().

◆ GetClearanceOverrides()

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

inline

Return any local clearance overrides set in the "classic" (ie: pre-rule) system.

Parameters

aSource [out] optionally reports the source as a user-readable string.

Returns: the clearance in internal units.

Definition at line 591 of file footprint.h.

References GetLocalClearance().

◆ GetComponentClass()

const COMPONENT_CLASS * FOOTPRINT::GetComponentClass ( ) const

Returns the component class for this footprint.

Definition at line 5470 of file footprint.cpp.

References m_componentClassCacheProxy.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOARD::ExchangeFootprint(), hasComponentClassFunc(), and testFootprintSelector().

◆ GetComponentClassAsString()

wxString FOOTPRINT::GetComponentClassAsString ( ) const

Used for display in the properties panel.

Definition at line 5476 of file footprint.cpp.

References m_componentClassCacheProxy.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ GetContextualTextVars()

void FOOTPRINT::GetContextualTextVars ( wxArrayString * aVars ) const

Return the list of system text vars for this footprint.

Definition at line 1441 of file footprint.cpp.

◆ 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 4297 of file footprint.cpp.

References BuildCourtyardCaches(), FOOTPRINT(), GetCachedCourtyard(), m_courtyard_cache, and m_courtyard_cache_mutex.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), AR_AUTOPLACER::buildFpAreas(), checkCourtyardCloses(), collidesWithArea(), collidesWithCourtyard(), KIGFX::PCB_PAINTER::draw(), DRC_ENGINE::EvalRules(), GetEffectiveShape(), GetExtrusionOutline(), DSN::SPECCTRA_DB::makeIMAGE(), BOARD_INSPECTION_TOOL::reportClearance(), DIALOG_FOOTPRINT_CHECKER::runChecks(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::testCourtyardClearances(), and DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances().

◆ GetCoverageArea()

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

static

Definition at line 4067 of file footprint.cpp.

References COLLECTORS_GUIDE::Accuracy(), ARC, ARC_LOW_DEF, SHAPE_LINE_CHAIN::Area(), BEZIER, BOARD_ITEM::BOARD_ITEM(), SHAPE_POLY_SET::BooleanAdd(), CIRCLE, ERROR_INSIDE, ERROR_OUTSIDE, FOOTPRINT(), GetBoundingHull(), GetCoverageArea(), GENERAL_COLLECTOR::GetGuide(), ZONE::GetIsRuleArea(), ZONE::GetLayerSet(), EDA_SHAPE::GetShape(), PCB_SHAPE::GetWidth(), EDA_SHAPE::IsAnyFill(), KI_FALLTHROUGH, ZONE::Outline(), SHAPE_POLY_SET::OutlineCount(), PCB_ARC_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_ZONE_T, POLY, polygonArea(), RECTANGLE, SEGMENT, MARKER_BASE::ShapeToPolygon(), text, BOARD_ITEM::TransformShapeToPolygon(), PCB_SHAPE::TransformShapeToPolygon(), ZONE::TransformShapeToPolygon(), PCB_TEXTBOX::TransformTextToPolySet(), EDA_ITEM::Type(), and UNDEFINED_LAYER.

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

◆ GetCustomProperties()

const std::map< wxString, wxString > & EDA_ITEM::GetCustomProperties ( ) const

inlineinherited

Custom user-defined string key/value properties attached to this item.

Keys and values are arbitrary strings; their meaning is defined by the user. The only constraint is that keys may not duplicate a built-in property (or field name, for items that have fields).

Definition at line 242 of file eda_item.h.

References m_customProperties.

Referenced by BOOST_AUTO_TEST_CASE(), KICAD_FORMAT::FormatCustomProperties(), and kiapi::common::PackCustomProperties().

◆ GetCustomPropertiesAsInspectables()

std::vector< PROPERTY_BASE * > EDA_ITEM::GetCustomPropertiesAsInspectables ( ) const

inherited

Definition at line 200 of file eda_item.cpp.

References m_customProperties, m_dynamicCustomPropsCache, and TYPE_HASH.

Referenced by GetDynamicProperties(), FOOTPRINT::GetDynamicProperties(), SCH_SHEET::GetDynamicProperties(), and SCH_SYMBOL::GetDynamicProperties().

◆ GetCustomProperty()

bool EDA_ITEM::GetCustomProperty	(	const wxString &	aKey,
		wxString &	aValue ) const

inherited

Returns: true if aKey is present and aValue was filled

Definition at line 188 of file eda_item.cpp.

References m_customProperties.

Referenced by customPropertyFunc(), EDA_CUSTOM_PROPERTY::getter(), hasCustomPropertyFunc(), PCB_PROPERTIES_PANEL::onKeyRenamed(), and SCH_PROPERTIES_PANEL::onKeyRenamed().

◆ GetDesc()

wxString FOOTPRINT::GetDesc ( )

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 486 of file footprint.h.

References GetLibDescription().

◆ GetDNPForVariant()

bool FOOTPRINT::GetDNPForVariant ( const wxString & aVariantName ) const

Get the DNP status for a specific variant.

If the variant doesn't exist, returns the default DNP status.

Parameters

aVariantName The variant name (empty for default).

Returns: true if DNP is set for the specified variant.

Definition at line 1723 of file footprint.cpp.

References GetDefaultVariantName(), FOOTPRINT_VARIANT::GetDNP(), GetVariant(), and IsDNP().

◆ GetDuplicatePadNumbersAreJumpers()

bool FOOTPRINT::GetDuplicatePadNumbersAreJumpers ( ) const

inline

Definition at line 1232 of file footprint.h.

References m_duplicatePadNumbersAreJumpers.

Referenced by PCB_IO_KICAD_SEXPR::format(), SerializeDefinition(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetDynamicProperties()

std::vector< PROPERTY_BASE * > FOOTPRINT::GetDynamicProperties ( ) const

overridevirtual

Return dynamically-computed properties specific to this object instance (e.g.

custom fields, pin-map entries). These are NOT registered in PROPERTY_MANAGER and do NOT appear in GetProperties(TYPE_ID).

The returned PROPERTY_BASE* pointers are owned by the object and remain valid until the object is destroyed or its property set changes.

Reimplemented from EDA_ITEM.

Definition at line 397 of file footprint.cpp.

References BOARD_ITEM::BOARD, FOOTPRINT(), BOARD_ITEM::GetBoard(), EDA_ITEM::GetCustomPropertiesAsInspectables(), GetFields(), PCB_FIELD::GetUntranslatedName(), PROPERTY_MANAGER::Instance(), BOARD::IsFootprintHolder(), m_dynamicPropertyCache, name, and TYPE_HASH.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 405 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

Referenced by collidesWithArea(), DRC_RTREE::Insert(), ItemHasDRCViolation(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), 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,
		DRC_CONSTRAINT_T	aUsage = NULL_CONSTRAINT ) 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).
aUsage	optional parameter specifying the query type. This can, for instance, allow backdrilling, countersinking, etc. to affect the shape used for resolving the physical_clearance.

Reimplemented from BOARD_ITEM.

Definition at line 4258 of file footprint.cpp.

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

◆ GetEmbeddedFile()

EMBEDDED_FILE * EMBEDDED_FILES::GetEmbeddedFile ( const wxString & aName ) const

inlineinherited

Returns the embedded file with the given name or nullptr if it does not exist.

Definition at line 242 of file embedded_files.h.

References m_files.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOARD::FixupEmbeddedData(), SCH_SCREEN::FixupEmbeddedData(), and SCH_EDIT_FRAME::importFile().

◆ GetEmbeddedFileLink()

wxString EMBEDDED_FILES::GetEmbeddedFileLink ( const EMBEDDED_FILE & aFile ) const

inlineinherited

Return the link for an embedded file.

Parameters

aFile is the file to get the link for.

Returns: the link for the file to be used in a hyperlink.

Definition at line 166 of file embedded_files.h.

References EMBEDDED_FILES::EMBEDDED_FILE::GetLink().

◆ GetEmbeddedFiles() [1/2]

const EMBEDDED_FILES * FOOTPRINT::GetEmbeddedFiles ( ) const

inline

Definition at line 1394 of file footprint.h.

References EMBEDDED_FILES::EMBEDDED_FILES().

◆ GetEmbeddedFiles() [2/2]

EMBEDDED_FILES * FOOTPRINT::GetEmbeddedFiles ( )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 1389 of file footprint.h.

References EMBEDDED_FILES::EMBEDDED_FILES().

Referenced by BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildFootprint3DShapes(), EmbedFonts(), BOARD::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), ALTIUM_PCB::HelperEmbedModel(), and idf_export_footprint().

◆ GetEmbeddedFonts()

const std::vector< wxString > * BOARD_ITEM::GetEmbeddedFonts ( )

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 460 of file board_item.cpp.

References BOARD, and GetBoard().

◆ GetExcludedFromBOMForVariant()

bool FOOTPRINT::GetExcludedFromBOMForVariant ( const wxString & aVariantName ) const

Get the exclude-from-BOM status for a specific variant.

If the variant doesn't exist, returns the default exclude-from-BOM status.

Parameters

aVariantName The variant name (empty for default).

Returns: true if excluded from BOM for the specified variant.

Definition at line 1739 of file footprint.cpp.

References GetDefaultVariantName(), FOOTPRINT_VARIANT::GetExcludedFromBOM(), GetVariant(), and IsExcludedFromBOM().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), PCB_PROPERTIES_PANEL::getItemValue(), GetMsgPanelInfo(), DIALOG_FIND_BY_PROPERTIES::getVariantAwareValue(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), ResolveTextVar(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and EDIT_TOOL::ToggleFootprintAttribute().

◆ GetExcludedFromPosFilesForVariant()

bool FOOTPRINT::GetExcludedFromPosFilesForVariant ( const wxString & aVariantName ) const

Get the exclude-from-position-files status for a specific variant.

If the variant doesn't exist, returns the default exclude-from-position-files status.

Parameters

aVariantName The variant name (empty for default).

Returns: true if excluded from position files for the specified variant.

Definition at line 1771 of file footprint.cpp.

References GetDefaultVariantName(), FOOTPRINT_VARIANT::GetExcludedFromPosFiles(), GetVariant(), and IsExcludedFromPosFiles().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), PCB_PROPERTIES_PANEL::getItemValue(), GetMsgPanelInfo(), DIALOG_FIND_BY_PROPERTIES::getVariantAwareValue(), BOARD_ADAPTER::IsFootprintShown(), ResolveTextVar(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and EDIT_TOOL::ToggleFootprintAttribute().

◆ GetExcludedFromSimForVariant()

bool FOOTPRINT::GetExcludedFromSimForVariant ( const wxString & aVariantName ) const

Get the exclude-from-simulation status for a specific variant.

If the variant doesn't exist, returns the default exclude-from-simulation status.

Parameters

aVariantName The variant name (empty for default).

Returns: true if excluded from simulation for the specified variant.

Definition at line 1755 of file footprint.cpp.

References GetDefaultVariantName(), FOOTPRINT_VARIANT::GetExcludedFromSim(), GetVariant(), and IsExcludedFromSim().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue(), PCB_PROPERTIES_PANEL::getItemValue(), GetMsgPanelInfo(), DIALOG_FIND_BY_PROPERTIES::getVariantAwareValue(), ResolveTextVar(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and EDIT_TOOL::ToggleFootprintAttribute().

◆ GetExtrudedBody() [1/2]

EXTRUDED_3D_BODY * FOOTPRINT::GetExtrudedBody ( )

inline

Definition at line 429 of file footprint.h.

References m_extrudedBody.

◆ GetExtrudedBody() [2/2]

const EXTRUDED_3D_BODY * FOOTPRINT::GetExtrudedBody ( ) const

inline

Definition at line 428 of file footprint.h.

References m_extrudedBody.

Referenced by RENDER_3D_RAYTRACE_BASE::addExtrudedBodyToRaytracer(), STEP_PCB_MODEL::AddExtrudedPins(), EXPORTER_STEP::buildFootprint3DShapes(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), GetExtrusionOutline(), and PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow().

◆ GetField() [1/3]

PCB_FIELD * FOOTPRINT::GetField ( const wxString & aFieldName ) const

Return a field in this symbol.

Parameters

aFieldName is the name of the field

Returns: is the field with aFieldName or NULL if the field does not exist.

Definition at line 917 of file footprint.cpp.

References m_fields.

◆ GetField() [2/3]

const PCB_FIELD * FOOTPRINT::GetField ( FIELD_T aFieldNdx ) const

Definition at line 899 of file footprint.cpp.

References m_fields.

◆ GetField() [3/3]

PCB_FIELD * FOOTPRINT::GetField ( FIELD_T aFieldType )

Return a mandatory field in this footprint.

The const version will return nullptr if the field doesn't exist; the non-const version will create the field and return it.

Definition at line 884 of file footprint.cpp.

References m_fields.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), SPRINT_LAYOUT_PARSER::CreateBoard(), Deserialize(), PCB_IO_EASYEDAPRO_PARSER::FillFootprintModelInfo(), PCB_IO_KICAD_SEXPR::format(), GetBoundingBox(), getFieldFunc(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), GetFieldValueForVariant(), GetFootprintDocumentationURL(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant(), PCB_FOOTPRINT_FIELD_PROPERTY::getter(), HasField(), PCB_PROPERTIES_PANEL::onKeyRenamed(), PCB_IO_EASYEDAPRO_PARSER::ParseFootprint(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseFootprint(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), Reference(), Reference(), PCB_PROPERTIES_PANEL::removeField(), ResolveTextVar(), Serialize(), PCB_FOOTPRINT_FIELD_PROPERTY::setter(), UpdateFields(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), Value(), and Value().

◆ GetFields() [1/3]

std::deque< PCB_FIELD * > & FOOTPRINT::GetFields ( )

inline

Definition at line 978 of file footprint.h.

References m_fields.

◆ GetFields() [2/3]

const std::deque< PCB_FIELD * > & FOOTPRINT::GetFields ( ) const

inline

Return a reference to the deque holding the footprint's fields.

Definition at line 977 of file footprint.h.

References m_fields.

Referenced by GetDynamicProperties(), GetFonts(), and operator==().

◆ GetFields() [3/3]

void FOOTPRINT::GetFields	(	std::vector< PCB_FIELD * > &	aVector,
		bool	aVisibleOnly ) const

Populate a std::vector with PCB_TEXTs.

Parameters

aVector	is the vector to populate.
aVisibleOnly	is used to add only the fields that are visible and contain text.

Definition at line 929 of file footprint.cpp.

References m_fields.

Referenced by COMPONENTS_MANAGER::AddComponent(), BOARD_ADAPTER::addFootprintShapes(), KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), KI_TEST::CheckFootprint(), KICAD_DIFF::CollectFootprintDiffContextItems(), SPRINT_LAYOUT_PARSER::CreateBoard(), KICAD_DIFF::PCB_DIFFER::diffFootprintChildren(), BOARD::ExchangeFootprint(), BOARD_TEXT_VAR_ADAPTER::ExtractSourceKeys(), PCB_IO_KICAD_SEXPR::format(), API_HANDLER_FOOTPRINT::handleGetItems(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FOOTPRINT_FIELDS_TABLE::LoadFieldNames(), operator==(), PCB_IO_EAGLE::orientFootprintAndText(), PCB_IO_EASYEDAPRO_PARSER::ParseFootprint(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseFootprint(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT(), pasteFootprintItemsToFootprintEditor(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), SPRINT_LAYOUT_PARSER::processPad(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), transformFPTextToPolySet(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetFieldValueForVariant()

wxString FOOTPRINT::GetFieldValueForVariant	(	const wxString &	aVariantName,
		const wxString &	aFieldName ) const

Get a field value for a specific variant.

If the variant doesn't exist or doesn't override the field, returns the default field value.

NB: variant values do NOT resolve text variable references. Any such refereneces are considered to be in schematic scope and are resolved before the footprint gets them.

Parameters

aVariantName	The variant name (empty for default).
aFieldName	The field name.

Returns: The field value for the specified variant.

Definition at line 1787 of file footprint.cpp.

References GetDefaultVariantName(), GetField(), FOOTPRINT_VARIANT::GetFieldValue(), GetVariant(), and FOOTPRINT_VARIANT::HasFieldValue().

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant(), GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_FIELD::GetShownText(), and PCB_FOOTPRINT_FIELD_PROPERTY::getter().

◆ GetFileAddedCallback()

FILE_ADDED_CALLBACK EMBEDDED_FILES::GetFileAddedCallback ( ) const

inlineinherited

Definition at line 101 of file embedded_files.h.

References m_fileAddedCallback.

Referenced by PADS_SCH_BINARY::PADS_SCH_BINARY_BUILDER::Build(), and SYMBOL_LIBRARY_MANAGER::SaveLibrary().

◆ GetFileFormatVersionAtLoad()

int FOOTPRINT::GetFileFormatVersionAtLoad ( ) const

inline

Definition at line 1176 of file footprint.h.

References m_fileFormatVersionAtLoad.

◆ GetFilters()

wxString FOOTPRINT::GetFilters ( ) const

inline

Definition at line 516 of file footprint.h.

References m_filters.

Referenced by BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetFlag()

int FOOTPRINT::GetFlag ( ) const

inline

Definition at line 564 of file footprint.h.

References m_arflag.

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

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 167 of file eda_item.h.

References m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), checkCourtyardCloses(), collidesWithArea(), PCB_TABLE::DeleteMarkedCells(), SCH_TABLE::DeleteMarkedCells(), doConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doIntersectsAreaFunc(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditCancel(), PCB_VIA_STITCH::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_VIA_STITCH::EditFinish(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::FilterCollectorForHierarchy(), findNext(), DRC_ITEM::GetViolationLayers(), hasExactNetclassFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), PAD::SetAttribute(), PCB_VIA::SetBottomLayer(), BOARD_CONNECTED_ITEM::SetLayer(), PCB_VIA::SetLayerPair(), PAD::SetLayerSet(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_VIA::SetTopLayer(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), PCB_TUNING_PATTERN::Update(), PCB_VIA_STACK::Update(), and PCB_VIA_STITCH::Update().

◆ 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_ARC, PCB_SHAPE, and PCB_TRACK.

Definition at line 355 of file eda_item.h.

References GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), and test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run().

◆ GetFontFiles()

const std::vector< wxString > * EMBEDDED_FILES::GetFontFiles ( ) const

inherited

If we just need the cached version of the font files, we can use this function which is const and will not update the font files.

Definition at line 644 of file embedded_files.cpp.

References m_fontFiles.

Referenced by SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic().

◆ GetFontMetrics()

const KIFONT::METRICS & BOARD_ITEM::GetFontMetrics ( ) const

inherited

Definition at line 169 of file board_item.cpp.

References KIFONT::METRICS::Default().

Referenced by FEATURES_MANAGER::AddText(), BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::drawDrillSymbol(), PCB_TEXT::getFontMetrics(), PCB_TEXTBOX::getFontMetrics(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ GetFonts()

std::set< KIFONT::OUTLINE_FONT * > FOOTPRINT::GetFonts ( ) const

overridevirtual

Get a list of outline fonts referenced in the footprint.

Reimplemented from EMBEDDED_FILES.

Definition at line 5401 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), fonts, KIFONT::OUTLINE_FONT::GetEmbeddingPermission(), GetFields(), GraphicalItems(), KIFONT::FONT::IsOutline(), and text.

Referenced by EmbedFonts().

◆ GetFootprint()

virtual wxString LIB_TREE_ITEM::GetFootprint ( )

inlinevirtualinherited

For items with footprint fields.

Reimplemented in LIB_SYMBOL.

Definition at line 68 of file lib_tree_item.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), DIALOG_FOOTPRINT_FIELDS_TABLE::LoadFieldNames(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ GetFootprintType()

FOOTPRINT_TYPE FOOTPRINT::GetFootprintType ( ) const

Definition at line 2132 of file footprint.cpp.

References FP_SMD, FP_THROUGH_HOLE, m_attributes, SMD, THROUGH_HOLE, and UNSPECIFIED.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), and GetTypeName().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 167 of file view_item.h.

References m_forcedTransparency.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::getRenderColor(), EDA_ITEM::operator=(), ZONE_PAINTER::PCB_PAINTER(), and LIB_SYMBOL::SetParent().

◆ GetFPID()

const LIB_ID & FOOTPRINT::GetFPID ( ) const

inline

Definition at line 473 of file footprint.h.

References m_fpid.

◆ GetFPIDAsString()

wxString FOOTPRINT::GetFPIDAsString ( ) const

inline

Definition at line 479 of file footprint.h.

References m_fpid.

Referenced by DisambiguateItemDescription(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant(), Matches(), TMATCH::COMPONENT::MatchesWith(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), testFootprintSelector(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ 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 2176 of file footprint.cpp.

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

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 415 of file board_item.cpp.

References GetParentFootprint(), and EDA_ITEM::GetPosition().

Referenced by PCB_IO_IPC2581::addLocationNode(), PCB_IO_IPC2581::addPackage(), EDA_DATA::PACKAGE::AddPin(), CHECK_SHAPE_LIBPOS_MIRROR(), PCB_IO_KICAD_SEXPR::format(), PCB_FIELDS_GRID_TABLE::GetValue(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), padNeedsUpdate(), processTextItem(), and PCB_FIELDS_GRID_TABLE::SetValue().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TABLECELL, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA_STACK, PCB_VIA_STITCH, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, SCH_PIN, SCH_RULE_AREA, SCH_SHEET_PIN, SCH_TEXT, and ZONE.

Definition at line 565 of file eda_item.cpp.

References GetTypeDesc().

Referenced by API_HANDLER_BOARD::createItemForType(), API_HANDLER_SCH::createItemForType(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), and PROPERTIES_PANEL::rebuildProperties().

◆ GetInitialComments()

const wxArrayString * FOOTPRINT::GetInitialComments ( ) const

inline

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

Definition at line 1360 of file footprint.h.

References m_initial_comments.

Referenced by PCB_IO_KICAD_SEXPR::format().

◆ GetItemDescription()

wxString FOOTPRINT::GetItemDescription	(	UNITS_PROVIDER *	aUnitsProvider,
		bool	aFull ) 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.

Parameters

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 3225 of file footprint.cpp.

References _, and GetReference().

Referenced by DisambiguateItemDescription(), and DRC_ENGINE::EvalRules().

◆ GetJumperPadGroup()

std::optional< const std::set< wxString > > FOOTPRINT::GetJumperPadGroup ( const wxString & aPadNumber ) const

Retrieves the jumper group containing the specified pad number, if one exists.

Definition at line 4000 of file footprint.cpp.

References group, and m_jumperPadGroups.

◆ GetKeywords()

wxString FOOTPRINT::GetKeywords ( ) const

inline

Definition at line 493 of file footprint.h.

References m_keywords.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), KI_TEST::CheckFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_KICAD_SEXPR::format(), LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue(), GetMsgPanelInfo(), GetSearchTerms(), Matches(), and SerializeDefinition().

◆ GetLayer()

PCB_LAYER_ID FOOTPRINT::GetLayer ( ) const

inlineoverridevirtual

Return the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Definition at line 449 of file footprint.h.

References BOARD_ITEM::m_layer.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), EXPORTER_STEP::buildFootprint3DShapes(), AR_AUTOPLACER::buildFpAreas(), CHAIN_TOPOLOGY::CHAIN_TOPOLOGY(), PCB_GRID_HELPER::computeAnchors(), BOARD::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), KICAD_DIFF::ExtractFootprintGeometry(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), FitsEnabledLayers(), Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_KICAD_SEXPR::FootprintSave(), PCB_IO_KICAD_SEXPR::format(), DSN::SPECCTRA_DB::FromSESSION(), PCB_IO_IPC2581::generateLayerSetNet(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), AR_AUTOPLACER::getOptimalFPPlacement(), GetSide(), idf_export_footprint(), IsFlipped(), PAD::IsFlipped(), LENGTH_DELAY_CALCULATION::optimiseVias(), PCB_IO_EAGLE::packagePad(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), PCB_TEXT::PCB_TEXT(), Serialize(), SetLayerAndFlip(), AR_AUTOPLACER::testFootprintOnBoard(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetLayerBoundingBox()

const BOX2I FOOTPRINT::GetLayerBoundingBox ( const LSET & aLayers ) const

Return the bounding box of the footprint on a given set of layers.

Definition at line 2383 of file footprint.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), BOARD_ITEM::GetBoard(), IsValidLayer(), m_drawings, m_pads, m_points, m_privateLayers, m_zones, BOX2< Vec >::Merge(), pad, and PCB_REFERENCE_IMAGE_T.

Referenced by PCB_SELECTION_TOOL::FilterCollectorForFootprints(), PCB_IO_EASYEDAPRO_PARSER::ParseFootprint(), and PCB_IO_EASYEDAPRO_V3_PARSER::ParseFootprint().

◆ 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 225 of file board_item.cpp.

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

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PAD, PCB_BOARD_OUTLINE, PCB_GENERATOR, PCB_GRID_ITEM, PCB_GROUP, PCB_SHAPE, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 346 of file board_item.h.

References m_layer, and UNDEFINED_LAYER.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), collidesWithArea(), PCB_GRID_HELPER::computeAnchors(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), doIntersectsAreaFunc(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), existsOnLayerFunc(), FindSnapGraphic(), FindSnapPad(), FindSnapTrack(), FitsEnabledLayers(), LAYER_UTILS::GetAllFootprintLayers(), getBoardNormalizedLayerSet(), hash_board_item(), PNS_KICAD_IFACE::IsItemVisible(), isMaskAperture(), IsOnCopperLayer(), IsSideSpecific(), ItemHasDRCViolation(), LayerMaskDescribe(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), BOARD_ITEM::ptr_cmp::operator()(), CN_VISITOR::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), ZONE_PAINTER::PCB_PAINTER(), DRC_ENGINE::ProcessAssertions(), BOARD_COMMIT::propagateDamage(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), BOARD::RemoveAllItemsOnLayer(), BOARD_INSPECTION_TOOL::reportClearance(), PCB_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), ITEM_EVAL_EXPECTATION::RunTest(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), SCOPED_LAYERSET::SCOPED_LAYERSET(), POINT_PLACER::SnapItem(), stackupNeedsUpdate(), GLOBAL_EDIT_TOOL::swapBoardItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), FOOTPRINT_EDIT_FRAME::updateEnabledLayers(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetLIB_ID()

LIB_ID FOOTPRINT::GetLIB_ID ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 483 of file footprint.h.

References m_fpid.

Referenced by GetSearchTerms().

◆ GetLibDescription()

wxString FOOTPRINT::GetLibDescription ( ) const

inline

Definition at line 490 of file footprint.h.

References m_libDescription.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), KI_TEST::CheckFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_KICAD_SEXPR::format(), GetDesc(), GetFootprintDocumentationURL(), LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue(), GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), GetSearchTerms(), Matches(), and SerializeDefinition().

◆ GetLibNickname()

wxString FOOTPRINT::GetLibNickname ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 485 of file footprint.h.

References m_fpid.

Referenced by GetMsgPanelInfo(), and GetSearchTerms().

◆ 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 2066 of file footprint.cpp.

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

Referenced by CheckFootprintAttributes().

◆ GetLink()

KIID FOOTPRINT::GetLink ( ) const

inline

Definition at line 1258 of file footprint.h.

References m_link.

Referenced by FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), FOOTPRINT_EDIT_FRAME::prepareFootprintTabHandoff(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), and FOOTPRINT_EDIT_FRAME::setupUIConditions().

◆ GetLocalClearance() [1/2]

std::optional< int > FOOTPRINT::GetLocalClearance ( ) const

inline

Definition at line 519 of file footprint.h.

References m_clearance.

Referenced by BOARD::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), GetClearanceOverrides(), and Serialize().

◆ GetLocalClearance() [2/2]

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

inline

Definition at line 577 of file footprint.h.

References _, GetReference(), and m_clearance.

◆ GetLocalSolderMaskMargin()

std::optional< int > FOOTPRINT::GetLocalSolderMaskMargin ( ) const

inline

Definition at line 522 of file footprint.h.

References m_solderMaskMargin.

Referenced by BOARD::ExchangeFootprint(), FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), and Serialize().

◆ GetLocalSolderPasteMargin()

std::optional< int > FOOTPRINT::GetLocalSolderPasteMargin ( ) const

inline

Definition at line 525 of file footprint.h.

References m_solderPasteMargin.

Referenced by BOARD::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), and Serialize().

◆ GetLocalSolderPasteMarginRatio()

std::optional< double > FOOTPRINT::GetLocalSolderPasteMarginRatio ( ) const

inline

Definition at line 528 of file footprint.h.

References m_solderPasteMarginRatio.

Referenced by BOARD::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), and Serialize().

◆ GetLocalZoneConnection()

ZONE_CONNECTION FOOTPRINT::GetLocalZoneConnection ( ) const

inline

Definition at line 532 of file footprint.h.

References m_zoneConnection.

Referenced by DRC_ENGINE::EvalRules(), BOARD::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), and Serialize().

◆ GetMaxError()

int BOARD_ITEM::GetMaxError ( ) const

inherited

Definition at line 175 of file board_item.cpp.

References ARC_HIGH_DEF, BOARD, and GetBoard().

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_ADAPTER::addShape(), BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), BOARD_ADAPTER::addText(), DSN::appendPadstackShape(), PAD::BuildEffectivePolygon(), PAD::buildEffectiveShape(), EXPORTER_STEP::buildFootprint3DShapes(), EXPORTER_STEP::buildGraphic3DShape(), ZONE::BuildSmoothedPoly(), EXPORTER_STEP::buildTrack3DShape(), FOOTPRINT::CheckNetTies(), PCB_BARCODE::ComputeTextPoly(), BOARD_ADAPTER::createLayers(), CONVERT_TOOL::CreateLines(), BOARD_ADAPTER::createPadWithMargin(), BOARD_ADAPTER::createTrackWithMargin(), PAD::doCheckPad(), KIGFX::PCB_PAINTER::draw(), PCB_TEXT::GetEffectiveShape(), PCB_SHAPE::getMaxError(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), PAD::MergePrimitivesAsPolygon(), BRDITEMS_PLOTTER::PlotShape(), process(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), CONSTRAINT_OVERLAY::render(), PNS_KICAD_IFACE_BASE::syncBarcode(), PNS_KICAD_IFACE_BASE::syncDimension(), PNS_KICAD_IFACE_BASE::syncTextItem(), ZONE::TransformSmoothedOutlineToPolygon(), and GENCAD_EXPORTER::writePadShape().

◆ 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 3244 of file footprint.cpp.

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

aFrame	is the EDA_DRAW_FRAME that displays the message panel
aList	is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 2585 of file footprint.cpp.

References _, B_Cu, BOARD_ITEM::BOARD, F_Cu, FRAME_FOOTPRINT_CHOOSER, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, BOARD_ITEM::GetBoard(), GetDefaultFieldName(), GetDNPForVariant(), GetExcludedFromBOMForVariant(), GetExcludedFromPosFilesForVariant(), GetExcludedFromSimForVariant(), GetFieldValueForVariant(), GetFPID(), GetKeywords(), GetLibDescription(), GetLibNickname(), GetNumberedPadCount(), GetOrientation(), GetSide(), IsBoardOnly(), IsLocked(), IsPlaced(), EDA_BASE_FRAME::IsType(), m_3D_Drawings, m_componentClassCacheProxy, m_fpid, m_keywords, m_libDescription, Reference(), UnescapeString(), UNTRANSLATED, and VALUE.

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

◆ GetName()

wxString FOOTPRINT::GetName ( ) const

inlineoverridevirtual

Implements LIB_TREE_ITEM.

Definition at line 484 of file footprint.h.

References m_fpid.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier(), LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue(), and GetSearchTerms().

◆ GetNetTieCache()

const std::set< int > & FOOTPRINT::GetNetTieCache ( const BOARD_ITEM * aItem ) const

inline

Get the set of net codes that are allowed to connect to a footprint item.

Definition at line 795 of file footprint.h.

References BOARD_ITEM::BOARD_ITEM(), and m_netTieCache.

Referenced by DRC_ENGINE::EvalRules(), and DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems().

◆ 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 608 of file footprint.h.

References m_netTiePadGroups.

Referenced by FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), and SerializeDefinition().

◆ 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 4563 of file footprint.cpp.

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

Referenced by CheckShortingPads(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone().

◆ GetNextFieldOrdinal()

int FOOTPRINT::GetNextFieldOrdinal ( ) const

Return the next ordinal for a user field for this footprint.

Definition at line 1006 of file footprint.cpp.

References m_fields.

Referenced by PCB_FIELD::PCB_FIELD(), and CLIPBOARD_IO::SaveSelection().

◆ GetNextPadNumber()

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

Returns: the next available pad number in the footprint.

Definition at line 3980 of file footprint.cpp.

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

Referenced by EDIT_TOOL::Duplicate().

◆ GetNumberedPadCount()

unsigned FOOTPRINT::GetNumberedPadCount ( ) const

Return the number of unique pads whose pad number represents an electrical pin.

A pad number is considered electrical if it is either purely numeric (e.g. "1", "42") or follows the BGA/alphanumeric convention of up to two letters followed by one or more digits (e.g. "A1", "B12", "AA3"). This deliberately excludes mounting-pad designators such as "MP" that carry no signal connection.

Definition at line 3012 of file footprint.cpp.

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

Referenced by GetMsgPanelInfo(), GetPinCount(), and FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList().

◆ GetOrientation()

EDA_ANGLE FOOTPRINT::GetOrientation ( ) const

inline

Definition at line 438 of file footprint.h.

References m_transform.

Referenced by COMPONENTS_MANAGER::AddComponent(), PCAD2KICAD::PCAD_ARC::AddToBoard(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), PCAD2KICAD::PCAD_PAD::AddToFootprint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), EXPORTER_STEP::buildFootprint3DShapes(), buildPadBoundingBox(), CalcPlaceholderLocalBox(), KI_TEST::CheckFootprint(), ComputeFootprintShift(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), doPushPadProperties(), KI_TEST::DrawArc(), KI_TEST::DrawSegment(), BOARD::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), GENCAD_EXPORTER::footprintWriteShape(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_FIELDS_GRID_TABLE::GetValue(), hash_fp_item(), idf_export_footprint(), PAD::ImportSettingsFrom(), PCB_IO_KICAD_LEGACY::loadFP_SHAPE(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::mapPt(), MoveAnchorPosition(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), PCB_IO_EAGLE::packageWire(), ALTIUM_PCB::ParseComponentsBodies6Data(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), pasteFootprintItemsToFootprintEditor(), Rotate(), PCB_FIELDS_GRID_TABLE::SetValue(), EDIT_TOOL::Swap(), PCB_IO_EAGLE::transferPad(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetOrientationDegrees()

double FOOTPRINT::GetOrientationDegrees ( ) const

inline

Definition at line 468 of file footprint.h.

References m_transform.

Referenced by MULTICHANNEL_TOOL::copyRuleAreaContents(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), and Serialize().

◆ GetPad()

PAD * FOOTPRINT::GetPad	(	const VECTOR2I &	aPosition,
		const 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 2950 of file footprint.cpp.

References m_pads, and pad.

◆ GetPadCount()

unsigned FOOTPRINT::GetPadCount ( ) const

Returns: the number of pads.

Definition at line 2982 of file footprint.cpp.

References m_pads.

Referenced by AR_AUTOPLACER::genModuleOnRoutingMatrix(), PCB_IO_IPC2581::pinName(), sortFootprintsByComplexity(), and AR_AUTOPLACER::testFootprintOnBoard().

◆ GetPads()

std::vector< const PAD * > FOOTPRINT::GetPads	(	const wxString &	aPadNumber,
		const PAD *	aIgnore = nullptr ) const

Definition at line 2966 of file footprint.cpp.

References m_pads, and pad.

Referenced by MULTICHANNEL_TOOL::fixupNet().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 266 of file board_item.h.

References EDA_ITEM::m_parent.

Referenced by BOOST_AUTO_TEST_CASE(), ZONE::Clone(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createTrackWithMargin(), EDIT_TOOL::DeleteItems(), DeleteStructure(), KICAD_DIFF::PCB_DIFFER::diffProperties(), doIntersectsAreaFunc(), KIGFX::PCB_PAINTER::draw(), enclosedByAreaFunc(), PCB_SELECTION_TOOL::extendTableCellSelectionTo(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), PCB_SHAPE::Flip(), getClosestGroup(), PCB_TABLECELL::GetColumn(), PCB_TABLECELL::GetColumnWidth(), PCB_SHAPE::GetLibraryBezierC1(), PCB_SHAPE::GetLibraryBezierC2(), PCB_SHAPE::GetLibraryPolyShape(), PCBEXPR_VAR_REF::GetObject(), PCB_TABLECELL::GetParentGroup(), PCB_TABLECELL::GetRow(), PCB_TABLECELL::GetRowHeight(), DRC_RTREE::Insert(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), KICAD_DIFF::PCB_DIFFER::itemRefdes(), memberOfGroupFunc(), EDIT_TOOL::MoveExact(), moveSelectionBy(), PAD::operator==(), PAD::PAD(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_BOARD_OUTLINE::PCB_BOARD_OUTLINE(), PCB_FIELD::PCB_FIELD(), PCB_FIELD::PCB_FIELD(), PCB_TABLECELL_DESC::PCB_TABLECELL_DESC(), PCB_VIA::PCB_VIA(), BRDITEMS_PLOTTER::PlotBarCode(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), SPRINT_LAYOUT_PARSER::resolveGroups(), PCB_GRID_HELPER::ResolveSnap(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), ITEM_EVAL_EXPECTATION::RunTest(), PCB_TABLECELL::SetColumnWidth(), PCB_TABLECELL::SetRowHeight(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), SwapItemData(), PCB_SHAPE::syncLibCoords(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), PCB_SELECTION_TOOL::toggleTableCellSelection(), PCB_SHAPE::transformFp(), KIGFX::PCB_VIEW::Update(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ GetParentAsString()

wxString BOARD_ITEM::GetParentAsString ( ) const

inherited

For "parent" property.

Returns: the parent footprint's ref or the parent item's UUID.

Definition at line 451 of file board_item.cpp.

References EDA_ITEM::m_parent.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 112 of file board_item.cpp.

References EDA_ITEM::findParent(), and PCB_FOOTPRINT_T.

Referenced by CN_CONNECTIVITY_ALGO::Add(), PCB_IO_IPC2581::addPad(), FEATURES_MANAGER::AddPadShape(), STEP_PCB_MODEL::AddPadShape(), PCB_CONTROL::AppendBoard(), PCB_IO_KICAD_SEXPR_PARSER::bakeTextBoxLib(), BOOST_FIXTURE_TEST_CASE(), PCB_GROUP_TOOL::canGroupItem(), CHAIN_TOPOLOGY::CHAIN_TOPOLOGY(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), collidesWithArea(), ZONE::computeBoundingBox(), computeConstraint(), PCB_BARCODE::ComputeTextPoly(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), ConstraintItemIsLocked(), CONVERT_TOOL::CreatePolys(), customPropertyFunc(), EDIT_TOOL::DeleteItems(), PCB_BARCODE::Deserialize(), doPushPadProperties(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDIT_TOOL::Duplicate(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), findOverlappingPairs(), MULTICHANNEL_TOOL::fixupNet(), PAD::Flip(), PCB_BARCODE::Flip(), PCB_POINT::Flip(), PCB_TABLE::Flip(), PCB_TEXT::Flip(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_IPC2581::generateLayerSetNet(), PCB_BARCODE::GetAngle(), ZONE::GetBoardOutline(), PAD::GetClearanceOverrides(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TEXT::GetDrawRotation(), ZONE::GetEffectiveShape(), PCB_DIMENSION_BASE::GetEnd(), GetFPRelativePosition(), PCB_SHAPE::getHatchingKnockouts(), ZONE::GetHatchLines(), ZONE::GetInteractingZones(), PAD::GetItemDescription(), PCB_FIELD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TEXT::GetItemDescription(), PCB_SHAPE::GetMenuImage(), PCB_BARCODE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PAD::GetOffset(), PAD::GetOrientation(), PAD::GetPosition(), PCB_BARCODE::GetPosition(), PAD::GetPrimaryDrillSize(), PAD::GetPrimitiveLibScale(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_FIELD::GetShownText(), PCB_TABLECELL::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), PAD::GetSize(), PAD::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), PCB_DIMENSION_BASE::GetStart(), PCB_TEXT::GetTextAngle(), PCB_TEXTBOX::GetTextAngle(), PCB_TEXT::GetTextPos(), PCB_TEXT::GetTextSize(), PCB_TEXTBOX::GetTextSize(), PCB_TEXT::GetTextThickness(), PCB_TEXTBOX::GetTextThickness(), PCB_FIELDS_GRID_TABLE::GetValue(), PCBEXPR_COMPONENT_CLASS_REF::GetValue(), PCBEXPR_VAR_REF::GetValue(), PAD::GetZoneConnectionOverrides(), PCB_SELECTION_TOOL::grabUnconnected(), hasComponentClassFunc(), hasCustomPropertyFunc(), hash_fp_item(), BOARD::HasItemsOnLayer(), PCB_SELECTION_TOOL::HasLockedDescendant(), ZONE::HitTestCutout(), ZONE::HitTestFilledArea(), ZONE::HitTestForCorner(), ZONE::HitTestForEdge(), PAD::ImportSettingsFrom(), GENERAL_COLLECTOR::Inspect(), PCB_SHAPE::IsConnected(), CONNECTIVITY_DATA::IsConnectedOnLayer(), PAD::IsFlipped(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), DRC_ENGINE::IsNetTieExclusion(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), ItemHasDRCViolation(), PCB_SELECTION_TOOL::itemPassesFilter(), DRC_TEST_PROVIDER_SOLDER_MASK::maskApertureBridgeExcluded(), memberOfFootprintFunc(), memberOfSheetFunc(), memberOfSheetOrChildrenFunc(), PCB_DIMENSION_BASE::Mirror(), ZONE::Mirror(), BOARD::Move(), PCB_BARCODE::Move(), PCB_DIMENSION_BASE::Move(), ZONE::Move(), ZONE::MoveEdge(), PCB_TEXT::Offset(), PCB_GRID_HELPER::OnBoardItemRemoved(), ARRAY_TOOL::onDialogClosed(), PAD::OnFootprintTransformed(), PCB_TEXTBOX::OnFootprintTransformed(), PCB_EDIT_FRAME::onVariantSelected(), LENGTH_DELAY_CALCULATION::optimiseVias(), padNeedsUpdate(), PCB_IO_IPC2581::pinName(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotTableBorders(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PAD_TOOL::pushPadSettings(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), PAD::rebakePrimitiveToFootprint(), PAD::Recombine(), PCB_POINT::recomputePosition(), DRC_TEST_PROVIDER_SOLDER_MASK::recordMaskAperture(), refOfSolid(), BOARD::RemoveAllItemsOnLayer(), DRC_TEST_PROVIDER_SOLDER_MASK::reportMaskApertureBridges(), PCB_IO_KICAD_SEXPR_PARSER::resolveConstraints(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), PCB_GRID_HELPER::ResolveSnap(), BOARD_COMMIT::Revert(), PCB_BARCODE::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXTBOX::Rotate(), ZONE::Rotate(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PAD::SameLogicalPadAs(), CLIPBOARD_IO::SaveSelection(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_SELECTION_TOOL::Selectable(), PCB_EDIT_FRAME::SendCrossProbeItem(), PAD::Serialize(), PCB_BARCODE::Serialize(), PCB_DIMENSION_BASE::Serialize(), PCB_GROUP::Serialize(), PCB_POINT::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), PCB_SHAPE::Serialize(), PCB_TABLE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), ZONE::Serialize(), SetDimensionValueMode(), PCB_DIMENSION_BASE::SetEnd(), PAD::SetFPRelativeOrientation(), SetFPRelativePosition(), PAD::SetOffset(), PAD::SetOrientation(), PAD::SetPosition(), PCB_POINT::SetPosition(), PAD::SetPrimaryDrillSize(), PAD::SetSize(), PCB_DIMENSION_BASE::SetStart(), PCB_TEXT::SetTextAngle(), PCB_TEXT::SetTextSize(), PCB_TEXTBOX::SetTextSize(), PCB_TEXT::SetTextThickness(), PCB_TEXTBOX::SetTextThickness(), PCB_FIELDS_GRID_TABLE::SetValue(), PAD::SharesNetTieGroup(), BOARD_COMMIT::Stage(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), PCB_TEXTBOX::syncLibCoords(), PNS_KICAD_IFACE_BASE::syncZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testGraphicClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PCB_IO_EAGLE::transferPad(), PCB_SHAPE::transformFp(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), PCB_POINT_EDITOR::updateItem(), PAD::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TEXT::ViewGetLayers(), PCB_TEXTBOX::ViewGetLayers(), PCB_FIELD::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and ZONE::ZONE().

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, and SCH_TABLECELL.

Definition at line 116 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), EDIT_TOOL::DeleteItems(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), EDIT_TOOL::doMoveSelection(), BOARD_ITEM::Duplicate(), PCB_TABLE::Duplicate(), SCH_ITEM::Duplicate(), BOARD::ExchangeFootprint(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), TRACKS_CLEANER::filterItem(), MULTICHANNEL_TOOL::GeneratePotentialRuleAreas(), GENERATOR_TOOL::GENERATOR_TOOL(), getClosestGroup(), getClosestGroup(), PCB_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetParentGroup(), GetParentGroupId(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), SCH_MOVE_TOOL::initializeMoveOperation(), isExpandableMicrovia(), isInTuningPattern(), BOARD_ITEM::IsLocked(), SCH_ITEM::IsLocked(), PCB_SELECTION_TOOL::isWithinEnteredGroup(), memberOfGroupFunc(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD::Move(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), BOARD::Remove(), PNS_KICAD_IFACE::RemoveItem(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), COMMIT::Stage(), BOARD_ITEM::SwapItemData(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), BOARD_NETLIST_UPDATER::updateGroups(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), PCB_GROUP::WithinScope(), and SCH_GROUP::WithinScope().

◆ GetParentGroupId()

KIID EDA_ITEM::GetParentGroupId ( ) const

inherited

Definition at line 232 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

Referenced by ITEM_PICKER::SetItem(), and ITEM_PICKER::SetLink().

◆ GetPath()

const KIID_PATH & FOOTPRINT::GetPath ( ) const

inline

Definition at line 496 of file footprint.h.

References m_path.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), PCB_SELECTION_TOOL::selectSameSheet(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetPinCount()

int FOOTPRINT::GetPinCount ( )

inlineoverridevirtual

The pin count for symbols or the unique pad count for footprints.

Reimplemented from LIB_TREE_ITEM.

Definition at line 487 of file footprint.h.

References GetNumberedPadCount().

◆ GetPosition()

VECTOR2I FOOTPRINT::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 435 of file footprint.h.

References m_transform.

◆ GetPrivateLayers()

LSET FOOTPRINT::GetPrivateLayers ( ) const

inline

Definition at line 344 of file footprint.h.

References m_privateLayers.

Referenced by KIGFX::PCB_PAINTER::Draw(), PCB_IO_KICAD_SEXPR::format(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), SerializeDefinition(), and TransformFPShapesToPolySet().

◆ GetReference()

const wxString & FOOTPRINT::GetReference ( ) const

inline

Returns: reference designator text.

Definition at line 901 of file footprint.h.

References EDA_TEXT::GetText(), and Reference().

Referenced by COMPONENTS_MANAGER::AddComponent(), TMATCH::CONNECTION_GRAPH::AddFootprint(), AR_AUTOPLACER::AutoplaceFootprints(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), EXPORTER_STEP::buildFootprint3DShapes(), PCB_IO_PADS_BINARY::buildPad(), KI_TEST::CheckFootprint(), CollisionMatchesExpected(), compareFootprintsbyRef(), PCB_IO_IPC2581::componentName(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper(), ALTIUM_PCB::ConvertPads6ToFootprintItemOnNonCopper(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItem(), MULTICHANNEL_TOOL::copyRuleAreaContents(), PCB_BASE_FRAME::CreateNewFootprint(), EDIT_TOOL::doMoveSelection(), BOARD_TEXT_VAR_ADAPTER::ExtractSourceKeys(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), GetExtrusionOutline(), GetItemDescription(), PAD::GetItemDescription(), PCB_FIELD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), GetLocalClearance(), PAD::GetMsgPanelInfo(), PCB_BARCODE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), CADSTAR_PCB_ARCHIVE_LOADER::getPadReference(), GetReferenceAsString(), GENCAD_EXPORTER::getShapeName(), GetZoneConnectionOverrides(), IncrementReference(), InvalidMatchesExpected(), IsAnnotated(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), PCB_IO_EAGLE::loadElements(), CADSTAR_PCB_ARCHIVE_LOADER::loadNets(), EDA_3D_CANVAS::OnLeftUp(), EDA_3D_CANVAS::OnMouseMove(), PCB_IO_EAGLE::packageText(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), PromptConnectedPadDecision(), refOfSolid(), BOARD_NETLIST_UPDATER::replaceFootprint(), CLIPBOARD_IO::SaveSelection(), PCB_EDIT_FRAME::SendCrossProbeItem(), testFootprintSelector(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DIALOG_MULTICHANNEL_REPEAT_LAYOUT::TransferDataToWindow(), BOARD_NETLIST_UPDATER::updateComponentClass(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateComponentUnits(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and FOOTPRINT_EDIT_FRAME::updateInfoBar().

◆ GetReferenceAsString()

wxString FOOTPRINT::GetReferenceAsString ( ) const

inline

Definition at line 910 of file footprint.h.

References GetReference().

Referenced by STEP_PCB_MODEL::AddPadShape(), TMATCH::CONNECTION_GRAPH::breakTie(), TMATCH::CONNECTION_GRAPH::breakTieBySymbolUuid(), TMATCH::checkCandidateNetConsistency(), TMATCH::CONNECTION_GRAPH::findMatchingComponents(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier(), TMATCH::PIN::IsIsomorphic(), and TMATCH::COMPONENT::MatchesWith().

◆ GetRolloverPos()

VECTOR2I EDA_ITEM::GetRolloverPos ( ) const

inlineinherited

Definition at line 143 of file eda_item.h.

References m_rolloverPos.

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

◆ GetScaleX()

double FOOTPRINT::GetScaleX ( ) const

inline

Definition at line 455 of file footprint.h.

References m_transform.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ GetScaleY()

double FOOTPRINT::GetScaleY ( ) const

inline

Definition at line 456 of file footprint.h.

References m_transform.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ GetSearchTerms()

std::vector< SEARCH_TERM > & FOOTPRINT::GetSearchTerms ( )

overridevirtual

Implements LIB_TREE_ITEM.

Definition at line 2155 of file footprint.cpp.

References Format(), GetKeywords(), GetLIB_ID(), GetLibDescription(), GetLibNickname(), GetName(), and m_searchTerms.

Referenced by FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList().

◆ GetSheetfile()

wxString FOOTPRINT::GetSheetfile ( ) const

inline

Definition at line 513 of file footprint.h.

References m_sheetfile.

Referenced by BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetSheetname()

wxString FOOTPRINT::GetSheetname ( ) const

inline

Definition at line 510 of file footprint.h.

References m_sheetname.

Referenced by BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), memberOfSheetFunc(), memberOfSheetOrChildrenFunc(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetSide()

PCB_LAYER_ID FOOTPRINT::GetSide ( ) const

Use instead of IsFlipped() when you also need to account for unsided footprints (those purely on user-layers, etc.).

Definition at line 2675 of file footprint.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), BOARD_ITEM::GetBoard(), GetLayer(), IsValidLayer(), m_drawings, m_pads, m_zones, pad, LSET::SideSpecificMask(), and UNDEFINED_LAYER.

Referenced by GetBoundingBox(), GetMsgPanelInfo(), GENERAL_COLLECTOR::Inspect(), and COMPONENT_CLASS_ASSIGNMENT_RULE::Matches().

◆ 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 364 of file eda_item.h.

References GetPosition().

◆ GetStackupLayers()

const LSET & FOOTPRINT::GetStackupLayers ( ) const

inline

Definition at line 548 of file footprint.h.

References m_stackupLayers.

Referenced by footprintVsBoardStackup(), PCB_IO_KICAD_SEXPR::format(), and FOOTPRINT_EDIT_FRAME::updateEnabledLayers().

◆ GetStackupMode()

FOOTPRINT_STACKUP FOOTPRINT::GetStackupMode ( ) const

inline

Definition at line 541 of file footprint.h.

References m_stackupMode.

Referenced by FixUpPadsForBoard(), footprintVsBoardStackup(), PCB_IO_KICAD_SEXPR::format(), DIALOG_RULE_AREA_PROPERTIES::OnLayerSelection(), stackupNeedsUpdate(), and FOOTPRINT_EDIT_FRAME::updateEnabledLayers().

◆ GetStaticComponentClass()

const COMPONENT_CLASS * FOOTPRINT::GetStaticComponentClass ( ) const

Returns the component class for this footprint.

Definition at line 5458 of file footprint.cpp.

References m_componentClassCacheProxy.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), PCB_IO_KICAD_SEXPR::format(), and BOARD_NETLIST_UPDATER::updateComponentClass().

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 155 of file board_item.cpp.

References DEFAULT_LINE_WIDTH, KIGFX::VIEW_ITEM::GetClass(), and pcbIUScale.

Referenced by CONVERT_TOOL::CreatePolys().

◆ GetSubUnitCount()

virtual int LIB_TREE_ITEM::GetSubUnitCount ( ) const

inlinevirtualinherited

For items with units, return the number of units.

Reimplemented in LIB_SYMBOL.

Definition at line 78 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 183 of file eda_item.h.

References CANDIDATE, CONNECTIVITY_CANDIDATE, IS_LINKED, m_flags, SELECTED_BY_DRAG, SELECTION_CANDIDATE, and SKIP_STRUCT.

Referenced by ClearTempFlags(), and SCH_ITEM::SwapFlags().

◆ GetTemporaryFileName() [1/2]

wxFileName EMBEDDED_FILES::GetTemporaryFileName ( const wxString & aName ) const

inherited

Definition at line 599 of file embedded_files.cpp.

References PATHS::EnsurePathExists(), PATHS::GetUserCachePath(), and m_files.

Referenced by UpdateFontFiles().

◆ GetTemporaryFileName() [2/2]

wxFileName EMBEDDED_FILES::GetTemporaryFileName ( EMBEDDED_FILE * aFile ) const

inherited

◆ GetTransform()

const TRANSFORM_TRS & FOOTPRINT::GetTransform ( ) const

inline

◆ GetTransientComponentClassNames()

const std::unordered_set< wxString > & FOOTPRINT::GetTransientComponentClassNames ( )

inline

Gets the transient component class names.

Definition at line 1438 of file footprint.h.

References m_transientComponentClassNames.

Referenced by PCB_CONTROL::Paste().

◆ 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 556 of file eda_item.cpp.

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

Referenced by EDIT_TOOL::doMoveSelection(), and GetFriendlyName().

◆ GetTypeName()

wxString FOOTPRINT::GetTypeName ( ) const

Get the type of footprint.

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

Definition at line 2120 of file footprint.cpp.

References _, GetFootprintType(), SMD, and THROUGH_HOLE.

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

◆ GetUniquePadNumbers()

std::set< wxString > FOOTPRINT::GetUniquePadNumbers ( ) const

A complex pad can be built with many pads having the same pad name to create a complex shape or fragmented solder paste areas.

Returns: the names of the unique, non-blank pads.

Definition at line 2988 of file footprint.cpp.

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

◆ GetUnitInfo()

const std::vector< FP_UNIT_INFO > & FOOTPRINT::GetUnitInfo ( ) const

inline

Definition at line 1017 of file footprint.h.

References m_unitInfo.

Referenced by GATE_SWAP_MENU::EqualPinCounts(), GATE_SWAP_MENU::eventHandler(), PCB_IO_KICAD_SEXPR::format(), GATE_SWAP_MENU::GetCompatibleTargets(), GATE_SWAP_MENU::GetSingleEligibleFootprint(), GATE_SWAP_MENU::GetUnitsHitIndices(), EDIT_TOOL::SwapGateNets(), GATE_SWAP_MENU::update(), and BOARD_NETLIST_UPDATER::updateComponentUnits().

◆ GetUnitName()

virtual wxString LIB_TREE_ITEM::GetUnitName ( int aUnit ) const

inlinevirtualinherited

For items with units, return an identifier for unit x.

Reimplemented in LIB_SYMBOL.

Definition at line 83 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ GetValue()

const wxString & FOOTPRINT::GetValue ( ) const

inline

Returns: the value text.

Definition at line 925 of file footprint.h.

References EDA_TEXT::GetText(), and Value().

Referenced by TMATCH::CONNECTION_GRAPH::breakTieByValue(), KI_TEST::CheckFootprint(), GENCAD_EXPORTER::createDevicesSection(), PCB_BASE_FRAME::CreateNewFootprint(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), BOARD::ExchangeFootprint(), GetValueAsString(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), PCB_IO_EAGLE::loadElements(), EDA_3D_CANVAS::OnMouseMove(), PCB_IO_EAGLE::packageText(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), CLIPBOARD_IO::SaveSelection(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetValueAsString()

wxString FOOTPRINT::GetValueAsString ( ) const

inline

Definition at line 933 of file footprint.h.

References GetValue().

◆ GetVariant() [1/2]

FOOTPRINT_VARIANT * FOOTPRINT::GetVariant ( const wxString & aVariantName )

Get a mutable variant by name.

Parameters

aVariantName The name of the variant.

Returns: Pointer to the variant, or nullptr if not found.

Definition at line 1628 of file footprint.cpp.

References m_variants.

◆ GetVariant() [2/2]

const FOOTPRINT_VARIANT * FOOTPRINT::GetVariant ( const wxString & aVariantName ) const

Get a variant by name.

Parameters

aVariantName The name of the variant.

Returns: Pointer to the variant, or nullptr if not found.

Definition at line 1620 of file footprint.cpp.

References m_variants.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GetDNPForVariant(), GetExcludedFromBOMForVariant(), GetExcludedFromPosFilesForVariant(), GetExcludedFromSimForVariant(), GetFieldValueForVariant(), PCB_FIELD::GetShownText(), EDIT_TOOL::ToggleFootprintAttribute(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ GetVariants()

const CASE_INSENSITIVE_MAP< FOOTPRINT_VARIANT > & FOOTPRINT::GetVariants ( ) const

inline

Get all variants.

Returns: Map of variant name to variant data.

Definition at line 1119 of file footprint.h.

References m_variants.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PCB_IO_KICAD_SEXPR::format().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 133 of file board_item.h.

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

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), GROUP_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), ZONE_SEARCH_HANDLER::getResultCell(), SetY(), and ZONE_DESC::ZONE_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 139 of file board_item.h.

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

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), GROUP_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), ZONE_SEARCH_HANDLER::getResultCell(), SetX(), and ZONE_DESC::ZONE_DESC().

◆ GetZoneConnectionOverrides()

ZONE_CONNECTION FOOTPRINT::GetZoneConnectionOverrides ( wxString * aSource ) const

inline

Definition at line 596 of file footprint.h.

References _, GetReference(), INHERITED, and m_zoneConnection.

◆ GraphicalItems() [1/2]

DRAWINGS & FOOTPRINT::GraphicalItems ( )

inline

Definition at line 407 of file footprint.h.

References m_drawings.

◆ GraphicalItems() [2/2]

const DRAWINGS & FOOTPRINT::GraphicalItems ( ) const

inline

Definition at line 408 of file footprint.h.

References m_drawings.

◆ Groups() [1/2]

GROUPS & FOOTPRINT::Groups ( )

inline

Definition at line 413 of file footprint.h.

References m_groups.

Referenced by KI_TEST::CheckFootprint(), DeserializeDefinition(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), API_HANDLER_FOOTPRINT::handleGetItems(), operator=(), and pasteFootprintItemsToFootprintEditor().

◆ Groups() [2/2]

const GROUPS & FOOTPRINT::Groups ( ) const

inline

Definition at line 414 of file footprint.h.

References m_groups.

◆ HasCustomProperties()

bool EDA_ITEM::HasCustomProperties ( ) const

inlineinherited

Definition at line 269 of file eda_item.h.

References m_customProperties.

Referenced by KICAD_FORMAT::FormatCustomProperties().

◆ HasDrilledHole()

virtual bool BOARD_ITEM::HasDrilledHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 212 of file board_item.h.

Referenced by PNS_PCBNEW_RULE_RESOLVER::IsDrilledHole(), and BOARD_INSPECTION_TOOL::reportClearance().

◆ HasExtrudedBody()

bool FOOTPRINT::HasExtrudedBody ( ) const

inline

Definition at line 427 of file footprint.h.

References m_extrudedBody.

Referenced by EXPORTER_STEP::buildFootprint3DShapes(), BOARD::ExchangeFootprint(), and PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow().

◆ HasField()

bool FOOTPRINT::HasField ( const wxString & aFieldName ) const

Definition at line 911 of file footprint.cpp.

References GetField().

Referenced by PCB_PROPERTIES_PANEL::addBlankField(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ HasFile()

bool EMBEDDED_FILES::HasFile ( const wxString & name ) const

inlineinherited

Definition at line 171 of file embedded_files.h.

References m_files, and name.

Referenced by AddFile(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PANEL_EMBEDDED_FILES::TransferDataFromWindow().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 168 of file eda_item.h.

References m_flags.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), BOOST_AUTO_TEST_CASE(), BOARD::BulkRemoveStaleTeardrops(), GRAPHICS_CLEANER::cleanupShapes(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_MOVE_TOOL::findTargetSheet(), PCB_TUNING_PATTERN::Flip(), SYMBOL_EDIT_FRAME::freeTransientUndoCommands(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_SCREEN::MarkConnections(), PCB_TUNING_PATTERN::Mirror(), PCB_TUNING_PATTERN::Move(), MoveSchematicItem(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_MOVE_TOOL::performItemMove(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), GERBVIEW_FRAME::RemapLayers(), PCB_TUNING_PATTERN::Rotate(), SCH_EDIT_TOOL::Rotate(), ISSUE22864_FIXTURE::RunAlignmentAndVerify(), ISSUE22864_FIXTURE::RunAlignmentAndVerifyNoSkew(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), SCH_SELECTION_TOOL::SelectMultiple(), SCH_COMMIT::Stage(), TRACKS_CLEANER::testTrackEndpointIsNode(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and PCB_TUNING_PATTERN::ViewDraw().

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 207 of file board_item.h.

Referenced by DRC_ENGINE::EvalRules(), DRC_RTREE::Insert(), ItemHasDRCViolation(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_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::testSingleLayerItemAgainstItem(), PCB_CONTROL::UpdateMessagePanel(), and PCB_TRACK::ViewBBox().

◆ 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 297 of file board_item.h.

Referenced by CONVERT_TOOL::CreatePolys().

◆ HasSelectedAncestorGroup()

bool EDA_ITEM::HasSelectedAncestorGroup ( ) const

inherited

Returns: true if any ancestor group (recursively) of this item is currently selected. Group members do not carry the SELECTED flag themselves, so callers that need to know whether an item is moving as part of a group selection should use this helper.

Definition at line 241 of file eda_item.cpp.

References EDA_ITEM(), and group.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_MOVE_TOOL::getConnectedDragItems().

◆ HasThroughHolePads()

bool FOOTPRINT::HasThroughHolePads ( ) const

Definition at line 4894 of file footprint.cpp.

References pad, Pads(), and SMD.

◆ HasVariant()

bool FOOTPRINT::HasVariant ( const wxString & aVariantName ) const

Check if a variant exists.

Parameters

aVariantName The name of the variant.

Returns: true if the variant exists.

Definition at line 1717 of file footprint.cpp.

References m_variants.

◆ HitTest() [1/3]

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 2818 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), BOX2< Vec >::Contains(), GetBoundingBox(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), m_drawings, m_pads, m_points, m_zones, pad, and PCB_TEXT_T.

◆ HitTest() [2/3]

bool FOOTPRINT::HitTest	(	const SHAPE_LINE_CHAIN &	aPoly,
		bool	aContained ) const

overridevirtual

Test if aPoly intersects this item.

Parameters

aPoly	A reference to a SHAPE_LINE_CHAIN object containing the polygon or polyline to test.
aContained	Set to true to test for containment instead of an intersection.

Returns: True if aPoly contains or intersects the item.

Reimplemented from EDA_ITEM.

Definition at line 2875 of file footprint.cpp.

References KIGEOM::BoxHitTest(), GetBoundingBox(), m_drawings, m_pads, m_zones, and PCB_TEXT_T.

◆ HitTest() [3/3]

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 2805 of file footprint.cpp.

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 2812 of file footprint.cpp.

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

Referenced by GENERAL_COLLECTOR::Inspect().

◆ HitTestOnLayer() [1/2]

bool FOOTPRINT::HitTestOnLayer	(	const BOX2I &	aRect,
		bool	aContained,
		PCB_LAYER_ID	aLayer,
		int	aAccuracy = 0 ) const

Definition at line 2764 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), m_drawings, m_pads, m_zones, pad, and PCB_TEXT_T.

◆ HitTestOnLayer() [2/2]

bool FOOTPRINT::HitTestOnLayer	(	const VECTOR2I &	aPosition,
		PCB_LAYER_ID	aLayer,
		int	aAccuracy = 0 ) const

Test if the point hits one or more of the footprint elements on a given layer.

Parameters

aPosition	is the point to test
aAccuracy	is the hit test accuracy
aLayer	is the layer to test

Returns: true if aPosition hits a footprint element on aLayer

Definition at line 2737 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), m_drawings, m_pads, m_zones, pad, and PCB_TEXT_T.

Referenced by PCB_SELECTION_TOOL::FilterCollectorForFootprints().

◆ IncrementFlag()

void FOOTPRINT::IncrementFlag ( )

inline

Definition at line 563 of file footprint.h.

References m_arflag.

◆ IncrementReference()

void FOOTPRINT::IncrementReference ( int aDelta )

Bump the current reference by aDelta.

Definition at line 4040 of file footprint.cpp.

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

◆ InvalidateComponentClassCache()

void FOOTPRINT::InvalidateComponentClassCache ( ) const

Forces deferred (on next access) recalculation of the component class for this footprint.

Definition at line 5494 of file footprint.cpp.

References m_componentClassCacheProxy.

Referenced by PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ InvalidateGeometryCaches()

void FOOTPRINT::InvalidateGeometryCaches ( )

Resets the caches for this footprint, for example if it was modified via the API.

Definition at line 1412 of file footprint.cpp.

References m_courtyard_cache, m_courtyard_cache_mutex, m_geometry_cache, and m_geometry_cache_mutex.

Referenced by Add(), Remove(), and UpdateFields().

◆ IsAnnotated()

bool FOOTPRINT::IsAnnotated ( ) const

inline

Definition at line 920 of file footprint.h.

References GetReference().

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 98 of file view_item.h.

References m_isBOARD_ITEM.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_GROUP_TOOL::canGroupItem(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), EDA_ITEM::EDA_ITEM(), PCB_BASE_FRAME::FocusOnItem(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), KIGFX::PCB_PAINTER::HasUniformColor(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD::Move(), PCB_GRID_HELPER::nearestAnchor(), PCB_GRID_HELPER::OnBoardItemRemoved(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), PCB_GRID_HELPER::ResolveSnap(), GRAPHIC_EDIT_TOOL::runInteractive(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::SelectAll(), PCB_EDIT_FRAME::SetPageSettings(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), BOARD_COMMIT::Stage(), EDIT_TOOL::Swap(), BOARD_COMMIT::undoLevelItem(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::UnselectAll(), KIGFX::PCB_VIEW::Update(), KIGFX::PCB_VIEW::UpdateCollidingItems(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ IsBoardOnly()

bool FOOTPRINT::IsBoardOnly ( ) const

inline

Definition at line 1019 of file footprint.h.

References FP_BOARD_ONLY, and m_attributes.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), GetMsgPanelInfo(), and Serialize().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

References BRIGHTENED, m_flags, and m_netHighlighted.

◆ IsConflicting()

bool FOOTPRINT::IsConflicting ( ) const

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

Definition at line 1424 of file footprint.cpp.

References COURTYARD_CONFLICT, and EDA_ITEM::HasFlag().

Referenced by KIGFX::PCB_PAINTER::draw(), 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, PCB_SHAPE, and ZONE.

Definition at line 172 of file board_item.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), hasExactNetclassFunc(), hasNetChainFunc(), hasNetclassFunc(), inDiffPairFunc(), inNetChainClassFunc(), inNetChainFunc(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), ZONE_PAINTER::PCB_PAINTER(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testGraphicClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

◆ IsDNP()

bool FOOTPRINT::IsDNP ( ) const

inline

Definition at line 1055 of file footprint.h.

References FP_DNP, and m_attributes.

Referenced by AddVariant(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_KICAD_SEXPR::format(), GetDNPForVariant(), and Serialize().

◆ IsEmpty()

bool EMBEDDED_FILES::IsEmpty ( ) const

inlineinherited

Definition at line 178 of file embedded_files.h.

References m_files.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_SYMBOL::Flatten(), FootprintChainBridgingLength(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), LIB_SYMBOL::GetDescription(), and API_HANDLER_SCH::handleGetCurrentVariant().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 135 of file eda_item.h.

References ENTERED, and m_flags.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), and KIGFX::SCH_PAINTER::draw().

◆ IsExcludedFromBOM()

bool FOOTPRINT::IsExcludedFromBOM ( ) const

inline

Definition at line 1037 of file footprint.h.

References FP_EXCLUDE_FROM_BOM, and m_attributes.

Referenced by AddVariant(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_KICAD_SEXPR::format(), GetExcludedFromBOMForVariant(), and Serialize().

◆ IsExcludedFromPosFiles()

bool FOOTPRINT::IsExcludedFromPosFiles ( ) const

inline

Definition at line 1028 of file footprint.h.

References FP_EXCLUDE_FROM_POS_FILES, and m_attributes.

Referenced by AddVariant(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_KICAD_SEXPR::format(), GetExcludedFromPosFilesForVariant(), and Serialize().

◆ IsExcludedFromSim()

bool FOOTPRINT::IsExcludedFromSim ( ) const

inline

Definition at line 1046 of file footprint.h.

References FP_EXCLUDE_FROM_SIM, and m_attributes.

Referenced by AddVariant(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO_KICAD_SEXPR::format(), GetExcludedFromSimForVariant(), and Serialize().

◆ 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 660 of file footprint.h.

References B_Cu, and GetLayer().

Referenced by COMPONENTS_MANAGER::AddComponent(), RENDER_3D_RAYTRACE_BASE::addExtrudedBodyToRaytracer(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), EDA_DATA::AddPackage(), FEATURES_MANAGER::AddPadShape(), RENDER_3D_RAYTRACE_BASE::addPlaceholderToRaytracer(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ComputeFootprintShift(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), FootprintNeedsUpdate(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), GetExtrusionOutline(), intersectsBackCourtyardFunc(), intersectsFrontCourtyardFunc(), isOppositeSideSilk(), ALTIUM_PCB::ParseComponentsBodies6Data(), BOARD_EDITOR_CONTROL::PlaceFootprint(), RENDER_3D_OPENGL::renderPlaceholderForFootprint(), and EDIT_TOOL::Swap().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 233 of file eda_item.h.

References m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_FIELD::Plot(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ IsGroupableType()

bool BOARD_ITEM::IsGroupableType ( ) const

inherited

◆ IsIndexedInBoard()

bool BOARD_ITEM::IsIndexedInBoard ( ) const

inlineinherited

Definition at line 419 of file board_item.h.

References m_boardCacheOwner.

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Reimplemented in PCB_BARCODE.

Definition at line 413 of file board_item.h.

References m_isKnockout.

Referenced by FEATURES_MANAGER::AddText(), BOARD_ADAPTER::addText(), BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_TEXT::GetBoundingBox(), PCB_TEXT::GetEffectiveShape(), PCB_FIELDS_GRID_TABLE::GetValueAsBool(), PCB_BARCODE::IsKnockout(), PCB_TEXT_DESC::PCB_TEXT_DESC(), PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), processTextItem(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TEXT::TextHitTest(), PCB_TEXT::TextHitTest(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ IsLayerAgnostic()

bool FOOTPRINT::IsLayerAgnostic ( ) const

inlineoverridevirtual

Check if this item's layer set must not be confined to a board's enabled layers.

A container's layer set is its members', and those are confined individually; a footprint's children come from a library that knows no board's layers and must survive those layers being re-enabled; a geometric constraint has no layer at all. Masking any of them would corrupt the item. Whether the board accepts it at all is FitsEnabledLayers. A footprint's children may sit on layers this board has disabled; masking them off would break the footprint and lose the contents when those layers are re-enabled.

Reimplemented from BOARD_ITEM.

Definition at line 688 of file footprint.h.

◆ 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 3393 of file footprint.cpp.

References StringLibNameInvalidChars().

Referenced by DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::checkFootprintName().

◆ IsLocked()

bool FOOTPRINT::IsLocked ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 680 of file footprint.h.

References FP_is_LOCKED, and m_fpStatus.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), BOOST_AUTO_TEST_CASE(), ConstraintItemIsLocked(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), itemIsIncludedByFilter(), BOARD_NETLIST_UPDATER::replaceFootprint(), and Serialize().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 130 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsNetHighlighted()

bool EDA_ITEM::IsNetHighlighted ( ) const

inherited

Net highlighting must not clear brightening owned by find or picker tools.

Definition at line 125 of file eda_item.cpp.

References m_netHighlighted.

Referenced by KIGFX::SCH_PAINTER::draw(), and setNetHighlight().

◆ IsNetTie()

bool FOOTPRINT::IsNetTie ( ) const

inline

Definition at line 566 of file footprint.h.

References group, and m_netTiePadGroups.

Referenced by PCB_IO_KICAD_SEXPR::format(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), DRC_ENGINE::IsNetTieExclusion(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), DIALOG_FOOTPRINT_CHECKER::runChecks(), PAD::SharesNetTieGroup(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References IS_NEW, and m_flags.

Referenced by SCH_MOVE_TOOL::checkMoveInProgress(), SCH_EDIT_TOOL::CycleBodyStyle(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PCB_TUNING_PATTERN::EditStart(), PCB_VIA_STACK::EditStart(), PCB_VIA_STITCH::EditStart(), SCH_MOVE_TOOL::finalizeMoveOperation(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_MOVE_TOOL::initializeMoveOperation(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_POINT_EDITOR::Main(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_SELECTION_TOOL::select(), COMMIT::Unstage(), PCB_TUNING_PATTERN::Update(), and PCB_TUNING_PATTERN::ViewDraw().

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

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

Reimplemented in PAD, PCB_GROUP, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 189 of file board_item.h.

References GetLayer(), GetLayerSet(), IsCopperLayer(), IsSingleLayerType(), and EDA_ITEM::Type().

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::CheckNetTies(), DRC_ENGINE::EvalRules(), PCB_SHAPE::GetItemDescription(), PCB_SHAPE::GetMsgPanelInfo(), PCB_SHAPE::IsConnected(), isCopper(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), ZONE_PAINTER::PCB_PAINTER(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), PCB_SHAPE::SetLayer(), BOARD_CONNECTED_ITEM::SetNetCode(), shapeNeedsUpdate(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::UpdateMessagePanel(), and PCB_SHAPE::ViewGetLayers().

◆ IsOnLayer()

bool FOOTPRINT::IsOnLayer ( PCB_LAYER_ID aLayer ) const

overridevirtual

Test to see if this object is on the given layer.

Virtual so objects like PAD, which reside on multiple layers can do their own form of testing.

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 2706 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), m_drawings, m_fields, m_pads, m_zones, and pad.

Referenced by PCB_IO_EASYEDAPRO_PARSER::ParseFootprint(), and PCB_IO_EASYEDAPRO_V3_PARSER::ParseFootprint().

◆ IsPlaced()

bool FOOTPRINT::IsPlaced ( ) const

inline

Definition at line 716 of file footprint.h.

References FP_is_PLACED, and m_fpStatus.

Referenced by PCB_IO_KICAD_SEXPR::format(), and GetMsgPanelInfo().

◆ IsPowerSymbol()

virtual bool LIB_TREE_ITEM::IsPowerSymbol ( ) const

inlinevirtualinherited

For symbols that could be a power symbol.

Reimplemented in LIB_SYMBOL.

Definition at line 63 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ 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 SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 520 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References m_isRollover.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), and SCH_ITEM::HasHoveredHypertext().

◆ IsRoot()

virtual bool LIB_TREE_ITEM::IsRoot ( ) const

inlinevirtualinherited

For items having aliases, IsRoot() indicates the principal item.

Reimplemented in LIB_SYMBOL.

Definition at line 60 of file lib_tree_item.h.

Referenced by LIB_TREE_NODE_ITEM::LIB_TREE_NODE_ITEM(), and LIB_TREE_NODE_ITEM::Update().

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 97 of file view_item.h.

References m_isSCH_ITEM.

Referenced by SCH_GROUP_TOOL::canGroupItem(), KIGFX::SCH_VIEW::DisplaySheet(), EDA_ITEM::EDA_ITEM(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_PROPERTIES_PANEL::getPropertyFromEvent(), EE_GRID_HELPER::ResolveSnap(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), and KIGFX::SCH_VIEW::Update().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 134 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 235 of file board_item.cpp.

References BOARD, GetBoard(), GetLayerSet(), LT_BACK, LT_FRONT, m_layer, and LSET::SideSpecificMask().

Referenced by PCB_BARCODE::AssembleBarcode(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), and PCB_DIMENSION_BASE::Mirror().

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

Checks if the given object is tented (its copper shape is covered by solder mask) on a given side of the board.

Parameters

aLayer is the layer to check tenting mode for: F_Cu and F_Mask are treated identically as are B_Cu and B_Mask

Returns: true if the object is tented on the given side

Reimplemented in PCB_VIA.

Definition at line 224 of file board_item.h.

Referenced by BOARD_INSPECTION_TOOL::reportClearance(), 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 PAD, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_VIA, SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, and SCH_LINE.

Definition at line 214 of file eda_item.h.

References m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), EDIT_TOOL::BooleanPolygons(), PNS_KICAD_IFACE::createBoardItem(), groupMirrorable(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EDIT_TOOL::HealShapes(), PAD::IsType(), PCB_FIELD::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), SCH_ITEM::IsType(), PL_POINT_EDITOR::Main(), SCH_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EDIT_TOOL::ModifyLines(), CONVERT_TOOL::OutsetItems(), SCH_SELECTION_TOOL::RequestSelection(), CONVERT_TOOL::SegmentToArc(), EDIT_TOOL::SimplifyPolygons(), SCH_EDITOR_CONTROL::SimProbe(), SCH_COMMIT::undoLevelItem(), KIGFX::PCB_VIEW::UpdateCollidingItems(), and Visit().

◆ IsWithinSchematicSheet()

bool FOOTPRINT::IsWithinSchematicSheet ( const KIID_PATH & aSheetPath ) const

Test whether this footprint's symbol lives on aSheetPath or any sheet below it.

Parameters

aSheetPath is a schematic sheet path as returned by SCH_SHEET_PATH::Path(), which leads with the root sheet UUID. Board paths never record the root sheet, so it is stripped before comparing.

Returns: true if the footprint's path is at or below aSheetPath, false if aSheetPath is empty.

Definition at line 1430 of file footprint.cpp.

References m_path.

◆ 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 401 of file eda_item.h.

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

Referenced by BOARD::Visit(), FOOTPRINT::Visit(), and 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 421 of file eda_item.h.

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

◆ JumperPadGroups() [1/2]

std::vector< std::set< wxString > > & FOOTPRINT::JumperPadGroups ( )

inline

Each jumper pad group is a set of pad numbers that should be treated as internally connected.

Returns: The list of jumper pad groups in this footprint

Definition at line 1239 of file footprint.h.

References m_jumperPadGroups.

Referenced by DeserializeDefinition(), PCB_IO_KICAD_SEXPR::format(), SerializeDefinition(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ JumperPadGroups() [2/2]

const std::vector< std::set< wxString > > & FOOTPRINT::JumperPadGroups ( ) const

inline

Definition at line 1240 of file footprint.h.

References m_jumperPadGroups.

◆ LayerMaskDescribe()

wxString BOARD_ITEM::LayerMaskDescribe ( ) const

virtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 252 of file board_item.cpp.

References _, LSET::AllCuMask(), LSET::AllTechMask(), BOARD, GetBoard(), BOARD::GetCopperLayerCount(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), GetLayerSet(), LayerName(), MAX_CU_LAYERS, PCB_LAYER_ID_COUNT, PCBNEW_LAYER_ID_START, and ToLAYER_ID().

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

◆ LegacyPadsLocked()

bool FOOTPRINT::LegacyPadsLocked ( ) const

inline

Definition at line 734 of file footprint.h.

References FP_PADS_are_LOCKED, and m_fpStatus.

◆ lodScaleForThreshold()

double VIEW_ITEM::lodScaleForThreshold	(	const KIGFX::VIEW *	aView,
		int	aWhatIu,
		int	aThresholdIu )

staticprotectedinherited

Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

This is useful when a level-of-detail is defined in terms of a threshold size (i.e. 'only draw X when it will be bigger than Y size on screen').

E.g. if aWhatIu is 1000 and aThresholdIu is 100, then the item will be the same size as the threshold at 0.1 scale. Returning that 0.1 as the LoD will hide the item when the scale is less than 0.1 - i.e. smaller than the threshold.

Because even at zoom 1.0, 1mm in KiCad may not be exactly 1mm on a physical screen, the threshold may not be exact in practice.

Definition at line 35 of file view_item.cpp.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), KIGFX::RENDER_SETTINGS::IsPrinting(), LOD_HIDE, LOD_SHOW, and VIEW.

Referenced by GERBER_DRAW_ITEM::ViewGetLOD(), PAD::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), and SCH_LINE::ViewGetLOD().

◆ 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 4508 of file footprint.cpp.

References group, m_netTiePadGroups, m_pads, and pad.

Referenced by BuildNetTieCache(), CheckNetTiePadGroups(), CheckNetTies(), GetNetTiePads(), DRC_ENGINE::IsNetTieExclusion(), DRC_TEST_PROVIDER_SOLDER_MASK::reportMaskApertureBridges(), PAD::SharesNetTieGroup(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ Matches() [1/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 318 of file eda_item.cpp.

References CTX_SEARCH, EDA_COMBINED_MATCHER::Find(), EDA_SEARCH_DATA::findString, flag, IsReplaceable(), isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), PERMISSIVE, REGEX, EDA_SEARCH_DATA::regex, EDA_SEARCH_DATA::regex_string, EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ Matches() [2/2]

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

overridevirtual

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 from EDA_ITEM.

Definition at line 3118 of file footprint.cpp.

References GetFPIDAsString(), GetKeywords(), GetLibDescription(), EDA_ITEM::Matches(), and EDA_SEARCH_DATA::searchMetadata.

◆ Mirror()

void BOARD_ITEM::Mirror	(	const VECTOR2I &	aCentre,
		FLIP_DIRECTION	aFlipDirection )

virtualinherited

Mirror this object relative to a given horizontal axis the layer is not changed.

Parameters

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

Reimplemented in PCB_ARC, PCB_CONSTRAINT, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIMENSION_BASE, PCB_GENERATOR, PCB_GENERATOR_POLY, PCB_GROUP, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA_STACK, and ZONE.

Definition at line 445 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass().

◆ Models() [1/2]

◆ Models() [2/2]

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

inline

Definition at line 425 of file footprint.h.

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 3418 of file footprint.cpp.

References m_transform, SetPosition(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CLIPBOARD_IO::SaveSelection(), SpreadFootprints(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ 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 3667 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), GetOrientation(), GraphicalItems(), m_courtyard_cache, m_fields, m_geometry_cache, m_pads, m_points, model, Models(), pad, pcbIUScale, RotatePoint(), VECTOR2< T >::x, VECTOR2< T >::y, and Zones().

Referenced by BOOST_AUTO_TEST_CASE(), and CLIPBOARD_IO::SaveSelection().

◆ NeedsPlaced()

bool FOOTPRINT::NeedsPlaced ( ) const

inline

Definition at line 725 of file footprint.h.

References FP_to_PLACE, and m_fpStatus.

◆ Normalize()

virtual void BOARD_ITEM::Normalize ( )

inlinevirtualinherited

Perform any normalization required after a user rotate and/or flip.

Reimplemented in PCB_SHAPE, and PCB_TABLE.

Definition at line 487 of file board_item.h.

Referenced by EDIT_TOOL::Flip(), API_HANDLER_BOARD::handleFlipItems(), NormalizeForCompare(), and EDIT_TOOL::Rotate().

◆ NormalizeForCompare()

virtual void BOARD_ITEM::NormalizeForCompare ( )

inlinevirtualinherited

Perform any normalization required to compare 2 graphics, especially if the can be rotated and/or flipped.

Similar to Normalize(), but more changes can be made

Reimplemented in PCB_SHAPE.

Definition at line 494 of file board_item.h.

References Normalize().

◆ OnFootprintRescaled()

virtual void BOARD_ITEM::OnFootprintRescaled	(	double	aRatioX,
		double	aRatioY,
		double	aLinearFactor,
		const VECTOR2I &	aAnchor,
		const EDA_ANGLE &	aParentRotate )

inlinevirtualinherited

Apply a parent footprint scale to this item.

Default is a no-op. Items with sizable geometry (PAD, PCB_SHAPE, PCB_TEXT, ZONE) override.

Parameters

aRatioX	new Sx / old Sx (multiply X-axis-aligned values by this).
aRatioY	same for Y.
aLinearFactor	weighted factor for stroke / thickness.
aAnchor	scale anchor (the parent footprint's translate).
aParentRotate	current parent rotation. Needed by POLY / BEZIER to unrotate before scaling and rotate back.

Reimplemented in PAD, PCB_BARCODE, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 458 of file board_item.h.

◆ OnFootprintTransformed()

virtual void BOARD_ITEM::OnFootprintTransformed ( )

inlinevirtualinherited

Hook for items inside a footprint to refresh after the FP transform changes (translate, rotate, flip).

Scaling uses OnFootprintRescaled.

Reimplemented in PAD, PCB_DIMENSION_BASE, PCB_POINT, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 466 of file board_item.h.

◆ 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 479 of file eda_item.cpp.

References EDA_ITEM(), and KIGFX::VIEW_ITEM::GetClass().

◆ operator=() [1/2]

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

Definition at line 1248 of file footprint.cpp.

References Add(), EDA_GROUP::AddItem(), BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), Constraints(), EDA_ITEM::EDA_ITEM(), FOOTPRINT(), BOARD_ITEM::GetBoard(), EDA_GROUP::GetItems(), COMPONENT_CLASS_CACHE_PROXY::GetStaticComponentClass(), GraphicalItems(), group, Groups(), m_3D_Drawings, m_attributes, m_clearance, m_componentClassCacheProxy, m_constraints, m_courtyard_cache, m_drawings, m_duplicatePadNumbersAreJumpers, m_extrudedBody, m_fields, m_flipped, m_fpid, m_fpStatus, m_geometry_cache, m_groups, m_initial_comments, m_jumperPadGroups, m_keywords, m_lastEditTime, m_libDescription, m_link, m_netTiePadGroups, m_pads, m_path, m_points, m_privateLayers, m_solderMaskMargin, m_solderPasteMargin, m_solderPasteMarginRatio, m_transform, m_variants, m_zoneConnection, m_zones, BOARD_ITEM::operator=(), EMBEDDED_FILES::operator=(), PAD, pad, Pads(), Points(), ZONE::SetNetCode(), and Zones().

◆ operator=() [2/2]

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

◆ operator==() [1/2]

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

overridevirtual

Implements BOARD_ITEM.

Definition at line 4906 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), FOOTPRINT(), PCB_FOOTPRINT_T, and EDA_ITEM::Type().

◆ operator==() [2/2]

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

Definition at line 4917 of file footprint.cpp.

References FOOTPRINT(), GetFields(), GetFields(), m_drawings, m_pads, m_points, and m_zones.

◆ Pads() [1/2]

std::deque< PAD * > & FOOTPRINT::Pads ( )

inline

Definition at line 404 of file footprint.h.

References m_pads.

◆ Pads() [2/2]

const std::deque< PAD * > & FOOTPRINT::Pads ( ) const

inline

Definition at line 405 of file footprint.h.

References m_pads.

◆ Points() [1/2]

PCB_POINTS & FOOTPRINT::Points ( )

inline

Definition at line 419 of file footprint.h.

References m_points.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_GRID_HELPER::computeAnchors(), DeserializeDefinition(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), operator=(), PCB_SELECTION_TOOL::Selectable(), and SerializeDefinition().

◆ Points() [2/2]

const PCB_POINTS & FOOTPRINT::Points ( ) const

inline

Definition at line 420 of file footprint.h.

References m_points.

◆ RecomputeComponentClass()

void FOOTPRINT::RecomputeComponentClass ( ) const

Forces immediate recalculation of the component class for this footprint.

Definition at line 5464 of file footprint.cpp.

References m_componentClassCacheProxy.

◆ Reference() [1/2]

PCB_FIELD & FOOTPRINT::Reference ( )

inline

Definition at line 940 of file footprint.h.

References GetField(), and REFERENCE.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), AutoPositionFields(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ZONE_FILLER::buildCopperItemClearances(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), DIPTRACE::PCB_PARSER::CreateFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), GetMsgPanelInfo(), GetReference(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), idf_export_footprint(), PCB_IO_EAGLE::loadElements(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FABMASTER::loadFootprints(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS_BINARY::loadFootprints(), PCB_IO_EAGLE::loadPlain(), PCB_IO_EAGLE::orientFootprintAndText(), PCB_IO_EAGLE::packageText(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), SPRINT_LAYOUT_PARSER::processPad(), SPRINT_LAYOUT_PARSER::processText(), and SetReference().

◆ Reference() [2/2]

const PCB_FIELD & FOOTPRINT::Reference ( ) const

inline

Definition at line 944 of file footprint.h.

References GetField(), and REFERENCE.

◆ RemapKIIDs()

virtual void BOARD_ITEM::RemapKIIDs ( const std::map< KIID, KIID > & aIdMap )

inlinevirtualinherited

Remap KIIDs this item stores to reference other items (e.g.

constraint members) through aIdMap (old -> new), after a paste/duplicate has re-UUIDed the referenced items. KIIDs absent from the map are left unchanged. The default does nothing.

Reimplemented in PCB_CONSTRAINT.

Definition at line 287 of file board_item.h.

Referenced by PCB_CONTROL::placeBoardItems().

◆ Remove()

void FOOTPRINT::Remove	(	BOARD_ITEM *	aItem,
		REMOVE_MODE	aMode = REMOVE_MODE::NORMAL )

overridevirtual

Removes an item from the container.

Implements BOARD_ITEM_CONTAINER.

Definition at line 1921 of file footprint.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::BOARD_ITEM(), BOARD_ITEM::GetBoard(), InvalidateGeometryCaches(), m_constraints, m_drawings, m_fields, m_groups, m_pads, m_points, m_variants, m_zones, PCB_BARCODE_T, PCB_CONSTRAINT_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_POINT_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_ZONE_T, EDA_ITEM::SetFlags(), STRUCT_DELETED, and EDA_ITEM::Type().

Referenced by KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DeserializeDefinition(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), PCB_PROPERTIES_PANEL::removeField(), UpdateFields(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ RemoveConflictingCustomProperties()

std::vector< wxString > EDA_ITEM::RemoveConflictingCustomProperties ( )

inherited

Remove custom properties whose keys collide with an existing field or built-in property name (matched case-insensitively).

Returns the keys removed, if any.

Definition at line 168 of file eda_item.cpp.

References _HKI, PROPERTY_MANAGER::Instance(), m_customProperties, and RemoveCustomProperty().

◆ RemoveCustomProperty()

void EDA_ITEM::RemoveCustomProperty ( const wxString & aKey )

inherited

Definition at line 161 of file eda_item.cpp.

References m_customProperties, and m_dynamicCustomPropsCache.

Referenced by PCB_PROPERTIES_PANEL::onKeyRenamed(), SCH_PROPERTIES_PANEL::onKeyRenamed(), RemoveConflictingCustomProperties(), and SCH_PROPERTIES_PANEL::removeCustomProperty().

◆ RemoveFile()

void EMBEDDED_FILES::RemoveFile	(	const wxString &	name,
		bool	aErase = true )

inherited

Remove a file from the collection and frees the memory.

Parameters

aName is the name of the file to remove.

Definition at line 166 of file embedded_files.cpp.

References m_files, and name.

Referenced by BOARD::ExchangeFootprint(), and PANEL_EMBEDDED_FILES::TransferDataFromWindow().

◆ RenameVariant()

void FOOTPRINT::RenameVariant	(	const wxString &	aOldName,
		const wxString &	aNewName )

Rename a variant.

Parameters

aOldName	The current name of the variant.
aNewName	The new name for the variant.

Definition at line 1689 of file footprint.cpp.

References GetDefaultVariantName(), m_variants, and FOOTPRINT_VARIANT::SetName().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 196 of file eda_item.h.

◆ Replace() [1/2]

virtual bool EDA_ITEM::Replace	(	const EDA_SEARCH_DATA &	aSearchData,
		void *	aAuxData = nullptr )

inlinevirtualinherited

Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters

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

Returns: True if the item text was modified, otherwise false.

Reimplemented in SCH_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET_PIN, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 509 of file eda_item.h.

◆ Replace() [2/2]

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

staticinherited

Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns: True if aText was modified, otherwise false.

Definition at line 396 of file eda_item.cpp.

References EDA_SEARCH_DATA::findString, flag, isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), REGEX, EDA_SEARCH_DATA::regex, EDA_SEARCH_DATA::regex_string, EDA_SEARCH_DATA::replaceString, result, text, and WHOLEWORD.

Referenced by EDA_TEXT::Replace(), SCH_FIELD::Replace(), SCH_PIN::Replace(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), and SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext().

◆ RescaleAroundPoint()

void FOOTPRINT::RescaleAroundPoint	(	const VECTOR2I &	aCenter,
		double	aSx,
		double	aSy )

Definition at line 3607 of file footprint.cpp.

References TRANSFORM_TRS::GetScaleX(), TRANSFORM_TRS::GetScaleY(), TRANSFORM_TRS::GetTranslate(), m_transform, SetPosition(), and SetTransformScale().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ ResetUuid()

void BOARD_ITEM::ResetUuid ( )

inlineinherited

Definition at line 280 of file board_item.h.

References SetUuid().

Referenced by CloneFullySelectedConstraints(), MULTICHANNEL_TOOL::copyRuleAreaContents(), Duplicate(), PCB_TABLE::Duplicate(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ ResetUuidDirect()

void BOARD_ITEM::ResetUuidDirect ( )

inlineinherited

Definition at line 277 of file board_item.h.

References SetUuidDirect().

Referenced by PCB_EDIT_TABLE_TOOL::copyCell(), MULTICHANNEL_TOOL::copyRuleAreaContents(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), and LoadNetlistFootprints().

◆ ResolveComponentClassNames()

void FOOTPRINT::ResolveComponentClassNames	(	BOARD *	aBoard,
		const std::unordered_set< wxString > &	aComponentClassNames )

Resolves a set of component class names to this footprint's actual component class.

Definition at line 5485 of file footprint.cpp.

References BOARD_ITEM::BOARD, BOARD::GetComponentClassManager(), COMPONENT_CLASS_MANAGER::GetEffectiveStaticComponentClass(), and SetStaticComponentClass().

Referenced by PCB_CONTROL::Paste().

◆ ResolveTextVar() [1/2]

bool FOOTPRINT::ResolveTextVar	(	wxString *	token,
		const wxString &	aVariantName,
		int	aDepth = 0 ) const

◆ ResolveTextVar() [2/2]

bool FOOTPRINT::ResolveTextVar	(	wxString *	token,
		int	aDepth = 0 ) const

Resolve any references to system tokens supported by the component.

Parameters

aDepth a counter to limit recursion and circular references.

Definition at line 1460 of file footprint.cpp.

References BOARD_ITEM::GetBoard(), BOARD::GetCurrentVariant(), and ResolveTextVar().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), PCB_FIELD::GetShownText(), PCB_TABLECELL::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), BOARD::ResolveTextVar(), ResolveTextVar(), ResolveTextVar(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars().

◆ Rotate()

void FOOTPRINT::Rotate	(	const VECTOR2I &	aRotCentre,
		const EDA_ANGLE &	aAngle )

overridevirtual

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from BOARD_ITEM.

Definition at line 3428 of file footprint.cpp.

References ANGLE_0, BOARD_ITEM::BOARD_ITEM(), GetOrientation(), m_drawings, m_fields, m_transform, PCB_TEXT_T, RotatePoint(), SetOrientation(), and SetPosition().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), EDIT_TOOL::doMoveSelection(), Flip(), and BOARD_EDITOR_CONTROL::PlaceFootprint().

◆ RunOnChildren()

void FOOTPRINT::RunOnChildren	(	const std::function< void(BOARD_ITEM *)> &	aFunction,
		RECURSE_MODE	aMode ) const

overridevirtual

Invoke a function on all children.

Note: This function should not add or remove items to the parent.

Reimplemented from BOARD_ITEM.

Definition at line 3256 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), group, m_constraints, m_drawings, m_fields, m_groups, m_pads, m_points, m_zones, pad, and RECURSE.

Referenced by ClearAllNets(), PCB_BASE_FRAME::CreateNewFootprint(), Duplicate(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), LAYER_UTILS::GetAllFootprintLayers(), PCB_IO_KICAD_SEXPR_PARSER::resolveConstraints(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), HEADLESS_FOOTPRINT_CONTEXT::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), and swapData().

◆ RunOnNestedEmbeddedFiles()

virtual void EMBEDDED_FILES::RunOnNestedEmbeddedFiles ( const std::function< void(EMBEDDED_FILES *)> & aFunction )

inlinevirtualinherited

Provide access to nested embedded files, such as symbols in schematics and footprints in boards.

Reimplemented in BOARD, and SCHEMATIC.

Definition at line 187 of file embedded_files.h.

References EMBEDDED_FILES().

◆ Seed()

static uint32_t EMBEDDED_FILES::Seed ( )

inlinestaticinherited

Definition at line 293 of file embedded_files.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CompressAndEncode(), ComputeFileHash(), SYMBOL_EMBEDDED_FILES_TEST_FIXTURE::CreateTestEmbeddedFile(), DecompressAndDecode(), and EMBEDDED_FILES::EMBEDDED_FILE::Validate().

◆ Serialize()

void FOOTPRINT::Serialize ( google::protobuf::Any & aContainer ) const

overridevirtual

Serializes this object to the given Any message.

The Any message's concrete type will be specific to the object in question.

Parameters

aContainer will be filled with a message describing this object

Reimplemented from SERIALIZABLE.

Definition at line 461 of file footprint.cpp.

References AllowMissingCourtyard(), AllowSolderMaskBridges(), BOARD_ITEM::BOARD, DATASHEET, DESCRIPTION, FP_SMD, FP_THROUGH_HOLE, BOARD_ITEM::GetBoard(), GetField(), GetLayer(), GetLocalClearance(), GetLocalSolderMaskMargin(), GetLocalSolderPasteMargin(), GetLocalSolderPasteMarginRatio(), GetLocalZoneConnection(), GetOrientationDegrees(), GetPosition(), IsBoardOnly(), IsDNP(), IsExcludedFromBOM(), IsExcludedFromPosFiles(), IsExcludedFromSim(), IsLocked(), m_attributes, m_filters, m_path, m_sheetfile, m_sheetname, EDA_ITEM::m_Uuid, m_variants, kiapi::common::PackCustomProperties(), kiapi::board::PackEmbeddedFiles(), kiapi::common::PackSheetPath(), REFERENCE, PCB_FIELD::Serialize(), SerializeDefinition(), ToProtoEnum(), and VALUE.

Referenced by API_HANDLER_PCB::handlePlaceFootprintFromLibrary().

◆ SerializeDefinition()

void FOOTPRINT::SerializeDefinition ( kiapi::board::types::Footprint * aOutput ) const

Definition at line 548 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), GetDuplicatePadNumbersAreJumpers(), GetFPID(), GetKeywords(), GetLibDescription(), GetNetTiePadGroups(), GetPrivateLayers(), GraphicalItems(), group, JumperPadGroups(), m_fields, model, Models(), kiapi::common::PackLibId(), kiapi::common::PackVector3D(), Pads(), Points(), ToProtoEnum(), and Zones().

Referenced by Serialize().

◆ Set() [1/4]

template<typename T>

bool INSPECTABLE::Set	(	const wxString &	aProperty,
		T	aValue,
		bool	aNotify = true )

inherited

Definition at line 48 of file inspectable_impl.h.

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_MANAGER::PropertyChanged(), PROPERTY_BASE::set(), T, TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [2/4]

template<typename T>

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		T	aValue,
		bool	aNotify = true )

inherited

Definition at line 31 of file inspectable_impl.h.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_MANAGER::PropertyChanged(), PROPERTY_BASE::set(), T, TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [3/4]

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		wxAny &	aValue,
		bool	aNotify = true )

inherited

Definition at line 28 of file inspectable.cpp.

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

Referenced by KICAD_DIFF::ApplyPropertyResolutions(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), MATCH_PROPERTIES_CATALOG::Copy(), PCB_PROPERTIES_PANEL::valueChanged(), and SCH_PROPERTIES_PANEL::valueChanged().

◆ Set() [4/4]

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		wxVariant	aValue,
		bool	aNotify = true )

inherited

Definition at line 45 of file inspectable.cpp.

References PROPERTY_BASE::GetChoices(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_MANAGER::PropertyChanged(), PROPERTY_BASE::set(), TYPE_HASH, PROPERTY_MANAGER::TypeCast(), and PROPERTY_BASE::TypeHash().

◆ SetAllowMissingCourtyard()

void FOOTPRINT::SetAllowMissingCourtyard ( bool aAllow )

inline

Definition at line 557 of file footprint.h.

References m_allowMissingCourtyard.

Referenced by Deserialize(), and FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ SetAllowSolderMaskBridges()

void FOOTPRINT::SetAllowSolderMaskBridges ( bool aAllow )

inline

Definition at line 560 of file footprint.h.

References m_allowSolderMaskBridges.

Referenced by Deserialize(), and BOARD::ExchangeFootprint().

◆ SetAreFontsEmbedded()

void EMBEDDED_FILES::SetAreFontsEmbedded ( bool aEmbedFonts )

inlineinherited

Definition at line 283 of file embedded_files.h.

References m_embedFonts.

Referenced by ORCAD_CONVERTER::applyFont(), LIB_SYMBOL::Deserialize(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), LIB_BUFFER::SaveBuffer(), and SYMBOL_LIBRARY_MANAGER::SaveLibrary().

◆ SetAttributes()

void FOOTPRINT::SetAttributes ( int aAttributes )

inline

Definition at line 551 of file footprint.h.

References m_attributes.

Referenced by addFootprint(), BOARD_NETLIST_UPDATER::addNewFootprint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_BASE_FRAME::CreateNewFootprint(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ SetBoardOnly()

void FOOTPRINT::SetBoardOnly ( bool aIsBoardOnly = true )

inline

Definition at line 1020 of file footprint.h.

References FP_BOARD_ONLY, and m_attributes.

Referenced by Deserialize(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and PCB_IO_PADS::loadTestPoints().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 151 of file eda_item.h.

References BRIGHTENED, and SetFlags().

Referenced by KICAD_DIFF::ConfigureSchDiffCanvasContext(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and PCB_TEST_SELECTION_TOOL::highlightInternal().

◆ SetCustomProperties()

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

inlineinherited

Definition at line 247 of file eda_item.h.

References m_customProperties, and SetCustomProperty().

Referenced by kiapi::common::UnpackCustomProperties().

◆ SetCustomProperty()

void EDA_ITEM::SetCustomProperty	(	const wxString &	aKey,
		const wxString &	aValue )

inlineinherited

Definition at line 255 of file eda_item.h.

References m_customProperties.

Referenced by SCH_PROPERTIES_PANEL::addBlankCustomProperty(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::onKeyRenamed(), SCH_PROPERTIES_PANEL::onKeyRenamed(), PCB_IO_KICAD_SEXPR_PARSER::parseCustomProperty(), SCH_IO_KICAD_SEXPR_PARSER::parseCustomProperty(), SetCustomProperties(), and EDA_CUSTOM_PROPERTY::setter().

◆ SetDNP()

void FOOTPRINT::SetDNP ( bool aDNP = true )

inline

Definition at line 1056 of file footprint.h.

References FP_DNP, and m_attributes.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Deserialize(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue().

◆ SetDuplicatePadNumbersAreJumpers()

void FOOTPRINT::SetDuplicatePadNumbersAreJumpers ( bool aEnabled )

inline

Definition at line 1233 of file footprint.h.

References m_duplicatePadNumbersAreJumpers.

Referenced by DeserializeDefinition(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ SetExcludedFromBOM()

void FOOTPRINT::SetExcludedFromBOM ( bool aExclude = true )

inline

Definition at line 1038 of file footprint.h.

References FP_EXCLUDE_FROM_BOM, and m_attributes.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Deserialize(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and EDIT_TOOL::ToggleFootprintAttribute().

◆ SetExcludedFromPosFiles()

void FOOTPRINT::SetExcludedFromPosFiles ( bool aExclude = true )

inline

Definition at line 1029 of file footprint.h.

References FP_EXCLUDE_FROM_POS_FILES, and m_attributes.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Deserialize(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and EDIT_TOOL::ToggleFootprintAttribute().

◆ SetExcludedFromSim()

void FOOTPRINT::SetExcludedFromSim ( bool aExclude = true )

inline

Definition at line 1047 of file footprint.h.

References FP_EXCLUDE_FROM_SIM, and m_attributes.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Deserialize(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue(), and EDIT_TOOL::ToggleFootprintAttribute().

◆ SetExtrudedBody()

void FOOTPRINT::SetExtrudedBody ( std::unique_ptr< EXTRUDED_3D_BODY > aBody )

Definition at line 3112 of file footprint.cpp.

References m_extrudedBody.

Referenced by BOARD::ExchangeFootprint().

◆ SetFileAddedCallback()

void EMBEDDED_FILES::SetFileAddedCallback ( FILE_ADDED_CALLBACK callback )

inlineinherited

Definition at line 96 of file embedded_files.h.

References m_fileAddedCallback.

Referenced by LIB_BUFFER::SaveBuffer(), and SYMBOL_LIBRARY_MANAGER::SaveLibrary().

◆ SetFileFormatVersionAtLoad()

void FOOTPRINT::SetFileFormatVersionAtLoad ( int aVersion )

inline

Definition at line 1175 of file footprint.h.

References m_fileFormatVersionAtLoad.

◆ SetFilters()

void FOOTPRINT::SetFilters ( const wxString & aFilters )

inline

Definition at line 517 of file footprint.h.

References m_filters.

Referenced by BOARD::ExchangeFootprint(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ SetFlag()

void FOOTPRINT::SetFlag ( int aFlag )

inline

Definition at line 562 of file footprint.h.

References m_arflag.

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 158 of file eda_item.h.

References m_flags.

◆ SetFootprintType()

void FOOTPRINT::SetFootprintType ( FOOTPRINT_TYPE aFootprintType )

Definition at line 2144 of file footprint.cpp.

References FP_SMD, FP_THROUGH_HOLE, m_attributes, SMD, and THROUGH_HOLE.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ SetForcedTransparency()

void KIGFX::VIEW_ITEM::SetForcedTransparency ( double aForcedTransparency )

inlineinherited

Definition at line 162 of file view_item.h.

References m_forcedTransparency.

Referenced by FOOTPRINT_DIFF_WIDGET::onSlider(), EDA_ITEM::operator=(), and LIB_SYMBOL::SetParent().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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.

Parameters

aEnable True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 232 of file eda_item.h.

References m_forceVisible.

Referenced by SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ SetFPID()

void FOOTPRINT::SetFPID ( const LIB_ID & aFPID )

inline

Definition at line 474 of file footprint.h.

References m_fpid.

◆ SetFPIDAsString()

void FOOTPRINT::SetFPIDAsString ( const wxString & aFPID )

inline

Definition at line 480 of file footprint.h.

References m_fpid.

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 424 of file board_item.cpp.

References GetParentFootprint(), and EDA_ITEM::SetPosition().

Referenced by PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), processTextItem(), and PCB_FIELDS_GRID_TABLE::SetValue().

◆ SetInitialComments()

void FOOTPRINT::SetInitialComments ( wxArrayString * aInitialComments )

inline

Take ownership of caller's heap allocated aInitialComments block.

The comments are single line strings already containing the s-expression comments with optional leading whitespace and then a '#' character followed by optional single line text (text with no line endings, not even one). This block of single line comments will be output upfront of any generated s-expression text in the PCBIO::Format() function.

Note: A block of single line comments constitutes a multiline block of single line comments. That is, the block is made of consecutive single line comments.

Parameters

aInitialComments is a heap allocated wxArrayString or NULL, which the caller gives up ownership of over to this FOOTPRINT.

Definition at line 1343 of file footprint.h.

References m_initial_comments.

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

◆ SetIsPlaced()

void FOOTPRINT::SetIsPlaced ( bool isPlaced )

inline

Definition at line 717 of file footprint.h.

References FP_is_PLACED, and m_fpStatus.

Referenced by AR_AUTOPLACER::AutoplaceFootprints(), and PCB_IO_KICAD_LEGACY::loadFOOTPRINT().

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover	(	bool	aIsRollover,
		const VECTOR2I &	aMousePos )

inlineinherited

Definition at line 144 of file eda_item.h.

References m_isRollover, and m_rolloverPos.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 198 of file eda_item.h.

References ClearFlags(), IS_SHOWN_AS_BITMAP, and SetFlags().

◆ SetKeywords()

void FOOTPRINT::SetKeywords ( const wxString & aKeywords )

inline

Definition at line 494 of file footprint.h.

References m_keywords.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), DeserializeDefinition(), and PCB_IO_KICAD_LEGACY::loadFOOTPRINT().

◆ SetLayer()

void FOOTPRINT::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtual

Set the layer this item is on.

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Definition at line 3558 of file footprint.cpp.

References B_Cu, m_flipped, and BOARD_ITEM::SetLayer().

Referenced by addFootprint(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SPRINT_LAYOUT_PARSER::CreateBoard(), Deserialize(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), FABMASTER::loadFootprints(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS_BINARY::loadFootprints(), PCB_IO_PADS::loadTestPoints(), and SPRINT_LAYOUT_PARSER::processPad().

◆ SetLayerAndFlip()

void FOOTPRINT::SetLayerAndFlip ( PCB_LAYER_ID aLayer )

Used as Layer property setter – performs a flip if necessary to set the footprint layer.

Parameters

aLayer is the target layer (F_Cu or B_Cu)

Definition at line 3451 of file footprint.cpp.

References B_Cu, F_Cu, Flip(), GetLayer(), GetPosition(), and LEFT_RIGHT.

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( const LSET & aLayers )

inlinevirtualinherited

Reimplemented in BOARD, PAD, PCB_GRID_ITEM, PCB_SHAPE, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 354 of file board_item.h.

References KIGFX::VIEW_ITEM::GetClass(), LSET::Seq(), SetLayer(), and UNIMPLEMENTED_FOR.

Referenced by MULTICHANNEL_TOOL::copyRuleAreaContents(), BOARD::RemoveAllItemsOnLayer(), and GLOBAL_EDIT_TOOL::swapBoardItem().

◆ SetLibDescription()

void FOOTPRINT::SetLibDescription ( const wxString & aDesc )

inline

Definition at line 491 of file footprint.h.

References m_libDescription.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), SPRINT_LAYOUT_PARSER::CreateBoard(), DeserializeDefinition(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), and PCB_IO_KICAD_LEGACY::loadFOOTPRINT().

◆ SetLink()

void FOOTPRINT::SetLink ( const KIID & aLink )

inline

Definition at line 1259 of file footprint.h.

References m_link.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOOST_AUTO_TEST_CASE(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PlotFootprintToSVG(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ SetLocalClearance()

void FOOTPRINT::SetLocalClearance ( std::optional< int > aClearance )

inline

Definition at line 520 of file footprint.h.

References m_clearance.

Referenced by Deserialize(), BOARD::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and PCB_IO_KICAD_LEGACY::loadFOOTPRINT().

◆ SetLocalSolderMaskMargin()

void FOOTPRINT::SetLocalSolderMaskMargin ( std::optional< int > aMargin )

inline

Definition at line 523 of file footprint.h.

References m_solderMaskMargin.

Referenced by Deserialize(), BOARD::ExchangeFootprint(), and PCB_IO_KICAD_LEGACY::loadFOOTPRINT().

◆ SetLocalSolderPasteMargin()

void FOOTPRINT::SetLocalSolderPasteMargin ( std::optional< int > aMargin )

inline

Definition at line 526 of file footprint.h.

References m_solderPasteMargin.

Referenced by Deserialize(), BOARD::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and PCB_IO_KICAD_LEGACY::loadFOOTPRINT().

◆ SetLocalSolderPasteMarginRatio()

void FOOTPRINT::SetLocalSolderPasteMarginRatio ( std::optional< double > aRatio )

inline

Definition at line 529 of file footprint.h.

References m_solderPasteMarginRatio.

Referenced by BOOST_AUTO_TEST_CASE(), Deserialize(), BOARD::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and PCB_IO_KICAD_LEGACY::loadFOOTPRINT().

◆ SetLocalZoneConnection()

void FOOTPRINT::SetLocalZoneConnection ( ZONE_CONNECTION aType )

inline

Definition at line 531 of file footprint.h.

References m_zoneConnection.

Referenced by Deserialize(), BOARD::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and PCB_IO_KICAD_LEGACY::loadFOOTPRINT().

◆ SetLocked()

void FOOTPRINT::SetLocked ( bool isLocked )

inlineoverridevirtual

Set the #MODULE_is_LOCKED bit in the m_ModuleStatus.

Parameters

isLocked true means turn on locked status, else unlock

Reimplemented from BOARD_ITEM.

Definition at line 703 of file footprint.h.

References FP_is_LOCKED, and m_fpStatus.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Deserialize(), BOARD::ExchangeFootprint(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), and CLIPBOARD_IO::SaveSelection().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 260 of file eda_item.cpp.

References IS_CHANGED, m_parent, and SetFlags().

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), SCH_IO_ALTIUM::ParseASCIISchematic(), and SCH_IO_ALTIUM::ParseFileHeader().

◆ SetNeedsPlaced()

void FOOTPRINT::SetNeedsPlaced ( bool needsPlaced )

inline

Definition at line 726 of file footprint.h.

References FP_to_PLACE, and m_fpStatus.

Referenced by AR_AUTOPLACER::AutoplaceFootprints().

◆ SetNetHighlighted()

void EDA_ITEM::SetNetHighlighted ( bool aHighlighted )

inherited

Definition at line 131 of file eda_item.cpp.

References m_netHighlighted.

Referenced by KIGFX::SCH_PAINTER::draw(), and setNetHighlight().

◆ SetOrientation()

void FOOTPRINT::SetOrientation ( const EDA_ANGLE & aNewAngle )

Definition at line 3728 of file footprint.cpp.

References BaseType(), BOARD_ITEM::BOARD_ITEM(), GetPosition(), m_courtyard_cache, m_drawings, m_fields, m_geometry_cache, m_pads, m_points, m_transform, m_zones, EDA_ANGLE::Normalize180(), pad, PCB_BARCODE_T, PCB_DIMENSION_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, and PCB_TEXTBOX_T.

◆ SetOrientationDegrees()

void FOOTPRINT::SetOrientationDegrees ( double aOrientation )

inline

Definition at line 464 of file footprint.h.

References DEGREES_T, and SetOrientation().

Referenced by BOOST_AUTO_TEST_CASE(), SPRINT_LAYOUT_PARSER::CreateBoard(), Deserialize(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and FABMASTER::loadFootprints().

◆ SetParent()

void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

virtualinherited

Reimplemented in LIB_SYMBOL, NETINFO_ITEM, and PCB_POINT.

Definition at line 153 of file eda_item.cpp.

References EDA_ITEM(), and m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), PCB_TABLE::AddCell(), SCH_TABLE::AddCell(), LIB_SYMBOL::AddDrawItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCHEMATIC::AddTopLevelSheet(), SCH_SCREEN::Append(), PADSTACK::AppendPrimitives(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_generic_connectivity, CONNECTION_GRAPH::boost_test_update_symbol_connectivity, CADSTAR_SCH_ARCHIVE_LOADER::copySymbolItems(), SPRINT_LAYOUT_PARSER::CreateBoard(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol(), FIELDS_GRID_TABLE::DetachFields(), FOOTPRINT_EDITOR_CONTROL::editFootprintPropertiesFromLibrary(), SCHEMATIC::ensureVirtualRoot(), FOOTPRINT_LIBRARY_ADAPTER::enumerateLibrary(), BOARD::ExchangeFootprint(), PAD_TOOL::explodePad(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), LIB_SYMBOL::Flatten(), PCB_IO_KICAD_SEXPR::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), PCB_TABLE::InsertCell(), SCH_TABLE::InsertCell(), LIB_SYMBOL::LIB_SYMBOL(), LTSPICE_SCHEMATIC::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), PCB_IO_GEDA::loadBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_KICAD_SEXPR::loadHierarchy(), SCH_IO_DATABASE::loadSymbolFromRow(), SCH_IO_EAGLE::loadSymbolPolyLine(), SCH_IO_EAGLE::loadSymbolRectangle(), SCH_IO_EAGLE::loadSymbolWire(), PCB_POINT_EDITOR::OnSelectionChange(), LIB_SYMBOL::operator=(), SCH_IO_KICAD_SEXPR_PARSER::parseLibSymbol(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceMicroviaStack(), PlaceRemoteDownloadedSymbol(), PlotFootprintToSVG(), FOOTPRINT_EDIT_FRAME::prepareFootprintTabHandoff(), BACK_ANNOTATE::processNetNameChange(), KI_TEST::ReadSchematicFromStream(), PAD::Recombine(), FOOTPRINT_EDIT_FRAME::RefreshLibraryFootprintTab(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_POINT::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), FOOTPRINT::swapData(), PCB_BARCODE::swapData(), PCB_TABLE::swapData(), SCH_LABEL_BASE::swapData(), SCH_SHEET::swapData(), SCH_SYMBOL::swapData(), SCH_TABLE::swapData(), BOARD_ITEM::SwapItemData(), SCH_ITEM::SwapItemData(), SCH_SYMBOL::SyncOtherUnits(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), FOOTPRINT::UpdateFields(), and PCB_IO_SPRINT_LAYOUT::~PCB_IO_SPRINT_LAYOUT().

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

Definition at line 115 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), FOOTPRINT_LIBRARY_ADAPTER::enumerateLibrary(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), PCB_IO_KICAD_SEXPR::FootprintSave(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_SYMBOL::GetOrientation(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), EDA_GROUP::RemoveItem(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), CLIPBOARD_IO::SaveSelection(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), PCB_GROUP::swapChildOwnership(), SCH_GROUP::swapData(), and BOARD_ITEM::SwapItemData().

◆ SetPath()

void FOOTPRINT::SetPath ( const KIID_PATH & aPath )

inline

Definition at line 497 of file footprint.h.

References m_path.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS_BINARY::loadFootprints(), COMPONENT::SetFootprint(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ SetPosition()

void FOOTPRINT::SetPosition ( const VECTOR2I & aPos )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 3616 of file footprint.cpp.

References BaseType(), BOARD_ITEM::BOARD_ITEM(), delta, m_courtyard_cache, m_drawings, m_fields, m_geometry_cache, m_pads, m_points, m_transform, m_zones, pad, PCB_BARCODE_T, PCB_DIMENSION_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, and PCB_TEXTBOX_T.

◆ SetPrivateLayers()

void FOOTPRINT::SetPrivateLayers ( const LSET & aLayers )

inline

Adds an item to the container.

Parameters

aMode	decides whether the item is added in the beginning or at the end of the list.
aSkipConnectivity	skip connectivity update (useful for file loading, when the connectivity is updated after end of loading).

Definition at line 345 of file footprint.h.

References m_privateLayers.

Referenced by DeserializeDefinition().

◆ SetReference()

void FOOTPRINT::SetReference ( const wxString & aReference )

inline

Parameters

aReference A reference to a wxString object containing the reference designator text.

Definition at line 907 of file footprint.h.

References Reference(), and EDA_TEXT::SetText().

◆ SetScaleX()

void FOOTPRINT::SetScaleX ( double aScaleX )

inline

Definition at line 458 of file footprint.h.

References m_transform, and SetTransformScale().

Referenced by BOOST_FIXTURE_TEST_CASE(), and FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ SetScaleY()

void FOOTPRINT::SetScaleY ( double aScaleY )

inline

Definition at line 460 of file footprint.h.

References m_transform, and SetTransformScale().

Referenced by BOOST_FIXTURE_TEST_CASE(), and FOOTPRINT_DESC::FOOTPRINT_DESC().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 150 of file eda_item.h.

References SELECTED, and SetFlags().

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), SCH_LINE::MergeOverlap(), DRAWING_TOOL::PlaceGridItem(), DS_PROXY_UNDO_ITEM::Restore(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SCH_COMMIT::Stage().

◆ SetSheetfile()

void FOOTPRINT::SetSheetfile ( const wxString & aSheetfile )

inline

Definition at line 514 of file footprint.h.

References m_sheetfile.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOARD::ExchangeFootprint(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ SetSheetname()

void FOOTPRINT::SetSheetname ( const wxString & aSheetname )

inline

Definition at line 511 of file footprint.h.

References m_sheetname.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOARD::ExchangeFootprint(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ SetStackupLayers()

void FOOTPRINT::SetStackupLayers ( LSET aLayers )

If the footprint has a non-default stackup, set the layers that should be used for the stackup.

Definition at line 5512 of file footprint.cpp.

References CUSTOM_LAYERS, m_stackupLayers, and m_stackupMode.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parseFootprintStackup().

◆ SetStackupMode()

void FOOTPRINT::SetStackupMode ( FOOTPRINT_STACKUP aMode )

Set the stackup mode for this footprint.

This determines if the footprint lists its own layers or uses a default stackup, with "expansion" of inner layers to the PCB's inner layers.

Definition at line 5500 of file footprint.cpp.

References B_Cu, EXPAND_INNER_LAYERS, F_Cu, In1_Cu, m_stackupLayers, and m_stackupMode.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parseFootprintStackup().

◆ SetStaticComponentClass()

void FOOTPRINT::SetStaticComponentClass ( const COMPONENT_CLASS * aClass ) const

Sets the component class object pointer for this footprint.

Definition at line 5452 of file footprint.cpp.

References m_componentClassCacheProxy.

Referenced by BOARD_NETLIST_UPDATER::addNewFootprint(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOARD::ExchangeFootprint(), ResolveComponentClassNames(), and BOARD_NETLIST_UPDATER::updateComponentClass().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 163 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass().

◆ SetTransformScale()

void FOOTPRINT::SetTransformScale	(	double	aScaleX,
		double	aScaleY )

Definition at line 3565 of file footprint.cpp.

References anchor, BOARD_ITEM::BOARD_ITEM(), m_courtyard_cache, m_drawings, m_fields, m_geometry_cache, m_pads, m_points, m_transform, m_zones, and pad.

◆ SetTransientComponentClassNames()

void FOOTPRINT::SetTransientComponentClassNames ( const std::unordered_set< wxString > & classNames )

inline

Sets the transient component class names.

This is used during paste operations as we can't resolve the component classes immediately until we have the true board context once the pasted items have been placed

Definition at line 1432 of file footprint.h.

References m_transientComponentClassNames.

◆ SetUnitInfo()

void FOOTPRINT::SetUnitInfo ( const std::vector< FP_UNIT_INFO > & aUnits )

inline

Definition at line 1016 of file footprint.h.

References m_unitInfo.

Referenced by COMPONENT::SetFootprint(), and BOARD_NETLIST_UPDATER::updateComponentUnits().

◆ SetUuid()

void BOARD_ITEM::SetUuid ( const KIID & aUuid )

inherited

Definition at line 118 of file board_item.cpp.

References BOARD, m_boardCacheOwner, EDA_ITEM::m_Uuid, and SetUuidDirect().

Referenced by BOOST_AUTO_TEST_CASE(), BOARD::ExchangeFootprint(), processTextItem(), ResetUuid(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ SetUuidDirect()

void BOARD_ITEM::SetUuidDirect ( const KIID & aUuid )

inherited

Raw UUID assignment.

No board index maintenance.

Use for detached/load-time items only. Prefer SetUuid() for normal callers.

Definition at line 134 of file board_item.cpp.

References EDA_ITEM::m_Uuid.

◆ SetValue()

void FOOTPRINT::SetValue ( const wxString & aValue )

inline

Parameters

aValue A reference to a wxString object containing the value text.

Definition at line 930 of file footprint.h.

References EDA_TEXT::SetText(), and Value().

◆ SetVariant()

void FOOTPRINT::SetVariant ( const FOOTPRINT_VARIANT & aVariant )

Add or update a variant.

Parameters

aVariant The variant to add or update.

Definition at line 1636 of file footprint.cpp.

References GetDefaultVariantName(), FOOTPRINT_VARIANT::GetName(), m_variants, and FOOTPRINT_VARIANT::SetName().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 155 of file board_item.h.

References GetY(), and EDA_ITEM::SetPosition().

Referenced by FOOTPRINT::AutoPositionFields(), and BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 161 of file board_item.h.

References GetX(), and EDA_ITEM::SetPosition().

Referenced by FOOTPRINT::AutoPositionFields(), and BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ Similarity()

double FOOTPRINT::Similarity ( const BOARD_ITEM & aItem ) const

overridevirtual

Return a measure of how likely the other object is to represent the same object.

The scale runs from 0.0 (definitely different objects) to 1.0 (same)

This is a pure virtual function. Derived classes must implement this.

Implements BOARD_ITEM.

Definition at line 4971 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), FindPadByNumber(), FOOTPRINT(), m_pads, pad, PCB_FOOTPRINT_T, and EDA_ITEM::Type().

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ Sort()

static bool EDA_ITEM::Sort	(	const EDA_ITEM *	aLeft,
		const EDA_ITEM *	aRight )

inlinestaticinherited

Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns: True if aLeft is less than aRight.

Definition at line 538 of file eda_item.h.

References EDA_ITEM().

◆ StringLibNameInvalidChars()

const wxChar * FOOTPRINT::StringLibNameInvalidChars ( bool aUserReadable )

static

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

Parameters

aUserReadable set to false to get the list of invalid characters or true to get a readable form (i.e ' ' = 'space' '\t'= 'tab').

Returns: the list of invalid chars in the library name.

Definition at line 3404 of file footprint.cpp.

References GetLibFilenameForbiddenChars().

Referenced by DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::checkFootprintName(), IsLibNameValid(), and SAVE_AS_DIALOG::SAVE_AS_DIALOG().

◆ StyleFromSettings()

virtual void BOARD_ITEM::StyleFromSettings	(	const BOARD_DESIGN_SETTINGS &	settings,
		bool	aCheckSide )

inlinevirtualinherited

Reimplemented in PCB_BARCODE, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, and PCB_TEXTBOX.

Definition at line 423 of file board_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ swapData()

void FOOTPRINT::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtual

Reimplemented from BOARD_ITEM.

Definition at line 4870 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), FOOTPRINT(), image, NO_RECURSE, PCB_FOOTPRINT_T, RunOnChildren(), EDA_ITEM::SetParent(), and EDA_ITEM::Type().

◆ SwapItemData()

void BOARD_ITEM::SwapItemData ( BOARD_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

Used in undo and redo commands to swap values between an item and its copy. Only values like layer, size .. which are modified by editing are swapped.

Parameters

aImage the item image which contains data to swap.

Definition at line 320 of file board_item.cpp.

References BOARD, BOARD_ITEM(), BOARD::CacheChildrenById(), EDA_ITEM::EDA_ITEM(), GetBoard(), GetParent(), EDA_ITEM::GetParentGroup(), group, EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), swapData(), and BOARD::UncacheChildrenById().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), and BOARD_COMMIT::Revert().

◆ TextOnly()

bool FOOTPRINT::TextOnly ( ) const

Definition at line 2197 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), m_drawings, m_privateLayers, PCB_FIELD_T, and PCB_TEXT_T.

◆ TransformFPShapesToPolySet()

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

Useful to generate a polygonal representation of a footprint in 3D view and plot functions, when a full polygonal approach is needed.

Parameters

aLayer	is the layer to consider, or UNDEFINED_LAYER to consider all.
aBuffer	is the buffer to store polygons.
aClearance	is a value to inflate shapes.
aError	is the maximum error between true arc and polygon approximation.
aIncludeText	set to true to transform text shapes.
aIncludeShapes	set to true to transform footprint shapes.

Definition at line 5341 of file footprint.cpp.

References BOARD_ITEM::BOARD_ITEM(), BOARD_ITEM::GetLayer(), PCB_SHAPE::GetLayer(), GetPrivateLayers(), GraphicalItems(), PCB_TEXTBOX::IsBorderEnabled(), m_fields, PCB_BARCODE_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, text, BOARD_ITEM::TransformShapeToPolySet(), PCB_SHAPE::TransformShapeToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), and UNDEFINED_LAYER.

Referenced by EXPORTER_STEP::buildFootprint3DShapes(), CoverageRatio(), enclosedByAreaFunc(), and TransformFPTextToPolySet().

◆ TransformFPTextToPolySet()

void FOOTPRINT::TransformFPTextToPolySet	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc ) const

inline

This function is the same as TransformFPShapesToPolySet but only generates text.

Definition at line 845 of file footprint.h.

References TransformFPShapesToPolySet().

◆ TransformPadsToPolySet()

void FOOTPRINT::TransformPadsToPolySet	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aMaxError,
		ERROR_LOC	aErrorLoc ) const

Generate pads shapes on layer aLayer as polygons and adds these polygons to aBuffer.

Useful to generate a polygonal representation of a footprint in 3D view and plot functions, when a full polygonal approach is needed.

Parameters

aLayer	is the layer to consider, or UNDEFINED_LAYER to consider all layers.
aBuffer	i the buffer to store polygons.
aClearance	is an additional size to add to pad shapes.
aMaxError	is the maximum deviation from true for arcs.

Definition at line 5271 of file footprint.cpp.

References B_Mask, B_Paste, clearance, CUSTOM, dummy, F_Mask, F_Paste, m_pads, pad, UNDEFINED_LAYER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CoverageRatio(), and enclosedByAreaFunc().

◆ TransformShapeToPolygon()

void BOARD_ITEM::TransformShapeToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc,
		bool	ignoreLineWidth = false ) const

virtualinherited

Convert the item shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the polygonal shape (inflated polygon).
aError	the maximum deviation from true circle.
aErrorLoc	should the approximation error be placed outside or inside the polygon?
ignoreLineWidth	used for edge cut items where the line width is only for visualization.

Reimplemented in PAD, PCB_BARCODE, PCB_DIMENSION_BASE, PCB_GRID_ITEM, PCB_MARKER, PCB_POINT, PCB_SHAPE, PCB_TABLE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, and ZONE.

Definition at line 372 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass().

Referenced by addItemPolysWithEndings(), addItemPolysWithEndings(), addItemPolysWithEndings(), ZONE_FILLER::addKnockout(), ZONE_FILLER::addKnockout(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkReturnPath(), FOOTPRINT::CoverageRatio(), enclosedByAreaFunc(), FOOTPRINT::GetCoverageArea(), process(), PNS_KICAD_IFACE_BASE::syncTextItem(), and TransformShapeToPolySet().

◆ TransformShapeToPolySet()

virtual void BOARD_ITEM::TransformShapeToPolySet	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc,
		KIGFX::RENDER_SETTINGS *	aRenderSettings = nullptr ) const

inlinevirtualinherited

Convert the item shape to a polyset.

Circles and arcs are approximated by segments; hatched fills and details (if any) will be included.

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the pad.
aError	the maximum deviation from true circle.
aErrorLoc	should the approximation error be placed outside or inside the polygon?
aRenderSettings	used to plot outlines with not solid segments like dashed lines. So it is not used by all BOARD_ITEMS. If null lines like dashed will be converted as SOLID

Reimplemented in PCB_SHAPE, and PCB_TABLE.

Definition at line 542 of file board_item.h.

References TransformShapeToPolygon().

Referenced by BOARD_ADAPTER::addBarCode(), EXPORTER_STEP::buildGraphic3DShape(), ComputeBoardStatistics(), BOARD_ADAPTER::createLayers(), KIGFX::PCB_PAINTER::draw(), PCB_TRACK::GetMsgPanelInfo(), CONVERT_TOOL::makePolysFromClosedGraphics(), BRDITEMS_PLOTTER::PlotBarCode(), and FOOTPRINT::TransformFPShapesToPolySet().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns: the type of object.

Definition at line 110 of file eda_item.h.

References m_structType.

◆ UpdateFields()

void FOOTPRINT::UpdateFields	(	const std::vector< PCB_FIELD > &	aFields,
		std::vector< PCB_FIELD * > &	aAdded,
		std::vector< PCB_FIELD * > &	aDetached )

Replace the fields with aFields, reusing the existing mandatory field objects.

Destroying and recreating a mandatory field invalidates every pointer to it, including the board's item-by-id cache entry, and leaves the footprint without a reference or a value for as long as the rebuild takes. The const field accessors return nullptr in that state, so anything reading the footprint meanwhile dereferences null.

Parameters

aFields	is the new field set, mandatory fields included.
aAdded	receives the fields created here, which the footprint now owns.
aDetached	receives the fields dropped here, which the caller must dispose of.

Definition at line 952 of file footprint.cpp.

References Add(), EDA_ITEM::ClearEditFlags(), PCB_FIELD::CloneField(), alg::contains(), GetField(), InvalidateGeometryCaches(), m_fields, Remove(), and EDA_ITEM::SetParent().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ UpdateFontFiles()

const std::vector< wxString > * EMBEDDED_FILES::UpdateFontFiles ( )

inherited

Helper function to get a list of fonts for fontconfig to add to the library.

This is necessary because EMBEDDED_FILES lives in common at the moment and fontconfig is in libkicommon. This will create the cache files in the KiCad cache directory (if they do not already exist) and return the temp files names

Definition at line 650 of file embedded_files.cpp.

References EMBEDDED_FILES::EMBEDDED_FILE::FONT, GetTemporaryFileName(), m_files, m_fontFiles, and name.

Referenced by ORCAD_CONVERTER::applyFont(), SCH_SCREEN::FixupEmbeddedData(), PCB_IO_KICAD_SEXPR_PARSER::Parse(), and SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol().

◆ Value() [1/2]

PCB_FIELD & FOOTPRINT::Value ( )

inline

read/write accessors:

Definition at line 939 of file footprint.h.

References GetField(), and VALUE.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), AutoPositionFields(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ZONE_FILLER::buildCopperItemClearances(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), DIPTRACE::PCB_PARSER::CreateFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), GetValue(), idf_export_footprint(), PCB_IO_EAGLE::loadElements(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FABMASTER::loadFootprints(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS_BINARY::loadFootprints(), PCB_IO_EAGLE::orientFootprintAndText(), PCB_IO_EAGLE::packageText(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), SPRINT_LAYOUT_PARSER::processText(), and SetValue().

◆ Value() [2/2]

const PCB_FIELD & FOOTPRINT::Value ( ) const

inline

The const versions to keep the compiler happy.

Definition at line 943 of file footprint.h.

References GetField(), and VALUE.

◆ ViewBBox()

const BOX2I FOOTPRINT::ViewBBox ( ) const

overridevirtual

Return the bounding box of the item covering all its layers.

Returns: the current bounding box.

Reimplemented from EDA_ITEM.

Definition at line 3378 of file footprint.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::GetBoard(), GetBoundingBox(), and BOX2< Vec >::Inflate().

◆ ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw	(	int	aLayer,
		VIEW *	aView ) const

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects if there is no #PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Reimplemented in CONSTRAINT_BADGE_ITEM, DS_PROXY_VIEW_ITEM, EDIT_POINTS, KIGFX::ANCHOR_DEBUG, KIGFX::CONSTRUCTION_GEOM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::BEZIER_ASSISTANT, KIGFX::PREVIEW::ELLIPSE_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::SNAP_INDICATOR, KIGFX::VIEW_GROUP, KIGFX::VIEW_OVERLAY, MY_DRAWING, PCB_TUNING_PATTERN, PCB_VIA_STITCH, RATSNEST_VIEW_ITEM, RECT_RADIUS_TEXT_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, TUNING_STATUS_VIEW_ITEM, and VIEW_OVERLAY.

Definition at line 123 of file view_item.h.

References VIEW.

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

◆ ViewGetLayers()

std::vector< int > FOOTPRINT::ViewGetLayers ( ) const

overridevirtual

Return the all the layers within the VIEW the object is painted on.

For instance, a PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Reimplemented from BOARD_ITEM.

Definition at line 3293 of file footprint.cpp.

References B_Cu, B_SilkS, BOARD_ITEM::BOARD_ITEM(), F_Cu, F_SilkS, KI_FALLTHROUGH, LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, m_drawings, BOARD_ITEM::m_layer, and m_pads.

◆ ViewGetLOD()

double FOOTPRINT::ViewGetLOD	(	int	aLayer,
		const KIGFX::VIEW *	aView ) const

overridevirtual

Return the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Use LOD_HIDE and LOD_SHOW constants to hide or show the item unconditionally.

Use lodScaleForThreshold() to calculate the LOD scale for when the item passes a certain threshold size on screen.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Returns: the level of detail. 0 always shows the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 3345 of file footprint.cpp.

References B_Cu, F_Cu, IsConflicting(), KIGFX::VIEW::IsLayerVisible(), LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, KIGFX::VIEW_ITEM::LOD_HIDE, KIGFX::VIEW_ITEM::LOD_SHOW, and BOARD_ITEM::m_layer.

◆ viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

◆ Visit()

INSPECT_RESULT FOOTPRINT::Visit	(	INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	aScanTypes )

overridevirtual

May be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in aScanTypes, and may use IterateForward() to do so on lists of such data.

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns: #SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Reimplemented from EDA_ITEM.

Definition at line 3137 of file footprint.cpp.

References CONTINUE, GetClass(), EDA_ITEM::IterateForward(), m_constraints, m_drawings, m_fields, m_groups, m_pads, m_points, m_zones, PCB_BARCODE_T, PCB_CONSTRAINT_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_PAD_T, PCB_POINT_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_ZONE_T, and QUIT.

◆ WriteEmbeddedFiles()

void EMBEDDED_FILES::WriteEmbeddedFiles	(	OUTPUTFORMATTER &	aOut,
		bool	aWriteData ) const

inherited

Output formatter for the embedded files.

Parameters

aOut	is the output formatter.
aWriteData	is true if the actual data should be written. This is false when writing an element that is already embedded in a file that itself has embedded files (boards, schematics, etc.).

Definition at line 210 of file embedded_files.cpp.

References EMBEDDED_FILES::EMBEDDED_FILE::compressedEncodedData, EMBEDDED_FILES::EMBEDDED_FILE::data_hash, EMBEDDED_FILES::EMBEDDED_FILE::DATASHEET, EMBEDDED_FILES::EMBEDDED_FILE::FONT, m_files, MIME_BASE64_LENGTH, EMBEDDED_FILES::EMBEDDED_FILE::MODEL, EMBEDDED_FILES::EMBEDDED_FILE::name, name, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), EMBEDDED_FILES::EMBEDDED_FILE::type, and EMBEDDED_FILES::EMBEDDED_FILE::WORKSHEET.

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 159 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

◆ Zones() [1/2]

◆ Zones() [2/2]

const ZONES & FOOTPRINT::Zones ( ) const

inline

Definition at line 411 of file footprint.h.

References m_zones.

Member Data Documentation

◆ LOD_HIDE

double KIGFX::VIEW_ITEM::LOD_HIDE = std::numeric_limits<double>::max()

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to hide the item unconditionally.

Definition at line 176 of file view_item.h.

Referenced by lodScaleForThreshold(), KIGFX::VIEW_GROUP::ViewDraw(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_BARCODE::ViewGetLOD(), PCB_DIMENSION_BASE::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GRID_ITEM::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TABLE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ LOD_SHOW

double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to show the item unconditionally.

Definition at line 181 of file view_item.h.

Referenced by lodScaleForThreshold(), FOOTPRINT::ViewGetLOD(), GERBER_DRAW_ITEM::ViewGetLOD(), ViewGetLOD(), PAD::ViewGetLOD(), PCB_BARCODE::ViewGetLOD(), PCB_DIMENSION_BASE::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GRID_ITEM::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TABLE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ m_3D_Drawings

std::vector<FP_3DMODEL> FOOTPRINT::m_3D_Drawings

private

Definition at line 1560 of file footprint.h.

Referenced by Add3DModel(), FOOTPRINT(), FOOTPRINT(), GetMsgPanelInfo(), Models(), Models(), operator=(), and operator=().

◆ m_allowMissingCourtyard

bool FOOTPRINT::m_allowMissingCourtyard

private

Definition at line 1535 of file footprint.h.

Referenced by AllowMissingCourtyard(), FOOTPRINT(), FOOTPRINT(), and SetAllowMissingCourtyard().

◆ m_allowSolderMaskBridges

bool FOOTPRINT::m_allowSolderMaskBridges

private

Definition at line 1536 of file footprint.h.

Referenced by AllowSolderMaskBridges(), FOOTPRINT(), FOOTPRINT(), and SetAllowSolderMaskBridges().

◆ m_arflag

int FOOTPRINT::m_arflag

private

Definition at line 1557 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), GetFlag(), IncrementFlag(), and SetFlag().

◆ m_attributes

int FOOTPRINT::m_attributes

private

Definition at line 1498 of file footprint.h.

Referenced by Deserialize(), FOOTPRINT(), FOOTPRINT(), GetAttributes(), GetFootprintType(), IsBoardOnly(), IsDNP(), IsExcludedFromBOM(), IsExcludedFromPosFiles(), IsExcludedFromSim(), operator=(), operator=(), Serialize(), SetAttributes(), SetBoardOnly(), SetDNP(), SetExcludedFromBOM(), SetExcludedFromPosFiles(), SetExcludedFromSim(), and SetFootprintType().

◆ m_boardCacheOwner

BOARD* BOARD_ITEM::m_boardCacheOwner = nullptr

mutableprotectedinherited

Definition at line 576 of file board_item.h.

Referenced by BOARD::CacheAndReturnItemById(), BOARD::CacheItemById(), BOARD::ClearItemByIdCache(), IsIndexedInBoard(), SetUuid(), BOARD::UncacheItemById(), BOARD::UncacheItemByPtr(), and ~BOARD_ITEM().

◆ m_clearance

std::optional<int> FOOTPRINT::m_clearance

private

Definition at line 1540 of file footprint.h.

Referenced by FOOTPRINT(), GetLocalClearance(), GetLocalClearance(), operator=(), operator=(), and SetLocalClearance().

◆ m_componentClassCacheProxy

std::unique_ptr<COMPONENT_CLASS_CACHE_PROXY> FOOTPRINT::m_componentClassCacheProxy

private

Definition at line 1571 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), FOOTPRINT(), GetComponentClass(), GetComponentClassAsString(), GetMsgPanelInfo(), GetStaticComponentClass(), InvalidateComponentClassCache(), operator=(), operator=(), RecomputeComponentClass(), and SetStaticComponentClass().

◆ m_constraints

std::deque<PCB_CONSTRAINT*> FOOTPRINT::m_constraints

private

Definition at line 1492 of file footprint.h.

Referenced by Add(), Constraints(), Constraints(), operator=(), operator=(), Remove(), RunOnChildren(), Visit(), and ~FOOTPRINT().

◆ m_courtyard_cache

std::unique_ptr<FOOTPRINT_COURTYARD_CACHE_DATA> FOOTPRINT::m_courtyard_cache

mutableprivate

Definition at line 1567 of file footprint.h.

Referenced by BuildCourtyardCaches(), Flip(), GetCachedCourtyard(), GetCourtyard(), InvalidateGeometryCaches(), MoveAnchorPosition(), operator=(), operator=(), SetOrientation(), SetPosition(), and SetTransformScale().

◆ m_courtyard_cache_mutex

std::mutex FOOTPRINT::m_courtyard_cache_mutex

mutableprivate

Definition at line 1568 of file footprint.h.

Referenced by GetCourtyard(), and InvalidateGeometryCaches().

◆ m_customProperties

std::map<wxString, wxString> EDA_ITEM::m_customProperties

protectedinherited

Definition at line 615 of file eda_item.h.

Referenced by ClearCustomProperties(), GetCustomProperties(), GetCustomPropertiesAsInspectables(), GetCustomProperty(), HasCustomProperties(), operator=(), RemoveConflictingCustomProperties(), RemoveCustomProperty(), SetCustomProperties(), SetCustomProperty(), LIB_SYMBOL::SetParent(), PCB_BARCODE::swapData(), PCB_REFERENCE_IMAGE::swapData(), PCB_SHAPE::swapData(), PCB_TABLE::swapData(), and SCH_ITEM::SwapItemData().

◆ m_drawings

std::deque<BOARD_ITEM*> FOOTPRINT::m_drawings

private

Definition at line 1488 of file footprint.h.

Referenced by Add(), ApplyDefaultSettings(), BuildNetTieCache(), CheckClippedSilk(), CheckNetTies(), FixUuids(), Flip(), GetBoundingBox(), GetBoundingHull(), GetBoundingHull(), GetLayerBoundingBox(), GetSide(), GraphicalItems(), GraphicalItems(), HitTest(), HitTest(), HitTestOnLayer(), HitTestOnLayer(), IsOnLayer(), operator=(), operator=(), operator==(), Remove(), Rotate(), RunOnChildren(), SetOrientation(), SetPosition(), SetTransformScale(), TextOnly(), ViewGetLayers(), Visit(), and ~FOOTPRINT().

◆ m_duplicatePadNumbersAreJumpers

bool FOOTPRINT::m_duplicatePadNumbersAreJumpers

private

Flag that this footprint should automatically treat sets of two or more pads with the same number as jumpered pin groups.

Definition at line 1533 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), GetDuplicatePadNumbersAreJumpers(), operator=(), operator=(), and SetDuplicatePadNumbersAreJumpers().

◆ m_dynamicCustomPropsCache

std::map<wxString, std::unique_ptr<PROPERTY_BASE> > EDA_ITEM::m_dynamicCustomPropsCache

mutableprotectedinherited

Per-key cache of dynamic property descriptors for m_customProperties, owned by this object.

Mirrors the per-object field-property caches used by FOOTPRINT / SCH_SYMBOL / SCH_SHEET; entries linger after a key is removed but are simply not enumerated.

Definition at line 621 of file eda_item.h.

Referenced by GetCustomPropertiesAsInspectables(), and RemoveCustomProperty().

◆ m_dynamicPropertyCache

std::map<wxString, std::unique_ptr<PCB_FOOTPRINT_FIELD_PROPERTY> > FOOTPRINT::m_dynamicPropertyCache

mutableprivate

Definition at line 1518 of file footprint.h.

Referenced by GetDynamicProperties().

◆ m_embedFonts

bool EMBEDDED_FILES::m_embedFonts = false

protectedinherited

If set, fonts will be embedded in the element on save.

Otherwise, font files embedded in the element will be removed on save.

Definition at line 307 of file embedded_files.h.

Referenced by EMBEDDED_FILES(), EMBEDDED_FILES(), FOOTPRINT::FOOTPRINT(), FOOTPRINT::FOOTPRINT(), GetAreFontsEmbedded(), operator=(), operator=(), and SetAreFontsEmbedded().

◆ m_extrudedBody

std::unique_ptr<EXTRUDED_3D_BODY> FOOTPRINT::m_extrudedBody

private

Definition at line 1562 of file footprint.h.

Referenced by ClearExtrudedBody(), EnsureExtrudedBody(), Flip(), FOOTPRINT(), GetExtrudedBody(), GetExtrudedBody(), HasExtrudedBody(), operator=(), operator=(), and SetExtrudedBody().

◆ m_fields

std::deque<PCB_FIELD*> FOOTPRINT::m_fields

private

Definition at line 1487 of file footprint.h.

Referenced by Add(), ApplyDefaultSettings(), CheckNetTies(), DeserializeDefinition(), FixUuids(), Flip(), FOOTPRINT(), FOOTPRINT(), GetBoundingBox(), GetField(), GetField(), GetField(), GetFields(), GetFields(), GetFields(), GetNextFieldOrdinal(), IsOnLayer(), MoveAnchorPosition(), operator=(), operator=(), Remove(), Rotate(), RunOnChildren(), SerializeDefinition(), SetOrientation(), SetPosition(), SetTransformScale(), TransformFPShapesToPolySet(), UpdateFields(), Visit(), and ~FOOTPRINT().

◆ m_fileAddedCallback

FILE_ADDED_CALLBACK EMBEDDED_FILES::m_fileAddedCallback

privateinherited

Definition at line 304 of file embedded_files.h.

Referenced by AddFile(), AddFile(), EMBEDDED_FILES(), EMBEDDED_FILES(), GetFileAddedCallback(), operator=(), operator=(), and SetFileAddedCallback().

◆ m_fileFormatVersionAtLoad

int FOOTPRINT::m_fileFormatVersionAtLoad

private

Definition at line 1500 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), GetFileFormatVersionAtLoad(), and SetFileFormatVersionAtLoad().

◆ m_files

std::map<wxString, std::shared_ptr<EMBEDDED_FILE> > EMBEDDED_FILES::m_files

privateinherited

Definition at line 302 of file embedded_files.h.

Referenced by AddFile(), AddFile(), AssignSharedFrom(), ClearEmbeddedFiles(), ClearEmbeddedFonts(), EMBEDDED_FILES(), EMBEDDED_FILES(), EmbeddedFileMap(), GetEmbeddedFile(), GetTemporaryFileName(), HasFile(), IsEmpty(), operator=(), operator=(), RemoveFile(), UpdateFontFiles(), and WriteEmbeddedFiles().

◆ m_filters

wxString FOOTPRINT::m_filters

private

Definition at line 1555 of file footprint.h.

Referenced by Deserialize(), FOOTPRINT(), GetFilters(), Serialize(), and SetFilters().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 606 of file eda_item.h.

Referenced by ClearFlags(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), SCH_PIN::GetBoundingBox(), GetEditFlags(), GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), GetTempFlags(), HasFlag(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_JUNCTION::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_LINE::HitTest(), SCH_PIN::HitTest(), SCH_PIN::HitTest(), SCH_SHAPE::HitTest(), SCH_SHAPE::HitTest(), SCH_SYMBOL::HitTest(), SCH_SYMBOL::HitTest(), SCH_TEXT::HitTest(), SCH_TEXT::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), IsBrightened(), SCH_ITEM::IsConnected(), IsEntered(), IsModified(), IsMoving(), IsNew(), IsSelected(), IsShownAsBitmap(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), operator=(), PCB_SHAPE::operator==(), SCH_LINE::Rotate(), SetFlags(), LIB_SYMBOL::Similarity(), PCB_SHAPE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), PCB_SHAPE::swapData(), SCH_ITEM::SwapFlags(), SCH_PIN::ViewBBox(), and XorFlags().

◆ m_flipped

bool FOOTPRINT::m_flipped = false

private

Definition at line 1496 of file footprint.h.

Referenced by Flip(), FOOTPRINT(), operator=(), operator=(), and SetLayer().

◆ m_fontFiles

std::vector<wxString> EMBEDDED_FILES::m_fontFiles

privateinherited

Definition at line 303 of file embedded_files.h.

Referenced by EMBEDDED_FILES(), EMBEDDED_FILES(), GetFontFiles(), operator=(), operator=(), and UpdateFontFiles().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 206 of file view_item.h.

Referenced by GetForcedTransparency(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), SetForcedTransparency(), and VIEW_ITEM().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 612 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), ZONE::InitDataFromSrcInCopyCtor(), IsForceVisible(), operator=(), PCB_SHAPE::operator==(), SetForceVisible(), LIB_SYMBOL::SetParent(), PCB_SHAPE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), and PCB_SHAPE::swapData().

◆ m_fpid

LIB_ID FOOTPRINT::m_fpid

private

Definition at line 1497 of file footprint.h.

Referenced by FOOTPRINT(), GetFPID(), GetFPIDAsString(), GetLIB_ID(), GetLibNickname(), GetMsgPanelInfo(), GetName(), operator=(), operator=(), ResolveTextVar(), SetFPID(), and SetFPIDAsString().

◆ m_fpStatus

int FOOTPRINT::m_fpStatus

private

Definition at line 1499 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), IsLocked(), IsPlaced(), LegacyPadsLocked(), NeedsPlaced(), operator=(), operator=(), SetIsPlaced(), SetLocked(), and SetNeedsPlaced().

◆ m_geometry_cache

std::unique_ptr<FOOTPRINT_GEOMETRY_CACHE_DATA> FOOTPRINT::m_geometry_cache

mutableprivate

Definition at line 1516 of file footprint.h.

Referenced by Flip(), FOOTPRINT(), GetBoundingBox(), GetBoundingHull(), InvalidateGeometryCaches(), MoveAnchorPosition(), operator=(), operator=(), SetOrientation(), SetPosition(), and SetTransformScale().

◆ m_geometry_cache_mutex

std::mutex FOOTPRINT::m_geometry_cache_mutex

mutableprivate

Definition at line 1515 of file footprint.h.

Referenced by GetBoundingBox(), GetBoundingHull(), and InvalidateGeometryCaches().

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

The group this item belongs to, if any. No ownership implied.

Definition at line 608 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), GetParentGroup(), operator=(), SCH_LINE::SCH_LINE(), and SetParentGroup().

◆ m_groups

std::deque<PCB_GROUP*> FOOTPRINT::m_groups

private

Definition at line 1491 of file footprint.h.

Referenced by Add(), FixUuids(), Groups(), Groups(), operator=(), operator=(), Remove(), RunOnChildren(), Visit(), and ~FOOTPRINT().

◆ m_initial_comments

wxArrayString* FOOTPRINT::m_initial_comments

private

Definition at line 1564 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), GetInitialComments(), operator=(), operator=(), SetInitialComments(), and ~FOOTPRINT().

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 204 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 572 of file board_item.h.

Referenced by BOARD_ITEM(), BOARD_ITEM(), IsKnockout(), operator=(), PCB_SHAPE::operator==(), SetIsKnockout(), PCB_SHAPE::Similarity(), PCB_BARCODE::swapData(), PCB_REFERENCE_IMAGE::swapData(), and PCB_SHAPE::swapData().

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 573 of file board_item.h.

Referenced by BOARD_ITEM(), BOARD_ITEM(), IsLocked(), operator=(), PCB_SHAPE::operator==(), SetLocked(), PCB_SHAPE::Similarity(), PCB_BARCODE::swapData(), PCB_DRILL_MAP::swapData(), PCB_REFERENCE_IMAGE::swapData(), PCB_SHAPE::swapData(), and PCB_TABLE::swapData().

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 611 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), IsRollover(), operator=(), SetIsRollover(), and LIB_SYMBOL::SetParent().

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 203 of file view_item.h.

Referenced by IsSCH_ITEM(), and VIEW_ITEM().

◆ m_jumperPadGroups

std::vector<std::set<wxString> > FOOTPRINT::m_jumperPadGroups

private

A list of jumper pad groups, each of which is a set of pad numbers that should be jumpered together (treated as internally connected for the purposes of connectivity)

Definition at line 1529 of file footprint.h.

Referenced by FOOTPRINT(), GetJumperPadGroup(), JumperPadGroups(), JumperPadGroups(), operator=(), and operator=().

◆ m_keywords

wxString FOOTPRINT::m_keywords

private

Definition at line 1551 of file footprint.h.

Referenced by FOOTPRINT(), GetKeywords(), GetMsgPanelInfo(), operator=(), operator=(), and SetKeywords().

◆ m_lastEditTime

timestamp_t FOOTPRINT::m_lastEditTime

private

Definition at line 1556 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), operator=(), and operator=().

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 571 of file board_item.h.

Referenced by PCB_BARCODE::AssembleBarcode(), BOARD_ITEM(), BOARD_ITEM(), PCB_BARCODE::computeCacheKey(), PCB_BARCODE::Deserialize(), FOOTPRINT::FOOTPRINT(), PCB_BARCODE::GetBoundingHull(), PCB_VIA::GetDrillConstraint(), GetLayer(), FOOTPRINT::GetLayer(), PCB_GENERATOR::GetLayer(), PCB_SHAPE::GetLayer(), GetLayerName(), GetLayerSet(), PCB_SHAPE::GetLayerSet(), PCB_TRACK::GetLayerSet(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PAD::GetPrincipalLayer(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_TRACK::GetSolderMaskExpansion(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), IsOnLayer(), PCB_SHAPE::IsOnLayer(), PCB_TRACK::IsOnLayer(), IsSideSpecific(), PCB_SHAPE::IsType(), operator=(), PCB_ARC::operator==(), PCB_REFERENCE_IMAGE::operator==(), PCB_SHAPE::operator==(), PCB_TARGET::operator==(), PCB_TRACK::operator==(), PCB_VIA::operator==(), PCB_BARCODE::PCB_BARCODE(), PCB_DIMENSION_BASE::PCB_DIMENSION_BASE(), PCB_TARGET::PCB_TARGET(), PCB_TARGET::PCB_TARGET(), PCB_POINT::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), SetLayer(), PCB_BARCODE::SetLayer(), PCB_GENERATOR::SetLayer(), PCB_TABLE::SetLayer(), PAD::SetLayerSet(), PCB_ARC::Similarity(), PCB_REFERENCE_IMAGE::Similarity(), PCB_TRACK::Similarity(), PCB_VIA::Similarity(), PCB_DIMENSION_BASE::StyleFromSettings(), PCB_BARCODE::swapData(), PCB_DRILL_MAP::swapData(), PCB_REFERENCE_IMAGE::swapData(), PCB_SHAPE::swapData(), PCB_TABLE::swapData(), PCB_BARCODE::TransformShapeToPolygon(), ViewGetLayers(), FOOTPRINT::ViewGetLayers(), PCB_REFERENCE_IMAGE::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), FOOTPRINT::ViewGetLOD(), PCB_BARCODE::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TABLE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), and PCB_TRACK::ViewGetLOD().

◆ m_libDescription

wxString FOOTPRINT::m_libDescription

private

Definition at line 1550 of file footprint.h.

Referenced by FOOTPRINT(), GetLibDescription(), GetMsgPanelInfo(), operator=(), operator=(), and SetLibDescription().

◆ m_link

KIID FOOTPRINT::m_link

private

Definition at line 1558 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), GetLink(), operator=(), operator=(), and SetLink().

◆ m_netHighlighted

bool EDA_ITEM::m_netHighlighted = false

protectedinherited

Definition at line 613 of file eda_item.h.

Referenced by ClearFlags(), IsBrightened(), IsNetHighlighted(), operator=(), SetNetHighlighted(), and LIB_SYMBOL::SetParent().

◆ m_netTieCache

std::map<const BOARD_ITEM*, std::set<int> > FOOTPRINT::m_netTieCache

private

Definition at line 1525 of file footprint.h.

Referenced by BuildNetTieCache(), and GetNetTieCache().

◆ m_netTiePadGroups

std::vector<wxString> FOOTPRINT::m_netTiePadGroups

private

Definition at line 1522 of file footprint.h.

Referenced by AddNetTiePadGroup(), ClearNetTiePadGroups(), DeserializeDefinition(), FOOTPRINT(), GetNetTiePadGroups(), IsNetTie(), MapPadNumbersToNetTieGroups(), operator=(), and operator=().

◆ m_pads

std::deque<PAD*> FOOTPRINT::m_pads

private

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 607 of file eda_item.h.

Referenced by PCB_BOARD_OUTLINE::CopyPros(), SCH_FIELD::Deserialize(), SCH_FIELD::DoHypertextAction(), EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetDefaultLayer(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), BOARD_ITEM::GetParent(), GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetShownText(), SCH_FIELD::GetText(), SCH_FIELD::getUnescapedText(), SCH_FIELD::GetUntranslatedName(), SCH_FIELD::HitTest(), SCH_FIELD::IsLocked(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), BOARD_BOUNDING_BOX::operator=(), operator=(), PAD::operator==(), PCB_BOARD_OUTLINE::operator==(), SCH_FIELD::operator==(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_FIELD::Replace(), SCH_ITEM::ResolveText(), SCH_LABEL_BASE::ResolveTextVar(), SCH_FIELD::SCH_FIELD(), SCH_SYMBOL::SCH_SYMBOL(), SCH_FIELD::Serialize(), SetModified(), SetParent(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), and PCB_SHAPE::swapData().

◆ m_path

KIID_PATH FOOTPRINT::m_path

private

Definition at line 1552 of file footprint.h.

Referenced by Deserialize(), FOOTPRINT(), GetPath(), IsWithinSchematicSheet(), operator=(), operator=(), Serialize(), and SetPath().

◆ m_points

std::deque<PCB_POINT*> FOOTPRINT::m_points

private

Definition at line 1493 of file footprint.h.

Referenced by Add(), DuplicateItem(), FixUuids(), Flip(), GetBoundingBox(), GetLayerBoundingBox(), HitTest(), MoveAnchorPosition(), operator=(), operator=(), operator==(), Points(), Points(), Remove(), RunOnChildren(), SetOrientation(), SetPosition(), SetTransformScale(), Visit(), and ~FOOTPRINT().

◆ m_privateLayers

LSET FOOTPRINT::m_privateLayers

private

Definition at line 1548 of file footprint.h.

Referenced by FOOTPRINT(), GetBoundingBox(), GetBoundingHull(), GetBoundingHull(), GetLayerBoundingBox(), GetPrivateLayers(), operator=(), operator=(), SetPrivateLayers(), and TextOnly().

◆ m_rolloverPos

VECTOR2I EDA_ITEM::m_rolloverPos

protectedinherited

Definition at line 610 of file eda_item.h.

Referenced by GetRolloverPos(), and SetIsRollover().

◆ m_searchTerms

std::vector<SEARCH_TERM> FOOTPRINT::m_searchTerms

private

Definition at line 1576 of file footprint.h.

Referenced by GetSearchTerms().

◆ m_sheetfile

wxString FOOTPRINT::m_sheetfile

private

Definition at line 1554 of file footprint.h.

Referenced by Deserialize(), FOOTPRINT(), GetSheetfile(), Serialize(), and SetSheetfile().

◆ m_sheetname

wxString FOOTPRINT::m_sheetname

private

Definition at line 1553 of file footprint.h.

Referenced by Deserialize(), FOOTPRINT(), GetSheetname(), Serialize(), and SetSheetname().

◆ m_solderMaskMargin

std::optional<int> FOOTPRINT::m_solderMaskMargin

private

Definition at line 1541 of file footprint.h.

Referenced by FOOTPRINT(), GetLocalSolderMaskMargin(), operator=(), operator=(), and SetLocalSolderMaskMargin().

◆ m_solderPasteMargin

std::optional<int> FOOTPRINT::m_solderPasteMargin

private

Definition at line 1542 of file footprint.h.

Referenced by FOOTPRINT(), GetLocalSolderPasteMargin(), operator=(), operator=(), and SetLocalSolderPasteMargin().

◆ m_solderPasteMarginRatio

std::optional<double> FOOTPRINT::m_solderPasteMarginRatio

private

Definition at line 1543 of file footprint.h.

Referenced by FOOTPRINT(), GetLocalSolderPasteMarginRatio(), operator=(), operator=(), and SetLocalSolderPasteMarginRatio().

◆ m_stackupLayers

LSET FOOTPRINT::m_stackupLayers

private

Definition at line 1546 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), GetStackupLayers(), SetStackupLayers(), and SetStackupMode().

◆ m_stackupMode

FOOTPRINT_STACKUP FOOTPRINT::m_stackupMode

private

Definition at line 1547 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), GetStackupMode(), SetStackupLayers(), and SetStackupMode().

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

Definition at line 603 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), IsType(), and Type().

◆ m_transform

TRANSFORM_TRS FOOTPRINT::m_transform

private

Definition at line 1495 of file footprint.h.

Referenced by Flip(), FOOTPRINT(), GetBoundingBox(), GetOrientation(), GetOrientationDegrees(), GetPosition(), GetScaleX(), GetScaleY(), GetTransform(), Move(), operator=(), operator=(), RescaleAroundPoint(), Rotate(), SetOrientation(), SetPosition(), SetScaleX(), SetScaleY(), and SetTransformScale().

◆ m_transientComponentClassNames

std::unordered_set<wxString> FOOTPRINT::m_transientComponentClassNames

private

Definition at line 1570 of file footprint.h.

Referenced by ClearTransientComponentClassNames(), GetTransientComponentClassNames(), and SetTransientComponentClassNames().

◆ m_unitInfo

std::vector<FP_UNIT_INFO> FOOTPRINT::m_unitInfo

private

Definition at line 1574 of file footprint.h.

Referenced by GetUnitInfo(), and SetUnitInfo().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 597 of file eda_item.h.

◆ m_variants

CASE_INSENSITIVE_MAP<FOOTPRINT_VARIANT> FOOTPRINT::m_variants

private

Variant data for this footprint, keyed by variant name.

Definition at line 1503 of file footprint.h.

Referenced by AddVariant(), DeleteVariant(), Deserialize(), FOOTPRINT(), GetVariant(), GetVariant(), GetVariants(), HasVariant(), operator=(), operator=(), Remove(), RenameVariant(), Serialize(), and SetVariant().

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 205 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::unlinkItem(), KIGFX::VIEW::updateBbox(), KIGFX::VIEW::updateLayers(), VIEW_ITEM(), viewPrivData(), and ~VIEW_ITEM().

◆ m_zoneConnection

ZONE_CONNECTION FOOTPRINT::m_zoneConnection

private

Definition at line 1539 of file footprint.h.

Referenced by FOOTPRINT(), FOOTPRINT(), GetLocalZoneConnection(), GetZoneConnectionOverrides(), operator=(), operator=(), and SetLocalZoneConnection().

◆ m_zones

std::vector<ZONE*> FOOTPRINT::m_zones

private

Definition at line 1490 of file footprint.h.

Referenced by Add(), CheckNetTies(), DuplicateItem(), FixUuids(), Flip(), GetBoundingBox(), GetBoundingHull(), GetBoundingHull(), GetLayerBoundingBox(), GetSide(), HitTest(), HitTest(), HitTestOnLayer(), HitTestOnLayer(), IsOnLayer(), operator=(), operator=(), operator==(), Remove(), RunOnChildren(), SetOrientation(), SetPosition(), SetTransformScale(), Visit(), Zones(), Zones(), and ~FOOTPRINT().

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

A value of wxPoint(0,0) which can be passed to the Draw() functions.

Definition at line 232 of file board_item.h.

Referenced by BOARD::GetPosition().

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FILE_ADDED_CALLBACK

Member Enumeration Documentation

◆ COMPARE_FLAGS

◆ RETURN_CODE

Constructor & Destructor Documentation

◆ FOOTPRINT() [1/3]

◆ FOOTPRINT() [2/3]

◆ FOOTPRINT() [3/3]

◆ ~FOOTPRINT()

Member Function Documentation

◆ Add()

◆ Add3DModel()

◆ AddFile() [1/3]

◆ AddFile() [2/3]

◆ AddFile() [3/3]

◆ addMandatoryFields()

◆ AddNetTiePadGroup()

◆ AddVariant()

◆ AllowMissingCourtyard()

◆ AllowSolderMaskBridges()

◆ ApplyDefaultSettings()

◆ AssignSharedFrom()

◆ AutoPositionFields()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ BuildCourtyardCaches()

◆ BuildNetTieCache()

◆ CheckClippedSilk()

◆ CheckFootprintAttributes()

◆ CheckNetTiePadGroups()

◆ CheckNetTies()

◆ CheckPads()

◆ CheckShortingPads()

◆ ClassOf()

◆ ClearAllNets()

◆ ClearBrightened()

◆ ClearCustomProperties()

◆ ClearEditFlags()

◆ ClearEmbeddedFiles()

◆ ClearEmbeddedFonts()

◆ ClearExtrudedBody()

◆ ClearFlags()

◆ ClearNetTiePadGroups()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearTransientComponentClassNames()

◆ Clone()

◆ CompressAndEncode()

◆ ComputeFileHash()

◆ Constraints() [1/2]

◆ Constraints() [2/2]

◆ CopyFrom()

◆ CoverageRatio()

◆ DecompressAndDecode()

◆ Delete()

◆ DeleteStructure()

◆ DeleteVariant()

◆ Deserialize()

◆ DeserializeDefinition()

◆ DisambiguateItemDescription()

◆ Duplicate()

◆ DuplicateItem()

◆ EmbeddedFileMap()

◆ EmbedFonts()

◆ EnsureExtrudedBody()

◆ FindPadByNumber()