plugins.FootprintWizardBase.FootprintWizard Class Reference

A class to simplify many aspects of footprint creation, leaving only the footprint specific routines to the wizards themselves. More...

Inheritance diagram for plugins.FootprintWizardBase.FootprintWizard:

Public Member Functions
def	__init__ (self)
def	GetName (self)
	Return the name of the footprint wizard. More...
def	GetDescription (self)
	Return the footprint wizard description. More...
def	GetValue (self)
	Return the value (name) of the generated footprint. More...
def	GenerateParameterList (self)
	Footprint parameter specification is done here. More...
def	CheckParameters (self)
	Any custom parameter checking should be performed here. More...
def	BuildThisFootprint (self)
	Draw the footprint. More...
def	BuildFootprint (self)
	Actually make the footprint. More...
def	SetModule3DModel (self)
	If your plug-in sets a 3D model, override this function. More...
def	GetTextSize (self)
	Get the default text size for the footprint. More...
def	GetTextThickness (self)
	Thicker than IPC guidelines (10% of text height = 0.12mm) as 5 wires/mm is a common silk screen limitation. More...
Public Member Functions inherited from pcbnew.FootprintWizardPlugin
def	__init__ (self)
def	defaults (self)
def	AddParam (self, page, name, unit, default, **kwarg)
def	parameters (self)
def	values (self)
def	ResetWizard (self)
def	GetName (self)
def	GetImage (self)
def	GetDescription (self)
def	GetValue (self)
def	GetReferencePrefix (self)
def	GetParam (self, page, name)
def	CheckParam (self, page, name, **kwarg)
def	AnyErrors (self)
def	pages (self)
def	GetNumParameterPages (self)
def	GetParameterPageName (self, page_n)
def	GetParametersByPageName (self, page_name)
def	GetParametersByPageIndex (self, page_index)
def	GetParameterDesignators (self, page_index)
def	GetParameterNames (self, page_index)
def	GetParameterValues (self, page_index)
def	GetParameterErrors (self, page_index)
def	GetParameterTypes (self, page_index)
def	GetParameterHints (self, page_index)
def	GetParameterDesignators (self, page_index)
def	SetParameterValues (self, page_index, list_of_values)
def	GetFootprint (self)
def	BuildFootprint (self)
def	GetBuildMessages (self)
def	Show (self)
Public Member Functions inherited from pcbnew.KiCadPlugin
def	__init__ (self)
def	register (self)
def	deregister (self)
def	GetPluginPath (self)

Public Attributes
	buildmessages
	module
	draw
Public Attributes inherited from pcbnew.FootprintWizardPlugin
	module
	params
	name
	description
	image
	buildmessages

Static Public Attributes
	uMM = pcbnew.uMM
	uMils = pcbnew.uMils
	uFloat = pcbnew.uFloat
	uInteger = pcbnew.uInteger
	uBool = pcbnew.uBool
	uRadians = pcbnew.uRadians
	uDegrees = pcbnew.uDegrees
	uPercent = pcbnew.uPercent
	uString = pcbnew.uString

Detailed Description

A class to simplify many aspects of footprint creation, leaving only the footprint specific routines to the wizards themselves.

Inherit this class to make a new wizard.

Provides simplified access to helpers like drawing functions, a transform matrix stack and simple parameter checking.

Generally, you need to implement: GetValue() GenerateParameterList() CheckParameters() BuildThisFootprint() GetName() GetDescription()

Definition at line 27 of file FootprintWizardBase.py.

Constructor & Destructor Documentation

__init__()

def plugins.FootprintWizardBase.FootprintWizard.__init__

(

self

)

Reimplemented from pcbnew.FootprintWizardPlugin.

Definition at line 57 of file FootprintWizardBase.py.

Member Function Documentation

BuildFootprint()

def plugins.FootprintWizardBase.FootprintWizard.BuildFootprint

(

self

)

Actually make the footprint.

We defer all but the set-up to the implementing class

Reimplemented from pcbnew.FootprintWizardPlugin.

Definition at line 101 of file FootprintWizardBase.py.

Here is the caller graph for this function:

BuildThisFootprint()

def plugins.FootprintWizardBase.FootprintWizard.BuildThisFootprint

(

self

)

Draw the footprint.

This is specific to each footprint class, you need to implement this to draw what you want

Definition at line 91 of file FootprintWizardBase.py.

CheckParameters()

def plugins.FootprintWizardBase.FootprintWizard.CheckParameters

(

self

)

Any custom parameter checking should be performed here.

Definition at line 85 of file FootprintWizardBase.py.

GenerateParameterList()

def plugins.FootprintWizardBase.FootprintWizard.GenerateParameterList

(

self

)

Footprint parameter specification is done here.

Definition at line 79 of file FootprintWizardBase.py.

Here is the caller graph for this function:

GetDescription()

def plugins.FootprintWizardBase.FootprintWizard.GetDescription

(

self

)

Return the footprint wizard description.

Reimplemented from pcbnew.FootprintWizardPlugin.

Definition at line 67 of file FootprintWizardBase.py.

Here is the caller graph for this function:

GetName()

def plugins.FootprintWizardBase.FootprintWizard.GetName

(

self

)

Return the name of the footprint wizard.

Reimplemented from pcbnew.FootprintWizardPlugin.

Definition at line 61 of file FootprintWizardBase.py.

Here is the caller graph for this function:

GetTextSize()

def plugins.FootprintWizardBase.FootprintWizard.GetTextSize

(

self

)

Get the default text size for the footprint.

Override to change it.

Defaults to IPC nominal of 1.0mm

Definition at line 164 of file FootprintWizardBase.py.

GetTextThickness()

def plugins.FootprintWizardBase.FootprintWizard.GetTextThickness

(

self

)

Thicker than IPC guidelines (10% of text height = 0.12mm) as 5 wires/mm is a common silk screen limitation.

Definition at line 172 of file FootprintWizardBase.py.

GetValue()

def plugins.FootprintWizardBase.FootprintWizard.GetValue

(

self

)

Return the value (name) of the generated footprint.

Reimplemented from pcbnew.FootprintWizardPlugin.

Definition at line 73 of file FootprintWizardBase.py.

SetModule3DModel()

def plugins.FootprintWizardBase.FootprintWizard.SetModule3DModel

(

self

)

If your plug-in sets a 3D model, override this function.

Definition at line 158 of file FootprintWizardBase.py.

Member Data Documentation

buildmessages

plugins.FootprintWizardBase.FootprintWizard.buildmessages

Definition at line 107 of file FootprintWizardBase.py.

draw

plugins.FootprintWizardBase.FootprintWizard.draw

Definition at line 138 of file FootprintWizardBase.py.

module

plugins.FootprintWizardBase.FootprintWizard.module

Definition at line 108 of file FootprintWizardBase.py.

uBool

plugins.FootprintWizardBase.FootprintWizard.uBool = pcbnew.uBool

static

Definition at line 51 of file FootprintWizardBase.py.

uDegrees

plugins.FootprintWizardBase.FootprintWizard.uDegrees = pcbnew.uDegrees

static

Definition at line 53 of file FootprintWizardBase.py.

uFloat

plugins.FootprintWizardBase.FootprintWizard.uFloat = pcbnew.uFloat

static

Definition at line 49 of file FootprintWizardBase.py.

uInteger

plugins.FootprintWizardBase.FootprintWizard.uInteger = pcbnew.uInteger

static

Definition at line 50 of file FootprintWizardBase.py.

uMils

plugins.FootprintWizardBase.FootprintWizard.uMils = pcbnew.uMils

static

Definition at line 48 of file FootprintWizardBase.py.

uMM

plugins.FootprintWizardBase.FootprintWizard.uMM = pcbnew.uMM

static

Definition at line 47 of file FootprintWizardBase.py.

uPercent

plugins.FootprintWizardBase.FootprintWizard.uPercent = pcbnew.uPercent

static

Definition at line 54 of file FootprintWizardBase.py.

uRadians

plugins.FootprintWizardBase.FootprintWizard.uRadians = pcbnew.uRadians

static

Definition at line 52 of file FootprintWizardBase.py.

uString

plugins.FootprintWizardBase.FootprintWizard.uString = pcbnew.uString

static

Definition at line 55 of file FootprintWizardBase.py.

---

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

• /src/pcbnew/python/plugins/FootprintWizardBase.py