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

Public Member Functions

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

Static Public Member Functions

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

Constructor & Destructor Documentation

◆ __init__()

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

Here is the caller graph for this function:

Member Function Documentation

◆ __eq__()

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

Definition at line 5676 of file pcbnew.py.

◆ __lt__()

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

Definition at line 5813 of file pcbnew.py.

◆ __ne__()

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

Definition at line 5680 of file pcbnew.py.

◆ Angle()

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

Definition at line 5701 of file pcbnew.py.

◆ ApproxCollinear()

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

Definition at line 5762 of file pcbnew.py.

◆ ApproxParallel()

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

Definition at line 5766 of file pcbnew.py.

◆ ApproxPerpendicular()

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

Definition at line 5770 of file pcbnew.py.

◆ CanonicalCoefs()

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

Definition at line 5754 of file pcbnew.py.

◆ Center()

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

Definition at line 5809 of file pcbnew.py.

◆ Collide()

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

Definition at line 5736 of file pcbnew.py.

◆ Collinear()

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

Definition at line 5758 of file pcbnew.py.

◆ Contains()

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

Definition at line 5794 of file pcbnew.py.

Here is the caller graph for this function:

◆ Distance()

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

Definition at line 5747 of file pcbnew.py.

Here is the caller graph for this function:

◆ Index()

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

Definition at line 5790 of file pcbnew.py.

◆ Intersect()

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

◆ IntersectLines()

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

Definition at line 5724 of file pcbnew.py.

◆ Intersects()

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

Definition at line 5720 of file pcbnew.py.

◆ Length()

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

Definition at line 5778 of file pcbnew.py.

◆ LineDistance()

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

Definition at line 5697 of file pcbnew.py.

◆ LineProject()

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

Definition at line 5689 of file pcbnew.py.

◆ NearestPoint()

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

Definition at line 5705 of file pcbnew.py.

Here is the caller graph for this function:

◆ Overlaps()

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

Definition at line 5774 of file pcbnew.py.

◆ ParallelSeg()

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

Definition at line 5732 of file pcbnew.py.

◆ PerpendicularSeg()

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

Definition at line 5728 of file pcbnew.py.

◆ ReflectPoint()

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

Definition at line 5712 of file pcbnew.py.

◆ Reverse()

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

Definition at line 5801 of file pcbnew.py.

◆ Reversed()

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

Definition at line 5805 of file pcbnew.py.

◆ Side()

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

Definition at line 5693 of file pcbnew.py.

◆ Square()

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

Definition at line 5685 of file pcbnew.py.

◆ SquaredDistance()

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

Definition at line 5740 of file pcbnew.py.

Here is the caller graph for this function:

◆ SquaredLength()

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

Definition at line 5782 of file pcbnew.py.

◆ TCoef()

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

Definition at line 5786 of file pcbnew.py.

Property Documentation

◆ A

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

Definition at line 5663 of file pcbnew.py.

◆ B

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

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


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