/**
* @module
*/
import olGeomPoint from 'ol/geom/Point';
import googAsserts from 'goog/asserts';
import olProj from 'ol/proj';
import olEvents from 'ol/events';
import olMapBrowserEventType from 'ol/MapBrowserEventType';
import olcsUtil from './util.js';
import olcsCore from './core.js';
import olcsAutoRenderLoop from './AutoRenderLoop.js';
import olcsCamera from './Camera.js';
import olcsRasterSynchronizer from './RasterSynchronizer.js';
import olcsVectorSynchronizer from './VectorSynchronizer.js';
import olcsOverlaySynchronizer from './OverlaySynchronizer.js';
const exports = function(options) {
/**
* @type {olcs.AutoRenderLoop}
* @private
*/
this.autoRenderLoop_ = null;
/**
* @type {!ol.Map}
* @private
*/
this.map_ = options.map;
/**
* @type {!function(): Cesium.JulianDate}
* @private
*/
this.time_ = options.time || function() {
return Cesium.JulianDate.now();
};
/**
* No change of the view projection.
* @private
*/
this.to4326Transform_ = olProj.getTransform(this.map_.getView().getProjection(), 'EPSG:4326');
/**
* @type {number}
* @private
*/
this.resolutionScale_ = 1.0;
/**
* @type {number}
* @private
*/
this.canvasClientWidth_ = 0.0;
/**
* @type {number}
* @private
*/
this.canvasClientHeight_ = 0.0;
/**
* @type {boolean}
* @private
*/
this.resolutionScaleChanged_ = true; // force resize
const fillArea = 'position:absolute;top:0;left:0;width:100%;height:100%;';
/**
* @type {!Element}
* @private
*/
this.container_ = document.createElement('DIV');
const containerAttribute = document.createAttribute('style');
containerAttribute.value = `${fillArea}visibility:hidden;`;
this.container_.setAttributeNode(containerAttribute);
let targetElement = options.target || null;
if (targetElement) {
if (typeof targetElement === 'string') {
targetElement = document.getElementById(targetElement);
}
targetElement.appendChild(this.container_);
} else {
const oc = this.map_.getViewport().querySelector('.ol-overlaycontainer');
if (oc && oc.parentNode) {
oc.parentNode.insertBefore(this.container_, oc);
}
}
/**
* Whether the Cesium container is placed over the ol map.
* @type {boolean}
* @private
*/
this.isOverMap_ = !targetElement;
if (this.isOverMap_ && options.stopOpenLayersEventsPropagation) {
const overlayEvents = [
olEvents.EventType.CLICK,
olEvents.EventType.DBLCLICK,
olEvents.EventType.MOUSEDOWN,
olEvents.EventType.TOUCHSTART,
olEvents.EventType.MSPOINTERDOWN,
olMapBrowserEventType.POINTERDOWN,
olEvents.EventType.MOUSEWHEEL,
olEvents.EventType.WHEEL
];
for (let i = 0, ii = overlayEvents.length; i < ii; ++i) {
olEvents.listen(this.container_, overlayEvents[i], olEvents.Event.stopPropagation);
}
}
/**
* @type {!HTMLCanvasElement}
* @private
*/
this.canvas_ = /** @type {!HTMLCanvasElement} */ (document.createElement('CANVAS'));
const canvasAttribute = document.createAttribute('style');
canvasAttribute.value = fillArea;
this.canvas_.setAttributeNode(canvasAttribute);
if (olcsUtil.supportsImageRenderingPixelated()) {
// non standard CSS4
this.canvas_.style['imageRendering'] = olcsUtil.imageRenderingValue();
}
this.canvas_.oncontextmenu = function() { return false; };
this.canvas_.onselectstart = function() { return false; };
this.container_.appendChild(this.canvas_);
/**
* @type {boolean}
* @private
*/
this.enabled_ = false;
/**
* @type {!Array.<ol.interaction.Interaction>}
* @private
*/
this.pausedInteractions_ = [];
/**
* @type {?ol.layer.Group}
* @private
*/
this.hiddenRootGroup_ = null;
const sceneOptions = options.sceneOptions !== undefined ? options.sceneOptions :
/** @type {Cesium.SceneOptions} */ ({});
sceneOptions.canvas = this.canvas_;
sceneOptions.scene3DOnly = true;
/**
* @type {!Cesium.Scene}
* @private
*/
this.scene_ = new Cesium.Scene(sceneOptions);
const sscc = this.scene_.screenSpaceCameraController;
sscc.tiltEventTypes.push({
'eventType': Cesium.CameraEventType.LEFT_DRAG,
'modifier': Cesium.KeyboardEventModifier.SHIFT
});
sscc.tiltEventTypes.push({
'eventType': Cesium.CameraEventType.LEFT_DRAG,
'modifier': Cesium.KeyboardEventModifier.ALT
});
sscc.enableLook = false;
this.scene_.camera.constrainedAxis = Cesium.Cartesian3.UNIT_Z;
/**
* @type {!olcs.Camera}
* @private
*/
this.camera_ = new olcsCamera(this.scene_, this.map_);
/**
* @type {!Cesium.Globe}
* @private
*/
this.globe_ = new Cesium.Globe(Cesium.Ellipsoid.WGS84);
this.globe_.baseColor = Cesium.Color.WHITE;
this.scene_.globe = this.globe_;
this.scene_.skyAtmosphere = new Cesium.SkyAtmosphere();
this.dataSourceCollection_ = new Cesium.DataSourceCollection();
this.dataSourceDisplay_ = new Cesium.DataSourceDisplay({
scene: this.scene_,
dataSourceCollection: this.dataSourceCollection_
});
const synchronizers = options.createSynchronizers ?
options.createSynchronizers(this.map_, this.scene_, this.dataSourceCollection_) : [
new olcsRasterSynchronizer(this.map_, this.scene_),
new olcsVectorSynchronizer(this.map_, this.scene_),
new olcsOverlaySynchronizer(this.map_, this.scene_)
];
// Assures correct canvas size after initialisation
this.handleResize_();
for (let i = synchronizers.length - 1; i >= 0; --i) {
synchronizers[i].synchronize();
}
if (this.isOverMap_) {
// if in "stacked mode", hide everything except canvas (including credits)
const credits = this.canvas_.nextElementSibling;
if (credits) {
credits.style.display = 'none';
}
}
/**
* Time of the last rendered frame, as returned by `performance.now()`.
* @type {number}
* @private
*/
this.lastFrameTime_ = 0;
/**
* The identifier returned by `requestAnimationFrame`.
* @type {number|undefined}
* @private
*/
this.renderId_ = undefined;
/**
* Target frame rate for the render loop.
* @type {number}
* @private
*/
this.targetFrameRate_ = Number.POSITIVE_INFINITY;
/**
* If the Cesium render loop is being blocked.
* @type {boolean}
* @private
*/
this.blockCesiumRendering_ = false;
/**
* If the warmup routine is active.
* @type {boolean}
* @private
*/
this.warmingUp_ = false;
/**
* @type {ol.Feature}
* @private
*/
this.trackedFeature_ = null;
/**
* @type {Cesium.Entity}
* @private
*/
this.trackedEntity_ = null;
/**
* @type {Cesium.EntityView}
* @private
*/
this.entityView_ = null;
/**
* @type {boolean}
* @private
*/
this.needTrackedEntityUpdate_ = false;
/**
* @type {!Cesium.BoundingSphere}
*/
this.boundingSphereScratch_ = new Cesium.BoundingSphere();
const eventHelper = new Cesium.EventHelper();
eventHelper.add(this.scene_.postRender, exports.prototype.updateTrackedEntity_, this);
// Cesium has a mechanism to prevent the camera to go under the terrain.
// Unfortunately, it is only active when all the terrain has been loaded, which:
// - does not prevent the camera to sink under terrain anymore;
// - introduce a jumping effect once all terrain has been loaded and the position of the camera is finally fixed.
// The property below enables a workaround found in the Camptocamp Cesium fork.
// See also https://github.com/AnalyticalGraphicsInc/cesium/issues/5999.
Cesium.Camera.enableSuspendTerrainAdjustment = false;
};
Object.defineProperties(exports.prototype, {
'trackedFeature': {
'get': /** @this {olcs.OLCesium} */ function() {
return this.trackedFeature_;
},
'set': /** @this {olcs.OLCesium} */ function(feature) {
if (this.trackedFeature_ !== feature) {
const scene = this.scene_;
//Stop tracking
if (!feature || !feature.getGeometry()) {
this.needTrackedEntityUpdate_ = false;
scene.screenSpaceCameraController.enableTilt = true;
if (this.trackedEntity_) {
this.dataSourceDisplay_.defaultDataSource.entities.remove(this.trackedEntity_);
}
this.trackedEntity_ = null;
this.trackedFeature_ = null;
this.entityView_ = null;
scene.camera.lookAtTransform(Cesium.Matrix4.IDENTITY);
return;
}
this.trackedFeature_ = feature;
//We can't start tracking immediately, so we set a flag and start tracking
//when the bounding sphere is ready (most likely next frame).
this.needTrackedEntityUpdate_ = true;
const to4326Transform = this.to4326Transform_;
const toCesiumPosition = function() {
const geometry = feature.getGeometry();
googAsserts.assertInstanceof(geometry, olGeomPoint);
const coo = geometry.getCoordinates();
const coo4326 = to4326Transform(coo, undefined, coo.length);
return olcsCore.ol4326CoordinateToCesiumCartesian(coo4326);
};
// Create an invisible point entity for tracking.
// It is independant from the primitive/geometry created by the vector synchronizer.
const options = {
'position': new Cesium.CallbackProperty((time, result) => toCesiumPosition(), false),
'point': {
'pixelSize': 1,
'color': Cesium.Color.TRANSPARENT
}
};
this.trackedEntity_ = this.dataSourceDisplay_.defaultDataSource.entities.add(options);
}
}
}
});
/**
* Render the Cesium scene.
* @private
*/
exports.prototype.render_ = function() {
// if a call to `requestAnimationFrame` is pending, cancel it
if (this.renderId_ !== undefined) {
cancelAnimationFrame(this.renderId_);
this.renderId_ = undefined;
}
// only render if Cesium is enabled/warming and rendering hasn't been blocked
if ((this.enabled_ || this.warmingUp_) && !this.blockCesiumRendering_) {
this.renderId_ = requestAnimationFrame(this.onAnimationFrame_.bind(this));
}
};
/**
* Callback for `requestAnimationFrame`.
* @param {number} frameTime The frame time, from `performance.now()`.
* @private
*/
exports.prototype.onAnimationFrame_ = function(frameTime) {
this.renderId_ = undefined;
// check if a frame was rendered within the target frame rate
const interval = 1000.0 / this.targetFrameRate_;
const delta = frameTime - this.lastFrameTime_;
if (delta < interval) {
// too soon, don't render yet
this.render_();
return;
}
// time to render a frame, save the time
this.lastFrameTime_ = frameTime;
const julianDate = this.time_();
this.scene_.initializeFrame();
this.handleResize_();
this.dataSourceDisplay_.update(julianDate);
// Update tracked entity
if (this.entityView_) {
const trackedEntity = this.trackedEntity_;
const trackedState = this.dataSourceDisplay_.getBoundingSphere(trackedEntity, false, this.boundingSphereScratch_);
if (trackedState === Cesium.BoundingSphereState.DONE) {
this.boundingSphereScratch_.radius = 1; // a radius of 1 is enough for tracking points
this.entityView_.update(julianDate, this.boundingSphereScratch_);
}
}
this.scene_.render(julianDate);
this.camera_.checkCameraChange();
// request the next render call after this one completes to ensure the browser doesn't get backed up
this.render_();
};
/**
* @private
*/
exports.prototype.updateTrackedEntity_ = function() {
if (!this.needTrackedEntityUpdate_) {
return;
}
const trackedEntity = this.trackedEntity_;
const scene = this.scene_;
const state = this.dataSourceDisplay_.getBoundingSphere(trackedEntity, false, this.boundingSphereScratch_);
if (state === Cesium.BoundingSphereState.PENDING) {
return;
}
scene.screenSpaceCameraController.enableTilt = false;
const bs = state !== Cesium.BoundingSphereState.FAILED ? this.boundingSphereScratch_ : undefined;
if (bs) {
bs.radius = 1;
}
this.entityView_ = new Cesium.EntityView(trackedEntity, scene, scene.mapProjection.ellipsoid);
this.entityView_.update(this.time_(), bs);
this.needTrackedEntityUpdate_ = false;
};
/**
* @private
*/
exports.prototype.handleResize_ = function() {
let width = this.canvas_.clientWidth;
let height = this.canvas_.clientHeight;
if (width === 0 | height === 0) {
// The canvas DOM element is not ready yet.
return;
}
if (width === this.canvasClientWidth_ &&
height === this.canvasClientHeight_ &&
!this.resolutionScaleChanged_) {
return;
}
let resolutionScale = this.resolutionScale_;
if (!olcsUtil.supportsImageRenderingPixelated()) {
resolutionScale *= window.devicePixelRatio || 1.0;
}
this.resolutionScaleChanged_ = false;
this.canvasClientWidth_ = width;
this.canvasClientHeight_ = height;
width *= resolutionScale;
height *= resolutionScale;
this.canvas_.width = width;
this.canvas_.height = height;
this.scene_.camera.frustum.aspectRatio = width / height;
};
/**
* @return {!olcs.Camera}
* @api
*/
exports.prototype.getCamera = function() {
return this.camera_;
};
/**
* @return {!ol.Map}
* @api
*/
exports.prototype.getOlMap = function() {
return this.map_;
};
/**
* @return {!ol.View}
* @api
*/
exports.prototype.getOlView = function() {
const view = this.map_.getView();
googAsserts.assert(view);
return view;
};
/**
* @return {!Cesium.Scene}
* @api
*/
exports.prototype.getCesiumScene = function() {
return this.scene_;
};
/**
* @return {!Cesium.DataSourceCollection}
* @api
*/
exports.prototype.getDataSources = function() {
return this.dataSourceCollection_;
};
/**
* @return {!Cesium.DataSourceDisplay}
* @api
*/
exports.prototype.getDataSourceDisplay = function() {
return this.dataSourceDisplay_;
};
/**
* @return {boolean}
* @api
*/
exports.prototype.getEnabled = function() {
return this.enabled_;
};
/**
* Enables/disables the Cesium.
* This modifies the visibility style of the container element.
* @param {boolean} enable
* @api
*/
exports.prototype.setEnabled = function(enable) {
if (this.enabled_ === enable) {
return;
}
this.enabled_ = enable;
// some Cesium operations are operating with canvas.clientWidth,
// so we can't remove it from DOM or even make display:none;
this.container_.style.visibility = this.enabled_ ? 'visible' : 'hidden';
let interactions;
if (this.enabled_) {
this.throwOnUnitializedMap_();
if (this.isOverMap_) {
interactions = this.map_.getInteractions();
interactions.forEach(function(el, i, arr) {
this.pausedInteractions_.push(el);
}, this);
interactions.clear();
const rootGroup = this.map_.getLayerGroup();
if (rootGroup.getVisible()) {
this.hiddenRootGroup_ = rootGroup;
this.hiddenRootGroup_.setVisible(false);
}
this.map_.getOverlayContainer().classList.add('olcs-hideoverlay');
this.map_.getOverlayContainerStopEvent().classList.add('olcs-hideoverlay');
}
this.camera_.readFromView();
this.render_();
} else {
if (this.isOverMap_) {
interactions = this.map_.getInteractions();
this.pausedInteractions_.forEach((interaction) => {
interactions.push(interaction);
});
this.pausedInteractions_.length = 0;
this.map_.getOverlayContainer().classList.remove('olcs-hideoverlay');
this.map_.getOverlayContainerStopEvent().classList.remove('olcs-hideoverlay');
if (this.hiddenRootGroup_) {
this.hiddenRootGroup_.setVisible(true);
this.hiddenRootGroup_ = null;
}
}
this.camera_.updateView();
}
};
/**
* Preload Cesium so that it is ready when transitioning from 2D to 3D.
* @param {number} height Target height of the camera
* @param {number} timeout Milliseconds after which the warming will stop
* @api
*/
exports.prototype.warmUp = function(height, timeout) {
if (this.enabled_) {
// already enabled
return;
}
this.throwOnUnitializedMap_();
this.camera_.readFromView();
const ellipsoid = this.globe_.ellipsoid;
const csCamera = this.scene_.camera;
const position = ellipsoid.cartesianToCartographic(csCamera.position);
if (position.height < height) {
position.height = height;
csCamera.position = ellipsoid.cartographicToCartesian(position);
}
this.warmingUp_ = true;
this.render_();
setTimeout(() => {
this.warmingUp_ = false;
}, timeout);
};
/**
* Block Cesium rendering to save resources.
* @param {boolean} block True to block.
* @api
*/
exports.prototype.setBlockCesiumRendering = function(block) {
if (this.blockCesiumRendering_ !== block) {
this.blockCesiumRendering_ = block;
// reset the render loop
this.render_();
}
};
/**
* Render the globe only when necessary in order to save resources.
* Experimental.
* @api
*/
exports.prototype.enableAutoRenderLoop = function() {
if (!this.autoRenderLoop_) {
this.autoRenderLoop_ = new olcsAutoRenderLoop(this, false);
}
};
/**
* Get the autorender loop.
* @return {?olcs.AutoRenderLoop}
* @api
*/
exports.prototype.getAutoRenderLoop = function() {
return this.autoRenderLoop_;
};
/**
* The 3D Cesium globe is rendered in a canvas with two different dimensions:
* clientWidth and clientHeight which are the dimension on the screen and
* width and height which are the dimensions of the drawing buffer.
*
* By using a resolution scale lower than 1.0, it is possible to render the
* globe in a buffer smaller than the canvas client dimensions and improve
* performance, at the cost of quality.
*
* Pixel ratio should also be taken into account; by default, a device with
* pixel ratio of 2.0 will have a buffer surface 4 times bigger than the client
* surface.
*
* @param {number} value
* @this {olcs.OLCesium}
* @api
*/
exports.prototype.setResolutionScale = function(value) {
value = Math.max(0, value);
if (value !== this.resolutionScale_) {
this.resolutionScale_ = Math.max(0, value);
this.resolutionScaleChanged_ = true;
if (this.autoRenderLoop_) {
this.autoRenderLoop_.restartRenderLoop();
}
}
};
/**
* Set the target frame rate for the renderer. Set to `Number.POSITIVE_INFINITY`
* to render as quickly as possible.
* @param {number} value The frame rate, in frames per second.
* @api
*/
exports.prototype.setTargetFrameRate = function(value) {
if (this.targetFrameRate_ !== value) {
this.targetFrameRate_ = value;
// reset the render loop
this.render_();
}
};
/**
* Check if OpenLayers map is not properly initialized.
* @private
*/
exports.prototype.throwOnUnitializedMap_ = function() {
const map = this.map_;
const view = map.getView();
const center = view.getCenter();
if (!view.isDef() || isNaN(center[0]) || isNaN(center[1])) {
throw new Error(`The OpenLayers map is not properly initialized: ${center} / ${view.getResolution()}`);
}
};
export default exports;