KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PDF_PLOTTER Class Reference

#include <plotters_pslike.h>

Inheritance diagram for PDF_PLOTTER:
PSLIKE_PLOTTER PLOTTER

Classes

struct  OUTLINE_NODE
 

Public Member Functions

 PDF_PLOTTER (const PROJECT *aProject=nullptr)
 
virtual PLOT_FORMAT GetPlotterType () const override
 Returns the effective plot engine in use.
 
virtual bool OpenFile (const wxString &aFullFilename) override
 Open or create the plot file aFullFilename.
 
virtual bool StartPlot (const wxString &aPageNumber) override
 The PDF engine supports multiple pages; the first one is opened 'for free' the following are to be closed and reopened.
 
virtual bool StartPlot (const wxString &aPageNumber, const wxString &aPageName=wxEmptyString)
 
virtual bool EndPlot () override
 
virtual void StartPage (const wxString &aPageNumber, const wxString &aPageName=wxEmptyString)
 Start a new page in the PDF document.
 
virtual void ClosePage ()
 Close the current page in the PDF document (and emit its compressed stream).
 
virtual void SetCurrentLineWidth (int width, void *aData=nullptr) override
 Pen width setting for PDF.
 
virtual void SetDash (int aLineWidth, LINE_STYLE aLineStyle) override
 PDF supports dashed lines.
 
virtual void SetViewport (const VECTOR2I &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!)
 
virtual void Rect (const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 Rectangles in PDF.
 
virtual void Circle (const VECTOR2I &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 Circle drawing for PDF.
 
virtual void Arc (const VECTOR2D &aCenter, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
 The PDF engine can't directly plot arcs so we use polygonization.
 
virtual void PlotPoly (const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr) override
 Polygon plotting for PDF.
 
virtual void PenTo (const VECTOR2I &pos, char plume) override
 Moveto/lineto primitive, moves the 'pen' to the specified direction.
 
virtual void Text (const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics, void *aData=nullptr) override
 Draw text with the plotter.
 
virtual void PlotText (const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const TEXT_ATTRIBUTES &aAttributes, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics, void *aData=nullptr) override
 
void HyperlinkBox (const BOX2I &aBox, const wxString &aDestinationURL) override
 Create a clickable hyperlink with a rectangular click area.
 
void HyperlinkMenu (const BOX2I &aBox, const std::vector< wxString > &aDestURLs) override
 Create a clickable hyperlink menu with a rectangular click area.
 
void Bookmark (const BOX2I &aBox, const wxString &aName, const wxString &aGroupName=wxEmptyString) override
 Create a bookmark to a symbol.
 
void PlotImage (const wxImage &aImage, const VECTOR2I &aPos, double aScaleFactor) override
 PDF images are handles as inline, not XObject streams...
 
virtual void SetTextMode (PLOT_TEXT_MODE mode) override
 PS and PDF fully implement native text (for the Latin-1 subset)
 
void SetScaleAdjust (double scaleX, double scaleY)
 Set the 'fine' scaling for the postscript engine.
 
virtual void FlashPadCircle (const VECTOR2I &aPadPos, int aDiameter, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadOval (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadRect (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadRoundRect (const VECTOR2I &aPadPos, const VECTOR2I &aSize, int aCornerRadius, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadCustom (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, SHAPE_POLY_SET *aPolygons, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadTrapez (const VECTOR2I &aPadPos, const VECTOR2I *aCorners, const EDA_ANGLE &aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a trapezoidal pad.
 
virtual void FlashRegularPolygon (const VECTOR2I &aShapePos, int aDiameter, int aCornerCount, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a regular polygon.
 
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.
 
virtual void SetNegative (bool aNegative)
 
virtual void SetColorMode (bool aColorMode)
 Plot in B/W or color.
 
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)
 
virtual void SetAuthor (const wxString &aAuthor)
 
virtual void SetSubject (const wxString &aSubject)
 
void AddLineToHeader (const wxString &aExtraString)
 Add a line to the list of free lines to print at the beginning of the file.
 
void ClearHeaderLinesList ()
 Remove all lines from the list of free lines to print at the beginning of the file.
 
double GetIUsPerDecimil () const
 The IUs per decimil are an essential scaling factor when plotting; they are set and saved when establishing the viewport.
 
int GetPlotterArcLowDef () const
 
int GetPlotterArcHighDef () const
 
virtual void Arc (const VECTOR2D &aStart, const VECTOR2D &aMid, const VECTOR2D &aEnd, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)
 
virtual void BezierCurve (const VECTOR2I &aStart, const VECTOR2I &aControl1, const VECTOR2I &aControl2, const VECTOR2I &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.
 
void MoveTo (const VECTOR2I &pos)
 
void LineTo (const VECTOR2I &pos)
 
void FinishTo (const VECTOR2I &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 ).
 
virtual void ThickSegment (const VECTOR2I &start, const VECTOR2I &end, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void ThickArc (const EDA_SHAPE &aArcShape, OUTLINE_MODE aTraceMode, void *aData, int aWidth)
 
virtual void ThickArc (const VECTOR2D &aCentre, const EDA_ANGLE &aStAngle, const EDA_ANGLE &aAngle, double aRadius, int aWidth, OUTLINE_MODE aTraceMode, void *aData)
 
virtual void ThickRect (const VECTOR2I &p1, const VECTOR2I &p2, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void ThickCircle (const VECTOR2I &pos, int diametre, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void FilledCircle (const VECTOR2I &pos, int diametre, OUTLINE_MODE tracemode, void *aData)
 
void Marker (const VECTOR2I &position, int diametre, unsigned aShapeId)
 Draw a pattern shape number aShapeId, to coord position.
 
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.
 
virtual void SetGerberCoordinatesFormat (int aResolution, bool aUseInches=false)
 
virtual void SetSvgCoordinatesFormat (unsigned aPrecision)
 Set the number of digits for mantissa in coordinates in mm for SVG plotter.
 
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.
 
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.
 
VECTOR2I GetPlotOffsetUserUnits ()
 

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).
 

Protected Member Functions

OUTLINE_NODEaddOutlineNode (OUTLINE_NODE *aParent, int aActionHandle, const wxString &aTitle)
 Adds a new outline node entry.
 
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)
 
virtual void emitSetRGBColor (double r, double g, double b, double a) override
 PDF supports colors fully.
 
int allocPdfObject ()
 Allocate a new handle in the table of the PDF 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.
 
int startPdfStream (int handle=-1)
 Starts a PDF stream (for the page).
 
void closePdfStream ()
 Finish the current PDF stream (writes the deferred length, too)
 
int emitOutline ()
 Starts emitting the outline object.
 
void emitOutlineNode (OUTLINE_NODE *aNode, int aParentHandle, int aNextNode, int aPrevNode)
 Emits a outline item object and recurses into any children.
 
int emitGoToAction (int aPageHandle, const VECTOR2I &aBottomLeft, const VECTOR2I &aTopRight)
 Emits an action object that instructs a goto coordinates on a page.
 
int emitGoToAction (int aPageHandle)
 
void computeTextParameters (const VECTOR2I &aPos, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, bool aMirror, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_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.
 
int returnPostscriptTextWidth (const wxString &aText, int aXSize, bool aItalic, bool aBold)
 Sister function for the GRTextWidth in gr_text.cpp Does the same processing (i.e.
 
virtual void polyArc (const VECTOR2D &aCentre, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)
 Generic fallback: arc rendered as a polyline.
 
void markerCircle (const VECTOR2I &pos, int radius)
 Plot a circle centered on the position.
 
void markerHBar (const VECTOR2I &pos, int radius)
 Plot a - bar centered on the position.
 
void markerSlash (const VECTOR2I &pos, int radius)
 Plot a / bar centered on the position.
 
void markerBackSlash (const VECTOR2I &pos, int radius)
 Plot a \ bar centered on the position.
 
void markerVBar (const VECTOR2I &pos, int radius)
 Plot a | bar centered on the position.
 
void markerSquare (const VECTOR2I &position, int radius)
 Plot a square centered on the position.
 
void markerLozenge (const VECTOR2I &position, int radius)
 Plot a lozenge centered on the position.
 
void segmentAsOval (const VECTOR2I &start, const VECTOR2I &end, int width, OUTLINE_MODE tracemode)
 Convert a thick segment and plot it as an oval.
 
void sketchOval (const VECTOR2I &aPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, int aWidth)
 
virtual VECTOR2D userToDeviceCoordinates (const VECTOR2I &aCoordinate)
 Modify coordinates according to the orientation, scale factor, and offsets trace.
 
virtual VECTOR2D userToDeviceSize (const VECTOR2I &size)
 Modify size according to the plotter scale factors (VECTOR2I version, returns a VECTOR2D).
 
virtual double userToDeviceSize (double size) const
 Modify size according to the plotter scale factors (simple double version).
 
double GetDotMarkLenIU (int aLineWidth) const
 
double GetDashMarkLenIU (int aLineWidth) const
 
double GetDashGapLenIU (int aLineWidth) const
 

Protected Attributes

int m_pageTreeHandle
 Handle to the root of the page tree object.
 
int m_fontResDictHandle
 Font resource dictionary.
 
int m_imgResDictHandle
 Image resource dictionary.
 
int m_jsNamesHandle
 Handle for Names dictionary with JS.
 
std::vector< int > m_pageHandles
 Handles to the page objects.
 
int m_pageStreamHandle
 Handle of the page content object.
 
int m_streamLengthHandle
 Handle to the deferred stream length.
 
wxString m_workFilename
 
wxString m_pageName
 
FILE * m_workFile
 Temporary file to construct the stream before zipping.
 
std::vector< long > m_xrefTable
 The PDF xref offset table.
 
std::vector< wxString > m_pageNumbers
 List of loaded hyperlinks in current page.
 
std::vector< std::pair< BOX2I, wxString > > m_hyperlinksInPage
 
std::vector< std::pair< BOX2I, std::vector< wxString > > > m_hyperlinkMenusInPage
 Handles for all the hyperlink objects that will be deferred.
 
std::map< int, std::pair< BOX2D, wxString > > m_hyperlinkHandles
 
std::map< int, std::pair< BOX2D, std::vector< wxString > > > m_hyperlinkMenuHandles
 
std::map< wxString, std::vector< std::pair< BOX2I, wxString > > > m_bookmarksInPage
 
std::map< int, wxImage > m_imageHandles
 
std::unique_ptr< OUTLINE_NODEm_outlineRoot
 Root outline node.
 
int m_totalOutlineNodes
 Total number of outline nodes.
 
double plotScaleAdjX
 Fine user scale adjust ( = 1.0 if no correction)
 
double plotScaleAdjY
 
PLOT_TEXT_MODE m_textMode
 How to draw text.
 
double m_plotScale
 Plot scale - chosen by the user (even implicitly with 'fit in a4')
 
double m_IUsPerDecimil
 
double m_iuPerDeviceUnit
 
VECTOR2I m_plotOffset
 
bool m_plotMirror
 
bool m_mirrorIsHorizontal
 
bool m_yaxisReversed
 
FILE * m_outputFile
 Output file.
 
bool m_colorMode
 
bool m_negativeMode
 
int m_currentPenWidth
 
char m_penState
 
VECTOR2I m_penLastpos
 
wxString m_creator
 
wxString m_filename
 
wxString m_title
 
wxString m_author
 
wxString m_subject
 
PAGE_INFO m_pageInfo
 
VECTOR2I m_paperSize
 
wxArrayString m_headerExtraLines
 
RENDER_SETTINGSm_renderSettings
 
const PROJECTm_project
 

Static Protected Attributes

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

Detailed Description

Definition at line 240 of file plotters_pslike.h.

Constructor & Destructor Documentation

◆ PDF_PLOTTER()

PDF_PLOTTER::PDF_PLOTTER ( const PROJECT aProject = nullptr)
inline

Definition at line 243 of file plotters_pslike.h.

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

References PLOTTER::m_headerExtraLines.

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

◆ addOutlineNode()

PDF_PLOTTER::OUTLINE_NODE * PDF_PLOTTER::addOutlineNode ( OUTLINE_NODE aParent,
int  aActionHandle,
const wxString &  aTitle 
)
protected

Adds a new outline node entry.

The PDF object handle is automacially allocated

Parameters
aParentParent node to append the new node to
aActionHandleThe handle of an action that may be performed on click, set to -1 for no action
aTitleTitle of node to display

Definition at line 1070 of file PDF_plotter.cpp.

References PDF_PLOTTER::OUTLINE_NODE::AddChild(), allocPdfObject(), and m_totalOutlineNodes.

Referenced by ClosePage().

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

References m_xrefTable.

Referenced by addOutlineNode(), ClosePage(), emitGoToAction(), emitOutline(), EndPlot(), PlotImage(), startPdfObject(), startPdfStream(), and StartPlot().

◆ Arc() [1/2]

void PDF_PLOTTER::Arc ( const VECTOR2D aCenter,
const EDA_ANGLE aStartAngle,
const EDA_ANGLE aAngle,
double  aRadius,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

The PDF engine can't directly plot arcs so we use polygonization.

Reimplemented from PLOTTER.

Definition at line 332 of file PDF_plotter.cpp.

References Circle(), DEGREES_T, delta, KiROUND(), m_workFile, SetCurrentLineWidth(), PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Arc() [2/2]

void PLOTTER::Arc ( const VECTOR2D aStart,
const VECTOR2D aMid,
const VECTOR2D aEnd,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH 
)
virtualinherited

◆ BezierCurve()

void PLOTTER::BezierCurve ( const VECTOR2I aStart,
const VECTOR2I aControl1,
const VECTOR2I aControl2,
const VECTOR2I 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 230 of file plotter.cpp.

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

Referenced by SVG_PLOTTER::BezierCurve(), and BRDITEMS_PLOTTER::PlotShape().

◆ Bookmark()

void PDF_PLOTTER::Bookmark ( const BOX2I aBox,
const wxString &  aName,
const wxString &  aGroupName = wxEmptyString 
)
overridevirtual

Create a bookmark to a symbol.

Parameters
aBoxis the rectangular click target
aSymbolReferenceis the symbol schematic ref

Reimplemented from PLOTTER.

Definition at line 1725 of file PDF_plotter.cpp.

References m_bookmarksInPage.

◆ Circle()

void PDF_PLOTTER::Circle ( const VECTOR2I 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 274 of file PDF_plotter.cpp.

References m_workFile, SetCurrentLineWidth(), PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), 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 172 of file plotter.h.

References PLOTTER::m_headerExtraLines.

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

◆ ClosePage()

◆ closePdfObject()

void PDF_PLOTTER::closePdfObject ( )
protected

Close the current PDF object.

Definition at line 553 of file PDF_plotter.cpp.

References PLOTTER::m_outputFile, and m_workFile.

Referenced by ClosePage(), closePdfStream(), emitGoToAction(), emitOutline(), emitOutlineNode(), and EndPlot().

◆ closePdfStream()

void PDF_PLOTTER::closePdfStream ( )
protected

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

Definition at line 592 of file PDF_plotter.cpp.

References closePdfObject(), ADVANCED_CFG::GetCfg(), ignore_unused(), PLOTTER::m_outputFile, m_streamLengthHandle, m_workFile, m_workFilename, and startPdfObject().

Referenced by ClosePage().

◆ computeTextParameters()

void PSLIKE_PLOTTER::computeTextParameters ( const VECTOR2I aPos,
const wxString &  aText,
const EDA_ANGLE aOrient,
const VECTOR2I aSize,
bool  aMirror,
enum GR_TEXT_H_ALIGN_T  aH_justify,
enum GR_TEXT_V_ALIGN_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 352 of file PS_plotter.cpp.

References EDA_ANGLE::AsRadians(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_INDETERMINATE, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, GR_TEXT_V_ALIGN_TOP, EDA_ANGLE::Invert(), PLOTTER::m_plotMirror, PSLIKE_PLOTTER::postscriptTextAscent, PSLIKE_PLOTTER::returnPostscriptTextWidth(), RotatePoint(), PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Text().

◆ emitGoToAction() [1/2]

int PDF_PLOTTER::emitGoToAction ( int  aPageHandle)
protected

◆ emitGoToAction() [2/2]

int PDF_PLOTTER::emitGoToAction ( int  aPageHandle,
const VECTOR2I aBottomLeft,
const VECTOR2I aTopRight 
)
protected

Emits an action object that instructs a goto coordinates on a page.

Returns
Generated action handle

Definition at line 973 of file PDF_plotter.cpp.

References allocPdfObject(), closePdfObject(), PLOTTER::m_outputFile, startPdfObject(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ClosePage().

◆ emitOutline()

int PDF_PLOTTER::emitOutline ( )
protected

Starts emitting the outline object.

Definition at line 1080 of file PDF_plotter.cpp.

References allocPdfObject(), closePdfObject(), emitOutlineNode(), m_outlineRoot, PLOTTER::m_outputFile, m_totalOutlineNodes, and startPdfObject().

Referenced by EndPlot().

◆ emitOutlineNode()

void PDF_PLOTTER::emitOutlineNode ( OUTLINE_NODE aNode,
int  aParentHandle,
int  aNextNode,
int  aPrevNode 
)
protected

◆ emitSetRGBColor()

void PDF_PLOTTER::emitSetRGBColor ( double  r,
double  g,
double  b,
double  a 
)
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 171 of file PDF_plotter.cpp.

References m_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 52 of file PDF_plotter.cpp.

References KI_FALLTHROUGH.

Referenced by emitOutlineNode(), EndPlot(), and Text().

◆ EndBlock()

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

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

the group is started by StartBlock()

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

Reimplemented in GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 546 of file plotter.h.

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

◆ EndPlot()

◆ FilledCircle()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 663 of file plotter.cpp.

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

Referenced by SCH_LABEL_BASE::Plot(), and BRDITEMS_PLOTTER::PlotShape().

◆ FinishTo()

◆ FlashPadCircle()

void PSLIKE_PLOTTER::FlashPadCircle ( const VECTOR2I 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 121 of file PS_plotter.cpp.

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

◆ FlashPadCustom()

void PSLIKE_PLOTTER::FlashPadCustom ( const VECTOR2I aPadPos,
const VECTOR2I aSize,
const EDA_ANGLE 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 208 of file PS_plotter.cpp.

References SHAPE_LINE_CHAIN::CPoint(), FILLED, PLOTTER::GetCurrentLineWidth(), 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 VECTOR2I aPadPos,
const VECTOR2I aSize,
const EDA_ANGLE 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 91 of file PS_plotter.cpp.

References ANGLE_90, delta, FILLED, PLOTTER::m_outputFile, RotatePoint(), PLOTTER::sketchOval(), PLOTTER::ThickSegment(), PLOTTER::USE_DEFAULT_LINE_WIDTH, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadRect()

void PSLIKE_PLOTTER::FlashPadRect ( const VECTOR2I aPadPos,
const VECTOR2I aSize,
const EDA_ANGLE 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 138 of file PS_plotter.cpp.

References FILLED, PLOTTER::GetCurrentLineWidth(), PLOTTER::PlotPoly(), RotatePoint(), PLOTTER::SetCurrentLineWidth(), PLOTTER::USE_DEFAULT_LINE_WIDTH, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadRoundRect()

void PSLIKE_PLOTTER::FlashPadRoundRect ( const VECTOR2I aPadPos,
const VECTOR2I aSize,
int  aCornerRadius,
const EDA_ANGLE 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 178 of file PS_plotter.cpp.

References SHAPE_LINE_CHAIN::CPoint(), ERROR_INSIDE, FILLED, PLOTTER::GetCurrentLineWidth(), PLOTTER::GetPlotterArcHighDef(), 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 VECTOR2I aPadPos,
const VECTOR2I aCorners,
const EDA_ANGLE 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 236 of file PS_plotter.cpp.

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

◆ FlashRegularPolygon()

void PSLIKE_PLOTTER::FlashRegularPolygon ( const VECTOR2I aShapePos,
int  aDiameter,
int  aCornerCount,
const EDA_ANGLE 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.
aDatais a auxiliary parameter used (if needed) to handle extra info specific to the plotter.

Implements PLOTTER.

Definition at line 267 of file PS_plotter.cpp.

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( int  aLineWidth) const
protectedinherited

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( int  aLineWidth) const
protectedinherited

◆ GetDefaultFileExtension()

static wxString PDF_PLOTTER::GetDefaultFileExtension ( )
inlinestatic

Definition at line 261 of file plotters_pslike.h.

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

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( int  aLineWidth) const
protectedinherited

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

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetPlotOffsetUserUnits()

VECTOR2I PLOTTER::GetPlotOffsetUserUnits ( )
inlineinherited
Returns
the plot offset in IUs, set by SetViewport() and used to plot items.

Definition at line 552 of file plotter.h.

References PLOTTER::m_plotOffset.

Referenced by PlotInteractiveLayer().

◆ GetPlotterArcHighDef()

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 208 of file plotter.h.

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

◆ HyperlinkBox()

void PDF_PLOTTER::HyperlinkBox ( const BOX2I aBox,
const wxString &  aDestinationURL 
)
overridevirtual

Create a clickable hyperlink with a rectangular click area.

Parameters
aBoxis the rectangular click target
aDestinationURLis the target URL

Reimplemented from PLOTTER.

Definition at line 1713 of file PDF_plotter.cpp.

References m_hyperlinksInPage.

◆ HyperlinkMenu()

void PDF_PLOTTER::HyperlinkMenu ( const BOX2I aBox,
const std::vector< wxString > &  aDestURLs 
)
overridevirtual

Create a clickable hyperlink menu with a rectangular click area.

Parameters
aBoxis the rectangular click target
aDestURLsis the target URL

Reimplemented from PLOTTER.

Definition at line 1719 of file PDF_plotter.cpp.

References m_hyperlinkMenusInPage.

◆ LineTo()

◆ Marker()

void PLOTTER::Marker ( const VECTOR2I 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 364 of file plotter.cpp.

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 VECTOR2I pos,
int  radius 
)
protectedinherited

Plot a \ bar centered on the position.

Building block for markers

Definition at line 350 of file plotter.cpp.

References PLOTTER::FinishTo(), PLOTTER::MoveTo(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PLOTTER::Marker().

◆ markerCircle()

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

Plot a circle centered on the position.

Building block for markers

Definition at line 303 of file plotter.cpp.

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

Referenced by PLOTTER::Marker().

◆ markerHBar()

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

Plot a - bar centered on the position.

Building block for markers

Definition at line 336 of file plotter.cpp.

References PLOTTER::FinishTo(), PLOTTER::MoveTo(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PLOTTER::Marker().

◆ markerLozenge()

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

Plot a lozenge centered on the position.

Building block for markers

Definition at line 309 of file plotter.cpp.

References PLOTTER::GetCurrentLineWidth(), PLOTTER::PlotPoly(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PLOTTER::Marker().

◆ markerSlash()

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

Plot a / bar centered on the position.

Building block for markers

Definition at line 343 of file plotter.cpp.

References PLOTTER::FinishTo(), PLOTTER::MoveTo(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PLOTTER::Marker().

◆ markerSquare()

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

Plot a square centered on the position.

Building block for markers

Definition at line 275 of file plotter.cpp.

References PLOTTER::GetCurrentLineWidth(), KiROUND(), PLOTTER::PlotPoly(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PLOTTER::Marker().

◆ markerVBar()

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

Plot a | bar centered on the position.

Building block for markers

Definition at line 357 of file plotter.cpp.

References PLOTTER::FinishTo(), PLOTTER::MoveTo(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

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

Referenced by SCH_PLOTTER::createPDFFile().

◆ PageSettings()

PAGE_INFO & PLOTTER::PageSettings ( )
inlineinherited

◆ PenFinish()

◆ PenTo()

void PDF_PLOTTER::PenTo ( const VECTOR2I 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 423 of file PDF_plotter.cpp.

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

◆ PlotImage()

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

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

Reimplemented from PLOTTER.

Definition at line 453 of file PDF_plotter.cpp.

References allocPdfObject(), image, m_imageHandles, m_workFile, PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), 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 677 of file plotter.cpp.

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< VECTOR2I > &  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 391 of file PDF_plotter.cpp.

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

Referenced by Rect().

◆ PlotText()

void PDF_PLOTTER::PlotText ( const VECTOR2I aPos,
const COLOR4D aColor,
const wxString &  aText,
const TEXT_ATTRIBUTES aAttributes,
KIFONT::FONT aFont,
const KIFONT::METRICS aFontMetrics,
void *  aData = nullptr 
)
overridevirtual

◆ polyArc()

void PLOTTER::polyArc ( const VECTOR2D aCentre,
const EDA_ANGLE aStartAngle,
const EDA_ANGLE aAngle,
double  aRadius,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH 
)
protectedvirtualinherited

Generic fallback: arc rendered as a polyline.

Note also aCentre and aRadius are double to avoid creating rounding issues due to the fact a arc is defined in Kicad by a start point, a end point and third point not angles and radius. In some plotters (i.e. dxf) whe need a good precision when calculating an arc without error introduced by rounding, to avoid moving the end points, usually important in outlines when plotting an arc given by center, radius and angles. Winding direction: counter-clockwise in right-down coordinate system.

Definition at line 181 of file plotter.cpp.

References ANGLE_0, EDA_ANGLE::Cos(), DEGREES_T, delta, PLOTTER::FinishTo(), KiROUND(), PLOTTER::LineTo(), PLOTTER::MoveTo(), PLOTTER::SetCurrentLineWidth(), sign(), EDA_ANGLE::Sin(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ Rect()

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

Rectangles in PDF.

Supported by the native operator.

Implements PLOTTER.

Definition at line 223 of file PDF_plotter.cpp.

References std::abs(), PLOTTER::FinishTo(), m_workFile, PLOTTER::MoveTo(), PlotPoly(), SetCurrentLineWidth(), PLOTTER::userToDeviceCoordinates(), 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 GRTextWidth in gr_text.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 316 of file PS_plotter.cpp.

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

Referenced by PSLIKE_PLOTTER::computeTextParameters().

◆ segmentAsOval()

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

Convert a thick segment and plot it as an oval.

Definition at line 486 of file plotter.cpp.

References VECTOR2< T >::EuclideanNorm(), PLOTTER::FlashPadOval(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ SetAuthor()

virtual void PLOTTER::SetAuthor ( const wxString &  aAuthor)
inlinevirtualinherited

Definition at line 156 of file plotter.h.

References PLOTTER::m_author.

Referenced by SCH_PLOTTER::createPDFFile(), and DIALOG_PLOT::Plot().

◆ 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.

Definition at line 63 of file PS_plotter.cpp.

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

Referenced by SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), PS_PLOTTER::PlotText(), PS_PLOTTER::Text(), Text(), and SVG_PLOTTER::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 150 of file PDF_plotter.cpp.

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

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

◆ SetDash()

void PDF_PLOTTER::SetDash ( int  aLineWidth,
LINE_STYLE  aLineStyle 
)
overridevirtual

PDF supports dashed lines.

Implements PLOTTER.

Definition at line 188 of file PDF_plotter.cpp.

References PLOTTER::GetDashGapLenIU(), PLOTTER::GetDashMarkLenIU(), PLOTTER::GetDotMarkLenIU(), and m_workFile.

◆ SetGerberCoordinatesFormat()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 519 of file plotter.h.

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

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 125 of file plotter.h.

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

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

Referenced by StartPlotBoard().

◆ SetSubject()

virtual void PLOTTER::SetSubject ( const wxString &  aSubject)
inlinevirtualinherited

Definition at line 157 of file plotter.h.

References PLOTTER::m_subject.

Referenced by SCH_PLOTTER::createPDFFile(), and DIALOG_PLOT::Plot().

◆ SetSvgCoordinatesFormat()

virtual void PLOTTER::SetSvgCoordinatesFormat ( unsigned  aPrecision)
inlinevirtualinherited

Set the number of digits for mantissa in coordinates in mm for SVG plotter.

Reimplemented in SVG_PLOTTER.

Definition at line 525 of file plotter.h.

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

References PSLIKE_PLOTTER::m_textMode.

Referenced by SVG_PLOTTER::SVG_PLOTTER().

◆ SetTitle()

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

Definition at line 155 of file plotter.h.

References PLOTTER::m_title.

Referenced by SCH_PLOTTER::createPDFFile(), and DIALOG_PLOT::Plot().

◆ SetViewport()

void PDF_PLOTTER::SetViewport ( const VECTOR2I 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 134 of file PDF_plotter.cpp.

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

◆ sketchOval()

void PLOTTER::sketchOval ( const VECTOR2I aPos,
const VECTOR2I aSize,
const EDA_ANGLE aOrient,
int  aWidth 
)
protectedinherited

◆ StartBlock()

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

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

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

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

Reimplemented in GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 537 of file plotter.h.

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

◆ StartPage()

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

References allocPdfObject(), PLOTTER::m_outputFile, m_workFile, and m_xrefTable.

Referenced by ClosePage(), closePdfStream(), emitGoToAction(), emitOutline(), emitOutlineNode(), 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 561 of file PDF_plotter.cpp.

References allocPdfObject(), ADVANCED_CFG::GetCfg(), PLOTTER::m_outputFile, m_streamLengthHandle, m_workFile, m_workFilename, and startPdfObject().

Referenced by StartPage().

◆ StartPlot() [1/2]

bool PDF_PLOTTER::StartPlot ( const wxString &  aPageNumber)
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 927 of file PDF_plotter.cpp.

References StartPlot().

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

◆ StartPlot() [2/2]

bool PDF_PLOTTER::StartPlot ( const wxString &  aPageNumber,
const wxString &  aPageName = wxEmptyString 
)
virtual

◆ Text()

void PDF_PLOTTER::Text ( const VECTOR2I aPos,
const COLOR4D aColor,
const wxString &  aText,
const EDA_ANGLE aOrient,
const VECTOR2I aSize,
enum GR_TEXT_H_ALIGN_T  aH_justify,
enum GR_TEXT_V_ALIGN_T  aV_justify,
int  aPenWidth,
bool  aItalic,
bool  aBold,
bool  aMultilineAllowed,
KIFONT::FONT aFont,
const KIFONT::METRICS aFontMetrics,
void *  aData = nullptr 
)
overridevirtual

Draw text with the plotter.

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

Parameters
aPosis the text position (according to aH_justify, aV_justify).
aColoris the text color.
aTextis the text to draw.
aOrientis the angle.
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 (aPenWidth = 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 1578 of file PDF_plotter.cpp.

References std::abs(), PSLIKE_PLOTTER::computeTextParameters(), encodeStringForPlotter(), KIFONT::FONT::GetFont(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, m_workFile, render_mode, RotatePoint(), PSLIKE_PLOTTER::SetColor(), SetCurrentLineWidth(), KIFONT::FONT::StringBoundaryLimits(), PLOTTER::Text(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PlotText().

◆ ThickArc() [1/2]

void PLOTTER::ThickArc ( const EDA_SHAPE aArcShape,
OUTLINE_MODE  aTraceMode,
void *  aData,
int  aWidth 
)
virtualinherited

◆ ThickArc() [2/2]

void PLOTTER::ThickArc ( const VECTOR2D aCentre,
const EDA_ANGLE aStAngle,
const EDA_ANGLE aAngle,
double  aRadius,
int  aWidth,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
virtualinherited

Reimplemented in GERBER_PLOTTER.

Definition at line 578 of file plotter.cpp.

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

◆ ThickCircle()

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

◆ ThickRect()

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

◆ ThickSegment()

◆ userToDeviceCoordinates()

VECTOR2D PLOTTER::userToDeviceCoordinates ( const VECTOR2I aCoordinate)
protectedvirtualinherited

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

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

Member Data Documentation

◆ DO_NOT_SET_LINE_WIDTH

◆ m_author

wxString PLOTTER::m_author
protectedinherited

Definition at line 674 of file plotter.h.

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

◆ m_bookmarksInPage

std::map<wxString, std::vector<std::pair<BOX2I, wxString> > > PDF_PLOTTER::m_bookmarksInPage
protected

Definition at line 512 of file plotters_pslike.h.

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

◆ m_colorMode

◆ m_creator

wxString PLOTTER::m_creator
protectedinherited

◆ m_currentPenWidth

◆ m_filename

wxString PLOTTER::m_filename
protectedinherited

Definition at line 672 of file plotter.h.

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

◆ m_fontResDictHandle

int PDF_PLOTTER::m_fontResDictHandle
protected

Font resource dictionary.

Definition at line 490 of file plotters_pslike.h.

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

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

◆ m_hyperlinkHandles

std::map<int, std::pair<BOX2D, wxString> > PDF_PLOTTER::m_hyperlinkHandles
protected

Definition at line 509 of file plotters_pslike.h.

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

◆ m_hyperlinkMenuHandles

std::map<int, std::pair<BOX2D, std::vector<wxString> > > PDF_PLOTTER::m_hyperlinkMenuHandles
protected

Definition at line 510 of file plotters_pslike.h.

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

◆ m_hyperlinkMenusInPage

std::vector<std::pair<BOX2I, std::vector<wxString> > > PDF_PLOTTER::m_hyperlinkMenusInPage
protected

Handles for all the hyperlink objects that will be deferred.

Definition at line 506 of file plotters_pslike.h.

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

◆ m_hyperlinksInPage

std::vector<std::pair<BOX2I, wxString> > PDF_PLOTTER::m_hyperlinksInPage
protected

Definition at line 505 of file plotters_pslike.h.

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

◆ m_imageHandles

std::map<int, wxImage> PDF_PLOTTER::m_imageHandles
protected

Definition at line 514 of file plotters_pslike.h.

Referenced by EndPlot(), and PlotImage().

◆ m_imgResDictHandle

int PDF_PLOTTER::m_imgResDictHandle
protected

Image resource dictionary.

Definition at line 491 of file plotters_pslike.h.

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

◆ m_iuPerDeviceUnit

◆ m_IUsPerDecimil

◆ m_jsNamesHandle

int PDF_PLOTTER::m_jsNamesHandle
protected

Handle for Names dictionary with JS.

Definition at line 492 of file plotters_pslike.h.

Referenced by EndPlot(), and StartPlot().

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

Definition at line 658 of file plotter.h.

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

◆ m_negativeMode

bool PLOTTER::m_negativeMode
protectedinherited

Definition at line 666 of file plotter.h.

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

◆ m_outlineRoot

std::unique_ptr<OUTLINE_NODE> PDF_PLOTTER::m_outlineRoot
protected

Root outline node.

Definition at line 516 of file plotters_pslike.h.

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

◆ m_outputFile

FILE* PLOTTER::m_outputFile
protectedinherited

Output file.

Definition at line 662 of file plotter.h.

Referenced by DXF_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(), emitGoToAction(), emitOutline(), emitOutlineNode(), PS_PLOTTER::emitSetRGBColor(), DXF_PLOTTER::EndPlot(), GERBER_PLOTTER::EndPlot(), HPGL_PLOTTER::EndPlot(), PS_PLOTTER::EndPlot(), EndPlot(), SVG_PLOTTER::EndPlot(), HPGL_PLOTTER::FlashPadCircle(), DXF_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::FlashPadOval(), HPGL_PLOTTER::FlashPadOval(), PSLIKE_PLOTTER::FlashPadOval(), DXF_PLOTTER::FlashPadOval(), GERBER_PLOTTER::FlashPadRect(), DXF_PLOTTER::FlashPadRect(), GERBER_PLOTTER::FlashPadRoundRect(), DXF_PLOTTER::FlashPadTrapez(), GERBER_PLOTTER::formatNetAttribute(), PLOTTER::OpenFile(), OpenFile(), DXF_PLOTTER::PenTo(), GERBER_PLOTTER::PenTo(), HPGL_PLOTTER::PenTo(), PS_PLOTTER::PenTo(), SVG_PLOTTER::PenTo(), GERBER_PLOTTER::plotArc(), GERBER_PLOTTER::PlotGerberRegion(), PS_PLOTTER::PlotImage(), SVG_PLOTTER::PlotImage(), DXF_PLOTTER::plotOneLineOfText(), GERBER_PLOTTER::PlotPoly(), PS_PLOTTER::PlotPoly(), SVG_PLOTTER::PlotPoly(), GERBER_PLOTTER::plotRoundRectAsRegion(), PLOTTER::PLOTTER(), PS_PLOTTER::PlotText(), HPGL_PLOTTER::Rect(), DXF_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(), StartPage(), startPdfObject(), startPdfStream(), DXF_PLOTTER::StartPlot(), HPGL_PLOTTER::StartPlot(), PS_PLOTTER::StartPlot(), SVG_PLOTTER::StartPlot(), StartPlot(), GERBER_PLOTTER::StartPlot(), PS_PLOTTER::Text(), SVG_PLOTTER::Text(), HPGL_PLOTTER::ThickSegment(), GERBER_PLOTTER::writeApertureList(), and PLOTTER::~PLOTTER().

◆ m_pageHandles

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

Handles to the page objects.

Definition at line 493 of file plotters_pslike.h.

Referenced by ClosePage(), and EndPlot().

◆ m_pageInfo

◆ m_pageName

wxString PDF_PLOTTER::m_pageName
protected

Definition at line 497 of file plotters_pslike.h.

Referenced by ClosePage(), and StartPage().

◆ m_pageNumbers

std::vector<wxString> PDF_PLOTTER::m_pageNumbers
protected

List of loaded hyperlinks in current page.

Definition at line 502 of file plotters_pslike.h.

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

◆ m_pageStreamHandle

int PDF_PLOTTER::m_pageStreamHandle
protected

Handle of the page content object.

Definition at line 494 of file plotters_pslike.h.

Referenced by ClosePage(), and StartPage().

◆ m_pageTreeHandle

int PDF_PLOTTER::m_pageTreeHandle
protected

Handle to the root of the page tree object.

Definition at line 489 of file plotters_pslike.h.

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

◆ m_paperSize

◆ m_penLastpos

VECTOR2I PLOTTER::m_penLastpos
protectedinherited

◆ m_penState

char PLOTTER::m_penState
protectedinherited

◆ m_plotMirror

◆ m_plotOffset

◆ m_plotScale

◆ m_project

const PROJECT* PLOTTER::m_project
protectedinherited

Definition at line 683 of file plotter.h.

Referenced by EndPlot().

◆ m_renderSettings

◆ m_streamLengthHandle

int PDF_PLOTTER::m_streamLengthHandle
protected

Handle to the deferred stream length.

Definition at line 495 of file plotters_pslike.h.

Referenced by closePdfStream(), and startPdfStream().

◆ m_subject

wxString PLOTTER::m_subject
protectedinherited

Definition at line 675 of file plotter.h.

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

◆ m_textMode

PLOT_TEXT_MODE PSLIKE_PLOTTER::m_textMode
protectedinherited

◆ m_title

wxString PLOTTER::m_title
protectedinherited

Definition at line 673 of file plotter.h.

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

◆ m_totalOutlineNodes

int PDF_PLOTTER::m_totalOutlineNodes
protected

Total number of outline nodes.

Definition at line 517 of file plotters_pslike.h.

Referenced by addOutlineNode(), emitOutline(), and StartPlot().

◆ m_workFile

FILE* PDF_PLOTTER::m_workFile
protected

◆ m_workFilename

wxString PDF_PLOTTER::m_workFilename
protected

Definition at line 496 of file plotters_pslike.h.

Referenced by closePdfStream(), and startPdfStream().

◆ m_xrefTable

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

The PDF xref offset table.

List of user-space page numbers for resolving internal hyperlinks

Definition at line 499 of file plotters_pslike.h.

Referenced by allocPdfObject(), EndPlot(), startPdfObject(), and 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 485 of file plotter.h.

Referenced by PLOTTER::Marker().

◆ plotScaleAdjX

double PSLIKE_PLOTTER::plotScaleAdjX
protectedinherited

Fine user scale adjust ( = 1.0 if no correction)

Definition at line 137 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 127 of file plotters_pslike.h.

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

◆ USE_DEFAULT_LINE_WIDTH


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