KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.SHAPE_RECT Class Reference
Inheritance diagram for pcbnew.SHAPE_RECT:

Public Member Functions

 __init__ (self, *args)
 
 BBox (self, aClearance=0)
 
 GetInflated (self, aOffset)
 
 Diagonal (self)
 
 MajorDimension (self)
 
 MinorDimension (self)
 
 Collide (self, *args)
 
 GetPosition (self)
 
 GetSize (self)
 
 GetHeight (self)
 
 GetRadius (self)
 
 SetRadius (self, aRadius)
 
 Rotate (self, *args)
 
 Outline (self)
 
 Format (self, aCplusPlus=True)
 
 Normalize (self)
 
- Public Member Functions inherited from pcbnew.SHAPE
 __init__ (self, *args, **kwargs)
 
 Clone (self)
 
 GetClearance (self, aOther)
 
 IsNull (self)
 
 Centre (self)
 
 Distance (self, aP)
 
 SquaredDistance (self, aP, aOutlineOnly=False)
 
 NearestPoints (self, aOther, aPtThis, aPtOther)
 
 PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False)
 
 TransformToPolygon (self, aBuffer, aError, aErrorLoc)
 
 GetStart (self)
 
 GetEnd (self)
 
 GetWidth (self)
 
 SetWidth (self, aWidth)
 
 Move (self, aVector)
 
 IsSolid (self)
 
 Parse (self, aStream)
 
 Cast (self)
 
- Public Member Functions inherited from pcbnew.SHAPE_BASE
 __init__ (self, aType)
 
 Type (self)
 
 TypeName (self)
 
 HasIndexableSubshapes (self)
 
 GetIndexableSubshapeCount (self)
 
 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 7264 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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, VECTOR2I aP0, VECTOR2I aP1) -> SHAPE_RECT
    __init__(SHAPE_RECT self, SHAPE_RECT aOther) -> SHAPE_RECT

Definition at line 7270 of file pcbnew.py.

Member Function Documentation

◆ BBox()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7281 of file pcbnew.py.

◆ Collide()

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 7301 of file pcbnew.py.

◆ Diagonal()

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

Definition at line 7289 of file pcbnew.py.

◆ Format()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7337 of file pcbnew.py.

◆ GetHeight()

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

Definition at line 7317 of file pcbnew.py.

◆ GetInflated()

pcbnew.SHAPE_RECT.GetInflated ( self,
aOffset )
GetInflated(SHAPE_RECT self, int aOffset) -> SHAPE_RECT

Definition at line 7285 of file pcbnew.py.

◆ GetPosition()

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

Definition at line 7309 of file pcbnew.py.

◆ GetRadius()

pcbnew.SHAPE_RECT.GetRadius ( self)
GetRadius(SHAPE_RECT self) -> int

Definition at line 7321 of file pcbnew.py.

◆ GetSize()

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

Definition at line 7313 of file pcbnew.py.

◆ MajorDimension()

pcbnew.SHAPE_RECT.MajorDimension ( self)
MajorDimension(SHAPE_RECT self) -> int

Definition at line 7293 of file pcbnew.py.

◆ MinorDimension()

pcbnew.SHAPE_RECT.MinorDimension ( self)
MinorDimension(SHAPE_RECT self) -> int

Definition at line 7297 of file pcbnew.py.

◆ Normalize()

pcbnew.SHAPE_RECT.Normalize ( self)
Normalize(SHAPE_RECT self)

Definition at line 7341 of file pcbnew.py.

◆ Outline()

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

Definition at line 7333 of file pcbnew.py.

◆ Rotate()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 7329 of file pcbnew.py.

◆ SetRadius()

pcbnew.SHAPE_RECT.SetRadius ( self,
aRadius )
SetRadius(SHAPE_RECT self, int aRadius)

Definition at line 7325 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 7267 of file pcbnew.py.


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