Inheritance diagram for pcbnew.BOX2I:

Public Member Functions
	SetMaximum (self)

	Centre (self)

	Move (self, aMoveVector)

	Normalize (self)

	Contains (self, *args)

	GetSize (self)

	GetX (self)

	GetY (self)

	GetOrigin (self)

	GetPosition (self)

	GetEnd (self)

	GetWidth (self)

	GetHeight (self)

	GetRight (self)

	GetBottom (self)

	GetLeft (self)

	GetTop (self)

	GetCenter (self)

	GetSizeMax (self)

	SetOrigin (self, *args)

	SetSize (self, *args)

	Offset (self, *args)

	GetWithOffset (self, aMoveVector)

	SetX (self, val)

	SetY (self, val)

	SetWidth (self, val)

	SetHeight (self, val)

	SetEnd (self, *args)

	Intersect (self, aRect)

	Intersects (self, *args)

	IntersectsCircle (self, aCenter, aRadius)

	IntersectsCircleEdge (self, aCenter, aRadius, aWidth)

	Format (self)

	Inflate (self, *args)

	GetInflated (self, *args)

	Merge (self, *args)

	GetBoundingBoxRotated (self, aRotCenter, aAngle)

	GetArea (self)

	Diagonal (self)

	SquaredDiagonal (self)

	SquaredDistance (self, *args)

	Distance (self, *args)

	NearestPoint (self, aPoint)

	FarthestPointTo (self, aPoint)

	__eq__ (self, aOther)

	__ne__ (self, aOther)

	IsValid (self)

	__init__ (self, *args)

Static Public Member Functions
	ByCorners (aCorner1, aCorner2)

	ByCenter (aCenter, aSize)

Properties
	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 5368 of file pcbnew.py.

Constructor & Destructor Documentation

◆ init()

pcbnew.BOX2I.__init__	(		self,
		*	args )

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

Definition at line 5607 of file pcbnew.py.

Member Function Documentation

◆ eq()

pcbnew.BOX2I.__eq__	(		self,
			aOther )

__eq__(BOX2I self, BOX2I aOther) -> bool

Definition at line 5595 of file pcbnew.py.

◆ ne()

pcbnew.BOX2I.__ne__	(		self,
			aOther )

__ne__(BOX2I self, BOX2I aOther) -> bool

Definition at line 5599 of file pcbnew.py.

◆ ByCenter()

pcbnew.BOX2I.ByCenter	(		aCenter,
			aSize )

static

ByCenter(VECTOR2I aCenter, VECTOR2L aSize) -> BOX2I

Definition at line 5380 of file pcbnew.py.

◆ ByCorners()

pcbnew.BOX2I.ByCorners	(		aCorner1,
			aCorner2 )

static

ByCorners(VECTOR2I aCorner1, VECTOR2I aCorner2) -> BOX2I

Definition at line 5375 of file pcbnew.py.

◆ Centre()

pcbnew.BOX2I.Centre ( self )

Centre(BOX2I self) -> VECTOR2I

Definition at line 5388 of file pcbnew.py.

◆ Contains()

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

◆ Diagonal()

pcbnew.BOX2I.Diagonal ( self )

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

Definition at line 5565 of file pcbnew.py.

◆ Distance()

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

◆ FarthestPointTo()

pcbnew.BOX2I.FarthestPointTo	(		self,
			aPoint )

FarthestPointTo(BOX2I self, VECTOR2I aPoint) -> VECTOR2I

Definition at line 5591 of file pcbnew.py.

◆ Format()

pcbnew.BOX2I.Format ( self )

Format(BOX2I self) -> string

Definition at line 5532 of file pcbnew.py.

◆ GetArea()

pcbnew.BOX2I.GetArea ( self )

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

Definition at line 5561 of file pcbnew.py.

◆ GetBottom()

pcbnew.BOX2I.GetBottom ( self )

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

Definition at line 5444 of file pcbnew.py.

◆ GetBoundingBoxRotated()

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

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

Definition at line 5557 of file pcbnew.py.

◆ GetCenter()

pcbnew.BOX2I.GetCenter ( self )

GetCenter(BOX2I self) -> VECTOR2I

Definition at line 5456 of file pcbnew.py.

◆ GetEnd()

pcbnew.BOX2I.GetEnd ( self )

GetEnd(BOX2I self) -> VECTOR2I

Definition at line 5428 of file pcbnew.py.

◆ GetHeight()

pcbnew.BOX2I.GetHeight ( self )

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

Definition at line 5436 of file pcbnew.py.

◆ GetInflated()

pcbnew.BOX2I.GetInflated	(		self,
		*	args )

    GetInflated(BOX2I self, BOX2< VECTOR2< int > >::coord_type aDx, BOX2< VECTOR2< int > >::coord_type aDy) -> BOX2I
    GetInflated(BOX2I self, BOX2< VECTOR2< int > >::coord_type aDelta) -> BOX2I

Definition at line 5543 of file pcbnew.py.

◆ GetLeft()

pcbnew.BOX2I.GetLeft ( self )

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

Definition at line 5448 of file pcbnew.py.

◆ GetOrigin()

pcbnew.BOX2I.GetOrigin ( self )

GetOrigin(BOX2I self) -> VECTOR2I

Definition at line 5420 of file pcbnew.py.

◆ GetPosition()

pcbnew.BOX2I.GetPosition ( self )

GetPosition(BOX2I self) -> VECTOR2I

Definition at line 5424 of file pcbnew.py.

◆ GetRight()

pcbnew.BOX2I.GetRight ( self )

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

Definition at line 5440 of file pcbnew.py.

◆ GetSize()

pcbnew.BOX2I.GetSize ( self )

GetSize(BOX2I self) -> VECTOR2L

Definition at line 5408 of file pcbnew.py.

◆ GetSizeMax()

pcbnew.BOX2I.GetSizeMax ( self )

GetSizeMax(BOX2I self) -> int

Definition at line 5460 of file pcbnew.py.

◆ GetTop()

pcbnew.BOX2I.GetTop ( self )

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

Definition at line 5452 of file pcbnew.py.

◆ GetWidth()

pcbnew.BOX2I.GetWidth ( self )

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

Definition at line 5432 of file pcbnew.py.

◆ GetWithOffset()

pcbnew.BOX2I.GetWithOffset	(		self,
			aMoveVector )

GetWithOffset(BOX2I self, VECTOR2I aMoveVector) -> BOX2I

Definition at line 5485 of file pcbnew.py.

◆ GetX()

pcbnew.BOX2I.GetX ( self )

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

Definition at line 5412 of file pcbnew.py.

◆ GetY()

pcbnew.BOX2I.GetY ( self )

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

Definition at line 5416 of file pcbnew.py.

◆ Inflate()

pcbnew.BOX2I.Inflate	(		self,
		*	args )

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

Definition at line 5536 of file pcbnew.py.

◆ Intersect()

pcbnew.BOX2I.Intersect	(		self,
			aRect )

Intersect(BOX2I self, BOX2I aRect) -> BOX2I

Definition at line 5512 of file pcbnew.py.

◆ Intersects()

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

◆ IntersectsCircle()

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

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

Definition at line 5524 of file pcbnew.py.

◆ IntersectsCircleEdge()

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

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

Definition at line 5528 of file pcbnew.py.

◆ IsValid()

pcbnew.BOX2I.IsValid ( self )

IsValid(BOX2I self) -> bool

Definition at line 5603 of file pcbnew.py.

◆ Merge()

pcbnew.BOX2I.Merge	(		self,
		*	args )

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

Definition at line 5550 of file pcbnew.py.

◆ Move()

pcbnew.BOX2I.Move	(		self,
			aMoveVector )

Move(BOX2I self, VECTOR2I aMoveVector)

Definition at line 5392 of file pcbnew.py.

◆ NearestPoint()

pcbnew.BOX2I.NearestPoint	(		self,
			aPoint )

NearestPoint(BOX2I self, VECTOR2I aPoint) -> VECTOR2I

Definition at line 5587 of file pcbnew.py.

◆ Normalize()

pcbnew.BOX2I.Normalize ( self )

Normalize(BOX2I self) -> BOX2I

Definition at line 5396 of file pcbnew.py.

◆ Offset()

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

◆ SetEnd()

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

◆ SetHeight()

pcbnew.BOX2I.SetHeight	(		self,
			val )

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

Definition at line 5501 of file pcbnew.py.

◆ SetMaximum()

pcbnew.BOX2I.SetMaximum ( self )

SetMaximum(BOX2I self)

Definition at line 5384 of file pcbnew.py.

◆ SetOrigin()

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

◆ SetSize()

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

◆ SetWidth()

pcbnew.BOX2I.SetWidth	(		self,
			val )

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

Definition at line 5497 of file pcbnew.py.

◆ SetX()

pcbnew.BOX2I.SetX	(		self,
			val )

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

Definition at line 5489 of file pcbnew.py.

◆ SetY()

pcbnew.BOX2I.SetY	(		self,
			val )

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

Definition at line 5493 of file pcbnew.py.

◆ SquaredDiagonal()

pcbnew.BOX2I.SquaredDiagonal ( self )

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

Definition at line 5569 of file pcbnew.py.

◆ SquaredDistance()

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

Property Documentation

◆ thisown

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

static

Definition at line 5371 of file pcbnew.py.

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

pcbnew.py

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __ne__()

◆ ByCenter()

◆ ByCorners()

◆ Centre()

◆ Contains()

◆ Diagonal()

◆ Distance()

◆ FarthestPointTo()

◆ Format()

◆ GetArea()

◆ GetBottom()

◆ GetBoundingBoxRotated()

◆ GetCenter()

◆ GetEnd()

◆ GetHeight()

◆ GetInflated()

◆ GetLeft()

◆ GetOrigin()

◆ GetPosition()

◆ GetRight()

◆ GetSize()

◆ GetSizeMax()

◆ GetTop()

◆ GetWidth()

◆ GetWithOffset()

◆ GetX()

◆ GetY()

◆ Inflate()

◆ Intersect()

◆ Intersects()

◆ IntersectsCircle()

◆ IntersectsCircleEdge()

◆ IsValid()

◆ Merge()

◆ Move()

◆ NearestPoint()

◆ Normalize()

◆ Offset()

◆ SetEnd()

◆ SetHeight()

◆ SetMaximum()

◆ SetOrigin()

◆ SetSize()

◆ SetWidth()

◆ SetX()

◆ SetY()

◆ SquaredDiagonal()

◆ SquaredDistance()

Property Documentation

◆ thisown

◆ init()

◆ eq()

◆ ne()