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

Public Member Functions

def __init__ (self, *args)
 
"void" Move (self, "wxPoint" aMoveVector)
 
"void" Rotate (self, "wxPoint" aRotCentre, "double" aAngle)
 
"void" Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)
 
"void" SetMid (self, "wxPoint" aMid)
 
"wxPoint const &" GetMid (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint" GetPosition (self)
 
"wxPoint" GetCenter (self)
 
"double" GetRadius (self)
 
"double" GetAngle (self)
 
"double" GetArcAngleStart (self)
 
"double" GetArcAngleEnd (self)
 
"bool" HitTest (self, *args)
 
"wxString" GetClass (self)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"double" GetLength (self)
 
"EDA_ITEM *" Clone (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
- Public Member Functions inherited from pcbnew.PCB_TRACK
def __init__ (self, "BOARD_ITEM" aParent, "KICAD_T" idtype=PCB_TRACE_T)
 
"void" Move (self, "wxPoint" aMoveVector)
 
"void" Rotate (self, "wxPoint" aRotCentre, "double" aAngle)
 
"void" Flip (self, "wxPoint" aCentre, "bool" aFlipLeftRight)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint" GetPosition (self)
 
"wxPoint const" GetFocusPosition (self)
 
"void" SetWidth (self, "int" aWidth)
 
"int" GetWidth (self)
 
"void" SetEnd (self, "wxPoint" aEnd)
 
"wxPoint const &" GetEnd (self)
 
"void" SetStart (self, "wxPoint" aStart)
 
"wxPoint const &" GetStart (self)
 
"void" SetEndX (self, "int" aX)
 
"void" SetEndY (self, "int" aY)
 
"int" GetEndX (self)
 
"int" GetEndY (self)
 
"wxPoint const &" GetEndPoint (self, "ENDPOINT_T" aEndPoint)
 
"EDA_RECT const" GetBoundingBox (self)
 
"double" GetLength (self)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" ignoreLineWidth=False)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"EDA_ITEM_FLAGS" IsPointOnEnds (self, "wxPoint" point, "int" min_dist=0)
 
"bool" IsNull (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"bool" HitTest (self, *args)
 
"bool" ApproxCollinear (self, "PCB_TRACK" aTrack)
 
"wxString" GetClass (self)
 
"int" GetLocalClearance (self, "wxString" aSource)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"EDA_ITEM *" Clone (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 
"double" ViewGetLOD (self, "int" aLayer, "KIGFX::VIEW *" aView)
 
"BOX2I const" ViewBBox (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
"bool" IsOnCopperLayer (self)
 
- Public Member Functions inherited from pcbnew.BOARD_CONNECTED_ITEM
def __init__ (self, *args, **kwargs)
 
"bool" IsConnected (self)
 
"NETINFO_ITEM *" GetNet (self)
 
"void" SetNet (self, "NETINFO_ITEM" aNetInfo)
 
"int" GetNetCode (self)
 
"void" SetNetCode (self, *args)
 
"wxString" GetNetname (self)
 
"wxString" GetNetnameMsg (self)
 
"wxString" GetShortNetname (self)
 
"int" GetOwnClearance (self, "PCB_LAYER_ID" aLayer, "wxString" aSource=None)
 
"int" GetLocalClearanceOverrides (self, "wxString" aSource)
 
"int" GetLocalClearance (self, "wxString" aSource)
 
"NETCLASS *" GetNetClass (self)
 
"NETCLASS *" GetEffectiveNetclass (self)
 
"wxString" GetNetClassName (self)
 
"void" SetLocalRatsnestVisible (self, "bool" aVisible)
 
"bool" GetLocalRatsnestVisible (self)
 
- Public Member Functions inherited from pcbnew.BOARD_ITEM
def __init__ (self, *args, **kwargs)
 
"void" SetParentGroup (self, "PCB_GROUP" aGroup)
 
"PCB_GROUP *" GetParentGroup (self)
 
"int" GetX (self)
 
"int" GetY (self)
 
"wxPoint" GetCenter (self)
 
"void" SetX (self, "int" aX)
 
"void" SetY (self, "int" aY)
 
"bool" IsConnected (self)
 
"bool" IsOnCopperLayer (self)
 
"std::shared_ptr< SHAPE >" GetEffectiveShape (self, *args)
 
"BOARD_ITEM_CONTAINER *" GetParent (self)
 
"BOARD_ITEM_CONTAINER *" GetParentFootprint (self)
 
"PCB_LAYER_ID" GetLayer (self)
 
"LSET" GetLayerSet (self)
 
"void" SetLayerSet (self, "LSET" aLayers)
 
"void" SetLayer (self, "PCB_LAYER_ID" aLayer)
 
"BOARD_ITEM *" Duplicate (self)
 
"void" SwapData (self, "BOARD_ITEM" aImage)
 
"bool" IsOnLayer (self, "PCB_LAYER_ID" aLayer)
 
"bool" IsTrack (self)
 
"bool" IsLocked (self)
 
"void" SetLocked (self, "bool" aLocked)
 
"void" DeleteStructure (self)
 
"void" Move (self, *args)
 
"void" Rotate (self, *args)
 
"void" Flip (self, *args)
 
"BOARD *" GetBoard (self, *args)
 
"wxString" GetLayerName (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 
"void" TransformShapeWithClearanceToPolygon (self, "SHAPE_POLY_SET" aCornerBuffer, "PCB_LAYER_ID" aLayer, "int" aClearanceValue, "int" aError, "ERROR_LOC" aErrorLoc, "bool" 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)
 
"KICAD_T" Type (self)
 
"EDA_ITEM *" GetParent (self)
 
"void" SetParent (self, "EDA_ITEM" aParent)
 
"bool" IsModified (self)
 
"bool" IsNew (self)
 
"bool" IsMoving (self)
 
"bool" IsDragging (self)
 
"bool" IsWireImage (self)
 
"bool" IsSelected (self)
 
"bool" IsEntered (self)
 
"bool" IsResized (self)
 
"bool" IsBrightened (self)
 
"void" SetWireImage (self)
 
"void" SetSelected (self)
 
"void" SetBrightened (self)
 
"void" ClearSelected (self)
 
"void" ClearBrightened (self)
 
"void" SetModified (self)
 
"int" GetState (self, "EDA_ITEM_FLAGS" type)
 
"void" SetState (self, "EDA_ITEM_FLAGS" type, "bool" state)
 
"EDA_ITEM_FLAGS" GetStatus (self)
 
"void" SetStatus (self, "EDA_ITEM_FLAGS" aStatus)
 
"void" SetFlags (self, "EDA_ITEM_FLAGS" aMask)
 
"void" ClearFlags (self, *args)
 
"EDA_ITEM_FLAGS" GetFlags (self)
 
"bool" HasFlag (self, "EDA_ITEM_FLAGS" aFlag)
 
"EDA_ITEM_FLAGS" GetEditFlags (self)
 
"void" ClearTempFlags (self)
 
"void" ClearEditFlags (self)
 
"bool" IsType (self, "KICAD_T const []" aScanTypes)
 
"void" SetForceVisible (self, "bool" aEnable)
 
"bool" IsForceVisible (self)
 
"void" GetMsgPanelInfo (self, "EDA_DRAW_FRAME *" aFrame, "std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > &" aList)
 
"bool" HitTest (self, *args)
 
"EDA_RECT const" GetBoundingBox (self)
 
"wxPoint" GetPosition (self)
 
"void" SetPosition (self, "wxPoint" aPos)
 
"wxPoint const" GetFocusPosition (self)
 
"EDA_ITEM *" Clone (self)
 
"SEARCH_RESULT" Visit (self, "INSPECTOR" inspector, "void *" testData, "KICAD_T const []" scanTypes)
 
"wxString" GetClass (self)
 
"wxString" GetSelectMenuText (self, "EDA_UNITS" aUnits)
 
"BITMAPS" GetMenuImage (self)
 
"bool" Matches (self, "wxFindReplaceData const &" aSearchData, "void *" aAuxData)
 
"bool" Replace (self, *args)
 
"bool" IsReplaceable (self)
 
"bool" __lt__ (self, "EDA_ITEM" aItem)
 
"BOX2I const" ViewBBox (self)
 
"void" ViewGetLayers (self, "int []" aLayers, "int &" aCount)
 

Static Public Member Functions

"bool" ClassOf ("EDA_ITEM" aItem)
 
"bool" ClassOf ("EDA_ITEM" aItem)
 
"bool" ClassOf ("EDA_ITEM" aItem)
 
- Static Public Member Functions inherited from pcbnew.EDA_ITEM
"bool" Sort ("EDA_ITEM" aLeft, "EDA_ITEM" 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_ARC class.

Definition at line 11923 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_ARC.__init__ (   self,
args 
)
    __init__(PCB_ARC self, BOARD_ITEM aParent) -> PCB_ARC
    __init__(PCB_ARC self, BOARD_ITEM aParent, SHAPE_ARC const * aArc) -> PCB_ARC

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11929 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ ClassOf()

"bool" pcbnew.PCB_ARC.ClassOf ( "EDA_ITEM"  aItem)
static
ClassOf(EDA_ITEM aItem) -> bool

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11937 of file pcbnew.py.

◆ Clone()

"EDA_ITEM *" pcbnew.PCB_ARC.Clone (   self)
Clone(PCB_ARC self) -> EDA_ITEM

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 12008 of file pcbnew.py.

Here is the caller graph for this function:

◆ Flip()

"void" pcbnew.PCB_ARC.Flip (   self,
"wxPoint"  aCentre,
"bool"  aFlipLeftRight 
)
Flip(PCB_ARC self, wxPoint aCentre, bool aFlipLeftRight)

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11949 of file pcbnew.py.

◆ GetAngle()

"double" pcbnew.PCB_ARC.GetAngle (   self)
GetAngle(PCB_ARC self) -> double

Definition at line 11977 of file pcbnew.py.

◆ GetArcAngleEnd()

"double" pcbnew.PCB_ARC.GetArcAngleEnd (   self)
GetArcAngleEnd(PCB_ARC self) -> double

Definition at line 11985 of file pcbnew.py.

◆ GetArcAngleStart()

"double" pcbnew.PCB_ARC.GetArcAngleStart (   self)
GetArcAngleStart(PCB_ARC self) -> double

Definition at line 11981 of file pcbnew.py.

◆ GetCenter()

"wxPoint" pcbnew.PCB_ARC.GetCenter (   self)
GetCenter(PCB_ARC self) -> wxPoint

Reimplemented from pcbnew.BOARD_ITEM.

Definition at line 11969 of file pcbnew.py.

◆ GetClass()

"wxString" pcbnew.PCB_ARC.GetClass (   self)
GetClass(PCB_ARC self) -> wxString

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11996 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetEffectiveShape()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 12000 of file pcbnew.py.

◆ GetLength()

"double" pcbnew.PCB_ARC.GetLength (   self)
GetLength(PCB_ARC self) -> double

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 12004 of file pcbnew.py.

◆ GetMid()

"wxPoint const &" pcbnew.PCB_ARC.GetMid (   self)
GetMid(PCB_ARC self) -> wxPoint

Definition at line 11957 of file pcbnew.py.

◆ GetPosition()

"wxPoint" pcbnew.PCB_ARC.GetPosition (   self)
GetPosition(PCB_ARC self) -> wxPoint

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11965 of file pcbnew.py.

◆ GetRadius()

"double" pcbnew.PCB_ARC.GetRadius (   self)
GetRadius(PCB_ARC self) -> double

Definition at line 11973 of file pcbnew.py.

◆ HitTest()

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

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11989 of file pcbnew.py.

Here is the caller graph for this function:

◆ Move()

"void" pcbnew.PCB_ARC.Move (   self,
"wxPoint"  aMoveVector 
)
Move(PCB_ARC self, wxPoint aMoveVector)

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11941 of file pcbnew.py.

◆ Rotate()

"void" pcbnew.PCB_ARC.Rotate (   self,
"wxPoint"  aRotCentre,
"double"  aAngle 
)
Rotate(PCB_ARC self, wxPoint aRotCentre, double aAngle)

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11945 of file pcbnew.py.

◆ SetMid()

"void" pcbnew.PCB_ARC.SetMid (   self,
"wxPoint"  aMid 
)
SetMid(PCB_ARC self, wxPoint aMid)

Definition at line 11953 of file pcbnew.py.

◆ SetPosition()

"void" pcbnew.PCB_ARC.SetPosition (   self,
"wxPoint"  aPos 
)
SetPosition(PCB_ARC self, wxPoint aPos)

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 11961 of file pcbnew.py.

Here is the caller graph for this function:

◆ SwapData()

"void" pcbnew.PCB_ARC.SwapData (   self,
"BOARD_ITEM"  aImage 
)
SwapData(PCB_ARC self, BOARD_ITEM aImage)

Reimplemented from pcbnew.PCB_TRACK.

Definition at line 12012 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 11926 of file pcbnew.py.


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