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.
- DEM/DTM/DSM through WMTS
- 3D Tiles for optimized massive 3D datasets, including point clouds
- glTF for individual models
- Potree point clouds
To install with npm (recommended method):
npm install --save @giro3d/giro3d
This package contains both original sources (under src/
) and slightly processed sources (dead code elimination, inlining shader code...).
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.
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 make-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.
To run the test suite:
npm test
Browse the API Documentation documentation or check the examples.
Giro3D has received contributions and sponsoring from people and organizations listed in CONTRIBUTORS.md. If you are interested in contributing to Giro3D, please read CONTRIBUTING.md.
Giro3D is the successor of iTowns, an original work from IGN and MATIS research laboratory. It has been funded through various research programs involving the French National Research Agency, Cap Digital, The Sorbonne University, Mines ParisTech, CNRS, IFSTTAR.
Giro3D is currently maintained by Oslandia.
In case you don't want to code your own application, you can also use Piero, our sister project - also available on GitLab.
The name is a reference to the italian mathematician and inventor Girolamo Cardano.