This package has been deprecated
The project has been renamed. Please use ol-cesium instead
Switch smoothly between 2D and 3D and synchronize:
- Map context (bounding box and zoom level);
- Raster data sources;
- Vector data sources in 2D and 3D;
- Map selection (selected items).
The library is configurable and extensible and allows:
- Lazy or eager loading of Cesium
- Limiting Cesium resource consumption (idle detection)
Stay tuned for more exciting features like animated transitions between map and globe view, and synchronization of maps in projections other than EPSG:4326 and EPSG:3857.
To obtain Ol-Cesium, either download a release from https://github.com/openlayers/ol-cesium/releases, or clone the repository and build it yourself (see below).
Applications using Ol-Cesium also need to load OpenLayers styles and Cesium resources (included in the distribution):
An OpenLayers map can be switched to a 3d globe view by running the code below after the map has been created:
var ol3d = map: map; // map is the ol.Map instanceol3d;
The above will use the WGS84 ellipsoid all around the globe. To use terrain, simply add a terrain provider using the Cesium API (can be your own, but in the snippet below it's one that ships with Cesium):
var ol3d = map: map; // map is the ol.Map instancevar scene = ol3d;sceneterrainProvider =url: '';ol3d;
Building the library
Requirements for building Ol-Cesium:
To get started, clone the Ol-Cesium repository with its submodules:
$ git clone --recursive https://github.com/openlayers/ol-cesium.git
Change into the clone directory, and invoke
$ make dist
from the root of the repository. You will then be able to use
dist/olcesium.js for your applications.
Running the examples in debug mode
This is useful for contributing to Ol-Cesium, because it loads the source files instead of a minified build:
$ make serve
will make the distribution examples available at http://localhost:4000/examples
Running the unminified version of Cesium
Passing the parameter
?mode=dev to an example will load the debug version of
Cesium instead of the minified one. This is helpful when something breaks inside
Cesium. In distribution mode, an unminified version of OpenLayers and Ol-Cesium is
OpenLayers unmanaged layers are not discoverable and as a consequence not supported. Plain layers should be used instead or the synchronization managed manually. See https://github.com/openlayers/ol-cesium/issues/350.