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

Public Member Functions

def __init__ (self, aParent)
 
def ClassOf (aItem)
 
def Draw (self, args)
 
def IsOnLayer (self, aLayer)
 
def GetLayerSet (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 GetPosition (self)
 
def SetPosition (self, aPoint)
 
def HitTest (self, args)
 
def GetClass (self)
 
def GetSelectMenuText (self, aUnits)
 
def GetMenuImage (self)
 
def Clone (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def ViewGetLOD (self, aLayer, aView)
 
def Flip (self, aCentre)
 
def GetViaType (self)
 
def SetViaType (self, aViaType)
 
def SetDrill (self, aDrill)
 
def GetDrill (self)
 
def GetDrillValue (self)
 
def SetDrillDefault (self)
 
def IsDrillDefault (self)
 
def SwapData (self, aImage)
 
- Public Member Functions inherited from pcbnew.TRACK
def ClassOf (aItem)
 
def __init__ (self, aParent, idtype=PCB_TRACE_T)
 
def Next (self)
 
def Back (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def SetPosition (self, aPos)
 
def GetPosition (self)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def SetEnd (self, aEnd)
 
def GetEnd (self)
 
def SetStart (self, aStart)
 
def GetStart (self)
 
def GetEndPoint (self, aEndPoint)
 
def GetBoundingBox (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def GetBestInsertPoint (self, aPcb)
 
def GetStartNetCode (self, NetCode)
 
def GetEndNetCode (self, NetCode)
 
def GetLength (self)
 
def Draw (self, args)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def IsPointOnEnds (self, point, min_dist=0)
 
def IsNull (self)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def Visit (self, inspector, testData, scanTypes)
 
def HitTest (self, args)
 
def GetVia (self, args)
 
def GetTrack (self, aStartTrace, aEndTrace, aEndPoint, aSameNetOnly, aSequential)
 
def GetEndSegments (self, NbSegm, StartTrack, EndTrack)
 
def GetClass (self)
 
def GetClearance (self, aItem=None)
 
def GetSelectMenuText (self, aUnits)
 
def GetMenuImage (self)
 
def Clone (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def ViewGetLOD (self, aLayer, aView)
 
def ViewBBox (self)
 
def SwapData (self, aImage)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, args, kwargs)
 
def ClassOf (aItem)
 
def IsConnected (self)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode (self, aNetCode, aNoAssert=False)
 
def GetNetname (self)
 
def GetNetnameMsg (self)
 
def GetShortNetname (self)
 
def GetClearance (self, aItem=None)
 
def GetNetClass (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 GetPosition (self)
 
def GetCenter (self)
 
def SetPosition (self, aPos)
 
def IsConnected (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def Draw (self, args)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (aShape)
 
def Move (self, args)
 
def Rotate (self, args)
 
def Flip (self, args)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def HitTest (self, args)
 
def FormatAngle (aAngle)
 
def FormatInternalUnits (args)
 
def ViewGetLayers (self, aLayers, aCount)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
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 SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def Next (self)
 
def Back (self)
 
def GetParent (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (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 ClearFlags (self, aMask=-1)
 
def GetFlags (self)
 
def IsType (self, aScanTypes)
 
def SetForceVisible (self, aEnable)
 
def GetMsgPanelInfo (self, aUnits, aList)
 
def HitTest (self, aPosition)
 
def GetBoundingBox (self)
 
def Clone (self)
 
def IterateForward (listStart, inspector, testData, scanTypes)
 
def Visit (self, inspector, testData, scanTypes)
 
def GetClass (self)
 
def GetSelectMenuText (self, aUnits)
 
def GetMenuImage (self)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (aLeft, aRight)
 
def ViewBBox (self)
 
def ViewGetLayers (self, aLayers, aCount)
 

Public Attributes

 this
 
- Public Attributes inherited from pcbnew.TRACK
 this
 

Static Public Attributes

 ClassOf = staticmethod(ClassOf)
 
- Static Public Attributes inherited from pcbnew.TRACK
 ClassOf = staticmethod(ClassOf)
 
 start = _swig_property(_pcbnew.TRACK_start_get, _pcbnew.TRACK_start_set)
 
 end = _swig_property(_pcbnew.TRACK_end_get, _pcbnew.TRACK_end_set)
 
 m_Param = _swig_property(_pcbnew.TRACK_m_Param_get, _pcbnew.TRACK_m_Param_set)
 
- Static Public Attributes inherited from pcbnew.BOARD_CONNECTED_ITEM
 ClassOf = staticmethod(ClassOf)
 
- Static Public Attributes inherited from pcbnew.BOARD_ITEM
 ShowShape = staticmethod(ShowShape)
 
 FormatAngle = staticmethod(FormatAngle)
 
 FormatInternalUnits = staticmethod(FormatInternalUnits)
 
- Static Public Attributes inherited from pcbnew.EDA_ITEM
 IterateForward = staticmethod(IterateForward)
 
 Sort = staticmethod(Sort)
 

Detailed Description

Proxy of C++ VIA class.

Definition at line 13669 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.VIA.__init__ (   self,
  aParent 
)
__init__(VIA self, BOARD_ITEM aParent) -> VIA

Definition at line 13682 of file pcbnew.py.

Member Function Documentation

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

Definition at line 13741 of file pcbnew.py.

def pcbnew.VIA.ClassOf (   aItem)
ClassOf(EDA_ITEM aItem) -> bool

Definition at line 13690 of file pcbnew.py.

def pcbnew.VIA.Clone (   self)
Clone(VIA self) -> EDA_ITEM

Definition at line 13786 of file pcbnew.py.

def pcbnew.VIA.Draw (   self,
  args 
)
Draw(VIA self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(VIA self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode)

Definition at line 13698 of file pcbnew.py.

def pcbnew.VIA.Flip (   self,
  aCentre 
)
Flip(VIA self, wxPoint aCentre)

Definition at line 13801 of file pcbnew.py.

def pcbnew.VIA.GetClass (   self)
GetClass(VIA self) -> wxString

Definition at line 13771 of file pcbnew.py.

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

Definition at line 13821 of file pcbnew.py.

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

Definition at line 13826 of file pcbnew.py.

def pcbnew.VIA.GetLayerSet (   self)
GetLayerSet(VIA self) -> LSET

Definition at line 13711 of file pcbnew.py.

def pcbnew.VIA.GetMenuImage (   self)
GetMenuImage(VIA self) -> BITMAP_DEF

Definition at line 13781 of file pcbnew.py.

def pcbnew.VIA.GetPosition (   self)
GetPosition(VIA self) -> wxPoint

Definition at line 13751 of file pcbnew.py.

def pcbnew.VIA.GetSelectMenuText (   self,
  aUnits 
)
GetSelectMenuText(VIA self, EDA_UNITS_T aUnits) -> wxString

Definition at line 13776 of file pcbnew.py.

def pcbnew.VIA.GetViaType (   self)
GetViaType(VIA self) -> VIATYPE_T

Definition at line 13806 of file pcbnew.py.

def pcbnew.VIA.HitTest (   self,
  args 
)
HitTest(VIA self, wxPoint aPosition) -> bool
HitTest(VIA self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(VIA self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(VIA self, EDA_RECT aRect) -> bool

Definition at line 13761 of file pcbnew.py.

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

Definition at line 13836 of file pcbnew.py.

def pcbnew.VIA.IsOnLayer (   self,
  aLayer 
)
IsOnLayer(VIA self, PCB_LAYER_ID aLayer) -> bool

Definition at line 13706 of file pcbnew.py.

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

Definition at line 13731 of file pcbnew.py.

def pcbnew.VIA.SanitizeLayers (   self)
SanitizeLayers(VIA self)

Definition at line 13746 of file pcbnew.py.

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

Definition at line 13721 of file pcbnew.py.

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

Definition at line 13816 of file pcbnew.py.

def pcbnew.VIA.SetDrillDefault (   self)
SetDrillDefault(VIA self)

Definition at line 13831 of file pcbnew.py.

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

Definition at line 13716 of file pcbnew.py.

def pcbnew.VIA.SetPosition (   self,
  aPoint 
)
SetPosition(VIA self, wxPoint aPoint)

Definition at line 13756 of file pcbnew.py.

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

Definition at line 13726 of file pcbnew.py.

def pcbnew.VIA.SetViaType (   self,
  aViaType 
)
SetViaType(VIA self, VIATYPE_T aViaType)

Definition at line 13811 of file pcbnew.py.

def pcbnew.VIA.SwapData (   self,
  aImage 
)
SwapData(VIA self, BOARD_ITEM aImage)

Definition at line 13841 of file pcbnew.py.

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

Definition at line 13736 of file pcbnew.py.

def pcbnew.VIA.ViewGetLayers (   self,
  aLayers,
  aCount 
)
ViewGetLayers(VIA self, int [] aLayers, int & aCount)

Definition at line 13791 of file pcbnew.py.

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

Definition at line 13796 of file pcbnew.py.

Member Data Documentation

pcbnew.VIA.ClassOf = staticmethod(ClassOf)
static

Definition at line 13695 of file pcbnew.py.

pcbnew.VIA.this

Definition at line 13688 of file pcbnew.py.


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