KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
pcbnew.SHAPE Class Reference
Inheritance diagram for pcbnew.SHAPE:
Inheritance graph
[legend]

Public Member Functions

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 Distance (self, aP)
 
def SquaredDistance (self, aP, aOutlineOnly=False)
 
def PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False)
 
def TransformToPolygon (self, aBuffer, aError, aErrorLoc)
 
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)
 

Static Public Attributes

 MIN_PRECISION_IU = _pcbnew.SHAPE_MIN_PRECISION_IU
 

Properties

 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")
 

Detailed Description

Proxy of C++ SHAPE class.

Definition at line 6067 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.SHAPE.__init__ (   self,
aType,
**  kwargs 
)
__init__(SHAPE_BASE self, SHAPE_TYPE aType) -> SHAPE_BASE

Reimplemented from pcbnew.SHAPE_BASE.

Reimplemented in pcbnew.SHAPE_CIRCLE, pcbnew.SHAPE_COMPOUND, pcbnew.SHAPE_LINE_CHAIN, pcbnew.SHAPE_POLY_SET, pcbnew.SHAPE_RECT, pcbnew.SHAPE_SEGMENT, pcbnew.SHAPE_SIMPLE, pcbnew.SHAPE_LINE_CHAIN_BASE, and pcbnew.SHAPE_ARC.

Definition at line 6072 of file pcbnew.py.

Member Function Documentation

◆ BBox()

def pcbnew.SHAPE.BBox (   self,
  aClearance = 0 
)

◆ Cast()

def pcbnew.SHAPE.Cast (   self)

Definition at line 6144 of file pcbnew.py.

◆ Centre()

def pcbnew.SHAPE.Centre (   self)
Centre(SHAPE self) -> VECTOR2I

Definition at line 6104 of file pcbnew.py.

◆ Clone()

def pcbnew.SHAPE.Clone (   self)
Clone(SHAPE self) -> SHAPE

Reimplemented in pcbnew.SHAPE_COMPOUND.

Definition at line 6079 of file pcbnew.py.

◆ Collide()

def pcbnew.SHAPE.Collide (   self,
args 
)
    Collide(SHAPE self, VECTOR2I aP, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
    Collide(SHAPE self, SHAPE aShape, int aClearance, VECTOR2I aMTV) -> bool
    Collide(SHAPE self, SHAPE aShape, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool
    Collide(SHAPE self, SEG aSeg, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool

Reimplemented in pcbnew.SHAPE_LINE_CHAIN_BASE, pcbnew.SHAPE_ARC, pcbnew.SHAPE_COMPOUND, pcbnew.SHAPE_LINE_CHAIN, pcbnew.SHAPE_POLY_SET, pcbnew.SHAPE_RECT, pcbnew.SHAPE_SEGMENT, pcbnew.SHAPE_CIRCLE, and pcbnew.SHAPE_SIMPLE.

Definition at line 6091 of file pcbnew.py.

Here is the caller graph for this function:

◆ Distance()

def pcbnew.SHAPE.Distance (   self,
  aP 
)
Distance(SHAPE self, VECTOR2I aP) -> int

Reimplemented in pcbnew.SHAPE_COMPOUND, and pcbnew.SHAPE_LINE_CHAIN.

Definition at line 6108 of file pcbnew.py.

◆ Format()

def pcbnew.SHAPE.Format (   self,
  aCplusPlus = True 
)
Format(SHAPE self, bool aCplusPlus=True) -> string

Reimplemented in pcbnew.SHAPE_CIRCLE, pcbnew.SHAPE_COMPOUND, pcbnew.SHAPE_LINE_CHAIN, pcbnew.SHAPE_POLY_SET, pcbnew.SHAPE_RECT, and pcbnew.SHAPE_SEGMENT.

Definition at line 6140 of file pcbnew.py.

◆ GetClearance()

def pcbnew.SHAPE.GetClearance (   self,
  aOther 
)
GetClearance(SHAPE self, SHAPE aOther) -> int

Definition at line 6083 of file pcbnew.py.

◆ IsNull()

def pcbnew.SHAPE.IsNull (   self)
IsNull(SHAPE self) -> bool

Definition at line 6087 of file pcbnew.py.

◆ IsSolid()

def pcbnew.SHAPE.IsSolid (   self)
IsSolid(SHAPE self) -> bool

Definition at line 6132 of file pcbnew.py.

◆ Move()

def pcbnew.SHAPE.Move (   self,
  aVector 
)
Move(SHAPE self, VECTOR2I aVector)

Definition at line 6128 of file pcbnew.py.

◆ Parse()

def pcbnew.SHAPE.Parse (   self,
  aStream 
)
Parse(SHAPE self, std::stringstream & aStream) -> bool

Definition at line 6136 of file pcbnew.py.

◆ PointInside()

def pcbnew.SHAPE.PointInside (   self,
  aPt,
  aAccuracy = 0,
  aUseBBoxCache = False 
)
PointInside(SHAPE self, VECTOR2I aPt, int aAccuracy=0, bool aUseBBoxCache=False) -> bool

Reimplemented in pcbnew.SHAPE_LINE_CHAIN_BASE, and pcbnew.SHAPE_POLY_SET.

Definition at line 6116 of file pcbnew.py.

◆ Rotate()

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

Reimplemented in pcbnew.SHAPE_CIRCLE, pcbnew.SHAPE_COMPOUND, pcbnew.SHAPE_LINE_CHAIN, pcbnew.SHAPE_POLY_SET, pcbnew.SHAPE_RECT, pcbnew.SHAPE_SEGMENT, and pcbnew.SHAPE_SIMPLE.

Definition at line 6124 of file pcbnew.py.

◆ SquaredDistance()

def pcbnew.SHAPE.SquaredDistance (   self,
  aP,
  aOutlineOnly = False 
)
SquaredDistance(SHAPE self, VECTOR2I aP, bool aOutlineOnly=False) -> SEG::ecoord

Reimplemented in pcbnew.SHAPE_POLY_SET, and pcbnew.SHAPE_LINE_CHAIN_BASE.

Definition at line 6112 of file pcbnew.py.

◆ TransformToPolygon()

def pcbnew.SHAPE.TransformToPolygon (   self,
  aBuffer,
  aError,
  aErrorLoc 
)
TransformToPolygon(SHAPE self, SHAPE_POLY_SET aBuffer, int aError, ERROR_LOC aErrorLoc)

Definition at line 6120 of file pcbnew.py.

Member Data Documentation

◆ MIN_PRECISION_IU

pcbnew.SHAPE.MIN_PRECISION_IU = _pcbnew.SHAPE_MIN_PRECISION_IU
static

Definition at line 6075 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 6070 of file pcbnew.py.


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