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:

[legend]

Public Member Functions
	__init__ (self)

	GetName (self)
	Return the name of the footprint wizard.

	GetDescription (self)
	Return the footprint wizard description.

	GetValue (self)
	Return the value (name) of the generated footprint.

	GenerateParameterList (self)
	Footprint parameter specification is done here.

	CheckParameters (self)
	Any custom parameter checking should be performed here.

	BuildThisFootprint (self)
	Draw the footprint.

	BuildFootprint (self)
	Actually make the footprint.

	SetModule3DModel (self)
	If your plug-in sets a 3D model, override this function.

	GetTextSize (self)
	Get the default text size for the footprint.

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

Public Member Functions inherited from pcbnew.FootprintWizardPlugin
	__init__ (self)

	defaults (self)

	AddParam (self, page, name, unit, default, **kwarg)

	parameters (self)

	values (self)

	ResetWizard (self)

	GetImage (self)

	GetReferencePrefix (self)

	GetParam (self, page, name)

	CheckParam (self, page, name, **kwarg)

	AnyErrors (self)

	pages (self)

	GetNumParameterPages (self)

	GetParameterPageName (self, page_n)

	GetParametersByPageName (self, page_name)

	GetParametersByPageIndex (self, page_index)

	GetParameterDesignators (self, page_index)

	GetParameterNames (self, page_index)

	GetParameterValues (self, page_index)

	GetParameterErrors (self, page_index)

	GetParameterTypes (self, page_index)

	GetParameterHints (self, page_index)

	GetParameterDesignators (self, page_index)

	SetParameterValues (self, page_index, list_of_values)

	GetFootprint (self)

	GetBuildMessages (self)

	Show (self)

Public Member Functions inherited from pcbnew.KiCadPlugin
	__init__ (self)

	register (self)

	deregister (self)

	GetPluginPath (self)

Public Attributes
	draw

Public Attributes inherited from pcbnew.FootprintWizardPlugin
	module = None

list	params = []

str	name = "KiCad FP Wizard"

str	description = "Undefined Footprint Wizard plugin"

str	image = ""

str	buildmessages = ""

	pages

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()

plugins.FootprintWizardBase.FootprintWizard.__init__ ( self )

Definition at line 57 of file FootprintWizardBase.py.

Member Function Documentation

◆ BuildFootprint()

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.

◆ BuildThisFootprint()

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()

plugins.FootprintWizardBase.FootprintWizard.CheckParameters ( self )

Any custom parameter checking should be performed here.

Definition at line 85 of file FootprintWizardBase.py.

◆ GenerateParameterList()

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()

plugins.FootprintWizardBase.FootprintWizard.GetDescription ( self )

Return the footprint wizard description.

Reimplemented from pcbnew.FootprintWizardPlugin.

Definition at line 67 of file FootprintWizardBase.py.

◆ GetName()

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()

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()

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()

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()

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

◆ draw

plugins.FootprintWizardBase.FootprintWizard.draw

Initial value:

= FootprintWizardDrawingAids(

self.module)

Definition at line 138 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

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ BuildFootprint()

◆ BuildThisFootprint()

◆ CheckParameters()

◆ GenerateParameterList()

◆ GetDescription()

◆ GetName()

◆ GetTextSize()

◆ GetTextThickness()

◆ GetValue()

◆ SetModule3DModel()

Member Data Documentation

◆ draw

◆ uBool

◆ uDegrees

◆ uFloat

◆ uInteger

◆ uMils

◆ uMM

◆ uPercent

◆ uRadians

◆ uString

◆ init()