@giro3d/giro3d NPM

Supported data sources

giro3d is powered by OpenLayers for maps, and Three.js for 3d assets, and can be easily extended to support more. Below is a non-exhaustive list of supported data sources.

Maps

Elevation data

DEM/DTM/DSM through WMTS

Vector data

3D assets

3D Tiles for optimized massive 3D datasets, including point clouds
glTF for individual models
Potree point clouds

Getting started

To install with npm (recommended method):

npm install --save @giro3d/giro3d

This package contains transpiled sources of giro3d (compatible with most browsers).

If you're using a module bundler (like wepback) or plan on targeting recent enough browser, you can directly import it as such:

import Instance from '@giro3d/giro3d/Core/Instance.js';

You can also import the original, untranspiled sources, by adding src after @giro3d/giro3d/ :

import Instance from '@giro3d/giro3d/src/Core/Instance.js';

This will probably limit browser compatibility though, without application specific process or loader. Also, non .js files (such as .glsl files) will need to be inlined at client application level.

From a release bundle

See our release page.

With npm link

This is handy if you need to develop on giro3d alongside your project. You need to first prepare the package folder and link from there:

npm run build-package
cd build/giro3d
npm link
# then in your project folder
npm link @giro3d/giro3d

To ease development, files can be automatically transpiled on modification with the watch script :

npm run watch

Each time a source file is modified, this script will transpile it in the build folder.

Tests

To run the test suite:

npm test

API documentation and examples

Browse the API Documentation documentation or check the examples.

Contributors

giro3d has received contributions from people listed in CONTRIBUTORS.md. If you are interested in contributing to giro3d, please read CONTRIBUTING.md.