Struct wavefc::Wave

pub struct Wave {
    pub flags: Vec<Flags>,
    /* private fields */
}

Encapsulation for the Wave Function Collapse implementation.

Fields

flags: Vec<Flags>

Implementations

impl Wave

pub fn new() -> Self

pub fn set_debug(&mut self)

Sets the debug mode for the wave. This will print some extra output helpful for debugging.

pub fn collapse_all<F>(
    &mut self,
    max_contradictions: usize,
    callback: Option<F>
) -> Result<(), String>where
    F: Fn(usize, usize, Vec<Vec<Vec<usize>>>),

Collapses continuously until the wave function either completely collapses or the max number of contradictions (attempts has been reached).

Arguments

• callback: An optional function which accepts the number of iterations and failures occured, as well as the current state of the wave function. This can be used for logging or print purposes.

Notes

• The number of iterations resets after a failed attempt. The number of failures is never reset.
• The current representation (Vec<Vec<Vec<usize>>>) is provided in the callback as its not available while the function is borrowing the Wave.
• No final perfect result is returned from a successful run as to avoid doing extra work in case the caller doesn’t need the final representation.
• When an error is returned, the final state at which the error occurred is preserved in the wave.

pub fn perfect_rep(&self) -> Result<Vec<Vec<usize>>, String>

pub fn current_rep(&self) -> Vec<Vec<Vec<usize>>>

pub fn collapse_once(&mut self)

Causing the wave to perform one collapse. This will also cause consequent propagation.

Notes

• The wave doesn’t stop propogating until its completely iterated over the entire superposition grid. It does this as, although on the first run it doesn’t make much sense, on future runs it will propagate out changes between the sites of different collapses.
• After this function is called, it saves what it did to a private history log.
  • This can be disabled using the NoHistory flag.
• If the internal superposition grid is empty, this function will do nothing.

pub fn propagate(&mut self, center_element: usize)

pub fn fill(&mut self, size: Vector2<usize>) -> Result<(), String>

pub fn analyze(
    &mut self,
    input: Vec<Vec<usize>>,
    chunk_size: Vector2<usize>,
    border_mode: BorderMode
)

Please note, the flag Flag::NoTransforms must be set at this point for it to be registered.

impl Wave

pub fn clear_history(&mut self)

Clears the wave’s internal history log.

pub fn undo_collapse(&mut self, remove_record: bool) -> Result<(), String>

Undo’s the last collapse undertaken by the algorithm.

Parameters:

• remove_record: Determines whether the operation being undone should be forgotten in the internal history log or remembered.

Notes:

• If the internal history log for the Wave is empty, this function does nothing.
• If remove_record is set to true, if an error is returned, DO NOT attempt another undo.
  • In this situation, the last undo will have been marked as undone but an error occurred during this process. Undoing again will likely result in an error for a variety of reasons.

pub fn redo_collapse(&mut self) -> Result<(), String>

Redos the previous undo if one occured. Otherwise, this function does nothing.

Notes: