A class for representing and manipulating rectangles. It has x, y,
width and height properties. In wxPython most palces that expect a
wx.Rect can also accept a (x,y,width,height) tuple.
| Method Summary |
| Rect |
__init__(self,
x,
y,
width,
height)
Create a new Rect object. |
| Rect |
__add__(self,
rect)
Add the properties of rect to this rectangle and return the result. |
| |
__del__(self)
|
| bool |
__eq__(self,
other)
Test for equality of wx.Rect objects. |
| |
__getitem__(self,
index)
|
| Rect |
__iadd__(self,
rect)
Add the properties of rect to this rectangle, updating this rectangle. |
| |
__len__(self)
|
| bool |
__ne__(self,
other)
Test for inequality of wx.Rect objects. |
| |
__nonzero__(self)
|
| |
__reduce__(self)
|
| |
__repr__(self)
|
| |
__setitem__(self,
index,
val)
|
| |
__str__(self)
|
| |
asTuple(*args,
**kwargs)
asTuple is deprecated, use Get instead |
| Rect |
CenterIn(self,
r,
dir)
Center this rectangle within the one passed to the method, which is
usually, but not necessarily, the larger one. |
| Rect |
CentreIn(self,
r,
dir)
Center this rectangle within the one passed to the method, which is
usually, but not necessarily, the larger one. |
| bool |
Contains(self,
pt)
Return True if the point is inside the rect. |
| bool |
ContainsRect(self,
rect)
Returns True if the given rectangle is completely inside this
rectangle or touches its boundary. |
| bool |
ContainsXY(self,
x,
y)
Return True if the point is inside the rect. |
| Rect |
Deflate(self,
dx,
dy)
Decrease the rectangle size. |
| (x,y,width,height) |
Get()
Return the rectangle properties as a tuple. |
| int |
GetBottom(self)
|
| Point |
GetBottomLeft(self)
|
| Point |
GetBottomRight(self)
|
| int |
GetHeight(self)
|
| int |
GetLeft(self)
|
| Point |
GetPosition(self)
|
| int |
GetRight(self)
|
| Size |
GetSize(self)
|
| int |
GetTop(self)
|
| Point |
GetTopLeft(self)
|
| Point |
GetTopRight(self)
|
| int |
GetWidth(self)
|
| int |
GetX(self)
|
| int |
GetY(self)
|
| Rect |
Inflate(self,
dx,
dy)
Increases the size of the rectangle. |
| bool |
Inside(self,
pt)
Return True if the point is inside the rect. |
| bool |
InsideRect(self,
rect)
Returns True if the given rectangle is completely inside this
rectangle or touches its boundary. |
| bool |
InsideXY(self,
x,
y)
Return True if the point is inside the rect. |
| Rect |
Intersect(self,
rect)
Returns the intersectsion of this rectangle and rect. |
| bool |
Intersects(self,
rect)
Returns True if the rectangles have a non empty intersection. |
| bool |
IsEmpty(self)
|
| |
Offset(self,
pt)
Same as OffsetXY but uses dx,dy from Point |
| |
OffsetXY(self,
dx,
dy)
Moves the rectangle by the specified offset. |
| |
Set(self,
x,
y,
width,
height)
Set all rectangle properties. |
| |
SetBottom(self,
bottom)
|
| |
SetBottomLeft(self,
p)
|
| |
SetBottomRight(self,
p)
|
| |
SetHeight(self,
h)
|
| |
SetLeft(self,
left)
|
| |
SetPosition(self,
p)
|
| |
SetRight(self,
right)
|
| |
SetSize(self,
s)
|
| |
SetTop(self,
top)
|
| |
SetTopLeft(self,
p)
|
| |
SetTopRight(self,
p)
|
| |
SetWidth(self,
w)
|
| |
SetX(self,
x)
|
| |
SetY(self,
y)
|
| Rect |
Union(self,
rect)
Returns the union of this rectangle and rect. |
Inflate(self,
dx,
dy)
Increases the size of the rectangle.
The left border is moved farther left and the right border is moved
farther right by dx. The upper border is moved farther up and the
bottom border is moved farther down by dy. (Note the the width and
height of the rectangle thus change by 2*dx and 2*dy,
respectively.) If one or both of dx and dy are negative, the
opposite happens: the rectangle size decreases in the respective
direction.
The change is made to the rectangle inplace, if instead you need a
copy that is inflated, preserving the original then make the copy
first:
copy = wx.Rect(*original)
copy.Inflate(10,15)
Inflating and deflating behaves naturally. Defined more precisely,
that means:
- Real inflates (that is, dx and/or dy >= 0) are not
constrained. Thus inflating a rectangle can cause its upper left
corner to move into the negative numbers. (The versions prior to
2.5.4 forced the top left coordinate to not fall below (0, 0),
which implied a forced move of the rectangle.)
- Deflates are clamped to not reduce the width or height of the
rectangle below zero. In such cases, the top-left corner is
nonetheless handled properly. For example, a rectangle at (10,
10) with size (20, 40) that is inflated by (-15, -15) will
become located at (20, 25) at size (0, 10). Finally, observe
that the width and height are treated independently. In the
above example, the width is reduced by 20, whereas the height is
reduced by the full 30 (rather than also stopping at 20, when
the width reached zero).
-
- Parameters:
dx
(type=int)
dy
(type=int)
- Returns:
-
Rect
See Also: Deflate
|