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

Public Member Functions

 __init__ (self, *args)
 
 Clone (self)
 
 Format (self, aCplusPlus=True)
 
 Collide (self, *args)
 
 Shapes (self)
 
 BBox (self, aClearance=0)
 
 Distance (self, *args)
 
 AddShape (self, *args)
 
 Empty (self)
 
 Size (self)
 
 Rotate (self, *args)
 
 UniqueSubshape (self)
 
 GetSubshapes (self)
 
- Public Member Functions inherited from pcbnew.SHAPE
 __init__ (self, *args, **kwargs)
 
 GetClearance (self, aOther)
 
 IsNull (self)
 
 Centre (self)
 
 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_COMPOUND class.

Definition at line 6392 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.SHAPE_COMPOUND.__init__ ( self,
* args )
    __init__(SHAPE_COMPOUND self) -> SHAPE_COMPOUND
    __init__(SHAPE_COMPOUND self, std::vector< SHAPE *,std::allocator< SHAPE * > > const & aShapes) -> SHAPE_COMPOUND
    __init__(SHAPE_COMPOUND self, SHAPE_COMPOUND aOther) -> SHAPE_COMPOUND

Definition at line 6398 of file pcbnew.py.

Member Function Documentation

◆ AddShape()

pcbnew.SHAPE_COMPOUND.AddShape ( self,
* args )
    AddShape(SHAPE_COMPOUND self, SHAPE aShape)
    AddShape(SHAPE_COMPOUND self, std::shared_ptr< SHAPE > aShape)

Definition at line 6438 of file pcbnew.py.

◆ BBox()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6427 of file pcbnew.py.

◆ Clone()

pcbnew.SHAPE_COMPOUND.Clone ( self)
Clone(SHAPE_COMPOUND self) -> SHAPE_COMPOUND

Reimplemented from pcbnew.SHAPE.

Definition at line 6407 of file pcbnew.py.

◆ Collide()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6415 of file pcbnew.py.

◆ Distance()

pcbnew.SHAPE_COMPOUND.Distance ( self,
* args )
    Distance(SHAPE_COMPOUND self, VECTOR2I aP) -> int
    Distance(SHAPE_COMPOUND self, SEG aSeg) -> int

Reimplemented from pcbnew.SHAPE.

Definition at line 6431 of file pcbnew.py.

◆ Empty()

pcbnew.SHAPE_COMPOUND.Empty ( self)
Empty(SHAPE_COMPOUND self) -> bool

Definition at line 6445 of file pcbnew.py.

◆ Format()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6411 of file pcbnew.py.

◆ GetSubshapes()

pcbnew.SHAPE_COMPOUND.GetSubshapes ( self)
GetSubshapes(SHAPE_COMPOUND self) -> VECTOR_SHAPEPTR

Definition at line 6461 of file pcbnew.py.

◆ Rotate()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6453 of file pcbnew.py.

◆ Shapes()

pcbnew.SHAPE_COMPOUND.Shapes ( self)
Shapes(SHAPE_COMPOUND self) -> std::vector< SHAPE *,std::allocator< SHAPE * > > const &

Definition at line 6423 of file pcbnew.py.

◆ Size()

pcbnew.SHAPE_COMPOUND.Size ( self)
Size(SHAPE_COMPOUND self) -> int

Definition at line 6449 of file pcbnew.py.

◆ UniqueSubshape()

pcbnew.SHAPE_COMPOUND.UniqueSubshape ( self)
UniqueSubshape(SHAPE_COMPOUND self) -> SHAPE

Definition at line 6457 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 6395 of file pcbnew.py.


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