Inheritance diagram for pcbnew.BOX2I:

Public Member Functions
def	__init__ (self, *args)

def	SetMaximum (self)

def	Centre (self)

def	Move (self, aMoveVector)

def	Normalize (self)

def	Contains (self, *args)

def	GetSize (self)

def	GetX (self)

def	GetY (self)

def	GetOrigin (self)

def	GetPosition (self)

def	GetEnd (self)

def	GetWidth (self)

def	GetHeight (self)

def	GetRight (self)

def	GetBottom (self)

def	GetLeft (self)

def	GetTop (self)

def	GetCenter (self)

def	GetSizeMax (self)

def	SetOrigin (self, *args)

def	SetSize (self, *args)

def	Offset (self, *args)

def	SetX (self, val)

def	SetY (self, val)

def	SetWidth (self, val)

def	SetHeight (self, val)

def	SetEnd (self, *args)

def	Intersect (self, aRect)

def	Intersects (self, *args)

def	IntersectsCircle (self, aCenter, aRadius)

def	IntersectsCircleEdge (self, aCenter, aRadius, aWidth)

def	Format (self)

def	Inflate (self, *args)

def	Merge (self, *args)

def	GetBoundingBoxRotated (self, aRotCenter, aAngle)

def	GetArea (self)

def	Diagonal (self)

def	SquaredDistance (self, *args)

def	Distance (self, *args)

def	ClosestPointTo (self, aPoint)

def	FarthestPointTo (self, aPoint)

def	__eq__ (self, aOther)

def	__ne__ (self, aOther)

def	IsValid (self)

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

Detailed Description

Proxy of C++ BOX2< VECTOR2I > class.

Definition at line 5413 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

def pcbnew.BOX2I.__init__	(		self,
		*	args
	)

    __init__(BOX2I self) -> BOX2I
    __init__(BOX2I self, VECTOR2I aPos, VECTOR2L aSize=BOX2< VECTOR2I >::SizeVec(0, 0)) -> BOX2I

Definition at line 5419 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ eq()

def pcbnew.BOX2I.__eq__	(	self,
		aOther
	)

__eq__(BOX2I self, BOX2I aOther) -> bool

Definition at line 5622 of file pcbnew.py.

◆ ne()

def pcbnew.BOX2I.__ne__	(	self,
		aOther
	)

__ne__(BOX2I self, BOX2I aOther) -> bool

Definition at line 5626 of file pcbnew.py.

◆ Centre()

def pcbnew.BOX2I.Centre ( self )

Centre(BOX2I self) -> VECTOR2I

Definition at line 5430 of file pcbnew.py.

◆ ClosestPointTo()

def pcbnew.BOX2I.ClosestPointTo	(	self,
		aPoint
	)

ClosestPointTo(BOX2I self, VECTOR2I aPoint) -> VECTOR2I

Definition at line 5614 of file pcbnew.py.

◆ Contains()

def pcbnew.BOX2I.Contains	(		self,
		*	args
	)

    Contains(BOX2I self, VECTOR2I aPoint) -> bool
    Contains(BOX2I self, BOX2< VECTOR2< int > >::coord_type x, BOX2< VECTOR2< int > >::coord_type y) -> bool
    Contains(BOX2I self, BOX2I aRect) -> bool

Definition at line 5442 of file pcbnew.py.

Here is the caller graph for this function:

◆ Diagonal()

def pcbnew.BOX2I.Diagonal ( self )

Diagonal(BOX2I self) -> BOX2< VECTOR2< int > >::ecoord_type

Definition at line 5596 of file pcbnew.py.

◆ Distance()

def pcbnew.BOX2I.Distance	(		self,
		*	args
	)

    Distance(BOX2I self, VECTOR2I aP) -> BOX2< VECTOR2< int > >::ecoord_type
    Distance(BOX2I self, BOX2I aBox) -> BOX2< VECTOR2< int > >::ecoord_type

Definition at line 5607 of file pcbnew.py.

Here is the caller graph for this function:

◆ FarthestPointTo()

def pcbnew.BOX2I.FarthestPointTo	(	self,
		aPoint
	)

FarthestPointTo(BOX2I self, VECTOR2I aPoint) -> VECTOR2I

Definition at line 5618 of file pcbnew.py.

◆ Format()

def pcbnew.BOX2I.Format ( self )

Format(BOX2I self) -> string

Definition at line 5570 of file pcbnew.py.

◆ GetArea()

def pcbnew.BOX2I.GetArea ( self )

GetArea(BOX2I self) -> BOX2< VECTOR2< int > >::ecoord_type

Definition at line 5592 of file pcbnew.py.

◆ GetBottom()

def pcbnew.BOX2I.GetBottom ( self )

GetBottom(BOX2I self) -> BOX2< VECTOR2< int > >::coord_type

Definition at line 5486 of file pcbnew.py.

◆ GetBoundingBoxRotated()

def pcbnew.BOX2I.GetBoundingBoxRotated	(	self,
		aRotCenter,
		aAngle
	)

GetBoundingBoxRotated(BOX2I self, VECTOR2I aRotCenter, EDA_ANGLE aAngle) -> BOX2I

Definition at line 5588 of file pcbnew.py.

◆ GetCenter()

def pcbnew.BOX2I.GetCenter ( self )

GetCenter(BOX2I self) -> VECTOR2I

Definition at line 5498 of file pcbnew.py.

◆ GetEnd()

def pcbnew.BOX2I.GetEnd ( self )

GetEnd(BOX2I self) -> VECTOR2I

Definition at line 5470 of file pcbnew.py.

◆ GetHeight()

def pcbnew.BOX2I.GetHeight ( self )

GetHeight(BOX2I self) -> BOX2< VECTOR2< int > >::size_type

Definition at line 5478 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetLeft()

def pcbnew.BOX2I.GetLeft ( self )

GetLeft(BOX2I self) -> BOX2< VECTOR2< int > >::coord_type

Definition at line 5490 of file pcbnew.py.

◆ GetOrigin()

def pcbnew.BOX2I.GetOrigin ( self )

GetOrigin(BOX2I self) -> VECTOR2I

Definition at line 5462 of file pcbnew.py.

◆ GetPosition()

def pcbnew.BOX2I.GetPosition ( self )

GetPosition(BOX2I self) -> VECTOR2I

Definition at line 5466 of file pcbnew.py.

◆ GetRight()

def pcbnew.BOX2I.GetRight ( self )

GetRight(BOX2I self) -> BOX2< VECTOR2< int > >::coord_type

Definition at line 5482 of file pcbnew.py.

◆ GetSize()

def pcbnew.BOX2I.GetSize ( self )

GetSize(BOX2I self) -> VECTOR2L

Definition at line 5450 of file pcbnew.py.

◆ GetSizeMax()

def pcbnew.BOX2I.GetSizeMax ( self )

GetSizeMax(BOX2I self) -> int

Definition at line 5502 of file pcbnew.py.

◆ GetTop()

def pcbnew.BOX2I.GetTop ( self )

GetTop(BOX2I self) -> BOX2< VECTOR2< int > >::coord_type

Definition at line 5494 of file pcbnew.py.

◆ GetWidth()

def pcbnew.BOX2I.GetWidth ( self )

GetWidth(BOX2I self) -> BOX2< VECTOR2< int > >::size_type

Definition at line 5474 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetX()

def pcbnew.BOX2I.GetX ( self )

GetX(BOX2I self) -> BOX2< VECTOR2< int > >::coord_type

Definition at line 5454 of file pcbnew.py.

◆ GetY()

def pcbnew.BOX2I.GetY ( self )

GetY(BOX2I self) -> BOX2< VECTOR2< int > >::coord_type

Definition at line 5458 of file pcbnew.py.

◆ Inflate()

def pcbnew.BOX2I.Inflate	(		self,
		*	args
	)

    Inflate(BOX2I self, BOX2< VECTOR2< int > >::coord_type dx, BOX2< VECTOR2< int > >::coord_type dy) -> BOX2I
    Inflate(BOX2I self, int aDelta) -> BOX2I

Definition at line 5574 of file pcbnew.py.

Here is the caller graph for this function:

◆ Intersect()

def pcbnew.BOX2I.Intersect	(	self,
		aRect
	)

Intersect(BOX2I self, BOX2I aRect) -> BOX2I

Definition at line 5550 of file pcbnew.py.

◆ Intersects()

def pcbnew.BOX2I.Intersects	(		self,
		*	args
	)

    Intersects(BOX2I self, BOX2I aRect) -> bool
    Intersects(BOX2I self, VECTOR2I aPoint1, VECTOR2I aPoint2) -> bool
    Intersects(BOX2I self, BOX2I aRect, EDA_ANGLE aRotation) -> bool

Definition at line 5554 of file pcbnew.py.

Here is the caller graph for this function:

◆ IntersectsCircle()

def pcbnew.BOX2I.IntersectsCircle	(	self,
		aCenter,
		aRadius
	)

IntersectsCircle(BOX2I self, VECTOR2I aCenter, int const aRadius) -> bool

Definition at line 5562 of file pcbnew.py.

◆ IntersectsCircleEdge()

def pcbnew.BOX2I.IntersectsCircleEdge	(	self,
		aCenter,
		aRadius,
		aWidth
	)

IntersectsCircleEdge(BOX2I self, VECTOR2I aCenter, int const aRadius, int const aWidth) -> bool

Definition at line 5566 of file pcbnew.py.

◆ IsValid()

def pcbnew.BOX2I.IsValid ( self )

IsValid(BOX2I self) -> bool

Definition at line 5630 of file pcbnew.py.

◆ Merge()

def pcbnew.BOX2I.Merge	(		self,
		*	args
	)

    Merge(BOX2I self, BOX2I aRect) -> BOX2I
    Merge(BOX2I self, VECTOR2I aPoint) -> BOX2I

Definition at line 5581 of file pcbnew.py.

Here is the caller graph for this function:

◆ Move()

def pcbnew.BOX2I.Move	(	self,
		aMoveVector
	)

Move(BOX2I self, VECTOR2I aMoveVector)

Definition at line 5434 of file pcbnew.py.

◆ Normalize()

def pcbnew.BOX2I.Normalize ( self )

Normalize(BOX2I self) -> BOX2I

Definition at line 5438 of file pcbnew.py.

◆ Offset()

def pcbnew.BOX2I.Offset	(		self,
		*	args
	)

    Offset(BOX2I self, BOX2< VECTOR2< int > >::coord_type dx, BOX2< VECTOR2< int > >::coord_type dy)
    Offset(BOX2I self, VECTOR2I offset)

Definition at line 5520 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetEnd()

def pcbnew.BOX2I.SetEnd	(		self,
		*	args
	)

    SetEnd(BOX2I self, BOX2< VECTOR2< int > >::coord_type x, BOX2< VECTOR2< int > >::coord_type y)
    SetEnd(BOX2I self, VECTOR2I pos)

Definition at line 5543 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetHeight()

def pcbnew.BOX2I.SetHeight	(	self,
		val
	)

SetHeight(BOX2I self, BOX2< VECTOR2< int > >::size_type val)

Definition at line 5539 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetMaximum()

def pcbnew.BOX2I.SetMaximum ( self )

SetMaximum(BOX2I self)

Definition at line 5426 of file pcbnew.py.

◆ SetOrigin()

def pcbnew.BOX2I.SetOrigin	(		self,
		*	args
	)

    SetOrigin(BOX2I self, VECTOR2I pos)
    SetOrigin(BOX2I self, BOX2< VECTOR2< int > >::coord_type x, BOX2< VECTOR2< int > >::coord_type y)

Definition at line 5506 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetSize()

def pcbnew.BOX2I.SetSize	(		self,
		*	args
	)

    SetSize(BOX2I self, VECTOR2L size)
    SetSize(BOX2I self, BOX2< VECTOR2< int > >::size_type w, BOX2< VECTOR2< int > >::size_type h)

Definition at line 5513 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetWidth()

def pcbnew.BOX2I.SetWidth	(	self,
		val
	)

SetWidth(BOX2I self, BOX2< VECTOR2< int > >::size_type val)

Definition at line 5535 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetX()

def pcbnew.BOX2I.SetX	(	self,
		val
	)

SetX(BOX2I self, BOX2< VECTOR2< int > >::coord_type val)

Definition at line 5527 of file pcbnew.py.

Here is the caller graph for this function:

◆ SetY()

def pcbnew.BOX2I.SetY	(	self,
		val
	)

SetY(BOX2I self, BOX2< VECTOR2< int > >::coord_type val)

Definition at line 5531 of file pcbnew.py.

Here is the caller graph for this function:

◆ SquaredDistance()

def pcbnew.BOX2I.SquaredDistance	(		self,
		*	args
	)

    SquaredDistance(BOX2I self, VECTOR2I aP) -> BOX2< VECTOR2< int > >::ecoord_type
    SquaredDistance(BOX2I self, BOX2I aBox) -> BOX2< VECTOR2< int > >::ecoord_type

Definition at line 5600 of file pcbnew.py.

Here is the caller graph for this function:

Property Documentation

◆ thisown

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

static

Definition at line 5416 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __ne__()

◆ Centre()

◆ ClosestPointTo()

◆ Contains()

◆ Diagonal()

◆ Distance()

◆ FarthestPointTo()

◆ Format()

◆ GetArea()

◆ GetBottom()

◆ GetBoundingBoxRotated()

◆ GetCenter()

◆ GetEnd()

◆ GetHeight()

◆ GetLeft()

◆ GetOrigin()

◆ GetPosition()

◆ GetRight()

◆ GetSize()

◆ GetSizeMax()

◆ GetTop()

◆ GetWidth()

◆ GetX()

◆ GetY()

◆ Inflate()

◆ Intersect()

◆ Intersects()

◆ IntersectsCircle()

◆ IntersectsCircleEdge()

◆ IsValid()

◆ Merge()

◆ Move()

◆ Normalize()

◆ Offset()

◆ SetEnd()

◆ SetHeight()

◆ SetMaximum()

◆ SetOrigin()

◆ SetSize()

◆ SetWidth()

◆ SetX()

◆ SetY()

◆ SquaredDistance()

Property Documentation

◆ thisown

◆ init()

◆ eq()

◆ ne()