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

/*
Line and line segment library for 2d and 3d.

Copyright (C) 2021 eadf https://github.com/eadf

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short notice like
this when it starts in an interactive mode:

Linestring Copyright (C) 2021 eadf

This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.

This is free software, and you are welcome to redistribute it under certain
conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands might
be different; for a GUI interface, you would use an "about box".

You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary. For
more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General Public
License instead of this License. But first, please read <https://www.gnu.org/
licenses /why-not-lgpl.html>.
*/

#![deny(non_camel_case_types)]
#![deny(unused_parens)]
#![deny(non_upper_case_globals)]
#![deny(unused_qualifications)]
#![deny(unused_results)]
#![deny(unused_imports)]
#![deny(unused_variables)]
#![cfg_attr(feature = "map_first_last", feature(map_first_last))]

//! This library contains data structures and methods that deals with lines in 2D and 3D space.
//!
//! There are 3D and 2D implementations of:
//! * LineString, a sequence of points, aka Polyline.
//! * Line, a finite two-point struct (no rays).
//! * [Ramer–Douglas-Peucker](https://en.wikipedia.org/wiki/Ramer–Douglas–Peucker_algorithm) and
//! * [Visvalingam-Whyatt](https://en.wikipedia.org/wiki/Visvalingam–Whyatt_algorithm) line simplification algorithms.
//! * Sampling of [boostvoronoi](https://github.com/eadf/boostvoronoi.rs) parabolic arc curves.
//! * Rudimentary functionality to save to .obj file
//!
//! There are 2D implementations of:
//! * LineString2 convex hull calculation (gift wrapping & Graham scan)
//! * Aabb [axis aligned bounding box](https://en.wikipedia.org/wiki/Minimum_bounding_box).
//! * Self intersection tests for line strings, or groups of lines O( n log n + i log n).
//! * Convex hull containment test (single threaded or multi-threaded with [ryon](https://crates.io/crates/rayon))
//! * Simple affine transformation (pan, zoom)
//!
//! The library is implemented for a couple of independent 2d/3d packages:nalgebra,cgmath,vecmath,mint and plain vectors.
//! Those implementations are feature gated so you only need to import the package you really use.
use thiserror::Error;

#[derive(Error, Debug)]
pub enum LinestringError {
    #[error("Your line-strings are self-intersecting.")]
    SelfIntersectingData(String),

    #[error("The input data is not 2D")]
    InputNotPLane(String),

    #[error("Invalid data")]
    InvalidData(String),

    #[error("Unknown error")]
    InternalError(String),

    #[error("Aabb error")]
    AabbError(String),

    #[error("Aabb error")]
    TransformError(String),

    #[error(transparent)]
    IoError(#[from] std::io::Error),
}

/// This module is optional. To use if you must include the feature ```nalgebra``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```nalgebra``` feature you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["nalgebra"]}```
#[cfg(feature = "nalgebra")]
pub mod nalgebra_2d;
/// This module is optional. To use if you must include the feature ```nalgebra``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```nalgebra``` feature you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["nalgebra"]}```
#[cfg(feature = "nalgebra")]
pub mod nalgebra_3d;

/// This module is optional. To use if you must include the feature ```cgmath``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```cgmath``` feature you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["cgmath"]}```
#[cfg(feature = "cgmath")]
pub mod cgmath_2d;

/// This module is optional. To use if you must include the feature ```cgmath``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```cgmath``` feature you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["cgmath"]}```
#[cfg(feature = "cgmath")]
pub mod cgmath_3d;

/// This module is optional. To use if you must include the feature ```mint``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```mint``` feature you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["mint"]}```
#[cfg(feature = "mint")]
pub mod mint_2d;
/// This module is optional. To use if you must include the feature ```mint``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```mint``` feature you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["mint"]}```
#[cfg(feature = "mint")]
pub mod mint_3d;

/// This module is optional. To use if you must include the feature ```vecmath``` or ```vector``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```vecmath``` or ```vecmath``` features you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["vecmath"]}```
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["vector"]}```
#[cfg(any(feature = "vector", feature = "vecmath"))]
pub mod vector_2d;
/// This module is optional. To use if you must include the feature ```vecmath``` or ```vector``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```vecmath``` or ```vecmath``` features you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["vecmath"]}```
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["vector"]}```
#[cfg(any(feature = "vector", feature = "vecmath"))]
pub mod vector_3d;

/// This module is optional. To use if you must include the feature ```vecmath``` in your ```Cargo.toml``` file.
///
/// By default all features are enabled (this is a work-around to enable the automatic rust doc).
/// If you want to only enable the ```vecmath``` feature you must first disable the default features with ```default-features=false```.
///
/// Cargo.toml example: ```linestring = {version="<current version>",default-features=false,features=["vecmath"]}```
#[cfg(feature = "vecmath")]
pub mod vecmath_3d;