KiCad PCB EDA Suite
PDF_PLOTTER Class Reference

#include <plotter.h>

Inheritance diagram for PDF_PLOTTER:
PSLIKE_PLOTTER PLOTTER

Public Member Functions

 PDF_PLOTTER ()
 
virtual PLOT_FORMAT GetPlotterType () const override
 Returns the effective plot engine in use. More...
 
virtual bool OpenFile (const wxString &aFullFilename) override
 Open or create the plot file aFullFilename. More...
 
virtual bool StartPlot () override
 The PDF engine supports multiple pages; the first one is opened 'for free' the following are to be closed and reopened. More...
 
virtual bool EndPlot () override
 
virtual void StartPage ()
 Starts a new page in the PDF document. More...
 
virtual void ClosePage ()
 Close the current page in the PDF document (and emit its compressed stream) More...
 
virtual void SetCurrentLineWidth (int width, void *aData=NULL) override
 Pen width setting for PDF. More...
 
virtual void SetDash (PLOT_DASH_TYPE dashed) override
 PDF supports dashed lines. More...
 
virtual void 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 (PLOT_TEXT_MODE 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
 
PLOT_TEXT_MODE m_textMode
 How to draw text. More...
 
double plotScale
 Plot scale - chosen by the user (even implicitly with 'fit in a4') More...
 
double m_IUsPerDecimil
 
double iuPerDeviceUnit
 Device scale (from IUs to plotter device units - usually decimils) More...
 
wxPoint plotOffset
 Plot offset (in IUs) More...
 
bool m_plotMirror
 X axis orientation (SVG) and plot mirrored (only for PS, PDF HPGL and SVG) More...
 
bool m_mirrorIsHorizontal
 
bool m_yaxisReversed
 true to mirror horizontally (else vertically) More...
 
FILE * outputFile
 true if the Y axis is top to bottom (SVG) More...
 
bool colorMode
 
bool negativeMode
 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 845 of file plotter.h.

Constructor & Destructor Documentation

◆ PDF_PLOTTER()

PDF_PLOTTER::PDF_PLOTTER ( )
inline

Definition at line 848 of file plotter.h.

848  : pageStreamHandle( 0 ), workFile( NULL )
849  {
850  // Avoid non initialized variables:
852  pageTreeHandle = 0;
853  }
int pageTreeHandle
Definition: plotter.h:924
int streamLengthHandle
Handle of the page content object.
Definition: plotter.h:928
#define NULL
FILE * workFile
Definition: plotter.h:930
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:925
int pageStreamHandle
Handles to the page objects.
Definition: plotter.h:927

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

183  {
184  m_headerExtraLines.Add( aExtraString );
185  }
wxArrayString m_headerExtraLines
Definition: plotter.h:602

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

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

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

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

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

◆ BezierCurve()

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

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

Reimplemented in SVG_PLOTTER.

Definition at line 203 of file plotter.cpp.

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

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

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

192  {
193  m_headerExtraLines.Clear();
194  }
wxArrayString m_headerExtraLines
Definition: plotter.h:602

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

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

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

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

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

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

References closePdfObject(), NULL, PLOTTER::outputFile, startPdfObject(), streamLengthHandle, workFile, and workFilename.

Referenced by ClosePage().

◆ computeTextParameters()

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

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

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

Definition at line 435 of file PS_plotter.cpp.

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

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

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

484 {}

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

◆ EndPlot()

bool PDF_PLOTTER::EndPlot ( )
overridevirtual

Implements PLOTTER.

Definition at line 672 of file PDF_plotter.cpp.

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

References ClosePage(), closePdfObject(), PLOTTER::creator, PLOTTER::filename, fontResDictHandle, NULL, 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 116 of file PS_plotter.cpp.

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

225 {
226  wxSize size( aSize );
227 
228  if( aTraceMode == FILLED )
229  SetCurrentLineWidth( 0 );
230  else
231  {
233  size.x -= GetCurrentLineWidth();
234  size.y -= GetCurrentLineWidth();
235  }
236 
237 
238  std::vector< wxPoint > cornerList;
239 
240  for( int cnt = 0; cnt < aPolygons->OutlineCount(); ++cnt )
241  {
242  SHAPE_LINE_CHAIN& poly = aPolygons->Outline( cnt );
243  cornerList.clear();
244 
245  for( int ii = 0; ii < poly.PointCount(); ++ii )
246  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
247 
248  // Close polygon
249  cornerList.push_back( cornerList[0] );
250 
251  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILLED_SHAPE : NO_FILL,
253  }
254 }
int OutlineCount() const
Returns the number of outlines in the set
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
int PointCount() const
Function PointCount()
virtual int GetCurrentLineWidth() const
Definition: plotter.h:158
const VECTOR2I & CPoint(int aIndex) const
Function Point()
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:108
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
SHAPE_LINE_CHAIN.
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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

◆ FlashPadOval()

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

virtual function FlashPadOval

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

Implements PLOTTER.

Definition at line 86 of file PS_plotter.cpp.

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

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

◆ FlashPadRect()

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

virtual function FlashPadRect

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

Implements PLOTTER.

Definition at line 137 of file PS_plotter.cpp.

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

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

◆ FlashPadRoundRect()

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

virtual function FlashPadRoundRect

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

Implements PLOTTER.

Definition at line 186 of file PS_plotter.cpp.

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

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

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

◆ fputsPostscriptString()

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

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

Definition at line 314 of file PS_plotter.cpp.

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

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

◆ GetColorMode()

bool PLOTTER::GetColorMode ( ) const
inlineinherited

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( ) const
protectedinherited

Definition at line 151 of file plotter.cpp.

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

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

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

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( ) const
protectedinherited

Definition at line 145 of file plotter.cpp.

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

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

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

◆ GetDefaultFileExtension()

static wxString PDF_PLOTTER::GetDefaultFileExtension ( )
inlinestatic

Definition at line 860 of file plotter.h.

861  {
862  return wxString( wxT( "pdf" ) );
863  }

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

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( ) const
protectedinherited

Definition at line 139 of file plotter.cpp.

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

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

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

◆ GetIUsPerDecimil()

double PLOTTER::GetIUsPerDecimil ( ) const
inlineinherited

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

Here they can be get back again

Definition at line 223 of file plotter.h.

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

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotWorkSheet().

◆ GetPlotterArcHighDef()

int PLOTTER::GetPlotterArcHighDef ( ) const
inlineinherited

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 225 of file plotter.h.

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

References PLOTTER::m_IUsPerDecimil.

◆ GetPlotterType()

virtual PLOT_FORMAT PDF_PLOTTER::GetPlotterType ( ) const
inlineoverridevirtual

Returns the effective plot engine in use.

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

Implements PLOTTER.

Definition at line 855 of file plotter.h.

856  {
857  return PLOT_FORMAT::PDF;
858  }

References PDF.

◆ LineTo()

void PLOTTER::LineTo ( const wxPoint pos)
inlineinherited

Definition at line 265 of file plotter.h.

266  {
267  PenTo( pos, 'D' );
268  }
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 331 of file plotter.cpp.

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

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

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

◆ markerBackSlash()

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

Plot a \ bar centered on the position.

Building block for markers

Definition at line 317 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerCircle()

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

Plot a circle centered on the position.

Building block for markers

Definition at line 273 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerHBar()

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

Plot a - bar centered on the position.

Building block for markers

Definition at line 303 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerLozenge()

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

Plot a lozenge centered on the position.

Building block for markers

Definition at line 279 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerSlash()

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

Plot a / bar centered on the position.

Building block for markers

Definition at line 310 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerSquare()

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

Plot a square centered on the position.

Building block for markers

Definition at line 248 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerVBar()

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

Plot a | bar centered on the position.

Building block for markers

Definition at line 324 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ MoveTo()

◆ OpenFile()

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

Open or create the plot file aFullFilename.

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

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

Reimplemented from PLOTTER.

Definition at line 50 of file PDF_plotter.cpp.

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

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

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ PenFinish()

void PLOTTER::PenFinish ( )
inlineinherited

Definition at line 276 of file plotter.h.

277  {
278  // The point is not important with Z motion
279  PenTo( wxPoint( 0, 0 ), 'Z' );
280  }
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 313 of file PDF_plotter.cpp.

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

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

◆ PlotImage()

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

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

Reimplemented from PLOTTER.

Definition at line 342 of file PDF_plotter.cpp.

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

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

◆ PlotPoly() [1/2]

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

Function PlotPoly.

Draw a polygon ( filled or not )

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

Definition at line 575 of file plotter.cpp.

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

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

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

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

References hv_widths, hvb_widths, hvbo_widths, hvo_widths, 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 162 of file PDF_plotter.cpp.

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

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

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

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

Referenced by PSLIKE_PLOTTER::computeTextParameters().

◆ segmentAsOval()

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

Cdonvert a thick segment and plot it as an oval.

Definition at line 437 of file plotter.cpp.

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

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

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

◆ SetColor()

void PSLIKE_PLOTTER::SetColor ( COLOR4D  color)
overridevirtualinherited

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

Implements PLOTTER.

Reimplemented in SVG_PLOTTER.

Definition at line 60 of file PS_plotter.cpp.

61 {
62  if( colorMode )
63  {
64  if( negativeMode )
65  emitSetRGBColor( 1 - color.r, 1 - color.g, 1 - color.b );
66  else
67  emitSetRGBColor( color.r, color.g, color.b );
68  }
69  else
70  {
71  /* B/W Mode - Use BLACK or WHITE for all items
72  * note the 2 colors are used in B&W mode, mainly by Pcbnew to draw
73  * holes in white on pads in black
74  */
75  double k = 1; // White
76  if( color != COLOR4D::WHITE )
77  k = 0;
78  if( negativeMode )
79  emitSetRGBColor( 1 - k, 1 - k, 1 - k );
80  else
81  emitSetRGBColor( k, k, k );
82  }
83 }
int color
Definition: DXF_plotter.cpp:61
bool colorMode
Definition: plotter.h:587
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:588

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

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

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

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

◆ SetDash()

void PDF_PLOTTER::SetDash ( PLOT_DASH_TYPE  dashed)
overridevirtual

PDF supports dashed lines.

Implements PLOTTER.

Definition at line 135 of file PDF_plotter.cpp.

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

References DASH, DASHDOT, DOT, PLOTTER::GetDashGapLenIU(), PLOTTER::GetDashMarkLenIU(), PLOTTER::GetDotMarkLenIU(), 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 53 of file PS_plotter.cpp.

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

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

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

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

450  {
451  // NOP for most plotters
452  }

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 124 of file plotter.h.

125  {
126  negativeMode = aNegative;
127  }
bool negativeMode
true to plot in color, false to plot in black and white
Definition: plotter.h:588

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

66 {
67  pageInfo = aPageSettings;
68 }
PAGE_INFO pageInfo
Definition: plotter.h:598

References PLOTTER::pageInfo.

◆ SetScaleAdjust()

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

Set the 'fine' scaling for the postscript engine.

Definition at line 715 of file plotter.h.

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

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

Referenced by StartPlotBoard().

◆ SetTextMode()

virtual void PSLIKE_PLOTTER::SetTextMode ( PLOT_TEXT_MODE  mode)
inlineoverridevirtualinherited

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

Reimplemented from PLOTTER.

Definition at line 704 of file plotter.h.

705  {
706  if( mode != PLOT_TEXT_MODE::DEFAULT )
707  m_textMode = mode;
708  }
PLOT_TEXT_MODE m_textMode
How to draw text.
Definition: plotter.h:783

References DEFAULT, and PSLIKE_PLOTTER::m_textMode.

Referenced by SVG_PLOTTER::SVG_PLOTTER().

◆ SetTitle()

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

Definition at line 172 of file plotter.h.

173  {
174  title = aTitle;
175  }
wxString title
Definition: plotter.h:597

References PLOTTER::title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ SetViewport()

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

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

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

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

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

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

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

◆ StartBlock()

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

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

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

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

Reimplemented in GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 475 of file plotter.h.

475 {}

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

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

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

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

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

644 {
645  wxASSERT( outputFile );
646 
647  // First things first: the customary null object
648  xrefTable.clear();
649  xrefTable.push_back( 0 );
650 
651  /* The header (that's easy!). The second line is binary junk required
652  to make the file binary from the beginning (the important thing is
653  that they must have the bit 7 set) */
654  fputs( "%PDF-1.5\n%\200\201\202\203\n", outputFile );
655 
656  /* Allocate an entry for the page tree root, it will go in every page
657  parent entry */
659 
660  /* In the same way, the font resource dictionary is used by every page
661  (it *could* be inherited via the Pages tree */
663 
664  /* Now, the PDF is read from the end, (more or less)... so we start
665  with the page stream for page 1. Other more important stuff is written
666  at the end */
667  StartPage();
668  return true;
669 }
virtual void StartPage()
Starts a new page in the PDF document.
int pageTreeHandle
Definition: plotter.h:924
int fontResDictHandle
Handle to the root of the page tree object.
Definition: plotter.h:925
std::vector< long > xrefTable
Temporary file to costruct the stream before zipping.
Definition: plotter.h:931
FILE * outputFile
true if the Y axis is top to bottom (SVG)
Definition: plotter.h:584
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 809 of file PDF_plotter.cpp.

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

References PSLIKE_PLOTTER::computeTextParameters(), PSLIKE_PLOTTER::fputsPostscriptString(), 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 523 of file plotter.cpp.

525 {
526  if( tracemode == FILLED )
527  Arc( centre, StAngle, EndAngle, radius, NO_FILL, width );
528  else
529  {
530  SetCurrentLineWidth( -1 );
531  Arc( centre, StAngle, EndAngle,
532  radius - ( width - currentPenWidth ) / 2, NO_FILL, -1 );
533  Arc( centre, StAngle, EndAngle,
534  radius + ( width - currentPenWidth ) / 2, NO_FILL, -1 );
535  }
536 }
int currentPenWidth
Definition: plotter.h:590
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:157
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 561 of file plotter.cpp.

563 {
564  if( tracemode == FILLED )
565  Circle( pos, diametre, NO_FILL, width );
566  else
567  {
568  SetCurrentLineWidth( -1 );
569  Circle( pos, diametre - width + currentPenWidth, NO_FILL, -1 );
570  Circle( pos, diametre + width - currentPenWidth, NO_FILL, -1 );
571  }
572 }
int currentPenWidth
Definition: plotter.h:590
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 539 of file plotter.cpp.

541 {
542  if( tracemode == FILLED )
543  Rect( p1, p2, NO_FILL, width );
544  else
545  {
546  SetCurrentLineWidth( -1 );
547  wxPoint offsetp1( p1.x - (width - currentPenWidth) / 2,
548  p1.y - (width - currentPenWidth) / 2 );
549  wxPoint offsetp2( p2.x + (width - currentPenWidth) / 2,
550  p2.y + (width - currentPenWidth) / 2 );
551  Rect( offsetp1, offsetp2, NO_FILL, -1 );
552  offsetp1.x += (width - currentPenWidth);
553  offsetp1.y += (width - currentPenWidth);
554  offsetp2.x -= (width - currentPenWidth);
555  offsetp2.y -= (width - currentPenWidth);
556  Rect( offsetp1, offsetp2, NO_FILL, -1 );
557  }
558 }
int currentPenWidth
Definition: plotter.h:590
virtual void Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0
virtual void SetCurrentLineWidth(int width, void *aData=NULL)=0
Set the line width for the next drawing.

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

◆ ThickSegment()

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

Reimplemented in DXF_PLOTTER, GERBER_PLOTTER, and HPGL_PLOTTER.

Definition at line 506 of file plotter.cpp.

508 {
509  if( tracemode == FILLED )
510  {
511  SetCurrentLineWidth( width );
512  MoveTo( start );
513  FinishTo( end );
514  }
515  else
516  {
517  SetCurrentLineWidth( -1 );
518  segmentAsOval( start, end, width, tracemode );
519  }
520 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:270
void MoveTo(const wxPoint &pos)
Definition: plotter.h:260
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:437
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 99 of file plotter.cpp.

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

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

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

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

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 925 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

PLOT_TEXT_MODE PSLIKE_PLOTTER::m_textMode
protectedinherited

How to draw text.

Definition at line 783 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 581 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 431 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 588 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 584 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 926 of file plotter.h.

Referenced by ClosePage(), and EndPlot().

◆ pageInfo

◆ pageStreamHandle

int PDF_PLOTTER::pageStreamHandle
protected

Handles to the page objects.

Definition at line 927 of file plotter.h.

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

◆ pageTreeHandle

int PDF_PLOTTER::pageTreeHandle
protected

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

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

◆ plotOffset

◆ plotScale

◆ plotScaleAdjX

double PSLIKE_PLOTTER::plotScaleAdjX
protectedinherited

Fine user scale adjust ( = 1.0 if no correction)

Definition at line 780 of file plotter.h.

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

◆ plotScaleAdjY

double PSLIKE_PLOTTER::plotScaleAdjY
protectedinherited

Definition at line 780 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 774 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 928 of file plotter.h.

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

◆ title

wxString PLOTTER::title
protectedinherited

Definition at line 597 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 929 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 931 of file plotter.h.

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


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