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)
 
 SetLayersToExport (self, aLayersToExport)
 
 GetLayer (self)
 
 SetLayer (self, aLayer)
 
 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 8967 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 8972 of file pcbnew.py.

Member Function Documentation

◆ AddLineToHeader()

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

Definition at line 9061 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 9109 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 9116 of file pcbnew.py.

◆ Bookmark()

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

Definition at line 9226 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 9105 of file pcbnew.py.

◆ ClearHeaderLinesList()

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

Definition at line 9065 of file pcbnew.py.

◆ EndBlock()

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

Definition at line 9256 of file pcbnew.py.

◆ EndPlot()

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

Definition at line 8989 of file pcbnew.py.

◆ FilledCircle()

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

Definition at line 9170 of file pcbnew.py.

◆ FinishTo()

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

Definition at line 9132 of file pcbnew.py.

◆ FlashPadCircle()

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

Definition at line 9182 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 9198 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 9186 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 9190 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 9194 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 9202 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 9206 of file pcbnew.py.

◆ GetColorMode()

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

Definition at line 9001 of file pcbnew.py.

◆ GetCurrentLineWidth()

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

Definition at line 9033 of file pcbnew.py.

◆ GetIUsPerDecimil()

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

Definition at line 9089 of file pcbnew.py.

◆ GetLayer()

pcbnew.PLOTTER.GetLayer ( self) 
GetLayer(PLOTTER self) -> PCB_LAYER_ID

Definition at line 9077 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPlotMirrored()

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

Definition at line 9025 of file pcbnew.py.

◆ GetPlotOffsetUserUnits()

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

Definition at line 9260 of file pcbnew.py.

◆ GetPlotterArcHighDef()

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

Definition at line 9097 of file pcbnew.py.

◆ GetPlotterArcLowDef()

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

Definition at line 9093 of file pcbnew.py.

◆ GetPlotterType()

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

Definition at line 8981 of file pcbnew.py.

◆ HyperlinkBox()

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

Definition at line 9218 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 9222 of file pcbnew.py.

◆ LineTo()

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

Definition at line 9128 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 9232 of file pcbnew.py.

◆ MoveTo()

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

Definition at line 9124 of file pcbnew.py.

◆ OpenFile()

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

Definition at line 9085 of file pcbnew.py.

◆ PageSettings()

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

Definition at line 9017 of file pcbnew.py.

◆ PenFinish()

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

Definition at line 9136 of file pcbnew.py.

◆ PenTo()

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

Definition at line 9120 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 9147 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 aLineChain, FILL_T aFill, int aWidth, void * aData)

Definition at line 9140 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 9214 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 9101 of file pcbnew.py.

◆ RenderSettings()

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

Definition at line 9009 of file pcbnew.py.

◆ SetAuthor()

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

Definition at line 9053 of file pcbnew.py.

◆ SetColor()

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

Definition at line 9037 of file pcbnew.py.

◆ SetColorMode()

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

Definition at line 8997 of file pcbnew.py.

◆ SetCreator()

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

Definition at line 9045 of file pcbnew.py.

◆ SetCurrentLineWidth()

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

Definition at line 9029 of file pcbnew.py.

◆ SetDash()

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

Definition at line 9041 of file pcbnew.py.

◆ SetGerberCoordinatesFormat()

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

Definition at line 9244 of file pcbnew.py.

◆ SetLayer()

pcbnew.PLOTTER.SetLayer ( self,
aLayer ) 
SetLayer(PLOTTER self, PCB_LAYER_ID aLayer)

Definition at line 9081 of file pcbnew.py.

◆ SetLayerPolarity()

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

Definition at line 9236 of file pcbnew.py.

◆ SetLayersToExport()

pcbnew.PLOTTER.SetLayersToExport ( self,
aLayersToExport ) 
SetLayersToExport(PLOTTER self, std::vector< std::pair< PCB_LAYER_ID,wxString >,std::allocator< std::pair< PCB_LAYER_ID,wxString > > > const & aLayersToExport)

Definition at line 9073 of file pcbnew.py.

◆ SetNegative()

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

Definition at line 8993 of file pcbnew.py.

◆ SetPageSettings()

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

Definition at line 9013 of file pcbnew.py.

◆ SetPlotMirrored()

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

Definition at line 9021 of file pcbnew.py.

◆ SetRenderSettings()

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

Definition at line 9005 of file pcbnew.py.

◆ SetSubject()

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

Definition at line 9057 of file pcbnew.py.

◆ SetSvgCoordinatesFormat()

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

Definition at line 9248 of file pcbnew.py.

◆ SetTextMode()

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

Definition at line 9240 of file pcbnew.py.

◆ SetTitle()

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

Definition at line 9049 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 9069 of file pcbnew.py.

◆ StartBlock()

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

Definition at line 9252 of file pcbnew.py.

◆ StartPlot()

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

Definition at line 8985 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 9210 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 9155 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 9166 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 9174 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 9178 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 9162 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 9151 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 8975 of file pcbnew.py.

◆ MARKER_COUNT

pcbnew.PLOTTER.MARKER_COUNT = _pcbnew.PLOTTER_MARKER_COUNT
static

Definition at line 9229 of file pcbnew.py.

◆ USE_DEFAULT_LINE_WIDTH

pcbnew.PLOTTER.USE_DEFAULT_LINE_WIDTH = _pcbnew.PLOTTER_USE_DEFAULT_LINE_WIDTH
static

Definition at line 8977 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 8970 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Tue May 19 2026 20:48:29 for KiCad Pcbnew Python Scripting by doxygen 1.13.2