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

Public Member Functions

def __init__ (self, args, kwargs)
 
def SetTextMode (self, mode)
 
def SetDefaultLineWidth (self, width)
 
def SetScaleAdjust (self, scaleX, scaleY)
 
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 SetColor (self, color)
 
- 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)
 

Additional Inherited Members

- 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

The PSLIKE_PLOTTER class is an intermediate class to handle common
routines for engines working more or less with the postscript imaging
model.

C++ includes: plot_common.h 

Definition at line 11661 of file pcbnew.py.

Constructor & Destructor Documentation

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

Definition at line 11680 of file pcbnew.py.

Member Function Documentation

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

void
PSLIKE_PLOTTER::FlashPadCircle(const wxPoint &aPadPos, int aDiameter,
EDA_DRAW_MODE_T aTraceMode, void *aData) override

virtual function FlashPadCircle

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

aPadPos:  Position of the shape (center of the rectangle

aDiameter:  diameter of round pad

aTraceMode:  FILLED or SKETCH

aData:  an auxiliary info (mainly for gerber format attributes) 

Definition at line 11728 of file pcbnew.py.

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

void
PSLIKE_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 attributes) 

Definition at line 11835 of file pcbnew.py.

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

void
PSLIKE_PLOTTER::FlashPadOval(const wxPoint &aPadPos, const wxSize
&aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)
override

virtual function FlashPadOval

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

aPadPos:  Position of the shape (center of the rectangle

aSize:  = size of oblong shape

aPadOrient:  The rotation of the shape

aTraceMode:  FILLED or SKETCH

aData:  an auxiliary info (mainly for gerber format attributes) 

Definition at line 11752 of file pcbnew.py.

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

void
PSLIKE_PLOTTER::FlashPadRect(const wxPoint &aPadPos, const wxSize
&aSize, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void *aData)
override

virtual function FlashPadRect

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

aPadPos:  Position of the shape (center of the rectangle

aSize:  = size of rounded rect

aPadOrient:  The rotation of the shape

aTraceMode:  FILLED or SKETCH

aData:  an auxuliary info (mainly for gerber format attributes) 

Definition at line 11779 of file pcbnew.py.

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

void
PSLIKE_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

aCornerRadius:  Radius of the rounded corners

aOrient:  The rotation of the shape

aTraceMode:  FILLED or SKETCH

aData:  an auxiliary info (mainly for gerber format attributes) 

Definition at line 11806 of file pcbnew.py.

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

void
PSLIKE_PLOTTER::FlashPadTrapez(const wxPoint &aPadPos, const wxPoint
*aCorners, double aPadOrient, EDA_DRAW_MODE_T aTraceMode, 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

aTraceMode:  = FILLED or SKETCH

aData:  an auxiliary info (mainly for gerber format attributes) 

Definition at line 11862 of file pcbnew.py.

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

void
PSLIKE_PLOTTER::SetColor(COLOR4D color) override

The SetColor implementation is split with the subclasses: The PSLIKE
computes the rgb values, the subclass emits the operator to actually
do it. 

Definition at line 11890 of file pcbnew.py.

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

void
PSLIKE_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 11696 of file pcbnew.py.

def pcbnew.PSLIKE_PLOTTER.SetScaleAdjust (   self,
  scaleX,
  scaleY 
)
SetScaleAdjust(PSLIKE_PLOTTER self, double scaleX, double scaleY)

void
PSLIKE_PLOTTER::SetScaleAdjust(double scaleX, double scaleY)

Set the 'fine' scaling for the postscript engine. 

Definition at line 11716 of file pcbnew.py.

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

virtual void
PSLIKE_PLOTTER::SetTextMode(PlotTextMode mode) override

PS and PDF fully implement native text (for the Latin-1 subset) 

Definition at line 11684 of file pcbnew.py.


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