bevy_urdf 0.4.3

Import robots from URDF files and run simulation with rapier.
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
use std::{collections::VecDeque, f32::consts::PI};

use anyhow::Error;
use bevy::prelude::*;
use bevy_rapier3d::{
    plugin::RapierConfiguration,
    prelude::{
        RapierContextColliders, RapierContextJoints, RapierContextSimulation, RapierRigidBodySet,
    },
};
use nalgebra::{vector, Isometry3, Rotation3, UnitQuaternion, Vector3};
use rapier3d::prelude::RigidBodyType;
use roxmltree::Document;

use crate::{control::UAVStateUpdate, urdf_asset_loader::UrdfAsset, URDFRobot};

#[derive(Default, Debug, Clone, PartialEq)]
pub enum DronePhysics {
    #[default]
    RapierPhysics,
    ODEPhysics,
}

#[derive(Default, Debug, Clone, PartialEq)]
pub enum FlightPhase {
    #[default]
    Idle,
    TakeOff,
    Landing,
    InFlight,
}

#[derive(Component, Default, Debug, Clone)]
pub struct UAVDescriptor {
    pub aerodynamic_props: AerodynamicProps,
    pub dynamics_model_props: DynamicModelProps,
    pub visual_body_properties: VisualBodyProps,
    pub drone_physics: DronePhysics,
    pub thrust_commands: Vec<f32>,
    pub uav_state: uav::dynamics::State,
    pub(crate) state_log: VecDeque<uav::dynamics::State>,
    pub(crate) flight_phase: FlightPhase,
}

#[derive(Component)]
pub struct DroneRotor {
    pub state: uav::dynamics::RotorState,
    pub transform: Transform,
    pub rotor_index: usize,
}

impl UAVDescriptor {
    fn set_uav_state(&mut self, new_state: uav::dynamics::State) {
        self.uav_state = new_state;
        // make configurable
        if self.state_log.len() >= 30 {
            // persist state for 0.5 second
            self.state_log.pop_front();
        }

        self.state_log.push_back(new_state);
    }
}

#[derive(Default, Debug, Clone, Copy)]
pub struct AerodynamicProps {
    pub kf: f32,
    pub km: f32,
    pub thrust2weight: f32,
    pub max_speed_kmh: f32,
    pub gnd_eff_coeff: f32,
    pub prop_radius: f32,
    pub drag_coeff_xy: f32,
    pub drag_coeff_z: f32,
    pub dw_coeff_1: f32,
    pub dw_coeff_2: f32,
    pub dw_coeff_3: f32,
}

#[derive(Default, Debug, Clone)]
pub struct DynamicModelProps {
    pub mass: f32,
    pub ixx: f32,
    pub iyy: f32,
    pub izz: f32,
    pub rotor_positions: Vec<Vec3>,
}

impl DynamicModelProps {
    pub fn n_rotors(&self) -> usize {
        self.rotor_positions.len()
    }
}

#[derive(Default, Debug, Clone)]
pub struct VisualBodyProps {
    pub root_body_index: usize,
    pub rotor_body_indices: Vec<usize>,
    pub rotor_positions: Vec<Vec3>,
}

#[derive(Event)]
pub struct ControlThrusts {
    pub handle: Handle<UrdfAsset>,
    pub thrusts: Vec<f32>,
}

#[derive(Debug)]
pub enum ParseError {
    XmlError(roxmltree::Error),
    MissingProperties,
    InvalidFloat(String),
}

impl std::fmt::Display for ParseError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ParseError::XmlError(e) => write!(f, "XML parsing error: {e}"),
            ParseError::MissingProperties => write!(f, "Missing properties element"),
            ParseError::InvalidFloat(attr) => {
                write!(f, "Invalid float value for attribute: {attr}")
            }
        }
    }
}

impl std::error::Error for ParseError {}

impl From<roxmltree::Error> for ParseError {
    fn from(error: roxmltree::Error) -> Self {
        ParseError::XmlError(error)
    }
}

pub fn try_extract_drone_aerodynamic_props(
    xml_content: &str,
) -> Result<AerodynamicProps, ParseError> {
    let doc = Document::parse(xml_content)?;

    // Find the properties element
    let properties = doc
        .descendants()
        .find(|n| n.has_tag_name("properties"))
        .ok_or(ParseError::MissingProperties)?;

    let mut props = AerodynamicProps::default();

    // Helper function to parse an attribute
    let parse_attr = |attr_name: &str| -> Result<Option<f32>, ParseError> {
        if let Some(value) = properties.attribute(attr_name) {
            let parsed = value
                .parse::<f32>()
                .map_err(|_| ParseError::InvalidFloat(attr_name.to_string()))?;
            Ok(Some(parsed))
        } else {
            Ok(None)
        }
    };

    // Parse each attribute
    if let Some(val) = parse_attr("kf")? {
        props.kf = val;
    }

    if let Some(val) = parse_attr("km")? {
        props.km = val;
    }

    if let Some(val) = parse_attr("thrust2weight")? {
        props.thrust2weight = val;
    }

    if let Some(val) = parse_attr("max_speed_kmh")? {
        props.max_speed_kmh = val;
    }

    if let Some(val) = parse_attr("gnd_eff_coeff")? {
        props.gnd_eff_coeff = val;
    }

    if let Some(val) = parse_attr("prop_radius")? {
        props.prop_radius = val;
    }

    if let Some(val) = parse_attr("drag_coeff_xy")? {
        props.drag_coeff_xy = val;
    }

    if let Some(val) = parse_attr("drag_coeff_z")? {
        props.drag_coeff_z = val;
    }

    if let Some(val) = parse_attr("dw_coeff_1")? {
        props.dw_coeff_1 = val;
    }

    if let Some(val) = parse_attr("dw_coeff_2")? {
        props.dw_coeff_2 = val;
    }

    if let Some(val) = parse_attr("dw_coeff_3")? {
        props.dw_coeff_3 = val;
    }

    Ok(props)
}

pub fn try_extract_drone_visual_and_dynamic_model_props(
    xml_content: &str,
) -> Result<(DynamicModelProps, VisualBodyProps), Error> {
    let urdf_robot = urdf_rs::read_from_string(xml_content)?;
    let mut visual_body_props = VisualBodyProps { ..default() };
    let mut dynamics_model_properties = DynamicModelProps { ..default() };

    for (index, link) in urdf_robot.links.iter().enumerate() {
        // probably it's a drone body
        if link.name.contains("base_") && link.inertial.mass.value != 0.0 {
            visual_body_props.root_body_index = index;
            dynamics_model_properties.ixx = link.inertial.inertia.ixx as f32;
            dynamics_model_properties.iyy = link.inertial.inertia.iyy as f32;
            dynamics_model_properties.izz = link.inertial.inertia.izz as f32;
            dynamics_model_properties.mass = link.inertial.mass.value as f32;
        }

        // probably it's a propeller
        if link.name.contains("prop") {
            let prop_origin = link.inertial.origin.xyz.0;
            visual_body_props.rotor_body_indices.push(index);
            dynamics_model_properties.rotor_positions.push(Vec3::new(
                prop_origin[0] as f32,
                prop_origin[1] as f32,
                prop_origin[2] as f32,
            ));

            for visual in link.visual.iter() {
                let prop_visual = visual.origin.xyz.0;
                visual_body_props.rotor_positions.push(Vec3::new(
                    prop_visual[0] as f32,
                    prop_visual[1] as f32,
                    prop_visual[2] as f32,
                ));
            }
        }
    }

    Ok((dynamics_model_properties, visual_body_props))
}

pub(crate) fn handle_control_thrusts(
    mut er_control_thrusts: EventReader<ControlThrusts>,
    mut q_urdf_robots: Query<(Entity, &URDFRobot, &mut UAVDescriptor)>,
) {
    // just copy thrusts to drone descriptor. uav will pick it and apply in dynamics model
    for event in er_control_thrusts.read() {
        for (_, robot, mut descriptor) in q_urdf_robots.iter_mut() {
            if event.handle != robot.handle {
                continue;
            }
            descriptor.thrust_commands = event.thrusts.clone();
        }
    }
}

pub(crate) fn switch_drone_physics(
    mut q_urdf_robots: Query<(Entity, &Transform, &mut UAVDescriptor)>,
) {
    for (_, _, mut drone) in q_urdf_robots.iter_mut() {
        if drone.state_log.is_empty() {
            continue;
        }

        let last_state = drone.state_log.iter().last().unwrap();
        let first_state = drone.state_log.iter().next().unwrap();

        let delta_altitude = last_state.position_z - first_state.position_z;

        // determine flight phase
        match drone.flight_phase {
            FlightPhase::Idle => {
                if delta_altitude > 0.0 {
                    drone.flight_phase = FlightPhase::TakeOff;
                }
            }
            FlightPhase::TakeOff => {
                // has taken off 10cm
                if delta_altitude > 0.1 {
                    drone.flight_phase = FlightPhase::InFlight;
                }
            }
            _ => {}
        }

        match drone.drone_physics {
            DronePhysics::RapierPhysics => {
                if drone.flight_phase == FlightPhase::InFlight {
                    drone.drone_physics = DronePhysics::ODEPhysics;
                }
            }
            DronePhysics::ODEPhysics => {}
        }
    }
}

pub(crate) fn simulate_drone(
    mut q_drones: Query<(Entity, &mut Transform, &URDFRobot, &mut UAVDescriptor)>,
    mut q_drone_rotors: Query<(Entity, &ChildOf, &mut DroneRotor)>,
    mut q_rapier_context: Query<(
        Entity,
        &mut RapierConfiguration,
        &mut RapierContextSimulation,
        &mut RapierRigidBodySet,
        &mut RapierContextColliders,
        &mut RapierContextJoints,
    )>,
    mut ew_uav_state_update: EventWriter<UAVStateUpdate>,
) {
    for (_, rapier_configuration, rapier_simulation, mut rigid_bodies, _, _) in
        q_rapier_context.iter_mut()
    {
        if !rapier_configuration.physics_pipeline_active {
            continue;
        }

        let start_time = 0.0;
        let end_time = rapier_simulation.integration_parameters.dt as f64;

        for (parent_entity, _transform, urdf_robot, mut drone) in q_drones.iter_mut() {
            let consts = uav::dynamics::Consts {
                g: rapier_configuration.gravity.length() as f64,
                mass: drone.dynamics_model_props.mass as f64,
                ixx: drone.dynamics_model_props.ixx as f64,
                iyy: drone.dynamics_model_props.iyy as f64,
                izz: drone.dynamics_model_props.izz as f64,
            };

            if drone.thrust_commands.is_empty() {
                continue;
            }

            let mut output_thusts: Vec<f32> = Vec::new();
            for (index, thrust_command) in drone.thrust_commands.iter().enumerate() {
                for (_, child_of, mut drone_rotor) in q_drone_rotors.iter_mut() {
                    if !(child_of.parent() == parent_entity && drone_rotor.rotor_index == index) {
                        continue;
                    }

                    drone_rotor
                        .state
                        .update(rapier_simulation.integration_parameters.dt, *thrust_command);

                    output_thusts.push(drone_rotor.state.current_thrust);
                    break;
                }
            }

            let (forces, torques) = multirotor_dynamics(
                &output_thusts,
                &drone.aerodynamic_props,
                &drone.dynamics_model_props,
            );

            if drone.drone_physics == DronePhysics::ODEPhysics {
                match uav::dynamics::simulate_drone(
                    drone.uav_state,
                    consts,
                    Vector3::new(forces[0] as f64, forces[1] as f64, forces[2] as f64),
                    Vector3::new(torques[0] as f64, torques[1] as f64, torques[2] as f64),
                    (start_time, end_time),
                    1e-6,
                ) {
                    Ok(new_state) => {
                        drone.uav_state = new_state;
                        // assume root body as at link 0
                        let root_body_handle = &urdf_robot.rapier_handles.links
                            [drone.visual_body_properties.root_body_index]
                            .body;
                        if let Some(root_body) = rigid_bodies.bodies.get_mut(*root_body_handle) {
                            root_body.set_body_type(RigidBodyType::KinematicPositionBased, false);
                            let position = Isometry3::translation(
                                new_state.position_x as f32,
                                new_state.position_z as f32,
                                new_state.position_y as f32,
                            );
                            root_body.set_position(position, false);

                            let rotation = Rotation3::from_euler_angles(
                                new_state.roll as f32,
                                new_state.pitch as f32,
                                new_state.yaw as f32,
                            );
                            let quat = UnitQuaternion::from_rotation_matrix(&rotation);
                            let quat_fix =
                                UnitQuaternion::from_scaled_axis(Vector3::new(-PI / 2., 0.0, 0.0));

                            root_body.set_rotation(quat_fix * quat, false);
                        }

                        drone.set_uav_state(new_state);

                        ew_uav_state_update.write(UAVStateUpdate {
                            handle: urdf_robot.handle.clone(),
                            drone_state: new_state,
                        });
                    }
                    Err(_e) => {}
                }
            } else if drone.drone_physics == DronePhysics::RapierPhysics {
                let root_body_handle = &urdf_robot.rapier_handles.links
                    [drone.visual_body_properties.root_body_index]
                    .body;

                if let Some(root_body) = rigid_bodies.bodies.get_mut(*root_body_handle) {
                    root_body.set_body_type(RigidBodyType::Dynamic, false);
                    root_body.reset_forces(false);
                    root_body.reset_torques(false);
                    let rotation = *root_body.rotation();
                    let position = *root_body.position().translation;
                    let omega = *root_body.angvel();
                    let velocity = *root_body.linvel();

                    let quat_fix =
                        UnitQuaternion::from_scaled_axis(Vector3::new(-PI / 2.0, 0.0, 0.0));
                    let quat_fix_inverse = quat_fix.inverse();

                    let original_quat = quat_fix_inverse * rotation;
                    let euler_angles_transformed = original_quat.euler_angles();
                    let omega_transformed = quat_fix_inverse * omega;

                    // apply forces to rapier body
                    let forces = rotation * vector![forces[0], forces[1], forces[2]];
                    let torques = rotation * vector![torques[0], torques[1], torques[2]];

                    root_body.add_force(forces, true);
                    root_body.add_torque(torques, true);

                    // sync drone state
                    let new_state = uav::dynamics::State {
                        position_x: position.x as f64,
                        position_y: position.z as f64,
                        position_z: position.y as f64,
                        velocity_x: velocity.x as f64,
                        velocity_y: velocity.z as f64,
                        velocity_z: velocity.y as f64,
                        roll: euler_angles_transformed.0 as f64,
                        pitch: euler_angles_transformed.1 as f64,
                        yaw: euler_angles_transformed.2 as f64,
                        roll_rate: omega_transformed.x as f64,
                        pitch_rate: omega_transformed.y as f64,
                        yaw_rate: omega_transformed.z as f64,
                    };
                    drone.set_uav_state(new_state);
                }
            }
        }
    }
}

fn multirotor_dynamics(
    thrusts: &[f32],
    aerodynamics_props: &AerodynamicProps,
    dynamics_props: &DynamicModelProps,
) -> ([f32; 3], [f32; 3]) {
    // Ensure we have the same number of thrusts as rotors
    assert_eq!(thrusts.len(), dynamics_props.n_rotors());

    let torque_to_thrust_ratio = aerodynamics_props.km / aerodynamics_props.kf;
    let f_direction = vector![0.0, 0.0, 1.0];

    // Calculate total force and torque
    let mut total_force = vector![0.0, 0.0, 0.0];
    let mut total_torque_from_thrust = vector![0.0, 0.0, 0.0];
    let mut total_torque_from_drag = vector![0.0, 0.0, 0.0];

    for (i, &thrust) in thrusts.iter().enumerate() {
        let rp = dynamics_props.rotor_positions[i];
        let rotor_position = vector![rp.x, rp.y, rp.z];
        let force_vector = f_direction * thrust;

        // Accumulate total force
        total_force += force_vector;

        // Torque from thrust (position × force)
        let torque_from_thrust = rotor_position.cross(&force_vector);
        total_torque_from_thrust += torque_from_thrust;

        // Torque from rotor drag
        // Assuming alternating rotor directions: even indices CW, odd indices CCW
        let rotor_direction = if i % 2 == 0 { -1.0 } else { 1.0 };
        let torque_from_drag = f_direction * (torque_to_thrust_ratio * thrust * rotor_direction);
        total_torque_from_drag += torque_from_drag;
    }

    // Total torque is the sum of thrust-induced torque and drag torque
    let total_torque = total_torque_from_thrust + total_torque_from_drag;

    (
        [total_force.x, total_force.y, total_force.z],
        [total_torque.x, total_torque.y, total_torque.z],
    )
}

pub(crate) fn render_drone_rotors(mut q_rotors: Query<(Entity, &mut Transform, &DroneRotor)>) {
    let quat_fix = Quat::from_rotation_x(std::f32::consts::PI / 2.0);
    for (_, mut transform, rotor) in q_rotors.iter_mut() {
        let rotor_direction = if rotor.rotor_index % 2 == 0 {
            -1.0
        } else {
            1.0
        };
        transform.rotation =
            quat_fix * Quat::from_rotation_z(rotor_direction * rotor.state.current_angle);
    }
}