diff --git a/changelog/upgrade-notes.md b/changelog/upgrade-notes.md index bf6aa0a575..5aa85d168f 100644 --- a/changelog/upgrade-notes.md +++ b/changelog/upgrade-notes.md @@ -27,6 +27,7 @@ A number of internal types have been renamed. This will not affect those who us * rename `ol.OverlayProperty` to `ol.Overlay.Property` * rename `ol.control.MousePositionProperty` to `ol.control.MousePosition.Property` * rename `ol.format.IGCZ` to `ol.format.IGC.Z` + * rename `ol.interaction.InteractionProperty` to `ol.interaction.Interaction.Property` * rename `ol.interaction.DrawMode` to `ol.interaction.Draw.Mode` * rename `ol.interaction.DrawEvent` to `ol.interaction.Draw.Event` * rename `ol.interaction.DrawEventType` to `ol.interaction.Draw.EventType` @@ -47,6 +48,7 @@ A number of internal types have been renamed. This will not affect those who us * rename `ol.MapProperty` to `ol.Map.Property` * rename `ol.ModifyEventType` to `ol.interaction.Modify.EventType` * rename `ol.RendererType` to `ol.renderer.Type` + * rename `ol.render.EventType` to `ol.render.Event.Type` * rename `ol.source.ImageEvent` to `ol.source.Image.Event` * rename `ol.source.ImageEventType` to `ol.source.Image.EventType` * rename `ol.source.RasterEvent` to `ol.source.Raster.Event` diff --git a/src/ol/graticule.js b/src/ol/graticule.js index 3550ceb849..488931cad4 100644 --- a/src/ol/graticule.js +++ b/src/ol/graticule.js @@ -7,7 +7,7 @@ goog.require('ol.geom.LineString'); goog.require('ol.geom.flat.geodesic'); goog.require('ol.math'); goog.require('ol.proj'); -goog.require('ol.render.EventType'); +goog.require('ol.render.Event'); goog.require('ol.style.Stroke'); @@ -519,12 +519,12 @@ ol.Graticule.prototype.updateProjectionInfo_ = function(projection) { */ ol.Graticule.prototype.setMap = function(map) { if (this.map_) { - this.map_.un(ol.render.EventType.POSTCOMPOSE, + this.map_.un(ol.render.Event.Type.POSTCOMPOSE, this.handlePostCompose_, this); this.map_.render(); } if (map) { - map.on(ol.render.EventType.POSTCOMPOSE, + map.on(ol.render.Event.Type.POSTCOMPOSE, this.handlePostCompose_, this); map.render(); } diff --git a/src/ol/interaction/draw.js b/src/ol/interaction/draw.js index 8d6453da76..40cd72941d 100644 --- a/src/ol/interaction/draw.js +++ b/src/ol/interaction/draw.js @@ -17,7 +17,7 @@ goog.require('ol.geom.MultiPoint'); goog.require('ol.geom.MultiPolygon'); goog.require('ol.geom.Point'); goog.require('ol.geom.Polygon'); -goog.require('ol.interaction.InteractionProperty'); +goog.require('ol.interaction.Interaction'); goog.require('ol.interaction.Pointer'); goog.require('ol.layer.Vector'); goog.require('ol.source.Vector'); @@ -255,7 +255,7 @@ ol.interaction.Draw = function(options) { options.freehandCondition : ol.events.condition.shiftKeyOnly; ol.events.listen(this, - ol.Object.getChangeEventType(ol.interaction.InteractionProperty.ACTIVE), + ol.Object.getChangeEventType(ol.interaction.Interaction.Property.ACTIVE), this.updateState_, this); }; diff --git a/src/ol/interaction/interaction.js b/src/ol/interaction/interaction.js index b5fafb7281..5d13ac1947 100644 --- a/src/ol/interaction/interaction.js +++ b/src/ol/interaction/interaction.js @@ -1,7 +1,6 @@ // FIXME factor out key precondition (shift et. al) goog.provide('ol.interaction.Interaction'); -goog.provide('ol.interaction.InteractionProperty'); goog.require('ol'); goog.require('ol.Object'); @@ -9,14 +8,6 @@ goog.require('ol.animation'); goog.require('ol.easing'); -/** - * @enum {string} - */ -ol.interaction.InteractionProperty = { - ACTIVE: 'active' -}; - - /** * @classdesc * Abstract base class; normally only used for creating subclasses and not @@ -63,7 +54,7 @@ ol.inherits(ol.interaction.Interaction, ol.Object); */ ol.interaction.Interaction.prototype.getActive = function() { return /** @type {boolean} */ ( - this.get(ol.interaction.InteractionProperty.ACTIVE)); + this.get(ol.interaction.Interaction.Property.ACTIVE)); }; @@ -84,7 +75,7 @@ ol.interaction.Interaction.prototype.getMap = function() { * @api */ ol.interaction.Interaction.prototype.setActive = function(active) { - this.set(ol.interaction.InteractionProperty.ACTIVE, active); + this.set(ol.interaction.Interaction.Property.ACTIVE, active); }; @@ -238,3 +229,11 @@ ol.interaction.Interaction.zoomWithoutConstraints = function(map, view, resoluti view.setResolution(resolution); } }; + + +/** + * @enum {string} + */ +ol.interaction.Interaction.Property = { + ACTIVE: 'active' +}; diff --git a/src/ol/layer/heatmap.js b/src/ol/layer/heatmap.js index 072f8107f8..b3420708ee 100644 --- a/src/ol/layer/heatmap.js +++ b/src/ol/layer/heatmap.js @@ -7,7 +7,7 @@ goog.require('ol.dom'); goog.require('ol.layer.Vector'); goog.require('ol.math'); goog.require('ol.obj'); -goog.require('ol.render.EventType'); +goog.require('ol.render.Event'); goog.require('ol.style.Icon'); goog.require('ol.style.Style'); @@ -120,7 +120,7 @@ ol.layer.Heatmap = function(opt_options) { // The render order is not relevant for a heatmap representation. this.setRenderOrder(null); - ol.events.listen(this, ol.render.EventType.RENDER, this.handleRender_, this); + ol.events.listen(this, ol.render.Event.Type.RENDER, this.handleRender_, this); }; ol.inherits(ol.layer.Heatmap, ol.layer.Vector); @@ -236,7 +236,7 @@ ol.layer.Heatmap.prototype.handleStyleChanged_ = function() { * @private */ ol.layer.Heatmap.prototype.handleRender_ = function(event) { - ol.DEBUG && console.assert(event.type == ol.render.EventType.RENDER, + ol.DEBUG && console.assert(event.type == ol.render.Event.Type.RENDER, 'event.type should be RENDER'); ol.DEBUG && console.assert(this.gradient_, 'this.gradient_ expected'); var context = event.context; diff --git a/src/ol/layer/layer.js b/src/ol/layer/layer.js index f3e321978d..c735a7b442 100644 --- a/src/ol/layer/layer.js +++ b/src/ol/layer/layer.js @@ -7,7 +7,7 @@ goog.require('ol.Object'); goog.require('ol.layer.Base'); goog.require('ol.layer.LayerProperty'); goog.require('ol.obj'); -goog.require('ol.render.EventType'); +goog.require('ol.render.Event'); goog.require('ol.source.State'); @@ -177,7 +177,7 @@ ol.layer.Layer.prototype.setMap = function(map) { } if (map) { this.mapPrecomposeKey_ = ol.events.listen( - map, ol.render.EventType.PRECOMPOSE, function(evt) { + map, ol.render.Event.Type.PRECOMPOSE, function(evt) { var layerState = this.getLayerState(); layerState.managed = false; layerState.zIndex = Infinity; diff --git a/src/ol/layer/vector.js b/src/ol/layer/vector.js index ce53973490..79afbc852f 100644 --- a/src/ol/layer/vector.js +++ b/src/ol/layer/vector.js @@ -6,14 +6,6 @@ goog.require('ol.obj'); goog.require('ol.style.Style'); -/** - * @enum {string} - */ -ol.layer.VectorProperty = { - RENDER_ORDER: 'renderOrder' -}; - - /** * @classdesc * Vector data that is rendered client-side. @@ -100,7 +92,7 @@ ol.layer.Vector.prototype.getRenderBuffer = function() { */ ol.layer.Vector.prototype.getRenderOrder = function() { return /** @type {function(ol.Feature, ol.Feature):number|null|undefined} */ ( - this.get(ol.layer.VectorProperty.RENDER_ORDER)); + this.get(ol.layer.Vector.Property.RENDER_ORDER)); }; @@ -162,7 +154,7 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) { renderOrder === undefined || !renderOrder || typeof renderOrder === 'function', 'renderOrder must be a comparator function'); - this.set(ol.layer.VectorProperty.RENDER_ORDER, renderOrder); + this.set(ol.layer.Vector.Property.RENDER_ORDER, renderOrder); }; @@ -183,3 +175,11 @@ ol.layer.Vector.prototype.setStyle = function(style) { undefined : ol.style.Style.createFunction(this.style_); this.changed(); }; + + +/** + * @enum {string} + */ +ol.layer.Vector.Property = { + RENDER_ORDER: 'renderOrder' +}; diff --git a/src/ol/layer/vectortile.js b/src/ol/layer/vectortile.js index 8def31d2e5..18e9128fc4 100644 --- a/src/ol/layer/vectortile.js +++ b/src/ol/layer/vectortile.js @@ -7,15 +7,6 @@ goog.require('ol.layer.Vector'); goog.require('ol.obj'); -/** - * @enum {string} - */ -ol.layer.VectorTileProperty = { - PRELOAD: 'preload', - USE_INTERIM_TILES_ON_ERROR: 'useInterimTilesOnError' -}; - - /** * @classdesc * Layer for vector tile data that is rendered client-side. @@ -64,7 +55,7 @@ ol.inherits(ol.layer.VectorTile, ol.layer.Vector); * @api */ ol.layer.VectorTile.prototype.getPreload = function() { - return /** @type {number} */ (this.get(ol.layer.VectorTileProperty.PRELOAD)); + return /** @type {number} */ (this.get(ol.layer.VectorTile.Property.PRELOAD)); }; @@ -84,7 +75,7 @@ ol.layer.VectorTile.prototype.getRenderMode = function() { */ ol.layer.VectorTile.prototype.getUseInterimTilesOnError = function() { return /** @type {boolean} */ ( - this.get(ol.layer.VectorTileProperty.USE_INTERIM_TILES_ON_ERROR)); + this.get(ol.layer.VectorTile.Property.USE_INTERIM_TILES_ON_ERROR)); }; @@ -111,6 +102,15 @@ ol.layer.VectorTile.prototype.setUseInterimTilesOnError = function(useInterimTil }; +/** + * @enum {string} + */ +ol.layer.VectorTile.Property = { + PRELOAD: 'preload', + USE_INTERIM_TILES_ON_ERROR: 'useInterimTilesOnError' +}; + + /** * @enum {string} * Render mode for vector tiles: diff --git a/src/ol/render/event.js b/src/ol/render/event.js index 64560e32c4..4660b7e1f4 100644 --- a/src/ol/render/event.js +++ b/src/ol/render/event.js @@ -1,37 +1,14 @@ goog.provide('ol.render.Event'); -goog.provide('ol.render.EventType'); goog.require('ol'); goog.require('ol.events.Event'); -/** - * @enum {string} - */ -ol.render.EventType = { - /** - * @event ol.render.Event#postcompose - * @api - */ - POSTCOMPOSE: 'postcompose', - /** - * @event ol.render.Event#precompose - * @api - */ - PRECOMPOSE: 'precompose', - /** - * @event ol.render.Event#render - * @api - */ - RENDER: 'render' -}; - - /** * @constructor * @extends {ol.events.Event} * @implements {oli.render.Event} - * @param {ol.render.EventType} type Type. + * @param {ol.render.Event.Type} type Type. * @param {ol.render.VectorContext=} opt_vectorContext Vector context. * @param {olx.FrameState=} opt_frameState Frame state. * @param {?CanvasRenderingContext2D=} opt_context Context. @@ -75,3 +52,25 @@ ol.render.Event = function( }; ol.inherits(ol.render.Event, ol.events.Event); + + +/** + * @enum {string} + */ +ol.render.Event.Type = { + /** + * @event ol.render.Event#postcompose + * @api + */ + POSTCOMPOSE: 'postcompose', + /** + * @event ol.render.Event#precompose + * @api + */ + PRECOMPOSE: 'precompose', + /** + * @event ol.render.Event#render + * @api + */ + RENDER: 'render' +}; diff --git a/src/ol/renderer/canvas/layer.js b/src/ol/renderer/canvas/layer.js index 296f4d8fe4..a9df0e7dea 100644 --- a/src/ol/renderer/canvas/layer.js +++ b/src/ol/renderer/canvas/layer.js @@ -3,7 +3,6 @@ goog.provide('ol.renderer.canvas.Layer'); goog.require('ol'); goog.require('ol.extent'); goog.require('ol.render.Event'); -goog.require('ol.render.EventType'); goog.require('ol.render.canvas'); goog.require('ol.render.canvas.Immediate'); goog.require('ol.renderer.Layer'); @@ -109,7 +108,7 @@ ol.renderer.canvas.Layer.prototype.composeFrame = function(frameState, layerStat /** - * @param {ol.render.EventType} type Event type. + * @param {ol.render.Event.Type} type Event type. * @param {CanvasRenderingContext2D} context Context. * @param {olx.FrameState} frameState Frame state. * @param {ol.Transform=} opt_transform Transform. @@ -142,7 +141,7 @@ ol.renderer.canvas.Layer.prototype.dispatchComposeEvent_ = function(type, contex * @protected */ ol.renderer.canvas.Layer.prototype.dispatchPostComposeEvent = function(context, frameState, opt_transform) { - this.dispatchComposeEvent_(ol.render.EventType.POSTCOMPOSE, context, + this.dispatchComposeEvent_(ol.render.Event.Type.POSTCOMPOSE, context, frameState, opt_transform); }; @@ -154,7 +153,7 @@ ol.renderer.canvas.Layer.prototype.dispatchPostComposeEvent = function(context, * @protected */ ol.renderer.canvas.Layer.prototype.dispatchPreComposeEvent = function(context, frameState, opt_transform) { - this.dispatchComposeEvent_(ol.render.EventType.PRECOMPOSE, context, + this.dispatchComposeEvent_(ol.render.Event.Type.PRECOMPOSE, context, frameState, opt_transform); }; @@ -166,7 +165,7 @@ ol.renderer.canvas.Layer.prototype.dispatchPreComposeEvent = function(context, f * @protected */ ol.renderer.canvas.Layer.prototype.dispatchRenderEvent = function(context, frameState, opt_transform) { - this.dispatchComposeEvent_(ol.render.EventType.RENDER, context, + this.dispatchComposeEvent_(ol.render.Event.Type.RENDER, context, frameState, opt_transform); }; diff --git a/src/ol/renderer/canvas/map.js b/src/ol/renderer/canvas/map.js index 111085d11d..6dcb6a10a6 100644 --- a/src/ol/renderer/canvas/map.js +++ b/src/ol/renderer/canvas/map.js @@ -13,7 +13,6 @@ goog.require('ol.layer.Tile'); goog.require('ol.layer.Vector'); goog.require('ol.layer.VectorTile'); goog.require('ol.render.Event'); -goog.require('ol.render.EventType'); goog.require('ol.render.canvas'); goog.require('ol.render.canvas.Immediate'); goog.require('ol.renderer.Map'); @@ -88,7 +87,7 @@ ol.renderer.canvas.Map.prototype.createLayerRenderer = function(layer) { /** - * @param {ol.render.EventType} type Event type. + * @param {ol.render.Event.Type} type Event type. * @param {olx.FrameState} frameState Frame state. * @private */ @@ -166,7 +165,7 @@ ol.renderer.canvas.Map.prototype.renderFrame = function(frameState) { this.calculateMatrices2D(frameState); - this.dispatchComposeEvent_(ol.render.EventType.PRECOMPOSE, frameState); + this.dispatchComposeEvent_(ol.render.Event.Type.PRECOMPOSE, frameState); var layerStatesArray = frameState.layerStatesArray; ol.array.stableSort(layerStatesArray, ol.renderer.Map.sortByZIndex); @@ -191,7 +190,7 @@ ol.renderer.canvas.Map.prototype.renderFrame = function(frameState) { ol.render.canvas.rotateAtOffset(context, -rotation, width / 2, height / 2); this.dispatchComposeEvent_( - ol.render.EventType.POSTCOMPOSE, frameState); + ol.render.Event.Type.POSTCOMPOSE, frameState); if (!this.renderedVisible_) { this.canvas_.style.display = ''; diff --git a/src/ol/renderer/canvas/tilelayer.js b/src/ol/renderer/canvas/tilelayer.js index 01db493250..d827100352 100644 --- a/src/ol/renderer/canvas/tilelayer.js +++ b/src/ol/renderer/canvas/tilelayer.js @@ -10,7 +10,7 @@ goog.require('ol.array'); goog.require('ol.dom'); goog.require('ol.extent'); goog.require('ol.render.canvas'); -goog.require('ol.render.EventType'); +goog.require('ol.render.Event'); goog.require('ol.renderer.canvas.Layer'); goog.require('ol.size'); @@ -235,7 +235,7 @@ ol.renderer.canvas.TileLayer.prototype.renderTileImages = function(context, fram var tileGutter = pixelRatio * source.getGutter(projection); var tileGrid = source.getTileGridForProjection(projection); - var hasRenderListeners = layer.hasListener(ol.render.EventType.RENDER); + var hasRenderListeners = layer.hasListener(ol.render.Event.Type.RENDER); var renderContext = context; var drawScale = 1; var drawOffsetX, drawOffsetY, drawSize; diff --git a/src/ol/renderer/canvas/vectorlayer.js b/src/ol/renderer/canvas/vectorlayer.js index f3164df2bb..8addea4e39 100644 --- a/src/ol/renderer/canvas/vectorlayer.js +++ b/src/ol/renderer/canvas/vectorlayer.js @@ -4,7 +4,7 @@ goog.require('ol'); goog.require('ol.View'); goog.require('ol.dom'); goog.require('ol.extent'); -goog.require('ol.render.EventType'); +goog.require('ol.render.Event'); goog.require('ol.render.canvas'); goog.require('ol.render.canvas.ReplayGroup'); goog.require('ol.renderer.canvas.Layer'); @@ -97,7 +97,7 @@ ol.renderer.canvas.VectorLayer.prototype.composeFrame = function(frameState, lay var drawOffsetX = 0; var drawOffsetY = 0; var replayContext; - if (layer.hasListener(ol.render.EventType.RENDER)) { + if (layer.hasListener(ol.render.Event.Type.RENDER)) { var drawWidth = context.canvas.width; var drawHeight = context.canvas.height; if (rotation) { diff --git a/src/ol/renderer/canvas/vectortilelayer.js b/src/ol/renderer/canvas/vectortilelayer.js index a6623ba6ac..559ddf29fb 100644 --- a/src/ol/renderer/canvas/vectortilelayer.js +++ b/src/ol/renderer/canvas/vectortilelayer.js @@ -6,7 +6,7 @@ goog.require('ol.extent'); goog.require('ol.proj'); goog.require('ol.proj.Units'); goog.require('ol.layer.VectorTile'); -goog.require('ol.render.EventType'); +goog.require('ol.render.Event'); goog.require('ol.render.ReplayType'); goog.require('ol.render.canvas'); goog.require('ol.render.canvas.ReplayGroup'); @@ -123,7 +123,7 @@ ol.renderer.canvas.VectorTileLayer.prototype.renderTileReplays_ = function( var transform = this.getTransform(frameState, 0); var replayContext; - if (layer.hasListener(ol.render.EventType.RENDER)) { + if (layer.hasListener(ol.render.Event.Type.RENDER)) { // resize and clear this.context.canvas.width = context.canvas.width; this.context.canvas.height = context.canvas.height; diff --git a/src/ol/renderer/webgl/layer.js b/src/ol/renderer/webgl/layer.js index 5ce02c846d..e6f7da508d 100644 --- a/src/ol/renderer/webgl/layer.js +++ b/src/ol/renderer/webgl/layer.js @@ -2,7 +2,6 @@ goog.provide('ol.renderer.webgl.Layer'); goog.require('ol'); goog.require('ol.render.Event'); -goog.require('ol.render.EventType'); goog.require('ol.render.webgl.Immediate'); goog.require('ol.renderer.Layer'); goog.require('ol.renderer.webgl.defaultmapshader'); @@ -140,7 +139,7 @@ ol.renderer.webgl.Layer.prototype.bindFramebuffer = function(frameState, framebu ol.renderer.webgl.Layer.prototype.composeFrame = function(frameState, layerState, context) { this.dispatchComposeEvent_( - ol.render.EventType.PRECOMPOSE, context, frameState); + ol.render.Event.Type.PRECOMPOSE, context, frameState); context.bindBuffer(ol.webgl.ARRAY_BUFFER, this.arrayBuffer_); @@ -179,13 +178,13 @@ ol.renderer.webgl.Layer.prototype.composeFrame = function(frameState, layerState gl.drawArrays(ol.webgl.TRIANGLE_STRIP, 0, 4); this.dispatchComposeEvent_( - ol.render.EventType.POSTCOMPOSE, context, frameState); + ol.render.Event.Type.POSTCOMPOSE, context, frameState); }; /** - * @param {ol.render.EventType} type Event type. + * @param {ol.render.Event.Type} type Event type. * @param {ol.webgl.Context} context WebGL context. * @param {olx.FrameState} frameState Frame state. * @private diff --git a/src/ol/renderer/webgl/map.js b/src/ol/renderer/webgl/map.js index 9e80bd70e6..607d86600b 100644 --- a/src/ol/renderer/webgl/map.js +++ b/src/ol/renderer/webgl/map.js @@ -12,7 +12,6 @@ goog.require('ol.layer.Layer'); goog.require('ol.layer.Tile'); goog.require('ol.layer.Vector'); goog.require('ol.render.Event'); -goog.require('ol.render.EventType'); goog.require('ol.render.webgl.Immediate'); goog.require('ol.renderer.Map'); goog.require('ol.renderer.Type'); @@ -251,7 +250,7 @@ ol.renderer.webgl.Map.prototype.createLayerRenderer = function(layer) { /** - * @param {ol.render.EventType} type Event type. + * @param {ol.render.Event.Type} type Event type. * @param {olx.FrameState} frameState Frame state. * @private */ @@ -433,7 +432,7 @@ ol.renderer.webgl.Map.prototype.renderFrame = function(frameState) { this.textureCache_.set((-frameState.index).toString(), null); ++this.textureCacheFrameMarkerCount_; - this.dispatchComposeEvent_(ol.render.EventType.PRECOMPOSE, frameState); + this.dispatchComposeEvent_(ol.render.Event.Type.PRECOMPOSE, frameState); /** @type {Array.} */ var layerStatesToDraw = []; @@ -492,7 +491,7 @@ ol.renderer.webgl.Map.prototype.renderFrame = function(frameState) { frameState.animate = true; } - this.dispatchComposeEvent_(ol.render.EventType.POSTCOMPOSE, frameState); + this.dispatchComposeEvent_(ol.render.Event.Type.POSTCOMPOSE, frameState); this.scheduleRemoveUnusedLayerRenderers(frameState); this.scheduleExpireIconCache(frameState); diff --git a/src/ol/style/stroke.js b/src/ol/style/stroke.js index 5d11b69fc3..7a6b6b8f6f 100644 --- a/src/ol/style/stroke.js +++ b/src/ol/style/stroke.js @@ -1,5 +1,7 @@ goog.provide('ol.style.Stroke'); +goog.require('ol'); + /** * @classdesc