aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSébastien Crozet <sebcrozet@dimforge.com>2024-06-09 10:57:37 +0200
committerSébastien Crozet <sebastien@crozet.re>2024-06-09 12:09:58 +0200
commitedaa36ac7e702f419faab4ff1b9af858fc84177f (patch)
tree059a92ef66db3f4769146ef20b64b3dcbb649129
parentcfddaa3c46e58f59d551e3dc7fc5d4380b322789 (diff)
downloadrapier-edaa36ac7e702f419faab4ff1b9af858fc84177f.tar.gz
rapier-edaa36ac7e702f419faab4ff1b9af858fc84177f.tar.bz2
rapier-edaa36ac7e702f419faab4ff1b9af858fc84177f.zip
chore: add more comments
-rw-r--r--CHANGELOG.md4
-rw-r--r--Cargo.toml2
-rw-r--r--README.md6
-rw-r--r--benchmarks2d/Cargo.toml18
-rw-r--r--benchmarks3d/Cargo.toml18
-rw-r--r--crates/rapier-stl/Cargo.toml10
-rw-r--r--crates/rapier-stl/src/lib.rs72
-rw-r--r--crates/rapier-urdf/Cargo.toml17
-rw-r--r--crates/rapier2d-f64/Cargo.toml2
-rw-r--r--crates/rapier2d/Cargo.toml2
-rw-r--r--crates/rapier3d-f64/Cargo.toml2
-rw-r--r--crates/rapier3d-stl/CHANGELOG.md9
-rw-r--r--crates/rapier3d-stl/Cargo.toml19
-rw-r--r--crates/rapier3d-stl/LICENSE201
-rw-r--r--crates/rapier3d-stl/README.md18
-rw-r--r--crates/rapier3d-stl/src/lib.rs110
-rw-r--r--crates/rapier3d-urdf/CHANGELOG.md16
-rw-r--r--crates/rapier3d-urdf/Cargo.toml26
-rw-r--r--crates/rapier3d-urdf/LICENSE201
-rw-r--r--crates/rapier3d-urdf/README.md37
-rw-r--r--crates/rapier3d-urdf/src/lib.rs (renamed from crates/rapier-urdf/src/lib.rs)205
-rw-r--r--crates/rapier3d/Cargo.toml2
-rw-r--r--crates/rapier_testbed2d-f64/Cargo.toml2
-rw-r--r--crates/rapier_testbed2d/Cargo.toml2
-rw-r--r--crates/rapier_testbed3d-f64/Cargo.toml2
-rw-r--r--crates/rapier_testbed3d/Cargo.toml2
-rw-r--r--examples2d/Cargo.toml22
-rw-r--r--examples2d/all_examples2.rs4
-rw-r--r--examples2d/inverse_kinematics2.rs1
-rw-r--r--examples3d-f64/Cargo.toml18
-rw-r--r--examples3d/Cargo.toml6
-rw-r--r--examples3d/all_examples3.rs4
-rw-r--r--examples3d/urdf3.rs5
-rw-r--r--src/dynamics/ccd/toi_entry.rs4
-rw-r--r--src/dynamics/joint/multibody_joint/multibody.rs4
-rw-r--r--src/dynamics/joint/multibody_joint/multibody_joint.rs4
-rw-r--r--src/dynamics/joint/multibody_joint/multibody_joint_set.rs1
-rw-r--r--src/dynamics/solver/contact_constraint/contact_constraints_set.rs1
-rw-r--r--src/dynamics/solver/joint_constraint/joint_constraint_builder.rs10
-rw-r--r--src/geometry/mesh_converter.rs8
-rw-r--r--src/lib.rs2
41 files changed, 897 insertions, 202 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9a60209..eb6a330 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,9 +2,9 @@
This release introduces two new crates:
-- `rapier-urdf` for loading URDF files into rapier3d. This will load the rigid-bodies,
+- `rapier3d-urdf` for loading URDF files into rapier3d. This will load the rigid-bodies,
colliders, and joints.
-- `rapier-stl` for loading an STL file as a collision shape.
+- `rapier3d-stl` for loading an STL file as a collision shape.
### Added
diff --git a/Cargo.toml b/Cargo.toml
index f176685..971dff9 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[workspace]
members = ["crates/rapier2d", "crates/rapier2d-f64", "crates/rapier_testbed2d", "crates/rapier_testbed2d-f64", "examples2d", "benchmarks2d",
- "crates/rapier3d", "crates/rapier3d-f64", "crates/rapier_testbed3d", "crates/rapier_testbed3d-f64", "examples3d", "examples3d-f64", "benchmarks3d", "crates/rapier-urdf", "crates/rapier-stl"]
+ "crates/rapier3d", "crates/rapier3d-f64", "crates/rapier_testbed3d", "crates/rapier_testbed3d-f64", "examples3d", "examples3d-f64", "benchmarks3d", "crates/rapier3d-urdf", "crates/rapier3d-stl"]
resolver = "2"
[patch.crates-io]
diff --git a/README.md b/README.md
index 1174a1c..017cf56 100644
--- a/README.md
+++ b/README.md
@@ -40,12 +40,6 @@ are `rapier2d`, `rapier3d`, `rapier2d-f64`, and `rapier3d-f64`. They are written
programming language, by the [Dimforge](https://dimforge.com) organization. It is forever free
and open-source!
-## Roadmap
-
-We update our roadmap at the beginning of each year. Our 2021 roadmap can be seen
-[there](https://www.dimforge.com/blog/2021/01/01/physics-simulation-with-rapier-2021-roadmap/#rapier-roadmap-for-2021).
-We regularly give updates about our progress on [our blog](https://www.dimforge.com/blog).
-
## Getting started
The easiest way to get started with Rapier is to:
diff --git a/benchmarks2d/Cargo.toml b/benchmarks2d/Cargo.toml
index bbab4d9..0d64704 100644
--- a/benchmarks2d/Cargo.toml
+++ b/benchmarks2d/Cargo.toml
@@ -1,19 +1,19 @@
[package]
-name = "rapier-benchmarks-2d"
+name = "rapier-benchmarks-2d"
version = "0.1.0"
-authors = [ "Sébastien Crozet <developer@crozet.re>" ]
+authors = ["Sébastien Crozet <sebcrozet@dimforge.com>"]
edition = "2021"
[features]
-parallel = [ "rapier2d/parallel", "rapier_testbed2d/parallel" ]
-simd-stable = [ "rapier2d/simd-stable" ]
-simd-nightly = [ "rapier2d/simd-nightly" ]
-other-backends = [ "rapier_testbed2d/other-backends" ]
-enhanced-determinism = [ "rapier2d/enhanced-determinism" ]
+parallel = ["rapier2d/parallel", "rapier_testbed2d/parallel"]
+simd-stable = ["rapier2d/simd-stable"]
+simd-nightly = ["rapier2d/simd-nightly"]
+other-backends = ["rapier_testbed2d/other-backends"]
+enhanced-determinism = ["rapier2d/enhanced-determinism"]
[dependencies]
-rand = "0.8"
-Inflector = "0.11"
+rand = "0.8"
+Inflector = "0.11"
[dependencies.rapier_testbed2d]
path = "../crates/rapier_testbed2d"
diff --git a/benchmarks3d/Cargo.toml b/benchmarks3d/Cargo.toml
index 76d1911..f264543 100644
--- a/benchmarks3d/Cargo.toml
+++ b/benchmarks3d/Cargo.toml
@@ -1,19 +1,19 @@
[package]
-name = "rapier-benchmarks-3d"
+name = "rapier-benchmarks-3d"
version = "0.1.0"
-authors = [ "Sébastien Crozet <developer@crozet.re>" ]
+authors = ["Sébastien Crozet <sebcrozet@dimforge.com>"]
edition = "2021"
[features]
-parallel = [ "rapier3d/parallel", "rapier_testbed3d/parallel" ]
-simd-stable = [ "rapier3d/simd-stable" ]
-simd-nightly = [ "rapier3d/simd-nightly" ]
-other-backends = [ "rapier_testbed3d/other-backends" ]
-enhanced-determinism = [ "rapier3d/enhanced-determinism" ]
+parallel = ["rapier3d/parallel", "rapier_testbed3d/parallel"]
+simd-stable = ["rapier3d/simd-stable"]
+simd-nightly = ["rapier3d/simd-nightly"]
+other-backends = ["rapier_testbed3d/other-backends"]
+enhanced-determinism = ["rapier3d/enhanced-determinism"]
[dependencies]
-rand = "0.8"
-Inflector = "0.11"
+rand = "0.8"
+Inflector = "0.11"
[dependencies.rapier_testbed3d]
path = "../crates/rapier_testbed3d"
diff --git a/crates/rapier-stl/Cargo.toml b/crates/rapier-stl/Cargo.toml
deleted file mode 100644
index f533170..0000000
--- a/crates/rapier-stl/Cargo.toml
+++ /dev/null
@@ -1,10 +0,0 @@
-[package]
-name = "rapier-stl"
-version = "0.1.0"
-edition = "2021"
-
-[dependencies]
-thiserror = "1.0.61"
-stl_io = "0.7"
-
-rapier3d = { versions = "0.19", path = "../rapier3d" }
diff --git a/crates/rapier-stl/src/lib.rs b/crates/rapier-stl/src/lib.rs
deleted file mode 100644
index 87fafec..0000000
--- a/crates/rapier-stl/src/lib.rs
+++ /dev/null
@@ -1,72 +0,0 @@
-use rapier3d::geometry::{
- Collider, ColliderBuilder, Cuboid, MeshConverter, MeshConverterError, SharedShape, TriMesh,
-};
-use rapier3d::math::{Isometry, Point, Real, Vector};
-use rapier3d::parry::bounding_volume;
-use std::fs::File;
-use std::io::{BufReader, Read, Seek};
-use std::path::Path;
-use stl_io::IndexedMesh;
-
-#[derive(thiserror::Error, Debug)]
-pub enum StlLoaderError {
- #[error(transparent)]
- MeshConverter(#[from] MeshConverterError),
- #[error(transparent)]
- Io(#[from] std::io::Error),
-}
-
-/// The result of loading a shape from an stl mesh.
-pub struct StlShape {
- /// The shape loaded from the file and converted by the [`MeshConverter`].
- pub shape: SharedShape,
- /// The shape’s pose.
- pub pose: Isometry<Real>,
- /// The raw mesh read from the stl file.
- pub raw_mesh: IndexedMesh,
-}
-
-pub fn load_from_path(
- file_path: impl AsRef<Path>,
- converter: MeshConverter,
- scale: Vector<Real>,
-) -> Result<StlShape, StlLoaderError> {
- let mut reader = BufReader::new(File::open(file_path)?);
- load_from_reader(&mut reader, converter, scale)
-}
-
-pub fn load_from_reader<R: Read + Seek>(
- read: &mut R,
- converter: MeshConverter,
- scale: Vector<Real>,
-) -> Result<StlShape, StlLoaderError> {
- let stl_mesh = stl_io::read_stl(read)?;
- Ok(load_from_raw_mesh(stl_mesh, converter, scale)?)
-}
-
-pub fn load_from_raw_mesh(
- raw_mesh: IndexedMesh,
- converter: MeshConverter,
- scale: Vector<Real>,
-) -> Result<StlShape, MeshConverterError> {
- let mut vertices: Vec<_> = raw_mesh
- .vertices
- .iter()
- .map(|xyz| Point::new(xyz[0] as Real, xyz[1] as Real, xyz[2] as Real))
- .collect();
- vertices
- .iter_mut()
- .for_each(|pt| pt.coords.component_mul_assign(&scale));
- let indices: Vec<_> = raw_mesh
- .faces
- .iter()
- .map(|f| f.vertices.map(|i| i as u32))
- .collect();
- let (shape, pose) = converter.convert(vertices, indices)?;
-
- Ok(StlShape {
- shape,
- pose,
- raw_mesh,
- })
-}
diff --git a/crates/rapier-urdf/Cargo.toml b/crates/rapier-urdf/Cargo.toml
deleted file mode 100644
index 6837950..0000000
--- a/crates/rapier-urdf/Cargo.toml
+++ /dev/null
@@ -1,17 +0,0 @@
-[package]
-name = "rapier-urdf"
-version = "0.1.0"
-edition = "2021"
-
-[features]
-stl = ["rapier-stl"]
-
-[dependencies]
-log = "0.4"
-anyhow = "1"
-bitflags = "2"
-# NOTE: we are not using the (more recent) urdf-rs crate because of https://github.com/openrr/urdf-rs/issues/94
-xurdf = "0.2"
-
-rapier3d = { versions = "0.19", path = "../rapier3d" }
-rapier-stl = { version = "0.1.0", path = "../rapier-stl", optional = true }
diff --git a/crates/rapier2d-f64/Cargo.toml b/crates/rapier2d-f64/Cargo.toml
index 79046bb..059f52d 100644
--- a/crates/rapier2d-f64/Cargo.toml
+++ b/crates/rapier2d-f64/Cargo.toml
@@ -1,7 +1,7 @@
[package]
name = "rapier2d-f64"
version = "0.19.0"
-authors = ["Sébastien Crozet <developer@crozet.re>"]
+authors = ["Sébastien Crozet <sebcrozet@dimforge.com>"]
description = "2-dimensional physics engine in Rust."
documentation = "https://docs.rs/rapier2d"
homepage = "https://rapier.rs"
diff --git a/crates/rapier2d/Cargo.toml b/crates/rapier2d/Cargo.toml
index f0474c8..d270c9d 100644
--- a/crates/rapier2d/Cargo.toml
+++ b/crates/rapier2d/Cargo.toml
@@ -1,7 +1,7 @@
[package]
name = "rapier2d"
version = "0.19.0"
-authors = ["Sébastien Crozet <developer@crozet.re>"]
+authors = ["Sébastien Crozet <sebcrozet@dimforge.com>"]
description = "2-dimensional physics engine in Rust."
documentation = "https://docs.rs/rapier2d"
homepage = "https://rapier.rs"
diff --git a/crates/rapier3d-f64/Cargo.toml b/crates/rapier3d-f64/Cargo.toml
index 95f0d66..98a87a9 100644
--- a/crates/rapier3d-f64/Cargo.toml
+++ b/crates/rapier3d-f64/Cargo.toml
@@ -1,7 +1,7 @@
[package]
name = "rapier3d-f64"
version = "0.19.0"
-authors = ["Sébastien Crozet <developer@crozet.re>"]
+authors = ["Sébastien Crozet <sebcrozet@dimforge.com>"]
description = "3-dimensional physics engine in Rust."
documentation = "https://docs.rs/rapier3d"
homepage = "https://rapier.rs"
diff --git a/crates/rapier3d-stl/CHANGELOG.md b/crates/rapier3d-stl/CHANGELOG.md
new file mode 100644
index 0000000..bb3ffa3
--- /dev/null
+++ b/crates/rapier3d-stl/CHANGELOG.md
@@ -0,0 +1,9 @@
+## Unreleased
+
+This is the initial release of the `rapier3d-stl` crate.
+
+### Added
+
+- Add `load_from_path` for creating a shape from a stl file.
+- Add `load_from_reader` for creating a shape from an object implementing `Read`.
+- Add `load_from_raw_mesh` for creating a shape from an already loaded `IndexedMesh`.
diff --git a/crates/rapier3d-stl/Cargo.toml b/crates/rapier3d-stl/Cargo.toml
new file mode 100644
index 0000000..dc5bd0e
--- /dev/null
+++ b/crates/rapier3d-stl/Cargo.toml
@@ -0,0 +1,19 @@
+[package]
+name = "rapier3d-stl"
+version = "0.1.0"
+authors = ["Sébastien Crozet <sebcrozet@dimforge.com>"]
+description = "STL file loader for the 3D rapier physics engine."
+documentation = "https://docs.rs/rapier3d-stl"
+homepage = "https://rapier.rs"
+repository = "https://github.com/dimforge/rapier"
+readme = "README.md"
+categories = ["science", "game-development", "mathematics", "simulation", "wasm"]
+keywords = ["physics", "joints", "multibody", "robotics", "urdf"]
+license = "Apache-2.0"
+edition = "2021"
+
+[dependencies]
+thiserror = "1.0.61"
+stl_io = "0.7"
+
+rapier3d = { version = "0.19", path = "../rapier3d" }
diff --git a/crates/rapier3d-stl/LICENSE b/crates/rapier3d-stl/LICENSE
new file mode 100644
index 0000000..97f4383
--- /dev/null
+++ b/crates/rapier3d-stl/LICENSE
@@ -0,0 +1,201 @@
+ 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
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2020 Sébastien Crozet
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/crates/rapier3d-stl/README.md b/crates/rapier3d-stl/README.md
new file mode 100644
index 0000000..98d61a0
--- /dev/null
+++ b/crates/rapier3d-stl/README.md
@@ -0,0 +1,18 @@
+## STL loader for the Rapier physics engine
+
+Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. The `rapier3d-stl`
+crate lets you create a shape compatible with `rapier3d` and `parry3d` (the underlying collision-detection
+library) from an STL file.
+
+## Resources and discussions
+
+- [Dimforge](https://dimforge.com): See all the open-source projects we are working on! Follow our announcements
+ on our [blog](https://www.dimforge.com/blog).
+- [User guide](https://www.rapier.rs/docs/): Learn to use Rapier in your project by reading the official User Guides.
+- [Discord](https://discord.gg/vt9DJSW): Come chat with us, get help, suggest features, on Discord!
+- [NPM packages](https://www.npmjs.com/search?q=%40dimforge): Check out our NPM packages for Rapier, if you need to
+ use it with JavaScript/Typescript.
+
+Please make sure to familiarize yourself with our [Code of Conduct](CODE_OF_CONDUCT.md)
+and our [Contribution Guidelines](CONTRIBUTING.md) before contributing or participating in
+discussions with the community.
diff --git a/crates/rapier3d-stl/src/lib.rs b/crates/rapier3d-stl/src/lib.rs
new file mode 100644
index 0000000..0273bc0
--- /dev/null
+++ b/crates/rapier3d-stl/src/lib.rs
@@ -0,0 +1,110 @@
+//! ## STL loader for the Rapier physics engine
+//!
+//! Rapier is a set of 2D and 3D physics engines for games, animation, and robotics. The `rapier3d-stl`
+//! crate lets you create a shape compatible with `rapier3d` and `parry3d` (the underlying collision-detection
+//! library) from an STL file.
+
+#![warn(missing_docs)]
+
+use rapier3d::geometry::{MeshConverter, MeshConverterError, SharedShape};
+use rapier3d::math::{Isometry, Point, Real, Vector};
+use std::fs::File;
+use std::io::{BufReader, Read, Seek};
+use std::path::Path;
+use stl_io::IndexedMesh;
+
+/// Error while loading an STL file.
+#[derive(thiserror::Error, Debug)]
+pub enum StlLoaderError {
+ /// An error triggered by rapier’s [`MeshConverter`].
+ #[error(transparent)]
+ MeshConverter(#[from] MeshConverterError),
+ /// A generic IO error.
+ #[error(transparent)]
+ Io(#[from] std::io::Error),
+}
+
+/// The result of loading a shape from an stl mesh.
+pub struct StlShape {
+ /// The shape loaded from the file and converted by the [`MeshConverter`].
+ pub shape: SharedShape,
+ /// The shape’s pose.
+ pub pose: Isometry<Real>,
+ /// The raw mesh read from the stl file without any modification.
+ pub raw_mesh: IndexedMesh,
+}
+
+/// Loads an STL file as a shape from a file.
+///
+/// # Parameters
+/// - `file_path`: the STL file’s path.
+/// - `converter`: controls how the shape is computed from the STL content. In particular, it lets
+/// you specify if the computed [`StlShape::shape`] is a triangle mesh, its convex hull,
+/// bounding box, etc.
+/// - `scale`: the scaling factor applied to the geometry input to the `converter`. This scale will
+/// affect at the geometric level the [`StlShape::shape`]. Note that raw mesh value stored
+/// in [`StlShape::raw_mesh`] remains unscaled.
+pub fn load_from_path(
+ file_path: impl AsRef<Path>,
+ converter: MeshConverter,
+ scale: Vector<Real>,
+) -> Result<StlShape, StlLoaderError> {
+ let mut reader = BufReader::new(File::open(file_path)?);
+ load_from_reader(&mut reader, converter, scale)
+}
+
+/// Loads an STL file as a shape from an arbitrary reader.
+///
+/// # Parameters
+/// - `reader`: the reader.
+/// - `converter`: controls how the shape is computed from the STL content. In particular, it lets
+/// you specify if the computed [`StlShape::shape`] is a triangle mesh, its convex hull,
+/// bounding box, etc.
+/// - `scale`: the scaling factor applied to the geometry input to the `converter`. This scale will
+/// affect at the geometric level the [`StlShape::shape`]. Note that raw mesh value stored
+/// in [`StlShape::raw_mesh`] remains unscaled.
+pub fn load_from_reader<R: Read + Seek>(
+ read: &mut