the pygame.rect class has functionality to store and manipulate rectangular areas. a rect object can be constructed from left, top, width and height values. functions in rect class enable copying, moving nd resizing the rect object.

a rect object has following virtual attributes −

in addition to movement, rect class has methods to test collision between rectangles.

copy()	returns a new rectangle having the same position and size as the original.
move()	returns a new rectangle that is moved by the given offset. the x and y arguments can be any integer value, positive or negative.
move_ip()	same as the rect.move() method, but operates in place.
inflate(x,y)	returns a new rectangle with the size changed by the given offset. negative values will shrink the rectangle.
inflate_ip(x, y)	same as the rect.inflate() method, but operates in place.
clamp(rect)	returns a new rectangle that is moved to be completely inside the argument rect.
clip(rect)	returns a new rectangle that is cropped to be completely inside the argument rect.
union(rect)	returns a new rectangle that completely covers the area of the two provided rectangles.
union_ip(rect)	same as the rect.union() method, but operates in place.
contains(rect)	returns true when the argument is completely inside the rect.
collidepoint((x,y))	returns true if the given point is inside the rectangle.
colliderect(rect)	returns true if any portion of either rectangle overlap

example

in the following program, a rect object is drawn with red outline. using copy() method, its clone is created for movement. the movement is effected by move_ip() method. the arrow keys move the position of copied rectangle by incrementing/decrementing x/y coordinate by + or -5 pixels.

import pygame
from pygame.locals import *
from sys import exit
pygame.init()
screen = pygame.display.set_mode((400,300))
rect1 = rect(50, 60, 200, 80)
rect2=rect1.copy()
running = true
x=0
y=0
while running:
   for event in pygame.event.get():
      if event.type == quit:
         running = false
      if event.type == keydown:
         if event.key==k_left:
            x= -5
            y=0
         if event.key == k_right:
            x=5
            y=0
         if event.key == k_up:
            x = 0
            y = -5
         if event.key == k_down:
            x = 0
            y = 5
   rect2.move_ip(x,y)
   screen.fill((127,127,127))
   pygame.draw.rect(screen, (255,0,0), rect1, 1)
   pygame.draw.rect(screen, (0,0,255), rect2, 5)
   pygame.display.update()
   pygame.quit()

output

the following output shows rectangle with red outline is the original rectangle. its copy keeps moving responding to arrow keys and has blue outline

example

changing the move_ip() method to inflate_ip() method to grow/shrink the rectangle depending upon the arrow pressed.

while running:
   for event in pygame.event.get():
      if event.type == quit:
         running = false
      if event.type == keydown:
         if event.key==k_left:
            x= -5
            y=0
         if event.key == k_right:
            x=5
            y=0
         if event.key == k_up:
            x = 0
            y = -5
         if event.key == k_down:
            x = 0
            y = 5
      rect2.inflate_ip(x,y)
   screen.fill((127,127,127))
   pygame.draw.rect(screen, (255,0,0), rect1, 1)
   pygame.draw.rect(screen, (0,0,255), rect2, 5)
   pygame.display.update()

output

the following is the screenshot of the arrow key-press activity −

example

to make the rectangle move by detecting mousemotion event, we need to first press the mouse inside the original rectangle. to verify whether mouse position is inside the rectangle, we use collidepoint() method of the rect object. while the mouse is in motion, the rectangle object is moved in place by move_ip() method. movement shall stop when mouse is released.

import pygame
from pygame.locals import *
from sys import exit
pygame.init()
screen = pygame.display.set_mode((400,300))
rect = rect(50, 60, 200, 80)
moving = false
running = true
while running:
   for event in pygame.event.get():
      if event.type == quit:
         running = false
      elif event.type == mousebuttondown:
         if rect.collidepoint(event.pos):
            moving = true
      elif event.type == mousebuttonup:
         moving = false
      elif event.type == mousemotion and moving:
         rect.move_ip(event.rel)
   screen.fill((127,127,127))
   pygame.draw.rect(screen, (255,0,0), rect)
   if moving:
      pygame.draw.rect(screen, (0,0,255), rect, 4)
   pygame.display.flip()
pygame.quit()

output

example

to draw rectangle by mouse, capture the mouse pointer coordinates in mousebuttondown and mousebuttonup events, calculate the topleft coordinates, width and height and call rect() function.

import pygame
from pygame.locals import *
from sys import exit
pygame.init()
screen = pygame.display.set_mode((400,300))
pygame.display.set_caption("draw rectangle with mouse")
screen.fill((127,127,127))
x=0
y=0
w=0
h=0
drawmode=true
running = true
while running:
   for event in pygame.event.get():
      if event.type == quit:
         running = false
      if event.type == mousebuttondown:
         x,y = pygame.mouse.get_pos()
         drawmode = true
      if event.type == mousebuttonup:
         x1,y1 = pygame.mouse.get_pos()
         w=x1-x
         h=y1-y
         drawmode= false

   rect = pygame.rect(x,y,w,h)
   if drawmode == false:
      pygame.draw.rect(screen, (255,0,0), rect)
   pygame.display.flip()
pygame.quit()

output

Save or share this article