rbx_xml 2.0.1

Implementation of Roblox's XML file formats, rbxlx and rbxmx
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

use std::io::{Read, Write};

use rbx_dom_weak::types::CFrame;

use crate::{
    core::XmlType,
    deserializer_core::XmlEventReader,
    error::{DecodeError, EncodeError},
    serializer_core::XmlEventWriter,
};

static TAG_NAMES: [&str; 12] = [
    "X", "Y", "Z", "R00", "R01", "R02", "R10", "R11", "R12", "R20", "R21", "R22",
];

impl XmlType for CFrame {
    const XML_TAG_NAME: &'static str = "CoordinateFrame";

    fn write_xml<W: Write>(&self, writer: &mut XmlEventWriter<W>) -> Result<(), EncodeError> {
        // FIXME: Should this be built into rbx_types?
        let as_slice = &[
            self.position.x,
            self.position.y,
            self.position.z,
            self.orientation.x.x,
            self.orientation.x.y,
            self.orientation.x.z,
            self.orientation.y.x,
            self.orientation.y.y,
            self.orientation.y.z,
            self.orientation.z.x,
            self.orientation.z.y,
            self.orientation.z.z,
        ];

        writer.write_tag_array(as_slice, &TAG_NAMES)?;

        Ok(())
    }

    fn read_xml<R: Read>(reader: &mut XmlEventReader<R>) -> Result<Self, DecodeError> {
        let mut value = CFrame::identity();

        for &tag_name in &TAG_NAMES {
            let component: f32 = reader.read_value_in_tag(tag_name)?;

            match tag_name {
                "X" => value.position.x = component,
                "Y" => value.position.y = component,
                "Z" => value.position.z = component,

                "R00" => value.orientation.x.x = component,
                "R01" => value.orientation.x.y = component,
                "R02" => value.orientation.x.z = component,

                "R10" => value.orientation.y.x = component,
                "R11" => value.orientation.y.y = component,
                "R12" => value.orientation.y.z = component,

                "R20" => value.orientation.z.x = component,
                "R21" => value.orientation.z.y = component,
                "R22" => value.orientation.z.z = component,

                _ => unreachable!(),
            }
        }

        Ok(value)
    }
}

#[cfg(test)]
mod test {
    use super::*;

    use crate::test_util;
    use rbx_dom_weak::types::{Matrix3, Vector3};

    #[test]
    fn round_trip() {
        let test_input = CFrame::new(
            Vector3::new(123.0, 456.0, 789.0),
            Matrix3 {
                x: Vector3::new(987.0, 654.0, 432.0),
                y: Vector3::new(210.0, 0.0, -12345.0),
                z: Vector3::new(765.0, 234.0, 123123.0),
            },
        );

        test_util::test_xml_round_trip(&test_input);
    }
}