The World is where all of the simulation happens. Robots are added to the World, and the Viewer and Logger refer to a World to draw the simulation and save data.
Once the World is created and you have added your robots, you will likely only need to call the
World(width: int, height: int, robots: List[gridsim.robot.Robot] = , environment: str = '', allow_collisions: bool = True)¶
__init__(width: int, height: int, robots: List[gridsim.robot.Robot] = , environment: str = '', allow_collisions: bool = True)¶
Create a World for simulating Robots in a grid world
width (int) – Width of the world (number of cells)
height (int) – Height of the world (number of cells)
robots (List[Robot], optional) – List of Robots to place in the World to start, by default . Additional robots can be added after initialization with the add_robot method.
environment (str, optional) – Filename of an image to use for a background in the World. Robots will be able to sense the color of this image. If the environment dimensions do not match the World dimensions, the image will be re-scaled (and possibly stretched). We recommend using an image with the same resolution as your grid size.
allow_collisions (bool, optional) – Whether or not to allow Robots to exist in the same grid cell, by default True
Add an image to the environment for the Robots to sense. This will also be shown by the Viewer.
Because sensing is cell-based, images will be scaled to the size of the World’s grid. If the aspect ratio does not match, images will be stretched. To avoid any surprises from rescaling, we recommend using an image with the same resolution as your grid size. (e.g., if you have a 50x50 grid, use a 50px x 50px image.)
img_filename (str) – Filename of the RGB image to use as a background environment. Any transparency (alpha) is ignored by the robot sensing.
Add a single robot to the World. Robots can also be added in bulk (as a list) when the
Worldis created, using the
robot (Robot) – Robot to add to the World
get_dimensions() → Tuple[int, int]¶
Get the dimensions (in grid cells) of the World
(width, height) of the World, in grid cells
- Return type
get_robots() → pygame.sprite.Group¶
Get a list of all the robots in the World
All Robots currently in the World
- Return type
get_time() → float¶
Get the current time of the World. At the moment, that’s just the number of ticks (time steps) since the simulation started, since we’re in a discrete world.
Number of ticks (steps) since simulation started
- Return type
Run a single step of the simulation. This moves the robots, manages the clock, and runs the robot controllers.
tag(pos: Tuple[int, int], color: Tuple[int, int, int])¶
Tag a cell position in the World with an RGB color to display in the viewer. There will be a semi-transparent overlay with the given color in that cell in the World. This is primarily for use with the Viewer, to visualize what has been sampled in the World.
pos (Tuple[int, int]) – (x, y) grid cell position to mark
color (Tuple[int, int, int]) – (R, G, B) color to set as the cell’s overlay color (each in the range [0, 255])