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

//! Engine zone component.

use crate::_bevy::*;
use avian3d::math::{Scalar, Vector};
use serde::{Deserialize, Serialize};

/// Piston engine configuration. Attach to the engine child entity alongside
/// an Avian [`avian3d::prelude::Collider`] and
/// [`avian3d::prelude::ColliderDensity`].
///
/// Thrust is applied via `apply_force_at_point` at the engine's world
/// position. Avian computes the torque contribution automatically.
///
/// Failure state is read from [`crate::components::Failure`] if present on the same entity.
/// When absent the engine is treated as fully intact.
///
/// Lives on the **engine child entity**.
///
/// ## Required components
///
/// - ZoneForce: written by the FDM each frame; treat as read-only.
#[derive(Component, Reflect, Serialize, Deserialize, Clone, Debug)]
#[reflect(Component, Serialize, Deserialize)]
#[require(crate::components::zone_force::ZoneForce)]
pub struct EngineZone {
    /// Sea-level static maximum thrust (N).
    pub max_thrust_n: Scalar,
    /// Throttle-to-thrust-fraction lookup table. Each entry is `[throttle, fraction]`.
    /// `throttle` in [0, 1]. Must be strictly increasing in throttle.
    pub throttle_curve: Vec<[Scalar; 2]>,
    /// Thrust direction in body frame (unit vector). Usually `Vector::X` (forward).
    pub thrust_axis_body: Vector,

    /// Airspeed at which the propeller produces zero net thrust (m/s).
    ///
    /// Models the speed dependence of a fixed-pitch propeller. The thrust
    /// multiplier is `max(0, 1 − (V / V_zero)²)`:
    ///
    /// - At V = 0: factor = 1.0 (full static thrust)
    /// - At V = V_zero: factor = 0.0 (propeller windmilling)
    ///
    /// `None` disables speed dependence (constant-thrust model).
    /// Typical values for light GA: 70–90 m/s (J3 Cub ~ 80 m/s).
    pub zero_thrust_speed_ms: Option<Scalar>,
}

impl Default for EngineZone {
    fn default() -> Self {
        Self {
            max_thrust_n: 0.0,
            throttle_curve: vec![[0.0, 0.0], [1.0, 1.0]],
            thrust_axis_body: Vector::X,
            zero_thrust_speed_ms: None,
        }
    }
}