diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..9c18a84 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,35 @@ +name: CI + +on: + push: + branches: + - main + - develop + pull_request: {} + + +jobs: + + build: + name: cargo build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - name: Build + run: cargo build + + test: + name: cargo test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + with: + components: rustfmt clippy + - name: rustfmt + run: cargo fmt --all -- --check + - name: clippy + run: cargo clippy + - name: test + run: cargo test --verbose diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5ee7f3a --- /dev/null +++ b/.gitignore @@ -0,0 +1,141 @@ +# Created by https://www.toptal.com/developers/gitignore/api/rust,macos,jetbrains+all +# Edit at https://www.toptal.com/developers/gitignore?templates=rust,macos,jetbrains+all + +### JetBrains+all ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### JetBrains+all Patch ### +# Ignore everything but code style settings and run configurations +# that are supposed to be shared within teams. + +.idea/* + +!.idea/codeStyles +!.idea/runConfigurations + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### macOS Patch ### +# iCloud generated files +*.icloud + +### Rust ### +# Generated by Cargo +# will have compiled files and executables +debug/ +target/ + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html +Cargo.lock + +# These are backup files generated by rustfmt +**/*.rs.bk + +# MSVC Windows builds of rustc generate these, which store debugging information +*.pdb + +# End of https://www.toptal.com/developers/gitignore/api/rust,macos,jetbrains+all diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..214638c --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,24 @@ +[workspace] +members = [ + "crates/*" +] + +resolver = "2" + +[workspace.package] +version = "0.0.1-alpha.3" +authors = ["Benedikt Schwab "] +edition = "2021" +license = "MIT OR Apache-2.0" +repository = "https://github.com/envis-space/emesh" + +[workspace.dependencies] +ecoord = { version = "0.0.1-alpha.3" } + +thiserror = "1.0.61" +clap = "4.5.9" +tracing = "0.1.40" +tracing-subscriber = "0.3.18" +polars = "0.41.3" +rayon = "1.10.0" +nalgebra = "0.33.0" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..a7e77cb --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..468cd79 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,23 @@ +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a056c0 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# emesh + +A Rust library for processing 3D polygon meshes. + +> [!WARNING] +> The library is at an early stage of development. + +## Contributing + +The library is developed at the [TUM Chair of Geoinformatics](https://github.com/tum-gis) and contributions are highly welcome. diff --git a/crates/emesh-cli/Cargo.toml b/crates/emesh-cli/Cargo.toml new file mode 100644 index 0000000..fabc506 --- /dev/null +++ b/crates/emesh-cli/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "emesh-cli" +version.workspace = true +authors.workspace = true +edition.workspace = true +license.workspace = true +repository.workspace = true +description = "CLI tool for processing 3D polygon meshes." + + +[dependencies] +emesh = { version = "0.0.1-alpha.3", path = "../emesh" } + +clap = { workspace = true, features = ["derive"] } +tracing = { workspace = true } +tracing-subscriber = { workspace = true } diff --git a/crates/emesh-cli/README.md b/crates/emesh-cli/README.md new file mode 100644 index 0000000..bba2f7b --- /dev/null +++ b/crates/emesh-cli/README.md @@ -0,0 +1,10 @@ +# emesh-cli + +CLI tool for processing 3D polygon meshes. + +> [!WARNING] +> The library is at an early stage of development. + +## Contributing + +The library is developed at the [TUM Chair of Geoinformatics](https://github.com/tum-gis) and contributions are highly welcome. diff --git a/crates/emesh-cli/src/arguments.rs b/crates/emesh-cli/src/arguments.rs new file mode 100644 index 0000000..9d3b082 --- /dev/null +++ b/crates/emesh-cli/src/arguments.rs @@ -0,0 +1,18 @@ +use clap::{Parser, Subcommand}; + +#[derive(Parser)] +#[clap(author, version, about, long_about = None, propagate_version = true)] +pub struct Arguments { + #[clap(subcommand)] + pub command: Commands, +} + +#[derive(Subcommand)] +pub enum Commands { + /// Convert a mesh to a graphics representation + Test { + /// Path to the output directory + #[clap(short, long)] + output_path: String, + }, +} diff --git a/crates/emesh-cli/src/commands/mod.rs b/crates/emesh-cli/src/commands/mod.rs new file mode 100644 index 0000000..bcc92d7 --- /dev/null +++ b/crates/emesh-cli/src/commands/mod.rs @@ -0,0 +1 @@ +pub(crate) mod test; diff --git a/crates/emesh-cli/src/commands/test.rs b/crates/emesh-cli/src/commands/test.rs new file mode 100644 index 0000000..6218cd6 --- /dev/null +++ b/crates/emesh-cli/src/commands/test.rs @@ -0,0 +1,3 @@ +use std::path::PathBuf; + +pub fn run(_output_file_path: PathBuf) {} diff --git a/crates/emesh-cli/src/main.rs b/crates/emesh-cli/src/main.rs new file mode 100644 index 0000000..2071b6f --- /dev/null +++ b/crates/emesh-cli/src/main.rs @@ -0,0 +1,19 @@ +use crate::arguments::{Arguments, Commands}; +use clap::Parser; +use std::path::PathBuf; + +mod arguments; +mod commands; + +fn main() { + tracing_subscriber::fmt::init(); + let arguments = Arguments::parse(); + + match &arguments.command { + Commands::Test { output_path } => { + let output_directory_path = PathBuf::from(&output_path); + + commands::test::run(output_directory_path); + } + } +} diff --git a/crates/emesh-core/Cargo.toml b/crates/emesh-core/Cargo.toml new file mode 100644 index 0000000..48c93f1 --- /dev/null +++ b/crates/emesh-core/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "emesh-core" +version.workspace = true +authors.workspace = true +edition.workspace = true +license.workspace = true +repository.workspace = true +description = "Core primitives and operations for processing 3D polygon meshes." + +[dependencies] +ecoord = { workspace = true } + +thiserror = { workspace = true } +polars = { workspace = true } +rayon = { workspace = true } +nalgebra = { workspace = true } diff --git a/crates/emesh-core/README.md b/crates/emesh-core/README.md new file mode 100644 index 0000000..0084abb --- /dev/null +++ b/crates/emesh-core/README.md @@ -0,0 +1,10 @@ +# emesh-core + +Core primitives and operations for processing 3D polygon meshes. + +> [!WARNING] +> The library is at an early stage of development. + +## Contributing + +The library is developed at the [TUM Chair of Geoinformatics](https://github.com/tum-gis) and contributions are highly welcome. diff --git a/crates/emesh-core/src/error.rs b/crates/emesh-core/src/error.rs new file mode 100644 index 0000000..14b8fb0 --- /dev/null +++ b/crates/emesh-core/src/error.rs @@ -0,0 +1,7 @@ +use thiserror::Error; + +#[derive(Error, Debug)] +pub enum Error { + #[error("Field does not match type")] + VertexDuplicates, +} diff --git a/crates/emesh-core/src/lib.rs b/crates/emesh-core/src/lib.rs new file mode 100644 index 0000000..427c0ac --- /dev/null +++ b/crates/emesh-core/src/lib.rs @@ -0,0 +1,15 @@ +mod error; +mod mesh; +mod polygon; + +#[doc(inline)] +pub use error::Error; + +#[doc(inline)] +pub use mesh::Mesh; + +#[doc(inline)] +pub use polygon::IndexedPolygon; + +#[doc(inline)] +pub use polygon::Polygon; diff --git a/crates/emesh-core/src/mesh.rs b/crates/emesh-core/src/mesh.rs new file mode 100644 index 0000000..0d9fb46 --- /dev/null +++ b/crates/emesh-core/src/mesh.rs @@ -0,0 +1,65 @@ +use crate::polygon::{IndexedPolygon, Polygon}; +use nalgebra::Point3; +use rayon::iter::*; + +#[derive(Debug, Clone, PartialEq)] +pub struct Mesh { + vertices: Vec>, + polygons: Vec, +} + +impl Mesh { + pub fn new(vertices: Vec>, polygons: Vec) -> Self { + Self { vertices, polygons } + } + + pub fn add_vertex(&mut self, vertex: Point3) -> usize { + self.vertices.push(vertex); + self.vertices.len() - 1 + } + + pub fn add_indexed_polygon(&mut self, polygon: IndexedPolygon) { + self.polygons.push(polygon); + } + + pub fn add_polygon(&mut self, polygon: &Polygon, tolerance: Option) { + if tolerance.is_some() { + todo!("not supported yet"); + } + let start_index = self.vertices.len(); + let indext_range: Vec<_> = + (start_index..(start_index + polygon.vertices().len())).collect(); + let mut vertices = polygon.vertices().clone(); + self.vertices.append(&mut vertices); + + let indexed_polygon = IndexedPolygon::new(indext_range).unwrap(); + self.polygons.push(indexed_polygon); + } + + pub fn get_polygon(&self, index: usize) -> Option { + let indexed_polygon = self.polygons.get(index)?; + + let polygon = resolve_indexed_polygon(indexed_polygon, &self.vertices); + Some(polygon) + } + + pub fn get_polygons(&self) -> Vec { + self.polygons + .par_iter() + .map(|p| resolve_indexed_polygon(p, &self.vertices)) + .collect() + } +} + +fn resolve_indexed_polygon( + indexed_polygon: &IndexedPolygon, + vertices: &Vec>, +) -> Polygon { + let vertices: Vec> = indexed_polygon + .vertices() + .iter() + .map(|i| *vertices.get(*i).expect("indices must be sane")) + .collect(); + + Polygon::new(vertices).expect("must be sane") +} diff --git a/crates/emesh-core/src/polygon.rs b/crates/emesh-core/src/polygon.rs new file mode 100644 index 0000000..3c5e897 --- /dev/null +++ b/crates/emesh-core/src/polygon.rs @@ -0,0 +1,32 @@ +use crate::Error; +use nalgebra::Point3; + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct IndexedPolygon { + vertices: Vec, +} + +impl IndexedPolygon { + pub fn new(vertices: Vec) -> Result { + Ok(Self { vertices }) + } + + pub fn vertices(&self) -> &Vec { + &self.vertices + } +} + +#[derive(Debug, Clone, PartialEq)] +pub struct Polygon { + vertices: Vec>, +} + +impl Polygon { + pub fn new(vertices: Vec>) -> Result { + Ok(Self { vertices }) + } + + pub fn vertices(&self) -> &Vec> { + &self.vertices + } +} diff --git a/crates/emesh/Cargo.toml b/crates/emesh/Cargo.toml new file mode 100644 index 0000000..a1b7ce4 --- /dev/null +++ b/crates/emesh/Cargo.toml @@ -0,0 +1,13 @@ +[package] +name = "emesh" +version.workspace = true +authors.workspace = true +edition.workspace = true +license.workspace = true +repository.workspace = true +description = "Library for processing 3D polygon meshes." + + +[dependencies] +emesh-core = { version = "0.0.1-alpha.3", path = "../emesh-core" } + diff --git a/crates/emesh/README.md b/crates/emesh/README.md new file mode 100644 index 0000000..036c55a --- /dev/null +++ b/crates/emesh/README.md @@ -0,0 +1,10 @@ +# emesh + +Library for processing 3D polygon meshes. + +> [!WARNING] +> The library is at an early stage of development. + +## Contributing + +The library is developed at the [TUM Chair of Geoinformatics](https://github.com/tum-gis) and contributions are highly welcome. diff --git a/crates/emesh/src/lib.rs b/crates/emesh/src/lib.rs new file mode 100644 index 0000000..0ba3b5e --- /dev/null +++ b/crates/emesh/src/lib.rs @@ -0,0 +1,9 @@ +///! `emesh` is a library for processing 3D polygon meshes. +///! +///! +///! # Overview +///! +///! +///! # Data structure +///! +pub use emesh_core::{Error, IndexedPolygon, Mesh, Polygon};