package kiapi.board.types

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

message AlignedDimensionAttributes

board_types.proto:690

An aligned dimension is drawn parallel to the line segment between the start and end points

Used in: Dimension

message Arc

board_types.proto:160

Represents an arc track (not a PCB_SHAPE in arc shape) Arc tracks in KiCad store start, midpoint, and end. All other values (center point, angles, etc) are inferred.

message BoardGraphicShape

board_types.proto:450

Used in: PadStackLayer

enum BoardLayer

board_types.proto:27

Used in: BoardStackupLayer, commands.BoardLayerResponse, commands.BoardLayers, commands.GetPadShapeAsPolygon, commands.SetActiveLayer, commands.SetVisibleLayers, Arc, BoardGraphicShape, BoardText, BoardTextBox, Dimension, DrillProperties, Footprint, FootprintInstance, PadStack, PadStackLayer, Track, Zone, ZoneFilledPolygons, ZoneLayerProperties

message BoardText

board_types.proto:460

A board-specific text object, existing on a board layer

Used in: Field

message BoardTextBox

board_types.proto:470

A board-specific textbox, existing on a board layer

message CenterDimensionAttributes

board_types.proto:748

Used in: Dimension

message ChamferedRectCorners

board_types.proto:215

Which corners are chamfered in a PSS_CHAMFEREDRECT

Used in: PadStackLayer

message CopperZoneSettings

board_types.proto:586

Used in: Zone

enum CustomPadShapeZoneFillStrategy

board_types.proto:492

message Dimension

board_types.proto:805

A dimension in KiCad is a special type of text object. To know the visual appearance of the dimension as rendered by KiCad, use GetTextAsShapes

enum DimensionArrowDirection

board_types.proto:764

Used in: Dimension

enum DimensionPrecision

board_types.proto:771

Used in: Dimension

enum DimensionTextBorderStyle

board_types.proto:732

The style of the optional frame applied to dimension text

Used in: LeaderDimensionAttributes

enum DimensionTextPosition

board_types.proto:786

Used in: Dimension

enum DimensionUnit

board_types.proto:794

Used in: Dimension

enum DimensionUnitFormat

board_types.proto:756

Used in: Dimension

message DrillProperties

board_types.proto:367

Used in: PadStack

enum DrillShape

board_types.proto:343

Used in: DrillProperties

message Field

board_types.proto:852

Used in: Footprint, FootprintInstance

message FieldId

board_types.proto:847

Used in: Field

message Footprint

board_types.proto:927

A footprint definition (i.e. what would be in a library)

Used in: FootprintInstance

message Footprint3DModel

board_types.proto:895

message FootprintAttributes

board_types.proto:870

Used in: Footprint, FootprintInstance

message FootprintDesignRuleOverrides

board_types.proto:887

Used in: Footprint, FootprintInstance

message FootprintInstance

board_types.proto:948

An instance of a footprint on a board

enum FootprintMountingStyle

board_types.proto:862

Used in: FootprintAttributes

message Group

board_types.proto:842

TODO

(message has no fields)

message HatchFillSettings

board_types.proto:571

Used in: CopperZoneSettings

enum IslandRemovalMode

board_types.proto:540

Used in: CopperZoneSettings

message JumperGroup

board_types.proto:913

Used in: JumperSettings

message JumperSettings

board_types.proto:918

Used in: Footprint

message LeaderDimensionAttributes

board_types.proto:741

Used in: Dimension

message Net

board_types.proto:136

Describes a copper item's net

Used in: commands.GetNetClassForNets, commands.NetsResponse, Arc, BoardGraphicShape, CopperZoneSettings, Pad, Track, Via

message NetCode

board_types.proto:130

Used in: commands.GetItemsByNet, Net

message NetTieDefinition

board_types.proto:882

Used in: Footprint

message OrthogonalDimensionAttributes

board_types.proto:703

An orthogonal dimension is drawn parallel to the X or Y axis of the coordinate system

Used in: Dimension

message Pad

board_types.proto:506

message PadStack

board_types.proto:387

A pad stack definition for a multilayer pad or via.

Used in: Pad, Via, common.project.NetClassBoardSettings

message PadStackLayer

board_types.proto:258

The defintion of a padstack on a single layer

Used in: PadStack

message PadStackOuterLayer

board_types.proto:328

Properties for the outer technical layers of a padstack on the top or bottom of the stack

Used in: PadStack

enum PadStackShape

board_types.proto:202

The shape of a pad on a given layer

Used in: PadStackLayer

enum PadStackType

board_types.proto:173

What copper layer shape mode the padstack uses

Used in: PadStack

enum PadType

board_types.proto:483

NOTE: There has been some discussion about what to do with pad attributes and properties. This may be considered somewhat unstable until we decide what to do with the KiCad side. It is not clear what the set of mutually-exclusive pad types will be at the end of the day, versus what will be non-exclusive attributes/properties. For now, this maps to PAD_ATTRIB in KiCad.

Used in: Pad

enum PlacementRuleSourceType

board_types.proto:607

Used in: RuleAreaSettings

message RadialDimensionAttributes

board_types.proto:718

Used in: Dimension

message ReferenceImage

board_types.proto:837

TODO

(message has no fields)

message RuleAreaSettings

board_types.proto:615

Used in: Zone

enum SolderMaskMode

board_types.proto:295

Used in: PadStackOuterLayer

message SolderMaskOverrides

board_types.proto:242

Used in: FootprintDesignRuleOverrides, PadStackOuterLayer

enum SolderPasteMode

board_types.proto:319

Used in: PadStackOuterLayer

message SolderPasteOverrides

board_types.proto:248

Used in: FootprintDesignRuleOverrides, PadStackOuterLayer

message TeardropSettings

board_types.proto:581

Used in: CopperZoneSettings

enum TeardropType

board_types.proto:531

Used in: TeardropSettings

message ThermalSpokeSettings

board_types.proto:499

Used in: ZoneConnectionSettings

message Track

board_types.proto:146

Represents a track segment on a board

enum UnconnectedLayerRemoval

board_types.proto:187

Used in: PadStack

message Via

board_types.proto:432

Represents a via

enum ViaCoveringMode

board_types.proto:303

Used in: PadStackOuterLayer

enum ViaDrillCappingMode

board_types.proto:351

Used in: DrillProperties

enum ViaDrillFillingMode

board_types.proto:359

Used in: DrillProperties

enum ViaPluggingMode

board_types.proto:311

Used in: PadStackOuterLayer

enum ViaType

board_types.proto:416

Used in: Via

message Zone

board_types.proto:659

message ZoneBorderSettings

board_types.proto:637

Used in: Zone

enum ZoneBorderStyle

board_types.proto:628

Used in: ZoneBorderSettings

message ZoneConnectionSettings

board_types.proto:235

Controls for how copper zones connect to a pad

Used in: CopperZoneSettings, PadStack, PadStackLayer

enum ZoneConnectionStyle

board_types.proto:224

enum class ZONE_CONNECTION

Used in: FootprintDesignRuleOverrides, ZoneConnectionSettings

enum ZoneFillMode

board_types.proto:548

Used in: CopperZoneSettings

message ZoneFilledPolygons

board_types.proto:644

The set of filled polygons of a zone on a single board layer

Used in: Zone

enum ZoneHatchFillBorderMode

board_types.proto:564

Used in: HatchFillSettings

enum ZoneHatchSmoothing

board_types.proto:555

message ZoneLayerProperties

board_types.proto:651

Used in: Zone

enum ZoneType

board_types.proto:522

Used in: Zone