pcbnew.PLOTTER Class Reference

Inheritance diagram for pcbnew.PLOTTER:

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	GetPlotterType (self)
def	StartPlot (self, aPageNumber)
def	EndPlot (self)
def	SetNegative (self, aNegative)
def	SetColorMode (self, aColorMode)
def	GetColorMode (self)
def	SetRenderSettings (self, aSettings)
def	RenderSettings (self)
def	SetPageSettings (self, aPageSettings)
def	PageSettings (self)
def	SetCurrentLineWidth (self, width, aData=None)
def	GetCurrentLineWidth (self)
def	SetColor (self, color)
def	SetDash (self, aLineWidth, aLineStyle)
def	SetCreator (self, aCreator)
def	SetTitle (self, aTitle)
def	SetAuthor (self, aAuthor)
def	SetSubject (self, aSubject)
def	AddLineToHeader (self, aExtraString)
def	ClearHeaderLinesList (self)
def	SetViewport (self, aOffset, aIusPerDecimil, aScale, aMirror)
def	OpenFile (self, aFullFilename)
def	GetIUsPerDecimil (self)
def	GetPlotterArcLowDef (self)
def	GetPlotterArcHighDef (self)
def	Rect (self, *args)
def	Circle (self, *args)
def	Arc (self, *args)
def	BezierCurve (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, *args)
def	ThickRect (self, p1, p2, width, tracemode, aData)
def	ThickCircle (self, pos, diametre, width, tracemode, aData)
def	FilledCircle (self, pos, diametre, 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, aPadOrient, aPolygons, aTraceMode, aData)
def	FlashPadTrapez (self, aPadPos, aCorners, aPadOrient, aTraceMode, aData)
def	FlashRegularPolygon (self, aShapePos, aDiameter, aCornerCount, aOrient, aTraceMode, aData)
def	Text (self, aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aPenWidth, aItalic, aBold, aMultilineAllowed, aFont, aFontMetrics, aData=None)
def	PlotText (self, aPos, aColor, aText, aAttributes, aFont, aFontMetrics, aData=None)
def	HyperlinkBox (self, aBox, aDestinationURL)
def	HyperlinkMenu (self, aBox, aDestURLs)
def	Bookmark (self, *args)
def	Marker (self, position, diametre, aShapeId)
def	SetLayerPolarity (self, aPositive)
def	SetTextMode (self, mode)
def	SetGerberCoordinatesFormat (self, aResolution, aUseInches=False)
def	SetSvgCoordinatesFormat (self, aPrecision)
def	StartBlock (self, aData)
def	EndBlock (self, aData)
def	GetPlotOffsetUserUnits (self)

Static Public Attributes
_pcbnew	DO_NOT_SET_LINE_WIDTH = _pcbnew.PLOTTER_DO_NOT_SET_LINE_WIDTH
_pcbnew	USE_DEFAULT_LINE_WIDTH = _pcbnew.PLOTTER_USE_DEFAULT_LINE_WIDTH
_pcbnew	MARKER_COUNT = _pcbnew.PLOTTER_MARKER_COUNT

Properties
property	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 8732 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 8737 of file pcbnew.py.

Member Function Documentation

AddLineToHeader()

def pcbnew.PLOTTER.AddLineToHeader	(		self,
			aExtraString
	)

AddLineToHeader(PLOTTER self, wxString aExtraString)

Definition at line 8818 of file pcbnew.py.

Arc()

def pcbnew.PLOTTER.Arc	(		self,
		*	args
	)

    Arc(PLOTTER self, VECTOR2D const & aStart, VECTOR2D const & aMid, VECTOR2D const & aEnd, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)
    Arc(PLOTTER self, VECTOR2D const & aCenter, EDA_ANGLE aStartAngle, EDA_ANGLE aAngle, double aRadius, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH)

Definition at line 8854 of file pcbnew.py.

Here is the caller graph for this function:

BezierCurve()

def pcbnew.PLOTTER.BezierCurve	(		self,
		*	args
	)

BezierCurve(PLOTTER self, VECTOR2I aStart, VECTOR2I aControl1, VECTOR2I aControl2, VECTOR2I aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH)

Definition at line 8861 of file pcbnew.py.

Bookmark()

def pcbnew.PLOTTER.Bookmark	(		self,
		*	args
	)

Bookmark(PLOTTER self, BOX2I aBox, wxString aName, wxString aGroupName=wxEmptyString)

Definition at line 8963 of file pcbnew.py.

Circle()

def pcbnew.PLOTTER.Circle	(		self,
		*	args
	)

Circle(PLOTTER self, VECTOR2I pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)

Definition at line 8850 of file pcbnew.py.

ClearHeaderLinesList()

def pcbnew.PLOTTER.ClearHeaderLinesList

(

self

)

ClearHeaderLinesList(PLOTTER self)

Definition at line 8822 of file pcbnew.py.

EndBlock()

def pcbnew.PLOTTER.EndBlock	(		self,
			aData
	)

EndBlock(PLOTTER self, void * aData)

Definition at line 8993 of file pcbnew.py.

EndPlot()

def pcbnew.PLOTTER.EndPlot

(

self

)

EndPlot(PLOTTER self) -> bool

Definition at line 8754 of file pcbnew.py.

FilledCircle()

def pcbnew.PLOTTER.FilledCircle	(		self,
			pos,
			diametre,
			tracemode,
			aData
	)

FilledCircle(PLOTTER self, VECTOR2I pos, int diametre, OUTLINE_MODE tracemode, void * aData)

Definition at line 8915 of file pcbnew.py.

FinishTo()

def pcbnew.PLOTTER.FinishTo	(		self,
			pos
	)

FinishTo(PLOTTER self, VECTOR2I pos)

Definition at line 8877 of file pcbnew.py.

FlashPadCircle()

def pcbnew.PLOTTER.FlashPadCircle	(		self,
			aPadPos,
			aDiameter,
			aTraceMode,
			aData
	)

FlashPadCircle(PLOTTER self, VECTOR2I aPadPos, int aDiameter, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 8919 of file pcbnew.py.

FlashPadCustom()

def pcbnew.PLOTTER.FlashPadCustom	(		self,
			aPadPos,
			aSize,
			aPadOrient,
			aPolygons,
			aTraceMode,
			aData
	)

FlashPadCustom(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aSize, EDA_ANGLE aPadOrient, SHAPE_POLY_SET aPolygons, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 8935 of file pcbnew.py.

FlashPadOval()

def pcbnew.PLOTTER.FlashPadOval	(		self,
			aPadPos,
			aSize,
			aPadOrient,
			aTraceMode,
			aData
	)

FlashPadOval(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aSize, EDA_ANGLE aPadOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 8923 of file pcbnew.py.

FlashPadRect()

def pcbnew.PLOTTER.FlashPadRect	(		self,
			aPadPos,
			aSize,
			aPadOrient,
			aTraceMode,
			aData
	)

FlashPadRect(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aSize, EDA_ANGLE aPadOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 8927 of file pcbnew.py.

FlashPadRoundRect()

def pcbnew.PLOTTER.FlashPadRoundRect	(		self,
			aPadPos,
			aSize,
			aCornerRadius,
			aOrient,
			aTraceMode,
			aData
	)

FlashPadRoundRect(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aSize, int aCornerRadius, EDA_ANGLE aOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 8931 of file pcbnew.py.

FlashPadTrapez()

def pcbnew.PLOTTER.FlashPadTrapez	(		self,
			aPadPos,
			aCorners,
			aPadOrient,
			aTraceMode,
			aData
	)

FlashPadTrapez(PLOTTER self, VECTOR2I aPadPos, VECTOR2I aCorners, EDA_ANGLE aPadOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 8939 of file pcbnew.py.

FlashRegularPolygon()

def pcbnew.PLOTTER.FlashRegularPolygon	(		self,
			aShapePos,
			aDiameter,
			aCornerCount,
			aOrient,
			aTraceMode,
			aData
	)

FlashRegularPolygon(PLOTTER self, VECTOR2I aShapePos, int aDiameter, int aCornerCount, EDA_ANGLE aOrient, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 8943 of file pcbnew.py.

GetColorMode()

def pcbnew.PLOTTER.GetColorMode

(

self

)

GetColorMode(PLOTTER self) -> bool

Definition at line 8766 of file pcbnew.py.

GetCurrentLineWidth()

def pcbnew.PLOTTER.GetCurrentLineWidth

(

self

)

GetCurrentLineWidth(PLOTTER self) -> int

Definition at line 8790 of file pcbnew.py.

GetIUsPerDecimil()

def pcbnew.PLOTTER.GetIUsPerDecimil

(

self

)

GetIUsPerDecimil(PLOTTER self) -> double

Definition at line 8834 of file pcbnew.py.

GetPlotOffsetUserUnits()

def pcbnew.PLOTTER.GetPlotOffsetUserUnits

(

self

)

GetPlotOffsetUserUnits(PLOTTER self) -> VECTOR2I

Definition at line 8997 of file pcbnew.py.

GetPlotterArcHighDef()

def pcbnew.PLOTTER.GetPlotterArcHighDef

(

self

)

GetPlotterArcHighDef(PLOTTER self) -> int

Definition at line 8842 of file pcbnew.py.

GetPlotterArcLowDef()

def pcbnew.PLOTTER.GetPlotterArcLowDef

(

self

)

GetPlotterArcLowDef(PLOTTER self) -> int

Definition at line 8838 of file pcbnew.py.

GetPlotterType()

def pcbnew.PLOTTER.GetPlotterType

(

self

)

GetPlotterType(PLOTTER self) -> PLOT_FORMAT

Definition at line 8746 of file pcbnew.py.

HyperlinkBox()

def pcbnew.PLOTTER.HyperlinkBox	(		self,
			aBox,
			aDestinationURL
	)

HyperlinkBox(PLOTTER self, BOX2I aBox, wxString aDestinationURL)

Definition at line 8955 of file pcbnew.py.

HyperlinkMenu()

def pcbnew.PLOTTER.HyperlinkMenu	(		self,
			aBox,
			aDestURLs
	)

HyperlinkMenu(PLOTTER self, BOX2I aBox, std::vector< wxString,std::allocator< wxString > > const & aDestURLs)

Definition at line 8959 of file pcbnew.py.

LineTo()

def pcbnew.PLOTTER.LineTo	(		self,
			pos
	)

LineTo(PLOTTER self, VECTOR2I pos)

Definition at line 8873 of file pcbnew.py.

Marker()

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

Marker(PLOTTER self, VECTOR2I position, int diametre, unsigned int aShapeId)

Definition at line 8969 of file pcbnew.py.

MoveTo()

def pcbnew.PLOTTER.MoveTo	(		self,
			pos
	)

MoveTo(PLOTTER self, VECTOR2I pos)

Definition at line 8869 of file pcbnew.py.

OpenFile()

def pcbnew.PLOTTER.OpenFile	(		self,
			aFullFilename
	)

OpenFile(PLOTTER self, wxString aFullFilename) -> bool

Definition at line 8830 of file pcbnew.py.

PageSettings()

def pcbnew.PLOTTER.PageSettings

(

self

)

PageSettings(PLOTTER self) -> PAGE_INFO &

Definition at line 8782 of file pcbnew.py.

PenFinish()

def pcbnew.PLOTTER.PenFinish

(

self

)

PenFinish(PLOTTER self)

Definition at line 8881 of file pcbnew.py.

PenTo()

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

PenTo(PLOTTER self, VECTOR2I pos, char plume)

Definition at line 8865 of file pcbnew.py.

PlotImage()

def pcbnew.PLOTTER.PlotImage	(		self,
			aImage,
			aPos,
			aScaleFactor
	)

PlotImage(PLOTTER self, wxImage const & aImage, VECTOR2I aPos, double aScaleFactor)

Definition at line 8892 of file pcbnew.py.

PlotPoly()

def pcbnew.PLOTTER.PlotPoly	(		self,
		*	args
	)

    PlotPoly(PLOTTER self, VECTOR_VECTOR2I 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 8885 of file pcbnew.py.

Here is the caller graph for this function:

PlotText()

def pcbnew.PLOTTER.PlotText	(		self,
			aPos,
			aColor,
			aText,
			aAttributes,
			aFont,
			aFontMetrics,
			aData = None
	)

PlotText(PLOTTER self, VECTOR2I aPos, COLOR4D aColor, wxString aText, TEXT_ATTRIBUTES aAttributes, KIFONT::FONT * aFont, KIFONT::METRICS const & aFontMetrics, void * aData=None)

Definition at line 8951 of file pcbnew.py.

Rect()

def pcbnew.PLOTTER.Rect	(		self,
		*	args
	)

Rect(PLOTTER self, VECTOR2I p1, VECTOR2I p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH)

Definition at line 8846 of file pcbnew.py.

RenderSettings()

def pcbnew.PLOTTER.RenderSettings

(

self

)

RenderSettings(PLOTTER self) -> RENDER_SETTINGS *

Definition at line 8774 of file pcbnew.py.

SetAuthor()

def pcbnew.PLOTTER.SetAuthor	(		self,
			aAuthor
	)

SetAuthor(PLOTTER self, wxString aAuthor)

Definition at line 8810 of file pcbnew.py.

SetColor()

def pcbnew.PLOTTER.SetColor	(		self,
			color
	)

SetColor(PLOTTER self, COLOR4D color)

Definition at line 8794 of file pcbnew.py.

SetColorMode()

def pcbnew.PLOTTER.SetColorMode	(		self,
			aColorMode
	)

SetColorMode(PLOTTER self, bool aColorMode)

Definition at line 8762 of file pcbnew.py.

SetCreator()

def pcbnew.PLOTTER.SetCreator	(		self,
			aCreator
	)

SetCreator(PLOTTER self, wxString aCreator)

Definition at line 8802 of file pcbnew.py.

SetCurrentLineWidth()

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

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

Definition at line 8786 of file pcbnew.py.

SetDash()

def pcbnew.PLOTTER.SetDash	(		self,
			aLineWidth,
			aLineStyle
	)

SetDash(PLOTTER self, int aLineWidth, LINE_STYLE aLineStyle)

Definition at line 8798 of file pcbnew.py.

SetGerberCoordinatesFormat()

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

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

Definition at line 8981 of file pcbnew.py.

SetLayerPolarity()

def pcbnew.PLOTTER.SetLayerPolarity	(		self,
			aPositive
	)

SetLayerPolarity(PLOTTER self, bool aPositive)

Definition at line 8973 of file pcbnew.py.

SetNegative()

def pcbnew.PLOTTER.SetNegative	(		self,
			aNegative
	)

SetNegative(PLOTTER self, bool aNegative)

Definition at line 8758 of file pcbnew.py.

SetPageSettings()

def pcbnew.PLOTTER.SetPageSettings	(		self,
			aPageSettings
	)

SetPageSettings(PLOTTER self, PAGE_INFO const & aPageSettings)

Definition at line 8778 of file pcbnew.py.

SetRenderSettings()

def pcbnew.PLOTTER.SetRenderSettings	(		self,
			aSettings
	)

SetRenderSettings(PLOTTER self, RENDER_SETTINGS * aSettings)

Definition at line 8770 of file pcbnew.py.

SetSubject()

def pcbnew.PLOTTER.SetSubject	(		self,
			aSubject
	)

SetSubject(PLOTTER self, wxString aSubject)

Definition at line 8814 of file pcbnew.py.

SetSvgCoordinatesFormat()

def pcbnew.PLOTTER.SetSvgCoordinatesFormat	(		self,
			aPrecision
	)

SetSvgCoordinatesFormat(PLOTTER self, unsigned int aPrecision)

Definition at line 8985 of file pcbnew.py.

SetTextMode()

def pcbnew.PLOTTER.SetTextMode	(		self,
			mode
	)

SetTextMode(PLOTTER self, PLOT_TEXT_MODE mode)

Definition at line 8977 of file pcbnew.py.

SetTitle()

def pcbnew.PLOTTER.SetTitle	(		self,
			aTitle
	)

SetTitle(PLOTTER self, wxString aTitle)

Definition at line 8806 of file pcbnew.py.

SetViewport()

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

SetViewport(PLOTTER self, VECTOR2I aOffset, double aIusPerDecimil, double aScale, bool aMirror)

Definition at line 8826 of file pcbnew.py.

StartBlock()

def pcbnew.PLOTTER.StartBlock	(		self,
			aData
	)

StartBlock(PLOTTER self, void * aData)

Definition at line 8989 of file pcbnew.py.

StartPlot()

def pcbnew.PLOTTER.StartPlot	(		self,
			aPageNumber
	)

StartPlot(PLOTTER self, wxString aPageNumber) -> bool

Definition at line 8750 of file pcbnew.py.

Text()

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

ThickArc()

def pcbnew.PLOTTER.ThickArc	(		self,
		*	args
	)

    ThickArc(PLOTTER self, EDA_SHAPE aArcShape, OUTLINE_MODE aTraceMode, void * aData)
    ThickArc(PLOTTER self, VECTOR2D const & aCentre, EDA_ANGLE aStAngle, EDA_ANGLE aAngle, double aRadius, int aWidth, OUTLINE_MODE aTraceMode, void * aData)

Definition at line 8900 of file pcbnew.py.

Here is the caller graph for this function:

ThickCircle()

def pcbnew.PLOTTER.ThickCircle	(		self,
			pos,
			diametre,
			width,
			tracemode,
			aData
	)

ThickCircle(PLOTTER self, VECTOR2I pos, int diametre, int width, OUTLINE_MODE tracemode, void * aData)

Definition at line 8911 of file pcbnew.py.

ThickRect()

def pcbnew.PLOTTER.ThickRect	(		self,
			p1,
			p2,
			width,
			tracemode,
			aData
	)

ThickRect(PLOTTER self, VECTOR2I p1, VECTOR2I p2, int width, OUTLINE_MODE tracemode, void * aData)

Definition at line 8907 of file pcbnew.py.

ThickSegment()

def pcbnew.PLOTTER.ThickSegment	(		self,
			start,
			end,
			width,
			tracemode,
			aData
	)

ThickSegment(PLOTTER self, VECTOR2I start, VECTOR2I end, int width, OUTLINE_MODE tracemode, void * aData)

Definition at line 8896 of file pcbnew.py.

Member Data Documentation

DO_NOT_SET_LINE_WIDTH

_pcbnew pcbnew.PLOTTER.DO_NOT_SET_LINE_WIDTH = _pcbnew.PLOTTER_DO_NOT_SET_LINE_WIDTH

static

Definition at line 8740 of file pcbnew.py.

MARKER_COUNT

_pcbnew pcbnew.PLOTTER.MARKER_COUNT = _pcbnew.PLOTTER_MARKER_COUNT

static

Definition at line 8966 of file pcbnew.py.

USE_DEFAULT_LINE_WIDTH

_pcbnew pcbnew.PLOTTER.USE_DEFAULT_LINE_WIDTH = _pcbnew.PLOTTER_USE_DEFAULT_LINE_WIDTH

static

Definition at line 8742 of file pcbnew.py.

Property Documentation

thisown

property pcbnew.PLOTTER.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

Definition at line 8735 of file pcbnew.py.

---

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

• pcbnew.py