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

const std::set< BOARD_ITEM * >	GetItemSet ()

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)

void	GetContextualTextVars (wxArrayString *aVars) const

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

EDA_UNITS	GetUserUnits ()

void	SetUserUnits (EDA_UNITS aUnits)

void	UpdateUserUnits (BOARD_ITEM aItem, KIGFX::VIEW aView)
	Update any references within aItem (or its descendants) to the user units. More...

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

int	GetOutlinesChainingEpsilon ()

void	SetOutlinesChainingEpsilon (int aValue)

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

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

bool	LegacyTeardrops () const

void	SetLegacyTeardrops (bool aFlag)

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

FOOTPRINT *	GetParentFootprint () const

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

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, bool aIncludeCourtyards=false) 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 ()

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	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

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::shared_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

std::map< ZONE *, std::map< PCB_LAYER_ID, ISOLATED_ISLANDS > >	m_ZoneIsolatedIslandsMap

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 *	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
int	m_outlinesChainingEpsilon
	the max distance between 2 end point to see them connected when building the board outlines More...

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

EDA_UNITS	m_userUnits

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

bool	m_legacyTeardrops = false
	Teardrops in 7.0 were applied as a post-processing step (rather than from pad and via properties). 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

double	m_forcedTransparency
	Additional transparency for diff'ing items. More...

Friends
class	PCB_EDIT_FRAME

Detailed Description

Information pertinent to a Pcbnew printed circuit board.

Definition at line 269 of file board.h.

Constructor & Destructor Documentation

◆ BOARD() [1/2]

◆ ~BOARD()

BOARD::~BOARD ( )

Definition at line 127 of file board.cpp.

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 796 of file board.cpp.

References NETINFO_LIST::AppendNet(), 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 2002 of file board.cpp.

References ZONE::AppendCorner(), m_zones, 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 2102 of file board.cpp.

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 2058 of file board.cpp.

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

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

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(), 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 779 of file board.h.

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 746 of file board.cpp.

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

References PCB_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 142 of file eda_item.h.

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(), SYMBOL_EDITOR_MOVE_TOOL::Main(), 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 125 of file eda_item.h.

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(), BOARD_COMMIT::dirtyIntersectingZones(), 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(), SCHEMATIC_COMMIT::Stage(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearProject()

void BOARD::ClearProject ( )

Definition at line 217 of file board.cpp.

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.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), 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 137 of file eda_item.h.

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

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

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

Definition at line 81 of file eda_item.cpp.

References EDA_ITEM::GetClass().

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), LIB_SYMBOL::LIB_SYMBOL(), SCHEMATIC_COMMIT::makeImage(), 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 1303 of file board.cpp.

References Edge_Cuts, GetVisibleLayers(), IsElementVisible(), IsFootprintHolder(), LAYER_MOD_TEXT_INVISIBLE, m_drawings, m_footprints, PGM_BASE::m_Printing, m_tracks, m_zones, BOX2< Vec >::Merge(), 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 2328 of file board.cpp.

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 1184 of file board.cpp.

References Footprints().

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

◆ ConvertKIIDsToCrossReferences()

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

Definition at line 1238 of file board.cpp.

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.

References BOARD_ITEM_CONTAINER::Remove().

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

◆ DeleteAllFootprints()

void BOARD::DeleteAllFootprints ( )

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

Definition at line 1060 of file board.cpp.

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 1028 of file board.cpp.

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 1038 of file board.cpp.

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

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

◆ Drawings() [1/2]

DRAWINGS & BOARD::Drawings ( )

inline

Definition at line 315 of file board.h.

References m_drawings.

Referenced by PCB_CONTROL::AppendBoard(), EXPORTER_STEP::buildBoard3DShapes(), 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(), PNS_KICAD_IFACE_BASE::SyncWorld(), and TestForExistingItem().

◆ Drawings() [2/2]

const DRAWINGS & BOARD::Drawings ( ) const

inline

Definition at line 316 of file board.h.

References m_drawings.

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 185 of file board_item.cpp.

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

References NETINFO_LIST::end(), and m_NetInfo.

◆ FillItemMap()

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

Definition at line 1148 of file board.cpp.

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 893 of file board.cpp.

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 899 of file board.cpp.

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 1566 of file board.cpp.

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 1554 of file board.cpp.

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 1548 of file board.cpp.

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 1533 of file board.cpp.

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

Referenced by PCAD2KICAD::PCAD_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_TEARDROPS::TransferDataToWindow(), 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, 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 288 of file board_item.cpp.

References EDA_ITEM::GetClass().

◆ Footprints() [1/2]

FOOTPRINTS & BOARD::Footprints ( )

inline

Definition at line 312 of file board.h.

References m_footprints.

◆ Footprints() [2/2]

const FOOTPRINTS & BOARD::Footprints ( ) const

inline

Definition at line 313 of file board.h.

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.

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.

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(), and PCB_EXPR_VAR_REF::GetValue().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

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

References m_zones.

Referenced by UpdateCopyOfZonesList().

◆ GetAreaCount()

int BOARD::GetAreaCount ( ) const

inline

Returns: The number of copper pour areas or ZONEs.

Definition at line 963 of file board.h.

References m_zones.

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 58 of file board_item.cpp.

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

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(), BOARD_INSPECTION_TOOL::DiffFootprint(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), existsOnLayerFunc(), PCB_VIA::FlashLayer(), PAD::FlashLayer(), 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(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), FOOTPRINT::GetCourtyard(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), 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(), PCB_TEXT::GetShownText(), 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(), padNeedsUpdate(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), ResolveDRCExclusions(), FOOTPRINT::ResolveTextVar(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_DIMENSION_BASE::SetUnitsMode(), 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 858 of file board.h.

References ComputeBoundingBox().

Referenced by GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), AUTOPLACE_TOOL::autoplace(), BuildBoardPolygonOutlines(), 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`,
		bool	aAllowUseArcsInPolygons = `false`
	)

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.
aAllowUseArcsInPolygons	= an optional option to allow adding arcs in SHAPE_LINE_CHAIN polylines/polygons when building outlines from aShapeList This is mainly for export to STEP files

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

Definition at line 2027 of file board.cpp.

References BuildBoardPolygonOutlines(), GetDesignSettings(), GetOutlinesChainingEpsilon(), SHAPE_POLY_SET::PM_STRICTLY_SIMPLE, and SHAPE_POLY_SET::Simplify().

Referenced by EXPORTER_STEP::buildBoard3DShapes(), DSN::SPECCTRA_DB::BuiltBoardOutlines(), 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 289 of file board.h.

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

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

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

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

◆ GetClass()

wxString BOARD::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 916 of file board.h.

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

References m_connectivity.

Referenced by TEARDROP_MANAGER::AddTeardropsOnTracks(), 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_CACHE_GENERATOR::Run(), 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(), UpdateRatsnestExclusions(), and TEARDROP_MANAGER::UpdateTeardrops().

◆ GetContextualTextVars()

void BOARD::GetContextualTextVars ( wxArrayString * aVars ) const

Definition at line 355 of file board.cpp.

References alg::contains(), TITLE_BLOCK::GetContextualTextVars(), GetProject(), and GetTitleBlock().

Referenced by PCB_BASE_EDIT_FRAME::GetContextualTextVars().

◆ GetCopperLayerCount()

int BOARD::GetCopperLayerCount ( ) const

Returns: The number of copper layers in the BOARD.

Definition at line 587 of file board.cpp.

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(), ZONE_FILLER::Fill(), PCB_TRACK::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), DSN::SPECCTRA_DB::FromBOARD(), GetGerberFileFunctionAttribute(), DIALOG_TRACK_VIA_PROPERTIES::getLayerDepth(), BOARD_ADAPTER::InitSettings(), LayerDepth(), BOARD_ITEM::layerMaskDescribe(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DSN::SPECCTRA_DB::makeVIA(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), DRC_CACHE_GENERATOR::Run(), PCB_BASE_FRAME::SwitchLayer(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), 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 728 of file board.cpp.

References m_designSettings.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 129 of file eda_item.h.

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

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, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and PAD.

Definition at line 220 of file board_item.cpp.

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 611 of file board.cpp.

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(), ZONE_FILLER::Fill(), 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(), padNeedsUpdate(), 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 371 of file board.h.

References m_fileFormatVersionAtLoad.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetFileName()

const wxString & BOARD::GetFileName ( ) const

inline

Definition at line 307 of file board.h.

References m_fileName.

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), PCB_EDIT_FRAME::canCloseWindow(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), CreateHeaderInfoData(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PCB_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Export_IDF3(), EXPORTER_STEP::EXPORTER_STEP(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), DIALOG_EXPORT_SVG::ExportSVGFile(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GENDRILL_WRITER_BASE::GenDrillReportFile(), PCB_EDIT_FRAME::GenFootprintsReport(), PCB_EDIT_FRAME::GetCurrentFileName(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), GENDRILL_WRITER_BASE::getDrillFileName(), PCB_EDIT_FRAME::GetLastPath(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportPdf(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportStep(), FABMASTER::loadFootprints(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_IMPORT_SETTINGS::OnBrowseClicked(), PCB_EDIT_FRAME::OnExportHyperlynx(), PCB_EDIT_FRAME::OnExportIDF3(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), PLOT_CONTROLLER::OpenPlotfile(), ALTIUM_PCB::ParseModelsData(), PCB_PLOT_SVG::Plot(), DIALOG_PLOT::Plot(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), DIALOG_BOARD_STATISTICS::saveReportClicked(), PCB_EDIT_FRAME::SetLastPath(), StartPlotBoard(), PCB_EDIT_FRAME::UpdateTitle(), HYPERLYNX_EXPORTER::writeBoardInfo(), WriteDRCReport(), and DIALOG_DRC::writeReport().

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

References m_footprints.

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

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_PIN::GetMsgPanelInfo(), 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 361 of file board.h.

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 1918 of file board.cpp.

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 150 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and EDA_ITEM::operator=().

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 254 of file board_item.cpp.

References BOARD_ITEM::GetParentFootprint(), EDA_ITEM::GetPosition(), and RotatePoint().

Referenced by PCB_PLUGIN::format(), DIALOG_PAD_PROPERTIES::initValues(), FOOTPRINT::cmp_pads::operator()(), padNeedsUpdate(), and textNeedsUpdate().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TRACK, and ZONE.

Definition at line 310 of file eda_item.cpp.

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

References m_highLight, and HIGH_LIGHT_INFO::m_netCodes.

Referenced by DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), 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 1069 of file board.cpp.

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(), ResolveDRCExclusions(), 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 996 of file board.cpp.

References _.

◆ GetItemSet()

const std::set< BOARD_ITEM * > BOARD::GetItemSet ( )

Definition at line 2408 of file board.cpp.

References INSERT_ITEMS, m_drawings, m_footprints, m_markers, m_tracks, and m_zones.

Referenced by PCB_EDIT_FRAME::RebuildAndRefresh(), and PCB_EDIT_FRAME::RunActionPlugin().

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

References BOARD_ITEM::m_layer.

Referenced by Add(), CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapes(), GRAPHICS_CLEANER::areEquivalent(), TEARDROP_MANAGER::areItemsInSameZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BuildBoardPolygonOutlines(), EXPORTER_STEP::buildGraphic3DShape(), EXPORTER_STEP::buildTrack3DShape(), PNS::ITEM::collideSimple(), TEARDROP_MANAGER::computeTeardropPolygon(), 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(), PCB_DIMENSION_BASE::Flip(), PCB_SHAPE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), 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(), 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::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(), PCB_SELECTION_TOOL::Selectable(), shapeNeedsUpdate(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTextItem(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::SyncWorld(), DRC_TEST_PROVIDER_MISC::testTextVars(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), textNeedsUpdate(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), FOOTPRINT::TransformFPShapesToPolySet(), PCB_CONTROL::UpdateMessagePanel(), PCB_TEXT::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), PCB_TEXT::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetLayerID()

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

Return the ID of a layer.

Definition at line 478 of file board.cpp.

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

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

Referenced by PCB_DIMENSION_BASE::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TEXT::GetItemDescription(), PCB_TEXTBOX::GetItemDescription(), PCB_TRACK::GetItemDescription(), 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 498 of file board.cpp.

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

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DSN::SPECCTRA_DB::buildLayerMaps(), PCB_PROPERTIES_PANEL::createPGProperty(), 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(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), CADSTAR_PCB_ARCHIVE_LOADER::Load(), PCBNEW_PRINTOUT::OnPrintPage(), PCB_PARSER::parseBOARD_unchecked(), 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 201 of file board_item.h.

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(), 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 532 of file board.cpp.

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

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

aFrame	is the EDA_DRAW_FRAME that displays the message panel
aList	is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1369 of file board.cpp.

References _, Footprints(), 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 1578 of file board.cpp.

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

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

References m_NetInfo.

◆ GetNetInfo() [2/2]

const NETINFO_LIST & BOARD::GetNetInfo ( ) const

inline

Definition at line 800 of file board.h.

References m_NetInfo.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), BOOST_AUTO_TEST_CASE(), CONNECTIVITY_DATA::Build(), DIALOG_GLOBAL_EDIT_TEARDROPS::buildFilterLists(), 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::SaveProjectLocalSettings(), 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 1286 of file board.cpp.

References Footprints(), and pad.

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

◆ GetOutlinesChainingEpsilon()

int BOARD::GetOutlinesChainingEpsilon ( )

inline

Returns: a epsilon value that is the max distance between 2 points to see them at the same coordinate when building the board outlines and tray to connect 2 end points when buildind the outlines of the board Too small value do not allow connecting 2 shapes (i.e. segments) not exactly connected Too large value do not allow safely connecting 2 shapes like very short segments.

Definition at line 684 of file board.h.

References m_outlinesChainingEpsilon.

Referenced by BOARD_ADAPTER::createBoardPolygon(), GetBoardPolygonOutlines(), and DRC_TEST_PROVIDER_MISC::testOutline().

◆ 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 1683 of file board.cpp.

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

◆ GetPad() [2/4]

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

inline

Definition at line 1002 of file board.h.

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 1663 of file board.cpp.

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 1712 of file board.cpp.

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 1693 of file board.cpp.

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 2044 of file board.cpp.

References Footprints(), and pad.

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

◆ GetPageSettings()

const PAGE_INFO & BOARD::GetPageSettings ( ) const

inline

Definition at line 638 of file board.h.

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 ( ) const

inlineinherited

Definition at line 176 of file board_item.h.

References EDA_ITEM::m_parent.

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 240 of file board_item.cpp.

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), GRAPHICS_IMPORTER_PCBNEW::AddPolygon(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), EDIT_TOOL::Duplicate(), PCB_PLUGIN::format(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TEXT::GetDrawRotation(), PAD::GetFPRelativeOrientation(), BOARD_ITEM::GetFPRelativePosition(), PCB_TEXT::GetItemDescription(), PCB_SHAPE::GetMenuImage(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXT::GetShownText(), GROUP_TOOL::Group(), hash_fp_item(), GENERAL_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), DRC_ENGINE::IsNetTieExclusion(), PCB_SELECTION_TOOL::itemPassesFilter(), memberOfFootprintFunc(), Move(), BOARD_COMMIT::parentObject(), BRDITEMS_PLOTTER::PlotPcbShape(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), PCB_PARSER::resolveGroups(), PAD::SameLogicalPadAs(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::Selectable(), PAD::SetFPRelativeOrientation(), BOARD_ITEM::SetFPRelativePosition(), PAD::SharesNetTieGroup(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PCB_POINT_EDITOR::updateItem(), PCB_TEXT::ViewGetLayers(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and ZONE::ZONE().

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

◆ GetPlotOptions()

const PCB_PLOT_PARAMS & BOARD::GetPlotOptions ( ) const

inline

Definition at line 641 of file board.h.

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 412 of file board.cpp.

References BOARD_ITEM::ZeroOffset.

◆ GetProject()

PROJECT * BOARD::GetProject ( ) const

inline

◆ GetProperties()

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

inline

Definition at line 339 of file board.h.

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 1820 of file board.cpp.

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

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

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

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 83 of file board_item.cpp.

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

Referenced by CONVERT_TOOL::CreatePolys().

◆ GetTentVias()

bool BOARD::GetTentVias ( ) const

inline

Definition at line 635 of file board.h.

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

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

References m_titles.

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

◆ GetTitleBlock() [2/2]

const TITLE_BLOCK & BOARD::GetTitleBlock ( ) const

inline

Definition at line 645 of file board.h.

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 1835 of file board.cpp.

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.

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

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

◆ GetUserUnits()

EDA_UNITS BOARD::GetUserUnits ( )

inline

Definition at line 650 of file board.h.

References m_userUnits.

Referenced by PCB_DIMENSION_BASE::SetUnitsMode().

◆ 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 671 of file board.cpp.

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 625 of file board.cpp.

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

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

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

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 1982 of file board.cpp.

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 734 of file board.cpp.

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 2250 of file board.cpp.

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

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

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 2171 of file board.cpp.

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 2184 of file board.cpp.

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

Referenced by GroupsSanityCheck().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 141 of file board_item.h.

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

◆ HighLightOFF()

void BOARD::HighLightOFF ( )

inline

Disable net highlight.

Definition at line 514 of file board.h.

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 2161 of file board.cpp.

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

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

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 ( )

◆ InvokeListeners()

template<typename Func , typename... Args>

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

inlineprivate

Definition at line 1203 of file board.h.

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.

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(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

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

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 677 of file board.cpp.

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

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.

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

References m_boardUse.

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

◆ 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 716 of file board.cpp.

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

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

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

References BOARD_ITEM::m_isKnockout.

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

◆ 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 637 of file board.cpp.

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 617 of file board.cpp.

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

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), KI_TEST::CheckFpShape(), KI_TEST::CheckFpZone(), PCB_CONTROL::DeleteItemCursor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromSESSION(), PCB_GROUP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), PCB_SELECTION_CONDITIONS::HasLockedItems(), PCB_SELECTION_CONDITIONS::HasUnlockedItems(), ROUTER_TOOL::InlineDrag(), GENERAL_COLLECTOR::Inspect(), BOARD_ITEM::IsLocked(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_POINT_EDITOR::OnSelectionChange(), ZONE_SETTINGS::operator<<(), PCB_SELECTION_TOOL::RequestSelection(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), BOARD_ITEM::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), and PCB_VIA::ViewGetLayers().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

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.

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.

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

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

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

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer	(	PCB_LAYER_ID	aLayer,
		bool	aIncludeCourtyards = `false`
	)		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 261 of file board_item.h.

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(), BOARD_COMMIT::Push(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), 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 403 of file eda_item.h.

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

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.

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

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

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, PAD, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, and PCB_VIA.

Definition at line 165 of file eda_item.h.

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(), PAD::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(), SCHEMATIC_COMMIT::Stage(), 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 285 of file eda_item.h.

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

References EDA_ITEM::Visit().

◆ LayerDepth()

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

Definition at line 599 of file board.cpp.

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

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

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

◆ LegacyTeardrops()

bool BOARD::LegacyTeardrops ( ) const

inline

Definition at line 1160 of file board.h.

References m_legacyTeardrops.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_PLUGIN::formatGeneral(), DIALOG_TRACK_VIA_PROPERTIES::onCurvedEdgesUpdateUi(), DIALOG_PAD_PROPERTIES::onTeardropCurvePointsUpdateUi(), DIALOG_PAD_PROPERTIES::onTeardropsUpdateUi(), DIALOG_TRACK_VIA_PROPERTIES::onTeardropsUpdateUi(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), PCB_SELECTION_TOOL::Selectable(), and TEARDROP_MANAGER::UpdateTeardrops().

◆ 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 2078 of file board.cpp.

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

◆ Markers() [1/2]

MARKERS & BOARD::Markers ( )

inline

Definition at line 321 of file board.h.

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

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, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 365 of file eda_item.h.

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(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), 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 116 of file eda_item.cpp.

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

◆ 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 424 of file board.cpp.

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

Referenced by 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 2127 of file board.cpp.

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 2133 of file board.cpp.

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

References 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 905 of file board.cpp.

References alg::delete_matching(), EDA_ITEM::GetFlags(), NETINFO_LIST::GetNetItem(), BOARD_ITEM::GetParentGroup(), InvokeListeners(), m_connectivity, m_drawings, m_footprints, m_groups, m_markers, m_NetInfo, m_tracks, m_zones, BOARD_LISTENER::OnBoardItemRemoved(), pad, 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, PCB_GROUP::RemoveItem(), NETINFO_LIST::RemoveNet(), EDA_ITEM::SetFlags(), STRUCT_DELETED, EDA_ITEM::Type(), and NETINFO_LIST::UNCONNECTED.

Referenced by NET_SELECTOR_COMBOPOPUP::Accept(), TRACKS_CLEANER::deleteDanglingTracks(), TEARDROP_MANAGER::DeleteTrackToTrackTeardrops(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), GroupsSanityCheckInternal(), FABMASTER::loadZones(), TRACKS_CLEANER::mergeCollinearSegments(), DIALOG_NET_INSPECTOR::onDeleteNet(), BOARD_COMMIT::Push(), TRACKS_CLEANER::removeItems(), BOARD_COMMIT::Revert(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), GROUP_TOOL::Ungroup(), and TEARDROP_MANAGER::UpdateTeardrops().

◆ RemoveAllListeners()

void BOARD::RemoveAllListeners ( )

Remove all listeners.

Definition at line 2121 of file board.cpp.

References m_listeners.

Referenced by PCB_EDIT_FRAME::~PCB_EDIT_FRAME().

◆ RemoveListener()

void BOARD::RemoveListener ( BOARD_LISTENER * aListener )

Remove the specified listener.

If it has not been added before, it will do nothing.

Definition at line 2109 of file board.cpp.

References m_listeners.

Referenced by DIALOG_NET_INSPECTOR::~DIALOG_NET_INSPECTOR().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 147 of file eda_item.h.

◆ Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

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

Reimplemented in LIB_TEXTBOX, SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 392 of file eda_item.h.

◆ Replace() [2/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 167 of file eda_item.cpp.

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

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

◆ ResetNetHighLight()

void BOARD::ResetNetHighLight ( )

Reset all high light data to the init state.

Definition at line 2139 of file board.cpp.

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

Referenced by PCB_EDIT_FRAME::Clear_Pcb(), BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), and BOARD_INSPECTION_TOOL::highlightNet().

◆ ResolveDRCExclusions()

std::vector< PCB_MARKER * > BOARD::ResolveDRCExclusions ( bool aCreateMarkers )

Rebuild DRC markers from the serialized data in BOARD_DESIGN_SETTINGS.

Parameters

aCreateMarkers if true, create markers from serialized data; if false only use serialized data to set existing markers to excluded. The former is used on board load; the later after a DRC.

Definition at line 306 of file board.cpp.

References PCB_MARKER::Deserialize(), BOARD_ITEM::GetBoard(), DELETED_BOARD_ITEM::GetInstance(), GetItem(), MARKER_BASE::GetRCItem(), m_designSettings, Markers(), and MARKER_BASE::SetExcluded().

Referenced by LoadBoard().

◆ ResolveTextVar()

bool BOARD::ResolveTextVar	(	wxString *	token,
		int	aDepth
	)		const

◆ Rotate()

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

virtualinherited

Rotate this object.

Parameters

aRotCentre the rotation center point.

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

Definition at line 282 of file board_item.cpp.

References EDA_ITEM::GetClass().

Referenced by EDIT_TOOL::MoveExact(), and TransformItem().

◆ SanitizeNetcodes()

void BOARD::SanitizeNetcodes ( )

Definition at line 2092 of file board.cpp.

References AllConnectedItems(), FindNet(), and NETINFO_LIST::ORPHANED.

Referenced by PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetAreasNetCodesFromNetNames()

int BOARD::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.

However the Netcode is an arbitrary equivalence, it must be set after each netlist read or net change Must be called after pad netcodes are calculated

Returns: : error count For non copper areas, netcode is set to 0

Definition at line 1629 of file board.cpp.

References NETINFO_ITEM::GetNetCode(), NETINFO_ITEM::SetNetCode(), NETINFO_LIST::UNCONNECTED, and Zones().

Referenced by NETINFO_LIST::buildListOfNets().

◆ SetBoardUse()

void BOARD::SetBoardUse ( BOARD_USE aUse )

inline

Set what the board is going to be used for.

Parameters

aUse	is the flag

Definition at line 282 of file board.h.

References m_boardUse.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), and PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 116 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetCopperLayerCount()

void BOARD::SetCopperLayerCount ( int aCount )

Definition at line 593 of file board.cpp.

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

Referenced by PCAD2KICAD::PCAD_PCB::AddToBoard(), PCB_CONTROL::AppendBoard(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), EAGLE_PLUGIN::Load(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), LEGACY_PLUGIN::loadGENERAL(), EAGLE_PLUGIN::loadLayerDefs(), ALTIUM_PCB::ParseBoard6Data(), and PCB_PARSER::parseLayers().

◆ SetElementVisibility()

void BOARD::SetElementVisibility	(	GAL_LAYER_ID	aLayer,
		bool	aNewState
	)

Change the visibility of an element category.

Parameters

aLayer	is from the enum by the same name.
aNewState	is the new visibility state of the element category.

See also: enum GAL_LAYER_ID

Definition at line 683 of file board.cpp.

References Footprints(), GAL_LAYER_ID_START, PROJECT::GetLocalSettings(), LAYER_RATSNEST, m_project, PROJECT_LOCAL_SETTINGS::m_VisibleItems, pad, GAL_SET::set(), Tracks(), and Zones().

Referenced by APPEARANCE_CONTROLS::onObjectVisibilityChanged(), PCB_EDIT_FRAME::SetElementVisibility(), APPEARANCE_CONTROLS::SetObjectVisible(), SetVisibleAlls(), and SetVisibleElements().

◆ SetEnabledLayers()

void BOARD::SetEnabledLayers ( LSET aLayerMask )

A proxy function that calls the correspondent function in m_BoardSettings.

Parameters

aLayerMask the new bit-mask of enabled layers.

Definition at line 631 of file board.cpp.

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

Referenced by PCB_CONTROL::AppendBoard(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), LEGACY_PLUGIN::loadGENERAL(), FABMASTER::loadLayers(), PCB_PARSER::parseLayers(), CADSTAR_PCB_ARCHIVE_LOADER::remapUnsureLayers(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetFileFormatVersionAtLoad()

void BOARD::SetFileFormatVersionAtLoad ( int aVersion )

inline

Definition at line 370 of file board.h.

References m_fileFormatVersionAtLoad.

Referenced by LEGACY_PLUGIN::checkVersion(), and PCB_PARSER::parseHeader().

◆ SetFileName()

void BOARD::SetFileName ( const wxString & aFileName )

inline

Definition at line 305 of file board.h.

References m_fileName.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::Files_io_from_id(), ALTIUM_CIRCUIT_STUDIO_PLUGIN::Load(), ALTIUM_CIRCUIT_MAKER_PLUGIN::Load(), ALTIUM_DESIGNER_PLUGIN::Load(), CLIPBOARD_IO::Load(), EAGLE_PLUGIN::Load(), FABMASTER_PLUGIN::Load(), PCB_PLUGIN::Load(), LEGACY_PLUGIN::Load(), PCAD_PLUGIN::Load(), FABMASTER::LoadBoard(), PCB_EDIT_FRAME::OpenProjectFiles(), and PCB_EDIT_FRAME::SavePcbFile().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 123 of file eda_item.h.

References EDA_ITEM::m_flags.

◆ SetForcedTransparency()

void KIGFX::VIEW_ITEM::SetForcedTransparency ( double aForcedTransparency )

inlineinherited

Definition at line 145 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), SYMBOL_DIFF_WIDGET::onSlider(), FOOTPRINT_DIFF_WIDGET::onSlider(), and EDA_ITEM::operator=().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters

aEnable True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 183 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

Referenced by SCH_FIND_REPLACE_TOOL::FindNext(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 268 of file board_item.cpp.

References BOARD_ITEM::GetParentFootprint(), RotatePoint(), and EDA_ITEM::SetPosition().

Referenced by PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), LEGACY_PLUGIN::loadMODULE_TEXT(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

◆ SetGenerator()

void BOARD::SetGenerator ( const wxString & aGenerator )

inline

Definition at line 373 of file board.h.

References m_generator.

Referenced by PCB_PARSER::parseBOARD_unchecked().

◆ SetHighLightNet()

void BOARD::SetHighLightNet	(	int	aNetCode,
		bool	aMulti = `false`
	)

Select the netcode to be highlighted.

Parameters

aNetCode	is the net to highlight.
aMulti	is true if you want to add a highlighted net without clearing the old one.

Definition at line 2148 of file board.cpp.

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

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

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 267 of file board_item.h.

References BOARD_ITEM::m_isKnockout.

Referenced by PCB_TEXT_DESC::PCB_TEXT_DESC().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 149 of file eda_item.h.

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

◆ SetLayer()

virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID aLayer )

inlinevirtualinherited

Set the layer this item is on.

This method is virtual because some items (in fact: class DIMENSION) have a slightly different initialization.

Parameters

aLayer The layer number.

Reimplemented in PCB_GROUP, and ZONE.

Definition at line 230 of file board_item.h.

References BOARD_ITEM::m_layer.

◆ SetLayerDescr()

bool BOARD::SetLayerDescr	(	PCB_LAYER_ID	aIndex,
		const LAYER &	aLayer
	)

Return the type of the copper layer given by aLayer.

Parameters

aIndex	A layer index in m_Layer
aLayer	A reference to a LAYER description.

Returns: false if the index was out of range.

Definition at line 466 of file board.cpp.

References arrayDim(), and m_layers.

Referenced by PCB_PARSER::parseLayers().

◆ SetLayerName()

bool BOARD::SetLayerName	(	PCB_LAYER_ID	aLayer,
		const wxString &	aLayerName
	)

Changes the name of the layer given by aLayer.

Parameters

aLayer	A layer, like B_Cu, etc.
aLayerName	The new layer name

Returns: true if aLayerName was legal and unique among other layer names at other layer indices and aLayer was within range, else false.

Definition at line 514 of file board.cpp.

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

Referenced by FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), EAGLE_PLUGIN::loadLayerDefs(), FABMASTER::loadLayers(), LEGACY_PLUGIN::loadSETUP(), ALTIUM_PCB::ParseBoard6Data(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET aLayers )

inlinevirtualinherited

Reimplemented in PAD, PCB_VIA, and ZONE.

Definition at line 209 of file board_item.h.

References LSET::Seq(), and BOARD_ITEM::SetLayer().

Referenced by PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLayerType()

bool BOARD::SetLayerType	(	PCB_LAYER_ID	aLayer,
		LAYER_T	aLayerType
	)

Change the type of the layer given by aLayer.

Parameters

aLayer	A layer index, like B_Cu, etc.
aLayerType	The new layer type.

Returns: true if aLayerType was legal and aLayer was within range, else false.

Definition at line 544 of file board.cpp.

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), EAGLE_PLUGIN::loadLayerDefs(), LEGACY_PLUGIN::loadSETUP(), ALTIUM_PCB::ParseBoard6Data(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLegacyTeardrops()

void BOARD::SetLegacyTeardrops ( bool aFlag )

inline

Definition at line 1161 of file board.h.

References m_legacyTeardrops.

Referenced by PCB_PARSER::parseGeneralSection(), PCB_PARSER::parseZONE(), and DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

◆ SetOutlinesChainingEpsilon()

void BOARD::SetOutlinesChainingEpsilon ( int aValue )

inline

Definition at line 685 of file board.h.

References m_outlinesChainingEpsilon.

◆ SetPageSettings()

void BOARD::SetPageSettings ( const PAGE_INFO & aPageSettings )

inline

Definition at line 639 of file board.h.

References m_paper.

Referenced by PCB_CONTROL::AppendBoard(), LEGACY_PLUGIN::loadSHEET(), PCB_PARSER::parsePAGE_INFO(), PCB_PLOT_SVG::Plot(), and PCB_BASE_FRAME::SetPageSettings().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 100 of file eda_item.h.

References EDA_ITEM::m_parent.

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 84 of file board_item.h.

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::DragArcTrack(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), BOARD_COMMIT::makeImage(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GROUP::RemoveItem(), BOARD_COMMIT::Revert(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SaveCopyOfZones(), BOARD_ITEM::SwapItemData(), and TEST_BOARD_ITEM_FIXTURE::~TEST_BOARD_ITEM_FIXTURE().

◆ SetPlotOptions()

void BOARD::SetPlotOptions ( const PCB_PLOT_PARAMS & aOptions )

inline

Definition at line 642 of file board.h.

References m_plotOptions.

Referenced by LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), PCB_BASE_FRAME::SetPlotSettings(), and DIALOG_GENDRILL::UpdateDrillParams().

◆ SetPosition()

void BOARD::SetPosition ( const VECTOR2I & aPos )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 418 of file board.cpp.

◆ SetProject()

void BOARD::SetProject	(	PROJECT *	aProject,
		bool	aReferenceOnly = `false`
	)

Link a board to a given project.

Should be called immediately after loading board in order for everything to work.

Parameters

aProject	is a loaded project to link to.
aReferenceOnly	avoids taking ownership of settings stored in project if true

Definition at line 178 of file board.cpp.

References ClearProject(), GetDesignSettings(), PROJECT::GetProjectFile(), m_LegacyDesignSettingsLoaded, m_LegacyNetclassesLoaded, BOARD_DESIGN_SETTINGS::m_NetSettings, m_project, and project.

Referenced by CreateEmptyBoard(), LoadBoard(), NewBoard(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), and PCB_EDIT_FRAME::SetBoard().

◆ SetProperties()

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

inline

Definition at line 340 of file board.h.

References m_properties.

Referenced by PCB_CONTROL::AppendBoard(), PCB_PARSER::parseBOARD_unchecked(), and SynchronizeProperties().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 115 of file eda_item.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), EE_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), SCH_LINE::MergeOverlap(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 89 of file board_item.cpp.

◆ SetTentVias()

void BOARD::SetTentVias ( bool aFlag )

inline

Definition at line 636 of file board.h.

References m_plotOptions, and PCB_PLOT_PARAMS::SetPlotViaOnMaskLayer().

Referenced by PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow().

◆ SetTitleBlock()

void BOARD::SetTitleBlock ( const TITLE_BLOCK & aTitleBlock )

inline

Definition at line 646 of file board.h.

References m_titles.

Referenced by PCB_CONTROL::AppendBoard(), LEGACY_PLUGIN::loadSHEET(), PCB_PARSER::parseTITLE_BLOCK(), and PCB_BASE_FRAME::SetTitleBlock().

◆ SetUserUnits()

void BOARD::SetUserUnits ( EDA_UNITS aUnits )

inline

Definition at line 651 of file board.h.

References m_userUnits.

Referenced by PCB_BASE_FRAME::SetBoard(), and PCB_BASE_FRAME::unitsChangeRefresh().

◆ SetVisibleAlls()

void BOARD::SetVisibleAlls ( )

Change the bit-mask of visible element categories and layers.

See also: enum GAL_LAYER_ID

Definition at line 660 of file board.cpp.

References GAL_LAYER_ID_BITMASK_END, GAL_LAYER_ID_START, SetElementVisibility(), and SetVisibleLayers().

Referenced by EVT_GRID_CMD_CELL_CHANGED(), and FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME().

◆ SetVisibleElements()

void BOARD::SetVisibleElements ( const GAL_SET & aMask )

A proxy function that calls the correspondent function in m_BoardSettings.

Parameters

aMask is the new bit-mask of visible element bitmap or-ed from enum GAL_LAYER_ID

See also: enum GAL_LAYER_ID

Definition at line 650 of file board.cpp.

References GAL_LAYER_ID_START, and SetElementVisibility().

Referenced by LEGACY_PLUGIN::loadSETUP(), and APPEARANCE_CONTROLS::setVisibleObjects().

◆ SetVisibleLayers()

void BOARD::SetVisibleLayers ( LSET aLayerMask )

A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of visible layers.

Parameters

aLayerMask is the new bit-mask of visible layers.

Definition at line 643 of file board.cpp.

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

Referenced by PCB_CONTROL::AppendBoard(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GENDRILL_WRITER_BASE::genDrillMapFile(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), LEGACY_PLUGIN::loadGENERAL(), CADSTAR_PCB_ARCHIVE_LOADER::remapUnsureLayers(), SetVisibleAlls(), APPEARANCE_CONTROLS::setVisibleLayers(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 111 of file board_item.h.

References BOARD_ITEM::GetY(), and EDA_ITEM::SetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 117 of file board_item.h.

References BOARD_ITEM::GetX(), and EDA_ITEM::SetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetZoneSettings()

void BOARD::SetZoneSettings ( const ZONE_SETTINGS & aSettings )

overridevirtual

Set the zone settings for this container.

Parameters

aSettings new Zone settings for this container

Reimplemented from BOARD_ITEM_CONTAINER.

Definition at line 740 of file board.cpp.

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

Referenced by LEGACY_PLUGIN::loadSETUP().

◆ Sort()

static bool EDA_ITEM::Sort	(	const EDA_ITEM *	aLeft,
		const EDA_ITEM *	aRight
	)

inlinestaticinherited

Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns: True if aLeft is less than aRight.

Definition at line 421 of file eda_item.h.

◆ swapData()

void BOARD_ITEM::swapData ( BOARD_ITEM * aImage )

protectedvirtualinherited

Reimplemented in PCB_GROUP, FOOTPRINT, PAD, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIM_LEADER, PCB_DIM_CENTER, PCB_SHAPE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_ARC, PCB_VIA, ZONE, and PCB_BITMAP.

Definition at line 162 of file board_item.cpp.

Referenced by BOARD_ITEM::SwapItemData().

◆ SwapItemData()

void BOARD_ITEM::SwapItemData ( BOARD_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

Used in undo and redo commands to swap values between an item and its copy. Only values like layer, size .. which are modified by editing are swapped.

Parameters

aImage the item image which contains data to swap.

Definition at line 167 of file board_item.cpp.

References BOARD_ITEM::GetParent(), BOARD_ITEM::GetParentGroup(), group, EDA_ITEM::SetParent(), BOARD_ITEM::SetParentGroup(), and BOARD_ITEM::swapData().

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

◆ SynchronizeNetsAndNetClasses()

void BOARD::SynchronizeNetsAndNetClasses ( bool aResetTrackAndViaSizes )

Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.

Must be called after a Design Rules edit, or after reading a netlist (or editing the list of nets) Also this function removes the non existing nets in netclasses and add net nets in default netclass (this happens after reading a netlist)

Definition at line 1601 of file board.cpp.

References GetDesignSettings(), InvokeListeners(), m_NetInfo, BOARD_DESIGN_SETTINGS::m_NetSettings, m_project, BOARD_LISTENER::OnBoardNetSettingsChanged(), BOARD_DESIGN_SETTINGS::SetCustomDiffPairGap(), BOARD_DESIGN_SETTINGS::SetCustomDiffPairViaGap(), BOARD_DESIGN_SETTINGS::SetCustomDiffPairWidth(), BOARD_DESIGN_SETTINGS::SetCustomTrackWidth(), BOARD_DESIGN_SETTINGS::SetCustomViaDrill(), BOARD_DESIGN_SETTINGS::SetCustomViaSize(), and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

Referenced by PCB_CONTROL::AppendBoard(), BOARD_EDITOR_CONTROL::AssignNetclass(), NETINFO_LIST::buildListOfNets(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), ExportBoardToSpecctraFile(), LoadBoard(), DRC_ENGINE::loadImplicitRules(), SaveBoard(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SynchronizeProperties()

void BOARD::SynchronizeProperties ( )

Copy the current project's text variables into the boards property cache.

Definition at line 1592 of file board.cpp.

References PROJECT::GetTextVars(), PROJECT::IsNullProject(), m_project, and SetProperties().

Referenced by PCB_EDIT_FRAME::SavePcbFile().

◆ TestZoneIntersection()

bool BOARD::TestZoneIntersection	(	ZONE *	aZone1,
		ZONE *	aZone2
	)

Test for intersection of 2 copper areas.

Parameters

aZone1	is the area reference.
aZone2	is the area to compare for intersection calculations.

Returns: false if no intersection, true if intersection.

Definition at line 113 of file edit_zone_helpers.cpp.

References SHAPE_POLY_SET::BBox(), SEG::Collide(), SHAPE_POLY_SET::Contains(), ZONE::GetLayerSet(), BOX2< Vec >::Intersects(), SHAPE_POLY_SET::IterateSegmentsWithHoles(), SHAPE_POLY_SET::IterateWithHoles(), and ZONE::Outline().

Referenced by BOARD_EDITOR_CONTROL::ZoneMerge().

◆ Tracks() [1/2]

TRACKS & BOARD::Tracks ( )

inline

Definition at line 309 of file board.h.

References m_tracks.

◆ Tracks() [2/2]

const TRACKS & BOARD::Tracks ( ) const

inline

Definition at line 310 of file board.h.

References m_tracks.

◆ TracksInNet()

TRACKS BOARD::TracksInNet ( int aNetCode )

Collect all the TRACKs and VIAs that are members of a net given by aNetCode.

Used from python.

Parameters

aNetCode gives the id of the net.

Returns: list of track which are in the net identified by aNetCode.

Definition at line 444 of file board.cpp.

References BOARD_CONNECTED_ITEM::GetNetCode(), GENERAL_COLLECTOR::Tracks, and Visit().

◆ TransformShapeToPolygon()

void BOARD_ITEM::TransformShapeToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc,
		bool	ignoreLineWidth = `false`
	)		const

virtualinherited

Convert the item shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the pad.
aError	the maximum deviation from true circle.
aErrorLoc	should the approximation error be placed outside or inside the polygon?
ignoreLineWidth	used for edge cut items where the line width is only for visualization.

Reimplemented in PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TARGET, PCB_TRACK, ZONE, PCB_TEXT, PCB_TEXTBOX, and PAD.

Definition at line 197 of file board_item.cpp.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), ZONE_FILLER::addKnockout(), FOOTPRINT::CoverageRatio(), enclosedByAreaFunc(), FOOTPRINT::GetCoverageArea(), process(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), and DRC_TEST_PROVIDER_SLIVER_CHECKER::Run().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

This attribute should never be changed after a ctor sets it, so there is no public "setter" method.

Returns: the type of object.

Definition at line 97 of file eda_item.h.

References EDA_ITEM::m_structType.

◆ UpdateRatsnestExclusions()

void BOARD::UpdateRatsnestExclusions ( )

Update the visibility flags on the current unconnected ratsnest lines.

Definition at line 275 of file board.cpp.

References BOARD_ITEM::GetBoard(), GetConnectivity(), CN_EDGE::GetSourceNode(), CN_EDGE::GetTargetNode(), MARKER_BASE::MARKER_RATSNEST, Markers(), and CN_EDGE::SetVisible().

Referenced by BuildConnectivity(), PCB_BASE_FRAME::Compile_Ratsnest(), DIALOG_DRC::OnDRCItemRClick(), BOARD_COMMIT::Push(), PCB_EDIT_FRAME::ResolveDRCExclusions(), and BOARD_COMMIT::Revert().

◆ UpdateUserUnits()

void BOARD::UpdateUserUnits	(	BOARD_ITEM *	aItem,
		KIGFX::VIEW *	aView
	)

Update any references within aItem (or its descendants) to the user units.

Primarily for automatic-unit dimensions.

Definition at line 1002 of file board.cpp.

References PCB_DIMENSION_BASE::GetUnitsMode(), PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, KIGFX::VIEW::Update(), PCB_DIMENSION_BASE::UpdateUnits(), and EDA_ITEM::Visit().

Referenced by PCB_BASE_FRAME::AddFootprintToBoard(), LoadBoard(), and BOARD_EDITOR_CONTROL::PlaceFootprint().

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns: the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in LIB_PIN, SCH_PIN, GERBER_DRAW_ITEM, DS_PROXY_VIEW_ITEM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, EDIT_POINTS, FOOTPRINT, PAD, PCB_DIMENSION_BASE, PCB_DIM_CENTER, PCB_MARKER, PCB_SHAPE, PCB_TEXT, PCB_TRACK, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, and MY_DRAWING.

Definition at line 254 of file eda_item.cpp.

References EDA_ITEM::GetBoundingBox().

Referenced by EDIT_TOOL::doMoveSelection(), GERBVIEW_FRAME::GetDocumentExtents(), EDIT_TOOL::Rotate(), and PCB_SHAPE::ViewBBox().

◆ ViewDraw()

virtual void KIGFX::VIEW_ITEM::ViewDraw	(	int	aLayer,
		VIEW *	aView
	)		const

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects if there is no #PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Reimplemented in DS_PROXY_VIEW_ITEM, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, EDIT_POINTS, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::VIEW_GROUP, and KIGFX::VIEW_OVERLAY.

Definition at line 108 of file view_item.h.

Referenced by KIGFX::VIEW::draw(), and KIGFX::VIEW::updateItemGeometry().

◆ ViewGetLayers()

void BOARD_ITEM::ViewGetLayers	(	int	aLayers[],
		int &	aCount
	)		const

overridevirtualinherited

Return the all the layers within the VIEW the object is painted on.

For instance, a PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters

aLayers[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Reimplemented from EDA_ITEM.

Reimplemented in PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_MARKER, PCB_TEXT, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 140 of file board_item.cpp.

References BOARD_ITEM::IsLocked(), LAYER_LOCKED_ITEM_SHADOW, and BOARD_ITEM::m_layer.

◆ ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD	(	int	aLayer,
		VIEW *	aView
	)		const

inlinevirtualinherited

Return the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Returns: the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in SCH_LINE, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 134 of file view_item.h.

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), and PCB_GRID_HELPER::queryVisible().

◆ viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

◆ Visit()

INSPECT_RESULT BOARD::Visit	(	INSPECTOR	inspector,
		void *	testData,
		const std::vector< KICAD_T > &	scanTypes
	)

overridevirtual

May be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in scanTypes[], and may use IterateForward() to do so on lists of such data.

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
scanTypes	Which KICAD_T types are of interest and the order to process them in.

Returns: SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE, and determined by the inspector.

Reimplemented from EDA_ITEM.

Definition at line 1407 of file board.cpp.

References GetClass(), m_drawings, m_footprints, m_groups, m_markers, m_tracks, m_zones, 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_PAD_T, PCB_SHAPE_T, PCB_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, and PCB_ZONE_T.

Referenced by Move(), PCB_CONTROL::Paste(), PCB_SELECTION_TOOL::RebuildSelection(), and TracksInNet().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 124 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by EE_SELECTION_TOOL::selectMultiple().

◆ Zones() [1/2]

ZONES & BOARD::Zones ( )

inline

Definition at line 318 of file board.h.

References m_zones.

Referenced by GERBER_JOBFILE_WRITER::addJSONDesignRules(), AllConnectedItems(), PCB_CONTROL::AppendBoard(), TEARDROP_MANAGER::areItemsInSameZone(), CN_CONNECTIVITY_ALGO::Build(), ZONE_FILLER::buildCopperItemClearances(), BOARD_NETLIST_UPDATER::cacheCopperZoneConnections(), HYPERLYNX_EXPORTER::collectNetObjects(), ConvertBrdLayerToPolygonalContours(), BOARD_ADAPTER::createLayers(), TEARDROP_MANAGER::DeleteTrackToTrackTeardrops(), BOARD_COMMIT::dirtyIntersectingZones(), PCB_DRAW_PANEL_GAL::DisplayBoard(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), ZONE_FILLER::Fill(), FillItemMap(), ZONE_FILLER::fillNonCopperZone(), KI_TEST::FillZones(), DRC_TEST_PROVIDER::forEachGeometryItem(), PCB_PLUGIN::format(), DSN::SPECCTRA_DB::FromBOARD(), GetItem(), GetZoneList(), PNS_KICAD_IFACE::HideItem(), DRC_ENGINE::loadImplicitRules(), FABMASTER::loadZones(), BOARD_INSPECTION_TOOL::makeDRCEngine(), FABMASTER::orderZones(), PCB_PARSER::parseBOARD_unchecked(), PCB_CONTROL::placeBoardItems(), PlotSolderMaskLayer(), PlotStandardLayer(), BOARD_COMMIT::Push(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), PCB_EDIT_FRAME::RunActionPlugin(), SaveCopyOfZones(), DIALOG_FIND::search(), ZONE_SEARCH_HANDLER::Search(), searchAreas(), SetAreasNetCodesFromNetNames(), SetElementVisibility(), ZONE_FILLER::subtractHigherPriorityZones(), PNS_KICAD_IFACE_BASE::SyncWorld(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::testCourtyardClearances(), TestForExistingItem(), NETINFO_MAPPING::Update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and TEARDROP_MANAGER::UpdateTeardrops().

◆ Zones() [2/2]

const ZONES & BOARD::Zones ( ) const

inline

Definition at line 319 of file board.h.

References m_zones.

Friends And Related Function Documentation

◆ PCB_EDIT_FRAME

friend class PCB_EDIT_FRAME

friend

Definition at line 1209 of file board.h.

Member Data Documentation

◆ m_boardUse

BOARD_USE BOARD::m_boardUse

private

What is this board being used for.

Definition at line 1216 of file board.h.

Referenced by GetBoardUse(), IsFootprintHolder(), and SetBoardUse().

◆ m_CachesMutex

std::mutex BOARD::m_CachesMutex

Definition at line 1176 of file board.h.

Referenced by ZONE::CacheBoundingBox(), PCB_LAYER_VALUE::EqualTo(), existsOnLayerFunc(), IncrementTimeStamp(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), DRC_CACHE_GENERATOR::Run(), and DRC_TEST_PROVIDER_DISALLOW::Run().

◆ m_connectivity

std::shared_ptr<CONNECTIVITY_DATA> BOARD::m_connectivity

private

Definition at line 1236 of file board.h.

Referenced by Add(), BOARD(), GetConnectivity(), and Remove().

◆ m_CopperItemRTreeCache

std::shared_ptr<DRC_RTREE> BOARD::m_CopperItemRTreeCache

Definition at line 1184 of file board.h.

Referenced by IncrementTimeStamp(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

◆ m_CopperZoneRTreeCache

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

Definition at line 1183 of file board.h.

Referenced by collidesWithArea(), IncrementTimeStamp(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), and CONNECTIVITY_DATA::TestTrackEndpointDangling().

◆ m_designSettings

std::unique_ptr<BOARD_DESIGN_SETTINGS> BOARD::m_designSettings

private

All of the board design settings are stored as a JSON object inside the project file.

The object itself is located here because the alternative is to require a valid project be passed in when constructing a BOARD, since things in the BOARD constructor rely on access to the BOARD_DESIGN_SETTINGS object.

A reference to this object is set up in the PROJECT_FILE for the PROJECT this board is part of, so that the JSON load/store operations work. This link is established when boards are loaded from disk.

Definition at line 1254 of file board.h.

Referenced by GetDesignSettings(), and ResolveDRCExclusions().