KiCad Pcbnew Python Scripting
Public Member Functions | Public Attributes | List of all members
plugins.PadArray.PadCircleArray Class Reference

Circular pad array. More...

Inheritance diagram for plugins.PadArray.PadCircleArray:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, pad, n, r, angle_offset=0, centre=pcbnew.wxPoint(0, 0), clockwise=True, padRotationEnable=False, padRotationOffset=0)
 
def NamingFunction (self, n)
 Naming around the circle, CW or CCW according to the clockwise flag. More...
 
def AddPadsToModule (self, dc)
 Create the pads and add them to the module in the correct positions. More...
 
- Public Member Functions inherited from plugins.PadArray.PadArray
def __init__ (self, pad)
 
def SetPinNames (self, pinNames)
 Set a name for all the pins. More...
 
def SetFirstPadType (self, firstPad)
 If the array has a different first pad, this is the pad that is used. More...
 
def SetFirstPadInArray (self, fpNum)
 Set the numbering for the first pad in the array. More...
 
def AddPad (self, pad)
 Add a pad to the array, under the same moodule as the main prototype pad. More...
 
def GetPad (self, is_first_pad, pos)
 Get a pad in the array with the given position. More...
 
def GetName (self, args, kwargs)
 Get the pad name from the naming function, or the pre-set pinNames parameter (set with SetPinNames) More...
 
def NamingFunction (self, args, kwargs)
 Implement this as needed for each array type. More...
 

Public Attributes

 n
 
 r
 
 angle_offset
 
 centre
 
 clockwise
 
 padRotationEnable
 
 padRotationOffset
 
- Public Attributes inherited from plugins.PadArray.PadArray
 firstPadNum
 
 pinNames
 
 pad
 
 firstPad
 

Detailed Description

Circular pad array.

Definition at line 368 of file PadArray.py.

Constructor & Destructor Documentation

def plugins.PadArray.PadCircleArray.__init__ (   self,
  pad,
  n,
  r,
  angle_offset = 0,
  centre = pcbnew.wxPoint(0, 0),
  clockwise = True,
  padRotationEnable = False,
  padRotationOffset = 0 
)
Parameters
padthe prototypical pad
nnumber of pads in array
rthe circle radius
angle_offsetangle of the first pad
centrearray centre point
clockwisearray increases in a clockwise direction
padRotationEnablealso rotate pads when placing
padRotationOffsetrotation of first pad

Definition at line 374 of file PadArray.py.

Member Function Documentation

def plugins.PadArray.PadCircleArray.AddPadsToModule (   self,
  dc 
)

Create the pads and add them to the module in the correct positions.

Parameters
dcthe drawing context

Definition at line 402 of file PadArray.py.

def plugins.PadArray.PadCircleArray.NamingFunction (   self,
  n 
)

Naming around the circle, CW or CCW according to the clockwise flag.

Definition at line 396 of file PadArray.py.

Member Data Documentation

plugins.PadArray.PadCircleArray.angle_offset

Definition at line 390 of file PadArray.py.

plugins.PadArray.PadCircleArray.centre

Definition at line 391 of file PadArray.py.

plugins.PadArray.PadCircleArray.clockwise

Definition at line 392 of file PadArray.py.

plugins.PadArray.PadCircleArray.n

Definition at line 388 of file PadArray.py.

plugins.PadArray.PadCircleArray.padRotationEnable

Definition at line 393 of file PadArray.py.

plugins.PadArray.PadCircleArray.padRotationOffset

Definition at line 394 of file PadArray.py.

plugins.PadArray.PadCircleArray.r

Definition at line 389 of file PadArray.py.


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