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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

/*
Copyright 2016 Martin Buck
This file is part of rust-3d.
rust-3d is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
rust-3d is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with rust-3d.  If not, see <http://www.gnu.org/licenses/>.
*/

#![deny(warnings)]

//! rust-3d
//! =======
//! 3D/2D library written in Rust.
//! Offering useful containers, structures and algorithms for 2D and 3D space.
//! Meant as basis for numeric algorithms, viewers, game engines, ...
//!
//!
//! Notes
//! -----
//! `rust-3d` is still in really early stages, there might come breaking changes with each update.
//! The test coverage is far from perfect, so you might find some bugs (please report them).
//! Compiling with `stable`.
//!
//!
//! Tour
//! ----
//! Here's a little overview of some of `rust-3d`'s features.
//! The snippets / names might not be up-to-date, so please check `tests/` for compiling examples.
//!
//!
//! ### Proper error handling
//! No `.unwrap()` where it's not 100% safe.
//!
//! ### Strong / Smart Types
//! There's strong types for everything that might get mixed up easily.
//! This way e.g. ids of faces can't be mistaken for ids of vertices.
//! ```rust,ignore
//! fn edges_of_face(&self, faceid: FId) -> Result<(EId, EId, EId)>;
//! ```
//! There's also smart types which restrict the values they can hold.
//! This way distances can never be `< 0.0`, sizes can be enfored to be `> 0.0` etc.
//! ```rust,ignore
//! Positive
//! NonNegative
//! ```
//!
//! ### Generic Code Base
//! I try and keep all algorithms and types as generic as possible (see `/src/traits`).
//! - Even rather basic types like `Is2D` are split into several versions: `IsEditable2D`, `IsBuildable2D`
//! - `IsMesh` is defined for any vertex type and any number of vertices / face
//! - There's traits for collections (no need to use `Vec`)
//!
//! This makes it possible to require as little implementation work as possible if you want to use your own types.
//!
//!
//! ### Combinators / Transformers
//! - Any `IsFilter<T>` can be combined via `FilterAND`, `FilterOR`, `FilterAny`, `FilterNegate`...
//! - Any `IsFilter<T>` can be transformed to work for any collection of `T`s (`IsFilterRandomAccessible`).
//! - `IsDirectionField2D` might be transformed to an `IsFilter<Is2D>`, which can then be transformed to an `IsFilterRandomAccessible<Is2D>`.
//!
//!
//! ### IO
//! Any `IO` method is defined on traits, so if you implement these, you'll get read/write of different file formats for free.
//!
//!
//! Documentation
//! -------------
//! The documentation is quite good already, come and [take a look](https://docs.rs/rust-3d/).
//!
//!
//! Examples
//! --------
//! Please take a look at the tests in `tests/`. These will be up-to-date and compiling.
//! I might add extensive tutorials / examples / demo projects in the future.
//!
//!
//! Links
//! -----
//! [crates.io](https://crates.io/crates/rust-3d)
//! [github.com](https://github.com/I3ck/rust-3d)
//! [docs.rs](https://docs.rs/rust-3d/)
//!
//!
//! Contribute
//! ----------
//! Feel free to open an issue in case you're missing something or found a bug.
//! Please avoid directly contributing since I might be working on breaking changes or the feature you want to implement.
//! Open an issue or email me beforehand.
//!
//!
//! License
//! ------
//! LGPL (see LICENSE)

pub mod prelude;
pub mod strong_types;
pub mod traits;
pub mod impls;
pub mod io;
pub mod filters;
pub mod algorithms;
pub mod functions;
pub mod factory_2d;
pub mod interpolation_2d;
pub mod distances_2d;
pub mod distances_3d;
pub mod distances_nd;
pub mod test_helper;

mod           point_2d;
pub use self::point_2d::Point2D;

mod           point_3d;
pub use self::point_3d::Point3D;

mod           line_2d;
pub use self::line_2d::Line2D;

mod           line_3d;
pub use self::line_3d::Line3D;

mod           line_segment_2d;
pub use self::line_segment_2d::LineSegment2D;

mod           line_segment_3d;
pub use self::line_segment_3d::LineSegment3D;

mod           ray_2d;
pub use self::ray_2d::Ray2D;

mod           ray_3d;
pub use self::ray_3d::Ray3D;

mod           plane_3d;
pub use self::plane_3d::Plane3D;

mod           point_cloud_2d;
pub use self::point_cloud_2d::PointCloud2D;

mod           point_cloud_3d;
pub use self::point_cloud_3d::PointCloud3D;

mod           norm_2d;
pub use self::norm_2d::Norm2D;

mod           norm_3d;
pub use self::norm_3d::Norm3D;

mod           bounding_box_2d;
pub use self::bounding_box_2d::BoundingBox2D;

mod           bounding_box_3d;
pub use self::bounding_box_3d::BoundingBox3D;

mod           matrix3;
pub use self::matrix3::Matrix3;

mod           matrix4;
pub use self::matrix4::Matrix4;

mod           matrix3_pipe;
pub use self::matrix3_pipe::Matrix3Pipe;

mod           matrix4_pipe;
pub use self::matrix4_pipe::Matrix4Pipe;

mod           compressed_point_3d;
pub use self::compressed_point_3d::CompressedPoint3D;

mod           compressed_point_cloud_3d;
pub use self::compressed_point_cloud_3d::CompressedPointCloud3D;

mod           projection_to_plane;
//pub use self::projection_to_plane::ProjectionToPlane;

mod           kd_tree;
pub use self::kd_tree::KdTree;

mod           mesh_3d;
pub use self::mesh_3d::Mesh3D;

mod           searchable_mesh;
pub use self::searchable_mesh::SearchableMesh;

mod           oc_tree;
pub use self::oc_tree::OcTree;

mod           view;
pub use self::view::View;

mod           positive;
pub use self::positive::Positive;

mod           non_negative;
pub use self::non_negative::NonNegative;

mod           result;
pub use self::result::Result;

mod           face3;
pub use self::face3::Face3;

mod           half_edge;
pub use self::half_edge::HalfEdge;

mod           shapes;
pub use self::shapes::*;

mod enums;
pub use self::enums::*;

mod utils;