Struct liriodendron::log::tools::grids::Grids

pub struct Grids {
    current_grid_id: usize,
    current_grid: Grid,
    names: Vec<String>,
    error: String,
    height: u16,
    width: u16,
    scroll_x: u16,
    scroll_y: u16,
    state: HashMap<Cell, FullPixel>,
    map_capacity: usize,
    switch_cursor: usize,
}

Represents user interface set of grids

Fields

current_grid_id: usize

current_grid: Grid

names: Vec<String>

Names of grids

error: String

If an error occured during an operation, a String is made to be displayed on the graphic interface

height: u16

width: u16

scroll_x: u16

Determines the visible part of the grid when user interface grid area is smaller than the grid

scroll_y: u16

Determines the visible part of the grid when user interface grid area is smaller than the grid

state: HashMap<Cell, FullPixel>

Grids' filled cells

map_capacity: usize

Customizable member

switch_cursor: usize

Determines which grid will be swapped with the current grid

Methods

impl Grids

pub fn new(map_capacity: usize) -> Grids

pub fn get_current_grid_info(&self) -> (Grid, usize)

pub fn is_on_current_grid(&self, id: usize, grid: Grid) -> bool

pub fn get_length_capacity_state(&self) -> (usize, usize)

pub fn get_current_grid(&self) -> Vec<(FullPixel, u16, u16)>

Returns current grid's filled cells in a Vec of tuples (cell content, cell X coordinate, cell Y coordinate)

pub fn get_names(&self) -> Vec<String>

pub fn get_nb(&self) -> usize

pub fn is_full(&self) -> bool

pub fn is_alone(&self) -> bool

fn clear_current_grid(&mut self)

fn add(&mut self, name: String)

fn rename_current_grid(&mut self, name: String)

fn delete_current_grid(&mut self)

Clears content of the current grid, deletes it and decrements the grid id of cells with a grid id greater than the deleted grid

fn switch_current_grid(&mut self, switched_grid: usize)

switched_grid is a data from the userinterface where names of each grid is displayed except the current grid. So if the switched_grid has a greater id than the current grid, this switched_grid has a userinterface id equal to its log id minus 1. So when this data arrived in this function, we have to increments it to match with this userinterface representation to the log representation.

pub fn get_switch_cursor(&self) -> usize

pub fn next_switch_cursor(&mut self)

pub fn previous_switch_cursor(&mut self)

pub fn check_name(&mut self, name: String) -> Option<[char; 16]>

Chechs if the name typed by the user have a length between 1 and 16 and if the name is not already used

pub fn error_occured(&self) -> bool

pub fn get_error(&self) -> String

pub fn next(&mut self)

pub fn previous(&mut self)

pub fn get_nb_filledcells_current_grid(&self) -> usize

pub fn get_grids(&self) -> HashMap<(u16, u16), (usize, FullPixel)>

Returns grids' filled cells in a HashMap of key-tuples (cell X coordinate, cell Y coordinate) and value-tuples (grid ID, cell content)

pub fn update(&mut self, action: &Action) -> (Option<FullPixel>, bool)

Updates state depending of action. Returns the old value if action deletes of modifies a value in state. Returns a bool for the user interface if action inserts and overflows state capacity.

pub fn get_grid_width(&self) -> u16

pub fn get_grid_height(&self) -> u16

fn increment_width(&mut self)

fn decrement_width(&mut self)

fn increment_height(&mut self)

fn decrement_height(&mut self)

pub fn get_scroll(&self) -> (u16, u16)

pub fn check_scroll(&mut self, (area_width, area_height): &(u16, u16))

pub fn scroll_up(&mut self)

pub fn scroll_down(&mut self)

pub fn scroll_left(&mut self)

pub fn scroll_right(&mut self)

Trait Implementations

impl Clone for Grids

fn clone(&self) -> Grids

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.