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

Public Member Functions

def __init__ (self, *args)
 
def BBox (self, aClearance=0)
 
def Diagonal (self)
 
def Collide (self, *args)
 
def GetPosition (self)
 
def GetSize (self)
 
def GetWidth (self)
 
def GetHeight (self)
 
def Rotate (self, *args)
 
def Outline (self)
 
def Format (self, aCplusPlus=True)
 
- 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 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)
 

Properties

 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_RECT class.

Definition at line 7259 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.SHAPE_RECT.__init__ (   self,
args 
)
    __init__(SHAPE_RECT self) -> SHAPE_RECT
    __init__(SHAPE_RECT self, BOX2I aBox) -> SHAPE_RECT
    __init__(SHAPE_RECT self, int aX0, int aY0, int aW, int aH) -> SHAPE_RECT
    __init__(SHAPE_RECT self, VECTOR2I aP0, int aW, int aH) -> SHAPE_RECT
    __init__(SHAPE_RECT self, SHAPE_RECT aOther) -> SHAPE_RECT

Reimplemented from pcbnew.SHAPE.

Definition at line 7265 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ BBox()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7275 of file pcbnew.py.

◆ Collide()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7283 of file pcbnew.py.

Here is the caller graph for this function:

◆ Diagonal()

def pcbnew.SHAPE_RECT.Diagonal (   self)
Diagonal(SHAPE_RECT self) -> int

Definition at line 7279 of file pcbnew.py.

◆ Format()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7315 of file pcbnew.py.

◆ GetHeight()

def pcbnew.SHAPE_RECT.GetHeight (   self)
GetHeight(SHAPE_RECT self) -> int

Definition at line 7303 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetPosition()

def pcbnew.SHAPE_RECT.GetPosition (   self)
GetPosition(SHAPE_RECT self) -> VECTOR2I

Definition at line 7291 of file pcbnew.py.

◆ GetSize()

def pcbnew.SHAPE_RECT.GetSize (   self)
GetSize(SHAPE_RECT self) -> VECTOR2I

Definition at line 7295 of file pcbnew.py.

◆ GetWidth()

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

Definition at line 7299 of file pcbnew.py.

Here is the caller graph for this function:

◆ Outline()

def pcbnew.SHAPE_RECT.Outline (   self)
Outline(SHAPE_RECT self) -> SHAPE_LINE_CHAIN

Definition at line 7311 of file pcbnew.py.

◆ Rotate()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7307 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 7262 of file pcbnew.py.


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