cityjson 0.7.1

Types and accessor methods for representing semantic 3D city models in Rust, implementing the CityJSON specifications.
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

use crate::resources::handles::TextureHandle;
use crate::resources::id::{ResourceId, ResourceId32};
use crate::v2_0::vertex::{VertexIndex, VertexRef};

#[repr(C)]
#[derive(Clone, Debug, Default, Hash, Ord, PartialOrd, Eq, PartialEq)]
pub(crate) struct TextureMapCore<VR: VertexRef, RR: ResourceId> {
    vertices: Vec<Option<VertexIndex<VR>>>,
    rings: Vec<VertexIndex<VR>>,
    ring_textures: Vec<Option<RR>>,
    // The boundary is authoritative for surface, shell, and solid topology.
}

impl<VR: VertexRef, RR: ResourceId> TextureMapCore<VR, RR> {
    pub(crate) fn is_empty(&self) -> bool {
        self.vertices.is_empty() && self.rings.is_empty() && self.ring_textures.is_empty()
    }

    pub(crate) fn add_vertex(&mut self, vertex: Option<VertexIndex<VR>>) {
        self.vertices.push(vertex);
    }

    pub(crate) fn add_ring(&mut self, ring_start: VertexIndex<VR>) {
        self.rings.push(ring_start);
    }

    pub(crate) fn add_ring_texture(&mut self, texture: Option<RR>) {
        self.ring_textures.push(texture);
    }

    pub(crate) fn vertices(&self) -> &[Option<VertexIndex<VR>>] {
        &self.vertices
    }

    pub(crate) fn vertices_mut(&mut self) -> &mut [Option<VertexIndex<VR>>] {
        &mut self.vertices
    }

    pub(crate) fn rings(&self) -> &[VertexIndex<VR>] {
        &self.rings
    }

    pub(crate) fn rings_mut(&mut self) -> &mut [VertexIndex<VR>] {
        &mut self.rings
    }

    pub(crate) fn ring_textures(&self) -> &[Option<RR>] {
        &self.ring_textures
    }

    pub(crate) fn ring_textures_mut(&mut self) -> &mut [Option<RR>] {
        &mut self.ring_textures
    }
}

#[repr(C)]
#[derive(Clone, Debug, Default, Hash, Ord, PartialOrd, Eq, PartialEq)]
pub struct TextureMap<VR: VertexRef> {
    inner: TextureMapCore<VR, ResourceId32>,
}

impl<VR: VertexRef> TextureMap<VR> {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.inner.is_empty()
    }

    pub fn add_vertex(&mut self, vertex: Option<VertexIndex<VR>>) {
        self.inner.add_vertex(vertex);
    }

    pub fn add_ring(&mut self, ring_start: VertexIndex<VR>) {
        self.inner.add_ring(ring_start);
    }

    pub fn add_ring_texture(&mut self, texture: Option<TextureHandle>) {
        self.inner
            .add_ring_texture(texture.map(super::super::handles::TextureHandle::to_raw));
    }

    #[must_use]
    pub fn vertices(&self) -> &[Option<VertexIndex<VR>>] {
        self.inner.vertices()
    }

    pub fn vertices_mut(&mut self) -> &mut [Option<VertexIndex<VR>>] {
        self.inner.vertices_mut()
    }

    #[must_use]
    pub fn rings(&self) -> &[VertexIndex<VR>] {
        self.inner.rings()
    }

    pub fn rings_mut(&mut self) -> &mut [VertexIndex<VR>] {
        self.inner.rings_mut()
    }

    #[must_use]
    pub fn ring_textures(&self) -> Vec<Option<TextureHandle>> {
        self.inner
            .ring_textures()
            .iter()
            .copied()
            .map(|r| r.map(TextureHandle::from_raw))
            .collect()
    }

    pub fn set_ring_texture(&mut self, ring_index: usize, texture: Option<TextureHandle>) -> bool {
        let Some(slot) = self.inner.ring_textures_mut().get_mut(ring_index) else {
            return false;
        };
        *slot = texture.map(super::super::handles::TextureHandle::to_raw);
        true
    }

    #[allow(dead_code)]
    pub(crate) fn from_raw(inner: TextureMapCore<VR, ResourceId32>) -> Self {
        Self { inner }
    }

    #[allow(dead_code)]
    pub(crate) fn into_raw(self) -> TextureMapCore<VR, ResourceId32> {
        self.inner
    }

    #[allow(dead_code)]
    pub(crate) fn to_raw(&self) -> &TextureMapCore<VR, ResourceId32> {
        &self.inner
    }
}

// ---------------------------------------------------------------------------
// Unit tests for TextureMapCore / TextureMap
// Family 8: texture topology (vertices / rings / ring_textures)
// Family 9: vertex-reuse — same geometric vertex, different UV per ring
// ---------------------------------------------------------------------------

#[cfg(test)]
mod texture_map {
    use super::*;
    use crate::resources::id::ResourceId32;

    type Core = TextureMapCore<u32, ResourceId32>;

    fn make_tex_id(index: u32) -> ResourceId32 {
        ResourceId32::new(index, 0)
    }

    fn vi(n: u32) -> VertexIndex<u32> {
        VertexIndex::new(n)
    }

    // -----------------------------------------------------------------------
    // Family 8: core topology
    // -----------------------------------------------------------------------

    #[test]
    fn ring_count_matches_uv_vertex_count() {
        // A ring with 3 vertices: ring starts at uv-vertex index 0
        let mut core = Core::default();
        core.add_vertex(Some(vi(0)));
        core.add_vertex(Some(vi(1)));
        core.add_vertex(Some(vi(2)));
        core.add_ring(vi(0));
        core.add_ring_texture(Some(make_tex_id(0)));

        assert_eq!(core.vertices().len(), 3);
        assert_eq!(core.rings().len(), 1);
        assert_eq!(core.ring_textures().len(), 1);
    }

    #[test]
    fn ring_texture_can_be_none() {
        let mut core = Core::default();
        core.add_vertex(Some(vi(0)));
        core.add_ring(vi(0));
        core.add_ring_texture(None);

        assert!(core.ring_textures()[0].is_none());
    }

    #[test]
    fn multi_ring_multi_texture() {
        // Two rings in the same surface, each with a different texture
        let mut core = Core::default();
        // Ring 0: vertices 0,1,2
        core.add_vertex(Some(vi(0)));
        core.add_vertex(Some(vi(1)));
        core.add_vertex(Some(vi(2)));
        core.add_ring(vi(0));
        core.add_ring_texture(Some(make_tex_id(0)));
        // Ring 1: vertices 0,2,3
        core.add_vertex(Some(vi(0)));
        core.add_vertex(Some(vi(2)));
        core.add_vertex(Some(vi(3)));
        core.add_ring(vi(3));
        core.add_ring_texture(Some(make_tex_id(1)));

        assert_eq!(core.vertices().len(), 6);
        assert_eq!(core.rings().len(), 2);
        assert_eq!(core.ring_textures().len(), 2);
        assert_eq!(core.ring_textures()[0], Some(make_tex_id(0)));
        assert_eq!(core.ring_textures()[1], Some(make_tex_id(1)));
    }

    // -----------------------------------------------------------------------
    // Family 9: vertex-reuse — a geometric vertex can appear in multiple rings
    // with different UV coordinates per occurrence
    // -----------------------------------------------------------------------

    #[test]
    fn vertex_reuse_different_uvs_per_ring() {
        // Geometric vertices 0 and 1 appear in two rings.
        // Ring 0 maps vertex 0 → uv-vertex 0, vertex 1 → uv-vertex 1.
        // Ring 1 maps vertex 0 → uv-vertex 2 (different UV!), vertex 1 → uv-vertex 3.
        let mut core = Core::default();
        // Ring 0 uv-vertices
        core.add_vertex(Some(vi(0))); // uv index 0 → geom vertex 0
        core.add_vertex(Some(vi(1))); // uv index 1 → geom vertex 1
        core.add_ring(vi(0));
        core.add_ring_texture(Some(make_tex_id(0)));
        // Ring 1 uv-vertices — same geom vertices, different UV positions in the pool
        core.add_vertex(Some(vi(0))); // uv index 2 → geom vertex 0 (reused)
        core.add_vertex(Some(vi(1))); // uv index 3 → geom vertex 1 (reused)
        core.add_ring(vi(2));
        core.add_ring_texture(Some(make_tex_id(0)));

        assert_eq!(core.vertices().len(), 4, "4 uv-vertex slots (2 per ring)");
        // uv-vertex 0 and uv-vertex 2 both reference the same geometric vertex 0
        assert_eq!(core.vertices()[0], core.vertices()[2]);
        // but they are distinct slots — allowing different UV coords in the UV pool
        assert_ne!(
            core.rings()[0],
            core.rings()[1],
            "rings start at different uv-vertex offsets"
        );
    }
}