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

Public Member Functions

def __init__ (self, *args)
 
def getWxPoint (self)
 
def getWxSize (self)
 
def EuclideanNorm (self)
 
def SquaredEuclideanNorm (self)
 
def Perpendicular (self)
 
def Resize (self, aNewLength)
 
def Format (self)
 
def Cross (self, aVector)
 
def Dot (self, aVector)
 
def __add__ (self, *args)
 
def __imul__ (self, *args)
 
def __iadd__ (self, *args)
 
def __sub__ (self, *args)
 
def __isub__ (self, *args)
 
def __neg__ (self)
 
def __mul__ (self, *args)
 
def __truediv__ (self, *args)
 
def __eq__ (self, aVector)
 
def __ne__ (self, aVector)
 
def __lt__ (self, aVector)
 
def __le__ (self, aVector)
 
def __gt__ (self, aVector)
 
def __ge__ (self, aVector)
 
def Set (self, x, y)
 
def Get (self)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __str__ (self)
 
def __repr__ (self)
 
def __len__ (self)
 
def __getitem__ (self, index)
 
def __setitem__ (self, index, val)
 
def __nonzero__ (self)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 x = property(_pcbnew.VECTOR2I_x_get, _pcbnew.VECTOR2I_x_set, doc=)
 
 y = property(_pcbnew.VECTOR2I_y_get, _pcbnew.VECTOR2I_y_set, doc=)
 

Detailed Description

Proxy of C++ VECTOR2< int > class.

Definition at line 5000 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.VECTOR2I.__init__ (   self,
args 
)
    __init__(VECTOR2I self) -> VECTOR2I
    __init__(VECTOR2I self, wxPoint aPoint) -> VECTOR2I
    __init__(VECTOR2I self, wxSize aSize) -> VECTOR2I
    __init__(VECTOR2I self, int x, int y) -> VECTOR2I
    __init__(VECTOR2I self, VECTOR2I aVec) -> VECTOR2I

Definition at line 5008 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __add__()

def pcbnew.VECTOR2I.__add__ (   self,
args 
)
    __add__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2I
    __add__(VECTOR2I self, int const & aScalar) -> VECTOR2I

Definition at line 5054 of file pcbnew.py.

Here is the caller graph for this function:

◆ __eq__() [1/2]

def pcbnew.VECTOR2I.__eq__ (   self,
  aVector 
)
__eq__(VECTOR2I self, VECTOR2I aVector) -> bool

Definition at line 5106 of file pcbnew.py.

◆ __eq__() [2/2]

def pcbnew.VECTOR2I.__eq__ (   self,
  other 
)

Definition at line 5138 of file pcbnew.py.

◆ __ge__()

def pcbnew.VECTOR2I.__ge__ (   self,
  aVector 
)
__ge__(VECTOR2I self, VECTOR2I aVector) -> bool

Definition at line 5126 of file pcbnew.py.

◆ __getitem__()

def pcbnew.VECTOR2I.__getitem__ (   self,
  index 
)

Definition at line 5143 of file pcbnew.py.

◆ __gt__()

def pcbnew.VECTOR2I.__gt__ (   self,
  aVector 
)
__gt__(VECTOR2I self, VECTOR2I aVector) -> bool

Definition at line 5122 of file pcbnew.py.

◆ __iadd__()

def pcbnew.VECTOR2I.__iadd__ (   self,
args 
)
    __iadd__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2I
    __iadd__(VECTOR2I self, int const & aScalar) -> VECTOR2I

Definition at line 5068 of file pcbnew.py.

Here is the caller graph for this function:

◆ __imul__()

def pcbnew.VECTOR2I.__imul__ (   self,
args 
)
    __imul__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2I
    __imul__(VECTOR2I self, int const & aScalar) -> VECTOR2I

Definition at line 5061 of file pcbnew.py.

Here is the caller graph for this function:

◆ __isub__()

def pcbnew.VECTOR2I.__isub__ (   self,
args 
)
    __isub__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2I
    __isub__(VECTOR2I self, int const & aScalar) -> VECTOR2I

Definition at line 5082 of file pcbnew.py.

Here is the caller graph for this function:

◆ __le__()

def pcbnew.VECTOR2I.__le__ (   self,
  aVector 
)
__le__(VECTOR2I self, VECTOR2I aVector) -> bool

Definition at line 5118 of file pcbnew.py.

◆ __len__()

def pcbnew.VECTOR2I.__len__ (   self)

Definition at line 5142 of file pcbnew.py.

◆ __lt__()

def pcbnew.VECTOR2I.__lt__ (   self,
  aVector 
)
__lt__(VECTOR2I self, VECTOR2I aVector) -> bool

Definition at line 5114 of file pcbnew.py.

◆ __mul__()

def pcbnew.VECTOR2I.__mul__ (   self,
args 
)
    __mul__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2< int >::extended_type
    __mul__(VECTOR2I self, int const & aFactor) -> VECTOR2I

Definition at line 5093 of file pcbnew.py.

Here is the caller graph for this function:

◆ __ne__() [1/2]

def pcbnew.VECTOR2I.__ne__ (   self,
  aVector 
)
__ne__(VECTOR2I self, VECTOR2I aVector) -> bool

Definition at line 5110 of file pcbnew.py.

◆ __ne__() [2/2]

def pcbnew.VECTOR2I.__ne__ (   self,
  other 
)

Definition at line 5139 of file pcbnew.py.

◆ __neg__()

def pcbnew.VECTOR2I.__neg__ (   self)
__neg__(VECTOR2I self) -> VECTOR2I

Definition at line 5089 of file pcbnew.py.

◆ __nonzero__()

def pcbnew.VECTOR2I.__nonzero__ (   self)

Definition at line 5151 of file pcbnew.py.

◆ __repr__()

def pcbnew.VECTOR2I.__repr__ (   self)

Definition at line 5141 of file pcbnew.py.

◆ __setitem__()

def pcbnew.VECTOR2I.__setitem__ (   self,
  index,
  val 
)

Definition at line 5144 of file pcbnew.py.

◆ __str__()

def pcbnew.VECTOR2I.__str__ (   self)

Definition at line 5140 of file pcbnew.py.

Here is the caller graph for this function:

◆ __sub__()

def pcbnew.VECTOR2I.__sub__ (   self,
args 
)
    __sub__(VECTOR2I self, VECTOR2I aVector) -> VECTOR2I
    __sub__(VECTOR2I self, int const & aScalar) -> VECTOR2I

Definition at line 5075 of file pcbnew.py.

Here is the caller graph for this function:

◆ __truediv__()

def pcbnew.VECTOR2I.__truediv__ (   self,
args 
)

Definition at line 5100 of file pcbnew.py.

◆ Cross()

def pcbnew.VECTOR2I.Cross (   self,
  aVector 
)
Cross(VECTOR2I self, VECTOR2I aVector) -> VECTOR2< int >::extended_type

Definition at line 5046 of file pcbnew.py.

◆ Dot()

def pcbnew.VECTOR2I.Dot (   self,
  aVector 
)
Dot(VECTOR2I self, VECTOR2I aVector) -> VECTOR2< int >::extended_type

Definition at line 5050 of file pcbnew.py.

◆ EuclideanNorm()

def pcbnew.VECTOR2I.EuclideanNorm (   self)
EuclideanNorm(VECTOR2I self) -> int

Definition at line 5026 of file pcbnew.py.

◆ Format()

def pcbnew.VECTOR2I.Format (   self)
Format(VECTOR2I self) -> string

Definition at line 5042 of file pcbnew.py.

◆ Get()

def pcbnew.VECTOR2I.Get (   self)
Get(VECTOR2I self) -> PyObject *

Definition at line 5134 of file pcbnew.py.

Here is the caller graph for this function:

◆ getWxPoint()

def pcbnew.VECTOR2I.getWxPoint (   self)
getWxPoint(VECTOR2I self) -> wxPoint

Definition at line 5018 of file pcbnew.py.

◆ getWxSize()

def pcbnew.VECTOR2I.getWxSize (   self)
getWxSize(VECTOR2I self) -> wxSize

Definition at line 5022 of file pcbnew.py.

◆ Perpendicular()

def pcbnew.VECTOR2I.Perpendicular (   self)
Perpendicular(VECTOR2I self) -> VECTOR2I

Definition at line 5034 of file pcbnew.py.

◆ Resize()

def pcbnew.VECTOR2I.Resize (   self,
  aNewLength 
)
Resize(VECTOR2I self, int aNewLength) -> VECTOR2I

Definition at line 5038 of file pcbnew.py.

◆ Set()

def pcbnew.VECTOR2I.Set (   self,
  x,
  y 
)
Set(VECTOR2I self, long x, long y)

Definition at line 5130 of file pcbnew.py.

◆ SquaredEuclideanNorm()

def pcbnew.VECTOR2I.SquaredEuclideanNorm (   self)
SquaredEuclideanNorm(VECTOR2I self) -> VECTOR2< int >::extended_type

Definition at line 5030 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 5003 of file pcbnew.py.

◆ x

pcbnew.VECTOR2I.x = property(_pcbnew.VECTOR2I_x_get, _pcbnew.VECTOR2I_x_set, doc=)
static

Definition at line 5005 of file pcbnew.py.

◆ y

pcbnew.VECTOR2I.y = property(_pcbnew.VECTOR2I_y_get, _pcbnew.VECTOR2I_y_set, doc=)
static

Definition at line 5006 of file pcbnew.py.


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