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)
 
"wxPoint" getWxPoint (self)
 
"int" EuclideanNorm (self)
 
"VECTOR2< int >::extended_type" SquaredEuclideanNorm (self)
 
"VECTOR2< int >" Perpendicular (self)
 
"VECTOR2< int >" Resize (self, "int" aNewLength)
 
"double" Angle (self)
 
"VECTOR2< int >" Rotate (self, "double" aAngle)
 
"std::string const" Format (self)
 
"VECTOR2< int >::extended_type" Cross (self, "VECTOR2I" aVector)
 
"VECTOR2< int >::extended_type" Dot (self, "VECTOR2I" aVector)
 
"VECTOR2< int >" __add__ (self, *args)
 
"VECTOR2< int > &" __iadd__ (self, *args)
 
"VECTOR2< int >" __sub__ (self, *args)
 
"VECTOR2< int > &" __isub__ (self, *args)
 
"VECTOR2< int >" __neg__ (self)
 
"VECTOR2< int >" __mul__ (self, *args)
 
def __truediv__ (self, *args)
 
"bool" __eq__ (self, "VECTOR2I" aVector)
 
"bool" __ne__ (self, "VECTOR2I" aVector)
 
"bool" __lt__ (self, "VECTOR2I" aVector)
 
"bool" __le__ (self, "VECTOR2I" aVector)
 
"bool" __gt__ (self, "VECTOR2I" aVector)
 
"bool" __ge__ (self, "VECTOR2I" aVector)
 
"void" Set (self, "long" x, "long" y)
 
"PyObject *" 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 4351 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 4359 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __add__()

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

Definition at line 4409 of file pcbnew.py.

Here is the caller graph for this function:

◆ __eq__() [1/2]

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

Definition at line 4454 of file pcbnew.py.

◆ __eq__() [2/2]

def pcbnew.VECTOR2I.__eq__ (   self,
  other 
)

Definition at line 4486 of file pcbnew.py.

◆ __ge__()

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

Definition at line 4474 of file pcbnew.py.

◆ __getitem__()

def pcbnew.VECTOR2I.__getitem__ (   self,
  index 
)

Definition at line 4491 of file pcbnew.py.

◆ __gt__()

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

Definition at line 4470 of file pcbnew.py.

◆ __iadd__()

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

Definition at line 4416 of file pcbnew.py.

Here is the caller graph for this function:

◆ __isub__()

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

Definition at line 4430 of file pcbnew.py.

Here is the caller graph for this function:

◆ __le__()

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

Definition at line 4466 of file pcbnew.py.

◆ __len__()

def pcbnew.VECTOR2I.__len__ (   self)

Definition at line 4490 of file pcbnew.py.

◆ __lt__()

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

Definition at line 4462 of file pcbnew.py.

◆ __mul__()

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

Definition at line 4441 of file pcbnew.py.

Here is the caller graph for this function:

◆ __ne__() [1/2]

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

Definition at line 4458 of file pcbnew.py.

◆ __ne__() [2/2]

def pcbnew.VECTOR2I.__ne__ (   self,
  other 
)

Definition at line 4487 of file pcbnew.py.

◆ __neg__()

"VECTOR2< int >" pcbnew.VECTOR2I.__neg__ (   self)
__neg__(VECTOR2I self) -> VECTOR2I

Definition at line 4437 of file pcbnew.py.

◆ __nonzero__()

def pcbnew.VECTOR2I.__nonzero__ (   self)

Definition at line 4499 of file pcbnew.py.

◆ __repr__()

def pcbnew.VECTOR2I.__repr__ (   self)

Definition at line 4489 of file pcbnew.py.

◆ __setitem__()

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

Definition at line 4492 of file pcbnew.py.

◆ __str__()

def pcbnew.VECTOR2I.__str__ (   self)

Definition at line 4488 of file pcbnew.py.

Here is the caller graph for this function:

◆ __sub__()

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

Definition at line 4423 of file pcbnew.py.

Here is the caller graph for this function:

◆ __truediv__()

def pcbnew.VECTOR2I.__truediv__ (   self,
args 
)

Definition at line 4448 of file pcbnew.py.

◆ Angle()

"double" pcbnew.VECTOR2I.Angle (   self)
Angle(VECTOR2I self) -> double

Definition at line 4389 of file pcbnew.py.

◆ Cross()

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

Definition at line 4401 of file pcbnew.py.

◆ Dot()

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

Definition at line 4405 of file pcbnew.py.

◆ EuclideanNorm()

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

Definition at line 4373 of file pcbnew.py.

◆ Format()

"std.string const" pcbnew.VECTOR2I.Format (   self)
Format(VECTOR2I self) -> string

Definition at line 4397 of file pcbnew.py.

◆ Get()

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

Definition at line 4482 of file pcbnew.py.

Here is the caller graph for this function:

◆ getWxPoint()

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

Definition at line 4369 of file pcbnew.py.

◆ Perpendicular()

"VECTOR2< int >" pcbnew.VECTOR2I.Perpendicular (   self)
Perpendicular(VECTOR2I self) -> VECTOR2I

Definition at line 4381 of file pcbnew.py.

◆ Resize()

"VECTOR2< int >" pcbnew.VECTOR2I.Resize (   self,
"int"  aNewLength 
)
Resize(VECTOR2I self, int aNewLength) -> VECTOR2I

Definition at line 4385 of file pcbnew.py.

◆ Rotate()

"VECTOR2< int >" pcbnew.VECTOR2I.Rotate (   self,
"double"  aAngle 
)
Rotate(VECTOR2I self, double aAngle) -> VECTOR2I

Definition at line 4393 of file pcbnew.py.

◆ Set()

"void" pcbnew.VECTOR2I.Set (   self,
"long"  x,
"long"  y 
)
Set(VECTOR2I self, long x, long y)

Definition at line 4478 of file pcbnew.py.

◆ SquaredEuclideanNorm()

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

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

◆ x

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

Definition at line 4356 of file pcbnew.py.

◆ y

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

Definition at line 4357 of file pcbnew.py.


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