KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
pcbnew.PLOTTER Class Reference
Inheritance diagram for pcbnew.PLOTTER:
Inheritance graph
[legend]

Public Member Functions

 __init__ (self, *args, **kwargs)
 
 GetPlotterType (self)
 
 StartPlot (self, aPageNumber)
 
 EndPlot (self)
 
 SetNegative (self, aNegative)
 
 SetColorMode (self, aColorMode)
 
 GetColorMode (self)
 
 SetRenderSettings (self, aSettings)
 
 RenderSettings (self)
 
 SetPageSettings (self, aPageSettings)
 
 PageSettings (self)
 
 SetPlotMirrored (self, aMirror)
 
 GetPlotMirrored (self)
 
 SetCurrentLineWidth (self, width, aData=None)
 
 GetCurrentLineWidth (self)
 
 SetColor (self, color)
 
 SetDash (self, aLineWidth, aLineStyle)
 
 SetCreator (self, aCreator)
 
 SetTitle (self, aTitle)
 
 SetAuthor (self, aAuthor)
 
 SetSubject (self, aSubject)
 
 AddLineToHeader (self, aExtraString)
 
 ClearHeaderLinesList (self)
 
 SetViewport (self, aOffset, aIusPerDecimil, aScale, aMirror)
 
 OpenFile (self, aFullFilename)
 
 GetIUsPerDecimil (self)
 
 GetPlotterArcLowDef (self)
 
 GetPlotterArcHighDef (self)
 
 Rect (self, p1, p2, fill, width, aCornerRadius=0)
 
 Circle (self, pos, diametre, fill, width)
 
 Arc (self, *args)
 
 BezierCurve (self, aStart, aControl1, aControl2, aEnd, aTolerance, aLineThickness)
 
 PenTo (self, pos, plume)
 
 MoveTo (self, pos)
 
 LineTo (self, pos)
 
 FinishTo (self, pos)
 
 PenFinish (self)
 
 PlotPoly (self, *args)
 
 PlotImage (self, aImage, aPos, aScaleFactor)
 
 ThickSegment (self, start, end, width, aData)
 
 ThickArc (self, *args)
 
 ThickRect (self, p1, p2, width, aData)
 
 ThickCircle (self, pos, diametre, width, aData)
 
 FilledCircle (self, pos, diametre, aData)
 
 ThickOval (self, aPos, aSize, aOrient, aWidth, aData)
 
 ThickPoly (self, aPoly, aWidth, aData)
 
 FlashPadCircle (self, aPadPos, aDiameter, aData)
 
 FlashPadOval (self, aPadPos, aSize, aPadOrient, aData)
 
 FlashPadRect (self, aPadPos, aSize, aPadOrient, aData)
 
 FlashPadRoundRect (self, aPadPos, aSize, aCornerRadius, aOrient, aData)
 
 FlashPadCustom (self, aPadPos, aSize, aPadOrient, aPolygons, aData)
 
 FlashPadTrapez (self, aPadPos, aCorners, aPadOrient, aData)
 
 FlashRegularPolygon (self, aShapePos, aDiameter, aCornerCount, aOrient, aData)
 
 Text (self, aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aPenWidth, aItalic, aBold, aMultilineAllowed, aFont, aFontMetrics, aData=None)
 
 PlotText (self, *args)
 
 HyperlinkBox (self, aBox, aDestinationURL)
 
 HyperlinkMenu (self, aBox, aDestURLs)
 
 Bookmark (self, *args)
 
 Marker (self, position, diametre, aShapeId)
 
 SetLayerPolarity (self, aPositive)
 
 SetTextMode (self, mode)
 
 SetGerberCoordinatesFormat (self, aResolution, aUseInches=False)
 
 SetSvgCoordinatesFormat (self, aPrecision)
 
 StartBlock (self, aData)
 
 EndBlock (self, aData)
 
 GetPlotOffsetUserUnits (self)
 

Static Public Attributes

 DO_NOT_SET_LINE_WIDTH = _pcbnew.PLOTTER_DO_NOT_SET_LINE_WIDTH
 
 USE_DEFAULT_LINE_WIDTH = _pcbnew.PLOTTER_USE_DEFAULT_LINE_WIDTH
 
 MARKER_COUNT = _pcbnew.PLOTTER_MARKER_COUNT
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Proxy of C++ PLOTTER class.

Definition at line 8835 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.PLOTTER.__init__ ( self,
* args,
** kwargs )

Definition at line 8840 of file pcbnew.py.

Member Function Documentation

◆ AddLineToHeader()

pcbnew.PLOTTER.AddLineToHeader ( self,
aExtraString ) 
AddLineToHeader(PLOTTER self, wxString aExtraString)

Definition at line 8929 of file pcbnew.py.

◆ Arc()

pcbnew.PLOTTER.Arc ( self,
* args ) 
    Arc(PLOTTER self, VECTOR2D const & aStart, VECTOR2D const & aMid, VECTOR2D const & aEnd, FILL_T aFill, int aWidth)
    Arc(PLOTTER self, VECTOR2D const & aCenter, EDA_ANGLE aStartAngle, EDA_ANGLE aAngle, double aRadius, FILL_T aFill, int aWidth)

Definition at line 8965 of file pcbnew.py.

Here is the caller graph for this function:

◆ BezierCurve()

pcbnew.PLOTTER.BezierCurve ( self,
aStart,
aControl1,
aControl2,
aEnd,
aTolerance,
aLineThickness ) 
BezierCurve(PLOTTER self, VECTOR2I aStart, VECTOR2I aControl1, VECTOR2I aControl2, VECTOR2I aEnd, int aTolerance, int aLineThickness)

Definition at line 8972 of file pcbnew.py.

◆ Bookmark()

pcbnew.PLOTTER.Bookmark ( self,
* args ) 
Bookmark(PLOTTER self, BOX2I aBox, wxString aName, wxString aGroupName=wxEmptyString)

Definition at line 9082 of file pcbnew.py.

◆ Circle()

pcbnew.PLOTTER.Circle ( self,
pos,
diametre,
fill,
width ) 
Circle(PLOTTER self, VECTOR2I pos, int diametre, FILL_T fill, int width)

Definition at line 8961 of file pcbnew.py.

◆ ClearHeaderLinesList()

pcbnew.PLOTTER.ClearHeaderLinesList ( self) 
ClearHeaderLinesList(PLOTTER self)

Definition at line 8933 of file pcbnew.py.

◆ EndBlock()

pcbnew.PLOTTER.EndBlock ( self,
aData ) 
EndBlock(PLOTTER self, void * aData)

Definition at line 9112 of file pcbnew.py.

◆ EndPlot()

pcbnew.PLOTTER.EndPlot ( self) 
EndPlot(PLOTTER self) -> bool

Definition at line 8857 of file pcbnew.py.

◆ FilledCircle()

pcbnew.PLOTTER.FilledCircle ( self,
pos,
diametre,
aData ) 
FilledCircle(PLOTTER self, VECTOR2I pos, int diametre, void * aData)

Definition at line 9026 of file pcbnew.py.

◆ FinishTo()

pcbnew.PLOTTER.FinishTo ( self,
pos ) 
FinishTo(PLOTTER self, VECTOR2I pos)

Definition at line 8988 of file pcbnew.py.

◆ FlashPadCircle()

pcbnew.PLOTTER.FlashPadCircle ( self,
aPadPos,
aDiameter,
aData ) 
FlashPadCircle(PLOTTER self, VECTOR2I aPadPos, int aDiameter, void * aData)

Definition at line 9038 of file pcbnew.py.

◆ FlashPadCustom()

pcbnew.PLOTTER.FlashPadCustom ( self,
aPadPos,
aSize,
aPadOrient,
aPolygons,
aData ) 
FlashPadCustom(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aSize, EDA_ANGLE aPadOrient, SHAPE_POLY_SET aPolygons, void * aData)

Definition at line 9054 of file pcbnew.py.

◆ FlashPadOval()

pcbnew.PLOTTER.FlashPadOval ( self,
aPadPos,
aSize,
aPadOrient,
aData ) 
FlashPadOval(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aSize, EDA_ANGLE aPadOrient, void * aData)

Definition at line 9042 of file pcbnew.py.

◆ FlashPadRect()

pcbnew.PLOTTER.FlashPadRect ( self,
aPadPos,
aSize,
aPadOrient,
aData ) 
FlashPadRect(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aSize, EDA_ANGLE aPadOrient, void * aData)

Definition at line 9046 of file pcbnew.py.

◆ FlashPadRoundRect()

pcbnew.PLOTTER.FlashPadRoundRect ( self,
aPadPos,
aSize,
aCornerRadius,
aOrient,
aData ) 
FlashPadRoundRect(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aSize, int aCornerRadius, EDA_ANGLE aOrient, void * aData)

Definition at line 9050 of file pcbnew.py.

◆ FlashPadTrapez()

pcbnew.PLOTTER.FlashPadTrapez ( self,
aPadPos,
aCorners,
aPadOrient,
aData ) 
FlashPadTrapez(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aCorners, EDA_ANGLE aPadOrient, void * aData)

Definition at line 9058 of file pcbnew.py.

◆ FlashRegularPolygon()

pcbnew.PLOTTER.FlashRegularPolygon ( self,
aShapePos,
aDiameter,
aCornerCount,
aOrient,
aData ) 
FlashRegularPolygon(PLOTTER self, VECTOR2I aShapePos, int aDiameter, int aCornerCount, EDA_ANGLE aOrient, void * aData)

Definition at line 9062 of file pcbnew.py.

◆ GetColorMode()

pcbnew.PLOTTER.GetColorMode ( self) 
GetColorMode(PLOTTER self) -> bool

Definition at line 8869 of file pcbnew.py.

◆ GetCurrentLineWidth()

pcbnew.PLOTTER.GetCurrentLineWidth ( self) 
GetCurrentLineWidth(PLOTTER self) -> int

Definition at line 8901 of file pcbnew.py.

◆ GetIUsPerDecimil()

pcbnew.PLOTTER.GetIUsPerDecimil ( self) 
GetIUsPerDecimil(PLOTTER self) -> double

Definition at line 8945 of file pcbnew.py.

◆ GetPlotMirrored()

pcbnew.PLOTTER.GetPlotMirrored ( self) 
GetPlotMirrored(PLOTTER self) -> bool

Definition at line 8893 of file pcbnew.py.

◆ GetPlotOffsetUserUnits()

pcbnew.PLOTTER.GetPlotOffsetUserUnits ( self) 
GetPlotOffsetUserUnits(PLOTTER self) -> VECTOR2I

Definition at line 9116 of file pcbnew.py.

◆ GetPlotterArcHighDef()

pcbnew.PLOTTER.GetPlotterArcHighDef ( self) 
GetPlotterArcHighDef(PLOTTER self) -> int

Definition at line 8953 of file pcbnew.py.

◆ GetPlotterArcLowDef()

pcbnew.PLOTTER.GetPlotterArcLowDef ( self) 
GetPlotterArcLowDef(PLOTTER self) -> int

Definition at line 8949 of file pcbnew.py.

◆ GetPlotterType()

pcbnew.PLOTTER.GetPlotterType ( self) 
GetPlotterType(PLOTTER self) -> PLOT_FORMAT

Definition at line 8849 of file pcbnew.py.

◆ HyperlinkBox()

pcbnew.PLOTTER.HyperlinkBox ( self,
aBox,
aDestinationURL ) 
HyperlinkBox(PLOTTER self, BOX2I aBox, wxString aDestinationURL)

Definition at line 9074 of file pcbnew.py.

◆ HyperlinkMenu()

pcbnew.PLOTTER.HyperlinkMenu ( self,
aBox,
aDestURLs ) 
HyperlinkMenu(PLOTTER self, BOX2I aBox, std::vector< wxString,std::allocator< wxString > > const & aDestURLs)

Definition at line 9078 of file pcbnew.py.

◆ LineTo()

pcbnew.PLOTTER.LineTo ( self,
pos ) 
LineTo(PLOTTER self, VECTOR2I pos)

Definition at line 8984 of file pcbnew.py.

◆ Marker()

pcbnew.PLOTTER.Marker ( self,
position,
diametre,
aShapeId ) 
Marker(PLOTTER self, VECTOR2I position, int diametre, unsigned int aShapeId)

Definition at line 9088 of file pcbnew.py.

◆ MoveTo()

pcbnew.PLOTTER.MoveTo ( self,
pos ) 
MoveTo(PLOTTER self, VECTOR2I pos)

Definition at line 8980 of file pcbnew.py.

◆ OpenFile()

pcbnew.PLOTTER.OpenFile ( self,
aFullFilename ) 
OpenFile(PLOTTER self, wxString aFullFilename) -> bool

Definition at line 8941 of file pcbnew.py.

◆ PageSettings()

pcbnew.PLOTTER.PageSettings ( self) 
PageSettings(PLOTTER self) -> PAGE_INFO &

Definition at line 8885 of file pcbnew.py.

◆ PenFinish()

pcbnew.PLOTTER.PenFinish ( self) 
PenFinish(PLOTTER self)

Definition at line 8992 of file pcbnew.py.

◆ PenTo()

pcbnew.PLOTTER.PenTo ( self,
pos,
plume ) 
PenTo(PLOTTER self, VECTOR2I pos, char plume)

Definition at line 8976 of file pcbnew.py.

◆ PlotImage()

pcbnew.PLOTTER.PlotImage ( self,
aImage,
aPos,
aScaleFactor ) 
PlotImage(PLOTTER self, wxImage const & aImage, VECTOR2I aPos, double aScaleFactor)

Definition at line 9003 of file pcbnew.py.

◆ PlotPoly()

pcbnew.PLOTTER.PlotPoly ( self,
* args ) 
    PlotPoly(PLOTTER self, VECTOR_VECTOR2I aCornerList, FILL_T aFill, int aWidth, void * aData)
    PlotPoly(PLOTTER self, SHAPE_LINE_CHAIN aCornerList, FILL_T aFill, int aWidth, void * aData)

Definition at line 8996 of file pcbnew.py.

◆ PlotText()

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

Definition at line 9070 of file pcbnew.py.

◆ Rect()

pcbnew.PLOTTER.Rect ( self,
p1,
p2,
fill,
width,
aCornerRadius = 0 ) 
Rect(PLOTTER self, VECTOR2I p1, VECTOR2I p2, FILL_T fill, int width, int aCornerRadius=0)

Definition at line 8957 of file pcbnew.py.

◆ RenderSettings()

pcbnew.PLOTTER.RenderSettings ( self) 
RenderSettings(PLOTTER self) -> RENDER_SETTINGS *

Definition at line 8877 of file pcbnew.py.

◆ SetAuthor()

pcbnew.PLOTTER.SetAuthor ( self,
aAuthor ) 
SetAuthor(PLOTTER self, wxString aAuthor)

Definition at line 8921 of file pcbnew.py.

◆ SetColor()

pcbnew.PLOTTER.SetColor ( self,
color ) 
SetColor(PLOTTER self, COLOR4D color)

Definition at line 8905 of file pcbnew.py.

◆ SetColorMode()

pcbnew.PLOTTER.SetColorMode ( self,
aColorMode ) 
SetColorMode(PLOTTER self, bool aColorMode)

Definition at line 8865 of file pcbnew.py.

◆ SetCreator()

pcbnew.PLOTTER.SetCreator ( self,
aCreator ) 
SetCreator(PLOTTER self, wxString aCreator)

Definition at line 8913 of file pcbnew.py.

◆ SetCurrentLineWidth()

pcbnew.PLOTTER.SetCurrentLineWidth ( self,
width,
aData = None ) 
SetCurrentLineWidth(PLOTTER self, int width, void * aData=None)

Definition at line 8897 of file pcbnew.py.

◆ SetDash()

pcbnew.PLOTTER.SetDash ( self,
aLineWidth,
aLineStyle ) 
SetDash(PLOTTER self, int aLineWidth, LINE_STYLE aLineStyle)

Definition at line 8909 of file pcbnew.py.

◆ SetGerberCoordinatesFormat()

pcbnew.PLOTTER.SetGerberCoordinatesFormat ( self,
aResolution,
aUseInches = False ) 
SetGerberCoordinatesFormat(PLOTTER self, int aResolution, bool aUseInches=False)

Definition at line 9100 of file pcbnew.py.

◆ SetLayerPolarity()

pcbnew.PLOTTER.SetLayerPolarity ( self,
aPositive ) 
SetLayerPolarity(PLOTTER self, bool aPositive)

Definition at line 9092 of file pcbnew.py.

◆ SetNegative()

pcbnew.PLOTTER.SetNegative ( self,
aNegative ) 
SetNegative(PLOTTER self, bool aNegative)

Definition at line 8861 of file pcbnew.py.

◆ SetPageSettings()

pcbnew.PLOTTER.SetPageSettings ( self,
aPageSettings ) 
SetPageSettings(PLOTTER self, PAGE_INFO const & aPageSettings)

Definition at line 8881 of file pcbnew.py.

◆ SetPlotMirrored()

pcbnew.PLOTTER.SetPlotMirrored ( self,
aMirror ) 
SetPlotMirrored(PLOTTER self, bool aMirror)

Definition at line 8889 of file pcbnew.py.

◆ SetRenderSettings()

pcbnew.PLOTTER.SetRenderSettings ( self,
aSettings ) 
SetRenderSettings(PLOTTER self, RENDER_SETTINGS * aSettings)

Definition at line 8873 of file pcbnew.py.

◆ SetSubject()

pcbnew.PLOTTER.SetSubject ( self,
aSubject ) 
SetSubject(PLOTTER self, wxString aSubject)

Definition at line 8925 of file pcbnew.py.

◆ SetSvgCoordinatesFormat()

pcbnew.PLOTTER.SetSvgCoordinatesFormat ( self,
aPrecision ) 
SetSvgCoordinatesFormat(PLOTTER self, unsigned int aPrecision)

Definition at line 9104 of file pcbnew.py.

◆ SetTextMode()

pcbnew.PLOTTER.SetTextMode ( self,
mode ) 
SetTextMode(PLOTTER self, PLOT_TEXT_MODE mode)

Definition at line 9096 of file pcbnew.py.

◆ SetTitle()

pcbnew.PLOTTER.SetTitle ( self,
aTitle ) 
SetTitle(PLOTTER self, wxString aTitle)

Definition at line 8917 of file pcbnew.py.

◆ SetViewport()

pcbnew.PLOTTER.SetViewport ( self,
aOffset,
aIusPerDecimil,
aScale,
aMirror ) 
SetViewport(PLOTTER self, VECTOR2I aOffset, double aIusPerDecimil, double aScale, bool aMirror)

Definition at line 8937 of file pcbnew.py.

◆ StartBlock()

pcbnew.PLOTTER.StartBlock ( self,
aData ) 
StartBlock(PLOTTER self, void * aData)

Definition at line 9108 of file pcbnew.py.

◆ StartPlot()

pcbnew.PLOTTER.StartPlot ( self,
aPageNumber ) 
StartPlot(PLOTTER self, wxString aPageNumber) -> bool

Definition at line 8853 of file pcbnew.py.

◆ Text()

pcbnew.PLOTTER.Text ( self,
aPos,
aColor,
aText,
aOrient,
aSize,
aH_justify,
aV_justify,
aPenWidth,
aItalic,
aBold,
aMultilineAllowed,
aFont,
aFontMetrics,
aData = None ) 
Text(PLOTTER self, VECTOR2I aPos, COLOR4D aColor, wxString aText, EDA_ANGLE aOrient, 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, KIFONT::METRICS const & aFontMetrics, void * aData=None)

Definition at line 9066 of file pcbnew.py.

◆ ThickArc()

pcbnew.PLOTTER.ThickArc ( self,
* args ) 
    ThickArc(PLOTTER self, EDA_SHAPE aArcShape, void * aData, int aWidth)
    ThickArc(PLOTTER self, VECTOR2D const & aCentre, EDA_ANGLE aStAngle, EDA_ANGLE aAngle, double aRadius, int aWidth, void * aData)

Definition at line 9011 of file pcbnew.py.

◆ ThickCircle()

pcbnew.PLOTTER.ThickCircle ( self,
pos,
diametre,
width,
aData ) 
ThickCircle(PLOTTER self, VECTOR2I pos, int diametre, int width, void * aData)

Definition at line 9022 of file pcbnew.py.

◆ ThickOval()

pcbnew.PLOTTER.ThickOval ( self,
aPos,
aSize,
aOrient,
aWidth,
aData ) 
ThickOval(PLOTTER self, VECTOR2I aPos, VECTOR2I aSize, EDA_ANGLE aOrient, int aWidth, void * aData)

Definition at line 9030 of file pcbnew.py.

◆ ThickPoly()

pcbnew.PLOTTER.ThickPoly ( self,
aPoly,
aWidth,
aData ) 
ThickPoly(PLOTTER self, SHAPE_POLY_SET aPoly, int aWidth, void * aData)

Definition at line 9034 of file pcbnew.py.

◆ ThickRect()

pcbnew.PLOTTER.ThickRect ( self,
p1,
p2,
width,
aData ) 
ThickRect(PLOTTER self, VECTOR2I p1, VECTOR2I p2, int width, void * aData)

Definition at line 9018 of file pcbnew.py.

◆ ThickSegment()

pcbnew.PLOTTER.ThickSegment ( self,
start,
end,
width,
aData ) 
ThickSegment(PLOTTER self, VECTOR2I start, VECTOR2I end, int width, void * aData)

Definition at line 9007 of file pcbnew.py.

Member Data Documentation

◆ DO_NOT_SET_LINE_WIDTH

pcbnew.PLOTTER.DO_NOT_SET_LINE_WIDTH = _pcbnew.PLOTTER_DO_NOT_SET_LINE_WIDTH
static

Definition at line 8843 of file pcbnew.py.

◆ MARKER_COUNT

pcbnew.PLOTTER.MARKER_COUNT = _pcbnew.PLOTTER_MARKER_COUNT
static

Definition at line 9085 of file pcbnew.py.

◆ USE_DEFAULT_LINE_WIDTH

pcbnew.PLOTTER.USE_DEFAULT_LINE_WIDTH = _pcbnew.PLOTTER_USE_DEFAULT_LINE_WIDTH
static

Definition at line 8845 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.PLOTTER.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 8838 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Sun Sep 21 2025 01:08:20 for KiCad Pcbnew Python Scripting by doxygen 1.13.2