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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
//! This is a public API for layouting: laying out different widgets on the screen.
//!
//! At the core you can imagine the box as having a position ([`CxLayoutBox::pos`]), a "sandbox" that
//! it can move in (delineated by [`CxLayoutBox::origin`] and [`CxLayoutBox::width`] and [`CxLayoutBox::height`]).
//!
//! Its movement is determined primarily by the [`Layout`] that you pass in, and you can modify it
//! ad-hoc by calling various functions.
//!
//! Boxes can be nested, so we have a stack of boxes in [`Cx::layout_boxes`]. The last [`CxLayoutBox`] on
//! the stack is the "current" or "active" box. When you call [`Cx::end_typed_box`], the last box's
//! "sandbox" [`Rect`] will be used to move the draw position of the parent box.
//!
//! A core philosophy of the box model is its simplicity and speed, by having only a single pass
//! to do layouting. Contrast this with systems like [CSS Flexbox](https://en.wikipedia.org/wiki/CSS_Flexible_Box_Layout),
//! which use a constraint satisfaction system to lay out your widgets. Instead, we make a single
//! pass, but do sometimes shift over individual elements after the fact, typically using
//! [`Cx::layout_box_align_list`]. When doing this we can regard it as a "1.5-pass" rendering. Currently
//! we have to go through every individual element if we want to move it, but in the future we could
//! exploit groupings of elements in [`View`]s and [`DrawCall`]s, and set uniforms on them.
//!
//! TODO(JP): The way the boxes move around is quite confusing in a lot of cases! This model
//! probably requires a complete rework. We can take inspiration from other layouting systems (e.g.
//! the [CSS box model](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/The_box_model))

use crate::*;

impl Cx {
    /// Starts the box that has it elements layed out horizontally (as a row)
    pub fn begin_row(&mut self, width: Width, height: Height) {
        self.begin_typed_box(
            CxBoxType::Row,
            Layout { direction: Direction::Right, layout_size: LayoutSize { width, height }, ..Layout::default() },
        );
    }

    /// Ends the current block that was opened by [`Cx::begin_row`].
    /// Returns a [`Rect`] representing the overall area of that row
    pub fn end_row(&mut self) -> Rect {
        self.end_typed_box(CxBoxType::Row)
    }

    /// Starts the box that has it elements layed out vertically (as a column)
    pub fn begin_column(&mut self, width: Width, height: Height) {
        self.begin_typed_box(
            CxBoxType::Column,
            Layout { direction: Direction::Down, layout_size: LayoutSize { width, height }, ..Layout::default() },
        );
    }

    /// Ends the current block that was opened by [`Cx::begin_column`].
    /// Returns a [`Rect`] representing the overall area of that column
    pub fn end_column(&mut self) -> Rect {
        self.end_typed_box(CxBoxType::Column)
    }

    /// Starts alignment element that fills all remaining space by y axis and centers content by it
    pub fn begin_center_y_align(&mut self) {
        let parent = self.layout_boxes.last().unwrap();
        let layout_box = CxLayoutBox {
            align_list_x_start_index: self.layout_box_align_list.len(),
            align_list_y_start_index: self.layout_box_align_list.len(),
            origin: parent.pos,
            pos: parent.pos,
            // fills out all remaining space by y axis
            layout: Layout { layout_size: LayoutSize { height: Height::Fill, ..parent.layout.layout_size }, ..parent.layout },
            biggest: 0.0,
            bound_right_bottom: Vec2 { x: std::f32::NEG_INFINITY, y: std::f32::NEG_INFINITY },
            width: self.get_width_left(),
            height: self.get_height_left(),
            abs_size: parent.abs_size,
            box_type: CxBoxType::CenterYAlign,
            available_width: parent.get_width_left(),
            available_height: parent.get_height_left(),
        };
        self.layout_boxes.push(layout_box);
    }

    pub fn end_center_y_align(&mut self) {
        self.assert_last_box_type_matches(CxBoxType::CenterYAlign);

        let layout_box = self.layout_boxes.pop().unwrap();
        let dy = Cx::compute_align_box_y(&layout_box, AlignY::CENTER);
        let align_start = layout_box.align_list_y_start_index;
        self.do_align_y(dy, align_start);

        let parent = self.layout_boxes.last_mut().unwrap();
        // TODO(Dmitry): communicating only few updates to parent for now. It's possible we need more.
        parent.bound_right_bottom.x = parent.bound_right_bottom.x.max(layout_box.bound_right_bottom.x);
        parent.pos = layout_box.pos;
    }

    /// Starts alignment element that fills all remaining space in box and centers content by x and y
    pub fn begin_center_x_and_y_align(&mut self) {
        let parent = self.layout_boxes.last().unwrap();
        let layout_box = CxLayoutBox {
            align_list_x_start_index: self.layout_box_align_list.len(),
            align_list_y_start_index: self.layout_box_align_list.len(),
            origin: parent.pos,
            pos: parent.pos,
            // fills out all remaining space by both axis
            layout: Layout { layout_size: LayoutSize { width: Width::Fill, height: Height::Fill }, ..parent.layout },
            biggest: 0.0,
            bound_right_bottom: Vec2 { x: std::f32::NEG_INFINITY, y: std::f32::NEG_INFINITY },
            width: self.get_width_left(),
            height: self.get_height_left(),
            abs_size: parent.abs_size,
            box_type: CxBoxType::CenterXYAlign,
            available_width: parent.get_width_left(),
            available_height: parent.get_height_left(),
        };
        self.layout_boxes.push(layout_box);
    }

    pub fn end_center_x_and_y_align(&mut self) {
        self.assert_last_box_type_matches(CxBoxType::CenterXYAlign);
        let layout_box = self.layout_boxes.pop().unwrap();

        let dx = Cx::compute_align_box_x(&layout_box, AlignX::CENTER);
        self.do_align_x(dx, layout_box.align_list_x_start_index);

        let dy = Cx::compute_align_box_y(&layout_box, AlignY::CENTER);
        self.do_align_y(dy, layout_box.align_list_y_start_index);

        // TODO(Dmitry): we are not communicating any changes back to parent since we are filling all remaining place
        // it's possible this breaks in some cases
    }

    // Start new box that will be on the bottom by y axis
    pub fn begin_bottom_box(&mut self) {
        let parent = self.layout_boxes.last().unwrap();
        let layout_box = CxLayoutBox {
            align_list_x_start_index: self.layout_box_align_list.len(),
            align_list_y_start_index: self.layout_box_align_list.len(),
            origin: parent.pos,
            pos: parent.pos,
            layout: parent.layout,
            biggest: 0.0,
            bound_right_bottom: Vec2 { x: std::f32::NEG_INFINITY, y: std::f32::NEG_INFINITY },
            width: parent.width,
            height: parent.height,
            abs_size: parent.abs_size,
            box_type: CxBoxType::BottomBox,
            available_width: parent.get_width_left(),
            available_height: parent.get_height_left(),
        };
        self.layout_boxes.push(layout_box);
    }

    pub fn end_bottom_box(&mut self) {
        self.assert_last_box_type_matches(CxBoxType::BottomBox);

        let layout_box = self.layout_boxes.pop().unwrap();
        let parent = self.layout_boxes.last_mut().unwrap();

        let drawn_height = layout_box.bound_right_bottom.y - layout_box.origin.y;
        let last_y = parent.origin.y + parent.available_height;
        let dy = last_y - layout_box.bound_right_bottom.y;
        // update parent
        parent.available_height -= drawn_height;
        parent.pos = layout_box.origin;
        parent.bound_right_bottom.x = parent.bound_right_bottom.x.max(layout_box.bound_right_bottom.x);
        parent.bound_right_bottom.y = last_y;

        let align_start = layout_box.align_list_y_start_index;
        self.do_align_y(dy, align_start);
    }

    /// Starts alignment element that fills all remaining space by x axis and centers content by it
    pub fn begin_center_x_align(&mut self) {
        let parent = self.layout_boxes.last().unwrap();
        let layout_box = CxLayoutBox {
            align_list_x_start_index: self.layout_box_align_list.len(),
            align_list_y_start_index: self.layout_box_align_list.len(),
            origin: parent.pos,
            pos: parent.pos,
            // fills out all remaining space by x axis
            layout: Layout { layout_size: LayoutSize { width: Width::Fill, ..parent.layout.layout_size }, ..parent.layout },
            biggest: 0.0,
            bound_right_bottom: Vec2 { x: std::f32::NEG_INFINITY, y: std::f32::NEG_INFINITY },
            width: self.get_width_left(),
            height: self.get_height_left(),
            abs_size: parent.abs_size,
            box_type: CxBoxType::CenterXAlign,
            available_width: parent.get_width_left(),
            available_height: parent.get_height_left(),
        };
        self.layout_boxes.push(layout_box);
    }

    pub fn end_center_x_align(&mut self) {
        self.assert_last_box_type_matches(CxBoxType::CenterXAlign);

        let layout_box = self.layout_boxes.pop().unwrap();
        let dx = Cx::compute_align_box_x(&layout_box, AlignX::CENTER);
        let align_start = layout_box.align_list_x_start_index;
        self.do_align_x(dx, align_start);

        let parent = self.layout_boxes.last_mut().unwrap();
        // TODO(Dmitry): communicating only few updates to parent for now. It's possible we need more.
        parent.bound_right_bottom.y = parent.bound_right_bottom.y.max(layout_box.bound_right_bottom.y);
        parent.pos = layout_box.pos;
    }

    /// Start new box that will be on the right by x axis
    pub fn begin_right_box(&mut self) {
        let parent = self.layout_boxes.last().unwrap();
        let layout_box = CxLayoutBox {
            align_list_x_start_index: self.layout_box_align_list.len(),
            align_list_y_start_index: self.layout_box_align_list.len(),
            origin: parent.pos,
            pos: parent.pos,
            layout: parent.layout,
            biggest: 0.0,
            bound_right_bottom: Vec2 { x: std::f32::NEG_INFINITY, y: std::f32::NEG_INFINITY },
            width: parent.width,
            height: parent.height,
            abs_size: parent.abs_size,
            box_type: CxBoxType::RightBox,
            available_width: parent.get_width_left(),
            available_height: parent.get_height_left(),
        };
        self.layout_boxes.push(layout_box);
    }

    pub fn end_right_box(&mut self) {
        self.assert_last_box_type_matches(CxBoxType::RightBox);

        let layout_box = self.layout_boxes.pop().unwrap();
        let parent = self.layout_boxes.last_mut().unwrap();

        let drawn_width = layout_box.bound_right_bottom.x - layout_box.origin.x;
        let last_x = parent.origin.x + parent.available_width;
        let dx = last_x - layout_box.bound_right_bottom.x;
        // update parent
        parent.available_width -= drawn_width;
        parent.pos = layout_box.origin;
        parent.bound_right_bottom.x = last_x;
        parent.bound_right_bottom.y = parent.bound_right_bottom.y.max(layout_box.bound_right_bottom.y);

        let align_start = layout_box.align_list_x_start_index;
        self.do_align_x(dx, align_start);
    }

    /// Starts a new box that adds padding to current box context
    pub fn begin_padding_box(&mut self, padding: Padding) {
        let parent = self.layout_boxes.last().expect("Using padding_box without parent is not supported");
        let direction = parent.layout.direction;
        self.begin_typed_box(
            CxBoxType::PaddingBox,
            Layout {
                direction,
                layout_size: LayoutSize { width: Width::Compute, height: Height::Compute },
                padding,
                ..Layout::default()
            },
        );
    }

    /// Ends the current box that was opened by [`Cx::begin_padding_box`]
    pub fn end_padding_box(&mut self) -> Rect {
        self.end_typed_box(CxBoxType::PaddingBox)
    }

    /// Starts new box that is absolutely positioned at (0, 0) coordinate
    pub fn begin_absolute_box(&mut self) {
        self.begin_typed_box(CxBoxType::AbsoluteBox, Layout { absolute: true, ..Layout::default() });
    }

    /// Ends the current box that was opened by [`Cx::begin_absolute_box`]
    pub fn end_absolute_box(&mut self) {
        self.end_typed_box(CxBoxType::AbsoluteBox);
    }

    /// Starts new box that is wrapping its content inside.
    /// This is defined in terms of child boxes (e.g. if any of the immediately nested boxes
    /// goes beyond the bounds, it would be wrapped to new line).
    /// This is only supported for horizontal direction.
    /// Note: text has its own wrapping mechanism via [`TextInsProps::wrapping`].
    pub fn begin_wrapping_box(&mut self) {
        let parent = self.layout_boxes.last().expect("Using wrapping_box without parent is not supported");
        let direction = parent.layout.direction;
        assert_eq!(direction, Direction::Right, "Wrapping is only supported for Direction::Right");
        self.begin_typed_box(
            CxBoxType::WrappingBox,
            Layout {
                direction,
                line_wrap: LineWrap::Overflow,
                layout_size: LayoutSize { width: Width::Compute, height: Height::Compute },
                ..Layout::default()
            },
        );
    }

    /// Ends the current box that was opened by [`Cx::begin_wrapping_box`]
    pub fn end_wrapping_box(&mut self) {
        self.end_typed_box(CxBoxType::WrappingBox);
    }

    /// Returns the full rect corresponding to current box.
    /// It uses all available_width/height plus padding.
    /// Note that these are the inherent dimensions of the [`CxLayoutBox`], not
    /// what the [`CxLayoutBox`] has walked so far. See [`Cx::get_box_bounds`] for that.
    pub fn get_box_rect(&self) -> Rect {
        if let Some(layout_box) = self.layout_boxes.last() {
            return Rect {
                pos: layout_box.origin,
                size: vec2(
                    layout_box.available_width + layout_box.layout.padding.r,
                    layout_box.available_height + layout_box.layout.padding.b,
                ),
            };
        };
        Rect::default()
    }

    /// Get some notion of the width that is "left" for the current [`CxLayoutBox`].
    ///
    /// See also [`Cx::get_width_total`].
    pub fn get_width_left(&self) -> f32 {
        if let Some(layout_box) = self.layout_boxes.last() {
            layout_box.get_width_left()
        } else {
            0.
        }
    }

    /// Get some notion of the total width of the current box. If the width
    /// is well defined, then we return it. If it's computed, then we return the
    /// bound (including padding) of how much we've drawn so far. And if we haven't
    /// drawn anything, we return 0.
    pub fn get_width_total(&self) -> f32 {
        if let Some(layout_box) = self.layout_boxes.last() {
            let nan_val = max_zero_keep_nan(layout_box.width);
            if nan_val.is_nan() {
                // if we are a computed width, if some value is known, use that
                if layout_box.bound_right_bottom.x != std::f32::NEG_INFINITY {
                    return layout_box.bound_right_bottom.x - layout_box.origin.x + layout_box.layout.padding.r;
                } else {
                    return 0.;
                }
            }
            return nan_val;
        }
        0.
    }

    /// Get some notion of the height that is "left" for the current [`CxLayoutBox`].
    ///
    /// See also [`Cx::get_height_total`].
    pub fn get_height_left(&self) -> f32 {
        if let Some(layout_box) = self.layout_boxes.last() {
            layout_box.get_height_left()
        } else {
            0.
        }
    }

    /// Get some notion of the total height of the current box. If the height
    /// is well defined, then we return it. If it's computed, then we return the
    /// bound (including padding) of how much we've drawn so far. And if we haven't
    /// drawn anything, we return 0.
    pub fn get_height_total(&self) -> f32 {
        if let Some(layout_box) = self.layout_boxes.last() {
            let nan_val = max_zero_keep_nan(layout_box.height);
            if nan_val.is_nan() {
                // if we are a computed height, if some value is known, use that
                if layout_box.bound_right_bottom.y != std::f32::NEG_INFINITY {
                    return layout_box.bound_right_bottom.y - layout_box.origin.y + layout_box.layout.padding.b;
                } else {
                    return 0.;
                }
            }
            return nan_val;
        }
        0.
    }

    /// Get the bounds of what the box has *actually* moved (not just its
    /// inherent width/height as given by [`Cx::get_box_rect`]), including any padding that the
    /// layout of the current box specifies.
    pub fn get_box_bounds(&self) -> Vec2 {
        if let Some(layout_box) = self.layout_boxes.last() {
            return Vec2 {
                x: if layout_box.bound_right_bottom.x < 0. { 0. } else { layout_box.bound_right_bottom.x }
                    + layout_box.layout.padding.r
                    - layout_box.origin.x,
                y: if layout_box.bound_right_bottom.y < 0. { 0. } else { layout_box.bound_right_bottom.y }
                    + layout_box.layout.padding.b
                    - layout_box.origin.y,
            };
        }
        Vec2::default()
    }

    /// Same as [`Cx::get_box_rect().pos`].
    ///
    /// TODO(JP): Do we really need two different methods to get to the same data?
    pub fn get_box_origin(&self) -> Vec2 {
        if let Some(layout_box) = self.layout_boxes.last() {
            return layout_box.origin;
        }
        Vec2::default()
    }

    /// Get the current [`CxLayoutBox::pos`] in absolute coordinates.
    ///
    /// TODO(JP): Only used in two places currently; do we really need this?
    pub fn get_draw_pos(&self) -> Vec2 {
        if let Some(layout_box) = self.layout_boxes.last() {
            layout_box.pos
        } else {
            Vec2::default()
        }
    }

    /// Adds Box to current [`CxLayoutBox`], returning a [`Rect`] of its size
    pub fn add_box(&mut self, layout_size: LayoutSize) -> Rect {
        self.move_box_with_old(layout_size, None)
    }

    /// Manually change [`CxLayoutBox::pos`]. Warning! Does not update [`CxLayoutBox::bound_right_bottom`],
    /// like [`Cx::add_box`] does; might result in unexpected behavior.
    ///
    /// TODO(JP): Should we delete this and just always use [`Cx::add_box`] instead?
    pub fn move_draw_pos(&mut self, dx: f32, dy: f32) {
        if let Some(layout_box) = self.layout_boxes.last_mut() {
            layout_box.pos.x += dx;
            layout_box.pos.y += dy;
        }
    }

    /// Manually change [`CxLayoutBox::pos`]. Warning! Does not update [`CxLayoutBox::bound_right_bottom`],
    /// like [`Cx::add_box`] does; might result in unexpected behavior.
    ///
    /// TODO(JP): Should we delete this and just always use [`Cx::add_box`] instead?
    pub fn set_draw_pos(&mut self, pos: Vec2) {
        if let Some(layout_box) = self.layout_boxes.last_mut() {
            layout_box.pos = pos
        }
    }

    /// Explicitly move the current [`CxLayoutBox`] to a new line.
    ///
    /// TODO(JP): Mostly relevant for [`Direction::Right`], should we just disable
    /// this for [`Direction::Down`] to avoid confusion?
    pub fn draw_new_line(&mut self) {
        if let Some(layout_box) = self.layout_boxes.last_mut() {
            assert_eq!(layout_box.layout.direction, Direction::Right, "draw_new_line with Direction::Down is not supported");
            layout_box.pos.x = layout_box.origin.x + layout_box.layout.padding.l;
            layout_box.pos.y += layout_box.biggest;
            layout_box.biggest = 0.0;
        }
    }

    /// [`Cx::draw_new_line`] but allows setting a minimum height for the line.
    ///
    /// TODO(JP): Should we instead include `min_height` in [`Layout`]?
    pub fn draw_new_line_min_height(&mut self, min_height: f32) {
        if let Some(layout_box) = self.layout_boxes.last_mut() {
            assert_eq!(
                layout_box.layout.direction,
                Direction::Right,
                "draw_new_line_min_height with Direction::Down is not supported"
            );
            layout_box.pos.x = layout_box.origin.x + layout_box.layout.padding.l;
            layout_box.pos.y += layout_box.biggest.max(min_height);
            layout_box.biggest = 0.0;
        }
    }
}