Merge pull request #2757 from iced-rs/feature/animation-api

`Animation` API for application code

3 files changed, 141 insertions, 0 deletions

diff --git a/core/Cargo.toml b/core/Cargo.toml
index a3bc6745..1ca7260c 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -21,6 +21,7 @@ advanced = []
 bitflags.workspace = true
 bytes.workspace = true
 glam.workspace = true
+lilt.workspace = true
 log.workspace = true
 num-traits.workspace = true
 palette.workspace = true
diff --git a/core/src/animation.rs b/core/src/animation.rs
new file mode 100644
index 00000000..258fd084
--- /dev/null
+++ b/core/src/animation.rs
@@ -0,0 +1,136 @@
+//! Animate your applications.
+use crate::time::{Duration, Instant};
+
+pub use lilt::{Easing, FloatRepresentable as Float, Interpolable};
+
+/// The animation of some particular state.
+///
+/// It tracks state changes and allows projecting interpolated values
+/// through time.
+#[derive(Debug, Clone)]
+pub struct Animation<T>
+where
+    T: Clone + Copy + PartialEq + Float,
+{
+    raw: lilt::Animated<T, Instant>,
+}
+
+impl<T> Animation<T>
+where
+    T: Clone + Copy + PartialEq + Float,
+{
+    /// Creates a new [`Animation`] with the given initial state.
+    pub fn new(state: T) -> Self {
+        Self {
+            raw: lilt::Animated::new(state),
+        }
+    }
+
+    /// Sets the [`Easing`] function of the [`Animation`].
+    ///
+    /// See the [Easing Functions Cheat Sheet](https://easings.net) for
+    /// details!
+    pub fn easing(mut self, easing: Easing) -> Self {
+        self.raw = self.raw.easing(easing);
+        self
+    }
+
+    /// Sets the duration of the [`Animation`] to 100ms.
+    pub fn very_quick(self) -> Self {
+        self.duration(Duration::from_millis(100))
+    }
+
+    /// Sets the duration of the [`Animation`] to 200ms.
+    pub fn quick(self) -> Self {
+        self.duration(Duration::from_millis(200))
+    }
+
+    /// Sets the duration of the [`Animation`] to 400ms.
+    pub fn slow(self) -> Self {
+        self.duration(Duration::from_millis(400))
+    }
+
+    /// Sets the duration of the [`Animation`] to 500ms.
+    pub fn very_slow(self) -> Self {
+        self.duration(Duration::from_millis(500))
+    }
+
+    /// Sets the duration of the [`Animation`] to the given value.
+    pub fn duration(mut self, duration: Duration) -> Self {
+        self.raw = self.raw.duration(duration.as_secs_f32() * 1_000.0);
+        self
+    }
+
+    /// Sets a delay for the [`Animation`].
+    pub fn delay(mut self, duration: Duration) -> Self {
+        self.raw = self.raw.delay(duration.as_secs_f64() as f32 * 1000.0);
+        self
+    }
+
+    /// Makes the [`Animation`] repeat a given amount of times.
+    ///
+    /// Providing 1 repetition plays the animation twice in total.
+    pub fn repeat(mut self, repetitions: u32) -> Self {
+        self.raw = self.raw.repeat(repetitions);
+        self
+    }
+
+    /// Makes the [`Animation`] repeat forever.
+    pub fn repeat_forever(mut self) -> Self {
+        self.raw = self.raw.repeat_forever();
+        self
+    }
+
+    /// Makes the [`Animation`] automatically reverse when repeating.
+    pub fn auto_reverse(mut self) -> Self {
+        self.raw = self.raw.auto_reverse();
+        self
+    }
+
+    /// Transitions the [`Animation`] from its current state to the given new state.
+    pub fn go(mut self, new_state: T) -> Self {
+        self.go_mut(new_state);
+        self
+    }
+
+    /// Transitions the [`Animation`] from its current state to the given new state, by reference.
+    pub fn go_mut(&mut self, new_state: T) {
+        self.raw.transition(new_state, Instant::now());
+    }
+
+    /// Returns true if the [`Animation`] is currently in progress.
+    ///
+    /// An [`Animation`] is in progress when it is transitioning to a different state.
+    pub fn is_animating(&self, at: Instant) -> bool {
+        self.raw.in_progress(at)
+    }
+
+    /// Projects the [`Animation`] into an interpolated value at the given [`Instant`]; using the
+    /// closure provided to calculate the different keyframes of interpolated values.
+    ///
+    /// If the [`Animation`] state is a `bool`, you can use the simpler [`interpolate`] method.
+    ///
+    /// [`interpolate`]: Animation::interpolate
+    pub fn interpolate_with<I>(&self, f: impl Fn(T) -> I, at: Instant) -> I
+    where
+        I: Interpolable,
+    {
+        self.raw.animate(f, at)
+    }
+
+    /// Retuns the current state of the [`Animation`].
+    pub fn value(&self) -> T {
+        self.raw.value
+    }
+}
+
+impl Animation<bool> {
+    /// Projects the [`Animation`] into an interpolated value at the given [`Instant`]; using the
+    /// `start` and `end` values as the origin and destination keyframes.
+    pub fn interpolate<I>(&self, start: I, end: I, at: Instant) -> I
+    where
+        I: Interpolable + Clone,
+    {
+        self.raw.animate_bool(start, end, at)
+    }
+}
diff --git a/core/src/lib.rs b/core/src/lib.rs
index 645f7a90..3a61a5ee 100644
--- a/core/src/lib.rs
+++ b/core/src/lib.rs
@@ -10,6 +10,8 @@
     html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
 )]
 pub mod alignment;
+#[cfg(not(target_arch = "wasm32"))]
+pub mod animation;
 pub mod border;
 pub mod clipboard;
 pub mod event;
@@ -49,6 +51,8 @@ mod vector;
 
 pub use alignment::Alignment;
 pub use angle::{Degrees, Radians};
+#[cfg(not(target_arch = "wasm32"))]
+pub use animation::Animation;
 pub use background::Background;
 pub use border::Border;
 pub use clipboard::Clipboard;