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

#include <plotter_hpgl.h>

Inheritance diagram for HPGL_PLOTTER:
PLOTTER

Classes

struct  HPGL_ITEM
 

Public Member Functions

 HPGL_PLOTTER ()
 
virtual PLOT_FORMAT GetPlotterType () const override
 Returns the effective plot engine in use.
 
void SetTargetChordLength (double chord_len)
 Set the target length of chords used to draw approximated circles and arcs.
 
void SetUserCoords (bool user_coords)
 Switch to the user coordinate system.
 
void SetUserCoordsFit (bool user_coords_fit)
 Set whether the user coordinate system is fit to content.
 
virtual bool StartPlot (const wxString &aPageNumber) override
 At the start of the HPGL plot pen speed and number are requested.
 
virtual bool EndPlot () override
 HPGL end of plot: sort and emit graphics, pen return and release.
 
virtual void SetColorMode (bool aColorMode) override
 HPGL doesn't handle color.
 
virtual void SetCurrentLineWidth (int width, void *aData=nullptr) override
 HPGL doesn't handle line thickness or color.
 
virtual void SetDash (int aLineWidth, LINE_STYLE aLineStyle) override
 HPGL supports dashed lines.
 
virtual void SetColor (const COLOR4D &color) override
 
virtual void SetPenSpeed (int speed)
 
virtual void SetPenNumber (int number)
 
virtual void SetPenDiameter (double diameter)
 
virtual void SetViewport (const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
 Set the plot offset and scaling for the current plot.
 
virtual void Rect (const VECTOR2I &p1, const VECTOR2I &p2, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
 
virtual void Circle (const VECTOR2I &aCenter, int aDiameter, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH) override
 
virtual void PlotPoly (const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr) override
 Draw a polygon ( filled or not ).
 
virtual void ThickSegment (const VECTOR2I &start, const VECTOR2I &end, int width, OUTLINE_MODE tracemode, void *aData) override
 
virtual void PenTo (const VECTOR2I &pos, char plume) override
 Moveto/lineto primitive, moves the 'pen' to the specified direction.
 
virtual void FlashPadCircle (const VECTOR2I &aPadPos, int aDiameter, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadOval (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadRect (const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &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 &aOrient, SHAPE_POLY_SET *aPolygons, OUTLINE_MODE aTraceMode, void *aData) override
 
virtual void FlashPadTrapez (const VECTOR2I &aPadPos, const VECTOR2I *aCorners, const EDA_ANGLE &aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a trapezoidal pad.
 
virtual void FlashRegularPolygon (const VECTOR2I &aShapePos, int aDiameter, int aCornerCount, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
 Flash a regular polygon.
 
virtual void SetNegative (bool aNegative)
 
bool GetColorMode () const
 
void SetRenderSettings (RENDER_SETTINGS *aSettings)
 
RENDER_SETTINGSRenderSettings ()
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings)
 
PAGE_INFOPageSettings ()
 
virtual int GetCurrentLineWidth () const
 
virtual void SetCreator (const wxString &aCreator)
 
virtual void SetTitle (const wxString &aTitle)
 
virtual void SetAuthor (const wxString &aAuthor)
 
virtual void SetSubject (const wxString &aSubject)
 
void AddLineToHeader (const wxString &aExtraString)
 Add a line to the list of free lines to print at the beginning of the file.
 
void ClearHeaderLinesList ()
 Remove all lines from the list of free lines to print at the beginning of the file.
 
virtual bool OpenFile (const wxString &aFullFilename)
 Open or create the plot file aFullFilename.
 
double GetIUsPerDecimil () const
 The IUs per decimil are an essential scaling factor when plotting; they are set and saved when establishing the viewport.
 
int GetPlotterArcLowDef () const
 
int GetPlotterArcHighDef () const
 
virtual void Arc (const VECTOR2D &aStart, const VECTOR2D &aMid, const VECTOR2D &aEnd, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)
 
virtual void BezierCurve (const VECTOR2I &aStart, const VECTOR2I &aControl1, const VECTOR2I &aControl2, const VECTOR2I &aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH)
 Generic fallback: Cubic Bezier curve rendered as a polyline In KiCad the bezier curves have 4 control points: start ctrl1 ctrl2 end.
 
void MoveTo (const VECTOR2I &pos)
 
void LineTo (const VECTOR2I &pos)
 
void FinishTo (const VECTOR2I &pos)
 
void PenFinish ()
 
virtual void PlotPoly (const SHAPE_LINE_CHAIN &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr)
 Draw a polygon ( filled or not ).
 
virtual void PlotImage (const wxImage &aImage, const VECTOR2I &aPos, double aScaleFactor)
 Only PostScript plotters can plot bitmaps.
 
virtual void ThickArc (const EDA_SHAPE &aArcShape, OUTLINE_MODE aTraceMode, void *aData, int aWidth)
 
virtual void ThickArc (const VECTOR2D &aCentre, const EDA_ANGLE &aStAngle, const EDA_ANGLE &aAngle, double aRadius, int aWidth, OUTLINE_MODE aTraceMode, void *aData)
 
virtual void ThickRect (const VECTOR2I &p1, const VECTOR2I &p2, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void ThickCircle (const VECTOR2I &pos, int diametre, int width, OUTLINE_MODE tracemode, void *aData)
 
virtual void FilledCircle (const VECTOR2I &pos, int diametre, OUTLINE_MODE tracemode, void *aData)
 
virtual void Text (const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify, int aPenWidth, bool aItalic, bool aBold, bool aMultilineAllowed, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics, void *aData=nullptr)
 Draw text with the plotter.
 
virtual void PlotText (const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const TEXT_ATTRIBUTES &aAttributes, KIFONT::FONT *aFont=nullptr, const KIFONT::METRICS &aFontMetrics=KIFONT::METRICS::Default(), void *aData=nullptr)
 
virtual void HyperlinkBox (const BOX2I &aBox, const wxString &aDestinationURL)
 Create a clickable hyperlink with a rectangular click area.
 
virtual void HyperlinkMenu (const BOX2I &aBox, const std::vector< wxString > &aDestURLs)
 Create a clickable hyperlink menu with a rectangular click area.
 
virtual void Bookmark (const BOX2I &aBox, const wxString &aName, const wxString &aGroupName=wxEmptyString)
 Create a bookmark to a symbol.
 
void Marker (const VECTOR2I &position, int diametre, unsigned aShapeId)
 Draw a pattern shape number aShapeId, to coord position.
 
virtual void SetLayerPolarity (bool aPositive)
 Set the current Gerber layer polarity to positive or negative by writing %LPD*% or %LPC*% to the Gerber file, respectively.
 
virtual void SetTextMode (PLOT_TEXT_MODE mode)
 Change the current text mode.
 
virtual void SetGerberCoordinatesFormat (int aResolution, bool aUseInches=false)
 
virtual void SetSvgCoordinatesFormat (unsigned aPrecision)
 Set the number of digits for mantissa in coordinates in mm for SVG plotter.
 
virtual void StartBlock (void *aData)
 calling this function allows one to define the beginning of a group of drawing items, for instance in SVG or Gerber format.
 
virtual void EndBlock (void *aData)
 calling this function allows one to define the end of a group of drawing items for instance in SVG or Gerber format.
 
VECTOR2I GetPlotOffsetUserUnits ()
 

Static Public Member Functions

static wxString GetDefaultFileExtension ()
 

Static Public Attributes

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

Protected Member Functions

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
 Plot an arc.
 
bool startItem (const VECTOR2D &location)
 Start a new HPGL_ITEM if necessary, keeping the current one if it exists.
 
void flushItem ()
 Flush the current HPGL_ITEM and clear out the current item pointer.
 
bool startOrAppendItem (const VECTOR2D &location, const wxString &content)
 Start a new HPGL_ITEM with the given string if necessary, or append the string to the current item.
 
virtual void polyArc (const VECTOR2D &aCentre, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)
 Generic fallback: arc rendered as a polyline.
 
void markerCircle (const VECTOR2I &pos, int radius)
 Plot a circle centered on the position.
 
void markerHBar (const VECTOR2I &pos, int radius)
 Plot a - bar centered on the position.
 
void markerSlash (const VECTOR2I &pos, int radius)
 Plot a / bar centered on the position.
 
void markerBackSlash (const VECTOR2I &pos, int radius)
 Plot a \ bar centered on the position.
 
void markerVBar (const VECTOR2I &pos, int radius)
 Plot a | bar centered on the position.
 
void markerSquare (const VECTOR2I &position, int radius)
 Plot a square centered on the position.
 
void markerLozenge (const VECTOR2I &position, int radius)
 Plot a lozenge centered on the position.
 
void segmentAsOval (const VECTOR2I &start, const VECTOR2I &end, int width, OUTLINE_MODE tracemode)
 Convert a thick segment and plot it as an oval.
 
void sketchOval (const VECTOR2I &aPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, int aWidth)
 
virtual VECTOR2D userToDeviceCoordinates (const VECTOR2I &aCoordinate)
 Modify coordinates according to the orientation, scale factor, and offsets trace.
 
virtual VECTOR2D userToDeviceSize (const VECTOR2I &size)
 Modify size according to the plotter scale factors (VECTOR2I version, returns a VECTOR2D).
 
virtual double userToDeviceSize (double size) const
 Modify size according to the plotter scale factors (simple double version).
 
double GetDotMarkLenIU (int aLineWidth) const
 
double GetDashMarkLenIU (int aLineWidth) const
 
double GetDashGapLenIU (int aLineWidth) const
 

Static Protected Member Functions

static void sortItems (std::list< HPGL_ITEM > &items)
 Sort a list of HPGL items to improve plotting speed on mechanical plotters.
 
static const char * lineStyleCommand (LINE_STYLE aLineStyle)
 Return the plot command corresponding to a line type.
 

Protected Attributes

int m_penSpeed
 
int m_penNumber
 
double m_penDiameter
 
double m_arcTargetChordLength
 
EDA_ANGLE m_arcMinChordDegrees
 
LINE_STYLE m_lineStyle
 
bool m_useUserCoords
 
bool m_fitUserCoords
 
std::list< HPGL_ITEMm_items
 
HPGL_ITEMm_current_item
 
double m_plotScale
 Plot scale - chosen by the user (even implicitly with 'fit in a4')
 
double m_IUsPerDecimil
 
double m_iuPerDeviceUnit
 
VECTOR2I m_plotOffset
 
bool m_plotMirror
 
bool m_mirrorIsHorizontal
 
bool m_yaxisReversed
 
FILE * m_outputFile
 Output file.
 
bool m_colorMode
 
bool m_negativeMode
 
int m_currentPenWidth
 
char m_penState
 
VECTOR2I m_penLastpos
 
wxString m_creator
 
wxString m_filename
 
wxString m_title
 
wxString m_author
 
wxString m_subject
 
PAGE_INFO m_pageInfo
 
VECTOR2I m_paperSize
 
wxArrayString m_headerExtraLines
 
RENDER_SETTINGSm_renderSettings
 
const PROJECTm_project
 

Detailed Description

Definition at line 33 of file plotter_hpgl.h.

Constructor & Destructor Documentation

◆ HPGL_PLOTTER()

HPGL_PLOTTER::HPGL_PLOTTER ( )

Definition at line 222 of file HPGL_plotter.cpp.

References SetPenDiameter(), SetPenNumber(), and SetPenSpeed().

Member Function Documentation

◆ AddLineToHeader()

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

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

Parameters
aExtraStringis the string to print

Definition at line 164 of file plotter.h.

References PLOTTER::m_headerExtraLines.

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

◆ Arc() [1/2]

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

Plot an arc.

Command PU PY x, y; PD start_arc_X AA, start_arc_Y, angle, NbSegm; PU; Or PU PY x, y; PD start_arc_X AA, start_arc_Y, angle, PU;

center is the center of the arc. StAngled is the start angle of the arc. aAngle is angle the arc. Radius is the radius of the arc.

Reimplemented from PLOTTER.

Definition at line 562 of file HPGL_plotter.cpp.

References std::abs(), ANGLE_360, ANGLE_45, EDA_ANGLE::AsDegrees(), HPGL_PLOTTER::HPGL_ITEM::bbox, EDA_ANGLE::Cos(), flushItem(), KiROUND(), HPGL_PLOTTER::HPGL_ITEM::lift_after, m_arcMinChordDegrees, m_arcTargetChordLength, m_current_item, PLOTTER::m_plotMirror, BOX2< Vec >::Merge(), PLOTTER::polyArc(), EDA_ANGLE::Sin(), startOrAppendItem(), PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Arc() [2/2]

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

◆ BezierCurve()

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

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

Reimplemented in SVG_PLOTTER.

Definition at line 230 of file plotter.cpp.

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

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

◆ Bookmark()

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

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

◆ Circle()

◆ ClearHeaderLinesList()

void PLOTTER::ClearHeaderLinesList ( )
inlineinherited

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

Definition at line 172 of file plotter.h.

References PLOTTER::m_headerExtraLines.

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

◆ EndBlock()

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

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

the group is started by StartBlock()

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

Reimplemented in GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 546 of file plotter.h.

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

◆ EndPlot()

◆ FilledCircle()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 663 of file plotter.cpp.

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

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

◆ FinishTo()

◆ FlashPadCircle()

void HPGL_PLOTTER::FlashPadCircle ( const VECTOR2I aPadPos,
int  aDiameter,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual
Parameters
aPadPosPosition of the shape (center of the rectangle.
aDiameteris the diameter of round pad.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDatais an auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 646 of file HPGL_plotter.cpp.

References FILLED, hpgl_end_polygon_cmd, KiROUND(), HPGL_PLOTTER::HPGL_ITEM::lift_before, m_current_item, PLOTTER::m_outputFile, m_penDiameter, PLOTTER::MoveTo(), HPGL_PLOTTER::HPGL_ITEM::pen_returns, PLOTTER::PenFinish(), startOrAppendItem(), PLOTTER::userToDeviceCoordinates(), PLOTTER::userToDeviceSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by FlashPadOval().

◆ FlashPadCustom()

void HPGL_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 766 of file HPGL_plotter.cpp.

References SHAPE_LINE_CHAIN::CPoint(), FILLED, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadOval()

void HPGL_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 609 of file HPGL_plotter.cpp.

References ANGLE_90, FILLED, FlashPadCircle(), FlashPadRect(), KiROUND(), PLOTTER::m_outputFile, m_penDiameter, RotatePoint(), PLOTTER::sketchOval(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadRect()

void HPGL_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 690 of file HPGL_plotter.cpp.

References FILLED, KiROUND(), m_penDiameter, PlotPoly(), RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by FlashPadOval().

◆ FlashPadRoundRect()

void HPGL_PLOTTER::FlashPadRoundRect ( const VECTOR2I aPadPos,
const VECTOR2I aSize,
int  aCornerRadius,
const EDA_ANGLE aOrient,
OUTLINE_MODE  aTraceMode,
void *  aData 
)
overridevirtual
Parameters
aPadPosPosition of the shape (center of the rectangle.
aSizeis the size of rounded rect.
aCornerRadiusRadius of the rounded corners.
aOrientThe rotation of the shape.
aTraceModeis the drawing mode, FILLED or SKETCH.
aDataan auxiliary info (mainly for gerber format attributes).

Implements PLOTTER.

Definition at line 728 of file HPGL_plotter.cpp.

References SHAPE_LINE_CHAIN::CPoint(), ERROR_INSIDE, FILLED, PLOTTER::GetPlotterArcHighDef(), KiROUND(), m_penDiameter, SHAPE_POLY_SET::Outline(), PlotPoly(), SHAPE_LINE_CHAIN::PointCount(), TransformRoundChamferedRectToPolygon(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ FlashPadTrapez()

void HPGL_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 790 of file HPGL_plotter.cpp.

References FILLED, PlotPoly(), and RotatePoint().

◆ FlashRegularPolygon()

void HPGL_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 812 of file HPGL_plotter.cpp.

◆ flushItem()

void HPGL_PLOTTER::flushItem ( )
protected

Flush the current HPGL_ITEM and clear out the current item pointer.

Definition at line 827 of file HPGL_plotter.cpp.

References m_current_item.

Referenced by Arc(), EndPlot(), PenTo(), and SetDash().

◆ GetColorMode()

◆ GetCurrentLineWidth()

◆ GetDashGapLenIU()

double PLOTTER::GetDashGapLenIU ( int  aLineWidth) const
protectedinherited

◆ GetDashMarkLenIU()

double PLOTTER::GetDashMarkLenIU ( int  aLineWidth) const
protectedinherited

◆ GetDefaultFileExtension()

static wxString HPGL_PLOTTER::GetDefaultFileExtension ( )
inlinestatic

Definition at line 43 of file plotter_hpgl.h.

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

◆ GetDotMarkLenIU()

double PLOTTER::GetDotMarkLenIU ( int  aLineWidth) const
protectedinherited

◆ GetIUsPerDecimil()

double PLOTTER::GetIUsPerDecimil ( ) const
inlineinherited

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

Here they can be get back again

Definition at line 206 of file plotter.h.

References PLOTTER::m_IUsPerDecimil.

Referenced by PlotDrawingSheet().

◆ GetPlotOffsetUserUnits()

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

Definition at line 552 of file plotter.h.

References PLOTTER::m_plotOffset.

Referenced by PlotInteractiveLayer().

◆ GetPlotterArcHighDef()

◆ GetPlotterArcLowDef()

int PLOTTER::GetPlotterArcLowDef ( ) const
inlineinherited

Definition at line 208 of file plotter.h.

References PLOTTER::m_IUsPerDecimil.

◆ GetPlotterType()

virtual PLOT_FORMAT HPGL_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 38 of file plotter_hpgl.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 454 of file plotter.h.

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

◆ HyperlinkMenu()

virtual void PLOTTER::HyperlinkMenu ( const BOX2I aBox,
const std::vector< wxString > &  aDestURLs 
)
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 465 of file plotter.h.

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

◆ lineStyleCommand()

const char * HPGL_PLOTTER::lineStyleCommand ( LINE_STYLE  aLineStyle)
staticprotected

Return the plot command corresponding to a line type.

Definition at line 919 of file HPGL_plotter.cpp.

Referenced by EndPlot().

◆ 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 75 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()

void PLOTTER::PenFinish ( )
inlineinherited

◆ PenTo()

void HPGL_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 506 of file HPGL_plotter.cpp.

References HPGL_PLOTTER::HPGL_ITEM::bbox, flushItem(), HPGL_PLOTTER::HPGL_ITEM::loc_end, m_current_item, PLOTTER::m_outputFile, PLOTTER::m_penLastpos, PLOTTER::m_penState, BOX2< Vec >::Merge(), startOrAppendItem(), PLOTTER::userToDeviceCoordinates(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ 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 PLOTTER::PlotPoly ( const SHAPE_LINE_CHAIN aCornerList,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH,
void *  aData = nullptr 
)
virtualinherited

Draw a polygon ( filled or not ).

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

Reimplemented in GERBER_PLOTTER.

Definition at line 677 of file plotter.cpp.

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

◆ PlotPoly() [2/2]

void HPGL_PLOTTER::PlotPoly ( const std::vector< VECTOR2I > &  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 std::vector< VECTOR2I >).
aFillis the type of fill.
aWidthis the line width.
aDatais an auxiliary info (mainly for gerber format).

Implements PLOTTER.

Definition at line 448 of file HPGL_plotter.cpp.

References HPGL_PLOTTER::HPGL_ITEM::content, hpgl_end_polygon_cmd, PLOTTER::LineTo(), m_current_item, PLOTTER::MoveTo(), HPGL_PLOTTER::HPGL_ITEM::pen_returns, PLOTTER::PenFinish(), SetCurrentLineWidth(), startItem(), PLOTTER::USE_DEFAULT_LINE_WIDTH, and PLOTTER::userToDeviceCoordinates().

Referenced by FlashPadCustom(), FlashPadRect(), FlashPadRoundRect(), FlashPadTrapez(), and Rect().

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

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

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

◆ Rect()

void HPGL_PLOTTER::Rect ( const VECTOR2I p1,
const VECTOR2I p2,
FILL_T  aFill,
int  aWidth = USE_DEFAULT_LINE_WIDTH 
)
overridevirtual

Implements PLOTTER.

Definition at line 390 of file HPGL_plotter.cpp.

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

◆ 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 VECTOR2< T >::EuclideanNorm(), PLOTTER::FlashPadOval(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ SetAuthor()

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

Definition at line 156 of file plotter.h.

References PLOTTER::m_author.

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

◆ SetColor()

virtual void HPGL_PLOTTER::SetColor ( const COLOR4D color)
inlineoverridevirtual

Implements PLOTTER.

Definition at line 86 of file plotter_hpgl.h.

◆ SetColorMode()

virtual void HPGL_PLOTTER::SetColorMode ( bool  aColorMode)
inlineoverridevirtual

HPGL doesn't handle color.

Reimplemented from PLOTTER.

Definition at line 72 of file plotter_hpgl.h.

◆ SetCreator()

◆ SetCurrentLineWidth()

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

HPGL doesn't handle line thickness or color.

Implements PLOTTER.

Definition at line 75 of file plotter_hpgl.h.

References PLOTTER::m_currentPenWidth, m_penDiameter, and PLOTTER::userToDeviceSize().

Referenced by Circle(), and PlotPoly().

◆ SetDash()

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

HPGL supports dashed lines.

Implements PLOTTER.

Definition at line 537 of file HPGL_plotter.cpp.

References flushItem(), and m_lineStyle.

◆ SetGerberCoordinatesFormat()

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

Reimplemented in GERBER_PLOTTER.

Definition at line 519 of file plotter.h.

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

◆ SetLayerPolarity()

virtual void PLOTTER::SetLayerPolarity ( bool  aPositive)
inlinevirtualinherited

Set the current Gerber layer polarity to positive or negative by writing %LPD*% or %LPC*% to the Gerber file, respectively.

(obviously starts a new Gerber layer, too)

Parameters
aPositiveis the layer polarity and true for positive. It's not useful with most other plotter since they can't 'scratch' the film like photoplotter imagers do

Reimplemented in GERBER_PLOTTER.

Definition at line 505 of file plotter.h.

Referenced by PlotOneBoardLayer().

◆ SetNegative()

virtual void PLOTTER::SetNegative ( bool  aNegative)
inlinevirtualinherited

Definition at line 125 of file plotter.h.

References PLOTTER::m_negativeMode.

Referenced by FillNegativeKnockout().

◆ SetPageSettings()

◆ SetPenDiameter()

void HPGL_PLOTTER::SetPenDiameter ( double  diameter)
virtual

Definition at line 384 of file HPGL_plotter.cpp.

References m_penDiameter.

Referenced by ConfigureHPGLPenSizes(), HPGL_PLOTTER(), and SCH_PLOTTER::plotOneSheetHpgl().

◆ SetPenNumber()

virtual void HPGL_PLOTTER::SetPenNumber ( int  number)
inlinevirtual

Definition at line 93 of file plotter_hpgl.h.

References m_penNumber.

Referenced by ConfigureHPGLPenSizes(), and HPGL_PLOTTER().

◆ SetPenSpeed()

virtual void HPGL_PLOTTER::SetPenSpeed ( int  speed)
inlinevirtual

Definition at line 88 of file plotter_hpgl.h.

References m_penSpeed.

Referenced by ConfigureHPGLPenSizes(), and HPGL_PLOTTER().

◆ SetRenderSettings()

◆ SetSubject()

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

Definition at line 157 of file plotter.h.

References PLOTTER::m_subject.

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

◆ SetSvgCoordinatesFormat()

virtual void PLOTTER::SetSvgCoordinatesFormat ( unsigned  aPrecision)
inlinevirtualinherited

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

Reimplemented in SVG_PLOTTER.

Definition at line 525 of file plotter.h.

Referenced by initializePlotter().

◆ SetTargetChordLength()

void HPGL_PLOTTER::SetTargetChordLength ( double  chord_len)

Set the target length of chords used to draw approximated circles and arcs.

Parameters
chord_lenthe chord length in IUs.

Definition at line 252 of file HPGL_plotter.cpp.

References m_arcTargetChordLength, and PLOTTER::userToDeviceSize().

Referenced by SCH_PLOTTER::plotOneSheetHpgl().

◆ 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 514 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(), and DIALOG_PLOT::Plot().

◆ SetUserCoords()

void HPGL_PLOTTER::SetUserCoords ( bool  user_coords)
inline

Switch to the user coordinate system.

Definition at line 56 of file plotter_hpgl.h.

References m_useUserCoords.

Referenced by SCH_PLOTTER::plotOneSheetHpgl().

◆ SetUserCoordsFit()

void HPGL_PLOTTER::SetUserCoordsFit ( bool  user_coords_fit)
inline

Set whether the user coordinate system is fit to content.

Definition at line 59 of file plotter_hpgl.h.

References m_fitUserCoords.

Referenced by SCH_PLOTTER::plotOneSheetHpgl().

◆ SetViewport()

void HPGL_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 236 of file HPGL_plotter.cpp.

References PAGE_INFO::GetSizeMils(), PLOTTER::m_iuPerDeviceUnit, PLOTTER::m_IUsPerDecimil, PLOTTER::m_pageInfo, PLOTTER::m_paperSize, PLOTTER::m_plotMirror, PLOTTER::m_plotOffset, PLOTTER::m_plotScale, PLUsPERDECIMIL, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_PLOTTER::plotOneSheetHpgl().

◆ sketchOval()

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

◆ sortItems()

void HPGL_PLOTTER::sortItems ( std::list< HPGL_ITEM > &  items)
staticprotected

Sort a list of HPGL items to improve plotting speed on mechanical plotters.

Parameters
items- items to sort

Definition at line 856 of file HPGL_plotter.cpp.

References dpoint_dist(), HPGL_PLOTTER::HPGL_ITEM::loc_end, and HPGL_PLOTTER::HPGL_ITEM::pen.

Referenced by EndPlot().

◆ StartBlock()

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

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

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

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

Reimplemented in GERBER_PLOTTER, and SVG_PLOTTER.

Definition at line 537 of file plotter.h.

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

◆ startItem()

bool HPGL_PLOTTER::startItem ( const VECTOR2D location)
protected

Start a new HPGL_ITEM if necessary, keeping the current one if it exists.

Parameters
locationis the location of the item.
Returns
whether a new item was made.

Definition at line 821 of file HPGL_plotter.cpp.

References startOrAppendItem().

Referenced by PlotPoly().

◆ startOrAppendItem()

bool HPGL_PLOTTER::startOrAppendItem ( const VECTOR2D location,
const wxString &  content 
)
protected

Start a new HPGL_ITEM with the given string if necessary, or append the string to the current item.

Parameters
locationis the location of the item, if a new one is made.
contentis the content substring.
Returns
whether a new item was made.

Definition at line 833 of file HPGL_plotter.cpp.

References HPGL_PLOTTER::HPGL_ITEM::bbox, HPGL_PLOTTER::HPGL_ITEM::content, HPGL_PLOTTER::HPGL_ITEM::dashType, HPGL_PLOTTER::HPGL_ITEM::loc_end, HPGL_PLOTTER::HPGL_ITEM::loc_start, m_current_item, m_items, m_lineStyle, m_penNumber, and HPGL_PLOTTER::HPGL_ITEM::pen.

Referenced by Arc(), Circle(), FlashPadCircle(), PenTo(), and startItem().

◆ StartPlot()

bool HPGL_PLOTTER::StartPlot ( const wxString &  aPageNumber)
overridevirtual

At the start of the HPGL plot pen speed and number are requested.

Implements PLOTTER.

Definition at line 258 of file HPGL_plotter.cpp.

References PLOTTER::m_outputFile, m_penDiameter, m_penNumber, m_penSpeed, and PLOTTER::userToDeviceSize().

Referenced by SCH_PLOTTER::plotOneSheetHpgl().

◆ Text()

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

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

Definition at line 692 of file plotter.cpp.

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

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

◆ ThickArc() [1/2]

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

◆ ThickArc() [2/2]

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

Reimplemented in GERBER_PLOTTER.

Definition at line 578 of file plotter.cpp.

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

◆ ThickCircle()

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

◆ ThickRect()

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

◆ ThickSegment()

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

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

Member Data Documentation

◆ DO_NOT_SET_LINE_WIDTH

◆ m_arcMinChordDegrees

EDA_ANGLE HPGL_PLOTTER::m_arcMinChordDegrees
protected

Definition at line 222 of file plotter_hpgl.h.

Referenced by Arc(), and Circle().

◆ m_arcTargetChordLength

double HPGL_PLOTTER::m_arcTargetChordLength
protected

Definition at line 221 of file plotter_hpgl.h.

Referenced by Arc(), Circle(), and SetTargetChordLength().

◆ m_author

wxString PLOTTER::m_author
protectedinherited

Definition at line 674 of file plotter.h.

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

◆ m_colorMode

◆ m_creator

wxString PLOTTER::m_creator
protectedinherited

◆ m_current_item

HPGL_ITEM* HPGL_PLOTTER::m_current_item
protected

Definition at line 228 of file plotter_hpgl.h.

Referenced by Arc(), Circle(), FlashPadCircle(), flushItem(), PenTo(), PlotPoly(), and startOrAppendItem().

◆ m_currentPenWidth

◆ m_filename

wxString PLOTTER::m_filename
protectedinherited

◆ m_fitUserCoords

bool HPGL_PLOTTER::m_fitUserCoords
protected

Definition at line 225 of file plotter_hpgl.h.

Referenced by EndPlot(), and SetUserCoordsFit().

◆ m_headerExtraLines

wxArrayString PLOTTER::m_headerExtraLines
protectedinherited

◆ m_items

std::list<HPGL_ITEM> HPGL_PLOTTER::m_items
protected

Definition at line 227 of file plotter_hpgl.h.

Referenced by EndPlot(), and startOrAppendItem().

◆ m_iuPerDeviceUnit

◆ m_IUsPerDecimil

◆ m_lineStyle

LINE_STYLE HPGL_PLOTTER::m_lineStyle
protected

Definition at line 223 of file plotter_hpgl.h.

Referenced by SetDash(), and startOrAppendItem().

◆ m_mirrorIsHorizontal

bool PLOTTER::m_mirrorIsHorizontal
protectedinherited

Definition at line 658 of file plotter.h.

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

◆ m_negativeMode

bool PLOTTER::m_negativeMode
protectedinherited

Definition at line 666 of file plotter.h.

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

◆ m_outputFile

FILE* PLOTTER::m_outputFile
protectedinherited

Output file.

Definition at line 662 of file plotter.h.

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

◆ m_pageInfo

◆ m_paperSize

◆ m_penDiameter

double HPGL_PLOTTER::m_penDiameter
protected

◆ m_penLastpos

VECTOR2I PLOTTER::m_penLastpos
protectedinherited

◆ m_penNumber

int HPGL_PLOTTER::m_penNumber
protected

Definition at line 219 of file plotter_hpgl.h.

Referenced by EndPlot(), SetPenNumber(), startOrAppendItem(), and StartPlot().

◆ m_penSpeed

int HPGL_PLOTTER::m_penSpeed
protected

Definition at line 218 of file plotter_hpgl.h.

Referenced by SetPenSpeed(), and StartPlot().

◆ m_penState

char PLOTTER::m_penState
protectedinherited

◆ m_plotMirror

◆ m_plotOffset

◆ m_plotScale

◆ m_project

const PROJECT* PLOTTER::m_project
protectedinherited

Definition at line 683 of file plotter.h.

Referenced by PDF_PLOTTER::EndPlot().

◆ m_renderSettings

◆ m_subject

wxString PLOTTER::m_subject
protectedinherited

Definition at line 675 of file plotter.h.

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

◆ m_title

wxString PLOTTER::m_title
protectedinherited

Definition at line 673 of file plotter.h.

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

◆ m_useUserCoords

bool HPGL_PLOTTER::m_useUserCoords
protected

Definition at line 224 of file plotter_hpgl.h.

Referenced by EndPlot(), and SetUserCoords().

◆ m_yaxisReversed

bool PLOTTER::m_yaxisReversed
protectedinherited

◆ MARKER_COUNT

const unsigned PLOTTER::MARKER_COUNT = 58
staticinherited

Draw a marker (used for the drill map).

Definition at line 485 of file plotter.h.

Referenced by PLOTTER::Marker().

◆ USE_DEFAULT_LINE_WIDTH


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