Struct PixGrid 

pub struct PixGrid {
    pub color_map: HashMap<u8, Rgb<u8>>,
    pub grid_data: Vec<Vec<u8>>,
    pub cell_size: u32,
    pub grid_color: Option<Rgb<u8>>,
}

Represents a pixel grid configuration, containing color mappings, the grid layout, cell size, and grid line visibility settings.

Fields

color_map: HashMap<u8, Rgb<u8>>

Maps the color code (u8) found in grid_data to a specific RGB color.

grid_data: Vec<Vec<u8>>

The actual grid data, where each inner Vec is a row of color codes.

cell_size: u32

The size (width and height) in pixels for each cell in the grid.

grid_color: Option<Rgb<u8>>

Optional RGB color for drawing grid lines. None means no lines are drawn.

Implementations

impl PixGrid

pub fn new(width: usize, height: usize) -> Self

✨ Constructor: Creates a new PixGrid with the specified dimensions.

Arguments

• width - The number of columns (grid width).
• height - The number of rows (grid height).

Default Values Used

• cell_size: 1 (Default pixel size for each cell).
• grid_color: None (No grid lines drawn by default).
• default_color_code: 0 (Default color code used to fill the grid).

pub fn set_cell( &mut self, position: CellPosition, color_code: u8, ) -> Result<(), &'static str>

Sets the color code of a single cell at the given logical position.

Returns Ok(()) on success or Err if the position is out of bounds.

pub fn get_cell(&self, position: CellPosition) -> Option<u8>

Retrieves the color code of a single cell at the given logical position.

Returns Option, which is None if the position is out of bounds.

pub fn get_moore_neighbors( &self, center_pos: CellPosition, ) -> Vec<(CellPosition, u8)>

Retrieves the position and color code of the 8 surrounding cells (Moore neighborhood) for the given position. Out-of-bounds cells are skipped.

Returns a Vec<(CellPosition, u8)>.

pub fn get_von_neumann_neighbors( &self, center_pos: CellPosition, ) -> Vec<(CellPosition, u8)>

Retrieves the position and color code of the 4 cardinal neighboring cells (Von Neumann neighborhood: Top, Bottom, Left, Right) for the given position. Out-of-bounds cells are skipped.

Returns a Vec<(CellPosition, u8)>.

pub fn parse(input_data: &str) -> Result<PixGrid, Box<dyn Error>>

Parses a string of input data into a PixGrid configuration.

The input format expects configuration parameters (cell_size, grid_color) and color definitions (code=R,G,B) followed by a separator “—” and the grid data.

Errors

Returns an error if no color definitions are found.

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

Retrieves the width and height of the grid (in number of cells). Returns (width, height). Returns (0, 0) if the grid is empty.

pub fn random_sparse_fill(&mut self, cell_state: u8, density: f64)

Initializes the grid with a specific color code based on a given density (probability). Cells not assigned the activation code will remain at the default code (0).

Arguments

• cell_state: The color code (e.g., 1) to use for the randomized cells.
• density: The probability (0.0 to 1.0) that a cell will be set to cell_state.

pub fn random_fill_with_proportions( &mut self, proportions: &[(u8, f64)], ) -> Result<(), &'static str>

Fills the grid randomly according to a given vector of code proportions.

Arguments

• proportions: A slice of tuples (color_code: u8, proportion: f64). The sum of all proportions must be close to 1.0.

Errors

Returns an Err if the proportions are invalid (sum is not close to 1.0).

pub fn export_pg(&self, output_path: &Path) -> Result<(), Box<dyn Error>>

Exports the current PixGrid configuration to a file in the *.pg format.

The output format includes:

1. Rendering parameters (cell_size, grid_color).
2. Color definitions (Code = R, G, B).
3. The grid data, separated by “—”.

Arguments

• output_path - The path to the file where the data will be written.

Returns

A Result indicating success or an error if writing to the file fails.

pub fn get_missing_codes(&self) -> Vec<u8>

pub fn export_png(&self, output_path: &Path) -> Result<(), Box<dyn Error>>

Export a PNG image from the stored grid data.

The image is created by scaling each u8 code in grid_data by cell_size. Unknown color codes default to magenta (Rgb([255, 0, 255])).

Errors

Returns an error if the grid data is empty or if image saving fails.

pub fn export_svg(&self, output_path: &Path) -> Result<(), Box<dyn Error>>

Export an SVG image (XML format) from the stored grid data.

Each grid cell is drawn as an SVG <rect> element.

Errors

Returns an error if the grid data is empty or if file writing fails.

pub fn from_png( input_path: &Path, cell_size: u32, grid_color_setting: Option<Rgb<u8>>, ) -> Result<PixGrid, Box<dyn Error>>

Creates a new PixGrid structure by reading a PNG file.

It samples the top-left pixel of each cell (defined by cell_size) to determine the cell’s color and assigns a unique u8 code to each distinct color found.

Arguments

• input_path - Path to the PNG file to read.
• cell_size - The expected cell size (N x N) in pixels.
• grid_color_setting - Sets the grid_color parameter for the resulting PixGrid.

Errors

Returns an error if the image dimensions are not multiples of cell_size, if the image is empty, or if no colors are found.

Trait Implementations

impl Clone for PixGrid

fn clone(&self) -> PixGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PixGrid

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.