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

Public Member Functions

 __init__ (self, *args)
 
 __eq__ (self, aSeg)
 
 __ne__ (self, aSeg)
 
 LineProject (self, aP)
 
 Side (self, aP)
 
 LineDistance (self, aP, aDetermineSide=False)
 
 Angle (self, aOther)
 
 NearestPoint (self, *args)
 
 NearestPoints (self, aSeg, aPtA, aPtB, aDistSq)
 
 ReflectPoint (self, aP)
 
 Intersect (self, aSeg, aIgnoreEndpoints=False, aLines=False)
 
 Intersects (self, aSeg)
 
 IntersectLines (self, aSeg)
 
 IntersectsLine (self, aSlope, aOffset, aIntersection)
 
 PerpendicularSeg (self, aP)
 
 ParallelSeg (self, aP)
 
 Collide (self, aSeg, aClearance, aActual=None)
 
 SquaredDistance (self, *args)
 
 Distance (self, *args)
 
 CanonicalCoefs (self, qA, qB, qC)
 
 Collinear (self, aSeg)
 
 ApproxCollinear (self, aSeg, aDistanceThreshold=1)
 
 ApproxParallel (self, aSeg, aDistanceThreshold=1)
 
 ApproxPerpendicular (self, aSeg)
 
 Overlaps (self, aSeg)
 
 Length (self)
 
 SquaredLength (self)
 
 TCoef (self, aP)
 
 Index (self)
 
 Contains (self, *args)
 
 Reverse (self)
 
 Reversed (self)
 
 Center (self)
 
 __lt__ (self, aSeg)
 

Static Public Member Functions

 Square (a)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 A = property(_pcbnew.SEG_A_get, _pcbnew.SEG_A_set, doc=)
 
 B = property(_pcbnew.SEG_B_get, _pcbnew.SEG_B_set, doc=)
 

Detailed Description

Proxy of C++ SEG class.

Definition at line 5794 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.SEG.__init__ ( self,
* args )
    __init__(SEG self) -> SEG
    __init__(SEG self, int aX1, int aY1, int aX2, int aY2) -> SEG
    __init__(SEG self, VECTOR2I aA, VECTOR2I aB) -> SEG
    __init__(SEG self, VECTOR2I aA, VECTOR2I aB, int aIndex) -> SEG
    __init__(SEG self, SEG aSeg) -> SEG

Definition at line 5802 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

pcbnew.SEG.__eq__ ( self,
aSeg )
__eq__(SEG self, SEG aSeg) -> bool

Definition at line 5812 of file pcbnew.py.

◆ __lt__()

pcbnew.SEG.__lt__ ( self,
aSeg )
__lt__(SEG self, SEG aSeg) -> bool

Definition at line 5957 of file pcbnew.py.

◆ __ne__()

pcbnew.SEG.__ne__ ( self,
aSeg )
__ne__(SEG self, SEG aSeg) -> bool

Definition at line 5816 of file pcbnew.py.

◆ Angle()

pcbnew.SEG.Angle ( self,
aOther )
Angle(SEG self, SEG aOther) -> EDA_ANGLE

Definition at line 5837 of file pcbnew.py.

◆ ApproxCollinear()

pcbnew.SEG.ApproxCollinear ( self,
aSeg,
aDistanceThreshold = 1 )
ApproxCollinear(SEG self, SEG aSeg, int aDistanceThreshold=1) -> bool

Definition at line 5906 of file pcbnew.py.

◆ ApproxParallel()

pcbnew.SEG.ApproxParallel ( self,
aSeg,
aDistanceThreshold = 1 )
ApproxParallel(SEG self, SEG aSeg, int aDistanceThreshold=1) -> bool

Definition at line 5910 of file pcbnew.py.

◆ ApproxPerpendicular()

pcbnew.SEG.ApproxPerpendicular ( self,
aSeg )
ApproxPerpendicular(SEG self, SEG aSeg) -> bool

Definition at line 5914 of file pcbnew.py.

◆ CanonicalCoefs()

pcbnew.SEG.CanonicalCoefs ( self,
qA,
qB,
qC )
CanonicalCoefs(SEG self, SEG::ecoord & qA, SEG::ecoord & qB, SEG::ecoord & qC)

Definition at line 5898 of file pcbnew.py.

◆ Center()

pcbnew.SEG.Center ( self)
Center(SEG self) -> VECTOR2I

Definition at line 5953 of file pcbnew.py.

◆ Collide()

pcbnew.SEG.Collide ( self,
aSeg,
aClearance,
aActual = None )
Collide(SEG self, SEG aSeg, int aClearance, int * aActual=None) -> bool

Definition at line 5880 of file pcbnew.py.

◆ Collinear()

pcbnew.SEG.Collinear ( self,
aSeg )
Collinear(SEG self, SEG aSeg) -> bool

Definition at line 5902 of file pcbnew.py.

◆ Contains()

pcbnew.SEG.Contains ( self,
* args )
    Contains(SEG self, SEG aSeg) -> bool
    Contains(SEG self, VECTOR2I aP) -> bool

Definition at line 5938 of file pcbnew.py.

◆ Distance()

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

Definition at line 5891 of file pcbnew.py.

◆ Index()

pcbnew.SEG.Index ( self)
Index(SEG self) -> int

Definition at line 5934 of file pcbnew.py.

◆ Intersect()

pcbnew.SEG.Intersect ( self,
aSeg,
aIgnoreEndpoints = False,
aLines = False )
Intersect(SEG self, SEG aSeg, bool aIgnoreEndpoints=False, bool aLines=False) -> OPT_VECTOR2I

Definition at line 5856 of file pcbnew.py.

◆ IntersectLines()

pcbnew.SEG.IntersectLines ( self,
aSeg )
IntersectLines(SEG self, SEG aSeg) -> OPT_VECTOR2I

Definition at line 5864 of file pcbnew.py.

◆ Intersects()

pcbnew.SEG.Intersects ( self,
aSeg )
Intersects(SEG self, SEG aSeg) -> bool

Definition at line 5860 of file pcbnew.py.

◆ IntersectsLine()

pcbnew.SEG.IntersectsLine ( self,
aSlope,
aOffset,
aIntersection )
IntersectsLine(SEG self, double aSlope, double aOffset, VECTOR2I aIntersection) -> bool

Definition at line 5868 of file pcbnew.py.

◆ Length()

pcbnew.SEG.Length ( self)
Length(SEG self) -> int

Definition at line 5922 of file pcbnew.py.

◆ LineDistance()

pcbnew.SEG.LineDistance ( self,
aP,
aDetermineSide = False )
LineDistance(SEG self, VECTOR2I aP, bool aDetermineSide=False) -> int

Definition at line 5833 of file pcbnew.py.

◆ LineProject()

pcbnew.SEG.LineProject ( self,
aP )
LineProject(SEG self, VECTOR2I aP) -> VECTOR2I

Definition at line 5825 of file pcbnew.py.

◆ NearestPoint()

pcbnew.SEG.NearestPoint ( self,
* args )
    NearestPoint(SEG self, VECTOR2I aP) -> VECTOR2I
    NearestPoint(SEG self, SEG aSeg) -> VECTOR2I

Definition at line 5841 of file pcbnew.py.

◆ NearestPoints()

pcbnew.SEG.NearestPoints ( self,
aSeg,
aPtA,
aPtB,
aDistSq )
NearestPoints(SEG self, SEG aSeg, VECTOR2I aPtA, VECTOR2I aPtB, int64_t & aDistSq) -> bool

Definition at line 5848 of file pcbnew.py.

◆ Overlaps()

pcbnew.SEG.Overlaps ( self,
aSeg )
Overlaps(SEG self, SEG aSeg) -> bool

Definition at line 5918 of file pcbnew.py.

◆ ParallelSeg()

pcbnew.SEG.ParallelSeg ( self,
aP )
ParallelSeg(SEG self, VECTOR2I aP) -> SEG

Definition at line 5876 of file pcbnew.py.

◆ PerpendicularSeg()

pcbnew.SEG.PerpendicularSeg ( self,
aP )
PerpendicularSeg(SEG self, VECTOR2I aP) -> SEG

Definition at line 5872 of file pcbnew.py.

◆ ReflectPoint()

pcbnew.SEG.ReflectPoint ( self,
aP )
ReflectPoint(SEG self, VECTOR2I aP) -> VECTOR2I

Definition at line 5852 of file pcbnew.py.

◆ Reverse()

pcbnew.SEG.Reverse ( self)
Reverse(SEG self)

Definition at line 5945 of file pcbnew.py.

◆ Reversed()

pcbnew.SEG.Reversed ( self)
Reversed(SEG self) -> SEG

Definition at line 5949 of file pcbnew.py.

◆ Side()

pcbnew.SEG.Side ( self,
aP )
Side(SEG self, VECTOR2I aP) -> int

Definition at line 5829 of file pcbnew.py.

◆ Square()

pcbnew.SEG.Square ( a)
static
Square(int a) -> SEG::ecoord

Definition at line 5821 of file pcbnew.py.

◆ SquaredDistance()

pcbnew.SEG.SquaredDistance ( self,
* args )
    SquaredDistance(SEG self, SEG aSeg) -> SEG::ecoord
    SquaredDistance(SEG self, VECTOR2I aP) -> SEG::ecoord

Definition at line 5884 of file pcbnew.py.

◆ SquaredLength()

pcbnew.SEG.SquaredLength ( self)
SquaredLength(SEG self) -> SEG::ecoord

Definition at line 5926 of file pcbnew.py.

◆ TCoef()

pcbnew.SEG.TCoef ( self,
aP )
TCoef(SEG self, VECTOR2I aP) -> SEG::ecoord

Definition at line 5930 of file pcbnew.py.

Property Documentation

◆ A

pcbnew.SEG.A = property(_pcbnew.SEG_A_get, _pcbnew.SEG_A_set, doc=)
static

Definition at line 5799 of file pcbnew.py.

◆ B

pcbnew.SEG.B = property(_pcbnew.SEG_B_get, _pcbnew.SEG_B_set, doc=)
static

Definition at line 5800 of file pcbnew.py.

◆ thisown

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

Definition at line 5797 of file pcbnew.py.


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