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

Public Member Functions

def __init__ (self, *args)
 
def Clear (self)
 
def BBox (self, aClearance=0)
 
def PointCount (self)
 
def CPoint (self, aIndex)
 
def CDPoint (self, aIndex)
 
def Vertices (self)
 
def Append (self, *args)
 
def Collide (self, aSeg, aClearance=0, aActual=None, aLocation=None)
 
def Rotate (self, *args)
 
- Public Member Functions inherited from pcbnew.SHAPE_LINE_CHAIN_BASE
def __init__ (self, *args, **kwargs)
 
def Collide (self, *args)
 
def SquaredDistance (self, aP, aOutlineOnly=False)
 
def PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False)
 
def PointOnEdge (self, aP, aAccuracy=0)
 
def EdgeContainingPoint (self, aP, aAccuracy=0)
 
def GetPoint (self, aIndex)
 
def GetSegment (self, aIndex)
 
def GetPointCount (self)
 
def GetSegmentCount (self)
 
def IsClosed (self)
 
def GetCachedBBox (self)
 
- Public Member Functions inherited from pcbnew.SHAPE
def __init__ (self, *args, **kwargs)
 
def Clone (self)
 
def GetClearance (self, aOther)
 
def IsNull (self)
 
def Collide (self, *args)
 
def BBox (self, aClearance=0)
 
def Centre (self)
 
def Rotate (self, *args)
 
def Move (self, aVector)
 
def IsSolid (self)
 
def Parse (self, aStream)
 
def Format (self, aCplusPlus=True)
 
def Cast (self)
 
- Public Member Functions inherited from pcbnew.SHAPE_BASE
def __init__ (self, aType)
 
def Type (self)
 
def TypeName (self)
 
def HasIndexableSubshapes (self)
 
def GetIndexableSubshapeCount (self)
 
def GetIndexableSubshapes (self, aSubshapes)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.SHAPE_LINE_CHAIN_BASE
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.SHAPE
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from pcbnew.SHAPE_BASE
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Additional Inherited Members

- Static Public Attributes inherited from pcbnew.SHAPE
 MIN_PRECISION_IU = _pcbnew.SHAPE_MIN_PRECISION_IU
 

Detailed Description

Proxy of C++ SHAPE_SIMPLE class.

Definition at line 7148 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.SHAPE_SIMPLE.__init__ (   self,
args 
)
    __init__(SHAPE_SIMPLE self) -> SHAPE_SIMPLE
    __init__(SHAPE_SIMPLE self, SHAPE_LINE_CHAIN aPoly) -> SHAPE_SIMPLE
    __init__(SHAPE_SIMPLE self, SHAPE_SIMPLE aOther) -> SHAPE_SIMPLE

Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.

Definition at line 7154 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ Append()

def pcbnew.SHAPE_SIMPLE.Append (   self,
args 
)
    Append(SHAPE_SIMPLE self, int aX, int aY)
    Append(SHAPE_SIMPLE self, VECTOR2I aP)

Definition at line 7186 of file pcbnew.py.

Here is the caller graph for this function:

◆ BBox()

def pcbnew.SHAPE_SIMPLE.BBox (   self,
  aClearance = 0 
)
BBox(SHAPE_SIMPLE self, int aClearance=0) -> BOX2I

Reimplemented from pcbnew.SHAPE.

Definition at line 7166 of file pcbnew.py.

◆ CDPoint()

def pcbnew.SHAPE_SIMPLE.CDPoint (   self,
  aIndex 
)
CDPoint(SHAPE_SIMPLE self, int aIndex) -> VECTOR2D const

Definition at line 7178 of file pcbnew.py.

◆ Clear()

def pcbnew.SHAPE_SIMPLE.Clear (   self)
Clear(SHAPE_SIMPLE self)

Definition at line 7162 of file pcbnew.py.

◆ Collide()

def pcbnew.SHAPE_SIMPLE.Collide (   self,
  aSeg,
  aClearance = 0,
  aActual = None,
  aLocation = None 
)
Collide(SHAPE_SIMPLE self, SEG aSeg, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool

Reimplemented from pcbnew.SHAPE_LINE_CHAIN_BASE.

Definition at line 7193 of file pcbnew.py.

◆ CPoint()

def pcbnew.SHAPE_SIMPLE.CPoint (   self,
  aIndex 
)
CPoint(SHAPE_SIMPLE self, int aIndex) -> VECTOR2I

Definition at line 7174 of file pcbnew.py.

◆ PointCount()

def pcbnew.SHAPE_SIMPLE.PointCount (   self)
PointCount(SHAPE_SIMPLE self) -> int

Definition at line 7170 of file pcbnew.py.

◆ Rotate()

def pcbnew.SHAPE_SIMPLE.Rotate (   self,
args 
)
Rotate(SHAPE_SIMPLE self, EDA_ANGLE aAngle, VECTOR2I aCenter={ 0, 0 })

Reimplemented from pcbnew.SHAPE.

Definition at line 7197 of file pcbnew.py.

◆ Vertices()

def pcbnew.SHAPE_SIMPLE.Vertices (   self)
Vertices(SHAPE_SIMPLE self) -> SHAPE_LINE_CHAIN

Definition at line 7182 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 7151 of file pcbnew.py.


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