#include <pad.h>

Inheritance diagram for PAD:

Classes
struct	PAD_DRAW_CACHE_DATA

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

Public Member Functions
	PAD (FOOTPRINT *parent)

	PAD (const PAD &aPad)

PAD &	operator= (const PAD &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.

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

bool	HasHole () const override

bool	HasDrilledHole () const override

bool	IsLocked () const override

void	ImportSettingsFrom (const PAD &aMasterPad)
	Import the pad settings from aMasterPad.

bool	IsFlipped () const

void	SetNumber (const wxString &aNumber)
	Set the pad number (note that it can be alphanumeric, such as the array reference "AA12").

const wxString &	GetNumber () const

bool	CanHaveNumber () const
	Indicates whether or not the pad can have a number.

void	SetPinFunction (const wxString &aName)
	Set the pad function (pin name in schematic)

const wxString &	GetPinFunction () const

void	SetPinType (const wxString &aType)
	Set the pad electrical type.

const wxString &	GetPinType () const

bool	SameLogicalPadAs (const PAD *aOther) const
	Before we had custom pad shapes it was common to have multiple overlapping pads to represent a more complex shape.

bool	SharesNetTieGroup (const PAD *aOther) const

bool	IsNoConnectPad () const

bool	IsFreePad () const

void	SetPadstackMode (PADSTACK::MODE aMode)

PADSTACK::MODE	GetPadstackMode () const

void	SetShape (PCB_LAYER_ID aLayer, PAD_SHAPE aShape)
	Set the new shape of this pad.

PAD_SHAPE	GetShape (PCB_LAYER_ID aLayer) const

void	SetFrontShape (PAD_SHAPE aShape)

PAD_SHAPE	GetFrontShape () const

void	SetPosition (const VECTOR2I &aPos) override

VECTOR2I	GetPosition () const override

VECTOR2I	GetLibraryPosition () const

PAD_SHAPE	GetAnchorPadShape (PCB_LAYER_ID aLayer) const

CUSTOM_SHAPE_ZONE_MODE	GetCustomShapeInZoneOpt () const

void	SetCustomShapeInZoneOpt (CUSTOM_SHAPE_ZONE_MODE aOption)
	Set the option for the custom pad shape to use as clearance area in copper zones.

void	SetAnchorPadShape (PCB_LAYER_ID aLayer, PAD_SHAPE aShape)
	Set the shape of the anchor pad for custom shaped pads.

bool	IsOnCopperLayer () const override

void	SetY (int y)

void	SetX (int x)

void	SetSize (PCB_LAYER_ID aLayer, const VECTOR2I &aSize)

VECTOR2I	GetSize (PCB_LAYER_ID aLayer) const

void	SetLibSize (PCB_LAYER_ID aLayer, const VECTOR2I &aSize)

void	SetLibDrillSize (const VECTOR2I &aSize)

void	SetLibOffset (PCB_LAYER_ID aLayer, const VECTOR2I &aOffset)

bool	HasExplicitDefinitionForLayer (PCB_LAYER_ID aLayer) const

void	SetSizeX (int aX)

int	GetSizeX () const

void	SetSizeY (int aY)

int	GetSizeY () const

void	SetDelta (PCB_LAYER_ID aLayer, const VECTOR2I &aSize)

const VECTOR2I &	GetDelta (PCB_LAYER_ID aLayer) const

void	SetPrimaryDrillSize (const VECTOR2I &aSize)

VECTOR2I	GetPrimaryDrillSize () const

void	SetPrimaryDrillSizeX (int aX)

int	GetPrimaryDrillSizeX () const

void	SetPrimaryDrillSizeY (int aY)

int	GetPrimaryDrillSizeY () const

void	SetDrillSize (const VECTOR2I &aSize)

VECTOR2I	GetDrillSize () const

void	SetDrillSizeX (int aX)

int	GetDrillSizeX () const

void	SetDrillSizeY (int aY)

int	GetDrillSizeY () const

void	SetOffset (PCB_LAYER_ID aLayer, const VECTOR2I &aOffset)

VECTOR2I	GetOffset (PCB_LAYER_ID aLayer) const

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

const PADSTACK &	Padstack () const

PADSTACK &	Padstack ()

void	SetPadstack (const PADSTACK &aPadstack)

void	AddPrimitivePoly (PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aPoly, int aThickness, bool aFilled)
	Has meaning only for custom shape pads.

void	AddPrimitivePoly (PCB_LAYER_ID aLayer, const std::vector< VECTOR2I > &aPoly, int aThickness, bool aFilled)

void	MergePrimitivesAsPolygon (PCB_LAYER_ID aLayer, SHAPE_POLY_SET *aMergedPolygon, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
	Merge all basic shapes to a SHAPE_POLY_SET.

void	DeletePrimitivesList (PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
	Clear the basic shapes list.

const std::vector< std::shared_ptr< PCB_SHAPE > > &	GetPrimitives (PCB_LAYER_ID aLayer) const
	Accessor to the basic shape list for custom-shaped pads.

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

void	FlipPrimitives (FLIP_DIRECTION aFlipDirection)
	Flip (mirror) the primitives left to right or top to bottom, around the anchor position in custom pads.

void	ReplacePrimitives (PCB_LAYER_ID aLayer, const std::vector< std::shared_ptr< PCB_SHAPE > > &aPrimitivesList)
	Clear the current custom shape primitives list and import a new list.

void	AppendPrimitives (PCB_LAYER_ID aLayer, const std::vector< std::shared_ptr< PCB_SHAPE > > &aPrimitivesList)
	Import a custom shape primitive list (composed of basic shapes) and add items to the current list.

void	AddPrimitive (PCB_LAYER_ID aLayer, PCB_SHAPE *aPrimitive)
	Add item to the custom shape primitives list.

void	SetOrientation (const EDA_ANGLE &aAngle)
	Set the rotation angle of the pad.

void	SetFPRelativeOrientation (const EDA_ANGLE &aAngle)

EDA_ANGLE	GetOrientation () const
	Return the rotation angle of the pad.

EDA_ANGLE	GetFPRelativeOrientation () const

void	GetPrimitiveLibScale (double &aScaleX, double &aScaleY) const

void	SetOrientationDegrees (double aOrientation)

double	GetOrientationDegrees () const

void	SetPrimaryDrillShape (PAD_DRILL_SHAPE aShape)

PAD_DRILL_SHAPE	GetPrimaryDrillShape () const

void	SetDrillShape (PAD_DRILL_SHAPE aShape)

PAD_DRILL_SHAPE	GetDrillShape () const

void	SetPrimaryDrillStartLayer (PCB_LAYER_ID aLayer)

PCB_LAYER_ID	GetPrimaryDrillStartLayer () const

void	SetPrimaryDrillEndLayer (PCB_LAYER_ID aLayer)

PCB_LAYER_ID	GetPrimaryDrillEndLayer () const

void	SetFrontPostMachining (const std::optional< PAD_DRILL_POST_MACHINING_MODE > &aMode)

std::optional< PAD_DRILL_POST_MACHINING_MODE >	GetFrontPostMachining () const

void	SetFrontPostMachiningMode (PAD_DRILL_POST_MACHINING_MODE aMode)

PAD_DRILL_POST_MACHINING_MODE	GetFrontPostMachiningMode () const

void	SetFrontPostMachiningSize (int aSize)

int	GetFrontPostMachiningSize () const

void	SetFrontPostMachiningDepth (int aDepth)

int	GetFrontPostMachiningDepth () const

void	SetFrontPostMachiningAngle (int aAngle)

int	GetFrontPostMachiningAngle () const

void	SetBackPostMachining (const std::optional< PAD_DRILL_POST_MACHINING_MODE > &aMode)

std::optional< PAD_DRILL_POST_MACHINING_MODE >	GetBackPostMachining () const

void	SetBackPostMachiningMode (PAD_DRILL_POST_MACHINING_MODE aMode)

PAD_DRILL_POST_MACHINING_MODE	GetBackPostMachiningMode () const

void	SetBackPostMachiningSize (int aSize)

int	GetBackPostMachiningSize () const

void	SetBackPostMachiningDepth (int aDepth)

int	GetBackPostMachiningDepth () const

void	SetBackPostMachiningAngle (int aAngle)

int	GetBackPostMachiningAngle () const

bool	IsBackdrilledOrPostMachined (PCB_LAYER_ID aLayer) const
	Check if a layer is affected by backdrilling or post-machining operations.

int	GetPostMachiningKnockout (PCB_LAYER_ID aLayer) const
	Get the knockout diameter for a layer affected by post-machining.

void	SetPrimaryDrillFilled (const std::optional< bool > &aFilled)

void	SetPrimaryDrillFilledFlag (bool aFilled)

std::optional< bool >	GetPrimaryDrillFilled () const

bool	GetPrimaryDrillFilledFlag () const

void	SetPrimaryDrillCapped (const std::optional< bool > &aCapped)

void	SetPrimaryDrillCappedFlag (bool aCapped)

std::optional< bool >	GetPrimaryDrillCapped () const

bool	GetPrimaryDrillCappedFlag () const

void	SetSecondaryDrillSize (const VECTOR2I &aSize)

const VECTOR2I &	GetSecondaryDrillSize () const

void	ClearSecondaryDrillSize ()

void	SetSecondaryDrillSizeX (int aX)

int	GetSecondaryDrillSizeX () const

void	SetSecondaryDrillSizeY (int aY)

int	GetSecondaryDrillSizeY () const

void	SetSecondaryDrillShape (PAD_DRILL_SHAPE aShape)

PAD_DRILL_SHAPE	GetSecondaryDrillShape () const

void	SetSecondaryDrillStartLayer (PCB_LAYER_ID aLayer)

PCB_LAYER_ID	GetSecondaryDrillStartLayer () const

void	SetSecondaryDrillEndLayer (PCB_LAYER_ID aLayer)

PCB_LAYER_ID	GetSecondaryDrillEndLayer () const

void	SetTertiaryDrillSize (const VECTOR2I &aSize)

const VECTOR2I &	GetTertiaryDrillSize () const

void	ClearTertiaryDrillSize ()

void	SetTertiaryDrillSizeX (int aX)

int	GetTertiaryDrillSizeX () const

void	SetTertiaryDrillSizeY (int aY)

int	GetTertiaryDrillSizeY () const

void	SetTertiaryDrillShape (PAD_DRILL_SHAPE aShape)

PAD_DRILL_SHAPE	GetTertiaryDrillShape () const

void	SetTertiaryDrillStartLayer (PCB_LAYER_ID aLayer)

PCB_LAYER_ID	GetTertiaryDrillStartLayer () const

void	SetTertiaryDrillEndLayer (PCB_LAYER_ID aLayer)

PCB_LAYER_ID	GetTertiaryDrillEndLayer () const

bool	IsDirty () const

void	SetDirty ()

void	SetLayerSet (const LSET &aLayers) override

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

void	SetAttribute (PAD_ATTRIB aAttribute)

PAD_ATTRIB	GetAttribute () const

void	SetProperty (PAD_PROP aProperty)

PAD_PROP	GetProperty () const

bool	IsAperturePad () const

void	SetSimElectricalType (PAD_SIM_ELECTRICAL_TYPE aType)

PAD_SIM_ELECTRICAL_TYPE	GetSimElectricalType () const

bool	IsNPTHWithNoCopper () const

void	SetPadToDieLength (int aLength)

int	GetPadToDieLength () const

void	SetPadToDieDelay (int aDelay)

int	GetPadToDieDelay () const

std::optional< int >	GetLocalClearance () const override
	Return any local clearances set in the "classic" (ie: pre-rule) system.

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

int	GetOwnClearance (PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const override
	Return the pad's "own" clearance in internal units.

double	GetCoverageArea (int aTextMargin) const override
	Return the board area this item covers, used to rank candidates under the cursor so a click on a small item inside a large one selects the small one.

void	TransformShapeToPolygon (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE, bool aIgnoreLineWidth=false) const override
	Convert the pad shape to a closed polygon.

bool	TransformHoleToPolygon (SHAPE_POLY_SET &aBuffer, int aClearance, int aError, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
	Build the corner list of the polygonal drill shape in the board coordinate system.

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.

const std::shared_ptr< SHAPE_POLY_SET > &	GetEffectivePolygon (PCB_LAYER_ID aLayer, ERROR_LOC aErrorLoc=ERROR_INSIDE) const

std::shared_ptr< SHAPE_SEGMENT >	GetEffectiveHoleShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER, DRC_CONSTRAINT_T aUsage=NULL_CONSTRAINT) const override
	Return a SHAPE_SEGMENT object representing the pad's hole.

int	GetBoundingRadius () const
	Return the radius of a minimum sized circle which fully encloses this pad.

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

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

int	GetSolderMaskExpansion (PCB_LAYER_ID aLayer) const

VECTOR2I	GetSolderPasteMargin (PCB_LAYER_ID aLayer) const
	Usually < 0 (mask shape smaller than pad)because the margin can be dependent on the pad size, the margin has a x and a y value.

ZONE_CONNECTION	GetZoneConnectionOverrides (wxString *aSource=nullptr) const

void	SetLocalThermalSpokeWidthOverride (std::optional< int > aWidth)
	Set the width of the thermal spokes connecting the pad to a zone.

std::optional< int >	GetLocalThermalSpokeWidthOverride () const

int	GetLocalSpokeWidthOverride (wxString *aSource=nullptr) const

void	SetThermalSpokeAngle (const EDA_ANGLE &aAngle)
	The orientation of the thermal spokes.

EDA_ANGLE	GetThermalSpokeAngle () const

void	SetThermalSpokeAngleDegrees (double aAngle)

double	GetThermalSpokeAngleDegrees () const

void	SetThermalGap (int aGap)

int	GetThermalGap () const

int	GetLocalThermalGapOverride (wxString *aSource) const

std::optional< int >	GetLocalThermalGapOverride () const

void	SetLocalThermalGapOverride (const std::optional< int > &aOverride)

void	SetRoundRectCornerRadius (PCB_LAYER_ID aLayer, double aRadius)

int	GetRoundRectCornerRadius (PCB_LAYER_ID aLayer) const

VECTOR2I	ShapePos (PCB_LAYER_ID aLayer) const

void	SetRoundRectRadiusRatio (PCB_LAYER_ID aLayer, double aRadiusScale)
	Has meaning only for rounded rectangle pads.

double	GetRoundRectRadiusRatio (PCB_LAYER_ID aLayer) const

void	SetFrontRoundRectRadiusRatio (double aRadiusScale)

double	GetFrontRoundRectRadiusRatio () const

void	SetFrontRoundRectRadiusSize (int aRadius)

int	GetFrontRoundRectRadiusSize () const

void	SetChamferRectRatio (PCB_LAYER_ID aLayer, double aChamferScale)
	Has meaning only for chamfered rectangular pads.

double	GetChamferRectRatio (PCB_LAYER_ID aLayer) const

void	SetChamferPositions (PCB_LAYER_ID aLayer, int aPositions)
	Has meaning only for chamfered rectangular pads.

int	GetChamferPositions (PCB_LAYER_ID aLayer) const

int	GetSubRatsnest () const

void	SetSubRatsnest (int aSubRatsnest)

void	SetRemoveUnconnected (bool aSet)

bool	GetRemoveUnconnected () const

void	SetKeepTopBottom (bool aSet)

bool	GetKeepTopBottom () const

void	SetUnconnectedLayerMode (UNCONNECTED_LAYER_MODE aMode)

UNCONNECTED_LAYER_MODE	GetUnconnectedLayerMode () const

bool	ConditionallyFlashed (PCB_LAYER_ID aLayer) 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	IsOnLayer (PCB_LAYER_ID aLayer) const override
	Test to see if this object is on the given layer.

bool	FlashLayer (int aLayer, bool aOnlyCheckIfPermitted=false) const
	Check to see whether the pad should be flashed on the specific layer.

bool	CanFlashLayer (int aLayer)

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

PCB_LAYER_ID	GetPrincipalLayer () const

bool	FlashLayer (const LSET &aLayers) const
	Check to see if the pad should be flashed to any of the layers in the set.

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

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	HitTest (const VECTOR2I &aPosition, int aAccuracy, PCB_LAYER_ID aLayer) const
	return true if hit test on the specified layer

std::vector< PCB_SHAPE * >	Recombine (bool aIsDryRun, int aMaxError)
	Recombines the pad with other graphical shapes in the footprint.

wxString	GetClass () const override
	Return the class name.

const BOX2I	GetBoundingBox () const override
	The bounding box is cached, so this will be efficient most of the time.

const BOX2I	GetBoundingBox (PCB_LAYER_ID aLayer) const

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

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

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

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

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

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

wxString	ShowPadShape (PCB_LAYER_ID aLayer) const

wxString	ShowLegacyPadShape (PCB_LAYER_ID aLayer) const
	An older version still used by place file writer.

wxString	ShowPadAttr () const

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

PAD *	ClonePad () const
	Same as Clone, but returns a PAD item.

void	BuildEffectiveShapes () const
	Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit.

void	BuildEffectivePolygon (ERROR_LOC aErrorLoc=ERROR_INSIDE) const

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.

void	ClearZoneLayerOverrides ()

const ZONE_LAYER_OVERRIDE &	GetZoneLayerOverride (PCB_LAYER_ID aLayer) const

void	SetZoneLayerOverride (PCB_LAYER_ID aLayer, ZONE_LAYER_OVERRIDE aOverride)

void	CheckPad (UNITS_PROVIDER *aUnitsProvider, bool aForPadProperties, const std::function< void(int aErrorCode, const wxString &aMsg)> &aErrorHandler) const

BACKDRILL_MODE	GetBackdrillMode () const

void	SetBackdrillMode (BACKDRILL_MODE aMode)

std::optional< int >	GetBottomBackdrillSize () const

void	SetBottomBackdrillSize (std::optional< int > aSize)

PCB_LAYER_ID	GetBottomBackdrillLayer () const

void	SetBottomBackdrillLayer (PCB_LAYER_ID aLayer)

std::optional< int >	GetTopBackdrillSize () const

void	SetTopBackdrillSize (std::optional< int > aSize)

PCB_LAYER_ID	GetTopBackdrillLayer () const

void	SetTopBackdrillLayer (PCB_LAYER_ID aLayer)

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

bool	operator== (const PAD &aOther) const

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

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

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

NETINFO_ITEM *	GetNet () const
	Return NETINFO_ITEM object for a given item.

virtual void	SetNet (NETINFO_ITEM *aNetInfo)
	Set a NET_INFO object for the item.

void	UnpackNet (const kiapi::board::types::Net &aProto)
	Assigns a net to this item from an API message.

void	PackNet (kiapi::board::types::Net *aProto) const

int	GetNetCode () const

virtual bool	SetNetCode (int aNetCode, bool aNoAssert)
	Set net using a net code.

void	SetNetCode (int aNetCode)

wxString	GetNetname () const

wxString	GetNetnameMsg () const

const wxString &	GetShortNetname () const

const wxString &	GetDisplayNetname () const

virtual NETCLASS *	GetEffectiveNetClass () const
	Return the NETCLASS for this item.

wxString	GetNetClassName () const
	Returns the name of the effective netclass.

void	SetLocalRatsnestVisible (bool aVisible)

bool	GetLocalRatsnestVisible () const

TEARDROP_PARAMETERS &	GetTeardropParams ()

const TEARDROP_PARAMETERS &	GetTeardropParams () const

void	SetTeardropsEnabled (bool aEnable)

bool	GetTeardropsEnabled () const

void	SetTeardropBestLengthRatio (double aRatio)

double	GetTeardropBestLengthRatio () const

void	SetTeardropMaxLength (int aMaxLength)

int	GetTeardropMaxLength () const

void	SetTeardropBestWidthRatio (double aRatio)

double	GetTeardropBestWidthRatio () const

void	SetTeardropMaxWidth (int aMaxWidth)

int	GetTeardropMaxWidth () const

void	SetTeardropCurved (bool aCurve)

bool	GetTeardropCurved () const

void	SetTeardropPreferZoneConnections (bool aPrefer)

bool	GetTeardropPreferZoneConnections () const

void	SetTeardropAllowSpanTwoTracks (bool aAllow)

bool	GetTeardropAllowSpanTwoTracks () const

void	SetTeardropMaxTrackWidth (double aRatio)

double	GetTeardropMaxTrackWidth () const

bool	IsGroupableType () const

int	GetX () const

int	GetY () 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 void	RunOnChildren (const std::function< void(BOARD_ITEM *)> &aFunction, RECURSE_MODE aMode) const
	Invoke a function on all children.

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 bool	IsLayerAgnostic () const
	Check if this item's layer set must not be confined to a board's enabled layers.

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

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.

bool	IsSideSpecific () const

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

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

void	SetLocked (bool aLocked) override

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

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

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

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.

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

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

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

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

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.

virtual EMBEDDED_FILES *	GetEmbeddedFiles ()

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

Static Public Member Functions
static LSET	PTHMask ()
	layer set for a through hole pad

static LSET	SMDMask ()
	layer set for a SMD pad on Front layer

static LSET	ConnSMDMask ()
	layer set for a SMD pad on Front layer used for edge board connectors

static LSET	UnplatedHoleMask ()
	layer set for a mechanical unplated through hole pad

static LSET	ApertureMask ()
	layer set for an aperture pad

static bool	ClassOf (const EDA_ITEM *aItem)

static void	SwapShapePositions (PAD aLhs, PAD aRhs)
	Swap the visible shape positions of two pads, preserving each pad's own shape offset.

static int	Compare (const PAD aPadRef, const PAD aPadCmp)
	Compare two pads and return 0 if they are equal.

static wxString	ShowPadShape (PAD_SHAPE aShape)

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.

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

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	polygonArea (SHAPE_POLY_SET &aPolySet)
	Area of aPolySet with every contour closed first, holes subtracted.

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
NETINFO_ITEM *	m_netinfo
	Store all information about the net that item belongs to.

TEARDROP_PARAMETERS	m_teardropParams
	Not all BOARD_CONNECTED_ITEMs support teardrops, but we want those that do to share a single section in the property inspector.

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.

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 Member Functions
const SHAPE_COMPOUND &	buildEffectiveShape (PCB_LAYER_ID aLayer) const

void	rebakePrimitiveToFootprint (PCB_SHAPE *aPrimitive) const

PAD_DRAW_CACHE_DATA &	getDrawCache () const

void	doCheckPad (PCB_LAYER_ID aLayer, UNITS_PROVIDER *aUnitsProvider, bool aForPadProperties, const std::function< void(int aErrorCode, const wxString &aMsg)> &aErrorHandler) const

Private Attributes
wxString	m_number

wxString	m_pinFunction

wxString	m_pinType

VECTOR2I	m_libPos

EDA_ORIENTATION	m_libOrientation

PADSTACK	m_padStack

std::mutex	m_dataMutex

std::unique_ptr< PAD_DRAW_CACHE_DATA >	m_drawCache

int	m_effectiveBoundingRadius

int	m_subRatsnest

PAD_ATTRIB	m_attribute = PAD_ATTRIB::PTH

PAD_PROP	m_property

int	m_lengthPadToDie

int	m_delayPadToDie

PAD_SIM_ELECTRICAL_TYPE	m_simElectricalType { PAD_SIM_ELECTRICAL_TYPE::NONE }

bool	m_polyDirty [2]

bool	m_shapesDirty

std::map< PCB_LAYER_ID, ZONE_LAYER_OVERRIDE >	m_zoneLayerOverrides

bool	m_localRatsnestVisible

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.

Detailed Description

Definition at line 60 of file pad.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC
INSTANCE_TO_INSTANCE

Definition at line 568 of file board_item.h.

Constructor & Destructor Documentation

◆ PAD() [1/2]

PAD::PAD ( FOOTPRINT * parent )

◆ PAD() [2/2]

PAD::PAD ( const PAD & aPad )

Definition at line 115 of file pad.cpp.

References ANGLE_0, BOARD_CONNECTED_ITEM::BOARD_CONNECTED_ITEM(), BOARD_ITEM::GetParent(), m_libOrientation, m_padStack, EDA_ITEM::m_Uuid, operator=(), PAD(), PCB_PAD_T, and BOARD_ITEM::SetUuidDirect().

Member Function Documentation

◆ AddPrimitive()

void PAD::AddPrimitive	(	PCB_LAYER_ID	aLayer,
		PCB_SHAPE *	aPrimitive )

Add item to the custom shape primitives list.

Definition at line 3707 of file pad.cpp.

References ARC, BEZIER, EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), m_padStack, PCB_SHAPE::OverrideLibBezier(), PCB_SHAPE::OverrideLibCoords(), PCB_SHAPE::OverrideLibPoly(), POLY, rebakePrimitiveToFootprint(), SetDirty(), and EDA_ITEM::SetParent().

Referenced by AddPrimitivePoly(), AddPrimitivePoly(), AppendPrimitives(), ALTIUM_PCB::ParseFootprint(), PCB_IO_KICAD_SEXPR_PARSER::parsePAD_primitives(), and Recombine().

◆ AddPrimitivePoly() [1/2]

void PAD::AddPrimitivePoly	(	PCB_LAYER_ID	aLayer,
		const SHAPE_POLY_SET &	aPoly,
		int	aThickness,
		bool	aFilled )

Has meaning only for custom shape pads.

add a free shape to the shape list. the shape can be

a polygon (outline can have a thickness)
a thick segment
a filled circle (thickness == 0) or ring
a filled rect (thickness == 0) or rectangular outline
a arc
a bezier curve

Definition at line 3645 of file pad.cpp.

References AddPrimitive(), SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::COutline(), SHAPE_POLY_SET::Fracture(), SHAPE_POLY_SET::HasHoles(), SHAPE_POLY_SET::OutlineCount(), POLY, SetDirty(), EDA_SHAPE::SetFilled(), PCB_SHAPE::SetPolyShape(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStroke(), and SOLID.

Referenced by PAD_LAYER_GEOMETRY::ResolvePadLayer.

◆ AddPrimitivePoly() [2/2]

void PAD::AddPrimitivePoly	(	PCB_LAYER_ID	aLayer,
		const std::vector< VECTOR2I > &	aPoly,
		int	aThickness,
		bool	aFilled )

Definition at line 3672 of file pad.cpp.

References AddPrimitive(), POLY, SetDirty(), EDA_SHAPE::SetFilled(), EDA_SHAPE::SetPolyPoints(), PCB_SHAPE::SetStroke(), and SOLID.

◆ ApertureMask()

LSET PAD::ApertureMask ( )

static

layer set for an aperture pad

Definition at line 644 of file pad.cpp.

References F_Paste.

Referenced by PAD_FIXTURE::MakeAperture(), and DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ AppendPrimitives()

void PAD::AppendPrimitives	(	PCB_LAYER_ID	aLayer,
		const std::vector< std::shared_ptr< PCB_SHAPE > > &	aPrimitivesList )

Import a custom shape primitive list (composed of basic shapes) and add items to the current list.

Copies the input, which is not altered.

Definition at line 3697 of file pad.cpp.

References AddPrimitive(), and SetDirty().

Referenced by ReplacePrimitives().

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

◆ BuildEffectivePolygon()

void PAD::BuildEffectivePolygon ( ERROR_LOC aErrorLoc = ERROR_INSIDE ) const

Definition at line 1579 of file pad.cpp.

References SHAPE_LINE_CHAIN::CPoint(), ERROR_OUTSIDE, PADSTACK::ForEachUniqueLayer(), getDrawCache(), GetDrillSizeX(), GetDrillSizeY(), BOARD_ITEM::GetMaxError(), GetPosition(), KiROUND(), m_dataMutex, m_effectiveBoundingRadius, PAD::PAD_DRAW_CACHE_DATA::m_effectivePolygons, m_polyDirty, Padstack(), SHAPE_LINE_CHAIN::PointCount(), and TransformShapeToPolygon().

Referenced by GetBoundingRadius(), and GetEffectivePolygon().

◆ buildEffectiveShape()

const SHAPE_COMPOUND & PAD::buildEffectiveShape ( PCB_LAYER_ID aLayer ) const

private

◆ BuildEffectiveShapes()

void PAD::BuildEffectiveShapes ( ) const

Rebuild the effective shape cache (and bounding box and radius) for the pad and clears the dirty bit.

Definition at line 1368 of file pad.cpp.

References SHAPE_COMPOUND::BBox(), SHAPE_SEGMENT::BBox(), buildEffectiveShape(), BOX2< VECTOR2I >::ByCenter(), CIRCLE, PADSTACK::ForEachUniqueLayer(), getDrawCache(), GetDrillSize(), GetOrientation(), GetPosition(), m_dataMutex, PAD::PAD_DRAW_CACHE_DATA::m_effectiveBoundingBox, PAD::PAD_DRAW_CACHE_DATA::m_effectiveHoleShape, PAD::PAD_DRAW_CACHE_DATA::m_effectiveShapes, m_padStack, m_shapesDirty, BOX2< Vec >::Merge(), Padstack(), RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GetBoundingBox(), GetEffectiveHoleShape(), and GetEffectiveShape().

◆ CanFlashLayer()

bool PAD::CanFlashLayer ( int aLayer )

inline

Definition at line 939 of file pad.h.

References FlashLayer().

◆ CanHaveNumber()

bool PAD::CanHaveNumber ( ) const

Indicates whether or not the pad can have a number.

(NPTH and SMD aperture pads can not.)

Definition at line 534 of file pad.cpp.

References GetAttribute(), IsAperturePad(), and NPTH.

Referenced by BOOST_AUTO_TEST_CASE(), and ImportSettingsFrom().

◆ CheckPad()

void PAD::CheckPad	(	UNITS_PROVIDER *	aUnitsProvider,
		bool	aForPadProperties,
		const std::function< void(int aErrorCode, const wxString &aMsg)> &	aErrorHandler ) const

Definition at line 3323 of file pad.cpp.

References _, B_Cu, B_Mask, B_Paste, BGA, CASTELLATED, CONN, doCheckPad(), DRCE_PAD_TH_WITH_NO_HOLE, DRCE_PADSTACK, DRCE_PADSTACK_INVALID, F_Cu, F_Mask, F_Paste, FIDUCIAL_GLBL, FIDUCIAL_LOCAL, PADSTACK::ForEachUniqueLayer(), GetAttribute(), GetDrillShape(), GetDrillSize(), GetLayerSet(), GetProperty(), HasDrilledHole(), HEATSINK, LSET::InternalCuMask(), IsOnLayer(), KI_FALLTHROUGH, MECHANICAL, NPTH, OBLONG, Padstack(), PRESSFIT, PTH, SMD, TESTPOINT, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ ClassOf()

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

inlinestatic

Definition at line 87 of file pad.h.

References EDA_ITEM::EDA_ITEM(), PCB_PAD_T, and EDA_ITEM::Type().

◆ 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(), KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), LIB_SYMBOL::ClearEditFlags(), DRAWING_TOOL::drawShape(), SCH_MOVE_TOOL::finalizeMoveOperation(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::RevertToCheckpoint(), SCH_ITEM::SwapFlags(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and FOOTPRINT::UpdateFields().

◆ 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(), PCB_VIA_STACK::BuildMembers(), ClearBrightened(), ClearEditFlags(), ClearSelected(), ClearTempFlags(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), MULTICHANNEL_TOOL::copyRuleAreaContents(), FOOTPRINT_EDITOR_CONTROL::CreateFootprintFromWizard(), 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_POINT_EDITOR::Reset(), SCH_COMMIT::RevertToCheckpoint(), 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(), PCB_VIA::SetSizeFromRules(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SELECTION_TOOL::unhighlight(), SCH_SHAPE::UpdateHatching(), and SCOPED_FLAGS_CLEANER::~SCOPED_FLAGS_CLEANER().

◆ ClearSecondaryDrillSize()

void PAD::ClearSecondaryDrillSize ( )

Definition at line 1101 of file pad.cpp.

References m_padStack, and SetDirty().

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

◆ ClearTertiaryDrillSize()

void PAD::ClearTertiaryDrillSize ( )

Definition at line 1154 of file pad.cpp.

References m_padStack, and SetDirty().

◆ ClearZoneLayerOverrides()

void PAD::ClearZoneLayerOverrides ( )

Definition at line 508 of file pad.cpp.

References B_Cu, BOARD_ITEM::BoardCopperLayerCount(), F_Cu, m_dataMutex, m_zoneLayerOverrides, and ZLO_NONE.

Referenced by Deserialize().

◆ Clone()

EDA_ITEM * PAD::Clone ( ) const

overridevirtual

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

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 2700 of file pad.cpp.

References EDA_ITEM::EDA_ITEM(), PADSTACK::ForEachUniqueLayer(), m_padStack, PAD, PAD(), Padstack(), and PADSTACK::Primitives().

Referenced by ClonePad().

◆ ClonePad()

PAD * PAD::ClonePad ( ) const

inline

Same as Clone, but returns a PAD item.

Useful mainly for python scripts, because Clone returns an EDA_ITEM.

Definition at line 1035 of file pad.h.

References Clone(), and PAD().

◆ Compare()

int PAD::Compare	(	const PAD *	aPadRef,
		const PAD *	aPadCmp )

static

Compare two pads and return 0 if they are equal.

Returns: less than 0 if left less than right, 0 if equal, or greater than 0 if left greater than right.

Definition at line 2483 of file pad.cpp.

References PADSTACK::Compare(), m_attribute, PAD(), and Padstack().

Referenced by GENCAD_EXPORTER::createPadsShapesSection().

◆ ConditionallyFlashed()

bool PAD::ConditionallyFlashed ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 904 of file pad.h.

References KEEP_ALL, m_padStack, REMOVE_ALL, REMOVE_EXCEPT_START_AND_END, and START_END_ONLY.

◆ ConnSMDMask()

LSET PAD::ConnSMDMask ( )

static

layer set for a SMD pad on Front layer used for edge board connectors

Definition at line 630 of file pad.cpp.

References F_Cu, and F_Mask.

Referenced by DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ CopyFrom()

void PAD::CopyFrom ( const BOARD_ITEM * aOther )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 367 of file pad.cpp.

References BOARD_ITEM::BOARD_ITEM(), PAD(), PCB_PAD_T, and EDA_ITEM::Type().

◆ DeletePrimitivesList()

void PAD::DeletePrimitivesList ( PCB_LAYER_ID aLayer = UNDEFINED_LAYER )

Clear the basic shapes list.

Parameters

aLayer is the layer to clear, or UNDEFINED_LAYER to clear all layers

Definition at line 3732 of file pad.cpp.

References m_padStack, SetDirty(), and UNDEFINED_LAYER.

Referenced by PAD_TOOL::explodePad(), ReplacePrimitives(), and PAD_LAYER_GEOMETRY::ResolvePadLayer.

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

◆ Deserialize()

bool PAD::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 449 of file pad.cpp.

References ClearZoneLayerOverrides(), FromProtoEnum(), GetCanonicalElectricalTypeName(), BOARD_CONNECTED_ITEM::GetTeardropParams(), m_dataMutex, m_padStack, m_pinFunction, m_pinType, m_zoneLayerOverrides, pad, SetAttribute(), BOARD_CONNECTED_ITEM::SetLayer(), SetLocalClearance(), BOARD_ITEM::SetLocked(), SetNumber(), SetOrientation(), SetPadToDieDelay(), SetPadToDieLength(), SetPosition(), SetProperty(), SetSimElectricalType(), BOARD_CONNECTED_ITEM::SetTeardropsEnabled(), BOARD_ITEM::SetUuidDirect(), kiapi::common::UnpackCustomProperties(), BOARD_CONNECTED_ITEM::UnpackNet(), kiapi::board::UnpackTeardropSettings(), kiapi::common::UnpackVector2(), and kiapi::board::UnpackZoneLayerOverrides().

◆ DisambiguateItemDescription()

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

inlinevirtualinherited

Reimplemented in FOOTPRINT.

Definition at line 458 of file eda_item.h.

References GetItemDescription().

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ doCheckPad()

void PAD::doCheckPad	(	PCB_LAYER_ID	aLayer,
		UNITS_PROVIDER *	aUnitsProvider,
		bool	aForPadProperties,
		const std::function< void(int aErrorCode, const wxString &aMsg)> &	aErrorHandler ) const

private

Definition at line 3438 of file pad.cpp.

References _, SHAPE_POLY_SET::BooleanSubtract(), CHAMFERED_RECT, CIRCLE, SHAPE_POLY_SET::Collide(), CUSTOM, DRCE_PADSTACK, DRCE_PADSTACK_INVALID, ERROR_INSIDE, ERROR_OUTSIDE, GetAttribute(), GetBoundingBox(), GetChamferRectRatio(), GetDelta(), GetDrillSize(), GetDrillSizeX(), GetDrillSizeY(), GetEffectiveHoleShape(), BOX2< Vec >::GetHeight(), GetLocalClearance(), GetLocalSolderMaskMargin(), GetLocalSolderPasteMargin(), GetLocalSolderPasteMarginRatio(), BOARD_ITEM::GetMaxError(), GetPosition(), GetPrimitives(), GetRoundRectRadiusRatio(), GetShape(), BOX2< Vec >::GetSize(), GetSize(), BOX2< Vec >::GetWidth(), SHAPE_POLY_SET::IsEmpty(), IsOnCopperLayer(), KiROUND(), MergePrimitivesAsPolygon(), SHAPE_POLY_SET::OutlineCount(), PTH, ROUNDRECT, UNITS_PROVIDER::StringFromValue(), TransformOvalToPolygon(), TransformShapeToPolygon(), TRAPEZOID, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CheckPad().

◆ Duplicate()

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

virtualinherited

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.
aCommit	is the commit object for undo/redo.

Reimplemented in FOOTPRINT, PCB_TABLE, and ZONE.

Definition at line 352 of file board_item.cpp.

References BOARD_ITEM(), EDA_ITEM::Clone(), EDA_ITEM::GetParentGroup(), group, COMMIT::Modify(), NO_RECURSE, and ResetUuid().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_POINT_EDITOR::addCorner(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDIT_TOOL::Duplicate(), FOOTPRINT::Duplicate(), ZONE::Duplicate(), FOOTPRINT::DuplicateItem(), and ARRAY_TOOL::onDialogClosed().

◆ 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::GetParentScreen(), SCH_ITEM::GetParentSymbol(), SCH_ITEM::GetParentSymbol(), and SCH_ITEM::Schematic().

◆ FitsEnabledLayers()

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

virtualinherited

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.

Reimplemented in FOOTPRINT, and PCB_VIA.

Definition at line 37 of file board_item.cpp.

References GetLayerSet(), and IsLayerAgnostic().

Referenced by BOOST_AUTO_TEST_CASE(), and PCB_VIA::FitsEnabledLayers().

◆ FlashLayer() [1/2]

bool PAD::FlashLayer ( const LSET & aLayers ) const

Check to see if the pad should be flashed to any of the layers in the set.

Parameters

aLayers set of layers to check the via against

Returns: true if connected by pad or track (or optionally zone) on any of the associated layers

Definition at line 675 of file pad.cpp.

References FlashLayer().

◆ FlashLayer() [2/2]

bool PAD::FlashLayer	(	int	aLayer,
		bool	aOnlyCheckIfPermitted = false ) const

Check to see whether the pad should be flashed on the specific layer.

Parameters

aLayer	Layer to check for connectivity
aOnlyCheckIfPermitted	indicates that the routine should just return whether or not a flashed connection is permitted on this layer (without checking for a connection)

Returns: true if connected by pad or track (or optionally zone)

Definition at line 687 of file pad.cpp.

References B_Cu, B_Mask, LSET::BackBoardTechMask(), BOARD_ITEM::BOARD, CIRCLE, F_Cu, F_Mask, LSET::FrontBoardTechMask(), GetAttribute(), BOARD_ITEM::GetBoard(), GetDrillShape(), GetDrillSize(), GetOffset(), GetShape(), GetSize(), GetZoneLayerOverride(), IsCopperLayer(), IsExternalCopperLayer(), IsOnLayer(), KEEP_ALL, m_padStack, NPTH, OBLONG, OVAL, PCB_ARC_T, PCB_LAYER_ID_COUNT, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PTH, REMOVE_EXCEPT_START_AND_END, START_END_ONLY, UNDEFINED_LAYER, and ZLO_FORCE_FLASHED.

Referenced by STEP_PCB_MODEL::AddPadShape(), PCB_IO_IPC2581::addPadStack(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CanFlashLayer(), KIGFX::PCB_PAINTER::draw(), FlashLayer(), GetEffectiveShape(), LENGTH_DELAY_CALCULATION::OptimiseTraceInPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and ViewGetLOD().

◆ Flip()

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

Reimplemented from BOARD_ITEM.

Definition at line 1775 of file pad.cpp.

References FlipLayer(), FlipPrimitives(), PADSTACK::ForEachUniqueLayer(), BOARD_ITEM::GetBoard(), GetFPRelativeOrientation(), BOARD_ITEM::GetParentFootprint(), GetPosition(), LEFT_RIGHT, m_libPos, m_padStack, MIRROR(), Padstack(), RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT, BASE_SET::set(), SetDirty(), SetFPRelativeOrientation(), SetLayerSet(), and SetPosition().

◆ FlipPrimitives()

void PAD::FlipPrimitives ( FLIP_DIRECTION aFlipDirection )

Flip (mirror) the primitives left to right or top to bottom, around the anchor position in custom pads.

Definition at line 1850 of file pad.cpp.

References PADSTACK::ForEachUniqueLayer(), m_padStack, Padstack(), and SetDirty().

Referenced by Flip(), and mirrorPad().

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

◆ GetAnchorPadShape()

PAD_SHAPE PAD::GetAnchorPadShape ( PCB_LAYER_ID aLayer ) const

inline

Returns: the shape of the anchor pad shape, for custom shaped pads.

Definition at line 219 of file pad.h.

References m_padStack.

Referenced by buildEffectiveShape(), PAD_TOOL::explodePad(), PCB_IO_KICAD_SEXPR::format(), MergePrimitivesAsPolygon(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ GetAttribute()

PAD_ATTRIB PAD::GetAttribute ( ) const

inline

Definition at line 560 of file pad.h.

References m_attribute.

Referenced by STEP_PCB_MODEL::AddPadShape(), PCB_IO_IPC2581::addPadStack(), FEATURES_MANAGER::AddRoutSlot(), PCB_IO_IPC2581::addSlotCavity(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CanHaveNumber(), CheckPad(), doCheckPad(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), DrillsAreEditable(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), FlashLayer(), PCB_IO_KICAD_SEXPR::format(), GetEffectiveShape(), GetFabPadRole(), GetItemDescription(), GetMsgPanelInfo(), GetPadTypeString(), ImportSettingsFrom(), BOARD_INSPECTION_TOOL::InspectDRCError(), IsNPTHWithNoCopper(), IsOnCopperLayer(), PCB_SELECTION_TOOL::isPadVisible(), isPlatedFunc(), MakeFabPin(), operator==(), LENGTH_DELAY_CALCULATION::optimiseVias(), PAD_DESC::PAD_DESC(), padNeedsUpdate(), PANEL_PREVIEW_3D_MODEL::pickAlignment(), PCB_IO_IPC2581::pinName(), BRDITEMS_PLOTTER::PlotPad(), Serialize(), SetPadTypeFromString(), ShowPadAttr(), Similarity(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ GetBackdrillMode()

BACKDRILL_MODE PAD::GetBackdrillMode ( ) const

inline

Definition at line 1062 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ GetBackPostMachining()

std::optional< PAD_DRILL_POST_MACHINING_MODE > PAD::GetBackPostMachining ( ) const

inline

Definition at line 462 of file pad.h.

References m_padStack.

Referenced by RENDER_3D_RAYTRACE_BASE::insertHole().

◆ GetBackPostMachiningAngle()

int PAD::GetBackPostMachiningAngle ( ) const

inline

Definition at line 479 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ GetBackPostMachiningDepth()

int PAD::GetBackPostMachiningDepth ( ) const

inline

Definition at line 477 of file pad.h.

References m_padStack.

Referenced by RENDER_3D_RAYTRACE_BASE::insertHole(), and PAD_DESC::PAD_DESC().

◆ GetBackPostMachiningMode()

PAD_DRILL_POST_MACHINING_MODE PAD::GetBackPostMachiningMode ( ) const

inline

Definition at line 469 of file pad.h.

References m_padStack, and NOT_POST_MACHINED.

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

◆ GetBackPostMachiningSize()

int PAD::GetBackPostMachiningSize ( ) const

inline

Definition at line 475 of file pad.h.

References m_padStack.

Referenced by RENDER_3D_RAYTRACE_BASE::insertHole(), and PAD_DESC::PAD_DESC().

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

◆ GetBottomBackdrillLayer()

PCB_LAYER_ID PAD::GetBottomBackdrillLayer ( ) const

inline

Definition at line 1068 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ GetBottomBackdrillSize()

std::optional< int > PAD::GetBottomBackdrillSize ( ) const

inline

Definition at line 1065 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ GetBoundingBox() [1/2]

const BOX2I PAD::GetBoundingBox ( ) const

overridevirtual

The bounding box is cached, so this will be efficient most of the time.

Reimplemented from EDA_ITEM.

Definition at line 1635 of file pad.cpp.

References BuildEffectiveShapes(), getDrawCache(), PAD::PAD_DRAW_CACHE_DATA::m_effectiveBoundingBox, and m_shapesDirty.

Referenced by AR_AUTOPLACER::addPad(), DSN::appendPadstackShape(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ZONE_FILLER::buildThermalSpokes(), FOOTPRINT::CheckShortingPads(), doCheckPad(), KIGFX::PCB_PAINTER::draw(), HitTest(), playground_main_func(), BRDITEMS_PLOTTER::PlotPadNumber(), ViewBBox(), and ViewGetLOD().

◆ GetBoundingBox() [2/2]

const BOX2I PAD::GetBoundingBox ( PCB_LAYER_ID aLayer ) const

Definition at line 1645 of file pad.cpp.

References SHAPE_COMPOUND::BBox(), and buildEffectiveShape().

◆ GetBoundingRadius()

int PAD::GetBoundingRadius ( ) const

Return the radius of a minimum sized circle which fully encloses this pad.

The center is the pad position NOT THE SHAPE POS!

Definition at line 1350 of file pad.cpp.

References BuildEffectivePolygon(), ERROR_OUTSIDE, m_effectiveBoundingRadius, and m_polyDirty.

Referenced by HitTest(), and HitTest().

◆ GetCenter()

VECTOR2I PAD::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 329 of file pad.h.

References GetPosition().

Referenced by EDA_DATA::AddPackage(), PAD_INFO_FORMATTER::Format(), and DIALOG_FP_EDIT_PAD_TABLE::PAD_SNAPSHOT_COMPARE::operator()().

◆ GetChamferPositions()

int PAD::GetChamferPositions ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 852 of file pad.h.

References m_padStack.

Referenced by FEATURES_MANAGER::AddPadShape(), PCB_IO_IPC2581::addShape(), DSN::appendPadstackShape(), buildEffectiveShape(), PCB_IO_KICAD_SEXPR::format(), padNeedsUpdate(), BRDITEMS_PLOTTER::PlotPad(), TransformShapeToPolygon(), and GENCAD_EXPORTER::writePadShape().

◆ GetChamferRectRatio()

double PAD::GetChamferRectRatio ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 834 of file pad.h.

References m_padStack.

Referenced by FEATURES_MANAGER::AddPadShape(), PCB_IO_IPC2581::addShape(), DSN::appendPadstackShape(), buildEffectiveShape(), doCheckPad(), PCB_IO_KICAD_SEXPR::format(), padNeedsUpdate(), BRDITEMS_PLOTTER::PlotPad(), TransformShapeToPolygon(), and GENCAD_EXPORTER::writePadShape().

◆ GetClass()

wxString PAD::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements KIGFX::VIEW_ITEM.

Definition at line 978 of file pad.h.

◆ GetClearanceOverrides()

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

overridevirtual

Return any 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.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 1956 of file pad.cpp.

References GetLocalClearance(), BOARD_ITEM::GetParentFootprint(), and m_padStack.

◆ GetCoverageArea()

double PAD::GetCoverageArea ( int aTextMargin ) const

overridevirtual

Return the board area this item covers, used to rank candidates under the cursor so a click on a small item inside a large one selects the small one.

Parameters

aTextMargin the margin added around text, normally the hit-test accuracy.

Reimplemented from BOARD_ITEM.

Definition at line 3030 of file pad.cpp.

References ARC_LOW_DEF, SHAPE_POLY_SET::BooleanAdd(), ERROR_OUTSIDE, PADSTACK::ForEachUniqueLayer(), Padstack(), BOARD_ITEM::polygonArea(), and TransformShapeToPolygon().

◆ 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 BOOST_AUTO_TEST_CASE(), customPropertyFunc(), EDA_CUSTOM_PROPERTY::getter(), hasCustomPropertyFunc(), PCB_PROPERTIES_PANEL::onKeyRenamed(), and SCH_PROPERTIES_PANEL::onKeyRenamed().

◆ GetCustomShapeInZoneOpt()

CUSTOM_SHAPE_ZONE_MODE PAD::GetCustomShapeInZoneOpt ( ) const

inline

Returns: the option for the custom pad shape to use as clearance area in copper zones.

Definition at line 227 of file pad.h.

References m_padStack.

Referenced by PCB_IO_KICAD_SEXPR::format(), ImportSettingsFrom(), and padHasOverrides().

◆ GetDelta()

const VECTOR2I & PAD::GetDelta ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 307 of file pad.h.

References m_padStack.

Referenced by DSN::appendPadstackShape(), BOOST_AUTO_TEST_CASE(), PCB_GRID_HELPER::computeAnchors(), doCheckPad(), PCB_IO_KICAD_SEXPR::format(), mirrorPad(), padNeedsUpdate(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), PAD_LAYER_GEOMETRY::ResolvePadLayer, and GENCAD_EXPORTER::writePadShape().

◆ GetDisplayNetname()

const wxString & BOARD_CONNECTED_ITEM::GetDisplayNetname ( ) const

inherited

Returns: the unescaped short netname.

Definition at line 185 of file board_connected_item.cpp.

References BOARD_ITEM::BOARD, emptyString, BOARD_ITEM::GetBoard(), and m_netinfo.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), and PCB_TRACK::ViewGetLOD().

◆ getDrawCache()

PAD::PAD_DRAW_CACHE_DATA & PAD::getDrawCache ( ) const

private

Definition at line 1359 of file pad.cpp.

References m_drawCache.

Referenced by BuildEffectivePolygon(), buildEffectiveShape(), BuildEffectiveShapes(), GetBoundingBox(), GetEffectiveHoleShape(), GetEffectivePolygon(), and GetEffectiveShape().

◆ GetDrillShape()

PAD_DRILL_SHAPE PAD::GetDrillShape ( ) const

inline

Definition at line 434 of file pad.h.

References GetPrimaryDrillShape().

Referenced by PCB_IO_IPC2581::addSlotCavity(), BOOST_AUTO_TEST_CASE(), CheckPad(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), FlashLayer(), PCB_IO_KICAD_SEXPR::format(), KIGFX::PCB_PAINTER::getDrillShape(), GetMsgPanelInfo(), IsDrillSlot(), PAD_DESC::PAD_DESC(), and padNeedsUpdate().

◆ GetDrillSize()

VECTOR2I PAD::GetDrillSize ( ) const

inline

Definition at line 320 of file pad.h.

References GetPrimaryDrillSize().

Referenced by STEP_PCB_MODEL::AddPadShape(), PCB_IO_IPC2581::addSlotCavity(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BuildEffectiveShapes(), CheckPad(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), PCB_GRID_HELPER::computeAnchors(), doCheckPad(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), FlashLayer(), PAD_INFO_FORMATTER::Format(), PCB_IO_KICAD_SEXPR::format(), GetMsgPanelInfo(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), RENDER_3D_RAYTRACE_BASE::insertHole(), BOARD_INSPECTION_TOOL::InspectConstraints(), IsNPTHWithNoCopper(), DSN::isRoundKeepout(), padNeedsUpdate(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), TransformHoleToPolygon(), UpdateDrillCells(), PAD_INFO_FORMATTER::UpdatePad(), and GENCAD_EXPORTER::writePadShape().

◆ GetDrillSizeX()

int PAD::GetDrillSizeX ( ) const

inline

Definition at line 322 of file pad.h.

References GetPrimaryDrillSizeX().

Referenced by PCB_IO_IPC2581::addPadStack(), BOOST_AUTO_TEST_CASE(), BuildEffectivePolygon(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), doCheckPad(), KIGFX::PCB_PAINTER::draw(), HasDrilledHole(), HasHole(), IsDrillSlot(), and PAD_DESC::PAD_DESC().

◆ GetDrillSizeY()

int PAD::GetDrillSizeY ( ) const

inline

Definition at line 324 of file pad.h.

References GetPrimaryDrillSizeY().

Referenced by PCB_IO_IPC2581::addPadStack(), BuildEffectivePolygon(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), doCheckPad(), HasDrilledHole(), HasHole(), IsDrillSlot(), and PAD_DESC::PAD_DESC().

◆ GetDynamicProperties()

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

overridevirtualinherited

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

Reimplemented in FOOTPRINT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 226 of file eda_item.cpp.

References GetCustomPropertiesAsInspectables().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveHoleShape()

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

overridevirtual

Return a SHAPE_SEGMENT object representing the pad's hole.

Reimplemented from BOARD_ITEM.

Definition at line 1328 of file pad.cpp.

References ANNULAR_WIDTH_CONSTRAINT, BuildEffectiveShapes(), getDrawCache(), PADSTACK::GetMaxHoleSize(), GetPosition(), HOLE_CLEARANCE_CONSTRAINT, HOLE_TO_HOLE_CONSTRAINT, IsBackdrilledOrPostMachined(), PAD::PAD_DRAW_CACHE_DATA::m_effectiveHoleShape, m_shapesDirty, Padstack(), PHYSICAL_CLEARANCE_CONSTRAINT, and SILK_CLEARANCE_CONSTRAINT.

Referenced by STEP_PCB_MODEL::AddPadShape(), FEATURES_MANAGER::AddRoutSlot(), FOOTPRINT::CheckShortingPads(), BOARD_ADAPTER::createPadHoleShape(), doCheckPad(), KIGFX::PCB_PAINTER::draw(), GetEffectiveShape(), KIGFX::PCB_PAINTER::getPadHoleShape(), HitTest(), HitTest(), HitTest(), playground_main_func(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and TransformHoleToPolygon().

◆ GetEffectiveNetClass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetClass ( ) const

virtualinherited

Return the NETCLASS for this item.

Note: Do not return a std::shared_ptr from this. It is used heavily in DRC, and the std::shared_ptr stuff shows up large in performance profiling.

Definition at line 130 of file board_connected_item.cpp.

References BOARD_ITEM::BOARD, NETCLASS::Default, BOARD_ITEM::GetBoard(), and m_netinfo.

Referenced by PCB_TUNING_PATTERN::CreateNew(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DRAWING_TOOL::DrawVia(), PCB_TUNING_PATTERN::EditStart(), DRC_ENGINE::EvalRules(), PCB_VIA::GetDrillValue(), BOARD_INSPECTION_TOOL::getItemDescription(), LENGTH_DELAY_CALCULATION::GetLengthCalculationItem(), PAD::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), GetNetClassName(), hasExactNetclassFunc(), hasNetclassFunc(), ZONE_PAINTER::PCB_PAINTER(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetEffectivePolygon()

const std::shared_ptr< SHAPE_POLY_SET > & PAD::GetEffectivePolygon	(	PCB_LAYER_ID	aLayer,
		ERROR_LOC	aErrorLoc = ERROR_INSIDE ) const

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > PAD::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	determines which layer to query for shape
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 1253 of file pad.cpp.

References ALWAYS_FLASHED, BuildEffectiveShapes(), Edge_Cuts, PADSTACK::EffectiveLayerFor(), FlashLayer(), GetAttribute(), getDrawCache(), GetEffectiveHoleShape(), IsBackdrilledOrPostMachined(), PAD::PAD_DRAW_CACHE_DATA::m_effectiveShapes, m_shapesDirty, NEVER_FLASHED, NPTH, Padstack(), PHYSICAL_CLEARANCE_CONSTRAINT, PTH, and SILK_CLEARANCE_CONSTRAINT.

Referenced by BOOST_FIXTURE_TEST_CASE(), FOOTPRINT::CheckClippedSilk(), FOOTPRINT::CheckShortingPads(), BOARD_ADAPTER::createPadWithMargin(), KIGFX::PCB_PAINTER::draw(), HitTest(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

Reimplemented in BOARD, FOOTPRINT, LIB_SYMBOL, SCH_SYMBOL, and SCHEMATIC.

Definition at line 551 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEmbeddedFonts()

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

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 482 of file board_item.cpp.

References BOARD, and GetBoard().

◆ 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(), 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().

◆ GetFontMetrics()

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

inherited

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

◆ GetFPRelativeOrientation()

EDA_ANGLE PAD::GetFPRelativeOrientation ( ) const

Definition at line 1769 of file pad.cpp.

References m_libOrientation.

Referenced by BOOST_AUTO_TEST_CASE(), Flip(), GetOffset(), GetPrimaryDrillSize(), GetPrimitiveLibScale(), GetSize(), OnFootprintTransformed(), padNeedsUpdate(), SetOffset(), SetPrimaryDrillSize(), and SetSize().

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 437 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().

◆ GetFrontPostMachining()

std::optional< PAD_DRILL_POST_MACHINING_MODE > PAD::GetFrontPostMachining ( ) const

inline

Definition at line 442 of file pad.h.

References m_padStack.

Referenced by RENDER_3D_RAYTRACE_BASE::insertHole().

◆ GetFrontPostMachiningAngle()

int PAD::GetFrontPostMachiningAngle ( ) const

inline

Definition at line 459 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ GetFrontPostMachiningDepth()

int PAD::GetFrontPostMachiningDepth ( ) const

inline

Definition at line 457 of file pad.h.

References m_padStack.

Referenced by RENDER_3D_RAYTRACE_BASE::insertHole(), and PAD_DESC::PAD_DESC().

◆ GetFrontPostMachiningMode()

PAD_DRILL_POST_MACHINING_MODE PAD::GetFrontPostMachiningMode ( ) const

inline

Definition at line 449 of file pad.h.

References m_padStack, and NOT_POST_MACHINED.

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

◆ GetFrontPostMachiningSize()

int PAD::GetFrontPostMachiningSize ( ) const

inline

Definition at line 455 of file pad.h.

References m_padStack.

Referenced by RENDER_3D_RAYTRACE_BASE::insertHole(), and PAD_DESC::PAD_DESC().

◆ GetFrontRoundRectRadiusRatio()

double PAD::GetFrontRoundRectRadiusRatio ( ) const

inline

Definition at line 818 of file pad.h.

References F_Cu, and m_padStack.

Referenced by GetFrontRoundRectRadiusSize(), and PAD_DESC::PAD_DESC().

◆ GetFrontRoundRectRadiusSize()

int PAD::GetFrontRoundRectRadiusSize ( ) const

Definition at line 1222 of file pad.cpp.

References F_Cu, GetFrontRoundRectRadiusRatio(), GetSize(), KiROUND(), minSize, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PAD_DESC::PAD_DESC().

◆ GetFrontShape()

PAD_SHAPE PAD::GetFrontShape ( ) const

inline

Definition at line 210 of file pad.h.

References F_Cu, and m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ GetItemDescription()

wxString PAD::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

aUnitsProvider	is the UNITS_PROVIDER object to handle item units.
aFull	is a flag to get the extend (full) description.

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 2610 of file pad.cpp.

References _, CONN, FPHOLDER, GetAttribute(), BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), GetNumber(), BOARD_ITEM::GetParentFootprint(), FOOTPRINT::GetReference(), BOARD_ITEM::LayerMaskDescribe(), NPTH, and SMD.

◆ GetKeepTopBottom()

bool PAD::GetKeepTopBottom ( ) const

inline

Definition at line 889 of file pad.h.

References m_padStack, and REMOVE_EXCEPT_START_AND_END.

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

◆ GetLayer()

PCB_LAYER_ID PAD::GetLayer ( ) const

overridevirtual

Return the primary layer this item is on.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 659 of file pad.cpp.

References GetPrincipalLayer().

◆ 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()

LSET PAD::GetLayerSet ( ) const

inlineoverridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 557 of file pad.h.

References m_padStack.

Referenced by STEP_PCB_MODEL::AddPadShape(), PCB_IO_IPC2581::addPadStack(), BOOST_AUTO_TEST_CASE(), CheckPad(), FOOTPRINT::CheckShortingPads(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), GetPrincipalLayer(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), ipcPadstackHash(), PCB_SELECTION_TOOL::isPadVisible(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makePADSTACK(), FOOTPRINT::cmp_pads::operator()(), ALTIUM_PCB::ParseFootprint(), AR_MATRIX::PlacePad(), Recombine(), PNS_KICAD_IFACE_BASE::syncPad(), and ViewGetLOD().

◆ GetLibraryPosition()

VECTOR2I PAD::GetLibraryPosition ( ) const

inline

Definition at line 214 of file pad.h.

References m_libPos.

◆ GetLocalClearance() [1/2]

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

inlineoverridevirtual

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

Returns: the clearance (if any is specified) in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 583 of file pad.h.

References m_padStack.

Referenced by doCheckPad(), PCB_IO_KICAD_SEXPR::format(), GetClearanceOverrides(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), padHasOverrides(), and Serialize().

◆ GetLocalClearance() [2/2]

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

overridevirtual

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.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 1947 of file pad.cpp.

References _, and m_padStack.

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 209 of file board_connected_item.h.

References m_localRatsnestVisible.

Referenced by BOARD::ExchangeFootprint().

◆ GetLocalSolderMaskMargin()

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

inline

Definition at line 586 of file pad.h.

References m_padStack.

Referenced by BOOST_FIXTURE_TEST_CASE(), doCheckPad(), PCB_IO_KICAD_SEXPR::format(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), padHasOverrides(), and ALTIUM_PCB::ParseFootprint().

◆ GetLocalSolderPasteMargin()

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

inline

Definition at line 593 of file pad.h.

References m_padStack.

Referenced by doCheckPad(), PCB_IO_KICAD_SEXPR::format(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), padHasOverrides(), and ALTIUM_PCB::ParseFootprint().

◆ GetLocalSolderPasteMarginRatio()

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

inline

Definition at line 600 of file pad.h.

References m_padStack.

Referenced by doCheckPad(), PCB_IO_KICAD_SEXPR::format(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), and padHasOverrides().

◆ GetLocalSpokeWidthOverride()

int PAD::GetLocalSpokeWidthOverride ( wxString * aSource = nullptr ) const

Definition at line 2187 of file pad.cpp.

References _, and m_padStack.

◆ GetLocalThermalGapOverride() [1/2]

std::optional< int > PAD::GetLocalThermalGapOverride ( ) const

inline

Definition at line 777 of file pad.h.

References m_padStack.

Referenced by GetLocalThermalGapOverride().

◆ GetLocalThermalGapOverride() [2/2]

int PAD::GetLocalThermalGapOverride ( wxString * aSource ) const

Definition at line 2196 of file pad.cpp.

References _, GetLocalThermalGapOverride(), and m_padStack.

Referenced by PCB_IO_KICAD_SEXPR::format(), ZONE::GetThermalReliefGap(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), and padHasOverrides().

◆ GetLocalThermalSpokeWidthOverride()

std::optional< int > PAD::GetLocalThermalSpokeWidthOverride ( ) const

inline

Definition at line 741 of file pad.h.

References m_padStack.

Referenced by PAD_TOOL::explodePad(), PCB_IO_KICAD_SEXPR::format(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), padHasOverrides(), and PCB_SHAPE::SetIsProxyItem().

◆ GetLocalZoneConnection()

ZONE_CONNECTION PAD::GetLocalZoneConnection ( ) const

inline

Definition at line 611 of file pad.h.

References INHERITED, and m_padStack.

Referenced by BOOST_FIXTURE_TEST_CASE(), PCB_IO_KICAD_SEXPR::format(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), and padHasOverrides().

◆ 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(), 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(), drawPcbShapeWithStyle(), FabMaskShape(), 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 PAD::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 2694 of file pad.cpp.

References pad.

◆ GetMsgPanelInfo()

void PAD::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 2205 of file pad.cpp.

References _, ANGLE_0, AREA, EDA_ANGLE::AsDegrees(), BGA, CASTELLATED, CIRCLE, clearance, CONN, FIDUCIAL_GLBL, FIDUCIAL_LOCAL, FOOTPRINT_EDIT_FRAME_NAME, PADSTACK::ForEachUniqueLayer(), GetAttribute(), GetDrillShape(), GetDrillSize(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), GetEffectivePolygon(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetname(), FOOTPRINT::GetOrientation(), GetOrientation(), GetOwnClearance(), GetPadToDieLength(), GetPinFunction(), GetPinType(), GetProperty(), FOOTPRINT::GetReference(), GetShape(), GetSize(), HEATSINK, IsLocked(), EDA_ANGLE::IsZero(), BOARD_ITEM::LayerMaskDescribe(), m_number, EDA_ITEM::m_parent, EDA_ITEM::m_Uuid, MECHANICAL, UNITS_PROVIDER::MessageTextFromValue(), NONE, EDA_ANGLE::Normalize180(), OVAL, Padstack(), PCB_EDIT_FRAME_NAME, PRESSFIT, ShowPadAttr(), ShowPadShape(), SMD, source, PADSTACK::TEMP_ALL_LAYERS, TESTPOINT, UNDEFINED_LAYER, UnescapeString(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetNet()

NETINFO_ITEM * BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Return NETINFO_ITEM object for a given item.

Definition at line 81 of file board_connected_item.h.

References m_netinfo.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), TEARDROP_MANAGER::buildCrossingStub(), PNS_KICAD_IFACE::createBoardItem(), CONVERT_TOOL::CreateLines(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_TUNING_PATTERN::EditStart(), EDIT_TOOL::FilletTracks(), PNS::NODE::FindItemByParent(), PAD::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), MODEL_ZONES_OVERVIEW::GetValueByRow(), PCB_TUNING_PATTERN::initBaseLines(), isCoupledDiffPairFunc(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), ROUTER_TOOL::OptimizeSelected(), PartitionNetChainAroundNet(), BOARD_EDITOR_CONTROL::RepairBoard(), BOARD_INSPECTION_TOOL::reportClearance(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::selectNetChain(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), PCB_CONTROL::UpdateMessagePanel(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetNetClassName()

wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const

inherited

Returns the name of the effective netclass.

Primarily for the use of the property system.

Definition at line 149 of file board_connected_item.cpp.

References GetEffectiveNetClass(), and NETCLASS::GetName().

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), and main().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const

inherited

Returns: the net code.

Definition at line 122 of file board_connected_item.cpp.

References m_netinfo.

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 155 of file board_connected_item.cpp.

References m_netinfo.

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), EXPORTER_STEP::buildTrack3DShape(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PAD::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), GetNetnameMsg(), ZONE_SEARCH_HANDLER::getResultCell(), ALTIUM_PCB::HelperCreateTuningPatterns(), isCoupledDiffPairFunc(), FABMASTER::loadZone(), PackNet(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotZone(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetNetnameMsg()

wxString BOARD_CONNECTED_ITEM::GetNetnameMsg ( ) const

inherited

Returns: the full netname or "<no net>" in square braces, followed by "(Not Found)" if the netcode is undefined.

Definition at line 161 of file board_connected_item.cpp.

References _, BOARD_ITEM::GetBoard(), GetNetCode(), GetNetname(), and UnescapeString().

Referenced by PAD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TRACK::GetItemDescription(), PCB_VIA::GetItemDescription(), and ZONE::GetItemDescription().

◆ GetNumber()

const wxString & PAD::GetNumber ( ) const

inline

Definition at line 143 of file pad.h.

References m_number.

Referenced by STEP_PCB_MODEL::AddPadShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT::CheckNetTies(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), KIGFX::PCB_PAINTER::draw(), DIALOG_FP_EDIT_PAD_TABLE::fillGridRow(), MULTICHANNEL_TOOL::fixupNet(), PAD_INFO_FORMATTER::Format(), PCB_IO_KICAD_SEXPR::format(), GetFabPadRole(), GetItemDescription(), FOOTPRINT::GetNetTiePads(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), MakeFabPin(), DRC_TEST_PROVIDER_SOLDER_MASK::maskApertureBridgeExcluded(), DIALOG_FP_EDIT_PAD_TABLE::PAD_SNAPSHOT_COMPARE::operator()(), FOOTPRINT::cmp_pads::operator()(), operator=(), PAD_DESC::PAD_DESC(), padNeedsUpdate(), PCB_IO_IPC2581::pinName(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotPadNumber(), Serialize(), SharesNetTieGroup(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetOffset()

VECTOR2I PAD::GetOffset ( PCB_LAYER_ID aLayer ) const

Definition at line 838 of file pad.cpp.

References GetFPRelativeOrientation(), BOARD_ITEM::GetParentFootprint(), and m_padStack.

Referenced by PCB_IO_IPC2581::addLocationNode(), PCB_IO_IPC2581::addPadStack(), DSN::appendPadstackShape(), BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), FlashLayer(), PCB_IO_KICAD_SEXPR::format(), mirrorPad(), padNeedsUpdate(), ShapePos(), SwapShapePositions(), PNS_KICAD_IFACE_BASE::syncPad(), and GENCAD_EXPORTER::writePadShape().

◆ GetOrientation()

EDA_ANGLE PAD::GetOrientation ( ) const

Return the rotation angle of the pad.

Definition at line 1757 of file pad.cpp.

References BOARD_ITEM::GetParentFootprint(), m_libOrientation, and EDA_ANGLE::Normalized().

Referenced by PCB_IO_IPC2581::addPad(), FEATURES_MANAGER::AddPadShape(), PCB_IO_IPC2581::addSlotCavity(), BOOST_AUTO_TEST_CASE(), buildEffectiveShape(), BuildEffectiveShapes(), PCB_GRID_HELPER::computeAnchors(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), PCB_IO_KICAD_SEXPR::format(), GetMsgPanelInfo(), GetOrientationDegrees(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), RENDER_3D_RAYTRACE_BASE::insertHole(), mirrorPad(), ALTIUM_PCB::ParseFootprint(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotPadNumber(), Recombine(), Rotate(), ShapePos(), SwapShapePositions(), PNS_KICAD_IFACE_BASE::syncPad(), TransformShapeToPolygon(), and GENCAD_EXPORTER::writePadShape().

◆ GetOrientationDegrees()

double PAD::GetOrientationDegrees ( ) const

inline

Definition at line 428 of file pad.h.

References EDA_ANGLE::AsDegrees(), and GetOrientation().

Referenced by PAD_DESC::PAD_DESC().

◆ GetOwnClearance()

int PAD::GetOwnClearance	(	PCB_LAYER_ID	aLayer,
		wxString *	aSource = nullptr ) const

overridevirtual

Return the pad's "own" clearance in internal units.

Parameters

aLayer	the layer in question.
aSource	[out] optionally reports the source as a user-readable string.

Returns: the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 1991 of file pad.cpp.

References BOARD_CONNECTED_ITEM::GetOwnClearance().

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

◆ GetPadstackMode()

PADSTACK::MODE PAD::GetPadstackMode ( ) const

inline

Definition at line 191 of file pad.h.

References m_padStack.

◆ GetPadToDieDelay()

int PAD::GetPadToDieDelay ( ) const

inline

Definition at line 581 of file pad.h.

References m_delayPadToDie.

Referenced by DIALOG_FP_EDIT_PAD_TABLE::fillGridRow(), PAD_INFO_FORMATTER::Format(), PCB_IO_KICAD_SEXPR::format(), TUNING_PROFILE_PARAMETERS_USER_DEFINED::getPropagationDelay(), ImportSettingsFrom(), operator=(), PAD_DESC::PAD_DESC(), Serialize(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ GetPadToDieLength()

int PAD::GetPadToDieLength ( ) const

inline

Definition at line 578 of file pad.h.

References m_lengthPadToDie.

Referenced by LENGTH_DELAY_CALCULATION::CalculateLengthDetails(), DIALOG_FP_EDIT_PAD_TABLE::fillGridRow(), PAD_INFO_FORMATTER::Format(), PCB_IO_KICAD_SEXPR::format(), GetMsgPanelInfo(), ImportSettingsFrom(), operator=(), PAD_DESC::PAD_DESC(), padNeedsUpdate(), Serialize(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ 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(), BOOST_AUTO_TEST_CASE(), ZONE::Clone(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createTrackWithMargin(), 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_TEXTBOX::GetPolygonalBoxShape(), PCB_TABLECELL::GetRow(), PCB_TABLECELL::GetRowHeight(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), 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_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 473 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(), STEP_PCB_MODEL::AddPadShape(), PCB_CONTROL::AppendBoard(), PCB_IO_AUTOTRAX::applyText(), 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(), FabItemLess(), 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_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_TABLECELL::GetUnwrappedShownText(), 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(), FEATURES_MANAGER::InitFeatureList(), 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(), PCB_SELECTION_TOOL::isOnVisibleFootprintSide(), ItemHasDRCViolation(), PCB_SELECTION_TOOL::itemPassesFilter(), MakeFabPin(), 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::RevertToCheckpoint(), 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(), KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), 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_DATA_TEST_CASE_F(), 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(), 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(), SCH_MOVE_TOOL::prepareMoveOperation(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), BOARD::Remove(), PNS_KICAD_IFACE::RemoveItem(), BOARD_COMMIT::RemoveOrDiscard(), 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().

◆ GetPinFunction()

const wxString & PAD::GetPinFunction ( ) const

inline

Definition at line 154 of file pad.h.

References m_pinFunction.

Referenced by KIGFX::PCB_PAINTER::draw(), BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), GetMsgPanelInfo(), BOARD_NETLIST_UPDATER::getPinFunction(), operator=(), PAD_DESC::PAD_DESC(), and BRDITEMS_PLOTTER::PlotPad().

◆ GetPinType()

const wxString & PAD::GetPinType ( ) const

inline

Definition at line 160 of file pad.h.

References m_pinType.

Referenced by BOARD::ExchangeFootprint(), PCB_IO_KICAD_SEXPR::format(), GetMsgPanelInfo(), operator=(), and PAD_DESC::PAD_DESC().

◆ GetPosition()

VECTOR2I PAD::GetPosition ( ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 256 of file pad.cpp.

References BOARD_ITEM::GetParentFootprint(), and m_libPos.

◆ GetPostMachiningKnockout()

int PAD::GetPostMachiningKnockout ( PCB_LAYER_ID aLayer ) const

Get the knockout diameter for a layer affected by post-machining.

Parameters

aLayer the copper layer to check

Returns: the diameter to knockout on this layer, or 0 if layer is not affected

Definition at line 956 of file pad.cpp.

References PADSTACK::POST_MACHINING_PROPS::angle, B_Cu, BOARD_ITEM::BOARD, COUNTERSINK, PADSTACK::POST_MACHINING_PROPS::depth, F_Cu, BOARD_ITEM::GetBoard(), BOARD_STACKUP::GetLayerDistance(), IsCopperLayer(), m_padStack, M_PI, PADSTACK::POST_MACHINING_PROPS::mode, NOT_POST_MACHINED, PADSTACK::POST_MACHINING_PROPS::size, and UNKNOWN.

Referenced by IsBackdrilledOrPostMachined().

◆ GetPrimaryDrillCapped()

std::optional< bool > PAD::GetPrimaryDrillCapped ( ) const

inline

Definition at line 507 of file pad.h.

References m_padStack.

◆ GetPrimaryDrillCappedFlag()

bool PAD::GetPrimaryDrillCappedFlag ( ) const

inline

Definition at line 508 of file pad.h.

References m_padStack.

◆ GetPrimaryDrillEndLayer()

PCB_LAYER_ID PAD::GetPrimaryDrillEndLayer ( ) const

inline

Definition at line 439 of file pad.h.

References m_padStack.

◆ GetPrimaryDrillFilled()

std::optional< bool > PAD::GetPrimaryDrillFilled ( ) const

inline

Definition at line 502 of file pad.h.

References m_padStack.

◆ GetPrimaryDrillFilledFlag()

bool PAD::GetPrimaryDrillFilledFlag ( ) const

inline

Definition at line 503 of file pad.h.

References m_padStack.

◆ GetPrimaryDrillShape()

PAD_DRILL_SHAPE PAD::GetPrimaryDrillShape ( ) const

inline

Definition at line 431 of file pad.h.

References m_padStack.

Referenced by GetDrillShape(), GetPrimaryDrillSize(), SetPrimaryDrillSize(), and SetPrimaryDrillSizeX().

◆ GetPrimaryDrillSize()

VECTOR2I PAD::GetPrimaryDrillSize ( ) const

Definition at line 785 of file pad.cpp.

References GetFPRelativeOrientation(), BOARD_ITEM::GetParentFootprint(), GetPrimaryDrillShape(), and m_padStack.

Referenced by GetDrillSize(), GetPrimaryDrillSizeX(), GetPrimaryDrillSizeY(), SetPrimaryDrillSizeX(), and SetPrimaryDrillSizeY().

◆ GetPrimaryDrillSizeX()

int PAD::GetPrimaryDrillSizeX ( ) const

inline

Definition at line 315 of file pad.h.

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

Referenced by GetDrillSizeX().

◆ GetPrimaryDrillSizeY()

int PAD::GetPrimaryDrillSizeY ( ) const

inline

Definition at line 317 of file pad.h.

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

Referenced by GetDrillSizeY().

◆ GetPrimaryDrillStartLayer()

PCB_LAYER_ID PAD::GetPrimaryDrillStartLayer ( ) const

inline

Definition at line 437 of file pad.h.

References m_padStack.

◆ GetPrimitiveLibScale()

void PAD::GetPrimitiveLibScale	(	double &	aScaleX,
		double &	aScaleY ) const

Definition at line 2504 of file pad.cpp.

References std::abs(), GetFPRelativeOrientation(), BOARD_ITEM::GetParentFootprint(), TRANSFORM_TRS::GetScaleX(), and TRANSFORM_TRS::GetScaleY().

Referenced by rebakePrimitiveToFootprint().

◆ GetPrimitives()

const std::vector< std::shared_ptr< PCB_SHAPE > > & PAD::GetPrimitives ( PCB_LAYER_ID aLayer ) const

inline

Accessor to the basic shape list for custom-shaped pads.

Definition at line 375 of file pad.h.

References m_padStack.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), doCheckPad(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), PCB_IO_KICAD_SEXPR::format(), padNeedsUpdate(), ALTIUM_PCB::ParseFootprint(), and BRDITEMS_PLOTTER::PlotPadNumber().

◆ GetPrincipalLayer()

PCB_LAYER_ID PAD::GetPrincipalLayer ( ) const

Returns: the principal copper layer for SMD and CONN pads.

Definition at line 665 of file pad.cpp.

References CONN, GetLayerSet(), m_attribute, BOARD_ITEM::m_layer, LSET::Seq(), and SMD.

Referenced by PAD_TOOL::explodePad(), GetLayer(), Recombine(), and DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run().

◆ GetProperty()

PAD_PROP PAD::GetProperty ( ) const

inline

Definition at line 563 of file pad.h.

References m_property.

Referenced by STEP_PCB_MODEL::AddPadShape(), CheckPad(), PCB_IO_KICAD_SEXPR::format(), GetFabPadRole(), GetMsgPanelInfo(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), padNeedsUpdate(), BRDITEMS_PLOTTER::PlotPad(), and Serialize().

◆ GetRemoveUnconnected()

bool PAD::GetRemoveUnconnected ( ) const

inline

Definition at line 874 of file pad.h.

References KEEP_ALL, and m_padStack.

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

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

◆ GetRoundRectCornerRadius()

int PAD::GetRoundRectCornerRadius ( PCB_LAYER_ID aLayer ) const

Returns: The radius of the rounded corners for this pad.

Definition at line 1182 of file pad.cpp.

References m_padStack.

Referenced by FEATURES_MANAGER::AddPadShape(), DSN::appendPadstackShape(), buildEffectiveShape(), BRDITEMS_PLOTTER::PlotPad(), PAD_LAYER_GEOMETRY::ResolvePadLayer, TransformShapeToPolygon(), and GENCAD_EXPORTER::writePadShape().

◆ GetRoundRectRadiusRatio()

double PAD::GetRoundRectRadiusRatio ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 811 of file pad.h.

References m_padStack.

Referenced by doCheckPad(), PCB_IO_KICAD_SEXPR::format(), padNeedsUpdate(), and PAD_LAYER_GEOMETRY::ResolvePadLayer.

◆ GetSecondaryDrillEndLayer()

PCB_LAYER_ID PAD::GetSecondaryDrillEndLayer ( ) const

inline

Definition at line 525 of file pad.h.

References m_padStack.

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

◆ GetSecondaryDrillShape()

PAD_DRILL_SHAPE PAD::GetSecondaryDrillShape ( ) const

inline

Definition at line 520 of file pad.h.

References m_padStack.

Referenced by SetSecondaryDrillSizeX().

◆ GetSecondaryDrillSize()

const VECTOR2I & PAD::GetSecondaryDrillSize ( ) const

inline

Definition at line 511 of file pad.h.

References m_padStack.

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

◆ GetSecondaryDrillSizeX()

int PAD::GetSecondaryDrillSizeX ( ) const

inline

Definition at line 515 of file pad.h.

References m_padStack.

◆ GetSecondaryDrillSizeY()

int PAD::GetSecondaryDrillSizeY ( ) const

inline

Definition at line 517 of file pad.h.

References m_padStack.

◆ GetSecondaryDrillStartLayer()

PCB_LAYER_ID PAD::GetSecondaryDrillStartLayer ( ) const

inline

Definition at line 523 of file pad.h.

References m_padStack.

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

◆ GetShape()

PAD_SHAPE PAD::GetShape ( PCB_LAYER_ID aLayer ) const

inline

Returns: the shape of this pad.

Definition at line 205 of file pad.h.

References m_padStack.

Referenced by ZONE_FILLER::addKnockout(), FEATURES_MANAGER::AddPadShape(), PCB_IO_IPC2581::addShape(), DSN::appendPadstackShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), buildEffectiveShape(), buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createPadWithMargin(), doCheckPad(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), FlashLayer(), PAD_INFO_FORMATTER::Format(), PCB_IO_KICAD_SEXPR::format(), GetMsgPanelInfo(), GetSize(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), IsNPTHWithNoCopper(), IsOnCopperLayer(), DSN::isRoundKeepout(), mirrorPad(), FOOTPRINT::cmp_pads::operator()(), PAD_UTILS::PadHasMeaningfulRoundingRadius(), padNeedsUpdate(), ALTIUM_PCB::ParseFootprint(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotPadNumber(), Recombine(), PAD_LAYER_GEOMETRY::ResolvePadLayer, SetSize(), SetSizeX(), SetSizeY(), ShowLegacyPadShape(), ShowPadShape(), DIALOG_PAD_PROPERTIES::transferDataToPad(), TransformShapeToPolygon(), and GENCAD_EXPORTER::writePadShape().

◆ GetShortNetname()

const wxString & BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

Definition at line 177 of file board_connected_item.cpp.

References emptyString, and m_netinfo.

Referenced by STEP_PCB_MODEL::AddPadShape(), PAD::IsFreePad(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetSimElectricalType()

PAD_SIM_ELECTRICAL_TYPE PAD::GetSimElectricalType ( ) const

inline

Definition at line 573 of file pad.h.

References m_simElectricalType.

Referenced by DIFF_PHASE_SKEW_TOOL::determinePathDirections(), PCB_IO_KICAD_SEXPR::format(), operator=(), PAD_DESC::PAD_DESC(), and Serialize().

◆ GetSize()

VECTOR2I PAD::GetSize ( PCB_LAYER_ID aLayer ) const

Definition at line 298 of file pad.cpp.

References GetFPRelativeOrientation(), BOARD_ITEM::GetParentFootprint(), GetShape(), and m_padStack.

Referenced by FEATURES_MANAGER::AddPadShape(), PCB_IO_IPC2581::addShape(), DSN::appendPadstackShape(), 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(), buildEffectiveShape(), buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createPadWithMargin(), doCheckPad(), KIGFX::PCB_PAINTER::draw(), DIALOG_FP_EDIT_PAD_TABLE::fillGridRow(), FlashLayer(), PAD_INFO_FORMATTER::Format(), PAD_UTILS::GetDefaultIpcRoundingRatio(), GetFrontRoundRectRadiusSize(), GetMsgPanelInfo(), GetSizeX(), GetSizeY(), GetSolderPasteMargin(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), IsNPTHWithNoCopper(), DSN::isRoundKeepout(), MergePrimitivesAsPolygon(), FOOTPRINT::cmp_pads::operator()(), padNeedsUpdate(), ALTIUM_PCB::ParseFootprint(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotPadNumber(), PAD_LAYER_GEOMETRY::ResolvePadLayer, SetFrontRoundRectRadiusSize(), DIALOG_FP_EDIT_PAD_TABLE::setPadFromGridCell(), SetSizeX(), SetSizeY(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PCB_IO_EAGLE::transferPad(), TransformShapeToPolygon(), PAD_INFO_FORMATTER::UpdatePad(), and GENCAD_EXPORTER::writePadShape().

◆ GetSizeX()

int PAD::GetSizeX ( ) const

Definition at line 322 of file pad.cpp.

References PADSTACK::ALL_LAYERS, GetSize(), and VECTOR2< T >::x.

Referenced by PCB_GRID_HELPER::computeAnchors(), KIGFX::PCB_PAINTER::draw(), and PAD_DESC::PAD_DESC().

◆ GetSizeY()

int PAD::GetSizeY ( ) const

Definition at line 342 of file pad.cpp.

References PADSTACK::ALL_LAYERS, GetSize(), and VECTOR2< T >::y.

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

◆ GetSolderMaskExpansion()

int PAD::GetSolderMaskExpansion ( PCB_LAYER_ID aLayer ) const

Returns: the expansion for the solder mask layer

Usually > 0 (mask shape bigger than pad). For pads not on copper layers, the value is the local value because there is no default shape to build. For pads also on copper layers, the value (used to build a default shape) is: 1 the local value 2 if 0, the parent footprint value 3 if 0, the global value

Definition at line 1998 of file pad.cpp.

References LSET::AllCuMask(), B_Cu, B_Mask, BOARD_ITEM::BOARD, F_Cu, F_Mask, BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), BOARD_ITEM::GetParentFootprint(), MINOPTMAX< T >::HasOpt(), IsBackLayer(), IsFrontLayer(), BOARD_DESIGN_SETTINGS::m_DRCEngine, m_padStack, DRC_CONSTRAINT::m_Value, MINOPTMAX< T >::Opt(), and SOLDER_MASK_EXPANSION_CONSTRAINT.

Referenced by BOOST_FIXTURE_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), ipcPadstackHash(), ResolvePadMargin(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), and ViewBBox().

◆ GetSolderPasteMargin()

VECTOR2I PAD::GetSolderPasteMargin ( PCB_LAYER_ID aLayer ) const

Usually < 0 (mask shape smaller than pad)because the margin can be dependent on the pad size, the margin has a x and a y value.

For pads not on copper layers, the value is the local value because there is no default shape to build. For pads also on copper layers, the value (used to build a default shape) is: 1 the local value 2 if 0, the parent footprint value 3 if 0, the global value

Returns: the margin for the solder mask layer.

Definition at line 2061 of file pad.cpp.

References LSET::AllCuMask(), B_Cu, B_Paste, BOARD_ITEM::BOARD, CUSTOM, F_Cu, F_Paste, BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), BOARD_ITEM::GetParentFootprint(), GetSize(), MINOPTMAX< T >::HasOpt(), IsBackLayer(), IsFrontLayer(), KiROUND(), BOARD_DESIGN_SETTINGS::m_DRCEngine, m_padStack, DRC_CONSTRAINT::m_Value, MINOPTMAX< T >::Opt(), SOLDER_PASTE_ABS_MARGIN_CONSTRAINT, SOLDER_PASTE_REL_MARGIN_CONSTRAINT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::PCB_PAINTER::draw(), ipcPadstackHash(), ResolvePadMargin(), and ViewBBox().

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

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

◆ GetSubRatsnest()

int PAD::GetSubRatsnest ( ) const

inline

Returns: the netcode.

Definition at line 860 of file pad.h.

References m_subRatsnest.

Referenced by operator=().

◆ GetTeardropAllowSpanTwoTracks()

bool BOARD_CONNECTED_ITEM::GetTeardropAllowSpanTwoTracks ( ) const

inlineinherited

Definition at line 236 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropBestLengthRatio()

double BOARD_CONNECTED_ITEM::GetTeardropBestLengthRatio ( ) const

inlineinherited

Definition at line 218 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropBestWidthRatio()

double BOARD_CONNECTED_ITEM::GetTeardropBestWidthRatio ( ) const

inlineinherited

Definition at line 224 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropCurved()

bool BOARD_CONNECTED_ITEM::GetTeardropCurved ( ) const

inlineinherited

Definition at line 230 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxLength()

int BOARD_CONNECTED_ITEM::GetTeardropMaxLength ( ) const

inlineinherited

Definition at line 221 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxTrackWidth()

double BOARD_CONNECTED_ITEM::GetTeardropMaxTrackWidth ( ) const

inlineinherited

Definition at line 239 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxWidth()

int BOARD_CONNECTED_ITEM::GetTeardropMaxWidth ( ) const

inlineinherited

Definition at line 227 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropParams() [1/2]

TEARDROP_PARAMETERS & BOARD_CONNECTED_ITEM::GetTeardropParams ( )

inlineinherited

Definition at line 211 of file board_connected_item.h.

References m_teardropParams.

Referenced by PAD::Deserialize(), PCB_VIA::Deserialize(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_IO_KICAD_SEXPR::format(), ZONE::operator==(), DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), PAD::Serialize(), PCB_VIA::Serialize(), ZONE::Similarity(), DIALOG_PAD_PROPERTIES::transferDataToPad(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem().

◆ GetTeardropParams() [2/2]

const TEARDROP_PARAMETERS & BOARD_CONNECTED_ITEM::GetTeardropParams ( ) const

inlineinherited

Definition at line 212 of file board_connected_item.h.

References m_teardropParams.

◆ GetTeardropPreferZoneConnections()

bool BOARD_CONNECTED_ITEM::GetTeardropPreferZoneConnections ( ) const

inlineinherited

Definition at line 233 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropsEnabled()

bool BOARD_CONNECTED_ITEM::GetTeardropsEnabled ( ) const

inlineinherited

Definition at line 215 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

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

◆ GetTertiaryDrillEndLayer()

PCB_LAYER_ID PAD::GetTertiaryDrillEndLayer ( ) const

inline

Definition at line 542 of file pad.h.

References m_padStack.

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

◆ GetTertiaryDrillShape()

PAD_DRILL_SHAPE PAD::GetTertiaryDrillShape ( ) const

inline

Definition at line 537 of file pad.h.

References m_padStack.

Referenced by SetTertiaryDrillSizeX().

◆ GetTertiaryDrillSize()

const VECTOR2I & PAD::GetTertiaryDrillSize ( ) const

inline

Definition at line 528 of file pad.h.

References m_padStack.

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

◆ GetTertiaryDrillSizeX()

int PAD::GetTertiaryDrillSizeX ( ) const

inline

Definition at line 532 of file pad.h.

References m_padStack.

◆ GetTertiaryDrillSizeY()

int PAD::GetTertiaryDrillSizeY ( ) const

inline

Definition at line 534 of file pad.h.

References m_padStack.

◆ GetTertiaryDrillStartLayer()

PCB_LAYER_ID PAD::GetTertiaryDrillStartLayer ( ) const

inline

Definition at line 540 of file pad.h.

References m_padStack.

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

◆ GetThermalGap()

int PAD::GetThermalGap ( ) const

inline

Definition at line 773 of file pad.h.

References m_padStack.

Referenced by padHasOverrides().

◆ GetThermalSpokeAngle()

EDA_ANGLE PAD::GetThermalSpokeAngle ( ) const

inline

Definition at line 757 of file pad.h.

References m_padStack.

Referenced by PCB_IO_KICAD_SEXPR::format(), ImportSettingsFrom(), and padHasOverrides().

◆ GetThermalSpokeAngleDegrees()

double PAD::GetThermalSpokeAngleDegrees ( ) const

inline

Definition at line 767 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ GetTopBackdrillLayer()

PCB_LAYER_ID PAD::GetTopBackdrillLayer ( ) const

inline

Definition at line 1074 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ GetTopBackdrillSize()

std::optional< int > PAD::GetTopBackdrillSize ( ) const

inline

Definition at line 1071 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

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

◆ GetUnconnectedLayerMode()

UNCONNECTED_LAYER_MODE PAD::GetUnconnectedLayerMode ( ) const

inline

Definition at line 899 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ 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 PAD::GetZoneConnectionOverrides ( wxString * aSource = nullptr ) const

Definition at line 2167 of file pad.cpp.

References _, BOARD_ITEM::GetParentFootprint(), INHERITED, and m_padStack.

◆ GetZoneLayerOverride()

const ZONE_LAYER_OVERRIDE & PAD::GetZoneLayerOverride ( PCB_LAYER_ID aLayer ) const

Definition at line 517 of file pad.cpp.

References m_dataMutex, m_zoneLayerOverrides, and ZLO_NONE.

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

◆ 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()

bool PAD::HasDrilledHole ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 118 of file pad.h.

References GetDrillSizeX(), GetDrillSizeY(), and HasHole().

Referenced by CheckPad(), and FOOTPRINT::CheckShortingPads().

◆ HasExplicitDefinitionForLayer()

bool PAD::HasExplicitDefinitionForLayer ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 285 of file pad.h.

References m_padStack.

◆ 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(), SCH_MOVE_TOOL::doMoveSelection(), 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(), SCH_POINT_EDITOR::Reset(), 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(), PCB_VIA::SetSizeFromRules(), SCH_COMMIT::Stage(), TRACKS_CLEANER::testTrackEndpointIsNode(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and PCB_TUNING_PATTERN::ViewDraw().

◆ HasHole()

bool PAD::HasHole ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 113 of file pad.h.

References GetDrillSizeX(), and GetDrillSizeY().

Referenced by PCB_IO_IPC2581::addPadStack(), EDA_DATA::PACKAGE::AddPin(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createPadHoleShape(), HasDrilledHole(), IsDrillSlot(), IsType(), MakeFabPin(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), PCB_CONTROL::UpdateMessagePanel(), and 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().

◆ HitTest() [1/4]

bool PAD::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 2402 of file pad.cpp.

References SHAPE_SEGMENT::Collide(), BOX2< Vec >::Contains(), ERROR_INSIDE, PADSTACK::ForEachUniqueLayer(), GetBoundingBox(), GetEffectiveHoleShape(), GetEffectivePolygon(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), BOX2< Vec >::Normalize(), and Padstack().

◆ HitTest() [2/4]

bool PAD::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 2465 of file pad.cpp.

References SHAPE_COMPOUND::AddShape(), PADSTACK::ForEachUniqueLayer(), GetEffectiveHoleShape(), GetEffectiveShape(), Padstack(), and KIGEOM::ShapeHitTest().

◆ HitTest() [3/4]

bool PAD::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy,
		PCB_LAYER_ID	aLayer ) const

return true if hit test on the specified layer

Definition at line 2359 of file pad.cpp.

References SHAPE_POLY_SET::Contains(), delta, ERROR_INSIDE, GetBoundingRadius(), GetEffectivePolygon(), GetPosition(), IsOnLayer(), and SEG::Square().

◆ HitTest() [4/4]

bool PAD::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 2376 of file pad.cpp.

References SHAPE_SEGMENT::Collide(), delta, ERROR_INSIDE, PADSTACK::ForEachUniqueLayer(), GetBoundingRadius(), GetEffectiveHoleShape(), GetEffectivePolygon(), GetPosition(), Padstack(), and SEG::Square().

◆ ImportSettingsFrom()

void PAD::ImportSettingsFrom ( const PAD & aMasterPad )

Import the pad settings from aMasterPad.

The result is "this" has the same settings (sizes, shapes ... ) as aMasterPad.

Parameters

aMasterPad the template pad.

Definition at line 2932 of file pad.cpp.

References CanHaveNumber(), CIRCLE, CONN, PADSTACK::ForEachUniqueLayer(), GetAttribute(), GetCustomShapeInZoneOpt(), GetLayerSet(), GetLocalClearance(), GetLocalSolderMaskMargin(), GetLocalSolderPasteMargin(), GetLocalSolderPasteMarginRatio(), GetLocalThermalGapOverride(), GetLocalThermalSpokeWidthOverride(), GetLocalZoneConnection(), FOOTPRINT::GetOrientation(), GetOrientation(), GetPadToDieDelay(), GetPadToDieLength(), BOARD_ITEM::GetParentFootprint(), GetProperty(), GetShape(), GetThermalSpokeAngle(), BOARD_CONNECTED_ITEM::m_teardropParams, PAD(), Padstack(), SetAttribute(), SetCustomShapeInZoneOpt(), SetDirty(), SetDrillSize(), SetLayerSet(), SetLibSize(), SetLocalClearance(), SetLocalSolderMaskMargin(), SetLocalSolderPasteMargin(), SetLocalSolderPasteMarginRatio(), SetLocalThermalGapOverride(), SetLocalThermalSpokeWidthOverride(), SetLocalZoneConnection(), SetNumber(), SetOrientation(), SetPadstack(), SetPadToDieDelay(), SetPadToDieLength(), SetProperty(), SetThermalSpokeAngle(), and SMD.

Referenced by PAD_TOOL::copyPadSettings(), operator=(), and PAD_TOOL::pastePadProperties().

◆ IsAperturePad()

bool PAD::IsAperturePad ( ) const

inline

Definition at line 567 of file pad.h.

References LSET::AllCuMask(), and m_padStack.

Referenced by CanHaveNumber(), doPushPadProperties(), GetPadTypeString(), and SetPadTypeFromString().

◆ IsBackdrilledOrPostMachined()

bool PAD::IsBackdrilledOrPostMachined ( PCB_LAYER_ID aLayer ) const

Check if a layer is affected by backdrilling or post-machining operations.

This checks both the secondary drill (backdrill) and post-machining (counterbore/countersink) settings to determine if the given layer has had copper removed.

Parameters

aLayer the copper layer to check

Returns: true if the layer is affected by backdrilling or post-machining

Definition at line 873 of file pad.cpp.

References B_Cu, BOARD_ITEM::BOARD, PADSTACK::DRILL_PROPS::end, F_Cu, BOARD_ITEM::GetBoard(), GetPostMachiningKnockout(), IsCopperLayer(), m_padStack, PADSTACK::DRILL_PROPS::size, PADSTACK::DRILL_PROPS::start, UNDEFINED_LAYER, and VECTOR2< T >::x.

Referenced by GetEffectiveHoleShape(), and GetEffectiveShape().

◆ 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(), BOARD_COMMIT::RevertToCheckpoint(), 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().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

References BRIGHTENED, m_flags, and m_netHighlighted.

◆ IsConnected()

bool BOARD_CONNECTED_ITEM::IsConnected ( ) const

inlineoverridevirtualinherited

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

Reimplemented in PCB_SHAPE, and ZONE.

Definition at line 73 of file board_connected_item.h.

◆ IsDirty()

bool PAD::IsDirty ( ) const

inline

Definition at line 544 of file pad.h.

References ERROR_INSIDE, ERROR_OUTSIDE, m_polyDirty, and m_shapesDirty.

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

◆ IsFlipped()

bool PAD::IsFlipped ( ) const

Returns: true if the pad has a footprint parent flipped on the back/bottom layer.

Definition at line 651 of file pad.cpp.

References B_Cu, FOOTPRINT::GetLayer(), and BOARD_ITEM::GetParentFootprint().

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

◆ IsFreePad()

bool PAD::IsFreePad ( ) const

Returns: true if the pad is associated with a "free" pin (not-internally-connected) and has not yet been assigned another net (ie: by being routed to).

Definition at line 610 of file pad.cpp.

References BOARD_CONNECTED_ITEM::GetShortNetname(), and m_pinType.

Referenced by CN_CLUSTER::Add(), KIGFX::PCB_PAINTER::draw(), isMaskAperture(), PNS_KICAD_IFACE_BASE::syncPad(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

◆ IsGroupableType()

bool BOARD_ITEM::IsGroupableType ( ) const

inherited

◆ IsIndexedInBoard()

bool BOARD_ITEM::IsIndexedInBoard ( ) const

inlineinherited

Definition at line 420 of file board_item.h.

References m_boardCacheOwner.

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Reimplemented in PCB_BARCODE.

Definition at line 414 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()

virtual bool BOARD_ITEM::IsLayerAgnostic ( ) const

inlinevirtualinherited

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.

Reimplemented in FOOTPRINT, PCB_CONSTRAINT, and PCB_GROUP.

Definition at line 307 of file board_item.h.

Referenced by FitsEnabledLayers().

◆ IsLocked()

bool PAD::IsLocked ( ) const

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 578 of file pad.cpp.

References BOARD_ITEM::GetParent(), BOARD_ITEM::IsLocked(), and IsLocked().

Referenced by GetMsgPanelInfo(), IsLocked(), Serialize(), and ViewGetLayers().

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

◆ 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_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_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SCH_POINT_EDITOR::Main(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_MOVE_TOOL::prepareMoveOperation(), SCH_SELECTION_TOOL::select(), SCH_MOVE_TOOL::startMoveOperation(), PCB_TUNING_PATTERN::Update(), and PCB_TUNING_PATTERN::ViewDraw().

◆ IsNoConnectPad()

bool PAD::IsNoConnectPad ( ) const

Returns: true if the pad is associated with an "unconnected" pin (or a no-connect symbol) and has no net.

Definition at line 604 of file pad.cpp.

References m_pinType.

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

◆ IsNPTHWithNoCopper()

bool PAD::IsNPTHWithNoCopper ( ) const

Definition at line 548 of file pad.cpp.

References CIRCLE, PADSTACK::ForEachUniqueLayer(), GetAttribute(), GetDrillSize(), GetShape(), GetSize(), NPTH, OVAL, and Padstack().

◆ IsOnCopperLayer()

bool PAD::IsOnCopperLayer ( ) const

overridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 1900 of file pad.cpp.

References LSET::AllCuMask(), CIRCLE, PADSTACK::ForEachUniqueLayer(), GetAttribute(), GetShape(), m_padStack, NPTH, OVAL, and Padstack().

Referenced by doCheckPad(), BOARD::ExchangeFootprint(), and MakeFabPin().

◆ IsOnLayer()

bool PAD::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlineoverridevirtual

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 924 of file pad.h.

References m_padStack.

Referenced by AR_AUTOPLACER::addPad(), STEP_PCB_MODEL::AddPadShape(), FOOTPRINT::CheckClippedSilk(), CheckPad(), FlashLayer(), HitTest(), DSN::SPECCTRA_DB::makePADSTACK(), ALTIUM_PCB::ParseFootprint(), and ViewGetLayers().

◆ 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 522 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().

◆ 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()

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

inlineoverridevirtual

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

Definition at line 92 of file pad.h.

References HasHole(), EDA_ITEM::IsType(), m_attribute, NPTH, PCB_LOCATE_HOLE_T, PCB_LOCATE_NPTH_T, and PCB_LOCATE_PTH_T.

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

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

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

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

Reimplemented in FOOTPRINT, NETINFO_ITEM, PCB_FIELD, PCB_GROUP, PCB_MARKER, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, SCH_FIELD, SCH_GROUP, SCH_LABEL_BASE, SCH_MARKER, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 484 of file eda_item.h.

Referenced by SCH_FIND_REPLACE_TOOL::HasMatch(), FOOTPRINT::Matches(), NETINFO_ITEM::Matches(), PCB_GROUP::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_GROUP::Matches(), SCH_LABEL_BASE::Matches(), SCH_MARKER::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_SYMBOL::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), ZONE::Matches(), SCH_ITEM::MatchesNetName(), TEXT_SEARCH_HANDLER::Search(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 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.

◆ MergePrimitivesAsPolygon()

void PAD::MergePrimitivesAsPolygon	(	PCB_LAYER_ID	aLayer,
		SHAPE_POLY_SET *	aMergedPolygon,
		ERROR_LOC	aErrorLoc = ERROR_INSIDE ) const

Merge all basic shapes to a SHAPE_POLY_SET.

Note: The results are relative to the pad position, orientation 0.

Parameters

aLayer	is the copper layer to merge shapes for
aMergedPolygon	will store the final polygon
aErrorLoc	is used when a circle (or arc) is approximated by segments = ERROR_INSIDE to build a polygon inside the arc/circle (usual shape to raw/plot) = ERROR_OUIDE to build a polygon outside the arc/circle (for instance when building a clearance area)

Definition at line 3751 of file pad.cpp.

References SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::BooleanAdd(), CIRCLE, SHAPE_POLY_SET::Fracture(), GetAnchorPadShape(), BOARD_ITEM::GetMaxError(), GetSize(), m_padStack, SHAPE_RECT::Outline(), SHAPE_POLY_SET::OutlineCount(), RECTANGLE, SHAPE_POLY_SET::RemoveAllContours(), SHAPE_POLY_SET::Simplify(), TransformCircleToPolygon(), UNDEFINED_LAYER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DSN::appendPadstackShape(), doCheckPad(), PAD_LAYER_GEOMETRY::ResolvePadLayer, TransformShapeToPolygon(), and GENCAD_EXPORTER::writePadShape().

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

References KIGFX::VIEW_ITEM::GetClass().

◆ Move()

void PAD::Move ( const VECTOR2I & aMoveVector )

inlineoverridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 997 of file pad.h.

References GetPosition(), and SetPosition().

Referenced by DIALOG_FP_EDIT_PAD_TABLE::OnAddRow().

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

References Normalize().

◆ OnFootprintRescaled()

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

overridevirtual

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

Definition at line 2529 of file pad.cpp.

References PADSTACK::ForEachUniqueLayer(), OnFootprintTransformed(), Padstack(), and rebakePrimitiveToFootprint().

◆ OnFootprintTransformed()

void PAD::OnFootprintTransformed ( )

overridevirtual

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

Scaling uses OnFootprintRescaled.

Reimplemented from BOARD_ITEM.

Definition at line 2547 of file pad.cpp.

References ANGLE_0, GetFPRelativeOrientation(), BOARD_ITEM::GetParentFootprint(), Padstack(), SetDirty(), and PADSTACK::SetOrientation().

Referenced by OnFootprintRescaled().

◆ 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=()

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

Definition at line 348 of file pad.cpp.

References GetNumber(), GetPadToDieDelay(), GetPadToDieLength(), GetPinFunction(), GetPinType(), GetPosition(), GetSimElectricalType(), GetSubRatsnest(), ImportSettingsFrom(), m_effectiveBoundingRadius, BOARD_ITEM::operator=(), PAD(), SetNumber(), SetPadToDieDelay(), SetPadToDieLength(), SetPinFunction(), SetPinType(), SetPosition(), SetSimElectricalType(), and SetSubRatsnest().

Referenced by PAD().

◆ operator==() [1/2]

bool PAD::operator== ( const BOARD_ITEM & aBoardItem ) const

overridevirtual

Implements BOARD_ITEM.

Definition at line 3592 of file pad.cpp.

References BOARD_ITEM::BOARD_ITEM(), BOARD_ITEM::GetParent(), EDA_ITEM::m_parent, EDA_ITEM::m_Uuid, PAD(), and EDA_ITEM::Type().

◆ operator==() [2/2]

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

Definition at line 3606 of file pad.cpp.

References GetAttribute(), GetPosition(), PAD(), and Padstack().

◆ PackNet()

void BOARD_CONNECTED_ITEM::PackNet ( kiapi::board::types::Net * aProto ) const

inherited

Definition at line 79 of file board_connected_item.cpp.

References GetNetname().

Referenced by PAD::Serialize(), PCB_ARC::Serialize(), PCB_SHAPE::Serialize(), PCB_TRACK::Serialize(), PCB_VIA::Serialize(), and ZONE::Serialize().

◆ Padstack() [1/2]

PADSTACK & PAD::Padstack ( )

inline

Definition at line 332 of file pad.h.

References m_padStack.

◆ Padstack() [2/2]

const PADSTACK & PAD::Padstack ( ) const

inline

Definition at line 331 of file pad.h.

References m_padStack.

Referenced by PCB_IO_IPC2581::addLocationNode(), PCB_IO_IPC2581::addPadStack(), EDA_DATA::PACKAGE::AddPin(), PCB_IO_IPC2581::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BuildEffectivePolygon(), BuildEffectiveShapes(), CheckPad(), FOOTPRINT::CheckShortingPads(), Clone(), Compare(), doPushPadProperties(), PAD_TOOL::explodePad(), DIALOG_FP_EDIT_PAD_TABLE::fillGridRow(), Flip(), FlipPrimitives(), PCB_IO_KICAD_SEXPR::format(), GetCoverageArea(), GetEffectiveHoleShape(), GetEffectivePolygon(), GetEffectiveShape(), GetMsgPanelInfo(), HitTest(), HitTest(), HitTest(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), LENGTH_DELAY_CALCULATION::inferViaInPad(), ipcPadstackHash(), CONNECTIVITY_DATA::IsConnectedOnLayer(), IsNPTHWithNoCopper(), IsOnCopperLayer(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makePADSTACK(), mirrorPad(), OnFootprintRescaled(), OnFootprintTransformed(), FOOTPRINT::cmp_pads::operator()(), operator==(), LENGTH_DELAY_CALCULATION::optimiseVias(), padNeedsUpdate(), PCB_IO_KICAD_SEXPR_PARSER::parsePadstack(), AR_MATRIX::PlacePad(), Recombine(), DIALOG_FP_EDIT_PAD_TABLE::setPadFromGridCell(), Similarity(), PNS_KICAD_IFACE_BASE::syncPad(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PAD_INFO_FORMATTER::UpdatePad(), and ViewBBox().

◆ polygonArea()

double BOARD_ITEM::polygonArea ( SHAPE_POLY_SET & aPolySet )

staticprotectedinherited

Area of aPolySet with every contour closed first, holes subtracted.

Definition at line 388 of file board_item.cpp.

References SHAPE_POLY_SET::Area(), SHAPE_POLY_SET::Hole(), SHAPE_POLY_SET::HoleCount(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::SetClosed().

Referenced by FOOTPRINT::CoverageRatio(), GetCoverageArea(), FOOTPRINT::GetCoverageArea(), PAD::GetCoverageArea(), PCB_TEXT::GetCoverageArea(), PCB_TEXTBOX::GetCoverageArea(), and ZONE::GetCoverageArea().

◆ PTHMask()

LSET PAD::PTHMask ( )

static

◆ rebakePrimitiveToFootprint()

void PAD::rebakePrimitiveToFootprint ( PCB_SHAPE * aPrimitive ) const

private

Definition at line 2518 of file pad.cpp.

References BOARD_ITEM::GetParentFootprint(), GetPrimitiveLibScale(), and PCB_SHAPE::RebakeWithScale().

Referenced by AddPrimitive(), and OnFootprintRescaled().

◆ Recombine()

std::vector< PCB_SHAPE * > PAD::Recombine	(	bool	aIsDryRun,
		int	aMaxError )

Recombines the pad with other graphical shapes in the footprint.

Parameters

aIsDryRun	if true, the pad will not be recombined but the operation will still be logged
aMaxError	the maximum error to allow for converting arcs to polygons

Returns: a list of shapes that were recombined

Definition at line 3152 of file pad.cpp.

References AddPrimitive(), PADSTACK::ALL_LAYERS, BOARD_ITEM::BOARD_ITEM(), SHAPE_POLY_SET::BooleanIntersection(), CIRCLE, EDA_ITEM::ClearFlags(), CUSTOM, ENTERED, ERROR_INSIDE, FILLED_SHAPE, findNext(), PADSTACK::ForEachUniqueLayer(), EDA_ITEM::GetFlags(), PCB_SHAPE::GetLayer(), GetLayerSet(), GetOrientation(), BOARD_ITEM::GetParentFootprint(), GetPrincipalLayer(), GetShape(), FOOTPRINT::GraphicalItems(), group, IGNORE_PARENT_GROUP, EDA_SHAPE::IsAnyFill(), SHAPE_POLY_SET::IsEmpty(), PCB_SHAPE::IsProxyItem(), PCB_SHAPE::Move(), SHAPE::NearestPoints(), PADSTACK::NORMAL, Padstack(), POLY, radius, RECTANGLE, PCB_SHAPE::Rotate(), SetAnchorPadShape(), EDA_SHAPE::SetFilled(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetParent(), PCB_SHAPE::SetPolyShape(), SetShape(), SetSize(), PCB_SHAPE::SetStroke(), ShapePos(), SKIP_STRUCT, SOLID, TransformShapeToPolygon(), and PCB_SHAPE::TransformShapeToPolygon().

Referenced by PAD_TOOL::RecombinePad().

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

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

◆ 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 511 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().

◆ ReplacePrimitives()

void PAD::ReplacePrimitives	(	PCB_LAYER_ID	aLayer,
		const std::vector< std::shared_ptr< PCB_SHAPE > > &	aPrimitivesList )

Clear the current custom shape primitives list and import a new list.

Copies the input, which is not altered.

Definition at line 3684 of file pad.cpp.

References AppendPrimitives(), DeletePrimitivesList(), and SetDirty().

Referenced by DIALOG_PAD_PROPERTIES::transferDataToPad().

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

◆ Rotate()

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

overridevirtual

Rotate this object.

Parameters

aRotCentre	the rotation center point.
aAngle	the amount to rotation around the center point.

Reimplemented from BOARD_ITEM.

Definition at line 2494 of file pad.cpp.

References GetOrientation(), GetPosition(), RotatePoint(), SetOrientation(), and SetPosition().

◆ RunOnChildren()

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

inlinevirtualinherited

Invoke a function on all children.

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

Reimplemented in BOARD, FOOTPRINT, PCB_GROUP, and PCB_TABLE.

Definition at line 264 of file board_item.h.

References BOARD_ITEM().

Referenced by BOARD::CacheChildrenById(), BOARD::CacheItemSubtreeById(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), CollectConstraintScopeIds(), PCB_GROUP::DeepDuplicate(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::Duplicate(), PCB_TABLE::Duplicate(), PCB_SELECTION_TOOL::HasLockedDescendant(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), BOARD_EDITOR_CONTROL::modifyLockSelected(), ARRAY_TOOL::onDialogClosed(), PCB_IO_KICAD_SEXPR_PARSER::Parse(), BOARD_COMMIT::propagateDamage(), BOARD_COMMIT::Push(), PCB_GRID_HELPER::queryVisible(), ALLEGRO::BOARD_BUILDER::stampIds(), BOARD::UncacheChildrenById(), BOARD::UncacheItemSubtreeById(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), KIGFX::PCB_VIEW::Update(), and PCB_SELECTION::updateDrawList().

◆ SameLogicalPadAs()

bool PAD::SameLogicalPadAs ( const PAD * aOther ) const

inline

Before we had custom pad shapes it was common to have multiple overlapping pads to represent a more complex shape.

Definition at line 166 of file pad.h.

References BOARD_ITEM::GetParentFootprint(), m_number, and PAD().

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::maskApertureBridgeExcluded().

◆ Serialize()

void PAD::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 402 of file pad.cpp.

References GetAttribute(), GetLocalClearance(), GetNumber(), GetPadToDieDelay(), GetPadToDieLength(), BOARD_ITEM::GetParentFootprint(), GetPosition(), GetProperty(), GetSimElectricalType(), BOARD_CONNECTED_ITEM::GetTeardropParams(), IsLocked(), m_dataMutex, m_padStack, m_pinFunction, m_pinType, EDA_ITEM::m_Uuid, m_zoneLayerOverrides, kiapi::common::PackCustomProperties(), BOARD_CONNECTED_ITEM::PackNet(), kiapi::board::PackTeardropSettings(), kiapi::common::PackVector2(), kiapi::board::PackZoneLayerOverrides(), pad, parsePinType(), and ToProtoEnum().

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

◆ SetAnchorPadShape()

void PAD::SetAnchorPadShape	(	PCB_LAYER_ID	aLayer,
		PAD_SHAPE	aShape )

inline

Set the shape of the anchor pad for custom shaped pads.

Parameters

aLayer	is the layer ID of the pad.
aShape	is the shape of the anchor pad shape( currently, only PAD_SHAPE::RECTANGLE or PAD_SHAPE::CIRCLE.

Definition at line 249 of file pad.h.

References CIRCLE, m_padStack, RECTANGLE, and SetDirty().

Referenced by PAD(), ALTIUM_PCB::ParseFootprint(), PCB_IO_KICAD_SEXPR_PARSER::parsePAD_option(), Recombine(), PAD_LAYER_GEOMETRY::ResolvePadLayer, and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetAttribute()

void PAD::SetAttribute ( PAD_ATTRIB aAttribute )

◆ SetBackdrillMode()

void PAD::SetBackdrillMode ( BACKDRILL_MODE aMode )

inline

Definition at line 1063 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ SetBackPostMachining()

void PAD::SetBackPostMachining ( const std::optional< PAD_DRILL_POST_MACHINING_MODE > & aMode )

inline

Definition at line 461 of file pad.h.

References m_padStack.

◆ SetBackPostMachiningAngle()

void PAD::SetBackPostMachiningAngle ( int aAngle )

inline

Definition at line 478 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC(), and BACKDRILL_TEST_FIXTURE::SetPadPostMachining().

◆ SetBackPostMachiningDepth()

void PAD::SetBackPostMachiningDepth ( int aDepth )

inline

Definition at line 476 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC(), and BACKDRILL_TEST_FIXTURE::SetPadPostMachining().

◆ SetBackPostMachiningMode()

void PAD::SetBackPostMachiningMode ( PAD_DRILL_POST_MACHINING_MODE aMode )

inline

Definition at line 464 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC(), and BACKDRILL_TEST_FIXTURE::SetPadPostMachining().

◆ SetBackPostMachiningSize()

void PAD::SetBackPostMachiningSize ( int aSize )

inline

Definition at line 474 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC(), and BACKDRILL_TEST_FIXTURE::SetPadPostMachining().

◆ SetBottomBackdrillLayer()

void PAD::SetBottomBackdrillLayer ( PCB_LAYER_ID aLayer )

inline

Definition at line 1069 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ SetBottomBackdrillSize()

void PAD::SetBottomBackdrillSize ( std::optional< int > aSize )

inline

Definition at line 1066 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

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

◆ SetChamferPositions()

void PAD::SetChamferPositions	(	PCB_LAYER_ID	aLayer,
		int	aPositions )

inline

Has meaning only for chamfered rectangular pads.

Set the position of the chamfers for orientation 0.

Parameters

aLayer	is the layer ID of the PAD to chamfer.
aPositions	a bit-set of RECT_CHAMFER_POSITIONS.

Definition at line 847 of file pad.h.

References m_padStack.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyPadShape(), PCB_IO_KICAD_SEXPR_PARSER::parsePadstack(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetChamferRectRatio()

void PAD::SetChamferRectRatio	(	PCB_LAYER_ID	aLayer,
		double	aChamferScale )

Has meaning only for chamfered rectangular pads.

Set the ratio between the smaller X or Y size and chamfered corner size. Cannot be < 0.5.

Definition at line 1232 of file pad.cpp.

References m_padStack, and SetDirty().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyPadShape(), PCB_IO_KICAD_SEXPR_PARSER::parsePadstack(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ 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(), 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().

◆ SetCustomShapeInZoneOpt()

void PAD::SetCustomShapeInZoneOpt ( CUSTOM_SHAPE_ZONE_MODE aOption )

inline

Set the option for the custom pad shape to use as clearance area in copper zones.

Parameters

aOption is the clearance area shape CUST_PAD_SHAPE_IN_ZONE option

Definition at line 237 of file pad.h.

References m_padStack.

Referenced by ImportSettingsFrom(), PCB_IO_KICAD_SEXPR_PARSER::parsePAD_option(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetDelta()

void PAD::SetDelta	(	PCB_LAYER_ID	aLayer,
		const VECTOR2I &	aSize )

inline

Definition at line 301 of file pad.h.

References m_padStack, and SetDirty().

Referenced by mirrorPad(), PCB_IO_KICAD_SEXPR_PARSER::parsePadstack(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetDirty()

void PAD::SetDirty ( )

inline

Definition at line 549 of file pad.h.

References ERROR_INSIDE, ERROR_OUTSIDE, m_polyDirty, and m_shapesDirty.

Referenced by AddPrimitive(), AddPrimitivePoly(), AddPrimitivePoly(), AppendPrimitives(), ClearSecondaryDrillSize(), ClearTertiaryDrillSize(), DeletePrimitivesList(), Flip(), FlipPrimitives(), ImportSettingsFrom(), DIALOG_FP_EDIT_PAD_TABLE::OnCellChanged(), OnFootprintTransformed(), DIALOG_FP_EDIT_PAD_TABLE::OnImportButtonClick(), PAD(), ReplacePrimitives(), SetAnchorPadShape(), SetAttribute(), SetChamferRectRatio(), SetDelta(), SetFPRelativeOrientation(), SetFrontRoundRectRadiusRatio(), SetFrontShape(), SetLayerSet(), SetLibDrillSize(), SetLibOffset(), SetLibSize(), SetOffset(), SetOrientation(), SetPosition(), SetPrimaryDrillCapped(), SetPrimaryDrillCappedFlag(), SetPrimaryDrillEndLayer(), SetPrimaryDrillFilled(), SetPrimaryDrillFilledFlag(), SetPrimaryDrillShape(), SetPrimaryDrillSize(), SetPrimaryDrillStartLayer(), SetProperty(), SetRoundRectRadiusRatio(), SetSecondaryDrillEndLayer(), SetSecondaryDrillShape(), SetSecondaryDrillSize(), SetSecondaryDrillSizeX(), SetSecondaryDrillSizeY(), SetSecondaryDrillStartLayer(), SetShape(), SetSize(), SetTertiaryDrillEndLayer(), SetTertiaryDrillShape(), SetTertiaryDrillSize(), SetTertiaryDrillSizeX(), SetTertiaryDrillSizeY(), and SetTertiaryDrillStartLayer().

◆ SetDrillShape()

void PAD::SetDrillShape ( PAD_DRILL_SHAPE aShape )

inline

Definition at line 433 of file pad.h.

References SetPrimaryDrillShape().

Referenced by BOOST_AUTO_TEST_CASE(), DIPTRACE::PCB_PARSER::CreateFootprint(), PAD(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetDrillSize()

void PAD::SetDrillSize ( const VECTOR2I & aSize )

inline

Definition at line 319 of file pad.h.

References SetPrimaryDrillSize().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIPTRACE::PCB_PARSER::CreateFootprint(), ImportSettingsFrom(), PCB_IO_KICAD_LEGACY::loadSETUP(), DIALOG_FP_EDIT_PAD_TABLE::OnCellChanged(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), DIALOG_FP_EDIT_PAD_TABLE::setPadFromGridCell(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PAD_INFO_FORMATTER::UpdatePad().

◆ SetDrillSizeX()

void PAD::SetDrillSizeX ( int aX )

Definition at line 807 of file pad.cpp.

References SetPrimaryDrillSizeX().

Referenced by PAD_DESC::PAD_DESC(), and playground_main_func().

◆ SetDrillSizeY()

void PAD::SetDrillSizeY ( int aY )

Definition at line 821 of file pad.cpp.

References SetPrimaryDrillSizeY().

Referenced by PAD_DESC::PAD_DESC(), and playground_main_func().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 158 of file eda_item.h.

References m_flags.

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

◆ SetFPRelativeOrientation()

void PAD::SetFPRelativeOrientation ( const EDA_ANGLE & aAngle )

Definition at line 1744 of file pad.cpp.

References BOARD_ITEM::GetParentFootprint(), m_libOrientation, m_padStack, and SetDirty().

Referenced by Flip().

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 446 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().

◆ SetFrontPostMachining()

void PAD::SetFrontPostMachining ( const std::optional< PAD_DRILL_POST_MACHINING_MODE > & aMode )

inline

Definition at line 441 of file pad.h.

References m_padStack.

◆ SetFrontPostMachiningAngle()

void PAD::SetFrontPostMachiningAngle ( int aAngle )

inline

Definition at line 458 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC(), and BACKDRILL_TEST_FIXTURE::SetPadPostMachining().

◆ SetFrontPostMachiningDepth()

void PAD::SetFrontPostMachiningDepth ( int aDepth )

inline

Definition at line 456 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC(), and BACKDRILL_TEST_FIXTURE::SetPadPostMachining().

◆ SetFrontPostMachiningMode()

void PAD::SetFrontPostMachiningMode ( PAD_DRILL_POST_MACHINING_MODE aMode )

inline

Definition at line 444 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC(), and BACKDRILL_TEST_FIXTURE::SetPadPostMachining().

◆ SetFrontPostMachiningSize()

void PAD::SetFrontPostMachiningSize ( int aSize )

inline

Definition at line 454 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC(), and BACKDRILL_TEST_FIXTURE::SetPadPostMachining().

◆ SetFrontRoundRectRadiusRatio()

void PAD::SetFrontRoundRectRadiusRatio ( double aRadiusScale )

Definition at line 1202 of file pad.cpp.

References F_Cu, m_padStack, PADSTACK::NORMAL, and SetDirty().

Referenced by PAD_DESC::PAD_DESC(), and SetFrontRoundRectRadiusSize().

◆ SetFrontRoundRectRadiusSize()

void PAD::SetFrontRoundRectRadiusSize ( int aRadius )

Definition at line 1212 of file pad.cpp.

References F_Cu, GetSize(), minSize, SetFrontRoundRectRadiusRatio(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PAD_DESC::PAD_DESC().

◆ SetFrontShape()

void PAD::SetFrontShape ( PAD_SHAPE aShape )

Definition at line 1705 of file pad.cpp.

References F_Cu, PAD_UTILS::GetDefaultIpcRoundingRatio(), m_padStack, PAD_UTILS::PadHasMeaningfulRoundingRadius(), and SetDirty().

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

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

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

◆ SetKeepTopBottom()

void PAD::SetKeepTopBottom ( bool aSet )

inline

Deprecated

use Padstack().SetUnconnectedLayerMode() Sets whether we keep the start and end annular rings even if they are not connected

Definition at line 883 of file pad.h.

References m_padStack, REMOVE_ALL, and REMOVE_EXCEPT_START_AND_END.

◆ SetLayer()

void BOARD_CONNECTED_ITEM::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtualinherited

Set the layer this item is on.

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_SHAPE, PCB_VIA, and ZONE.

Definition at line 47 of file board_connected_item.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::GetBoard(), EDA_ITEM::GetFlags(), EDA_ITEM::m_Uuid, ROUTER_TRANSIENT, and BOARD_ITEM::SetLayer().

◆ SetLayerSet()

void PAD::SetLayerSet ( const LSET & aLayers )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 1968 of file pad.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::GetBoard(), EDA_ITEM::GetFlags(), BOARD_ITEM::m_layer, m_padStack, EDA_ITEM::m_Uuid, ROUTER_TRANSIENT, LSET::Seq(), SetDirty(), and UNDEFINED_LAYER.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), buildCoincidentFootprint(), DIPTRACE::PCB_PARSER::CreateFootprint(), Flip(), ImportSettingsFrom(), ALTIUM_PCB::ParseFootprint(), SetPadTypeFromString(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetLibDrillSize()

void PAD::SetLibDrillSize ( const VECTOR2I & aSize )

Definition at line 284 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetLibOffset()

void PAD::SetLibOffset	(	PCB_LAYER_ID	aLayer,
		const VECTOR2I &	aOffset )

Definition at line 291 of file pad.cpp.

References m_padStack, and SetDirty().

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parsePadstack().

◆ SetLibSize()

void PAD::SetLibSize	(	PCB_LAYER_ID	aLayer,
		const VECTOR2I &	aSize )

Definition at line 277 of file pad.cpp.

References m_padStack, and SetDirty().

Referenced by ImportSettingsFrom(), and PCB_IO_KICAD_SEXPR_PARSER::parsePadstack().

◆ SetLocalClearance()

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

inline

Definition at line 584 of file pad.h.

References m_padStack.

Referenced by Deserialize(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetLocalRatsnestVisible()

void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible ( bool aVisible )

inlineinherited

Definition at line 208 of file board_connected_item.h.

References m_localRatsnestVisible.

Referenced by BOARD::ExchangeFootprint().

◆ SetLocalSolderMaskMargin()

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

inline

Definition at line 587 of file pad.h.

References B_Mask, F_Mask, and m_padStack.

Referenced by BOOST_FIXTURE_TEST_CASE(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), ALTIUM_PCB::ParseFootprint(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PCB_IO_EAGLE::transferPad().

◆ SetLocalSolderPasteMargin()

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

inline

Definition at line 594 of file pad.h.

References B_Paste, F_Paste, and m_padStack.

Referenced by ImportSettingsFrom(), PAD_DESC::PAD_DESC(), ALTIUM_PCB::ParseFootprint(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetLocalSolderPasteMarginRatio()

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

inline

Definition at line 604 of file pad.h.

References B_Paste, F_Paste, and m_padStack.

Referenced by ImportSettingsFrom(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetLocalThermalGapOverride()

void PAD::SetLocalThermalGapOverride ( const std::optional< int > & aOverride )

inline

Definition at line 781 of file pad.h.

References m_padStack.

Referenced by ImportSettingsFrom(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetLocalThermalSpokeWidthOverride()

void PAD::SetLocalThermalSpokeWidthOverride ( std::optional< int > aWidth )

inline

Set the width of the thermal spokes connecting the pad to a zone.

If != 0 this will override similar settings in the parent footprint and zone.

Definition at line 737 of file pad.h.

References m_padStack.

Referenced by ImportSettingsFrom(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetLocalZoneConnection()

void PAD::SetLocalZoneConnection ( ZONE_CONNECTION aType )

inline

Definition at line 610 of file pad.h.

References m_padStack.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ImportSettingsFrom(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PCB_IO_EAGLE::transferPad().

◆ SetLocked()

void BOARD_ITEM::SetLocked ( bool aLocked )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, and PCB_GROUP.

Definition at line 418 of file board_item.h.

References m_isLocked.

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

◆ SetNet()

virtual void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM * aNetInfo )

inlinevirtualinherited

Set a NET_INFO object for the item.

Subclasses with a netless invariant (e.g. ZONE in copper-thieving mode) override this to drop aNetInfo before storing it. Direct callers of SetNet bypass the SetNetCode clamp, so this hook is essential.

Reimplemented in ZONE.

Definition at line 93 of file board_connected_item.h.

References m_netinfo.

◆ SetNetCode() [1/2]

void BOARD_CONNECTED_ITEM::SetNetCode ( int aNetCode )

inlineinherited

Definition at line 128 of file board_connected_item.h.

References SetNetCode().

◆ SetNetCode() [2/2]

bool BOARD_CONNECTED_ITEM::SetNetCode	(	int	aNetCode,
		bool	aNoAssert )

virtualinherited

Set net using a net code.

Subclasses that enforce a netless invariant (e.g. ZONE in copper-thieving mode) override this to clamp aNetCode before it reaches the base routine. The non-virtual overload below routes through this one, so callers that reach the setter via a BOARD_CONNECTED_ITEM* still hit the clamp.

Note: Pads not on copper layers will have their net code always set to 0 (not connected).

Parameters

aNetCode	is a net code for the new net. It has to exist in NETINFO_LIST held by BOARD.
aNoAssert	if true, do not assert that the net exists. Otherwise, item is assigned to the unconnected net.

Returns: true on success, false if the net did not exist

Reimplemented in ZONE.

Definition at line 85 of file board_connected_item.cpp.

References BOARD_ITEM::BOARD, BOARD::FindNet(), BOARD_ITEM::GetBoard(), EDA_ITEM::GetFlags(), BOARD::InvalidateClearanceCache(), BOARD_ITEM::IsOnCopperLayer(), m_netinfo, EDA_ITEM::m_Uuid, NETINFO_LIST::OrphanedItem(), and ROUTER_TRANSIENT.

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

◆ SetNumber()

void PAD::SetNumber ( const wxString & aNumber )

inline

Set the pad number (note that it can be alphanumeric, such as the array reference "AA12").

Definition at line 142 of file pad.h.

References m_number.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), DIPTRACE::PCB_PARSER::CreateFootprint(), Deserialize(), ImportSettingsFrom(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), CADSTAR_PCB_ARCHIVE_LOADER::loadLibraryCoppers(), DIALOG_FP_EDIT_PAD_TABLE::OnUpdateUI(), operator=(), PAD_DESC::PAD_DESC(), DIALOG_FP_EDIT_PAD_TABLE::restorePadFromSnapshot(), DIALOG_FP_EDIT_PAD_TABLE::setPadFromGridCell(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PCB_IO_EAGLE::transferPad(), and PAD_INFO_FORMATTER::UpdatePad().

◆ SetOffset()

void PAD::SetOffset	(	PCB_LAYER_ID	aLayer,
		const VECTOR2I &	aOffset )

Definition at line 827 of file pad.cpp.

References GetFPRelativeOrientation(), BOARD_ITEM::GetParentFootprint(), m_padStack, and SetDirty().

Referenced by PCB_IO_PADS_BINARY::applyPadShape(), ZONE_FILLER::buildThermalSpokes(), mirrorPad(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetOrientation()

void PAD::SetOrientation ( const EDA_ANGLE & aAngle )

Set the rotation angle of the pad.

If aAngle is outside of 0 - 360, then it will be normalized.

Definition at line 1732 of file pad.cpp.

References BOARD_ITEM::GetParentFootprint(), m_libOrientation, m_padStack, and SetDirty().

Referenced by ZONE_FILLER::buildThermalSpokes(), Deserialize(), ImportSettingsFrom(), mirrorPad(), Rotate(), SetOrientationDegrees(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetOrientationDegrees()

void PAD::SetOrientationDegrees ( double aOrientation )

inline

Definition at line 424 of file pad.h.

References DEGREES_T, and SetOrientation().

Referenced by PAD_DESC::PAD_DESC().

◆ SetPadstack()

void PAD::SetPadstack ( const PADSTACK & aPadstack )

inline

Definition at line 333 of file pad.h.

References m_padStack.

Referenced by ImportSettingsFrom(), and DIALOG_FP_EDIT_PAD_TABLE::restorePadFromSnapshot().

◆ SetPadstackMode()

void PAD::SetPadstackMode ( PADSTACK::MODE aMode )

inline

Definition at line 190 of file pad.h.

References m_padStack.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), buildCoincidentFootprint(), DIPTRACE::PCB_PARSER::CreateFootprint(), and PCB_IO_KICAD_LEGACY::loadSETUP().

◆ SetPadToDieDelay()

void PAD::SetPadToDieDelay ( int aDelay )

inline

Definition at line 580 of file pad.h.

References m_delayPadToDie.

Referenced by Deserialize(), ImportSettingsFrom(), operator=(), PAD_DESC::PAD_DESC(), DIALOG_FP_EDIT_PAD_TABLE::restorePadFromSnapshot(), DIALOG_FP_EDIT_PAD_TABLE::setPadFromGridCell(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PAD_INFO_FORMATTER::UpdatePad().

◆ SetPadToDieLength()

void PAD::SetPadToDieLength ( int aLength )

inline

Definition at line 577 of file pad.h.

References m_lengthPadToDie.

Referenced by BOOST_AUTO_TEST_CASE(), Deserialize(), ImportSettingsFrom(), operator=(), PAD_DESC::PAD_DESC(), DIALOG_FP_EDIT_PAD_TABLE::restorePadFromSnapshot(), DIALOG_FP_EDIT_PAD_TABLE::setPadFromGridCell(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PAD_INFO_FORMATTER::UpdatePad().

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

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

◆ SetPinFunction()

void PAD::SetPinFunction ( const wxString & aName )

inline

Set the pad function (pin name in schematic)

Definition at line 153 of file pad.h.

References m_pinFunction.

Referenced by BOARD::ExchangeFootprint(), operator=(), and PAD_DESC::PAD_DESC().

◆ SetPinType()

void PAD::SetPinType ( const wxString & aType )

inline

Set the pad electrical type.

Definition at line 159 of file pad.h.

References m_pinType.

Referenced by BOARD::ExchangeFootprint(), operator=(), and PAD_DESC::PAD_DESC().

◆ SetPosition()

void PAD::SetPosition ( const VECTOR2I & aPos )

overridevirtual

◆ SetPrimaryDrillCapped()

void PAD::SetPrimaryDrillCapped ( const std::optional< bool > & aCapped )

Definition at line 1062 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetPrimaryDrillCappedFlag()

void PAD::SetPrimaryDrillCappedFlag ( bool aCapped )

Definition at line 1069 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetPrimaryDrillEndLayer()

void PAD::SetPrimaryDrillEndLayer ( PCB_LAYER_ID aLayer )

Definition at line 866 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetPrimaryDrillFilled()

void PAD::SetPrimaryDrillFilled ( const std::optional< bool > & aFilled )

Definition at line 1048 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetPrimaryDrillFilledFlag()

void PAD::SetPrimaryDrillFilledFlag ( bool aFilled )

Definition at line 1055 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetPrimaryDrillShape()

void PAD::SetPrimaryDrillShape ( PAD_DRILL_SHAPE aShape )

Definition at line 847 of file pad.cpp.

References CIRCLE, m_padStack, m_shapesDirty, and SetDirty().

Referenced by SetDrillShape().

◆ SetPrimaryDrillSize()

void PAD::SetPrimaryDrillSize ( const VECTOR2I & aSize )

Definition at line 773 of file pad.cpp.

References GetFPRelativeOrientation(), BOARD_ITEM::GetParentFootprint(), GetPrimaryDrillShape(), m_padStack, and SetDirty().

Referenced by SetDrillSize(), SetPrimaryDrillSizeX(), and SetPrimaryDrillSizeY().

◆ SetPrimaryDrillSizeX()

void PAD::SetPrimaryDrillSizeX ( int aX )

Definition at line 795 of file pad.cpp.

References CIRCLE, GetPrimaryDrillShape(), GetPrimaryDrillSize(), SetPrimaryDrillSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SetDrillSizeX().

◆ SetPrimaryDrillSizeY()

void PAD::SetPrimaryDrillSizeY ( int aY )

Definition at line 813 of file pad.cpp.

References GetPrimaryDrillSize(), SetPrimaryDrillSize(), and VECTOR2< T >::y.

Referenced by SetDrillSizeY().

◆ SetPrimaryDrillStartLayer()

void PAD::SetPrimaryDrillStartLayer ( PCB_LAYER_ID aLayer )

Definition at line 859 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetProperty()

void PAD::SetProperty ( PAD_PROP aProperty )

Definition at line 1724 of file pad.cpp.

References m_property, and SetDirty().

Referenced by Deserialize(), ImportSettingsFrom(), PAD(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetRemoveUnconnected()

void PAD::SetRemoveUnconnected ( bool aSet )

inline

Deprecated

use Padstack().SetUnconnectedLayerMode() Sets the unconnected removal property. If true, the copper is removed on zone fill or when specifically requested when the via is not connected on a layer.

Definition at line 868 of file pad.h.

References KEEP_ALL, m_padStack, and REMOVE_ALL.

◆ SetRoundRectCornerRadius()

void PAD::SetRoundRectCornerRadius	(	PCB_LAYER_ID	aLayer,
		double	aRadius )

Definition at line 1188 of file pad.cpp.

References m_padStack.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyPadShape(), and PAD_LAYER_GEOMETRY::ResolvePadLayer.

◆ SetRoundRectRadiusRatio()

void PAD::SetRoundRectRadiusRatio	(	PCB_LAYER_ID	aLayer,
		double	aRadiusScale )

Has meaning only for rounded rectangle pads.

Set the ratio between the smaller X or Y size and the rounded corner radius. Cannot be > 0.5; the normalized IPC-7351C value is 0.25

Definition at line 1194 of file pad.cpp.

References m_padStack, and SetDirty().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyPadShape(), PCB_IO_PADS_BINARY::applyPadShape(), PCB_IO_KICAD_SEXPR_PARSER::parsePadstack(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetSecondaryDrillEndLayer()

void PAD::SetSecondaryDrillEndLayer ( PCB_LAYER_ID aLayer )

Definition at line 1122 of file pad.cpp.

References m_padStack, and SetDirty().

Referenced by BACKDRILL_TEST_FIXTURE::SetPadBackdrill().

◆ SetSecondaryDrillShape()

void PAD::SetSecondaryDrillShape ( PAD_DRILL_SHAPE aShape )

Definition at line 1108 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetSecondaryDrillSize()

void PAD::SetSecondaryDrillSize ( const VECTOR2I & aSize )

Definition at line 1076 of file pad.cpp.

References m_padStack, and SetDirty().

Referenced by BACKDRILL_TEST_FIXTURE::SetPadBackdrill().

◆ SetSecondaryDrillSizeX()

void PAD::SetSecondaryDrillSizeX ( int aX )

Definition at line 1083 of file pad.cpp.

References CIRCLE, GetSecondaryDrillShape(), m_padStack, and SetDirty().

◆ SetSecondaryDrillSizeY()

void PAD::SetSecondaryDrillSizeY ( int aY )

Definition at line 1094 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetSecondaryDrillStartLayer()

void PAD::SetSecondaryDrillStartLayer ( PCB_LAYER_ID aLayer )

Definition at line 1115 of file pad.cpp.

References m_padStack, and SetDirty().

Referenced by BACKDRILL_TEST_FIXTURE::SetPadBackdrill().

◆ 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::PlaceSubGrid(), DS_PROXY_UNDO_ITEM::Restore(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SCH_COMMIT::Stage().

◆ SetShape()

void PAD::SetShape	(	PCB_LAYER_ID	aLayer,
		PAD_SHAPE	aShape )

inline

Set the new shape of this pad.

Definition at line 196 of file pad.h.

References m_padStack, and SetDirty().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyPadShape(), PCB_IO_PADS_BINARY::applyPadShape(), BOOST_AUTO_TEST_CASE(), DIPTRACE::PCB_PARSER::CreateFootprint(), PAD_TOOL::explodePad(), PAD(), ALTIUM_PCB::ParseFootprint(), PCB_IO_KICAD_SEXPR_PARSER::parsePadstack(), Recombine(), PAD_LAYER_GEOMETRY::ResolvePadLayer, DIALOG_FP_EDIT_PAD_TABLE::setPadFromGridCell(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PAD_INFO_FORMATTER::UpdatePad().

◆ SetSimElectricalType()

void PAD::SetSimElectricalType ( PAD_SIM_ELECTRICAL_TYPE aType )

inline

Definition at line 572 of file pad.h.

References m_simElectricalType.

Referenced by Deserialize(), operator=(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetSize()

void PAD::SetSize	(	PCB_LAYER_ID	aLayer,
		const VECTOR2I &	aSize )

◆ SetSizeX()

void PAD::SetSizeX ( int aX )

Definition at line 308 of file pad.cpp.

References PADSTACK::ALL_LAYERS, CIRCLE, GetShape(), GetSize(), SetSize(), and VECTOR2< T >::y.

Referenced by PAD_DESC::PAD_DESC(), and playground_main_func().

◆ SetSizeY()

void PAD::SetSizeY ( int aY )

Definition at line 328 of file pad.cpp.

References PADSTACK::ALL_LAYERS, CIRCLE, GetShape(), GetSize(), SetSize(), and VECTOR2< T >::x.

Referenced by PAD_DESC::PAD_DESC(), and playground_main_func().

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

◆ SetSubRatsnest()

void PAD::SetSubRatsnest ( int aSubRatsnest )

inline

Definition at line 861 of file pad.h.

References m_subRatsnest.

Referenced by operator=(), and PAD().

◆ SetTeardropAllowSpanTwoTracks()

void BOARD_CONNECTED_ITEM::SetTeardropAllowSpanTwoTracks ( bool aAllow )

inlineinherited

Definition at line 235 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropBestLengthRatio()

void BOARD_CONNECTED_ITEM::SetTeardropBestLengthRatio ( double aRatio )

inlineinherited

Definition at line 217 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropBestWidthRatio()

void BOARD_CONNECTED_ITEM::SetTeardropBestWidthRatio ( double aRatio )

inlineinherited

Definition at line 223 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropCurved()

void BOARD_CONNECTED_ITEM::SetTeardropCurved ( bool aCurve )

inlineinherited

Definition at line 229 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxLength()

void BOARD_CONNECTED_ITEM::SetTeardropMaxLength ( int aMaxLength )

inlineinherited

Definition at line 220 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxTrackWidth()

void BOARD_CONNECTED_ITEM::SetTeardropMaxTrackWidth ( double aRatio )

inlineinherited

Definition at line 238 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxWidth()

void BOARD_CONNECTED_ITEM::SetTeardropMaxWidth ( int aMaxWidth )

inlineinherited

Definition at line 226 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropPreferZoneConnections()

void BOARD_CONNECTED_ITEM::SetTeardropPreferZoneConnections ( bool aPrefer )

inlineinherited

Definition at line 232 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropsEnabled()

void BOARD_CONNECTED_ITEM::SetTeardropsEnabled ( bool aEnable )

inlineinherited

Definition at line 214 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), PAD::Deserialize(), and PCB_VIA::Deserialize().

◆ SetTertiaryDrillEndLayer()

void PAD::SetTertiaryDrillEndLayer ( PCB_LAYER_ID aLayer )

Definition at line 1175 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetTertiaryDrillShape()

void PAD::SetTertiaryDrillShape ( PAD_DRILL_SHAPE aShape )

Definition at line 1161 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetTertiaryDrillSize()

void PAD::SetTertiaryDrillSize ( const VECTOR2I & aSize )

Definition at line 1129 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetTertiaryDrillSizeX()

void PAD::SetTertiaryDrillSizeX ( int aX )

Definition at line 1136 of file pad.cpp.

References CIRCLE, GetTertiaryDrillShape(), m_padStack, and SetDirty().

◆ SetTertiaryDrillSizeY()

void PAD::SetTertiaryDrillSizeY ( int aY )

Definition at line 1147 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetTertiaryDrillStartLayer()

void PAD::SetTertiaryDrillStartLayer ( PCB_LAYER_ID aLayer )

Definition at line 1168 of file pad.cpp.

References m_padStack, and SetDirty().

◆ SetThermalGap()

void PAD::SetThermalGap ( int aGap )

inline

Definition at line 772 of file pad.h.

References m_padStack.

◆ SetThermalSpokeAngle()

void PAD::SetThermalSpokeAngle ( const EDA_ANGLE & aAngle )

inline

The orientation of the thermal spokes.

45° will produce an X (the default for circular pads and circular-anchored custom shaped pads), while 90° will produce a + (the default for all other shapes).

Definition at line 753 of file pad.h.

References m_padStack.

Referenced by ImportSettingsFrom(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetThermalSpokeAngleDegrees()

void PAD::SetThermalSpokeAngleDegrees ( double aAngle )

inline

Definition at line 763 of file pad.h.

References DEGREES_T, and m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ SetTopBackdrillLayer()

void PAD::SetTopBackdrillLayer ( PCB_LAYER_ID aLayer )

inline

Definition at line 1075 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ SetTopBackdrillSize()

void PAD::SetTopBackdrillSize ( std::optional< int > aSize )

inline

Definition at line 1072 of file pad.h.

References m_padStack.

Referenced by PAD_DESC::PAD_DESC().

◆ SetUnconnectedLayerMode()

void PAD::SetUnconnectedLayerMode ( UNCONNECTED_LAYER_MODE aMode )

inline

Definition at line 894 of file pad.h.

References m_padStack.

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

◆ 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(), 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.

◆ SetX()

void PAD::SetX ( int x )

inline

Definition at line 269 of file pad.h.

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

Referenced by MICROWAVE_TOOL::createPolygonShape(), and playground_main_func().

◆ SetY()

void PAD::SetY ( int y )

inline

Definition at line 262 of file pad.h.

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

Referenced by playground_main_func().

◆ SetZoneLayerOverride()

void PAD::SetZoneLayerOverride	(	PCB_LAYER_ID	aLayer,
		ZONE_LAYER_OVERRIDE	aOverride )

Definition at line 527 of file pad.cpp.

References m_dataMutex, and m_zoneLayerOverrides.

◆ ShapePos()

VECTOR2I PAD::ShapePos ( PCB_LAYER_ID aLayer ) const

◆ SharesNetTieGroup()

bool PAD::SharesNetTieGroup ( const PAD * aOther ) const

Returns: true if this and

Parameters

aOther represent a net-tie.

Definition at line 587 of file pad.cpp.

References GetNumber(), BOARD_ITEM::GetParentFootprint(), FOOTPRINT::IsNetTie(), FOOTPRINT::MapPadNumbersToNetTieGroups(), and PAD().

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::maskApertureBridgeExcluded().

◆ ShowLegacyPadShape()

wxString PAD::ShowLegacyPadShape ( PCB_LAYER_ID aLayer ) const

An older version still used by place file writer.

Definition at line 2581 of file pad.cpp.

References _, CHAMFERED_RECT, CIRCLE, CUSTOM, GetShape(), OVAL, RECTANGLE, ROUNDRECT, and TRAPEZOID.

◆ ShowPadAttr()

wxString PAD::ShowPadAttr ( ) const

Returns: the GUI-appropriate description of the pad type (attribute) : Std, SMD ...

Definition at line 2597 of file pad.cpp.

References _, CONN, GetAttribute(), NPTH, PTH, and SMD.

Referenced by GetMsgPanelInfo().

◆ ShowPadShape() [1/2]

wxString PAD::ShowPadShape ( PAD_SHAPE aShape )

static

Returns: the GUI-appropriate name of the shape.

Definition at line 2559 of file pad.cpp.

References _, CHAMFERED_RECT, CIRCLE, CUSTOM, OVAL, RECTANGLE, ROUNDRECT, and TRAPEZOID.

Referenced by DIALOG_FP_EDIT_PAD_TABLE::DIALOG_FP_EDIT_PAD_TABLE(), DIALOG_FP_EDIT_PAD_TABLE::fillGridRow(), GetMsgPanelInfo(), BRDITEMS_PLOTTER::PlotPad(), ShowPadShape(), DIALOG_FP_EDIT_PAD_TABLE::TransferDataToWindow(), PCB_CONTROL::UpdateMessagePanel(), and GENCAD_EXPORTER::writePadShape().

◆ ShowPadShape() [2/2]

wxString PAD::ShowPadShape ( PCB_LAYER_ID aLayer ) const

Definition at line 2575 of file pad.cpp.

References GetShape(), and ShowPadShape().

◆ Similarity()

double PAD::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 3621 of file pad.cpp.

References BOARD_ITEM::BOARD_ITEM(), GetAttribute(), BOARD_ITEM::GetParent(), GetPosition(), EDA_ITEM::m_parent, EDA_ITEM::m_Uuid, PAD(), Padstack(), PADSTACK::Similarity(), and EDA_ITEM::Type().

◆ SMDMask()

LSET PAD::SMDMask ( )

static

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

References EDA_ITEM().

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

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ swapData()

void PAD::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtual

Reimplemented from BOARD_ITEM.

Definition at line 3005 of file pad.cpp.

References BOARD_ITEM::BOARD_ITEM(), PAD(), PCB_PAD_T, 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::RevertToCheckpoint().

◆ SwapShapePositions()

void PAD::SwapShapePositions	(	PAD *	aLhs,
		PAD *	aRhs )

static

Swap the visible shape positions of two pads, preserving each pad's own shape offset.

Using SetPosition() directly would swap anchor (hole) positions, which leaves each pad's copper shape displaced by its own offset after the swap. This helper computes the new anchor for each pad so the visible shape centers (ShapePos) are exchanged.

Definition at line 1882 of file pad.cpp.

References PADSTACK::ALL_LAYERS, GetOffset(), GetOrientation(), PAD(), RotatePoint(), SetPosition(), and ShapePos().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and EDIT_TOOL::Swap().

◆ TransformHoleToPolygon()

bool PAD::TransformHoleToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc = ERROR_INSIDE ) const

Build the corner list of the polygonal drill shape in the board coordinate system.

Parameters

aBuffer	a buffer to fill.
aClearance	the clearance or margin value.
aError	maximum deviation of an arc from the polygon approximation.
aErrorLoc	= should the approximation error be placed outside or inside the polygon?

Returns: false if the pad has no hole, true otherwise.

Definition at line 3013 of file pad.cpp.

References GetDrillSize(), GetEffectiveHoleShape(), TransformOvalToPolygon(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ZONE_FILLER::addHoleKnockout(), PCB_IO_IPC2581::addSlotCavity(), and playground_main_func().

◆ TransformShapeToPolygon()

void PAD::TransformShapeToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aMaxError,
		ERROR_LOC	aErrorLoc = ERROR_INSIDE,
		bool	aIgnoreLineWidth = false ) const

overridevirtual

Convert the pad shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

aBuffer	a buffer to store the polygon.
aLayer	is the layer ID of the pad.
aClearance	the clearance around the pad.
aMaxError	maximum error from true when converting arcs.
aErrorLoc	should the approximation error be placed outside or inside the polygon?
aIgnoreLineWidth	used for edge cuts where the line width is only for visualization.

Reimplemented from BOARD_ITEM.

Definition at line 3046 of file pad.cpp.

References ALLOW_ACUTE_CORNERS, SHAPE_POLY_SET::Append(), CHAMFERED_RECT, CIRCLE, CUSTOM, delta, ERROR_OUTSIDE, SHAPE_POLY_SET::Fracture(), GetChamferPositions(), GetChamferRectRatio(), GetOrientation(), GetRoundRectCornerRadius(), GetShape(), GetSize(), SHAPE_POLY_SET::Inflate(), m_padStack, MergePrimitivesAsPolygon(), SHAPE_POLY_SET::Move(), OVAL, RECTANGLE, SHAPE_POLY_SET::Rotate(), RotatePoint(), ROUND_ALL_CORNERS, ROUNDRECT, ShapePos(), TransformCircleToPolygon(), TransformOvalToPolygon(), TransformRoundChamferedRectToPolygon(), TransformTrapezoidToPolygon(), TRAPEZOID, UNDEFINED_LAYER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by STEP_PCB_MODEL::AddPadShape(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BuildEffectivePolygon(), BOARD_ADAPTER::createPadWithMargin(), doCheckPad(), KIGFX::PCB_PAINTER::draw(), GetCoverageArea(), ALTIUM_PCB::ParseFootprint(), playground_main_func(), BRDITEMS_PLOTTER::PlotPad(), and Recombine().

◆ 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.
aLayer	is the layer of the shape to transform.
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 546 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.

◆ UnpackNet()

void BOARD_CONNECTED_ITEM::UnpackNet ( const kiapi::board::types::Net & aProto )

inherited

Assigns a net to this item from an API message.

If the net does not yet exist, it will be created.

Parameters

aProto is the protobuf message to unpack a net from

Definition at line 59 of file board_connected_item.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::GetBoard(), name, and SetNet().

Referenced by PAD::Deserialize(), PCB_ARC::Deserialize(), PCB_SHAPE::Deserialize(), PCB_TRACK::Deserialize(), PCB_VIA::Deserialize(), and ZONE::Deserialize().

◆ UnplatedHoleMask()

LSET PAD::UnplatedHoleMask ( )

static

layer set for a mechanical unplated through hole pad

Definition at line 637 of file pad.cpp.

References B_Cu, B_Mask, F_Cu, and F_Mask.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_IO_PADS_BINARY::buildPad(), ALLEGRO::BOARD_BUILDER::buildPadItems(), ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper(), DIPTRACE::PCB_PARSER::CreateFootprint(), FABMASTER::loadFootprints(), PCB_IO_PADS::loadFootprints(), PAD_FIXTURE::MakeNPTH(), PAD_FIXTURE::MakePTH(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), and DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ ViewBBox()

const BOX2I PAD::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 2892 of file pad.cpp.

References clearance, BOARD::ExpandBoundingBoxForDrillSymbols(), PADSTACK::ForEachUniqueLayer(), BOARD_ITEM::GetBoard(), GetBoundingBox(), BOARD::GetMaxClearanceValue(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetSize(), GetSolderMaskExpansion(), GetSolderPasteMargin(), HasHole(), Kiface(), Padstack(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE().

◆ 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 KIGFX::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 > PAD::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 2716 of file pad.cpp.

References LSET::AllCuMask(), B_Adhes, B_Cu, B_Mask, B_Paste, B_SilkS, BOARD_ITEM::BOARD, DRILL_SYMBOL_LAYER_FOR, Dwgs_User, Eco1_User, Eco2_User, F_Adhes, F_Cu, F_Mask, F_Paste, F_SilkS, BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParentFootprint(), IsLocked(), IsOnLayer(), LAYER_CLEARANCE_START, LAYER_LOCKED_ITEM_SHADOW, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK_NETNAMES, LAYER_PAD_COPPER_START, LAYER_PAD_FR_NETNAMES, LAYER_PAD_HOLEWALLS, LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, m_attribute, m_padStack, NPTH, PTH, and LSET::Seq().

◆ ViewGetLOD()

double PAD::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 2811 of file pad.cpp.

References LSET::BackMask(), BOARD_ITEM::BOARD, FlashLayer(), LSET::FrontMask(), BOARD_ITEM::GetBoard(), GetBoundingBox(), KIGFX::RENDER_SETTINGS::GetHighContrast(), GetLayerSet(), KIGFX::VIEW::GetPainter(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), KIGFX::PCB_PAINTER::GetSettings(), BOX2< Vec >::GetSize(), IsDrillSymbolLayer(), IsHoleLayer(), KIGFX::VIEW::IsLayerVisible(), KIGFX::VIEW::IsLayerVisibleCached(), IsNetnameLayer(), LAYER_DRILL_SYMBOL_START, LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, LAYER_PADS, KIGFX::VIEW_ITEM::LOD_HIDE, KIGFX::VIEW_ITEM::LOD_SHOW, KIGFX::VIEW_ITEM::lodScaleForThreshold(), minSize, pcbIUScale, LSET::PhysicalLayersMask(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

◆ Visit()

INSPECT_RESULT EDA_ITEM::Visit	(	INSPECTOR	aInspector,
		void *	aTestData,
		const std::vector< KICAD_T > &	aScanTypes )

virtualinherited

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

aInspector	An INSPECTOR instance to use in the inspection.
aTestData	Arbitrary data used by the inspector.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

Returns: INSPECT_RESULT INSPECT_RESULT::QUIT if the Iterator is to stop the scan, else INSPECT_RESULT::CONTINUE, and determined by the inspector.

Reimplemented in BOARD, FOOTPRINT, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, LIB_SYMBOL, PCB_GENERATED_TABLE, PCB_GROUP, PCB_TABLE, PCB_TRACK, SCH_GROUP, SCH_LABEL_BASE, SCH_SHEET, SCH_SYMBOL, and SCH_TABLE.

Definition at line 287 of file eda_item.cpp.

References CONTINUE, KIGFX::VIEW_ITEM::GetClass(), IsType(), and QUIT.

Referenced by GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), IterateForward(), IterateForward(), and BOARD::UpdateUserUnits().

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

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_attribute

PAD_ATTRIB PAD::m_attribute = PAD_ATTRIB::PTH

private

Definition at line 1133 of file pad.h.

Referenced by Compare(), GetAttribute(), GetPrincipalLayer(), IsType(), PAD(), SetAttribute(), and ViewGetLayers().

◆ m_boardCacheOwner

BOARD* BOARD_ITEM::m_boardCacheOwner = nullptr

mutableprotectedinherited

Definition at line 591 of file board_item.h.

Referenced by BOARD::CacheAndReturnItemById(), BOARD::CacheItemById(), BOARD::ClearItemByIdCache(), IsIndexedInBoard(), SetUuid(), BOARD::UncacheItemById(), BOARD::UncacheItemByPtr(), and ~BOARD_ITEM().

◆ m_customProperties

std::map<wxString, wxString> EDA_ITEM::m_customProperties

protectedinherited

◆ m_dataMutex

std::mutex PAD::m_dataMutex

mutableprivate

Definition at line 1124 of file pad.h.

Referenced by BuildEffectivePolygon(), BuildEffectiveShapes(), ClearZoneLayerOverrides(), Deserialize(), GetZoneLayerOverride(), Serialize(), and SetZoneLayerOverride().

◆ m_delayPadToDie

int PAD::m_delayPadToDie

private

Definition at line 1138 of file pad.h.

Referenced by GetPadToDieDelay(), PAD(), and SetPadToDieDelay().

◆ m_drawCache

std::unique_ptr<PAD_DRAW_CACHE_DATA> PAD::m_drawCache

mutableprivate

Definition at line 1126 of file pad.h.

Referenced by getDrawCache().

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

Referenced by GetCustomPropertiesAsInspectables(), and RemoveCustomProperty().

◆ m_effectiveBoundingRadius

int PAD::m_effectiveBoundingRadius

mutableprivate

Definition at line 1128 of file pad.h.

Referenced by BuildEffectivePolygon(), GetBoundingRadius(), operator=(), and PAD().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 608 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_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 614 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_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

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

Definition at line 610 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), GetParentGroup(), operator=(), SCH_LINE::SCH_LINE(), and SetParentGroup().

◆ 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 587 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 588 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 613 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_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 586 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(), 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_lengthPadToDie

int PAD::m_lengthPadToDie

private

Definition at line 1137 of file pad.h.

Referenced by GetPadToDieLength(), PAD(), and SetPadToDieLength().

◆ m_libOrientation

EDA_ORIENTATION PAD::m_libOrientation

private

Definition at line 1119 of file pad.h.

Referenced by GetFPRelativeOrientation(), GetOrientation(), PAD(), PAD(), SetFPRelativeOrientation(), and SetOrientation().

◆ m_libPos

VECTOR2I PAD::m_libPos

private

Definition at line 1118 of file pad.h.

Referenced by Flip(), GetLibraryPosition(), GetPosition(), and SetPosition().

◆ m_localRatsnestVisible

bool BOARD_CONNECTED_ITEM::m_localRatsnestVisible

privateinherited

Definition at line 250 of file board_connected_item.h.

Referenced by BOARD_CONNECTED_ITEM(), GetLocalRatsnestVisible(), and SetLocalRatsnestVisible().

◆ m_netHighlighted

bool EDA_ITEM::m_netHighlighted = false

protectedinherited

Definition at line 615 of file eda_item.h.

Referenced by ClearFlags(), IsBrightened(), IsNetHighlighted(), operator=(), SetNetHighlighted(), and LIB_SYMBOL::SetParent().

◆ m_netinfo

NETINFO_ITEM* BOARD_CONNECTED_ITEM::m_netinfo

protectedinherited

Store all information about the net that item belongs to.

Definition at line 243 of file board_connected_item.h.

Referenced by BOARD_CONNECTED_ITEM(), GetDisplayNetname(), GetEffectiveNetClass(), GetNet(), GetNetCode(), GetNetname(), GetShortNetname(), ZONE::InitDataFromSrcInCopyCtor(), PCB_SHAPE::operator==(), SetNet(), SetNetCode(), PCB_SHAPE::Similarity(), and PCB_SHAPE::swapData().

◆ m_number

wxString PAD::m_number

private

Definition at line 1114 of file pad.h.

Referenced by GetMsgPanelInfo(), GetNumber(), SameLogicalPadAs(), SetAttribute(), and SetNumber().

◆ m_padStack

PADSTACK PAD::m_padStack

private

Definition at line 1121 of file pad.h.

Referenced by AddPrimitive(), buildEffectiveShape(), BuildEffectiveShapes(), ClearSecondaryDrillSize(), ClearTertiaryDrillSize(), Clone(), ConditionallyFlashed(), DeletePrimitivesList(), Deserialize(), FlashLayer(), Flip(), FlipPrimitives(), GetAnchorPadShape(), GetBackdrillMode(), GetBackPostMachining(), GetBackPostMachiningAngle(), GetBackPostMachiningDepth(), GetBackPostMachiningMode(), GetBackPostMachiningSize(), GetBottomBackdrillLayer(), GetBottomBackdrillSize(), GetChamferPositions(), GetChamferRectRatio(), GetClearanceOverrides(), GetCustomShapeInZoneOpt(), GetDelta(), GetFrontPostMachining(), GetFrontPostMachiningAngle(), GetFrontPostMachiningDepth(), GetFrontPostMachiningMode(), GetFrontPostMachiningSize(), GetFrontRoundRectRadiusRatio(), GetFrontShape(), GetKeepTopBottom(), GetLayerSet(), GetLocalClearance(), GetLocalClearance(), GetLocalSolderMaskMargin(), GetLocalSolderPasteMargin(), GetLocalSolderPasteMarginRatio(), GetLocalSpokeWidthOverride(), GetLocalThermalGapOverride(), GetLocalThermalGapOverride(), GetLocalThermalSpokeWidthOverride(), GetLocalZoneConnection(), GetOffset(), GetPadstackMode(), GetPostMachiningKnockout(), GetPrimaryDrillCapped(), GetPrimaryDrillCappedFlag(), GetPrimaryDrillEndLayer(), GetPrimaryDrillFilled(), GetPrimaryDrillFilledFlag(), GetPrimaryDrillShape(), GetPrimaryDrillSize(), GetPrimaryDrillStartLayer(), GetPrimitives(), GetRemoveUnconnected(), GetRoundRectCornerRadius(), GetRoundRectRadiusRatio(), GetSecondaryDrillEndLayer(), GetSecondaryDrillShape(), GetSecondaryDrillSize(), GetSecondaryDrillSizeX(), GetSecondaryDrillSizeY(), GetSecondaryDrillStartLayer(), GetShape(), GetSize(), GetSolderMaskExpansion(), GetSolderPasteMargin(), GetTertiaryDrillEndLayer(), GetTertiaryDrillShape(), GetTertiaryDrillSize(), GetTertiaryDrillSizeX(), GetTertiaryDrillSizeY(), GetTertiaryDrillStartLayer(), GetThermalGap(), GetThermalSpokeAngle(), GetThermalSpokeAngleDegrees(), GetTopBackdrillLayer(), GetTopBackdrillSize(), GetUnconnectedLayerMode(), GetZoneConnectionOverrides(), HasExplicitDefinitionForLayer(), IsAperturePad(), IsBackdrilledOrPostMachined(), IsOnCopperLayer(), IsOnLayer(), MergePrimitivesAsPolygon(), PAD(), PAD(), Padstack(), Padstack(), Serialize(), SetAnchorPadShape(), SetAttribute(), SetBackdrillMode(), SetBackPostMachining(), SetBackPostMachiningAngle(), SetBackPostMachiningDepth(), SetBackPostMachiningMode(), SetBackPostMachiningSize(), SetBottomBackdrillLayer(), SetBottomBackdrillSize(), SetChamferPositions(), SetChamferRectRatio(), SetCustomShapeInZoneOpt(), SetDelta(), SetFPRelativeOrientation(), SetFrontPostMachining(), SetFrontPostMachiningAngle(), SetFrontPostMachiningDepth(), SetFrontPostMachiningMode(), SetFrontPostMachiningSize(), SetFrontRoundRectRadiusRatio(), SetFrontShape(), SetKeepTopBottom(), SetLayerSet(), SetLibDrillSize(), SetLibOffset(), SetLibSize(), SetLocalClearance(), SetLocalSolderMaskMargin(), SetLocalSolderPasteMargin(), SetLocalSolderPasteMarginRatio(), SetLocalThermalGapOverride(), SetLocalThermalSpokeWidthOverride(), SetLocalZoneConnection(), SetOffset(), SetOrientation(), SetPadstack(), SetPadstackMode(), SetPrimaryDrillCapped(), SetPrimaryDrillCappedFlag(), SetPrimaryDrillEndLayer(), SetPrimaryDrillFilled(), SetPrimaryDrillFilledFlag(), SetPrimaryDrillShape(), SetPrimaryDrillSize(), SetPrimaryDrillStartLayer(), SetRemoveUnconnected(), SetRoundRectCornerRadius(), SetRoundRectRadiusRatio(), SetSecondaryDrillEndLayer(), SetSecondaryDrillShape(), SetSecondaryDrillSize(), SetSecondaryDrillSizeX(), SetSecondaryDrillSizeY(), SetSecondaryDrillStartLayer(), SetShape(), SetSize(), SetTertiaryDrillEndLayer(), SetTertiaryDrillShape(), SetTertiaryDrillSize(), SetTertiaryDrillSizeX(), SetTertiaryDrillSizeY(), SetTertiaryDrillStartLayer(), SetThermalGap(), SetThermalSpokeAngle(), SetThermalSpokeAngleDegrees(), SetTopBackdrillLayer(), SetTopBackdrillSize(), SetUnconnectedLayerMode(), TransformShapeToPolygon(), and ViewGetLayers().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 609 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_pinFunction

wxString PAD::m_pinFunction

private

Definition at line 1115 of file pad.h.

Referenced by Deserialize(), GetPinFunction(), Serialize(), and SetPinFunction().

◆ m_pinType

wxString PAD::m_pinType

private

Definition at line 1116 of file pad.h.

Referenced by Deserialize(), GetPinType(), IsFreePad(), IsNoConnectPad(), Serialize(), and SetPinType().

◆ m_polyDirty

bool PAD::m_polyDirty[2]

mutableprivate

Definition at line 1143 of file pad.h.

Referenced by BuildEffectivePolygon(), GetBoundingRadius(), GetEffectivePolygon(), IsDirty(), and SetDirty().

◆ m_property

PAD_PROP PAD::m_property

private

Definition at line 1135 of file pad.h.

Referenced by GetProperty(), and SetProperty().

◆ m_rolloverPos

VECTOR2I EDA_ITEM::m_rolloverPos

protectedinherited

Definition at line 612 of file eda_item.h.

Referenced by GetRolloverPos(), and SetIsRollover().

◆ m_shapesDirty

bool PAD::m_shapesDirty

mutableprivate

Definition at line 1144 of file pad.h.

Referenced by BuildEffectiveShapes(), GetBoundingBox(), GetEffectiveHoleShape(), GetEffectiveShape(), IsDirty(), SetDirty(), and SetPrimaryDrillShape().

◆ m_simElectricalType

PAD_SIM_ELECTRICAL_TYPE PAD::m_simElectricalType { PAD_SIM_ELECTRICAL_TYPE::NONE }

private

Definition at line 1140 of file pad.h.

Referenced by GetSimElectricalType(), and SetSimElectricalType().

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

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), IsType(), and Type().

◆ m_subRatsnest

int PAD::m_subRatsnest

private

Definition at line 1130 of file pad.h.

Referenced by GetSubRatsnest(), and SetSubRatsnest().

◆ m_teardropParams

TEARDROP_PARAMETERS BOARD_CONNECTED_ITEM::m_teardropParams

protectedinherited

Not all BOARD_CONNECTED_ITEMs support teardrops, but we want those that do to share a single section in the property inspector.

Definition at line 247 of file board_connected_item.h.

Referenced by GetTeardropAllowSpanTwoTracks(), GetTeardropBestLengthRatio(), GetTeardropBestWidthRatio(), GetTeardropCurved(), GetTeardropMaxLength(), GetTeardropMaxTrackWidth(), GetTeardropMaxWidth(), GetTeardropParams(), GetTeardropParams(), GetTeardropPreferZoneConnections(), GetTeardropsEnabled(), PAD::ImportSettingsFrom(), SetTeardropAllowSpanTwoTracks(), SetTeardropBestLengthRatio(), SetTeardropBestWidthRatio(), SetTeardropCurved(), SetTeardropMaxLength(), SetTeardropMaxTrackWidth(), SetTeardropMaxWidth(), SetTeardropPreferZoneConnections(), and SetTeardropsEnabled().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 599 of file eda_item.h.

◆ 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_zoneLayerOverrides

std::map<PCB_LAYER_ID, ZONE_LAYER_OVERRIDE> PAD::m_zoneLayerOverrides

private

Definition at line 1146 of file pad.h.

Referenced by ClearZoneLayerOverrides(), Deserialize(), GetZoneLayerOverride(), PAD(), Serialize(), and SetZoneLayerOverride().

◆ 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 Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ PAD() [1/2]

◆ PAD() [2/2]

Member Function Documentation

◆ AddPrimitive()

◆ AddPrimitivePoly() [1/2]

◆ AddPrimitivePoly() [2/2]

◆ ApertureMask()

◆ AppendPrimitives()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ BuildEffectivePolygon()

◆ buildEffectiveShape()

◆ BuildEffectiveShapes()

◆ CanFlashLayer()

◆ CanHaveNumber()

◆ CheckPad()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCustomProperties()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSecondaryDrillSize()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearTertiaryDrillSize()

◆ ClearZoneLayerOverrides()

◆ Clone()

◆ ClonePad()

◆ Compare()

◆ ConditionallyFlashed()

◆ ConnSMDMask()

◆ CopyFrom()

◆ DeletePrimitivesList()

◆ DeleteStructure()

◆ Deserialize()

◆ DisambiguateItemDescription()

◆ doCheckPad()

◆ Duplicate()

◆ findParent()

◆ FitsEnabledLayers()

◆ FlashLayer() [1/2]

◆ FlashLayer() [2/2]

◆ Flip()

◆ FlipPrimitives()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAnchorPadShape()

◆ GetAttribute()

◆ GetBackdrillMode()

◆ GetBackPostMachining()

◆ GetBackPostMachiningAngle()

◆ GetBackPostMachiningDepth()

◆ GetBackPostMachiningMode()

◆ GetBackPostMachiningSize()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBottomBackdrillLayer()

◆ GetBottomBackdrillSize()

◆ GetBoundingBox() [1/2]

◆ GetBoundingBox() [2/2]

◆ GetBoundingRadius()

◆ GetCenter()