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

#include <board.h>

Inheritance diagram for BOARD:

Classes
struct	cmp_drawings

struct	cmp_items

struct	GroupLegalOpsField

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

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

void	IncrementTimeStamp ()

int	GetTimeStamp () const

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

void	SetFileName (const wxString &aFileName)

const wxString &	GetFileName () const

TRACKS &	Tracks ()

const TRACKS &	Tracks () const

FOOTPRINTS &	Footprints ()

const FOOTPRINTS &	Footprints () const

DRAWINGS &	Drawings ()

const DRAWINGS &	Drawings () const

ZONES &	Zones ()

const ZONES &	Zones () const

MARKERS &	Markers ()

const MARKERS &	Markers () const

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

const GROUPS &	Groups () const

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

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

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

bool	ResolveTextVar (wxString *token, int aDepth) const

	BOARD ()

	~BOARD ()

wxPoint	GetPosition () const override

void	SetPosition (const wxPoint &aPos) override

const wxPoint	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 wxPoint &aMoveVector) override
	Move this object. More...

void	SetFileFormatVersionAtLoad (int aVersion)

int	GetFileFormatVersionAtLoad () const

void	SetGenerator (const wxString &aGenerator)

const wxString &	GetGenerator () const

void	Add (BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
	Adds an item to 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...

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

void	BuildConnectivity ()
	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)
	Link a board to a given project. More...

void	ClearProject ()

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

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

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

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	GetSelectMenuText (EDA_UNITS aUnits) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

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

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

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

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

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

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

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

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

unsigned	GetNodesCount (int aNet=-1) const

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

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

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

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

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

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::vector< wxString >	GetNetClassAssignmentCandidates () const
	Return a list of name candidates for netclass assignment. More...

void	SynchronizeNetsAndNetClasses ()
	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, wxPoint aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch)
	Add an empty copper area to board areas list. More...

bool	NormalizeAreaPolygon (PICKED_ITEMS_LIST aNewZonesList, ZONE aCurrArea)
	Process an area that has been modified, by normalizing its polygon against itself. More...

bool	OnAreaPolygonModified (PICKED_ITEMS_LIST aModifiedZonesList, ZONE modified_area)
	Process an area that has been modified, by normalizing its polygon and merging the intersecting polygons for any other areas on the same net. More...

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

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

PAD *	GetPad (const wxPoint &aPosition) const

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

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

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

void	PadDelete (PAD *aPad)
	Delete a given pad from the BOARD by removing it from its footprint and from the m_NetInfo. 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 wxPoint &aPosition, PCB_LAYER_ID aActiveLayer, bool aVisibleOnly, bool aIgnoreLocked=false) const
	Get a footprint by its bounding rectangle at aPosition on aLayer. More...

void	ClearAllNetCodes ()
	Reset all items' netcodes to 0 (no net). 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	OnItemChanged (BOARD_ITEM *aItem)
	Notify the board and its listeners that an item on the board has been modified in some way. More...

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

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

wxString	GroupsSanityCheckInternal (bool repair)

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

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

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

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

void	SetX (int aX)

void	SetY (int aY)

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

virtual bool	IsOnCopperLayer () const

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

BOARD_ITEM_CONTAINER *	GetParent () const

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

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

virtual void	SetLayerSet (LSET aLayers)

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

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

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

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

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

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)
	Modify the 'lock' status for of the item. More...

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

void	Move (const VECTOR2I &aMoveVector)

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

void	Rotate (const VECTOR2I &aRotCentre, double aAngle)

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

void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)

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

virtual BOARD *	GetBoard ()

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

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	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const
	Convert the item shape to a closed polygon. More...

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

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

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

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...

bool	IsForceVisible () const

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

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

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

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

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

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

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

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

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

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

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

wxAny	Get (PROPERTY_BASE *aProperty)

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

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

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

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

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

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

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

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

Public Attributes
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::map< std::pair< BOARD_ITEM , BOARD_ITEM >, bool >	m_InsideCourtyardCache

std::map< std::pair< BOARD_ITEM , BOARD_ITEM >, bool >	m_InsideFCourtyardCache

std::map< std::pair< BOARD_ITEM , BOARD_ITEM >, bool >	m_InsideBCourtyardCache

std::map< std::pair< BOARD_ITEM , BOARD_ITEM >, bool >	m_InsideAreaCache

std::map< wxString, LSET >	m_LayerExpressionCache

std::map< ZONE *, std::unique_ptr< DRC_RTREE > >	m_CopperZoneRTrees

const KIID	m_Uuid

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

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

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

Protected Attributes
PCB_LAYER_ID	m_layer

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

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

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

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

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

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

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

int	m_timeStamp

wxString	m_fileName

MARKERS	m_markers

DRAWINGS	m_drawings

FOOTPRINTS	m_footprints

TRACKS	m_tracks

GROUPS	m_groups

ZONES	m_zones

LAYER	m_layers [PCB_LAYER_ID_COUNT]

HIGH_LIGHT_INFO	m_highLight

HIGH_LIGHT_INFO	m_highLightPrevious

int	m_fileFormatVersionAtLoad

wxString	m_generator

std::map< wxString, wxString >	m_properties

std::shared_ptr< CONNECTIVITY_DATA >	m_connectivity

PAGE_INFO	m_paper

TITLE_BLOCK	m_titles

PCB_PLOT_PARAMS	m_plotOptions

PROJECT *	m_project

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

NETINFO_LIST	m_NetInfo

std::vector< BOARD_LISTENER * >	m_listeners

Friends
class	PCB_EDIT_FRAME

Detailed Description

Information pertinent to a Pcbnew printed circuit board.

Definition at line 190 of file board.h.

Constructor & Destructor Documentation

◆ BOARD() [1/2]

BOARD::BOARD ( )

Definition at line 63 of file board.cpp.

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

References _, A4, GAL_LAYER_ID_BITMASK_END, GAL_LAYER_INDEX, BOARD_DESIGN_SETTINGS::GetDefault(), GetDesignSettings(), GetStandardLayerName(), IsCopperLayer(), LT_SIGNAL, LT_UNDEFINED, m_connectivity, m_fileFormatVersionAtLoad, m_layers, m_LegacyVisibleItems, m_LegacyVisibleLayers, LAYER::m_name, LAYER::m_type, NORMAL, PCB_LAYER_ID_COUNT, Rescue, GAL_SET::set(), NETCLASS::SetDescription(), ToLAYER_ID(), and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

◆ ~BOARD()

BOARD::~BOARD ( )

Definition at line 105 of file board.cpp.

 {
     // Clean up the owned elements
     DeleteMARKERs();
 
     for( ZONE* zone : m_zones )
         delete zone;
 
     m_zones.clear();
 
     for( FOOTPRINT* footprint : m_footprints )
         delete footprint;
 
     m_footprints.clear();
 
     for( PCB_TRACK* t : m_tracks )
         delete t;
 
     m_tracks.clear();
 
     for( BOARD_ITEM* d : m_drawings )
         delete d;
 
     m_drawings.clear();
 
     for( PCB_GROUP* g : m_groups )
         delete g;
 
     m_groups.clear();
 }

References DeleteMARKERs(), m_drawings, m_footprints, m_groups, 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`
	)

overridevirtual

Adds an item to the container.

Parameters

aMode decides whether the item is added in the beginning or at the end of the list.

Implements BOARD_ITEM_CONTAINER.

Definition at line 608 of file board.cpp.

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

References APPEND, NETINFO_LIST::AppendNet(), BULK_APPEND, BULK_INSERT, EDA_ITEM::ClearEditFlags(), ZONE::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_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_MARKER_T, PCB_NETINFO_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_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,
		wxPoint	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 1807 of file board.cpp.

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

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

Referenced by NormalizeAreaPolygon().

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

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

References alg::contains(), and m_listeners.

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

◆ AllConnectedItems()

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

Definition at line 1909 of file board.cpp.

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

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

Referenced by ClearAllNetCodes(), 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 693 of file board.h.

     {
         return m_NetInfo.begin();
     }

References NETINFO_LIST::begin(), and m_NetInfo.

◆ BuildConnectivity()

void BOARD::BuildConnectivity ( )

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

 {
     GetConnectivity()->Build( this );
 }

References GetConnectivity().

Referenced by PCB_CONTROL::AppendBoard(), TRACKS_CLEANER::cleanup(), TRACKS_CLEANER::deleteDanglingTracks(), LoadBoard(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_CONTROL::Paste(), Refresh(), SaveBoard(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), and PCB_EDIT_FRAME::UpdateUserInterface().

◆ BuildListOfNets()

void BOARD::BuildListOfNets ( )

inline

Definition at line 658 of file board.h.

     {
         m_NetInfo.buildListOfNets();
     }

References NETINFO_LIST::buildListOfNets(), and m_NetInfo.

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

◆ ClassOf()

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

inlinestatic

Definition at line 193 of file board.h.

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

References PCB_T, and EDA_ITEM::Type().

◆ ClearAllNetCodes()

void BOARD::ClearAllNetCodes ( )

Reset all items' netcodes to 0 (no net).

Definition at line 1929 of file board.cpp.

 {
     for( BOARD_CONNECTED_ITEM* item : AllConnectedItems() )
         item->SetNetCode( 0 );
 }

References AllConnectedItems().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 133 of file eda_item.h.

133 { ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:154

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 172 of file eda_item.h.

     {
         ClearFlags( GetEditFlags() );
     }

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

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 154 of file eda_item.h.

154 { m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

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

◆ ClearProject()

void BOARD::ClearProject ( )

Definition at line 173 of file board.cpp.

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

References GetDesignSettings(), PROJECT::GetProjectFile(), 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(), and SetProject().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:154

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 166 of file eda_item.h.

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

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

     {
         m_viewPrivData = nullptr;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * 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 FP_ZONE, ZONE, SCH_SYMBOL, PAD, FOOTPRINT, PCB_DIM_CENTER, PCB_DIM_LEADER, SCH_HIERLABEL, PCB_DIM_ORTHOGONAL, PCB_VIA, SCH_SHEET, PCB_DIM_ALIGNED, SCH_GLOBALLABEL, SCH_LABEL, PCB_ARC, SCH_TEXT, SCH_LINE, LIB_PIN, FP_TEXT, SCH_BUS_BUS_ENTRY, PCB_TRACK, SCH_FIELD, SCH_SHEET_PIN, LIB_FIELD, SCH_BUS_WIRE_ENTRY, FP_SHAPE, PCB_TEXT, SCH_BITMAP, PCB_SHAPE, PCB_GROUP, SCH_JUNCTION, SCH_NO_CONNECT, LIB_TEXT, SCH_MARKER, LIB_SHAPE, PCB_TARGET, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 83 of file eda_item.cpp.

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

References EDA_ITEM::GetClass().

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_DIMENSION_BASE::GetEffectiveShape(), LIB_SYMBOL::LIB_SYMBOL(), new_clone(), LIB_SYMBOL::operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_SYMBOL::SetConversion(), LIB_SYMBOL::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ComputeBoundingBox()

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

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

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

Referenced by buildBoardBoundingBoxPoly(), BuildBoardPolygonOutlines(), DIALOG_EXPORT_SVG::CreateSVGFile(), DRAWING_TOOL::DrawBoardCharacteristics(), PCB_EDIT_FRAME::ExportToGenCAD(), PLACE_FILE_EXPORTER::GenReportData(), GetBoardEdgesBoundingBox(), PCBNEW_PRINTOUT::getBoundingBox(), GetBoundingBox(), initializePlotter(), BOARD_ADAPTER::InitSettings(), DIALOG_EXPORT_STEP::onExportButton(), 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 72 of file board_items_to_polygon_shape_transform.cpp.

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

References ERROR_INSIDE, GetDesignSettings(), m_drawings, m_footprints, BOARD_DESIGN_SETTINGS::m_MaxError, m_tracks, PCB_SHAPE_T, PCB_TEXT_T, text, PCB_SHAPE::TransformShapeWithClearanceToPolygon(), 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 960 of file board.cpp.

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

References Footprints().

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

◆ ConvertKIIDsToCrossReferences()

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

Definition at line 1014 of file board.cpp.

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

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

Referenced by DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_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 74 of file board_item_container.h.

     {
         Remove( aItem );
         delete aItem;
     }

References BOARD_ITEM_CONTAINER::Remove().

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

◆ DeleteAllFootprints()

void BOARD::DeleteAllFootprints ( )

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

Definition at line 836 of file board.cpp.

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

References m_footprints.

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

◆ DeleteMARKERs() [1/2]

void BOARD::DeleteMARKERs ( )

Delete all MARKERS from the board.

Definition at line 804 of file board.cpp.

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

References m_markers.

Referenced by BOARD_DRC_ITEMS_PROVIDER::DeleteAllItems(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), DSN::SPECCTRA_DB::FromSESSION(), and ~BOARD().

◆ DeleteMARKERs() [2/2]

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

Definition at line 814 of file board.cpp.

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

References m_markers.

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 126 of file board_item.cpp.

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

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

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

◆ Drawings() [1/2]

DRAWINGS& BOARD::Drawings ( )

inline

Definition at line 236 of file board.h.

236 { return m_drawings; }

BOARD::m_drawings

DRAWINGS m_drawings

Definition: board.h:1120

References m_drawings.

Referenced by PCB_CONTROL::AppendBoard(), ZONE_FILLER::buildCopperItemClearances(), CreateBoardSection(), BOARD_ADAPTER::createLayers(), PCB_DRAW_PANEL_GAL::DisplayBoard(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), FillItemMap(), DRC_TEST_PROVIDER::forEachGeometryItem(), PCB_IO::format(), GENDRILL_WRITER_BASE::genDrillMapFile(), AR_AUTOPLACER::genPlacementRoutingMatrix(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), GetItem(), idf_export_outline(), ALTIUM_PCB::Parse(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BRDITEMS_PLOTTER::PlotBoardGraphicItems(), BOARD_EDITOR_CONTROL::RepairBoard(), 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 237 of file board.h.

237 { return m_drawings; }

BOARD::m_drawings

DRAWINGS m_drawings

Definition: board.h:1120

References m_drawings.

◆ Duplicate()

virtual BOARD_ITEM* BOARD_ITEM::Duplicate ( ) const

inlinevirtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 169 of file board_item.h.

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

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), EDIT_TOOL::Duplicate(), 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 701 of file board.h.

     {
         return m_NetInfo.end();
     }

References NETINFO_LIST::end(), and m_NetInfo.

◆ FillItemMap()

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

Definition at line 924 of file board.cpp.

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

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

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

◆ FinalizeBulkAdd()

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

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

Definition at line 698 of file board.cpp.

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

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

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

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

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

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

◆ FindFootprintByPath()

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

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

Parameters

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

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

Definition at line 1358 of file board.cpp.

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

References m_footprints.

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

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

References m_footprints.

Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), DSN::SPECCTRA_DB::FromSESSION(), and DRC_TEST_PROVIDER_LVS::testFootprints().

◆ FindNet() [1/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 1325 of file board.cpp.

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

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

Referenced by PCAD2KICAD::PCB_PAD::AddToFootprint(), CreateSignalsSection(), PNS_PCBNEW_RULE_RESOLVER::DpCoupledNet(), PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), PNS_PCBNEW_RULE_RESOLVER::DpNetPolarity(), PCB_EDIT_FRAME::Edit_Zone_Params(), DIALOG_COPPER_ZONE::ensureSelectedNetIsVisible(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), BOARD_INSPECTION_TOOL::highlightNet(), inDiffPair(), 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 *(), SanitizeNetcodes(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and ROUTER_TOOL::updateMessagePanel().

◆ FindNet() [2/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 1340 of file board.cpp.

 {
     return m_NetInfo.GetNetItem( aNetname );
 }

References NETINFO_LIST::GetNetItem(), and m_NetInfo.

◆ Flip() [1/2]

void BOARD_ITEM::Flip	(	const wxPoint &	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 ZONE, PCB_VIA, PAD, PCB_ARC, FOOTPRINT, PCB_DIMENSION_BASE, PCB_GROUP, FP_TEXT, PCB_SHAPE, FP_SHAPE, PCB_TEXT, PCB_TRACK, PCB_TARGET, and PCB_MARKER.

Definition at line 183 of file board_item.cpp.

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

References EDA_ITEM::GetClass().

Referenced by BOARD_ITEM::Flip().

◆ Flip() [2/2]

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

inlineinherited

Definition at line 267 of file board_item.h.

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

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

◆ Footprints() [1/2]

FOOTPRINTS& BOARD::Footprints ( )

inline

Definition at line 233 of file board.h.

233 { return m_footprints; }

BOARD::m_footprints

FOOTPRINTS m_footprints

Definition: board.h:1121

References m_footprints.

◆ Footprints() [2/2]

const FOOTPRINTS& BOARD::Footprints ( ) const

inline

Definition at line 234 of file board.h.

234 { return m_footprints; }

BOARD::m_footprints

FOOTPRINTS m_footprints

Definition: board.h:1121

References m_footprints.

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 86 of file inspectable.h.

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

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

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

◆ Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 95 of file inspectable.h.

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

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

◆ Get() [3/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

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

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

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

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

References m_zones.

Referenced by DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SaveCopyOfZones(), and UpdateCopyOfZonesList().

◆ GetAreaCount()

int BOARD::GetAreaCount ( ) const

inline

Returns: The number of copper pour areas or ZONEs.

Definition at line 845 of file board.h.

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

References m_zones.

◆ GetBoard() [1/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 36 of file board_item.cpp.

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

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

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

◆ GetBoard() [2/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 50 of file board_item.cpp.

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

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

◆ GetBoardEdgesBoundingBox()

const EDA_RECT 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 737 of file board.h.

     {
         return ComputeBoundingBox( true );
     }

References ComputeBoundingBox().

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

◆ GetBoardPolygonOutlines()

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

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

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

Parameters

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

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

Definition at line 1880 of file board.cpp.

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

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

Referenced by DSN::SPECCTRA_DB::BuiltBoardOutlines(), BOARD_ADAPTER::createBoardPolygon(), 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 210 of file board.h.

210 { return m_boardUse; }

BOARD::m_boardUse

BOARD_USE m_boardUse

What is this board being used for.

Definition: board.h:1115

References m_boardUse.

◆ GetBoundingBox()

const EDA_RECT 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 723 of file board.h.

     {
         return ComputeBoundingBox( false );
     }

References ComputeBoundingBox().

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

◆ GetCenter()

virtual wxPoint BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

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

Returns: center point of the item

Reimplemented in PCB_ARC, PAD, PCB_SHAPE, and PCB_MARKER.

Definition at line 81 of file board_item.h.

     {
         return GetBoundingBox().GetCenter();
     }

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

Referenced by PCB_GRID_HELPER::computeAnchors(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), and ALTIUM_PCB::HelperParseDimensions6Radial().

◆ GetClass()

wxString BOARD::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 798 of file board.h.

     {
         return wxT( "BOARD" );
     }

Referenced by Visit().

◆ GetConnectivity()

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

inline

Return a list of missing connections between components/tracks.

Returns: an object that contains information about missing connections.

Definition at line 344 of file board.h.

344 { return m_connectivity; }

BOARD::m_connectivity

std::shared_ptr< CONNECTIVITY_DATA > m_connectivity

Definition: board.h:1135

References m_connectivity.

Referenced by BuildConnectivity(), BOARD_NETLIST_UPDATER::cacheCopperZoneConnections(), FROM_TO_CACHE::cacheFromToPaths(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), TRACKS_CLEANER::cleanup(), ZONE_CREATE_HELPER::commitZone(), PCB_BASE_FRAME::Compile_Ratsnest(), TRACKS_CLEANER::deleteDanglingTracks(), TRACKS_CLEANER::deleteTracksInPads(), PCB_DRAW_PANEL_GAL::DisplayBoard(), EDIT_TOOL::DragArcTrack(), PCB_EDIT_FRAME::Edit_Zone_Params(), exprFromTo(), ZONE_FILLER::Fill(), EDIT_TOOL::FilletTracks(), PCB_VIA::FlashLayer(), PAD::FlashLayer(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), GetMsgPanelInfo(), GetTrackLength(), PCB_EDIT_FRAME::ImportSpecctraSession(), TRACKS_CLEANER::mergeCollinearSegments(), PadDelete(), 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(), AR_AUTOPLACER::rotateFootprint(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_SELECTION_TOOL::selectAllItemsOnNet(), PCB_SELECTION_TOOL::selectConnectedTracks(), PCB_EDIT_FRAME::SetBoard(), TRACKS_CLEANER::testTrackEndpointIsNode(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ GetCopperLayerCount()

int BOARD::GetCopperLayerCount ( ) const

Returns: The number of copper layers in the BOARD.

Definition at line 455 of file board.cpp.

 {
     return GetDesignSettings().GetCopperLayerCount();
 }

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

Referenced by GERBER_JOBFILE_WRITER::addJSONDesignRules(), GERBER_JOBFILE_WRITER::addJSONFilesAttributes(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PCB_CONTROL::AppendBoard(), GENDRILL_WRITER_BASE::BuildFileFunctionAttributeString(), DSN::SPECCTRA_DB::buildLayerMaps(), PANEL_SETUP_LAYERS::CheckCopperLayerCount(), compute_pad_access_code(), EXPORTER_PCB_VRML::ComputeLayer3D_Zpos(), CreateComponentsSection(), CreatePadsShapesSection(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), CreateRoutesSection(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DRAWING_TOOL::DrawVia(), PCB_TRACK::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), ZONE::Flip(), DSN::SPECCTRA_DB::FromBOARD(), GetGerberFileFunctionAttribute(), BOARD_ADAPTER::InitSettings(), EAGLE_PLUGIN::Load(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DSN::SPECCTRA_DB::makeVIA(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), DRC_TEST_PROVIDER_DISALLOW::Run(), ZONE_SETTINGS::SetupLayersList(), PCB_BASE_FRAME::SwitchLayer(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), PANEL_SETUP_LAYERS::TransferDataToWindow(), and via_access_code().

◆ GetDesignSettings()

BOARD_DESIGN_SETTINGS & BOARD::GetDesignSettings ( ) const

Returns: the BOARD_DESIGN_SETTINGS for this BOARD

Definition at line 590 of file board.cpp.

 {
     return *m_designSettings;
 }

References m_designSettings.

Referenced by AddGerberX2Header(), ZONE_FILLER::addHoleKnockout(), GERBER_JOBFILE_WRITER::addJSONDesignRules(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), BOARD(), build_pad_testpoints(), build_via_testpoints(), ZONE_FILLER::buildCopperItemClearances(), PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetclassesGrid(), ZONE::BuildSmoothedPoly(), ZONE_FILLER::buildThermalSpokes(), calcIsInsideArea(), DIALOG_NET_INSPECTOR::calculateViaLength(), CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), EDIT_TOOL::ChangeTrackWidth(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), ClearProject(), ZONE_CREATE_HELPER::commitZone(), EXPORTER_PCB_VRML::ComputeLayer3D_Zpos(), ZONE_FILLER::computeRawFilledArea(), ConvertBrdLayerToPolygonalContours(), BOARD_ADAPTER::createBoardPolygon(), MICROWAVE_TOOL::createInductorBetween(), BOARD_ADAPTER::createLayers(), CreatePadsShapesSection(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), CreateRoutesSection(), DIALOG_EXPORT_SVG::CreateSVGFile(), ROUTER_TOOL::CustomTrackWidthDialog(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), ROUTER_TOOL::DpDimensionsDialog(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), VIA_SIZE_MENU::eventHandler(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportToGenCAD(), ZONE_FILLER::Fill(), KI_TEST::FillZones(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_IO::formatGeneral(), PCB_IO::formatSetup(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), PCB_BASE_FRAME::GetAuxOrigin(), GetBoardPolygonOutlines(), PCB_MARKER::GetColorLayer(), GetCopperLayerCount(), BOARD_DRC_ITEMS_PROVIDER::GetCount(), VECTOR_DRC_ITEMS_PROVIDER::GetCount(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), PCB_VIA::GetEffectiveShape(), GetEnabledLayers(), PCB_BASE_FRAME::GetGridOrigin(), CADSTAR_PCB_ARCHIVE_LOADER::getHatchCodeAngleDegrees(), BOARD_ADAPTER::GetHolePlatingThickness(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadHatchCodeGap(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadHatchCodeThickness(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), CADSTAR_PCB_ARCHIVE_LOADER::getLineThickness(), PCB_VIA::GetMinAnnulus(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetOwnClearance(), DRAWING_TOOL::getSegmentWidth(), PCB_BASE_FRAME::GetSeverity(), DRC_ENGINE::GetShape(), PAD::GetSolderMaskMargin(), GetTrackLength(), PCB_TRACK::GetWidthConstraints(), PCB_BASE_FRAME::GetZoneSettings(), GetZoneSettings(), ROUTER_TOOL::handleLayerSwitch(), ALTIUM_PCB::HelperCreateBoardOutline(), PANEL_SETUP_BOARD_FINISH::ImportSettingsFrom(), PANEL_SETUP_CONSTRAINTS::ImportSettingsFrom(), PANEL_SETUP_TEXT_AND_GRAPHICS::ImportSettingsFrom(), PANEL_SETUP_TRACKS_AND_VIAS::ImportSettingsFrom(), PANEL_SETUP_MASK_AND_PASTE::ImportSettingsFrom(), PANEL_SETUP_BOARD_STACKUP::ImportSettingsFrom(), PNS_KICAD_IFACE_BASE::ImportSizes(), DIALOG_PLOT::init_Dialog(), initializePlotter(), BOARD_ADAPTER::InitSettings(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), IsLayerEnabled(), IsLayerVisible(), EAGLE_PLUGIN::Load(), LoadBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), EAGLE_PLUGIN::loadClasses(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadGENERAL(), DRC_ENGINE::loadImplicitRules(), LEGACY_PLUGIN::loadNETCLASS(), FABMASTER::loadOutline(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), LEGACY_PLUGIN::loadSETUP(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadVias(), DSN::SPECCTRA_DB::makePADSTACK(), CONVERT_TOOL::makePolysFromCircles(), PAD::MergePrimitivesAsPolygon(), NETINFO_ITEM::NETINFO_ITEM(), DIALOG_PAD_PROPERTIES::onAddPrimitive(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), PANEL_SETUP_RULES::onScintillaCharAdded(), DIALOG_POSITION_RELATIVE::OnUseGridOriginClick(), PCB_EDIT_FRAME::OpenProjectFiles(), EAGLE_PLUGIN::packageWire(), DIALOG_PAD_PROPERTIES::padValuesOK(), PANEL_SETUP_BOARD_FINISH::PANEL_SETUP_BOARD_FINISH(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), PANEL_SETUP_CONSTRAINTS::PANEL_SETUP_CONSTRAINTS(), PANEL_SETUP_MASK_AND_PASTE::PANEL_SETUP_MASK_AND_PASTE(), PANEL_SETUP_TEXT_AND_GRAPHICS::PANEL_SETUP_TEXT_AND_GRAPHICS(), PANEL_SETUP_TRACKS_AND_VIAS::PANEL_SETUP_TRACKS_AND_VIAS(), ALTIUM_PCB::Parse(), ALTIUM_PCB::ParseBoard6Data(), ALTIUM_PCB::ParseClasses6Data(), PLACE_FILE_EXPORTER::PLACE_FILE_EXPORTER(), BOARD_EDITOR_CONTROL::PlaceTarget(), DIALOG_PLOT::Plot(), PlotOneBoardLayer(), PlotSolderMaskLayer(), PlotStandardLayer(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), APPEARANCE_CONTROLS::rebuildNets(), PAD_TOOL::recombinePad(), PCB_EDIT_FRAME::RecordDRCExclusions(), DIALOG_PLOT::reInitDialog(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TOOL::Reset(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), PCB_BASE_EDIT_FRAME::SetBoard(), SetCopperLayerCount(), SetEnabledLayers(), PCB_BASE_FRAME::SetGridOrigin(), NETINFO_ITEM::SetNetClass(), DIALOG_PLOT::SetPlotFormat(), SetProject(), BOARD_DRC_ITEMS_PROVIDER::SetSeverities(), VECTOR_DRC_ITEMS_PROVIDER::SetSeverities(), PCB_BASE_FRAME::SetZoneSettings(), SetZoneSettings(), APPEARANCE_CONTROLS::showNetclass(), PNS_KICAD_IFACE_BASE::StackupHeight(), SynchronizeNetsAndNetClasses(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncVia(), PNS_KICAD_IFACE_BASE::SyncWorld(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_MISC::testOutline(), PANEL_SETUP_RULES::TransferDataFromWindow(), ZONE::TransformSmoothedOutlineToPolygon(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), DIALOG_GENDRILL::UpdateDrillParams(), PCB_TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), PCB_MARKER::ViewGetLayers(), WriteDRCReport(), DIALOG_DRC::writeReport(), and HYPERLYNX_EXPORTER::writeStackupInfo().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 158 of file eda_item.h.

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

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

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > BOARD_ITEM::GetEffectiveShape ( PCB_LAYER_ID aLayer = UNDEFINED_LAYER ) 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.

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

Definition at line 167 of file board_item.cpp.

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

References EDA_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

Referenced by calcIsInsideArea(), calcIsInsideCourtyard(), DRC_ENGINE::GetShape(), PCB_SELECTION_TOOL::hitTestDistance(), DRC_RTREE::Insert(), DRC_RTREE::QueryColliding(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), and CONNECTIVITY_DATA::TestTrackEndpointDangling().

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

 {
     return GetDesignSettings().GetEnabledLayers();
 }

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

Referenced by PCB_CONTROL::AppendBoard(), DIALOG_PLOT::applyPlotSettings(), PCB_ONE_LAYER_SELECTOR::buildList(), SELECT_COPPER_LAYERS_PAIR_DIALOG::buildList(), PCB_IO::formatBoardLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), PCB_LAYER_BOX_SELECTOR::getEnabledLayers(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), HYPERLYNX_PAD_STACK::isEmpty(), BOARD_ITEM::layerMaskDescribe(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), DIALOG_PLOT::Plot(), APPEARANCE_CONTROLS::rebuildLayers(), CADSTAR_PCB_ARCHIVE_LOADER::remapUnsureLayers(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), PANEL_SETUP_LAYERS::TransferDataToWindow(), PCB_EDIT_FRAME::UpdateUserInterface(), PCB_VIA::ViewGetLOD(), PAD::ViewGetLOD(), and HYPERLYNX_EXPORTER::writeSinglePadStack().

◆ GetFileFormatVersionAtLoad()

int BOARD::GetFileFormatVersionAtLoad ( ) const

inline

Definition at line 289 of file board.h.

289 { return m_fileFormatVersionAtLoad; }

BOARD::m_fileFormatVersionAtLoad

int m_fileFormatVersionAtLoad

Definition: board.h:1131

References m_fileFormatVersionAtLoad.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetFileName()

const wxString& BOARD::GetFileName ( void ) const

inline

Definition at line 228 of file board.h.

228 { return m_fileName; }

BOARD::m_fileName

wxString m_fileName

Definition: board.h:1118

References m_fileName.

◆ GetFirstFootprint()

FOOTPRINT* BOARD::GetFirstFootprint ( ) const

inline

Get the first footprint on the board or nullptr.

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

Returns: first footprint or null pointer

Definition at line 317 of file board.h.

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

References m_footprints.

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 155 of file eda_item.h.

155 { return m_flags; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

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

◆ GetFocusPosition()

const wxPoint 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 279 of file board.h.

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

BOARD::GetBoundingBox

const EDA_RECT GetBoundingBox() const override

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

Definition: board.h:723

EDA_RECT::GetCenter

const wxPoint GetCenter() const

Definition: eda_rect.h:104

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

◆ GetFootprint()

FOOTPRINT * BOARD::GetFootprint	(	const wxPoint &	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 wxPoint 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 1723 of file board.cpp.

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

References EDA_RECT::GetHeight(), EDA_RECT::GetWidth(), EDA_RECT::GetX(), EDA_RECT::GetY(), IsBackLayer(), IsFootprintLayerVisible(), and m_footprints.

◆ GetGenerator()

const wxString& BOARD::GetGenerator ( ) const

inline

Definition at line 292 of file board.h.

292 { return m_generator; }

BOARD::m_generator

wxString m_generator

Definition: board.h:1132

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

     {
         return m_highLight.m_netCodes;
     }

References m_highLight, and HIGH_LIGHT_INFO::m_netCodes.

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

◆ GetItem()

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

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

Definition at line 845 of file board.cpp.

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

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

Referenced by CollisionMatchesExpected(), ConvertKIIDsToCrossReferences(), PCB_BASE_FRAME::FocusOnItem(), PCB_BASE_FRAME::GetItem(), PCB_TEXT::GetShownText(), BOARD_INSPECTION_TOOL::InspectDRCError(), InvalidMatchesExpected(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), and DIALOG_FOOTPRINT_CHECKER::OnSelectItem().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 140 of file board_item.h.

140 { return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:316

References BOARD_ITEM::m_layer.

◆ GetLayerID()

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

Return the ID of a layer.

Definition at line 340 of file board.cpp.

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

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

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

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

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

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

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

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

References GetStandardLayerName(), IsLayerEnabled(), and m_layers.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DSN::SPECCTRA_DB::buildLayerMaps(), PANEL_SETUP_BOARD_STACKUP::createRowData(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), GRID_CELL_LAYER_RENDERER::Draw(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_IO::formatBoardLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), PCB_LAYER_SELECTOR::getLayerName(), PCB_LAYER_BOX_SELECTOR::getLayerName(), BOARD_ITEM::GetLayerName(), ZONE::GetMsgPanelInfo(), ZONE::GetSelectMenuText(), GRID_CELL_LAYER_SELECTOR::GetValue(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), CADSTAR_PCB_ARCHIVE_LOADER::Load(), DIALOG_PLOT::Plot(), APPEARANCE_CONTROLS::rebuildLayers(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), ZONE_SETTINGS::SetupLayersList(), PANEL_SETUP_LAYERS::showBoardLayerNames(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), DIALOG_PAD_PROPERTIES::UpdateLayersDropdown(), HYPERLYNX_EXPORTER::writeDevices(), 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 PAD, PCB_VIA, ZONE, and PCB_GROUP.

Definition at line 145 of file board_item.h.

145 { return LSET( m_layer ); }

LSET

LSET is a set of PCB_LAYER_IDs.

Definition: layer_ids.h:504

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:316

References BOARD_ITEM::m_layer.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), existsOnLayer(), extractDiffPairCoupledItems(), hash_board_item(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_ITEM::layerMaskDescribe(), FABMASTER::loadZone(), PCB_GRID_HELPER::nearestAnchor(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), CN_VISITOR::operator()(), EDIT_TOOL::Properties(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

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

 {
     if( !IsCopperLayer( aLayer ) )
         return LT_SIGNAL;
 
     //@@IMB: The original test was broken due to the discontinuity
     // in the layer sequence.
     if( IsLayerEnabled( aLayer ) )
         return m_layers[aLayer].m_type;
 
     return LT_SIGNAL;
 }

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

Referenced by PCB_IO::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 ZONE, SCH_SYMBOL, PAD, FOOTPRINT, PCB_DIM_CENTER, PCB_DIM_LEADER, SCH_HIERLABEL, PCB_DIM_ORTHOGONAL, SCH_GLOBALLABEL, PCB_VIA, SCH_SHEET, PCB_DIM_ALIGNED, SCH_LABEL, GERBER_DRAW_ITEM, SCH_TEXT, LIB_PIN, FP_TEXT, SCH_LINE, SCH_BUS_BUS_ENTRY, PCB_TRACK, PCB_GROUP, SCH_FIELD, SCH_SHEET_PIN, LIB_FIELD, SCH_BUS_WIRE_ENTRY, FP_SHAPE, PCB_TEXT, PCB_SHAPE, SCH_BITMAP, LIB_TEXT, LIB_SHAPE, SCH_NO_CONNECT, SCH_MARKER, PCB_MARKER, PCB_TARGET, and SCH_JUNCTION.

Definition at line 211 of file eda_item.cpp.

 {
     return BITMAPS::dummy_item;
 }

References dummy_item.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and PCB_SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1143 of file board.cpp.

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

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

◆ GetNetClassAssignmentCandidates()

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

Return a list of name candidates for netclass assignment.

Tokens may appear more than once if they were harvested from hierarchical nets (ie: /CLK, /sheet1/CLK).

Definition at line 1370 of file board.cpp.

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

References m_NetInfo.

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

◆ GetNetCount()

unsigned BOARD::GetNetCount ( ) const

inline

Returns: the number of nets (NETINFO_ITEM).

Definition at line 710 of file board.h.

     {
         return m_NetInfo.GetNetCount();
     }

References NETINFO_LIST::GetNetCount(), and m_NetInfo.

Referenced by CreateSignalsSection().

◆ GetNetInfo() [1/2]

const NETINFO_LIST& BOARD::GetNetInfo ( ) const

inline

Definition at line 679 of file board.h.

     {
         return m_NetInfo;
     }

References m_NetInfo.

Referenced by BOOST_AUTO_TEST_CASE(), CONNECTIVITY_DATA::Build(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_NET_INSPECTOR::buildNetsList(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DSN::SPECCTRA_DB::FromBOARD(), FABMASTER::loadEtch(), FABMASTER::loadFootprints(), PCB_EDIT_FRAME::LoadProjectSettings(), FABMASTER::loadVias(), FABMASTER::loadZone(), FABMASTER::loadZones(), main(), DIALOG_NET_INSPECTOR::onRenameNet(), DIALOG_COPPER_ZONE::readNetInformation(), NET_GRID_TABLE::Rebuild(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), PCB_EDIT_FRAME::SaveProjectSettings(), APPEARANCE_CONTROLS::showNetclass(), TestForExistingItem(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and HYPERLYNX_EXPORTER::writeNets().

◆ GetNetInfo() [2/2]

NETINFO_LIST& BOARD::GetNetInfo ( )

inline

Definition at line 684 of file board.h.

     {
         return m_NetInfo;
     }

References m_NetInfo.

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

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

References Footprints(), and pad.

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

◆ GetPad() [1/4]

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

Find a pad aPosition on aLayer.

Parameters

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

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

Definition at line 1458 of file board.cpp.

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

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

Referenced by GetPad().

◆ GetPad() [2/4]

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

inline

Definition at line 909 of file board.h.

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

References GetPad().

◆ GetPad() [3/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 1478 of file board.cpp.

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

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

◆ GetPad() [4/4]

PAD * BOARD::GetPad	(	std::vector< PAD * > &	aPadList,
		const wxPoint &	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 wxPoint 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 1507 of file board.cpp.

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

References delta, and pad.

◆ GetPadFast()

PAD * BOARD::GetPadFast	(	const wxPoint &	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 wxPoint object containing the position to hit test.
aLayerMask	A layer or layers to mask the hit test.

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

Definition at line 1488 of file board.cpp.

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

References Footprints(), and pad.

◆ GetPads()

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

Return a reference to a list of all the pads.

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

Returns: a full list of pads.

Definition at line 1895 of file board.cpp.

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

References Footprints(), and pad.

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

◆ GetPageSettings()

const PAGE_INFO& BOARD::GetPageSettings ( ) const

inline

Definition at line 535 of file board.h.

535 { return m_paper; }

BOARD::m_paper

PAGE_INFO m_paper

Definition: board.h:1137

References m_paper.

Referenced by DIALOG_EXPORT_SVG::CreateSVGFile(), BOARD_NETLIST_UPDATER::estimateFootprintInsertionPosition(), PCB_IO::formatGeneral(), PCB_BASE_FRAME::GetPageSettings(), PCB_BASE_FRAME::GetPageSizeIU(), initializePlotter(), ALTIUM_PCB::Parse(), PCB_EDIT_FRAME::SetBoard(), and StartPlotBoard().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 135 of file board_item.h.

135 { return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:479

BOARD_ITEM_CONTAINER

Abstract interface for BOARD_ITEMs capable of storing other items inside.

Definition: board_item_container.h:52

References EDA_ITEM::m_parent.

Referenced by PCB_POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PNS_KICAD_IFACE::Commit(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), BOARD_ITEM::DeleteStructure(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), PCB_MARKER::GetColorLayer(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), FP_TEXT::GetSelectMenuText(), PCB_TEXT::GetShownText(), FP_TEXT::GetShownText(), getTopLevelGroup(), GENERAL_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), isInsideArea(), DRC_ENGINE::IsNetTie(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), PCB_SELECTION_TOOL::itemPassesFilter(), LEGACY_PLUGIN::loadMODULE_TEXT(), memberOf(), EDIT_TOOL::MoveExact(), ALTIUM_PCB::ParseTexts6Data(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), POSITION_RELATIVE_TOOL::PositionRelative(), BOARD_COMMIT::Push(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_MARKER::ViewGetLayers(), FP_ZONE::ViewGetLOD(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetParentGroup()

PCB_GROUP* BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 60 of file board_item.h.

60 { return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:317

References BOARD_ITEM::m_group.

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

◆ GetPlotOptions()

const PCB_PLOT_PARAMS& BOARD::GetPlotOptions ( ) const

inline

Definition at line 538 of file board.h.

538 { return m_plotOptions; }

BOARD::m_plotOptions

PCB_PLOT_PARAMS m_plotOptions

Definition: board.h:1139

References m_plotOptions.

Referenced by AddGerberX2Header(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), PCB_IO::formatSetup(), PCB_BASE_FRAME::GetPlotSettings(), and DIALOG_GENDRILL::UpdateDrillParams().

◆ GetPosition()

wxPoint BOARD::GetPosition ( ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 256 of file board.cpp.

 {
     return ZeroOffset;
 }

References BOARD_ITEM::ZeroOffset.

◆ GetProject()

PROJECT* BOARD::GetProject ( ) const

inline

Definition at line 360 of file board.h.

360 { return m_project; }

BOARD::m_project

PROJECT * m_project

Definition: board.h:1140

References m_project.

Referenced by AddGerberX2Header(), GetFootprintLibraryTable(), PCB_TEXT::GetShownText(), APPEARANCE_CONTROLS::rebuildNets(), StartPlotBoard(), and DRC_TEST_PROVIDER_MISC::testTextVars().

◆ GetProperties()

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

inline

Definition at line 258 of file board.h.

258 { return m_properties; }

BOARD::m_properties

std::map< wxString, wxString > m_properties

Definition: board.h:1134

References m_properties.

Referenced by PCB_CONTROL::AppendBoard(), and PCB_IO::formatProperties().

◆ GetSelectMenuText()

wxString BOARD::GetSelectMenuText ( EDA_UNITS aUnits ) const

overridevirtual

Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 798 of file board.cpp.

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

References _, and Format().

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

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

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

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

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

References LayerName().

Referenced by BOARD(), DIALOG_EXPORT_SVG::ExportSVGFile(), PCB_IO::format(), GetLayerID(), BOARD_ITEM::GetLayerName(), and GetLayerName().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 137 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 150 of file eda_item.h.

150 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

◆ GetTimeStamp()

int BOARD::GetTimeStamp ( ) const

inline

Definition at line 214 of file board.h.

214 { return m_timeStamp; }

BOARD::m_timeStamp

int m_timeStamp

Definition: board.h:1116

References m_timeStamp.

Referenced by FOOTPRINT::GetBoundingBox(), and FOOTPRINT::GetBoundingHull().

◆ GetTitleBlock() [1/2]

TITLE_BLOCK& BOARD::GetTitleBlock ( )

inline

Definition at line 541 of file board.h.

541 { return m_titles; }

BOARD::m_titles

TITLE_BLOCK m_titles

Definition: board.h:1138

References m_titles.

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), PCB_IO::formatGeneral(), PCB_BASE_FRAME::GetTitleBlock(), ResolveTextVar(), and StartPlotBoard().

◆ GetTitleBlock() [2/2]

const TITLE_BLOCK& BOARD::GetTitleBlock ( ) const

inline

Definition at line 542 of file board.h.

542 { return m_titles; }

BOARD::m_titles

TITLE_BLOCK m_titles

Definition: board.h:1138

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

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

References EOT, 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_PAD_T, PCB_TRACE_T, PCB_VIA_T, and via.

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

◆ GetUnconnectedNetCount()

unsigned BOARD::GetUnconnectedNetCount ( ) const

Returns: the number of unconnected nets in the current ratsnest.

Definition at line 1076 of file board.cpp.

 {
     return m_connectivity->GetUnconnectedCount();
 }

References m_connectivity.

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

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

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

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

◆ GetVisibleLayers()

LSET BOARD::GetVisibleLayers ( ) const

A proxy function that calls the correspondent function in m_BoardSettings.

Returns: the visible layers in bit-mapped form.

Definition at line 481 of file board.cpp.

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

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

Referenced by ComputeBoundingBox(), GENDRILL_WRITER_BASE::genDrillMapFile(), PCB_BASE_FRAME::GetCollectorsGuide(), APPEARANCE_CONTROLS::getVisibleLayers(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::Selectable(), PCB_EDIT_FRAME::UpdateUserInterface(), PCB_VIA::ViewGetLOD(), and PAD::ViewGetLOD().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 64 of file board_item.h.

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

References EDA_ITEM::GetPosition().

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 70 of file board_item.h.

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

References EDA_ITEM::GetPosition().

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

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

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

References m_footprints, and Zones().

◆ GetZoneSettings()

const ZONE_SETTINGS & BOARD::GetZoneSettings ( ) const

overridevirtual

Fetch the zone settings for this container.

Reimplemented from BOARD_ITEM_CONTAINER.

Definition at line 596 of file board.cpp.

 {
     return GetDesignSettings().GetDefaultZoneSettings();
 }

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

Referenced by LEGACY_PLUGIN::loadSETUP().

◆ GroupLegalOps()

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

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

Returns: bit field of legal ops.

Definition at line 2102 of file board.cpp.

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

References BOARD::GroupLegalOpsField::create, BOARD::GroupLegalOpsField::enter, 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 253 of file board.h.

253 { return m_groups; }

BOARD::m_groups

GROUPS m_groups

Definition: board.h:1123

References m_groups.

Referenced by PCB_CONTROL::AppendBoard(), PCB_IO::format(), GroupsSanityCheckInternal(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::RepairBoard(), and TestForExistingItem().

◆ Groups() [2/2]

const GROUPS& BOARD::Groups ( ) const

inline

Definition at line 254 of file board.h.

254 { return m_groups; }

BOARD::m_groups

GROUPS m_groups

Definition: board.h:1123

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

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

References GroupsSanityCheckInternal().

Referenced by PCB_IO::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 2036 of file board.cpp.

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

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

Referenced by GroupsSanityCheck().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 156 of file eda_item.h.

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

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

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

◆ HighLightOFF()

void BOARD::HighLightOFF ( )

inline

Disable net highlight.

Definition at line 416 of file board.h.

     {
         HighLightON( false );
     }

References HighLightON().

◆ HighLightON()

void BOARD::HighLightON ( bool aValue = true )

Enable or disable net highlighting.

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

Definition at line 2013 of file board.cpp.

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

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

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

◆ HitTest() [1/2]

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

inlinevirtualinherited

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

Parameters

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

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

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

Definition at line 225 of file eda_item.h.

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

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

◆ HitTest() [2/2]

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

inlinevirtualinherited

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

Parameters

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

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

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

Definition at line 238 of file eda_item.h.

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

◆ IncrementTimeStamp()

void BOARD::IncrementTimeStamp ( )

Definition at line 192 of file board.cpp.

 {
     m_timeStamp++;
 
     {
         std::unique_lock<std::mutex> cacheLock( m_CachesMutex );
         m_InsideAreaCache.clear();
         m_InsideCourtyardCache.clear();
         m_InsideFCourtyardCache.clear();
         m_InsideBCourtyardCache.clear();
         m_LayerExpressionCache.clear();
     }
 
     m_CopperZoneRTrees.clear();
 }

References m_CachesMutex, m_CopperZoneRTrees, m_InsideAreaCache, m_InsideBCourtyardCache, m_InsideCourtyardCache, m_InsideFCourtyardCache, m_LayerExpressionCache, and m_timeStamp.

Referenced by ZONE_FILLER_TOOL::FillAllZones(), DRC_ENGINE::InitEngine(), PCB_BASE_FRAME::OnModify(), and DRC_ENGINE::RunTests().

◆ InvokeListeners()

template<typename Func , typename... Args>

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

inlineprivate

Definition at line 1106 of file board.h.

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

References m_listeners.

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 126 of file eda_item.h.

126 { return m_flags & BRIGHTENED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented in ZONE, and BOARD_CONNECTED_ITEM.

Definition at line 103 of file board_item.h.

     {
         return false;
     }

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

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 121 of file eda_item.h.

121 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

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

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

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

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

◆ IsEmpty()

bool BOARD::IsEmpty ( ) const

inline

Definition at line 281 of file board.h.

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

References m_drawings, m_footprints, m_tracks, and m_zones.

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

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & ENTERED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsFootprintHolder()

bool BOARD::IsFootprintHolder ( ) const

inline

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

Returns: if the board is just holding a footprint

Definition at line 221 of file board.h.

     {
         return m_boardUse == BOARD_USE::FPHOLDER;
     }

References FPHOLDER, and m_boardUse.

Referenced by BOARD_ADAPTER::createBoardPolygon(), and BOARD_ADAPTER::InitSettings().

◆ IsFootprintLayerVisible()

bool BOARD::IsFootprintLayerVisible ( PCB_LAYER_ID aLayer ) const

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

Parameters

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

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

Definition at line 572 of file board.cpp.

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

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

Referenced by GetFootprint().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

206 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

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

402 { return m_highLight.m_highLightOn; }

BOARD::m_highLight

HIGH_LIGHT_INFO m_highLight

Definition: board.h:1128

HIGH_LIGHT_INFO::m_highLightOn

bool m_highLightOn

Definition: board.h:138

References m_highLight, and HIGH_LIGHT_INFO::m_highLightOn.

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

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

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

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

Referenced by GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), GetLayerName(), GetLayerType(), BOARD_ADAPTER::Is3dLayerEnabled(), PCB_LAYER_SELECTOR::isLayerEnabled(), PCB_LAYER_BOX_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 473 of file board.cpp.

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

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

Referenced by DRAWING_TOOL::DrawVia(), 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

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

Reimplemented in FOOTPRINT, and PAD.

Definition at line 64 of file board_item.cpp.

 {
     if( GetParentGroup() )
         return GetParentGroup()->IsLocked();
 
     return GetState( LOCKED );
 }

References BOARD_ITEM::GetParentGroup(), EDA_ITEM::GetState(), BOARD_ITEM::IsLocked(), and LOCKED.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), PCB_CONTROL::DeleteItemCursor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_IO::format(), PCB_TEXT::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PCB_GROUP::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), ROUTER_TOOL::InlineDrag(), GENERAL_COLLECTOR::Inspect(), PAD::IsLocked(), BOARD_ITEM::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_POINT_EDITOR::OnSelectionChange(), ZONE_SETTINGS::operator<<(), POSITION_RELATIVE_TOOL::PositionRelative(), processTextItem(), 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_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 118 of file eda_item.h.

118 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_MOVING; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsOnCopperLayer()

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

     {
         return IsCopperLayer( GetLayer() );
     }

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

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

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

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

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

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

Definition at line 198 of file board_item.h.

     {
         return m_layer == aLayer;
     }

References BOARD_ITEM::m_layer.

Referenced by BOARD_ADAPTER::createLayers(), existsOnLayer(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), and PNS_KICAD_IFACE::IsItemVisible().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 403 of file eda_item.h.

403 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & SELECTED; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::m_flags, and SELECTED.

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const

inlineinherited

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

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

Definition at line 208 of file board_item.h.

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

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

◆ IsType()

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

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented in PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 183 of file eda_item.h.

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

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & IS_WIRE_IMAGE; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 295 of file eda_item.h.

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

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 314 of file eda_item.h.

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

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

The BOARD is needed because layer names are customizable.

Reimplemented in PCB_VIA.

Definition at line 85 of file board_item.cpp.

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

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

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

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

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

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

◆ Markers() [1/2]

MARKERS& BOARD::Markers ( )

inline

Definition at line 242 of file board.h.

242 { return m_markers; }

BOARD::m_markers

MARKERS m_markers

Definition: board.h:1119

References m_markers.

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), BOARD_DRC_ITEMS_PROVIDER::GetCount(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_PLOT::reInitDialog(), BOARD_EDITOR_CONTROL::RepairBoard(), ResolveDRCExclusions(), DIALOG_FIND::search(), and BOARD_DRC_ITEMS_PROVIDER::SetSeverities().

◆ Markers() [2/2]

const MARKERS& BOARD::Markers ( ) const

inline

Definition at line 243 of file board.h.

243 { return m_markers; }

BOARD::m_markers

MARKERS m_markers

Definition: board.h:1119

References m_markers.

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 365 of file eda_item.h.

     {
         return false;
     }

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 118 of file eda_it

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BOARD() [1/2]

◆ ~BOARD()

◆ BOARD() [2/2]

Member Function Documentation

◆ Add()

◆ AddArea()

◆ AddListener()

◆ AllConnectedItems()

◆ BeginNets()

◆ BuildConnectivity()

◆ BuildListOfNets()

◆ ClassOf()

◆ ClearAllNetCodes()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearProject()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ ComputeBoundingBox()

◆ ConvertBrdLayerToPolygonalContours()

◆ ConvertCrossReferencesToKIIDs()

◆ ConvertKIIDsToCrossReferences()

◆ Delete()

◆ DeleteAllFootprints()

◆ DeleteMARKERs() [1/2]

◆ DeleteMARKERs() [2/2]

◆ DeleteStructure()

◆ Drawings() [1/2]

◆ Drawings() [2/2]

◆ Duplicate()

◆ EndNets()

◆ FillItemMap()

◆ FinalizeBulkAdd()

◆ FinalizeBulkRemove()

◆ FindFootprintByPath()

◆ FindFootprintByReference()

◆ FindNet() [1/2]

◆ FindNet() [2/2]

◆ Flip() [1/2]

◆ Flip() [2/2]

◆ Footprints() [1/2]

◆ Footprints() [2/2]

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetArea()

◆ GetAreaCount()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoardEdgesBoundingBox()

◆ GetBoardPolygonOutlines()

◆ GetBoardUse()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetConnectivity()

◆ GetCopperLayerCount()

◆ GetDesignSettings()

◆ GetEditFlags()

◆ GetEffectiveShape()

◆ GetEnabledLayers()

◆ GetFileFormatVersionAtLoad()

◆ GetFileName()

◆ GetFirstFootprint()

◆ GetFlags()