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

Public Member Functions

def __init__ (self, args)
 
def ClassOf (aItem)
 
def Next (self)
 
def Back (self)
 
def AddNative
 
def RemoveNative (self, aItem)
 
def ClearAllNets (self)
 
def CalculateBoundingBox (self)
 
def GetFootprintRect (self)
 
def GetBoundingBox (self)
 
def PadsList (self, args)
 
def GraphicalItemsList (self, args)
 
def Pads (self)
 
def GraphicalItems (self)
 
def Models (self, args)
 
def SetPosition (self, aPos)
 
def GetPosition (self)
 
def SetOrientation (self, newangle)
 
def SetOrientationDegrees (self, aOrientation)
 
def GetOrientation (self)
 
def GetOrientationDegrees (self)
 
def GetOrientationRadians (self)
 
def GetFPID (self)
 
def SetFPID (self, aFPID)
 
def GetDescription (self)
 
def SetDescription (self, aDoc)
 
def GetKeywords (self)
 
def SetKeywords (self, aKeywords)
 
def GetPath (self)
 
def SetPath (self, aPath)
 
def GetLocalSolderMaskMargin (self)
 
def SetLocalSolderMaskMargin (self, aMargin)
 
def GetLocalClearance (self)
 
def SetLocalClearance (self, aClearance)
 
def GetLocalSolderPasteMargin (self)
 
def SetLocalSolderPasteMargin (self, aMargin)
 
def GetLocalSolderPasteMarginRatio (self)
 
def SetLocalSolderPasteMarginRatio (self, aRatio)
 
def SetZoneConnection (self, aType)
 
def GetZoneConnection (self)
 
def SetThermalWidth (self, aWidth)
 
def GetThermalWidth (self)
 
def SetThermalGap (self, aGap)
 
def GetThermalGap (self)
 
def GetAttributes (self)
 
def SetAttributes (self, aAttributes)
 
def SetFlag (self, aFlag)
 
def IncrementFlag (self)
 
def GetFlag (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def MoveAnchorPosition (self, aMoveVector)
 
def IsFlipped (self)
 
def IsLocked (self)
 
def SetLocked (self, isLocked)
 
def IsPlaced (self)
 
def SetIsPlaced (self, isPlaced)
 
def NeedsPlaced (self)
 
def SetNeedsPlaced (self, needsPlaced)
 
def PadsLocked (self)
 
def SetPadsLocked (self, aPadsLocked)
 
def SetLastEditTime (self, args)
 
def GetLastEditTime (self)
 
def Draw (self, args)
 
def DrawOutlinesWhenMoving (self, aPanel, aDC, aMoveVector)
 
def TransformPadsShapesWithClearanceToPolygon
 
def TransformGraphicShapesWithClearanceToPolygonSet
 
def TransformGraphicTextWithClearanceToPolygonSet
 
def DrawEdgesOnly (self, panel, DC, offset, draw_mode)
 
def DrawAncre (self, panel, DC, offset, dim_ancre, draw_mode)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, args)
 
def GetReference (self)
 
def SetReference (self, aReference)
 
def GetReferencePrefix (self)
 
def GetValue (self)
 
def SetValue (self, aValue)
 
def Value (self, args)
 
def Reference (self, args)
 
def FindPadByName (self, aPadName)
 
def GetPad (self, args)
 
def GetTopLeftPad (self)
 
def GetPadCount (self, args)
 
def GetUniquePadCount (self, args)
 
def GetNextPadName (self, aFillSequenceGaps)
 
def GetArea (self)
 
def GetLink (self)
 
def SetLink (self, aLink)
 
def GetPlacementCost180 (self)
 
def SetPlacementCost180 (self, aCost)
 
def GetPlacementCost90 (self)
 
def SetPlacementCost90 (self, aCost)
 
def Duplicate
 
def Add3DModel (self, a3DModel)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
def RunOnChildren (self, aFunction)
 
def ViewGetLayers (self, aLayers, aCount)
 
def ViewGetLOD (self, aLayer, aView)
 
def ViewBBox (self)
 
def CopyNetlistSettings (self, aModule, aCopyLocalSettings)
 
def IsLibNameValid (aName)
 
def StringLibNameInvalidChars (aUserReadable)
 
def SetInitialComments (self, aInitialComments)
 
def PadCoverageRatio (self)
 
def GetInitialComments (self)
 
def GetPolyCourtyardFront (self)
 
def GetPolyCourtyardBack (self)
 
def BuildPolyCourtyard (self)
 
def Pads (self)
 
def GraphicalItems (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM_CONTAINER
def __init__ (self, args, kwargs)
 
def AddNative
 
def RemoveNative (self, aItem)
 
def DeleteNative (self, aItem)
 
def Add (self, item)
 
def Remove (self, item)
 
def Delete (self, item)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, args, kwargs)
 
def GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, args)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, args)
 
def Rotate (self, args)
 
def Flip (self, args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, args, kwargs)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def ClearFlags
 
def GetFlags (self)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Public Attributes

 this
 

Static Public Attributes

tuple ClassOf = staticmethod(ClassOf)
 
tuple IsLibNameValid = staticmethod(IsLibNameValid)
 
tuple StringLibNameInvalidChars = staticmethod(StringLibNameInvalidChars)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
tuple ShowShape = staticmethod(ShowShape)
 
tuple FormatAngle = staticmethod(FormatAngle)
 
tuple FormatInternalUnits = staticmethod(FormatInternalUnits)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
tuple IterateForward = staticmethod(IterateForward)
 
tuple Sort = staticmethod(Sort)
 

Detailed Description

C++ includes: class_module.h 

Definition at line 35922 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.MODULE.__init__ (   self,
  args 
)
__init__(MODULE self, BOARD parent) -> MODULE
__init__(MODULE self, MODULE aModule) -> MODULE

MODULE::MODULE(const MODULE
&aModule) 

Definition at line 35934 of file pcbnew.py.

Member Function Documentation

def pcbnew.MODULE.Add3DModel (   self,
  a3DModel 
)
Add3DModel(MODULE self, S3D_INFO * a3DModel)

void
MODULE::Add3DModel(S3D_INFO *a3DModel)

Function Add3DModel adds a3DModel definition to the end of the 3D
model list.

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

a3DModel:  A pointer to a S3D_INFO to add to the list. 

Definition at line 37223 of file pcbnew.py.

def pcbnew.MODULE.AddNative (   self,
  aItem,
  aMode = ADD_INSERT 
)
AddNative(MODULE self, BOARD_ITEM aItem, ADD_MODE aMode=ADD_INSERT)
AddNative(MODULE self, BOARD_ITEM aItem)

void MODULE::Add(BOARD_ITEM
*aItem, ADD_MODE aMode=ADD_INSERT) override

>

Adds an item to the container.

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

aItem:  is an item to be added.

aMode:  decides whether the item is added in the beginning or at the
end of the list. 

Definition at line 35976 of file pcbnew.py.

def pcbnew.MODULE.Back (   self)
Back(MODULE self) -> MODULE

MODULE* MODULE::Back() const 

Definition at line 35967 of file pcbnew.py.

def pcbnew.MODULE.BuildPolyCourtyard (   self)
BuildPolyCourtyard(MODULE self) -> bool

bool
MODULE::BuildPolyCourtyard()

Used in DRC to build the courtyard area (a complex polygon) from
graphic items put on the courtyard.

true if OK, or no courtyard defined, false only if the polygon cannot
be built due to amalformed courtyard shape The polygon cannot be built
if segments/arcs on courtyard layers cannot be grouped in a polygon.

Definition at line 37549 of file pcbnew.py.

def pcbnew.MODULE.CalculateBoundingBox (   self)
CalculateBoundingBox(MODULE self)

void
MODULE::CalculateBoundingBox()

Function CalculateBoundingBox calculates the bounding box in board
coordinates. 

Definition at line 36035 of file pcbnew.py.

def pcbnew.MODULE.ClassOf (   aItem)
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 35950 of file pcbnew.py.

def pcbnew.MODULE.ClearAllNets (   self)
ClearAllNets(MODULE self)

void
MODULE::ClearAllNets()

Function ClearAllNets Clear (i.e.

force the ORPHANED dummy net info) the net info which depends on a
given board for all pads of the footprint. This is needed when a
footprint is copied between the fp editor and the board editor for
instance, because net info become fully broken 

Definition at line 36018 of file pcbnew.py.

def pcbnew.MODULE.Clone (   self)
Clone(MODULE self) -> EDA_ITEM

EDA_ITEM * MODULE::Clone()
const override

Function Clone creates a duplicate of this item with linked list
members set to NULL.

The default version will return NULL in release builds and likely
crash the program. In debug builds, a warning message indicating the
derived class has not implemented cloning. This really should be a
pure virtual function. Due to the fact that there are so many objects
derived from EDA_ITEM, the decision was made to return NULL until all
the objects derived from EDA_ITEM implement cloning. Once that
happens, this function should be made pure.

A clone of the item. 

Definition at line 37323 of file pcbnew.py.

def pcbnew.MODULE.CopyNetlistSettings (   self,
  aModule,
  aCopyLocalSettings 
)
CopyNetlistSettings(MODULE self, MODULE aModule, bool aCopyLocalSettings)

void
MODULE::CopyNetlistSettings(MODULE *aModule, bool aCopyLocalSettings)

Function CopyNetlistSettings copies the netlist settings to aModule.

Used to copy some footprint parameters when replacing a footprint by
an other footprint when reading a netlist, or in exchange footprint
dialog

The netlist settings are all of the MODULE settings not define by a
MODULE in a netlist. These setting include placement prms (position,
orientation, side) and optionally local prms( clearances, zone
connection type, etc). The reference designator, value, path, and
physical geometry settings are not copied.

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

aModule:  is the MODULE to copy the settings to.

aCopyLocalSettings:  = false to copy only module placement true to
also copy local prms 

Definition at line 37421 of file pcbnew.py.

def pcbnew.MODULE.Draw (   self,
  args 
)
Draw(MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode)

void MODULE::Draw(EDA_DRAW_PANEL
*aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint
&aOffset=ZeroOffset) override

Function Draw draws the footprint to the aDC.

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

aPanel:  = draw panel, Used to know the clip box

aDC:  = Current Device Context

aDrawMode:  = GR_OR, GR_XOR..

aOffset:  = draw offset (usually wxPoint(0,0) 

Definition at line 36650 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.MODULE.DrawAncre (   self,
  panel,
  DC,
  offset,
  dim_ancre,
  draw_mode 
)
DrawAncre(MODULE self, EDA_DRAW_PANEL * panel, wxDC * DC, wxPoint offset, int dim_ancre, GR_DRAWMODE draw_mode)

void
MODULE::DrawAncre(EDA_DRAW_PANEL *panel, wxDC *DC, const wxPoint
&offset, int dim_ancre, GR_DRAWMODE draw_mode)

Function DrawAncre Draw the anchor cross (vertical) Must be done after
the pads, because drawing the hole will erase overwrite every thing
already drawn. 

Definition at line 36844 of file pcbnew.py.

def pcbnew.MODULE.DrawEdgesOnly (   self,
  panel,
  DC,
  offset,
  draw_mode 
)
DrawEdgesOnly(MODULE self, EDA_DRAW_PANEL * panel, wxDC * DC, wxPoint offset, GR_DRAWMODE draw_mode)

void
MODULE::DrawEdgesOnly(EDA_DRAW_PANEL *panel, wxDC *DC, const wxPoint
&offset, GR_DRAWMODE draw_mode)

Function DrawEdgesOnly Draws the footprint edges only to the current
Device Context.

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

panel:  = The active Draw Panel (used to know the clip box)

DC:  = current Device Context

offset:  = draw offset (usually wxPoint(0,0)

draw_mode:  = GR_OR, GR_XOR, GR_AND 

Definition at line 36819 of file pcbnew.py.

def pcbnew.MODULE.DrawOutlinesWhenMoving (   self,
  aPanel,
  aDC,
  aMoveVector 
)
DrawOutlinesWhenMoving(MODULE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, wxPoint aMoveVector)

void
MODULE::DrawOutlinesWhenMoving(EDA_DRAW_PANEL *aPanel, wxDC *aDC,
const wxPoint &aMoveVector)

Function DrawOutlinesWhenMoving draws in XOR mode the footprint when
moving it to the aDC.

To speed up the drawing, only a simplified shape is drawn

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

aPanel:  = draw panel, Used to know the clip box

aDC:  = Current Device Context

aMoveVector:  = the offset between the curr position and the draw
position. 

Definition at line 36675 of file pcbnew.py.

def pcbnew.MODULE.Duplicate (   self,
  aItem,
  aIncrementPadNumbers,
  aAddToModule = False 
)
Duplicate(MODULE self, BOARD_ITEM aItem, bool aIncrementPadNumbers, bool aAddToModule=False) -> BOARD_ITEM
Duplicate(MODULE self, BOARD_ITEM aItem, bool aIncrementPadNumbers) -> BOARD_ITEM

BOARD_ITEM *
MODULE::Duplicate(const BOARD_ITEM *aItem, bool aIncrementPadNumbers,
bool aAddToModule=false)

Function Duplicate Duplicate a given item within the module, without
adding to the board.

the new item, or NULL if the item could not be duplicated 

Definition at line 37206 of file pcbnew.py.

def pcbnew.MODULE.FindPadByName (   self,
  aPadName 
)
FindPadByName(MODULE self, wxString aPadName) -> D_PAD

D_PAD *
MODULE::FindPadByName(const wxString &aPadName) const

Function FindPadByName returns a D_PAD* with a matching name.

Note that names may not be unique, depending on how the foot print was
created.

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

aPadName:  the pad name to find

D_PAD* - The first matching name is returned, or NULL if not found. 

Definition at line 37012 of file pcbnew.py.

def pcbnew.MODULE.Flip (   self,
  aCentre 
)
Flip(MODULE self, wxPoint aCentre)

void BOARD_ITEM::Flip(const
VECTOR2I &aCentre) 

Definition at line 36493 of file pcbnew.py.

def pcbnew.MODULE.GetArea (   self)
GetArea(MODULE self) -> double

double MODULE::GetArea()
const 

Definition at line 37136 of file pcbnew.py.

def pcbnew.MODULE.GetAttributes (   self)
GetAttributes(MODULE self) -> int

int
MODULE::GetAttributes() const 

Definition at line 36423 of file pcbnew.py.

def pcbnew.MODULE.GetBoundingBox (   self)
GetBoundingBox(MODULE self) -> EDA_RECT

const EDA_RECT
MODULE::GetBoundingBox() const override

Function GetBoundingBox returns the orthogonal, bounding box of this
object for display purposes.

This box should be an enclosing perimeter for visible components of
this object, and the units should be in the pcb or schematic
coordinate system. It is OK to overestimate the size by a few counts.

Definition at line 36063 of file pcbnew.py.

def pcbnew.MODULE.GetClass (   self)
GetClass(MODULE self) -> wxString

wxString MODULE::GetClass()
const override

Function GetClass returns the class name.

wxString 

Definition at line 37272 of file pcbnew.py.

def pcbnew.MODULE.GetDescription (   self)
GetDescription(MODULE self) -> wxString

const wxString&
MODULE::GetDescription() const 

Definition at line 36223 of file pcbnew.py.

def pcbnew.MODULE.GetFlag (   self)
GetFlag(MODULE self) -> int

int MODULE::GetFlag() const

Definition at line 36463 of file pcbnew.py.

def pcbnew.MODULE.GetFootprintRect (   self)
GetFootprintRect(MODULE self) -> EDA_RECT

EDA_RECT
MODULE::GetFootprintRect() const

Function GetFootprintRect() Returns the area of the module footprint
excluding any text.

EDA_RECT - The rectangle containing the footprint. 

Definition at line 36048 of file pcbnew.py.

def pcbnew.MODULE.GetFPID (   self)
GetFPID(MODULE self) -> LIB_ID

const LIB_ID&
MODULE::GetFPID() const 

Definition at line 36203 of file pcbnew.py.

def pcbnew.MODULE.GetInitialComments (   self)
GetInitialComments(MODULE self) -> wxArrayString const *

const
wxArrayString* MODULE::GetInitialComments() const

Return the initial comments block or NULL if none, without transfer of
ownership. 

Definition at line 37512 of file pcbnew.py.

def pcbnew.MODULE.GetKeywords (   self)
GetKeywords(MODULE self) -> wxString

const wxString&
MODULE::GetKeywords() const 

Definition at line 36243 of file pcbnew.py.

def pcbnew.MODULE.GetLastEditTime (   self)
GetLastEditTime(MODULE self) -> time_t

time_t
MODULE::GetLastEditTime() const 

Definition at line 36640 of file pcbnew.py.

def pcbnew.MODULE.GetLink (   self)
GetLink(MODULE self) -> time_t

time_t MODULE::GetLink()
const 

Definition at line 37146 of file pcbnew.py.

def pcbnew.MODULE.GetLocalClearance (   self)
GetLocalClearance(MODULE self) -> int

int
MODULE::GetLocalClearance() const 

Definition at line 36303 of file pcbnew.py.

def pcbnew.MODULE.GetLocalSolderMaskMargin (   self)
GetLocalSolderMaskMargin(MODULE self) -> int

int
MODULE::GetLocalSolderMaskMargin() const 

Definition at line 36283 of file pcbnew.py.

def pcbnew.MODULE.GetLocalSolderPasteMargin (   self)
GetLocalSolderPasteMargin(MODULE self) -> int

int
MODULE::GetLocalSolderPasteMargin() const 

Definition at line 36323 of file pcbnew.py.

def pcbnew.MODULE.GetLocalSolderPasteMarginRatio (   self)
GetLocalSolderPasteMarginRatio(MODULE self) -> double

double
MODULE::GetLocalSolderPasteMarginRatio() const 

Definition at line 36343 of file pcbnew.py.

def pcbnew.MODULE.GetMenuImage (   self)
GetMenuImage(MODULE self) -> BITMAP_DEF

BITMAP_DEF
MODULE::GetMenuImage() const override

Function GetMenuImage returns a pointer to an image to be used in
menus.

The default version returns the right arrow image. Override this
function to provide object specific menu images. The menu image
associated with the item. 

Definition at line 37306 of file pcbnew.py.

def pcbnew.MODULE.GetMsgPanelInfo (   self,
  aList 
)
GetMsgPanelInfo(MODULE self, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

void
MODULE::GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override

>

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects
with it's internal state for display purposes. This method replaces
DisplayInfo() so that KiCad objects no longer have any knowledge of
wxWidgets UI objects.

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

aList:  is the list to populate. 

Definition at line 36859 of file pcbnew.py.

def pcbnew.MODULE.GetNextPadName (   self,
  aFillSequenceGaps 
)
GetNextPadName(MODULE self, bool aFillSequenceGaps) -> wxString

wxString
MODULE::GetNextPadName(bool aFillSequenceGaps) const

Function GetNextPadName returns the next available pad name in the
module.

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

aFillSequenceGaps:  true if the numbering should "fill in" gaps in
the sequence, else return the highest value + 1

the next available pad name 

Definition at line 37115 of file pcbnew.py.

def pcbnew.MODULE.GetOrientation (   self)
GetOrientation(MODULE self) -> double

double
MODULE::GetOrientation() const 

Definition at line 36173 of file pcbnew.py.

def pcbnew.MODULE.GetOrientationDegrees (   self)
GetOrientationDegrees(MODULE self) -> double

double
MODULE::GetOrientationDegrees() const 

Definition at line 36183 of file pcbnew.py.

def pcbnew.MODULE.GetOrientationRadians (   self)
GetOrientationRadians(MODULE self) -> double

double
MODULE::GetOrientationRadians() const 

Definition at line 36193 of file pcbnew.py.

def pcbnew.MODULE.GetPad (   self,
  args 
)
GetPad(MODULE self, wxPoint aPosition, LSET aLayerMask) -> D_PAD
GetPad(MODULE self, wxPoint aPosition) -> D_PAD

D_PAD * MODULE::GetPad(const
wxPoint &aPosition, LSET aLayerMask=LSET::AllLayersMask())

Function GetPad get a pad at aPosition on aLayerMask in the footprint.

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

aPosition:  A wxPoint object containing the position to hit test.

aLayerMask:  A layer or layers to mask the hit test.

A pointer to a D_PAD object if found otherwise NULL. 

Definition at line 37034 of file pcbnew.py.

def pcbnew.MODULE.GetPadCount (   self,
  args 
)
GetPadCount(MODULE self, INCLUDE_NPTH_T aIncludeNPTH) -> unsigned int
GetPadCount(MODULE self) -> unsigned int

unsigned
MODULE::GetPadCount(INCLUDE_NPTH_T
aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const

GetPadCount returns the number of pads.

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

aIncludeNPTH:  includes non-plated through holes when true. Does not
include non- plated through holes when false.

the number of pads according to aIncludeNPTH. 

Definition at line 37066 of file pcbnew.py.

def pcbnew.MODULE.GetPath (   self)
GetPath(MODULE self) -> wxString

const wxString&
MODULE::GetPath() const 

Definition at line 36263 of file pcbnew.py.

def pcbnew.MODULE.GetPlacementCost180 (   self)
GetPlacementCost180(MODULE self) -> int

int
MODULE::GetPlacementCost180() const 

Definition at line 37166 of file pcbnew.py.

def pcbnew.MODULE.GetPlacementCost90 (   self)
GetPlacementCost90(MODULE self) -> int

int
MODULE::GetPlacementCost90() const 

Definition at line 37186 of file pcbnew.py.

def pcbnew.MODULE.GetPolyCourtyardBack (   self)
GetPolyCourtyardBack(MODULE self) -> SHAPE_POLY_SET

SHAPE_POLY_SET&
MODULE::GetPolyCourtyardBack() 

Definition at line 37539 of file pcbnew.py.

def pcbnew.MODULE.GetPolyCourtyardFront (   self)
GetPolyCourtyardFront(MODULE self) -> SHAPE_POLY_SET

SHAPE_POLY_SET&
MODULE::GetPolyCourtyardFront()

Used in DRC to test the courtyard area (a complex polygon)

the courtyard polygon 

Definition at line 37525 of file pcbnew.py.

def pcbnew.MODULE.GetPosition (   self)
GetPosition(MODULE self) -> wxPoint

const wxPoint&
MODULE::GetPosition() const override 

Definition at line 36143 of file pcbnew.py.

def pcbnew.MODULE.GetReference (   self)
GetReference(MODULE self) -> wxString

const wxString&
MODULE::GetReference() const

Function GetReference.

const wxString& - the reference designator text. 

Definition at line 36909 of file pcbnew.py.

def pcbnew.MODULE.GetReferencePrefix (   self)
GetReferencePrefix(MODULE self) -> wxString

wxString
MODULE::GetReferencePrefix() const

Function GetReference prefix Gets the alphabetic prefix of the module
reference - e.g.

R1 -> R IC34 -> IC the reference prefix (may be empty) 

Definition at line 36941 of file pcbnew.py.

def pcbnew.MODULE.GetSelectMenuText (   self)
GetSelectMenuText(MODULE self) -> wxString

wxString
MODULE::GetSelectMenuText() const override

Function GetSelectMenuText returns the text to display to be used in
the selection clarification context menu when multiple items are found
at the current cursor position.

The default version of this function raises an assertion in the debug
mode and returns a string to indicate that it was not overridden to
provide the object specific text.

The menu text string. 

Definition at line 37286 of file pcbnew.py.

def pcbnew.MODULE.GetThermalGap (   self)
GetThermalGap(MODULE self) -> int

int
MODULE::GetThermalGap() const 

Definition at line 36413 of file pcbnew.py.

def pcbnew.MODULE.GetThermalWidth (   self)
GetThermalWidth(MODULE self) -> int

int
MODULE::GetThermalWidth() const 

Definition at line 36393 of file pcbnew.py.

def pcbnew.MODULE.GetTopLeftPad (   self)
GetTopLeftPad(MODULE self) -> D_PAD

D_PAD *
MODULE::GetTopLeftPad() 

Definition at line 37056 of file pcbnew.py.

def pcbnew.MODULE.GetUniquePadCount (   self,
  args 
)
GetUniquePadCount(MODULE self, INCLUDE_NPTH_T aIncludeNPTH) -> unsigned int
GetUniquePadCount(MODULE self) -> unsigned int

unsigned
MODULE::GetUniquePadCount(INCLUDE_NPTH_T
aIncludeNPTH=INCLUDE_NPTH_T(INCLUDE_NPTH)) const

GetUniquePadCount returns the number of unique pads.

A complex pad can be built with many pads having the same pad name to
create a complex shape or fragmented solder paste areas.

GetUniquePadCount calculate the count of not blank pad names

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

aIncludeNPTH:  includes non-plated through holes when true. Does not
include non- plated through holes when false.

the number of unique pads according to aIncludeNPTH. 

Definition at line 37088 of file pcbnew.py.

def pcbnew.MODULE.GetValue (   self)
GetValue(MODULE self) -> wxString

const wxString&
MODULE::GetValue() const

Function GetValue.

const wxString& - the value text. 

Definition at line 36956 of file pcbnew.py.

def pcbnew.MODULE.GetZoneConnection (   self)
GetZoneConnection(MODULE self) -> ZoneConnection

ZoneConnection
MODULE::GetZoneConnection() const 

Definition at line 36373 of file pcbnew.py.

def pcbnew.MODULE.GraphicalItems (   self)
GraphicalItems(MODULE self) -> DLIST_ITERATOR_WRAPPER< BOARD_ITEM >

DLIST_ITERATOR_WRAPPER<BOARD_ITEM> MODULE::GraphicalItems() 

Definition at line 36113 of file pcbnew.py.

def pcbnew.MODULE.GraphicalItems (   self)

Definition at line 37569 of file pcbnew.py.

def pcbnew.MODULE.GraphicalItemsList (   self,
  args 
)
GraphicalItemsList(MODULE self) -> BOARD_ITEM_List
GraphicalItemsList(MODULE self) -> BOARD_ITEM_List

const
DLIST<BOARD_ITEM>& MODULE::GraphicalItemsList() const 

Definition at line 36092 of file pcbnew.py.

def pcbnew.MODULE.HitTest (   self,
  args 
)
HitTest(MODULE self, wxPoint aPosition) -> bool
HitTest(MODULE self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(MODULE self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(MODULE self, EDA_RECT aRect) -> bool

bool MODULE::HitTest(const
EDA_RECT &aRect, bool aContained=true, int aAccuracy=0) const override

Function HitTest tests if the aRect intersects or contains this object
(depending on aContained).

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

aRect:  A reference to an EDA_RECT object containg the area to test.

aContained:  Test if aRect contains this object completly.

aAccuracy:  Increase the item bounding box by this amount.

bool - True if aRect contains this object completly or if aRect
intersects the object and aContained is False, otherwise false. 

Definition at line 36881 of file pcbnew.py.

def pcbnew.MODULE.IncrementFlag (   self)
IncrementFlag(MODULE self)

void
MODULE::IncrementFlag() 

Definition at line 36453 of file pcbnew.py.

def pcbnew.MODULE.IsFlipped (   self)
IsFlipped(MODULE self) -> bool

bool MODULE::IsFlipped()
const

function IsFlipped

true if the module is flipped, i.e. on the back side of the board 

Definition at line 36523 of file pcbnew.py.

def pcbnew.MODULE.IsLibNameValid (   aName)
IsLibNameValid(wxString aName) -> bool

Definition at line 37451 of file pcbnew.py.

def pcbnew.MODULE.IsLocked (   self)
IsLocked(MODULE self) -> bool

bool MODULE::IsLocked()
const override

Function IsLocked.

bool - true if the object is locked, else false 

Definition at line 36537 of file pcbnew.py.

def pcbnew.MODULE.IsPlaced (   self)
IsPlaced(MODULE self) -> bool

bool MODULE::IsPlaced()
const 

Definition at line 36569 of file pcbnew.py.

def pcbnew.MODULE.Models (   self,
  args 
)
Models(MODULE self) -> std::list< S3D_INFO >
Models(MODULE self) -> std::list< S3D_INFO > const &

const std::list<S3D_INFO>&
MODULE::Models() const 

Definition at line 36122 of file pcbnew.py.

def pcbnew.MODULE.Move (   self,
  aMoveVector 
)
Move(MODULE self, wxPoint aMoveVector)

void BOARD_ITEM::Move(const
VECTOR2I &aMoveVector) 

Definition at line 36473 of file pcbnew.py.

def pcbnew.MODULE.MoveAnchorPosition (   self,
  aMoveVector 
)
MoveAnchorPosition(MODULE self, wxPoint aMoveVector)

void
MODULE::MoveAnchorPosition(const wxPoint &aMoveVector)

Function MoveAnchorPosition Move the reference point of the footprint
It looks like a move footprint: the footprints elements (pads,
outlines, edges .

. ) are moved However: the footprint position is not modified.

the relative (local) coordinates of these items are modified (a move
footprint does not change these local coordinates, but changes the
footprint position) 

Definition at line 36503 of file pcbnew.py.

def pcbnew.MODULE.NeedsPlaced (   self)
NeedsPlaced(MODULE self) -> bool

bool
MODULE::NeedsPlaced() const 

Definition at line 36589 of file pcbnew.py.

def pcbnew.MODULE.Next (   self)
Next(MODULE self) -> MODULE

MODULE* MODULE::Next() const 

Definition at line 35958 of file pcbnew.py.

def pcbnew.MODULE.PadCoverageRatio (   self)
PadCoverageRatio(MODULE self) -> double

double
MODULE::PadCoverageRatio() const

Function PadCoverageRatio Calculates the ratio of total area of the
footprint pads to the area of the footprint.

Used by selection tool heuristics. the ratio 

Definition at line 37497 of file pcbnew.py.

def pcbnew.MODULE.Pads (   self)
Pads(MODULE self) -> DLIST_ITERATOR_WRAPPER< D_PAD >

DLIST_ITERATOR_WRAPPER<D_PAD>
MODULE::Pads() 

Definition at line 36103 of file pcbnew.py.

def pcbnew.MODULE.Pads (   self)

Definition at line 37568 of file pcbnew.py.

def pcbnew.MODULE.PadsList (   self,
  args 
)
PadsList(MODULE self) -> PAD_List
PadsList(MODULE self) -> PAD_List

const DLIST<D_PAD>&
MODULE::PadsList() const 

Definition at line 36081 of file pcbnew.py.

def pcbnew.MODULE.PadsLocked (   self)
PadsLocked(MODULE self) -> bool

bool MODULE::PadsLocked()
const 

Definition at line 36609 of file pcbnew.py.

def pcbnew.MODULE.Reference (   self,
  args 
)
Reference(MODULE self) -> TEXTE_MODULE
Reference(MODULE self) -> TEXTE_MODULE

TEXTE_MODULE&
MODULE::Reference() const 

Definition at line 37001 of file pcbnew.py.

def pcbnew.MODULE.RemoveNative (   self,
  aItem 
)
RemoveNative(MODULE self, BOARD_ITEM aItem)

void MODULE::Remove(BOARD_ITEM
*aItem) override

>

Removes an item from the container.

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

aItem:  is an item to be removed. 

Definition at line 35999 of file pcbnew.py.

def pcbnew.MODULE.Rotate (   self,
  aRotCentre,
  aAngle 
)
Rotate(MODULE self, wxPoint aRotCentre, double aAngle)

void BOARD_ITEM::Rotate(const
VECTOR2I &aRotCentre, double aAngle) 

Definition at line 36483 of file pcbnew.py.

def pcbnew.MODULE.RunOnChildren (   self,
  aFunction 
)
RunOnChildren(MODULE self, std::function< void (BOARD_ITEM *) > aFunction)

void
MODULE::RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)

Function RunOnChildren.

Invokes a function on all BOARD_ITEMs that belong to the module (pads,
drawings, texts).

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

aFunction:  is the function to be invoked. 

Definition at line 37346 of file pcbnew.py.

def pcbnew.MODULE.SetAttributes (   self,
  aAttributes 
)
SetAttributes(MODULE self, int aAttributes)

void
MODULE::SetAttributes(int aAttributes) 

Definition at line 36433 of file pcbnew.py.

def pcbnew.MODULE.SetDescription (   self,
  aDoc 
)
SetDescription(MODULE self, wxString aDoc)

void
MODULE::SetDescription(const wxString &aDoc) 

Definition at line 36233 of file pcbnew.py.

def pcbnew.MODULE.SetFlag (   self,
  aFlag 
)
SetFlag(MODULE self, int aFlag)

void MODULE::SetFlag(int
aFlag) 

Definition at line 36443 of file pcbnew.py.

def pcbnew.MODULE.SetFPID (   self,
  aFPID 
)
SetFPID(MODULE self, LIB_ID aFPID)

void MODULE::SetFPID(const
LIB_ID &aFPID) 

Definition at line 36213 of file pcbnew.py.

def pcbnew.MODULE.SetInitialComments (   self,
  aInitialComments 
)
SetInitialComments(MODULE self, wxArrayString * aInitialComments)

void
MODULE::SetInitialComments(wxArrayString *aInitialComments)

Function SetInitialComments takes ownership of caller's heap allocated
aInitialComments block.

The comments are single line strings already containing the
s-expression comments with optional leading whitespace and then a '#'
character followed by optional single line text (text with no line
endings, not even one). This block of single line comments will be
output upfront of any generated s-expression text in the
PCBIO::Format() function.

Note that a block of single line comments constitutes a multiline
block of single line comments. That is, the block is made of
consecutive single line comments.

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

aInitialComments:  is a heap allocated wxArrayString or NULL, which
the caller gives up ownership of over to this MODULE. 

Definition at line 37467 of file pcbnew.py.

def pcbnew.MODULE.SetIsPlaced (   self,
  isPlaced 
)
SetIsPlaced(MODULE self, bool isPlaced)

void
MODULE::SetIsPlaced(bool isPlaced) 

Definition at line 36579 of file pcbnew.py.

def pcbnew.MODULE.SetKeywords (   self,
  aKeywords 
)
SetKeywords(MODULE self, wxString aKeywords)

void
MODULE::SetKeywords(const wxString &aKeywords) 

Definition at line 36253 of file pcbnew.py.

def pcbnew.MODULE.SetLastEditTime (   self,
  args 
)
SetLastEditTime(MODULE self, time_t aTime)
SetLastEditTime(MODULE self)

void
MODULE::SetLastEditTime() 

Definition at line 36629 of file pcbnew.py.

def pcbnew.MODULE.SetLink (   self,
  aLink 
)
SetLink(MODULE self, time_t aLink)

void MODULE::SetLink(time_t
aLink) 

Definition at line 37156 of file pcbnew.py.

def pcbnew.MODULE.SetLocalClearance (   self,
  aClearance 
)
SetLocalClearance(MODULE self, int aClearance)

void
MODULE::SetLocalClearance(int aClearance) 

Definition at line 36313 of file pcbnew.py.

def pcbnew.MODULE.SetLocalSolderMaskMargin (   self,
  aMargin 
)
SetLocalSolderMaskMargin(MODULE self, int aMargin)

void
MODULE::SetLocalSolderMaskMargin(int aMargin) 

Definition at line 36293 of file pcbnew.py.

def pcbnew.MODULE.SetLocalSolderPasteMargin (   self,
  aMargin 
)
SetLocalSolderPasteMargin(MODULE self, int aMargin)

void
MODULE::SetLocalSolderPasteMargin(int aMargin) 

Definition at line 36333 of file pcbnew.py.

def pcbnew.MODULE.SetLocalSolderPasteMarginRatio (   self,
  aRatio 
)
SetLocalSolderPasteMarginRatio(MODULE self, double aRatio)

void
MODULE::SetLocalSolderPasteMarginRatio(double aRatio) 

Definition at line 36353 of file pcbnew.py.

def pcbnew.MODULE.SetLocked (   self,
  isLocked 
)
SetLocked(MODULE self, bool isLocked)

void MODULE::SetLocked(bool
isLocked) override

Function SetLocked sets the MODULE_is_LOCKED bit in the
m_ModuleStatus.

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

isLocked:  When true means turn on locked status, else unlock 

Definition at line 36551 of file pcbnew.py.

def pcbnew.MODULE.SetNeedsPlaced (   self,
  needsPlaced 
)
SetNeedsPlaced(MODULE self, bool needsPlaced)

void
MODULE::SetNeedsPlaced(bool needsPlaced) 

Definition at line 36599 of file pcbnew.py.

def pcbnew.MODULE.SetOrientation (   self,
  newangle 
)
SetOrientation(MODULE self, double newangle)

void
MODULE::SetOrientation(double newangle) 

Definition at line 36153 of file pcbnew.py.

def pcbnew.MODULE.SetOrientationDegrees (   self,
  aOrientation 
)
SetOrientationDegrees(MODULE self, double aOrientation)

void
MODULE::SetOrientationDegrees(double aOrientation) 

Definition at line 36163 of file pcbnew.py.

def pcbnew.MODULE.SetPadsLocked (   self,
  aPadsLocked 
)
SetPadsLocked(MODULE self, bool aPadsLocked)

void
MODULE::SetPadsLocked(bool aPadsLocked) 

Definition at line 36619 of file pcbnew.py.

def pcbnew.MODULE.SetPath (   self,
  aPath 
)
SetPath(MODULE self, wxString aPath)

void MODULE::SetPath(const
wxString &aPath) 

Definition at line 36273 of file pcbnew.py.

def pcbnew.MODULE.SetPlacementCost180 (   self,
  aCost 
)
SetPlacementCost180(MODULE self, int aCost)

void
MODULE::SetPlacementCost180(int aCost) 

Definition at line 37176 of file pcbnew.py.

def pcbnew.MODULE.SetPlacementCost90 (   self,
  aCost 
)
SetPlacementCost90(MODULE self, int aCost)

void
MODULE::SetPlacementCost90(int aCost) 

Definition at line 37196 of file pcbnew.py.

def pcbnew.MODULE.SetPosition (   self,
  aPos 
)
SetPosition(MODULE self, wxPoint aPos)

void
MODULE::SetPosition(const wxPoint &aPos) override 

Definition at line 36133 of file pcbnew.py.

def pcbnew.MODULE.SetReference (   self,
  aReference 
)
SetReference(MODULE self, wxString aReference)

void
MODULE::SetReference(const wxString &aReference)

Function SetReference.

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

aReference:  A reference to a wxString object containing the reference
designator text. 

Definition at line 36923 of file pcbnew.py.

def pcbnew.MODULE.SetThermalGap (   self,
  aGap 
)
SetThermalGap(MODULE self, int aGap)

void
MODULE::SetThermalGap(int aGap) 

Definition at line 36403 of file pcbnew.py.

def pcbnew.MODULE.SetThermalWidth (   self,
  aWidth 
)
SetThermalWidth(MODULE self, int aWidth)

void
MODULE::SetThermalWidth(int aWidth) 

Definition at line 36383 of file pcbnew.py.

def pcbnew.MODULE.SetValue (   self,
  aValue 
)
SetValue(MODULE self, wxString aValue)

void MODULE::SetValue(const
wxString &aValue)

Function SetValue.

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

aValue:  A reference to a wxString object containing the value text.

Definition at line 36970 of file pcbnew.py.

def pcbnew.MODULE.SetZoneConnection (   self,
  aType 
)
SetZoneConnection(MODULE self, ZoneConnection aType)

void
MODULE::SetZoneConnection(ZoneConnection aType) 

Definition at line 36363 of file pcbnew.py.

def pcbnew.MODULE.StringLibNameInvalidChars (   aUserReadable)
StringLibNameInvalidChars(bool aUserReadable) -> wxChar const *

Definition at line 37459 of file pcbnew.py.

def pcbnew.MODULE.TransformGraphicShapesWithClearanceToPolygonSet (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aCircleToSegmentsCountForTexts = 0 
)
TransformGraphicShapesWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, int aCircleToSegmentsCountForTexts=0)
TransformGraphicShapesWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void
MODULE::TransformGraphicShapesWithClearanceToPolygonSet(PCB_LAYER_ID
aLayer, SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int
aCircleToSegmentsCount, double aCorrectionFactor, int
aCircleToSegmentsCountForTexts=0) const

function TransformGraphicShapesWithClearanceToPolygonSet generate
shapes of graphic items (outlines) on layer aLayer as polygons, and
adds these polygons to aCornerBuffer Useful to generate a polygonal
representation of a footprint in 3D view and plot functions, when a
full polygonal approach is needed

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

aLayer:  = the current layer: items on this layer are considered

aCornerBuffer:  = the buffer to store polygons

aInflateValue:  = a value to inflate shapes aInflateValue = 0 to have
the exact shape size

aCircleToSegmentsCount:  = number of segments to generate a circle

aCorrectionFactor:  = the correction to apply to a circle radius to
approximate a circle by the polygon. if aCorrectionFactor = 1.0, the
polygon is inside the circle the radius of circle approximated by
segments is initial radius * aCorrectionFactor

aCircleToSegmentsCountForTexts:  = number of segments to generate a
circle when building the texts polygonal shapes of the stroke font if
0, use the aCircleToSegmentsCount value 

Definition at line 36745 of file pcbnew.py.

def pcbnew.MODULE.TransformGraphicTextWithClearanceToPolygonSet (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aCircleToSegmentsCountForTexts = 0 
)
TransformGraphicTextWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, int aCircleToSegmentsCountForTexts=0)
TransformGraphicTextWithClearanceToPolygonSet(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void
MODULE::TransformGraphicTextWithClearanceToPolygonSet(PCB_LAYER_ID
aLayer, SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int
aCircleToSegmentsCount, double aCorrectionFactor, int
aCircleToSegmentsCountForTexts=0) const

TransformGraphicTextWithClearanceToPolygonSet This function is the
same as TransformGraphicShapesWithClearanceToPolygonSet but only
generate text.

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

aLayer:

aCornerBuffer:

aInflateValue:

aCircleToSegmentsCount:

aCorrectionFactor:

aCircleToSegmentsCountForTexts:  

Definition at line 36786 of file pcbnew.py.

def pcbnew.MODULE.TransformPadsShapesWithClearanceToPolygon (   self,
  aLayer,
  aCornerBuffer,
  aInflateValue,
  aCircleToSegmentsCount,
  aCorrectionFactor,
  aSkipNPTHPadsWihNoCopper = False 
)
TransformPadsShapesWithClearanceToPolygon(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor, bool aSkipNPTHPadsWihNoCopper=False)
TransformPadsShapesWithClearanceToPolygon(MODULE self, PCB_LAYER_ID aLayer, SHAPE_POLY_SET aCornerBuffer, int aInflateValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void
MODULE::TransformPadsShapesWithClearanceToPolygon(PCB_LAYER_ID aLayer,
SHAPE_POLY_SET &aCornerBuffer, int aInflateValue, int
aCircleToSegmentsCount, double aCorrectionFactor, bool
aSkipNPTHPadsWihNoCopper=false) const

function TransformPadsShapesWithClearanceToPolygon generate pads
shapes on layer aLayer as polygons, and adds these polygons to
aCornerBuffer Useful to generate a polygonal representation of a
footprint in 3D view and plot functions, when a full polygonal
approach is needed

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

aLayer:  = the current layer: pads on this layer are considered

aCornerBuffer:  = the buffer to store polygons

aInflateValue:  = an additionnal size to add to pad shapes
aInflateValue = 0 to have the exact pad size

aCircleToSegmentsCount:  = number of segments to generate a circle

aCorrectionFactor:  = the correction to apply to a circle radius to
approximate a circle by the polygon. if aCorrectionFactor = 1.0, the
polygon is inside the circle the radius of circle approximated by
segments is initial radius * aCorrectionFactor

aSkipNPTHPadsWihNoCopper:  = if true, do not add a NPTH pad shape, if
the shape has same size and position as the hole. Usually, these pads
are not drawn on copper layers, because there is actually no copper
Due to diff between layers and holes, these pads must be skipped to be
sure there is no copper left on the board (for instance when creating
Gerber Files or 3D shapes) default = false 

Definition at line 36701 of file pcbnew.py.

def pcbnew.MODULE.Value (   self,
  args 
)
Value(MODULE self) -> TEXTE_MODULE
Value(MODULE self) -> TEXTE_MODULE

TEXTE_MODULE& MODULE::Value()
const

The const versions to keep the compiler happy. 

Definition at line 36988 of file pcbnew.py.

def pcbnew.MODULE.ViewBBox (   self)
ViewBBox(MODULE self) -> BOX2I const

const BOX2I
MODULE::ViewBBox() const override

Function ViewBBox() returns the bounding box of the item covering all
its layers.

BOX2I - the current bounding box 

Definition at line 37406 of file pcbnew.py.

def pcbnew.MODULE.ViewGetLayers (   self,
  aLayers,
  aCount 
)
ViewGetLayers(MODULE self, int [] aLayers, int & aCount)

void
MODULE::ViewGetLayers(int aLayers[], int &aCount) const override

Function ViewGetLayers() Returns the all the layers within the VIEW
the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few
technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called
for each of the layers returned by ViewGetLayers(), depending on the
rendering order.

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

aLayers[]:  output layer index array

aCount:  number of layer indices in aLayers[] 

Definition at line 37366 of file pcbnew.py.

def pcbnew.MODULE.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(MODULE self, int aLayer, KIGFX::VIEW * aView) -> unsigned int

unsigned int
MODULE::ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override

Function ViewGetLOD() Returns the level of detail of the item.

A level of detail is the minimal VIEW scale that is sufficient for an
item to be shown on a given layer. 

Definition at line 37391 of file pcbnew.py.

def pcbnew.MODULE.Visit (   self,
  inspector,
  testData,
  scanTypes 
)
Visit(MODULE self, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

SEARCH_RESULT
MODULE::Visit(INSPECTOR inspector, void *testData, const KICAD_T
scanTypes[]) override

Function Visit may be re-implemented for each derived class in order
to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in
scanTypes[], and may use IterateForward() to do so on lists of such
data.

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

inspector:  An INSPECTOR instance to use in the inspection.

testData:  Arbitrary data used by the inspector.

scanTypes:  Which KICAD_T types are of interest and the order is
significant too, terminated by EOT.

SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else
SCAN_CONTINUE, and determined by the inspector. 

Definition at line 37241 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.MODULE.ClassOf = staticmethod(ClassOf)
static

Definition at line 35955 of file pcbnew.py.

tuple pcbnew.MODULE.IsLibNameValid = staticmethod(IsLibNameValid)
static

Definition at line 37456 of file pcbnew.py.

tuple pcbnew.MODULE.StringLibNameInvalidChars = staticmethod(StringLibNameInvalidChars)
static

Definition at line 37464 of file pcbnew.py.

pcbnew.MODULE.this

Definition at line 35946 of file pcbnew.py.


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