bevy_cobweb_ui 0.22.2

UI framework for the bevy game engine
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

use std::fmt::Debug;

use bevy::prelude::*;
use dyn_clone::DynClone;

use crate::prelude::*;
use crate::sickle::*;

//-------------------------------------------------------------------------------------------------------------------

/// Trait for loadable types that specify a static value tied to pseudo states.
///
/// See [`Static`].
pub trait StaticAttribute: Instruction
{
    /// Specifies the value-type of the attribute.
    type Value: Loadable + Clone + DynClone + Debug;

    /// Converts [`Self::Value`] into `Self`.
    fn construct(value: Self::Value) -> Self;

    /// Updates an entity with a value.
    #[inline(always)]
    fn update(entity: Entity, world: &mut World, new_value: Self::Value)
    {
        Self::construct(new_value).apply(entity, world);
        world.flush();
    }
}

//-------------------------------------------------------------------------------------------------------------------

/// Trait for loadable types that respond to interactions.
///
/// Use [`Interactive`] to make an entity interactable.
///
/// See [`Responsive`].
pub trait ResponsiveAttribute: StaticAttribute
{
    /// Extracts a value from an interaction state.
    ///
    /// The `reference_vals` are set in [`Responsive`].
    ///
    /// The value will be applied with [`StaticAttribute::update`].
    #[inline(always)]
    fn extract(
        _: Entity,
        _: &mut World,
        reference_vals: &ResponsiveVals<Self::Value>,
        state: FluxInteraction,
    ) -> Self::Value
    {
        reference_vals.to_value(state)
    }
}

//-------------------------------------------------------------------------------------------------------------------

/// Trait for loadable types that can be animated in response to interactions.
///
/// Use [`Interactive`] to make an entity interactable.
///
/// See [`Animated`].
pub trait AnimatedAttribute: StaticAttribute<Value: Lerp>
{
    /// Tries to get the current value of the attribute on the entity.
    ///
    /// Used to set the `AnimatedVals::enter_ref` field when entering a new state if the attribute includes an
    /// on-enter animation. Note there is [`Animated::enter_ref_override`] if you want to manually specify an
    /// enter value.
    fn get_value(entity: Entity, world: &World) -> Option<Self::Value>;

    /// Extracts a value that should be applied to the entity.
    ///
    /// The `reference_vals` are set in [`Animated`].
    ///
    /// The value will be applied with [`StaticAttribute::update`].
    #[inline(always)]
    fn extract(
        _: Entity,
        _: &mut World,
        reference_vals: &AnimatedVals<Self::Value>,
        state: &AnimationState,
    ) -> Self::Value
    {
        reference_vals.to_value(state)
    }
}

//-------------------------------------------------------------------------------------------------------------------