KiCad PCB EDA Suite
PLOTTER Class Referenceabstract

Base plotter engine class. More...

#include <class_plotter.h>

Inheritance diagram for PLOTTER:
DXF_PLOTTER GERBER_PLOTTER HPGL_PLOTTER PSLIKE_PLOTTER PDF_PLOTTER PS_PLOTTER SVG_PLOTTER

Public Member Functions

 PLOTTER ()
 
virtual ~PLOTTER ()
 
virtual PlotFormat GetPlotterType () const =0
 Returns the effective plot engine in use. More...
 
virtual bool StartPlot ()=0
 
virtual bool EndPlot ()=0
 
virtual void SetNegative (bool _negative)
 
virtual void SetColorMode (bool _color_mode)
 
bool GetColorMode () const
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings)
 
virtual void SetCurrentLineWidth (int width, void *aData=NULL)=0
 Set the line width for the next drawing. More...
 
virtual void SetDefaultLineWidth (int width)=0
 Set the default line width. More...
 
virtual int GetCurrentLineWidth () const
 
virtual void SetColor (COLOR4D color)=0
 
virtual void SetDash (int dashed)=0
 
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 void SetViewport (const wxPoint &aOffset, double aIusPerDecimil, double aScale, bool aMirror)=0
 Set the plot offset and scaling for the current plot. 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...
 
virtual void Rect (const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
 
virtual void Circle (const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
 
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. More...
 
virtual void PenTo (const wxPoint &pos, char plume)=0
 moveto/lineto primitive, moves the 'pen' to the specified direction More...
 
void MoveTo (const wxPoint &pos)
 
void LineTo (const wxPoint &pos)
 
void FinishTo (const wxPoint &pos)
 
void PenFinish ()
 
virtual void PlotPoly (const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
 Function PlotPoly. More...
 
virtual void PlotPoly (const SHAPE_LINE_CHAIN &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)
 Function PlotPoly. More...
 
virtual void PlotImage (const wxImage &aImage, const wxPoint &aPos, double aScaleFactor)
 Function PlotImage Only Postscript plotters can plot bitmaps for plotters that cannot plot a bitmap, a rectangle is plotted. More...
 
virtual void ThickSegment (const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData)
 
virtual void ThickArc (const wxPoint &centre, double StAngle, double EndAngle, int rayon, int width, EDA_DRAW_MODE_T tracemode, void *aData)
 
virtual void ThickRect (const wxPoint &p1, const wxPoint &p2, int width, EDA_DRAW_MODE_T tracemode, void *aData)
 
virtual void ThickCircle (const wxPoint &pos, int diametre, int width, EDA_DRAW_MODE_T tracemode, void *aData)
 
virtual void FlashPadCircle (const wxPoint &aPadPos, int aDiameter, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
 virtual function FlashPadCircle More...
 
virtual void FlashPadOval (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
 virtual function FlashPadOval More...
 
virtual void FlashPadRect (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
 virtual function FlashPadRect More...
 
virtual void FlashPadRoundRect (const wxPoint &aPadPos, const wxSize &aSize, int aCornerRadius, double aOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
 virtual function FlashPadRoundRect More...
 
virtual void FlashPadCustom (const wxPoint &aPadPos, const wxSize &aSize, SHAPE_POLY_SET *aPolygons, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
 virtual function FlashPadCustom More...
 
virtual void FlashPadTrapez (const wxPoint &aPadPos, const wxPoint *aCorners, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
 virtual function FlashPadTrapez flash a trapezoidal pad 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)
 Draws text with the plotter. More...
 
void Marker (const wxPoint &position, int diametre, unsigned aShapeId)
 Draw a pattern shape number aShapeId, to coord position. More...
 
virtual void SetLayerPolarity (bool aPositive)
 Function SetLayerPolarity sets current Gerber layer polarity to positive or negative by writing %LPD*% or %LPC*% to the Gerber file, respectively. More...
 
virtual void SetTextMode (PlotTextMode mode)
 Change the current text mode. More...
 
virtual void SetGerberCoordinatesFormat (int aResolution, bool aUseInches=false)
 
virtual void StartBlock (void *aData)
 calling this function allows to define the beginning of a group of drawing items, for instance in SVG or Gerber format. More...
 
virtual void EndBlock (void *aData)
 calling this function allows to define the end of a group of drawing items for instance in SVG or Gerber format. More...
 

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 markerCircle (const wxPoint &pos, int radius)
 Plot a circle centered on the position. More...
 
void markerHBar (const wxPoint &pos, int radius)
 Plot a - bar centered on the position. More...
 
void markerSlash (const wxPoint &pos, int radius)
 Plot a / bar centered on the position. More...
 
void markerBackSlash (const wxPoint &pos, int radius)
 Plot a \ bar centered on the position. More...
 
void markerVBar (const wxPoint &pos, int radius)
 Plot a | bar centered on the position. More...
 
void markerSquare (const wxPoint &position, int radius)
 Plot a square centered on the position. More...
 
void markerLozenge (const wxPoint &position, int radius)
 Plot a lozenge centered on the position. More...
 
void segmentAsOval (const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode)
 Cdonvert a thick segment and plot it as an oval. More...
 
void sketchOval (const wxPoint &pos, const wxSize &size, double orient, int width)
 
virtual DPOINT userToDeviceCoordinates (const wxPoint &aCoordinate)
 Modifies coordinates according to the orientation, scale factor, and offsets trace. More...
 
virtual DPOINT userToDeviceSize (const wxSize &size)
 Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT) More...
 
virtual double userToDeviceSize (double size) const
 Modifies size according to the plotter scale factors (simple double version) More...
 
double GetDotMarkLenIU () const
 
double GetDashMarkLenIU () const
 
double GetDashGapLenIU () const
 

Protected Attributes

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
 

Private Attributes

double m_dotMarkLength_mm
 Dotted line parameter in mm: segment. More...
 

Detailed Description

Base plotter engine class.

General rule: all the interface with the caller is done in IU, the IU size is specified with SetViewport. Internal and output processing is usually done in decimils (or whatever unit the effective engine class need to use)

Definition at line 96 of file class_plotter.h.

Constructor & Destructor Documentation

PLOTTER::PLOTTER ( )

Definition at line 53 of file class_plotter.cpp.

References colorMode, currentPenWidth, defaultPenWidth, iuPerDeviceUnit, m_dotMarkLength_mm, m_IUsPerDecimil, m_mirrorIsHorizontal, m_plotMirror, m_yaxisReversed, negativeMode, outputFile, penState, and plotScale.

54 {
55  plotScale = 1;
56  defaultPenWidth = 0;
57  currentPenWidth = -1; // To-be-set marker
58  penState = 'Z'; // End-of-path idle
59  m_plotMirror = false; // Plot mirror option flag
60  m_mirrorIsHorizontal = true;
61  m_yaxisReversed = false;
62  outputFile = 0;
63  colorMode = false; // Starts as a BW plot
64  negativeMode = false;
65  // Temporary init to avoid not initialized vars, will be set later
66  m_IUsPerDecimil = 1; // will be set later to the actual value
67  iuPerDeviceUnit = 1; // will be set later to the actual value
68  m_dotMarkLength_mm = 0.1; // Dotted line parameter in mm: segment
69  // Dashed line parameter is 5 * dotted line mark
70  // Dashed line gap is 3 * dotted line mark
71 }
double m_dotMarkLength_mm
Dotted line parameter in mm: segment.
Definition: class_plotter.h:99
bool colorMode
char penState
Current pen state: 'U', 'D' or 'Z' (see PenTo)
double m_IUsPerDecimil
bool m_yaxisReversed
true to mirror horizontally (else vertically)
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
int currentPenWidth
int defaultPenWidth
true to generate a negative image (PS mode mainly)
FILE * outputFile
true if the Y axis is top to bottom (SVG)
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
bool m_mirrorIsHorizontal
bool negativeMode
true to plot in color, false to plot in black and white
PLOTTER::~PLOTTER ( )
virtual

Definition at line 73 of file class_plotter.cpp.

References outputFile.

74 {
75  // Emergency cleanup, but closing the file is
76  // usually made in EndPlot().
77  if( outputFile )
78  fclose( outputFile );
79 }
FILE * outputFile
true if the Y axis is top to bottom (SVG)

Member Function Documentation

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

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 175 of file class_plotter.h.

References m_headerExtraLines.

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

176  {
177  m_headerExtraLines.Add( aExtraString );
178  }
wxArrayString m_headerExtraLines
void PLOTTER::Arc ( const wxPoint centre,
double  StAngle,
double  EndAngle,
int  rayon,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
virtual

Generic fallback: arc rendered as a polyline.

Reimplemented in DXF_PLOTTER, GERBER_PLOTTER, SVG_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and HPGL_PLOTTER.

Definition at line 155 of file class_plotter.cpp.

References cosdecideg(), delta, FinishTo(), KiROUND(), LineTo(), MoveTo(), SetCurrentLineWidth(), sindecideg(), wxPoint::x, and wxPoint::y.

Referenced by LIB_ARC::Plot(), sketchOval(), and ThickArc().

157 {
158  wxPoint start, end;
159  const int delta = 50; // increment (in 0.1 degrees) to draw circles
160 
161  if( StAngle > EndAngle )
162  std::swap( StAngle, EndAngle );
163 
164  SetCurrentLineWidth( width );
165  /* Please NOTE the different sign due to Y-axis flip */
166  start.x = centre.x + KiROUND( cosdecideg( radius, -StAngle ) );
167  start.y = centre.y + KiROUND( sindecideg( radius, -StAngle ) );
168  MoveTo( start );
169  for( int ii = StAngle + delta; ii < EndAngle; ii += delta )
170  {
171  end.x = centre.x + KiROUND( cosdecideg( radius, -ii ) );
172  end.y = centre.y + KiROUND( sindecideg( radius, -ii ) );
173  LineTo( end );
174  }
175 
176  end.x = centre.x + KiROUND( cosdecideg( radius, -EndAngle ) );
177  end.y = centre.y + KiROUND( sindecideg( radius, -EndAngle ) );
178  FinishTo( end );
179 }
void FinishTo(const wxPoint &pos)
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
static const int delta[8][2]
Definition: solve.cpp:112
void LineTo(const wxPoint &pos)
void MoveTo(const wxPoint &pos)
double cosdecideg(double r, double a)
Circle generation utility: computes r * cos(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:333
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:324
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
virtual void PLOTTER::Circle ( const wxPoint pos,
int  diametre,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
pure virtual
void PLOTTER::ClearHeaderLinesList ( )
inline

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

Definition at line 184 of file class_plotter.h.

References m_headerExtraLines.

Referenced by StartPlotBoard().

185  {
186  m_headerExtraLines.Clear();
187  }
wxArrayString m_headerExtraLines
virtual void PLOTTER::EndBlock ( void *  aData)
inlinevirtual

calling this function allows to define the end of a group of drawing items for instance in SVG or Gerber format.

the group is started by StartBlock()

Parameters
aDatacan define any parameter for most of plotters: do nothing

Reimplemented in GERBER_PLOTTER.

Definition at line 453 of file class_plotter.h.

Referenced by PlotSilkScreen(), and PlotStandardLayer().

453 {}
virtual void PLOTTER::FlashPadCircle ( const wxPoint aPadPos,
int  aDiameter,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
pure virtual

virtual function FlashPadCircle

Parameters
aPadPosPosition of the shape (center of the rectangle
aDiameterdiameter of round pad
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format attributes)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

Referenced by BRDITEMS_PLOTTER::plotOneDrillMark(), BRDITEMS_PLOTTER::PlotPad(), and PlotStandardLayer().

virtual void PLOTTER::FlashPadCustom ( const wxPoint aPadPos,
const wxSize &  aSize,
SHAPE_POLY_SET aPolygons,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
pure virtual

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)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

virtual void PLOTTER::FlashPadOval ( const wxPoint aPadPos,
const wxSize &  aSize,
double  aPadOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
pure virtual

virtual function FlashPadOval

Parameters
aPadPosPosition of the shape (center of the rectangle
aSize= size of oblong shape
aPadOrientThe rotation of the shape
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format attributes)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

Referenced by GENDRILL_WRITER_BASE::plotDrillMarks(), BRDITEMS_PLOTTER::plotOneDrillMark(), BRDITEMS_PLOTTER::PlotPad(), and segmentAsOval().

virtual void PLOTTER::FlashPadRect ( const wxPoint aPadPos,
const wxSize &  aSize,
double  aPadOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
pure virtual

virtual function FlashPadRect

Parameters
aPadPosPosition of the shape (center of the rectangle
aSize= size of rounded rect
aPadOrientThe rotation of the shape
aTraceModeFILLED or SKETCH
aDataan auxuliary info (mainly for gerber format attributes)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

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

virtual function FlashPadRoundRect

Parameters
aPadPosPosition of the shape (center of the rectangle
aSize= size of rounded rect
aCornerRadiusRadius of the rounded corners
aOrientThe rotation of the shape
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format attributes)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

virtual void PLOTTER::FlashPadTrapez ( const wxPoint aPadPos,
const wxPoint aCorners,
double  aPadOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
pure virtual

virtual function FlashPadTrapez flash a trapezoidal pad

Parameters
aPadPos= the position of the shape
aCorners= the list of 4 corners positions, relative to the shape position, pad orientation 0
aPadOrient= the rotation of the shape
aTraceMode= FILLED or SKETCH
aDataan auxiliary info (mainly for gerber format attributes)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

bool PLOTTER::GetColorMode ( ) const
inline

Definition at line 130 of file class_plotter.h.

References colorMode.

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

131  {
132  return colorMode;
133  }
bool colorMode
double PLOTTER::GetDashGapLenIU ( ) const
protected

Definition at line 150 of file class_plotter.cpp.

References GetCurrentLineWidth(), GetDotMarkLenIU(), and userToDeviceSize().

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

151 {
152  return 3.0 * GetDotMarkLenIU() + userToDeviceSize( 2 * GetCurrentLineWidth() );
153 }
double GetDotMarkLenIU() const
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT) ...
virtual int GetCurrentLineWidth() const
double PLOTTER::GetDashMarkLenIU ( ) const
protected

Definition at line 144 of file class_plotter.cpp.

References GetDashGapLenIU(), GetDotMarkLenIU(), and max.

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

145 {
146  return std::max( GetDashGapLenIU(), 5.0 * GetDotMarkLenIU() );
147 }
double GetDotMarkLenIU() const
#define max(a, b)
Definition: auxiliary.h:86
double GetDashGapLenIU() const
double PLOTTER::GetDotMarkLenIU ( ) const
protected

Definition at line 137 of file class_plotter.cpp.

References GetCurrentLineWidth(), m_dotMarkLength_mm, m_IUsPerDecimil, max, and userToDeviceSize().

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

138 {
139  return userToDeviceSize( std::max( 1.0,
140  m_dotMarkLength_mm * 10000 / 25.4 * m_IUsPerDecimil - GetCurrentLineWidth() ) );
141 }
double m_dotMarkLength_mm
Dotted line parameter in mm: segment.
Definition: class_plotter.h:99
double m_IUsPerDecimil
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT) ...
virtual int GetCurrentLineWidth() const
#define max(a, b)
Definition: auxiliary.h:86
double PLOTTER::GetIUsPerDecimil ( ) const
inline

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 216 of file class_plotter.h.

References m_IUsPerDecimil.

Referenced by PlotWorkSheet().

216 { return m_IUsPerDecimil; }
double m_IUsPerDecimil
virtual PlotFormat PLOTTER::GetPlotterType ( ) const
pure virtual

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

Implemented in DXF_PLOTTER, GERBER_PLOTTER, SVG_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and HPGL_PLOTTER.

Referenced by PlotOneBoardLayer(), and StartPlotBoard().

void PLOTTER::LineTo ( const wxPoint pos)
inline

Definition at line 245 of file class_plotter.h.

References PenTo().

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

246  {
247  PenTo( pos, 'D' );
248  }
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 
)

Draw a pattern shape number aShapeId, to coord position.

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

Definition at line 282 of file class_plotter.cpp.

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

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

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

Plot a \ bar centered on the position.

Building block for markers

Definition at line 268 of file class_plotter.cpp.

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

Referenced by Marker().

269 {
270  MoveTo( wxPoint( pos.x + radius, pos.y - radius ) );
271  FinishTo( wxPoint( pos.x - radius, pos.y + radius ) );
272 }
void FinishTo(const wxPoint &pos)
void MoveTo(const wxPoint &pos)
void PLOTTER::markerCircle ( const wxPoint pos,
int  radius 
)
protected

Plot a circle centered on the position.

Building block for markers

Definition at line 224 of file class_plotter.cpp.

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

Referenced by Marker().

225 {
226  Circle( position, radius * 2, NO_FILL, GetCurrentLineWidth() );
227 }
virtual int GetCurrentLineWidth() const
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 
)
protected

Plot a - bar centered on the position.

Building block for markers

Definition at line 254 of file class_plotter.cpp.

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

Referenced by Marker().

255 {
256  MoveTo( wxPoint( pos.x - radius, pos.y ) );
257  FinishTo( wxPoint( pos.x + radius, pos.y ) );
258 }
void FinishTo(const wxPoint &pos)
void MoveTo(const wxPoint &pos)
void PLOTTER::markerLozenge ( const wxPoint position,
int  radius 
)
protected

Plot a lozenge centered on the position.

Building block for markers

Definition at line 230 of file class_plotter.cpp.

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

Referenced by Marker().

231 {
232  std::vector< wxPoint > corner_list;
233  wxPoint corner;
234  corner.x = position.x;
235  corner.y = position.y + radius;
236  corner_list.push_back( corner );
237  corner.x = position.x + radius;
238  corner.y = position.y,
239  corner_list.push_back( corner );
240  corner.x = position.x;
241  corner.y = position.y - radius;
242  corner_list.push_back( corner );
243  corner.x = position.x - radius;
244  corner.y = position.y;
245  corner_list.push_back( corner );
246  corner.x = position.x;
247  corner.y = position.y + radius;
248  corner_list.push_back( corner );
249 
250  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
251 }
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
void PLOTTER::markerSlash ( const wxPoint pos,
int  radius 
)
protected

Plot a / bar centered on the position.

Building block for markers

Definition at line 261 of file class_plotter.cpp.

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

Referenced by Marker().

262 {
263  MoveTo( wxPoint( pos.x - radius, pos.y - radius ) );
264  FinishTo( wxPoint( pos.x + radius, pos.y + radius ) );
265 }
void FinishTo(const wxPoint &pos)
void MoveTo(const wxPoint &pos)
void PLOTTER::markerSquare ( const wxPoint position,
int  radius 
)
protected

Plot a square centered on the position.

Building block for markers

Definition at line 199 of file class_plotter.cpp.

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

Referenced by Marker().

200 {
201  double r = KiROUND( radius / 1.4142 );
202  std::vector< wxPoint > corner_list;
203  wxPoint 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  corner.x = position.x - r;
211  corner.y = position.y - r;
212  corner_list.push_back( corner );
213  corner.x = position.x - r;
214  corner.y = position.y + r;
215  corner_list.push_back( corner );
216  corner.x = position.x + r;
217  corner.y = position.y + r;
218  corner_list.push_back( corner );
219 
220  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
221 }
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
void PLOTTER::markerVBar ( const wxPoint pos,
int  radius 
)
protected

Plot a | bar centered on the position.

Building block for markers

Definition at line 275 of file class_plotter.cpp.

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

Referenced by Marker().

276 {
277  MoveTo( wxPoint( pos.x, pos.y - radius ) );
278  FinishTo( wxPoint( pos.x, pos.y + radius ) );
279 }
void FinishTo(const wxPoint &pos)
void MoveTo(const wxPoint &pos)
bool PLOTTER::OpenFile ( const wxString &  aFullFilename)
virtual

Open or create the plot file aFullFilename.

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

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

Reimplemented in PDF_PLOTTER.

Definition at line 82 of file class_plotter.cpp.

References filename, and 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().

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

Definition at line 256 of file class_plotter.h.

References PenTo().

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

257  {
258  // The point is not important with Z motion
259  PenTo( wxPoint( 0, 0 ), 'Z' );
260  }
virtual void PenTo(const wxPoint &pos, char plume)=0
moveto/lineto primitive, moves the 'pen' to the specified direction
virtual void PLOTTER::PenTo ( const wxPoint pos,
char  plume 
)
pure virtual

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)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, SVG_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and HPGL_PLOTTER.

Referenced by FinishTo(), LineTo(), MoveTo(), and PenFinish().

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

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 182 of file class_plotter.cpp.

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

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

183 {
184  wxSize size( aImage.GetWidth() * aScaleFactor,
185  aImage.GetHeight() * aScaleFactor );
186 
187  wxPoint start = aPos;
188  start.x -= size.x / 2;
189  start.y -= size.y / 2;
190 
191  wxPoint end = start;
192  end.x += size.x;
193  end.y += size.y;
194 
195  Rect( start, end, NO_FILL );
196 }
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void PLOTTER::PlotPoly ( const std::vector< wxPoint > &  aCornerList,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = NULL 
)
pure virtual
void PLOTTER::PlotPoly ( const SHAPE_LINE_CHAIN aCornerList,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = NULL 
)
virtual

Function PlotPoly.

Draw a polygon ( filled or not )

Parameters
aCornerList= corners list (a SHAPE_LINE_CHAIN)
aFill= type of fill
aWidth= line width
aDataan auxiliary info (mainly for gerber format)

Definition at line 526 of file class_plotter.cpp.

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

528 {
529  std::vector< wxPoint > cornerList;
530 
531  for( int ii = 0; ii < aCornerList.PointCount(); ii++ )
532  cornerList.push_back( wxPoint( aCornerList.CPoint( ii ) ) );
533 
534  PlotPoly( cornerList , aFill, aWidth, aData );
535 }
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)=0
Function PlotPoly.
const VECTOR2I & CPoint(int aIndex) const
Function CPoint()
virtual void PLOTTER::Rect ( const wxPoint p1,
const wxPoint p2,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
pure virtual
void PLOTTER::segmentAsOval ( const wxPoint start,
const wxPoint end,
int  width,
EDA_DRAW_MODE_T  tracemode 
)
protected

Cdonvert a thick segment and plot it as an oval.

Definition at line 388 of file class_plotter.cpp.

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

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

390 {
391  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
392  wxSize size( end.x - start.x, end.y - start.y );
393  double orient;
394 
395  if( size.y == 0 )
396  orient = 0;
397  else if( size.x == 0 )
398  orient = 900;
399  else
400  orient = -ArcTangente( size.y, size.x );
401 
402  size.x = KiROUND( EuclideanNorm( size ) ) + width;
403  size.y = width;
404 
405  FlashPadOval( center, size, orient, tracemode, NULL );
406 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:112
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
virtual void PLOTTER::SetDash ( int  dashed)
pure virtual
virtual void PLOTTER::SetDefaultLineWidth ( int  width)
pure virtual

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

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

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

virtual void PLOTTER::SetGerberCoordinatesFormat ( int  aResolution,
bool  aUseInches = false 
)
inlinevirtual

Reimplemented in GERBER_PLOTTER.

Definition at line 432 of file class_plotter.h.

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

433  {
434  // NOP for most plotters. Only for Gerber plotter
435  }
virtual void PLOTTER::SetLayerPolarity ( bool  aPositive)
inlinevirtual

Function SetLayerPolarity sets current Gerber layer polarity to positive or negative by writing %LPD*% or %LPC*% to the Gerber file, respectively.

(obviously starts a new Gerber layer, too)

Parameters
aPositiveis the layer polarity and true for positive. It's not useful with most other plotter since they can't 'scratch' the film like photoplotter imagers do

Reimplemented in GERBER_PLOTTER.

Definition at line 418 of file class_plotter.h.

Referenced by PlotOneBoardLayer().

419  {
420  // NOP for most plotters
421  }
virtual void PLOTTER::SetNegative ( bool  _negative)
inlinevirtual

Definition at line 120 of file class_plotter.h.

References negativeMode.

Referenced by FillNegativeKnockout().

121  {
122  negativeMode = _negative;
123  }
bool negativeMode
true to plot in color, false to plot in black and white
virtual void PLOTTER::SetTextMode ( PlotTextMode  mode)
inlinevirtual

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 427 of file class_plotter.h.

Referenced by initializePlotter(), and PlotOneBoardLayer().

428  {
429  // NOP for most plotters.
430  }
virtual void PLOTTER::SetTitle ( const wxString &  aTitle)
inlinevirtual

Definition at line 165 of file class_plotter.h.

References title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

166  {
167  title = aTitle;
168  }
wxString title
virtual void PLOTTER::SetViewport ( const wxPoint aOffset,
double  aIusPerDecimil,
double  aScale,
bool  aMirror 
)
pure virtual

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)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, SVG_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and HPGL_PLOTTER.

Referenced by GENDRILL_WRITER_BASE::genDrillMapFile(), initializePlotter(), and DIALOG_PLOT_SCHEMATIC::setupPlotPagePDF().

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

Definition at line 409 of file class_plotter.cpp.

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

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

410 {
411  SetCurrentLineWidth( width );
412  width = currentPenWidth;
413  int radius, deltaxy, cx, cy;
414  wxSize size( aSize );
415 
416  if( size.x > size.y )
417  {
418  std::swap( size.x, size.y );
419  orient = AddAngles( orient, 900 );
420  }
421 
422  deltaxy = size.y - size.x; /* distance between centers of the oval */
423  radius = ( size.x - width ) / 2;
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 = radius;
434  cy = -deltaxy / 2;
435  RotatePoint( &cx, &cy, orient );
436  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
437  cx = radius;
438  cy = deltaxy / 2;
439  RotatePoint( &cx, &cy, orient );
440  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
441 
442  cx = 0;
443  cy = deltaxy / 2;
444  RotatePoint( &cx, &cy, orient );
445  Arc( wxPoint( cx + pos.x, cy + pos.y ),
446  orient + 1800, orient + 3600,
447  radius, NO_FILL );
448  cx = 0;
449  cy = -deltaxy / 2;
450  RotatePoint( &cx, &cy, orient );
451  Arc( wxPoint( cx + pos.x, cy + pos.y ),
452  orient, orient + 1800,
453  radius, NO_FILL );
454 }
void FinishTo(const wxPoint &pos)
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:267
void MoveTo(const wxPoint &pos)
int currentPenWidth
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.
virtual void PLOTTER::StartBlock ( void *  aData)
inlinevirtual

calling this function allows to define the beginning of a group of drawing items, for instance in SVG or Gerber format.

(example: group all segments of a letter or a text)

Parameters
aDatacan define any parameter for most of plotters: do nothing

Reimplemented in GERBER_PLOTTER.

Definition at line 444 of file class_plotter.h.

Referenced by PlotSilkScreen(), and PlotStandardLayer().

444 {}
virtual bool PLOTTER::StartPlot ( )
pure virtual
void 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 
)
virtual

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 in DXF_PLOTTER, GERBER_PLOTTER, SVG_PLOTTER, PDF_PLOTTER, and PS_PLOTTER.

Definition at line 229 of file drawtxt.cpp.

References Clamp_Text_PenSize(), DrawGraphicText(), GetPenSizeForBold(), min, SetColor(), and SetCurrentLineWidth().

Referenced by GENDRILL_WRITER_BASE::genDrillMapFile(), LIB_TEXT::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), LIB_FIELD::Plot(), SCH_SHEET::Plot(), LIB_PIN::PlotPinTexts(), BRDITEMS_PLOTTER::PlotTextePcb(), BRDITEMS_PLOTTER::PlotTextModule(), PlotWorkSheet(), PS_PLOTTER::Text(), PDF_PLOTTER::Text(), SVG_PLOTTER::Text(), GERBER_PLOTTER::Text(), and DXF_PLOTTER::Text().

241 {
242  int textPensize = aWidth;
243 
244  if( textPensize == 0 && aBold ) // Use default values if aWidth == 0
245  textPensize = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
246 
247  if( textPensize >= 0 )
248  textPensize = Clamp_Text_PenSize( aWidth, aSize, aBold );
249  else
250  textPensize = -Clamp_Text_PenSize( -aWidth, aSize, aBold );
251 
252  SetCurrentLineWidth( textPensize, aData );
253 
254  SetColor( aColor );
255 
256  DrawGraphicText( NULL, NULL, aPos, aColor, aText,
257  aOrient, aSize,
258  aH_justify, aV_justify,
259  textPensize, aItalic, aBold, NULL, this );
260 
261  if( aWidth != textPensize )
262  SetCurrentLineWidth( aWidth, aData );
263 }
void DrawGraphicText(EDA_RECT *aClipBox, wxDC *aDC, const wxPoint &aPos, 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, void(*aCallback)(int x0, int y0, int xf, int yf), PLOTTER *aPlotter)
Function DrawGraphicText Draw a graphic text (like module texts)
Definition: drawtxt.cpp:122
virtual void SetColor(COLOR4D color)=0
int Clamp_Text_PenSize(int aPenSize, int aSize, bool aBold)
Function Clamp_Text_PenSize As a rule, pen width should not be >1/4em, otherwise the character will b...
Definition: drawtxt.cpp:67
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
Definition: drawtxt.cpp:49
#define min(a, b)
Definition: auxiliary.h:85
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
void PLOTTER::ThickArc ( const wxPoint centre,
double  StAngle,
double  EndAngle,
int  rayon,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 474 of file class_plotter.cpp.

References Arc(), currentPenWidth, FILLED, NO_FILL, and SetCurrentLineWidth().

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

476 {
477  if( tracemode == FILLED )
478  Arc( centre, StAngle, EndAngle, radius, NO_FILL, width );
479  else
480  {
481  SetCurrentLineWidth( -1 );
482  Arc( centre, StAngle, EndAngle,
483  radius - ( width - currentPenWidth ) / 2, NO_FILL, -1 );
484  Arc( centre, StAngle, EndAngle,
485  radius + ( width - currentPenWidth ) / 2, NO_FILL, -1 );
486  }
487 }
int currentPenWidth
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 PLOTTER::ThickCircle ( const wxPoint pos,
int  diametre,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 512 of file class_plotter.cpp.

References Circle(), currentPenWidth, FILLED, NO_FILL, and SetCurrentLineWidth().

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

514 {
515  if( tracemode == FILLED )
516  Circle( pos, diametre, NO_FILL, width );
517  else
518  {
519  SetCurrentLineWidth( -1 );
520  Circle( pos, diametre - width + currentPenWidth, NO_FILL, -1 );
521  Circle( pos, diametre + width - currentPenWidth, NO_FILL, -1 );
522  }
523 }
int currentPenWidth
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
void PLOTTER::ThickRect ( const wxPoint p1,
const wxPoint p2,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 490 of file class_plotter.cpp.

References currentPenWidth, FILLED, NO_FILL, Rect(), SetCurrentLineWidth(), wxPoint::x, and wxPoint::y.

492 {
493  if( tracemode == FILLED )
494  Rect( p1, p2, NO_FILL, width );
495  else
496  {
497  SetCurrentLineWidth( -1 );
498  wxPoint offsetp1( p1.x - (width - currentPenWidth) / 2,
499  p1.y - (width - currentPenWidth) / 2 );
500  wxPoint offsetp2( p2.x + (width - currentPenWidth) / 2,
501  p2.y + (width - currentPenWidth) / 2 );
502  Rect( offsetp1, offsetp2, NO_FILL, -1 );
503  offsetp1.x += (width - currentPenWidth);
504  offsetp1.y += (width - currentPenWidth);
505  offsetp2.x -= (width - currentPenWidth);
506  offsetp2.y -= (width - currentPenWidth);
507  Rect( offsetp1, offsetp2, NO_FILL, -1 );
508  }
509 }
int currentPenWidth
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
void PLOTTER::ThickSegment ( const wxPoint start,
const wxPoint end,
int  width,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
virtual

Reimplemented in DXF_PLOTTER, GERBER_PLOTTER, and HPGL_PLOTTER.

Definition at line 457 of file class_plotter.cpp.

References FILLED, FinishTo(), MoveTo(), segmentAsOval(), and SetCurrentLineWidth().

Referenced by PSLIKE_PLOTTER::FlashPadOval(), BRDITEMS_PLOTTER::Plot_1_EdgeModule(), BRDITEMS_PLOTTER::PlotDrawSegment(), BRDITEMS_PLOTTER::PlotFilledAreas(), PlotLayerOutlines(), PlotSilkScreen(), and PlotStandardLayer().

459 {
460  if( tracemode == FILLED )
461  {
462  SetCurrentLineWidth( width );
463  MoveTo( start );
464  FinishTo( end );
465  }
466  else
467  {
468  SetCurrentLineWidth( -1 );
469  segmentAsOval( start, end, width, tracemode );
470  }
471 }
void FinishTo(const wxPoint &pos)
void MoveTo(const wxPoint &pos)
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.
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.
DPOINT PLOTTER::userToDeviceCoordinates ( const wxPoint aCoordinate)
protectedvirtual

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

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

Definition at line 99 of file class_plotter.cpp.

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

Referenced by HPGL_PLOTTER::Arc(), PS_PLOTTER::Arc(), PDF_PLOTTER::Arc(), SVG_PLOTTER::Arc(), GERBER_PLOTTER::Arc(), DXF_PLOTTER::Arc(), PS_PLOTTER::Circle(), PDF_PLOTTER::Circle(), SVG_PLOTTER::Circle(), DXF_PLOTTER::Circle(), PSLIKE_PLOTTER::computeTextParameters(), HPGL_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::FlashPadOval(), GERBER_PLOTTER::FlashPadRect(), HPGL_PLOTTER::PenTo(), PS_PLOTTER::PenTo(), PDF_PLOTTER::PenTo(), SVG_PLOTTER::PenTo(), GERBER_PLOTTER::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().

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

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

Definition at line 124 of file class_plotter.cpp.

References iuPerDeviceUnit, and 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(), GetDashGapLenIU(), GetDotMarkLenIU(), 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().

125 {
126  return DPOINT( size.x * plotScale * iuPerDeviceUnit,
127  size.y * plotScale * iuPerDeviceUnit );
128 }
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
VECTOR2< double > DPOINT
Definition: vector2d.h:594
double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtual

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

Definition at line 131 of file class_plotter.cpp.

References iuPerDeviceUnit, and plotScale.

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

Member Data Documentation

wxString PLOTTER::creator
protected
double PLOTTER::m_dotMarkLength_mm
private

Dotted line parameter in mm: segment.

Definition at line 99 of file class_plotter.h.

Referenced by GetDotMarkLenIU(), and PLOTTER().

wxArrayString PLOTTER::m_headerExtraLines
protected
bool PLOTTER::m_mirrorIsHorizontal
protected
bool PLOTTER::m_yaxisReversed
protected

true to mirror horizontally (else vertically)

Definition at line 550 of file class_plotter.h.

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

const unsigned PLOTTER::MARKER_COUNT = 58
static

Draw a marker (used for the drill map)

Definition at line 400 of file class_plotter.h.

Referenced by Marker().

bool PLOTTER::negativeMode
protected

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

Definition at line 557 of file class_plotter.h.

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

FILE* PLOTTER::outputFile
protected

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

Output file

Definition at line 553 of file class_plotter.h.

Referenced by HPGL_PLOTTER::Arc(), PS_PLOTTER::Arc(), SVG_PLOTTER::Arc(), GERBER_PLOTTER::Arc(), DXF_PLOTTER::Arc(), HPGL_PLOTTER::Circle(), PS_PLOTTER::Circle(), SVG_PLOTTER::Circle(), DXF_PLOTTER::Circle(), GERBER_PLOTTER::clearNetAttribute(), PDF_PLOTTER::ClosePage(), PDF_PLOTTER::closePdfObject(), PDF_PLOTTER::closePdfStream(), GERBER_PLOTTER::emitDcode(), PS_PLOTTER::emitSetRGBColor(), HPGL_PLOTTER::EndPlot(), PS_PLOTTER::EndPlot(), PDF_PLOTTER::EndPlot(), SVG_PLOTTER::EndPlot(), GERBER_PLOTTER::EndPlot(), DXF_PLOTTER::EndPlot(), HPGL_PLOTTER::FlashPadCircle(), DXF_PLOTTER::FlashPadCircle(), HPGL_PLOTTER::FlashPadOval(), PSLIKE_PLOTTER::FlashPadOval(), GERBER_PLOTTER::FlashPadOval(), DXF_PLOTTER::FlashPadOval(), GERBER_PLOTTER::FlashPadRect(), DXF_PLOTTER::FlashPadRect(), DXF_PLOTTER::FlashPadTrapez(), GERBER_PLOTTER::formatNetAttribute(), OpenFile(), PDF_PLOTTER::OpenFile(), HPGL_PLOTTER::penControl(), HPGL_PLOTTER::PenTo(), PS_PLOTTER::PenTo(), SVG_PLOTTER::PenTo(), GERBER_PLOTTER::PenTo(), DXF_PLOTTER::PenTo(), PS_PLOTTER::PlotImage(), HPGL_PLOTTER::PlotPoly(), PS_PLOTTER::PlotPoly(), SVG_PLOTTER::PlotPoly(), GERBER_PLOTTER::PlotPoly(), PLOTTER(), HPGL_PLOTTER::Rect(), PS_PLOTTER::Rect(), SVG_PLOTTER::Rect(), DXF_PLOTTER::Rect(), GERBER_PLOTTER::selectAperture(), PS_PLOTTER::SetCurrentLineWidth(), HPGL_PLOTTER::SetDash(), PS_PLOTTER::SetDash(), GERBER_PLOTTER::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(), GERBER_PLOTTER::StartPlot(), DXF_PLOTTER::StartPlot(), PS_PLOTTER::Text(), DXF_PLOTTER::Text(), HPGL_PLOTTER::ThickSegment(), GERBER_PLOTTER::writeApertureList(), and ~PLOTTER().

wxPoint PLOTTER::penLastpos
protected

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

Definition at line 563 of file class_plotter.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
protected

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

Definition at line 561 of file class_plotter.h.

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

wxString PLOTTER::title
protected

Definition at line 566 of file class_plotter.h.

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


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