KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
plugins.PadArray.PadCircleArray Class Reference

Circular pad array. More...

Inheritance diagram for plugins.PadArray.PadCircleArray:

Public Member Functions

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

Public Attributes

 n = int(n)
 
 r = r
 
 angle_offset = angle_offset
 
 centre = centre
 
 clockwise = clockwise
 
 padRotationEnable = padRotationEnable
 
 padRotationOffset = padRotationOffset
 
- Public Attributes inherited from plugins.PadArray.PadArray
int firstPadNum = 1
 
 pinNames = None
 
 pad = pad
 
 firstPad = None
 

Detailed Description

Circular pad array.

Definition at line 389 of file PadArray.py.

Constructor & Destructor Documentation

◆ __init__()

plugins.PadArray.PadCircleArray.__init__ ( self,
pad,
n,
r,
angle_offset = 0,
centre = pcbnew.VECTOR2I(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 394 of file PadArray.py.

Here is the caller graph for this function:

Member Function Documentation

◆ AddPadsToModule()

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 423 of file PadArray.py.

◆ NamingFunction()

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

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

Reimplemented from plugins.PadArray.PadArray.

Definition at line 417 of file PadArray.py.

Member Data Documentation

◆ angle_offset

plugins.PadArray.PadCircleArray.angle_offset = angle_offset

Definition at line 411 of file PadArray.py.

◆ centre

plugins.PadArray.PadCircleArray.centre = centre

Definition at line 412 of file PadArray.py.

◆ clockwise

plugins.PadArray.PadCircleArray.clockwise = clockwise

Definition at line 413 of file PadArray.py.

◆ n

plugins.PadArray.PadCircleArray.n = int(n)

Definition at line 409 of file PadArray.py.

◆ padRotationEnable

plugins.PadArray.PadCircleArray.padRotationEnable = padRotationEnable

Definition at line 414 of file PadArray.py.

◆ padRotationOffset

plugins.PadArray.PadCircleArray.padRotationOffset = padRotationOffset

Definition at line 415 of file PadArray.py.

◆ r

plugins.PadArray.PadCircleArray.r = r

Definition at line 410 of file PadArray.py.


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