KiCad Pcbnew Python Scripting

https://docs.kicad.org/doxygen-python-9.0/
Admin
KiCad Pcbnew Python Scripting provides Python API documentation for automating and extending KiCad's...
Tokens:731,376
Snippets:5,048
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GetStart Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIMENSION__BASE.html

Retrieves the starting point of the dimension.

```python
GetStart(PCB_DIMENSION_BASE self) -> VECTOR2I
```

--------------------------------

### SetStart Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIMENSION__BASE.html

Sets the starting point for the dimension.

```python
SetStart(PCB_DIMENSION_BASE self, VECTOR2I aPoint)
```

--------------------------------

### GetStart()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIMENSION__BASE.html

Retrieves the starting point of the dimension.

```APIDOC
### GetStart()

Returns the starting coordinate of the dimension as a VECTOR2I.
```

--------------------------------

### SetStart method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TRACK.html

Sets the starting point of the track.

```python
SetStart(PCB_TRACK self, VECTOR2I aStart)
```

--------------------------------

### GetStart Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TRACK.html

Retrieves the start coordinate of the track.

```python
GetStart(PCB_TRACK self) -> VECTOR2I
```

--------------------------------

### PADSTACK.StartLayer

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PADSTACK.html

Retrieves the starting layer of the padstack.

```APIDOC
## PADSTACK.StartLayer()

### Description
Retrieves the starting layer of the padstack.

### Method
`StartLayer(PADSTACK self) -> PCB_LAYER_ID`

### Parameters
- **self** (PADSTACK) - The PADSTACK object.

### Returns
- **PCB_LAYER_ID** - The starting layer of the padstack.
```

--------------------------------

### GetP1

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__ARC.html

Retrieves the starting point of the arc.

```APIDOC
## GetP1(self)

### Description
Returns the starting point of the SHAPE_ARC.

### Returns
- **VECTOR2I** - The starting point of the arc.
```

--------------------------------

### GetStartX Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TRACK.html

Retrieves the starting X coordinate of the track.

```python
GetStartX(PCB_TRACK self) -> int
```

--------------------------------

### SetStart(VECTOR2I aPoint)

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIMENSION__BASE.html

Sets the starting point for the dimension.

```APIDOC
### SetStart(VECTOR2I aPoint)

Sets the starting point of the dimension object.

**Parameters:**
- **aPoint** (VECTOR2I) - The coordinate point to set as the start.
```

--------------------------------

### GetP0()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__ARC.html

Retrieves the starting point of the arc.

```APIDOC
### Method
`pcbnew.SHAPE_ARC.GetP0(self)`

### Description
Returns the starting point (P0) of the arc as a VECTOR2I object.
```

--------------------------------

### SetStart

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TRACK.html

Sets the starting coordinate of the track.

```APIDOC
### Method
`pcbnew.PCB_TRACK.SetStart(self, aStart)`

### Description
Sets the starting point of the track.

### Parameters
- **aStart** (VECTOR2I) - The starting coordinate vector.
```

--------------------------------

### GetP1 Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__ARC.html

Retrieves the starting point of the arc.

```python
GetP1(SHAPE_ARC self) -> VECTOR2I
```

--------------------------------

### __init__()

Source: https://docs.kicad.org/doxygen-python-9.0/classplugins_1_1FootprintWizardBase_1_1FootprintWizard.html

Initializes a new instance of the FootprintWizard class.

```APIDOC
## __init__()

### Description
Initializes the FootprintWizard instance. This method is typically called when the plugin is instantiated.

### Signature
`__init__(self)`
```

--------------------------------

### Get arc start angle

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__SHAPE.html

Retrieves the starting angle of the arc shape.

```python
GetArcAngleStart(PCB_SHAPE self) -> EDA_ANGLE
```

--------------------------------

### Get Crossbar Start Coordinate

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIM__ALIGNED.html

Retrieves the start coordinate of the dimension crossbar.

```python
GetCrossbarStart(PCB_DIM_ALIGNED self) -> VECTOR2I
```

--------------------------------

### Constructor: pcbnew.TEXT_ITEM_INFO.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1TEXT__ITEM__INFO.html

Initializes a new instance of the TEXT_ITEM_INFO class.

```APIDOC
## __init__(self, aText, aVisible, aLayer)

### Description
Initializes a new TEXT_ITEM_INFO object with the specified text, visibility status, and layer.

### Parameters
- **aText** (wxString) - Required - The text content.
- **aVisible** (bool) - Required - The visibility status of the text.
- **aLayer** (PCB_LAYER_ID) - Required - The layer identifier for the text item.
```

--------------------------------

### GetStartX

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TRACK.html

Retrieves the starting X coordinate of the track.

```APIDOC
### GetStartX(self)

Returns the starting X coordinate of the track as an integer.
```

--------------------------------

### Retrieve arc geometry

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__ARC.html

Methods to get the angle, start angle, and end angle of the arc.

```python
GetAngle(PCB_ARC self) -> EDA_ANGLE
GetArcAngleEnd(PCB_ARC self) -> EDA_ANGLE
GetArcAngleStart(PCB_ARC self) -> EDA_ANGLE
```

--------------------------------

### PCB_IO_KICAD_SEXPR.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__IO__KICAD__SEXPR.html

Initializes a new instance of the PCB_IO_KICAD_SEXPR class.

```APIDOC
## __init__(self, aControlFlags=(CTL_OMIT_INITIAL_COMMENTS|CTL_OMIT_FOOTPRINT_VERSION))

### Description
Initializes the PCB_IO_KICAD_SEXPR object with optional control flags.

### Parameters
- **aControlFlags** (int) - Optional - Control flags for the initialization process.
```

--------------------------------

### Get UniString Sub-Library Name

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LIB__ID.html

Retrieves the universal string representation of the sub-library name. Returns a wxString. No specific setup or constraints are mentioned.

```python
GetUniStringSubLibraryName(LIB_ID self) -> wxString
```

--------------------------------

### pcbnew.FOOTPRINT.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1FOOTPRINT.html

Initializes a new FOOTPRINT instance.

```APIDOC
## __init__(self, parent)

### Description
Initializes a new FOOTPRINT object associated with a parent BOARD or copies an existing FOOTPRINT.

### Parameters
- **parent** (BOARD) - Required - The parent board for the footprint.
- **aFootprint** (FOOTPRINT) - Required - An existing footprint to copy.
```

--------------------------------

### Get UniString Library Nickname

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LIB__ID.html

Retrieves the universal string representation of the library nickname. Returns a wxString. No specific setup or constraints are mentioned.

```python
GetUniStringLibNickname(LIB_ID self) -> wxString
```

--------------------------------

### SetStart()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1EDA__SHAPE.html

Sets the starting point of the EDA_SHAPE object.

```APIDOC
## SetStart()

### Description
Sets the starting point of the EDA_SHAPE object.

### Method
python

### Endpoint
pcbnew.EDA_SHAPE.SetStart

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **_self_** (EDA_SHAPE) - Required - The EDA_SHAPE object.
- **_aStart_** (VECTOR2I) - Required - The starting point (x, y coordinates).

### Request Example
```python
# Example usage (assuming EDA_SHAPE object and VECTOR2I value are available)
edashape_object.SetStart(some_vector)
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Get UniString Library ID

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LIB__ID.html

Retrieves the universal string representation of the library ID. Returns a wxString. No specific setup or constraints are mentioned.

```python
GetUniStringLibId(LIB_ID self) -> wxString
```

--------------------------------

### Constructor: __init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1wxPoint__Vector.html

Initializes a new instance of the wxPoint_Vector class.

```APIDOC
## __init__

### Description
Initializes a new wxPoint_Vector object. Supports multiple overloads for copying or pre-allocating size.

### Parameters
#### Request Body
- **args** (list) - Required - Arguments for initialization (e.g., other vector, size, or initial value)

### Response
#### Success Response (200)
- **instance** (wxPoint_Vector) - The initialized vector object
```

--------------------------------

### Get Sub-Library Name

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LIB__ID.html

Retrieves the sub-library name from the LIB_ID object. Returns a UTF8 encoded string. No specific setup or constraints are mentioned.

```python
GetSubLibraryName(LIB_ID self) -> UTF8
```

--------------------------------

### Get Library Nickname

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LIB__ID.html

Retrieves the library nickname from the LIB_ID object. Returns a UTF8 encoded string. No specific setup or constraints are mentioned.

```python
GetLibNickname(LIB_ID self) -> UTF8
```

--------------------------------

### Show()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1FootprintWizardPlugin.html

Displays the footprint wizard interface.

```APIDOC
## Show()

### Description
Displays the footprint wizard interface.

### Signature
`pcbnew.FootprintWizardPlugin.Show(self)`
```

--------------------------------

### Get Full Library Name

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LIB__ID.html

Retrieves the full library name from the LIB_ID object. Returns a wxString. No specific setup or constraints are mentioned.

```python
GetFullLibraryName(LIB_ID self) -> wxString
```

--------------------------------

### Get slice from string

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1string.html

Use __getslice__ to extract a portion of the string based on start and end indices. The extracted part is returned as a new string.

```python
__getslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j) -> string
```

--------------------------------

### PCB_REFERENCE_IMAGE.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__REFERENCE__IMAGE.html

Initializes a new instance of the PCB_REFERENCE_IMAGE class.

```APIDOC
## __init__(self, aParent, pos=VECTOR2I(0, 0), aLayer=F_Cu)

### Description
Creates a new PCB_REFERENCE_IMAGE object associated with a parent BOARD_ITEM.

### Parameters
- **aParent** (BOARD_ITEM) - Required - The parent board item.
- **pos** (VECTOR2I) - Optional - The position of the image (default: 0,0).
- **aLayer** (PCB_LAYER_ID) - Optional - The layer for the image (default: F_Cu).

## __init__(self, aPcbBitmap)

### Description
Creates a copy of an existing PCB_REFERENCE_IMAGE object.

### Parameters
- **aPcbBitmap** (PCB_REFERENCE_IMAGE) - Required - The image to copy.
```

--------------------------------

### Get UniString Library Item Name

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LIB__ID.html

Retrieves the universal string representation of the library item name. Returns a wxString. No specific setup or constraints are mentioned.

```python
GetUniStringLibItemName(LIB_ID self) -> wxString
```

--------------------------------

### Get Library Item Name

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LIB__ID.html

Retrieves the library item name from the LIB_ID object. Returns a UTF8 encoded string. No specific setup or constraints are mentioned.

```python
GetLibItemName(LIB_ID self) -> UTF8
```

--------------------------------

### Constructor Initialization

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PRETTIFIED__FILE__OUTPUTFORMATTER.html

Initializes the PRETTIFIED_FILE_OUTPUTFORMATTER with a filename, mode, and quote character.

```python
__init__(PRETTIFIED_FILE_OUTPUTFORMATTER self, wxString aFileName, wxChar const * aMode=wxT( "wt" ), char aQuoteChar='"') -> PRETTIFIED_FILE_OUTPUTFORMATTER
```

--------------------------------

### Get connected items from CONNECTIVITY_DATA

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1CONNECTIVITY__DATA.html

Retrieves connected board items based on a starting item, a vector of item types, and an optional flag to ignore netcodes. Returns a constant vector of BOARD_CONNECTED_ITEM pointers.

```c++
GetConnectedItems(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, std::vector< KICAD_T,std::allocator< KICAD_T > > const & aTypes, bool aIgnoreNetcodes=False) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const
```

--------------------------------

### plugins.PadArray.PadGridArray.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classplugins_1_1PadArray_1_1PadGridArray-members.html

Initializes a new PadGridArray instance for managing a grid of pads.

```APIDOC
## __init__(self, pad, nx, ny, px, py, centre=pcbnew.VECTOR2I(0, 0))

### Description
Initializes the PadGridArray with the specified pad, grid dimensions, and spacing.

### Parameters
- **pad** (object) - Required - The pad object to be used in the array.
- **nx** (int) - Required - Number of pads in the X direction.
- **ny** (int) - Required - Number of pads in the Y direction.
- **px** (int) - Required - Spacing between pads in the X direction.
- **py** (int) - Required - Spacing between pads in the Y direction.
- **centre** (pcbnew.VECTOR2I) - Optional - The center position of the array.
```

--------------------------------

### Get connected items at anchor in CONNECTIVITY_DATA

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1CONNECTIVITY__DATA.html

Retrieves connected board items at a specific anchor point. Takes a starting item, anchor coordinates, item types, and an optional maximum error. Returns a constant vector of BOARD_CONNECTED_ITEM pointers.

```c++
GetConnectedItemsAtAnchor(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, VECTOR2I aAnchor, std::vector< KICAD_T,std::allocator< KICAD_T > > const & aTypes, int const & aMaxError=0) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const
```

--------------------------------

### NET_SETTINGS Constructor

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1NET__SETTINGS.html

Initializes a new instance of the NET_SETTINGS class.

```APIDOC
## __init__

### Description
Initializes a new NET_SETTINGS object.

### Parameters
#### Path Parameters
- **aParent** (JSON_SETTINGS*) - Required - The parent settings object.
- **aPath** (string) - Required - The path for the settings.

### Response
- **NET_SETTINGS** (object) - The initialized NET_SETTINGS instance.
```

--------------------------------

### Check for Arc Start

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__LINE__CHAIN.html

Determines if the point at the specified index is the start of an arc.

```python
IsArcStart(SHAPE_LINE_CHAIN self, size_t aIndex) -> bool
```

--------------------------------

### Initialize PCB_REFERENCE_IMAGE

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__REFERENCE__IMAGE.html

Constructs a new PCB_REFERENCE_IMAGE instance, either from a parent item and position or as a copy of an existing image.

```python
__init__(PCB_REFERENCE_IMAGE self, BOARD_ITEM aParent, VECTOR2I pos=VECTOR2I( 0, 0 ), PCB_LAYER_ID aLayer=F_Cu) -> PCB_REFERENCE_IMAGE
__init__(PCB_REFERENCE_IMAGE self, PCB_REFERENCE_IMAGE aPcbBitmap) -> PCB_REFERENCE_IMAGE
```

--------------------------------

### Retrieve Start Point

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__ARC.html

Returns the starting point (P0) of the arc as a VECTOR2I.

```python
GetP0(SHAPE_ARC self) -> VECTOR2I
```

--------------------------------

### Construct SHAPE_ARC from Start, End, and Center

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__ARC.html

Creates a new SHAPE_ARC instance defined by start, end, and center points.

```python
ConstructFromStartEndCenter(SHAPE_ARC self, VECTOR2I aStart, VECTOR2I aEnd, VECTOR2I aCenter, bool aClockwise=False, double aWidth=0) -> SHAPE_ARC
```

--------------------------------

### Initialize PCB_VIA instance

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__VIA.html

Constructs a new PCB_VIA object, either by specifying a parent BOARD_ITEM or by copying an existing PCB_VIA instance.

```python
__init__(PCB_VIA self, BOARD_ITEM aParent) -> PCB_VIA
__init__(PCB_VIA self, PCB_VIA aOther) -> PCB_VIA
```

--------------------------------

### Construct SHAPE_ARC from Start, End, and Angle

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__ARC.html

Creates a new SHAPE_ARC instance using start and end points along with a specified angle.

```python
ConstructFromStartEndAngle(SHAPE_ARC self, VECTOR2I aStart, VECTOR2I aEnd, EDA_ANGLE aAngle, double aWidth=0) -> SHAPE_ARC
```

--------------------------------

### PCB_DIM_CENTER.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIM__CENTER.html

Initializes a new instance of the PCB_DIM_CENTER class.

```APIDOC
## __init__(self, aParent)

### Description
Initializes a new PCB_DIM_CENTER object with a specified parent board item.

### Parameters
- **aParent** (BOARD_ITEM) - Required - The parent item for this dimension.
```

--------------------------------

### Get Iterator to End

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1NETNAMES__MAP.html

Use `end` to get an iterator pointing to the position after the last element in the NETNAMES_MAP. This is commonly used as a loop termination condition.

```python
end(NETNAMES_MAP self) -> std::map< wxString,NETINFO_ITEM * >::iterator
```

--------------------------------

### PCB_DIM_LEADER.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIM__LEADER.html

Initializes a new instance of the PCB_DIM_LEADER class.

```APIDOC
## PCB_DIM_LEADER.__init__(self, aParent)

### Description
Constructs a new PCB_DIM_LEADER object associated with a parent board item.

### Parameters
- **aParent** (BOARD_ITEM) - Required - The parent item for this dimension.
```

--------------------------------

### Get Iterator to Beginning

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1NETNAMES__MAP.html

Use `begin` to get an iterator pointing to the first element in the NETNAMES_MAP. This is useful for manual iteration over the map's contents.

```python
begin(NETNAMES_MAP self) -> std::map< wxString,NETINFO_ITEM * >::iterator
```

--------------------------------

### Initialize PCB_TEXTBOX

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TEXTBOX.html

Constructor for creating a new PCB_TEXTBOX instance.

```python
__init__(PCB_TEXTBOX self, BOARD_ITEM aParent, KICAD_T aType=PCB_TEXTBOX_T) -> PCB_TEXTBOX
```

--------------------------------

### Class Members - Variables starting with 'y'

Source: https://docs.kicad.org/doxygen-python-9.0/functions_y.html

Lists variables within KiCad's Pcbnew Python scripting API that start with the letter 'y', along with the classes they belong to.

```APIDOC
## Class Members - Variables starting with 'y'

### Description
Lists variables within KiCad's Pcbnew Python scripting API that start with the letter 'y', along with the classes they belong to.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **y** (pcbnew.VECTOR2I, pcbnew.VECTOR2L, pcbnew.VECTOR3D, pcbnew.wxPoint, pcbnew.wxRect, pcbnew.wxSize) - Description of the 'y' variable.
- **y_location** (pcbnew.D356_RECORD) - Description of the 'y_location' variable.
- **y_size** (pcbnew.D356_RECORD) - Description of the 'y_size' variable.

#### Response Example
N/A
```

--------------------------------

### Initialize TEXT_ITEM_INFO Object

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1TEXT__ITEM__INFO.html

Constructs a new TEXT_ITEM_INFO object. Requires text content, visibility status, and layer information.

```python
TEXT_ITEM_INFO(self, wxString aText, bool aVisible, PCB_LAYER_ID aLayer)
```

--------------------------------

### Class Members starting with 'w'

Source: https://docs.kicad.org/doxygen-python-9.0/functions_func_w.html

Lists functions and properties within KiCad's Pcbnew Python scripting API whose names start with the letter 'w'.

```APIDOC
## Class Members starting with 'w'

### Description
This section lists members of classes within the KiCad Pcbnew Python scripting API that begin with the letter 'w'.

### Method
N/A (This is a listing of available members, not an API endpoint)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **What()** (pcbnew.IO_ERROR, pcbnew.KI_PARAM_ERROR) - Description of the What() function.
- **Where()** (pcbnew.IO_ERROR) - Description of the Where() function.
- **Width()** (pcbnew.SHAPE_LINE_CHAIN) - Description of the Width() function.
- **WithAlpha()** (pcbnew.COLOR4D) - Description of the WithAlpha() function.
- **WithinScope()** (pcbnew.PCB_GROUP) - Description of the WithinScope() function.
- **Write()** (pcbnew.IPC356D_WRITER) - Description of the Write() function.
- **WriteJSONJobFile()** (pcbnew.GERBER_JOBFILE_WRITER) - Description of the WriteJSONJobFile() function.
- **wx_str()** (pcbnew.UTF8) - Description of the wx_str() function.

#### Response Example
N/A
```

--------------------------------

### SetStartX method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TRACK.html

Sets the X coordinate of the track start point.

```python
SetStartX(PCB_TRACK self, int aX)
```

--------------------------------

### Initialize PCB_DIM_CENTER

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIM__CENTER.html

Constructor for creating a new instance of PCB_DIM_CENTER.

```python
__init__(PCB_DIM_CENTER self, BOARD_ITEM aParent) -> PCB_DIM_CENTER
```

--------------------------------

### Class Members Starting with 'k'

Source: https://docs.kicad.org/doxygen-python-9.0/functions_func_k.html

Lists functions, variables, and properties within KiCad's Pcbnew Python scripting API whose names start with the letter 'k'.

```APIDOC
## Class Members Starting with 'k'

### Description
This section details members of classes within the KiCad Pcbnew Python scripting API that begin with the letter 'k'.

### Functions
- **KeepUpright()** : pcbnew.EDA_ANGLE, pcbnew.PCB_TEXT - Keeps the text upright relative to the board.
- **key_iterator()** : pcbnew.MAP_STRING_STRING, pcbnew.netclasses_map, pcbnew.NETCODES_MAP, pcbnew.NETNAMES_MAP, pcbnew.str_utf8_Map - Returns an iterator for the keys of a map-like object.
- **keys()** : pcbnew.MAP_STRING_STRING, pcbnew.netclasses_map, pcbnew.NETCODES_MAP, pcbnew.NETNAMES_MAP, pcbnew.str_utf8_Map - Returns a list of keys from a map-like object.

### Variables
(No variables starting with 'k' are explicitly listed in the provided text.)

### Properties
(No properties starting with 'k' are explicitly listed in the provided text.)
```

--------------------------------

### Constructor: pcbnew.SEG.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SEG.html

Initializes a new SEG object with various parameter configurations.

```APIDOC
## __init__

### Description
Initializes a new SEG object. Multiple overloads are available depending on the input arguments.

### Method
Constructor

### Parameters
#### Path Parameters
- **args** (variable) - Required - Can be empty, coordinates (x1, y1, x2, y2), two VECTOR2I points, two VECTOR2I points and an index, or another SEG object.

### Response
- **SEG** (object) - Returns a new instance of the SEG class.
```

--------------------------------

### PADSTACK.Name()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PADSTACK.html

Gets the name of the PADSTACK.

```APIDOC
## PADSTACK.Name()

### Description
Retrieves the name identifier for this PADSTACK.

### Method
`pcbnew.PADSTACK.Name`

### Parameters
- `_self_` (PADSTACK): The PADSTACK object.

### Response
- `wxString`: The name of the PADSTACK.

### Response Example
```python
# Example usage (conceptual)
name = padstack.Name()
```
```

--------------------------------

### PADSTACK.GetOrientation()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PADSTACK.html

Gets the orientation of the PADSTACK.

```APIDOC
## PADSTACK.GetOrientation()

### Description
Retrieves the current orientation of the PADSTACK.

### Method
`pcbnew.PADSTACK.GetOrientation`

### Parameters
- `_self_` (PADSTACK): The PADSTACK object.

### Response
- `EDA_ANGLE`: The orientation angle.

### Response Example
```python
# Example usage (conceptual)
orientation = padstack.GetOrientation()
```
```

--------------------------------

### CreateLibrary Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__IO__KICAD__SEXPR.html

Creates a new library at the specified path with optional properties.

```python
CreateLibrary(PCB_IO_KICAD_SEXPR self, wxString aLibraryPath, str_utf8_Map aProperties=None)
```

--------------------------------

### pcbnew.ZONE.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1ZONE.html

Initializes a new instance of the ZONE class.

```APIDOC
## __init__(self, parent)
## __init__(self, aZone)

### Description
Constructs a new ZONE object. Can be initialized with a parent container or by copying an existing zone.

### Parameters
- **parent** (BOARD_ITEM_CONTAINER) - Required for first constructor - The parent container for the zone.
- **aZone** (ZONE) - Required for second constructor - An existing zone to copy.
```

--------------------------------

### NETINFO_ITEM.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1NETINFO__ITEM.html

Constructor for the NETINFO_ITEM class.

```APIDOC
## __init__(self, aParent, aNetName=wxEmptyString, aNetCode=-1)

### Description
Initializes a new instance of the NETINFO_ITEM class.

### Parameters
- **aParent** (BOARD) - Required - The parent board object.
- **aNetName** (wxString) - Optional - The name of the net.
- **aNetCode** (int) - Optional - The net code identifier.
```

--------------------------------

### pcbnew.PCB_TABLE.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TABLE.html

Initializes a new instance of the PCB_TABLE class.

```APIDOC
## __init__(self, aParent, aLineWidth)
## __init__(self, aTable)

### Description
Constructs a new PCB_TABLE object. It can be initialized with a parent board item and line width, or as a copy of an existing PCB_TABLE.

### Parameters
- **aParent** (BOARD_ITEM) - Required for first constructor - The parent board item.
- **aLineWidth** (int) - Required for first constructor - The width of the table lines.
- **aTable** (PCB_TABLE) - Required for second constructor - The table to copy.
```

--------------------------------

### GetStartY

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TRACK.html

Retrieves the starting Y coordinate of the track.

```APIDOC
### GetStartY(self)

Returns the starting Y coordinate of the track as an integer.
```

--------------------------------

### GetArcAngleStart

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__SHAPE.html

Retrieves the starting angle of the arc.

```APIDOC
## GetArcAngleStart(self)

### Description
Returns the starting angle of the arc shape as an EDA_ANGLE.

### Signature
GetArcAngleStart(PCB_SHAPE self) -> EDA_ANGLE
```

--------------------------------

### pcbnew.PCB_TARGET.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TARGET.html

Initializes a new instance of the PCB_TARGET class.

```APIDOC
## __init__(self, aParent)
## __init__(self, aParent, aShape, aLayer, aPos, aSize, aWidth)

### Description
Initializes a new PCB_TARGET object. Can be initialized with just a parent BOARD_ITEM or with full geometric and layer properties.

### Parameters
- **aParent** (BOARD_ITEM) - Required - The parent board item.
- **aShape** (int) - Optional - The shape identifier for the target.
- **aLayer** (PCB_LAYER_ID) - Optional - The layer on which the target is placed.
- **aPos** (VECTOR2I) - Optional - The position of the target.
- **aSize** (int) - Optional - The size of the target.
- **aWidth** (int) - Optional - The line width of the target.
```

--------------------------------

### __init__(pad, n, pitch, isVertical, centre)

Source: https://docs.kicad.org/doxygen-python-9.0/classplugins_1_1PadArray_1_1PadLineArray.html

Initializes a new instance of the PadLineArray class to create a single-row grid array of pads.

```APIDOC
## __init__(pad, n, pitch, isVertical, centre)

### Description
Initializes a new single-row grid array of pads.

### Parameters
- **pad** (object) - The prototypical pad to be used in the array.
- **n** (int) - The number of pads in the array.
- **pitch** (int) - The distance between pad centres.
- **isVertical** (bool) - Specifies if the array is vertical or horizontal.
- **centre** (pcbnew.VECTOR2I) - Optional; the centre of the array, defaults to (0, 0).
```

--------------------------------

### GetCrossbarStart

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIM__ALIGNED.html

Retrieves the start coordinate of the crossbar.

```APIDOC
### GetCrossbarStart()

**Description**: Returns the start point of the dimension crossbar.

**Returns**:
- (VECTOR2I) - The start coordinate.
```

--------------------------------

### Initialize KIID_PATH

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1KIID__PATH.html

Constructs a new KIID_PATH instance, optionally from a wxString.

```python
__init__(KIID_PATH self) -> KIID_PATH
__init__(KIID_PATH self, wxString aString) -> KIID_PATH
```

--------------------------------

### GetPlotOnAllLayersSequence

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__PLOT__PARAMS.html

Gets the sequence for plotting on all layers.

```APIDOC
## GetPlotOnAllLayersSequence

### Description
Retrieves the current sequence setting for plotting elements when processing all layers.

### Method
GetPlotOnAllLayersSequence

### Response Example
```json
{
  "plot_on_all_layers_sequence": ["elements", "pads", "tracks"]
}
```
```

--------------------------------

### SetupRenderCache

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1EDA__TEXT.html

Sets up the render cache for the text element.

```APIDOC
## SetupRenderCache()

### Description
Sets up the render cache for the text element.

### Method
POST

### Endpoint
/pcbnew/EDA_TEXT/SetupRenderCache

### Parameters
#### Path Parameters
- **_self_** (EDA_TEXT) - Required - The text element instance.
- **aResolvedText** (wxString) - Required - The resolved text string.
- **aFont** (KIFONT::FONT const *) - Required - Pointer to the font structure.
- **aAngle** (EDA_ANGLE) - Required - The text angle.
- **aOffset** (VECTOR2I) - Required - The offset for rendering.

### Request Example
```json
{
  "_self_": "<EDA_TEXT_instance>",
  "aResolvedText": "Rendered Text",
  "aFont": "<KIFONT::FONT_pointer>",
  "aAngle": "<EDA_ANGLE_value>",
  "aOffset": {"x": 0, "y": 0}
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Initialize NETINFO_ITEM

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1NETINFO__ITEM.html

Constructor for creating a new NETINFO_ITEM instance with an optional parent board, network name, and network code.

```python
__init__(NETINFO_ITEM self, BOARD aParent, wxString aNetName=wxEmptyString, int aNetCode=-1) -> NETINFO_ITEM
```

--------------------------------

### GetAutoScale

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__PLOT__PARAMS.html

Gets the current setting for auto-scaling.

```APIDOC
## GetAutoScale

### Description
Retrieves the current setting that indicates whether auto-scaling is enabled.

### Method
GetAutoScale

### Response Example
```json
{
  "auto_scale": true
}
```
```

--------------------------------

### GetPlotMode

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__PLOT__PARAMS.html

Gets the current plotting mode.

```APIDOC
## GetPlotMode

### Description
Retrieves the current setting for the overall plot mode.

### Method
GetPlotMode

### Response Example
```json
{
  "plot_mode": "gerber"
}
```
```

--------------------------------

### Initialize PCB_TABLE

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TABLE.html

Constructs a new PCB_TABLE instance, either by specifying a parent and line width or by copying an existing table.

```python
__init__(PCB_TABLE self, BOARD_ITEM aParent, int aLineWidth) -> PCB_TABLE
__init__(PCB_TABLE self, PCB_TABLE aTable) -> PCB_TABLE
```

--------------------------------

### PADSTACK.Mode()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PADSTACK.html

Gets the operational mode of the PADSTACK.

```APIDOC
## PADSTACK.Mode()

### Description
Returns the current operational mode of the PADSTACK.

### Method
`pcbnew.PADSTACK.Mode`

### Parameters
- `_self_` (PADSTACK): The PADSTACK object.

### Response
- `PADSTACK::MODE`: The operational mode of the PADSTACK.

### Response Example
```python
# Example usage (conceptual)
mode = padstack.Mode()
```
```

--------------------------------

### BuildNetTieCache

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1FOOTPRINT.html

Builds the net tie cache for the footprint.

```python
BuildNetTieCache(FOOTPRINT self)
```

--------------------------------

### pcbnew.PRETTIFIED_FILE_OUTPUTFORMATTER.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PRETTIFIED__FILE__OUTPUTFORMATTER.html

Initializes a new instance of the PRETTIFIED_FILE_OUTPUTFORMATTER class.

```APIDOC
## __init__(self, aFileName, aMode='wt', aQuoteChar='"')

### Description
Initializes the formatter with a specified file name, mode, and quote character.

### Parameters
- **aFileName** (wxString) - Required - The path to the file to be written.
- **aMode** (wxChar const *) - Optional - The file access mode (default is 'wt').
- **aQuoteChar** (char) - Optional - The character used for quoting (default is '"').
```

--------------------------------

### PADSTACK.EndLayer()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PADSTACK.html

Gets the end layer of a PADSTACK.

```APIDOC
## PADSTACK.EndLayer()

### Description
Returns the final layer ID in the sequence of layers for this PADSTACK.

### Method
`pcbnew.PADSTACK.EndLayer`

### Parameters
- `_self_` (PADSTACK): The PADSTACK object.

### Response
- `PCB_LAYER_ID`: The end layer ID.

### Response Example
```python
# Example usage (conceptual)
end_layer = padstack.EndLayer()
```
```

--------------------------------

### PADSTACK.DrillShape()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PADSTACK.html

Gets the shape of the drill for a PADSTACK.

```APIDOC
## PADSTACK.DrillShape()

### Description
Retrieves the shape of the drill used in the PADSTACK.

### Method
`pcbnew.PADSTACK.DrillShape`

### Parameters
- `_self_` (PADSTACK): The PADSTACK object.

### Response
- `PAD_DRILL_SHAPE`: The shape of the drill.

### Response Example
```python
# Example usage (conceptual)
drill_shape = padstack.DrillShape()
```
```

--------------------------------

### EXCELLON_WRITER.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1EXCELLON__WRITER.html

Initializes a new instance of the EXCELLON_WRITER class.

```APIDOC
### Constructor
`__init__(self, aPcb)`

Initializes the writer with the provided PCB object.
```

--------------------------------

### KiCad Pcbnew Python Scripting - Functions starting with 'V'

Source: https://docs.kicad.org/doxygen-python-9.0/functions_func_v.html

This section lists functions within the KiCad Pcbnew Python scripting API that start with the letter 'V'. It includes function names, their return types, and the classes or modules they belong to.

```APIDOC
## Functions starting with 'V'

### Description
Lists functions within the KiCad Pcbnew Python scripting API that start with the letter 'V'.

### Method
N/A (This is a reference list, not an API endpoint)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
- **Function Name** (string) - The name of the function.
- **Return Type** (string) - The data type returned by the function.
- **Belongs To** (string) - The class or module the function is associated with.

#### Response Example
```json
[
  {
    "Function Name": "ValidateHyperlink()",
    "Return Type": "pcbnew.EDA_TEXT",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "Value()",
    "Return Type": "pcbnew.FOOTPRINT",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "value()",
    "Return Type": "pcbnew.FootprintWizardParameter",
    "Belongs To": "pcbnew.FootprintWizard"
  },
  {
    "Function Name": "Value()",
    "Return Type": "plugins.FootprintWizardBase.FootprintWizardDrawingAids",
    "Belongs To": "plugins.FootprintWizardBase"
  },
  {
    "Function Name": "value_iterator()",
    "Return Type": "pcbnew.MAP_STRING_STRING, pcbnew.netclasses_map, pcbnew.NETCODES_MAP, pcbnew.NETNAMES_MAP, pcbnew.str_utf8_Map",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "ValueFromString()",
    "Return Type": "pcbnew.UNITS_PROVIDER",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "values()",
    "Return Type": "pcbnew.FootprintWizardPlugin, pcbnew.MAP_STRING_STRING, pcbnew.netclasses_map, pcbnew.NETCODES_MAP, pcbnew.NETNAMES_MAP, pcbnew.str_utf8_Map",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "VertexCount()",
    "Return Type": "pcbnew.SHAPE_POLY_SET",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "Vertices()",
    "Return Type": "pcbnew.SHAPE_SIMPLE",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "ViewBBox()",
    "Return Type": "pcbnew.EDA_ITEM",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "ViewGetLayers()",
    "Return Type": "pcbnew.EDA_ITEM",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "ViewGetLOD()",
    "Return Type": "pcbnew.FOOTPRINT, pcbnew.PAD, pcbnew.PCB_FIELD, pcbnew.PCB_GROUP, pcbnew.PCB_REFERENCE_IMAGE, pcbnew.PCB_SHAPE, pcbnew.PCB_TEXT, pcbnew.PCB_TEXTBOX, pcbnew.PCB_TRACK, pcbnew.PCB_VIA, pcbnew.ZONE",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "Visit()",
    "Return Type": "pcbnew.EDA_ITEM",
    "Belongs To": "pcbnew"
  },
  {
    "Function Name": "VLine()",
    "Return Type": "plugins.FootprintWizardBase.FootprintWizardDrawingAids",
    "Belongs To": "plugins.FootprintWizardBase"
  }
]
```
```

--------------------------------

### EXCELLON_WRITER.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1EXCELLON__WRITER.html

Initializes a new instance of the EXCELLON_WRITER class.

```APIDOC
### Constructor
`__init__(self, BOARD aPcb)`

Creates an EXCELLON_WRITER instance for the specified board.
```

--------------------------------

### pcbnew.PCB_VIA.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__VIA.html

Initializes a new instance of the PCB_VIA class. It can be initialized with a parent board item or as a copy of an existing PCB_VIA object.

```APIDOC
## Constructor: pcbnew.PCB_VIA.__init__

### Description
Creates a new PCB_VIA object. This constructor supports initializing a via with a parent BOARD_ITEM or creating a copy of an existing PCB_VIA.

### Signature
- __init__(self, BOARD_ITEM aParent) -> PCB_VIA
- __init__(self, PCB_VIA aOther) -> PCB_VIA

### Parameters
- **aParent** (BOARD_ITEM) - Optional - The parent board item to associate with the new via.
- **aOther** (PCB_VIA) - Optional - An existing PCB_VIA instance to copy.
```

--------------------------------

### Initialize VECTOR3D

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1VECTOR3D.html

Constructors for creating a new VECTOR3D instance.

```python
__init__(VECTOR3D self) -> VECTOR3D
__init__(VECTOR3D self, double x, double y, double z) -> VECTOR3D
```

--------------------------------

### GetStartAngle Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__ARC.html

Retrieves the starting angle of the arc.

```python
GetStartAngle(SHAPE_ARC self) -> EDA_ANGLE
```

--------------------------------

### KIID_PATH.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1KIID__PATH.html

Initializes a new instance of the KIID_PATH class.

```APIDOC
## __init__(self, *args)

### Description
Initializes a new KIID_PATH object. Can be called with no arguments or with a wxString to initialize from a string representation.

### Signature
`__init__(KIID_PATH self) -> KIID_PATH`
`__init__(KIID_PATH self, wxString aString) -> KIID_PATH`
```

--------------------------------

### GetNetSettings()

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1CONNECTIVITY__DATA.html

Retrieves the net settings.

```APIDOC
## GetNetSettings()

### Description
Retrieves the net settings.

### Method
GET

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **return_value** (NET_SETTINGS) - The NET_SETTINGS object.

#### Response Example
```json
{
  "return_value": "<NET_SETTINGS_OBJECT>"
}
```
```

--------------------------------

### PADS begin Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PADS.html

Returns an iterator to the beginning of the PADS collection. Use for manual iteration or algorithms.

```python
begin(PADS self) -> std::deque< PAD * >::iterator
```

--------------------------------

### Initialize VECTOR_FP_3DMODEL

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1VECTOR__FP__3DMODEL.html

Constructor signatures for creating instances of the VECTOR_FP_3DMODEL class.

```python
__init__(VECTOR_FP_3DMODEL self) -> VECTOR_FP_3DMODEL
    __init__(VECTOR_FP_3DMODEL self, VECTOR_FP_3DMODEL other) -> VECTOR_FP_3DMODEL
    __init__(VECTOR_FP_3DMODEL self, std::vector< FP_3DMODEL >::size_type size) -> VECTOR_FP_3DMODEL
    __init__(VECTOR_FP_3DMODEL self, std::vector< FP_3DMODEL >::size_type size, FP_3DMODEL value) -> VECTOR_FP_3DMODEL
```

--------------------------------

### GetStartY Method

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__TRACK.html

Retrieves the starting Y coordinate of the track.

```python
GetStartY(PCB_TRACK self) -> int
```

--------------------------------

### pcbnew.LSEQ.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1LSEQ.html

Initializes a new instance of the LSEQ class, optionally with a list of PCB layer identifiers.

```APIDOC
## Constructor: pcbnew.LSEQ.__init__

### Description
Initializes a new LSEQ object. Can be called without arguments or with an initializer list of PCB_LAYER_ID values.

### Signature
- `__init__(self)`
- `__init__(self, aLayers: std::initializer_list<PCB_LAYER_ID>)
```

--------------------------------

### SetStartEnd

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIM__CENTER.html

Sets the start and end points for the dimension.

```APIDOC
### SetStartEnd

**Signature:** `SetStartEnd(self, start, end)`

Defines the start and end coordinates for the dimension object.
```

--------------------------------

### Constructor Definition

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1INPUTSTREAM__LINE__READER.html

Signature for initializing the INPUTSTREAM_LINE_READER with a wxInputStream and a source string.

```python
__init__(INPUTSTREAM_LINE_READER self, wxInputStream * aStream, wxString aSource) -> INPUTSTREAM_LINE_READER
```

--------------------------------

### Initialize PLACE_FILE_EXPORTER

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PLACE__FILE__EXPORTER.html

Constructor for the PLACE_FILE_EXPORTER class. Requires a BOARD object and various boolean flags to configure export settings.

```python
def __init__(self, aBoard, aUnitsMM, aOnlySMD, aExcludeAllTH, aExcludeDNP, aTopSide, aBottomSide, aFormatCSV, aUseAuxOrigin, aNegateBottomX) -> PLACE_FILE_EXPORTER:
```

--------------------------------

### SetupRenderCache

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1EDA__TEXT.html

Configures the render cache for the text object.

```python
SetupRenderCache(EDA_TEXT self, wxString aResolvedText, KIFONT::FONT const * aFont, EDA_ANGLE aAngle, VECTOR2I aOffset)
```

--------------------------------

### Get Tracks

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1BOARD.html

Retrieves the tracks associated with the board.

```python
    Tracks(BOARD self) -> TRACKS
    Tracks(BOARD self) -> TRACKS
```

--------------------------------

### Get Groups

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1BOARD.html

Retrieves the groups associated with the board.

```python
Groups(BOARD self) -> GROUPS
```

--------------------------------

### Constructor __init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PADS__VEC.html

Initializes a new instance of the PADS_VEC class.

```APIDOC
## __init__

### Description
Initializes a new PADS_VEC object. Can be called with no arguments, another PADS_VEC, a size, or a size and an initial value.

### Parameters
#### Path Parameters
- **args** (variable) - Optional - Initialization arguments including size or existing PADS_VEC instance.

### Request Example
PADS_VEC()
```

--------------------------------

### PCB_DIM_ALIGNED.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1PCB__DIM__ALIGNED.html

Initializes a new instance of the PCB_DIM_ALIGNED class.

```APIDOC
### Constructor
`__init__(self, aParent, aType=PCB_DIM_ALIGNED_T)`

Creates a new aligned dimension object associated with a parent board item.
```

--------------------------------

### Get Outline

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__RECT.html

Returns the outline of the rectangle as a SHAPE_LINE_CHAIN.

```python
Outline(SHAPE_RECT self) -> SHAPE_LINE_CHAIN
```

--------------------------------

### Get Rectangle Width

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1SHAPE__RECT.html

Returns the width of the rectangle.

```python
GetWidth(SHAPE_RECT self) -> int
```

--------------------------------

### PadCustomArray.__init__

Source: https://docs.kicad.org/doxygen-python-9.0/classplugins_1_1PadArray_1_1PadCustomArray.html

Initializes a new instance of the PadCustomArray class with a prototype pad and position data.

```APIDOC
## __init__(self, pad, array)

### Description
Initializes the PadCustomArray with a prototypical pad and an array of position data.

### Parameters
- **pad** (object) - The prototypical pad to be used for the array.
- **array** (list) - The position data array containing [x,y] coordinates.
```

--------------------------------

### Initialize wxPoint

Source: https://docs.kicad.org/doxygen-python-9.0/classpcbnew_1_1wxPoint.html

Constructs a new wxPoint object. Can be initialized with integers or doubles.

```python
__init__(wxPoint self, int xx, int yy) -> wxPoint
__init__(wxPoint self, double xx, double yy) -> wxPoint
```
Tokens:
Raw