aura-anim-iced 0.2.0

Iced-first animation primitives.
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

use crate::property::PropertySnapshot;

#[cfg(test)]
use crate::{prelude::RawPropertySpec, property::PropertyEntry};

/// A property snapshot stored at a normalized keyframe offset.
#[derive(Debug, Clone, PartialEq)]
pub struct Keyframe {
    offset: f32,
    snapshot: PropertySnapshot,
}

impl Keyframe {
    /// Creates a keyframe with a normalized offset and composition-sorted snapshot.
    #[must_use]
    pub fn new(offset: f32, mut snapshot: PropertySnapshot) -> Self {
        snapshot.sort_by_composition_key();

        Self {
            offset: normalize_offset(offset),
            snapshot,
        }
    }

    /// Returns the normalized offset of this keyframe.
    #[must_use]
    pub const fn offset(&self) -> f32 {
        self.offset
    }

    /// Returns a reference to the property snapshot at this keyframe.
    #[must_use]
    pub const fn snapshot(&self) -> &PropertySnapshot {
        &self.snapshot
    }

    pub(crate) fn merge_snapshot(&mut self, snapshot: PropertySnapshot) {
        self.snapshot.merge(snapshot);
    }

    #[cfg(test)]
    pub(crate) fn find_property(&self, property: &RawPropertySpec) -> Option<&PropertyEntry> {
        self.snapshot.find_property(property)
    }
}

/// Normalizes a keyframe offset to the inclusive range `[0.0, 1.0]`.
#[must_use]
pub fn normalize_offset(offset: f32) -> f32 {
    if offset.is_finite() {
        offset.clamp(0.0, 1.0)
    } else {
        0.0
    }
}