vecrec.Rect

class vecrec.Rect(left, bottom, width, height)

Bases: vecrec.shapes.Shape

Represent a mutable two-dimensional rectangle.

Public Data Attributes:

top_left
top_center
top_right
center_left
center
center_right
bottom_left
bottom_center
bottom_right
left
center_x
right
top
center_y
bottom
area
width
height
half_width
half_height
vertices
size
size_as_int
dimensions
tuple
union
intersection
rounded

Inherited from Shape

bottom
left
width
height

Public Methods:

__init__(left, bottom, width, height)
__repr__()	Return repr(self).
__str__()	Return str(self).
__eq__(other)	Return self==value.
__add__(vector)
__iadd__(vector)
__sub__(vector)
__isub__(vector)
__contains__(other)
null()	Create a rectangle with everything set to zero.
from_size(width, height)	Create a rectangle with the given width and height.
from_width(width[, ratio])	Create a rectangle with the given width.
from_height(height[, ratio])	Create a rectangle with the given height.
from_square(size)	Create a rectangle with the same width and height.
from_dimensions(left, bottom, width, height)	Create a rectangle with the given dimensions.
from_sides(left, top, right, bottom)	Create a rectangle with the specified edge coordinates.
from_corners(v1, v2)	Create the rectangle defined by the two corners.
from_bottom_left(position, width, height)	Create a rectangle with the given width, height, and bottom-left corner.
from_center(position, width, height)	Create a rectangle with the given dimensions centered at the given position.
from_vector(position)	Create a rectangle from a vector.
from_points(*points)	Create a rectangle that contains all the given points.
from_shape(shape)	Create a rectangle from an object that implements the Shape interface.
from_pygame_surface(surface)	Create a rectangle from a pygame.Surface.
from_pyglet_window(window)	Create a rectangle from a pyglet.window.Window.
from_pyglet_image(image)	Create a rectangle from a pyglet.image.AbstractImage.
from_union(*inputs)	Create a rectangle that contains all the given inputs.
from_intersection(*inputs)	Create a rectangle that represents the overlapping area between all the given inputs.
grow(*padding)	Grow this rectangle by the given padding on all sides.
shrink(*padding)	Shrink this rectangle by the given padding on all sides.
displace(vector)	Displace this rectangle by the given vector.
round(*args)	Round the dimensions of the given rectangle to the given number of digits.
set(shape)	Fill this rectangle with the dimensions of the given shape.
copy()	Return a copy of this rectangle.
inside(other)	Return true if this rectangle is inside the given shape.
outside(other)	Return true if this rectangle is outside the given shape.
touching(other)	Return true if this rectangle is touching the given shape.
contains(other)	Return true if the given shape is inside this rectangle.
align_left(target)	Make the left coordinate of this rectangle equal to that of the given rectangle.
align_center_x(target)	Make the center-x coordinate of this rectangle equal to that of the given rectangle.
align_right(target)	Make the right coordinate of this rectangle equal to that of the given rectangle.
align_top(target)	Make the top coordinate of this rectangle equal to that of the given rectangle.
align_center_y(target)	Make the center-y coordinate of this rectangle equal to that of the given rectangle.
align_bottom(target)	Make the bottom coordinate of this rectangle equal to that of the given rectangle.
get_left()
set_left(x)
get_center_x()
set_center_x(x)
get_right()
set_right(x)
get_top()
set_top(y)
get_center_y()
set_center_y(y)
get_bottom()
set_bottom(y)
get_area()
get_width()
set_width(width)
get_height()
set_height(height)
get_half_width()
set_half_width(half_width)
get_half_height()
set_half_height(half_height)
get_top_left()
set_top_left(point)
get_top_center()
set_top_center(point)
get_top_right()
set_top_right(point)
get_center_left()
set_center_left(point)
get_center()
set_center(point)
get_center_right()
set_center_right(point)
get_bottom_left()
set_bottom_left(point)
get_bottom_center()
set_bottom_center(point)
get_bottom_right()
set_bottom_right(point)
get_vertices()
set_vertices(vertices)
get_size()
set_size(width, height)
get_size_as_int()
get_dimensions()
get_tuple()
get_union(*rectangles)
get_intersection(*rectangles)
get_grown(padding)
get_shrunk(padding)
get_rounded(*args)

Inherited from Shape

get_bottom()
get_left()
get_width()
get_height()

---

__add__(vector)

__contains__(other)

__eq__(other)

Return self==value.

__hash__ = None

__iadd__(vector)

__init__(left, bottom, width, height)

__isub__(vector)

__repr__()

Return repr(self).

__str__()

Return str(self).

__sub__(vector)

align_bottom(target)

Make the bottom coordinate of this rectangle equal to that of the given rectangle.

align_center_x(target)

Make the center-x coordinate of this rectangle equal to that of the given rectangle.

align_center_y(target)

Make the center-y coordinate of this rectangle equal to that of the given rectangle.

align_left(target)

Make the left coordinate of this rectangle equal to that of the given rectangle.

align_right(target)

Make the right coordinate of this rectangle equal to that of the given rectangle.

align_top(target)

Make the top coordinate of this rectangle equal to that of the given rectangle.

property area

property bottom

property bottom_center

property bottom_left

property bottom_right

property center

property center_left

property center_right

property center_x

property center_y

contains(other)

Return true if the given shape is inside this rectangle.

copy()

Return a copy of this rectangle.

property dimensions

displace(vector)

Displace this rectangle by the given vector.

static from_bottom_left(position, width, height)

Create a rectangle with the given width, height, and bottom-left corner.

static from_center(position, width, height)

Create a rectangle with the given dimensions centered at the given position.

static from_corners(v1, v2)

Create the rectangle defined by the two corners. The corners can be specified in any order.

static from_dimensions(left, bottom, width, height)

Create a rectangle with the given dimensions. This is an alias for the constructor.

static from_height(height, ratio=1.618033988749895)

Create a rectangle with the given height. The width will be calculated from the given ratio, or the golden ratio by default.

static from_intersection(*inputs)

Create a rectangle that represents the overlapping area between all the given inputs. Each input must implement the Shape interface.

static from_points(*points)

Create a rectangle that contains all the given points.

static from_pygame_surface(surface)

Create a rectangle from a pygame.Surface.

static from_pyglet_image(image)

Create a rectangle from a pyglet.image.AbstractImage.

static from_pyglet_window(window)

Create a rectangle from a pyglet.window.Window.

static from_shape(shape)

Create a rectangle from an object that implements the Shape interface.

static from_sides(left, top, right, bottom)

Create a rectangle with the specified edge coordinates.

static from_size(width, height)

Create a rectangle with the given width and height. The bottom-left corner will be on the origin.

static from_square(size)

Create a rectangle with the same width and height.

static from_union(*inputs)

Create a rectangle that contains all the given inputs. Each input must implement the Shape interface.

static from_vector(position)

Create a rectangle from a vector. The rectangle will have no area, and its bottom-let corner will be the same as the vector.

static from_width(width, ratio=0.6180339887498948)

Create a rectangle with the given width. The height will be calculated from the given ratio, or the golden ratio by default.

get_area()

get_bottom()

get_bottom_center()

get_bottom_left()

get_bottom_right()

get_center()

get_center_left()

get_center_right()

get_center_x()

get_center_y()

get_dimensions()

get_grown(padding)

get_half_height()

get_half_width()

get_height()

get_intersection(*rectangles)

get_left()

get_right()

get_rounded(*args)

get_shrunk(padding)

get_size()

get_size_as_int()

get_top()

get_top_center()

get_top_left()

get_top_right()

get_tuple()

get_union(*rectangles)

get_vertices()

get_width()

grow(*padding)

Grow this rectangle by the given padding on all sides.

property half_height

property half_width

property height

inside(other)

Return true if this rectangle is inside the given shape.

property intersection

property left

static null()

Create a rectangle with everything set to zero. It will be located at the origin and have no area.

outside(other)

Return true if this rectangle is outside the given shape.

property right

round(*args)

Round the dimensions of the given rectangle to the given number of digits.

property rounded

set(shape)

Fill this rectangle with the dimensions of the given shape.

set_bottom(y)

set_bottom_center(point)

set_bottom_left(point)

set_bottom_right(point)

set_center(point)

set_center_left(point)

set_center_right(point)

set_center_x(x)

set_center_y(y)

set_half_height(half_height)

set_half_width(half_width)

set_height(height)

set_left(x)

set_right(x)

set_size(width, height)

set_top(y)

set_top_center(point)

set_top_left(point)

set_top_right(point)

set_vertices(vertices)

set_width(width)

shrink(*padding)

Shrink this rectangle by the given padding on all sides.

The padding can either be a single number (to be applied to all sides), or a tuple of 4 number (to be applied to the left, right, top, and bottom, respectively).

property size

property size_as_int

property top

property top_center

property top_left

property top_right

touching(other)

Return true if this rectangle is touching the given shape.

property tuple

property union

property vertices

property width