KiCad PCB EDA Suite
Loading...
Searching...
No Matches
convert_shape_list_to_polygon.cpp File Reference
#include <unordered_set>
#include <deque>
#include <trigo.h>
#include <macros.h>
#include <math/vector2d.h>
#include <pcb_shape.h>
#include <footprint.h>
#include <pad.h>
#include <base_units.h>
#include <convert_basic_shapes_to_polygon.h>
#include <geometry/shape_poly_set.h>
#include <geometry/geometry_utils.h>
#include <geometry/roundrect.h>
#include <convert_shape_list_to_polygon.h>
#include <board.h>
#include <collectors.h>
#include <nanoflann.hpp>
#include <wx/log.h>

Go to the source code of this file.

Classes

class  SCOPED_FLAGS_CLEANER
 
struct  PCB_SHAPE_ENDPOINTS_ADAPTOR
 

Typedefs

using KDTree
 

Functions

static bool close_enough (VECTOR2I aLeft, VECTOR2I aRight, unsigned aLimit)
 Local and tunable method of qualifying the proximity of two points.
 
static bool closer_to_first (VECTOR2I aRef, VECTOR2I aFirst, VECTOR2I aSecond)
 Local method which qualifies whether the start or end point of a segment is closest to a point.
 
static bool isCopperOutside (const FOOTPRINT *aFootprint, SHAPE_POLY_SET &aShape)
 
static void processClosedShape (PCB_SHAPE *aShape, SHAPE_LINE_CHAIN &aContour, std::map< std::pair< VECTOR2I, VECTOR2I >, PCB_SHAPE * > &aShapeOwners, int aErrorMax, bool aAllowUseArcsInPolygons)
 
static void processShapeSegment (PCB_SHAPE *aShape, SHAPE_LINE_CHAIN &aContour, VECTOR2I &aPrevPt, std::map< std::pair< VECTOR2I, VECTOR2I >, PCB_SHAPE * > &aShapeOwners, int aErrorMax, int aChainingEpsilon, bool aAllowUseArcsInPolygons)
 
static std::map< int, std::vector< int > > buildContourHierarchy (const std::vector< SHAPE_LINE_CHAIN > &aContours)
 
static bool addOutlinesToPolygon (const std::vector< SHAPE_LINE_CHAIN > &aContours, const std::map< int, std::vector< int > > &aContourHierarchy, SHAPE_POLY_SET &aPolygons, bool aAllowDisjoint, OUTLINE_ERROR_HANDLER *aErrorHandler, const std::function< PCB_SHAPE *(const SEG &)> &aFetchOwner, std::map< int, int > &aContourToOutlineIdxMap)
 
static void addHolesToPolygon (const std::vector< SHAPE_LINE_CHAIN > &aContours, const std::map< int, std::vector< int > > &aContourHierarchy, const std::map< int, int > &aContourToOutlineIdxMap, SHAPE_POLY_SET &aPolygons)
 
static bool checkSelfIntersections (SHAPE_POLY_SET &aPolygons, OUTLINE_ERROR_HANDLER *aErrorHandler, const std::function< PCB_SHAPE *(const SEG &)> &aFetchOwner)
 
static PCB_SHAPEfindNext (PCB_SHAPE *aShape, const VECTOR2I &aPoint, const KDTree &kdTree, const PCB_SHAPE_ENDPOINTS_ADAPTOR &adaptor, double aChainingEpsilon)
 
bool doConvertOutlineToPolygon (std::vector< PCB_SHAPE * > &aShapeList, SHAPE_POLY_SET &aPolygons, int aErrorMax, int aChainingEpsilon, bool aAllowDisjoint, OUTLINE_ERROR_HANDLER *aErrorHandler, bool aAllowUseArcsInPolygons, SCOPED_FLAGS_CLEANER &aCleaner)
 
bool ConvertOutlineToPolygon (std::vector< PCB_SHAPE * > &aShapeList, SHAPE_POLY_SET &aPolygons, int aErrorMax, int aChainingEpsilon, bool aAllowDisjoint, OUTLINE_ERROR_HANDLER *aErrorHandler, bool aAllowUseArcsInPolygons)
 Build a polygon set with holes from a PCB_SHAPE list.
 
bool TestBoardOutlinesGraphicItems (BOARD *aBoard, int aMinDist, OUTLINE_ERROR_HANDLER *aErrorHandler)
 Test a board graphic items on edge cut layer for validity.
 
bool BuildBoardPolygonOutlines (BOARD *aBoard, SHAPE_POLY_SET &aOutlines, int aErrorMax, int aChainingEpsilon, OUTLINE_ERROR_HANDLER *aErrorHandler, bool aAllowUseArcsInPolygons)
 Extract the board outlines and build a closed polygon from lines, arcs and circle items on edge cut layer.
 
void buildBoardBoundingBoxPoly (const BOARD *aBoard, SHAPE_POLY_SET &aOutline)
 Get the complete bounding box of the board (including all items).
 
VECTOR2I projectPointOnSegment (const VECTOR2I &aEndPoint, const SHAPE_POLY_SET &aOutline, int aOutlineNum=0)
 
int findEndSegments (SHAPE_LINE_CHAIN &aChain, SEG &aStartSeg, SEG &aEndSeg)
 
bool BuildFootprintPolygonOutlines (BOARD *aBoard, SHAPE_POLY_SET &aOutlines, int aErrorMax, int aChainingEpsilon, OUTLINE_ERROR_HANDLER *aErrorHandler)
 Extract a board outline for a footprint view.
 

Variables

const wxChar * traceBoardOutline = wxT( "KICAD_BOARD_OUTLINE" )
 Flag to enable debug tracing for the board outline creation.
 

Typedef Documentation

◆ KDTree

using KDTree
Initial value:
nanoflann::KDTreeSingleIndexAdaptor<nanoflann::L2_Simple_Adaptor<double, PCB_SHAPE_ENDPOINTS_ADAPTOR>,
2 >

Definition at line 173 of file convert_shape_list_to_polygon.cpp.

Function Documentation

◆ addHolesToPolygon()

static void addHolesToPolygon ( const std::vector< SHAPE_LINE_CHAIN > & aContours,
const std::map< int, std::vector< int > > & aContourHierarchy,
const std::map< int, int > & aContourToOutlineIdxMap,
SHAPE_POLY_SET & aPolygons )
static

Definition at line 435 of file convert_shape_list_to_polygon.cpp.

References SHAPE_POLY_SET::AddHole().

Referenced by doConvertOutlineToPolygon().

◆ addOutlinesToPolygon()

static bool addOutlinesToPolygon ( const std::vector< SHAPE_LINE_CHAIN > & aContours,
const std::map< int, std::vector< int > > & aContourHierarchy,
SHAPE_POLY_SET & aPolygons,
bool aAllowDisjoint,
OUTLINE_ERROR_HANDLER * aErrorHandler,
const std::function< PCB_SHAPE *(const SEG &)> & aFetchOwner,
std::map< int, int > & aContourToOutlineIdxMap )
static

◆ buildBoardBoundingBoxPoly()

void buildBoardBoundingBoxPoly ( const BOARD * aBoard,
SHAPE_POLY_SET & aOutline )

Get the complete bounding box of the board (including all items).

The vertex numbers and segment numbers of the rectangle returned. 1 ------------— |1 2| 0| |2 |0 3| ------------— 3

Definition at line 1114 of file convert_shape_list_to_polygon.cpp.

References SHAPE_POLY_SET::AddOutline(), chain, BOARD::ComputeBoundingBox(), BOARD::GetBoundingBox(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Inflate(), pcbIUScale, SHAPE_POLY_SET::RemoveAllContours(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BuildFootprintPolygonOutlines(), and RENDER_3D_RAYTRACE_BASE::Reload().

◆ BuildBoardPolygonOutlines()

bool BuildBoardPolygonOutlines ( BOARD * aBoard,
SHAPE_POLY_SET & aOutlines,
int aErrorMax,
int aChainingEpsilon,
OUTLINE_ERROR_HANDLER * aErrorHandler = nullptr,
bool aAllowUseArcsInPolygons = false )

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

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

Parameters
aBoardis the board to build outlines.
aOutlineswill contain the outlines ( complex polygons ).
aErrorMaxis the max error distance when polygonizing a curve (internal units).
aChainingEpsilonis the max distance from one endPt to the next startPt (internal units),
aErrorHandler= an optional error handler.
aAllowUseArcsInPolygonsis an option to allow adding arcs in SHAPE_LINE_CHAIN polylines/polygons when building outlines from aShapeList This is mainly for export to STEP files.
Returns
true if success, false if a contour is not valid.

Definition at line 972 of file convert_shape_list_to_polygon.cpp.

References SHAPE_POLY_SET::AddHole(), SHAPE_POLY_SET::Append(), PCB_TYPE_COLLECTOR::Collect(), BOARD::ComputeBoundingBox(), SHAPE_LINE_CHAIN::CPoint(), doConvertOutlineToPolygon(), Edge_Cuts, BOARD::Footprints(), BOARD::GetBoardEdgesBoundingBox(), COLLECTOR::GetCount(), BOX2< Vec >::GetEnd(), EDA_ITEM::GetFlags(), BOX2< Vec >::GetHeight(), PCB_SHAPE::GetLayer(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Inflate(), isCopperOutside(), SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PCB_SHAPE_T, pcbIUScale, SHAPE_LINE_CHAIN_BASE::PointInside(), SHAPE_POLY_SET::RemoveAllContours(), SKIP_STRUCT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOARD::GetBoardPolygonOutlines(), DIALOG_EXPORT_STEP::onExportButton(), and DRC_TEST_PROVIDER_MISC::testOutline().

◆ buildContourHierarchy()

static std::map< int, std::vector< int > > buildContourHierarchy ( const std::vector< SHAPE_LINE_CHAIN > & aContours)
static

◆ BuildFootprintPolygonOutlines()

bool BuildFootprintPolygonOutlines ( BOARD * aBoard,
SHAPE_POLY_SET & aOutlines,
int aErrorMax,
int aChainingEpsilon,
OUTLINE_ERROR_HANDLER * aErrorHandler = nullptr )

Extract a board outline for a footprint view.

  • Incomplete outlines will be closed by joining the end of the outline onto the bounding box (by simply projecting the end points) and then take the area that contains the copper.
  • If all copper lies inside a closed outline, than that outline will be treated as an external board outline.
  • If copper is located outside a closed outline, then that outline will be treated as a hole, and the outer edge will be formed using the bounding box.

Definition at line 1216 of file convert_shape_list_to_polygon.cpp.

References SHAPE_POLY_SET::AddHole(), SHAPE_LINE_CHAIN::Append(), SHAPE_POLY_SET::Append(), buildBoardBoundingBoxPoly(), chain, PCB_TYPE_COLLECTOR::Collect(), SEG::Contains(), doConvertOutlineToPolygon(), Edge_Cuts, findEndSegments(), COLLECTOR::GetCount(), BOARD::GetFirstFootprint(), SHAPE_LINE_CHAIN::GetPoint(), SHAPE_POLY_SET::Hole(), SHAPE_POLY_SET::HoleCount(), SEG::IntersectLines(), SHAPE_LINE_CHAIN::IsClosed(), isCopperOutside(), SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PCB_SHAPE_T, SHAPE_LINE_CHAIN::Segment(), SHAPE_LINE_CHAIN::SetClosed(), SKIP_STRUCT, and traceBoardOutline.

Referenced by BOARD_ADAPTER::createBoardPolygon().

◆ checkSelfIntersections()

◆ close_enough()

static bool close_enough ( VECTOR2I aLeft,
VECTOR2I aRight,
unsigned aLimit )
static

Local and tunable method of qualifying the proximity of two points.

Parameters
aLeftis the first point.
aRightis the second point.
aLimitis a measure of proximity that the caller knows about.
Returns
true if the two points are close enough, else false.

Definition at line 83 of file convert_shape_list_to_polygon.cpp.

References SEG::Square().

Referenced by doConvertOutlineToPolygon(), and processShapeSegment().

◆ closer_to_first()

static bool closer_to_first ( VECTOR2I aRef,
VECTOR2I aFirst,
VECTOR2I aSecond )
static

Local method which qualifies whether the start or end point of a segment is closest to a point.

Parameters
aRefis the reference point
aFirstis the first point
aSecondis the second point
Returns
true if the first point is closest to the reference, otherwise false.

Definition at line 97 of file convert_shape_list_to_polygon.cpp.

Referenced by ConnectBoardShapes(), doConvertOutlineToPolygon(), and processShapeSegment().

◆ ConvertOutlineToPolygon()

bool ConvertOutlineToPolygon ( std::vector< PCB_SHAPE * > & aShapeList,
SHAPE_POLY_SET & aPolygons,
int aErrorMax,
int aChainingEpsilon,
bool aAllowDisjoint,
OUTLINE_ERROR_HANDLER * aErrorHandler,
bool aAllowUseArcsInPolygons = false )

Build a polygon set with holes from a PCB_SHAPE list.

The shape list is expected to be one or more top-level closed outlines with zero or more holes in each. Optionally, it can be limited to a single top-level closed outline.

Parameters
aShapeListthe initial list of drawsegments (only lines, circles and arcs).
aPolygonswill contain the complex polygon.
aErrorMaxis the max error distance when polygonizing a curve (internal units).
aChainingEpsilonis the max distance from one endPt to the next startPt (internal units).
aAllowDisjointindicates multiple top-level outlines are allowed.
aErrorHandleris an optional error handler.
aAllowUseArcsInPolygonsis an option to allow adding arcs in SHAPE_LINE_CHAIN polylines/polygons when building outlines from aShapeList This is mainly for export to STEP files.
Returns
true if success, false if a contour is not valid (self intersecting).

Definition at line 840 of file convert_shape_list_to_polygon.cpp.

References doConvertOutlineToPolygon(), and SKIP_STRUCT.

Referenced by FOOTPRINT::BuildCourtyardCaches().

◆ doConvertOutlineToPolygon()

◆ findEndSegments()

◆ findNext()

static PCB_SHAPE * findNext ( PCB_SHAPE * aShape,
const VECTOR2I & aPoint,
const KDTree & kdTree,
const PCB_SHAPE_ENDPOINTS_ADAPTOR & adaptor,
double aChainingEpsilon )
static

◆ isCopperOutside()

◆ processClosedShape()

◆ processShapeSegment()

◆ projectPointOnSegment()

VECTOR2I projectPointOnSegment ( const VECTOR2I & aEndPoint,
const SHAPE_POLY_SET & aOutline,
int aOutlineNum = 0 )

◆ TestBoardOutlinesGraphicItems()

bool TestBoardOutlinesGraphicItems ( BOARD * aBoard,
int aMinDist,
OUTLINE_ERROR_HANDLER * aErrorHandler )

Test a board graphic items on edge cut layer for validity.

Parameters
aBoardis the board to test.
aMinDistis the min length of a segment (or radius, or diagonal size of a rect) to be valid.
aErrorHandleris an optional error handler.

Definition at line 852 of file convert_shape_list_to_polygon.cpp.

References _, ARC, BEZIER, CIRCLE, PCB_TYPE_COLLECTOR::Collect(), Edge_Cuts, VECTOR2< T >::EuclideanNorm(), COLLECTOR::GetCount(), PCB_SHAPE::GetLayer(), PCB_SHAPE_T, POLY, RECTANGLE, SEGMENT, and UNIMPLEMENTED_FOR.

Referenced by DRC_TEST_PROVIDER_MISC::testOutline().