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

Public Member Functions

def __init__ (self, args, kwargs)
 
def GetPlotterType (self)
 
def StartPlot (self)
 
def EndPlot (self)
 
def SetNegative (self, _negative)
 
def SetColorMode (self, _color_mode)
 
def GetColorMode (self)
 
def SetPageSettings (self, aPageSettings)
 
def SetCurrentLineWidth (self, width, aData=None)
 
def SetDefaultLineWidth (self, width)
 
def GetCurrentLineWidth (self)
 
def SetColor (self, color)
 
def SetDash (self, dashed)
 
def SetCreator (self, aCreator)
 
def SetTitle (self, aTitle)
 
def AddLineToHeader (self, aExtraString)
 
def ClearHeaderLinesList (self)
 
def SetViewport (self, aOffset, aIusPerDecimil, aScale, aMirror)
 
def OpenFile (self, aFullFilename)
 
def GetIUsPerDecimil (self)
 
def Rect (self, args)
 
def Circle (self, args)
 
def Arc (self, args)
 
def PenTo (self, pos, plume)
 
def MoveTo (self, pos)
 
def LineTo (self, pos)
 
def FinishTo (self, pos)
 
def PenFinish (self)
 
def PlotPoly (self, args)
 
def PlotImage (self, aImage, aPos, aScaleFactor)
 
def ThickSegment (self, start, end, width, tracemode, aData)
 
def ThickArc (self, centre, StAngle, EndAngle, rayon, width, tracemode, aData)
 
def ThickRect (self, p1, p2, width, tracemode, aData)
 
def ThickCircle (self, pos, diametre, width, tracemode, aData)
 
def FlashPadCircle (self, aPadPos, aDiameter, aTraceMode, aData)
 
def FlashPadOval (self, aPadPos, aSize, aPadOrient, aTraceMode, aData)
 
def FlashPadRect (self, aPadPos, aSize, aPadOrient, aTraceMode, aData)
 
def FlashPadRoundRect (self, aPadPos, aSize, aCornerRadius, aOrient, aTraceMode, aData)
 
def FlashPadCustom (self, aPadPos, aSize, aPolygons, aTraceMode, aData)
 
def FlashPadTrapez (self, aPadPos, aCorners, aPadOrient, aTraceMode, aData)
 
def Text (self, aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aWidth, aItalic, aBold, aMultilineAllowed=False, aData=None)
 
def Marker (self, position, diametre, aShapeId)
 
def SetLayerPolarity (self, aPositive)
 
def SetTextMode (self, mode)
 
def SetGerberCoordinatesFormat (self, aResolution, aUseInches=False)
 
def StartBlock (self, aData)
 
def EndBlock (self, 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
 

Detailed Description

Proxy of C++ PLOTTER class.

Definition at line 6977 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 6985 of file pcbnew.py.

Member Function Documentation

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

Definition at line 7066 of file pcbnew.py.

def pcbnew.PLOTTER.Arc (   self,
  args 
)
Arc(PLOTTER self, wxPoint centre, double StAngle, double EndAngle, int rayon, FILL_T fill, int width)
Arc(PLOTTER self, wxPoint centre, double StAngle, double EndAngle, int rayon, FILL_T fill)

Definition at line 7107 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.PLOTTER.Circle (   self,
  args 
)
Circle(PLOTTER self, wxPoint pos, int diametre, FILL_T fill, int width)
Circle(PLOTTER self, wxPoint pos, int diametre, FILL_T fill)

Definition at line 7099 of file pcbnew.py.

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

Definition at line 7071 of file pcbnew.py.

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

Definition at line 7245 of file pcbnew.py.

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

Definition at line 7003 of file pcbnew.py.

def pcbnew.PLOTTER.FinishTo (   self,
  pos 
)
FinishTo(PLOTTER self, wxPoint pos)

Definition at line 7130 of file pcbnew.py.

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

Definition at line 7177 of file pcbnew.py.

def pcbnew.PLOTTER.FlashPadCustom (   self,
  aPadPos,
  aSize,
  aPolygons,
  aTraceMode,
  aData 
)
FlashPadCustom(PLOTTER self, wxPoint aPadPos, wxSize aSize, SHAPE_POLY_SET aPolygons, EDA_DRAW_MODE_T aTraceMode, void * aData)

Definition at line 7197 of file pcbnew.py.

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

Definition at line 7182 of file pcbnew.py.

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

Definition at line 7187 of file pcbnew.py.

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

Definition at line 7192 of file pcbnew.py.

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

Definition at line 7202 of file pcbnew.py.

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

Definition at line 7018 of file pcbnew.py.

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

Definition at line 7041 of file pcbnew.py.

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

Definition at line 7086 of file pcbnew.py.

def pcbnew.PLOTTER.GetPlotterType (   self)
GetPlotterType(PLOTTER self) -> PlotFormat

Definition at line 6993 of file pcbnew.py.

def pcbnew.PLOTTER.LineTo (   self,
  pos 
)
LineTo(PLOTTER self, wxPoint pos)

Definition at line 7125 of file pcbnew.py.

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

Definition at line 7217 of file pcbnew.py.

def pcbnew.PLOTTER.MoveTo (   self,
  pos 
)
MoveTo(PLOTTER self, wxPoint pos)

Definition at line 7120 of file pcbnew.py.

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

Definition at line 7081 of file pcbnew.py.

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

Definition at line 7135 of file pcbnew.py.

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

Definition at line 7115 of file pcbnew.py.

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

Definition at line 7152 of file pcbnew.py.

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

Definition at line 7140 of file pcbnew.py.

def pcbnew.PLOTTER.Rect (   self,
  args 
)
Rect(PLOTTER self, wxPoint p1, wxPoint p2, FILL_T fill, int width)
Rect(PLOTTER self, wxPoint p1, wxPoint p2, FILL_T fill)

Definition at line 7091 of file pcbnew.py.

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

Definition at line 7046 of file pcbnew.py.

def pcbnew.PLOTTER.SetColorMode (   self,
  _color_mode 
)
SetColorMode(PLOTTER self, bool _color_mode)

Definition at line 7013 of file pcbnew.py.

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

Definition at line 7056 of file pcbnew.py.

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

Definition at line 7028 of file pcbnew.py.

def pcbnew.PLOTTER.SetDash (   self,
  dashed 
)
SetDash(PLOTTER self, int dashed)

Definition at line 7051 of file pcbnew.py.

def pcbnew.PLOTTER.SetDefaultLineWidth (   self,
  width 
)
SetDefaultLineWidth(PLOTTER self, int width)

Definition at line 7036 of file pcbnew.py.

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

Definition at line 7232 of file pcbnew.py.

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

Definition at line 7222 of file pcbnew.py.

def pcbnew.PLOTTER.SetNegative (   self,
  _negative 
)
SetNegative(PLOTTER self, bool _negative)

Definition at line 7008 of file pcbnew.py.

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

Definition at line 7023 of file pcbnew.py.

def pcbnew.PLOTTER.SetTextMode (   self,
  mode 
)
SetTextMode(PLOTTER self, PlotTextMode mode)

Definition at line 7227 of file pcbnew.py.

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

Definition at line 7061 of file pcbnew.py.

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

Definition at line 7076 of file pcbnew.py.

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

Definition at line 7240 of file pcbnew.py.

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

Definition at line 6998 of file pcbnew.py.

def pcbnew.PLOTTER.Text (   self,
  aPos,
  aColor,
  aText,
  aOrient,
  aSize,
  aH_justify,
  aV_justify,
  aWidth,
  aItalic,
  aBold,
  aMultilineAllowed = False,
  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)
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)
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)

Definition at line 7207 of file pcbnew.py.

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

Definition at line 7162 of file pcbnew.py.

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

Definition at line 7172 of file pcbnew.py.

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

Definition at line 7167 of file pcbnew.py.

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

Definition at line 7157 of file pcbnew.py.

Member Data Documentation

pcbnew.PLOTTER.DO_NOT_SET_LINE_WIDTH = _pcbnew.PLOTTER_DO_NOT_SET_LINE_WIDTH
static

Definition at line 6988 of file pcbnew.py.

pcbnew.PLOTTER.MARKER_COUNT = _pcbnew.PLOTTER_MARKER_COUNT
static

Definition at line 7215 of file pcbnew.py.

pcbnew.PLOTTER.USE_DEFAULT_LINE_WIDTH = _pcbnew.PLOTTER_USE_DEFAULT_LINE_WIDTH
static

Definition at line 6989 of file pcbnew.py.


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