#include <pad.h>

Inheritance diagram for PAD:

Public Member Functions
	PAD (FOOTPRINT *parent)

	PAD (const PAD &aPad)

PAD &	operator= (const PAD &aOther)

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

bool	HasHole () const override

FOOTPRINT *	GetParent () const

wxString	GetParentAsString () const

bool	IsLocked () const override

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

bool	IsFlipped () const

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

const wxString &	GetNumber () const

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

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

const wxString &	GetPinFunction () const

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

const wxString &	GetPinType () const

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

bool	IsNoConnectPad () const

bool	IsFreePad () const

void	SetShape (PAD_SHAPE aShape)
	Set the new shape of this pad. More...

PAD_SHAPE	GetShape () const

void	SetPosition (const VECTOR2I &aPos) override

VECTOR2I	GetPosition () const override

PAD_SHAPE	GetAnchorPadShape () const

CUST_PAD_SHAPE_IN_ZONE	GetCustomShapeInZoneOpt () const

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

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

bool	IsOnCopperLayer () const override

void	SetY (int y)

void	SetX (int x)

void	SetPos0 (const VECTOR2I &aPos)

const VECTOR2I &	GetPos0 () const

void	SetY0 (int y)

void	SetX0 (int x)

void	SetSize (const VECTOR2I &aSize)

const VECTOR2I &	GetSize () const

void	SetSizeX (const int aX)

int	GetSizeX () const

void	SetSizeY (const int aY)

int	GetSizeY () const

void	SetDelta (const VECTOR2I &aSize)

const VECTOR2I &	GetDelta () const

void	SetDrillSize (const VECTOR2I &aSize)

const VECTOR2I &	GetDrillSize () const

void	SetDrillSizeX (const int aX)

int	GetDrillSizeX () const

void	SetDrillSizeY (const int aY)

int	GetDrillSizeY () const

void	SetOffset (const VECTOR2I &aOffset)

const VECTOR2I &	GetOffset () const

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

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

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

void	AddPrimitiveSegment (const VECTOR2I &aStart, const VECTOR2I &aEnd, int aThickness)

void	AddPrimitiveCircle (const VECTOR2I &aCenter, int aRadius, int aThickness, bool aFilled)

void	AddPrimitiveRect (const VECTOR2I &aStart, const VECTOR2I &aEnd, int aThickness, bool aFilled)

void	AddPrimitiveArc (const VECTOR2I &aCenter, const VECTOR2I &aStart, const EDA_ANGLE &aArcAngle, int aThickness)

void	AddPrimitiveCurve (const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aCtrl1, const VECTOR2I &aCtrl2, int aThickness)

void	AddPrimitiveAnnotationBox (const VECTOR2I &aStart, const VECTOR2I &aEnd)
	Has meaning only for custom shape pads. More...

bool	GetBestAnchorPosition (VECTOR2I &aPos)

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

void	DeletePrimitivesList ()
	Clear the basic shapes list. More...

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

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

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

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

void	AppendPrimitives (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. More...

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

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

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

void	SetOrientationDegrees (double aOrientation)

double	GetOrientationDegrees () const

void	SetDrillShape (PAD_DRILL_SHAPE_T aShape)

PAD_DRILL_SHAPE_T	GetDrillShape () const

bool	IsDirty () const

void	SetDirty ()

void	SetLayerSet (LSET aLayers) override

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

void	SetAttribute (PAD_ATTRIB aAttribute)

PAD_ATTRIB	GetAttribute () const

void	SetProperty (PAD_PROP aProperty)

PAD_PROP	GetProperty () const

bool	IsAperturePad () const

void	SetPadToDieLength (int aLength)

int	GetPadToDieLength () const

int	GetLocalSolderMaskMargin () const

void	SetLocalSolderMaskMargin (int aMargin)

int	GetLocalClearance (wxString *aSource) const override
	Return any local clearances set in the "classic" (ie: pre-rule) system. More...

int	GetLocalClearance () const

void	SetLocalClearance (int aClearance)

int	GetLocalSolderPasteMargin () const

void	SetLocalSolderPasteMargin (int aMargin)

double	GetLocalSolderPasteMarginRatio () const

void	SetLocalSolderPasteMarginRatio (double aRatio)

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

void	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aMaxError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
	Convert the pad shape to a closed polygon. More...

bool	TransformHoleWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int aError, ERROR_LOC aErrorLoc) const
	Build the corner list of the polygonal drill shape in the board coordinate system. More...

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

const std::shared_ptr< SHAPE_POLY_SET > &	GetEffectivePolygon () const

std::shared_ptr< SHAPE_SEGMENT >	GetEffectiveHoleShape () const override
	Return a SHAPE_SEGMENT object representing the pad's hole. More...

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

int	GetLocalClearanceOverrides (wxString *aSource) const override
	Return any local clearance overrides set in the "classic" (ie: pre-rule) system. More...

int	GetSolderMaskExpansion () const

VECTOR2I	GetSolderPasteMargin () 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. More...

void	SetZoneConnection (ZONE_CONNECTION aType)

ZONE_CONNECTION	GetZoneConnection () const

ZONE_CONNECTION	GetLocalZoneConnectionOverride (wxString *aSource=nullptr) const

void	SetThermalSpokeWidth (int aWidth)
	Set the width of the thermal spokes connecting the pad to a zone. More...

int	GetThermalSpokeWidth () const

int	GetLocalSpokeWidthOverride (wxString *aSource=nullptr) const

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

EDA_ANGLE	GetThermalSpokeAngle () const

void	SetThermalSpokeAngleDegrees (double aAngle)

double	GetThermalSpokeAngleDegrees () const

void	SetThermalGap (int aGap)

int	GetThermalGap () const

int	GetLocalThermalGapOverride (wxString *aSource=nullptr) const

void	SetRoundRectCornerRadius (double aRadius)
	Has meaning only for rounded rectangle pads. More...

int	GetRoundRectCornerRadius () const

VECTOR2I	ShapePos () const

void	SetRoundRectRadiusRatio (double aRadiusScale)
	Has meaning only for rounded rectangle pads. More...

double	GetRoundRectRadiusRatio () const

void	SetChamferRectRatio (double aChamferScale)
	Has meaning only for chamfered rectangular pads. More...

double	GetChamferRectRatio () const

void	SetChamferPositions (int aPositions)
	Has meaning only for chamfered rectangular pads. More...

int	GetChamferPositions () const

int	GetSubRatsnest () const

void	SetSubRatsnest (int aSubRatsnest)

void	SetRemoveUnconnected (bool aSet)
	Set the unconnected removal property. More...

bool	GetRemoveUnconnected () const

void	SetKeepTopBottom (bool aSet)
	Set whether we keep the top and bottom connections even if they are not connected. More...

bool	GetKeepTopBottom () 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. More...

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

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

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

PCB_LAYER_ID	GetPrincipalLayer () const

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

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

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

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

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

void	SetDrawCoord ()

void	SetLocalCoord ()
	< Set relative coordinates. More...

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

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

wxString	GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

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

wxString	ShowPadShape () const

wxString	ShowPadAttr () const

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

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

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

void	BuildEffectivePolygon () const

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

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

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

virtual void	SwapData (BOARD_ITEM *aImage) override
	Swap data between aItem and aImage. More...

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

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

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

int	GetNetCode () const

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

void	SetNetCode (int aNetCode)

wxString	GetNetname () const

wxString	GetNetnameMsg () const

wxString	GetShortNetname () const

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

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

void	SetLocalRatsnestVisible (bool aVisible)

bool	GetLocalRatsnestVisible () const

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

virtual bool	IsTented () const

BOARD_ITEM_CONTAINER *	GetParentFootprint () const

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

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

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

virtual void	SetLocked (bool aLocked)

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

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

virtual BOARD *	GetBoard ()

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

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

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

bool	IsForceVisible () const

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

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

virtual INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, 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. More...

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

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

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

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

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

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

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

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

static LSET	ApertureMask ()
	layer set for an aperture pad More...

static bool	ClassOf (const EDA_ITEM *aItem)

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

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

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

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

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

Public Attributes
const KIID	m_Uuid

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

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

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

Protected Attributes
NETINFO_ITEM *	m_netinfo
	Store all information about the net that item belongs to. More...

PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

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

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Member Functions
void	addPadPrimitivesToPolygon (SHAPE_POLY_SET *aMergedPolygon, int aError, ERROR_LOC aErrorLoc) const

Private Attributes
wxString	m_number

wxString	m_pinFunction

wxString	m_pinType

VECTOR2I	m_pos

PAD_SHAPE	m_padShape

std::vector< std::shared_ptr< PCB_SHAPE > >	m_editPrimitives

bool	m_shapesDirty

std::mutex	m_shapesBuildingLock

BOX2I	m_effectiveBoundingBox

std::shared_ptr< SHAPE_COMPOUND >	m_effectiveShape

std::shared_ptr< SHAPE_SEGMENT >	m_effectiveHoleShape

bool	m_polyDirty

std::mutex	m_polyBuildingLock

std::shared_ptr< SHAPE_POLY_SET >	m_effectivePolygon

int	m_effectiveBoundingRadius

CUST_PAD_SHAPE_IN_ZONE	m_customShapeClearanceArea

int	m_subRatsnest

VECTOR2I	m_drill

VECTOR2I	m_size

PAD_DRILL_SHAPE_T	m_drillShape

double	m_roundedCornerScale

double	m_chamferScale

int	m_chamferPositions

PAD_SHAPE	m_anchorPadShape

VECTOR2I	m_offset

LSET	m_layerMask

VECTOR2I	m_deltaSize

VECTOR2I	m_pos0

PAD_ATTRIB	m_attribute

PAD_PROP	m_property

EDA_ANGLE	m_orient

int	m_lengthPadToDie

bool	m_removeUnconnectedLayer
	< If true, the pad copper is removed for layers that are not connected. More...

bool	m_keepTopBottomLayer

int	m_localClearance

int	m_localSolderMaskMargin

int	m_localSolderPasteMargin

double	m_localSolderPasteMarginRatio

ZONE_CONNECTION	m_zoneConnection

int	m_thermalSpokeWidth

EDA_ANGLE	m_thermalSpokeAngle

int	m_thermalGap

bool	m_localRatsnestVisible

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

VIEW_ITEM_DATA *	m_viewPrivData

Detailed Description

Definition at line 57 of file pad.h.

Constructor & Destructor Documentation

◆ PAD() [1/2]

PAD::PAD ( FOOTPRINT * parent )

Definition at line 60 of file pad.cpp.

 :
 BOARD_CONNECTED_ITEM( parent, PCB_PAD_T )
{
 m_size.x = m_size.y = EDA_UNIT_UTILS::Mils2IU( pcbIUScale, 60 ); // Default pad size 60 mils.
 m_drill.x = m_drill.y = EDA_UNIT_UTILS::Mils2IU( pcbIUScale, 30 ); // Default drill size 30 mils.
 m_orient = ANGLE_0;
 m_lengthPadToDie = 0;
 
 if( m_parent && m_parent->Type() == PCB_FOOTPRINT_T )
 m_pos = GetParent()->GetPosition();
 
 SetShape( PAD_SHAPE::CIRCLE ); // Default pad shape is PAD_CIRCLE.
 SetAnchorPadShape( PAD_SHAPE::CIRCLE ); // Default shape for custom shaped pads
 // is PAD_CIRCLE.
 SetDrillShape( PAD_DRILL_SHAPE_CIRCLE ); // Default pad drill shape is a circle.
 m_attribute = PAD_ATTRIB::PTH; // Default pad type is plated through hole
 SetProperty( PAD_PROP::NONE ); // no special fabrication property
 m_localClearance = 0;
 m_localSolderMaskMargin = 0;
 m_localSolderPasteMargin = 0;
 m_localSolderPasteMarginRatio = 0.0;
 
 // Parameters for round rect only:
 m_roundedCornerScale = 0.25; // from IPC-7351C standard
 
 // Parameters for chamfered rect only:
 m_chamferScale = 0.2; // Size of chamfer: ratio of smallest of X,Y size
 m_chamferPositions = RECT_NO_CHAMFER; // No chamfered corner
 
 m_zoneConnection = ZONE_CONNECTION::INHERITED; // Use parent setting by default
 m_thermalSpokeWidth = 0; // Use parent setting by default
 m_thermalSpokeAngle = ANGLE_45; // Default for circular pads
 m_thermalGap = 0; // Use parent setting by default
 
 m_customShapeClearanceArea = CUST_PAD_SHAPE_IN_ZONE_OUTLINE;
 
 // Set layers mask to default for a standard thru hole pad.
 m_layerMask = PTHMask();
 
 SetSubRatsnest( 0 ); // used in ratsnest calculations
 
 SetDirty();
 m_effectiveBoundingRadius = 0;
 m_removeUnconnectedLayer = false;
 m_keepTopBottomLayer = true;
}

References ANGLE_0, ANGLE_45, CIRCLE, CUST_PAD_SHAPE_IN_ZONE_OUTLINE, GetParent(), FOOTPRINT::GetPosition(), INHERITED, m_attribute, m_chamferPositions, m_chamferScale, m_customShapeClearanceArea, m_drill, m_effectiveBoundingRadius, m_keepTopBottomLayer, m_layerMask, m_lengthPadToDie, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_orient, EDA_ITEM::m_parent, m_pos, m_removeUnconnectedLayer, m_roundedCornerScale, m_size, m_thermalGap, m_thermalSpokeAngle, m_thermalSpokeWidth, m_zoneConnection, EDA_UNIT_UTILS::Mils2IU(), NONE, PAD_DRILL_SHAPE_CIRCLE, PCB_FOOTPRINT_T, pcbIUScale, PTH, PTHMask(), RECT_NO_CHAMFER, SetAnchorPadShape(), SetDirty(), SetDrillShape(), SetProperty(), SetShape(), SetSubRatsnest(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Clone().

◆ PAD() [2/2]

PAD::PAD ( const PAD & aPad )

Definition at line 108 of file pad.cpp.

 :
 BOARD_CONNECTED_ITEM( aOther.GetParent(), PCB_PAD_T )
{
 PAD::operator=( aOther );
 
 const_cast<KIID&>( m_Uuid ) = aOther.m_Uuid;
}

References EDA_ITEM::m_Uuid, and operator=().

Member Function Documentation

◆ addPadPrimitivesToPolygon()

void PAD::addPadPrimitivesToPolygon	(	SHAPE_POLY_SET *	aMergedPolygon,
		int	aError,
		ERROR_LOC	aErrorLoc
	)		const

private

Definition at line 205 of file pad_custom_shape_functions.cpp.

{
 SHAPE_POLY_SET polyset;
 
 for( const std::shared_ptr<PCB_SHAPE>& primitive : m_editPrimitives )
 {
 if( !primitive->IsAnnotationProxy() )
 {
 primitive->TransformShapeWithClearanceToPolygon( polyset, UNDEFINED_LAYER, 0, aError,
 aErrorLoc );
 }
 }
 
 polyset.Simplify( SHAPE_POLY_SET::PM_FAST );
 
 // Merge all polygons with the initial pad anchor shape
 if( polyset.OutlineCount() )
 {
 aMergedPolygon->BooleanAdd( polyset, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
 aMergedPolygon->Fracture( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
 }
}

References SHAPE_POLY_SET::BooleanAdd(), SHAPE_POLY_SET::Fracture(), m_editPrimitives, SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, SHAPE_POLY_SET::Simplify(), and UNDEFINED_LAYER.

Referenced by GetBestAnchorPosition(), and MergePrimitivesAsPolygon().

◆ AddPrimitive()

void PAD::AddPrimitive ( PCB_SHAPE * aPrimitive )

Add item to the custom shape primitives list.

Definition at line 187 of file pad_custom_shape_functions.cpp.

{
 aPrimitive->SetParent( this );
 m_editPrimitives.emplace_back( aPrimitive );
 
 SetDirty();
}

References m_editPrimitives, SetDirty(), and EDA_ITEM::SetParent().

Referenced by AppendPrimitives(), and PAD_TOOL::RecombinePad().

◆ AddPrimitiveAnnotationBox()

void PAD::AddPrimitiveAnnotationBox	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd
	)

Has meaning only for custom shape pads.

Allows one to specify the box in which to place the pad number and/or net name (if they are being displayed).

Definition at line 150 of file pad_custom_shape_functions.cpp.

{
 PCB_SHAPE* item = new PCB_SHAPE( nullptr, SHAPE_T::RECT );
 item->SetIsAnnotationProxy();
 item->SetFilled( false );
 item->SetStart( aStart );
 item->SetEnd( aEnd );
 item->SetStroke( STROKE_PARAMS( 1, PLOT_DASH_TYPE::SOLID ) );
 item->SetParent( this );
 m_editPrimitives.emplace_back( item );
 SetDirty();
}

References m_editPrimitives, RECT, SetDirty(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), EDA_SHAPE::SetIsAnnotationProxy(), EDA_ITEM::SetParent(), EDA_SHAPE::SetStart(), PCB_SHAPE::SetStroke(), and SOLID.

◆ AddPrimitiveArc()

void PAD::AddPrimitiveArc	(	const VECTOR2I &	aCenter,
		const VECTOR2I &	aStart,
		const EDA_ANGLE &	aArcAngle,
		int	aThickness
	)

Definition at line 92 of file pad_custom_shape_functions.cpp.

{
 PCB_SHAPE* item = new PCB_SHAPE( nullptr, SHAPE_T::ARC );
 item->SetFilled( false );
 item->SetCenter( aCenter );
 item->SetStart( aStart );
 item->SetArcAngleAndEnd( aArcAngle );
 item->SetStroke( STROKE_PARAMS( aThickness, PLOT_DASH_TYPE::SOLID ) );
 item->SetParent( this );
 m_editPrimitives.emplace_back( item );
 SetDirty();
}

References ARC, m_editPrimitives, EDA_SHAPE::SetArcAngleAndEnd(), EDA_SHAPE::SetCenter(), SetDirty(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetStart(), PCB_SHAPE::SetStroke(), and SOLID.

◆ AddPrimitiveCircle()

void PAD::AddPrimitiveCircle	(	const VECTOR2I &	aCenter,
		int	aRadius,
		int	aThickness,
		bool	aFilled
	)

Definition at line 123 of file pad_custom_shape_functions.cpp.

{
 PCB_SHAPE* item = new PCB_SHAPE( nullptr, SHAPE_T::CIRCLE );
 item->SetFilled( aFilled );
 item->SetStart( aCenter );
 item->SetEnd( wxPoint( aCenter.x + aRadius, aCenter.y ) );
 item->SetStroke( STROKE_PARAMS( aThickness, PLOT_DASH_TYPE::SOLID ) );
 item->SetParent( this );
 m_editPrimitives.emplace_back( item );
 SetDirty();
}

References CIRCLE, m_editPrimitives, SetDirty(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetStart(), PCB_SHAPE::SetStroke(), SOLID, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ AddPrimitiveCurve()

void PAD::AddPrimitiveCurve	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		const VECTOR2I &	aCtrl1,
		const VECTOR2I &	aCtrl2,
		int	aThickness
	)

Definition at line 107 of file pad_custom_shape_functions.cpp.

{
 PCB_SHAPE* item = new PCB_SHAPE( nullptr, SHAPE_T::BEZIER );
 item->SetFilled( false );
 item->SetStart( aStart );
 item->SetEnd( aEnd );
 item->SetBezierC1( aCtrl1 );
 item->SetBezierC2( aCtrl2 );
 item->SetStroke( STROKE_PARAMS( aThickness, PLOT_DASH_TYPE::SOLID ) );
 item->SetParent( this );
 m_editPrimitives.emplace_back( item );
 SetDirty();
}

References BEZIER, m_editPrimitives, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), SetDirty(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetStart(), PCB_SHAPE::SetStroke(), and SOLID.

◆ AddPrimitivePoly() [1/2]

void PAD::AddPrimitivePoly	(	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 40 of file pad_custom_shape_functions.cpp.

{
 // If aPoly has holes, convert it to a polygon with no holes.
 SHAPE_POLY_SET poly_no_hole;
 poly_no_hole.Append( aPoly );
 
 if( poly_no_hole.HasHoles() )
 poly_no_hole.Fracture( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
 
 // There should never be multiple shapes, but if there are, we split them into
 // primitives so that we can edit them both.
 for( int ii = 0; ii < poly_no_hole.OutlineCount(); ++ii )
 {
 SHAPE_POLY_SET poly_outline( poly_no_hole.COutline( ii ) );
 PCB_SHAPE* item = new PCB_SHAPE();
 item->SetShape( SHAPE_T::POLY );
 item->SetFilled( aFilled );
 item->SetPolyShape( poly_outline );
 item->SetStroke( STROKE_PARAMS( aThickness, PLOT_DASH_TYPE::SOLID ) );
 item->SetParent( this );
 m_editPrimitives.emplace_back( item );
 }
 
 SetDirty();
}

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

◆ AddPrimitivePoly() [2/2]

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

Definition at line 67 of file pad_custom_shape_functions.cpp.

{
 PCB_SHAPE* item = new PCB_SHAPE( nullptr, SHAPE_T::POLY );
 item->SetFilled( aFilled );
 item->SetPolyPoints( aPoly );
 item->SetStroke( STROKE_PARAMS( aThickness, PLOT_DASH_TYPE::SOLID ) );
 item->SetParent( this );
 m_editPrimitives.emplace_back( item );
 SetDirty();
}

References m_editPrimitives, POLY, SetDirty(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetPolyPoints(), PCB_SHAPE::SetStroke(), and SOLID.

◆ AddPrimitiveRect()

void PAD::AddPrimitiveRect	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		int	aThickness,
		bool	aFilled
	)

Definition at line 136 of file pad_custom_shape_functions.cpp.

{
 PCB_SHAPE* item = new PCB_SHAPE( nullptr, SHAPE_T::RECT );
 item->SetFilled( aFilled );
 item->SetStart( aStart );
 item->SetEnd( aEnd );
 item->SetStroke( STROKE_PARAMS( aThickness, PLOT_DASH_TYPE::SOLID ) );
 item->SetParent( this );
 m_editPrimitives.emplace_back( item );
 SetDirty();
}

References m_editPrimitives, RECT, SetDirty(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetStart(), PCB_SHAPE::SetStroke(), and SOLID.

◆ AddPrimitiveSegment()

void PAD::AddPrimitiveSegment	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		int	aThickness
	)

Definition at line 79 of file pad_custom_shape_functions.cpp.

{
 PCB_SHAPE* item = new PCB_SHAPE( nullptr, SHAPE_T::SEGMENT );
 item->SetFilled( false );
 item->SetStart( aStart );
 item->SetEnd( aEnd );
 item->SetStroke( STROKE_PARAMS( aThickness, PLOT_DASH_TYPE::SOLID ) );
 item->SetParent( this );
 m_editPrimitives.emplace_back( item );
 SetDirty();
}

References m_editPrimitives, SEGMENT, SetDirty(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetStart(), PCB_SHAPE::SetStroke(), and SOLID.

◆ ApertureMask()

LSET PAD::ApertureMask ( )

static

layer set for an aperture pad

Definition at line 202 of file pad.cpp.

{
 static LSET saved( 1, F_Paste );
 return saved;
}

References F_Paste.

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

◆ AppendPrimitives()

void PAD::AppendPrimitives ( 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 177 of file pad_custom_shape_functions.cpp.

{
 // Add duplicates of aPrimitivesList to the pad primitives list:
 for( const std::shared_ptr<PCB_SHAPE>& prim : aPrimitivesList )
 AddPrimitive( new PCB_SHAPE( *prim ) );
 
 SetDirty();
}

References AddPrimitive(), and SetDirty().

Referenced by ReplacePrimitives().

◆ BuildEffectivePolygon()

void PAD::BuildEffectivePolygon ( ) const

Definition at line 574 of file pad.cpp.

{
 std::lock_guard<std::mutex> RAII_lock( m_polyBuildingLock );
 
 // If we had to wait for the lock then we were probably waiting for someone else to
 // finish rebuilding the shapes. So check to see if they're clean now.
 if( !m_polyDirty )
 return;
 
 const BOARD* board = GetBoard();
 int maxError = board ? board->GetDesignSettings().m_MaxError : ARC_HIGH_DEF;
 
 // Polygon
 m_effectivePolygon = std::make_shared<SHAPE_POLY_SET>();
 TransformShapeWithClearanceToPolygon( *m_effectivePolygon, UNDEFINED_LAYER, 0, maxError,
 ERROR_INSIDE );
 
 // Bounding radius
 //
 // PADSTACKS TODO: these will both need to cycle through all layers to get the largest
 // values....
 m_effectiveBoundingRadius = 0;
 
 for( int cnt = 0; cnt < m_effectivePolygon->OutlineCount(); ++cnt )
 {
 const SHAPE_LINE_CHAIN& poly = m_effectivePolygon->COutline( cnt );
 
 for( int ii = 0; ii < poly.PointCount(); ++ii )
 {
 int dist = KiROUND( ( poly.CPoint( ii ) - m_pos ).EuclideanNorm() );
 m_effectiveBoundingRadius = std::max( m_effectiveBoundingRadius, dist );
 }
 }
 
 // All done
 m_polyDirty = false;
}

References ARC_HIGH_DEF, SHAPE_LINE_CHAIN::CPoint(), ERROR_INSIDE, BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), KiROUND(), m_effectiveBoundingRadius, m_effectivePolygon, BOARD_DESIGN_SETTINGS::m_MaxError, m_polyBuildingLock, m_polyDirty, m_pos, SHAPE_LINE_CHAIN::PointCount(), TransformShapeWithClearanceToPolygon(), and UNDEFINED_LAYER.

Referenced by GetBoundingRadius(), and GetEffectivePolygon().

◆ BuildEffectiveShapes()

void PAD::BuildEffectiveShapes ( PCB_LAYER_ID aLayer ) const

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

Definition at line 402 of file pad.cpp.

{
 std::lock_guard<std::mutex> RAII_lock( m_shapesBuildingLock );
 
 // If we had to wait for the lock then we were probably waiting for someone else to
 // finish rebuilding the shapes. So check to see if they're clean now.
 if( !m_shapesDirty )
 return;
 
 const BOARD* board = GetBoard();
 int maxError = board ? board->GetDesignSettings().m_MaxError : ARC_HIGH_DEF;
 
 m_effectiveShape = std::make_shared<SHAPE_COMPOUND>();
 m_effectiveHoleShape = nullptr;
 
 auto add = [this]( SHAPE* aShape )
 {
 m_effectiveShape->AddShape( aShape );
 };
 
 VECTOR2I shapePos = ShapePos(); // Fetch only once; rotation involves trig
 PAD_SHAPE effectiveShape = GetShape();
 
 if( GetShape() == PAD_SHAPE::CUSTOM )
 effectiveShape = GetAnchorPadShape();
 
 switch( effectiveShape )
 {
 case PAD_SHAPE::CIRCLE:
 add( new SHAPE_CIRCLE( shapePos, m_size.x / 2 ) );
 break;
 
 case PAD_SHAPE::OVAL:
 if( m_size.x == m_size.y ) // the oval pad is in fact a circle
 {
 add( new SHAPE_CIRCLE( shapePos, m_size.x / 2 ) );
 }
 else
 {
 VECTOR2I half_size = m_size / 2;
 int half_width = std::min( half_size.x, half_size.y );
 VECTOR2I half_len( half_size.x - half_width, half_size.y - half_width );
 RotatePoint( half_len, m_orient );
 add( new SHAPE_SEGMENT( shapePos - half_len, shapePos + half_len, half_width * 2 ) );
 }
 
 break;
 
 case PAD_SHAPE::RECT:
 case PAD_SHAPE::TRAPEZOID:
 case PAD_SHAPE::ROUNDRECT:
 {
 int r = ( effectiveShape == PAD_SHAPE::ROUNDRECT ) ? GetRoundRectCornerRadius() : 0;
 VECTOR2I half_size( m_size.x / 2, m_size.y / 2 );
 VECTOR2I trap_delta( 0, 0 );
 
 if( r )
 {
 half_size -= VECTOR2I( r, r );
 
 // Avoid degenerated shapes (0 length segments) that always create issues
 // For roundrect pad very near a circle, use only a circle
 const int min_len = pcbIUScale.mmToIU( 0.0001);
 
 if( half_size.x < min_len && half_size.y < min_len )
 {
 add( new SHAPE_CIRCLE( shapePos, r ) );
 break;
 }
 }
 else if( effectiveShape == PAD_SHAPE::TRAPEZOID )
 {
 trap_delta = m_deltaSize / 2;
 }
 
 SHAPE_LINE_CHAIN corners;
 
 corners.Append( -half_size.x - trap_delta.y, half_size.y + trap_delta.x );
 corners.Append( half_size.x + trap_delta.y, half_size.y - trap_delta.x );
 corners.Append( half_size.x - trap_delta.y, -half_size.y + trap_delta.x );
 corners.Append( -half_size.x + trap_delta.y, -half_size.y - trap_delta.x );
 
 corners.Rotate( m_orient );
 corners.Move( shapePos );
 
 // GAL renders rectangles faster than 4-point polygons so it's worth checking if our
 // body shape is a rectangle.
 if( corners.PointCount() == 4
 &&
 ( ( corners.CPoint( 0 ).y == corners.CPoint( 1 ).y
 && corners.CPoint( 1 ).x == corners.CPoint( 2 ).x
 && corners.CPoint( 2 ).y == corners.CPoint( 3 ).y
 && corners.CPoint( 3 ).x == corners.CPoint( 0 ).x )
 ||
 ( corners.CPoint( 0 ).x == corners.CPoint( 1 ).x
 && corners.CPoint( 1 ).y == corners.CPoint( 2 ).y
 && corners.CPoint( 2 ).x == corners.CPoint( 3 ).x
 && corners.CPoint( 3 ).y == corners.CPoint( 0 ).y )
 )
 )
 {
 int width = std::abs( corners.CPoint( 2 ).x - corners.CPoint( 0 ).x );
 int height = std::abs( corners.CPoint( 2 ).y - corners.CPoint( 0 ).y );
 VECTOR2I pos( std::min( corners.CPoint( 2 ).x, corners.CPoint( 0 ).x ),
 std::min( corners.CPoint( 2 ).y, corners.CPoint( 0 ).y ) );
 
 add( new SHAPE_RECT( pos, width, height ) );
 }
 else
 {
 add( new SHAPE_SIMPLE( corners ) );
 }
 
 if( r )
 {
 add( new SHAPE_SEGMENT( corners.CPoint( 0 ), corners.CPoint( 1 ), r * 2 ) );
 add( new SHAPE_SEGMENT( corners.CPoint( 1 ), corners.CPoint( 2 ), r * 2 ) );
 add( new SHAPE_SEGMENT( corners.CPoint( 2 ), corners.CPoint( 3 ), r * 2 ) );
 add( new SHAPE_SEGMENT( corners.CPoint( 3 ), corners.CPoint( 0 ), r * 2 ) );
 }
 }
 break;
 
 case PAD_SHAPE::CHAMFERED_RECT:
 {
 SHAPE_POLY_SET outline;
 
 TransformRoundChamferedRectToPolygon( outline, shapePos, GetSize(), m_orient,
 GetRoundRectCornerRadius(), GetChamferRectRatio(),
 GetChamferPositions(), 0, maxError, ERROR_INSIDE );
 
 add( new SHAPE_SIMPLE( outline.COutline( 0 ) ) );
 }
 break;
 
 default:
 wxFAIL_MSG( wxT( "PAD::buildEffectiveShapes: Unsupported pad shape: " )
 + PAD_SHAPE_T_asString( effectiveShape ) );
 break;
 }
 
 if( GetShape() == PAD_SHAPE::CUSTOM )
 {
 for( const std::shared_ptr<PCB_SHAPE>& primitive : m_editPrimitives )
 {
 for( SHAPE* shape : primitive->MakeEffectiveShapes() )
 {
 shape->Rotate( m_orient );
 shape->Move( shapePos );
 add( shape );
 }
 }
 }
 
 m_effectiveBoundingBox = m_effectiveShape->BBox();
 
 // Hole shape
 VECTOR2I half_size = m_drill / 2;
 int half_width = std::min( half_size.x, half_size.y );
 VECTOR2I half_len( half_size.x - half_width, half_size.y - half_width );
 
 RotatePoint( half_len, m_orient );
 
 m_effectiveHoleShape = std::make_shared<SHAPE_SEGMENT>( m_pos - half_len, m_pos + half_len,
 half_width * 2 );
 m_effectiveBoundingBox.Merge( m_effectiveHoleShape->BBox() );
 
 // All done
 m_shapesDirty = false;
}

References std::abs(), SHAPE_LINE_CHAIN::Append(), ARC_HIGH_DEF, CHAMFERED_RECT, CIRCLE, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), CUSTOM, ERROR_INSIDE, GetAnchorPadShape(), BOARD_ITEM::GetBoard(), GetChamferPositions(), GetChamferRectRatio(), BOARD::GetDesignSettings(), GetRoundRectCornerRadius(), GetShape(), GetSize(), m_deltaSize, m_drill, m_editPrimitives, m_effectiveBoundingBox, m_effectiveHoleShape, m_effectiveShape, BOARD_DESIGN_SETTINGS::m_MaxError, m_orient, m_pos, m_shapesBuildingLock, m_shapesDirty, m_size, BOX2< Vec >::Merge(), EDA_IU_SCALE::mmToIU(), SHAPE_LINE_CHAIN::Move(), OVAL, PAD_SHAPE_T_asString(), pcbIUScale, SHAPE_LINE_CHAIN::PointCount(), r, RECT, SHAPE_LINE_CHAIN::Rotate(), RotatePoint(), ROUNDRECT, ShapePos(), TransformRoundChamferedRectToPolygon(), TRAPEZOID, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ 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 137 of file pad.cpp.

{
 // Aperture pads don't get a number
 if( IsAperturePad() )
 return false;
 
 // NPTH pads don't get numbers
 if( GetAttribute() == PAD_ATTRIB::NPTH )
 return false;
 
 return true;
}

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

◆ ClassOf()

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

inlinestatic

Definition at line 79 of file pad.h.

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

References PCB_PAD_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 136 of file eda_item.h.

136{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:157

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:66

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 174 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 157 of file eda_item.h.

157{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:512

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 135 of file eda_item.h.

135{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 169 of file eda_item.h.

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

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

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

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * 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 1273 of file pad.cpp.

{
 return new PAD( *this );
}

References PAD().

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

 {
 return (PAD*) Clone();
 }

References Clone().

◆ 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 1102 of file pad.cpp.

{
 int diff;
 
 if( ( diff = static_cast<int>( aPadRef->GetShape() ) -
 static_cast<int>( aPadCmp->GetShape() ) ) != 0 )
 return diff;
 
 if( ( diff = static_cast<int>( aPadRef->m_attribute ) -
 static_cast<int>( aPadCmp->m_attribute ) ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_drillShape - aPadCmp->m_drillShape ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_drill.x - aPadCmp->m_drill.x ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_drill.y - aPadCmp->m_drill.y ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_size.x - aPadCmp->m_size.x ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_size.y - aPadCmp->m_size.y ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_offset.x - aPadCmp->m_offset.x ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_offset.y - aPadCmp->m_offset.y ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_deltaSize.x - aPadCmp->m_deltaSize.x ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_deltaSize.y - aPadCmp->m_deltaSize.y ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_roundedCornerScale - aPadCmp->m_roundedCornerScale ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_chamferPositions - aPadCmp->m_chamferPositions ) != 0 )
 return diff;
 
 if( ( diff = aPadRef->m_chamferScale - aPadCmp->m_chamferScale ) != 0 )
 return diff;
 
 if( ( diff = static_cast<int>( aPadRef->m_editPrimitives.size() ) -
 static_cast<int>( aPadCmp->m_editPrimitives.size() ) ) != 0 )
 return diff;
 
 // @todo: Compare custom pad primitives for pads that have the same number of primitives
 // here. Currently there is no compare function for PCB_SHAPE objects.
 
 // Dick: specctra_export needs this
 // Lorenzo: gencad also needs it to implement padstacks!
 
#if __cplusplus >= 201103L
 long long d = aPadRef->m_layerMask.to_ullong() - aPadCmp->m_layerMask.to_ullong();
 
 if( d < 0 )
 return -1;
 else if( d > 0 )
 return 1;
 
 return 0;
#else
 // these strings are not typically constructed, since we don't get here often.
 std::string s1 = aPadRef->m_layerMask.to_string();
 std::string s2 = aPadCmp->m_layerMask.to_string();
 return s1.compare( s2 );
#endif
}

References GetShape(), m_attribute, m_chamferPositions, m_chamferScale, m_deltaSize, m_drill, m_drillShape, m_editPrimitives, m_layerMask, m_offset, m_roundedCornerScale, m_size, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CreatePadsShapesSection().

◆ ConnSMDMask()

LSET PAD::ConnSMDMask ( )

static

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

Definition at line 188 of file pad.cpp.

{
 static LSET saved( 2, F_Cu, F_Mask );
 return saved;
}

References F_Cu, and F_Mask.

Referenced by DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ DeletePrimitivesList()

void PAD::DeletePrimitivesList ( )

Clear the basic shapes list.

Definition at line 197 of file pad_custom_shape_functions.cpp.

{
 m_editPrimitives.clear();
 
 SetDirty();
}

References m_editPrimitives, and SetDirty().

Referenced by PAD_TOOL::explodePad(), ReplacePrimitives(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 144 of file board_item.cpp.

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

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

Referenced by BOARD::PadDelete(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 160 of file board_item.cpp.

{
 BOARD_ITEM* dupe = static_cast<BOARD_ITEM*>( Clone() );
 const_cast<KIID&>( dupe->m_Uuid ) = KIID();
 
 if( dupe->GetParentGroup() )
 dupe->GetParentGroup()->AddItem( dupe );
 
 return static_cast<BOARD_ITEM*>( dupe );
}

References PCB_GROUP::AddItem(), EDA_ITEM::Clone(), BOARD_ITEM::GetParentGroup(), and EDA_ITEM::m_Uuid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), FOOTPRINT::Duplicate(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), and ARRAY_CREATOR::Invoke().

◆ FlashLayer() [1/2]

bool PAD::FlashLayer ( int aLayer ) const

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

Parameters

aLayer Layer to check for connectivity

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

Heat sink pads always get copper

Definition at line 245 of file pad.cpp.

{
 if( aLayer != UNDEFINED_LAYER && !IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) ) )
 return false;
 
 if( aLayer == UNDEFINED_LAYER )
 return true;
 
 if( GetAttribute() == PAD_ATTRIB::NPTH && IsCopperLayer( aLayer ) )
 {
 if( GetShape() == PAD_SHAPE::CIRCLE && GetDrillShape() == PAD_DRILL_SHAPE_CIRCLE )
 {
 if( GetOffset() == VECTOR2I( 0, 0 ) && GetDrillSize().x >= GetSize().x )
 return false;
 }
 else if( GetShape() == PAD_SHAPE::OVAL && GetDrillShape() == PAD_DRILL_SHAPE_OBLONG )
 {
 if( GetOffset() == VECTOR2I( 0, 0 )
 && GetDrillSize().x >= GetSize().x && GetDrillSize().y >= GetSize().y )
 {
 return false;
 }
 }
 }
 
 if( LSET::FrontBoardTechMask().test( aLayer ) )
 aLayer = F_Cu;
 else if( LSET::BackBoardTechMask().test( aLayer ) )
 aLayer = B_Cu;
 
 if( GetAttribute() == PAD_ATTRIB::PTH && IsCopperLayer( aLayer ) )
 {
 if( GetProperty() == PAD_PROP::HEATSINK )
 return true;
 
 if( !m_removeUnconnectedLayer )
 return true;
 
 // Plated through hole pads need copper on the top/bottom layers for proper soldering
 // Unless the user has removed them in the pad dialog
 if( m_keepTopBottomLayer && ( aLayer == F_Cu || aLayer == B_Cu ) )
 return true;
 
 if( const BOARD* board = GetBoard() )
 {
 // Must be static to keep from raising its ugly head in performance profiles
 static std::initializer_list<KICAD_T> types = { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T,
 PCB_PAD_T };
 
 // Do not check zones. Doing so results in race conditions when the via collides with
 // two different zones of different priorities.
 // See https://gitlab.com/kicad/code/kicad/-/issues/11299.
 
 return board->GetConnectivity()->IsConnectedOnLayer( this, aLayer, types, true );
 }
 }
 
 return true;
}

References B_Cu, LSET::BackBoardTechMask(), CIRCLE, F_Cu, LSET::FrontBoardTechMask(), GetAttribute(), BOARD_ITEM::GetBoard(), GetDrillShape(), GetDrillSize(), GetOffset(), GetProperty(), GetShape(), GetSize(), HEATSINK, IsCopperLayer(), IsOnLayer(), m_keepTopBottomLayer, m_removeUnconnectedLayer, NPTH, OVAL, PAD_DRILL_SHAPE_CIRCLE, PAD_DRILL_SHAPE_OBLONG, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PTH, and UNDEFINED_LAYER.

Referenced by KIGFX::PCB_PAINTER::draw(), FlashLayer(), GetEffectiveShape(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and ViewGetLOD().

◆ FlashLayer() [2/2]

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

{
 for( PCB_LAYER_ID layer : aLayers.Seq() )
 {
 if( FlashLayer( layer ) )
 return true;
 }
 
 return false;
}

References FlashLayer(), and LSET::Seq().

◆ Flip()

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

overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 681 of file pad.cpp.

{
 if( aFlipLeftRight )
 {
 MIRROR( m_pos.x, aCentre.x );
 MIRROR( m_pos0.x, 0 );
 MIRROR( m_offset.x, 0 );
 MIRROR( m_deltaSize.x, 0 );
 }
 else
 {
 MIRROR( m_pos.y, aCentre.y );
 MIRROR( m_pos0.y, 0 );
 MIRROR( m_offset.y, 0 );
 MIRROR( m_deltaSize.y, 0 );
 }
 
 SetOrientation( -GetOrientation() );
 
 auto mirrorBitFlags = []( int& aBitfield, int a, int b )
 {
 bool temp = aBitfield & a;
 
 if( aBitfield & b )
 aBitfield |= a;
 else
 aBitfield &= ~a;
 
 if( temp )
 aBitfield |= b;
 else
 aBitfield &= ~b;
 };
 
 if( aFlipLeftRight )
 {
 mirrorBitFlags( m_chamferPositions, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT );
 mirrorBitFlags( m_chamferPositions, RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT );
 }
 else
 {
 mirrorBitFlags( m_chamferPositions, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_BOTTOM_LEFT );
 mirrorBitFlags( m_chamferPositions, RECT_CHAMFER_TOP_RIGHT, RECT_CHAMFER_BOTTOM_RIGHT );
 }
 
 // flip pads layers
 // PADS items are currently on all copper layers, or
 // currently, only on Front or Back layers.
 // So the copper layers count is not taken in account
 SetLayerSet( FlipLayerMask( m_layerMask ) );
 
 // Flip the basic shapes, in custom pads
 FlipPrimitives( aFlipLeftRight );
 
 SetDirty();
}

References FlipLayerMask(), FlipPrimitives(), GetOrientation(), m_chamferPositions, m_deltaSize, m_layerMask, m_offset, m_pos, m_pos0, MIRROR(), RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT, SetDirty(), SetLayerSet(), SetOrientation(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DIALOG_PAD_PROPERTIES::initValues(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ FlipPrimitives()

void PAD::FlipPrimitives ( bool aFlipLeftRight )

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

Definition at line 739 of file pad.cpp.

{
 for( std::shared_ptr<PCB_SHAPE>& primitive : m_editPrimitives )
 primitive->Flip( VECTOR2I( 0, 0 ), aFlipLeftRight );
 
 SetDirty();
}

References m_editPrimitives, and SetDirty().

Referenced by Flip(), mirrorPadX(), and mirrorPadY().

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

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

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

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

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

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

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

◆ GetAnchorPadShape()

PAD_SHAPE PAD::GetAnchorPadShape ( ) const

inline

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

Definition at line 201 of file pad.h.

201{ return m_anchorPadShape; }

PAD::m_anchorPadShape

PAD_SHAPE m_anchorPadShape

Definition: pad.h:765

References m_anchorPadShape.

Referenced by BuildEffectiveShapes(), KI_TEST::CheckFpPad(), PAD_TOOL::explodePad(), PCB_PLUGIN::format(), GetBestAnchorPosition(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), MergePrimitivesAsPolygon(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ GetAttribute()

PAD_ATTRIB PAD::GetAttribute ( ) const

inline

◆ GetBestAnchorPosition()

bool PAD::GetBestAnchorPosition ( VECTOR2I & aPos )

Definition at line 258 of file pad_custom_shape_functions.cpp.

{
 SHAPE_POLY_SET poly;
 addPadPrimitivesToPolygon( &poly, ARC_LOW_DEF, ERROR_INSIDE );
 
 if( poly.OutlineCount() > 1 )
 return false;
 
 const int minSteps = 10;
 const int maxSteps = 50;
 
 int stepsX, stepsY;
 
 auto bbox = poly.BBox();
 
 if( bbox.GetWidth() < bbox.GetHeight() )
 {
 stepsX = minSteps;
 stepsY = minSteps * (double) bbox.GetHeight() / (double )(bbox.GetWidth() + 1);
 }
 else
 {
 stepsY = minSteps;
 stepsX = minSteps * (double) bbox.GetWidth() / (double )(bbox.GetHeight() + 1);
 }
 
 stepsX = std::max(minSteps, std::min( maxSteps, stepsX ) );
 stepsY = std::max(minSteps, std::min( maxSteps, stepsY ) );
 
 VECTOR2I center = bbox.Centre();
 
 int64_t minDist = std::numeric_limits<int64_t>::max();
 int64_t minDistEdge;
 
 if( GetAnchorPadShape() == PAD_SHAPE::CIRCLE )
 {
 minDistEdge = GetSize().x;
 }
 else
 {
 minDistEdge = std::max( GetSize().x, GetSize().y );
 }
 
 std::optional<VECTOR2I> bestAnchor( []()->std::optional<VECTOR2I> { return std::nullopt; }() );
 
 for( int y = 0; y < stepsY ; y++ )
 {
 for( int x = 0; x < stepsX; x++ )
 {
 VECTOR2I p = bbox.GetPosition();
 p.x += rescale( x, bbox.GetWidth(), (stepsX - 1) );
 p.y += rescale( y, bbox.GetHeight(), (stepsY - 1) );
 
 if( poly.Contains(p) )
 {
 
 int dist = (center - p).EuclideanNorm();
 int distEdge = poly.COutline(0).Distance( p, true );
 
 if( distEdge >= minDistEdge )
 {
 if( dist < minDist )
 {
 bestAnchor = p;
 minDist = dist;
 }
 }
 }
 }
 }
 
 if( bestAnchor )
 {
 aPos = *bestAnchor;
 return true;
 }
 
 return false;
}

References addPadPrimitivesToPolygon(), ARC_LOW_DEF, SHAPE_POLY_SET::BBox(), CIRCLE, SHAPE_POLY_SET::Contains(), SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::Distance(), ERROR_INSIDE, EuclideanNorm(), GetAnchorPadShape(), BOX2< Vec >::GetHeight(), GetSize(), SHAPE_POLY_SET::OutlineCount(), rescale(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 51 of file board_item.cpp.

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

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 37 of file board_item.cpp.

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

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

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

◆ GetBoundingBox()

const BOX2I PAD::GetBoundingBox ( ) const

overridevirtual

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

Set absolute coordinates.

Reimplemented from EDA_ITEM.

Definition at line 613 of file pad.cpp.

{
 if( m_shapesDirty )
 BuildEffectiveShapes( UNDEFINED_LAYER );
 
 return m_effectiveBoundingBox;
}

References BuildEffectiveShapes(), m_effectiveBoundingBox, m_shapesDirty, and UNDEFINED_LAYER.

Referenced by AR_AUTOPLACER::addPad(), ZONE_FILLER::buildThermalSpokes(), KIGFX::PCB_PAINTER::draw(), HitTest(), DSN::SPECCTRA_DB::makePADSTACK(), ViewBBox(), and ViewGetLOD().

◆ 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 393 of file pad.cpp.

{
 if( m_polyDirty )
 BuildEffectivePolygon();
 
 return m_effectiveBoundingRadius;
}

References BuildEffectivePolygon(), m_effectiveBoundingRadius, and m_polyDirty.

Referenced by 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 270 of file pad.h.

270{ return GetPosition(); }

PAD::GetPosition

VECTOR2I GetPosition() const override

Definition: pad.h:196

References GetPosition().

◆ GetChamferPositions()

int PAD::GetChamferPositions ( ) const

inline

Definition at line 575 of file pad.h.

575{ return m_chamferPositions; }

References m_chamferPositions.

Referenced by BuildEffectiveShapes(), KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::SPECCTRA_DB::makePADSTACK(), padsNeedUpdate(), BRDITEMS_PLOTTER::PlotPad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and TransformShapeWithClearanceToPolygon().

◆ GetChamferRectRatio()

double PAD::GetChamferRectRatio ( ) const

inline

Definition at line 565 of file pad.h.

565{ return m_chamferScale; }

References m_chamferScale.

Referenced by BuildEffectiveShapes(), KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PAD_PROPERTIES::OnPadShapeSelection(), padsNeedUpdate(), BRDITEMS_PLOTTER::PlotPad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), TransformShapeWithClearanceToPolygon(), and DIALOG_PAD_PROPERTIES::updateRoundRectCornerValues().

◆ GetClass()

wxString PAD::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 632 of file pad.h.

 {
 return wxT( "PAD" );
 }

◆ GetCustomShapeInZoneOpt()

CUST_PAD_SHAPE_IN_ZONE PAD::GetCustomShapeInZoneOpt ( ) const

inline

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

Definition at line 206 of file pad.h.

 {
 return m_customShapeClearanceArea;
 }

References m_customShapeClearanceArea.

Referenced by ZONE_FILLER::addKnockout(), KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), padsNeedUpdate(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetDelta()

const VECTOR2I & PAD::GetDelta ( ) const

inline

Definition at line 258 of file pad.h.

258{ return m_deltaSize; }

References m_deltaSize.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::SPECCTRA_DB::makePADSTACK(), mirrorPadX(), mirrorPadY(), padsNeedUpdate(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetDrillShape()

PAD_DRILL_SHAPE_T PAD::GetDrillShape ( ) const

inline

Definition at line 377 of file pad.h.

377{ return m_drillShape; }

References m_drillShape.

Referenced by KI_TEST::CheckFpPad(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), FlashLayer(), PCB_PLUGIN::format(), KIGFX::PCB_PAINTER::getDrillShape(), GetMsgPanelInfo(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetDrillSize()

const VECTOR2I & PAD::GetDrillSize ( ) const

inline

◆ GetDrillSizeX()

int PAD::GetDrillSizeX ( ) const

inline

Definition at line 263 of file pad.h.

263{ return m_drill.x; }

References m_drill, and VECTOR2< T >::x.

Referenced by HasHole(), PAD_DESC::PAD_DESC(), and VIAPAD::VIAPAD().

◆ GetDrillSizeY()

int PAD::GetDrillSizeY ( ) const

inline

Definition at line 265 of file pad.h.

265{ return m_drill.y; }

References m_drill, and VECTOR2< T >::y.

Referenced by HasHole(), PAD_DESC::PAD_DESC(), and VIAPAD::VIAPAD().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 161 of file eda_item.h.

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

References IS_CHANGED, IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

◆ GetEffectiveHoleShape()

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

overridevirtual

Return a SHAPE_SEGMENT object representing the pad's hole.

Reimplemented from BOARD_ITEM.

Definition at line 384 of file pad.cpp.

{
 if( m_shapesDirty )
 BuildEffectiveShapes( UNDEFINED_LAYER );
 
 return m_effectiveHoleShape;
}

References BuildEffectiveShapes(), m_effectiveHoleShape, m_shapesDirty, and UNDEFINED_LAYER.

Referenced by BOARD_ADAPTER::createPadWithDrill(), KIGFX::PCB_PAINTER::draw(), GetEffectiveShape(), DIALOG_PAD_PROPERTIES::padValuesOK(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and TransformHoleWithClearanceToPolygon().

◆ 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 97 of file board_connected_item.cpp.

{
 if( m_netinfo && m_netinfo->GetNetClass() )
 return m_netinfo->GetNetClass();
 else
 return GetBoard()->GetDesignSettings().m_NetSettings->m_DefaultNetClass.get();
}

References BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), NETINFO_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::m_netinfo, and BOARD_DESIGN_SETTINGS::m_NetSettings.

Referenced by PCB_VIA::GetDrillValue(), BOARD_INSPECTION_TOOL::getItemDescription(), GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClassName(), PCB_EXPR_NETCLASS_REF::GetValue(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetEffectivePolygon()

const std::shared_ptr< SHAPE_POLY_SET > & PAD::GetEffectivePolygon ( ) const

Definition at line 338 of file pad.cpp.

{
 if( m_polyDirty )
 BuildEffectivePolygon();
 
 return m_effectivePolygon;
}

References BuildEffectivePolygon(), m_effectivePolygon, and m_polyDirty.

Referenced by BOARD_ADAPTER::buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), HitTest(), and BRDITEMS_PLOTTER::PlotPad().

◆ GetEffectiveShape()

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

overridevirtual

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

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

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

Parameters

aLayer in case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.

Reimplemented from BOARD_ITEM.

Definition at line 347 of file pad.cpp.

{
 if( aLayer == Edge_Cuts )
 {
 if( GetAttribute() == PAD_ATTRIB::PTH || GetAttribute() == PAD_ATTRIB::NPTH )
 return GetEffectiveHoleShape();
 else
 return std::make_shared<SHAPE_NULL>();
 }
 
 if( GetAttribute() == PAD_ATTRIB::PTH )
 {
 bool flash;
 
 if( flashPTHPads == FLASHING::NEVER_FLASHED )
 flash = false;
 else if( flashPTHPads == FLASHING::ALWAYS_FLASHED )
 flash = true;
 else
 flash = FlashLayer( aLayer );
 
 if( !flash )
 {
 if( GetAttribute() == PAD_ATTRIB::PTH )
 return GetEffectiveHoleShape();
 else
 return std::make_shared<SHAPE_NULL>();
 }
 }
 
 if( m_shapesDirty )
 BuildEffectiveShapes( aLayer );
 
 return m_effectiveShape;
}

References ALWAYS_FLASHED, BuildEffectiveShapes(), Edge_Cuts, FlashLayer(), GetAttribute(), GetEffectiveHoleShape(), m_effectiveShape, m_shapesDirty, NEVER_FLASHED, NPTH, and PTH.

Referenced by BOARD_ADAPTER::createPadWithMargin(), KIGFX::PCB_PAINTER::draw(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 158 of file eda_item.h.

158{ return m_flags; }

References EDA_ITEM::m_flags.

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

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 270 of file eda_item.h.

270{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:263

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetKeepTopBottom()

bool PAD::GetKeepTopBottom ( ) const

inline

Definition at line 596 of file pad.h.

596{ return m_keepTopBottomLayer; }

References m_keepTopBottomLayer.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetLayer()

PCB_LAYER_ID PAD::GetLayer ( ) const

overridevirtual

Return the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Definition at line 217 of file pad.cpp.

{
 return BOARD_ITEM::GetLayer();
}

References BOARD_ITEM::GetLayer().

Referenced by DRC_TEST_PROVIDER_MISC::testDisabledLayers().

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

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

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

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

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

391{ return m_layerMask; }

References m_layerMask.

Referenced by KI_TEST::CheckFpPad(), doPushPadProperties(), PAD_TOOL::explodePad(), PCB_PLUGIN::format(), GetPrincipalLayer(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), IsOnCopperLayer(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), DIALOG_PAD_PROPERTIES::OnUpdateUINonCopperWarning(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), AR_MATRIX::PlacePad(), PAD_TOOL::RecombinePad(), PNS_KICAD_IFACE_BASE::syncPad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and ViewBBox().

◆ GetLocalClearance() [1/2]

int PAD::GetLocalClearance ( ) const

inline

Definition at line 413 of file pad.h.

413{ return m_localClearance; }

References m_localClearance.

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

◆ GetLocalClearance() [2/2]

int PAD::GetLocalClearance ( wxString * aSource ) const

overridevirtual

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

These are things like zone clearance which are not an override.

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 777 of file pad.cpp.

{
 if( aSource )
 *aSource = _( "pad" );
 
 return m_localClearance;
}

References _, and m_localClearance.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetLocalClearanceOverrides()

int PAD::GetLocalClearanceOverrides ( 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 763 of file pad.cpp.

{
 // A pad can have specific clearance that overrides its NETCLASS clearance value
 if( GetLocalClearance() )
 return GetLocalClearance( aSource );
 
 // A footprint can have a specific clearance value
 if( GetParent() && GetParent()->GetLocalClearance() )
 return GetParent()->GetLocalClearance( aSource );
 
 return 0;
}

References FOOTPRINT::GetLocalClearance(), GetLocalClearance(), and GetParent().

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 171 of file board_connected_item.h.

 {
 return m_localRatsnestVisible;
 }

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint().

◆ GetLocalSolderMaskMargin()

int PAD::GetLocalSolderMaskMargin ( ) const

inline

Definition at line 409 of file pad.h.

409{ return m_localSolderMaskMargin; }

References m_localSolderMaskMargin.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetLocalSolderPasteMargin()

int PAD::GetLocalSolderPasteMargin ( ) const

inline

Definition at line 416 of file pad.h.

416{ return m_localSolderPasteMargin; }

References m_localSolderPasteMargin.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetLocalSolderPasteMarginRatio()

double PAD::GetLocalSolderPasteMarginRatio ( ) const

inline

Definition at line 419 of file pad.h.

419{ return m_localSolderPasteMarginRatio; }

References m_localSolderPasteMarginRatio.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetLocalSpokeWidthOverride()

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

Definition at line 916 of file pad.cpp.

{
 if( m_thermalSpokeWidth > 0 && aSource )
 *aSource = _( "pad" );
 
 return m_thermalSpokeWidth;
}

References _, and m_thermalSpokeWidth.

◆ GetLocalThermalGapOverride()

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

Definition at line 925 of file pad.cpp.

{
 if( m_thermalGap > 0 && aSource )
 *aSource = _( "pad" );
 
 return m_thermalGap;
}

References _, and m_thermalGap.

Referenced by ZONE::GetThermalReliefGap().

◆ GetLocalZoneConnectionOverride()

ZONE_CONNECTION PAD::GetLocalZoneConnectionOverride ( wxString * aSource = nullptr ) const

Definition at line 907 of file pad.cpp.

{
 if( m_zoneConnection != ZONE_CONNECTION::INHERITED && aSource )
 *aSource = _( "pad" );
 
 return m_zoneConnection;
}

References _, INHERITED, and m_zoneConnection.

◆ 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 1267 of file pad.cpp.

{
 return BITMAPS::pad;
}

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

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 934 of file pad.cpp.

{
 wxString msg;
 FOOTPRINT* parentFootprint = static_cast<FOOTPRINT*>( m_parent );
 
 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
 {
 if( parentFootprint )
 aList.emplace_back( _( "Footprint" ), parentFootprint->GetReference() );
 }
 
 aList.emplace_back( _( "Pad" ), m_number );
 
 if( !GetPinFunction().IsEmpty() )
 aList.emplace_back( _( "Pin Name" ), GetPinFunction() );
 
 if( !GetPinType().IsEmpty() )
 aList.emplace_back( _( "Pin Type" ), GetPinType() );
 
 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
 {
 aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
 
 aList.emplace_back( _( "Resolved Netclass" ),
 UnescapeString( GetEffectiveNetClass()->GetName() ) );
 
 if( IsLocked() )
 aList.emplace_back( _( "Status" ), _( "Locked" ) );
 }
 
 if( GetAttribute() == PAD_ATTRIB::SMD || GetAttribute() == PAD_ATTRIB::CONN )
 aList.emplace_back( _( "Layer" ), layerMaskDescribe() );
 
 // Show the pad shape, attribute and property
 wxString props = ShowPadAttr();
 
 if( GetProperty() != PAD_PROP::NONE )
 props += ',';
 
 switch( GetProperty() )
 {
 case PAD_PROP::NONE: break;
 case PAD_PROP::BGA: props += _( "BGA" ); break;
 case PAD_PROP::FIDUCIAL_GLBL: props += _( "Fiducial global" ); break;
 case PAD_PROP::FIDUCIAL_LOCAL: props += _( "Fiducial local" ); break;
 case PAD_PROP::TESTPOINT: props += _( "Test point" ); break;
 case PAD_PROP::HEATSINK: props += _( "Heat sink" ); break;
 case PAD_PROP::CASTELLATED: props += _( "Castellated" ); break;
 }
 
 aList.emplace_back( ShowPadShape(), props );
 
 if( ( GetShape() == PAD_SHAPE::CIRCLE || GetShape() == PAD_SHAPE::OVAL )
 && m_size.x == m_size.y )
 {
 aList.emplace_back( _( "Diameter" ), aFrame->MessageTextFromValue( m_size.x ) );
 }
 else
 {
 aList.emplace_back( _( "Width" ), aFrame->MessageTextFromValue( m_size.x ) );
 aList.emplace_back( _( "Height" ), aFrame->MessageTextFromValue( m_size.y ) );
 }
 
 EDA_ANGLE fp_orient = parentFootprint ? parentFootprint->GetOrientation() : ANGLE_0;
 EDA_ANGLE pad_orient = GetOrientation() - fp_orient;
 pad_orient.Normalize180();
 
 if( !fp_orient.IsZero() )
 msg.Printf( wxT( "%g(+ %g)" ), pad_orient.AsDegrees(), fp_orient.AsDegrees() );
 else
 msg.Printf( wxT( "%g" ), GetOrientation().AsDegrees() );
 
 aList.emplace_back( _( "Rotation" ), msg );
 
 if( GetPadToDieLength() )
 {
 aList.emplace_back( _( "Length in Package" ),
 aFrame->MessageTextFromValue( GetPadToDieLength() ) );
 }
 
 if( m_drill.x > 0 || m_drill.y > 0 )
 {
 if( GetDrillShape() == PAD_DRILL_SHAPE_CIRCLE )
 {
 aList.emplace_back( _( "Hole" ),
 wxString::Format( wxT( "%s" ),
 aFrame->MessageTextFromValue( m_drill.x ) ) );
 }
 else
 {
 aList.emplace_back( _( "Hole X / Y" ),
 wxString::Format( wxT( "%s / %s" ),
 aFrame->MessageTextFromValue( m_drill.x ),
 aFrame->MessageTextFromValue( m_drill.y ) ) );
 }
 }
 
 wxString source;
 int clearance = GetOwnClearance( UNDEFINED_LAYER, &source );
 
 if( !source.IsEmpty() )
 {
 aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
 aFrame->MessageTextFromValue( clearance ) ),
 wxString::Format( _( "(from %s)" ),
 source ) );
 }
#if 0
 // useful for debug only
 aList.emplace_back( wxT( "UUID" ), m_Uuid.AsString() );
#endif
}

References _, ANGLE_0, EDA_ANGLE::AsDegrees(), KIID::AsString(), BGA, CASTELLATED, CIRCLE, CONN, FIDUCIAL_GLBL, FIDUCIAL_LOCAL, Format(), GetAttribute(), GetDrillShape(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), BOARD_CONNECTED_ITEM::GetNetname(), FOOTPRINT::GetOrientation(), GetOrientation(), GetOwnClearance(), GetPadToDieLength(), GetPinFunction(), GetPinType(), GetProperty(), FOOTPRINT::GetReference(), GetShape(), HEATSINK, IsLocked(), EDA_ANGLE::IsZero(), BOARD_ITEM::layerMaskDescribe(), m_drill, m_number, EDA_ITEM::m_parent, m_size, EDA_ITEM::m_Uuid, UNITS_PROVIDER::MessageTextFromValue(), NONE, EDA_ANGLE::Normalize180(), OVAL, PAD_DRILL_SHAPE_CIRCLE, PCB_EDIT_FRAME_NAME, ShowPadAttr(), ShowPadShape(), SMD, TESTPOINT, UNDEFINED_LAYER, UnescapeString(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetNet()

NETINFO_ITEM * BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Return #NET_INFO object for a given item.

Definition at line 75 of file board_connected_item.h.

 {
 return m_netinfo;
 }

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::RepairBoard(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow().

◆ 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 106 of file board_connected_item.cpp.

{
 return GetEffectiveNetClass()->GetName();
}

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

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and main().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const

inherited

Returns: the net code.

Definition at line 89 of file board_connected_item.cpp.

{
 return m_netinfo ? m_netinfo->GetNetCode() : -1;
}

References NETINFO_ITEM::GetNetCode(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ZONE_FILLER::buildCopperItemClearances(), KI_TEST::CheckFpPad(), KI_TEST::CheckFpZone(), connectedItemFilter(), CreateRoutesSection(), TEARDROP_MANAGER::createTeardrop(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), PNS::NODE::FindItemByParent(), TEARDROP_MANAGER::findTouchingTrack(), PCB_PLUGIN::format(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), CONNECTIVITY_DATA::GetConnectedItems(), ZONE::GetInteractingZones(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), CONNECTIVITY_DATA::GetRatsnestForPad(), BOARD_INSPECTION_TOOL::highlightNet(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), CONNECTIVITY_DATA::IsConnectedOnLayer(), ZONE::IsIsland(), ZONE::IsSame(), TEARDROP_MANAGER::isViaAndTrackInSameZone(), ZONE_FILLER::knockoutThermalReliefs(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), CN_ITEM::Net(), DIALOG_DRC::OnDRCItemSelected(), PCB_TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), ZONE::SameNet(), PCB_SELECTION_CONDITIONS::sameNetFunc(), SaveCopyOfZones(), PCB_SELECTION_TOOL::selectNet(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), BOARD::TracksInNet(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_CONTROL::UpdateMessagePanel(), VIAPAD::VIAPAD(), PCB_TRACK::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 112 of file board_connected_item.cpp.

{
 return m_netinfo ? m_netinfo->GetNetname() : wxString();
}

References NETINFO_ITEM::GetNetname(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), ZONE_SEARCH_HANDLER::GetResultCell(), PCB_EXPR_NETNAME_REF::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), CN_CLUSTER::OriginNetName(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotPad(), 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 118 of file board_connected_item.cpp.

{
 if( !GetBoard() )
 return wxT( "[** NO BOARD DEFINED **]" );
 
 wxString netname = GetNetname();
 
 if( !netname.length() )
 return wxT( "[<no net>]" );
 else if( GetNetCode() < 0 )
 return wxT( "[" ) + UnescapeString( netname ) + wxT( "](" ) + _( "Not Found" ) + wxT( ")" );
 else
 return wxT( "[" ) + UnescapeString( netname ) + wxT( "]" );
}

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

Referenced by GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), PCB_VIA::GetSelectMenuText(), and ZONE::GetSelectMenuText().

◆ GetNumber()

const wxString & PAD::GetNumber ( ) const

inline

◆ GetOffset()

const VECTOR2I & PAD::GetOffset ( ) const

inline

Definition at line 268 of file pad.h.

268{ return m_offset; }

References m_offset.

Referenced by KI_TEST::CheckFpPad(), FlashLayer(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::SPECCTRA_DB::makePADSTACK(), mirrorPadX(), mirrorPadY(), DIALOG_PAD_PROPERTIES::OnOffsetCheckbox(), padsNeedUpdate(), PNS_KICAD_IFACE_BASE::syncPad(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetOrientation()

EDA_ANGLE PAD::GetOrientation ( ) const

inline

Return the rotation angle of the pad.

Definition at line 364 of file pad.h.

364{ return m_orient; }

References m_orient.

Referenced by KI_TEST::CheckFpPad(), doPushPadProperties(), PAD_TOOL::explodePad(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), Flip(), PCB_PLUGIN::format(), GetMsgPanelInfo(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), RENDER_3D_RAYTRACE::insertHole(), mirrorPadX(), mirrorPadY(), padsNeedUpdate(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), PAD_TOOL::RecombinePad(), DIALOG_PAD_PROPERTIES::redraw(), PNS_KICAD_IFACE_BASE::syncPad(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetOrientationDegrees()

double PAD::GetOrientationDegrees ( ) const

inline

Definition at line 371 of file pad.h.

 {
 return m_orient.AsDegrees();
 }

References EDA_ANGLE::AsDegrees(), and m_orient.

Referenced by PAD_DESC::PAD_DESC().

◆ GetOwnClearance()

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

overridevirtual

Return an item'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 786 of file pad.cpp.

{
 DRC_CONSTRAINT c;
 
 if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
 {
 BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();
 
 if( GetAttribute() == PAD_ATTRIB::NPTH )
 c = bds.m_DRCEngine->EvalRules( HOLE_CLEARANCE_CONSTRAINT, this, nullptr, aLayer );
 else
 c = bds.m_DRCEngine->EvalRules( CLEARANCE_CONSTRAINT, this, nullptr, aLayer );
 }
 
 if( c.Value().HasMin() )
 {
 if( aSource )
 *aSource = c.GetName();
 
 return c.Value().Min();
 }
 
 return 0;
}

References CLEARANCE_CONSTRAINT, GetAttribute(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), DRC_CONSTRAINT::GetName(), MINOPTMAX< T >::HasMin(), HOLE_CLEARANCE_CONSTRAINT, BOARD_DESIGN_SETTINGS::m_DRCEngine, MINOPTMAX< T >::Min(), NPTH, and DRC_CONSTRAINT::Value().

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

◆ GetPadToDieLength()

int PAD::GetPadToDieLength ( ) const

inline

Definition at line 407 of file pad.h.

407{ return m_lengthPadToDie; }

References m_lengthPadToDie.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), GetMsgPanelInfo(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::OnPadToDieCheckbox(), operator=(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), PNS_KICAD_IFACE_BASE::syncPad(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetParent()

FOOTPRINT * PAD::GetParent ( void ) const

Definition at line 1464 of file pad.cpp.

{
 return dyn_cast<FOOTPRINT*>( m_parent );
}

References EDA_ITEM::m_parent.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), doPushPadProperties(), GetLocalClearanceOverrides(), GetSelectMenuText(), GetSolderMaskExpansion(), GetSolderPasteMargin(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), IsFlipped(), IsLocked(), PAD(), padsNeedUpdate(), BRDITEMS_PLOTTER::PlotPad(), PAD_TOOL::pushPadSettings(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), EAGLE_PLUGIN::transferPad(), and ViewGetLayers().

◆ GetParentAsString()

wxString PAD::GetParentAsString ( ) const

inline

Definition at line 112 of file pad.h.

112{ return m_parent->m_Uuid.AsString(); }

References KIID::AsString(), EDA_ITEM::m_parent, and EDA_ITEM::m_Uuid.

Referenced by PAD_DESC::PAD_DESC().

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 217 of file board_item.cpp.

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

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

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

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 64 of file board_item.h.

64{ return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:324

References BOARD_ITEM::m_group.

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

◆ GetPinFunction()

const wxString & PAD::GetPinFunction ( ) const

inline

Definition at line 145 of file pad.h.

145{ return m_pinFunction; }

PAD::m_pinFunction

wxString m_pinFunction

Definition: pad.h:718

References m_pinFunction.

Referenced by KI_TEST::CheckFpPad(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_PLUGIN::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 151 of file pad.h.

151{ return m_pinType; }

PAD::m_pinType

wxString m_pinType

Definition: pad.h:719

References m_pinType.

Referenced by KI_TEST::CheckFpPad(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_PLUGIN::format(), GetMsgPanelInfo(), operator=(), and PAD_DESC::PAD_DESC().

◆ GetPos0()

const VECTOR2I & PAD::GetPos0 ( ) const

inline

Definition at line 245 of file pad.h.

245{ return m_pos0; }

References m_pos0.

Referenced by MICROWAVE_TOOL::createPolygonShape(), PCB_PLUGIN::format(), FOOTPRINT::cmp_pads::operator()(), operator=(), and padsNeedUpdate().

◆ GetPosition()

VECTOR2I PAD::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 196 of file pad.h.

196{ return m_pos; }

References m_pos.

Referenced by KI_TEST::CheckFpPad(), FOOTPRINT::CheckNetTies(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), AR_AUTOPLACER::computePlacementRatsnestCost(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), GetCenter(), HitTest(), DIALOG_PAD_PROPERTIES::initValues(), RENDER_3D_RAYTRACE::insertHole(), mirrorPadX(), mirrorPadY(), AR_AUTOPLACER::nearestPad(), operator=(), DIALOG_PAD_PROPERTIES::padValuesOK(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PAD_TOOL::RecombinePad(), DIALOG_PAD_PROPERTIES::redraw(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DIALOG_FOOTPRINT_CHECKER::runChecks(), sortPadsByXthenYCoord(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and VIAPAD::VIAPAD().

◆ GetPrimitives()

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

inline

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

Definition at line 324 of file pad.h.

 {
 return m_editPrimitives;
 }

References m_editPrimitives.

Referenced by KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetPrincipalLayer()

PCB_LAYER_ID PAD::GetPrincipalLayer ( ) const

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

Definition at line 223 of file pad.cpp.

{
 if( m_attribute == PAD_ATTRIB::SMD || m_attribute == PAD_ATTRIB::CONN || GetLayerSet().none() )
 return m_layer;
 else
 return GetLayerSet().Seq().front();
 
}

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

Referenced by DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run().

◆ GetProperty()

PAD_PROP PAD::GetProperty ( ) const

inline

Definition at line 397 of file pad.h.

397{ return m_property; }

PAD::m_property

PAD_PROP m_property

Definition: pad.h:789

References m_property.

Referenced by KI_TEST::CheckFpPad(), FlashLayer(), PCB_PLUGIN::format(), GetMsgPanelInfo(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), BRDITEMS_PLOTTER::PlotPad(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ GetRemoveUnconnected()

bool PAD::GetRemoveUnconnected ( ) const

inline

Definition at line 590 of file pad.h.

590{ return m_removeUnconnectedLayer; }

References m_removeUnconnectedLayer.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetRoundRectCornerRadius()

int PAD::GetRoundRectCornerRadius ( ) const

Definition at line 307 of file pad.cpp.

{
 return KiROUND( std::min( m_size.x, m_size.y ) * m_roundedCornerScale );
}

References KiROUND(), m_roundedCornerScale, m_size, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BuildEffectiveShapes(), DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), padsNeedUpdate(), BRDITEMS_PLOTTER::PlotPad(), TransformShapeWithClearanceToPolygon(), and DIALOG_PAD_PROPERTIES::updateRoundRectCornerValues().

◆ GetRoundRectRadiusRatio()

double PAD::GetRoundRectRadiusRatio ( ) const

inline

Definition at line 556 of file pad.h.

556{ return m_roundedCornerScale; }

References m_roundedCornerScale.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::onCornerRadiusChange(), DIALOG_PAD_PROPERTIES::OnPadShapeSelection(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::updateRoundRectCornerValues().

◆ GetSelectMenuText()

wxString PAD::GetSelectMenuText ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 1220 of file pad.cpp.

{
 if( GetNumber().IsEmpty() )
 {
 if( GetAttribute() == PAD_ATTRIB::SMD || GetAttribute() == PAD_ATTRIB::CONN )
 {
 return wxString::Format( _( "Pad %s of %s on %s" ),
 GetNetnameMsg(),
 GetParent()->GetReference(),
 layerMaskDescribe() );
 }
 else if( GetAttribute() == PAD_ATTRIB::NPTH )
 {
 return wxString::Format( _( "NPTH pad of %s" ), GetParent()->GetReference() );
 }
 else
 {
 return wxString::Format( _( "PTH pad %s of %s" ),
 GetNetnameMsg(),
 GetParent()->GetReference() );
 }
 }
 else
 {
 if( GetAttribute() == PAD_ATTRIB::SMD || GetAttribute() == PAD_ATTRIB::CONN )
 {
 return wxString::Format( _( "Pad %s %s of %s on %s" ),
 GetNumber(),
 GetNetnameMsg(),
 GetParent()->GetReference(),
 layerMaskDescribe() );
 }
 else if( GetAttribute() == PAD_ATTRIB::NPTH )
 {
 return wxString::Format( _( "NPTH of %s" ), GetParent()->GetReference() );
 }
 else
 {
 return wxString::Format( _( "PTH pad %s %s of %s" ),
 GetNumber(),
 GetNetnameMsg(),
 GetParent()->GetReference() );
 }
 }
}

References _, CONN, Format(), GetAttribute(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), GetNumber(), GetParent(), BOARD_ITEM::layerMaskDescribe(), NPTH, and SMD.

◆ GetShape()

PAD_SHAPE PAD::GetShape ( ) const

inline

Returns: the shape of this pad.

Definition at line 188 of file pad.h.

188{ return m_padShape; }

PAD::m_padShape

PAD_SHAPE m_padShape

Definition: pad.h:723

References m_padShape.

Referenced by ZONE_FILLER::addKnockout(), BuildEffectiveShapes(), BOARD_ADAPTER::buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), KI_TEST::CheckFpPad(), Compare(), BOARD_ADAPTER::createPadWithMargin(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), FlashLayer(), PCB_PLUGIN::format(), GetMsgPanelInfo(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makePADSTACK(), mirrorPadX(), mirrorPadY(), DIALOG_PAD_PROPERTIES::onCornerRadiusChange(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), FOOTPRINT::cmp_pads::operator()(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), DIALOG_PAD_PROPERTIES::padValuesOK(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), PAD_TOOL::RecombinePad(), ShowPadShape(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), TransformShapeWithClearanceToPolygon(), and VIAPAD::VIAPAD().

◆ GetShortNetname()

wxString BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

Definition at line 134 of file board_connected_item.cpp.

{
 return m_netinfo->GetShortNetname();
}

References NETINFO_ITEM::GetShortNetname(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by KIGFX::PCB_PAINTER::draw(), IsFreePad(), and IsNoConnectPad().

◆ GetSize()

const VECTOR2I & PAD::GetSize ( ) const

inline

◆ GetSizeX()

int PAD::GetSizeX ( ) const

inline

Definition at line 253 of file pad.h.

253{ return m_size.x; }

References m_size, and VECTOR2< T >::x.

Referenced by PAD_DESC::PAD_DESC(), and PAD_TOOL::RecombinePad().

◆ GetSizeY()

int PAD::GetSizeY ( ) const

inline

Definition at line 255 of file pad.h.

255{ return m_size.y; }

References m_size, and VECTOR2< T >::y.

Referenced by PAD_DESC::PAD_DESC(), and PAD_TOOL::RecombinePad().

◆ GetSolderMaskExpansion()

int PAD::GetSolderMaskExpansion ( ) 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 812 of file pad.cpp.

{
 // The pad inherits the margin only to calculate a default shape,
 // therefore only if it is also a copper layer
 // Pads defined only on mask layers (and perhaps on other tech layers) use the shape
 // defined by the pad settings only
 bool isOnCopperLayer = ( m_layerMask & LSET::AllCuMask() ).any();
 
 if( !isOnCopperLayer )
 return 0;
 
 int margin = m_localSolderMaskMargin;
 
 FOOTPRINT* parentFootprint = GetParent();
 
 if( parentFootprint )
 {
 if( margin == 0 )
 {
 if( parentFootprint->GetLocalSolderMaskMargin() )
 margin = parentFootprint->GetLocalSolderMaskMargin();
 }
 
 if( margin == 0 )
 {
 const BOARD* brd = GetBoard();
 
 if( brd )
 margin = brd->GetDesignSettings().m_SolderMaskExpansion;
 }
 }
 
 // ensure mask have a size always >= 0
 if( margin < 0 )
 {
 int minsize = -std::min( m_size.x, m_size.y ) / 2;
 
 if( margin < minsize )
 margin = minsize;
 }
 
 return margin;
}

References LSET::AllCuMask(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), FOOTPRINT::GetLocalSolderMaskMargin(), GetParent(), m_layerMask, m_localSolderMaskMargin, m_size, BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ GetSolderPasteMargin()

VECTOR2I PAD::GetSolderPasteMargin ( ) 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 857 of file pad.cpp.

{
 // The pad inherits the margin only to calculate a default shape,
 // therefore only if it is also a copper layer.
 // Pads defined only on mask layers (and perhaps on other tech layers) use the shape
 // defined by the pad settings only
 bool isOnCopperLayer = ( m_layerMask & LSET::AllCuMask() ).any();
 
 if( !isOnCopperLayer )
 return VECTOR2I( 0, 0 );
 
 int margin = m_localSolderPasteMargin;
 double mratio = m_localSolderPasteMarginRatio;
 
 FOOTPRINT* parentFootprint = GetParent();
 
 if( parentFootprint )
 {
 if( margin == 0 )
 margin = parentFootprint->GetLocalSolderPasteMargin();
 
 auto brd = GetBoard();
 
 if( margin == 0 && brd )
 margin = brd->GetDesignSettings().m_SolderPasteMargin;
 
 if( mratio == 0.0 )
 mratio = parentFootprint->GetLocalSolderPasteMarginRatio();
 
 if( mratio == 0.0 && brd )
 {
 mratio = brd->GetDesignSettings().m_SolderPasteMarginRatio;
 }
 }
 
 VECTOR2I pad_margin;
 pad_margin.x = margin + KiROUND( m_size.x * mratio );
 pad_margin.y = margin + KiROUND( m_size.y * mratio );
 
 // ensure mask have a size always >= 0
 if( pad_margin.x < -m_size.x / 2 )
 pad_margin.x = -m_size.x / 2;
 
 if( pad_margin.y < -m_size.y / 2 )
 pad_margin.y = -m_size.y / 2;
 
 return pad_margin;
}

References LSET::AllCuMask(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetLocalSolderPasteMargin(), FOOTPRINT::GetLocalSolderPasteMarginRatio(), GetParent(), KiROUND(), m_layerMask, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_size, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by KIGFX::PCB_PAINTER::draw(), 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 279 of file eda_item.h.

279{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 140 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 153 of file eda_item.h.

153{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 76 of file board_item.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog().

◆ GetSubRatsnest()

int PAD::GetSubRatsnest ( ) const

inline

Returns: the netcode.

Definition at line 580 of file pad.h.

580{ return m_subRatsnest; }

PAD::m_subRatsnest

int m_subRatsnest

Definition: pad.h:751

References m_subRatsnest.

Referenced by operator=().

◆ GetThermalGap()

int PAD::GetThermalGap ( ) const

inline

Definition at line 535 of file pad.h.

535{ return m_thermalGap; }

References m_thermalGap.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetThermalSpokeAngle()

EDA_ANGLE PAD::GetThermalSpokeAngle ( ) const

inline

Definition at line 522 of file pad.h.

522{ return m_thermalSpokeAngle; }

References m_thermalSpokeAngle.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), padsNeedUpdate(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetThermalSpokeAngleDegrees()

double PAD::GetThermalSpokeAngleDegrees ( ) const

inline

Definition at line 529 of file pad.h.

 {
 return m_thermalSpokeAngle.AsDegrees();
 }

References EDA_ANGLE::AsDegrees(), and m_thermalSpokeAngle.

Referenced by PAD_DESC::PAD_DESC().

◆ GetThermalSpokeWidth()

int PAD::GetThermalSpokeWidth ( ) const

inline

Definition at line 512 of file pad.h.

512{ return m_thermalSpokeWidth; }

References m_thermalSpokeWidth.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), padsNeedUpdate(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( )

inherited

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

Definition at line 301 of file eda_item.cpp.

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

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

Referenced by PROPERTIES_PANEL::update().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 68 of file board_item.h.

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

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

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 74 of file board_item.h.

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

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

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

◆ GetZoneConnection()

ZONE_CONNECTION PAD::GetZoneConnection ( ) const

inline

Definition at line 503 of file pad.h.

503{ return m_zoneConnection; }

References m_zoneConnection.

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), padsNeedUpdate(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 159 of file eda_item.h.

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

References EDA_ITEM::m_flags.

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

◆ HasHole()

bool PAD::HasHole ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 105 of file pad.h.

 {
 return GetDrillSizeX() > 0 && GetDrillSizeY() > 0;
 }

References GetDrillSizeX(), and GetDrillSizeY().

Referenced by BOARD_ADAPTER::createPadWithDrill(), IsType(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

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

161{ return false; }

◆ HitTest() [1/2]

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 1060 of file pad.cpp.

{
 BOX2I arect = aRect;
 arect.Normalize();
 arect.Inflate( aAccuracy );
 
 BOX2I bbox = GetBoundingBox();
 
 if( aContained )
 {
 return arect.Contains( bbox );
 }
 else
 {
 // Fast test: if aRect is outside the polygon bounding box,
 // rectangles cannot intersect
 if( !arect.Intersects( bbox ) )
 return false;
 
 const std::shared_ptr<SHAPE_POLY_SET>& poly = GetEffectivePolygon();
 
 int count = poly->TotalVertices();
 
 for( int ii = 0; ii < count; ii++ )
 {
 VECTOR2I vertex = poly->CVertex( ii );
 VECTOR2I vertexNext = poly->CVertex( ( ii + 1 ) % count );
 
 // Test if the point is within aRect
 if( arect.Contains( vertex ) )
 return true;
 
 // Test if this edge intersects aRect
 if( arect.Intersects( vertex, vertexNext ) )
 return true;
 }
 
 return false;
 }
}

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

◆ HitTest() [2/2]

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 1048 of file pad.cpp.

{
 VECTOR2I delta = aPosition - GetPosition();
 int boundingRadius = GetBoundingRadius() + aAccuracy;
 
 if( delta.SquaredEuclideanNorm() > SEG::Square( boundingRadius ) )
 return false;
 
 return GetEffectivePolygon()->Contains( aPosition, -1, aAccuracy );
}

References delta, GetBoundingRadius(), GetEffectivePolygon(), GetPosition(), 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 1470 of file pad.cpp.

{
 SetShape( aMasterPad.GetShape() );
 SetLayerSet( aMasterPad.GetLayerSet() );
 SetAttribute( aMasterPad.GetAttribute() );
 SetProperty( aMasterPad.GetProperty() );
 
 // I am not sure the m_LengthPadToDie should be imported, because this is a parameter
 // really specific to a given pad (JPC).
#if 0
 SetPadToDieLength( aMasterPad.GetPadToDieLength() );
#endif
 
 // The pad orientation, for historical reasons is the pad rotation + parent rotation.
 EDA_ANGLE pad_rot = aMasterPad.GetOrientation();
 
 if( aMasterPad.GetParent() )
 pad_rot -= aMasterPad.GetParent()->GetOrientation();
 
 if( GetParent() )
 pad_rot += GetParent()->GetOrientation();
 
 SetOrientation( pad_rot );
 
 SetSize( aMasterPad.GetSize() );
 SetDelta( VECTOR2I( 0, 0 ) );
 SetOffset( aMasterPad.GetOffset() );
 SetDrillSize( aMasterPad.GetDrillSize() );
 SetDrillShape( aMasterPad.GetDrillShape() );
 SetRoundRectRadiusRatio( aMasterPad.GetRoundRectRadiusRatio() );
 SetChamferRectRatio( aMasterPad.GetChamferRectRatio() );
 SetChamferPositions( aMasterPad.GetChamferPositions() );
 
 switch( aMasterPad.GetShape() )
 {
 case PAD_SHAPE::TRAPEZOID:
 SetDelta( aMasterPad.GetDelta() );
 break;
 
 case PAD_SHAPE::CIRCLE:
 // ensure size.y == size.x
 SetSize( VECTOR2I( GetSize().x, GetSize().x ) );
 break;
 
 default:
 ;
 }
 
 switch( aMasterPad.GetAttribute() )
 {
 case PAD_ATTRIB::SMD:
 case PAD_ATTRIB::CONN:
 // These pads do not have a hole (they are expected to be on one external copper layer)
 SetDrillSize( VECTOR2I( 0, 0 ) );
 break;
 
 default:
 ;
 }
 
 // copy also local settings:
 SetLocalClearance( aMasterPad.GetLocalClearance() );
 SetLocalSolderMaskMargin( aMasterPad.GetLocalSolderMaskMargin() );
 SetLocalSolderPasteMargin( aMasterPad.GetLocalSolderPasteMargin() );
 SetLocalSolderPasteMarginRatio( aMasterPad.GetLocalSolderPasteMarginRatio() );
 
 SetZoneConnection( aMasterPad.GetZoneConnection() );
 SetThermalSpokeWidth( aMasterPad.GetThermalSpokeWidth() );
 SetThermalSpokeAngle( aMasterPad.GetThermalSpokeAngle() );
 SetThermalGap( aMasterPad.GetThermalGap() );
 
 SetCustomShapeInZoneOpt( aMasterPad.GetCustomShapeInZoneOpt() );
 
 // Add or remove custom pad shapes:
 ReplacePrimitives( aMasterPad.GetPrimitives() );
 SetAnchorPadShape( aMasterPad.GetAnchorPadShape() );
 
 SetDirty();
}

References CIRCLE, CONN, GetAnchorPadShape(), GetAttribute(), GetChamferPositions(), GetChamferRectRatio(), GetCustomShapeInZoneOpt(), GetDelta(), GetDrillShape(), GetDrillSize(), GetLayerSet(), GetLocalClearance(), GetLocalSolderMaskMargin(), GetLocalSolderPasteMargin(), GetLocalSolderPasteMarginRatio(), GetOffset(), FOOTPRINT::GetOrientation(), GetOrientation(), GetPadToDieLength(), GetParent(), GetPrimitives(), GetProperty(), GetRoundRectRadiusRatio(), GetShape(), GetSize(), GetThermalGap(), GetThermalSpokeAngle(), GetThermalSpokeWidth(), GetZoneConnection(), ReplacePrimitives(), SetAnchorPadShape(), SetAttribute(), SetChamferPositions(), SetChamferRectRatio(), SetCustomShapeInZoneOpt(), SetDelta(), SetDirty(), SetDrillShape(), SetDrillSize(), SetLayerSet(), SetLocalClearance(), SetLocalSolderMaskMargin(), SetLocalSolderPasteMargin(), SetLocalSolderPasteMarginRatio(), SetOffset(), SetOrientation(), SetPadToDieLength(), SetProperty(), SetRoundRectRadiusRatio(), SetShape(), SetSize(), SetThermalGap(), SetThermalSpokeAngle(), SetThermalSpokeWidth(), SetZoneConnection(), SMD, and TRAPEZOID.

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

◆ IsAperturePad()

bool PAD::IsAperturePad ( ) const

inline

Definition at line 401 of file pad.h.

 {
 return ( m_layerMask & LSET::AllCuMask() ).none();
 }

References LSET::AllCuMask(), and m_layerMask.

Referenced by CanHaveNumber(), doPushPadProperties(), and DIALOG_PAD_PROPERTIES::initValues().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

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

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

Definition at line 67 of file board_connected_item.h.

 {
 return true;
 }

◆ IsDirty()

bool PAD::IsDirty ( ) const

inline

Definition at line 379 of file pad.h.

 {
 return m_shapesDirty || m_polyDirty;
 }

References m_polyDirty, and m_shapesDirty.

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:73

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_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 209 of file pad.cpp.

{
 FOOTPRINT* parent = GetParent();
 
 return ( parent && parent->GetLayer() == B_Cu );
}

References B_Cu, BOARD_ITEM::GetLayer(), and GetParent().

Referenced by DIALOG_PAD_PROPERTIES::initValues(), and ViewGetLOD().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 217 of file eda_item.h.

217{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:511

References EDA_ITEM::m_forceVisible.

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

◆ 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 167 of file pad.cpp.

{
 return GetShortNetname().StartsWith( wxT( "unconnected-(" ) )
 && m_pinType == wxT( "free" );
}

References BOARD_CONNECTED_ITEM::GetShortNetname(), and m_pinType.

Referenced by KIGFX::PCB_PAINTER::draw(), isMaskAperture(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Definition at line 239 of file board_item.h.

239{ return m_isKnockout; }

BOARD_ITEM::m_isKnockout

bool m_isKnockout

Definition: board_item.h:320

References BOARD_ITEM::m_isKnockout.

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

◆ IsLocked()

bool PAD::IsLocked ( ) const

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 151 of file pad.cpp.

{
 if( GetParent() && GetParent()->IsLocked() )
 return true;
 
 return BOARD_ITEM::IsLocked();
};

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

Referenced by KI_TEST::CheckFpPad(), PCB_PLUGIN::format(), GetMsgPanelInfo(), and IsLocked().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 116 of file eda_item.h.

116{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

117{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ 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 160 of file pad.cpp.

{
 return GetShortNetname().StartsWith( wxT( "unconnected-(" ) )
 && ( m_pinType == wxT( "no_connect" ) || m_pinType.EndsWith( wxT( "+no_connect" ) ) );
}

References BOARD_CONNECTED_ITEM::GetShortNetname(), and m_pinType.

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

◆ IsOnCopperLayer()

bool PAD::IsOnCopperLayer ( ) const

inlineoverridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 236 of file pad.h.

 {
 return ( GetLayerSet() & LSET::AllCuMask() ) != 0;
 }

References LSET::AllCuMask(), and GetLayerSet().

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), and DIALOG_PAD_PROPERTIES::padValuesOK().

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

 {
 return m_layerMask[aLayer];
 }

References m_layerMask.

Referenced by AR_AUTOPLACER::addPad(), PAD_TOOL::explodePad(), FlashLayer(), DSN::SPECCTRA_DB::makePADSTACK(), PAD_TOOL::RecombinePad(), 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 LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 434 of file eda_item.h.

434{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

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

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), KIGFX::SCH_PAINTER::nonCached(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), EE_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), RENDER_3D_OPENGL::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), GERBVIEW_SELECTION_TOOL::unselect(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 189 of file eda_item.h.

189{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:55

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( ) const

inlinevirtualinherited

Reimplemented in PCB_VIA.

Definition at line 125 of file board_item.h.

 {
 return false;
 }

Referenced by BOARD_INSPECTION_TOOL::InspectClearance(), 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 84 of file pad.h.

 {
 if( BOARD_CONNECTED_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( HasHole() )
 {
 if( scanType == PCB_LOCATE_HOLE_T )
 return true;
 else if( scanType == PCB_LOCATE_PTH_T && m_attribute != PAD_ATTRIB::NPTH )
 return true;
 else if( scanType == PCB_LOCATE_NPTH_T && m_attribute == PAD_ATTRIB::NPTH )
 return true;
 }
 }
 
 return false;
 }

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

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

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 336 of file eda_item.h.

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

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 100 of file board_item.cpp.

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

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

Referenced by GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), and GetSelectMenuText().

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 396 of file eda_item.h.

 {
 return false;
 }

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 117 of file eda_item.cpp.

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

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

◆ MergePrimitivesAsPolygon()

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

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 229 of file pad_custom_shape_functions.cpp.

{
 const BOARD* board = GetBoard();
 int maxError = board ? board->GetDesignSettings().m_MaxError : ARC_HIGH_DEF;
 
 aMergedPolygon->RemoveAllContours();
 
 // Add the anchor pad shape in aMergedPolygon, others in aux_polyset:
 // The anchor pad is always at 0,0
 switch( GetAnchorPadShape() )
 {
 case PAD_SHAPE::RECT:
 {
 SHAPE_RECT rect( -GetSize().x / 2, -GetSize().y / 2, GetSize().x, GetSize().y );
 aMergedPolygon->AddOutline( rect.Outline() );
 }
 break;
 
 default:
 case PAD_SHAPE::CIRCLE:
 TransformCircleToPolygon( *aMergedPolygon, wxPoint( 0, 0 ), GetSize().x / 2, maxError,
 aErrorLoc );
 break;
 }
 
 addPadPrimitivesToPolygon( aMergedPolygon, maxError, aErrorLoc );
}

References SHAPE_POLY_SET::AddOutline(), addPadPrimitivesToPolygon(), ARC_HIGH_DEF, CIRCLE, GetAnchorPadShape(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), GetSize(), BOARD_DESIGN_SETTINGS::m_MaxError, SHAPE_RECT::Outline(), RECT, SHAPE_POLY_SET::RemoveAllContours(), and TransformCircleToPolygon().

Referenced by DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PAD_PROPERTIES::padValuesOK(), and TransformShapeWithClearanceToPolygon().

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

 {
 m_pos += aMoveVector;
 SetLocalCoord();
 SetDirty();
 }

References m_pos, SetDirty(), and SetLocalCoord().

◆ operator<()

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

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

Definition at line 231 of file eda_item.cpp.

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

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

◆ operator=()

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

Definition at line 117 of file pad.cpp.

{
 BOARD_CONNECTED_ITEM::operator=( aOther );
 
 ImportSettingsFrom( aOther );
 SetPadToDieLength( aOther.GetPadToDieLength() );
 SetPosition( aOther.GetPosition() );
 SetPos0( aOther.GetPos0() );
 SetNumber( aOther.GetNumber() );
 SetPinType( aOther.GetPinType() );
 SetPinFunction( aOther.GetPinFunction() );
 SetSubRatsnest( aOther.GetSubRatsnest() );
 m_effectiveBoundingRadius = aOther.m_effectiveBoundingRadius;
 m_removeUnconnectedLayer = aOther.m_removeUnconnectedLayer;
 m_keepTopBottomLayer = aOther.m_keepTopBottomLayer;
 
 return *this;
}

References GetNumber(), GetPadToDieLength(), GetPinFunction(), GetPinType(), GetPos0(), GetPosition(), GetSubRatsnest(), ImportSettingsFrom(), m_effectiveBoundingRadius, m_keepTopBottomLayer, m_removeUnconnectedLayer, EDA_ITEM::operator=(), SetNumber(), SetPadToDieLength(), SetPinFunction(), SetPinType(), SetPos0(), SetPosition(), and SetSubRatsnest().

Referenced by PAD().

◆ PTHMask()

LSET PAD::PTHMask ( )

static

layer set for a through hole pad

Definition at line 174 of file pad.cpp.

{
 static LSET saved = LSET::AllCuMask() | LSET( 2, F_Mask, B_Mask );
 return saved;
}

References LSET::AllCuMask(), B_Mask, and F_Mask.

Referenced by ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper(), FABMASTER::loadFootprints(), PAD(), PAD_TOOL::PlacePad(), and DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 179 of file eda_item.h.

179{ return false; }

◆ 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 LIB_TEXTBOX, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 423 of file eda_item.h.

 {
 return false;
 }

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.matchCase )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }
 
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }
 
 if( next > ii )
 result += aText.Mid( ii, next - ii );
 
 ii = next;
 next += searchText.length();
 
 bool startOK;
 bool endOK;
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }
 
 if( startOK && endOK )
 {
 result += aSearchData.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

References EDA_SEARCH_DATA::findString, EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::replaceString, text, and WHOLEWORD.

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

◆ ReplacePrimitives()

void PAD::ReplacePrimitives ( 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 164 of file pad_custom_shape_functions.cpp.

{
 // clear old list
 DeletePrimitivesList();
 
 // Import to the given shape list
 if( aPrimitivesList.size() )
 AppendPrimitives( aPrimitivesList );
 
 SetDirty();
}

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

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

◆ Rotate()

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

overridevirtual

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from BOARD_ITEM.

Definition at line 1178 of file pad.cpp.

{
 RotatePoint( m_pos, aRotCentre, aAngle );
 
 m_orient += aAngle;
 m_orient.Normalize();
 
 SetLocalCoord();
 
 SetDirty();
}

References m_orient, m_pos, EDA_ANGLE::Normalize(), RotatePoint(), SetDirty(), and SetLocalCoord().

◆ SameLogicalPadAs()

bool PAD::SameLogicalPadAs ( const PAD * other ) 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 157 of file pad.h.

 {
 // hide tricks behind sensible API
 return GetParentFootprint() == other->GetParentFootprint()
 && !m_number.IsEmpty() && m_number == other->m_number;
 }

References BOARD_ITEM::GetParentFootprint(), and m_number.

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;
 
 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 prop->set<T>( object, aValue );
 }
 
 return object != nullptr;
 }

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->set<T>( object, aValue );
 
 return object != nullptr;
 }

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->setter( object, aValue );
 
 return object != nullptr;
 }

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetAnchorPadShape()

void PAD::SetAnchorPadShape ( PAD_SHAPE aShape )

inline

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

Parameters

aShape is the shape of the anchor pad shape( currently, only PAD_SHAPE::RECT or PAD_SHAPE::CIRCLE.

Definition at line 227 of file pad.h.

 {
 m_anchorPadShape = ( aShape == PAD_SHAPE::RECT ) ? PAD_SHAPE::RECT : PAD_SHAPE::CIRCLE;
 SetDirty();
 }

References CIRCLE, m_anchorPadShape, RECT, and SetDirty().

Referenced by ImportSettingsFrom(), PAD(), PCB_PARSER::parsePAD_option(), PAD_TOOL::RecombinePad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetAttribute()

void PAD::SetAttribute ( PAD_ATTRIB aAttribute )

Definition at line 653 of file pad.cpp.

{
 m_attribute = aAttribute;
 
 if( aAttribute == PAD_ATTRIB::SMD )
 m_drill = VECTOR2I( 0, 0 );
 
 SetDirty();
}

References m_attribute, m_drill, SetDirty(), and SMD.

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 133 of file eda_item.h.

133{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:156

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetChamferPositions()

void PAD::SetChamferPositions ( int aPositions )

inline

Has meaning only for chamfered rectangular pads.

Set the position of the chamfers for orientation 0.

Parameters

aPositions a bit-set of RECT_CHAMFER_POSITIONS.

Definition at line 574 of file pad.h.

574{ m_chamferPositions = aPositions; }

References m_chamferPositions.

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

◆ SetChamferRectRatio()

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

{
 m_chamferScale = std::max( 0.0, std::min( aChamferScale, 0.5 ) );
 
 SetDirty();
}

References m_chamferScale, and SetDirty().

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

◆ SetCustomShapeInZoneOpt()

void PAD::SetCustomShapeInZoneOpt ( CUST_PAD_SHAPE_IN_ZONE 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 216 of file pad.h.

 {
 m_customShapeClearanceArea = aOption;
 }

References m_customShapeClearanceArea.

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

◆ SetDelta()

void PAD::SetDelta ( const VECTOR2I & aSize )

inline

Definition at line 257 of file pad.h.

257{ m_deltaSize = aSize; SetDirty(); }

References m_deltaSize, and SetDirty().

Referenced by ImportSettingsFrom(), mirrorPadX(), mirrorPadY(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetDirty()

void PAD::SetDirty ( )

inline

Definition at line 384 of file pad.h.

 {
 m_shapesDirty = true;
 m_polyDirty = true;
 }

References m_polyDirty, and m_shapesDirty.

Referenced by AddPrimitive(), AddPrimitiveAnnotationBox(), AddPrimitiveArc(), AddPrimitiveCircle(), AddPrimitiveCurve(), AddPrimitivePoly(), AddPrimitiveRect(), AddPrimitiveSegment(), AppendPrimitives(), DeletePrimitivesList(), Flip(), FlipPrimitives(), ImportSettingsFrom(), Move(), PAD(), ReplacePrimitives(), Rotate(), SetAnchorPadShape(), SetAttribute(), SetChamferRectRatio(), SetDelta(), SetDrawCoord(), SetDrillSize(), SetDrillSizeX(), SetDrillSizeY(), SetOffset(), SetOrientation(), SetPosition(), SetProperty(), SetRoundRectRadiusRatio(), SetShape(), SetSize(), SetSizeX(), SetSizeY(), SetX(), and SetY().

◆ SetDrawCoord()

void PAD::SetDrawCoord ( )

Definition at line 622 of file pad.cpp.

{
 FOOTPRINT* parentFootprint = static_cast<FOOTPRINT*>( m_parent );
 
 m_pos = m_pos0;
 
 if( parentFootprint == nullptr )
 return;
 
 RotatePoint( &m_pos.x, &m_pos.y, parentFootprint->GetOrientation() );
 m_pos += parentFootprint->GetPosition();
 
 SetDirty();
}

References FOOTPRINT::GetOrientation(), FOOTPRINT::GetPosition(), EDA_ITEM::m_parent, m_pos, m_pos0, RotatePoint(), SetDirty(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SetDrillShape()

void PAD::SetDrillShape ( PAD_DRILL_SHAPE_T aShape )

inline

Definition at line 376 of file pad.h.

376{ m_drillShape = aShape; m_shapesDirty = true; }

References m_drillShape, and m_shapesDirty.

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

◆ SetDrillSize()

void PAD::SetDrillSize ( const VECTOR2I & aSize )

inline

Definition at line 260 of file pad.h.

260{ m_drill = aSize; SetDirty(); }

References m_drill, and SetDirty().

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

◆ SetDrillSizeX()

void PAD::SetDrillSizeX ( const int aX )

inline

Definition at line 262 of file pad.h.

262{ m_drill.x = aX; SetDirty(); }

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

Referenced by PAD_DESC::PAD_DESC().

◆ SetDrillSizeY()

void PAD::SetDrillSizeY ( const int aY )

inline

Definition at line 264 of file pad.h.

264{ m_drill.y = aY; SetDirty(); }

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

Referenced by PAD_DESC::PAD_DESC().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 156 of file eda_item.h.

156{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

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

215{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 240 of file board_item.h.

240{ m_isKnockout = aKnockout; }

References BOARD_ITEM::m_isKnockout.

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 181 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

References EDA_ITEM::ClearFlags(), IS_SHOWN_AS_BITMAP, and EDA_ITEM::SetFlags().

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PAD() [1/2]

◆ PAD() [2/2]

Member Function Documentation

◆ addPadPrimitivesToPolygon()

◆ AddPrimitive()

◆ AddPrimitiveAnnotationBox()

◆ AddPrimitiveArc()

◆ AddPrimitiveCircle()

◆ AddPrimitiveCurve()

◆ AddPrimitivePoly() [1/2]

◆ AddPrimitivePoly() [2/2]

◆ AddPrimitiveRect()

◆ AddPrimitiveSegment()

◆ ApertureMask()

◆ AppendPrimitives()

◆ BuildEffectivePolygon()

◆ BuildEffectiveShapes()

◆ CanHaveNumber()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ClonePad()

◆ Compare()

◆ ConnSMDMask()

◆ DeletePrimitivesList()

◆ DeleteStructure()

◆ Duplicate()

◆ FlashLayer() [1/2]

◆ FlashLayer() [2/2]

◆ Flip()

◆ FlipPrimitives()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAnchorPadShape()

◆ GetAttribute()

◆ GetBestAnchorPosition()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox()

◆ GetBoundingRadius()

◆ GetCenter()

◆ GetChamferPositions()

◆ GetChamferRectRatio()

◆ GetClass()

◆ GetCustomShapeInZoneOpt()

◆ GetDelta()

◆ GetDrillShape()

◆ GetDrillSize()

◆ GetDrillSizeX()

◆ GetDrillSizeY()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveNetClass()

◆ GetEffectivePolygon()

◆ GetEffectiveShape()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetKeepTopBottom()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetLocalClearance() [1/2]

◆ GetLocalClearance() [2/2]

◆ GetLocalClearanceOverrides()