Base plotter engine class. More...

#include <plotter.h>

Inheritance diagram for PLOTTER:

Public Member Functions
	PLOTTER (const PROJECT *aProject=nullptr)

virtual	~PLOTTER ()

virtual PLOT_FORMAT	GetPlotterType () const =0
	Return the effective plot engine in use.

virtual bool	StartPlot (const wxString &aPageNumber)=0

virtual bool	EndPlot ()=0

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_SETTINGS *	RenderSettings ()

virtual void	SetPageSettings (const PAGE_INFO &aPageSettings)

PAGE_INFO &	PageSettings ()

void	SetPlotMirrored (bool aMirror)

bool	GetPlotMirrored () const

virtual void	SetCurrentLineWidth (int width, void *aData=nullptr)=0
	Set the line width for the next drawing.

virtual int	GetCurrentLineWidth () const

virtual void	SetColor (const COLOR4D &color)=0

virtual void	SetDash (int aLineWidth, LINE_STYLE aLineStyle)=0

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.

virtual void	SetViewport (const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror)=0
	Set the plot offset and scaling for the current plot.

virtual bool	OpenFile (const wxString &aFullFilename)
	Open or create the plot file aFullFilename.

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	Rect (const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width, int aCornerRadius=0)=0

virtual void	Circle (const VECTOR2I &pos, int diametre, FILL_T fill, int width)=0

virtual void	Arc (const VECTOR2D &aStart, const VECTOR2D &aMid, const VECTOR2D &aEnd, FILL_T aFill, int aWidth)

virtual void	Arc (const VECTOR2D &aCenter, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, FILL_T aFill, int aWidth)

virtual void	BezierCurve (const VECTOR2I &aStart, const VECTOR2I &aControl1, const VECTOR2I &aControl2, const VECTOR2I &aEnd, int aTolerance, int aLineThickness)
	Generic fallback: Cubic Bezier curve rendered as a polyline.

virtual void	PenTo (const VECTOR2I &pos, char plume)=0
	Moveto/lineto primitive, moves the 'pen' to the specified direction.

void	MoveTo (const VECTOR2I &pos)

void	LineTo (const VECTOR2I &pos)

void	FinishTo (const VECTOR2I &pos)

void	PenFinish ()

virtual void	PlotPoly (const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth, void *aData)=0
	Draw a polygon ( filled or not ).

virtual void	PlotPoly (const SHAPE_LINE_CHAIN &aCornerList, FILL_T aFill, int aWidth, void *aData)
	Draw a polygon ( filled or not ).

virtual void	PlotImage (const wxImage &aImage, const VECTOR2I &aPos, double aScaleFactor)
	Only PostScript plotters can plot bitmaps.

virtual void	ThickSegment (const VECTOR2I &start, const VECTOR2I &end, int width, void *aData)

virtual void	ThickArc (const EDA_SHAPE &aArcShape, void *aData, int aWidth)

virtual void	ThickArc (const VECTOR2D &aCentre, const EDA_ANGLE &aStAngle, const EDA_ANGLE &aAngle, double aRadius, int aWidth, void *aData)

virtual void	ThickRect (const VECTOR2I &p1, const VECTOR2I &p2, int width, void *aData)

virtual void	ThickCircle (const VECTOR2I &pos, int diametre, int width, void *aData)

virtual void	FilledCircle (const VECTOR2I &pos, int diametre, void *aData)

virtual void	ThickOval (const VECTOR2I &aPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, int aWidth, void *aData)

virtual void	ThickPoly (const SHAPE_POLY_SET &aPoly, int aWidth, void *aData)

virtual void	FlashPadCircle (const VECTOR2I &aPadPos, int aDiameter, void *aData)=0

virtual void	FlashPadOval (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aPadOrient, void *aData)=0

virtual void	FlashPadRect (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aPadOrient, void *aData)=0

virtual void	FlashPadRoundRect (const VECTOR2I &aPadPos, const VECTOR2I &aSize, int aCornerRadius, const EDA_ANGLE &aOrient, void *aData)=0

virtual void	FlashPadCustom (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aPadOrient, SHAPE_POLY_SET aPolygons, void aData)=0

virtual void	FlashPadTrapez (const VECTOR2I &aPadPos, const VECTOR2I aCorners, const EDA_ANGLE &aPadOrient, void aData)=0
	Flash a trapezoidal pad.

virtual void	FlashRegularPolygon (const VECTOR2I &aShapePos, int aDiameter, int aCornerCount, const EDA_ANGLE &aOrient, void *aData)=0
	Flash a regular polygon.

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 aPenWidth, bool aItalic, bool aBold, bool aMultilineAllowed, KIFONT::FONT aFont, const KIFONT::METRICS &aFontMetrics, void aData=nullptr)
	Draw text with the plotter.

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

virtual void	HyperlinkBox (const BOX2I &aBox, const wxString &aDestinationURL)
	Create a clickable hyperlink with a rectangular click area.

virtual void	HyperlinkMenu (const BOX2I &aBox, const std::vector< wxString > &aDestURLs)
	Create a clickable hyperlink menu with a rectangular click area.

virtual void	Bookmark (const BOX2I &aBox, const wxString &aName, const wxString &aGroupName=wxEmptyString)
	Create a bookmark to a symbol.

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	SetTextMode (PLOT_TEXT_MODE mode)
	Change the current text mode.

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 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
virtual void	polyArc (const VECTOR2D &aCentre, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, FILL_T aFill, int aWidth)
	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.

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
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_SETTINGS *	m_renderSettings

const PROJECT *	m_project

Detailed Description

Base plotter engine class.

General rule: all the interface with the caller is done in IU, the IU size is specified with SetViewport. Internal and output processing is usually done in decimils (or whatever unit the effective engine class need to use)

Definition at line 120 of file plotter.h.

Constructor & Destructor Documentation

◆ PLOTTER()

PLOTTER::PLOTTER ( const PROJECT * aProject = nullptr )

Definition at line 48 of file plotter.cpp.

References m_colorMode, m_currentPenWidth, m_iuPerDeviceUnit, m_IUsPerDecimil, m_mirrorIsHorizontal, m_negativeMode, m_outputFile, m_penState, m_plotMirror, m_plotScale, m_project, m_renderSettings, and m_yaxisReversed.

Referenced by PSLIKE_PLOTTER::PSLIKE_PLOTTER().

◆ ~PLOTTER()

PLOTTER::~PLOTTER ( )

virtual

Definition at line 68 of file plotter.cpp.

References m_outputFile.

Member Function Documentation

◆ AddLineToHeader()

void PLOTTER::AddLineToHeader ( const wxString & aExtraString )

inline

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

Parameters

aExtraString is the string to print

Definition at line 183 of file plotter.h.

References m_headerExtraLines.

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

◆ Arc() [1/2]

void PLOTTER::Arc	(	const VECTOR2D &	aCenter,
		const EDA_ANGLE &	aStartAngle,
		const EDA_ANGLE &	aAngle,
		double	aRadius,
		FILL_T	aFill,
		int	aWidth )

virtual

Reimplemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Definition at line 175 of file plotter.cpp.

References polyArc().

◆ Arc() [2/2]

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

virtual

Definition at line 151 of file plotter.cpp.

References Arc(), CalcArcCenter(), cw, EDA_ANGLE::Normalize(), EDA_ANGLE::NormalizeNegative(), and radius.

Referenced by Arc(), SCH_SHAPE::Plot(), ThickArc(), and ThickOval().

◆ BezierCurve()

void PLOTTER::BezierCurve	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aControl1,
		const VECTOR2I &	aControl2,
		const VECTOR2I &	aEnd,
		int	aTolerance,
		int	aLineThickness )

virtual

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

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

Referenced by SVG_PLOTTER::BezierCurve().

◆ Bookmark()

virtual void PLOTTER::Bookmark	(	const BOX2I &	aBox,
		const wxString &	aName,
		const wxString &	aGroupName = wxEmptyString )

inlinevirtual

Create a bookmark to a symbol.

Parameters

aBox	is the rectangular click target
aSymbolReference	is the symbol schematic ref

Reimplemented in PDF_PLOTTER.

Definition at line 483 of file plotter.h.

Referenced by SCH_LABEL_BASE::Plot(), SCH_SYMBOL::Plot(), and PlotInteractiveLayer().

◆ Circle()

virtual void PLOTTER::Circle	(	const VECTOR2I &	pos,
		int	diametre,
		FILL_T	fill,
		int	width )

pure virtual

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Referenced by FilledCircle(), PSLIKE_PLOTTER::FlashPadCircle(), markerCircle(), SCH_JUNCTION::Plot(), SCH_SHAPE::Plot(), PlotLayerOutlines(), SCH_PIN::PlotPinType(), ThickCircle(), and ThickSegment().

◆ ClearHeaderLinesList()

void PLOTTER::ClearHeaderLinesList ( )

inline

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.

References m_headerExtraLines.

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

◆ EndBlock()

virtual void PLOTTER::EndBlock ( void * aData )

inlinevirtual

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

aData can define any parameter for most of plotters: do nothing

Reimplemented in GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 554 of file plotter.h.

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

◆ EndPlot()

virtual bool PLOTTER::EndPlot ( )

pure virtual

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Referenced by GENDRILL_WRITER_BASE::genDrillMapFile(), PCBNEW_JOBS_HANDLER::JobExportGerber(), and PCB_PLOTTER::Plot().

◆ FilledCircle()

void PLOTTER::FilledCircle	(	const VECTOR2I &	pos,
		int	diametre,
		void *	aData )

virtual

Reimplemented in DXF_PLOTTER, and GERBER_PLOTTER.

Definition at line 598 of file plotter.cpp.

References Circle(), and FILLED_SHAPE.

Referenced by SCH_LABEL_BASE::Plot().

◆ FinishTo()

void PLOTTER::FinishTo ( const VECTOR2I & pos )

inline

◆ FlashPadCircle()

virtual void PLOTTER::FlashPadCircle	(	const VECTOR2I &	aPadPos,
		int	aDiameter,
		void *	aData )

pure virtual

Parameters

aPadPos	Position of the shape (center of the rectangle.
aDiameter	is the diameter of round pad.
aData	is an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

Referenced by PlotStandardLayer().

◆ FlashPadCustom()

virtual void PLOTTER::FlashPadCustom	(	const VECTOR2I &	aPadPos,
		const VECTOR2I &	aSize,
		const EDA_ANGLE &	aPadOrient,
		SHAPE_POLY_SET *	aPolygons,
		void *	aData )

pure virtual

Parameters

aPadPos	Position of the shape.
aSize	is the size of round reference pad.
aPadOrient	is the pad rotation, used only with aperture macros (Gerber plotter).
aPolygons	the shape as polygon set.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

◆ FlashPadOval()

virtual void PLOTTER::FlashPadOval	(	const VECTOR2I &	aPadPos,
		const VECTOR2I &	aSize,
		const EDA_ANGLE &	aPadOrient,
		void *	aData )

pure virtual

Parameters

aPadPos	Position of the shape (center of the rectangle.
aSize	is the size of oblong shape.
aPadOrient	The rotation of the shape.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

◆ FlashPadRect()

virtual void PLOTTER::FlashPadRect	(	const VECTOR2I &	aPadPos,
		const VECTOR2I &	aSize,
		const EDA_ANGLE &	aPadOrient,
		void *	aData )

pure virtual

Parameters

aPadPos	Position of the shape (center of the rectangle).
aSize	is the size of rounded rect.
aPadOrient	The rotation of the shape.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

◆ FlashPadRoundRect()

virtual void PLOTTER::FlashPadRoundRect	(	const VECTOR2I &	aPadPos,
		const VECTOR2I &	aSize,
		int	aCornerRadius,
		const EDA_ANGLE &	aOrient,
		void *	aData )

pure virtual

Parameters

aPadPos	Position of the shape (center of the rectangle.
aSize	is the size of rounded rect.
aCornerRadius	Radius of the rounded corners.
aOrient	The rotation of the shape.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

◆ FlashPadTrapez()

virtual void PLOTTER::FlashPadTrapez	(	const VECTOR2I &	aPadPos,
		const VECTOR2I *	aCorners,
		const EDA_ANGLE &	aPadOrient,
		void *	aData )

pure virtual

Flash a trapezoidal pad.

Parameters

aPadPos	is the the position of the shape.
aCorners	is the list of 4 corners positions, relative to the shape position, pad orientation 0.
aPadOrient	is the rotation of the shape.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

◆ FlashRegularPolygon()

virtual void PLOTTER::FlashRegularPolygon	(	const VECTOR2I &	aShapePos,
		int	aDiameter,
		int	aCornerCount,
		const EDA_ANGLE &	aOrient,
		void *	aData )

pure virtual

Flash a regular polygon.

Useful only in Gerber files to flash a regular polygon.

Parameters

aShapePos	is the center of the circle containing the polygon.
aRadius	is the radius of the circle containing the polygon.
aCornerCount	is the number of vertices.
aOrient	is the polygon rotation.
aData	is a auxiliary parameter used (if needed) to handle extra info specific to the plotter.

Implemented in DXF_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

References KIFONT::METRICS::Default().

◆ GetColorMode()

bool PLOTTER::GetColorMode ( ) const

inline

◆ GetCurrentLineWidth()

virtual int PLOTTER::GetCurrentLineWidth ( ) const

inlinevirtual

Definition at line 167 of file plotter.h.

References m_currentPenWidth.

Referenced by GERBER_PLOTTER::Arc(), PDF_PLOTTER::Arc(), SVG_PLOTTER::Arc(), SVG_PLOTTER::BezierCurve(), PDF_PLOTTER::Circle(), PS_PLOTTER::Circle(), SVG_PLOTTER::Circle(), markerCircle(), markerLozenge(), markerSquare(), SVG_PLOTTER::PenTo(), PS_PLOTTER::PlotPoly(), PS_PLOTTER::Rect(), SVG_PLOTTER::Rect(), PS_PLOTTER::SetCurrentLineWidth(), PS_PLOTTER::Text(), and SVG_PLOTTER::Text().

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( int aLineWidth ) const

protected

Definition at line 145 of file plotter.cpp.

References m_renderSettings, and userToDeviceSize().

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

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( int aLineWidth ) const

protected

Definition at line 139 of file plotter.cpp.

References m_renderSettings, and userToDeviceSize().

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

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( int aLineWidth ) const

protected

Definition at line 133 of file plotter.cpp.

References m_renderSettings, and userToDeviceSize().

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

◆ GetIUsPerDecimil()

double PLOTTER::GetIUsPerDecimil ( ) const

inline

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.

References m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetPlotMirrored()

bool PLOTTER::GetPlotMirrored ( ) const

inline

Definition at line 158 of file plotter.h.

References m_plotMirror.

◆ GetPlotOffsetUserUnits()

VECTOR2I PLOTTER::GetPlotOffsetUserUnits ( )

inline

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

Definition at line 559 of file plotter.h.

References m_plotOffset.

Referenced by PlotInteractiveLayer().

◆ GetPlotterArcHighDef()

int PLOTTER::GetPlotterArcHighDef ( ) const

inline

Definition at line 228 of file plotter.h.

References m_IUsPerDecimil.

Referenced by GERBER_PLOTTER::FlashPadChamferRoundRect(), DXF_PLOTTER::FlashPadRoundRect(), PSLIKE_PLOTTER::FlashPadRoundRect(), DXF_PLOTTER::PlotPoly(), DXF_PLOTTER::ThickPoly(), and DXF_PLOTTER::ThickSegment().

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const

inline

Definition at line 227 of file plotter.h.

References m_IUsPerDecimil.

◆ GetPlotterType()

virtual PLOT_FORMAT PLOTTER::GetPlotterType ( ) const

pure virtual

Return 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

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

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

◆ HyperlinkBox()

virtual void PLOTTER::HyperlinkBox	(	const BOX2I &	aBox,
		const wxString &	aDestinationURL )

inlinevirtual

Create a clickable hyperlink with a rectangular click area.

Parameters

aBox	is the rectangular click target
aDestinationURL	is the target URL

Reimplemented in PDF_PLOTTER.

Definition at line 461 of file plotter.h.

Referenced by SCH_LABEL_BASE::Plot(), SCH_SHEET::Plot(), SCH_TEXT::Plot(), and SCH_TEXTBOX::Plot().

◆ HyperlinkMenu()

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

inlinevirtual

Create a clickable hyperlink menu with a rectangular click area.

Parameters

aBox	is the rectangular click target
aDestURLs	is the target URL

Reimplemented in PDF_PLOTTER.

Definition at line 472 of file plotter.h.

Referenced by SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_SHEET::Plot(), SCH_SYMBOL::Plot(), and PlotInteractiveLayer().

◆ LineTo()

void PLOTTER::LineTo ( const VECTOR2I & pos )

inline

◆ Marker()

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

Draw a pattern shape number aShapeId, to coord position.

Parameters

aPosition	is the position of the marker.
aDiameter	is the diameter of the marker.
aShapeId	is the index (used to generate forms characters).

Definition at line 364 of file plotter.cpp.

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

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

◆ markerBackSlash()

void PLOTTER::markerBackSlash	(	const VECTOR2I &	pos,
		int	radius )

protected

Plot a \ bar centered on the position.

Building block for markers

Definition at line 350 of file plotter.cpp.

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

Referenced by Marker().

◆ markerCircle()

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

protected

Plot a circle centered on the position.

Building block for markers

Definition at line 303 of file plotter.cpp.

References Circle(), GetCurrentLineWidth(), NO_FILL, and radius.

Referenced by Marker().

◆ markerHBar()

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

protected

Plot a - bar centered on the position.

Building block for markers

Definition at line 336 of file plotter.cpp.

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

Referenced by Marker().

◆ markerLozenge()

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

protected

Plot a lozenge centered on the position.

Building block for markers

Definition at line 309 of file plotter.cpp.

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

Referenced by Marker().

◆ markerSlash()

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

protected

Plot a / bar centered on the position.

Building block for markers

Definition at line 343 of file plotter.cpp.

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

Referenced by Marker().

◆ markerSquare()

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

protected

Plot a square centered on the position.

Building block for markers

Definition at line 275 of file plotter.cpp.

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

Referenced by Marker().

◆ markerVBar()

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

protected

Plot a | bar centered on the position.

Building block for markers

Definition at line 357 of file plotter.cpp.

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

Referenced by Marker().

◆ MoveTo()

void PLOTTER::MoveTo ( const VECTOR2I & pos )

inline

◆ OpenFile()

bool PLOTTER::OpenFile ( const wxString & aFullFilename )

virtual

Open or create the plot file aFullFilename.

Parameters

aFullFilename is the full file name of the file to create.

Returns: true if success, false if the file cannot be created/opened.

Virtual because some plotters use ascii files, some others binary files (PDF) The base class open the file in text mode

Reimplemented in PDF_PLOTTER.

Definition at line 76 of file plotter.cpp.

References m_filename, and m_outputFile.

Referenced by GERBER_WRITER::createDrillFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), GERBER_WRITER::createProtectionFile(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), StartPlotBoard(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ PageSettings()

PAGE_INFO & PLOTTER::PageSettings ( )

inline

Definition at line 155 of file plotter.h.

References m_pageInfo.

◆ PenFinish()

void PLOTTER::PenFinish ( )

inline

Definition at line 278 of file plotter.h.

References PenTo().

Referenced by PDF_PLOTTER::drawOverbars(), SCH_LABEL_BASE::Plot(), DXF_PLOTTER::PlotPoly(), GERBER_PLOTTER::PlotPoly(), GERBER_PLOTTER::PlotPoly(), PlotText(), and Text().

◆ PenTo()

virtual void PLOTTER::PenTo	(	const VECTOR2I &	pos,
		char	plume )

pure virtual

Moveto/lineto primitive, moves the 'pen' to the specified direction.

Parameters

pos	is the target position.
plume	specifies 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).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Referenced by FinishTo(), LineTo(), MoveTo(), and PenFinish().

◆ PlotImage()

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

virtual

Only PostScript plotters can plot bitmaps.

A rectangle is plotted for plotters that cannot plot a bitmap.

Parameters

aImage	is the bitmap.
aPos	is position of the center of the bitmap.
aScaleFactor	is the scale factor to apply to the bitmap size (this is not the plot scale factor).

Reimplemented in PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Definition at line 259 of file plotter.cpp.

References end, NO_FILL, Rect(), USE_DEFAULT_LINE_WIDTH, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BITMAP_BASE::PlotImage(), and SVG_PLOTTER::PlotImage().

◆ PlotPoly() [1/2]

void PLOTTER::PlotPoly	(	const SHAPE_LINE_CHAIN &	aCornerList,
		FILL_T	aFill,
		int	aWidth,
		void *	aData )

virtual

Draw a polygon ( filled or not ).

Parameters

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

Reimplemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, and PS_PLOTTER.

Definition at line 610 of file plotter.cpp.

References SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::IsClosed(), PlotPoly(), and SHAPE_LINE_CHAIN::PointCount().

◆ PlotPoly() [2/2]

virtual void PLOTTER::PlotPoly	(	const std::vector< VECTOR2I > &	aCornerList,
		FILL_T	aFill,
		int	aWidth,
		void *	aData )

pure virtual

Draw a polygon ( filled or not ).

Parameters

aCornerList	is the corners list (a std::vector< VECTOR2I >).
aFill	is the type of fill.
aWidth	is the line width.
aData	is an auxiliary info (mainly for gerber format).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

References end.

Referenced by PSLIKE_PLOTTER::FlashPadCustom(), PSLIKE_PLOTTER::FlashPadRect(), PSLIKE_PLOTTER::FlashPadRoundRect(), PSLIKE_PLOTTER::FlashPadTrapez(), markerLozenge(), markerSquare(), SCH_LABEL_BASE::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), PlotDrawingSheet(), PlotLayerOutlines(), PlotPoly(), PlotText(), Text(), DXF_PLOTTER::ThickPoly(), and ThickPoly().

◆ PlotText()

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

virtual

Reimplemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Definition at line 695 of file plotter.cpp.

References KIFONT::FONT::Draw(), EXPRESSION_EVALUATOR::Evaluate(), FILLED_SHAPE, KIFONT::FONT::GetFont(), GetPenSizeForBold(), LineTo(), TEXT_ATTRIBUTES::m_Bold, m_renderSettings, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, MoveTo(), PenFinish(), PlotPoly(), SetColor(), SetCurrentLineWidth(), text, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_PIN::PlotPinTexts(), DXF_PLOTTER::PlotText(), GERBER_PLOTTER::PlotText(), and PS_PLOTTER::PlotText().

◆ polyArc()

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

protectedvirtual

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

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

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

◆ Rect()

virtual void PLOTTER::Rect	(	const VECTOR2I &	p1,
		const VECTOR2I &	p2,
		FILL_T	fill,
		int	width,
		int	aCornerRadius = 0 )

pure virtual

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Referenced by FillNegativeKnockout(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), PlotImage(), SCH_PLOTTER::plotOneSheetPDF(), plotPdfBackground(), and ThickRect().

◆ RenderSettings()

RENDER_SETTINGS * PLOTTER::RenderSettings ( )

inline

◆ SetAuthor()

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

inlinevirtual

Definition at line 175 of file plotter.h.

References m_author.

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

◆ SetColor()

virtual void PLOTTER::SetColor ( const COLOR4D & color )

pure virtual

◆ SetColorMode()

virtual void PLOTTER::SetColorMode ( bool aColorMode )

inlinevirtual

Plot in B/W or color.

Parameters

aColorMode use true to plot in color, false to plot in black and white.

Definition at line 148 of file plotter.h.

References m_colorMode.

Referenced by SCH_PLOTTER::createPDFFile(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), GENDRILL_WRITER_BASE::genDrillMapFile(), initializePlotter(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ SetCreator()

virtual void PLOTTER::SetCreator ( const wxString & aCreator )

inlinevirtual

Definition at line 173 of file plotter.h.

References m_creator.

Referenced by GERBER_WRITER::createDrillFile(), SCH_PLOTTER::createPDFFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), GERBER_WRITER::createProtectionFile(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), GENDRILL_WRITER_BASE::genDrillMapFile(), initializePlotter(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ SetCurrentLineWidth()

virtual void PLOTTER::SetCurrentLineWidth	(	int	width,
		void *	aData = nullptr )

pure virtual

Set the line width for the next drawing.

Parameters

width	is specified in IUs.
aData	is an auxiliary parameter, mainly used in gerber plotter.

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Referenced by BezierCurve(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_RULE_AREA::Plot(), SCH_SCREEN::Plot(), SCH_SHAPE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), PlotDrawingSheet(), GENDRILL_WRITER_BASE::plotDrillMarks(), BITMAP_BASE::PlotImage(), SCH_PIN::PlotPinTexts(), SCH_PIN::PlotPinType(), PlotText(), polyArc(), Text(), ThickOval(), and ThickSegment().

◆ SetDash()

virtual void PLOTTER::SetDash	(	int	aLineWidth,
		LINE_STYLE	aLineStyle )

pure virtual

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

Referenced by SCH_BUS_ENTRY_BASE::Plot(), SCH_LINE::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), and SCH_TABLE::Plot().

◆ SetGerberCoordinatesFormat()

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

inlinevirtual

Reimplemented in GERBER_PLOTTER.

Definition at line 527 of file plotter.h.

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

◆ SetLayerPolarity()

virtual void PLOTTER::SetLayerPolarity ( bool aPositive )

inlinevirtual

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

aPositive is 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 512 of file plotter.h.

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool aNegative )

inlinevirtual

Definition at line 141 of file plotter.h.

References m_negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

virtual void PLOTTER::SetPageSettings ( const PAGE_INFO & aPageSettings )

inlinevirtual

Definition at line 154 of file plotter.h.

References m_pageInfo.

Referenced by EESCHEMA_JOBS_HANDLER::doSymExportSvg(), GENDRILL_WRITER_BASE::genDrillMapFile(), initializePlotter(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), SCH_PLOTTER::setupPlotPagePDF(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ SetPlotMirrored()

void PLOTTER::SetPlotMirrored ( bool aMirror )

inline

Definition at line 157 of file plotter.h.

References m_plotMirror.

◆ SetRenderSettings()

void PLOTTER::SetRenderSettings ( RENDER_SETTINGS * aSettings )

inline

Definition at line 151 of file plotter.h.

References m_renderSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_PLOTTER::createPDFFile(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), StartPlotBoard(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ SetSubject()

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

inlinevirtual

Definition at line 176 of file plotter.h.

References m_subject.

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

◆ SetSvgCoordinatesFormat()

virtual void PLOTTER::SetSvgCoordinatesFormat ( unsigned aPrecision )

inlinevirtual

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

Reimplemented in SVG_PLOTTER.

Definition at line 533 of file plotter.h.

Referenced by initializePlotter().

◆ SetTextMode()

virtual void PLOTTER::SetTextMode ( PLOT_TEXT_MODE mode )

inlinevirtual

Change the current text mode.

See the PlotTextMode explanation at the beginning of the file.

Reimplemented in DXF_PLOTTER, and PSLIKE_PLOTTER.

Definition at line 522 of file plotter.h.

Referenced by initializePlotter(), and PlotOneBoardLayer().

◆ SetTitle()

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

inlinevirtual

Definition at line 174 of file plotter.h.

References m_title.

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

◆ SetViewport()

virtual void PLOTTER::SetViewport	(	const VECTOR2I &	aOffset,
		double	aIusPerDecimil,
		double	aScale,
		bool	aMirror )

pure virtual

Set the plot offset and scaling for the current plot.

Parameters

aOffset	is the plot offset.
aIusPerDecimil	gives the scaling factor from IUs to device units
aScale	is the user set plot scaling factor (either explicitly or using 'fit to A4').
aMirror	flips the plot in the Y direction (useful for toner transfers or some kind of film).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

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

◆ StartBlock()

virtual void PLOTTER::StartBlock ( void * aData )

inlinevirtual

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

aData can define any parameter for most of plotters: do nothing

Reimplemented in GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 545 of file plotter.h.

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

◆ StartPlot()

virtual bool PLOTTER::StartPlot ( const wxString & aPageNumber )

pure virtual

Implemented in DXF_PLOTTER, GERBER_PLOTTER, PDF_PLOTTER, PS_PLOTTER, and SVG_PLOTTER.

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

◆ Text()

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

virtual

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

aPos	is the text position (according to aH_justify, aV_justify).
aColor	is the text color.
aText	is the text to draw.
aOrient	is the angle.
aSize	is the text size (size.x or size.y can be < 0 for mirrored texts).
aH_justify	is the horizontal justification (Left, center, right).
aV_justify	is the vertical justification (bottom, center, top).
aPenWidth	is the line width (if = 0, use plot default line width).
aItalic	is the true to simulate an italic font.
aBold	use true to use a bold font Useful only with default width value (aPenWidth = 0).
aMultilineAllowed	use true to plot text as multiline, otherwise single line.
aData	is a parameter used by some plotters in SetCurrentLineWidth(), not directly used here.