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
79
80
81

//! FDM debug rendering plugin.
//!
//! Renders aerodynamic force vectors, moment arcs, zone health wireframes, and
//! angle-of-attack indicators as Bevy gizmos.
//!
//! Only compiled with `features = ["debug-plugin"]`. Add alongside
//! [`crate::plugin::AircraftFdmPlugin`], not included in it by default:
//!
//! ```rust,no_run
//! use avian_fdm::plugin::AircraftFdmPlugin;
//! use avian_fdm::debug_render::AircraftFdmDebugPlugin;
//! use bevy::prelude::*;
//!
//! App::new()
//!     .add_plugins((AircraftFdmPlugin::default(), AircraftFdmDebugPlugin))
//!     .run();
//! ```
//!
//! Configure globally via [`GizmoConfigStore`] using [`FdmGizmos`]:
//!
//! ```rust,no_run
//! use avian_fdm::debug_render::FdmGizmos;
//! use bevy::prelude::*;
//!
//! App::new()
//!     .insert_gizmo_config(
//!         FdmGizmos::forces(),
//!         GizmoConfig::default(),
//!     );
//! ```
//!
//! Override per zone entity with [`FdmDebugRender`].

mod colliders;
mod configuration;
mod gizmos;

pub use crate::gizmo_shape::{GizmoContours, GizmoShape};
pub use colliders::ShowColliders;
pub use configuration::{FdmDebugRender, FdmGizmos};

use crate::_bevy::*;
use bevy_transform::TransformSystems;
use gizmos::*;

/// Plugin that adds all FDM debug gizmo overlays.
///
/// Must be added **separately** from [`crate::plugin::AircraftFdmPlugin`], it is not included
/// by default (following Avian's `PhysicsDebugPlugin` convention).
///
/// [`AircraftFdmPlugin`]: crate::plugin::AircraftFdmPlugin
#[derive(Default)]
pub struct AircraftFdmDebugPlugin;

impl Plugin for AircraftFdmDebugPlugin {
    fn build(&self, app: &mut App) {
        colliders::plugin(app);

        app.init_gizmo_group::<FdmGizmos>();
        app.register_type::<FdmDebugRender>();

        let mut store = app.world_mut().resource_mut::<GizmoConfigStore>();
        store.config_mut::<FdmGizmos>().0.line.width = 1.5;

        app.add_systems(
            PostUpdate,
            (
                debug_render_cg,
                debug_render_ac,
                debug_render_zone_forces,
                debug_render_thrust,
                debug_render_resultant,
                debug_render_moments,
                debug_render_zones,
                debug_render_wind,
            )
                .after(TransformSystems::Propagate)
                .run_if(|store: Res<GizmoConfigStore>| store.config::<FdmGizmos>().0.enabled),
        );
    }
}