mjcf-rs 0.34.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

//! `<equality>` element AST.

/// One `<equality>` entry.
#[derive(Clone, Debug)]
pub enum Equality {
    /// `<equality><connect>` — point-to-point constraint between two bodies.
    Connect(EqualityConnect),
    /// `<equality><weld>` — rigid attachment between two bodies.
    Weld(EqualityWeld),
    /// `<equality><joint>` — polynomial coupling between two joints' positions.
    Joint(EqualityJoint),
    /// `<equality><tendon>` — polynomial coupling between two tendon lengths,
    /// or (with `tendon2` omitted) a fixed tendon pinned to a constant length.
    Tendon(EqualityTendon),
}

/// Common metadata shared by all equality variants.
#[derive(Clone, Debug, Default)]
pub struct EqualityCommon {
    /// `name` attribute.
    pub name: Option<String>,
    /// Class.
    pub class: Option<String>,
    /// `active` attribute (default `true`).
    pub active: bool,
}

/// `<equality><connect>` element.
#[derive(Clone, Debug, Default)]
pub struct EqualityConnect {
    /// Common metadata.
    pub common: EqualityCommon,
    /// First body.
    pub body1: String,
    /// Second body. May be omitted (constrains to world).
    pub body2: Option<String>,
    /// Anchor in body1's frame.
    pub anchor: [f64; 3],
}

/// `<equality><weld>` element.
#[derive(Clone, Debug, Default)]
pub struct EqualityWeld {
    /// Common metadata.
    pub common: EqualityCommon,
    /// First body.
    pub body1: String,
    /// Second body. May be omitted (constrains to world).
    pub body2: Option<String>,
    /// Optional `relpose` attribute `(pos quat)`.
    pub relpose: Option<crate::Pose>,
    /// Optional anchor (`anchor="x y z"`).
    pub anchor: Option<[f64; 3]>,
    /// `torquescale` attribute.
    pub torque_scale: f64,
}

/// `<equality><joint>` element: couples the position of `joint2` to that of
/// `joint1` through a quartic polynomial of the offset from their reference
/// positions:
/// `q2 − ref2 = p0 + p1·(q1 − ref1) + p2·(q1 − ref1)² + p3·(q1 − ref1)³ + p4·(q1 − ref1)⁴`.
/// `joint2` may be omitted, in which case `joint1` is constrained to the
/// constant `p0`.
#[derive(Clone, Debug, Default)]
pub struct EqualityJoint {
    /// Common metadata.
    pub common: EqualityCommon,
    /// First (independent) joint.
    pub joint1: String,
    /// Second (dependent) joint. `None` constrains `joint1` to `polycoef[0]`.
    pub joint2: Option<String>,
    /// Polynomial coefficients `[p0, p1, p2, p3, p4]` (default `[0,1,0,0,0]`).
    pub polycoef: [f64; 5],
}

/// `<equality><tendon>` element: couples the length of `tendon2` to that of
/// `tendon1` through the same quartic polynomial form as [`EqualityJoint`].
/// `tendon2` may be omitted, in which case `tendon1`'s length is constrained to
/// the constant `polycoef[0]`.
#[derive(Clone, Debug, Default)]
pub struct EqualityTendon {
    /// Common metadata.
    pub common: EqualityCommon,
    /// First (independent) tendon name.
    pub tendon1: String,
    /// Second (dependent) tendon name. `None` constrains `tendon1` to `polycoef[0]`.
    pub tendon2: Option<String>,
    /// Polynomial coefficients `[p0, p1, p2, p3, p4]` (default `[0,1,0,0,0]`).
    pub polycoef: [f64; 5],
}