makara 0.2.6

A Bevy UI simplifier that make it easy to build GUI app with bevy engine.
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
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
//! `checkbox` widget.

use bevy::{prelude::*, ui::InteractionDisabled, ui_widgets::observe};
use bevy::window::{CursorIcon, SystemCursorIcon};

use crate::utils::update_focus_state_for_widgets_on_click;
use crate::{consts::*, events::*, utils::*, on_mouse_out};
use super::*;

/// Marker component for `checkbox`.
#[derive(Component)]
pub struct MakaraCheckbox;

/// Component used to store state of a `checkbox`.
#[derive(Component)]
pub struct MakaraCheckboxState(pub bool);

/// Marker component for `checkbox` button.
#[derive(Component)]
pub struct MakaraCheckboxButton;

#[derive(Component)]
pub struct MakaraCheckboxText;

#[derive(Component)]
pub struct CheckboxButtonActiveColor(pub Color);

/// A struct used to mutate components attached to `checkbox` widget.
pub struct CheckboxWidget<'a, 'w, 's> {
    pub entity: Entity,
    pub class: &'a mut Class,
    pub style: WidgetStyle<'a>,
    pub button_style: WidgetStyle<'a>,
    pub button_active_color: &'a mut CheckboxButtonActiveColor,
    pub text: ChildText<'a>,
    pub commands: &'a mut Commands<'w, 's>
}

impl<'a, 'w, 's> SetText for CheckboxWidget<'a, 'w, 's> {
    fn set_text(&mut self, text: &str) {
        self.text.value.0 = text.to_string();
    }
}

impl<'a, 'w, 's> CheckboxWidget<'a, 'w, 's> {
    /// Set state of a `checkbox` to active.
    pub fn set_active(&mut self) {
        self.commands.trigger(SetCheckboxState {
            entity: self.entity,
            state: true
        });
    }

    /// Set state of a `checkbox` to inactive.
    pub fn set_inactive(&mut self) {
        self.commands.trigger(SetCheckboxState {
            entity: self.entity,
            state: false
        });
    }
}

type IsCheckboxOnly = (
    (
        With<MakaraCheckbox>,
        Without<MakaraCheckboxButton>,
        Without<MakaraButton>,
        Without<MakaraColumn>,
        Without<MakaraRow>,
        Without<MakaraRoot>,
        Without<MakaraCircular>,
        Without<MakaraDropdown>,
        Without<MakaraDropdownOverlay>,
        Without<MakaraImage>,
        Without<MakaraLink>,
        Without<MakaraModal>,
        Without<MakaraModalBackdrop>,
    ),
    (
        Without<MakaraProgressBar>,
        Without<MakaraRadio>,
        Without<MakaraRadioGroup>,
        Without<MakaraScroll>,
        Without<MakaraScrollbar>,
        Without<MakaraTextInput>,
        Without<MakaraTextInputCursor>,
        Without<MakaraSlider>,
        Without<MakaraSliderThumb>,
        Without<MakaraSelect>,
        Without<MakaraSelectOverlay>,
    )
);

type IsCheckboxButtonOnly = (
    (
        With<MakaraCheckboxButton>,
        Without<MakaraCheckbox>,
        Without<MakaraButton>,
        Without<MakaraColumn>,
        Without<MakaraRow>,
        Without<MakaraRoot>,
        Without<MakaraCircular>,
        Without<MakaraDropdown>,
        Without<MakaraDropdownOverlay>,
        Without<MakaraImage>,
        Without<MakaraLink>,
        Without<MakaraModal>,
        Without<MakaraModalBackdrop>,
    ),
    (
        Without<MakaraProgressBar>,
        Without<MakaraRadio>,
        Without<MakaraRadioGroup>,
        Without<MakaraScroll>,
        Without<MakaraScrollbar>,
        Without<MakaraTextInput>,
        Without<MakaraTextInputCursor>,
        Without<MakaraSlider>,
        Without<MakaraSliderThumb>,
        Without<MakaraSelect>,
        Without<MakaraSelectOverlay>,
    )
);

type IsCheckboxTextOnly = (
    With<MakaraCheckboxText>,
    Without<MakaraButtonText>
);

/// `checkbox` system param.
#[derive(SystemParam)]
pub struct CheckboxQuery<'w, 's> {
    pub id: Query<'w, 's, (Entity, &'static Id), With<MakaraCheckbox>>,
    pub class: Query<'w, 's, (Entity, &'static mut Class), IsCheckboxOnly>,
    pub style: StyleQuery<'w, 's, IsCheckboxOnly>,
    pub button_style: StyleQuery<'w, 's, IsCheckboxButtonOnly>,
    pub button_active_color: Query<'w, 's, &'static mut CheckboxButtonActiveColor>,
    pub text: TextQueryAsChild<'w, 's, IsCheckboxTextOnly>,
    pub children: Query<'w, 's, &'static Children>,
    pub commands: Commands<'w, 's>
}

impl<'w, 's> WidgetQuery<'w, 's> for CheckboxQuery<'w, 's> {
     type WidgetView<'a> = CheckboxWidget<'a, 'w, 's> where Self: 'a;

    fn get_components<'a>(&'a mut self, entity: Entity) -> Option<Self::WidgetView<'a>> {
        let CheckboxQuery {
            id: _, class, style, button_style, button_active_color, text, children, commands
        } = self;

        let mut text_entity = None;
        let mut btn_entity = None;

        let children_list = children.get(entity).ok()?;

        for child in children_list {
            if text_entity.is_none() && text.query.get(*child).is_ok() {
                text_entity = Some(*child);
            }

            if btn_entity.is_none() && button_style.query.get(*child).is_ok() {
                btn_entity = Some(*child);
            }
        }

        // 2. BORROW PHASE: Now that the loop is over, we borrow specifically what we need.
        if let (Some(t_ent), Some(b_ent)) = (text_entity, btn_entity) {
            // Fetch the parent styles
            let style_bundle = style.query.get_mut(entity).ok()?;
            let (node, bg, border, shadow, z) = style_bundle;

            // Fetch the children components mutably (only happens once!)
            let t_components = text.query.get_mut(t_ent).ok()?;
            let b_style_components = button_style.query.get_mut(b_ent).ok()?;
            let active_color = button_active_color.get_mut(b_ent).ok()?;

            return Some(CheckboxWidget {
                entity,
                class: class.get_mut(entity).ok()?.1.into_inner(),
                style: WidgetStyle {
                    node: node.into_inner(),
                    background_color: bg.into_inner(),
                    border_color: border.into_inner(),
                    shadow: shadow.into_inner(),
                    z_index: z.into_inner(),
                },
                button_style: WidgetStyle {
                    node: b_style_components.0.into_inner(),
                    background_color: b_style_components.1.into_inner(),
                    border_color: b_style_components.2.into_inner(),
                    shadow: b_style_components.3.into_inner(),
                    z_index: b_style_components.4.into_inner(),
                },
                button_active_color: active_color.into_inner(),
                text: ChildText {
                    value: t_components.0.into_inner(),
                    font: t_components.1.into_inner(),
                    layout: t_components.2.into_inner(),
                    color: t_components.3.into_inner(),
                },
                commands: commands
            });
        }

        None
    }

    fn find_by_id<'a>(&'a mut self, target_id: &str) -> Option<Self::WidgetView<'a>> {
        let entity = self.id.iter()
            .find(|(_, id)| id.0 == target_id)
            .map(|(e, _)| e)?;

        self.get_components(entity)
    }

    fn find_by_entity<'a>(&'a mut self, target_entity: Entity) -> Option<Self::WidgetView<'a>> {
        self.get_components(target_entity)
    }

    fn find_by_class(&self, target_class: &str) -> Vec<Entity> {
        self.class.iter()
            .filter(|(_, class)| class.0.split(" ").any(|word| word == target_class))
            .map(|(e, _)| e)
            .collect()
    }
}

/// Bundle for creating `checkbox`.
#[derive(Bundle)]
pub struct CheckboxBundle {
    pub id_class: IdAndClass,
    pub style: ContainerStyle,
    pub button_style: ContainerStyle,
    pub button_active_color: CheckboxButtonActiveColor,
    pub text_bundle: TextBundle,
    pub state: MakaraCheckboxState,
    pub tooltip_bundle: TooltipBundle
}

impl Default for CheckboxBundle {
    fn default() -> Self {
        let style = ContainerStyle {
            node: Node {
                width: auto(),
                height: auto(),
                display: Display::Flex,
                flex_direction: FlexDirection::Row,
                align_items: AlignItems::Start,
                justify_content: JustifyContent::Center,
                align_content: AlignContent::Center,
                ..default()
            },
            shadow: BoxShadow::default(),
            ..default()
        };

        let button_style = ContainerStyle {
            node: Node {
                width: px(15),
                height: px(15),
                border: UiRect::all(px(2)),
                display: Display::Flex,
                margin: UiRect::top(px(1.5)),
                border_radius: BorderRadius::all(px(2.5)),
                ..default()
            },
            border_color: BorderColor::all(LIGHT_THEME_TEXT_COLOR),
            background_color: BackgroundColor(CHECKBOX_UNCHECKED_COLOR),
            shadow: BoxShadow::default(),
            ..default()
        };

        let text_bundle = TextBundle {
            id_class: IdAndClass::default(),
            text: Text::new(""),
            text_style: TextStyle {
                color: TextColor(LIGHT_THEME_TEXT_COLOR),
                font: TextFont::from_font_size(DEFAULT_TEXT_FONT_SIZE),
                ..default()
            },
            style: ContainerStyle {
                node: Node {
                    margin: UiRect {
                        top: px(2),
                        left: px(2.5),
                        ..default()
                    },
                    ..default()
                },
                shadow: BoxShadow::default(),
                ..default()
            }
        };

        let state = MakaraCheckboxState(false);
        let tooltip_bundle = TooltipBundle::default();
        let id_class = IdAndClass::default();
        let button_active_color = CheckboxButtonActiveColor(CHECKBOX_CHECKED_COLOR);

        Self { style, button_style, text_bundle, state, tooltip_bundle, id_class, button_active_color }
    }
}

impl CheckboxBundle {
    /// Replace text style with provided style.
    pub fn text_style(mut self, style: TextStyle) -> Self {
        self.text_bundle.text_style = style;
        self
    }

    /// Set checkbox as active.
    pub fn active(mut self) -> Self {
        self.state.0 = true;
        self
    }

    /// Set color for button when active
    pub fn button_active_color(mut self, color: Color) -> Self {
        self.button_active_color.0 = color;
        self
    }

    /// Build `checkbox` as disabled.
    pub fn build_as_disabled(self) -> impl Bundle {
        (self.build(), InteractionDisabled)
    }
}

impl Widget for CheckboxBundle {
    /// Build `checkbox`.
    fn build(mut self) -> impl Bundle {
        process_built_in_spacing_class(&self.id_class.class, &mut self.style.node);
        process_built_in_color(
            &self.id_class.class,
            &mut self.button_active_color.0
        );

        (
            self.id_class,
            self.style,
            self.state,
            MakaraCheckbox,
            MakaraWidget,
            WidgetFocus(false),
            children![
                (
                    self.button_style,
                    self.button_active_color,
                    MakaraCheckboxButton
                ),
                (self.text_bundle, MakaraText, MakaraCheckboxText),
                self.tooltip_bundle.build()
            ],
            observe(on_checkbox_mouse_over),
            observe(on_checkbox_state_set),
            observe(on_mouse_out),
            observe(on_checkbox_click)
        )
    }
}

impl SetContainerStyle for CheckboxBundle {
    fn container_style(&mut self) -> &mut ContainerStyle {
        &mut self.style
    }
}

impl SetToolTip for CheckboxBundle {
    fn set_tooltip(&mut self) -> &mut TooltipBundle {
        &mut self.tooltip_bundle
    }
}

impl SetIdAndClass for CheckboxBundle {
    fn id_and_class(&mut self) -> &mut IdAndClass {
        &mut self.id_class
    }
}

pub fn checkbox(text: &str) -> CheckboxBundle {
    let mut bundle = CheckboxBundle::default();
    bundle.text_bundle.text.0 = text.to_string();
    bundle
}

pub(crate) fn detect_checkbox_class_change_for_built_in_color(
    mut checkboxs: Query<
        (&Class, &mut Node, &mut MakaraCheckboxState, &Children),
        (IsCheckboxOnly, Changed<Class>)
    >,
    mut checkbox_btns: Query<&mut CheckboxButtonActiveColor, IsCheckboxButtonOnly>,
) {
    for (class, mut node, mut state, children) in checkboxs.iter_mut() {
        for child in children.iter() {
            if let Ok(mut active_color) = checkbox_btns.get_mut(child) {
                process_built_in_color(class, &mut active_color.0);
                process_built_in_spacing_class(class, &mut node);
                state.set_changed();
                break;
            }
        }
    }
}

fn on_checkbox_mouse_over(
    mut over: On<Pointer<Over>>,
    mut checkboxs: Query<
        (Has<InteractionDisabled>, &Children, &UiTransform, &ComputedNode),
        With<MakaraCheckbox>
    >,
    mut tooltips: Query<
        (&mut Node, &ComputedNode, &TooltipPosition, &UseTooltip),
        With<MakaraTooltip>
    >,
    mut commands: Commands,
    window: Single<Entity, With<Window>>,
) {

    if let Ok((is_disabled, children, transform, computed)) = checkboxs.get_mut(over.entity) {
        let cursor_icon = if is_disabled {
            CursorIcon::System(SystemCursorIcon::Default)
        } else {
            CursorIcon::System(SystemCursorIcon::Pointer)
        };

        commands.entity(*window).insert(cursor_icon);
        show_or_hide_tooltip(true, &mut tooltips, Some(computed), Some(transform), children);
    }

    commands.trigger(MouseOver { entity: over.entity });
    over.propagate(false);
}

fn on_checkbox_click(
    mut click: On<Pointer<Click>>,
    mut commands: Commands,
    mut checkboxs: Query<(&mut MakaraCheckboxState, &Children), With<MakaraCheckbox>>,
    mut widgets: Query<(Entity, &mut WidgetFocus)>,
    text_q: Query<&Text, With<MakaraText>>
) {
    update_focus_state_for_widgets_on_click(click.entity, &mut widgets);

    if let Ok((mut state, children)) = checkboxs.get_mut(click.entity) {
        state.0 = !state.0;

        for child in children {
            if let Ok(text) = text_q.get(*child) {
               match state.0 {
                    true => commands.trigger(Active {
                        entity: click.entity,
                        data: text.0.clone()
                    }),
                    false => commands.trigger(Inactive {
                        entity: click.entity,
                        data: text.0.clone()
                    })
                }
            }
        }

        commands.trigger(Clicked { entity: click.entity });
        click.propagate(false);
    }
}

fn on_checkbox_state_set(
    set_state: On<SetCheckboxState>,
    mut commands: Commands,
    mut checkboxs: Query<(&mut MakaraCheckboxState, &Children), With<MakaraCheckbox>>,
    text_q: Query<&Text, With<MakaraText>>
) {
    if let Ok((mut state, children)) = checkboxs.get_mut(set_state.entity) {
        state.0 = set_state.state;

        for child in children {
            if let Ok(text) = text_q.get(*child) {
               match state.0 {
                    true => commands.trigger(Active {
                        entity: set_state.entity,
                        data: text.0.clone()
                    }),
                    false => commands.trigger(Inactive {
                        entity: set_state.entity,
                        data: text.0.clone()
                    })
                }
            }
        }
    }
}

pub(crate) fn update_checkbox_style_on_state_change_system(
    checkboxs: Query<
        (&MakaraCheckboxState, &Children),
        (With<MakaraCheckbox>, Or<(Changed<MakaraCheckboxState>, Added<MakaraCheckboxState>)>)
    >,
    mut checkbox_btns: Query<
        (&mut BackgroundColor, &CheckboxButtonActiveColor),
        With<MakaraCheckboxButton>
    >,
) {
    for (state, children) in checkboxs.iter() {
        for child in children {
            if let Ok((mut bg_color, active_color)) = checkbox_btns.get_mut(*child) {
                match state.0 {
                    true => bg_color.0 = active_color.0.clone(),
                    false => bg_color.0 = CHECKBOX_UNCHECKED_COLOR
                }
            }
        }
    }
}

pub(crate) fn update_checkbox_button_style_on_theme_change_system(
    makara_theme: Res<MakaraTheme>,
    mut checkbox_btn_q: Query<&mut BorderColor, With<MakaraCheckboxButton>>,
) {
    if !makara_theme.is_changed() {
        return;
    }

    // use color same as text
    let new_bd_color = match makara_theme.theme {
        Theme::Light => LIGHT_THEME_TEXT_COLOR,
        Theme::Dark => DARK_THEME_TEXT_COLOR
    };

    let default_light = BorderColor::all(LIGHT_THEME_TEXT_COLOR);
    let default_dark = BorderColor::all(DARK_THEME_TEXT_COLOR);

    for mut bd_color in checkbox_btn_q.iter_mut() {
        // only react to theme change if color is default
        if *bd_color == default_light || *bd_color == default_dark {
            *bd_color = BorderColor::all(new_bd_color);
        }
    }
}

pub(crate) fn detect_checkbox_built(
    mut commands: Commands,
    checkboxs: Query<Entity, Added<MakaraCheckbox>>
) {
    for entity in checkboxs.iter() {
        commands.trigger(WidgetBuilt {
            entity
        });
    }
}

pub(crate) fn can_run_checkbox_systems(q: Query<&MakaraCheckbox>) -> bool {
    q.count() > 0
}