Struct n18ui::UserInterface

pub struct UserInterface {
    pub assets: Assets,
    pub state: State,
    pub controller: Controller,
    pub keymap: Keymap,
    pub canvas: Canvas,
    // some fields omitted
}

Defines the user interface.

Fields

assets: Assets

state: State

controller: Controller

keymap: Keymap

canvas: Canvas

Implementations

impl UserInterface

pub fn new<T, C>(games: T, controller: C, keymap: Keymap) -> Self where
    T: IntoIterator<Item = Box<dyn Game>>,
    C: Into<Controller>, 

Creates the initial user interface state.

pub fn draw(&self)

Draws the current state of the user interface.

pub fn min_hex_diameter(&self) -> f64

Returns the minimum allowed hex diameter, which limits zooming out.

pub fn max_hex_diameter(&self) -> f64

Returns the maximum allowed hex diameter, which limits zooming in.

pub fn handle_key_press(&mut self, event: &KeyPress) -> UiResponse

pub fn handle_button_press(&mut self, event: &ButtonPress) -> UiResponse

pub fn respond(&mut self, response: UiResponse)

pub fn map_size(&self) -> (i32, i32)

Returns the dimensions of the current game map, in pixels.

pub fn zoom_and_redraw(&mut self)

Requests the drawing area to update its size, and redraws the current game state.

This should be called when the user has zoomed in or zoomed out.

pub fn reset_and_redraw(&mut self)

Resets the drawing surface, requests the drawing area to update its size, and redraws the current game state.

This should only be called when the active game has changed (e.g., when creating a new game or loading a saved game).

pub fn set_default_title(&mut self)

Sets the window title to the game name, replacing any state-specific title.

pub fn ping(&mut self, dest: PingDest) -> UiResponse

Responds to an event triggered by something other than a UI event (e.g., a message from a task running in a separate thread).

pub fn new_game(&mut self, game_ix: usize) -> UiResponse

Creates a new game, identified by index into the game library.

pub fn load_game(&mut self, path: PathBuf) -> UiResponse

Loads a saved game state from path.

pub fn save_game(&mut self, path: PathBuf) -> UiResponse

Saves the current game state to path.

pub fn save_image(&self, path: PathBuf, image: ImageSurface) -> UiResponse

Saves an image to path.