KiCad PCB EDA Suite
PDF_PLOTTER Class Reference

#include <plotter.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_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 Rectangles in PDF. More...
 
virtual void Circle (const wxPoint &pos, int diametre, FILL_T 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_T 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_T 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, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 virtual function FlashPadCircle More...
 
virtual void FlashPadOval (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 virtual function FlashPadOval More...
 
virtual void FlashPadRect (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 virtual function FlashPadRect More...
 
virtual void FlashPadRoundRect (const wxPoint &aPadPos, const wxSize &aSize, int aCornerRadius, double aOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 virtual function FlashPadRoundRect More...
 
virtual void FlashPadCustom (const wxPoint &aPadPos, const wxSize &aSize, SHAPE_POLY_SET *aPolygons, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 virtual function FlashPadCustom More...
 
virtual void FlashPadTrapez (const wxPoint &aPadPos, const wxPoint *aCorners, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData) override
 virtual function FlashPadTrapez flash a trapezoidal pad More...
 
virtual void FlashRegularPolygon (const wxPoint &aShapePos, int aDiameter, int aCornerCount, double aOrient, EDA_DRAW_MODE_T 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)
 Function AddLineToHeader Add a line to the list of free lines to print at the beginning of the file. More...
 
void ClearHeaderLinesList ()
 Function ClearHeaderLinesList remove all lines from the list of free lines to print at the beginning of the file. More...
 
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_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)
 Function PlotPoly. More...
 
virtual void ThickSegment (const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData)
 
virtual void ThickArc (const wxPoint &centre, double StAngle, double EndAngle, int rayon, int width, EDA_DRAW_MODE_T tracemode, void *aData)
 
virtual void ThickRect (const wxPoint &p1, const wxPoint &p2, int width, EDA_DRAW_MODE_T tracemode, void *aData)
 
virtual void ThickCircle (const wxPoint &pos, int diametre, int width, EDA_DRAW_MODE_T tracemode, void *aData)
 
void Marker (const wxPoint &position, int diametre, unsigned aShapeId)
 Draw a pattern shape number aShapeId, to coord position. More...
 
virtual void SetLayerPolarity (bool aPositive)
 Function SetLayerPolarity sets current Gerber layer polarity to positive or negative by writing %LPD*% or %LPC*% to the Gerber file, respectively. More...
 
virtual void 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, EDA_DRAW_MODE_T tracemode)
 Cdonvert a thick segment and plot it as an oval. More...
 
void sketchOval (const wxPoint &pos, const wxSize &size, double orient, int width)
 
virtual DPOINT userToDeviceCoordinates (const wxPoint &aCoordinate)
 Modifies coordinates according to the orientation, scale factor, and offsets trace. More...
 
virtual DPOINT userToDeviceSize (const wxSize &size)
 Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT) More...
 
virtual double userToDeviceSize (double size) const
 Modifies size according to the plotter scale factors (simple double version) More...
 
double GetDotMarkLenIU () const
 
double GetDashMarkLenIU () const
 
double GetDashGapLenIU () const
 

Protected Attributes

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 costruct 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 plotScale
 Plot scale - chosen by the user (even implicitly with 'fit in a4') More...
 
double m_IUsPerDecimil
 
double iuPerDeviceUnit
 Device scale (from IUs to plotter device units - usually decimils) More...
 
wxPoint plotOffset
 Plot offset (in IUs) More...
 
bool m_plotMirror
 X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG) More...
 
bool m_mirrorIsHorizontal
 
bool m_yaxisReversed
 true to mirror horizontally (else vertically) More...
 
FILE * outputFile
 true if the Y axis is top to bottom (SVG) More...
 
bool colorMode
 
bool negativeMode
 
int currentPenWidth
 
char penState
 
wxPoint penLastpos
 
wxString creator
 
wxString filename
 
wxString title
 
PAGE_INFO pageInfo
 
wxSize 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 849 of file plotter.h.

Constructor & Destructor Documentation

◆ PDF_PLOTTER()

PDF_PLOTTER::PDF_PLOTTER ( )
inline

Definition at line 852 of file plotter.h.

852  :
853  pageTreeHandle( 0 ),
854  fontResDictHandle( 0 ),
855  pageStreamHandle( 0 ),
856  streamLengthHandle( 0 ),
857  workFile( nullptr )
858  {
859  }
int pageTreeHandle
Definition: plotter.h:933
int streamLengthHandle
Handle of the page content object.
Definition: plotter.h:937
FILE * workFile
Definition: plotter.h:939
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:934
int pageStreamHandle
Handles to the page objects.
Definition: plotter.h:936

Member Function Documentation

◆ AddLineToHeader()

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

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

Parameters
aExtraStringis the string to print

Definition at line 179 of file plotter.h.

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

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 503 of file PDF_plotter.cpp.

504 {
505  xrefTable.push_back( 0 );
506  return xrefTable.size() - 1;
507 }
std::vector< long > xrefTable
Temporary file to costruct the stream before zipping.
Definition: plotter.h:940

References xrefTable.

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

◆ Arc()

void PDF_PLOTTER::Arc ( const wxPoint centre,
double  StAngle,
double  EndAngle,
int  radius,
FILL_T  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 294 of file PDF_plotter.cpp.

296 {
297  wxASSERT( workFile );
298  if( radius <= 0 )
299  {
300  Circle( centre, width, FILLED_SHAPE, 0 );
301  return;
302  }
303 
304  /* Arcs are not so easily approximated by beziers (in the general case),
305  so we approximate them in the old way */
306  wxPoint start, end;
307  const int delta = 50; // increment (in 0.1 degrees) to draw circles
308 
309  if( StAngle > EndAngle )
310  std::swap( StAngle, EndAngle );
311 
312  SetCurrentLineWidth( width );
313 
314  // Usual trig arc plotting routine...
315  start.x = centre.x + KiROUND( cosdecideg( radius, -StAngle ) );
316  start.y = centre.y + KiROUND( sindecideg( radius, -StAngle ) );
317  DPOINT pos_dev = userToDeviceCoordinates( start );
318  fprintf( workFile, "%g %g m ", pos_dev.x, pos_dev.y );
319  for( int ii = StAngle + delta; ii < EndAngle; ii += delta )
320  {
321  end.x = centre.x + KiROUND( cosdecideg( radius, -ii ) );
322  end.y = centre.y + KiROUND( sindecideg( radius, -ii ) );
323  pos_dev = userToDeviceCoordinates( end );
324  fprintf( workFile, "%g %g l ", pos_dev.x, pos_dev.y );
325  }
326 
327  end.x = centre.x + KiROUND( cosdecideg( radius, -EndAngle ) );
328  end.y = centre.y + KiROUND( sindecideg( radius, -EndAngle ) );
329  pos_dev = userToDeviceCoordinates( end );
330  fprintf( workFile, "%g %g l ", pos_dev.x, pos_dev.y );
331 
332  // The arc is drawn... if not filled we stroke it, otherwise we finish
333  // closing the pie at the center
334  if( fill == NO_FILL )
335  {
336  fputs( "S\n", workFile );
337  }
338  else
339  {
340  pos_dev = userToDeviceCoordinates( centre );
341  fprintf( workFile, "%g %g l b\n", pos_dev.x, pos_dev.y );
342  }
343 }
FILE * workFile
Definition: plotter.h:939
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:94
double cosdecideg(double r, double a)
Circle generation utility: computes r * cos(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:427
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:418
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
Circle drawing for PDF.
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 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, wxPoint::x, VECTOR2< T >::x, wxPoint::y, 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 204 of file plotter.cpp.

207 {
208  // Generic fallback: Quadratic Bezier curve plotted as a polyline
209  int minSegLen = aLineThickness; // The segment min length to approximate a bezier curve
210 
211  std::vector<wxPoint> ctrlPoints;
212  ctrlPoints.push_back( aStart );
213  ctrlPoints.push_back( aControl1 );
214  ctrlPoints.push_back( aControl2 );
215  ctrlPoints.push_back( aEnd );
216 
217  BEZIER_POLY bezier_converter( ctrlPoints );
218 
219  std::vector<wxPoint> approxPoints;
220  bezier_converter.GetPoly( approxPoints, minSegLen );
221 
222  SetCurrentLineWidth( aLineThickness );
223  MoveTo( aStart );
224 
225  for( unsigned ii = 1; ii < approxPoints.size()-1; ii++ )
226  LineTo( approxPoints[ii] );
227 
228  FinishTo( aEnd );
229 }
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:35
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::PlotDrawSegment(), and BRDITEMS_PLOTTER::PlotFootprintGraphicItem().

◆ Circle()

void PDF_PLOTTER::Circle ( const wxPoint pos,
int  diametre,
FILL_T  aFill,
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 237 of file PDF_plotter.cpp.

238 {
239  wxASSERT( workFile );
240  DPOINT pos_dev = userToDeviceCoordinates( pos );
241  double radius = userToDeviceSize( diametre / 2.0 );
242 
243  /* OK. Here's a trick. PDF doesn't support circles or circular angles, that's
244  a fact. You'll have to do with cubic beziers. These *can't* represent
245  circular arcs (NURBS can, beziers don't). But there is a widely known
246  approximation which is really good
247  */
248 
249  SetCurrentLineWidth( width );
250 
251  // If diameter is less than width, switch to filled mode
252  if( aFill == NO_FILL && diametre < width )
253  {
254  aFill = FILLED_SHAPE;
255  SetCurrentLineWidth( 0 );
256 
257  radius = userToDeviceSize( ( diametre / 2.0 ) + ( width / 2.0 ) );
258  }
259 
260  double magic = radius * 0.551784; // You don't want to know where this come from
261 
262  // This is the convex hull for the bezier approximated circle
263  fprintf( workFile, "%g %g m "
264  "%g %g %g %g %g %g c "
265  "%g %g %g %g %g %g c "
266  "%g %g %g %g %g %g c "
267  "%g %g %g %g %g %g c %c\n",
268  pos_dev.x - radius, pos_dev.y,
269 
270  pos_dev.x - radius, pos_dev.y + magic,
271  pos_dev.x - magic, pos_dev.y + radius,
272  pos_dev.x, pos_dev.y + radius,
273 
274  pos_dev.x + magic, pos_dev.y + radius,
275  pos_dev.x + radius, pos_dev.y + magic,
276  pos_dev.x + radius, pos_dev.y,
277 
278  pos_dev.x + radius, pos_dev.y - magic,
279  pos_dev.x + magic, pos_dev.y - radius,
280  pos_dev.x, pos_dev.y - radius,
281 
282  pos_dev.x - magic, pos_dev.y - radius,
283  pos_dev.x - radius, pos_dev.y - magic,
284  pos_dev.x - radius, pos_dev.y,
285 
286  aFill == NO_FILL ? 's' : 'b' );
287 }
FILE * workFile
Definition: plotter.h:939
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:125
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:94
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

Function ClearHeaderLinesList 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:601

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 657 of file PDF_plotter.cpp.

658 {
659  wxASSERT( workFile );
660 
661  // Close the page stream (and compress it)
662  closePdfStream();
663 
664  // Emit the page object and put it in the page list for later
665  pageHandles.push_back( startPdfObject() );
666 
667  /* Page size is in 1/72 of inch (default user space units)
668  Works like the bbox in postscript but there is no need for
669  swapping the sizes, since PDF doesn't require a portrait page.
670  We use the MediaBox but PDF has lots of other less used boxes
671  to use */
672 
673  const double BIGPTsPERMIL = 0.072;
674  wxSize psPaperSize = pageInfo.GetSizeMils();
675 
676  fprintf( outputFile,
677  "<<\n"
678  "/Type /Page\n"
679  "/Parent %d 0 R\n"
680  "/Resources <<\n"
681  " /ProcSet [/PDF /Text /ImageC /ImageB]\n"
682  " /Font %d 0 R >>\n"
683  "/MediaBox [0 0 %d %d]\n"
684  "/Contents %d 0 R\n"
685  ">>\n",
688  int( ceil( psPaperSize.x * BIGPTsPERMIL ) ),
689  int( ceil( psPaperSize.y * BIGPTsPERMIL ) ),
691  closePdfObject();
692 
693  // Mark the page stream as idle
694  pageStreamHandle = 0;
695 }
void closePdfStream()
Finish the current PDF stream (writes the deferred length, too)
int pageTreeHandle
Definition: plotter.h:933
std::vector< int > pageHandles
Font resource dictionary.
Definition: plotter.h:935
PAGE_INFO pageInfo
Definition: plotter.h:598
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:143
FILE * workFile
Definition: plotter.h:939
void closePdfObject()
Close the current PDF object.
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:934
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
int pageStreamHandle
Handles to the page objects.
Definition: plotter.h:936

References closePdfObject(), closePdfStream(), fontResDictHandle, PAGE_INFO::GetSizeMils(), PLOTTER::outputFile, pageHandles, PLOTTER::pageInfo, 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 531 of file PDF_plotter.cpp.

532 {
533  wxASSERT( outputFile );
534  wxASSERT( !workFile );
535  fputs( "endobj\n", outputFile );
536 }
FILE * workFile
Definition: plotter.h:939
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586

References PLOTTER::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 569 of file PDF_plotter.cpp.

570 {
571  wxASSERT( workFile );
572 
573  long stream_len = ftell( workFile );
574 
575  if( stream_len < 0 )
576  {
577  wxASSERT( false );
578  return;
579  }
580 
581  // Rewind the file, read in the page stream and DEFLATE it
582  fseek( workFile, 0, SEEK_SET );
583  unsigned char *inbuf = new unsigned char[stream_len];
584 
585  int rc = fread( inbuf, 1, stream_len, workFile );
586  wxASSERT( rc == stream_len );
587  (void) rc;
588 
589  // We are done with the temporary file, junk it
590  fclose( workFile );
591  workFile = 0;
592  ::wxRemoveFile( workFilename );
593 
594  // NULL means memos owns the memory, but provide a hint on optimum size needed.
595  wxMemoryOutputStream memos( NULL, std::max( 2000l, stream_len ) ) ;
596 
597  {
598  /* Somewhat standard parameters to compress in DEFLATE. The PDF spec is
599  * misleading, it says it wants a DEFLATE stream but it really want a ZLIB
600  * stream! (a DEFLATE stream would be generated with -15 instead of 15)
601  * rc = deflateInit2( &zstrm, Z_BEST_COMPRESSION, Z_DEFLATED, 15,
602  * 8, Z_DEFAULT_STRATEGY );
603  */
604 
605  wxZlibOutputStream zos( memos, wxZ_BEST_COMPRESSION, wxZLIB_ZLIB );
606 
607  zos.Write( inbuf, stream_len );
608 
609  delete[] inbuf;
610 
611  } // flush the zip stream using zos destructor
612 
613  wxStreamBuffer* sb = memos.GetOutputStreamBuffer();
614 
615  unsigned out_count = sb->Tell();
616 
617  fwrite( sb->GetBufferStart(), 1, out_count, outputFile );
618 
619  fputs( "endstream\n", outputFile );
620  closePdfObject();
621 
622  // Writing the deferred length as an indirect object
624  fprintf( outputFile, "%u\n", out_count );
625  closePdfObject();
626 }
wxString workFilename
Handle to the deferred stream length.
Definition: plotter.h:938
int streamLengthHandle
Handle of the page content object.
Definition: plotter.h:937
#define NULL
int startPdfObject(int handle=-1)
Open a new PDF object and returns the handle if the parameter is -1.
FILE * workFile
Definition: plotter.h:939
void closePdfObject()
Close the current PDF object.
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586

References closePdfObject(), NULL, PLOTTER::outputFile, 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 429 of file PS_plotter.cpp.

447 {
448  // Compute the starting position (compensated for alignment)
449  wxPoint start_pos = aPos;
450 
451  // This is an approximation of the text bounds (in IUs)
452  int tw = returnPostscriptTextWidth( aText, aSize.x, aItalic, aWidth );
453  int th = aSize.y;
454  int dx, dy;
455 
456  switch( aH_justify )
457  {
459  dx = -tw / 2;
460  break;
461 
463  dx = -tw;
464  break;
465 
467  dx = 0;
468  break;
469  }
470 
471  switch( aV_justify )
472  {
474  dy = th / 2;
475  break;
476 
478  dy = th;
479  break;
480 
482  dy = 0;
483  break;
484  }
485 
486  RotatePoint( &dx, &dy, aOrient );
487  RotatePoint( &tw, &th, aOrient );
488  start_pos.x += dx;
489  start_pos.y += dy;
490  DPOINT pos_dev = userToDeviceCoordinates( start_pos );
491  DPOINT sz_dev = userToDeviceSize( aSize );
492 
493  // Now returns the final values... the widening factor
494  *wideningFactor = sz_dev.x / sz_dev.y;
495 
496  // Mirrored texts must be plotted as mirrored!
497  if( m_plotMirror )
498  {
499  *wideningFactor = -*wideningFactor;
500  aOrient = -aOrient;
501  }
502 
503  // The CTM transformation matrix
504  double alpha = DECIDEG2RAD( aOrient );
505  double sinalpha = sin( alpha );
506  double cosalpha = cos( alpha );
507 
508  *ctm_a = cosalpha;
509  *ctm_b = sinalpha;
510  *ctm_c = -sinalpha;
511  *ctm_d = cosalpha;
512  *ctm_e = pos_dev.x;
513  *ctm_f = pos_dev.y;
514 
515  // This is because the letters are less than 1 unit high
516  *heightFactor = sz_dev.y / postscriptTextAscent;
517 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:581
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:348
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:125
static const double postscriptTextAscent
Height of the postscript font (from the AFM)
Definition: plotter.h:778
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:94
double DECIDEG2RAD(double deg)
Definition: trigo.h:223

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(), wxPoint::x, VECTOR2< T >::x, wxPoint::y, 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 184 of file PDF_plotter.cpp.

185 {
186  wxASSERT( workFile );
187  fprintf( workFile, "%g %g %g rg %g %g %g RG\n",
188  r, g, b, r, g, b );
189 }
FILE * workFile
Definition: plotter.h:939

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 44 of file PDF_plotter.cpp.

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

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 GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 486 of file plotter.h.

486 {}

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

◆ EndPlot()

bool PDF_PLOTTER::EndPlot ( )
overridevirtual

Implements PLOTTER.

Definition at line 731 of file PDF_plotter.cpp.

732 {
733  wxASSERT( outputFile );
734 
735  // Close the current page (often the only one)
736  ClosePage();
737 
738  /* We need to declare the resources we're using (fonts in particular)
739  The useful standard one is the Helvetica family. Adding external fonts
740  is *very* involved! */
741  struct {
742  const char *psname;
743  const char *rsname;
744  int font_handle;
745  } fontdefs[4] = {
746  { "/Helvetica", "/KicadFont", 0 },
747  { "/Helvetica-Oblique", "/KicadFontI", 0 },
748  { "/Helvetica-Bold", "/KicadFontB", 0 },
749  { "/Helvetica-BoldOblique", "/KicadFontBI", 0 }
750  };
751 
752  /* Declare the font resources. Since they're builtin fonts, no descriptors (yay!)
753  We'll need metrics anyway to do any alignment (these are in the shared with
754  the postscript engine) */
755  for( int i = 0; i < 4; i++ )
756  {
757  fontdefs[i].font_handle = startPdfObject();
758  fprintf( outputFile,
759  "<< /BaseFont %s\n"
760  " /Type /Font\n"
761  " /Subtype /Type1\n"
762 
763  /* Adobe is so Mac-based that the nearest thing to Latin1 is
764  the Windows ANSI encoding! */
765  " /Encoding /WinAnsiEncoding\n"
766  ">>\n",
767  fontdefs[i].psname );
768  closePdfObject();
769  }
770 
771  // Named font dictionary (was allocated, now we emit it)
773  fputs( "<<\n", outputFile );
774  for( int i = 0; i < 4; i++ )
775  {
776  fprintf( outputFile, " %s %d 0 R\n",
777  fontdefs[i].rsname, fontdefs[i].font_handle );
778  }
779  fputs( ">>\n", outputFile );
780  closePdfObject();
781 
782  /* The page tree: it's a B-tree but luckily we only have few pages!
783  So we use just an array... The handle was allocated at the beginning,
784  now we instantiate the corresponding object */
786  fputs( "<<\n"
787  "/Type /Pages\n"
788  "/Kids [\n", outputFile );
789 
790  for( unsigned i = 0; i < pageHandles.size(); i++ )
791  fprintf( outputFile, "%d 0 R\n", pageHandles[i] );
792 
793  fprintf( outputFile,
794  "]\n"
795  "/Count %ld\n"
796  ">>\n", (long) pageHandles.size() );
797  closePdfObject();
798 
799 
800  // The info dictionary
801  int infoDictHandle = startPdfObject();
802  char date_buf[250];
803  time_t ltime = time( NULL );
804  strftime( date_buf, 250, "D:%Y%m%d%H%M%S",
805  localtime( &ltime ) );
806 
807  if( title.IsEmpty() )
808  {
809  // Windows uses '\' and other platforms ue '/' as sepatator
810  title = filename.AfterLast('\\');
811  title = title.AfterLast('/');
812  }
813 
814  fprintf( outputFile,
815  "<<\n"
816  "/Producer (KiCad PDF)\n"
817  "/CreationDate (%s)\n"
818  "/Creator %s\n"
819  "/Title %s\n"
820  "/Trapped False\n",
821  date_buf,
822  encodeStringForPlotter( creator ).c_str(),
823  encodeStringForPlotter( title ).c_str() );
824 
825  fputs( ">>\n", outputFile );
826  closePdfObject();
827 
828  // The catalog, at last
829  int catalogHandle = startPdfObject();
830  fprintf( outputFile,
831  "<<\n"
832  "/Type /Catalog\n"
833  "/Pages %d 0 R\n"
834  "/Version /1.5\n"
835  "/PageMode /UseNone\n"
836  "/PageLayout /SinglePage\n"
837  ">>\n", pageTreeHandle );
838  closePdfObject();
839 
840  /* Emit the xref table (format is crucial to the byte, each entry must
841  be 20 bytes long, and object zero must be done in that way). Also
842  the offset must be kept along for the trailer */
843  long xref_start = ftell( outputFile );
844  fprintf( outputFile,
845  "xref\n"
846  "0 %ld\n"
847  "0000000000 65535 f \n", (long) xrefTable.size() );
848  for( unsigned i = 1; i < xrefTable.size(); i++ )
849  {
850  fprintf( outputFile, "%010ld 00000 n \n", xrefTable[i] );
851  }
852 
853  // Done the xref, go for the trailer
854  fprintf( outputFile,
855  "trailer\n"
856  "<< /Size %lu /Root %d 0 R /Info %d 0 R >>\n"
857  "startxref\n"
858  "%ld\n" // The offset we saved before
859  "%%%%EOF\n",
860  (unsigned long) xrefTable.size(), catalogHandle, infoDictHandle, xref_start );
861 
862  fclose( outputFile );
863  outputFile = NULL;
864 
865  return true;
866 }
int pageTreeHandle
Definition: plotter.h:933
std::vector< int > pageHandles
Font resource dictionary.
Definition: plotter.h:935
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.
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:44
void closePdfObject()
Close the current PDF object.
wxString title
Definition: plotter.h:597
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:934
std::vector< long > xrefTable
Temporary file to costruct the stream before zipping.
Definition: plotter.h:940
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
wxString filename
Definition: plotter.h:596
wxString creator
Definition: plotter.h:595

References ClosePage(), closePdfObject(), PLOTTER::creator, encodeStringForPlotter(), PLOTTER::filename, fontResDictHandle, NULL, PLOTTER::outputFile, pageHandles, pageTreeHandle, startPdfObject(), PLOTTER::title, and xrefTable.

Referenced by DIALOG_PLOT_SCHEMATIC::restoreEnvironment().

◆ FinishTo()

◆ FlashPadCircle()

void PSLIKE_PLOTTER::FlashPadCircle ( const wxPoint aPadPos,
int  aDiameter,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtualinherited

virtual function FlashPadCircle

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

Implements PLOTTER.

Definition at line 108 of file PS_plotter.cpp.

110 {
111  if( aTraceMode == FILLED )
112  Circle( aPadPos, aDiameter, FILLED_SHAPE, 0 );
113  else // Plot a ring:
114  {
116  int linewidth = GetCurrentLineWidth();
117 
118  // avoid aDiameter <= 1 )
119  if( linewidth > aDiameter-2 )
120  linewidth = aDiameter-2;
121 
122  Circle( aPadPos, aDiameter - linewidth, NO_FILL, linewidth );
123  }
124 
126 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:119
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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,
SHAPE_POLY_SET aPolygons,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtualinherited

virtual function FlashPadCustom

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

Implements PLOTTER.

Definition at line 214 of file PS_plotter.cpp.

217 {
218  wxSize size( aSize );
219 
220  if( aTraceMode == FILLED )
221  SetCurrentLineWidth( 0 );
222  else
223  {
225  size.x -= GetCurrentLineWidth();
226  size.y -= GetCurrentLineWidth();
227  }
228 
229 
230  std::vector< wxPoint > cornerList;
231 
232  for( int cnt = 0; cnt < aPolygons->OutlineCount(); ++cnt )
233  {
234  SHAPE_LINE_CHAIN& poly = aPolygons->Outline( cnt );
235  cornerList.clear();
236 
237  for( int ii = 0; ii < poly.PointCount(); ++ii )
238  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
239 
240  // Close polygon
241  cornerList.push_back( cornerList[0] );
242 
243  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
245  }
246 }
int OutlineCount() const
Returns the number of outlines in the set
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
int PointCount() const
Function PointCount()
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:119
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
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,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtualinherited

virtual function FlashPadOval

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

Implements PLOTTER.

Definition at line 78 of file PS_plotter.cpp.

80 {
81  wxASSERT( outputFile );
82  int x0, y0, x1, y1, delta;
83  wxSize size( aSize );
84 
85  // The pad is reduced to an oval by dy > dx
86  if( size.x > size.y )
87  {
88  std::swap( size.x, size.y );
89  aPadOrient = AddAngles( aPadOrient, 900 );
90  }
91 
92  delta = size.y - size.x;
93  x0 = 0;
94  y0 = -delta / 2;
95  x1 = 0;
96  y1 = delta / 2;
97  RotatePoint( &x0, &y0, aPadOrient );
98  RotatePoint( &x1, &y1, aPadOrient );
99 
100  if( aTraceMode == FILLED )
101  ThickSegment( wxPoint( aPadPos.x + x0, aPadPos.y + y0 ),
102  wxPoint( aPadPos.x + x1, aPadPos.y + y1 ), size.x, aTraceMode, NULL );
103  else
104  sketchOval( aPadPos, size, aPadOrient, -1 );
105 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
#define NULL
T AddAngles(T a1, T2 a2)
Add two angles (keeping the result normalized). T2 is here.
Definition: trigo.h:323
virtual void ThickSegment(const wxPoint &start, const wxPoint &end, int width, EDA_DRAW_MODE_T tracemode, void *aData)
Definition: plotter.cpp:507
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
void sketchOval(const wxPoint &pos, const wxSize &size, double orient, int width)
Definition: plotter.cpp:459

References AddAngles(), FILLED, NULL, PLOTTER::outputFile, RotatePoint(), PLOTTER::sketchOval(), PLOTTER::ThickSegment(), wxPoint::x, and wxPoint::y.

◆ FlashPadRect()

void PSLIKE_PLOTTER::FlashPadRect ( const wxPoint aPadPos,
const wxSize &  aSize,
double  aPadOrient,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtualinherited

virtual function FlashPadRect

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

Implements PLOTTER.

Definition at line 129 of file PS_plotter.cpp.

131 {
132  static std::vector< wxPoint > cornerList;
133  wxSize size( aSize );
134  cornerList.clear();
135 
136  if( aTraceMode == FILLED )
137  SetCurrentLineWidth( 0 );
138  else
140 
141  size.x -= GetCurrentLineWidth();
142  size.y -= GetCurrentLineWidth();
143 
144  if( size.x < 1 )
145  size.x = 1;
146 
147  if( size.y < 1 )
148  size.y = 1;
149 
150  int dx = size.x / 2;
151  int dy = size.y / 2;
152 
153  wxPoint corner;
154  corner.x = aPadPos.x - dx;
155  corner.y = aPadPos.y + dy;
156  cornerList.push_back( corner );
157  corner.x = aPadPos.x - dx;
158  corner.y = aPadPos.y - dy;
159  cornerList.push_back( corner );
160  corner.x = aPadPos.x + dx;
161  corner.y = aPadPos.y - dy;
162  cornerList.push_back( corner );
163  corner.x = aPadPos.x + dx;
164  corner.y = aPadPos.y + dy,
165  cornerList.push_back( corner );
166 
167  for( unsigned ii = 0; ii < cornerList.size(); ii++ )
168  {
169  RotatePoint( &cornerList[ii], aPadPos, aPadOrient );
170  }
171 
172  cornerList.push_back( cornerList[0] );
173 
174  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
176 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:119
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(), PLOTTER::USE_DEFAULT_LINE_WIDTH, wxPoint::x, and wxPoint::y.

◆ FlashPadRoundRect()

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

virtual function FlashPadRoundRect

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

Implements PLOTTER.

Definition at line 178 of file PS_plotter.cpp.

181 {
182  wxSize size( aSize );
183 
184  if( aTraceMode == FILLED )
185  SetCurrentLineWidth( 0 );
186  else
187  {
189  size.x -= GetCurrentLineWidth();
190  size.y -= GetCurrentLineWidth();
191  aCornerRadius -= GetCurrentLineWidth()/2;
192  }
193 
194 
195  SHAPE_POLY_SET outline;
196  TransformRoundChamferedRectToPolygon( outline, aPadPos, size, aOrient,
197  aCornerRadius, 0.0, 0, GetPlotterArcHighDef() );
198 
199  std::vector< wxPoint > cornerList;
200  // TransformRoundRectToPolygon creates only one convex polygon
201  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
202  cornerList.reserve( poly.PointCount() );
203 
204  for( int ii = 0; ii < poly.PointCount(); ++ii )
205  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
206 
207  // Close polygon
208  cornerList.push_back( cornerList[0] );
209 
210  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
212 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
int PointCount() const
Function PointCount()
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:119
SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
SHAPE_LINE_CHAIN.
int GetPlotterArcHighDef() const
Definition: plotter.h:223
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aError)
convert a rectangle with rounded corners and/or chamfered corners to a polygon Convert rounded corner...
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(), 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,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtualinherited

virtual function FlashPadTrapez flash a trapezoidal pad

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

Implements PLOTTER.

Definition at line 248 of file PS_plotter.cpp.

250 {
251  static std::vector< wxPoint > cornerList;
252  cornerList.clear();
253 
254  for( int ii = 0; ii < 4; ii++ )
255  cornerList.push_back( aCorners[ii] );
256 
257  if( aTraceMode == FILLED )
258  {
259  SetCurrentLineWidth( 0 );
260  }
261  else
262  {
264  int w = GetCurrentLineWidth();
265  // offset polygon by w
266  // coord[0] is assumed the lower left
267  // coord[1] is assumed the upper left
268  // coord[2] is assumed the upper right
269  // coord[3] is assumed the lower right
270 
271  /* Trace the outline. */
272  cornerList[0].x += w;
273  cornerList[0].y -= w;
274  cornerList[1].x += w;
275  cornerList[1].y += w;
276  cornerList[2].x -= w;
277  cornerList[2].y += w;
278  cornerList[3].x -= w;
279  cornerList[3].y -= w;
280  }
281 
282  for( int ii = 0; ii < 4; ii++ )
283  {
284  RotatePoint( &cornerList[ii], aPadOrient );
285  cornerList[ii] += aPadPos;
286  }
287 
288  cornerList.push_back( cornerList[0] );
289  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
291 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:208
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:119
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,
EDA_DRAW_MODE_T  aTraceMode,
void *  aData 
)
overridevirtualinherited

Flash a regular polygon.

Usefull 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 294 of file PS_plotter.cpp.

297 {
298  // Do nothing
299  wxASSERT( 0 );
300 }

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( ) const
protectedinherited

Definition at line 152 of file plotter.cpp.

153 {
155 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:125
#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 146 of file plotter.cpp.

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

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

867  {
868  return wxString( wxT( "pdf" ) );
869  }

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

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( ) const
protectedinherited

Definition at line 140 of file plotter.cpp.

141 {
143 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
#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:125

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:571

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotWorkSheet().

◆ GetPlotterArcHighDef()

int PLOTTER::GetPlotterArcHighDef ( ) const
inlineinherited

◆ 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:571

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

862  {
863  return PLOT_FORMAT::PDF;
864  }

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

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

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

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

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

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

275 {
276  Circle( position, radius * 2, NO_FILL, GetCurrentLineWidth() );
277 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
virtual void Circle(const wxPoint &pos, int diametre, FILL_T 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 304 of file plotter.cpp.

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

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

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

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

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

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

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

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

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

250 {
251  double r = KiROUND( radius / 1.4142 );
252  std::vector< wxPoint > corner_list;
253  wxPoint corner;
254  corner.x = position.x + r;
255  corner.y = position.y + r;
256  corner_list.push_back( corner );
257  corner.x = position.x + r;
258  corner.y = position.y - r;
259  corner_list.push_back( corner );
260  corner.x = position.x - r;
261  corner.y = position.y - r;
262  corner_list.push_back( corner );
263  corner.x = position.x - r;
264  corner.y = position.y + r;
265  corner_list.push_back( corner );
266  corner.x = position.x + r;
267  corner.y = position.y + r;
268  corner_list.push_back( corner );
269 
270  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
271 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
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, PLOTTER::PlotPoly(), wxPoint::x, and wxPoint::y.

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

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

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

Referenced by PLOTTER::Marker().

◆ MoveTo()

◆ OpenFile()

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

Open or create the plot file aFullFilename.

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

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

Reimplemented from PLOTTER.

Definition at line 114 of file PDF_plotter.cpp.

115 {
116  filename = aFullFilename;
117 
118  wxASSERT( !outputFile );
119 
120  // Open the PDF file in binary mode
121  outputFile = wxFopen( filename, wxT( "wb" ) );
122 
123  if( outputFile == NULL )
124  return false ;
125 
126  return true;
127 }
#define NULL
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
wxString filename
Definition: plotter.h:596

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

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::Arc(), HPGL_PLOTTER::Circle(), HPGL_PLOTTER::FlashPadCircle(), HPGL_PLOTTER::PlotPoly(), GERBER_PLOTTER::PlotPoly(), DXF_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 372 of file PDF_plotter.cpp.

373 {
374  wxASSERT( workFile );
375  if( plume == 'Z' )
376  {
377  if( penState != 'Z' )
378  {
379  fputs( "S\n", workFile );
380  penState = 'Z';
381  penLastpos.x = -1;
382  penLastpos.y = -1;
383  }
384  return;
385  }
386 
387  if( penState != plume || pos != penLastpos )
388  {
389  DPOINT pos_dev = userToDeviceCoordinates( pos );
390  fprintf( workFile, "%g %g %c\n",
391  pos_dev.x, pos_dev.y,
392  ( plume=='D' ) ? 'l' : 'm' );
393  }
394  penState = plume;
395  penLastpos = pos;
396 }
char penState
Definition: plotter.h:592
wxPoint penLastpos
Definition: plotter.h:593
FILE * workFile
Definition: plotter.h:939
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:94

References PLOTTER::penLastpos, PLOTTER::penState, PLOTTER::userToDeviceCoordinates(), workFile, wxPoint::x, VECTOR2< T >::x, wxPoint::y, 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 401 of file PDF_plotter.cpp.

403 {
404  wxASSERT( workFile );
405  wxSize pix_size( aImage.GetWidth(), aImage.GetHeight() );
406 
407  // Requested size (in IUs)
408  DPOINT drawsize( aScaleFactor * pix_size.x,
409  aScaleFactor * pix_size.y );
410 
411  // calculate the bitmap start position
412  wxPoint start( aPos.x - drawsize.x / 2,
413  aPos.y + drawsize.y / 2);
414 
415  DPOINT dev_start = userToDeviceCoordinates( start );
416 
417  /* PDF has an uhm... simplified coordinate system handling. There is
418  *one* operator to do everything (the PS concat equivalent). At least
419  they kept the matrix stack to save restore environments. Also images
420  are always emitted at the origin with a size of 1x1 user units.
421  What we need to do is:
422  1) save the CTM end establish the new one
423  2) plot the image
424  3) restore the CTM
425  4) profit
426  */
427  fprintf( workFile, "q %g 0 0 %g %g %g cm\n", // Step 1
428  userToDeviceSize( drawsize.x ),
429  userToDeviceSize( drawsize.y ),
430  dev_start.x, dev_start.y );
431 
432  /* An inline image is a cross between a dictionary and a stream.
433  A real ugly construct (compared with the elegance of the PDF
434  format). Also it accepts some 'abbreviations', which is stupid
435  since the content stream is usually compressed anyway... */
436  fprintf( workFile,
437  "BI\n"
438  " /BPC 8\n"
439  " /CS %s\n"
440  " /W %d\n"
441  " /H %d\n"
442  "ID\n", colorMode ? "/RGB" : "/G", pix_size.x, pix_size.y );
443 
444  /* Here comes the stream (in binary!). I *could* have hex or ascii84
445  encoded it, but who cares? I'll go through zlib anyway */
446  for( int y = 0; y < pix_size.y; y++ )
447  {
448  for( int x = 0; x < pix_size.x; x++ )
449  {
450  unsigned char r = aImage.GetRed( x, y ) & 0xFF;
451  unsigned char g = aImage.GetGreen( x, y ) & 0xFF;
452  unsigned char b = aImage.GetBlue( x, y ) & 0xFF;
453 
454  // PDF inline images don't support alpha, so premultiply against white background
455  if( aImage.HasAlpha() )
456  {
457  unsigned char alpha = aImage.GetAlpha( x, y ) & 0xFF;
458 
459  if( alpha < 0xFF )
460  {
461  float a = 1.0 - ( (float) alpha / 255.0 );
462  r = ( int )( r + ( a * 0xFF ) ) & 0xFF;
463  g = ( int )( g + ( a * 0xFF ) ) & 0xFF;
464  b = ( int )( b + ( a * 0xFF ) ) & 0xFF;
465  }
466  }
467 
468  if( aImage.HasMask() )
469  {
470  if( r == aImage.GetMaskRed() && g == aImage.GetMaskGreen() && b == aImage.GetMaskBlue() )
471  {
472  r = 0xFF;
473  g = 0xFF;
474  b = 0xFF;
475  }
476  }
477 
478  // As usual these days, stdio buffering has to suffeeeeerrrr
479  if( colorMode )
480  {
481  putc( r, workFile );
482  putc( g, workFile );
483  putc( b, workFile );
484  }
485  else
486  {
487  // Greyscale conversion (CIE 1931)
488  unsigned char grey = KiROUND( r * 0.2126 + g * 0.7152 + b * 0.0722 );
489  putc( grey, workFile );
490  }
491  }
492  }
493 
494  fputs( "EI Q\n", workFile ); // Finish step 2 and do step 3
495 }
bool colorMode
Definition: plotter.h:589
FILE * workFile
Definition: plotter.h:939
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:125
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:94
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::colorMode, KiROUND(), PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), workFile, wxPoint::x, VECTOR2< T >::x, wxPoint::y, and VECTOR2< T >::y.

◆ PlotPoly() [1/2]

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

Function PlotPoly.

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

585 {
586  std::vector<wxPoint> cornerList;
587  cornerList.reserve( aCornerList.PointCount() );
588 
589  for( int ii = 0; ii < aCornerList.PointCount(); ii++ )
590  cornerList.emplace_back( aCornerList.CPoint( ii ) );
591 
592  if( aCornerList.IsClosed() && cornerList.front() != cornerList.back() )
593  cornerList.emplace_back( aCornerList.CPoint( 0 ) );
594 
595  PlotPoly( cornerList, aFill, aWidth, aData );
596 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
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().

◆ PlotPoly() [2/2]

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

Polygon plotting for PDF.

Everything is supported

Implements PLOTTER.

Definition at line 349 of file PDF_plotter.cpp.

351 {
352  wxASSERT( workFile );
353  if( aCornerList.size() <= 1 )
354  return;
355 
356  SetCurrentLineWidth( aWidth );
357 
358  DPOINT pos = userToDeviceCoordinates( aCornerList[0] );
359  fprintf( workFile, "%g %g m\n", pos.x, pos.y );
360 
361  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
362  {
363  pos = userToDeviceCoordinates( aCornerList[ii] );
364  fprintf( workFile, "%g %g l\n", pos.x, pos.y );
365  }
366 
367  // Close path and stroke(/fill)
368  fprintf( workFile, "%c\n", aFill == NO_FILL ? 'S' : 'b' );
369 }
FILE * workFile
Definition: plotter.h:939
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:94
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.

◆ 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 377 of file PS_plotter.cpp.

380 {
381  /* XXX This function is *too* similar to returnPostscriptTextWidth.
382  Consider merging them... */
383  const double *width_table = aBold ? ( aItalic ? hvbo_widths : hvb_widths )
384  : ( aItalic ? hvo_widths : hv_widths );
385  double tally = 0;
386 
387  for( unsigned i = 0; i < aText.length(); i++ )
388  {
389  wchar_t AsciiCode = aText[i];
390  // Skip the negation marks and untabled points
391  if( AsciiCode != '~' && AsciiCode < 256 )
392  {
393  tally += width_table[AsciiCode];
394  }
395  else
396  {
397  if( AsciiCode == '~' )
398  pos_pairs->push_back( KiROUND( aXSize * tally / postscriptTextAscent ) );
399  }
400  }
401 
402  // Special rule: we have to complete the last bar if the ~ aren't matched
403  if( pos_pairs->size() % 2 == 1 )
404  pos_pairs->push_back( KiROUND( aXSize * tally / postscriptTextAscent ) );
405 }
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)
Definition: plotter.h:778
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_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Rectangles in PDF.

Supported by the native operator

Implements PLOTTER.

Definition at line 221 of file PDF_plotter.cpp.

222 {
223  wxASSERT( workFile );
224  DPOINT p1_dev = userToDeviceCoordinates( p1 );
225  DPOINT p2_dev = userToDeviceCoordinates( p2 );
226 
227  SetCurrentLineWidth( width );
228  fprintf( workFile, "%g %g %g %g re %c\n", p1_dev.x, p1_dev.y,
229  p2_dev.x - p1_dev.x, p2_dev.y - p1_dev.y,
230  fill == NO_FILL ? 'S' : 'B' );
231 }
FILE * workFile
Definition: plotter.h:939
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:94
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 348 of file PS_plotter.cpp.

350 {
351  const double *width_table = aBold ? ( aItalic ? hvbo_widths : hvb_widths )
352  : ( aItalic ? hvo_widths : hv_widths );
353  double tally = 0;
354 
355  for( unsigned i = 0; i < aText.length(); i++ )
356  {
357  wchar_t AsciiCode = aText[i];
358  // Skip the negation marks and untabled points
359  if( AsciiCode != '~' && AsciiCode < 256 )
360  {
361  tally += width_table[AsciiCode];
362  }
363  }
364 
365  // Widths are proportional to height, but height is enlarged by a
366  // scaling factor
367  return KiROUND( aXSize * tally / postscriptTextAscent );
368 }
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)
Definition: plotter.h:778
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,
EDA_DRAW_MODE_T  tracemode 
)
protectedinherited

Cdonvert a thick segment and plot it as an oval.

Definition at line 438 of file plotter.cpp.

440 {
441  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
442  wxSize size( end.x - start.x, end.y - start.y );
443  double orient;
444 
445  if( size.y == 0 )
446  orient = 0;
447  else if( size.x == 0 )
448  orient = 900;
449  else
450  orient = -ArcTangente( size.y, size.x );
451 
452  size.x = KiROUND( EuclideanNorm( size ) ) + width;
453  size.y = width;
454 
455  FlashPadOval( center, size, orient, tracemode, NULL );
456 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:133
#define NULL
virtual void FlashPadOval(const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)=0
virtual function FlashPadOval
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:162

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

Referenced by PLOTTER::ThickSegment(), HPGL_PLOTTER::ThickSegment(), and GERBER_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 52 of file PS_plotter.cpp.

53 {
54  if( colorMode )
55  {
56  if( negativeMode )
57  emitSetRGBColor( 1 - color.r, 1 - color.g, 1 - color.b );
58  else
59  emitSetRGBColor( color.r, color.g, color.b );
60  }
61  else
62  {
63  /* B/W Mode - Use BLACK or WHITE for all items
64  * note the 2 colors are used in B&W mode, mainly by Pcbnew to draw
65  * holes in white on pads in black
66  */
67  double k = 1; // White
68  if( color != COLOR4D::WHITE )
69  k = 0;
70  if( negativeMode )
71  emitSetRGBColor( 1 - k, 1 - k, 1 - k );
72  else
73  emitSetRGBColor( k, k, k );
74  }
75 }
int color
Definition: DXF_plotter.cpp:61
bool colorMode
Definition: plotter.h:589
virtual void emitSetRGBColor(double r, double g, double b)=0
Virtual primitive for emitting the setrgbcolor operator.
Definition: color4d.h:48
bool negativeMode
Definition: plotter.h:590

References color, PLOTTER::colorMode, PSLIKE_PLOTTER::emitSetRGBColor(), PLOTTER::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  aWidth,
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 actally change the polygon

Implements PLOTTER.

Definition at line 154 of file PDF_plotter.cpp.

155 {
156  wxASSERT( workFile );
157 
158  if( aWidth == DO_NOT_SET_LINE_WIDTH )
159  return;
160  else if( aWidth == USE_DEFAULT_LINE_WIDTH )
162 
163  if( aWidth == 0 )
164  aWidth = 1;
165 
166  wxASSERT_MSG( aWidth > 0, "Plotter called to set negative pen width" );
167 
168  if( aWidth != currentPenWidth )
169  fprintf( workFile, "%g w\n", userToDeviceSize( aWidth ) );
170 
171  currentPenWidth = aWidth;
172 }
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:119
RENDER_SETTINGS * m_renderSettings
Definition: plotter.h:603
FILE * workFile
Definition: plotter.h:939
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:125
int currentPenWidth
Definition: plotter.h:591
int GetDefaultPenWidth() const
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:118

References PLOTTER::currentPenWidth, PLOTTER::DO_NOT_SET_LINE_WIDTH, KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), 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 194 of file PDF_plotter.cpp.

195 {
196  wxASSERT( workFile );
197  switch( dashed )
198  {
200  fprintf( workFile, "[%d %d] 0 d\n",
201  (int) GetDashMarkLenIU(), (int) GetDashGapLenIU() );
202  break;
203  case PLOT_DASH_TYPE::DOT:
204  fprintf( workFile, "[%d %d] 0 d\n",
205  (int) GetDotMarkLenIU(), (int) GetDashGapLenIU() );
206  break;
208  fprintf( workFile, "[%d %d %d %d] 0 d\n",
209  (int) GetDashMarkLenIU(), (int) GetDashGapLenIU(),
210  (int) GetDotMarkLenIU(), (int) GetDashGapLenIU() );
211  break;
212  default:
213  fputs( "[] 0 d\n", workFile );
214  }
215 }
double GetDotMarkLenIU() const
Definition: plotter.cpp:140
double GetDashGapLenIU() const
Definition: plotter.cpp:152
FILE * workFile
Definition: plotter.h:939
double GetDashMarkLenIU() const
Definition: plotter.cpp:146

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

461  {
462  // NOP for most plotters. Only for Gerber plotter
463  }

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

◆ SetLayerPolarity()

virtual void PLOTTER::SetLayerPolarity ( bool  aPositive)
inlinevirtualinherited

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

(obviously starts a new Gerber layer, too)

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

Reimplemented in GERBER_PLOTTER.

Definition at line 446 of file plotter.h.

447  {
448  // NOP for most plotters
449  }

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 135 of file plotter.h.

136  {
137  negativeMode = aNegative;
138  }
bool negativeMode
Definition: plotter.h:590

References PLOTTER::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 716 of file plotter.h.

717  {
718  plotScaleAdjX = scaleX;
719  plotScaleAdjY = scaleY;
720  }
double plotScaleAdjY
Definition: plotter.h:784
double plotScaleAdjX
Fine user scale adjust ( = 1.0 if no correction)
Definition: plotter.h:784

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

466  {
467  // NOP for most plotters. Only for SVG plotter
468  }

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

708  {
709  if( mode != PLOT_TEXT_MODE::DEFAULT )
710  m_textMode = mode;
711  }
PLOT_TEXT_MODE m_textMode
How to draw text.
Definition: plotter.h:787

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

170  {
171  title = aTitle;
172  }
wxString title
Definition: plotter.h:597

References PLOTTER::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 130 of file PDF_plotter.cpp.

132 {
133  m_plotMirror = aMirror;
134  plotOffset = aOffset;
135  plotScale = aScale;
136  m_IUsPerDecimil = aIusPerDecimil;
137 
138  // The CTM is set to 1 user unit per decimil
139  iuPerDeviceUnit = 1.0 / aIusPerDecimil;
140 
141  /* The paper size in this engined is handled page by page
142  Look in the StartPage function */
143 }
double m_IUsPerDecimil
Definition: plotter.h:571
wxPoint plotOffset
Plot offset (in IUs)
Definition: plotter.h:577
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:581
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:565
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:574

References PLOTTER::iuPerDeviceUnit, PLOTTER::m_IUsPerDecimil, PLOTTER::m_plotMirror, PLOTTER::plotOffset, and PLOTTER::plotScale.

◆ sketchOval()

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

Definition at line 459 of file plotter.cpp.

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

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

Referenced by HPGL_PLOTTER::FlashPadOval(), PSLIKE_PLOTTER::FlashPadOval(), GERBER_PLOTTER::FlashPadOval(), and DXF_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 GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 477 of file plotter.h.

477 {}

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 631 of file PDF_plotter.cpp.

632 {
633  wxASSERT( outputFile );
634  wxASSERT( !workFile );
635 
636  // Compute the paper size in IUs
638  paperSize.x *= 10.0 / iuPerDeviceUnit;
639  paperSize.y *= 10.0 / iuPerDeviceUnit;
640 
641  // Open the content stream; the page object will go later
643 
644  /* Now, until ClosePage *everything* must be wrote in workFile, to be
645  compressed later in closePdfStream */
646 
647  // Default graphic settings (coordinate system, default color and line style)
648  fprintf( workFile,
649  "%g 0 0 %g 0 0 cm 1 J 1 j 0 0 0 rg 0 0 0 RG %g w\n",
650  0.0072 * plotScaleAdjX, 0.0072 * plotScaleAdjY,
652 }
PAGE_INFO pageInfo
Definition: plotter.h:598
double plotScaleAdjY
Definition: plotter.h:784
int startPdfStream(int handle=-1)
Starts a PDF stream (for the page).
RENDER_SETTINGS * m_renderSettings
Definition: plotter.h:603
const wxSize & GetSizeMils() const
Definition: page_info.h:143
FILE * workFile
Definition: plotter.h:939
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:125
double plotScaleAdjX
Fine user scale adjust ( = 1.0 if no correction)
Definition: plotter.h:784
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
int GetDefaultPenWidth() const
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:574
int pageStreamHandle
Handles to the page objects.
Definition: plotter.h:936
wxSize paperSize
Definition: plotter.h:599

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), PAGE_INFO::GetSizeMils(), PLOTTER::iuPerDeviceUnit, PLOTTER::m_renderSettings, PLOTTER::outputFile, PLOTTER::pageInfo, pageStreamHandle, PLOTTER::paperSize, 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 514 of file PDF_plotter.cpp.

515 {
516  wxASSERT( outputFile );
517  wxASSERT( !workFile );
518 
519  if( handle < 0)
520  handle = allocPdfObject();
521 
522  xrefTable[handle] = ftell( outputFile );
523  fprintf( outputFile, "%d 0 obj\n", handle );
524  return handle;
525 }
FILE * workFile
Definition: plotter.h:939
std::vector< long > xrefTable
Temporary file to costruct the stream before zipping.
Definition: plotter.h:940
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
int allocPdfObject()
Allocate a new handle in the table of the PDF object.

References allocPdfObject(), PLOTTER::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 545 of file PDF_plotter.cpp.

546 {
547  wxASSERT( outputFile );
548  wxASSERT( !workFile );
549  handle = startPdfObject( handle );
550 
551  // This is guaranteed to be handle+1 but needs to be allocated since
552  // you could allocate more object during stream preparation
554  fprintf( outputFile,
555  "<< /Length %d 0 R /Filter /FlateDecode >>\n" // Length is deferred
556  "stream\n", handle + 1 );
557 
558  // Open a temporary file to accumulate the stream
559  workFilename = wxFileName::CreateTempFileName( "" );
560  workFile = wxFopen( workFilename, wxT( "w+b" ));
561  wxASSERT( workFile );
562  return handle;
563 }
wxString workFilename
Handle to the deferred stream length.
Definition: plotter.h:938
int streamLengthHandle
Handle of the page content object.
Definition: plotter.h:937
int startPdfObject(int handle=-1)
Open a new PDF object and returns the handle if the parameter is -1.
FILE * workFile
Definition: plotter.h:939
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
int allocPdfObject()
Allocate a new handle in the table of the PDF object.

References allocPdfObject(), PLOTTER::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 702 of file PDF_plotter.cpp.

703 {
704  wxASSERT( outputFile );
705 
706  // First things first: the customary null object
707  xrefTable.clear();
708  xrefTable.push_back( 0 );
709 
710  /* The header (that's easy!). The second line is binary junk required
711  to make the file binary from the beginning (the important thing is
712  that they must have the bit 7 set) */
713  fputs( "%PDF-1.5\n%\200\201\202\203\n", outputFile );
714 
715  /* Allocate an entry for the page tree root, it will go in every page
716  parent entry */
718 
719  /* In the same way, the font resource dictionary is used by every page
720  (it *could* be inherited via the Pages tree */
722 
723  /* Now, the PDF is read from the end, (more or less)... so we start
724  with the page stream for page 1. Other more important stuff is written
725  at the end */
726  StartPage();
727  return true;
728 }
virtual void StartPage()
Starts a new page in the PDF document.
int pageTreeHandle
Definition: plotter.h:933
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:934
std::vector< long > xrefTable
Temporary file to costruct the stream before zipping.
Definition: plotter.h:940
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:586
int allocPdfObject()
Allocate a new handle in the table of the PDF object.

References allocPdfObject(), fontResDictHandle, PLOTTER::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 868 of file PDF_plotter.cpp.

880 {
881  // PDF files do not like 0 sized texts which create broken files.
882  if( aSize.x == 0 || aSize.y == 0 )
883  return;
884 
885  // Render phantom text (which will be searchable) behind the stroke font. This won't
886  // be pixel-accurate, but it doesn't matter for searching.
887  int render_mode = 3; // invisible
888 
889  const char *fontname = aItalic ? ( aBold ? "/KicadFontBI" : "/KicadFontI" )
890  : ( aBold ? "/KicadFontB" : "/KicadFont" );
891 
892  // Compute the copious transformation parameters of the Curent Transform Matrix
893  double ctm_a, ctm_b, ctm_c, ctm_d, ctm_e, ctm_f;
894  double wideningFactor, heightFactor;
895 
896  computeTextParameters( aPos, aText, aOrient, aSize, m_plotMirror, aH_justify,
897  aV_justify, aWidth, aItalic, aBold,
898  &wideningFactor, &ctm_a, &ctm_b, &ctm_c,
899  &ctm_d, &ctm_e, &ctm_f, &heightFactor );
900 
901  SetColor( aColor );
902  SetCurrentLineWidth( aWidth, aData );
903 
904  /* We use the full CTM instead of the text matrix because the same
905  coordinate system will be used for the overlining. Also the %f
906  for the trig part of the matrix to avoid %g going in exponential
907  format (which is not supported) */
908  fprintf( workFile, "q %f %f %f %f %g %g cm BT %s %g Tf %d Tr %g Tz ",
909  ctm_a, ctm_b, ctm_c, ctm_d, ctm_e, ctm_f,
910  fontname, heightFactor, render_mode, wideningFactor * 100 );
911 
912  // The text must be escaped correctly
913  std:: string txt_pdf = encodeStringForPlotter( aText );
914  fprintf( workFile, "%s Tj ET\n", txt_pdf.c_str() );
915 
916  // Restore the CTM
917  fputs( "Q\n", workFile );
918 
919  // Plot the stroked text (if requested)
920  PLOTTER::Text( aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aWidth,
921  aItalic, aBold, aMultilineAllowed );
922 }
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:222
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:581
virtual void SetColor(COLOR4D color) override
The SetColor implementation is split with the subclasses: The PSLIKE computes the rgb values,...
Definition: PS_plotter.cpp:52
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:44
FILE * workFile
Definition: plotter.h:939
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:429
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,
EDA_DRAW_MODE_T  tracemode,
void *  aData 
)
virtualinherited

Reimplemented in GERBER_PLOTTER.

Definition at line 531 of file plotter.cpp.

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

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

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

◆ ThickCircle()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 569 of file plotter.cpp.

571 {
572  if( tracemode == FILLED )
573  Circle( pos, diametre, NO_FILL, width );
574  else
575  {
576  SetCurrentLineWidth( -1 );
577  Circle( pos, diametre - width + currentPenWidth, NO_FILL, -1 );
578  Circle( pos, diametre + width - currentPenWidth, NO_FILL, -1 );
579  }
580 }
int currentPenWidth
Definition: plotter.h:591
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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

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

◆ ThickRect()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 547 of file plotter.cpp.

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

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

◆ ThickSegment()

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

Reimplemented in DXF_PLOTTER, GERBER_PLOTTER, and HPGL_PLOTTER.

Definition at line 507 of file plotter.cpp.

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

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

Referenced by PSLIKE_PLOTTER::FlashPadOval(), BRDITEMS_PLOTTER::PlotDrawSegment(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), PlotLayerOutlines(), 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 94 of file plotter.cpp.

95 {
96  wxPoint pos = aCoordinate - plotOffset;
97 
98  // Don't allow overflows; they can cause rendering failures in some file viewers
99  // (such as Acrobat)
100  int clampSize = MAX_PAGE_SIZE_MILS * m_IUsPerDecimil * 10 / 2;
101  pos.x = std::max( -clampSize, std::min( pos.x, clampSize ) );
102  pos.y = std::max( -clampSize, std::min( pos.y, clampSize ) );
103 
104  double x = pos.x * plotScale;
105  double y = ( paperSize.y - pos.y * plotScale );
106 
107  if( m_plotMirror )
108  {
110  x = ( paperSize.x - pos.x * plotScale );
111  else
112  y = pos.y * plotScale;
113  }
114 
115  if( m_yaxisReversed )
116  y = paperSize.y - y;
117 
118  x *= iuPerDeviceUnit;
119  y *= iuPerDeviceUnit;
120 
121  return DPOINT( x, y );
122 }
double m_IUsPerDecimil
Definition: plotter.h:571
wxPoint plotOffset
Plot offset (in IUs)
Definition: plotter.h:577
bool m_yaxisReversed
true to mirror horizontally (else vertically)
Definition: plotter.h:583
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:581
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:565
#define MAX_PAGE_SIZE_MILS
Definition: page_info.h:41
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:574
VECTOR2< double > DPOINT
Definition: vector2d.h:599
wxSize paperSize
Definition: plotter.h:599
bool m_mirrorIsHorizontal
Definition: plotter.h:582

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

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

◆ userToDeviceSize() [1/2]

DPOINT PLOTTER::userToDeviceSize ( const wxSize &  size)
protectedvirtualinherited

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

Definition at line 125 of file plotter.cpp.

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

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

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

◆ userToDeviceSize() [2/2]

double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtualinherited

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

Definition at line 132 of file plotter.cpp.

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

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

Member Data Documentation

◆ colorMode

bool PLOTTER::colorMode
protectedinherited

◆ creator

wxString PLOTTER::creator
protectedinherited

◆ currentPenWidth

◆ DO_NOT_SET_LINE_WIDTH

◆ filename

wxString PLOTTER::filename
protectedinherited

Definition at line 596 of file plotter.h.

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

◆ fontResDictHandle

int PDF_PLOTTER::fontResDictHandle
protected

Handle to the root of the page tree object.

Definition at line 934 of file plotter.h.

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

◆ iuPerDeviceUnit

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

◆ m_IUsPerDecimil

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

◆ m_plotMirror

◆ m_renderSettings

◆ m_textMode

PLOT_TEXT_MODE PSLIKE_PLOTTER::m_textMode
protectedinherited

How to draw text.

Definition at line 787 of file plotter.h.

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

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed
protectedinherited

true to mirror horizontally (else vertically)

Definition at line 583 of file plotter.h.

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

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58
staticinherited

Draw a marker (used for the drill map)

Definition at line 428 of file plotter.h.

Referenced by PLOTTER::Marker().

◆ negativeMode

bool PLOTTER::negativeMode
protectedinherited

Definition at line 590 of file plotter.h.

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

◆ outputFile

FILE* PLOTTER::outputFile
protectedinherited

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

Output file

Definition at line 586 of file plotter.h.

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

◆ pageHandles

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

Font resource dictionary.

Definition at line 935 of file plotter.h.

Referenced by ClosePage(), and EndPlot().

◆ pageInfo

◆ pageStreamHandle

int PDF_PLOTTER::pageStreamHandle
protected

Handles to the page objects.

Definition at line 936 of file plotter.h.

Referenced by ClosePage(), and StartPage().

◆ pageTreeHandle

int PDF_PLOTTER::pageTreeHandle
protected

Definition at line 933 of file plotter.h.

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

◆ paperSize

◆ penLastpos

wxPoint PLOTTER::penLastpos
protectedinherited

◆ penState

char PLOTTER::penState
protectedinherited

◆ plotOffset

◆ plotScale

◆ plotScaleAdjX

double PSLIKE_PLOTTER::plotScaleAdjX
protectedinherited

Fine user scale adjust ( = 1.0 if no correction)

Definition at line 784 of file plotter.h.

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

◆ plotScaleAdjY

double PSLIKE_PLOTTER::plotScaleAdjY
protectedinherited

Definition at line 784 of file plotter.h.

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

◆ postscriptTextAscent

const double PSLIKE_PLOTTER::postscriptTextAscent = 0.718
staticprotectedinherited

Height of the postscript font (from the AFM)

Definition at line 778 of file plotter.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 937 of file plotter.h.

Referenced by closePdfStream(), and startPdfStream().

◆ title

wxString PLOTTER::title
protectedinherited

Definition at line 597 of file plotter.h.

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

◆ USE_DEFAULT_LINE_WIDTH

◆ workFile

◆ workFilename

wxString PDF_PLOTTER::workFilename
protected

Handle to the deferred stream length.

Definition at line 938 of file plotter.h.

Referenced by closePdfStream(), and startPdfStream().

◆ xrefTable

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

Temporary file to costruct the stream before zipping.

Definition at line 940 of file plotter.h.

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


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