diff --git a/Apps/Sandcastle/gallery/ProxyHeightmap.html b/Apps/Sandcastle/gallery/ProxyHeightmap.html new file mode 100644 index 00000000000..2b7c40beeeb --- /dev/null +++ b/Apps/Sandcastle/gallery/ProxyHeightmap.html @@ -0,0 +1,74 @@ + + + + + + + + + Cesium Demo + + + + + + +
+

Loading...

+
+
+
+
+
+ + + diff --git a/Source/Core/ProxyHeightmapTerrainProvider.js b/Source/Core/ProxyHeightmapTerrainProvider.js new file mode 100644 index 00000000000..8951ebf5e9b --- /dev/null +++ b/Source/Core/ProxyHeightmapTerrainProvider.js @@ -0,0 +1,205 @@ +import when from '../ThirdParty/when.js'; +import defaultValue from './defaultValue.js'; +import defined from './defined.js'; +import DeveloperError from './DeveloperError.js'; +import Ellipsoid from './Ellipsoid.js'; +import Event from './Event.js'; +import GeographicTilingScheme from './GeographicTilingScheme.js'; +import HeightmapTerrainData from './HeightmapTerrainData.js'; +import TerrainProvider from './TerrainProvider.js'; + + /** + * A simple {@link TerrainProvider} that gets heightmap geometry from a callback function. + * + * @alias ProxyHeightmapTerrainProvider + * @constructor + * + * @param {Object} [options] Object with the following properties: + * @param {TilingScheme} [options.tilingScheme] The tiling scheme specifying how the ellipsoidal + * surface is broken into tiles. If this parameter is not provided, a {@link GeographicTilingScheme} + * is used. + * @param {Ellipsoid} [options.ellipsoid] The ellipsoid. If the tilingScheme is specified, + * this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither + * parameter is specified, the WGS84 ellipsoid is used. + * @param {Function} [options.callback] The callback function for requesting tiles. The function + * is passed the x, y, and level of the tile and returns a promise to a Float32Array, width, and height. + * + * @see TerrainProvider + */ + function ProxyHeightmapTerrainProvider(options) { + options = defaultValue(options, defaultValue.EMPTY_OBJECT); + + //>>includeStart('debug', pragmas.debug); + if (!defined(options.callback)) { + throw new DeveloperError('options.callback is required.'); + } + //>>includeEnd('debug'); + + this._callback = options.callback; + + this._tilingScheme = options.tilingScheme; + if (!defined(this._tilingScheme)) { + this._tilingScheme = new GeographicTilingScheme({ + ellipsoid : defaultValue(options.ellipsoid, Ellipsoid.WGS84) + }); + } + + // Note: the 64 below does NOT need to match the actual vertex dimensions, because + // the ellipsoid is significantly smoother than actual terrain. + this._levelZeroMaximumGeometricError = TerrainProvider.getEstimatedLevelZeroGeometricErrorForAHeightmap(this._tilingScheme.ellipsoid, 64, this._tilingScheme.getNumberOfXTilesAtLevel(0)); + + this._errorEvent = new Event(); + this._readyPromise = when.resolve(true); + } + + Object.defineProperties(ProxyHeightmapTerrainProvider.prototype, { + /** + * Gets an event that is raised when the terrain provider encounters an asynchronous error. By subscribing + * to the event, you will be notified of the error and can potentially recover from it. Event listeners + * are passed an instance of {@link TileProviderError}. + * @memberof ProxyHeightmapTerrainProvider.prototype + * @type {Event} + */ + errorEvent : { + get : function() { + return this._errorEvent; + } + }, + + /** + * Gets the credit to display when this terrain provider is active. Typically this is used to credit + * the source of the terrain. This function should not be called before {@link ProxyHeightmapTerrainProvider#ready} returns true. + * @memberof ProxyHeightmapTerrainProvider.prototype + * @type {Credit} + */ + credit : { + get : function() { + return undefined; + } + }, + + /** + * Gets the tiling scheme used by this provider. This function should + * not be called before {@link ProxyHeightmapTerrainProvider#ready} returns true. + * @memberof ProxyHeightmapTerrainProvider.prototype + * @type {GeographicTilingScheme} + */ + tilingScheme : { + get : function() { + return this._tilingScheme; + } + }, + + /** + * Gets a value indicating whether or not the provider is ready for use. + * @memberof ProxyHeightmapTerrainProvider.prototype + * @type {Boolean} + */ + ready : { + get : function() { + return true; + } + }, + + /** + * Gets a promise that resolves to true when the provider is ready for use. + * @memberof ProxyHeightmapTerrainProvider.prototype + * @type {Promise.} + * @readonly + */ + readyPromise : { + get : function() { + return this._readyPromise; + } + }, + + /** + * Gets a value indicating whether or not the provider includes a water mask. The water mask + * indicates which areas of the globe are water rather than land, so they can be rendered + * as a reflective surface with animated waves. This function should not be + * called before {@link ProxyHeightmapTerrainProvider#ready} returns true. + * @memberof ProxyHeightmapTerrainProvider.prototype + * @type {Boolean} + */ + hasWaterMask : { + get : function() { + return false; + } + }, + + /** + * Gets a value indicating whether or not the requested tiles include vertex normals. + * This function should not be called before {@link ProxyHeightmapTerrainProvider#ready} returns true. + * @memberof ProxyHeightmapTerrainProvider.prototype + * @type {Boolean} + */ + hasVertexNormals : { + get : function() { + return false; + } + } + }); + + /** + * Requests the geometry for a given tile. This function should not be called before + * {@link TerrainProvider#ready} returns true. The result includes terrain + * data and indicates that all child tiles are available. + * + * @param {Number} x The X coordinate of the tile for which to request geometry. + * @param {Number} y The Y coordinate of the tile for which to request geometry. + * @param {Number} level The level of the tile for which to request geometry. + * @param {Request} [request] The request object. Intended for internal use only. + * + * @returns {Promise.|undefined} A promise for the requested geometry. If this method + * returns undefined instead of a promise, it is an indication that too many requests are already + * pending and the request will be retried later. + */ + ProxyHeightmapTerrainProvider.prototype.requestTileGeometry = function(x, y, level, request) { + var promise = this._callback(x, y, level); + if (!defined(promise)) { + return undefined; + } + + return when(promise).then(function(result) { + return new HeightmapTerrainData({ + buffer : result.buffer, + width : result.width, + height : result.height + }); + }); + }; + + /** + * Gets the maximum geometric error allowed in a tile at a given level. + * + * @param {Number} level The tile level for which to get the maximum geometric error. + * @returns {Number} The maximum geometric error. + */ + ProxyHeightmapTerrainProvider.prototype.getLevelMaximumGeometricError = function(level) { + return this._levelZeroMaximumGeometricError / (1 << level); + }; + + /** + * Determines whether data for a tile is available to be loaded. + * + * @param {Number} x The X coordinate of the tile for which to request geometry. + * @param {Number} y The Y coordinate of the tile for which to request geometry. + * @param {Number} level The level of the tile for which to request geometry. + * @returns {Boolean} Undefined if not supported, otherwise true or false. + */ + ProxyHeightmapTerrainProvider.prototype.getTileDataAvailable = function(x, y, level) { + return undefined; + }; + + /** + * Makes sure we load availability data for a tile + * + * @param {Number} x The X coordinate of the tile for which to request geometry. + * @param {Number} y The Y coordinate of the tile for which to request geometry. + * @param {Number} level The level of the tile for which to request geometry. + * @returns {undefined|Promise} Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded + */ + ProxyHeightmapTerrainProvider.prototype.loadTileDataAvailability = function(x, y, level) { + return undefined; + }; +export default ProxyHeightmapTerrainProvider;