bevy_elements 0.1.0

Living environments for Bevy: sun, moon and stars, climate-driven weather, GPU wind, volumetric clouds, rain, snow and fog, lightning, terrain with hydraulic and thermal erosion, flooding, snow cover, wetness and dust — simulated in compute shaders.
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

//! Feed `bevy_flora` from this crate's wind, seasons and weathering (feature `flora`).
//!
//! `bevy_flora` owns tree visuals and their global wind, season and wetness resources; this
//! module only writes those resources from [`WindState`], [`WindGust`], [`SeasonState`],
//! [`Weather`] and [`SurfaceWeathering`]. Flora's shaders read one global wind, so the spatial
//! wind field is not passed on.

use bevy::prelude::*;
use bevy_flora::{FloraSeason, FloraWetness, FloraWind, GustFront};

use crate::climate::{SeasonState, SurfaceWeathering, Weather};
use crate::plugin::{ElementsSystems, ensure_core};
use crate::wind::{WindGust, WindState};

/// Wind speed at 10 m, m/s, that `bevy_flora`'s `FloraWind::strength` of 1 ("a strong wind")
/// stands for. Gust strengths are converted on the same scale.
pub const FLORA_FULL_WIND_MS: f32 = 20.0;

/// Drives `bevy_flora`'s `FloraWind`, `FloraSeason` and `FloraWetness` from this crate.
///
/// Not part of [`ElementsPlugins`](crate::ElementsPlugins): add it next to `bevy_flora`'s
/// `FloraPlugin`. It runs in `Update` after [`ElementsSystems::Readback`] and leaves every
/// `FloraWind` field it does not map (speed, flutter, bend, frequencies) as the game set it.
///
/// | `bevy_flora` | from |
/// |---|---|
/// | `FloraWind::direction` | `WindState::prevailing` |
/// | `FloraWind::strength` | `WindState::speed_10m / 20`, clamped to 0–1 |
/// | `FloraWind::turbulence` | `Weather::gustiness` |
/// | `FloraWind::gust_strength` | `(WindState::gust_factor − 1) / 0.5` (= gustiness), 0–1 |
/// | `FloraWind::launch_gust` | each [`WindGust`], strength / 20 |
/// | `FloraSeason` | `SeasonState::{autumn, leaf_fall, blossom}`, `snow` = `SurfaceWeathering::snow_cover` |
/// | `FloraWetness` | `SurfaceWeathering::wetness` |
pub struct ElementsFloraPlugin;

impl Plugin for ElementsFloraPlugin {
    fn build(&self, app: &mut App) {
        ensure_core(app);
        app.add_systems(
            Update,
            (drive_wind, drive_season).after(ElementsSystems::Readback),
        );
    }
}

fn drive_wind(
    wind: Res<WindState>,
    weather: Res<Weather>,
    time: Res<Time>,
    mut gusts: MessageReader<WindGust>,
    flora: Option<ResMut<FloraWind>>,
) {
    let Some(mut flora) = flora else {
        gusts.clear();
        return;
    };
    let mut next = *flora;
    next.direction = wind.prevailing;
    next.strength = (wind.speed_10m / FLORA_FULL_WIND_MS).clamp(0.0, 1.0);
    next.turbulence = weather.gustiness;
    next.gust_strength = ((wind.gust_factor - 1.0) / 0.5).clamp(0.0, 1.0);
    for gust in gusts.read() {
        next.launch_gust(
            GustFront {
                origin: gust.origin,
                direction: gust.direction,
                speed: gust.speed,
                width: gust.width,
                strength: gust.strength / FLORA_FULL_WIND_MS,
                start: 0.0,
            },
            &time,
        );
    }
    flora.set_if_neq(next);
}

fn drive_season(
    season: Option<Res<SeasonState>>,
    ground: Option<Res<SurfaceWeathering>>,
    flora_season: Option<ResMut<FloraSeason>>,
    wetness: Option<ResMut<FloraWetness>>,
) {
    let snow = ground.as_ref().map_or(0.0, |g| g.snow_cover);
    if let (Some(season), Some(mut flora_season)) = (season, flora_season) {
        flora_season.set_if_neq(FloraSeason {
            autumn: season.autumn,
            leaf_fall: season.leaf_fall,
            snow,
            blossom: season.blossom,
        });
    }
    if let (Some(ground), Some(mut wetness)) = (ground, wetness) {
        wetness.set_if_neq(FloraWetness(ground.wetness));
    }
}