bherbruckandClaude Opus 5.5
e67cc0c747
The Flatpak app id, desktop/metainfo/MIME file names, icon name and the window's Wayland app_id / X11 class are now ai.storyteller.solidcraft, the id the ArtCraft launcher expects. Existing Flatpak installs move over: the Pages repo marks app/ai.storyteller.solvecraft end-of-life with a rebase to the new id, so flatpak update offers the switch and Flatpak carries ~/.var/app along. A new install next to the old one copies settings and autosaves on first launch through a read-only grant on the old data folder. The metainfo declares <replaces>/<provides>, the desktop entry X-Flatpak-RenamedFrom, and AppImages drop the menu entry an older AppImage installed. deb/rpm upgrades remove the old-named files. Co-Authored-By: Claude Opus 5.5 <[email protected]>
685 lines
30 KiB
Rust
685 lines
30 KiB
Rust
//! File formats. Designs use JSON or versioned containers (`.solidcraft`); the authoritative
|
|
//! document rebuilds on load and optional display caches remain provisional. Bodies export
|
|
//! as STL (binary or ASCII), OBJ, STEP and 3MF; STEP
|
|
//! files import as a base feature (see [`step_import_feature`]), 3MF and STL files as mesh bodies
|
|
//! (see [`mesh_import_feature`]).
|
|
#![deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable)]
|
|
#![forbid(unsafe_code)]
|
|
|
|
mod design;
|
|
mod design_metadata;
|
|
mod dxf;
|
|
pub use design::{
|
|
DesignCompression, DesignContainerReader, DesignGeometry, DesignPreview, THUMBNAIL_SIZE, is_design_container, read_design_file,
|
|
read_design_geometry, read_design_preview, read_design_thumbnail, read_design_thumbnail_file, write_design_container,
|
|
write_design_container_with_cache, write_design_container_with_compression, write_design_container_with_preview,
|
|
write_design_container_with_thumbnail,
|
|
};
|
|
mod legacy_dir;
|
|
pub mod safe_write;
|
|
mod sketch2d;
|
|
mod svg;
|
|
mod threemf;
|
|
pub mod vfs;
|
|
|
|
pub use dxf::{read_dxf, write_dxf};
|
|
pub use legacy_dir::{APP_ID, LEGACY_APP_ID, adopt_legacy_dir, legacy_flatpak_path};
|
|
pub use safe_write::{backup_path, write_atomic};
|
|
pub use sketch2d::{Geom2, MAX_DRAWING_BYTES};
|
|
pub use svg::read_svg;
|
|
mod obj;
|
|
pub use obj::read_obj;
|
|
pub use threemf::{MAX_3MF_BYTES, MeshObject, model_xml, read_3mf, weld, write_3mf};
|
|
|
|
use solidcraft_doc::{Document, ModelState};
|
|
use solidcraft_geom::{Mesh, Vec3};
|
|
|
|
/// Design file extension.
|
|
pub const DESIGN_EXT: &str = "solidcraft";
|
|
/// The design extension of earlier releases. Compatibility shim (docs/compatibility.md): such
|
|
/// files still open everywhere a design opens; new designs are saved as [`DESIGN_EXT`].
|
|
pub const LEGACY_DESIGN_EXT: &str = "solvecraft";
|
|
/// Every extension a design file may have, current first.
|
|
pub const DESIGN_EXTS: [&str; 2] = [DESIGN_EXT, LEGACY_DESIGN_EXT];
|
|
|
|
/// Is this a design file name (`.solidcraft`, or the legacy extension), any case?
|
|
pub fn is_design_path(path: &str) -> bool {
|
|
std::path::Path::new(path)
|
|
.extension()
|
|
.and_then(|e| e.to_str())
|
|
.is_some_and(|e| DESIGN_EXTS.iter().chain(["json"].iter()).any(|x| e.eq_ignore_ascii_case(x)))
|
|
}
|
|
/// Largest design file we read.
|
|
pub const MAX_DESIGN_BYTES: usize = 256 << 20;
|
|
|
|
#[derive(Debug, thiserror::Error)]
|
|
pub enum IoError {
|
|
#[error("unsupported format `{0}` (use stl, obj, step, 3mf or solidcraft)")]
|
|
Format(String),
|
|
#[error("nothing to export: the design has no bodies")]
|
|
Empty,
|
|
#[error("{0}")]
|
|
Invalid(String),
|
|
#[error(transparent)]
|
|
Kernel(#[from] solidcraft_kernel::KernelError),
|
|
#[error(transparent)]
|
|
Doc(#[from] solidcraft_doc::DocError),
|
|
}
|
|
|
|
pub type Result<T> = std::result::Result<T, IoError>;
|
|
|
|
/// Largest STEP file we read.
|
|
pub const MAX_STEP_BYTES: usize = 512 << 20;
|
|
|
|
/// Is this a CAD exchange file read as an Import base feature: STEP (`.step` / `.stp`) or IGES
|
|
/// (`.igs` / `.iges`), any case?
|
|
pub fn is_step_path(path: &str) -> bool {
|
|
std::path::Path::new(path)
|
|
.extension()
|
|
.and_then(|e| e.to_str())
|
|
.is_some_and(|e| ["step", "stp", "igs", "iges"].iter().any(|x| e.eq_ignore_ascii_case(x)))
|
|
}
|
|
|
|
/// Is this an IGES file name (`.igs` / `.iges`, any case)?
|
|
pub fn is_iges_path(path: &str) -> bool {
|
|
std::path::Path::new(path).extension().and_then(|e| e.to_str()).is_some_and(|e| e.eq_ignore_ascii_case("igs") || e.eq_ignore_ascii_case("iges"))
|
|
}
|
|
|
|
/// A STEP file read as an import feature.
|
|
pub struct StepFeature {
|
|
/// Timeline name: the root product's name, else the file name.
|
|
pub name: String,
|
|
pub kind: solidcraft_doc::FeatureKind,
|
|
/// Body names from the file (solid names, else product names).
|
|
pub body_names: Vec<String>,
|
|
pub warnings: Vec<String>,
|
|
}
|
|
|
|
/// Read STEP bytes (`file` is the source file name) into an Import base feature. The file is
|
|
/// read once here to fail early and collect names; the feature holds the STEP text.
|
|
pub fn step_import_feature(bytes: &[u8], file: &str) -> Result<StepFeature> {
|
|
if bytes.len() > MAX_STEP_BYTES {
|
|
return Err(IoError::Invalid(format!("STEP file too large ({} MB, limit {} MB)", bytes.len() >> 20, MAX_STEP_BYTES >> 20)));
|
|
}
|
|
// STEP is 7-bit text with escapes; tolerate stray 8-bit bytes. IGES is restated as STEP
|
|
// (the feature keeps that STEP text).
|
|
let text = String::from_utf8_lossy(bytes).into_owned();
|
|
let (text, iges_warnings) =
|
|
if is_iges_path(file) { solidcraft_kernel::iges_to_step(&text).map_err(IoError::Invalid)? } else { (text, Vec::new()) };
|
|
let imp = solidcraft_kernel::step_import_shared(&text)?;
|
|
let stem = std::path::Path::new(file)
|
|
.file_stem()
|
|
.map(|s| s.to_string_lossy().to_string())
|
|
.filter(|s| !s.trim().is_empty())
|
|
.unwrap_or_else(|| "Import".into());
|
|
let generic = |n: &str| n.trim().is_empty() || n.starts_with('(') || n.eq_ignore_ascii_case("import") || n.eq_ignore_ascii_case("unnamed");
|
|
// The root product's name; else the only body's name; else the file name.
|
|
let name = match (imp.tree.as_slice(), imp.bodies.as_slice()) {
|
|
([root], _) if !generic(&root.name) => root.name.clone(),
|
|
(_, [only]) if !generic(&only.name) => only.name.clone(),
|
|
_ => stem,
|
|
};
|
|
let file_name = std::path::Path::new(file).file_name().map(|s| s.to_string_lossy().to_string()).unwrap_or_else(|| file.to_string());
|
|
Ok(StepFeature {
|
|
name,
|
|
body_names: imp.bodies.iter().map(|b| b.name.clone()).collect(),
|
|
kind: solidcraft_doc::FeatureKind::Import { file: file_name, step: text, components: imp.tree.clone() },
|
|
warnings: iges_warnings.into_iter().chain(imp.warnings.iter().cloned()).collect(),
|
|
})
|
|
}
|
|
|
|
/// Is this a mesh file we import (`.3mf`, `.stl`, `.obj`, any case)?
|
|
pub fn is_mesh_path(path: &str) -> bool {
|
|
std::path::Path::new(path).extension().and_then(|e| e.to_str()).is_some_and(|e| ["3mf", "stl", "obj"].iter().any(|x| e.eq_ignore_ascii_case(x)))
|
|
}
|
|
|
|
/// A 3MF, STL or OBJ file read as a mesh import feature.
|
|
pub struct MeshFeature {
|
|
/// Timeline name: the only mesh's name, else the file name.
|
|
pub name: String,
|
|
pub kind: solidcraft_doc::FeatureKind,
|
|
pub body_names: Vec<String>,
|
|
pub warnings: Vec<String>,
|
|
}
|
|
|
|
/// Read 3MF, STL or OBJ bytes (the format from `file`'s extension) into a MeshImport feature.
|
|
pub fn mesh_import_feature(bytes: &[u8], file: &str) -> Result<MeshFeature> {
|
|
if bytes.len() > MAX_3MF_BYTES {
|
|
return Err(IoError::Invalid(format!("mesh file too large ({} MB)", bytes.len() >> 20)));
|
|
}
|
|
let path = std::path::Path::new(file);
|
|
let stem = path.file_stem().map(|s| s.to_string_lossy().to_string()).filter(|s| !s.trim().is_empty()).unwrap_or_else(|| "Mesh".into());
|
|
let ext = path.extension().and_then(|e| e.to_str()).unwrap_or("").to_ascii_lowercase();
|
|
let (objects, warnings) = if ext == "obj" {
|
|
obj::read_obj(bytes, &stem)?
|
|
} else if ext == "stl" {
|
|
let tris = read_stl(bytes)?;
|
|
if tris.is_empty() {
|
|
return Err(IoError::Invalid("STL has no triangles".into()));
|
|
}
|
|
let positions: Vec<Vec3> = tris.iter().flatten().map(|v| Vec3::new(v[0] as f64, v[1] as f64, v[2] as f64)).collect();
|
|
let n = u32::try_from(tris.len()).map_err(|_| IoError::Invalid("STL too large".into()))?;
|
|
let triangles = (0..n).map(|i| [i * 3, i * 3 + 1, i * 3 + 2]).collect();
|
|
(vec![MeshObject { name: stem.clone(), positions, triangles, ..Default::default() }], Vec::new())
|
|
} else {
|
|
read_3mf(bytes)?
|
|
};
|
|
// Check every mesh now, so the command fails rather than the timeline.
|
|
let mut meshes = Vec::with_capacity(objects.len());
|
|
for o in &objects {
|
|
solidcraft_kernel::mesh_body(&o.positions, &o.triangles).map_err(|e| IoError::Invalid(format!("mesh `{}`: {e}", o.name)))?;
|
|
meshes.push(solidcraft_doc::MeshData {
|
|
name: o.name.clone(),
|
|
positions: o.positions.iter().flat_map(|p| [p.x, p.y, p.z]).collect(),
|
|
triangles: o.triangles.iter().flatten().copied().collect(),
|
|
color: o.color,
|
|
});
|
|
}
|
|
let name = match objects.as_slice() {
|
|
[only] if !only.name.trim().is_empty() => only.name.clone(),
|
|
_ => stem,
|
|
};
|
|
let file_name = path.file_name().map(|s| s.to_string_lossy().to_string()).unwrap_or_else(|| file.to_string());
|
|
Ok(MeshFeature {
|
|
name,
|
|
body_names: objects.iter().map(|o| o.name.clone()).collect(),
|
|
kind: solidcraft_doc::FeatureKind::MeshImport { file: file_name, meshes },
|
|
warnings,
|
|
})
|
|
}
|
|
|
|
/// Export formats.
|
|
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
|
pub enum Format {
|
|
StlBinary,
|
|
StlAscii,
|
|
Obj,
|
|
Step,
|
|
Iges,
|
|
ThreeMf,
|
|
Design,
|
|
}
|
|
|
|
impl Format {
|
|
/// From a file name or extension (`part.stl`, `step`, `stp`…).
|
|
pub fn from_name(name: &str) -> Result<Format> {
|
|
let ext = name.rsplit('.').next().unwrap_or(name).to_ascii_lowercase();
|
|
Ok(match ext.as_str() {
|
|
"stl" => Format::StlBinary,
|
|
"stla" | "stl-ascii" => Format::StlAscii,
|
|
"obj" => Format::Obj,
|
|
"step" | "stp" => Format::Step,
|
|
"igs" | "iges" => Format::Iges,
|
|
"3mf" => Format::ThreeMf,
|
|
"solidcraft" | "solvecraft" | "json" => Format::Design,
|
|
_ => return Err(IoError::Format(ext)),
|
|
})
|
|
}
|
|
}
|
|
|
|
/// Fine export mesh for a body (chord tolerance 2e-4 of its size).
|
|
pub fn export_mesh(b: &solidcraft_kernel::Body) -> Result<Mesh> {
|
|
Ok(b.tessellate((b.size() * 2e-4).max(1e-3))?)
|
|
}
|
|
|
|
/// Binary STL of several meshes (one solid).
|
|
pub fn stl_binary(meshes: &[Mesh], name: &str) -> Vec<u8> {
|
|
let n: usize = meshes.iter().map(|m| m.triangles.len()).sum();
|
|
let mut out = Vec::with_capacity(84 + n * 50);
|
|
let mut header = format!("SolidCraft STL {name}").into_bytes();
|
|
header.resize(80, b' ');
|
|
out.extend_from_slice(&header);
|
|
out.extend_from_slice(&u32::try_from(n).unwrap_or(u32::MAX).to_le_bytes());
|
|
for m in meshes {
|
|
for t in &m.triangles {
|
|
let Some([a, b, c]) = m.tri(t) else { continue };
|
|
let nrm = (b - a).cross(c - a).normalized().unwrap_or_default();
|
|
for v in [nrm, a, b, c] {
|
|
for x in v.to_f32() {
|
|
out.extend_from_slice(&x.to_le_bytes());
|
|
}
|
|
}
|
|
out.extend_from_slice(&[0, 0]);
|
|
}
|
|
}
|
|
out
|
|
}
|
|
|
|
/// ASCII STL.
|
|
pub fn stl_ascii(meshes: &[Mesh], name: &str) -> String {
|
|
let name: String = name.chars().filter(|c| c.is_ascii_graphic()).collect();
|
|
let mut s = format!("solid {name}\n");
|
|
for m in meshes {
|
|
for t in &m.triangles {
|
|
let Some([a, b, c]) = m.tri(t) else { continue };
|
|
let n = (b - a).cross(c - a).normalized().unwrap_or_default();
|
|
s += &format!(" facet normal {:e} {:e} {:e}\n outer loop\n", n.x, n.y, n.z);
|
|
for v in [a, b, c] {
|
|
s += &format!(" vertex {:e} {:e} {:e}\n", v.x, v.y, v.z);
|
|
}
|
|
s += " endloop\n endfacet\n";
|
|
}
|
|
}
|
|
s += &format!("endsolid {name}\n");
|
|
s
|
|
}
|
|
|
|
/// Wavefront OBJ, one object per body.
|
|
pub fn obj(meshes: &[(String, Mesh)]) -> String {
|
|
let mut s = String::from("# SolidCraft OBJ export (mm)\n");
|
|
let mut base = 1usize;
|
|
for (name, m) in meshes {
|
|
s += &format!("o {}\n", name.replace(char::is_whitespace, "_"));
|
|
for p in &m.positions {
|
|
s += &format!("v {} {} {}\n", p.x, p.y, p.z);
|
|
}
|
|
for n in &m.normals {
|
|
s += &format!("vn {} {} {}\n", n.x, n.y, n.z);
|
|
}
|
|
for t in &m.triangles {
|
|
let [a, b, c] = t.map(|i| i as usize + base);
|
|
s += &format!("f {a}//{a} {b}//{b} {c}//{c}\n");
|
|
}
|
|
base += m.positions.len();
|
|
}
|
|
s
|
|
}
|
|
|
|
/// Export the given bodies of a model (all when `bodies` is empty) in a format.
|
|
pub fn export(state: &ModelState, bodies: &[String], format: Format, name: &str) -> Result<Vec<u8>> {
|
|
let sel: Vec<&solidcraft_doc::ModelBody> = state.bodies.iter().filter(|b| bodies.is_empty() || bodies.contains(&b.name)).collect();
|
|
if sel.is_empty() {
|
|
return Err(IoError::Empty);
|
|
}
|
|
Ok(match format {
|
|
Format::StlBinary | Format::StlAscii | Format::Obj => {
|
|
let meshes: Vec<(String, Mesh)> = sel.iter().map(|b| Ok((b.name.clone(), export_mesh(&b.body)?))).collect::<Result<_>>()?;
|
|
match format {
|
|
Format::StlBinary => stl_binary(&meshes.into_iter().map(|(_, m)| m).collect::<Vec<_>>(), name),
|
|
Format::StlAscii => stl_ascii(&meshes.into_iter().map(|(_, m)| m).collect::<Vec<_>>(), name).into_bytes(),
|
|
_ => obj(&meshes).into_bytes(),
|
|
}
|
|
}
|
|
Format::Step => {
|
|
let bs: Vec<solidcraft_kernel::ExportBody> =
|
|
sel.iter().map(|b| solidcraft_kernel::ExportBody { name: b.name.clone(), body: &b.body, color: b.body.color() }).collect();
|
|
let header = solidcraft_kernel::StepHeader { file_name: format!("{name}.step"), ..Default::default() };
|
|
solidcraft_kernel::step_export_bodies(&bs, &header)?.into_bytes()
|
|
}
|
|
Format::Iges => {
|
|
let bs: Vec<solidcraft_kernel::ExportBody> =
|
|
sel.iter().map(|b| solidcraft_kernel::ExportBody { name: b.name.clone(), body: &b.body, color: b.body.color() }).collect();
|
|
let header = solidcraft_kernel::StepHeader { file_name: format!("{name}.igs"), ..Default::default() };
|
|
solidcraft_kernel::iges_export_bodies(&bs, &header)?.into_bytes()
|
|
}
|
|
Format::ThreeMf => {
|
|
let objs: Vec<MeshObject> = sel
|
|
.iter()
|
|
.map(|b| {
|
|
let m = export_mesh(&b.body)?;
|
|
let eps = (b.body.size() * 1e-6).max(1e-7);
|
|
// Faces with colours of their own tag their triangles.
|
|
let paint = b.body.paint();
|
|
let mut looks = Vec::new();
|
|
let mut by_face = std::collections::HashMap::new();
|
|
for f in paint.map(|p| p.faces.as_slice()).unwrap_or_default() {
|
|
looks.push((f.color, 1.0 - f.opacity));
|
|
by_face.insert(f.face, looks.len() as u32);
|
|
}
|
|
let tags: Vec<u32> = m.tri_face.iter().map(|f| by_face.get(&(*f as usize)).copied().unwrap_or(0)).collect();
|
|
let (positions, triangles, tri_looks) = threemf::weld_tagged(&m.positions, &m.triangles, &tags, eps);
|
|
let tri_looks = if looks.is_empty() { Vec::new() } else { tri_looks };
|
|
let transparency = 1.0 - paint.map(|p| p.opacity).unwrap_or(1.0);
|
|
Ok(MeshObject { name: b.name.clone(), positions, triangles, color: b.body.color(), transparency, looks, tri_looks })
|
|
})
|
|
.collect::<Result<_>>()?;
|
|
write_3mf(&objs)?
|
|
}
|
|
Format::Design => return Err(IoError::Format("solidcraft (save the document instead)".into())),
|
|
})
|
|
}
|
|
|
|
/// STEP assembly of a design with components: a product per component holding its bodies in
|
|
/// the component's own frame (`local` is the model before placing occurrences), and an
|
|
/// assembly occurrence per component occurrence.
|
|
pub fn step_assembly(doc: &Document, local: &ModelState, name: &str) -> Result<Vec<u8>> {
|
|
use solidcraft_kernel::{ExportBody, ExportProduct};
|
|
let mut index: std::collections::HashMap<u64, usize> = std::collections::HashMap::new();
|
|
index.insert(0, 0);
|
|
let mut products = vec![ExportProduct { name: doc.name.clone(), bodies: Vec::new(), children: Vec::new() }];
|
|
for c in &doc.components {
|
|
index.insert(c.id, products.len());
|
|
products.push(ExportProduct { name: c.name.clone(), bodies: Vec::new(), children: Vec::new() });
|
|
}
|
|
for b in &local.bodies {
|
|
let comp = doc.body_component(&b.name, b.feature);
|
|
let Some(p) = index.get(&comp).and_then(|i| products.get_mut(*i)) else { continue };
|
|
p.bodies.push(ExportBody { name: b.name.clone(), body: &b.body, color: b.body.color() });
|
|
}
|
|
for o in &doc.occurrences {
|
|
let (Some(&parent), Some(&child)) = (index.get(&o.parent), index.get(&o.component)) else { continue };
|
|
if let Some(p) = products.get_mut(parent) {
|
|
p.children.push((child, o.transform, o.name.clone()));
|
|
}
|
|
}
|
|
let header = solidcraft_kernel::StepHeader { file_name: format!("{name}.step"), ..Default::default() };
|
|
Ok(solidcraft_kernel::step_export_products(&products, 0, &header)?.into_bytes())
|
|
}
|
|
|
|
/// Read a design file's bytes.
|
|
pub fn read_design(bytes: &[u8]) -> Result<Document> {
|
|
if bytes.len() > MAX_DESIGN_BYTES {
|
|
return Err(IoError::Invalid("design file too large".into()));
|
|
}
|
|
if is_design_container(bytes) {
|
|
return design::read(bytes);
|
|
}
|
|
let s = std::str::from_utf8(bytes).map_err(|_| IoError::Invalid("design file is not UTF-8 JSON".into()))?;
|
|
Ok(Document::from_json(s)?)
|
|
}
|
|
|
|
/// Design file bytes.
|
|
pub fn write_design(doc: &Document) -> Vec<u8> {
|
|
doc.to_json().into_bytes()
|
|
}
|
|
|
|
/// Parse a binary or ASCII STL (used by tests and round-trip checks): triangles.
|
|
pub fn read_stl(bytes: &[u8]) -> Result<Vec<[[f32; 3]; 3]>> {
|
|
// Binary when the size matches the triangle count in the header (some binary files start
|
|
// with "solid" too); ASCII when the text has facets.
|
|
let count = bytes.get(80..84).map(|b| u32::from_le_bytes([b[0], b[1], b[2], b[3]]) as usize);
|
|
let binary_size = count.is_some_and(|n| bytes.len() == 84 + n.saturating_mul(50));
|
|
let head = String::from_utf8_lossy(bytes.get(..bytes.len().min(512)).unwrap_or_default()).to_string();
|
|
let ascii = !binary_size && head.trim_start().starts_with("solid") && String::from_utf8_lossy(bytes).contains("facet");
|
|
let mut tris = Vec::new();
|
|
let ok = |v: &[f32; 3]| v.iter().all(|x| x.is_finite() && x.abs() < 1e9);
|
|
if ascii {
|
|
let s = String::from_utf8_lossy(bytes);
|
|
let mut cur: Vec<[f32; 3]> = Vec::new();
|
|
for l in s.lines() {
|
|
let mut it = l.split_whitespace();
|
|
match it.next() {
|
|
Some("vertex") => {
|
|
let v: Vec<f32> = it.filter_map(|x| x.parse().ok()).collect();
|
|
if let [x, y, z] = v[..] {
|
|
cur.push([x, y, z]);
|
|
}
|
|
}
|
|
// Each facet takes exactly its three vertices (a bad vertex drops the facet).
|
|
Some("endfacet") => {
|
|
if let [a, b, c] = cur[..]
|
|
&& [a, b, c].iter().all(ok)
|
|
{
|
|
tris.push([a, b, c]);
|
|
}
|
|
cur.clear();
|
|
}
|
|
_ => {}
|
|
}
|
|
if tris.len() > MAX_STL_TRIANGLES {
|
|
return Err(IoError::Invalid(format!("STL with more than {MAX_STL_TRIANGLES} triangles")));
|
|
}
|
|
}
|
|
return Ok(tris);
|
|
}
|
|
let n = count.ok_or_else(|| IoError::Invalid("short STL".into()))?;
|
|
// A wrong count in the header (some writers leave 0): use the triangles that are there.
|
|
let room = bytes.len().saturating_sub(84) / 50;
|
|
let n = if n == 0 || n > room { room } else { n };
|
|
if n == 0 {
|
|
return Err(IoError::Invalid("STL has no triangles".into()));
|
|
}
|
|
if n > MAX_STL_TRIANGLES {
|
|
return Err(IoError::Invalid(format!("STL with {n} triangles (limit {MAX_STL_TRIANGLES})")));
|
|
}
|
|
let f = |o: usize| bytes.get(o..o + 4).map(|b| f32::from_le_bytes([b[0], b[1], b[2], b[3]])).unwrap_or(f32::NAN);
|
|
tris.reserve(n);
|
|
for i in 0..n {
|
|
// The facet normal (first 12 bytes) is ignored: winding gives the orientation.
|
|
let o = 84 + i * 50 + 12;
|
|
let v = |k: usize| [f(o + k * 12), f(o + k * 12 + 4), f(o + k * 12 + 8)];
|
|
let t = [v(0), v(1), v(2)];
|
|
if t.iter().all(ok) {
|
|
tris.push(t);
|
|
}
|
|
}
|
|
Ok(tris)
|
|
}
|
|
|
|
/// Most triangles we read from one STL file.
|
|
pub const MAX_STL_TRIANGLES: usize = 20_000_000;
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use solidcraft_doc::{FeatureKind, Model, Operation, point_expr};
|
|
use solidcraft_geom::Vec3;
|
|
|
|
fn model() -> (Document, Model) {
|
|
let mut doc = Document::new("t");
|
|
doc.add_feature(
|
|
FeatureKind::Box {
|
|
corner: point_expr(Vec3::ZERO),
|
|
length: "10".into(),
|
|
width: "20".into(),
|
|
height: "30".into(),
|
|
operation: Operation::NewBody,
|
|
},
|
|
None,
|
|
)
|
|
.unwrap();
|
|
let mut m = Model::new();
|
|
m.evaluate(&doc);
|
|
(doc, m)
|
|
}
|
|
|
|
/// A binary STL of a cube's triangles.
|
|
fn cube_stl(flip: &[usize], header: &[u8], count: Option<u32>, normals: [f32; 3]) -> Vec<u8> {
|
|
let c = |i: usize| [(i & 1) as f32 * 10.0, ((i >> 1) & 1) as f32 * 10.0, ((i >> 2) & 1) as f32 * 10.0];
|
|
let quads = [[0, 2, 3, 1], [4, 5, 7, 6], [0, 1, 5, 4], [2, 6, 7, 3], [0, 4, 6, 2], [1, 3, 7, 5]];
|
|
let mut tris = Vec::new();
|
|
for q in quads {
|
|
tris.push([c(q[0]), c(q[1]), c(q[2])]);
|
|
tris.push([c(q[0]), c(q[2]), c(q[3])]);
|
|
}
|
|
for &k in flip {
|
|
tris[k].swap(1, 2);
|
|
}
|
|
let mut b = header.to_vec();
|
|
b.resize(80, b' ');
|
|
b.extend(count.unwrap_or(tris.len() as u32).to_le_bytes());
|
|
for t in &tris {
|
|
for x in normals.iter().chain(t.iter().flatten()) {
|
|
b.extend(x.to_le_bytes());
|
|
}
|
|
b.extend([0, 0]);
|
|
}
|
|
b
|
|
}
|
|
|
|
fn mesh_volume(bytes: &[u8]) -> f64 {
|
|
let f = mesh_import_feature(bytes, "x.stl").unwrap();
|
|
let solidcraft_doc::FeatureKind::MeshImport { meshes, .. } = f.kind else { panic!() };
|
|
let m = &meshes[0];
|
|
let pos: Vec<Vec3> = m.positions.chunks(3).map(|c| Vec3::new(c[0], c[1], c[2])).collect();
|
|
let tris: Vec<[u32; 3]> = m.triangles.chunks(3).map(|c| [c[0], c[1], c[2]]).collect();
|
|
solidcraft_kernel::measure(&solidcraft_kernel::mesh_body(&pos, &tris).unwrap()).unwrap().volume
|
|
}
|
|
|
|
/// STL quirks: a binary header starting with "solid", a zero triangle count, garbage
|
|
/// normals, stray inverted facets and non-finite vertices.
|
|
#[test]
|
|
fn stl_quirks_read_cleanly() {
|
|
let v = mesh_volume(&cube_stl(&[], b"solid exported by something", None, [0.0; 3]));
|
|
assert!((v - 1000.0).abs() < 1e-6, "{v}");
|
|
let v = mesh_volume(&cube_stl(&[], b"x", Some(0), [f32::NAN, 9.0, -7.0]));
|
|
assert!((v - 1000.0).abs() < 1e-6, "{v}");
|
|
let v = mesh_volume(&cube_stl(&[1, 4, 7], b"x", None, [1.0, 0.0, 0.0]));
|
|
assert!((v - 1000.0).abs() < 1e-6, "flipped facets: {v}");
|
|
let mut bad = cube_stl(&[], b"x", None, [0.0; 3]);
|
|
bad[84 + 12..84 + 16].copy_from_slice(&f32::INFINITY.to_le_bytes());
|
|
assert_eq!(read_stl(&bad).unwrap().len(), 11);
|
|
// ASCII with a non-UTF-8 name and a facet with a bad vertex.
|
|
let mut ascii = b"solid caf\xe9\n".to_vec();
|
|
ascii.extend(b"facet normal 0 0 1\nouter loop\nvertex 0 0 0\nvertex 1 0 0\nvertex 0 1 0\nendloop\nendfacet\n");
|
|
ascii.extend(b"facet normal 0 0 1\nouter loop\nvertex 0 0 0\nvertex nan 0 0\nvertex 0 1 0\nendloop\nendfacet\nendsolid\n");
|
|
assert_eq!(read_stl(&ascii).unwrap().len(), 1);
|
|
for b in [&b""[..], b"solid", &[0u8; 83], &[0xff; 200], &cube_stl(&[], b"x", Some(u32::MAX), [0.0; 3])[..]] {
|
|
let r = std::panic::catch_unwind(|| read_stl(b).map(|t| t.len()));
|
|
assert!(r.is_ok());
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn stl_round_trip_volume() {
|
|
let (_, m) = model();
|
|
let bytes = export(&m.state(), &[], Format::StlBinary, "t").unwrap();
|
|
let tris = read_stl(&bytes).unwrap();
|
|
let v: f64 = tris
|
|
.iter()
|
|
.map(|t| {
|
|
let p = |k: usize| Vec3::new(t[k][0] as f64, t[k][1] as f64, t[k][2] as f64);
|
|
p(0).dot(p(1).cross(p(2))) / 6.0
|
|
})
|
|
.sum();
|
|
assert!((v - 6000.0).abs() < 1e-2, "{v}");
|
|
let a = export(&m.state(), &[], Format::StlAscii, "t").unwrap();
|
|
assert_eq!(read_stl(&a).unwrap().len(), tris.len());
|
|
let o = String::from_utf8(export(&m.state(), &[], Format::Obj, "t").unwrap()).unwrap();
|
|
assert!(o.contains("o Body1") && o.contains("\nf "));
|
|
}
|
|
|
|
#[test]
|
|
fn step_and_design() {
|
|
let (doc, m) = model();
|
|
let s = String::from_utf8(export(&m.state(), &[], Format::Step, "t").unwrap()).unwrap();
|
|
assert!(s.starts_with("ISO-10303-21;") && s.contains("CLOSED_SHELL"));
|
|
let back = read_design(&write_design(&doc)).unwrap();
|
|
assert_eq!(back, doc);
|
|
assert!(read_design(b"\xff\xfe").is_err());
|
|
assert!(matches!(export(&m.state(), &["nope".into()], Format::Step, "t"), Err(IoError::Empty)));
|
|
assert_eq!(Format::from_name("a.STP").unwrap(), Format::Step);
|
|
assert!(is_step_path("/x/Part.STEP") && is_step_path("a.stp") && !is_step_path("a.step.json") && !is_step_path("step"));
|
|
let f = step_import_feature(s.as_bytes(), "/tmp/My Part.step").unwrap();
|
|
// Named after the exported product (the export was called `t`).
|
|
assert_eq!(f.name, "t");
|
|
assert_eq!(f.body_names, ["Body1"]);
|
|
assert_eq!(f.body_names.len(), 1);
|
|
assert!(matches!(&f.kind, FeatureKind::Import { file, .. } if file == "My Part.step"));
|
|
let mut imported = Document::new("Imported STEP round trip");
|
|
imported.add_feature(f.kind, None).unwrap();
|
|
let packaged = read_design(&write_design_container(&imported).unwrap()).unwrap();
|
|
assert_eq!(packaged, imported);
|
|
let mut rebuilt = Model::new();
|
|
rebuilt.evaluate(&packaged);
|
|
assert!(rebuilt.results.iter().all(|r| r.error.is_none()));
|
|
let state = rebuilt.state();
|
|
assert_eq!(state.bodies.len(), 1);
|
|
assert!((solidcraft_kernel::measure(&state.bodies[0].body).unwrap().volume - 6000.0).abs() < 1e-6);
|
|
assert!(step_import_feature(b"ISO-10303-21;", "x.step").is_err());
|
|
assert!(step_import_feature(&[0xff, 0xfe, 0x00], "x.step").is_err());
|
|
assert!(Format::from_name("a.dwg").is_err());
|
|
// Compatibility shim: the legacy design extension is still a design.
|
|
assert_eq!(Format::from_name("old.solvecraft").unwrap(), Format::Design);
|
|
assert_eq!(Format::from_name("new.solidcraft").unwrap(), Format::Design);
|
|
assert!(is_design_path("/d/old.SOLVECRAFT") && is_design_path("new.solidcraft") && !is_design_path("a.step"));
|
|
assert!(read_stl(&[0u8; 10]).is_err());
|
|
let mut fake = vec![0u8; 84];
|
|
fake[80..84].copy_from_slice(&u32::MAX.to_le_bytes());
|
|
assert!(read_stl(&fake).is_err());
|
|
}
|
|
|
|
fn stl_volume(bytes: &[u8]) -> f64 {
|
|
read_stl(bytes)
|
|
.unwrap()
|
|
.iter()
|
|
.map(|t| {
|
|
let p = |k: usize| Vec3::new(t[k][0] as f64, t[k][1] as f64, t[k][2] as f64);
|
|
p(0).dot(p(1).cross(p(2))) / 6.0
|
|
})
|
|
.sum()
|
|
}
|
|
|
|
/// Build → export 3MF → import → the same volume as the STL export, closed meshes, names.
|
|
#[test]
|
|
fn threemf_round_trip() {
|
|
let mut doc = Document::new("t");
|
|
doc.add_feature(
|
|
FeatureKind::Box {
|
|
corner: point_expr(Vec3::ZERO),
|
|
length: "40".into(),
|
|
width: "30".into(),
|
|
height: "10".into(),
|
|
operation: Operation::NewBody,
|
|
},
|
|
None,
|
|
)
|
|
.unwrap();
|
|
doc.add_feature(
|
|
FeatureKind::Fillet {
|
|
edges: vec![Vec3::new(0.0, 0.0, 5.0)],
|
|
radius: "4".into(),
|
|
body: None,
|
|
style: Default::default(),
|
|
fit: Default::default(),
|
|
},
|
|
None,
|
|
)
|
|
.unwrap();
|
|
doc.add_feature(
|
|
FeatureKind::Cylinder {
|
|
base: point_expr(Vec3::new(80.0, 0.0, 0.0)),
|
|
axis: Vec3::Z,
|
|
radius: "6".into(),
|
|
height: "15".into(),
|
|
operation: Operation::NewBody,
|
|
},
|
|
None,
|
|
)
|
|
.unwrap();
|
|
doc.add_feature(
|
|
FeatureKind::Torus {
|
|
center: point_expr(Vec3::new(0.0, 80.0, 0.0)),
|
|
major: "12".into(),
|
|
minor: "3".into(),
|
|
operation: Operation::NewBody,
|
|
},
|
|
None,
|
|
)
|
|
.unwrap();
|
|
let mut m = Model::new();
|
|
m.evaluate(&doc);
|
|
let st = m.state();
|
|
assert_eq!(st.bodies.len(), 3);
|
|
let bytes = export(&st, &[], Format::ThreeMf, "t").unwrap();
|
|
let f = mesh_import_feature(&bytes, "/tmp/parts.3MF").unwrap();
|
|
assert_eq!(f.body_names, st.bodies.iter().map(|b| b.name.clone()).collect::<Vec<_>>());
|
|
let mut d2 = Document::new("m");
|
|
let id = d2.add_feature(f.kind, Some(&f.name)).unwrap();
|
|
let mut m2 = Model::new();
|
|
m2.evaluate(&d2);
|
|
assert!(m2.result(id).unwrap().error.is_none());
|
|
let st2 = m2.state();
|
|
assert_eq!(st2.bodies.len(), 3);
|
|
for (a, b) in st.bodies.iter().zip(&st2.bodies) {
|
|
assert_eq!(a.name, b.name);
|
|
assert!(b.body.is_mesh() && b.body.is_closed_mesh(), "{} is not watertight", b.name);
|
|
let v_stl = stl_volume(&export(&st, std::slice::from_ref(&a.name), Format::StlBinary, "t").unwrap());
|
|
let v = solidcraft_kernel::measure(&b.body).unwrap().volume;
|
|
assert!((v - v_stl).abs() <= 1e-6 * v_stl.abs(), "{}: {v} vs {v_stl}", a.name);
|
|
}
|
|
// Mesh bodies export again (3MF, STL, OBJ) but not as STEP.
|
|
assert!(export(&st2, &[], Format::ThreeMf, "t").is_ok());
|
|
assert!(export(&st2, &[], Format::StlAscii, "t").is_ok());
|
|
assert!(export(&st2, &[], Format::Obj, "t").is_ok());
|
|
assert!(export(&st2, &[], Format::Step, "t").is_err());
|
|
// STL imports the same way.
|
|
let stl = export(&st, &[], Format::StlBinary, "t").unwrap();
|
|
let fs = mesh_import_feature(&stl, "all.stl").unwrap();
|
|
assert_eq!(fs.name, "all");
|
|
assert!(mesh_import_feature(b"PK", "x.3mf").is_err());
|
|
assert!(mesh_import_feature(&[0u8; 84], "x.stl").is_err());
|
|
assert!(is_mesh_path("a.3MF") && is_mesh_path("b.stl") && !is_mesh_path("c.step"));
|
|
}
|
|
}
|