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

#include <plotter_gerber.h>

Inheritance diagram for GERBER_PLOTTER:
PLOTTER

Public Member Functions

 GERBER_PLOTTER ()
 
virtual PLOT_FORMAT GetPlotterType () const override
 Returns the effective plot engine in use. More...
 
virtual bool StartPlot (const wxString &pageNumber) override
 Write GERBER header to file initialize global variable g_Plot_PlotOutputFile. More...
 
virtual bool EndPlot () override
 
virtual void SetCurrentLineWidth (int aLineWidth, void *aData=nullptr) override
 Set the line width for the next drawing. More...
 
virtual void SetDash (int aLineWidth, LINE_STYLE aLineStyle) override
 
virtual void SetColor (const COLOR4D &aColor) override
 
virtual void SetViewport (const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
 Set the plot offset and scaling for the current plot. More...
 
virtual void Rect (const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 
virtual void Circle (const VECTOR2I &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
 
virtual void Arc (const VECTOR2D &aCenter, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
 
virtual void ThickSegment (const VECTOR2I &start, const VECTOR2I &end, int width, OUTLINE_MODE tracemode, void *aData) override
 
virtual void ThickRect (const VECTOR2I &p1, const VECTOR2I &p2, int width, OUTLINE_MODE tracemode, void *aData) override
 
virtual void ThickCircle (const VECTOR2I &pos, int diametre, int width, OUTLINE_MODE tracemode, void *aData) override
 
virtual void FilledCircle (const VECTOR2I &pos, int diametre, OUTLINE_MODE tracemode, void *aData) override
 
virtual void PlotPoly (const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr) override
 Gerber polygon: they can (and should) be filled with the appropriate G36/G37 sequence. More...
 
virtual void PlotPoly (const SHAPE_LINE_CHAIN &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr) override
 Draw a polygon ( filled or not ). More...
 
void PlotPolyAsRegion (const SHAPE_LINE_CHAIN &aPoly, FILL_T aFill, int aWidth, GBR_METADATA *aGbrMetadata)
 Similar to PlotPoly(), plot a filled polygon using Gerber region, therefore adding X2 attributes to the region object, like TA.xxx. More...
 
virtual void PenTo (const VECTOR2I &pos, char plume) override
 Moveto/lineto primitive, moves the 'pen' to the specified direction. 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 aWidth, bool aItalic, bool aBold, bool aMultilineAllowed, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics, void *aData=nullptr) override
 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, const KIFONT::METRICS &aFontMetrics, void *aData=nullptr) override
 
virtual void FlashPadCircle (const VECTOR2I &pos, int diametre, OUTLINE_MODE trace_mode, void *aData) override
 Filled circular flashes are stored as apertures. More...
 
virtual void FlashPadOval (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadRect (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadRoundRect (const VECTOR2I &aPadPos, const VECTOR2I &aSize, int aCornerRadius, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadCustom (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aPadOrient, SHAPE_POLY_SET *aPolygons, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadTrapez (const VECTOR2I &aPadPos, const VECTOR2I *aCorners, const EDA_ANGLE &aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a trapezoidal pad. More...
 
virtual void FlashRegularPolygon (const VECTOR2I &aShapePos, int aDiameter, int aCornerCount, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a regular polygon. More...
 
void FlashPadChamferRoundRect (const VECTOR2I &aShapePos, const VECTOR2I &aPadSize, int aCornerRadius, double aChamferRatio, int aChamferPositions, const EDA_ANGLE &aPadOrient, OUTLINE_MODE aPlotMode, void *aData)
 Flash a chamfered round rect pad. More...
 
void PlotGerberRegion (const std::vector< VECTOR2I > &aCornerList, GBR_METADATA *aGbrMetadata)
 Plot a Gerber region: similar to PlotPoly but plot only filled polygon, and add the TA.AperFunction if aGbrMetadata contains this attribute, and clear it after plotting. More...
 
void PlotGerberRegion (const SHAPE_LINE_CHAIN &aPoly, GBR_METADATA *aGbrMetadata)
 
virtual void SetLayerPolarity (bool aPositive) override
 Change the plot polarity and begin a new layer. More...
 
virtual void SetGerberCoordinatesFormat (int aResolution, bool aUseInches=false) override
 Selection of Gerber units and resolution (number of digits in mantissa). More...
 
void UseX2format (bool aEnable)
 
void UseX2NetAttributes (bool aEnable)
 
void DisableApertMacros (bool aDisable)
 Disable Aperture Macro (AM) command, only for broken Gerber Readers. More...
 
virtual void StartBlock (void *aData) override
 Calling this function allows one to define the beginning of a group of drawing items (used in X2 format with netlist attributes). More...
 
virtual void EndBlock (void *aData) override
 Define the end of a group of drawing items the group is started by StartBlock(). More...
 
void ClearAllAttributes ()
 Remove (clear) all attributes from object attributes dictionary (TO. More...
 
int GetOrCreateAperture (const VECTOR2I &aSize, int aRadius, const EDA_ANGLE &aRotation, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 
int GetOrCreateAperture (const std::vector< VECTOR2I > &aCorners, const EDA_ANGLE &aRotation, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 
virtual void SetNegative (bool aNegative)
 
virtual void SetColorMode (bool aColorMode)
 Plot in B/W or color. More...
 
bool GetColorMode () const
 
void SetRenderSettings (RENDER_SETTINGS *aSettings)
 
RENDER_SETTINGSRenderSettings ()
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings)
 
PAGE_INFOPageSettings ()
 
virtual int GetCurrentLineWidth () const
 
virtual void SetCreator (const wxString &aCreator)
 
virtual void SetTitle (const wxString &aTitle)
 
void AddLineToHeader (const wxString &aExtraString)
 Add a line to the list of free lines to print at the beginning of the file. More...
 
void ClearHeaderLinesList ()
 Remove all lines from the list of free lines to print at the beginning of the file. More...
 
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 Arc (const VECTOR2D &aStart, const VECTOR2D &aMid, const VECTOR2D &aEnd, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)
 
virtual void BezierCurve (const VECTOR2I &aStart, const VECTOR2I &aControl1, const VECTOR2I &aControl2, const VECTOR2I &aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH)
 Generic fallback: Cubic Bezier curve rendered as a polyline In KiCad the bezier curves have 4 control points: start ctrl1 ctrl2 end. More...
 
void MoveTo (const VECTOR2I &pos)
 
void LineTo (const VECTOR2I &pos)
 
void FinishTo (const VECTOR2I &pos)
 
void PenFinish ()
 
virtual void PlotImage (const wxImage &aImage, const VECTOR2I &aPos, double aScaleFactor)
 Only PostScript plotters can plot bitmaps. More...
 
virtual void ThickArc (const EDA_SHAPE &aArcShape, OUTLINE_MODE aTraceMode, void *aData)
 
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 SetTextMode (PLOT_TEXT_MODE mode)
 Change the current text mode. More...
 
virtual void SetSvgCoordinatesFormat (unsigned aPrecision)
 Set the number of digits for mantissa in coordinates in mm for SVG plotter. More...
 

Static Public Member Functions

static wxString GetDefaultFileExtension ()
 

Static Public Attributes

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

Protected Member Functions

virtual void ThickArc (const VECTOR2D &aCentre, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, int aWidth, OUTLINE_MODE aTraceMode, void *aData) override
 
void plotRoundRectAsRegion (const VECTOR2I &aRectCenter, const VECTOR2I &aSize, int aCornerRadius, const EDA_ANGLE &aOrient)
 Plot a round rect (a round rect shape in fact) as a Gerber region using lines and arcs for corners. More...
 
void plotArc (const VECTOR2I &aCenter, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aEndAngle, int aRadius, bool aPlotInRegion)
 Plot a Gerber arc. More...
 
void plotArc (const SHAPE_ARC &aArc, bool aPlotInRegion)
 
void selectAperture (const VECTOR2I &aSize, int aRadius, const EDA_ANGLE &aRotation, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 Pick an existing aperture or create a new one, matching the size, type and attributes. More...
 
void selectAperture (const std::vector< VECTOR2I > &aCorners, const EDA_ANGLE &aPolygonRotation, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 Pick an existing aperture or create a new one, matching the aDiameter, aPolygonRotation, type and attributes. More...
 
void selectAperture (int aDiameter, const EDA_ANGLE &aRotation, APERTURE::APERTURE_TYPE aType, int aApertureAttribute)
 Pick an existing aperture or create a new one, matching the corner list, aRotDegree, type and attributes. More...
 
void emitDcode (const VECTOR2D &pt, int dcode)
 Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate. More...
 
void formatNetAttribute (GBR_NETLIST_METADATA *aData)
 Print a Gerber net attribute object record. More...
 
void clearNetAttribute ()
 Clear a Gerber net attribute record (clear object attribute dictionary) and output the clear object attribute dictionary command to gerber file has effect only if a net attribute is stored in m_objectAttributesDictionary. More...
 
void writeApertureList ()
 Generate the table of D codes. More...
 
virtual void polyArc (const VECTOR2D &aCentre, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)
 Generic fallback: arc rendered as a polyline. More...
 
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

std::string m_objectAttributesDictionary
 
int m_apertureAttribute
 
FILE * workFile
 
FILE * finalFile
 
wxString m_workFilename
 
std::vector< APERTUREm_apertures
 
int m_currentApertureIdx
 
bool m_hasApertureRoundRect
 
bool m_hasApertureRotOval
 
bool m_hasApertureRotRect
 
bool m_hasApertureOutline4P
 
bool m_hasApertureChamferedRect
 
bool m_gerberUnitInch
 
int m_gerberUnitFmt
 
bool m_gerberDisableApertMacros
 
bool m_useX2format
 
bool m_useNetAttributes
 
APER_MACRO_FREEPOLY_LIST m_am_freepoly_list
 
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_SETTINGSm_renderSettings
 

Detailed Description

Definition at line 29 of file plotter_gerber.h.

Constructor & Destructor Documentation

◆ GERBER_PLOTTER()

Member Function Documentation

◆ AddLineToHeader()

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

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

Parameters
aExtraStringis the string to print

Definition at line 162 of file plotter.h.

References PLOTTER::m_headerExtraLines.

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

◆ Arc() [1/2]

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

Reimplemented from PLOTTER.

Definition at line 821 of file GERBER_plotter.cpp.

References plotArc(), and SetCurrentLineWidth().

Referenced by Circle(), and ThickArc().

◆ Arc() [2/2]

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

◆ BezierCurve()

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

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

Reimplemented in SVG_PLOTTER.

Definition at line 229 of file plotter.cpp.

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

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

◆ Bookmark()

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

Create a bookmark to a symbol.

Parameters
aBoxis the rectangular click target
aSymbolReferenceis the symbol schematic ref

Reimplemented in PDF_PLOTTER.

Definition at line 474 of file plotter.h.

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

◆ Circle()

void GERBER_PLOTTER::Circle ( const VECTOR2I pos,
int  diametre,
FILL_T  fill,
int  width = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Implements PLOTTER.

Definition at line 813 of file GERBER_plotter.cpp.

References ANGLE_0, ANGLE_180, and Arc().

Referenced by FilledCircle(), FlashPadCircle(), and ThickCircle().

◆ ClearAllAttributes()

void GERBER_PLOTTER::ClearAllAttributes ( )

Remove (clear) all attributes from object attributes dictionary (TO.

and TA commands) similar to clearNetAttribute(), this is an unconditional reset of TO. and TA. attributes.

Definition at line 161 of file GERBER_plotter.cpp.

References m_objectAttributesDictionary, PLOTTER::m_outputFile, and m_useX2format.

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ ClearHeaderLinesList()

void PLOTTER::ClearHeaderLinesList ( )
inlineinherited

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

Definition at line 170 of file plotter.h.

References PLOTTER::m_headerExtraLines.

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

◆ clearNetAttribute()

void GERBER_PLOTTER::clearNetAttribute ( )
protected

Clear a Gerber net attribute record (clear object attribute dictionary) and output the clear object attribute dictionary command to gerber file has effect only if a net attribute is stored in m_objectAttributesDictionary.

Definition at line 173 of file GERBER_plotter.cpp.

References m_objectAttributesDictionary, PLOTTER::m_outputFile, and m_useX2format.

Referenced by EndBlock(), and formatNetAttribute().

◆ DisableApertMacros()

void GERBER_PLOTTER::DisableApertMacros ( bool  aDisable)
inline

Disable Aperture Macro (AM) command, only for broken Gerber Readers.

Regions will be used instead of AM shapes to draw complex shapes.

Parameters
aDisableuse true to disable Aperture Macro (AM) command.

Definition at line 216 of file plotter_gerber.h.

References m_gerberDisableApertMacros.

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

◆ emitDcode()

void GERBER_PLOTTER::emitDcode ( const VECTOR2D pt,
int  dcode 
)
protected

Emit a D-Code record, using proper conversions to format a leading zero omitted gerber coordinate.

For n decimal positions, see header generation in start_plot.

Definition at line 156 of file GERBER_plotter.cpp.

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

Referenced by FlashPadChamferRoundRect(), FlashPadCircle(), FlashPadCustom(), FlashPadOval(), FlashPadRect(), FlashPadRoundRect(), FlashPadTrapez(), FlashRegularPolygon(), and PenTo().

◆ EndBlock()

void GERBER_PLOTTER::EndBlock ( void *  aData)
overridevirtual

Define the end of a group of drawing items the group is started by StartBlock().

Used in X2 format with netlist attributes.

Parameters
aDatacan define any parameter

Reimplemented from PLOTTER.

Definition at line 196 of file GERBER_plotter.cpp.

References clearNetAttribute().

Referenced by GERBER_WRITER::createDrillFile(), and StartBlock().

◆ EndPlot()

◆ FilledCircle()

void GERBER_PLOTTER::FilledCircle ( const VECTOR2I pos,
int  diametre,
OUTLINE_MODE  tracemode,
void *  aData 
)
overridevirtual

◆ FinishTo()

◆ FlashPadChamferRoundRect()

void GERBER_PLOTTER::FlashPadChamferRoundRect ( const VECTOR2I aShapePos,
const VECTOR2I aPadSize,
int  aCornerRadius,
double  aChamferRatio,
int  aChamferPositions,
const EDA_ANGLE aPadOrient,
OUTLINE_MODE  aPlotMode,
void *  aData 
)

Flash a chamfered round rect pad.

Parameters
aShapePosis the position of the pad shape.
aPadSizeis the size of the rectangle.
aCornerRadiusis the radius of rounded corners.
aChamferRatiois the chamfer value (ratio < 0.5 between smallest size and chamfer).
aChamferPositionsis the identifier of the corners to chamfer: 0 = no chamfer 1 = TOP_LEFT 2 = TOP_RIGHT 4 = BOTTOM_LEFT 8 = BOTTOM_RIGHT
aPadOrientis the rotation of the shape.
aPlotModeis the drawing mode, FILLED or SKETCH.
aDatais the a reference to Gerber attributes descr.

Definition at line 1719 of file GERBER_plotter.cpp.

References APERTURE::AM_FREE_POLYGON, ANGLE_0, APERTURE::APER_MACRO_OUTLINE4P, APERTURE::APER_MACRO_OUTLINE5P, APERTURE::APER_MACRO_OUTLINE6P, APERTURE::APER_MACRO_OUTLINE7P, APERTURE::APER_MACRO_OUTLINE8P, SHAPE_LINE_CHAIN::CPoint(), emitDcode(), ERROR_INSIDE, FILLED, formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), PLOTTER::GetPlotterArcHighDef(), m_gerberDisableApertMacros, m_hasApertureChamferedRect, m_hasApertureOutline4P, GBR_METADATA::m_NetlistMetadata, SHAPE_POLY_SET::Outline(), PlotGerberRegion(), PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), RotatePoint(), selectAperture(), SKETCH, TransformRoundChamferedRectToPolygon(), PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BRDITEMS_PLOTTER::PlotPad().

◆ FlashPadCircle()

void GERBER_PLOTTER::FlashPadCircle ( const VECTOR2I pos,
int  diametre,
OUTLINE_MODE  trace_mode,
void *  aData 
)
overridevirtual

◆ FlashPadCustom()

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

Implements PLOTTER.

Definition at line 1650 of file GERBER_plotter.cpp.

References APERTURE::AM_FREE_POLYGON, SHAPE_POLY_SET::CloneDropTriangulation(), SHAPE_LINE_CHAIN::CPoint(), emitDcode(), FILLED, formatNetAttribute(), GBR_MACRO_FOR_CUSTOM_PAD_MAX_CORNER_COUNT, GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), m_gerberDisableApertMacros, GBR_METADATA::m_NetlistMetadata, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PlotGerberRegion(), PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), RotatePoint(), selectAperture(), SetCurrentLineWidth(), SKETCH, PLOTTER::USE_DEFAULT_LINE_WIDTH, PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadOval()

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

Implements PLOTTER.

Definition at line 1281 of file GERBER_plotter.cpp.

References APERTURE::AM_ROTATED_OVAL, ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, APERTURE::AT_OVAL, emitDcode(), FILLED, FlashPadRoundRect(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), EDA_ANGLE::IsCardinal(), EDA_ANGLE::IsCardinal90(), m_gerberDisableApertMacros, m_hasApertureRotOval, GBR_METADATA::m_NetlistMetadata, PLOTTER::m_outputFile, EDA_ANGLE::Normalize(), selectAperture(), PLOTTER::sketchOval(), PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by GERBER_WRITER::createDrillFile().

◆ FlashPadRect()

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

Implements PLOTTER.

Definition at line 1362 of file GERBER_plotter.cpp.

References APERTURE::AM_ROT_RECT, ANGLE_0, APERTURE::AT_RECT, emitDcode(), FlashPadTrapez(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), EDA_ANGLE::IsCardinal(), EDA_ANGLE::IsCardinal90(), m_gerberDisableApertMacros, m_hasApertureRotRect, GBR_METADATA::m_NetlistMetadata, PLOTTER::m_outputFile, Rect(), selectAperture(), SetCurrentLineWidth(), SKETCH, PLOTTER::USE_DEFAULT_LINE_WIDTH, PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadRoundRect()

void GERBER_PLOTTER::FlashPadRoundRect ( const VECTOR2I aPadPos,
const VECTOR2I aSize,
int  aCornerRadius,
const EDA_ANGLE aOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual

◆ FlashPadTrapez()

void GERBER_PLOTTER::FlashPadTrapez ( const VECTOR2I aPadPos,
const VECTOR2I aCorners,
const EDA_ANGLE aPadOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual

Flash a trapezoidal pad.

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

Implements PLOTTER.

Definition at line 1843 of file GERBER_plotter.cpp.

References APERTURE::APER_MACRO_OUTLINE4P, emitDcode(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), m_gerberDisableApertMacros, m_hasApertureOutline4P, GBR_METADATA::m_NetlistMetadata, PlotGerberRegion(), PlotPoly(), RotatePoint(), selectAperture(), SKETCH, and PLOTTER::userToDeviceCoordinates().

Referenced by FlashPadRect().

◆ FlashRegularPolygon()

void GERBER_PLOTTER::FlashRegularPolygon ( const VECTOR2I aShapePos,
int  aDiameter,
int  aCornerCount,
const EDA_ANGLE aOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual

Flash a regular polygon.

Useful only in Gerber files to flash a regular polygon.

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

Implements PLOTTER.

Definition at line 1896 of file GERBER_plotter.cpp.

References ANGLE_360, APERTURE::AT_REGULAR_POLY3, emitDcode(), formatNetAttribute(), GBR_METADATA::GetApertureAttrib(), PLOTTER::GetCurrentLineWidth(), GBR_METADATA::m_NetlistMetadata, PlotPoly(), RotatePoint(), selectAperture(), SKETCH, and PLOTTER::userToDeviceCoordinates().

Referenced by PLACEFILE_GERBER_WRITER::CreatePlaceFile().

◆ formatNetAttribute()

void GERBER_PLOTTER::formatNetAttribute ( GBR_NETLIST_METADATA aData)
protected

Print a Gerber net attribute object record.

In a gerber file, a net attribute is owned by a graphic object formatNetAttribute must be called before creating the object. The generated string depends on the type of netlist info.

Parameters
aDatacontains the data to format.

Definition at line 203 of file GERBER_plotter.cpp.

References clearNetAttribute(), FormatNetAttribute(), GBR_NETLIST_METADATA::m_ExtraData, m_objectAttributesDictionary, PLOTTER::m_outputFile, m_useNetAttributes, m_useX2format, and TO_UTF8.

Referenced by FilledCircle(), FlashPadChamferRoundRect(), FlashPadCircle(), FlashPadCustom(), FlashPadOval(), FlashPadRect(), FlashPadRoundRect(), FlashPadTrapez(), FlashRegularPolygon(), PlotPoly(), PlotText(), Text(), ThickArc(), ThickCircle(), ThickRect(), and ThickSegment().

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( int  aLineWidth) const
protectedinherited

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( int  aLineWidth) const
protectedinherited

◆ GetDefaultFileExtension()

static wxString GERBER_PLOTTER::GetDefaultFileExtension ( )
inlinestatic

Definition at line 39 of file plotter_gerber.h.

Referenced by GetDefaultPlotExtension().

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( int  aLineWidth) const
protectedinherited

◆ GetIUsPerDecimil()

double PLOTTER::GetIUsPerDecimil ( ) const
inlineinherited

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

Here they can be get back again

Definition at line 204 of file plotter.h.

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetOrCreateAperture() [1/2]

int GERBER_PLOTTER::GetOrCreateAperture ( const std::vector< VECTOR2I > &  aCorners,
const EDA_ANGLE aRotation,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
Parameters
aCornersis the corner list.
aRotationis the rotation of tool.
aTypeis the type ( shape ) of tool that can manage a list of corners (polygon).
aApertureAttributeis an aperture attribute of the tool (a tool can have only one attribute) 0 = no specific attribute.
Returns
an index to the aperture in aperture list which meets the data and type of tool if the aperture does not exist, it is created and entered in aperture list.

Definition at line 448 of file GERBER_plotter.cpp.

References APERTURE::AM_FREE_POLYGON, APER_MACRO_FREEPOLY_LIST::Append(), APER_MACRO_FREEPOLY_LIST::FindAm(), m_am_freepoly_list, APERTURE::m_ApertureAttribute, m_apertures, APERTURE::m_Corners, APERTURE::m_DCode, APERTURE::m_Radius, APERTURE::m_Rotation, APERTURE::m_Size, APERTURE::m_Type, and polyCompare().

◆ GetOrCreateAperture() [2/2]

int GERBER_PLOTTER::GetOrCreateAperture ( const VECTOR2I aSize,
int  aRadius,
const EDA_ANGLE aRotation,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
Parameters
aSizeis the size of tool.
aRadiusis the radius used for some shapes tool (oval, roundrect macros).
aRotationis the rotation of tool (primitives round, oval rect accept only 0.0).
aTypeis the type ( shape ) of tool.
aApertureAttributeis an aperture attribute of the tool (a tool can have only one attribute) 0 = no specific attribute.
Returns
an index to the aperture in aperture list which meets the size and type of tool if the aperture does not exist, it is created and entered in aperture list.

Definition at line 415 of file GERBER_plotter.cpp.

References APERTURE::m_ApertureAttribute, m_apertures, APERTURE::m_DCode, APERTURE::m_Radius, APERTURE::m_Rotation, APERTURE::m_Size, and APERTURE::m_Type.

Referenced by selectAperture().

◆ GetPlotterArcHighDef()

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 206 of file plotter.h.

References PLOTTER::m_IUsPerDecimil.

◆ GetPlotterType()

virtual PLOT_FORMAT GERBER_PLOTTER::GetPlotterType ( ) const
inlineoverridevirtual

Returns the effective plot engine in use.

It's not very OO but for now is required since some things are only done with some output devices (like drill marks, emitted only for postscript

Implements PLOTTER.

Definition at line 34 of file plotter_gerber.h.

◆ HyperlinkBox()

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

Create a clickable hyperlink with a rectangular click area.

Parameters
aBoxis the rectangular click target
aDestinationURLis the target URL

Reimplemented in PDF_PLOTTER.

Definition at line 452 of file plotter.h.

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

◆ HyperlinkMenu()

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

Create a clickable hyperlink menu with a rectangular click area.

Parameters
aBoxis the rectangular click target
aDestURLsis the target URL

Reimplemented in PDF_PLOTTER.

Definition at line 463 of file plotter.h.

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

◆ LineTo()

◆ Marker()

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

Draw a pattern shape number aShapeId, to coord position.

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

Definition at line 364 of file plotter.cpp.

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

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

◆ markerBackSlash()

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

Plot a \ bar centered on the position.

Building block for markers

Definition at line 350 of file plotter.cpp.

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

Referenced by PLOTTER::Marker().

◆ markerCircle()

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

Plot a circle centered on the position.

Building block for markers

Definition at line 303 of file plotter.cpp.

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

Referenced by PLOTTER::Marker().

◆ markerHBar()

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

Plot a - bar centered on the position.

Building block for markers

Definition at line 336 of file plotter.cpp.

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

Referenced by PLOTTER::Marker().

◆ markerLozenge()

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

Plot a lozenge centered on the position.

Building block for markers

Definition at line 309 of file plotter.cpp.

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

Referenced by PLOTTER::Marker().

◆ markerSlash()

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

Plot a / bar centered on the position.

Building block for markers

Definition at line 343 of file plotter.cpp.

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

Referenced by PLOTTER::Marker().

◆ markerSquare()

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

Plot a square centered on the position.

Building block for markers

Definition at line 275 of file plotter.cpp.

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

Referenced by PLOTTER::Marker().

◆ markerVBar()

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

Plot a | bar centered on the position.

Building block for markers

Definition at line 357 of file plotter.cpp.

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

Referenced by PLOTTER::Marker().

◆ MoveTo()

◆ OpenFile()

bool PLOTTER::OpenFile ( const wxString &  aFullFilename)
virtualinherited

Open or create the plot file aFullFilename.

Parameters
aFullFilenameis 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.

References PLOTTER::m_filename, and PLOTTER::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 ( )
inlineinherited

◆ PenFinish()

◆ PenTo()

void GERBER_PLOTTER::PenTo ( const VECTOR2I pos,
char  plume 
)
overridevirtual

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

Parameters
posis the target position.
plumespecifies the kind of motion: 'U' only moves the pen, 'D' draw a line from the current position and 'Z' finish the drawing and returns the 'pen' to rest (flushes the trace).

Implements PLOTTER.

Definition at line 770 of file GERBER_plotter.cpp.

References emitDcode(), PLOTTER::m_outputFile, PLOTTER::m_penState, and PLOTTER::userToDeviceCoordinates().

◆ plotArc() [1/2]

◆ plotArc() [2/2]

void GERBER_PLOTTER::plotArc ( const VECTOR2I aCenter,
const EDA_ANGLE aStartAngle,
const EDA_ANGLE aEndAngle,
int  aRadius,
bool  aPlotInRegion 
)
protected

Plot a Gerber arc.

If aPlotInRegion = true, the current pen position will not be initialized to the arc start position, and therefore the arc can be used to define a region outline item a line will be created from current position to arc start point. If aPlotInRegion = false, the current pen position will be initialized to the arc start position, to plot an usual arc item. The line thickness is not initialized in plotArc, and must be initialized before calling it if needed.

Definition at line 871 of file GERBER_plotter.cpp.

References EDA_ANGLE::Cos(), KiROUND(), PLOTTER::LineTo(), PLOTTER::m_outputFile, PLOTTER::MoveTo(), EDA_ANGLE::Sin(), PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Arc(), PlotPoly(), and plotRoundRectAsRegion().

◆ PlotGerberRegion() [1/2]

void GERBER_PLOTTER::PlotGerberRegion ( const SHAPE_LINE_CHAIN aPoly,
GBR_METADATA aGbrMetadata 
)

◆ PlotGerberRegion() [2/2]

void GERBER_PLOTTER::PlotGerberRegion ( const std::vector< VECTOR2I > &  aCornerList,
GBR_METADATA aGbrMetadata 
)

Plot a Gerber region: similar to PlotPoly but plot only filled polygon, and add the TA.AperFunction if aGbrMetadata contains this attribute, and clear it after plotting.

Definition at line 939 of file GERBER_plotter.cpp.

References GBR_APERTURE_METADATA::FormatAttribute(), GBR_METADATA::m_ApertureMetadata, PLOTTER::m_outputFile, m_useX2format, and PlotPoly().

Referenced by FlashPadChamferRoundRect(), FlashPadCustom(), FlashPadTrapez(), and PlotPolyAsRegion().

◆ PlotImage()

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

Only PostScript plotters can plot bitmaps.

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

Parameters
aImageis the bitmap.
aPosis position of the center of the bitmap.
aScaleFactoris 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 259 of file plotter.cpp.

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

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

◆ PlotPoly() [1/2]

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

Draw a polygon ( filled or not ).

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

Plain point

Plain point

Reimplemented from PLOTTER.

Definition at line 988 of file GERBER_plotter.cpp.

References SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::CPoints(), PLOTTER::FinishTo(), formatNetAttribute(), SHAPE_LINE_CHAIN::IsClosed(), PLOTTER::LineTo(), GBR_METADATA::m_NetlistMetadata, PLOTTER::m_outputFile, PLOTTER::MoveTo(), PLOTTER::PenFinish(), plotArc(), SHAPE_LINE_CHAIN::PointCount(), and SetCurrentLineWidth().

◆ PlotPoly() [2/2]

void GERBER_PLOTTER::PlotPoly ( const std::vector< VECTOR2I > &  aCornerList,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = nullptr 
)
overridevirtual

◆ PlotPolyAsRegion()

void GERBER_PLOTTER::PlotPolyAsRegion ( const SHAPE_LINE_CHAIN aPoly,
FILL_T  aFill,
int  aWidth,
GBR_METADATA aGbrMetadata 
)

Similar to PlotPoly(), plot a filled polygon using Gerber region, therefore adding X2 attributes to the region object, like TA.xxx.

Definition at line 975 of file GERBER_plotter.cpp.

References PlotGerberRegion(), and PlotPoly().

◆ plotRoundRectAsRegion()

void GERBER_PLOTTER::plotRoundRectAsRegion ( const VECTOR2I aRectCenter,
const VECTOR2I aSize,
int  aCornerRadius,
const EDA_ANGLE aOrient 
)
protected

Plot a round rect (a round rect shape in fact) as a Gerber region using lines and arcs for corners.

Note
Only the G36 ... G37 region is created.
Parameters
aRectCenteris the center of the rectangle.
aSizeis the size of the rectangle.
aCornerRadiusis the radius of the corners.
aOrientis the rotation of the rectangle.

Definition at line 1521 of file GERBER_plotter.cpp.

References ANGLE_0, ANGLE_180, ANGLE_90, EDA_ANGLE::Cos(), KiROUND(), PLOTTER::LineTo(), PLOTTER::m_outputFile, PLOTTER::MoveTo(), plotArc(), RotatePoint(), EDA_ANGLE::Sin(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by FlashPadRoundRect().

◆ PlotText()

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

Reimplemented from PLOTTER.

Definition at line 1970 of file GERBER_plotter.cpp.

References formatNetAttribute(), GBR_METADATA::m_NetlistMetadata, and PLOTTER::PlotText().

◆ polyArc()

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

Generic fallback: arc rendered as a polyline.

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

Definition at line 180 of file plotter.cpp.

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

Referenced by PLOTTER::Arc().

◆ Rect()

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

Implements PLOTTER.

Definition at line 792 of file GERBER_plotter.cpp.

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

Referenced by FlashPadRect(), and ThickRect().

◆ RenderSettings()

◆ segmentAsOval()

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

Convert a thick segment and plot it as an oval.

Definition at line 486 of file plotter.cpp.

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

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

◆ selectAperture() [1/3]

void GERBER_PLOTTER::selectAperture ( const std::vector< VECTOR2I > &  aCorners,
const EDA_ANGLE aPolygonRotation,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
protected

Pick an existing aperture or create a new one, matching the aDiameter, aPolygonRotation, type and attributes.

It apply only to apertures with type = AT_REGULAR_POLY3 to AT_REGULAR_POLY12 write the DCode selection on gerber file

Definition at line 524 of file GERBER_plotter.cpp.

References GetOrCreateAperture(), m_apertures, m_currentApertureIdx, and PLOTTER::m_outputFile.

◆ selectAperture() [2/3]

void GERBER_PLOTTER::selectAperture ( const VECTOR2I aSize,
int  aRadius,
const EDA_ANGLE aRotation,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
protected

Pick an existing aperture or create a new one, matching the size, type and attributes.

Write the DCode selection on gerber file.

Definition at line 502 of file GERBER_plotter.cpp.

References GetOrCreateAperture(), m_apertures, m_currentApertureIdx, and PLOTTER::m_outputFile.

Referenced by FlashPadChamferRoundRect(), FlashPadCircle(), FlashPadCustom(), FlashPadOval(), FlashPadRect(), FlashPadRoundRect(), FlashPadTrapez(), FlashRegularPolygon(), selectAperture(), and SetCurrentLineWidth().

◆ selectAperture() [3/3]

void GERBER_PLOTTER::selectAperture ( int  aDiameter,
const EDA_ANGLE aRotation,
APERTURE::APERTURE_TYPE  aType,
int  aApertureAttribute 
)
protected

Pick an existing aperture or create a new one, matching the corner list, aRotDegree, type and attributes.

It only applies to apertures managing a polygon that differs from AT_REGULAR_POLY3 to AT_REGULAR_POLY12 (for instance APER_MACRO_TRAPEZOID ) write the DCode selection on gerber file.

Definition at line 558 of file GERBER_plotter.cpp.

References EDA_ANGLE::AsDegrees(), APERTURE::AT_REGULAR_POLY12, APERTURE::AT_REGULAR_POLY3, and selectAperture().

◆ SetColor()

virtual void GERBER_PLOTTER::SetColor ( const COLOR4D aColor)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 56 of file plotter_gerber.h.

◆ SetColorMode()

virtual void PLOTTER::SetColorMode ( bool  aColorMode)
inlinevirtualinherited

◆ SetCreator()

◆ SetCurrentLineWidth()

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

◆ SetDash()

virtual void GERBER_PLOTTER::SetDash ( int  aLineWidth,
LINE_STYLE  aLineStyle 
)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 52 of file plotter_gerber.h.

◆ SetGerberCoordinatesFormat()

void GERBER_PLOTTER::SetGerberCoordinatesFormat ( int  aResolution,
bool  aUseInches = false 
)
overridevirtual

Selection of Gerber units and resolution (number of digits in mantissa).

Should be called only after SetViewport() is called.

Parameters
aResolutionis the number of digits in mantissa of coordinate use 5 or 6 for mm and 6 or 7 for inches do not use value > 6 (mm) or > 7 (in) to avoid overflow.
aUseInchesuse true to use inches, false to use mm (default).

Reimplemented from PLOTTER.

Definition at line 144 of file GERBER_plotter.cpp.

References m_gerberUnitFmt, m_gerberUnitInch, PLOTTER::m_iuPerDeviceUnit, and PLOTTER::m_IUsPerDecimil.

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

◆ SetLayerPolarity()

void GERBER_PLOTTER::SetLayerPolarity ( bool  aPositive)
overridevirtual

Change the plot polarity and begin a new layer.

Used to 'scratch off' silk screen away from solder mask.

Reimplemented from PLOTTER.

Definition at line 1986 of file GERBER_plotter.cpp.

References PLOTTER::m_outputFile.

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 124 of file plotter.h.

References PLOTTER::m_negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

◆ SetRenderSettings()

◆ SetSvgCoordinatesFormat()

virtual void PLOTTER::SetSvgCoordinatesFormat ( unsigned  aPrecision)
inlinevirtualinherited

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

Reimplemented in SVG_PLOTTER.

Definition at line 523 of file plotter.h.

Referenced by initializePlotter().

◆ SetTextMode()

virtual void PLOTTER::SetTextMode ( PLOT_TEXT_MODE  mode)
inlinevirtualinherited

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

Referenced by initializePlotter(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), and PlotOneBoardLayer().

◆ SetTitle()

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

Definition at line 155 of file plotter.h.

References PLOTTER::m_title.

Referenced by SCH_PLOTTER::createPDFFile().

◆ SetViewport()

void GERBER_PLOTTER::SetViewport ( const VECTOR2I aOffset,
double  aIusPerDecimil,
double  aScale,
bool  aMirror 
)
overridevirtual

Set the plot offset and scaling for the current plot.

Parameters
aOffsetis the plot offset.
aIusPerDecimilgives the scaling factor from IUs to device units
aScaleis the user set plot scaling factor (either explicitly or using 'fit to A4').
aMirrorflips the plot in the Y direction (useful for toner transfers or some kind of film).

Implements PLOTTER.

Definition at line 122 of file GERBER_plotter.cpp.

References m_gerberUnitFmt, PLOTTER::m_iuPerDeviceUnit, PLOTTER::m_IUsPerDecimil, PLOTTER::m_paperSize, PLOTTER::m_plotMirror, PLOTTER::m_plotOffset, PLOTTER::m_plotScale, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ sketchOval()

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

◆ StartBlock()

void GERBER_PLOTTER::StartBlock ( void *  aData)
overridevirtual

Calling this function allows one to define the beginning of a group of drawing items (used in X2 format with netlist attributes).

Parameters
aDatacan define any parameter.

Reimplemented from PLOTTER.

Definition at line 189 of file GERBER_plotter.cpp.

References EndBlock().

◆ StartPlot()

◆ Text()

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

Draw text with the plotter.

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

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

Reimplemented from PLOTTER.

Definition at line 1945 of file GERBER_plotter.cpp.

References formatNetAttribute(), GBR_METADATA::m_NetlistMetadata, and PLOTTER::Text().

◆ ThickArc() [1/2]

◆ ThickArc() [2/2]

void GERBER_PLOTTER::ThickArc ( const VECTOR2D aCentre,
const EDA_ANGLE aStartAngle,
const EDA_ANGLE aAngle,
double  aRadius,
int  aWidth,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overrideprotectedvirtual

◆ ThickCircle()

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

◆ ThickRect()

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

◆ ThickSegment()

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

◆ userToDeviceCoordinates()

VECTOR2D PLOTTER::userToDeviceCoordinates ( const VECTOR2I aCoordinate)
protectedvirtualinherited

◆ userToDeviceSize() [1/2]

◆ userToDeviceSize() [2/2]

double PLOTTER::userToDeviceSize ( double  size) const
protectedvirtualinherited

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

Definition at line 122 of file plotter.cpp.

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

◆ UseX2format()

void GERBER_PLOTTER::UseX2format ( bool  aEnable)
inline

◆ UseX2NetAttributes()

void GERBER_PLOTTER::UseX2NetAttributes ( bool  aEnable)
inline

◆ writeApertureList()

Member Data Documentation

◆ DO_NOT_SET_LINE_WIDTH

◆ finalFile

FILE* GERBER_PLOTTER::finalFile
protected

Definition at line 365 of file plotter_gerber.h.

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

◆ m_am_freepoly_list

APER_MACRO_FREEPOLY_LIST GERBER_PLOTTER::m_am_freepoly_list
protected

Definition at line 399 of file plotter_gerber.h.

Referenced by EndPlot(), GetOrCreateAperture(), StartPlot(), and writeApertureList().

◆ m_apertureAttribute

int GERBER_PLOTTER::m_apertureAttribute
protected

Definition at line 362 of file plotter_gerber.h.

Referenced by GERBER_PLOTTER(), and writeApertureList().

◆ m_apertures

std::vector<APERTURE> GERBER_PLOTTER::m_apertures
protected

Definition at line 373 of file plotter_gerber.h.

Referenced by GetOrCreateAperture(), selectAperture(), and writeApertureList().

◆ m_colorMode

◆ m_creator

wxString PLOTTER::m_creator
protectedinherited

◆ m_currentApertureIdx

int GERBER_PLOTTER::m_currentApertureIdx
protected

Definition at line 374 of file plotter_gerber.h.

Referenced by GERBER_PLOTTER(), and selectAperture().

◆ m_currentPenWidth

◆ m_filename

wxString PLOTTER::m_filename
protectedinherited

◆ m_gerberDisableApertMacros

bool GERBER_PLOTTER::m_gerberDisableApertMacros
protected

◆ m_gerberUnitFmt

int GERBER_PLOTTER::m_gerberUnitFmt
protected

◆ m_gerberUnitInch

bool GERBER_PLOTTER::m_gerberUnitInch
protected

◆ m_hasApertureChamferedRect

bool GERBER_PLOTTER::m_hasApertureChamferedRect
protected

Definition at line 380 of file plotter_gerber.h.

Referenced by EndPlot(), FlashPadChamferRoundRect(), GERBER_PLOTTER(), and StartPlot().

◆ m_hasApertureOutline4P

bool GERBER_PLOTTER::m_hasApertureOutline4P
protected

◆ m_hasApertureRotOval

bool GERBER_PLOTTER::m_hasApertureRotOval
protected

Definition at line 376 of file plotter_gerber.h.

Referenced by EndPlot(), FlashPadOval(), GERBER_PLOTTER(), and StartPlot().

◆ m_hasApertureRotRect

bool GERBER_PLOTTER::m_hasApertureRotRect
protected

Definition at line 377 of file plotter_gerber.h.

Referenced by EndPlot(), FlashPadRect(), GERBER_PLOTTER(), and StartPlot().

◆ m_hasApertureRoundRect

bool GERBER_PLOTTER::m_hasApertureRoundRect
protected

Definition at line 375 of file plotter_gerber.h.

Referenced by EndPlot(), FlashPadRoundRect(), GERBER_PLOTTER(), and StartPlot().

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

Definition at line 668 of file plotter.h.

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

◆ m_iuPerDeviceUnit

◆ m_IUsPerDecimil

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

Definition at line 649 of file plotter.h.

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

◆ m_negativeMode

bool PLOTTER::m_negativeMode
protectedinherited

Definition at line 657 of file plotter.h.

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

◆ m_objectAttributesDictionary

std::string GERBER_PLOTTER::m_objectAttributesDictionary
protected

Definition at line 359 of file plotter_gerber.h.

Referenced by ClearAllAttributes(), clearNetAttribute(), and formatNetAttribute().

◆ m_outputFile

FILE* PLOTTER::m_outputFile
protectedinherited

Output file.

Definition at line 653 of file plotter.h.

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

◆ m_pageInfo

◆ m_paperSize

◆ m_penLastpos

VECTOR2I PLOTTER::m_penLastpos
protectedinherited

◆ m_penState

char PLOTTER::m_penState
protectedinherited

◆ m_plotMirror

◆ m_plotOffset

◆ m_plotScale

double PLOTTER::m_plotScale
protectedinherited

◆ m_renderSettings

◆ m_title

wxString PLOTTER::m_title
protectedinherited

Definition at line 664 of file plotter.h.

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

◆ m_useNetAttributes

bool GERBER_PLOTTER::m_useNetAttributes
protected

Definition at line 391 of file plotter_gerber.h.

Referenced by formatNetAttribute(), GERBER_PLOTTER(), and UseX2NetAttributes().

◆ m_useX2format

bool GERBER_PLOTTER::m_useX2format
protected

◆ m_workFilename

wxString GERBER_PLOTTER::m_workFilename
protected

Definition at line 366 of file plotter_gerber.h.

Referenced by EndPlot(), and StartPlot().

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed
protectedinherited

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58
staticinherited

Draw a marker (used for the drill map).

Definition at line 483 of file plotter.h.

Referenced by PLOTTER::Marker().

◆ USE_DEFAULT_LINE_WIDTH

◆ workFile

FILE* GERBER_PLOTTER::workFile
protected

Definition at line 364 of file plotter_gerber.h.

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


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