@giro3d/giro3d
Advanced tools
 |  |  |
|---|---|---|
 |  |  |
Giro3D is a Web library written in TypeScript to build 2D and 3D geospatial scenes. It is powered by three.js and WebGL. It aims to support major geospatial standards and provide a rich feature set to help visualize data in a 3D environment.
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.
.pnts tiles (you can generate them with py3dtiles)💡 To test Giro3D without installing anything, check the interactive examples.
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.
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, Région Auvergne-Rhône-Alpes.
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.
v0.42.0 (2025-02-10)
This release integrates the 3d-tiles-renderer package into Giro3D. This enables a much better support for the 3D Tiles format, including the 3D Tiles 1.1 specification. This makes it very easy to load Google Photorealistic 3D Tiles into Giro3D !
Maps now support light-based shadows and lighting provided by three.js lights, in addition to the hillshade mode (which is still the default mode). When using this mode, the terrain is shaded by all directional and point lights in the scene. This allows for light-based simulations such as sun shadows for a given time of day for example.
Map lighting and shading options have changed:
entities/ rather than core/MapLightingOptionshillshade (e.g
hillshadeAzimuth, hillshadeIntensity...)The Tiles3D entity's API has changed and the
Tiles3DSource class is removed. Please refer to the API documentation
for more information.
The ColorMap constructor now uses named parameters
rather than positional parameters, i.e new ColorMap({ colors, min, max })
ColorMap and ColorMapMode are moved from /core/layer/ into /core since they don't apply only to layers.
"label-created" event to customize the DOM label after creation.clone() method.brightness, .constrast and .saturation propertiesFAQs
A JS/WebGL framework for 3D geospatial data visualization
The npm package @giro3d/giro3d receives a total of 934 weekly downloads. As such, @giro3d/giro3d popularity was classified as not popular.
We found that @giro3d/giro3d demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.