#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

wxString	GetParentAsString () const

bool	IsLocked () const override

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

bool	IsFlipped () const

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

const wxString &	GetNumber () const

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

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

const wxString &	GetPinFunction () const

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

const wxString &	GetPinType () const

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

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

PAD_SHAPE	GetShape () const

void	SetPosition (const wxPoint &aPos) override

wxPoint	GetPosition () const override

PAD_SHAPE	GetAnchorPadShape () const

CUST_PAD_SHAPE_IN_ZONE	GetCustomShapeInZoneOpt () const

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

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

bool	IsOnCopperLayer () const override

void	SetY (int y)

void	SetX (int x)

void	SetPos0 (const 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, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
	Merge all basic shapes to a SHAPE_POLY_SET. More...

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

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

void	Flip (const 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 primitive list (composed of basic shapes) and add items to the current list. More...

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

void	SetOrientation (double aAngle)
	Set the rotation angle of the pad. More...

void	SetOrientationDegrees (double aOrientation)
	Set orientation in degrees. More...

double	GetOrientation () const
	Return 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_ATTRIB aAttribute)

PAD_ATTRIB	GetAttribute () const

void	SetProperty (PAD_PROP aProperty)

PAD_PROP	GetProperty () const

bool	IsAperturePad () const

void	SetPadToDieLength (int aLength)

int	GetPadToDieLength () const

int	GetLocalSolderMaskMargin () const

void	SetLocalSolderMaskMargin (int aMargin)

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

int	GetLocalClearance () const

void	SetLocalClearance (int aClearance)

int	GetLocalSolderPasteMargin () const

void	SetLocalSolderPasteMargin (int aMargin)

double	GetLocalSolderPasteMarginRatio () const

void	SetLocalSolderPasteMarginRatio (double aRatio)

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

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

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

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

const SHAPE_SEGMENT *	GetEffectiveHoleShape () const
	Return a SHAPE object representing the pad's hole. More...

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

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

int	GetSolderMaskMargin () const

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

void	SetZoneConnection (ZONE_CONNECTION aType)

ZONE_CONNECTION	GetZoneConnection () const

ZONE_CONNECTION	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)
	Has meaning only for rounded rectangle pads. More...

int	GetRoundRectCornerRadius () const

wxPoint	ShapePos () const

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

double	GetRoundRectRadiusRatio () const

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

double	GetChamferRectRatio () const

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

int	GetChamferPositions () const

int	GetSubRatsnest () const

void	SetSubRatsnest (int aSubRatsnest)

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

bool	GetRemoveUnconnected () const

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

bool	GetKeepTopBottom () const

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

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

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

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

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

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

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

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

void	SetDrawCoord ()

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

void	Move (const 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...

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

wxString	ShowPadShape () const

wxString	ShowPadAttr () const

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

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

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

void	BuildEffectivePolygon () const

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

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

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

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

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

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

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

int	GetNetCode () const

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

void	SetNetCode (int aNetCode)

wxString	GetNetname () const

wxString	GetNetnameMsg () const

wxString	GetShortNetname () const

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

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

virtual NETCLASS *	GetEffectiveNetclass () const
	Return the NETCLASS for this item, or the default netclass if none is defined. More...

virtual wxString	GetNetClassName () const
	Returns 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

BOARD_ITEM_CONTAINER *	GetParentFootprint () 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 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 const BOARD *	GetBoard () const
	Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...

virtual BOARD *	GetBoard ()

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

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

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

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 aPadRef, const PAD aPadCmp)
	Compare two pads and return 0 if they are equal. 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
	Store all information about the net that item belongs to. More...

PCB_LAYER_ID	m_layer

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

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

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

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

Private Attributes
wxString	m_number

wxString	m_pinFunction

wxString	m_pinType

wxPoint	m_pos

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

wxPoint	m_offset

LSET	m_layerMask

wxSize	m_deltaSize

wxPoint	m_pos0

PAD_ATTRIB	m_attribute

PAD_PROP	m_property

double	m_orient

int	m_lengthPadToDie

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

bool	m_keepTopBottomLayer

int	m_localClearance

int	m_localSolderMaskMargin

int	m_localSolderPasteMargin

double	m_localSolderPasteMarginRatio

ZONE_CONNECTION	m_zoneConnection

int	m_thermalWidth

int	m_thermalGap

Detailed Description

Definition at line 57 of file pad.h.

Constructor & Destructor Documentation

◆ PAD() [1/2]

PAD::PAD ( FOOTPRINT * parent )

Definition at line 60 of file pad.cpp.

  :
  BOARD_CONNECTED_ITEM( parent, PCB_PAD_T )
 {
  m_size.x = m_size.y = 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 CIRCLE, CUST_PAD_SHAPE_IN_ZONE_OUTLINE, GetParent(), FOOTPRINT::GetPosition(), INHERITED, m_attribute, m_chamferPositions, m_chamferScale, m_customShapeClearanceArea, m_drill, m_effectiveBoundingRadius, m_keepTopBottomLayer, m_layerMask, m_lengthPadToDie, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_orient, EDA_ITEM::m_parent, m_pos, m_removeUnconnectedLayer, m_roundedCornerScale, m_size, m_thermalGap, m_thermalWidth, m_zoneConnection, NONE, PAD_DRILL_SHAPE_CIRCLE, PCB_FOOTPRINT_T, PTH, 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 107 of file pad.cpp.

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

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

Member Function Documentation

◆ addPadPrimitivesToPolygon()

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

private

Definition at line 191 of file pad_custom_shape_functions.cpp.

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

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

Referenced by GetBestAnchorPosition(), and MergePrimitivesAsPolygon().

◆ AddPrimitive()

void PAD::AddPrimitive ( PCB_SHAPE * aPrimitive )

Add item to the custom shape primitives list.

Definition at line 173 of file pad_custom_shape_functions.cpp.

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

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

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

◆ AddPrimitiveArc()

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

Definition at line 92 of file pad_custom_shape_functions.cpp.

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

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

◆ AddPrimitiveCircle()

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

Definition at line 123 of file pad_custom_shape_functions.cpp.

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

References CIRCLE, m_editPrimitives, SetDirty(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetStart(), and EDA_SHAPE::SetWidth().

◆ AddPrimitiveCurve()

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

Definition at line 107 of file pad_custom_shape_functions.cpp.

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

References BEZIER, m_editPrimitives, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), SetDirty(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetStart(), and EDA_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 40 of file pad_custom_shape_functions.cpp.

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

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::COutline(), SHAPE_POLY_SET::Fracture(), SHAPE_POLY_SET::HasHoles(), m_editPrimitives, SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, POLY, and SetDirty().

Referenced by FABMASTER::loadFootprints().

◆ AddPrimitivePoly() [2/2]

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

Definition at line 67 of file pad_custom_shape_functions.cpp.

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

References m_editPrimitives, POLY, SetDirty(), EDA_SHAPE::SetFilled(), EDA_ITEM::SetParent(), EDA_SHAPE::SetPolyPoints(), and EDA_SHAPE::SetWidth().

◆ AddPrimitiveRect()

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

Definition at line 136 of file pad_custom_shape_functions.cpp.

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

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

◆ AddPrimitiveSegment()

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

Definition at line 79 of file pad_custom_shape_functions.cpp.

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

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

◆ ApertureMask()

LSET PAD::ApertureMask ( )

static

layer set for an aperture pad

Definition at line 187 of file pad.cpp.

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

References F_Paste.

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

◆ AppendPrimitives()

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

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

Copies the input, which is not altered.

Definition at line 163 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 530 of file pad.cpp.

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

References 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

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

Definition at line 354 of file pad.cpp.

 {
  std::lock_guard<std::mutex> RAII_lock( m_shapesBuildingLock );
 
  // If we had to wait for the lock then we were probably waiting for someone else to
  // finish rebuilding the shapes. So check to see if they're clean now.
  if( !m_shapesDirty )
  return;
 
  const BOARD* board = GetBoard();
  int maxError = board ? board->GetDesignSettings().m_MaxError : ARC_HIGH_DEF;
 
  m_effectiveShape = std::make_shared<SHAPE_COMPOUND>();
  m_effectiveHoleShape = nullptr;
 
  auto add = [this]( SHAPE* aShape )
  {
  m_effectiveShape->AddShape( aShape );
  };
 
  wxPoint shapePos = ShapePos(); // Fetch only once; rotation involves trig
  PAD_SHAPE effectiveShape = GetShape();
 
  if( GetShape() == PAD_SHAPE::CUSTOM )
  effectiveShape = GetAnchorPadShape();
 
  switch( effectiveShape )
  {
  case PAD_SHAPE::CIRCLE:
  add( new SHAPE_CIRCLE( shapePos, m_size.x / 2 ) );
  break;
 
  case PAD_SHAPE::OVAL:
  if( m_size.x == m_size.y ) // the oval pad is in fact a circle
  {
  add( new SHAPE_CIRCLE( shapePos, m_size.x / 2 ) );
  }
  else
  {
  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(), 0, maxError, ERROR_INSIDE );
 
  add( new SHAPE_SIMPLE( outline.COutline( 0 ) ) );
  }
  break;
 
  default:
  wxFAIL_MSG( wxT( "PAD::buildEffectiveShapes: Unsupported pad shape: " )
  + PAD_SHAPE_T_asString( effectiveShape ) );
  break;
   }
 
  if( GetShape() == PAD_SHAPE::CUSTOM )
  {
  for( const std::shared_ptr<PCB_SHAPE>& primitive : m_editPrimitives )
  {
  for( SHAPE* shape : primitive->MakeEffectiveShapes() )
  {
  shape->Rotate( -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 );
  bbox = m_effectiveHoleShape->BBox();
  m_effectiveBoundingBox.Merge( EDA_RECT( (wxPoint) bbox.GetPosition(),
  wxSize( bbox.GetWidth(), bbox.GetHeight() ) ) );
 
  // All done
  m_shapesDirty = false;
 }

References SHAPE_LINE_CHAIN::Append(), CHAMFERED_RECT, CIRCLE, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), CUSTOM, 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, EDA_RECT::Merge(), Millimeter2iu(), SHAPE_LINE_CHAIN::Move(), OVAL, PAD_SHAPE_T_asString(), SHAPE_LINE_CHAIN::PointCount(), r, RECT, SHAPE_LINE_CHAIN::Rotate(), RotatePoint(), ROUNDRECT, ShapePos(), TransformRoundChamferedRectToPolygon(), TRAPEZOID, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ CanHaveNumber()

bool PAD::CanHaveNumber ( ) const

Indicates whether or not the pad can have a number.

(NPTH and SMD aperture pads can not.)

Definition at line 136 of file pad.cpp.

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

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

◆ ClassOf()

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

inlinestatic

Definition at line 79 of file pad.h.

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

References PCB_PAD_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132 { ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:153

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), 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 171 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_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 153 of file eda_item.h.

153 { m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

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(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), 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 131 of file eda_item.h.

131 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:153

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< 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 165 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 143 of file view_item.h.

  {
  m_viewPrivData = nullptr;
  }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * PAD::Clone ( ) const

overridevirtual

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

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 1240 of file pad.cpp.

 {
  return new PAD( *this );
 }

References PAD().

Referenced by ClonePad(), and GetEffectiveShape().

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

  {
  return (PAD*) Clone();
  }

References Clone().

◆ Compare()

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

static

Compare two pads and return 0 if they are equal.

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

Definition at line 1066 of file pad.cpp.

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

References GetShape(), m_attribute, m_chamferPositions, m_chamferScale, m_deltaSize, m_drill, m_drillShape, m_editPrimitives, m_layerMask, m_offset, m_roundedCornerScale, 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 173 of file pad.cpp.

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

References F_Cu, and F_Mask.

Referenced by DIALOG_PAD_PROPERTIES::updatePadLayersList().

◆ DeletePrimitivesList()

void PAD::DeletePrimitivesList ( )

Clear the basic shapes list.

Definition at line 183 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 128 of file board_item.cpp.

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

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

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

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 144 of file board_item.cpp.

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

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

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

◆ FlashLayer() [1/2]

bool PAD::FlashLayer ( int aLayer ) const

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

Parameters

aLayer Layer to check for connectivity

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

Heat sink pads always get copper

Definition at line 214 of file pad.cpp.

 {
  std::vector<KICAD_T> types
  { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T, PCB_ZONE_T, PCB_FP_ZONE_T };
 
  if( aLayer != UNDEFINED_LAYER && !IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) ) )
  return false;
 
  if( aLayer == UNDEFINED_LAYER )
  return true;
 
  if( GetAttribute() == PAD_ATTRIB::NPTH && IsCopperLayer( aLayer ) )
  {
  if( GetShape() == PAD_SHAPE::CIRCLE && GetDrillShape() == PAD_DRILL_SHAPE_CIRCLE )
  {
  if( GetOffset() == wxPoint( 0, 0 ) && GetDrillSize().x >= GetSize().x )
  return false;
  }
  else if( GetShape() == PAD_SHAPE::OVAL && GetDrillShape() == PAD_DRILL_SHAPE_OBLONG )
  {
  if( GetOffset() == wxPoint( 0, 0 )
  && GetDrillSize().x >= GetSize().x && GetDrillSize().y >= GetSize().y )
  {
  return false;
  }
  }
  }
 
  if( LSET::FrontBoardTechMask().test( aLayer ) )
  aLayer = F_Cu;
  else if( LSET::BackBoardTechMask().test( aLayer ) )
  aLayer = B_Cu;
 
  if( GetAttribute() == PAD_ATTRIB::PTH && IsCopperLayer( aLayer ) )
  {
  if( GetProperty() == PAD_PROP::HEATSINK )
  return true;
 
  if( !m_removeUnconnectedLayer )
  return true;
 
  // Plated through hole pads need copper on the top/bottom layers for proper soldering
  // Unless the user has removed them in the pad dialog
  if( m_keepTopBottomLayer && ( aLayer == F_Cu || aLayer == B_Cu ) )
  return true;
 
  if( const BOARD* board = GetBoard() )
  return board->GetConnectivity()->IsConnectedOnLayer( this, aLayer, types, true );
  }
 
  return true;
 }

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

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

◆ FlashLayer() [2/2]

bool PAD::FlashLayer ( LSET aLayers ) const

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

Parameters

aLayers set of layers to check the via against

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

Definition at line 202 of file pad.cpp.

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

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

◆ Flip() [1/2]

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

inlineinherited

Definition at line 264 of file board_item.h.

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

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

◆ Flip() [2/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 639 of file pad.cpp.

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

References FlipLayerMask(), FlipPrimitives(), GetOrientation(), m_chamferPositions, m_deltaSize, m_layerMask, m_offset, m_pos, m_pos0, MIRROR(), RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT, RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT, SetDirty(), SetLayerSet(), and SetOrientation().

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

◆ FlipPrimitives()

void PAD::FlipPrimitives ( bool aFlipLeftRight )

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

Definition at line 697 of file 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 86 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 BOOST_AUTO_TEST_CASE(), 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 95 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 104 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 = T();
 
  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 PAD::GetAnchorPadShape ( ) const

inline

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

Definition at line 183 of file pad.h.

183 { return m_anchorPadShape; }

PAD::m_anchorPadShape

PAD_SHAPE m_anchorPadShape

Definition: pad.h:726

References m_anchorPadShape.

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

◆ GetAttribute()

PAD_ATTRIB PAD::GetAttribute ( ) const

inline

Definition at line 371 of file pad.h.

371 { return m_attribute; }

PAD::m_attribute

PAD_ATTRIB m_attribute

Definition: pad.h:748

References m_attribute.

Referenced by ZONE_FILLER::addHoleKnockout(), CanHaveNumber(), doPushPadProperties(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), FlashLayer(), PCB_PLUGIN::format(), GetEffectiveShape(), GetMsgPanelInfo(), GetSelectMenuText(), DRC_ENGINE::GetShape(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::padValuesOK(), BRDITEMS_PLOTTER::PlotPad(), ShowPadAttr(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and ViewGetLOD().

◆ GetBestAnchorPosition()

bool PAD::GetBestAnchorPosition ( VECTOR2I & aPos )

Definition at line 241 of file pad_custom_shape_functions.cpp.

 {
  SHAPE_POLY_SET poly;
  addPadPrimitivesToPolygon( &poly, ARC_LOW_DEF, ERROR_INSIDE );
 
  if( poly.OutlineCount() > 1 )
  return false;
 
  const int minSteps = 10;
  const int maxSteps = 50;
 
  int stepsX, stepsY;
 
  auto bbox = poly.BBox();
 
  if( bbox.GetWidth() < bbox.GetHeight() )
  {
  stepsX = minSteps;
  stepsY = minSteps * (double) bbox.GetHeight() / (double )(bbox.GetWidth() + 1);
  }
  else
  {
  stepsY = minSteps;
  stepsX = minSteps * (double) bbox.GetWidth() / (double )(bbox.GetHeight() + 1);
  }
 
  stepsX = std::max(minSteps, std::min( maxSteps, stepsX ) );
  stepsY = std::max(minSteps, std::min( maxSteps, stepsY ) );
 
  VECTOR2I center = bbox.Centre();
 
  int64_t minDist = std::numeric_limits<int64_t>::max();
  int64_t minDistEdge;
 
  if( GetAnchorPadShape() == PAD_SHAPE::CIRCLE )
  {
  minDistEdge = GetSize().x;
  }
  else
  {
  minDistEdge = std::max( GetSize().x, GetSize().y );
  }
 
  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(), CIRCLE, 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(), rescale(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetBoard() [1/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 36 of file board_item.cpp.

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

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

Referenced by ZONE_FILLER::addHoleKnockout(), BuildEffectivePolygon(), BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), calcIsInsideArea(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), PCB_LAYER_VALUE::EqualTo(), existsOnLayer(), exprFromTo(), PCB_VIA::FlashLayer(), FlashLayer(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), FP_SHAPE::Flip(), PCB_SHAPE::Flip(), FP_TEXT::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), ZONE::Flip(), PCB_EXPR_CONTEXT::GetBoard(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), GetEffectiveShape(), PCB_VIA::GetEffectiveShape(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), PCB_VIA::GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), ZONE::GetSelectMenuText(), DRC_ENGINE::GetShape(), FP_TEXT::GetShownText(), GetSolderMaskMargin(), GetSolderPasteMargin(), BOARD::GetTrackLength(), inDiffPair(), insideArea(), insideBackCourtyard(), insideCourtyard(), insideFrontCourtyard(), isInsideArea(), isInsideCourtyard(), BOARD_ITEM::IsLocked(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), CONVERT_TOOL::makePolysFromCircles(), MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), ZONE::TransformSolidAreasShapesToPolygon(), PCB_TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), PCB_VIA::ViewGetLOD(), and ViewGetLOD().

◆ GetBoard() [2/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 50 of file board_item.cpp.

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

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

◆ GetBoundingBox()

const EDA_RECT PAD::GetBoundingBox ( ) const

overridevirtual

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

Set absolute coordinates.

Reimplemented from EDA_ITEM.

Definition at line 569 of file pad.cpp.

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

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

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

◆ GetBoundingRadius()

int PAD::GetBoundingRadius ( ) const

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

The center is the pad position NOT THE SHAPE POS!

Definition at line 345 of file 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 252 of file pad.h.

252 { return GetPosition(); }

PAD::GetPosition

wxPoint GetPosition() const override

Definition: pad.h:178

References GetPosition().

◆ GetChamferPositions()

int PAD::GetChamferPositions ( ) const

inline

Definition at line 543 of file pad.h.

543 { return m_chamferPositions; }

PAD::m_chamferPositions

int m_chamferPositions

Definition: pad.h:724

References m_chamferPositions.

Referenced by BuildEffectiveShapes(), PCB_PLUGIN::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 533 of file pad.h.

533 { return m_chamferScale; }

PAD::m_chamferScale

double m_chamferScale

Definition: pad.h:722

References m_chamferScale.

Referenced by BuildEffectiveShapes(), PCB_PLUGIN::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 593 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 188 of file pad.h.

  {
  return m_customShapeClearanceArea;
  }

References m_customShapeClearanceArea.

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

◆ GetDelta()

const wxSize& PAD::GetDelta ( ) const

inline

Definition at line 240 of file pad.h.

240 { return m_deltaSize; }

PAD::m_deltaSize

wxSize m_deltaSize

Definition: pad.h:741

References m_deltaSize.

Referenced by PCB_PLUGIN::format(), 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 354 of file pad.h.

354 { return m_drillShape; }

PAD::m_drillShape

PAD_DRILL_SHAPE_T m_drillShape

Definition: pad.h:718

References m_drillShape.

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

◆ GetDrillSize()

const wxSize& PAD::GetDrillSize ( ) const

inline

◆ GetDrillSizeX()

const int PAD::GetDrillSizeX ( ) const

inline

Definition at line 245 of file pad.h.

245 { return m_drill.x; }

PAD::m_drill

wxSize m_drill

Definition: pad.h:715

References m_drill.

Referenced by BOARD_INSPECTION_TOOL::InspectClearance(), PAD_DESC::PAD_DESC(), and ViewGetLOD().

◆ GetDrillSizeY()

const int PAD::GetDrillSizeY ( ) const

inline

Definition at line 247 of file pad.h.

247 { return m_drill.y; }

PAD::m_drill

wxSize m_drill

Definition: pad.h:715

References m_drill.

Referenced by BOARD_INSPECTION_TOOL::InspectClearance(), PAD_DESC::PAD_DESC(), and ViewGetLOD().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

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

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

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveHoleShape()

const SHAPE_SEGMENT * PAD::GetEffectiveHoleShape ( ) const

Return a SHAPE object representing the pad's hole.

Definition at line 336 of file 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(), GetEffectiveShape(), DRC_ENGINE::GetShape(), DIALOG_PAD_PROPERTIES::padValuesOK(), PNS_KICAD_IFACE_BASE::syncPad(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and TransformHoleWithClearanceToPolygon().

◆ GetEffectiveNetclass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetclass ( ) const

virtualinherited

Return the NETCLASS for this item, 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 66 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 300 of file pad.cpp.

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

References BuildEffectivePolygon(), m_effectivePolygon, and m_polyDirty.

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

◆ GetEffectiveShape()

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

overridevirtual

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

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

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 309 of file pad.cpp.

 {
  if( ( GetAttribute() == PAD_ATTRIB::PTH && aFlash == FLASHING::NEVER_FLASHED )
  || ( aLayer != UNDEFINED_LAYER && !FlashLayer( aLayer ) ) )
  {
  if( GetAttribute() == PAD_ATTRIB::PTH )
  {
  BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();
 
  // Note: drill size represents finish size, which means the actual holes size is the
  // plating thickness larger.
  auto hole = static_cast<SHAPE_SEGMENT*>( GetEffectiveHoleShape()->Clone() );
  hole->SetWidth( hole->GetWidth() + bds.GetHolePlatingThickness() );
  return std::make_shared<SHAPE_SEGMENT>( *hole );
  }
 
  return std::make_shared<SHAPE_NULL>();
  }
 
 
  if( m_shapesDirty )
  BuildEffectiveShapes( aLayer );
 
  return m_effectiveShape;
 }

References BuildEffectiveShapes(), Clone(), FlashLayer(), GetAttribute(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), GetEffectiveHoleShape(), BOARD_DESIGN_SETTINGS::GetHolePlatingThickness(), m_effectiveShape, m_shapesDirty, NEVER_FLASHED, PTH, and UNDEFINED_LAYER.

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 879 of file 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 860 of file 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 839 of file 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 ZONE::GetPadConnection(), and ImportSettingsFrom().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 154 of file eda_item.h.

154 { return m_flags; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), calcIsInsideArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_SYMBOL::LIB_SYMBOL(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

virtual const 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_TRACK, and PCB_SHAPE.

Definition at line 258 of file eda_item.h.

258 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:251

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetKeepTopBottom()

bool PAD::GetKeepTopBottom ( ) const

inline

Definition at line 564 of file pad.h.

564 { return m_keepTopBottomLayer; }

PAD::m_keepTopBottomLayer

bool m_keepTopBottomLayer

Definition: pad.h:760

References m_keepTopBottomLayer.

Referenced by PCB_PLUGIN::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 143 of file board_item.h.

143 { return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:313

References BOARD_ITEM::m_layer.

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

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

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

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

◆ GetLayerSet()

LSET PAD::GetLayerSet ( ) const

inlineoverridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 368 of file pad.h.

368 { return m_layerMask; }

PAD::m_layerMask

LSET m_layerMask

Definition: pad.h:738

References m_layerMask.

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

◆ GetLocalClearance() [1/2]

int PAD::GetLocalClearance ( wxString * aSource ) const

overridevirtual

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

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

Parameters

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

Returns: the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 735 of file pad.cpp.

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

References _, and m_localClearance.

Referenced by PCB_PLUGIN::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 390 of file pad.h.

390 { return m_localClearance; }

PAD::m_localClearance

int m_localClearance

Definition: pad.h:772

References m_localClearance.

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

◆ GetLocalClearanceOverrides()

int PAD::GetLocalClearanceOverrides ( wxString * aSource ) const

overridevirtual

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

Parameters

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

Returns: the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 721 of file pad.cpp.

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

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

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 184 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 386 of file pad.h.

386 { return m_localSolderMaskMargin; }

PAD::m_localSolderMaskMargin

int m_localSolderMaskMargin

Definition: pad.h:773

References m_localSolderMaskMargin.

Referenced by PCB_PLUGIN::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 393 of file pad.h.

393 { return m_localSolderPasteMargin; }

PAD::m_localSolderPasteMargin

int m_localSolderPasteMargin

Definition: pad.h:774

References m_localSolderPasteMargin.

Referenced by PCB_PLUGIN::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 396 of file pad.h.

396 { return m_localSolderPasteMarginRatio; }

PAD::m_localSolderPasteMarginRatio

double m_localSolderPasteMarginRatio

Definition: pad.h:775

References m_localSolderPasteMarginRatio.

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

◆ GetMenuImage()

BITMAPS PAD::GetMenuImage ( ) const

overridevirtual

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

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1234 of file pad.cpp.

 {
  return BITMAPS::pad;
 }

References pad.

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 898 of file pad.cpp.

 {
  EDA_UNITS units = aFrame->GetUserUnits();
  wxString msg;
  FOOTPRINT* parentFootprint = static_cast<FOOTPRINT*>( m_parent );
 
  if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
  {
  if( parentFootprint )
  aList.emplace_back( _( "Footprint" ), parentFootprint->GetReference() );
  }
 
  aList.emplace_back( _( "Pad" ), m_number );
 
  if( !GetPinFunction().IsEmpty() )
  aList.emplace_back( _( "Pin Name" ), GetPinFunction() );
 
  if( !GetPinType().IsEmpty() )
  aList.emplace_back( _( "Pin Type" ), GetPinType() );
 
  if( aFrame->GetName() == PCB_EDIT_FRAME_NAME )
  {
  aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
 
  aList.emplace_back( _( "Net Class" ), UnescapeString( GetNetClass()->GetName() ) );
 
  if( IsLocked() )
  aList.emplace_back( _( "Status" ), _( "Locked" ) );
  }
 
  if( GetAttribute() == PAD_ATTRIB::SMD || GetAttribute() == PAD_ATTRIB::CONN )
  aList.emplace_back( _( "Layer" ), layerMaskDescribe() );
 
  // Show the pad shape, attribute and property
  wxString props = ShowPadAttr();
 
  if( GetProperty() != PAD_PROP::NONE )
  props += ',';
 
  switch( GetProperty() )
  {
  case PAD_PROP::NONE: break;
  case PAD_PROP::BGA: props += _( "BGA" ); break;
  case PAD_PROP::FIDUCIAL_GLBL: props += _( "Fiducial global" ); break;
  case PAD_PROP::FIDUCIAL_LOCAL: props += _( "Fiducial local" ); break;
  case PAD_PROP::TESTPOINT: props += _( "Test point" ); break;
  case PAD_PROP::HEATSINK: props += _( "Heat sink" ); break;
  case PAD_PROP::CASTELLATED: props += _( "Castellated" ); break;
  }
 
  aList.emplace_back( ShowPadShape(), props );
 
  if( ( GetShape() == PAD_SHAPE::CIRCLE || GetShape() == PAD_SHAPE::OVAL ) &&
  m_size.x == m_size.y )
  {
  aList.emplace_back( _( "Diameter" ), 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( wxT( "%s" ),
  MessageTextFromValue( units, m_drill.x ) ) );
  }
  else
  {
  aList.emplace_back( _( "Hole X / Y" ),
  wxString::Format( wxT( "%s / %s" ),
  MessageTextFromValue( units, m_drill.x ),
  MessageTextFromValue( units, m_drill.y ) ) );
  }
  }
 
  wxString source;
  int clearance = GetOwnClearance( GetLayer(), &source );
 
  if( !source.IsEmpty() )
  {
  aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
  MessageTextFromValue( units, clearance ) ),
  wxString::Format( _( "(from %s)" ),
  source ) );
  }
 #if 0
  // useful for debug only
  aList.emplace_back( wxT( "UUID" ), m_Uuid.AsString() );
 #endif
 }

References _, KIID::AsString(), BGA, CASTELLATED, CIRCLE, CONN, FIDUCIAL_GLBL, FIDUCIAL_LOCAL, Format(), GetAttribute(), GetDrillShape(), BOARD_ITEM::GetLayer(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetname(), FOOTPRINT::GetOrientationDegrees(), GetOrientationDegrees(), BOARD_CONNECTED_ITEM::GetOwnClearance(), GetPadToDieLength(), GetPinFunction(), GetPinType(), GetProperty(), FOOTPRINT::GetReference(), GetShape(), EDA_BASE_FRAME::GetUserUnits(), HEATSINK, IsLocked(), BOARD_ITEM::layerMaskDescribe(), m_drill, m_number, EDA_ITEM::m_parent, m_size, EDA_ITEM::m_Uuid, MessageTextFromValue(), NONE, NormalizeAngleDegrees(), OVAL, PAD_DRILL_SHAPE_CIRCLE, PCB_EDIT_FRAME_NAME, ShowPadAttr(), ShowPadShape(), SMD, TESTPOINT, and UnescapeString().

◆ GetNet()

NETINFO_ITEM* BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Return #NET_INFO object for a given item.

Definition at line 75 of file board_connected_item.h.

  {
  return m_netinfo;
  }

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), isCoupledDiffPair(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), 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

Return the NETCLASS for this item.

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

Reimplemented in ZONE.

Definition at line 108 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 PCB_VIA::GetDrillValue(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), BOARD_INSPECTION_TOOL::getItemDescription(), GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ZONE::GetNetClass(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), and DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ GetNetClassName()

wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const

virtualinherited

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

inherited

Returns: the net code.

Definition at line 100 of file board_connected_item.cpp.

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

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

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ZONE_FILLER::buildCopperItemClearances(), connectedItemFilter(), CreateRoutesSection(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), ZONE_FILLER::Fill(), PNS::NODE::FindItemByParent(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromBOARD(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), CONNECTIVITY_DATA::GetConnectedItems(), ZONE::GetInteractingZones(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), CONNECTIVITY_DATA::GetRatsnestForPad(), hasThermalConnection(), BOARD_INSPECTION_TOOL::highlightNet(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::IsConnectedOnLayer(), ZONE::IsIsland(), ZONE::IsSame(), ZONE_FILLER::knockoutThermalReliefs(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), CN_ITEM::Net(), DIALOG_DRC::OnDRCItemSelected(), PCB_TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), 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_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), BOARD::TracksInNet(), 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

inherited

Returns: the full netname.

Definition at line 126 of file board_connected_item.cpp.

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

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

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromBOARD(), ZONE::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), CN_CLUSTER::OriginNetName(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotPad(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetNetnameMsg()

wxString BOARD_CONNECTED_ITEM::GetNetnameMsg ( ) const

inherited

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

Definition at line 132 of file board_connected_item.cpp.

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

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

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

◆ GetNumber()

const wxString& PAD::GetNumber ( ) const

inline

Definition at line 129 of file pad.h.

129 { return m_number; }

PAD::m_number

wxString m_number

Definition: pad.h:678

References m_number.

Referenced by BOOST_FIXTURE_TEST_CASE(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), PLACE_FILE_EXPORTER::GenReportData(), GetSelectMenuText(), DIALOG_PAD_PROPERTIES::initValues(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), FOOTPRINT::cmp_pads::operator()(), operator=(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), BRDITEMS_PLOTTER::PlotPad(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and ViewGetLayers().

◆ GetOffset()

const wxPoint& PAD::GetOffset ( ) const

inline

Definition at line 250 of file pad.h.

250 { return m_offset; }

PAD::m_offset

wxPoint m_offset

Definition: pad.h:736

References m_offset.

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

◆ GetOrientation()

double PAD::GetOrientation ( ) const

inline

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

Definition at line 349 of file pad.h.

349 { return m_orient; }

PAD::m_orient

double m_orient

Definition: pad.h:752

References m_orient.

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

◆ GetOrientationDegrees()

double PAD::GetOrientationDegrees ( ) const

inline

Definition at line 350 of file pad.h.

350 { return m_orient/10.0; }

PAD::m_orient

double m_orient

Definition: pad.h:752

References m_orient.

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

◆ GetOrientationRadians()

double PAD::GetOrientationRadians ( ) const

inline

Definition at line 351 of file pad.h.

351 { return m_orient*M_PI/1800; }

PAD::m_orient

double m_orient

Definition: pad.h:752

References m_orient.

◆ GetOwnClearance()

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

virtualinherited

Return an item's "own" clearance in internal units.

Parameters

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

Returns: the clearance in internal units.

Definition at line 77 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->EvalRules( 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(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), GetMsgPanelInfo(), and ViewBBox().

◆ GetPadToDieLength()

int PAD::GetPadToDieLength ( ) const

inline

Definition at line 384 of file pad.h.

384 { return m_lengthPadToDie; }

PAD::m_lengthPadToDie

int m_lengthPadToDie

Definition: pad.h:754

References m_lengthPadToDie.

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

◆ GetParent()

FOOTPRINT * PAD::GetParent ( void ) const

Definition at line 1439 of file pad.cpp.

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

References EDA_ITEM::m_parent.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), 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_SOLDER_MASK::testItemAgainstItems(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), EAGLE_PLUGIN::transferPad(), and ViewGetLayers().

◆ GetParentAsString()

wxString PAD::GetParentAsString ( ) const

inline

Definition at line 107 of file pad.h.

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

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:478

KIID::AsString

wxString AsString() const

Definition: kiid.cpp:236

EDA_ITEM::m_Uuid

const KIID m_Uuid

Definition: eda_item.h:474

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

Referenced by PAD_DESC::PAD_DESC().

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 191 of file board_item.cpp.

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

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), PNS::ITEM::collideSimple(), CONVERT_TOOL::CreatePolys(), and DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems().

◆ GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 60 of file board_item.h.

60 { return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:314

References BOARD_ITEM::m_group.

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

◆ GetPinFunction()

const wxString& PAD::GetPinFunction ( ) const

inline

Definition at line 140 of file pad.h.

140 { return m_pinFunction; }

PAD::m_pinFunction

wxString m_pinFunction

Definition: pad.h:679

References m_pinFunction.

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

◆ GetPinType()

const wxString& PAD::GetPinType ( ) const

inline

Definition at line 146 of file pad.h.

146 { return m_pinType; }

PAD::m_pinType

wxString m_pinType

Definition: pad.h:680

References m_pinType.

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_PLUGIN::format(), GetMsgPanelInfo(), operator=(), and PAD_DESC::PAD_DESC().

◆ GetPos0()

const wxPoint& PAD::GetPos0 ( ) const

inline

Definition at line 227 of file pad.h.

227 { return m_pos0; }

PAD::m_pos0

wxPoint m_pos0

Definition: pad.h:745

References m_pos0.

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

◆ GetPosition()

wxPoint PAD::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 178 of file pad.h.

178 { return m_pos; }

PAD::m_pos

wxPoint m_pos

Definition: pad.h:682

References m_pos.

Referenced by DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), AR_AUTOPLACER::computePlacementRatsnestCost(), BOARD_ADAPTER::createPadWithDrill(), PAD_TOOL::explodePad(), EXPORTER_PCB_VRML::ExportVrmlPadHole(), GetCenter(), FOOTPRINT::GetTopLeftPad(), HitTest(), DIALOG_PAD_PROPERTIES::initValues(), RENDER_3D_RAYTRACE::insertHole(), FABMASTER::loadFootprints(), mirrorPadX(), AR_AUTOPLACER::nearestPad(), operator=(), DIALOG_PAD_PROPERTIES::prepareCanvas(), PAD_TOOL::recombinePad(), DIALOG_PAD_PROPERTIES::redraw(), sortPadsByXthenYCoord(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

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

  {
  return m_editPrimitives;
  }

References m_editPrimitives.

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

◆ GetProperty()

PAD_PROP PAD::GetProperty ( ) const

inline

Definition at line 374 of file pad.h.

374 { return m_property; }

PAD::m_property

PAD_PROP m_property

Definition: pad.h:750

References m_property.

Referenced by FlashLayer(), PCB_PLUGIN::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 558 of file pad.h.

558 { return m_removeUnconnectedLayer; }

PAD::m_removeUnconnectedLayer

bool m_removeUnconnectedLayer

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

Definition: pad.h:757

References m_removeUnconnectedLayer.

Referenced by PCB_PLUGIN::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 269 of file pad.cpp.

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

References KiROUND(), m_roundedCornerScale, and m_size.

Referenced by BuildEffectiveShapes(), 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 524 of file pad.h.

524 { return m_roundedCornerScale; }

PAD::m_roundedCornerScale

double m_roundedCornerScale

Definition: pad.h:720

References m_roundedCornerScale.

Referenced by PCB_PLUGIN::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 1183 of file pad.cpp.

 {
  if( GetNumber().IsEmpty() )
  {
  if( GetAttribute() == PAD_ATTRIB::SMD || GetAttribute() == PAD_ATTRIB::CONN )
  {
  return wxString::Format( _( "Pad %s of %s on %s" ),
  GetNetnameMsg(),
  GetParent()->GetReference(),
  layerMaskDescribe() );
  }
  else if( GetAttribute() == PAD_ATTRIB::NPTH && !FlashLayer( UNDEFINED_LAYER ) )
  {
  return wxString::Format( _( "Through hole pad %s of %s" ),
  wxT( "(" ) + _( "NPTH, Mechanical" ) + wxT( ")" ),
  GetParent()->GetReference() );
  }
  else
  {
  return wxString::Format( _( "Through hole pad %s of %s" ),
  GetNetnameMsg(),
  GetParent()->GetReference() );
  }
  }
  else
  {
  if( GetAttribute() == PAD_ATTRIB::SMD || GetAttribute() == PAD_ATTRIB::CONN )
  {
  return wxString::Format( _( "Pad %s %s of %s on %s" ),
  GetNumber(),
  GetNetnameMsg(),
  GetParent()->GetReference(),
  layerMaskDescribe() );
  }
  else if( GetAttribute() == PAD_ATTRIB::NPTH && !FlashLayer( UNDEFINED_LAYER ) )
  {
  return wxString::Format( _( "Through hole pad %s of %s" ),
  wxT( "(" ) + _( "NPTH, Mechanical" ) + wxT( ")" ),
  GetParent()->GetReference() );
  }
  else
  {
  return wxString::Format( _( "Through hole pad %s %s of %s" ),
  GetNumber(),
  GetNetnameMsg(),
  GetParent()->GetReference() );
  }
  }
 }

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

◆ GetShape()

PAD_SHAPE PAD::GetShape ( ) const

inline

Returns: the shape of this pad.

Definition at line 170 of file pad.h.

170 { return m_padShape; }

PAD::m_padShape

PAD_SHAPE m_padShape

Definition: pad.h:684

References m_padShape.

Referenced by ZONE_FILLER::addKnockout(), BuildEffectiveShapes(), BOARD_ADAPTER::buildPadOutlineAsPolygon(), BOARD_ADAPTER::buildPadOutlineAsSegments(), Compare(), BOARD_ADAPTER::createPadWithClearance(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), FlashLayer(), PCB_PLUGIN::format(), GetMsgPanelInfo(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), DSN::isRoundKeepout(), DSN::SPECCTRA_DB::makePADSTACK(), mirrorPadX(), DIALOG_PAD_PROPERTIES::onCornerRadiusChange(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), PAD_DESC::PAD_DESC(), DIALOG_PAD_PROPERTIES::padValuesOK(), AR_MATRIX::PlacePad(), BRDITEMS_PLOTTER::PlotPad(), PAD_TOOL::recombinePad(), ShowPadShape(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), TransformShapeWithClearanceToPolygon(), and ViewGetLOD().

◆ GetShortNetname()

wxString BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

Definition at line 148 of file board_connected_item.cpp.

 {
  return m_netinfo->GetShortNetname();
 }

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

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

◆ GetSize()

const wxSize& PAD::GetSize ( ) const

inline

◆ GetSizeX()

const int PAD::GetSizeX ( ) const

inline

Definition at line 235 of file pad.h.

235 { return m_size.x; }

PAD::m_size

wxSize m_size

Definition: pad.h:716

References m_size.

Referenced by PAD_DESC::PAD_DESC(), PAD_TOOL::recombinePad(), and ViewGetLOD().

◆ GetSizeY()

const int PAD::GetSizeY ( ) const

inline

Definition at line 237 of file pad.h.

237 { return m_size.y; }

PAD::m_size

wxSize m_size

Definition: pad.h:716

References m_size.

Referenced by PAD_DESC::PAD_DESC(), PAD_TOOL::recombinePad(), and ViewGetLOD().

◆ GetSolderMaskMargin()

int PAD::GetSolderMaskMargin ( ) const

Returns: the margin for the solder mask layer

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

Definition at line 744 of file pad.cpp.

 {
  // The pad inherits the margin only to calculate a default shape,
  // therefore only if it is also a copper layer
  // Pads defined only on mask layers (and perhaps on other tech layers) use the shape
  // defined by the pad settings only
  bool isOnCopperLayer = ( m_layerMask & LSET::AllCuMask() ).any();
 
  if( !isOnCopperLayer )
  return 0;
 
  int margin = m_localSolderMaskMargin;
 
  FOOTPRINT* parentFootprint = GetParent();
 
  if( parentFootprint )
  {
  if( margin == 0 )
  {
  if( parentFootprint->GetLocalSolderMaskMargin() )
  margin = parentFootprint->GetLocalSolderMaskMargin();
  }
 
  if( margin == 0 )
  {
  const BOARD* brd = GetBoard();
 
  if( brd )
  margin = brd->GetDesignSettings().m_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

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

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

Returns: the margin for the solder mask layer.

Definition at line 789 of file pad.cpp.

 {
  // The pad inherits the margin only to calculate a default shape,
  // therefore only if it is also a copper layer.
  // Pads defined only on mask layers (and perhaps on other tech layers) use the shape
  // defined by the pad settings only
  bool isOnCopperLayer = ( m_layerMask & LSET::AllCuMask() ).any();
 
  if( !isOnCopperLayer )
  return 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 ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 136 of file eda_item.h.

  {
  return m_status & type;
  }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 149 of file eda_item.h.

149 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:477

References EDA_ITEM::m_status.

◆ GetSubRatsnest()

int PAD::GetSubRatsnest ( ) const

inline

Returns: the netcode.

Definition at line 548 of file pad.h.

548 { return m_subRatsnest; }

PAD::m_subRatsnest

int m_subRatsnest

Definition: pad.h:712

References m_subRatsnest.

Referenced by operator=().

◆ GetThermalGap()

int PAD::GetThermalGap ( ) const

inline

Definition at line 500 of file pad.h.

500 { return m_thermalGap; }

PAD::m_thermalGap

int m_thermalGap

Definition: pad.h:780

References m_thermalGap.

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

◆ GetThermalSpokeWidth()

int PAD::GetThermalSpokeWidth ( ) const

inline

Definition at line 492 of file pad.h.

492 { return m_thermalWidth; }

PAD::m_thermalWidth

int m_thermalWidth

Definition: pad.h:779

References m_thermalWidth.

Referenced by PCB_PLUGIN::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 64 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 70 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 477 of file pad.h.

477 { return m_zoneConnection; }

PAD::m_zoneConnection

ZONE_CONNECTION m_zoneConnection

Definition: pad.h:778

References m_zoneConnection.

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

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 155 of file eda_item.h.

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

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupShapes(), 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 inside or on the boundary of this 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 1012 of file pad.cpp.

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

References delta, GetBoundingRadius(), GetEffectivePolygon(), GetPosition(), and SEG::Square().

◆ HitTest() [2/2]

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

overridevirtual

Test if aRect intersects this 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 1024 of file pad.cpp.

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

References EDA_RECT::Contains(), GetBoundingBox(), GetEffectivePolygon(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), and EDA_RECT::Normalize().

◆ ImportSettingsFrom()

void PAD::ImportSettingsFrom ( const PAD & aMasterPad )

Import the pad settings from aMasterPad.

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

Parameters

aMasterPad the template pad.

Definition at line 1445 of file 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 CIRCLE, CONN, 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(), ReplacePrimitives(), SetAnchorPadShape(), SetAttribute(), SetChamferPositions(), SetChamferRectRatio(), SetCustomShapeInZoneOpt(), SetDelta(), SetDirty(), SetDrillShape(), SetDrillSize(), SetLayerSet(), SetLocalClearance(), SetLocalSolderMaskMargin(), SetLocalSolderPasteMargin(), SetLocalSolderPasteMarginRatio(), SetOffset(), SetOrientation(), SetPadToDieLength(), SetProperty(), SetRoundRectRadiusRatio(), SetShape(), SetSize(), SetThermalGap(), SetThermalSpokeWidth(), SetZoneConnection(), SMD, and TRAPEZOID.

Referenced by operator=().

◆ IsAperturePad()

bool PAD::IsAperturePad ( ) const

inline

Definition at line 378 of file pad.h.

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

References LSET::AllCuMask(), and m_layerMask.

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & BRIGHTENED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::DS_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

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented from BOARD_ITEM.

Reimplemented in ZONE.

Definition at line 67 of file board_connected_item.h.

  {
  return true;
  }

◆ IsDirty()

bool PAD::IsDirty ( ) const

inline

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

120 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & ENTERED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsFlipped()

bool PAD::IsFlipped ( ) const

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

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

205 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:479

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

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

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

Referenced by PCB_PLUGIN::format(), GetMsgPanelInfo(), and DIALOG_PAD_PROPERTIES::initValues().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 117 of file eda_item.h.

117 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119 { return m_flags & IS_MOVING; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_SHAPE::CalcArcAngles(), LIB_PIN::CalcEdit(), 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(), and SCH_EDIT_TOOL::Rotate().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ConvertDeMorgan(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_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(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ IsOnCopperLayer()

bool PAD::IsOnCopperLayer ( ) const

inlineoverridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 218 of file pad.h.

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

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

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

◆ IsOnLayer()

bool PAD::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlineoverridevirtual

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

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

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 568 of file pad.h.

  {
  return m_layerMask[aLayer];
  }

References m_layerMask.

Referenced by AR_AUTOPLACER::addPad(), PAD_TOOL::explodePad(), FlashLayer(), DSN::SPECCTRA_DB::makePADSTACK(), PAD_TOOL::recombinePad(), and ViewGetLayers().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 402 of file eda_item.h.

402 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & SELECTED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::m_flags, and SELECTED.

◆ 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 205 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 84 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, NPTH, PCB_LOCATE_HOLE_T, PCB_LOCATE_NPTH_T, and PCB_LOCATE_PTH_T.

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_WIRE_IMAGE; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:480

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

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 294 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 313 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 PCB_VIA.

Definition at line 87 of file board_item.cpp.

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

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

Referenced by PCB_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_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, PCB_MARKER, SCH_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 364 of file eda_item.h.

  {
  return false;
  }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), SCH_MARKER::Matches(), PCB_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::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 118 of file eda_item.cpp.

 {
  wxString text = aText;
  int flags = aSearchData.GetFlags();
  wxString searchText = aSearchData.GetFindString();
 
  // Don't match if searching for replaceable item and the item doesn't support text replace.
  if( ( flags & FR_SEARCH_REPLACE ) && !IsReplaceable() )
  return false;
 
  if( !( flags & wxFR_MATCHCASE ) )
  {
  text.MakeUpper();
  searchText.MakeUpper();
  }
 
  if( flags & wxFR_WHOLEWORD )
  {
  int ii = 0;
 
  while( ii < (int) text.length() )
  {
  int next = text.find( searchText, ii );
 
  if( next == wxNOT_FOUND )
  return false;
 
  ii = next;
  next += searchText.length();
 
  bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
  bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
  if( startOK && endOK )
  return true;
  else
  ii++;
  }
 
  return false;
  }
  else if( flags & FR_MATCH_WILDCARD )
  {
  return text.Matches( searchText );
  }
  else
  {
  return text.Find( searchText ) != wxNOT_FOUND;
  }
 }

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

◆ MergePrimitivesAsPolygon()

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

Merge all basic shapes to a SHAPE_POLY_SET.

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

Parameters

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

Definition at line 212 of file pad_custom_shape_functions.cpp.

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

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

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

◆ Move() [1/2]

void BOARD_ITEM::Move ( const VECTOR2I & aMoveVector )

inlineinherited

Definition at line 238 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 618 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 234 of file

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PAD() [1/2]

◆ PAD() [2/2]

Member Function Documentation

◆ addPadPrimitivesToPolygon()

◆ AddPrimitive()

◆ AddPrimitiveArc()

◆ AddPrimitiveCircle()

◆ AddPrimitiveCurve()

◆ AddPrimitivePoly() [1/2]

◆ AddPrimitivePoly() [2/2]

◆ AddPrimitiveRect()

◆ AddPrimitiveSegment()

◆ ApertureMask()

◆ AppendPrimitives()

◆ BuildEffectivePolygon()

◆ BuildEffectiveShapes()

◆ CanHaveNumber()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ClonePad()

◆ Compare()

◆ ConnSMDMask()

◆ DeletePrimitivesList()

◆ DeleteStructure()

◆ Duplicate()

◆ FlashLayer() [1/2]

◆ FlashLayer() [2/2]

◆ Flip() [1/2]

◆ Flip() [2/2]

◆ FlipPrimitives()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAnchorPadShape()

◆ GetAttribute()

◆ GetBestAnchorPosition()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox()

◆ GetBoundingRadius()

◆ GetCenter()

◆ GetChamferPositions()

◆ GetChamferRectRatio()

◆ GetClass()

◆ GetCustomShapeInZoneOpt()

◆ GetDelta()

◆ GetDrillShape()

◆ GetDrillSize()

◆ GetDrillSizeX()

◆ GetDrillSizeY()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveNetclass()

◆ GetEffectivePolygon()

◆ GetEffectiveShape()

◆ GetEffectiveThermalGap()

◆ GetEffectiveThermalSpokeWidth()

◆ GetEffectiveZoneConnection()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetKeepTopBottom()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()