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

//! `CityJSON` v2.0 types.
//!
//! The types map directly to the [CityJSON 2.0 spec](https://www.cityjson.org/specs/2.0.1/).
//!
//! | Spec concept | Rust type |
//! |---|---|
//! | Root `CityJSON` object | [`CityModel`] |
//! | `CityObjects` map entry | [`CityObject`] |
//! | Geometry (stored) | [`Geometry`] |
//! | Geometry (authoring) | [`GeometryDraft`] |
//! | Semantic surface | [`Semantic`], [`SemanticType`] |
//! | Material / Texture resource | [`Material`], [`Texture`] (registered in model pools) |
//! | Appearance assignment | [`MaterialMap`], [`TextureMap`] (per geometry, per theme) |
//! | Coordinate transform | [`Transform`] |
//! | Metadata | [`Metadata`] |
//!
//! ## Differences from the JSON representation
//!
//! - **Coordinates are floats, not integers.** The `transform` object (spec §4) is a
//!   serialization concern. Internally all vertices are `f64` real-world coordinates.
//! - **Boundaries are flat.** The nested JSON arrays (spec §3.2) are stored as flat `Vec`s
//!   with offset counters. Use `Boundary::to_nested_*` or the [`raw`](crate::raw) module to
//!   recover the nested form for serialization.
//! - **Resources live in model-level pools.** Semantics, materials, and textures are stored
//!   once on [`CityModel`] and referenced by typed handles ([`SemanticHandle`],
//!   [`MaterialHandle`], [`TextureHandle`]).
//! - **Geometry authoring has a checked draft layer and a raw stored layer.**
//!   [`GeometryDraft`] accepts raw coordinates, deduplicates vertices, validates the geometry,
//!   and then inserts through the unchecked raw path. For trusted flat input, use
//!   [`geometry::StoredGeometryParts`] with [`Geometry::from_stored_parts`].
//!
//! ## Imports
//!
//! ```rust
//! use cityjson::v2_0::*;     // all domain types
//! use cityjson::prelude::*;  // handles, storage strategies, error types
//! ```
//!
//! [`SemanticHandle`]: crate::resources::handles::SemanticHandle
//! [`MaterialHandle`]: crate::resources::handles::MaterialHandle
//! [`TextureHandle`]: crate::resources::handles::TextureHandle
//! [`MaterialMap`]: crate::resources::mapping::materials::MaterialMap
//! [`TextureMap`]: crate::resources::mapping::textures::TextureMap
pub use crate::resources::mapping::{MaterialMap, SemanticMap, TextureMap};
pub use crate::{CityJSONVersion, CityModelType};

pub mod appearance;
pub mod attributes {
    pub use crate::cityjson::core::attributes::{
        AttributeValue, Attributes, BorrowedAttributeValue, BorrowedAttributes,
        OwnedAttributeValue, OwnedAttributes,
    };
}
pub mod boundary {
    pub use crate::cityjson::core::boundary::nested;
    pub use crate::cityjson::core::boundary::{
        Boundary, Boundary16, Boundary32, Boundary64, BoundaryCoordinates, BoundaryType,
        BoundaryUniqueCoordinates,
    };
}
pub mod citymodel;
pub mod cityobject;
pub mod coordinate {
    pub use crate::cityjson::core::coordinate::{Coordinate, RealWorldCoordinate, UVCoordinate};
}
pub mod extension;
pub mod geometry;
pub mod geometry_draft;
pub mod metadata;
pub mod transform;
pub mod vertex {
    pub use crate::cityjson::core::vertex::{
        RawVertexView, VertexIndex, VertexIndex16, VertexIndex32, VertexIndex64, VertexIndexVec,
        VertexIndicesSequence, VertexRef,
    };
}
pub mod vertices {
    pub use crate::cityjson::core::vertices::{
        GeometryVertices16, GeometryVertices32, GeometryVertices64, UVVertices16, UVVertices32,
        UVVertices64, Vertices,
    };
}

pub use appearance::{
    ImageType, RGB, RGBA, TextureType, ThemeName, WrapMode,
    material::{BorrowedMaterial, Material, OwnedMaterial},
    texture::{BorrowedTexture, OwnedTexture, Texture},
};
pub use attributes::{
    AttributeValue, Attributes, BorrowedAttributeValue, BorrowedAttributes, OwnedAttributeValue,
    OwnedAttributes,
};
pub use boundary::{
    Boundary, Boundary16, Boundary32, Boundary64, BoundaryCoordinates, BoundaryType,
    BoundaryUniqueCoordinates,
    nested::{
        BoundaryNestedMultiLineString, BoundaryNestedMultiLineString16,
        BoundaryNestedMultiLineString32, BoundaryNestedMultiLineString64,
        BoundaryNestedMultiOrCompositeSolid, BoundaryNestedMultiOrCompositeSolid16,
        BoundaryNestedMultiOrCompositeSolid32, BoundaryNestedMultiOrCompositeSolid64,
        BoundaryNestedMultiOrCompositeSurface, BoundaryNestedMultiOrCompositeSurface16,
        BoundaryNestedMultiOrCompositeSurface32, BoundaryNestedMultiOrCompositeSurface64,
        BoundaryNestedMultiPoint, BoundaryNestedMultiPoint16, BoundaryNestedMultiPoint32,
        BoundaryNestedMultiPoint64, BoundaryNestedSolid, BoundaryNestedSolid16,
        BoundaryNestedSolid32, BoundaryNestedSolid64,
    },
};
pub use citymodel::{BorrowedCityModel, CityModel, CityModelCapacities, OwnedCityModel};
pub use cityobject::{
    BorrowedCityObjects, CityObject, CityObjectIdentifier, CityObjectType, CityObjects,
    OwnedCityObjects,
};
pub use coordinate::{Coordinate, RealWorldCoordinate, UVCoordinate};
pub use extension::{Extension, Extensions};
pub use geometry::{
    AffineTransform3D, Geometry, GeometryInstanceView, GeometryType, GeometryView, LoD,
    StoredGeometryInstance, StoredGeometryParts,
    semantic::{BorrowedSemantic, OwnedSemantic, Semantic, SemanticType},
};
pub use geometry_draft::{
    GeometryDraft, LineStringDraft, PointDraft, RingDraft, ShellDraft, SolidDraft, SurfaceDraft,
    UvDraft, VertexDraft,
};
pub use metadata::{
    BBox, CRS, CityModelIdentifier, Contact, ContactRole, ContactType, Date, Metadata,
};
pub use transform::Transform;
pub use vertex::{
    RawVertexView, VertexIndex, VertexIndex16, VertexIndex32, VertexIndex64, VertexIndexVec,
    VertexIndicesSequence, VertexRef,
};
pub use vertices::{
    GeometryVertices16, GeometryVertices32, GeometryVertices64, UVVertices16, UVVertices32,
    UVVertices64, Vertices,
};