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 PlotFormat 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 (int dashed) override
 PDF supports dashed lines. More...
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings) override
 PDF can have multiple pages, so SetPageSettings can be called with the outputFile open (but not inside a page stream!) More...
 
virtual void SetViewport (const wxPoint &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
 Set the plot offset and scaling for the current plot. More...
 
virtual void Rect (const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 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 (PlotTextMode mode) override
 PS and PDF fully implement native text (for the Latin-1 subset) More...
 
virtual void SetDefaultLineWidth (int width) override
 Set the default line width. 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
 
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 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

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...
 
void fputsPostscriptString (FILE *fout, const wxString &txt)
 Write on a stream a string escaped for postscript/PDF. 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
 
PlotTextMode 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
 true to plot in color, false to plot in black and white More...
 
int defaultPenWidth
 true to generate a negative image (PS mode mainly) More...
 
int currentPenWidth
 
char penState
 Current pen state: 'U', 'D' or 'Z' (see PenTo) More...
 
wxPoint penLastpos
 Last pen positions; set to -1,-1 when the pen is at rest. More...
 
wxString creator
 
wxString filename
 
wxString title
 
PAGE_INFO pageInfo
 
wxSize paperSize
 Paper size in IU - not in mils. More...
 
wxArrayString m_headerExtraLines
 

Static Protected Attributes

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

Detailed Description

Definition at line 840 of file plotter.h.

Constructor & Destructor Documentation

◆ PDF_PLOTTER()

PDF_PLOTTER::PDF_PLOTTER ( )
inline

Definition at line 843 of file plotter.h.

843  : pageStreamHandle( 0 ), workFile( NULL )
844  {
845  // Avoid non initialized variables:
847  pageTreeHandle = 0;
848  }
int pageTreeHandle
Definition: plotter.h:919
int streamLengthHandle
Handle of the page content object.
Definition: plotter.h:923
FILE * workFile
Definition: plotter.h:925
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:920
int pageStreamHandle
Handles to the page objects.
Definition: plotter.h:922

References fontResDictHandle, pageStreamHandle, pageTreeHandle, and streamLengthHandle.

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

177  {
178  m_headerExtraLines.Add( aExtraString );
179  }
wxArrayString m_headerExtraLines
Definition: plotter.h:596

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

444 {
445  xrefTable.push_back( 0 );
446  return xrefTable.size() - 1;
447 }
std::vector< long > xrefTable
Temporary file to costruct the stream before zipping.
Definition: plotter.h:926

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

236 {
237  wxASSERT( workFile );
238  if( radius <= 0 )
239  {
240  Circle( centre, width, FILLED_SHAPE, 0 );
241  return;
242  }
243 
244  /* Arcs are not so easily approximated by beziers (in the general case),
245  so we approximate them in the old way */
246  wxPoint start, end;
247  const int delta = 50; // increment (in 0.1 degrees) to draw circles
248 
249  if( StAngle > EndAngle )
250  std::swap( StAngle, EndAngle );
251 
252  SetCurrentLineWidth( width );
253 
254  // Usual trig arc plotting routine...
255  start.x = centre.x + KiROUND( cosdecideg( radius, -StAngle ) );
256  start.y = centre.y + KiROUND( sindecideg( radius, -StAngle ) );
257  DPOINT pos_dev = userToDeviceCoordinates( start );
258  fprintf( workFile, "%g %g m ", pos_dev.x, pos_dev.y );
259  for( int ii = StAngle + delta; ii < EndAngle; ii += delta )
260  {
261  end.x = centre.x + KiROUND( cosdecideg( radius, -ii ) );
262  end.y = centre.y + KiROUND( sindecideg( radius, -ii ) );
263  pos_dev = userToDeviceCoordinates( end );
264  fprintf( workFile, "%g %g l ", pos_dev.x, pos_dev.y );
265  }
266 
267  end.x = centre.x + KiROUND( cosdecideg( radius, -EndAngle ) );
268  end.y = centre.y + KiROUND( sindecideg( radius, -EndAngle ) );
269  pos_dev = userToDeviceCoordinates( end );
270  fprintf( workFile, "%g %g l ", pos_dev.x, pos_dev.y );
271 
272  // The arc is drawn... if not filled we stroke it, otherwise we finish
273  // closing the pie at the center
274  if( fill == NO_FILL )
275  {
276  fputs( "S\n", workFile );
277  }
278  else
279  {
280  pos_dev = userToDeviceCoordinates( centre );
281  fprintf( workFile, "%g %g l b\n", pos_dev.x, pos_dev.y );
282  }
283 }
FILE * workFile
Definition: plotter.h:925
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:98
double cosdecideg(double r, double a)
Circle generation utility: computes r * cos(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:365
double sindecideg(double r, double a)
Circle generation utility: computes r * sin(a) Where a is in decidegrees, not in radians.
Definition: trigo.h:356
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
Circle drawing for PDF.
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.
Definition: PDF_plotter.cpp:95
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

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

◆ BezierCurve()

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

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

Reimplemented in SVG_PLOTTER.

Definition at line 202 of file plotter.cpp.

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

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

178 {
179  wxASSERT( workFile );
180  DPOINT pos_dev = userToDeviceCoordinates( pos );
181  double radius = userToDeviceSize( diametre / 2.0 );
182 
183  /* OK. Here's a trick. PDF doesn't support circles or circular angles, that's
184  a fact. You'll have to do with cubic beziers. These *can't* represent
185  circular arcs (NURBS can, beziers don't). But there is a widely known
186  approximation which is really good
187  */
188 
189  SetCurrentLineWidth( width );
190 
191  // If diameter is less than width, switch to filled mode
192  if( aFill == NO_FILL && diametre < width )
193  {
194  aFill = FILLED_SHAPE;
195  SetCurrentLineWidth( 0 );
196 
197  radius = userToDeviceSize( ( diametre / 2.0 ) + ( width / 2.0 ) );
198  }
199 
200  double magic = radius * 0.551784; // You don't want to know where this come from
201 
202  // This is the convex hull for the bezier approximated circle
203  fprintf( workFile, "%g %g m "
204  "%g %g %g %g %g %g c "
205  "%g %g %g %g %g %g c "
206  "%g %g %g %g %g %g c "
207  "%g %g %g %g %g %g c %c\n",
208  pos_dev.x - radius, pos_dev.y,
209 
210  pos_dev.x - radius, pos_dev.y + magic,
211  pos_dev.x - magic, pos_dev.y + radius,
212  pos_dev.x, pos_dev.y + radius,
213 
214  pos_dev.x + magic, pos_dev.y + radius,
215  pos_dev.x + radius, pos_dev.y + magic,
216  pos_dev.x + radius, pos_dev.y,
217 
218  pos_dev.x + radius, pos_dev.y - magic,
219  pos_dev.x + magic, pos_dev.y - radius,
220  pos_dev.x, pos_dev.y - radius,
221 
222  pos_dev.x - magic, pos_dev.y - radius,
223  pos_dev.x - radius, pos_dev.y - magic,
224  pos_dev.x - radius, pos_dev.y,
225 
226  aFill == NO_FILL ? 's' : 'b' );
227 }
FILE * workFile
Definition: plotter.h:925
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:123
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:98
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.
Definition: PDF_plotter.cpp:95

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

186  {
187  m_headerExtraLines.Clear();
188  }
wxArrayString m_headerExtraLines
Definition: plotter.h:596

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

598 {
599  wxASSERT( workFile );
600 
601  // Close the page stream (and compress it)
602  closePdfStream();
603 
604  // Emit the page object and put it in the page list for later
605  pageHandles.push_back( startPdfObject() );
606 
607  /* Page size is in 1/72 of inch (default user space units)
608  Works like the bbox in postscript but there is no need for
609  swapping the sizes, since PDF doesn't require a portrait page.
610  We use the MediaBox but PDF has lots of other less used boxes
611  to use */
612 
613  const double BIGPTsPERMIL = 0.072;
614  wxSize psPaperSize = pageInfo.GetSizeMils();
615 
616  fprintf( outputFile,
617  "<<\n"
618  "/Type /Page\n"
619  "/Parent %d 0 R\n"
620  "/Resources <<\n"
621  " /ProcSet [/PDF /Text /ImageC /ImageB]\n"
622  " /Font %d 0 R >>\n"
623  "/MediaBox [0 0 %d %d]\n"
624  "/Contents %d 0 R\n"
625  ">>\n",
628  int( ceil( psPaperSize.x * BIGPTsPERMIL ) ),
629  int( ceil( psPaperSize.y * BIGPTsPERMIL ) ),
631  closePdfObject();
632 
633  // Mark the page stream as idle
634  pageStreamHandle = 0;
635 }
void closePdfStream()
Finish the current PDF stream (writes the deferred length, too)
int pageTreeHandle
Definition: plotter.h:919
std::vector< int > pageHandles
Font resource dictionary.
Definition: plotter.h:921
PAGE_INFO pageInfo
Definition: plotter.h:592
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:142
FILE * workFile
Definition: plotter.h:925
void closePdfObject()
Close the current PDF object.
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:920
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:578
int pageStreamHandle
Handles to the page objects.
Definition: plotter.h:922

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

472 {
473  wxASSERT( outputFile );
474  wxASSERT( !workFile );
475  fputs( "endobj\n", outputFile );
476 }
FILE * workFile
Definition: plotter.h:925
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:578

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

510 {
511  wxASSERT( workFile );
512 
513  long stream_len = ftell( workFile );
514 
515  if( stream_len < 0 )
516  {
517  wxASSERT( false );
518  return;
519  }
520 
521  // Rewind the file, read in the page stream and DEFLATE it
522  fseek( workFile, 0, SEEK_SET );
523  unsigned char *inbuf = new unsigned char[stream_len];
524 
525  int rc = fread( inbuf, 1, stream_len, workFile );
526  wxASSERT( rc == stream_len );
527  (void) rc;
528 
529  // We are done with the temporary file, junk it
530  fclose( workFile );
531  workFile = 0;
532  ::wxRemoveFile( workFilename );
533 
534  // NULL means memos owns the memory, but provide a hint on optimum size needed.
535  wxMemoryOutputStream memos( NULL, std::max( 2000l, stream_len ) ) ;
536 
537  {
538  /* Somewhat standard parameters to compress in DEFLATE. The PDF spec is
539  * misleading, it says it wants a DEFLATE stream but it really want a ZLIB
540  * stream! (a DEFLATE stream would be generated with -15 instead of 15)
541  * rc = deflateInit2( &zstrm, Z_BEST_COMPRESSION, Z_DEFLATED, 15,
542  * 8, Z_DEFAULT_STRATEGY );
543  */
544 
545  wxZlibOutputStream zos( memos, wxZ_BEST_COMPRESSION, wxZLIB_ZLIB );
546 
547  zos.Write( inbuf, stream_len );
548 
549  delete[] inbuf;
550 
551  } // flush the zip stream using zos destructor
552 
553  wxStreamBuffer* sb = memos.GetOutputStreamBuffer();
554 
555  unsigned out_count = sb->Tell();
556 
557  fwrite( sb->GetBufferStart(), 1, out_count, outputFile );
558 
559  fputs( "endstream\n", outputFile );
560  closePdfObject();
561 
562  // Writing the deferred length as an indirect object
564  fprintf( outputFile, "%u\n", out_count );
565  closePdfObject();
566 }
wxString workFilename
Handle to the deferred stream length.
Definition: plotter.h:924
int streamLengthHandle
Handle of the page content object.
Definition: plotter.h:923
int startPdfObject(int handle=-1)
Open a new PDF object and returns the handle if the parameter is -1.
FILE * workFile
Definition: plotter.h:925
void closePdfObject()
Close the current PDF object.
#define max(a, b)
Definition: auxiliary.h:86
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:578

References closePdfObject(), max, 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 434 of file PS_plotter.cpp.

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

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

Referenced by PS_PLOTTER::Text(), and 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 124 of file PDF_plotter.cpp.

125 {
126  wxASSERT( workFile );
127  fprintf( workFile, "%g %g %g rg %g %g %g RG\n",
128  r, g, b, r, g, b );
129 }
FILE * workFile
Definition: plotter.h:925

References workFile.

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

478 {}

Referenced by SCH_COMPONENT::Plot(), PlotSilkScreen(), and PlotStandardLayer().

◆ EndPlot()

bool PDF_PLOTTER::EndPlot ( )
overridevirtual

Implements PLOTTER.

Definition at line 671 of file PDF_plotter.cpp.

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

References ClosePage(), closePdfObject(), PLOTTER::creator, PLOTTER::filename, fontResDictHandle, i, PLOTTER::outputFile, pageHandles, pageTreeHandle, startPdfObject(), PLOTTER::title, TO_UTF8, 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 115 of file PS_plotter.cpp.

117 {
118  if( aTraceMode == FILLED )
119  Circle( aPadPos, aDiameter, FILLED_SHAPE, 0 );
120  else // Plot a ring:
121  {
123  int linewidth = GetCurrentLineWidth();
124 
125  // avoid aDiameter <= 1 )
126  if( linewidth > aDiameter-2 )
127  linewidth = aDiameter-2;
128 
129  Circle( aPadPos, aDiameter - linewidth, NO_FILL, linewidth );
130  }
131 
133 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:152
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:102
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 221 of file PS_plotter.cpp.

224 {
225  wxSize size( aSize );
226 
227  if( aTraceMode == FILLED )
228  SetCurrentLineWidth( 0 );
229  else
230  {
232  size.x -= GetCurrentLineWidth();
233  size.y -= GetCurrentLineWidth();
234  }
235 
236 
237  std::vector< wxPoint > cornerList;
238 
239  for( int cnt = 0; cnt < aPolygons->OutlineCount(); ++cnt )
240  {
241  SHAPE_LINE_CHAIN& poly = aPolygons->Outline( cnt );
242  cornerList.clear();
243 
244  for( int ii = 0; ii < poly.PointCount(); ++ii )
245  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
246 
247  // Close polygon
248  cornerList.push_back( cornerList[0] );
249 
250  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
252  }
253 }
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:152
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:102
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
Class 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 85 of file PS_plotter.cpp.

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

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

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

138 {
139  static std::vector< wxPoint > cornerList;
140  wxSize size( aSize );
141  cornerList.clear();
142 
143  if( aTraceMode == FILLED )
144  SetCurrentLineWidth( 0 );
145  else
147 
148  size.x -= GetCurrentLineWidth();
149  size.y -= GetCurrentLineWidth();
150 
151  if( size.x < 1 )
152  size.x = 1;
153 
154  if( size.y < 1 )
155  size.y = 1;
156 
157  int dx = size.x / 2;
158  int dy = size.y / 2;
159 
160  wxPoint corner;
161  corner.x = aPadPos.x - dx;
162  corner.y = aPadPos.y + dy;
163  cornerList.push_back( corner );
164  corner.x = aPadPos.x - dx;
165  corner.y = aPadPos.y - dy;
166  cornerList.push_back( corner );
167  corner.x = aPadPos.x + dx;
168  corner.y = aPadPos.y - dy;
169  cornerList.push_back( corner );
170  corner.x = aPadPos.x + dx;
171  corner.y = aPadPos.y + dy,
172  cornerList.push_back( corner );
173 
174  for( unsigned ii = 0; ii < cornerList.size(); ii++ )
175  {
176  RotatePoint( &cornerList[ii], aPadPos, aPadOrient );
177  }
178 
179  cornerList.push_back( cornerList[0] );
180 
181  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
183 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:206
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:152
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:102
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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

◆ FlashPadRoundRect()

void PSLIKE_PLOTTER::FlashPadRoundRect ( const wxPoint &  aPadPos,
const wxSize &  aSize,
int  aCornerRadius,
double  aOrient,
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 185 of file PS_plotter.cpp.

188 {
189  wxSize size( aSize );
190 
191  if( aTraceMode == FILLED )
192  SetCurrentLineWidth( 0 );
193  else
194  {
196  size.x -= GetCurrentLineWidth();
197  size.y -= GetCurrentLineWidth();
198  aCornerRadius -= GetCurrentLineWidth()/2;
199  }
200 
201 
202  SHAPE_POLY_SET outline;
203  TransformRoundChamferedRectToPolygon( outline, aPadPos, size, aOrient,
204  aCornerRadius, 0.0, 0, GetPlotterArcHighDef() );
205 
206  std::vector< wxPoint > cornerList;
207  // TransformRoundRectToPolygon creates only one convex polygon
208  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
209  cornerList.reserve( poly.PointCount() );
210 
211  for( int ii = 0; ii < poly.PointCount(); ++ii )
212  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
213 
214  // Close polygon
215  cornerList.push_back( cornerList[0] );
216 
217  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
219 }
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aApproxErrorMax, int aMinSegPerCircleCount)
convert a rectangle with rounded corners and/or chamfered corners to a polygon Convert rounded corner...
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_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:152
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:102
Class SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
Class SHAPE_LINE_CHAIN.
int GetPlotterArcHighDef() const
Definition: plotter.h:220
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 255 of file PS_plotter.cpp.

257 {
258  static std::vector< wxPoint > cornerList;
259  cornerList.clear();
260 
261  for( int ii = 0; ii < 4; ii++ )
262  cornerList.push_back( aCorners[ii] );
263 
264  if( aTraceMode == FILLED )
265  {
266  SetCurrentLineWidth( 0 );
267  }
268  else
269  {
271  int w = GetCurrentLineWidth();
272  // offset polygon by w
273  // coord[0] is assumed the lower left
274  // coord[1] is assumed the upper left
275  // coord[2] is assumed the upper right
276  // coord[3] is assumed the lower right
277 
278  /* Trace the outline. */
279  cornerList[0].x += w;
280  cornerList[0].y -= w;
281  cornerList[1].x += w;
282  cornerList[1].y += w;
283  cornerList[2].x -= w;
284  cornerList[2].y += w;
285  cornerList[3].x -= w;
286  cornerList[3].y -= w;
287  }
288 
289  for( int ii = 0; ii < 4; ii++ )
290  {
291  RotatePoint( &cornerList[ii], aPadOrient );
292  cornerList[ii] += aPadPos;
293  }
294 
295  cornerList.push_back( cornerList[0] );
296  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
298 }
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:206
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:152
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:102
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 301 of file PS_plotter.cpp.

304 {
305  // Do nothing
306  wxASSERT( 0 );
307 }

◆ fputsPostscriptString()

void PSLIKE_PLOTTER::fputsPostscriptString ( FILE *  fout,
const wxString &  txt 
)
protectedinherited

Write on a stream a string escaped for postscript/PDF.

Definition at line 313 of file PS_plotter.cpp.

314 {
315  putc( '(', fout );
316  for( unsigned i = 0; i < txt.length(); i++ )
317  {
318  // Lazyness made me use stdio buffering yet another time...
319  wchar_t ch = txt[i];
320 
321  if( ch < 256 )
322  {
323  switch (ch)
324  {
325  // The ~ shouldn't reach the outside
326  case '~':
327  break;
328  // These characters must be escaped
329  case '(':
330  case ')':
331  case '\\':
332  putc( '\\', fout );
333 
334  // FALLTHRU
335  default:
336  putc( ch, fout );
337  break;
338  }
339  }
340  }
341 
342  putc( ')', fout );
343 }
size_t i
Definition: json11.cpp:649

References i.

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

◆ GetColorMode()

bool PLOTTER::GetColorMode ( ) const
inlineinherited

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( ) const
protectedinherited

Definition at line 150 of file plotter.cpp.

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

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

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

856  {
857  return wxString( wxT( "pdf" ) );
858  }

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

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( ) const
protectedinherited

Definition at line 138 of file plotter.cpp.

139 {
141 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:152
#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:123

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

217 { return m_IUsPerDecimil; }
double m_IUsPerDecimil
Definition: plotter.h:563

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotWorkSheet().

◆ GetPlotterArcHighDef()

int PLOTTER::GetPlotterArcHighDef ( ) const
inlineinherited

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 219 of file plotter.h.

219 { return m_IUsPerDecimil * 8; }
double m_IUsPerDecimil
Definition: plotter.h:563

References PLOTTER::m_IUsPerDecimil.

◆ GetPlotterType()

virtual PlotFormat 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 850 of file plotter.h.

851  {
852  return PLOT_FORMAT_PDF;
853  }

References PLOT_FORMAT_PDF.

◆ LineTo()

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

Definition at line 259 of file plotter.h.

260  {
261  PenTo( pos, 'D' );
262  }
virtual void PenTo(const wxPoint &pos, char plume)=0
moveto/lineto primitive, moves the 'pen' to the specified direction

References PLOTTER::PenTo().

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

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

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

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

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

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

Referenced by PLOTTER::Marker().

◆ markerCircle()

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

Plot a circle centered on the position.

Building block for markers

Definition at line 272 of file plotter.cpp.

273 {
274  Circle( position, radius * 2, NO_FILL, GetCurrentLineWidth() );
275 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:152
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 302 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerLozenge()

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

Plot a lozenge centered on the position.

Building block for markers

Definition at line 278 of file plotter.cpp.

279 {
280  std::vector< wxPoint > corner_list;
281  wxPoint corner;
282  corner.x = position.x;
283  corner.y = position.y + radius;
284  corner_list.push_back( corner );
285  corner.x = position.x + radius;
286  corner.y = position.y,
287  corner_list.push_back( corner );
288  corner.x = position.x;
289  corner.y = position.y - radius;
290  corner_list.push_back( corner );
291  corner.x = position.x - radius;
292  corner.y = position.y;
293  corner_list.push_back( corner );
294  corner.x = position.x;
295  corner.y = position.y + radius;
296  corner_list.push_back( corner );
297 
298  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
299 }
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:152

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

Referenced by PLOTTER::Marker().

◆ markerSlash()

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

Plot a / bar centered on the position.

Building block for markers

Definition at line 309 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerSquare()

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

Plot a square centered on the position.

Building block for markers

Definition at line 247 of file plotter.cpp.

248 {
249  double r = KiROUND( radius / 1.4142 );
250  std::vector< wxPoint > corner_list;
251  wxPoint corner;
252  corner.x = position.x + r;
253  corner.y = position.y + r;
254  corner_list.push_back( corner );
255  corner.x = position.x + r;
256  corner.y = position.y - r;
257  corner_list.push_back( corner );
258  corner.x = position.x - r;
259  corner.y = position.y - r;
260  corner_list.push_back( corner );
261  corner.x = position.x - r;
262  corner.y = position.y + r;
263  corner_list.push_back( corner );
264  corner.x = position.x + r;
265  corner.y = position.y + r;
266  corner_list.push_back( corner );
267 
268  PlotPoly( corner_list, NO_FILL, GetCurrentLineWidth() );
269 }
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:152
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

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

Referenced by PLOTTER::Marker().

◆ markerVBar()

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

Plot a | bar centered on the position.

Building block for markers

Definition at line 323 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ MoveTo()

◆ OpenFile()

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

Open or create the plot file aFullFilename.

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

50 {
51  filename = aFullFilename;
52 
53  wxASSERT( !outputFile );
54 
55  // Open the PDF file in binary mode
56  outputFile = wxFopen( filename, wxT( "wb" ) );
57 
58  if( outputFile == NULL )
59  return false ;
60 
61  return true;
62 }
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:578
wxString filename
Definition: plotter.h:590

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

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ PenFinish()

void PLOTTER::PenFinish ( )
inlineinherited

Definition at line 270 of file plotter.h.

271  {
272  // The point is not important with Z motion
273  PenTo( wxPoint( 0, 0 ), 'Z' );
274  }
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 312 of file PDF_plotter.cpp.

313 {
314  wxASSERT( workFile );
315  if( plume == 'Z' )
316  {
317  if( penState != 'Z' )
318  {
319  fputs( "S\n", workFile );
320  penState = 'Z';
321  penLastpos.x = -1;
322  penLastpos.y = -1;
323  }
324  return;
325  }
326 
327  if( penState != plume || pos != penLastpos )
328  {
329  DPOINT pos_dev = userToDeviceCoordinates( pos );
330  fprintf( workFile, "%g %g %c\n",
331  pos_dev.x, pos_dev.y,
332  ( plume=='D' ) ? 'l' : 'm' );
333  }
334  penState = plume;
335  penLastpos = pos;
336 }
char penState
Current pen state: 'U', 'D' or 'Z' (see PenTo)
Definition: plotter.h:586
wxPoint penLastpos
Last pen positions; set to -1,-1 when the pen is at rest.
Definition: plotter.h:588
FILE * workFile
Definition: plotter.h:925
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:98

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

◆ PlotImage()

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

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

Reimplemented from PLOTTER.

Definition at line 341 of file PDF_plotter.cpp.

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

References PLOTTER::colorMode, KiROUND(), PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), workFile, VECTOR2< T >::x, 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 574 of file plotter.cpp.

576 {
577  std::vector<wxPoint> cornerList;
578  cornerList.reserve( aCornerList.PointCount() );
579 
580  for( int ii = 0; ii < aCornerList.PointCount(); ii++ )
581  cornerList.emplace_back( aCornerList.CPoint( ii ) );
582 
583  if( aCornerList.IsClosed() && cornerList.front() != cornerList.back() )
584  cornerList.emplace_back( aCornerList.CPoint( 0 ) );
585 
586  PlotPoly( cornerList, aFill, aWidth, aData );
587 }
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
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 289 of file PDF_plotter.cpp.

291 {
292  wxASSERT( workFile );
293  if( aCornerList.size() <= 1 )
294  return;
295 
296  SetCurrentLineWidth( aWidth );
297 
298  DPOINT pos = userToDeviceCoordinates( aCornerList[0] );
299  fprintf( workFile, "%g %g m\n", pos.x, pos.y );
300 
301  for( unsigned ii = 1; ii < aCornerList.size(); ii++ )
302  {
303  pos = userToDeviceCoordinates( aCornerList[ii] );
304  fprintf( workFile, "%g %g l\n", pos.x, pos.y );
305  }
306 
307  // Close path and stroke(/fill)
308  fprintf( workFile, "%c\n", aFill == NO_FILL ? 'S' : 'b' );
309 }
FILE * workFile
Definition: plotter.h:925
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:98
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.
Definition: PDF_plotter.cpp:95

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

384 {
385  /* XXX This function is *too* similar to returnPostscriptTextWidth.
386  Consider merging them... */
387  const double *width_table = aBold ? ( aItalic ? hvbo_widths : hvb_widths )
388  : ( aItalic ? hvo_widths : hv_widths );
389  double tally = 0;
390 
391  for( unsigned i = 0; i < aText.length(); i++ )
392  {
393  wchar_t AsciiCode = aText[i];
394  // Skip the negation marks and untabled points
395  if( AsciiCode != '~' && AsciiCode < 256 )
396  {
397  tally += width_table[AsciiCode];
398  }
399  else
400  {
401  if( AsciiCode == '~' )
402  pos_pairs->push_back( KiROUND( aXSize * tally / postscriptTextAscent ) );
403  }
404  }
405 
406  // Special rule: we have to complete the last bar if the ~ aren't matched
407  if( pos_pairs->size() % 2 == 1 )
408  pos_pairs->push_back( KiROUND( aXSize * tally / postscriptTextAscent ) );
409 }
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:769
const double hvbo_widths[256]
Character widths for Helvetica-BoldOblique.
size_t i
Definition: json11.cpp:649
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

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

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

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

162 {
163  wxASSERT( workFile );
164  DPOINT p1_dev = userToDeviceCoordinates( p1 );
165  DPOINT p2_dev = userToDeviceCoordinates( p2 );
166 
167  SetCurrentLineWidth( width );
168  fprintf( workFile, "%g %g %g %g re %c\n", p1_dev.x, p1_dev.y,
169  p2_dev.x - p1_dev.x, p2_dev.y - p1_dev.y,
170  fill == NO_FILL ? 'S' : 'B' );
171 }
FILE * workFile
Definition: plotter.h:925
virtual DPOINT userToDeviceCoordinates(const wxPoint &aCoordinate)
Modifies coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:98
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.
Definition: PDF_plotter.cpp:95

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

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

354 {
355  const double *width_table = aBold ? ( aItalic ? hvbo_widths : hvb_widths )
356  : ( aItalic ? hvo_widths : hv_widths );
357  double tally = 0;
358 
359  for( unsigned i = 0; i < aText.length(); i++ )
360  {
361  wchar_t AsciiCode = aText[i];
362  // Skip the negation marks and untabled points
363  if( AsciiCode != '~' && AsciiCode < 256 )
364  {
365  tally += width_table[AsciiCode];
366  }
367  }
368 
369  // Widths are proportional to height, but height is enlarged by a
370  // scaling factor
371  return KiROUND( aXSize * tally / postscriptTextAscent );
372 }
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:769
const double hvbo_widths[256]
Character widths for Helvetica-BoldOblique.
size_t i
Definition: json11.cpp:649
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References hv_widths, hvb_widths, hvbo_widths, hvo_widths, i, 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 436 of file plotter.cpp.

438 {
439  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
440  wxSize size( end.x - start.x, end.y - start.y );
441  double orient;
442 
443  if( size.y == 0 )
444  orient = 0;
445  else if( size.x == 0 )
446  orient = 900;
447  else
448  orient = -ArcTangente( size.y, size.x );
449 
450  size.x = KiROUND( EuclideanNorm( size ) ) + width;
451  size.y = width;
452 
453  FlashPadOval( center, size, orient, tracemode, NULL );
454 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:123
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:160
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: common.h:114

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

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

60 {
61  if( colorMode )
62  {
63  if( negativeMode )
64  emitSetRGBColor( 1 - color.r, 1 - color.g, 1 - color.b );
65  else
66  emitSetRGBColor( color.r, color.g, color.b );
67  }
68  else
69  {
70  /* B/W Mode - Use BLACK or WHITE for all items
71  * note the 2 colors are used in B&W mode, mainly by Pcbnew to draw
72  * holes in white on pads in black
73  */
74  double k = 1; // White
75  if( color != COLOR4D::WHITE )
76  k = 0;
77  if( negativeMode )
78  emitSetRGBColor( 1 - k, 1 - k, 1 - k );
79  else
80  emitSetRGBColor( k, k, k );
81  }
82 }
int color
Definition: DXF_plotter.cpp:62
bool colorMode
Definition: plotter.h:581
virtual void emitSetRGBColor(double r, double g, double b)=0
Virtual primitive for emitting the setrgbcolor operator.
Definition: colors.h:49
bool negativeMode
true to plot in color, false to plot in black and white
Definition: plotter.h:582

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  width,
void *  aData = NULL 
)
overridevirtual

Pen width setting for PDF.

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

Implements PLOTTER.

Definition at line 95 of file PDF_plotter.cpp.

96 {
97  wxASSERT( workFile );
98  int pen_width;
99 
100  if( width > 0 )
101  pen_width = width;
102  else if( width == 0 )
103  pen_width = 1;
104  else
105  pen_width = defaultPenWidth;
106 
107  if( pen_width != currentPenWidth )
108  fprintf( workFile, "%g w\n",
109  userToDeviceSize( pen_width ) );
110 
111  currentPenWidth = pen_width;
112 }
FILE * workFile
Definition: plotter.h:925
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:123
int currentPenWidth
Definition: plotter.h:584
int defaultPenWidth
true to generate a negative image (PS mode mainly)
Definition: plotter.h:583

References PLOTTER::currentPenWidth, PLOTTER::defaultPenWidth, PLOTTER::userToDeviceSize(), and workFile.

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

◆ SetDash()

void PDF_PLOTTER::SetDash ( int  dashed)
overridevirtual

PDF supports dashed lines.

Implements PLOTTER.

Definition at line 134 of file PDF_plotter.cpp.

135 {
136  wxASSERT( workFile );
137  switch( dashed )
138  {
139  case PLOTDASHTYPE_DASH:
140  fprintf( workFile, "[%d %d] 0 d\n",
141  (int) GetDashMarkLenIU(), (int) GetDashGapLenIU() );
142  break;
143  case PLOTDASHTYPE_DOT:
144  fprintf( workFile, "[%d %d] 0 d\n",
145  (int) GetDotMarkLenIU(), (int) GetDashGapLenIU() );
146  break;
148  fprintf( workFile, "[%d %d %d %d] 0 d\n",
149  (int) GetDashMarkLenIU(), (int) GetDashGapLenIU(),
150  (int) GetDotMarkLenIU(), (int) GetDashGapLenIU() );
151  break;
152  default:
153  fputs( "[] 0 d\n", workFile );
154  }
155 }
double GetDotMarkLenIU() const
Definition: plotter.cpp:138
double GetDashGapLenIU() const
Definition: plotter.cpp:150
FILE * workFile
Definition: plotter.h:925
double GetDashMarkLenIU() const
Definition: plotter.cpp:144

References PLOTTER::GetDashGapLenIU(), PLOTTER::GetDashMarkLenIU(), PLOTTER::GetDotMarkLenIU(), PLOTDASHTYPE_DASH, PLOTDASHTYPE_DASHDOT, PLOTDASHTYPE_DOT, and workFile.

◆ SetDefaultLineWidth()

void PSLIKE_PLOTTER::SetDefaultLineWidth ( int  width)
overridevirtualinherited

Set the default line width.

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

Parameters
widthis specified in IUs

Implements PLOTTER.

Definition at line 52 of file PS_plotter.cpp.

53 {
54  defaultPenWidth = width;
55  currentPenWidth = -1;
56 }
int currentPenWidth
Definition: plotter.h:584
int defaultPenWidth
true to generate a negative image (PS mode mainly)
Definition: plotter.h:583

References PLOTTER::currentPenWidth, and PLOTTER::defaultPenWidth.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), PS_PLOTTER::SetViewport(), SetViewport(), SVG_PLOTTER::SetViewport(), and LIB_EDIT_FRAME::SVG_PlotComponent().

◆ SetGerberCoordinatesFormat()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 457 of file plotter.h.

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

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

444  {
445  // NOP for most plotters
446  }

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 118 of file plotter.h.

119  {
120  negativeMode = aNegative;
121  }
bool negativeMode
true to plot in color, false to plot in black and white
Definition: plotter.h:582

References PLOTTER::negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

void PDF_PLOTTER::SetPageSettings ( const PAGE_INFO aPageSettings)
overridevirtual

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

Reimplemented from PLOTTER.

Definition at line 64 of file PDF_plotter.cpp.

65 {
66  pageInfo = aPageSettings;
67 }
PAGE_INFO pageInfo
Definition: plotter.h:592

References PLOTTER::pageInfo.

◆ SetScaleAdjust()

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

Set the 'fine' scaling for the postscript engine.

Definition at line 710 of file plotter.h.

711  {
712  plotScaleAdjX = scaleX;
713  plotScaleAdjY = scaleY;
714  }
double plotScaleAdjY
Definition: plotter.h:775
double plotScaleAdjX
Fine user scale adjust ( = 1.0 if no correction)
Definition: plotter.h:775

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

Referenced by StartPlotBoard().

◆ SetTextMode()

virtual void PSLIKE_PLOTTER::SetTextMode ( PlotTextMode  mode)
inlineoverridevirtualinherited

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

Reimplemented from PLOTTER.

Definition at line 699 of file plotter.h.

700  {
701  if( mode != PLOTTEXTMODE_DEFAULT )
702  m_textMode = mode;
703  }
PlotTextMode m_textMode
How to draw text.
Definition: plotter.h:778

References PSLIKE_PLOTTER::m_textMode, and PLOTTEXTMODE_DEFAULT.

Referenced by SVG_PLOTTER::SVG_PLOTTER().

◆ SetTitle()

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

Definition at line 166 of file plotter.h.

167  {
168  title = aTitle;
169  }
wxString title
Definition: plotter.h:591

References PLOTTER::title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ SetViewport()

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

Set the plot offset and scaling for the current plot.

Parameters
aOffsetis the plot offset
aIusPerDecimilgives the scaling factor from IUs to device units
aScaleis the user set plot scaling factor (either explicitly or using 'fit to A4')
aMirrorflips the plot in the Y direction (useful for toner transfers or some kind of film)

Implements PLOTTER.

Definition at line 69 of file PDF_plotter.cpp.

71 {
72  m_plotMirror = aMirror;
73  plotOffset = aOffset;
74  plotScale = aScale;
75  m_IUsPerDecimil = aIusPerDecimil;
76 
77  // The CTM is set to 1 user unit per decimil
78  iuPerDeviceUnit = 1.0 / aIusPerDecimil;
79 
80  SetDefaultLineWidth( 100 / iuPerDeviceUnit ); // arbitrary default
81 
82  /* The paper size in this engined is handled page by page
83  Look in the StartPage function */
84 }
double m_IUsPerDecimil
Definition: plotter.h:563
wxPoint plotOffset
Plot offset (in IUs)
Definition: plotter.h:569
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:573
virtual void SetDefaultLineWidth(int width) override
Set the default line width.
Definition: PS_plotter.cpp:52
double plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:557
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:566

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

◆ sketchOval()

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

Definition at line 457 of file plotter.cpp.

458 {
459  SetCurrentLineWidth( width );
460  width = currentPenWidth;
461  int radius, deltaxy, cx, cy;
462  wxSize size( aSize );
463 
464  if( size.x > size.y )
465  {
466  std::swap( size.x, size.y );
467  orient = AddAngles( orient, 900 );
468  }
469 
470  deltaxy = size.y - size.x; /* distance between centers of the oval */
471  radius = ( size.x - width ) / 2;
472  cx = -radius;
473  cy = -deltaxy / 2;
474  RotatePoint( &cx, &cy, orient );
475  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
476  cx = -radius;
477  cy = deltaxy / 2;
478  RotatePoint( &cx, &cy, orient );
479  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
480 
481  cx = radius;
482  cy = -deltaxy / 2;
483  RotatePoint( &cx, &cy, orient );
484  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
485  cx = radius;
486  cy = deltaxy / 2;
487  RotatePoint( &cx, &cy, orient );
488  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
489 
490  cx = 0;
491  cy = deltaxy / 2;
492  RotatePoint( &cx, &cy, orient );
493  Arc( wxPoint( cx + pos.x, cy + pos.y ),
494  orient + 1800, orient + 3600,
495  radius, NO_FILL );
496  cx = 0;
497  cy = -deltaxy / 2;
498  RotatePoint( &cx, &cy, orient );
499  Arc( wxPoint( cx + pos.x, cy + pos.y ),
500  orient, orient + 1800,
501  radius, NO_FILL );
502 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:264
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:206
T AddAngles(T a1, T2 a2)
Add two angles (keeping the result normalized). T2 is here.
Definition: trigo.h:299
void MoveTo(const wxPoint &pos)
Definition: plotter.h:254
int currentPenWidth
Definition: plotter.h:584
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:156
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(), and PLOTTER::SetCurrentLineWidth().

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

469 {}

Referenced by SCH_COMPONENT::Plot(), PlotSilkScreen(), and PlotStandardLayer().

◆ StartPage()

void PDF_PLOTTER::StartPage ( )
virtual

Starts a new page in the PDF document.

Definition at line 571 of file PDF_plotter.cpp.

572 {
573  wxASSERT( outputFile );
574  wxASSERT( !workFile );
575 
576  // Compute the paper size in IUs
578  paperSize.x *= 10.0 / iuPerDeviceUnit;
579  paperSize.y *= 10.0 / iuPerDeviceUnit;
580 
581  // Open the content stream; the page object will go later
583 
584  /* Now, until ClosePage *everything* must be wrote in workFile, to be
585  compressed later in closePdfStream */
586 
587  // Default graphic settings (coordinate system, default color and line style)
588  fprintf( workFile,
589  "%g 0 0 %g 0 0 cm 1 J 1 j 0 0 0 rg 0 0 0 RG %g w\n",
590  0.0072 * plotScaleAdjX, 0.0072 * plotScaleAdjY,
592 }
PAGE_INFO pageInfo
Definition: plotter.h:592
double plotScaleAdjY
Definition: plotter.h:775
int startPdfStream(int handle=-1)
Starts a PDF stream (for the page).
const wxSize & GetSizeMils() const
Definition: page_info.h:142
FILE * workFile
Definition: plotter.h:925
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:123
int defaultPenWidth
true to generate a negative image (PS mode mainly)
Definition: plotter.h:583
double plotScaleAdjX
Fine user scale adjust ( = 1.0 if no correction)
Definition: plotter.h:775
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:578
double iuPerDeviceUnit
Device scale (from IUs to plotter device units - usually decimils)
Definition: plotter.h:566
int pageStreamHandle
Handles to the page objects.
Definition: plotter.h:922
wxSize paperSize
Paper size in IU - not in mils.
Definition: plotter.h:594

References PLOTTER::defaultPenWidth, PAGE_INFO::GetSizeMils(), PLOTTER::iuPerDeviceUnit, 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 454 of file PDF_plotter.cpp.

455 {
456  wxASSERT( outputFile );
457  wxASSERT( !workFile );
458 
459  if( handle < 0)
460  handle = allocPdfObject();
461 
462  xrefTable[handle] = ftell( outputFile );
463  fprintf( outputFile, "%d 0 obj\n", handle );
464  return handle;
465 }
FILE * workFile
Definition: plotter.h:925
std::vector< long > xrefTable
Temporary file to costruct the stream before zipping.
Definition: plotter.h:926
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:578
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 485 of file PDF_plotter.cpp.

486 {
487  wxASSERT( outputFile );
488  wxASSERT( !workFile );
489  handle = startPdfObject( handle );
490 
491  // This is guaranteed to be handle+1 but needs to be allocated since
492  // you could allocate more object during stream preparation
494  fprintf( outputFile,
495  "<< /Length %d 0 R /Filter /FlateDecode >>\n" // Length is deferred
496  "stream\n", handle + 1 );
497 
498  // Open a temporary file to accumulate the stream
499  workFilename = filename + wxT(".tmp");
500  workFile = wxFopen( workFilename, wxT( "w+b" ));
501  wxASSERT( workFile );
502  return handle;
503 }
wxString workFilename
Handle to the deferred stream length.
Definition: plotter.h:924
int streamLengthHandle
Handle of the page content object.
Definition: plotter.h:923
int startPdfObject(int handle=-1)
Open a new PDF object and returns the handle if the parameter is -1.
FILE * workFile
Definition: plotter.h:925
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:578
wxString filename
Definition: plotter.h:590
int allocPdfObject()
Allocate a new handle in the table of the PDF object.

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

643 {
644  wxASSERT( outputFile );
645 
646  // First things first: the customary null object
647  xrefTable.clear();
648  xrefTable.push_back( 0 );
649 
650  /* The header (that's easy!). The second line is binary junk required
651  to make the file binary from the beginning (the important thing is
652  that they must have the bit 7 set) */
653  fputs( "%PDF-1.5\n%\200\201\202\203\n", outputFile );
654 
655  /* Allocate an entry for the page tree root, it will go in every page
656  parent entry */
658 
659  /* In the same way, the font resource dictionary is used by every page
660  (it *could* be inherited via the Pages tree */
662 
663  /* Now, the PDF is read from the end, (more or less)... so we start
664  with the page stream for page 1. Other more important stuff is written
665  at the end */
666  StartPage();
667  return true;
668 }
virtual void StartPage()
Starts a new page in the PDF document.
int pageTreeHandle
Definition: plotter.h:919
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:920
std::vector< long > xrefTable
Temporary file to costruct the stream before zipping.
Definition: plotter.h:926
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:578
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  aWidth,
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)
aWidth= line width (pen width) (default = 0) if width < 0 : draw segments in sketch mode, width = abs(width) Use a value min(aSize.x, aSize.y) / 5 for a bold text
aItalic= true to simulate an italic font
aBold= true to use a bold font Useful only with default width value (aWidth = 0)
aMultilineAllowed= true to plot text as multiline, otherwise single line
aData= a parameter used by some plotters in SetCurrentLineWidth(), not directly used here.

Reimplemented from PLOTTER.

Definition at line 808 of file PDF_plotter.cpp.

820 {
821  // PDF files do not like 0 sized texts which create broken files.
822  if( aSize.x == 0 || aSize.y == 0 )
823  return;
824 
825  // Fix me: see how to use PDF text mode for multiline texts
826  if( aMultilineAllowed && !aText.Contains( wxT( "\n" ) ) )
827  aMultilineAllowed = false; // the text has only one line.
828 
829  // Emit native PDF text (if requested)
830  // Currently: is not supported, because only our stroke font is alloxed: disable it
831  // However, shadowed texts (searchable texts) works reasonably well because
832  // pixel accurate precision is not requested, so we add searchable texts
833  // behind our stroked font texts
834  bool use_native_font = false;
835  // render_mode 0 shows the text, render_mode 3 is invisible
836  int render_mode = use_native_font ? 0 : 3;
837 
838  const char *fontname = aItalic ? (aBold ? "/KicadFontBI" : "/KicadFontI")
839  : (aBold ? "/KicadFontB" : "/KicadFont");
840 
841  // Compute the copious transformation parameters of the Curent Transform Matrix
842  double ctm_a, ctm_b, ctm_c, ctm_d, ctm_e, ctm_f;
843  double wideningFactor, heightFactor;
844 
845  computeTextParameters( aPos, aText, aOrient, aSize, m_plotMirror, aH_justify,
846  aV_justify, aWidth, aItalic, aBold,
847  &wideningFactor, &ctm_a, &ctm_b, &ctm_c,
848  &ctm_d, &ctm_e, &ctm_f, &heightFactor );
849 
850  SetColor( aColor );
851  SetCurrentLineWidth( aWidth, aData );
852 
853  /* We use the full CTM instead of the text matrix because the same
854  coordinate system will be used for the overlining. Also the %f
855  for the trig part of the matrix to avoid %g going in exponential
856  format (which is not supported)
857  render_mode 0 shows the text, render_mode 3 is invisible */
858  fprintf( workFile, "q %f %f %f %f %g %g cm BT %s %g Tf %d Tr %g Tz ",
859  ctm_a, ctm_b, ctm_c, ctm_d, ctm_e, ctm_f,
860  fontname, heightFactor, render_mode,
861  wideningFactor * 100 );
862 
863  // The text must be escaped correctly
865  fputs( " Tj ET\n", workFile );
866 
867  // We are in text coordinates, plot the overbars, if we're not doing phantom text
868  if( use_native_font )
869  {
870  std::vector<int> pos_pairs;
871  postscriptOverlinePositions( aText, aSize.x, aItalic, aBold, &pos_pairs );
872  int overbar_y = KiROUND( aSize.y * 1.1 );
873  for( unsigned i = 0; i < pos_pairs.size(); i += 2)
874  {
875  /* This is a nontrivial situation: we are *not* in the user
876  coordinate system, so the userToDeviceCoordinates function
877  can't be used! Strange as it may seem, the userToDeviceSize
878  is the right function to use here... */
879  DPOINT dev_from = userToDeviceSize( wxSize( pos_pairs[i], overbar_y ) );
880  DPOINT dev_to = userToDeviceSize( wxSize( pos_pairs[i + 1], overbar_y ) );
881  fprintf( workFile, "%g %g m %g %g l ",
882  dev_from.x, dev_from.y, dev_to.x, dev_to.y );
883  }
884  }
885 
886  // Stroke and restore the CTM
887  fputs( "S Q\n", workFile );
888 
889  // Plot the stroked text (if requested)
890  if( !use_native_font )
891  {
892  PLOTTER::Text( aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify,
893  aWidth, aItalic, aBold, aMultilineAllowed );
894  }
895 }
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:215
bool m_plotMirror
X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG)
Definition: plotter.h:573
virtual void SetColor(COLOR4D color) override
The SetColor implementation is split with the subclasses: The PSLIKE computes the rgb values,...
Definition: PS_plotter.cpp:59
FILE * workFile
Definition: plotter.h:925
virtual DPOINT userToDeviceSize(const wxSize &size)
Modifies size according to the plotter scale factors (wxSize version, returns a DPOINT)
Definition: plotter.cpp:123
void fputsPostscriptString(FILE *fout, const wxString &txt)
Write on a stream a string escaped for postscript/PDF.
Definition: PS_plotter.cpp:313
size_t i
Definition: json11.cpp:649
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.
Definition: PS_plotter.cpp:381
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:434
virtual void SetCurrentLineWidth(int width, void *aData=NULL) override
Pen width setting for PDF.
Definition: PDF_plotter.cpp:95
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References PSLIKE_PLOTTER::computeTextParameters(), PSLIKE_PLOTTER::fputsPostscriptString(), i, KiROUND(), PLOTTER::m_plotMirror, PSLIKE_PLOTTER::postscriptOverlinePositions(), PSLIKE_PLOTTER::SetColor(), SetCurrentLineWidth(), PLOTTER::Text(), PLOTTER::userToDeviceSize(), workFile, VECTOR2< T >::x, and VECTOR2< T >::y.

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

524 {
525  if( tracemode == FILLED )
526  Arc( centre, StAngle, EndAngle, radius, NO_FILL, width );
527  else
528  {
529  SetCurrentLineWidth( -1 );
530  Arc( centre, StAngle, EndAngle,
531  radius - ( width - currentPenWidth ) / 2, NO_FILL, -1 );
532  Arc( centre, StAngle, EndAngle,
533  radius + ( width - currentPenWidth ) / 2, NO_FILL, -1 );
534  }
535 }
int currentPenWidth
Definition: plotter.h:584
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:156
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::Plot_1_EdgeModule(), and BRDITEMS_PLOTTER::PlotDrawSegment().

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

562 {
563  if( tracemode == FILLED )
564  Circle( pos, diametre, NO_FILL, width );
565  else
566  {
567  SetCurrentLineWidth( -1 );
568  Circle( pos, diametre - width + currentPenWidth, NO_FILL, -1 );
569  Circle( pos, diametre + width - currentPenWidth, NO_FILL, -1 );
570  }
571 }
int currentPenWidth
Definition: plotter.h:584
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::Plot_1_EdgeModule(), and BRDITEMS_PLOTTER::PlotDrawSegment().

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

540 {
541  if( tracemode == FILLED )
542  Rect( p1, p2, NO_FILL, width );
543  else
544  {
545  SetCurrentLineWidth( -1 );
546  wxPoint offsetp1( p1.x - (width - currentPenWidth) / 2,
547  p1.y - (width - currentPenWidth) / 2 );
548  wxPoint offsetp2( p2.x + (width - currentPenWidth) / 2,
549  p2.y + (width - currentPenWidth) / 2 );
550  Rect( offsetp1, offsetp2, NO_FILL, -1 );
551  offsetp1.x += (width - currentPenWidth);
552  offsetp1.y += (width - currentPenWidth);
553  offsetp2.x -= (width - currentPenWidth);
554  offsetp2.y -= (width - currentPenWidth);
555  Rect( offsetp1, offsetp2, NO_FILL, -1 );
556  }
557 }
int currentPenWidth
Definition: plotter.h:584
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(), and PLOTTER::SetCurrentLineWidth().

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

507 {
508  if( tracemode == FILLED )
509  {
510  SetCurrentLineWidth( width );
511  MoveTo( start );
512  FinishTo( end );
513  }
514  else
515  {
516  SetCurrentLineWidth( -1 );
517  segmentAsOval( start, end, width, tracemode );
518  }
519 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:264
void MoveTo(const wxPoint &pos)
Definition: plotter.h:254
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:436
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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

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

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

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

Referenced by HPGL_PLOTTER::Arc(), PS_PLOTTER::Arc(), Arc(), SVG_PLOTTER::Arc(), GERBER_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(), 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

◆ userToDeviceSize() [2/2]

double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtualinherited

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

Definition at line 130 of file plotter.cpp.

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

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

Member Data Documentation

◆ colorMode

bool PLOTTER::colorMode
protectedinherited

◆ creator

wxString PLOTTER::creator
protectedinherited

◆ currentPenWidth

◆ defaultPenWidth

◆ DO_NOT_SET_LINE_WIDTH

const int PLOTTER::DO_NOT_SET_LINE_WIDTH = -2
staticinherited

◆ filename

wxString PLOTTER::filename
protectedinherited

◆ fontResDictHandle

int PDF_PLOTTER::fontResDictHandle
protected

Handle to the root of the page tree object.

Definition at line 920 of file plotter.h.

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

◆ iuPerDeviceUnit

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

◆ m_IUsPerDecimil

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

◆ m_plotMirror

◆ m_textMode

PlotTextMode PSLIKE_PLOTTER::m_textMode
protectedinherited

How to draw text.

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

Referenced by PLOTTER::Marker().

◆ negativeMode

bool PLOTTER::negativeMode
protectedinherited

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

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

Referenced by HPGL_PLOTTER::Arc(), PS_PLOTTER::Arc(), SVG_PLOTTER::Arc(), GERBER_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(), 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::PlotGerberRegion(), PS_PLOTTER::PlotImage(), SVG_PLOTTER::PlotImage(), HPGL_PLOTTER::PlotPoly(), PS_PLOTTER::PlotPoly(), SVG_PLOTTER::PlotPoly(), GERBER_PLOTTER::PlotPoly(), 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 921 of file plotter.h.

Referenced by ClosePage(), and EndPlot().

◆ pageInfo

◆ pageStreamHandle

int PDF_PLOTTER::pageStreamHandle
protected

Handles to the page objects.

Definition at line 922 of file plotter.h.

Referenced by ClosePage(), PDF_PLOTTER(), and StartPage().

◆ pageTreeHandle

int PDF_PLOTTER::pageTreeHandle
protected

Definition at line 919 of file plotter.h.

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

◆ paperSize

◆ penLastpos

wxPoint PLOTTER::penLastpos
protectedinherited

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

Definition at line 588 of file plotter.h.

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

◆ penState

char PLOTTER::penState
protectedinherited

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

Definition at line 586 of file plotter.h.

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

◆ plotOffset

wxPoint PLOTTER::plotOffset
protectedinherited

◆ plotScale

◆ plotScaleAdjX

double PSLIKE_PLOTTER::plotScaleAdjX
protectedinherited

Fine user scale adjust ( = 1.0 if no correction)

Definition at line 775 of file plotter.h.

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

◆ plotScaleAdjY

double PSLIKE_PLOTTER::plotScaleAdjY
protectedinherited

Definition at line 775 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 769 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 923 of file plotter.h.

Referenced by closePdfStream(), PDF_PLOTTER(), and startPdfStream().

◆ title

wxString PLOTTER::title
protectedinherited

Definition at line 591 of file plotter.h.

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

◆ USE_DEFAULT_LINE_WIDTH

◆ workFile

◆ workFilename

wxString PDF_PLOTTER::workFilename
protected

Handle to the deferred stream length.

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

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


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