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) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2018 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 
41 #include <build_version.h>
42 
43 #include <gbr_metadata.h>
44 
45 
47 {
48  workFile = NULL;
49  finalFile = NULL;
50  currentAperture = apertures.end();
52 
53  // number of digits after the point (number of digits of the mantissa
54  // Be carefull: the Gerber coordinates are stored in an integer
55  // so 6 digits (inches) or 5 digits (mm) is a good value
56  // To avoid overflow, 7 digits (inches) or 6 digits is a max.
57  // with lower values than 6 digits (inches) or 5 digits (mm),
58  // Creating self-intersecting polygons from non-intersecting polygons
59  // happen easily.
60  m_gerberUnitInch = false;
61  m_gerberUnitFmt = 6;
62  m_useX2format = true;
63  m_useNetAttributes = true;
64 }
65 
66 
67 void GERBER_PLOTTER::SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
68  double aScale, bool aMirror )
69 {
70  wxASSERT( aMirror == false );
71  m_plotMirror = false;
72  plotOffset = aOffset;
73  wxASSERT( aScale == 1 ); // aScale parameter is not used in Gerber
74  plotScale = 1; // Plot scale is *always* 1.0
75 
76  m_IUsPerDecimil = aIusPerDecimil;
77  // gives now a default value to iuPerDeviceUnit (because the units of the caller is now known)
78  // which could be modified later by calling SetGerberCoordinatesFormat()
79  iuPerDeviceUnit = pow( 10.0, m_gerberUnitFmt ) / ( m_IUsPerDecimil * 10000.0 );
80 
81  // We don't handle the filmbox, and it's more useful to keep the
82  // origin at the origin
83  paperSize.x = 0;
84  paperSize.y = 0;
85  SetDefaultLineWidth( 100 * aIusPerDecimil ); // Arbitrary default
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",
105  KiROUND( pt.x ), KiROUND( pt.y ), dcode );
106 }
107 
108 
110 {
111  // disable a Gerber net attribute (exists only in X2 with net attributes mode).
112  if( m_objectAttributesDictionnary.empty() ) // No net attribute or not X2 mode
113  return;
114 
115  // Remove all net attributes from object attributes dictionnary
116  if( m_useX2format )
117  fputs( "%TD*%\n", outputFile );
118  else
119  fputs( "G04 #@! TD*\n", outputFile );
120 
122 }
123 
124 
125 void GERBER_PLOTTER::StartBlock( void* aData )
126 {
127  // Currently, it is the same as EndBlock(): clear all aperture net attributes
128  EndBlock( aData );
129 }
130 
131 
132 void GERBER_PLOTTER::EndBlock( void* aData )
133 {
134  // Remove all net attributes from object attributes dictionnary
136 }
137 
138 
140 {
141  // print a Gerber net attribute record.
142  // it is added to the object attributes dictionnary
143  // On file, only modified or new attributes are printed.
144  if( aData == NULL )
145  return;
146 
147  if( !m_useNetAttributes )
148  return;
149 
150  bool useX1StructuredComment = !m_useX2format;
151 
152  bool clearDict;
153  std::string short_attribute_string;
154 
155  if( !FormatNetAttribute( short_attribute_string, m_objectAttributesDictionnary,
156  aData, clearDict, useX1StructuredComment ) )
157  return;
158 
159  if( clearDict )
161 
162  if( !short_attribute_string.empty() )
163  fputs( short_attribute_string.c_str(), outputFile );
164 }
165 
166 
168 {
169  wxASSERT( outputFile );
170 
171  finalFile = outputFile; // the actual gerber file will be created later
172 
173  // Create a temporary filename to store gerber file
174  // note tmpfile() does not work under Vista and W7 in user mode
175  m_workFilename = filename + wxT(".tmp");
176  workFile = wxFopen( m_workFilename, wxT( "wt" ));
178  wxASSERT( outputFile );
179 
180  if( outputFile == NULL )
181  return false;
182 
183  for( unsigned ii = 0; ii < m_headerExtraLines.GetCount(); ii++ )
184  {
185  if( ! m_headerExtraLines[ii].IsEmpty() )
186  fprintf( outputFile, "%s\n", TO_UTF8( m_headerExtraLines[ii] ) );
187  }
188 
189  // Set coordinate format to 3.6 or 4.5 absolute, leading zero omitted
190  // the number of digits for the integer part of coordintes is needed
191  // in gerber format, but is not very important when omitting leading zeros
192  // It is fixed here to 3 (inch) or 4 (mm), but is not actually used
193  int leadingDigitCount = m_gerberUnitInch ? 3 : 4;
194 
195  fprintf( outputFile, "%%FSLAX%d%dY%d%d*%%\n",
196  leadingDigitCount, m_gerberUnitFmt,
197  leadingDigitCount, m_gerberUnitFmt );
198  fprintf( outputFile,
199  "G04 Gerber Fmt %d.%d, Leading zero omitted, Abs format (unit %s)*\n",
200  leadingDigitCount, m_gerberUnitFmt,
201  m_gerberUnitInch ? "inch" : "mm" );
202 
203  wxString Title = creator + wxT( " " ) + GetBuildVersion();
204  fprintf( outputFile, "G04 Created by KiCad (%s) date %s*\n",
205  TO_UTF8( Title ), TO_UTF8( DateAndTime() ) );
206 
207  /* Mass parameter: unit = INCHES/MM */
208  if( m_gerberUnitInch )
209  fputs( "%MOIN*%\n", outputFile );
210  else
211  fputs( "%MOMM*%\n", outputFile );
212 
213  // Be sure the usual dark polarity is selected:
214  fputs( "%LPD*%\n", outputFile );
215 
216  fputs( "G04 APERTURE LIST*\n", outputFile );
217 
218  return true;
219 }
220 
221 
223 {
224  char line[1024];
225  wxString msg;
226 
227  wxASSERT( outputFile );
228 
229  /* Outfile is actually a temporary file i.e. workFile */
230  fputs( "M02*\n", outputFile );
231  fflush( outputFile );
232 
233  fclose( workFile );
234  workFile = wxFopen( m_workFilename, wxT( "rt" ));
235  wxASSERT( workFile );
237 
238  // Placement of apertures in RS274X
239  while( fgets( line, 1024, workFile ) )
240  {
241  fputs( line, outputFile );
242 
243  if( strcmp( strtok( line, "\n\r" ), "G04 APERTURE LIST*" ) == 0 )
244  {
246  fputs( "G04 APERTURE END LIST*\n", outputFile );
247  }
248  }
249 
250  fclose( workFile );
251  fclose( finalFile );
252  ::wxRemoveFile( m_workFilename );
253  outputFile = 0;
254 
255  return true;
256 }
257 
258 
260 {
261  defaultPenWidth = width;
262  currentAperture = apertures.end();
263 }
264 
265 
266 void GERBER_PLOTTER::SetCurrentLineWidth( int width, void* aData )
267 {
268  if( width == DO_NOT_SET_LINE_WIDTH )
269  return;
270 
271  int pen_width;
272 
273  if( width > 0 )
274  pen_width = width;
275  else
276  pen_width = defaultPenWidth;
277 
278  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
279  int aperture_attribute = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
280 
281  selectAperture( wxSize( pen_width, pen_width ), APERTURE::Plotting, aperture_attribute );
282  currentPenWidth = pen_width;
283 }
284 
285 
286 std::vector<APERTURE>::iterator GERBER_PLOTTER::getAperture( const wxSize& aSize,
287  APERTURE::APERTURE_TYPE aType, int aApertureAttribute )
288 {
289  int last_D_code = 9;
290 
291  // Search an existing aperture
292  std::vector<APERTURE>::iterator tool = apertures.begin();
293 
294  while( tool != apertures.end() )
295  {
296  last_D_code = tool->m_DCode;
297 
298  if( (tool->m_Type == aType) && (tool->m_Size == aSize) &&
299  (tool->m_ApertureAttribute == aApertureAttribute) )
300  return tool;
301 
302  ++tool;
303  }
304 
305  // Allocate a new aperture
306  APERTURE new_tool;
307  new_tool.m_Size = aSize;
308  new_tool.m_Type = aType;
309  new_tool.m_DCode = last_D_code + 1;
310  new_tool.m_ApertureAttribute = aApertureAttribute;
311 
312  apertures.push_back( new_tool );
313 
314  return apertures.end() - 1;
315 }
316 
317 
318 void GERBER_PLOTTER::selectAperture( const wxSize& aSize,
320  int aApertureAttribute )
321 {
322  bool change = ( currentAperture == apertures.end() ) ||
323  ( currentAperture->m_Type != aType ) ||
324  ( currentAperture->m_Size != aSize );
325 
326  if( !m_useNetAttributes )
327  aApertureAttribute = 0;
328  else
329  change = change || ( currentAperture->m_ApertureAttribute != aApertureAttribute );
330 
331  if( change )
332  {
333  // Pick an existing aperture or create a new one
334  currentAperture = getAperture( aSize, aType, aApertureAttribute );
335  fprintf( outputFile, "D%d*\n", currentAperture->m_DCode );
336  }
337 }
338 
339 
341 {
342  wxASSERT( outputFile );
343  char cbuf[1024];
344 
345  bool useX1StructuredComment = false;
346 
347  if( !m_useX2format )
348  useX1StructuredComment = true;
349 
350  // Init
351  for( std::vector<APERTURE>::iterator tool = apertures.begin();
352  tool != apertures.end(); ++tool )
353  {
354  // apertude sizes are in inch or mm, regardless the
355  // coordinates format
356  double fscale = 0.0001 * plotScale / m_IUsPerDecimil; // inches
357 
358  if(! m_gerberUnitInch )
359  fscale *= 25.4; // size in mm
360 
361  int attribute = tool->m_ApertureAttribute;
362 
363  if( attribute != m_apertureAttribute )
364  {
367  useX1StructuredComment ).c_str(), outputFile );
368  }
369 
370  char* text = cbuf + sprintf( cbuf, "%%ADD%d", tool->m_DCode );
371 
372  /* Please note: the Gerber specs for mass parameters say that
373  exponential syntax is *not* allowed and the decimal point should
374  also be always inserted. So the %g format is ruled out, but %f is fine
375  (the # modifier forces the decimal point). Sadly the %f formatter
376  can't remove trailing zeros but thats not a problem, since nothing
377  forbid it (the file is only slightly longer) */
378 
379  switch( tool->m_Type )
380  {
381  case APERTURE::Circle:
382  sprintf( text, "C,%#f*%%\n", tool->m_Size.x * fscale );
383  break;
384 
385  case APERTURE::Rect:
386  sprintf( text, "R,%#fX%#f*%%\n",
387  tool->m_Size.x * fscale,
388  tool->m_Size.y * fscale );
389  break;
390 
391  case APERTURE::Plotting:
392  sprintf( text, "C,%#f*%%\n", tool->m_Size.x * fscale );
393  break;
394 
395  case APERTURE::Oval:
396  sprintf( text, "O,%#fX%#f*%%\n",
397  tool->m_Size.x * fscale,
398  tool->m_Size.y * fscale );
399  break;
400  }
401 
402  fputs( cbuf, outputFile );
403 
404  m_apertureAttribute = attribute;
405 
406  // Currently reset the aperture attribute. Perhaps a better optimization
407  // is to store the last attribute
408  if( attribute )
409  {
410  if( m_useX2format )
411  fputs( "%TD*%\n", outputFile );
412  else
413  fputs( "G04 #@! TD*\n", outputFile );
414 
416  }
417 
418  }
419 }
420 
421 
422 void GERBER_PLOTTER::PenTo( const wxPoint& aPos, char plume )
423 {
424  wxASSERT( outputFile );
425  DPOINT pos_dev = userToDeviceCoordinates( aPos );
426 
427  switch( plume )
428  {
429  case 'Z':
430  break;
431 
432  case 'U':
433  emitDcode( pos_dev, 2 );
434  break;
435 
436  case 'D':
437  emitDcode( pos_dev, 1 );
438  }
439 
440  penState = plume;
441 }
442 
443 
444 void GERBER_PLOTTER::Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill, int width )
445 {
446  std::vector< wxPoint > cornerList;
447 
448  // Build corners list
449  cornerList.push_back( p1 );
450  wxPoint corner(p1.x, p2.y);
451  cornerList.push_back( corner );
452  cornerList.push_back( p2 );
453  corner.x = p2.x;
454  corner.y = p1.y;
455  cornerList.push_back( corner );
456  cornerList.push_back( p1 );
457 
458  PlotPoly( cornerList, fill, width );
459 }
460 
461 
462 void GERBER_PLOTTER::Circle( const wxPoint& aCenter, int aDiameter, FILL_T aFill, int aWidth )
463 {
464  Arc( aCenter, 0, 3600, aDiameter / 2, aFill, aWidth );
465 }
466 
467 
468 void GERBER_PLOTTER::Arc( const wxPoint& aCenter, double aStAngle, double aEndAngle,
469  int aRadius, FILL_T aFill, int aWidth )
470 {
471  SetCurrentLineWidth( aWidth );
472 
473  wxPoint start, end;
474  start.x = aCenter.x + KiROUND( cosdecideg( aRadius, aStAngle ) );
475  start.y = aCenter.y - KiROUND( sindecideg( aRadius, aStAngle ) );
476  MoveTo( start );
477  end.x = aCenter.x + KiROUND( cosdecideg( aRadius, aEndAngle ) );
478  end.y = aCenter.y - KiROUND( sindecideg( aRadius, aEndAngle ) );
479  DPOINT devEnd = userToDeviceCoordinates( end );
480  DPOINT devCenter = userToDeviceCoordinates( aCenter ) - userToDeviceCoordinates( start );
481 
482  fprintf( outputFile, "G75*\n" ); // Multiquadrant (360 degrees) mode
483 
484  if( aStAngle < aEndAngle )
485  fprintf( outputFile, "G03" );
486  else
487  fprintf( outputFile, "G02" );
488 
489  fprintf( outputFile, "X%dY%dI%dJ%dD01*\n",
490  KiROUND( devEnd.x ), KiROUND( devEnd.y ),
491  KiROUND( devCenter.x ), KiROUND( devCenter.y ) );
492 
493  fprintf( outputFile, "G01*\n" ); // Back to linear interpol (perhaps useless here).
494 }
495 
496 
497 void GERBER_PLOTTER:: PlotPoly( const std::vector< wxPoint >& aCornerList,
498  FILL_T aFill, int aWidth, void * aData )
499 {
500  if( aCornerList.size() <= 1 )
501  return;
502 
503  // Gerber format does not know filled polygons with thick outline
504  // Therefore, to plot a filled polygon with outline having a thickness,
505  // one should plot outline as thick segments
506  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
507 
508  SetCurrentLineWidth( aWidth, gbr_metadata );
509 
510  if( gbr_metadata )
511  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
512 
513  if( aFill )
514  {
515  fputs( "G36*\n", outputFile );
516 
517  MoveTo( aCornerList[0] );
518  fputs( "G01*\n", outputFile ); // Set linear interpolation.
519 
520  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
521  LineTo( aCornerList[ii] );
522 
523  FinishTo( aCornerList[0] );
524  fputs( "G37*\n", outputFile );
525  }
526 
527  if( aWidth > 0 )
528  {
529  MoveTo( aCornerList[0] );
530 
531  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
532  LineTo( aCornerList[ii] );
533 
534  // Ensure the thick outline is closed for filled polygons
535  // (if not filled, could be only a polyline)
536  if( aFill && ( aCornerList[aCornerList.size()-1] != aCornerList[0] ) )
537  LineTo( aCornerList[0] );
538 
539  PenFinish();
540  }
541 }
542 
543 
544 void GERBER_PLOTTER::ThickSegment( const wxPoint& start, const wxPoint& end, int width,
545  EDA_DRAW_MODE_T tracemode, void* aData )
546 {
547  if( tracemode == FILLED )
548  {
549  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
550  SetCurrentLineWidth( width, gbr_metadata );
551 
552  if( gbr_metadata )
553  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
554 
555  MoveTo( start );
556  FinishTo( end );
557  }
558  else
559  {
561  segmentAsOval( start, end, width, tracemode );
562  }
563 }
564 
565 void GERBER_PLOTTER::ThickArc( const wxPoint& centre, double StAngle, double EndAngle,
566  int radius, int width, EDA_DRAW_MODE_T tracemode, void* aData )
567 {
568  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
569  SetCurrentLineWidth( width, gbr_metadata );
570 
571  if( gbr_metadata )
572  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
573 
574  if( tracemode == FILLED )
575  Arc( centre, StAngle, EndAngle, radius, NO_FILL, DO_NOT_SET_LINE_WIDTH );
576  else
577  {
579  Arc( centre, StAngle, EndAngle,
580  radius - ( width - currentPenWidth ) / 2,
582  Arc( centre, StAngle, EndAngle,
583  radius + ( width - currentPenWidth ) / 2, NO_FILL,
585  }
586 }
587 
588 
589 void GERBER_PLOTTER::ThickRect( const wxPoint& p1, const wxPoint& p2, int width,
590  EDA_DRAW_MODE_T tracemode, void* aData )
591 {
592  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
593  SetCurrentLineWidth( width, gbr_metadata );
594 
595  if( gbr_metadata )
596  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
597 
598  if( tracemode == FILLED )
599  Rect( p1, p2, NO_FILL, DO_NOT_SET_LINE_WIDTH );
600  else
601  {
603  wxPoint offsetp1( p1.x - (width - currentPenWidth) / 2,
604  p1.y - (width - currentPenWidth) / 2 );
605  wxPoint offsetp2( p2.x + (width - currentPenWidth) / 2,
606  p2.y + (width - currentPenWidth) / 2 );
607  Rect( offsetp1, offsetp2, NO_FILL, -1 );
608  offsetp1.x += (width - currentPenWidth);
609  offsetp1.y += (width - currentPenWidth);
610  offsetp2.x -= (width - currentPenWidth);
611  offsetp2.y -= (width - currentPenWidth);
612  Rect( offsetp1, offsetp2, NO_FILL, DO_NOT_SET_LINE_WIDTH );
613  }
614 }
615 
616 
617 void GERBER_PLOTTER::ThickCircle( const wxPoint& pos, int diametre, int width,
618  EDA_DRAW_MODE_T tracemode, void* aData )
619 {
620  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
621  SetCurrentLineWidth( width, gbr_metadata );
622 
623  if( gbr_metadata )
624  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
625 
626  if( tracemode == FILLED )
627  Circle( pos, diametre, NO_FILL, DO_NOT_SET_LINE_WIDTH );
628  else
629  {
631  Circle( pos, diametre - (width - currentPenWidth),
633  Circle( pos, diametre + (width - currentPenWidth),
635  }
636 }
637 
638 
639 void GERBER_PLOTTER::FlashPadCircle( const wxPoint& pos, int diametre, EDA_DRAW_MODE_T trace_mode, void* aData )
640 {
641  wxSize size( diametre, diametre );
642  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
643 
644  if( trace_mode == SKETCH )
645  {
647 
648  if( gbr_metadata )
649  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
650 
652  }
653  else
654  {
655  DPOINT pos_dev = userToDeviceCoordinates( pos );
656 
657  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
658  selectAperture( size, APERTURE::Circle, aperture_attrib );
659 
660  if( gbr_metadata )
661  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
662 
663  emitDcode( pos_dev, 3 );
664  }
665 }
666 
667 
668 void GERBER_PLOTTER::FlashPadOval( const wxPoint& pos, const wxSize& aSize, double orient,
669  EDA_DRAW_MODE_T trace_mode, void* aData )
670 {
671  wxASSERT( outputFile );
672  wxSize size( aSize );
673  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
674 
675  /* Plot a flashed shape. */
676  if( ( orient == 0 || orient == 900 || orient == 1800 || orient == 2700 )
677  && trace_mode == FILLED )
678  {
679  if( orient == 900 || orient == 2700 ) /* orientation turned 90 deg. */
680  std::swap( size.x, size.y );
681 
682  DPOINT pos_dev = userToDeviceCoordinates( pos );
683  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
684  selectAperture( size, APERTURE::Oval, aperture_attrib );
685 
686  if( gbr_metadata )
687  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
688 
689  emitDcode( pos_dev, 3 );
690  }
691  else /* Plot pad as a segment. */
692  {
693  if( size.x > size.y )
694  {
695  std::swap( size.x, size.y );
696 
697  if( orient < 2700 )
698  orient += 900;
699  else
700  orient -= 2700;
701  }
702 
703  if( trace_mode == FILLED )
704  {
705  // TODO: use an aperture macro to declare the rotated pad
706 
707  // Flash a pad anchor, if a netlist attribute is set
708  if( aData )
709  FlashPadCircle( pos, size.x, trace_mode, aData );
710 
711  // The pad is reduced to an segment with dy > dx
712  int delta = size.y - size.x;
713  int x0 = 0;
714  int y0 = -delta / 2;
715  int x1 = 0;
716  int y1 = delta / 2;
717  RotatePoint( &x0, &y0, orient );
718  RotatePoint( &x1, &y1, orient );
719  GBR_METADATA metadata;
720 
721  if( gbr_metadata )
722  {
723  metadata = *gbr_metadata;
724 
725  // If the pad is drawn on a copper layer,
726  // set attribute to GBR_APERTURE_ATTRIB_CONDUCTOR
727  if( metadata.IsCopper() )
729 
730  // Clear .P attribute, only allowed for flashed items
731  wxString attrname( ".P" );
732  metadata.m_NetlistMetadata.ClearAttribute( &attrname );
733  }
734 
735  ThickSegment( wxPoint( pos.x + x0, pos.y + y0 ),
736  wxPoint( pos.x + x1, pos.y + y1 ),
737  size.x, trace_mode, &metadata );
738  }
739  else
740  {
741  sketchOval( pos, size, orient, -1 );
742  }
743  }
744 }
745 
746 
747 void GERBER_PLOTTER::FlashPadRect( const wxPoint& pos, const wxSize& aSize,
748  double orient, EDA_DRAW_MODE_T trace_mode, void* aData )
749 
750 {
751  wxASSERT( outputFile );
752  wxSize size( aSize );
753  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
754 
755  // Plot as an aperture flash
756  switch( int( orient ) )
757  {
758  case 900:
759  case 2700: // rotation of 90 degrees or 270 swaps sizes
760  std::swap( size.x, size.y );
761  // Pass through
762  case 0:
763  case 1800:
764  if( trace_mode == SKETCH )
765  {
767 
768  if( gbr_metadata )
769  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
770 
771  Rect( wxPoint( pos.x - (size.x - currentPenWidth) / 2,
772  pos.y - (size.y - currentPenWidth) / 2 ),
773  wxPoint( pos.x + (size.x - currentPenWidth) / 2,
774  pos.y + (size.y - currentPenWidth) / 2 ),
776  }
777  else
778  {
779  DPOINT pos_dev = userToDeviceCoordinates( pos );
780  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
781  selectAperture( size, APERTURE::Rect, aperture_attrib );
782 
783  if( gbr_metadata )
784  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
785 
786  emitDcode( pos_dev, 3 );
787  }
788  break;
789 
790  default: // plot pad shape as polygon
791  {
792  // XXX to do: use an aperture macro to declare the rotated pad
793  wxPoint coord[4];
794  // coord[0] is assumed the lower left
795  // coord[1] is assumed the upper left
796  // coord[2] is assumed the upper right
797  // coord[3] is assumed the lower right
798 
799  /* Trace the outline. */
800  coord[0].x = -size.x/2; // lower left
801  coord[0].y = size.y/2;
802  coord[1].x = -size.x/2; // upper left
803  coord[1].y = -size.y/2;
804  coord[2].x = size.x/2; // upper right
805  coord[2].y = -size.y/2;
806  coord[3].x = size.x/2; // lower right
807  coord[3].y = size.y/2;
808 
809  FlashPadTrapez( pos, coord, orient, trace_mode, aData );
810  }
811  break;
812  }
813 }
814 
815 void GERBER_PLOTTER::FlashPadRoundRect( const wxPoint& aPadPos, const wxSize& aSize,
816  int aCornerRadius, double aOrient,
817  EDA_DRAW_MODE_T aTraceMode, void* aData )
818 
819 {
820  GBR_METADATA gbr_metadata;
821 
822  if( aData )
823  {
824  gbr_metadata = *static_cast<GBR_METADATA*>( aData );
825  // If the pad is drawn on a copper layer,
826  // set attribute to GBR_APERTURE_ATTRIB_CONDUCTOR
827  if( gbr_metadata.IsCopper() )
829 
830  wxString attrname( ".P" );
831  gbr_metadata.m_NetlistMetadata.ClearAttribute( &attrname ); // not allowed on inner layers
832  }
833 
834  if( aTraceMode != FILLED )
836 
837  // Currently, a Pad RoundRect is plotted as polygon.
838  // TODO: use Aperture macro and flash it
839  SHAPE_POLY_SET outline;
840  const int segmentToCircleCount = 64;
841  TransformRoundRectToPolygon( outline, aPadPos, aSize, aOrient,
842  aCornerRadius, segmentToCircleCount );
843 
844  if( aTraceMode != FILLED )
845  outline.Inflate( -GetCurrentLineWidth()/2, 16 );
846 
847  std::vector< wxPoint > cornerList;
848  // TransformRoundRectToPolygon creates only one convex polygon
849  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
850  cornerList.reserve( poly.PointCount() + 1 );
851 
852  for( int ii = 0; ii < poly.PointCount(); ++ii )
853  cornerList.push_back( wxPoint( poly.Point( ii ).x, poly.Point( ii ).y ) );
854 
855  // Close polygon
856  cornerList.push_back( cornerList[0] );
857 
858  PlotPoly( cornerList, aTraceMode == FILLED ? FILLED_SHAPE : NO_FILL,
859  aTraceMode == FILLED ? 0 : GetCurrentLineWidth(), &gbr_metadata );
860 
861  // Now, flash a pad anchor, if a netlist attribute is set
862  // (remove me when a Aperture macro will be used)
863  if( aData && aTraceMode == FILLED )
864  {
865  int diameter = std::min( aSize.x, aSize.y );
866  FlashPadCircle( aPadPos, diameter, aTraceMode , aData );
867  }
868 }
869 
870 void GERBER_PLOTTER::FlashPadCustom( const wxPoint& aPadPos, const wxSize& aSize,
871  SHAPE_POLY_SET* aPolygons,
872  EDA_DRAW_MODE_T aTraceMode, void* aData )
873 
874 {
875  // A Pad custom is plotted as polygon.
876 
877  // A flashed circle @aPadPos is added (anchor pad)
878  // However, because the anchor pad can be circle or rect, we use only
879  // a circle not bigger than the rect.
880  // the main purpose is to print a flashed DCode as pad anchor
881  if( aTraceMode == FILLED )
882  FlashPadCircle( aPadPos, std::min( aSize.x, aSize.y ), aTraceMode, aData );
883 
884  GBR_METADATA gbr_metadata;
885 
886  if( aData )
887  {
888  gbr_metadata = *static_cast<GBR_METADATA*>( aData );
889  // If the pad is drawn on a copper layer,
890  // set attribute to GBR_APERTURE_ATTRIB_CONDUCTOR
891  if( gbr_metadata.IsCopper() )
893 
894  wxString attrname( ".P" );
895  gbr_metadata.m_NetlistMetadata.ClearAttribute( &attrname ); // not allowed on inner layers
896  }
897 
898  SHAPE_POLY_SET polyshape = *aPolygons;
899 
900  if( aTraceMode != FILLED )
901  {
903  polyshape.Inflate( -GetCurrentLineWidth()/2, 16 );
904  }
905 
906  std::vector< wxPoint > cornerList;
907 
908  for( int cnt = 0; cnt < polyshape.OutlineCount(); ++cnt )
909  {
910  SHAPE_LINE_CHAIN& poly = polyshape.Outline( cnt );
911 
912  cornerList.clear();
913 
914  for( int ii = 0; ii < poly.PointCount(); ++ii )
915  cornerList.push_back( wxPoint( poly.Point( ii ).x, poly.Point( ii ).y ) );
916 
917  // Close polygon
918  cornerList.push_back( cornerList[0] );
919 
920  PlotPoly( cornerList,
921  aTraceMode == FILLED ? FILLED_SHAPE : NO_FILL,
922  aTraceMode == FILLED ? 0 : GetCurrentLineWidth(), &gbr_metadata );
923  }
924 }
925 
926 
927 void GERBER_PLOTTER::FlashPadTrapez( const wxPoint& aPadPos, const wxPoint* aCorners,
928  double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode, void* aData )
929 
930 {
931  // Currently, a Pad Trapezoid is plotted as polygon.
932  // TODO: use Aperture macro and flash it
933 
934  // polygon corners list
935  std::vector< wxPoint > cornerList;
936 
937  for( int ii = 0; ii < 4; ii++ )
938  cornerList.push_back( aCorners[ii] );
939 
940  // Now, flash a pad anchor, if a netlist attribute is set
941  // (remove me when a Aperture macro will be used)
942  if( aData && ( aTrace_Mode == FILLED ) )
943  {
944  // Calculate the radius of the circle inside the shape
945  // It is the smaller dist from shape pos to edges
946  int radius = INT_MAX;
947 
948  for( unsigned ii = 0, jj = cornerList.size()-1; ii < cornerList.size();
949  jj = ii, ii++ )
950  {
951  SEG segment( aCorners[ii], aCorners[jj] );
952  int dist = segment.LineDistance( VECTOR2I( 0, 0) );
953  radius = std::min( radius, dist );
954  }
955 
956  FlashPadCircle( aPadPos, radius*2, aTrace_Mode, aData );
957  }
958 
959  // Draw the polygon and fill the interior as required
960  for( unsigned ii = 0; ii < 4; ii++ )
961  {
962  RotatePoint( &cornerList[ii], aPadOrient );
963  cornerList[ii] += aPadPos;
964  }
965 
966  // Close the polygon
967  cornerList.push_back( cornerList[0] );
968  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
969 
970  GBR_METADATA metadata;
971 
972  if( gbr_metadata )
973  {
974  metadata = *gbr_metadata;
975  // If the pad is drawn on a copper layer,
976  // set attribute to GBR_APERTURE_ATTRIB_CONDUCTOR
977  if( metadata.IsCopper() )
979 
980  wxString attrname( ".P" );
981  metadata.m_NetlistMetadata.ClearAttribute( &attrname ); // not allowed on inner layers
982  }
983 
985  PlotPoly( cornerList, aTrace_Mode == FILLED ? FILLED_SHAPE : NO_FILL,
986  aTrace_Mode == FILLED ? 0 : GetCurrentLineWidth(),
987  &metadata );
988 }
989 
990 
991 void GERBER_PLOTTER::Text( const wxPoint& aPos, const COLOR4D aColor,
992  const wxString& aText, double aOrient, const wxSize& aSize,
993  enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify,
994  int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed,
995  void* aData )
996 {
997  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
998 
999  if( gbr_metadata )
1000  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1001 
1002  PLOTTER::Text( aPos, aColor, aText, aOrient, aSize,
1003  aH_justify, aV_justify, aWidth, aItalic, aBold, aMultilineAllowed, aData );
1004 }
1005 
1006 
1007 void GERBER_PLOTTER::SetLayerPolarity( bool aPositive )
1008 {
1009  if( aPositive )
1010  fprintf( outputFile, "%%LPD*%%\n" );
1011  else
1012  fprintf( outputFile, "%%LPC*%%\n" );
1013 }
virtual void SetDefaultLineWidth(int width) override
Set the default line width.
std::vector< APERTURE >::iterator getAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Function getAperture returns a reference to the aperture which meets the size anf type of tool if the...
void FinishTo(const wxPoint &pos)
Definition: plotter.h:251
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 dictionnary) and output the clear object ...
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:62
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
virtual void PenTo(const wxPoint &pos, char plume) override
moveto/lineto primitive, moves the &#39;pen&#39; to the specified direction
void PenFinish()
Definition: plotter.h:257
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:...
static const int dist[10][10]
Definition: ar_matrix.cpp:320
virtual void SetLayerPolarity(bool aPositive) override
Change the plot polarity and begin a new layer Used to &#39;scratch off&#39; silk screen away from solder mas...
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:121
APERTURE_TYPE
Definition: plotter.h:995
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:1003
int PointCount() const
Function PointCount()
wxSize m_Size
Definition: plotter.h:1002
bool m_useNetAttributes
Definition: plotter.h:1227
void TransformRoundRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, int aCircleToSegmentsCount)
Function TransformRoundRectToPolygon convert a rectangle with rounded corners to a polygon Convert ar...
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 PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL) override
Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence.
bool IsCopper()
Allowed attributes are not the same on board copper layers and on other layers Therefore a flag can b...
Definition: gbr_metadata.h:170
std::vector< APERTURE > apertures
Definition: plotter.h:1218
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.
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
char penState
Current pen state: &#39;U&#39;, &#39;D&#39; or &#39;Z&#39; (see PenTo)
Definition: plotter.h:562
int OutlineCount() const
Returns the number of outlines in the set
this class handle info which can be added in a gerber file as attribute of an obtect the GBR_INFO_TYP...
double m_IUsPerDecimil
Definition: plotter.h:539
bool m_gerberUnitInch
Definition: plotter.h:1221
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587
wxArrayString m_headerExtraLines
Definition: plotter.h:572
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:545
static const int delta[8][2]
Definition: solve.cpp:112
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.
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.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
void LineTo(const wxPoint &pos)
Definition: plotter.h:246
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:102
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:549
void Inflate(int aFactor, int aCircleSegmentsCount)
Performs outline inflation/deflation, using round corners.
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
wxString GetBuildVersion()
Function GetBuildVersion Return the build version string.
Class 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:77
int m_gerberUnitFmt
Definition: plotter.h:1222
int LineDistance(const VECTOR2I &aP, bool aDetermineSide=false) const
Function LineDistance()
Definition: seg.h:357
Base window classes and related definitions.
double plotScale
Plot scale - chosen by the user (even implicitly with &#39;fit in a4&#39;)
Definition: plotter.h:533
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:147
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:1210
virtual void FlashPadCircle(const wxPoint &pos, int diametre, EDA_DRAW_MODE_T trace_mode, void *aData) override
Filled circular flashes are stored as apertures.
aperture used for connected items like tracks (not vias)
Definition: gbr_metadata.h:84
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:69
void MoveTo(const wxPoint &pos)
Definition: plotter.h:241
bool m_useX2format
Definition: plotter.h:1224
Definition: seg.h:36
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:96
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:354
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:345
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:560
virtual int GetCurrentLineWidth() const
Definition: plotter.h:152
int defaultPenWidth
true to generate a negative image (PS mode mainly)
Definition: plotter.h:559
virtual bool EndPlot() override
Class SHAPE_LINE_CHAIN.
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:554
std::string m_objectAttributesDictionnary
Definition: plotter.h:1204
The common library.
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:54
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...
void ClearAttribute(const wxString *aName)
remove the net attribute specified by aName If aName == NULL or empty, remove all attributes ...
VECTOR2I & Point(int aIndex)
Function Point()
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
Definition: gbr_metadata.h:142
wxString m_workFilename
Definition: plotter.h:1211
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:181
int m_apertureAttribute
Definition: plotter.h:1207
Basic classes for most KiCad items.
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
int m_DCode
Definition: plotter.h:1004
int m_ApertureAttribute
Definition: plotter.h:1005
FILE * workFile
Definition: plotter.h:1209
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:542
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:101
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:387
wxString filename
Definition: plotter.h:566
std::vector< APERTURE >::iterator currentAperture
Definition: plotter.h:1219
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:408
wxString creator
Definition: plotter.h:565
wxString DateAndTime()
Function DateAndTime.
Definition: string.cpp:306
wxSize paperSize
Paper size in IU - not in mils.
Definition: plotter.h:570
#define min(a, b)
Definition: auxiliary.h:85
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39