avian_fdm 0.1.0

6-DoF Flight Dynamics Model for Bevy + Avian 0.6
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

//! [`RegisterAirfoil`] extension trait and the `resolve_airfoil_names` system.

use crate::_bevy::*;
use crate::components::aero_coeff::AeroCoeff;

use super::library::AirfoilLibrary;
use super::types::AirfoilData;

/// Extension trait for [`App`] — register a named airfoil into [`AirfoilLibrary`].
///
/// # Example
///
/// ```rust,no_run
/// # use avian_fdm::prelude::*;
/// # use avian_fdm::airfoil::{AirfoilData, RegisterAirfoil};
/// # use avian_fdm::components::aero_coeff::AeroCoeff;
/// # use bevy::prelude::*;
/// App::new()
///     .add_plugins(AircraftFdmPlugin::default())
///     .register_airfoil("MyFoil", AirfoilData {
///         cl: AeroCoeff::Scalar(5.0),
///         cd: AeroCoeff::Scalar(0.02),
///         cm: AeroCoeff::Absent,
///     });
/// ```
pub trait RegisterAirfoil {
    /// Register `data` under `name` in the [`AirfoilLibrary`] resource.
    ///
    /// Call after [`AircraftFdmPlugin`](crate::plugin::AircraftFdmPlugin) has been added
    /// (the plugin initialises the resource). Overwrites any existing entry.
    fn register_airfoil(&mut self, name: impl Into<String>, data: AirfoilData) -> &mut Self;
}

impl RegisterAirfoil for App {
    fn register_airfoil(&mut self, name: impl Into<String>, data: AirfoilData) -> &mut Self {
        self.world_mut()
            .resource_mut::<AirfoilLibrary>()
            .register(name, data);
        self
    }
}

/// System that resolves `AeroZone::airfoil_name` to coefficient tables.
///
/// Runs in `PreUpdate` on every newly added `AeroZone`. For each zone with
/// a non-empty `airfoil_name`, looks up the name in [`AirfoilLibrary`] and
/// overwrites any [`AeroCoeff::Placeholder`] `cl`/`cd`/`cm` field with the
/// corresponding data from the library. Explicit (non-`Placeholder`) fields
/// are never overwritten.
///
/// Emits a `warn_once!` if the name is not found in the library.
pub fn resolve_airfoil_names(
    library: Res<AirfoilLibrary>,
    mut zones: Query<&mut crate::components::AeroZone, Added<crate::components::AeroZone>>,
) {
    for mut zone in &mut zones {
        if zone.airfoil_name.is_empty() {
            continue;
        }
        let name = zone.airfoil_name.clone();
        let Some(data) = library.lookup(&name) else {
            warn_once!(
                "AeroZone references unknown airfoil \"{name}\". \
                 Register it via App::register_airfoil() before spawning zones."
            );
            continue;
        };
        if matches!(zone.cl, AeroCoeff::Placeholder) {
            zone.cl = data.cl.clone();
        }
        if matches!(zone.cd, AeroCoeff::Placeholder) {
            zone.cd = data.cd.clone();
        }
        if matches!(zone.cm, AeroCoeff::Placeholder) {
            zone.cm = data.cm.clone();
        }
    }
}