three-geojson-geometry

ThreeJS GeoJSON Geometry
========================

[![NPM package][npm-img]][npm-url]
[![Build Size][build-size-img]][build-size-url]
[![NPM Downloads][npm-downloads-img]][npm-downloads-url]

A ThreeJS geometry class for stroking GeoJSON objects on a sphere.

Quick start

``js
import GeoJsonGeometry from 'three-geojson-geometry';
`
or using a script tag
`html

`
then
`js
const myLine = new THREE.Line(
new GeoJsonGeometry(geoJson),
new THREE.LineBasicMaterial({ color: 'blue' })
);

`

API reference

$3

GeoJsonGeometry(geoJson: GeoJson object, radius: Float, resolution: Float)

* geoJson: A GeoJson geometry object. It's recommended to split the geometries at the anti-meridian. Each coordinates point is expected to include longitude and latitude in that order. Altitude may be included as a third optional element, interpreted as elevation above the surface in regular cartesian units.
* radius: Radius of the sphere surface to draw the poygon on. Default is 1.
* resolution: Resolution of the sphere, in lat/lng degrees. If the angular distance between two adjacent line points is larger than this value, the line segment will be interpolated in order to approximate the curvature of the sphere surface. Lower values yield more perfectly curved lines, at the cost of performance. Default is 5.

$3

.parameters: Object

An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.

$3

When generating Polygon or MultiPolygon geometries, two groups are provided to which different materials can be applied.

* 0: The outer ring of the polygon.
* 1: The polygon inner holes (if any).

$3

Different geoJson types should be represented using different ThreeJS object types:
* Point and MultiPoints - Use THREE.Points
* LineString and Polygon - Use THREE.Line
* MultiLineString and MultiPolygon - Use THREE.LineSegments`

[npm-img]: https://img.shields.io/npm/v/three-geojson-geometry
[npm-url]: https://npmjs.org/package/three-geojson-geometry
[build-size-img]: https://img.shields.io/bundlephobia/minzip/three-geojson-geometry
[build-size-url]: https://bundlephobia.com/result?p=three-geojson-geometry
[npm-downloads-img]: https://img.shields.io/npm/dt/three-geojson-geometry
[npm-downloads-url]: https://www.npmtrends.com/three-geojson-geometry