LSystemBuilder

Struct LSystemBuilder 

Source
pub struct LSystemBuilder { /* private fields */ }

Implementations§

Source§

impl LSystemBuilder

Source

pub fn new() -> Self

Examples found in repository?
examples/cantor_set.rs (line 7)
6fn main() {
7    let mut builder = LSystemBuilder::new();
8
9    let a = builder.token("A");
10    let b = builder.token("B");
11
12    builder.axiom(vec![a]);
13    builder.transformation_rule(a, vec![a, b, a]);
14    builder.transformation_rule(b, vec![b, b, b]);
15
16    let mut system = builder.finish();
17
18    // the total number of states (including the initial state!) to render
19    let step_limit = 6;
20
21    // At state number `step_limit`, our diagram has 3^(step_limit - 1) bars,
22    // so we make the width of our image an integer multiple of this number.
23    let width = 3_u32.pow(step_limit - 1) * 2;
24
25    // the vertical spacing between each bar in the render
26    let vertical_spacing = 5;
27
28    let mut lines = Vec::new();
29
30    for index in 0..step_limit {
31        let state = system.get_state();
32        let bar_width: u32 = width / state.len() as u32;
33
34        let mut x: u32 = 0;
35        let y = vertical_spacing * index;
36
37        for token in state {
38            if *token == a {
39                // draw a line
40                lines.push((x, y, x + bar_width, y));
41            }
42            x += bar_width;
43        }
44
45        system.step();
46    }
47
48    let padding: u32 = 5;
49    let render_width = 2 * padding + width as u32;
50    let render_height = 2 * padding + vertical_spacing * (step_limit - 1);
51
52    let mut buffer = ImageBuffer::new(render_width, render_height);
53
54    // Make the buffer entirely white
55    fill_mut(&mut buffer, Rgb([255u8, 255u8, 255u8]));
56
57    // Draw the lines
58    for (x1, y1, x2, y2) in lines.into_iter() {
59        for x in x1..=x2 {
60            for y in y1..=y2 {
61                let pixel = buffer.get_pixel_mut(x + padding, y + padding);
62                *pixel = Rgb([0u8, 0u8, 0u8]);
63            }
64        }
65    }
66
67    buffer
68        .save("cantor_set.png")
69        .expect("Failed to save to cantor_set.png");
70}
Source

pub fn token<S: Into<String>>(&mut self, name: S) -> ArenaId

Register a new token.

Returns a TokenId which can be used (in this LSystem) to refer to the registered token.

Examples found in repository?
examples/cantor_set.rs (line 9)
6fn main() {
7    let mut builder = LSystemBuilder::new();
8
9    let a = builder.token("A");
10    let b = builder.token("B");
11
12    builder.axiom(vec![a]);
13    builder.transformation_rule(a, vec![a, b, a]);
14    builder.transformation_rule(b, vec![b, b, b]);
15
16    let mut system = builder.finish();
17
18    // the total number of states (including the initial state!) to render
19    let step_limit = 6;
20
21    // At state number `step_limit`, our diagram has 3^(step_limit - 1) bars,
22    // so we make the width of our image an integer multiple of this number.
23    let width = 3_u32.pow(step_limit - 1) * 2;
24
25    // the vertical spacing between each bar in the render
26    let vertical_spacing = 5;
27
28    let mut lines = Vec::new();
29
30    for index in 0..step_limit {
31        let state = system.get_state();
32        let bar_width: u32 = width / state.len() as u32;
33
34        let mut x: u32 = 0;
35        let y = vertical_spacing * index;
36
37        for token in state {
38            if *token == a {
39                // draw a line
40                lines.push((x, y, x + bar_width, y));
41            }
42            x += bar_width;
43        }
44
45        system.step();
46    }
47
48    let padding: u32 = 5;
49    let render_width = 2 * padding + width as u32;
50    let render_height = 2 * padding + vertical_spacing * (step_limit - 1);
51
52    let mut buffer = ImageBuffer::new(render_width, render_height);
53
54    // Make the buffer entirely white
55    fill_mut(&mut buffer, Rgb([255u8, 255u8, 255u8]));
56
57    // Draw the lines
58    for (x1, y1, x2, y2) in lines.into_iter() {
59        for x in x1..=x2 {
60            for y in y1..=y2 {
61                let pixel = buffer.get_pixel_mut(x + padding, y + padding);
62                *pixel = Rgb([0u8, 0u8, 0u8]);
63            }
64        }
65    }
66
67    buffer
68        .save("cantor_set.png")
69        .expect("Failed to save to cantor_set.png");
70}
Source

pub fn transformation_rule( &mut self, predecessor: ArenaId, successor: Vec<ArenaId>, )

Register a new transformation rule in this LSystem.

If any of the provided TokenId are invalid, this function will panic.

Examples found in repository?
examples/cantor_set.rs (line 13)
6fn main() {
7    let mut builder = LSystemBuilder::new();
8
9    let a = builder.token("A");
10    let b = builder.token("B");
11
12    builder.axiom(vec![a]);
13    builder.transformation_rule(a, vec![a, b, a]);
14    builder.transformation_rule(b, vec![b, b, b]);
15
16    let mut system = builder.finish();
17
18    // the total number of states (including the initial state!) to render
19    let step_limit = 6;
20
21    // At state number `step_limit`, our diagram has 3^(step_limit - 1) bars,
22    // so we make the width of our image an integer multiple of this number.
23    let width = 3_u32.pow(step_limit - 1) * 2;
24
25    // the vertical spacing between each bar in the render
26    let vertical_spacing = 5;
27
28    let mut lines = Vec::new();
29
30    for index in 0..step_limit {
31        let state = system.get_state();
32        let bar_width: u32 = width / state.len() as u32;
33
34        let mut x: u32 = 0;
35        let y = vertical_spacing * index;
36
37        for token in state {
38            if *token == a {
39                // draw a line
40                lines.push((x, y, x + bar_width, y));
41            }
42            x += bar_width;
43        }
44
45        system.step();
46    }
47
48    let padding: u32 = 5;
49    let render_width = 2 * padding + width as u32;
50    let render_height = 2 * padding + vertical_spacing * (step_limit - 1);
51
52    let mut buffer = ImageBuffer::new(render_width, render_height);
53
54    // Make the buffer entirely white
55    fill_mut(&mut buffer, Rgb([255u8, 255u8, 255u8]));
56
57    // Draw the lines
58    for (x1, y1, x2, y2) in lines.into_iter() {
59        for x in x1..=x2 {
60            for y in y1..=y2 {
61                let pixel = buffer.get_pixel_mut(x + padding, y + padding);
62                *pixel = Rgb([0u8, 0u8, 0u8]);
63            }
64        }
65    }
66
67    buffer
68        .save("cantor_set.png")
69        .expect("Failed to save to cantor_set.png");
70}
Source

pub fn axiom(&mut self, axiom: Vec<ArenaId>)

Set the axiom for this LSystem.

Examples found in repository?
examples/cantor_set.rs (line 12)
6fn main() {
7    let mut builder = LSystemBuilder::new();
8
9    let a = builder.token("A");
10    let b = builder.token("B");
11
12    builder.axiom(vec![a]);
13    builder.transformation_rule(a, vec![a, b, a]);
14    builder.transformation_rule(b, vec![b, b, b]);
15
16    let mut system = builder.finish();
17
18    // the total number of states (including the initial state!) to render
19    let step_limit = 6;
20
21    // At state number `step_limit`, our diagram has 3^(step_limit - 1) bars,
22    // so we make the width of our image an integer multiple of this number.
23    let width = 3_u32.pow(step_limit - 1) * 2;
24
25    // the vertical spacing between each bar in the render
26    let vertical_spacing = 5;
27
28    let mut lines = Vec::new();
29
30    for index in 0..step_limit {
31        let state = system.get_state();
32        let bar_width: u32 = width / state.len() as u32;
33
34        let mut x: u32 = 0;
35        let y = vertical_spacing * index;
36
37        for token in state {
38            if *token == a {
39                // draw a line
40                lines.push((x, y, x + bar_width, y));
41            }
42            x += bar_width;
43        }
44
45        system.step();
46    }
47
48    let padding: u32 = 5;
49    let render_width = 2 * padding + width as u32;
50    let render_height = 2 * padding + vertical_spacing * (step_limit - 1);
51
52    let mut buffer = ImageBuffer::new(render_width, render_height);
53
54    // Make the buffer entirely white
55    fill_mut(&mut buffer, Rgb([255u8, 255u8, 255u8]));
56
57    // Draw the lines
58    for (x1, y1, x2, y2) in lines.into_iter() {
59        for x in x1..=x2 {
60            for y in y1..=y2 {
61                let pixel = buffer.get_pixel_mut(x + padding, y + padding);
62                *pixel = Rgb([0u8, 0u8, 0u8]);
63            }
64        }
65    }
66
67    buffer
68        .save("cantor_set.png")
69        .expect("Failed to save to cantor_set.png");
70}
Source

pub fn finish(self) -> LSystem

Consumes the builder, returning an LSystem instance.

This function will panic if you have not set an axiom before proceeding.

Examples found in repository?
examples/cantor_set.rs (line 16)
6fn main() {
7    let mut builder = LSystemBuilder::new();
8
9    let a = builder.token("A");
10    let b = builder.token("B");
11
12    builder.axiom(vec![a]);
13    builder.transformation_rule(a, vec![a, b, a]);
14    builder.transformation_rule(b, vec![b, b, b]);
15
16    let mut system = builder.finish();
17
18    // the total number of states (including the initial state!) to render
19    let step_limit = 6;
20
21    // At state number `step_limit`, our diagram has 3^(step_limit - 1) bars,
22    // so we make the width of our image an integer multiple of this number.
23    let width = 3_u32.pow(step_limit - 1) * 2;
24
25    // the vertical spacing between each bar in the render
26    let vertical_spacing = 5;
27
28    let mut lines = Vec::new();
29
30    for index in 0..step_limit {
31        let state = system.get_state();
32        let bar_width: u32 = width / state.len() as u32;
33
34        let mut x: u32 = 0;
35        let y = vertical_spacing * index;
36
37        for token in state {
38            if *token == a {
39                // draw a line
40                lines.push((x, y, x + bar_width, y));
41            }
42            x += bar_width;
43        }
44
45        system.step();
46    }
47
48    let padding: u32 = 5;
49    let render_width = 2 * padding + width as u32;
50    let render_height = 2 * padding + vertical_spacing * (step_limit - 1);
51
52    let mut buffer = ImageBuffer::new(render_width, render_height);
53
54    // Make the buffer entirely white
55    fill_mut(&mut buffer, Rgb([255u8, 255u8, 255u8]));
56
57    // Draw the lines
58    for (x1, y1, x2, y2) in lines.into_iter() {
59        for x in x1..=x2 {
60            for y in y1..=y2 {
61                let pixel = buffer.get_pixel_mut(x + padding, y + padding);
62                *pixel = Rgb([0u8, 0u8, 0u8]);
63            }
64        }
65    }
66
67    buffer
68        .save("cantor_set.png")
69        .expect("Failed to save to cantor_set.png");
70}

Trait Implementations§

Source§

impl Clone for LSystemBuilder

Source§

fn clone(&self) -> LSystemBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LSystemBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LSystemBuilder

Source§

fn default() -> LSystemBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src
where Scheme: ApproxScheme,

Source§

type Err = NoError

The error type produced by a failed conversion.
Source§

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.
Source§

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src
where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

Source§

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.
Source§

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, Dst> ConvAsUtil<Dst> for T

Source§

fn approx(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Approximate the subject with the default scheme.
Source§

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Approximate the subject with a specific scheme.
Source§

impl<T> ConvUtil for T

Source§

fn approx_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Approximate the subject to a given type with the default scheme.
Source§

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.
Source§

fn into_as<Dst>(self) -> Dst
where Self: Sized + Into<Dst>,

Convert the subject to a given type.
Source§

fn try_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + TryInto<Dst>,

Attempt to convert the subject to a given type.
Source§

fn value_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<Src> TryFrom<Src> for Src

Source§

type Err = NoError

The error type produced by a failed conversion.
Source§

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<Src, Dst> TryInto<Dst> for Src
where Dst: TryFrom<Src>,

Source§

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.
Source§

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<Src> ValueFrom<Src> for Src

Source§

type Err = NoError

The error type produced by a failed conversion.
Source§

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Convert the given value into an exactly equivalent representation.
Source§

impl<Src, Dst> ValueInto<Dst> for Src
where Dst: ValueFrom<Src>,

Source§

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.
Source§

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Convert the subject into an exactly equivalent representation.