Information pertinent to a Pcbnew printed circuit board. More...

#include <board.h>

Inheritance diagram for BOARD:

Classes
struct	cmp_drawings

struct	cmp_items

struct	GroupLegalOpsField

Public Member Functions
void	SetBoardUse (BOARD_USE aUse)
	Set what the board is going to be used for. More...

BOARD_USE	GetBoardUse () const
	Get what the board use is. More...

void	IncrementTimeStamp ()

int	GetTimeStamp () const

bool	IsFootprintHolder () const
	Find out if the board is being used to hold a single footprint for editing/viewing. More...

void	SetFileName (const wxString &aFileName)

const wxString &	GetFileName () const

TRACKS &	Tracks ()

const TRACKS &	Tracks () const

FOOTPRINTS &	Footprints ()

const FOOTPRINTS &	Footprints () const

DRAWINGS &	Drawings ()

const DRAWINGS &	Drawings () const

ZONES &	Zones ()

const ZONES &	Zones () const

MARKERS &	Markers ()

const MARKERS &	Markers () const

GROUPS &	Groups ()
	The groups must maintain the following invariants. More...

const GROUPS &	Groups () const

const std::vector< BOARD_CONNECTED_ITEM * >	AllConnectedItems ()

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

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

bool	ResolveTextVar (wxString *token, int aDepth) const

	BOARD ()

	~BOARD ()

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPos) override

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

bool	IsEmpty () const

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

void	SetFileFormatVersionAtLoad (int aVersion)

int	GetFileFormatVersionAtLoad () const

void	SetGenerator (const wxString &aGenerator)

const wxString &	GetGenerator () const
	Adds an item to the container. More...

void	Add (BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
	Removes an item from the container. More...

void	Remove (BOARD_ITEM *aBoardItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
	Removes an item from the container. More...

void	FinalizeBulkAdd (std::vector< BOARD_ITEM * > &aNewItems)
	Must be used if Add() is used using a BULK_x ADD_MODE to generate a change event for listeners. More...

void	FinalizeBulkRemove (std::vector< BOARD_ITEM * > &aRemovedItems)
	Must be used if Remove() is used using a BULK_x REMOVE_MODE to generate a change event for listeners. More...

void	CacheTriangulation (PROGRESS_REPORTER aReporter=nullptr, const std::vector< ZONE > &aZones={})

FOOTPRINT *	GetFirstFootprint () const
	Get the first footprint on the board or nullptr. More...

void	DeleteAllFootprints ()
	Remove all footprints from the deque and free the memory associated with them. More...

BOARD_ITEM *	GetItem (const KIID &aID) const

void	FillItemMap (std::map< KIID, EDA_ITEM * > &aMap)

wxString	ConvertCrossReferencesToKIIDs (const wxString &aSource) const
	Convert cross-references back and forth between ${refDes:field} and ${kiid:field}. More...

wxString	ConvertKIIDsToCrossReferences (const wxString &aSource) const

std::shared_ptr< CONNECTIVITY_DATA >	GetConnectivity () const
	Return a list of missing connections between components/tracks. More...

bool	BuildConnectivity (PROGRESS_REPORTER *aReporter=nullptr)
	Build or rebuild the board connectivity database for the board, especially the list of connected items, list of nets and rastnest data Needed after loading a board to have the connectivity database updated. More...

void	DeleteMARKERs ()
	Delete all MARKERS from the board. More...

void	DeleteMARKERs (bool aWarningsAndErrors, bool aExclusions)

PROJECT *	GetProject () const

void	SetProject (PROJECT *aProject, bool aReferenceOnly=false)
	Link a board to a given project. More...

void	ClearProject ()

std::vector< PCB_MARKER * >	ResolveDRCExclusions ()
	Rebuild DRC markers from the serialized data in BOARD_DESIGN_SETTINGS. More...

void	UpdateRatsnestExclusions ()
	Update the visibility flags on the current unconnected ratsnest lines. More...

void	ResetNetHighLight ()
	Reset all high light data to the init state. More...

const std::set< int > &	GetHighLightNetCodes () const

void	SetHighLightNet (int aNetCode, bool aMulti=false)
	Select the netcode to be highlighted. More...

bool	IsHighLightNetON () const

void	HighLightON (bool aValue=true)
	Enable or disable net highlighting. More...

void	HighLightOFF ()
	Disable net highlight. More...

int	GetCopperLayerCount () const

void	SetCopperLayerCount (int aCount)

int	LayerDepth (PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer) const

LSET	GetEnabledLayers () const
	A proxy function that calls the corresponding function in m_BoardSettings. More...

void	SetEnabledLayers (LSET aLayerMask)
	A proxy function that calls the correspondent function in m_BoardSettings. More...

bool	IsLayerEnabled (PCB_LAYER_ID aLayer) const
	A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer is enabled. More...

bool	IsLayerVisible (PCB_LAYER_ID aLayer) const
	A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer is visible. More...

LSET	GetVisibleLayers () const
	A proxy function that calls the correspondent function in m_BoardSettings. More...

void	SetVisibleLayers (LSET aLayerMask)
	A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of visible layers. More...

GAL_SET	GetVisibleElements () const
	Return a set of all the element categories that are visible. More...

void	SetVisibleElements (const GAL_SET &aMask)
	A proxy function that calls the correspondent function in m_BoardSettings. More...

void	SetVisibleAlls ()
	Change the bit-mask of visible element categories and layers. More...

bool	IsElementVisible (GAL_LAYER_ID aLayer) const
	Test whether a given element category is visible. More...

void	SetElementVisibility (GAL_LAYER_ID aLayer, bool aNewState)
	Change the visibility of an element category. More...

bool	IsFootprintLayerVisible (PCB_LAYER_ID aLayer) const
	Expect either of the two layers on which a footprint can reside, and returns whether that layer is visible. More...

BOARD_DESIGN_SETTINGS &	GetDesignSettings () const

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

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

bool	GetTentVias () const

void	SetTentVias (bool aFlag)

const PAGE_INFO &	GetPageSettings () const

void	SetPageSettings (const PAGE_INFO &aPageSettings)

const PCB_PLOT_PARAMS &	GetPlotOptions () const

void	SetPlotOptions (const PCB_PLOT_PARAMS &aOptions)

TITLE_BLOCK &	GetTitleBlock ()

const TITLE_BLOCK &	GetTitleBlock () const

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock)

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

bool	GetBoardPolygonOutlines (SHAPE_POLY_SET &aOutlines, OUTLINE_ERROR_HANDLER *aErrorHandler=nullptr)
	Extract the board outlines and build a closed polygon from lines, arcs and circle items on edge cut layer. More...

void	ConvertBrdLayerToPolygonalContours (PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aOutlines) const
	Build a set of polygons which are the outlines of copper items (pads, tracks, vias, texts, zones). More...

const PCB_LAYER_ID	GetLayerID (const wxString &aLayerName) const
	Return the ID of a layer. More...

const wxString	GetLayerName (PCB_LAYER_ID aLayer) const
	Return the name of a aLayer. More...

bool	SetLayerName (PCB_LAYER_ID aLayer, const wxString &aLayerName)
	Changes the name of the layer given by aLayer. More...

bool	SetLayerDescr (PCB_LAYER_ID aIndex, const LAYER &aLayer)
	Return the type of the copper layer given by aLayer. More...

LAYER_T	GetLayerType (PCB_LAYER_ID aLayer) const
	Return the type of the copper layer given by aLayer. More...

bool	SetLayerType (PCB_LAYER_ID aLayer, LAYER_T aLayerType)
	Change the type of the layer given by aLayer. More...

unsigned	GetNodesCount (int aNet=-1) const

const std::vector< PAD * >	GetPads () const
	Return a reference to a list of all the pads. More...

void	BuildListOfNets ()

NETINFO_ITEM *	FindNet (int aNetcode) const
	Search for a net with the given netcode. More...

NETINFO_ITEM *	FindNet (const wxString &aNetname) const
	Search for a net with the given name. More...

const NETINFO_LIST &	GetNetInfo () const

NETINFO_LIST &	GetNetInfo ()

NETINFO_LIST::iterator	BeginNets () const

NETINFO_LIST::iterator	EndNets () const

unsigned	GetNetCount () const

BOX2I	ComputeBoundingBox (bool aBoardEdgesOnly=false) const
	Calculate the bounding box containing all board items (or board edge segments). More...

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

const BOX2I	GetBoardEdgesBoundingBox () const
	Return the board bounding box calculated using exclusively the board edges (graphics on Edge.Cuts layer). More...

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

INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< 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...

FOOTPRINT *	FindFootprintByReference (const wxString &aReference) const
	Search for a FOOTPRINT within this board with the given reference designator. More...

FOOTPRINT *	FindFootprintByPath (const KIID_PATH &aPath) const
	Search for a FOOTPRINT within this board with the given path. More...

std::set< wxString >	GetNetClassAssignmentCandidates () const
	Return the set of netname candidates for netclass assignment. More...

void	SynchronizeNetsAndNetClasses (bool aResetTrackAndViaSizes)
	Copy NETCLASS info to each NET, based on NET membership in a NETCLASS. More...

void	SynchronizeProperties ()
	Copy the current project's text variables into the boards property cache. More...

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

int	SetAreasNetCodesFromNetNames ()
	Set the .m_NetCode member of all copper areas, according to the area Net Name The SetNetCodesFromNetNames is an equivalent to net name, for fast comparisons. More...

ZONE *	GetArea (int index) const
	Return the Zone at a given index. More...

std::list< ZONE * >	GetZoneList (bool aIncludeZonesInFootprints=false) const

int	GetAreaCount () const

ZONE *	AddArea (PICKED_ITEMS_LIST *aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer, VECTOR2I aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch)
	Add an empty copper area to board areas list. More...

bool	TestZoneIntersection (ZONE aZone1, ZONE aZone2)
	Test for intersection of 2 copper areas. More...

PAD *	GetPad (const VECTOR2I &aPosition, LSET aLayerMask) const
	Find a pad aPosition on aLayer. More...

PAD *	GetPad (const VECTOR2I &aPosition) const

PAD *	GetPad (const PCB_TRACK *aTrace, ENDPOINT_T aEndPoint) const
	Find a pad connected to aEndPoint of aTrace. More...

PAD *	GetPadFast (const VECTOR2I &aPosition, LSET aLayerMask) const
	Return pad found at aPosition on aLayerMask using the fast search method. More...

PAD *	GetPad (std::vector< PAD * > &aPadList, const VECTOR2I &aPosition, LSET aLayerMask) const
	Locate the pad connected at aPosition on aLayer starting at list position aPad. More...

void	GetSortedPadListByXthenYCoord (std::vector< PAD * > &aVector, int aNetCode=-1) const
	First empties then fills the vector with all pads and sorts them by increasing x coordinate, and for increasing y coordinate for same values of x coordinates. More...

std::tuple< int, double, double >	GetTrackLength (const PCB_TRACK &aTrack) const
	Return data on the length and number of track segments connected to a given track. More...

TRACKS	TracksInNet (int aNetCode)
	Collect all the TRACKs and VIAs that are members of a net given by aNetCode. More...

FOOTPRINT *	GetFootprint (const VECTOR2I &aPosition, PCB_LAYER_ID aActiveLayer, bool aVisibleOnly, bool aIgnoreLocked=false) const
	Get a footprint by its bounding rectangle at aPosition on aLayer. More...

void	MapNets (const BOARD *aDestBoard)
	Map all nets in the given board to nets with the same name (if any) in the destination board. More...

void	SanitizeNetcodes ()

void	AddListener (BOARD_LISTENER *aListener)
	Add a listener to the board to receive calls whenever something on the board has been modified. More...

void	RemoveListener (BOARD_LISTENER *aListener)
	Remove the specified listener. More...

void	RemoveAllListeners ()
	Remove all listeners. More...

void	OnItemChanged (BOARD_ITEM *aItem)
	Notify the board and its listeners that an item on the board has been modified in some way. More...

void	OnItemsChanged (std::vector< BOARD_ITEM * > &aItems)
	Notify the board and its listeners that an item on the board has been modified in some way. More...

wxString	GroupsSanityCheck (bool repair=false)
	Consistency check of internal m_groups structure. More...

wxString	GroupsSanityCheckInternal (bool repair)

GroupLegalOpsField	GroupLegalOps (const PCB_SELECTION &selection) const
	Check which selection tool group operations are legal given the selection. More...

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

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

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

virtual bool	HasHole () const

virtual bool	IsTented () const

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

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

BOARD_ITEM_CONTAINER *	GetParent () const

BOARD_ITEM_CONTAINER *	GetParentFootprint () const

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

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

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

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

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)

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

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

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

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

virtual BOARD *	GetBoard ()

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

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

virtual void	TransformShapeToPolygon (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, 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	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

virtual bool	IsType (const std::vector< 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 wxString	GetFriendlyName () const

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

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

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

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

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

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

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

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

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

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

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)

static wxString	GetStandardLayerName (PCB_LAYER_ID aLayerId)
	Return an "English Standard" name of a PCB layer when given aLayerNumber. More...

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

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

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

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

Public Attributes
LSET	m_LegacyVisibleLayers
	Visibility settings stored in board prior to 6.0, only used for loading legacy files. More...

GAL_SET	m_LegacyVisibleItems

bool	m_LegacyDesignSettingsLoaded
	True if the legacy board design settings were loaded from a file. More...

bool	m_LegacyCopperEdgeClearanceLoaded

bool	m_LegacyNetclassesLoaded
	True if netclasses were loaded from the file. More...

std::mutex	m_CachesMutex

std::unordered_map< PTR_PTR_CACHE_KEY, bool >	m_IntersectsCourtyardCache

std::unordered_map< PTR_PTR_CACHE_KEY, bool >	m_IntersectsFCourtyardCache

std::unordered_map< PTR_PTR_CACHE_KEY, bool >	m_IntersectsBCourtyardCache

std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool >	m_IntersectsAreaCache

std::unordered_map< PTR_PTR_LAYER_CACHE_KEY, bool >	m_EnclosedByAreaCache

std::unordered_map< wxString, LSET >	m_LayerExpressionCache

std::unordered_map< ZONE *, std::unique_ptr< DRC_RTREE > >	m_CopperZoneRTreeCache

std::unique_ptr< DRC_RTREE >	m_CopperItemRTreeCache

std::unordered_map< const ZONE *, BOX2I >	m_ZoneBBoxCache

std::vector< ZONE * >	m_DRCZones

std::vector< ZONE * >	m_DRCCopperZones

int	m_DRCMaxClearance

int	m_DRCMaxPhysicalClearance

ZONE *	m_SolderMask

const KIID	m_Uuid

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

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

virtual void	swapData (BOARD_ITEM *aImage)

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

Protected Attributes
PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

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

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Member Functions
	BOARD (const BOARD &aOther)=delete

BOARD &	operator= (const BOARD &aOther)=delete

template<typename Func , typename... Args>
void	InvokeListeners (Func &&aFunc, Args &&... args)

Private Attributes
BOARD_USE	m_boardUse
	What is this board being used for. More...

int	m_timeStamp

wxString	m_fileName

MARKERS	m_markers

DRAWINGS	m_drawings

FOOTPRINTS	m_footprints

TRACKS	m_tracks

GROUPS	m_groups

ZONES	m_zones

LAYER	m_layers [PCB_LAYER_ID_COUNT]

HIGH_LIGHT_INFO	m_highLight

HIGH_LIGHT_INFO	m_highLightPrevious

int	m_fileFormatVersionAtLoad

wxString	m_generator

std::map< wxString, wxString >	m_properties

std::shared_ptr< CONNECTIVITY_DATA >	m_connectivity

PAGE_INFO	m_paper

TITLE_BLOCK	m_titles

PCB_PLOT_PARAMS	m_plotOptions

PROJECT *	m_project

std::unique_ptr< BOARD_DESIGN_SETTINGS >	m_designSettings
	All of the board design settings are stored as a JSON object inside the project file. More...

NETINFO_LIST	m_NetInfo

std::vector< BOARD_LISTENER * >	m_listeners

ZONE_SETTINGS	m_zoneSettings

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

VIEW_ITEM_DATA *	m_viewPrivData

Friends
class	PCB_EDIT_FRAME

Detailed Description

Information pertinent to a Pcbnew printed circuit board.

Definition at line 264 of file board.h.

Constructor & Destructor Documentation

◆ BOARD() [1/2]

BOARD::BOARD ( )

Definition at line 69 of file board.cpp.

 :
 BOARD_ITEM_CONTAINER( (BOARD_ITEM*) nullptr, PCB_T ),
 m_LegacyDesignSettingsLoaded( false ),
 m_LegacyCopperEdgeClearanceLoaded( false ),
 m_LegacyNetclassesLoaded( false ),
 m_boardUse( BOARD_USE::NORMAL ),
 m_timeStamp( 1 ),
 m_paper( PAGE_INFO::A4 ),
 m_project( nullptr ),
 m_designSettings( new BOARD_DESIGN_SETTINGS( nullptr, "board.design_settings" ) ),
 m_NetInfo( this )
{
 // we have not loaded a board yet, assume latest until then.
 m_fileFormatVersionAtLoad = LEGACY_BOARD_FILE_VERSION;
 
 for( int layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
 {
 m_layers[layer].m_name = GetStandardLayerName( ToLAYER_ID( layer ) );
 
 if( IsCopperLayer( layer ) )
 m_layers[layer].m_type = LT_SIGNAL;
 else
 m_layers[layer].m_type = LT_UNDEFINED;
 }
 
 m_SolderMask = new ZONE( this );
 m_SolderMask->SetLayerSet( LSET().set( F_Mask ).set( B_Mask ) );
 int infinity = ( std::numeric_limits<int>::max() / 2 ) - pcbIUScale.mmToIU( 1 );
 m_SolderMask->Outline()->NewOutline();
 m_SolderMask->Outline()->Append( VECTOR2I( -infinity, -infinity ) );
 m_SolderMask->Outline()->Append( VECTOR2I( -infinity, +infinity ) );
 m_SolderMask->Outline()->Append( VECTOR2I( +infinity, +infinity ) );
 m_SolderMask->Outline()->Append( VECTOR2I( +infinity, -infinity ) );
 m_SolderMask->SetMinThickness( 0 );
 
 BOARD_DESIGN_SETTINGS& bds = GetDesignSettings();
 
 // Initialize default netclass.
 bds.m_NetSettings->m_DefaultNetClass = std::make_shared<NETCLASS>( NETCLASS::Default );
 bds.m_NetSettings->m_DefaultNetClass->SetDescription( _( "This is the default net class." ) );
 
 bds.UseCustomTrackViaSize( false );
 
 // Initialize ratsnest
 m_connectivity.reset( new CONNECTIVITY_DATA() );
 
 // Set flag bits on these that will only be cleared if these are loaded from a legacy file
 m_LegacyVisibleLayers.reset().set( Rescue );
 m_LegacyVisibleItems.reset().set( GAL_LAYER_INDEX( GAL_LAYER_ID_BITMASK_END ) );
}

References _, A4, SHAPE_POLY_SET::Append(), B_Mask, NETCLASS::Default, F_Mask, GAL_LAYER_ID_BITMASK_END, GAL_LAYER_INDEX, GetDesignSettings(), GetStandardLayerName(), IsCopperLayer(), LT_SIGNAL, LT_UNDEFINED, m_connectivity, m_fileFormatVersionAtLoad, m_layers, m_LegacyVisibleItems, m_LegacyVisibleLayers, LAYER::m_name, BOARD_DESIGN_SETTINGS::m_NetSettings, m_SolderMask, LAYER::m_type, EDA_IU_SCALE::mmToIU(), SHAPE_POLY_SET::NewOutline(), NORMAL, ZONE::Outline(), PCB_LAYER_ID_COUNT, pcbIUScale, Rescue, GAL_SET::set(), ZONE::SetLayerSet(), ZONE::SetMinThickness(), ToLAYER_ID(), and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

◆ ~BOARD()

BOARD::~BOARD ( )

Definition at line 121 of file board.cpp.

{
 // Untangle group parents before doing any deleting
 for( PCB_GROUP* group : m_groups )
 {
 for( BOARD_ITEM* item : group->GetItems() )
 item->SetParentGroup( nullptr );
 }
 
 // Clean up the owned elements
 DeleteMARKERs();
 
 for( ZONE* zone : m_zones )
 delete zone;
 
 m_zones.clear();
 
 delete m_SolderMask;
 
 for( FOOTPRINT* footprint : m_footprints )
 delete footprint;
 
 m_footprints.clear();
 
 for( PCB_TRACK* t : m_tracks )
 delete t;
 
 m_tracks.clear();
 
 for( BOARD_ITEM* d : m_drawings )
 delete d;
 
 m_drawings.clear();
 
 for( PCB_GROUP* g : m_groups )
 delete g;
 
 m_groups.clear();
}

References DeleteMARKERs(), group, m_drawings, m_footprints, m_groups, m_SolderMask, m_tracks, and m_zones.

◆ BOARD() [2/2]

BOARD::BOARD ( const BOARD & aOther )

privatedelete

Member Function Documentation

◆ Add()

void BOARD::Add	(	BOARD_ITEM *	aItem,
		ADD_MODE	aMode = `ADD_MODE::INSERT`,
		bool	aSkipConnectivity = `false`
	)

overridevirtual

Removes an item from the container.

Implements BOARD_ITEM_CONTAINER.

Definition at line 750 of file board.cpp.

{
 if( aBoardItem == nullptr )
 {
 wxFAIL_MSG( wxT( "BOARD::Add() param error: aBoardItem nullptr" ) );
 return;
 }
 
 switch( aBoardItem->Type() )
 {
 case PCB_NETINFO_T:
 m_NetInfo.AppendNet( (NETINFO_ITEM*) aBoardItem );
 break;
 
 // this one uses a vector
 case PCB_MARKER_T:
 m_markers.push_back( (PCB_MARKER*) aBoardItem );
 break;
 
 // this one uses a vector
 case PCB_GROUP_T:
 m_groups.push_back( (PCB_GROUP*) aBoardItem );
 break;
 
 // this one uses a vector
 case PCB_ZONE_T:
 m_zones.push_back( (ZONE*) aBoardItem );
 break;
 
 case PCB_TRACE_T:
 case PCB_VIA_T:
 case PCB_ARC_T:
 
 // N.B. This inserts a small memory leak as we lose the
 if( !IsCopperLayer( aBoardItem->GetLayer() ) )
 {
 wxFAIL_MSG( wxT( "BOARD::Add() Cannot place Track on non-copper layer" ) );
 return;
 }
 
 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
 m_tracks.push_back( static_cast<PCB_TRACK*>( aBoardItem ) );
 else
 m_tracks.push_front( static_cast<PCB_TRACK*>( aBoardItem ) );
 
 break;
 
 case PCB_FOOTPRINT_T:
 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
 m_footprints.push_back( static_cast<FOOTPRINT*>( aBoardItem ) );
 else
 m_footprints.push_front( static_cast<FOOTPRINT*>( aBoardItem ) );
 
 break;
 
 case PCB_DIM_ALIGNED_T:
 case PCB_DIM_CENTER_T:
 case PCB_DIM_RADIAL_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_DIM_LEADER_T:
 case PCB_SHAPE_T:
 case PCB_BITMAP_T:
 case PCB_TEXT_T:
 case PCB_TEXTBOX_T:
 case PCB_TARGET_T:
 if( aMode == ADD_MODE::APPEND || aMode == ADD_MODE::BULK_APPEND )
 m_drawings.push_back( aBoardItem );
 else
 m_drawings.push_front( aBoardItem );
 
 break;
 
 // other types may use linked list
 default:
 {
 wxString msg;
 msg.Printf( wxT( "BOARD::Add() needs work: BOARD_ITEM type (%d) not handled" ),
 aBoardItem->Type() );
 wxFAIL_MSG( msg );
 return;
 }
 break;
 }
 
 aBoardItem->SetParent( this );
 aBoardItem->ClearEditFlags();
 
 if( !aSkipConnectivity )
 m_connectivity->Add( aBoardItem );
 
 if( aMode != ADD_MODE::BULK_INSERT && aMode != ADD_MODE::BULK_APPEND )
 {
 InvokeListeners( &BOARD_LISTENER::OnBoardItemAdded, *this, aBoardItem );
 }
}

References APPEND, NETINFO_LIST::AppendNet(), BULK_APPEND, BULK_INSERT, EDA_ITEM::ClearEditFlags(), BOARD_ITEM::GetLayer(), InvokeListeners(), IsCopperLayer(), m_connectivity, m_drawings, m_footprints, m_groups, m_markers, m_NetInfo, m_tracks, m_zones, BOARD_LISTENER::OnBoardItemAdded(), PCB_ARC_T, PCB_BITMAP_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_MARKER_T, PCB_NETINFO_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, EDA_ITEM::SetParent(), and EDA_ITEM::Type().

◆ AddArea()

ZONE * BOARD::AddArea	(	PICKED_ITEMS_LIST *	aNewZonesList,
		int	aNetcode,
		PCB_LAYER_ID	aLayer,
		VECTOR2I	aStartPointPosition,
		ZONE_BORDER_DISPLAY_STYLE	aHatch
	)

Add an empty copper area to board areas list.

Parameters

aNewZonesList	is a PICKED_ITEMS_LIST * where to store new areas pickers (useful in undo commands) can be NULL.
aNetcode	is the netcode of the copper area (0 = no net).
aLayer	is the layer of area.
aStartPointPosition	is position of the first point of the polygon outline of this area.
aHatch	is the hatch option.

Returns: a reference to the new area.

Definition at line 1925 of file board.cpp.

{
 ZONE* new_area = new ZONE( this );
 
 new_area->SetNetCode( aNetcode );
 new_area->SetLayer( aLayer );
 
 m_zones.push_back( new_area );
 
 new_area->SetHatchStyle( (ZONE_BORDER_DISPLAY_STYLE) aHatch );
 
 // Add the first corner to the new zone
 new_area->AppendCorner( aStartPointPosition, -1 );
 
 if( aNewZonesList )
 {
 ITEM_PICKER picker( nullptr, new_area, UNDO_REDO::NEWITEM );
 aNewZonesList->PushItem( picker );
 }
 
 return new_area;
}

References ZONE::AppendCorner(), m_zones, NEWITEM, PICKED_ITEMS_LIST::PushItem(), ZONE::SetHatchStyle(), ZONE::SetLayer(), and BOARD_CONNECTED_ITEM::SetNetCode().

◆ AddListener()

void BOARD::AddListener ( BOARD_LISTENER * aListener )

Add a listener to the board to receive calls whenever something on the board has been modified.

The board does not take ownership of the listener object. Make sure to call RemoveListener before deleting the listener object. The order of listener invocations is not guaranteed. If the specified listener object has been added before, it will not be added again.

Definition at line 2023 of file board.cpp.

{
 if( !alg::contains( m_listeners, aListener ) )
 m_listeners.push_back( aListener );
}

References alg::contains(), and m_listeners.

Referenced by DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), APPEARANCE_CONTROLS::OnBoardChanged(), DIALOG_NET_INSPECTOR::onBoardChanged(), PCB_SEARCH_PANE::onBoardChanged(), and PCB_SEARCH_PANE::PCB_SEARCH_PANE().

◆ AllConnectedItems()

const std::vector< BOARD_CONNECTED_ITEM * > BOARD::AllConnectedItems ( )

Definition at line 1979 of file board.cpp.

{
 std::vector<BOARD_CONNECTED_ITEM*> items;
 
 for( PCB_TRACK* track : Tracks() )
 items.push_back( track );
 
 for( FOOTPRINT* footprint : Footprints() )
 {
 for( PAD* pad : footprint->Pads() )
 items.push_back( pad );
 }
 
 for( ZONE* zone : Zones() )
 items.push_back( zone );
 
 return items;
}

References Footprints(), pad, Tracks(), and Zones().

Referenced by MapNets(), and SanitizeNetcodes().

◆ BeginNets()

NETINFO_LIST::iterator BOARD::BeginNets ( ) const

inline

Returns: iterator to the first element of the NETINFO_ITEMs list.

Definition at line 779 of file board.h.

 {
 return m_NetInfo.begin();
 }

References NETINFO_LIST::begin(), and m_NetInfo.

◆ BuildConnectivity()

bool BOARD::BuildConnectivity ( PROGRESS_REPORTER * aReporter = nullptr )

Build or rebuild the board connectivity database for the board, especially the list of connected items, list of nets and rastnest data Needed after loading a board to have the connectivity database updated.

Definition at line 162 of file board.cpp.

{
 if( !GetConnectivity()->Build( this, aReporter ) )
 return false;
 
 UpdateRatsnestExclusions();
 return true;
}

References GetConnectivity(), and UpdateRatsnestExclusions().

Referenced by PCB_CONTROL::AppendBoard(), TRACKS_CLEANER::deleteDanglingTracks(), KI_TEST::FillZones(), PCB_EDIT_FRAME::ImportSpecctraSession(), LoadBoard(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::RebuildAndRefresh(), PCB_BASE_FRAME::rebuildConnectivity(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), TEARDROP_MANAGER::RemoveTeardrops(), SaveBoard(), PCB_EDIT_FRAME::SetBoard(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ BuildListOfNets()

void BOARD::BuildListOfNets ( )

inline

Definition at line 744 of file board.h.

 {
 m_NetInfo.buildListOfNets();
 }

References NETINFO_LIST::buildListOfNets(), and m_NetInfo.

Referenced by PCB_CONTROL::AppendBoard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), LoadBoard(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_EDIT_FRAME::OpenProjectFiles(), and PCB_EDIT_FRAME::ShowBoardSetupDialog().

◆ CacheTriangulation()

void BOARD::CacheTriangulation	(	PROGRESS_REPORTER *	aReporter = `nullptr`,
		const std::vector< ZONE * > &	aZones = `{}`
	)

Definition at line 700 of file board.cpp.

{
 std::vector<ZONE*> zones = aZones;
 
 if( zones.empty() )
 zones = m_zones;
 
 if( zones.empty() )
 return;
 
 if( aReporter )
 aReporter->Report( _( "Tessellating copper zones..." ) );
 
 thread_pool& tp = GetKiCadThreadPool();
 std::vector<std::future<size_t>> returns;
 
 returns.reserve( zones.size() );
 
 auto cache_zones = [aReporter]( ZONE* aZone ) -> size_t
 {
 if( aReporter && aReporter->IsCancelled() )
 return 0;
 
 aZone->CacheTriangulation();
 
 if( aReporter )
 aReporter->AdvanceProgress();
 
 return 1;
 };
 
 for( ZONE* zone : zones )
 returns.emplace_back( tp.submit( cache_zones, zone ) );
 
 // Finalize the triangulation threads
 for( const std::future<size_t>& ret : returns )
 {
 std::future_status status = ret.wait_for( std::chrono::milliseconds( 250 ) );
 
 while( status != std::future_status::ready )
 {
 if( aReporter )
 aReporter->KeepRefreshing();
 
 status = ret.wait_for( std::chrono::milliseconds( 250 ) );
 }
 }
}

References _, PROGRESS_REPORTER::AdvanceProgress(), GetKiCadThreadPool(), PROGRESS_REPORTER::IsCancelled(), PROGRESS_REPORTER::KeepRefreshing(), m_zones, PROGRESS_REPORTER::Report(), and tp.

Referenced by CONNECTIVITY_DATA::Build(), and PCB_DRAW_PANEL_GAL::DisplayBoard().

◆ ClassOf()

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

inlinestatic

Definition at line 267 of file board.h.

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

References PCB_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:141

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 158 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 141 of file eda_item.h.

141{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), 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(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearProject()

void BOARD::ClearProject ( )

Definition at line 206 of file board.cpp.

{
 if( !m_project )
 return;
 
 PROJECT_FILE& project = m_project->GetProjectFile();
 
 // Owned by the BOARD
 if( project.m_BoardSettings )
 {
 project.ReleaseNestedSettings( project.m_BoardSettings );
 project.m_BoardSettings = nullptr;
 }
 
 GetDesignSettings().m_NetSettings = nullptr;
 GetDesignSettings().SetParent( nullptr );
 m_project = nullptr;
}

References GetDesignSettings(), PROJECT::GetProjectFile(), BOARD_DESIGN_SETTINGS::m_NetSettings, m_project, project, and NESTED_SETTINGS::SetParent().

Referenced by PCB_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SetBoard(), and SetProject().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:47

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 153 of file eda_item.h.

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

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

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

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const

virtualinherited

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 in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, KIGFX::ORIGIN_VIEWITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PAD, PCB_BITMAP, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and FP_ZONE.

Definition at line 82 of file eda_item.cpp.

{
 wxCHECK_MSG( false, nullptr, wxT( "Clone not implemented in derived class " ) + GetClass() +
 wxT( ". Bad programmer!" ) );
}

References EDA_ITEM::GetClass().

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_DIMENSION_BASE::GetEffectiveShape(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_COMMIT::makeImage(), new_clone(), LIB_SYMBOL::operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_SYMBOL::SetConversion(), LIB_SYMBOL::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ComputeBoundingBox()

BOX2I BOARD::ComputeBoundingBox ( bool aBoardEdgesOnly = false ) const

Calculate the bounding box containing all board items (or board edge segments).

Parameters

aBoardEdgesOnly is true if we are interested in board edge segments only.

Returns: the board's bounding box.

Definition at line 1231 of file board.cpp.

{
 BOX2I bbox;
 LSET visible = GetVisibleLayers();
 bool showInvisibleText = IsElementVisible( LAYER_MOD_TEXT_INVISIBLE )
 && PgmOrNull() && !PgmOrNull()->m_Printing;
 
 if( aBoardEdgesOnly )
 visible.set( Edge_Cuts );
 
 // Check shapes, dimensions, texts, and fiducials
 for( BOARD_ITEM* item : m_drawings )
 {
 if( aBoardEdgesOnly && ( item->GetLayer() != Edge_Cuts || item->Type() != PCB_SHAPE_T ) )
 continue;
 
 if( ( item->GetLayerSet() & visible ).any() )
 bbox.Merge( item->GetBoundingBox() );
 }
 
 // Check footprints
 for( FOOTPRINT* footprint : m_footprints )
 {
 if( !( footprint->GetLayerSet() & visible ).any() )
 continue;
 
 if( aBoardEdgesOnly )
 {
 for( const BOARD_ITEM* edge : footprint->GraphicalItems() )
 {
 if( edge->GetLayer() == Edge_Cuts && edge->Type() == PCB_FP_SHAPE_T )
 bbox.Merge( edge->GetBoundingBox() );
 }
 }
 else
 {
 bbox.Merge( footprint->GetBoundingBox( true, showInvisibleText ) );
 }
 }
 
 if( !aBoardEdgesOnly )
 {
 // Check tracks
 for( PCB_TRACK* track : m_tracks )
 {
 if( ( track->GetLayerSet() & visible ).any() )
 bbox.Merge( track->GetBoundingBox() );
 }
 
 // Check zones
 for( ZONE* aZone : m_zones )
 {
 if( ( aZone->GetLayerSet() & visible ).any() )
 bbox.Merge( aZone->GetBoundingBox() );
 }
 }
 
 return bbox;
}

References Edge_Cuts, GetVisibleLayers(), IsElementVisible(), LAYER_MOD_TEXT_INVISIBLE, m_drawings, m_footprints, PGM_BASE::m_Printing, m_tracks, m_zones, BOX2< Vec >::Merge(), PCB_FP_SHAPE_T, PCB_SHAPE_T, and PgmOrNull().

Referenced by buildBoardBoundingBoxPoly(), BuildBoardPolygonOutlines(), PCB_EDIT_FRAME::ExportToGenCAD(), PLACE_FILE_EXPORTER::GenReportData(), GetBoardEdgesBoundingBox(), GetBoundingBox(), PCBNEW_PRINTOUT::getBoundingBox(), initializePlotter(), BOARD_ADAPTER::InitSettings(), DIALOG_EXPORT_STEP::onExportButton(), PCB_PLOT_SVG::Plot(), and StartPlotBoard().

◆ ConvertBrdLayerToPolygonalContours()

void BOARD::ConvertBrdLayerToPolygonalContours	(	PCB_LAYER_ID	aLayer,
		SHAPE_POLY_SET &	aOutlines
	)		const

Build a set of polygons which are the outlines of copper items (pads, tracks, vias, texts, zones).

Holes in vias or pads are ignored. The polygons are not merged. This is useful to export the shape of copper layers to dxf polygons or 3D viewer/

Parameters

aLayer	is a copper layer, like B_Cu, etc.
aOutlines	is the SHAPE_POLY_SET to fill in with items outline.

Definition at line 2249 of file board.cpp.

{
 int maxError = GetDesignSettings().m_MaxError;
 
 // convert tracks and vias:
 for( const PCB_TRACK* track : m_tracks )
 {
 if( !track->IsOnLayer( aLayer ) )
 continue;
 
 track->TransformShapeToPolygon( aOutlines, aLayer, 0, maxError, ERROR_INSIDE );
 }
 
 // convert pads and other copper items in footprints
 for( const FOOTPRINT* footprint : m_footprints )
 {
 footprint->TransformPadsToPolySet( aOutlines, aLayer, 0, maxError, ERROR_INSIDE );
 
 // Microwave footprints may have items on copper layers
 footprint->TransformFPShapesToPolySet( aOutlines, aLayer, 0, maxError, ERROR_INSIDE,
 true, /* include text */
 true, /* include shapes */
 false /* include private items */ );
 
 for( const ZONE* zone : footprint->Zones() )
 {
 if( zone->GetLayerSet().test( aLayer ) )
 zone->TransformSolidAreasShapesToPolygon( aLayer, aOutlines );
 }
 }
 
 // convert copper zones
 for( const ZONE* zone : Zones() )
 {
 if( zone->GetLayerSet().test( aLayer ) )
 zone->TransformSolidAreasShapesToPolygon( aLayer, aOutlines );
 }
 
 // convert graphic items on copper layers (texts)
 for( const BOARD_ITEM* item : m_drawings )
 {
 if( !item->IsOnLayer( aLayer ) )
 continue;
 
 switch( item->Type() )
 {
 case PCB_SHAPE_T:
 {
 const PCB_SHAPE* shape = static_cast<const PCB_SHAPE*>( item );
 shape->TransformShapeToPolygon( aOutlines, aLayer, 0, maxError, ERROR_INSIDE );
 break;
 }
 
 case PCB_TEXT_T:
 {
 const PCB_TEXT* text = static_cast<const PCB_TEXT*>( item );
 text->TransformTextToPolySet( aOutlines, aLayer, 0, maxError, ERROR_INSIDE );
 break;
 }
 
 case PCB_TEXTBOX_T:
 {
 const PCB_TEXTBOX* textbox = static_cast<const PCB_TEXTBOX*>( item );
 
 // plot border
 textbox->PCB_SHAPE::TransformShapeToPolygon( aOutlines, aLayer, 0, maxError,
 ERROR_INSIDE );
 // plot text
 textbox->TransformTextToPolySet( aOutlines, aLayer, 0, maxError, ERROR_INSIDE );
 break;
 }
 
 default:
 break;
 }
 }
}

References ERROR_INSIDE, GetDesignSettings(), m_drawings, m_footprints, BOARD_DESIGN_SETTINGS::m_MaxError, m_tracks, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, text, PCB_SHAPE::TransformShapeToPolygon(), PCB_TEXTBOX::TransformTextToPolySet(), and Zones().

Referenced by EXPORTER_PCB_VRML::ExportStandardLayers(), EXPORTER_PCB_VRML::ExportVrmlSolderMask(), and PlotLayerOutlines().

◆ ConvertCrossReferencesToKIIDs()

wxString BOARD::ConvertCrossReferencesToKIIDs ( const wxString & aSource ) const

Convert cross-references back and forth between ${refDes:field} and ${kiid:field}.

Definition at line 1112 of file board.cpp.

{
 wxString newbuf;
 size_t sourceLen = aSource.length();
 
 for( size_t i = 0; i < sourceLen; ++i )
 {
 if( aSource[i] == '$' && i + 1 < sourceLen && aSource[i+1] == '{' )
 {
 wxString token;
 bool isCrossRef = false;
 
 for( i = i + 2; i < sourceLen; ++i )
 {
 if( aSource[i] == '}' )
 break;
 
 if( aSource[i] == ':' )
 isCrossRef = true;
 
 token.append( aSource[i] );
 }
 
 if( isCrossRef )
 {
 wxString remainder;
 wxString ref = token.BeforeFirst( ':', &remainder );
 
 for( const FOOTPRINT* footprint : Footprints() )
 {
 if( footprint->GetReference().CmpNoCase( ref ) == 0 )
 {
 wxString test( remainder );
 
 if( footprint->ResolveTextVar( &test ) )
 token = footprint->m_Uuid.AsString() + wxT( ":" ) + remainder;
 
 break;
 }
 }
 }
 
 newbuf.append( wxT( "${" ) + token + wxT( "}" ) );
 }
 else
 {
 newbuf.append( aSource[i] );
 }
 }
 
 return newbuf;
}

References Footprints().

Referenced by DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ ConvertKIIDsToCrossReferences()

wxString BOARD::ConvertKIIDsToCrossReferences ( const wxString & aSource ) const

Definition at line 1166 of file board.cpp.

{
 wxString newbuf;
 size_t sourceLen = aSource.length();
 
 for( size_t i = 0; i < sourceLen; ++i )
 {
 if( aSource[i] == '$' && i + 1 < sourceLen && aSource[i+1] == '{' )
 {
 wxString token;
 bool isCrossRef = false;
 
 for( i = i + 2; i < sourceLen; ++i )
 {
 if( aSource[i] == '}' )
 break;
 
 if( aSource[i] == ':' )
 isCrossRef = true;
 
 token.append( aSource[i] );
 }
 
 if( isCrossRef )
 {
 wxString remainder;
 wxString ref = token.BeforeFirst( ':', &remainder );
 BOARD_ITEM* refItem = GetItem( KIID( ref ) );
 
 if( refItem && refItem->Type() == PCB_FOOTPRINT_T )
 {
 token = static_cast<FOOTPRINT*>( refItem )->GetReference() + wxT( ":" )
 + remainder;
 }
 }
 
 newbuf.append( wxT( "${" ) + token + wxT( "}" ) );
 }
 else
 {
 newbuf.append( aSource[i] );
 }
 }
 
 return newbuf;
}

References GetItem(), PCB_FOOTPRINT_T, and EDA_ITEM::Type().

Referenced by DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ Delete()

virtual void BOARD_ITEM_CONTAINER::Delete ( BOARD_ITEM * aItem )

inlinevirtualinherited

Removes an item from the container and deletes it.

Definition at line 77 of file board_item_container.h.

 {
 Remove( aItem );
 delete aItem;
 }

References BOARD_ITEM_CONTAINER::Remove().

Referenced by DRC_ITEMS_PROVIDER::DeleteItem(), PCB_PARSER::parseBOARD_unchecked(), and BOARD_COMMIT::Push().

◆ DeleteAllFootprints()

void BOARD::DeleteAllFootprints ( )

Remove all footprints from the deque and free the memory associated with them.

Definition at line 988 of file board.cpp.

{
 for( FOOTPRINT* footprint : m_footprints )
 delete footprint;
 
 m_footprints.clear();
}

References m_footprints.

Referenced by FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ DeleteMARKERs() [1/2]

void BOARD::DeleteMARKERs ( )

Delete all MARKERS from the board.

Definition at line 956 of file board.cpp.

{
 // the vector does not know how to delete the PCB_MARKER, it holds pointers
 for( PCB_MARKER* marker : m_markers )
 delete marker;
 
 m_markers.clear();
}

References m_markers.

Referenced by DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), DSN::SPECCTRA_DB::FromSESSION(), and ~BOARD().

◆ DeleteMARKERs() [2/2]

void BOARD::DeleteMARKERs	(	bool	aWarningsAndErrors,
		bool	aExclusions
	)

Definition at line 966 of file board.cpp.

{
 // Deleting lots of items from a vector can be very slow. Copy remaining items instead.
 MARKERS remaining;
 
 for( PCB_MARKER* marker : m_markers )
 {
 if( ( marker->GetSeverity() == RPT_SEVERITY_EXCLUSION && aExclusions )
 || ( marker->GetSeverity() != RPT_SEVERITY_EXCLUSION && aWarningsAndErrors ) )
 {
 delete marker;
 }
 else
 {
 remaining.push_back( marker );
 }
 }
 
 m_markers = remaining;
}

References m_markers, and RPT_SEVERITY_EXCLUSION.

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 150 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 DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Drawings() [1/2]

DRAWINGS & BOARD::Drawings ( )

inline

Definition at line 310 of file board.h.

310{ return m_drawings; }

References m_drawings.

Referenced by PCB_CONTROL::AppendBoard(), ZONE_FILLER::buildCopperItemClearances(), CreateBoardSection(), BOARD_ADAPTER::createLayers(), PCB_DRAW_PANEL_GAL::DisplayBoard(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), FillItemMap(), ZONE_FILLER::fillNonCopperZone(), DRC_TEST_PROVIDER::forEachGeometryItem(), PCB_PLUGIN::format(), GENDRILL_WRITER_BASE::genDrillMapFile(), AR_AUTOPLACER::genPlacementRoutingMatrix(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), GetItem(), idf_export_outline(), ALTIUM_PCB::Parse(), PCB_PARSER::parseBOARD_unchecked(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BRDITEMS_PLOTTER::PlotBoardGraphicItems(), PlotSolderMaskLayer(), PCB_EDIT_FRAME::RunActionPlugin(), DIALOG_FIND::search(), TEXT_SEARCH_HANDLER::Search(), PNS_KICAD_IFACE_BASE::SyncWorld(), and TestForExistingItem().

◆ Drawings() [2/2]

const DRAWINGS & BOARD::Drawings ( ) const

inline

Definition at line 311 of file board.h.

311{ return m_drawings; }

References m_drawings.

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 184 of file board_item.cpp.

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

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

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

◆ EndNets()

NETINFO_LIST::iterator BOARD::EndNets ( ) const

inline

Returns: iterator to the last element of the NETINFO_ITEMs list.

Definition at line 787 of file board.h.

 {
 return m_NetInfo.end();
 }

References NETINFO_LIST::end(), and m_NetInfo.

◆ FillItemMap()

void BOARD::FillItemMap ( std::map< KIID, EDA_ITEM * > & aMap )

Definition at line 1076 of file board.cpp.

{
 // the board itself
 aMap[ m_Uuid ] = this;
 
 for( PCB_TRACK* track : Tracks() )
 aMap[ track->m_Uuid ] = track;
 
 for( FOOTPRINT* footprint : Footprints() )
 {
 aMap[ footprint->m_Uuid ] = footprint;
 
 for( PAD* pad : footprint->Pads() )
 aMap[ pad->m_Uuid ] = pad;
 
 aMap[ footprint->Reference().m_Uuid ] = &footprint->Reference();
 aMap[ footprint->Value().m_Uuid ] = &footprint->Value();
 
 for( BOARD_ITEM* drawing : footprint->GraphicalItems() )
 aMap[ drawing->m_Uuid ] = drawing;
 }
 
 for( ZONE* zone : Zones() )
 aMap[ zone->m_Uuid ] = zone;
 
 for( BOARD_ITEM* drawing : Drawings() )
 aMap[ drawing->m_Uuid ] = drawing;
 
 for( PCB_MARKER* marker : m_markers )
 aMap[ marker->m_Uuid ] = marker;
 
 for( PCB_GROUP* group : m_groups )
 aMap[ group->m_Uuid ] = group;
}

References Drawings(), Footprints(), group, m_groups, m_markers, EDA_ITEM::m_Uuid, pad, Tracks(), and Zones().

Referenced by WriteDRCReport(), and DIALOG_DRC::writeReport().

◆ FinalizeBulkAdd()

void BOARD::FinalizeBulkAdd ( std::vector< BOARD_ITEM * > & aNewItems )

Must be used if Add() is used using a BULK_x ADD_MODE to generate a change event for listeners.

Definition at line 847 of file board.cpp.

{
 InvokeListeners( &BOARD_LISTENER::OnBoardItemsAdded, *this, aNewItems );
}

References InvokeListeners(), and BOARD_LISTENER::OnBoardItemsAdded().

Referenced by PCB_PARSER::parseBOARD_unchecked(), BOARD_COMMIT::Push(), and BOARD_COMMIT::Revert().

◆ FinalizeBulkRemove()

void BOARD::FinalizeBulkRemove ( std::vector< BOARD_ITEM * > & aRemovedItems )

Must be used if Remove() is used using a BULK_x REMOVE_MODE to generate a change event for listeners.

Definition at line 853 of file board.cpp.

{
 InvokeListeners( &BOARD_LISTENER::OnBoardItemsRemoved, *this, aRemovedItems );
}

References InvokeListeners(), and BOARD_LISTENER::OnBoardItemsRemoved().

Referenced by BOARD_COMMIT::Push(), and BOARD_COMMIT::Revert().

◆ FindFootprintByPath()

FOOTPRINT * BOARD::FindFootprintByPath ( const KIID_PATH & aPath ) const

Search for a FOOTPRINT within this board with the given path.

Parameters

aPath The path ([sheetUUID, .., symbolUUID]) to search for.

Returns: If found, the FOOTPRINT having the given uuid, else NULL.

Definition at line 1489 of file board.cpp.

{
 for( FOOTPRINT* footprint : m_footprints )
 {
 if( footprint->GetPath() == aPath )
 return footprint;
 }
 
 return nullptr;
}

References m_footprints.

Referenced by PCB_EDIT_FRAME::LoadFootprints().

◆ FindFootprintByReference()

FOOTPRINT * BOARD::FindFootprintByReference ( const wxString & aReference ) const

Search for a FOOTPRINT within this board with the given reference designator.

Finds only the first one, if there is more than one such FOOTPRINT.

Parameters

aReference The reference designator of the FOOTPRINT to find.

Returns: If found the FOOTPRINT having the given reference designator, else nullptr.

Definition at line 1477 of file board.cpp.

{
 for( FOOTPRINT* footprint : m_footprints )
 {
 if( aReference == footprint->GetReference() )
 return footprint;
 }
 
 return nullptr;
}

References m_footprints.

Referenced by DSN::SPECCTRA_DB::FromSESSION(), PCB_EDIT_FRAME::LoadFootprints(), and DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist().

◆ FindNet() [1/2]

NETINFO_ITEM * BOARD::FindNet ( const wxString & aNetname ) const

Search for a net with the given name.

Parameters

aNetname A Netname to search for.

Returns: the net if found or NULL if not found.

Definition at line 1471 of file board.cpp.

{
 return m_NetInfo.GetNetItem( aNetname );
}

References NETINFO_LIST::GetNetItem(), and m_NetInfo.

◆ FindNet() [2/2]

NETINFO_ITEM * BOARD::FindNet ( int aNetcode ) const

Search for a net with the given netcode.

Parameters

aNetcode A netcode to search for.

Returns: the net if found or NULL if not found.

Definition at line 1456 of file board.cpp.

{
 // the first valid netcode is 1 and the last is m_NetInfo.GetCount()-1.
 // zero is reserved for "no connection" and is not actually a net.
 // nullptr is returned for non valid netcodes
 
 wxASSERT( m_NetInfo.GetNetCount() > 0 );
 
 if( aNetcode == NETINFO_LIST::UNCONNECTED && m_NetInfo.GetNetCount() == 0 )
 return NETINFO_LIST::OrphanedItem();
 else
 return m_NetInfo.GetNetItem( aNetcode );
}

References NETINFO_LIST::GetNetCount(), NETINFO_LIST::GetNetItem(), m_NetInfo, NETINFO_LIST::OrphanedItem(), and NETINFO_LIST::UNCONNECTED.

Referenced by PCAD2KICAD::PCB_PAD::AddToFootprint(), CreateSignalsSection(), PNS_PCBNEW_RULE_RESOLVER::DpCoupledNet(), PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), PNS_PCBNEW_RULE_RESOLVER::DpNetPolarity(), PCB_EDIT_FRAME::Edit_Zone_Params(), DIALOG_COPPER_ZONE::ensureSelectedNetIsVisible(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), inDiffPairFunc(), DRC_ENGINE::IsNetADiffPair(), LEGACY_PLUGIN::loadNETINFO_ITEM(), LEGACY_PLUGIN::loadPAD(), MapNets(), PNS_PCBNEW_RULE_RESOLVER::NetName(), DIALOG_NET_INSPECTOR::onAddNet(), DIALOG_NET_INSPECTOR::onRenameNet(), NETINFO_MAPPING::iterator::operator*(), PCB_PARSER::parseNETINFO_ITEM(), PCB_PARSER::parsePAD(), PCB_PARSER::parseZONE(), BOARD_EDITOR_CONTROL::RepairBoard(), SanitizeNetcodes(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and ROUTER_TOOL::UpdateMessagePanel().

◆ Flip()

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

virtualinherited

Flip this object, i.e.

change the board side for this object.

Parameters

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

Reimplemented in PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and PAD.

Definition at line 256 of file board_item.cpp.

{
 wxMessageBox( wxT( "virtual BOARD_ITEM::Flip used, should not occur" ), GetClass() );
}

References EDA_ITEM::GetClass().

◆ Footprints() [1/2]

FOOTPRINTS & BOARD::Footprints ( )

inline

Definition at line 307 of file board.h.

307{ return m_footprints; }

References m_footprints.

◆ Footprints() [2/2]

const FOOTPRINTS & BOARD::Footprints ( ) const

inline

Definition at line 308 of file board.h.

308{ return m_footprints; }

References m_footprints.

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

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

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

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

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

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

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

◆ GetArea()

ZONE * BOARD::GetArea ( int index ) const

inline

Return the Zone at a given index.

Parameters

index The array type index into a collection of ZONE *.

Returns: a pointer to the Area or NULL if index out of range.

Definition at line 912 of file board.h.

 {
 if( (unsigned) index < m_zones.size() )
 return m_zones[index];
 
 return nullptr;
 }

References m_zones.

Referenced by UpdateCopyOfZonesList().

◆ GetAreaCount()

int BOARD::GetAreaCount ( ) const

inline

Returns: The number of copper pour areas or ZONEs.

Definition at line 928 of file board.h.

 {
 return static_cast<int>( m_zones.size() );
 }

References m_zones.

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 57 of file board_item.cpp.

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

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 43 of file board_item.cpp.

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

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

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

◆ GetBoardEdgesBoundingBox()

const BOX2I BOARD::GetBoardEdgesBoundingBox ( ) const

inline

Return the board bounding box calculated using exclusively the board edges (graphics on Edge.Cuts layer).

If there are items outside of the area limited by Edge.Cuts graphics, the items will not be taken into account.

Returns: bounding box calculated using exclusively the board edges.

Definition at line 823 of file board.h.

 {
 return ComputeBoundingBox( true );
 }

References ComputeBoundingBox().

Referenced by GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), AUTOPLACE_TOOL::autoplace(), BuildBoardPolygonOutlines(), EAGLE_PLUGIN::centerBoard(), BOARD_NETLIST_UPDATER::estimateFootprintInsertionPosition(), GENDRILL_WRITER_BASE::genDrillMapFile(), AR_AUTOPLACER::genPlacementRoutingMatrix(), PCB_BASE_FRAME::GetBoardBoundingBox(), idf_export_outline(), CADSTAR_PCB_ARCHIVE_PLUGIN::Load(), PCB_EDIT_FRAME::OnExportIDF3(), and ALTIUM_PCB::Parse().

◆ GetBoardPolygonOutlines()

bool BOARD::GetBoardPolygonOutlines	(	SHAPE_POLY_SET &	aOutlines,
		OUTLINE_ERROR_HANDLER *	aErrorHandler = `nullptr`
	)

Extract the board outlines and build a closed polygon from lines, arcs and circle items on edge cut layer.

Any closed outline inside the main outline is a hole. All contours should be closed, i.e. have valid vertices to build a closed polygon.

Parameters

aOutlines	is the SHAPE_POLY_SET to fill in with outlines/holes.
aErrorHandler	is an optional DRC_ITEM error handler.

Returns: true if success, false if a contour is not valid

Definition at line 1950 of file board.cpp.

{
 int chainingEpsilon = pcbIUScale.mmToIU( 0.02 ); // max dist from one endPt to next startPt
 
 bool success = BuildBoardPolygonOutlines( this, aOutlines, GetDesignSettings().m_MaxError,
 chainingEpsilon, aErrorHandler );
 
 // Make polygon strictly simple to avoid issues (especially in 3D viewer)
 aOutlines.Simplify( SHAPE_POLY_SET::PM_STRICTLY_SIMPLE );
 
 return success;
}

References BuildBoardPolygonOutlines(), GetDesignSettings(), EDA_IU_SCALE::mmToIU(), pcbIUScale, SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, and SHAPE_POLY_SET::Simplify().

Referenced by DSN::SPECCTRA_DB::BuiltBoardOutlines(), EXPORTER_STEP::composePCB(), BOARD_ADAPTER::createBoardPolygon(), DRAWING_TOOL::DrawBoardCharacteristics(), EXPORTER_PCB_VRML::ExportVrmlBoard(), ZONE_FILLER::Fill(), AR_AUTOPLACER::genPlacementRoutingMatrix(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), PlotSolderMaskLayer(), PNS_KICAD_IFACE_BASE::SyncWorld(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), and HYPERLYNX_EXPORTER::writeBoardInfo().

◆ GetBoardUse()

BOARD_USE BOARD::GetBoardUse ( ) const

inline

Get what the board use is.

Returns: what the board is being used for

Definition at line 284 of file board.h.

284{ return m_boardUse; }

References m_boardUse.

Referenced by BOARD_ITEM::IsLocked().

◆ GetBoundingBox()

const BOX2I BOARD::GetBoundingBox ( ) const

inlineoverridevirtual

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 809 of file board.h.

 {
 return ComputeBoundingBox( false );
 }

References ComputeBoundingBox().

Referenced by buildBoardBoundingBoxPoly(), PCB_BASE_FRAME::GetBoardBoundingBox(), GetFocusPosition(), PCB_EDIT_FRAME::OnExportVRML(), DRC_TEST_PROVIDER_MISC::testOutline(), and PANEL_PCBNEW_COLOR_SETTINGS::zoomFitPreview().

◆ GetCenter()

virtual VECTOR2I 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 PAD, PCB_MARKER, PCB_SHAPE, and PCB_ARC.

Definition at line 93 of file board_item.h.

 {
 return GetBoundingBox().GetCenter();
 }

References EDA_ITEM::GetBoundingBox(), and BOX2< Vec >::GetCenter().

Referenced by PCB_GRID_HELPER::computeAnchors(), PCB_SELECTION_TOOL::FindItem(), and ALTIUM_PCB::HelperParseDimensions6Radial().

◆ GetClass()

wxString BOARD::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 881 of file board.h.

 {
 return wxT( "BOARD" );
 }

Referenced by Visit().

◆ GetConnectivity()

std::shared_ptr< CONNECTIVITY_DATA > BOARD::GetConnectivity ( ) const

inline

Return a list of missing connections between components/tracks.

Returns: an object that contains information about missing connections.

Definition at line 424 of file board.h.

424{ return m_connectivity; }

References m_connectivity.

Referenced by BuildConnectivity(), BOARD_NETLIST_UPDATER::cacheCopperZoneConnections(), FROM_TO_CACHE::cacheFromToPaths(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), DIALOG_NET_INSPECTOR::calculateViaLength(), TRACKS_CLEANER::cleanup(), PCB_BASE_FRAME::Compile_Ratsnest(), TRACKS_CLEANER::deleteDanglingTracks(), TRACKS_CLEANER::deleteTracksInPads(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PNS_KICAD_IFACE::DisplayRatline(), EDIT_TOOL::DragArcTrack(), ZONE_FILLER::Fill(), EDIT_TOOL::FilletTracks(), PCB_VIA::FlashLayer(), fromToFunc(), NETINFO_ITEM::GetBoundingBox(), TRACKS_CLEANER::getConnectedItems(), GetMsgPanelInfo(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), GetTrackLength(), PCB_SELECTION_TOOL::grabUnconnected(), PCB_EDIT_FRAME::ImportSpecctraSession(), ROUTER_TOOL::Init(), ROUTER_TOOL::InlineDrag(), TRACKS_CLEANER::mergeCollinearSegments(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), PCB_BASE_FRAME::PlaceFootprint(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), DIALOG_NET_INSPECTOR::relevantConnectivityItems(), TRACKS_CLEANER::removeShortingTrackSegments(), BOARD_COMMIT::Revert(), ROUTER_TOOL::RouteSelected(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), PCB_SELECTION_TOOL::SelectAllItemsOnNet(), PCB_SELECTION_TOOL::selectConnections(), PCB_SELECTION_TOOL::selectUnconnected(), TRACKS_CLEANER::testTrackEndpointIsNode(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and UpdateRatsnestExclusions().

◆ GetCopperLayerCount()

int BOARD::GetCopperLayerCount ( ) const

Returns: The number of copper layers in the BOARD.

Definition at line 541 of file board.cpp.

{
 return GetDesignSettings().GetCopperLayerCount();
}

References BOARD_DESIGN_SETTINGS::GetCopperLayerCount(), and GetDesignSettings().

Referenced by GERBER_JOBFILE_WRITER::addJSONDesignRules(), GERBER_JOBFILE_WRITER::addJSONFilesAttributes(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PCB_CONTROL::AppendBoard(), GENDRILL_WRITER_BASE::BuildFileFunctionAttributeString(), DSN::SPECCTRA_DB::buildLayerMaps(), PANEL_SETUP_LAYERS::CheckCopperLayerCount(), compute_pad_access_code(), EXPORTER_PCB_VRML::ComputeLayer3D_Zpos(), CreateComponentsSection(), CreatePadsShapesSection(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), CreateRoutesSection(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_TRACK::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), DSN::SPECCTRA_DB::FromBOARD(), GetGerberFileFunctionAttribute(), DIALOG_TRACK_VIA_PROPERTIES::getLayerDepth(), BOARD_ADAPTER::InitSettings(), LayerDepth(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DSN::SPECCTRA_DB::makeVIA(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), PCB_BASE_FRAME::SwitchLayer(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), PANEL_SETUP_LAYERS::TransferDataToWindow(), and via_access_code().

◆ GetDesignSettings()

BOARD_DESIGN_SETTINGS & BOARD::GetDesignSettings ( ) const

Returns: the BOARD_DESIGN_SETTINGS for this BOARD

Definition at line 682 of file board.cpp.

{
 return *m_designSettings;
}

References m_designSettings.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

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

References IS_BROKEN, IS_CHANGED, IS_MOVING, IS_NEW, IS_PASTED, EDA_ITEM::m_flags, and STRUCT_DELETED.

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 229 of file board_item.cpp.

{
 static std::shared_ptr<SHAPE_SEGMENT> slot;
 
 UNIMPLEMENTED_FOR( GetClass() );
 
 return slot;
}

References EDA_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

Referenced by collidesWithArea(), DRAWING_TOOL::DrawVia(), DRC_RTREE::Insert(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetEffectiveShape()

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

virtualinherited

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.
aFlash	optional parameter allowing a caller to force the pad to be flashed (or not flashed) on the current layer (default is to honour the pad's setting and the current connections for the given layer).

Reimplemented in PCB_DIMENSION_BASE, PCB_MARKER, PCB_TARGET, PCB_GROUP, FOOTPRINT, FP_TEXT, FP_TEXTBOX, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and PAD.

Definition at line 219 of file board_item.cpp.

{
 static std::shared_ptr<SHAPE> shape;
 
 UNIMPLEMENTED_FOR( GetClass() );
 
 return shape;
}

References EDA_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

◆ GetEnabledLayers()

LSET BOARD::GetEnabledLayers ( ) const

A proxy function that calls the corresponding function in m_BoardSettings.

Returns: the enabled layers in bit-mapped form.

Definition at line 565 of file board.cpp.

{
 return GetDesignSettings().GetEnabledLayers();
}

References GetDesignSettings(), and BOARD_DESIGN_SETTINGS::GetEnabledLayers().

Referenced by PCB_CONTROL::AppendBoard(), PCB_ONE_LAYER_SELECTOR::buildList(), SELECT_COPPER_LAYERS_PAIR_DIALOG::buildList(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_PLOT::DIALOG_PLOT(), KIGFX::PCB_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_PLUGIN::format(), PCB_PLUGIN::formatBoardLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), PCB_LAYER_BOX_SELECTOR::getEnabledLayers(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), PANEL_SETUP_BOARD_STACKUP::ImportSettingsFrom(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), HYPERLYNX_PAD_STACK::IsEmpty(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), BOARD_ITEM::layerMaskDescribe(), padsNeedUpdate(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), DIALOG_PLOT::Plot(), PCB_CONTROL::pruneItemLayers(), APPEARANCE_CONTROLS::rebuildLayers(), CADSTAR_PCB_ARCHIVE_LOADER::remapUnsureLayers(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), PANEL_SETUP_LAYERS::TransferDataToWindow(), PCB_PROPERTIES_PANEL::updateLists(), PCB_EDIT_FRAME::UpdateUserInterface(), PAD::ViewGetLOD(), PCB_VIA::ViewGetLOD(), and HYPERLYNX_EXPORTER::writeSinglePadStack().

◆ GetFileFormatVersionAtLoad()

int BOARD::GetFileFormatVersionAtLoad ( ) const

inline

Definition at line 363 of file board.h.

363{ return m_fileFormatVersionAtLoad; }

References m_fileFormatVersionAtLoad.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetFileName()

const wxString & BOARD::GetFileName ( void ) const

inline

Definition at line 302 of file board.h.

302{ return m_fileName; }

BOARD::m_fileName

wxString m_fileName

Definition: board.h:1176

References m_fileName.

◆ GetFirstFootprint()

FOOTPRINT * BOARD::GetFirstFootprint ( ) const

inline

Get the first footprint on the board or nullptr.

This is used primarily by the footprint editor which knows there is only one.

Returns: first footprint or null pointer

Definition at line 397 of file board.h.

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

References m_footprints.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BuildFootprintPolygonOutlines(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::ClearModify(), BOARD_ADAPTER::createBoardPolygon(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), PCB_CONTROL::DeleteItemCursor(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), EDIT_TOOL::Duplicate(), FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint(), PAD_TOOL::EnumeratePads(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), PCB_TOOL_BASE::footprint(), PCB_VIEWER_TOOLS::footprint(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), FOOTPRINT_EDIT_FRAME::GetLoadedFPID(), DISPLAY_FOOTPRINTS_FRAME::GetModel(), FOOTPRINT_EDIT_FRAME::GetModel(), FOOTPRINT_VIEWER_FRAME::GetModel(), FOOTPRINT_WIZARD_FRAME::GetModel(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), GROUP_TOOL::Group(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), ARRAY_CREATOR::Invoke(), FOOTPRINT_EDIT_FRAME::IsContentModified(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), DRAWING_TOOL::PlaceImportedGraphics(), FOOTPRINT_EDITOR_CONTROL::Properties(), BOARD_COMMIT::Push(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), DIALOG_FOOTPRINT_CHECKER::runChecks(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), GROUP_TOOL::Ungroup(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), and DIALOG_FOOTPRINT_CHECKER::~DIALOG_FOOTPRINT_CHECKER().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

142{ return m_flags; }

References EDA_ITEM::m_flags.

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

◆ GetFocusPosition()

const VECTOR2I BOARD::GetFocusPosition ( ) const

inlineoverridevirtual

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

Reimplemented from EDA_ITEM.

Definition at line 353 of file board.h.

353{ return GetBoundingBox().GetCenter(); }

BOARD::GetBoundingBox

const BOX2I GetBoundingBox() const override

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

Definition: board.h:809

References GetBoundingBox(), and BOX2< Vec >::GetCenter().

◆ GetFootprint()

FOOTPRINT * BOARD::GetFootprint	(	const VECTOR2I &	aPosition,
		PCB_LAYER_ID	aActiveLayer,
		bool	aVisibleOnly,
		bool	aIgnoreLocked = `false`
	)		const

Get a footprint by its bounding rectangle at aPosition on aLayer.

If more than one footprint is at aPosition, then the closest footprint on the active layer is returned. The distance is calculated via manhattan distance from the center of the bounding rectangle to aPosition.

Parameters

aPosition	A VECTOR2I object containing the position to test.
aActiveLayer	Layer to test.
aVisibleOnly	Search only the visible layers if true.
aIgnoreLocked	Ignore locked footprints when true.

Definition at line 1841 of file board.cpp.

{
 FOOTPRINT* footprint = nullptr;
 FOOTPRINT* alt_footprint = nullptr;
 int min_dim = 0x7FFFFFFF;
 int alt_min_dim = 0x7FFFFFFF;
 bool current_layer_back = IsBackLayer( aActiveLayer );
 
 for( FOOTPRINT* candidate : m_footprints )
 {
 // is the ref point within the footprint's bounds?
 if( !candidate->HitTest( aPosition ) )
 continue;
 
 // if caller wants to ignore locked footprints, and this one is locked, skip it.
 if( aIgnoreLocked && candidate->IsLocked() )
 continue;
 
 PCB_LAYER_ID layer = candidate->GetLayer();
 
 // Filter non visible footprints if requested
 if( !aVisibleOnly || IsFootprintLayerVisible( layer ) )
 {
 BOX2I bb = candidate->GetBoundingBox( false, false );
 
 int offx = bb.GetX() + bb.GetWidth() / 2;
 int offy = bb.GetY() + bb.GetHeight() / 2;
 
 // off x & offy point to the middle of the box.
 int dist = ( aPosition.x - offx ) * ( aPosition.x - offx ) +
 ( aPosition.y - offy ) * ( aPosition.y - offy );
 
 if( current_layer_back == IsBackLayer( layer ) )
 {
 if( dist <= min_dim )
 {
 // better footprint shown on the active side
 footprint = candidate;
 min_dim = dist;
 }
 }
 else if( aVisibleOnly && IsFootprintLayerVisible( layer ) )
 {
 if( dist <= alt_min_dim )
 {
 // better footprint shown on the other side
 alt_footprint = candidate;
 alt_min_dim = dist;
 }
 }
 }
 }
 
 if( footprint )
 return footprint;
 
 if( alt_footprint)
 return alt_footprint;
 
 return nullptr;
}

References BOX2< Vec >::GetHeight(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), IsBackLayer(), IsFootprintLayerVisible(), m_footprints, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TRACK, and ZONE.

Definition at line 310 of file eda_item.cpp.

{
 return GetTypeDesc();
}

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::rebuildProperties().

◆ GetGenerator()

const wxString & BOARD::GetGenerator ( ) const

inline

Adds an item to the container.

Parameters

aMode	decides whether the item is added in the beginning or at the end of the list.
aSkipConnectivity	skip connectivity update (useful for file loading, when the connectivity is updated after end of loading).

Definition at line 366 of file board.h.

References m_generator.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetHighLightNetCodes()

const std::set< int > & BOARD::GetHighLightNetCodes ( ) const

inline

Returns: the set of net codes that should be highlighted

Definition at line 472 of file board.h.

 {
 return m_highLight.m_netCodes;
 }

References m_highLight, and HIGH_LIGHT_INFO::m_netCodes.

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), and DIALOG_NET_INSPECTOR::OnBoardHighlightNetChanged().

◆ GetItem()

BOARD_ITEM * BOARD::GetItem ( const KIID & aID ) const

Returns: null if aID is null. Returns an object of Type() == NOT_USED if the aID is not found.

Definition at line 997 of file board.cpp.

{
 if( aID == niluuid )
 return nullptr;
 
 for( PCB_TRACK* track : Tracks() )
 {
 if( track->m_Uuid == aID )
 return track;
 }
 
 for( FOOTPRINT* footprint : Footprints() )
 {
 if( footprint->m_Uuid == aID )
 return footprint;
 
 for( PAD* pad : footprint->Pads() )
 {
 if( pad->m_Uuid == aID )
 return pad;
 }
 
 if( footprint->Reference().m_Uuid == aID )
 return &footprint->Reference();
 
 if( footprint->Value().m_Uuid == aID )
 return &footprint->Value();
 
 for( BOARD_ITEM* drawing : footprint->GraphicalItems() )
 {
 if( drawing->m_Uuid == aID )
 return drawing;
 }
 
 for( BOARD_ITEM* zone : footprint->Zones() )
 {
 if( zone->m_Uuid == aID )
 return zone;
 }
 
 for( PCB_GROUP* group : footprint->Groups() )
 {
 if( group->m_Uuid == aID )
 return group;
 }
 }
 
 for( ZONE* zone : Zones() )
 {
 if( zone->m_Uuid == aID )
 return zone;
 }
 
 for( BOARD_ITEM* drawing : Drawings() )
 {
 if( drawing->m_Uuid == aID )
 return drawing;
 }
 
 for( PCB_MARKER* marker : m_markers )
 {
 if( marker->m_Uuid == aID )
 return marker;
 }
 
 for( PCB_GROUP* group : m_groups )
 {
 if( group->m_Uuid == aID )
 return group;
 }
 
 if( m_Uuid == aID )
 return const_cast<BOARD*>( this );
 
 // Not found; weak reference has been deleted.
 return DELETED_BOARD_ITEM::GetInstance();
}

References Drawings(), Footprints(), DELETED_BOARD_ITEM::GetInstance(), group, m_groups, m_markers, EDA_ITEM::m_Uuid, niluuid, pad, Tracks(), and Zones().

Referenced by CollisionMatchesExpected(), ConvertKIIDsToCrossReferences(), PCB_BASE_FRAME::FocusOnItems(), PCB_BASE_FRAME::GetItem(), BOARD_INSPECTION_TOOL::InspectDRCError(), InvalidMatchesExpected(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), ResolveTextVar(), and DRC_TEST_PROVIDER_DISALLOW::Run().

◆ GetItemDescription()

wxString BOARD::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

Return a user-visible description string of this item.

This description is used in disambiguation menus, the message panel, ERC/DRC reports, etc.

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 950 of file board.cpp.

{
 return wxString::Format( _( "PCB" ) );
}

References _, and Format().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in FOOTPRINT, PAD, and ZONE.

Definition at line 180 of file board_item.h.

180{ return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:329

References BOARD_ITEM::m_layer.

Referenced by Add(), CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapes(), TEARDROP_MANAGER::addTeardropsOnTracks(), GRAPHICS_CLEANER::areEquivalent(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BuildBoardPolygonOutlines(), PNS::ITEM::collideSimple(), TEARDROP_MANAGER::ComputePointsOnPadVia(), CreateBoardSection(), PCB_BASE_FRAME::CreateNewFootprint(), TEARDROP_MANAGER::createTeardrop(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), TEARDROP_MANAGER::findTouchingTrack(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_SHAPE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), FootprintWriteShape(), PCB_PLUGIN::format(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetLayer(), PAD::GetLayer(), ZONE::GetLayer(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), GetPad(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), BOARD_ITEM::IsOnCopperLayer(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), TEARDROP_MANAGER::isViaAndTrackInSameZone(), itemIsIncludedByFilter(), FABMASTER::loadFootprints(), FABMASTER::loadOutline(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_TEXTBOX_PROPERTIES::onBorderChecked(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), DRC_ENGINE::ProcessAssertions(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_CONTROL::pruneItemLayers(), PAD_TOOL::RecombinePad(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::Selectable(), shapesNeedUpdate(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::SyncWorld(), DRC_TEST_PROVIDER_MISC::testTextVars(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), textsNeedUpdate(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolySet(), FOOTPRINT::TransformFPShapesToPolySet(), PCB_CONTROL::UpdateMessagePanel(), FP_TEXT::ViewGetLayers(), FP_TEXTBOX::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), FP_TEXT::ViewGetLOD(), FP_TEXTBOX::ViewGetLOD(), FP_ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetLayerID()

const PCB_LAYER_ID BOARD::GetLayerID ( const wxString & aLayerName ) const

Return the ID of a layer.

Definition at line 432 of file board.cpp.

{
 // Check the BOARD physical layer names.
 for( int layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
 {
 if ( m_layers[ layer ].m_name == aLayerName || m_layers[ layer ].m_userName == aLayerName )
 return ToLAYER_ID( layer );
 }
 
 // Otherwise fall back to the system standard layer names for virtual layers.
 for( int layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
 {
 if( GetStandardLayerName( ToLAYER_ID( layer ) ) == aLayerName )
 return ToLAYER_ID( layer );
 }
 
 return UNDEFINED_LAYER;
}

References GetStandardLayerName(), m_layers, PCB_LAYER_ID_COUNT, ToLAYER_ID(), and UNDEFINED_LAYER.

Referenced by PCB_EXPR_VAR_REF::GetValue(), and PCB_PARSER::parseBoardStackup().

◆ GetLayerName() [1/2]

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

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

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

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

◆ GetLayerName() [2/2]

wxString BOARD::GetLayerName ( PCB_LAYER_ID aLayer ) const

Return the name of a aLayer.

Parameters

aLayer is the PCB_LAYER_ID of the layer.

Returns: a string containing the name of the layer.

Definition at line 452 of file board.cpp.

{
 // All layer names are stored in the BOARD.
 if( IsLayerEnabled( aLayer ) )
 {
 // Standard names were set in BOARD::BOARD() but they may be over-ridden by
 // BOARD::SetLayerName(). For copper layers, return the user defined layer name,
 // if it was set. Otherwise return the Standard English layer name.
 if( !m_layers[aLayer].m_userName.IsEmpty() )
 return m_layers[aLayer].m_userName;
 }
 
 return GetStandardLayerName( aLayer );
}

References GetStandardLayerName(), IsLayerEnabled(), m_layers, and LAYER::m_userName.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DSN::SPECCTRA_DB::buildLayerMaps(), PCB_PROPERTIES_PANEL::createPGProperty(), PANEL_SETUP_BOARD_STACKUP::createRowData(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_PLOT::DIALOG_PLOT(), GRID_CELL_LAYER_RENDERER::Draw(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_PLUGIN::formatBoardLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), ZONE::GetItemDescription(), BOARD_ITEM::GetLayerName(), PCB_LAYER_BOX_SELECTOR::getLayerName(), PCB_LAYER_SELECTOR::getLayerName(), ZONE::GetMsgPanelInfo(), ZONE_SEARCH_HANDLER::GetResultCell(), GRID_CELL_LAYER_SELECTOR::GetValue(), PRIVATE_LAYERS_GRID_TABLE::GetValue(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::layerDesc(), DRC_TEST_PROVIDER_SLIVER_CHECKER::layerDesc(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), CADSTAR_PCB_ARCHIVE_LOADER::Load(), PCBNEW_PRINTOUT::OnPrintPage(), DIALOG_PLOT::Plot(), APPEARANCE_CONTROLS::rebuildLayers(), BOARD_INSPECTION_TOOL::reportHeader(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), ZONE_SETTINGS::SetupLayersList(), PANEL_SETUP_LAYERS::showBoardLayerNames(), StartPlotBoard(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), DIALOG_PAD_PROPERTIES::UpdateLayersDropdown(), HYPERLYNX_EXPORTER::writeDevices(), WriteDRCReport(), HYPERLYNX_EXPORTER::writeNetObjects(), HYPERLYNX_EXPORTER::writeSinglePadStack(), and HYPERLYNX_EXPORTER::writeStackupInfo().

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

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

Reimplemented in PCB_GROUP, PAD, PCB_VIA, and ZONE.

Definition at line 185 of file board_item.h.

 {
 if( m_layer == UNDEFINED_LAYER )
 return LSET();
 else
 return LSET( m_layer );
 }

References BOARD_ITEM::m_layer, and UNDEFINED_LAYER.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), KI_TEST::CheckFpShape(), collidesWithArea(), BOARD_COMMIT::dirtyIntersectingZones(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), existsOnLayerFunc(), extractDiffPairCoupledItems(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), hash_board_item(), BOARD_INSPECTION_TOOL::InspectClearance(), PNS_KICAD_IFACE::IsItemVisible(), isMaskAperture(), BOARD_ITEM::layerMaskDescribe(), FABMASTER::loadZone(), PCB_DIMENSION_BASE::Mirror(), PCB_GRID_HELPER::nearestAnchor(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), DRC_ENGINE::ProcessAssertions(), EDIT_TOOL::Properties(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetLayerType()

LAYER_T BOARD::GetLayerType ( PCB_LAYER_ID aLayer ) const

Return the type of the copper layer given by aLayer.

Parameters

aLayer A layer index, like B_Cu, etc.

Returns: the layer type, or LAYER_T(-1) if the index was out of range.

Definition at line 486 of file board.cpp.

{
 if( !IsCopperLayer( aLayer ) )
 return LT_SIGNAL;
 
 if( IsLayerEnabled( aLayer ) )
 return m_layers[aLayer].m_type;
 
 return LT_SIGNAL;
}

References IsCopperLayer(), IsLayerEnabled(), LT_SIGNAL, m_layers, and LAYER::m_type.

Referenced by PCB_PLUGIN::formatBoardLayers(), DSN::SPECCTRA_DB::FromBOARD(), GetGerberFileFunctionAttribute(), PANEL_SETUP_LAYERS::showLayerTypes(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ GetMenuImage()

BITMAPS EDA_ITEM::GetMenuImage ( ) const

virtualinherited

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 in LIB_FIELD, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_WIRE_ENTRY, SCH_BUS_BUS_ENTRY, SCH_FIELD, SCH_JUNCTION, SCH_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 269 of file eda_item.cpp.

{
 return BITMAPS::dummy_item;
}

References dummy_item.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1292 of file board.cpp.

{
 int padCount = 0;
 int viaCount = 0;
 int trackSegmentCount = 0;
 std::set<int> netCodes;
 int unconnected = GetConnectivity()->GetUnconnectedCount( true );
 
 for( PCB_TRACK* item : m_tracks )
 {
 if( item->Type() == PCB_VIA_T )
 viaCount++;
 else
 trackSegmentCount++;
 
 if( item->GetNetCode() > 0 )
 netCodes.insert( item->GetNetCode() );
 }
 
 for( FOOTPRINT* footprint : Footprints() )
 {
 for( PAD* pad : footprint->Pads() )
 {
 padCount++;
 
 if( pad->GetNetCode() > 0 )
 netCodes.insert( pad->GetNetCode() );
 }
 }
 
 aList.emplace_back( _( "Pads" ), wxString::Format( wxT( "%d" ), padCount ) );
 aList.emplace_back( _( "Vias" ), wxString::Format( wxT( "%d" ), viaCount ) );
 aList.emplace_back( _( "Track Segments" ), wxString::Format( wxT( "%d" ), trackSegmentCount ) );
 aList.emplace_back( _( "Nets" ), wxString::Format( wxT( "%d" ), (int) netCodes.size() ) );
 aList.emplace_back( _( "Unrouted" ), wxString::Format( wxT( "%d" ), unconnected ) );
}

References _, Footprints(), Format(), GetConnectivity(), m_tracks, pad, and PCB_VIA_T.

Referenced by PCB_CONTROL::UpdateMessagePanel().

◆ GetNetClassAssignmentCandidates()

std::set< wxString > BOARD::GetNetClassAssignmentCandidates ( ) const

Return the set of netname candidates for netclass assignment.

Definition at line 1501 of file board.cpp.

{
 std::set<wxString> names;
 
 for( const NETINFO_ITEM* net : m_NetInfo )
 {
 if( !net->GetNetname().IsEmpty() )
 names.insert( net->GetNetname() );
 }
 
 return names;
}

References m_NetInfo.

Referenced by DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), and PANEL_SETUP_RULES::onScintillaCharAdded().

◆ GetNetCount()

unsigned BOARD::GetNetCount ( ) const

inline

Returns: the number of nets (NETINFO_ITEM).

Definition at line 796 of file board.h.

 {
 return m_NetInfo.GetNetCount();
 }

References NETINFO_LIST::GetNetCount(), and m_NetInfo.

Referenced by CreateSignalsSection(), and PCB_PARSER::parseZONE().

◆ GetNetInfo() [1/2]

NETINFO_LIST & BOARD::GetNetInfo ( )

inline

Definition at line 770 of file board.h.

 {
 return m_NetInfo;
 }

References m_NetInfo.

◆ GetNetInfo() [2/2]

const NETINFO_LIST & BOARD::GetNetInfo ( ) const

inline

Definition at line 765 of file board.h.

 {
 return m_NetInfo;
 }

References m_NetInfo.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), BOOST_AUTO_TEST_CASE(), CONNECTIVITY_DATA::Build(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_NET_INSPECTOR::buildNetsList(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DSN::SPECCTRA_DB::exportNETCLASS(), DSN::SPECCTRA_DB::FromBOARD(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), FABMASTER::loadEtch(), FABMASTER::loadFootprints(), PCB_EDIT_FRAME::LoadProjectSettings(), FABMASTER::loadVias(), FABMASTER::loadZone(), FABMASTER::loadZones(), main(), APPEARANCE_CONTROLS::onNetclassContextMenu(), DIALOG_NET_INSPECTOR::onRenameNet(), DIALOG_COPPER_ZONE::readNetInformation(), NET_GRID_TABLE::Rebuild(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_FIND::search(), NETS_SEARCH_HANDLER::Search(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), APPEARANCE_CONTROLS::showNetclass(), TestForExistingItem(), PCB_PROPERTIES_PANEL::updateLists(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and HYPERLYNX_EXPORTER::writeNets().

◆ GetNodesCount()

unsigned BOARD::GetNodesCount ( int aNet = -1 ) const

Parameters

aNet	Only count nodes belonging to this net.

Returns: the number of pads members of nets (i.e. with netcode > 0).

Definition at line 1214 of file board.cpp.

{
 unsigned retval = 0;
 
 for( FOOTPRINT* footprint : Footprints() )
 {
 for( PAD* pad : footprint->Pads() )
 {
 if( ( aNet == -1 && pad->GetNetCode() > 0 ) || aNet == pad->GetNetCode() )
 retval++;
 }
 }
 
 return retval;
}

References Footprints(), and pad.

Referenced by DIALOG_NET_INSPECTOR::OnBoardItemAdded(), and DIALOG_NET_INSPECTOR::updateNet().

◆ GetPad() [1/4]

PAD * BOARD::GetPad	(	const PCB_TRACK *	aTrace,
		ENDPOINT_T	aEndPoint
	)		const

Find a pad connected to aEndPoint of aTrace.

Parameters

aTrace	A pointer to a PCB_TRACK object to hit test against.
aEndPoint	The end point of aTrace the hit test against.

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

Definition at line 1606 of file board.cpp.

{
 const VECTOR2I& aPosition = aTrace->GetEndPoint( aEndPoint );
 
 LSET lset( aTrace->GetLayer() );
 
 return GetPad( aPosition, lset );
}

References PCB_TRACK::GetEndPoint(), BOARD_ITEM::GetLayer(), and GetPad().

◆ GetPad() [2/4]

PAD * BOARD::GetPad ( const VECTOR2I & aPosition ) const

inline

Definition at line 967 of file board.h.

 {
 return GetPad( aPosition, LSET().set() );
 }

References GetPad().

◆ GetPad() [3/4]

PAD * BOARD::GetPad	(	const VECTOR2I &	aPosition,
		LSET	aLayerMask
	)		const

Find a pad aPosition on aLayer.

Parameters

aPosition	A VECTOR2I 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 or NULL if not found.

Definition at line 1586 of file board.cpp.

{
 if( !aLayerSet.any() )
 aLayerSet = LSET::AllCuMask();
 
 for( FOOTPRINT* footprint : m_footprints )
 {
 PAD* pad = nullptr;
 
 if( footprint->HitTest( aPosition ) )
 pad = footprint->GetPad( aPosition, aLayerSet );
 
 if( pad )
 return pad;
 }
 
 return nullptr;
}

References LSET::AllCuMask(), m_footprints, and pad.

Referenced by GetPad().

◆ GetPad() [4/4]

PAD * BOARD::GetPad	(	std::vector< PAD * > &	aPadList,
		const VECTOR2I &	aPosition,
		LSET	aLayerMask
	)		const

Locate the pad connected at aPosition on aLayer starting at list position aPad.

This function uses a fast search in this sorted pad list and it is faster than GetPadFast(). This list is a sorted pad list must be built before calling this function.

Note: The normal pad list is sorted by increasing netcodes.

Parameters

aPadList	is the list of pads candidates (a std::vector<PAD*>).
aPosition	A VECTOR2I object containing the position to test.
aLayerMask	A layer or layers to mask the hit test.

Returns: a PAD object pointer to the connected pad.

Definition at line 1635 of file board.cpp.

{
 // Search aPadList for aPosition
 // aPadList is sorted by X then Y values, and a fast binary search is used
 int idxmax = aPadList.size() - 1;
 
 int delta = aPadList.size();
 
 int idx = 0; // Starting index is the beginning of list
 
 while( delta )
 {
 // Calculate half size of remaining interval to test.
 // Ensure the computed value is not truncated (too small)
 if( (delta & 1) && ( delta > 1 ) )
 delta++;
 
 delta /= 2;
 
 PAD* pad = aPadList[idx];
 
 if( pad->GetPosition() == aPosition ) // candidate found
 {
 // The pad must match the layer mask:
 if( ( aLayerSet & pad->GetLayerSet() ).any() )
 return pad;
 
 // More than one pad can be at aPosition
 // search for a pad at aPosition that matched this mask
 
 // search next
 for( int ii = idx+1; ii <= idxmax; ii++ )
 {
 pad = aPadList[ii];
 
 if( pad->GetPosition() != aPosition )
 break;
 
  if( ( aLayerSet & pad->GetLayerSet() ).any() )
 return pad;
 }
 // search previous
 for( int ii = idx - 1 ;ii >=0; ii-- )
 {
 pad = aPadList[ii];
 
 if( pad->GetPosition() != aPosition )
 break;
 
 if( ( aLayerSet & pad->GetLayerSet() ).any() )
 return pad;
 }
 
 // Not found:
 return nullptr;
 }
 
 if( pad->GetPosition().x == aPosition.x ) // Must search considering Y coordinate
 {
 if( pad->GetPosition().y < aPosition.y ) // Must search after this item
 {
 idx += delta;
 
 if( idx > idxmax )
 idx = idxmax;
 }
 else // Must search before this item
 {
 idx -= delta;
 
 if( idx < 0 )
 idx = 0;
 }
 }
 else if( pad->GetPosition().x < aPosition.x ) // Must search after this item
 {
 idx += delta;
 
 if( idx > idxmax )
 idx = idxmax;
 }
 else // Must search before this item
 {
 idx -= delta;
 
 if( idx < 0 )
 idx = 0;
 }
 }
 
 return nullptr;
}

References delta, pad, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetPadFast()

PAD * BOARD::GetPadFast	(	const VECTOR2I &	aPosition,
		LSET	aLayerMask
	)		const

Return pad found at aPosition on aLayerMask using the fast search method.

The fast search method only works if the pad list has already been built.

Parameters

aPosition	A VECTOR2I 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 or NULL if not found.

Definition at line 1616 of file board.cpp.

{
 for( FOOTPRINT* footprint : Footprints() )
 {
 for( PAD* pad : footprint->Pads() )
 {
 if( pad->GetPosition() != aPosition )
 continue;
 
 // Pad found, it must be on the correct layer
 if( ( pad->GetLayerSet() & aLayerSet ).any() )
 return pad;
 }
 }
 
 return nullptr;
}

References Footprints(), and pad.

◆ GetPads()

const std::vector< PAD * > BOARD::GetPads ( ) const

Return a reference to a list of all the pads.

The returned list is not sorted and contains pointers to PADS, but those pointers do not convey ownership of the respective PADs.

Returns: a full list of pads.

Definition at line 1965 of file board.cpp.

{
 std::vector<PAD*> allPads;
 
 for( FOOTPRINT* footprint : Footprints() )
 {
 for( PAD* pad : footprint->Pads() )
 allPads.push_back( pad );
 }
 
 return allPads;
}

References Footprints(), and pad.

Referenced by CreatePadsShapesSection(), and DIALOG_COPPER_ZONE::sortNetsByPadCount().

◆ GetPageSettings()

const PAGE_INFO & BOARD::GetPageSettings ( ) const

inline

Definition at line 626 of file board.h.

626{ return m_paper; }

References m_paper.

Referenced by PCB_CONTROL::AppendBoard(), BOARD_NETLIST_UPDATER::estimateFootprintInsertionPosition(), PCB_PLUGIN::formatGeneral(), PCB_BASE_FRAME::GetPageSettings(), PCB_BASE_FRAME::GetPageSizeIU(), initializePlotter(), ALTIUM_PCB::Parse(), PCB_PLOT_SVG::Plot(), PCB_EDIT_FRAME::RebuildAndRefresh(), PCB_EDIT_FRAME::SetBoard(), PCB_EDIT_FRAME::SetPageSettings(), and StartPlotBoard().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 163 of file board_item.h.

163{ return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:496

References EDA_ITEM::m_parent.

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 239 of file board_item.cpp.

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

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

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

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 72 of file board_item.h.

72{ return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:334

References BOARD_ITEM::m_group.

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

◆ GetPlotOptions()

const PCB_PLOT_PARAMS & BOARD::GetPlotOptions ( ) const

inline

Definition at line 629 of file board.h.

629{ return m_plotOptions; }

BOARD::m_plotOptions

PCB_PLOT_PARAMS m_plotOptions

Definition: board.h:1197

References m_plotOptions.

Referenced by AddGerberX2Header(), BOARD_ADAPTER::addShape(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), PCB_PLUGIN::formatSetup(), PCB_BASE_FRAME::GetPlotSettings(), PANEL_SETUP_FORMATTING::ImportSettingsFrom(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), and DIALOG_GENDRILL::UpdateDrillParams().

◆ GetPosition()

VECTOR2I BOARD::GetPosition ( ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 367 of file board.cpp.

{
 return ZeroOffset;
}

References BOARD_ITEM::ZeroOffset.

◆ GetProject()

PROJECT * BOARD::GetProject ( ) const

inline

◆ GetProperties()

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

inline

Definition at line 332 of file board.h.

332{ return m_properties; }

BOARD::m_properties

std::map< wxString, wxString > m_properties

Definition: board.h:1192

References m_properties.

Referenced by PCB_CONTROL::AppendBoard(), PCB_PLUGIN::formatProperties(), PCB_EDIT_FRAME::SetPageSettings(), and StartPlotBoard().

◆ GetSortedPadListByXthenYCoord()

void BOARD::GetSortedPadListByXthenYCoord	(	std::vector< PAD * > &	aVector,
		int	aNetCode = `-1`
	)		const

First empties then fills the vector with all pads and sorts them by increasing x coordinate, and for increasing y coordinate for same values of x coordinates.

The vector only holds pointers to the pads and those pointers are only references to pads which are owned by the BOARD through other links.

Parameters

aVector	Where to put the pad pointers.
aNetCode	= the netcode filter: = -1 to build the full pad list. = a given netcode to build the pad list relative to the given net

Definition at line 1743 of file board.cpp.

{
 for( FOOTPRINT* footprint : Footprints() )
 {
 for( PAD* pad : footprint->Pads( ) )
 {
 if( aNetCode < 0 || pad->GetNetCode() == aNetCode )
 aVector.push_back( pad );
 }
 }
 
 std::sort( aVector.begin(), aVector.end(), sortPadsByXthenYCoord );
}

References Footprints(), pad, and sortPadsByXthenYCoord().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 265 of file eda_item.h.

265{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

◆ GetStandardLayerName()

static wxString BOARD::GetStandardLayerName ( PCB_LAYER_ID aLayerId )

inlinestatic

Return an "English Standard" name of a PCB layer when given aLayerNumber.

This function is static so it can be called without a BOARD instance. Use GetLayerName() if want the layer names of a specific BOARD, which could be different than the default if the user has renamed any copper layers.

Parameters

aLayerId is the layer identifier (index) to fetch.

Returns: a string containing the layer name or "BAD INDEX" if aLayerId is not legal.

Definition at line 696 of file board.h.

 {
 // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
 return LayerName( aLayerId );
 }

References LayerName().

Referenced by BOARD(), GRID_CELL_LAYER_RENDERER::Draw(), DIALOG_EXPORT_SVG::ExportSVGFile(), GetLayerID(), BOARD_ITEM::GetLayerName(), PCB_LAYER_BOX_SELECTOR::getLayerName(), GetLayerName(), and GRID_CELL_LAYER_SELECTOR::GetValue().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 123 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

136{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 82 of file board_item.cpp.

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

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

Referenced by CONVERT_TOOL::CreatePolys(), and PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog().

◆ GetTentVias()

bool BOARD::GetTentVias ( ) const

inline

Definition at line 623 of file board.h.

623{ return !m_plotOptions.GetPlotViaOnMaskLayer(); }

PCB_PLOT_PARAMS::GetPlotViaOnMaskLayer

bool GetPlotViaOnMaskLayer() const

Definition: pcb_plot_params.h:115

References PCB_PLOT_PARAMS::GetPlotViaOnMaskLayer(), and m_plotOptions.

Referenced by PCB_VIA::IsTented(), and PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow().

◆ GetTimeStamp()

int BOARD::GetTimeStamp ( ) const

inline

Definition at line 288 of file board.h.

288{ return m_timeStamp; }

References m_timeStamp.

Referenced by FOOTPRINT::BuildCourtyardCaches(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), and DRC_ENGINE::RunTests().

◆ GetTitleBlock() [1/2]

TITLE_BLOCK & BOARD::GetTitleBlock ( )

inline

Definition at line 632 of file board.h.

632{ return m_titles; }

BOARD::m_titles

TITLE_BLOCK m_titles

Definition: board.h:1196

References m_titles.

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), PCB_CONTROL::AppendBoard(), CreateHeaderInfoData(), PCB_PLUGIN::formatGeneral(), PCB_BASE_FRAME::GetTitleBlock(), ResolveTextVar(), PCB_EDIT_FRAME::SetPageSettings(), and StartPlotBoard().

◆ GetTitleBlock() [2/2]

const TITLE_BLOCK & BOARD::GetTitleBlock ( ) const

inline

Definition at line 633 of file board.h.

633{ return m_titles; }

References m_titles.

◆ GetTrackLength()

std::tuple< int, double, double > BOARD::GetTrackLength ( const PCB_TRACK & aTrack ) const

Return data on the length and number of track segments connected to a given track.

This uses the connectivity data for the board to calculate connections

Parameters

aTrack Starting track (can also be a via) to check against for connection.

Returns: a tuple containing <number, length, package length>

Definition at line 1758 of file board.cpp.

{
 int count = 0;
 double length = 0.0;
 double package_length = 0.0;
 
 auto connectivity = GetBoard()->GetConnectivity();
 BOARD_STACKUP& stackup = GetDesignSettings().GetStackupDescriptor();
 bool useHeight = GetDesignSettings().m_UseHeightForLengthCalcs;
 
 for( BOARD_CONNECTED_ITEM* item : connectivity->GetConnectedItems(
 static_cast<const BOARD_CONNECTED_ITEM*>( &aTrack ),
 { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T, PCB_PAD_T } ) )
 {
 count++;
 
 if( PCB_TRACK* track = dynamic_cast<PCB_TRACK*>( item ) )
 {
 if( track->Type() == PCB_VIA_T && useHeight )
 {
 PCB_VIA* via = static_cast<PCB_VIA*>( track );
 length += stackup.GetLayerDistance( via->TopLayer(), via->BottomLayer() );
 continue;
 }
 else if( track->Type() == PCB_ARC_T )
 {
 // Note: we don't apply the clip-to-pad optimization if an arc ends in a pad
 // Room for future improvement.
 length += track->GetLength();
 continue;
 }
 
 bool inPad = false;
 SEG trackSeg( track->GetStart(), track->GetEnd() );
 double segLen = trackSeg.Length();
 double segInPadLen = 0;
 
 for( auto pad_it : connectivity->GetConnectedPads( item ) )
 {
 PAD* pad = static_cast<PAD*>( pad_it );
 
 bool hitStart = pad->HitTest( track->GetStart(), track->GetWidth() / 2 );
 bool hitEnd = pad->HitTest( track->GetEnd(), track->GetWidth() / 2 );
 
 if( hitStart && hitEnd )
 {
 inPad = true;
 break;
 }
 else if( hitStart || hitEnd )
 {
 VECTOR2I loc;
 
 // We may not collide even if we passed the bounding-box hit test
 if( pad->GetEffectivePolygon()->Collide( trackSeg, 0, nullptr, &loc ) )
 {
 // Part 1: length of the seg to the intersection with the pad poly
 if( hitStart )
 trackSeg.A = loc;
 else
 trackSeg.B = loc;
 
 segLen = trackSeg.Length();
 
 // Part 2: length from the intersection to the pad anchor
 segInPadLen += ( loc - pad->GetPosition() ).EuclideanNorm();
 }
 }
 }
 
 if( !inPad )
 length += segLen + segInPadLen;
 }
 else if( PAD* pad = dyn_cast<PAD*>( item ) )
 {
 package_length += pad->GetPadToDieLength();
 }
 }
 
 return std::make_tuple( count, length, package_length );
}

References SEG::A, SEG::B, EuclideanNorm(), BOARD_ITEM::GetBoard(), GetConnectivity(), GetDesignSettings(), BOARD_STACKUP::GetLayerDistance(), BOARD_DESIGN_SETTINGS::GetStackupDescriptor(), SEG::Length(), BOARD_DESIGN_SETTINGS::m_UseHeightForLengthCalcs, pad, PCB_ARC_T, PCB_VIA_T, and via.

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

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

Definition at line 301 of file eda_item.cpp.

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

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

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::doMoveSelection(), and EDA_ITEM::GetFriendlyName().

◆ GetVisibleElements()

GAL_SET BOARD::GetVisibleElements ( ) const

Return a set of all the element categories that are visible.

Returns: the set of visible GAL layers.

See also: enum GAL_LAYER_ID

Definition at line 625 of file board.cpp.

{
 return m_project ? m_project->GetLocalSettings().m_VisibleItems : GAL_SET().set();
}

References PROJECT::GetLocalSettings(), m_project, PROJECT_LOCAL_SETTINGS::m_VisibleItems, and GAL_SET::set().

Referenced by APPEARANCE_CONTROLS::getVisibleObjects(), and PCB_EDIT_FRAME::setupUIConditions().

◆ GetVisibleLayers()

LSET BOARD::GetVisibleLayers ( ) const

A proxy function that calls the correspondent function in m_BoardSettings.

Returns: the visible layers in bit-mapped form.

Definition at line 579 of file board.cpp.

{
 return m_project ? m_project->GetLocalSettings().m_VisibleLayers : LSET::AllLayersMask();
}

References LSET::AllLayersMask(), PROJECT::GetLocalSettings(), m_project, and PROJECT_LOCAL_SETTINGS::m_VisibleLayers.

Referenced by ComputeBoundingBox(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), GENDRILL_WRITER_BASE::genDrillMapFile(), PCB_BASE_FRAME::GetCollectorsGuide(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), APPEARANCE_CONTROLS::getVisibleLayers(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::Selectable(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), PAD::ViewGetLOD(), and PCB_VIA::ViewGetLOD().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 76 of file board_item.h.

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

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

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 82 of file board_item.h.

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

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

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

◆ GetZoneList()

std::list< ZONE * > BOARD::GetZoneList ( bool aIncludeZonesInFootprints = false ) const

Returns: a std::list of pointers to all board zones (possibly including zones in footprints)

Definition at line 1905 of file board.cpp.

{
 std::list<ZONE*> zones;
 
 for( ZONE* zone : Zones() )
 zones.push_back( zone );
 
 if( aIncludeZonesInFootprints )
 {
 for( FOOTPRINT* footprint : m_footprints )
 {
 for( FP_ZONE* zone : footprint->Zones() )
 zones.push_back( zone );
 }
 }
 
 return zones;
}

References m_footprints, and Zones().

◆ GetZoneSettings()

const ZONE_SETTINGS & BOARD::GetZoneSettings ( ) const

overridevirtual

Fetch the zone settings for this container.

Reimplemented from BOARD_ITEM_CONTAINER.

Definition at line 688 of file board.cpp.

{
 return GetDesignSettings().GetDefaultZoneSettings();
}

References BOARD_DESIGN_SETTINGS::GetDefaultZoneSettings(), and GetDesignSettings().

Referenced by LEGACY_PLUGIN::loadSETUP().

◆ GroupLegalOps()

BOARD::GroupLegalOpsField BOARD::GroupLegalOps ( const PCB_SELECTION & selection ) const

Check which selection tool group operations are legal given the selection.

Returns: bit field of legal ops.

Definition at line 2171 of file board.cpp.

{
 bool hasGroup = false;
 bool hasMember = false;
 
 for( EDA_ITEM* item : selection )
 {
 if( item->Type() == PCB_GROUP_T )
 hasGroup = true;
 
 if( static_cast<BOARD_ITEM*>( item )->GetParentGroup() )
 hasMember = true;
 }
 
 GroupLegalOpsField legalOps;
 
 legalOps.create = true;
 legalOps.removeItems = hasMember;
 legalOps.ungroup = hasGroup;
 
 return legalOps;
}

References BOARD::GroupLegalOpsField::create, BOARD_ITEM::GetParentGroup(), PCB_GROUP_T, BOARD::GroupLegalOpsField::removeItems, and BOARD::GroupLegalOpsField::ungroup.

◆ Groups() [1/2]

GROUPS & BOARD::Groups ( )

inline

The groups must maintain the following invariants.

These are checked by GroupsSanityCheck():

An item may appear in at most one group
Each group must contain at least one item
If a group specifies a name, it must be unique
The graph of groups containing subgroups must be cyclic.

Definition at line 327 of file board.h.

327{ return m_groups; }

References m_groups.

Referenced by PCB_CONTROL::AppendBoard(), PCB_PLUGIN::format(), GroupsSanityCheckInternal(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), and TestForExistingItem().

◆ Groups() [2/2]

const GROUPS & BOARD::Groups ( ) const

inline

Definition at line 328 of file board.h.

328{ return m_groups; }

References m_groups.

◆ GroupsSanityCheck()

wxString BOARD::GroupsSanityCheck ( bool repair = false )

Consistency check of internal m_groups structure.

Parameters

repair if true, modify groups structure until it passes the sanity check.

Returns: empty string on success. Or error description if there's a problem.

Definition at line 2092 of file board.cpp.

{
 if( repair )
 {
 while( GroupsSanityCheckInternal( repair ) != wxEmptyString )
 {};
 
 return wxEmptyString;
 }
 return GroupsSanityCheckInternal( repair );
}

References GroupsSanityCheckInternal().

Referenced by PCB_PARSER::resolveGroups(), and PCB_PLUGIN::Save().

◆ GroupsSanityCheckInternal()

wxString BOARD::GroupsSanityCheckInternal ( bool repair )

Parameters

repair if true, make one modification to groups structure that brings it closer to passing the sanity check.

Returns: empty string on success. Or error description if there's a problem.

Definition at line 2105 of file board.cpp.

{
 // Cycle detection
 //
 // Each group has at most one parent group.
 // So we start at group 0 and traverse the parent chain, marking groups seen along the way.
 // If we ever see a group that we've already marked, that's a cycle.
 // If we reach the end of the chain, we know all groups in that chain are not part of any cycle.
 //
 // Algorithm below is linear in the # of groups because each group is visited only once.
 // There may be extra time taken due to the container access calls and iterators.
 //
 // Groups we know are cycle free
 std::unordered_set<PCB_GROUP*> knownCycleFreeGroups;
 // Groups in the current chain we're exploring.
 std::unordered_set<PCB_GROUP*> currentChainGroups;
 // Groups we haven't checked yet.
 std::unordered_set<PCB_GROUP*> toCheckGroups;
 
 // Initialize set of groups to check that could participate in a cycle.
 for( PCB_GROUP* group : Groups() )
 toCheckGroups.insert( group);
 
 while( !toCheckGroups.empty() )
 {
 currentChainGroups.clear();
 PCB_GROUP* group = *toCheckGroups.begin();
 
 while( true )
 {
 if( currentChainGroups.find( group ) != currentChainGroups.end() )
 {
 if( repair )
 Remove( group );
 
 return "Cycle detected in group membership";
 }
 else if( knownCycleFreeGroups.find( group ) != knownCycleFreeGroups.end() )
 {
 // Parent is a group we know does not lead to a cycle
 break;
 }
 
 currentChainGroups.insert( group );
 // We haven't visited currIdx yet, so it must be in toCheckGroups
 toCheckGroups.erase( group );
 
 group = group->GetParentGroup();
 
 if( !group )
 {
 // end of chain and no cycles found in this chain
 break;
 }
 }
 
 // No cycles found in chain, so add it to set of groups we know don't participate
 // in a cycle.
 knownCycleFreeGroups.insert( currentChainGroups.begin(), currentChainGroups.end() );
 }
 
 // Success
 return "";
}

References group, Groups(), and Remove().

Referenced by GroupsSanityCheck().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 143 of file eda_item.h.

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

References EDA_ITEM::m_flags.

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

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 128 of file board_item.h.

 {
 return false;
 }

Referenced by DRAWING_TOOL::DrawVia(), hasDrilledHole(), DRC_RTREE::Insert(), BOARD_INSPECTION_TOOL::InspectClearance(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and PCB_CONTROL::UpdateMessagePanel().

◆ HasLineStroke()

virtual bool BOARD_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this item has line stoke properties.

See also: STROKE_PARAMS

Reimplemented in PCB_SHAPE.

Definition at line 172 of file board_item.h.

172{ return false; }

◆ HighLightOFF()

void BOARD::HighLightOFF ( )

inline

Disable net highlight.

Definition at line 502 of file board.h.

 {
 HighLightON( false );
 }

References HighLightON().

◆ HighLightON()

void BOARD::HighLightON ( bool aValue = true )

Enable or disable net highlighting.

If a netcode >= 0 has been set with SetHighLightNet and aValue is true, the net will be highlighted. If aValue is false, net highlighting will be disabled regardless of the highlight netcode being set.

Definition at line 2082 of file board.cpp.

{
 if( m_highLight.m_highLightOn != aValue )
 {
 m_highLight.m_highLightOn = aValue;
 InvokeListeners( &BOARD_LISTENER::OnBoardHighlightNetChanged, *this );
 }
}

References InvokeListeners(), m_highLight, HIGH_LIGHT_INFO::m_highLightOn, and BOARD_LISTENER::OnBoardHighlightNetChanged().

Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), BOARD_INSPECTION_TOOL::highlightNet(), HighLightOFF(), and APPEARANCE_CONTROLS::onNetclassContextMenu().

◆ HitTest() [1/2]

virtual bool EDA_ITEM::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

inlinevirtualinherited

Test if aRect intersects this item.

Parameters

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

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

Reimplemented in LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, FP_TEXT, FP_TEXTBOX, PAD, PCB_BITMAP, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, PCB_ARC, ZONE, and GERBER_DRAW_ITEM.

Definition at line 235 of file eda_item.h.

 {
 return false; // derived classes should override this function
 }

◆ HitTest() [2/2]

virtual bool EDA_ITEM::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy = `0`
	)		const

inlinevirtualinherited

Test if aPosition is inside or on the boundary of this item.

Parameters

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

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

Reimplemented in RATSNEST_VIEW_ITEM, SCH_SHEET, FP_TEXT, FP_TEXTBOX, PCB_DIMENSION_BASE, PCB_TEXT, PCB_TEXTBOX, LIB_FIELD, LIB_ITEM, LIB_PIN, LIB_SHAPE, LIB_TEXT, LIB_TEXTBOX, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_MARKER, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, DS_DRAW_ITEM_BASE, DS_DRAW_ITEM_LINE, DS_DRAW_ITEM_POLYPOLYGONS, DS_DRAW_ITEM_RECT, DS_DRAW_ITEM_PAGE, DS_DRAW_ITEM_TEXT, DS_DRAW_ITEM_BITMAP, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_MARKER, PCB_SHAPE, PCB_TARGET, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and GERBER_DRAW_ITEM.

Definition at line 222 of file eda_item.h.

 {
 return false; // derived classes should override this function
 }

Referenced by PCB_GRID_HELPER::AlignToNearestPad(), PL_SELECTION_TOOL::guessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), LIB_ITEM::HitTest(), DS_DRAW_ITEM_BASE::HitTest(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_SELECTION_TOOL::selectionContains(), and PCB_SELECTION_TOOL::selectMultiple().

◆ IncrementTimeStamp()

void BOARD::IncrementTimeStamp ( )

Definition at line 226 of file board.cpp.

{
 m_timeStamp++;
 
 if( !m_IntersectsAreaCache.empty()
 || !m_EnclosedByAreaCache.empty()
 || !m_IntersectsCourtyardCache.empty()
 || !m_IntersectsFCourtyardCache.empty()
 || !m_IntersectsBCourtyardCache.empty()
 || !m_LayerExpressionCache.empty()
 || !m_ZoneBBoxCache.empty() )
 {
 std::unique_lock<std::mutex> cacheLock( m_CachesMutex );
 
 m_IntersectsAreaCache.clear();
 m_EnclosedByAreaCache.clear();
 m_IntersectsCourtyardCache.clear();
 m_IntersectsFCourtyardCache.clear();
 m_IntersectsBCourtyardCache.clear();
 m_LayerExpressionCache.clear();
 
 m_ZoneBBoxCache.clear();
 
 // These are always regenerated before use, but still probably safer to clear them
 // while we're here.
 m_DRCMaxClearance = 0;
 m_DRCMaxPhysicalClearance = 0;
 m_DRCZones.clear();
 m_DRCCopperZones.clear();
 m_CopperZoneRTreeCache.clear();
 m_CopperItemRTreeCache = std::make_unique<DRC_RTREE>();
 }
 else if( !m_CopperItemRTreeCache )
 {
 std::unique_lock<std::mutex> cacheLock( m_CachesMutex );
 m_CopperItemRTreeCache = std::make_unique<DRC_RTREE>();
 }
}

References m_CachesMutex, m_CopperItemRTreeCache, m_CopperZoneRTreeCache, m_DRCCopperZones, m_DRCMaxClearance, m_DRCMaxPhysicalClearance, m_DRCZones, m_EnclosedByAreaCache, m_IntersectsAreaCache, m_IntersectsBCourtyardCache, m_IntersectsCourtyardCache, m_IntersectsFCourtyardCache, m_LayerExpressionCache, m_timeStamp, and m_ZoneBBoxCache.

Referenced by ZONE_FILLER_TOOL::FillAllZones(), DRC_ENGINE::InitEngine(), PCB_BASE_FRAME::OnModify(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::Revert(), DRC_ENGINE::RunTests(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ InvokeListeners()

template<typename Func , typename... Args>

void BOARD::InvokeListeners	(	Func &&	aFunc,
		Args &&...	args
	)

inlineprivate

Definition at line 1164 of file board.h.

 {
 for( auto&& l : m_listeners )
 ( l->*aFunc )( std::forward<Args>( args )... );
 }

References m_listeners.

Referenced by Add(), FinalizeBulkAdd(), FinalizeBulkRemove(), HighLightON(), OnItemChanged(), OnItemsChanged(), Remove(), ResetNetHighLight(), SetHighLightNet(), and SynchronizeNetsAndNetClasses().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_FIND_REPLACE_TOOL::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 BOARD_CONNECTED_ITEM, and ZONE.

Definition at line 115 of file board_item.h.

 {
 return false;
 }

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), DRC_ENGINE::EvalRules(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), inDiffPairFunc(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), and DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones().

◆ IsElementVisible()

bool BOARD::IsElementVisible ( GAL_LAYER_ID aLayer ) const

Test whether a given element category is visible.

Parameters

aLayer is from the enum by the same name.

Returns: true if the element is visible otherwise false.

See also: enum GAL_LAYER_ID

Definition at line 631 of file board.cpp.

{
 return !m_project || m_project->GetLocalSettings().m_VisibleItems[aLayer - GAL_LAYER_ID_START];
}

References GAL_LAYER_ID_START, PROJECT::GetLocalSettings(), m_project, and PROJECT_LOCAL_SETTINGS::m_VisibleItems.

Referenced by ComputeBoundingBox(), KIGFX::PCB_PAINTER::draw(), FOOTPRINT::GetBoundingBox(), PCB_BASE_FRAME::GetCollectorsGuide(), PCB_SELECTION_TOOL::getCollectorsGuide(), PCB_EDIT_FRAME::IsElementVisible(), IsFootprintLayerVisible(), PCB_SELECTION_TOOL::Selectable(), PCBNEW_PRINTOUT::setupViewLayers(), and PCB_DRAW_PANEL_GAL::SyncLayersVisibility().

◆ IsEmpty()

bool BOARD::IsEmpty ( ) const

inline

Definition at line 355 of file board.h.

 {
 return m_drawings.empty() && m_footprints.empty() && m_tracks.empty() && m_zones.empty();
 }

References m_drawings, m_footprints, m_tracks, and m_zones.

Referenced by BOARD_NETLIST_UPDATER::estimateFootprintInsertionPosition(), PCB_EDITOR_CONDITIONS::hasItemsFunc(), EDIT_TOOL::Init(), and DIALOG_BOARD_REANNOTATE::OnApplyClick().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsFootprintHolder()

bool BOARD::IsFootprintHolder ( ) const

inline

Find out if the board is being used to hold a single footprint for editing/viewing.

Returns: if the board is just holding a footprint

Definition at line 295 of file board.h.

 {
 return m_boardUse == BOARD_USE::FPHOLDER;
 }

References FPHOLDER, and m_boardUse.

Referenced by BOARD_ADAPTER::createBoardPolygon(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), and BOARD_ADAPTER::InitSettings().

◆ IsFootprintLayerVisible()

bool BOARD::IsFootprintLayerVisible ( PCB_LAYER_ID aLayer ) const

Expect either of the two layers on which a footprint can reside, and returns whether that layer is visible.

Parameters

aLayer is one of the two allowed layers for footprints: F_Cu or B_Cu

Returns: true if the layer is visible, otherwise false.

Definition at line 670 of file board.cpp.

{
 switch( aLayer )
 {
 case F_Cu: return IsElementVisible( LAYER_MOD_FR );
 case B_Cu: return IsElementVisible( LAYER_MOD_BK );
 default: wxFAIL_MSG( wxT( "BOARD::IsModuleLayerVisible(): bad layer" ) ); return true;
 }
}

References B_Cu, F_Cu, IsElementVisible(), LAYER_MOD_BK, and LAYER_MOD_FR.

Referenced by GetFootprint().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 201 of file eda_item.h.

201{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:497

References EDA_ITEM::m_forceVisible.

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

◆ IsHighLightNetON()

bool BOARD::IsHighLightNetON ( ) const

inline

Returns: true if a net is currently highlighted

Definition at line 488 of file board.h.

488{ return m_highLight.m_highLightOn; }

References m_highLight, and HIGH_LIGHT_INFO::m_highLightOn.

Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), and DIALOG_NET_INSPECTOR::OnBoardHighlightNetChanged().

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Definition at line 250 of file board_item.h.

250{ return m_isKnockout; }

BOARD_ITEM::m_isKnockout

bool m_isKnockout

Definition: board_item.h:330

References BOARD_ITEM::m_isKnockout.

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

◆ IsLayerEnabled()

bool BOARD::IsLayerEnabled ( PCB_LAYER_ID aLayer ) const

A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer is enabled.

Parameters

aLayer = The layer to be tested

Returns: true if the layer is visible.

Definition at line 591 of file board.cpp.

{
 return GetDesignSettings().IsLayerEnabled( aLayer );
}

References GetDesignSettings(), and BOARD_DESIGN_SETTINGS::IsLayerEnabled().

Referenced by GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), GetLayerName(), GetLayerType(), BOARD_ADAPTER::Is3dLayerEnabled(), PCB_LAYER_SELECTOR::isLayerEnabled(), SetLayerName(), SetLayerType(), PANEL_SETUP_LAYERS::setUserDefinedLayerCheckBoxes(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

◆ IsLayerVisible()

bool BOARD::IsLayerVisible ( PCB_LAYER_ID aLayer ) const

A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer is visible.

Parameters

aLayer is the layer to be tested.

Returns: true if the layer is visible otherwise false.

Definition at line 571 of file board.cpp.

{
 // If there is no project, assume layer is visible always
 return GetDesignSettings().IsLayerEnabled( aLayer )
 && ( !m_project || m_project->GetLocalSettings().m_VisibleLayers[aLayer] );
}

References GetDesignSettings(), PROJECT::GetLocalSettings(), BOARD_DESIGN_SETTINGS::IsLayerEnabled(), m_project, and PROJECT_LOCAL_SETTINGS::m_VisibleLayers.

Referenced by FOOTPRINT::GetBoundingBox(), PCB_BASE_FRAME::GetDocumentExtents(), BOARD_ADAPTER::Is3dLayerEnabled(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), PCB_SELECTION_TOOL::Selectable(), and PCB_DRAW_PANEL_GAL::SyncLayersVisibility().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Reimplemented in FOOTPRINT, and PAD.

Definition at line 71 of file board_item.cpp.

{
 if( GetParentGroup() )
 return GetParentGroup()->IsLocked();
 
 const BOARD* board = GetBoard();
 
 return board && board->GetBoardUse() != BOARD_USE::FPHOLDER && m_isLocked;
}

References FPHOLDER, BOARD_ITEM::GetBoard(), GetBoardUse(), BOARD_ITEM::GetParentGroup(), BOARD_ITEM::IsLocked(), and BOARD_ITEM::m_isLocked.

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

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

Reimplemented in PAD, PCB_TRACK, and ZONE.

Definition at line 123 of file board_item.h.

 {
 return IsCopperLayer( GetLayer() );
 }

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::CheckNetTies(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_CONNECTED_ITEM::SetNetCode(), and PCB_CONTROL::UpdateMessagePanel().

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

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

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented in PCB_GROUP, FOOTPRINT, PAD, PCB_VIA, and ZONE.

Definition at line 245 of file board_item.h.

 {
 return m_layer == aLayer;
 }

References BOARD_ITEM::m_layer.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), CN_VISITOR::checkZoneItemConnection(), BOARD_ADAPTER::createLayers(), existsOnLayerFunc(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), isEdge(), PNS_KICAD_IFACE::IsItemVisible(), VIAPAD::IsOnLayer(), BOARD_COMMIT::Push(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), and PCB_CONTROL::UpdateMessagePanel().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 420 of file eda_item.h.

420{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

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

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 173 of file eda_item.h.

173{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:54

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( ) const

inlinevirtualinherited

Reimplemented in PCB_VIA.

Definition at line 133 of file board_item.h.

 {
 return false;
 }

Referenced by BOARD_INSPECTION_TOOL::InspectClearance(), and DRC_TEST_PROVIDER_SILK_CLEARANCE::Run().

◆ IsType()

virtual bool EDA_ITEM::IsType ( const std::vector< 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 SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 181 of file eda_item.h.

 {
  for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
 return true;
 }
 
 return false;
 }

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), KIGFX::SCH_PAINTER::getLineWidth(), SCH_FIELD::GetName(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::GetShownText(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), SCH_ITEM::IsType(), FP_TEXT::IsType(), FP_TEXTBOX::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::Visit().

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 302 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 322 of file eda_item.h.

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

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

◆ LayerDepth()

int BOARD::LayerDepth	(	PCB_LAYER_ID	aStartLayer,
		PCB_LAYER_ID	aEndLayer
	)		const

Definition at line 553 of file board.cpp.

{
 if( aStartLayer > aEndLayer )
 std::swap( aStartLayer, aEndLayer );
 
 if( aEndLayer == B_Cu )
 aEndLayer = ToLAYER_ID( F_Cu + GetCopperLayerCount() - 1 );
 
 return aEndLayer - aStartLayer;
}

References B_Cu, F_Cu, GetCopperLayerCount(), and ToLAYER_ID().

Referenced by DIALOG_TRACK_VIA_PROPERTIES::getLayerDepth().

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 106 of file board_item.cpp.

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

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

Referenced by PAD::GetItemDescription(), PAD::GetMsgPanelInfo(), and PCB_TRACK::GetMsgPanelInfo().

◆ MapNets()

void BOARD::MapNets ( const BOARD * aDestBoard )

Map all nets in the given board to nets with the same name (if any) in the destination board.

This allows us to share layouts which came from the same hierarchical sheet in the schematic.

Definition at line 1999 of file board.cpp.

{
 for( BOARD_CONNECTED_ITEM* item : AllConnectedItems() )
 {
 NETINFO_ITEM* netInfo = aDestBoard->FindNet( item->GetNetname() );
 
 if( netInfo )
 item->SetNet( netInfo );
 else
 item->SetNetCode( 0 );
 }
}

References AllConnectedItems(), FindNet(), and NETINFO_ITEM::SetNetCode().

◆ Markers() [1/2]

MARKERS & BOARD::Markers ( )

inline

Definition at line 316 of file board.h.

316{ return m_markers; }

References m_markers.

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), DRC_ITEMS_PROVIDER::GetCount(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_PLOT::reInitDialog(), ResolveDRCExclusions(), DIALOG_FIND::search(), DRC_ITEMS_PROVIDER::SetSeverities(), and UpdateRatsnestExclusions().

◆ Markers() [2/2]

const MARKERS & BOARD::Markers ( ) const

inline

Definition at line 317 of file board.h.

317{ return m_markers; }

References m_markers.

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 382 of file eda_item.h.

 {
 return false;
 }

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 117 of file eda_item.cpp.

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

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

◆ Move()

void BOARD::Move ( const VECTOR2I & aMoveVector )

overridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 379 of file board.cpp.

{
 INSPECTOR_FUNC inspector =
 [&] ( EDA_ITEM* item, void* testData )
 {
 BOARD_ITEM* brdItem = static_cast<BOARD_ITEM*>( item );
 
 // aMoveVector was snapshotted, don't need "data".
 // Only move the top level group
 if( brdItem->GetParentGroup() == nullptr )
 brdItem->Move( aMoveVector );
 
 return INSPECT_RESULT::CONTINUE;
 };
 
 Visit( inspector, nullptr, GENERAL_COLLECTOR::BoardLevelItems );
}

References GENERAL_COLLECTOR::BoardLevelItems, CONTINUE, BOARD_ITEM::GetParentGroup(), BOARD_ITEM::Move(), and Visit().

Referenced by EAGLE_PLUGIN::centerBoard(), CADSTAR_PCB_ARCHIVE_PLUGIN::Load(), and ALTIUM_PCB::Parse().

◆ OnItemChanged()

void BOARD::OnItemChanged ( BOARD_ITEM * aItem )

Notify the board and its listeners that an item on the board has been modified in some way.

Definition at line 2048 of file board.cpp.

{
 InvokeListeners( &BOARD_LISTENER::OnBoardItemChanged, *this, aItem );
}

References InvokeListeners(), and BOARD_LISTENER::OnBoardItemChanged().

Referenced by PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), and BOARD_COMMIT::Revert().

◆ OnItemsChanged()

void BOARD::OnItemsChanged ( std::vector< BOARD_ITEM * > & aItems )

Notify the board and its listeners that an item on the board has been modified in some way.

Definition at line 2054 of file board.cpp.

{
 InvokeListeners( &BOARD_LISTENER::OnBoardItemsChanged, *this, aItems );
}

References InvokeListeners(), and BOARD_LISTENER::OnBoardItemsChanged().

Referenced by BOARD_COMMIT::Push(), BOARD_COMMIT::Revert(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow().

◆ operator<()

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

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

Definition at line 231 of file eda_item.cpp.

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

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

◆ operator=()

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

privatedelete

◆ Remove()

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

overridevirtual

Removes an item from the container.

Implements BOARD_ITEM_CONTAINER.

Definition at line 859 of file board.cpp.

{
 // find these calls and fix them! Don't send me no stinking' nullptr.
 wxASSERT( aBoardItem );
 
 switch( aBoardItem->Type() )
 {
 case PCB_NETINFO_T:
 {
 NETINFO_ITEM* item = static_cast<NETINFO_ITEM*>( aBoardItem );
 NETINFO_ITEM* unconnected = m_NetInfo.GetNetItem( NETINFO_LIST::UNCONNECTED );
 
 for( FOOTPRINT* fp : m_footprints )
 {
 for( PAD* pad : fp->Pads() )
 {
 if( pad->GetNet() == item )
 pad->SetNet( unconnected );
 }
 }
 
 for( ZONE* zone : m_zones )
 {
 if( zone->GetNet() == item )
 zone->SetNet( unconnected );
 }
 
 for( PCB_TRACK* track : m_tracks )
 {
 if( track->GetNet() == item )
 track->SetNet( unconnected );
 }
 
 m_NetInfo.RemoveNet( item );
 break;
 }
 
 case PCB_MARKER_T:
 alg::delete_matching( m_markers, aBoardItem );
 break;
 
 case PCB_GROUP_T:
 alg::delete_matching( m_groups, aBoardItem );
 break;
 
 case PCB_ZONE_T:
 alg::delete_matching( m_zones, aBoardItem );
 break;
 
 case PCB_FOOTPRINT_T:
 alg::delete_matching( m_footprints, aBoardItem );
 break;
 
 case PCB_TRACE_T:
 case PCB_ARC_T:
 case PCB_VIA_T:
 alg::delete_matching( m_tracks, aBoardItem );
 break;
 
 case PCB_DIM_ALIGNED_T:
 case PCB_DIM_CENTER_T:
 case PCB_DIM_RADIAL_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_DIM_LEADER_T:
 case PCB_SHAPE_T:
 case PCB_BITMAP_T:
 case PCB_TEXT_T:
 case PCB_TEXTBOX_T:
 case PCB_TARGET_T:
 alg::delete_matching( m_drawings, aBoardItem );
 break;
 
 // other types may use linked list
 default:
 wxFAIL_MSG( wxT( "BOARD::Remove() needs more ::Type() support" ) );
 }
 
 aBoardItem->SetFlags( STRUCT_DELETED );
 
 PCB_GROUP* parentGroup = aBoardItem->GetParentGroup();
 
 if( parentGroup && !( parentGroup->GetFlags() & STRUCT_DELETED ) )
 parentGroup->RemoveItem( aBoardItem );
 
 m_connectivity->Remove( aBoardItem );
 
 if( aRemoveMode != REMOVE_MODE::BULK )
 InvokeListeners( &BOARD_LISTENER::OnBoardItemRemoved, *this, aBoardItem );
}

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BOARD() [1/2]

◆ ~BOARD()

◆ BOARD() [2/2]

Member Function Documentation

◆ Add()

◆ AddArea()

◆ AddListener()

◆ AllConnectedItems()

◆ BeginNets()

◆ BuildConnectivity()

◆ BuildListOfNets()

◆ CacheTriangulation()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearProject()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ComputeBoundingBox()

◆ ConvertBrdLayerToPolygonalContours()

◆ ConvertCrossReferencesToKIIDs()

◆ ConvertKIIDsToCrossReferences()

◆ Delete()

◆ DeleteAllFootprints()

◆ DeleteMARKERs() [1/2]

◆ DeleteMARKERs() [2/2]

◆ DeleteStructure()

◆ Drawings() [1/2]

◆ Drawings() [2/2]

◆ Duplicate()

◆ EndNets()

◆ FillItemMap()

◆ FinalizeBulkAdd()

◆ FinalizeBulkRemove()

◆ FindFootprintByPath()

◆ FindFootprintByReference()

◆ FindNet() [1/2]

◆ FindNet() [2/2]

◆ Flip()

◆ Footprints() [1/2]

◆ Footprints() [2/2]

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetArea()

◆ GetAreaCount()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoardEdgesBoundingBox()

◆ GetBoardPolygonOutlines()

◆ GetBoardUse()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetConnectivity()

◆ GetCopperLayerCount()

◆ GetDesignSettings()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveShape()

◆ GetEnabledLayers()

◆ GetFileFormatVersionAtLoad()

◆ GetFileName()

◆ GetFirstFootprint()

◆ GetFlags()