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

Public Member Functions

def __init__ (self, aBoard)
 
def GetPlotOptions (self)
 
def SetLayer (self, aLayer)
 
def GetLayer (self)
 
def IsPlotOpen (self)
 
def ClosePlot (self)
 
def OpenPlotfile (self, aSuffix, aFormat, aSheetDesc)
 
def PlotLayer (self)
 
def GetPlotFileName (self)
 
def GetPlotDirName (self)
 
def SetColorMode (self, arg2)
 
def GetColorMode (self)
 

Public Attributes

 this
 

Detailed Description

Batch plotter state object.

Keeps the plot options and handles multiple plot requests Especially
useful in Python scripts

C++ includes: plotcontroller.h 

Definition at line 9194 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.PLOT_CONTROLLER.__init__ (   self,
  aBoard 
)
__init__(PLOT_CONTROLLER self, BOARD aBoard) -> PLOT_CONTROLLER

PLOT_CONTROLLER::PLOT_CONTROLLER(BOARD *aBoard)

Batch plotter constructor, nothing interesting here. 

Definition at line 9211 of file pcbnew.py.

Member Function Documentation

def pcbnew.PLOT_CONTROLLER.ClosePlot (   self)
ClosePlot(PLOT_CONTROLLER self)

void
PLOT_CONTROLLER::ClosePlot()

Close the current plot, nothing happens if it isn't open. 

Definition at line 9270 of file pcbnew.py.

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

bool
PLOT_CONTROLLER::GetColorMode()

true if the current plot color mode is Color, false if the current
plot color mode is Black and White 

Definition at line 9360 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.GetLayer (   self)
GetLayer(PLOT_CONTROLLER self) -> LAYER_NUM

LAYER_NUM
PLOT_CONTROLLER::GetLayer() 

Definition at line 9248 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.GetPlotDirName (   self)
GetPlotDirName(PLOT_CONTROLLER self) -> wxString

const
wxString PLOT_CONTROLLER::GetPlotDirName()

the current plot full filename, set by OpenPlotfile 

Definition at line 9330 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.GetPlotFileName (   self)
GetPlotFileName(PLOT_CONTROLLER self) -> wxString

const
wxString PLOT_CONTROLLER::GetPlotFileName()

the current plot full filename, set by OpenPlotfile 

Definition at line 9318 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.GetPlotOptions (   self)
GetPlotOptions(PLOT_CONTROLLER self) -> PCB_PLOT_PARAMS

PCB_PLOT_PARAMS& PLOT_CONTROLLER::GetPlotOptions()

Accessor to the plot parameters and options. 

Definition at line 9227 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.IsPlotOpen (   self)
IsPlotOpen(PLOT_CONTROLLER self) -> bool

bool
PLOT_CONTROLLER::IsPlotOpen() const

true if a plotter is initialized and can be used 

Definition at line 9258 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.OpenPlotfile (   self,
  aSuffix,
  aFormat,
  aSheetDesc 
)
OpenPlotfile(PLOT_CONTROLLER self, wxString aSuffix, PlotFormat aFormat, wxString aSheetDesc) -> bool

bool
PLOT_CONTROLLER::OpenPlotfile(const wxString &aSuffix, PlotFormat
aFormat, const wxString &aSheetDesc)

Open a new plotfile; works as a factory for plotter objects.

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

aSuffix:  is a string added to the base filename (derived from the
board filename) to identify the plot file

aFormat:  is the plot file format identifier

aSheetDesc:  

Definition at line 9282 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.PlotLayer (   self)
PlotLayer(PLOT_CONTROLLER self) -> bool

bool
PLOT_CONTROLLER::PlotLayer()

Plot a single layer on the current plotfile m_plotLayer is the layer
to plot. 

Definition at line 9305 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.SetColorMode (   self,
  arg2 
)
SetColorMode(PLOT_CONTROLLER self, bool arg2)

void
PLOT_CONTROLLER::SetColorMode(bool)

Plotters can plot in Black and White mode or Color mode SetColorMode
activate/de-actiavte the Color mode.

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

aColorMode:  = true to activate the plot color mode 

Definition at line 9342 of file pcbnew.py.

def pcbnew.PLOT_CONTROLLER.SetLayer (   self,
  aLayer 
)
SetLayer(PLOT_CONTROLLER self, LAYER_NUM aLayer)

void
PLOT_CONTROLLER::SetLayer(LAYER_NUM aLayer) 

Definition at line 9238 of file pcbnew.py.

Member Data Documentation

pcbnew.PLOT_CONTROLLER.this

Definition at line 9223 of file pcbnew.py.


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