KiCad PCB EDA Suite
GERBER_PLOTTER Class Reference

#include <plot_common.h>

Inheritance diagram for GERBER_PLOTTER:
PLOTTER

Public Member Functions

 GERBER_PLOTTER ()
 
virtual PlotFormat GetPlotterType () const override
 Returns the effective plot engine in use. More...
 
virtual bool StartPlot () override
 Function StartPlot Write GERBER header to file initialize global variable g_Plot_PlotOutputFile. More...
 
virtual bool EndPlot () override
 
virtual void SetCurrentLineWidth (int width, void *aData=NULL) override
 Set the line width for the next drawing. More...
 
virtual void SetDefaultLineWidth (int width) override
 Set the default line width. More...
 
virtual void SetDash (bool dashed) override
 
virtual void SetColor (COLOR4D color) override
 
virtual void SetViewport (const wxPoint &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
 Set the plot offset and scaling for the current plot. More...
 
virtual void Rect (const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 
virtual void Circle (const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 
virtual void Arc (const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
 Generic fallback: arc rendered as a polyline. More...
 
virtual void ThickSegment (const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
 
virtual void ThickArc (const wxPoint &centre, double StAngle, double EndAngle, int rayon, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
 
virtual void ThickRect (const wxPoint &p1, const wxPoint &p2, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
 
virtual void ThickCircle (const wxPoint &pos, int diametre, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
 
virtual void PlotPoly (const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL) override
 Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence. More...
 
virtual void PenTo (const wxPoint &pos, char plume) override
 moveto/lineto primitive, moves the 'pen' to the specified direction More...
 
virtual void Text (const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL) override
 Draws text with the plotter. More...
 
virtual void FlashPadCircle (const wxPoint &pos, int diametre, EDA_DRAW_MODE_T trace_mode, void *aData) override
 Filled circular flashes are stored as apertures. More...
 
virtual void FlashPadOval (const wxPoint &pos, const wxSize &size, double orient, EDA_DRAW_MODE_T trace_mode, void *aData) override
 Filled oval flashes are handled as aperture in the 90 degree positions only. More...
 
virtual void FlashPadRect (const wxPoint &pos, const wxSize &size, double orient, EDA_DRAW_MODE_T trace_mode, void *aData) override
 Filled rect flashes are handled as aperture in the 0 90 180 or 270 degree orientation only and as polygon for other orientations TODO: always use flashed shapes (aperture macros) More...
 
virtual void FlashPadRoundRect (const wxPoint &aPadPos, const wxSize &aSize, int aCornerRadius, double aOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 Roundrect pad at the moment are not handled as aperture, since they require aperture macros TODO: always use flashed shapes (aperture macros) More...
 
virtual void FlashPadCustom (const wxPoint &aPadPos, const wxSize &aSize, SHAPE_POLY_SET *aPolygons, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 virtual function FlashPadCustom More...
 
virtual void FlashPadTrapez (const wxPoint &aPadPos, const wxPoint *aCorners, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 Trapezoidal pad at the moment are never handled as aperture, since they require aperture macros TODO: always use flashed shapes (aperture macros) More...
 
virtual void SetLayerPolarity (bool aPositive) override
 Change the plot polarity and begin a new layer Used to 'scratch off' silk screen away from solder mask. More...
 
virtual void SetGerberCoordinatesFormat (int aResolution, bool aUseInches=false) override
 Function SetGerberCoordinatesFormat selection of Gerber units and resolution (number of digits in mantissa) More...
 
void UseX2Attributes (bool aEnable)
 
void UseX2NetAttributes (bool aEnable)
 
virtual void StartBlock (void *aData) override
 calling this function allows to define the beginning of a group of drawing items (used in X2 format with netlist attributes) More...
 
virtual void EndBlock (void *aData) override
 calling this function allows to define the end of a group of drawing items the group is started by StartBlock() (used in X2 format with netlist attributes) More...
 
virtual void SetNegative (bool _negative)
 
virtual void SetColorMode (bool _color_mode)
 
bool GetColorMode () const
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings)
 
virtual int GetCurrentLineWidth () const
 
virtual void SetCreator (const wxString &aCreator)
 
virtual void SetTitle (const wxString &aTitle)
 
void AddLineToHeader (const wxString &aExtraString)
 Function AddLineToHeader Add a line to the list of free lines to print at the beginning of the file. More...
 
void ClearHeaderLinesList ()
 Function ClearHeaderLinesList remove all lines from the list of free lines to print at the beginning of the file. More...
 
virtual bool OpenFile (const wxString &aFullFilename)
 Open or create the plot file aFullFilename. More...
 
double GetIUsPerDecimil () const
 The IUs per decimil are an essential scaling factor when plotting; they are set and saved when establishing the viewport. More...
 
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)
 Function PlotImage Only Postscript plotters can plot bitmaps for plotters that cannot plot a bitmap, a rectangle is plotted. More...
 
void Marker (const wxPoint &position, int diametre, unsigned aShapeId)
 Draw a pattern shape number aShapeId, to coord position. More...
 
virtual void SetTextMode (PlotTextMode mode)
 Change the current text mode. More...
 

Static Public Member Functions

static wxString GetDefaultFileExtension ()
 

Static Public Attributes

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

Protected Member Functions

void selectAperture (const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 Pick an existing aperture or create a new one, matching the size, type and attributes. More...
 
void emitDcode (const DPOINT &pt, int dcode)
 Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate (for n decimal positions, see header generation in start_plot. More...
 
void formatNetAttribute (GBR_NETLIST_METADATA *aData)
 print a Gerber net attribute object record. More...
 
void clearNetAttribute ()
 clear a Gerber net attribute record (clear object attribute dictionnary) and output the clear object attribute dictionnary command to gerber file More...
 
std::vector< APERTURE >::iterator getAperture (const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 Function getAperture returns a reference to the aperture which meets the size anf type of tool if the aperture does not exist, it is created and entered in aperture list. More...
 
void writeApertureList ()
 Generate the table of D codes. More...
 
void markerCircle (const wxPoint &pos, int radius)
 Plot a circle centered on the position. More...
 
void markerHBar (const wxPoint &pos, int radius)
 Plot a - bar centered on the position. More...
 
void markerSlash (const wxPoint &pos, int radius)
 Plot a / bar centered on the position. More...
 
void markerBackSlash (const wxPoint &pos, int radius)
 Plot a \ bar centered on the position. More...
 
void markerVBar (const wxPoint &pos, int radius)
 Plot a | bar centered on the position. More...
 
void markerSquare (const wxPoint &position, int radius)
 Plot a square centered on the position. More...
 
void markerLozenge (const wxPoint &position, int radius)
 Plot a lozenge centered on the position. More...
 
void segmentAsOval (const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode)
 Cdonvert a thick segment and plot it as an oval. More...
 
void sketchOval (const wxPoint &pos, const wxSize &size, double orient, int width)
 
virtual DPOINT userToDeviceCoordinates (const wxPoint &aCoordinate)
 Modifies coordinates according to the orientation, scale factor, and offsets trace. More...
 
virtual DPOINT userToDeviceSize (const wxSize &size)
 Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT) More...
 
virtual double userToDeviceSize (double size) const
 Modifies size according to the plotter scale factors (simple double version) More...
 
double GetDashMarkLenIU () const
 
double GetDashGapLenIU () const
 

Protected Attributes

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

Detailed Description

Definition at line 985 of file plot_common.h.

Constructor & Destructor Documentation

GERBER_PLOTTER::GERBER_PLOTTER ( )

Definition at line 46 of file common_plotGERBER_functions.cpp.

References apertures, currentAperture, finalFile, m_apertureAttribute, m_gerberUnitFmt, m_gerberUnitInch, m_useNetAttributes, m_useX2Attributes, and workFile.

47 {
48  workFile = NULL;
49  finalFile = NULL;
50  currentAperture = apertures.end();
52 
53  // number of digits after the point (number of digits of the mantissa
54  // Be carefull: the Gerber coordinates are stored in an integer
55  // so 6 digits (inches) or 5 digits (mm) is a good value
56  // To avoid overflow, 7 digits (inches) or 6 digits is a max.
57  // with lower values than 6 digits (inches) or 5 digits (mm),
58  // Creating self-intersecting polygons from non-intersecting polygons
59  // happen easily.
60  m_gerberUnitInch = false;
61  m_gerberUnitFmt = 6;
62  m_useX2Attributes = false;
63  m_useNetAttributes = true;
64 }
bool m_useNetAttributes
Definition: plot_common.h:1200
std::vector< APERTURE > apertures
Definition: plot_common.h:1192
bool m_useX2Attributes
Definition: plot_common.h:1198
std::vector< APERTURE >::iterator currentAperture
Definition: plot_common.h:1193

Member Function Documentation

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

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

Parameters
aExtraStringis the string to print

Definition at line 166 of file plot_common.h.

References PLOTTER::m_headerExtraLines.

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

167  {
168  m_headerExtraLines.Add( aExtraString );
169  }
wxArrayString m_headerExtraLines
Definition: plot_common.h:549
void GERBER_PLOTTER::Arc ( const wxPoint centre,
double  StAngle,
double  EndAngle,
int  rayon,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Generic fallback: arc rendered as a polyline.

Reimplemented from PLOTTER.

Definition at line 450 of file common_plotGERBER_functions.cpp.

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

Referenced by Circle(), and ThickArc().

452 {
453  SetCurrentLineWidth( aWidth );
454 
455  wxPoint start, end;
456  start.x = aCenter.x + KiROUND( cosdecideg( aRadius, aStAngle ) );
457  start.y = aCenter.y - KiROUND( sindecideg( aRadius, aStAngle ) );
458  MoveTo( start );
459  end.x = aCenter.x + KiROUND( cosdecideg( aRadius, aEndAngle ) );
460  end.y = aCenter.y - KiROUND( sindecideg( aRadius, aEndAngle ) );
461  DPOINT devEnd = userToDeviceCoordinates( end );
462  DPOINT devCenter = userToDeviceCoordinates( aCenter ) - userToDeviceCoordinates( start );
463 
464  fprintf( outputFile, "G75*\n" ); // Multiquadrant mode
465 
466  if( aStAngle < aEndAngle )
467  fprintf( outputFile, "G03" );
468  else
469  fprintf( outputFile, "G02" );
470 
471  fprintf( outputFile, "X%dY%dI%dJ%dD01*\n",
472  KiROUND( devEnd.x ), KiROUND( devEnd.y ),
473  KiROUND( devCenter.x ), KiROUND( devCenter.y ) );
474  fprintf( outputFile, "G01*\n" ); // Back to linear interp.
475 }
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
double cosdecideg(double r, double a)
Circle generation utility: computes r * cos(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:311
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:302
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
void GERBER_PLOTTER::Circle ( const wxPoint pos,
int  diametre,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Implements PLOTTER.

Definition at line 444 of file common_plotGERBER_functions.cpp.

References Arc().

Referenced by FlashPadCircle(), and ThickCircle().

445 {
446  Arc( aCenter, 0, 3600, aDiameter / 2, aFill, aWidth );
447 }
virtual void Arc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
Generic fallback: arc rendered as a polyline.
void PLOTTER::ClearHeaderLinesList ( )
inlineinherited

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

Definition at line 175 of file plot_common.h.

References PLOTTER::m_headerExtraLines.

Referenced by StartPlotBoard().

176  {
177  m_headerExtraLines.Clear();
178  }
wxArrayString m_headerExtraLines
Definition: plot_common.h:549
void GERBER_PLOTTER::clearNetAttribute ( )
protected

clear a Gerber net attribute record (clear object attribute dictionnary) and output the clear object attribute dictionnary command to gerber file

Definition at line 109 of file common_plotGERBER_functions.cpp.

References m_objectAttributesDictionnary, and PLOTTER::outputFile.

Referenced by EndBlock(), and formatNetAttribute().

110 {
111  // disable a Gerber net attribute (exists only in X2 with net attributes mode).
112  if( m_objectAttributesDictionnary.empty() ) // No net attribute or not X2 mode
113  return;
114 
115  // Remove all net attributes from object attributes dictionnary
116  fputs( "%TD*%\n", outputFile );
117 
119 }
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
std::string m_objectAttributesDictionnary
Definition: plot_common.h:1178
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 101 of file common_plotGERBER_functions.cpp.

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

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

102 {
103 
104  fprintf( outputFile, "X%dY%dD%02d*\n",
105  KiROUND( pt.x ), KiROUND( pt.y ), dcode );
106 }
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
void GERBER_PLOTTER::EndBlock ( void *  aData)
overridevirtual

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

Parameters
aDatacan define any parameter

Reimplemented from PLOTTER.

Definition at line 129 of file common_plotGERBER_functions.cpp.

References clearNetAttribute().

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

130 {
131  // Remove all net attributes from object attributes dictionnary
133 }
void clearNetAttribute()
clear a Gerber net attribute record (clear object attribute dictionnary) and output the clear object ...
bool GERBER_PLOTTER::EndPlot ( )
overridevirtual

Implements PLOTTER.

Definition at line 217 of file common_plotGERBER_functions.cpp.

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

Referenced by GERBER_WRITER::createDrillFile().

218 {
219  char line[1024];
220  wxString msg;
221 
222  wxASSERT( outputFile );
223 
224  /* Outfile is actually a temporary file i.e. workFile */
225  fputs( "M02*\n", outputFile );
226  fflush( outputFile );
227 
228  fclose( workFile );
229  workFile = wxFopen( m_workFilename, wxT( "rt" ));
230  wxASSERT( workFile );
232 
233  // Placement of apertures in RS274X
234  while( fgets( line, 1024, workFile ) )
235  {
236  fputs( line, outputFile );
237 
238  if( strcmp( strtok( line, "\n\r" ), "G04 APERTURE LIST*" ) == 0 )
239  {
241  fputs( "G04 APERTURE END LIST*\n", outputFile );
242  }
243  }
244 
245  fclose( workFile );
246  fclose( finalFile );
247  ::wxRemoveFile( m_workFilename );
248  outputFile = 0;
249 
250  return true;
251 }
void writeApertureList()
Generate the table of D codes.
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
wxString m_workFilename
Definition: plot_common.h:1185
void GERBER_PLOTTER::FlashPadCircle ( const wxPoint pos,
int  diametre,
EDA_DRAW_MODE_T  trace_mode,
void *  aData 
)
overridevirtual

Filled circular flashes are stored as apertures.

Implements PLOTTER.

Definition at line 619 of file common_plotGERBER_functions.cpp.

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

Referenced by GERBER_WRITER::createDrillFile(), FlashPadCustom(), FlashPadOval(), FlashPadRoundRect(), and FlashPadTrapez().

620 {
621  wxSize size( diametre, diametre );
622  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
623 
624  if( trace_mode == SKETCH )
625  {
627 
628  if( gbr_metadata )
629  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
630 
632  }
633  else
634  {
635  DPOINT pos_dev = userToDeviceCoordinates( pos );
636 
637  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
638  selectAperture( size, APERTURE::Circle, aperture_attrib );
639 
640  if( gbr_metadata )
641  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
642 
643  emitDcode( pos_dev, 3 );
644  }
645 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
void selectAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate (fo...
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
int currentPenWidth
Definition: plot_common.h:537
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
static const int DO_NOT_SET_LINE_WIDTH
Definition: plot_common.h:94
void GERBER_PLOTTER::FlashPadCustom ( const wxPoint aPadPos,
const wxSize &  aSize,
SHAPE_POLY_SET aPolygons,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtual

virtual function FlashPadCustom

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

Implements PLOTTER.

Definition at line 846 of file common_plotGERBER_functions.cpp.

References GBR_NETLIST_METADATA::ClearAttribute(), FILLED, FILLED_SHAPE, FlashPadCircle(), GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_METADATA::IsCopper(), GBR_METADATA::m_NetlistMetadata, min, NO_FILL, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PlotPoly(), SHAPE_LINE_CHAIN::Point(), SHAPE_LINE_CHAIN::PointCount(), GBR_METADATA::SetApertureAttrib(), PLOTTER::USE_DEFAULT_LINE_WIDTH, VECTOR2< T >::x, and VECTOR2< T >::y.

850 {
851  // A Pad custom is plotted as polygon.
852 
853  // A flashed circle @aPadPos is added (anchor pad)
854  // However, because the anchor pad can be circle or rect, we use only
855  // a circle not bigger than the rect.
856  // the main purpose is to print a flashed DCode as pad anchor
857  FlashPadCircle( aPadPos, std::min( aSize.x, aSize.x ), aTraceMode, aData );
858  GBR_METADATA gbr_metadata;
859 
860  if( aData )
861  {
862  gbr_metadata = *static_cast<GBR_METADATA*>( aData );
863  // If the pad is drawn on a copper layer,
864  // set attribute to GBR_APERTURE_ATTRIB_CONDUCTOR
865  if( gbr_metadata.IsCopper() )
867 
868  wxString attrname( ".P" );
869  gbr_metadata.m_NetlistMetadata.ClearAttribute( &attrname ); // not allowed on inner layers
870  }
871 
872  std::vector< wxPoint > cornerList;
873 
874  for( int cnt = 0; cnt < aPolygons->OutlineCount(); ++cnt )
875  {
876  SHAPE_LINE_CHAIN& poly = aPolygons->Outline( cnt );
877  cornerList.clear();
878 
879  for( int ii = 0; ii < poly.PointCount(); ++ii )
880  cornerList.push_back( wxPoint( poly.Point( ii ).x, poly.Point( ii ).y ) );
881 
882  // Close polygon
883  cornerList.push_back( cornerList[0] );
884 
885  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL, USE_DEFAULT_LINE_WIDTH, &gbr_metadata );
886  }
887 }
int PointCount() const
Function PointCount()
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL) override
Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence.
bool IsCopper()
Allowed attributes are not the same on board copper layers and on other layers Therefore a flag can b...
int OutlineCount() const
Returns the number of outlines in the set
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
virtual void FlashPadCircle(const wxPoint &pos, int diametre, EDA_DRAW_MODE_T trace_mode, void *aData) override
Filled circular flashes are stored as apertures.
aperture used for connected items like tracks (not vias)
Class SHAPE_LINE_CHAIN.
void ClearAttribute(const wxString *aName)
remove the net attribute specified by aName If aName == NULL or empty, remove all attributes ...
VECTOR2I & Point(int aIndex)
Function Point()
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
#define min(a, b)
Definition: auxiliary.h:85
void GERBER_PLOTTER::FlashPadOval ( const wxPoint pos,
const wxSize &  size,
double  orient,
EDA_DRAW_MODE_T  trace_mode,
void *  aData 
)
overridevirtual

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

Implements PLOTTER.

Definition at line 648 of file common_plotGERBER_functions.cpp.

References GBR_NETLIST_METADATA::ClearAttribute(), delta, emitDcode(), FILLED, FlashPadCircle(), formatNetAttribute(), GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_METADATA::GetApertureAttrib(), GBR_METADATA::IsCopper(), GBR_METADATA::m_NetlistMetadata, PLOTTER::outputFile, APERTURE::Oval, RotatePoint(), selectAperture(), GBR_METADATA::SetApertureAttrib(), PLOTTER::sketchOval(), ThickSegment(), PLOTTER::userToDeviceCoordinates(), wxPoint::x, and wxPoint::y.

Referenced by GERBER_WRITER::createDrillFile().

650 {
651  wxASSERT( outputFile );
652  int x0, y0, x1, y1, delta;
653  wxSize size( aSize );
654  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
655 
656  /* Plot a flashed shape. */
657  if( ( orient == 0 || orient == 900 || orient == 1800 || orient == 2700 )
658  && trace_mode == FILLED )
659  {
660  if( orient == 900 || orient == 2700 ) /* orientation turned 90 deg. */
661  std::swap( size.x, size.y );
662 
663  DPOINT pos_dev = userToDeviceCoordinates( pos );
664  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
665  selectAperture( size, APERTURE::Oval, aperture_attrib );
666 
667  if( gbr_metadata )
668  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
669 
670  emitDcode( pos_dev, 3 );
671  }
672  else /* Plot pad as a segment. */
673  {
674  if( size.x > size.y )
675  {
676  std::swap( size.x, size.y );
677 
678  if( orient < 2700 )
679  orient += 900;
680  else
681  orient -= 2700;
682  }
683 
684  if( trace_mode == FILLED )
685  {
686  // TODO: use an aperture macro to declare the rotated pad
687  //
688 
689  // Flash a pad anchor, if a netlist attribute is set
690  if( aData )
691  FlashPadCircle( pos, size.x, trace_mode, aData );
692 
693  // The pad is reduced to an segment with dy > dx
694  delta = size.y - size.x;
695  x0 = 0;
696  y0 = -delta / 2;
697  x1 = 0;
698  y1 = delta / 2;
699  RotatePoint( &x0, &y0, orient );
700  RotatePoint( &x1, &y1, orient );
701  GBR_METADATA metadata;
702 
703  if( gbr_metadata )
704  {
705  metadata = *gbr_metadata;
706 
707  // If the pad is drawn on a copper layer,
708  // set attribute to GBR_APERTURE_ATTRIB_CONDUCTOR
709  if( metadata.IsCopper() )
711 
712  // Clear .P attribute, only allowed for flashed items
713  wxString attrname( ".P" );
714  metadata.m_NetlistMetadata.ClearAttribute( &attrname );
715  }
716 
717  ThickSegment( wxPoint( pos.x + x0, pos.y + y0 ),
718  wxPoint( pos.x + x1, pos.y + y1 ),
719  size.x, trace_mode, &metadata );
720  }
721  else
722  {
723  sketchOval( pos, size, orient, -1 );
724  }
725  }
726 }
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData) override
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
bool IsCopper()
Allowed attributes are not the same on board copper layers and on other layers Therefore a flag can b...
void selectAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
static const int delta[8][2]
Definition: solve.cpp:112
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate (fo...
virtual void FlashPadCircle(const wxPoint &pos, int diametre, EDA_DRAW_MODE_T trace_mode, void *aData) override
Filled circular flashes are stored as apertures.
aperture used for connected items like tracks (not vias)
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
void ClearAttribute(const wxString *aName)
remove the net attribute specified by aName If aName == NULL or empty, remove all attributes ...
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
void sketchOval(const wxPoint &pos, const wxSize &size, double orient, int width)
void GERBER_PLOTTER::FlashPadRect ( const wxPoint pos,
const wxSize &  size,
double  orient,
EDA_DRAW_MODE_T  trace_mode,
void *  aData 
)
overridevirtual

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

Implements PLOTTER.

Definition at line 729 of file common_plotGERBER_functions.cpp.

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

732 {
733  wxASSERT( outputFile );
734  wxSize size( aSize );
735  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
736 
737  // Plot as an aperture flash
738  switch( int( orient ) )
739  {
740  case 900:
741  case 2700: // rotation of 90 degrees or 270 swaps sizes
742  std::swap( size.x, size.y );
743 
744  // Pass through
745  case 0:
746  case 1800:
747  if( trace_mode == SKETCH )
748  {
750 
751  if( gbr_metadata )
752  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
753 
754  Rect( wxPoint( pos.x - (size.x - currentPenWidth) / 2,
755  pos.y - (size.y - currentPenWidth) / 2 ),
756  wxPoint( pos.x + (size.x - currentPenWidth) / 2,
757  pos.y + (size.y - currentPenWidth) / 2 ),
758  NO_FILL );
759  }
760  else
761  {
762  DPOINT pos_dev = userToDeviceCoordinates( pos );
763  int aperture_attrib = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
764  selectAperture( size, APERTURE::Rect, aperture_attrib );
765 
766  if( gbr_metadata )
767  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
768 
769  emitDcode( pos_dev, 3 );
770  }
771  break;
772 
773  default: // plot pad shape as polygon
774  {
775  // XXX to do: use an aperture macro to declare the rotated pad
776  wxPoint coord[4];
777  // coord[0] is assumed the lower left
778  // coord[1] is assumed the upper left
779  // coord[2] is assumed the upper right
780  // coord[3] is assumed the lower right
781 
782  /* Trace the outline. */
783  coord[0].x = -size.x/2; // lower left
784  coord[0].y = size.y/2;
785  coord[1].x = -size.x/2; // upper left
786  coord[1].y = -size.y/2;
787  coord[2].x = size.x/2; // upper right
788  coord[2].y = -size.y/2;
789  coord[3].x = size.x/2; // lower right
790  coord[3].y = size.y/2;
791 
792  FlashPadTrapez( pos, coord, orient, trace_mode, aData );
793  }
794  break;
795  }
796 }
virtual void FlashPadTrapez(const wxPoint &aPadPos, const wxPoint *aCorners, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
Trapezoidal pad at the moment are never handled as aperture, since they require aperture macros TODO:...
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
void selectAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate (fo...
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
int currentPenWidth
Definition: plot_common.h:537
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
void GERBER_PLOTTER::FlashPadRoundRect ( const wxPoint aPadPos,
const wxSize &  aSize,
int  aCornerRadius,
double  aOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtual

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

Implements PLOTTER.

Definition at line 798 of file common_plotGERBER_functions.cpp.

References GBR_NETLIST_METADATA::ClearAttribute(), FILLED, FILLED_SHAPE, FlashPadCircle(), GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_METADATA::IsCopper(), GBR_METADATA::m_NetlistMetadata, min, NO_FILL, SHAPE_POLY_SET::Outline(), PlotPoly(), SHAPE_LINE_CHAIN::Point(), SHAPE_LINE_CHAIN::PointCount(), GBR_METADATA::SetApertureAttrib(), TransformRoundRectToPolygon(), PLOTTER::USE_DEFAULT_LINE_WIDTH, VECTOR2< T >::x, and VECTOR2< T >::y.

802 {
803  // Currently, a Pad RoundRect is plotted as polygon.
804  // TODO: use Aperture macro and flash it
805  SHAPE_POLY_SET outline;
806  const int segmentToCircleCount = 64;
807  TransformRoundRectToPolygon( outline, aPadPos, aSize, aOrient,
808  aCornerRadius, segmentToCircleCount );
809 
810  std::vector< wxPoint > cornerList;
811  cornerList.reserve( segmentToCircleCount + 5 );
812  // TransformRoundRectToPolygon creates only one convex polygon
813  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
814 
815  for( int ii = 0; ii < poly.PointCount(); ++ii )
816  cornerList.push_back( wxPoint( poly.Point( ii ).x, poly.Point( ii ).y ) );
817 
818  // Close polygon
819  cornerList.push_back( cornerList[0] );
820 
821  GBR_METADATA gbr_metadata;
822 
823  if( aData )
824  {
825  gbr_metadata = *static_cast<GBR_METADATA*>( aData );
826  // If the pad is drawn on a copper layer,
827  // set attribute to GBR_APERTURE_ATTRIB_CONDUCTOR
828  if( gbr_metadata.IsCopper() )
830 
831  wxString attrname( ".P" );
832  gbr_metadata.m_NetlistMetadata.ClearAttribute( &attrname ); // not allowed on inner layers
833  }
834 
835  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL, USE_DEFAULT_LINE_WIDTH, &gbr_metadata );
836 
837  // Now, flash a pad anchor, if a netlist attribute is set
838  // (remove me when a Aperture macro will be used)
839  if( aData && aTraceMode == FILLED )
840  {
841  int diameter = std::min( aSize.x, aSize.y );
842  FlashPadCircle( aPadPos, diameter, aTraceMode , aData );
843  }
844 }
int PointCount() const
Function PointCount()
void TransformRoundRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, int aCircleToSegmentsCount)
Function TransformRoundRectToPolygon convert a rectangle with rounded corners to a polygon Convert ar...
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL) override
Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence.
bool IsCopper()
Allowed attributes are not the same on board copper layers and on other layers Therefore a flag can b...
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
Class SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
virtual void FlashPadCircle(const wxPoint &pos, int diametre, EDA_DRAW_MODE_T trace_mode, void *aData) override
Filled circular flashes are stored as apertures.
aperture used for connected items like tracks (not vias)
Class SHAPE_LINE_CHAIN.
void ClearAttribute(const wxString *aName)
remove the net attribute specified by aName If aName == NULL or empty, remove all attributes ...
VECTOR2I & Point(int aIndex)
Function Point()
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
#define min(a, b)
Definition: auxiliary.h:85
void GERBER_PLOTTER::FlashPadTrapez ( const wxPoint aPadPos,
const wxPoint aCorners,
double  aPadOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtual

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

Implements PLOTTER.

Definition at line 890 of file common_plotGERBER_functions.cpp.

References GBR_NETLIST_METADATA::ClearAttribute(), dist, FILLED, FILLED_SHAPE, FlashPadCircle(), GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB_CONDUCTOR, GBR_METADATA::IsCopper(), SEG::LineDistance(), GBR_METADATA::m_NetlistMetadata, min, NO_FILL, PlotPoly(), RotatePoint(), GBR_METADATA::SetApertureAttrib(), SetCurrentLineWidth(), and PLOTTER::USE_DEFAULT_LINE_WIDTH.

Referenced by FlashPadRect().

893 {
894  // Currently, a Pad Trapezoid is plotted as polygon.
895  // TODO: use Aperture macro and flash it
896 
897  // polygon corners list
898  std::vector< wxPoint > cornerList;
899 
900  for( int ii = 0; ii < 4; ii++ )
901  cornerList.push_back( aCorners[ii] );
902 
903  // Now, flash a pad anchor, if a netlist attribute is set
904  // (remove me when a Aperture macro will be used)
905  if( aData && (aTrace_Mode==FILLED) )
906  {
907  // Calculate the radius of the circle inside the shape
908  // It is the smaller dist from shape pos to edges
909  int radius = INT_MAX;
910 
911  for( unsigned ii = 0, jj = cornerList.size()-1; ii < cornerList.size();
912  jj = ii, ii++ )
913  {
914  SEG segment( aCorners[ii], aCorners[jj] );
915  int dist = segment.LineDistance( VECTOR2I( 0, 0) );
916  radius = std::min( radius, dist );
917  }
918 
919  FlashPadCircle( aPadPos, radius*2, aTrace_Mode, aData );
920  }
921 
922  // Draw the polygon and fill the interior as required
923  for( unsigned ii = 0; ii < 4; ii++ )
924  {
925  RotatePoint( &cornerList[ii], aPadOrient );
926  cornerList[ii] += aPadPos;
927  }
928 
929  // Close the polygon
930  cornerList.push_back( cornerList[0] );
931  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
932 
933  GBR_METADATA metadata;
934 
935  if( gbr_metadata )
936  {
937  metadata = *gbr_metadata;
938  // If the pad is drawn on a copper layer,
939  // set attribute to GBR_APERTURE_ATTRIB_CONDUCTOR
940  if( metadata.IsCopper() )
942 
943  wxString attrname( ".P" );
944  metadata.m_NetlistMetadata.ClearAttribute( &attrname ); // not allowed on inner layers
945  }
946 
948  PlotPoly( cornerList, aTrace_Mode==FILLED ? FILLED_SHAPE : NO_FILL, USE_DEFAULT_LINE_WIDTH, &metadata );
949 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL) override
Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence.
static const int dist[10][10]
Definition: dist.cpp:57
bool IsCopper()
Allowed attributes are not the same on board copper layers and on other layers Therefore a flag can b...
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
VECTOR2< int > VECTOR2I
Definition: vector2d.h:590
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
virtual void FlashPadCircle(const wxPoint &pos, int diametre, EDA_DRAW_MODE_T trace_mode, void *aData) override
Filled circular flashes are stored as apertures.
aperture used for connected items like tracks (not vias)
Definition: seg.h:37
void ClearAttribute(const wxString *aName)
remove the net attribute specified by aName If aName == NULL or empty, remove all attributes ...
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
#define min(a, b)
Definition: auxiliary.h:85
void GERBER_PLOTTER::formatNetAttribute ( GBR_NETLIST_METADATA aData)
protected

print a Gerber net attribute object record.

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

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

Definition at line 136 of file common_plotGERBER_functions.cpp.

References clearNetAttribute(), FormatNetAttribute(), m_objectAttributesDictionnary, m_useNetAttributes, m_useX2Attributes, and PLOTTER::outputFile.

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

137 {
138  // print a Gerber net attribute record.
139  // it is added to the object attributes dictionnary
140  // On file, only modified or new attributes are printed.
141  if( aData == NULL || !m_useX2Attributes || !m_useNetAttributes )
142  return;
143 
144  bool clearDict;
145  std::string short_attribute_string;
146 
147  if( !FormatNetAttribute( short_attribute_string, m_objectAttributesDictionnary,
148  aData, clearDict ) )
149  return;
150 
151  if( clearDict )
153 
154  if( !short_attribute_string.empty() )
155  fputs( short_attribute_string.c_str(), outputFile );
156 }
void clearNetAttribute()
clear a Gerber net attribute record (clear object attribute dictionnary) and output the clear object ...
bool m_useNetAttributes
Definition: plot_common.h:1200
bool FormatNetAttribute(std::string &aPrintedText, std::string &aLastNetAttributes, GBR_NETLIST_METADATA *aData, bool &aClearPreviousAttributes)
Generates the string to print to a gerber file, to set a net attribute for a graphic object...
bool m_useX2Attributes
Definition: plot_common.h:1198
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
std::string m_objectAttributesDictionnary
Definition: plot_common.h:1178
std::vector< APERTURE >::iterator GERBER_PLOTTER::getAperture ( const wxSize &  aSize,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
protected

Function getAperture returns a reference to the aperture which meets the size anf type of tool if the aperture does not exist, it is created and entered in aperture list.

Parameters
aSize= the size of tool
aType= the type ( shape ) of tool
aApertureAttribute= an aperture attribute of the tool (a tool can have onlu one attribute) 0 = no specific attribute

Definition at line 281 of file common_plotGERBER_functions.cpp.

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

Referenced by selectAperture().

283 {
284  int last_D_code = 9;
285 
286  // Search an existing aperture
287  std::vector<APERTURE>::iterator tool = apertures.begin();
288 
289  while( tool != apertures.end() )
290  {
291  last_D_code = tool->m_DCode;
292 
293  if( (tool->m_Type == aType) && (tool->m_Size == aSize) && (tool->m_ApertureAttribute == aApertureAttribute) )
294  return tool;
295 
296  ++tool;
297  }
298 
299  // Allocate a new aperture
300  APERTURE new_tool;
301  new_tool.m_Size = aSize;
302  new_tool.m_Type = aType;
303  new_tool.m_DCode = last_D_code + 1;
304  new_tool.m_ApertureAttribute = aApertureAttribute;
305 
306  apertures.push_back( new_tool );
307 
308  return apertures.end() - 1;
309 }
APERTURE_TYPE m_Type
Definition: plot_common.h:977
wxSize m_Size
Definition: plot_common.h:976
std::vector< APERTURE > apertures
Definition: plot_common.h:1192
int m_DCode
Definition: plot_common.h:978
int m_ApertureAttribute
Definition: plot_common.h:979
bool PLOTTER::GetColorMode ( ) const
inlineinherited

Definition at line 121 of file plot_common.h.

References PLOTTER::colorMode.

Referenced by PLOT_CONTROLLER::GetColorMode(), LIB_TEXT::Plot(), LIB_PART::Plot(), LIB_PART::PlotLibFields(), and PlotWorkSheet().

122  {
123  return colorMode;
124  }
bool colorMode
Definition: plot_common.h:534
double PLOTTER::GetDashGapLenIU ( ) const
protectedinherited

Definition at line 141 of file class_plotter.cpp.

References PLOTTER::GetCurrentLineWidth(), PLOTTER::m_dashGapLength_mm, PLOTTER::m_IUsPerDecimil, and PLOTTER::userToDeviceSize().

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

142 {
144 }
double m_IUsPerDecimil
Definition: plot_common.h:516
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT) ...
double m_dashGapLength_mm
Dashed line parameter in mm: gap.
Definition: plot_common.h:90
virtual int GetCurrentLineWidth() const
Definition: plot_common.h:142
double PLOTTER::GetDashMarkLenIU ( ) const
protectedinherited

Definition at line 134 of file class_plotter.cpp.

References PLOTTER::GetCurrentLineWidth(), PLOTTER::m_dashMarkLength_mm, PLOTTER::m_IUsPerDecimil, and PLOTTER::userToDeviceSize().

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

135 {
137  return ( mark < 0.0 ) ? 0.0 : mark;
138 }
double m_IUsPerDecimil
Definition: plot_common.h:516
double m_dashMarkLength_mm
Dashed line parameter in mm: segment.
Definition: plot_common.h:89
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT) ...
virtual int GetCurrentLineWidth() const
Definition: plot_common.h:142
static wxString GERBER_PLOTTER::GetDefaultFileExtension ( )
inlinestatic

Definition at line 995 of file plot_common.h.

Referenced by GetDefaultPlotExtension().

996  {
997  return wxString( wxT( "gbr" ) );
998  }
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 207 of file plot_common.h.

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotWorkSheet().

207 { return m_IUsPerDecimil; }
double m_IUsPerDecimil
Definition: plot_common.h:516
virtual PlotFormat 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 990 of file plot_common.h.

References PLOT_FORMAT_GERBER.

991  {
992  return PLOT_FORMAT_GERBER;
993  }
void PLOTTER::LineTo ( const wxPoint pos)
inlineinherited

Definition at line 236 of file plot_common.h.

References PLOTTER::PenTo().

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

237  {
238  PenTo( pos, 'D' );
239  }
virtual void PenTo(const wxPoint &pos, char plume)=0
moveto/lineto primitive, moves the 'pen' to the specified direction
void PLOTTER::Marker ( const wxPoint position,
int  diametre,
unsigned  aShapeId 
)
inherited

Draw a pattern shape number aShapeId, to coord position.

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

Definition at line 273 of file class_plotter.cpp.

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

274 {
275  int radius = diametre / 2;
276  /* Marker are composed by a series of 'parts' superimposed; not every
277  combination make sense, obviously. Since they are used in order I
278  tried to keep the uglier/more complex constructions at the end.
279  Also I avoided the |/ |\ -/ -\ construction because they're *very*
280  ugly... if needed they could be added anyway... I'd like to see
281  a board with more than 58 drilling/slotting tools!
282  If Visual C++ supported the 0b literals they would be optimally
283  and easily encoded as an integer array. We have to do with octal */
284  static const unsigned char marker_patterns[MARKER_COUNT] = {
285  // Bit order: O Square Lozenge - | \ /
286  // First choice: simple shapes
287  0003, // X
288  0100, // O
289  0014, // +
290  0040, // Sq
291  0020, // Lz
292  // Two simple shapes
293  0103, // X O
294  0017, // X +
295  0043, // X Sq
296  0023, // X Lz
297  0114, // O +
298  0140, // O Sq
299  0120, // O Lz
300  0054, // + Sq
301  0034, // + Lz
302  0060, // Sq Lz
303  // Three simple shapes
304  0117, // X O +
305  0143, // X O Sq
306  0123, // X O Lz
307  0057, // X + Sq
308  0037, // X + Lz
309  0063, // X Sq Lz
310  0154, // O + Sq
311  0134, // O + Lz
312  0074, // + Sq Lz
313  // Four simple shapes
314  0174, // O Sq Lz +
315  0163, // X O Sq Lz
316  0157, // X O Sq +
317  0137, // X O Lz +
318  0077, // X Sq Lz +
319  // This draws *everything *
320  0177, // X O Sq Lz +
321  // Here we use the single bars... so the cross is forbidden
322  0110, // O -
323  0104, // O |
324  0101, // O /
325  0050, // Sq -
326  0044, // Sq |
327  0041, // Sq /
328  0030, // Lz -
329  0024, // Lz |
330  0021, // Lz /
331  0150, // O Sq -
332  0144, // O Sq |
333  0141, // O Sq /
334  0130, // O Lz -
335  0124, // O Lz |
336  0121, // O Lz /
337  0070, // Sq Lz -
338  0064, // Sq Lz |
339  0061, // Sq Lz /
340  0170, // O Sq Lz -
341  0164, // O Sq Lz |
342  0161, // O Sq Lz /
343  // Last resort: the backlash component (easy to confound)
344  0102, // \ O
345  0042, // \ Sq
346  0022, // \ Lz
347  0142, // \ O Sq
348  0122, // \ O Lz
349  0062, // \ Sq Lz
350  0162 // \ O Sq Lz
351  };
352  if( aShapeId >= MARKER_COUNT )
353  {
354  // Fallback shape
355  markerCircle( position, radius );
356  }
357  else
358  {
359  // Decode the pattern and draw the corresponding parts
360  unsigned char pat = marker_patterns[aShapeId];
361  if( pat & 0001 )
362  markerSlash( position, radius );
363  if( pat & 0002 )
364  markerBackSlash( position, radius );
365  if( pat & 0004 )
366  markerVBar( position, radius );
367  if( pat & 0010 )
368  markerHBar( position, radius );
369  if( pat & 0020 )
370  markerLozenge( position, radius );
371  if( pat & 0040 )
372  markerSquare( position, radius );
373  if( pat & 0100 )
374  markerCircle( position, radius );
375  }
376 }
void markerHBar(const wxPoint &pos, int radius)
Plot a - bar centered on the position.
static const unsigned MARKER_COUNT
Draw a marker (used for the drill map)
Definition: plot_common.h:380
void markerSlash(const wxPoint &pos, int radius)
Plot a / bar centered on the position.
void markerLozenge(const wxPoint &position, int radius)
Plot a lozenge centered on the position.
void markerCircle(const wxPoint &pos, int radius)
Plot a circle centered on the position.
void markerVBar(const wxPoint &pos, int radius)
Plot a | bar centered on the position.
void markerSquare(const wxPoint &position, int radius)
Plot a square centered on the position.
void markerBackSlash(const wxPoint &pos, int radius)
Plot a \ bar centered on the position.
void PLOTTER::markerBackSlash ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a \ bar centered on the position.

Building block for markers

Definition at line 259 of file class_plotter.cpp.

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

Referenced by PLOTTER::Marker().

260 {
261  MoveTo( wxPoint( pos.x + radius, pos.y - radius ) );
262  FinishTo( wxPoint( pos.x - radius, pos.y + radius ) );
263 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
void PLOTTER::markerCircle ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a circle centered on the position.

Building block for markers

Definition at line 215 of file class_plotter.cpp.

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

Referenced by PLOTTER::Marker().

216 {
217  Circle( position, radius * 2, NO_FILL, GetCurrentLineWidth() );
218 }
virtual int GetCurrentLineWidth() const
Definition: plot_common.h:142
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
void PLOTTER::markerHBar ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a - bar centered on the position.

Building block for markers

Definition at line 245 of file class_plotter.cpp.

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

Referenced by PLOTTER::Marker().

246 {
247  MoveTo( wxPoint( pos.x - radius, pos.y ) );
248  FinishTo( wxPoint( pos.x + radius, pos.y ) );
249 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
void PLOTTER::markerLozenge ( const wxPoint position,
int  radius 
)
protectedinherited

Plot a lozenge centered on the position.

Building block for markers

Definition at line 221 of file class_plotter.cpp.

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

Referenced by PLOTTER::Marker().

222 {
223  std::vector< wxPoint > corner_list;
224  wxPoint corner;
225  corner.x = position.x;
226  corner.y = position.y + radius;
227  corner_list.push_back( corner );
228  corner.x = position.x + radius;
229  corner.y = position.y,
230  corner_list.push_back( corner );
231  corner.x = position.x;
232  corner.y = position.y - radius;
233  corner_list.push_back( corner );
234  corner.x = position.x - radius;
235  corner.y = position.y;
236  corner_list.push_back( corner );
237  corner.x = position.x;
238  corner.y = position.y + radius;
239  corner_list.push_back( corner );
240 
241  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
242 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
virtual int GetCurrentLineWidth() const
Definition: plot_common.h:142
void PLOTTER::markerSlash ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a / bar centered on the position.

Building block for markers

Definition at line 252 of file class_plotter.cpp.

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

Referenced by PLOTTER::Marker().

253 {
254  MoveTo( wxPoint( pos.x - radius, pos.y - radius ) );
255  FinishTo( wxPoint( pos.x + radius, pos.y + radius ) );
256 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
void PLOTTER::markerSquare ( const wxPoint position,
int  radius 
)
protectedinherited

Plot a square centered on the position.

Building block for markers

Definition at line 190 of file class_plotter.cpp.

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

Referenced by PLOTTER::Marker().

191 {
192  double r = KiROUND( radius / 1.4142 );
193  std::vector< wxPoint > corner_list;
194  wxPoint corner;
195  corner.x = position.x + r;
196  corner.y = position.y + r;
197  corner_list.push_back( corner );
198  corner.x = position.x + r;
199  corner.y = position.y - r;
200  corner_list.push_back( corner );
201  corner.x = position.x - r;
202  corner.y = position.y - r;
203  corner_list.push_back( corner );
204  corner.x = position.x - r;
205  corner.y = position.y + r;
206  corner_list.push_back( corner );
207  corner.x = position.x + r;
208  corner.y = position.y + r;
209  corner_list.push_back( corner );
210 
211  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
212 }
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
virtual int GetCurrentLineWidth() const
Definition: plot_common.h:142
void PLOTTER::markerVBar ( const wxPoint pos,
int  radius 
)
protectedinherited

Plot a | bar centered on the position.

Building block for markers

Definition at line 266 of file class_plotter.cpp.

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

Referenced by PLOTTER::Marker().

267 {
268  MoveTo( wxPoint( pos.x, pos.y - radius ) );
269  FinishTo( wxPoint( pos.x, pos.y + radius ) );
270 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
bool PLOTTER::OpenFile ( const wxString &  aFullFilename)
virtualinherited

Open or create the plot file aFullFilename.

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

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

Reimplemented in PDF_PLOTTER.

Definition at line 79 of file class_plotter.cpp.

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

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

80 {
81  filename = aFullFilename;
82 
83  wxASSERT( !outputFile );
84 
85  // Open the file in text mode (not suitable for all plotters
86  // but only for most of them
87  outputFile = wxFopen( filename, wxT( "wt" ) );
88 
89  if( outputFile == NULL )
90  return false ;
91 
92  return true;
93 }
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
wxString filename
Definition: plot_common.h:543
void PLOTTER::PenFinish ( )
inlineinherited

Definition at line 247 of file plot_common.h.

References PLOTTER::PenTo().

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

248  {
249  // The point is not important with Z motion
250  PenTo( wxPoint( 0, 0 ), 'Z' );
251  }
virtual void PenTo(const wxPoint &pos, char plume)=0
moveto/lineto primitive, moves the 'pen' to the specified direction
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 404 of file common_plotGERBER_functions.cpp.

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

405 {
406  wxASSERT( outputFile );
407  DPOINT pos_dev = userToDeviceCoordinates( aPos );
408 
409  switch( plume )
410  {
411  case 'Z':
412  break;
413 
414  case 'U':
415  emitDcode( pos_dev, 2 );
416  break;
417 
418  case 'D':
419  emitDcode( pos_dev, 1 );
420  }
421 
422  penState = plume;
423 }
char penState
Current pen state: 'U', 'D' or 'Z' (see PenTo)
Definition: plot_common.h:539
void emitDcode(const DPOINT &pt, int dcode)
Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate (fo...
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
void PLOTTER::PlotImage ( const wxImage &  aImage,
const wxPoint aPos,
double  aScaleFactor 
)
virtualinherited

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

Draw an image bitmap

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

Reimplemented in SVG_PLOTTER, PDF_PLOTTER, and PS_PLOTTER.

Definition at line 173 of file class_plotter.cpp.

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

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

174 {
175  wxSize size( aImage.GetWidth() * aScaleFactor,
176  aImage.GetHeight() * aScaleFactor );
177 
178  wxPoint start = aPos;
179  start.x -= size.x / 2;
180  start.y -= size.y / 2;
181 
182  wxPoint end = start;
183  end.x += size.x;
184  end.y += size.y;
185 
186  Rect( start, end, NO_FILL );
187 }
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
void GERBER_PLOTTER::PlotPoly ( const std::vector< wxPoint > &  aCornerList,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = NULL 
)
overridevirtual

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

Implements PLOTTER.

Definition at line 478 of file common_plotGERBER_functions.cpp.

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

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

480 {
481  if( aCornerList.size() <= 1 )
482  return;
483 
484  // Gerber format does not know filled polygons with thick outline
485  // Therefore, to plot a filled polygon with outline having a thickness,
486  // one should plot outline as thick segments
487  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
488 
489  SetCurrentLineWidth( aWidth, gbr_metadata );
490 
491  if( gbr_metadata )
492  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
493 
494  if( aFill )
495  {
496  fputs( "G36*\n", outputFile );
497 
498  MoveTo( aCornerList[0] );
499 
500  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
501  LineTo( aCornerList[ii] );
502 
503  FinishTo( aCornerList[0] );
504  fputs( "G37*\n", outputFile );
505  }
506 
507  if( aWidth > 0 )
508  {
509  MoveTo( aCornerList[0] );
510 
511  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
512  LineTo( aCornerList[ii] );
513 
514  // Ensure the thick outline is closed for filled polygons
515  // (if not filled, could be only a polyline)
516  if( aFill && ( aCornerList[aCornerList.size()-1] != aCornerList[0] ) )
517  LineTo( aCornerList[0] );
518 
519  PenFinish();
520  }
521 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
void PenFinish()
Definition: plot_common.h:247
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
void LineTo(const wxPoint &pos)
Definition: plot_common.h:236
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
void GERBER_PLOTTER::Rect ( const wxPoint p1,
const wxPoint p2,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Implements PLOTTER.

Definition at line 426 of file common_plotGERBER_functions.cpp.

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

Referenced by FlashPadRect(), and ThickRect().

427 {
428  std::vector< wxPoint > cornerList;
429 
430  // Build corners list
431  cornerList.push_back( p1 );
432  wxPoint corner(p1.x, p2.y);
433  cornerList.push_back( corner );
434  cornerList.push_back( p2 );
435  corner.x = p2.x;
436  corner.y = p1.y;
437  cornerList.push_back( corner );
438  cornerList.push_back( p1 );
439 
440  PlotPoly( cornerList, fill, width );
441 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL) override
Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence.
void PLOTTER::segmentAsOval ( const wxPoint start,
const wxPoint end,
int  width,
EDA_DRAW_MODE_T  tracemode 
)
protectedinherited

Cdonvert a thick segment and plot it as an oval.

Definition at line 379 of file class_plotter.cpp.

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

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

381 {
382  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
383  wxSize size( end.x - start.x, end.y - start.y );
384  double orient;
385 
386  if( size.y == 0 )
387  orient = 0;
388  else if( size.x == 0 )
389  orient = 900;
390  else
391  orient = -ArcTangente( size.y, size.x );
392 
393  size.x = KiROUND( EuclideanNorm( size ) ) + width;
394  size.y = width;
395 
396  FlashPadOval( center, size, orient, tracemode, NULL );
397 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:104
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:271
virtual void FlashPadOval(const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
virtual function FlashPadOval
void GERBER_PLOTTER::selectAperture ( const wxSize &  aSize,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
protected

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

write the DCode selection on gerber file

Definition at line 312 of file common_plotGERBER_functions.cpp.

References apertures, currentAperture, getAperture(), m_useNetAttributes, m_useX2Attributes, and PLOTTER::outputFile.

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

315 {
316  bool change = ( currentAperture == apertures.end() ) ||
317  ( currentAperture->m_Type != aType ) ||
318  ( currentAperture->m_Size != aSize );
319 
321  aApertureAttribute = 0;
322  else
323  change = change || ( currentAperture->m_ApertureAttribute != aApertureAttribute );
324 
325  if( change )
326  {
327  // Pick an existing aperture or create a new one
328  currentAperture = getAperture( aSize, aType, aApertureAttribute );
329  fprintf( outputFile, "D%d*\n", currentAperture->m_DCode );
330  }
331 }
std::vector< APERTURE >::iterator getAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Function getAperture returns a reference to the aperture which meets the size anf type of tool if the...
bool m_useNetAttributes
Definition: plot_common.h:1200
std::vector< APERTURE > apertures
Definition: plot_common.h:1192
bool m_useX2Attributes
Definition: plot_common.h:1198
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
std::vector< APERTURE >::iterator currentAperture
Definition: plot_common.h:1193
virtual void GERBER_PLOTTER::SetColor ( COLOR4D  color)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 1012 of file plot_common.h.

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

Set the line width for the next drawing.

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

Implements PLOTTER.

Definition at line 261 of file common_plotGERBER_functions.cpp.

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

Referenced by Arc(), FlashPadCircle(), FlashPadRect(), FlashPadTrapez(), PlotPoly(), ThickArc(), ThickCircle(), ThickRect(), and ThickSegment().

262 {
263  if( width == DO_NOT_SET_LINE_WIDTH )
264  return;
265 
266  int pen_width;
267 
268  if( width > 0 )
269  pen_width = width;
270  else
271  pen_width = defaultPenWidth;
272 
273  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
274  int aperture_attribute = gbr_metadata ? gbr_metadata->GetApertureAttrib() : 0;
275 
276  selectAperture( wxSize( pen_width, pen_width ), APERTURE::Plotting, aperture_attribute );
277  currentPenWidth = pen_width;
278 }
void selectAperture(const wxSize &aSize, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
Pick an existing aperture or create a new one, matching the size, type and attributes.
GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
int currentPenWidth
Definition: plot_common.h:537
int defaultPenWidth
true to generate a negative image (PS mode mainly)
Definition: plot_common.h:536
static const int DO_NOT_SET_LINE_WIDTH
Definition: plot_common.h:94
virtual void GERBER_PLOTTER::SetDash ( bool  dashed)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 1011 of file plot_common.h.

1011 {}
void GERBER_PLOTTER::SetDefaultLineWidth ( int  width)
overridevirtual

Set the default line width.

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

Parameters
widthis specified in IUs

Implements PLOTTER.

Definition at line 254 of file common_plotGERBER_functions.cpp.

References apertures, currentAperture, and PLOTTER::defaultPenWidth.

Referenced by SetViewport().

255 {
256  defaultPenWidth = width;
257  currentAperture = apertures.end();
258 }
std::vector< APERTURE > apertures
Definition: plot_common.h:1192
int defaultPenWidth
true to generate a negative image (PS mode mainly)
Definition: plot_common.h:536
std::vector< APERTURE >::iterator currentAperture
Definition: plot_common.h:1193
void GERBER_PLOTTER::SetGerberCoordinatesFormat ( int  aResolution,
bool  aUseInches = false 
)
overridevirtual

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

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

Should be called only after SetViewport() is called

Reimplemented from PLOTTER.

Definition at line 89 of file common_plotGERBER_functions.cpp.

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

Referenced by GERBER_WRITER::createDrillFile().

90 {
91  m_gerberUnitInch = aUseInches;
92  m_gerberUnitFmt = aResolution;
93 
94  iuPerDeviceUnit = pow( 10.0, m_gerberUnitFmt ) / ( m_IUsPerDecimil * 10000.0 );
95 
96  if( ! m_gerberUnitInch )
97  iuPerDeviceUnit *= 25.4; // gerber output in mm
98 }
double m_IUsPerDecimil
Definition: plot_common.h:516
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plot_common.h:519
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 968 of file common_plotGERBER_functions.cpp.

References PLOTTER::outputFile.

969 {
970  if( aPositive )
971  fprintf( outputFile, "%%LPD*%%\n" );
972  else
973  fprintf( outputFile, "%%LPC*%%\n" );
974 }
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
virtual void PLOTTER::SetNegative ( bool  _negative)
inlinevirtualinherited

Definition at line 111 of file plot_common.h.

References PLOTTER::negativeMode.

Referenced by FillNegativeKnockout().

112  {
113  negativeMode = _negative;
114  }
bool negativeMode
true to plot in color, false to plot in black and white
Definition: plot_common.h:535
virtual void PLOTTER::SetTextMode ( PlotTextMode  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 407 of file plot_common.h.

Referenced by initializePlotter(), and PlotOneBoardLayer().

408  {
409  // NOP for most plotters.
410  }
virtual void PLOTTER::SetTitle ( const wxString &  aTitle)
inlinevirtualinherited

Definition at line 156 of file plot_common.h.

References PLOTTER::title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

157  {
158  title = aTitle;
159  }
wxString title
Definition: plot_common.h:544
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 67 of file common_plotGERBER_functions.cpp.

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

Referenced by GERBER_WRITER::createDrillFile().

69 {
70  wxASSERT( aMirror == false );
71  m_plotMirror = false;
72  plotOffset = aOffset;
73  wxASSERT( aScale == 1 ); // aScale parameter is not used in Gerber
74  plotScale = 1; // Plot scale is *always* 1.0
75 
76  m_IUsPerDecimil = aIusPerDecimil;
77  // gives now a default value to iuPerDeviceUnit (because the units of the caller is now known)
78  // which could be modified later by calling SetGerberCoordinatesFormat()
79  iuPerDeviceUnit = pow( 10.0, m_gerberUnitFmt ) / ( m_IUsPerDecimil * 10000.0 );
80 
81  // We don't handle the filmbox, and it's more useful to keep the
82  // origin at the origin
83  paperSize.x = 0;
84  paperSize.y = 0;
85  SetDefaultLineWidth( 100 * aIusPerDecimil ); // Arbitrary default
86 }
virtual void SetDefaultLineWidth(int width) override
Set the default line width.
double m_IUsPerDecimil
Definition: plot_common.h:516
wxPoint plotOffset
Plot offset (in IUs)
Definition: plot_common.h:522
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plot_common.h:526
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plot_common.h:510
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plot_common.h:519
wxSize paperSize
Paper size in IU - not in mils.
Definition: plot_common.h:547
void PLOTTER::sketchOval ( const wxPoint pos,
const wxSize &  size,
double  orient,
int  width 
)
protectedinherited

Definition at line 400 of file class_plotter.cpp.

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

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

401 {
402  SetCurrentLineWidth( width );
403  width = currentPenWidth;
404  int radius, deltaxy, cx, cy;
405  wxSize size( aSize );
406 
407  if( size.x > size.y )
408  {
409  std::swap( size.x, size.y );
410  orient = AddAngles( orient, 900 );
411  }
412 
413  deltaxy = size.y - size.x; /* distance between centers of the oval */
414  radius = ( size.x - width ) / 2;
415  cx = -radius;
416  cy = -deltaxy / 2;
417  RotatePoint( &cx, &cy, orient );
418  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
419  cx = -radius;
420  cy = deltaxy / 2;
421  RotatePoint( &cx, &cy, orient );
422  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
423 
424  cx = radius;
425  cy = -deltaxy / 2;
426  RotatePoint( &cx, &cy, orient );
427  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
428  cx = radius;
429  cy = deltaxy / 2;
430  RotatePoint( &cx, &cy, orient );
431  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
432 
433  cx = 0;
434  cy = deltaxy / 2;
435  RotatePoint( &cx, &cy, orient );
436  Arc( wxPoint( cx + pos.x, cy + pos.y ),
437  orient + 1800, orient + 3600,
438  radius, NO_FILL );
439  cx = 0;
440  cy = -deltaxy / 2;
441  RotatePoint( &cx, &cy, orient );
442  Arc( wxPoint( cx + pos.x, cy + pos.y ),
443  orient, orient + 1800,
444  radius, NO_FILL );
445 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
T AddAngles(T a1, T2 a2)
Add two angles (keeping the result normalized). T2 is here.
Definition: trigo.h:246
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
int currentPenWidth
Definition: plot_common.h:537
virtual void Arc(const wxPoint &centre, double StAngle, double EndAngle, int rayon, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)
Generic fallback: arc rendered as a polyline.
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
void GERBER_PLOTTER::StartBlock ( void *  aData)
overridevirtual

calling this function allows 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 122 of file common_plotGERBER_functions.cpp.

References EndBlock().

123 {
124  // Currently, it is the same as EndBlock(): clear all aperture net attributes
125  EndBlock( aData );
126 }
virtual void EndBlock(void *aData) override
calling this function allows to define the end of a group of drawing items the group is started by St...
bool GERBER_PLOTTER::StartPlot ( )
overridevirtual

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

Implements PLOTTER.

Definition at line 159 of file common_plotGERBER_functions.cpp.

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

Referenced by GERBER_WRITER::createDrillFile().

160 {
161  wxASSERT( outputFile );
162 
163  finalFile = outputFile; // the actual gerber file will be created later
164 
165  // Create a temporary filename to store gerber file
166  // note tmpfile() does not work under Vista and W7 in user mode
167  m_workFilename = filename + wxT(".tmp");
168  workFile = wxFopen( m_workFilename, wxT( "wt" ));
170  wxASSERT( outputFile );
171 
172  if( outputFile == NULL )
173  return false;
174 
175  for( unsigned ii = 0; ii < m_headerExtraLines.GetCount(); ii++ )
176  {
177  if( ! m_headerExtraLines[ii].IsEmpty() )
178  fprintf( outputFile, "%s\n", TO_UTF8( m_headerExtraLines[ii] ) );
179  }
180 
181  // Set coordinate format to 3.6 or 4.5 absolute, leading zero omitted
182  // the number of digits for the integer part of coordintes is needed
183  // in gerber format, but is not very important when omitting leading zeros
184  // It is fixed here to 3 (inch) or 4 (mm), but is not actually used
185  int leadingDigitCount = m_gerberUnitInch ? 3 : 4;
186 
187  fprintf( outputFile, "%%FSLAX%d%dY%d%d*%%\n",
188  leadingDigitCount, m_gerberUnitFmt,
189  leadingDigitCount, m_gerberUnitFmt );
190  fprintf( outputFile,
191  "G04 Gerber Fmt %d.%d, Leading zero omitted, Abs format (unit %s)*\n",
192  leadingDigitCount, m_gerberUnitFmt,
193  m_gerberUnitInch ? "inch" : "mm" );
194 
195  wxString Title = creator + wxT( " " ) + GetBuildVersion();
196  fprintf( outputFile, "G04 Created by KiCad (%s) date %s*\n",
197  TO_UTF8( Title ), TO_UTF8( DateAndTime() ) );
198 
199  /* Mass parameter: unit = INCHES/MM */
200  if( m_gerberUnitInch )
201  fputs( "%MOIN*%\n", outputFile );
202  else
203  fputs( "%MOMM*%\n", outputFile );
204 
205  // Be sure the usual dark polarity is selected:
206  fputs( "%LPD*%\n", outputFile );
207 
208  // Specify linear interpol (G01):
209  fputs( "G01*\n", outputFile );
210 
211  fputs( "G04 APERTURE LIST*\n", outputFile );
212 
213  return true;
214 }
wxArrayString m_headerExtraLines
Definition: plot_common.h:549
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
wxString GetBuildVersion()
Function GetBuildVersion Return the build version string.
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531
wxString m_workFilename
Definition: plot_common.h:1185
wxString filename
Definition: plot_common.h:543
wxString creator
Definition: plot_common.h:542
wxString DateAndTime()
Function DateAndTime.
Definition: string.cpp:229
void GERBER_PLOTTER::Text ( const wxPoint aPos,
const COLOR4D  aColor,
const wxString &  aText,
double  aOrient,
const wxSize &  aSize,
enum EDA_TEXT_HJUSTIFY_T  aH_justify,
enum EDA_TEXT_VJUSTIFY_T  aV_justify,
int  aWidth,
bool  aItalic,
bool  aBold,
bool  aMultilineAllowed = false,
void *  aData = NULL 
)
overridevirtual

Draws text with the plotter.

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

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

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

Reimplemented from PLOTTER.

Definition at line 952 of file common_plotGERBER_functions.cpp.

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

957 {
958  GBR_METADATA* gbr_metadata = static_cast<GBR_METADATA*>( aData );
959 
960  if( gbr_metadata )
961  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
962 
963  PLOTTER::Text( aPos, aColor, aText, aOrient, aSize,
964  aH_justify, aV_justify, aWidth, aItalic, aBold, aMultilineAllowed, aData );
965 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
virtual void Text(const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL)
Draws text with the plotter.
Definition: drawtxt.cpp:229
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
void GERBER_PLOTTER::ThickArc ( const wxPoint centre,
double  StAngle,
double  EndAngle,
int  rayon,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 545 of file common_plotGERBER_functions.cpp.

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

547 {
548  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
549  SetCurrentLineWidth( width, gbr_metadata );
550 
551  if( gbr_metadata )
552  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
553 
554  if( tracemode == FILLED )
555  Arc( centre, StAngle, EndAngle, radius, NO_FILL, DO_NOT_SET_LINE_WIDTH );
556  else
557  {
559  Arc( centre, StAngle, EndAngle,
560  radius - ( width - currentPenWidth ) / 2,
562  Arc( centre, StAngle, EndAngle,
563  radius + ( width - currentPenWidth ) / 2, NO_FILL,
565  }
566 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
int currentPenWidth
Definition: plot_common.h:537
virtual void Arc(const wxPoint &aCenter, double aStAngle, double aEndAngle, int aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
Generic fallback: arc rendered as a polyline.
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
static const int DO_NOT_SET_LINE_WIDTH
Definition: plot_common.h:94
void GERBER_PLOTTER::ThickCircle ( const wxPoint pos,
int  diametre,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 597 of file common_plotGERBER_functions.cpp.

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

599 {
600  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
601  SetCurrentLineWidth( width, gbr_metadata );
602 
603  if( gbr_metadata )
604  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
605 
606  if( tracemode == FILLED )
607  Circle( pos, diametre, NO_FILL, DO_NOT_SET_LINE_WIDTH );
608  else
609  {
611  Circle( pos, diametre - (width - currentPenWidth),
613  Circle( pos, diametre + (width - currentPenWidth),
615  }
616 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
int currentPenWidth
Definition: plot_common.h:537
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
static const int DO_NOT_SET_LINE_WIDTH
Definition: plot_common.h:94
void GERBER_PLOTTER::ThickRect ( const wxPoint p1,
const wxPoint p2,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 569 of file common_plotGERBER_functions.cpp.

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

571 {
572  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
573  SetCurrentLineWidth( width, gbr_metadata );
574 
575  if( gbr_metadata )
576  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
577 
578  if( tracemode == FILLED )
579  Rect( p1, p2, NO_FILL, DO_NOT_SET_LINE_WIDTH );
580  else
581  {
583  wxPoint offsetp1( p1.x - (width - currentPenWidth) / 2,
584  p1.y - (width - currentPenWidth) / 2 );
585  wxPoint offsetp2( p2.x + (width - currentPenWidth) / 2,
586  p2.y + (width - currentPenWidth) / 2 );
587  Rect( offsetp1, offsetp2, NO_FILL, -1 );
588  offsetp1.x += (width - currentPenWidth);
589  offsetp1.y += (width - currentPenWidth);
590  offsetp2.x -= (width - currentPenWidth);
591  offsetp2.y -= (width - currentPenWidth);
592  Rect( offsetp1, offsetp2, NO_FILL, DO_NOT_SET_LINE_WIDTH );
593  }
594 }
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
int currentPenWidth
Definition: plot_common.h:537
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
static const int DO_NOT_SET_LINE_WIDTH
Definition: plot_common.h:94
void GERBER_PLOTTER::ThickSegment ( const wxPoint start,
const wxPoint end,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
overridevirtual

Reimplemented from PLOTTER.

Definition at line 524 of file common_plotGERBER_functions.cpp.

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

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

526 {
527  if( tracemode == FILLED )
528  {
529  GBR_METADATA *gbr_metadata = static_cast<GBR_METADATA*>( aData );
530  SetCurrentLineWidth( width, gbr_metadata );
531 
532  if( gbr_metadata )
533  formatNetAttribute( &gbr_metadata->m_NetlistMetadata );
534 
535  MoveTo( start );
536  FinishTo( end );
537  }
538  else
539  {
541  segmentAsOval( start, end, width, tracemode );
542  }
543 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
void formatNetAttribute(GBR_NETLIST_METADATA *aData)
print a Gerber net attribute object record.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plot_common.h:95
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Set the line width for the next drawing.
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
GBR_NETLIST_METADATA m_NetlistMetadata
a item to handle object attribute:
void segmentAsOval(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode)
Cdonvert a thick segment and plot it as an oval.
DPOINT PLOTTER::userToDeviceCoordinates ( const wxPoint aCoordinate)
protectedvirtualinherited

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

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

Definition at line 96 of file class_plotter.cpp.

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

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

97 {
98  wxPoint pos = aCoordinate - plotOffset;
99 
100  double x = pos.x * plotScale;
101  double y = ( paperSize.y - pos.y * plotScale );
102 
103  if( m_plotMirror )
104  {
106  x = ( paperSize.x - pos.x * plotScale );
107  else
108  y = pos.y * plotScale;
109  }
110 
111  if( m_yaxisReversed )
112  y = paperSize.y - y;
113 
114  x *= iuPerDeviceUnit;
115  y *= iuPerDeviceUnit;
116 
117  return DPOINT( x, y );
118 }
wxPoint plotOffset
Plot offset (in IUs)
Definition: plot_common.h:522
bool m_yaxisReversed
true to mirror horizontally (else vertically)
Definition: plot_common.h:528
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plot_common.h:526
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plot_common.h:510
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plot_common.h:519
VECTOR2< double > DPOINT
Definition: vector2d.h:595
wxSize paperSize
Paper size in IU - not in mils.
Definition: plot_common.h:547
bool m_mirrorIsHorizontal
Definition: plot_common.h:527
DPOINT PLOTTER::userToDeviceSize ( const wxSize &  size)
protectedvirtualinherited

Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)

Definition at line 121 of file class_plotter.cpp.

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

Referenced by PS_PLOTTER::Arc(), SVG_PLOTTER::Arc(), DXF_PLOTTER::Arc(), HPGL_PLOTTER::Circle(), PS_PLOTTER::Circle(), PDF_PLOTTER::Circle(), SVG_PLOTTER::Circle(), DXF_PLOTTER::Circle(), PSLIKE_PLOTTER::computeTextParameters(), HPGL_PLOTTER::FlashPadCircle(), PLOTTER::GetDashGapLenIU(), PLOTTER::GetDashMarkLenIU(), PDF_PLOTTER::PlotImage(), HPGL_PLOTTER::SetCurrentLineWidth(), PS_PLOTTER::SetCurrentLineWidth(), PDF_PLOTTER::SetCurrentLineWidth(), SVG_PLOTTER::setSVGPlotStyle(), PDF_PLOTTER::StartPage(), HPGL_PLOTTER::StartPlot(), PS_PLOTTER::StartPlot(), PS_PLOTTER::Text(), PDF_PLOTTER::Text(), and DXF_PLOTTER::Text().

122 {
123  return DPOINT( size.x * plotScale * iuPerDeviceUnit,
124  size.y * plotScale * iuPerDeviceUnit );
125 }
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plot_common.h:510
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plot_common.h:519
VECTOR2< double > DPOINT
Definition: vector2d.h:595
double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtualinherited

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

Definition at line 128 of file class_plotter.cpp.

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

129 {
130  return size * plotScale * iuPerDeviceUnit;
131 }
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plot_common.h:510
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plot_common.h:519
void GERBER_PLOTTER::UseX2Attributes ( bool  aEnable)
inline

Definition at line 1111 of file plot_common.h.

References m_useX2Attributes.

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

1111 { m_useX2Attributes = aEnable; }
bool m_useX2Attributes
Definition: plot_common.h:1198
void GERBER_PLOTTER::UseX2NetAttributes ( bool  aEnable)
inline

Definition at line 1112 of file plot_common.h.

References m_useNetAttributes.

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

1112 { m_useNetAttributes = aEnable; }
bool m_useNetAttributes
Definition: plot_common.h:1200
void GERBER_PLOTTER::writeApertureList ( )
protected

Generate the table of D codes.

Definition at line 334 of file common_plotGERBER_functions.cpp.

References apertures, APERTURE::Circle, GBR_APERTURE_METADATA::FormatAttribute(), m_apertureAttribute, m_gerberUnitInch, PLOTTER::m_IUsPerDecimil, PLOTTER::outputFile, APERTURE::Oval, PLOTTER::plotScale, APERTURE::Plotting, and APERTURE::Rect.

Referenced by EndPlot().

335 {
336  wxASSERT( outputFile );
337  char cbuf[1024];
338 
339  // Init
340  for( std::vector<APERTURE>::iterator tool = apertures.begin();
341  tool != apertures.end(); ++tool )
342  {
343  // apertude sizes are in inch or mm, regardless the
344  // coordinates format
345  double fscale = 0.0001 * plotScale / m_IUsPerDecimil; // inches
346 
347  if(! m_gerberUnitInch )
348  fscale *= 25.4; // size in mm
349 
350  int attribute = tool->m_ApertureAttribute;
351 
352  if( attribute != m_apertureAttribute )
355 
356  char* text = cbuf + sprintf( cbuf, "%%ADD%d", tool->m_DCode );
357 
358  /* Please note: the Gerber specs for mass parameters say that
359  exponential syntax is *not* allowed and the decimal point should
360  also be always inserted. So the %g format is ruled out, but %f is fine
361  (the # modifier forces the decimal point). Sadly the %f formatter
362  can't remove trailing zeros but thats not a problem, since nothing
363  forbid it (the file is only slightly longer) */
364 
365  switch( tool->m_Type )
366  {
367  case APERTURE::Circle:
368  sprintf( text, "C,%#f*%%\n", tool->m_Size.x * fscale );
369  break;
370 
371  case APERTURE::Rect:
372  sprintf( text, "R,%#fX%#f*%%\n",
373  tool->m_Size.x * fscale,
374  tool->m_Size.y * fscale );
375  break;
376 
377  case APERTURE::Plotting:
378  sprintf( text, "C,%#f*%%\n", tool->m_Size.x * fscale );
379  break;
380 
381  case APERTURE::Oval:
382  sprintf( text, "O,%#fX%#f*%%\n",
383  tool->m_Size.x * fscale,
384  tool->m_Size.y * fscale );
385  break;
386  }
387 
388  fputs( cbuf, outputFile );
389 
390  m_apertureAttribute = attribute;
391 
392  // Currently reset the aperture attribute. Perhaps a better optimization
393  // is to store the last attribute
394  if( attribute )
395  {
396  fputs( "%TD*%\n", outputFile );
398  }
399 
400  }
401 }
std::vector< APERTURE > apertures
Definition: plot_common.h:1192
double m_IUsPerDecimil
Definition: plot_common.h:516
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plot_common.h:510
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:531

Member Data Documentation

std::vector<APERTURE> GERBER_PLOTTER::apertures
protected
wxString PLOTTER::creator
protectedinherited
std::vector<APERTURE>::iterator GERBER_PLOTTER::currentAperture
protected

Definition at line 1193 of file plot_common.h.

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

const int PLOTTER::DO_NOT_SET_LINE_WIDTH = -2
staticinherited

Definition at line 94 of file plot_common.h.

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

FILE* GERBER_PLOTTER::finalFile
protected

Definition at line 1184 of file plot_common.h.

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

int GERBER_PLOTTER::m_apertureAttribute
protected

Definition at line 1181 of file plot_common.h.

Referenced by GERBER_PLOTTER(), and writeApertureList().

int GERBER_PLOTTER::m_gerberUnitFmt
protected

Definition at line 1196 of file plot_common.h.

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

bool GERBER_PLOTTER::m_gerberUnitInch
protected
wxArrayString PLOTTER::m_headerExtraLines
protectedinherited
bool PLOTTER::m_mirrorIsHorizontal
protectedinherited
std::string GERBER_PLOTTER::m_objectAttributesDictionnary
protected

Definition at line 1178 of file plot_common.h.

Referenced by clearNetAttribute(), and formatNetAttribute().

bool GERBER_PLOTTER::m_useNetAttributes
protected
bool GERBER_PLOTTER::m_useX2Attributes
protected
wxString GERBER_PLOTTER::m_workFilename
protected

Definition at line 1185 of file plot_common.h.

Referenced by EndPlot(), and StartPlot().

bool PLOTTER::m_yaxisReversed
protectedinherited

true to mirror horizontally (else vertically)

Definition at line 528 of file plot_common.h.

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

const unsigned PLOTTER::MARKER_COUNT = 58
staticinherited

Draw a marker (used for the drill map)

Definition at line 380 of file plot_common.h.

Referenced by PLOTTER::Marker().

bool PLOTTER::negativeMode
protectedinherited

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

Definition at line 535 of file plot_common.h.

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

FILE* PLOTTER::outputFile
protectedinherited

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

Output file

Definition at line 531 of file plot_common.h.

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

wxPoint PLOTTER::penLastpos
protectedinherited

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

Definition at line 541 of file plot_common.h.

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

char PLOTTER::penState
protectedinherited

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

Definition at line 539 of file plot_common.h.

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

double PLOTTER::plotScale
protectedinherited
wxString PLOTTER::title
protectedinherited

Definition at line 544 of file plot_common.h.

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

FILE* GERBER_PLOTTER::workFile
protected

Definition at line 1183 of file plot_common.h.

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


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