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

Public Member Functions

def __init__ (self, *args)
 
def GetViaType (self)
 
def SetViaType (self, aViaType)
 
def GetSolderMaskExpansion (self)
 
def SetLayerPair (self, aTopLayer, aBottomLayer)
 
def SetBottomLayer (self, aLayer)
 
def SetTopLayer (self, aLayer)
 
def LayerPair (self, top_layer, bottom_layer)
 
def TopLayer (self)
 
def BottomLayer (self)
 
def SanitizeLayers (self)
 
def HitTest (self, *args)
 
def ViewGetLOD (self, aLayer, aView)
 
def GetMinAnnulus (self, aLayer, aSource)
 
def SetRemoveUnconnected (self, aSet)
 
def GetRemoveUnconnected (self)
 
def SetKeepStartEnd (self, aSet)
 
def GetKeepStartEnd (self)
 
def ConditionallyFlashed (self, aLayer)
 
def FlashLayer (self, *args)
 
def SetDrill (self, aDrill)
 
def GetDrill (self)
 
def GetDrillValue (self)
 
def SetDrillDefault (self)
 
def GetIsFree (self)
 
def SetIsFree (self, aFree=True)
 
def IsDrillDefault (self)
 
def GetEffectiveShape (self, *args)
 
def ClearZoneLayerOverrides (self)
 
def GetZoneLayerOverride (self, aLayer)
 
def SetZoneLayerOverride (self, aLayer, aOverride)
 
- Public Member Functions inherited from pcbnew.PCB_TRACK
def __init__ (self, aParent, idtype=PCB_TRACE_T)
 
def Mirror (self, aCentre, aMirrorAroundXAxis)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def SetEnd (self, aEnd)
 
def GetEnd (self)
 
def SetStart (self, aStart)
 
def GetStart (self)
 
def SetEndX (self, aX)
 
def SetEndY (self, aY)
 
def GetEndX (self)
 
def GetEndY (self)
 
def GetEndPoint (self, aEndPoint)
 
def GetLength (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def GetEffectiveShape (self, *args)
 
def IsPointOnEnds (self, point, min_dist=0)
 
def IsNull (self)
 
def HitTest (self, *args)
 
def ApproxCollinear (self, aTrack)
 
def GetWidthConstraint (self, aSource=None)
 
def ViewGetLOD (self, aLayer, aView)
 
def GetCachedLOD (self)
 
def SetCachedLOD (self, aLOD)
 
def GetCachedScale (self)
 
def SetCachedScale (self, aScale)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, *args, **kwargs)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode (self, *args)
 
def GetNetname (self)
 
def GetNetnameMsg (self)
 
def GetShortNetname (self)
 
def GetUnescapedShortNetname (self)
 
def GetOwnClearance (self, aLayer, aSource=None)
 
def GetLocalClearanceOverrides (self, aSource)
 
def GetLocalClearance (self, aSource)
 
def GetEffectiveNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
def SetParentGroup (self, aGroup)
 
def GetParentGroup (self)
 
def GetX (self)
 
def GetY (self)
 
def GetCenter (self)
 
def SetX (self, aX)
 
def SetY (self, aY)
 
def IsConnected (self)
 
def IsOnCopperLayer (self)
 
def HasHole (self)
 
def IsTented (self)
 
def GetEffectiveShape (self, *args)
 
def GetEffectiveHoleShape (self)
 
def GetParent (self)
 
def GetParentFootprint (self)
 
def HasLineStroke (self)
 
def GetStroke (self)
 
def SetStroke (self, aStroke)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayerSet (self, aLayers)
 
def SetLayer (self, aLayer)
 
def Duplicate (self)
 
def SwapItemData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsKnockout (self)
 
def SetIsKnockout (self, aKnockout)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def DeleteStructure (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre, aFlipLeftRight)
 
def GetBoard (self, *args)
 
def GetLayerName (self)
 
def TransformShapeToPolygon (self, aBuffer, aLayer, aClearance, aError, aErrorLoc, ignoreLineWidth=False)
 
def Cast (self)
 
def Duplicate (self)
 
def SetPos (self, p)
 
def SetStartEnd (self, start, end)
 
- Public Member Functions inherited from pcbnew.EDA_ITEM
def __init__ (self, *args, **kwargs)
 
def Type (self)
 
def GetParent (self)
 
def SetParent (self, aParent)
 
def IsModified (self)
 
def IsNew (self)
 
def IsMoving (self)
 
def IsSelected (self)
 
def IsEntered (self)
 
def IsBrightened (self)
 
def IsRollover (self)
 
def SetSelected (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def XorFlags (self, aMask)
 
def ClearFlags (self, *args)
 
def GetFlags (self)
 
def HasFlag (self, aFlag)
 
def GetEditFlags (self)
 
def ClearTempFlags (self)
 
def ClearEditFlags (self)
 
def RenderAsBitmap (self, aWorldScale)
 
def SetIsShownAsBitmap (self, aBitmap)
 
def IsShownAsBitmap (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def IsForceVisible (self)
 
def GetMsgPanelInfo (self, aFrame, aList)
 
def GetFriendlyName (self)
 
def HitTest (self, *args)
 
def GetBoundingBox (self)
 
def GetPosition (self)
 
def SetPosition (self, aPos)
 
def GetFocusPosition (self)
 
def GetSortPosition (self)
 
def Clone (self)
 
def Visit (self, inspector, testData, aScanTypes)
 
def GetClass (self)
 
def GetTypeDesc (self)
 
def GetItemDescription (self, aUnitsProvider)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData)
 
def Replace (self, *args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Static Public Member Functions

def ClassOf (aItem)
 
def ClassOf (aItem)
 
def ClassOf (aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
def 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.PCB_TRACK
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.BOARD_CONNECTED_ITEM
 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=)
 

Detailed Description

Proxy of C++ PCB_VIA class.

Definition at line 13357 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_VIA.__init__ (   self,
args 
)
    __init__(PCB_VIA self, BOARD_ITEM aParent) -> PCB_VIA
    __init__(PCB_VIA self, PCB_VIA aOther) -> PCB_VIA

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 13368 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ BottomLayer()

def pcbnew.PCB_VIA.BottomLayer (   self)
BottomLayer(PCB_VIA self) -> PCB_LAYER_ID

Definition at line 13407 of file pcbnew.py.

◆ ClassOf()

def pcbnew.PCB_VIA.ClassOf (   aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 13364 of file pcbnew.py.

◆ ClearZoneLayerOverrides()

def pcbnew.PCB_VIA.ClearZoneLayerOverrides (   self)
ClearZoneLayerOverrides(PCB_VIA self)

Definition at line 13489 of file pcbnew.py.

◆ ConditionallyFlashed()

def pcbnew.PCB_VIA.ConditionallyFlashed (   self,
  aLayer 
)
ConditionallyFlashed(PCB_VIA self, PCB_LAYER_ID aLayer) -> bool

Definition at line 13446 of file pcbnew.py.

◆ FlashLayer()

def pcbnew.PCB_VIA.FlashLayer (   self,
args 
)
    FlashLayer(PCB_VIA self, int aLayer) -> bool
    FlashLayer(PCB_VIA self, LSET aLayers) -> bool

Definition at line 13450 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetDrill()

def pcbnew.PCB_VIA.GetDrill (   self)
GetDrill(PCB_VIA self) -> int

Definition at line 13461 of file pcbnew.py.

◆ GetDrillValue()

def pcbnew.PCB_VIA.GetDrillValue (   self)
GetDrillValue(PCB_VIA self) -> int

Definition at line 13465 of file pcbnew.py.

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 13485 of file pcbnew.py.

◆ GetIsFree()

def pcbnew.PCB_VIA.GetIsFree (   self)
GetIsFree(PCB_VIA self) -> bool

Definition at line 13473 of file pcbnew.py.

◆ GetKeepStartEnd()

def pcbnew.PCB_VIA.GetKeepStartEnd (   self)
GetKeepStartEnd(PCB_VIA self) -> bool

Definition at line 13442 of file pcbnew.py.

◆ GetMinAnnulus()

def pcbnew.PCB_VIA.GetMinAnnulus (   self,
  aLayer,
  aSource 
)
GetMinAnnulus(PCB_VIA self, PCB_LAYER_ID aLayer, wxString aSource) -> int

Definition at line 13426 of file pcbnew.py.

◆ GetRemoveUnconnected()

def pcbnew.PCB_VIA.GetRemoveUnconnected (   self)
GetRemoveUnconnected(PCB_VIA self) -> bool

Definition at line 13434 of file pcbnew.py.

◆ GetSolderMaskExpansion()

def pcbnew.PCB_VIA.GetSolderMaskExpansion (   self)
GetSolderMaskExpansion(PCB_VIA self) -> int

Definition at line 13383 of file pcbnew.py.

◆ GetViaType()

def pcbnew.PCB_VIA.GetViaType (   self)
GetViaType(PCB_VIA self) -> VIATYPE

Definition at line 13375 of file pcbnew.py.

◆ GetZoneLayerOverride()

def pcbnew.PCB_VIA.GetZoneLayerOverride (   self,
  aLayer 
)
GetZoneLayerOverride(PCB_VIA self, PCB_LAYER_ID aLayer) -> ZONE_LAYER_OVERRIDE const &

Definition at line 13493 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 13415 of file pcbnew.py.

Here is the caller graph for this function:

◆ IsDrillDefault()

def pcbnew.PCB_VIA.IsDrillDefault (   self)
IsDrillDefault(PCB_VIA self) -> bool

Definition at line 13481 of file pcbnew.py.

◆ LayerPair()

def pcbnew.PCB_VIA.LayerPair (   self,
  top_layer,
  bottom_layer 
)
LayerPair(PCB_VIA self, PCB_LAYER_ID * top_layer, PCB_LAYER_ID * bottom_layer)

Definition at line 13399 of file pcbnew.py.

◆ SanitizeLayers()

def pcbnew.PCB_VIA.SanitizeLayers (   self)
SanitizeLayers(PCB_VIA self)

Definition at line 13411 of file pcbnew.py.

◆ SetBottomLayer()

def pcbnew.PCB_VIA.SetBottomLayer (   self,
  aLayer 
)
SetBottomLayer(PCB_VIA self, PCB_LAYER_ID aLayer)

Definition at line 13391 of file pcbnew.py.

◆ SetDrill()

def pcbnew.PCB_VIA.SetDrill (   self,
  aDrill 
)
SetDrill(PCB_VIA self, int aDrill)

Definition at line 13457 of file pcbnew.py.

◆ SetDrillDefault()

def pcbnew.PCB_VIA.SetDrillDefault (   self)
SetDrillDefault(PCB_VIA self)

Definition at line 13469 of file pcbnew.py.

◆ SetIsFree()

def pcbnew.PCB_VIA.SetIsFree (   self,
  aFree = True 
)
SetIsFree(PCB_VIA self, bool aFree=True)

Definition at line 13477 of file pcbnew.py.

◆ SetKeepStartEnd()

def pcbnew.PCB_VIA.SetKeepStartEnd (   self,
  aSet 
)
SetKeepStartEnd(PCB_VIA self, bool aSet)

Definition at line 13438 of file pcbnew.py.

◆ SetLayerPair()

def pcbnew.PCB_VIA.SetLayerPair (   self,
  aTopLayer,
  aBottomLayer 
)
SetLayerPair(PCB_VIA self, PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)

Definition at line 13387 of file pcbnew.py.

◆ SetRemoveUnconnected()

def pcbnew.PCB_VIA.SetRemoveUnconnected (   self,
  aSet 
)
SetRemoveUnconnected(PCB_VIA self, bool aSet)

Definition at line 13430 of file pcbnew.py.

◆ SetTopLayer()

def pcbnew.PCB_VIA.SetTopLayer (   self,
  aLayer 
)
SetTopLayer(PCB_VIA self, PCB_LAYER_ID aLayer)

Definition at line 13395 of file pcbnew.py.

◆ SetViaType()

def pcbnew.PCB_VIA.SetViaType (   self,
  aViaType 
)
SetViaType(PCB_VIA self, VIATYPE aViaType)

Definition at line 13379 of file pcbnew.py.

◆ SetZoneLayerOverride()

def pcbnew.PCB_VIA.SetZoneLayerOverride (   self,
  aLayer,
  aOverride 
)
SetZoneLayerOverride(PCB_VIA self, PCB_LAYER_ID aLayer, ZONE_LAYER_OVERRIDE aOverride)

Definition at line 13497 of file pcbnew.py.

◆ TopLayer()

def pcbnew.PCB_VIA.TopLayer (   self)
TopLayer(PCB_VIA self) -> PCB_LAYER_ID

Definition at line 13403 of file pcbnew.py.

◆ ViewGetLOD()

def pcbnew.PCB_VIA.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(PCB_VIA self, int aLayer, KIGFX::VIEW * aView) -> double

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 13422 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 13360 of file pcbnew.py.


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