Base plotter engine class. More...

#include <plotter.h>

Inheritance diagram for PLOTTER:

Public Member Functions
	PLOTTER ()

virtual	~PLOTTER ()

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

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

bool	GetColorMode () const

void	SetRenderSettings (RENDER_SETTINGS *aSettings)

RENDER_SETTINGS *	RenderSettings ()

virtual void	SetPageSettings (const PAGE_INFO &aPageSettings)

PAGE_INFO &	PageSettings ()

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

virtual int	GetCurrentLineWidth () const

virtual void	SetColor (const COLOR4D &color)=0

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

virtual void	SetCreator (const wxString &aCreator)

virtual void	SetTitle (const wxString &aTitle)

void	AddLineToHeader (const wxString &aExtraString)
	Add a line to the list of free lines to print at the beginning of the file. More...

void	ClearHeaderLinesList ()
	Remove all lines from the list of free lines to print at the beginning of the file. More...

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

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

double	GetIUsPerDecimil () const
	The IUs per decimil are an essential scaling factor when plotting; they are set and saved when establishing the viewport. More...

int	GetPlotterArcLowDef () const

int	GetPlotterArcHighDef () const

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

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

virtual void	Arc (const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aEnd, FILL_T aFill, int aWidth, int aMaxError)
	Generic fallback: arc rendered as a polyline. More...

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

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

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=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
	Draw a polygon ( filled or not ). More...

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

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

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

virtual void	ThickArc (const VECTOR2I &aCentre, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aWidth, OUTLINE_MODE aTraceMode, void *aData)

virtual void	ThickArc (const EDA_SHAPE &aArcShape, 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)

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

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

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

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

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

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

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

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, void aData=nullptr)
	Draw text with the plotter. More...

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

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

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

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

void	Marker (const VECTOR2I &position, int diametre, unsigned aShapeId)
	Draw a pattern shape number aShapeId, to coord position. More...

virtual void	SetLayerPolarity (bool aPositive)
	Set the current Gerber layer polarity to positive or negative by writing %LPD% or %LPC% to the Gerber file, respectively. More...

virtual void	SetTextMode (PLOT_TEXT_MODE mode)
	Change the current text mode. More...

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

virtual void	StartBlock (void *aData)
	calling this function allows one to define the beginning of a group of drawing items, for instance in SVG or Gerber format. More...

virtual void	EndBlock (void *aData)
	calling this function allows one to define the end of a group of drawing items for instance in SVG or Gerber format. More...

Static Public Attributes
static const int	DO_NOT_SET_LINE_WIDTH = -2

static const int	USE_DEFAULT_LINE_WIDTH = -1

static const unsigned	MARKER_COUNT = 58
	Draw a marker (used for the drill map). More...

Protected Member Functions
virtual void	Arc (const VECTOR2I &aCentre, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aEndAngle, int aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)
	Generic fallback: arc rendered as a polyline. More...

virtual void	ThickArc (const VECTOR2I &aCentre, const EDA_ANGLE &StAngle, const EDA_ANGLE &EndAngle, int aRadius, int aWidth, OUTLINE_MODE aTraceMode, void *aData)

void	markerCircle (const VECTOR2I &pos, int radius)
	Plot a circle centered on the position. More...

void	markerHBar (const VECTOR2I &pos, int radius)
	Plot a - bar centered on the position. More...

void	markerSlash (const VECTOR2I &pos, int radius)
	Plot a / bar centered on the position. More...

void	markerBackSlash (const VECTOR2I &pos, int radius)
	Plot a \ bar centered on the position. More...

void	markerVBar (const VECTOR2I &pos, int radius)
	Plot a \| bar centered on the position. More...

void	markerSquare (const VECTOR2I &position, int radius)
	Plot a square centered on the position. More...

void	markerLozenge (const VECTOR2I &position, int radius)
	Plot a lozenge centered on the position. More...

void	segmentAsOval (const VECTOR2I &start, const VECTOR2I &end, int width, OUTLINE_MODE tracemode)
	Convert a thick segment and plot it as an oval. More...

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

virtual VECTOR2D	userToDeviceSize (const VECTOR2I &size)
	Modify size according to the plotter scale factors (VECTOR2I version, returns a VECTOR2D). More...

virtual double	userToDeviceSize (double size) const
	Modify size according to the plotter scale factors (simple double version). More...

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

double	m_IUsPerDecimil

double	m_iuPerDeviceUnit

VECTOR2I	m_plotOffset

bool	m_plotMirror

bool	m_mirrorIsHorizontal

bool	m_yaxisReversed

FILE *	m_outputFile
	Output file. More...

bool	m_colorMode

bool	m_negativeMode

int	m_currentPenWidth

char	m_penState

VECTOR2I	m_penLastpos

wxString	m_creator

wxString	m_filename

wxString	m_title

PAGE_INFO	m_pageInfo

VECTOR2I	m_paperSize

wxArrayString	m_headerExtraLines

RENDER_SETTINGS *	m_renderSettings

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

Constructor & Destructor Documentation

◆ PLOTTER()

PLOTTER::PLOTTER ( )

Definition at line 47 of file plotter.cpp.

{
 m_plotScale = 1;
 m_currentPenWidth = -1; // To-be-set marker
 m_penState = 'Z'; // End-of-path idle
 m_plotMirror = false; // Plot mirror option flag
 m_mirrorIsHorizontal = true;
 m_yaxisReversed = false;
 m_outputFile = nullptr;
 m_colorMode = false; // Starts as a BW plot
 m_negativeMode = false;
 
 // Temporary init to avoid not initialized vars, will be set later
 m_IUsPerDecimil = 1; // will be set later to the actual value
 m_iuPerDeviceUnit = 1; // will be set later to the actual value
 m_renderSettings = nullptr;
}

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

◆ ~PLOTTER()

PLOTTER::~PLOTTER ( )

virtual

Definition at line 66 of file plotter.cpp.

{
 // Emergency cleanup, but closing the file is usually made in EndPlot().
 if( m_outputFile )
 fclose( m_outputFile );
}

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

 {
 m_headerExtraLines.Add( aExtraString );
 }

References m_headerExtraLines.

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

◆ Arc() [1/2]

void PLOTTER::Arc	(	const VECTOR2I &	aCenter,
		const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		FILL_T	aFill,
		int	aWidth,
		int	aMaxError
	)

virtual

Generic fallback: arc rendered as a polyline.

Reimplemented in HPGL_PLOTTER, PS_PLOTTER, and PDF_PLOTTER.

Definition at line 149 of file plotter.cpp.

{
 EDA_ANGLE startAngle( aStart - aCenter );
 EDA_ANGLE endAngle( aEnd - aCenter );
 int radius = ( aStart - aCenter ).EuclideanNorm();
 
 if( startAngle > endAngle )
 {
 if( endAngle < ANGLE_0 )
 endAngle.Normalize();
 else
 startAngle = startAngle.Normalize() - ANGLE_360;
 }
 
 // In old Kicad code, calls to Arc() using angles calls this function after
 // swapping angles and negate them (to compensate the inverted Y axis).
 // So to be compatible with Arc() calls with angles, do the same thing
 std::swap( startAngle, endAngle );
 startAngle = -startAngle;
 endAngle = -endAngle;
 
 Arc( aCenter, startAngle, endAngle, radius, aFill, aWidth );
}

References ANGLE_0, ANGLE_360, Arc(), EuclideanNorm(), and EDA_ANGLE::Normalize().

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

◆ Arc() [2/2]

void PLOTTER::Arc	(	const VECTOR2I &	aCentre,
		const EDA_ANGLE &	aStartAngle,
		const EDA_ANGLE &	aEndAngle,
		int	aRadius,
		FILL_T	aFill,
		int	aWidth = `USE_DEFAULT_LINE_WIDTH`
	)

protectedvirtual

Generic fallback: arc rendered as a polyline.

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

Definition at line 175 of file plotter.cpp.

{
 EDA_ANGLE startAngle( aStartAngle );
 EDA_ANGLE endAngle( aEndAngle );
 const EDA_ANGLE delta( 5.0, DEGREES_T ); // increment to draw arc
 VECTOR2I start, end;
 const int sign = -1;
 
 if( startAngle > endAngle )
 std::swap( startAngle, endAngle );
 
 SetCurrentLineWidth( aWidth );
 
 start.x = aCenter.x + KiROUND( aRadius * startAngle.Cos() );
 start.y = aCenter.y + sign*KiROUND( aRadius * startAngle.Sin() );
 
 if( aFill != FILL_T::NO_FILL )
 {
 MoveTo( aCenter );
 LineTo( start );
 }
 else
 {
 MoveTo( start );
 }
 
 for( EDA_ANGLE ii = startAngle + delta; ii < endAngle; ii += delta )
 {
 end.x = aCenter.x + KiROUND( aRadius * ii.Cos() );
 end.y = aCenter.y + sign*KiROUND( aRadius * ii.Sin() );
 LineTo( end );
 }
 
 end.x = aCenter.x + KiROUND( aRadius * endAngle.Cos() );
 end.y = aCenter.y + sign*KiROUND( aRadius * endAngle.Sin() );
 
 if( aFill != FILL_T::NO_FILL )
 {
 LineTo( end );
 FinishTo( aCenter );
 }
 else
 {
 FinishTo( end );
 }
}

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

◆ BezierCurve()

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

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

{
 // Generic fallback: Quadratic Bezier curve plotted as a polyline
 int minSegLen = aLineThickness; // The segment min length to approximate a bezier curve
 
 std::vector<VECTOR2I> ctrlPoints;
 ctrlPoints.reserve( 4 );
 
 ctrlPoints.push_back( aStart );
 ctrlPoints.push_back( aControl1 );
 ctrlPoints.push_back( aControl2 );
 ctrlPoints.push_back( aEnd );
 
 BEZIER_POLY bezier_converter( ctrlPoints );
 
 std::vector<VECTOR2I> approxPoints;
 bezier_converter.GetPoly( approxPoints, minSegLen );
 
 SetCurrentLineWidth( aLineThickness );
 MoveTo( aStart );
 
 for( unsigned ii = 1; ii < approxPoints.size()-1; ii++ )
 LineTo( approxPoints[ii] );
 
 FinishTo( aEnd );
}

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

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

◆ Bookmark()

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

inlinevirtual

Create a bookmark to a symbol.

@aBox is the bounding box of the symbol @aSymbolReference is the symbol schematic ref

Reimplemented in PDF_PLOTTER.

Definition at line 477 of file plotter.h.

 {
 // NOP for most plotters.
 }

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

◆ Circle()

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

pure virtual

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

Referenced by FilledCircle(), PSLIKE_PLOTTER::FlashPadCircle(), markerCircle(), SCH_JUNCTION::Plot(), SCH_SHAPE::Plot(), LIB_SHAPE::Plot(), PlotLayerOutlines(), LIB_PIN::PlotSymbol(), 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 176 of file plotter.h.

 {
 m_headerExtraLines.Clear();
 }

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

547{}

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

◆ EndPlot()

virtual bool PLOTTER::EndPlot ( )

pure virtual

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

Referenced by PLOT_CONTROLLER::ClosePlot(), GENDRILL_WRITER_BASE::genDrillMapFile(), and DIALOG_PLOT::Plot().

◆ FilledCircle()

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

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 668 of file plotter.cpp.

{
 if( tracemode == FILLED )
 {
 Circle( pos, diametre, FILL_T::FILLED_SHAPE, 0 );
 }
 else
 {
 SetCurrentLineWidth( -1 );
 Circle( pos, diametre, FILL_T::NO_FILL, -1 );
 }
}

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

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

◆ FinishTo()

void PLOTTER::FinishTo ( const VECTOR2I & pos )

inline

Definition at line 257 of file plotter.h.

 {
 PenTo( pos, 'D' );
 PenTo( pos, 'Z' );
 }

References PenTo().

Referenced by Arc(), BezierCurve(), DXF_PLOTTER::FlashPadCustom(), DXF_PLOTTER::FlashPadRect(), DXF_PLOTTER::FlashPadRoundRect(), DXF_PLOTTER::FlashPadTrapez(), markerBackSlash(), markerHBar(), markerSlash(), markerVBar(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_SHAPE::Plot(), PlotDrawingSheet(), GERBER_PLOTTER::PlotPoly(), LIB_PIN::PlotSymbol(), DXF_PLOTTER::Rect(), sketchOval(), ThickSegment(), DXF_PLOTTER::ThickSegment(), GERBER_PLOTTER::ThickSegment(), and HPGL_PLOTTER::ThickSegment().

◆ FlashPadCircle()

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

pure virtual

Parameters

aPadPos	Position of the shape (center of the rectangle.
aDiameter	is the diameter of round pad.
aTraceMode	is the drawing mode, FILLED or SKETCH.
aData	is an auxiliary info (mainly for gerber format attributes).

Implemented in HPGL_PLOTTER, PSLIKE_PLOTTER, DXF_PLOTTER, and GERBER_PLOTTER.

Referenced by BRDITEMS_PLOTTER::plotOneDrillMark(), BRDITEMS_PLOTTER::PlotPad(), and PlotStandardLayer().

◆ FlashPadCustom()

virtual void PLOTTER::FlashPadCustom	(	const VECTOR2I &	aPadPos,
		const VECTOR2I &	aSize,
		const EDA_ANGLE &	aPadOrient,
		SHAPE_POLY_SET *	aPolygons,
		OUTLINE_MODE	aTraceMode,
		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.
aTraceMode	is the drawing mode, FILLED or SKETCH.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, HPGL_PLOTTER, PSLIKE_PLOTTER, and GERBER_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashPadOval()

virtual void PLOTTER::FlashPadOval	(	const VECTOR2I &	aPadPos,
		const VECTOR2I &	aSize,
		const EDA_ANGLE &	aPadOrient,
		OUTLINE_MODE	aTraceMode,
		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.
aTraceMode	is the drawing mode, FILLED or SKETCH.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in GERBER_PLOTTER, HPGL_PLOTTER, PSLIKE_PLOTTER, and DXF_PLOTTER.

Referenced by GENDRILL_WRITER_BASE::plotDrillMarks(), BRDITEMS_PLOTTER::plotOneDrillMark(), BRDITEMS_PLOTTER::PlotPad(), and segmentAsOval().

◆ FlashPadRect()

virtual void PLOTTER::FlashPadRect	(	const VECTOR2I &	aPadPos,
		const VECTOR2I &	aSize,
		const EDA_ANGLE &	aPadOrient,
		OUTLINE_MODE	aTraceMode,
		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.
aTraceMode	is the drawing mode, FILLED or SKETCH.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in GERBER_PLOTTER, HPGL_PLOTTER, PSLIKE_PLOTTER, and DXF_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashPadRoundRect()

virtual void PLOTTER::FlashPadRoundRect	(	const VECTOR2I &	aPadPos,
		const VECTOR2I &	aSize,
		int	aCornerRadius,
		const EDA_ANGLE &	aOrient,
		OUTLINE_MODE	aTraceMode,
		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.
aTraceMode	is the drawing mode, FILLED or SKETCH.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, HPGL_PLOTTER, and PSLIKE_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashPadTrapez()

virtual void PLOTTER::FlashPadTrapez	(	const VECTOR2I &	aPadPos,
		const VECTOR2I *	aCorners,
		const EDA_ANGLE &	aPadOrient,
		OUTLINE_MODE	aTraceMode,
		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.
aTraceMode	is the drawing mode, FILLED or SKETCH.
aData	an auxiliary info (mainly for gerber format attributes).

Implemented in DXF_PLOTTER, GERBER_PLOTTER, HPGL_PLOTTER, and PSLIKE_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashRegularPolygon()

virtual void PLOTTER::FlashRegularPolygon	(	const VECTOR2I &	aShapePos,
		int	aDiameter,
		int	aCornerCount,
		const EDA_ANGLE &	aOrient,
		OUTLINE_MODE	aTraceMode,
		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, HPGL_PLOTTER, and PSLIKE_PLOTTER.

◆ GetColorMode()

bool PLOTTER::GetColorMode ( ) const

inline

◆ GetCurrentLineWidth()

virtual int PLOTTER::GetCurrentLineWidth ( ) const

inlinevirtual

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( int aLineWidth ) const

protected

Definition at line 143 of file plotter.cpp.

{
 return userToDeviceSize( m_renderSettings->GetGapLength( aLineWidth ) );
}

References KIGFX::RENDER_SETTINGS::GetGapLength(), m_renderSettings, and userToDeviceSize().

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

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( int aLineWidth ) const

protected

Definition at line 137 of file plotter.cpp.

{
 return userToDeviceSize( m_renderSettings->GetDashLength( aLineWidth ) );
}

References KIGFX::RENDER_SETTINGS::GetDashLength(), m_renderSettings, and userToDeviceSize().

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

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( int aLineWidth ) const

protected

Definition at line 131 of file plotter.cpp.

{
 return userToDeviceSize( m_renderSettings->GetDotLength( aLineWidth ) );
}

References KIGFX::RENDER_SETTINGS::GetDotLength(), m_renderSettings, and userToDeviceSize().

Referenced by PS_PLOTTER::SetDash(), PDF_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 210 of file plotter.h.

210{ return m_IUsPerDecimil; }

References m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetPlotterArcHighDef()

int PLOTTER::GetPlotterArcHighDef ( ) const

inline

Definition at line 213 of file plotter.h.

213{ return m_IUsPerDecimil * 2; }

References m_IUsPerDecimil.

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

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const

inline

Definition at line 212 of file plotter.h.

212{ return m_IUsPerDecimil * 8; }

References m_IUsPerDecimil.

◆ GetPlotterType()

virtual PLOT_FORMAT PLOTTER::GetPlotterType ( ) const

pure virtual

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

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

Referenced by GENDRILL_WRITER_BASE::genDrillMapFile(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotFootprintShape(), PlotOneBoardLayer(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotPcbShape(), and StartPlotBoard().

◆ HyperlinkBox()

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

inlinevirtual

Create a clickable hyperlink with a rectangular click area.

@aBox is the rectangular click target @aDestinationURL is the target URL

Reimplemented in PDF_PLOTTER.

Definition at line 455 of file plotter.h.

 {
 // NOP for most plotters.
 }

Referenced by 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.

@aBox is the rectangular click target @aDestURLs is the list of target URLs for the menu

Reimplemented in PDF_PLOTTER.

Definition at line 466 of file plotter.h.

 {
 // NOP for most plotters.
 }

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

Definition at line 252 of file plotter.h.

 {
 PenTo( pos, 'D' );
 }

References PenTo().

Referenced by Arc(), BezierCurve(), DXF_PLOTTER::FlashPadCustom(), DXF_PLOTTER::FlashPadRect(), DXF_PLOTTER::FlashPadRoundRect(), DXF_PLOTTER::FlashPadTrapez(), SCH_SHAPE::Plot(), GERBER_PLOTTER::plotArc(), PlotDrawingSheet(), GERBER_PLOTTER::PlotPoly(), DXF_PLOTTER::PlotPoly(), HPGL_PLOTTER::PlotPoly(), GERBER_PLOTTER::plotRoundRectAsRegion(), LIB_PIN::PlotSymbol(), PlotText(), DXF_PLOTTER::Rect(), and Text().

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

{
 int radius = diametre / 2;
 
 /* Marker are composed by a series of 'parts' superimposed; not every
 combination make sense, obviously. Since they are used in order I
 tried to keep the uglier/more complex constructions at the end.
 Also I avoided the |/ |\ -/ -\ construction because they're *very*
 ugly... if needed they could be added anyway... I'd like to see
 a board with more than 58 drilling/slotting tools!
 If Visual C++ supported the 0b literals they would be optimally
 and easily encoded as an integer array. We have to do with octal */
 static const unsigned char marker_patterns[MARKER_COUNT] = {
 
 // Bit order: O Square Lozenge - | \ /
 // First choice: simple shapes
 0003, // X
 0100, // O
 0014, // +
 0040, // Sq
 0020, // Lz
 
 // Two simple shapes
 0103, // X O
 0017, // X +
 0043, // X Sq
 0023, // X Lz
 0114, // O +
 0140, // O Sq
 0120, // O Lz
 0054, // + Sq
 0034, // + Lz
 0060, // Sq Lz
 
 // Three simple shapes
 0117, // X O +
 0143, // X O Sq
 0123, // X O Lz
 0057, // X + Sq
 0037, // X + Lz
 0063, // X Sq Lz
 0154, // O + Sq
 0134, // O + Lz
 0074, // + Sq Lz
 
 // Four simple shapes
 0174, // O Sq Lz +
 0163, // X O Sq Lz
 0157, // X O Sq +
 0137, // X O Lz +
 0077, // X Sq Lz +
 
 // This draws *everything *
 0177, // X O Sq Lz +
 
 // Here we use the single bars... so the cross is forbidden
 0110, // O -
 0104, // O |
 0101, // O /
 0050, // Sq -
 0044, // Sq |
 0041, // Sq /
 0030, // Lz -
 0024, // Lz |
 0021, // Lz /
 0150, // O Sq -
 0144, // O Sq |
 0141, // O Sq /
 0130, // O Lz -
 0124, // O Lz |
 0121, // O Lz /
 0070, // Sq Lz -
 0064, // Sq Lz |
 0061, // Sq Lz /
 0170, // O Sq Lz -
 0164, // O Sq Lz |
 0161, // O Sq Lz /
 
 // Last resort: the backlash component (easy to confound)
 0102, // \ O
 0042, // \ Sq
 0022, // \ Lz
 0142, // \ O Sq
 0122, // \ O Lz
 0062, // \ Sq Lz
 0162 // \ O Sq Lz
 };
 
 if( aShapeId >= MARKER_COUNT )
 {
 // Fallback shape
 markerCircle( position, radius );
 }
 else
 {
 // Decode the pattern and draw the corresponding parts
 unsigned char pat = marker_patterns[aShapeId];
 
 if( pat & 0001 )
 markerSlash( position, radius );
 
 if( pat & 0002 )
 markerBackSlash( position, radius );
 
 if( pat & 0004 )
 markerVBar( position, radius );
 
 if( pat & 0010 )
 markerHBar( position, radius );
 
 if( pat & 0020 )
 markerLozenge( position, radius );
 
 if( pat & 0040 )
 markerSquare( position, radius );
 
 if( pat & 0100 )
 markerCircle( position, radius );
 }
}

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

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

{
 MoveTo( VECTOR2I( pos.x + radius, pos.y - radius ) );
 FinishTo( VECTOR2I( pos.x - radius, pos.y + radius ) );
}

References FinishTo(), MoveTo(), 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 298 of file plotter.cpp.

{
 Circle( position, radius * 2, FILL_T::NO_FILL, GetCurrentLineWidth() );
}

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

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

{
 MoveTo( VECTOR2I( pos.x - radius, pos.y ) );
 FinishTo( VECTOR2I( pos.x + radius, pos.y ) );
}

References FinishTo(), MoveTo(), 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 304 of file plotter.cpp.

{
 std::vector<VECTOR2I> corner_list;
 VECTOR2I corner;
 
 corner_list.reserve( 4 );
 
 corner.x = position.x;
 corner.y = position.y + radius;
 corner_list.push_back( corner );
 corner.x = position.x + radius;
 corner.y = position.y,
 corner_list.push_back( corner );
 corner.x = position.x;
 corner.y = position.y - radius;
 corner_list.push_back( corner );
 corner.x = position.x - radius;
 corner.y = position.y;
 corner_list.push_back( corner );
 corner.x = position.x;
 corner.y = position.y + radius;
 corner_list.push_back( corner );
 
 PlotPoly( corner_list, FILL_T::NO_FILL, GetCurrentLineWidth() );
}

References GetCurrentLineWidth(), NO_FILL, PlotPoly(), 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 338 of file plotter.cpp.

{
 MoveTo( VECTOR2I( pos.x - radius, pos.y - radius ) );
 FinishTo( VECTOR2I( pos.x + radius, pos.y + radius ) );
}

References FinishTo(), MoveTo(), 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 270 of file plotter.cpp.

{
 double r = KiROUND( radius / 1.4142 );
 std::vector<VECTOR2I> corner_list;
 VECTOR2I corner;
 
 corner_list.reserve( 4 );
 
 corner.x = position.x + r;
 corner.y = position.y + r;
 corner_list.push_back( corner );
 corner.x = position.x + r;
 corner.y = position.y - r;
 corner_list.push_back( corner );
 corner.x = position.x - r;
 corner.y = position.y - r;
 corner_list.push_back( corner );
 corner.x = position.x - r;
 corner.y = position.y + r;
 corner_list.push_back( corner );
 corner.x = position.x + r;
 corner.y = position.y + r;
 corner_list.push_back( corner );
 
 PlotPoly( corner_list, FILL_T::NO_FILL, GetCurrentLineWidth() );
}

References GetCurrentLineWidth(), KiROUND(), NO_FILL, PlotPoly(), 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 352 of file plotter.cpp.

{
 MoveTo( VECTOR2I( pos.x, pos.y - radius ) );
 FinishTo( VECTOR2I( pos.x, pos.y + radius ) );
}

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

Referenced by Marker().

◆ MoveTo()

void PLOTTER::MoveTo ( const VECTOR2I & pos )

inline

Definition at line 247 of file plotter.h.

 {
 PenTo( pos, 'U' );
 }

References PenTo().

Referenced by Arc(), BezierCurve(), HPGL_PLOTTER::Circle(), HPGL_PLOTTER::FlashPadCircle(), DXF_PLOTTER::FlashPadCustom(), DXF_PLOTTER::FlashPadRect(), DXF_PLOTTER::FlashPadRoundRect(), DXF_PLOTTER::FlashPadTrapez(), markerBackSlash(), markerHBar(), markerSlash(), markerVBar(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_SHAPE::Plot(), GERBER_PLOTTER::plotArc(), PlotDrawingSheet(), GERBER_PLOTTER::PlotPoly(), DXF_PLOTTER::PlotPoly(), HPGL_PLOTTER::PlotPoly(), GERBER_PLOTTER::plotRoundRectAsRegion(), LIB_PIN::PlotSymbol(), PlotText(), HPGL_PLOTTER::Rect(), DXF_PLOTTER::Rect(), sketchOval(), Text(), ThickSegment(), DXF_PLOTTER::ThickSegment(), GERBER_PLOTTER::ThickSegment(), and HPGL_PLOTTER::ThickSegment().

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

{
 m_filename = aFullFilename;
 
 wxASSERT( !m_outputFile );
 
 // Open the file in text mode (not suitable for all plotters but only for most of them.
 m_outputFile = wxFopen( m_filename, wxT( "wt" ) );
 
 if( m_outputFile == nullptr )
 return false ;
 
 return true;
}

References m_filename, and m_outputFile.

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

◆ PageSettings()

PAGE_INFO & PLOTTER::PageSettings ( )

inline

Definition at line 144 of file plotter.h.

144{ return m_pageInfo; }

PLOTTER::m_pageInfo

PAGE_INFO m_pageInfo

Definition: plotter.h:665

References m_pageInfo.

Referenced by SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), and SCH_PLOTTER::plotOneSheetSVG().

◆ PenFinish()

void PLOTTER::PenFinish ( )

inline

Definition at line 263 of file plotter.h.

 {
 // The point is not important with Z motion
 PenTo( VECTOR2I( 0, 0 ), 'Z' );
 }

References PenTo().

Referenced by HPGL_PLOTTER::Circle(), HPGL_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::PlotPoly(), DXF_PLOTTER::PlotPoly(), HPGL_PLOTTER::PlotPoly(), PlotText(), HPGL_PLOTTER::Rect(), 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, HPGL_PLOTTER, PS_PLOTTER, PDF_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 PS_PLOTTER, PDF_PLOTTER, and SVG_PLOTTER.

Definition at line 254 of file plotter.cpp.

{
 VECTOR2I size( aImage.GetWidth() * aScaleFactor, aImage.GetHeight() * aScaleFactor );
 
 VECTOR2I start = aPos;
 start.x -= size.x / 2;
 start.y -= size.y / 2;
 
 VECTOR2I end = start;
 end.x += size.x;
 end.y += size.y;
 
 Rect( start, end, FILL_T::NO_FILL );
}

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

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

◆ PlotPoly() [1/2]

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

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

Definition at line 682 of file plotter.cpp.

{
 std::vector<VECTOR2I> cornerList;
 cornerList.reserve( aCornerList.PointCount() );
 
 for( int ii = 0; ii < aCornerList.PointCount(); ii++ )
 cornerList.emplace_back( aCornerList.CPoint( ii ) );
 
 if( aCornerList.IsClosed() && cornerList.front() != cornerList.back() )
 cornerList.emplace_back( aCornerList.CPoint( 0 ) );
 
 PlotPoly( cornerList, aFill, aWidth, aData );
}

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 = `USE_DEFAULT_LINE_WIDTH`,
		void *	aData = `nullptr`
	)

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, HPGL_PLOTTER, PS_PLOTTER, PDF_PLOTTER, and SVG_PLOTTER.

Referenced by PSLIKE_PLOTTER::FlashPadCustom(), PSLIKE_PLOTTER::FlashPadRect(), PSLIKE_PLOTTER::FlashPadRoundRect(), PSLIKE_PLOTTER::FlashPadTrapez(), markerLozenge(), markerSquare(), SCH_LABEL_BASE::Plot(), SCH_SHAPE::Plot(), LIB_SHAPE::Plot(), PlotDrawingSheet(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), PlotLayerOutlines(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbText(), PlotPoly(), PlotSolderMaskLayer(), PlotText(), and Text().

◆ PlotText()

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

virtual

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

Definition at line 758 of file plotter.cpp.

{
 KIGFX::GAL_DISPLAY_OPTIONS empty_opts;
 
 TEXT_ATTRIBUTES attributes = aAttributes;
 int penWidth = attributes.m_StrokeWidth;
 
 SetColor( aColor );
 SetCurrentLineWidth( penWidth, aData );
 
 if( penWidth == 0 && attributes.m_Bold ) // Use default values if aPenWidth == 0
 penWidth = GetPenSizeForBold( std::min( attributes.m_Size.x, attributes.m_Size.y ) );
 
 if( penWidth < 0 )
 penWidth = -penWidth;
 
 attributes.m_StrokeWidth = penWidth;
 
 CALLBACK_GAL callback_gal( empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 MoveTo( aPt1 );
 LineTo( aPt2 );
 PenFinish();
 },
 // Polygon callback
 [&]( const SHAPE_LINE_CHAIN& aPoly )
 {
 PlotPoly( aPoly, FILL_T::FILLED_SHAPE, 0, aData );
 } );
 
 if( !aFont )
 aFont = KIFONT::FONT::GetFont();
 
 aFont->Draw( &callback_gal, aText, aPos, attributes );
}

References KIFONT::FONT::Draw(), FILLED_SHAPE, KIFONT::FONT::GetFont(), GetPenSizeForBold(), LineTo(), TEXT_ATTRIBUTES::m_Bold, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, MoveTo(), PenFinish(), PlotPoly(), SetColor(), SetCurrentLineWidth(), 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(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_PIN::PlotPinTexts(), DXF_PLOTTER::PlotText(), GERBER_PLOTTER::PlotText(), and PS_PLOTTER::PlotText().

◆ Rect()

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

pure virtual

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

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

◆ RenderSettings()

RENDER_SETTINGS * PLOTTER::RenderSettings ( )

inline

Definition at line 141 of file plotter.h.

141{ return m_renderSettings; }

References m_renderSettings.

Referenced by PLOT_CONTROLLER::ClosePlot(), SCH_SCREEN::Plot(), SCH_BITMAP::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_SHAPE::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), LIB_SYMBOL::Plot(), DIALOG_PLOT::Plot(), PlotDrawingSheet(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), LIB_SYMBOL::PlotLibFields(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetHpgl(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_PIN::PlotPinTexts(), LIB_PIN::PlotSymbol(), and StartPlotBoard().

◆ segmentAsOval()

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

protected

Convert a thick segment and plot it as an oval.

Definition at line 481 of file plotter.cpp.

{
 VECTOR2I center( ( start.x + end.x ) / 2, ( start.y + end.y ) / 2 );
 VECTOR2I size( end.x - start.x, end.y - start.y );
 EDA_ANGLE orient( size );
 orient = -orient; // this is due to our Y axis orientation
 
 size.x = KiROUND( EuclideanNorm( size ) ) + aWidth;
 size.y = aWidth;
 
 FlashPadOval( center, size, orient, aTraceMode, nullptr );
}

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

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

◆ SetColor()

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

pure virtual

Implemented in GERBER_PLOTTER, DXF_PLOTTER, HPGL_PLOTTER, PSLIKE_PLOTTER, and SVG_PLOTTER.

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

137{ m_colorMode = aColorMode; }

References m_colorMode.

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

◆ SetCreator()

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

inlinevirtual

Definition at line 159 of file plotter.h.

159{ m_creator = aCreator; }

PLOTTER::m_creator

wxString m_creator

Definition: plotter.h:662

References m_creator.

Referenced by GERBER_WRITER::createDrillFile(), SCH_PLOTTER::createPDFFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), GENDRILL_WRITER_BASE::genDrillMapFile(), initializePlotter(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetHpgl(), 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 GERBER_PLOTTER, DXF_PLOTTER, HPGL_PLOTTER, PS_PLOTTER, PDF_PLOTTER, and SVG_PLOTTER.

Referenced by Arc(), BezierCurve(), FilledCircle(), PSLIKE_PLOTTER::FlashPadCircle(), PSLIKE_PLOTTER::FlashPadCustom(), PSLIKE_PLOTTER::FlashPadRect(), PSLIKE_PLOTTER::FlashPadRoundRect(), PSLIKE_PLOTTER::FlashPadTrapez(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_SCREEN::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_SHAPE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), PlotDrawingSheet(), GENDRILL_WRITER_BASE::plotDrillMarks(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BITMAP_BASE::PlotImage(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_PIN::PlotSymbol(), PlotText(), sketchOval(), Text(), ThickArc(), ThickCircle(), ThickRect(), and ThickSegment().

◆ SetDash()

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

pure virtual

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

Referenced by SCH_BUS_ENTRY_BASE::Plot(), SCH_LINE::Plot(), SCH_SHAPE::Plot(), SCH_TEXTBOX::Plot(), LIB_SHAPE::Plot(), and LIB_TEXTBOX::Plot().

◆ SetGerberCoordinatesFormat()

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

inlinevirtual

Reimplemented in GERBER_PLOTTER.

Definition at line 520 of file plotter.h.

 {
 // NOP for most plotters. Only for Gerber plotter
 }

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

 {
 // NOP for most plotters
 }

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool aNegative )

inlinevirtual

Definition at line 130 of file plotter.h.

130{ m_negativeMode = aNegative; }

References m_negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

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

inlinevirtual

Definition at line 143 of file plotter.h.

143{ m_pageInfo = aPageSettings; }

References m_pageInfo.

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

◆ SetRenderSettings()

void PLOTTER::SetRenderSettings ( RENDER_SETTINGS * aSettings )

inline

Definition at line 140 of file plotter.h.

140{ m_renderSettings = aSettings; }

References m_renderSettings.

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

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

 {
 // NOP for most plotters. Only for SVG plotter
 }

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

 {
 // NOP for most plotters.
 }

Referenced by initializePlotter(), and PlotOneBoardLayer().

◆ SetTitle()

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

inlinevirtual

Definition at line 161 of file plotter.h.

161{ m_title = aTitle; }

PLOTTER::m_title

wxString m_title

Definition: plotter.h:664

References m_title.

Referenced by SCH_PLOTTER::createPDFFile().

◆ 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, HPGL_PLOTTER, PS_PLOTTER, PDF_PLOTTER, and SVG_PLOTTER.

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

◆ sketchOval()

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

protected

Definition at line 496 of file plotter.cpp.

{
 SetCurrentLineWidth( aWidth );
 
 EDA_ANGLE orient( aOrient );
 VECTOR2I size( aSize );
 
 if( size.x > size.y )
 {
 std::swap( size.x, size.y );
 orient += ANGLE_90;
 }
 
 int deltaxy = size.y - size.x; /* distance between centers of the oval */
 int radius = size.x / 2;
 
 // Build a vertical oval shape giving the start and end points of arcs and edges,
 // and the middle point of arcs
 std::vector<VECTOR2I> corners;
 corners.reserve( 6 );
 // Shape is (x = corner and arc ends, c = arc centre)
 // xcx
 //
 // xcx
 int half_height = deltaxy / 2;
 corners.emplace_back( -radius, -half_height );
 corners.emplace_back( -radius, half_height );
 corners.emplace_back( 0, half_height );
 corners.emplace_back( radius, half_height );
 corners.emplace_back( radius, -half_height );
 corners.emplace_back( 0, -half_height );
 
 // Rotate and move to the actual position
 for( size_t ii = 0; ii < corners.size(); ii++ )
 {
 RotatePoint( corners[ii], orient );
 corners[ii] += aPos;
 }
 
 // Gen shape:
 MoveTo( corners[0] );
 FinishTo( corners[1] );
 
 Arc( corners[2], orient + ANGLE_180, orient + ANGLE_360, radius, FILL_T::NO_FILL );
 
 MoveTo( corners[3] );
 FinishTo( corners[4] );
 
 Arc( corners[5], orient, orient + ANGLE_180, radius, FILL_T::NO_FILL );
}

References ANGLE_180, ANGLE_360, ANGLE_90, Arc(), FinishTo(), MoveTo(), NO_FILL, RotatePoint(), SetCurrentLineWidth(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

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

538{}

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

◆ StartPlot()

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

pure virtual

Implemented in DXF_PLOTTER, HPGL_PLOTTER, PS_PLOTTER, PDF_PLOTTER, SVG_PLOTTER, and GERBER_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,
		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.

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

Definition at line 697 of file plotter.cpp.

{
 KIGFX::GAL_DISPLAY_OPTIONS empty_opts;
 
 SetColor( aColor );
 SetCurrentLineWidth( aPenWidth, aData );
 
 if( aPenWidth == 0 && aBold ) // Use default values if aPenWidth == 0
 aPenWidth = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );
 
 if( aPenWidth < 0 )
 aPenWidth = -aPenWidth;
 
 CALLBACK_GAL callback_gal( empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 MoveTo( aPt1 );
 LineTo( aPt2 );
 PenFinish();
 },
 // Polygon callback
 [&]( const SHAPE_LINE_CHAIN& aPoly )
 {
 PlotPoly( aPoly, FILL_T::FILLED_SHAPE, 0, aData );
 } );
 
 TEXT_ATTRIBUTES attributes;
 attributes.m_Angle = aOrient;
 attributes.m_StrokeWidth = aPenWidth;
 attributes.m_Italic = aItalic;
 attributes.m_Bold = aBold;
 attributes.m_Halign = aH_justify;
 attributes.m_Valign = aV_justify;
 attributes.m_Size = aSize;
 
 // if Size.x is < 0, the text is mirrored (we have no other param to know a text is mirrored)
 if( attributes.m_Size.x < 0 )
 {
 attributes.m_Size.x = -attributes.m_Size.x;
 attributes.m_Mirrored = true;
 }
 
 if( !aFont )
 aFont = KIFONT::FONT::GetFont();
 
 aFont->Draw( &callback_gal, aText, aPos, attributes );
}

References KIFONT::FONT::Draw(), FILLED_SHAPE, KIFONT::FONT::GetFont(), GetPenSizeForBold(), LineTo(), TEXT_ATTRIBUTES::m_Angle, MoveTo(), PenFinish(), PlotPoly(), SetColor(), SetCurrentLineWidth(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PlotDrawingSheet(), DXF_PLOTTER::Text(), GERBER_PLOTTER::Text(), PS_PLOTTER::Text(), PDF_PLOTTER::Text(), and SVG_PLOTTER::Text().

◆ ThickArc() [1/3]

void PLOTTER::ThickArc	(	const EDA_SHAPE &	aArcShape,
		OUTLINE_MODE	aTraceMode,
		void *	aData
	)

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 620 of file plotter.cpp.

{
 ThickArc( aArcShape.getCenter(),aArcShape.GetStart(), aArcShape.GetEnd(),
 aArcShape.GetWidth(), aTraceMode, aData );
}

References EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), and ThickArc().

◆ ThickArc() [2/3]

void PLOTTER::ThickArc	(	const VECTOR2I &	aCentre,
		const EDA_ANGLE &	StAngle,
		const EDA_ANGLE &	EndAngle,
		int	aRadius,
		int	aWidth,
		OUTLINE_MODE	aTraceMode,
		void *	aData
	)

protectedvirtual

Reimplemented in GERBER_PLOTTER.

Definition at line 573 of file plotter.cpp.

{
 if( aTraceMode == FILLED )
 {
 Arc( centre, aStartAngle, aEndAngle, aRadius, FILL_T::NO_FILL, aWidth );
 }
 else
 {
 SetCurrentLineWidth( -1 );
 Arc( centre, aStartAngle, aEndAngle, aRadius - ( aWidth - m_currentPenWidth ) / 2,
 FILL_T::NO_FILL, -1 );
 Arc( centre, aStartAngle, aEndAngle, aRadius + ( aWidth - m_currentPenWidth ) / 2,
 FILL_T::NO_FILL, -1 );
 }
}

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

◆ ThickArc() [3/3]

void PLOTTER::ThickArc	(	const VECTOR2I &	aCentre,
		const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		int	aWidth,
		OUTLINE_MODE	aTraceMode,
		void *	aData
	)

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 592 of file plotter.cpp.

{
 if( aTraceMode == FILLED )
 {
 Arc( aCentre, aStart, aEnd, FILL_T::NO_FILL, aWidth, GetPlotterArcHighDef() );
 }
 else
 {
 SetCurrentLineWidth( -1 );
 int radius = ( aStart - aCentre ).EuclideanNorm();
 
 int new_radius = radius - ( aWidth - m_currentPenWidth ) / 2;
 VECTOR2I start = ( aStart - aCentre ).Resize( new_radius ) + aCentre;
 VECTOR2I end = ( aEnd - aCentre ).Resize( new_radius ) + aCentre;
 
 Arc( aCentre, start, end, FILL_T::NO_FILL, -1, GetPlotterArcHighDef() );
 
 new_radius = radius + ( aWidth - m_currentPenWidth ) / 2;
 start = ( aStart - aCentre ).Resize( new_radius ) + aCentre;
 end = ( aEnd - aCentre ).Resize( new_radius ) + aCentre;
 
 Arc( aCentre, start, end, FILL_T::NO_FILL, -1, GetPlotterArcHighDef() );
 }
}

References Arc(), EuclideanNorm(), FILLED, GetPlotterArcHighDef(), m_currentPenWidth, NO_FILL, and SetCurrentLineWidth().

Referenced by BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), PlotStandardLayer(), and ThickArc().

◆ ThickCircle()

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

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 652 of file plotter.cpp.

{
 if( tracemode == FILLED )
 {
 Circle( pos, diametre, FILL_T::NO_FILL, width );
 }
 else
 {
 SetCurrentLineWidth( -1 );
 Circle( pos, diametre - width + m_currentPenWidth, FILL_T::NO_FILL, -1 );
 Circle( pos, diametre + width - m_currentPenWidth, FILL_T::NO_FILL, -1 );
 }
}

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

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

◆ ThickRect()

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

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 628 of file plotter.cpp.

{
 if( tracemode == FILLED )
 {
 Rect( p1, p2, FILL_T::NO_FILL, width );
 }
 else
 {
 SetCurrentLineWidth( -1 );
 VECTOR2I offsetp1( p1.x - ( width - m_currentPenWidth ) / 2,
 p1.y - (width - m_currentPenWidth) / 2 );
 VECTOR2I offsetp2( p2.x + ( width - m_currentPenWidth ) / 2,
 p2.y + (width - m_currentPenWidth) / 2 );
 Rect( offsetp1, offsetp2, FILL_T::NO_FILL, -1 );
 offsetp1.x += ( width - m_currentPenWidth );
 offsetp1.y += ( width - m_currentPenWidth );
 offsetp2.x -= ( width - m_currentPenWidth );
 offsetp2.y -= ( width - m_currentPenWidth );
 Rect( offsetp1, offsetp2, FILL_T::NO_FILL, -1 );
 }
}

References FILLED, m_currentPenWidth, NO_FILL, Rect(), SetCurrentLineWidth(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ ThickSegment()

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

virtual

Reimplemented in DXF_PLOTTER, GERBER_PLOTTER, and HPGL_PLOTTER.

Definition at line 549 of file plotter.cpp.

{
 if( tracemode == FILLED )
 {
 if( start == end )
 {
 Circle( start, width, FILL_T::FILLED_SHAPE, 0 );
 }
 else
 {
 SetCurrentLineWidth( width );
 MoveTo( start );
 FinishTo( end );
 }
 }
 else
 {
 SetCurrentLineWidth( -1 );
 segmentAsOval( start, end, width, tracemode );
 }
}

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

Referenced by PSLIKE_PLOTTER::FlashPadOval(), SCH_SYMBOL::PlotDNP(), BRDITEMS_PLOTTER::PlotFootprintShape(), PlotLayerOutlines(), BRDITEMS_PLOTTER::PlotPcbShape(), and PlotStandardLayer().

◆ userToDeviceCoordinates()

VECTOR2D PLOTTER::userToDeviceCoordinates ( const VECTOR2I & aCoordinate )

protectedvirtual

Modify coordinates according to the orientation, scale factor, and offsets trace.

Also convert from a VECTOR2I to VECTOR2D, since some output engines needs floating point coordinates.

Definition at line 90 of file plotter.cpp.

{
 VECTOR2I pos = aCoordinate - m_plotOffset;
 
 double x = pos.x * m_plotScale;
 double y = ( m_paperSize.y - pos.y * m_plotScale );
 
 if( m_plotMirror )
 {
 if( m_mirrorIsHorizontal )
 x = ( m_paperSize.x - pos.x * m_plotScale );
 else
 y = pos.y * m_plotScale;
 }
 
 if( m_yaxisReversed )
 y = m_paperSize.y - y;
 
 x *= m_iuPerDeviceUnit;
 y *= m_iuPerDeviceUnit;
 
 return VECTOR2D( x, y );
}

References m_iuPerDeviceUnit, m_mirrorIsHorizontal, m_paperSize, m_plotMirror, m_plotOffset, m_plotScale, m_yaxisReversed, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ userToDeviceSize() [1/2]

VECTOR2D PLOTTER::userToDeviceSize ( const VECTOR2I & size )

protectedvirtual

Modify size according to the plotter scale factors (VECTOR2I version, returns a VECTOR2D).

Definition at line 115 of file plotter.cpp.

{
 return VECTOR2D( size.x * m_plotScale * m_iuPerDeviceUnit,
 size.y * m_plotScale * m_iuPerDeviceUnit );
}

References m_iuPerDeviceUnit, m_plotScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DXF_PLOTTER::Arc(), HPGL_PLOTTER::Arc(), SVG_PLOTTER::Arc(), HPGL_PLOTTER::Circle(), DXF_PLOTTER::Circle(), PS_PLOTTER::Circle(), PDF_PLOTTER::Circle(), SVG_PLOTTER::Circle(), PSLIKE_PLOTTER::computeTextParameters(), HPGL_PLOTTER::FlashPadCircle(), GetDashGapLenIU(), GetDashMarkLenIU(), GetDotMarkLenIU(), PDF_PLOTTER::PlotImage(), SVG_PLOTTER::PlotImage(), DXF_PLOTTER::plotOneLineOfText(), HPGL_PLOTTER::SetCurrentLineWidth(), PS_PLOTTER::SetCurrentLineWidth(), PDF_PLOTTER::SetCurrentLineWidth(), SVG_PLOTTER::setSVGPlotStyle(), HPGL_PLOTTER::SetTargetChordLength(), PDF_PLOTTER::StartPage(), HPGL_PLOTTER::StartPlot(), PS_PLOTTER::StartPlot(), and SVG_PLOTTER::Text().

◆ userToDeviceSize() [2/2]

double PLOTTER::userToDeviceSize ( double size ) const

protectedvirtual

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

Definition at line 122 of file plotter.cpp.

{
 return size * m_plotScale * m_iuPerDeviceUnit;
}

References m_iuPerDeviceUnit, and m_plotScale.

Member Data Documentation

◆ DO_NOT_SET_LINE_WIDTH

const int PLOTTER::DO_NOT_SET_LINE_WIDTH = -2

static

Definition at line 113 of file plotter.h.

Referenced by GERBER_PLOTTER::FilledCircle(), GERBER_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::SetCurrentLineWidth(), PS_PLOTTER::SetCurrentLineWidth(), PDF_PLOTTER::SetCurrentLineWidth(), SVG_PLOTTER::SetCurrentLineWidth(), GERBER_PLOTTER::ThickArc(), GERBER_PLOTTER::ThickCircle(), and GERBER_PLOTTER::ThickRect().

◆ m_colorMode

bool PLOTTER::m_colorMode

protected

Definition at line 656 of file plotter.h.

Referenced by GetColorMode(), PS_PLOTTER::PlotImage(), PDF_PLOTTER::PlotImage(), SVG_PLOTTER::PlotImage(), PLOTTER(), DXF_PLOTTER::SetColor(), PSLIKE_PLOTTER::SetColor(), and SetColorMode().

◆ m_creator

wxString PLOTTER::m_creator

protected

Definition at line 662 of file plotter.h.

Referenced by PDF_PLOTTER::EndPlot(), SetCreator(), PS_PLOTTER::StartPlot(), SVG_PLOTTER::StartPlot(), and GERBER_PLOTTER::StartPlot().

◆ m_currentPenWidth

int PLOTTER::m_currentPenWidth

protected

Definition at line 658 of file plotter.h.

Referenced by GetCurrentLineWidth(), PLOTTER(), GERBER_PLOTTER::SetCurrentLineWidth(), DXF_PLOTTER::SetCurrentLineWidth(), HPGL_PLOTTER::SetCurrentLineWidth(), PS_PLOTTER::SetCurrentLineWidth(), PDF_PLOTTER::SetCurrentLineWidth(), SVG_PLOTTER::SetCurrentLineWidth(), GERBER_PLOTTER::ThickArc(), ThickArc(), ThickCircle(), GERBER_PLOTTER::ThickCircle(), ThickRect(), and GERBER_PLOTTER::ThickRect().

◆ m_filename

wxString PLOTTER::m_filename

protected

Definition at line 663 of file plotter.h.

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

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines

protected

Definition at line 668 of file plotter.h.

Referenced by AddLineToHeader(), ClearHeaderLinesList(), and GERBER_PLOTTER::StartPlot().

◆ m_iuPerDeviceUnit

double PLOTTER::m_iuPerDeviceUnit

protected

Definition at line 644 of file plotter.h.

Referenced by HPGL_PLOTTER::EndPlot(), PLOTTER(), GERBER_PLOTTER::SetGerberCoordinatesFormat(), DXF_PLOTTER::SetViewport(), GERBER_PLOTTER::SetViewport(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), PDF_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), PDF_PLOTTER::StartPage(), SVG_PLOTTER::StartPlot(), userToDeviceCoordinates(), and userToDeviceSize().

◆ m_IUsPerDecimil

double PLOTTER::m_IUsPerDecimil

protected

Definition at line 642 of file plotter.h.

Referenced by PDF_PLOTTER::ClosePage(), GERBER_PLOTTER::EndPlot(), GetIUsPerDecimil(), GetPlotterArcHighDef(), GetPlotterArcLowDef(), PLOTTER(), GERBER_PLOTTER::SetGerberCoordinatesFormat(), DXF_PLOTTER::SetViewport(), GERBER_PLOTTER::SetViewport(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), PDF_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), SVG_PLOTTER::StartPlot(), GERBER_PLOTTER::StartPlot(), and GERBER_PLOTTER::writeApertureList().

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal

protected

Definition at line 649 of file plotter.h.

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

◆ m_negativeMode

bool PLOTTER::m_negativeMode

protected

Definition at line 657 of file plotter.h.

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

◆ m_outputFile

FILE* PLOTTER::m_outputFile

protected

Output file.

Definition at line 653 of file plotter.h.

◆ m_pageInfo

PAGE_INFO PLOTTER::m_pageInfo

protected

Definition at line 665 of file plotter.h.

Referenced by PDF_PLOTTER::ClosePage(), PageSettings(), SetPageSettings(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), PDF_PLOTTER::StartPage(), and PS_PLOTTER::StartPlot().

◆ m_paperSize

VECTOR2I PLOTTER::m_paperSize

protected

Definition at line 666 of file plotter.h.

Referenced by HPGL_PLOTTER::EndPlot(), DXF_PLOTTER::SetViewport(), GERBER_PLOTTER::SetViewport(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), PDF_PLOTTER::StartPage(), SVG_PLOTTER::StartPlot(), and userToDeviceCoordinates().

◆ m_penLastpos

VECTOR2I PLOTTER::m_penLastpos

protected

Definition at line 660 of file plotter.h.

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

◆ m_penState

char PLOTTER::m_penState

protected

Definition at line 659 of file plotter.h.

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

◆ m_plotMirror

bool PLOTTER::m_plotMirror

protected

Definition at line 647 of file plotter.h.

Referenced by HPGL_PLOTTER::Arc(), SVG_PLOTTER::Arc(), PSLIKE_PLOTTER::computeTextParameters(), PLOTTER(), DXF_PLOTTER::SetViewport(), GERBER_PLOTTER::SetViewport(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), PDF_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), PDF_PLOTTER::Text(), and userToDeviceCoordinates().

◆ m_plotOffset

VECTOR2I PLOTTER::m_plotOffset

protected

Definition at line 646 of file plotter.h.

Referenced by DXF_PLOTTER::SetViewport(), GERBER_PLOTTER::SetViewport(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), PDF_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), and userToDeviceCoordinates().

◆ m_plotScale

double PLOTTER::m_plotScale

protected

Plot scale - chosen by the user (even implicitly with 'fit in a4')

Definition at line 636 of file plotter.h.

Referenced by GERBER_PLOTTER::EndPlot(), PLOTTER(), DXF_PLOTTER::SetViewport(), GERBER_PLOTTER::SetViewport(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), PDF_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), userToDeviceCoordinates(), userToDeviceSize(), and GERBER_PLOTTER::writeApertureList().

◆ m_renderSettings

RENDER_SETTINGS* PLOTTER::m_renderSettings

protected

Definition at line 670 of file plotter.h.

Referenced by GetDashGapLenIU(), GetDashMarkLenIU(), GetDotMarkLenIU(), PLOTTER(), RenderSettings(), GERBER_PLOTTER::SetCurrentLineWidth(), PS_PLOTTER::SetCurrentLineWidth(), PDF_PLOTTER::SetCurrentLineWidth(), SVG_PLOTTER::SetCurrentLineWidth(), SetRenderSettings(), PDF_PLOTTER::StartPage(), PS_PLOTTER::StartPlot(), and GERBER_PLOTTER::StartPlot().

◆ m_title

wxString PLOTTER::m_title

protected

Definition at line 664 of file plotter.h.

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

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed

protected

Definition at line 650 of file plotter.h.

Referenced by PLOTTER(), SVG_PLOTTER::SetViewport(), GERBER_PLOTTER::ThickArc(), and userToDeviceCoordinates().

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58

static

Draw a marker (used for the drill map).

Definition at line 486 of file plotter.h.

Referenced by Marker().

◆ USE_DEFAULT_LINE_WIDTH

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PLOTTER()

◆ ~PLOTTER()

Member Function Documentation

◆ AddLineToHeader()

◆ Arc() [1/2]

◆ Arc() [2/2]

◆ BezierCurve()

◆ Bookmark()

◆ Circle()

◆ ClearHeaderLinesList()

◆ EndBlock()

◆ EndPlot()

◆ FilledCircle()

◆ FinishTo()

◆ FlashPadCircle()

◆ FlashPadCustom()

◆ FlashPadOval()

◆ FlashPadRect()

◆ FlashPadRoundRect()

◆ FlashPadTrapez()

◆ FlashRegularPolygon()

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

◆ GetDashMarkLenIU()

◆ GetDotMarkLenIU()

◆ GetIUsPerDecimil()

◆ GetPlotterArcHighDef()

◆ GetPlotterArcLowDef()

◆ GetPlotterType()

◆ HyperlinkBox()

◆ HyperlinkMenu()

◆ LineTo()

◆ Marker()

◆ markerBackSlash()

◆ markerCircle()

◆ markerHBar()

◆ markerLozenge()

◆ markerSlash()

◆ markerSquare()

◆ markerVBar()

◆ MoveTo()

◆ OpenFile()

◆ PageSettings()

◆ PenFinish()

◆ PenTo()

◆ PlotImage()

◆ PlotPoly() [1/2]

◆ PlotPoly() [2/2]

◆ PlotText()

◆ Rect()

◆ RenderSettings()

◆ segmentAsOval()

◆ SetColor()

◆ SetColorMode()

◆ SetCreator()

◆ SetCurrentLineWidth()

◆ SetDash()

◆ SetGerberCoordinatesFormat()

◆ SetLayerPolarity()

◆ SetNegative()

◆ SetPageSettings()

◆ SetRenderSettings()

◆ SetSvgCoordinatesFormat()

◆ SetTextMode()

◆ SetTitle()

◆ SetViewport()

◆ sketchOval()

◆ StartBlock()

◆ StartPlot()

◆ Text()

◆ ThickArc() [1/3]

◆ ThickArc() [2/3]

◆ ThickArc() [3/3]