KiCAD pcbnew scripting
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.HPGL_PLOTTER Class Reference
Inheritance diagram for pcbnew.HPGL_PLOTTER:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self)
 
def GetPlotterType (self)
 
def GetDefaultFileExtension ()
 
def StartPlot (self)
 
def EndPlot (self)
 
def SetCurrentLineWidth
 
def SetDefaultLineWidth (self, width)
 
def SetDash (self, dashed)
 
def SetColor (self, color)
 
def SetPenSpeed (self, speed)
 
def SetPenNumber (self, number)
 
def SetPenDiameter (self, diameter)
 
def SetViewport (self, aOffset, aIusPerDecimil, aScale, aMirror)
 
def Rect (self, args)
 
def Circle (self, args)
 
def PlotPoly (self, args)
 
def ThickSegment (self, start, end, width, tracemode, aData)
 
def Arc (self, args)
 
def PenTo (self, pos, plume)
 
def FlashPadCircle (self, pos, diametre, trace_mode, aData)
 
def FlashPadOval (self, pos, size, orient, trace_mode, aData)
 
def FlashPadRect (self, pos, size, orient, trace_mode, aData)
 
def FlashPadRoundRect (self, aPadPos, aSize, aCornerRadius, aOrient, aTraceMode, aData)
 
def FlashPadCustom (self, aPadPos, aSize, aPolygons, aTraceMode, aData)
 
def FlashPadTrapez (self, aPadPos, aCorners, aPadOrient, aTrace_Mode, aData)
 
- Public Member Functions inherited from pcbnew.PLOTTER
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
 
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
 
def Marker (self, position, diametre, aShapeId)
 
def SetLayerPolarity (self, aPositive)
 
def SetTextMode (self, mode)
 
def SetGerberCoordinatesFormat
 
def StartBlock (self, aData)
 
def EndBlock (self, aData)
 

Public Attributes

 this
 

Static Public Attributes

tuple GetDefaultFileExtension = staticmethod(GetDefaultFileExtension)
 
- Static Public Attributes inherited from pcbnew.PLOTTER
 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

C++ includes: plot_common.h 

Definition at line 11019 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.HPGL_PLOTTER.__init__ (   self)
__init__(HPGL_PLOTTER self) -> HPGL_PLOTTER

HPGL_PLOTTER::HPGL_PLOTTER() 

Definition at line 11031 of file pcbnew.py.

Member Function Documentation

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

void
HPGL_PLOTTER::Arc(const wxPoint &centre, double StAngle, double
EndAngle, int rayon, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)
override

Generic fallback: arc rendered as a polyline. 

Definition at line 11256 of file pcbnew.py.

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

void
HPGL_PLOTTER::Circle(const wxPoint &pos, int diametre, FILL_T fill,
int width=USE_DEFAULT_LINE_WIDTH) override 

Definition at line 11217 of file pcbnew.py.

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

bool
HPGL_PLOTTER::EndPlot() override

HPGL end of plot: pen return and release. 

Definition at line 11079 of file pcbnew.py.

def pcbnew.HPGL_PLOTTER.FlashPadCircle (   self,
  pos,
  diametre,
  trace_mode,
  aData 
)
FlashPadCircle(HPGL_PLOTTER self, wxPoint pos, int diametre, EDA_DRAW_MODE_T trace_mode, void * aData)

void
HPGL_PLOTTER::FlashPadCircle(const wxPoint &pos, int diametre,
EDA_DRAW_MODE_T trace_mode, void *aData) override

virtual function FlashPadCircle

Parameters:
-----------

aPadPos:  Position of the shape (center of the rectangle

aSize:  = size of rounded rect

cornerRadius:  Radius of the rounded corners

aOrient:  The rotation of the shape

aTraceMode:  FILLED or SKETCH

aData:  an auxiliary info (mainly for gerber format) 

Definition at line 11292 of file pcbnew.py.

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

void
HPGL_PLOTTER::FlashPadCustom(const wxPoint &aPadPos, const wxSize
&aSize, SHAPE_POLY_SET *aPolygons, EDA_DRAW_MODE_T aTraceMode, void
*aData) override

virtual function FlashPadCustom

Parameters:
-----------

aPadPos:  Position of the shape (center of the rectangle

aSize:  = size of round reference pad

aPolygons:  the shape as polygon set

aTraceMode:  FILLED or SKETCH

aData:  an auxiliary info (mainly for gerber format) 

Definition at line 11405 of file pcbnew.py.

def pcbnew.HPGL_PLOTTER.FlashPadOval (   self,
  pos,
  size,
  orient,
  trace_mode,
  aData 
)
FlashPadOval(HPGL_PLOTTER self, wxPoint pos, wxSize size, double orient, EDA_DRAW_MODE_T trace_mode, void * aData)

void
HPGL_PLOTTER::FlashPadOval(const wxPoint &pos, const wxSize &size,
double orient, EDA_DRAW_MODE_T trace_mode, void *aData) override

virtual function FlashPadOval

Parameters:
-----------

aPadPos:  Position of the shape (center of the rectangle

aSize:  = size of rounded rect

cornerRadius:  Radius of the rounded corners

aOrient:  The rotation of the shape

aTraceMode:  FILLED or SKETCH

aData:  an auxiliary info (mainly for gerber format) 

Definition at line 11320 of file pcbnew.py.

def pcbnew.HPGL_PLOTTER.FlashPadRect (   self,
  pos,
  size,
  orient,
  trace_mode,
  aData 
)
FlashPadRect(HPGL_PLOTTER self, wxPoint pos, wxSize size, double orient, EDA_DRAW_MODE_T trace_mode, void * aData)

void
HPGL_PLOTTER::FlashPadRect(const wxPoint &pos, const wxSize &size,
double orient, EDA_DRAW_MODE_T trace_mode, void *aData) override

virtual function FlashPadRect

Parameters:
-----------

aPadPos:  Position of the shape (center of the rectangle

aSize:  = size of rounded rect

cornerRadius:  Radius of the rounded corners

aOrient:  The rotation of the shape

aTraceMode:  FILLED or SKETCH

aData:  an auxuliary info (mainly for gerber format) 

Definition at line 11348 of file pcbnew.py.

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

void
HPGL_PLOTTER::FlashPadRoundRect(const wxPoint &aPadPos, const wxSize
&aSize, int aCornerRadius, double aOrient, EDA_DRAW_MODE_T aTraceMode,
void *aData) override

virtual function FlashPadRoundRect

Parameters:
-----------

aPadPos:  Position of the shape (center of the rectangle

aSize:  = size of rounded rect

cornerRadius:  Radius of the rounded corners

aOrient:  The rotation of the shape

aTraceMode:  FILLED or SKETCH

aData:  an auxiliary info (mainly for gerber format) 

Definition at line 11376 of file pcbnew.py.

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

void
HPGL_PLOTTER::FlashPadTrapez(const wxPoint &aPadPos, const wxPoint
*aCorners, double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode, void
*aData) override

virtual function FlashPadTrapez flash a trapezoidal pad

Parameters:
-----------

aPadPos:  = the position of the shape

aCorners:  = the list of 4 corners positions, relative to the shape
position, pad orientation 0

aPadOrient:  = the rotation of the shape

aTrace_Mode:  = FILLED or SKETCH 

Definition at line 11432 of file pcbnew.py.

def pcbnew.HPGL_PLOTTER.GetDefaultFileExtension ( )
GetDefaultFileExtension() -> wxString

Definition at line 11059 of file pcbnew.py.

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

virtual
PlotFormat HPGL_PLOTTER::GetPlotterType() const override

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 

Definition at line 11043 of file pcbnew.py.

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

void
HPGL_PLOTTER::PenTo(const wxPoint &pos, char plume) override

moveto/lineto primitive, moves the 'pen' to the specified direction

Parameters:
-----------

pos:  is the target position

plume:  specifies 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) 

Definition at line 11271 of file pcbnew.py.

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

void
HPGL_PLOTTER::PlotPoly(const std::vector< wxPoint > &aCornerList,
FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)
override

HPGL polygon: 

Definition at line 11229 of file pcbnew.py.

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

void
HPGL_PLOTTER::Rect(const wxPoint &p1, const wxPoint &p2, FILL_T fill,
int width=USE_DEFAULT_LINE_WIDTH) override

HPGL rectangle: fill not supported. 

Definition at line 11203 of file pcbnew.py.

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

virtual void
HPGL_PLOTTER::SetColor(COLOR4D color) override 

Definition at line 11137 of file pcbnew.py.

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

virtual
void HPGL_PLOTTER::SetCurrentLineWidth(int width, void *aData=NULL)
override

HPGL doesn't handle line thickness or color. 

Definition at line 11091 of file pcbnew.py.

def pcbnew.HPGL_PLOTTER.SetDash (   self,
  dashed 
)
SetDash(HPGL_PLOTTER self, bool dashed)

void
HPGL_PLOTTER::SetDash(bool dashed) override

HPGL supports dashed lines. 

Definition at line 11125 of file pcbnew.py.

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

virtual
void HPGL_PLOTTER::SetDefaultLineWidth(int width) override

Set the default line width.

Used at the beginning and when a width of -1 (USE_DEFAULT_LINE_WIDTH)
is requested.

Parameters:
-----------

width:  is specified in IUs 

Definition at line 11105 of file pcbnew.py.

def pcbnew.HPGL_PLOTTER.SetPenDiameter (   self,
  diameter 
)
SetPenDiameter(HPGL_PLOTTER self, double diameter)

void
HPGL_PLOTTER::SetPenDiameter(double diameter) 

Definition at line 11167 of file pcbnew.py.

def pcbnew.HPGL_PLOTTER.SetPenNumber (   self,
  number 
)
SetPenNumber(HPGL_PLOTTER self, int number)

virtual void
HPGL_PLOTTER::SetPenNumber(int number) 

Definition at line 11157 of file pcbnew.py.

def pcbnew.HPGL_PLOTTER.SetPenSpeed (   self,
  speed 
)
SetPenSpeed(HPGL_PLOTTER self, int speed)

virtual void
HPGL_PLOTTER::SetPenSpeed(int speed) 

Definition at line 11147 of file pcbnew.py.

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

void
HPGL_PLOTTER::SetViewport(const wxPoint &aOffset, double
aIusPerDecimil, double aScale, bool aMirror) override

Set the plot offset and scaling for the current plot.

Parameters:
-----------

aOffset:  is the plot offset

aIusPerDecimil:  gives the scaling factor from IUs to device units

aScale:  is the user set plot scaling factor (either explicitly or
using 'fit to A4')

aMirror:  flips the plot in the Y direction (useful for toner
transfers or some kind of film) 

Definition at line 11177 of file pcbnew.py.

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

bool
HPGL_PLOTTER::StartPlot() override

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

Definition at line 11067 of file pcbnew.py.

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

void
HPGL_PLOTTER::ThickSegment(const wxPoint &start, const wxPoint &end,
int width, EDA_DRAW_MODE_T tracemode, void *aData) override 

Definition at line 11245 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.HPGL_PLOTTER.GetDefaultFileExtension = staticmethod(GetDefaultFileExtension)
static

Definition at line 11064 of file pcbnew.py.

pcbnew.HPGL_PLOTTER.this

Definition at line 11041 of file pcbnew.py.


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