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

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def Collide (self, *args)
 
def SquaredDistance (self, aP, aOutlineOnly=False)
 
def PointInside (self, aPt, aAccuracy=0, aUseBBoxCache=False)
 
def PointOnEdge (self, aP, aAccuracy=0)
 
def EdgeContainingPoint (self, aP, aAccuracy=0)
 
def GetPoint (self, aIndex)
 
def GetSegment (self, aIndex)
 
def GetPointCount (self)
 
def GetSegmentCount (self)
 
def IsClosed (self)
 
def GetCachedBBox (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_LINE_CHAIN_BASE class.

Definition at line 5970 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from pcbnew.SHAPE.

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_SIMPLE.

Definition at line 5975 of file pcbnew.py.

Member Function Documentation

◆ Collide()

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

Reimplemented from pcbnew.SHAPE.

Reimplemented in pcbnew.SHAPE_LINE_CHAIN, and pcbnew.SHAPE_SIMPLE.

Definition at line 5980 of file pcbnew.py.

Here is the caller graph for this function:

◆ EdgeContainingPoint()

def pcbnew.SHAPE_LINE_CHAIN_BASE.EdgeContainingPoint (   self,
  aP,
  aAccuracy = 0 
)
EdgeContainingPoint(SHAPE_LINE_CHAIN_BASE self, VECTOR2I aP, int aAccuracy=0) -> int

Definition at line 5999 of file pcbnew.py.

◆ GetCachedBBox()

def pcbnew.SHAPE_LINE_CHAIN_BASE.GetCachedBBox (   self)
GetCachedBBox(SHAPE_LINE_CHAIN_BASE self) -> BOX2I

Definition at line 6023 of file pcbnew.py.

◆ GetPoint()

def pcbnew.SHAPE_LINE_CHAIN_BASE.GetPoint (   self,
  aIndex 
)
GetPoint(SHAPE_LINE_CHAIN_BASE self, int aIndex) -> VECTOR2I

Definition at line 6003 of file pcbnew.py.

◆ GetPointCount()

def pcbnew.SHAPE_LINE_CHAIN_BASE.GetPointCount (   self)
GetPointCount(SHAPE_LINE_CHAIN_BASE self) -> size_t

Definition at line 6011 of file pcbnew.py.

◆ GetSegment()

def pcbnew.SHAPE_LINE_CHAIN_BASE.GetSegment (   self,
  aIndex 
)
GetSegment(SHAPE_LINE_CHAIN_BASE self, int aIndex) -> SEG

Definition at line 6007 of file pcbnew.py.

◆ GetSegmentCount()

def pcbnew.SHAPE_LINE_CHAIN_BASE.GetSegmentCount (   self)
GetSegmentCount(SHAPE_LINE_CHAIN_BASE self) -> size_t

Definition at line 6015 of file pcbnew.py.

◆ IsClosed()

def pcbnew.SHAPE_LINE_CHAIN_BASE.IsClosed (   self)
IsClosed(SHAPE_LINE_CHAIN_BASE self) -> bool

Definition at line 6019 of file pcbnew.py.

◆ PointInside()

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

Definition at line 5991 of file pcbnew.py.

◆ PointOnEdge()

def pcbnew.SHAPE_LINE_CHAIN_BASE.PointOnEdge (   self,
  aP,
  aAccuracy = 0 
)
PointOnEdge(SHAPE_LINE_CHAIN_BASE self, VECTOR2I aP, int aAccuracy=0) -> bool

Definition at line 5995 of file pcbnew.py.

◆ SquaredDistance()

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

Definition at line 5987 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 5973 of file pcbnew.py.


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