Struct Generator 

pub struct Generator<C: CoordinateSystem, G: Grid<C>> { /* private fields */ }

Model synthesis/WFC generator. Use a GeneratorBuilder to get an instance of a Generator.

Implementations

impl<C: CoordinateSystem, G: Grid<C>> Generator<C, G>

pub fn builder() -> GeneratorBuilder<Unset, Unset, C, G>

Returns a new GeneratorBuilder

pub fn max_retry_count(&self) -> u32

Returns the max_retry_count: how many time the Generator should retry to generate the Grid when a contradiction is encountered

pub fn set_max_retry_count(&mut self, max_retry_count: u32)

Specifies how many time the Generator should retry to generate the Grid when a contradiction is encountered

pub fn seed(&self) -> u64

Returns the seed that was used to initialize the generator RNG for this generation. See RngMode for more information.

pub fn grid(&self) -> &G

Returns the Grid used by the generator

pub fn rules(&self) -> &Rules<C>

Returns the Rules used by the generator

pub fn nodes_left(&self) -> usize

Returns how many nodes are left to generate

pub fn to_grid_data(&self) -> Option<GridData<C, ModelInstance, G>>

Returns a GridData of ModelInstance with all the nodes generated if the generation is done

Returns None if the generation is still ongoing or currently failed

pub fn generate_grid( &mut self, ) -> Result<(GenInfo, GridData<C, ModelInstance, G>), GeneratorError>

Tries to generate the whole grid. If the generation fails due to a contradiction, it will retry max_retry_count times before returning the last encountered GeneratorError

If the generation is currently done or failed, calling this method will reinitialize the generator with the next seed before starting the generation.

If the generation was already started by previous calls to Generator::set_and_propagate or Generator::select_and_propagate, this will simply continue the current generation.

pub fn generate(&mut self) -> Result<GenInfo, GeneratorError>

Same as Generator::generate_grid but does not return the generated ModelInstance when successful.

Generator::to_grid_data can still be called to retrieve a GridData afterwards.

pub fn select_and_propagate( &mut self, ) -> Result<GenerationStatus, GeneratorError>

Advances the generation by one “step”: select a node and a model via the heuristics and propagate the changes.

• Returns the GenerationStatus if the step executed successfully
• Returns a GeneratorError if the generation fails due to a contradiction.

If the generation is currently done or failed, this method will just return the done or failed status/error.

Note: One call to this method can lead to more than one node generated if the propagation phase forces some other node(s) into a definite state (due to only one possible model remaining on a node)

pub fn select_and_propagate_collected( &mut self, ) -> Result<(GenerationStatus, Vec<GeneratedNode>), GeneratorError>

Same as Generator::select_and_propagate but collects and return the generated GeneratedNode when successful.

pub fn set_and_propagate<N: NodeRef<C, G>, M: ModelVariantRef<C>>( &mut self, node_ref: N, model_variant_ref: M, memorized: bool, ) -> Result<GenerationStatus, NodeSetError>

Tries to set the node referenced by node_ref to the model refrenced by model_variant_ref. Then tries to propagate the change.

• Returns Ok and the current GenerationStatus if successful.
• Returns a NodeSetError if it fails.

If the generation is currently done or failed, this method will just return the done or failed status/error.

Note: One call to this method can lead to more than one node generated if the propagation phase forces some other node(s) into a definite state (due to only one possible model remaining on a node)

pub fn set_and_propagate_collected<N: NodeRef<C, G>, M: ModelVariantRef<C>>( &mut self, node_ref: N, model_variant_ref: M, memorized: bool, ) -> Result<(GenerationStatus, Vec<GeneratedNode>), NodeSetError>

Same as Generator::set_and_propagate but also returns all the GeneratedNode generated by this generation operation if successful.

pub fn reinitialize(&mut self) -> GenerationStatus

Reinitalizes the generator with the next seed (a seed is generated from the current seed)

pub fn reinitialize_collected( &mut self, ) -> (GenerationStatus, Vec<GeneratedNode>)

Same as Generator::reinitialize but also returns all the GeneratedNode generated by this generation operation.

pub fn get_models_on(&self, node_index: NodeIndex) -> Vec<ModelInstance>

Returns all the current possible model instances on node_index

pub fn get_models_variations_on( &self, node_index: NodeIndex, ) -> (Vec<ModelVariations>, u32)

Returns all the current possible model on node_index grouped by variations, as well as the total number of possible models