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

Public Member Functions

def __init__ (self, *args)
 
def Clone (self)
 
def Format (self, aCplusPlus=True)
 
def Collide (self, *args)
 
def Shapes (self)
 
def BBox (self, aClearance=0)
 
def Distance (self, aSeg)
 
def AddShape (self, *args)
 
def Empty (self)
 
def Size (self)
 
def Rotate (self, *args)
 
def UniqueSubshape (self)
 
def ConvertToSimplePolygon (self, aOut)
 
def GetSubshapes (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
 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 6210 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def 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

Reimplemented from pcbnew.SHAPE.

Definition at line 6216 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ AddShape()

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

Definition at line 6253 of file pcbnew.py.

Here is the caller graph for this function:

◆ BBox()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6245 of file pcbnew.py.

◆ Clone()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6225 of file pcbnew.py.

◆ Collide()

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

Here is the caller graph for this function:

◆ ConvertToSimplePolygon()

def pcbnew.SHAPE_COMPOUND.ConvertToSimplePolygon (   self,
  aOut 
)
ConvertToSimplePolygon(SHAPE_COMPOUND self, SHAPE_SIMPLE aOut) -> bool

Definition at line 6276 of file pcbnew.py.

◆ Distance()

def pcbnew.SHAPE_COMPOUND.Distance (   self,
  aSeg 
)
Distance(SHAPE_COMPOUND self, SEG aSeg) -> int

Definition at line 6249 of file pcbnew.py.

◆ Empty()

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

Definition at line 6260 of file pcbnew.py.

◆ Format()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6229 of file pcbnew.py.

◆ GetSubshapes()

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

Definition at line 6280 of file pcbnew.py.

◆ Rotate()

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

Reimplemented from pcbnew.SHAPE.

Definition at line 6268 of file pcbnew.py.

◆ Shapes()

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

Definition at line 6241 of file pcbnew.py.

◆ Size()

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

Definition at line 6264 of file pcbnew.py.

◆ UniqueSubshape()

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

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


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