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 ()=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 (PLOT_DASH_TYPE dashed)=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 wxPoint &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 wxPoint &p1, const wxPoint &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)=0

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

virtual void	Arc (const wxPoint &centre, double StAngle, double EndAngle, int rayon, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)
	Generic fallback: arc rendered as a polyline. More...

virtual void	Arc (const SHAPE_ARC &aArc)

virtual void	BezierCurve (const wxPoint &aStart, const wxPoint &aControl1, const wxPoint &aControl2, const wxPoint &aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH)
	Generic fallback: Cubic Bezier curve rendered as a polyline In KiCad the bezier curves have 4 control points: start ctrl1 ctrl2 end. More...

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

void	MoveTo (const wxPoint &pos)

void	LineTo (const wxPoint &pos)

void	FinishTo (const wxPoint &pos)

void	PenFinish ()

virtual void	PlotPoly (const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)=0
	Draw a polygon ( filled or not ). 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 wxPoint &aPos, double aScaleFactor)
	Only PostScript plotters can plot bitmaps. More...

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

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

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

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

virtual void	FilledCircle (const wxPoint &pos, int diametre, OUTLINE_MODE tracemode, void *aData)

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

virtual void	FlashPadOval (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData)=0

virtual void	FlashPadRect (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void *aData)=0

virtual void	FlashPadRoundRect (const wxPoint &aPadPos, const wxSize &aSize, int aCornerRadius, double aOrient, OUTLINE_MODE aTraceMode, void *aData)=0

virtual void	FlashPadCustom (const wxPoint &aPadPos, const wxSize &aSize, double aPadOrient, SHAPE_POLY_SET aPolygons, OUTLINE_MODE aTraceMode, void aData)=0

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

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

virtual void	Text (const wxPoint &aPos, const COLOR4D &aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=false, void *aData=nullptr)
	Draw text with the plotter. More...

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

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

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

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

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

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

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

Static Public 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
void	markerCircle (const wxPoint &pos, int radius)
	Plot a circle centered on the position. More...

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

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

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

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

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

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

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

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

virtual DPOINT	userToDeviceCoordinates (const wxPoint &aCoordinate)
	Modify coordinates according to the orientation, scale factor, and offsets trace. More...

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

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

double	GetDotMarkLenIU () const

double	GetDashMarkLenIU () const

double	GetDashGapLenIU () const

Protected Attributes
double	m_plotScale
	Plot scale - chosen by the user (even implicitly with 'fit in a4') More...

double	m_IUsPerDecimil

double	m_iuPerDeviceUnit

wxPoint	m_plotOffset

bool	m_plotMirror

bool	m_mirrorIsHorizontal

bool	m_yaxisReversed

FILE *	m_outputFile
	Output file. More...

bool	m_colorMode

bool	m_negativeMode

int	m_currentPenWidth

char	m_penState

wxPoint	m_penLastpos

wxString	m_creator

wxString	m_filename

wxString	m_title

PAGE_INFO	m_pageInfo

wxSize	m_paperSize

wxArrayString	m_headerExtraLines

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

Constructor & Destructor Documentation

◆ PLOTTER()

PLOTTER::PLOTTER ( )

Definition at line 49 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 68 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 183 of file plotter.h.

  {
  m_headerExtraLines.Add( aExtraString );
  }

References m_headerExtraLines.

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

◆ Arc() [1/2]

void PLOTTER::Arc	(	const wxPoint &	centre,
		double	StAngle,
		double	EndAngle,
		int	rayon,
		FILL_T	fill,
		int	width = `USE_DEFAULT_LINE_WIDTH`
	)

virtual

Generic fallback: arc rendered as a polyline.

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

Definition at line 164 of file plotter.cpp.

 {
  wxPoint start, end;
  const int delta = 50; // increment (in 0.1 degrees) to draw circles
 
  if( StAngle > EndAngle )
  std::swap( StAngle, EndAngle );
 
  SetCurrentLineWidth( width );
 
  /* Please NOTE the different sign due to Y-axis flip */
  start.x = centre.x + KiROUND( cosdecideg( radius, -StAngle ) );
  start.y = centre.y + KiROUND( sindecideg( radius, -StAngle ) );
 
  if( fill != FILL_T::NO_FILL )
  {
  MoveTo( centre );
  LineTo( start );
  }
  else
  {
  MoveTo( start );
  }
 
  for( int ii = StAngle + delta; ii < EndAngle; ii += delta )
  {
  end.x = centre.x + KiROUND( cosdecideg( radius, -ii ) );
  end.y = centre.y + KiROUND( sindecideg( radius, -ii ) );
  LineTo( end );
  }
 
  end.x = centre.x + KiROUND( cosdecideg( radius, -EndAngle ) );
  end.y = centre.y + KiROUND( sindecideg( radius, -EndAngle ) );
 
  if( fill != FILL_T::NO_FILL )
  {
  LineTo( end );
  FinishTo( centre );
  }
  else
  {
  FinishTo( end );
  }
 }

References cosdecideg(), delta, FinishTo(), KiROUND(), LineTo(), MoveTo(), NO_FILL, SetCurrentLineWidth(), and sindecideg().

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

◆ Arc() [2/2]

void PLOTTER::Arc ( const SHAPE_ARC & aArc )

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 157 of file plotter.cpp.

 {
  Arc( wxPoint( aArc.GetCenter() ), aArc.GetStartAngle(), aArc.GetEndAngle(), aArc.GetRadius(),
  FILL_T::NO_FILL, aArc.GetWidth() );
 }

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

◆ BezierCurve()

void PLOTTER::BezierCurve	(	const wxPoint &	aStart,
		const wxPoint &	aControl1,
		const wxPoint &	aControl2,
		const wxPoint &	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 211 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<wxPoint> ctrlPoints;
  ctrlPoints.push_back( aStart );
  ctrlPoints.push_back( aControl1 );
  ctrlPoints.push_back( aControl2 );
  ctrlPoints.push_back( aEnd );
 
  BEZIER_POLY bezier_converter( ctrlPoints );
 
  std::vector<wxPoint> 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::PlotFootprintGraphicItem(), and BRDITEMS_PLOTTER::PlotPcbShape().

◆ Circle()

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

pure virtual

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

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

  {
  m_headerExtraLines.Clear();
  }

References m_headerExtraLines.

Referenced by 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 SVG_PLOTTER, and GERBER_PLOTTER.

Definition at line 496 of file plotter.h.

496 {}

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

◆ EndPlot()

virtual bool PLOTTER::EndPlot ( )

pure virtual

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

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

◆ FilledCircle()

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

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 607 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::PlotFootprintGraphicItem(), and BRDITEMS_PLOTTER::PlotPcbShape().

◆ FinishTo()

void PLOTTER::FinishTo ( const wxPoint & pos )

inline

Definition at line 273 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_NO_CONNECT::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LINE::Plot(), PlotDrawingSheet(), GERBER_PLOTTER::PlotPoly(), LIB_PIN::PlotSymbol(), DXF_PLOTTER::Rect(), sketchOval(), GERBER_PLOTTER::ThickSegment(), HPGL_PLOTTER::ThickSegment(), DXF_PLOTTER::ThickSegment(), and ThickSegment().

◆ FlashPadCircle()

virtual void PLOTTER::FlashPadCircle	(	const wxPoint &	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, DXF_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

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

◆ FlashPadCustom()

virtual void PLOTTER::FlashPadCustom	(	const wxPoint &	aPadPos,
		const wxSize &	aSize,
		double	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, GERBER_PLOTTER, and PSLIKE_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashPadOval()

virtual void PLOTTER::FlashPadOval	(	const wxPoint &	aPadPos,
		const wxSize &	aSize,
		double	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 DXF_PLOTTER, HPGL_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

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

◆ FlashPadRect()

virtual void PLOTTER::FlashPadRect	(	const wxPoint &	aPadPos,
		const wxSize &	aSize,
		double	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 DXF_PLOTTER, HPGL_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashPadRoundRect()

virtual void PLOTTER::FlashPadRoundRect	(	const wxPoint &	aPadPos,
		const wxSize &	aSize,
		int	aCornerRadius,
		double	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, HPGL_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashPadTrapez()

virtual void PLOTTER::FlashPadTrapez	(	const wxPoint &	aPadPos,
		const wxPoint *	aCorners,
		double	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, HPGL_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashRegularPolygon()

virtual void PLOTTER::FlashRegularPolygon	(	const wxPoint &	aShapePos,
		int	aDiameter,
		int	aCornerCount,
		double	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 in degrees.
aData	is a auxiliary parameter used (if needed) to handle extra info specific to the plotter.

Implemented in DXF_PLOTTER, HPGL_PLOTTER, GERBER_PLOTTER, and PSLIKE_PLOTTER.

◆ GetColorMode()

bool PLOTTER::GetColorMode ( ) const

inline

Definition at line 153 of file plotter.h.

153 { return m_colorMode; }

PLOTTER::m_colorMode

bool m_colorMode

Definition: plotter.h:593

References m_colorMode.

Referenced by PLOT_CONTROLLER::GetColorMode(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), LIB_SYMBOL::Plot(), SCH_SHEET::Plot(), PlotDrawingSheet(), LIB_SYMBOL::PlotLibFields(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), and DXF_PLOTTER::StartPlot().

◆ GetCurrentLineWidth()

virtual int PLOTTER::GetCurrentLineWidth ( ) const

inlinevirtual

Definition at line 168 of file plotter.h.

168 { return m_currentPenWidth; }

PLOTTER::m_currentPenWidth

int m_currentPenWidth

Definition: plotter.h:595

References m_currentPenWidth.

Referenced by GERBER_PLOTTER::FlashPadChamferRoundRect(), PSLIKE_PLOTTER::FlashPadCircle(), PSLIKE_PLOTTER::FlashPadCustom(), GERBER_PLOTTER::FlashPadCustom(), PSLIKE_PLOTTER::FlashPadRect(), GERBER_PLOTTER::FlashPadRect(), PSLIKE_PLOTTER::FlashPadRoundRect(), GERBER_PLOTTER::FlashPadRoundRect(), PSLIKE_PLOTTER::FlashPadTrapez(), GERBER_PLOTTER::FlashPadTrapez(), GERBER_PLOTTER::FlashRegularPolygon(), GetDashGapLenIU(), GetDashMarkLenIU(), GetDotMarkLenIU(), markerCircle(), markerLozenge(), markerSquare(), PS_PLOTTER::SetCurrentLineWidth(), and SVG_PLOTTER::setSVGPlotStyle().

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( ) const

protected

Definition at line 151 of file plotter.cpp.

 {
  return userToDeviceSize( dash_gap_len( GetCurrentLineWidth() ) );
 }

References dash_gap_len(), GetCurrentLineWidth(), and userToDeviceSize().

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

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( ) const

protected

Definition at line 145 of file plotter.cpp.

 {
  return userToDeviceSize( dash_mark_len( GetCurrentLineWidth() ) );
 }

References dash_mark_len(), GetCurrentLineWidth(), and userToDeviceSize().

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

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( ) const

protected

Definition at line 139 of file plotter.cpp.

 {
  return userToDeviceSize( dot_mark_len( GetCurrentLineWidth() ) );
 }

References dot_mark_len(), GetCurrentLineWidth(), 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 225 of file plotter.h.

225 { return m_IUsPerDecimil; }

PLOTTER::m_IUsPerDecimil

double m_IUsPerDecimil

Definition: plotter.h:579

References m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetPlotterArcHighDef()

int PLOTTER::GetPlotterArcHighDef ( ) const

inline

Definition at line 228 of file plotter.h.

228 { return m_IUsPerDecimil * 2; }

PLOTTER::m_IUsPerDecimil

double m_IUsPerDecimil

Definition: plotter.h:579

References m_IUsPerDecimil.

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

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const

inline

Definition at line 227 of file plotter.h.

227 { return m_IUsPerDecimil * 8; }

PLOTTER::m_IUsPerDecimil

double m_IUsPerDecimil

Definition: plotter.h:579

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

Referenced by BRDITEMS_PLOTTER::PlotFilledAreas(), PlotOneBoardLayer(), BRDITEMS_PLOTTER::PlotPad(), and StartPlotBoard().

◆ LineTo()

void PLOTTER::LineTo ( const wxPoint & pos )

inline

Definition at line 268 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(), GERBER_PLOTTER::plotArc(), GERBER_PLOTTER::PlotPoly(), HPGL_PLOTTER::PlotPoly(), DXF_PLOTTER::PlotPoly(), GERBER_PLOTTER::plotRoundRectAsRegion(), LIB_PIN::PlotSymbol(), and DXF_PLOTTER::Rect().

◆ Marker()

void PLOTTER::Marker	(	const wxPoint &	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 338 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 wxPoint &	pos,
		int	radius
	)

protected

Plot a \ bar centered on the position.

Building block for markers

Definition at line 324 of file plotter.cpp.

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

References FinishTo(), and MoveTo().

Referenced by Marker().

◆ markerCircle()

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

protected

Plot a circle centered on the position.

Building block for markers

Definition at line 280 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 wxPoint &	pos,
		int	radius
	)

protected

Plot a - bar centered on the position.

Building block for markers

Definition at line 310 of file plotter.cpp.

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

References FinishTo(), and MoveTo().

Referenced by Marker().

◆ markerLozenge()

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

protected

Plot a lozenge centered on the position.

Building block for markers

Definition at line 286 of file plotter.cpp.

 {
  std::vector< wxPoint > corner_list;
  wxPoint 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 );
  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, and PlotPoly().

Referenced by Marker().

◆ markerSlash()

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

protected

Plot a / bar centered on the position.

Building block for markers

Definition at line 317 of file plotter.cpp.

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

References FinishTo(), and MoveTo().

Referenced by Marker().

◆ markerSquare()

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

protected

Plot a square centered on the position.

Building block for markers

Definition at line 255 of file plotter.cpp.

 {
  double r = KiROUND( radius / 1.4142 );
  std::vector< wxPoint > corner_list;
  wxPoint 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 );
  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(), and r.

Referenced by Marker().

◆ markerVBar()

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

protected

Plot a | bar centered on the position.

Building block for markers

Definition at line 331 of file plotter.cpp.

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

References FinishTo(), and MoveTo().

Referenced by Marker().

◆ MoveTo()

void PLOTTER::MoveTo ( const wxPoint & pos )

inline

Definition at line 263 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_NO_CONNECT::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LINE::Plot(), GERBER_PLOTTER::plotArc(), PlotDrawingSheet(), GERBER_PLOTTER::PlotPoly(), HPGL_PLOTTER::PlotPoly(), DXF_PLOTTER::PlotPoly(), GERBER_PLOTTER::plotRoundRectAsRegion(), LIB_PIN::PlotSymbol(), DXF_PLOTTER::Rect(), HPGL_PLOTTER::Rect(), sketchOval(), GERBER_PLOTTER::ThickSegment(), HPGL_PLOTTER::ThickSegment(), DXF_PLOTTER::ThickSegment(), and 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 76 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(), GENDRILL_WRITER_BASE::genDrillMapFile(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), StartPlotBoard(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ PageSettings()

PAGE_INFO& PLOTTER::PageSettings ( )

inline

Definition at line 159 of file plotter.h.

159 { return m_pageInfo; }

PLOTTER::m_pageInfo

PAGE_INFO m_pageInfo

Definition: plotter.h:602

References m_pageInfo.

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

◆ PenFinish()

void PLOTTER::PenFinish ( )

inline

Definition at line 279 of file plotter.h.

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

References PenTo().

Referenced by HPGL_PLOTTER::Circle(), HPGL_PLOTTER::FlashPadCircle(), GERBER_PLOTTER::PlotPoly(), HPGL_PLOTTER::PlotPoly(), DXF_PLOTTER::PlotPoly(), and HPGL_PLOTTER::Rect().

◆ PenTo()

virtual void PLOTTER::PenTo	(	const wxPoint &	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 SVG_PLOTTER, PDF_PLOTTER, PS_PLOTTER, HPGL_PLOTTER, DXF_PLOTTER, and GERBER_PLOTTER.

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

◆ PlotImage()

void PLOTTER::PlotImage	(	const wxImage &	aImage,
		const wxPoint &	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 SVG_PLOTTER, PDF_PLOTTER, and PS_PLOTTER.

Definition at line 239 of file plotter.cpp.

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

References NO_FILL, and Rect().

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

◆ PlotPoly() [1/2]

virtual void PLOTTER::PlotPoly	(	const std::vector< wxPoint > &	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< wxPoint >).
aFill	is the type of fill.
aWidth	is the line width.
aData	is an auxiliary info (mainly for gerber format).

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

Referenced by PSLIKE_PLOTTER::FlashPadCustom(), PSLIKE_PLOTTER::FlashPadRect(), PSLIKE_PLOTTER::FlashPadRoundRect(), PSLIKE_PLOTTER::FlashPadTrapez(), markerLozenge(), markerSquare(), LIB_SHAPE::Plot(), SCH_TEXT::Plot(), PlotDrawingSheet(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), PlotLayerOutlines(), BRDITEMS_PLOTTER::PlotPcbShape(), PlotPoly(), and PlotSolderMaskLayer().

◆ PlotPoly() [2/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 621 of file plotter.cpp.

 {
  std::vector<wxPoint> 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().

◆ Rect()

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

pure virtual

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

Referenced by FillNegativeKnockout(), LIB_SHAPE::Plot(), SCH_SHEET::Plot(), PlotDrawingSheet(), PlotImage(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), and ThickRect().

◆ RenderSettings()

RENDER_SETTINGS* PLOTTER::RenderSettings ( )

inline

Definition at line 156 of file plotter.h.

156 { return m_renderSettings; }

PLOTTER::m_renderSettings

RENDER_SETTINGS * m_renderSettings

Definition: plotter.h:607

References m_renderSettings.

Referenced by PLOT_CONTROLLER::ClosePlot(), DIALOG_PLOT::Plot(), LIB_SHAPE::Plot(), LIB_TEXT::Plot(), SCH_NO_CONNECT::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_JUNCTION::Plot(), SCH_BITMAP::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), SCH_SCREEN::Plot(), LIB_SYMBOL::Plot(), SCH_SHEET::Plot(), PlotDrawingSheet(), LIB_SYMBOL::PlotLibFields(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPDF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), LIB_PIN::PlotPinTexts(), LIB_PIN::PlotSymbol(), and StartPlotBoard().

◆ segmentAsOval()

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

protected

Convert a thick segment and plot it as an oval.

Definition at line 460 of file plotter.cpp.

 {
  wxPoint center( (start.x + end.x) / 2, (start.y + end.y) / 2 );
  wxSize size( end.x - start.x, end.y - start.y );
  double orient;
 
  if( size.y == 0 )
  orient = 0;
  else if( size.x == 0 )
  orient = 900;
  else
  orient = -ArcTangente( size.y, size.x );
 
  size.x = KiROUND( EuclideanNorm( size ) ) + width;
  size.y = width;
 
  FlashPadOval( center, size, orient, tracemode, nullptr );
 }

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

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

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

152 { m_colorMode = aColorMode; }

PLOTTER::m_colorMode

bool m_colorMode

Definition: plotter.h:593

References m_colorMode.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_EXPORT_SVG::CreateSVGFile(), GENDRILL_WRITER_BASE::genDrillMapFile(), initializePlotter(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::plotOneSheetSVG(), PLOT_CONTROLLER::SetColorMode(), and SYMBOL_EDIT_FRAME::SVGPlotSymbol().

◆ SetCreator()

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

inlinevirtual

Definition at line 174 of file plotter.h.

174 { m_creator = aCreator; }

PLOTTER::m_creator

wxString m_creator

Definition: plotter.h:599

References m_creator.

Referenced by GERBER_WRITER::createDrillFile(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), PLACEFILE_GERBER_WRITER::CreatePlaceFile(), GENDRILL_WRITER_BASE::genDrillMapFile(), initializePlotter(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_PLOT_SCHEMATIC::plotOneSheetPS(), DIALOG_PLOT_SCHEMATIC::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 SVG_PLOTTER, PDF_PLOTTER, PS_PLOTTER, HPGL_PLOTTER, DXF_PLOTTER, and GERBER_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_NO_CONNECT::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_LINE::Plot(), SCH_TEXT::Plot(), SCH_SCREEN::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(), sketchOval(), Text(), ThickArc(), ThickCircle(), ThickRect(), and ThickSegment().

◆ SetDash()

virtual void PLOTTER::SetDash ( PLOT_DASH_TYPE dashed )

pure virtual

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

Referenced by SCH_BUS_ENTRY_BASE::Plot(), and SCH_LINE::Plot().

◆ SetGerberCoordinatesFormat()

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

inlinevirtual

Reimplemented in GERBER_PLOTTER.

Definition at line 470 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 456 of file plotter.h.

  {
  // NOP for most plotters
  }

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool aNegative )

inlinevirtual

Definition at line 142 of file plotter.h.

  {
  m_negativeMode = aNegative;
  }

References m_negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

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

inlinevirtual

Definition at line 158 of file plotter.h.

158 { m_pageInfo = aPageSettings; }

PLOTTER::m_pageInfo

PAGE_INFO m_pageInfo

Definition: plotter.h:602

References m_pageInfo.

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

◆ SetRenderSettings()

void PLOTTER::SetRenderSettings ( RENDER_SETTINGS * aSettings )

inline

Definition at line 155 of file plotter.h.

155 { m_renderSettings = aSettings; }

PLOTTER::m_renderSettings

RENDER_SETTINGS * m_renderSettings

Definition: plotter.h:607

References m_renderSettings.

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

◆ SetSvgCoordinatesFormat()

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

inlinevirtual

Reimplemented in SVG_PLOTTER.

Definition at line 475 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 465 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 176 of file plotter.h.

176 { m_title = aTitle; }

PLOTTER::m_title

wxString m_title

Definition: plotter.h:601

References m_title.

Referenced by DIALOG_PLOT_SCHEMATIC::createPDFFile().

◆ SetViewport()

virtual void PLOTTER::SetViewport	(	const wxPoint &	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 SVG_PLOTTER, PDF_PLOTTER, PS_PLOTTER, HPGL_PLOTTER, DXF_PLOTTER, and GERBER_PLOTTER.

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

◆ sketchOval()

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

protected

Definition at line 481 of file plotter.cpp.

 {
  SetCurrentLineWidth( width );
  width = m_currentPenWidth;
  int radius, deltaxy, cx, cy;
  wxSize size( aSize );
 
  if( size.x > size.y )
  {
  std::swap( size.x, size.y );
  orient = AddAngles( orient, 900 );
  }
 
  deltaxy = size.y - size.x; /* distance between centers of the oval */
  radius = ( size.x - width ) / 2;
  cx = -radius;
  cy = -deltaxy / 2;
  RotatePoint( &cx, &cy, orient );
  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
  cx = -radius;
  cy = deltaxy / 2;
  RotatePoint( &cx, &cy, orient );
  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
 
  cx = radius;
  cy = -deltaxy / 2;
  RotatePoint( &cx, &cy, orient );
  MoveTo( wxPoint( cx + pos.x, cy + pos.y ) );
  cx = radius;
  cy = deltaxy / 2;
  RotatePoint( &cx, &cy, orient );
  FinishTo( wxPoint( cx + pos.x, cy + pos.y ) );
 
  cx = 0;
  cy = deltaxy / 2;
  RotatePoint( &cx, &cy, orient );
  Arc( wxPoint( cx + pos.x, cy + pos.y ), orient + 1800, orient + 3600, radius, FILL_T::NO_FILL );
  cx = 0;
  cy = -deltaxy / 2;
  RotatePoint( &cx, &cy, orient );
  Arc( wxPoint( cx + pos.x, cy + pos.y ), orient, orient + 1800, radius, FILL_T::NO_FILL );
 }

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

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

Definition at line 487 of file plotter.h.

487 {}

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

◆ StartPlot()

virtual bool PLOTTER::StartPlot ( )

pure virtual

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

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

◆ Text()

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

virtual

Draw text with the plotter.

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

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

Parameters

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 in 0.1 degree.
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 (aWidth = 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 SVG_PLOTTER, PDF_PLOTTER, PS_PLOTTER, DXF_PLOTTER, and GERBER_PLOTTER.

Definition at line 219 of file gr_text.cpp.

 {
  SetColor( aColor );
  SetCurrentLineWidth( aPenWidth, aData );
 
  GRText( nullptr, aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aPenWidth,
  aItalic, aBold, nullptr, nullptr, this );
 }

References GRText(), SetColor(), and SetCurrentLineWidth().

Referenced by GENDRILL_WRITER_BASE::genDrillMapFile(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), PlotDrawingSheet(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_PIN::PlotPinTexts(), GERBER_PLOTTER::Text(), DXF_PLOTTER::Text(), PS_PLOTTER::Text(), PDF_PLOTTER::Text(), and SVG_PLOTTER::Text().

◆ ThickArc()

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

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 549 of file plotter.cpp.

 {
  if( tracemode == FILLED )
  {
  Arc( centre, StAngle, EndAngle, radius, FILL_T::NO_FILL, width );
  }
  else
  {
  SetCurrentLineWidth( -1 );
  Arc( centre, StAngle, EndAngle, radius - ( width - m_currentPenWidth ) / 2,
  FILL_T::NO_FILL, -1 );
  Arc( centre, StAngle, EndAngle, radius + ( width - m_currentPenWidth ) / 2,
  FILL_T::NO_FILL, -1 );
  }
 }

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

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

◆ ThickCircle()

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

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 591 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::PlotFootprintGraphicItem(), and BRDITEMS_PLOTTER::PlotPcbShape().

◆ ThickRect()

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

virtual

Reimplemented in GERBER_PLOTTER.

Definition at line 567 of file plotter.cpp.

 {
  if( tracemode == FILLED )
  {
  Rect( p1, p2, FILL_T::NO_FILL, width );
  }
  else
  {
  SetCurrentLineWidth( -1 );
  wxPoint offsetp1( p1.x - (width - m_currentPenWidth) / 2,
  p1.y - (width - m_currentPenWidth) / 2 );
  wxPoint 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(), and SetCurrentLineWidth().

◆ ThickSegment()

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

virtual

Reimplemented in DXF_PLOTTER, HPGL_PLOTTER, and GERBER_PLOTTER.

Definition at line 525 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(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), PlotLayerOutlines(), BRDITEMS_PLOTTER::PlotPcbShape(), and PlotStandardLayer().

◆ userToDeviceCoordinates()

DPOINT PLOTTER::userToDeviceCoordinates ( const wxPoint & aCoordinate )

protectedvirtual

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

Also convert from a wxPoint to DPOINT, since some output engines needs floating point coordinates.

Definition at line 92 of file plotter.cpp.

 {
  wxPoint pos = aCoordinate - m_plotOffset;
 
  // Don't allow overflows; they can cause rendering failures in some file viewers
  // (such as Acrobat)
  int clampSize = MAX_PAGE_SIZE_MILS * m_IUsPerDecimil * 10 / 2;
  pos.x = std::max( -clampSize, std::min( pos.x, clampSize ) );
  pos.y = std::max( -clampSize, std::min( pos.y, clampSize ) );
 
  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 DPOINT( x, y );
 }

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

◆ userToDeviceSize() [1/2]

DPOINT PLOTTER::userToDeviceSize ( const wxSize & size )

protectedvirtual

Modify size according to the plotter scale factors (wxSize version, returns a DPOINT).

Definition at line 123 of file plotter.cpp.

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

References m_iuPerDeviceUnit, and m_plotScale.

Referenced by DXF_PLOTTER::Arc(), HPGL_PLOTTER::Arc(), PS_PLOTTER::Arc(), SVG_PLOTTER::Arc(), DXF_PLOTTER::Circle(), HPGL_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(), HPGL_PLOTTER::SetCurrentLineWidth(), PS_PLOTTER::SetCurrentLineWidth(), PDF_PLOTTER::SetCurrentLineWidth(), SVG_PLOTTER::setSVGPlotStyle(), HPGL_PLOTTER::SetTargetChordLength(), PDF_PLOTTER::StartPage(), HPGL_PLOTTER::StartPlot(), PS_PLOTTER::StartPlot(), DXF_PLOTTER::Text(), 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 130 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 125 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 593 of file plotter.h.

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

◆ m_creator

wxString PLOTTER::m_creator

protected

Definition at line 599 of file plotter.h.

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

◆ m_currentPenWidth

int PLOTTER::m_currentPenWidth

protected

Definition at line 595 of file plotter.h.

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

◆ m_filename

wxString PLOTTER::m_filename

protected

Definition at line 600 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 605 of file plotter.h.

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

◆ m_iuPerDeviceUnit

double PLOTTER::m_iuPerDeviceUnit

protected

Definition at line 581 of file plotter.h.

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

◆ m_IUsPerDecimil

double PLOTTER::m_IUsPerDecimil

protected

Definition at line 579 of file plotter.h.

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

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal

protected

Definition at line 586 of file plotter.h.

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

◆ m_negativeMode

bool PLOTTER::m_negativeMode

protected

Definition at line 594 of file plotter.h.

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

◆ m_outputFile

FILE* PLOTTER::m_outputFile

protected

Output file.

Definition at line 590 of file plotter.h.

◆ m_pageInfo

PAGE_INFO PLOTTER::m_pageInfo

protected

Definition at line 602 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

wxSize PLOTTER::m_paperSize

protected

Definition at line 603 of file plotter.h.

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

◆ m_penLastpos

wxPoint PLOTTER::m_penLastpos

protected

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

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

◆ m_plotOffset

wxPoint PLOTTER::m_plotOffset

protected

Definition at line 583 of file plotter.h.

Referenced by GERBER_PLOTTER::SetViewport(), DXF_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 573 of file plotter.h.

Referenced by GERBER_PLOTTER::EndPlot(), PLOTTER(), GERBER_PLOTTER::SetViewport(), DXF_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 607 of file plotter.h.

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

◆ m_title

wxString PLOTTER::m_title

protected

Definition at line 601 of file plotter.h.

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

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed

protected

Definition at line 587 of file plotter.h.

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

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58

static

Draw a marker (used for the drill map).

Definition at line 436 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()

◆ Circle()

◆ ClearHeaderLinesList()

◆ EndBlock()

◆ EndPlot()

◆ FilledCircle()

◆ FinishTo()

◆ FlashPadCircle()

◆ FlashPadCustom()

◆ FlashPadOval()

◆ FlashPadRect()

◆ FlashPadRoundRect()

◆ FlashPadTrapez()

◆ FlashRegularPolygon()

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

◆ GetDashMarkLenIU()

◆ GetDotMarkLenIU()

◆ GetIUsPerDecimil()

◆ GetPlotterArcHighDef()

◆ GetPlotterArcLowDef()

◆ GetPlotterType()

◆ LineTo()

◆ Marker()

◆ markerBackSlash()

◆ markerCircle()

◆ markerHBar()

◆ markerLozenge()

◆ markerSlash()

◆ markerSquare()

◆ markerVBar()

◆ MoveTo()

◆ OpenFile()

◆ PageSettings()

◆ PenFinish()

◆ PenTo()

◆ PlotImage()

◆ PlotPoly() [1/2]

◆ PlotPoly() [2/2]

◆ Rect()

◆ RenderSettings()

◆ segmentAsOval()

◆ SetColor()

◆ SetColorMode()

◆ SetCreator()

◆ SetCurrentLineWidth()

◆ SetDash()

◆ SetGerberCoordinatesFormat()

◆ SetLayerPolarity()

◆ SetNegative()

◆ SetPageSettings()

◆ SetRenderSettings()

◆ SetSvgCoordinatesFormat()

◆ SetTextMode()

◆ SetTitle()

◆ SetViewport()

◆ sketchOval()

◆ StartBlock()

◆ StartPlot()

◆ Text()

◆ ThickArc()

◆ ThickCircle()

◆ ThickRect()

◆ ThickSegment()

◆ userToDeviceCoordinates()

◆ userToDeviceSize() [1/2]

◆ userToDeviceSize() [2/2]