KiCad PCB EDA Suite
GERBER_PLOTTER Class Reference

#include <plotter_gerber.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
 Write GERBER header to file initialize global variable g_Plot_PlotOutputFile. More...
 
virtual bool EndPlot () override
 
virtual void SetCurrentLineWidth (int width, void *aData=nullptr) override
 Set the line width for the next drawing. More...
 
virtual void SetDash (PLOT_DASH_TYPE dashed) override
 
virtual void SetColor (const 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_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
 
virtual void Circle (const wxPoint &pos, int diametre, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
 
virtual void Arc (const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
 Generic fallback: arc rendered as a polyline. More...
 
virtual void Arc (const SHAPE_ARC &aArc) override
 
virtual void ThickSegment (const wxPoint &start, const wxPoint &end, int width, OUTLINE_MODE tracemode, void *aData) override
 
virtual void ThickArc (const wxPoint &centre, double StAngle, double EndAngle, int rayon, int width, OUTLINE_MODE tracemode, void *aData) override
 
virtual void ThickRect (const wxPoint &p1, const wxPoint &p2, int width, OUTLINE_MODE tracemode, void *aData) override
 
virtual void ThickCircle (const wxPoint &pos, int diametre, int width, OUTLINE_MODE tracemode, void *aData) override
 
virtual void FilledCircle (const wxPoint &pos, int diametre, OUTLINE_MODE tracemode, void *aData) override
 
virtual void PlotPoly (const std::vector< wxPoint > &aCornerList, FILL_TYPE 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 PlotPoly (const SHAPE_LINE_CHAIN &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr) override
 Draw a polygon ( filled or not ). 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=nullptr) override
 Draw text with the plotter. More...
 
virtual void FlashPadCircle (const wxPoint &pos, int diametre, OUTLINE_MODE trace_mode, void *aData) override
 Filled circular flashes are stored as apertures. More...
 
virtual void FlashPadOval (const wxPoint &aPadPos, const wxSize &size, double orient, OUTLINE_MODE trace_mode, void *aData) override
 
virtual void FlashPadRect (const wxPoint &aPadPos, const wxSize &size, double orient, OUTLINE_MODE trace_mode, void *aData) override
 
virtual void FlashPadRoundRect (const wxPoint &aPadPos, const wxSize &aSize, int aCornerRadius, double aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadCustom (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, SHAPE_POLY_SET *aPolygons, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadTrapez (const wxPoint &aPadPos, const wxPoint *aCorners, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a trapezoidal pad. More...
 
virtual void FlashRegularPolygon (const wxPoint &aShapePos, int aDiameter, int aCornerCount, double aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a regular polygon. More...
 
void FlashPadChamferRoundRect (const wxPoint &aShapePos, const wxSize &aPadSize, int aCornerRadius, double aChamferRatio, int aChamferPositions, double aPadOrient, OUTLINE_MODE aPlotMode, void *aData)
 Flash a chamfered round rect pad. More...
 
void PlotGerberRegion (const std::vector< wxPoint > &aCornerList, void *aData=nullptr)
 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...
 
void PlotGerberRegion (const SHAPE_LINE_CHAIN &aPoly, void *aData=nullptr)
 
virtual void SetLayerPolarity (bool aPositive) override
 Change the plot polarity and begin a new layer. More...
 
virtual void SetGerberCoordinatesFormat (int aResolution, bool aUseInches=false) override
 Selection of Gerber units and resolution (number of digits in mantissa). More...
 
void UseX2format (bool aEnable)
 
void UseX2NetAttributes (bool aEnable)
 
void DisableApertMacros (bool aDisable)
 Disable Aperture Macro (AM) command, only for broken Gerber Readers. More...
 
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
 Define the end of a group of drawing items the group is started by StartBlock(). More...
 
void ClearAllAttributes ()
 Remove (clear) all attributes from object attributes dictionary (TO. More...
 
int GetOrCreateAperture (const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 
int GetOrCreateAperture (const std::vector< wxPoint > &aCorners, double aRotDegree, 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 SetRenderSettings (RENDER_SETTINGS *aSettings)
 
RENDER_SETTINGSRenderSettings ()
 
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)
 Add a line to the list of free lines to print at the beginning of the file. More...
 
void 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 PlotImage (const wxImage &aImage, const wxPoint &aPos, double aScaleFactor)
 Only PostScript plotters can plot bitmaps. 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...
 
virtual void SetSvgCoordinatesFormat (unsigned aResolution, bool aUseInches=false)
 

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 plotRoundRectAsRegion (const wxPoint &aRectCenter, const wxSize &aSize, int aCornerRadius, double aOrient)
 Plot a round rect (a round rect shape in fact) as a Gerber region using lines and arcs for corners. More...
 
void plotArc (const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, bool aPlotInRegion)
 Plot a Gerber arc. More...
 
void plotArc (const SHAPE_ARC &aArc, bool aPlotInRegion)
 
void selectAperture (const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 Pick an existing aperture or create a new one, matching the size, type and attributes. More...
 
void selectAperture (const std::vector< wxPoint > &aCorners, 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 selectAperture (int aDiameter, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 Pick an existing aperture or create a new one, matching the corner list, aRotDegree, 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. 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_objectAttributesDictionary. 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, OUTLINE_MODE tracemode)
 Convert 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)
 Modify coordinates according to the orientation, scale factor, and offsets trace. More...
 
virtual DPOINT userToDeviceSize (const wxSize &size)
 Modify size according to the plotter scale factors (wxSize version, returns a DPOINT). More...
 
virtual double userToDeviceSize (double size) const
 Modify 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_objectAttributesDictionary
 
int m_apertureAttribute
 
FILE * workFile
 
FILE * finalFile
 
wxString m_workFilename
 
std::vector< APERTUREm_apertures
 
int m_currentApertureIdx
 
bool m_hasApertureRoundRect
 
bool m_hasApertureRotOval
 
bool m_hasApertureRotRect
 
bool m_hasApertureOutline4P
 
bool m_hasApertureChamferedRect
 
bool m_gerberUnitInch
 
int m_gerberUnitFmt
 
bool m_gerberDisableApertMacros
 
bool m_useX2format
 
bool m_useNetAttributes
 
APER_MACRO_FREEPOLY_LIST m_am_freepoly_list
 
double m_plotScale
 Plot scale - chosen by the user (even implicitly with 'fit in a4') More...
 
double m_IUsPerDecimil
 
double m_iuPerDeviceUnit
 
wxPoint m_plotOffset
 
bool m_plotMirror
 
bool m_mirrorIsHorizontal
 
bool m_yaxisReversed
 
FILE * m_outputFile
 Output file. More...
 
bool m_colorMode
 
bool m_negativeMode
 
int m_currentPenWidth
 
char m_penState
 
wxPoint m_penLastpos
 
wxString m_creator
 
wxString m_filename
 
wxString m_title
 
PAGE_INFO m_pageInfo
 
wxSize m_paperSize
 
wxArrayString m_headerExtraLines
 
RENDER_SETTINGSm_renderSettings
 

Detailed Description

Definition at line 37 of file plotter_gerber.h.

Constructor & Destructor Documentation

◆ GERBER_PLOTTER()

GERBER_PLOTTER::GERBER_PLOTTER ( )

Definition at line 94 of file GERBER_plotter.cpp.

95 {
96  workFile = nullptr;
97  finalFile = nullptr;
100 
101  // number of digits after the point (number of digits of the mantissa
102  // Be careful: the Gerber coordinates are stored in an integer
103  // so 6 digits (inches) or 5 digits (mm) is a good value
104  // To avoid overflow, 7 digits (inches) or 6 digits is a max.
105  // with lower values than 6 digits (inches) or 5 digits (mm),
106  // Creating self-intersecting polygons from non-intersecting polygons
107  // happen easily.
108  m_gerberUnitInch = false;
109  m_gerberUnitFmt = 6;
110  m_useX2format = true;
111  m_useNetAttributes = true;
113 
114  m_hasApertureRoundRect = false; // true is at least one round rect aperture is in use
115  m_hasApertureRotOval = false; // true is at least one oval rotated aperture is in use
116  m_hasApertureRotRect = false; // true is at least one rect. rotated aperture is in use
117  m_hasApertureOutline4P = false; // true is at least one rotated rect or trapezoid pad
118  // aperture is in use
119  m_hasApertureChamferedRect = false; // true is at least one chamfered rect
120  // (no rounded corner) is in use
121 }
bool m_hasApertureChamferedRect
bool m_hasApertureOutline4P
bool m_hasApertureRoundRect
bool m_gerberDisableApertMacros

References finalFile, m_apertureAttribute, m_currentApertureIdx, m_gerberDisableApertMacros, m_gerberUnitFmt, m_gerberUnitInch, m_hasApertureChamferedRect, m_hasApertureOutline4P, m_hasApertureRotOval, m_hasApertureRotRect, m_hasApertureRoundRect, m_useNetAttributes, m_useX2format, and workFile.

Member Function Documentation

◆ AddLineToHeader()

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

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 183 of file plotter.h.

184  {
185  m_headerExtraLines.Add( aExtraString );
186  }
wxArrayString m_headerExtraLines
Definition: plotter.h:605

References PLOTTER::m_headerExtraLines.

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

◆ Arc() [1/2]

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

Generic fallback: arc rendered as a polyline.

Reimplemented from PLOTTER.

Definition at line 824 of file GERBER_plotter.cpp.

826 {
827  SetCurrentLineWidth( aWidth );
828 
829  // aFill is not used here.
830  plotArc( aCenter, aStAngle, aEndAngle, aRadius, false );
831 }
void plotArc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, bool aPlotInRegion)
Plot a Gerber arc.
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.

References plotArc(), and SetCurrentLineWidth().

Referenced by Circle(), and ThickArc().

◆ Arc() [2/2]

void GERBER_PLOTTER::Arc ( const SHAPE_ARC aArc)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 834 of file GERBER_plotter.cpp.

835 {
836  SetCurrentLineWidth( aArc.GetWidth() );
837 
838  // aFill is not used here.
839  plotArc( aArc, false );
840 }
void plotArc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, bool aPlotInRegion)
Plot a Gerber arc.
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
int GetWidth() const
Definition: shape_arc.h:112

References SHAPE_ARC::GetWidth(), plotArc(), and SetCurrentLineWidth().

◆ 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 210 of file plotter.cpp.

213 {
214  // Generic fallback: Quadratic Bezier curve plotted as a polyline
215  int minSegLen = aLineThickness; // The segment min length to approximate a bezier curve
216 
217  std::vector<wxPoint> ctrlPoints;
218  ctrlPoints.push_back( aStart );
219  ctrlPoints.push_back( aControl1 );
220  ctrlPoints.push_back( aControl2 );
221  ctrlPoints.push_back( aEnd );
222 
223  BEZIER_POLY bezier_converter( ctrlPoints );
224 
225  std::vector<wxPoint> approxPoints;
226  bezier_converter.GetPoly( approxPoints, minSegLen );
227 
228  SetCurrentLineWidth( aLineThickness );
229  MoveTo( aStart );
230 
231  for( unsigned ii = 1; ii < approxPoints.size()-1; ii++ )
232  LineTo( approxPoints[ii] );
233 
234  FinishTo( aEnd );
235 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void LineTo(const wxPoint &pos)
Definition: plotter.h:268
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
Bezier curves to polygon converter.
Definition: bezier_curves.h:36
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=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::PlotFootprintGraphicItem(), and BRDITEMS_PLOTTER::PlotPcbShape().

◆ Circle()

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

Implements PLOTTER.

Definition at line 817 of file GERBER_plotter.cpp.

818 {
819  Arc( aCenter, 0, 3600, aDiameter / 2, aFill, aWidth );
820 }
virtual void Arc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
Generic fallback: arc rendered as a polyline.

References Arc().

Referenced by FilledCircle(), 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 164 of file GERBER_plotter.cpp.

165 {
166  // Remove all attributes from object attributes dictionary (TO. and TA commands)
167  if( m_useX2format )
168  fputs( "%TD*%\n", m_outputFile );
169  else
170  fputs( "G04 #@! TD*\n", m_outputFile );
171 
173 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
std::string m_objectAttributesDictionary

References m_objectAttributesDictionary, PLOTTER::m_outputFile, and m_useX2format.

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ ClearHeaderLinesList()

void PLOTTER::ClearHeaderLinesList ( )
inlineinherited

Remove all lines from the list of free lines to print at the beginning of the file.

Definition at line 191 of file plotter.h.

192  {
193  m_headerExtraLines.Clear();
194  }
wxArrayString m_headerExtraLines
Definition: plotter.h:605

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_objectAttributesDictionary.

Definition at line 176 of file GERBER_plotter.cpp.

177 {
178  // disable a Gerber net attribute (exists only in X2 with net attributes mode).
179  if( m_objectAttributesDictionary.empty() ) // No net attribute or not X2 mode
180  return;
181 
182  // Remove all net attributes from object attributes dictionary
183  if( m_useX2format )
184  fputs( "%TD*%\n", m_outputFile );
185  else
186  fputs( "G04 #@! TD*\n", m_outputFile );
187 
189 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
std::string m_objectAttributesDictionary

References m_objectAttributesDictionary, PLOTTER::m_outputFile, and m_useX2format.

Referenced by EndBlock(), and formatNetAttribute().

◆ DisableApertMacros()

void GERBER_PLOTTER::DisableApertMacros ( bool  aDisable)
inline

Disable Aperture Macro (AM) command, only for broken Gerber Readers.

Regions will be used instead of AM shapes to draw complex shapes.

Parameters
aDisableuse true to disable Aperture Macro (AM) command.

Definition at line 203 of file plotter_gerber.h.

203 { m_gerberDisableApertMacros = aDisable; }
bool m_gerberDisableApertMacros

References m_gerberDisableApertMacros.

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

◆ 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 158 of file GERBER_plotter.cpp.

159 {
160 
161  fprintf( m_outputFile, "X%dY%dD%02d*\n", KiROUND( pt.x ), KiROUND( pt.y ), dcode );
162 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
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:70

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

Referenced by FlashPadChamferRoundRect(), FlashPadCircle(), FlashPadCustom(), FlashPadOval(), FlashPadRect(), FlashPadRoundRect(), FlashPadTrapez(), FlashRegularPolygon(), and PenTo().

◆ EndBlock()

void GERBER_PLOTTER::EndBlock ( void *  aData)
overridevirtual

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 199 of file GERBER_plotter.cpp.

200 {
201  // Remove all net attributes from object attributes dictionary
203 }
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 320 of file GERBER_plotter.cpp.

321 {
322  char line[1024];
323  wxString msg;
324 
325  wxASSERT( m_outputFile );
326 
327  /* Outfile is actually a temporary file i.e. workFile */
328  fputs( "M02*\n", m_outputFile );
329  fflush( m_outputFile );
330 
331  fclose( workFile );
332  workFile = wxFopen( m_workFilename, wxT( "rt" ));
333  wxASSERT( workFile );
335 
336  // Placement of apertures in RS274X
337  while( fgets( line, 1024, workFile ) )
338  {
339  fputs( line, m_outputFile );
340 
341  char* substr = strtok( line, "\n\r" );
342 
343  if( substr && strcmp( substr, "G04 APERTURE LIST*" ) == 0 )
344  {
345  // Add aperture list macro:
349  {
350  fputs( "G04 Aperture macros list*\n", m_outputFile );
351 
354 
357 
360 
363 
365  {
370  }
371 
373  {
374  // aperture sizes are in inch or mm, regardless the
375  // coordinates format
376  double fscale = 0.0001 * m_plotScale / m_IUsPerDecimil; // inches
377 
378  if(! m_gerberUnitInch )
379  fscale *= 25.4; // size in mm
380 
382  }
383 
384  fputs( "G04 Aperture macros list end*\n", m_outputFile );
385  }
386 
388  fputs( "G04 APERTURE END LIST*\n", m_outputFile );
389  }
390  }
391 
392  fclose( workFile );
393  fclose( finalFile );
394  ::wxRemoveFile( m_workFilename );
395  m_outputFile = nullptr;
396 
397  return true;
398 }
#define APER_MACRO_ROT_RECT_HEADER
void writeApertureList()
Generate the table of D codes.
bool m_hasApertureChamferedRect
FILE * m_outputFile
Output file.
Definition: plotter.h:590
APER_MACRO_FREEPOLY_LIST m_am_freepoly_list
double m_IUsPerDecimil
Definition: plotter.h:579
#define APER_MACRO_OUTLINE6P_HEADER
bool m_hasApertureOutline4P
bool m_hasApertureRoundRect
double m_plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:573
#define APER_MACRO_SHAPE_OVAL_HEADER
#define APER_MACRO_OUTLINE5P_HEADER
#define APER_MACRO_ROUNDRECT_HEADER
#define APER_MACRO_OUTLINE7P_HEADER
#define APER_MACRO_OUTLINE4P_HEADER
#define APER_MACRO_OUTLINE8P_HEADER
wxString m_workFilename
void Format(FILE *aOutput, double aIu2GbrMacroUnit)
print the aperture macro list to aOutput

References APER_MACRO_FREEPOLY_LIST::AmCount(), APER_MACRO_OUTLINE4P_HEADER, APER_MACRO_OUTLINE5P_HEADER, APER_MACRO_OUTLINE6P_HEADER, APER_MACRO_OUTLINE7P_HEADER, APER_MACRO_OUTLINE8P_HEADER, APER_MACRO_ROT_RECT_HEADER, APER_MACRO_ROUNDRECT_HEADER, APER_MACRO_SHAPE_OVAL_HEADER, finalFile, APER_MACRO_FREEPOLY_LIST::Format(), m_am_freepoly_list, m_gerberUnitInch, m_hasApertureChamferedRect, m_hasApertureOutline4P, m_hasApertureRotOval, m_hasApertureRotRect, m_hasApertureRoundRect, PLOTTER::m_IUsPerDecimil, PLOTTER::m_outputFile, PLOTTER::m_plotScale, m_workFilename, workFile, and writeApertureList().

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

◆ FilledCircle()

void GERBER_PLOTTER::FilledCircle ( const wxPoint &  pos,
int  diametre,
OUTLINE_MODE  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 1206 of file GERBER_plotter.cpp.

1208 {
1209  // A filled circle is a graphic item, not a pad.
1210  // So it is drawn, not flashed.
1211  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
1212 
1213  if( gbr_metadata )
1214  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1215 
1216  if( tracemode == FILLED )
1217  {
1218  // Draw a circle of diameter = diameter/2 with a line thickness = radius,
1219  // To create a filled circle
1220  SetCurrentLineWidth( diametre/2, gbr_metadata );
1221  Circle( pos, diametre/2, FILL_TYPE::NO_FILL, DO_NOT_SET_LINE_WIDTH );
1222  }
1223  else
1224  {
1226  Circle( pos, diametre, FILL_TYPE::NO_FILL, DO_NOT_SET_LINE_WIDTH );
1227  }
1228 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:125

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

◆ FinishTo()

◆ FlashPadChamferRoundRect()

void GERBER_PLOTTER::FlashPadChamferRoundRect ( const wxPoint &  aShapePos,
const wxSize &  aPadSize,
int  aCornerRadius,
double  aChamferRatio,
int  aChamferPositions,
double  aPadOrient,
OUTLINE_MODE  aPlotMode,
void *  aData 
)

Flash a chamfered round rect pad.

Parameters
aShapePosis the position of the pad shape.
aPadSizeis the size of the rectangle.
aCornerRadiusis the radius of rounded corners.
aChamferRatiois the chamfer value (ratio < 0.5 between smallest size and chamfer).
aChamferPositionsis the identifier of the corners to chamfer: 0 = no chamfer 1 = TOP_LEFT 2 = TOP_RIGHT 4 = BOTTOM_LEFT 8 = BOTTOM_RIGHT
aPadOrientis the rotation in 0.1 degrees of the shape.
aPlotModeis the drawing mode, FILLED or SKETCH.
aDatais the a reference to Gerber attributes descr.

Definition at line 1700 of file GERBER_plotter.cpp.

1705 {
1706  GBR_METADATA gbr_metadata;
1707 
1708  if( aData )
1709  gbr_metadata = *static_cast<GBR_METADATA*>( aData );
1710 
1711  DPOINT pos_dev = userToDeviceCoordinates( aShapePos );
1712 
1713  SHAPE_POLY_SET outline;
1714  // polygon corners list
1715  std::vector<wxPoint> cornerList;
1716 
1717  bool hasRoundedCorner = aCornerRadius != 0 && aChamferPositions != 15;
1718 
1719 #ifdef GBR_USE_MACROS_FOR_CHAMFERED_RECT
1720  // Sketch mode or round rect shape or Apert Macros disabled
1721  if( aPlotMode != FILLED || hasRoundedCorner || m_gerberDisableApertMacros )
1722 #endif
1723  {
1724  TransformRoundChamferedRectToPolygon( outline, aShapePos, aPadSize, aPadOrient,
1725  aCornerRadius, aChamferRatio, aChamferPositions,
1727 
1728  // Build the corner list
1729  const SHAPE_LINE_CHAIN& corners = outline.Outline(0);
1730 
1731  for( int ii = 0; ii < corners.PointCount(); ii++ )
1732  cornerList.emplace_back( corners.CPoint( ii ).x, corners.CPoint( ii ).y );
1733 
1734  // Close the polygon
1735  cornerList.push_back( cornerList[0] );
1736 
1737  if( aPlotMode == SKETCH )
1738  PlotPoly( cornerList, FILL_TYPE::NO_FILL, GetCurrentLineWidth(), &gbr_metadata );
1739  else
1740  {
1741 #ifdef GBR_USE_MACROS_FOR_CHAMFERED_ROUND_RECT
1743  {
1744  PlotGerberRegion( cornerList, &gbr_metadata );
1745  }
1746  else
1747  {
1748  // An AM will be created. the shape must be in position 0,0 and orientation 0
1749  // to be able to reuse the same AM for pads having the same shape
1750  for( size_t ii = 0; ii < cornerList.size(); ii++ )
1751  {
1752  cornerList[ii] -= aShapePos;
1753  RotatePoint( &cornerList[ii], -aPadOrient );
1754  }
1755 
1756  selectAperture( cornerList, aPadOrient/10.0,
1757  APERTURE::AM_FREE_POLYGON, gbr_metadata.GetApertureAttrib() );
1758  formatNetAttribute( &gbr_metadata.m_NetlistMetadata );
1759 
1760  emitDcode( pos_dev, 3 );
1761  }
1762 #else
1763  PlotGerberRegion( cornerList, &gbr_metadata );
1764 #endif
1765  }
1766 
1767  return;
1768  }
1769 
1770  // Build the chamfered polygon (4 to 8 corners )
1771  TransformRoundChamferedRectToPolygon( outline, wxPoint( 0, 0 ), aPadSize, 0.0, 0,
1772  aChamferRatio, aChamferPositions,
1774 
1775  // Build the corner list
1776  const SHAPE_LINE_CHAIN& corners = outline.Outline(0);
1777 
1778  // Generate the polygon (4 to 8 corners )
1779  for( int ii = 0; ii < corners.PointCount(); ii++ )
1780  cornerList.emplace_back( corners.CPoint( ii ).x, corners.CPoint( ii ).y );
1781 
1782  switch( cornerList.size() )
1783  {
1784  case 4:
1785  m_hasApertureOutline4P = true;
1786  selectAperture( cornerList, aPadOrient/10.0,
1788  break;
1789 
1790  case 5:
1792  selectAperture( cornerList, aPadOrient/10.0,
1794  break;
1795 
1796  case 6:
1798  selectAperture( cornerList, aPadOrient/10.0,
1800  break;
1801 
1802  case 7:
1804  selectAperture( cornerList, aPadOrient/10.0,
1806  break;
1807 
1808  case 8:
1810  selectAperture( cornerList, aPadOrient/10.0,
1812  break;
1813 
1814  default:
1815  wxLogMessage( "FlashPadChamferRoundRect(): Unexpected number of corners (%d)",
1816  (int)cornerList.size() );
1817  break;
1818  }
1819 
1820  formatNetAttribute( &gbr_metadata.m_NetlistMetadata );
1821 
1822  emitDcode( pos_dev, 3 );
1823 }
bool m_hasApertureChamferedRect
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aError, ERROR_LOC aErrorLoc)
convert a rectangle with rounded corners and/or chamfered corners to a polygon Convert rounded corner...
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
int PointCount() const
Function PointCount()
bool m_hasApertureOutline4P
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE 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.
const VECTOR2I & CPoint(int aIndex) const
Function Point()
Represent a set of closed polygons.
SHAPE_LINE_CHAIN & Outline(int aIndex)
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
SHAPE_LINE_CHAIN.
int GetPlotterArcHighDef() const
Definition: plotter.h:228
void PlotGerberRegion(const std::vector< wxPoint > &aCornerList, void *aData=nullptr)
Plot a Gerber region: similar to PlotPoly but plot only filled polygon, and add the TA....
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
bool m_gerberDisableApertMacros

References APERTURE::AM_FREE_POLYGON, APERTURE::APER_MACRO_OUTLINE4P, APERTURE::APER_MACRO_OUTLINE5P, APERTURE::APER_MACRO_OUTLINE6P, APERTURE::APER_MACRO_OUTLINE7P, APERTURE::APER_MACRO_OUTLINE8P, SHAPE_LINE_CHAIN::CPoint(), emitDcode(), ERROR_INSIDE, FILLED, formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), PLOTTER::GetPlotterArcHighDef(), m_gerberDisableApertMacros, m_hasApertureChamferedRect, m_hasApertureOutline4P, GBR_METADATA::m_NetlistMetadata, NO_FILL, SHAPE_POLY_SET::Outline(), PlotGerberRegion(), PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), RotatePoint(), selectAperture(), SKETCH, TransformRoundChamferedRectToPolygon(), PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadCircle()

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

Filled circular flashes are stored as apertures.

Implements PLOTTER.

Definition at line 1231 of file GERBER_plotter.cpp.

1232 {
1233  wxSize size( diametre, diametre );
1234  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1235 
1236  if( trace_mode == SKETCH )
1237  {
1238  if( gbr_metadata )
1239  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1240 
1242 
1244  }
1245  else
1246  {
1247  DPOINT pos_dev = userToDeviceCoordinates( pos );
1248 
1249  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1250  selectAperture( size, 0, 0.0, APERTURE::AT_CIRCLE, aperture_attrib );
1251 
1252  if( gbr_metadata )
1253  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1254 
1255  emitDcode( pos_dev, 3 );
1256  }
1257 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
int m_currentPenWidth
Definition: plotter.h:595
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:125

References APERTURE::AT_CIRCLE, Circle(), PLOTTER::DO_NOT_SET_LINE_WIDTH, emitDcode(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::m_currentPenWidth, 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,
double  aPadOrient,
SHAPE_POLY_SET aPolygons,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual
Parameters
aPadPosPosition of the shape.
aSizeis the size of round reference pad.
aPadOrientis the pad rotation, used only with aperture macros (Gerber plotter).
aPolygonsthe shape as polygon set.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 1632 of file GERBER_plotter.cpp.

1636 {
1637  // A Pad custom is plotted as polygon (a region in Gerber language).
1638  GBR_METADATA gbr_metadata;
1639 
1640  if( aData )
1641  gbr_metadata = *static_cast<GBR_METADATA*>( aData );
1642 
1643  SHAPE_POLY_SET polyshape = *aPolygons;
1644 
1645  if( aTraceMode != FILLED )
1646  {
1647  SetCurrentLineWidth( USE_DEFAULT_LINE_WIDTH, &gbr_metadata );
1648  polyshape.Inflate( -GetCurrentLineWidth()/2, 16 );
1649  }
1650 
1651  std::vector< wxPoint > cornerList;
1652 
1653  for( int cnt = 0; cnt < polyshape.OutlineCount(); ++cnt )
1654  {
1655  SHAPE_LINE_CHAIN& poly = polyshape.Outline( cnt );
1656 
1657  cornerList.clear();
1658 
1659  for( int ii = 0; ii < poly.PointCount(); ++ii )
1660  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
1661 
1662  // Close polygon
1663  cornerList.push_back( cornerList[0] );
1664 
1665  if( aTraceMode == SKETCH )
1666  {
1667  PlotPoly( cornerList, FILL_TYPE::NO_FILL, GetCurrentLineWidth(), &gbr_metadata );
1668  }
1669  else
1670  {
1671 #ifdef GBR_USE_MACROS_FOR_CUSTOM_PAD
1673  || cornerList.size() > GBR_MACRO_FOR_CUSTOM_PAD_MAX_CORNER_COUNT )
1674  PlotGerberRegion( cornerList, &gbr_metadata );
1675  else
1676  {
1677  // An AM will be created. the shape must be in position 0,0 and orientation 0
1678  // to be able to reuse the same AM for pads having the same shape
1679  for( size_t ii = 0; ii < cornerList.size(); ii++ )
1680  {
1681  cornerList[ii] -= aPadPos;
1682  RotatePoint( &cornerList[ii], -aOrient );
1683  }
1684 
1685  DPOINT pos_dev = userToDeviceCoordinates( aPadPos );
1686  selectAperture( cornerList, aOrient/10.0,
1687  APERTURE::AM_FREE_POLYGON, gbr_metadata.GetApertureAttrib() );
1688  formatNetAttribute( &gbr_metadata.m_NetlistMetadata );
1689 
1690  emitDcode( pos_dev, 3 );
1691  }
1692 #else
1693  PlotGerberRegion( cornerList, &gbr_metadata );
1694 #endif
1695  }
1696  }
1697 }
int OutlineCount() const
Return the number of vertices in a given outline/hole.
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
int PointCount() const
Function PointCount()
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE 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.
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
Represent a set of closed polygons.
SHAPE_LINE_CHAIN & Outline(int aIndex)
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
void Inflate(int aAmount, int aCircleSegCount, CORNER_STRATEGY aCornerStrategy=ROUND_ALL_CORNERS)
Perform outline inflation/deflation.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
SHAPE_LINE_CHAIN.
#define GBR_MACRO_FOR_CUSTOM_PAD_MAX_CORNER_COUNT
void PlotGerberRegion(const std::vector< wxPoint > &aCornerList, void *aData=nullptr)
Plot a Gerber region: similar to PlotPoly but plot only filled polygon, and add the TA....
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
bool m_gerberDisableApertMacros

References APERTURE::AM_FREE_POLYGON, SHAPE_LINE_CHAIN::CPoint(), emitDcode(), FILLED, formatNetAttribute(), GBR_MACRO_FOR_CUSTOM_PAD_MAX_CORNER_COUNT, GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), SHAPE_POLY_SET::Inflate(), m_gerberDisableApertMacros, GBR_METADATA::m_NetlistMetadata, NO_FILL, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PlotGerberRegion(), PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), RotatePoint(), selectAperture(), SetCurrentLineWidth(), SKETCH, PLOTTER::USE_DEFAULT_LINE_WIDTH, PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadOval()

void GERBER_PLOTTER::FlashPadOval ( const wxPoint &  aPadPos,
const wxSize &  aSize,
double  aPadOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual
Parameters
aPadPosPosition of the shape (center of the rectangle.
aSizeis the size of oblong shape.
aPadOrientThe rotation of the shape.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 1260 of file GERBER_plotter.cpp.

1262 {
1263  wxASSERT( m_outputFile );
1264  wxSize size( aSize );
1265  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1266 
1267  // Flash a vertical or horizontal shape (this is a basic aperture).
1268  if( ( orient == 0 || orient == 900 || orient == 1800 || orient == 2700 )
1269  && trace_mode == FILLED )
1270  {
1271  if( orient == 900 || orient == 2700 ) /* orientation turned 90 deg. */
1272  std::swap( size.x, size.y );
1273 
1274  DPOINT pos_dev = userToDeviceCoordinates( pos );
1275  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1276  selectAperture( size, 0, 0.0, APERTURE::AT_OVAL, aperture_attrib );
1277 
1278  if( gbr_metadata )
1279  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1280 
1281  emitDcode( pos_dev, 3 );
1282  }
1283  else // Plot pad as region.
1284  // Only regions and flashed items accept a object attribute TO.P for the pin name
1285  {
1286  if( trace_mode == FILLED )
1287  {
1288  #ifdef GBR_USE_MACROS_FOR_ROTATED_OVAL
1290  #endif
1291  {
1292  m_hasApertureRotOval = true;
1293  // We are using a aperture macro that expect size.y < size.x
1294  // i.e draw a horizontal line for rotation = 0.0
1295  // size.x = length, size.y = width
1296  if( size.x < size.y )
1297  {
1298  std::swap( size.x, size.y );
1299  orient += 900;
1300 
1301  if( orient > 1800 )
1302  orient -= 1800;
1303  }
1304 
1305  DPOINT pos_dev = userToDeviceCoordinates( pos );
1306  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1307  selectAperture( size, 0, orient/10.0, APERTURE::AM_ROTATED_OVAL, aperture_attrib );
1308 
1309  if( gbr_metadata )
1310  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1311 
1312  emitDcode( pos_dev, 3 );
1313  return;
1314  }
1315  // Draw the oval as round rect pad with a radius = 50% min size)
1316  // In gerber file, it will be drawn as a region with arcs, and can be
1317  // detected as pads (similar to a flashed pad)
1318  FlashPadRoundRect( pos, aSize, std::min( aSize.x, aSize.y ) / 2,
1319  orient, FILLED, aData );
1320  }
1321  else // Non filled shape: plot outlines:
1322  {
1323  if( size.x > size.y )
1324  {
1325  std::swap( size.x, size.y );
1326 
1327  if( orient < 2700 )
1328  orient += 900;
1329  else
1330  orient -= 2700;
1331  }
1332 
1333  sketchOval( pos, size, orient, -1 );
1334  }
1335  }
1336 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
FILE * m_outputFile
Output file.
Definition: plotter.h:590
virtual void FlashPadRoundRect(const wxPoint &aPadPos, const wxSize &aSize, int aCornerRadius, double aOrient, OUTLINE_MODE aTraceMode, void *aData) override
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
bool m_gerberDisableApertMacros
void sketchOval(const wxPoint &pos, const wxSize &size, double orient, int width)
Definition: plotter.cpp:465

References APERTURE::AM_ROTATED_OVAL, APERTURE::AT_OVAL, emitDcode(), FILLED, FlashPadRoundRect(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), m_gerberDisableApertMacros, m_hasApertureRotOval, GBR_METADATA::m_NetlistMetadata, PLOTTER::m_outputFile, selectAperture(), PLOTTER::sketchOval(), and PLOTTER::userToDeviceCoordinates().

Referenced by GERBER_WRITER::createDrillFile().

◆ FlashPadRect()

void GERBER_PLOTTER::FlashPadRect ( const wxPoint &  aPadPos,
const wxSize &  aSize,
double  aPadOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual
Parameters
aPadPosPosition of the shape (center of the rectangle).
aSizeis the size of rounded rect.
aPadOrientThe rotation of the shape.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 1339 of file GERBER_plotter.cpp.

1342 {
1343  wxASSERT( m_outputFile );
1344  wxSize size( aSize );
1345  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1346 
1347  // Plot as an aperture flash
1348  switch( int( orient ) )
1349  {
1350  case 900:
1351  case 2700: // rotation of 90 degrees or 270 swaps sizes
1352  std::swap( size.x, size.y );
1354 
1355  case 0:
1356  case 1800:
1357  if( trace_mode == SKETCH )
1358  {
1359  if( gbr_metadata )
1360  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1361 
1363  Rect( wxPoint( pos.x - (size.x - GetCurrentLineWidth()) / 2,
1364  pos.y - (size.y - GetCurrentLineWidth()) / 2 ),
1365  wxPoint( pos.x + (size.x - GetCurrentLineWidth()) / 2,
1366  pos.y + (size.y - GetCurrentLineWidth()) / 2 ),
1368  }
1369  else
1370  {
1371  DPOINT pos_dev = userToDeviceCoordinates( pos );
1372  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1373  selectAperture( size, 0, 0.0, APERTURE::AT_RECT, aperture_attrib );
1374 
1375  if( gbr_metadata )
1376  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1377 
1378  emitDcode( pos_dev, 3 );
1379  }
1380  break;
1381 
1382  default:
1383  #ifdef GBR_USE_MACROS_FOR_ROTATED_RECT
1384  if( trace_mode != SKETCH && !m_gerberDisableApertMacros )
1385  {
1386  m_hasApertureRotRect = true;
1387  DPOINT pos_dev = userToDeviceCoordinates( pos );
1388  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1389  selectAperture( size, 0, orient/10.0, APERTURE::AM_ROT_RECT, aperture_attrib );
1390 
1391  if( gbr_metadata )
1392  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1393 
1394  emitDcode( pos_dev, 3 );
1395 
1396  break;
1397  }
1398  #endif
1399  {
1400  // plot pad shape as Gerber region
1401  wxPoint coord[4];
1402  // coord[0] is assumed the lower left
1403  // coord[1] is assumed the upper left
1404  // coord[2] is assumed the upper right
1405  // coord[3] is assumed the lower right
1406 
1407  coord[0].x = -size.x/2; // lower left
1408  coord[0].y = size.y/2;
1409  coord[1].x = -size.x/2; // upper left
1410  coord[1].y = -size.y/2;
1411  coord[2].x = size.x/2; // upper right
1412  coord[2].y = -size.y/2;
1413  coord[3].x = size.x/2; // lower right
1414  coord[3].y = size.y/2;
1415 
1416  FlashPadTrapez( pos, coord, orient, trace_mode, aData );
1417  }
1418  break;
1419  }
1420 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
virtual void FlashPadTrapez(const wxPoint &aPadPos, const wxPoint *aCorners, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
Flash a trapezoidal pad.
FILE * m_outputFile
Output file.
Definition: plotter.h:590
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
bool m_gerberDisableApertMacros

References APERTURE::AM_ROT_RECT, APERTURE::AT_RECT, emitDcode(), FlashPadTrapez(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), KI_FALLTHROUGH, m_gerberDisableApertMacros, m_hasApertureRotRect, GBR_METADATA::m_NetlistMetadata, PLOTTER::m_outputFile, NO_FILL, Rect(), selectAperture(), SetCurrentLineWidth(), SKETCH, PLOTTER::USE_DEFAULT_LINE_WIDTH, and PLOTTER::userToDeviceCoordinates().

◆ FlashPadRoundRect()

void GERBER_PLOTTER::FlashPadRoundRect ( const wxPoint &  aPadPos,
const wxSize &  aSize,
int  aCornerRadius,
double  aOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual
Parameters
aPadPosPosition of the shape (center of the rectangle.
aSizeis the size of rounded rect.
aCornerRadiusRadius of the rounded corners.
aOrientThe rotation of the shape.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 1422 of file GERBER_plotter.cpp.

1426 {
1427  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1428 
1429  if( aTraceMode != FILLED )
1430  {
1431  SHAPE_POLY_SET outline;
1432  TransformRoundChamferedRectToPolygon( outline, aPadPos, aSize, aOrient, aCornerRadius,
1433  0.0, 0, GetPlotterArcHighDef(), ERROR_INSIDE );
1434 
1435  SetCurrentLineWidth( USE_DEFAULT_LINE_WIDTH, &gbr_metadata );
1436  outline.Inflate( -GetCurrentLineWidth()/2, 16 );
1437 
1438  std::vector< wxPoint > cornerList;
1439  // TransformRoundRectToPolygon creates only one convex polygon
1440  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
1441  cornerList.reserve( poly.PointCount() + 1 );
1442 
1443  for( int ii = 0; ii < poly.PointCount(); ++ii )
1444  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
1445 
1446  // Close polygon
1447  cornerList.push_back( cornerList[0] );
1448 
1449  // plot outlines
1450  PlotPoly( cornerList, FILL_TYPE::NO_FILL, GetCurrentLineWidth(), gbr_metadata );
1451  }
1452  else
1453  {
1454  #ifdef GBR_USE_MACROS_FOR_ROUNDRECT
1456  #endif
1457  {
1458  m_hasApertureRoundRect = true;
1459 
1460  DPOINT pos_dev = userToDeviceCoordinates( aPadPos );
1461  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1462  selectAperture( aSize, aCornerRadius, aOrient/10.0,
1463  APERTURE::AM_ROUND_RECT, aperture_attrib );
1464 
1465  if( gbr_metadata )
1466  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1467 
1468  emitDcode( pos_dev, 3 );
1469  return;
1470  }
1471 
1472  // A Pad RoundRect is plotted as a Gerber region.
1473  // Initialize region metadata:
1474  bool clearTA_AperFunction = false; // true if a TA.AperFunction is used
1475 
1476  if( gbr_metadata )
1477  {
1478  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1479  std::string attrib = gbr_metadata->m_ApertureMetadata.FormatAttribute( !m_useX2format );
1480 
1481  if( !attrib.empty() )
1482  {
1483  fputs( attrib.c_str(), m_outputFile );
1484  clearTA_AperFunction = true;
1485  }
1486  }
1487 
1488  // Plot the region using arcs in corners.
1489  plotRoundRectAsRegion( aPadPos, aSize, aCornerRadius, aOrient );
1490 
1491  // Clear the TA attribute, to avoid the next item to inherit it:
1492  if( clearTA_AperFunction )
1493  {
1494  if( m_useX2format )
1495  fputs( "%TD.AperFunction*%\n", m_outputFile );
1496  else
1497  fputs( "G04 #@! TD.AperFunction*\n", m_outputFile );
1498  }
1499  }
1500 }
void plotRoundRectAsRegion(const wxPoint &aRectCenter, const wxSize &aSize, int aCornerRadius, double aOrient)
Plot a round rect (a round rect shape in fact) as a Gerber region using lines and arcs for corners.
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
FILE * m_outputFile
Output file.
Definition: plotter.h:590
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aError, ERROR_LOC aErrorLoc)
convert a rectangle with rounded corners and/or chamfered corners to a polygon Convert rounded corner...
int PointCount() const
Function PointCount()
bool m_hasApertureRoundRect
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE 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.
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
Represent a set of closed polygons.
SHAPE_LINE_CHAIN & Outline(int aIndex)
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
void Inflate(int aAmount, int aCircleSegCount, CORNER_STRATEGY aCornerStrategy=ROUND_ALL_CORNERS)
Perform outline inflation/deflation.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment)
SHAPE_LINE_CHAIN.
int GetPlotterArcHighDef() const
Definition: plotter.h:228
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
bool m_gerberDisableApertMacros
GBR_APERTURE_METADATA m_ApertureMetadata
An item to handle aperture attribute.
Definition: gbr_metadata.h:257

References APERTURE::AM_ROUND_RECT, SHAPE_LINE_CHAIN::CPoint(), emitDcode(), ERROR_INSIDE, FILLED, GBR_APERTURE_METADATA::FormatAttribute(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), PLOTTER::GetPlotterArcHighDef(), SHAPE_POLY_SET::Inflate(), GBR_METADATA::m_ApertureMetadata, m_gerberDisableApertMacros, m_hasApertureRoundRect, GBR_METADATA::m_NetlistMetadata, PLOTTER::m_outputFile, m_useX2format, NO_FILL, SHAPE_POLY_SET::Outline(), PlotPoly(), plotRoundRectAsRegion(), SHAPE_LINE_CHAIN::PointCount(), selectAperture(), SetCurrentLineWidth(), TransformRoundChamferedRectToPolygon(), PLOTTER::USE_DEFAULT_LINE_WIDTH, PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by FlashPadOval().

◆ FlashPadTrapez()

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

Flash a trapezoidal pad.

Parameters
aPadPosis the the position of the shape.
aCornersis the list of 4 corners positions, relative to the shape position, pad orientation 0.
aPadOrientis the rotation of the shape.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 1826 of file GERBER_plotter.cpp.

1829 {
1830  // polygon corners list
1831  std::vector<wxPoint> cornerList = { aCorners[0], aCorners[1], aCorners[2], aCorners[3] };
1832 
1833  // Draw the polygon and fill the interior as required
1834  for( unsigned ii = 0; ii < 4; ii++ )
1835  {
1836  RotatePoint( &cornerList[ii], aPadOrient );
1837  cornerList[ii] += aPadPos;
1838  }
1839 
1840  // Close the polygon
1841  cornerList.push_back( cornerList[0] );
1842  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1843 
1844  GBR_METADATA metadata;
1845 
1846  if( gbr_metadata )
1847  metadata = *gbr_metadata;
1848 
1849  if( aTrace_Mode == SKETCH )
1850  {
1851  PlotPoly( cornerList, FILL_TYPE::NO_FILL, GetCurrentLineWidth(), &metadata );
1852  return;
1853  }
1854 
1855  // Plot a filled polygon:
1856  #ifdef GBR_USE_MACROS_FOR_TRAPEZOID
1858  #endif
1859  {
1860  m_hasApertureOutline4P = true;
1861  DPOINT pos_dev = userToDeviceCoordinates( aPadPos );
1862  // polygon corners list
1863  std::vector<wxPoint> corners = { aCorners[0], aCorners[1], aCorners[2], aCorners[3] };
1864  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1865  selectAperture( corners, aPadOrient/10.0, APERTURE::APER_MACRO_OUTLINE4P, aperture_attrib );
1866 
1867  if( gbr_metadata )
1868  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1869 
1870  emitDcode( pos_dev, 3 );
1871  return;
1872  }
1873 
1874  PlotGerberRegion( cornerList, &metadata );
1875 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
bool m_hasApertureOutline4P
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE 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.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
void PlotGerberRegion(const std::vector< wxPoint > &aCornerList, void *aData=nullptr)
Plot a Gerber region: similar to PlotPoly but plot only filled polygon, and add the TA....
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
bool m_gerberDisableApertMacros

References APERTURE::APER_MACRO_OUTLINE4P, emitDcode(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), m_gerberDisableApertMacros, m_hasApertureOutline4P, GBR_METADATA::m_NetlistMetadata, NO_FILL, PlotGerberRegion(), PlotPoly(), RotatePoint(), selectAperture(), SKETCH, and PLOTTER::userToDeviceCoordinates().

Referenced by FlashPadRect().

◆ FlashRegularPolygon()

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

Flash a regular polygon.

Useful 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 1878 of file GERBER_plotter.cpp.

1881 {
1882  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1883 
1884  GBR_METADATA metadata;
1885 
1886  if( gbr_metadata )
1887  metadata = *gbr_metadata;
1888 
1889  if( aTraceMode == SKETCH )
1890  {
1891  // Build the polygon:
1892  std::vector< wxPoint > cornerList;
1893 
1894  double angle_delta = 3600.0 / aCornerCount; // in 0.1 degree
1895 
1896  for( int ii = 0; ii < aCornerCount; ii++ )
1897  {
1898  double rot = aOrient + (angle_delta*ii);
1899  wxPoint vertice( aDiameter/2, 0 );
1900  RotatePoint( &vertice, rot );
1901  vertice += aShapePos;
1902  cornerList.push_back( vertice );
1903  }
1904 
1905  cornerList.push_back( cornerList[0] ); // Close the shape
1906 
1907  PlotPoly( cornerList, FILL_TYPE::NO_FILL, GetCurrentLineWidth(), &gbr_metadata );
1908  }
1909  else
1910  {
1911  DPOINT pos_dev = userToDeviceCoordinates( aShapePos );
1912 
1913  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
1914 
1915  APERTURE::APERTURE_TYPE apert_type =
1917  selectAperture( aDiameter, aOrient, apert_type, aperture_attrib );
1918 
1919  if( gbr_metadata )
1920  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1921 
1922  emitDcode( pos_dev, 3 );
1923  }
1924 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE 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.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262

References APERTURE::AT_REGULAR_POLY3, emitDcode(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), GBR_METADATA::m_NetlistMetadata, NO_FILL, PlotPoly(), RotatePoint(), selectAperture(), 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. The generated string depends on the type of netlist info.

Parameters
aDatacontains the data to format.

Definition at line 206 of file GERBER_plotter.cpp.

207 {
208  // print a Gerber net attribute record.
209  // it is added to the object attributes dictionary
210  // On file, only modified or new attributes are printed.
211  if( aData == nullptr )
212  return;
213 
214  if( !m_useNetAttributes )
215  return;
216 
217  bool useX1StructuredComment = !m_useX2format;
218 
219  bool clearDict;
220  std::string short_attribute_string;
221 
222  if( !FormatNetAttribute( short_attribute_string, m_objectAttributesDictionary,
223  aData, clearDict, useX1StructuredComment ) )
224  return;
225 
226  if( clearDict )
228 
229  if( !short_attribute_string.empty() )
230  fputs( short_attribute_string.c_str(), m_outputFile );
231 
232  if( m_useX2format && !aData->m_ExtraData.IsEmpty() )
233  {
234  std::string extra_data = TO_UTF8( aData->m_ExtraData );
235  fputs( extra_data.c_str(), m_outputFile );
236  }
237 }
void clearNetAttribute()
Clear a Gerber net attribute record (clear object attribute dictionary) and output the clear object a...
FILE * m_outputFile
Output file.
Definition: plotter.h:590
std::string m_objectAttributesDictionary
bool FormatNetAttribute(std::string &aPrintedText, std::string &aLastNetAttributes, const GBR_NETLIST_METADATA *aData, bool &aClearPreviousAttributes, bool aUseX1StructuredComment)
Generate the string to set a net attribute for a graphic object to print to a gerber file.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
wxString m_ExtraData
a string to print after TO object attributes, if not empty it is printed "as this"

References clearNetAttribute(), FormatNetAttribute(), GBR_NETLIST_METADATA::m_ExtraData, m_objectAttributesDictionary, PLOTTER::m_outputFile, m_useNetAttributes, m_useX2format, and TO_UTF8.

Referenced by FilledCircle(), FlashPadChamferRoundRect(), FlashPadCircle(), FlashPadCustom(), FlashPadOval(), FlashPadRect(), FlashPadRoundRect(), FlashPadTrapez(), 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:168
virtual DPOINT userToDeviceSize(const wxSize &size)
Modify 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:168
virtual DPOINT userToDeviceSize(const wxSize &size)
Modify 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 47 of file plotter_gerber.h.

48  {
49  return wxString( wxT( "gbr" ) );
50  }

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:168
#define DOT_MARK_LEN(aLineWidth)
virtual DPOINT userToDeviceSize(const wxSize &size)
Modify 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 225 of file plotter.h.

225 { return m_IUsPerDecimil; }
double m_IUsPerDecimil
Definition: plotter.h:579

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetOrCreateAperture() [1/2]

int GERBER_PLOTTER::GetOrCreateAperture ( const wxSize &  aSize,
int  aRadius,
double  aRotDegree,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
Parameters
aSizeis the size of tool.
aRadiusis the radius used for some shapes tool (oval, roundrect macros).
aRotDegreeis the rotation of tool (primitives round, oval rect accept only 0.0).
aTypeis the type ( shape ) of tool.
aApertureAttributeis an aperture attribute of the tool (a tool can have only one attribute) 0 = no specific attribute.
Returns
an 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.

Definition at line 418 of file GERBER_plotter.cpp.

420 {
421  int last_D_code = 9;
422 
423  // Search an existing aperture
424  for( int idx = 0; idx < (int)m_apertures.size(); ++idx )
425  {
426  APERTURE* tool = &m_apertures[idx];
427  last_D_code = tool->m_DCode;
428 
429  if( (tool->m_Type == aType) && (tool->m_Size == aSize) &&
430  (tool->m_Radius == aRadius) && (tool->m_Rotation == aRotDegree) &&
431  (tool->m_ApertureAttribute == aApertureAttribute) )
432  return idx;
433  }
434 
435  // Allocate a new aperture
436  APERTURE new_tool;
437  new_tool.m_Size = aSize;
438  new_tool.m_Type = aType;
439  new_tool.m_Radius = aRadius;
440  new_tool.m_Rotation = aRotDegree;
441  new_tool.m_DCode = last_D_code + 1;
442  new_tool.m_ApertureAttribute = aApertureAttribute;
443 
444  m_apertures.push_back( new_tool );
445 
446  return m_apertures.size() - 1;
447 }
APERTURE_TYPE m_Type
std::vector< APERTURE > m_apertures

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

Referenced by selectAperture().

◆ GetOrCreateAperture() [2/2]

int GERBER_PLOTTER::GetOrCreateAperture ( const std::vector< wxPoint > &  aCorners,
double  aRotDegree,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
Parameters
aCornersis the corner list.
aRotDegreeis the rotation of tool.
aTypeis the type ( shape ) of tool that can manage a list of corners (polygon).
aApertureAttributeis an aperture attribute of the tool (a tool can have only one attribute) 0 = no specific attribute.
Returns
an index to the aperture in aperture list which meets the data and type of tool if the aperture does not exist, it is created and entered in aperture list.

Definition at line 450 of file GERBER_plotter.cpp.

452 {
453  int last_D_code = 9;
454 
455  // For APERTURE::AM_FREE_POLYGON aperture macros, we need to create the macro
456  // on the fly, because due to the fact the vertex count is not a constant we
457  // cannot create a static definition.
458  if( APERTURE::AM_FREE_POLYGON == aType )
459  {
460  int idx = m_am_freepoly_list.FindAm( aCorners );
461 
462  if( idx < 0 )
463  m_am_freepoly_list.Append( aCorners );
464  }
465 
466  // Search an existing aperture
467  for( int idx = 0; idx < (int)m_apertures.size(); ++idx )
468  {
469  APERTURE* tool = &m_apertures[idx];
470 
471  last_D_code = tool->m_DCode;
472 
473  if( (tool->m_Type == aType) &&
474  (tool->m_Corners.size() == aCorners.size() ) &&
475  (tool->m_Rotation == aRotDegree) &&
476  (tool->m_ApertureAttribute == aApertureAttribute) )
477  {
478  // A candidate is found. the corner lists must be similar
479  bool is_same = polyCompare( tool->m_Corners, aCorners );
480 
481  if( is_same )
482  return idx;
483  }
484  }
485 
486  // Allocate a new aperture
487  APERTURE new_tool;
488 
489  new_tool.m_Corners = aCorners;
490  new_tool.m_Size = wxSize( 0, 0 ); // Not used
491  new_tool.m_Type = aType;
492  new_tool.m_Radius = 0; // Not used
493  new_tool.m_Rotation = aRotDegree;
494  new_tool.m_DCode = last_D_code + 1;
495  new_tool.m_ApertureAttribute = aApertureAttribute;
496 
497  m_apertures.push_back( new_tool );
498 
499  return m_apertures.size() - 1;
500 }
APERTURE_TYPE m_Type
static bool polyCompare(const std::vector< wxPoint > &aPolygon, const std::vector< wxPoint > &aTestPolygon)
APER_MACRO_FREEPOLY_LIST m_am_freepoly_list
void Append(const std::vector< wxPoint > &aPolygon)
append a new APER_MACRO_FREEPOLY containing the polygon aPolygon to the current list
std::vector< APERTURE > m_apertures
std::vector< wxPoint > m_Corners
int FindAm(const std::vector< wxPoint > &aPolygon) const

References APERTURE::AM_FREE_POLYGON, APER_MACRO_FREEPOLY_LIST::Append(), APER_MACRO_FREEPOLY_LIST::FindAm(), m_am_freepoly_list, APERTURE::m_ApertureAttribute, m_apertures, APERTURE::m_Corners, APERTURE::m_DCode, APERTURE::m_Radius, APERTURE::m_Rotation, APERTURE::m_Size, APERTURE::m_Type, and polyCompare().

◆ GetPlotterArcHighDef()

int PLOTTER::GetPlotterArcHighDef ( ) const
inlineinherited

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 227 of file plotter.h.

227 { return m_IUsPerDecimil * 8; }
double m_IUsPerDecimil
Definition: plotter.h:579

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 42 of file plotter_gerber.h.

43  {
44  return PLOT_FORMAT::GERBER;
45  }

References GERBER.

◆ LineTo()

void PLOTTER::LineTo ( const wxPoint &  pos)
inlineinherited

Definition at line 268 of file plotter.h.

269  {
270  PenTo( pos, 'D' );
271  }
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(), plotArc(), PlotPoly(), HPGL_PLOTTER::PlotPoly(), DXF_PLOTTER::PlotPoly(), plotRoundRectAsRegion(), 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.

Parameters
aPositionis the position of the marker.
aDiameteris the diameter of the marker.
aShapeIdis the index (used to generate forms characters).

Definition at line 338 of file plotter.cpp.

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

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 324 of file plotter.cpp.

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

References PLOTTER::FinishTo(), and PLOTTER::MoveTo().

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 280 of file plotter.cpp.

281 {
282  Circle( position, radius * 2, FILL_TYPE::NO_FILL, GetCurrentLineWidth() );
283 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE 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 310 of file plotter.cpp.

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

References PLOTTER::FinishTo(), and PLOTTER::MoveTo().

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 286 of file plotter.cpp.

287 {
288  std::vector< wxPoint > corner_list;
289  wxPoint corner;
290  corner.x = position.x;
291  corner.y = position.y + radius;
292  corner_list.push_back( corner );
293  corner.x = position.x + radius;
294  corner.y = position.y,
295  corner_list.push_back( corner );
296  corner.x = position.x;
297  corner.y = position.y - radius;
298  corner_list.push_back( corner );
299  corner.x = position.x - radius;
300  corner.y = position.y;
301  corner_list.push_back( corner );
302  corner.x = position.x;
303  corner.y = position.y + radius;
304  corner_list.push_back( corner );
305 
307 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168

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

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 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:273
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263

References PLOTTER::FinishTo(), and PLOTTER::MoveTo().

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 255 of file plotter.cpp.

256 {
257  double r = KiROUND( radius / 1.4142 );
258  std::vector< wxPoint > corner_list;
259  wxPoint corner;
260  corner.x = position.x + r;
261  corner.y = position.y + r;
262  corner_list.push_back( corner );
263  corner.x = position.x + r;
264  corner.y = position.y - r;
265  corner_list.push_back( corner );
266  corner.x = position.x - r;
267  corner.y = position.y - r;
268  corner_list.push_back( corner );
269  corner.x = position.x - r;
270  corner.y = position.y + r;
271  corner_list.push_back( corner );
272  corner.x = position.x + r;
273  corner.y = position.y + r;
274  corner_list.push_back( corner );
275 
277 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
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:70

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

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 331 of file plotter.cpp.

332 {
333  MoveTo( wxPoint( pos.x, pos.y - radius ) );
334  FinishTo( wxPoint( pos.x, pos.y + radius ) );
335 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263

References PLOTTER::FinishTo(), and PLOTTER::MoveTo().

Referenced by PLOTTER::Marker().

◆ MoveTo()

◆ OpenFile()

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

Open or create the plot file aFullFilename.

Parameters
aFullFilenameis 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 76 of file plotter.cpp.

77 {
78  m_filename = aFullFilename;
79 
80  wxASSERT( !m_outputFile );
81 
82  // Open the file in text mode (not suitable for all plotters
83  // but only for most of them
84  m_outputFile = wxFopen( m_filename, wxT( "wt" ) );
85 
86  if( m_outputFile == NULL )
87  return false ;
88 
89  return true;
90 }
wxString m_filename
Definition: plotter.h:600
FILE * m_outputFile
Output file.
Definition: plotter.h:590
#define NULL

References PLOTTER::m_filename, PLOTTER::m_outputFile, and NULL.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), GENDRILL_WRITER_BASE::genDrillMapFile(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDxf(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), StartPlotBoard(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ PageSettings()

PAGE_INFO& PLOTTER::PageSettings ( )
inlineinherited

◆ PenFinish()

void PLOTTER::PenFinish ( )
inlineinherited

Definition at line 279 of file plotter.h.

280  {
281  // The point is not important with Z motion
282  PenTo( wxPoint( 0, 0 ), 'Z' );
283  }
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::Circle(), HPGL_PLOTTER::FlashPadCircle(), PlotPoly(), HPGL_PLOTTER::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 777 of file GERBER_plotter.cpp.

778 {
779  wxASSERT( m_outputFile );
780  DPOINT pos_dev = userToDeviceCoordinates( aPos );
781 
782  switch( plume )
783  {
784  case 'Z':
785  break;
786 
787  case 'U':
788  emitDcode( pos_dev, 2 );
789  break;
790 
791  case 'D':
792  emitDcode( pos_dev, 1 );
793  }
794 
795  m_penState = plume;
796 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
char m_penState
Definition: plotter.h:596

References emitDcode(), PLOTTER::m_outputFile, PLOTTER::m_penState, and PLOTTER::userToDeviceCoordinates().

◆ plotArc() [1/2]

void GERBER_PLOTTER::plotArc ( const wxPoint &  aCenter,
double  aStAngle,
double  aEndAngle,
int  aRadius,
bool  aPlotInRegion 
)
protected

Plot a Gerber arc.

If aPlotInRegion = true, the current pen position will not be initialized to the arc start position, and therefore the arc can be used to define a region outline item a line will be created from current position to arc start point. If aPlotInRegion = false, the current pen position will be initialized to the arc start position, to plot an usual arc item. The line thickness is not initialized in plotArc, and must be initialized before calling it if needed.

Definition at line 872 of file GERBER_plotter.cpp.

874 {
875  wxPoint start, end;
876  start.x = aCenter.x + KiROUND( cosdecideg( aRadius, aStAngle ) );
877  start.y = aCenter.y - KiROUND( sindecideg( aRadius, aStAngle ) );
878 
879  if( !aPlotInRegion )
880  MoveTo( start );
881  else
882  LineTo( start );
883 
884  end.x = aCenter.x + KiROUND( cosdecideg( aRadius, aEndAngle ) );
885  end.y = aCenter.y - KiROUND( sindecideg( aRadius, aEndAngle ) );
886  DPOINT devEnd = userToDeviceCoordinates( end );
887  DPOINT devCenter = userToDeviceCoordinates( aCenter ) - userToDeviceCoordinates( start );
888 
889  fprintf( m_outputFile, "G75*\n" ); // Multiquadrant (360 degrees) mode
890 
891  if( aStAngle < aEndAngle )
892  fprintf( m_outputFile, "G03*\n" ); // Active circular interpolation, CCW
893  else
894  fprintf( m_outputFile, "G02*\n" ); // Active circular interpolation, CW
895 
896  fprintf( m_outputFile, "X%dY%dI%dJ%dD01*\n",
897  KiROUND( devEnd.x ), KiROUND( devEnd.y ),
898  KiROUND( devCenter.x ), KiROUND( devCenter.y ) );
899 
900  fprintf( m_outputFile, "G01*\n" ); // Back to linear interpolate (perhaps useless here).
901 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
void LineTo(const wxPoint &pos)
Definition: plotter.h:268
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
double cosdecideg(double r, double a)
Circle generation utility: computes r * cos(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:439
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:430
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:70

References cosdecideg(), KiROUND(), PLOTTER::LineTo(), PLOTTER::m_outputFile, PLOTTER::MoveTo(), sindecideg(), PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Arc(), PlotPoly(), and plotRoundRectAsRegion().

◆ plotArc() [2/2]

void GERBER_PLOTTER::plotArc ( const SHAPE_ARC aArc,
bool  aPlotInRegion 
)
protected

Definition at line 843 of file GERBER_plotter.cpp.

844 {
845  wxPoint start( aArc.GetP0() );
846  wxPoint end( aArc.GetP1() );
847  wxPoint center( aArc.GetCenter() );
848  double start_angle = aArc.GetStartAngle();
849  double end_angle = aArc.GetEndAngle();
850 
851  if( !aPlotInRegion )
852  MoveTo( start);
853  else
854  LineTo( start );
855 
856  DPOINT devEnd = userToDeviceCoordinates( end );
857  DPOINT devCenter = userToDeviceCoordinates( center ) - userToDeviceCoordinates( start );
858 
859  if( start_angle < end_angle )
860  fprintf( m_outputFile, "G03*\n" ); // Active circular interpolation, CCW
861  else
862  fprintf( m_outputFile, "G02*\n" ); // Active circular interpolation, CW
863 
864  fprintf( m_outputFile, "X%dY%dI%dJ%dD01*\n",
865  KiROUND( devEnd.x ), KiROUND( devEnd.y ),
866  KiROUND( devCenter.x ), KiROUND( devCenter.y ) );
867 
868  fprintf( m_outputFile, "G01*\n" ); // Back to linear interpolate (perhaps useless here).
869 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
double GetStartAngle() const
Definition: shape_arc.cpp:363
void LineTo(const wxPoint &pos)
Definition: plotter.h:268
const VECTOR2I & GetP0() const
Definition: shape_arc.h:95
double GetEndAngle() const
Definition: shape_arc.cpp:373
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
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:70
const VECTOR2I & GetP1() const
Definition: shape_arc.h:96
VECTOR2I GetCenter() const
Definition: shape_arc.cpp:383

References SHAPE_ARC::GetCenter(), SHAPE_ARC::GetEndAngle(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), SHAPE_ARC::GetStartAngle(), KiROUND(), PLOTTER::LineTo(), PLOTTER::m_outputFile, PLOTTER::MoveTo(), PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ PlotGerberRegion() [1/2]

void GERBER_PLOTTER::PlotGerberRegion ( const std::vector< wxPoint > &  aCornerList,
void *  aData = nullptr 
)

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 941 of file GERBER_plotter.cpp.

942 {
943  if( aCornerList.size() <= 2 )
944  return;
945 
946  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
947 
948  bool clearTA_AperFunction = false; // true if a TA.AperFunction is used
949 
950  if( gbr_metadata )
951  {
952  std::string attrib = gbr_metadata->m_ApertureMetadata.FormatAttribute( !m_useX2format );
953 
954  if( !attrib.empty() )
955  {
956  fputs( attrib.c_str(), m_outputFile );
957  clearTA_AperFunction = true;
958  }
959  }
960 
961  PlotPoly( aCornerList, FILL_TYPE::FILLED_SHAPE, 0, gbr_metadata );
962 
963  // Clear the TA attribute, to avoid the next item to inherit it:
964  if( clearTA_AperFunction )
965  {
966  if( m_useX2format )
967  {
968  fputs( "%TD.AperFunction*%\n", m_outputFile );
969  }
970  else
971  {
972  fputs( "G04 #@! TD.AperFunction*\n", m_outputFile );
973  }
974  }
975 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE 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.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment)
GBR_APERTURE_METADATA m_ApertureMetadata
An item to handle aperture attribute.
Definition: gbr_metadata.h:257

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

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

◆ PlotGerberRegion() [2/2]

void GERBER_PLOTTER::PlotGerberRegion ( const SHAPE_LINE_CHAIN aPoly,
void *  aData = nullptr 
)

Definition at line 904 of file GERBER_plotter.cpp.

905 {
906  if( aPoly.PointCount() <= 2 )
907  return;
908 
909  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
910 
911  bool clearTA_AperFunction = false; // true if a TA.AperFunction is used
912 
913  if( gbr_metadata )
914  {
915  std::string attrib = gbr_metadata->m_ApertureMetadata.FormatAttribute( !m_useX2format );
916 
917  if( !attrib.empty() )
918  {
919  fputs( attrib.c_str(), m_outputFile );
920  clearTA_AperFunction = true;
921  }
922  }
923 
924  PlotPoly( aPoly, FILL_TYPE::FILLED_SHAPE, 0 , gbr_metadata );
925 
926  // Clear the TA attribute, to avoid the next item to inherit it:
927  if( clearTA_AperFunction )
928  {
929  if( m_useX2format )
930  {
931  fputs( "%TD.AperFunction*%\n", m_outputFile );
932  }
933  else
934  {
935  fputs( "G04 #@! TD.AperFunction*\n", m_outputFile );
936  }
937  }
938 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
int PointCount() const
Function PointCount()
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE 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.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment)
GBR_APERTURE_METADATA m_ApertureMetadata
An item to handle aperture attribute.
Definition: gbr_metadata.h:257

References FILLED_SHAPE, GBR_APERTURE_METADATA::FormatAttribute(), GBR_METADATA::m_ApertureMetadata, PLOTTER::m_outputFile, m_useX2format, PlotPoly(), and SHAPE_LINE_CHAIN::PointCount().

◆ PlotImage()

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

Only PostScript plotters can plot bitmaps.

A rectangle is plotted for plotters that cannot plot a bitmap.

Parameters
aImageis the bitmap.
aPosis position of the center of the bitmap.
aScaleFactoris 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 238 of file plotter.cpp.

239 {
240  wxSize size( aImage.GetWidth() * aScaleFactor,
241  aImage.GetHeight() * aScaleFactor );
242 
243  wxPoint start = aPos;
244  start.x -= size.x / 2;
245  start.y -= size.y / 2;
246 
247  wxPoint end = start;
248  end.x += size.x;
249  end.y += size.y;
250 
251  Rect( start, end, FILL_TYPE::NO_FILL );
252 }
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH)=0

References NO_FILL, and PLOTTER::Rect().

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

◆ PlotPoly() [1/2]

void GERBER_PLOTTER::PlotPoly ( const std::vector< wxPoint > &  aCornerList,
FILL_TYPE  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 1056 of file GERBER_plotter.cpp.

1058 {
1059  if( aCornerList.size() <= 1 )
1060  return;
1061 
1062  // Gerber format does not know filled polygons with thick outline
1063  // Therefore, to plot a filled polygon with outline having a thickness,
1064  // one should plot outline as thick segments
1065  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1066 
1067  if( gbr_metadata )
1068  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1069 
1070  if( aFill != FILL_TYPE::NO_FILL )
1071  {
1072  fputs( "G36*\n", m_outputFile );
1073 
1074  MoveTo( aCornerList[0] );
1075  fputs( "G01*\n", m_outputFile ); // Set linear interpolation.
1076 
1077  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
1078  LineTo( aCornerList[ii] );
1079 
1080  // If the polygon is not closed, close it:
1081  if( aCornerList[0] != aCornerList[aCornerList.size()-1] )
1082  FinishTo( aCornerList[0] );
1083 
1084  fputs( "G37*\n", m_outputFile );
1085  }
1086 
1087  if( aWidth > 0 ) // Draw the polyline/polygon outline
1088  {
1089  SetCurrentLineWidth( aWidth, gbr_metadata );
1090 
1091  MoveTo( aCornerList[0] );
1092 
1093  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
1094  LineTo( aCornerList[ii] );
1095 
1096  // Ensure the thick outline is closed for filled polygons
1097  // (if not filled, could be only a polyline)
1098  if( aFill != FILL_TYPE::NO_FILL &&( aCornerList[aCornerList.size() - 1] != aCornerList[0] ) )
1099  LineTo( aCornerList[0] );
1100 
1101  PenFinish();
1102  }
1103 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void PenFinish()
Definition: plotter.h:279
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
FILE * m_outputFile
Output file.
Definition: plotter.h:590
void LineTo(const wxPoint &pos)
Definition: plotter.h:268
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262

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

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

◆ PlotPoly() [2/2]

void GERBER_PLOTTER::PlotPoly ( const SHAPE_LINE_CHAIN aCornerList,
FILL_TYPE  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = nullptr 
)
overridevirtual

Draw a polygon ( filled or not ).

Parameters
aCornerListis the corners list (a SHAPE_LINE_CHAIN). must be closed (IsClosed() == true) for a polygon. Otherwise this is a polyline.
aFillis the type of fill.
aWidthis the line width.
aDatais an auxiliary info (mainly for gerber format).

Plain point

Plain point

Reimplemented from PLOTTER.

Definition at line 978 of file GERBER_plotter.cpp.

980 {
981  if( aPoly.CPoints().size() <= 1 )
982  return;
983 
984  // Gerber format does not know filled polygons with thick outline
985  // Therefore, to plot a filled polygon with outline having a thickness,
986  // one should plot outline as thick segments
987  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
988 
989  if( gbr_metadata )
990  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
991 
992  if( aFill != FILL_TYPE::NO_FILL )
993  {
994  fputs( "G36*\n", m_outputFile );
995 
996  MoveTo( wxPoint( aPoly.CPoint( 0 ) ) );
997 
998  fputs( "G01*\n", m_outputFile ); // Set linear interpolation.
999 
1000  for( int ii = 1; ii < aPoly.PointCount(); ii++ )
1001  {
1002  int arcindex = aPoly.ArcIndex( ii );
1003 
1004  if( arcindex < 0 )
1005  {
1007  LineTo( wxPoint( aPoly.CPoint( ii ) ) );
1008  }
1009  else
1010  {
1011  const SHAPE_ARC& arc = aPoly.Arc( arcindex );
1012 
1013  plotArc( arc, ii > 0 );
1014  }
1015  }
1016 
1017  // If the polygon is not closed, close it:
1018  if( aPoly.CPoint( 0 ) != aPoly.CPoint( -1 ) )
1019  FinishTo( wxPoint( aPoly.CPoint( 0 ) ) );
1020 
1021  fputs( "G37*\n", m_outputFile );
1022  }
1023 
1024  if( aWidth > 0 ) // Draw the polyline/polygon outline
1025  {
1026  SetCurrentLineWidth( aWidth, gbr_metadata );
1027 
1028  MoveTo( wxPoint( aPoly.CPoint( 0 ) ) );
1029 
1030  for( int ii = 1; ii < aPoly.PointCount(); ii++ )
1031  {
1032  int arcindex = aPoly.ArcIndex( ii );
1033 
1034  if( arcindex < 0 )
1035  {
1037  LineTo( wxPoint( aPoly.CPoint( ii ) ) );
1038  }
1039  else
1040  {
1041  const SHAPE_ARC& arc = aPoly.Arc( arcindex );
1042 
1043  plotArc( arc, ii > 0 );
1044  }
1045  }
1046 
1047  // Ensure the thick outline is closed for filled polygons
1048  // (if not filled, could be only a polyline)
1049  if( aFill != FILL_TYPE::NO_FILL && ( aPoly.CPoint( 0 ) != aPoly.CPoint( -1 ) ) )
1050  LineTo( wxPoint( aPoly.CPoint( 0 ) ) );
1051 
1052  PenFinish();
1053  }
1054 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void PenFinish()
Definition: plotter.h:279
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
FILE * m_outputFile
Output file.
Definition: plotter.h:590
void plotArc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, bool aPlotInRegion)
Plot a Gerber arc.
void LineTo(const wxPoint &pos)
Definition: plotter.h:268
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262

References SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::CPoints(), PLOTTER::FinishTo(), formatNetAttribute(), PLOTTER::LineTo(), GBR_METADATA::m_NetlistMetadata, PLOTTER::m_outputFile, PLOTTER::MoveTo(), NO_FILL, PLOTTER::PenFinish(), plotArc(), SHAPE_LINE_CHAIN::PointCount(), and SetCurrentLineWidth().

◆ plotRoundRectAsRegion()

void GERBER_PLOTTER::plotRoundRectAsRegion ( const wxPoint &  aRectCenter,
const wxSize &  aSize,
int  aCornerRadius,
double  aOrient 
)
protected

Plot a round rect (a round rect shape in fact) as a Gerber region using lines and arcs for corners.

Note
Only the G36 ... G37 region is created.
Parameters
aRectCenteris the center of the rectangle.
aSizeis the size of the rectangle.
aCornerRadiusis the radius of the corners.
aOrientis the rotation of the rectangle.

Definition at line 1503 of file GERBER_plotter.cpp.

1505 {
1506  // The region outline is generated by 4 sides and 4 90 deg arcs
1507  // 1 --- 2
1508  // | c |
1509  // 4 --- 3
1510 
1511  // Note also in user coordinates the Y axis is from top to bottom
1512  // for historical reasons.
1513 
1514  // A helper structure to handle outlines coordinates (segments and arcs)
1515  // in user coordinates
1516  struct RR_EDGE
1517  {
1518  wxPoint m_start;
1519  wxPoint m_end;
1520  wxPoint m_center;
1521  // in decidegrees: angle start. angle end = m_arc_angle_start+arc_angle
1522  double m_arc_angle_start;
1523  };
1524 
1525  const double arc_angle = -900.0; // in decidegrees
1526  int hsizeX = aSize.x/2;
1527  int hsizeY = aSize.y/2;
1528 
1529  RR_EDGE curr_edge;
1530  std::vector<RR_EDGE> rr_outline;
1531 
1532  // Build outline coordinates, relative to rectangle center, rotation 0:
1533 
1534  // Top left corner 1 (and 4 to 1 left vertical side @ x=-hsizeX)
1535  curr_edge.m_start.x = -hsizeX;
1536  curr_edge.m_start.y = hsizeY - aCornerRadius;
1537  curr_edge.m_end.x = curr_edge.m_start.x;
1538  curr_edge.m_end.y = -hsizeY + aCornerRadius;
1539  curr_edge.m_center.x = -hsizeX + aCornerRadius;
1540  curr_edge.m_center.y = curr_edge.m_end.y;
1541  curr_edge.m_arc_angle_start = aOrient + 1800.0; // En decidegree
1542 
1543  rr_outline.push_back( curr_edge );
1544 
1545  // Top right corner 2 (and 1 to 2 top horizontal side @ y=-hsizeY)
1546  curr_edge.m_start.x = -hsizeX + aCornerRadius;
1547  curr_edge.m_start.y = -hsizeY;
1548  curr_edge.m_end.x = hsizeX - aCornerRadius;
1549  curr_edge.m_end.y = curr_edge.m_start.y;
1550  curr_edge.m_center.x = curr_edge.m_end.x;
1551  curr_edge.m_center.y = -hsizeY + aCornerRadius;
1552  curr_edge.m_arc_angle_start = aOrient + 900.0; // En decidegree
1553 
1554  rr_outline.push_back( curr_edge );
1555 
1556  // bottom right corner 3 (and 2 to 3 right vertical side @ x=hsizeX)
1557  curr_edge.m_start.x = hsizeX;
1558  curr_edge.m_start.y = -hsizeY + aCornerRadius;
1559  curr_edge.m_end.x = curr_edge.m_start.x;
1560  curr_edge.m_end.y = hsizeY - aCornerRadius;
1561  curr_edge.m_center.x = hsizeX - aCornerRadius;
1562  curr_edge.m_center.y = curr_edge.m_end.y;
1563  curr_edge.m_arc_angle_start = aOrient + 0.0; // En decidegree
1564 
1565  rr_outline.push_back( curr_edge );
1566 
1567  // bottom left corner 4 (and 3 to 4 bottom horizontal side @ y=hsizeY)
1568  curr_edge.m_start.x = hsizeX - aCornerRadius;
1569  curr_edge.m_start.y = hsizeY;
1570  curr_edge.m_end.x = -hsizeX + aCornerRadius;
1571  curr_edge.m_end.y = curr_edge.m_start.y;
1572  curr_edge.m_center.x = curr_edge.m_end.x;
1573  curr_edge.m_center.y = hsizeY - aCornerRadius;
1574  curr_edge.m_arc_angle_start = aOrient - 900.0; // En decidegree
1575 
1576  rr_outline.push_back( curr_edge );
1577 
1578  // Move relative coordinates to the actual location and rotation:
1579  wxPoint arc_last_center;
1580  int arc_last_angle = curr_edge.m_arc_angle_start+arc_angle;
1581 
1582  for( RR_EDGE& rr_edge: rr_outline )
1583  {
1584  RotatePoint( &rr_edge.m_start, aOrient );
1585  RotatePoint( &rr_edge.m_end, aOrient );
1586  RotatePoint( &rr_edge.m_center, aOrient );
1587  rr_edge.m_start += aRectCenter;
1588  rr_edge.m_end += aRectCenter;
1589  rr_edge.m_center += aRectCenter;
1590  arc_last_center = rr_edge.m_center;
1591  }
1592 
1593  // Ensure the region is a closed polygon, i.e. the end point of last segment
1594  // (end of arc) is the same as the first point. Rounding issues can create a
1595  // small difference, mainly for rotated pads.
1596  // calculate last point (end of last arc):
1597  wxPoint last_pt;
1598  last_pt.x = arc_last_center.x + KiROUND( cosdecideg( aCornerRadius, arc_last_angle ) );
1599  last_pt.y = arc_last_center.y - KiROUND( sindecideg( aCornerRadius, arc_last_angle ) );
1600 
1601  wxPoint first_pt = rr_outline[0].m_start;
1602 
1603 #if 0 // For test only:
1604  if( last_pt != first_pt )
1605  wxLogMessage( "first pt %d %d last pt %d %d",
1606  first_pt.x, first_pt.y, last_pt.x, last_pt.y );
1607 #endif
1608 
1609  fputs( "G36*\n", m_outputFile ); // Start region
1610  fputs( "G01*\n", m_outputFile ); // Set linear interpolation.
1611  first_pt = last_pt;
1612  MoveTo( first_pt ); // Start point of region, must be same as end point
1613 
1614  for( RR_EDGE& rr_edge: rr_outline )
1615  {
1616  if( aCornerRadius ) // Guard: ensure we do not create arcs with radius = 0
1617  {
1618  // LineTo( rr_edge.m_end ); // made in plotArc()
1619  plotArc( rr_edge.m_center, rr_edge.m_arc_angle_start,
1620  rr_edge.m_arc_angle_start+arc_angle, aCornerRadius, true );
1621  }
1622  else
1623  {
1624  LineTo( rr_edge.m_end );
1625  }
1626  }
1627 
1628  fputs( "G37*\n", m_outputFile ); // Close region
1629 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
void plotArc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, bool aPlotInRegion)
Plot a Gerber arc.
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
void LineTo(const wxPoint &pos)
Definition: plotter.h:268
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
double cosdecideg(double r, double a)
Circle generation utility: computes r * cos(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:439
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:430
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:70

References cosdecideg(), KiROUND(), PLOTTER::LineTo(), PLOTTER::m_outputFile, PLOTTER::MoveTo(), plotArc(), RotatePoint(), and sindecideg().

Referenced by FlashPadRoundRect().

◆ Rect()

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

Implements PLOTTER.

Definition at line 799 of file GERBER_plotter.cpp.

800 {
801  std::vector< wxPoint > cornerList;
802 
803  // Build corners list
804  cornerList.push_back( p1 );
805  wxPoint corner(p1.x, p2.y);
806  cornerList.push_back( corner );
807  cornerList.push_back( p2 );
808  corner.x = p2.x;
809  corner.y = p1.y;
810  cornerList.push_back( corner );
811  cornerList.push_back( p1 );
812 
813  PlotPoly( cornerList, fill, width );
814 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE 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().

Referenced by FlashPadRect(), and ThickRect().

◆ RenderSettings()

◆ segmentAsOval()

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

Convert a thick segment and plot it as an oval.

Definition at line 444 of file plotter.cpp.

446 {
447  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
448  wxSize size( end.x - start.x, end.y - start.y );
449  double orient;
450 
451  if( size.y == 0 )
452  orient = 0;
453  else if( size.x == 0 )
454  orient = 900;
455  else
456  orient = -ArcTangente( size.y, size.x );
457 
458  size.x = KiROUND( EuclideanNorm( size ) ) + width;
459  size.y = width;
460 
461  FlashPadOval( center, size, orient, tracemode, NULL );
462 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:148
virtual void FlashPadOval(const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData)=0
#define NULL
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:70
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:182

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

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

◆ selectAperture() [1/3]

void GERBER_PLOTTER::selectAperture ( const wxSize &  aSize,
int  aRadius,
double  aRotDegree,
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 503 of file GERBER_plotter.cpp.

505 {
506  bool change = ( m_currentApertureIdx < 0 ) ||
507  ( m_apertures[m_currentApertureIdx].m_Type != aType ) ||
508  ( m_apertures[m_currentApertureIdx].m_Size != aSize ) ||
509  ( m_apertures[m_currentApertureIdx].m_Radius != aRadius ) ||
510  ( m_apertures[m_currentApertureIdx].m_Rotation != aRotDegree );
511 
512  if( !change )
513  change = m_apertures[m_currentApertureIdx].m_ApertureAttribute != aApertureAttribute;
514 
515  if( change )
516  {
517  // Pick an existing aperture or create a new one
518  m_currentApertureIdx = GetOrCreateAperture( aSize, aRadius, aRotDegree,
519  aType, aApertureAttribute );
520  fprintf( m_outputFile, "D%d*\n", m_apertures[m_currentApertureIdx].m_DCode );
521  }
522 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
std::vector< APERTURE > m_apertures
int GetOrCreateAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)

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

Referenced by FlashPadChamferRoundRect(), FlashPadCircle(), FlashPadCustom(), FlashPadOval(), FlashPadRect(), FlashPadRoundRect(), FlashPadTrapez(), FlashRegularPolygon(), selectAperture(), and SetCurrentLineWidth().

◆ selectAperture() [2/3]

void GERBER_PLOTTER::selectAperture ( const std::vector< wxPoint > &  aCorners,
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 525 of file GERBER_plotter.cpp.

527 {
528  bool change = ( m_currentApertureIdx < 0 ) ||
529  ( m_apertures[m_currentApertureIdx].m_Type != aType ) ||
530  ( m_apertures[m_currentApertureIdx].m_Corners.size() != aCorners.size() ) ||
531  ( m_apertures[m_currentApertureIdx].m_Rotation != aRotDegree );
532 
533  if( !change ) // Compare corner lists
534  {
535  for( size_t ii = 0; ii < aCorners.size(); ii++ )
536  {
537  if( aCorners[ii] != m_apertures[m_currentApertureIdx].m_Corners[ii] )
538  {
539  change = true;
540  break;
541  }
542  }
543  }
544 
545  if( !change )
546  change = m_apertures[m_currentApertureIdx].m_ApertureAttribute != aApertureAttribute;
547 
548  if( change )
549  {
550  // Pick an existing aperture or create a new one
551  m_currentApertureIdx = GetOrCreateAperture( aCorners, aRotDegree,
552  aType, aApertureAttribute );
553  fprintf( m_outputFile, "D%d*\n", m_apertures[m_currentApertureIdx].m_DCode );
554  }
555 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590
std::vector< APERTURE > m_apertures
int GetOrCreateAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)

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

◆ selectAperture() [3/3]

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

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

It only applies to apertures managing a polygon that differs from AT_REGULAR_POLY3 to AT_REGULAR_POLY12 (for instance APER_MACRO_TRAPEZOID ) write the DCode selection on gerber file.

Definition at line 558 of file GERBER_plotter.cpp.

560 {
561  // Pick an existing aperture or create a new one, matching the
562  // aDiameter, aPolygonRotation, type and attributes for type =
563  // AT_REGULAR_POLY3 to AT_REGULAR_POLY12
564 
565  wxASSERT( aType>= APERTURE::APERTURE_TYPE::AT_REGULAR_POLY3 &&
566  aType <= APERTURE::APERTURE_TYPE::AT_REGULAR_POLY12 );
567 
568  wxSize size( aDiameter, (int)( aPolygonRotation * 1000.0 ) );
569  selectAperture( wxSize( 0, 0), aDiameter/2, aPolygonRotation, aType, aApertureAttribute );
570 }
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, 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 ( const COLOR4D color)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 64 of file plotter_gerber.h.

64 {}

◆ SetColorMode()

virtual void PLOTTER::SetColorMode ( bool  aColorMode)
inlinevirtualinherited

◆ SetCreator()

◆ SetCurrentLineWidth()

void GERBER_PLOTTER::SetCurrentLineWidth ( int  width,
void *  aData = nullptr 
)
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 401 of file GERBER_plotter.cpp.

402 {
403  if( aWidth == DO_NOT_SET_LINE_WIDTH )
404  return;
405  else if( aWidth == USE_DEFAULT_LINE_WIDTH )
407 
408  wxASSERT_MSG( aWidth >= 0, "Plotter called to set negative pen width" );
409 
410  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
411  int aperture_attribute = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
412 
413  selectAperture( wxSize( aWidth, aWidth ), 0, 0.0, APERTURE::AT_PLOTTING, aperture_attribute );
414  m_currentPenWidth = aWidth;
415 }
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
int m_currentPenWidth
Definition: plotter.h:595
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
Definition: gbr_metadata.h:214
RENDER_SETTINGS * m_renderSettings
Definition: plotter.h:607
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void selectAperture(const wxSize &aSize, int aRadius, double aRotDegree, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
int GetDefaultPenWidth() const
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:125

References APERTURE::AT_PLOTTING, PLOTTER::DO_NOT_SET_LINE_WIDTH, GBR_METADATA::GetApertureAttrib(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), PLOTTER::m_currentPenWidth, PLOTTER::m_renderSettings, selectAperture(), and PLOTTER::USE_DEFAULT_LINE_WIDTH.

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

◆ SetDash()

virtual void GERBER_PLOTTER::SetDash ( PLOT_DASH_TYPE  dashed)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 60 of file plotter_gerber.h.

61  {
62  }

◆ SetGerberCoordinatesFormat()

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

Selection of Gerber units and resolution (number of digits in mantissa).

Should be called only after SetViewport() is called.

Parameters
aResolutionis the 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.
aUseInchesuse true to use inches, false to use mm (default).

Reimplemented from PLOTTER.

Definition at line 146 of file GERBER_plotter.cpp.

147 {
148  m_gerberUnitInch = aUseInches;
149  m_gerberUnitFmt = aResolution;
150 
151  m_iuPerDeviceUnit = pow( 10.0, m_gerberUnitFmt ) / ( m_IUsPerDecimil * 10000.0 );
152 
153  if( ! m_gerberUnitInch )
154  m_iuPerDeviceUnit *= 25.4; // gerber output in mm
155 }
double m_iuPerDeviceUnit
Definition: plotter.h:581
double m_IUsPerDecimil
Definition: plotter.h:579

References m_gerberUnitFmt, m_gerberUnitInch, PLOTTER::m_iuPerDeviceUnit, 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 1943 of file GERBER_plotter.cpp.

1944 {
1945  if( aPositive )
1946  fprintf( m_outputFile, "%%LPD*%%\n" );
1947  else
1948  fprintf( m_outputFile, "%%LPC*%%\n" );
1949 }
FILE * m_outputFile
Output file.
Definition: plotter.h:590

References PLOTTER::m_outputFile.

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 142 of file plotter.h.

143  {
144  m_negativeMode = aNegative;
145  }
bool m_negativeMode
Definition: plotter.h:594

References PLOTTER::m_negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

◆ SetRenderSettings()

◆ SetSvgCoordinatesFormat()

virtual void PLOTTER::SetSvgCoordinatesFormat ( unsigned  aResolution,
bool  aUseInches = false 
)
inlinevirtualinherited

Reimplemented in SVG_PLOTTER.

Definition at line 475 of file plotter.h.

476  {
477  // NOP for most plotters. Only for SVG plotter
478  }

Referenced by initializePlotter().

◆ 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 465 of file plotter.h.

466  {
467  // NOP for most plotters.
468  }

Referenced by initializePlotter(), and PlotOneBoardLayer().

◆ SetTitle()

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

Definition at line 176 of file plotter.h.

176 { m_title = aTitle; }
wxString m_title
Definition: plotter.h:601

References PLOTTER::m_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 124 of file GERBER_plotter.cpp.

126 {
127  wxASSERT( aMirror == false );
128  m_plotMirror = false;
129  m_plotOffset = aOffset;
130  wxASSERT( aScale == 1 ); // aScale parameter is not used in Gerber
131  m_plotScale = 1; // Plot scale is *always* 1.0
132 
133  m_IUsPerDecimil = aIusPerDecimil;
134 
135  // gives now a default value to iuPerDeviceUnit (because the units of the caller is now known)
136  // which could be modified later by calling SetGerberCoordinatesFormat()
137  m_iuPerDeviceUnit = pow( 10.0, m_gerberUnitFmt ) / ( m_IUsPerDecimil * 10000.0 );
138 
139  // We don't handle the filmbox, and it's more useful to keep the
140  // origin at the origin
141  m_paperSize.x = 0;
142  m_paperSize.y = 0;
143 }
double m_iuPerDeviceUnit
Definition: plotter.h:581
double m_IUsPerDecimil
Definition: plotter.h:579
double m_plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:573
bool m_plotMirror
Definition: plotter.h:584
wxPoint m_plotOffset
Definition: plotter.h:583
wxSize m_paperSize
Definition: plotter.h:603

References m_gerberUnitFmt, PLOTTER::m_iuPerDeviceUnit, PLOTTER::m_IUsPerDecimil, PLOTTER::m_paperSize, PLOTTER::m_plotMirror, PLOTTER::m_plotOffset, and PLOTTER::m_plotScale.

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 465 of file plotter.cpp.

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

References AddAngles(), PLOTTER::Arc(), PLOTTER::FinishTo(), PLOTTER::m_currentPenWidth, PLOTTER::MoveTo(), NO_FILL, RotatePoint(), and PLOTTER::SetCurrentLineWidth().

Referenced by PSLIKE_PLOTTER::FlashPadOval(), FlashPadOval(), HPGL_PLOTTER::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 192 of file GERBER_plotter.cpp.

193 {
194  // Currently, it is the same as EndBlock(): clear all aperture net attributes
195  EndBlock( aData );
196 }
virtual void EndBlock(void *aData) override
Define the end of a group of drawing items the group is started by StartBlock().

References EndBlock().

◆ StartPlot()

bool GERBER_PLOTTER::StartPlot ( )
overridevirtual

Write GERBER header to file initialize global variable g_Plot_PlotOutputFile.

Implements PLOTTER.

Definition at line 240 of file GERBER_plotter.cpp.

241 {
242  m_hasApertureRoundRect = false; // true is at least one round rect aperture is in use
243  m_hasApertureRotOval = false; // true is at least one oval rotated aperture is in use
244  m_hasApertureRotRect = false; // true is at least one rect. rotated aperture is in use
245  m_hasApertureOutline4P = false; // true is at least one rotated rect/trapezoid aperture
246  // is in use
247  m_hasApertureChamferedRect = false; // true is at least one chamfered rect is in use
249 
250  wxASSERT( m_outputFile );
251 
252  finalFile = m_outputFile; // the actual gerber file will be created later
253 
254  // Create a temp file in system temp to avoid potential network share buffer issues for
255  // the final read and save.
256  m_workFilename = wxFileName::CreateTempFileName( "" );
257  workFile = wxFopen( m_workFilename, wxT( "wt" ));
259  wxASSERT( m_outputFile );
260 
261  if( m_outputFile == nullptr )
262  return false;
263 
264  for( unsigned ii = 0; ii < m_headerExtraLines.GetCount(); ii++ )
265  {
266  if( ! m_headerExtraLines[ii].IsEmpty() )
267  fprintf( m_outputFile, "%s\n", TO_UTF8( m_headerExtraLines[ii] ) );
268  }
269 
270  // Set coordinate format to 3.6 or 4.5 absolute, leading zero omitted
271  // the number of digits for the integer part of coordinates is needed
272  // in gerber format, but is not very important when omitting leading zeros
273  // It is fixed here to 3 (inch) or 4 (mm), but is not actually used
274  int leadingDigitCount = m_gerberUnitInch ? 3 : 4;
275 
276  fprintf( m_outputFile, "%%FSLAX%d%dY%d%d*%%\n",
277  leadingDigitCount, m_gerberUnitFmt,
278  leadingDigitCount, m_gerberUnitFmt );
279  fprintf( m_outputFile,
280  "G04 Gerber Fmt %d.%d, Leading zero omitted, Abs format (unit %s)*\n",
281  leadingDigitCount, m_gerberUnitFmt,
282  m_gerberUnitInch ? "inch" : "mm" );
283 
284  wxString Title = m_creator + wxT( " " ) + GetBuildVersion();
285 
286  // In gerber files, ASCII7 chars only are allowed.
287  // So use a ISO date format (using a space as separator between date and time),
288  // not a localized date format
289  wxDateTime date = wxDateTime::Now();
290  fprintf( m_outputFile, "G04 Created by KiCad (%s) date %s*\n",
291  TO_UTF8( Title ), TO_UTF8( date.FormatISOCombined( ' ') ) );
292 
293  /* Mass parameter: unit = INCHES/MM */
294  if( m_gerberUnitInch )
295  fputs( "%MOIN*%\n", m_outputFile );
296  else
297  fputs( "%MOMM*%\n", m_outputFile );
298 
299  // Be sure the usual dark polarity is selected:
300  fputs( "%LPD*%\n", m_outputFile );
301 
302  // Set initial interpolation mode: always G01 (linear):
303  fputs( "G01*\n", m_outputFile );
304 
305  // Add aperture list start point
306  fputs( "G04 APERTURE LIST*\n", m_outputFile );
307 
308  // Give a minimal value to the default pen size, used to plot items in sketch mode
309  if( m_renderSettings )
310  {
311  const int pen_min = 0.1 * m_IUsPerDecimil * 10000 / 25.4; // for min width = 0.1 mm
313  pen_min ) );
314  }
315 
316  return true;
317 }
bool m_hasApertureChamferedRect
FILE * m_outputFile
Output file.
Definition: plotter.h:590
APER_MACRO_FREEPOLY_LIST m_am_freepoly_list
double m_IUsPerDecimil
Definition: plotter.h:579
wxArrayString m_headerExtraLines
Definition: plotter.h:605
bool m_hasApertureOutline4P
bool m_hasApertureRoundRect
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
wxString GetBuildVersion()
Get the full KiCad version string.
RENDER_SETTINGS * m_renderSettings
Definition: plotter.h:607
int GetDefaultPenWidth() const
wxString m_workFilename
void SetDefaultPenWidth(int aWidth)
wxString m_creator
Definition: plotter.h:599

References APER_MACRO_FREEPOLY_LIST::ClearList(), finalFile, GetBuildVersion(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), m_am_freepoly_list, PLOTTER::m_creator, m_gerberUnitFmt, m_gerberUnitInch, m_hasApertureChamferedRect, m_hasApertureOutline4P, m_hasApertureRotOval, m_hasApertureRotRect, m_hasApertureRoundRect, PLOTTER::m_headerExtraLines, PLOTTER::m_IUsPerDecimil, PLOTTER::m_outputFile, PLOTTER::m_renderSettings, m_workFilename, KIGFX::RENDER_SETTINGS::SetDefaultPenWidth(), 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  aPenWidth,
bool  aItalic,
bool  aBold,
bool  aMultilineAllowed = false,
void *  aData = nullptr 
)
overridevirtual

Draw text with the plotter.

Same as GRText, but plot graphic text instead of draw it.

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

Parameters
aPosis the text position (according to aH_justify, aV_justify).
aColoris the text color.
aTextis the text to draw.
aOrientis the angle in 0.1 degree.
aSizeis the text size (size.x or size.y can be < 0 for mirrored texts).
aH_justifyis the horizontal justification (Left, center, right).
aV_justifyis the vertical justification (bottom, center, top).
aPenWidthis the line width (if = 0, use plot default line width).
aItalicis the true to simulate an italic font.
aBolduse true to use a bold font Useful only with default width value (aWidth = 0).
aMultilineAlloweduse true to plot text as multiline, otherwise single line.
aDatais a parameter used by some plotters in SetCurrentLineWidth(), not directly used here.

Reimplemented from PLOTTER.

Definition at line 1927 of file GERBER_plotter.cpp.

1932 {
1933  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
1934 
1935  if( gbr_metadata )
1936  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1937 
1938  PLOTTER::Text( aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aWidth, aItalic,
1939  aBold, aMultilineAllowed, aData );
1940 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
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=nullptr)
Draw text with the plotter.
Definition: gr_text.cpp:217
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262

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,
OUTLINE_MODE  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 1127 of file GERBER_plotter.cpp.

1129 {
1130  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
1131  SetCurrentLineWidth( width, gbr_metadata );
1132 
1133  if( gbr_metadata )
1134  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1135 
1136  if( tracemode == FILLED )
1137  {
1138  Arc( centre, StAngle, EndAngle, radius, FILL_TYPE::NO_FILL, DO_NOT_SET_LINE_WIDTH );
1139  }
1140  else
1141  {
1143  Arc( centre, StAngle, EndAngle,
1144  radius - ( width - m_currentPenWidth ) / 2, FILL_TYPE::NO_FILL,
1146  Arc( centre, StAngle, EndAngle, radius + ( width - m_currentPenWidth ) / 2,
1148  }
1149 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
int m_currentPenWidth
Definition: plotter.h:595
virtual void Arc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
Generic fallback: arc rendered as a polyline.
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:125

References Arc(), PLOTTER::DO_NOT_SET_LINE_WIDTH, FILLED, formatNetAttribute(), PLOTTER::m_currentPenWidth, 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,
OUTLINE_MODE  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 1182 of file GERBER_plotter.cpp.

1184 {
1185  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
1186  SetCurrentLineWidth( width, gbr_metadata );
1187 
1188  if( gbr_metadata )
1189  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1190 
1191  if( tracemode == FILLED )
1192  {
1193  Circle( pos, diametre, FILL_TYPE::NO_FILL, DO_NOT_SET_LINE_WIDTH );
1194  }
1195  else
1196  {
1198  Circle( pos, diametre - (width - m_currentPenWidth),
1200  Circle( pos, diametre + (width - m_currentPenWidth),
1202  }
1203 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
int m_currentPenWidth
Definition: plotter.h:595
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:125

References Circle(), PLOTTER::DO_NOT_SET_LINE_WIDTH, FILLED, formatNetAttribute(), PLOTTER::m_currentPenWidth, 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,
OUTLINE_MODE  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 1152 of file GERBER_plotter.cpp.

1154 {
1155  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
1156  SetCurrentLineWidth( width, gbr_metadata );
1157 
1158  if( gbr_metadata )
1159  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1160 
1161  if( tracemode == FILLED )
1162  {
1164  }
1165  else
1166  {
1168  wxPoint offsetp1( p1.x - (width - m_currentPenWidth) / 2,
1169  p1.y - (width - m_currentPenWidth) / 2 );
1170  wxPoint offsetp2( p2.x + (width - m_currentPenWidth) / 2,
1171  p2.y + (width - m_currentPenWidth) / 2 );
1172  Rect( offsetp1, offsetp2, FILL_TYPE::NO_FILL, -1 );
1173  offsetp1.x += (width - m_currentPenWidth);
1174  offsetp1.y += (width - m_currentPenWidth);
1175  offsetp2.x -= (width - m_currentPenWidth);
1176  offsetp2.y -= (width - m_currentPenWidth);
1177  Rect( offsetp1, offsetp2, FILL_TYPE::NO_FILL, DO_NOT_SET_LINE_WIDTH );
1178  }
1179 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
int m_currentPenWidth
Definition: plotter.h:595
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:125

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

◆ ThickSegment()

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

Reimplemented from PLOTTER.

Definition at line 1106 of file GERBER_plotter.cpp.

1108 {
1109  if( tracemode == FILLED )
1110  {
1111  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
1112  SetCurrentLineWidth( width, gbr_metadata );
1113 
1114  if( gbr_metadata )
1115  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
1116 
1117  MoveTo( start );
1118  FinishTo( end );
1119  }
1120  else
1121  {
1123  segmentAsOval( start, end, width, tracemode );
1124  }
1125 }
void segmentAsOval(const wxPoint &start, const wxPoint &end, int width, OUTLINE_MODE tracemode)
Convert a thick segment and plot it as an oval.
Definition: plotter.cpp:444
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
Print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Metadata which can be added in a gerber file as attribute in X2 format.
Definition: gbr_metadata.h:204
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
Definition: gbr_metadata.h:262

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().

◆ userToDeviceCoordinates()

DPOINT PLOTTER::userToDeviceCoordinates ( const wxPoint &  aCoordinate)
protectedvirtualinherited

Modify 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 93 of file plotter.cpp.

94 {
95  wxPoint pos = aCoordinate - m_plotOffset;
96 
97  // Don't allow overflows; they can cause rendering failures in some file viewers
98  // (such as Acrobat)
99  int clampSize = MAX_PAGE_SIZE_MILS * m_IUsPerDecimil * 10 / 2;
100  pos.x = std::max( -clampSize, std::min( pos.x, clampSize ) );
101  pos.y = std::max( -clampSize, std::min( pos.y, clampSize ) );
102 
103  double x = pos.x * m_plotScale;
104  double y = ( m_paperSize.y - pos.y * m_plotScale );
105 
106  if( m_plotMirror )
107  {
109  x = ( m_paperSize.x - pos.x * m_plotScale );
110  else
111  y = pos.y * m_plotScale;
112  }
113 
114  if( m_yaxisReversed )
115  y = m_paperSize.y - y;
116 
117  x *= m_iuPerDeviceUnit;
118  y *= m_iuPerDeviceUnit;
119 
120  return DPOINT( x, y );
121 }
double m_iuPerDeviceUnit
Definition: plotter.h:581
double m_IUsPerDecimil
Definition: plotter.h:579
double m_plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:573
bool m_yaxisReversed
Definition: plotter.h:587
bool m_plotMirror
Definition: plotter.h:584
wxPoint m_plotOffset
Definition: plotter.h:583
#define MAX_PAGE_SIZE_MILS
Definition: page_info.h:41
VECTOR2< double > DPOINT
Definition: vector2d.h:628
wxSize m_paperSize
Definition: plotter.h:603
bool m_mirrorIsHorizontal
Definition: plotter.h:586

References PLOTTER::m_iuPerDeviceUnit, PLOTTER::m_IUsPerDecimil, PLOTTER::m_mirrorIsHorizontal, PLOTTER::m_paperSize, PLOTTER::m_plotMirror, PLOTTER::m_plotOffset, PLOTTER::m_plotScale, PLOTTER::m_yaxisReversed, and MAX_PAGE_SIZE_MILS.

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

◆ userToDeviceSize() [1/2]

◆ userToDeviceSize() [2/2]

double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtualinherited

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

Definition at line 131 of file plotter.cpp.

132 {
133  return size * m_plotScale * m_iuPerDeviceUnit;
134 }
double m_iuPerDeviceUnit
Definition: plotter.h:581
double m_plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:573

References PLOTTER::m_iuPerDeviceUnit, and PLOTTER::m_plotScale.

◆ UseX2format()

void GERBER_PLOTTER::UseX2format ( bool  aEnable)
inline

◆ UseX2NetAttributes()

void GERBER_PLOTTER::UseX2NetAttributes ( bool  aEnable)
inline

◆ writeApertureList()

void GERBER_PLOTTER::writeApertureList ( )
protected

Generate the table of D codes.

Definition at line 572 of file GERBER_plotter.cpp.

573 {
574  wxASSERT( m_outputFile );
575  char cbuf[1024];
576  std::string buffer;
577 
578  bool useX1StructuredComment = false;
579 
580  if( !m_useX2format )
581  useX1StructuredComment = true;
582 
583  // Init
584  for( APERTURE& tool : m_apertures )
585  {
586  // aperture sizes are in inch or mm, regardless the
587  // coordinates format
588  double fscale = 0.0001 * m_plotScale / m_IUsPerDecimil; // inches
589 
590  if(! m_gerberUnitInch )
591  fscale *= 25.4; // size in mm
592 
593  int attribute = tool.m_ApertureAttribute;
594 
595  if( attribute != m_apertureAttribute )
596  {
599  useX1StructuredComment ).c_str(), m_outputFile );
600  }
601 
602  sprintf( cbuf, "%%ADD%d", tool.m_DCode );
603  buffer = cbuf;
604 
605  /* Please note: the Gerber specs for mass parameters say that
606  exponential syntax is *not* allowed and the decimal point should
607  also be always inserted. So the %g format is ruled out, but %f is fine
608  (the # modifier forces the decimal point). Sadly the %f formatter
609  can't remove trailing zeros but that's not a problem, since nothing
610  forbid it (the file is only slightly longer) */
611 
612  switch( tool.m_Type )
613  {
614  case APERTURE::AT_CIRCLE:
615  sprintf( cbuf, "C,%#f*%%\n", tool.GetDiameter() * fscale );
616  break;
617 
618  case APERTURE::AT_RECT:
619  sprintf( cbuf, "R,%#fX%#f*%%\n", tool.m_Size.x * fscale,
620  tool.m_Size.y * fscale );
621  break;
622 
624  sprintf( cbuf, "C,%#f*%%\n", tool.m_Size.x * fscale );
625  break;
626 
627  case APERTURE::AT_OVAL:
628  sprintf( cbuf, "O,%#fX%#f*%%\n", tool.m_Size.x * fscale,
629  tool.m_Size.y * fscale );
630  break;
631 
643  sprintf( cbuf, "P,%#fX%dX%#f*%%\n", tool.GetDiameter() * fscale,
644  tool.GetRegPolyVerticeCount(), tool.GetRotation() );
645  break;
646 
647  case APERTURE::AM_ROUND_RECT: // Aperture macro for round rect pads
648  {
649  // The aperture macro needs coordinates of the centers of the 4 corners
650  std::vector<VECTOR2I> corners;
651  wxSize half_size( tool.m_Size.x/2-tool.m_Radius, tool.m_Size.y/2-tool.m_Radius );
652 
653  corners.emplace_back( -half_size.x, -half_size.y );
654  corners.emplace_back( half_size.x, -half_size.y );
655  corners.emplace_back( half_size.x, half_size.y );
656  corners.emplace_back( -half_size.x, half_size.y );
657 
658  // Rotate the corner coordinates:
659  for( int ii = 0; ii < 4; ii++ )
660  RotatePoint( corners[ii], -tool.m_Rotation*10.0 );
661 
662  sprintf( cbuf, "%s,%#fX", APER_MACRO_ROUNDRECT_NAME,
663  tool.m_Radius * fscale );
664  buffer += cbuf;
665 
666  // Add each corner
667  for( int ii = 0; ii < 4; ii++ )
668  {
669  sprintf( cbuf, "%#fX%#fX",
670  corners[ii].x * fscale, corners[ii].y * fscale );
671  buffer += cbuf;
672  }
673 
674  sprintf( cbuf, "0*%%\n" );
675  }
676  break;
677 
678  case APERTURE::AM_ROT_RECT: // Aperture macro for rotated rect pads
679  sprintf( cbuf, "%s,%#fX%#fX%#f*%%\n", APER_MACRO_ROT_RECT_NAME,
680  tool.m_Size.x * fscale, tool.m_Size.y * fscale,
681  tool.m_Rotation );
682  break;
683 
684  case APERTURE::APER_MACRO_OUTLINE4P: // Aperture macro for trapezoid pads
685  case APERTURE::APER_MACRO_OUTLINE5P: // Aperture macro for chamfered rect pads
686  case APERTURE::APER_MACRO_OUTLINE6P: // Aperture macro for chamfered rect pads
687  case APERTURE::APER_MACRO_OUTLINE7P: // Aperture macro for chamfered rect pads
688  case APERTURE::APER_MACRO_OUTLINE8P: // Aperture macro for chamfered rect pads
689  switch( tool.m_Type )
690  {
692  sprintf( cbuf, "%s,", APER_MACRO_OUTLINE4P_NAME ); break;
694  sprintf( cbuf, "%s,", APER_MACRO_OUTLINE5P_NAME ); break;
696  sprintf( cbuf, "%s,", APER_MACRO_OUTLINE6P_NAME ); break;
698  sprintf( cbuf, "%s,", APER_MACRO_OUTLINE7P_NAME ); break;
700  sprintf( cbuf, "%s,", APER_MACRO_OUTLINE8P_NAME ); break;
701  default:
702  break;
703  }
704 
705  buffer += cbuf;
706 
707  // Output all corners (should be 4 to 8 corners)
708  // Remember: the Y coordinate must be negated, due to the fact in Pcbnew
709  // the Y axis is from top to bottom
710  for( size_t ii = 0; ii < tool.m_Corners.size(); ii++ )
711  {
712  sprintf( cbuf, "%#fX%#fX",
713  tool.m_Corners[ii].x * fscale, -tool.m_Corners[ii].y * fscale );
714  buffer += cbuf;
715  }
716 
717  // close outline and output rotation
718  sprintf( cbuf, "%#f*%%\n", tool.m_Rotation );
719  break;
720 
721  case APERTURE::AM_ROTATED_OVAL: // Aperture macro for rotated oval pads
722  // (not rotated is a primitive)
723  // m_Size.x = full length; m_Size.y = width, and the macro aperture expects
724  // the position of ends
725  {
726  // the seg_len is the distance between the 2 circle centers
727  int seg_len = tool.m_Size.x - tool.m_Size.y;
728  // Center of the circle on the segment start point:
729  VECTOR2I start( seg_len/2, 0 );
730  // Center of the circle on the segment end point:
731  VECTOR2I end( - seg_len/2, 0 );
732 
733  RotatePoint( start, tool.m_Rotation*10.0 );
734  RotatePoint( end, tool.m_Rotation*10.0 );
735 
736  sprintf( cbuf, "%s,%#fX%#fX%#fX%#fX%#fX0*%%\n", APER_MACRO_SHAPE_OVAL_NAME,
737  tool.m_Size.y * fscale, // width
738  start.x * fscale, -start.y * fscale, // X,Y corner start pos
739  end.x * fscale, -end.y * fscale ); // X,Y cornerend pos
740  }
741  break;
742 
744  {
745  // Find the aperture macro name in the list of aperture macro
746  // created on the fly for this polygon:
747  int idx = m_am_freepoly_list.FindAm( tool.m_Corners );
748 
749  // Write DCODE id ( "%ADDxx" is already in buffer) and rotation
750  // the full line is something like :%ADD12FreePoly1,45.000000*%
751  sprintf( cbuf, "%s%d,%#f*%%\n", AM_FREEPOLY_BASENAME, idx, tool.m_Rotation );
752  break;
753  }
754  }
755 
756  buffer += cbuf;
757  fputs( buffer.c_str(), m_outputFile );
758 
759  m_apertureAttribute = attribute;
760 
761  // Currently reset the aperture attribute. Perhaps a better optimization
762  // is to store the last attribute
763  if( attribute )
764  {
765  if( m_useX2format )
766  fputs( "%TD*%\n", m_outputFile );
767  else
768  fputs( "G04 #@! TD*\n", m_outputFile );
769 
771  }
772 
773  }
774 }
#define APER_MACRO_ROUNDRECT_NAME
#define APER_MACRO_SHAPE_OVAL_NAME
FILE * m_outputFile
Output file.
Definition: plotter.h:590
#define APER_MACRO_OUTLINE7P_NAME
APER_MACRO_FREEPOLY_LIST m_am_freepoly_list
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
double m_IUsPerDecimil
Definition: plotter.h:579
double m_plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:573
std::vector< APERTURE > m_apertures
#define APER_MACRO_OUTLINE5P_NAME
#define APER_MACRO_OUTLINE8P_NAME
#define APER_MACRO_ROT_RECT_NAME
#define AM_FREEPOLY_BASENAME
static std::string FormatAttribute(GBR_APERTURE_ATTRIB aAttribute, bool aUseX1StructuredComment)
#define APER_MACRO_OUTLINE4P_NAME
int FindAm(const std::vector< wxPoint > &aPolygon) const
#define APER_MACRO_OUTLINE6P_NAME

References APERTURE::AM_FREE_POLYGON, AM_FREEPOLY_BASENAME, APERTURE::AM_ROT_RECT, APERTURE::AM_ROTATED_OVAL, APERTURE::AM_ROUND_RECT, APERTURE::APER_MACRO_OUTLINE4P, APER_MACRO_OUTLINE4P_NAME, APERTURE::APER_MACRO_OUTLINE5P, APER_MACRO_OUTLINE5P_NAME, APERTURE::APER_MACRO_OUTLINE6P, APER_MACRO_OUTLINE6P_NAME, APERTURE::APER_MACRO_OUTLINE7P, APER_MACRO_OUTLINE7P_NAME, APERTURE::APER_MACRO_OUTLINE8P, APER_MACRO_OUTLINE8P_NAME, APER_MACRO_ROT_RECT_NAME, APER_MACRO_ROUNDRECT_NAME, APER_MACRO_SHAPE_OVAL_NAME, 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, APER_MACRO_FREEPOLY_LIST::FindAm(), GBR_APERTURE_METADATA::FormatAttribute(), m_am_freepoly_list, m_apertureAttribute, m_apertures, m_gerberUnitInch, PLOTTER::m_IUsPerDecimil, PLOTTER::m_outputFile, PLOTTER::m_plotScale, m_useX2format, RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EndPlot().

Member Data Documentation

◆ DO_NOT_SET_LINE_WIDTH

◆ finalFile

FILE* GERBER_PLOTTER::finalFile
protected

Definition at line 348 of file plotter_gerber.h.

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

◆ m_am_freepoly_list

APER_MACRO_FREEPOLY_LIST GERBER_PLOTTER::m_am_freepoly_list
protected

Definition at line 382 of file plotter_gerber.h.

Referenced by EndPlot(), GetOrCreateAperture(), StartPlot(), and writeApertureList().

◆ m_apertureAttribute

int GERBER_PLOTTER::m_apertureAttribute
protected

Definition at line 345 of file plotter_gerber.h.

Referenced by GERBER_PLOTTER(), and writeApertureList().

◆ m_apertures

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

Definition at line 356 of file plotter_gerber.h.

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

◆ m_colorMode

◆ m_creator

wxString PLOTTER::m_creator
protectedinherited

◆ m_currentApertureIdx

int GERBER_PLOTTER::m_currentApertureIdx
protected

Definition at line 357 of file plotter_gerber.h.

Referenced by GERBER_PLOTTER(), and selectAperture().

◆ m_currentPenWidth

◆ m_filename

wxString PLOTTER::m_filename
protectedinherited

◆ m_gerberDisableApertMacros

bool GERBER_PLOTTER::m_gerberDisableApertMacros
protected

◆ m_gerberUnitFmt

int GERBER_PLOTTER::m_gerberUnitFmt
protected

◆ m_gerberUnitInch

bool GERBER_PLOTTER::m_gerberUnitInch
protected

◆ m_hasApertureChamferedRect

bool GERBER_PLOTTER::m_hasApertureChamferedRect
protected

Definition at line 363 of file plotter_gerber.h.

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

◆ m_hasApertureOutline4P

bool GERBER_PLOTTER::m_hasApertureOutline4P
protected

◆ m_hasApertureRotOval

bool GERBER_PLOTTER::m_hasApertureRotOval
protected

Definition at line 359 of file plotter_gerber.h.

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

◆ m_hasApertureRotRect

bool GERBER_PLOTTER::m_hasApertureRotRect
protected

Definition at line 360 of file plotter_gerber.h.

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

◆ m_hasApertureRoundRect

bool GERBER_PLOTTER::m_hasApertureRoundRect
protected

Definition at line 358 of file plotter_gerber.h.

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

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

Definition at line 605 of file plotter.h.

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

◆ m_iuPerDeviceUnit

◆ m_IUsPerDecimil

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

◆ m_negativeMode

bool PLOTTER::m_negativeMode
protectedinherited

Definition at line 594 of file plotter.h.

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

◆ m_objectAttributesDictionary

std::string GERBER_PLOTTER::m_objectAttributesDictionary
protected

Definition at line 342 of file plotter_gerber.h.

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

◆ m_outputFile

FILE* PLOTTER::m_outputFile
protectedinherited

Output file.

Definition at line 590 of file plotter.h.

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

◆ m_pageInfo

◆ m_paperSize

◆ m_penLastpos

wxPoint PLOTTER::m_penLastpos
protectedinherited

◆ m_penState

char PLOTTER::m_penState
protectedinherited

◆ m_plotMirror

◆ m_plotOffset

◆ m_plotScale

double PLOTTER::m_plotScale
protectedinherited

◆ m_renderSettings

◆ m_title

wxString PLOTTER::m_title
protectedinherited

Definition at line 601 of file plotter.h.

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

◆ m_useNetAttributes

bool GERBER_PLOTTER::m_useNetAttributes
protected

Definition at line 374 of file plotter_gerber.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 349 of file plotter_gerber.h.

Referenced by EndPlot(), and StartPlot().

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed
protectedinherited

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58
staticinherited

Draw a marker (used for the drill map).

Definition at line 436 of file plotter.h.

Referenced by PLOTTER::Marker().

◆ USE_DEFAULT_LINE_WIDTH

◆ workFile

FILE* GERBER_PLOTTER::workFile
protected

Definition at line 347 of file plotter_gerber.h.

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


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