cityjson 0.7.1

Types and accessor methods for representing semantic 3D city models in Rust, implementing the CityJSON specifications.
Documentation
pub mod materials;
pub mod semantics;
pub mod textures;

use crate::resources::id::ResourceId;
use crate::v2_0::boundary::BoundaryType;
use crate::v2_0::vertex::VertexRef;

pub use materials::MaterialMap;
pub use semantics::SemanticMap;
pub use textures::TextureMap;

#[repr(C)]
#[derive(Clone, Debug, Default, Hash, Ord, PartialOrd, Eq, PartialEq)]
pub(crate) struct SemanticOrMaterialMap<VR: VertexRef, RR: ResourceId> {
    pub(crate) points: Vec<Option<RR>>,
    pub(crate) linestrings: Vec<Option<RR>>,
    pub(crate) surfaces: Vec<Option<RR>>,
    // The boundary is authoritative for shell and solid topology.
    _phantom: std::marker::PhantomData<VR>,
}

impl<VR: VertexRef, RR: ResourceId> SemanticOrMaterialMap<VR, RR> {
    pub(crate) fn new() -> Self {
        Self::default()
    }

    pub(crate) fn is_empty(&self) -> bool {
        self.points.is_empty() && self.linestrings.is_empty() && self.surfaces.is_empty()
    }

    pub(crate) fn add_point(&mut self, resource: Option<RR>) {
        self.points.push(resource);
    }

    pub(crate) fn add_linestring(&mut self, resource: Option<RR>) {
        self.linestrings.push(resource);
    }

    pub(crate) fn add_surface(&mut self, resource: Option<RR>) {
        self.surfaces.push(resource);
    }

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

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

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

    pub(crate) fn check_type(&self) -> BoundaryType {
        if !self.surfaces.is_empty() {
            BoundaryType::MultiOrCompositeSurface
        } else if !self.linestrings.is_empty() {
            BoundaryType::MultiLineString
        } else if !self.points.is_empty() {
            BoundaryType::MultiPoint
        } else {
            BoundaryType::None
        }
    }
}

macro_rules! define_typed_resource_map {
    ($name:ident, $handle:ty) => {
        #[derive(Clone, Debug, Default, Hash, Ord, PartialOrd, Eq, PartialEq)]
        pub struct $name<VR: crate::v2_0::vertex::VertexRef> {
            inner: crate::resources::mapping::SemanticOrMaterialMap<
                VR,
                crate::resources::id::ResourceId32,
            >,
        }

        impl<VR: crate::v2_0::vertex::VertexRef> $name<VR> {
            pub fn new() -> Self {
                Self::default()
            }

            pub fn is_empty(&self) -> bool {
                self.inner.is_empty()
            }

            pub fn add_point(&mut self, resource: Option<$handle>) {
                self.inner.add_point(resource.map(|r| r.to_raw()));
            }

            pub fn add_linestring(&mut self, resource: Option<$handle>) {
                self.inner.add_linestring(resource.map(|r| r.to_raw()));
            }

            pub fn add_surface(&mut self, resource: Option<$handle>) {
                self.inner.add_surface(resource.map(|r| r.to_raw()));
            }

            pub fn points(&self) -> &[Option<$handle>] {
                crate::resources::handles::cast_option_handle_slice::<$handle>(self.inner.points())
            }

            pub fn linestrings(&self) -> &[Option<$handle>] {
                crate::resources::handles::cast_option_handle_slice::<$handle>(
                    self.inner.linestrings(),
                )
            }

            pub fn surfaces(&self) -> &[Option<$handle>] {
                crate::resources::handles::cast_option_handle_slice::<$handle>(
                    self.inner.surfaces(),
                )
            }

            pub fn check_type(&self) -> crate::v2_0::boundary::BoundaryType {
                self.inner.check_type()
            }

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

            #[allow(dead_code)]
            pub(crate) fn into_raw(
                self,
            ) -> crate::resources::mapping::SemanticOrMaterialMap<
                VR,
                crate::resources::id::ResourceId32,
            > {
                self.inner
            }

            #[allow(dead_code)]
            pub(crate) fn to_raw(
                &self,
            ) -> &crate::resources::mapping::SemanticOrMaterialMap<
                VR,
                crate::resources::id::ResourceId32,
            > {
                &self.inner
            }
        }
    };
}

pub(crate) use define_typed_resource_map;

// ---------------------------------------------------------------------------
// Unit tests for SemanticOrMaterialMap
// Family 5: semantic/material map shape
// Family 6: map check_type() correctness
// ---------------------------------------------------------------------------

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

    type Map = SemanticOrMaterialMap<u32, ResourceId32>;

    fn make_surface_map() -> Map {
        let mut m = Map::new();
        m.add_surface(Some(ResourceId32::new(0, 0)));
        m.add_surface(Some(ResourceId32::new(1, 0)));
        m.add_surface(None);
        m
    }

    // -----------------------------------------------------------------------
    // Family 5: map has correct bucket counts
    // -----------------------------------------------------------------------

    #[test]
    fn surface_map_surfaces_bucket_has_correct_length() {
        let m = make_surface_map();
        assert_eq!(m.surfaces().len(), 3, "one entry per surface");
        assert!(m.points().is_empty());
        assert!(m.linestrings().is_empty());
    }

    #[test]
    fn point_map_points_bucket_has_correct_length() {
        let mut m = Map::new();
        m.add_point(Some(ResourceId32::new(0, 0)));
        m.add_point(None);
        assert_eq!(m.points().len(), 2);
        assert!(m.linestrings().is_empty());
        assert!(m.surfaces().is_empty());
    }

    #[test]
    fn linestring_map_linestrings_bucket_has_correct_length() {
        let mut m = Map::new();
        m.add_linestring(None);
        m.add_linestring(Some(ResourceId32::new(7, 0)));
        assert_eq!(m.linestrings().len(), 2);
        assert!(m.points().is_empty());
        assert!(m.surfaces().is_empty());
    }

    #[test]
    fn none_entries_are_preserved() {
        let m = make_surface_map();
        assert!(m.surfaces()[2].is_none(), "None entry must be preserved");
    }

    // -----------------------------------------------------------------------
    // Family 6: check_type() correctness
    // -----------------------------------------------------------------------

    #[test]
    fn empty_map_check_type_is_none() {
        let m = Map::new();
        assert_eq!(m.check_type(), BoundaryType::None);
    }

    #[test]
    fn surface_only_map_check_type_is_multi_or_composite_surface() {
        let m = make_surface_map();
        assert_eq!(m.check_type(), BoundaryType::MultiOrCompositeSurface);
    }

    #[test]
    fn point_only_map_check_type_is_multi_point() {
        let mut m = Map::new();
        m.add_point(None);
        assert_eq!(m.check_type(), BoundaryType::MultiPoint);
    }

    #[test]
    fn linestring_only_map_check_type_is_multi_linestring() {
        let mut m = Map::new();
        m.add_linestring(None);
        assert_eq!(m.check_type(), BoundaryType::MultiLineString);
    }
}