KiCad PCB EDA Suite
PLOTTER Class Referenceabstract

Base plotter engine class. More...

#include <plot_common.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 (bool 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 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 x0, y0. 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 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_dashMarkLength_mm
 Dashed line parameter in mm: segment. More...
 
double m_dashGapLength_mm
 Dashed line parameter in mm: gap. 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 86 of file plot_common.h.

Constructor & Destructor Documentation

PLOTTER::PLOTTER ( )

Definition at line 51 of file class_plotter.cpp.

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

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

Definition at line 70 of file class_plotter.cpp.

References outputFile.

71 {
72  // Emergency cleanup, but closing the file is
73  // usually made in EndPlot().
74  if( outputFile )
75  fclose( outputFile );
76 }
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plot_common.h:534

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 166 of file plot_common.h.

References m_headerExtraLines.

Referenced by AddGerberX2Attribute().

167  {
168  m_headerExtraLines.Add( aExtraString );
169  }
wxArrayString m_headerExtraLines
Definition: plot_common.h:552
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 146 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().

148 {
149  wxPoint start, end;
150  const int delta = 50; // increment (in 0.1 degrees) to draw circles
151 
152  if( StAngle > EndAngle )
153  std::swap( StAngle, EndAngle );
154 
155  SetCurrentLineWidth( width );
156  /* Please NOTE the different sign due to Y-axis flip */
157  start.x = centre.x + KiROUND( cosdecideg( radius, -StAngle ) );
158  start.y = centre.y + KiROUND( sindecideg( radius, -StAngle ) );
159  MoveTo( start );
160  for( int ii = StAngle + delta; ii < EndAngle; ii += delta )
161  {
162  end.x = centre.x + KiROUND( cosdecideg( radius, -ii ) );
163  end.y = centre.y + KiROUND( sindecideg( radius, -ii ) );
164  LineTo( end );
165  }
166 
167  end.x = centre.x + KiROUND( cosdecideg( radius, -EndAngle ) );
168  end.y = centre.y + KiROUND( sindecideg( radius, -EndAngle ) );
169  FinishTo( end );
170 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
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)
Definition: plot_common.h:236
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
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
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 175 of file plot_common.h.

References m_headerExtraLines.

Referenced by StartPlotBoard().

176  {
177  m_headerExtraLines.Clear();
178  }
wxArrayString m_headerExtraLines
Definition: plot_common.h:552
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 436 of file plot_common.h.

Referenced by PlotSilkScreen(), and PlotStandardLayer().

436 {}
virtual bool PLOTTER::EndPlot ( )
pure virtual
void PLOTTER::FinishTo ( const wxPoint pos)
inline
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
aSize= size of rounded rect
cornerRadiusRadius of the rounded corners
aOrientThe rotation of the shape
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format)

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)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

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 rounded rect
cornerRadiusRadius of the rounded corners
aOrientThe rotation of the shape
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format)

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

Referenced by EXCELLON_WRITER::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
cornerRadiusRadius of the rounded corners
aOrientThe rotation of the shape
aTraceModeFILLED or SKETCH
aDataan auxuliary info (mainly for gerber format)

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
cornerRadiusRadius of the rounded corners
aOrientThe rotation of the shape
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format)

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
aTrace_Mode= FILLED or SKETCH

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PSLIKE_PLOTTER, and HPGL_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

bool PLOTTER::GetColorMode ( ) const
inline

Definition at line 121 of file plot_common.h.

References 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:537
double PLOTTER::GetDashGapLenIU ( ) const
protected

Definition at line 141 of file class_plotter.cpp.

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

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

142 {
144 }
double m_IUsPerDecimil
Definition: plot_common.h:519
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
protected

Definition at line 134 of file class_plotter.cpp.

References GetCurrentLineWidth(), m_dashMarkLength_mm, m_IUsPerDecimil, and 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:519
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
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 207 of file plot_common.h.

References m_IUsPerDecimil.

Referenced by PlotWorkSheet().

207 { return m_IUsPerDecimil; }
double m_IUsPerDecimil
Definition: plot_common.h:519
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 236 of file plot_common.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().

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 
)

Draw a pattern shape number aShapeId, to coord x0, y0.

x0, y0 = coordinates tables Diameter diameter = (coord table) hole AShapeId = index (used to generate forms characters)

Definition at line 273 of file class_plotter.cpp.

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

Referenced by EXCELLON_WRITER::GenDrillMapFile(), and EXCELLON_WRITER::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:382
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 259 of file class_plotter.cpp.

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

Referenced by 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 
)
protected

Plot a circle centered on the position.

Building block for markers

Definition at line 215 of file class_plotter.cpp.

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

Referenced by 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 
)
protected

Plot a - bar centered on the position.

Building block for markers

Definition at line 245 of file class_plotter.cpp.

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

Referenced by 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 
)
protected

Plot a lozenge centered on the position.

Building block for markers

Definition at line 221 of file class_plotter.cpp.

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

Referenced by 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 
)
protected

Plot a / bar centered on the position.

Building block for markers

Definition at line 252 of file class_plotter.cpp.

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

Referenced by 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 
)
protected

Plot a square centered on the position.

Building block for markers

Definition at line 190 of file class_plotter.cpp.

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

Referenced by 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 
)
protected

Plot a | bar centered on the position.

Building block for markers

Definition at line 266 of file class_plotter.cpp.

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

Referenced by 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)
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 79 of file class_plotter.cpp.

References filename, and outputFile.

Referenced by EXCELLON_WRITER::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:534
wxString filename
Definition: plot_common.h:546
void PLOTTER::PenFinish ( )
inline

Definition at line 247 of file plot_common.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().

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

References NO_FILL, 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
virtual void PLOTTER::PlotPoly ( const std::vector< wxPoint > &  aCornerList,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = NULL 
)
pure virtual
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 379 of file class_plotter.cpp.

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

Referenced by ThickSegment(), HPGL_PLOTTER::ThickSegment(), GERBER_PLOTTER::ThickSegment(), and DXF_PLOTTER::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
virtual void PLOTTER::SetDash ( bool  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 EXCELLON_WRITER::GenDrillMapFile(), and initializePlotter().

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

Reimplemented in GERBER_PLOTTER.

Definition at line 415 of file plot_common.h.

Referenced by EXCELLON_WRITER::GenDrillMapFile(), and initializePlotter().

416  {
417  // NOP for most plotters. Only for Gerber plotter
418  }
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 401 of file plot_common.h.

Referenced by PlotOneBoardLayer().

402  {
403  // NOP for most plotters
404  }
virtual void PLOTTER::SetNegative ( bool  _negative)
inlinevirtual

Definition at line 111 of file plot_common.h.

References 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:538
void PLOTTER::SetPageSettings ( const PAGE_INFO aPageSettings)
virtual
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 410 of file plot_common.h.

Referenced by initializePlotter(), and PlotOneBoardLayer().

411  {
412  // NOP for most plotters.
413  }
virtual void PLOTTER::SetTitle ( const wxString &  aTitle)
inlinevirtual

Definition at line 156 of file plot_common.h.

References title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

157  {
158  title = aTitle;
159  }
wxString title
Definition: plot_common.h:547
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 EXCELLON_WRITER::GenDrillMapFile(), initializePlotter(), and DIALOG_PLOT_SCHEMATIC::setupPlotPagePDF().

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

Definition at line 400 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().

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:540
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 427 of file plot_common.h.

Referenced by PlotSilkScreen(), and PlotStandardLayer().

427 {}
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

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

Definition at line 227 of file drawtxt.cpp.

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

Referenced by EXCELLON_WRITER::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().

239 {
240  int textPensize = aWidth;
241 
242  if( textPensize == 0 && aBold ) // Use default values if aWidth == 0
243  textPensize = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
244 
245  if( textPensize >= 0 )
246  textPensize = Clamp_Text_PenSize( aWidth, aSize, aBold );
247  else
248  textPensize = -Clamp_Text_PenSize( -aWidth, aSize, aBold );
249 
250  SetCurrentLineWidth( textPensize, aData );
251 
252  SetColor( aColor );
253 
254  DrawGraphicText( NULL, NULL, aPos, aColor, aText,
255  aOrient, aSize,
256  aH_justify, aV_justify,
257  textPensize, aItalic, aBold, NULL, this );
258 
259  if( aWidth != textPensize )
260  SetCurrentLineWidth( aWidth, aData );
261 }
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 465 of file class_plotter.cpp.

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

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

467 {
468  if( tracemode == FILLED )
469  Arc( centre, StAngle, EndAngle, radius, NO_FILL, width );
470  else
471  {
472  SetCurrentLineWidth( -1 );
473  Arc( centre, StAngle, EndAngle,
474  radius - ( width - currentPenWidth ) / 2, NO_FILL, -1 );
475  Arc( centre, StAngle, EndAngle,
476  radius + ( width - currentPenWidth ) / 2, NO_FILL, -1 );
477  }
478 }
int currentPenWidth
Definition: plot_common.h:540
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 503 of file class_plotter.cpp.

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

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

504 {
505  if( tracemode == FILLED )
506  Circle( pos, diametre, NO_FILL, width );
507  else
508  {
509  SetCurrentLineWidth( -1 );
510  Circle( pos, diametre - width + currentPenWidth, NO_FILL, -1 );
511  Circle( pos, diametre + width - currentPenWidth, NO_FILL, -1 );
512  }
513 }
int currentPenWidth
Definition: plot_common.h:540
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 481 of file class_plotter.cpp.

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

483 {
484  if( tracemode == FILLED )
485  Rect( p1, p2, NO_FILL, width );
486  else
487  {
488  SetCurrentLineWidth( -1 );
489  wxPoint offsetp1( p1.x - (width - currentPenWidth) / 2,
490  p1.y - (width - currentPenWidth) / 2 );
491  wxPoint offsetp2( p2.x + (width - currentPenWidth) / 2,
492  p2.y + (width - currentPenWidth) / 2 );
493  Rect( offsetp1, offsetp2, NO_FILL, -1 );
494  offsetp1.x += (width - currentPenWidth);
495  offsetp1.y += (width - currentPenWidth);
496  offsetp2.x -= (width - currentPenWidth);
497  offsetp2.y -= (width - currentPenWidth);
498  Rect( offsetp1, offsetp2, NO_FILL, -1 );
499  }
500 }
int currentPenWidth
Definition: plot_common.h:540
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 448 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().

450 {
451  if( tracemode == FILLED )
452  {
453  SetCurrentLineWidth( width );
454  MoveTo( start );
455  FinishTo( end );
456  }
457  else
458  {
459  SetCurrentLineWidth( -1 );
460  segmentAsOval( start, end, width, tracemode );
461  }
462 }
void FinishTo(const wxPoint &pos)
Definition: plot_common.h:241
void MoveTo(const wxPoint &pos)
Definition: plot_common.h:231
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 96 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().

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:525
bool m_yaxisReversed
true to mirror horizontally (else vertically)
Definition: plot_common.h:531
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plot_common.h:529
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plot_common.h:513
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plot_common.h:522
VECTOR2< double > DPOINT
Definition: vector2d.h:595
wxSize paperSize
Paper size in IU - not in mils.
Definition: plot_common.h:550
bool m_mirrorIsHorizontal
Definition: plot_common.h:530
DPOINT PLOTTER::userToDeviceSize ( const wxSize &  size)
protectedvirtual

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

Definition at line 121 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(), 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:513
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plot_common.h:522
VECTOR2< double > DPOINT
Definition: vector2d.h:595
double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtual

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

Definition at line 128 of file class_plotter.cpp.

References iuPerDeviceUnit, and 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:513
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plot_common.h:522

Member Data Documentation

wxString PLOTTER::creator
protected
const int PLOTTER::DO_NOT_SET_LINE_WIDTH = -2
static
double PLOTTER::m_dashGapLength_mm
private

Dashed line parameter in mm: gap.

Definition at line 90 of file plot_common.h.

Referenced by GetDashGapLenIU(), and PLOTTER().

double PLOTTER::m_dashMarkLength_mm
private

Dashed line parameter in mm: segment.

Definition at line 89 of file plot_common.h.

Referenced by GetDashMarkLenIU(), and PLOTTER().

wxArrayString PLOTTER::m_headerExtraLines
protected

Definition at line 552 of file plot_common.h.

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

bool PLOTTER::m_mirrorIsHorizontal
protected

Definition at line 530 of file plot_common.h.

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

bool PLOTTER::m_plotMirror
protected
bool PLOTTER::m_yaxisReversed
protected

true to mirror horizontally (else vertically)

Definition at line 531 of file plot_common.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 382 of file plot_common.h.

Referenced by Marker().

bool PLOTTER::negativeMode
protected

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

Definition at line 538 of file plot_common.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 534 of file plot_common.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(), DXF_PLOTTER::SetColor(), PS_PLOTTER::SetCurrentLineWidth(), HPGL_PLOTTER::SetDash(), PS_PLOTTER::SetDash(), GERBER_PLOTTER::SetLayerPolarity(), SetPageSettings(), SVG_PLOTTER::setSVGPlotStyle(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), GERBER_PLOTTER::SetViewport(), DXF_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 544 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
protected

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

Definition at line 542 of file plot_common.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 547 of file plot_common.h.

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


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