KiCad PCB EDA Suite
BOARD Class Reference

Class BOARD holds information pertinent to a Pcbnew printed circuit board. More...

#include <class_board.h>

Inheritance diagram for BOARD:
BOARD_ITEM_CONTAINER BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM

Public Member Functions

void SetFileName (const wxString &aFileName)
 
const wxString & GetFileName () const
 
DLIST_ITERATOR_WRAPPER< TRACKTracks ()
 
DLIST_ITERATOR_WRAPPER< MODULEModules ()
 
DLIST_ITERATOR_WRAPPER< BOARD_ITEMDrawings ()
 
ZONE_CONTAINERS & Zones ()
 
const std::vector< BOARD_CONNECTED_ITEM * > AllConnectedItems ()
 
DLIST< BOARD_ITEM > & DrawingsList ()
 
 BOARD ()
 
 ~BOARD ()
 
virtual const wxPoint GetPosition () const override
 
virtual void SetPosition (const wxPoint &aPos) override
 
bool IsEmpty () const
 
void Move (const wxPoint &aMoveVector) override
 Function Move move this object. More...
 
void SetFileFormatVersionAtLoad (int aVersion)
 
int GetFileFormatVersionAtLoad () const
 
void Add (BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
 Adds an item to the container. More...
 
void Remove (BOARD_ITEM *aBoardItem) override
 Removes an item from the container. More...
 
BOARD_ITEMGetItem (void *aWeakReference)
 
BOARD_ITEMDuplicate (const BOARD_ITEM *aItem, bool aAddToBoard=false)
 
std::shared_ptr< CONNECTIVITY_DATAGetConnectivity () const
 Function GetConnectivity() returns list of missing connections between components/tracks. More...
 
void BuildConnectivity ()
 Builds or rebuilds 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 ()
 Function DeleteMARKERs deletes ALL MARKERS from the board. More...
 
void DeleteZONEOutlines ()
 Function DeleteZONEOutlines deletes ALL zone outlines from the board. More...
 
MARKER_PCBGetMARKER (int index) const
 Function GetMARKER returns the MARKER at a given index. More...
 
int GetMARKERCount () const
 Function GetMARKERCount. More...
 
void SetAuxOrigin (const wxPoint &aPoint)
 Function SetAuxOrigin sets the origin point used for plotting. More...
 
const wxPoint & GetAuxOrigin () const
 
void SetGridOrigin (const wxPoint &aPoint)
 Function SetGridOrigin sets the origin point of the grid. More...
 
const wxPoint & GetGridOrigin () const
 
void ResetHighLight ()
 Function ResetHighLight Reset all high light data to the init state. More...
 
int GetHighLightNetCode () const
 Function GetHighLightNetCode. More...
 
void SetHighLightNet (int aNetCode)
 Function SetHighLightNet. More...
 
bool IsHighLightNetON () const
 Function IsHighLightNetON. More...
 
void HighLightOFF ()
 Function HighLightOFF Disable highlight. More...
 
void HighLightON ()
 Function HighLightON Enable highlight. More...
 
void PushHighLight ()
 Function PushHighLight save current high light info for later use. More...
 
void PopHighLight ()
 Function PopHighLight retrieve a previously saved high light info. More...
 
int GetCopperLayerCount () const
 Function GetCopperLayerCount. More...
 
void SetCopperLayerCount (int aCount)
 
LSET GetEnabledLayers () const
 Function GetEnabledLayers is a proxy function that calls the corresponding function in m_BoardSettings Returns a bit-mask of all the layers that are enabled. More...
 
void SetEnabledLayers (LSET aLayerMask)
 Function SetEnabledLayers is a proxy function that calls the correspondent function in m_BoardSettings Changes the bit-mask of enabled layers. More...
 
bool IsLayerEnabled (PCB_LAYER_ID aLayer) const
 Function IsLayerEnabled is 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
 Function IsLayerVisible is a proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer is visible. More...
 
LSET GetVisibleLayers () const
 Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSettings Returns a bit-mask of all the layers that are visible. More...
 
void SetVisibleLayers (LSET aLayerMask)
 Function SetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of visible layers. More...
 
int GetVisibleElements () const
 Function GetVisibleElements is a proxy function that calls the correspondent function in m_BoardSettings returns a bit-mask of all the element categories that are visible. More...
 
void SetVisibleElements (int aMask)
 Function SetVisibleElements is a proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of visible element categories. More...
 
void SetVisibleAlls ()
 Function SetVisibleAlls changes the bit-mask of visible element categories and layers. More...
 
bool IsElementVisible (GAL_LAYER_ID aLayer) const
 Function IsElementVisible tests whether a given element category is visible. More...
 
void SetElementVisibility (GAL_LAYER_ID aLayer, bool aNewState)
 Function SetElementVisibility changes the visibility of an element category. More...
 
bool IsModuleLayerVisible (PCB_LAYER_ID aLayer)
 Function IsModuleLayerVisible expects either of the two layers on which a module can reside, and returns whether that layer is visible. More...
 
BOARD_DESIGN_SETTINGSGetDesignSettings () const
 Function GetDesignSettings. More...
 
void SetDesignSettings (const BOARD_DESIGN_SETTINGS &aDesignSettings)
 Function SetDesignSettings. More...
 
const PAGE_INFOGetPageSettings () const
 
void SetPageSettings (const PAGE_INFO &aPageSettings)
 
const PCB_PLOT_PARAMSGetPlotOptions () const
 
void SetPlotOptions (const PCB_PLOT_PARAMS &aOptions)
 
TITLE_BLOCKGetTitleBlock ()
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock)
 
const ZONE_SETTINGSGetZoneSettings () const
 
void SetZoneSettings (const ZONE_SETTINGS &aSettings)
 
wxString GetSelectMenuText (EDA_UNITS_T aUnits) const override
 Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
const COLORS_DESIGN_SETTINGSColors () const
 Function GetColorSettings. More...
 
void SetColorsSettings (COLORS_DESIGN_SETTINGS *aColorsSettings)
 Function SetColorsSettings. More...
 
bool GetBoardPolygonOutlines (SHAPE_POLY_SET &aOutlines, wxString *aErrorText=nullptr, wxPoint *aErrorLocation=nullptr)
 Function GetBoardPolygonOutlines Extracts 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. More...
 
void ConvertBrdLayerToPolygonalContours (PCB_LAYER_ID aLayer, SHAPE_POLY_SET &aOutlines)
 Function ConvertBrdLayerToPolygonalContours Build a set of polygons which are the outlines of copper items (pads, tracks, vias, texts, zones) Holes in vias or pads are ignored Usefull to export the shape of copper layers to dxf polygons or 3D viewer the polygons are not merged. More...
 
const PCB_LAYER_ID GetLayerID (const wxString &aLayerName) const
 Function GetLayerID returns the ID of a layer given by aLayerName. More...
 
const wxString GetLayerName (PCB_LAYER_ID aLayer) const
 Function GetLayerName returns the name of a layer given by aLayer. More...
 
bool SetLayerName (PCB_LAYER_ID aLayer, const wxString &aLayerName)
 Function SetLayerName changes the name of the layer given by aLayer. More...
 
bool SetLayerDescr (PCB_LAYER_ID aIndex, const LAYER &aLayer)
 Function SetLayerDescr returns the type of the copper layer given by aLayer. More...
 
LAYER_T GetLayerType (PCB_LAYER_ID aLayer) const
 Function GetLayerType returns the type of the copper layer given by aLayer. More...
 
bool SetLayerType (PCB_LAYER_ID aLayer, LAYER_T aLayerType)
 Function SetLayerType changes the type of the layer given by aLayer. More...
 
int GetNumSegmTrack () const
 Functions to get some items count. More...
 
int GetNumSegmZone () const
 Calculate the zone segment count. More...
 
unsigned GetNodesCount (int aNet=-1)
 Function GetNodesCount. More...
 
unsigned GetUnconnectedNetCount () const
 Function GetUnconnectedNetCount. More...
 
unsigned GetPadCount ()
 Function GetPadCount. More...
 
D_PADGetPad (unsigned aIndex) const
 Function GetPad. More...
 
const std::vector< D_PAD * > GetPads ()
 Function GetPads returns a reference to a list of all the pads. More...
 
void BuildListOfNets ()
 
NETINFO_ITEMFindNet (int aNetcode) const
 Function FindNet searches for a net with the given netcode. More...
 
NETINFO_ITEMFindNet (const wxString &aNetname) const
 Function FindNet overloaded searches for a net with the given name. More...
 
NETINFO_LISTGetNetInfo ()
 
NETINFO_LIST::iterator BeginNets () const
 Function BeginNets. More...
 
NETINFO_LIST::iterator EndNets () const
 Function EndNets. More...
 
unsigned GetNetCount () const
 Function GetNetCount. More...
 
EDA_RECT ComputeBoundingBox (bool aBoardEdgesOnly=false) const
 Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge segments). More...
 
const EDA_RECT GetBoundingBox () const override
 Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes. More...
 
const EDA_RECT GetBoardEdgesBoundingBox () const
 Function GetBoardEdgesBoundingBox Returns the board bounding box calculated using exclusively the board edges (graphics on Edge.Cuts layer). More...
 
void GetMsgPanelInfo (EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
 Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes. More...
 
void Draw (EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset=ZeroOffset) override
 Function Draw. More...
 
void DrawHighLight (EDA_DRAW_PANEL *aDrawPanel, wxDC *aDC, int aNetCode)
 Function DrawHighLight redraws the objects in the board that are associated with the given aNetCode and turns on or off the brilliance associated with that net according to the current value of global g_HighLight_Status. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 Function Visit may be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
MODULEFindModuleByReference (const wxString &aReference) const
 Function FindModuleByReference searches for a MODULE within this board with the given reference designator. More...
 
MODULEFindModule (const wxString &aRefOrTimeStamp, bool aSearchByTimeStamp=false) const
 Function FindModule searches for a module matching aRefOrTimeStamp depending on the state of aSearchByTimeStamp. More...
 
void ReplaceNetlist (NETLIST &aNetlist, bool aDeleteSinglePadNets, std::vector< MODULE * > *aNewFootprints, REPORTER &aReporter)
 Function ReplaceNetlist updates the BOARD according to aNetlist. More...
 
void updateComponentPadConnections (NETLIST &aNetlist, MODULE *footprint, COMPONENT *component, REPORTER &aReporter)
 
int SortedNetnamesList (wxArrayString &aNames, bool aSortbyPadsCount)
 Function SortedNetnamesList. More...
 
void SynchronizeNetsAndNetClasses ()
 Function SynchronizeNetsAndNetClasses copies NETCLASS info to each NET, based on NET membership in a NETCLASS. More...
 
wxString GetClass () const override
 Function GetClass returns the class name. More...
 
ZONE_CONTAINERHitTestForAnyFilledArea (const wxPoint &aRefPos, PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer, int aNetCode)
 Function HitTestForAnyFilledArea tests if the given wxPoint is within the bounds of a filled area of this zone. More...
 
void RedrawAreasOutlines (EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, PCB_LAYER_ID aLayer)
 Function RedrawAreasOutlines Redraw all areas outlines on layer aLayer ( redraw all if aLayer < 0 ) More...
 
void RedrawFilledAreas (EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, PCB_LAYER_ID aLayer)
 Function RedrawFilledAreas Redraw all filled areas on layer aLayer ( redraw all if aLayer < 0 ) More...
 
int SetAreasNetCodesFromNetNames (void)
 Function 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_CONTAINERGetArea (int index) const
 Function GetArea returns the Area (Zone Container) at a given index. More...
 
int GetAreaIndex (const ZONE_CONTAINER *aArea) const
 Function GetAreaIndex returns the Area Index for the given Zone Container. More...
 
int GetAreaCount () const
 Function GetAreaCount. More...
 
ZONE_CONTAINERAddArea (PICKED_ITEMS_LIST *aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer, wxPoint aStartPointPosition, int aHatch)
 Function AddArea Add an empty copper area to board areas list. More...
 
ZONE_CONTAINERInsertArea (int aNetcode, int aAreaIdx, PCB_LAYER_ID aLayer, int aCornerX, int aCornerY, int aHatch)
 Add a copper area to net, inserting after m_ZoneDescriptorList[aAreaIdx]. More...
 
bool NormalizeAreaPolygon (PICKED_ITEMS_LIST *aNewZonesList, ZONE_CONTAINER *aCurrArea)
 Function NormalizeAreaPolygon Process an area that has been modified, by normalizing its polygon against itself. More...
 
bool OnAreaPolygonModified (PICKED_ITEMS_LIST *aModifiedZonesList, ZONE_CONTAINER *modified_area)
 Function OnAreaPolygonModified 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 CombineAllAreasInNet (PICKED_ITEMS_LIST *aDeletedList, int aNetCode, bool aUseLocalFlags)
 Function CombineAllAreasInNet Checks all copper areas in net for intersections, combining them if found. More...
 
void RemoveArea (PICKED_ITEMS_LIST *aDeletedList, ZONE_CONTAINER *area_to_remove)
 Function RemoveArea remove copper area from net, and put it in a deleted list (if exists) More...
 
bool TestAreaIntersections (ZONE_CONTAINER *area_to_test)
 Function TestAreaIntersections Check for intersection of a given copper area with other areas in same net. More...
 
bool TestAreaIntersection (ZONE_CONTAINER *area_ref, ZONE_CONTAINER *area_to_test)
 Function TestAreaIntersection Test for intersection of 2 copper areas area_to_test must be after area_ref in m_ZoneDescriptorList. More...
 
bool CombineAreas (PICKED_ITEMS_LIST *aDeletedList, ZONE_CONTAINER *area_ref, ZONE_CONTAINER *area_to_combine)
 Function CombineAreas If possible, combine 2 copper areas. More...
 
VIAGetViaByPosition (const wxPoint &aPosition, PCB_LAYER_ID aLayer=PCB_LAYER_ID(-1)) const
 Function GetViaByPosition finds the first via at aPosition on aLayer. More...
 
std::list< TRACK * > GetTracksByPosition (const wxPoint &aPosition, PCB_LAYER_ID aLayer=PCB_LAYER_ID(-1)) const
 Function GetTracksByPosition finds the list of tracks that starts or ends at aPosition on aLayer. More...
 
D_PADGetPad (const wxPoint &aPosition, LSET aLayerMask)
 Function GetPad finds a pad aPosition on aLayer. More...
 
D_PADGetPad (const wxPoint &aPosition)
 
D_PADGetPad (TRACK *aTrace, ENDPOINT_T aEndPoint)
 Function GetPad finds a pad connected to aEndPoint of aTrace. More...
 
D_PADGetPadFast (const wxPoint &aPosition, LSET aLayerMask)
 Function GetPadFast return pad found at aPosition on aLayerMask using the fast search method. More...
 
D_PADGetPad (std::vector< D_PAD * > &aPadList, const wxPoint &aPosition, LSET aLayerMask)
 Function GetPad locates the pad connected at aPosition on aLayer starting at list position aPad. More...
 
void PadDelete (D_PAD *aPad)
 Function PadDelete deletes a given bad from the BOARD by removing it from its module and from the m_NetInfo. More...
 
void GetSortedPadListByXthenYCoord (std::vector< D_PAD * > &aVector, int aNetCode=-1)
 Function GetSortedPadListByXthenYCoord 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...
 
TRACKGetVisibleTrack (TRACK *aStartingTrace, const wxPoint &aPosition, LSET aLayerSet) const
 Function GetVisibleTrack finds the neighboring visible segment of aTrace at aPosition that is on a layer in aLayerSet. More...
 
TRACKMarkTrace (TRACK *aTrackList, TRACK *aTrace, int *aCount, double *aTraceLength, double *aInPackageLength, bool aReorder)
 Function MarkTrace marks a chain of trace segments, connected to aTrace. More...
 
TRACKS TracksInNet (int aNetCode)
 Function TrackInNet collects all the TRACKs and VIAs that are members of a net given by aNetCode. More...
 
TRACKS TracksInNetBetweenPoints (const wxPoint &aStartPos, const wxPoint &aGoalPos, int aNetCode)
 Function TrackInNetBetweenPoints collects all the TRACKs and VIAs that are members of a net given by aNetCode and that make up a path between two end points. More...
 
MODULEGetFootprint (const wxPoint &aPosition, PCB_LAYER_ID aActiveLayer, bool aVisibleOnly, bool aIgnoreLocked=false)
 Function GetFootprint get a footprint by its bounding rectangle at aPosition on aLayer. More...
 
BOARD_CONNECTED_ITEMGetLockPoint (const wxPoint &aPosition, LSET aLayerMask)
 Function GetLockPoint returns the item at the "attachment" point at the end of a trace at aPosition on aLayerMask. More...
 
TRACKCreateLockPoint (wxPoint &aPosition, TRACK *aSegment, PICKED_ITEMS_LIST *aList)
 Function CreateLockPoint creates an intermediate point on aSegment and break it into two segments at aPosition. More...
 
void ClearAllNetCodes ()
 Function ClearAllNetCodes() Resets all items' netcodes to 0 (no net). More...
 
void SanitizeNetcodes ()
 
virtual void Delete (BOARD_ITEM *aItem)
 Removes an item from the containter and deletes it. More...
 
virtual const wxPoint GetCenter () const
 Function GetCenter() More...
 
virtual bool IsConnected () const
 Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...
 
BOARD_ITEMNext () const
 
BOARD_ITEMBack () const
 
BOARD_ITEM_CONTAINERGetParent () const
 
virtual PCB_LAYER_ID GetLayer () const
 Function GetLayer returns the primary layer this item is on. More...
 
virtual LSET GetLayerSet () const
 Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides. More...
 
virtual void SetLayer (PCB_LAYER_ID aLayer)
 Function SetLayer sets the layer this item is on. More...
 
virtual void SwapData (BOARD_ITEM *aImage)
 Swap data between aItem and aImage. More...
 
virtual bool IsOnLayer (PCB_LAYER_ID aLayer) const
 Function IsOnLayer tests to see if this object is on the given layer. More...
 
bool IsTrack () const
 Function IsTrack tests to see if this object is a track or via (or microvia). More...
 
virtual bool IsLocked () const
 Function IsLocked. More...
 
virtual void SetLocked (bool aLocked)
 Function SetLocked modifies 'lock' status for of the item. More...
 
virtual void UnLink ()
 Function UnLink detaches this object from its owner. More...
 
void DeleteStructure ()
 Function DeleteStructure deletes this object after UnLink()ing it from its owner if it has one. More...
 
void Move (const VECTOR2I &aMoveVector)
 
virtual void Rotate (const wxPoint &aRotCentre, double aAngle)
 Function Rotate Rotate this object. More...
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
virtual void Flip (const wxPoint &aCentre)
 Function Flip Flip this object, i.e. More...
 
void Flip (const VECTOR2I &aCentre)
 
virtual BOARDGetBoard () const
 Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
 
wxString GetLayerName () const
 Function GetLayerName returns the name of the PCB layer on which the item resides. More...
 
virtual bool HitTest (const wxPoint &aPosition) const override
 Function HitTest tests if aPosition is contained within or on the bounding area of an item. More...
 
virtual bool HitTest (const EDA_RECT &aRect, bool aContained=true, int aAccuracy=0) const
 Function HitTest tests if the aRect intersects or contains this object (depending on aContained). More...
 
virtual void ViewGetLayers (int aLayers[], int &aCount) const override
 Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on. More...
 
virtual void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool ignoreLineWidth=false) const
 Function TransformShapeWithClearanceToPolygon Convert the item shape to a closed polygon Used in filling zones calculations Circles and arcs are approximated by segments. More...
 
KICAD_T Type () const
 Function Type() More...
 
void SetTimeStamp (timestamp_t aNewTimeStamp)
 
timestamp_t GetTimeStamp () const
 
DHEADGetList () const
 
void SetNext (EDA_ITEM *aNext)
 
void SetBack (EDA_ITEM *aBack)
 
void SetParent (EDA_ITEM *aParent)
 
void SetList (DHEAD *aList)
 
bool IsNew () const
 
bool IsModified () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsResized () const
 
bool IsHighlighted () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetHighlighted ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearHighlighted ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, int state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool IsType (const KICAD_T aScanTypes[])
 Function IsType Checks whether the item is one of the listed types. More...
 
void SetForceVisible (bool aEnable)
 Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
virtual EDA_ITEMClone () const
 Function Clone creates a duplicate of this item with linked list members set to NULL. More...
 
virtual BITMAP_DEF GetMenuImage () const
 Function GetMenuImage returns a pointer to an image to be used in menus. More...
 
virtual bool Matches (wxFindReplaceData &aSearchData, void *aAuxData, wxPoint *aFindLocation)
 Function Matches compares the item against the search criteria in aSearchData. More...
 
bool Replace (wxFindReplaceData &aSearchData, wxString &aText)
 Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool Replace (wxFindReplaceData &aSearchData, void *aAuxData=NULL)
 Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Function IsReplaceable. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual const BOX2I ViewBBox () const override
 Function ViewBBox() returns the bounding box of the item covering all its layers. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Function ViewDraw() Draws the parts of the object belonging to layer aLayer. More...
 
virtual unsigned int ViewGetLOD (int aLayer, VIEW *aView) const
 Function ViewGetLOD() Returns the level of detail (LOD) of the item. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
static wxString GetStandardLayerName (PCB_LAYER_ID aLayerId)
 Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumber. More...
 
static wxString ShowShape (STROKE_T aShape)
 Function ShowShape converts the enum STROKE_T integer value to a wxString. More...
 
static SEARCH_RESULT IterateForward (EDA_ITEM *listStart, INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
 Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes. More...
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Function Sort is a helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers. More...
 

Public Attributes

int m_Status_Pcb
 Flags used in ratsnest calculation and update. More...
 
DLIST< MODULEm_Modules
 
DLIST< TRACKm_Track
 
DLIST< SEGZONEm_SegZoneDeprecated
 
ZONE_CONTAINERm_CurrentZoneContour
 zone contour currently in progress More...
 

Static Public Attributes

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

Protected Member Functions

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

Static Protected Member Functions

static int getTrailingInt (const wxString &aStr)
 
static int getNextNumberInSequence (const std::set< int > &aSeq, bool aFillSequenceGaps)
 

Protected Attributes

EDA_ITEMPnext
 next in linked list More...
 
EDA_ITEMPback
 previous in linked list More...
 
DHEADm_List
 which DLIST I am on. More...
 
EDA_ITEMm_Parent
 Linked list: Link (parent struct) More...
 
timestamp_t m_TimeStamp
 Time stamp used for logical links. More...
 
bool m_forceVisible
 Set to true to override the visibility setting of the item. More...
 
STATUS_FLAGS m_Flags
 Flag bits for editing and other uses. More...
 

Private Member Functions

void chainMarkedSegments (TRACK *aTrackList, wxPoint aPosition, const LSET &aLayerSet, TRACKS *aList)
 Function chainMarkedSegments is used by MarkTrace() to set the BUSY flag of connected segments of the trace segment located at aPosition on aLayerMask. More...
 
 BOARD (const BOARD &aOther)
 
BOARDoperator= (const BOARD &aOther)
 

Private Attributes

wxString m_fileName
 the board filename More...
 
MARKERS m_markers
 MARKER_PCBs for clearance problems, owned by pointer. More...
 
ZONE_CONTAINERS m_ZoneDescriptorList
 edge zone descriptors, owned by pointer. More...
 
LAYER m_Layer [PCB_LAYER_ID_COUNT]
 
HIGH_LIGHT_INFO m_highLight
 
HIGH_LIGHT_INFO m_highLightPrevious
 
int m_fileFormatVersionAtLoad
 the version loaded from the file More...
 
std::shared_ptr< CONNECTIVITY_DATAm_connectivity
 
BOARD_DESIGN_SETTINGS m_designSettings
 
ZONE_SETTINGS m_zoneSettings
 
COLORS_DESIGN_SETTINGSm_colorsSettings
 
PAGE_INFO m_paper
 
TITLE_BLOCK m_titles
 text in lower right of screen and plots More...
 
PCB_PLOT_PARAMS m_plotOptions
 
NETINFO_LIST m_NetInfo
 net info list (name, design constraints .. More...
 
DLIST< BOARD_ITEMm_Drawings
 

Friends

class PCB_EDIT_FRAME
 

Detailed Description

Class BOARD holds information pertinent to a Pcbnew printed circuit board.

Definition at line 171 of file class_board.h.

Constructor & Destructor Documentation

BOARD::BOARD ( const BOARD aOther)
inlineprivate

Definition at line 218 of file class_board.h.

218  :
219  BOARD_ITEM_CONTAINER( aOther ), m_NetInfo( this )
220  {
221  assert( false );
222  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
BOARD_ITEM_CONTAINER(BOARD_ITEM *aParent, KICAD_T aType)
BOARD::BOARD ( )

Definition at line 110 of file class_board.cpp.

References BuildListOfNets(), dummyColorsSettings, BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), BOARD_DESIGN_SETTINGS::GetCurrentViaDrill(), BOARD_DESIGN_SETTINGS::GetCurrentViaSize(), BOARD_DESIGN_SETTINGS::GetDefault(), GetStandardLayerName(), IsCopperLayer(), LT_SIGNAL, LT_UNDEFINED, m_colorsSettings, m_connectivity, m_CurrentZoneContour, m_designSettings, m_fileFormatVersionAtLoad, m_Layer, LAYER::m_name, m_Status_Pcb, LAYER::m_type, PCB_LAYER_ID_COUNT, BOARD_DESIGN_SETTINGS::SetCurrentNetClass(), BOARD_DESIGN_SETTINGS::SetCustomTrackWidth(), BOARD_DESIGN_SETTINGS::SetCustomViaDrill(), BOARD_DESIGN_SETTINGS::SetCustomViaSize(), ToLAYER_ID(), and BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize().

110  :
112  m_paper( PAGE_INFO::A4 ), m_NetInfo( this )
113 {
114  // we have not loaded a board yet, assume latest until then.
115  m_fileFormatVersionAtLoad = LEGACY_BOARD_FILE_VERSION;
116 
118  m_Status_Pcb = 0; // Status word: bit 1 = calculate.
119  m_CurrentZoneContour = NULL; // This ZONE_CONTAINER handle the
120  // zone contour currently in progress
121 
122  BuildListOfNets(); // prepare pad and netlist containers.
123 
124  for( LAYER_NUM layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
125  {
126  m_Layer[layer].m_name = GetStandardLayerName( ToLAYER_ID( layer ) );
127 
128  if( IsCopperLayer( layer ) )
129  m_Layer[layer].m_type = LT_SIGNAL;
130  else
131  m_Layer[layer].m_type = LT_UNDEFINED;
132  }
133 
134  // Initialize default netclass.
135  NETCLASSPTR defaultClass = m_designSettings.GetDefault();
136  defaultClass->SetDescription( _( "This is the default net class." ) );
137  m_designSettings.SetCurrentNetClass( defaultClass->GetName() );
138 
139  // Set sensible initial values for custom track width & via size
144 
145  // Initialize ratsnest
146  m_connectivity.reset( new CONNECTIVITY_DATA() );
147 }
void BuildListOfNets()
Definition: class_board.h:735
int GetCurrentViaDrill() const
Function GetCurrentViaDrill.
Definition: typeinfo.h:85
NETCLASSPTR GetDefault() const
Function GetDefault.
wxString m_name
The name of the layer, there should be no spaces in this name.
Definition: class_board.h:113
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
PAGE_INFO m_paper
Definition: class_board.h:198
void SetCustomViaDrill(int aDrill)
Function SetCustomViaDrill Sets custom size for via drill (i.e.
LAYER_T m_type
The type of the layer.
Definition: class_board.h:115
COLORS_DESIGN_SETTINGS * m_colorsSettings
Definition: class_board.h:197
ZONE_CONTAINER * m_CurrentZoneContour
zone contour currently in progress
Definition: class_board.h:264
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
int GetCurrentViaSize() const
Function GetCurrentViaSize.
static COLORS_DESIGN_SETTINGS dummyColorsSettings(FRAME_PCB)
void SetCustomViaSize(int aSize)
Function SetCustomViaSize Sets custom size for via diameter (i.e.
static const wxChar A4[]
Definition: page_info.h:64
void SetCustomTrackWidth(int aWidth)
Function SetCustomTrackWidth Sets custom width for track (i.e.
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
bool SetCurrentNetClass(const wxString &aNetClassName)
Function SetCurrentNetClass Must be called after a netclass selection (or after a netclass parameter ...
int m_fileFormatVersionAtLoad
the version loaded from the file
Definition: class_board.h:191
LAYER m_Layer[PCB_LAYER_ID_COUNT]
Definition: class_board.h:185
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:193
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
int GetCurrentTrackWidth() const
Function GetCurrentTrackWidth.
BOARD_ITEM_CONTAINER(BOARD_ITEM *aParent, KICAD_T aType)
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:813
void UseCustomTrackViaSize(bool aEnabled)
Function UseCustomTrackViaSize Enables/disables custom track/via size settings.
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:659
int m_Status_Pcb
Flags used in ratsnest calculation and update.
Definition: class_board.h:241
BOARD::~BOARD ( )

Definition at line 150 of file class_board.cpp.

References BOARD_ITEM_CONTAINER::Delete(), DeleteMARKERs(), DeleteZONEOutlines(), m_CurrentZoneContour, and m_ZoneDescriptorList.

151 {
152  while( m_ZoneDescriptorList.size() )
153  {
154  ZONE_CONTAINER* area_to_remove = m_ZoneDescriptorList[0];
155  Delete( area_to_remove );
156  }
157 
158  DeleteMARKERs();
160 
161  delete m_CurrentZoneContour;
162  m_CurrentZoneContour = NULL;
163 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
void DeleteZONEOutlines()
Function DeleteZONEOutlines deletes ALL zone outlines from the board.
ZONE_CONTAINER * m_CurrentZoneContour
zone contour currently in progress
Definition: class_board.h:264
void DeleteMARKERs()
Function DeleteMARKERs deletes ALL MARKERS from the board.
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
virtual void Delete(BOARD_ITEM *aItem)
Removes an item from the containter and deletes it.

Member Function Documentation

void BOARD::Add ( BOARD_ITEM aItem,
ADD_MODE  aMode = ADD_INSERT 
)
overridevirtual

Adds an item to the container.

Parameters
aItemis an item to be added.
aModedecides whether the item is added in the beginning or at the end of the list.

Implements BOARD_ITEM_CONTAINER.

Definition at line 867 of file class_board.cpp.

References ADD_APPEND, NETINFO_LIST::AppendNet(), TRACK::GetBestInsertPoint(), DLIST< T >::Insert(), m_connectivity, m_Drawings, m_markers, m_Modules, m_NetInfo, m_SegZoneDeprecated, m_Status_Pcb, m_Track, m_ZoneDescriptorList, PCB_DIMENSION_T, PCB_LINE_T, PCB_MARKER_T, PCB_MODULE_T, PCB_NETINFO_T, PCB_SEGZONE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, DLIST< T >::PushBack(), DLIST< T >::PushFront(), EDA_ITEM::SetParent(), and EDA_ITEM::Type().

Referenced by PCB_BASE_FRAME::AddModuleToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB::AddToBoard(), PCAD2KICAD::PCB_MODULE::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToModule(), PCB_EDIT_FRAME::Begin_DrawSegment(), PCB_EDIT_FRAME::Block_Duplicate(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), PCB_EDIT_FRAME::CreateTarget(), PCB_EDIT_FRAME::CreateTextePcb(), Duplicate(), PCB_EDIT_FRAME::duplicateZone(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), PCB_EDIT_FRAME::End_Zone(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), DSN::SPECCTRA_DB::FromSESSION(), InvokeDialogImportGfxBoard(), LEGACY_PLUGIN::loadAllSections(), LEGACY_PLUGIN::loadDIMENSION(), EAGLE_PLUGIN::loadElements(), LEGACY_PLUGIN::loadNETINFO_ITEM(), LEGACY_PLUGIN::loadPCB_LINE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), LEGACY_PLUGIN::loadZONE_CONTAINER(), PANEL_PREV_3D::PANEL_PREV_3D(), BOARD_COMMIT::Push(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), ReplaceNetlist(), BOARD_COMMIT::Revert(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), and updateComponentPadConnections().

868 {
869  if( aBoardItem == NULL )
870  {
871  wxFAIL_MSG( wxT( "BOARD::Add() param error: aBoardItem NULL" ) );
872  return;
873  }
874 
875  switch( aBoardItem->Type() )
876  {
877  case PCB_NETINFO_T:
878  m_NetInfo.AppendNet( (NETINFO_ITEM*) aBoardItem );
879  break;
880 
881  // this one uses a vector
882  case PCB_MARKER_T:
883  m_markers.push_back( (MARKER_PCB*) aBoardItem );
884  break;
885 
886  // this one uses a vector
887  case PCB_ZONE_AREA_T:
888  m_ZoneDescriptorList.push_back( (ZONE_CONTAINER*) aBoardItem );
889  break;
890 
891  case PCB_TRACE_T:
892  case PCB_VIA_T:
893  if( aMode == ADD_APPEND )
894  {
895  m_Track.PushBack( (TRACK*) aBoardItem );
896  }
897  else
898  {
899  TRACK* insertAid;
900  insertAid = ( (TRACK*) aBoardItem )->GetBestInsertPoint( this );
901  m_Track.Insert( (TRACK*) aBoardItem, insertAid );
902  }
903 
904  break;
905 
906  case PCB_SEGZONE_T:
907  if( aMode == ADD_APPEND )
908  m_SegZoneDeprecated.PushBack( (SEGZONE*) aBoardItem );
909  else
910  m_SegZoneDeprecated.PushFront( (SEGZONE*) aBoardItem );
911 
912  break;
913 
914  case PCB_MODULE_T:
915  if( aMode == ADD_APPEND )
916  m_Modules.PushBack( (MODULE*) aBoardItem );
917  else
918  m_Modules.PushFront( (MODULE*) aBoardItem );
919 
920  // Because the list of pads has changed, reset the status
921  // This indicate the list of pad and nets must be recalculated before use
922  m_Status_Pcb = 0;
923  break;
924 
925  case PCB_DIMENSION_T:
926  case PCB_LINE_T:
927  case PCB_TEXT_T:
928  case PCB_TARGET_T:
929  if( aMode == ADD_APPEND )
930  m_Drawings.PushBack( aBoardItem );
931  else
932  m_Drawings.PushFront( aBoardItem );
933 
934  break;
935 
936  // other types may use linked list
937  default:
938  {
939  wxString msg;
940  msg.Printf( wxT( "BOARD::Add() needs work: BOARD_ITEM type (%d) not handled" ),
941  aBoardItem->Type() );
942  wxFAIL_MSG( msg );
943  return;
944  }
945  break;
946  }
947 
948  aBoardItem->SetParent( this );
949  m_connectivity->Add( aBoardItem );
950 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
void PushFront(T *aNewElement)
Function PushFront puts aNewElement at front of list sequence.
Definition: dlist.h:240
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
void PushBack(T *aNewElement)
Function PushBack puts aNewElement at the end of the list sequence.
Definition: dlist.h:250
void AppendNet(NETINFO_ITEM *aNewElement)
Function AppendNet adds aNewElement to the end of the net list.
class MODULE, a footprint
Definition: typeinfo.h:89
DLIST< SEGZONE > m_SegZoneDeprecated
Definition: class_board.h:251
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:245
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:180
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:101
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:69
TRACK * GetBestInsertPoint(BOARD *aPcb)
Function GetBestInsertPoint searches the "best" insertion point within the track linked list...
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:99
DLIST< MODULE > m_Modules
Definition: class_board.h:249
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:104
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:193
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
DLIST< TRACK > m_Track
Definition: class_board.h:250
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
class SEGZONE, a segment used to fill a zone area (segment on a
Definition: typeinfo.h:97
void Insert(T *aNewElement, T *aElementAfterMe)
Function Insert puts aNewElement just in front of aElementAfterMe in the list sequence.
Definition: dlist.h:200
int m_Status_Pcb
Flags used in ratsnest calculation and update.
Definition: class_board.h:241
ZONE_CONTAINER * BOARD::AddArea ( PICKED_ITEMS_LIST aNewZonesList,
int  aNetcode,
PCB_LAYER_ID  aLayer,
wxPoint  aStartPointPosition,
int  aHatch 
)

Function AddArea Add an empty copper area to board areas list.

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

Definition at line 2358 of file class_board.cpp.

References InsertArea(), m_ZoneDescriptorList, PICKED_ITEMS_LIST::PushItem(), and UR_NEW.

Referenced by NormalizeAreaPolygon().

2360 {
2361  ZONE_CONTAINER* new_area = InsertArea( aNetcode,
2362  m_ZoneDescriptorList.size( ) - 1,
2363  aLayer, aStartPointPosition.x,
2364  aStartPointPosition.y, aHatch );
2365 
2366  if( aNewZonesList )
2367  {
2368  ITEM_PICKER picker( new_area, UR_NEW );
2369  aNewZonesList->PushItem( picker );
2370  }
2371 
2372  return new_area;
2373 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
ZONE_CONTAINER * InsertArea(int aNetcode, int aAreaIdx, PCB_LAYER_ID aLayer, int aCornerX, int aCornerY, int aHatch)
Add a copper area to net, inserting after m_ZoneDescriptorList[aAreaIdx].
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
const std::vector< BOARD_CONNECTED_ITEM * > BOARD::AllConnectedItems ( )

Definition at line 3032 of file class_board.cpp.

References GetArea(), GetAreaCount(), i, mod, Modules(), and Tracks().

Referenced by SanitizeNetcodes().

3033 {
3034  std::vector<BOARD_CONNECTED_ITEM*> items;
3035 
3036  for( auto track : Tracks() )
3037  {
3038  items.push_back( track );
3039  }
3040 
3041  for( auto mod : Modules() )
3042  {
3043  for( auto pad : mod->Pads() )
3044  {
3045  items.push_back( pad );
3046  }
3047  }
3048 
3049  for( int i = 0; i<GetAreaCount(); i++ )
3050  {
3051  auto zone = GetArea( i );
3052  items.push_back( zone );
3053  }
3054 
3055  return items;
3056 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:255
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1026
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:997
size_t i
Definition: json11.cpp:597
DLIST_ITERATOR_WRAPPER< TRACK > Tracks()
Definition: class_board.h:254
#define mod(a, n)
Definition: greymap.cpp:24
BOARD_ITEM* BOARD_ITEM::Back ( ) const
inlineinherited

Definition at line 117 of file class_board_item.h.

References EDA_ITEM::Pback.

Referenced by SwapItemData().

117 { return static_cast<BOARD_ITEM*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:168
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
NETINFO_LIST::iterator BOARD::BeginNets ( ) const
inline

Function BeginNets.

Returns
iterator to the first element of the NETINFO_ITEMs list

Definition at line 766 of file class_board.h.

References NETINFO_LIST::begin().

767  {
768  return m_NetInfo.begin();
769  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
iterator begin() const
Definition: netinfo.h:532
void BOARD::BuildConnectivity ( )

Builds or rebuilds 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 166 of file class_board.cpp.

References GetConnectivity().

Referenced by PCBNEW_CONTROL::AppendBoard(), LoadBoard(), PCB_EDIT_FRAME::OpenProjectFiles(), Refresh(), SaveBoard(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), and PCB_EDIT_FRAME::UpdateUserInterface().

167 {
168  GetConnectivity()->Build( this );
169 }
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:297
void BOARD::BuildListOfNets ( )
inline

Definition at line 735 of file class_board.h.

References NETINFO_LIST::buildListOfNets().

Referenced by Abort_MoveOrCopyModule(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), BOARD(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), FOOTPRINT_EDIT_FRAME::Import_Module(), LoadBoard(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), ReplaceNetlist(), and PANEL_SETUP_NETCLASSES::TransferDataToWindow().

736  {
738  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
void buildListOfNets()
Function buildListOfNets builds or rebuilds the list of NETINFO_ITEMs The list is sorted by names...
void BOARD::chainMarkedSegments ( TRACK aTrackList,
wxPoint  aPosition,
const LSET aLayerSet,
TRACKS *  aList 
)
private

Function chainMarkedSegments is used by MarkTrace() to set the BUSY flag of connected segments of the trace segment located at aPosition on aLayerMask.

Vias are put in list but their flags BUSY is not set

Parameters
aTrackListis the beginning of the track list (usually the board track list).
aPositionA wxPoint object containing the position of the starting search.
aLayerSetThe allowed layers for segments to search.
aListThe track list to fill with points of flagged segments.

Definition at line 423 of file class_board.cpp.

References BUSY, BOARD_ITEM::GetCenter(), TRACK::GetEnd(), BOARD_ITEM::GetLayerSet(), GetLineLength(), GetPad(), TRACK::GetStart(), EDA_ITEM::GetState(), GetTrack(), TRACK::GetVia(), max, TRACK::Next(), and EDA_ITEM::SetState().

Referenced by MarkTrace().

425 {
426  LSET layer_set = aLayerSet;
427 
428  if( !aTrackList ) // no tracks at all in board
429  return;
430 
431  D_PAD* pad = NULL;
432  double distanceToPadCenter = std::numeric_limits<double>::max();
433 
434  /* Set the BUSY flag of all connected segments, first search starting at
435  * aPosition. The search ends when a pad is found (end of a track), a
436  * segment end has more than one other segment end connected, or when no
437  * connected item found.
438  *
439  * Vias are a special case because they can connect segments
440  * on other layers and they change the layer mask. They can be a track
441  * end or not. They will be analyzed later, and vias on terminal points
442  * of the track will be considered as part of this track if they do not
443  * connect segments on a other track together and will be considered as
444  * part of a other track when removing the via, the segments of that other
445  * track are disconnected.
446  */
447  for( ; ; )
448  {
449  if( !pad )
450  pad = GetPad( aPosition, layer_set );
451 
452  if( pad )
453  distanceToPadCenter = GetLineLength( aPosition, pad->GetCenter() );
454 
455  /* Test for a via: a via changes the layer mask and can connect a lot
456  * of segments at location aPosition. When found, the via is just
457  * pushed in list. Vias will be examined later, when all connected
458  * segment are found and push in list. This is because when a via
459  * is found we do not know at this time the number of connected items
460  * and we do not know if this via is on the track or finish the track
461  */
462  TRACK* via = aTrackList->GetVia( NULL, aPosition, layer_set );
463 
464  if( via )
465  {
466  layer_set = via->GetLayerSet();
467  aList->push_back( via );
468  }
469 
470  int seg_count = 0;
471  TRACK* candidate = NULL;
472 
473  /* Search all segments connected to point aPosition.
474  * if only 1 segment at aPosition: then this segment is "candidate"
475  * if > 1 segment:
476  * then end of "track" (because more than 2 segments are connected at aPosition)
477  */
478  TRACK* segment = aTrackList;
479 
480  while( ( segment = ::GetTrack( segment, NULL, aPosition, layer_set ) ) != NULL )
481  {
482  if( segment->GetState( BUSY ) ) // already found and selected: skip it
483  {
484  segment = segment->Next();
485  continue;
486  }
487 
488  if( segment == via ) // just previously found: skip it
489  {
490  segment = segment->Next();
491  continue;
492  }
493 
494  if( ++seg_count == 1 ) // if first connected item: then segment is candidate
495  {
496  candidate = segment;
497  segment = segment->Next();
498  }
499  else // More than 1 segment connected -> location is end of track
500  {
501  return;
502  }
503  }
504 
505  if( candidate ) // A candidate is found: flag it and push it in list
506  {
507  /* Initialize parameters to search items connected to this
508  * candidate:
509  * we must analyze connections to its other end
510  */
511  if( aPosition == candidate->GetStart() )
512  {
513  aPosition = candidate->GetEnd();
514  }
515  else
516  {
517  aPosition = candidate->GetStart();
518  }
519 
520  /* If we are in a pad, only candidates approaching the pad center
521  * are accepted.
522  */
523  if( pad )
524  {
525  if( GetPad( aPosition, layer_set ) != pad )
526  return;
527 
528  if( GetLineLength( aPosition, pad->GetCenter() ) > distanceToPadCenter )
529  return;
530  }
531 
532  layer_set = candidate->GetLayerSet();
533 
534  // flag this item and push it in list of selected items
535  aList->push_back( candidate );
536  candidate->SetState( BUSY, true );
537  }
538  else
539  {
540  return;
541  }
542  }
543 }
TRACK * GetTrack(TRACK *aStartTrace, const TRACK *aEndTrace, const wxPoint &aPosition, LSET aLayerMask)
Function GetTrack is a helper function to locate a trace segment having an end point at aPosition on ...
Definition: class_track.cpp:68
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Function GetLineLength returns the length of a line segment defined by aPointA and aPointB...
Definition: trigo.h:191
D_PAD * GetPad(unsigned aIndex) const
Function GetPad.
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:135
int GetState(int type) const
Definition: base_struct.h:240
const wxPoint & GetEnd() const
Definition: class_track.h:123
virtual const wxPoint GetCenter() const
Function GetCenter()
VIA * GetVia(const wxPoint &aPosition, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
Function GetVia finds the first VIA object at aPosition on aLayer starting at the trace...
Class LSET is a set of PCB_LAYER_IDs.
const wxPoint & GetStart() const
Definition: class_track.h:126
virtual LSET GetLayerSet() const
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
TRACK * Next() const
Definition: class_track.h:103
void SetState(int type, int state)
Definition: base_struct.h:245
#define max(a, b)
Definition: auxiliary.h:86
static bool BOARD::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 231 of file class_board.h.

References PCB_T, and EDA_ITEM::Type().

232  {
233  return aItem && PCB_T == aItem->Type();
234  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
Definition: typeinfo.h:85
void BOARD::ClearAllNetCodes ( )

Function ClearAllNetCodes() Resets all items' netcodes to 0 (no net).

Definition at line 3020 of file class_board.cpp.

References GetPads(), Tracks(), and Zones().

3021 {
3022  for( auto zone : Zones() )
3023  zone->SetNetCode( 0 );
3024 
3025  for( auto pad : GetPads() )
3026  pad->SetNetCode( 0 );
3027 
3028  for( auto track : Tracks() )
3029  track->SetNetCode( 0 );
3030 }
const std::vector< D_PAD * > GetPads()
Function GetPads returns a reference to a list of all the pads.
ZONE_CONTAINERS & Zones()
Definition: class_board.h:257
DLIST_ITERATOR_WRAPPER< TRACK > Tracks()
Definition: class_board.h:254
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 236 of file base_struct.h.

References BRIGHTENED, EDA_ITEM::ClearFlags(), and EDA_ITEM::SetModified().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), and SELECTION_TOOL::unhighlight().

236 { ClearFlags( BRIGHTENED ); }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
void EDA_ITEM::ClearFlags ( STATUS_FLAGS  aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 257 of file base_struct.h.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_Move_Pad(), Abort_MoveOrCopyModule(), Abort_MoveTrack(), Abort_Zone_Create_Outline(), Abort_Zone_Move_Corner_Or_Outlines(), AbortMoveAndEditTarget(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToScreen(), PNS_KICAD_IFACE::AddItem(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), PCB_EDIT_FRAME::Begin_Zone(), SCH_EDIT_FRAME::BeginSegment(), PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), LIB_EDIT_FRAME::BlockCopySelectedItems(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_COMPONENT::ClearAllHighlightFlags(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), DRAG_LIST::ClearList(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), MWAVE::CreateMicrowaveInductor(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_EDIT_FRAME::Delete_LastCreatedCorner(), PCB_EDIT_FRAME::Delete_Segment_Edge(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_EDIT_FRAME::EditDimension(), PCB_EDIT_FRAME::End_Edge(), FOOTPRINT_EDIT_FRAME::End_Edge_Module(), PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::End_Zone(), EraseDragList(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), KIGFX::SCH_VIEW::HighlightItem(), PCB_BASE_FRAME::Import_Pad_Settings(), SCH_JUNCTION::IsSelectStateChanged(), SCH_NO_CONNECT::IsSelectStateChanged(), SCH_MARKER::IsSelectStateChanged(), SCH_BUS_ENTRY_BASE::IsSelectStateChanged(), SCH_BITMAP::IsSelectStateChanged(), SCH_LINE::IsSelectStateChanged(), SCH_TEXT::IsSelectStateChanged(), SCH_SHEET::IsSelectStateChanged(), SCH_COMPONENT::IsSelectStateChanged(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), MarkItemsInBloc(), MirrorX(), MirrorY(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnOrient(), LIB_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_FIELD::Place(), PCB_EDIT_FRAME::Place_DrawItem(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_EDIT_FRAME::PlaceDimensionText(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), PCB_BASE_FRAME::PlaceModule(), PCB_BASE_FRAME::PlacePad(), PCB_EDIT_FRAME::PlaceTarget(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::PlaceTexteModule(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), LIB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::RepeatDrawItem(), LIB_EDIT_FRAME::RepeatPinItem(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), RotateListOfItems(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

257 { m_Flags &= ~aMask; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
void EDA_ITEM::ClearHighlighted ( )
inlineinherited

Definition at line 235 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

235 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
void EDA_ITEM::ClearSelected ( )
inlineinherited

Definition at line 234 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), GAL_ARRAY_CREATOR::prePushAction(), SELECTION_TOOL::unhighlight(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

234 { ClearFlags( SELECTED ); }
#define SELECTED
Definition: base_struct.h:121
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:257
EDA_ITEM * EDA_ITEM::Clone ( ) const
virtualinherited

Function Clone creates 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 D_PAD, SCH_COMPONENT, ZONE_CONTAINER, MODULE, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, SCH_LABEL, DIMENSION, LIB_FIELD, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, SCH_LINE, SCH_BUS_BUS_ENTRY, SCH_BITMAP, LIB_ARC, SCH_BUS_WIRE_ENTRY, LIB_TEXT, EDGE_MODULE, TEXTE_PCB, LIB_POLYLINE, SCH_NO_CONNECT, LIB_RECTANGLE, SCH_JUNCTION, LIB_BEZIER, PCB_TARGET, LIB_CIRCLE, SCH_MARKER, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 123 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), LIB_EDIT_FRAME::BlockCopySelectedItems(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), CopyMarkedItems(), LIB_EDIT_FRAME::copySelectedItems(), DrawMovingBlockOutlines(), Duplicate(), DuplicateStruct(), EDA_ITEM::HitTest(), LIB_PART::LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), moveItemWithMouseCursor(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::pasteClipboard(), RedrawWhileMovingCursor(), SCH_EDIT_FRAME::RepeatDrawItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveWireImage(), LIB_PART::SetConversion(), SCH_EDIT_FRAME::SetRepeatItem(), SCH_EDIT_FRAME::SetUndoItem(), LIB_PART::SetUnitCount(), and COMMIT::Stage().

124 {
125  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
126  wxT( ". Bad programmer!" ) );
127 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
const COLORS_DESIGN_SETTINGS& BOARD::Colors ( ) const
inline

Function GetColorSettings.

Returns
the current COLORS_DESIGN_SETTINGS in use

Definition at line 572 of file class_board.h.

Referenced by BRDITEMS_PLOTTER::getColor(), CINFO3D_VISU::GetItemColor(), CINFO3D_VISU::GetLayerColor(), BRDITEMS_PLOTTER::PlotDimension(), PlotSilkScreen(), and PlotStandardLayer().

572 { return *m_colorsSettings; }
COLORS_DESIGN_SETTINGS * m_colorsSettings
Definition: class_board.h:197
bool BOARD::CombineAllAreasInNet ( PICKED_ITEMS_LIST aDeletedList,
int  aNetCode,
bool  aUseLocalFlags 
)

Function CombineAllAreasInNet Checks all copper areas in net for intersections, combining them if found.

Parameters
aDeletedList= a PICKED_ITEMS_LIST * where to store deleted areas (useful in undo commands can be NULL
aNetCode= net to consider
aUseLocalFlags: if true, don't check areas if both local flags are 0 Sets local flag = 1 for any areas modified
Returns
true if some areas modified

Definition at line 97 of file zones_test_and_combine_areas.cpp.

References SHAPE_POLY_SET::BBox(), CombineAreas(), ZONE_CONTAINER::GetIsKeepout(), ZONE_CONTAINER::GetLayer(), ZONE_CONTAINER::GetLocalFlags(), BOARD_CONNECTED_ITEM::GetNetCode(), ZONE_CONTAINER::GetPriority(), BOX2< Vec >::Intersects(), m_ZoneDescriptorList, ZONE_CONTAINER::Outline(), and TestAreaIntersection().

Referenced by OnAreaPolygonModified().

99 {
100  if( m_ZoneDescriptorList.size() <= 1 )
101  return false;
102 
103  bool modified = false;
104 
105  // Loop through all combinations
106  for( unsigned ia1 = 0; ia1 < m_ZoneDescriptorList.size() - 1; ia1++ )
107  {
108  ZONE_CONTAINER* curr_area = m_ZoneDescriptorList[ia1];
109 
110  if( curr_area->GetNetCode() != aNetCode )
111  continue;
112 
113  // legal polygon
114  BOX2I b1 = curr_area->Outline()->BBox();
115  bool mod_ia1 = false;
116 
117  for( unsigned ia2 = m_ZoneDescriptorList.size() - 1; ia2 > ia1; ia2-- )
118  {
119  ZONE_CONTAINER* area2 = m_ZoneDescriptorList[ia2];
120 
121  if( area2->GetNetCode() != aNetCode )
122  continue;
123 
124  if( curr_area->GetPriority() != area2->GetPriority() )
125  continue;
126 
127  if( curr_area->GetIsKeepout() != area2->GetIsKeepout() )
128  continue;
129 
130  if( curr_area->GetLayer() != area2->GetLayer() )
131  continue;
132 
133  BOX2I b2 = area2->Outline()->BBox();
134 
135  if( b1.Intersects( b2 ) )
136  {
137  // check area2 against curr_area
138  if( curr_area->GetLocalFlags() || area2->GetLocalFlags()
139  || aUseLocalFlags == false )
140  {
141  bool ret = TestAreaIntersection( curr_area, area2 );
142 
143  if( ret )
144  ret = CombineAreas( aDeletedList, curr_area, area2 );
145 
146  if( ret )
147  {
148  mod_ia1 = true;
149  modified = true;
150  }
151  }
152  }
153  }
154 
155  if( mod_ia1 )
156  ia1--; // if modified, we need to check it again
157  }
158 
159  return modified;
160 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:175
SHAPE_POLY_SET * Outline()
Definition: class_zone.h:243
bool CombineAreas(PICKED_ITEMS_LIST *aDeletedList, ZONE_CONTAINER *area_ref, ZONE_CONTAINER *area_to_combine)
Function CombineAreas If possible, combine 2 copper areas.
bool TestAreaIntersection(ZONE_CONTAINER *area_ref, ZONE_CONTAINER *area_to_test)
Function TestAreaIntersection Test for intersection of 2 copper areas area_to_test must be after area...
bool GetIsKeepout() const
Accessors to parameters used in Keepout zones:
Definition: class_zone.h:630
bool Intersects(const BOX2< Vec > &aRect) const
Function Intersects.
Definition: box2.h:234
int GetNetCode() const
Function GetNetCode.
int GetLocalFlags() const
Definition: class_zone.h:237
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
unsigned GetPriority() const
Function GetPriority.
Definition: class_zone.h:106
const BOX2I BBox(int aClearance=0) const override
Function BBox()
bool BOARD::CombineAreas ( PICKED_ITEMS_LIST aDeletedList,
ZONE_CONTAINER area_ref,
ZONE_CONTAINER area_to_combine 
)

Function CombineAreas If possible, combine 2 copper areas.

Parameters
aDeletedList= a PICKED_ITEMS_LIST * where to store deleted areas (useful for undo).
area_ref= the main area (zone)
area_to_combine= the zone that can be merged with area_ref area_ref must be BEFORE area_to_combine area_to_combine will be deleted, if areas are combined
Returns
: true if area_to_combine is combined with area_ref (and therefore be deleted)

Definition at line 289 of file zones_test_and_combine_areas.cpp.

References SHAPE_POLY_SET::BooleanAdd(), ZONE_CONTAINER::Hatch(), ZONE_CONTAINER::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_POLY_SET::PM_FAST, RemoveArea(), ZONE_CONTAINER::SetLocalFlags(), ZONE_CONTAINER::SetOutline(), and SHAPE_POLY_SET::Simplify().

Referenced by CombineAllAreasInNet().

291 {
292  if( area_ref == area_to_combine )
293  {
294  wxASSERT( 0 );
295  return false;
296  }
297 
298  SHAPE_POLY_SET mergedOutlines = *area_ref->Outline();
299  SHAPE_POLY_SET areaToMergePoly = *area_to_combine->Outline();
300 
301  mergedOutlines.BooleanAdd( areaToMergePoly, SHAPE_POLY_SET::PM_FAST );
302  mergedOutlines.Simplify( SHAPE_POLY_SET::PM_FAST );
303 
304  // We should have one polygon with hole
305  // We can have 2 polygons with hole, if the 2 initial polygons have only one common corner
306  // and therefore cannot be merged (they are dectected as intersecting)
307  // but we should never have more than 2 polys
308  if( mergedOutlines.OutlineCount() > 2 )
309  {
310  wxLogMessage(wxT("BOARD::CombineAreas error: more than 2 polys after merging") );
311  return false;
312  }
313 
314  if( mergedOutlines.OutlineCount() > 1 )
315  return false;
316 
317  // Update the area with the new merged outline
318  delete area_ref->Outline();
319  area_ref->SetOutline( new SHAPE_POLY_SET( mergedOutlines ) );
320 
321  RemoveArea( aDeletedList, area_to_combine );
322 
323  area_ref->SetLocalFlags( 1 );
324  area_ref->Hatch();
325 
326  return true;
327 }
void BooleanAdd(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Performs boolean polyset union For aFastMode meaning, see function booleanOp
SHAPE_POLY_SET * Outline()
Definition: class_zone.h:243
void RemoveArea(PICKED_ITEMS_LIST *aDeletedList, ZONE_CONTAINER *area_to_remove)
Function RemoveArea remove copper area from net, and put it in a deleted list (if exists) ...
int OutlineCount() const
Returns the number of outlines in the set
void SetOutline(SHAPE_POLY_SET *aOutline)
Definition: class_zone.h:246
Class SHAPE_POLY_SET.
void Simplify(POLYGON_MODE aFastMode)
Simplifies the polyset (merges overlapping polys, eliminates degeneracy/self-intersections) For aFast...
void Hatch()
Function Hatch computes the hatch lines depending on the hatch parameters and stores it in the zone&#39;s...
void SetLocalFlags(int aFlags)
Definition: class_zone.h:238
EDA_RECT BOARD::ComputeBoundingBox ( bool  aBoardEdgesOnly = false) const

Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge segments).

Parameters
aBoardEdgesOnlyis true if we are interested in board edge segments only.
Returns
EDA_RECT - the board's bounding box

Definition at line 1121 of file class_board.cpp.

References Edge_Cuts, m_Drawings, m_Modules, m_SegZoneDeprecated, m_Track, m_ZoneDescriptorList, EDA_RECT::Merge(), TRACK::Next(), BOARD_ITEM::Next(), MODULE::Next(), SEGZONE::Next(), and PCB_LINE_T.

Referenced by BuildBoardPolygonOutlines(), DIALOG_EXPORT_SVG::CreateSVGFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), PCB_EDIT_FRAME::ExportToGenCAD(), PCBNEW_PRINTOUT::getBoundingBox(), initializePlotter(), CINFO3D_VISU::InitSettings(), DIALOG_EXPORT_STEP::onExportButton(), and StartPlotBoard().

1122 {
1123  bool hasItems = false;
1124  EDA_RECT area;
1125 
1126  // Check segments, dimensions, texts, and fiducials
1127  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
1128  {
1129  if( aBoardEdgesOnly && (item->Type() != PCB_LINE_T || item->GetLayer() != Edge_Cuts ) )
1130  continue;
1131 
1132  if( !hasItems )
1133  area = item->GetBoundingBox();
1134  else
1135  area.Merge( item->GetBoundingBox() );
1136 
1137  hasItems = true;
1138  }
1139 
1140  if( !aBoardEdgesOnly )
1141  {
1142  // Check modules
1143  for( MODULE* module = m_Modules; module; module = module->Next() )
1144  {
1145  if( !hasItems )
1146  area = module->GetBoundingBox();
1147  else
1148  area.Merge( module->GetBoundingBox() );
1149 
1150  hasItems = true;
1151  }
1152 
1153  // Check tracks
1154  for( TRACK* track = m_Track; track; track = track->Next() )
1155  {
1156  if( !hasItems )
1157  area = track->GetBoundingBox();
1158  else
1159  area.Merge( track->GetBoundingBox() );
1160 
1161  hasItems = true;
1162  }
1163 
1164  // Check segment zones
1165  for( TRACK* track = m_SegZoneDeprecated; track; track = track->Next() )
1166  {
1167  if( !hasItems )
1168  area = track->GetBoundingBox();
1169  else
1170  area.Merge( track->GetBoundingBox() );
1171 
1172  hasItems = true;
1173  }
1174 
1175  // Check polygonal zones
1176  for( auto aZone : m_ZoneDescriptorList )
1177  {
1178  if( !hasItems )
1179  area = aZone->GetBoundingBox();
1180  else
1181  area.Merge( aZone->GetBoundingBox() );
1182 
1183  area.Merge( aZone->GetBoundingBox() );
1184  hasItems = true;
1185  }
1186  }
1187 
1188  return area;
1189 }
void Merge(const EDA_RECT &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect...
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
MODULE * Next() const
Definition: class_module.h:122
SEGZONE * Next() const
Definition: class_track.h:367
BOARD_ITEM * Next() const
DLIST< SEGZONE > m_SegZoneDeprecated
Definition: class_board.h:251
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:245
TRACK * Next() const
Definition: class_track.h:103
DLIST< MODULE > m_Modules
Definition: class_board.h:249
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
DLIST< TRACK > m_Track
Definition: class_board.h:250
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
void BOARD::ConvertBrdLayerToPolygonalContours ( PCB_LAYER_ID  aLayer,
SHAPE_POLY_SET aOutlines 
)

Function ConvertBrdLayerToPolygonalContours Build a set of polygons which are the outlines of copper items (pads, tracks, vias, texts, zones) Holes in vias or pads are ignored Usefull to export the shape of copper layers to dxf polygons or 3D viewer the polygons are not merged.

Parameters
aLayer= A copper layer, like B_Cu, etc.
aOutlinesThe SHAPE_POLY_SET to fill in with items outline.

Definition at line 80 of file board_items_to_polygon_shape_transform.cpp.

References ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF, GetCircletoPolyCorrectionFactor(), ZONE_CONTAINER::GetLayer(), TRACK::Next(), BOARD_ITEM::Next(), MODULE::Next(), PCB_LINE_T, PCB_TEXT_T, and ZONE_CONTAINER::TransformSolidAreasShapesToPolygonSet().

Referenced by PlotLayerOutlines().

81 {
82  // Number of segments to convert a circle to a polygon
83  const int segcountforcircle = ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF;
84  double correctionFactor = GetCircletoPolyCorrectionFactor( segcountforcircle );
85 
86  // convert tracks and vias:
87  for( TRACK* track = m_Track; track != NULL; track = track->Next() )
88  {
89  if( !track->IsOnLayer( aLayer ) )
90  continue;
91 
92  track->TransformShapeWithClearanceToPolygon( aOutlines,
93  0, segcountforcircle, correctionFactor );
94  }
95 
96  // convert pads
97  for( MODULE* module = m_Modules; module != NULL; module = module->Next() )
98  {
99  module->TransformPadsShapesWithClearanceToPolygon( aLayer,
100  aOutlines, 0, segcountforcircle, correctionFactor );
101 
102  // Micro-wave modules may have items on copper layers
103  module->TransformGraphicShapesWithClearanceToPolygonSet( aLayer,
104  aOutlines, 0, segcountforcircle, correctionFactor );
105  }
106 
107  // convert copper zones
108  for( int ii = 0; ii < GetAreaCount(); ii++ )
109  {
110  ZONE_CONTAINER* zone = GetArea( ii );
111  PCB_LAYER_ID zonelayer = zone->GetLayer();
112 
113  if( zonelayer == aLayer )
115  aOutlines, segcountforcircle, correctionFactor );
116  }
117 
118  // convert graphic items on copper layers (texts)
119  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
120  {
121  if( !item->IsOnLayer( aLayer ) )
122  continue;
123 
124  switch( item->Type() )
125  {
126  case PCB_LINE_T: // should not exist on copper layers
127  ( (DRAWSEGMENT*) item )->TransformShapeWithClearanceToPolygon(
128  aOutlines, 0, segcountforcircle, correctionFactor );
129  break;
130 
131  case PCB_TEXT_T:
132  ( (TEXTE_PCB*) item )->TransformShapeWithClearanceToPolygonSet(
133  aOutlines, 0, segcountforcircle, correctionFactor );
134  break;
135 
136  default:
137  break;
138  }
139  }
140 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
MODULE * Next() const
Definition: class_module.h:122
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:175
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
void TransformSolidAreasShapesToPolygonSet(SHAPE_POLY_SET &aCornerBuffer, int aCircleToSegmentsCount, double aCorrectionFactor) const
Function TransformSolidAreasShapesToPolygonSet Convert solid areas full shapes to polygon set (the fu...
BOARD_ITEM * Next() const
PCB_LAYER_ID
A quick note on layer IDs:
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:245
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1026
TRACK * Next() const
Definition: class_track.h:103
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:997
DLIST< MODULE > m_Modules
Definition: class_board.h:249
DLIST< TRACK > m_Track
Definition: class_board.h:250
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
#define ARC_APPROX_SEGMENTS_COUNT_HIGH_DEF
Definition: pcbnew.h:42
double GetCircletoPolyCorrectionFactor(int aSegCountforCircle)
TRACK * BOARD::CreateLockPoint ( wxPoint &  aPosition,
TRACK aSegment,
PICKED_ITEMS_LIST aList 
)

Function CreateLockPoint creates an intermediate point on aSegment and break it into two segments at aPosition.

The new segment starts from aPosition and ends at the end point of aSegment. The original segment now ends at aPosition.

Parameters
aPositionA wxPoint object containing the position to test and the new segment start position if the return value is not NULL.
aSegmentThe trace segment to create the lock point on.
aListThe pick list to add the created items to.
Returns
NULL if no new point was created or a pointer to a TRACK object of the created segment. If aSegment points to a via the exact value of aPosition and a pointer to the via are returned.

Definition at line 2280 of file class_board.cpp.

References BEGIN_ONPAD, TRACK::Clone(), delta, TRACK::end, END_ONPAD, ENDPOINT_START, TRACK::GetEnd(), EDA_ITEM::GetList(), GetPad(), TRACK::GetStart(), KiROUND(), TRACK::Next(), PCB_VIA_T, PICKED_ITEMS_LIST::PushItem(), TRACK::SetEnd(), ITEM_PICKER::SetItem(), ITEM_PICKER::SetLink(), TRACK::SetStart(), EDA_ITEM::SetState(), ITEM_PICKER::SetStatus(), TRACK::start, EDA_ITEM::Type(), UR_CHANGED, and UR_NEW.

Referenced by PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::End_Route(), and PCB_EDIT_FRAME::Process_Special_Functions().

2281 {
2282  /* creates an intermediate point on aSegment and break it into two segments
2283  * at aPosition.
2284  * The new segment starts from aPosition and ends at the end point of
2285  * aSegment. The original segment now ends at aPosition.
2286  */
2287  if( aSegment->GetStart() == aPosition || aSegment->GetEnd() == aPosition )
2288  return NULL;
2289 
2290  // A via is a good lock point
2291  if( aSegment->Type() == PCB_VIA_T )
2292  {
2293  aPosition = aSegment->GetStart();
2294  return aSegment;
2295  }
2296 
2297  // Calculation coordinate of intermediate point relative to the start point of aSegment
2298  wxPoint delta = aSegment->GetEnd() - aSegment->GetStart();
2299 
2300  // calculate coordinates of aPosition relative to aSegment->GetStart()
2301  wxPoint lockPoint = aPosition - aSegment->GetStart();
2302 
2303  // lockPoint must be on aSegment:
2304  // Ensure lockPoint.y/lockPoint.y = delta.y/delta.x
2305  if( delta.x == 0 )
2306  lockPoint.x = 0; // horizontal segment
2307  else
2308  lockPoint.y = KiROUND( ( (double)lockPoint.x * delta.y ) / delta.x );
2309 
2310  /* Create the intermediate point (that is to say creation of a new
2311  * segment, beginning at the intermediate point.
2312  */
2313  lockPoint += aSegment->GetStart();
2314 
2315  TRACK* newTrack = (TRACK*)aSegment->Clone();
2316  // The new segment begins at the new point,
2317  newTrack->SetStart(lockPoint);
2318  newTrack->start = aSegment;
2319  newTrack->SetState( BEGIN_ONPAD, false );
2320 
2321  DLIST<TRACK>* list = (DLIST<TRACK>*)aSegment->GetList();
2322  wxASSERT( list );
2323  list->Insert( newTrack, aSegment->Next() );
2324 
2325  if( aList )
2326  {
2327  // Prepare the undo command for the now track segment
2328  ITEM_PICKER picker( newTrack, UR_NEW );
2329  aList->PushItem( picker );
2330  // Prepare the undo command for the old track segment
2331  // before modifications
2332  picker.SetItem( aSegment );
2333  picker.SetStatus( UR_CHANGED );
2334  picker.SetLink( aSegment->Clone() );
2335  aList->PushItem( picker );
2336  }
2337 
2338  // Old track segment now ends at new point.
2339  aSegment->SetEnd(lockPoint);
2340  aSegment->end = newTrack;
2341  aSegment->SetState( END_ONPAD, false );
2342 
2343  D_PAD * pad = GetPad( newTrack, ENDPOINT_START );
2344 
2345  if( pad )
2346  {
2347  newTrack->start = pad;
2348  newTrack->SetState( BEGIN_ONPAD, true );
2349  aSegment->end = pad;
2350  aSegment->SetState( END_ONPAD, true );
2351  }
2352 
2353  aPosition = lockPoint;
2354  return newTrack;
2355 }
DHEAD * GetList() const
Definition: base_struct.h:212
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:134
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:121
void SetEnd(const wxPoint &aEnd)
Definition: class_track.h:122
virtual EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
D_PAD * GetPad(unsigned aIndex) const
Function GetPad.
#define BEGIN_ONPAD
Pcbnew: flag set for track segment starting on a pad.
Definition: base_struct.h:133
static const int delta[8][2]
Definition: solve.cpp:112
const wxPoint & GetEnd() const
Definition: class_track.h:123
const wxPoint & GetStart() const
Definition: class_track.h:126
TRACK * Next() const
Definition: class_track.h:103
void SetState(int type, int state)
Definition: base_struct.h:245
void SetStart(const wxPoint &aStart)
Definition: class_track.h:125
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
BOARD_CONNECTED_ITEM * end
Definition: class_track.h:95
BOARD_CONNECTED_ITEM * start
Definition: class_track.h:94
virtual void BOARD_ITEM_CONTAINER::Delete ( BOARD_ITEM aItem)
inlinevirtualinherited

Removes an item from the containter and deletes it.

Parameters
aItemis an item to be deleted.

Definition at line 68 of file board_item_container.h.

References BOARD_ITEM_CONTAINER::Remove().

Referenced by DRC_LIST_MARKERS::DeleteItem(), BOARD_COMMIT::Push(), PCB_EDIT_FRAME::Remove_Zone_Corner(), RemoveArea(), PCB_EDIT_FRAME::RemoveStruct(), and ~BOARD().

69  {
70  Remove( aItem );
71  delete aItem;
72  }
virtual void Remove(BOARD_ITEM *aItem)=0
Removes an item from the container.
void BOARD::DeleteMARKERs ( )

Function DeleteMARKERs deletes ALL MARKERS from the board.

Definition at line 1028 of file class_board.cpp.

References m_markers.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), DRC_LIST_MARKERS::DeleteAllItems(), DSN::SPECCTRA_DB::FromSESSION(), and ~BOARD().

1029 {
1030  // the vector does not know how to delete the MARKER_PCB, it holds pointers
1031  for( MARKER_PCB* marker : m_markers )
1032  delete marker;
1033 
1034  m_markers.clear();
1035 }
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:180
void BOARD::DeleteZONEOutlines ( )

Function DeleteZONEOutlines deletes ALL zone outlines from the board.

Definition at line 1038 of file class_board.cpp.

References m_ZoneDescriptorList.

Referenced by ~BOARD().

1039 {
1040  // the vector does not know how to delete the ZONE Outlines, it holds pointers
1041  for( ZONE_CONTAINER* zone : m_ZoneDescriptorList )
1042  delete zone;
1043 
1044  m_ZoneDescriptorList.clear();
1045 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
void BOARD::Draw ( EDA_DRAW_PANEL aPanel,
wxDC *  aDC,
GR_DRAWMODE  aDrawMode,
const wxPoint &  aOffset = ZeroOffset 
)
overridevirtual

Function Draw.

Redraw the BOARD items but not cursors, axis or grid.

Parameters
aPanel= the panel relative to the board
aDC= the current device context
aDrawMode= GR_COPY, GR_OR ... (not always used)
aOffset= an draw offset value (default = 0,0)

Implements BOARD_ITEM.

Definition at line 135 of file pcb_legacy_draw_utils.cpp.

References LSET::AllCuMask(), B_Cu, ZONE_CONTAINER::Draw(), ZONE_CONTAINER::DrawFilledArea(), F_Cu, EDA_ITEM::GetFlags(), i, IN_EDIT, IS_DRAGGED, IS_MOVED, FOOTPRINT_EDIT_FRAME::IsElementVisible(), LAYER_MOD_BK, LAYER_MOD_FR, TRACK::Next(), BOARD_ITEM::Next(), MODULE::Next(), SEGZONE::Next(), PCB_DIMENSION_T, PCB_LINE_T, PCB_TARGET_T, PCB_TEXT_T, and Trace_Pads_Only().

Referenced by DISPLAY_FOOTPRINTS_FRAME::OnUIToolSelection(), FOOTPRINT_VIEWER_FRAME::RedrawActiveWindow(), FOOTPRINT_WIZARD_FRAME::RedrawActiveWindow(), and PCB_EDIT_FRAME::RedrawActiveWindow().

136 {
137  /* The order of drawing is flexible on some systems and not on others. For
138  * OSes which use OR to draw, the order is not important except for the
139  * effect of the highlight and its relationship to markers. See comment
140  * below.
141  * This order independence comes from the fact that a binary OR operation is
142  * commutative in nature.
143  * However on the OSX, the OR operation is not used, and so this sequence
144  * below is chosen to give MODULEs the highest visible priority.
145  */
146 
147  /* Draw all tracks and zones. As long as dark colors are used for the
148  * tracks, Then the OR draw mode should show tracks underneath other
149  * tracks. But a white track will cover any other color since it has
150  * more bits to OR in.
151  */
152  for( TRACK* track = m_Track; track; track = track->Next() )
153  {
154  if( track->IsMoving() )
155  continue;
156 
157  track->Draw( aPanel, DC, aDrawMode );
158  }
159 
160  // SEGZONE is deprecated, only for compatibility with
161  // very old designs
162  for( SEGZONE* zone = m_SegZoneDeprecated; zone; zone = zone->Next() )
163  {
164  if( zone->IsMoving() )
165  continue;
166 
167  zone->Draw( aPanel, DC, aDrawMode );
168  }
169 
170  // Draw areas (i.e. zones)
171  for( int ii = 0; ii < GetAreaCount(); ii++ )
172  {
173  ZONE_CONTAINER* zone = GetArea( ii );
174 
175  // Areas must be drawn here only if not moved or dragged,
176  // because these areas are drawn by ManageCursor() in a specific manner
177  if( ( zone->GetFlags() & (IN_EDIT | IS_DRAGGED | IS_MOVED) ) == 0 )
178  {
179  zone->Draw( aPanel, DC, aDrawMode );
180  zone->DrawFilledArea( aPanel, DC, aDrawMode );
181  }
182  }
183 
184  // Draw the graphic items
185  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
186  {
187  if( item->IsMoving() )
188  continue;
189 
190  switch( item->Type() )
191  {
192  case PCB_DIMENSION_T:
193  case PCB_TEXT_T:
194  case PCB_TARGET_T:
195  case PCB_LINE_T:
196  item->Draw( aPanel, DC, aDrawMode );
197  break;
198 
199  default:
200  break;
201  }
202  }
203 
204  LSET all_cu = LSET::AllCuMask();
205 
206  for( MODULE* module = m_Modules; module; module = module->Next() )
207  {
208  bool display = true;
209  LSET layerMask = all_cu;
210 
211  if( module->IsMoving() )
212  continue;
213 
215  {
216  if( module->GetLayer() == F_Cu )
217  display = false;
218 
219  layerMask.set( F_Cu, false );
220  }
221 
223  {
224  if( module->GetLayer() == B_Cu )
225  display = false;
226 
227  layerMask.set( B_Cu, false );
228  }
229 
230  if( display )
231  module->Draw( aPanel, DC, aDrawMode );
232  else
233  Trace_Pads_Only( aPanel, DC, module, 0, 0, layerMask, aDrawMode );
234  }
235 
236  if( IsHighLightNetON() )
237  DrawHighLight( aPanel, DC, GetHighLightNetCode() );
238 
239  // draw the BOARD's markers last, otherwise the high light will erase any marker on a pad
240  for( unsigned i = 0; i < m_markers.size(); ++i )
241  {
242  m_markers[i]->Draw( aPanel, DC, aDrawMode );
243  }
244 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:676
void Draw(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset) override
Function Draw Draws the zone outline.
Definition: class_zone.cpp:276
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:258
#define IN_EDIT
Item currently edited.
Definition: base_struct.h:112
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
void DrawFilledArea(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset)
Function DrawDrawFilledArea Draws the filled area for this zone (polygon list .m_FilledPolysList) ...
Definition: class_zone.cpp:406
MODULE * Next() const
Definition: class_module.h:122
show modules on back
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
SEGZONE * Next() const
Definition: class_track.h:367
show modules on front
BOARD_ITEM * Next() const
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:116
Class LSET is a set of PCB_LAYER_IDs.
DLIST< SEGZONE > m_SegZoneDeprecated
Definition: class_board.h:251
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:245
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1026
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:180
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
static void Trace_Pads_Only(EDA_DRAW_PANEL *panel, wxDC *DC, MODULE *Module, int ox, int oy, LSET LayerMask, GR_DRAWMODE draw_mode)
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:101
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
TRACK * Next() const
Definition: class_track.h:103
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:997
DLIST< MODULE > m_Modules
Definition: class_board.h:249
size_t i
Definition: json11.cpp:597
bool IsHighLightNetON() const
Function IsHighLightNetON.
Definition: class_board.h:388
int GetHighLightNetCode() const
Function GetHighLightNetCode.
Definition: class_board.h:373
DLIST< TRACK > m_Track
Definition: class_board.h:250
void DrawHighLight(EDA_DRAW_PANEL *aDrawPanel, wxDC *aDC, int aNetCode)
Function DrawHighLight redraws the objects in the board that are associated with the given aNetCode a...
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
#define IS_MOVED
Item being moved.
Definition: base_struct.h:113
void BOARD::DrawHighLight ( EDA_DRAW_PANEL aDrawPanel,
wxDC *  aDC,
int  aNetCode 
)

Function DrawHighLight redraws the objects in the board that are associated with the given aNetCode and turns on or off the brilliance associated with that net according to the current value of global g_HighLight_Status.

Parameters
aDrawPanelis needed for the clipping support.
aDC= the current device context
aNetCodeis the net number to highlight or to dim.

Definition at line 247 of file pcb_legacy_draw_utils.cpp.

References ZONE_CONTAINER::Draw(), BOARD_CONNECTED_ITEM::GetNetCode(), GR_AND, GR_HIGHLIGHT, GR_OR, TRACK::Next(), MODULE::Next(), and D_PAD::Next().

Referenced by Abort_Create_Track(), PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::HighLight(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), and PCB_EDIT_FRAME::StartMoveOneNodeOrSegment().

248 {
249  GR_DRAWMODE draw_mode;
250 
251  if( IsHighLightNetON() )
252  draw_mode = GR_HIGHLIGHT | GR_OR;
253  else
254  draw_mode = GR_AND | GR_HIGHLIGHT;
255 
256  // Redraw zones
257  for( int ii = 0; ii < GetAreaCount(); ii++ )
258  {
259  ZONE_CONTAINER* zone = GetArea( ii );
260 
261  if( zone->GetNetCode() == aNetCode )
262  {
263  zone->Draw( am_canvas, DC, draw_mode );
264  }
265  }
266 
267  // Redraw any pads that have aNetCode
268  for( MODULE* module = m_Modules; module; module = module->Next() )
269  {
270  for( D_PAD* pad = module->PadsList(); pad; pad = pad->Next() )
271  {
272  if( pad->GetNetCode() == aNetCode )
273  {
274  pad->Draw( am_canvas, DC, draw_mode );
275  }
276  }
277  }
278 
279  // Redraw track and vias that have aNetCode
280  for( TRACK* seg = m_Track; seg; seg = seg->Next() )
281  {
282  if( seg->GetNetCode() == aNetCode )
283  {
284  seg->Draw( am_canvas, DC, draw_mode );
285  }
286  }
287 }
void Draw(EDA_DRAW_PANEL *panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint &offset=ZeroOffset) override
Function Draw Draws the zone outline.
Definition: class_zone.cpp:276
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
MODULE * Next() const
Definition: class_module.h:122
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
D_PAD * Next() const
Definition: class_pad.h:160
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1026
Definition: gr_basic.h:38
int GetNetCode() const
Function GetNetCode.
TRACK * Next() const
Definition: class_track.h:103
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:997
DLIST< MODULE > m_Modules
Definition: class_board.h:249
bool IsHighLightNetON() const
Function IsHighLightNetON.
Definition: class_board.h:388
DLIST< TRACK > m_Track
Definition: class_board.h:250
DLIST<BOARD_ITEM>& BOARD::DrawingsList ( )
inline

Definition at line 261 of file class_board.h.

Referenced by PCB_EDIT_FRAME::AppendBoardFile(), and PCBNEW_CONTROL::placeBoardItems().

261 { return m_Drawings; }
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:245
BOARD_ITEM * BOARD::Duplicate ( const BOARD_ITEM aItem,
bool  aAddToBoard = false 
)

Definition at line 2918 of file class_board.cpp.

References Add(), BuildBoardPolygonOutlines(), EDA_ITEM::Clone(), PCB_DIMENSION_T, PCB_LINE_T, PCB_MODULE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, and EDA_ITEM::Type().

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

2920 {
2921  BOARD_ITEM* new_item = NULL;
2922 
2923  switch( aItem->Type() )
2924  {
2925  case PCB_MODULE_T:
2926  case PCB_TEXT_T:
2927  case PCB_LINE_T:
2928  case PCB_TRACE_T:
2929  case PCB_VIA_T:
2930  case PCB_ZONE_AREA_T:
2931  case PCB_TARGET_T:
2932  case PCB_DIMENSION_T:
2933  new_item = static_cast<BOARD_ITEM*>( aItem->Clone() );
2934  break;
2935 
2936  default:
2937  // Un-handled item for duplication
2938  new_item = NULL;
2939  break;
2940  }
2941 
2942  if( new_item && aAddToBoard )
2943  Add( new_item );
2944 
2945  return new_item;
2946 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class MODULE, a footprint
Definition: typeinfo.h:89
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:101
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
NETINFO_LIST::iterator BOARD::EndNets ( ) const
inline

Function EndNets.

Returns
iterator to the last element of the NETINFO_ITEMs list

Definition at line 775 of file class_board.h.

References NETINFO_LIST::end().

776  {
777  return m_NetInfo.end();
778  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
iterator end() const
Definition: netinfo.h:537
MODULE * BOARD::FindModule ( const wxString &  aRefOrTimeStamp,
bool  aSearchByTimeStamp = false 
) const

Function FindModule searches for a module matching aRefOrTimeStamp depending on the state of aSearchByTimeStamp.

Parameters
aRefOrTimeStampis the search string.
aSearchByTimeStampsearches by the module time stamp value if true. Otherwise search by reference designator.
Returns
MODULE* - If found, the module meeting the search criteria, else NULL.

Definition at line 1457 of file class_board.cpp.

References FindModuleByReference(), m_Modules, and MODULE::Next().

1458 {
1459  if( aSearchByTimeStamp )
1460  {
1461  for( MODULE* module = m_Modules; module; module = module->Next() )
1462  {
1463  if( aRefOrTimeStamp.CmpNoCase( module->GetPath() ) == 0 )
1464  return module;
1465  }
1466  }
1467  else
1468  {
1469  return FindModuleByReference( aRefOrTimeStamp );
1470  }
1471 
1472  return NULL;
1473 }
MODULE * Next() const
Definition: class_module.h:122
MODULE * FindModuleByReference(const wxString &aReference) const
Function FindModuleByReference searches for a MODULE within this board with the given reference desig...
DLIST< MODULE > m_Modules
Definition: class_board.h:249
MODULE * BOARD::FindModuleByReference ( const wxString &  aReference) const

Function FindModuleByReference searches for a MODULE within this board with the given reference designator.

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

Parameters
aReferenceThe reference designator of the MODULE to find.
Returns
MODULE* - If found, the MODULE having the given reference designator, else NULL.

Definition at line 1429 of file class_board.cpp.

References EOT, MODULE::GetReference(), PCB_MODULE_T, SEARCH_CONTINUE, SEARCH_QUIT, and Visit().

Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), FindModule(), DSN::SPECCTRA_DB::FromSESSION(), ReplaceNetlist(), BOARD_NETLIST_UPDATER::testConnectivity(), and DIALOG_NETLIST::verifyFootprints().

1430 {
1431  MODULE* found = nullptr;
1432 
1433  // search only for MODULES
1434  static const KICAD_T scanTypes[] = { PCB_MODULE_T, EOT };
1435 
1436  INSPECTOR_FUNC inspector = [&] ( EDA_ITEM* item, void* testData )
1437  {
1438  MODULE* module = (MODULE*) item;
1439 
1440  if( aReference == module->GetReference() )
1441  {
1442  found = module;
1443  return SEARCH_QUIT;
1444  }
1445 
1446  return SEARCH_CONTINUE;
1447  };
1448 
1449  // visit this BOARD with the above inspector
1450  BOARD* nonconstMe = (BOARD*) this;
1451  nonconstMe->Visit( inspector, NULL, scanTypes );
1452 
1453  return found;
1454 }
std::function< SEARCH_RESULT(EDA_ITEM *aItem, void *aTestData) > INSPECTOR_FUNC
Typedef INSPECTOR is used to inspect and possibly collect the (search) results of iterating over a li...
Definition: base_struct.h:77
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
class MODULE, a footprint
Definition: typeinfo.h:89
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:171
const wxString & GetReference() const
Function GetReference.
Definition: class_module.h:462
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
NETINFO_ITEM * BOARD::FindNet ( int  aNetcode) const

Function FindNet searches for a net with the given netcode.

Parameters
aNetcodeA netcode to search for.
Returns
NETINFO_ITEM_ITEM* - the net or NULL if not found.

Definition at line 1408 of file class_board.cpp.

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

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), PCAD2KICAD::PCB_PAD::AddToModule(), DIALOG_COPPER_ZONE::buildAvailableListOfNets(), CreateSignalsSection(), PNS_PCBNEW_RULE_RESOLVER::DpCoupledNet(), PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), PNS_PCBNEW_RULE_RESOLVER::DpNetPolarity(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), filterNetClass(), PCB_EDIT_FRAME::fixEagleNets(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), BOARD_CONNECTED_ITEM::GetNetClass(), DIALOG_SELECT_NET_FROM_LIST::HighlightNet(), highlightNet(), PNS::SIZES_SETTINGS::Init(), LEGACY_PLUGIN::loadNETINFO_ITEM(), LEGACY_PLUGIN::loadPAD(), PNS_PCBNEW_RULE_RESOLVER::NetName(), PCB_EDIT_FRAME::OnLeftClick(), PNS_PCBNEW_RULE_RESOLVER::PNS_PCBNEW_RULE_RESOLVER(), SanitizeNetcodes(), BOARD_CONNECTED_ITEM::SetNetCode(), PNS::DIFF_PAIR_PLACER::Start(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateCopperZoneNets().

1409 {
1410  // the first valid netcode is 1 and the last is m_NetInfo.GetCount()-1.
1411  // zero is reserved for "no connection" and is not actually a net.
1412  // NULL is returned for non valid netcodes
1413 
1414  wxASSERT( m_NetInfo.GetNetCount() > 0 );
1415 
1416  if( aNetcode == NETINFO_LIST::UNCONNECTED && m_NetInfo.GetNetCount() == 0 )
1418  else
1419  return m_NetInfo.GetNetItem( aNetcode );
1420 }
NETINFO_ITEM * GetNetItem(int aNetCode) const
Function GetItem.
unsigned GetNetCount() const
Function GetNetCount.
Definition: netinfo.h:442
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
static NETINFO_ITEM ORPHANED_ITEM
NETINFO_ITEM meaning that there was no net assigned for an item, as there was no board storing net li...
Definition: netinfo.h:477
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
Definition: netinfo.h:469
NETINFO_ITEM * BOARD::FindNet ( const wxString &  aNetname) const

Function FindNet overloaded searches for a net with the given name.

Parameters
aNetnameA Netname to search for.
Returns
NETINFO_ITEM* - the net or NULL if not found.

Definition at line 1423 of file class_board.cpp.

References NETINFO_LIST::GetNetItem(), and m_NetInfo.

1424 {
1425  return m_NetInfo.GetNetItem( aNetname );
1426 }
NETINFO_ITEM * GetNetItem(int aNetCode) const
Function GetItem.
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
virtual void BOARD_ITEM::Flip ( const wxPoint &  aCentre)
inlinevirtualinherited

Function Flip Flip this object, i.e.

change the board side for this object

Parameters
aCentre- the rotation point.

Reimplemented in VIA, ZONE_CONTAINER, D_PAD, DRAWSEGMENT, MODULE, DIMENSION, TRACK, TEXTE_MODULE, EDGE_MODULE, MARKER_PCB, PCB_TARGET, and TEXTE_PCB.

Definition at line 266 of file class_board_item.h.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Flip(), BOARD_ITEM::Flip(), and PCB_BASE_EDIT_FRAME::PutDataInPreviousState().

267  {
268  wxMessageBox( wxT( "virtual BOARD_ITEM::Flip used, should not occur" ), GetClass() );
269  }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void BOARD_ITEM::Flip ( const VECTOR2I aCentre)
inlineinherited

Definition at line 271 of file class_board_item.h.

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

272  {
273  Flip( wxPoint( aCentre.x, aCentre.y ) );
274  }
virtual void Flip(const wxPoint &aCentre)
Function Flip Flip this object, i.e.
ZONE_CONTAINER* BOARD::GetArea ( int  index) const
inline

Function GetArea returns the Area (Zone Container) at a given index.

Parameters
indexThe array type index into a collection of ZONE_CONTAINER *.
Returns
ZONE_CONTAINER* - a pointer to the Area or NULL if index out of range.

Definition at line 997 of file class_board.h.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), GERBER_JOBFILE_WRITER::addJSONDesignRules(), AllConnectedItems(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::Block_SelectItems(), CN_CONNECTIVITY_ALGO::Build(), ZONE_FILLER::buildZoneFeatureHoleList(), BOARD_NETLIST_UPDATER::cacheCopperZoneConnections(), CINFO3D_VISU::createLayers(), PYTHON_ACTION_PLUGINS::deregister_action(), DRC::doEdgeZoneDrc(), DRC::doTrackKeepoutDrc(), PCB_EDIT_FRAME::Edit_Zone_Params(), export_vrml_zones(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), PCB_IO::format(), PlotSilkScreen(), PlotSolderMaskLayer(), PlotStandardLayer(), PCB_EDIT_FRAME::Process_Special_Functions(), RedrawAreasOutlines(), RedrawFilledAreas(), ReplaceNetlist(), SaveCopyOfZones(), SetAreasNetCodesFromNetNames(), SetElementVisibility(), TestForExistingItem(), DRC::testKeepoutAreas(), DRC::testZones(), DRC::TestZoneToZoneOutline(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), and UpdateCopyOfZonesList().

998  {
999  if( (unsigned) index < m_ZoneDescriptorList.size() )
1000  return m_ZoneDescriptorList[index];
1001 
1002  return NULL;
1003  }
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
int BOARD::GetAreaIndex ( const ZONE_CONTAINER aArea) const
inline

Function GetAreaIndex returns the Area Index for the given Zone Container.

Parameters
aArea:The ZONE_CONTAINER to find.
Returns
an Area Index in m_ZoneDescriptorList or -1 if non found.

Definition at line 1011 of file class_board.h.

Referenced by PCB_EDIT_FRAME::End_Move_Zone_Corner_Or_Outlines(), PCB_EDIT_FRAME::End_Zone(), and PCB_EDIT_FRAME::Remove_Zone_Corner().

1012  {
1013  for( int ii = 0; ii < GetAreaCount(); ii++ ) // Search for aArea in list
1014  {
1015  if( aArea == GetArea( ii ) ) // Found !
1016  return ii;
1017  }
1018 
1019  return -1;
1020  }
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1026
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:997
const wxPoint& BOARD::GetAuxOrigin ( ) const
inline
BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 64 of file class_board_item.cpp.

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

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::CreateFiles(), DeleteMarkedItems(), TEXTE_PCB::Draw(), PCB_TARGET::Draw(), EDGE_MODULE::Draw(), ZONE_CONTAINER::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DIMENSION::Draw(), DRAWSEGMENT::Draw(), MODULE::Draw(), SEGZONE::Draw(), VIA::Draw(), MODULE::DrawAncre(), ZONE_CONTAINER::DrawFilledArea(), TEXTE_PCB::Flip(), TRACK::Flip(), BOARD_ITEM::Flip(), ZONE_CONTAINER::Flip(), VIA::Flip(), BOARD_ITEM::GetBoard(), GAL_ARRAY_CREATOR::getBoard(), LEGACY_ARRAY_CREATOR::getBoard(), MODULE::GetBoundingPoly(), BOARD_ITEM::GetLayerName(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), VIA::GetSelectMenuText(), D_PAD::GetSelectMenuText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), PushTrack(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), MODULE::ViewBBox(), VIA::ViewGetLOD(), and D_PAD::ViewGetLOD().

65 {
66  if( Type() == PCB_T )
67  return (BOARD*) this;
68 
69  BOARD_ITEM* parent = GetParent();
70 
71  if( parent )
72  return parent->GetBoard();
73 
74  return NULL;
75 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
BOARD_ITEM_CONTAINER * GetParent() const
Definition: typeinfo.h:85
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:171
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
const EDA_RECT BOARD::GetBoardEdgesBoundingBox ( ) const
inline

Function GetBoardEdgesBoundingBox Returns 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 810 of file class_board.h.

Referenced by GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), BuildBoardPolygonOutlines(), EAGLE_PLUGIN::centerBoard(), BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition(), GENDRILL_WRITER_BASE::genDrillMapFile(), AR_AUTOPLACER::genPlacementRoutingMatrix(), PCB_BASE_FRAME::GetBoardBoundingBox(), idf_export_outline(), PCB_EDIT_FRAME::OnExportIDF3(), ReplaceNetlist(), PCB_EDIT_FRAME::SpreadFootprints(), and DRC::testOutline().

811  {
812  return ComputeBoundingBox( true );
813  }
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge seg...
bool BOARD::GetBoardPolygonOutlines ( SHAPE_POLY_SET aOutlines,
wxString *  aErrorText = nullptr,
wxPoint *  aErrorLocation = nullptr 
)

Function GetBoardPolygonOutlines Extracts 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
aOutlinesThe SHAPE_POLY_SET to fill in with outlines/holes.
aErrorText= a wxString reference to display an error message with the coordinate of the point which creates the error (default = nullptr , no message returned on error)
aErrorLocation= a wxPoint giving the location of the Error message on the board if left null (default), no location is returned
Returns
true if success, false if a contour is not valid

Definition at line 2960 of file class_board.cpp.

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

Referenced by CINFO3D_VISU::createBoardPolygon(), export_vrml_board(), DSN::SPECCTRA_DB::fillBOUNDARY(), AR_AUTOPLACER::genPlacementRoutingMatrix(), and DRC::testOutline().

2961 {
2962  bool success = BuildBoardPolygonOutlines( this, aOutlines, aErrorText,
2963  Millimeter2iu( 0.05 ), aErrorLocation );
2964 
2965  // Make polygon strictly simple to avoid issues (especially in 3D viewer)
2967 
2968  return success;
2969 
2970 }
void Simplify(POLYGON_MODE aFastMode)
Simplifies the polyset (merges overlapping polys, eliminates degeneracy/self-intersections) For aFast...
bool BuildBoardPolygonOutlines(BOARD *aBoard, SHAPE_POLY_SET &aOutlines, wxString *aErrorText, unsigned int aTolerance, wxPoint *aErrorLocation=nullptr)
const EDA_RECT BOARD::GetBoundingBox ( ) const
inlineoverridevirtual

Function GetBoundingBox returns 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 798 of file class_board.h.

Referenced by PCB_BASE_FRAME::GetBoardBoundingBox(), DIALOG_UPDATE_PCB::PerformUpdate(), and PCB_EDIT_FRAME::ReadPcbNetlist().

799  {
800  return ComputeBoundingBox( false );
801  }
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge seg...
virtual const wxPoint BOARD_ITEM::GetCenter ( ) const
inlinevirtualinherited

Function GetCenter()

This defaults to the same point as returned by GetPosition(), unless overridden

Returns
centre point of the item

Reimplemented in DRAWSEGMENT.

Definition at line 97 of file class_board_item.h.

References BOARD_ITEM::GetPosition(), and BOARD_ITEM::SetPosition().

Referenced by chainMarkedSegments(), and DIALOG_CREATE_ARRAY::ARRAY_CIRCULAR_OPTIONS::TransformItem().

97 { return GetPosition(); }
virtual const wxPoint GetPosition() const =0
wxString BOARD::GetClass ( ) const
inlineoverridevirtual

Function GetClass returns the class name.

Returns
wxString

Implements EDA_ITEM.

Definition at line 933 of file class_board.h.

Referenced by Visit().

934  {
935  return wxT( "BOARD" );
936  }
std::shared_ptr<CONNECTIVITY_DATA> BOARD::GetConnectivity ( ) const
inline

Function GetConnectivity() returns list of missing connections between components/tracks.

Returns
an object that contains informations about missing connections.

Definition at line 297 of file class_board.h.

Referenced by PCB_EDIT_FRAME::Block_Delete(), PCB_EDIT_FRAME::Block_Flip(), PCB_EDIT_FRAME::Block_Move(), PCB_EDIT_FRAME::Block_Rotate(), PCB_BASE_FRAME::build_ratsnest_module(), BuildConnectivity(), TRACKS_CLEANER::buildTrackConnectionInfo(), BOARD_NETLIST_UPDATER::cacheCopperZoneConnections(), PCB_EDITOR_CONTROL::calculateSelectionRatsnest(), PCB_EDIT_FRAME::Change_Side_Module(), TRACKS_CLEANER::cleanupVias(), PCB_BASE_FRAME::Compile_Ratsnest(), PCB_EDIT_FRAME::Delete_net(), PCB_EDIT_FRAME::Delete_Segment(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PCB_BASE_FRAME::DrawGeneralRatsnest(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::EraseRedundantTrack(), ZONE_FILLER::Fill(), filterNetClass(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_EDIT_FRAME::ImportSpecctraSession(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), DIALOG_NETLIST::OnCompileRatsnestClick(), PadDelete(), PCB_BASE_FRAME::PlaceModule(), PCB_EDIT_FRAME::Process_Special_Functions(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::ReadPcbNetlist(), PCB_EDIT_FRAME::Remove_One_Track(), TRACKS_CLEANER::removeBadTrackSegments(), BOARD_COMMIT::Revert(), PCB_BASE_FRAME::Rotate_Module(), AR_AUTOPLACER::rotateModule(), SELECTION_TOOL::selectAllItemsConnectedToItem(), SELECTION_TOOL::selectAllItemsOnNet(), PCB_EDIT_FRAME::SetBoard(), SetElementVisibility(), TRACKS_CLEANER::testTrackEndpointDangling(), DRC::testUnconnected(), DRC::testZones(), PCB_BASE_FRAME::TraceAirWiresToTargets(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

298  {
299  return m_connectivity;
300  }
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:193
int BOARD::GetCopperLayerCount ( ) const

Function GetCopperLayerCount.

Returns
int - The number of copper layers in the BOARD.

Definition at line 732 of file class_board.cpp.

References BOARD_DESIGN_SETTINGS::GetCopperLayerCount(), and m_designSettings.

Referenced by GERBER_JOBFILE_WRITER::addJSONDesignRules(), GERBER_JOBFILE_WRITER::addJSONFilesAttributes(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), Autoroute_One_Track(), GENDRILL_WRITER_BASE::BuildFileFunctionAttributeString(), DSN::SPECCTRA_DB::buildLayerMaps(), compute_layer_Zs(), compute_pad_access_code(), CreateComponentsSection(), CreatePadsShapesSection(), CreateRoutesSection(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), VIA::Draw(), DRAWING_TOOL::DrawVia(), TEXTE_PCB::Flip(), TRACK::Flip(), ZONE_CONTAINER::Flip(), VIA::Flip(), DSN::SPECCTRA_DB::FromBOARD(), GetGerberFileFunctionAttribute(), CINFO3D_VISU::InitSettings(), PCB_EDIT_FRAME::IsMicroViaAcceptable(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), main(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DSN::SPECCTRA_DB::makeVIA(), PARAM_CFG_LAYERS::SaveParam(), ZONE_SETTINGS::SetupLayersList(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), PANEL_SETUP_LAYERS::TransferDataToWindow(), and via_access_code().

733 {
735 }
int GetCopperLayerCount() const
Function GetCopperLayerCount.
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
BOARD_DESIGN_SETTINGS& BOARD::GetDesignSettings ( ) const
inline

Function GetDesignSettings.

Returns
the BOARD_DESIGN_SETTINGS for this BOARD

Definition at line 539 of file class_board.h.

Referenced by GERBER_JOBFILE_WRITER::addJSONDesignRules(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), Append_Track_Width_List(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetclassesGrid(), ZONE_FILLER::buildUnconnectedThermalStubsPolygonList(), ZONE_FILLER::buildZoneFeatureHoleList(), EDIT_TOOL::changeTrackWidthOnClick(), compute_layer_Zs(), MICROWAVE_TOOL::createInductorBetween(), CreatePadsShapesSection(), CreateRoutesSection(), ROUTER_TOOL::CustomTrackWidthDialog(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), DRC::doFootprintOverlappingDrc(), DRC::doNetClass(), DRC::doTrackDrc(), ROUTER_TOOL::DpDimensionsDialog(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::EditDimension(), EVT_GRID_CMD_CELL_CHANGED(), EVT_UPDATE_UI(), PCB_EDIT_FRAME::Export_IDF3(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), PCB_IO::formatGeneral(), PCB_IO::formatNetInformation(), PCB_IO::formatSetup(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), MODULE::GetBoundingPoly(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_CONNECTED_ITEM::GetNetClass(), PCB_EDIT_FRAME::GetProjectFileParameters(), DRAWING_TOOL::getSegmentWidth(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), PANEL_SETUP_MASK_AND_PASTE::ImportSettingsFrom(), PANEL_SETUP_TEXT_AND_GRAPHICS::ImportSettingsFrom(), PANEL_SETUP_FEATURE_CONSTRAINTS::ImportSettingsFrom(), PANEL_SETUP_TRACKS_AND_VIAS::ImportSettingsFrom(), PANEL_SETUP_NETCLASSES::ImportSettingsFrom(), PNS::SIZES_SETTINGS::Init(), DIALOG_PLOT::init_Dialog(), CINFO3D_VISU::InitSettings(), CINFO3D_VISU::Is3DLayerEnabled(), LEGACY_PLUGIN::loadGENERAL(), LEGACY_PLUGIN::loadNETCLASS(), EAGLE_PLUGIN::loadPlain(), LEGACY_PLUGIN::loadSETUP(), NETINFO_ITEM::NETINFO_ITEM(), DIALOG_DRC_CONTROL::OnActivateDlg(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), PCB_EDIT_FRAME::OnHotKey(), ROUTER_TOOL::onViaCommand(), PCB_EDIT_FRAME::OpenProjectFiles(), OrCell_Trace(), PANEL_SETUP_FEATURE_CONSTRAINTS::PANEL_SETUP_FEATURE_CONSTRAINTS(), PANEL_SETUP_MASK_AND_PASTE::PANEL_SETUP_MASK_AND_PASTE(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SETUP_TEXT_AND_GRAPHICS::PANEL_SETUP_TEXT_AND_GRAPHICS(), PANEL_SETUP_TRACKS_AND_VIAS::PANEL_SETUP_TRACKS_AND_VIAS(), PCB_EDITOR_CONTROL::PlaceTarget(), PlotOneBoardLayer(), PlotSolderMaskLayer(), PlotStandardLayer(), PNS_PCBNEW_RULE_RESOLVER::PNS_PCBNEW_RULE_RESOLVER(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), PARAM_CFG_LAYERS::ReadParam(), PCB_LAYER_WIDGET::ReFillRender(), DRC::RunTests(), SaveBoard(), PARAM_CFG_LAYERS::SaveParam(), NETINFO_ITEM::SetClass(), PNS::DIFF_PAIR_PLACER::Start(), PNS_KICAD_IFACE::SyncWorld(), DRC::testDrilledHoles(), DRC::testNetClasses(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), and MODULE::ViewBBox().

540  {
541  // remove const-ness with cast.
543  }
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
int BOARD::GetFileFormatVersionAtLoad ( ) const
inline

Definition at line 282 of file class_board.h.

References ADD_INSERT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

282 { return m_fileFormatVersionAtLoad; }
int m_fileFormatVersionAtLoad
the version loaded from the file
Definition: class_board.h:191
const wxString& BOARD::GetFileName ( ) const
inline

Definition at line 238 of file class_board.h.

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), DIALOG_GEN_FOOTPRINT_POSITION::CreateFiles(), CreateHeaderInfoData(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GENDRILL_WRITER_BASE::GenDrillReportFile(), PCB_EDIT_FRAME::GenFootprintsReport(), GENDRILL_WRITER_BASE::getDrillFileName(), PCB_EDIT_FRAME::GetLastNetListRead(), PCB_EDIT_FRAME::ImportSpecctraSession(), PCB_EDIT_FRAME::InstallNetlistFrame(), DIALOG_IMPORT_SETTINGS::OnBrowseClicked(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), PCB_EDIT_FRAME::OnCloseWindow(), PCB_EDIT_FRAME::OnExportIDF3(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), PLOT_CONTROLLER::OpenPlotfile(), DIALOG_PLOT::Plot(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), PCB_EDIT_FRAME::SetLastNetListRead(), StartPlotBoard(), PCB_EDIT_FRAME::UpdateTitle(), and DIALOG_DRC_CONTROL::writeReport().

238 { return m_fileName; }
wxString m_fileName
the board filename
Definition: class_board.h:177
STATUS_FLAGS EDA_ITEM::GetFlags ( ) const
inlineinherited

Definition at line 258 of file base_struct.h.

References EDA_ITEM::m_Flags.

Referenced by AbortMoveAndEditTarget(), SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForBitmap(), AddMenusForBusEntry(), AddMenusForComponent(), AddMenusForComponentField(), AddMenusForEditComponent(), AddMenusForGLabel(), AddMenusForHierchicalSheet(), AddMenusForHLabel(), AddMenusForLabel(), AddMenusForSheetPin(), AddMenusForText(), SCH_EDIT_FRAME::BeginSegment(), SCH_EDIT_FRAME::ChangeTextOrient(), Collect_TrackSegmentsToDrag(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), LIB_EDIT_FRAME::copySelectedItems(), LIB_EDIT_FRAME::CreatePin(), PCB_EDIT_FRAME::createPopUpMenuForFootprints(), PCB_EDIT_FRAME::createPopUpMenuForFpPads(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), PCB_EDIT_FRAME::createPopUpMenuForTexts(), PCB_EDIT_FRAME::createPopupMenuForTracks(), PCB_EDIT_FRAME::createPopUpMenuForZones(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteItem(), SCH_EDIT_FRAME::DeleteItemsInList(), SCH_EDIT_FRAME::DeleteJunction(), PCB_BASE_FRAME::DeleteTextModule(), Draw(), PCB_EDIT_FRAME::Edit_TrackSegm_Width(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditImage(), PCB_EDIT_FRAME::FlipTextePcb(), LIB_VIEW_FRAME::GeneralControl(), SCH_EDIT_FRAME::GeneralControl(), LIB_EDIT_FRAME::GetComponentFromRedoList(), LIB_EDIT_FRAME::GetComponentFromUndoList(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), SCH_EDIT_FRAME::OnDragItem(), SCH_EDIT_FRAME::OnEditItem(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnHotKey(), SCH_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotKey(), PCB_EDIT_FRAME::OnHotkeyBeginRoute(), PCB_EDIT_FRAME::OnHotkeyCopyItem(), PCB_EDIT_FRAME::OnHotkeyDeleteItem(), PCB_EDIT_FRAME::OnHotkeyDuplicateOrArrayItem(), PCB_EDIT_FRAME::OnHotkeyEditItem(), PCB_EDIT_FRAME::OnHotkeyFlipItem(), PCB_EDIT_FRAME::OnHotkeyMoveItem(), PCB_EDIT_FRAME::OnHotkeyPlaceItem(), PCB_EDIT_FRAME::OnHotkeyRotateItem(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), EDA_DRAW_PANEL::OnMouseEvent(), SCH_EDIT_FRAME::OnMoveItem(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_EDIT_FRAME::OnOrient(), FOOTPRINT_EDIT_FRAME::OnRightClick(), GERBVIEW_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), SCH_EDIT_FRAME::OnSelectUnit(), SCH_EDIT_FRAME::OrientComponent(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::Rotate_Module(), PCB_EDIT_FRAME::Rotate_Texte_Pcb(), SCH_EDIT_FRAME::RotateField(), SCH_EDIT_FRAME::RotateHierarchicalSheet(), SCH_EDIT_FRAME::RotateImage(), PCB_BASE_FRAME::RotateTextModule(), LIB_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow().

258 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
MODULE * BOARD::GetFootprint ( const wxPoint &  aPosition,
PCB_LAYER_ID  aActiveLayer,
bool  aVisibleOnly,
bool  aIgnoreLocked = false 
)

Function GetFootprint 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
aPositionA wxPoint object containing the position to test.
aActiveLayerLayer to test.
aVisibleOnlySearch only the visible layers if true.
aIgnoreLockedIgnore locked modules when true.
Returns
MODULE* The best module or NULL if none.

Definition at line 2191 of file class_board.cpp.

References dist, MODULE::GetFootprintRect(), EDA_RECT::GetHeight(), BOARD_ITEM::GetLayer(), EDA_RECT::GetWidth(), EDA_RECT::GetX(), EDA_RECT::GetY(), MODULE::HitTest(), IsBackLayer(), MODULE::IsLocked(), IsModuleLayerVisible(), m_Modules, and MODULE::Next().

Referenced by PCB_EDIT_FRAME::OnHotKey(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

2193 {
2194  MODULE* pt_module;
2195  MODULE* module = NULL;
2196  MODULE* alt_module = NULL;
2197  int min_dim = 0x7FFFFFFF;
2198  int alt_min_dim = 0x7FFFFFFF;
2199  bool current_layer_back = IsBackLayer( aActiveLayer );
2200 
2201  for( pt_module = m_Modules; pt_module; pt_module = pt_module->Next() )
2202  {
2203  // is the ref point within the module's bounds?
2204  if( !pt_module->HitTest( aPosition ) )
2205  continue;
2206 
2207  // if caller wants to ignore locked modules, and this one is locked, skip it.
2208  if( aIgnoreLocked && pt_module->IsLocked() )
2209  continue;
2210 
2211  PCB_LAYER_ID layer = pt_module->GetLayer();
2212 
2213  // Filter non visible modules if requested
2214  if( !aVisibleOnly || IsModuleLayerVisible( layer ) )
2215  {
2216  EDA_RECT bb = pt_module->GetFootprintRect();
2217 
2218  int offx = bb.GetX() + bb.GetWidth() / 2;
2219  int offy = bb.GetY() + bb.GetHeight() / 2;
2220 
2221  // off x & offy point to the middle of the box.
2222  int dist = ( aPosition.x - offx ) * ( aPosition.x - offx ) +
2223  ( aPosition.y - offy ) * ( aPosition.y - offy );
2224 
2225  if( current_layer_back == IsBackLayer( layer ) )
2226  {
2227  if( dist <= min_dim )
2228  {
2229  // better footprint shown on the active side
2230  module = pt_module;
2231  min_dim = dist;
2232  }
2233  }
2234  else if( aVisibleOnly && IsModuleLayerVisible( layer ) )
2235  {
2236  if( dist <= alt_min_dim )
2237  {
2238  // better footprint shown on the other side
2239  alt_module = pt_module;
2240  alt_min_dim = dist;
2241  }
2242  }
2243  }
2244  }
2245 
2246  if( module )
2247  {
2248  return module;
2249  }
2250 
2251  if( alt_module)
2252  {
2253  return alt_module;
2254  }
2255 
2256  return NULL;
2257 }
static const int dist[10][10]
Definition: ar_matrix.cpp:320
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it&#39;s a back layer.
MODULE * Next() const
Definition: class_module.h:122
int GetHeight() const
Definition: eda_rect.h:118
PCB_LAYER_ID
A quick note on layer IDs:
EDA_RECT GetFootprintRect() const
Function GetFootprintRect() Returns the area of the module footprint excluding any text...
bool IsLocked() const override
Function IsLocked.
Definition: class_module.h:267
DLIST< MODULE > m_Modules
Definition: class_board.h:249
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int GetX() const
Definition: eda_rect.h:109
int GetWidth() const
Definition: eda_rect.h:117
bool IsModuleLayerVisible(PCB_LAYER_ID aLayer)
Function IsModuleLayerVisible expects either of the two layers on which a module can reside...
int GetY() const
Definition: eda_rect.h:110
bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
const wxPoint& BOARD::GetGridOrigin ( ) const
inline
int BOARD::GetHighLightNetCode ( ) const
inline

Function GetHighLightNetCode.

Returns
netcode of net to highlight (-1 when no net selected)

Definition at line 373 of file class_board.h.

References HIGH_LIGHT_INFO::m_netCode.

Referenced by Abort_Create_Track(), PCB_EDIT_FRAME::Begin_Zone(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists().

373 { return m_highLight.m_netCode; }
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:188
BOARD_ITEM * BOARD::GetItem ( void *  aWeakReference)

Definition at line 1048 of file class_board.cpp.

References Drawings(), g_DeletedItem, Modules(), Tracks(), and Zones().

Referenced by DRC_ITEM::GetAuxiliaryItem(), and DRC_ITEM::GetMainItem().

1049 {
1050  for( TRACK* track : Tracks() )
1051  if( track == aWeakReference )
1052  return track;
1053 
1054  for( MODULE* module : Modules() )
1055  {
1056  if( module == aWeakReference )
1057  return module;
1058 
1059  for( D_PAD* pad : module->Pads() )
1060  if( pad == aWeakReference )
1061  return pad;
1062 
1063  if( &module->Reference() == aWeakReference )
1064  return &module->Reference();
1065 
1066  if( &module->Value() == aWeakReference )
1067  return &module->Value();
1068 
1069  for( BOARD_ITEM* drawing : module->GraphicalItems() )
1070  if( drawing == aWeakReference )
1071  return drawing;
1072  }
1073 
1074  for( ZONE_CONTAINER* zone : Zones() )
1075  if( zone == aWeakReference )
1076  return zone;
1077 
1078  for( BOARD_ITEM* drawing : Drawings() )
1079  if( drawing == aWeakReference )
1080  return drawing;
1081 
1082  // Not found; weak reference has been deleted.
1083  return &g_DeletedItem;
1084 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
DELETED_BOARD_ITEM g_DeletedItem
Definition: class_board.cpp:95
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:255
ZONE_CONTAINERS & Zones()
Definition: class_board.h:257
DLIST_ITERATOR_WRAPPER< TRACK > Tracks()
Definition: class_board.h:254
DLIST_ITERATOR_WRAPPER< BOARD_ITEM > Drawings()
Definition: class_board.h:256
virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const
inlinevirtualinherited

Function GetLayer returns the primary layer this item is on.

Reimplemented in ZONE_CONTAINER.

Definition at line 124 of file class_board_item.h.

References BOARD_ITEM::m_Layer.

Referenced by Abort_MoveOrCopyModule(), DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), CN_CONNECTIVITY_ALGO::Add(), CN_LIST::Add(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), DIMENSION::AdjustDimensionDetails(), PCB_EDIT_FRAME::Begin_DrawSegment(), FOOTPRINT_EDIT_FRAME::Begin_Edge_Module(), AR_AUTOPLACER::buildFpAreas(), PCB_EDIT_FRAME::Change_Side_Module(), checkConnectedTo(), MODULE::CopyNetlistSettings(), CreateBoardSection(), MWAVE::CreateMicrowaveInductor(), CreateRoutesSection(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), DRC::doTrackKeepoutDrc(), TEXTE_MODULE::Draw(), DRAWSEGMENT::Draw(), KIGFX::PCB_PAINTER::draw(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Layer(), FOOTPRINT_EDIT_FRAME::Edit_Edge_Width(), export_vrml_drawsegment(), export_vrml_edge_module(), export_vrml_module(), export_vrml_pcbtext(), export_vrml_text_module(), PCB_EDIT_FRAME::ExportToGenCAD(), TEXTE_PCB::Flip(), PCB_TARGET::Flip(), EDGE_MODULE::Flip(), TEXTE_MODULE::Flip(), TRACK::Flip(), DIMENSION::Flip(), MODULE::Flip(), DRAWSEGMENT::Flip(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::formatLayer(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), GetFootprint(), ZONE_CONTAINER::GetLayer(), AR_AUTOPLACER::getOptimalModulePlacement(), GetPad(), TEXT_MOD_GRID_TABLE::GetValueAsLong(), GetVisibleTrack(), SELECTION_TOOL::guessSelectionCandidates(), idf_export_module(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), D_PAD::IsFlipped(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), MarkTrace(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), PCB_EDIT_FRAME::OnRightClick(), PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::Plot_Edges_Modules(), BRDITEMS_PLOTTER::PlotAllTextsModule(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotDrawSegment(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotTextePcb(), processBoardItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), TRACKS_CLEANER::removeDuplicatesOfTrack(), PCB_BASE_FRAME::ResetTextSize(), SELECTION_TOOL::selectable(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), ShowClearance(), PNS_KICAD_IFACE::syncGraphicalItem(), PNS_KICAD_IFACE::syncTrack(), DRC::testCopperDrawItem(), DRC::testCopperTextAndGraphics(), DRC::testCopperTextItem(), DRC::testDisabledLayers(), AR_AUTOPLACER::testModuleOnBoard(), TEXTE_MODULE::TEXTE_MODULE(), AR_MATRIX::TraceSegmentPcb(), TraceSegmentPcb(), TrackListSortByNetcode(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), MODULE::TransformGraphicTextWithClearanceToPolygonSet(), TEXTE_MODULE::ViewGetLayers(), TRACK::ViewGetLayers(), TEXTE_MODULE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

124 { return m_Layer; }
PCB_LAYER_ID m_Layer
const PCB_LAYER_ID BOARD::GetLayerID ( const wxString &  aLayerName) const

Function GetLayerID returns the ID of a layer given by aLayerName.

Copper layers may have custom names.

Parameters
aLayerName= A layer name, like wxT("B.Cu"), etc.
Returns
PCB_LAYER_ID - the layer id, which for copper layers may be custom, else standard.

Definition at line 572 of file class_board.cpp.

References GetStandardLayerName(), IsCopperLayer(), m_Layer, PCB_LAYER_ID_COUNT, ToLAYER_ID(), and UNDEFINED_LAYER.

573 {
574 
575  // Look for the BOARD specific copper layer names
576  for( LAYER_NUM layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
577  {
578  if ( IsCopperLayer( layer ) && ( m_Layer[ layer ].m_name == aLayerName ) )
579  {
580  return ToLAYER_ID( layer );
581  }
582  }
583 
584  // Otherwise fall back to the system standard layer names
585  for( LAYER_NUM layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
586  {
587  if( GetStandardLayerName( ToLAYER_ID( layer ) ) == aLayerName )
588  {
589  return ToLAYER_ID( layer );
590  }
591  }
592 
593  return UNDEFINED_LAYER;
594 }
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
LAYER m_Layer[PCB_LAYER_ID_COUNT]
Definition: class_board.h:185
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:813
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:659
wxString BOARD_ITEM::GetLayerName ( ) const
inherited

Function GetLayerName returns the name of the PCB layer on which the item resides.

Returns
wxString containing the layer name associated with this item.

Definition at line 78 of file class_board_item.cpp.

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

Referenced by BOARD_ITEM::Flip(), PCB_IO::format(), PCB_IO::formatLayer(), TEXTE_PCB::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), DRAWSEGMENT::GetMsgPanelInfo(), TEXTE_PCB::GetSelectMenuText(), EDGE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), DIMENSION::GetSelectMenuText(), DRAWSEGMENT::GetSelectMenuText(), TRACK::GetSelectMenuText(), SEGZONE::GetSelectMenuText(), MODULE::GetSelectMenuText(), ZONE_CONTAINER::GetSelectMenuText(), TEXT_MOD_GRID_TABLE::GetValue(), and main().

79 {
80  BOARD* board = GetBoard();
81 
82  if( board )
83  return board->GetLayerName( m_Layer );
84 
85  // If no parent, return standard name
87 }
PCB_LAYER_ID m_Layer
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:171
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:659
wxString BOARD::GetLayerName ( PCB_LAYER_ID  aLayer) const

Function GetLayerName returns the name of a layer given by aLayer.

Copper layers may have custom names.

Parameters
aLayer= A layer, like B_Cu, etc.
Returns
wxString - the layer name, which for copper layers may be custom, else standard.

Definition at line 596 of file class_board.cpp.

References GetStandardLayerName(), IsCopperLayer(), IsLayerEnabled(), m_Layer, and LAYER::m_name.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DSN::SPECCTRA_DB::buildLayerMaps(), GRID_CELL_LAYER_RENDERER::Draw(), PCB_IO::formatBoardLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), PCB_LAYER_SELECTOR::GetLayerName(), PCB_LAYER_BOX_SELECTOR::GetLayerName(), BOARD_ITEM::GetLayerName(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), VIA::GetSelectMenuText(), GRID_CELL_LAYER_SELECTOR::GetValue(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_PAD_PROPERTIES::initValues(), LayerMaskDescribe(), DIALOG_PLOT::Plot(), PCB_LAYER_WIDGET::ReFill(), PARAM_CFG_LAYERS::SaveParam(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), ZONE_SETTINGS::SetupLayersList(), PANEL_SETUP_LAYERS::showBoardLayerNames(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), and DIALOG_PRINT_PCBNEW::TransferDataToWindow().

597 {
598  // All layer names are stored in the BOARD.
599  if( IsLayerEnabled( aLayer ) )
600  {
601  // Standard names were set in BOARD::BOARD() but they may be
602  // over-ridden by BOARD::SetLayerName().
603  // For copper layers, return the actual copper layer name,
604  // otherwise return the Standard English layer name.
605  if( IsCopperLayer( aLayer ) )
606  return m_Layer[aLayer].m_name;
607  }
608 
609  return GetStandardLayerName( aLayer );
610 }
wxString m_name
The name of the layer, there should be no spaces in this name.
Definition: class_board.h:113
bool IsLayerEnabled(PCB_LAYER_ID aLayer) const
Function IsLayerEnabled is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:446
LAYER m_Layer[PCB_LAYER_ID_COUNT]
Definition: class_board.h:185
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Function GetStandardLayerName returns an "English Standard" name of a PCB layer when given aLayerNumb...
Definition: class_board.h:659
virtual LSET BOARD_ITEM::GetLayerSet ( ) const
inlinevirtualinherited

Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segment or VIA physically resides.

Returns
int - a layer mask, see layers_id_colors_visibility.h.

Reimplemented in D_PAD, VIA, and ZONE_CONTAINER.

Definition at line 132 of file class_board_item.h.

Referenced by GRID_HELPER::BestSnapAnchor(), build_pad_testpoints(), chainMarkedSegments(), VIA::ClassOf(), Collect_TrackSegmentsToDrag(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), PCB_EDIT_FRAME::EraseRedundantTrack(), find_vias_and_tracks_at(), TRACK::GetEndSegments(), TRACK::GetTrack(), hash_board_item(), MarkTrace(), POINT_EDITOR::OnSelectionChange(), and PCB_EDIT_FRAME::StartMoveOneNodeOrSegment().

132 { return LSET( m_Layer ); }
PCB_LAYER_ID m_Layer
Class LSET is a set of PCB_LAYER_IDs.
LAYER_T BOARD::GetLayerType ( PCB_LAYER_ID  aLayer) const

Function GetLayerType returns the type of the copper layer given by aLayer.

Parameters
aLayerA layer index, like B_Cu, etc.
Returns
LAYER_T - the layer type, or LAYER_T(-1) if the index was out of range.

Definition at line 658 of file class_board.cpp.

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

Referenced by PCB_IO::formatBoardLayers(), DSN::SPECCTRA_DB::FromBOARD(), GetGerberFileFunctionAttribute(), PARAM_CFG_LAYERS::SaveParam(), and PANEL_SETUP_LAYERS::showLayerTypes().

659 {
660  if( !IsCopperLayer( aLayer ) )
661  return LT_SIGNAL;
662 
663  //@@IMB: The original test was broken due to the discontinuity
664  // in the layer sequence.
665  if( IsLayerEnabled( aLayer ) )
666  return m_Layer[aLayer].m_type;
667 
668  return LT_SIGNAL;
669 }
bool IsLayerEnabled(PCB_LAYER_ID aLayer) const
Function IsLayerEnabled is a proxy function that calls the correspondent function in m_BoardSettings ...
Definition: class_board.h:446
LAYER_T m_type
The type of the layer.
Definition: class_board.h:115
LAYER m_Layer[PCB_LAYER_ID_COUNT]
Definition: class_board.h:185
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
DHEAD* EDA_ITEM::GetList ( ) const
inlineinherited
BOARD_CONNECTED_ITEM * BOARD::GetLockPoint ( const wxPoint &  aPosition,
LSET  aLayerMask 
)

Function GetLockPoint returns the item at the "attachment" point at the end of a trace at aPosition on aLayerMask.

This may be a PAD or another trace segment.

Parameters
aPositionA wxPoint object containing the position to test.
aLayerMaskA layer or layers to mask the hit test. Use -1 to ignore layer mask.
Returns
A pointer to a BOARD_ITEM object if found otherwise NULL.

Definition at line 2260 of file class_board.cpp.

References GetTrack(), GetVisibleTrack(), m_Modules, m_Track, and MODULE::Next().

Referenced by PCB_EDIT_FRAME::Begin_Route(), and PCB_EDIT_FRAME::End_Route().

2261 {
2262  for( MODULE* module = m_Modules; module; module = module->Next() )
2263  {
2264  D_PAD* pad = module->GetPad( aPosition, aLayerSet );
2265 
2266  if( pad )
2267  return pad;
2268  }
2269 
2270  // No pad has been located so check for a segment of the trace.
2271  TRACK* segment = ::GetTrack( m_Track, NULL, aPosition, aLayerSet );
2272 
2273  if( !segment )
2274  segment = GetVisibleTrack( m_Track, aPosition, aLayerSet );
2275 
2276  return segment;
2277 }
TRACK * GetTrack(TRACK *aStartTrace, const TRACK *aEndTrace, const wxPoint &aPosition, LSET aLayerMask)
Function GetTrack is a helper function to locate a trace segment having an end point at aPosition on ...
Definition: class_track.cpp:68
MODULE * Next() const
Definition: class_module.h:122
TRACK * GetVisibleTrack(TRACK *aStartingTrace, const wxPoint &aPosition, LSET aLayerSet) const
Function GetVisibleTrack finds the neighboring visible segment of aTrace at aPosition that is on a la...
DLIST< MODULE > m_Modules
Definition: class_board.h:249
DLIST< TRACK > m_Track
Definition: class_board.h:250
MARKER_PCB* BOARD::GetMARKER ( int  index) const
inline

Function GetMARKER returns the MARKER at a given index.

Parameters
indexThe array type index into a collection of MARKER_PCBS.
Returns
MARKER_PCB* - a pointer to the MARKER_PCB or NULL if index out of range.

Definition at line 328 of file class_board.h.

Referenced by DRC_LIST_MARKERS::DeleteItem(), PCB_DRAW_PANEL_GAL::DisplayBoard(), DRC_LIST_MARKERS::GetItem(), and DIALOG_FIND::onButtonFindMarkerClick().

329  {
330  if( (unsigned) index < m_markers.size() )
331  return m_markers[index];
332 
333  return NULL;
334  }
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:180
int BOARD::GetMARKERCount ( ) const
inline

Function GetMARKERCount.

Returns
int - The number of MARKER_PCBS.

Definition at line 340 of file class_board.h.

Referenced by PCB_DRAW_PANEL_GAL::DisplayBoard(), and DRC_LIST_MARKERS::GetCount().

341  {
342  return (int) m_markers.size();
343  }
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:180
BITMAP_DEF EDA_ITEM::GetMenuImage ( ) const
virtualinherited

Function GetMenuImage returns 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 D_PAD, SCH_COMPONENT, ZONE_CONTAINER, MODULE, SCH_SHEET, LIB_PIN, VIA, SEGZONE, SCH_HIERLABEL, GERBER_DRAW_ITEM, TRACK, SCH_GLOBALLABEL, DRAWSEGMENT, DIMENSION, LIB_FIELD, SCH_LABEL, TEXTE_MODULE, SCH_BUS_BUS_ENTRY, SCH_SHEET_PIN, SCH_TEXT, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, LIB_TEXT, EDGE_MODULE, TEXTE_PCB, LIB_POLYLINE, LIB_RECTANGLE, MARKER_PCB, PCB_TARGET, LIB_CIRCLE, SCH_NO_CONNECT, SCH_MARKER, and SCH_JUNCTION.

Definition at line 280 of file base_struct.cpp.

References dummy_xpm, EDA_ITEM::GetClass(), i, and KIGFX::operator<<().

Referenced by SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::doSelectionMenu(), EDA_ITEM::HitTest(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

281 {
282  return dummy_xpm;
283 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:56
void BOARD::GetMsgPanelInfo ( EDA_UNITS_T  aUnits,
std::vector< MSG_PANEL_ITEM > &  aList 
)
overridevirtual

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Note
This method replaces DisplayInfo() so that KiCad objects no longer have any knowledge of wxWidgets UI objects.
Parameters
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 1192 of file class_board.cpp.

References BLUE, DARKCYAN, DARKGREEN, GetConnectivity(), NETINFO_LIST::GetNetCount(), GetNodesCount(), GetPadCount(), m_NetInfo, m_Track, TRACK::Next(), PCB_VIA_T, and RED.

Referenced by PCB_BASE_FRAME::UpdateMsgPanel().

1193 {
1194  wxString txt;
1195  int viasCount = 0;
1196  int trackSegmentsCount = 0;
1197 
1198  for( BOARD_ITEM* item = m_Track; item; item = item->Next() )
1199  {
1200  if( item->Type() == PCB_VIA_T )
1201  viasCount++;
1202  else
1203  trackSegmentsCount++;
1204  }
1205 
1206  txt.Printf( wxT( "%d" ), GetPadCount() );
1207  aList.push_back( MSG_PANEL_ITEM( _( "Pads" ), txt, DARKGREEN ) );
1208 
1209  txt.Printf( wxT( "%d" ), viasCount );
1210  aList.push_back( MSG_PANEL_ITEM( _( "Vias" ), txt, DARKGREEN ) );
1211 
1212  txt.Printf( wxT( "%d" ), trackSegmentsCount );
1213  aList.push_back( MSG_PANEL_ITEM( _( "Track Segments" ), txt, DARKGREEN ) );
1214 
1215  txt.Printf( wxT( "%d" ), GetNodesCount() );
1216  aList.push_back( MSG_PANEL_ITEM( _( "Nodes" ), txt, DARKCYAN ) );
1217 
1218  txt.Printf( wxT( "%d" ), m_NetInfo.GetNetCount() - 1 /* Don't include "No Net" in count */ );
1219  aList.push_back( MSG_PANEL_ITEM( _( "Nets" ), txt, RED ) );
1220 
1221  txt.Printf( wxT( "%d" ), GetConnectivity()->GetUnconnectedCount() );
1222  aList.push_back( MSG_PANEL_ITEM( _( "Unrouted" ), txt, BLUE ) );
1223 }
Definition: colors.h:57
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
unsigned GetNetCount() const
Function GetNetCount.
Definition: netinfo.h:442
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
unsigned GetNodesCount(int aNet=-1)
Function GetNodesCount.
Definition: colors.h:60
unsigned GetPadCount()
Function GetPadCount.
TRACK * Next() const
Definition: class_track.h:103
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
DLIST< TRACK > m_Track
Definition: class_board.h:250
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:297
unsigned BOARD::GetNetCount ( ) const
inline

Function GetNetCount.

Returns
the number of nets (NETINFO_ITEM)

Definition at line 785 of file class_board.h.

References NETINFO_LIST::GetNetCount().

Referenced by DIALOG_SELECT_NET_FROM_LIST::buildNetsList(), CreateSignalsSection(), DSN::SPECCTRA_DB::FromBOARD(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), PNS_PCBNEW_RULE_RESOLVER::PNS_PCBNEW_RULE_RESOLVER(), and SetElementVisibility().

786  {
787  return m_NetInfo.GetNetCount();
788  }
unsigned GetNetCount() const
Function GetNetCount.
Definition: netinfo.h:442
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:201
int BOARD_ITEM::getNextNumberInSequence ( const std::set< int > &  aSeq,
bool  aFillSequenceGaps 
)
staticprotectedinherited

Definition at line 121 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

122 {
123  if( aSeq.empty() )
124  return 1;
125 
126  // By default go to the end of the sequence
127  int candidate = *aSeq.rbegin();
128 
129  // Filling in gaps in pad numbering
130  if( aFillSequenceGaps )
131  {
132  // start at the beginning
133  candidate = *aSeq.begin();
134 
135  for( auto it : aSeq )
136  {
137  if( it - candidate > 1 )
138  break;
139 
140  candidate = it;
141  }
142  }
143 
144  ++candidate;
145 
146  return candidate;
147 }
unsigned BOARD::GetNodesCount ( int  aNet = -1)

Function GetNodesCount.

Parameters
aNetOnly count nodes belonging to this net
Returns
the number of pads members of nets (i.e. with netcode > 0)

Definition at line 1099 of file class_board.cpp.

References mod, and Modules().

Referenced by DIALOG_SELECT_NET_FROM_LIST::buildNetsList(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), and GetMsgPanelInfo().

1100 {
1101  unsigned retval = 0;
1102  for( auto mod : Modules() )
1103  {
1104  for( auto pad : mod->Pads() )
1105  {
1106  if( ( aNet == -1 && pad->GetNetCode() > 0 ) || aNet == pad->GetNetCode() )
1107  retval++;
1108  }
1109  }
1110 
1111  return retval;
1112 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:255
#define mod(a, n)
Definition: greymap.cpp:24
int BOARD::GetNumSegmTrack ( ) const

Functions to get some items count.

Definition at line 1087 of file class_board.cpp.

References DHEAD::GetCount(), and m_Track.

Referenced by PCB_IO::formatGeneral().

1088 {
1089  return m_Track.GetCount();
1090 }
unsigned GetCount() const
Function GetCount returns the number of elements in the list.
Definition: dlist.h:126
DLIST< TRACK > m_Track
Definition: class_board.h:250
int BOARD::GetNumSegmZone ( ) const

Calculate the zone segment count.

Definition at line 1093 of file class_board.cpp.

References DHEAD::GetCount(), and m_SegZoneDeprecated.

Referenced by PCB_IO::formatGeneral().

1094 {
1095  return m_SegZoneDeprecated.GetCount();
1096 }
DLIST< SEGZONE > m_SegZoneDeprecated
Definition: class_board.h:251
unsigned GetCount() const
Function GetCount returns the number of elements in the list.
Definition: dlist.h:126
D_PAD * BOARD::GetPad ( unsigned  aIndex) const

Function GetPad.

Returns
D_PAD* - at the aIndex

Definition at line 3002 of file class_board.cpp.

References m_Modules, and mod.

Referenced by AddNewTrace(), Autoroute_One_Track(), chainMarkedSegments(), CreateLockPoint(), DeleteNullTrackSegments(), PCB_EDIT_FRAME::EraseRedundantTrack(), GetPad(), Magnetize(), and MarkTrace().

3003 {
3004  unsigned count = 0;
3005 
3006  for( MODULE* mod = m_Modules; mod ; mod = mod->Next() ) // FIXME: const DLIST_ITERATOR
3007  {
3008  for( D_PAD* pad = mod->PadsList(); pad; pad = pad->Next() )
3009  {
3010  if( count == aIndex )
3011  return pad;
3012 
3013  count++;
3014  }
3015  }
3016 
3017  return nullptr;
3018 }
DLIST< MODULE > m_Modules
Definition: class_board.h:249
#define mod(a, n)
Definition: greymap.cpp:24
D_PAD * BOARD::GetPad ( const wxPoint &  aPosition,
LSET  aLayerMask 
)

Function GetPad finds a pad aPosition on aLayer.

Parameters
aPositionA wxPoint object containing the position to hit test.
aLayerMaskA layer or layers to mask the hit test.
Returns
A pointer to a D_PAD object if found or NULL if not found.

Definition at line 1657 of file class_board.cpp.

References LSET::AllCuMask(), m_Modules, and MODULE::Next().

1658 {
1659  if( !aLayerSet.any() )
1660  aLayerSet = LSET::AllCuMask();
1661 
1662  for( MODULE* module = m_Modules; module; module = module->Next() )
1663  {
1664  D_PAD* pad = NULL;
1665 
1666  if( module->HitTest( aPosition ) )
1667  pad = module->GetPad( aPosition, aLayerSet );
1668 
1669  if( pad )
1670  return pad;
1671  }
1672 
1673  return NULL;
1674 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:676
MODULE * Next() const
Definition: class_module.h:122
DLIST< MODULE > m_Modules
Definition: class_board.h:249
D_PAD* BOARD::GetPad ( const wxPoint &  aPosition)
inline

Definition at line 1173 of file class_board.h.

1174  {
1175  return GetPad( aPosition, LSET().set() );
1176  }
D_PAD * GetPad(unsigned aIndex) const
Function GetPad.
Class LSET is a set of PCB_LAYER_IDs.
D_PAD * BOARD::GetPad ( TRACK aTrace,
ENDPOINT_T  aEndPoint 
)

Function GetPad finds a pad connected to aEndPoint of aTrace.

Parameters
aTraceA pointer to a TRACK object to hit test against.
aEndPointThe end point of aTrace the hit test against.
Returns
A pointer to a D_PAD object if found or NULL if not found.

Definition at line 1677 of file class_board.cpp.

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

1678 {
1679  const wxPoint& aPosition = aTrace->GetEndPoint( aEndPoint );
1680 
1681  LSET lset( aTrace->GetLayer() );
1682 
1683  return GetPad( aPosition, lset );
1684 }
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
D_PAD * GetPad(unsigned aIndex) const
Function GetPad.
Class LSET is a set of PCB_LAYER_IDs.
const wxPoint & GetEndPoint(ENDPOINT_T aEndPoint) const
Return the selected endpoint (start or end)
Definition: class_track.h:130
D_PAD * BOARD::GetPad ( std::vector< D_PAD * > &  aPadList,
const wxPoint &  aPosition,
LSET  aLayerMask 
)

Function GetPad locates 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= the list of pads candidates (a std::vector<D_PAD*>)
aPositionA wxPoint object containing the position to test.
aLayerMaskA layer or layers to mask the hit test.
Returns
a D_PAD object pointer to the connected pad.

Definition at line 1723 of file class_board.cpp.

References delta, D_PAD::GetLayerSet(), and D_PAD::GetPosition().

1724 {
1725  // Search aPadList for aPosition
1726  // aPadList is sorted by X then Y values, and a fast binary search is used
1727  int idxmax = aPadList.size()-1;
1728 
1729  int delta = aPadList.size();
1730 
1731  int idx = 0; // Starting index is the beginning of list
1732 
1733  while( delta )
1734  {
1735  // Calculate half size of remaining interval to test.
1736  // Ensure the computed value is not truncated (too small)
1737  if( (delta & 1) && ( delta > 1 ) )
1738  delta++;
1739 
1740  delta /= 2;
1741 
1742  D_PAD* pad = aPadList[idx];
1743 
1744  if( pad->GetPosition() == aPosition ) // candidate found
1745  {
1746  // The pad must match the layer mask:
1747  if( ( aLayerSet & pad->GetLayerSet() ).any() )
1748  return pad;
1749 
1750  // More than one pad can be at aPosition
1751  // search for a pad at aPosition that matched this mask
1752 
1753  // search next
1754  for( int ii = idx+1; ii <= idxmax; ii++ )
1755  {
1756  pad = aPadList[ii];
1757 
1758  if( pad->GetPosition() != aPosition )
1759  break;
1760 
1761  if( ( aLayerSet & pad->GetLayerSet() ).any() )
1762  return pad;
1763  }
1764  // search previous
1765  for( int ii = idx-1 ;ii >=0; ii-- )
1766  {
1767  pad = aPadList[ii];
1768 
1769  if( pad->GetPosition() != aPosition )
1770  break;
1771 
1772  if( ( aLayerSet & pad->GetLayerSet() ).any() )
1773  return pad;
1774  }
1775 
1776  // Not found:
1777  return 0;
1778  }
1779 
1780  if( pad->GetPosition().x == aPosition.x ) // Must search considering Y coordinate
1781  {
1782  if( pad->GetPosition().y < aPosition.y ) // Must search after this item
1783  {
1784  idx += delta;
1785 
1786  if( idx > idxmax )
1787  idx = idxmax;
1788  }
1789  else // Must search before this item
1790  {
1791  idx -= delta;
1792 
1793  if( idx < 0 )
1794  idx = 0;
1795  }
1796  }
1797  else if( pad->GetPosition().x < aPosition.x ) // Must search after this item
1798  {
1799  idx += delta;
1800 
1801  if( idx > idxmax )
1802  idx = idxmax;
1803  }
1804  else // Must search before this item
1805  {
1806  idx -= delta;
1807 
1808  if( idx < 0 )
1809  idx = 0;
1810  }
1811  }
1812 
1813  return NULL;
1814 }
static const int delta[8][2]
Definition: solve.cpp:112
LSET GetLayerSet() const override
Function GetLayerSet returns a "layer mask", which is a bitmap of all layers on which the TRACK segme...
Definition: class_pad.h:402
const wxPoint GetPosition() const override
Definition: class_pad.h:220
unsigned BOARD::GetPadCount ( )

Function GetPadCount.

Returns
the number of pads in board

Definition at line 2987 of file class_board.cpp.

References mod, and Modules().

Referenced by Autoroute_One_Track(), CreatePadsShapesSection(), DRC::doTrackDrc(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), and GetMsgPanelInfo().

2988 {
2989  unsigned retval = 0;
2990 
2991  for( auto mod : Modules() )
2992  retval += mod->Pads().Size();
2993 
2994  return retval;
2995 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:255
#define mod(a, n)
Definition: greymap.cpp:24
D_PAD * BOARD::GetPadFast ( const wxPoint &  aPosition,
LSET  aLayerMask 
)

Function GetPadFast 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
aPositionA wxPoint object containing the position to hit test.
aLayerMaskA layer or layers to mask the hit test.
Returns
A pointer to a D_PAD object if found or NULL if not found.

Definition at line 1704 of file class_board.cpp.

References mod, and Modules().

Referenced by checkConnectedTo(), and PCB_EDIT_FRAME::PlaceDraggedOrMovedTrackSegment().

1705 {
1706  for( auto mod : Modules() )
1707  {
1708  for ( auto pad : mod->Pads() )
1709  {
1710  if( pad->GetPosition() != aPosition )
1711  continue;
1712 
1713  // Pad found, it must be on the correct layer
1714  if( ( pad->GetLayerSet() & aLayerSet ).any() )
1715  return pad;
1716  }
1717  }
1718 
1719  return nullptr;
1720 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:255
#define mod(a, n)
Definition: greymap.cpp:24
const std::vector< D_PAD * > BOARD::GetPads ( )

Function GetPads returns 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
D_PADS - a full list of pads

Definition at line 2973 of file class_board.cpp.

References mod, and Modules().

Referenced by ClearAllNetCodes(), CreatePadsShapesSection(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), DRC::doTrackDrc(), ReplaceNetlist(), SortedNetnamesList(), DRC::testCopperDrawItem(), and DRC::testCopperTextItem().

2974 {
2975  std::vector<D_PAD*> allPads;
2976 
2977  for( MODULE* mod : Modules() )
2978  {
2979  for( D_PAD* pad : mod->Pads() )
2980  allPads.push_back( pad );
2981  }
2982 
2983  return allPads;
2984 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:255
#define mod(a, n)
Definition: greymap.cpp:24
BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 118 of file class_board_item.h.

References EDA_ITEM::m_Parent.

Referenced by Abort_Move_ModuleOutline(), AbortMoveTextModule(), POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), CmpHoleSorting(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), BOARD_ITEM::DeleteStructure(), PCB_BASE_FRAME::DeleteTextModule(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::PCB_PAINTER::draw(), TEXTE_MODULE::DrawUmbilical(), PCB_EDIT_FRAME::duplicateItems(), EditToolSelectionFilter(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), EDGE_MODULE::GetMsgPanelInfo(), EDGE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetShownText(), SELECTION_TOOL::guessSelectionCandidates(), GENERAL_COLLECTOR::Inspect(), EDGE_MODULE::IsParentFlipped(), TEXTE_MODULE::IsParentFlipped(), LEGACY_PLUGIN::loadMODULE_TEXT(), PCB_EDIT_FRAME::moveExact(), FOOTPRINT_EDIT_FRAME::OnRightClick(), FOOTPRINT_EDIT_FRAME::Place_EdgeMod(), PCB_BASE_FRAME::PlaceTexteModule(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotTextModule(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PAD_TOOL::pushPadSettings(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), PCB_BASE_FRAME::ResetTextSize(), PCB_BASE_FRAME::RotateTextModule(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SELECTION_TOOL::select(), ShowCurrentOutlineWhileMoving(), ShowNewEdgeModule(), PCB_BASE_FRAME::StartMoveTexteModule(), SwapItemData(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

118 { return (BOARD_ITEM_CONTAINER*) m_Parent; }
EDA_ITEM * m_Parent
Linked list: Link (parent struct)
Definition: base_struct.h:171
Abstract interface for BOARD_ITEMs capable of storing other items inside.
const PCB_PLOT_PARAMS& BOARD::GetPlotOptions ( ) const
inline

Definition at line 557 of file class_board.h.

Referenced by AddGerberX2Header(), PCB_IO::formatSetup(), and PCB_BASE_FRAME::GetPlotSettings().

557 { return m_plotOptions; }
PCB_PLOT_PARAMS m_plotOptions
Definition: class_board.h:200
const wxPoint BOARD::GetPosition ( ) const
overridevirtual

Implements BOARD_ITEM.

Definition at line 172 of file class_board.cpp.

References BOARD_ITEM::ZeroOffset.

173 {
174  return ZeroOffset;
175 }
static wxPoint ZeroOffset
A value of wxPoint(0,0) which can be passed to the Draw() functions.
wxString BOARD::GetSelectMenuText ( EDA_UNITS_T  aUnits) const
overridevirtual

Function GetSelectMenuText returns 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 1022 of file class_board.cpp.

References Format().

1023 {
1024  return wxString::Format( _( "PCB" ) );
1025 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void BOARD::GetSortedPadListByXthenYCoord ( std::vector< D_PAD * > &  aVector,
int  aNetCode = -1 
)

Function GetSortedPadListByXthenYCoord 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
aVectorWhere 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 1830 of file class_board.cpp.

References mod, Modules(), and sortPadsByXthenYCoord().

Referenced by DRC::testPad2Pad().

1831 {
1832  for ( auto mod : Modules() )
1833  {
1834  for ( auto pad : mod->Pads( ) )
1835  {
1836  if( aNetCode < 0 || pad->GetNetCode() == aNetCode )
1837  {
1838  aVector.push_back( pad );
1839  }
1840  }
1841  }
1842 
1843  std::sort( aVector.begin(), aVector.end(), sortPadsByXthenYCoord );
1844 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:255
bool sortPadsByXthenYCoord(D_PAD *const &ref, D_PAD *const &comp)
Function SortPadsByXCoord is used by GetSortedPadListByXCoord to Sort a pad list by x coordinate valu...
#define mod(a, n)
Definition: greymap.cpp:24
static wxString BOARD::GetStandardLayerName ( PCB_LAYER_ID  aLayerId)
inlinestatic

Function GetStandardLayerName returns 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
aLayerIdis the layer identifier (index) to fetch
Returns
const wxString - containing the layer name or "BAD INDEX" if aLayerId is not legal

Definition at line 659 of file class_board.h.

References LSET::Name().

Referenced by BOARD(), DIALOG_EXPORT_SVG::ExportSVGFile(), PCB_IO::formatLayer(), PCB_IO::formatLayers(), GetLayerID(), BOARD_ITEM::GetLayerName(), GetLayerName(), PARAM_CFG_LAYERS::ReadParam(), and PARAM_CFG_LAYERS::SaveParam().

660  {
661  // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
662  return LSET::Name( aLayerId );
663  }
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Function Name returns the fixed name association with aLayerId.
Definition: lset.cpp:73
STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 253 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format(), and GERBER_DRAW_ITEM::HitTest().

253 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:164
timestamp_t EDA_ITEM::GetTimeStamp ( ) const
inlineinherited

Definition at line 207 of file base_struct.h.

References EDA_ITEM::m_TimeStamp.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), SCH_COMPONENT::AddSheetPathReferenceEntryIfMissing(), SCH_EDIT_FRAME::AnnotateComponents(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), PCB_EDIT_FRAME::Delete_OldZone_Fill(), PCB_EDIT_FRAME::Delete_Zone_Contour(), DuplicateStruct(), DIALOG_FOOTPRINT_BOARD_EDITOR::EditFootprint(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Exchange_Module(), PCB_IO::format(), FormatProbeItem(), NETLIST_OBJECT::GetShortNetName(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), NETLIST_EXPORTER_GENERIC::makeComponents(), mapExistingAnnotation(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), SCH_SHEET_PATH::Path(), PCB_BASE_FRAME::PcbGeneralLocateAndDisplay(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), SCH_LEGACY_PLUGIN::saveComponent(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_REFERENCE::SCH_REFERENCE(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), SortByTimeStamp(), SwapItemData(), DIALOG_SCH_SHEET_PROPS::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::~DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS().

207 { return m_TimeStamp; }
timestamp_t m_TimeStamp
Time stamp used for logical links.
Definition: base_struct.h:172
TITLE_BLOCK& BOARD::GetTitleBlock ( )
inline

Definition at line 560 of file class_board.h.

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

560 { return m_titles; }
TITLE_BLOCK m_titles
text in lower right of screen and plots
Definition: class_board.h:199
std::list< TRACK * > BOARD::GetTracksByPosition ( const wxPoint &  aPosition,
PCB_LAYER_ID  aLayer = PCB_LAYER_ID( -1 ) 
) const

Function GetTracksByPosition finds the list of tracks that starts or ends at aPosition on aLayer.

Parameters
aPositionThe wxPoint to check start agains against.
aLayerThe layer to search. Use -1 (<PCB_LAYER_ID>UNDEFINED_LAYER) for a don't care.
Returns
std::list<TRACK*> A list of TRACK* items that can be zero if no track is found.

Definition at line 1687 of file class_board.cpp.

References BUSY, GetFirstTrack(), IS_DELETED, m_Track, and UNDEFINED_LAYER.

Referenced by SELECTION_TOOL::selectAllItemsOnSheet().

1688 {
1689  std::list<TRACK*> tracks;
1690 
1691  for( TRACK* track = GetFirstTrack( m_Track ); track; track = GetFirstTrack( track->Next() ) )
1692  {
1693  if( ( ( track->GetStart() == aPosition ) || track->GetEnd() == aPosition ) &&
1694  ( track->GetState( BUSY | IS_DELETED ) == 0 ) &&
1695  ( ( aLayer == UNDEFINED_LAYER ) || ( track->IsOnLayer( aLayer ) ) ) )
1696 
1697  tracks.push_back( track );
1698  }
1699 
1700  return tracks;
1701 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:135
#define IS_DELETED
Definition: base_struct.h:117
DLIST< TRACK > m_Track
Definition: class_board.h:250
TRACK * GetFirstTrack(TRACK *aTrk, const TRACK *aStopPoint=NULL)
Scan a track list for the first TRACK object. Returns NULL if not found (or NULL passed) ...
Definition: class_track.h:528
int BOARD_ITEM::getTrailingInt ( const wxString &  aStr)
staticprotectedinherited

Definition at line 98 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName(), and MODULE::IncrementReference().

99 {
100  int number = 0;
101  int base = 1;
102 
103  // Trim and extract the trailing numeric part
104  int index = aStr.Len() - 1;
105  while( index >= 0 )
106  {
107  const char chr = aStr.GetChar( index );
108 
109  if( chr < '0' || chr > '9' )
110  break;
111 
112  number += ( chr - '0' ) * base;
113  base *= 10;
114  index--;
115  }
116 
117  return number;
118 }
unsigned BOARD::GetUnconnectedNetCount ( ) const

Function GetUnconnectedNetCount.

Returns
the number of unconnected nets in the current ratsnest.

Definition at line 1115 of file class_board.cpp.

References m_connectivity.

1116 {
1117  return m_connectivity->GetUnconnectedCount();
1118 }
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:193
VIA * BOARD::GetViaByPosition ( const wxPoint &  aPosition,
PCB_LAYER_ID  aLayer = PCB_LAYER_ID( -1 ) 
) const

Function GetViaByPosition finds the first via at aPosition on aLayer.

This function does not use the normal hit test to locate a via which which tests if a position is within the via's bounding box. It tests for the actual locate of the via.

Parameters
aPositionThe wxPoint to HitTest() against.
aLayerThe layer to search. Use -1 (PCB_LAYER_ID::UNDEFINED_LAYER) for a don't care.
Returns
VIA* A point a to the VIA object if found, else NULL.

Definition at line 1643 of file class_board.cpp.

References BUSY, GetFirstVia(), IS_DELETED, m_Track, and UNDEFINED_LAYER.

1644 {
1645  for( VIA *via = GetFirstVia( m_Track); via; via = GetFirstVia( via->Next() ) )
1646  {
1647  if( (via->GetStart() == aPosition) &&
1648  (via->GetState( BUSY | IS_DELETED ) == 0) &&
1649  ((aLayer == UNDEFINED_LAYER) || (via->IsOnLayer( aLayer ))) )
1650  return via;
1651  }
1652 
1653  return NULL;
1654 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:135
#define IS_DELETED
Definition: base_struct.h:117
DLIST< TRACK > m_Track
Definition: class_board.h:250
VIA * GetFirstVia(TRACK *aTrk, const TRACK *aStopPoint=NULL)
Scan a track list for the first VIA o NULL if not found (or NULL passed)
Definition: class_track.h:514
int BOARD::GetVisibleElements ( ) const

Function GetVisibleElements is a proxy function that calls the correspondent function in m_BoardSettings returns a bit-mask of all the element categories that are visible.

Returns
int - the visible element bitmap or-ed from enum GAL_LAYER_ID
See also
enum GAL_LAYER_ID

Definition at line 792 of file class_board.cpp.

References BOARD_DESIGN_SETTINGS::GetVisibleElements(), and m_designSettings.

793 {
795 }
int GetVisibleElements() const
Function GetVisibleElements returns a bit-mask of all the element categories that are visible...
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
LSET BOARD::GetVisibleLayers ( ) const

Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSettings Returns a bit-mask of all the layers that are visible.

Returns
int - the visible layers in bit-mapped form.

Definition at line 750 of file class_board.cpp.

References BOARD_DESIGN_SETTINGS::GetVisibleLayers(), and m_designSettings.

Referenced by ZONE_CONTAINER::Draw(), VIA::Draw(), D_PAD::Draw(), PCB_IO::formatBoardLayers(), PCB_BASE_FRAME::GetCollectorsGuide(), PCB_LAYER_WIDGET::OnLayerVisible(), SELECTION_TOOL::selectable(), VIA::ViewGetLOD(), and D_PAD::ViewGetLOD().

751 {
753 }
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
LSET GetVisibleLayers() const
Function GetVisibleLayers returns a bit-mask of all the layers that are visible.
TRACK * BOARD::GetVisibleTrack ( TRACK aStartingTrace,
const wxPoint &  aPosition,
LSET  aLayerSet 
) const

Function GetVisibleTrack finds the neighboring visible segment of aTrace at aPosition that is on a layer in aLayerSet.

Traces that are flagged as deleted or busy are ignored.

Parameters
aStartingTraceis the first TRACK to test, testing continues to end of m_Track list from this starting point.
aPositionA wxPoint object containing the position to test.
aLayerSetA set of layers; returned TRACK must be on one of these. May pass a full set to request any layer.
Returns
A TRACK object pointer if found otherwise NULL.

Definition at line 1854 of file class_board.cpp.

References BUSY, BOARD_ITEM::GetLayer(), IS_DELETED, BOARD_DESIGN_SETTINGS::IsLayerVisible(), m_designSettings, TRACK::Next(), and PCB_VIA_T.

Referenced by GetLockPoint(), and Magnetize().

1856 {
1857  for( TRACK* track = aStartingTrace; track; track = track->Next() )
1858  {
1859  PCB_LAYER_ID layer = track->GetLayer();
1860 
1861  if( track->GetState( BUSY | IS_DELETED ) )
1862  continue;
1863 
1864  // track's layer is not visible
1865  if( m_designSettings.IsLayerVisible( layer ) == false )
1866  continue;
1867 
1868  if( track->Type() == PCB_VIA_T ) // VIA encountered.
1869  {
1870  if( track->HitTest( aPosition ) )
1871  return track;
1872  }
1873  else
1874  {
1875  if( !aLayerSet[layer] )
1876  continue; // track's layer is not in aLayerSet
1877 
1878  if( track->HitTest( aPosition ) )
1879  return track;
1880  }
1881  }
1882 
1883  return NULL;
1884 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:135
bool IsLayerVisible(PCB_LAYER_ID aLayerId) const
Function IsLayerVisible tests whether a given layer is visible.
PCB_LAYER_ID
A quick note on layer IDs:
#define IS_DELETED
Definition: base_struct.h:117
TRACK * Next() const
Definition: class_track.h:103
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
const ZONE_SETTINGS& BOARD::GetZoneSettings ( ) const
inline
void BOARD::HighLightOFF ( )
inline

Function HighLightOFF Disable highlight.

Definition at line 394 of file class_board.h.

References HIGH_LIGHT_INFO::m_highLightOn.

Referenced by Abort_MoveTrack(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), and PCB_EDIT_FRAME::HighLight().

394 { m_highLight.m_highLightOn = false; }
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:188
void BOARD::HighLightON ( )
inline

Function HighLightON Enable highlight.

if m_highLight_NetCode >= 0, this net will be highlighted

Definition at line 401 of file class_board.h.

References HIGH_LIGHT_INFO::m_highLightOn.

Referenced by PCB_EDIT_FRAME::Begin_Route(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::HighLight(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), and PCB_EDIT_FRAME::StartMoveOneNodeOrSegment().

401 { m_highLight.m_highLightOn = true; }
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:188
virtual bool BOARD_ITEM::HitTest ( const wxPoint &  aPosition) const
inlineoverridevirtualinherited

Function HitTest tests if aPosition is contained within or on the bounding area of an item.

Parameters
aPositionA reference to a wxPoint object containing the coordinates to test.
Returns
True if aPosition is within or on the item bounding area.

Reimplemented from EDA_ITEM.

Reimplemented in D_PAD, MODULE, VIA, ZONE_CONTAINER, DIMENSION, TRACK, DRAWSEGMENT, TEXTE_MODULE, MARKER_PCB, PCB_TARGET, and TEXTE_PCB.

Definition at line 290 of file class_board_item.h.

References EDA_ITEM::HitTest().

Referenced by GENERAL_COLLECTOR::Inspect(), and SELECTION_TOOL::selectMultiple().

291  {
292  return EDA_ITEM::HitTest( aPosition );
293  }
virtual bool HitTest(const wxPoint &aPosition) const
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
Definition: base_struct.h:308
virtual bool BOARD_ITEM::HitTest ( const EDA_RECT aRect,
bool  aContained = true,
int  aAccuracy = 0 
) const
inlinevirtualinherited

Function HitTest tests if the aRect intersects or contains this object (depending on aContained).

Parameters
aRectA reference to an EDA_RECT object containg the area to test.
aContainedTest if aRect contains this object completly.
aAccuracyIncrease the item bounding box by this amount.
Returns
bool - True if aRect contains this object completly or if aRect intersects the object and aContained is False, otherwise false.

Reimplemented in D_PAD, MODULE, VIA, ZONE_CONTAINER, DIMENSION, TRACK, DRAWSEGMENT, TEXTE_MODULE, PCB_TARGET, and TEXTE_PCB.

Definition at line 305 of file class_board_item.h.

References BOARD_ITEM::TransformShapeWithClearanceToPolygon(), and BOARD_ITEM::ViewGetLayers().

306  {
307  return false; // derived classes should override this function
308  }
ZONE_CONTAINER * BOARD::HitTestForAnyFilledArea ( const wxPoint &  aRefPos,
PCB_LAYER_ID  aStartLayer,
PCB_LAYER_ID  aEndLayer,
int  aNetCode 
)

Function HitTestForAnyFilledArea tests if the given wxPoint is within the bounds of a filled area of this zone.

the test is made on zones on layer from aStartLayer to aEndLayer Note: if a zone has its flag BUSY (in .m_State) is set, it is ignored.

Parameters
aRefPosA wxPoint to test
aStartLayerthe first layer to test
aEndLayerthe last layer to test
aNetCode= the netcode used to filter zones (-1 to to test all zones)
Returns
ZONE_CONTAINER* return a pointer to the ZONE_CONTAINER found, else NULL

Definition at line 1578 of file class_board.cpp.

References BUSY, and m_ZoneDescriptorList.

Referenced by PCB_EDIT_FRAME::Begin_Route().

1580 {
1581  if( aEndLayer < 0 )
1582  aEndLayer = aStartLayer;
1583 
1584  if( aEndLayer < aStartLayer )
1585  std::swap( aEndLayer, aStartLayer );
1586 
1587  for( ZONE_CONTAINER* area : m_ZoneDescriptorList )
1588  {
1589  if( area->GetLayer() < aStartLayer || area->GetLayer() > aEndLayer )
1590  continue;
1591 
1592  // In locate functions we must skip tagged items with BUSY flag set.
1593  if( area->GetState( BUSY ) )
1594  continue;
1595 
1596  if( aNetCode >= 0 && area->GetNetCode() != aNetCode )
1597  continue;
1598 
1599  if( area->HitTestFilledArea( aRefPos ) )
1600  return area;
1601  }
1602 
1603  return NULL;
1604 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:135
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
ZONE_CONTAINER * BOARD::InsertArea ( int  aNetcode,
int  aAreaIdx,
PCB_LAYER_ID  aLayer,
int  aCornerX,
int  aCornerY,
int  aHatch 
)

Add a copper area to net, inserting after m_ZoneDescriptorList[aAreaIdx].

Parameters
aNetcodeis the netcode of the new copper zone
aAreaIdxis the netcode of the new copper zone
aLayeris the copper layer id of the new copper zone
aCornerX,aCornerYis the coordinate of the first corner (a zone cannot have a empty outline)
aHatchis the hatch option
Returns
pointer to the new area

Definition at line 2394 of file class_board.cpp.

References ZONE_CONTAINER::AppendCorner(), GetNewTimeStamp(), m_ZoneDescriptorList, ZONE_CONTAINER::SetHatchStyle(), ZONE_CONTAINER::SetLayer(), BOARD_CONNECTED_ITEM::SetNetCode(), and EDA_ITEM::SetTimeStamp().

Referenced by AddArea().

2396 {
2397  ZONE_CONTAINER* new_area = new ZONE_CONTAINER( this );
2398 
2399  new_area->SetNetCode( aNetcode );
2400  new_area->SetLayer( aLayer );
2401  new_area->SetTimeStamp( GetNewTimeStamp() );
2402 
2403  if( aAreaIdx < (int) ( m_ZoneDescriptorList.size() - 1 ) )
2404  m_ZoneDescriptorList.insert( m_ZoneDescriptorList.begin() + aAreaIdx + 1, new_area );
2405  else
2406  m_ZoneDescriptorList.push_back( new_area );
2407 
2408  new_area->SetHatchStyle( (ZONE_CONTAINER::HATCH_STYLE) aHatch );
2409 
2410  // Add the first corner to the new zone
2411  new_area->AppendCorner( wxPoint( aCornerX, aCornerY ), -1 );
2412 
2413  return new_area;
2414 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:59
timestamp_t GetNewTimeStamp()
Definition: common.cpp:212
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Function SetLayer sets the layer this item is on.
Definition: class_zone.cpp:202
bool SetNetCode(int aNetCode, bool aNoAssert=false)
Function SetNetCode sets net using a net code.
HATCH_STYLE
Zone hatch styles.
Definition: class_zone.h:66
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:183
void SetHatchStyle(HATCH_STYLE aStyle)
Definition: class_zone.h:531
bool AppendCorner(wxPoint aPosition, int aHoleIdx, bool aAllowDuplication=false)
Add a new corner to the zone outline (to the main outline or a hole)
void SetTimeStamp(timestamp_t aNewTimeStamp)
Definition: base_struct.h:206
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 227 of file base_struct.h.

References BRIGHTENED.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::GERBVIEW_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

227 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:138
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
virtual bool BOARD_ITEM::IsConnected ( ) const
inlinevirtualinherited

Function IsConnected() Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented in BOARD_CONNECTED_ITEM.

Definition at line 106 of file class_board_item.h.

Referenced by CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), and CONNECTIVITY_DATA::MarkItemNetAsDirty().

107  {
108  return false;
109  }
bool EDA_ITEM::IsDragging ( ) const
inlineinherited
bool BOARD::IsElementVisible ( GAL_LAYER_ID  aLayer) const

Function IsElementVisible tests whether a given element category is visible.

Keep this as an inline function.

Parameters
aLayeris from the enum by the same name
Returns
bool - true if the element is visible.
See also
enum GAL_LAYER_ID

Definition at line 798 of file class_board.cpp.

References BOARD_DESIGN_SETTINGS::IsElementVisible(), and m_designSettings.

Referenced by Abort_MoveOrCopyModule(), TEXTE_PCB::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), MODULE::Draw(), VIA::Draw(), D_PAD::Draw(), PCB_BASE_FRAME::GetCollectorsGuide(), FOOTPRINT_EDIT_FRAME::IsElementVisible(), PCB_EDIT_FRAME::IsElementVisible(), IsModuleLayerVisible(), DIALOG_EXCHANGE_FOOTPRINTS::OnApplyClicked(), PCB_EDIT_FRAME::OnPlaceOrRouteFootprints(), PCB_LAYER_WIDGET::OnRenderEnable(), PCB_LAYER_WIDGET::ReFillRender(), SELECTION_TOOL::selectable(), SetElementVisibility(), showLocalRatsnest(), and PCB_DRAW_PANEL_GAL::SyncLayersVisibility().

799 {
800  return m_designSettings.IsElementVisible( aLayer );
801 }
bool IsElementVisible(GAL_LAYER_ID aElementCategory) const
Function IsElementVisible tests whether a given element category is visible.
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
bool BOARD::IsEmpty ( ) const
inline

Definition at line 273 of file class_board.h.

References DHEAD::GetCount().

Referenced by BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition(), DIALOG_NETLIST::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), and ReplaceNetlist().

274  {
275  return m_Drawings.GetCount() == 0 && m_Modules.GetCount() == 0 &&
276  m_Track.GetCount() == 0 && m_SegZoneDeprecated.GetCount() == 0;
277  }
DLIST< SEGZONE > m_SegZoneDeprecated
Definition: class_board.h:251
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:245
DLIST< MODULE > m_Modules
Definition: class_board.h:249
unsigned GetCount() const
Function GetCount returns the number of elements in the list.
Definition: dlist.h:126
DLIST< TRACK > m_Track
Definition: class_board.h:250
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 226 of file base_struct.h.

References HIGHLIGHTED.

Referenced by KIGFX::SCH_PAINTER::draw(), and KIGFX::getOverlayColor().

226 { return m_Flags & HIGHLIGHTED; }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:137
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool BOARD::IsHighLightNetON ( ) const
inline

Function IsHighLightNetON.

Returns
true if a net is currently highlighted

Definition at line 388 of file class_board.h.

References HIGH_LIGHT_INFO::m_highLightOn.

Referenced by Abort_Create_Track(), PCB_EDIT_FRAME::End_Route(), DIALOG_SELECT_NET_FROM_LIST::HighlightNet(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), and PCB_EDIT_FRAME::Start_Move_Zone_Outlines().

388 { return m_highLight.m_highLightOn; }
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:188
bool BOARD::IsLayerEnabled ( PCB_LAYER_ID  aLayer) const
inline

Function IsLayerEnabled is 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
bool - true if the layer is visible.

Definition at line 446 of file class_board.h.

References BOARD_DESIGN_SETTINGS::IsLayerEnabled().

Referenced by GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), GetLayerName(), GetLayerType(), PCB_LAYER_SELECTOR::IsLayerEnabled(), PCB_LAYER_BOX_SELECTOR::IsLayerEnabled(), SetLayerName(), and SetLayerType().

447  {
448  return m_designSettings.IsLayerEnabled( aLayer );
449  }
bool IsLayerEnabled(PCB_LAYER_ID aLayerId) const
Function IsLayerEnabled tests whether a given layer is enabled.
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
bool BOARD::IsLayerVisible ( PCB_LAYER_ID  aLayer) const
inline

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

Parameters
aLayer= The layer to be tested
Returns
bool - true if the layer is visible.

Definition at line 458 of file class_board.h.

References PCB_EDIT_FRAME::IsElementVisible(), BOARD_DESIGN_SETTINGS::IsLayerVisible(), PCB_EDIT_FRAME::SetElementVisibility(), and PCB_EDIT_FRAME::SetVisibleAlls().

Referenced by PCB_EDIT_FRAME::Block_SelectItems(), TEXTE_PCB::Draw(), PCB_TARGET::Draw(), EDGE_MODULE::Draw(), ZONE_CONTAINER::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DIMENSION::Draw(), DRAWSEGMENT::Draw(), SEGZONE::Draw(), D_PAD::Draw(), ZONE_CONTAINER::DrawFilledArea(), DRAWING_TOOL::DrawVia(), itemIsIncludedByFilter(), Magnetize(), SELECTION_TOOL::selectable(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and PCB_LAYER_WIDGET::SyncLayerVisibilities().

459  {
460  return m_designSettings.IsLayerVisible( aLayer );
461  }
bool IsLayerVisible(PCB_LAYER_ID aLayerId) const
Function IsLayerVisible tests whether a given layer is visible.
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:195
virtual bool BOARD_ITEM::IsLocked ( ) const
inlinevirtualinherited

Function IsLocked.

Returns
bool - true if the object is locked, else false

Reimplemented in MODULE, and TRACK.

Definition at line 194 of file class_board_item.h.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), EditToolSelectionFilter(), GENERAL_COLLECTOR::Inspect(), PCB_EDITOR_CONTROL::modifyLockSelected(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

195  {
196  // only MODULEs & TRACKs can be locked at this time.
197  return false;
198  }
bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 220 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

220 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:110
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
bool BOARD::IsModuleLayerVisible ( PCB_LAYER_ID  aLayer)

Function IsModuleLayerVisible expects either of the two layers on which a module can reside, and returns whether that layer is visible.

Parameters
aLayerOne of the two allowed layers for modules: F_Cu or B_Cu
Returns
bool - true if the layer is visible, else false.

Definition at line 850 of file class_board.cpp.

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

Referenced by PCB_EDIT_FRAME::Block_SelectItems(), and GetFootprint().

851 {
852  switch( aLayer )
853  {
854  case F_Cu:
855  return IsElementVisible( LAYER_MOD_FR );
856 
857  case B_Cu:
858  return IsElementVisible( LAYER_MOD_BK );
859 
860  default:
861  wxFAIL_MSG( wxT( "BOARD::IsModuleLayerVisible() param error: bad layer" ) );
862  return true;
863  }
864 }
show modules on back
show modules on front
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Function IsElementVisible tests whether a given element category is visible.
bool EDA_ITEM::IsNew ( ) const
inlineinherited

Definition at line 219 of file base_struct.h.

References IS_NEW.

Referenced by Abort_Edit_Pcb_Text(), Abort_EditEdge(), Abort_Move_ModuleOutline(), Abort_MoveOrCopyModule(), Abort_Zone_Create_Outline(), AbortBuildDimension(), AbortMoveAndEditTarget(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToScreen(), SCH_EDIT_FRAME::addJunctionMenuEntries(), AddMenusForBus(), AddMenusForWire(), PCB_EDIT_FRAME::Delete_Segment(), PCB_EDIT_FRAME::Delete_Segment_Edge(), SCH_EDIT_FRAME::DeleteCurrentSegment(), LIB_ARC::drawEditGraphics(), LIB_ARC::drawGraphic(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), EDIT_TOOL::MoveExact(), SCH_EDIT_FRAME::OnAutoplaceFields(), SCH_EDIT_FRAME::OnConvertTextType(), LIB_EDIT_FRAME::OnEditPin(), SCH_EDIT_FRAME::OnHotKey(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), FOOTPRINT_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnRightClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_EDIT_FRAME::OnRotate(), PCB_EDIT_FRAME::Place_Texte_Pcb(), PCB_BASE_FRAME::PlaceModule(), LIB_EDIT_FRAME::PlacePin(), PCB_EDIT_FRAME::PlaceTarget(), SCH_EDIT_FRAME::PrepareMoveItem(), SCH_EDIT_FRAME::ReSizeSheet(), ShowClearance(), PCB_EDIT_FRAME::StartMoveTextePcb(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_SCH_EDIT_SHEET_PIN::TransferDataFromWindow(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

219 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:114
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID  aLayer) const
inlinevirtualinherited

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can do their own form of testing.

Parameters
aLayerThe layer to test for.
Returns
bool - true if on given layer, else false.

Reimplemented in D_PAD, VIA, ZONE_CONTAINER, and MARKER_PCB.

Definition at line 174 of file class_board_item.h.

Referenced by VIA::ClassOf(), CINFO3D_VISU::createLayers(), TEXTE_PCB::Draw(), EDGE_MODULE::Draw(), TEXTE_MODULE::Draw(), DRAWSEGMENT::Draw(), GENERAL_COLLECTOR::Inspect(), ZONE_CONTAINER::IsOnLayer(), AR_MATRIX::TraceSegmentPcb(), and TraceSegmentPcb().

175  {
176  return m_Layer == aLayer;
177  }
PCB_LAYER_ID m_Layer
virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

Function IsReplaceable.

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

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

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

Definition at line 464 of file base_struct.h.

References EDA_ITEM::operator<().

Referenced by EDA_ITEM::Matches(), and EDA_ITEM::Replace().

464 { return false; }
bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 225 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

225 { return m_Flags & IS_RESIZED; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
#define IS_RESIZED
Item being resized.
Definition: base_struct.h:115
bool EDA_ITEM::IsSelected ( ) const
inlineinherited
bool BOARD_ITEM::IsTrack ( ) const
inlineinherited

Function IsTrack tests to see if this object is a track or via (or microvia).

form of testing.

Returns
bool - true if a track or via, else false.

Definition at line 185 of file class_board_item.h.

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

Referenced by PCB_EDIT_FRAME::OnHotKey(), and PCB_EDIT_FRAME::OnHotkeyDeleteItem().

186  {
187  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
188  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
bool EDA_ITEM::IsType ( const KICAD_T  aScanTypes[])
inlineinherited

Function IsType Checks whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Definition at line 266 of file base_struct.h.

References EOT.

267  {
268  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
269  {
270  if( m_StructType == *p )
271  return true;
272  }
273 
274  return false;
275  }
KICAD_T m_StructType
Run time identification, keep private so it can never be changed after a constructor sets it...
Definition: base_struct.h:163
search types array terminator (End Of Types)
Definition: typeinfo.h:82
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 223 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by SCH_FIELD::Draw().

223 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:118
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
SEARCH_RESULT EDA_ITEM::IterateForward ( EDA_ITEM listStart,
INSPECTOR  inspector,
void *  testData,
const KICAD_T  scanTypes[] 
)
staticinherited

Function IterateForward walks through the object tree calling the inspector() on each object type requested in scanTypes.

Parameters
listStartThe first in a list of EDA_ITEMs to iterate over.
inspectorIs an INSPECTOR to call on each object that is one of the requested scanTypes.
testDataIs an aid to testFunc, and should be sufficient to allow it to fully determine if an item meets the match criteria, but it may also be used to collect output.
scanTypesA KICAD_T array that is EOT terminated, and provides both the order and interest level of of the types of objects to be iterated over.
Returns
SEARCH_RESULT SEARCH_QUIT if the called INSPECTOR returned SEARCH_QUIT, else SCAN_CONTINUE;

Definition at line 130 of file base_struct.cpp.

References EDA_ITEM::Pnext, SEARCH_CONTINUE, SEARCH_QUIT, and EDA_ITEM::Visit().

Referenced by SCH_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::Collect(), SCH_TYPE_COLLECTOR::Collect(), SCH_FIND_COLLECTOR::GetItem(), EDA_ITEM::HitTest(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and Visit().

134 {
135  EDA_ITEM* p = listStart;
136 
137  for( ; p; p = p->Pnext )
138  {
139  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
140  return SEARCH_QUIT;
141  }
142 
143  return SEARCH_CONTINUE;
144 }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:167
TRACK * BOARD::MarkTrace ( TRACK aTrackList,
TRACK aTrace,
int *  aCount,
double *  aTraceLength,
double *  aInPackageLength,
bool  aReorder 
)

Function MarkTrace marks a chain of trace segments, connected to aTrace.

Each segment is marked by setting the BUSY bit into m_Flags. Electrical continuity is detected by walking each segment, and finally the segments are rearranged into a contiguous chain within the given list.

Parameters
aTrackListThe list of available track segments. usually tracks on board, but can be a list of segments currently created.
aTraceThe segment within a list of trace segments to test.
aCountA pointer to an integer where to return the number of marked segments (can be NULL).
aTraceLengthA pointer to an double where to return the length of the trace (can be NULL).
aInPackageLengthA pointer to an double where to return the extra lengths inside integrated circuits from the pads connected to this track to the die (if any) (can be NULL).
aReordertrue for reorder the interesting segments (useful for track editing/deleting) in this case the flag BUSY is set (the user is responsible of flag clearing). False for no reorder : useful when we want just calculate the track length in this case, flags are reset
Returns
TRACK* - The first in the chain of interesting segments.

Definition at line 1887 of file class_board.cpp.

References BUSY, chainMarkedSegments(), dist, TRACK::GetEnd(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetLayerSet(), VIA::GetLayerSet(), EDA_ITEM::GetList(), GetPad(), D_PAD::GetPadToDieLength(), D_PAD::GetPosition(), TRACK::GetStart(), EDA_ITEM::GetState(), GetTrack(), i, TRACK::Next(), next(), PCB_VIA_T, EDA_ITEM::SetState(), EDA_ITEM::Type(), and BOARD_ITEM::UnLink().

Referenced by PCB_EDIT_FRAME::Attribut_Track(), PCB_EDIT_FRAME::Edit_Track_Width(), PCB_EDIT_FRAME::EraseRedundantTrack(), TRACK::GetMsgPanelInfo(), PCB_EDIT_FRAME::Remove_One_Track(), and SELECTION_TOOL::selectAllItemsConnectedToTrack().

1890 {
1891  TRACKS trackList;
1892 
1893  if( aCount )
1894  *aCount = 0;
1895 
1896  if( aTraceLength )
1897  *aTraceLength = 0;
1898 
1899  if( aTrace == NULL )
1900  return NULL;
1901 
1902  // Ensure the flag BUSY of all tracks of the board is cleared
1903  // because we use it to mark segments of the track
1904  for( TRACK* track = aTrackList; track; track = track->Next() )
1905  track->SetState( BUSY, false );
1906 
1907  // Set flags of the initial track segment
1908  aTrace->SetState( BUSY, true );
1909  LSET layer_set = aTrace->GetLayerSet();
1910 
1911  trackList.push_back( aTrace );
1912 
1913  /* Examine the initial track segment : if it is really a segment, this is
1914  * easy.
1915  * If it is a via, one must search for connected segments.
1916  * If <=2, this via connect 2 segments (or is connected to only one
1917  * segment) and this via and these 2 segments are a part of a track.
1918  * If > 2 only this via is flagged (the track has only this via)
1919  */
1920  if( aTrace->Type() == PCB_VIA_T )
1921  {
1922  TRACK* segm1 = ::GetTrack( aTrackList, NULL, aTrace->GetStart(), layer_set );
1923  TRACK* segm2 = NULL;
1924  TRACK* segm3 = NULL;
1925 
1926  if( segm1 )
1927  {
1928  segm2 = ::GetTrack( segm1->Next(), NULL, aTrace->GetStart(), layer_set );
1929  }
1930 
1931  if( segm2 )
1932  {
1933  segm3 = ::GetTrack( segm2->Next(), NULL, aTrace->GetStart(), layer_set );
1934  }
1935 
1936  if( segm3 )
1937  {
1938  // More than 2 segments are connected to this via.
1939  // The "track" is only this via.
1940 
1941  if( aCount )
1942  *aCount = 1;
1943 
1944  return aTrace;
1945  }
1946 
1947  if( segm1 ) // search for other segments connected to the initial segment start point
1948  {
1949  layer_set = segm1->GetLayerSet();
1950  chainMarkedSegments( aTrackList, aTrace->GetStart(), layer_set, &trackList );
1951  }
1952 
1953  if( segm2 ) // search for other segments connected to the initial segment end point
1954  {
1955  layer_set = segm2->GetLayerSet();
1956  chainMarkedSegments( aTrackList, aTrace->GetStart(), layer_set, &trackList );
1957  }
1958  }
1959  else // mark the chain using both ends of the initial segment
1960  {
1961  TRACKS from_start;
1962  TRACKS from_end;
1963 
1964  chainMarkedSegments( aTrackList, aTrace->GetStart(), layer_set, &from_start );
1965  chainMarkedSegments( aTrackList, aTrace->GetEnd(), layer_set, &from_end );
1966 
1967  // combine into one trackList:
1968  trackList.insert( trackList.end(), from_start.begin(), from_start.end() );
1969  trackList.insert( trackList.end(), from_end.begin(), from_end.end() );
1970  }
1971 
1972  // Now examine selected vias and flag them if they are on the track
1973  // If a via is connected to only one or 2 segments, it is flagged (is on the track)
1974  // If a via is connected to more than 2 segments, it is a track end, and it
1975  // is removed from the list.
1976  // Go through the list backwards.
1977  for( int i = trackList.size() - 1; i>=0; --i )
1978  {
1979  ::VIA* via = dynamic_cast< ::VIA* >( trackList[i] );
1980 
1981  if( !via )
1982  continue;
1983 
1984  if( via == aTrace )
1985  continue;
1986 
1987  via->SetState( BUSY, true ); // Try to flag it. the flag will be cleared later if needed
1988 
1989  layer_set = via->GetLayerSet();
1990 
1991  TRACK* track = ::GetTrack( aTrackList, NULL, via->GetStart(), layer_set );
1992 
1993  // GetTrace does not consider tracks flagged BUSY.
1994  // So if no connected track found, this via is on the current track
1995  // only: keep it
1996  if( track == NULL )
1997  continue;
1998 
1999  /* If a track is found, this via connects also other segments of
2000  * the other track. This case happens when a via ends the selected
2001  * track but must we consider this via is on the selected track, or
2002  * on a other track.
2003  * (this is important when selecting a track for deletion: must this
2004  * via be deleted or not?)
2005  * We consider this via to be on our track if other segments connected
2006  * to this via remain connected when removing this via.
2007  * We search for all other segments connected together:
2008  * if they are on the same layer, then the via is on the selected track;
2009  * if they are on different layers, the via is on a other track.
2010  */
2011  LAYER_NUM layer = track->GetLayer();
2012 
2013  while( ( track = ::GetTrack( track->Next(), NULL, via->GetStart(), layer_set ) ) != NULL )
2014  {
2015  if( layer != track->GetLayer() )
2016  {
2017  // The via connects segments of a other track: it is removed
2018  // from list because it is member of a other track
2019  via->SetState( BUSY, false );
2020  break;
2021  }
2022  }
2023  }
2024 
2025  /* Rearrange the track list in order to have flagged segments linked
2026  * from firstTrack so the NbSegmBusy segments are consecutive segments
2027  * in list, the first item in the full track list is firstTrack, and
2028  * the NbSegmBusy-1 next items (NbSegmBusy when including firstTrack)
2029  * are the flagged segments
2030  */
2031  int busy_count = 0;
2032  TRACK* firstTrack;
2033 
2034  for( firstTrack = aTrackList; firstTrack; firstTrack = firstTrack->Next() )
2035  {
2036  // Search for the first flagged BUSY segments
2037  if( firstTrack->GetState( BUSY ) )
2038  {
2039  busy_count = 1;
2040  break;
2041  }
2042  }
2043 
2044  if( firstTrack == NULL )
2045  return NULL;
2046 
2047  // First step: calculate the track length and find the pads (when exist)
2048  // at each end of the trace.
2049  double full_len = 0;
2050  double lenPadToDie = 0;
2051  // Because we have a track (a set of track segments between 2 nodes),
2052  // only 2 pads (maximum) will be taken in account:
2053  // that are on each end of the track, if any.
2054  // keep trace of them, to know the die length and the track length ibside each pad.
2055  D_PAD* s_pad = NULL; // the pad on one end of the trace
2056  D_PAD* e_pad = NULL; // the pad on the other end of the trace
2057  int dist_fromstart = INT_MAX;
2058  int dist_fromend = INT_MAX;
2059 
2060  for( TRACK* track = firstTrack; track; track = track->Next() )
2061  {
2062  if( !track->GetState( BUSY ) )
2063  continue;
2064 
2065  layer_set = track->GetLayerSet();
2066  D_PAD * pad_on_start = GetPad( track->GetStart(), layer_set );
2067  D_PAD * pad_on_end = GetPad( track->GetEnd(), layer_set );
2068 
2069  // a segment fully inside a pad does not contribute to the track len
2070  // (another track end inside this pad will contribute to this lenght)
2071  if( pad_on_start && ( pad_on_start == pad_on_end ) )
2072  continue;
2073 
2074  full_len += track->GetLength();
2075 
2076  if( pad_on_start == NULL && pad_on_end == NULL )
2077  // This most of time the case
2078  continue;
2079 
2080  // At this point, we can have one track end on a pad, or the 2 track ends on
2081