KiCad PCB EDA Suite
class_module.cpp File Reference

MODULE class implementation. More...

#include <fctsys.h>
#include <gr_basic.h>
#include <plotter.h>
#include <class_drawpanel.h>
#include <trigo.h>
#include <confirm.h>
#include <kicad_string.h>
#include <pcbnew.h>
#include <richio.h>
#include <filter_reader.h>
#include <macros.h>
#include <msgpanel.h>
#include <bitmaps.h>
#include <unordered_set>
#include <pcb_edit_frame.h>
#include <class_board.h>
#include <class_edge_mod.h>
#include <class_module.h>
#include <convert_basic_shapes_to_polygon.h>
#include <view/view.h>

Go to the source code of this file.

Functions

static double polygonArea (SHAPE_POLY_SET &aPolySet)
 
static void addRect (SHAPE_POLY_SET &aPolySet, wxRect aRect)
 
bool ConvertOutlineToPolygon (std::vector< DRAWSEGMENT * > &aSegList, SHAPE_POLY_SET &aPolygons, wxString *aErrorText, unsigned int aTolerance)
 Function ConvertOutlineToPolygon build a polygon (with holes) from a DRAWSEGMENT list, which is expected to be a outline, therefore a closed main outline with perhaps closed inner outlines. More...
 

Detailed Description

MODULE class implementation.

TEXT_MODULE class implementation.

Definition in file class_module.cpp.

Function Documentation

static void addRect ( SHAPE_POLY_SET aPolySet,
wxRect  aRect 
)
static

Definition at line 1391 of file class_module.cpp.

References SHAPE_POLY_SET::Append(), and SHAPE_POLY_SET::NewOutline().

Referenced by MODULE::CoverageRatio().

1392 {
1393  aPolySet.NewOutline();
1394 
1395  aPolySet.Append( aRect.GetX(), aRect.GetY() );
1396  aPolySet.Append( aRect.GetX()+aRect.width, aRect.GetY() );
1397  aPolySet.Append( aRect.GetX()+aRect.width, aRect.GetY()+aRect.height );
1398  aPolySet.Append( aRect.GetX(), aRect.GetY()+aRect.height );
1399 }
int NewOutline()
Creates a new empty polygon in the set and returns its index
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) ...
bool ConvertOutlineToPolygon ( std::vector< DRAWSEGMENT * > &  aSegList,
SHAPE_POLY_SET aPolygons,
wxString *  aErrorText,
unsigned int  aTolerance 
)

Function ConvertOutlineToPolygon build a polygon (with holes) from a DRAWSEGMENT list, which is expected to be a outline, therefore a closed main outline with perhaps closed inner outlines.

These closed inner outlines are considered as holes in the main outline

Parameters
aSegListthe initial list of drawsegments (only lines, circles and arcs).
aPolygonswill contain the complex polygon.
aToleranceis the max distance between points that is still accepted as connected (internal units)
aErrorTextis a wxString to return error message.

Definition at line 181 of file convert_drawsegment_list_to_polygon.cpp.

References PNS::angle(), SHAPE_POLY_SET::Append(), close_enough(), close_st(), findPoint(), BOARD_ITEM::FormatInternalUnits(), FROM_UTF8(), DRAWSEGMENT::GetAngle(), DRAWSEGMENT::GetArcEnd(), DRAWSEGMENT::GetArcStart(), GetArcToSegmentCount(), DRAWSEGMENT::GetBezierPoints(), DRAWSEGMENT::GetCenter(), GetChars(), DRAWSEGMENT::GetEnd(), DRAWSEGMENT::GetRadius(), DRAWSEGMENT::GetShape(), DRAWSEGMENT::GetStart(), DRAWSEGMENT::GetWidth(), i, SHAPE_POLY_SET::NewHole(), SHAPE_POLY_SET::NewOutline(), DRAWSEGMENT::RebuildBezierToSegmentsPointsList(), reverse(), RotatePoint(), S_ARC, S_CIRCLE, S_CURVE, S_SEGMENT, BOARD_ITEM::ShowShape(), TransformCircleToPolygon(), wxPoint::x, and wxPoint::y.

Referenced by BuildBoardPolygonOutlines(), MODULE::BuildPolyCourtyard(), and MODULE::CoverageRatio().

183 {
184  if( aSegList.size() == 0 )
185  return true;
186 
187  wxString msg;
188 
189  // Make a working copy of aSegList, because the list is modified during calculations
190  std::vector< DRAWSEGMENT* > segList = aSegList;
191 
192  DRAWSEGMENT* graphic;
193  wxPoint prevPt;
194 
195  // Find edge point with minimum x, this should be in the outer polygon
196  // which will define the perimeter Edge.Cuts polygon.
197  wxPoint xmin = wxPoint( INT_MAX, 0 );
198  int xmini = 0;
199 
200  for( size_t i = 0; i < segList.size(); i++ )
201  {
202  graphic = (DRAWSEGMENT*) segList[i];
203 
204  switch( graphic->GetShape() )
205  {
206  case S_SEGMENT:
207  {
208  if( graphic->GetStart().x < xmin.x )
209  {
210  xmin = graphic->GetStart();
211  xmini = i;
212  }
213 
214  if( graphic->GetEnd().x < xmin.x )
215  {
216  xmin = graphic->GetEnd();
217  xmini = i;
218  }
219  }
220  break;
221 
222  case S_ARC:
223  // Freerouter does not yet understand arcs, so approximate
224  // an arc with a series of short lines and put those
225  // line segments into the !same! PATH.
226  {
227  wxPoint pstart = graphic->GetArcStart();
228  wxPoint center = graphic->GetCenter();
229  double angle = -graphic->GetAngle();
230  double radius = graphic->GetRadius();
231  int steps = GetArcToSegmentCount( radius, ARC_LOW_DEF, angle / 10.0 );
232  wxPoint pt;
233 
234  for( int step = 1; step<=steps; ++step )
235  {
236  double rotation = ( angle * step ) / steps;
237 
238  pt = pstart;
239 
240  RotatePoint( &pt, center, rotation );
241 
242  if( pt.x < xmin.x )
243  {
244  xmin = pt;
245  xmini = i;
246  }
247  }
248  }
249  break;
250 
251  case S_CIRCLE:
252  {
253  wxPoint pt = graphic->GetCenter();
254 
255  // pt has minimum x point
256  pt.x -= graphic->GetRadius();
257 
258  // when the radius <= 0, this is a mal-formed circle. Skip it
259  if( graphic->GetRadius() > 0 && pt.x < xmin.x )
260  {
261  xmin = pt;
262  xmini = i;
263  }
264  }
265  break;
266 
267  case S_CURVE:
268  {
269  graphic->RebuildBezierToSegmentsPointsList( graphic->GetWidth() );
270 
271  for( unsigned int jj = 0; jj < graphic->GetBezierPoints().size(); jj++ )
272  {
273  wxPoint pt = graphic->GetBezierPoints()[jj];
274 
275  if( pt.x < xmin.x )
276  {
277  xmin = pt;
278  xmini = i;
279  }
280  }
281  }
282  break;
283 
284  default:
285  break;
286  }
287  }
288 
289  // Grab the left most point, assume its on the board's perimeter, and see if we
290  // can put enough graphics together by matching endpoints to formulate a cohesive
291  // polygon.
292 
293  graphic = (DRAWSEGMENT*) segList[xmini];
294 
295  // The first DRAWSEGMENT is in 'graphic', ok to remove it from 'items'
296  segList.erase( segList.begin() + xmini );
297 
298  // Output the Edge.Cuts perimeter as circle or polygon.
299  if( graphic->GetShape() == S_CIRCLE )
300  {
301  int steps = GetArcToSegmentCount( graphic->GetRadius(), ARC_LOW_DEF, 360.0 );
302  TransformCircleToPolygon( aPolygons, graphic->GetCenter(), graphic->GetRadius(), steps );
303  }
304  else
305  {
306  // Polygon start point. Arbitrarily chosen end of the
307  // segment and build the poly from here.
308 
309  wxPoint startPt = wxPoint( graphic->GetEnd() );
310  prevPt = graphic->GetEnd();
311  aPolygons.NewOutline();
312  aPolygons.Append( prevPt );
313 
314  // Do not append the other end point yet of this 'graphic', this first
315  // 'graphic' might be an arc or a curve.
316 
317  for(;;)
318  {
319  switch( graphic->GetShape() )
320  {
321  case S_SEGMENT:
322  {
323  wxPoint nextPt;
324 
325  // Use the line segment end point furthest away from
326  // prevPt as we assume the other end to be ON prevPt or
327  // very close to it.
328 
329  if( close_st( prevPt, graphic->GetStart(), graphic->GetEnd() ) )
330  nextPt = graphic->GetEnd();
331  else
332  nextPt = graphic->GetStart();
333 
334  aPolygons.Append( nextPt );
335  prevPt = nextPt;
336  }
337  break;
338 
339  case S_ARC:
340  // We do not support arcs in polygons, so approximate
341  // an arc with a series of short lines and put those
342  // line segments into the !same! PATH.
343  {
344  wxPoint pstart = graphic->GetArcStart();
345  wxPoint pend = graphic->GetArcEnd();
346  wxPoint pcenter = graphic->GetCenter();
347  double angle = -graphic->GetAngle();
348  double radius = graphic->GetRadius();
349  int steps = GetArcToSegmentCount( radius, ARC_LOW_DEF, angle / 10.0 );
350 
351  if( !close_enough( prevPt, pstart, aTolerance ) )
352  {
353  wxASSERT( close_enough( prevPt, graphic->GetArcEnd(), aTolerance ) );
354 
355  angle = -angle;
356  std::swap( pstart, pend );
357  }
358 
359  wxPoint nextPt;
360 
361  for( int step = 1; step<=steps; ++step )
362  {
363  double rotation = ( angle * step ) / steps;
364  nextPt = pstart;
365  RotatePoint( &nextPt, pcenter, rotation );
366 
367  aPolygons.Append( nextPt );
368  }
369 
370  prevPt = nextPt;
371  }
372  break;
373 
374  case S_CURVE:
375  // We do not support Bezier curves in polygons, so approximate
376  // with a series of short lines and put those
377  // line segments into the !same! PATH.
378  {
379  wxPoint nextPt;
380  bool reverse = false;
381 
382  // Use the end point furthest away from
383  // prevPt as we assume the other end to be ON prevPt or
384  // very close to it.
385 
386  if( close_st( prevPt, graphic->GetStart(), graphic->GetEnd() ) )
387  nextPt = graphic->GetEnd();
388  else
389  {
390  nextPt = graphic->GetStart();
391  reverse = true;
392  }
393 
394  if( reverse )
395  {
396  for( int jj = graphic->GetBezierPoints().size()-1;
397  jj >= 0; jj-- )
398  aPolygons.Append( graphic->GetBezierPoints()[jj] );
399  }
400  else
401  {
402  for( unsigned int jj = 0;
403  jj < graphic->GetBezierPoints().size(); jj++ )
404  aPolygons.Append( graphic->GetBezierPoints()[jj] );
405  }
406 
407  prevPt = nextPt;
408  }
409  break;
410 
411  default:
412  if( aErrorText )
413  {
414  msg.Printf( _( "Unsupported DRAWSEGMENT type %s" ),
415  GetChars( BOARD_ITEM::ShowShape( graphic->GetShape() ) ) );
416 
417  *aErrorText << msg << "\n";
418  }
419 
420  return false;
421  }
422 
423  // Get next closest segment.
424 
425  graphic = findPoint( prevPt, segList, aTolerance );
426 
427  // If there are no more close segments, check if the board
428  // outline polygon can be closed.
429 
430  if( !graphic )
431  {
432  if( close_enough( startPt, prevPt, aTolerance ) )
433  {
434  // Close the polygon back to start point
435  // aPolygons.Append( startPt ); // not needed
436  }
437  else
438  {
439  if( aErrorText )
440  {
441  msg.Printf(
442  _( "Unable to find the next boundary segment with an endpoint of (%s mm, %s mm). "
443  "graphic outline must form a contiguous, closed polygon." ),
444  GetChars( FROM_UTF8( BOARD_ITEM::FormatInternalUnits( prevPt.x ).c_str() ) ),
445  GetChars( FROM_UTF8( BOARD_ITEM::FormatInternalUnits( prevPt.y ).c_str() ) )
446  );
447 
448  *aErrorText << msg << "\n";
449  }
450 
451  return false;
452  }
453  break;
454  }
455  }
456  }
457 
458  while( segList.size() )
459  {
460  // emit a signal layers keepout for every interior polygon left...
461  int hole = aPolygons.NewHole();
462 
463  graphic = (DRAWSEGMENT*) segList[0];
464  segList.erase( segList.begin() );
465 
466  if( graphic->GetShape() == S_CIRCLE )
467  {
468  // make a circle by segments;
469  wxPoint center = graphic->GetCenter();
470  double angle = 3600.0;
471  wxPoint start = center;
472  int radius = graphic->GetRadius();
473  int steps = GetArcToSegmentCount( radius, ARC_LOW_DEF, 360.0 );
474  wxPoint nextPt;
475 
476  start.x += radius;
477 
478  for( int step = 0; step < steps; ++step )
479  {
480  double rotation = ( angle * step ) / steps;
481  nextPt = start;
482  RotatePoint( &nextPt.x, &nextPt.y, center.x, center.y, rotation );
483  aPolygons.Append( nextPt, -1, hole );
484  }
485  }
486  else
487  {
488  // Polygon start point. Arbitrarily chosen end of the
489  // segment and build the poly from here.
490 
491  wxPoint startPt( graphic->GetEnd() );
492  prevPt = graphic->GetEnd();
493  aPolygons.Append( prevPt, -1, hole );
494 
495  // do not append the other end point yet, this first 'graphic' might be an arc
496  for(;;)
497  {
498  switch( graphic->GetShape() )
499  {
500  case S_SEGMENT:
501  {
502  wxPoint nextPt;
503 
504  // Use the line segment end point furthest away from
505  // prevPt as we assume the other end to be ON prevPt or
506  // very close to it.
507 
508  if( close_st( prevPt, graphic->GetStart(), graphic->GetEnd() ) )
509  {
510  nextPt = graphic->GetEnd();
511  }
512  else
513  {
514  nextPt = graphic->GetStart();
515  }
516 
517  prevPt = nextPt;
518  aPolygons.Append( prevPt, -1, hole );
519  }
520  break;
521 
522  case S_ARC:
523  // Freerouter does not yet understand arcs, so approximate
524  // an arc with a series of short lines and put those
525  // line segments into the !same! PATH.
526  {
527  wxPoint pstart = graphic->GetArcStart();
528  wxPoint pend = graphic->GetArcEnd();
529  wxPoint pcenter = graphic->GetCenter();
530  double angle = -graphic->GetAngle();
531  int radius = graphic->GetRadius();
532  int steps = GetArcToSegmentCount( radius, ARC_LOW_DEF, angle / 10.0 );
533 
534  if( !close_enough( prevPt, pstart, aTolerance ) )
535  {
536  wxASSERT( close_enough( prevPt, graphic->GetArcEnd(), aTolerance ) );
537 
538  angle = -angle;
539  std::swap( pstart, pend );
540  }
541 
542  wxPoint nextPt;
543 
544  for( int step = 1; step <= steps; ++step )
545  {
546  double rotation = ( angle * step ) / steps;
547 
548  nextPt = pstart;
549  RotatePoint( &nextPt, pcenter, rotation );
550 
551  aPolygons.Append( nextPt, -1, hole );
552  }
553 
554  prevPt = nextPt;
555  }
556  break;
557 
558  case S_CURVE:
559  // We do not support Bezier curves in polygons, so approximate
560  // with a series of short lines and put those
561  // line segments into the !same! PATH.
562  {
563  wxPoint nextPt;
564  bool reverse = false;
565 
566  // Use the end point furthest away from
567  // prevPt as we assume the other end to be ON prevPt or
568  // very close to it.
569 
570  if( close_st( prevPt, graphic->GetStart(), graphic->GetEnd() ) )
571  nextPt = graphic->GetEnd();
572  else
573  {
574  nextPt = graphic->GetStart();
575  reverse = true;
576  }
577 
578  if( reverse )
579  {
580  for( int jj = graphic->GetBezierPoints().size()-1;
581  jj >= 0; jj-- )
582  aPolygons.Append( graphic->GetBezierPoints()[jj], -1, hole );
583  }
584  else
585  {
586  for( unsigned int jj = 0;
587  jj < graphic->GetBezierPoints().size(); jj++ )
588  aPolygons.Append( graphic->GetBezierPoints()[jj], -1, hole );
589  }
590 
591  prevPt = nextPt;
592  }
593  break;
594 
595  default:
596  if( aErrorText )
597  {
598  msg.Printf( _( "Unsupported DRAWSEGMENT type %s" ),
599  GetChars( BOARD_ITEM::ShowShape( graphic->GetShape() ) ) );
600 
601  *aErrorText << msg << "\n";
602  }
603 
604  return false;
605  }
606 
607  // Get next closest segment.
608 
609  graphic = findPoint( prevPt, segList, aTolerance );
610 
611  // If there are no more close segments, check if polygon
612  // can be closed.
613 
614  if( !graphic )
615  {
616  if( close_enough( startPt, prevPt, aTolerance ) )
617  {
618  // Close the polygon back to start point
619  // aPolygons.Append( startPt, -1, hole ); // not needed
620  }
621  else
622  {
623  if( aErrorText )
624  {
625  msg.Printf(
626  _( "Unable to find the next graphic segment with an endpoint of (%s mm, %s mm).\n"
627  "Edit graphics, making them contiguous polygons each." ),
628  GetChars( FROM_UTF8( BOARD_ITEM::FormatInternalUnits( prevPt.x ).c_str() ) ),
629  GetChars( FROM_UTF8( BOARD_ITEM::FormatInternalUnits( prevPt.y ).c_str() ) )
630  );
631 
632  *aErrorText << msg << "\n";
633  }
634 
635  return false;
636  }
637  break;
638  }
639  }
640  }
641  }
642 
643  return true;
644 }
int NewHole(int aOutline=-1)
Creates a new hole in a given outline
static wxString ShowShape(STROKE_T aShape)
Function ShowShape converts the enum STROKE_T integer value to a wxString.
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
int GetArcToSegmentCount(int aRadius, int aErrorMax, double aArcAngleDegree)
const wxPoint GetCenter() const override
Function GetCenter()
void TransformCircleToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aCenter, int aRadius, int aCircleToSegmentsCount)
Function TransformCircleToPolygon convert a circle to a polygon, using multiple straight lines...
void RebuildBezierToSegmentsPointsList(int aMinSegLen)
Rebuild the m_BezierPoints vertex list that approximate the Bezier curve by a list of segments Has me...
usual segment : line with rounded ends
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
static std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from board internal units to a string appropriate for wr...
bool close_st(const wxPoint &aReference, const wxPoint &aFirst, const wxPoint &aSecond)
Function close_st is a local method of qualifying if either the start of end point of a segment is cl...
const wxPoint & GetArcStart() const
STROKE_T GetShape() const
const wxPoint & GetEnd() const
Function GetEnd returns the ending point of the graphic.
Arcs (with rounded ends)
Bezier Curve.
bool close_enough(const wxPoint &aLeft, const wxPoint &aRight, unsigned aLimit)
Function close_enough is a local and tunable method of qualifying the proximity of two points...
int NewOutline()
Creates a new empty polygon in the set and returns its index
const std::vector< wxPoint > & GetBezierPoints() const
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
double GetAngle() const
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
size_t i
Definition: json11.cpp:597
const wxPoint GetArcEnd() const
static DRAWSEGMENT * findPoint(const wxPoint &aPoint, std::vector< DRAWSEGMENT * > &aList, unsigned aLimit)
Searches for a DRAWSEGMENT matching a given end point or start point in a list, and if found...
static void reverse(privcurve_t *curve)
Definition: trace.cpp:1025
int GetWidth() const
const wxPoint & GetStart() const
Function GetStart returns the starting point of the graphic.
int GetRadius() const
Function GetRadius returns the radius of this item Has meaning only for arc and circle.
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) ...
static double polygonArea ( SHAPE_POLY_SET aPolySet)
static

Definition at line 1375 of file class_module.cpp.

References SHAPE_LINE_CHAIN::Area(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::SetClosed().

Referenced by MODULE::CoverageRatio().

1376 {
1377  double area = 0.0;
1378  for( int ii = 0; ii < aPolySet.OutlineCount(); ii++ )
1379  {
1380  SHAPE_LINE_CHAIN& outline = aPolySet.Outline( ii );
1381  // Ensure the curr outline is closed, to calculate area
1382  outline.SetClosed( true );
1383 
1384  area += outline.Area();
1385  }
1386 
1387  return area;
1388 }
int OutlineCount() const
Returns the number of outlines in the set
void SetClosed(bool aClosed)
Function SetClosed()
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
Class SHAPE_LINE_CHAIN.
double Area() const