layuit 1.2.2

A UI layout library for Rust
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
//! Containers that distribute equal space to children.
//!
//! [`HEqual`] and [`VEqual`] work very similar to [`HStack`] and [`VStack`], but give every child
//! equal space and do not suffer from the [`Full`] alignment caveat.
//!
//! [`Grid`] arranges nodes in a grid, with each child getting equal width and height. Nodes fill
//! from left to right first, and then from top to bottom.
//!
//! [`HEqual`]: crate::grid::HEqual
//! [`VEqual`]: crate::grid::VEqual
//! [`HStack`]: crate::stacks::HStack
//! [`VStack`]: crate::stacks::VStack
//! [`Full`]: crate::Alignment::Full

use indexmap::IndexSet;
use std::num::NonZero;
use thunderdome::Index as TdIndex;

use crate::{Alignment, NodeCache, Rect, UiNode, UiTree};

/// Arranges children from left to right, similar to [`HStack`], but gives every child equal space
/// and does not suffer from the [`Full`] alignment caveat.
///
/// [`HStack`]: crate::stacks::HStack
/// [`Full`]: crate::Alignment::Full
pub struct HEqual {
    align: (Alignment, Alignment),
    children: IndexSet<TdIndex>,
}

impl HEqual {
    /// Creates a new `HEqual` with no children, 0 spacing, and ([`Begin`], [`Begin`]) alignment.
    ///
    /// [`Begin`]: Alignment::Begin
    pub fn new() -> Self {
        Self {
            align: (Alignment::Begin, Alignment::Begin),
            children: IndexSet::new(),
        }
    }

    /// Add a new child to the list.
    pub fn with_child(mut self, index: TdIndex) -> Self {
        self.children.insert(index);
        self
    }

    /// Set the horizontal and vertical alignment.
    pub fn with_align(mut self, align: (Alignment, Alignment)) -> Self {
        self.align = align;
        self
    }

    /// Add a child to the list. The child will appear at the end.
    pub fn add_child(&mut self, index: TdIndex) {
        self.children.insert(index);
    }

    /// Returns the number of children in the list.
    pub fn len(&self) -> usize {
        self.children.len()
    }

    /// Returns `true` if the list is empty.
    ///
    /// Equivalent to `len() == 0`.
    pub fn is_empty(&self) -> bool {
        self.children.is_empty()
    }

    /// Remove a child from the list.
    ///
    /// Returns `true` if the child was removed.
    pub fn remove_child(&mut self, index: usize, tree: &mut UiTree) -> bool {
        let Some(ti) = self.children.shift_remove_index(index) else {
            return false;
        };

        if tree.get_node(ti).is_none() {
            return false;
        }
        tree.remove_node(ti);

        true
    }

    /// Move a child to a new index.
    ///
    /// Returns `true` if the child was moved.
    pub fn set_child_position(&mut self, index: usize, position: usize) -> bool {
        self.children.move_index(index, position);
        true
    }

    /// Returns the tree index associated with a child at a given list index.
    pub fn get_child_index(&self, index: usize) -> Option<TdIndex> {
        self.children.get_index(index).copied()
    }
}

impl Default for HEqual {
    fn default() -> Self {
        Self::new()
    }
}

impl UiNode for HEqual {
    fn get_align(&self) -> (Alignment, Alignment) {
        self.align
    }

    fn get_align_mut(&mut self) -> (&mut Alignment, &mut Alignment) {
        (&mut self.align.0, &mut self.align.1)
    }

    fn calculate_min_size(&self, tree: &UiTree) -> (f32, f32) {
        if self.children.is_empty() {
            return (0.0, 0.0);
        }

        let mut w = 0.0f32;
        let mut h = 0.0f32;
        for child in &self.children {
            let child = tree.get_cache(*child).expect("Child not in cache");
            let (cw, ch) = child.min_size;
            w = w.max(cw);
            h = h.max(ch);
        }

        (w * (self.len() as f32), h)
    }

    fn calculate_rects(&self, cache: &NodeCache, tree: &UiTree) -> Vec<Rect> {
        if self.is_empty() {
            return vec![];
        }

        let mut child_rects = Vec::with_capacity(self.children.len());

        let w = cache.rect.w / (self.len() as f32);

        let mut x = cache.rect.x;
        for child in &self.children {
            let child_min = tree.get_cache(*child).expect("Child not in cache").min_size;
            let child = tree.get_node(*child).expect("Child not in arena");

            let space =
                Rect::new(x, cache.rect.y, w, cache.rect.h).align(child.get_align(), child_min);
            child_rects.push(space);
            x += w;
        }

        child_rects
    }

    fn get_children(&self) -> Vec<TdIndex> {
        self.children.iter().copied().collect()
    }
}

/// Arranges children from top to bottom, similar to [`VStack`], but gives every child equal space
/// and does not suffer from the [`Full`] alignment caveat.
///
/// [`VStack`]: crate::stacks::VStack
/// [`Full`]: crate::Alignment::Full
pub struct VEqual {
    align: (Alignment, Alignment),
    children: IndexSet<TdIndex>,
}

impl VEqual {
    /// Creates a new `VEqual` with no children, 0 spacing, and ([`Begin`], [`Begin`]) alignment.
    ///
    /// [`Begin`]: Alignment::Begin
    pub fn new() -> Self {
        Self {
            align: (Alignment::Begin, Alignment::Begin),
            children: IndexSet::new(),
        }
    }

    /// Add a new child to the list.
    pub fn with_child(mut self, index: TdIndex) -> Self {
        self.children.insert(index);
        self
    }

    /// Set the horizontal and vertical alignment.
    pub fn with_align(mut self, align: (Alignment, Alignment)) -> Self {
        self.align = align;
        self
    }

    /// Add a child to the list. The child will appear at the end.
    pub fn add_child(&mut self, index: TdIndex) {
        self.children.insert(index);
    }

    /// Returns the number of children in the list.
    pub fn len(&self) -> usize {
        self.children.len()
    }

    /// Returns `true` if the list is empty.
    ///
    /// Equivalent to `len() == 0`.
    pub fn is_empty(&self) -> bool {
        self.children.is_empty()
    }

    /// Remove a child from the list.
    ///
    /// Returns `true` if the child was removed.
    pub fn remove_child(&mut self, index: usize, tree: &mut UiTree) -> bool {
        let Some(ti) = self.children.shift_remove_index(index) else {
            return false;
        };

        if tree.get_node(ti).is_none() {
            return false;
        }
        tree.remove_node(ti);

        true
    }

    /// Move a child to a new index.
    ///
    /// Returns `true` if the child was moved.
    pub fn set_child_position(&mut self, index: usize, position: usize) -> bool {
        self.children.move_index(index, position);
        true
    }

    /// Returns the tree index associated with a child at a given list index.
    pub fn get_child_index(&self, index: usize) -> Option<TdIndex> {
        self.children.get_index(index).copied()
    }
}

impl Default for VEqual {
    fn default() -> Self {
        Self::new()
    }
}

impl UiNode for VEqual {
    fn get_align(&self) -> (Alignment, Alignment) {
        self.align
    }

    fn get_align_mut(&mut self) -> (&mut Alignment, &mut Alignment) {
        (&mut self.align.0, &mut self.align.1)
    }

    fn calculate_min_size(&self, tree: &UiTree) -> (f32, f32) {
        if self.children.is_empty() {
            return (0.0, 0.0);
        }

        let mut w = 0.0f32;
        let mut h = 0.0f32;
        for child in &self.children {
            let child = tree.get_cache(*child).expect("Child not in cache");
            let (cw, ch) = child.min_size;
            w = w.max(cw);
            h = h.max(ch);
        }

        (w, h * (self.len() as f32))
    }

    fn calculate_rects(&self, cache: &NodeCache, tree: &UiTree) -> Vec<Rect> {
        if self.is_empty() {
            return vec![];
        }

        let mut child_rects = Vec::with_capacity(self.children.len());

        let h = cache.rect.h / (self.len() as f32);

        let mut y = cache.rect.y;
        for child in &self.children {
            let child_min = tree.get_cache(*child).expect("Child not in cache").min_size;
            let child = tree.get_node(*child).expect("Child not in arena");

            let space =
                Rect::new(cache.rect.x, y, cache.rect.w, h).align(child.get_align(), child_min);
            child_rects.push(space);
            y += h;
        }

        child_rects
    }

    fn get_children(&self) -> Vec<TdIndex> {
        self.children.iter().copied().collect()
    }
}

/// Arranges children in a grid of equally-sized cells, from left to right and then top to bottom.
pub struct Grid {
    pub num_cols: NonZero<usize>,

    align: (Alignment, Alignment),
    children: IndexSet<TdIndex>,
}

impl Grid {
    /// Create a new grid with the specified number of columns.
    pub fn new(num_cols: NonZero<usize>) -> Self {
        Self {
            num_cols,
            align: (Alignment::Full, Alignment::Full),
            children: IndexSet::new(),
        }
    }

    /// Add a new child to the grid.
    pub fn with_child(mut self, index: TdIndex) -> Self {
        self.children.insert(index);
        self
    }

    /// Set the horizontal and vertical alignment.
    pub fn with_align(mut self, align: (Alignment, Alignment)) -> Self {
        self.align = align;
        self
    }

    /// Add a child to the grid. The child will appear at the end.
    pub fn add_child(&mut self, index: TdIndex) {
        self.children.insert(index);
    }

    /// Returns the number of children in the grid.
    pub fn len(&self) -> usize {
        self.children.len()
    }

    /// Returns `true` if the grid is empty.
    ///
    /// Equivalent to `len() == 0`.
    pub fn is_empty(&self) -> bool {
        self.children.is_empty()
    }

    /// Remove a child from the grid.
    ///
    /// Returns `true` if the child was removed.
    pub fn remove_child(&mut self, index: usize, tree: &mut UiTree) -> bool {
        let Some(ti) = self.children.shift_remove_index(index) else {
            return false;
        };

        if tree.get_node(ti).is_none() {
            return false;
        }
        tree.remove_node(ti);

        true
    }

    /// Move a child to a new index.
    ///
    /// Returns `true` if the child was moved.
    pub fn set_child_position(&mut self, index: usize, position: usize) -> bool {
        self.children.move_index(index, position);
        true
    }

    /// Returns the tree index associated with a child at a given list index.
    pub fn get_child_index(&self, index: usize) -> Option<TdIndex> {
        self.children.get_index(index).copied()
    }
}

impl UiNode for Grid {
    fn get_align(&self) -> (Alignment, Alignment) {
        self.align
    }

    fn get_align_mut(&mut self) -> (&mut Alignment, &mut Alignment) {
        (&mut self.align.0, &mut self.align.1)
    }

    fn calculate_min_size(&self, tree: &UiTree) -> (f32, f32) {
        let mut w = 0.0f32;
        let mut h = 0.0f32;
        for child in &self.children {
            let (cw, ch) = tree.get_cache(*child).expect("Child not in cache").min_size;
            w = w.max(cw);
            h = h.max(ch);
        }

        let num_rows = self.len().div_ceil(self.num_cols.get());

        (w * self.num_cols.get() as f32, h * num_rows as f32)
    }

    fn calculate_rects(&self, cache: &NodeCache, tree: &UiTree) -> Vec<Rect> {
        let mut child_rects = Vec::with_capacity(self.children.len());

        let num_rows = self.len().div_ceil(self.num_cols.get());
        let dx = cache.rect.w / (self.num_cols.get() as f32);
        let dy = cache.rect.h / (num_rows as f32);

        let mut col = 0;
        let mut x = cache.rect.x;
        let mut y = cache.rect.y;
        for child in &self.children {
            let child_min = tree.get_cache(*child).expect("Child not in cache").min_size;
            let child = tree.get_node(*child).expect("Child not in arena");

            let space = Rect::new(x, y, dx, dy).align(child.get_align(), child_min);
            child_rects.push(space);

            col += 1;
            if col >= self.num_cols.get() {
                col = 0;
                x = cache.rect.x;
                y += dy;
            } else {
                x += dx;
            }
        }

        child_rects
    }

    fn get_children(&self) -> Vec<TdIndex> {
        self.children.iter().copied().collect()
    }
}