#include <footprint.h>

Inheritance diagram for FOOTPRINT:

Classes
struct	cmp_drawings

struct	cmp_pads

Public Member Functions
	FOOTPRINT (BOARD *parent)

	FOOTPRINT (const FOOTPRINT &aFootprint)

	FOOTPRINT (FOOTPRINT &&aFootprint)

	~FOOTPRINT ()

FOOTPRINT &	operator= (const FOOTPRINT &aOther)

FOOTPRINT &	operator= (FOOTPRINT &&aOther)

void	Add (BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
	More...

void	Remove (BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
	More...

void	ClearAllNets ()
	Function ClearAllNets Clear (i.e. More...

void	CalculateBoundingBox ()
	Function CalculateBoundingBox calculates the bounding box in board coordinates. More...

EDA_RECT	GetFootprintRect () const
	Function GetFootprintRect() Build and returns the boundary box of the footprint excluding any text. More...

EDA_RECT	GetBoundingBoxBase () const
	Returns the last calculated bounding box of the footprint (does not recalculate it). More...

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

SHAPE_POLY_SET	GetBoundingHull () const
	Returns a bounding polygon for the shapes and pads in the footprint This operation is slower but more accurate than calculating a bounding box. More...

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

const EDA_RECT	GetBoundingBox (bool aIncludeInvisibleText) const

PADS &	Pads ()

const PADS &	Pads () const

DRAWINGS &	GraphicalItems ()

const DRAWINGS &	GraphicalItems () const

FP_ZONES &	Zones ()

const FP_ZONES &	Zones () const

FP_GROUPS &	Groups ()

const FP_GROUPS &	Groups () const

bool	HasThroughHolePads () const

std::list< FP_3DMODEL > &	Models ()

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

void	SetPosition (const wxPoint &aPos) override

wxPoint	GetPosition () const override

void	SetOrientation (double aNewAngle)

void	SetOrientationDegrees (double aOrientation)

double	GetOrientation () const

double	GetOrientationDegrees () const

double	GetOrientationRadians () const

const LIB_ID &	GetFPID () const

void	SetFPID (const LIB_ID &aFPID)

const wxString &	GetDescription () const

void	SetDescription (const wxString &aDoc)

const wxString &	GetKeywords () const

void	SetKeywords (const wxString &aKeywords)

const KIID_PATH &	GetPath () const

void	SetPath (const KIID_PATH &aPath)

int	GetLocalSolderMaskMargin () const

void	SetLocalSolderMaskMargin (int aMargin)

int	GetLocalClearance () const

void	SetLocalClearance (int aClearance)

int	GetLocalClearance (wxString *aSource) const

int	GetLocalSolderPasteMargin () const

void	SetLocalSolderPasteMargin (int aMargin)

double	GetLocalSolderPasteMarginRatio () const

void	SetLocalSolderPasteMarginRatio (double aRatio)

void	SetZoneConnection (ZONE_CONNECTION aType)

ZONE_CONNECTION	GetZoneConnection () const

void	SetThermalWidth (int aWidth)

int	GetThermalWidth () const

void	SetThermalGap (int aGap)

int	GetThermalGap () const

int	GetAttributes () const

void	SetAttributes (int aAttributes)

void	SetFlag (int aFlag)

void	IncrementFlag ()

int	GetFlag () const

bool	IsNetTie () const

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

void	Rotate (const wxPoint &aRotCentre, double aAngle) override
	Rotate this object. More...

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

void	MoveAnchorPosition (const wxPoint &aMoveVector)
	Function MoveAnchorPosition Move the reference point of the footprint It looks like a move footprint: the footprints elements (pads, outlines, edges . More...

bool	IsFlipped () const
	function IsFlipped More...

bool	IsOnLayer (PCB_LAYER_ID aLayer) const override
	A special IsOnLayer for footprints: return true if the footprint contains only items on the given layer, even if that layer is not one of the valid footprint layers F_Cu and B_Cu. More...

bool	IsLocked () const override

void	SetLocked (bool isLocked) override
	Function SetLocked sets the MODULE_is_LOCKED bit in the m_ModuleStatus. More...

bool	IsPlaced () const

void	SetIsPlaced (bool isPlaced)

bool	NeedsPlaced () const

void	SetNeedsPlaced (bool needsPlaced)

bool	LegacyPadsLocked () const

void	SetLastEditTime (timestamp_t aTime)

void	SetLastEditTime ()

timestamp_t	GetLastEditTime () const

void	TransformPadsWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aSkipNPTHPadsWihNoCopper=false, bool aSkipPlatedPads=false, bool aSkipNonPlatedPads=false) const
	function TransformPadsShapesWithClearanceToPolygon generate pads shapes on layer aLayer as polygons and adds these polygons to aCornerBuffer Useful to generate a polygonal representation of a footprint in 3D view and plot functions, when a full polygonal approach is needed More...

void	TransformFPShapesWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool aIncludeText=true, bool aIncludeShapes=true) const
	function TransformFPShapesWithClearanceToPolygon generate shapes of graphic items (outlines) on layer aLayer as polygons and adds these polygons to aCornerBuffer Useful to generate a polygonal representation of a footprint in 3D view and plot functions, when a full polygonal approach is needed More...

void	TransformFPTextWithClearanceToPolygonSet (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc) const
	TransformFPTextWithClearanceToPolygonSet This function is the same as TransformGraphicShapesWithClearanceToPolygonSet but only generate text. More...

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

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

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

bool	HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
	Test if aPosition is contained within or on the bounding box of an item. More...

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

bool	HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects or is contained within the bounding box of an item. More...

const wxString	GetReference () const
	Function GetReference. More...

void	SetReference (const wxString &aReference)
	Function SetReference. More...

void	IncrementReference (int aDelta)
	Function IncrementReference Bumps the current reference by aDelta. More...

const wxString	GetValue () const
	Function GetValue. More...

void	SetValue (const wxString &aValue)
	Function SetValue. More...

FP_TEXT &	Value ()
	read/write accessors: More...

FP_TEXT &	Reference ()

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

FP_TEXT &	Reference () const

const std::map< wxString, wxString > &	GetProperties () const

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

PAD *	FindPadByName (const wxString &aPadName) const
	Function FindPadByName returns a PAD* with a matching name. More...

PAD *	GetPad (const wxPoint &aPosition, LSET aLayerMask=LSET::AllLayersMask())
	Function GetPad get a pad at aPosition on aLayerMask in the footprint. More...

PAD *	GetTopLeftPad ()

PAD *	GetFirstPad () const
	Gets the first pad in the list or NULL if none. More...

unsigned	GetPadCount (INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
	GetPadCount returns the number of pads. More...

unsigned	GetUniquePadCount (INCLUDE_NPTH_T aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const
	GetUniquePadCount returns the number of unique pads. More...

wxString	GetNextPadName (const wxString &aLastPadName) const
	Function GetNextPadName returns the next available pad name in the footprint. More...

double	GetArea (int aPadding=0) const

KIID	GetLink () const

void	SetLink (const KIID &aLink)

int	GetPlacementCost180 () const

void	SetPlacementCost180 (int aCost)

int	GetPlacementCost90 () const

void	SetPlacementCost90 (int aCost)

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

BOARD_ITEM *	DuplicateItem (const BOARD_ITEM *aItem, bool aAddToFootprint=false)
	Function DuplicateItem Duplicate a given item within the footprint, optionally adding it to the board. More...

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

SEARCH_RESULT	Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
	May be re-implemented for each derived class in order to handle all the types given by its member data. More...

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

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

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

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

void	RunOnChildren (const std::function< void(BOARD_ITEM *)> &aFunction) const
	Function RunOnChildren. More...

void	GetAllDrawingLayers (int aLayers[], int &aCount, bool aIncludePads=true) const
	Returns a set of all layers that this footprint has drawings on similar to ViewGetLayers() More...

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

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

double	CoverageRatio (const GENERAL_COLLECTOR &aCollector) const
	Function CoverageRatio Calculates the ratio of total area of the footprint pads and graphical items to the area of the footprint. More...

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

SHAPE_POLY_SET &	GetPolyCourtyardFront ()
	Used in DRC to test the courtyard area (a complex polygon) More...

SHAPE_POLY_SET &	GetPolyCourtyardBack ()

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

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

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

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

virtual const ZONE_SETTINGS &	GetZoneSettings () const
	Fetch the zone settings for this container. More...

virtual void	SetZoneSettings (const ZONE_SETTINGS &aSettings)
	Set the zone settings for this container. More...

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

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

void	SetX (int aX)

void	SetY (int aY)

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

virtual bool	IsOnCopperLayer () const

BOARD_ITEM_CONTAINER *	GetParent () const

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

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

virtual void	SetLayerSet (LSET aLayers)

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

bool	IsTrack () const
	Test to see if this object is a track or via (or microvia). More...

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

void	Move (const VECTOR2I &aMoveVector)

void	Rotate (const VECTOR2I &aRotCentre, double aAngle)

void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)

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

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

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

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

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (int type) const

void	SetState (int type, int state)

STATUS_FLAGS	GetStatus () const

void	SetStatus (STATUS_FLAGS aStatus)

void	SetFlags (STATUS_FLAGS aMask)

void	ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

STATUS_FLAGS	GetFlags () const

bool	HasFlag (STATUS_FLAGS aFlag) const

STATUS_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	IsType (const KICAD_T aScanTypes[]) const
	Check whether the item is one of the listed types. More...

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 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 bool	ClassOf (const EDA_ITEM *aItem)

static bool	IsLibNameValid (const wxString &aName)
	static function IsLibNameValid Test for validity of a name of a footprint to be used in a footprint library ( no spaces, dir separators ... More...

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

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

static wxString	ShowShape (PCB_SHAPE_TYPE_T aShape)
	Convert the enum PCB_SHAPE_TYPE_T integer value to a wxString. More...

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

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

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

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

Public Attributes
const KIID	m_Uuid

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

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

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

Protected Attributes
PCB_LAYER_ID	m_layer

PCB_GROUP *	m_group

STATUS_FLAGS	m_status

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

bool	m_forceVisible

STATUS_FLAGS	m_flags

Private Attributes
DRAWINGS	m_drawings

PADS	m_pads

FP_ZONES	m_fp_zones

FP_GROUPS	m_fp_groups

double	m_orient

wxPoint	m_pos

FP_TEXT *	m_reference

FP_TEXT *	m_value

LIB_ID	m_fpid

int	m_attributes

int	m_fpStatus

EDA_RECT	m_boundingBox

ZONE_CONNECTION	m_zoneConnection

int	m_thermalWidth

int	m_thermalGap

int	m_localClearance

int	m_localSolderMaskMargin

int	m_localSolderPasteMargin

double	m_localSolderPasteMarginRatio

wxString	m_doc

wxString	m_keywords

KIID_PATH	m_path

timestamp_t	m_lastEditTime

int	m_arflag

KIID	m_link

int	m_rot90Cost

int	m_rot180Cost

std::list< FP_3DMODEL >	m_3D_Drawings

std::map< wxString, wxString >	m_properties

wxArrayString *	m_initial_comments

SHAPE_POLY_SET	m_poly_courtyard_front

SHAPE_POLY_SET	m_poly_courtyard_back

Detailed Description

Definition at line 108 of file footprint.h.

Constructor & Destructor Documentation

◆ FOOTPRINT() [1/3]

FOOTPRINT::FOOTPRINT ( BOARD * parent )

Definition at line 46 of file footprint.cpp.

                                     :
         BOARD_ITEM_CONTAINER((BOARD_ITEM*) parent, PCB_FOOTPRINT_T ),
         m_initial_comments( 0 )
 {
     m_attributes   = 0;
     m_layer        = F_Cu;
     m_orient       = 0;
     m_fpStatus     = FP_PADS_are_LOCKED;
     m_arflag       = 0;
     m_rot90Cost    = m_rot180Cost = 0;
     m_link         = 0;
     m_lastEditTime = 0;
     m_localClearance              = 0;
     m_localSolderMaskMargin       = 0;
     m_localSolderPasteMargin      = 0;
     m_localSolderPasteMarginRatio = 0.0;
     m_zoneConnection              = ZONE_CONNECTION::INHERITED; // Use zone setting by default
     m_thermalWidth = 0;     // Use zone setting by default
     m_thermalGap = 0;       // Use zone setting by default
 
     // These are special and mandatory text fields
     m_reference = new FP_TEXT( this, FP_TEXT::TEXT_is_REFERENCE );
     m_value = new FP_TEXT( this, FP_TEXT::TEXT_is_VALUE );
 
     m_3D_Drawings.clear();
 }

References F_Cu, FP_PADS_are_LOCKED, INHERITED, m_3D_Drawings, m_arflag, m_attributes, m_fpStatus, m_lastEditTime, BOARD_ITEM::m_layer, m_link, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_orient, m_reference, m_rot180Cost, m_rot90Cost, m_thermalGap, m_thermalWidth, m_value, m_zoneConnection, FP_TEXT::TEXT_is_REFERENCE, and FP_TEXT::TEXT_is_VALUE.

Referenced by Clone().

◆ FOOTPRINT() [2/3]

FOOTPRINT::FOOTPRINT ( const FOOTPRINT & aFootprint )

Definition at line 74 of file footprint.cpp.

                                                   :
     BOARD_ITEM_CONTAINER( aFootprint )
 {
     m_pos          = aFootprint.m_pos;
     m_fpid         = aFootprint.m_fpid;
     m_attributes   = aFootprint.m_attributes;
     m_fpStatus     = aFootprint.m_fpStatus;
     m_orient       = aFootprint.m_orient;
     m_boundingBox  = aFootprint.m_boundingBox;
     m_rot90Cost    = aFootprint.m_rot90Cost;
     m_rot180Cost   = aFootprint.m_rot180Cost;
     m_lastEditTime = aFootprint.m_lastEditTime;
     m_link         = aFootprint.m_link;
     m_path         = aFootprint.m_path;
 
     m_localClearance = aFootprint.m_localClearance;
     m_localSolderMaskMargin = aFootprint.m_localSolderMaskMargin;
     m_localSolderPasteMargin = aFootprint.m_localSolderPasteMargin;
     m_localSolderPasteMarginRatio = aFootprint.m_localSolderPasteMarginRatio;
     m_zoneConnection = aFootprint.m_zoneConnection;
     m_thermalWidth = aFootprint.m_thermalWidth;
     m_thermalGap = aFootprint.m_thermalGap;
 
     std::map<BOARD_ITEM*, BOARD_ITEM*> ptrMap;
 
     // Copy reference and value.
     m_reference = new FP_TEXT( *aFootprint.m_reference );
     m_reference->SetParent( this );
     ptrMap[ aFootprint.m_reference ] = m_reference;
 
     m_value = new FP_TEXT( *aFootprint.m_value );
     m_value->SetParent( this );
     ptrMap[ aFootprint.m_value ] = m_value;
 
     // Copy pads
     for( PAD* pad : aFootprint.Pads() )
     {
         PAD* newPad = static_cast<PAD*>( pad->Clone() );
         ptrMap[ pad ] = newPad;
         Add( newPad );
     }
 
     // Copy zones
     for( FP_ZONE* zone : aFootprint.Zones() )
     {
         FP_ZONE* newZone = static_cast<FP_ZONE*>( zone->Clone() );
         ptrMap[ zone ] = newZone;
         Add( newZone );
 
         // Ensure the net info is OK and especially uses the net info list
         // living in the current board
         // Needed when copying a fp from fp editor that has its own board
         // Must be NETINFO_LIST::ORPHANED_ITEM for a keepout that has no net.
         newZone->SetNetCode( -1 );
     }
 
     // Copy drawings
     for( BOARD_ITEM* item : aFootprint.GraphicalItems() )
     {
         BOARD_ITEM* newItem = static_cast<BOARD_ITEM*>( item->Clone() );
         ptrMap[ item ] = newItem;
         Add( newItem );
     }
 
     // Copy groups
     for( PCB_GROUP* group : aFootprint.Groups() )
     {
         PCB_GROUP* newGroup = static_cast<PCB_GROUP*>( group->Clone() );
         ptrMap[ group ] = newGroup;
         Add( newGroup );
     }
 
     // Rebuild groups
     for( PCB_GROUP* group : aFootprint.Groups() )
     {
         PCB_GROUP* newGroup = static_cast<PCB_GROUP*>( ptrMap[ group ] );
 
         newGroup->GetItems().clear();
 
         for( BOARD_ITEM* member : group->GetItems() )
             newGroup->AddItem( ptrMap[ member ] );
     }
 
     // Copy auxiliary data: 3D_Drawings info
     m_3D_Drawings = aFootprint.m_3D_Drawings;
 
     m_doc         = aFootprint.m_doc;
     m_keywords    = aFootprint.m_keywords;
     m_properties  = aFootprint.m_properties;
 
     m_arflag = 0;
 
     m_initial_comments = aFootprint.m_initial_comments ?
                          new wxArrayString( *aFootprint.m_initial_comments ) : nullptr;
 }

References Add(), PCB_GROUP::AddItem(), PCB_GROUP::GetItems(), GraphicalItems(), Groups(), m_3D_Drawings, m_arflag, m_attributes, m_boundingBox, m_doc, m_fpid, m_fpStatus, m_initial_comments, m_keywords, m_lastEditTime, m_link, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_orient, m_path, m_pos, m_properties, m_reference, m_rot180Cost, m_rot90Cost, m_thermalGap, m_thermalWidth, m_value, m_zoneConnection, Pads(), BOARD_CONNECTED_ITEM::SetNetCode(), EDA_ITEM::SetParent(), and Zones().

◆ FOOTPRINT() [3/3]

FOOTPRINT::FOOTPRINT ( FOOTPRINT && aFootprint )

Definition at line 171 of file footprint.cpp.

                                              :
     BOARD_ITEM_CONTAINER( aFootprint )
 {
     *this = std::move( aFootprint );
 }

◆ ~FOOTPRINT()

FOOTPRINT::~FOOTPRINT ( )

Definition at line 178 of file footprint.cpp.

 {
     // Clean up the owned elements
     delete m_reference;
     delete m_value;
     delete m_initial_comments;
 
     for( PAD* p : m_pads )
         delete p;
 
     m_pads.clear();
 
     for( FP_ZONE* zone : m_fp_zones )
         delete zone;
 
     m_fp_zones.clear();
 
     for( PCB_GROUP* group : m_fp_groups )
         delete group;
 
     m_fp_groups.clear();
 
     for( BOARD_ITEM* d : m_drawings )
         delete d;
 
     m_drawings.clear();
 }

References m_drawings, m_fp_groups, m_fp_zones, m_initial_comments, m_pads, m_reference, and m_value.

Member Function Documentation

◆ Add()

void FOOTPRINT::Add	(	BOARD_ITEM *	aItem,
		ADD_MODE	aMode = `ADD_MODE::INSERT`
	)

overridevirtual

Implements BOARD_ITEM_CONTAINER.

Definition at line 445 of file footprint.cpp.

 {
     switch( aBoardItem->Type() )
     {
     case PCB_FP_TEXT_T:
         // Only user text can be added this way.
         assert( static_cast<FP_TEXT*>( aBoardItem )->GetType() == FP_TEXT::TEXT_is_DIVERS );
         KI_FALLTHROUGH;
 
     case PCB_FP_SHAPE_T:
         if( aMode == ADD_MODE::APPEND )
             m_drawings.push_back( aBoardItem );
         else
             m_drawings.push_front( aBoardItem );
         break;
 
     case PCB_PAD_T:
         if( aMode == ADD_MODE::APPEND )
             m_pads.push_back( static_cast<PAD*>( aBoardItem ) );
         else
             m_pads.push_front( static_cast<PAD*>( aBoardItem ) );
         break;
 
     case PCB_FP_ZONE_T:
         if( aMode == ADD_MODE::APPEND )
             m_fp_zones.push_back( static_cast<FP_ZONE*>( aBoardItem ) );
         else
             m_fp_zones.insert( m_fp_zones.begin(), static_cast<FP_ZONE*>( aBoardItem ) );
         break;
 
     case PCB_GROUP_T:
         if( aMode == ADD_MODE::APPEND )
             m_fp_groups.push_back( static_cast<PCB_GROUP*>( aBoardItem ) );
         else
             m_fp_groups.insert( m_fp_groups.begin(), static_cast<PCB_GROUP*>( aBoardItem ) );
         break;
 
     default:
     {
         wxString msg;
         msg.Printf( wxT( "FOOTPRINT::Add() needs work: BOARD_ITEM type (%d) not handled" ),
                     aBoardItem->Type() );
         wxFAIL_MSG( msg );
 
         return;
     }
     }
 
     aBoardItem->ClearEditFlags();
     aBoardItem->SetParent( this );
 }

References APPEND, EDA_ITEM::ClearEditFlags(), KI_FALLTHROUGH, m_drawings, m_fp_groups, m_fp_zones, m_pads, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, EDA_ITEM::SetParent(), FP_TEXT::TEXT_is_DIVERS, and EDA_ITEM::Type().

◆ Add3DModel()

void FOOTPRINT::Add3DModel ( FP_3DMODEL * a3DModel )

Function Add3DModel adds a3DModel definition to the end of the 3D model list.

Parameters

a3DModel A pointer to a FP_3DMODEL to add to the list.

Definition at line 985 of file footprint.cpp.

 {
     if( nullptr == a3DModel )
         return;
 
     if( !a3DModel->m_Filename.empty() )
         m_3D_Drawings.push_back( *a3DModel );
 }

References m_3D_Drawings, and FP_3DMODEL::m_Filename.

◆ BuildPolyCourtyards()

void FOOTPRINT::BuildPolyCourtyards ( OUTLINE_ERROR_HANDLER * aErrorHandler = nullptr )

Builds complex polygons of the courtyard areas from graphic items on the courtyard layers.

Remarks: sets the MALFORMED_F_COURTYARD and MALFORMED_B_COURTYARD status flags if the given courtyard layer does not contain a (single) closed shape

Definition at line 1794 of file footprint.cpp.

 {
     m_poly_courtyard_front.RemoveAllContours();
     m_poly_courtyard_back.RemoveAllContours();
     ClearFlags( MALFORMED_COURTYARDS );
 
     // Build the courtyard area from graphic items on the courtyard.
     // Only PCB_FP_SHAPE_T have meaning, graphic texts are ignored.
     // Collect items:
     std::vector<PCB_SHAPE*> list_front;
     std::vector<PCB_SHAPE*> list_back;
 
     for( BOARD_ITEM* item : GraphicalItems() )
     {
         if( item->GetLayer() == B_CrtYd && item->Type() == PCB_FP_SHAPE_T )
             list_back.push_back( static_cast<PCB_SHAPE*>( item ) );
 
         if( item->GetLayer() == F_CrtYd && item->Type() == PCB_FP_SHAPE_T )
             list_front.push_back( static_cast<PCB_SHAPE*>( item ) );
     }
 
     if( !list_front.size() && !list_back.size() )
         return;
 
     int errorMax = Millimeter2iu( 0.02 );         // max error for polygonization
     int chainingEpsilon = Millimeter2iu( 0.02 );  // max dist from one endPt to next startPt
 
     if( ConvertOutlineToPolygon( list_front, m_poly_courtyard_front, errorMax, chainingEpsilon,
                                  aErrorHandler ) )
     {
         m_poly_courtyard_front.CacheTriangulation( false );
     }
     else
     {
         SetFlags( MALFORMED_F_COURTYARD );
     }
 
     if( ConvertOutlineToPolygon( list_back, m_poly_courtyard_back, errorMax, chainingEpsilon,
                                  aErrorHandler ) )
     {
         m_poly_courtyard_back.CacheTriangulation( false );
     }
     else
     {
         SetFlags( MALFORMED_B_COURTYARD );
     }
 }

References B_CrtYd, SHAPE_POLY_SET::CacheTriangulation(), EDA_ITEM::ClearFlags(), ConvertOutlineToPolygon(), F_CrtYd, GraphicalItems(), m_poly_courtyard_back, m_poly_courtyard_front, MALFORMED_B_COURTYARD, MALFORMED_COURTYARDS, MALFORMED_F_COURTYARD, Millimeter2iu(), PCB_FP_SHAPE_T, SHAPE_POLY_SET::RemoveAllContours(), and EDA_ITEM::SetFlags().

Referenced by AR_AUTOPLACER::buildFpAreas(), BOARD_INSPECTION_TOOL::InspectConstraints(), FABMASTER::loadFootprints(), BOARD_INSPECTION_TOOL::reportClearance(), and DIALOG_FOOTPRINT_CHECKER::runChecks().

◆ CalculateBoundingBox()

void FOOTPRINT::CalculateBoundingBox ( )

Function CalculateBoundingBox calculates the bounding box in board coordinates.

Definition at line 568 of file footprint.cpp.

 {
     m_boundingBox = GetFootprintRect();
 }

References GetFootprintRect(), and m_boundingBox.

Referenced by PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), AR_AUTOPLACER::AutoplaceFootprints(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), PCB_EDIT_FRAME::ExchangeFootprint(), Flip(), AR_AUTOPLACER::getOptimalFPPlacement(), LEGACY_PLUGIN::loadFOOTPRINT(), MoveAnchorPosition(), operator=(), AR_AUTOPLACER::pickFootprint(), Rotate(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ ClassOf()

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

inlinestatic

Definition at line 123 of file footprint.h.

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

References PCB_FOOTPRINT_T, and EDA_ITEM::Type().

◆ ClearAllNets()

void FOOTPRINT::ClearAllNets ( )

Function ClearAllNets Clear (i.e.

force the ORPHANED dummy net info) the net info which depends on a given board for all pads of the footprint. This is needed when a footprint is copied between the fp editor and the board editor for instance, because net info become fully broken

Definition at line 436 of file footprint.cpp.

 {
     // Force the ORPHANED dummy net info for all pads.
     // ORPHANED dummy net does not depend on a board
     for( PAD* pad : m_pads )
         pad->SetNetCode( NETINFO_LIST::ORPHANED );
 }

References m_pads, and NETINFO_LIST::ORPHANED.

Referenced by PCB_BASE_FRAME::loadFootprint(), and FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 181 of file eda_item.h.

181 { ClearFlags( BRIGHTENED ); }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:129

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:202

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 220 of file eda_item.h.

     {
         ClearFlags( GetEditFlags() );
     }

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

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( STATUS_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 202 of file eda_item.h.

202 { m_flags &= ~aMask; }

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 180 of file eda_item.h.

180 { ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Definition: eda_item.h:113

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:202

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 214 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 148 of file view_item.h.

     {
         m_viewPrivData = nullptr;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * FOOTPRINT::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 1098 of file footprint.cpp.

 {
     return new FOOTPRINT( *this );
 }

References FOOTPRINT().

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), Duplicate(), PCB_IO::FootprintSave(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ CoverageRatio()

double FOOTPRINT::CoverageRatio ( const GENERAL_COLLECTOR & aCollector ) const

Function CoverageRatio Calculates the ratio of total area of the footprint pads and graphical items to the area of the footprint.

Used by selection tool heuristics.

Returns: the ratio

Definition at line 1694 of file footprint.cpp.

 {
     int textMargin = KiROUND( 5 * aCollector.GetGuide()->OnePixelInIU() );
 
     SHAPE_POLY_SET footprintRegion( GetBoundingHull() );
     SHAPE_POLY_SET coveredRegion;
 
     TransformPadsWithClearanceToPolygon( coveredRegion, UNDEFINED_LAYER, 0, ARC_LOW_DEF,
                                          ERROR_OUTSIDE );
 
     TransformFPShapesWithClearanceToPolygon( coveredRegion, UNDEFINED_LAYER, textMargin,
                                              ARC_LOW_DEF, ERROR_OUTSIDE,
                                              true, /* include text */
                                              false /* include shapes */ );
 
     for( int i = 0; i < aCollector.GetCount(); ++i )
     {
         const BOARD_ITEM* item = aCollector[i];
 
         switch( item->Type() )
         {
         case PCB_FP_TEXT_T:
         case PCB_FP_SHAPE_T:
             if( item->GetParent() != this )
             {
                 item->TransformShapeWithClearanceToPolygon( coveredRegion, UNDEFINED_LAYER, 0,
                                                             ARC_LOW_DEF, ERROR_OUTSIDE );
             }
             break;
 
         case PCB_TEXT_T:
         case PCB_SHAPE_T:
         case PCB_TRACE_T:
         case PCB_ARC_T:
         case PCB_VIA_T:
             item->TransformShapeWithClearanceToPolygon( coveredRegion, UNDEFINED_LAYER, 0,
                                                         ARC_LOW_DEF, ERROR_OUTSIDE );
             break;
 
         case PCB_FOOTPRINT_T:
             if( item != this )
             {
                 const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( item );
                 coveredRegion.AddOutline( footprint->GetBoundingHull().Outline( 0 ) );
             }
             break;
 
         default:
             break;
         }
     }
 
     SHAPE_POLY_SET uncoveredRegion;
 
     try
     {
         uncoveredRegion.BooleanSubtract( footprintRegion, coveredRegion,
                                          SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
         uncoveredRegion.Simplify( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
         uncoveredRegion.Fracture( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
     }
     catch( ClipperLib::clipperException& )
     {
         // better to be conservative (this will result in the disambiguate dialog)
         return 1.0;
     }
 
     double footprintRegionArea = polygonArea( footprintRegion );
     double uncoveredRegionArea = polygonArea( uncoveredRegion );
     double coveredArea = footprintRegionArea - uncoveredRegionArea;
     double ratio = ( coveredArea / footprintRegionArea );
 
     return std::min( ratio, 1.0 );
 }

References SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::BooleanSubtract(), ERROR_OUTSIDE, SHAPE_POLY_SET::Fracture(), GetBoundingHull(), COLLECTOR::GetCount(), GENERAL_COLLECTOR::GetGuide(), BOARD_ITEM::GetParent(), KiROUND(), COLLECTORS_GUIDE::OnePixelInIU(), SHAPE_POLY_SET::Outline(), PCB_ARC_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, polygonArea(), SHAPE_POLY_SET::Simplify(), TransformFPShapesWithClearanceToPolygon(), TransformPadsWithClearanceToPolygon(), BOARD_ITEM::TransformShapeWithClearanceToPolygon(), EDA_ITEM::Type(), and UNDEFINED_LAYER.

Referenced by PCB_SELECTION_TOOL::GuessSelectionCandidates().

◆ Delete()

virtual void BOARD_ITEM_CONTAINER::Delete ( BOARD_ITEM * aItem )

inlinevirtualinherited

Removes an item from the container and deletes it.

Definition at line 74 of file board_item_container.h.

     {
         Remove( aItem );
         delete aItem;
     }

References BOARD_ITEM_CONTAINER::Remove().

Referenced by BOARD_DRC_ITEMS_PROVIDER::DeleteItem(), and BOARD_COMMIT::Push().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 113 of file board_item.cpp.

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

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

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

◆ Duplicate()

BOARD_ITEM * FOOTPRINT::Duplicate ( ) const

overridevirtual

Create a copy of a of this BOARD_ITEM.

Reimplemented from BOARD_ITEM.

Definition at line 1500 of file footprint.cpp.

 {
     FOOTPRINT* dupe = (FOOTPRINT*) Clone();
     const_cast<KIID&>( dupe->m_Uuid ) = KIID();
 
     dupe->RunOnChildren( [&]( BOARD_ITEM* child )
                          {
                              const_cast<KIID&>( child->m_Uuid ) = KIID();
                          });
 
     return static_cast<BOARD_ITEM*>( dupe );
 }

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

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), GPCB_PLUGIN::FootprintLoad(), LEGACY_PLUGIN::FootprintLoad(), EAGLE_PLUGIN::FootprintLoad(), PCB_IO::FootprintLoad(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), and FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard().

◆ DuplicateItem()

BOARD_ITEM * FOOTPRINT::DuplicateItem	(	const BOARD_ITEM *	aItem,
		bool	aAddToFootprint = `false`
	)

Function DuplicateItem Duplicate a given item within the footprint, optionally adding it to the board.

Returns: the new item, or NULL if the item could not be duplicated

Definition at line 1514 of file footprint.cpp.

 {
     BOARD_ITEM* new_item = NULL;
     FP_ZONE* new_zone = NULL;
 
     switch( aItem->Type() )
     {
     case PCB_PAD_T:
     {
         PAD* new_pad = new PAD( *static_cast<const PAD*>( aItem ) );
         const_cast<KIID&>( new_pad->m_Uuid ) = KIID();
 
         if( aAddToFootprint )
             m_pads.push_back( new_pad );
 
         new_item = new_pad;
         break;
     }
 
     case PCB_FP_ZONE_T:
     {
         new_zone = new FP_ZONE( *static_cast<const FP_ZONE*>( aItem ) );
         const_cast<KIID&>( new_zone->m_Uuid ) = KIID();
 
         if( aAddToFootprint )
             m_fp_zones.push_back( new_zone );
 
         new_item = new_zone;
         break;
     }
 
     case PCB_FP_TEXT_T:
     {
         FP_TEXT* new_text = new FP_TEXT( *static_cast<const FP_TEXT*>( aItem ) );
         const_cast<KIID&>( new_text->m_Uuid ) = KIID();
 
         if( new_text->GetType() == FP_TEXT::TEXT_is_REFERENCE )
         {
             new_text->SetText( wxT( "${REFERENCE}" ) );
             new_text->SetType( FP_TEXT::TEXT_is_DIVERS );
         }
         else if( new_text->GetType() == FP_TEXT::TEXT_is_VALUE )
         {
             new_text->SetText( wxT( "${VALUE}" ) );
             new_text->SetType( FP_TEXT::TEXT_is_DIVERS );
         }
 
         if( aAddToFootprint )
             Add( new_text );
 
         new_item = new_text;
 
         break;
     }
 
     case PCB_FP_SHAPE_T:
     {
         FP_SHAPE* new_shape = new FP_SHAPE( *static_cast<const FP_SHAPE*>( aItem ) );
         const_cast<KIID&>( new_shape->m_Uuid ) = KIID();
 
         if( aAddToFootprint )
             Add( new_shape );
 
         new_item = new_shape;
         break;
     }
 
     case PCB_GROUP_T:
         new_item = static_cast<const PCB_GROUP*>( aItem )->DeepDuplicate();
         break;
 
     case PCB_FOOTPRINT_T:
         // Ignore the footprint itself
         break;
 
     default:
         // Un-handled item for duplication
         wxFAIL_MSG( "Duplication not supported for items of class " + aItem->GetClass() );
         break;
     }
 
     return new_item;
 }

References Add(), EDA_ITEM::GetClass(), FP_TEXT::GetType(), m_fp_zones, m_pads, EDA_ITEM::m_Uuid, NULL, PAD, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, EDA_TEXT::SetText(), FP_TEXT::SetType(), FP_TEXT::TEXT_is_DIVERS, FP_TEXT::TEXT_is_REFERENCE, FP_TEXT::TEXT_is_VALUE, and EDA_ITEM::Type().

Referenced by EDIT_TOOL::Duplicate(), and ARRAY_CREATOR::Invoke().

◆ FindPadByName()

PAD * FOOTPRINT::FindPadByName ( const wxString & aPadName ) const

Function FindPadByName returns a PAD* with a matching name.

Note that names may not be unique, depending on how the foot print was created.

Parameters

aPadName the pad name to find

Returns: PAD* - The first matching name is returned, or NULL if not found.

Definition at line 886 of file footprint.cpp.

 {
     for( PAD* pad : m_pads )
     {
         if( pad->GetName() == aPadName )
             return pad;
     }
 
     return NULL;
 }

References m_pads, and NULL.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), BOARD_NETLIST_UPDATER::testConnectivity(), and DRC_TEST_PROVIDER_LVS::testFootprints().

◆ Flip() [1/2]

void FOOTPRINT::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).

Mirror the Y position (around the X axis)

Reimplemented from BOARD_ITEM.

Definition at line 1297 of file footprint.cpp.

 {
     // Move footprint to its final position:
     wxPoint finalPos = m_pos;
 
     // Now Flip the footprint.
     // Flipping a footprint is a specific transform: it is not mirrored like a text.
     // We have to change the side, and ensure the footprint rotation is modified according to the
     // transform, because this parameter is used in pick and place files, and when updating the
     // footprint from library.
     // When flipped around the X axis (Y coordinates changed) orientation is negated
     // When flipped around the Y axis (X coordinates changed) orientation is 180 - old orient.
     // Because it is specfic to a footprint, we flip around the X axis, and after rotate 180 deg
 
     MIRROR( finalPos.y, aCentre.y );     
 
     SetPosition( finalPos );
 
     // Flip layer
     SetLayer( FlipLayer( GetLayer() ) );
 
     // Reverse mirror orientation.
     m_orient = -m_orient;
 
     NORMALIZE_ANGLE_180( m_orient );
 
     // Mirror pads to other side of board.
     for( PAD* pad : m_pads )
         pad->Flip( m_pos, false );
 
     // Mirror zones to other side of board.
     for( ZONE* zone : m_fp_zones )
         zone->Flip( m_pos, aFlipLeftRight );
 
     // Mirror reference and value.
     m_reference->Flip( m_pos, false );
     m_value->Flip( m_pos, false );
 
     // Reverse mirror footprint graphics and texts.
     for( BOARD_ITEM* item : m_drawings )
     {
         switch( item->Type() )
         {
         case PCB_FP_SHAPE_T:
             static_cast<FP_SHAPE*>( item )->Flip( m_pos, false );
             break;
 
         case PCB_FP_TEXT_T:
             static_cast<FP_TEXT*>( item )->Flip( m_pos, false );
             break;
 
         default:
             wxMessageBox( wxT( "FOOTPRINT::Flip() error: Unknown Draw Type" ) );
             break;
         }
     }
 
     // Now rotate 180 deg if required
     if( aFlipLeftRight )
         Rotate( aCentre, 1800.0 );
 
     CalculateBoundingBox();
 }

References CalculateBoundingBox(), FP_TEXT::Flip(), FlipLayer(), BOARD_ITEM::GetLayer(), m_drawings, m_fp_zones, m_orient, m_pads, m_pos, m_reference, m_value, MIRROR(), NORMALIZE_ANGLE_180(), PCB_FP_SHAPE_T, PCB_FP_TEXT_T, Rotate(), BOARD_ITEM::SetLayer(), and SetPosition().

Referenced by PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_IO::FootprintSave(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FABMASTER::loadFootprints(), EAGLE_PLUGIN::orientFootprintAndText(), BOARD_EDITOR_CONTROL::PlaceModule(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Flip() [2/2]

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

inlineinherited

Definition at line 315 of file board_item.h.

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

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

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 84 of file inspectable.h.

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

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

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

◆ Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 93 of file inspectable.h.

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

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

◆ Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 102 of file inspectable.h.

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

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

◆ GetAllDrawingLayers()

void FOOTPRINT::GetAllDrawingLayers	(	int	aLayers[],
		int &	aCount,
		bool	aIncludePads = `true`
	)		const

Returns a set of all layers that this footprint has drawings on similar to ViewGetLayers()

Parameters

aLayers	is an array to store layer ids
aCount	is the number of layers stored in the array
aIncludePads	controls whether to also include pad layers

Definition at line 1130 of file footprint.cpp.

 {
     std::unordered_set<int> layers;
 
     for( BOARD_ITEM* item : m_drawings )
         layers.insert( static_cast<int>( item->GetLayer() ) );
 
     if( aIncludePads )
     {
         for( PAD* pad : m_pads )
         {
             int pad_layers[KIGFX::VIEW::VIEW_MAX_LAYERS], pad_layers_count;
             pad->ViewGetLayers( pad_layers, pad_layers_count );
 
             for( int i = 0; i < pad_layers_count; i++ )
                 layers.insert( pad_layers[i] );
         }
     }
 
     aCount = layers.size();
     int i = 0;
 
     for( int layer : layers )
         aLayers[i++] = layer;
 }

References m_drawings, m_pads, and KIGFX::VIEW::VIEW_MAX_LAYERS.

◆ GetArea()

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

Definition at line 574 of file footprint.cpp.

 {
     double w = std::abs( static_cast<double>( m_boundingBox.GetWidth() ) ) + aPadding;
     double h = std::abs( static_cast<double>( m_boundingBox.GetHeight() ) ) + aPadding;
     return w * h;
 }

References EDA_RECT::GetHeight(), EDA_RECT::GetWidth(), and m_boundingBox.

Referenced by sortFootprintsByComplexity(), sortFootprintsByRatsnestSize(), and SpreadFootprints().

◆ GetAttributes()

int FOOTPRINT::GetAttributes ( ) const

inline

Definition at line 249 of file footprint.h.

249 { return m_attributes; }

FOOTPRINT::m_attributes

int m_attributes

Definition: footprint.h:716

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), FootprintWriteShape(), PCB_IO::format(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 46 of file board_item.cpp.

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

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

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

◆ GetBoundingBox() [1/2]

const EDA_RECT FOOTPRINT::GetBoundingBox ( ) const

overridevirtual

Return the orthogonal bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 631 of file footprint.cpp.

 {
     return GetBoundingBox( true );
 }

Referenced by AR_AUTOPLACER::buildFpAreas(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), and HitTest().

◆ GetBoundingBox() [2/2]

const EDA_RECT FOOTPRINT::GetBoundingBox ( bool aIncludeInvisibleText ) const

Definition at line 637 of file footprint.cpp.

 {
     EDA_RECT area = GetFootprintRect();
 
     // Add in items not collected by GetFootprintRect():
     for( BOARD_ITEM* item : m_drawings )
     {
         if( item->Type() != PCB_FP_SHAPE_T )
             area.Merge( item->GetBoundingBox() );
     }
 
     // This can be further optimized when aIncludeInvisibleText is true, but currently
     // leaving this as is until it's determined there is a noticeable speed hit.
     bool   valueLayerIsVisible = true;
     bool   refLayerIsVisible   = true;
     BOARD* board               = GetBoard();
 
     if( board )
     {
         // The first "&&" conditional handles the user turning layers off as well as layers
         // not being present in the current PCB stackup.  Values, references, and all
         // footprint text can also be turned off via the GAL meta-layers, so the 2nd and
         // 3rd "&&" conditionals handle that.
         valueLayerIsVisible = board->IsLayerVisible( m_value->GetLayer() )
                               && board->IsElementVisible( LAYER_MOD_VALUES )
                               && board->IsElementVisible( LAYER_MOD_TEXT_FR );
 
         refLayerIsVisible = board->IsLayerVisible( m_reference->GetLayer() )
                             && board->IsElementVisible( LAYER_MOD_REFERENCES )
                             && board->IsElementVisible( LAYER_MOD_TEXT_FR );
     }
 
 
     if(( m_value->IsVisible() && valueLayerIsVisible ) || aIncludeInvisibleText )
         area.Merge( m_value->GetBoundingBox() );
 
     if(( m_reference->IsVisible() && refLayerIsVisible ) || aIncludeInvisibleText )
         area.Merge( m_reference->GetBoundingBox() );
 
     return area;
 }

References BOARD_ITEM::GetBoard(), FP_TEXT::GetBoundingBox(), GetFootprintRect(), BOARD_ITEM::GetLayer(), BOARD::IsElementVisible(), BOARD::IsLayerVisible(), EDA_TEXT::IsVisible(), LAYER_MOD_REFERENCES, LAYER_MOD_TEXT_FR, LAYER_MOD_VALUES, m_drawings, m_reference, m_value, EDA_RECT::Merge(), and PCB_FP_SHAPE_T.

◆ GetBoundingBoxBase()

EDA_RECT FOOTPRINT::GetBoundingBoxBase ( ) const

inline

Returns the last calculated bounding box of the footprint (does not recalculate it).

(call CalculateBoundingBox() to recalculate it)

Returns: EDA_RECT - The rectangle containing the footprint

Definition at line 161 of file footprint.h.

161 { return m_boundingBox; }

FOOTPRINT::m_boundingBox

EDA_RECT m_boundingBox

Definition: footprint.h:718

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

◆ GetBoundingHull()

SHAPE_POLY_SET FOOTPRINT::GetBoundingHull ( ) const

Returns a bounding polygon for the shapes and pads in the footprint This operation is slower but more accurate than calculating a bounding box.

Definition at line 680 of file footprint.cpp.

 {
     SHAPE_POLY_SET rawPolys;
 
     for( BOARD_ITEM* item : m_drawings )
     {
         if( item->Type() == PCB_FP_SHAPE_T )
         {
             item->TransformShapeWithClearanceToPolygon( rawPolys, UNDEFINED_LAYER, 0, ARC_LOW_DEF,
                                                         ERROR_OUTSIDE );
         }
 
         // We intentionally exclude footprint text from the bounding hull.
     }
 
     for( PAD* pad : m_pads )
     {
         pad->TransformShapeWithClearanceToPolygon( rawPolys, UNDEFINED_LAYER, 0, ARC_LOW_DEF,
                                                    ERROR_OUTSIDE );
     }
 
     for( FP_ZONE* zone : m_fp_zones )
     {
         for( PCB_LAYER_ID layer : zone->GetLayerSet().Seq() )
         {
             SHAPE_POLY_SET layerPoly = zone->GetFilledPolysList( layer );
 
             for( int ii = 0; ii < layerPoly.OutlineCount(); ii++ )
             {
                 const SHAPE_LINE_CHAIN& poly = layerPoly.COutline( ii );
                 rawPolys.AddOutline( poly );
             }
         }
     }
 
     // If there are some graphic items, build the actual hull.
     // However if no items, create a minimal polygon (can happen if a footprint
     // is created with no item: it contains only 2 texts.
     if( rawPolys.OutlineCount() == 0 )
     {
         // generate a small dummy rectangular outline around the anchor
         const int halfsize = Millimeter2iu( 0.02 );
 
         rawPolys.NewOutline();
         // add a square:
         rawPolys.Append( GetPosition().x - halfsize,  GetPosition().y - halfsize );
         rawPolys.Append( GetPosition().x + halfsize,  GetPosition().y - halfsize );
         rawPolys.Append( GetPosition().x + halfsize,  GetPosition().y + halfsize );
         rawPolys.Append( GetPosition().x - halfsize,  GetPosition().y + halfsize );
     }
 
     std::vector<wxPoint> convex_hull;
     BuildConvexHull( convex_hull, rawPolys );
 
     SHAPE_POLY_SET hullPoly;
     hullPoly.NewOutline();
 
     for( const wxPoint& pt : convex_hull )
         hullPoly.Append( pt );
 
     return hullPoly;
 }

References SHAPE_POLY_SET::AddOutline(), SHAPE_POLY_SET::Append(), BuildConvexHull(), SHAPE_POLY_SET::COutline(), ERROR_OUTSIDE, GetPosition(), m_drawings, m_fp_zones, m_pads, Millimeter2iu(), SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::OutlineCount(), PCB_FP_SHAPE_T, and UNDEFINED_LAYER.

Referenced by CoverageRatio(), GetCoverageArea(), HitTestAccurate(), and PCB_SELECTION_TOOL::hitTestDistance().

◆ GetCenter()

virtual wxPoint BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

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

Returns: center point of the item

Reimplemented in ARC, PAD, PCB_SHAPE, and PCB_MARKER.

Definition at line 114 of file board_item.h.

     {
         return GetBoundingBox().GetCenter();
     }

References EDA_ITEM::GetBoundingBox(), and EDA_RECT::GetCenter().

Referenced by ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), and getDrilledHoleShape().

◆ GetClass()

wxString FOOTPRINT::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 586 of file footprint.h.

     {
         return wxT( "FOOTPRINT" );
     }

Referenced by Visit().

◆ GetContextualTextVars()

void FOOTPRINT::GetContextualTextVars ( wxArrayString * aVars ) const

Return the list of system text vars for this footprint.

Definition at line 401 of file footprint.cpp.

 {
     aVars->push_back( wxT( "REFERENCE" ) );
     aVars->push_back( wxT( "VALUE" ) );
     aVars->push_back( wxT( "LAYER" ) );
 }

◆ GetCoverageArea()

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

static

Definition at line 1646 of file footprint.cpp.

 {
     int textMargin = KiROUND( 5 * aCollector.GetGuide()->OnePixelInIU() );
     SHAPE_POLY_SET poly;
 
     if( aItem->Type() == PCB_MARKER_T )
     {
         const PCB_MARKER* marker = static_cast<const PCB_MARKER*>( aItem );
         SHAPE_LINE_CHAIN  markerShape;
 
         marker->ShapeToPolygon( markerShape );
         return markerShape.Area();
     }
     else if( aItem->Type() == PCB_GROUP_T )
     {
         double combinedArea = 0.0;
 
         for( BOARD_ITEM* member : static_cast<const PCB_GROUP*>( aItem )->GetItems() )
             combinedArea += GetCoverageArea( member, aCollector );
 
         return combinedArea;
     }
 
     if( aItem->Type() == PCB_FOOTPRINT_T )
     {
         const FOOTPRINT* footprint = static_cast<const FOOTPRINT*>( aItem );
 
         poly = footprint->GetBoundingHull();
     }
     else if( aItem->Type() == PCB_FP_TEXT_T )
     {
         const FP_TEXT* text = static_cast<const FP_TEXT*>( aItem );
 
         text->TransformTextShapeWithClearanceToPolygon( poly, UNDEFINED_LAYER, textMargin,
                                                         ARC_LOW_DEF, ERROR_OUTSIDE );
     }
     else
     {
         aItem->TransformShapeWithClearanceToPolygon( poly, UNDEFINED_LAYER, 0,
                                                      ARC_LOW_DEF, ERROR_OUTSIDE );
     }
 
     poly.Simplify( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
     poly.Fracture( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
     return polygonArea( poly );
 }

References SHAPE_LINE_CHAIN::Area(), ERROR_OUTSIDE, GetBoundingHull(), GENERAL_COLLECTOR::GetGuide(), KiROUND(), COLLECTORS_GUIDE::OnePixelInIU(), PCB_FOOTPRINT_T, PCB_FP_TEXT_T, PCB_GROUP_T, PCB_MARKER_T, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, polygonArea(), MARKER_BASE::ShapeToPolygon(), BOARD_ITEM::TransformShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_ITEM::Type(), and UNDEFINED_LAYER.

Referenced by PCB_SELECTION_TOOL::GuessSelectionCandidates().

◆ GetDescription()

const wxString& FOOTPRINT::GetDescription ( ) const

inline

Definition at line 211 of file footprint.h.

211 { return m_doc; }

FOOTPRINT::m_doc

wxString m_doc

Definition: footprint.h:728

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), PCB_IO::format(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FOOTPRINT_INFO_IMPL::load(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

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

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), 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_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > FOOTPRINT::GetEffectiveShape ( PCB_LAYER_ID aLayer = UNDEFINED_LAYER ) const

overridevirtual

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

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

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 1770 of file footprint.cpp.

 {
     std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
 
     // There are several possible interpretations here:
     // 1) the bounding box (without or without invisible items)
     // 2) just the pads and "edges" (ie: non-text graphic items)
     // 3) the courtyard
 
     // We'll go with (2) for now....
 
     for( PAD* pad : Pads() )
         shape->AddShape( pad->GetEffectiveShape( aLayer )->Clone() );
 
     for( BOARD_ITEM* item : GraphicalItems() )
     {
         if( item->Type() == PCB_FP_SHAPE_T )
             shape->AddShape( item->GetEffectiveShape( aLayer )->Clone() );
     }
 
     return shape;
 }

References GraphicalItems(), Pads(), and PCB_FP_SHAPE_T.

◆ GetFirstPad()

PAD* FOOTPRINT::GetFirstPad ( ) const

inline

Gets the first pad in the list or NULL if none.

Returns: first pad or null pointer

Definition at line 517 of file footprint.h.

     {
         return m_pads.empty() ? nullptr : m_pads.front();
     }

Referenced by GetTopLeftPad().

◆ GetFlag()

int FOOTPRINT::GetFlag ( ) const

inline

Definition at line 254 of file footprint.h.

254 { return m_arflag; }

FOOTPRINT::m_arflag

int m_arflag

Definition: footprint.h:732

Referenced by DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::pickFootprint(), and sortFootprintsByRatsnestSize().

◆ GetFlags()

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 307 of file eda_item.h.

307 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:300

References EDA_ITEM::GetPosition().

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

◆ GetFootprintRect()

EDA_RECT FOOTPRINT::GetFootprintRect ( ) const

Function GetFootprintRect() Build and returns the boundary box of the footprint excluding any text.

Returns: EDA_RECT - The rectangle containing the footprint.

Definition at line 582 of file footprint.cpp.

 {
     EDA_RECT area;
 
     area.SetOrigin( m_pos );
     area.SetEnd( m_pos );
     area.Inflate( Millimeter2iu( 0.25 ) );   // Give a min size to the area
 
     for( BOARD_ITEM* item : m_drawings )
     {
         if( item->Type() == PCB_FP_SHAPE_T )
             area.Merge( item->GetBoundingBox() );
     }
 
     for( PAD* pad : m_pads )
         area.Merge( pad->GetBoundingBox() );
 
     for( FP_ZONE* zone : m_fp_zones )
         area.Merge( zone->GetBoundingBox() );
 
     // Groups do not contribute to the rect, only their members
 
     return area;
 }

References EDA_RECT::Inflate(), m_drawings, m_fp_zones, m_pads, m_pos, EDA_RECT::Merge(), Millimeter2iu(), PCB_FP_SHAPE_T, EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

Referenced by CalculateBoundingBox(), GetBoundingBox(), GetBoundingBoxes(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), AR_AUTOPLACER::getOptimalFPPlacement(), PCB_SELECTION_TOOL::hitTestDistance(), moveFootprintsInArea(), SpreadFootprints(), AR_AUTOPLACER::testFootprintOnBoard(), and ViewBBox().

◆ GetFPID()

const LIB_ID& FOOTPRINT::GetFPID ( ) const

inline

Definition at line 208 of file footprint.h.

208 { return m_fpid; }

FOOTPRINT::m_fpid

LIB_ID m_fpid

Definition: footprint.h:715

◆ GetFpPadsLocalBbox()

EDA_RECT FOOTPRINT::GetFpPadsLocalBbox ( ) const

Returns the bounding box containing pads when the footprint is on the front side, orientation 0, position 0,0.

mainly used in Gerber place file to draw a fp outline when the coutyard is missing or broken

Returns: EDA_RECT - The rectangle containing the pads for the normalized footprint.

Definition at line 608 of file footprint.cpp.

 {
     EDA_RECT area;
 
     // We want the bounding box of the footprint pads at rot 0, not flipped
     // Create such a image:
     FOOTPRINT dummy( *this );
 
     dummy.SetPosition( wxPoint( 0, 0 ) );
 
     if( dummy.IsFlipped() )
         dummy.Flip( wxPoint( 0, 0 ) , false );
 
     if( dummy.GetOrientation() )
         dummy.SetOrientation( 0 );
 
     for( PAD* pad : dummy.Pads() )
         area.Merge( pad->GetBoundingBox() );
 
     return area;
 }

References dummy(), EDA_RECT::Merge(), and EDA_ITEM::SetPosition().

◆ GetInitialComments()

const wxArrayString* FOOTPRINT::GetInitialComments ( ) const

inline

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

Definition at line 671 of file footprint.h.

671 { return m_initial_comments; }

FOOTPRINT::m_initial_comments

wxArrayString * m_initial_comments

Definition: footprint.h:739

Referenced by PCB_IO::format().

◆ GetKeywords()

const wxString& FOOTPRINT::GetKeywords ( ) const

inline

Definition at line 214 of file footprint.h.

214 { return m_keywords; }

FOOTPRINT::m_keywords

wxString m_keywords

Definition: footprint.h:729

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), PCB_IO::format(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), FOOTPRINT_INFO_IMPL::load(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetLastEditTime()

timestamp_t FOOTPRINT::GetLastEditTime ( ) const

inline

Definition at line 348 of file footprint.h.

348 { return m_lastEditTime; }

FOOTPRINT::m_lastEditTime

timestamp_t m_lastEditTime

Definition: footprint.h:731

Referenced by PCB_IO::format(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 173 of file board_item.h.

173 { return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:363

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

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

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

Referenced by PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PCB_TEXT::GetSelectMenuText(), FP_SHAPE::GetSelectMenuText(), TRACK::GetSelectMenuText(), DIMENSION_BASE::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetShownText(), TEXT_MOD_GRID_TABLE::GetValue(), and ResolveTextVar().

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

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

Reimplemented in VIA, PAD, ZONE, and PCB_GROUP.

Definition at line 178 of file board_item.h.

178 { return LSET( m_layer ); }

LSET

LSET is a set of PCB_LAYER_IDs.

Definition: layers_id_colors_and_visibility.h:491

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:363

References BOARD_ITEM::m_layer.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), build_pad_testpoints(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRulesForItems(), extractDiffPairCoupledItems(), hash_board_item(), DRC_RTREE::Insert(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_ITEM::layerMaskDescribe(), PCB_GRID_HELPER::nearestAnchor(), CN_VISITOR::operator()(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ GetLink()

KIID FOOTPRINT::GetLink ( ) const

inline

Definition at line 558 of file footprint.h.

558 { return m_link; }

FOOTPRINT::m_link

KIID m_link

Definition: footprint.h:733

Referenced by footprintIsFromBoard(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ GetLocalClearance() [1/2]

int FOOTPRINT::GetLocalClearance ( ) const

inline

Definition at line 223 of file footprint.h.

223 { return m_localClearance; }

FOOTPRINT::m_localClearance

int m_localClearance

Definition: footprint.h:723

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::format(), PAD::GetLocalClearanceOverrides(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ GetLocalClearance() [2/2]

int FOOTPRINT::GetLocalClearance ( wxString * aSource ) const

inline

Definition at line 226 of file footprint.h.

     {
         if( aSource )
             *aSource = wxString::Format( _( "footprint %s" ), GetReference() );
 
         return m_localClearance;
     }

References _, and Format().

◆ GetLocalSolderMaskMargin()

int FOOTPRINT::GetLocalSolderMaskMargin ( ) const

inline

Definition at line 220 of file footprint.h.

220 { return m_localSolderMaskMargin; }

FOOTPRINT::m_localSolderMaskMargin

int m_localSolderMaskMargin

Definition: footprint.h:724

Referenced by PCB_IO::format(), PAD::GetSolderMaskMargin(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ GetLocalSolderPasteMargin()

int FOOTPRINT::GetLocalSolderPasteMargin ( ) const

inline

Definition at line 234 of file footprint.h.

234 { return m_localSolderPasteMargin; }

FOOTPRINT::m_localSolderPasteMargin

int m_localSolderPasteMargin

Definition: footprint.h:725

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::format(), PAD::GetSolderPasteMargin(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ GetLocalSolderPasteMarginRatio()

double FOOTPRINT::GetLocalSolderPasteMarginRatio ( ) const

inline

Definition at line 237 of file footprint.h.

237 { return m_localSolderPasteMarginRatio; }

FOOTPRINT::m_localSolderPasteMarginRatio

double m_localSolderPasteMarginRatio

Definition: footprint.h:726

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::format(), PAD::GetSolderPasteMargin(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ GetMenuImage()

BITMAP_DEF FOOTPRINT::GetMenuImage ( ) const

overridevirtual

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

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1092 of file footprint.cpp.

 {
     return module_xpm;
 }

References module_xpm.

◆ GetMsgPanelInfo()

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

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 744 of file footprint.cpp.

 {
     wxString msg, msg2;
 
     aList.emplace_back( m_reference->GetShownText(), m_value->GetShownText() );
 
     if( aFrame->IsType( FRAME_FOOTPRINT_VIEWER )
         || aFrame->IsType( FRAME_FOOTPRINT_VIEWER_MODAL )
         || aFrame->IsType( FRAME_FOOTPRINT_EDITOR ) )
     {
         wxDateTime date( static_cast<time_t>( m_lastEditTime ) );
 
         // Date format: see http://www.cplusplus.com/reference/ctime/strftime
         if( m_lastEditTime && date.IsValid() )
             msg = date.Format( wxT( "%b %d, %Y" ) ); // Abbreviated_month_name Day, Year
         else
             msg = _( "Unknown" );
 
         aList.emplace_back( _( "Last Change" ), msg );
     }
     else if( aFrame->IsType( FRAME_PCB_EDITOR ) )
     {
         aList.emplace_back( _( "Board Side" ), IsFlipped() ? _( "Back (Flipped)" ) : _( "Front" ) );
     }
 
     auto addToken = []( wxString* aStr, const wxString& aAttr )
                     {
                         if( !aStr->IsEmpty() )
                             *aStr += wxT( ", " );
 
                         *aStr += aAttr;
                     };
 
     wxString status;
     wxString attrs;
 
     if( IsLocked() )
         addToken( &status, _( "locked" ) );
 
     if( m_fpStatus & FP_is_PLACED )
         addToken( &status, _( "autoplaced" ) );
 
     if( m_attributes & FP_BOARD_ONLY )
         addToken( &attrs, _( "not in schematic" ) );
 
     if( m_attributes & FP_EXCLUDE_FROM_POS_FILES )
         addToken( &attrs, _( "exclude from pos files" ) );
 
     if( m_attributes & FP_EXCLUDE_FROM_BOM )
         addToken( &attrs, _( "exclude from BOM" ) );
 
     aList.emplace_back( _( "Status: " ) + status, _( "Attributes:" ) + wxS( " " ) + attrs );
 
     aList.emplace_back( _( "Rotation" ), wxString::Format( "%.4g", GetOrientationDegrees() ) );
 
     msg.Printf( _( "Footprint: %s" ), m_fpid.Format().c_str() );
     msg2.Printf( _( "3D-Shape: %s" ), m_3D_Drawings.empty() ? _( "<none>" )
                                                             : m_3D_Drawings.front().m_Filename );
     aList.emplace_back( msg, msg2 );
 
     msg.Printf( _( "Doc: %s" ), m_doc );
     msg2.Printf( _( "Keywords: %s" ), m_keywords );
     aList.emplace_back( msg, msg2 );
 }

References _, UTF8::c_str(), LIB_ID::Format(), Format(), FP_BOARD_ONLY, FP_EXCLUDE_FROM_BOM, FP_EXCLUDE_FROM_POS_FILES, FP_is_PLACED, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, FRAME_PCB_EDITOR, GetOrientationDegrees(), FP_TEXT::GetShownText(), IsFlipped(), IsLocked(), EDA_BASE_FRAME::IsType(), m_3D_Drawings, m_attributes, m_doc, m_fpid, m_fpStatus, m_keywords, m_lastEditTime, m_reference, and m_value.

Referenced by DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel().

◆ GetNextPadName()

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

Function GetNextPadName returns the next available pad name in the footprint.

Parameters

aFillSequenceGaps true if the numbering should "fill in" gaps in the sequence, else return the highest value + 1

Returns: the next available pad name

Definition at line 1599 of file footprint.cpp.

 {
     std::set<wxString> usedNames;
 
     // Create a set of used pad numbers
     for( PAD* pad : m_pads )
         usedNames.insert( pad->GetName() );
 
     wxString prefix = UTIL::GetReferencePrefix( aLastPadName );
     int      num = GetTrailingInt( aLastPadName );
 
     while( usedNames.count( wxString::Format( "%s%d", prefix, num ) ) )
         num++;
 
     return wxString::Format( "%s%d", prefix, num );
 }

References Format(), UTIL::GetReferencePrefix(), GetTrailingInt(), and m_pads.

Referenced by EDIT_TOOL::Duplicate().

◆ GetOrientation()

double FOOTPRINT::GetOrientation ( ) const

inline

Definition at line 204 of file footprint.h.

204 { return m_orient; }

FOOTPRINT::m_orient

double m_orient

Definition: footprint.h:711

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_PAD::AddToFootprint(), AR_AUTOPLACER::AutoplaceFootprints(), ConvertOutlineToPolygon(), doPushPadProperties(), PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_footprint(), PCB_IO::format(), PCB_SHAPE::GetBoundingBox(), FP_TEXT::GetDrawRotation(), PCB_SHAPE::GetRectCorners(), hash_fp_item(), idf_export_footprint(), PAD::ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), LEGACY_PLUGIN::loadPAD(), MoveAnchorPosition(), EAGLE_PLUGIN::orientFPText(), ALTIUM_PCB::ParseComponentsBodies6Data(), ALTIUM_PCB::ParseTexts6Data(), pasteFootprintItemsToFootprintEditor(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), RENDER_3D_LEGACY::renderFootprint(), Rotate(), AR_AUTOPLACER::rotateFootprint(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), EAGLE_PLUGIN::transferPad(), and PCB_SHAPE::TransformShapeWithClearanceToPolygon().

◆ GetOrientationDegrees()

double FOOTPRINT::GetOrientationDegrees ( ) const

inline

Definition at line 205 of file footprint.h.

205 { return m_orient / 10.0; }

FOOTPRINT::m_orient

double m_orient

Definition: footprint.h:711

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), DSN::SPECCTRA_DB::FromBOARD(), GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), DIALOG_PAD_PROPERTIES::initValues(), and DSN::SPECCTRA_DB::makeIMAGE().

◆ GetOrientationRadians()

double FOOTPRINT::GetOrientationRadians ( ) const

inline

Definition at line 206 of file footprint.h.

206 { return m_orient * M_PI / 1800; }

FOOTPRINT::m_orient

double m_orient

Definition: footprint.h:711

Referenced by KIGFX::PCB_PAINTER::draw(), export_vrml_fp_shape(), ALTIUM_PCB::HelperDrawsegmentSetLocalCoord(), and PCB_SHAPE::MakeEffectiveShapes().

◆ GetPad()

PAD * FOOTPRINT::GetPad	(	const wxPoint &	aPosition,
		LSET	aLayerMask = `LSET::AllLayersMask()`
	)

Function GetPad get a pad at aPosition on aLayerMask in the footprint.

Parameters

aPosition	A wxPoint object containing the position to hit test.
aLayerMask	A layer or layers to mask the hit test.

Returns: A pointer to a PAD object if found otherwise NULL.

Definition at line 898 of file footprint.cpp.

 {
     for( PAD* pad : m_pads )
     {
         // ... and on the correct layer.
         if( !( pad->GetLayerSet() & aLayerMask ).any() )
             continue;
 
         if( pad->HitTest( aPosition ) )
             return pad;
     }
 
     return NULL;
 }

References m_pads, and NULL.

◆ GetPadCount()

unsigned FOOTPRINT::GetPadCount ( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const

GetPadCount returns the number of pads.

Parameters

aIncludeNPTH includes non-plated through holes when true. Does not include non-plated through holes when false.

Returns: the number of pads according to aIncludeNPTH.

Definition at line 933 of file footprint.cpp.

 {
     if( aIncludeNPTH )
         return m_pads.size();
 
     unsigned cnt = 0;
 
     for( PAD* pad : m_pads )
     {
         if( pad->GetAttribute() == PAD_ATTRIB_NPTH )
             continue;
 
         cnt++;
     }
 
     return cnt;
 }

References m_pads, and PAD_ATTRIB_NPTH.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), FOOTPRINT_INFO_IMPL::load(), sortFootprintsByComplexity(), AR_AUTOPLACER::testFootprintOnBoard(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 168 of file board_item.h.

168 { return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:527

BOARD_ITEM_CONTAINER

Abstract interface for BOARD_ITEMs capable of storing other items inside.

Definition: board_item_container.h:52

References EDA_ITEM::m_parent.

◆ GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 93 of file board_item.h.

93 { return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:364

References BOARD_ITEM::m_group.

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

◆ GetPath()

const KIID_PATH& FOOTPRINT::GetPath ( ) const

inline

Definition at line 217 of file footprint.h.

217 { return m_path; }

FOOTPRINT::m_path

KIID_PATH m_path

Definition: footprint.h:730

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), PCB_IO::format(), PCB_SELECTION_TOOL::selectAllItemsOnSheet(), PCB_SELECTION_TOOL::selectSameSheet(), sortFootprintsbySheetPath(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetPlacementCost180()

int FOOTPRINT::GetPlacementCost180 ( ) const

inline

Definition at line 561 of file footprint.h.

561 { return m_rot180Cost; }

FOOTPRINT::m_rot180Cost

int m_rot180Cost

Definition: footprint.h:735

Referenced by AR_AUTOPLACER::AutoplaceFootprints(), PCB_IO::format(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ GetPlacementCost90()

int FOOTPRINT::GetPlacementCost90 ( ) const

inline

Definition at line 564 of file footprint.h.

564 { return m_rot90Cost; }

FOOTPRINT::m_rot90Cost

int m_rot90Cost

Definition: footprint.h:734

Referenced by AR_AUTOPLACER::AutoplaceFootprints(), PCB_IO::format(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ GetPolyCourtyardBack()

SHAPE_POLY_SET& FOOTPRINT::GetPolyCourtyardBack ( )

inline

Definition at line 677 of file footprint.h.

677 { return m_poly_courtyard_back; }

FOOTPRINT::m_poly_courtyard_back

SHAPE_POLY_SET m_poly_courtyard_back

Definition: footprint.h:743

Referenced by AR_AUTOPLACER::buildFpAreas(), insideArea(), and DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances().

◆ GetPolyCourtyardFront()

SHAPE_POLY_SET& FOOTPRINT::GetPolyCourtyardFront ( )

inline

Used in DRC to test the courtyard area (a complex polygon)

Returns: the courtyard polygon

Definition at line 676 of file footprint.h.

676 { return m_poly_courtyard_front; }

FOOTPRINT::m_poly_courtyard_front

SHAPE_POLY_SET m_poly_courtyard_front

Definition: footprint.h:742

Referenced by AR_AUTOPLACER::buildFpAreas(), insideArea(), and DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances().

◆ GetPosition()

wxPoint FOOTPRINT::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 200 of file footprint.h.

200 { return m_pos; }

FOOTPRINT::m_pos

wxPoint m_pos

Definition: footprint.h:712

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCAD2KICAD::PCB_PAD::AddToFootprint(), PCB_GRID_HELPER::computeAnchors(), ConvertOutlineToPolygon(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_footprint(), export_vrml_fp_shape(), PCB_IO::FootprintSave(), PCB_IO::format(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromBOARD(), PCB_SHAPE::GetBoundingBox(), GetBoundingHull(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), AR_AUTOPLACER::getOptimalFPPlacement(), PCB_SHAPE::GetRectCorners(), hash_fp_item(), ALTIUM_PCB::HelperDrawsegmentSetLocalCoord(), idf_export_footprint(), ROUTER_TOOL::InlineDrag(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadPAD(), PCB_SHAPE::MakeEffectiveShapes(), moveFootprintsInArea(), EAGLE_PLUGIN::orientFootprintAndText(), EAGLE_PLUGIN::packageHole(), EAGLE_PLUGIN::packageText(), PAD::PAD(), ALTIUM_PCB::ParseComponentsBodies6Data(), BOARD_EDITOR_CONTROL::PlaceModule(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), RENDER_3D_LEGACY::renderFootprint(), CLIPBOARD_IO::SaveSelection(), DRAWING_TOOL::SetAnchor(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), SetOrientation(), DRC_TEST_PROVIDER_LVS::testFootprints(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), EAGLE_PLUGIN::transferPad(), and PCB_SHAPE::TransformShapeWithClearanceToPolygon().

◆ GetProperties()

const std::map<wxString, wxString>& FOOTPRINT::GetProperties ( ) const

inline

Definition at line 489 of file footprint.h.

489 { return m_properties; }

FOOTPRINT::m_properties

std::map< wxString, wxString > m_properties

Definition: footprint.h:738

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), PCB_IO::format(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetReference()

const wxString FOOTPRINT::GetReference ( void ) const

inline

Function GetReference.

Returns: const wxString& - the reference designator text.

Definition at line 442 of file footprint.h.

     {
         return m_reference->GetText();
     }

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), AR_AUTOPLACER::AutoplaceFootprints(), FROM_TO_CACHE::cacheFromToPaths(), CollisionMatchesExpected(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), GERBER_WRITER::createDrillFile(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FormatProbeItem(), DSN::SPECCTRA_DB::FromBOARD(), PLACE_FILE_EXPORTER::GenReportData(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), GetSelectMenuText(), getShapeName(), IncrementReference(), GENERAL_COLLECTOR::Inspect(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), EAGLE_PLUGIN::loadElements(), CADSTAR_PCB_ARCHIVE_LOADER::loadNets(), EDA_3D_CANVAS::OnMouseMove(), ALTIUM_PCB::ParsePads6Data(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPad(), DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), BOARD_NETLIST_UPDATER::replaceComponent(), CLIPBOARD_IO::SaveSelection(), DRC_TEST_PROVIDER_LVS::testFootprints(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), FOOTPRINT_EDIT_FRAME::updateTitle(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetSelectMenuText()

wxString FOOTPRINT::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 1081 of file footprint.cpp.

 {
     wxString reference = GetReference();
 
     if( reference.IsEmpty() )
         reference = _( "<no reference designator>" );
 
     return wxString::Format( _( "Footprint %s" ), reference );
 }

References _, Format(), and GetReference().

◆ GetState()

int EDA_ITEM::GetState ( int type ) const

inlineinherited

Definition at line 185 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 198 of file eda_item.h.

198 { return m_status; }

EDA_ITEM::m_status

STATUS_FLAGS m_status

Definition: eda_item.h:526

References EDA_ITEM::m_status.

◆ GetThermalGap()

int FOOTPRINT::GetThermalGap ( ) const

inline

Definition at line 247 of file footprint.h.

247 { return m_thermalGap; }

FOOTPRINT::m_thermalGap

int m_thermalGap

Definition: footprint.h:722

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::format(), and PAD::GetEffectiveThermalGap().

◆ GetThermalWidth()

int FOOTPRINT::GetThermalWidth ( ) const

inline

Definition at line 244 of file footprint.h.

244 { return m_thermalWidth; }

FOOTPRINT::m_thermalWidth

int m_thermalWidth

Definition: footprint.h:721

Referenced by FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::format(), and PAD::GetEffectiveThermalSpokeWidth().

◆ GetTopLeftPad()

PAD * FOOTPRINT::GetTopLeftPad ( )

Definition at line 914 of file footprint.cpp.

 {
     PAD* topLeftPad = GetFirstPad();
 
     for( PAD* p : m_pads )
     {
         wxPoint pnt = p->GetPosition(); // GetPosition() returns the center of the pad
 
         if( ( pnt.x < topLeftPad->GetPosition().x ) ||
             ( topLeftPad->GetPosition().x == pnt.x && pnt.y < topLeftPad->GetPosition().y ) )
         {
             topLeftPad = p;
         }
     }
 
     return topLeftPad;
 }

References GetFirstPad(), PAD::GetPosition(), and m_pads.

◆ GetUniquePadCount()

unsigned FOOTPRINT::GetUniquePadCount ( INCLUDE_NPTH_T aIncludeNPTH = INCLUDE_NPTH_T(INCLUDE_NPTH) ) const

GetUniquePadCount returns the number of unique pads.

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

GetUniquePadCount calculate the count of not blank pad names

Parameters

aIncludeNPTH includes non-plated through holes when true. Does not include non-plated through holes when false.

Returns: the number of unique pads according to aIncludeNPTH.

Definition at line 952 of file footprint.cpp.

 {
     std::set<wxString> usedNames;
 
     // Create a set of used pad numbers
     for( PAD* pad : m_pads )
     {
         // Skip pads not on copper layers (used to build complex
         // solder paste shapes for instance)
         if( ( pad->GetLayerSet() & LSET::AllCuMask() ).none() )
             continue;
 
         // Skip pads with no name, because they are usually "mechanical"
         // pads, not "electrical" pads
         if( pad->GetName().IsEmpty() )
             continue;
 
         if( !aIncludeNPTH )
         {
             // skip NPTH
             if( pad->GetAttribute() == PAD_ATTRIB_NPTH )
             {
                 continue;
             }
         }
 
         usedNames.insert( pad->GetName() );
     }
 
     return usedNames.size();
 }

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

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), and FOOTPRINT_INFO_IMPL::load().

◆ GetValue()

const wxString FOOTPRINT::GetValue ( ) const

inline

Function GetValue.

Returns: const wxString& - the value text.

Definition at line 467 of file footprint.h.

     {
         return m_value->GetText();
     }

Referenced by CreateDevicesSection(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), PCB_EDIT_FRAME::ExchangeFootprint(), FOOTPRINT_DESC::FOOTPRINT_DESC(), DSN::SPECCTRA_DB::FromBOARD(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), EAGLE_PLUGIN::loadElements(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), CLIPBOARD_IO::SaveSelection(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 97 of file board_item.h.

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

References EDA_ITEM::GetPosition().

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 103 of file board_item.h.

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

References EDA_ITEM::GetPosition().

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

◆ GetZoneConnection()

ZONE_CONNECTION FOOTPRINT::GetZoneConnection ( ) const

inline

Definition at line 241 of file footprint.h.

241 { return m_zoneConnection; }

FOOTPRINT::m_zoneConnection

ZONE_CONNECTION m_zoneConnection

Definition: footprint.h:720

Referenced by PCB_IO::format(), PAD::GetEffectiveZoneConnection(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ GetZoneSettings()

virtual const ZONE_SETTINGS& BOARD_ITEM_CONTAINER::GetZoneSettings ( ) const

inlinevirtualinherited

Fetch the zone settings for this container.

Reimplemented in BOARD.

Definition at line 83 of file board_item_container.h.

     {
         return m_zoneSettings;
     }

References BOARD_ITEM_CONTAINER::m_zoneSettings.

Referenced by ZONE::ZONE().

◆ GraphicalItems() [1/2]

DRAWINGS& FOOTPRINT::GraphicalItems ( )

inline

Definition at line 185 of file footprint.h.

185 { return m_drawings; }

FOOTPRINT::m_drawings

DRAWINGS m_drawings

Definition: footprint.h:706

Referenced by BOARD_ADAPTER::addFootprintShapesWithClearance(), BuildPolyCourtyards(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_footprint(), FOOTPRINT(), FootprintWriteShape(), PCB_IO::format(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), GetEffectiveShape(), getMatchingTextItem(), hash_fp_item(), hashFootprint(), ROUTER_TOOL::InlineDrag(), MoveAnchorPosition(), operator=(), pasteFootprintItemsToFootprintEditor(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BOARD_EDITOR_CONTROL::RepairBoard(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), PCB_SELECTION_TOOL::Selectable(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolygon(), and TransformFPShapesWithClearanceToPolygon().

◆ GraphicalItems() [2/2]

const DRAWINGS& FOOTPRINT::GraphicalItems ( ) const

inline

Definition at line 186 of file footprint.h.

186 { return m_drawings; }

FOOTPRINT::m_drawings

DRAWINGS m_drawings

Definition: footprint.h:706

◆ Groups() [1/2]

FP_GROUPS& FOOTPRINT::Groups ( )

inline

Definition at line 191 of file footprint.h.

191 { return m_fp_groups; }

FOOTPRINT::m_fp_groups

FP_GROUPS m_fp_groups

Definition: footprint.h:709

Referenced by FOOTPRINT(), PCB_IO::format(), operator=(), pasteFootprintItemsToFootprintEditor(), and BOARD_EDITOR_CONTROL::RepairBoard().

◆ Groups() [2/2]

const FP_GROUPS& FOOTPRINT::Groups ( ) const

inline

Definition at line 192 of file footprint.h.

192 { return m_fp_groups; }

FOOTPRINT::m_fp_groups

FP_GROUPS m_fp_groups

Definition: footprint.h:709

◆ HasFlag()

bool EDA_ITEM::HasFlag ( STATUS_FLAGS aFlag ) const

inlineinherited

Definition at line 204 of file eda_item.h.

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

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References EDA_ITEM::m_flags.

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

◆ HasThroughHolePads()

bool FOOTPRINT::HasThroughHolePads ( ) const

Definition at line 1851 of file footprint.cpp.

 {
     for( PAD* pad : Pads() )
     {
         if( pad->GetAttribute() != PAD_ATTRIB_SMD )
             return true;
     }
 
     return false;
 }

References PAD_ATTRIB_SMD, and Pads().

◆ HitTest() [1/2]

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

overridevirtual

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

Parameters

aPosition	A reference to a wxPoint object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns: True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 833 of file footprint.cpp.

 {
     EDA_RECT rect = m_boundingBox;//.GetBoundingBoxRotated( GetPosition(), m_Orient );
     return rect.Inflate( aAccuracy ).Contains( aPosition );
 }

References EDA_RECT::Contains(), EDA_RECT::Inflate(), and m_boundingBox.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ HitTest() [2/2]

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

overridevirtual

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

Parameters

aRect	A reference to a EDA_RECT object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 846 of file footprint.cpp.

 {
     EDA_RECT arect = aRect;
     arect.Inflate( aAccuracy );
 
     if( aContained )
         return arect.Contains( m_boundingBox );
     else
     {
         // If the rect does not intersect the bounding box, skip any tests
         if( !aRect.Intersects( GetBoundingBox() ) )
             return false;
 
         // Determine if any elements in the FOOTPRINT intersect the rect
         for( PAD* pad : m_pads )
         {
             if( pad->HitTest( arect, false, 0 ) )
                 return true;
         }
 
         for( FP_ZONE* zone : m_fp_zones )
         {
             if( zone->HitTest( arect, false, 0 ) )
                 return true;
         }
 
         for( BOARD_ITEM* item : m_drawings )
         {
             if( item->HitTest( arect, false, 0 ) )
                 return true;
         }
 
         // Groups are not hit-tested; only their members
 
         // No items were hit
         return false;
     }
 }

References EDA_RECT::Contains(), GetBoundingBox(), EDA_RECT::Inflate(), EDA_RECT::Intersects(), m_boundingBox, m_drawings, m_fp_zones, and m_pads.

◆ HitTestAccurate()

bool FOOTPRINT::HitTestAccurate	(	const wxPoint &	aPosition,
		int	aAccuracy = `0`
	)		const

Tests if a point is inside the bounding polygon of the footprint.

The other hit test methods are just checking the bounding box, which can be quite inaccurate for rotated or oddly-shaped footprints.

Parameters

aPosition is the point to test

Returns: true if aPosition is inside the bounding polygon

Definition at line 840 of file footprint.cpp.

 {
     return GetBoundingHull().Collide( aPosition, aAccuracy );
 }

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

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IncrementFlag()

void FOOTPRINT::IncrementFlag ( )

inline

Definition at line 253 of file footprint.h.

253 { m_arflag += 1; }

FOOTPRINT::m_arflag

int m_arflag

Definition: footprint.h:732

◆ IncrementReference()

void FOOTPRINT::IncrementReference ( int aDelta )

Function IncrementReference Bumps the current reference by aDelta.

Definition at line 1617 of file footprint.cpp.

 {
     const wxString& refdes = GetReference();
 
     SetReference( wxString::Format( wxT( "%s%i" ),
                   UTIL::GetReferencePrefix( refdes ),
                   GetTrailingInt( refdes ) + aDelta ) );
 }

References Format(), GetReference(), UTIL::GetReferencePrefix(), GetTrailingInt(), and SetReference().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 174 of file eda_item.h.

174 { return m_flags & BRIGHTENED; }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:129

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented in ZONE, and BOARD_CONNECTED_ITEM.

Definition at line 136 of file board_item.h.

     {
         return false;
     }

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), DRC_ENGINE::EvalRulesForItems(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), PCB_EXPR_NETCLASS_REF::GetValue(), PCB_EXPR_NETNAME_REF::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), isDiffPair(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 169 of file eda_item.h.

169 { return m_flags & IS_DRAGGED; }

IS_DRAGGED

#define IS_DRAGGED

Item being dragged.

Definition: eda_item.h:108

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References IS_DRAGGED, and EDA_ITEM::m_flags.

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

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 172 of file eda_item.h.

172 { return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item.h:136

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsFlipped()

bool FOOTPRINT::IsFlipped ( ) const

inline

function IsFlipped

Returns: true if the footprint is flipped, i.e. on the back side of the board

Definition at line 282 of file footprint.h.

282 { return GetLayer() == B_Cu; }

B_Cu

Definition: layers_id_colors_and_visibility.h:106

BOARD_ITEM::GetLayer

virtual PCB_LAYER_ID GetLayer() const

Return the primary layer this item is on.

Definition: board_item.h:173

References B_Cu, and GetLayer().

Referenced by PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), GetMsgPanelInfo(), DIALOG_PAD_PROPERTIES::initValues(), ALTIUM_PCB::ParseComponentsBodies6Data(), BOARD_EDITOR_CONTROL::PlaceModule(), RENDER_3D_LEGACY::renderFootprint(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 254 of file eda_item.h.

254 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:528

References EDA_ITEM::m_forceVisible.

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

◆ IsLibNameValid()

bool FOOTPRINT::IsLibNameValid ( const wxString & aName )

static

static function IsLibNameValid Test for validity of a name of a footprint to be used in a footprint library ( no spaces, dir separators ...

)

Parameters

aName = the name in library to validate

Returns: true if the given name is valid

Definition at line 1242 of file footprint.cpp.

 {
     const wxChar * invalids = StringLibNameInvalidChars( false );
 
     if( aName.find_first_of( invalids ) != std::string::npos )
         return false;
 
     return true;
 }

References StringLibNameInvalidChars().

Referenced by DIALOG_FOOTPRINT_FP_EDITOR::checkFootprintName().

◆ IsLocked()

bool FOOTPRINT::IsLocked ( ) const

inlineoverridevirtual

Returns: true if the object is locked, else false.

Reimplemented from BOARD_ITEM.

Definition at line 298 of file footprint.h.

     {
         return ( m_fpStatus & FP_is_LOCKED ) != 0;
     }

References FP_is_LOCKED.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), PCB_IO::format(), GetMsgPanelInfo(), itemIsIncludedByFilter(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 166 of file eda_item.h.

166 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item.h:102

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 168 of file eda_item.h.

168 { return m_flags & IS_MOVED; }

IS_MOVED

#define IS_MOVED

Item being moved.

Definition: eda_item.h:105

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References IS_MOVED, and EDA_ITEM::m_flags.

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

◆ IsNetTie()

bool FOOTPRINT::IsNetTie ( ) const

inline

Definition at line 257 of file footprint.h.

257 { return GetKeywords().StartsWith( wxT( "net tie" ) ); }

FOOTPRINT::GetKeywords

const wxString & GetKeywords() const

Definition: footprint.h:214

Referenced by DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 167 of file eda_item.h.

167 { return m_flags & IS_NEW; }

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item.h:106

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

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

Reimplemented in TRACK, PAD, and ZONE.

Definition at line 144 of file board_item.h.

     {
         return IsCopperLayer( GetLayer() );
     }

References BOARD_ITEM::GetLayer(), and IsCopperLayer().

Referenced by CN_CONNECTIVITY_ALGO::Add(), DRC_ENGINE::EvalRulesForItems(), and BOARD_CONNECTED_ITEM::SetNetCode().

◆ IsOnLayer()

bool FOOTPRINT::IsOnLayer ( PCB_LAYER_ID aLayer ) const

overridevirtual

A special IsOnLayer for footprints: return true if the footprint contains only items on the given layer, even if that layer is not one of the valid footprint layers F_Cu and B_Cu.

This allows selection of "graphic" footprints that contain only silkscreen, for example.

Reimplemented from BOARD_ITEM.

Definition at line 810 of file footprint.cpp.

 {
     // If we have any pads, fall back on normal checking
     if( !m_pads.empty() )
         return m_layer == aLayer;
 
     // No pads?  Check if this entire footprint exists on the given layer
     for( FP_ZONE* zone : m_fp_zones )
     {
         if( !zone->IsOnLayer( aLayer ) )
             return false;
     }
 
     for( BOARD_ITEM* item : m_drawings )
     {
         if( !item->IsOnLayer( aLayer ) )
             return false;
     }
 
     return true;
 }

References m_drawings, m_fp_zones, BOARD_ITEM::m_layer, and m_pads.

◆ IsPlaced()

bool FOOTPRINT::IsPlaced ( ) const

inline

Definition at line 316 of file footprint.h.

316 { return m_fpStatus & FP_is_PLACED; }

FOOTPRINT::m_fpStatus

int m_fpStatus

Definition: footprint.h:717

FP_is_PLACED

#define FP_is_PLACED

In autoplace: footprint automatically placed.

Definition: footprint.h:293

References FP_is_PLACED.

Referenced by PCB_IO::format().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 451 of file eda_item.h.

451 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 173 of file eda_item.h.

173 { return m_flags & IS_RESIZED; }

IS_RESIZED

#define IS_RESIZED

Item being resized.

Definition: eda_item.h:107

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References IS_RESIZED, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 171 of file eda_item.h.

171 { return m_flags & SELECTED; }

SELECTED

#define SELECTED

Definition: eda_item.h:113

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References EDA_ITEM::m_flags, and SELECTED.

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

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const

inlineinherited

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

Returns: true if a track or via, else false.

Definition at line 241 of file board_item.h.

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

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

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T aScanTypes[] ) const

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented in VIA, SCH_LABEL, DIMENSION_BASE, PAD, PCB_SHAPE, SCH_FIELD, SCH_LINE, FP_TEXT, FP_SHAPE, and PCB_TEXT.

Definition at line 231 of file eda_item.h.

     {
         if( aScanTypes[0] == SCH_LOCATE_ANY_T )
             return true;
 
         for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
         {
             if( m_structType == *p )
                 return true;
         }
 
         return false;
     }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), FP_TEXT::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), PCB_SHAPE::IsType(), PAD::IsType(), DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 170 of file eda_item.h.

170 { return m_flags & IS_WIRE_IMAGE; }

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item.h:110

EDA_ITEM::m_flags

STATUS_FLAGS m_flags

Definition: eda_item.h:529

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 343 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 362 of file eda_item.h.

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

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

The BOARD is needed because layer names are customizable.

Reimplemented in VIA.

Definition at line 72 of file board_item.cpp.

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

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

Referenced by TRACK::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), and PAD::GetSelectMenuText().

◆ LegacyPadsLocked()

bool FOOTPRINT::LegacyPadsLocked ( ) const

inline

Definition at line 334 of file footprint.h.

334 { return m_fpStatus & FP_PADS_are_LOCKED; }

FP_PADS_are_LOCKED

#define FP_PADS_are_LOCKED

Definition: footprint.h:295

FOOTPRINT::m_fpStatus

int m_fpStatus

Definition: footprint.h:717

References FP_PADS_are_LOCKED.

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 413 of file eda_item.h.

     {
         return false;
     }

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 132 of file eda_item.cpp.

 {
     wxString text = aText;
     wxString searchText = aSearchData.GetFindString();
 
     // Don't match if searching for replaceable item and the item doesn't support text replace.
     if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
         return false;
 
     if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
         return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
 
     if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
     {
         if( aSearchData.GetFlags() & wxFR_MATCHCASE )
             return text.Matches( searchText );
 
         return text.MakeUpper().Matches( searchText.MakeUpper() );
     }
 
     if( aSearchData.GetFlags() & wxFR_MATCHCASE )
         return aText.Find( searchText ) != wxNOT_FOUND;
 
     return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
 }

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

◆ Models() [1/2]

std::list<FP_3DMODEL>& FOOTPRINT::Models ( )

inline

Definition at line 196 of file footprint.h.

196 { return m_3D_Drawings; }

FOOTPRINT::m_3D_Drawings

std::list< FP_3DMODEL > m_3D_Drawings

Definition: footprint.h:737

Referenced by PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_footprint(), PCB_IO::format(), idf_export_footprint(), LEGACY_PLUGIN::load3D(), ALTIUM_PCB::ParseComponentsBodies6Data(), RENDER_3D_LEGACY::renderFootprint(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and PANEL_PREV_3D::UpdateDummyFootprint().

◆ Models() [2/2]

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

inline

Definition at line 197 of file footprint.h.

197 { return m_3D_Drawings; }

FOOTPRINT::m_3D_Drawings

std::list< FP_3DMODEL > m_3D_Drawings

Definition: footprint.h:737

◆ Move() [1/2]

void FOOTPRINT::Move ( const wxPoint & aMoveVector )

overridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 1268 of file footprint.cpp.

 {
     wxPoint newpos = m_pos + aMoveVector;
     SetPosition( newpos );
 }

References m_pos, and SetPosition().

Referenced by moveFootprintsInArea().

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I & aMoveVector )

inlineinherited

Definition at line 283 of file board_item.h.

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

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

◆ MoveAnchorPosition()

void FOOTPRINT::MoveAnchorPosition ( const wxPoint & aMoveVector )

Function MoveAnchorPosition Move the reference point of the footprint It looks like a move footprint: the footprints elements (pads, outlines, edges .

. ) are moved However:

the footprint position is not modified.
the relative (local) coordinates of these items are modified (a move footprint does not change these local coordinates, but changes the footprint position)

Definition at line 1405 of file footprint.cpp.

 {
     /* Move the reference point of the footprint
      * the footprints elements (pads, outlines, edges .. ) are moved
      * but:
      * - the footprint position is not modified.
      * - the relative (local) coordinates of these items are modified
      * - Draw coordinates are updated
      */
 
 
     // Update (move) the relative coordinates relative to the new anchor point.
     wxPoint moveVector = aMoveVector;
     RotatePoint( &moveVector, -GetOrientation() );
 
     // Update of the reference and value.
     m_reference->SetPos0( m_reference->GetPos0() + moveVector );
     m_reference->SetDrawCoord();
     m_value->SetPos0( m_value->GetPos0() + moveVector );
     m_value->SetDrawCoord();
 
     // Update the pad local coordinates.
     for( PAD* pad : m_pads )
     {
         pad->SetPos0( pad->GetPos0() + moveVector );
         pad->SetDrawCoord();
     }
 
     // Update the draw element coordinates.
     for( BOARD_ITEM* item : GraphicalItems() )
     {
         switch( item->Type() )
         {
         case PCB_FP_SHAPE_T:
             {
             FP_SHAPE* shape = static_cast<FP_SHAPE*>( item );
                 shape->Move( moveVector );
             }
             break;
 
         case PCB_FP_TEXT_T:
             {
             FP_TEXT* text = static_cast<FP_TEXT*>( item );
             text->SetPos0( text->GetPos0() + moveVector );
             text->SetDrawCoord();
             }
             break;
 
         default:
             break;
         }
     }
 
     CalculateBoundingBox();
 }

References CalculateBoundingBox(), GetOrientation(), FP_TEXT::GetPos0(), GraphicalItems(), m_pads, m_reference, m_value, FP_SHAPE::Move(), PCB_FP_SHAPE_T, PCB_FP_TEXT_T, RotatePoint(), FP_TEXT::SetDrawCoord(), and FP_TEXT::SetPos0().

Referenced by CLIPBOARD_IO::SaveSelection(), and DRAWING_TOOL::SetAnchor().

◆ NeedsPlaced()

bool FOOTPRINT::NeedsPlaced ( ) const

inline

Definition at line 325 of file footprint.h.

325 { return m_fpStatus & FP_to_PLACE; }

FOOTPRINT::m_fpStatus

int m_fpStatus

Definition: footprint.h:717

FP_to_PLACE

#define FP_to_PLACE

In autoplace: footprint waiting for autoplace.

Definition: footprint.h:294

References FP_to_PLACE.

Referenced by AR_AUTOPLACER::pickFootprint().

◆ operator<()

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

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

Definition at line 185 of file eda_item.cpp.

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

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

◆ operator=() [1/2]

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

Definition at line 302 of file footprint.cpp.

 {
     BOARD_ITEM::operator=( aOther );
 
     m_pos           = aOther.m_pos;
     m_fpid          = aOther.m_fpid;
     m_attributes    = aOther.m_attributes;
     m_fpStatus      = aOther.m_fpStatus;
     m_orient        = aOther.m_orient;
     m_boundingBox   = aOther.m_boundingBox;
     m_rot90Cost     = aOther.m_rot90Cost;
     m_rot180Cost    = aOther.m_rot180Cost;
     m_lastEditTime  = aOther.m_lastEditTime;
     m_link          = aOther.m_link;
     m_path          = aOther.m_path;
 
     m_localClearance                = aOther.m_localClearance;
     m_localSolderMaskMargin         = aOther.m_localSolderMaskMargin;
     m_localSolderPasteMargin        = aOther.m_localSolderPasteMargin;
     m_localSolderPasteMarginRatio   = aOther.m_localSolderPasteMarginRatio;
     m_zoneConnection                = aOther.m_zoneConnection;
     m_thermalWidth                  = aOther.m_thermalWidth;
     m_thermalGap                    = aOther.m_thermalGap;
 
     // Copy reference and value
     *m_reference = *aOther.m_reference;
     m_reference->SetParent( this );
     *m_value = *aOther.m_value;
     m_value->SetParent( this );
 
     std::map<BOARD_ITEM*, BOARD_ITEM*> ptrMap;
 
     // Copy pads
     m_pads.clear();
 
     for( PAD* pad : aOther.Pads() )
     {
         PAD* newPad = new PAD( *pad );
         ptrMap[ pad ] = newPad;
         Add( newPad );
     }
 
     // Copy zones
     m_fp_zones.clear();
 
     for( FP_ZONE* zone : aOther.Zones() )
     {
         FP_ZONE* newZone = static_cast<FP_ZONE*>( zone->Clone() );
         ptrMap[ zone ] = newZone;
         Add( newZone );
 
         // Ensure the net info is OK and especially uses the net info list
         // living in the current board
         // Needed when copying a fp from fp editor that has its own board
         // Must be NETINFO_LIST::ORPHANED_ITEM for a keepout that has no net.
         newZone->SetNetCode( -1 );
     }
 
     // Copy drawings
     m_drawings.clear();
 
     for( BOARD_ITEM* item : aOther.GraphicalItems() )
     {
         BOARD_ITEM* newItem = static_cast<BOARD_ITEM*>( item->Clone() );
         ptrMap[ item ] = newItem;
         Add( newItem );
     }
 
     // Copy groups
     m_fp_groups.clear();
 
     for( PCB_GROUP* group : aOther.Groups() )
     {
         PCB_GROUP* newGroup = static_cast<PCB_GROUP*>( group->Clone() );
         const_cast<std::unordered_set<BOARD_ITEM*>*>( &newGroup->GetItems() )->clear();
 
         for( BOARD_ITEM* member : group->GetItems() )
             newGroup->AddItem( ptrMap[ member ] );
 
         Add( newGroup );
     }
 
     // Copy auxiliary data: 3D_Drawings info
     m_3D_Drawings.clear();
     m_3D_Drawings = aOther.m_3D_Drawings;
     m_doc         = aOther.m_doc;
     m_keywords     = aOther.m_keywords;
     m_properties  = aOther.m_properties;
 
     // Ensure auxiliary data is up to date
     CalculateBoundingBox();
 
     m_initial_comments = aOther.m_initial_comments ?
                             new wxArrayString( *aOther.m_initial_comments ) : nullptr;
 
     return *this;
 }

References Add(), PCB_GROUP::AddItem(), CalculateBoundingBox(), PCB_GROUP::GetItems(), GraphicalItems(), Groups(), m_3D_Drawings, m_attributes, m_boundingBox, m_doc, m_drawings, m_fp_groups, m_fp_zones, m_fpid, m_fpStatus, m_initial_comments, m_keywords, m_lastEditTime, m_link, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_orient, m_pads, m_path, m_pos, m_properties, m_reference, m_rot180Cost, m_rot90Cost, m_thermalGap, m_thermalWidth, m_value, m_zoneConnection, EDA_ITEM::operator=(), PAD, Pads(), BOARD_CONNECTED_ITEM::SetNetCode(), EDA_ITEM::SetParent(), and Zones().

◆ operator=() [2/2]

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

Definition at line 207 of file footprint.cpp.

 {
     BOARD_ITEM::operator=( aOther );
 
     m_pos           = aOther.m_pos;
     m_fpid          = aOther.m_fpid;
     m_attributes    = aOther.m_attributes;
     m_fpStatus      = aOther.m_fpStatus;
     m_orient        = aOther.m_orient;
     m_boundingBox   = aOther.m_boundingBox;
     m_rot90Cost     = aOther.m_rot90Cost;
     m_rot180Cost    = aOther.m_rot180Cost;
     m_lastEditTime  = aOther.m_lastEditTime;
     m_link          = aOther.m_link;
     m_path          = aOther.m_path;
 
     m_localClearance                = aOther.m_localClearance;
     m_localSolderMaskMargin         = aOther.m_localSolderMaskMargin;
     m_localSolderPasteMargin        = aOther.m_localSolderPasteMargin;
     m_localSolderPasteMarginRatio   = aOther.m_localSolderPasteMarginRatio;
     m_zoneConnection                = aOther.m_zoneConnection;
     m_thermalWidth                  = aOther.m_thermalWidth;
     m_thermalGap                    = aOther.m_thermalGap;
 
     // Move reference and value
     m_reference = aOther.m_reference;
     m_reference->SetParent( this );
     m_value = aOther.m_value;
     m_value->SetParent( this );
 
 
     // Move the pads
     m_pads.clear();
 
     for( PAD* pad : aOther.Pads() )
         Add( pad );
 
     aOther.Pads().clear();
 
     // Move the zones
     m_fp_zones.clear();
 
     for( FP_ZONE* item : aOther.Zones() )
     {
         Add( item );
 
         // Ensure the net info is OK and especially uses the net info list
         // living in the current board
         // Needed when copying a fp from fp editor that has its own board
         // Must be NETINFO_LIST::ORPHANED_ITEM for a keepout that has no net.
         item->SetNetCode( -1 );
     }
 
     aOther.Zones().clear();
 
     // Move the drawings
     m_drawings.clear();
 
     for( BOARD_ITEM* item : aOther.GraphicalItems() )
         Add( item );
 
     aOther.GraphicalItems().clear();
 
     // Move the groups
     m_fp_groups.clear();
 
     for( PCB_GROUP* group : aOther.Groups() )
         Add( group );
 
     aOther.Groups().clear();
 
     // Copy auxiliary data: 3D_Drawings info
     m_3D_Drawings.clear();
     m_3D_Drawings = aOther.m_3D_Drawings;
     m_doc         = aOther.m_doc;
     m_keywords    = aOther.m_keywords;
     m_properties  = aOther.m_properties;
 
     // Ensure auxiliary data is up to date
     CalculateBoundingBox();
 
     m_initial_comments = aOther.m_initial_comments;
 
     // Clear the other item's containers since this is a move
     aOther.Pads().clear();
     aOther.Zones().clear();
     aOther.GraphicalItems().clear();
     aOther.m_value            = nullptr;
     aOther.m_reference        = nullptr;
     aOther.m_initial_comments = nullptr;
 
     return *this;
 }

References Add(), CalculateBoundingBox(), m_3D_Drawings, m_attributes, m_boundingBox, m_doc, m_drawings, m_fp_groups, m_fp_zones, m_fpid, m_fpStatus, m_initial_comments, m_keywords, m_lastEditTime, m_link, m_localClearance, m_localSolderMaskMargin, m_localSolderPasteMargin, m_localSolderPasteMarginRatio, m_orient, m_pads, m_path, m_pos, m_properties, m_reference, m_rot180Cost, m_rot90Cost, m_thermalGap, m_thermalWidth, m_value, m_zoneConnection, EDA_ITEM::operator=(), and EDA_ITEM::SetParent().

◆ Pads() [1/2]

PADS& FOOTPRINT::Pads ( )

inline

Definition at line 182 of file footprint.h.

182 { return m_pads; }

FOOTPRINT::m_pads

PADS m_pads

Definition: footprint.h:707

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), BOARD_ADAPTER::addPadsWithClearance(), allPadsLocked(), ARRAY_PAD_NAME_PROVIDER::ARRAY_PAD_NAME_PROVIDER(), AR_AUTOPLACER::buildFpAreas(), PCB_GRID_HELPER::computeAnchors(), AR_AUTOPLACER::computePlacementRatsnestCost(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createPolygonShape(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_footprint(), PLACEFILE_GERBER_WRITER::findPads1(), FOOTPRINT(), PCB_IO::format(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), GetEffectiveShape(), AR_AUTOPLACER::getOptimalFPPlacement(), CONNECTIVITY_DATA::GetRatsnestForComponent(), CONNECTIVITY_DATA::GetRatsnestForItems(), hash_fp_item(), hashFootprint(), HasThroughHolePads(), idf_export_footprint(), ROUTER_TOOL::InlineDrag(), isCopperOutside(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponents(), EAGLE_PLUGIN::loadElements(), CADSTAR_PCB_ARCHIVE_LOADER::loadNets(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), operator=(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceModule(), BOARD_EDITOR_CONTROL::RepairBoard(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllItemsOnSheet(), DRC_TEST_PROVIDER_LVS::testFootprints(), DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and BOARD_NETLIST_UPDATER::updateComponentPadConnections().

◆ Pads() [2/2]

const PADS& FOOTPRINT::Pads ( ) const

inline

Definition at line 183 of file footprint.h.

183 { return m_pads; }

FOOTPRINT::m_pads

PADS m_pads

Definition: footprint.h:707

◆ Reference() [1/2]

FP_TEXT& FOOTPRINT::Reference ( )

inline

Definition at line 483 of file footprint.h.

483 { return *m_reference; }

FOOTPRINT::m_reference

FP_TEXT * m_reference

Definition: footprint.h:713

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), BOARD_ADAPTER::addFootprintShapesWithClearance(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_footprint(), PCB_IO::format(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), idf_export_footprint(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineDrag(), EAGLE_PLUGIN::loadElements(), LEGACY_PLUGIN::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::orientFootprintAndText(), EAGLE_PLUGIN::packageText(), ALTIUM_PCB::ParseComponents6Data(), ALTIUM_PCB::ParseTexts6Data(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BOARD_EDITOR_CONTROL::RepairBoard(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and TransformFPShapesWithClearanceToPolygon().

◆ Reference() [2/2]

FP_TEXT& FOOTPRINT::Reference ( ) const

inline

Definition at line 487 of file footprint.h.

487 { return *m_reference; }

FOOTPRINT::m_reference

FP_TEXT * m_reference

Definition: footprint.h:713

◆ Remove()

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

overridevirtual

Implements BOARD_ITEM_CONTAINER.

Definition at line 498 of file footprint.cpp.

 {
     switch( aBoardItem->Type() )
     {
     case PCB_FP_TEXT_T:
         // Only user text can be removed this way.
         wxCHECK_RET(
                 static_cast<FP_TEXT*>( aBoardItem )->GetType() == FP_TEXT::TEXT_is_DIVERS,
                 "Please report this bug: Invalid remove operation on required text" );
         KI_FALLTHROUGH;
 
     case PCB_FP_SHAPE_T:
         for( auto it = m_drawings.begin(); it != m_drawings.end(); ++it )
         {
             if( *it == aBoardItem )
             {
                 m_drawings.erase( it );
                 break;
             }
         }
 
         break;
 
     case PCB_PAD_T:
         for( auto it = m_pads.begin(); it != m_pads.end(); ++it )
         {
             if( *it == static_cast<PAD*>( aBoardItem ) )
             {
                 m_pads.erase( it );
                 break;
             }
         }
 
         break;
 
     case PCB_FP_ZONE_T:
         for( auto it = m_fp_zones.begin(); it != m_fp_zones.end(); ++it )
         {
             if( *it == static_cast<FP_ZONE*>( aBoardItem ) )
             {
                 m_fp_zones.erase( it );
                 break;
             }
         }
 
         break;
 
     case PCB_GROUP_T:
         for( auto it = m_fp_groups.begin(); it != m_fp_groups.end(); ++it )
         {
             if( *it == static_cast<PCB_GROUP*>( aBoardItem ) )
             {
                 m_fp_groups.erase( it );
                 break;
             }
         }
 
         break;
 
     default:
     {
         wxString msg;
         msg.Printf( wxT( "FOOTPRINT::Remove() needs work: BOARD_ITEM type (%d) not handled" ),
                     aBoardItem->Type() );
         wxFAIL_MSG( msg );
     }
     }
 }

References KI_FALLTHROUGH, m_drawings, m_fp_groups, m_fp_zones, m_pads, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, FP_TEXT::TEXT_is_DIVERS, and EDA_ITEM::Type().

Referenced by BOARD_COMMIT::Push(), EDIT_TOOL::Remove(), and GROUP_TOOL::Ungroup().

◆ Replace() [1/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 159 of file eda_item.cpp.

 {
     wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
 
     int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
                                     aSearchData.GetFindString() :
                                     aSearchData.GetFindString().Upper() );
 
     if( result == wxNOT_FOUND )
         return false;
 
     wxString prefix = aText.Left( result );
     wxString suffix;
 
     if( aSearchData.GetFindString().length() + result < aText.length() )
         suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
 
     wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                 aText, prefix, aSearchData.GetReplaceString(), suffix );
 
     aText = prefix + aSearchData.GetReplaceString() + suffix;
 
     return true;
 }

References traceFindReplace.

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

◆ Replace() [2/2]

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

inlinevirtualinherited

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

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

Parameters

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

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

Reimplemented in SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, and SCH_PIN.

Definition at line 440 of file eda_item.h.

     {
         return false;
     }

◆ ResolveTextVar()

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

Resolve any references to system tokens supported by the component.

Parameters

aDepth a counter to limit recursion and circular references.

Definition at line 409 of file footprint.cpp.

 {
     if( token->IsSameAs( wxT( "REFERENCE" ) ) )
     {
         *token = m_reference->GetShownText( aDepth + 1 );
         return true;
     }
     else if( token->IsSameAs( wxT( "VALUE" ) ) )
     {
         *token = m_value->GetShownText( aDepth + 1 );
         return true;
     }
     else if( token->IsSameAs( wxT( "LAYER" ) ) )
     {
         *token = GetLayerName();
         return true;
     }
     else if( m_properties.count( *token ) )
     {
         *token = m_properties.at( *token );
         return true;
     }
 
     return false;
 }

References BOARD_ITEM::GetLayerName(), FP_TEXT::GetShownText(), m_properties, m_reference, and m_value.

Referenced by PCB_TEXT::GetShownText(), and FP_TEXT::GetShownText().

◆ Rotate() [1/2]

void FOOTPRINT::Rotate	(	const wxPoint &	aRotCentre,
		double	aAngle
	)

overridevirtual

Rotate this object.

Parameters

aRotCentre	the rotation point.
aAngle	the rotation angle in 0.1 degree.

Reimplemented from BOARD_ITEM.

Definition at line 1275 of file footprint.cpp.

 {
     double  orientation = GetOrientation();
     double  newOrientation = orientation + aAngle;
     wxPoint newpos = m_pos;
     RotatePoint( &newpos, aRotCentre, aAngle );
     SetPosition( newpos );
     SetOrientation( newOrientation );
 
     m_reference->KeepUpright( orientation, newOrientation );
     m_value->KeepUpright( orientation, newOrientation );
 
     for( BOARD_ITEM* item : m_drawings )
     {
         if( item->Type() == PCB_FP_TEXT_T )
             static_cast<FP_TEXT*>( item )->KeepUpright( orientation, newOrientation  );
     }
 
     CalculateBoundingBox();
 }

References CalculateBoundingBox(), GetOrientation(), FP_TEXT::KeepUpright(), m_drawings, m_pos, m_reference, m_value, PCB_FP_TEXT_T, RotatePoint(), SetOrientation(), and SetPosition().

Referenced by Flip(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Rotate() [2/2]

void BOARD_ITEM::Rotate	(	const VECTOR2I &	aRotCentre,
		double	aAngle
	)

inlineinherited

Definition at line 299 of file board_item.h.

     {
         Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
     }

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

◆ RunOnChildren()

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

Function RunOnChildren.

Invokes a function on all BOARD_ITEMs that belong to the footprint (pads, drawings, texts). Note that this function should not add or remove items to the footprint

Parameters

aFunction is the function to be invoked.

Definition at line 1104 of file footprint.cpp.

1105

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FOOTPRINT() [1/3]

◆ FOOTPRINT() [2/3]

◆ FOOTPRINT() [3/3]

◆ ~FOOTPRINT()

Member Function Documentation

◆ Add()

◆ Add3DModel()

◆ BuildPolyCourtyards()

◆ CalculateBoundingBox()

◆ ClassOf()

◆ ClearAllNets()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ CoverageRatio()

◆ Delete()

◆ DeleteStructure()

◆ Duplicate()

◆ DuplicateItem()

◆ FindPadByName()

◆ Flip() [1/2]

◆ Flip() [2/2]

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAllDrawingLayers()

◆ GetArea()

◆ GetAttributes()

◆ GetBoard()

◆ GetBoundingBox() [1/2]

◆ GetBoundingBox() [2/2]

◆ GetBoundingBoxBase()

◆ GetBoundingHull()

◆ GetCenter()

◆ GetClass()

◆ GetContextualTextVars()

◆ GetCoverageArea()

◆ GetDescription()

◆ GetEditFlags()

◆ GetEffectiveShape()

◆ GetFirstPad()

◆ GetFlag()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFootprintRect()

◆ GetFPID()

◆ GetFpPadsLocalBbox()

◆ GetInitialComments()

◆ GetKeywords()

◆ GetLastEditTime()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetLink()

◆ GetLocalClearance() [1/2]

◆ GetLocalClearance() [2/2]

◆ GetLocalSolderMaskMargin()

◆ GetLocalSolderPasteMargin()

◆ GetLocalSolderPasteMarginRatio()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetNextPadName()

◆ GetOrientation()

◆ GetOrientationDegrees()

◆ GetOrientationRadians()

◆ GetPad()