KiCad PCB EDA Suite
GERBER_plotter.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
30 #include <fctsys.h>
31 #include <gr_basic.h>
32 #include <trigo.h>
33 #include <eda_base_frame.h>
34 #include <base_struct.h>
35 #include <common.h>
36 #include <plotter.h>
37 #include <macros.h>
38 #include <kicad_string.h>
40 #include <math/util.h> // for KiROUND
41 
42 #include <build_version.h>
43 
44 #include <gbr_metadata.h>
45 
46 
48 {
49  workFile = NULL;
50  finalFile = NULL;
53 
54  // number of digits after the point (number of digits of the mantissa
55  // Be carefull: the Gerber coordinates are stored in an integer
56  // so 6 digits (inches) or 5 digits (mm) is a good value
57  // To avoid overflow, 7 digits (inches) or 6 digits is a max.
58  // with lower values than 6 digits (inches) or 5 digits (mm),
59  // Creating self-intersecting polygons from non-intersecting polygons
60  // happen easily.
61  m_gerberUnitInch = false;
62  m_gerberUnitFmt = 6;
63  m_useX2format = true;
64  m_useNetAttributes = true;
65 }
66 
67 
68 void GERBER_PLOTTER::SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
69  double aScale, bool aMirror )
70 {
71  wxASSERT( aMirror == false );
72  m_plotMirror = false;
73  plotOffset = aOffset;
74  wxASSERT( aScale == 1 ); // aScale parameter is not used in Gerber
75  plotScale = 1; // Plot scale is *always* 1.0
76 
77  m_IUsPerDecimil = aIusPerDecimil;
78  // gives now a default value to iuPerDeviceUnit (because the units of the caller is now known)
79  // which could be modified later by calling SetGerberCoordinatesFormat()
80  iuPerDeviceUnit = pow( 10.0, m_gerberUnitFmt ) / ( m_IUsPerDecimil * 10000.0 );
81 
82  // We don't handle the filmbox, and it's more useful to keep the
83  // origin at the origin
84  paperSize.x = 0;
85  paperSize.y = 0;
86 }
87 
88 
89 void GERBER_PLOTTER::SetGerberCoordinatesFormat( int aResolution, bool aUseInches )
90 {
91  m_gerberUnitInch = aUseInches;
92  m_gerberUnitFmt = aResolution;
93 
94  iuPerDeviceUnit = pow( 10.0, m_gerberUnitFmt ) / ( m_IUsPerDecimil * 10000.0 );
95 
96  if( ! m_gerberUnitInch )
97  iuPerDeviceUnit *= 25.4; // gerber output in mm
98 }
99 
100 
101 void GERBER_PLOTTER::emitDcode( const DPOINT& pt, int dcode )
102 {
103 
104  fprintf( outputFile, "X%dY%dD%02d*\n", KiROUND( pt.x ), KiROUND( pt.y ), dcode );
105 }
106 
108 {
109  // Remove all attributes from object attributes dictionary (TO. and TA commands)
110  if( m_useX2format )
111  fputs( "%TD*%\n", outputFile );
112  else
113  fputs( "G04 #@! TD*\n", outputFile );
114 
116 }
117 
118 
120 {
121  // disable a Gerber net attribute (exists only in X2 with net attributes mode).
122  if( m_objectAttributesDictionnary.empty() ) // No net attribute or not X2 mode
123  return;
124 
125  // Remove all net attributes from object attributes dictionary
126  if( m_useX2format )
127  fputs( "%TD*%\n", outputFile );
128  else
129  fputs( "G04 #@! TD*\n", outputFile );
130 
132 }
133 
134 
135 void GERBER_PLOTTER::StartBlock( void* aData )
136 {
137  // Currently, it is the same as EndBlock(): clear all aperture net attributes
138  EndBlock( aData );
139 }
140 
141 
142 void GERBER_PLOTTER::EndBlock( void* aData )
143 {
144  // Remove all net attributes from object attributes dictionary
146 }
147 
148 
150 {
151  // print a Gerber net attribute record.
152  // it is added to the object attributes dictionary
153  // On file, only modified or new attributes are printed.
154  if( aData == NULL )
155  return;
156 
157  if( !m_useNetAttributes )
158  return;
159 
160  bool useX1StructuredComment = !m_useX2format;
161 
162  bool clearDict;
163  std::string short_attribute_string;
164 
165  if( !FormatNetAttribute( short_attribute_string, m_objectAttributesDictionnary,
166  aData, clearDict, useX1StructuredComment ) )
167  return;
168 
169  if( clearDict )
171 
172  if( !short_attribute_string.empty() )
173  fputs( short_attribute_string.c_str(), outputFile );
174 
175  if( m_useX2format && !aData->m_ExtraData.IsEmpty() )
176  {
177  std::string extra_data = TO_UTF8( aData->m_ExtraData );
178  fputs( extra_data.c_str(), outputFile );
179  }
180 }
181 
182 
184 {
185  wxASSERT( outputFile );
186 
187  finalFile = outputFile; // the actual gerber file will be created later
188 
189  // Create a temporary filename to store gerber file
190  // note tmpfile() does not work under Vista and W7 in user mode
191  m_workFilename = filename + wxT(".tmp");
192  workFile = wxFopen( m_workFilename, wxT( "wt" ));
194  wxASSERT( outputFile );
195 
196  if( outputFile == NULL )
197  return false;
198 
199  for( unsigned ii = 0; ii < m_headerExtraLines.GetCount(); ii++ )
200  {
201  if( ! m_headerExtraLines[ii].IsEmpty() )
202  fprintf( outputFile, "%s\n", TO_UTF8( m_headerExtraLines[ii] ) );
203  }
204 
205  // Set coordinate format to 3.6 or 4.5 absolute, leading zero omitted
206  // the number of digits for the integer part of coordinates is needed
207  // in gerber format, but is not very important when omitting leading zeros
208  // It is fixed here to 3 (inch) or 4 (mm), but is not actually used
209  int leadingDigitCount = m_gerberUnitInch ? 3 : 4;
210 
211  fprintf( outputFile, "%%FSLAX%d%dY%d%d*%%\n",
212  leadingDigitCount, m_gerberUnitFmt,
213  leadingDigitCount, m_gerberUnitFmt );
214  fprintf( outputFile,
215  "G04 Gerber Fmt %d.%d, Leading zero omitted, Abs format (unit %s)*\n",
216  leadingDigitCount, m_gerberUnitFmt,
217  m_gerberUnitInch ? "inch" : "mm" );
218 
219  wxString Title = creator + wxT( " " ) + GetBuildVersion();
220  // In gerber files, ASCII7 chars only are allowed.
221  // So use a ISO date format (using a space as separator between date and time),
222  // not a localized date format
223  wxDateTime date = wxDateTime::Now();
224  fprintf( outputFile, "G04 Created by KiCad (%s) date %s*\n",
225  TO_UTF8( Title ), TO_UTF8( date.FormatISOCombined( ' ') ) );
226 
227  /* Mass parameter: unit = INCHES/MM */
228  if( m_gerberUnitInch )
229  fputs( "%MOIN*%\n", outputFile );
230  else
231  fputs( "%MOMM*%\n", outputFile );
232 
233  // Be sure the usual dark polarity is selected:
234  fputs( "%LPD*%\n", outputFile );
235 
236  // Set initial interpolation mode: always G01 (linear):
237  fputs( "G01*\n", outputFile );
238 
239  // Set aperture list starting point:
240  fputs( "G04 APERTURE LIST*\n", outputFile );
241 
242  return true;
243 }
244 
245 
247 {
248  char line[1024];
249  wxString msg;
250 
251  wxASSERT( outputFile );
252 
253  /* Outfile is actually a temporary file i.e. workFile */
254  fputs( "M02*\n", outputFile );
255  fflush( outputFile );
256 
257  fclose( workFile );
258  workFile = wxFopen( m_workFilename, wxT( "rt" ));
259  wxASSERT( workFile );
261 
262  // Placement of apertures in RS274X
263  while( fgets( line, 1024, workFile ) )
264  {
265  fputs( line, outputFile );
266 
267  char* substr = strtok( line, "\n\r" );
268 
269  if( substr && strcmp( substr, "G04 APERTURE LIST*" ) == 0 )
270  {
272  fputs( "G04 APERTURE END LIST*\n", outputFile );
273  }
274  }
275 
276  fclose( workFile );
277  fclose( finalFile );
278  ::wxRemoveFile( m_workFilename );
279  outputFile = 0;
280 
281  return true;
282 }
283 
284 
285 void GERBER_PLOTTER::SetCurrentLineWidth( int aWidth, void* aData )
286 {
287  if( aWidth == DO_NOT_SET_LINE_WIDTH )
288  return;
289  else if( aWidth == USE_DEFAULT_LINE_WIDTH )
291 
292  wxASSERT_MSG( aWidth >= 0, "Plotter called to set negative pen width" );
293 
294  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
295  int aperture_attribute = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
296 
297  selectAperture( wxSize( aWidth, aWidth ), APERTURE::AT_PLOTTING, aperture_attribute );
298  currentPenWidth = aWidth;
299 }
300 
301 
302 int GERBER_PLOTTER::GetOrCreateAperture( const wxSize& aSize,
303  APERTURE::APERTURE_TYPE aType, int aApertureAttribute )
304 {
305  int last_D_code = 9;
306 
307  // Search an existing aperture
308  for( int idx = 0; idx < (int)m_apertures.size(); ++idx )
309  {
310  APERTURE* tool = &m_apertures[idx];
311  last_D_code = tool->m_DCode;
312 
313  if( (tool->m_Type == aType) && (tool->m_Size == aSize) &&
314  (tool->m_ApertureAttribute == aApertureAttribute) )
315  return idx;
316  }
317 
318  // Allocate a new aperture
319  APERTURE new_tool;
320  new_tool.m_Size = aSize;
321  new_tool.m_Type = aType;
322  new_tool.m_DCode = last_D_code + 1;
323  new_tool.m_ApertureAttribute = aApertureAttribute;
324 
325  m_apertures.push_back( new_tool );
326 
327  return m_apertures.size() - 1;
328 }
329 
330 
331 void GERBER_PLOTTER::selectAperture( const wxSize& aSize,
333  int aApertureAttribute )
334 {
335  bool change = ( m_currentApertureIdx < 0 ) ||
336  ( m_apertures[m_currentApertureIdx].m_Type != aType ) ||
337  ( m_apertures[m_currentApertureIdx].m_Size != aSize );
338 
339  if( !change )
340  change = m_apertures[m_currentApertureIdx].m_ApertureAttribute != aApertureAttribute;
341 
342  if( change )
343  {
344  // Pick an existing aperture or create a new one
345  m_currentApertureIdx = GetOrCreateAperture( aSize, aType, aApertureAttribute );
346  fprintf( outputFile, "D%d*\n", m_apertures[m_currentApertureIdx].m_DCode );
347  }
348 }
349 
350 void GERBER_PLOTTER::selectAperture( int aDiameter, double aPolygonRotation,
351  APERTURE::APERTURE_TYPE aType, int aApertureAttribute )
352 {
353  // Pick an existing aperture or create a new one, matching the
354  // aDiameter, aPolygonRotation, type and attributes for type =
355  // AT_REGULAR_POLY3 to AT_REGULAR_POLY12
356 
357  wxASSERT( aType>= APERTURE::APERTURE_TYPE::AT_REGULAR_POLY3 &&
358  aType <= APERTURE::APERTURE_TYPE::AT_REGULAR_POLY12 );
359 
360  // To use selectAperture( size, ... ) calculate a equivalent aperture size:
361  // for AT_REGULAR_POLYxx the parameter APERTURE::m_Size contains
362  // aDiameter (in m_Size.x) and aPolygonRotation in 1/1000 degree (in m_Size.y)
363  wxSize size( aDiameter, (int)( aPolygonRotation * 1000.0 ) );
364  selectAperture( size, aType, aApertureAttribute );
365 }
366 
368 {
369  wxASSERT( outputFile );
370  char cbuf[1024];
371 
372  bool useX1StructuredComment = false;
373 
374  if( !m_useX2format )
375  useX1StructuredComment = true;
376 
377  // Init
378  for( APERTURE& tool : m_apertures )
379  {
380  // apertude sizes are in inch or mm, regardless the
381  // coordinates format
382  double fscale = 0.0001 * plotScale / m_IUsPerDecimil; // inches
383 
384  if(! m_gerberUnitInch )
385  fscale *= 25.4; // size in mm
386 
387  int attribute = tool.m_ApertureAttribute;
388 
389  if( attribute != m_apertureAttribute )
390  {
393  useX1StructuredComment ).c_str(), outputFile );
394  }
395 
396  char* text = cbuf + sprintf( cbuf, "%%ADD%d", tool.m_DCode );
397 
398  /* Please note: the Gerber specs for mass parameters say that
399  exponential syntax is *not* allowed and the decimal point should
400  also be always inserted. So the %g format is ruled out, but %f is fine
401  (the # modifier forces the decimal point). Sadly the %f formatter
402  can't remove trailing zeros but thats not a problem, since nothing
403  forbid it (the file is only slightly longer) */
404 
405  switch( tool.m_Type )
406  {
407  case APERTURE::AT_CIRCLE:
408  sprintf( text, "C,%#f*%%\n", tool.GetDiameter() * fscale );
409  break;
410 
411  case APERTURE::AT_RECT:
412  sprintf( text, "R,%#fX%#f*%%\n", tool.m_Size.x * fscale,
413  tool.m_Size.y * fscale );
414  break;
415 
417  sprintf( text, "C,%#f*%%\n", tool.m_Size.x * fscale );
418  break;
419 
420  case APERTURE::AT_OVAL:
421  sprintf( text, "O,%#fX%#f*%%\n", tool.m_Size.x * fscale,
422  tool.m_Size.y * fscale );
423  break;
424 
436  sprintf( text, "P,%#fX%dX%#f*%%\n", tool.GetDiameter() * fscale,
437  tool.GetVerticeCount(), tool.GetRotation() );
438  break;
439  }
440 
441  fputs( cbuf, outputFile );
442 
443  m_apertureAttribute = attribute;
444 
445  // Currently reset the aperture attribute. Perhaps a better optimization
446  // is to store the last attribute
447  if( attribute )
448  {
449  if( m_useX2format )
450  fputs( "%TD*%\n", outputFile );
451  else
452  fputs( "G04 #@! TD*\n", outputFile );
453 
455  }
456 
457  }
458 }
459 
460 
461 void GERBER_PLOTTER::PenTo( const wxPoint& aPos, char plume )
462 {
463  wxASSERT( outputFile );
464  DPOINT pos_dev = userToDeviceCoordinates( aPos );
465 
466  switch( plume )
467  {
468  case 'Z':
469  break;
470 
471  case 'U':
472  emitDcode( pos_dev, 2 );
473  break;
474 
475  case 'D':
476  emitDcode( pos_dev, 1 );
477  }
478 
479  penState = plume;
480 }
481 
482 
483 void GERBER_PLOTTER::Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill, int width )
484 {
485  std::vector< wxPoint > cornerList;
486 
487  // Build corners list
488  cornerList.push_back( p1 );
489  wxPoint corner(p1.x, p2.y);
490  cornerList.push_back( corner );
491  cornerList.push_back( p2 );
492  corner.x = p2.x;
493  corner.y = p1.y;
494  cornerList.push_back( corner );
495  cornerList.push_back( p1 );
496 
497  PlotPoly( cornerList, fill, width );
498 }
499 
500 
501 void GERBER_PLOTTER::Circle( const wxPoint& aCenter, int aDiameter, FILL_T aFill, int aWidth )
502 {
503  Arc( aCenter, 0, 3600, aDiameter / 2, aFill, aWidth );
504 }
505 
506 
507 void GERBER_PLOTTER::Arc( const wxPoint& aCenter, double aStAngle, double aEndAngle,
508  int aRadius, FILL_T aFill, int aWidth )
509 {
510  SetCurrentLineWidth( aWidth );
511 
512  // aFill is not used here.
513  plotArc( aCenter, aStAngle, aEndAngle, aRadius, false );
514 }
515 
516 
517 void GERBER_PLOTTER::plotArc( const wxPoint& aCenter, double aStAngle, double aEndAngle,
518  int aRadius, bool aPlotInRegion )
519 {
520  wxPoint start, end;
521  start.x = aCenter.x + KiROUND( cosdecideg( aRadius, aStAngle ) );
522  start.y = aCenter.y - KiROUND( sindecideg( aRadius, aStAngle ) );
523 
524  if( !aPlotInRegion )
525  MoveTo( start );
526  else
527  LineTo( start );
528 
529  end.x = aCenter.x + KiROUND( cosdecideg( aRadius, aEndAngle ) );
530  end.y = aCenter.y - KiROUND( sindecideg( aRadius, aEndAngle ) );
531  DPOINT devEnd = userToDeviceCoordinates( end );
532  DPOINT devCenter = userToDeviceCoordinates( aCenter ) - userToDeviceCoordinates( start );
533 
534  fprintf( outputFile, "G75*\n" ); // Multiquadrant (360 degrees) mode
535 
536  if( aStAngle < aEndAngle )
537  fprintf( outputFile, "G03*\n" ); // Active circular interpolation, CCW
538  else
539  fprintf( outputFile, "G02*\n" ); // Active circular interpolation, CW
540 
541  fprintf( outputFile, "X%dY%dI%dJ%dD01*\n",
542  KiROUND( devEnd.x ), KiROUND( devEnd.y ),
543  KiROUND( devCenter.x ), KiROUND( devCenter.y ) );
544 
545  fprintf( outputFile, "G01*\n" ); // Back to linear interpol (perhaps useless here).
546 }
547 
548 
549 void GERBER_PLOTTER::PlotGerberRegion( const std::vector< wxPoint >& aCornerList,
550  void * aData )
551 {
552  if( aCornerList.size() <= 2 )
553  return;
554 
555  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
556 
557  bool clearTA_AperFunction = false; // true if a TA.AperFunction is used
558 
559  if( gbr_metadata )
560  {
561  std::string attrib = gbr_metadata->m_ApertureMetadata.FormatAttribute( !m_useX2format );
562 
563  if( !attrib.empty() )
564  {
565  fputs( attrib.c_str(), outputFile );
566  clearTA_AperFunction = true;
567  }
568  }
569 
570  PlotPoly( aCornerList, FILLED_SHAPE, 0 , gbr_metadata );
571 
572  // Clear the TA attribute, to avoid the next item to inherit it:
573  if( clearTA_AperFunction )
574  {
575  if( m_useX2format )
576  {
577  fputs( "%TD.AperFunction*%\n", outputFile );
578  }
579  else
580  {
581  fputs( "G04 #@! TD.AperFunction*\n", outputFile );
582  }
583  }
584 }
585 
586 void GERBER_PLOTTER::PlotPoly( const std::vector< wxPoint >& aCornerList,
587  FILL_T aFill, int aWidth, void * aData )
588 {
589  if( aCornerList.size() <= 1 )
590  return;
591 
592  // Gerber format does not know filled polygons with thick outline
593  // Therefore, to plot a filled polygon with outline having a thickness,
594  // one should plot outline as thick segments
595  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
596 
597  if( gbr_metadata )
598  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
599 
600  if( aFill )
601  {
602  fputs( "G36*\n", outputFile );
603 
604  MoveTo( aCornerList[0] );
605  fputs( "G01*\n", outputFile ); // Set linear interpolation.
606 
607  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
608  LineTo( aCornerList[ii] );
609 
610  // If the polygon is not closed, close it:
611  if( aCornerList[0] != aCornerList[aCornerList.size()-1] )
612  FinishTo( aCornerList[0] );
613 
614  fputs( "G37*\n", outputFile );
615  }
616 
617  if( aWidth > 0 ) // Draw the polyline/polygon outline
618  {
619  SetCurrentLineWidth( aWidth, gbr_metadata );
620 
621  MoveTo( aCornerList[0] );
622 
623  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
624  LineTo( aCornerList[ii] );
625 
626  // Ensure the thick outline is closed for filled polygons
627  // (if not filled, could be only a polyline)
628  if( aFill && ( aCornerList[aCornerList.size()-1] != aCornerList[0] ) )
629  LineTo( aCornerList[0] );
630 
631  PenFinish();
632  }
633 }
634 
635 
636 void GERBER_PLOTTER::ThickSegment( const wxPoint& start, const wxPoint& end, int width,
637  EDA_DRAW_MODE_T tracemode, void* aData )
638 {
639  if( tracemode == FILLED )
640  {
641  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
642  SetCurrentLineWidth( width, gbr_metadata );
643 
644  if( gbr_metadata )
645  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
646 
647  MoveTo( start );
648  FinishTo( end );
649  }
650  else
651  {
653  segmentAsOval( start, end, width, tracemode );
654  }
655 }
656 
657 void GERBER_PLOTTER::ThickArc( const wxPoint& centre, double StAngle, double EndAngle,
658  int radius, int width, EDA_DRAW_MODE_T tracemode, void* aData )
659 {
660  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
661  SetCurrentLineWidth( width, gbr_metadata );
662 
663  if( gbr_metadata )
664  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
665 
666  if( tracemode == FILLED )
667  Arc( centre, StAngle, EndAngle, radius, NO_FILL, DO_NOT_SET_LINE_WIDTH );
668  else
669  {
671  Arc( centre, StAngle, EndAngle,
672  radius - ( width - currentPenWidth ) / 2,
674  Arc( centre, StAngle, EndAngle,
675  radius + ( width - currentPenWidth ) / 2, NO_FILL,
677  }
678 }
679 
680 
681 void GERBER_PLOTTER::ThickRect( const wxPoint& p1, const wxPoint& p2, int width,
682  EDA_DRAW_MODE_T tracemode, void* aData )
683 {
684  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
685  SetCurrentLineWidth( width, gbr_metadata );
686 
687  if( gbr_metadata )
688  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
689 
690  if( tracemode == FILLED )
691  Rect( p1, p2, NO_FILL, DO_NOT_SET_LINE_WIDTH );
692  else
693  {
695  wxPoint offsetp1( p1.x - (width - currentPenWidth) / 2,
696  p1.y - (width - currentPenWidth) / 2 );
697  wxPoint offsetp2( p2.x + (width - currentPenWidth) / 2,
698  p2.y + (width - currentPenWidth) / 2 );
699  Rect( offsetp1, offsetp2, NO_FILL, -1 );
700  offsetp1.x += (width - currentPenWidth);
701  offsetp1.y += (width - currentPenWidth);
702  offsetp2.x -= (width - currentPenWidth);
703  offsetp2.y -= (width - currentPenWidth);
704  Rect( offsetp1, offsetp2, NO_FILL, DO_NOT_SET_LINE_WIDTH );
705  }
706 }
707 
708 
709 void GERBER_PLOTTER::ThickCircle( const wxPoint& pos, int diametre, int width,
710  EDA_DRAW_MODE_T tracemode, void* aData )
711 {
712  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
713  SetCurrentLineWidth( width, gbr_metadata );
714 
715  if( gbr_metadata )
716  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
717 
718  if( tracemode == FILLED )
719  Circle( pos, diametre, NO_FILL, DO_NOT_SET_LINE_WIDTH );
720  else
721  {
723  Circle( pos, diametre - (width - currentPenWidth),
725  Circle( pos, diametre + (width - currentPenWidth),
727  }
728 }
729 
730 
731 void GERBER_PLOTTER::FlashPadCircle( const wxPoint& pos, int diametre, EDA_DRAW_MODE_T trace_mode, void* aData )
732 {
733  wxSize size( diametre, diametre );
734  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
735 
736  if( trace_mode == SKETCH )
737  {
738  if( gbr_metadata )
739  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
740 
742  }
743  else
744  {
745  DPOINT pos_dev = userToDeviceCoordinates( pos );
746 
747  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
748  selectAperture( size, APERTURE::AT_CIRCLE, aperture_attrib );
749 
750  if( gbr_metadata )
751  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
752 
753  emitDcode( pos_dev, 3 );
754  }
755 }
756 
757 
758 void GERBER_PLOTTER::FlashPadOval( const wxPoint& pos, const wxSize& aSize, double orient,
759  EDA_DRAW_MODE_T trace_mode, void* aData )
760 {
761  wxASSERT( outputFile );
762  wxSize size( aSize );
763  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
764 
765  // Flash a vertical or horizontal shape (this is a basic aperture).
766  if( ( orient == 0 || orient == 900 || orient == 1800 || orient == 2700 )
767  && trace_mode == FILLED )
768  {
769  if( orient == 900 || orient == 2700 ) /* orientation turned 90 deg. */
770  std::swap( size.x, size.y );
771 
772  DPOINT pos_dev = userToDeviceCoordinates( pos );
773  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
774  selectAperture( size, APERTURE::AT_OVAL, aperture_attrib );
775 
776  if( gbr_metadata )
777  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
778 
779  emitDcode( pos_dev, 3 );
780  }
781  else // Plot pad as region.
782  // Only regions and flashed items accept a object attribute TO.P for the pin name
783  {
784  if( trace_mode == FILLED )
785  {
786  // Draw the oval as round rect pad with a radius = 50% min size)
787  // In gerber file, it will be drawn as a region with arcs, and can be
788  // detected as pads (similar to a flashed pad)
789  FlashPadRoundRect( pos, aSize, std::min( aSize.x, aSize.y ) /2,
790  orient, FILLED, aData );
791  }
792  else // Non filled shape: plot outlines:
793  {
794  if( size.x > size.y )
795  {
796  std::swap( size.x, size.y );
797 
798  if( orient < 2700 )
799  orient += 900;
800  else
801  orient -= 2700;
802  }
803 
804  sketchOval( pos, size, orient, -1 );
805  }
806  }
807 }
808 
809 
810 void GERBER_PLOTTER::FlashPadRect( const wxPoint& pos, const wxSize& aSize,
811  double orient, EDA_DRAW_MODE_T trace_mode, void* aData )
812 
813 {
814  wxASSERT( outputFile );
815  wxSize size( aSize );
816  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
817 
818  // Plot as an aperture flash
819  switch( int( orient ) )
820  {
821  case 900:
822  case 2700: // rotation of 90 degrees or 270 swaps sizes
823  std::swap( size.x, size.y );
825 
826  case 0:
827  case 1800:
828  if( trace_mode == SKETCH )
829  {
830  if( gbr_metadata )
831  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
832 
833  Rect( wxPoint( pos.x - (size.x - currentPenWidth) / 2,
834  pos.y - (size.y - currentPenWidth) / 2 ),
835  wxPoint( pos.x + (size.x - currentPenWidth) / 2,
836  pos.y + (size.y - currentPenWidth) / 2 ),
838  }
839  else
840  {
841  DPOINT pos_dev = userToDeviceCoordinates( pos );
842  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
843  selectAperture( size, APERTURE::AT_RECT, aperture_attrib );
844 
845  if( gbr_metadata )
846  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
847 
848  emitDcode( pos_dev, 3 );
849  }
850  break;
851 
852  default: // plot pad shape as Gerber region
853  {
854  wxPoint coord[4];
855  // coord[0] is assumed the lower left
856  // coord[1] is assumed the upper left
857  // coord[2] is assumed the upper right
858  // coord[3] is assumed the lower right
859 
860  coord[0].x = -size.x/2; // lower left
861  coord[0].y = size.y/2;
862  coord[1].x = -size.x/2; // upper left
863  coord[1].y = -size.y/2;
864  coord[2].x = size.x/2; // upper right
865  coord[2].y = -size.y/2;
866  coord[3].x = size.x/2; // lower right
867  coord[3].y = size.y/2;
868 
869  FlashPadTrapez( pos, coord, orient, trace_mode, aData );
870  }
871  break;
872  }
873 }
874 
875 void GERBER_PLOTTER::FlashPadRoundRect( const wxPoint& aPadPos, const wxSize& aSize,
876  int aCornerRadius, double aOrient,
877  EDA_DRAW_MODE_T aTraceMode, void* aData )
878 
879 {
880  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
881 
882  if( aTraceMode != FILLED )
883  {
884  SHAPE_POLY_SET outline;
885  TransformRoundChamferedRectToPolygon( outline, aPadPos, aSize, aOrient,
886  aCornerRadius, 0.0, 0, GetPlotterArcHighDef() );
887 
889  outline.Inflate( -GetCurrentLineWidth()/2, 16 );
890 
891  std::vector< wxPoint > cornerList;
892  // TransformRoundRectToPolygon creates only one convex polygon
893  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
894  cornerList.reserve( poly.PointCount() + 1 );
895 
896  for( int ii = 0; ii < poly.PointCount(); ++ii )
897  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
898 
899  // Close polygon
900  cornerList.push_back( cornerList[0] );
901 
902  // plot outlines
903  PlotPoly( cornerList, NO_FILL, GetCurrentLineWidth(), gbr_metadata );
904  }
905  else
906  {
907  // A Pad RoundRect is plotted as a Gerber region.
908  // Initialize region metadata:
909  bool clearTA_AperFunction = false; // true if a TA.AperFunction is used
910 
911  if( gbr_metadata )
912  {
913  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
914  std::string attrib = gbr_metadata->m_ApertureMetadata.FormatAttribute( !m_useX2format );
915 
916  if( !attrib.empty() )
917  {
918  fputs( attrib.c_str(), outputFile );
919  clearTA_AperFunction = true;
920  }
921  }
922 
923  // Plot the region using arcs in corners.
924  plotRoundRectAsRegion( aPadPos, aSize, aCornerRadius, aOrient );
925 
926  // Clear the TA attribute, to avoid the next item to inherit it:
927  if( clearTA_AperFunction )
928  {
929  if( m_useX2format )
930  {
931  fputs( "%TD.AperFunction*%\n", outputFile );
932  }
933  else
934  {
935  fputs( "G04 #@! TD.AperFunction*\n", outputFile );
936  }
937  }
938  }
939 }
940 
941 
942 void GERBER_PLOTTER::plotRoundRectAsRegion( const wxPoint& aRectCenter, const wxSize& aSize,
943  int aCornerRadius, double aOrient )
944 {
945  // The region outline is generated by 4 sides and 4 90 deg arcs
946  // 1 --- 2
947  // | c |
948  // 4 --- 3
949 
950  // Note also in user coordinates the Y axis is from top to bottom
951  // for historical reasons.
952 
953  // A helper structure to handle outlines coordinates (segments and arcs)
954  // in user coordinates
955  struct RR_EDGE
956  {
957  wxPoint m_start;
958  wxPoint m_end;
959  wxPoint m_center;
960  // in decidegrees: angle start. angle end = m_arc_angle_start+arc_angle
961  double m_arc_angle_start;
962  };
963 
964  const double arc_angle = -900.0; // in decidegrees
965  int hsizeX = aSize.x/2;
966  int hsizeY = aSize.y/2;
967 
968  RR_EDGE curr_edge;
969  std::vector<RR_EDGE> rr_outline;
970 
971  // Build outline coordinates, relative to rectangle center, rotation 0:
972 
973  // Top left corner 1 (and 4 to 1 left vertical side @ x=-hsizeX)
974  curr_edge.m_start.x = -hsizeX;
975  curr_edge.m_start.y = hsizeY - aCornerRadius;
976  curr_edge.m_end.x = curr_edge.m_start.x;
977  curr_edge.m_end.y = -hsizeY + aCornerRadius;
978  curr_edge.m_center.x = -hsizeX + aCornerRadius;
979  curr_edge.m_center.y = curr_edge.m_end.y;
980  curr_edge.m_arc_angle_start = aOrient + 1800.0; // En decidegree
981 
982  rr_outline.push_back( curr_edge );
983 
984  // Top right corner 2 (and 1 to 2 top horizontal side @ y=-hsizeY)
985  curr_edge.m_start.x = -hsizeX + aCornerRadius;
986  curr_edge.m_start.y = -hsizeY;
987  curr_edge.m_end.x = hsizeX - aCornerRadius;
988  curr_edge.m_end.y = curr_edge.m_start.y;
989  curr_edge.m_center.x = curr_edge.m_end.x;
990  curr_edge.m_center.y = -hsizeY + aCornerRadius;
991  curr_edge.m_arc_angle_start = aOrient + 900.0; // En decidegree
992 
993  rr_outline.push_back( curr_edge );
994 
995  // bottom right corner 3 (and 2 to 3 right vertical side @ x=hsizeX)
996  curr_edge.m_start.x = hsizeX;
997  curr_edge.m_start.y = -hsizeY + aCornerRadius;
998  curr_edge.m_end.x = curr_edge.m_start.x;
999  curr_edge.m_end.y = hsizeY - aCornerRadius;
1000  curr_edge.m_center.x = hsizeX - aCornerRadius;
1001  curr_edge.m_center.y = curr_edge.m_end.y;
1002  curr_edge.m_arc_angle_start = aOrient + 0.0; // En decidegree
1003 
1004  rr_outline.push_back( curr_edge );
1005 
1006  // bottom left corner 4 (and 3 to 4 bottom horizontal side @ y=hsizeY)
1007  curr_edge.m_start.x = hsizeX - aCornerRadius;
1008  curr_edge.m_start.y = hsizeY;
1009  curr_edge.m_end.x = -hsizeX + aCornerRadius;
1010  curr_edge.m_end.y = curr_edge.m_start.y;
1011  curr_edge.m_center.x = curr_edge.m_end.x;
1012  curr_edge.m_center.y = hsizeY - aCornerRadius;
1013  curr_edge.m_arc_angle_start = aOrient - 900.0; // En decidegree
1014 
1015  rr_outline.push_back( curr_edge );
1016 
1017  // Move relative coordinates to the actual location and rotation:
1018  wxPoint arc_last_center;
1019  int arc_last_angle = curr_edge.m_arc_angle_start+arc_angle;
1020 
1021  for( RR_EDGE& rr_edge: rr_outline )
1022  {
1023  RotatePoint( &rr_edge.m_start, aOrient );
1024  RotatePoint( &rr_edge.m_end, aOrient );
1025  RotatePoint( &rr_edge.m_center, aOrient );
1026  rr_edge.m_start += aRectCenter;
1027  rr_edge.m_end += aRectCenter;
1028  rr_edge.m_center += aRectCenter;
1029  arc_last_center = rr_edge.m_center;
1030  }
1031 
1032  // Ensure the region is a closed polygon, i.e. the end point of last segment
1033  // (end of arc) is the same as the first point. Rounding issues can create a
1034  // small difference, mainly for rotated pads.
1035  // calculate last point (end of last arc):
1036  wxPoint last_pt;
1037  last_pt.x = arc_last_center.x + KiROUND( cosdecideg( aCornerRadius, arc_last_angle ) );
1038  last_pt.y = arc_last_center.y - KiROUND( sindecideg( aCornerRadius, arc_last_angle ) );
1039 
1040  wxPoint first_pt = rr_outline[0].m_start;
1041 
1042 #if 0 // For test only:
1043  if( last_pt != first_pt )
1044  wxLogMessage( "first pt %d %d last pt %d %d",
1045  first_pt.x, first_pt.y, last_pt.x, last_pt.y );
1046 #endif
1047 
1048  fputs( "G36*\n", outputFile ); // Start region
1049  fputs( "G01*\n", outputFile ); // Set linear interpolation.
1050  first_pt = last_pt;
1051  MoveTo( first_pt ); // Start point of region, must be same as end point
1052 
1053  for( RR_EDGE& rr_edge: rr_outline )
1054  {
1055  if( aCornerRadius ) // Guard: ensure we do not create arcs with radius = 0
1056  {
1057  // LineTo( rr_edge.m_end ); // made in plotArc()
1058  plotArc( rr_edge.m_center,
1059  rr_edge.m_arc_angle_start, rr_edge.m_arc_angle_start+arc_angle,
1060  aCornerRadius, true );
1061  }
1062  else
1063  LineTo( rr_edge.m_end );
1064  }
1065 
1066  fputs( "G37*\n", outputFile ); // Close region
1067 }
1068 
1069 
1070 void GERBER_PLOTTER::FlashPadCustom( const wxPoint& aPadPos, const wxSize& aSize,
1071  SHAPE_POLY_SET* aPolygons,
1072  EDA_DRAW_MODE_T aTraceMode, void* aData )
1073 
1074 {
1075  // A Pad custom is plotted as polygon (a region in Gerber language).
1076 
1077  GBR_METADATA gbr_metadata;
1078 
1079  if( aData )
1080  gbr_metadata = *static_cast<GBR_METADATA*>( aData );
1081 
1082  SHAPE_POLY_SET polyshape = *aPolygons;
1083 
1084  if( aTraceMode != FILLED )
1085  {
1086  SetCurrentLineWidth( USE_DEFAULT_LINE_WIDTH, &gbr_metadata );
1087  polyshape.Inflate( -GetCurrentLineWidth()/2, 16 );
1088  }
1089 
1090  std::vector< wxPoint > cornerList;
1091 
1092  for( int cnt = 0; cnt < polyshape.OutlineCount(); ++cnt )
1093  {
1094  SHAPE_LINE_CHAIN& poly = polyshape.Outline( cnt );
1095 
1096  cornerList.clear();
1097 
1098  for( int ii = 0; ii < poly.PointCount(); ++ii )
1099  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
1100 
1101  // Close polygon
1102  cornerList.push_back( cornerList[0] );
1103 
1104  if( aTraceMode == SKETCH )
1105  PlotPoly( cornerList, NO_FILL, GetCurrentLineWidth(), &gbr_metadata );
1106  else
1107  PlotGerberRegion( cornerList, &gbr_metadata );
1108  }
1109 }
1110 
1111 
1112 void GERBER_PLOTTER::FlashPadTrapez( const wxPoint& aPadPos, const wxPoint* aCorners,
1113  double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode, void* aData )
1114 
1115 {
1116  // TODO: use Aperture macro and flash it
1117 
1118  // polygon corners list
1119  std::vector<wxPoint> cornerList = { aCorners[0], aCorners[1], aCorners[2], aCorners[3] };
1120 
1121  // Draw the polygon and fill the interior as required
1122  for( unsigned ii = 0; ii < 4; ii++ )
1123  {
1124  RotatePoint( &cornerList[ii], aPadOrient );
1125  cornerList[ii] += aPadPos;
1126  }
1127 
1128  // Close the polygon
1129  cornerList.push_back( cornerList[0] );
1130  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1131 
1132  GBR_METADATA metadata;
1133 
1134  if( gbr_metadata )
1135  metadata = *gbr_metadata;
1136 
1137  if( aTrace_Mode == SKETCH )
1138  PlotPoly( cornerList, NO_FILL, DO_NOT_SET_LINE_WIDTH, &metadata );
1139  else
1140  PlotGerberRegion( cornerList, &metadata );
1141 }
1142 
1143 
1145  int aDiameter, int aCornerCount,
1146  double aOrient, EDA_DRAW_MODE_T aTraceMode,
1147  void* aData )
1148 {
1149  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1150 
1151  if( aTraceMode == SKETCH )
1152  {
1153  // Build the polygon:
1154  std::vector< wxPoint > cornerList;
1155 
1156  double angle_delta = 3600.0 / aCornerCount; // in 0.1 degree
1157 
1158  for( int ii = 0; ii < aCornerCount; ii++ )
1159  {
1160  double rot = aOrient + (angle_delta*ii);
1161  wxPoint vertice( aDiameter/2, 0 );
1162  RotatePoint( &vertice, rot );
1163  vertice += aShapePos;
1164  cornerList.push_back( vertice );
1165  }
1166 
1167  cornerList.push_back( cornerList[0] ); // Close the shape
1168 
1169  PlotPoly( cornerList, NO_FILL, GetCurrentLineWidth(), gbr_metadata );
1170  }
1171  else
1172  {
1173  DPOINT pos_dev = userToDeviceCoordinates( aShapePos );
1174 
1175  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1176 
1177  APERTURE::APERTURE_TYPE apert_type =
1179  selectAperture( aDiameter, aOrient, apert_type, aperture_attrib );
1180 
1181  if( gbr_metadata )
1182  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1183 
1184  emitDcode( pos_dev, 3 );
1185  }
1186 }
1187 
1188 
1189 void GERBER_PLOTTER::Text( const wxPoint& aPos, const COLOR4D aColor,
1190  const wxString& aText, double aOrient, const wxSize& aSize,
1191  enum EDA_TEXT_HJUSTIFY_T aH_justify,
1192  enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic,
1193  bool aBold, bool aMultilineAllowed, void* aData )
1194 {
1195  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1196 
1197  if( gbr_metadata )
1198  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1199 
1200  PLOTTER::Text( aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aWidth, aItalic,
1201  aBold, aMultilineAllowed, aData );
1202 }
1203 
1204 
1205 void GERBER_PLOTTER::SetLayerPolarity( bool aPositive )
1206 {
1207  if( aPositive )
1208  fprintf( outputFile, "%%LPD*%%\n" );
1209  else
1210  fprintf( outputFile, "%%LPC*%%\n" );
1211 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:267
virtual void FlashPadRoundRect(const wxPoint &aPadPos, const wxSize &aSize, int aCornerRadius, double aOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
Roundrect pad at the moment are not handled as aperture, since they require aperture macros TODO: alw...
a class to handle special data (items attributes) during plot.
void writeApertureList()
Generate the table of D codes.
void clearNetAttribute()
clear a Gerber net attribute record (clear object attribute dictionary) and output the clear object a...
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:47
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
#define KI_FALLTHROUGH
virtual void PenTo(const wxPoint &pos, char plume) override
moveto/lineto primitive, moves the 'pen' to the specified direction
void PenFinish()
Definition: plotter.h:273
virtual void FlashPadTrapez(const wxPoint &aPadPos, const wxPoint *aCorners, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
Trapezoidal pad at the moment are never handled as aperture, since they require aperture macros TODO:...
int OutlineCount() const
Returns the number of outlines in the set
void plotRoundRectAsRegion(const wxPoint &aRectCenter, const wxSize &aSize, int aCornerRadius, double aOrient)
Plot a round rect (a round rect shape in fact) as a Gerber region using lines and arcs for corners.
int GetOrCreateAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
virtual void SetLayerPolarity(bool aPositive) override
Change the plot polarity and begin a new layer Used to 'scratch off' silk screen away from solder mas...
APERTURE_TYPE
Definition: plotter.h:1079
virtual void EndBlock(void *aData) override
calling this function allows one to define the end of a group of drawing items the group is started b...
APERTURE_TYPE m_Type
Definition: plotter.h:1145
wxSize m_Size
Definition: plotter.h:1150
bool m_useNetAttributes
Definition: plotter.h:1428
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
virtual void FlashPadCustom(const wxPoint &aPadPos, const wxSize &aSize, SHAPE_POLY_SET *aPolygons, EDA_DRAW_MODE_T aTraceMode, void *aData) override
virtual function FlashPadCustom
virtual void FlashRegularPolygon(const wxPoint &aShapePos, int aDiameter, int aCornerCount, double aOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
Flash a regular polygon.
void plotArc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, bool aPlotInRegion)
Plot a Gerber arc.
bool FormatNetAttribute(std::string &aPrintedText, std::string &aLastNetAttributes, GBR_NETLIST_METADATA *aData, bool &aClearPreviousAttributes, bool aUseX1StructuredComment)
Generates the string to print to a gerber file, to set a net attribute for a graphic object.
void selectAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
char penState
Definition: plotter.h:592
this class handle info which can be added in a gerber file as attribute of an object the GBR_INFO_TYP...
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
double m_IUsPerDecimil
Definition: plotter.h:571
void Inflate(int aAmount, int aCircleSegmentsCount, CORNER_STRATEGY aCornerStrategy=ROUND_ALL_CORNERS)
Performs outline inflation/deflation.
bool m_gerberUnitInch
Definition: plotter.h:1423
int PointCount() const
Function PointCount()
wxArrayString m_headerExtraLines
Definition: plotter.h:601
virtual void FlashPadOval(const wxPoint &pos, const wxSize &size, double orient, EDA_DRAW_MODE_T trace_mode, void *aData) override
Filled oval flashes are handled as aperture in the 90 degree positions only.
wxPoint plotOffset
Plot offset (in IUs)
Definition: plotter.h:577
virtual bool StartPlot() override
Function StartPlot Write GERBER header to file initialize global variable g_Plot_PlotOutputFile.
This file contains miscellaneous commonly used macros and functions.
virtual void ThickRect(const wxPoint &p1, const wxPoint &p2, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
virtual void Text(const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL)
Draws text with the plotter.
Definition: gr_text.cpp:222
virtual void Text(const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL) override
Draws text with the plotter.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
const VECTOR2I & CPoint(int aIndex) const
Function Point()
wxString m_ExtraData
a string to print after TO object attributes, if not empty it is printed "as this"
void LineTo(const wxPoint &pos)
Definition: plotter.h:262
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:119
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr) override
Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence.
std::vector< APERTURE > m_apertures
Definition: plotter.h:1420
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:581
void ClearAllAttributes()
Remove (clear) all attributes from object attributes dictionary (TO.
#define NULL
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
wxString GetBuildVersion()
Get the full KiCad version string.
SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
EDA_DRAW_MODE_T
Definition: eda_text.h:62
int m_gerberUnitFmt
Definition: plotter.h:1424
Base window classes and related definitions.
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:565
virtual void SetViewport(const wxPoint &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the plot offset and scaling for the current plot.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:165
RENDER_SETTINGS * m_renderSettings
Definition: plotter.h:603
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate (fo...
virtual void ThickArc(const wxPoint &centre, double StAngle, double EndAngle, int rayon, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
FILE * finalFile
Definition: plotter.h:1412
virtual void FlashPadCircle(const wxPoint &pos, int diametre, EDA_DRAW_MODE_T trace_mode, void *aData) override
Filled circular flashes are stored as apertures.
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:54
void MoveTo(const wxPoint &pos)
Definition: plotter.h:257
bool m_useX2format
Definition: plotter.h:1426
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:94
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment)
double cosdecideg(double r, double a)
Circle generation utility: computes r * cos(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:408
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:399
virtual void StartBlock(void *aData) override
calling this function allows one to define the beginning of a group of drawing items (used in X2 form...
virtual void Arc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
Generic fallback: arc rendered as a polyline.
int currentPenWidth
Definition: plotter.h:591
void PlotGerberRegion(const std::vector< wxPoint > &aCornerList, void *aData=NULL)
Plot a Gerber region: similar to PlotPoly but plot only filled polygon, and add the TA....
virtual bool EndPlot() override
SHAPE_LINE_CHAIN.
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
std::string m_objectAttributesDictionnary
Definition: plotter.h:1406
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
#define TO_UTF8(wxstring)
The common library.
int GetPlotterArcHighDef() const
Definition: plotter.h:223
virtual void SetGerberCoordinatesFormat(int aResolution, bool aUseInches=false) override
Function SetGerberCoordinatesFormat selection of Gerber units and resolution (number of digits in man...
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:42
virtual void FlashPadRect(const wxPoint &pos, const wxSize &size, double orient, EDA_DRAW_MODE_T trace_mode, void *aData) override
Filled rect flashes are handled as aperture in the 0 90 180 or 270 degree orientation only and as pol...
int GetDefaultPenWidth() const
wxString m_workFilename
Definition: plotter.h:1413
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212
int m_apertureAttribute
Definition: plotter.h:1409
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
int m_DCode
Definition: plotter.h:1153
int m_ApertureAttribute
Definition: plotter.h:1158
FILE * workFile
Definition: plotter.h:1411
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aError)
convert a rectangle with rounded corners and/or chamfered corners to a polygon Convert rounded corner...
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:574
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:118
void segmentAsOval(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode)
Cdonvert a thick segment and plot it as an oval.
Definition: plotter.cpp:438
wxString filename
Definition: plotter.h:596
virtual void ThickCircle(const wxPoint &pos, int diametre, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
void sketchOval(const wxPoint &pos, const wxSize &size, double orient, int width)
Definition: plotter.cpp:459
wxString creator
Definition: plotter.h:595
wxSize paperSize
Definition: plotter.h:599
GBR_APERTURE_METADATA m_ApertureMetadata
a item to handle aperture attribute:
Definition: gbr_metadata.h:207
int m_currentApertureIdx
Definition: plotter.h:1421
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99