KiCad PCB EDA Suite
class_board.cpp File Reference

BOARD class functions. More...

#include <algorithm>
#include <iterator>
#include <fctsys.h>
#include <common.h>
#include <kicad_string.h>
#include <pcb_base_frame.h>
#include <msgpanel.h>
#include <reporter.h>
#include <ratsnest_data.h>
#include <ratsnest_viewitem.h>
#include <ws_proxy_view_item.h>
#include <pcbnew.h>
#include <collectors.h>
#include <class_board.h>
#include <class_module.h>
#include <class_track.h>
#include <class_zone.h>
#include <class_marker_pcb.h>
#include <class_drawsegment.h>
#include <class_pcb_target.h>
#include <connectivity/connectivity_data.h>
#include <pgm_base.h>

Go to the source code of this file.

Classes

class  DELETED_BOARD_ITEM
 A singleton item of this class is returned for a weak reference that no longer exists. More...
 

Functions

static bool sortNetsByNodes (const NETINFO_ITEM *a, const NETINFO_ITEM *b)
 
static bool sortNetsByNames (const NETINFO_ITEM *a, const NETINFO_ITEM *b)
 
bool sortPadsByXthenYCoord (D_PAD *const &ref, D_PAD *const &comp)
 Function SortPadsByXCoord is used by GetSortedPadListByXCoord to Sort a pad list by x coordinate value. More...
 
bool BuildBoardPolygonOutlines (BOARD *aBoard, SHAPE_POLY_SET &aOutlines, wxString *aErrorText, unsigned int aTolerance, wxPoint *aErrorLocation=nullptr)
 

Variables

DELETED_BOARD_ITEM g_DeletedItem
 
static PCB_GENERAL_SETTINGS dummyGeneralSettings (FRAME_PCB_EDITOR)
 
static std::vector< int > padCountListByNet
 

Detailed Description

BOARD class functions.

Definition in file class_board.cpp.

Function Documentation

◆ BuildBoardPolygonOutlines()

bool BuildBoardPolygonOutlines ( BOARD aBoard,
SHAPE_POLY_SET aOutlines,
wxString *  aErrorText,
unsigned int  aTolerance,
wxPoint *  aErrorLocation = nullptr 
)

Definition at line 749 of file convert_drawsegment_list_to_polygon.cpp.

751 {
752  PCB_TYPE_COLLECTOR items;
753 
754  // Get all the DRAWSEGMENTS and module graphics into 'items',
755  // then keep only those on layer == Edge_Cuts.
756  static const KICAD_T scan_graphics[] = { PCB_LINE_T, PCB_MODULE_EDGE_T, EOT };
757  items.Collect( aBoard, scan_graphics );
758 
759  // Make a working copy of aSegList, because the list is modified during calculations
760  std::vector< DRAWSEGMENT* > segList;
761 
762  for( int ii = 0; ii < items.GetCount(); ii++ )
763  {
764  if( items[ii]->GetLayer() == Edge_Cuts )
765  segList.push_back( static_cast< DRAWSEGMENT* >( items[ii] ) );
766  }
767 
768  bool success = ConvertOutlineToPolygon( segList, aOutlines, aErrorText, aTolerance, aErrorLocation );
769 
770  if( !success || !aOutlines.OutlineCount() )
771  {
772  // Creates a valid polygon outline is not possible.
773  // So uses the board edge cuts bounding box to create a
774  // rectangular outline
775  // When no edge cuts items, build a contour
776  // from global bounding box
777 
778  EDA_RECT bbbox = aBoard->GetBoardEdgesBoundingBox();
779 
780  // If null area, uses the global bounding box.
781  if( ( bbbox.GetWidth() ) == 0 || ( bbbox.GetHeight() == 0 ) )
782  bbbox = aBoard->ComputeBoundingBox();
783 
784  // Ensure non null area. If happen, gives a minimal size.
785  if( ( bbbox.GetWidth() ) == 0 || ( bbbox.GetHeight() == 0 ) )
786  bbbox.Inflate( Millimeter2iu( 1.0 ) );
787 
788  aOutlines.RemoveAllContours();
789  aOutlines.NewOutline();
790 
791  wxPoint corner;
792  aOutlines.Append( bbbox.GetOrigin() );
793 
794  corner.x = bbbox.GetOrigin().x;
795  corner.y = bbbox.GetEnd().y;
796  aOutlines.Append( corner );
797 
798  aOutlines.Append( bbbox.GetEnd() );
799 
800  corner.x = bbbox.GetEnd().x;
801  corner.y = bbbox.GetOrigin().y;
802  aOutlines.Append( corner );
803  }
804 
805  return success;
806 }
int OutlineCount() const
Returns the number of outlines in the set
const EDA_RECT GetBoardEdgesBoundingBox() const
Function GetBoardEdgesBoundingBox Returns the board bounding box calculated using exclusively the boa...
Definition: class_board.h:792
int GetWidth() const
Definition: eda_rect.h:119
bool ConvertOutlineToPolygon(std::vector< DRAWSEGMENT * > &aSegList, SHAPE_POLY_SET &aPolygons, wxString *aErrorText, unsigned int aTolerance, wxPoint *aErrorLocation)
Function ConvertOutlineToPolygon build a polygon (with holes) from a DRAWSEGMENT list,...
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
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
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:113
const wxPoint GetEnd() const
Definition: eda_rect.h:116
const wxPoint GetOrigin() const
Definition: eda_rect.h:114
int NewOutline()
Creates a new empty polygon in the set and returns its index
void Collect(BOARD_ITEM *aBoard, const KICAD_T aScanList[])
Collect BOARD_ITEM objects using this class's Inspector method, which does the collection.
Definition: collectors.cpp:519
int GetHeight() const
Definition: eda_rect.h:120
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
static bool GetLayer(MODEL_VRML &aModel, LAYER_NUM layer, VRML_LAYER **vlayer)
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge seg...
Collect all BOARD_ITEM objects of a given set of KICAD_T type(s).
Definition: collectors.h:621
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline)

Referenced by BOARD::GetBoardPolygonOutlines().

◆ sortNetsByNames()

static bool sortNetsByNames ( const NETINFO_ITEM a,
const NETINFO_ITEM b 
)
static

Definition at line 1116 of file class_board.cpp.

1117 {
1118  return a->GetNetname() < b->GetNetname();
1119 }
const wxString & GetNetname() const
Function GetNetname.
Definition: netinfo.h:233

References NETINFO_ITEM::GetNetname().

Referenced by BOARD::SortedNetnamesList().

◆ sortNetsByNodes()

static bool sortNetsByNodes ( const NETINFO_ITEM a,
const NETINFO_ITEM b 
)
static

Definition at line 1104 of file class_board.cpp.

1105 {
1106  int countA = padCountListByNet[a->GetNet()];
1107  int countB = padCountListByNet[b->GetNet()];
1108 
1109  if( countA == countB )
1110  return a->GetNetname() < b->GetNetname();
1111  else
1112  return countB < countA;
1113 }
const wxString & GetNetname() const
Function GetNetname.
Definition: netinfo.h:233
int GetNet() const
Function GetNet.
Definition: netinfo.h:225
static std::vector< int > padCountListByNet

References NETINFO_ITEM::GetNet(), NETINFO_ITEM::GetNetname(), and padCountListByNet.

Referenced by BOARD::SortedNetnamesList().

◆ sortPadsByXthenYCoord()

bool sortPadsByXthenYCoord ( D_PAD *const &  ref,
D_PAD *const &  comp 
)

Function SortPadsByXCoord is used by GetSortedPadListByXCoord to Sort a pad list by x coordinate value.

This function is used to build ordered pads lists

Definition at line 1382 of file class_board.cpp.

1383 {
1384  if( ref->GetPosition().x == comp->GetPosition().x )
1385  return ref->GetPosition().y < comp->GetPosition().y;
1386  return ref->GetPosition().x < comp->GetPosition().x;
1387 }
const wxPoint GetPosition() const override
Definition: class_pad.h:225

References D_PAD::GetPosition().

Referenced by BOARD::GetSortedPadListByXthenYCoord().

Variable Documentation

◆ dummyGeneralSettings

PCB_GENERAL_SETTINGS dummyGeneralSettings(FRAME_PCB_EDITOR)
static

Referenced by BOARD::BOARD().

◆ g_DeletedItem

DELETED_BOARD_ITEM g_DeletedItem

Definition at line 87 of file class_board.cpp.

Referenced by BOARD::GetItem().

◆ padCountListByNet

std::vector<int> padCountListByNet
static

Definition at line 1100 of file class_board.cpp.

Referenced by BOARD::SortedNetnamesList(), and sortNetsByNodes().