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

#![crate_name = "sfcgal"]
#![doc(html_root_url = "https://mthh.github.io/sfcgal-rs/")]
//! Rust bindings providing a high-level API to [`SFCGAL`](http://oslandia.github.io/SFCGAL/)
//! library and conversion to / from other geometry crates from Rust ecosystem.
//! Based on the [sfcgal-sys](https://github.com/mthh/sfcgal-sys) crate exposing low-level bindings.
//!
//! Allows notably reading from / writing to WKT as well as interoperability
//! with [geojson](https://crates.io/crates/geojson) and [geo-types](https://crates.io/crates/geo) crates.
//! It also offers an API
//! to manipulate SFCGAL geometries from/to coordinates (represented as tuples of 2 or 3 positions).
//!
//! #### Example
//! ```rust
//! # extern crate anyhow;
//! # fn fun() -> Result<(), anyhow::Error> {
//! extern crate sfcgal;
//! use sfcgal::{SFCGeometry, CoordSeq, ToGeoJSON, ToSFCGAL, Point2d, Point3d};
//!
//! // Create SFCGAL geometries from coordinates..
//! let coords_linestring = vec![(-0.5, -0.5, 2.5), (0., 0., 4.0)];
//! let coords_polygon = vec![
//!     vec![(-1., -1., 3.0), (1., -1., 3.0), (1., 1., 3.0), (-1., 1., 3.0), (-1., -1., 3.0)], // Exterior ring
//!     vec![(0.1, 0.1, 3.0), (0.1, 0.9, 3.0), (0.9, 0.9, 3.0), (0.9, 0.1, 3.0), (0.1, 0.1, 3.0)], // 1 interior ring
//! ];
//!
//! // .. by using the CoordSeq enum variants to match the wanted SFCGAL geometry type:
//! let line_3d = CoordSeq::Linestring(coords_linestring).to_sfcgal()?;
//! let polygon_3d = CoordSeq::Polygon(coords_polygon).to_sfcgal()?;
//!
//! // ..
//! assert!(line_3d.intersects_3d(&polygon_3d)?);
//! let intersection = line_3d.intersection_3d(&polygon_3d)?;
//!
//! // Get the geojson representation of the geometry with 3-member coordinates :
//! let geom = intersection.to_geojson::<Point3d>()?;
//! // Or the wkt representation with a floating precision of 1 :
//! let wkt = intersection.to_wkt_decim(1)?;
//! # Ok(())
//! # }
//! # fn main() { fun().unwrap(); }
//! ```

#[macro_use]
extern crate anyhow;
#[macro_use]
extern crate enum_primitive_derive;
#[allow(unused_imports)]
#[macro_use]
extern crate approx;

use sfcgal_sys::sfcgal_version;

mod conversion;
mod errors;
mod geometry;
mod utils;
pub use conversion::{CoordSeq, FromGeoJSON, ToGeoJSON, TryInto};
pub use errors::Result;
pub use geometry::{GeomType, SFCGeometry};

/// Type alias for manipulating 2d coordinates, represented as (x, y).
pub type Point2d = (f64, f64);

/// Type alias for manipulating 3d coordinates, represented as (x, y, z).
pub type Point3d = (f64, f64, f64);

/// Convert object to a [`SFCGeometry`] (implemented on [`CoordSeq`] and [geo-types](https://docs.rs/geo-types/) geometries)
///
/// [`SFCGeometry`]: struct.SFCGeometry.html
/// [`CoordSeq`]: enum.CoordSeq.html
pub trait ToSFCGAL {
    fn to_sfcgal(&self) -> Result<SFCGeometry>;
}

/// Convert object to a [`CoordSeq`] holding coordinates and informations about geometry type.
///
/// [`CoordSeq`]: enum.CoordSeq.html
pub trait ToCoordinates {
    fn to_coordinates<T>(&self) -> Result<CoordSeq<T>>
    where
        T: conversion::CoordType + conversion::FromSFCGALGeom;
}

/// Display SFCGAL version information.
pub fn version() -> String {
    utils::_string(unsafe { sfcgal_version() })
}

#[cfg(test)]
mod tests {
    use super::version;
    #[test]
    fn display_version() {
        assert!(version().contains("1.5."));
    }
}