KiCad Pcbnew Python Scripting
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

def __init__ (self, *args, **kwargs)
 
"PLOT_FORMAT" GetPlotterType (self)
 
"bool" StartPlot (self)
 
"bool" EndPlot (self)
 
"void" SetNegative (self, "bool" aNegative)
 
"void" SetColorMode (self, "bool" aColorMode)
 
"bool" GetColorMode (self)
 
"void" SetRenderSettings (self, "RENDER_SETTINGS *" aSettings)
 
"RENDER_SETTINGS *" RenderSettings (self)
 
"void" SetPageSettings (self, "PAGE_INFO const &" aPageSettings)
 
"PAGE_INFO &" PageSettings (self)
 
"void" SetCurrentLineWidth (self, "int" width, "void *" aData=None)
 
"int" GetCurrentLineWidth (self)
 
"void" SetColor (self, "COLOR4D" color)
 
"void" SetDash (self, "PLOT_DASH_TYPE" dashed)
 
"void" SetCreator (self, "wxString" aCreator)
 
"void" SetTitle (self, "wxString" aTitle)
 
"void" AddLineToHeader (self, "wxString" aExtraString)
 
"void" ClearHeaderLinesList (self)
 
"void" SetViewport (self, "wxPoint" aOffset, "double" aIusPerDecimil, "double" aScale, "bool" aMirror)
 
"bool" OpenFile (self, "wxString" aFullFilename)
 
"double" GetIUsPerDecimil (self)
 
"int" GetPlotterArcLowDef (self)
 
"int" GetPlotterArcHighDef (self)
 
"void" Rect (self, *args)
 
"void" Circle (self, *args)
 
"void" Arc (self, *args)
 
"void" BezierCurve (self, *args)
 
"void" PenTo (self, "wxPoint" pos, "char" plume)
 
"void" MoveTo (self, "wxPoint" pos)
 
"void" LineTo (self, "wxPoint" pos)
 
"void" FinishTo (self, "wxPoint" pos)
 
"void" PenFinish (self)
 
"void" PlotPoly (self, *args)
 
"void" PlotImage (self, "wxImage const &" aImage, "wxPoint" aPos, "double" aScaleFactor)
 
"void" ThickSegment (self, "wxPoint" start, "wxPoint" end, "int" width, "OUTLINE_MODE" tracemode, "void *" aData)
 
"void" ThickArc (self, "wxPoint" centre, "double" StAngle, "double" EndAngle, "int" rayon, "int" width, "OUTLINE_MODE" tracemode, "void *" aData)
 
"void" ThickRect (self, "wxPoint" p1, "wxPoint" p2, "int" width, "OUTLINE_MODE" tracemode, "void *" aData)
 
"void" ThickCircle (self, "wxPoint" pos, "int" diametre, "int" width, "OUTLINE_MODE" tracemode, "void *" aData)
 
"void" FilledCircle (self, "wxPoint" pos, "int" diametre, "OUTLINE_MODE" tracemode, "void *" aData)
 
"void" FlashPadCircle (self, "wxPoint" aPadPos, "int" aDiameter, "OUTLINE_MODE" aTraceMode, "void *" aData)
 
"void" FlashPadOval (self, "wxPoint" aPadPos, "wxSize" aSize, "double" aPadOrient, "OUTLINE_MODE" aTraceMode, "void *" aData)
 
"void" FlashPadRect (self, "wxPoint" aPadPos, "wxSize" aSize, "double" aPadOrient, "OUTLINE_MODE" aTraceMode, "void *" aData)
 
"void" FlashPadRoundRect (self, "wxPoint" aPadPos, "wxSize" aSize, "int" aCornerRadius, "double" aOrient, "OUTLINE_MODE" aTraceMode, "void *" aData)
 
"void" FlashPadCustom (self, "wxPoint" aPadPos, "wxSize" aSize, "double" aPadOrient, "SHAPE_POLY_SET" aPolygons, "OUTLINE_MODE" aTraceMode, "void *" aData)
 
"void" FlashPadTrapez (self, "wxPoint" aPadPos, "wxPoint" aCorners, "double" aPadOrient, "OUTLINE_MODE" aTraceMode, "void *" aData)
 
"void" FlashRegularPolygon (self, "wxPoint" aShapePos, "int" aDiameter, "int" aCornerCount, "double" aOrient, "OUTLINE_MODE" aTraceMode, "void *" aData)
 
"void" Text (self, "wxPoint" aPos, "COLOR4D" aColor, "wxString" aText, "double" aOrient, "wxSize" aSize, "enum EDA_TEXT_HJUSTIFY_T" aH_justify, "enum EDA_TEXT_VJUSTIFY_T" aV_justify, "int" aWidth, "bool" aItalic, "bool" aBold, "bool" aMultilineAllowed=False, "void *" aData=None)
 
"void" Marker (self, "wxPoint" position, "int" diametre, "unsigned int" aShapeId)
 
"void" SetLayerPolarity (self, "bool" aPositive)
 
"void" SetTextMode (self, "PLOT_TEXT_MODE" mode)
 
"void" SetGerberCoordinatesFormat (self, "int" aResolution, "bool" aUseInches=False)
 
"void" SetSvgCoordinatesFormat (self, "unsigned int" aResolution, "bool" aUseInches=False)
 
"void" StartBlock (self, "void *" aData)
 
"void" EndBlock (self, "void *" aData)
 

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 6520 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 6525 of file pcbnew.py.

Member Function Documentation

◆ AddLineToHeader()

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

Definition at line 6598 of file pcbnew.py.

◆ Arc()

"void" pcbnew.PLOTTER.Arc (   self,
args 
)
    Arc(PLOTTER self, wxPoint centre, double StAngle, double EndAngle, int rayon, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)
    Arc(PLOTTER self, SHAPE_ARC const & aArc)

Definition at line 6634 of file pcbnew.py.

Here is the caller graph for this function:

◆ BezierCurve()

"void" pcbnew.PLOTTER.BezierCurve (   self,
args 
)
BezierCurve(PLOTTER self, wxPoint aStart, wxPoint aControl1, wxPoint aControl2, wxPoint aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH)

Definition at line 6641 of file pcbnew.py.

◆ Circle()

"void" pcbnew.PLOTTER.Circle (   self,
args 
)
Circle(PLOTTER self, wxPoint pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)

Definition at line 6630 of file pcbnew.py.

◆ ClearHeaderLinesList()

"void" pcbnew.PLOTTER.ClearHeaderLinesList (   self)
ClearHeaderLinesList(PLOTTER self)

Definition at line 6602 of file pcbnew.py.

◆ EndBlock()

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

Definition at line 6754 of file pcbnew.py.

◆ EndPlot()

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

Definition at line 6542 of file pcbnew.py.

◆ FilledCircle()

"void" pcbnew.PLOTTER.FilledCircle (   self,
"wxPoint"  pos,
"int"  diametre,
"OUTLINE_MODE"  tracemode,
"void *"  aData 
)
FilledCircle(PLOTTER self, wxPoint pos, int diametre, OUTLINE_MODE tracemode, void * aData)

Definition at line 6692 of file pcbnew.py.

◆ FinishTo()

"void" pcbnew.PLOTTER.FinishTo (   self,
"wxPoint"  pos 
)
FinishTo(PLOTTER self, wxPoint pos)

Definition at line 6657 of file pcbnew.py.

◆ FlashPadCircle()

"void" pcbnew.PLOTTER.FlashPadCircle (   self,
"wxPoint"  aPadPos,
"int"  aDiameter,
"OUTLINE_MODE"  aTraceMode,
"void *"  aData 
)
FlashPadCircle(PLOTTER self, wxPoint aPadPos, int aDiameter, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 6696 of file pcbnew.py.

◆ FlashPadCustom()

"void" pcbnew.PLOTTER.FlashPadCustom (   self,
"wxPoint"  aPadPos,
"wxSize"  aSize,
"double"  aPadOrient,
"SHAPE_POLY_SET"  aPolygons,
"OUTLINE_MODE"  aTraceMode,
"void *"  aData 
)
FlashPadCustom(PLOTTER self, wxPoint aPadPos, wxSize aSize, double aPadOrient, SHAPE_POLY_SET aPolygons, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 6712 of file pcbnew.py.

◆ FlashPadOval()

"void" pcbnew.PLOTTER.FlashPadOval (   self,
"wxPoint"  aPadPos,
"wxSize"  aSize,
"double"  aPadOrient,
"OUTLINE_MODE"  aTraceMode,
"void *"  aData 
)
FlashPadOval(PLOTTER self, wxPoint aPadPos, wxSize aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 6700 of file pcbnew.py.

◆ FlashPadRect()

"void" pcbnew.PLOTTER.FlashPadRect (   self,
"wxPoint"  aPadPos,
"wxSize"  aSize,
"double"  aPadOrient,
"OUTLINE_MODE"  aTraceMode,
"void *"  aData 
)
FlashPadRect(PLOTTER self, wxPoint aPadPos, wxSize aSize, double aPadOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 6704 of file pcbnew.py.

◆ FlashPadRoundRect()

"void" pcbnew.PLOTTER.FlashPadRoundRect (   self,
"wxPoint"  aPadPos,
"wxSize"  aSize,
"int"  aCornerRadius,
"double"  aOrient,
"OUTLINE_MODE"  aTraceMode,
"void *"  aData 
)
FlashPadRoundRect(PLOTTER self, wxPoint aPadPos, wxSize aSize, int aCornerRadius, double aOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 6708 of file pcbnew.py.

◆ FlashPadTrapez()

"void" pcbnew.PLOTTER.FlashPadTrapez (   self,
"wxPoint"  aPadPos,
"wxPoint"  aCorners,
"double"  aPadOrient,
"OUTLINE_MODE"  aTraceMode,
"void *"  aData 
)
FlashPadTrapez(PLOTTER self, wxPoint aPadPos, wxPoint aCorners, double aPadOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 6716 of file pcbnew.py.

◆ FlashRegularPolygon()

"void" pcbnew.PLOTTER.FlashRegularPolygon (   self,
"wxPoint"  aShapePos,
"int"  aDiameter,
"int"  aCornerCount,
"double"  aOrient,
"OUTLINE_MODE"  aTraceMode,
"void *"  aData 
)
FlashRegularPolygon(PLOTTER self, wxPoint aShapePos, int aDiameter, int aCornerCount, double aOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 6720 of file pcbnew.py.

◆ GetColorMode()

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

Definition at line 6554 of file pcbnew.py.

◆ GetCurrentLineWidth()

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

Definition at line 6578 of file pcbnew.py.

◆ GetIUsPerDecimil()

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

Definition at line 6614 of file pcbnew.py.

◆ GetPlotterArcHighDef()

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

Definition at line 6622 of file pcbnew.py.

◆ GetPlotterArcLowDef()

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

Definition at line 6618 of file pcbnew.py.

◆ GetPlotterType()

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

Definition at line 6534 of file pcbnew.py.

◆ LineTo()

"void" pcbnew.PLOTTER.LineTo (   self,
"wxPoint"  pos 
)
LineTo(PLOTTER self, wxPoint pos)

Definition at line 6653 of file pcbnew.py.

◆ Marker()

"void" pcbnew.PLOTTER.Marker (   self,
"wxPoint"  position,
"int"  diametre,
"unsigned int"  aShapeId 
)
Marker(PLOTTER self, wxPoint position, int diametre, unsigned int aShapeId)

Definition at line 6730 of file pcbnew.py.

◆ MoveTo()

"void" pcbnew.PLOTTER.MoveTo (   self,
"wxPoint"  pos 
)
MoveTo(PLOTTER self, wxPoint pos)

Definition at line 6649 of file pcbnew.py.

◆ OpenFile()

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

Definition at line 6610 of file pcbnew.py.

◆ PageSettings()

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

Definition at line 6570 of file pcbnew.py.

◆ PenFinish()

"void" pcbnew.PLOTTER.PenFinish (   self)
PenFinish(PLOTTER self)

Definition at line 6661 of file pcbnew.py.

◆ PenTo()

"void" pcbnew.PLOTTER.PenTo (   self,
"wxPoint"  pos,
"char"  plume 
)
PenTo(PLOTTER self, wxPoint pos, char plume)

Definition at line 6645 of file pcbnew.py.

◆ PlotImage()

"void" pcbnew.PLOTTER.PlotImage (   self,
"wxImage const &"  aImage,
"wxPoint"  aPos,
"double"  aScaleFactor 
)
PlotImage(PLOTTER self, wxImage const & aImage, wxPoint aPos, double aScaleFactor)

Definition at line 6672 of file pcbnew.py.

◆ PlotPoly()

"void" pcbnew.PLOTTER.PlotPoly (   self,
args 
)
    PlotPoly(PLOTTER self, wxPoint_Vector aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void * aData=None)
    PlotPoly(PLOTTER self, SHAPE_LINE_CHAIN aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void * aData=None)

Definition at line 6665 of file pcbnew.py.

Here is the caller graph for this function:

◆ Rect()

"void" pcbnew.PLOTTER.Rect (   self,
args 
)
Rect(PLOTTER self, wxPoint p1, wxPoint p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)

Definition at line 6626 of file pcbnew.py.

◆ RenderSettings()

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

Definition at line 6562 of file pcbnew.py.

◆ SetColor()

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

Definition at line 6582 of file pcbnew.py.

◆ SetColorMode()

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

Definition at line 6550 of file pcbnew.py.

◆ SetCreator()

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

Definition at line 6590 of file pcbnew.py.

◆ SetCurrentLineWidth()

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

Definition at line 6574 of file pcbnew.py.

◆ SetDash()

"void" pcbnew.PLOTTER.SetDash (   self,
"PLOT_DASH_TYPE"  dashed 
)
SetDash(PLOTTER self, PLOT_DASH_TYPE dashed)

Definition at line 6586 of file pcbnew.py.

◆ SetGerberCoordinatesFormat()

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

Definition at line 6742 of file pcbnew.py.

◆ SetLayerPolarity()

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

Definition at line 6734 of file pcbnew.py.

◆ SetNegative()

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

Definition at line 6546 of file pcbnew.py.

◆ SetPageSettings()

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

Definition at line 6566 of file pcbnew.py.

◆ SetRenderSettings()

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

Definition at line 6558 of file pcbnew.py.

◆ SetSvgCoordinatesFormat()

"void" pcbnew.PLOTTER.SetSvgCoordinatesFormat (   self,
"unsigned int"  aResolution,
"bool"  aUseInches = False 
)
SetSvgCoordinatesFormat(PLOTTER self, unsigned int aResolution, bool aUseInches=False)

Definition at line 6746 of file pcbnew.py.

◆ SetTextMode()

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

Definition at line 6738 of file pcbnew.py.

◆ SetTitle()

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

Definition at line 6594 of file pcbnew.py.

◆ SetViewport()

"void" pcbnew.PLOTTER.SetViewport (   self,
"wxPoint"  aOffset,
"double"  aIusPerDecimil,
"double"  aScale,
"bool"  aMirror 
)
SetViewport(PLOTTER self, wxPoint aOffset, double aIusPerDecimil, double aScale, bool aMirror)

Definition at line 6606 of file pcbnew.py.

◆ StartBlock()

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

Definition at line 6750 of file pcbnew.py.

◆ StartPlot()

"bool" pcbnew.PLOTTER.StartPlot (   self)
StartPlot(PLOTTER self) -> bool

Definition at line 6538 of file pcbnew.py.

◆ Text()

"void" pcbnew.PLOTTER.Text (   self,
"wxPoint"  aPos,
"COLOR4D"  aColor,
"wxString"  aText,
"double"  aOrient,
"wxSize"  aSize,
"enum EDA_TEXT_HJUSTIFY_T"  aH_justify,
"enum EDA_TEXT_VJUSTIFY_T"  aV_justify,
"int"  aWidth,
"bool"  aItalic,
"bool"  aBold,
"bool"  aMultilineAllowed = False,
"void *"  aData = None 
)
Text(PLOTTER self, wxPoint aPos, COLOR4D aColor, wxString aText, double aOrient, wxSize aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, bool aMultilineAllowed=False, void * aData=None)

Definition at line 6724 of file pcbnew.py.

◆ ThickArc()

"void" pcbnew.PLOTTER.ThickArc (   self,
"wxPoint"  centre,
"double"  StAngle,
"double"  EndAngle,
"int"  rayon,
"int"  width,
"OUTLINE_MODE"  tracemode,
"void *"  aData 
)
ThickArc(PLOTTER self, wxPoint centre, double StAngle, double EndAngle, int rayon, int width, OUTLINE_MODE tracemode, void * aData)

Definition at line 6680 of file pcbnew.py.

◆ ThickCircle()

"void" pcbnew.PLOTTER.ThickCircle (   self,
"wxPoint"  pos,
"int"  diametre,
"int"  width,
"OUTLINE_MODE"  tracemode,
"void *"  aData 
)
ThickCircle(PLOTTER self, wxPoint pos, int diametre, int width, OUTLINE_MODE tracemode, void * aData)

Definition at line 6688 of file pcbnew.py.

◆ ThickRect()

"void" pcbnew.PLOTTER.ThickRect (   self,
"wxPoint"  p1,
"wxPoint"  p2,
"int"  width,
"OUTLINE_MODE"  tracemode,
"void *"  aData 
)
ThickRect(PLOTTER self, wxPoint p1, wxPoint p2, int width, OUTLINE_MODE tracemode, void * aData)

Definition at line 6684 of file pcbnew.py.

◆ ThickSegment()

"void" pcbnew.PLOTTER.ThickSegment (   self,
"wxPoint"  start,
"wxPoint"  end,
"int"  width,
"OUTLINE_MODE"  tracemode,
"void *"  aData 
)
ThickSegment(PLOTTER self, wxPoint start, wxPoint end, int width, OUTLINE_MODE tracemode, void * aData)

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

◆ MARKER_COUNT

pcbnew.PLOTTER.MARKER_COUNT = _pcbnew.PLOTTER_MARKER_COUNT
static

Definition at line 6727 of file pcbnew.py.

◆ USE_DEFAULT_LINE_WIDTH

pcbnew.PLOTTER.USE_DEFAULT_LINE_WIDTH = _pcbnew.PLOTTER_USE_DEFAULT_LINE_WIDTH
static

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


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