flatland.utils.editor module

class flatland.utils.editor.Controller(model, view)

Bases: object

Controller to handle incoming events from the ipywidgets Updates the editor/model. Calls the View directly for things which do not directly effect the model (this means the mouse drag path before it is interpreted as transitions)

clear(event)

debug(*args, **kwargs)

load(event)

log(*args, **kwargs)

on_click(wid, event)

on_mouse_move(wid, event)

Mouse motion event handler for drawing.

refresh(event)

regenerate(event)

reset(event)

reset_agents(event)

rotate_agent(event)

save(event)

save_image(event)

set_debug(event)

set_debug_move(event)

set_draw_mode(event)

set_filename(event)

set_model(model)

set_regen_height(event)

set_regen_width(event)

step(event)

class flatland.utils.editor.EditorMVC(env=None, sGL='PIL', env_filename='temp.pkl')

Bases: object

EditorMVC - a class to encompass and assemble the Jupyter Editor Model-View-Controller.

class flatland.utils.editor.EditorModel(env, env_filename='temp.pkl')

Bases: object

add_target(rc_cell)

clear()

clear_cell(cell_row_col)

click_agent(cell_row_col)

The user has clicked on a cell - * If there is an agent, select it

• If that agent was already selected, then deselect it

• If there is no agent selected, and no agent in the cell, create one
• If there is an agent selected, and no agent in the cell, move the selected agent to the cell

debug(*args, **kwargs)

debug_cell(rc_cell)

drag_path_element(rc_cell)

Mouse motion event handler for drawing.

find_agent_at(cell_row_col)

fix_env()

interpolate_pair(rcLast, rc_cell)

interpolate_path(lrcPath)

load()

log(*args, **kwargs)

mod_path(bAddRemove)

mod_rail_2cells(lrcCells, bAddRemove=True, iCellToMod=0, bPop=False)

Add transitions for rail between two cells lrcCells – list of two rc cells bAddRemove – whether to add (True) or remove (False) the transition iCellToMod – the index of the cell to modify: either 0 or 1

mod_rail_3cells(lrcStroke, bAddRemove=True, bPop=True)

Add transitions for rail spanning three cells. lrcStroke – list containing “stroke” of cells across grid bAddRemove – whether to add (True) or remove (False) the transition The transition is added to or removed from the 2nd cell, consistent with entering from the 1st cell, and exiting into the 3rd. Both the forward and backward transitions are added, eg rcCells [(3,4), (2,4), (2,5)] would result in the transitions N->E and W->S in cell (2,4).

mod_rail_cell_seq(lrcStroke, bAddRemove=True)

redraw()

regenerate(method=None, nAgents=0, env=None)

reset(regenerate_schedule=False, nAgents=0)

restart_agents()

save()

save_image()

set_debug(debug)

set_debug_move(debug)

set_draw_mode(draw_mode)

set_env(env)

set a new env for the editor, used by load and regenerate.

set_filename(filename)

set_regen_height(size)

set_regen_width(size)

class flatland.utils.editor.View(editor, sGL='MPL', screen_width=1200, screen_height=1200)

Bases: object

The Jupyter Editor View - creates and holds the widgets comprising the Editor.

display()

drag_path_element(x, y)

draw_stroke()

init_canvas()

init_widgets()

log(*args, **kwargs)

new_env()

Tell the view to update its graphics when a new env is created.

redisplay_image()

redraw()

xy_to_rc(x, y)