ifc-lite-processing 4.1.0

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

//! Shared response types for the IFC processing API.

use super::mesh::MeshData;
use crate::georeferencing::Georeferencing;
use crate::symbolic::SymbolicData;
use serde::{Deserialize, Serialize};

/// Full parse response with all meshes.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ParseResponse {
    /// Cache key for this result (SHA256 of file content).
    pub cache_key: String,
    /// All meshes extracted from the IFC file.
    pub meshes: Vec<MeshData>,
    /// Declares the coordinate space used by serialized mesh vertices:
    /// * `site_local` — vertices are relative to the IfcSite placement
    ///   translation (small floats in a meaningful, relatable frame).
    /// * `model_rtc`  — a model-level detected RTC anchor was subtracted.
    /// * `raw_ifc`    — no RTC anchor was applied; vertices are in raw IFC space.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mesh_coordinate_space: Option<String>,
    /// IfcSite ObjectPlacement as a column-major 4x4 matrix (16 f64 values, in meters).
    /// Used by clients to relocate geometry between global and site-local coordinate systems.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub site_transform: Option<Vec<f64>>,
    /// IfcBuilding ObjectPlacement as a column-major 4x4 matrix (16 f64 values, in meters).
    /// Used by clients to relocate geometry between global and building-local coordinate systems.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub building_transform: Option<Vec<f64>>,
    /// Model metadata.
    pub metadata: ModelMetadata,
    /// Processing statistics.
    pub stats: ProcessingStats,
    /// 2D symbol data extracted from `IfcAnnotation` and `IfcGrid`
    /// entities. Always emitted (potentially empty); see issue #843 for
    /// the parity rationale with the browser-side parser.
    #[serde(default, skip_serializing_if = "SymbolicData::is_empty")]
    pub symbolic_data: SymbolicData,
}

/// Model metadata extracted from the IFC file.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ModelMetadata {
    /// IFC schema version (e.g., "IFC2X3", "IFC4", "IFC4X3").
    pub schema_version: String,
    /// Total number of entities in the file.
    pub entity_count: usize,
    /// Number of geometry-bearing entities.
    pub geometry_entity_count: usize,
    /// Coordinate system information.
    pub coordinate_info: CoordinateInfo,
    /// Length unit scale to convert model length values to metres (e.g. `0.001`
    /// for millimetres). `None` when not yet computed; consumers treat it as
    /// `1.0`. Brings the server to parity with the browser parser's
    /// `extractLengthUnitScale` (issue #900).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub length_unit_scale: Option<f64>,
    /// Georeferencing (`IfcMapConversion` + `IfcProjectedCRS`). `None` when the
    /// model carries no map-conversion data. Mirrors the browser parser's
    /// `extractGeoreferencing` (issue #900).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub georeferencing: Option<Georeferencing>,
}

/// Coordinate system information.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CoordinateInfo {
    /// Origin shift applied to coordinates (for RTC rendering).
    pub origin_shift: [f64; 3],
    /// Whether the model is geo-referenced.
    pub is_geo_referenced: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct QuickMetadataEntitySummary {
    pub express_id: u32,
    pub type_name: String,
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub global_id: Option<String>,
    pub kind: String,
    pub has_children: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub element_count: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub elevation: Option<f64>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct QuickMetadataSpatialNode {
    #[serde(flatten)]
    pub summary: QuickMetadataEntitySummary,
    pub children: Vec<QuickMetadataSpatialNode>,
    pub elements: Vec<QuickMetadataEntitySummary>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct QuickMetadataBootstrap {
    pub schema_version: String,
    pub entity_count: usize,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub spatial_tree: Option<QuickMetadataSpatialNode>,
}

/// Processing statistics.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProcessingStats {
    /// Total number of meshes generated.
    pub total_meshes: usize,
    /// Total number of vertices.
    pub total_vertices: usize,
    /// Total number of triangles.
    pub total_triangles: usize,
    /// Time spent parsing entities (ms).
    pub parse_time_ms: u64,
    /// Time spent scanning entities and building initial job lists (ms).
    pub entity_scan_time_ms: u64,
    /// Time spent resolving lookups, styles, and optional metadata (ms).
    pub lookup_time_ms: u64,
    /// Time spent in geometry preprocessing before the extraction loop begins (ms).
    pub preprocess_time_ms: u64,
    /// Time spent processing geometry (ms).
    pub geometry_time_ms: u64,
    /// Total processing time (ms).
    pub total_time_ms: u64,
    /// Whether result was from cache.
    pub from_cache: bool,
    /// Total CSG boolean failures recorded during geometry extraction
    /// (mirrors the browser console diagnostics — see `BoolFailureReason`).
    #[serde(default)]
    pub total_csg_failures: u64,
    /// Number of distinct products with at least one CSG failure.
    #[serde(default)]
    pub products_with_failures: u64,
}