KiCad PCB EDA Suite
GERBER_PLOTTER Class Reference

#include <plotter.h>

Inheritance diagram for GERBER_PLOTTER:
PLOTTER

Public Member Functions

 GERBER_PLOTTER ()
 
virtual PLOT_FORMAT GetPlotterType () const override
 Returns the effective plot engine in use. More...
 
virtual bool StartPlot () override
 Function StartPlot Write GERBER header to file initialize global variable g_Plot_PlotOutputFile. More...
 
virtual bool EndPlot () override
 
virtual void SetCurrentLineWidth (int width, void *aData=NULL) override
 Set the line width for the next drawing. More...
 
virtual void SetDefaultLineWidth (int width) override
 Set the default line width. More...
 
virtual void SetDash (PLOT_DASH_TYPE dashed) override
 
virtual void SetColor (COLOR4D color) override
 
virtual void SetViewport (const wxPoint &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
 Set the plot offset and scaling for the current plot. More...
 
virtual void Rect (const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 
virtual void Circle (const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 
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. More...
 
virtual void ThickSegment (const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
 
virtual void ThickArc (const wxPoint &centre, double StAngle, double EndAngle, int rayon, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
 
virtual void ThickRect (const wxPoint &p1, const wxPoint &p2, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
 
virtual void ThickCircle (const wxPoint &pos, int diametre, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
 
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. More...
 
virtual void PenTo (const wxPoint &pos, char plume) override
 moveto/lineto primitive, moves the 'pen' to the specified direction More...
 
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. More...
 
virtual void FlashPadCircle (const wxPoint &pos, int diametre, EDA_DRAW_MODE_T trace_mode, void *aData) override
 Filled circular flashes are stored as apertures. More...
 
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. More...
 
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 polygon for other orientations TODO: always use flashed shapes (aperture macros) More...
 
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: always use flashed shapes (aperture macros) More...
 
virtual void FlashPadCustom (const wxPoint &aPadPos, const wxSize &aSize, SHAPE_POLY_SET *aPolygons, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 virtual function FlashPadCustom More...
 
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: always use flashed shapes (aperture macros) More...
 
virtual void FlashRegularPolygon (const wxPoint &aShapePos, int aDiameter, int aCornerCount, double aOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 Flash a regular polygon. More...
 
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.AperFunction if aData contains this attribute, and clear it after plotting. More...
 
virtual void SetLayerPolarity (bool aPositive) override
 Change the plot polarity and begin a new layer Used to 'scratch off' silk screen away from solder mask. More...
 
virtual void SetGerberCoordinatesFormat (int aResolution, bool aUseInches=false) override
 Function SetGerberCoordinatesFormat selection of Gerber units and resolution (number of digits in mantissa) More...
 
void UseX2format (bool aEnable)
 
void UseX2NetAttributes (bool aEnable)
 
virtual void StartBlock (void *aData) override
 calling this function allows one to define the beginning of a group of drawing items (used in X2 format with netlist attributes) More...
 
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 by StartBlock() (used in X2 format with netlist attributes) More...
 
void ClearAllAttributes ()
 Remove (clear) all attributes from object attributes dictionary (TO. More...
 
int GetOrCreateAperture (const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 
virtual void SetNegative (bool aNegative)
 
virtual void SetColorMode (bool aColorMode)
 Plot in B/W or color. More...
 
bool GetColorMode () const
 
void SetColorSettings (COLOR_SETTINGS *aSettings)
 
COLOR_SETTINGSColorSettings ()
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings)
 
PAGE_INFOPageSettings ()
 
virtual int GetCurrentLineWidth () const
 
virtual void SetCreator (const wxString &aCreator)
 
virtual void SetTitle (const wxString &aTitle)
 
void AddLineToHeader (const wxString &aExtraString)
 Function AddLineToHeader Add a line to the list of free lines to print at the beginning of the file. More...
 
void ClearHeaderLinesList ()
 Function ClearHeaderLinesList remove all lines from the list of free lines to print at the beginning of the file. More...
 
virtual bool OpenFile (const wxString &aFullFilename)
 Open or create the plot file aFullFilename. More...
 
double GetIUsPerDecimil () const
 The IUs per decimil are an essential scaling factor when plotting; they are set and saved when establishing the viewport. More...
 
int GetPlotterArcLowDef () const
 
int GetPlotterArcHighDef () const
 
virtual void BezierCurve (const wxPoint &aStart, const wxPoint &aControl1, const wxPoint &aControl2, const wxPoint &aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH)
 Generic fallback: Cubic Bezier curve rendered as a polyline In Kicad the bezier curves have 4 control points: start ctrl1 ctrl2 end. More...
 
void MoveTo (const wxPoint &pos)
 
void LineTo (const wxPoint &pos)
 
void FinishTo (const wxPoint &pos)
 
void PenFinish ()
 
virtual void PlotPoly (const SHAPE_LINE_CHAIN &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)
 Function PlotPoly. More...
 
virtual void PlotImage (const wxImage &aImage, const wxPoint &aPos, double aScaleFactor)
 Function PlotImage Only Postscript plotters can plot bitmaps for plotters that cannot plot a bitmap, a rectangle is plotted. More...
 
void Marker (const wxPoint &position, int diametre, unsigned aShapeId)
 Draw a pattern shape number aShapeId, to coord position. More...
 
virtual void SetTextMode (PLOT_TEXT_MODE mode)
 Change the current text mode. More...
 

Static Public Member Functions

static wxString GetDefaultFileExtension ()
 

Static Public Attributes

static const int DO_NOT_SET_LINE_WIDTH = -2
 
static const int USE_DEFAULT_LINE_WIDTH = -1
 
static const unsigned MARKER_COUNT = 58
 Draw a marker (used for the drill map) More...
 

Protected Member Functions

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. More...
 
void selectAperture (int aDiameter, double aPolygonRotation, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 Pick an existing aperture or create a new one, matching the aDiameter, aPolygonRotation, type and attributes. More...
 
void emitDcode (const DPOINT &pt, int dcode)
 Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate (for n decimal positions, see header generation in start_plot. More...
 
void formatNetAttribute (GBR_NETLIST_METADATA *aData)
 print a Gerber net attribute object record. More...
 
void clearNetAttribute ()
 clear a Gerber net attribute record (clear object attribute dictionary) and output the clear object attribute dictionary command to gerber file has effect only if a net attribute is stored in m_objectAttributesDictionnary More...
 
void writeApertureList ()
 Generate the table of D codes. More...
 
void markerCircle (const wxPoint &pos, int radius)
 Plot a circle centered on the position. More...
 
void markerHBar (const wxPoint &pos, int radius)
 Plot a - bar centered on the position. More...
 
void markerSlash (const wxPoint &pos, int radius)
 Plot a / bar centered on the position. More...
 
void markerBackSlash (const wxPoint &pos, int radius)
 Plot a \ bar centered on the position. More...
 
void markerVBar (const wxPoint &pos, int radius)
 Plot a | bar centered on the position. More...
 
void markerSquare (const wxPoint &position, int radius)
 Plot a square centered on the position. More...
 
void markerLozenge (const wxPoint &position, int radius)
 Plot a lozenge centered on the position. More...
 
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. More...
 
void sketchOval (const wxPoint &pos, const wxSize &size, double orient, int width)
 
virtual DPOINT userToDeviceCoordinates (const wxPoint &aCoordinate)
 Modifies coordinates according to the orientation, scale factor, and offsets trace. More...
 
virtual DPOINT userToDeviceSize (const wxSize &size)
 Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT) More...
 
virtual double userToDeviceSize (double size) const
 Modifies size according to the plotter scale factors (simple double version) More...
 
double GetDotMarkLenIU () const
 
double GetDashMarkLenIU () const
 
double GetDashGapLenIU () const
 

Protected Attributes

std::string m_objectAttributesDictionnary
 
int m_apertureAttribute
 
FILE * workFile
 
FILE * finalFile
 
wxString m_workFilename
 
std::vector< APERTUREm_apertures
 
int m_currentApertureIdx
 
bool m_gerberUnitInch
 
int m_gerberUnitFmt
 
bool m_useX2format
 
bool m_useNetAttributes
 
double plotScale
 Plot scale - chosen by the user (even implicitly with 'fit in a4') More...
 
double m_IUsPerDecimil
 
double iuPerDeviceUnit
 Device scale (from IUs to plotter device units - usually decimils) More...
 
wxPoint plotOffset
 Plot offset (in IUs) More...
 
bool m_plotMirror
 X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG) More...
 
bool m_mirrorIsHorizontal
 
bool m_yaxisReversed
 true to mirror horizontally (else vertically) More...
 
FILE * outputFile
 true if the Y axis is top to bottom (SVG) More...
 
bool colorMode
 
bool negativeMode
 true to plot in color, false to plot in black and white More...
 
int defaultPenWidth
 true to generate a negative image (PS mode mainly) More...
 
int currentPenWidth
 
char penState
 Current pen state: 'U', 'D' or 'Z' (see PenTo) More...
 
wxPoint penLastpos
 Last pen positions; set to -1,-1 when the pen is at rest. More...
 
wxString creator
 
wxString filename
 
wxString title
 
PAGE_INFO pageInfo
 
wxSize paperSize
 Paper size in IU - not in mils. More...
 
wxArrayString m_headerExtraLines
 
COLOR_SETTINGSm_colors
 a set of string to print in header file More...
 

Detailed Description

Definition at line 1156 of file plotter.h.

Constructor & Destructor Documentation

◆ GERBER_PLOTTER()

GERBER_PLOTTER::GERBER_PLOTTER ( )

Definition at line 47 of file GERBER_plotter.cpp.

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 }
bool m_useNetAttributes
Definition: plotter.h:1400
bool m_gerberUnitInch
Definition: plotter.h:1394
#define NULL
int m_gerberUnitFmt
Definition: plotter.h:1395
FILE * finalFile
Definition: plotter.h:1383
bool m_useX2format
Definition: plotter.h:1397
int m_apertureAttribute
Definition: plotter.h:1380
FILE * workFile
Definition: plotter.h:1382
int m_currentApertureIdx
Definition: plotter.h:1392

References finalFile, m_apertureAttribute, m_currentApertureIdx, m_gerberUnitFmt, m_gerberUnitInch, m_useNetAttributes, m_useX2format, NULL, and workFile.

Member Function Documentation

◆ AddLineToHeader()

void PLOTTER::AddLineToHeader ( const wxString &  aExtraString)
inlineinherited

Function AddLineToHeader Add a line to the list of free lines to print at the beginning of the file.

Parameters
aExtraStringis the string to print

Definition at line 195 of file plotter.h.

196  {
197  m_headerExtraLines.Add( aExtraString );
198  }
wxArrayString m_headerExtraLines
Definition: plotter.h:615

References PLOTTER::m_headerExtraLines.

Referenced by AddGerberX2Attribute(), AddGerberX2Header(), GERBER_WRITER::createDrillFile(), and PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ Arc()

void GERBER_PLOTTER::Arc ( const wxPoint centre,
double  StAngle,
double  EndAngle,
int  rayon,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Generic fallback: arc rendered as a polyline.

Reimplemented from PLOTTER.

Definition at line 518 of file GERBER_plotter.cpp.

520 {
521  SetCurrentLineWidth( aWidth );
522 
523  wxPoint start, end;
524  start.x = aCenter.x + KiROUND( cosdecideg( aRadius, aStAngle ) );
525  start.y = aCenter.y - KiROUND( sindecideg( aRadius, aStAngle ) );
526  MoveTo( start );
527  end.x = aCenter.x + KiROUND( cosdecideg( aRadius, aEndAngle ) );
528  end.y = aCenter.y - KiROUND( sindecideg( aRadius, aEndAngle ) );
529  DPOINT devEnd = userToDeviceCoordinates( end );
530  DPOINT devCenter = userToDeviceCoordinates( aCenter ) - userToDeviceCoordinates( start );
531 
532  fprintf( outputFile, "G75*\n" ); // Multiquadrant (360 degrees) mode
533 
534  if( aStAngle < aEndAngle )
535  fprintf( outputFile, "G03*\n" ); // Active circular interpolation, CCW
536  else
537  fprintf( outputFile, "G02*\n" ); // Active circular interpolation, CW
538 
539  fprintf( outputFile, "X%dY%dI%dJ%dD01*\n",
540  KiROUND( devEnd.x ), KiROUND( devEnd.y ),
541  KiROUND( devCenter.x ), KiROUND( devCenter.y ) );
542 
543  fprintf( outputFile, "G01*\n" ); // Back to linear interpol (perhaps useless here).
544 }
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:99
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
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
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:61

References cosdecideg(), KiROUND(), PLOTTER::MoveTo(), PLOTTER::outputFile, SetCurrentLineWidth(), sindecideg(), PLOTTER::userToDeviceCoordinates(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

Referenced by Circle(), and ThickArc().

◆ BezierCurve()

void PLOTTER::BezierCurve ( const wxPoint aStart,
const wxPoint aControl1,
const wxPoint aControl2,
const wxPoint aEnd,
int  aTolerance,
int  aLineThickness = USE_DEFAULT_LINE_WIDTH 
)
virtualinherited

Generic fallback: Cubic Bezier curve rendered as a polyline In Kicad the bezier curves have 4 control points: start ctrl1 ctrl2 end.

Reimplemented in SVG_PLOTTER.

Definition at line 203 of file plotter.cpp.

206 {
207  // Generic fallback: Quadratic Bezier curve plotted as a polyline
208  int minSegLen = aLineThickness; // The segment min length to approximate a bezier curve
209 
210  std::vector<wxPoint> ctrlPoints;
211  ctrlPoints.push_back( aStart );
212  ctrlPoints.push_back( aControl1 );
213  ctrlPoints.push_back( aControl2 );
214  ctrlPoints.push_back( aEnd );
215 
216  BEZIER_POLY bezier_converter( ctrlPoints );
217 
218  std::vector<wxPoint> approxPoints;
219  bezier_converter.GetPoly( approxPoints, minSegLen );
220 
221  SetCurrentLineWidth( aLineThickness );
222  MoveTo( aStart );
223 
224  for( unsigned ii = 1; ii < approxPoints.size()-1; ii++ )
225  LineTo( approxPoints[ii] );
226 
227  FinishTo( aEnd );
228 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
void LineTo(const wxPoint &pos)
Definition: plotter.h:278
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273
Bezier curves to polygon converter.
Definition: bezier_curves.h:35
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References PLOTTER::FinishTo(), BEZIER_POLY::GetPoly(), PLOTTER::LineTo(), PLOTTER::MoveTo(), and PLOTTER::SetCurrentLineWidth().

Referenced by SVG_PLOTTER::BezierCurve(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), and BRDITEMS_PLOTTER::PlotDrawSegment().

◆ Circle()

void GERBER_PLOTTER::Circle ( const wxPoint pos,
int  diametre,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Implements PLOTTER.

Definition at line 512 of file GERBER_plotter.cpp.

513 {
514  Arc( aCenter, 0, 3600, aDiameter / 2, aFill, aWidth );
515 }
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.

References Arc().

Referenced by FlashPadCircle(), and ThickCircle().

◆ ClearAllAttributes()

void GERBER_PLOTTER::ClearAllAttributes ( )

Remove (clear) all attributes from object attributes dictionary (TO.

and TA commands) similar to clearNetAttribute(), this is an unconditional reset of TO. and TA. attributes

Definition at line 108 of file GERBER_plotter.cpp.

109 {
110  // Remove all attributes from object attributes dictionary (TO. and TA commands)
111  if( m_useX2format )
112  fputs( "%TD*%\n", outputFile );
113  else
114  fputs( "G04 #@! TD*\n", outputFile );
115 
117 }
bool m_useX2format
Definition: plotter.h:1397
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
std::string m_objectAttributesDictionnary
Definition: plotter.h:1377

References m_objectAttributesDictionnary, m_useX2format, and PLOTTER::outputFile.

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ ClearHeaderLinesList()

void PLOTTER::ClearHeaderLinesList ( )
inlineinherited

Function ClearHeaderLinesList remove all lines from the list of free lines to print at the beginning of the file.

Definition at line 204 of file plotter.h.

205  {
206  m_headerExtraLines.Clear();
207  }
wxArrayString m_headerExtraLines
Definition: plotter.h:615

References PLOTTER::m_headerExtraLines.

Referenced by StartPlotBoard().

◆ clearNetAttribute()

void GERBER_PLOTTER::clearNetAttribute ( )
protected

clear a Gerber net attribute record (clear object attribute dictionary) and output the clear object attribute dictionary command to gerber file has effect only if a net attribute is stored in m_objectAttributesDictionnary

Definition at line 120 of file GERBER_plotter.cpp.

121 {
122  // disable a Gerber net attribute (exists only in X2 with net attributes mode).
123  if( m_objectAttributesDictionnary.empty() ) // No net attribute or not X2 mode
124  return;
125 
126  // Remove all net attributes from object attributes dictionary
127  if( m_useX2format )
128  fputs( "%TD*%\n", outputFile );
129  else
130  fputs( "G04 #@! TD*\n", outputFile );
131 
133 }
bool m_useX2format
Definition: plotter.h:1397
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
std::string m_objectAttributesDictionnary
Definition: plotter.h:1377

References m_objectAttributesDictionnary, m_useX2format, and PLOTTER::outputFile.

Referenced by EndBlock(), and formatNetAttribute().

◆ ColorSettings()

◆ emitDcode()

void GERBER_PLOTTER::emitDcode ( const DPOINT pt,
int  dcode 
)
protected

Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate (for n decimal positions, see header generation in start_plot.

Definition at line 102 of file GERBER_plotter.cpp.

103 {
104 
105  fprintf( outputFile, "X%dY%dD%02d*\n", KiROUND( pt.x ), KiROUND( pt.y ), dcode );
106 }
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
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:61

References KiROUND(), PLOTTER::outputFile, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by FlashPadCircle(), FlashPadOval(), FlashPadRect(), FlashRegularPolygon(), and PenTo().

◆ EndBlock()

void GERBER_PLOTTER::EndBlock ( void *  aData)
overridevirtual

calling this function allows one to define the end of a group of drawing items the group is started by StartBlock() (used in X2 format with netlist attributes)

Parameters
aDatacan define any parameter

Reimplemented from PLOTTER.

Definition at line 143 of file GERBER_plotter.cpp.

144 {
145  // Remove all net attributes from object attributes dictionary
147 }
void clearNetAttribute()
clear a Gerber net attribute record (clear object attribute dictionary) and output the clear object a...

References clearNetAttribute().

Referenced by GERBER_WRITER::createDrillFile(), and StartBlock().

◆ EndPlot()

bool GERBER_PLOTTER::EndPlot ( )
overridevirtual

Implements PLOTTER.

Definition at line 247 of file GERBER_plotter.cpp.

248 {
249  char line[1024];
250  wxString msg;
251 
252  wxASSERT( outputFile );
253 
254  /* Outfile is actually a temporary file i.e. workFile */
255  fputs( "M02*\n", outputFile );
256  fflush( outputFile );
257 
258  fclose( workFile );
259  workFile = wxFopen( m_workFilename, wxT( "rt" ));
260  wxASSERT( workFile );
262 
263  // Placement of apertures in RS274X
264  while( fgets( line, 1024, workFile ) )
265  {
266  fputs( line, outputFile );
267 
268  char* substr = strtok( line, "\n\r" );
269 
270  if( substr && strcmp( substr, "G04 APERTURE LIST*" ) == 0 )
271  {
273  fputs( "G04 APERTURE END LIST*\n", outputFile );
274  }
275  }
276 
277  fclose( workFile );
278  fclose( finalFile );
279  ::wxRemoveFile( m_workFilename );
280  outputFile = 0;
281 
282  return true;
283 }
void writeApertureList()
Generate the table of D codes.
FILE * finalFile
Definition: plotter.h:1383
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
wxString m_workFilename
Definition: plotter.h:1384
FILE * workFile
Definition: plotter.h:1382

References finalFile, m_workFilename, PLOTTER::outputFile, workFile, and writeApertureList().

Referenced by GERBER_WRITER::createDrillFile(), and PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ FinishTo()

◆ FlashPadCircle()

void GERBER_PLOTTER::FlashPadCircle ( const wxPoint pos,
int  diametre,
EDA_DRAW_MODE_T  trace_mode,
void *  aData 
)
overridevirtual

Filled circular flashes are stored as apertures.

Implements PLOTTER.

Definition at line 729 of file GERBER_plotter.cpp.

730 {
731  wxSize size( diametre, diametre );
732  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
733 
734  if( trace_mode == SKETCH )
735  {
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 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
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.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:109
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:165
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 DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:99
int currentPenWidth
Definition: plotter.h:603
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:108

References APERTURE::AT_CIRCLE, Circle(), PLOTTER::currentPenWidth, PLOTTER::DO_NOT_SET_LINE_WIDTH, emitDcode(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), GBR_METADATA::m_NetlistMetadata, NO_FILL, selectAperture(), SetCurrentLineWidth(), SKETCH, PLOTTER::USE_DEFAULT_LINE_WIDTH, and PLOTTER::userToDeviceCoordinates().

Referenced by GERBER_WRITER::createDrillFile(), and PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ FlashPadCustom()

void GERBER_PLOTTER::FlashPadCustom ( const wxPoint aPadPos,
const wxSize &  aSize,
SHAPE_POLY_SET aPolygons,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtual

virtual function FlashPadCustom

Parameters
aPadPosPosition of the shape (center of the rectangle
aSize= size of round reference pad
aPolygonsthe shape as polygon set
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format attributes)

Implements PLOTTER.

Definition at line 919 of file GERBER_plotter.cpp.

923 {
924  // A Pad custom is plotted as polygon (a region in Gerber language).
925 
926  GBR_METADATA gbr_metadata;
927 
928  if( aData )
929  gbr_metadata = *static_cast<GBR_METADATA*>( aData );
930 
931  SHAPE_POLY_SET polyshape = *aPolygons;
932 
933  if( aTraceMode != FILLED )
934  {
936  polyshape.Inflate( -GetCurrentLineWidth()/2, 16 );
937  }
938 
939  std::vector< wxPoint > cornerList;
940 
941  for( int cnt = 0; cnt < polyshape.OutlineCount(); ++cnt )
942  {
943  SHAPE_LINE_CHAIN& poly = polyshape.Outline( cnt );
944 
945  cornerList.clear();
946 
947  for( int ii = 0; ii < poly.PointCount(); ++ii )
948  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
949 
950  // Close polygon
951  cornerList.push_back( cornerList[0] );
952 
953  if( aTraceMode == SKETCH )
954  PlotPoly( cornerList, NO_FILL, GetCurrentLineWidth(), &gbr_metadata );
955  else
956  PlotGerberRegion( cornerList, &gbr_metadata );
957  }
958 }
int OutlineCount() const
Returns the number of outlines in the set
void Inflate(int aAmount, int aCircleSegmentsCount, CORNER_STRATEGY aCornerStrategy=ROUND_ALL_CORNERS)
Performs outline inflation/deflation.
int PointCount() const
Function PointCount()
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:109
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.
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
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....
SHAPE_LINE_CHAIN.

References SHAPE_LINE_CHAIN::CPoint(), FILLED, PLOTTER::GetCurrentLineWidth(), SHAPE_POLY_SET::Inflate(), NO_FILL, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PlotGerberRegion(), PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), SetCurrentLineWidth(), SKETCH, PLOTTER::USE_DEFAULT_LINE_WIDTH, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadOval()

void GERBER_PLOTTER::FlashPadOval ( const wxPoint pos,
const wxSize &  size,
double  orient,
EDA_DRAW_MODE_T  trace_mode,
void *  aData 
)
overridevirtual

Filled oval flashes are handled as aperture in the 90 degree positions only.

Implements PLOTTER.

Definition at line 758 of file GERBER_plotter.cpp.

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( size.x > size.y )
785  {
786  std::swap( size.x, size.y );
787 
788  if( orient < 2700 )
789  orient += 900;
790  else
791  orient -= 2700;
792  }
793 
794  if( trace_mode == FILLED )
795  {
796  // TODO: use an aperture macro to declare the rotated pad
797  // to be able to flash the shape
798  // For now, the pad is drawn as thick segment (painted with only one segment)
799 
800  // The pad is reduced to an segment with dy > dx
801  int delta = size.y - size.x;
802  wxPoint p0( 0, -delta / 2 );
803  wxPoint p1( 0, delta / 2 );
804  RotatePoint( &p0.x, &p0.y, orient );
805  RotatePoint( &p1.x, &p1.y, orient );
806 
807  ThickSegment( pos + p0, pos + p1, size.x, trace_mode, gbr_metadata );
808  }
809  else
810  sketchOval( pos, size, orient, -1 );
811  }
812 }
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
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:208
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:165
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 DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:99
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212
void sketchOval(const wxPoint &pos, const wxSize &size, double orient, int width)
Definition: plotter.cpp:458

References APERTURE::AT_OVAL, emitDcode(), FILLED, formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), GBR_METADATA::m_NetlistMetadata, PLOTTER::outputFile, RotatePoint(), selectAperture(), PLOTTER::sketchOval(), ThickSegment(), PLOTTER::userToDeviceCoordinates(), wxPoint::x, and wxPoint::y.

Referenced by GERBER_WRITER::createDrillFile().

◆ FlashPadRect()

void GERBER_PLOTTER::FlashPadRect ( const wxPoint pos,
const wxSize &  size,
double  orient,
EDA_DRAW_MODE_T  trace_mode,
void *  aData 
)
overridevirtual

Filled rect flashes are handled as aperture in the 0 90 180 or 270 degree orientation only and as polygon for other orientations TODO: always use flashed shapes (aperture macros)

Implements PLOTTER.

Definition at line 815 of file GERBER_plotter.cpp.

818 {
819  wxASSERT( outputFile );
820  wxSize size( aSize );
821  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
822 
823  // Plot as an aperture flash
824  switch( int( orient ) )
825  {
826  case 900:
827  case 2700: // rotation of 90 degrees or 270 swaps sizes
828  std::swap( size.x, size.y );
829  // Intentionally fall through
830  case 0:
831  case 1800:
832  if( trace_mode == SKETCH )
833  {
835 
836  if( gbr_metadata )
837  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
838 
839  Rect( wxPoint( pos.x - (size.x - currentPenWidth) / 2,
840  pos.y - (size.y - currentPenWidth) / 2 ),
841  wxPoint( pos.x + (size.x - currentPenWidth) / 2,
842  pos.y + (size.y - currentPenWidth) / 2 ),
844  }
845  else
846  {
847  DPOINT pos_dev = userToDeviceCoordinates( pos );
848  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
849  selectAperture( size, APERTURE::AT_RECT, aperture_attrib );
850 
851  if( gbr_metadata )
852  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
853 
854  emitDcode( pos_dev, 3 );
855  }
856  break;
857 
858  default: // plot pad shape as polygon
859  {
860  // XXX to do: use an aperture macro to declare the rotated pad
861  wxPoint coord[4];
862  // coord[0] is assumed the lower left
863  // coord[1] is assumed the upper left
864  // coord[2] is assumed the upper right
865  // coord[3] is assumed the lower right
866 
867  /* Trace the outline. */
868  coord[0].x = -size.x/2; // lower left
869  coord[0].y = size.y/2;
870  coord[1].x = -size.x/2; // upper left
871  coord[1].y = -size.y/2;
872  coord[2].x = size.x/2; // upper right
873  coord[2].y = -size.y/2;
874  coord[3].x = size.x/2; // lower right
875  coord[3].y = size.y/2;
876 
877  FlashPadTrapez( pos, coord, orient, trace_mode, aData );
878  }
879  break;
880  }
881 }
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:...
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
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.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
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:109
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:165
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 DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:99
int currentPenWidth
Definition: plotter.h:603
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212

References APERTURE::AT_RECT, PLOTTER::currentPenWidth, emitDcode(), FlashPadTrapez(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), GBR_METADATA::m_NetlistMetadata, NO_FILL, PLOTTER::outputFile, Rect(), selectAperture(), SetCurrentLineWidth(), SKETCH, PLOTTER::USE_DEFAULT_LINE_WIDTH, PLOTTER::userToDeviceCoordinates(), wxPoint::x, and wxPoint::y.

◆ FlashPadRoundRect()

void GERBER_PLOTTER::FlashPadRoundRect ( const wxPoint aPadPos,
const wxSize &  aSize,
int  aCornerRadius,
double  aOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtual

Roundrect pad at the moment are not handled as aperture, since they require aperture macros TODO: always use flashed shapes (aperture macros)

Implements PLOTTER.

Definition at line 883 of file GERBER_plotter.cpp.

887 {
888  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
889 
890  // Currently, a Pad RoundRect is plotted as polygon.
891  // TODO: use Aperture macro and flash it
892  SHAPE_POLY_SET outline;
893  TransformRoundChamferedRectToPolygon( outline, aPadPos, aSize, aOrient,
894  aCornerRadius, 0.0, 0, GetPlotterArcHighDef() );
895 
896  if( aTraceMode != FILLED )
897  {
899  outline.Inflate( -GetCurrentLineWidth()/2, 16 );
900  }
901 
902  std::vector< wxPoint > cornerList;
903  // TransformRoundRectToPolygon creates only one convex polygon
904  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
905  cornerList.reserve( poly.PointCount() + 1 );
906 
907  for( int ii = 0; ii < poly.PointCount(); ++ii )
908  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
909 
910  // Close polygon
911  cornerList.push_back( cornerList[0] );
912 
913  if( aTraceMode == SKETCH )
914  PlotPoly( cornerList, NO_FILL, GetCurrentLineWidth(), gbr_metadata );
915  else
916  PlotGerberRegion( cornerList, gbr_metadata );
917 }
void Inflate(int aAmount, int aCircleSegmentsCount, CORNER_STRATEGY aCornerStrategy=ROUND_ALL_CORNERS)
Performs outline inflation/deflation.
int PointCount() const
Function PointCount()
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:109
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.
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aApproxErrorMax, int aMinSegPerCircleCount=16)
convert a rectangle with rounded corners and/or chamfered corners to a polygon Convert rounded corner...
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....
SHAPE_LINE_CHAIN.
int GetPlotterArcHighDef() const
Definition: plotter.h:239

References SHAPE_LINE_CHAIN::CPoint(), FILLED, PLOTTER::GetCurrentLineWidth(), PLOTTER::GetPlotterArcHighDef(), SHAPE_POLY_SET::Inflate(), NO_FILL, SHAPE_POLY_SET::Outline(), PlotGerberRegion(), PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), SetCurrentLineWidth(), SKETCH, TransformRoundChamferedRectToPolygon(), PLOTTER::USE_DEFAULT_LINE_WIDTH, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadTrapez()

void GERBER_PLOTTER::FlashPadTrapez ( const wxPoint aPadPos,
const wxPoint aCorners,
double  aPadOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtual

Trapezoidal pad at the moment are never handled as aperture, since they require aperture macros TODO: always use flashed shapes (aperture macros)

Implements PLOTTER.

Definition at line 961 of file GERBER_plotter.cpp.

964 {
965  // TODO: use Aperture macro and flash it
966 
967  // polygon corners list
968  std::vector<wxPoint> cornerList = { aCorners[0], aCorners[1], aCorners[2], aCorners[3] };
969 
970  // Draw the polygon and fill the interior as required
971  for( unsigned ii = 0; ii < 4; ii++ )
972  {
973  RotatePoint( &cornerList[ii], aPadOrient );
974  cornerList[ii] += aPadPos;
975  }
976 
977  // Close the polygon
978  cornerList.push_back( cornerList[0] );
979  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
980 
981  GBR_METADATA metadata;
982 
983  if( gbr_metadata )
984  metadata = *gbr_metadata;
985 
986  if( aTrace_Mode == SKETCH )
988  &metadata );
989  else
990  PlotGerberRegion( cornerList, &metadata );
991 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:109
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.
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....

References NO_FILL, PlotGerberRegion(), PlotPoly(), RotatePoint(), SKETCH, and PLOTTER::USE_DEFAULT_LINE_WIDTH.

Referenced by FlashPadRect().

◆ FlashRegularPolygon()

void GERBER_PLOTTER::FlashRegularPolygon ( const wxPoint aShapePos,
int  aDiameter,
int  aCornerCount,
double  aOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtual

Flash a regular polygon.

Usefull only in Gerber files to flash a regular polygon

Parameters
aShapePosis the center of the circle containing the polygon
aRadiusis the radius of the circle containing the polygon
aCornerCountis the number of vertices
aOrientis the polygon rotation in degrees
aDatais a auxiliary parameter used (if needed) to handle extra info specific to the plotter

Implements PLOTTER.

Definition at line 994 of file GERBER_plotter.cpp.

998 {
999  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1000 
1001  if( aTraceMode == SKETCH )
1002  {
1003  // Build the polygon:
1004  std::vector< wxPoint > cornerList;
1005 
1006  double angle_delta = 3600.0 / aCornerCount; // in 0.1 degree
1007 
1008  for( int ii = 0; ii < aCornerCount; ii++ )
1009  {
1010  double rot = aOrient + (angle_delta*ii);
1011  wxPoint vertice( aDiameter/2, 0 );
1012  RotatePoint( &vertice, rot );
1013  vertice += aShapePos;
1014  cornerList.push_back( vertice );
1015  }
1016 
1017  cornerList.push_back( cornerList[0] ); // Close the shape
1018 
1019  SetCurrentLineWidth( aDiameter/8, gbr_metadata );
1020  PlotPoly( cornerList, NO_FILL, GetCurrentLineWidth(), gbr_metadata );
1021  }
1022  else
1023  {
1024  DPOINT pos_dev = userToDeviceCoordinates( aShapePos );
1025 
1026  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1027 
1028  APERTURE::APERTURE_TYPE apert_type =
1030  selectAperture( aDiameter, aOrient, apert_type, aperture_attrib );
1031 
1032  if( gbr_metadata )
1033  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1034 
1035  emitDcode( pos_dev, 3 );
1036  }
1037 }
APERTURE_TYPE
Definition: plotter.h:1073
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
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:208
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
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.
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:165
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 DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:99
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212

References APERTURE::AT_REGULAR_POLY3, emitDcode(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), GBR_METADATA::m_NetlistMetadata, NO_FILL, PlotPoly(), RotatePoint(), selectAperture(), SetCurrentLineWidth(), SKETCH, and PLOTTER::userToDeviceCoordinates().

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ formatNetAttribute()

void GERBER_PLOTTER::formatNetAttribute ( GBR_NETLIST_METADATA aData)
protected

print a Gerber net attribute object record.

In a gerber file, a net attribute is owned by a graphic object formatNetAttribute must be called before creating the object

Parameters
aDatacontains the dato to format. the generated string depends on the type of netlist info

Definition at line 150 of file GERBER_plotter.cpp.

151 {
152  // print a Gerber net attribute record.
153  // it is added to the object attributes dictionary
154  // On file, only modified or new attributes are printed.
155  if( aData == NULL )
156  return;
157 
158  if( !m_useNetAttributes )
159  return;
160 
161  bool useX1StructuredComment = !m_useX2format;
162 
163  bool clearDict;
164  std::string short_attribute_string;
165 
166  if( !FormatNetAttribute( short_attribute_string, m_objectAttributesDictionnary,
167  aData, clearDict, useX1StructuredComment ) )
168  return;
169 
170  if( clearDict )
172 
173  if( !short_attribute_string.empty() )
174  fputs( short_attribute_string.c_str(), outputFile );
175 
176  if( m_useX2format && !aData->m_ExtraData.IsEmpty() )
177  {
178  std::string extra_data = TO_UTF8( aData->m_ExtraData );
179  fputs( extra_data.c_str(), outputFile );
180  }
181 }
void clearNetAttribute()
clear a Gerber net attribute record (clear object attribute dictionary) and output the clear object a...
bool m_useNetAttributes
Definition: plotter.h:1400
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.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
wxString m_ExtraData
a string to print after TO object attributes, if not empty it is printed "as this"
#define NULL
bool m_useX2format
Definition: plotter.h:1397
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
std::string m_objectAttributesDictionnary
Definition: plotter.h:1377

References clearNetAttribute(), FormatNetAttribute(), GBR_NETLIST_METADATA::m_ExtraData, m_objectAttributesDictionnary, m_useNetAttributes, m_useX2format, NULL, PLOTTER::outputFile, and TO_UTF8.

Referenced by FlashPadCircle(), FlashPadOval(), FlashPadRect(), FlashRegularPolygon(), PlotPoly(), Text(), ThickArc(), ThickCircle(), ThickRect(), and ThickSegment().

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( ) const
protectedinherited

Definition at line 151 of file plotter.cpp.

152 {
154 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:124
#define DASH_GAP_LEN(aLineWidth)

References DASH_GAP_LEN, PLOTTER::GetCurrentLineWidth(), and PLOTTER::userToDeviceSize().

Referenced by PS_PLOTTER::SetDash(), PDF_PLOTTER::SetDash(), and SVG_PLOTTER::setSVGPlotStyle().

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( ) const
protectedinherited

Definition at line 145 of file plotter.cpp.

146 {
148 }
#define DASH_MARK_LEN(aLineWidth)
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:124

References DASH_MARK_LEN, PLOTTER::GetCurrentLineWidth(), and PLOTTER::userToDeviceSize().

Referenced by PS_PLOTTER::SetDash(), PDF_PLOTTER::SetDash(), and SVG_PLOTTER::setSVGPlotStyle().

◆ GetDefaultFileExtension()

static wxString GERBER_PLOTTER::GetDefaultFileExtension ( )
inlinestatic

Definition at line 1166 of file plotter.h.

1167  {
1168  return wxString( wxT( "gbr" ) );
1169  }

Referenced by GetDefaultPlotExtension().

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( ) const
protectedinherited

Definition at line 139 of file plotter.cpp.

140 {
142 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
#define DOT_MARK_LEN(aLineWidth)
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:124

References DOT_MARK_LEN, PLOTTER::GetCurrentLineWidth(), and PLOTTER::userToDeviceSize().

Referenced by PS_PLOTTER::SetDash(), PDF_PLOTTER::SetDash(), and SVG_PLOTTER::setSVGPlotStyle().

◆ GetIUsPerDecimil()

double PLOTTER::GetIUsPerDecimil ( ) const
inlineinherited

The IUs per decimil are an essential scaling factor when plotting; they are set and saved when establishing the viewport.

Here they can be get back again

Definition at line 236 of file plotter.h.

236 { return m_IUsPerDecimil; }
double m_IUsPerDecimil
Definition: plotter.h:582

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotWorkSheet().

◆ GetOrCreateAperture()

int GERBER_PLOTTER::GetOrCreateAperture ( const wxSize &  aSize,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
Returns
a index to the aperture in aperture list which meets the size and type of tool if the aperture does not exist, it is created and entered in aperture list
Parameters
aSize= the size of tool
aType= the type ( shape ) of tool
aApertureAttribute= an aperture attribute of the tool (a tool can have onlu one attribute) 0 = no specific attribute

Definition at line 313 of file GERBER_plotter.cpp.

315 {
316  int last_D_code = 9;
317 
318  // Search an existing aperture
319  for( int idx = 0; idx < (int)m_apertures.size(); ++idx )
320  {
321  APERTURE* tool = &m_apertures[idx];
322  last_D_code = tool->m_DCode;
323 
324  if( (tool->m_Type == aType) && (tool->m_Size == aSize) &&
325  (tool->m_ApertureAttribute == aApertureAttribute) )
326  return idx;
327  }
328 
329  // Allocate a new aperture
330  APERTURE new_tool;
331  new_tool.m_Size = aSize;
332  new_tool.m_Type = aType;
333  new_tool.m_DCode = last_D_code + 1;
334  new_tool.m_ApertureAttribute = aApertureAttribute;
335 
336  m_apertures.push_back( new_tool );
337 
338  return m_apertures.size() - 1;
339 }
APERTURE_TYPE m_Type
Definition: plotter.h:1139
wxSize m_Size
Definition: plotter.h:1144
std::vector< APERTURE > m_apertures
Definition: plotter.h:1391
int m_DCode
Definition: plotter.h:1147
int m_ApertureAttribute
Definition: plotter.h:1152

References APERTURE::m_ApertureAttribute, m_apertures, APERTURE::m_DCode, APERTURE::m_Size, and APERTURE::m_Type.

Referenced by selectAperture().

◆ GetPlotterArcHighDef()

int PLOTTER::GetPlotterArcHighDef ( ) const
inlineinherited

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 238 of file plotter.h.

238 { return m_IUsPerDecimil * 8; }
double m_IUsPerDecimil
Definition: plotter.h:582

References PLOTTER::m_IUsPerDecimil.

◆ GetPlotterType()

virtual PLOT_FORMAT GERBER_PLOTTER::GetPlotterType ( ) const
inlineoverridevirtual

Returns the effective plot engine in use.

It's not very OO but for now is required since some things are only done with some output devices (like drill marks, emitted only for postscript

Implements PLOTTER.

Definition at line 1161 of file plotter.h.

1162  {
1163  return PLOT_FORMAT::GERBER;
1164  }

References GERBER.

◆ LineTo()

void PLOTTER::LineTo ( const wxPoint pos)
inlineinherited

Definition at line 278 of file plotter.h.

279  {
280  PenTo( pos, 'D' );
281  }
virtual void PenTo(const wxPoint &pos, char plume)=0
moveto/lineto primitive, moves the 'pen' to the specified direction

References PLOTTER::PenTo().

Referenced by PLOTTER::Arc(), PLOTTER::BezierCurve(), DXF_PLOTTER::FlashPadCustom(), DXF_PLOTTER::FlashPadRect(), DXF_PLOTTER::FlashPadRoundRect(), DXF_PLOTTER::FlashPadTrapez(), SCH_SHEET::Plot(), HPGL_PLOTTER::PlotPoly(), PlotPoly(), DXF_PLOTTER::PlotPoly(), LIB_PIN::PlotSymbol(), and DXF_PLOTTER::Rect().

◆ Marker()

void PLOTTER::Marker ( const wxPoint position,
int  diametre,
unsigned  aShapeId 
)
inherited

Draw a pattern shape number aShapeId, to coord position.

Diameter diameter = (coord table) hole AShapeId = index (used to generate forms characters)

Definition at line 331 of file plotter.cpp.

332 {
333  int radius = diametre / 2;
334  /* Marker are composed by a series of 'parts' superimposed; not every
335  combination make sense, obviously. Since they are used in order I
336  tried to keep the uglier/more complex constructions at the end.
337  Also I avoided the |/ |\ -/ -\ construction because they're *very*
338  ugly... if needed they could be added anyway... I'd like to see
339  a board with more than 58 drilling/slotting tools!
340  If Visual C++ supported the 0b literals they would be optimally
341  and easily encoded as an integer array. We have to do with octal */
342  static const unsigned char marker_patterns[MARKER_COUNT] = {
343  // Bit order: O Square Lozenge - | \ /
344  // First choice: simple shapes
345  0003, // X
346  0100, // O
347  0014, // +
348  0040, // Sq
349  0020, // Lz
350  // Two simple shapes
351  0103, // X O
352  0017, // X +
353  0043, // X Sq
354  0023, // X Lz
355  0114, // O +
356  0140, // O Sq
357  0120, // O Lz
358  0054, // + Sq
359  0034, // + Lz
360  0060, // Sq Lz
361  // Three simple shapes
362  0117, // X O +
363  0143, // X O Sq
364  0123, // X O Lz
365  0057, // X + Sq
366  0037, // X + Lz
367  0063, // X Sq Lz
368  0154, // O + Sq
369  0134, // O + Lz
370  0074, // + Sq Lz
371  // Four simple shapes
372  0174, // O Sq Lz +
373  0163, // X O Sq Lz
374  0157, // X O Sq +
375  0137, // X O Lz +
376  0077, // X Sq Lz +
377  // This draws *everything *
378  0177, // X O Sq Lz +
379  // Here we use the single bars... so the cross is forbidden
380  0110, // O -
381  0104, // O |
382  0101, // O /
383  0050, // Sq -
384  0044, // Sq |
385  0041, // Sq /
386  0030, // Lz -
387  0024, // Lz |
388  0021, // Lz /
389  0150, // O Sq -
390  0144, // O Sq |
391  0141, // O Sq /
392  0130, // O Lz -
393  0124, // O Lz |
394  0121, // O Lz /
395  0070, // Sq Lz -
396  0064, // Sq Lz |
397  0061, // Sq Lz /
398  0170, // O Sq Lz -
399  0164, // O Sq Lz |
400  0161, // O Sq Lz /
401  // Last resort: the backlash component (easy to confound)
402  0102, // \ O
403  0042, // \ Sq
404  0022, // \ Lz
405  0142, // \ O Sq
406  0122, // \ O Lz
407  0062, // \ Sq Lz
408  0162 // \ O Sq Lz
409  };
410  if( aShapeId >= MARKER_COUNT )
411  {
412  // Fallback shape
413  markerCircle( position, radius );
414  }
415  else
416  {
417  // Decode the pattern and draw the corresponding parts
418  unsigned char pat = marker_patterns[aShapeId];
419  if( pat & 0001 )
420  markerSlash( position, radius );
421  if( pat & 0002 )
422  markerBackSlash( position, radius );
423  if( pat & 0004 )
424  markerVBar( position, radius );
425  if( pat & 0010 )
426  markerHBar( position, radius );
427  if( pat & 0020 )
428  markerLozenge( position, radius );
429  if( pat & 0040 )
430  markerSquare( position, radius );
431  if( pat & 0100 )
432  markerCircle( position, radius );
433  }
434 }
void markerHBar(const wxPoint &pos, int radius)
Plot a - bar centered on the position.
Definition: plotter.cpp:303
static const unsigned MARKER_COUNT
Draw a marker (used for the drill map)
Definition: plotter.h:444
void markerSlash(const wxPoint &pos, int radius)
Plot a / bar centered on the position.
Definition: plotter.cpp:310
void markerLozenge(const wxPoint &position, int radius)
Plot a lozenge centered on the position.
Definition: plotter.cpp:279
void markerCircle(const wxPoint &pos, int radius)
Plot a circle centered on the position.
Definition: plotter.cpp:273
void markerVBar(const wxPoint &pos, int radius)
Plot a | bar centered on the position.
Definition: plotter.cpp:324
void markerSquare(const wxPoint &position, int radius)
Plot a square centered on the position.
Definition: plotter.cpp:248
void markerBackSlash(const wxPoint &pos, int radius)
Plot a \ bar centered on the position.
Definition: plotter.cpp:317

References PLOTTER::MARKER_COUNT, PLOTTER::markerBackSlash(), PLOTTER::markerCircle(), PLOTTER::markerHBar(), PLOTTER::markerLozenge(), PLOTTER::markerSlash(), PLOTTER::markerSquare(), and PLOTTER::markerVBar().

Referenced by GENDRILL_WRITER_BASE::genDrillMapFile(), and GENDRILL_WRITER_BASE::plotDrillMarks().

◆ markerBackSlash()

void PLOTTER::markerBackSlash ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a \ bar centered on the position.

Building block for markers

Definition at line 317 of file plotter.cpp.

318 {
319  MoveTo( wxPoint( pos.x + radius, pos.y - radius ) );
320  FinishTo( wxPoint( pos.x - radius, pos.y + radius ) );
321 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273

References PLOTTER::FinishTo(), PLOTTER::MoveTo(), wxPoint::x, and wxPoint::y.

Referenced by PLOTTER::Marker().

◆ markerCircle()

void PLOTTER::markerCircle ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a circle centered on the position.

Building block for markers

Definition at line 273 of file plotter.cpp.

274 {
275  Circle( position, radius * 2, NO_FILL, GetCurrentLineWidth() );
276 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0

References PLOTTER::Circle(), PLOTTER::GetCurrentLineWidth(), and NO_FILL.

Referenced by PLOTTER::Marker().

◆ markerHBar()

void PLOTTER::markerHBar ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a - bar centered on the position.

Building block for markers

Definition at line 303 of file plotter.cpp.

304 {
305  MoveTo( wxPoint( pos.x - radius, pos.y ) );
306  FinishTo( wxPoint( pos.x + radius, pos.y ) );
307 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273

References PLOTTER::FinishTo(), PLOTTER::MoveTo(), wxPoint::x, and wxPoint::y.

Referenced by PLOTTER::Marker().

◆ markerLozenge()

void PLOTTER::markerLozenge ( const wxPoint position,
int  radius 
)
protectedinherited

Plot a lozenge centered on the position.

Building block for markers

Definition at line 279 of file plotter.cpp.

280 {
281  std::vector< wxPoint > corner_list;
282  wxPoint corner;
283  corner.x = position.x;
284  corner.y = position.y + radius;
285  corner_list.push_back( corner );
286  corner.x = position.x + radius;
287  corner.y = position.y,
288  corner_list.push_back( corner );
289  corner.x = position.x;
290  corner.y = position.y - radius;
291  corner_list.push_back( corner );
292  corner.x = position.x - radius;
293  corner.y = position.y;
294  corner_list.push_back( corner );
295  corner.x = position.x;
296  corner.y = position.y + radius;
297  corner_list.push_back( corner );
298 
299  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
300 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171

References PLOTTER::GetCurrentLineWidth(), NO_FILL, PLOTTER::PlotPoly(), wxPoint::x, and wxPoint::y.

Referenced by PLOTTER::Marker().

◆ markerSlash()

void PLOTTER::markerSlash ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a / bar centered on the position.

Building block for markers

Definition at line 310 of file plotter.cpp.

311 {
312  MoveTo( wxPoint( pos.x - radius, pos.y - radius ) );
313  FinishTo( wxPoint( pos.x + radius, pos.y + radius ) );
314 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273

References PLOTTER::FinishTo(), PLOTTER::MoveTo(), wxPoint::x, and wxPoint::y.

Referenced by PLOTTER::Marker().

◆ markerSquare()

void PLOTTER::markerSquare ( const wxPoint position,
int  radius 
)
protectedinherited

Plot a square centered on the position.

Building block for markers

Definition at line 248 of file plotter.cpp.

249 {
250  double r = KiROUND( radius / 1.4142 );
251  std::vector< wxPoint > corner_list;
252  wxPoint corner;
253  corner.x = position.x + r;
254  corner.y = position.y + r;
255  corner_list.push_back( corner );
256  corner.x = position.x + r;
257  corner.y = position.y - r;
258  corner_list.push_back( corner );
259  corner.x = position.x - r;
260  corner.y = position.y - r;
261  corner_list.push_back( corner );
262  corner.x = position.x - r;
263  corner.y = position.y + r;
264  corner_list.push_back( corner );
265  corner.x = position.x + r;
266  corner.y = position.y + r;
267  corner_list.push_back( corner );
268 
269  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
270 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:171
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:61

References PLOTTER::GetCurrentLineWidth(), KiROUND(), NO_FILL, PLOTTER::PlotPoly(), wxPoint::x, and wxPoint::y.

Referenced by PLOTTER::Marker().

◆ markerVBar()

void PLOTTER::markerVBar ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a | bar centered on the position.

Building block for markers

Definition at line 324 of file plotter.cpp.

325 {
326  MoveTo( wxPoint( pos.x, pos.y - radius ) );
327  FinishTo( wxPoint( pos.x, pos.y + radius ) );
328 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273

References PLOTTER::FinishTo(), PLOTTER::MoveTo(), wxPoint::x, and wxPoint::y.

Referenced by PLOTTER::Marker().

◆ MoveTo()

◆ OpenFile()

bool PLOTTER::OpenFile ( const wxString &  aFullFilename)
virtualinherited

Open or create the plot file aFullFilename.

Parameters
aFullFilename= the full file name of the file to create
Returns
true if success, false if the file cannot be created/opened

Virtual because some plotters use ascii files, some others binary files (PDF) The base class open the file in text mode

Reimplemented in PDF_PLOTTER.

Definition at line 82 of file plotter.cpp.

83 {
84  filename = aFullFilename;
85 
86  wxASSERT( !outputFile );
87 
88  // Open the file in text mode (not suitable for all plotters
89  // but only for most of them
90  outputFile = wxFopen( filename, wxT( "wt" ) );
91 
92  if( outputFile == NULL )
93  return false ;
94 
95  return true;
96 }
#define NULL
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
wxString filename
Definition: plotter.h:609

References PLOTTER::filename, NULL, and PLOTTER::outputFile.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), GENDRILL_WRITER_BASE::genDrillMapFile(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), StartPlotBoard(), and LIB_EDIT_FRAME::SVG_PlotComponent().

◆ PageSettings()

PAGE_INFO& PLOTTER::PageSettings ( )
inlineinherited

Definition at line 152 of file plotter.h.

153  {
154  return pageInfo;
155  }
PAGE_INFO pageInfo
Definition: plotter.h:611

References PLOTTER::pageInfo.

Referenced by DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG().

◆ PenFinish()

void PLOTTER::PenFinish ( )
inlineinherited

Definition at line 289 of file plotter.h.

290  {
291  // The point is not important with Z motion
292  PenTo( wxPoint( 0, 0 ), 'Z' );
293  }
virtual void PenTo(const wxPoint &pos, char plume)=0
moveto/lineto primitive, moves the 'pen' to the specified direction

References PLOTTER::PenTo().

Referenced by HPGL_PLOTTER::Arc(), HPGL_PLOTTER::Circle(), HPGL_PLOTTER::FlashPadCircle(), HPGL_PLOTTER::PlotPoly(), PlotPoly(), DXF_PLOTTER::PlotPoly(), and HPGL_PLOTTER::Rect().

◆ PenTo()

void GERBER_PLOTTER::PenTo ( const wxPoint pos,
char  plume 
)
overridevirtual

moveto/lineto primitive, moves the 'pen' to the specified direction

Parameters
posis the target position
plumespecifies the kind of motion: 'U' only moves the pen, 'D' draw a line from the current position and 'Z' finish the drawing and returns the 'pen' to rest (flushes the trace)

Implements PLOTTER.

Definition at line 472 of file GERBER_plotter.cpp.

473 {
474  wxASSERT( outputFile );
475  DPOINT pos_dev = userToDeviceCoordinates( aPos );
476 
477  switch( plume )
478  {
479  case 'Z':
480  break;
481 
482  case 'U':
483  emitDcode( pos_dev, 2 );
484  break;
485 
486  case 'D':
487  emitDcode( pos_dev, 1 );
488  }
489 
490  penState = plume;
491 }
char penState
Current pen state: 'U', 'D' or 'Z' (see PenTo)
Definition: plotter.h:605
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 DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:99
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597

References emitDcode(), PLOTTER::outputFile, PLOTTER::penState, and PLOTTER::userToDeviceCoordinates().

◆ PlotGerberRegion()

void GERBER_PLOTTER::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.AperFunction if aData contains this attribute, and clear it after plotting.

Definition at line 547 of file GERBER_plotter.cpp.

549 {
550  if( aCornerList.size() <= 2 )
551  return;
552 
553  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
554 
555  bool clearTA_AperFunction = false; // true if a TA.AperFunction is used
556 
557  if( gbr_metadata )
558  {
559  std::string attrib = gbr_metadata->m_ApertureMetadata.FormatAttribute( !m_useX2format );
560 
561  if( !attrib.empty() )
562  {
563  fputs( attrib.c_str(), outputFile );
564  clearTA_AperFunction = true;
565  }
566  }
567 
568  PlotPoly( aCornerList, FILLED_SHAPE, 0 , gbr_metadata );
569 
570  // Clear the TA attribute, to avoid the next item to inherit it:
571  if( clearTA_AperFunction )
572  {
573  if( m_useX2format )
574  {
575  fputs( "%TD.AperFunction*%\n", outputFile );
576  }
577  else
578  {
579  fputs( "G04 #@! TD.AperFunction*\n", outputFile );
580  }
581  }
582 }
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.
bool m_useX2format
Definition: plotter.h:1397
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment)
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
GBR_APERTURE_METADATA m_ApertureMetadata
a item to handle aperture attribute:
Definition: gbr_metadata.h:207

References FILLED_SHAPE, GBR_APERTURE_METADATA::FormatAttribute(), GBR_METADATA::m_ApertureMetadata, m_useX2format, PLOTTER::outputFile, and PlotPoly().

Referenced by FlashPadCustom(), FlashPadRoundRect(), and FlashPadTrapez().

◆ PlotImage()

void PLOTTER::PlotImage ( const wxImage &  aImage,
const wxPoint aPos,
double  aScaleFactor 
)
virtualinherited

Function PlotImage Only Postscript plotters can plot bitmaps for plotters that cannot plot a bitmap, a rectangle is plotted.

Draw an image bitmap

Parameters
aImage= the bitmap
aPos= position of the center of the bitmap
aScaleFactor= the scale factor to apply to the bitmap size (this is not the plot scale factor)

Reimplemented in SVG_PLOTTER, PDF_PLOTTER, and PS_PLOTTER.

Definition at line 231 of file plotter.cpp.

232 {
233  wxSize size( aImage.GetWidth() * aScaleFactor,
234  aImage.GetHeight() * aScaleFactor );
235 
236  wxPoint start = aPos;
237  start.x -= size.x / 2;
238  start.y -= size.y / 2;
239 
240  wxPoint end = start;
241  end.x += size.x;
242  end.y += size.y;
243 
244  Rect( start, end, NO_FILL );
245 }
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0

References NO_FILL, PLOTTER::Rect(), wxPoint::x, and wxPoint::y.

Referenced by BITMAP_BASE::PlotImage(), and SVG_PLOTTER::PlotImage().

◆ PlotPoly() [1/2]

void PLOTTER::PlotPoly ( const SHAPE_LINE_CHAIN aCornerList,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = NULL 
)
virtualinherited

Function PlotPoly.

Draw a polygon ( filled or not )

Parameters
aCornerList= corners list (a SHAPE_LINE_CHAIN). must be closed (IsClosed() == true) for a polygon. Otherwise this is a polyline
aFill= type of fill
aWidth= line width
aDataan auxiliary info (mainly for gerber format)

Definition at line 582 of file plotter.cpp.

584 {
585  std::vector<wxPoint> cornerList;
586  cornerList.reserve( aCornerList.PointCount() );
587 
588  for( int ii = 0; ii < aCornerList.PointCount(); ii++ )
589  cornerList.emplace_back( aCornerList.CPoint( ii ) );
590 
591  if( aCornerList.IsClosed() && cornerList.front() != cornerList.back() )
592  cornerList.emplace_back( aCornerList.CPoint( 0 ) );
593 
594  PlotPoly( cornerList, aFill, aWidth, aData );
595 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
int PointCount() const
Function PointCount()
const VECTOR2I & CPoint(int aIndex) const
Function Point()
bool IsClosed() const
Function IsClosed()

References SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::IsClosed(), PLOTTER::PlotPoly(), and SHAPE_LINE_CHAIN::PointCount().

◆ PlotPoly() [2/2]

void GERBER_PLOTTER::PlotPoly ( const std::vector< wxPoint > &  aCornerList,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = nullptr 
)
overridevirtual

Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence.

Implements PLOTTER.

Definition at line 584 of file GERBER_plotter.cpp.

586 {
587  if( aCornerList.size() <= 1 )
588  return;
589 
590  // Gerber format does not know filled polygons with thick outline
591  // Therefore, to plot a filled polygon with outline having a thickness,
592  // one should plot outline as thick segments
593  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
594 
595  if( gbr_metadata )
596  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
597 
598  if( aFill )
599  {
600  fputs( "G36*\n", outputFile );
601 
602  MoveTo( aCornerList[0] );
603  fputs( "G01*\n", outputFile ); // Set linear interpolation.
604 
605  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
606  LineTo( aCornerList[ii] );
607 
608  // If the polygon is not closed, close it:
609  if( aCornerList[0] != aCornerList[aCornerList.size()-1] )
610  FinishTo( aCornerList[0] );
611 
612  fputs( "G37*\n", outputFile );
613  }
614 
615  if( aWidth > 0 ) // Draw the polyline/polygon outline
616  {
617  SetCurrentLineWidth( aWidth, gbr_metadata );
618 
619  MoveTo( aCornerList[0] );
620 
621  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
622  LineTo( aCornerList[ii] );
623 
624  // Ensure the thick outline is closed for filled polygons
625  // (if not filled, could be only a polyline)
626  if( aFill && ( aCornerList[aCornerList.size()-1] != aCornerList[0] ) )
627  LineTo( aCornerList[0] );
628 
629  PenFinish();
630  }
631 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
void PenFinish()
Definition: plotter.h:289
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
void LineTo(const wxPoint &pos)
Definition: plotter.h:278
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212

References PLOTTER::FinishTo(), formatNetAttribute(), PLOTTER::LineTo(), GBR_METADATA::m_NetlistMetadata, PLOTTER::MoveTo(), PLOTTER::outputFile, PLOTTER::PenFinish(), and SetCurrentLineWidth().

Referenced by FlashPadCustom(), FlashPadRoundRect(), FlashPadTrapez(), FlashRegularPolygon(), PlotGerberRegion(), and Rect().

◆ Rect()

void GERBER_PLOTTER::Rect ( const wxPoint p1,
const wxPoint p2,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Implements PLOTTER.

Definition at line 494 of file GERBER_plotter.cpp.

495 {
496  std::vector< wxPoint > cornerList;
497 
498  // Build corners list
499  cornerList.push_back( p1 );
500  wxPoint corner(p1.x, p2.y);
501  cornerList.push_back( corner );
502  cornerList.push_back( p2 );
503  corner.x = p2.x;
504  corner.y = p1.y;
505  cornerList.push_back( corner );
506  cornerList.push_back( p1 );
507 
508  PlotPoly( cornerList, fill, width );
509 }
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.

References PlotPoly(), wxPoint::x, and wxPoint::y.

Referenced by FlashPadRect(), and ThickRect().

◆ segmentAsOval()

void PLOTTER::segmentAsOval ( const wxPoint start,
const wxPoint end,
int  width,
EDA_DRAW_MODE_T  tracemode 
)
protectedinherited

Cdonvert a thick segment and plot it as an oval.

Definition at line 437 of file plotter.cpp.

439 {
440  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
441  wxSize size( end.x - start.x, end.y - start.y );
442  double orient;
443 
444  if( size.y == 0 )
445  orient = 0;
446  else if( size.x == 0 )
447  orient = 900;
448  else
449  orient = -ArcTangente( size.y, size.x );
450 
451  size.x = KiROUND( EuclideanNorm( size ) ) + width;
452  size.y = width;
453 
454  FlashPadOval( center, size, orient, tracemode, NULL );
455 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:128
#define NULL
virtual void FlashPadOval(const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
virtual function FlashPadOval
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:61
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:162

References ArcTangente(), EuclideanNorm(), PLOTTER::FlashPadOval(), KiROUND(), NULL, wxPoint::x, and wxPoint::y.

Referenced by PLOTTER::ThickSegment(), HPGL_PLOTTER::ThickSegment(), and ThickSegment().

◆ selectAperture() [1/2]

void GERBER_PLOTTER::selectAperture ( const wxSize &  aSize,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
protected

Pick an existing aperture or create a new one, matching the size, type and attributes.

write the DCode selection on gerber file

Definition at line 342 of file GERBER_plotter.cpp.

345 {
346  bool change = ( m_currentApertureIdx < 0 ) ||
347  ( m_apertures[m_currentApertureIdx].m_Type != aType ) ||
348  ( m_apertures[m_currentApertureIdx].m_Size != aSize );
349 
350  if( !change )
351  change = m_apertures[m_currentApertureIdx].m_ApertureAttribute != aApertureAttribute;
352 
353  if( change )
354  {
355  // Pick an existing aperture or create a new one
356  m_currentApertureIdx = GetOrCreateAperture( aSize, aType, aApertureAttribute );
357  fprintf( outputFile, "D%d*\n", m_apertures[m_currentApertureIdx].m_DCode );
358  }
359 }
int GetOrCreateAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
std::vector< APERTURE > m_apertures
Definition: plotter.h:1391
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
int m_currentApertureIdx
Definition: plotter.h:1392

References GetOrCreateAperture(), m_apertures, m_currentApertureIdx, and PLOTTER::outputFile.

Referenced by FlashPadCircle(), FlashPadOval(), FlashPadRect(), FlashRegularPolygon(), selectAperture(), and SetCurrentLineWidth().

◆ selectAperture() [2/2]

void GERBER_PLOTTER::selectAperture ( int  aDiameter,
double  aPolygonRotation,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
protected

Pick an existing aperture or create a new one, matching the aDiameter, aPolygonRotation, type and attributes.

It apply only to apertures with type = AT_REGULAR_POLY3 to AT_REGULAR_POLY12 write the DCode selection on gerber file

Definition at line 361 of file GERBER_plotter.cpp.

363 {
364  // Pick an existing aperture or create a new one, matching the
365  // aDiameter, aPolygonRotation, type and attributes for type =
366  // AT_REGULAR_POLY3 to AT_REGULAR_POLY12
367 
368  wxASSERT( aType>= APERTURE::APERTURE_TYPE::AT_REGULAR_POLY3 &&
369  aType <= APERTURE::APERTURE_TYPE::AT_REGULAR_POLY12 );
370 
371  // To use selectAperture( size, ... ) calculate a equivalent aperture size:
372  // for AT_REGULAR_POLYxx the parameter APERTURE::m_Size contains
373  // aDiameter (in m_Size.x) and aPolygonRotation in 1/1000 degree (in m_Size.y)
374  wxSize size( aDiameter, (int)( aPolygonRotation * 1000.0 ) );
375  selectAperture( size, aType, aApertureAttribute );
376 }
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.

References selectAperture().

◆ SetColor()

virtual void GERBER_PLOTTER::SetColor ( COLOR4D  color)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 1186 of file plotter.h.

1186 {}

◆ SetColorMode()

virtual void PLOTTER::SetColorMode ( bool  aColorMode)
inlinevirtualinherited

◆ SetColorSettings()

void PLOTTER::SetColorSettings ( COLOR_SETTINGS aSettings)
inlineinherited

Definition at line 143 of file plotter.h.

143 { m_colors = aSettings; }
COLOR_SETTINGS * m_colors
a set of string to print in header file
Definition: plotter.h:618

References PLOTTER::m_colors.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), initializePlotter(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), and DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG().

◆ SetCreator()

◆ SetCurrentLineWidth()

void GERBER_PLOTTER::SetCurrentLineWidth ( int  width,
void *  aData = NULL 
)
overridevirtual

Set the line width for the next drawing.

Parameters
widthis specified in IUs
aDatais an auxiliary parameter, mainly used in gerber plotter

Implements PLOTTER.

Definition at line 293 of file GERBER_plotter.cpp.

294 {
295  if( width == DO_NOT_SET_LINE_WIDTH )
296  return;
297 
298  int pen_width;
299 
300  if( width > 0 )
301  pen_width = width;
302  else
303  pen_width = defaultPenWidth;
304 
305  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
306  int aperture_attribute = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
307 
308  selectAperture( wxSize( pen_width, pen_width ), APERTURE::AT_PLOTTING, aperture_attribute );
309  currentPenWidth = pen_width;
310 }
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.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:165
int currentPenWidth
Definition: plotter.h:603
int defaultPenWidth
true to generate a negative image (PS mode mainly)
Definition: plotter.h:602
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:108

References APERTURE::AT_PLOTTING, PLOTTER::currentPenWidth, PLOTTER::defaultPenWidth, PLOTTER::DO_NOT_SET_LINE_WIDTH, GBR_METADATA::GetApertureAttrib(), and selectAperture().

Referenced by Arc(), FlashPadCircle(), FlashPadCustom(), FlashPadRect(), FlashPadRoundRect(), FlashRegularPolygon(), PlotPoly(), ThickArc(), ThickCircle(), ThickRect(), and ThickSegment().

◆ SetDash()

virtual void GERBER_PLOTTER::SetDash ( PLOT_DASH_TYPE  dashed)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 1182 of file plotter.h.

1183  {
1184  }

◆ SetDefaultLineWidth()

void GERBER_PLOTTER::SetDefaultLineWidth ( int  width)
overridevirtual

Set the default line width.

Used at the beginning and when a width of -1 (USE_DEFAULT_LINE_WIDTH) is requested.

Parameters
widthis specified in IUs

Implements PLOTTER.

Definition at line 286 of file GERBER_plotter.cpp.

287 {
288  defaultPenWidth = width;
290 }
int defaultPenWidth
true to generate a negative image (PS mode mainly)
Definition: plotter.h:602
int m_currentApertureIdx
Definition: plotter.h:1392

References PLOTTER::defaultPenWidth, and m_currentApertureIdx.

Referenced by SetViewport().

◆ SetGerberCoordinatesFormat()

void GERBER_PLOTTER::SetGerberCoordinatesFormat ( int  aResolution,
bool  aUseInches = false 
)
overridevirtual

Function SetGerberCoordinatesFormat selection of Gerber units and resolution (number of digits in mantissa)

Parameters
aResolution= number of digits in mantissa of coordinate use 5 or 6 for mm and 6 or 7 for inches do not use value > 6 (mm) or > 7 (in) to avoid overflow
aUseInches= true to use inches, false to use mm (default)

Should be called only after SetViewport() is called

Reimplemented from PLOTTER.

Definition at line 90 of file GERBER_plotter.cpp.

91 {
92  m_gerberUnitInch = aUseInches;
93  m_gerberUnitFmt = aResolution;
94 
95  iuPerDeviceUnit = pow( 10.0, m_gerberUnitFmt ) / ( m_IUsPerDecimil * 10000.0 );
96 
97  if( ! m_gerberUnitInch )
98  iuPerDeviceUnit *= 25.4; // gerber output in mm
99 }
double m_IUsPerDecimil
Definition: plotter.h:582
bool m_gerberUnitInch
Definition: plotter.h:1394
int m_gerberUnitFmt
Definition: plotter.h:1395
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:585

References PLOTTER::iuPerDeviceUnit, m_gerberUnitFmt, m_gerberUnitInch, and PLOTTER::m_IUsPerDecimil.

Referenced by GERBER_WRITER::createDrillFile(), and PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ SetLayerPolarity()

void GERBER_PLOTTER::SetLayerPolarity ( bool  aPositive)
overridevirtual

Change the plot polarity and begin a new layer Used to 'scratch off' silk screen away from solder mask.

Reimplemented from PLOTTER.

Definition at line 1056 of file GERBER_plotter.cpp.

1057 {
1058  if( aPositive )
1059  fprintf( outputFile, "%%LPD*%%\n" );
1060  else
1061  fprintf( outputFile, "%%LPC*%%\n" );
1062 }
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597

References PLOTTER::outputFile.

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 125 of file plotter.h.

126  {
127  negativeMode = aNegative;
128  }
bool negativeMode
true to plot in color, false to plot in black and white
Definition: plotter.h:601

References PLOTTER::negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

◆ SetTextMode()

virtual void PLOTTER::SetTextMode ( PLOT_TEXT_MODE  mode)
inlinevirtualinherited

Change the current text mode.

See the PlotTextMode explanation at the beginning of the file

Reimplemented in DXF_PLOTTER, and PSLIKE_PLOTTER.

Definition at line 471 of file plotter.h.

472  {
473  // NOP for most plotters.
474  }

Referenced by initializePlotter(), and PlotOneBoardLayer().

◆ SetTitle()

virtual void PLOTTER::SetTitle ( const wxString &  aTitle)
inlinevirtualinherited

Definition at line 185 of file plotter.h.

186  {
187  title = aTitle;
188  }
wxString title
Definition: plotter.h:610

References PLOTTER::title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ SetViewport()

void GERBER_PLOTTER::SetViewport ( const wxPoint aOffset,
double  aIusPerDecimil,
double  aScale,
bool  aMirror 
)
overridevirtual

Set the plot offset and scaling for the current plot.

Parameters
aOffsetis the plot offset
aIusPerDecimilgives the scaling factor from IUs to device units
aScaleis the user set plot scaling factor (either explicitly or using 'fit to A4')
aMirrorflips the plot in the Y direction (useful for toner transfers or some kind of film)

Implements PLOTTER.

Definition at line 68 of file GERBER_plotter.cpp.

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  SetDefaultLineWidth( 100 * aIusPerDecimil ); // Arbitrary default
87 }
virtual void SetDefaultLineWidth(int width) override
Set the default line width.
double m_IUsPerDecimil
Definition: plotter.h:582
wxPoint plotOffset
Plot offset (in IUs)
Definition: plotter.h:588
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:592
int m_gerberUnitFmt
Definition: plotter.h:1395
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:576
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:585
wxSize paperSize
Paper size in IU - not in mils.
Definition: plotter.h:613

References PLOTTER::iuPerDeviceUnit, m_gerberUnitFmt, PLOTTER::m_IUsPerDecimil, PLOTTER::m_plotMirror, PLOTTER::paperSize, PLOTTER::plotOffset, PLOTTER::plotScale, and SetDefaultLineWidth().

Referenced by GERBER_WRITER::createDrillFile(), and PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ sketchOval()

void PLOTTER::sketchOval ( const wxPoint pos,
const wxSize &  size,
double  orient,
int  width 
)
protectedinherited

Definition at line 458 of file plotter.cpp.

459 {
460  SetCurrentLineWidth( width );
461  width = currentPenWidth;
462  int radius, deltaxy, cx, cy;
463  wxSize size( aSize );
464 
465  if( size.x > size.y )
466  {
467  std::swap( size.x, size.y );
468  orient = AddAngles( orient, 900 );
469  }
470 
471  deltaxy = size.y - size.x; /* distance between centers of the oval */
472  radius = ( size.x - width ) / 2;
473  cx = -radius;
474  cy = -deltaxy / 2;
475  RotatePoint( &cx, &cy, orient );
476  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
477  cx = -radius;
478  cy = deltaxy / 2;
479  RotatePoint( &cx, &cy, orient );
480  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
481 
482  cx = radius;
483  cy = -deltaxy / 2;
484  RotatePoint( &cx, &cy, orient );
485  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
486  cx = radius;
487  cy = deltaxy / 2;
488  RotatePoint( &cx, &cy, orient );
489  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
490 
491  cx = 0;
492  cy = deltaxy / 2;
493  RotatePoint( &cx, &cy, orient );
494  Arc( wxPoint( cx + pos.x, cy + pos.y ),
495  orient + 1800, orient + 3600,
496  radius, NO_FILL );
497  cx = 0;
498  cy = -deltaxy / 2;
499  RotatePoint( &cx, &cy, orient );
500  Arc( wxPoint( cx + pos.x, cy + pos.y ),
501  orient, orient + 1800,
502  radius, NO_FILL );
503 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
T AddAngles(T a1, T2 a2)
Add two angles (keeping the result normalized). T2 is here.
Definition: trigo.h:304
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273
int currentPenWidth
Definition: plotter.h:603
virtual void Arc(const wxPoint &centre, double StAngle, double EndAngle, int rayon, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)
Generic fallback: arc rendered as a polyline.
Definition: plotter.cpp:157
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References AddAngles(), PLOTTER::Arc(), PLOTTER::currentPenWidth, PLOTTER::FinishTo(), PLOTTER::MoveTo(), NO_FILL, RotatePoint(), PLOTTER::SetCurrentLineWidth(), wxPoint::x, and wxPoint::y.

Referenced by HPGL_PLOTTER::FlashPadOval(), PSLIKE_PLOTTER::FlashPadOval(), FlashPadOval(), and DXF_PLOTTER::FlashPadOval().

◆ StartBlock()

void GERBER_PLOTTER::StartBlock ( void *  aData)
overridevirtual

calling this function allows one to define the beginning of a group of drawing items (used in X2 format with netlist attributes)

Parameters
aDatacan define any parameter

Reimplemented from PLOTTER.

Definition at line 136 of file GERBER_plotter.cpp.

137 {
138  // Currently, it is the same as EndBlock(): clear all aperture net attributes
139  EndBlock( aData );
140 }
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...

References EndBlock().

◆ StartPlot()

bool GERBER_PLOTTER::StartPlot ( )
overridevirtual

Function StartPlot Write GERBER header to file initialize global variable g_Plot_PlotOutputFile.

Implements PLOTTER.

Definition at line 184 of file GERBER_plotter.cpp.

185 {
186  wxASSERT( outputFile );
187 
188  finalFile = outputFile; // the actual gerber file will be created later
189 
190  // Create a temporary filename to store gerber file
191  // note tmpfile() does not work under Vista and W7 in user mode
192  m_workFilename = filename + wxT(".tmp");
193  workFile = wxFopen( m_workFilename, wxT( "wt" ));
195  wxASSERT( outputFile );
196 
197  if( outputFile == NULL )
198  return false;
199 
200  for( unsigned ii = 0; ii < m_headerExtraLines.GetCount(); ii++ )
201  {
202  if( ! m_headerExtraLines[ii].IsEmpty() )
203  fprintf( outputFile, "%s\n", TO_UTF8( m_headerExtraLines[ii] ) );
204  }
205 
206  // Set coordinate format to 3.6 or 4.5 absolute, leading zero omitted
207  // the number of digits for the integer part of coordinates is needed
208  // in gerber format, but is not very important when omitting leading zeros
209  // It is fixed here to 3 (inch) or 4 (mm), but is not actually used
210  int leadingDigitCount = m_gerberUnitInch ? 3 : 4;
211 
212  fprintf( outputFile, "%%FSLAX%d%dY%d%d*%%\n",
213  leadingDigitCount, m_gerberUnitFmt,
214  leadingDigitCount, m_gerberUnitFmt );
215  fprintf( outputFile,
216  "G04 Gerber Fmt %d.%d, Leading zero omitted, Abs format (unit %s)*\n",
217  leadingDigitCount, m_gerberUnitFmt,
218  m_gerberUnitInch ? "inch" : "mm" );
219 
220  wxString Title = creator + wxT( " " ) + GetBuildVersion();
221  // In gerber files, ASCII7 chars only are allowed.
222  // So use a ISO date format (using a space as separator between date and time),
223  // not a localized date format
224  wxDateTime date = wxDateTime::Now();
225  fprintf( outputFile, "G04 Created by KiCad (%s) date %s*\n",
226  TO_UTF8( Title ), TO_UTF8( date.FormatISOCombined( ' ') ) );
227 
228  /* Mass parameter: unit = INCHES/MM */
229  if( m_gerberUnitInch )
230  fputs( "%MOIN*%\n", outputFile );
231  else
232  fputs( "%MOMM*%\n", outputFile );
233 
234  // Be sure the usual dark polarity is selected:
235  fputs( "%LPD*%\n", outputFile );
236 
237  // Set initial interpolation mode: always G01 (linear):
238  fputs( "G01*\n", outputFile );
239 
240  // Set aperture list starting point:
241  fputs( "G04 APERTURE LIST*\n", outputFile );
242 
243  return true;
244 }
bool m_gerberUnitInch
Definition: plotter.h:1394
wxArrayString m_headerExtraLines
Definition: plotter.h:615
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
#define NULL
wxString GetBuildVersion()
Get the full KiCad version string.
int m_gerberUnitFmt
Definition: plotter.h:1395
FILE * finalFile
Definition: plotter.h:1383
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
wxString m_workFilename
Definition: plotter.h:1384
FILE * workFile
Definition: plotter.h:1382
wxString filename
Definition: plotter.h:609
wxString creator
Definition: plotter.h:608

References PLOTTER::creator, PLOTTER::filename, finalFile, GetBuildVersion(), m_gerberUnitFmt, m_gerberUnitInch, PLOTTER::m_headerExtraLines, m_workFilename, NULL, PLOTTER::outputFile, TO_UTF8, and workFile.

Referenced by GERBER_WRITER::createDrillFile(), and PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ Text()

void GERBER_PLOTTER::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 
)
overridevirtual

Draws text with the plotter.

Function PLOTTER::Text same as GRText, but plot graphic text insteed of draw it.

For convenience it accept the color to use for specific plotters (GERBER) aData is used to pass extra parameters

Parameters
aPos= text position (according to aH_justify, aV_justify)
aColor(COLOR4D) = text color
aText= text to draw
aOrient= angle in 0.1 degree
aSize= text size (size.x or size.y can be < 0 for mirrored texts)
aH_justify= horizontal justification (Left, center, right)
aV_justify= vertical justification (bottom, center, top)
aWidth= line width (pen width) (default = 0) if width < 0 : draw segments in sketch mode, width = abs(width) Use a value min(aSize.x, aSize.y) / 5 for a bold text
aItalic= true to simulate an italic font
aBold= true to use a bold font Useful only with default width value (aWidth = 0)
aMultilineAllowed= true to plot text as multiline, otherwise single line
aData= a parameter used by some plotters in SetCurrentLineWidth(), not directly used here.

Reimplemented from PLOTTER.

Definition at line 1040 of file GERBER_plotter.cpp.

1045 {
1046  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1047 
1048  if( gbr_metadata )
1049  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1050 
1051  PLOTTER::Text( aPos, aColor, aText, aOrient, aSize,
1052  aH_justify, aV_justify, aWidth, aItalic, aBold, aMultilineAllowed, aData );
1053 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
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:232
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212

References formatNetAttribute(), GBR_METADATA::m_NetlistMetadata, and PLOTTER::Text().

◆ ThickArc()

void GERBER_PLOTTER::ThickArc ( const wxPoint centre,
double  StAngle,
double  EndAngle,
int  rayon,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 655 of file GERBER_plotter.cpp.

657 {
658  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
659  SetCurrentLineWidth( width, gbr_metadata );
660 
661  if( gbr_metadata )
662  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
663 
664  if( tracemode == FILLED )
665  Arc( centre, StAngle, EndAngle, radius, NO_FILL, DO_NOT_SET_LINE_WIDTH );
666  else
667  {
669  Arc( centre, StAngle, EndAngle,
670  radius - ( width - currentPenWidth ) / 2,
672  Arc( centre, StAngle, EndAngle,
673  radius + ( width - currentPenWidth ) / 2, NO_FILL,
675  }
676 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:109
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
int currentPenWidth
Definition: plotter.h:603
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.
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:108

References Arc(), PLOTTER::currentPenWidth, PLOTTER::DO_NOT_SET_LINE_WIDTH, FILLED, formatNetAttribute(), GBR_METADATA::m_NetlistMetadata, NO_FILL, SetCurrentLineWidth(), and PLOTTER::USE_DEFAULT_LINE_WIDTH.

◆ ThickCircle()

void GERBER_PLOTTER::ThickCircle ( const wxPoint pos,
int  diametre,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 707 of file GERBER_plotter.cpp.

709 {
710  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
711  SetCurrentLineWidth( width, gbr_metadata );
712 
713  if( gbr_metadata )
714  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
715 
716  if( tracemode == FILLED )
717  Circle( pos, diametre, NO_FILL, DO_NOT_SET_LINE_WIDTH );
718  else
719  {
721  Circle( pos, diametre - (width - currentPenWidth),
723  Circle( pos, diametre + (width - currentPenWidth),
725  }
726 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:109
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
int currentPenWidth
Definition: plotter.h:603
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:108

References Circle(), PLOTTER::currentPenWidth, PLOTTER::DO_NOT_SET_LINE_WIDTH, FILLED, formatNetAttribute(), GBR_METADATA::m_NetlistMetadata, NO_FILL, SetCurrentLineWidth(), and PLOTTER::USE_DEFAULT_LINE_WIDTH.

◆ ThickRect()

void GERBER_PLOTTER::ThickRect ( const wxPoint p1,
const wxPoint p2,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 679 of file GERBER_plotter.cpp.

681 {
682  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
683  SetCurrentLineWidth( width, gbr_metadata );
684 
685  if( gbr_metadata )
686  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
687 
688  if( tracemode == FILLED )
689  Rect( p1, p2, NO_FILL, DO_NOT_SET_LINE_WIDTH );
690  else
691  {
693  wxPoint offsetp1( p1.x - (width - currentPenWidth) / 2,
694  p1.y - (width - currentPenWidth) / 2 );
695  wxPoint offsetp2( p2.x + (width - currentPenWidth) / 2,
696  p2.y + (width - currentPenWidth) / 2 );
697  Rect( offsetp1, offsetp2, NO_FILL, -1 );
698  offsetp1.x += (width - currentPenWidth);
699  offsetp1.y += (width - currentPenWidth);
700  offsetp2.x -= (width - currentPenWidth);
701  offsetp2.y -= (width - currentPenWidth);
702  Rect( offsetp1, offsetp2, NO_FILL, DO_NOT_SET_LINE_WIDTH );
703  }
704 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
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:109
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
int currentPenWidth
Definition: plotter.h:603
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:108

References PLOTTER::currentPenWidth, PLOTTER::DO_NOT_SET_LINE_WIDTH, FILLED, formatNetAttribute(), GBR_METADATA::m_NetlistMetadata, NO_FILL, Rect(), SetCurrentLineWidth(), PLOTTER::USE_DEFAULT_LINE_WIDTH, wxPoint::x, and wxPoint::y.

◆ ThickSegment()

void GERBER_PLOTTER::ThickSegment ( const wxPoint start,
const wxPoint end,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 634 of file GERBER_plotter.cpp.

636 {
637  if( tracemode == FILLED )
638  {
639  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
640  SetCurrentLineWidth( width, gbr_metadata );
641 
642  if( gbr_metadata )
643  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
644 
645  MoveTo( start );
646  FinishTo( end );
647  }
648  else
649  {
651  segmentAsOval( start, end, width, tracemode );
652  }
653 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:283
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:109
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
void MoveTo(const wxPoint &pos)
Definition: plotter.h:273
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
Definition: gbr_metadata.h:212
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:437

References FILLED, PLOTTER::FinishTo(), formatNetAttribute(), GBR_METADATA::m_NetlistMetadata, PLOTTER::MoveTo(), PLOTTER::segmentAsOval(), SetCurrentLineWidth(), and PLOTTER::USE_DEFAULT_LINE_WIDTH.

Referenced by GERBER_WRITER::createDrillFile(), and FlashPadOval().

◆ userToDeviceCoordinates()

DPOINT PLOTTER::userToDeviceCoordinates ( const wxPoint aCoordinate)
protectedvirtualinherited

Modifies coordinates according to the orientation, scale factor, and offsets trace.

Also convert from a wxPoint to DPOINT, since some output engines needs floating point coordinates.

Definition at line 99 of file plotter.cpp.

100 {
101  wxPoint pos = aCoordinate - plotOffset;
102 
103  double x = pos.x * plotScale;
104  double y = ( paperSize.y - pos.y * plotScale );
105 
106  if( m_plotMirror )
107  {
109  x = ( paperSize.x - pos.x * plotScale );
110  else
111  y = pos.y * plotScale;
112  }
113 
114  if( m_yaxisReversed )
115  y = paperSize.y - y;
116 
117  x *= iuPerDeviceUnit;
118  y *= iuPerDeviceUnit;
119 
120  return DPOINT( x, y );
121 }
wxPoint plotOffset
Plot offset (in IUs)
Definition: plotter.h:588
bool m_yaxisReversed
true to mirror horizontally (else vertically)
Definition: plotter.h:594
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:592
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:576
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:585
VECTOR2< double > DPOINT
Definition: vector2d.h:599
wxSize paperSize
Paper size in IU - not in mils.
Definition: plotter.h:613
bool m_mirrorIsHorizontal
Definition: plotter.h:593

References PLOTTER::iuPerDeviceUnit, PLOTTER::m_mirrorIsHorizontal, PLOTTER::m_plotMirror, PLOTTER::m_yaxisReversed, PLOTTER::paperSize, PLOTTER::plotOffset, PLOTTER::plotScale, wxPoint::x, and wxPoint::y.

Referenced by HPGL_PLOTTER::Arc(), PS_PLOTTER::Arc(), PDF_PLOTTER::Arc(), SVG_PLOTTER::Arc(), Arc(), DXF_PLOTTER::Arc(), SVG_PLOTTER::BezierCurve(), PS_PLOTTER::Circle(), PDF_PLOTTER::Circle(), SVG_PLOTTER::Circle(), DXF_PLOTTER::Circle(), PSLIKE_PLOTTER::computeTextParameters(), HPGL_PLOTTER::FlashPadCircle(), FlashPadCircle(), FlashPadOval(), FlashPadRect(), FlashRegularPolygon(), HPGL_PLOTTER::PenTo(), PS_PLOTTER::PenTo(), PDF_PLOTTER::PenTo(), SVG_PLOTTER::PenTo(), PenTo(), DXF_PLOTTER::PenTo(), PS_PLOTTER::PlotImage(), PDF_PLOTTER::PlotImage(), PS_PLOTTER::PlotPoly(), PDF_PLOTTER::PlotPoly(), SVG_PLOTTER::PlotPoly(), HPGL_PLOTTER::Rect(), PS_PLOTTER::Rect(), PDF_PLOTTER::Rect(), SVG_PLOTTER::Rect(), PS_PLOTTER::Text(), SVG_PLOTTER::Text(), and DXF_PLOTTER::Text().

◆ userToDeviceSize() [1/2]

DPOINT PLOTTER::userToDeviceSize ( const wxSize &  size)
protectedvirtualinherited

◆ userToDeviceSize() [2/2]

double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtualinherited

Modifies size according to the plotter scale factors (simple double version)

Definition at line 131 of file plotter.cpp.

132 {
133  return size * plotScale * iuPerDeviceUnit;
134 }
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:576
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:585

References PLOTTER::iuPerDeviceUnit, and PLOTTER::plotScale.

◆ UseX2format()

void GERBER_PLOTTER::UseX2format ( bool  aEnable)
inline

Definition at line 1296 of file plotter.h.

1296 { m_useX2format = aEnable; }
bool m_useX2format
Definition: plotter.h:1397

References m_useX2format.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), and StartPlotBoard().

◆ UseX2NetAttributes()

void GERBER_PLOTTER::UseX2NetAttributes ( bool  aEnable)
inline

Definition at line 1297 of file plotter.h.

1297 { m_useNetAttributes = aEnable; }
bool m_useNetAttributes
Definition: plotter.h:1400

References m_useNetAttributes.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), and StartPlotBoard().

◆ writeApertureList()

void GERBER_PLOTTER::writeApertureList ( )
protected

Generate the table of D codes.

Definition at line 378 of file GERBER_plotter.cpp.

379 {
380  wxASSERT( outputFile );
381  char cbuf[1024];
382 
383  bool useX1StructuredComment = false;
384 
385  if( !m_useX2format )
386  useX1StructuredComment = true;
387 
388  // Init
389  for( APERTURE& tool : m_apertures )
390  {
391  // apertude sizes are in inch or mm, regardless the
392  // coordinates format
393  double fscale = 0.0001 * plotScale / m_IUsPerDecimil; // inches
394 
395  if(! m_gerberUnitInch )
396  fscale *= 25.4; // size in mm
397 
398  int attribute = tool.m_ApertureAttribute;
399 
400  if( attribute != m_apertureAttribute )
401  {
404  useX1StructuredComment ).c_str(), outputFile );
405  }
406 
407  char* text = cbuf + sprintf( cbuf, "%%ADD%d", tool.m_DCode );
408 
409  /* Please note: the Gerber specs for mass parameters say that
410  exponential syntax is *not* allowed and the decimal point should
411  also be always inserted. So the %g format is ruled out, but %f is fine
412  (the # modifier forces the decimal point). Sadly the %f formatter
413  can't remove trailing zeros but thats not a problem, since nothing
414  forbid it (the file is only slightly longer) */
415 
416  switch( tool.m_Type )
417  {
418  case APERTURE::AT_CIRCLE:
419  sprintf( text, "C,%#f*%%\n", tool.GetDiameter() * fscale );
420  break;
421 
422  case APERTURE::AT_RECT:
423  sprintf( text, "R,%#fX%#f*%%\n", tool.m_Size.x * fscale,
424  tool.m_Size.y * fscale );
425  break;
426 
428  sprintf( text, "C,%#f*%%\n", tool.m_Size.x * fscale );
429  break;
430 
431  case APERTURE::AT_OVAL:
432  sprintf( text, "O,%#fX%#f*%%\n", tool.m_Size.x * fscale,
433  tool.m_Size.y * fscale );
434  break;
435 
447  sprintf( text, "P,%#fX%dX%#f*%%\n", tool.GetDiameter() * fscale,
448  tool.GetVerticeCount(), tool.GetRotation() );
449  break;
450  }
451 
452  fputs( cbuf, outputFile );
453 
454  m_apertureAttribute = attribute;
455 
456  // Currently reset the aperture attribute. Perhaps a better optimization
457  // is to store the last attribute
458  if( attribute )
459  {
460  if( m_useX2format )
461  fputs( "%TD*%\n", outputFile );
462  else
463  fputs( "G04 #@! TD*\n", outputFile );
464 
466  }
467 
468  }
469 }
double m_IUsPerDecimil
Definition: plotter.h:582
bool m_gerberUnitInch
Definition: plotter.h:1394
std::vector< APERTURE > m_apertures
Definition: plotter.h:1391
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:576
bool m_useX2format
Definition: plotter.h:1397
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment)
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:597
int m_apertureAttribute
Definition: plotter.h:1380

References APERTURE::AT_CIRCLE, APERTURE::AT_OVAL, APERTURE::AT_PLOTTING, APERTURE::AT_RECT, APERTURE::AT_REGULAR_POLY, APERTURE::AT_REGULAR_POLY10, APERTURE::AT_REGULAR_POLY11, APERTURE::AT_REGULAR_POLY12, APERTURE::AT_REGULAR_POLY3, APERTURE::AT_REGULAR_POLY4, APERTURE::AT_REGULAR_POLY5, APERTURE::AT_REGULAR_POLY6, APERTURE::AT_REGULAR_POLY7, APERTURE::AT_REGULAR_POLY8, APERTURE::AT_REGULAR_POLY9, GBR_APERTURE_METADATA::FormatAttribute(), m_apertureAttribute, m_apertures, m_gerberUnitInch, PLOTTER::m_IUsPerDecimil, m_useX2format, PLOTTER::outputFile, and PLOTTER::plotScale.

Referenced by EndPlot().

Member Data Documentation

◆ colorMode

◆ creator

wxString PLOTTER::creator
protectedinherited

◆ currentPenWidth

◆ defaultPenWidth

◆ DO_NOT_SET_LINE_WIDTH

const int PLOTTER::DO_NOT_SET_LINE_WIDTH = -2
staticinherited

Definition at line 108 of file plotter.h.

Referenced by FlashPadCircle(), SetCurrentLineWidth(), ThickArc(), ThickCircle(), and ThickRect().

◆ filename

wxString PLOTTER::filename
protectedinherited

◆ finalFile

FILE* GERBER_PLOTTER::finalFile
protected

Definition at line 1383 of file plotter.h.

Referenced by EndPlot(), GERBER_PLOTTER(), and StartPlot().

◆ iuPerDeviceUnit

◆ m_apertureAttribute

int GERBER_PLOTTER::m_apertureAttribute
protected

Definition at line 1380 of file plotter.h.

Referenced by GERBER_PLOTTER(), and writeApertureList().

◆ m_apertures

std::vector<APERTURE> GERBER_PLOTTER::m_apertures
protected

Definition at line 1391 of file plotter.h.

Referenced by GetOrCreateAperture(), selectAperture(), and writeApertureList().

◆ m_colors

COLOR_SETTINGS* PLOTTER::m_colors
protectedinherited

a set of string to print in header file

Pointer to active color settings that is used for plotting

Definition at line 618 of file plotter.h.

Referenced by PLOTTER::ColorSettings(), and PLOTTER::SetColorSettings().

◆ m_currentApertureIdx

int GERBER_PLOTTER::m_currentApertureIdx
protected

Definition at line 1392 of file plotter.h.

Referenced by GERBER_PLOTTER(), selectAperture(), and SetDefaultLineWidth().

◆ m_gerberUnitFmt

int GERBER_PLOTTER::m_gerberUnitFmt
protected

Definition at line 1395 of file plotter.h.

Referenced by GERBER_PLOTTER(), SetGerberCoordinatesFormat(), SetViewport(), and StartPlot().

◆ m_gerberUnitInch

bool GERBER_PLOTTER::m_gerberUnitInch
protected

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

Definition at line 615 of file plotter.h.

Referenced by PLOTTER::AddLineToHeader(), PLOTTER::ClearHeaderLinesList(), and StartPlot().

◆ m_IUsPerDecimil

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

◆ m_objectAttributesDictionnary

std::string GERBER_PLOTTER::m_objectAttributesDictionnary
protected

Definition at line 1377 of file plotter.h.

Referenced by ClearAllAttributes(), clearNetAttribute(), and formatNetAttribute().

◆ m_plotMirror

◆ m_useNetAttributes

bool GERBER_PLOTTER::m_useNetAttributes
protected

Definition at line 1400 of file plotter.h.

Referenced by formatNetAttribute(), GERBER_PLOTTER(), and UseX2NetAttributes().

◆ m_useX2format

bool GERBER_PLOTTER::m_useX2format
protected

◆ m_workFilename

wxString GERBER_PLOTTER::m_workFilename
protected

Definition at line 1384 of file plotter.h.

Referenced by EndPlot(), and StartPlot().

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed
protectedinherited

true to mirror horizontally (else vertically)

Definition at line 594 of file plotter.h.

Referenced by SVG_PLOTTER::Arc(), PLOTTER::PLOTTER(), SVG_PLOTTER::SetViewport(), and PLOTTER::userToDeviceCoordinates().

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58
staticinherited

Draw a marker (used for the drill map)

Definition at line 444 of file plotter.h.

Referenced by PLOTTER::Marker().

◆ negativeMode

bool PLOTTER::negativeMode
protectedinherited

true to plot in color, false to plot in black and white

Definition at line 601 of file plotter.h.

Referenced by PLOTTER::PLOTTER(), PSLIKE_PLOTTER::SetColor(), and PLOTTER::SetNegative().

◆ outputFile

FILE* PLOTTER::outputFile
protectedinherited

true if the Y axis is top to bottom (SVG)

Output file

Definition at line 597 of file plotter.h.

Referenced by HPGL_PLOTTER::Arc(), PS_PLOTTER::Arc(), SVG_PLOTTER::Arc(), Arc(), DXF_PLOTTER::Arc(), SVG_PLOTTER::BezierCurve(), HPGL_PLOTTER::Circle(), PS_PLOTTER::Circle(), SVG_PLOTTER::Circle(), DXF_PLOTTER::Circle(), ClearAllAttributes(), clearNetAttribute(), PDF_PLOTTER::ClosePage(), PDF_PLOTTER::closePdfObject(), PDF_PLOTTER::closePdfStream(), emitDcode(), PS_PLOTTER::emitSetRGBColor(), SVG_PLOTTER::EndBlock(), HPGL_PLOTTER::EndPlot(), PS_PLOTTER::EndPlot(), PDF_PLOTTER::EndPlot(), SVG_PLOTTER::EndPlot(), EndPlot(), DXF_PLOTTER::EndPlot(), HPGL_PLOTTER::FlashPadCircle(), DXF_PLOTTER::FlashPadCircle(), HPGL_PLOTTER::FlashPadOval(), PSLIKE_PLOTTER::FlashPadOval(), FlashPadOval(), DXF_PLOTTER::FlashPadOval(), FlashPadRect(), DXF_PLOTTER::FlashPadRect(), DXF_PLOTTER::FlashPadTrapez(), formatNetAttribute(), PLOTTER::OpenFile(), PDF_PLOTTER::OpenFile(), HPGL_PLOTTER::penControl(), HPGL_PLOTTER::PenTo(), PS_PLOTTER::PenTo(), SVG_PLOTTER::PenTo(), PenTo(), DXF_PLOTTER::PenTo(), PlotGerberRegion(), PS_PLOTTER::PlotImage(), SVG_PLOTTER::PlotImage(), HPGL_PLOTTER::PlotPoly(), PS_PLOTTER::PlotPoly(), SVG_PLOTTER::PlotPoly(), PlotPoly(), PLOTTER::PLOTTER(), HPGL_PLOTTER::Rect(), PS_PLOTTER::Rect(), SVG_PLOTTER::Rect(), DXF_PLOTTER::Rect(), selectAperture(), PS_PLOTTER::SetCurrentLineWidth(), HPGL_PLOTTER::SetDash(), PS_PLOTTER::SetDash(), SetLayerPolarity(), SVG_PLOTTER::setSVGPlotStyle(), PS_PLOTTER::SetViewport(), SVG_PLOTTER::StartBlock(), PDF_PLOTTER::StartPage(), PDF_PLOTTER::startPdfObject(), PDF_PLOTTER::startPdfStream(), HPGL_PLOTTER::StartPlot(), PS_PLOTTER::StartPlot(), PDF_PLOTTER::StartPlot(), SVG_PLOTTER::StartPlot(), StartPlot(), DXF_PLOTTER::StartPlot(), PS_PLOTTER::Text(), SVG_PLOTTER::Text(), DXF_PLOTTER::Text(), HPGL_PLOTTER::ThickSegment(), writeApertureList(), and PLOTTER::~PLOTTER().

◆ pageInfo

◆ paperSize

wxSize PLOTTER::paperSize
protectedinherited

◆ penLastpos

wxPoint PLOTTER::penLastpos
protectedinherited

Last pen positions; set to -1,-1 when the pen is at rest.

Definition at line 607 of file plotter.h.

Referenced by HPGL_PLOTTER::penControl(), HPGL_PLOTTER::PenTo(), PS_PLOTTER::PenTo(), PDF_PLOTTER::PenTo(), SVG_PLOTTER::PenTo(), and DXF_PLOTTER::PenTo().

◆ penState

char PLOTTER::penState
protectedinherited

Current pen state: 'U', 'D' or 'Z' (see PenTo)

Definition at line 605 of file plotter.h.

Referenced by HPGL_PLOTTER::penControl(), PS_PLOTTER::PenTo(), PDF_PLOTTER::PenTo(), SVG_PLOTTER::PenTo(), PenTo(), and PLOTTER::PLOTTER().

◆ plotOffset

◆ plotScale

double PLOTTER::plotScale
protectedinherited

◆ title

wxString PLOTTER::title
protectedinherited

Definition at line 610 of file plotter.h.

Referenced by PDF_PLOTTER::EndPlot(), and PLOTTER::SetTitle().

◆ USE_DEFAULT_LINE_WIDTH

◆ workFile

FILE* GERBER_PLOTTER::workFile
protected

Definition at line 1382 of file plotter.h.

Referenced by EndPlot(), GERBER_PLOTTER(), and StartPlot().


The documentation for this class was generated from the following files: