flatk 0.5.2

Flat layout abstraction toolkit.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

//! This example demonstrates how to compose two components together to form a single component, with a
//! unique structure shared by all the fields.
//!
//! This improves on the `component` example by sharing the structure between `cur` and `prev` fields.

#[cfg(feature = "derive")]
use flatk::{Chunked, Chunked3, Component, Get, MapStorage, View, ViewMut};

#[cfg(feature = "derive")]
#[derive(Copy, Clone, Debug, PartialEq, Component)]
struct State<X, V> {
    pos: X,
    vel: V,
}

#[cfg(feature = "derive")]
#[derive(Copy, Clone, Debug, PartialEq, Component)]
struct Object<X, V> {
    id: usize,
    #[component]
    prev: State<X, V>,
    #[component]
    cur: State<X, V>,
}

#[cfg(feature = "derive")]
fn main() {
    let obj = Object {
        id: 0,
        // Previous state
        prev: State {
            pos: vec![0.0; 9],
            vel: vec![1.0; 9],
        },
        // Current state
        cur: State {
            pos: vec![0.0; 9],
            vel: vec![1.0; 9],
        },
    };

    // Select a structure for the `obj` data.
    let mut state = Chunked::from_sizes(vec![1, 2], Chunked3::from_flat(obj));

    // Push another chunk onto the state.
    state.push_iter(std::iter::once(Object {
        id: 0, /* ignored */
        prev: State {
            pos: [0.0; 3],
            vel: [1.0; 3],
        },
        cur: State {
            pos: [0.0; 3],
            vel: [1.0; 3],
        },
    }));

    // We can access individual elements in the state through indexing using the `View` and `Get`
    // traits.
    assert_eq!(
        state.view().at(0).at(0),
        Object {
            id: 0,
            prev: State {
                pos: &[0.0; 3],
                vel: &[1.0; 3]
            },
            cur: State {
                pos: &[0.0; 3],
                vel: &[1.0; 3]
            }
        }
    );

    // A typical animation loop can be written as follows.

    // Iterate for 20 frames
    for _ in 0..20 {
        let dt = 0.1;
        for mut element in state.view_mut().iter_mut() {
            for Object {
                mut prev, mut cur, ..
            } in element.iter_mut()
            {
                for (prev, cur) in prev.iter_mut().zip(cur.iter_mut()) {
                    *cur.pos += *cur.vel * dt;
                    *prev.pos = *cur.pos;
                }
            }
        }
    }

    // To isolate a particular field in the hierarchy, one can use map_storage, instead of having
    // to destructure the whole hierarchy.

    let prev_pos_only_view = state.view().map_storage(|s| s.prev.pos);

    for chunk in prev_pos_only_view.iter() {
        for pos in chunk.iter() {
            for component in pos.iter() {
                assert!((component - 2.0_f64).abs() < 1e-5);
            }
        }
    }

    dbg!(state);
}

#[cfg(not(feature = "derive"))]
fn main() {
    eprintln!("The `composite_component` example requires the \"derive\" feature flat");
}