diff --git a/doc/index.md b/doc/index.md index 431d7c0b4e..f4acd82ff3 100644 --- a/doc/index.md +++ b/doc/index.md @@ -6,7 +6,7 @@ In general every use of OpenLayers starts by initializing a map, then adding th Projections ----------- -A {@link ol.Projection} defines which point on earth is represented by a pair of coordinates. +A {@link ol.proj.Projection} defines which point on earth is represented by a pair of coordinates. Coordinates within OpenLayers can be used in various projections where some common projections are always supported, others can be used via [Proj4js](http://trac.osgeo.org/proj4js/). diff --git a/examples/wms-no-proj.js b/examples/wms-no-proj.js index f85dcbf4d8..d51f7ec345 100644 --- a/examples/wms-no-proj.js +++ b/examples/wms-no-proj.js @@ -1,11 +1,11 @@ goog.require('ol.Attribution'); goog.require('ol.Map'); -goog.require('ol.Projection'); goog.require('ol.ProjectionUnits'); goog.require('ol.RendererHints'); goog.require('ol.View2D'); goog.require('ol.layer.Image'); goog.require('ol.layer.Tile'); +goog.require('ol.proj.Projection'); goog.require('ol.source.ImageWMS'); goog.require('ol.source.TileWMS'); @@ -45,7 +45,7 @@ var layers = [ // A minimal projection object is configured with only the SRS code and the map // units. No client side coordinate transforms are possible with such a // projection object. -var projection = new ol.Projection({ +var projection = new ol.proj.Projection({ code: 'EPSG:21781', units: ol.ProjectionUnits.METERS }); diff --git a/src/ol/control/mousepositioncontrol.js b/src/ol/control/mousepositioncontrol.js index 6933af3bfa..40289563a9 100644 --- a/src/ol/control/mousepositioncontrol.js +++ b/src/ol/control/mousepositioncontrol.js @@ -12,10 +12,10 @@ goog.require('goog.style'); goog.require('ol.CoordinateFormatType'); goog.require('ol.Object'); goog.require('ol.Pixel'); -goog.require('ol.Projection'); goog.require('ol.TransformFunction'); goog.require('ol.control.Control'); goog.require('ol.proj'); +goog.require('ol.proj.Projection'); /** @@ -80,7 +80,7 @@ ol.control.MousePosition = function(opt_options) { /** * @private - * @type {ol.Projection} + * @type {ol.proj.Projection} */ this.mapProjection_ = null; @@ -139,10 +139,10 @@ goog.exportProperty( /** - * @return {ol.Projection|undefined} projection. + * @return {ol.proj.Projection|undefined} projection. */ ol.control.MousePosition.prototype.getProjection = function() { - return /** @type {ol.Projection|undefined} */ ( + return /** @type {ol.proj.Projection|undefined} */ ( this.get(ol.control.MousePositionProperty.PROJECTION)); }; goog.exportProperty( @@ -204,7 +204,7 @@ goog.exportProperty( /** - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. */ ol.control.MousePosition.prototype.setProjection = function(projection) { this.set(ol.control.MousePositionProperty.PROJECTION, projection); diff --git a/src/ol/geolocation.js b/src/ol/geolocation.js index ec5f762690..601baf1599 100644 --- a/src/ol/geolocation.js +++ b/src/ol/geolocation.js @@ -9,7 +9,6 @@ goog.require('goog.events.EventType'); goog.require('goog.math'); goog.require('ol.Coordinate'); goog.require('ol.Object'); -goog.require('ol.Projection'); goog.require('ol.proj'); @@ -254,10 +253,10 @@ goog.exportProperty( /** * Get the projection associated with the position. - * @return {ol.Projection|undefined} projection. + * @return {ol.proj.Projection|undefined} projection. */ ol.Geolocation.prototype.getProjection = function() { - return /** @type {ol.Projection|undefined} */ ( + return /** @type {ol.proj.Projection|undefined} */ ( this.get(ol.GeolocationProperty.PROJECTION)); }; goog.exportProperty( @@ -312,7 +311,7 @@ goog.exportProperty( /** * Set the projection to use for transforming the coordinates. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. */ ol.Geolocation.prototype.setProjection = function(projection) { this.set(ol.GeolocationProperty.PROJECTION, projection); diff --git a/src/ol/imageurlfunction.js b/src/ol/imageurlfunction.js index 9648e1b18c..602c4d0796 100644 --- a/src/ol/imageurlfunction.js +++ b/src/ol/imageurlfunction.js @@ -6,7 +6,7 @@ goog.require('ol.Size'); /** * @typedef {function(this:ol.source.Image, ol.Extent, ol.Size, - * ol.Projection): (string|undefined)} + * ol.proj.Projection): (string|undefined)} */ ol.ImageUrlFunctionType; @@ -15,7 +15,7 @@ ol.ImageUrlFunctionType; * @param {string} baseUrl Base URL (may have query data). * @param {Object.} params to encode in the url. * @param {function(string, Object., ol.Extent, ol.Size, - * ol.Projection): (string|undefined)} paramsFunction params function. + * ol.proj.Projection): (string|undefined)} paramsFunction params function. * @return {ol.ImageUrlFunctionType} Image URL function. */ ol.ImageUrlFunction.createFromParamsFunction = @@ -25,7 +25,7 @@ ol.ImageUrlFunction.createFromParamsFunction = * @this {ol.source.Image} * @param {ol.Extent} extent Extent. * @param {ol.Size} size Size. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} URL. */ function(extent, size, projection) { diff --git a/src/ol/iview2d.js b/src/ol/iview2d.js index ad1d28f564..784b91f7b7 100644 --- a/src/ol/iview2d.js +++ b/src/ol/iview2d.js @@ -2,12 +2,11 @@ goog.provide('ol.IView2D'); goog.provide('ol.View2DState'); goog.require('ol.Coordinate'); -goog.require('ol.Projection'); /** * @typedef {{center: ol.Coordinate, - * projection: ol.Projection, + * projection: ol.proj.Projection, * resolution: number, * rotation: number}} */ @@ -31,7 +30,7 @@ ol.IView2D.prototype.getCenter = function() { /** - * @return {ol.Projection|undefined} Map projection. + * @return {ol.proj.Projection|undefined} Map projection. */ ol.IView2D.prototype.getProjection = function() { }; diff --git a/src/ol/layer/vectorlayer.js b/src/ol/layer/vectorlayer.js index 01da071cd8..3cdd40814b 100644 --- a/src/ol/layer/vectorlayer.js +++ b/src/ol/layer/vectorlayer.js @@ -383,7 +383,7 @@ ol.layer.Vector.prototype.getStyle = function() { * as the data for `extent` is available. * * @param {ol.Extent} extent Bounding extent. - * @param {ol.Projection} projection Target projection. + * @param {ol.proj.Projection} projection Target projection. * @param {ol.geom.GeometryType=} opt_type Optional geometry type. * @param {Function=} opt_callback Callback to call when data is parsed. * @return {Object.} Features or null if source is loading @@ -492,8 +492,8 @@ ol.layer.Vector.prototype.getFeatureWithUid = function(uid) { /** * @param {Object|Element|Document|string} data Feature data. * @param {ol.parser.Parser} parser Feature parser. - * @param {ol.Projection} projection This sucks. The layer should be a view in - * one projection. + * @param {ol.proj.Projection} projection This sucks. The layer should be a + * view in one projection. */ ol.layer.Vector.prototype.parseFeatures = function(data, parser, projection) { var lookup = {}; diff --git a/src/ol/proj.exports b/src/ol/proj.exports index 6ad6796116..a4e9dd7459 100644 --- a/src/ol/proj.exports +++ b/src/ol/proj.exports @@ -1,11 +1,11 @@ -@exportClass ol.Projection ol.ProjectionOptions -@exportProperty ol.Projection.prototype.getAxisOrientation -@exportProperty ol.Projection.prototype.getCode -@exportProperty ol.Projection.prototype.getExtent -@exportProperty ol.Projection.prototype.getPointResolution -@exportProperty ol.Projection.prototype.getUnits -@exportProperty ol.Projection.prototype.getMetersPerUnit -@exportProperty ol.Projection.prototype.isGlobal +@exportClass ol.proj.Projection ol.ProjectionOptions +@exportProperty ol.proj.Projection.prototype.getAxisOrientation +@exportProperty ol.proj.Projection.prototype.getCode +@exportProperty ol.proj.Projection.prototype.getExtent +@exportProperty ol.proj.Projection.prototype.getPointResolution +@exportProperty ol.proj.Projection.prototype.getUnits +@exportProperty ol.proj.Projection.prototype.getMetersPerUnit +@exportProperty ol.proj.Projection.prototype.isGlobal @exportSymbol ol.ProjectionUnits @exportProperty ol.ProjectionUnits.DEGREES diff --git a/src/ol/proj/chprojection.js b/src/ol/proj/chprojection.js index e16fa0de69..255e0ac6fd 100644 --- a/src/ol/proj/chprojection.js +++ b/src/ol/proj/chprojection.js @@ -4,18 +4,18 @@ goog.provide('ol.proj.EPSG21781'); goog.require('goog.asserts'); goog.require('goog.math'); -goog.require('ol.Projection'); goog.require('ol.ProjectionUnits'); goog.require('ol.ellipsoid.BESSEL1841'); goog.require('ol.proj'); goog.require('ol.proj.EPSG4326'); +goog.require('ol.proj.Projection'); /** * Internal base class for Swiss grid projections. * @constructor - * @extends {ol.Projection} + * @extends {ol.proj.Projection} * @param {{code: string, extent: ol.Extent}} options Options. */ ol.proj.CH = function(options) { @@ -26,7 +26,7 @@ ol.proj.CH = function(options) { units: ol.ProjectionUnits.METERS }); }; -goog.inherits(ol.proj.CH, ol.Projection); +goog.inherits(ol.proj.CH, ol.proj.Projection); /** diff --git a/src/ol/proj/epsg3857projection.js b/src/ol/proj/epsg3857projection.js index e7739ffb0b..cddfb4ff13 100644 --- a/src/ol/proj/epsg3857projection.js +++ b/src/ol/proj/epsg3857projection.js @@ -2,16 +2,16 @@ goog.provide('ol.proj.EPSG3857'); goog.require('goog.array'); goog.require('goog.asserts'); -goog.require('ol.Projection'); goog.require('ol.ProjectionUnits'); goog.require('ol.math'); goog.require('ol.proj'); +goog.require('ol.proj.Projection'); /** * @constructor - * @extends {ol.Projection} + * @extends {ol.proj.Projection} * @param {string} code Code. */ ol.proj.EPSG3857 = function(code) { @@ -22,7 +22,7 @@ ol.proj.EPSG3857 = function(code) { global: true }); }; -goog.inherits(ol.proj.EPSG3857, ol.Projection); +goog.inherits(ol.proj.EPSG3857, ol.proj.Projection); /** @@ -67,7 +67,7 @@ ol.proj.EPSG3857.CODES = [ * Projections equal to EPSG:3857. * * @const - * @type {Array.} + * @type {Array.} */ ol.proj.EPSG3857.PROJECTIONS = goog.array.map( ol.proj.EPSG3857.CODES, diff --git a/src/ol/proj/epsg4326projection.js b/src/ol/proj/epsg4326projection.js index 57924a4ddc..49ee786bf1 100644 --- a/src/ol/proj/epsg4326projection.js +++ b/src/ol/proj/epsg4326projection.js @@ -1,14 +1,14 @@ goog.provide('ol.proj.EPSG4326'); -goog.require('ol.Projection'); goog.require('ol.ProjectionUnits'); goog.require('ol.proj'); +goog.require('ol.proj.Projection'); /** * @constructor - * @extends {ol.Projection} + * @extends {ol.proj.Projection} * @param {string} code Code. * @param {string=} opt_axisOrientation Axis orientation. */ @@ -21,7 +21,7 @@ ol.proj.EPSG4326 = function(code, opt_axisOrientation) { global: true }); }; -goog.inherits(ol.proj.EPSG4326, ol.Projection); +goog.inherits(ol.proj.EPSG4326, ol.proj.Projection); /** @@ -37,7 +37,7 @@ ol.proj.EPSG4326.EXTENT = [-180, -90, 180, 90]; * Projections equal to EPSG:4326. * * @const - * @type {Array.} + * @type {Array.} */ ol.proj.EPSG4326.PROJECTIONS = [ new ol.proj.EPSG4326('CRS:84'), diff --git a/src/ol/proj/proj.js b/src/ol/proj/proj.js index a82f443bbf..c1bbbde647 100644 --- a/src/ol/proj/proj.js +++ b/src/ol/proj/proj.js @@ -1,7 +1,7 @@ -goog.provide('ol.Projection'); goog.provide('ol.ProjectionLike'); goog.provide('ol.ProjectionUnits'); goog.provide('ol.proj'); +goog.provide('ol.proj.Projection'); goog.require('goog.array'); goog.require('goog.asserts'); @@ -25,8 +25,9 @@ ol.HAVE_PROJ4JS = ol.ENABLE_PROJ4JS && typeof Proj4js == 'object'; /** - * A projection as {@link ol.Projection}, SRS identifier string or undefined. - * @typedef {ol.Projection|string|undefined} ol.ProjectionLike + * A projection as {@link ol.proj.Projection}, SRS identifier string or + * undefined. + * @typedef {ol.proj.Projection|string|undefined} ol.ProjectionLike */ ol.ProjectionLike; @@ -56,7 +57,7 @@ ol.METERS_PER_UNIT[ol.ProjectionUnits.METERS] = 1; * @constructor * @param {ol.ProjectionOptions} options Projection options. */ -ol.Projection = function(options) { +ol.proj.Projection = function(options) { /** * @private @@ -102,7 +103,7 @@ ol.Projection = function(options) { * Get the code for this projection, e.g. 'EPSG:4326'. * @return {string} Code. */ -ol.Projection.prototype.getCode = function() { +ol.proj.Projection.prototype.getCode = function() { return this.code_; }; @@ -111,7 +112,7 @@ ol.Projection.prototype.getCode = function() { * Get the validity extent for this projection. * @return {ol.Extent} Extent. */ -ol.Projection.prototype.getExtent = function() { +ol.proj.Projection.prototype.getExtent = function() { return this.extent_; }; @@ -126,14 +127,14 @@ ol.Projection.prototype.getExtent = function() { * @param {ol.Coordinate} point Point. * @return {number} Point resolution. */ -ol.Projection.prototype.getPointResolution = goog.abstractMethod; +ol.proj.Projection.prototype.getPointResolution = goog.abstractMethod; /** * Get the units of this projection. * @return {ol.ProjectionUnits} Units. */ -ol.Projection.prototype.getUnits = function() { +ol.proj.Projection.prototype.getUnits = function() { return this.units_; }; @@ -143,7 +144,7 @@ ol.Projection.prototype.getUnits = function() { * not configured with a units identifier, the return is `undefined`. * @return {number|undefined} Meters. */ -ol.Projection.prototype.getMetersPerUnit = function() { +ol.proj.Projection.prototype.getMetersPerUnit = function() { return ol.METERS_PER_UNIT[this.units_]; }; @@ -158,7 +159,7 @@ ol.Projection.prototype.getMetersPerUnit = function() { * "west positive" coordinate systems * @return {string} Axis orientation. */ -ol.Projection.prototype.getAxisOrientation = function() { +ol.proj.Projection.prototype.getAxisOrientation = function() { return this.axisOrientation_; }; @@ -167,7 +168,7 @@ ol.Projection.prototype.getAxisOrientation = function() { * Is this projection a global projection which spans the whole world? * @return {boolean} Wether the projection is global. */ -ol.Projection.prototype.isGlobal = function() { +ol.proj.Projection.prototype.isGlobal = function() { return this.global_; }; @@ -175,7 +176,7 @@ ol.Projection.prototype.isGlobal = function() { /** * @return {ol.tilegrid.TileGrid} The default tile grid. */ -ol.Projection.prototype.getDefaultTileGrid = function() { +ol.proj.Projection.prototype.getDefaultTileGrid = function() { return this.defaultTileGrid_; }; @@ -183,7 +184,7 @@ ol.Projection.prototype.getDefaultTileGrid = function() { /** * @param {ol.tilegrid.TileGrid} tileGrid The default tile grid. */ -ol.Projection.prototype.setDefaultTileGrid = function(tileGrid) { +ol.proj.Projection.prototype.setDefaultTileGrid = function(tileGrid) { this.defaultTileGrid_ = tileGrid; }; @@ -191,7 +192,7 @@ ol.Projection.prototype.setDefaultTileGrid = function(tileGrid) { /** * @constructor - * @extends {ol.Projection} + * @extends {ol.proj.Projection} * @param {Proj4js.Proj} proj4jsProj Proj4js projection. * @param {ol.Proj4jsProjectionOptions} options Proj4js projection options. * @private @@ -221,7 +222,7 @@ ol.Proj4jsProjection_ = function(proj4jsProj, options) { this.toEPSG4326_ = null; }; -goog.inherits(ol.Proj4jsProjection_, ol.Projection); +goog.inherits(ol.Proj4jsProjection_, ol.proj.Projection); /** @@ -293,7 +294,7 @@ ol.proj.proj4jsProjections_ = {}; /** * @private - * @type {Object.} + * @type {Object.} */ ol.proj.projections_ = {}; @@ -309,7 +310,7 @@ ol.proj.transforms_ = {}; * Registers transformation functions that don't alter coordinates. Those allow * to transform between projections with equal meaning. * - * @param {Array.} projections Projections. + * @param {Array.} projections Projections. */ ol.proj.addEquivalentProjections = function(projections) { ol.proj.addProjections(projections); @@ -327,8 +328,10 @@ ol.proj.addEquivalentProjections = function(projections) { * Registers transformation functions to convert coordinates in any projection * in projection1 to any projection in projection2. * - * @param {Array.} projections1 Projections with equal meaning. - * @param {Array.} projections2 Projections with equal meaning. + * @param {Array.} projections1 Projections with equal + * meaning. + * @param {Array.} projections2 Projections with equal + * meaning. * @param {ol.TransformFunction} forwardTransform Transformation from any * projection in projection1 to any projection in projection2. * @param {ol.TransformFunction} inverseTransform Transform from any projection @@ -358,7 +361,7 @@ ol.proj.addProj4jsProjection_ = function(proj4jsProjection) { /** - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. */ ol.proj.addProjection = function(projection) { var projections = ol.proj.projections_; @@ -369,7 +372,7 @@ ol.proj.addProjection = function(projection) { /** - * @param {Array.} projections Projections. + * @param {Array.} projections Projections. */ ol.proj.addProjections = function(projections) { goog.array.forEach(projections, function(projection) { @@ -391,9 +394,9 @@ ol.proj.clearAllProjections = function() { /** - * @param {ol.Projection|string|undefined} projection Projection. + * @param {ol.proj.Projection|string|undefined} projection Projection. * @param {string} defaultCode Default code. - * @return {ol.Projection} Projection. + * @return {ol.proj.Projection} Projection. */ ol.proj.createProjection = function(projection, defaultCode) { if (!goog.isDefAndNotNull(projection)) { @@ -401,7 +404,7 @@ ol.proj.createProjection = function(projection, defaultCode) { } else if (goog.isString(projection)) { return ol.proj.get(projection); } else { - goog.asserts.assertInstanceof(projection, ol.Projection); + goog.asserts.assertInstanceof(projection, ol.proj.Projection); return projection; } }; @@ -411,8 +414,8 @@ ol.proj.createProjection = function(projection, defaultCode) { * Registers a conversion function to convert coordinates from the source * projection to the destination projection. * - * @param {ol.Projection} source Source. - * @param {ol.Projection} destination Destination. + * @param {ol.proj.Projection} source Source. + * @param {ol.proj.Projection} destination Destination. * @param {ol.TransformFunction} transformFn Transform. */ ol.proj.addTransform = function(source, destination, transformFn) { @@ -431,8 +434,8 @@ ol.proj.addTransform = function(source, destination, transformFn) { * projection to the destination projection. This method is used to clean up * cached transforms during testing. * - * @param {ol.Projection} source Source projection. - * @param {ol.Projection} destination Destination projection. + * @param {ol.proj.Projection} source Source projection. + * @param {ol.proj.Projection} destination Destination projection. * @return {ol.TransformFunction} transformFn The unregistered transform. */ ol.proj.removeTransform = function(source, destination) { @@ -455,11 +458,11 @@ ol.proj.removeTransform = function(source, destination) { * @param {ol.ProjectionLike} projectionLike Either a code string which is a * combination of authority and identifier such as "EPSG:4326", or an * existing projection object, or undefined. - * @return {ol.Projection} Projection. + * @return {ol.proj.Projection} Projection. */ ol.proj.get = function(projectionLike) { var projection; - if (projectionLike instanceof ol.Projection) { + if (projectionLike instanceof ol.proj.Projection) { projection = projectionLike; } else if (goog.isString(projectionLike)) { var code = projectionLike; @@ -512,8 +515,8 @@ ol.proj.getProj4jsProjectionFromCode_ = function(options) { * projection does represent the same geographic point as the same coordinate in * the other projection. * - * @param {ol.Projection} projection1 Projection 1. - * @param {ol.Projection} projection2 Projection 2. + * @param {ol.proj.Projection} projection1 Projection 1. + * @param {ol.proj.Projection} projection2 Projection 2. * @return {boolean} Equivalent. */ ol.proj.equivalent = function(projection1, projection2) { @@ -550,8 +553,8 @@ ol.proj.getTransform = function(source, destination) { * Searches a function that can be used to convert coordinates from the source * projection to the destination projection. * - * @param {ol.Projection} sourceProjection Source projection. - * @param {ol.Projection} destinationProjection Destination projection. + * @param {ol.proj.Projection} sourceProjection Source projection. + * @param {ol.proj.Projection} destinationProjection Destination projection. * @return {ol.TransformFunction} Transform. */ ol.proj.getTransformFromProjections = @@ -683,8 +686,8 @@ ol.proj.transform = function(point, source, destination) { * Transforms the given point to the destination projection. * * @param {ol.Coordinate} point Point. - * @param {ol.Projection} sourceProjection Source projection. - * @param {ol.Projection} destinationProjection Destination projection. + * @param {ol.proj.Projection} sourceProjection Source projection. + * @param {ol.proj.Projection} destinationProjection Destination projection. * @return {ol.Coordinate} Point. */ ol.proj.transformWithProjections = @@ -697,7 +700,7 @@ ol.proj.transformWithProjections = /** * @param {ol.Proj4jsProjectionOptions} options Proj4js projection options. - * @return {ol.Projection} Proj4js projection. + * @return {ol.proj.Projection} Proj4js projection. */ ol.proj.configureProj4jsProjection = function(options) { goog.asserts.assert(!goog.object.containsKey( diff --git a/src/ol/renderer/layerrenderer.js b/src/ol/renderer/layerrenderer.js index c33e0770ea..65d3d50af6 100644 --- a/src/ol/renderer/layerrenderer.js +++ b/src/ol/renderer/layerrenderer.js @@ -196,7 +196,7 @@ ol.renderer.Layer.prototype.updateUsedTiles = * @param {function(ol.Tile): boolean} isLoadedFunction Function to * determine if the tile is loaded. * @param {ol.source.Tile} tileSource Tile source. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @protected * @return {function(number, number, number): ol.Tile} Returns a tile if it is * loaded. @@ -243,7 +243,7 @@ ol.renderer.Layer.prototype.snapCenterToPixel = * @param {ol.FrameState} frameState Frame state. * @param {ol.source.Tile} tileSource Tile source. * @param {ol.tilegrid.TileGrid} tileGrid Tile grid. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @param {ol.Extent} extent Extent. * @param {number} currentZ Current Z. * @param {number} preload Load low resolution tiles up to 'preload' levels. diff --git a/src/ol/source/bingmapssource.js b/src/ol/source/bingmapssource.js index f2294d2f60..470194b511 100644 --- a/src/ol/source/bingmapssource.js +++ b/src/ol/source/bingmapssource.js @@ -90,7 +90,7 @@ ol.source.BingMaps.prototype.handleImageryMetadataResponse = /** * @this {ol.source.BingMaps} * @param {ol.TileCoord} tileCoord Tile coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} Tile URL. */ function(tileCoord, projection) { diff --git a/src/ol/source/imagesource.js b/src/ol/source/imagesource.js index 1a9d6579b3..d3b523c6f8 100644 --- a/src/ol/source/imagesource.js +++ b/src/ol/source/imagesource.js @@ -7,7 +7,6 @@ goog.require('ol.Extent'); goog.require('ol.Image'); goog.require('ol.ImageUrlFunction'); goog.require('ol.ImageUrlFunctionType'); -goog.require('ol.Projection'); goog.require('ol.Size'); goog.require('ol.array'); goog.require('ol.source.Source'); @@ -78,7 +77,7 @@ goog.inherits(ol.source.Image, ol.source.Source); * @param {ol.Extent} extent Extent. * @param {number} resolution Resolution. * @param {ol.Size} size Size. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {ol.Image} Single image. */ ol.source.Image.prototype.createImage = @@ -112,7 +111,7 @@ ol.source.Image.prototype.findNearestResolution = /** * @param {ol.Extent} extent Extent. * @param {number} resolution Resolution. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {ol.Image} Single image. */ ol.source.Image.prototype.getImage = goog.abstractMethod; diff --git a/src/ol/source/imagestaticsource.js b/src/ol/source/imagestaticsource.js index b6e3742d9a..4f15199c41 100644 --- a/src/ol/source/imagestaticsource.js +++ b/src/ol/source/imagestaticsource.js @@ -64,7 +64,7 @@ ol.source.ImageStatic.createImageFunction = function(url) { /** * @param {ol.Extent} extent Extent. * @param {ol.Size} size Size. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} URL. */ function(extent, size, projection) { diff --git a/src/ol/source/source.js b/src/ol/source/source.js index 0072d8f60e..2f1f0db681 100644 --- a/src/ol/source/source.js +++ b/src/ol/source/source.js @@ -20,7 +20,7 @@ ol.source.Source = function(options) { /** * @private - * @type {ol.Projection} + * @type {ol.proj.Projection} */ this.projection_ = ol.proj.get(options.projection); @@ -98,7 +98,7 @@ ol.source.Source.prototype.getLogo = function() { /** - * @return {ol.Projection} Projection. + * @return {ol.proj.Projection} Projection. */ ol.source.Source.prototype.getProjection = function() { return this.projection_; @@ -150,7 +150,7 @@ ol.source.Source.prototype.setLogo = function(logo) { /** - * @param {ol.Projection} projection Projetion. + * @param {ol.proj.Projection} projection Projetion. */ ol.source.Source.prototype.setProjection = function(projection) { this.projection_ = projection; diff --git a/src/ol/source/tileimagesource.js b/src/ol/source/tileimagesource.js index 7299595266..61ae2bd6c8 100644 --- a/src/ol/source/tileimagesource.js +++ b/src/ol/source/tileimagesource.js @@ -4,7 +4,6 @@ goog.require('goog.asserts'); goog.require('ol.Attribution'); goog.require('ol.Extent'); goog.require('ol.ImageTile'); -goog.require('ol.Projection'); goog.require('ol.Tile'); goog.require('ol.TileCache'); goog.require('ol.TileCoord'); diff --git a/src/ol/source/tilesource.js b/src/ol/source/tilesource.js index c357a8dbd7..14b2e5d77e 100644 --- a/src/ol/source/tilesource.js +++ b/src/ol/source/tilesource.js @@ -136,7 +136,7 @@ ol.source.Tile.prototype.getResolutions = function() { * @param {number} z Tile coordinate z. * @param {number} x Tile coordinate x. * @param {number} y Tile coordinate y. - * @param {ol.Projection=} opt_projection Projection. + * @param {ol.proj.Projection=} opt_projection Projection. * @return {!ol.Tile} Tile. */ ol.source.Tile.prototype.getTile = goog.abstractMethod; diff --git a/src/ol/source/vectorsource.js b/src/ol/source/vectorsource.js index a53eb708cb..4c24b94a1c 100644 --- a/src/ol/source/vectorsource.js +++ b/src/ol/source/vectorsource.js @@ -61,7 +61,7 @@ goog.inherits(ol.source.Vector, ol.source.Source); /** * @param {ol.layer.Vector} layer Layer that parses the data. * @param {ol.Extent} extent Extent that needs to be fetched. - * @param {ol.Projection} projection Projection of the view. + * @param {ol.proj.Projection} projection Projection of the view. * @param {function()=} opt_callback Callback which is called when features are * parsed after loading. * @return {ol.source.VectorLoadState} The current load state. diff --git a/src/ol/source/wmssource.js b/src/ol/source/wmssource.js index 1171f5babe..52e8d973cd 100644 --- a/src/ol/source/wmssource.js +++ b/src/ol/source/wmssource.js @@ -29,7 +29,7 @@ ol.source.WMSGetFeatureInfoMethod = { * @param {Object.} params Request parameters. * @param {ol.Extent} extent Extent. * @param {ol.Size} size Size. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string} WMS GetMap request URL. */ ol.source.wms.getUrl = diff --git a/src/ol/source/wmtssource.js b/src/ol/source/wmtssource.js index e4fecfcd05..d0ddb75e40 100644 --- a/src/ol/source/wmtssource.js +++ b/src/ol/source/wmtssource.js @@ -95,7 +95,7 @@ ol.source.WMTS = function(options) { /** * @this {ol.source.WMTS} * @param {ol.TileCoord} tileCoord Tile coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} Tile URL. */ function(tileCoord, projection) { @@ -136,7 +136,7 @@ ol.source.WMTS = function(options) { tileUrlFunction = ol.TileUrlFunction.withTileCoordTransform( /** * @param {ol.TileCoord} tileCoord Tile coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @param {ol.TileCoord=} opt_tileCoord Tile coordinate. * @return {ol.TileCoord} Tile coordinate. */ diff --git a/src/ol/tilegrid/tilegrid.js b/src/ol/tilegrid/tilegrid.js index fe90b19b5b..be6a12710d 100644 --- a/src/ol/tilegrid/tilegrid.js +++ b/src/ol/tilegrid/tilegrid.js @@ -3,13 +3,13 @@ goog.provide('ol.tilegrid.TileGrid'); goog.require('goog.array'); goog.require('goog.asserts'); goog.require('ol.Coordinate'); -goog.require('ol.Projection'); goog.require('ol.ProjectionUnits'); goog.require('ol.Size'); goog.require('ol.TileCoord'); goog.require('ol.TileRange'); goog.require('ol.array'); goog.require('ol.extent'); +goog.require('ol.proj.Projection'); /** @@ -106,8 +106,8 @@ ol.tilegrid.TileGrid.tmpTileCoord_ = new ol.TileCoord(0, 0, 0); /** * @param {{extent: (ol.Extent|undefined), * wrapX: (boolean|undefined)}=} opt_options Options. - * @return {function(ol.TileCoord, ol.Projection, ol.TileCoord=): ol.TileCoord} - * Tile coordinate transform. + * @return {function(ol.TileCoord, ol.proj.Projection, ol.TileCoord=): + * ol.TileCoord} Tile coordinate transform. */ ol.tilegrid.TileGrid.prototype.createTileCoordTransform = goog.abstractMethod; @@ -389,7 +389,7 @@ ol.tilegrid.TileGrid.prototype.getZForResolution = function(resolution) { /** - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {ol.tilegrid.TileGrid} Default tile grid for the passed projection. */ ol.tilegrid.getForProjection = function(projection) { @@ -403,7 +403,7 @@ ol.tilegrid.getForProjection = function(projection) { /** - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @param {number=} opt_maxZoom Maximum zoom level. * @param {ol.Size=} opt_tileSize Tile size. * @return {ol.tilegrid.TileGrid} TileGrid instance. diff --git a/src/ol/tilegrid/xyztilegrid.js b/src/ol/tilegrid/xyztilegrid.js index 40ba8ccdff..a68d754ed9 100644 --- a/src/ol/tilegrid/xyztilegrid.js +++ b/src/ol/tilegrid/xyztilegrid.js @@ -59,7 +59,7 @@ ol.tilegrid.XYZ.prototype.createTileCoordTransform = function(opt_options) { return ( /** * @param {ol.TileCoord} tileCoord Tile coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @param {ol.TileCoord=} opt_tileCoord Destination tile coordinate. * @return {ol.TileCoord} Tile coordinate. */ diff --git a/src/ol/tileurlfunction.js b/src/ol/tileurlfunction.js index d69080dc0a..b9da756063 100644 --- a/src/ol/tileurlfunction.js +++ b/src/ol/tileurlfunction.js @@ -9,13 +9,14 @@ goog.require('ol.extent'); /** * @typedef {function(this: ol.source.TileImage, ol.TileCoord, - * ol.Projection): (string|undefined)} + * ol.proj.Projection): (string|undefined)} */ ol.TileUrlFunctionType; /** - * @typedef {function(ol.TileCoord, ol.Projection, ol.TileCoord=): ol.TileCoord} + * @typedef {function(ol.TileCoord, ol.proj.Projection, ol.TileCoord=): + * ol.TileCoord} */ ol.TileCoordTransformType; @@ -29,7 +30,7 @@ ol.TileUrlFunction.createFromTemplate = function(template) { /** * @this {ol.source.TileImage} * @param {ol.TileCoord} tileCoord Tile Coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} Tile URL. */ function(tileCoord, projection) { @@ -66,7 +67,7 @@ ol.TileUrlFunction.createFromTileUrlFunctions = function(tileUrlFunctions) { /** * @this {ol.source.TileImage} * @param {ol.TileCoord} tileCoord Tile Coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} Tile URL. */ function(tileCoord, projection) { @@ -85,7 +86,7 @@ ol.TileUrlFunction.createFromTileUrlFunctions = function(tileUrlFunctions) { * @param {string} baseUrl Base URL (may have query data). * @param {Object.} params to encode in the url. * @param {function(this: ol.source.TileImage, string, Object., - * ol.Extent, ol.Size, ol.Projection)} paramsFunction params function. + * ol.Extent, ol.Size, ol.proj.Projection)} paramsFunction params function. * @return {ol.TileUrlFunctionType} Tile URL function. */ ol.TileUrlFunction.createFromParamsFunction = @@ -95,7 +96,7 @@ ol.TileUrlFunction.createFromParamsFunction = /** * @this {ol.source.TileImage} * @param {ol.TileCoord} tileCoord Tile Coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} Tile URL. */ function(tileCoord, projection) { @@ -118,7 +119,7 @@ ol.TileUrlFunction.createFromParamsFunction = /** * @this {ol.source.TileImage} * @param {ol.TileCoord} tileCoord Tile coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} Tile URL. */ ol.TileUrlFunction.nullTileUrlFunction = function(tileCoord, projection) { @@ -138,7 +139,7 @@ ol.TileUrlFunction.withTileCoordTransform = /** * @this {ol.source.TileImage} * @param {ol.TileCoord} tileCoord Tile Coordinate. - * @param {ol.Projection} projection Projection. + * @param {ol.proj.Projection} projection Projection. * @return {string|undefined} Tile URL. */ function(tileCoord, projection) { diff --git a/src/ol/view2d.js b/src/ol/view2d.js index dd573f1306..9fe18e637d 100644 --- a/src/ol/view2d.js +++ b/src/ol/view2d.js @@ -7,7 +7,6 @@ goog.require('goog.asserts'); goog.require('ol.Constraints'); goog.require('ol.IView2D'); goog.require('ol.IView3D'); -goog.require('ol.Projection'); goog.require('ol.ProjectionUnits'); goog.require('ol.ResolutionConstraint'); goog.require('ol.RotationConstraint'); @@ -17,6 +16,7 @@ goog.require('ol.View'); goog.require('ol.coordinate'); goog.require('ol.extent'); goog.require('ol.proj'); +goog.require('ol.proj.Projection'); /** @@ -234,7 +234,7 @@ ol.View2D.prototype.calculateExtent = function(size) { * @inheritDoc */ ol.View2D.prototype.getProjection = function() { - return /** @type {ol.Projection|undefined} */ ( + return /** @type {ol.proj.Projection|undefined} */ ( this.get(ol.View2DProperty.PROJECTION)); }; goog.exportProperty( @@ -425,7 +425,7 @@ goog.exportProperty( /** * Set the projection of this view. - * @param {ol.Projection|undefined} projection Projection. + * @param {ol.proj.Projection|undefined} projection Projection. */ ol.View2D.prototype.setProjection = function(projection) { this.set(ol.View2DProperty.PROJECTION, projection); diff --git a/test/spec/ol/proj/chprojection.test.js b/test/spec/ol/proj/chprojection.test.js index 5b86aa6f20..b42f0322f6 100644 --- a/test/spec/ol/proj/chprojection.test.js +++ b/test/spec/ol/proj/chprojection.test.js @@ -47,7 +47,7 @@ describe('ol.proj.EPSG2056', function() { beforeEach(function() { ol.proj.EPSG2056.add(); epsg2056 = ol.proj.get('EPSG:2056'); - expect(epsg2056).to.be.an(ol.Projection); + expect(epsg2056).to.be.an(ol.proj.Projection); }); it('transforms from EPSG:2056 to EPSG:4326', function() { @@ -82,7 +82,7 @@ describe('ol.proj.EPSG21781', function() { beforeEach(function() { ol.proj.EPSG21781.add(); epsg21781 = ol.proj.get('EPSG:21781'); - expect(epsg21781).to.be.an(ol.Projection); + expect(epsg21781).to.be.an(ol.proj.Projection); }); it('maintains accuracy when round-tripping', function() { @@ -127,8 +127,8 @@ describe('ol.proj.EPSG21781', function() { goog.require('goog.math'); -goog.require('ol.Projection'); goog.require('ol.proj'); goog.require('ol.proj.CH'); goog.require('ol.proj.EPSG2056'); goog.require('ol.proj.EPSG21781'); +goog.require('ol.proj.Projection'); diff --git a/test/spec/ol/proj/proj.test.js b/test/spec/ol/proj/proj.test.js index 4171d5b4c4..d6db351141 100644 --- a/test/spec/ol/proj/proj.test.js +++ b/test/spec/ol/proj/proj.test.js @@ -275,12 +275,12 @@ describe('ol.proj', function() { var units = ol.ProjectionUnits.DEGREES; it('removes functions cached by addTransform', function() { - var foo = new ol.Projection({ + var foo = new ol.proj.Projection({ code: 'foo', units: units, extent: extent }); - var bar = new ol.Projection({ + var bar = new ol.proj.Projection({ code: 'bar', units: units, extent: extent @@ -298,7 +298,7 @@ describe('ol.proj', function() { }); - describe('ol.Projection.prototype.getMetersPerUnit()', function() { + describe('ol.proj.Projection.prototype.getMetersPerUnit()', function() { beforeEach(function() { Proj4js.defs['EPSG:26782'] = @@ -351,7 +351,7 @@ describe('ol.proj', function() { goog.require('goog.array'); -goog.require('ol.Projection'); goog.require('ol.ProjectionUnits'); goog.require('ol.proj'); +goog.require('ol.proj.Projection'); goog.require('ol.proj.common'); diff --git a/test/spec/ol/tilegrid/tilegrid.test.js b/test/spec/ol/tilegrid/tilegrid.test.js index 86700b6be6..a8e1965960 100644 --- a/test/spec/ol/tilegrid/tilegrid.test.js +++ b/test/spec/ol/tilegrid/tilegrid.test.js @@ -191,7 +191,7 @@ describe('ol.tilegrid.TileGrid', function() { }); it('works for projections unknown to the client', function() { - var projection = new ol.Projection( + var projection = new ol.proj.Projection( {code: 'EPSG:31287', units: 'm'}); var grid = ol.tilegrid.createForProjection(projection); var resolutions = grid.getResolutions(); @@ -643,8 +643,8 @@ describe('ol.tilegrid.TileGrid', function() { }); goog.require('ol.Coordinate'); -goog.require('ol.Projection'); goog.require('ol.ProjectionUnits'); goog.require('ol.TileCoord'); goog.require('ol.proj'); +goog.require('ol.proj.Projection'); goog.require('ol.tilegrid.TileGrid');