PAD Class Reference

#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 KICAD_T aScanTypes[]) const override
	Check whether the item is one of the listed types. More...
FOOTPRINT *	GetParent () const
bool	IsLocked () const override
void	ImportSettingsFrom (const PAD &aMasterPad)
	Imports the pad settings from aMasterPad. More...
bool	IsFlipped () const
void	SetName (const wxString &aName)
	Set the pad name (sometimes called pad number, although it can be an array reference like AA12). More...
const wxString &	GetName () const
void	SetPinFunction (const wxString &aName)
	Set the pad function (pin name in schematic) More...
const wxString &	GetPinFunction () 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...
void	SetShape (PAD_SHAPE_T aShape)
	Set the new shape of this pad. More...
PAD_SHAPE_T	GetShape () const
void	SetPosition (const wxPoint &aPos) override
wxPoint	GetPosition () const override
PAD_SHAPE_T	GetAnchorPadShape () const
	Function GetAnchorPadShape. More...
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_T aShape)
	Function SetAnchorPadShape Set the shape of the anchor pad for custm shped pads. More...
bool	IsOnCopperLayer () const override
void	SetY (int y)
void	SetX (int x)
void	SetPos0 (const wxPoint &aPos)
const wxPoint &	GetPos0 () const
void	SetY0 (int y)
void	SetX0 (int x)
void	SetSize (const wxSize &aSize)
const wxSize &	GetSize () const
void	SetSizeX (const int aX)
const int	GetSizeX () const
void	SetSizeY (const int aY)
const int	GetSizeY () const
void	SetDelta (const wxSize &aSize)
const wxSize &	GetDelta () const
void	SetDrillSize (const wxSize &aSize)
const wxSize &	GetDrillSize () const
void	SetDrillSizeX (const int aX)
const int	GetDrillSizeX () const
void	SetDrillSizeY (const int aY)
const int	GetDrillSizeY () const
void	SetOffset (const wxPoint &aOffset)
const wxPoint &	GetOffset () const
wxPoint	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< wxPoint > &aPoly, int aThickness, bool aFilled)
void	AddPrimitiveSegment (const wxPoint &aStart, const wxPoint &aEnd, int aThickness)
void	AddPrimitiveCircle (const wxPoint &aCenter, int aRadius, int aThickness, bool aFilled)
void	AddPrimitiveRect (const wxPoint &aStart, const wxPoint &aEnd, int aThickness, bool aFilled)
void	AddPrimitiveArc (const wxPoint &aCenter, const wxPoint &aStart, int aArcAngle, int aThickness)
void	AddPrimitiveCurve (const wxPoint &aStart, const wxPoint &aEnd, const wxPoint &aCtrl1, const wxPoint &aCtrl2, int aThickness)
bool	GetBestAnchorPosition (VECTOR2I &aPos)
void	MergePrimitivesAsPolygon (SHAPE_POLY_SET *aMergedPolygon, PCB_LAYER_ID aLayer) const
	Merge all basic shapes to a SHAPE_POLY_SET Note: The results are relative to the pad position, orientation 0. 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 wxPoint &aCentre, 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 primites 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 (double aAngle)
	Function SetOrientation sets the rotation angle of the pad. More...
void	SetOrientationDegrees (double aOrientation)
	Set orientation in degrees. More...
double	GetOrientation () const
	Function GetOrientation returns the rotation angle of the pad in a variety of units (the basic call returns tenths of degrees). More...
double	GetOrientationDegrees () const
double	GetOrientationRadians () 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_ATTR_T aAttribute)
PAD_ATTR_T	GetAttribute () const
void	SetProperty (PAD_PROP_T aProperty)
PAD_PROP_T	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
	Function GetLocalClearance returns 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)
void	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aMaxError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
	Function TransformShapeWithClearanceToPolygon Convert the pad shape to a closed polygon. More...
bool	TransformHoleWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int aError, ERROR_LOC aErrorLoc) const
	Function TransformHoleWithClearanceToPolygon 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) 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
const SHAPE_SEGMENT *	GetEffectiveHoleShape () const
	Function GetEffectiveHoleShape Returns a SHAPE object representing the pad's hole. More...
int	GetBoundingRadius () const
	Function GetBoundingRadius returns the radius of a minimum sized circle which fully encloses this pad. More...
int	GetLocalClearanceOverrides (wxString *aSource) const override
	Function GetLocalClearanceOverrides returns any local clearance overrides set in the "classic" (ie: pre-rule) system. More...
int	GetSolderMaskMargin () const
	Function GetSolderMaskMargin. More...
wxSize	GetSolderPasteMargin () const
	Function GetSolderPasteMargin. More...
void	SetZoneConnection (ZONE_CONNECTION aType)
ZONE_CONNECTION	GetZoneConnection () const
ZONE_CONNECTION	GetEffectiveZoneConnection (wxString *aSource=nullptr) const
	Return the zone connection in effect (either locally overridden or overridden in the parent footprint). More...
void	SetThermalSpokeWidth (int aWidth)
	Set the width of the thermal spokes connecting the pad to a zone. More...
int	GetThermalSpokeWidth () const
int	GetEffectiveThermalSpokeWidth (wxString *aSource=nullptr) const
	Return the effective thermal spoke width having resolved any inheritance. More...
void	SetThermalGap (int aGap)
int	GetThermalGap () const
int	GetEffectiveThermalGap (wxString *aSource=nullptr) const
	Return the effective thermal gap having resolved any inheritance. More...
void	SetRoundRectCornerRadius (double aRadius)
	Function SetRoundRectCornerRadius has meaning only for rounded rect pads. More...
int	GetRoundRectCornerRadius () const
wxPoint	ShapePos () const
void	SetRoundRectRadiusRatio (double aRadiusScale)
	has meaning only for rounded rect pads Set the ratio between the smaller X or Y size and the rounded corner radius. More...
double	GetRoundRectRadiusRatio () const
void	SetChamferRectRatio (double aChamferScale)
	has meaning only for chamfered rect pads Set the ratio between the smaller X or Y size and chamfered corner size. More...
double	GetChamferRectRatio () const
void	SetChamferPositions (int aPositions)
	has meaning only for chamfered rect pads set the position of the chamfers for orientation 0. More...
int	GetChamferPositions () const
int	GetSubRatsnest () const
	Function GetSubRatsnest. More...
void	SetSubRatsnest (int aSubRatsnest)
void	SetRemoveUnconnected (bool aSet)
	Sets the unconnected removal property. More...
bool	GetRemoveUnconnected () const
void	SetKeepTopBottom (bool aSet)
	Sets 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, bool aIncludeZones=false) const
	Checks to see whether the pad should be flashed on the specific layer. More...
bool	FlashLayer (LSET aLayers, bool aIncludeZones=false) const
	Checks to see if the pad should be flashed to any of the layers in the set. More...
bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Test if aPosition is contained within or on the bounding box of an item. More...
bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects or is contained within the bounding box of an item. More...
wxString	GetClass () const override
	Return the class name. More...
const EDA_RECT	GetBoundingBox () const override
	Function GetBoundingBox The bounding box is cached, so this will be efficient most of the time. More...
void	SetDrawCoord ()
	Set absolute coordinates. More...
void	SetLocalCoord ()
	Set relative coordinates. More...
void	Move (const wxPoint &aMoveVector) override
	Move this object. More...
void	Rotate (const wxPoint &aRotCentre, double aAngle) override
	Rotate this object. More...
wxString	GetSelectMenuText (EDA_UNITS aUnits) 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...
BITMAP_DEF	GetMenuImage () const override
	Return a pointer to an image to be used in menus. More...
wxString	ShowPadShape () const
	Function ShowPadShape. More...
wxString	ShowPadAttr () const
	Function ShowPadAttr. More...
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
	Rebuilds 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
	More...
NETINFO_ITEM *	GetNet () const
	Function GetNet Returns NET_INFO object for a given item. More...
void	SetNet (NETINFO_ITEM *aNetInfo)
	Function SetNet Sets a NET_INFO object for the item. More...
int	GetNetCode () const
	Function GetNetCode. More...
bool	SetNetCode (int aNetCode, bool aNoAssert)
	Sets net using a net code. More...
void	SetNetCode (int aNetCode)
wxString	GetNetname () const
	Function GetNetname. More...
wxString	GetNetnameMsg () const
	Function GetNetnameMsg. More...
wxString	GetShortNetname () const
	Function GetShortNetname. More...
virtual int	GetOwnClearance (PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
	Function GetClearance returns an item's "own" clearance in internal units. More...
virtual NETCLASS *	GetNetClass () const
	Function GetNetClassPtr returns the NETCLASS for this item. More...
virtual NETCLASS *	GetEffectiveNetclass () const
	Function GetEffectiveNetclass returns the NETCLASS for this item, or the default netclass if none is defined. More...
virtual wxString	GetNetClassName () const
	Function GetNetClassName returns a pointer to the netclass of the zone. More...
void	SetLocalRatsnestVisible (bool aVisible)
bool	GetLocalRatsnestVisible () const
void	SetParentGroup (PCB_GROUP *aGroup)
PCB_GROUP *	GetParentGroup () const
int	GetX () const
int	GetY () const
virtual PCB_LAYER_ID	GetLayer () const
	Return the primary layer this item is on. More...
virtual void	SetLayer (PCB_LAYER_ID aLayer)
	Set the layer this item is on. More...
virtual BOARD_ITEM *	Duplicate () const
	Create a copy of a of this BOARD_ITEM. More...
bool	IsTrack () const
	Test to see if this object is a track or via (or microvia). More...
virtual void	SetLocked (bool aLocked)
	Modify the 'lock' status for of the item. More...
void	DeleteStructure ()
	Delete this object after removing from its parent if it has one. More...
void	Move (const VECTOR2I &aMoveVector)
void	Rotate (const VECTOR2I &aRotCentre, double aAngle)
void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)
virtual BOARD *	GetBoard () const
	Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
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
void	SetWireImage ()
void	SetSelected ()
void	SetBrightened ()
void	ClearSelected ()
void	ClearBrightened ()
void	SetModified ()
int	GetState (int type) const
void	SetState (int type, int state)
STATUS_FLAGS	GetStatus () const
void	SetStatus (STATUS_FLAGS aStatus)
void	SetFlags (STATUS_FLAGS aMask)
void	ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
STATUS_FLAGS	GetFlags () const
bool	HasFlag (STATUS_FLAGS aFlag) const
STATUS_FLAGS	GetEditFlags () const
void	ClearTempFlags ()
void	ClearEditFlags ()
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 wxPoint	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
virtual SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...
virtual bool	Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData. More...
virtual bool	Replace (const wxFindReplaceData &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)
template<typename T >
T	Get (PROPERTY_BASE *aProperty)
template<typename T >
boost::optional< T >	Get (const wxString &aProperty)

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 *padref, const PAD *padcmp)
	Function Compare compares two pads and return 0 if they are equal. More...
static wxString	ShowShape (PCB_SHAPE_TYPE_T aShape)
	Convert the enum PCB_SHAPE_TYPE_T integer value to a wxString. More...
template<class T >
static SEARCH_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	This changes first parameter to avoid the DList and use the main queue instead. More...
template<class T >
static SEARCH_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
	Change first parameter to avoid the DList and use std::vector instead. More...
static bool	Replace (const wxFindReplaceData &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 wxPoint	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 wxFindReplaceData &aSearchData) const
	Compare aText against search criteria in aSearchData. More...

Protected Attributes
NETINFO_ITEM *	m_netinfo
	Stores all informations about the net that item belongs to. More...
PCB_LAYER_ID	m_layer
PCB_GROUP *	m_group
STATUS_FLAGS	m_status
EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...
bool	m_forceVisible
STATUS_FLAGS	m_flags

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

Private Attributes
wxString	m_name
wxString	m_pinFunction
wxPoint	m_pos
PAD_SHAPE_T	m_padShape
std::vector< std::shared_ptr< PCB_SHAPE > >	m_editPrimitives
bool	m_shapesDirty
std::mutex	m_shapesBuildingLock
EDA_RECT	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
wxSize	m_drill
wxSize	m_size
PAD_DRILL_SHAPE_T	m_drillShape
double	m_roundedCornerScale
double	m_chamferScale
int	m_chamferPositions
PAD_SHAPE_T	m_anchorPadShape
wxPoint	m_offset
LSET	m_layerMask
wxSize	m_deltaSize
wxPoint	m_pos0
PAD_ATTR_T	m_attribute
PAD_PROP_T	m_property
double	m_orient
int	m_lengthPadToDie
bool	m_removeUnconnectedLayer
bool	m_keepTopBottomLayer
int	m_localClearance
int	m_localSolderMaskMargin
int	m_localSolderPasteMargin
double	m_localSolderPasteMarginRatio
ZONE_CONNECTION	m_zoneConnection
int	m_thermalWidth
int	m_thermalGap

Detailed Description

Definition at line 60 of file pad.h.

Constructor & Destructor Documentation

PAD() [1/2]

PAD::PAD

(

FOOTPRINT *

parent

)

Definition at line 49 of file pcbnew/pad.cpp.

                            :
    BOARD_CONNECTED_ITEM( parent, PCB_PAD_T )
{
    m_size.x = m_size.y   = Mils2iu( 60 );  // Default pad size 60 mils.
    m_drill.x = m_drill.y = Mils2iu( 30 );  // Default drill size 30 mils.
    m_orient              = 0;              // Pad rotation in 1/10 degrees.
    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_thermalWidth      = 0;                        // Use parent setting by default
    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 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_thermalWidth, m_zoneConnection, PAD_ATTRIB_PTH, PAD_DRILL_SHAPE_CIRCLE, PAD_PROP_NONE, PAD_SHAPE_CIRCLE, PCB_FOOTPRINT_T, PTHMask(), RECT_NO_CHAMFER, SetAnchorPadShape(), SetDirty(), SetDrillShape(), SetProperty(), SetShape(), SetSubRatsnest(), and EDA_ITEM::Type().

Referenced by Clone().

PAD() [2/2]

PAD::PAD

(

const PAD &

aPad

)

Definition at line 96 of file pcbnew/pad.cpp.

                            :
    BOARD_CONNECTED_ITEM( aOther.GetParent(), PCB_PAD_T )
{
    BOARD_CONNECTED_ITEM::operator=( aOther );

    ImportSettingsFrom( aOther );
    SetPadToDieLength( aOther.GetPadToDieLength() );
    SetPosition( aOther.GetPosition() );
    SetPos0( aOther.GetPos0() );
    SetName( aOther.GetName() );
    SetPinFunction( aOther.GetPinFunction() );
    SetSubRatsnest( aOther.GetSubRatsnest() );
    m_effectiveBoundingRadius = aOther.m_effectiveBoundingRadius;
    m_removeUnconnectedLayer = aOther.m_removeUnconnectedLayer;
    m_keepTopBottomLayer = aOther.m_keepTopBottomLayer;
    const_cast<KIID&>( m_Uuid ) = aOther.m_Uuid;
}

References GetName(), GetPadToDieLength(), GetPinFunction(), GetPos0(), GetPosition(), GetSubRatsnest(), ImportSettingsFrom(), m_effectiveBoundingRadius, m_keepTopBottomLayer, m_removeUnconnectedLayer, EDA_ITEM::m_Uuid, EDA_ITEM::operator=(), SetName(), SetPadToDieLength(), SetPinFunction(), SetPos0(), SetPosition(), and SetSubRatsnest().

Member Function Documentation

addPadPrimitivesToPolygon()

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

private

Definition at line 178 of file pad_custom_shape_functions.cpp.

{
    SHAPE_POLY_SET polyset;

    for( const std::shared_ptr<PCB_SHAPE>& primitive : m_editPrimitives )
        primitive->TransformShapeWithClearanceToPolygon( polyset, aLayer, 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, and SHAPE_POLY_SET::Simplify().

Referenced by GetBestAnchorPosition(), and MergePrimitivesAsPolygon().

AddPrimitive()

void PAD::AddPrimitive

(

PCB_SHAPE *

aPrimitive

)

Add item to the custom shape primitives list.

Definition at line 161 of file pad_custom_shape_functions.cpp.

{
    m_editPrimitives.emplace_back( aPrimitive );

    SetDirty();
}

References m_editPrimitives, and SetDirty().

Referenced by AppendPrimitives(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), and PAD_TOOL::recombinePad().

AddPrimitiveArc()

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

Definition at line 80 of file pad_custom_shape_functions.cpp.

{
    PCB_SHAPE* item = new PCB_SHAPE();
    item->SetShape( S_ARC );
    item->SetFilled( false );
    item->SetCenter( aCenter );
    item->SetArcStart( aStart );
    item->SetAngle( aArcAngle );
    item->SetWidth( aThickness );
    m_editPrimitives.emplace_back( item );
    SetDirty();
}

References m_editPrimitives, S_ARC, PCB_SHAPE::SetAngle(), PCB_SHAPE::SetArcStart(), PCB_SHAPE::SetCenter(), SetDirty(), PCB_SHAPE::SetFilled(), PCB_SHAPE::SetShape(), and PCB_SHAPE::SetWidth().

AddPrimitiveCircle()

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

Definition at line 111 of file pad_custom_shape_functions.cpp.

{
    PCB_SHAPE* item = new PCB_SHAPE();
    item->SetShape( S_CIRCLE );
    item->SetFilled( aFilled );
    item->SetStart( aCenter );
    item->SetEnd( wxPoint( aCenter.x + aRadius, aCenter.y ) );
    item->SetWidth( aThickness );
    m_editPrimitives.emplace_back( item );
    SetDirty();
}

References m_editPrimitives, S_CIRCLE, SetDirty(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetFilled(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), and PCB_SHAPE::SetWidth().

AddPrimitiveCurve()

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

Definition at line 95 of file pad_custom_shape_functions.cpp.

{
    PCB_SHAPE* item = new PCB_SHAPE();
    item->SetShape( S_CURVE );
    item->SetFilled( false );
    item->SetStart( aStart );
    item->SetEnd( aEnd );
    item->SetBezControl1( aCtrl1 );
    item->SetBezControl2( aCtrl2 );
    item->SetWidth( aThickness );
    m_editPrimitives.emplace_back( item );
    SetDirty();
}

References m_editPrimitives, S_CURVE, PCB_SHAPE::SetBezControl1(), PCB_SHAPE::SetBezControl2(), SetDirty(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetFilled(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), and PCB_SHAPE::SetWidth().

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

{
    std::vector<wxPoint> points;

    // If aPoly has holes, convert it to a polygon with no holes.
    SHAPE_POLY_SET poly_no_hole;
    poly_no_hole.Append( aPoly );
    poly_no_hole.Fracture( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );

    for( auto iter = poly_no_hole.CIterate(); iter; iter++ )
        points.emplace_back( iter->x, iter->y );

    AddPrimitivePoly( points, aThickness, aFilled );
}

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::Fracture(), and SHAPE_POLY_SET::PM_STRICTLY_SIMPLE.

Referenced by MICROWAVE_TOOL::createFootprint().

AddPrimitivePoly() [2/2]

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

Definition at line 55 of file pad_custom_shape_functions.cpp.

{
    PCB_SHAPE* item = new PCB_SHAPE();
    item->SetShape( S_POLYGON );
    item->SetFilled( aFilled );
    item->SetPolyPoints( aPoly );
    item->SetWidth( aThickness );
    m_editPrimitives.emplace_back( item );
    SetDirty();
}

References m_editPrimitives, S_POLYGON, SetDirty(), PCB_SHAPE::SetFilled(), PCB_SHAPE::SetPolyPoints(), PCB_SHAPE::SetShape(), and PCB_SHAPE::SetWidth().

AddPrimitiveRect()

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

Definition at line 124 of file pad_custom_shape_functions.cpp.

{
    PCB_SHAPE* item = new PCB_SHAPE();
    item->SetShape( S_RECT );
    item->SetFilled( aFilled );
    item->SetStart( aStart );
    item->SetEnd( aEnd );
    item->SetWidth( aThickness );
    m_editPrimitives.emplace_back( item );
    SetDirty();
}

References m_editPrimitives, S_RECT, SetDirty(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetFilled(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), and PCB_SHAPE::SetWidth().

AddPrimitiveSegment()

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

Definition at line 67 of file pad_custom_shape_functions.cpp.

{
    PCB_SHAPE* item = new PCB_SHAPE();
    item->SetShape( S_SEGMENT );
    item->SetFilled( false );
    item->SetStart( aStart );
    item->SetEnd( aEnd );
    item->SetWidth( aThickness );
    m_editPrimitives.emplace_back( item );
    SetDirty();
}

References m_editPrimitives, S_SEGMENT, SetDirty(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetFilled(), PCB_SHAPE::SetShape(), PCB_SHAPE::SetStart(), and PCB_SHAPE::SetWidth().

ApertureMask()

LSET PAD::ApertureMask ( )

static

layer set for an aperture pad

Definition at line 171 of file pcbnew/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 primites list (composed of basic shapes) and add items to the current list.

Copies the input, which is not altered.

Definition at line 151 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 482 of file pcbnew/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;

    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 SHAPE_LINE_CHAIN::CPoint(), ERROR_INSIDE, EuclideanNorm(), 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

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

Definition at line 310 of file pcbnew/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;

    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 );
               };

    wxPoint shapePos = ShapePos();  // Fetch only once; rotation involves trig
    PAD_SHAPE_T 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
        {
            wxSize  half_size = m_size / 2;
            int     half_width = std::min( half_size.x, half_size.y );
            wxPoint 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;
        wxPoint half_size( m_size.x / 2, m_size.y / 2 );
        wxSize  trap_delta( 0, 0 );

        if( r )
        {
            half_size -= wxPoint( 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 = Millimeter2iu( 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( -DECIDEG2RAD( 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(), maxError, ERROR_INSIDE );

        add( new SHAPE_SIMPLE( outline.COutline( 0 ) ) );
    }
        break;

    default:
        wxFAIL_MSG( "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( -DECIDEG2RAD( m_orient ) );
                shape->Move( shapePos );
                add( shape );
            }
        }
    }

    BOX2I bbox = m_effectiveShape->BBox();
    m_effectiveBoundingBox = EDA_RECT( (wxPoint) bbox.GetPosition(),
                                       wxSize( bbox.GetWidth(), bbox.GetHeight() ) );

    // Hole shape
    //
    wxSize  half_size = m_drill / 2;
    int     half_width = std::min( half_size.x, half_size.y );
    wxPoint 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 );

    // All done
    //
    m_shapesDirty = false;
}

References SHAPE_LINE_CHAIN::Append(), SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), DECIDEG2RAD(), ERROR_INSIDE, GetAnchorPadShape(), BOARD_ITEM::GetBoard(), GetChamferPositions(), GetChamferRectRatio(), BOARD::GetDesignSettings(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetPosition(), GetRoundRectCornerRadius(), GetShape(), GetSize(), BOX2< Vec >::GetWidth(), 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, Millimeter2iu(), SHAPE_LINE_CHAIN::Move(), PAD_SHAPE_CHAMFERED_RECT, PAD_SHAPE_CIRCLE, PAD_SHAPE_CUSTOM, PAD_SHAPE_OVAL, PAD_SHAPE_RECT, PAD_SHAPE_ROUNDRECT, PAD_SHAPE_T_asString(), PAD_SHAPE_TRAPEZOID, SHAPE_LINE_CHAIN::PointCount(), SHAPE_LINE_CHAIN::Rotate(), RotatePoint(), ShapePos(), TransformRoundChamferedRectToPolygon(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

ClassOf()

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

inlinestatic

Definition at line 81 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 181 of file eda_item.h.

{ ClearFlags( BRIGHTENED ); }

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 220 of file eda_item.h.

    {
        ClearFlags( GetEditFlags() );
    }

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

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

ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 202 of file eda_item.h.

{ m_flags &= ~aMask; }

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), 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(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 180 of file eda_item.h.

{ ClearFlags( SELECTED ); }

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_PART::LIB_PART(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 214 of file eda_item.h.

    {
        ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
                    DO_NOT_DRAW );
    }

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 148 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 1139 of file pcbnew/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 635 of file pad.h.

    {
        return (PAD*) Clone();
    }

References Clone().

Compare()

int PAD::Compare ( const PAD *  padref, const PAD *  padcmp  )

static

Function Compare compares two pads and return 0 if they are equal.

Returns

int - <0 if left less than right, 0 if equal, >0 if left greater than right.

Definition at line 1001 of file pcbnew/pad.cpp.

{
    int diff;

    if( ( diff = padref->GetShape() - padcmp->GetShape() ) != 0 )
        return diff;

    if( ( diff = padref->GetDrillShape() - padcmp->GetDrillShape() ) != 0)
        return diff;

    if( ( diff = padref->m_drill.x - padcmp->m_drill.x ) != 0 )
        return diff;

    if( ( diff = padref->m_drill.y - padcmp->m_drill.y ) != 0 )
        return diff;

    if( ( diff = padref->m_size.x - padcmp->m_size.x ) != 0 )
        return diff;

    if( ( diff = padref->m_size.y - padcmp->m_size.y ) != 0 )
        return diff;

    if( ( diff = padref->m_offset.x - padcmp->m_offset.x ) != 0 )
        return diff;

    if( ( diff = padref->m_offset.y - padcmp->m_offset.y ) != 0 )
        return diff;

    if( ( diff = padref->m_deltaSize.x - padcmp->m_deltaSize.x ) != 0 )
        return diff;

    if( ( diff = padref->m_deltaSize.y - padcmp->m_deltaSize.y ) != 0 )
        return diff;

// TODO: test custom shapes

    // Dick: specctra_export needs this
    // Lorenzo: gencad also needs it to implement padstacks!

#if __cplusplus >= 201103L
    long long d = padref->m_layerMask.to_ullong() - padcmp->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 = padref->m_layerMask.to_string();
    std::string s2 = padcmp->m_layerMask.to_string();
    return s1.compare( s2 );
#endif
}

References GetDrillShape(), GetShape(), m_deltaSize, m_drill, m_layerMask, m_offset, and m_size.

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 157 of file pcbnew/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 170 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 113 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()

virtual BOARD_ITEM* BOARD_ITEM::Duplicate ( ) const

inlinevirtualinherited

Create a copy of a of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 202 of file board_item.h.

    {
        EDA_ITEM* dupe = Clone();
        const_cast<KIID&>( dupe->m_Uuid ) = KIID();

        return static_cast<BOARD_ITEM*>( dupe );
    }

References EDA_ITEM::Clone(), and EDA_ITEM::m_Uuid.

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

FlashLayer() [1/2]

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

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

Parameters

aLayer	Layer to check for connectivity
aIncludeZones	We include zones in potentially connected elements when drawing

Returns

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

Normally, we don't need to include zones in our flash check because the zones will fill over the hole. But, when we are drawing the pad in pcbnew, it is helpful to show the annular ring where the pad is connected

We don't remove the copper from non-PTH pads

Heatsink pads always get copper

Plated through hole pads need copper on the top/bottom layers for proper soldering Unless the user has removed them in the pad dialog

Definition at line 198 of file pcbnew/pad.cpp.

{
    std::vector<KICAD_T> types{ PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T };

    if( aIncludeZones )
    {
        types.push_back( PCB_ZONE_T );
        types.push_back( PCB_FP_ZONE_T );
    }

    // Return the "normal" shape if the caller doesn't specify a particular layer
    if( aLayer == UNDEFINED_LAYER )
        return true;

    BOARD* board = GetBoard();

    if( !board )
        return false;

    if( GetAttribute() != PAD_ATTRIB_PTH )
        return IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) );

    if( GetProperty() == PAD_PROP_HEATSINK )
        return IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) );

    if( !m_removeUnconnectedLayer )
        return IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) );

    if( m_keepTopBottomLayer && ( aLayer == F_Cu || aLayer == B_Cu ) )
        return IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) );

    return board->GetConnectivity()->IsConnectedOnLayer( this, static_cast<int>( aLayer ),
            types );
}

References B_Cu, F_Cu, GetAttribute(), BOARD_ITEM::GetBoard(), BOARD::GetConnectivity(), GetProperty(), IsOnLayer(), m_keepTopBottomLayer, m_removeUnconnectedLayer, PAD_ATTRIB_PTH, PAD_PROP_HEATSINK, PCB_ARC_T, PCB_FP_ZONE_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, and UNDEFINED_LAYER.

Referenced by KIGFX::PCB_PAINTER::draw(), FlashLayer(), PNS_KICAD_IFACE::IsFlashedOnLayer(), DIALOG_DRC::OnDRCItemSelected(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and ViewGetLOD().

FlashLayer() [2/2]

bool PAD::FlashLayer	(	LSET	aLayers,
		bool	aIncludeZones = false
	)		const

Checks 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
aIncludeZones	We include zones in potentially connected elements when drawing

Returns

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

Definition at line 186 of file pcbnew/pad.cpp.

{
    for( auto layer : aLayers.Seq() )
    {
        if( FlashLayer( layer, aIncludeZones ) )
            return true;
    }

    return false;
}

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

Flip() [1/2]

void PAD::Flip ( const wxPoint &  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 594 of file pcbnew/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(), and SetOrientation().

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

Flip() [2/2]

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

inlineinherited

Definition at line 315 of file board_item.h.

    {
        Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
    }

References BOARD_ITEM::Flip(), VECTOR2< T >::x, and VECTOR2< T >::y.

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 653 of file pcbnew/pad.cpp.

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

    SetDirty();
}

References m_editPrimitives, and SetDirty().

Referenced by Flip(), and mirrorPadX().

Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 84 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, 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 CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE *  aProperty )

inlineinherited

Definition at line 93 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
        return object ? aProperty->get<T>( object ) : T();
    }

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

Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 102 of file inspectable.h.

    {
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        TYPE_ID thisType = TYPE_HASH( *this );
        PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
        boost::optional<T> ret;

        if( prop )
        {
            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().

GetAnchorPadShape()

PAD_SHAPE_T PAD::GetAnchorPadShape ( ) const

inline

Function GetAnchorPadShape.

Returns

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

Definition at line 176 of file pad.h.

{ return m_anchorPadShape; }

References m_anchorPadShape.

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

GetAttribute()

PAD_ATTR_T PAD::GetAttribute ( ) const

inline

Definition at line 359 of file pad.h.

{ return m_attribute; }

References m_attribute.

Referenced by CN_LIST::Add(), doPushPadProperties(), export_vrml_pad(), FlashLayer(), PCB_IO::format(), GetMsgPanelInfo(), GetSelectMenuText(), getShape(), hasThermalConnection(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), isCopper(), isPlated(), PNS::ROUTER::isStartingPointRoutable(), PAD_DESC::PAD_DESC(), PAD_NAMING::PadCanHaveName(), DIALOG_PAD_PROPERTIES::padValuesOK(), BRDITEMS_PLOTTER::PlotPad(), BOARD_INSPECTION_TOOL::reportZoneConnection(), PCB_SELECTION_TOOL::Selectable(), ShowPadAttr(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and ViewGetLOD().

GetBestAnchorPosition()

bool PAD::GetBestAnchorPosition

(

VECTOR2I &

aPos

)

Definition at line 225 of file pad_custom_shape_functions.cpp.

{
    SHAPE_POLY_SET poly;
    addPadPrimitivesToPolygon( &poly, UNDEFINED_LAYER, 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 );
    }

    OPT<VECTOR2I> bestAnchor( []()->OPT<VECTOR2I> { return 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(), SHAPE_POLY_SET::BBox(), SHAPE_POLY_SET::Contains(), SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::Distance(), ERROR_INSIDE, EuclideanNorm(), GetAnchorPadShape(), BOX2< Vec >::GetHeight(), GetSize(), NULLOPT, SHAPE_POLY_SET::OutlineCount(), PAD_SHAPE_CIRCLE, rescale(), UNDEFINED_LAYER, VECTOR2< T >::x, and VECTOR2< T >::y.

GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 46 of file board_item.cpp.

{
    if( Type() == PCB_T )
        return (BOARD*) this;

    BOARD_ITEM* parent = GetParent();

    if( parent )
        return parent->GetBoard();

    return NULL;
}

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

Referenced by BuildEffectivePolygon(), BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), KIGFX::PCB_PAINTER::draw(), exprFromTo(), VIA::FlashLayer(), FlashLayer(), PCB_TEXT::Flip(), TRACK::Flip(), ARC::Flip(), VIA::Flip(), ZONE::Flip(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), ZONE::GetSelectMenuText(), getShape(), FP_TEXT::GetShownText(), GetSolderMaskMargin(), GetSolderPasteMargin(), BOARD::GetTrackLength(), TRACK::GetWidthConstraints(), insideArea(), insideCourtyard(), isDiffPair(), BOARD_ITEM::layerMaskDescribe(), VIA::layerMaskDescribe(), CONVERT_TOOL::makePolysFromCircles(), MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), ZONE::TransformSmoothedOutlineToPolygon(), ZONE::TransformSolidAreasShapesToPolygon(), TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), and ViewGetLOD().

GetBoundingBox()

const EDA_RECT PAD::GetBoundingBox ( ) const

overridevirtual

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

Reimplemented from EDA_ITEM.

Definition at line 524 of file pcbnew/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(), hasThermalConnection(), HitTest(), DSN::SPECCTRA_DB::makePADSTACK(), ViewBBox(), and ViewGetLOD().

GetBoundingRadius()

int PAD::GetBoundingRadius

(

)

const

Function GetBoundingRadius returns 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 301 of file pcbnew/pad.cpp.

{
    if( m_polyDirty )
        BuildEffectivePolygon();

    return m_effectiveBoundingRadius;
}

References BuildEffectivePolygon(), m_effectiveBoundingRadius, and m_polyDirty.

Referenced by HitTest().

GetCenter()

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

{ return GetPosition(); }

References GetPosition().

GetChamferPositions()

int PAD::GetChamferPositions ( ) const

inline

Definition at line 530 of file pad.h.

{ return m_chamferPositions; }

References m_chamferPositions.

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

GetChamferRectRatio()

double PAD::GetChamferRectRatio ( ) const

inline

Definition at line 522 of file pad.h.

{ return m_chamferScale; }

References m_chamferScale.

Referenced by BuildEffectiveShapes(), PCB_IO::format(), ImportSettingsFrom(), DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PAD_PROPERTIES::OnPadShapeSelection(), 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 579 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 182 of file pad.h.

    {
        return m_customShapeClearanceArea;
    }

References m_customShapeClearanceArea.

Referenced by ZONE_FILLER::addKnockout(), PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetDelta()

const wxSize& PAD::GetDelta ( ) const

inline

Definition at line 236 of file pad.h.

{ return m_deltaSize; }

References m_deltaSize.

Referenced by CreatePadsShapesSection(), export_vrml_padshape(), PCB_IO::format(), hash_fp_item(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::SPECCTRA_DB::makePADSTACK(), mirrorPadX(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetDrillShape()

PAD_DRILL_SHAPE_T PAD::GetDrillShape ( ) const

inline

Definition at line 342 of file pad.h.

{ return m_drillShape; }

References m_drillShape.

Referenced by Compare(), export_vrml_pad(), PCB_IO::format(), KIGFX::PCB_PAINTER::getDrillShape(), GetMsgPanelInfo(), hash_fp_item(), PNS_PCBNEW_RULE_RESOLVER::holeRadius(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetDrillSize()

const wxSize& PAD::GetDrillSize ( ) const

inline

Definition at line 239 of file pad.h.

{ return m_drill; }

References m_drill.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), CreatePadsShapesSection(), BOARD_ADAPTER::createPadWithDrill(), KIGFX::PCB_PAINTER::draw(), export_vrml_pad(), PCB_IO::format(), getDrilledHoleShape(), KIGFX::PCB_PAINTER::getDrillSize(), PNS_PCBNEW_RULE_RESOLVER::holeRadius(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), RENDER_3D_RAYTRACE::insertHole(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makeIMAGE(), EAGLE_PLUGIN::packagePad(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), DIALOG_PAD_PROPERTIES::padValuesOK(), PAD_TOOL::recombinePad(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), TransformHoleWithClearanceToPolygon(), and POINT_EDITOR::updateItem().

GetDrillSizeX()

const int PAD::GetDrillSizeX ( ) const

inline

Definition at line 241 of file pad.h.

{ return m_drill.x; }

References m_drill.

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

GetDrillSizeY()

const int PAD::GetDrillSizeY ( ) const

inline

Definition at line 243 of file pad.h.

{ return m_drill.y; }

References m_drill.

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

GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

    {
        constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
                               IS_WIRE_IMAGE | STRUCT_DELETED );

        return m_flags & mask;
    }

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

GetEffectiveHoleShape()

const SHAPE_SEGMENT * PAD::GetEffectiveHoleShape

(

)

const

Function GetEffectiveHoleShape Returns a SHAPE object representing the pad's hole.

Definition at line 292 of file pcbnew/pad.cpp.

{
    if( m_shapesDirty )
        BuildEffectiveShapes( UNDEFINED_LAYER );

    return m_effectiveHoleShape.get();
}

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

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

GetEffectiveNetclass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetclass ( ) const

virtualinherited

Function GetEffectiveNetclass returns the NETCLASS for this item, or the default netclass if none is defined.

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

{
    // NB: we must check the net first, as when it is 0 GetNetClass() will return the
    // orphaned net netclass, not the default netclass.
    if( !m_netinfo || m_netinfo->GetNetCode() == 0 )
        return GetBoard()->GetDesignSettings().GetDefault();
    else
        return GetNetClass();
}

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

GetEffectivePolygon()

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

(

)

const

Definition at line 274 of file pcbnew/pad.cpp.

{
    if( m_polyDirty )
        BuildEffectivePolygon();

    return m_effectivePolygon;
}

References BuildEffectivePolygon(), m_effectivePolygon, and m_polyDirty.

Referenced by BOARD_ADAPTER::buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), CN_ITEM::GetAnchor(), HitTest(), BRDITEMS_PLOTTER::PlotPad(), and PNS_KICAD_IFACE_BASE::syncPad().

GetEffectiveShape()

std::shared_ptr< SHAPE > PAD::GetEffectiveShape ( PCB_LAYER_ID  aLayer = UNDEFINED_LAYER ) 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 283 of file pcbnew/pad.cpp.

{
    if( m_shapesDirty )
        BuildEffectiveShapes( aLayer );

    return m_effectiveShape;
}

References BuildEffectiveShapes(), m_effectiveShape, and m_shapesDirty.

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

GetEffectiveThermalGap()

int PAD::GetEffectiveThermalGap

(

wxString *

aSource = nullptr

)

const

Return the effective thermal gap having resolved any inheritance.

Definition at line 838 of file pcbnew/pad.cpp.

{
    FOOTPRINT* parentFootprint = GetParent();

    if( m_thermalGap == 0 && parentFootprint )
    {
        if( aSource )
            *aSource = _( "parent footprint" );

        return parentFootprint->GetThermalGap();
    }

    if( aSource )
        *aSource = _( "pad" );

    return m_thermalGap;
}

References _, GetParent(), FOOTPRINT::GetThermalGap(), and m_thermalGap.

Referenced by ZONE::GetThermalReliefGap().

GetEffectiveThermalSpokeWidth()

int PAD::GetEffectiveThermalSpokeWidth

(

wxString *

aSource = nullptr

)

const

Return the effective thermal spoke width having resolved any inheritance.

Definition at line 819 of file pcbnew/pad.cpp.

{
    FOOTPRINT* parentFootprint = GetParent();

    if( m_thermalWidth == 0 && parentFootprint )
    {
        if( aSource )
            *aSource = _( "parent footprint" );

        return parentFootprint->GetThermalWidth();
    }

    if( aSource )
        *aSource = _( "pad" );

    return m_thermalWidth;
}

References _, GetParent(), FOOTPRINT::GetThermalWidth(), and m_thermalWidth.

Referenced by ZONE::GetThermalReliefSpokeWidth().

GetEffectiveZoneConnection()

ZONE_CONNECTION PAD::GetEffectiveZoneConnection

(

wxString *

aSource = nullptr

)

const

Return the zone connection in effect (either locally overridden or overridden in the parent footprint).

Optionally reports on the source of the property (pad, parent footprint or zone).

Definition at line 798 of file pcbnew/pad.cpp.

{
    FOOTPRINT* parentFootprint = GetParent();

    if( m_zoneConnection == ZONE_CONNECTION::INHERITED && parentFootprint )
    {
        if( aSource )
            *aSource = _( "parent footprint" );

        return parentFootprint->GetZoneConnection();
    }
    else
    {
        if( aSource )
            *aSource = _( "pad" );

        return m_zoneConnection;
    }
}

References _, GetParent(), FOOTPRINT::GetZoneConnection(), INHERITED, and m_zoneConnection.

Referenced by PCB_IO::format(), ZONE::GetPadConnection(), ImportSettingsFrom(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetFlags()

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 203 of file eda_item.h.

{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRulesForItems(), PCB_SELECTION_TOOL::expandConnection(), insideArea(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_PART::LIB_PART(), DIALOG_DRC::OnDRCItemSelected(), LIB_PART::operator=(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), WS_DATA_ITEM::SyncDrawItems(), WS_DATA_ITEM_POLYGONS::SyncDrawItems(), WS_DATA_ITEM_TEXT::SyncDrawItems(), WS_DATA_ITEM_BITMAP::SyncDrawItems(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

GetFocusPosition()

virtual const wxPoint 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 TRACK.

Definition at line 307 of file eda_item.h.

{ return GetPosition(); }

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

GetKeepTopBottom()

bool PAD::GetKeepTopBottom ( ) const

inline

Definition at line 551 of file pad.h.

{ return m_keepTopBottomLayer; }

References m_keepTopBottomLayer.

Referenced by PCB_IO::format(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 173 of file board_item.h.

{ return m_layer; }

References BOARD_ITEM::m_layer.

Referenced by CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapesWithClearance(), GRAPHICS_CLEANER::areEquivalent(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), AR_AUTOPLACER::buildFpAreas(), TRACKS_CLEANER::cleanup(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), CreateRoutesSection(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_drawsegment(), export_vrml_footprint(), export_vrml_fp_shape(), export_vrml_fp_text(), export_vrml_pcbtext(), export_vrml_tracks(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), FP_SHAPE::Flip(), TRACK::Flip(), FP_TEXT::Flip(), DIMENSION_BASE::Flip(), FOOTPRINT::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::format(), PCB_IO::formatLayer(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), FOOTPRINT::GetBoundingBox(), ZONE::GetLayer(), getMatchingTextItem(), TRACK::GetMsgPanelInfo(), VIA::GetMsgPanelInfo(), GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalFPPlacement(), BOARD::GetPad(), TEXT_MOD_GRID_TABLE::GetValueAsLong(), TRACK::GetWidthConstraints(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), idf_export_footprint(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), IsFlipped(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_ITEM::IsOnCopperLayer(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), TRACK::cmp_tracks::operator()(), PCB_SHAPE::cmp_drawings::operator()(), BOARD_ITEM::ptr_cmp::operator()(), FOOTPRINT::cmp_drawings::operator()(), EAGLE_PLUGIN::packagePad(), BRDITEMS_PLOTTER::PlotBoardGraphicItems(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotPcbText(), CONVERT_TOOL::PolyToLines(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PAD_TOOL::recombinePad(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::Selectable(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTrack(), AR_AUTOPLACER::testFootprintOnBoard(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolygon(), FOOTPRINT::TransformFPShapesWithClearanceToPolygon(), TRACK::ViewGetLayers(), FP_TEXT::ViewGetLayers(), FP_TEXT::ViewGetLOD(), FP_ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

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

{
    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 PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PCB_TEXT::GetSelectMenuText(), FP_SHAPE::GetSelectMenuText(), TRACK::GetSelectMenuText(), DIMENSION_BASE::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetShownText(), TEXT_MOD_GRID_TABLE::GetValue(), 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 356 of file pad.h.

{ return m_layerMask; }

References m_layerMask.

Referenced by CN_LIST::Add(), CreatePadsShapesSection(), doPushPadProperties(), PAD_TOOL::explodePad(), export_vrml_pad(), PCB_IO::format(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), BOARD::GetPad(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), IsOnCopperLayer(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), DIALOG_PAD_PROPERTIES::OnUpdateUINonCopperWarning(), EAGLE_PLUGIN::packagePad(), EAGLE_PLUGIN::packageSMD(), DIALOG_PAD_PROPERTIES::padValuesOK(), ALTIUM_PCB::ParsePads6Data(), AR_MATRIX::PlacePad(), PAD_TOOL::recombinePad(), PCB_SELECTION_TOOL::Selectable(), PNS_KICAD_IFACE_BASE::syncPad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and ViewGetLOD().

GetLocalClearance() [1/2]

int PAD::GetLocalClearance ( wxString *  aSource ) const

overridevirtual

Function GetLocalClearance returns 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

int - the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 692 of file pcbnew/pad.cpp.

{
    if( aSource )
        *aSource = wxString::Format( _( "pad %s" ), GetName() );

    return m_localClearance;
}

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

Referenced by PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetLocalClearance() [2/2]

int PAD::GetLocalClearance ( ) const

inline

Definition at line 375 of file pad.h.

{ return m_localClearance; }

References m_localClearance.

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

GetLocalClearanceOverrides()

int PAD::GetLocalClearanceOverrides ( wxString *  aSource ) const

overridevirtual

Function GetLocalClearanceOverrides returns 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

int - the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 678 of file pcbnew/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 204 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 371 of file pad.h.

{ return m_localSolderMaskMargin; }

References m_localSolderMaskMargin.

Referenced by PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetLocalSolderPasteMargin()

int PAD::GetLocalSolderPasteMargin ( ) const

inline

Definition at line 378 of file pad.h.

{ return m_localSolderPasteMargin; }

References m_localSolderPasteMargin.

Referenced by PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetLocalSolderPasteMarginRatio()

double PAD::GetLocalSolderPasteMarginRatio ( ) const

inline

Definition at line 381 of file pad.h.

{ return m_localSolderPasteMarginRatio; }

References m_localSolderPasteMarginRatio.

Referenced by PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::padValuesOK(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetMenuImage()

BITMAP_DEF 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 1133 of file pcbnew/pad.cpp.

{
    return pad_xpm;
}

References pad_xpm.

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 857 of file pcbnew/pad.cpp.

{
    EDA_UNITS  units = aFrame->GetUserUnits();
    wxString   msg;
    FOOTPRINT* parentFootprint = static_cast<FOOTPRINT*>( m_parent );

    if( parentFootprint )
        aList.emplace_back( _( "Footprint" ), parentFootprint->GetReference() );

    aList.emplace_back( _( "Pad" ), m_name );

    if( !GetPinFunction().IsEmpty() )
        aList.emplace_back( _( "Pin Name" ), GetPinFunction() );

    aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );

    aList.emplace_back( _( "NetClass" ), UnescapeString( GetNetClass()->GetName() ) );

    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" ), MessageTextFromValue( units, m_size.x ) );
    }
    else
    {
        aList.emplace_back( _( "Width" ), MessageTextFromValue( units, m_size.x ) );
        aList.emplace_back( _( "Height" ), MessageTextFromValue( units, m_size.y ) );
    }

    double fp_orient_degrees = parentFootprint ? parentFootprint->GetOrientationDegrees() : 0;
    double pad_orient_degrees = GetOrientationDegrees() - fp_orient_degrees;
    pad_orient_degrees = NormalizeAngleDegrees( pad_orient_degrees, -180.0, +180.0 );

    if( fp_orient_degrees != 0.0 )
        msg.Printf( wxT( "%g(+ %g)" ), pad_orient_degrees, fp_orient_degrees );
    else
        msg.Printf( wxT( "%g" ), GetOrientationDegrees() );

    aList.emplace_back( _( "Rotation" ), msg );

    if( GetPadToDieLength() )
    {
        msg = MessageTextFromValue(units, GetPadToDieLength() );
        aList.emplace_back( _( "Length in Package" ), msg );
    }

    if( m_drill.x > 0 || m_drill.y > 0 )
    {
        if( GetDrillShape() == PAD_DRILL_SHAPE_CIRCLE )
        {
            aList.emplace_back( _( "Hole" ),
                                wxString::Format( "%s",
                                                  MessageTextFromValue( units, m_drill.x ) ) );
        }
        else
        {
            aList.emplace_back( _( "Hole X / Y" ),
                                wxString::Format( "%s / %s",
                                                  MessageTextFromValue( units, m_drill.x ),
                                                  MessageTextFromValue( units, m_drill.y ) ) );
        }
    }

    wxString source;
    int      clearance = GetOwnClearance( GetLayer(), &source );

    aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
                                          MessageTextFromValue( units, clearance ) ),
                        wxString::Format( _( "(from %s)" ), source ) );
}

References _, Format(), GetAttribute(), GetDrillShape(), BOARD_ITEM::GetLayer(), GetName(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetname(), FOOTPRINT::GetOrientationDegrees(), GetOrientationDegrees(), BOARD_CONNECTED_ITEM::GetOwnClearance(), GetPadToDieLength(), GetPinFunction(), GetProperty(), FOOTPRINT::GetReference(), GetShape(), EDA_BASE_FRAME::GetUserUnits(), BOARD_ITEM::layerMaskDescribe(), m_drill, m_name, EDA_ITEM::m_parent, m_size, MessageTextFromValue(), NormalizeAngleDegrees(), PAD_ATTRIB_CONN, PAD_ATTRIB_SMD, PAD_DRILL_SHAPE_CIRCLE, PAD_PROP_BGA, PAD_PROP_CASTELLATED, PAD_PROP_FIDUCIAL_GLBL, PAD_PROP_FIDUCIAL_LOCAL, PAD_PROP_HEATSINK, PAD_PROP_NONE, PAD_PROP_TESTPOINT, PAD_SHAPE_CIRCLE, PAD_SHAPE_OVAL, ShowPadAttr(), ShowPadShape(), and UnescapeString().

GetName()

const wxString& PAD::GetName ( void  ) const

inline

Definition at line 130 of file pad.h.

{ return m_name; }

References m_name.

Referenced by FROM_TO_CACHE::cacheFromToPaths(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), PLACE_FILE_EXPORTER::GenReportData(), GetLocalClearance(), GetMsgPanelInfo(), GetSelectMenuText(), DIALOG_PAD_PROPERTIES::initValues(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), DSN::SPECCTRA_DB::makeIMAGE(), EDA_3D_CANVAS::OnMouseMove(), FOOTPRINT::cmp_pads::operator()(), operator=(), PAD(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), BRDITEMS_PLOTTER::PlotPad(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and ViewGetLayers().

GetNet()

NETINFO_ITEM* BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Function GetNet Returns NET_INFO object for a given item.

Definition at line 81 of file board_connected_item.h.

    {
        return m_netinfo;
    }

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), EDIT_TOOL::FilletTracks(), EDA_3D_CANVAS::OnMouseMove(), BOARD_EDITOR_CONTROL::RepairBoard(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow().

GetNetClass()

NETCLASS * BOARD_CONNECTED_ITEM::GetNetClass ( ) const

virtualinherited

Function GetNetClassPtr returns 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.

Reimplemented in ZONE.

Definition at line 107 of file board_connected_item.cpp.

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

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

Referenced by EDIT_TOOL::ChangeTrackWidth(), DRAWING_TOOL::DrawVia(), VIA::GetDrillValue(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), BOARD_INSPECTION_TOOL::getItemDescription(), GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), ZONE::GetNetClass(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), and DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

GetNetClassName()

wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const

virtualinherited

Function GetNetClassName returns a pointer to the netclass of the zone.

If the net is not found (can happen when a netlist is reread, and the net name does not exist, return the default net class (should not return a null pointer).

Returns

the Net Class name of this item

Reimplemented in ZONE.

Definition at line 116 of file board_connected_item.cpp.

{
    if( m_netinfo )
        return m_netinfo->GetNetClassName();
    else
        return wxEmptyString;
}

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

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), ZONE::GetNetClassName(), main(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const

inlineinherited

Function GetNetCode.

Returns

int - the net code.

Definition at line 99 of file board_connected_item.h.

    {
        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(), BOARD::CombineAllZonesInNet(), connectedItemFilter(), CreateRoutesSection(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), ZONE_FILLER::Fill(), PNS::NODE::FindItemByParent(), PCB_IO::format(), DSN::SPECCTRA_DB::FromBOARD(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), CONNECTIVITY_DATA::GetConnectedItems(), ZONE::GetInteractingZones(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), hash_fp_item(), hasThermalConnection(), BOARD_INSPECTION_TOOL::highlightNet(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::IsConnectedOnLayer(), ZONE::IsIsland(), ZONE::IsSame(), DSN::SPECCTRA_DB::makeIMAGE(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), CN_ITEM::Net(), BOARD::NormalizeAreaPolygon(), BOARD::OnAreaPolygonModified(), TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), PCB_SELECTION_CONDITIONS::sameNetFunc(), SaveCopyOfZones(), PCB_SELECTION_TOOL::selectNet(), ZONE_FILLER::subtractHigherPriorityZones(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), BOARD::TestZoneIntersections(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZones(), BOARD::TracksInNet(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and BOARD_EDITOR_CONTROL::ZoneMerge().

GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inlineinherited

Function GetNetname.

Returns

wxString - the full netname

Definition at line 124 of file board_connected_item.h.

    {
        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(), FROM_TO_CACHE::cacheFromToPaths(), KIGFX::PCB_PAINTER::draw(), PCB_IO::format(), DSN::SPECCTRA_DB::FromBOARD(), ZONE::GetMsgPanelInfo(), GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), CN_CLUSTER::OriginNetName(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotPad(), PlotStandardLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

GetNetnameMsg()

wxString BOARD_CONNECTED_ITEM::GetNetnameMsg ( ) const

inherited

Function GetNetnameMsg.

Returns

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

Definition at line 125 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 ) + "](" + _( "Not Found" ) + ")" );
    else
        return wxT( "[" + UnescapeString( netname ) + "]" );
}

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

Referenced by TRACK::GetSelectMenuText(), VIA::GetSelectMenuText(), and ZONE::GetSelectMenuText().

GetOffset()

const wxPoint& PAD::GetOffset ( ) const

inline

Definition at line 246 of file pad.h.

{ return m_offset; }

References m_offset.

Referenced by CreatePadsShapesSection(), PCB_IO::format(), hash_fp_item(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::SPECCTRA_DB::makePADSTACK(), mirrorPadX(), DIALOG_PAD_PROPERTIES::OnOffsetCheckbox(), PNS_KICAD_IFACE_BASE::syncPad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and POINT_EDITOR::updateItem().

GetOrientation()

double PAD::GetOrientation ( ) const

inline

Function GetOrientation returns the rotation angle of the pad in a variety of units (the basic call returns tenths of degrees).

Definition at line 337 of file pad.h.

{ return m_orient; }

References m_orient.

Referenced by doPushPadProperties(), PAD_TOOL::explodePad(), export_vrml_pad(), export_vrml_padshape(), Flip(), PCB_IO::format(), CN_ITEM::GetAnchor(), hash_fp_item(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), RENDER_3D_RAYTRACE::insertHole(), POINT_EDITOR::makePoints(), mirrorPadX(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), PAD_TOOL::recombinePad(), DIALOG_PAD_PROPERTIES::redraw(), PNS_KICAD_IFACE_BASE::syncPad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), POINT_EDITOR::updateItem(), and POINT_EDITOR::updatePoints().

GetOrientationDegrees()

double PAD::GetOrientationDegrees ( ) const

inline

Definition at line 338 of file pad.h.

{ return m_orient/10.0; }

References m_orient.

Referenced by GetMsgPanelInfo(), DSN::SPECCTRA_DB::makeIMAGE(), and PAD_DESC::PAD_DESC().

GetOrientationRadians()

double PAD::GetOrientationRadians ( ) const

inline

Definition at line 339 of file pad.h.

{ return m_orient*M_PI/1800; }

References m_orient.

GetOwnClearance()

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

virtualinherited

Function GetClearance returns 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

int - the clearance in internal units.

Definition at line 81 of file board_connected_item.cpp.

{
    DRC_CONSTRAINT constraint;

    if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
    {
        BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();

        constraint = bds.m_DRCEngine->EvalRulesForItems( CLEARANCE_CONSTRAINT, this, nullptr,
                                                         aLayer );
    }

    if( constraint.Value().HasMin() )
    {
        if( aSource )
            *aSource = constraint.GetName();

        return constraint.Value().Min();
    }

    return 0;
}

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

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

GetPadToDieLength()

int PAD::GetPadToDieLength ( ) const

inline

Definition at line 369 of file pad.h.

{ return m_lengthPadToDie; }

References m_lengthPadToDie.

Referenced by PCB_IO::format(), GetMsgPanelInfo(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::OnPadToDieCheckbox(), operator=(), PAD(), PAD_DESC::PAD_DESC(), PNS_KICAD_IFACE_BASE::syncPad(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetParent()

FOOTPRINT * PAD::GetParent

(

void

)

const

Definition at line 1296 of file pcbnew/pad.cpp.

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

References EDA_ITEM::m_parent.

Referenced by FROM_TO_CACHE::cacheFromToPaths(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), GERBER_WRITER::createDrillFile(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), doPushPadProperties(), GetEffectiveThermalGap(), GetEffectiveThermalSpokeWidth(), GetEffectiveZoneConnection(), GetLocalClearanceOverrides(), GetSelectMenuText(), GetSolderMaskMargin(), GetSolderPasteMargin(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), IsFlipped(), IsLocked(), PAD(), BRDITEMS_PLOTTER::PlotPad(), PAD_TOOL::pushPadSettings(), SameLogicalPadAs(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), EAGLE_PLUGIN::transferPad(), POINT_EDITOR::updatePoints(), and ViewGetLayers().

GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 93 of file board_item.h.

{ return m_group; }

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), PCB_EDIT_FRAME::ExchangeFootprint(), BOARD::GroupsSanityCheckInternal(), memberOf(), PCB_CONTROL::placeBoardItems(), EDIT_TOOL::Remove(), GROUP_TOOL::RemoveFromGroup(), PCB_GROUP::TopLevelGroup(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), and PCB_GROUP::WithinScope().

GetPinFunction()

const wxString& PAD::GetPinFunction ( ) const

inline

Definition at line 136 of file pad.h.

{ return m_pinFunction; }

References m_pinFunction.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), PCB_IO::format(), GetMsgPanelInfo(), BOARD_NETLIST_UPDATER::getPinFunction(), operator=(), PAD(), and BRDITEMS_PLOTTER::PlotPad().

GetPos0()

const wxPoint& PAD::GetPos0 ( ) const

inline

Definition at line 223 of file pad.h.

{ return m_pos0; }

References m_pos0.

Referenced by MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createPolygonShape(), PCB_IO::format(), hash_fp_item(), DSN::SPECCTRA_DB::makeIMAGE(), operator=(), PAD(), and PCB_PARSER::parseFOOTPRINT_unchecked().

GetPosition()

wxPoint PAD::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 170 of file pad.h.

{ return m_pos; }

References m_pos.

Referenced by DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), AR_AUTOPLACER::computePlacementRatsnestCost(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), BOARD_ADAPTER::createPadWithDrill(), PAD_TOOL::explodePad(), export_vrml_pad(), CN_ITEM::GetAnchor(), GetCenter(), getDrilledHoleShape(), BOARD::GetPad(), FOOTPRINT::GetTopLeftPad(), hash_fp_item(), HitTest(), DIALOG_PAD_PROPERTIES::initValues(), RENDER_3D_RAYTRACE::insertHole(), mirrorPadX(), AR_AUTOPLACER::nearestPad(), operator=(), PAD(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PAD_TOOL::recombinePad(), DIALOG_PAD_PROPERTIES::redraw(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::selectConnectedTracks(), sortPadsByXthenYCoord(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and POINT_EDITOR::updateItem().

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

    {
        return m_editPrimitives;
    }

References m_editPrimitives.

Referenced by PAD_TOOL::explodePad(), PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetProperty()

PAD_PROP_T PAD::GetProperty ( ) const

inline

Definition at line 362 of file pad.h.

{ return m_property; }

References m_property.

Referenced by GERBER_WRITER::createDrillFile(), FlashLayer(), PCB_IO::format(), GetMsgPanelInfo(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::padValuesOK(), and BRDITEMS_PLOTTER::PlotPad().

GetRemoveUnconnected()

bool PAD::GetRemoveUnconnected ( ) const

inline

Definition at line 545 of file pad.h.

{ return m_removeUnconnectedLayer; }

References m_removeUnconnectedLayer.

Referenced by PCB_IO::format(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetRoundRectCornerRadius()

int PAD::GetRoundRectCornerRadius

(

)

const

Definition at line 243 of file pcbnew/pad.cpp.

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

References KiROUND(), m_roundedCornerScale, and m_size.

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

GetRoundRectRadiusRatio()

double PAD::GetRoundRectRadiusRatio ( ) const

inline

Definition at line 514 of file pad.h.

{ return m_roundedCornerScale; }

References m_roundedCornerScale.

Referenced by PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::onCornerRadiusChange(), DIALOG_PAD_PROPERTIES::OnPadShapeSelection(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::updateRoundRectCornerValues().

GetSelectMenuText()

wxString PAD::GetSelectMenuText ( EDA_UNITS  aUnits ) 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 1098 of file pcbnew/pad.cpp.

{
    if( GetName().IsEmpty() )
    {
        if( GetAttribute() == PAD_ATTRIB_SMD || GetAttribute() == PAD_ATTRIB_CONN )
        {
            return wxString::Format( _( "Pad of %s on %s" ),
                                     GetParent()->GetReference(),
                                     layerMaskDescribe() );
        }
        else
        {
            return wxString::Format( _( "Through hole pad of %s" ),
                                     GetParent()->GetReference() );
        }
    }
    else
    {
        if( GetAttribute() == PAD_ATTRIB_SMD || GetAttribute() == PAD_ATTRIB_CONN )
        {
            return wxString::Format( _( "Pad %s of %s on %s" ),
                                     GetName(),
                                     GetParent()->GetReference(),
                                     layerMaskDescribe() );
        }
        else
        {
            return wxString::Format( _( "Through hole pad %s of %s" ),
                                     GetName(),
                                     GetParent()->GetReference() );
        }
    }
}

References _, Format(), GetAttribute(), GetName(), GetParent(), BOARD_ITEM::layerMaskDescribe(), PAD_ATTRIB_CONN, and PAD_ATTRIB_SMD.

GetShape()

PAD_SHAPE_T PAD::GetShape ( ) const

inline

Returns

the shape of this pad.

Definition at line 162 of file pad.h.

{ return m_padShape; }

References m_padShape.

Referenced by ZONE_FILLER::addKnockout(), BuildEffectiveShapes(), BOARD_ADAPTER::buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), Compare(), CreatePadsShapesSection(), BOARD_ADAPTER::createPadWithClearance(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), export_vrml_padshape(), PCB_IO::format(), CN_ITEM::GetAnchor(), GetMsgPanelInfo(), hash_fp_item(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makePADSTACK(), POINT_EDITOR::makePoints(), mirrorPadX(), DIALOG_PAD_PROPERTIES::onCornerRadiusChange(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), EAGLE_PLUGIN::packagePad(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::padValuesOK(), GPCB_FPL_CACHE::parseFOOTPRINT(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), PAD_TOOL::recombinePad(), ShowPadShape(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), TransformShapeWithClearanceToPolygon(), POINT_EDITOR::updateItem(), POINT_EDITOR::updatePoints(), and DIALOG_PAD_PROPERTIES::updateRoundRectCornerValues().

GetShortNetname()

wxString BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inlineinherited

Function GetShortNetname.

Returns

wxString - the short netname

Definition at line 140 of file board_connected_item.h.

    {
        return m_netinfo->GetShortNetname();
    }

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

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

GetSize()

const wxSize& PAD::GetSize ( ) const

inline

Definition at line 229 of file pad.h.

{ return m_size; }

References m_size.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BuildEffectiveShapes(), BOARD_ADAPTER::buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), MICROWAVE_TOOL::createFootprint(), CreatePadsShapesSection(), BOARD_ADAPTER::createPadWithClearance(), KIGFX::PCB_PAINTER::draw(), export_vrml_padshape(), PCB_IO::format(), CN_ITEM::GetAnchor(), GetBestAnchorPosition(), hash_fp_item(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makePADSTACK(), POINT_EDITOR::makePoints(), MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packagePad(), DIALOG_PAD_PROPERTIES::padValuesOK(), GPCB_FPL_CACHE::parseFOOTPRINT(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), EAGLE_PLUGIN::transferPad(), and POINT_EDITOR::updatePoints().

GetSizeX()

const int PAD::GetSizeX ( ) const

inline

Definition at line 231 of file pad.h.

{ return m_size.x; }

References m_size.

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

GetSizeY()

const int PAD::GetSizeY ( ) const

inline

Definition at line 233 of file pad.h.

{ return m_size.y; }

References m_size.

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

GetSolderMaskMargin()

int PAD::GetSolderMaskMargin

(

)

const

Function GetSolderMaskMargin.

Returns

the margin for the solder mask layer usually > 0 (mask shape bigger than pad) 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 For pads NOT on copper layers, the value is the local value because there is no default shape to build

Definition at line 703 of file pcbnew/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 )
        {
            BOARD* brd = GetBoard();

            if( brd )
                margin = brd->GetDesignSettings().m_SolderMaskMargin;
        }
    }

    // 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, and BOARD_DESIGN_SETTINGS::m_SolderMaskMargin.

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

GetSolderPasteMargin()

wxSize PAD::GetSolderPasteMargin

(

)

const

Function GetSolderPasteMargin.

Returns

the margin for the solder mask layer 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 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

For pads NOT on copper layers, the value is the local value because there is no default shape to build

Definition at line 748 of file pcbnew/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 wxSize( 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;
        }
    }

    wxSize 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, and m_size.

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

GetState()

int EDA_ITEM::GetState ( int  type ) const

inlineinherited

Definition at line 185 of file eda_item.h.

    {
        return m_status & type;
    }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 198 of file eda_item.h.

{ return m_status; }

References EDA_ITEM::m_status.

GetSubRatsnest()

int PAD::GetSubRatsnest ( ) const

inline

Function GetSubRatsnest.

Returns

int - the netcode

Definition at line 536 of file pad.h.

{ return m_subRatsnest; }

References m_subRatsnest.

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

GetThermalGap()

int PAD::GetThermalGap ( ) const

inline

Definition at line 491 of file pad.h.

{ return m_thermalGap; }

References m_thermalGap.

Referenced by PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetThermalSpokeWidth()

int PAD::GetThermalSpokeWidth ( ) const

inline

Definition at line 483 of file pad.h.

{ return m_thermalWidth; }

References m_thermalWidth.

Referenced by PCB_IO::format(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 97 of file board_item.h.

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

References EDA_ITEM::GetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), BOARD_ITEM::SetY(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 103 of file board_item.h.

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

References EDA_ITEM::GetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), BOARD_ITEM::SetX(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

GetZoneConnection()

ZONE_CONNECTION PAD::GetZoneConnection ( ) const

inline

Definition at line 468 of file pad.h.

{ return m_zoneConnection; }

References m_zoneConnection.

Referenced by DIALOG_PAD_PROPERTIES::initValues().

HasFlag()

bool EDA_ITEM::HasFlag ( STATUS_FLAGS  aFlag ) const

inlineinherited

Definition at line 204 of file eda_item.h.

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

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), BOARD::CombineAllZonesInNet(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList().

HitTest() [1/2]

bool PAD::HitTest ( const wxPoint &  aPosition, int  aAccuracy = 0  ) const

overridevirtual

Test if aPosition is contained within or on the bounding box of an item.

Parameters

aPosition	A reference to a wxPoint 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 950 of file pcbnew/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 GetBoundingRadius(), GetEffectivePolygon(), GetPosition(), SEG::Square(), and VECTOR2< T >::SquaredEuclideanNorm().

Referenced by BOARD::GetTrackLength().

HitTest() [2/2]

bool PAD::HitTest ( const EDA_RECT &  aRect, bool  aContained, int  aAccuracy = 0  ) const

overridevirtual

Test if aRect intersects or is contained within the bounding box of an item.

Parameters

aRect	A reference to a EDA_RECT 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 962 of file pcbnew/pad.cpp.

{
    auto getArea = []( const SHAPE_POLY_SET& aPoly ) -> double
                   {
                       return aPoly.OutlineCount() ? aPoly.COutline( 0 ).Area() : 0;
                   };

    EDA_RECT arect = aRect;
    arect.Normalize();
    arect.Inflate( aAccuracy );

    EDA_RECT bbox = GetBoundingBox();

    if( !arect.Intersects( bbox ) )
        return false;

    // This covers total containment for all test cases
    if( arect.Contains( bbox ) )
        return true;

    SHAPE_POLY_SET selRect;
    selRect.NewOutline();
    selRect.Append( arect.GetOrigin() );
    selRect.Append( VECTOR2I( arect.GetRight(), arect.GetTop() ) );
    selRect.Append( VECTOR2I( arect.GetRight(), arect.GetBottom() ) );
    selRect.Append( VECTOR2I( arect.GetLeft(), arect.GetBottom() ) );

    selRect.BooleanIntersection( *GetEffectivePolygon(), SHAPE_POLY_SET::PM_FAST );

    double padArea = getArea( *GetEffectivePolygon() );
    double intersection = getArea( selRect );

    if( intersection > ( padArea * 0.99 ) )
        return true;
    else
        return !aContained && intersection > 0;
}

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::BooleanIntersection(), EDA_RECT::Contains(), EDA_RECT::GetBottom(), GetBoundingBox(), GetEffectivePolygon(), EDA_RECT::GetLeft(), EDA_RECT::GetOrigin(), EDA_RECT::GetRight(), EDA_RECT::GetTop(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), SHAPE_POLY_SET::NewOutline(), EDA_RECT::Normalize(), and SHAPE_POLY_SET::PM_FAST.

ImportSettingsFrom()

void PAD::ImportSettingsFrom

(

const PAD &

aMasterPad

)

Imports the pad settings from aMasterPad.

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

Parameters

aMasterPad

= the template pad

Definition at line 1302 of file pcbnew/pad.cpp.

{
    SetShape( aMasterPad.GetShape() );
    SetLayerSet( aMasterPad.GetLayerSet() );
    SetAttribute( aMasterPad.GetAttribute() );
    SetProperty( aMasterPad.GetProperty() );

    // I am not sure the m_LengthPadToDie must be imported, because this is
    // a parameter really specific to a given pad (JPC).
    // So this is currently non imported
    #if 0
    SetPadToDieLength( aMasterPad.GetPadToDieLength() );
    #endif

    // The pad orientation, for historical reasons is the
    // pad rotation + parent rotation.
    // So we have to manage this parent rotation
    double 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( wxSize( 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( wxSize( GetSize().x, GetSize().x ) );
        break;

    default:
        ;
    }

    switch( aMasterPad.GetAttribute() )
    {
    case PAD_ATTRIB_SMD:
    case PAD_ATTRIB_CONN:
        // These pads do not have hole (they are expected to be only on one
        // external copper layer)
        SetDrillSize( wxSize( 0, 0 ) );
        break;

    default:
        ;
    }

    // copy also local settings:
    SetLocalClearance( aMasterPad.GetLocalClearance() );
    SetLocalSolderMaskMargin( aMasterPad.GetLocalSolderMaskMargin() );
    SetLocalSolderPasteMargin( aMasterPad.GetLocalSolderPasteMargin() );
    SetLocalSolderPasteMarginRatio( aMasterPad.GetLocalSolderPasteMarginRatio() );

    SetZoneConnection( aMasterPad.GetEffectiveZoneConnection() );
    SetThermalSpokeWidth( aMasterPad.GetThermalSpokeWidth() );
    SetThermalGap( aMasterPad.GetThermalGap() );

    SetCustomShapeInZoneOpt( aMasterPad.GetCustomShapeInZoneOpt() );

    // Add or remove custom pad shapes:
    ReplacePrimitives( aMasterPad.GetPrimitives() );
    SetAnchorPadShape( aMasterPad.GetAnchorPadShape() );

    SetDirty();
}

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

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

IsAperturePad()

bool PAD::IsAperturePad ( ) const

inline

Definition at line 366 of file pad.h.

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

References LSET::AllCuMask(), and m_layerMask.

Referenced by doPushPadProperties(), DIALOG_PAD_PROPERTIES::initValues(), and PAD_NAMING::PadCanHaveName().

IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 174 of file eda_item.h.

{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::WS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

IsConnected()

bool BOARD_CONNECTED_ITEM::IsConnected ( ) const

inlineoverridevirtualinherited

Reimplemented from BOARD_ITEM.

Reimplemented in ZONE.

Definition at line 72 of file board_connected_item.h.

    {
        return true;
    }

Referenced by BOARD_INSPECTION_TOOL::InspectClearance().

IsDirty()

bool PAD::IsDirty ( ) const

inline

Definition at line 344 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 169 of file eda_item.h.

{ return m_flags & IS_DRAGGED; }

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), and KIGFX::SCH_PAINTER::setDeviceColors().

IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 172 of file eda_item.h.

{ return m_flags & ENTERED; }

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 178 of file pcbnew/pad.cpp.

{
    if( GetParent() &&  GetParent()->GetLayer() == B_Cu )
        return true;
    return false;
}

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

{ return m_forceVisible; }

References EDA_ITEM::m_forceVisible.

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

IsLocked()

bool PAD::IsLocked ( ) const

overridevirtual

Returns

true if the object is locked, else false.

Reimplemented from BOARD_ITEM.

Definition at line 134 of file pcbnew/pad.cpp.

{
    if( GetParent() && static_cast<FOOTPRINT*>( GetParent() )->IsLocked() )
        return true;

    return BOARD_ITEM::IsLocked();
};

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

Referenced by PCB_IO::format(), DIALOG_PAD_PROPERTIES::initValues(), POINT_EDITOR::makePoints(), and POINT_EDITOR::updatePoints().

IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 166 of file eda_item.h.

{ 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 168 of file eda_item.h.

{ return m_flags & IS_MOVED; }

References IS_MOVED, and EDA_ITEM::m_flags.

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

IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 167 of file eda_item.h.

{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and SCH_EDIT_FRAME::UpdateSymbolFromEditor().

IsOnCopperLayer()

bool PAD::IsOnCopperLayer ( ) const

inlineoverridevirtual

Returns

true if the pad is on any copper layer, false otherwise. pads can be only on tech layers to build special pads. they are therefore not always on a copper layer

Reimplemented from BOARD_ITEM.

Definition at line 214 of file pad.h.

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

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

Referenced by CN_LIST::Add(), isCopper(), EDA_3D_CANVAS::OnMouseMove(), 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 555 of file pad.h.

    {
        return m_layerMask[aLayer];
    }

References m_layerMask.

Referenced by AR_AUTOPLACER::addPad(), PAD_TOOL::explodePad(), FlashLayer(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), DSN::SPECCTRA_DB::makePADSTACK(), PAD_TOOL::recombinePad(), PCB_SELECTION_TOOL::Selectable(), and ViewGetLayers().

IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

Returns

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

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_SHEET_PIN, and SCH_FIELD.

Definition at line 451 of file eda_item.h.

{ return false; }

Referenced by EDA_ITEM::Matches().

IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 173 of file eda_item.h.

{ return m_flags & IS_RESIZED; }

References IS_RESIZED, and EDA_ITEM::m_flags.

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

IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 171 of file eda_item.h.

{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::WS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_LEGACY::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), PCB_SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), and WS_PROXY_UNDO_ITEM::WS_PROXY_UNDO_ITEM().

IsTrack()

bool BOARD_ITEM::IsTrack ( ) const

inlineinherited

Test to see if this object is a track or via (or microvia).

Returns

true if a track or via, else false.

Definition at line 241 of file board_item.h.

    {
        return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
    }

References PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

IsType()

bool PAD::IsType ( const 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 86 of file pad.h.

    {
        if( BOARD_CONNECTED_ITEM::IsType( aScanTypes ) )
            return true;

        for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
        {
            if( m_drill.x > 0 && m_drill.y > 0 )
            {
                if( *p == PCB_LOCATE_HOLE_T )
                    return true;
                else if( *p == PCB_LOCATE_PTH_T && m_attribute != PAD_ATTRIB_NPTH )
                    return true;
                else if( *p == PCB_LOCATE_NPTH_T && m_attribute == PAD_ATTRIB_NPTH )
                    return true;
            }
        }

        return false;
    }

References EOT, EDA_ITEM::IsType(), m_attribute, m_drill, PAD_ATTRIB_NPTH, PCB_LOCATE_HOLE_T, PCB_LOCATE_NPTH_T, and PCB_LOCATE_PTH_T.

IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 170 of file eda_item.h.

{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 343 of file eda_item.h.

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

        return SEARCH_RESULT::CONTINUE;
    }

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

Referenced by GERBER_FILE_IMAGE::Visit().

IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 362 of file eda_item.h.

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

        return SEARCH_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.

The BOARD is needed because layer names are customizable.

Reimplemented in VIA.

Definition at line 72 of file board_item.cpp.

{
    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 TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), and GetSelectMenuText().

Matches() [1/2]

virtual bool EDA_ITEM::Matches ( const wxFindReplaceData &  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_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 413 of file eda_item.h.

    {
        return false;
    }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), PCB_MARKER::Matches(), SCH_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_FIELD::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

Matches() [2/2]

bool EDA_ITEM::Matches ( const wxString &  aText, const wxFindReplaceData &  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 132 of file eda_item.cpp.

{
    wxString text = aText;
    wxString searchText = aSearchData.GetFindString();

    // Don't match if searching for replaceable item and the item doesn't support text replace.
    if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
        return false;

    if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
        return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );

    if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
    {
        if( aSearchData.GetFlags() & wxFR_MATCHCASE )
            return text.Matches( searchText );

        return text.MakeUpper().Matches( searchText.MakeUpper() );
    }

    if( aSearchData.GetFlags() & wxFR_MATCHCASE )
        return aText.Find( searchText ) != wxNOT_FOUND;

    return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
}

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, and EDA_ITEM::IsReplaceable().

MergePrimitivesAsPolygon()

void PAD::MergePrimitivesAsPolygon	(	SHAPE_POLY_SET *	aMergedPolygon,
		PCB_LAYER_ID	aLayer
	)		const

Merge all basic shapes to a SHAPE_POLY_SET Note: The results are relative to the pad position, orientation 0.

Definition at line 196 of file pad_custom_shape_functions.cpp.

{
    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,
                                  ERROR_INSIDE );
        break;
    }

    addPadPrimitivesToPolygon( aMergedPolygon, aLayer, maxError, ERROR_INSIDE );
}

References SHAPE_POLY_SET::AddOutline(), addPadPrimitivesToPolygon(), ERROR_INSIDE, GetAnchorPadShape(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), GetSize(), BOARD_DESIGN_SETTINGS::m_MaxError, SHAPE_RECT::Outline(), PAD_SHAPE_CIRCLE, PAD_SHAPE_RECT, SHAPE_POLY_SET::RemoveAllContours(), and TransformCircleToPolygon().

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

Move() [1/2]

void BOARD_ITEM::Move ( const VECTOR2I &  aMoveVector )

inlineinherited

Definition at line 283 of file board_item.h.

    {
        Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
    }

References BOARD_ITEM::Move(), VECTOR2< T >::x, and VECTOR2< T >::y.

Move() [2/2]

void PAD::Move ( const wxPoint &  aMoveVector )

inlineoverridevirtual

Move this object.

Parameters

aMoveVector

the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 604 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 185 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 115 of file pcbnew/pad.cpp.

{
    BOARD_CONNECTED_ITEM::operator=( aOther );

    ImportSettingsFrom( aOther );
    SetPadToDieLength( aOther.GetPadToDieLength() );
    SetPosition( aOther.GetPosition() );
    SetPos0( aOther.GetPos0() );
    SetName( aOther.GetName() );
    SetPinFunction( aOther.GetPinFunction() );
    SetSubRatsnest( aOther.GetSubRatsnest() );
    m_effectiveBoundingRadius = aOther.m_effectiveBoundingRadius;
    m_removeUnconnectedLayer = aOther.m_removeUnconnectedLayer;
    m_keepTopBottomLayer = aOther.m_keepTopBottomLayer;

    return *this;
}