KiCad PCB EDA Suite
PDF_PLOTTER Class Reference

#include <plotters_pslike.h>

Inheritance diagram for PDF_PLOTTER:
PSLIKE_PLOTTER PLOTTER

Public Member Functions

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

Static Public Member Functions

static wxString GetDefaultFileExtension ()
 

Static Public Attributes

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

Protected Member Functions

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

Protected Attributes

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

Static Protected Attributes

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

Detailed Description

Definition at line 234 of file plotters_pslike.h.

Constructor & Destructor Documentation

◆ PDF_PLOTTER()

PDF_PLOTTER::PDF_PLOTTER ( )
inline

Definition at line 237 of file plotters_pslike.h.

237  :
238  pageTreeHandle( 0 ),
239  fontResDictHandle( 0 ),
240  pageStreamHandle( 0 ),
241  streamLengthHandle( 0 ),
242  workFile( nullptr )
243  {
244  }
int streamLengthHandle
Handle of the page content object.
int fontResDictHandle
Handle to the root of the page tree object.
int pageStreamHandle
Handles to the page objects.

Member Function Documentation

◆ AddLineToHeader()

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

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

Parameters
aExtraStringis the string to print

Definition at line 183 of file plotter.h.

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

References PLOTTER::m_headerExtraLines.

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

◆ allocPdfObject()

int PDF_PLOTTER::allocPdfObject ( )
protected

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

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

Definition at line 461 of file PDF_plotter.cpp.

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

References xrefTable.

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

◆ Arc() [1/2]

void PLOTTER::Arc ( const SHAPE_ARC aArc)
virtualinherited

Reimplemented in GERBER_PLOTTER.

Definition at line 157 of file plotter.cpp.

158 {
159  Arc( wxPoint( aArc.GetCenter() ), aArc.GetStartAngle(), aArc.GetEndAngle(), aArc.GetRadius(),
160  FILL_T::NO_FILL, aArc.GetWidth() );
161 }
double GetRadius() const
Definition: shape_arc.cpp:492
double GetStartAngle() const
Definition: shape_arc.cpp:444
double GetEndAngle() const
Definition: shape_arc.cpp:454
int GetWidth() const
Definition: shape_arc.h:156
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:164
VECTOR2I GetCenter() const
Definition: shape_arc.cpp:464

References PLOTTER::Arc(), SHAPE_ARC::GetCenter(), SHAPE_ARC::GetEndAngle(), SHAPE_ARC::GetRadius(), SHAPE_ARC::GetStartAngle(), SHAPE_ARC::GetWidth(), and NO_FILL.

◆ Arc() [2/2]

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

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

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

◆ BezierCurve()

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

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

Reimplemented in SVG_PLOTTER.

Definition at line 211 of file plotter.cpp.

214 {
215  // Generic fallback: Quadratic Bezier curve plotted as a polyline
216  int minSegLen = aLineThickness; // The segment min length to approximate a bezier curve
217 
218  std::vector<wxPoint> ctrlPoints;
219  ctrlPoints.push_back( aStart );
220  ctrlPoints.push_back( aControl1 );
221  ctrlPoints.push_back( aControl2 );
222  ctrlPoints.push_back( aEnd );
223 
224  BEZIER_POLY bezier_converter( ctrlPoints );
225 
226  std::vector<wxPoint> approxPoints;
227  bezier_converter.GetPoly( approxPoints, minSegLen );
228 
229  SetCurrentLineWidth( aLineThickness );
230  MoveTo( aStart );
231 
232  for( unsigned ii = 1; ii < approxPoints.size()-1; ii++ )
233  LineTo( approxPoints[ii] );
234 
235  FinishTo( aEnd );
236 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void LineTo(const wxPoint &pos)
Definition: plotter.h:268
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
Bezier curves to polygon converter.
Definition: bezier_curves.h:36
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.

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

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

◆ Circle()

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

Circle drawing for PDF.

They're approximated by curves, but fill is supported

Implements PLOTTER.

Definition at line 205 of file PDF_plotter.cpp.

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

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

Referenced by Arc().

◆ ClearHeaderLinesList()

void PLOTTER::ClearHeaderLinesList ( )
inlineinherited

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

Definition at line 191 of file plotter.h.

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

References PLOTTER::m_headerExtraLines.

Referenced by StartPlotBoard().

◆ ClosePage()

void PDF_PLOTTER::ClosePage ( )
virtual

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

Definition at line 612 of file PDF_plotter.cpp.

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

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

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

◆ closePdfObject()

void PDF_PLOTTER::closePdfObject ( )
protected

Close the current PDF object.

Definition at line 482 of file PDF_plotter.cpp.

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

References PLOTTER::m_outputFile, and workFile.

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

◆ closePdfStream()

void PDF_PLOTTER::closePdfStream ( )
protected

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

Definition at line 521 of file PDF_plotter.cpp.

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

References closePdfObject(), ADVANCED_CFG::GetCfg(), ignore_unused(), PLOTTER::m_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 437 of file PS_plotter.cpp.

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

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

Referenced by Text().

◆ emitSetRGBColor()

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

PDF supports colors fully.

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

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

Implements PSLIKE_PLOTTER.

Definition at line 162 of file PDF_plotter.cpp.

163 {
164  wxASSERT( workFile );
165  fprintf( workFile, "%g %g %g rg %g %g %g RG\n", r, g, b, r, g, b );
166 }
E_SERIE r
Definition: eserie.cpp:41

References r, and workFile.

◆ encodeStringForPlotter()

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

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

Reimplemented from PSLIKE_PLOTTER.

Definition at line 44 of file PDF_plotter.cpp.

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

References KI_FALLTHROUGH.

Referenced by EndPlot(), and Text().

◆ EndBlock()

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

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

the group is started by StartBlock()

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

Reimplemented in SVG_PLOTTER, and GERBER_PLOTTER.

Definition at line 496 of file plotter.h.

496 {}

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

◆ EndPlot()

bool PDF_PLOTTER::EndPlot ( )
overridevirtual

Implements PLOTTER.

Definition at line 681 of file PDF_plotter.cpp.

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

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

Referenced by DIALOG_PLOT_SCHEMATIC::restoreEnvironment().

◆ FilledCircle()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 607 of file plotter.cpp.

608 {
609  if( tracemode == FILLED )
610  {
611  Circle( pos, diametre, FILL_T::FILLED_SHAPE, 0 );
612  }
613  else
614  {
615  SetCurrentLineWidth( -1 );
616  Circle( pos, diametre, FILL_T::NO_FILL, -1 );
617  }
618 }
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0

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

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

◆ FinishTo()

◆ FlashPadCircle()

void PSLIKE_PLOTTER::FlashPadCircle ( const wxPoint &  aPadPos,
int  aDiameter,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtualinherited
Parameters
aPadPosPosition of the shape (center of the rectangle.
aDiameteris the diameter of round pad.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDatais an auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 120 of file PS_plotter.cpp.

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

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

◆ FlashPadCustom()

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

Implements PLOTTER.

Definition at line 233 of file PS_plotter.cpp.

236 {
237  wxSize size( aSize );
238 
239  if( aTraceMode == FILLED )
240  {
241  SetCurrentLineWidth( 0 );
242  }
243  else
244  {
246  size.x -= GetCurrentLineWidth();
247  size.y -= GetCurrentLineWidth();
248  }
249 
250 
251  std::vector< wxPoint > cornerList;
252 
253  for( int cnt = 0; cnt < aPolygons->OutlineCount(); ++cnt )
254  {
255  SHAPE_LINE_CHAIN& poly = aPolygons->Outline( cnt );
256  cornerList.clear();
257 
258  for( int ii = 0; ii < poly.PointCount(); ++ii )
259  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
260 
261  // Close polygon
262  cornerList.push_back( cornerList[0] );
263 
264  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILL_T::FILLED_SHAPE : FILL_T::NO_FILL,
266  }
267 }
int OutlineCount() const
Return the number of vertices in a given outline/hole.
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
int PointCount() const
Return the number of points (vertices) in this line chain.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
SHAPE_LINE_CHAIN & Outline(int aIndex)
Represent a polyline (an zero-thickness chain of connected line segments).
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.

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

◆ FlashPadOval()

void PSLIKE_PLOTTER::FlashPadOval ( const wxPoint &  aPadPos,
const wxSize &  aSize,
double  aPadOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtualinherited
Parameters
aPadPosPosition of the shape (center of the rectangle.
aSizeis the size of oblong shape.
aPadOrientThe rotation of the shape.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 90 of file PS_plotter.cpp.

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

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

◆ FlashPadRect()

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

Implements PLOTTER.

Definition at line 143 of file PS_plotter.cpp.

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

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

◆ FlashPadRoundRect()

void PSLIKE_PLOTTER::FlashPadRoundRect ( const wxPoint &  aPadPos,
const wxSize &  aSize,
int  aCornerRadius,
double  aOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtualinherited
Parameters
aPadPosPosition of the shape (center of the rectangle.
aSizeis the size of rounded rect.
aCornerRadiusRadius of the rounded corners.
aOrientThe rotation of the shape.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 193 of file PS_plotter.cpp.

196 {
197  wxSize size( aSize );
198 
199  if( aTraceMode == FILLED )
200  {
201  SetCurrentLineWidth( 0 );
202  }
203  else
204  {
206  size.x -= GetCurrentLineWidth();
207  size.y -= GetCurrentLineWidth();
208  aCornerRadius -= GetCurrentLineWidth() / 2;
209  }
210 
211 
212  SHAPE_POLY_SET outline;
213  TransformRoundChamferedRectToPolygon( outline, aPadPos, size, aOrient, aCornerRadius,
214  0.0, 0, 0, GetPlotterArcHighDef(), ERROR_INSIDE );
215 
216  std::vector< wxPoint > cornerList;
217 
218  // TransformRoundRectToPolygon creates only one convex polygon
219  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
220  cornerList.reserve( poly.PointCount() );
221 
222  for( int ii = 0; ii < poly.PointCount(); ++ii )
223  cornerList.emplace_back( poly.CPoint( ii ).x, poly.CPoint( ii ).y );
224 
225  // Close polygon
226  cornerList.push_back( cornerList[0] );
227 
228  PlotPoly( cornerList, ( aTraceMode == FILLED ) ? FILL_T::FILLED_SHAPE : FILL_T::NO_FILL,
230 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
int PointCount() const
Return the number of points (vertices) in this line chain.
void TransformRoundChamferedRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, double aChamferRatio, int aChamferCorners, int aInflate, int aError, ERROR_LOC aErrorLoc)
Convert a rectangle with rounded corners and/or chamfered corners to a polygon.
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:126
Represent a set of closed polygons.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Represent a polyline (an zero-thickness chain of connected line segments).
int GetPlotterArcHighDef() const
Definition: plotter.h:228
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.

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

◆ FlashPadTrapez()

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

Flash a trapezoidal pad.

Parameters
aPadPosis the the position of the shape.
aCornersis the list of 4 corners positions, relative to the shape position, pad orientation 0.
aPadOrientis the rotation of the shape.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 270 of file PS_plotter.cpp.

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

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

◆ FlashRegularPolygon()

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

Flash a regular polygon.

Useful only in Gerber files to flash a regular polygon.

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

Implements PLOTTER.

Definition at line 317 of file PS_plotter.cpp.

319 {
320  // Do nothing
321  wxASSERT( 0 );
322 }

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( ) const
protectedinherited

Definition at line 151 of file plotter.cpp.

152 {
154 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
constexpr double dash_gap_len(double aLineWidth)
virtual DPOINT userToDeviceSize(const wxSize &size)
Modify size according to the plotter scale factors (wxSize version, returns a DPOINT).
Definition: plotter.cpp:123

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 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
virtual DPOINT userToDeviceSize(const wxSize &size)
Modify size according to the plotter scale factors (wxSize version, returns a DPOINT).
Definition: plotter.cpp:123
constexpr double dash_mark_len(double aLineWidth)

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 251 of file plotters_pslike.h.

252  {
253  return wxString( wxT( "pdf" ) );
254  }

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:168
constexpr double dot_mark_len(double aLineWidth)
Dashed and dotted line patterns.
virtual DPOINT userToDeviceSize(const wxSize &size)
Modify size according to the plotter scale factors (wxSize version, returns a DPOINT).
Definition: plotter.cpp:123

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

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

◆ GetIUsPerDecimil()

double PLOTTER::GetIUsPerDecimil ( ) const
inlineinherited

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

Here they can be get back again

Definition at line 225 of file plotter.h.

225 { return m_IUsPerDecimil; }
double m_IUsPerDecimil
Definition: plotter.h:579

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetPlotterArcHighDef()

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 227 of file plotter.h.

227 { return m_IUsPerDecimil * 8; }
double m_IUsPerDecimil
Definition: plotter.h:579

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 246 of file plotters_pslike.h.

247  {
248  return PLOT_FORMAT::PDF;
249  }

References PDF.

◆ LineTo()

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

◆ Marker()

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

Draw a pattern shape number aShapeId, to coord position.

Parameters
aPositionis the position of the marker.
aDiameteris the diameter of the marker.
aShapeIdis the index (used to generate forms characters).

Definition at line 338 of file plotter.cpp.

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

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

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

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

Referenced by PLOTTER::Marker().

◆ markerCircle()

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

Plot a circle centered on the position.

Building block for markers

Definition at line 280 of file plotter.cpp.

281 {
282  Circle( position, radius * 2, FILL_T::NO_FILL, GetCurrentLineWidth() );
283 }
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
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 310 of file plotter.cpp.

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

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

Referenced by PLOTTER::Marker().

◆ markerLozenge()

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

Plot a lozenge centered on the position.

Building block for markers

Definition at line 286 of file plotter.cpp.

287 {
288  std::vector< wxPoint > corner_list;
289  wxPoint corner;
290  corner.x = position.x;
291  corner.y = position.y + radius;
292  corner_list.push_back( corner );
293  corner.x = position.x + radius;
294  corner.y = position.y,
295  corner_list.push_back( corner );
296  corner.x = position.x;
297  corner.y = position.y - radius;
298  corner_list.push_back( corner );
299  corner.x = position.x - radius;
300  corner.y = position.y;
301  corner_list.push_back( corner );
302  corner.x = position.x;
303  corner.y = position.y + radius;
304  corner_list.push_back( corner );
305 
306  PlotPoly( corner_list, FILL_T::NO_FILL, GetCurrentLineWidth() );
307 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168

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

Referenced by PLOTTER::Marker().

◆ markerSlash()

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

Plot a / bar centered on the position.

Building block for markers

Definition at line 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:273
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263

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

Referenced by PLOTTER::Marker().

◆ markerSquare()

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

Plot a square centered on the position.

Building block for markers

Definition at line 255 of file plotter.cpp.

256 {
257  double r = KiROUND( radius / 1.4142 );
258  std::vector< wxPoint > corner_list;
259  wxPoint corner;
260  corner.x = position.x + r;
261  corner.y = position.y + r;
262  corner_list.push_back( corner );
263  corner.x = position.x + r;
264  corner.y = position.y - r;
265  corner_list.push_back( corner );
266  corner.x = position.x - r;
267  corner.y = position.y - r;
268  corner_list.push_back( corner );
269  corner.x = position.x - r;
270  corner.y = position.y + r;
271  corner_list.push_back( corner );
272  corner.x = position.x + r;
273  corner.y = position.y + r;
274  corner_list.push_back( corner );
275 
276  PlotPoly( corner_list, FILL_T::NO_FILL, GetCurrentLineWidth() );
277 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
virtual int GetCurrentLineWidth() const
Definition: plotter.h:168
E_SERIE r
Definition: eserie.cpp:41
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:73

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

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

332 {
333  MoveTo( wxPoint( pos.x, pos.y - radius ) );
334  FinishTo( wxPoint( pos.x, pos.y + radius ) );
335 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263

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

Referenced by PLOTTER::Marker().

◆ MoveTo()

◆ OpenFile()

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

Open or create the plot file aFullFilename.

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

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

Reimplemented from PLOTTER.

Definition at line 109 of file PDF_plotter.cpp.

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

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

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ PageSettings()

PAGE_INFO& PLOTTER::PageSettings ( )
inlineinherited

◆ PenFinish()

void PLOTTER::PenFinish ( )
inlineinherited

Definition at line 279 of file plotter.h.

280  {
281  // The point is not important with Z motion
282  PenTo( wxPoint( 0, 0 ), 'Z' );
283  }
virtual void PenTo(const wxPoint &pos, char plume)=0
Moveto/lineto primitive, moves the 'pen' to the specified direction.

References PLOTTER::PenTo().

Referenced by HPGL_PLOTTER::Circle(), HPGL_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::PlotPoly(), HPGL_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 336 of file PDF_plotter.cpp.

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

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

◆ PlotImage()

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

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

Reimplemented from PLOTTER.

Definition at line 366 of file PDF_plotter.cpp.

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

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

◆ PlotPoly() [1/2]

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

Draw a polygon ( filled or not ).

Parameters
aCornerListis the corners list (a SHAPE_LINE_CHAIN). must be closed (IsClosed() == true) for a polygon. Otherwise this is a polyline.
aFillis the type of fill.
aWidthis the line width.
aDatais an auxiliary info (mainly for gerber format).

Reimplemented in GERBER_PLOTTER.

Definition at line 621 of file plotter.cpp.

622 {
623  std::vector<wxPoint> cornerList;
624  cornerList.reserve( aCornerList.PointCount() );
625 
626  for( int ii = 0; ii < aCornerList.PointCount(); ii++ )
627  cornerList.emplace_back( aCornerList.CPoint( ii ) );
628 
629  if( aCornerList.IsClosed() && cornerList.front() != cornerList.back() )
630  cornerList.emplace_back( aCornerList.CPoint( 0 ) );
631 
632  PlotPoly( cornerList, aFill, aWidth, aData );
633 }
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
Draw a polygon ( filled or not ).
int PointCount() const
Return the number of points (vertices) in this line chain.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
bool IsClosed() const override

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 = nullptr 
)
overridevirtual

Polygon plotting for PDF.

Everything is supported

Implements PLOTTER.

Definition at line 312 of file PDF_plotter.cpp.

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

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

◆ postscriptOverlinePositions()

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

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

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

Definition at line 388 of file PS_plotter.cpp.

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

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

◆ Rect()

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

Rectangles in PDF.

Supported by the native operator.

Implements PLOTTER.

Definition at line 193 of file PDF_plotter.cpp.

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

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

◆ RenderSettings()

◆ returnPostscriptTextWidth()

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

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

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

Definition at line 365 of file PS_plotter.cpp.

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

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

Referenced by PSLIKE_PLOTTER::computeTextParameters().

◆ segmentAsOval()

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

Convert a thick segment and plot it as an oval.

Definition at line 460 of file plotter.cpp.

462 {
463  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
464  wxSize size( end.x - start.x, end.y - start.y );
465  double orient;
466 
467  if( size.y == 0 )
468  orient = 0;
469  else if( size.x == 0 )
470  orient = 900;
471  else
472  orient = -ArcTangente( size.y, size.x );
473 
474  size.x = KiROUND( EuclideanNorm( size ) ) + width;
475  size.y = width;
476 
477  FlashPadOval( center, size, orient, tracemode, nullptr );
478 }
double EuclideanNorm(const wxPoint &vector)
Euclidean norm of a 2D vector.
Definition: trigo.h:146
virtual void FlashPadOval(const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData)=0
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:73
double ArcTangente(int dy, int dx)
Definition: trigo.cpp:183

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

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

◆ SetColor()

void PSLIKE_PLOTTER::SetColor ( const 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 62 of file PS_plotter.cpp.

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

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

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

◆ SetColorMode()

virtual void PLOTTER::SetColorMode ( bool  aColorMode)
inlinevirtualinherited

◆ SetCreator()

◆ SetCurrentLineWidth()

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

Pen width setting for PDF.

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

Implements PLOTTER.

Definition at line 141 of file PDF_plotter.cpp.

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

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

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

◆ SetDash()

void PDF_PLOTTER::SetDash ( PLOT_DASH_TYPE  dashed)
overridevirtual

PDF supports dashed lines.

Implements PLOTTER.

Definition at line 169 of file PDF_plotter.cpp.

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

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

◆ SetGerberCoordinatesFormat()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 470 of file plotter.h.

471  {
472  // NOP for most plotters. Only for Gerber plotter
473  }

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

◆ SetLayerPolarity()

virtual void PLOTTER::SetLayerPolarity ( bool  aPositive)
inlinevirtualinherited

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

(obviously starts a new Gerber layer, too)

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

Reimplemented in GERBER_PLOTTER.

Definition at line 456 of file plotter.h.

457  {
458  // NOP for most plotters
459  }

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 142 of file plotter.h.

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

References PLOTTER::m_negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

◆ SetRenderSettings()

◆ SetScaleAdjust()

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

Set the 'fine' scaling for the postscript engine.

Definition at line 57 of file plotters_pslike.h.

58  {
59  plotScaleAdjX = scaleX;
60  plotScaleAdjY = scaleY;
61  }
double plotScaleAdjX
Fine user scale adjust ( = 1.0 if no correction)

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

Referenced by StartPlotBoard().

◆ SetSvgCoordinatesFormat()

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

Reimplemented in SVG_PLOTTER.

Definition at line 475 of file plotter.h.

476  {
477  // NOP for most plotters. Only for SVG plotter
478  }

Referenced by initializePlotter().

◆ SetTextMode()

virtual void PSLIKE_PLOTTER::SetTextMode ( PLOT_TEXT_MODE  mode)
inlineoverridevirtualinherited

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

Reimplemented from PLOTTER.

Definition at line 48 of file plotters_pslike.h.

49  {
50  if( mode != PLOT_TEXT_MODE::DEFAULT )
51  m_textMode = mode;
52  }
PLOT_TEXT_MODE m_textMode
How to draw text.

References DEFAULT, and PSLIKE_PLOTTER::m_textMode.

Referenced by SVG_PLOTTER::SVG_PLOTTER().

◆ SetTitle()

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

Definition at line 176 of file plotter.h.

176 { m_title = aTitle; }
wxString m_title
Definition: plotter.h:601

References PLOTTER::m_title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ SetViewport()

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

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

Implements PLOTTER.

Definition at line 125 of file PDF_plotter.cpp.

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

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

◆ sketchOval()

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

Definition at line 481 of file plotter.cpp.

482 {
483  SetCurrentLineWidth( width );
484  width = m_currentPenWidth;
485  int radius, deltaxy, cx, cy;
486  wxSize size( aSize );
487 
488  if( size.x > size.y )
489  {
490  std::swap( size.x, size.y );
491  orient = AddAngles( orient, 900 );
492  }
493 
494  deltaxy = size.y - size.x; /* distance between centers of the oval */
495  radius = ( size.x - width ) / 2;
496  cx = -radius;
497  cy = -deltaxy / 2;
498  RotatePoint( &cx, &cy, orient );
499  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
500  cx = -radius;
501  cy = deltaxy / 2;
502  RotatePoint( &cx, &cy, orient );
503  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
504 
505  cx = radius;
506  cy = -deltaxy / 2;
507  RotatePoint( &cx, &cy, orient );
508  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
509  cx = radius;
510  cy = deltaxy / 2;
511  RotatePoint( &cx, &cy, orient );
512  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
513 
514  cx = 0;
515  cy = deltaxy / 2;
516  RotatePoint( &cx, &cy, orient );
517  Arc( wxPoint( cx + pos.x, cy + pos.y ), orient + 1800, orient + 3600, radius, FILL_T::NO_FILL );
518  cx = 0;
519  cy = -deltaxy / 2;
520  RotatePoint( &cx, &cy, orient );
521  Arc( wxPoint( cx + pos.x, cy + pos.y ), orient, orient + 1800, radius, FILL_T::NO_FILL );
522 }
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:229
int m_currentPenWidth
Definition: plotter.h:595
T AddAngles(T a1, T2 a2)
Add two angles (keeping the result normalized). T2 is here.
Definition: trigo.h:341
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
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:164
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.

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

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

Definition at line 487 of file plotter.h.

487 {}

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

◆ StartPage()

void PDF_PLOTTER::StartPage ( )
virtual

Start a new page in the PDF document.

Definition at line 588 of file PDF_plotter.cpp.

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

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

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

◆ startPdfObject()

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

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

Otherwise fill in the xref entry for the passed object

Definition at line 468 of file PDF_plotter.cpp.

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

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

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

◆ startPdfStream()

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

Starts a PDF stream (for the page).

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

Definition at line 490 of file PDF_plotter.cpp.

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

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

Referenced by StartPage().

◆ StartPlot()

bool PDF_PLOTTER::StartPlot ( )
overridevirtual

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

Between each page parameters can be set.

Implements PLOTTER.

Definition at line 653 of file PDF_plotter.cpp.

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

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

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ Text()

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

Draw text with the plotter.

Same as GRText, but plot graphic text instead of draw it.

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

Parameters
aPosis the text position (according to aH_justify, aV_justify).
aColoris the text color.
aTextis the text to draw.
aOrientis the angle in 0.1 degree.
aSizeis the text size (size.x or size.y can be < 0 for mirrored texts).
aH_justifyis the horizontal justification (Left, center, right).
aV_justifyis the vertical justification (bottom, center, top).
aPenWidthis the line width (if = 0, use plot default line width).
aItalicis the true to simulate an italic font.
aBolduse true to use a bold font Useful only with default width value (aWidth = 0).
aMultilineAlloweduse true to plot text as multiline, otherwise single line.
aDatais a parameter used by some plotters in SetCurrentLineWidth(), not directly used here.

Reimplemented from PLOTTER.

Definition at line 819 of file PDF_plotter.cpp.

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

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

◆ ThickArc()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 549 of file plotter.cpp.

551 {
552  if( tracemode == FILLED )
553  {
554  Arc( centre, StAngle, EndAngle, radius, FILL_T::NO_FILL, width );
555  }
556  else
557  {
558  SetCurrentLineWidth( -1 );
559  Arc( centre, StAngle, EndAngle, radius - ( width - m_currentPenWidth ) / 2,
560  FILL_T::NO_FILL, -1 );
561  Arc( centre, StAngle, EndAngle, radius + ( width - m_currentPenWidth ) / 2,
562  FILL_T::NO_FILL, -1 );
563  }
564 }
int m_currentPenWidth
Definition: plotter.h:595
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:164
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.

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

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

◆ ThickCircle()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 591 of file plotter.cpp.

593 {
594  if( tracemode == FILLED )
595  {
596  Circle( pos, diametre, FILL_T::NO_FILL, width );
597  }
598  else
599  {
600  SetCurrentLineWidth( -1 );
601  Circle( pos, diametre - width + m_currentPenWidth, FILL_T::NO_FILL, -1 );
602  Circle( pos, diametre + width - m_currentPenWidth, FILL_T::NO_FILL, -1 );
603  }
604 }
int m_currentPenWidth
Definition: plotter.h:595
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0

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

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

◆ ThickRect()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 567 of file plotter.cpp.

569 {
570  if( tracemode == FILLED )
571  {
572  Rect( p1, p2, FILL_T::NO_FILL, width );
573  }
574  else
575  {
576  SetCurrentLineWidth( -1 );
577  wxPoint offsetp1( p1.x - (width - m_currentPenWidth) / 2,
578  p1.y - (width - m_currentPenWidth) / 2 );
579  wxPoint offsetp2( p2.x + (width - m_currentPenWidth) / 2,
580  p2.y + (width - m_currentPenWidth) / 2 );
581  Rect( offsetp1, offsetp2, FILL_T::NO_FILL, -1 );
582  offsetp1.x += ( width - m_currentPenWidth );
583  offsetp1.y += ( width - m_currentPenWidth );
584  offsetp2.x -= ( width - m_currentPenWidth );
585  offsetp2.y -= ( width - m_currentPenWidth );
586  Rect( offsetp1, offsetp2, FILL_T::NO_FILL, -1 );
587  }
588 }
int m_currentPenWidth
Definition: plotter.h:595
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=nullptr)=0
Set the line width for the next drawing.

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

◆ ThickSegment()

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

Reimplemented in DXF_PLOTTER, HPGL_PLOTTER, and GERBER_PLOTTER.

Definition at line 525 of file plotter.cpp.

527 {
528  if( tracemode == FILLED )
529  {
530  if( start == end )
531  {
532  Circle( start, width, FILL_T::FILLED_SHAPE, 0 );
533  }
534  else
535  {
536  SetCurrentLineWidth( width );
537  MoveTo( start );
538  FinishTo( end );
539  }
540  }
541  else
542  {
543  SetCurrentLineWidth( -1 );
544  segmentAsOval( start, end, width, tracemode );
545  }
546 }
void segmentAsOval(const wxPoint &start, const wxPoint &end, int width, OUTLINE_MODE tracemode)
Convert a thick segment and plot it as an oval.
Definition: plotter.cpp:460
void FinishTo(const wxPoint &pos)
Definition: plotter.h:273
void MoveTo(const wxPoint &pos)
Definition: plotter.h:263
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.
virtual void Circle(const wxPoint &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0

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

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

◆ userToDeviceCoordinates()

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

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

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

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

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

◆ userToDeviceSize() [1/2]

◆ userToDeviceSize() [2/2]

double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtualinherited

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

Definition at line 130 of file plotter.cpp.

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

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

Member Data Documentation

◆ DO_NOT_SET_LINE_WIDTH

◆ fontResDictHandle

int PDF_PLOTTER::fontResDictHandle
protected

Handle to the root of the page tree object.

Definition at line 400 of file plotters_pslike.h.

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

◆ m_colorMode

bool PLOTTER::m_colorMode
protectedinherited

◆ m_creator

wxString PLOTTER::m_creator
protectedinherited

◆ m_currentPenWidth

◆ m_filename

wxString PLOTTER::m_filename
protectedinherited

Definition at line 600 of file plotter.h.

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

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

◆ m_iuPerDeviceUnit

◆ m_IUsPerDecimil

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

◆ m_negativeMode

bool PLOTTER::m_negativeMode
protectedinherited

Definition at line 594 of file plotter.h.

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

◆ m_outputFile

FILE* PLOTTER::m_outputFile
protectedinherited

Output file.

Definition at line 590 of file plotter.h.

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

◆ m_pageInfo

◆ m_paperSize

◆ m_penLastpos

wxPoint PLOTTER::m_penLastpos
protectedinherited

◆ m_penState

char PLOTTER::m_penState
protectedinherited

◆ m_plotMirror

◆ m_plotOffset

◆ m_plotScale

◆ m_renderSettings

◆ m_textMode

PLOT_TEXT_MODE PSLIKE_PLOTTER::m_textMode
protectedinherited

How to draw text.

Definition at line 148 of file plotters_pslike.h.

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

◆ m_title

wxString PLOTTER::m_title
protectedinherited

Definition at line 601 of file plotter.h.

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

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed
protectedinherited

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58
staticinherited

Draw a marker (used for the drill map).

Definition at line 436 of file plotter.h.

Referenced by PLOTTER::Marker().

◆ pageHandles

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

Font resource dictionary.

Definition at line 401 of file plotters_pslike.h.

Referenced by ClosePage(), and EndPlot().

◆ pageStreamHandle

int PDF_PLOTTER::pageStreamHandle
protected

Handles to the page objects.

Definition at line 402 of file plotters_pslike.h.

Referenced by ClosePage(), and StartPage().

◆ pageTreeHandle

int PDF_PLOTTER::pageTreeHandle
protected

Definition at line 399 of file plotters_pslike.h.

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

◆ plotScaleAdjX

double PSLIKE_PLOTTER::plotScaleAdjX
protectedinherited

Fine user scale adjust ( = 1.0 if no correction)

Definition at line 145 of file plotters_pslike.h.

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

◆ plotScaleAdjY

double PSLIKE_PLOTTER::plotScaleAdjY
protectedinherited

◆ postscriptTextAscent

const double PSLIKE_PLOTTER::postscriptTextAscent = 0.718
staticprotectedinherited

Height of the postscript font (from the AFM)

Definition at line 134 of file plotters_pslike.h.

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

◆ streamLengthHandle

int PDF_PLOTTER::streamLengthHandle
protected

Handle of the page content object.

Definition at line 403 of file plotters_pslike.h.

Referenced by closePdfStream(), and startPdfStream().

◆ USE_DEFAULT_LINE_WIDTH

◆ workFile

◆ workFilename

wxString PDF_PLOTTER::workFilename
protected

Handle to the deferred stream length.

Definition at line 404 of file plotters_pslike.h.

Referenced by closePdfStream(), and startPdfStream().

◆ xrefTable

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

Temporary file to construct the stream before zipping.

Definition at line 406 of file plotters_pslike.h.

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


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