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)
 
"bool" Collide (self, *args)
 
"SEG::ecoord" SquaredDistance (self, "VECTOR2I" aP, "bool" aOutlineOnly=False)
 
"bool" PointInside (self, "VECTOR2I" aPt, "int" aAccuracy=0, "bool" aUseBBoxCache=False)
 
"bool" PointOnEdge (self, "VECTOR2I" aP, "int" aAccuracy=0)
 
"int" EdgeContainingPoint (self, "VECTOR2I" aP, "int" aAccuracy=0)
 
"VECTOR2I const" GetPoint (self, "int" aIndex)
 
"SEG const" GetSegment (self, "int" aIndex)
 
"size_t" GetPointCount (self)
 
"size_t" GetSegmentCount (self)
 
"bool" IsClosed (self)
 
"BOX2I *" GetCachedBBox (self)
 
- Public Member Functions inherited from pcbnew.SHAPE
def __init__ (self, *args, **kwargs)
 
"SHAPE *" Clone (self)
 
"bool" IsNull (self)
 
"bool" Collide (self, *args)
 
"BOX2I const" BBox (self, "int" aClearance=0)
 
"VECTOR2I" Centre (self)
 
"void" Rotate (self, *args)
 
"void" Move (self, "VECTOR2I" aVector)
 
"bool" IsSolid (self)
 
"bool" Parse (self, "std::stringstream &" aStream)
 
"std::string const" Format (self)
 
- Public Member Functions inherited from pcbnew.SHAPE_BASE
def __init__ (self, "SHAPE_TYPE" aType)
 
"SHAPE_TYPE" Type (self)
 
"wxString" TypeName (self)
 
"bool" HasIndexableSubshapes (self)
 
"size_t" GetIndexableSubshapeCount (self)
 
"void" GetIndexableSubshapes (self, "std::vector< SHAPE *,std::allocator< SHAPE * > > &" 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 4291 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.

Definition at line 4296 of file pcbnew.py.

Member Function Documentation

◆ Collide()

"bool" 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 const & aSeg, int aClearance=0, int * aActual=None, VECTOR2I aLocation=None) -> bool

Reimplemented from pcbnew.SHAPE.

Reimplemented in pcbnew.SHAPE_LINE_CHAIN.

Definition at line 4301 of file pcbnew.py.

Here is the caller graph for this function:

◆ EdgeContainingPoint()

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

Definition at line 4320 of file pcbnew.py.

◆ GetCachedBBox()

"BOX2I *" pcbnew.SHAPE_LINE_CHAIN_BASE.GetCachedBBox (   self)
GetCachedBBox(SHAPE_LINE_CHAIN_BASE self) -> BOX2I *

Reimplemented in pcbnew.SHAPE_LINE_CHAIN.

Definition at line 4344 of file pcbnew.py.

◆ GetPoint()

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

Reimplemented in pcbnew.SHAPE_LINE_CHAIN.

Definition at line 4324 of file pcbnew.py.

◆ GetPointCount()

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

Reimplemented in pcbnew.SHAPE_LINE_CHAIN.

Definition at line 4332 of file pcbnew.py.

◆ GetSegment()

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

Reimplemented in pcbnew.SHAPE_LINE_CHAIN.

Definition at line 4328 of file pcbnew.py.

◆ GetSegmentCount()

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

Reimplemented in pcbnew.SHAPE_LINE_CHAIN.

Definition at line 4336 of file pcbnew.py.

◆ IsClosed()

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

Reimplemented in pcbnew.SHAPE_LINE_CHAIN.

Definition at line 4340 of file pcbnew.py.

◆ PointInside()

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

Definition at line 4312 of file pcbnew.py.

◆ PointOnEdge()

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

Definition at line 4316 of file pcbnew.py.

◆ SquaredDistance()

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

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


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