goo.simulator

class goo.simulator.Render(value)

Bases: Enum

An enumeration.

MP4 = 3

PNG = 1

TIFF = 2

class goo.simulator.Simulator(celltypes: List[CellType | Cell] = [], diffsystems: DiffusionSystem = [], time: int = 250, physics_dt: int = 1, molecular_dt: int = 1)

Bases: object

A simulator for cell-based simulations in Blender.

Parameters:

• cells (List[Cell]) – List of cells.

• time (List[int]) – Start and end frames.

• physics_dt (int) – Time step for physics simulation.

• molecular_dt (int) – Time step for molecular simulation.

• celltypes (List[CellType | Cell])

• diffsystems (DiffusionSystem)

add_handler(handler: Handler, celltypes: list[CellType] | None = None, diffsystem: DiffusionSystem | None = None)

Add a handler to the simulation.

Parameters:

• handler (Handler)

• celltypes (list[CellType] | None)

• diffsystem (DiffusionSystem | None)

add_handlers(handlers: list[Handler])

Add multiple handlers to the simulation.

Parameters:

handlers (list[Handler])

enable_addon(addon)

Enable an addon in Blender.

extend_scene()

Extend the scene to allow cloth physics to pass the default 250 frames.

get_cells(celltypes=None)

Get all cells in the simulation.

get_cells_func(celltypes=None)

Get a function that returns all cells in the simulation.

get_diffsystem_func(diffsystem=None)

Get a function that returns the diffusion system.

render(frames: List[int] | range | None = None, path: str | None = None, camera=False, format: Render = Render.PNG)

Render the simulation in the background without updating the 3D Viewport in real time. If a camera is specified, the frames will be rendered with it, otherwise the frames will be rendered in the 3D Viewport. It will updated the scene at the end of the simulation.

Parameters:

• start (int) – Start frame.

• end (int) – End frame.

• path (str) – Path to save the frames.

• camera (bool) – Render with the camera.

• format (Render) – Render format: PNG (default), TIFF, MP4.

• frames (List[int] | range | None)

render_animation(path=None, end=bpy.context.scene.frame_end, camera=False)

Render the simulation as an animation.

run(end=bpy.context.scene.frame_end)

Run the simulation in the background without updating the 3D Viewport in real time.

Parameters:

end (int) – End frame. Defaults to the last frame of the scene.

set_seed(seed)

Set the random seed for the simulation.

setup_world(seed=1)

Set up the Blender scene for the simulation.

toggle_gravity(on)

Toggle gravity in the scene.