KiCad PCB EDA Suite
PDF_PLOTTER Class Reference

#include <plotters_pslike.h>

Inheritance diagram for PDF_PLOTTER:
PSLIKE_PLOTTER PLOTTER

Public Member Functions

 PDF_PLOTTER ()
 
virtual PLOT_FORMAT GetPlotterType () const override
 Returns the effective plot engine in use. More...
 
virtual bool OpenFile (const wxString &aFullFilename) override
 Open or create the plot file aFullFilename. More...
 
virtual bool StartPlot () override
 The PDF engine supports multiple pages; the first one is opened 'for free' the following are to be closed and reopened. More...
 
virtual bool EndPlot () override
 
virtual void StartPage ()
 Starts a new page in the PDF document. More...
 
virtual void ClosePage ()
 Close the current page in the PDF document (and emit its compressed stream) More...
 
virtual void SetCurrentLineWidth (int width, void *aData=NULL) override
 Pen width setting for PDF. More...
 
virtual void SetDash (PLOT_DASH_TYPE dashed) override
 PDF supports dashed lines. More...
 
virtual void SetViewport (const wxPoint &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
 PDF can have multiple pages, so SetPageSettings can be called with the outputFile open (but not inside a page stream!) More...
 
virtual void Rect (const wxPoint &p1, const wxPoint &p2, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
 Rectangles in PDF. More...
 
virtual void Circle (const wxPoint &pos, int diametre, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
 Circle drawing for PDF. More...
 
virtual void Arc (const wxPoint &centre, double StAngle, double EndAngle, int rayon, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
 The PDF engine can't directly plot arcs, it uses the base emulation. More...
 
virtual void PlotPoly (const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL) override
 Polygon plotting for PDF. More...
 
virtual void PenTo (const wxPoint &pos, char plume) override
 moveto/lineto primitive, moves the 'pen' to the specified direction More...
 
virtual void Text (const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL) override
 Draws text with the plotter. More...
 
virtual void PlotImage (const wxImage &aImage, const wxPoint &aPos, double aScaleFactor) override
 PDF images are handles as inline, not XObject streams... More...
 
virtual void SetTextMode (PLOT_TEXT_MODE mode) override
 PS and PDF fully implement native text (for the Latin-1 subset) More...
 
void SetScaleAdjust (double scaleX, double scaleY)
 Set the 'fine' scaling for the postscript engine. More...
 
virtual void FlashPadCircle (const wxPoint &aPadPos, int aDiameter, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadOval (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadRect (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadRoundRect (const wxPoint &aPadPos, const wxSize &aSize, int aCornerRadius, double aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadCustom (const wxPoint &aPadPos, const wxSize &aSize, double aOrient, SHAPE_POLY_SET *aPolygons, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadTrapez (const wxPoint &aPadPos, const wxPoint *aCorners, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a trapezoidal pad. More...
 
virtual void FlashRegularPolygon (const wxPoint &aShapePos, int aDiameter, int aCornerCount, double aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a regular polygon. More...
 
virtual void SetColor (COLOR4D color) override
 The SetColor implementation is split with the subclasses: The PSLIKE computes the rgb values, the subclass emits the operator to actually do it. More...
 
virtual void SetNegative (bool aNegative)
 
virtual void SetColorMode (bool aColorMode)
 Plot in B/W or color. More...
 
bool GetColorMode () const
 
void SetRenderSettings (RENDER_SETTINGS *aSettings)
 
RENDER_SETTINGSRenderSettings ()
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings)
 
PAGE_INFOPageSettings ()
 
virtual int GetCurrentLineWidth () const
 
virtual void SetCreator (const wxString &aCreator)
 
virtual void SetTitle (const wxString &aTitle)
 
void AddLineToHeader (const wxString &aExtraString)
 Add a line to the list of free lines to print at the beginning of the file. More...
 
void ClearHeaderLinesList ()
 Remove all lines from the list of free lines to print at the beginning of the file. More...
 
double GetIUsPerDecimil () const
 The IUs per decimil are an essential scaling factor when plotting; they are set and saved when establishing the viewport. More...
 
int GetPlotterArcLowDef () const
 
int GetPlotterArcHighDef () const
 
virtual void BezierCurve (const wxPoint &aStart, const wxPoint &aControl1, const wxPoint &aControl2, const wxPoint &aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH)
 Generic fallback: Cubic Bezier curve rendered as a polyline In KiCad the bezier curves have 4 control points: start ctrl1 ctrl2 end. More...
 
void MoveTo (const wxPoint &pos)
 
void LineTo (const wxPoint &pos)
 
void FinishTo (const wxPoint &pos)
 
void PenFinish ()
 
virtual void PlotPoly (const SHAPE_LINE_CHAIN &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)
 Draw a polygon ( filled or not ) More...
 
virtual void ThickSegment (const wxPoint &start, const wxPoint &end, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void ThickArc (const wxPoint &centre, double StAngle, double EndAngle, int rayon, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void ThickRect (const wxPoint &p1, const wxPoint &p2, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void ThickCircle (const wxPoint &pos, int diametre, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void FilledCircle (const wxPoint &pos, int diametre, OUTLINE_MODE tracemode, void *aData)
 
void Marker (const wxPoint &position, int diametre, unsigned aShapeId)
 Draw a pattern shape number aShapeId, to coord position. More...
 
virtual void SetLayerPolarity (bool aPositive)
 Set the current Gerber layer polarity to positive or negative by writing %LPD*% or %LPC*% to the Gerber file, respectively. More...
 
virtual void SetGerberCoordinatesFormat (int aResolution, bool aUseInches=false)
 
virtual void SetSvgCoordinatesFormat (unsigned aResolution, bool aUseInches=false)
 
virtual void StartBlock (void *aData)
 calling this function allows one 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 one to define the end of a group of drawing items for instance in SVG or Gerber format. More...
 

Static Public Member Functions

static wxString GetDefaultFileExtension ()
 

Static Public Attributes

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

Protected Member Functions

std::string encodeStringForPlotter (const wxString &aUnicode) override
 convert a wxString unicode string to a char string compatible with the accepted string PDF format (convert special chars and non ascii7 chars) More...
 
virtual void emitSetRGBColor (double r, double g, double b) override
 PDF supports colors fully. More...
 
int allocPdfObject ()
 Allocate a new handle in the table of the PDF object. More...
 
int startPdfObject (int handle=-1)
 Open a new PDF object and returns the handle if the parameter is -1. More...
 
void closePdfObject ()
 Close the current PDF object. More...
 
int startPdfStream (int handle=-1)
 Starts a PDF stream (for the page). More...
 
void closePdfStream ()
 Finish the current PDF stream (writes the deferred length, too) More...
 
void computeTextParameters (const wxPoint &aPos, const wxString &aText, int aOrient, const wxSize &aSize, bool aMirror, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, double *wideningFactor, double *ctm_a, double *ctm_b, double *ctm_c, double *ctm_d, double *ctm_e, double *ctm_f, double *heightFactor)
 This is the core for postscript/PDF text alignment It computes the transformation matrix to generate a user space system aligned with the text. More...
 
void postscriptOverlinePositions (const wxString &aText, int aXSize, bool aItalic, bool aBold, std::vector< int > *pos_pairs)
 Computes the x coordinates for the overlining in a string of text. More...
 
int returnPostscriptTextWidth (const wxString &aText, int aXSize, bool aItalic, bool aBold)
 Sister function for the GraphicTextWidth in drawtxt.cpp Does the same processing (i.e. More...
 
void markerCircle (const wxPoint &pos, int radius)
 Plot a circle centered on the position. More...
 
void markerHBar (const wxPoint &pos, int radius)
 Plot a - bar centered on the position. More...
 
void markerSlash (const wxPoint &pos, int radius)
 Plot a / bar centered on the position. More...
 
void markerBackSlash (const wxPoint &pos, int radius)
 Plot a \ bar centered on the position. More...
 
void markerVBar (const wxPoint &pos, int radius)
 Plot a | bar centered on the position. More...
 
void markerSquare (const wxPoint &position, int radius)
 Plot a square centered on the position. More...
 
void markerLozenge (const wxPoint &position, int radius)
 Plot a lozenge centered on the position. More...
 
void segmentAsOval (const wxPoint &start, const wxPoint &end, int width, OUTLINE_MODE tracemode)
 Convert a thick segment and plot it as an oval. More...
 
void sketchOval (const wxPoint &pos, const wxSize &size, double orient, int width)
 
virtual DPOINT userToDeviceCoordinates (const wxPoint &aCoordinate)
 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

int pageTreeHandle
 
int fontResDictHandle
 Handle to the root of the page tree object. More...
 
std::vector< int > pageHandles
 Font resource dictionary. More...
 
int pageStreamHandle
 Handles to the page objects. More...
 
int streamLengthHandle
 Handle of the page content object. More...
 
wxString workFilename
 Handle to the deferred stream length. More...
 
FILE * workFile
 
std::vector< long > xrefTable
 Temporary file to construct the stream before zipping. More...
 
double plotScaleAdjX
 Fine user scale adjust ( = 1.0 if no correction) More...
 
double plotScaleAdjY
 
PLOT_TEXT_MODE m_textMode
 How to draw text. More...
 
double m_plotScale
 Plot scale - chosen by the user (even implicitly with 'fit in a4') More...
 
double m_IUsPerDecimil
 
double m_iuPerDeviceUnit
 
wxPoint m_plotOffset
 
bool m_plotMirror
 
bool m_mirrorIsHorizontal
 
bool m_yaxisReversed
 
FILE * m_outputFile
 Output file. More...
 
bool m_colorMode
 
bool m_negativeMode
 
int m_currentPenWidth
 
char m_penState
 
wxPoint m_penLastpos
 
wxString m_creator
 
wxString m_filename
 
wxString m_title
 
PAGE_INFO m_pageInfo
 
wxSize m_paperSize
 
wxArrayString m_headerExtraLines
 
RENDER_SETTINGSm_renderSettings
 

Static Protected Attributes

static const double postscriptTextAscent = 0.718
 Height of the postscript font (from the AFM) More...
 

Detailed Description

Definition at line 196 of file plotters_pslike.h.

Constructor & Destructor Documentation

◆ PDF_PLOTTER()

PDF_PLOTTER::PDF_PLOTTER ( )
inline

Definition at line 199 of file plotters_pslike.h.

199  :
200  pageTreeHandle( 0 ),
201  fontResDictHandle( 0 ),
202  pageStreamHandle( 0 ),
203  streamLengthHandle( 0 ),
204  workFile( nullptr )
205  {
206  }
int streamLengthHandle
Handle of the page content object.
int fontResDictHandle
Handle to the root of the page tree object.
int pageStreamHandle
Handles to the page objects.

Member Function Documentation

◆ AddLineToHeader()

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

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

Parameters
aExtraStringis the string to print

Definition at line 180 of file plotter.h.

181  {
182  m_headerExtraLines.Add( aExtraString );
183  }
wxArrayString m_headerExtraLines
Definition: plotter.h:595

References PLOTTER::m_headerExtraLines.

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

◆ allocPdfObject()

int PDF_PLOTTER::allocPdfObject ( )
protected

Allocate a new handle in the table of the PDF object.

The handle must be completed using startPdfObject. It's an in-RAM operation only, no output is done.

Definition at line 461 of file PDF_plotter.cpp.

462 {
463  xrefTable.push_back( 0 );
464  return xrefTable.size() - 1;
465 }
std::vector< long > xrefTable
Temporary file to construct the stream before zipping.

References xrefTable.

Referenced by startPdfObject(), startPdfStream(), and StartPlot().

◆ Arc()

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

The PDF engine can't directly plot arcs, it uses the base emulation.

So no filled arcs (not a great loss... )

Reimplemented from PLOTTER.

Definition at line 256 of file PDF_plotter.cpp.

258 {
259  wxASSERT( workFile );
260 
261  if( radius <= 0 )
262  {
263  Circle( centre, width, FILL_TYPE::FILLED_SHAPE, 0 );
264  return;
265  }
266 
267  /* Arcs are not so easily approximated by beziers (in the general case),
268  so we approximate them in the old way */
269  wxPoint start, end;
270  const int delta = 50; // increment (in 0.1 degrees) to draw circles
271 
272  if( StAngle > EndAngle )
273  std::swap( StAngle, EndAngle );
274 
275  SetCurrentLineWidth( width );
276 
277  // Usual trig arc plotting routine...
278  start.x = centre.x + KiROUND( cosdecideg( radius, -StAngle ) );
279  start.y = centre.y + KiROUND( sindecideg( radius, -StAngle ) );
280  DPOINT pos_dev = userToDeviceCoordinates( start );
281  fprintf( workFile, "%g %g m ", pos_dev.x, pos_dev.y );
282  for( int ii = StAngle + delta; ii < EndAngle; ii += delta )
283  {
284  end.x = centre.x + KiROUND( cosdecideg( radius, -ii ) );
285  end.y = centre.y + KiROUND( sindecideg( radius, -ii ) );
286  pos_dev = userToDeviceCoordinates( end );
287  fprintf( workFile, "%g %g l ", pos_dev.x, pos_dev.y );
288  }
289 
290  end.x = centre.x + KiROUND( cosdecideg( radius, -EndAngle ) );
291  end.y = centre.y + KiROUND( sindecideg( radius, -EndAngle ) );
292  pos_dev = userToDeviceCoordinates( end );
293  fprintf( workFile, "%g %g l ", pos_dev.x, pos_dev.y );
294 
295  // The arc is drawn... if not filled we stroke it, otherwise we finish
296  // closing the pie at the center
297  if( fill == FILL_TYPE::NO_FILL )
298  {
299  fputs( "S\n", workFile );
300  }
301  else
302  {
303  pos_dev = userToDeviceCoordinates( centre );
304  fprintf( workFile, "%g %g l b\n", pos_dev.x, pos_dev.y );
305  }
306 }
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
double cosdecideg(double r, double a)
Circle generation utility: computes r * cos(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:439
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:430
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH) override
Circle drawing for PDF.
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.

References Circle(), cosdecideg(), FILLED_SHAPE, KiROUND(), NO_FILL, SetCurrentLineWidth(), sindecideg(), PLOTTER::userToDeviceCoordinates(), workFile, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ BezierCurve()

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

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

Reimplemented in SVG_PLOTTER.

Definition at line 203 of file plotter.cpp.

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

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

Referenced by SVG_PLOTTER::BezierCurve(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), and BRDITEMS_PLOTTER::PlotPcbShape().

◆ Circle()

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

Circle drawing for PDF.

They're approximated by curves, but fill is supported

Implements PLOTTER.

Definition at line 203 of file PDF_plotter.cpp.

204 {
205  wxASSERT( workFile );
206  DPOINT pos_dev = userToDeviceCoordinates( pos );
207  double radius = userToDeviceSize( diametre / 2.0 );
208 
209  /* OK. Here's a trick. PDF doesn't support circles or circular angles, that's
210  a fact. You'll have to do with cubic beziers. These *can't* represent
211  circular arcs (NURBS can, beziers don't). But there is a widely known
212  approximation which is really good
213  */
214 
215  SetCurrentLineWidth( width );
216 
217  // If diameter is less than width, switch to filled mode
218  if( aFill == FILL_TYPE::NO_FILL && diametre < width )
219  {
220  aFill = FILL_TYPE::FILLED_SHAPE;
221  SetCurrentLineWidth( 0 );
222 
223  radius = userToDeviceSize( ( diametre / 2.0 ) + ( width / 2.0 ) );
224  }
225 
226  double magic = radius * 0.551784; // You don't want to know where this come from
227 
228  // This is the convex hull for the bezier approximated circle
229  fprintf( workFile, "%g %g m "
230  "%g %g %g %g %g %g c "
231  "%g %g %g %g %g %g c "
232  "%g %g %g %g %g %g c "
233  "%g %g %g %g %g %g c %c\n",
234  pos_dev.x - radius, pos_dev.y,
235 
236  pos_dev.x - radius, pos_dev.y + magic,
237  pos_dev.x - magic, pos_dev.y + radius,
238  pos_dev.x, pos_dev.y + radius,
239 
240  pos_dev.x + magic, pos_dev.y + radius,
241  pos_dev.x + radius, pos_dev.y + magic,
242  pos_dev.x + radius, pos_dev.y,
243 
244  pos_dev.x + radius, pos_dev.y - magic,
245  pos_dev.x + magic, pos_dev.y - radius,
246  pos_dev.x, pos_dev.y - radius,
247 
248  pos_dev.x - magic, pos_dev.y - radius,
249  pos_dev.x - radius, pos_dev.y - magic,
250  pos_dev.x - radius, pos_dev.y,
251 
252  aFill == FILL_TYPE::NO_FILL ? 's' : 'b' );
253 }
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:124
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.

References FILLED_SHAPE, NO_FILL, SetCurrentLineWidth(), PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), workFile, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Arc().

◆ ClearHeaderLinesList()

void PLOTTER::ClearHeaderLinesList ( )
inlineinherited

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

Definition at line 188 of file plotter.h.

189  {
190  m_headerExtraLines.Clear();
191  }
wxArrayString m_headerExtraLines
Definition: plotter.h:595

References PLOTTER::m_headerExtraLines.

Referenced by StartPlotBoard().

◆ ClosePage()

void PDF_PLOTTER::ClosePage ( )
virtual

Close the current page in the PDF document (and emit its compressed stream)

Definition at line 612 of file PDF_plotter.cpp.

613 {
614  wxASSERT( workFile );
615 
616  // Close the page stream (and compress it)
617  closePdfStream();
618 
619  // Emit the page object and put it in the page list for later
620  pageHandles.push_back( startPdfObject() );
621 
622  /* Page size is in 1/72 of inch (default user space units)
623  Works like the bbox in postscript but there is no need for
624  swapping the sizes, since PDF doesn't require a portrait page.
625  We use the MediaBox but PDF has lots of other less used boxes
626  to use */
627 
628  const double BIGPTsPERMIL = 0.072;
629  wxSize psPaperSize = m_pageInfo.GetSizeMils();
630 
631  fprintf( m_outputFile,
632  "<<\n"
633  "/Type /Page\n"
634  "/Parent %d 0 R\n"
635  "/Resources <<\n"
636  " /ProcSet [/PDF /Text /ImageC /ImageB]\n"
637  " /Font %d 0 R >>\n"
638  "/MediaBox [0 0 %d %d]\n"
639  "/Contents %d 0 R\n"
640  ">>\n",
643  int( ceil( psPaperSize.x * BIGPTsPERMIL ) ),
644  int( ceil( psPaperSize.y * BIGPTsPERMIL ) ),
646  closePdfObject();
647 
648  // Mark the page stream as idle
649  pageStreamHandle = 0;
650 }
void closePdfStream()
Finish the current PDF stream (writes the deferred length, too)
FILE * m_outputFile
Output file.
Definition: plotter.h:580
std::vector< int > pageHandles
Font resource dictionary.
int startPdfObject(int handle=-1)
Open a new PDF object and returns the handle if the parameter is -1.
const wxSize & GetSizeMils() const
Definition: page_info.h:135
void closePdfObject()
Close the current PDF object.
int fontResDictHandle
Handle to the root of the page tree object.
PAGE_INFO m_pageInfo
Definition: plotter.h:592
int pageStreamHandle
Handles to the page objects.

References closePdfObject(), closePdfStream(), fontResDictHandle, PAGE_INFO::GetSizeMils(), PLOTTER::m_outputFile, PLOTTER::m_pageInfo, pageHandles, pageStreamHandle, pageTreeHandle, startPdfObject(), and workFile.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), and EndPlot().

◆ closePdfObject()

void PDF_PLOTTER::closePdfObject ( )
protected

Close the current PDF object.

Definition at line 482 of file PDF_plotter.cpp.

483 {
484  wxASSERT( m_outputFile );
485  wxASSERT( !workFile );
486  fputs( "endobj\n", m_outputFile );
487 }
FILE * m_outputFile
Output file.
Definition: plotter.h:580

References PLOTTER::m_outputFile, and workFile.

Referenced by ClosePage(), closePdfStream(), and EndPlot().

◆ closePdfStream()

void PDF_PLOTTER::closePdfStream ( )
protected

Finish the current PDF stream (writes the deferred length, too)

Definition at line 521 of file PDF_plotter.cpp.

522 {
523  wxASSERT( workFile );
524 
525  long stream_len = ftell( workFile );
526 
527  if( stream_len < 0 )
528  {
529  wxASSERT( false );
530  return;
531  }
532 
533  // Rewind the file, read in the page stream and DEFLATE it
534  fseek( workFile, 0, SEEK_SET );
535  unsigned char *inbuf = new unsigned char[stream_len];
536 
537  int rc = fread( inbuf, 1, stream_len, workFile );
538  wxASSERT( rc == stream_len );
539  (void) rc;
540 
541  // We are done with the temporary file, junk it
542  fclose( workFile );
543  workFile = 0;
544  ::wxRemoveFile( workFilename );
545 
546  unsigned out_count;
547 
548  if( ADVANCED_CFG::GetCfg().m_DebugPDFWriter )
549  {
550  out_count = stream_len;
551  fwrite( inbuf, out_count, 1, m_outputFile );
552  }
553  else
554  {
555  // NULL means memos owns the memory, but provide a hint on optimum size needed.
556  wxMemoryOutputStream memos( NULL, std::max( 2000l, stream_len ) ) ;
557 
558  {
559  /* Somewhat standard parameters to compress in DEFLATE. The PDF spec is
560  * misleading, it says it wants a DEFLATE stream but it really want a ZLIB
561  * stream! (a DEFLATE stream would be generated with -15 instead of 15)
562  * rc = deflateInit2( &zstrm, Z_BEST_COMPRESSION, Z_DEFLATED, 15,
563  * 8, Z_DEFAULT_STRATEGY );
564  */
565 
566  wxZlibOutputStream zos( memos, wxZ_BEST_COMPRESSION, wxZLIB_ZLIB );
567 
568  zos.Write( inbuf, stream_len );
569  } // flush the zip stream using zos destructor
570 
571  wxStreamBuffer* sb = memos.GetOutputStreamBuffer();
572 
573  out_count = sb->Tell();
574  fwrite( sb->GetBufferStart(), 1, out_count, m_outputFile );
575  }
576 
577  delete[] inbuf;
578  fputs( "endstream\n", m_outputFile );
579  closePdfObject();
580 
581  // Writing the deferred length as an indirect object
583  fprintf( m_outputFile, "%u\n", out_count );
584  closePdfObject();
585 }
FILE * m_outputFile
Output file.
Definition: plotter.h:580
wxString workFilename
Handle to the deferred stream length.
int streamLengthHandle
Handle of the page content object.
#define NULL
int startPdfObject(int handle=-1)
Open a new PDF object and returns the handle if the parameter is -1.
void closePdfObject()
Close the current PDF object.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.

References closePdfObject(), ADVANCED_CFG::GetCfg(), PLOTTER::m_outputFile, NULL, startPdfObject(), streamLengthHandle, workFile, and workFilename.

Referenced by ClosePage().

◆ computeTextParameters()

void PSLIKE_PLOTTER::computeTextParameters ( const wxPoint &  aPos,
const wxString &  aText,
int  aOrient,
const wxSize &  aSize,
bool  aMirror,
enum EDA_TEXT_HJUSTIFY_T  aH_justify,
enum EDA_TEXT_VJUSTIFY_T  aV_justify,
int  aWidth,
bool  aItalic,
bool  aBold,
double *  wideningFactor,
double *  ctm_a,
double *  ctm_b,
double *  ctm_c,
double *  ctm_d,
double *  ctm_e,
double *  ctm_f,
double *  heightFactor 
)
protectedinherited

This is the core for postscript/PDF text alignment It computes the transformation matrix to generate a user space system aligned with the text.

Even the PS uses the concat operator to simplify PDF generation (concat is everything PDF has to modify the CTM. Lots of parameters, both in and out.

Definition at line 442 of file PS_plotter.cpp.

460 {
461  // Compute the starting position (compensated for alignment)
462  wxPoint start_pos = aPos;
463 
464  // This is an approximation of the text bounds (in IUs)
465  int tw = returnPostscriptTextWidth( aText, aSize.x, aItalic, aWidth );
466  int th = aSize.y;
467  int dx, dy;
468 
469  switch( aH_justify )
470  {
472  dx = -tw / 2;
473  break;
474 
476  dx = -tw;
477  break;
478 
480  dx = 0;
481  break;
482  }
483 
484  switch( aV_justify )
485  {
487  dy = th / 2;
488  break;
489 
491  dy = th;
492  break;
493 
495  dy = 0;
496  break;
497  }
498 
499  RotatePoint( &dx, &dy, aOrient );
500  RotatePoint( &tw, &th, aOrient );
501  start_pos.x += dx;
502  start_pos.y += dy;
503  DPOINT pos_dev = userToDeviceCoordinates( start_pos );
504  DPOINT sz_dev = userToDeviceSize( aSize );
505 
506  // Now returns the final values... the widening factor
507  *wideningFactor = sz_dev.x / sz_dev.y;
508 
509  // Mirrored texts must be plotted as mirrored!
510  if( m_plotMirror )
511  {
512  *wideningFactor = -*wideningFactor;
513  aOrient = -aOrient;
514  }
515 
516  // The CTM transformation matrix
517  double alpha = DECIDEG2RAD( aOrient );
518  double sinalpha = sin( alpha );
519  double cosalpha = cos( alpha );
520 
521  *ctm_a = cosalpha;
522  *ctm_b = sinalpha;
523  *ctm_c = -sinalpha;
524  *ctm_d = cosalpha;
525  *ctm_e = pos_dev.x;
526  *ctm_f = pos_dev.y;
527 
528  // This is because the letters are less than 1 unit high
529  *heightFactor = sz_dev.y / postscriptTextAscent;
530 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
bool m_plotMirror
Definition: plotter.h:574
int returnPostscriptTextWidth(const wxString &aText, int aXSize, bool aItalic, bool aBold)
Sister function for the GraphicTextWidth in drawtxt.cpp Does the same processing (i....
Definition: PS_plotter.cpp:361
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:124
static const double postscriptTextAscent
Height of the postscript font (from the AFM)
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
double DECIDEG2RAD(double deg)
Definition: trigo.h:235

References DECIDEG2RAD(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, PLOTTER::m_plotMirror, PSLIKE_PLOTTER::postscriptTextAscent, PSLIKE_PLOTTER::returnPostscriptTextWidth(), RotatePoint(), PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Text().

◆ emitSetRGBColor()

void PDF_PLOTTER::emitSetRGBColor ( double  r,
double  g,
double  b 
)
overrideprotectedvirtual

PDF supports colors fully.

It actually has distinct fill and pen colors, but we set both at the same time.

XXX Keeping them divided could result in a minor optimization in Eeschema filled shapes, but would propagate to all the other plot engines. Also arcs are filled as pies but only the arc is stroked so it would be difficult to handle anyway.

Implements PSLIKE_PLOTTER.

Definition at line 159 of file PDF_plotter.cpp.

160 {
161  wxASSERT( workFile );
162  fprintf( workFile, "%g %g %g rg %g %g %g RG\n",
163  r, g, b, r, g, b );
164 }

References workFile.

◆ encodeStringForPlotter()

std::string PDF_PLOTTER::encodeStringForPlotter ( const wxString &  aUnicode)
overrideprotectedvirtual

convert a wxString unicode string to a char string compatible with the accepted string PDF format (convert special chars and non ascii7 chars)

Reimplemented from PSLIKE_PLOTTER.

Definition at line 41 of file PDF_plotter.cpp.

42 {
43  // returns a string compatible with PDF string convention from a unicode string.
44  // if the initial text is only ASCII7, return the text between ( and ) for a good readability
45  // if the initial text is no ASCII7, return the text between < and >
46  // and encoded using 16 bits hexa (4 digits) by wide char (unicode 16)
47  std::string result;
48 
49  // Is aText only ASCII7 ?
50  bool is_ascii7 = true;
51 
52  for( size_t ii = 0; ii < aText.Len(); ii++ )
53  {
54  if( aText[ii] >= 0x7F )
55  {
56  is_ascii7 = false;
57  break;
58  }
59  }
60 
61  if( is_ascii7 )
62  {
63  result = '(';
64 
65  for( unsigned ii = 0; ii < aText.Len(); ii++ )
66  {
67  unsigned int code = aText[ii];
68 
69  // These characters must be escaped
70  switch( code )
71  {
72  case '(':
73  case ')':
74  case '\\':
75  result += '\\';
77 
78  default:
79  result += code;
80  break;
81  }
82  }
83 
84  result += ')';
85  }
86  else
87  {
88  result = "<FEFF";
89 
90  for( size_t ii = 0; ii < aText.Len(); ii++ )
91  {
92  unsigned int code = aText[ii];
93  char buffer[16];
94  sprintf( buffer, "%4.4X", code );
95  result += buffer;
96 
97  }
98 
99  result += '>';
100  }
101 
102  return result;
103 }
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83

References KI_FALLTHROUGH.

Referenced by EndPlot(), and Text().

◆ EndBlock()

virtual void PLOTTER::EndBlock ( void *  aData)
inlinevirtualinherited

calling this function allows one 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 SVG_PLOTTER, and GERBER_PLOTTER.

Definition at line 484 of file plotter.h.

484 {}

Referenced by SCH_COMPONENT::Plot(), BRDITEMS_PLOTTER::PlotFilledAreas(), and PlotStandardLayer().

◆ EndPlot()

bool PDF_PLOTTER::EndPlot ( )
overridevirtual

Implements PLOTTER.

Definition at line 682 of file PDF_plotter.cpp.

683 {
684  wxASSERT( m_outputFile );
685 
686  // Close the current page (often the only one)
687  ClosePage();
688 
689  /* We need to declare the resources we're using (fonts in particular)
690  The useful standard one is the Helvetica family. Adding external fonts
691  is *very* involved! */
692  struct {
693  const char *psname;
694  const char *rsname;
695  int font_handle;
696  } fontdefs[4] = {
697  { "/Helvetica", "/KicadFont", 0 },
698  { "/Helvetica-Oblique", "/KicadFontI", 0 },
699  { "/Helvetica-Bold", "/KicadFontB", 0 },
700  { "/Helvetica-BoldOblique", "/KicadFontBI", 0 }
701  };
702 
703  /* Declare the font resources. Since they're builtin fonts, no descriptors (yay!)
704  We'll need metrics anyway to do any alignment (these are in the shared with
705  the postscript engine) */
706  for( int i = 0; i < 4; i++ )
707  {
708  fontdefs[i].font_handle = startPdfObject();
709  fprintf( m_outputFile,
710  "<< /BaseFont %s\n"
711  " /Type /Font\n"
712  " /Subtype /Type1\n"
713 
714  /* Adobe is so Mac-based that the nearest thing to Latin1 is
715  the Windows ANSI encoding! */
716  " /Encoding /WinAnsiEncoding\n"
717  ">>\n",
718  fontdefs[i].psname );
719  closePdfObject();
720  }
721 
722  // Named font dictionary (was allocated, now we emit it)
724  fputs( "<<\n", m_outputFile );
725 
726  for( int i = 0; i < 4; i++ )
727  {
728  fprintf( m_outputFile, " %s %d 0 R\n",
729  fontdefs[i].rsname, fontdefs[i].font_handle );
730  }
731 
732  fputs( ">>\n", m_outputFile );
733  closePdfObject();
734 
735  /* The page tree: it's a B-tree but luckily we only have few pages!
736  So we use just an array... The handle was allocated at the beginning,
737  now we instantiate the corresponding object */
739  fputs( "<<\n"
740  "/Type /Pages\n"
741  "/Kids [\n", m_outputFile );
742 
743  for( unsigned i = 0; i < pageHandles.size(); i++ )
744  fprintf( m_outputFile, "%d 0 R\n", pageHandles[i] );
745 
746  fprintf( m_outputFile,
747  "]\n"
748  "/Count %ld\n"
749  ">>\n", (long) pageHandles.size() );
750  closePdfObject();
751 
752 
753  // The info dictionary
754  int infoDictHandle = startPdfObject();
755  char date_buf[250];
756  time_t ltime = time( NULL );
757  strftime( date_buf, 250, "D:%Y%m%d%H%M%S",
758  localtime( &ltime ) );
759 
760  if( m_title.IsEmpty() )
761  {
762  // Windows uses '\' and other platforms ue '/' as separator
763  m_title = m_filename.AfterLast( '\\');
764  m_title = m_title.AfterLast( '/');
765  }
766 
767  fprintf( m_outputFile,
768  "<<\n"
769  "/Producer (KiCad PDF)\n"
770  "/CreationDate (%s)\n"
771  "/Creator %s\n"
772  "/Title %s\n"
773  "/Trapped False\n",
774  date_buf,
776  encodeStringForPlotter( m_title ).c_str() );
777 
778  fputs( ">>\n", m_outputFile );
779  closePdfObject();
780 
781  // The catalog, at last
782  int catalogHandle = startPdfObject();
783  fprintf( m_outputFile,
784  "<<\n"
785  "/Type /Catalog\n"
786  "/Pages %d 0 R\n"
787  "/Version /1.5\n"
788  "/PageMode /UseNone\n"
789  "/PageLayout /SinglePage\n"
790  ">>\n", pageTreeHandle );
791  closePdfObject();
792 
793  /* Emit the xref table (format is crucial to the byte, each entry must
794  be 20 bytes long, and object zero must be done in that way). Also
795  the offset must be kept along for the trailer */
796  long xref_start = ftell( m_outputFile );
797  fprintf( m_outputFile,
798  "xref\n"
799  "0 %ld\n"
800  "0000000000 65535 f \n", (long) xrefTable.size() );
801 
802  for( unsigned i = 1; i < xrefTable.size(); i++ )
803  {
804  fprintf( m_outputFile, "%010ld 00000 n \n", xrefTable[i] );
805  }
806 
807  // Done the xref, go for the trailer
808  fprintf( m_outputFile,
809  "trailer\n"
810  "<< /Size %lu /Root %d 0 R /Info %d 0 R >>\n"
811  "startxref\n"
812  "%ld\n" // The offset we saved before
813  "%%%%EOF\n",
814  (unsigned long) xrefTable.size(), catalogHandle, infoDictHandle, xref_start );
815 
816  fclose( m_outputFile );
817  m_outputFile = NULL;
818 
819  return true;
820 }
wxString m_filename
Definition: plotter.h:590
FILE * m_outputFile
Output file.
Definition: plotter.h:580
std::vector< int > pageHandles
Font resource dictionary.
virtual void ClosePage()
Close the current page in the PDF document (and emit its compressed stream)
#define NULL
int startPdfObject(int handle=-1)
Open a new PDF object and returns the handle if the parameter is -1.
wxString m_title
Definition: plotter.h:591
std::string encodeStringForPlotter(const wxString &aUnicode) override
convert a wxString unicode string to a char string compatible with the accepted string PDF format (co...
Definition: PDF_plotter.cpp:41
void closePdfObject()
Close the current PDF object.
int fontResDictHandle
Handle to the root of the page tree object.
std::vector< long > xrefTable
Temporary file to construct the stream before zipping.
wxString m_creator
Definition: plotter.h:589

References ClosePage(), closePdfObject(), encodeStringForPlotter(), fontResDictHandle, PLOTTER::m_creator, PLOTTER::m_filename, PLOTTER::m_outputFile, PLOTTER::m_title, NULL, pageHandles, pageTreeHandle, startPdfObject(), and xrefTable.

Referenced by DIALOG_PLOT_SCHEMATIC::restoreEnvironment().

◆ FilledCircle()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 584 of file plotter.cpp.

585 {
586  if( tracemode == FILLED )
587  {
588  Circle( pos, diametre, FILL_TYPE::FILLED_SHAPE, 0 );
589  }
590  else
591  {
592  SetCurrentLineWidth( -1 );
593  Circle( pos, diametre, FILL_TYPE::NO_FILL, -1 );
594  }
595 }
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE 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.

References PLOTTER::Circle(), FILLED, FILLED_SHAPE, NO_FILL, and PLOTTER::SetCurrentLineWidth().

Referenced by BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), and BRDITEMS_PLOTTER::PlotPcbShape().

◆ FinishTo()

◆ FlashPadCircle()

void PSLIKE_PLOTTER::FlashPadCircle ( const wxPoint &  aPadPos,
int  aDiameter,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtualinherited
Parameters
aPadPosPosition of the shape (center of the rectangle
aDiameterdiameter of round pad
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format attributes)

Implements PLOTTER.

Definition at line 121 of file PS_plotter.cpp.

123 {
124  if( aTraceMode == FILLED )
125  Circle( aPadPos, aDiameter, FILL_TYPE::FILLED_SHAPE, 0 );
126  else // Plot a ring:
127  {
129  int linewidth = GetCurrentLineWidth();
130 
131  // avoid aDiameter <= 1 )
132  if( linewidth > aDiameter-2 )
133  linewidth = aDiameter-2;
134 
135  Circle( aPadPos, aDiameter - linewidth, FILL_TYPE::NO_FILL, linewidth );
136  }
137 
139 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:166
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References PLOTTER::Circle(), FILLED, FILLED_SHAPE, PLOTTER::GetCurrentLineWidth(), NO_FILL, PLOTTER::SetCurrentLineWidth(), and PLOTTER::USE_DEFAULT_LINE_WIDTH.

◆ FlashPadCustom()

void PSLIKE_PLOTTER::FlashPadCustom ( const wxPoint &  aPadPos,
const wxSize &  aSize,
double  aPadOrient,
SHAPE_POLY_SET aPolygons,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtualinherited
Parameters
aPadPosPosition of the shape
aSize= size of round reference pad
aPadOrient= pad rotation, used only with aperture macros (Gerber plotter)
aPolygonsthe shape as polygon set
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format attributes)

Implements PLOTTER.

Definition at line 227 of file PS_plotter.cpp.

230 {
231  wxSize size( aSize );
232 
233  if( aTraceMode == FILLED )
234  SetCurrentLineWidth( 0 );
235  else
236  {
238  size.x -= GetCurrentLineWidth();
239  size.y -= GetCurrentLineWidth();
240  }
241 
242 
243  std::vector< wxPoint > cornerList;
244 
245  for( int cnt = 0; cnt < aPolygons->OutlineCount(); ++cnt )
246  {
247  SHAPE_LINE_CHAIN& poly = aPolygons->Outline( cnt );
248  cornerList.clear();
249 
250  for( int ii = 0; ii < poly.PointCount(); ++ii )
251  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
252 
253  // Close polygon
254  cornerList.push_back( cornerList[0] );
255 
256  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILL_TYPE::FILLED_SHAPE : FILL_TYPE::NO_FILL,
258  }
259 }
int OutlineCount() const
Return the number of vertices in a given outline/hole.
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Draw a polygon ( filled or not )
int PointCount() const
Function PointCount()
virtual int GetCurrentLineWidth() const
Definition: plotter.h:166
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
SHAPE_LINE_CHAIN & Outline(int aIndex)
SHAPE_LINE_CHAIN.
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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

◆ FlashPadOval()

void PSLIKE_PLOTTER::FlashPadOval ( const wxPoint &  aPadPos,
const wxSize &  aSize,
double  aPadOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtualinherited
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)

Implements PLOTTER.

Definition at line 91 of file PS_plotter.cpp.

93 {
94  wxASSERT( m_outputFile );
95  int x0, y0, x1, y1, delta;
96  wxSize size( aSize );
97 
98  // The pad is reduced to an oval by dy > dx
99  if( size.x > size.y )
100  {
101  std::swap( size.x, size.y );
102  aPadOrient = AddAngles( aPadOrient, 900 );
103  }
104 
105  delta = size.y - size.x;
106  x0 = 0;
107  y0 = -delta / 2;
108  x1 = 0;
109  y1 = delta / 2;
110  RotatePoint( &x0, &y0, aPadOrient );
111  RotatePoint( &x1, &y1, aPadOrient );
112 
113  if( aTraceMode == FILLED )
114  ThickSegment( wxPoint( aPadPos.x + x0, aPadPos.y + y0 ),
115  wxPoint( aPadPos.x + x1, aPadPos.y + y1 ), size.x, aTraceMode, NULL );
116  else
117  sketchOval( aPadPos, size, aPadOrient, -1 );
118 }
FILE * m_outputFile
Output file.
Definition: plotter.h:580
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, OUTLINE_MODE tracemode, void *aData)
Definition: plotter.cpp:506
#define NULL
T AddAngles(T a1, T2 a2)
Add two angles (keeping the result normalized). T2 is here.
Definition: trigo.h:335
void sketchOval(const wxPoint &pos, const wxSize &size, double orient, int width)
Definition: plotter.cpp:458

References AddAngles(), FILLED, PLOTTER::m_outputFile, NULL, RotatePoint(), PLOTTER::sketchOval(), and PLOTTER::ThickSegment().

◆ FlashPadRect()

void PSLIKE_PLOTTER::FlashPadRect ( const wxPoint &  aPadPos,
const wxSize &  aSize,
double  aPadOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtualinherited
Parameters
aPadPosPosition of the shape (center of the rectangle
aSize= size of rounded rect
aPadOrientThe rotation of the shape
aTraceModeFILLED or SKETCH
aDataan auxiliary info (mainly for gerber format attributes)

Implements PLOTTER.

Definition at line 142 of file PS_plotter.cpp.

144 {
145  static std::vector< wxPoint > cornerList;
146  wxSize size( aSize );
147  cornerList.clear();
148 
149  if( aTraceMode == FILLED )
150  SetCurrentLineWidth( 0 );
151  else
153 
154  size.x -= GetCurrentLineWidth();
155  size.y -= GetCurrentLineWidth();
156 
157  if( size.x < 1 )
158  size.x = 1;
159 
160  if( size.y < 1 )
161  size.y = 1;
162 
163  int dx = size.x / 2;
164  int dy = size.y / 2;
165 
166  wxPoint corner;
167  corner.x = aPadPos.x - dx;
168  corner.y = aPadPos.y + dy;
169  cornerList.push_back( corner );
170  corner.x = aPadPos.x - dx;
171  corner.y = aPadPos.y - dy;
172  cornerList.push_back( corner );
173  corner.x = aPadPos.x + dx;
174  corner.y = aPadPos.y - dy;
175  cornerList.push_back( corner );
176  corner.x = aPadPos.x + dx;
177  corner.y = aPadPos.y + dy,
178  cornerList.push_back( corner );
179 
180  for( unsigned ii = 0; ii < cornerList.size(); ii++ )
181  {
182  RotatePoint( &cornerList[ii], aPadPos, aPadOrient );
183  }
184 
185  cornerList.push_back( cornerList[0] );
186 
187  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILL_TYPE::FILLED_SHAPE : FILL_TYPE::NO_FILL,
189 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Draw a polygon ( filled or not )
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
virtual int GetCurrentLineWidth() const
Definition: plotter.h:166
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References FILLED, FILLED_SHAPE, PLOTTER::GetCurrentLineWidth(), NO_FILL, PLOTTER::PlotPoly(), RotatePoint(), PLOTTER::SetCurrentLineWidth(), and PLOTTER::USE_DEFAULT_LINE_WIDTH.

◆ FlashPadRoundRect()

void PSLIKE_PLOTTER::FlashPadRoundRect ( const wxPoint &  aPadPos,
const wxSize &  aSize,
int  aCornerRadius,
double  aOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtualinherited
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)

Implements PLOTTER.

Definition at line 191 of file PS_plotter.cpp.

194 {
195  wxSize size( aSize );
196 
197  if( aTraceMode == FILLED )
198  SetCurrentLineWidth( 0 );
199  else
200  {
202  size.x -= GetCurrentLineWidth();
203  size.y -= GetCurrentLineWidth();
204  aCornerRadius -= GetCurrentLineWidth()/2;
205  }
206 
207 
208  SHAPE_POLY_SET outline;
209  TransformRoundChamferedRectToPolygon( outline, aPadPos, size, aOrient, aCornerRadius,
210  0.0, 0, GetPlotterArcHighDef(), ERROR_INSIDE );
211 
212  std::vector< wxPoint > cornerList;
213  // TransformRoundRectToPolygon creates only one convex polygon
214  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
215  cornerList.reserve( poly.PointCount() );
216 
217  for( int ii = 0; ii < poly.PointCount(); ++ii )
218  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
219 
220  // Close polygon
221  cornerList.push_back( cornerList[0] );
222 
223  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILL_TYPE::FILLED_SHAPE : FILL_TYPE::NO_FILL,
225 }
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aError, ERROR_LOC aErrorLoc)
convert a rectangle with rounded corners and/or chamfered corners to a polygon Convert rounded corner...
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Draw a polygon ( filled or not )
int PointCount() const
Function PointCount()
virtual int GetCurrentLineWidth() const
Definition: plotter.h:166
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
Represent a set of closed polygons.
SHAPE_LINE_CHAIN & Outline(int aIndex)
SHAPE_LINE_CHAIN.
int GetPlotterArcHighDef() const
Definition: plotter.h:223
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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

◆ FlashPadTrapez()

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

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)

Implements PLOTTER.

Definition at line 261 of file PS_plotter.cpp.

263 {
264  static std::vector< wxPoint > cornerList;
265  cornerList.clear();
266 
267  for( int ii = 0; ii < 4; ii++ )
268  cornerList.push_back( aCorners[ii] );
269 
270  if( aTraceMode == FILLED )
271  {
272  SetCurrentLineWidth( 0 );
273  }
274  else
275  {
277  int w = GetCurrentLineWidth();
278  // offset polygon by w
279  // coord[0] is assumed the lower left
280  // coord[1] is assumed the upper left
281  // coord[2] is assumed the upper right
282  // coord[3] is assumed the lower right
283 
284  /* Trace the outline. */
285  cornerList[0].x += w;
286  cornerList[0].y -= w;
287  cornerList[1].x += w;
288  cornerList[1].y += w;
289  cornerList[2].x -= w;
290  cornerList[2].y += w;
291  cornerList[3].x -= w;
292  cornerList[3].y -= w;
293  }
294 
295  for( int ii = 0; ii < 4; ii++ )
296  {
297  RotatePoint( &cornerList[ii], aPadOrient );
298  cornerList[ii] += aPadPos;
299  }
300 
301  cornerList.push_back( cornerList[0] );
302  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILL_TYPE::FILLED_SHAPE : FILL_TYPE::NO_FILL,
304 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Draw a polygon ( filled or not )
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
virtual int GetCurrentLineWidth() const
Definition: plotter.h:166
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References FILLED, FILLED_SHAPE, PLOTTER::GetCurrentLineWidth(), NO_FILL, PLOTTER::PlotPoly(), RotatePoint(), PLOTTER::SetCurrentLineWidth(), and PLOTTER::USE_DEFAULT_LINE_WIDTH.

◆ FlashRegularPolygon()

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

Flash a regular polygon.

Useful only in Gerber files to flash a regular polygon

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

Implements PLOTTER.

Definition at line 307 of file PS_plotter.cpp.

310 {
311  // Do nothing
312  wxASSERT( 0 );
313 }

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( ) const
protectedinherited

Definition at line 151 of file plotter.cpp.

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

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

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

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( ) const
protectedinherited

Definition at line 145 of file plotter.cpp.

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

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

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

◆ GetDefaultFileExtension()

static wxString PDF_PLOTTER::GetDefaultFileExtension ( )
inlinestatic

Definition at line 213 of file plotters_pslike.h.

214  {
215  return wxString( wxT( "pdf" ) );
216  }

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), and GetDefaultPlotExtension().

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( ) const
protectedinherited

Definition at line 139 of file plotter.cpp.

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

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

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

◆ GetIUsPerDecimil()

double PLOTTER::GetIUsPerDecimil ( ) const
inlineinherited

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

Here they can be get back again

Definition at line 220 of file plotter.h.

220 { return m_IUsPerDecimil; }
double m_IUsPerDecimil
Definition: plotter.h:569

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetPlotterArcHighDef()

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 222 of file plotter.h.

222 { return m_IUsPerDecimil * 8; }
double m_IUsPerDecimil
Definition: plotter.h:569

References PLOTTER::m_IUsPerDecimil.

◆ GetPlotterType()

virtual PLOT_FORMAT PDF_PLOTTER::GetPlotterType ( ) const
inlineoverridevirtual

Returns the effective plot engine in use.

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

Implements PLOTTER.

Definition at line 208 of file plotters_pslike.h.

209  {
210  return PLOT_FORMAT::PDF;
211  }

References PDF.

◆ LineTo()

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

◆ Marker()

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

Draw a pattern shape number aShapeId, to coord position.

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

Definition at line 331 of file plotter.cpp.

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

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

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

◆ markerBackSlash()

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

Plot a \ bar centered on the position.

Building block for markers

Definition at line 317 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerCircle()

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

Plot a circle centered on the position.

Building block for markers

Definition at line 273 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerHBar()

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

Plot a - bar centered on the position.

Building block for markers

Definition at line 303 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerLozenge()

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

Plot a lozenge centered on the position.

Building block for markers

Definition at line 279 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerSlash()

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

Plot a / bar centered on the position.

Building block for markers

Definition at line 310 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerSquare()

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

Plot a square centered on the position.

Building block for markers

Definition at line 248 of file plotter.cpp.

249 {
250  double r = KiROUND( radius / 1.4142 );
251  std::vector< wxPoint > corner_list;
252  wxPoint corner;
253  corner.x = position.x + r;
254  corner.y = position.y + r;
255  corner_list.push_back( corner );
256  corner.x = position.x + r;
257  corner.y = position.y - r;
258  corner_list.push_back( corner );
259  corner.x = position.x - r;
260  corner.y = position.y - r;
261  corner_list.push_back( corner );
262  corner.x = position.x - r;
263  corner.y = position.y + r;
264  corner_list.push_back( corner );
265  corner.x = position.x + r;
266  corner.y = position.y + r;
267  corner_list.push_back( corner );
268 
270 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Draw a polygon ( filled or not )
virtual int GetCurrentLineWidth() const
Definition: plotter.h:166
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

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

Referenced by PLOTTER::Marker().

◆ markerVBar()

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

Plot a | bar centered on the position.

Building block for markers

Definition at line 324 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ MoveTo()

◆ OpenFile()

bool PDF_PLOTTER::OpenFile ( const wxString &  aFullFilename)
overridevirtual

Open or create the plot file aFullFilename.

The base class open the file in text mode, so we should have this function overlaid for PDF files, which are binary files

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

Reimplemented from PLOTTER.

Definition at line 106 of file PDF_plotter.cpp.

107 {
108  m_filename = aFullFilename;
109 
110  wxASSERT( !m_outputFile );
111 
112  // Open the PDF file in binary mode
113  m_outputFile = wxFopen( m_filename, wxT( "wb" ) );
114 
115  if( m_outputFile == NULL )
116  return false ;
117 
118  return true;
119 }
wxString m_filename
Definition: plotter.h:590
FILE * m_outputFile
Output file.
Definition: plotter.h:580
#define NULL

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

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ PageSettings()

PAGE_INFO& PLOTTER::PageSettings ( )
inlineinherited

◆ PenFinish()

void PLOTTER::PenFinish ( )
inlineinherited

Definition at line 273 of file plotter.h.

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

References PLOTTER::PenTo().

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

◆ PenTo()

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

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

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

Implements PLOTTER.

Definition at line 333 of file PDF_plotter.cpp.

334 {
335  wxASSERT( workFile );
336 
337  if( plume == 'Z' )
338  {
339  if( m_penState != 'Z' )
340  {
341  fputs( "S\n", workFile );
342  m_penState = 'Z';
343  m_penLastpos.x = -1;
344  m_penLastpos.y = -1;
345  }
346 
347  return;
348  }
349 
350  if( m_penState != plume || pos != m_penLastpos )
351  {
352  DPOINT pos_dev = userToDeviceCoordinates( pos );
353  fprintf( workFile, "%g %g %c\n",
354  pos_dev.x, pos_dev.y,
355  ( plume=='D' ) ? 'l' : 'm' );
356  }
357 
358  m_penState = plume;
359  m_penLastpos = pos;
360 }
wxPoint m_penLastpos
Definition: plotter.h:587
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
char m_penState
Definition: plotter.h:586

References PLOTTER::m_penLastpos, PLOTTER::m_penState, PLOTTER::userToDeviceCoordinates(), workFile, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ PlotImage()

void PDF_PLOTTER::PlotImage ( const wxImage &  aImage,
const wxPoint &  aPos,
double  aScaleFactor 
)
overridevirtual

PDF images are handles as inline, not XObject streams...

Reimplemented from PLOTTER.

Definition at line 363 of file PDF_plotter.cpp.

365 {
366  wxASSERT( workFile );
367  wxSize pix_size( aImage.GetWidth(), aImage.GetHeight() );
368 
369  // Requested size (in IUs)
370  DPOINT drawsize( aScaleFactor * pix_size.x,
371  aScaleFactor * pix_size.y );
372 
373  // calculate the bitmap start position
374  wxPoint start( aPos.x - drawsize.x / 2,
375  aPos.y + drawsize.y / 2);
376 
377  DPOINT dev_start = userToDeviceCoordinates( start );
378 
379  /* PDF has an uhm... simplified coordinate system handling. There is
380  *one* operator to do everything (the PS concat equivalent). At least
381  they kept the matrix stack to save restore environments. Also images
382  are always emitted at the origin with a size of 1x1 user units.
383  What we need to do is:
384  1) save the CTM end establish the new one
385  2) plot the image
386  3) restore the CTM
387  4) profit
388  */
389  fprintf( workFile, "q %g 0 0 %g %g %g cm\n", // Step 1
390  userToDeviceSize( drawsize.x ),
391  userToDeviceSize( drawsize.y ),
392  dev_start.x, dev_start.y );
393 
394  /* An inline image is a cross between a dictionary and a stream.
395  A real ugly construct (compared with the elegance of the PDF
396  format). Also it accepts some 'abbreviations', which is stupid
397  since the content stream is usually compressed anyway... */
398  fprintf( workFile,
399  "BI\n"
400  " /BPC 8\n"
401  " /CS %s\n"
402  " /W %d\n"
403  " /H %d\n"
404  "ID\n", m_colorMode ? "/RGB" : "/G", pix_size.x, pix_size.y );
405 
406  /* Here comes the stream (in binary!). I *could* have hex or ascii84
407  encoded it, but who cares? I'll go through zlib anyway */
408  for( int y = 0; y < pix_size.y; y++ )
409  {
410  for( int x = 0; x < pix_size.x; x++ )
411  {
412  unsigned char r = aImage.GetRed( x, y ) & 0xFF;
413  unsigned char g = aImage.GetGreen( x, y ) & 0xFF;
414  unsigned char b = aImage.GetBlue( x, y ) & 0xFF;
415 
416  // PDF inline images don't support alpha, so premultiply against white background
417  if( aImage.HasAlpha() )
418  {
419  unsigned char alpha = aImage.GetAlpha( x, y ) & 0xFF;
420 
421  if( alpha < 0xFF )
422  {
423  float a = 1.0 - ( (float) alpha / 255.0 );
424  r = ( int )( r + ( a * 0xFF ) ) & 0xFF;
425  g = ( int )( g + ( a * 0xFF ) ) & 0xFF;
426  b = ( int )( b + ( a * 0xFF ) ) & 0xFF;
427  }
428  }
429 
430  if( aImage.HasMask() )
431  {
432  if( r == aImage.GetMaskRed() && g == aImage.GetMaskGreen()
433  && b == aImage.GetMaskBlue() )
434  {
435  r = 0xFF;
436  g = 0xFF;
437  b = 0xFF;
438  }
439  }
440 
441  // As usual these days, stdio buffering has to suffeeeeerrrr
442  if( m_colorMode )
443  {
444  putc( r, workFile );
445  putc( g, workFile );
446  putc( b, workFile );
447  }
448  else
449  {
450  // Greyscale conversion (CIE 1931)
451  unsigned char grey = KiROUND( r * 0.2126 + g * 0.7152 + b * 0.0722 );
452  putc( grey, workFile );
453  }
454  }
455  }
456 
457  fputs( "EI Q\n", workFile ); // Finish step 2 and do step 3
458 }
bool m_colorMode
Definition: plotter.h:583
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:124
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

References KiROUND(), PLOTTER::m_colorMode, PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), workFile, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ PlotPoly() [1/2]

void PDF_PLOTTER::PlotPoly ( const std::vector< wxPoint > &  aCornerList,
FILL_TYPE  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = NULL 
)
overridevirtual

Polygon plotting for PDF.

Everything is supported

Implements PLOTTER.

Definition at line 309 of file PDF_plotter.cpp.

311 {
312  wxASSERT( workFile );
313 
314  if( aCornerList.size() <= 1 )
315  return;
316 
317  SetCurrentLineWidth( aWidth );
318 
319  DPOINT pos = userToDeviceCoordinates( aCornerList[0] );
320  fprintf( workFile, "%g %g m\n", pos.x, pos.y );
321 
322  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
323  {
324  pos = userToDeviceCoordinates( aCornerList[ii] );
325  fprintf( workFile, "%g %g l\n", pos.x, pos.y );
326  }
327 
328  // Close path and stroke(/fill)
329  fprintf( workFile, "%c\n", aFill == FILL_TYPE::NO_FILL ? 'S' : 'b' );
330 }
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.

References NO_FILL, SetCurrentLineWidth(), PLOTTER::userToDeviceCoordinates(), workFile, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ PlotPoly() [2/2]

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

Draw a polygon ( filled or not )

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

Definition at line 598 of file plotter.cpp.

600 {
601  std::vector<wxPoint> cornerList;
602  cornerList.reserve( aCornerList.PointCount() );
603 
604  for( int ii = 0; ii < aCornerList.PointCount(); ii++ )
605  cornerList.emplace_back( aCornerList.CPoint( ii ) );
606 
607  if( aCornerList.IsClosed() && cornerList.front() != cornerList.back() )
608  cornerList.emplace_back( aCornerList.CPoint( 0 ) );
609 
610  PlotPoly( cornerList, aFill, aWidth, aData );
611 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_TYPE aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Draw a polygon ( filled or not )
int PointCount() const
Function PointCount()
const VECTOR2I & CPoint(int aIndex) const
Function Point()
bool IsClosed() const override
Function IsClosed()

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

◆ postscriptOverlinePositions()

void PSLIKE_PLOTTER::postscriptOverlinePositions ( const wxString &  aText,
int  aXSize,
bool  aItalic,
bool  aBold,
std::vector< int > *  pos_pairs 
)
protectedinherited

Computes the x coordinates for the overlining in a string of text.

Fills the passed vector with couples of (start, stop) values to be used in the text coordinate system (use computeTextParameters to obtain the parameters to establish such a system)

Definition at line 390 of file PS_plotter.cpp.

393 {
394  /* XXX This function is *too* similar to returnPostscriptTextWidth.
395  Consider merging them... */
396  const double *width_table = aBold ? ( aItalic ? hvbo_widths : hvb_widths )
397  : ( aItalic ? hvo_widths : hv_widths );
398  double tally = 0;
399 
400  for( unsigned i = 0; i < aText.length(); i++ )
401  {
402  wchar_t AsciiCode = aText[i];
403  // Skip the negation marks and untabled points
404  if( AsciiCode != '~' && AsciiCode < 256 )
405  {
406  tally += width_table[AsciiCode];
407  }
408  else
409  {
410  if( AsciiCode == '~' )
411  pos_pairs->push_back( KiROUND( aXSize * tally / postscriptTextAscent ) );
412  }
413  }
414 
415  // Special rule: we have to complete the last bar if the ~ aren't matched
416  if( pos_pairs->size() % 2 == 1 )
417  pos_pairs->push_back( KiROUND( aXSize * tally / postscriptTextAscent ) );
418 }
const double hvb_widths[256]
Character widths for Helvetica-Bold.
const double hv_widths[256]
Character widths for Helvetica.
const double hvo_widths[256]
Character widths for Helvetica-Oblique.
static const double postscriptTextAscent
Height of the postscript font (from the AFM)
const double hvbo_widths[256]
Character widths for Helvetica-BoldOblique.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

References hv_widths, hvb_widths, hvbo_widths, hvo_widths, KiROUND(), and PSLIKE_PLOTTER::postscriptTextAscent.

◆ Rect()

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

Rectangles in PDF.

Supported by the native operator

Implements PLOTTER.

Definition at line 191 of file PDF_plotter.cpp.

192 {
193  wxASSERT( workFile );
194  DPOINT p1_dev = userToDeviceCoordinates( p1 );
195  DPOINT p2_dev = userToDeviceCoordinates( p2 );
196 
197  SetCurrentLineWidth( width );
198  fprintf( workFile, "%g %g %g %g re %c\n", p1_dev.x, p1_dev.y,
199  p2_dev.x - p1_dev.x, p2_dev.y - p1_dev.y, fill == FILL_TYPE::NO_FILL ? 'S' : 'B' );
200 }
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:93
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.

References NO_FILL, SetCurrentLineWidth(), PLOTTER::userToDeviceCoordinates(), workFile, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ RenderSettings()

◆ returnPostscriptTextWidth()

int PSLIKE_PLOTTER::returnPostscriptTextWidth ( const wxString &  aText,
int  aXSize,
bool  aItalic,
bool  aBold 
)
protectedinherited

Sister function for the GraphicTextWidth in drawtxt.cpp Does the same processing (i.e.

calculates a text string width) but using postscript metrics for the Helvetica font (optionally used for PS and PDF plotting

Definition at line 361 of file PS_plotter.cpp.

363 {
364  const double *width_table = aBold ? ( aItalic ? hvbo_widths : hvb_widths )
365  : ( aItalic ? hvo_widths : hv_widths );
366  double tally = 0;
367 
368  for( unsigned i = 0; i < aText.length(); i++ )
369  {
370  wchar_t AsciiCode = aText[i];
371  // Skip the negation marks and untabled points
372  if( AsciiCode != '~' && AsciiCode < 256 )
373  {
374  tally += width_table[AsciiCode];
375  }
376  }
377 
378  // Widths are proportional to height, but height is enlarged by a
379  // scaling factor
380  return KiROUND( aXSize * tally / postscriptTextAscent );
381 }
const double hvb_widths[256]
Character widths for Helvetica-Bold.
const double hv_widths[256]
Character widths for Helvetica.
const double hvo_widths[256]
Character widths for Helvetica-Oblique.
static const double postscriptTextAscent
Height of the postscript font (from the AFM)
const double hvbo_widths[256]
Character widths for Helvetica-BoldOblique.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68

References hv_widths, hvb_widths, hvbo_widths, hvo_widths, KiROUND(), and PSLIKE_PLOTTER::postscriptTextAscent.

Referenced by PSLIKE_PLOTTER::computeTextParameters().

◆ segmentAsOval()

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

Convert a thick segment and plot it as an oval.

Definition at line 437 of file plotter.cpp.

439 {
440  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
441  wxSize size( end.x - start.x, end.y - start.y );
442  double orient;
443 
444  if( size.y == 0 )
445  orient = 0;
446  else if( size.x == 0 )
447  orient = 900;
448  else
449  orient = -ArcTangente( size.y, size.x );
450 
451  size.x = KiROUND( EuclideanNorm( size ) ) + width;
452  size.y = width;
453 
454  FlashPadOval( center, size, orient, tracemode, NULL );
455 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:148
virtual void FlashPadOval(const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData)=0
#define NULL
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:182

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

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

◆ SetColor()

void PSLIKE_PLOTTER::SetColor ( COLOR4D  color)
overridevirtualinherited

The SetColor implementation is split with the subclasses: The PSLIKE computes the rgb values, the subclass emits the operator to actually do it.

Implements PLOTTER.

Reimplemented in SVG_PLOTTER.

Definition at line 65 of file PS_plotter.cpp.

66 {
67  if( m_colorMode )
68  {
69  if( m_negativeMode )
70  emitSetRGBColor( 1 - color.r, 1 - color.g, 1 - color.b );
71  else
72  emitSetRGBColor( color.r, color.g, color.b );
73  }
74  else
75  {
76  /* B/W Mode - Use BLACK or WHITE for all items
77  * note the 2 colors are used in B&W mode, mainly by Pcbnew to draw
78  * holes in white on pads in black
79  */
80  double k = 1; // White
81  if( color != COLOR4D::WHITE )
82  k = 0;
83  if( m_negativeMode )
84  emitSetRGBColor( 1 - k, 1 - k, 1 - k );
85  else
86  emitSetRGBColor( k, k, k );
87  }
88 }
int color
Definition: DXF_plotter.cpp:60
bool m_colorMode
Definition: plotter.h:583
virtual void emitSetRGBColor(double r, double g, double b)=0
Virtual primitive for emitting the setrgbcolor operator.
bool m_negativeMode
Definition: plotter.h:584
Definition: color4d.h:48

References color, PSLIKE_PLOTTER::emitSetRGBColor(), PLOTTER::m_colorMode, PLOTTER::m_negativeMode, and WHITE.

Referenced by DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), SVG_PLOTTER::SetColor(), PS_PLOTTER::Text(), and Text().

◆ SetColorMode()

virtual void PLOTTER::SetColorMode ( bool  aColorMode)
inlinevirtualinherited

◆ SetCreator()

◆ SetCurrentLineWidth()

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

Pen width setting for PDF.

Since the specs explicitly says that a 0 width is a bad thing to use (since it results in 1 pixel traces), we convert such requests to the minimal width (like 1) Note pen width = 0 is used in plot polygons to plot filled polygons with no outline thickness. Use in this case pen width = 1 does not actually change the polygon.

Implements PLOTTER.

Definition at line 138 of file PDF_plotter.cpp.

139 {
140  wxASSERT( workFile );
141 
142  if( aWidth == DO_NOT_SET_LINE_WIDTH )
143  return;
144  else if( aWidth == USE_DEFAULT_LINE_WIDTH )
146 
147  if( aWidth == 0 )
148  aWidth = 1;
149 
150  wxASSERT_MSG( aWidth > 0, "Plotter called to set negative pen width" );
151 
152  if( aWidth != m_currentPenWidth )
153  fprintf( workFile, "%g w\n", userToDeviceSize( aWidth ) );
154 
155  m_currentPenWidth = aWidth;
156 }
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
int m_currentPenWidth
Definition: plotter.h:585
RENDER_SETTINGS * m_renderSettings
Definition: plotter.h:597
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:124
int GetDefaultPenWidth() const
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:125

References PLOTTER::DO_NOT_SET_LINE_WIDTH, KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), PLOTTER::m_currentPenWidth, PLOTTER::m_renderSettings, PLOTTER::USE_DEFAULT_LINE_WIDTH, PLOTTER::userToDeviceSize(), and workFile.

Referenced by Arc(), Circle(), PlotPoly(), Rect(), and Text().

◆ SetDash()

void PDF_PLOTTER::SetDash ( PLOT_DASH_TYPE  dashed)
overridevirtual

PDF supports dashed lines.

Implements PLOTTER.

Definition at line 167 of file PDF_plotter.cpp.

168 {
169  wxASSERT( workFile );
170  switch( dashed )
171  {
173  fprintf( workFile, "[%d %d] 0 d\n",
174  (int) GetDashMarkLenIU(), (int) GetDashGapLenIU() );
175  break;
176  case PLOT_DASH_TYPE::DOT:
177  fprintf( workFile, "[%d %d] 0 d\n",
178  (int) GetDotMarkLenIU(), (int) GetDashGapLenIU() );
179  break;
181  fprintf( workFile, "[%d %d %d %d] 0 d\n",
182  (int) GetDashMarkLenIU(), (int) GetDashGapLenIU(),
183  (int) GetDotMarkLenIU(), (int) GetDashGapLenIU() );
184  break;
185  default:
186  fputs( "[] 0 d\n", workFile );
187  }
188 }
double GetDotMarkLenIU() const
Definition: plotter.cpp:139
double GetDashGapLenIU() const
Definition: plotter.cpp:151
double GetDashMarkLenIU() const
Definition: plotter.cpp:145

References DASH, DASHDOT, DOT, PLOTTER::GetDashGapLenIU(), PLOTTER::GetDashMarkLenIU(), PLOTTER::GetDotMarkLenIU(), and workFile.

◆ SetGerberCoordinatesFormat()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 458 of file plotter.h.

459  {
460  // NOP for most plotters. Only for Gerber plotter
461  }

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

◆ SetLayerPolarity()

virtual void PLOTTER::SetLayerPolarity ( bool  aPositive)
inlinevirtualinherited

Set the 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 444 of file plotter.h.

445  {
446  // NOP for most plotters
447  }

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 142 of file plotter.h.

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

References PLOTTER::m_negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

◆ SetRenderSettings()

◆ SetScaleAdjust()

void PSLIKE_PLOTTER::SetScaleAdjust ( double  scaleX,
double  scaleY 
)
inlineinherited

Set the 'fine' scaling for the postscript engine.

Definition at line 61 of file plotters_pslike.h.

62  {
63  plotScaleAdjX = scaleX;
64  plotScaleAdjY = scaleY;
65  }
double plotScaleAdjX
Fine user scale adjust ( = 1.0 if no correction)

References PSLIKE_PLOTTER::plotScaleAdjX, and PSLIKE_PLOTTER::plotScaleAdjY.

Referenced by StartPlotBoard().

◆ SetSvgCoordinatesFormat()

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

Reimplemented in SVG_PLOTTER.

Definition at line 463 of file plotter.h.

464  {
465  // NOP for most plotters. Only for SVG plotter
466  }

Referenced by initializePlotter().

◆ SetTextMode()

virtual void PSLIKE_PLOTTER::SetTextMode ( PLOT_TEXT_MODE  mode)
inlineoverridevirtualinherited

PS and PDF fully implement native text (for the Latin-1 subset)

Reimplemented from PLOTTER.

Definition at line 52 of file plotters_pslike.h.

53  {
54  if( mode != PLOT_TEXT_MODE::DEFAULT )
55  m_textMode = mode;
56  }
PLOT_TEXT_MODE m_textMode
How to draw text.

References DEFAULT, and PSLIKE_PLOTTER::m_textMode.

Referenced by SVG_PLOTTER::SVG_PLOTTER().

◆ SetTitle()

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

Definition at line 174 of file plotter.h.

174 { m_title = aTitle; }
wxString m_title
Definition: plotter.h:591

References PLOTTER::m_title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ SetViewport()

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

PDF can have multiple pages, so SetPageSettings can be called with the outputFile open (but not inside a page stream!)

Implements PLOTTER.

Definition at line 122 of file PDF_plotter.cpp.

124 {
125  m_plotMirror = aMirror;
126  m_plotOffset = aOffset;
127  m_plotScale = aScale;
128  m_IUsPerDecimil = aIusPerDecimil;
129 
130  // The CTM is set to 1 user unit per decimal
131  m_iuPerDeviceUnit = 1.0 / aIusPerDecimil;
132 
133  /* The paper size in this engine is handled page by page
134  Look in the StartPage function */
135 }
double m_iuPerDeviceUnit
Definition: plotter.h:571
double m_IUsPerDecimil
Definition: plotter.h:569
double m_plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:563
bool m_plotMirror
Definition: plotter.h:574
wxPoint m_plotOffset
Definition: plotter.h:573

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

◆ sketchOval()

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

Definition at line 458 of file plotter.cpp.

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

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

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

◆ StartBlock()

virtual void PLOTTER::StartBlock ( void *  aData)
inlinevirtualinherited

calling this function allows one 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 SVG_PLOTTER, and GERBER_PLOTTER.

Definition at line 475 of file plotter.h.

475 {}

Referenced by SCH_COMPONENT::Plot(), BRDITEMS_PLOTTER::PlotFilledAreas(), and PlotStandardLayer().

◆ StartPage()

void PDF_PLOTTER::StartPage ( )
virtual

Starts a new page in the PDF document.

Definition at line 588 of file PDF_plotter.cpp.

589 {
590  wxASSERT( m_outputFile );
591  wxASSERT( !workFile );
592 
593  // Compute the paper size in IUs
595  m_paperSize.x *= 10.0 / m_iuPerDeviceUnit;
596  m_paperSize.y *= 10.0 / m_iuPerDeviceUnit;
597 
598  // Open the content stream; the page object will go later
600 
601  /* Now, until ClosePage *everything* must be wrote in workFile, to be
602  compressed later in closePdfStream */
603 
604  // Default graphic settings (coordinate system, default color and line style)
605  fprintf( workFile,
606  "%g 0 0 %g 0 0 cm 1 J 1 j 0 0 0 rg 0 0 0 RG %g w\n",
607  0.0072 * plotScaleAdjX, 0.0072 * plotScaleAdjY,
609 }
FILE * m_outputFile
Output file.
Definition: plotter.h:580
double m_iuPerDeviceUnit
Definition: plotter.h:571
int startPdfStream(int handle=-1)
Starts a PDF stream (for the page).
RENDER_SETTINGS * m_renderSettings
Definition: plotter.h:597
const wxSize & GetSizeMils() const
Definition: page_info.h:135
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:124
PAGE_INFO m_pageInfo
Definition: plotter.h:592
double plotScaleAdjX
Fine user scale adjust ( = 1.0 if no correction)
int GetDefaultPenWidth() const
wxSize m_paperSize
Definition: plotter.h:593
int pageStreamHandle
Handles to the page objects.

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), PAGE_INFO::GetSizeMils(), PLOTTER::m_iuPerDeviceUnit, PLOTTER::m_outputFile, PLOTTER::m_pageInfo, PLOTTER::m_paperSize, PLOTTER::m_renderSettings, pageStreamHandle, PSLIKE_PLOTTER::plotScaleAdjX, PSLIKE_PLOTTER::plotScaleAdjY, startPdfStream(), PLOTTER::userToDeviceSize(), and workFile.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), and StartPlot().

◆ startPdfObject()

int PDF_PLOTTER::startPdfObject ( int  handle = -1)
protected

Open a new PDF object and returns the handle if the parameter is -1.

Otherwise fill in the xref entry for the passed object

Definition at line 468 of file PDF_plotter.cpp.

469 {
470  wxASSERT( m_outputFile );
471  wxASSERT( !workFile );
472 
473  if( handle < 0)
474  handle = allocPdfObject();
475 
476  xrefTable[handle] = ftell( m_outputFile );
477  fprintf( m_outputFile, "%d 0 obj\n", handle );
478  return handle;
479 }
FILE * m_outputFile
Output file.
Definition: plotter.h:580
std::vector< long > xrefTable
Temporary file to construct the stream before zipping.
int allocPdfObject()
Allocate a new handle in the table of the PDF object.

References allocPdfObject(), PLOTTER::m_outputFile, workFile, and xrefTable.

Referenced by ClosePage(), closePdfStream(), EndPlot(), and startPdfStream().

◆ startPdfStream()

int PDF_PLOTTER::startPdfStream ( int  handle = -1)
protected

Starts a PDF stream (for the page).

Returns the object handle opened Pass -1 (default) for a fresh object. Especially from PDF 1.5 streams can contain a lot of things, but for the moment we only handle page content.

Definition at line 490 of file PDF_plotter.cpp.

491 {
492  wxASSERT( m_outputFile );
493  wxASSERT( !workFile );
494  handle = startPdfObject( handle );
495 
496  // This is guaranteed to be handle+1 but needs to be allocated since
497  // you could allocate more object during stream preparation
499 
500  if( ADVANCED_CFG::GetCfg().m_DebugPDFWriter )
501  {
502  fprintf( m_outputFile,
503  "<< /Length %d 0 R >>\n" // Length is deferred
504  "stream\n", handle + 1 );
505  }
506  else
507  {
508  fprintf( m_outputFile,
509  "<< /Length %d 0 R /Filter /FlateDecode >>\n" // Length is deferred
510  "stream\n", handle + 1 );
511  }
512 
513  // Open a temporary file to accumulate the stream
514  workFilename = wxFileName::CreateTempFileName( "" );
515  workFile = wxFopen( workFilename, wxT( "w+b" ) );
516  wxASSERT( workFile );
517  return handle;
518 }
FILE * m_outputFile
Output file.
Definition: plotter.h:580
wxString workFilename
Handle to the deferred stream length.
int streamLengthHandle
Handle of the page content object.
int startPdfObject(int handle=-1)
Open a new PDF object and returns the handle if the parameter is -1.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
int allocPdfObject()
Allocate a new handle in the table of the PDF object.

References allocPdfObject(), ADVANCED_CFG::GetCfg(), PLOTTER::m_outputFile, startPdfObject(), streamLengthHandle, workFile, and workFilename.

Referenced by StartPage().

◆ StartPlot()

bool PDF_PLOTTER::StartPlot ( )
overridevirtual

The PDF engine supports multiple pages; the first one is opened 'for free' the following are to be closed and reopened.

Between each page parameters can be set

Implements PLOTTER.

Definition at line 653 of file PDF_plotter.cpp.

654 {
655  wxASSERT( m_outputFile );
656 
657  // First things first: the customary null object
658  xrefTable.clear();
659  xrefTable.push_back( 0 );
660 
661  /* The header (that's easy!). The second line is binary junk required
662  to make the file binary from the beginning (the important thing is
663  that they must have the bit 7 set) */
664  fputs( "%PDF-1.5\n%\200\201\202\203\n", m_outputFile );
665 
666  /* Allocate an entry for the page tree root, it will go in every page
667  parent entry */
669 
670  /* In the same way, the font resource dictionary is used by every page
671  (it *could* be inherited via the Pages tree */
673 
674  /* Now, the PDF is read from the end, (more or less)... so we start
675  with the page stream for page 1. Other more important stuff is written
676  at the end */
677  StartPage();
678  return true;
679 }
virtual void StartPage()
Starts a new page in the PDF document.
FILE * m_outputFile
Output file.
Definition: plotter.h:580
int fontResDictHandle
Handle to the root of the page tree object.
std::vector< long > xrefTable
Temporary file to construct the stream before zipping.
int allocPdfObject()
Allocate a new handle in the table of the PDF object.

References allocPdfObject(), fontResDictHandle, PLOTTER::m_outputFile, pageTreeHandle, StartPage(), and xrefTable.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ Text()

void PDF_PLOTTER::Text ( const wxPoint &  aPos,
const COLOR4D  aColor,
const wxString &  aText,
double  aOrient,
const wxSize &  aSize,
enum EDA_TEXT_HJUSTIFY_T  aH_justify,
enum EDA_TEXT_VJUSTIFY_T  aV_justify,
int  aPenWidth,
bool  aItalic,
bool  aBold,
bool  aMultilineAllowed = false,
void *  aData = NULL 
)
overridevirtual

Draws text with the plotter.

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

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

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

Reimplemented from PLOTTER.

Definition at line 823 of file PDF_plotter.cpp.

835 {
836  // PDF files do not like 0 sized texts which create broken files.
837  if( aSize.x == 0 || aSize.y == 0 )
838  return;
839 
840  // Render phantom text (which will be searchable) behind the stroke font. This won't
841  // be pixel-accurate, but it doesn't matter for searching.
842  int render_mode = 3; // invisible
843 
844  const char *fontname = aItalic ? ( aBold ? "/KicadFontBI" : "/KicadFontI" )
845  : ( aBold ? "/KicadFontB" : "/KicadFont" );
846 
847  // Compute the copious transformation parameters of the Current Transform Matrix
848  double ctm_a, ctm_b, ctm_c, ctm_d, ctm_e, ctm_f;
849  double wideningFactor, heightFactor;
850 
851  computeTextParameters( aPos, aText, aOrient, aSize, m_plotMirror, aH_justify,
852  aV_justify, aWidth, aItalic, aBold,
853  &wideningFactor, &ctm_a, &ctm_b, &ctm_c,
854  &ctm_d, &ctm_e, &ctm_f, &heightFactor );
855 
856  SetColor( aColor );
857  SetCurrentLineWidth( aWidth, aData );
858 
859  /* We use the full CTM instead of the text matrix because the same
860  coordinate system will be used for the overlining. Also the %f
861  for the trig part of the matrix to avoid %g going in exponential
862  format (which is not supported) */
863  fprintf( workFile, "q %f %f %f %f %g %g cm BT %s %g Tf %d Tr %g Tz ",
864  ctm_a, ctm_b, ctm_c, ctm_d, ctm_e, ctm_f,
865  fontname, heightFactor, render_mode, wideningFactor * 100 );
866 
867  // The text must be escaped correctly
868  std:: string txt_pdf = encodeStringForPlotter( aText );
869  fprintf( workFile, "%s Tj ET\n", txt_pdf.c_str() );
870 
871  // Restore the CTM
872  fputs( "Q\n", workFile );
873 
874  // Plot the stroked text (if requested)
875  PLOTTER::Text( aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aWidth,
876  aItalic, aBold, aMultilineAllowed );
877 }
virtual void Text(const wxPoint &aPos, const COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=NULL)
Draws text with the plotter.
Definition: gr_text.cpp:219
bool m_plotMirror
Definition: plotter.h:574
virtual void SetColor(COLOR4D color) override
The SetColor implementation is split with the subclasses: The PSLIKE computes the rgb values,...
Definition: PS_plotter.cpp:65
std::string encodeStringForPlotter(const wxString &aUnicode) override
convert a wxString unicode string to a char string compatible with the accepted string PDF format (co...
Definition: PDF_plotter.cpp:41
void computeTextParameters(const wxPoint &aPos, const wxString &aText, int aOrient, const wxSize &aSize, bool aMirror, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, double *wideningFactor, double *ctm_a, double *ctm_b, double *ctm_c, double *ctm_d, double *ctm_e, double *ctm_f, double *heightFactor)
This is the core for postscript/PDF text alignment It computes the transformation matrix to generate ...
Definition: PS_plotter.cpp:442
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.

References PSLIKE_PLOTTER::computeTextParameters(), encodeStringForPlotter(), PLOTTER::m_plotMirror, PSLIKE_PLOTTER::SetColor(), SetCurrentLineWidth(), PLOTTER::Text(), and workFile.

◆ ThickArc()

void PLOTTER::ThickArc ( const wxPoint &  centre,
double  StAngle,
double  EndAngle,
int  rayon,
int  width,
OUTLINE_MODE  tracemode,
void *  aData 
)
virtualinherited

Reimplemented in GERBER_PLOTTER.

Definition at line 530 of file plotter.cpp.

532 {
533  if( tracemode == FILLED )
534  Arc( centre, StAngle, EndAngle, radius, FILL_TYPE::NO_FILL, width );
535  else
536  {
537  SetCurrentLineWidth( -1 );
538  Arc( centre, StAngle, EndAngle,
539  radius - ( width - m_currentPenWidth ) / 2, FILL_TYPE::NO_FILL, -1 );
540  Arc( centre, StAngle, EndAngle,
541  radius + ( width - m_currentPenWidth ) / 2, FILL_TYPE::NO_FILL, -1 );
542  }
543 }
virtual void Arc(const wxPoint &centre, double StAngle, double EndAngle, int rayon, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH)
Generic fallback: arc rendered as a polyline.
Definition: plotter.cpp:157
int m_currentPenWidth
Definition: plotter.h:585
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References PLOTTER::Arc(), FILLED, PLOTTER::m_currentPenWidth, NO_FILL, and PLOTTER::SetCurrentLineWidth().

Referenced by BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), and PlotStandardLayer().

◆ ThickCircle()

void PLOTTER::ThickCircle ( const wxPoint &  pos,
int  diametre,
int  width,
OUTLINE_MODE  tracemode,
void *  aData 
)
virtualinherited

Reimplemented in GERBER_PLOTTER.

Definition at line 568 of file plotter.cpp.

570 {
571  if( tracemode == FILLED )
572  {
573  Circle( pos, diametre, FILL_TYPE::NO_FILL, width );
574  }
575  else
576  {
577  SetCurrentLineWidth( -1 );
578  Circle( pos, diametre - width + m_currentPenWidth, FILL_TYPE::NO_FILL, -1 );
579  Circle( pos, diametre + width - m_currentPenWidth, FILL_TYPE::NO_FILL, -1 );
580  }
581 }
int m_currentPenWidth
Definition: plotter.h:585
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE 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.

References PLOTTER::Circle(), FILLED, PLOTTER::m_currentPenWidth, NO_FILL, and PLOTTER::SetCurrentLineWidth().

Referenced by BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), and BRDITEMS_PLOTTER::PlotPcbShape().

◆ ThickRect()

void PLOTTER::ThickRect ( const wxPoint &  p1,
const wxPoint &  p2,
int  width,
OUTLINE_MODE  tracemode,
void *  aData 
)
virtualinherited

Reimplemented in GERBER_PLOTTER.

Definition at line 546 of file plotter.cpp.

548 {
549  if( tracemode == FILLED )
550  Rect( p1, p2, FILL_TYPE::NO_FILL, width );
551  else
552  {
553  SetCurrentLineWidth( -1 );
554  wxPoint offsetp1( p1.x - (width - m_currentPenWidth) / 2,
555  p1.y - (width - m_currentPenWidth) / 2 );
556  wxPoint offsetp2( p2.x + (width - m_currentPenWidth) / 2,
557  p2.y + (width - m_currentPenWidth) / 2 );
558  Rect( offsetp1, offsetp2, FILL_TYPE::NO_FILL, -1 );
559  offsetp1.x += (width - m_currentPenWidth);
560  offsetp1.y += (width - m_currentPenWidth);
561  offsetp2.x -= (width - m_currentPenWidth);
562  offsetp2.y -= (width - m_currentPenWidth);
563  Rect( offsetp1, offsetp2, FILL_TYPE::NO_FILL, -1 );
564  }
565 }
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH)=0
int m_currentPenWidth
Definition: plotter.h:585
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References FILLED, PLOTTER::m_currentPenWidth, NO_FILL, PLOTTER::Rect(), and PLOTTER::SetCurrentLineWidth().

◆ ThickSegment()

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

Reimplemented in HPGL_PLOTTER, DXF_PLOTTER, and GERBER_PLOTTER.

Definition at line 506 of file plotter.cpp.

508 {
509  if( tracemode == FILLED )
510  {
511  if( start == end )
512  {
513  Circle( start, width, FILL_TYPE::FILLED_SHAPE, 0 );
514  }
515  else
516  {
517  SetCurrentLineWidth( width );
518  MoveTo( start );
519  FinishTo( end );
520  }
521  }
522  else
523  {
524  SetCurrentLineWidth( -1 );
525  segmentAsOval( start, end, width, tracemode );
526  }
527 }
void segmentAsOval(const wxPoint &start, const wxPoint &end, int width, OUTLINE_MODE tracemode)
Convert a thick segment and plot it as an oval.
Definition: plotter.cpp:437
void FinishTo(const wxPoint &pos)
Definition: plotter.h:267
virtual void Circle(const wxPoint &pos, int diametre, FILL_TYPE fill, int width=USE_DEFAULT_LINE_WIDTH)=0
void MoveTo(const wxPoint &pos)
Definition: plotter.h:257
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

References PLOTTER::Circle(), FILLED, FILLED_SHAPE, PLOTTER::FinishTo(), PLOTTER::MoveTo(), PLOTTER::segmentAsOval(), and PLOTTER::SetCurrentLineWidth().

Referenced by PSLIKE_PLOTTER::FlashPadOval(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), PlotLayerOutlines(), BRDITEMS_PLOTTER::PlotPcbShape(), and PlotStandardLayer().

◆ userToDeviceCoordinates()

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

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

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

Definition at line 93 of file plotter.cpp.

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

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

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

◆ userToDeviceSize() [1/2]

◆ userToDeviceSize() [2/2]

double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtualinherited

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

Definition at line 131 of file plotter.cpp.

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

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

Member Data Documentation

◆ DO_NOT_SET_LINE_WIDTH

◆ fontResDictHandle

int PDF_PLOTTER::fontResDictHandle
protected

Handle to the root of the page tree object.

Definition at line 364 of file plotters_pslike.h.

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

◆ m_colorMode

bool PLOTTER::m_colorMode
protectedinherited

◆ m_creator

wxString PLOTTER::m_creator
protectedinherited

◆ m_currentPenWidth

◆ m_filename

wxString PLOTTER::m_filename
protectedinherited

Definition at line 590 of file plotter.h.

Referenced by EndPlot(), PLOTTER::OpenFile(), OpenFile(), and SVG_PLOTTER::StartPlot().

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

◆ m_iuPerDeviceUnit

◆ m_IUsPerDecimil

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

◆ m_negativeMode

bool PLOTTER::m_negativeMode
protectedinherited

Definition at line 584 of file plotter.h.

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

◆ m_outputFile

FILE* PLOTTER::m_outputFile
protectedinherited

Output file.

Definition at line 580 of file plotter.h.

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

◆ m_pageInfo

◆ m_paperSize

◆ m_penLastpos

wxPoint PLOTTER::m_penLastpos
protectedinherited

◆ m_penState

char PLOTTER::m_penState
protectedinherited

◆ m_plotMirror

◆ m_plotOffset

◆ m_plotScale

◆ m_renderSettings

◆ m_textMode

PLOT_TEXT_MODE PSLIKE_PLOTTER::m_textMode
protectedinherited

How to draw text.

Definition at line 133 of file plotters_pslike.h.

Referenced by PS_PLOTTER::PS_PLOTTER(), PSLIKE_PLOTTER::SetTextMode(), and PS_PLOTTER::Text().

◆ m_title

wxString PLOTTER::m_title
protectedinherited

Definition at line 591 of file plotter.h.

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

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed
protectedinherited

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58
staticinherited

Draw a marker (used for the drill map)

Definition at line 427 of file plotter.h.

Referenced by PLOTTER::Marker().

◆ pageHandles

std::vector<int> PDF_PLOTTER::pageHandles
protected

Font resource dictionary.

Definition at line 365 of file plotters_pslike.h.

Referenced by ClosePage(), and EndPlot().

◆ pageStreamHandle

int PDF_PLOTTER::pageStreamHandle
protected

Handles to the page objects.

Definition at line 366 of file plotters_pslike.h.

Referenced by ClosePage(), and StartPage().

◆ pageTreeHandle

int PDF_PLOTTER::pageTreeHandle
protected

Definition at line 363 of file plotters_pslike.h.

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

◆ plotScaleAdjX

double PSLIKE_PLOTTER::plotScaleAdjX
protectedinherited

Fine user scale adjust ( = 1.0 if no correction)

Definition at line 130 of file plotters_pslike.h.

Referenced by PSLIKE_PLOTTER::SetScaleAdjust(), StartPage(), and PS_PLOTTER::StartPlot().

◆ plotScaleAdjY

double PSLIKE_PLOTTER::plotScaleAdjY
protectedinherited

◆ postscriptTextAscent

const double PSLIKE_PLOTTER::postscriptTextAscent = 0.718
staticprotectedinherited

Height of the postscript font (from the AFM)

Definition at line 124 of file plotters_pslike.h.

Referenced by PSLIKE_PLOTTER::computeTextParameters(), PSLIKE_PLOTTER::postscriptOverlinePositions(), and PSLIKE_PLOTTER::returnPostscriptTextWidth().

◆ streamLengthHandle

int PDF_PLOTTER::streamLengthHandle
protected

Handle of the page content object.

Definition at line 367 of file plotters_pslike.h.

Referenced by closePdfStream(), and startPdfStream().

◆ USE_DEFAULT_LINE_WIDTH

◆ workFile

◆ workFilename

wxString PDF_PLOTTER::workFilename
protected

Handle to the deferred stream length.

Definition at line 368 of file plotters_pslike.h.

Referenced by closePdfStream(), and startPdfStream().

◆ xrefTable

std::vector<long> PDF_PLOTTER::xrefTable
protected

Temporary file to construct the stream before zipping.

Definition at line 370 of file plotters_pslike.h.

Referenced by allocPdfObject(), EndPlot(), startPdfObject(), and StartPlot().


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