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

Public Member Functions

def __init__ (self, args)
 
def ClassOf (aItem)
 
def SetPosition (self, aPos)
 
def GetPosition (self)
 
def SetShape (self, aShape)
 
def GetShape (self)
 
def SetSize (self, aSize)
 
def GetSize (self)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def Draw (self, args)
 
def GetClass (self)
 
def HitTest (self, args)
 
def GetBoundingBox (self)
 
def GetSelectMenuText (self, aUnits)
 
def GetMenuImage (self)
 
def Clone (self)
 
def SwapData (self, aImage)
 
- 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
 

Static Public Attributes

 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++ PCB_TARGET class.

Definition at line 16289 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.PCB_TARGET.__init__ (   self,
  args 
)
__init__(PCB_TARGET self, BOARD_ITEM aParent) -> PCB_TARGET
__init__(PCB_TARGET self, BOARD_ITEM aParent, int aShape, PCB_LAYER_ID aLayer, wxPoint aPos, int aSize, int aWidth) -> PCB_TARGET

Definition at line 16302 of file pcbnew.py.

Member Function Documentation

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

Definition at line 16315 of file pcbnew.py.

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

Definition at line 16416 of file pcbnew.py.

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

Definition at line 16378 of file pcbnew.py.

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

Definition at line 16373 of file pcbnew.py.

def pcbnew.PCB_TARGET.GetBoundingBox (   self)
GetBoundingBox(PCB_TARGET self) -> EDA_RECT

Definition at line 16401 of file pcbnew.py.

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

Definition at line 16386 of file pcbnew.py.

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

Definition at line 16411 of file pcbnew.py.

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

Definition at line 16328 of file pcbnew.py.

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

Definition at line 16406 of file pcbnew.py.

def pcbnew.PCB_TARGET.GetShape (   self)
GetShape(PCB_TARGET self) -> int

Definition at line 16338 of file pcbnew.py.

def pcbnew.PCB_TARGET.GetSize (   self)
GetSize(PCB_TARGET self) -> int

Definition at line 16348 of file pcbnew.py.

def pcbnew.PCB_TARGET.GetWidth (   self)
GetWidth(PCB_TARGET self) -> int

Definition at line 16358 of file pcbnew.py.

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

Definition at line 16391 of file pcbnew.py.

def pcbnew.PCB_TARGET.Move (   self,
  aMoveVector 
)
Move(PCB_TARGET self, wxPoint aMoveVector)

Definition at line 16363 of file pcbnew.py.

def pcbnew.PCB_TARGET.Rotate (   self,
  aRotCentre,
  aAngle 
)
Rotate(PCB_TARGET self, wxPoint aRotCentre, double aAngle)

Definition at line 16368 of file pcbnew.py.

def pcbnew.PCB_TARGET.SetPosition (   self,
  aPos 
)
SetPosition(PCB_TARGET self, wxPoint aPos)

Definition at line 16323 of file pcbnew.py.

def pcbnew.PCB_TARGET.SetShape (   self,
  aShape 
)
SetShape(PCB_TARGET self, int aShape)

Definition at line 16333 of file pcbnew.py.

def pcbnew.PCB_TARGET.SetSize (   self,
  aSize 
)
SetSize(PCB_TARGET self, int aSize)

Definition at line 16343 of file pcbnew.py.

def pcbnew.PCB_TARGET.SetWidth (   self,
  aWidth 
)
SetWidth(PCB_TARGET self, int aWidth)

Definition at line 16353 of file pcbnew.py.

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

Definition at line 16421 of file pcbnew.py.

Member Data Documentation

pcbnew.PCB_TARGET.ClassOf = staticmethod(ClassOf)
static

Definition at line 16320 of file pcbnew.py.

pcbnew.PCB_TARGET.this

Definition at line 16311 of file pcbnew.py.


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