bevy_vello 0.13.1

Render assets and scenes in Bevy with Vello
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

mod asset_loader;
mod systems;

pub(crate) mod render;

pub mod asset;
pub use asset::VelloLottie;

mod parse;
pub use parse::{load_lottie_from_bytes, load_lottie_from_str};

mod lottie_ext;
pub use lottie_ext::LottieExt;

mod plugin;
pub(crate) use plugin::LottieIntegrationPlugin;

mod theme;
pub use theme::Theme;

mod player;
pub use player::{
    LottiePlayer, PlaybackDirection, PlaybackLoopBehavior, PlaybackOptions, PlaybackPlayMode,
    PlayerState, PlayerTransition, Playhead,
};

use bevy::{
    camera::{primitives::Aabb, visibility::VisibilityClass},
    ecs::component::Mutable,
    prelude::*,
};

pub trait LottieAssetVariant: Component<Mutability = Mutable> + Clone {
    fn asset_id(&self) -> AssetId<VelloLottie>;
}

/// A renderable Lottie in the world.
#[derive(Component, Default, Debug, Clone, Deref, DerefMut, PartialEq, Eq, Reflect)]
#[require(
    Aabb,
    VelloLottieAnchor,
    Playhead,
    PlaybackOptions,
    LottiePlayer::<VelloLottie2d>,
    Transform,
    Visibility,
    VisibilityClass
)]
#[cfg_attr(feature = "picking", require(Pickable))]
#[reflect(Component)]
#[component(on_add = super::lottie::player::hooks::on_add_lottie::<VelloLottie2d>)]
pub struct VelloLottie2d(pub Handle<VelloLottie>);

impl LottieAssetVariant for VelloLottie2d {
    fn asset_id(&self) -> AssetId<VelloLottie> {
        self.id()
    }
}

/// A renderable Lottie that may be used in Bevy UI.
///
/// ### Object fit
/// The image will preserve the aspect ratio, and fits the image inside the container, without cutting - will leave empty space if needed.
#[derive(Component, Default, Debug, Clone, Deref, DerefMut, PartialEq, Eq, Reflect)]
#[require(
    Node,
    VelloLottieAnchor,
    Playhead,
    PlaybackOptions,
    LottiePlayer::<UiVelloLottie>,
    UiTransform,
    Visibility,
    VisibilityClass
)]
#[reflect(Component)]
#[component(on_add = super::lottie::player::hooks::on_add_lottie::<UiVelloLottie>)]
pub struct UiVelloLottie(pub Handle<VelloLottie>);

impl LottieAssetVariant for UiVelloLottie {
    fn asset_id(&self) -> AssetId<VelloLottie> {
        self.id()
    }
}

/// Describes how the asset is positioned relative to its [`Transform`]. It defaults to
/// [`VelloLottieAnchor::Center`].
///
/// Has no effect in UI nodes.
#[derive(Component, Default, Debug, Clone, Copy, PartialEq, Eq, Reflect)]
#[reflect(Component)]
pub enum VelloLottieAnchor {
    /// Bounds start from the render position and advance up and to the right.
    BottomLeft,
    /// Bounds start from the render position and advance up.
    Bottom,
    /// Bounds start from the render position and advance up and to the left.
    BottomRight,

    /// Bounds start from the render position and advance right.
    Left,
    /// Bounds start from the render position and advance equally on both axes.
    #[default]
    Center,
    /// Bounds start from the render position and advance left.
    Right,

    /// Bounds start from the render position and advance down and to the right.
    TopLeft,
    /// Bounds start from the render position and advance down.
    Top,
    /// Bounds start from the render position and advance down and to the left.
    TopRight,
}