osrm-backend/third_party/geometry.hpp-0.9.2/README.md
2018-04-27 05:21:08 +02:00

84 lines
2.1 KiB
Markdown

# geometry.hpp
Provides header-only, generic C++ interfaces for geometry types, geometry collections, and features.
- `mapbox::geometry::point`
- `mapbox::geometry::multi_point`
- `mapbox::geometry::line_string`
- `mapbox::geometry::multi_line_string`
- `mapbox::geometry::polygon`
- `mapbox::geometry::multi_polygon`
- `mapbox::geometry::geometry_collection`
- `mapbox::geometry::feature` (experimental)
### Design
These types are designed to be easy to parse and serialize to [GeoJSON](http://geojson.org/).
They should also be a robust and high performance container for data processing and conversion.
### Goals
- Header-only
- Fast compile
- c++11/c++14 compatibility
- No external dependencies for usage of core types (point, line_string, etc)
- Minimal dependencies for usage of enclosing `geometry` type (`mapbox::variant`)
- Easily [adaptable to `boost::geometry`](http://www.boost.org/doc/libs/1_56_0/libs/geometry/doc/html/geometry/examples/example__adapting_a_legacy_geometry_object_model.html)
### Usage
Using a single type directly (requires no external dependencies):
```cpp
#include <mapbox/geometry/point.hpp>
#include <iostream>
using mapbox::geometry::point;
int main() {
point<double> pt(1.0,0.0);
std::clog << "x: " << pt.x << " y: " << pt.y << "\n";
}
```
Creating a geometry collection (depends on https://github.com/mapbox/variant):
```cpp
#include <mapbox/geometry/geometry.hpp>
#include <mapbox/variant.hpp>
#include <iostream>
using mapbox::geometry::geometry_collection;
using mapbox::geometry::geometry;
using mapbox::geometry::point;
using point_type = point<double>;
struct printer
{
printer() {}
void operator()(point_type const& pt) const
{
std::clog << "x: " << pt.x << " y: " << pt.y << "\n";
}
template <typename T>
void operator()(T const& g) const
{
std::clog << "encountered non-point geometry\n";
}
};
int main() {
geometry_collection<double> gc;
gc.emplace_back(point_type(1.0,0.0));
geometry<double> const& geom = gc.at(0);
printer visitor;
mapbox::util::apply_visitor(visitor,geom);
}
```