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 ()
 
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_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 wxPointGetAuxOrigin () const
 
void SetGridOrigin (const wxPoint &aPoint)
 Function SetGridOrigin sets the origin point of the grid. More...
 
const wxPointGetGridOrigin () 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)
 
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=NULL)
 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 () const
 Function GetNodesCount. More...
 
unsigned GetUnconnectedNetCount () const
 Function GetUnconnectedNetCount. More...
 
unsigned GetPadCount () const
 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 (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=NULL)
 Function ReplaceNetlist updates the BOARD according to aNetlist. More...
 
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 *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...
 
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) const
 
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
 
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 wxString GetSelectMenuText () const
 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...
 
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 std::string FormatInternalUnits (int aValue)
 Function FormatInternalUnits converts aValue from board internal units to a string appropriate for writing to file. More...
 
static std::string FormatInternalUnits (const wxPoint &aPoint)
 
static std::string FormatInternalUnits (const wxSize &aSize)
 
static std::string FormatAngle (double aAngle)
 Function FormatAngle converts aAngle from board units to a string appropriate for writing to file. 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_Zone
 
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 (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 169 of file class_board.h.

Constructor & Destructor Documentation

BOARD::BOARD ( const BOARD aOther)
inlineprivate

Definition at line 214 of file class_board.h.

214  :
215  BOARD_ITEM_CONTAINER( aOther ), m_NetInfo( this )
216  {
217  assert( false );
218  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
BOARD_ITEM_CONTAINER(BOARD_ITEM *aParent, KICAD_T aType)
BOARD::BOARD ( )

Definition at line 76 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().

76  :
78  m_paper( PAGE_INFO::A4 ), m_NetInfo( this )
79 {
80  // we have not loaded a board yet, assume latest until then.
81  m_fileFormatVersionAtLoad = LEGACY_BOARD_FILE_VERSION;
82 
84  m_Status_Pcb = 0; // Status word: bit 1 = calculate.
85  m_CurrentZoneContour = NULL; // This ZONE_CONTAINER handle the
86  // zone contour currently in progress
87 
88  BuildListOfNets(); // prepare pad and netlist containers.
89 
90  for( LAYER_NUM layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
91  {
92  m_Layer[layer].m_name = GetStandardLayerName( ToLAYER_ID( layer ) );
93 
94  if( IsCopperLayer( layer ) )
95  m_Layer[layer].m_type = LT_SIGNAL;
96  else
97  m_Layer[layer].m_type = LT_UNDEFINED;
98  }
99 
100  // Initialize default netclass.
101  NETCLASSPTR defaultClass = m_designSettings.GetDefault();
102  defaultClass->SetDescription( _( "This is the default net class." ) );
103  m_designSettings.SetCurrentNetClass( defaultClass->GetName() );
104 
105  // Set sensible initial values for custom track width & via size
110 
111  // Initialize ratsnest
112  m_connectivity.reset( new CONNECTIVITY_DATA() );
113 }
void BuildListOfNets()
Definition: class_board.h:722
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:111
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:196
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:113
COLORS_DESIGN_SETTINGS * m_colorsSettings
Definition: class_board.h:195
ZONE_CONTAINER * m_CurrentZoneContour
zone contour currently in progress
Definition: class_board.h:259
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
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[]
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:189
LAYER m_Layer[PCB_LAYER_ID_COUNT]
Definition: class_board.h:183
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:191
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:193
int GetCurrentTrackWidth() const
Function GetCurrentTrackWidth.
BOARD_ITEM_CONTAINER(BOARD_ITEM *aParent, KICAD_T aType)
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:796
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:647
int m_Status_Pcb
Flags used in ratsnest calculation and update.
Definition: class_board.h:237
BOARD::~BOARD ( )

Definition at line 116 of file class_board.cpp.

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

117 {
118  while( m_ZoneDescriptorList.size() )
119  {
120  ZONE_CONTAINER* area_to_remove = m_ZoneDescriptorList[0];
121  Delete( area_to_remove );
122  }
123 
124  DeleteMARKERs();
126 
127  delete m_CurrentZoneContour;
128  m_CurrentZoneContour = NULL;
129 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
void DeleteZONEOutlines()
Function DeleteZONEOutlines deletes ALL zone outlines from the board.
ZONE_CONTAINER * m_CurrentZoneContour
zone contour currently in progress
Definition: class_board.h:259
void DeleteMARKERs()
Function DeleteMARKERs deletes ALL MARKERS from the board.
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
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 834 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_Status_Pcb, m_Track, m_Zone, m_ZoneDescriptorList, PCB_DIMENSION_T, PCB_LINE_T, PCB_MARKER_T, PCB_MODULE_T, PCB_NETINFO_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, PCB_ZONE_T, DLIST< T >::PushBack(), DLIST< T >::PushFront(), EDA_ITEM::SetParent(), and EDA_ITEM::Type().

Referenced by 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_BASE_FRAME::CreateNewModule(), 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(), EVT_TOOL(), DSN::SPECCTRA_DB::FromSESSION(), FOOTPRINT_EDIT_FRAME::Import_Module(), InvokeDXFDialogBoardImport(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), LEGACY_PLUGIN::loadAllSections(), LEGACY_PLUGIN::loadDIMENSION(), EAGLE_PLUGIN::loadElements(), PCB_BASE_FRAME::LoadModuleFromLibrary(), LEGACY_PLUGIN::loadNETINFO_ITEM(), LEGACY_PLUGIN::loadPCB_LINE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), LEGACY_PLUGIN::loadZONE_CONTAINER(), PANEL_PREV_3D::PANEL_PREV_3D(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), ReplaceNetlist(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), BOARD_COMMIT::Revert(), and FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint().

835 {
836  if( aBoardItem == NULL )
837  {
838  wxFAIL_MSG( wxT( "BOARD::Add() param error: aBoardItem NULL" ) );
839  return;
840  }
841 
842  switch( aBoardItem->Type() )
843  {
844  case PCB_NETINFO_T:
845  m_NetInfo.AppendNet( (NETINFO_ITEM*) aBoardItem );
846  break;
847 
848  // this one uses a vector
849  case PCB_MARKER_T:
850  m_markers.push_back( (MARKER_PCB*) aBoardItem );
851  break;
852 
853  // this one uses a vector
854  case PCB_ZONE_AREA_T:
855  m_ZoneDescriptorList.push_back( (ZONE_CONTAINER*) aBoardItem );
856  break;
857 
858  case PCB_TRACE_T:
859  case PCB_VIA_T:
860  if( aMode == ADD_APPEND )
861  {
862  m_Track.PushBack( (TRACK*) aBoardItem );
863  }
864  else
865  {
866  TRACK* insertAid;
867  insertAid = ( (TRACK*) aBoardItem )->GetBestInsertPoint( this );
868  m_Track.Insert( (TRACK*) aBoardItem, insertAid );
869  }
870 
871  break;
872 
873  case PCB_ZONE_T:
874  if( aMode == ADD_APPEND )
875  m_Zone.PushBack( (SEGZONE*) aBoardItem );
876  else
877  m_Zone.PushFront( (SEGZONE*) aBoardItem );
878 
879  break;
880 
881  case PCB_MODULE_T:
882  if( aMode == ADD_APPEND )
883  m_Modules.PushBack( (MODULE*) aBoardItem );
884  else
885  m_Modules.PushFront( (MODULE*) aBoardItem );
886 
887  // Because the list of pads has changed, reset the status
888  // This indicate the list of pad and nets must be recalculated before use
889  m_Status_Pcb = 0;
890  break;
891 
892  case PCB_DIMENSION_T:
893  case PCB_LINE_T:
894  case PCB_TEXT_T:
895  case PCB_TARGET_T:
896  if( aMode == ADD_APPEND )
897  m_Drawings.PushBack( aBoardItem );
898  else
899  m_Drawings.PushFront( aBoardItem );
900 
901  break;
902 
903  // other types may use linked list
904  default:
905  {
906  wxString msg;
907  msg.Printf( wxT( "BOARD::Add() needs work: BOARD_ITEM type (%d) not handled" ),
908  aBoardItem->Type() );
909  wxFAIL_MSG( msg );
910  return;
911  }
912  break;
913  }
914 
915  aBoardItem->SetParent( this );
916  m_connectivity->Add( aBoardItem );
917 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
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
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
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< BOARD_ITEM > m_Drawings
Definition: class_board.h:241
class SEGZONE, a segment used to fill a zone area (segment on a copper layer)
Definition: typeinfo.h:97
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:178
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: class_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:245
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:104
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:191
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
DLIST< TRACK > m_Track
Definition: class_board.h:246
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
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:237
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 2281 of file class_board.cpp.

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

Referenced by NormalizeAreaPolygon().

2283 {
2284  ZONE_CONTAINER* new_area = InsertArea( aNetcode,
2285  m_ZoneDescriptorList.size( ) - 1,
2286  aLayer, aStartPointPosition.x,
2287  aStartPointPosition.y, aHatch );
2288 
2289  if( aNewZonesList )
2290  {
2291  ITEM_PICKER picker( new_area, UR_NEW );
2292  aNewZonesList->PushItem( picker );
2293  }
2294 
2295  return new_area;
2296 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
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:181
BOARD_ITEM* BOARD_ITEM::Back ( ) const
inlineinherited

Definition at line 117 of file class_board_item.h.

References EDA_ITEM::Pback.

Referenced by PCB_EDIT_FRAME::Delete_Segment_Edge(), and SwapItemData().

117 { return static_cast<BOARD_ITEM*>( Pback ); }
EDA_ITEM * Pback
previous in linked list
Definition: base_struct.h:192
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 753 of file class_board.h.

References NETINFO_LIST::begin().

754  {
755  return m_NetInfo.begin();
756  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
iterator begin() const
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 132 of file class_board.cpp.

References GetConnectivity().

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

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

Definition at line 722 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(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), and ReplaceNetlist().

723  {
725  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
void buildListOfNets()
Function buildListOfNets builds or rebuilds the list of NETINFO_ITEMs The list is sorted by names...
void BOARD::chainMarkedSegments ( 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
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 391 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(), m_Track, TRACK::Next(), and EDA_ITEM::SetState().

Referenced by MarkTrace().

392 {
393  LSET layer_set = aLayerSet;
394 
395  if( !m_Track ) // no tracks at all in board
396  return;
397 
398  D_PAD* pad = NULL;
399  double distanceToPadCenter;
400 
401  /* Set the BUSY flag of all connected segments, first search starting at
402  * aPosition. The search ends when a pad is found (end of a track), a
403  * segment end has more than one other segment end connected, or when no
404  * connected item found.
405  *
406  * Vias are a special case because they must look for segments connected
407  * on other layers and they change the layer mask. They can be a track
408  * end or not. They will be analyzer later and vias on terminal points
409  * of the track will be considered as part of this track if they do not
410  * connect segments of another track together and will be considered as
411  * part of an other track when removing the via, the segments of that other
412  * track are disconnected.
413  */
414  for( ; ; )
415  {
416 
417  if( !pad )
418  pad = GetPad( aPosition, layer_set );
419  if( pad )
420  distanceToPadCenter = GetLineLength( aPosition, pad->GetCenter() );
421 
422  /* Test for a via: a via changes the layer mask and can connect a lot
423  * of segments at location aPosition. When found, the via is just
424  * pushed in list. Vias will be examined later, when all connected
425  * segment are found and push in list. This is because when a via
426  * is found we do not know at this time the number of connected items
427  * and we do not know if this via is on the track or finish the track
428  */
429  TRACK* via = m_Track->GetVia( NULL, aPosition, layer_set );
430 
431  if( via )
432  {
433  layer_set = via->GetLayerSet();
434 
435  aList->push_back( via );
436  }
437 
438  int seg_count = 0;
439  TRACK* candidate = NULL;
440 
441  /* Search all segments connected to point aPosition.
442  * if only 1 segment at aPosition: then this segment is "candidate"
443  * if > 1 segment:
444  * then end of "track" (because more than 2 segments are connected at aPosition)
445  */
446  TRACK* segment = m_Track;
447 
448  while( ( segment = ::GetTrack( segment, NULL, aPosition, layer_set ) ) != NULL )
449  {
450  if( segment->GetState( BUSY ) ) // already found and selected: skip it
451  {
452  segment = segment->Next();
453  continue;
454  }
455 
456  if( segment == via ) // just previously found: skip it
457  {
458  segment = segment->Next();
459  continue;
460  }
461 
462  if( ++seg_count == 1 ) // if first connected item: then segment is candidate
463  {
464  candidate = segment;
465  segment = segment->Next();
466  }
467  else // More than 1 segment connected -> location is end of track
468  {
469  return;
470  }
471  }
472 
473  if( candidate ) // A candidate is found: flag it and push it in list
474  {
475  /* Initialize parameters to search items connected to this
476  * candidate:
477  * we must analyze connections to its other end
478  */
479  if( aPosition == candidate->GetStart() )
480  {
481  aPosition = candidate->GetEnd();
482  }
483  else
484  {
485  aPosition = candidate->GetStart();
486  }
487 
488  /* If we are in a pad, only candidates approaching the pad center
489  * are accepted.
490  */
491  if( pad )
492  {
493  if( GetPad( aPosition, layer_set ) != pad )
494  return;
495  if( GetLineLength( aPosition, pad->GetCenter() ) > distanceToPadCenter )
496  return;
497  }
498 
499  layer_set = candidate->GetLayerSet();
500 
501  // flag this item and push it in list of selected items
502  aList->push_back( candidate );
503  candidate->SetState( BUSY, true );
504  }
505  else
506  {
507  return;
508  }
509  }
510 }
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:148
int GetState(int type) const
Definition: base_struct.h:264
const wxPoint & GetEnd() const
Definition: class_track.h:120
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:123
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:100
void SetState(int type, int state)
Definition: base_struct.h:269
DLIST< TRACK > m_Track
Definition: class_board.h:246
static bool BOARD::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 227 of file class_board.h.

References PCB_T, and EDA_ITEM::Type().

228  {
229  return aItem && PCB_T == aItem->Type();
230  }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:225
Definition: typeinfo.h:85
void BOARD::ClearAllNetCodes ( )

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

Definition at line 2914 of file class_board.cpp.

References mod, Modules(), Tracks(), and Zones().

2915 {
2916  for ( auto zone : Zones() )
2917  zone->SetNetCode( 0 );
2918 
2919  for ( auto mod : Modules() )
2920  for ( auto pad : mod->Pads() )
2921  pad->SetNetCode( 0 );
2922 
2923  for ( auto track : Tracks() )
2924  track->SetNetCode( 0 );
2925 
2926 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:250
ZONE_CONTAINERS & Zones()
Definition: class_board.h:252
DLIST_ITERATOR_WRAPPER< TRACK > Tracks()
Definition: class_board.h:249
#define mod(a, n)
Definition: greymap.cpp:24
void EDA_ITEM::ClearBrightened ( )
inlineinherited

Definition at line 260 of file base_struct.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

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

Definition at line 281 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(), abortMoveBitmap(), AbortMoveDimensionText(), abortMoveItem(), AbortMoveTextModule(), AbortPinMove(), SCH_SCREEN::addConnectedItemsToBlock(), SCH_EDIT_FRAME::addCurrentItemToList(), 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(), PCB_EDIT_FRAME::Change_Side_Module(), SCH_SCREEN::ClearAnnotation(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearHighlighted(), ClearMarkItems(), clearModuleItemFlags(), EDA_ITEM::ClearSelected(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::copyBlockItems(), CopyMarkedItems(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), 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(), 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_Zone(), PCB_EDIT_FRAME::Exchange_Module(), ExitSheet(), SCH_SCREEN::GetConnection(), PCB_BASE_FRAME::GlobalChange_PadSettings(), 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(), SCH_EAGLE_PLUGIN::loadSheet(), MarkItemsInBloc(), MirrorX(), MirrorY(), moveBitmap(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), LIB_EDIT_FRAME::OnEditPin(), FOOTPRINT_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnLeftClick(), PCB_EDIT_FRAME::OnLeftClick(), LIB_EDIT_FRAME::OnRotateItem(), 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(), PCBNEW_CONTROL::placeBoardItems(), 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(), EDIT_TOOL::Properties(), 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(), SCH_LEGACY_PLUGIN_CACHE::savePin(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), SCH_EDIT_FRAME::SetRepeatItem(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveModule(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DIALOG_PAD_PROPERTIES::TransferDataFromWindow().

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

Definition at line 259 of file base_struct.h.

References EDA_ITEM::ClearFlags(), and HIGHLIGHTED.

259 { ClearFlags( HIGHLIGHTED ); }
#define HIGHLIGHTED
item is drawn in normal colors, when the rest is darkened
Definition: base_struct.h:150
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:281
void EDA_ITEM::ClearSelected ( )
inlineinherited
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, SCH_GLOBALLABEL, TRACK, SCH_LABEL, DRAWSEGMENT, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, SCH_LINE, SCH_BUS_BUS_ENTRY, LIB_ARC, SCH_BUS_WIRE_ENTRY, SCH_BITMAP, TEXTE_PCB, LIB_TEXT, EDGE_MODULE, LIB_POLYLINE, LIB_RECTANGLE, SCH_MARKER, SCH_NO_CONNECT, LIB_BEZIER, LIB_CIRCLE, PCB_TARGET, and SCH_JUNCTION.

Definition at line 125 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by PCB_EDIT_FRAME::Block_Duplicate(), CopyMarkedItems(), LIB_PART::CopySelectedItems(), LIB_EDIT_FRAME::copySelectedItems(), Duplicate(), DuplicateStruct(), SCH_SCREEN::ExtractWires(), LIB_PART::LIB_PART(), LIB_EDIT_FRAME::LoadOneSymbol(), new_clone(), SCH_EDIT_FRAME::OnCopySchematicItemRequest(), LIB_EDIT_FRAME::pasteClipboard(), SCH_EDIT_FRAME::RepeatDrawItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), LIB_PART::SetConversion(), SCH_EDIT_FRAME::SetRepeatItem(), SCH_EDIT_FRAME::SetUndoItem(), LIB_PART::SetUnitCount(), and COMMIT::Stage().

126 {
127  wxCHECK_MSG( false, NULL, wxT( "Clone not implemented in derived class " ) + GetClass() +
128  wxT( ". Bad programmer!" ) );
129 }
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 563 of file class_board.h.

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

563 { return *m_colorsSettings; }
COLORS_DESIGN_SETTINGS * m_colorsSettings
Definition: class_board.h:195
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:60
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:172
SHAPE_POLY_SET * Outline()
Definition: class_zone.h:236
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:602
bool Intersects(const BOX2< Vec > &aRect) const
Function Intersects.
Definition: box2.h:224
int GetNetCode() const
Function GetNetCode.
int GetLocalFlags() const
Definition: class_zone.h:230
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
unsigned GetPriority() const
Function GetPriority.
Definition: class_zone.h:101
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 246 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().

248 {
249  if( area_ref == area_to_combine )
250  {
251  wxASSERT( 0 );
252  return false;
253  }
254 
255  SHAPE_POLY_SET mergedOutlines = *area_ref->Outline();
256  SHAPE_POLY_SET areaToMergePoly = *area_to_combine->Outline();
257 
258  mergedOutlines.BooleanAdd( areaToMergePoly, SHAPE_POLY_SET::PM_FAST );
259  mergedOutlines.Simplify( SHAPE_POLY_SET::PM_FAST );
260 
261  // We should have one polygon with hole
262  // We can have 2 polygons with hole, if the 2 initial polygons have only one common corner
263  // and therefore cannot be merged (they are dectected as intersecting)
264  // but we should never have more than 2 polys
265  if( mergedOutlines.OutlineCount() > 2 )
266  {
267  wxLogMessage(wxT("BOARD::CombineAreas error: more than 2 polys after merging") );
268  return false;
269  }
270 
271  if( mergedOutlines.OutlineCount() > 1 )
272  return false;
273 
274  // Update the area with the new merged outline
275  delete area_ref->Outline();
276  area_ref->SetOutline( new SHAPE_POLY_SET( mergedOutlines ) );
277 
278  RemoveArea( aDeletedList, area_to_combine );
279 
280  area_ref->SetLocalFlags( 1 );
281  area_ref->Hatch();
282 
283  return true;
284 }
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:236
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:239
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's...
void SetLocalFlags(int aFlags)
Definition: class_zone.h:231
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 1034 of file class_board.cpp.

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

Referenced by BuildBoardPolygonOutlines(), DIALOG_SVG_PRINT::CreateSVGFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), BOARD_PRINTOUT_CONTROLLER::DrawPage(), PCB_EDIT_FRAME::ExportToGenCAD(), initializePlotter(), CINFO3D_VISU::InitSettings(), PCB_EDIT_FRAME::OnExportSTEP(), and StartPlotBoard().

1035 {
1036  bool hasItems = false;
1037  EDA_RECT area;
1038 
1039  // Check segments, dimensions, texts, and fiducials
1040  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
1041  {
1042  if( aBoardEdgesOnly && (item->Type() != PCB_LINE_T || item->GetLayer() != Edge_Cuts ) )
1043  continue;
1044 
1045  if( !hasItems )
1046  area = item->GetBoundingBox();
1047  else
1048  area.Merge( item->GetBoundingBox() );
1049 
1050  hasItems = true;
1051  }
1052 
1053  if( !aBoardEdgesOnly )
1054  {
1055  // Check modules
1056  for( MODULE* module = m_Modules; module; module = module->Next() )
1057  {
1058  if( !hasItems )
1059  area = module->GetBoundingBox();
1060  else
1061  area.Merge( module->GetBoundingBox() );
1062 
1063  hasItems = true;
1064  }
1065 
1066  // Check tracks
1067  for( TRACK* track = m_Track; track; track = track->Next() )
1068  {
1069  if( !hasItems )
1070  area = track->GetBoundingBox();
1071  else
1072  area.Merge( track->GetBoundingBox() );
1073 
1074  hasItems = true;
1075  }
1076 
1077  // Check segment zones
1078  for( TRACK* track = m_Zone; track; track = track->Next() )
1079  {
1080  if( !hasItems )
1081  area = track->GetBoundingBox();
1082  else
1083  area.Merge( track->GetBoundingBox() );
1084 
1085  hasItems = true;
1086  }
1087 
1088  // Check polygonal zones
1089  for( unsigned int i = 0; i < m_ZoneDescriptorList.size(); i++ )
1090  {
1092 
1093  if( !hasItems )
1094  area = aZone->GetBoundingBox();
1095  else
1096  area.Merge( aZone->GetBoundingBox() );
1097 
1098  area.Merge( aZone->GetBoundingBox() );
1099  hasItems = true;
1100  }
1101  }
1102 
1103  return area;
1104 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
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...
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox (virtual)
Definition: class_zone.cpp:515
MODULE * Next() const
Definition: class_module.h:120
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
SEGZONE * Next() const
Definition: class_track.h:362
BOARD_ITEM * Next() const
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:241
TRACK * Next() const
Definition: class_track.h:100
DLIST< MODULE > m_Modules
Definition: class_board.h:245
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
Class EDA_RECT handles the component boundary box.
DLIST< TRACK > m_Track
Definition: class_board.h:246
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 66 of file board_items_to_polygon_shape_transform.cpp.

References GetArea(), GetAreaCount(), ZONE_CONTAINER::GetLayer(), m_Drawings, m_Modules, m_Track, TRACK::Next(), BOARD_ITEM::Next(), MODULE::Next(), PCB_LINE_T, PCB_TEXT_T, and ZONE_CONTAINER::TransformSolidAreasShapesToPolygonSet().

Referenced by PlotLayerOutlines().

67 {
68  // Number of segments to convert a circle to a polygon
69  const int segcountforcircle = 18;
70  double correctionFactor = 1.0 / cos( M_PI / (segcountforcircle * 2) );
71 
72  // convert tracks and vias:
73  for( TRACK* track = m_Track; track != NULL; track = track->Next() )
74  {
75  if( !track->IsOnLayer( aLayer ) )
76  continue;
77 
78  track->TransformShapeWithClearanceToPolygon( aOutlines,
79  0, segcountforcircle, correctionFactor );
80  }
81 
82  // convert pads
83  for( MODULE* module = m_Modules; module != NULL; module = module->Next() )
84  {
85  module->TransformPadsShapesWithClearanceToPolygon( aLayer,
86  aOutlines, 0, segcountforcircle, correctionFactor );
87 
88  // Micro-wave modules may have items on copper layers
89  module->TransformGraphicShapesWithClearanceToPolygonSet( aLayer,
90  aOutlines, 0, segcountforcircle, correctionFactor );
91  }
92 
93  // convert copper zones
94  for( int ii = 0; ii < GetAreaCount(); ii++ )
95  {
96  ZONE_CONTAINER* zone = GetArea( ii );
97  PCB_LAYER_ID zonelayer = zone->GetLayer();
98 
99  if( zonelayer == aLayer )
101  aOutlines, segcountforcircle, correctionFactor );
102  }
103 
104  // convert graphic items on copper layers (texts)
105  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
106  {
107  if( !item->IsOnLayer( aLayer ) )
108  continue;
109 
110  switch( item->Type() )
111  {
112  case PCB_LINE_T: // should not exist on copper layers
113  ( (DRAWSEGMENT*) item )->TransformShapeWithClearanceToPolygon(
114  aOutlines, 0, segcountforcircle, correctionFactor );
115  break;
116 
117  case PCB_TEXT_T:
118  ( (TEXTE_PCB*) item )->TransformShapeWithClearanceToPolygonSet(
119  aOutlines, 0, segcountforcircle, correctionFactor );
120  break;
121 
122  default:
123  break;
124  }
125  }
126 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
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:120
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:172
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:241
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1011
TRACK * Next() const
Definition: class_track.h:100
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:982
DLIST< MODULE > m_Modules
Definition: class_board.h:245
DLIST< TRACK > m_Track
Definition: class_board.h:246
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
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 2203 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, UR_NEW, wxPoint::x, and wxPoint::y.

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

2204 {
2205  /* creates an intermediate point on aSegment and break it into two segments
2206  * at aPosition.
2207  * The new segment starts from aPosition and ends at the end point of
2208  * aSegment. The original segment now ends at aPosition.
2209  */
2210  if( aSegment->GetStart() == aPosition || aSegment->GetEnd() == aPosition )
2211  return NULL;
2212 
2213  // A via is a good lock point
2214  if( aSegment->Type() == PCB_VIA_T )
2215  {
2216  aPosition = aSegment->GetStart();
2217  return aSegment;
2218  }
2219 
2220  // Calculation coordinate of intermediate point relative to the start point of aSegment
2221  wxPoint delta = aSegment->GetEnd() - aSegment->GetStart();
2222 
2223  // calculate coordinates of aPosition relative to aSegment->GetStart()
2224  wxPoint lockPoint = aPosition - aSegment->GetStart();
2225 
2226  // lockPoint must be on aSegment:
2227  // Ensure lockPoint.y/lockPoint.y = delta.y/delta.x
2228  if( delta.x == 0 )
2229  lockPoint.x = 0; // horizontal segment
2230  else
2231  lockPoint.y = KiROUND( ( (double)lockPoint.x * delta.y ) / delta.x );
2232 
2233  /* Create the intermediate point (that is to say creation of a new
2234  * segment, beginning at the intermediate point.
2235  */
2236  lockPoint += aSegment->GetStart();
2237 
2238  TRACK* newTrack = (TRACK*)aSegment->Clone();
2239  // The new segment begins at the new point,
2240  newTrack->SetStart(lockPoint);
2241  newTrack->start = aSegment;
2242  newTrack->SetState( BEGIN_ONPAD, false );
2243 
2244  DLIST<TRACK>* list = (DLIST<TRACK>*)aSegment->GetList();
2245  wxASSERT( list );
2246  list->Insert( newTrack, aSegment->Next() );
2247 
2248  if( aList )
2249  {
2250  // Prepare the undo command for the now track segment
2251  ITEM_PICKER picker( newTrack, UR_NEW );
2252  aList->PushItem( picker );
2253  // Prepare the undo command for the old track segment
2254  // before modifications
2255  picker.SetItem( aSegment );
2256  picker.SetStatus( UR_CHANGED );
2257  picker.SetLink( aSegment->Clone() );
2258  aList->PushItem( picker );
2259  }
2260 
2261  // Old track segment now ends at new point.
2262  aSegment->SetEnd(lockPoint);
2263  aSegment->end = newTrack;
2264  aSegment->SetState( END_ONPAD, false );
2265 
2266  D_PAD * pad = GetPad( newTrack, ENDPOINT_START );
2267 
2268  if( pad )
2269  {
2270  newTrack->start = pad;
2271  newTrack->SetState( BEGIN_ONPAD, true );
2272  aSegment->end = pad;
2273  aSegment->SetState( END_ONPAD, true );
2274  }
2275 
2276  aPosition = lockPoint;
2277  return newTrack;
2278 }
DHEAD * GetList() const
Definition: base_struct.h:236
KICAD_T Type() const
Function Type()
Definition: base_struct.h:225
#define END_ONPAD
Pcbnew: flag set for track segment ending on a pad.
Definition: base_struct.h:147
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
void SetEnd(const wxPoint &aEnd)
Definition: class_track.h:119
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:146
static const int delta[8][2]
Definition: solve.cpp:112
const wxPoint & GetEnd() const
Definition: class_track.h:120
const wxPoint & GetStart() const
Definition: class_track.h:123
TRACK * Next() const
Definition: class_track.h:100
void SetState(int type, int state)
Definition: base_struct.h:269
void SetStart(const wxPoint &aStart)
Definition: class_track.h:122
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
BOARD_CONNECTED_ITEM * end
Definition: class_track.h:92
BOARD_CONNECTED_ITEM * start
Definition: class_track.h:91
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 989 of file class_board.cpp.

References m_markers.

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

990 {
991  // the vector does not know how to delete the MARKER_PCB, it holds pointers
992  for( unsigned i = 0; i<m_markers.size(); ++i )
993  delete m_markers[i];
994 
995  m_markers.clear();
996 }
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:178
void BOARD_ITEM::DeleteStructure ( )
inherited
void BOARD::DeleteZONEOutlines ( )

Function DeleteZONEOutlines deletes ALL zone outlines from the board.

Definition at line 999 of file class_board.cpp.

References m_ZoneDescriptorList.

Referenced by ~BOARD().

1000 {
1001  // the vector does not know how to delete the ZONE Outlines, it holds
1002  // pointers
1003  for( unsigned i = 0; i<m_ZoneDescriptorList.size(); ++i )
1004  delete m_ZoneDescriptorList[i];
1005 
1006  m_ZoneDescriptorList.clear();
1007 }
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
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 tracepcb.cpp.

References LSET::AllCuMask(), B_Cu, ZONE_CONTAINER::Draw(), ZONE_CONTAINER::DrawFilledArea(), DrawHighLight(), F_Cu, GetArea(), GetAreaCount(), EDA_ITEM::GetFlags(), GetHighLightNetCode(), IN_EDIT, IS_DRAGGED, IS_MOVED, IsElementVisible(), IsHighLightNetON(), LAYER_MOD_BK, LAYER_MOD_FR, m_Drawings, m_markers, m_Modules, m_Track, m_Zone, 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::RedrawActiveWindow(), 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 outdated, only her for compatibility with
161  // very old designs
162  for( SEGZONE* zone = m_Zone; zone; zone = zone->Next() )
163  {
164  if( zone->IsMoving() )
165  continue;
166 
167  zone->Draw( aPanel, DC, aDrawMode );
168  }
169 
170  // Draw the graphic items
171  for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
172  {
173  if( item->IsMoving() )
174  continue;
175 
176  switch( item->Type() )
177  {
178  case PCB_DIMENSION_T:
179  case PCB_TEXT_T:
180  case PCB_TARGET_T:
181  case PCB_LINE_T:
182  item->Draw( aPanel, DC, aDrawMode );
183  break;
184 
185  default:
186  break;
187  }
188  }
189 
190  // Draw areas (i.e. zones)
191  for( int ii = 0; ii < GetAreaCount(); ii++ )
192  {
193  ZONE_CONTAINER* zone = GetArea( ii );
194 
195  // Areas must be drawn here only if not moved or dragged,
196  // because these areas are drawn by ManageCursor() in a specific manner
197  if( ( zone->GetFlags() & (IN_EDIT | IS_DRAGGED | IS_MOVED) ) == 0 )
198  {
199  zone->Draw( aPanel, DC, aDrawMode );
200  zone->DrawFilledArea( aPanel, DC, aDrawMode );
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:673
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:273
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:282
#define IN_EDIT
Item currently edited.
Definition: base_struct.h:125
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:403
MODULE * Next() const
Definition: class_module.h:120
show modules on back
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
SEGZONE * Next() const
Definition: class_track.h:362
show modules on front
BOARD_ITEM * Next() const
#define IS_DRAGGED
Item being dragged.
Definition: base_struct.h:129
Class LSET is a set of PCB_LAYER_IDs.
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:241
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1011
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:178
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
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:100
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:982
static void Trace_Pads_Only(EDA_DRAW_PANEL *panel, wxDC *DC, MODULE *Module, int ox, int oy, LSET LayerMask, GR_DRAWMODE draw_mode)
Definition: tracepcb.cpp:295
DLIST< MODULE > m_Modules
Definition: class_board.h:245
bool IsHighLightNetON() const
Function IsHighLightNetON.
Definition: class_board.h:381
int GetHighLightNetCode() const
Function GetHighLightNetCode.
Definition: class_board.h:366
DLIST< TRACK > m_Track
Definition: class_board.h:246
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...
Definition: tracepcb.cpp:247
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
#define IS_MOVED
Item being moved.
Definition: base_struct.h:126
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 tracepcb.cpp.

References ZONE_CONTAINER::Draw(), GetArea(), GetAreaCount(), BOARD_CONNECTED_ITEM::GetNetCode(), GR_AND, GR_HIGHLIGHT, GR_OR, IsHighLightNetON(), m_Modules, m_Track, TRACK::Next(), MODULE::Next(), and D_PAD::Next().

Referenced by Abort_Create_Track(), PCB_EDIT_FRAME::Begin_Route(), Draw(), 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:273
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
MODULE * Next() const
Definition: class_module.h:120
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:1011
Definition: gr_basic.h:38
int GetNetCode() const
Function GetNetCode.
TRACK * Next() const
Definition: class_track.h:100
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:982
DLIST< MODULE > m_Modules
Definition: class_board.h:245
bool IsHighLightNetON() const
Function IsHighLightNetON.
Definition: class_board.h:381
DLIST< TRACK > m_Track
Definition: class_board.h:246
DLIST<BOARD_ITEM>& BOARD::DrawingsList ( )
inline

Definition at line 256 of file class_board.h.

Referenced by PCB_EDIT_FRAME::AppendBoardFile().

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

Definition at line 2817 of file class_board.cpp.

References Add(), 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().

2819 {
2820  BOARD_ITEM* new_item = NULL;
2821 
2822  switch( aItem->Type() )
2823  {
2824  case PCB_MODULE_T:
2825  case PCB_TEXT_T:
2826  case PCB_LINE_T:
2827  case PCB_TRACE_T:
2828  case PCB_VIA_T:
2829  case PCB_ZONE_AREA_T:
2830  case PCB_TARGET_T:
2831  case PCB_DIMENSION_T:
2832  new_item = static_cast<BOARD_ITEM*>( aItem->Clone() );
2833  break;
2834 
2835  default:
2836  // Un-handled item for duplication
2837  new_item = NULL;
2838  break;
2839  }
2840 
2841  if( new_item && aAddToBoard )
2842  Add( new_item );
2843 
2844  return new_item;
2845 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:225
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 762 of file class_board.h.

References NETINFO_LIST::end().

763  {
764  return m_NetInfo.end();
765  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
iterator end() const
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 1372 of file class_board.cpp.

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

Referenced by ReplaceNetlist(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

1373 {
1374  if( aSearchByTimeStamp )
1375  {
1376  for( MODULE* module = m_Modules; module; module = module->Next() )
1377  {
1378  if( aRefOrTimeStamp.CmpNoCase( module->GetPath() ) == 0 )
1379  return module;
1380  }
1381  }
1382  else
1383  {
1384  return FindModuleByReference( aRefOrTimeStamp );
1385  }
1386 
1387  return NULL;
1388 }
MODULE * Next() const
Definition: class_module.h:120
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:245
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 1344 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().

1345 {
1346  MODULE* found = nullptr;
1347 
1348  // search only for MODULES
1349  static const KICAD_T scanTypes[] = { PCB_MODULE_T, EOT };
1350 
1351  INSPECTOR_FUNC inspector = [&] ( EDA_ITEM* item, void* testData )
1352  {
1353  MODULE* module = (MODULE*) item;
1354 
1355  if( aReference == module->GetReference() )
1356  {
1357  found = module;
1358  return SEARCH_QUIT;
1359  }
1360 
1361  return SEARCH_CONTINUE;
1362  };
1363 
1364  // visit this BOARD with the above inspector
1365  BOARD* nonconstMe = (BOARD*) this;
1366  nonconstMe->Visit( inspector, NULL, scanTypes );
1367 
1368  return found;
1369 }
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:93
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:169
const wxString & GetReference() const
Function GetReference.
Definition: class_module.h:439
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:178
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 1323 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(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), BOARD_CONNECTED_ITEM::GetNetClass(), ROUTER_TOOL::getNetclassDimensions(), highlightNet(), PNS::SIZES_SETTINGS::Init(), PCB_EDIT_FRAME::ListNetsAndSelect(), LEGACY_PLUGIN::loadNETINFO_ITEM(), LEGACY_PLUGIN::loadPAD(), PCB_EDIT_FRAME::OnLeftClick(), NETINFO_MAPPING::iterator::operator*(), PNS_PCBNEW_RULE_RESOLVER::PNS_PCBNEW_RULE_RESOLVER(), ReplaceNetlist(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_EDIT_FRAME::Solve(), PNS::DIFF_PAIR_PLACER::Start(), SynchronizeNetsAndNetClasses(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo().

1324 {
1325  // the first valid netcode is 1 and the last is m_NetInfo.GetCount()-1.
1326  // zero is reserved for "no connection" and is not actually a net.
1327  // NULL is returned for non valid netcodes
1328 
1329  wxASSERT( m_NetInfo.GetNetCount() > 0 ); // net zero should exist
1330 
1331  if( aNetcode == NETINFO_LIST::UNCONNECTED && m_NetInfo.GetNetCount() == 0 )
1333  else
1334  return m_NetInfo.GetNetItem( aNetcode );
1335 }
NETINFO_ITEM * GetNetItem(int aNetCode) const
Function GetItem.
unsigned GetNetCount() const
Function GetNetCount.
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
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...
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
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 1338 of file class_board.cpp.

References NETINFO_LIST::GetNetItem(), and m_NetInfo.

1339 {
1340  return m_NetInfo.GetNetItem( aNetname );
1341 }
NETINFO_ITEM * GetNetItem(int aNetCode) const
Function GetItem.
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
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, MODULE, DRAWSEGMENT, DIMENSION, TRACK, TEXTE_MODULE, EDGE_MODULE, MARKER_PCB, PCB_TARGET, and TEXTE_PCB.

Definition at line 265 of file class_board_item.h.

References EDA_ITEM::GetClass().

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

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

Definition at line 270 of file class_board_item.h.

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

271  {
272  Flip( wxPoint( aCentre.x, aCentre.y ) );
273  }
virtual void Flip(const wxPoint &aCentre)
Function Flip Flip this object, i.e.
std::string BOARD_ITEM::FormatAngle ( double  aAngle)
staticinherited

Function FormatAngle converts aAngle from board units to a string appropriate for writing to file.

Note
Internal angles for board items can be either degrees or tenths of degree on how KiCad is built.
Parameters
aAngleA angle value to convert.
Returns
A std::string object containing the converted angle.

Definition at line 171 of file class_board_item.cpp.

172 {
173  char temp[50];
174 
175  int len = snprintf( temp, sizeof(temp), "%.10g", aAngle / 10.0 );
176 
177  return std::string( temp, len );
178 }
std::string BOARD_ITEM::FormatInternalUnits ( int  aValue)
staticinherited

Function FormatInternalUnits converts aValue from board internal units to a string appropriate for writing to file.

Note
Internal units for board items can be either deci-mils or nanometers depending on how KiCad is build.
Parameters
aValueA coordinate value to convert.
Returns
A std::string object containing the converted value.

Definition at line 90 of file class_board_item.cpp.

Referenced by checkConnectedTo(), ConvertOutlineToPolygon(), BOARD_ITEM::FormatInternalUnits(), and TracksInNetBetweenPoints().

91 {
92 #if 1
93 
94  char buf[50];
95  int len;
96  double mm = aValue / IU_PER_MM;
97 
98  if( mm != 0.0 && fabs( mm ) <= 0.0001 )
99  {
100  len = sprintf( buf, "%.10f", mm );
101 
102  while( --len > 0 && buf[len] == '0' )
103  buf[len] = '\0';
104 
105  if( buf[len] == '.' )
106  buf[len] = '\0';
107  else
108  ++len;
109  }
110  else
111  {
112  len = sprintf( buf, "%.10g", mm );
113  }
114 
115  return std::string( buf, len );
116 
117 #else
118 
119  // Assume aValue is in nanometers, and that we want the result in millimeters,
120  // and that int is 32 bits wide. Then perform an alternative algorithm.
121  // Can be used to verify that the above algorithm is correctly generating text.
122  // Convert aValue into an integer string, then insert a decimal point manually.
123  // Results are the same as above general purpose algorithm.
124 
125  wxASSERT( sizeof(int) == 4 );
126 
127  if( aValue == 0 )
128  return std::string( 1, '0' );
129  else
130  {
131  char buf[50];
132  int len = sprintf( buf, aValue > 0 ? "%06d" : "%07d", aValue ); // optionally pad w/leading zeros
133 
134  std::string ret( buf, len );
135 
136  std::string::iterator it = ret.end() - 1; // last byte
137 
138  // insert '.' at 6 positions from end, dividing by 10e6 (a million), nm => mm
139  std::string::iterator decpoint = ret.end() - 6;
140 
141  // truncate trailing zeros, up to decimal point position
142  for( ; *it=='0' && it >= decpoint; --it )
143  ret.erase( it ); // does not invalidate iterators it or decpoint
144 
145  if( it >= decpoint )
146  {
147  ret.insert( decpoint, '.' );
148 
149  // decpoint is invalidated here, after insert()
150 
151 #if 1 // want a leading zero when decimal point is in first position?
152  if( ret[0] == '.' )
153  {
154  // insert leading zero ahead of decimal point.
155  ret.insert( ret.begin(), '0' );
156  }
157  else if( ret[0]=='-' && ret[1]=='.' )
158  {
159  ret.insert( ret.begin() + 1, '0' );
160  }
161 #endif
162  }
163 
164  return ret;
165  }
166 
167 #endif
168 }
std::string BOARD_ITEM::FormatInternalUnits ( const wxPoint aPoint)
staticinherited

Definition at line 181 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits(), wxPoint::x, and wxPoint::y.

182 {
183  return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
184 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
std::string BOARD_ITEM::FormatInternalUnits ( const wxSize &  aSize)
staticinherited

Definition at line 187 of file class_board_item.cpp.

References BOARD_ITEM::FormatInternalUnits().

188 {
189  return FormatInternalUnits( aSize.GetWidth() ) + " " + FormatInternalUnits( aSize.GetHeight() );
190 }
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
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 982 of file class_board.h.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), PCB_EDIT_FRAME::AppendBoardFile(), PCB_EDIT_FRAME::Begin_Zone(), PCB_EDIT_FRAME::Block_SelectItems(), CN_CONNECTIVITY_ALGO::Build(), ZONE_FILLER::buildZoneFeatureHoleList(), ConvertBrdLayerToPolygonalContours(), GERBER_JOBFILE_WRITER::CreateJobFile(), CINFO3D_VISU::createLayers(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), DRC::doEdgeZoneDrc(), DRC::doTrackKeepoutDrc(), Draw(), DrawHighLight(), PCB_EDIT_FRAME::Edit_Zone_Params(), export_vrml_zones(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), PCB_IO::format(), PlotSilkScreen(), PlotSolderMaskLayer(), PlotStandardLayer(), PCB_EDIT_FRAME::PrintPage(), PCB_EDIT_FRAME::Process_Special_Functions(), RedrawAreasOutlines(), RedrawFilledAreas(), ReplaceNetlist(), SaveCopyOfZones(), SetAreasNetCodesFromNetNames(), SetElementVisibility(), BOARD_NETLIST_UPDATER::testConnectivity(), TestForExistingItem(), DRC::testKeepoutAreas(), DRC::testZones(), DRC::TestZoneToZoneOutline(), NETINFO_MAPPING::Update(), and UpdateCopyOfZonesList().

983  {
984  if( (unsigned) index < m_ZoneDescriptorList.size() )
985  return m_ZoneDescriptorList[index];
986 
987  return NULL;
988  }
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
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 996 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().

997  {
998  for( int ii = 0; ii < GetAreaCount(); ii++ ) // Search for aArea in list
999  {
1000  if( aArea == GetArea( ii ) ) // Found !
1001  return ii;
1002  }
1003 
1004  return -1;
1005  }
int GetAreaCount() const
Function GetAreaCount.
Definition: class_board.h:1011
ZONE_CONTAINER * GetArea(int index) const
Function GetArea returns the Area (Zone Container) at a given index.
Definition: class_board.h:982
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 DeleteMarkedItems(), TEXTE_PCB::Draw(), PCB_TARGET::Draw(), EDGE_MODULE::Draw(), ZONE_CONTAINER::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), DIMENSION::Draw(), MODULE::Draw(), SEGZONE::Draw(), VIA::Draw(), D_PAD::Draw(), MODULE::DrawAncre(), ZONE_CONTAINER::DrawFilledArea(), BOARD_PRINTOUT_CONTROLLER::DrawPage(), EVT_COMMAND_RANGE(), TEXTE_PCB::Flip(), TRACK::Flip(), ZONE_CONTAINER::Flip(), VIA::Flip(), BOARD_ITEM::GetBoard(), MODULE::GetBoundingBox(), BOARD_ITEM::GetLayerName(), TRACK::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), D_PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), TRACK::GetSelectMenuText(), SEGZONE::GetSelectMenuText(), VIA::GetSelectMenuText(), ZONE_CONTAINER::GetSelectMenuText(), D_PAD::GetSelectMenuText(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), PushTrack(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), and VIA::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:225
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:169
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 797 of file class_board.h.

Referenced by BuildBoardPolygonOutlines(), EAGLE_PLUGIN::centerBoard(), MATRIX_ROUTING_HEAD::ComputeMatrixSize(), GERBER_JOBFILE_WRITER::CreateJobFile(), BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition(), GENDRILL_WRITER_BASE::genDrillMapFile(), genPlacementRoutingMatrix(), PCB_BASE_FRAME::GetBoardBoundingBox(), idf_export_outline(), PCB_EDIT_FRAME::OnExportIDF3(), ReplaceNetlist(), and PCB_EDIT_FRAME::SpreadFootprints().

798  {
799  return ComputeBoundingBox( true );
800  }
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 = NULL 
)

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 = NULL , no message returned on error)
Returns
true if success, false if a contour is not valid

Definition at line 2859 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(), and DSN::SPECCTRA_DB::fillBOUNDARY().

2861 {
2862  bool success = BuildBoardPolygonOutlines( this, aOutlines, aErrorText );
2863 
2864  // Make polygon strictly simple to avoid issues (especially in 3D viewer)
2866 
2867  return success;
2868 
2869 }
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)
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 785 of file class_board.h.

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

786  {
787  return ComputeBoundingBox( false );
788  }
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().

Referenced by chainMarkedSegments(), LEGACY_ARRAY_CREATOR::getRotationCentre(), 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 918 of file class_board.h.

Referenced by Visit().

919  {
920  return wxT( "BOARD" );
921  }
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 290 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(), DIALOG_SELECT_NET_FROM_LIST::buildNetsList(), TRACKS_CLEANER::buildTrackConnectionInfo(), 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(), DRAG_LIST::fillList(), filterNetClass(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_EDIT_FRAME::ImportSpecctraSession(), TRACKS_CLEANER::mergeCollinearSegmentIfPossible(), DIALOG_NETLIST::OnCompileRatsnestClick(), PCB_BASE_FRAME::PlaceModule(), PCB_EDIT_FRAME::Process_Special_Functions(), 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(), SELECTION_TOOL::selectAllItemsConnectedToItem(), SELECTION_TOOL::selectAllItemsOnNet(), PCB_EDIT_FRAME::SetBoard(), SetElementVisibility(), sortNetsByNodes(), BOARD_NETLIST_UPDATER::testConnectivity(), TRACKS_CLEANER::testTrackEndpointDangling(), DRC::testUnconnected(), DRC::testZones(), PCB_BASE_FRAME::TraceAirWiresToTargets(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

291  {
292  return m_connectivity;
293  }
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:191
int BOARD::GetCopperLayerCount ( ) const

Function GetCopperLayerCount.

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

Definition at line 699 of file class_board.cpp.

References BOARD_DESIGN_SETTINGS::GetCopperLayerCount(), and m_designSettings.

Referenced by PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), Autoroute_One_Track(), DSN::SPECCTRA_DB::buildLayerMaps(), compute_layer_Zs(), compute_pad_access_code(), CreateComponentsSection(), GERBER_WRITER::createDrillFile(), GERBER_JOBFILE_WRITER::CreateJobFile(), CreatePadsShapesSection(), CreateRoutesSection(), DIALOG_LAYERS_SETUP::DIALOG_LAYERS_SETUP(), VIA::Draw(), DRAWING_TOOL::DrawVia(), TEXTE_PCB::Flip(), TRACK::Flip(), ZONE_CONTAINER::Flip(), VIA::Flip(), DSN::SPECCTRA_DB::FromBOARD(), GetGerberFileFunctionAttribute(), DIALOG_KEEPOUT_AREA_PROPERTIES::initDialog(), DIALOG_COPPER_ZONE::initDialog(), CINFO3D_VISU::InitSettings(), PCB_EDIT_FRAME::IsMicroViaAcceptable(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), DSN::SPECCTRA_DB::makeIMAGE(), DSN::SPECCTRA_DB::makePADSTACK(), DSN::SPECCTRA_DB::makeVIA(), DIALOG_KEEPOUT_AREA_PROPERTIES::OnLayerSelection(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), and via_access_code().

700 {
702 }
int GetCopperLayerCount() const
Function GetCopperLayerCount.
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:193
BOARD_DESIGN_SETTINGS& BOARD::GetDesignSettings ( ) const
inline

Function GetDesignSettings.

Returns
the BOARD_DESIGN_SETTINGS for this BOARD

Definition at line 532 of file class_board.h.

Referenced by Append_Track_Width_List(), TRACK_VIA_SIZE_MENU::AppendSizes(), ZONE_FILLER::buildUnconnectedThermalStubsPolygonList(), ZONE_FILLER::buildZoneFeatureHoleList(), EDIT_TOOL::changeTrackWidthOnClick(), compute_layer_Zs(), MICROWAVE_TOOL::createInductorBetween(), GERBER_JOBFILE_WRITER::CreateJobFile(), CreatePadsShapesSection(), CreateRoutesSection(), ROUTER_TOOL::CustomTrackWidthDialog(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_PADS_MASK_CLEARANCE::DIALOG_PADS_MASK_CLEARANCE(), DRC::doNetClass(), DRC::doTrackDrc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::EditDimension(), TRACK_WIDTH_MENU::eventHandler(), EVT_TOOL(), EVT_UPDATE_UI(), PCB_EDIT_FRAME::Export_IDF3(), PCB_IO::formatGeneral(), PCB_IO::formatNetInformation(), PCB_IO::formatSetup(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), MODULE::GetBoundingBox(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_CONNECTED_ITEM::GetNetClass(), ROUTER_TOOL::getNetclassDimensions(), PCB_EDIT_FRAME::GetProjectFileParameters(), DRAWING_TOOL::getSegmentWidth(), D_PAD::GetSolderMaskMargin(), D_PAD::GetSolderPasteMargin(), PNS::SIZES_SETTINGS::Init(), DIALOG_PLOT::init_Dialog(), DIALOG_DESIGN_RULES::InitDialogRules(), 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(), PCB_EDIT_FRAME::OnHotKey(), ROUTER_TOOL::onViaCommand(), OrCell_Trace(), PlaceCells(), PCB_EDITOR_CONTROL::PlaceTarget(), PlotOneBoardLayer(), PlotSolderMaskLayer(), PlotStandardLayer(), PNS_PCBNEW_RULE_RESOLVER::PNS_PCBNEW_RULE_RESOLVER(), SaveBoard(), NETINFO_ITEM::SetClass(), PCB_EDIT_FRAME::Solve(), PNS::DIFF_PAIR_PLACER::Start(), PNS_KICAD_IFACE::SyncWorld(), DRC::testNetClasses(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), DIALOG_LAYERS_SETUP::TransferDataFromWindow(), DIALOG_LAYERS_SETUP::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo(), PCB_EDITOR_CONTROL::ViaSizeDec(), and PCB_EDITOR_CONTROL::ViaSizeInc().

533  {
534  // remove const-ness with cast.
536  }
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:193
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.
LSET BOARD::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.

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

Definition at line 711 of file class_board.cpp.

References BOARD_DESIGN_SETTINGS::GetEnabledLayers(), and m_designSettings.

Referenced by PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), DIALOG_PLOT::applyPlotSettings(), PCB_ONE_LAYER_SELECTOR::buildList(), SELECT_COPPER_LAYERS_PAIR_DIALOG::buildList(), DIALOG_LAYERS_SETUP::DIALOG_LAYERS_SETUP(), PCB_IO::formatBoardLayers(), PCB_IO::formatLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), PCB_LAYER_BOX_SELECTOR::getEnabledLayers(), DIALOG_LAYERS_SETUP::getRemovedLayersWithItems(), DIALOG_PLOT::init_Dialog(), DIALOG_SVG_PRINT::initDialog(), DIALOG_PRINT_USING_PRINTER::initValues(), DIALOG_PLOT::Plot(), PCB_LAYER_WIDGET::ReFill(), and SetLayerName().

712 {
714 }
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:193
LSET GetEnabledLayers() const
Function GetEnabledLayers returns a bit-mask of all the layers that are enabled.
int BOARD::GetFileFormatVersionAtLoad ( ) const
inline

Definition at line 277 of file class_board.h.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

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

Definition at line 234 of file class_board.h.

Referenced by AddGerberX2Header(), BuildGerberX2Header(), DIALOG_FREEROUTE::createDSN_File(), DIALOG_GEN_MODULE_POSITION::CreateFiles(), CreateHeaderInfoData(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), BOARD_PRINTOUT_CONTROLLER::DrawPage(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_SVG_PRINT::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_DRC_CONTROL::OnButtonBrowseRptFileClick(), PCB_EDIT_FRAME::OnCloseWindow(), PCB_EDIT_FRAME::OnExportIDF3(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_MODULE_POSITION::OnOutputDirectoryBrowseClicked(), PLOT_CONTROLLER::OpenPlotfile(), DIALOG_PLOT::Plot(), PCB_EDIT_FRAME::Process_Config(), DIALOG_EXCHANGE_MODULE::RebuildCmpList(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), PCB_EDIT_FRAME::SetLastNetListRead(), StartPlotBoard(), PCB_EDIT_FRAME::UpdateTitle(), and DIALOG_DRC_CONTROL::writeReport().

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

Definition at line 282 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(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), 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(), 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(), SCH_SCREEN::GetConnection(), InitialiseDragParameters(), EDA_DRAW_FRAME::isBusy(), Magnetize(), SCH_EDIT_FRAME::MirrorImage(), SCH_EDIT_FRAME::MirrorSheet(), moveBitmap(), 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(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), 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(), PCBNEW_CONTROL::placeBoardItems(), PCB_EDIT_FRAME::PlaceTarget(), FOOTPRINT_EDIT_FRAME::PrepareItemForHotkey(), LIB_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), 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(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_SCREEN::SelectBlockItems(), SCH_EDIT_FRAME::SetBusEntryShape(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), Show_Drag_Track_Segment_With_Cte_Slope(), Show_MoveNode(), PCB_EDIT_FRAME::Start_DragTrackSegmentAndKeepSlope(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), DIALOG_LABEL_EDITOR::TextPropertiesAccept(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_MODULE_BOARD_EDITOR::TransferDataFromWindow().

282 { return m_Flags; }
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:202
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 2114 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, MODULE::Next(), wxPoint::x, and wxPoint::y.

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

2116 {
2117  MODULE* pt_module;
2118  MODULE* module = NULL;
2119  MODULE* alt_module = NULL;
2120  int min_dim = 0x7FFFFFFF;
2121  int alt_min_dim = 0x7FFFFFFF;
2122  bool current_layer_back = IsBackLayer( aActiveLayer );
2123 
2124  for( pt_module = m_Modules; pt_module; pt_module = pt_module->Next() )
2125  {
2126  // is the ref point within the module's bounds?
2127  if( !pt_module->HitTest( aPosition ) )
2128  continue;
2129 
2130  // if caller wants to ignore locked modules, and this one is locked, skip it.
2131  if( aIgnoreLocked && pt_module->IsLocked() )
2132  continue;
2133 
2134  PCB_LAYER_ID layer = pt_module->GetLayer();
2135 
2136  // Filter non visible modules if requested
2137  if( !aVisibleOnly || IsModuleLayerVisible( layer ) )
2138  {
2139  EDA_RECT bb = pt_module->GetFootprintRect();
2140 
2141  int offx = bb.GetX() + bb.GetWidth() / 2;
2142  int offy = bb.GetY() + bb.GetHeight() / 2;
2143 
2144  // off x & offy point to the middle of the box.
2145  int dist = ( aPosition.x - offx ) * ( aPosition.x - offx ) +
2146  ( aPosition.y - offy ) * ( aPosition.y - offy );
2147 
2148  if( current_layer_back == IsBackLayer( layer ) )
2149  {
2150  if( dist <= min_dim )
2151  {
2152  // better footprint shown on the active side
2153  module = pt_module;
2154  min_dim = dist;
2155  }
2156  }
2157  else if( aVisibleOnly && IsModuleLayerVisible( layer ) )
2158  {
2159  if( dist <= alt_min_dim )
2160  {
2161  // better footprint shown on the other side
2162  alt_module = pt_module;
2163  alt_min_dim = dist;
2164  }
2165  }
2166  }
2167  }
2168 
2169  if( module )
2170  {
2171  return module;
2172  }
2173 
2174  if( alt_module)
2175  {
2176  return alt_module;
2177  }
2178 
2179  return NULL;
2180 }
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's a back layer.
MODULE * Next() const
Definition: class_module.h:120
static const int dist[10][10]
Definition: dist.cpp:57
int GetHeight() const
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:256
DLIST< MODULE > m_Modules
Definition: class_board.h:245
Class EDA_RECT handles the component boundary box.
int GetX() const
int GetWidth() const
bool IsModuleLayerVisible(PCB_LAYER_ID aLayer)
Function IsModuleLayerVisible expects either of the two layers on which a module can reside...
int GetY() const
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

Definition at line 350 of file class_board.h.

References BOARD_DESIGN_SETTINGS::m_GridOrigin.

Referenced by PCB_IO::formatSetup(), PCB_BASE_FRAME::GetGridOrigin(), and PCB_BASE_EDIT_FRAME::SetBoard().

350 { return m_designSettings.m_GridOrigin; }
wxPoint m_GridOrigin
origin for grid offsets
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:193
int BOARD::GetHighLightNetCode ( ) const
inline

Function GetHighLightNetCode.

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

Definition at line 366 of file class_board.h.

References HIGH_LIGHT_INFO::m_netCode.

Referenced by Abort_Create_Track(), PCB_EDIT_FRAME::Begin_Zone(), and Draw().

366 { return m_highLight.m_netCode; }
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:186
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(), CINFO3D_VISU::AddGraphicsShapesWithClearanceToContainer(), DIMENSION::AdjustDimensionDetails(), PCB_EDIT_FRAME::Begin_DrawSegment(), GRID_HELPER::BestSnapAnchor(), PCB_EDIT_FRAME::Change_Side_Module(), checkConnectedTo(), MODULE::CopyNetlistSettings(), CreateBoardSection(), MWAVE::CreateMicrowaveInductor(), CreateRoutesSection(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), 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(), 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(), DRAWSEGMENT::Flip(), MODULE::Flip(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::formatLayer(), DSN::SPECCTRA_DB::FromBOARD(), genModuleOnRoutingMatrix(), genPlacementRoutingMatrix(), GetFootprint(), ZONE_CONTAINER::GetLayer(), getOptimalModulePlacement(), GetPad(), GetVisibleTrack(), SELECTION_TOOL::guessSelectionCandidates(), idf_export_module(), DIALOG_MODULE_BOARD_EDITOR::InitBoardProperties(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), D_PAD::IsFlipped(), MODULE::IsFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), MarkTrace(), PCB_EDIT_FRAME::OnRightClick(), PlaceCells(), 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(), Print_Module(), TRACKS_CLEANER::removeDuplicatesOfTrack(), SELECTION_TOOL::selectable(), ShowClearance(), PCB_EDIT_FRAME::Swap_Layers(), PNS_KICAD_IFACE::syncTrack(), TEXTE_MODULE::TEXTE_MODULE(), TraceSegmentPcb(), TrackListSortByNetcode(), DIALOG_EDIT_FPTEXT::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_MODULE_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_EDIT_FPTEXT::TransferDataToWindow(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), CINFO3D_VISU::transformGraphicModuleEdgeToPolygonSet(), MODULE::TransformGraphicShapesWithClearanceToPolygonSet(), MODULE::TransformGraphicTextWithClearanceToPolygonSet(), TstModuleOnBoard(), TEXTE_MODULE::ViewGetLayers(), and TRACK::ViewGetLayers().

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 539 of file class_board.cpp.

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

540 {
541 
542  // Look for the BOARD specific copper layer names
543  for( LAYER_NUM layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
544  {
545  if ( IsCopperLayer( layer ) && ( m_Layer[ layer ].m_name == aLayerName ) )
546  {
547  return ToLAYER_ID( layer );
548  }
549  }
550 
551  // Otherwise fall back to the system standard layer names
552  for( LAYER_NUM layer = 0; layer < PCB_LAYER_ID_COUNT; ++layer )
553  {
554  if( GetStandardLayerName( ToLAYER_ID( layer ) ) == aLayerName )
555  {
556  return ToLAYER_ID( layer );
557  }
558  }
559 
560  return UNDEFINED_LAYER;
561 }
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
LAYER m_Layer[PCB_LAYER_ID_COUNT]
Definition: class_board.h:183
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:796
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:647
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 PCB_IO::format(), PCB_IO::formatLayer(), TEXTE_PCB::GetMsgPanelInfo(), ZONE_CONTAINER::GetMsgPanelInfo(), EDGE_MODULE::GetMsgPanelInfo(), DRAWSEGMENT::GetMsgPanelInfo(), TEXTE_MODULE::GetMsgPanelInfo(), EDGE_MODULE::GetSelectMenuText(), TEXTE_PCB::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), DIMENSION::GetSelectMenuText(), DRAWSEGMENT::GetSelectMenuText(), TRACK::GetSelectMenuText(), SEGZONE::GetSelectMenuText(), MODULE::GetSelectMenuText(), and ZONE_CONTAINER::GetSelectMenuText().

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:169
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:647
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 563 of file class_board.cpp.

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

Referenced by DSN::SPECCTRA_DB::buildLayerMaps(), EVT_COMMAND_RANGE(), PCB_IO::format(), PCB_IO::formatBoardLayers(), PCB_IO::formatLayers(), GENDRILL_WRITER_BASE::GenDrillReportFile(), PCB_LAYER_SELECTOR::GetLayerName(), PCB_LAYER_BOX_SELECTOR::GetLayerName(), BOARD_ITEM::GetLayerName(), TRACK::GetMsgPanelInfoBase(), SEGZONE::GetMsgPanelInfoBase(), VIA::GetMsgPanelInfoBase(), VIA::GetSelectMenuText(), DIALOG_NON_COPPER_ZONES_EDITOR::Init(), DIALOG_PLOT::init_Dialog(), DIALOG_KEEPOUT_AREA_PROPERTIES::initDialog(), DIALOG_SVG_PRINT::initDialog(), DIALOG_COPPER_ZONE::initDialog(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PRINT_USING_PRINTER::initValues(), LayerMaskDescribe(), DIALOG_PLOT::Plot(), PCB_LAYER_WIDGET::ReFill(), SWAP_LAYERS_DIALOG::Sel_Layer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), and DIALOG_LAYERS_SETUP::showBoardLayerNames().

564 {
565  // All layer names are stored in the BOARD.
566  if( IsLayerEnabled( aLayer ) )
567  {
568  // Standard names were set in BOARD::BOARD() but they may be
569  // over-ridden by BOARD::SetLayerName().
570  // For copper layers, return the actual copper layer name,
571  // otherwise return the Standard English layer name.
572  if( IsCopperLayer( aLayer ) )
573  return m_Layer[aLayer].m_name;
574  }
575 
576  return GetStandardLayerName( aLayer );
577 }
wxString m_name
The name of the layer, there should be no spaces in this name.
Definition: class_board.h:111
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:439
LAYER m_Layer[PCB_LAYER_ID_COUNT]
Definition: class_board.h:183
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:647
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 build_pad_testpoints(), chainMarkedSegments(), Collect_TrackSegmentsToDrag(), DRC::doTrackDrc(), DRC::doTrackKeepoutDrc(), PCB_EDIT_FRAME::EraseRedundantTrack(), find_vias_and_tracks_at(), TRACK::GetEndSegments(), TRACK::GetTrack(), hash_board_item(), MarkTrace(), PCB_EDIT_FRAME::PrintPage(), CN_CONNECTIVITY_ALGO::searchConnections(), PCB_EDIT_FRAME::StartMoveOneNodeOrSegment(), and DRC::testKeepoutAreas().

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 625 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(), and DIALOG_LAYERS_SETUP::showLayerTypes().

626 {
627  if( !IsCopperLayer( aLayer ) )
628  return LT_SIGNAL;
629 
630  //@@IMB: The original test was broken due to the discontinuity
631  // in the layer sequence.
632  if( IsLayerEnabled( aLayer ) )
633  return m_Layer[aLayer].m_type;
634 
635  return LT_SIGNAL;
636 }
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:439
LAYER_T m_type
The type of the layer.
Definition: class_board.h:113
LAYER m_Layer[PCB_LAYER_ID_COUNT]
Definition: class_board.h:183
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 2183 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().

2184 {
2185  for( MODULE* module = m_Modules; module; module = module->Next() )
2186  {
2187  D_PAD* pad = module->GetPad( aPosition, aLayerSet );
2188 
2189  if( pad )
2190  return pad;
2191  }
2192 
2193  // No pad has been located so check for a segment of the trace.
2194  TRACK* segment = ::GetTrack( m_Track, NULL, aPosition, aLayerSet );
2195 
2196  if( !segment )
2197  segment = GetVisibleTrack( m_Track, aPosition, aLayerSet );
2198 
2199  return segment;
2200 }
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:120
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:245
DLIST< TRACK > m_Track
Definition: class_board.h:246
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 321 of file class_board.h.

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

322  {
323  if( (unsigned) index < m_markers.size() )
324  return m_markers[index];
325 
326  return NULL;
327  }
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:178
int BOARD::GetMARKERCount ( ) const
inline

Function GetMARKERCount.

Returns
int - The number of MARKER_PCBS.

Definition at line 333 of file class_board.h.

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

334  {
335  return (int) m_markers.size();
336  }
MARKERS m_markers
MARKER_PCBs for clearance problems, owned by pointer.
Definition: class_board.h:178
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, SCH_GLOBALLABEL, TRACK, SCH_LABEL, DRAWSEGMENT, LIB_FIELD, DIMENSION, TEXTE_MODULE, SCH_SHEET_PIN, SCH_BUS_BUS_ENTRY, SCH_TEXT, SCH_FIELD, SCH_LINE, LIB_ARC, SCH_BUS_WIRE_ENTRY, TEXTE_PCB, SCH_BITMAP, LIB_TEXT, EDGE_MODULE, LIB_POLYLINE, MARKER_PCB, LIB_RECTANGLE, LIB_CIRCLE, PCB_TARGET, SCH_MARKER, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 282 of file base_struct.cpp.

References dummy_xpm.

Referenced by SELECTION_TOOL::disambiguationMenu(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

283 {
284  return dummy_xpm;
285 }
static const BITMAP_OPAQUE dummy_xpm[1]
Definition: base_struct.cpp:56
void BOARD::GetMsgPanelInfo ( 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 1107 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().

1108 {
1109  wxString txt;
1110  int viasCount = 0;
1111  int trackSegmentsCount = 0;
1112 
1113  for( BOARD_ITEM* item = m_Track; item; item = item->Next() )
1114  {
1115  if( item->Type() == PCB_VIA_T )
1116  viasCount++;
1117  else
1118  trackSegmentsCount++;
1119  }
1120 
1121  txt.Printf( wxT( "%d" ), GetPadCount() );
1122  aList.push_back( MSG_PANEL_ITEM( _( "Pads" ), txt, DARKGREEN ) );
1123 
1124  txt.Printf( wxT( "%d" ), viasCount );
1125  aList.push_back( MSG_PANEL_ITEM( _( "Vias" ), txt, DARKGREEN ) );
1126 
1127  txt.Printf( wxT( "%d" ), trackSegmentsCount );
1128  aList.push_back( MSG_PANEL_ITEM( _( "Track Segments" ), txt, DARKGREEN ) );
1129 
1130  txt.Printf( wxT( "%d" ), GetNodesCount() );
1131  aList.push_back( MSG_PANEL_ITEM( _( "Nodes" ), txt, DARKCYAN ) );
1132 
1133  txt.Printf( wxT( "%d" ), m_NetInfo.GetNetCount() );
1134  aList.push_back( MSG_PANEL_ITEM( _( "Nets" ), txt, RED ) );
1135 
1136  txt.Printf( wxT( "%d" ), GetConnectivity()->GetUnconnectedCount() );
1137  aList.push_back( MSG_PANEL_ITEM( _( "Unconnected" ), txt, BLUE ) );
1138 }
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.
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
Definition: colors.h:60
unsigned GetPadCount() const
Function GetPadCount.
TRACK * Next() const
Definition: class_track.h:100
unsigned GetNodesCount() const
Function GetNodesCount.
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
DLIST< TRACK > m_Track
Definition: class_board.h:246
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:290
unsigned BOARD::GetNetCount ( ) const
inline

Function GetNetCount.

Returns
the number of nets (NETINFO_ITEM)

Definition at line 772 of file class_board.h.

References NETINFO_LIST::GetNetCount().

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetsList(), 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().

773  {
774  return m_NetInfo.GetNetCount();
775  }
unsigned GetNetCount() const
Function GetNetCount.
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
NETINFO_LIST& BOARD::GetNetInfo ( )
inline

Definition at line 743 of file class_board.h.

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetsList(), DIALOG_SELECT_NET_FROM_LIST::buildNetsList(), WIDGET_NET_SELECTOR::SetBoard(), and TestForExistingItem().

744  {
745  return m_NetInfo;
746  }
NETINFO_LIST m_NetInfo
net info list (name, design constraints ..
Definition: class_board.h:199
int BOARD_ITEM::getNextNumberInSequence ( const std::set< int > &  aSeq,
bool  aFillSequenceGaps 
)
staticprotectedinherited

Definition at line 224 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

225 {
226  if( aSeq.empty() )
227  return 1;
228 
229  // By default go to the end of the sequence
230  int candidate = *aSeq.rbegin();
231 
232  // Filling in gaps in pad numbering
233  if( aFillSequenceGaps )
234  {
235  // start at the beginning
236  candidate = *aSeq.begin();
237 
238  for( auto it : aSeq )
239  {
240  if( it - candidate > 1 )
241  break;
242 
243  candidate = it;
244  }
245  }
246 
247  ++candidate;
248 
249  return candidate;
250 }
unsigned BOARD::GetNodesCount ( ) const

Function GetNodesCount.

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

Definition at line 1022 of file class_board.cpp.

References m_connectivity.

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

1023 {
1024  return m_connectivity->GetPadCount();
1025 }
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:191
int BOARD::GetNumSegmTrack ( ) const

Functions to get some items count.

Definition at line 1010 of file class_board.cpp.

References DHEAD::GetCount(), and m_Track.

Referenced by PCB_IO::formatGeneral().

1011 {
1012  return m_Track.GetCount();
1013 }
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:246
int BOARD::GetNumSegmZone ( ) const

Calculate the zone segment count.

Definition at line 1016 of file class_board.cpp.

References DHEAD::GetCount(), and m_Zone.

Referenced by PCB_IO::formatGeneral().

1017 {
1018  return m_Zone.GetCount();
1019 }
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
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 2896 of file class_board.cpp.

References m_Modules, and mod.

Referenced by AddNewTrace(), Autoroute_One_Track(), chainMarkedSegments(), CreateLockPoint(), DeleteNullTrackSegments(), Magnetize(), MarkTrace(), and PlaceCells().

2897 {
2898  unsigned count = 0;
2899 
2900  for( MODULE* mod = m_Modules; mod ; mod = mod->Next() ) // FIXME: const DLIST_ITERATOR
2901  {
2902  for( D_PAD* pad = mod->PadsList(); pad; pad = pad->Next() )
2903  {
2904  if( count == aIndex )
2905  return pad;
2906 
2907  count++;
2908  }
2909  }
2910 
2911  return nullptr;
2912 }
DLIST< MODULE > m_Modules
Definition: class_board.h:245
#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 1552 of file class_board.cpp.

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

1553 {
1554  if( !aLayerSet.any() )
1555  aLayerSet = LSET::AllCuMask();
1556 
1557  for( MODULE* module = m_Modules; module; module = module->Next() )
1558  {
1559  D_PAD* pad = module->GetPad( aPosition, aLayerSet );
1560 
1561  if( pad )
1562  return pad;
1563  }
1564 
1565  return NULL;
1566 }
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:673
MODULE * Next() const
Definition: class_module.h:120
DLIST< MODULE > m_Modules
Definition: class_board.h:245
D_PAD* BOARD::GetPad ( const wxPoint aPosition)
inline

Definition at line 1158 of file class_board.h.

1159  {
1160  return GetPad( aPosition, LSET().set() );
1161  }
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 1569 of file class_board.cpp.

References TRACK::GetEndPoint(), BOARD_ITEM::GetLayer(), m_Modules, and MODULE::Next().

1570 {
1571  const wxPoint& aPosition = aTrace->GetEndPoint( aEndPoint );
1572 
1573  LSET lset( aTrace->GetLayer() );
1574 
1575  for( MODULE* module = m_Modules; module; module = module->Next() )
1576  {
1577  D_PAD* pad = module->GetPad( aPosition, lset );
1578 
1579  if( pad )
1580  return pad;
1581  }
1582 
1583  return NULL;
1584 
1585 }
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
MODULE * Next() const
Definition: class_module.h:120
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:127
DLIST< MODULE > m_Modules
Definition: class_board.h:245
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 1624 of file class_board.cpp.

References delta, D_PAD::GetLayerSet(), D_PAD::GetPosition(), wxPoint::x, and wxPoint::y.

1625 {
1626  // Search aPadList for aPosition
1627  // aPadList is sorted by X then Y values, and a fast binary search is used
1628  int idxmax = aPadList.size()-1;
1629 
1630  int delta = aPadList.size();
1631 
1632  int idx = 0; // Starting index is the beginning of list
1633 
1634  while( delta )
1635  {
1636  // Calculate half size of remaining interval to test.
1637  // Ensure the computed value is not truncated (too small)
1638  if( (delta & 1) && ( delta > 1 ) )
1639  delta++;
1640 
1641  delta /= 2;
1642 
1643  D_PAD* pad = aPadList[idx];
1644 
1645  if( pad->GetPosition() == aPosition ) // candidate found
1646  {
1647  // The pad must match the layer mask:
1648  if( ( aLayerSet & pad->GetLayerSet() ).any() )
1649  return pad;
1650 
1651  // More than one pad can be at aPosition
1652  // search for a pad at aPosition that matched this mask
1653 
1654  // search next
1655  for( int ii = idx+1; ii <= idxmax; ii++ )
1656  {
1657  pad = aPadList[ii];
1658 
1659  if( pad->GetPosition() != aPosition )
1660  break;
1661 
1662  if( ( aLayerSet & pad->GetLayerSet() ).any() )
1663  return pad;
1664  }
1665  // search previous
1666  for( int ii = idx-1 ;ii >=0; ii-- )
1667  {
1668  pad = aPadList[ii];
1669 
1670  if( pad->GetPosition() != aPosition )
1671  break;
1672 
1673  if( ( aLayerSet & pad->GetLayerSet() ).any() )
1674  return pad;
1675  }
1676 
1677  // Not found:
1678  return 0;
1679  }
1680 
1681  if( pad->GetPosition().x == aPosition.x ) // Must search considering Y coordinate
1682  {
1683  if( pad->GetPosition().y < aPosition.y ) // Must search after this item
1684  {
1685  idx += delta;
1686 
1687  if( idx > idxmax )
1688  idx = idxmax;
1689  }
1690  else // Must search before this item
1691  {
1692  idx -= delta;
1693 
1694  if( idx < 0 )
1695  idx = 0;
1696  }
1697  }
1698  else if( pad->GetPosition().x < aPosition.x ) // Must search after this item
1699  {
1700  idx += delta;
1701 
1702  if( idx > idxmax )
1703  idx = idxmax;
1704  }
1705  else // Must search before this item
1706  {
1707  idx -= delta;
1708 
1709  if( idx < 0 )
1710  idx = 0;
1711  }
1712  }
1713 
1714  return NULL;
1715 }
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:395
const wxPoint GetPosition() const override
Definition: class_pad.h:220
unsigned BOARD::GetPadCount ( ) const

Function GetPadCount.

Returns
the number of pads in board

Definition at line 2886 of file class_board.cpp.

References m_connectivity.

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

2887 {
2888  return m_connectivity->GetPadCount();
2889 }
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:191
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 1605 of file class_board.cpp.

References mod, and Modules().

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

1606 {
1607  for( auto mod : Modules() )
1608  {
1609  for ( auto pad : mod->Pads() )
1610  {
1611  if( pad->GetPosition() != aPosition )
1612  continue;
1613 
1614  // Pad found, it must be on the correct layer
1615  if( ( pad->GetLayerSet() & aLayerSet ).any() )
1616  return pad;
1617  }
1618 }
1619 
1620  return nullptr;
1621 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:250
#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 2872 of file class_board.cpp.

References mod, and Modules().

Referenced by CreatePadsShapesSection(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), DRC::doTrackDrc(), ReplaceNetlist(), and DRC::testTexts().

2873 {
2874  std::vector<D_PAD*> rv;
2875  for ( auto mod: Modules() )
2876  {
2877  for ( auto pad: mod->Pads() )
2878  rv.push_back ( pad );
2879 
2880  }
2881 
2882  return rv;
2883 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:250
#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(), CmpHoleSorting(), compute_Ratsnest_PlaceModule(), PCB_EDIT_FRAME::createPopUpMenuForFpTexts(), FOOTPRINT_EDIT_FRAME::Delete_Edge_Module(), BOARD_ITEM::DeleteStructure(), PCB_BASE_FRAME::DeleteTextModule(), DIALOG_EDIT_FPTEXT::DIALOG_EDIT_FPTEXT(), KIGFX::PCB_PAINTER::draw(), TEXTE_MODULE::DrawUmbilical(), PCB_EDIT_FRAME::duplicateItems(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), LEGACY_ARRAY_CREATOR::getModule(), EDGE_MODULE::GetMsgPanelInfo(), EDGE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetSelectMenuText(), TEXTE_MODULE::GetShownText(), SELECTION_TOOL::guessSelectionCandidates(), GENERAL_COLLECTOR::Inspect(), 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(), PCB_BASE_FRAME::ResetTextSize(), PCB_BASE_FRAME::RotateTextModule(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SELECTION_TOOL::select(), ShowCurrentOutlineWhileMoving(), ShowNewEdgeModule(), PCB_BASE_FRAME::StartMoveTexteModule(), and SwapItemData().

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

Definition at line 550 of file class_board.h.

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

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

Implements BOARD_ITEM.

Definition at line 138 of file class_board.cpp.

References BOARD_ITEM::ZeroOffset.

139 {
140  wxLogWarning( wxT( "This should not be called on the BOARD object") );
141 
142  return ZeroOffset;
143 }
static wxPoint ZeroOffset
A value of wxPoint(0,0) which can be passed to the Draw() functions.
wxString EDA_ITEM::GetSelectMenuText ( ) const
virtualinherited

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

Definition at line 175 of file base_struct.cpp.

References EDA_ITEM::GetClass().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), SELECTION_TOOL::disambiguationMenu(), DRC::fillMarker(), SCH_FIND_COLLECTOR::GetText(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), and PCB_BASE_FRAME::PcbGeneralLocateAndDisplay().

176 {
177  wxFAIL_MSG( wxT( "GetSelectMenuText() was not overridden for schematic item type " ) +
178  GetClass() );
179 
180  return wxString( wxT( "Undefined menu text for " ) + GetClass() );
181 }
virtual wxString GetClass() const =0
Function GetClass returns the class name.
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 1731 of file class_board.cpp.

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

Referenced by DRC::testPad2Pad().

1732 {
1733  for ( auto mod : Modules() )
1734  {
1735  for ( auto pad : mod->Pads( ) )
1736  {
1737  if( aNetCode < 0 || pad->GetNetCode() == aNetCode )
1738  {
1739  aVector.push_back( pad );
1740  }
1741  }
1742  }
1743 
1744  std::sort( aVector.begin(), aVector.end(), sortPadsByXthenYCoord );
1745 }
DLIST_ITERATOR_WRAPPER< MODULE > Modules()
Definition: class_board.h:250
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 647 of file class_board.h.

References LSET::Name().

Referenced by BOARD(), DIALOG_SVG_PRINT::ExportSVGFile(), PCB_IO::formatLayer(), PCB_IO::formatLayers(), GetLayerID(), BOARD_ITEM::GetLayerName(), and GetLayerName().

648  {
649  // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
650  return LSET::Name( aLayerId );
651  }
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 277 of file base_struct.h.

References EDA_ITEM::m_Status.

Referenced by PCB_IO::format().

277 { return m_Status; }
STATUS_FLAGS m_Status
Definition: base_struct.h:188
TITLE_BLOCK& BOARD::GetTitleBlock ( )
inline

Definition at line 553 of file class_board.h.

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

553 { return m_titles; }
TITLE_BLOCK m_titles
text in lower right of screen and plots
Definition: class_board.h:197
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 1588 of file class_board.cpp.

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

Referenced by SELECTION_TOOL::selectAllItemsOnSheet().

1589 {
1590  std::list<TRACK*> tracks;
1591 
1592  for( TRACK* track = GetFirstTrack( m_Track ); track; track = GetFirstTrack( track->Next() ) )
1593  {
1594  if( ( ( track->GetStart() == aPosition ) || track->GetEnd() == aPosition ) &&
1595  ( track->GetState( BUSY | IS_DELETED ) == 0 ) &&
1596  ( ( aLayer == UNDEFINED_LAYER ) || ( track->IsOnLayer( aLayer ) ) ) )
1597 
1598  tracks.push_back( track );
1599  }
1600 
1601  return tracks;
1602 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:148
#define IS_DELETED
Definition: base_struct.h:130
DLIST< TRACK > m_Track
Definition: class_board.h:246
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:523
int BOARD_ITEM::getTrailingInt ( const wxString &  aStr)
staticprotectedinherited

Definition at line 201 of file class_board_item.cpp.

Referenced by MODULE::GetNextPadName().

202 {
203  int number = 0;
204  int base = 1;
205 
206  // Trim and extract the trailing numeric part
207  int index = aStr.Len() - 1;
208  while( index >= 0 )
209  {
210  const char chr = aStr.GetChar( index );
211 
212  if( chr < '0' || chr > '9' )
213  break;
214 
215  number += ( chr - '0' ) * base;
216  base *= 10;
217  index--;
218  }
219 
220  return number;
221 }
unsigned BOARD::GetUnconnectedNetCount ( ) const

Function GetUnconnectedNetCount.

Returns
the number of unconnected nets in the current ratsnest.

Definition at line 1028 of file class_board.cpp.

References m_connectivity.

Referenced by PCB_EDIT_FRAME::Solve().

1029 {
1030  return m_connectivity->GetUnconnectedCount();
1031 }
std::shared_ptr< CONNECTIVITY_DATA > m_connectivity
Definition: class_board.h:191
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 1538 of file class_board.cpp.

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

1539 {
1540  for( VIA *via = GetFirstVia( m_Track); via; via = GetFirstVia( via->Next() ) )
1541  {
1542  if( (via->GetStart() == aPosition) &&
1543  (via->GetState( BUSY | IS_DELETED ) == 0) &&
1544  ((aLayer == UNDEFINED_LAYER) || (via->IsOnLayer( aLayer ))) )
1545  return via;
1546  }
1547 
1548  return NULL;
1549 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:148
#define IS_DELETED
Definition: base_struct.h:130
DLIST< TRACK > m_Track
Definition: class_board.h:246
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:509
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 759 of file class_board.cpp.

References BOARD_DESIGN_SETTINGS::GetVisibleElements(), and m_designSettings.

760 {
762 }
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:193
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 717 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(), and VIA::ViewGetLOD().

718 {
720 }
BOARD_DESIGN_SETTINGS m_designSettings
Definition: class_board.h:193
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 1754 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().

1756 {
1757  for( TRACK* track = aStartingTrace; track; track = track->Next() )
1758  {
1759  PCB_LAYER_ID layer = track->GetLayer();
1760 
1761  if( track->GetState( BUSY | IS_DELETED ) )
1762  continue;
1763 
1764  // track's layer is not visible
1765  if( m_designSettings.IsLayerVisible( layer ) == false )
1766  continue;
1767 
1768  if( track->Type() == PCB_VIA_T ) // VIA encountered.
1769  {
1770  if( track->HitTest( aPosition ) )
1771  return track;
1772  }
1773  else
1774  {
1775  if( !aLayerSet[layer] )
1776  continue; // track's layer is not in aLayerSet
1777 
1778  if( track->HitTest( aPosition ) )
1779  return track;
1780  }
1781  }
1782 
1783  return NULL;
1784 }
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:148
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:130
TRACK * Next() const
Definition: class_track.h:100
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:193
const ZONE_SETTINGS& BOARD::GetZoneSettings ( ) const
inline
void BOARD::HighLightOFF ( )
inline

Function HighLightOFF Disable highlight.

Definition at line 387 of file class_board.h.

References HIGH_LIGHT_INFO::m_highLightOn.

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

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

Function HighLightON Enable highlight.

if m_highLight_NetCode >= 0, this net will be highlighted

Definition at line 394 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().

394 { m_highLight.m_highLightOn = true; }
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:186
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, TRACK, DIMENSION, TEXTE_MODULE, DRAWSEGMENT, MARKER_PCB, PCB_TARGET, and TEXTE_PCB.

Definition at line 289 of file class_board_item.h.

References EDA_ITEM::HitTest().

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

290  {
291  return EDA_ITEM::HitTest( aPosition );
292  }
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:315
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, TRACK, DIMENSION, TEXTE_MODULE, DRAWSEGMENT, PCB_TARGET, and TEXTE_PCB.

Definition at line 304 of file class_board_item.h.

305  {
306  return false; // derived classes should override this function
307  }
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 1470 of file class_board.cpp.

References BUSY, ZONE_CONTAINER::GetLayer(), BOARD_CONNECTED_ITEM::GetNetCode(), EDA_ITEM::GetState(), ZONE_CONTAINER::HitTestFilledArea(), and m_ZoneDescriptorList.

Referenced by PCB_EDIT_FRAME::Begin_Route().

1472 {
1473  if( aEndLayer < 0 )
1474  aEndLayer = aStartLayer;
1475 
1476  if( aEndLayer < aStartLayer )
1477  std::swap( aEndLayer, aStartLayer );
1478 
1479  for( unsigned ia = 0; ia < m_ZoneDescriptorList.size(); ia++ )
1480  {
1482  LAYER_NUM layer = area->GetLayer();
1483 
1484  if( layer < aStartLayer || layer > aEndLayer )
1485  continue;
1486 
1487  // In locate functions we must skip tagged items with BUSY flag set.
1488  if( area->GetState( BUSY ) )
1489  continue;
1490 
1491  if( aNetCode >= 0 && area->GetNetCode() != aNetCode )
1492  continue;
1493 
1494  if( area->HitTestFilledArea( aRefPos ) )
1495  return area;
1496  }
1497 
1498  return NULL;
1499 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
virtual PCB_LAYER_ID GetLayer() const override
Function GetLayer returns the primary layer this item is on.
Definition: class_zone.cpp:172
#define BUSY
Pcbnew: flag indicating that the structure has.
Definition: base_struct.h:148
int GetState(int type) const
Definition: base_struct.h:264
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
int GetNetCode() const
Function GetNetCode.
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
bool HitTestFilledArea(const wxPoint &aRefPos) const
Function HitTestFilledArea tests if the given wxPoint is within the bounds of a filled area of this z...
Definition: class_zone.cpp:804
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 2317 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().

2319 {
2320  ZONE_CONTAINER* new_area = new ZONE_CONTAINER( this );
2321 
2322  new_area->SetNetCode( aNetcode );
2323  new_area->SetLayer( aLayer );
2324  new_area->SetTimeStamp( GetNewTimeStamp() );
2325 
2326  if( aAreaIdx < (int) ( m_ZoneDescriptorList.size() - 1 ) )
2327  m_ZoneDescriptorList.insert( m_ZoneDescriptorList.begin() + aAreaIdx + 1, new_area );
2328  else
2329  m_ZoneDescriptorList.push_back( new_area );
2330 
2331  new_area->SetHatchStyle( (ZONE_CONTAINER::HATCH_STYLE) aHatch );
2332 
2333  // Add the first corner to the new zone
2334  new_area->AppendCorner( wxPoint( aCornerX, aCornerY ), -1 );
2335 
2336  return new_area;
2337 }
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:60
timestamp_t GetNewTimeStamp()
Definition: common.cpp:166
virtual void SetLayer(PCB_LAYER_ID aLayer) override
Function SetLayer sets the layer this item is on.
Definition: class_zone.cpp:199
bool SetNetCode(int aNetCode, bool aNoAssert=false)
Function SetNetCode sets net using a net code.
HATCH_STYLE
Zone hatch styles.
Definition: class_zone.h:67
ZONE_CONTAINERS m_ZoneDescriptorList
edge zone descriptors, owned by pointer.
Definition: class_board.h:181
void SetHatchStyle(HATCH_STYLE aStyle)
Definition: class_zone.h:503
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:230
bool EDA_ITEM::IsBrightened ( ) const
inlineinherited

Definition at line 251 of file base_struct.h.

References BRIGHTENED.

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

251 { return m_Flags & BRIGHTENED; }
#define BRIGHTENED
item is drawn with a bright contour
Definition: base_struct.h:151
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:202
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 CONNECTIVITY_DATA::MarkItemNetAsDirty(), and CN_CONNECTIVITY_ALGO::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 765 of file class_board.cpp.

References BOARD_DESIGN_SETTINGS::IsElementVisible(), and m_designSettings.

Referenced by Abort_MoveOrCopyModule(), TEXTE_PCB::Draw(), TEXTE_MODULE::Draw(), MODULE::Draw(), VIA::Draw(), D_PAD::Draw(), Draw(), PCB_BASE_FRAME::GetCollectorsGuide(), DIALOG_GENERALOPTIONS::init(), FOOTPRINT_EDIT_FRAME::IsElementVisible(), PCB_EDIT_FRAME::IsElementVisible(), IsModuleLayerVisible(), DIALOG_GENERALOPTIONS::OnOkClick(), DIALOG_EXCHANGE_MODULE::OnOkClick(), PCB_EDIT_FRAME::OnPlaceOrRouteFootprints(), PCB_LAYER_WIDGET::OnRenderEnable(), FOOTPRINT_EDIT_FRAME::PrintPage(), PCB_EDIT_FRAME::PrintPage(), PCB_LAYER_WIDGET::ReFillRender(), SELECTION_TOOL::selectable(), SetElementVisibility(), PCB_DRAW_PANEL_GAL::SyncLayersVisibility(), and PCB_LAYER_WIDGET::SyncRenderStates().

766 {
767  return m_designSettings.IsElementVisible( aLayer );
768 }
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:193
bool BOARD::IsEmpty ( ) const
inline

Definition at line 268 of file class_board.h.

References DHEAD::GetCount().

Referenced by BOARD_NETLIST_UPDATER::estimateComponentInsertionPosition(), DIALOG_NETLIST::OnReadNetlistFileClick(), and ReplaceNetlist().

269  {
270  return m_Drawings.GetCount() == 0 && m_Modules.GetCount() == 0 &&
271  m_Track.GetCount() == 0 && m_Zone.GetCount() == 0;
272  }
DLIST< SEGZONE > m_Zone
Definition: class_board.h:247
DLIST< BOARD_ITEM > m_Drawings
Definition: class_board.h:241
DLIST< MODULE > m_Modules
Definition: class_board.h:245
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:246
bool EDA_ITEM::IsHighlighted ( ) const
inlineinherited

Definition at line 250 of file base_struct.h.

References HIGHLIGHTED.

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

Function IsHighLightNetON.

Returns
true if a net is currently highlighted

Definition at line 381 of file class_board.h.

References HIGH_LIGHT_INFO::m_highLightOn.

Referenced by Abort_Create_Track(), Draw(), DrawHighLight(), PCB_EDIT_FRAME::End_Route(), PCB_EDIT_FRAME::Start_Move_Zone_Corner(), and PCB_EDIT_FRAME::Start_Move_Zone_Outlines().

381 { return m_highLight.m_highLightOn; }
HIGH_LIGHT_INFO m_highLight
Definition: class_board.h:186
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 439 of file class_board.h.

References BOARD_DESIGN_SETTINGS::IsLayerEnabled().

Referenced by DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), GetLayerName(), GetLayerType(), PCB_LAYER_SELECTOR::IsLayerEnabled(), PCB_LAYER_BOX_SELECTOR::IsLayerEnabled(), DIALOG_DIMENSION_EDITOR::OnOKClick(), SetLayerName(), SetLayerType(), and DIALOG_EDIT_FPTEXT::TransferDataToWindow().

440  {
441  return m_designSettings.IsLayerEnabled( aLayer );
442  }
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:193
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 451 of file class_board.h.

References BOARD_DESIGN_SETTINGS::IsLayerVisible().

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

452  {
453  return m_designSettings.IsLayerVisible( aLayer );
454  }
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:193
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(), 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 244 of file base_struct.h.

References IS_CHANGED.

Referenced by LIB_EDIT_FRAME::OnEditPin().

244 { return m_Flags & IS_CHANGED; }
#define IS_CHANGED
std::function passed to nested users by ref, avoids copying std::function
Definition: base_struct.h:123
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:202
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 817 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().

818 {
819  switch( aLayer )
820  {
821  case F_Cu:
822  return IsElementVisible( LAYER_MOD_FR );
823 
824  case B_Cu:
825  return IsElementVisible( LAYER_MOD_BK );
826 
827  default:
828  wxFAIL_MSG( wxT( "BOARD::IsModuleLayerVisible() param error: bad layer" ) );
829  return true;
830  }
831 }
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 243 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(), abortMoveBitmap(), abortMoveItem(), AbortPinMove(), AbortSymbolTraceOn(), SCH_EDIT_FRAME::addCurrentItemToList(), 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(), DrawMovePin(), SCH_EDIT_FRAME::EditSheetPin(), LIB_PIN::EnableEditMode(), LIB_EDIT_FRAME::EndDrawGraphicItem(), SCH_EDIT_FRAME::EndSegment(), ExitSheet(), LIB_PART::LIB_PART(), 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(), LIB_EDIT_FRAME::OnLeftDClick(), SCH_EDIT_FRAME::OnLeftDClick(), PCB_EDIT_FRAME::OnLeftDClick(), LIB_EDIT_FRAME::OnRightClick(), SCH_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(), and DIALOG_LABEL_EDITOR::TextPropertiesAccept().

243 { return m_Flags & IS_NEW; }
#define IS_NEW
New item, just created.
Definition: base_struct.h:127
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:202
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 CINFO3D_VISU::createLayers(), TEXTE_PCB::Draw(), EDGE_MODULE::Draw(), TEXTE_MODULE::Draw(), TRACK::Draw(), DRAWSEGMENT::Draw(), SEGZONE::Draw(), TRACK::DrawShortNetname(), GENERAL_COLLECTOR::Inspect(), ZONE_CONTAINER::IsOnLayer(), SELECTION_TOOL::selectable(), 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 471 of file base_struct.h.

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

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

Definition at line 249 of file base_struct.h.

References IS_RESIZED.

Referenced by ExitSheet().

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

Definition at line 248 of file base_struct.h.

References SELECTED.

Referenced by SCH_SCREEN::addConnectedItemsToBlock(), AddMenusForPin(), KIGFX::PCB_PAINTER::draw(), LIB_CIRCLE::drawGraphic(), LIB_POLYLINE::drawGraphic(), LIB_RECTANGLE::drawGraphic(), LIB_BEZIER::drawGraphic(), LIB_TEXT::drawGraphic(), LIB_ARC::drawGraphic(), LIB_FIELD::drawGraphic(), DrawMovingBlockOutlines(), LIB_PIN::DrawPinElectricalTypeName(), LIB_PIN::DrawPinSymbol(), LIB_PIN::DrawPinTexts(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), LIB_EDIT_FRAME::GlobalSetPins(), 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(), MirrorMarkedItems(), MoveMarkedItems(), MoveMarkedItemsExactly(), LIB_TEXT::Plot(), RotateMarkedItems(), SELECTION_TOOL::SanitizeSelection(), GERBVIEW_SELECTION_TOOL::select(), SELECTION_TOOL::select(), SCH_SCREEN::SelectBlockItems(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), GERBVIEW_SELECTION_TOOL::unselect(), and SELECTION_TOOL::unselect().

248 { return m_Flags & SELECTED; }
#define SELECTED
Definition: base_struct.h:134
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:202
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:225
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::IsWireImage ( ) const
inlineinherited

Definition at line 247 of file base_struct.h.

References IS_WIRE_IMAGE.

Referenced by abortMoveItem(), and SCH_FIELD::Draw().

247 { return m_Flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: base_struct.h:131
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:202
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 132 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(), GERBER_FILE_IMAGE::Visit(), MODULE::Visit(), and Visit().

136 {
137  EDA_ITEM* p = listStart;
138 
139  for( ; p; p = p->Pnext )
140  {
141  if( SEARCH_QUIT == p->Visit( inspector, testData, scanTypes ) )
142  return SEARCH_QUIT;
143  }
144 
145  return SEARCH_CONTINUE;
146 }
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:178
EDA_ITEM * Pnext
next in linked list
Definition: base_struct.h:191
TRACK * BOARD::MarkTrace ( 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
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 edition/deletion) 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 1810 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(), m_Track, 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().

1813 {
1814  TRACKS trackList;
1815 
1816  if( aCount )
1817  *aCount = 0;
1818 
1819  if( aTraceLength )
1820  *aTraceLength = 0;
1821 
1822  if( aTrace == NULL )
1823  return NULL;
1824 
1825  // Ensure the flag BUSY of all tracks of the board is cleared
1826  // because we use it to mark segments of the track
1827  for( TRACK* track = m_Track; track; track = track->Next() )
1828  track->SetState( BUSY, false );
1829 
1830  // Set flags of the initial track segment
1831  aTrace->SetState( BUSY, true );
1832  LSET layer_set = aTrace->GetLayerSet();
1833 
1834  trackList.push_back( aTrace );
1835 
1836  /* Examine the initial track segment : if it is really a segment, this is
1837  * easy.
1838  * If it is a via, one must search for connected segments.
1839  * If <=2, this via connect 2 segments (or is connected to only one
1840  * segment) and this via and these 2 segments are a part of a track.
1841  * If > 2 only this via is flagged (the track has only this via)
1842  */
1843  if( aTrace->Type() == PCB_VIA_T )
1844  {
1845  TRACK* segm1 = ::GetTrack( m_Track, NULL, aTrace->GetStart(), layer_set );
1846  TRACK* segm2 = NULL;
1847  TRACK* segm3 = NULL;
1848 
1849  if( segm1 )
1850  {
1851  segm2 = ::GetTrack( segm1->Next(), NULL, aTrace->GetStart(), layer_set );
1852  }
1853 
1854  if( segm2 )
1855  {
1856  segm3 = ::GetTrack( segm2->Next(), NULL, aTrace->GetStart(), layer_set );
1857  }
1858 
1859  if( segm3 )
1860  {
1861  // More than 2 segments are connected to this via.
1862  // The "track" is only this via.
1863 
1864  if( aCount )
1865  *aCount = 1;
1866 
1867  return aTrace;
1868  }
1869 
1870  if( segm1 ) // search for other segments connected to the initial segment start point
1871  {
1872  layer_set = segm1->GetLayerSet();
1873  chainMarkedSegments( aTrace->GetStart(), layer_set, &trackList );
1874  }
1875 
1876  if( segm2 ) // search for other segments connected to the initial segment end point
1877  {
1878  layer_set = segm2->GetLayerSet();
1879  chainMarkedSegments( aTrace->GetStart(), layer_set, &trackList );
1880  }
1881  }
1882  else // mark the chain using both ends of the initial segment
1883  {
1884  TRACKS from_start;
1885  TRACKS from_end;
1886 
1887  chainMarkedSegments( aTrace->GetStart(), layer_set, &from_start );
1888  chainMarkedSegments( aTrace->GetEnd(), layer_set, &from_end );
1889 
1890  // combine into one trackList:
1891  trackList.insert( trackList.end(), from_start.begin(), from_start.end() );
1892  trackList.insert( trackList.end(), from_end.begin(), from_end.end() );
1893  }
1894 
1895  // Now examine selected vias and flag them if they are on the track
1896  // If a via is connected to only one or 2 segments, it is flagged (is on the track)
1897  // If a via is connected to more than 2 segments, it is a track end, and it
1898  // is removed from the list.
1899  // Go through the list backwards.
1900  for( int i = trackList.size() - 1; i>=0; --i )
1901  {
1902  ::VIA* via = dynamic_cast< ::VIA* >( trackList[i] );
1903 
1904  if( !via )
1905  continue;
1906 
1907  if( via == aTrace )
1908  continue;
1909 
1910  via->SetState( BUSY, true ); // Try to flag it. the flag will be cleared later if needed
1911 
1912  layer_set = via->GetLayerSet();
1913 
1914  TRACK* track = ::GetTrack( m_Track, NULL, via->GetStart(), layer_set );
1915 
1916  // GetTrace does not consider tracks flagged BUSY.
1917  // So if no connected track found, this via is on the current track
1918  // only: keep it
1919  if( track == NULL )
1920  continue;
1921 
1922  /* If a track is found, this via connects also other segments of
1923  * another track. This case happens when a via ends the selected
1924  * track but must we consider this via is on the selected track, or
1925  * on another track.
1926  * (this is important when selecting a track for deletion: must this
1927  * via be deleted or not?)
1928  * We consider this via to be on our track if other segments connected
1929  * to this via remain connected when removing this via.
1930  * We search for all other segments connected together:
1931  * if they are on the same layer, then the via is on the selected track;
1932  * if they are on different layers, the via is on another track.
1933  */
1934  LAYER_NUM layer = track->GetLayer();
1935 
1936  while( ( track = ::GetTrack( track->Next(), NULL, via->GetStart(), layer_set ) ) != NULL )
1937  {
1938  if( layer != track->GetLayer() )
1939  {
1940  // The via connects segments of another track: it is removed
1941  // from list because it is member of another track
1942  via->SetState( BUSY, false );
1943  break;
1944  }
1945  }
1946  }
1947 
1948  /* Rearrange the track list in order to have flagged segments linked
1949  * from firstTrack so the NbSegmBusy segments are consecutive segments
1950  * in list, the first item in the full track list is firstTrack, and
1951  * the NbSegmBusy-1 next items (NbSegmBusy when including firstTrack)
1952  * are the flagged segments
1953  */
1954  int busy_count = 0;
1955  TRACK* firstTrack;
1956 
1957  for( firstTrack = m_Track; firstTrack; firstTrack = firstTrack->Next() )
1958  {
1959  // Search for the first flagged BUSY segments
1960  if( firstTrack->GetState( BUSY ) )
1961  {
1962  busy_count = 1;
1963  break;
1964  }
1965  }
1966 
1967  if( firstTrack == NULL )
1968  return NULL;
1969 
1970  // First step: calculate the track length and find the pads (when exist)
1971  // at each end of the trace.
1972  double full_len = 0;
1973  double lenPadToDie = 0;
1974  // Because we have a track (a set of track segments between 2 nodes),
1975  // only 2 pads (maximum) will be taken in acc