Struct WfcContext 

pub struct WfcContext<'a, TBitSet>
where
    TBitSet: BitSearch + BitEmpty + BitSet + BitIntersection + BitUnion + BitTestNone + Hash + Eq + Copy + BitIntersection<Output = TBitSet> + BitUnion<Output = TBitSet>,
{ /* private fields */ }

A heart of WFC. Does an actual collapse work

Implementations

impl<'a, TBitSet> WfcContext<'a, TBitSet>

where TBitSet: BitSearch + BitEmpty + BitSet + BitIntersection + BitUnion + BitTestNone + Hash + Eq + Copy + BitIntersection<Output = TBitSet> + BitUnion<Output = TBitSet>,

pub fn local_collapse( &mut self, row: usize, column: usize, module: usize, result_transmitter: Sender<Result<Vec<usize>, WfcError>>, )

A function which lets a user to “draw” some new parts above existing collapse result

When the work is done, the result is being sent through result_transmitter to a corresponding receiver

The successful result is composed of a vec with a size = (self.width * self.height) indices of modules which have been chosen of corresponding slots during collapse

pub fn set_module(&mut self, row: usize, column: usize, module: usize)

A function which lets a user to “preset” some modules before doing actual collapse

Examples found in repository

examples/dungeon.rs (line 358)

    pub fn generate_new_map(&mut self) {
        let mut wfc_context: WfcContext<CustomBitSet> = WfcContextBuilder
            ::new(&self.modules, self.w, self.h)
            .build();

        let (tx, rc) = channel();

        // Preset some fields in a map with a void to enforce more island-ish look
        {
            wfc_context.set_module(0, 0, 0);
            wfc_context.set_module(self.h - 1, 0, 0);
            wfc_context.set_module(0, self.w - 1, 0);
            wfc_context.set_module(self.h - 1, self.w - 1, 0);
            wfc_context.set_module(self.h / 2, self.w / 2, 0);
        }

        wfc_context.collapse(100, tx.clone());

        let results = rc.recv()
            .unwrap()
            .unwrap_or_else(|_| vec![0; self.w * self.h]);

        self.map_data.clear();
        for &idx in results.iter() {
            let random_id = rand::gen_range(0, self.tiles[idx].subrects.len());
            self.map_data.push((idx, random_id));
        }
    }

pub fn collapse( &mut self, max_contradictions: i32, result_transmitter: Sender<Result<Vec<usize>, WfcError>>, )

A function which is making actual collapse

When the work is done, the result is being sent through result_transmitter to a corresponding receiver

The successful result is composed of a vec with a size = (self.width * self.height) indices of modules which have been chosen of corresponding slots during collapse

Examples found in repository

examples/wang_corner_carpet.rs (line 159)

    pub fn generate_new_map(&mut self) {
        let mut wfc_context: WfcContext<CustomBitSet> = WfcContextBuilder
        ::new(&self.modules, self.w, self.h)
            .build();

        let (tx, rc) = channel();

        wfc_context.collapse(100, tx.clone());

        let results = rc.recv()
            .unwrap()
            .unwrap_or_else(|_| vec![0; self.w * self.h]);

        self.map_data.clear();
        self.map_data.extend_from_slice(&results[..]);
    }

examples/summer_garden.rs (line 425)

    pub fn generate_new_map(&mut self) {
        let mut wfc_context: WfcContext<CustomBitSet> = WfcContextBuilder
        ::new(&self.modules, self.w, self.h)
            .build();

        let (tx, rc) = channel();

        wfc_context.collapse(100, tx.clone());

        let results = rc.recv()
            .unwrap()
            .unwrap_or_else(|_| vec![0; self.w * self.h]);

        self.map_data.clear();
        self.map_data.extend_from_slice(&results[..]);

        self.plant_trees()
    }

examples/dungeon.rs (line 365)

    pub fn generate_new_map(&mut self) {
        let mut wfc_context: WfcContext<CustomBitSet> = WfcContextBuilder
            ::new(&self.modules, self.w, self.h)
            .build();

        let (tx, rc) = channel();

        // Preset some fields in a map with a void to enforce more island-ish look
        {
            wfc_context.set_module(0, 0, 0);
            wfc_context.set_module(self.h - 1, 0, 0);
            wfc_context.set_module(0, self.w - 1, 0);
            wfc_context.set_module(self.h - 1, self.w - 1, 0);
            wfc_context.set_module(self.h / 2, self.w / 2, 0);
        }

        wfc_context.collapse(100, tx.clone());

        let results = rc.recv()
            .unwrap()
            .unwrap_or_else(|_| vec![0; self.w * self.h]);

        self.map_data.clear();
        for &idx in results.iter() {
            let random_id = rand::gen_range(0, self.tiles[idx].subrects.len());
            self.map_data.push((idx, random_id));
        }
    }