mjcf-rs 0.1.0

Pure-Rust parser for the MuJoCo MJCF XML format.
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

//! Pass-through types: `<actuator>`, `<sensor>`, `<keyframe>`.

/// `<actuator>` element. Stores enough information for the loader to wire
/// it up to a rapier joint motor; the simulation itself is up to the user.
#[derive(Clone, Debug, Default)]
pub struct Actuator {
    /// `name` attribute.
    pub name: Option<String>,
    /// Default class.
    pub class: Option<String>,
    /// Subtype (`motor`, `position`, `velocity`, …).
    pub kind: ActuatorKind,
    /// Joint name this actuator drives, if any.
    pub joint: Option<String>,
    /// Tendon name. Tendons are out of scope; recorded only.
    pub tendon: Option<String>,
    /// Body name (for `<actuator><adhesion>`-like actuators). Recorded only.
    pub body: Option<String>,
    /// Site (for `<actuator><site>`-like actuators). Recorded only.
    pub site: Option<String>,
    /// Gear ratio (default 1.0). Length 6 for spatial gears; we keep all 6.
    pub gear: [f64; 6],
    /// `ctrlrange` if specified.
    pub ctrl_range: Option<[f64; 2]>,
    /// `forcerange` if specified.
    pub force_range: Option<[f64; 2]>,
    /// `ctrllimited`.
    pub ctrl_limited: crate::types::Tristate,
    /// `forcelimited`.
    pub force_limited: crate::types::Tristate,
    /// `gainprm` (up to 10 entries).
    pub gainprm: Vec<f64>,
    /// `biasprm` (up to 10 entries).
    pub biasprm: Vec<f64>,
    /// `dyntype`.
    pub dyn_type: Option<String>,
    /// `dynprm`.
    pub dynprm: Vec<f64>,
    /// `kp` for `<position>` actuators.
    pub kp: Option<f64>,
    /// `kv` for `<velocity>` / `<damper>` actuators.
    pub kv: Option<f64>,
}

/// `<actuator>` subtype.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Default)]
pub enum ActuatorKind {
    /// `<motor>` — direct force/torque actuator.
    #[default]
    Motor,
    /// `<position>`.
    Position,
    /// `<velocity>`.
    Velocity,
    /// `<intvelocity>`.
    IntVelocity,
    /// `<damper>`.
    Damper,
    /// `<general>` (most general form).
    General,
    /// Anything else (cylinder/muscle/adhesion/plugin) — recorded but not driven.
    Other,
}

/// `<sensor>` element. Recorded for downstream code.
#[derive(Clone, Debug, Default)]
pub struct Sensor {
    /// `name` attribute.
    pub name: Option<String>,
    /// Default class.
    pub class: Option<String>,
    /// MJCF subtype name (`accelerometer`, `gyro`, `jointpos`, …).
    pub kind: String,
    /// Object reference type (`body`, `geom`, `site`, `joint`, …).
    pub objtype: Option<String>,
    /// Object name reference.
    pub objname: Option<String>,
    /// Reference body (for relative sensors).
    pub reftype: Option<String>,
    /// Reference body name.
    pub refname: Option<String>,
    /// `cutoff` clamp.
    pub cutoff: Option<f64>,
    /// `noise` standard deviation.
    pub noise: Option<f64>,
}

/// One `<keyframe><key>` entry.
#[derive(Clone, Debug, Default)]
pub struct Keyframe {
    /// `name` attribute.
    pub name: Option<String>,
    /// `time` attribute.
    pub time: f64,
    /// `qpos` array (one entry per generalized coordinate).
    pub qpos: Vec<f64>,
    /// `qvel` array.
    pub qvel: Vec<f64>,
    /// `act` actuator activation array.
    pub act: Vec<f64>,
    /// `ctrl` controller setpoint array.
    pub ctrl: Vec<f64>,
    /// `mpos` mocap-body positions (3 per mocap body).
    pub mpos: Vec<f64>,
    /// `mquat` mocap-body orientations (4 per mocap body).
    pub mquat: Vec<f64>,
}