here_be_dragons/src/dungeon/mod.rs

//! Generators for dungeon type maps.
//! 
//! Generators can bu used directly or they can be combined with
//! `MapGenerator`s and `MapModifier`s
//! 
//! * MapGenerators are use to create initial map.
//! * MapModifiers modify existing map.
//! 

pub mod map;
pub mod cellular_automata;

use rand::prelude::*;
use map::Map;


/// Trait which should be implemented by any map generator which want to be used
/// by MapBuilder
pub trait MapGenerator {
    fn generate_map(&self, rng: &mut StdRng) -> Map;
}

/// Trait which should be implemented by map modifier. 
/// Modifier takes initiall map and apply changes to it.
pub trait MapModifier {
    fn modify_map(&self, rng: &mut StdRng, map: &Map) -> Map;
}

/// Used to chain MapBuilder and MapModifiers to create the final map.
pub struct MapBuilder {
    generator: Box<dyn MapGenerator>,
    modifiers: Vec<Box<dyn MapModifier>>,
    rng: StdRng,
}

impl MapBuilder {
    pub fn new(generator : Box<dyn MapGenerator>) -> MapBuilder {
        MapBuilder { 
            generator, 
            modifiers: Vec::new(),
            rng: StdRng::seed_from_u64(0)
        }
    }

    pub fn with(&mut self, modifier : Box<dyn MapModifier>) {
        self.modifiers.push(modifier);
    }

    pub fn build_map(&mut self) -> Map {
        let mut map = self.generator.generate_map(&mut self.rng);
        
        // Build additional layers in turn
        for modifier in self.modifiers.iter() {
            modifier.modify_map(&mut self.rng, &mut map);
        }

        map
    }
}