KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Properties | List of all members
pcbnew.PCB_BARCODE Class Reference
Inheritance diagram for pcbnew.PCB_BARCODE:
Inheritance graph
[legend]

Public Member Functions

 __init__ (self, *args)
 
 SetTextSize (self, aTextSize)
 
 GetTextSize (self)
 
 Serialize (self, aContainer)
 
 Deserialize (self, aContainer)
 
 GetWidth (self)
 
 SetWidth (self, aWidth)
 
 GetHeight (self)
 
 SetHeight (self, aHeight)
 
 GetMargin (self)
 
 SetMargin (self, aMargin)
 
 GetPolyShape (self)
 
 GetSymbolPoly (self)
 
 GetTextPoly (self)
 
 TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc=ERROR_INSIDE, ignoreLineWidth=False)
 
 GetEffectiveShape (self, *args)
 
 GetBoundingHull (self, aBuffer, aLayer, aClearance, aMaxError, aErrorLoc=ERROR_INSIDE)
 
 ComputeBarcode (self)
 
 ComputeTextPoly (self)
 
 AssembleBarcode (self)
 
 SetText (self, aText)
 
 GetText (self)
 
 GetShownText (self)
 
 Text (self, *args)
 
 SetRect (self, aTopLeft, aBotRight)
 
 HitTest (self, *args)
 
 GetClass (self)
 
 swapData (self, aImage)
 
 __eq__ (self, *args)
 
 GetKind (self)
 
 SetKind (self, aKind)
 
 SetBarcodeKind (self, aKind)
 
 KeepSquare (self)
 
 SetErrorCorrection (self, aErrorCorrection)
 
 GetErrorCorrection (self)
 
 SetBarcodeErrorCorrection (self, aErrorCorrection)
 
 SetBarcodeText (self, aText)
 
 SetShowText (self, aShow)
 
 GetShowText (self)
 
 SetBarcodeWidth (self, aWidth)
 
 SetBarcodeHeight (self, aHeight)
 
 GetAngle (self)
 
 GetOrientation (self)
 
 SetOrientation (self, aDegrees)
 
 GetMarginX (self)
 
 GetMarginY (self)
 
 SetMarginX (self, aX)
 
 SetMarginY (self, aY)
 
 GetLastError (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
 __init__ (self, *args, **kwargs)
 
 CopyFrom (self, aOther)
 
 IsGroupableType (self)
 
 GetX (self)
 
 GetY (self)
 
 GetCenter (self)
 
 SetX (self, aX)
 
 SetY (self, aY)
 
 IsConnected (self)
 
 Similarity (self, aItem)
 
 __eq__ (self, aItem)
 
 IsOnCopperLayer (self)
 
 HasHole (self)
 
 HasDrilledHole (self)
 
 IsTented (self, aLayer)
 
 GetEffectiveHoleShape (self)
 
 RunOnChildren (self, aFunction, aMode)
 
 GetParent (self)
 
 GetParentFootprint (self)
 
 GetFPRelativePosition (self)
 
 SetFPRelativePosition (self, aPos)
 
 HasLineStroke (self)
 
 GetStroke (self)
 
 SetStroke (self, aStroke)
 
 GetFontMetrics (self)
 
 GetLayer (self)
 
 BoardLayerCount (self)
 
 BoardCopperLayerCount (self)
 
 BoardLayerSet (self)
 
 GetLayerSet (self)
 
 SetLayerSet (self, aLayers)
 
 IsSideSpecific (self)
 
 SetLayer (self, aLayer)
 
 Duplicate (self, addToParentGroup, aCommit=None)
 
 SwapItemData (self, aImage)
 
 IsOnLayer (self, aLayer)
 
 IsKnockout (self)
 
 SetIsKnockout (self, aKnockout)
 
 GetMaxError (self)
 
 StyleFromSettings (self, settings, aCheckSide)
 
 DeleteStructure (self)
 
 Move (self, aMoveVector)
 
 Rotate (self, aRotCentre, aAngle)
 
 Flip (self, aCentre, aFlipDirection)
 
 Mirror (self, aCentre, aFlipDirection)
 
 Normalize (self)
 
 NormalizeForCompare (self)
 
 GetBoard (self, *args)
 
 GetParentAsString (self)
 
 GetLayerName (self)
 
 TransformShapeToPolySet (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, aRenderSettings=None)
 
 LayerMaskDescribe (self)
 
 Cast (self)
 
 Duplicate (self)
 
 SetPos (self, p)
 
 SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
 __init__ (self, *args, **kwargs)
 
 Type (self)
 
 SetParent (self, aParent)
 
 SetParentGroup (self, aGroup)
 
 GetParentGroup (self)
 
 GetParentGroupId (self)
 
 IsLocked (self)
 
 SetLocked (self, aLocked)
 
 IsModified (self)
 
 IsNew (self)
 
 IsMoving (self)
 
 IsSelected (self)
 
 IsEntered (self)
 
 IsBrightened (self)
 
 IsRollover (self)
 
 GetRolloverPos (self)
 
 SetIsRollover (self, aIsRollover, aMousePos)
 
 SetSelected (self)
 
 SetBrightened (self)
 
 ClearSelected (self)
 
 ClearBrightened (self)
 
 SetModified (self)
 
 SetFlags (self, aMask)
 
 XorFlags (self, aMask)
 
 ClearFlags (self, *args)
 
 GetFlags (self)
 
 HasFlag (self, aFlag)
 
 GetEditFlags (self)
 
 ClearEditFlags (self)
 
 GetTempFlags (self)
 
 ClearTempFlags (self)
 
 RenderAsBitmap (self, aWorldScale)
 
 SetIsShownAsBitmap (self, aBitmap)
 
 IsShownAsBitmap (self)
 
 IsType (self, aScanTypes)
 
 SetForceVisible (self, aEnable)
 
 IsForceVisible (self)
 
 GetMsgPanelInfo (self, aFrame, aList)
 
 GetFriendlyName (self)
 
 GetBoundingBox (self)
 
 GetPosition (self)
 
 SetPosition (self, aPos)
 
 GetFocusPosition (self)
 
 GetSortPosition (self)
 
 Clone (self)
 
 Visit (self, inspector, testData, aScanTypes)
 
 GetTypeDesc (self)
 
 GetItemDescription (self, aUnitsProvider, aFull)
 
 DisambiguateItemDescription (self, aUnitsProvider, aFull)
 
 GetMenuImage (self)
 
 Matches (self, aSearchData, aAuxData)
 
 Replace (self, *args)
 
 IsReplaceable (self)
 
 __lt__ (self, aItem)
 
 ViewBBox (self)
 
 ViewGetLayers (self)
 
 GetEmbeddedFiles (self)
 
 GetEmbeddedFonts (self)
 
 PyGetClass (self)
 

Static Public Member Functions

 ClassOf (aItem)
 
 Compare (aBarcode, aOther)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
 Sort (aLeft, aRight)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.EDA_ITEM
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 m_Uuid = property(_pcbnew.EDA_ITEM_m_Uuid_get, doc=)
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 DRC = _pcbnew.BOARD_ITEM_DRC
 
 INSTANCE_TO_INSTANCE = _pcbnew.BOARD_ITEM_INSTANCE_TO_INSTANCE
 

Detailed Description

Proxy of C++ PCB_BARCODE class.

Definition at line 10856 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.PCB_BARCODE.__init__ ( self,
* args ) 
    __init__(PCB_BARCODE self, BOARD_ITEM aParent) -> PCB_BARCODE
    __init__(PCB_BARCODE self, PCB_BARCODE aOther) -> PCB_BARCODE

Definition at line 10862 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

pcbnew.PCB_BARCODE.__eq__ ( self,
* args ) 
    __eq__(PCB_BARCODE self, BOARD_ITEM aItem) -> bool
    __eq__(PCB_BARCODE self, PCB_BARCODE aBarcode) -> bool

Definition at line 10994 of file pcbnew.py.

◆ AssembleBarcode()

pcbnew.PCB_BARCODE.AssembleBarcode ( self) 
AssembleBarcode(PCB_BARCODE self)

Definition at line 10947 of file pcbnew.py.

◆ ClassOf()

pcbnew.PCB_BARCODE.ClassOf ( aItem)
static 
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 10871 of file pcbnew.py.

◆ Compare()

pcbnew.PCB_BARCODE.Compare ( aBarcode,
aOther )
static 
Compare(PCB_BARCODE aBarcode, PCB_BARCODE aOther) -> int

Definition at line 10990 of file pcbnew.py.

◆ ComputeBarcode()

pcbnew.PCB_BARCODE.ComputeBarcode ( self) 
ComputeBarcode(PCB_BARCODE self)

Definition at line 10939 of file pcbnew.py.

◆ ComputeTextPoly()

pcbnew.PCB_BARCODE.ComputeTextPoly ( self) 
ComputeTextPoly(PCB_BARCODE self)

Definition at line 10943 of file pcbnew.py.

◆ Deserialize()

pcbnew.PCB_BARCODE.Deserialize ( self,
aContainer ) 
Deserialize(PCB_BARCODE self, google::protobuf::Any const & aContainer) -> bool

Definition at line 10887 of file pcbnew.py.

◆ GetAngle()

pcbnew.PCB_BARCODE.GetAngle ( self) 
GetAngle(PCB_BARCODE self) -> EDA_ANGLE

Definition at line 11049 of file pcbnew.py.

◆ GetBoundingHull()

pcbnew.PCB_BARCODE.GetBoundingHull ( self,
aBuffer,
aLayer,
aClearance,
aMaxError,
aErrorLoc = ERROR_INSIDE ) 
GetBoundingHull(PCB_BARCODE self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE)

Definition at line 10935 of file pcbnew.py.

◆ GetClass()

pcbnew.PCB_BARCODE.GetClass ( self) 
GetClass(PCB_BARCODE self) -> wxString

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 10981 of file pcbnew.py.

◆ GetEffectiveShape()

pcbnew.PCB_BARCODE.GetEffectiveShape ( self,
* args ) 
GetEffectiveShape(PCB_BARCODE self, PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=DEFAULT) -> std::shared_ptr< SHAPE >

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 10931 of file pcbnew.py.

◆ GetErrorCorrection()

pcbnew.PCB_BARCODE.GetErrorCorrection ( self) 
GetErrorCorrection(PCB_BARCODE self) -> BARCODE_ECC_T

Definition at line 11021 of file pcbnew.py.

◆ GetHeight()

pcbnew.PCB_BARCODE.GetHeight ( self) 
GetHeight(PCB_BARCODE self) -> int

Definition at line 10899 of file pcbnew.py.

◆ GetKind()

pcbnew.PCB_BARCODE.GetKind ( self) 
GetKind(PCB_BARCODE self) -> BARCODE_T

Definition at line 11001 of file pcbnew.py.

◆ GetLastError()

pcbnew.PCB_BARCODE.GetLastError ( self) 
GetLastError(PCB_BARCODE self) -> wxString

Definition at line 11077 of file pcbnew.py.

◆ GetMargin()

pcbnew.PCB_BARCODE.GetMargin ( self) 
GetMargin(PCB_BARCODE self) -> VECTOR2I

Definition at line 10907 of file pcbnew.py.

◆ GetMarginX()

pcbnew.PCB_BARCODE.GetMarginX ( self) 
GetMarginX(PCB_BARCODE self) -> int

Definition at line 11061 of file pcbnew.py.

◆ GetMarginY()

pcbnew.PCB_BARCODE.GetMarginY ( self) 
GetMarginY(PCB_BARCODE self) -> int

Definition at line 11065 of file pcbnew.py.

◆ GetOrientation()

pcbnew.PCB_BARCODE.GetOrientation ( self) 
GetOrientation(PCB_BARCODE self) -> double

Definition at line 11053 of file pcbnew.py.

◆ GetPolyShape()

pcbnew.PCB_BARCODE.GetPolyShape ( self) 
GetPolyShape(PCB_BARCODE self) -> SHAPE_POLY_SET

Definition at line 10915 of file pcbnew.py.

◆ GetShownText()

pcbnew.PCB_BARCODE.GetShownText ( self) 
GetShownText(PCB_BARCODE self) -> wxString

Definition at line 10959 of file pcbnew.py.

◆ GetShowText()

pcbnew.PCB_BARCODE.GetShowText ( self) 
GetShowText(PCB_BARCODE self) -> bool

Definition at line 11037 of file pcbnew.py.

◆ GetSymbolPoly()

pcbnew.PCB_BARCODE.GetSymbolPoly ( self) 
GetSymbolPoly(PCB_BARCODE self) -> SHAPE_POLY_SET

Definition at line 10919 of file pcbnew.py.

◆ GetText()

pcbnew.PCB_BARCODE.GetText ( self) 
GetText(PCB_BARCODE self) -> wxString

Definition at line 10955 of file pcbnew.py.

◆ GetTextPoly()

pcbnew.PCB_BARCODE.GetTextPoly ( self) 
GetTextPoly(PCB_BARCODE self) -> SHAPE_POLY_SET

Definition at line 10923 of file pcbnew.py.

◆ GetTextSize()

pcbnew.PCB_BARCODE.GetTextSize ( self) 
GetTextSize(PCB_BARCODE self) -> int

Definition at line 10879 of file pcbnew.py.

◆ GetWidth()

pcbnew.PCB_BARCODE.GetWidth ( self) 
GetWidth(PCB_BARCODE self) -> int

Definition at line 10891 of file pcbnew.py.

◆ HitTest()

pcbnew.PCB_BARCODE.HitTest ( self,
* args ) 
    HitTest(PCB_BARCODE self, VECTOR2I aPosition, int aAccuracy) -> bool
    HitTest(PCB_BARCODE self, BOX2I aRect, bool aContained, int aAccuracy=0) -> bool

Reimplemented from pcbnew.EDA_ITEM.

Definition at line 10974 of file pcbnew.py.

◆ KeepSquare()

pcbnew.PCB_BARCODE.KeepSquare ( self) 
KeepSquare(PCB_BARCODE self) -> bool

Definition at line 11013 of file pcbnew.py.

◆ Serialize()

pcbnew.PCB_BARCODE.Serialize ( self,
aContainer ) 
Serialize(PCB_BARCODE self, google::protobuf::Any & aContainer)

Definition at line 10883 of file pcbnew.py.

◆ SetBarcodeErrorCorrection()

pcbnew.PCB_BARCODE.SetBarcodeErrorCorrection ( self,
aErrorCorrection ) 
SetBarcodeErrorCorrection(PCB_BARCODE self, BARCODE_ECC_T aErrorCorrection)

Definition at line 11025 of file pcbnew.py.

◆ SetBarcodeHeight()

pcbnew.PCB_BARCODE.SetBarcodeHeight ( self,
aHeight ) 
SetBarcodeHeight(PCB_BARCODE self, int aHeight)

Definition at line 11045 of file pcbnew.py.

◆ SetBarcodeKind()

pcbnew.PCB_BARCODE.SetBarcodeKind ( self,
aKind ) 
SetBarcodeKind(PCB_BARCODE self, BARCODE_T aKind)

Definition at line 11009 of file pcbnew.py.

◆ SetBarcodeText()

pcbnew.PCB_BARCODE.SetBarcodeText ( self,
aText ) 
SetBarcodeText(PCB_BARCODE self, wxString aText)

Definition at line 11029 of file pcbnew.py.

◆ SetBarcodeWidth()

pcbnew.PCB_BARCODE.SetBarcodeWidth ( self,
aWidth ) 
SetBarcodeWidth(PCB_BARCODE self, int aWidth)

Definition at line 11041 of file pcbnew.py.

◆ SetErrorCorrection()

pcbnew.PCB_BARCODE.SetErrorCorrection ( self,
aErrorCorrection ) 
SetErrorCorrection(PCB_BARCODE self, BARCODE_ECC_T aErrorCorrection)

Definition at line 11017 of file pcbnew.py.

◆ SetHeight()

pcbnew.PCB_BARCODE.SetHeight ( self,
aHeight ) 
SetHeight(PCB_BARCODE self, int aHeight)

Definition at line 10903 of file pcbnew.py.

◆ SetKind()

pcbnew.PCB_BARCODE.SetKind ( self,
aKind ) 
SetKind(PCB_BARCODE self, BARCODE_T aKind)

Definition at line 11005 of file pcbnew.py.

◆ SetMargin()

pcbnew.PCB_BARCODE.SetMargin ( self,
aMargin ) 
SetMargin(PCB_BARCODE self, VECTOR2I aMargin)

Definition at line 10911 of file pcbnew.py.

◆ SetMarginX()

pcbnew.PCB_BARCODE.SetMarginX ( self,
aX ) 
SetMarginX(PCB_BARCODE self, int aX)

Definition at line 11069 of file pcbnew.py.

◆ SetMarginY()

pcbnew.PCB_BARCODE.SetMarginY ( self,
aY ) 
SetMarginY(PCB_BARCODE self, int aY)

Definition at line 11073 of file pcbnew.py.

◆ SetOrientation()

pcbnew.PCB_BARCODE.SetOrientation ( self,
aDegrees ) 
SetOrientation(PCB_BARCODE self, double aDegrees)

Definition at line 11057 of file pcbnew.py.

◆ SetRect()

pcbnew.PCB_BARCODE.SetRect ( self,
aTopLeft,
aBotRight ) 
SetRect(PCB_BARCODE self, VECTOR2I aTopLeft, VECTOR2I aBotRight)

Definition at line 10970 of file pcbnew.py.

◆ SetShowText()

pcbnew.PCB_BARCODE.SetShowText ( self,
aShow ) 
SetShowText(PCB_BARCODE self, bool aShow)

Definition at line 11033 of file pcbnew.py.

◆ SetText()

pcbnew.PCB_BARCODE.SetText ( self,
aText ) 
SetText(PCB_BARCODE self, wxString aText)

Definition at line 10951 of file pcbnew.py.

◆ SetTextSize()

pcbnew.PCB_BARCODE.SetTextSize ( self,
aTextSize ) 
SetTextSize(PCB_BARCODE self, int aTextSize)

Definition at line 10875 of file pcbnew.py.

◆ SetWidth()

pcbnew.PCB_BARCODE.SetWidth ( self,
aWidth ) 
SetWidth(PCB_BARCODE self, int aWidth)

Definition at line 10895 of file pcbnew.py.

◆ swapData()

pcbnew.PCB_BARCODE.swapData ( self,
aImage ) 
swapData(PCB_BARCODE self, BOARD_ITEM aImage)

Definition at line 10985 of file pcbnew.py.

◆ Text()

pcbnew.PCB_BARCODE.Text ( self,
* args ) 
    Text(PCB_BARCODE self) -> PCB_TEXT
    Text(PCB_BARCODE self) -> PCB_TEXT

Definition at line 10963 of file pcbnew.py.

◆ TransformShapeToPolygon()

pcbnew.PCB_BARCODE.TransformShapeToPolygon ( self,
aBuffer,
aLayer,
aClearance,
aMaxError,
aErrorLoc = ERROR_INSIDE,
ignoreLineWidth = False ) 
TransformShapeToPolygon(PCB_BARCODE self, SHAPE_POLY_SET aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE, bool ignoreLineWidth=False)

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 10927 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.PCB_BARCODE.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 10859 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Tue Apr 28 2026 20:49:39 for KiCad Pcbnew Python Scripting by doxygen 1.13.2