Merge pull request #5859 from fredj/rname_ol.RendererType

Rename ol.RendererType to ol.renderer.Type

changelog/upgrade-notes.md

@@ -18,6 +18,7 @@ A number of internal types have been renamed.  This will not affect those who us
  * rename `ol.layer.GroupProperty` to `ol.layer.Group.Property`
  * rename `ol.layer.HeatmapLayerProperty` to `ol.layer.Heatmap.Property`
  * rename `ol.layer.VectorTileRenderType` to `ol.layer.VectorTile.RenderType`
+ * rename `ol.RendererType` to `ol.renderer.Type`
  * rename `ol.source.TileEvent` to `ol.source.Tile.Event`
  * rename `ol.source.TileEventType` to `ol.source.Tile.EventType`
  * rename `ol.source.VectorEvent` to `ol.source.Vector.Event`

externs/olx.js

@@ -171,7 +171,7 @@ olx.interaction.InteractionOptions.prototype.handleEvent;
  *     loadTilesWhileInteracting: (boolean|undefined),
  *     logo: (boolean|string|olx.LogoOptions|Element|undefined),
  *     overlays: (ol.Collection.<ol.Overlay>|Array.<ol.Overlay>|undefined),
- *     renderer: (ol.RendererType|Array.<ol.RendererType|string>|string|undefined),
+ *     renderer: (ol.renderer.Type|Array.<ol.renderer.Type|string>|string|undefined),
  *     target: (Element|string|undefined),
  *     view: (ol.View|undefined)}}
  */
@@ -274,10 +274,10 @@ olx.MapOptions.prototype.overlays;
 /**
  * Renderer. By default, Canvas and WebGL renderers are tested for support
  * in that order, and the first supported used. Specify a
- * {@link ol.RendererType} here to use a specific renderer.
+ * {@link ol.renderer.Type} here to use a specific renderer.
  * Note that the Canvas renderer fully supports vector data, but WebGL can only
  * render Point geometries.
- * @type {ol.RendererType|Array.<ol.RendererType|string>|string|undefined}
+ * @type {ol.renderer.Type|Array.<ol.renderer.Type|string>|string|undefined}
  * @api stable
  */
 olx.MapOptions.prototype.renderer;

src/ol/map.js

@@ -14,7 +14,6 @@ goog.require('ol.MapEvent');
 goog.require('ol.MapEventType');
 goog.require('ol.Object');
 goog.require('ol.ObjectEventType');
-goog.require('ol.RendererType');
 goog.require('ol.TileQueue');
 goog.require('ol.View');
 goog.require('ol.array');
@@ -31,6 +30,7 @@ goog.require('ol.interaction');
 goog.require('ol.layer.Group');
 goog.require('ol.obj');
 goog.require('ol.proj.common');
+goog.require('ol.renderer.Type');
 goog.require('ol.renderer.Map');
 goog.require('ol.renderer.canvas.Map');
 goog.require('ol.renderer.webgl.Map');
@@ -75,12 +75,12 @@ ol.OL3_LOGO_URL = 'data:image/png;base64,' +
 
 
 /**
- * @type {Array.<ol.RendererType>}
+ * @type {Array.<ol.renderer.Type>}
  * @const
  */
 ol.DEFAULT_RENDERER_TYPES = [
-  ol.RendererType.CANVAS,
-  ol.RendererType.WEBGL
+  ol.renderer.Type.CANVAS,
+  ol.renderer.Type.WEBGL
 ];
 
 
@@ -1462,7 +1462,7 @@ ol.Map.createOptionsInternal = function(options) {
   var rendererConstructor = ol.renderer.Map;
 
   /**
-   * @type {Array.<ol.RendererType>}
+   * @type {Array.<ol.renderer.Type>}
    */
   var rendererTypes;
   if (options.renderer !== undefined) {
@@ -1473,7 +1473,7 @@ ol.Map.createOptionsInternal = function(options) {
     } else {
       ol.asserts.assert(false, 46); // Incorrect format for `renderer` option
     }
-    if (rendererTypes.indexOf(/** @type {ol.RendererType} */ ('dom')) >= 0) {
+    if (rendererTypes.indexOf(/** @type {ol.renderer.Type} */ ('dom')) >= 0) {
       ol.DEBUG && console.assert(false, 'The DOM render has been removed');
       rendererTypes = rendererTypes.concat(ol.DEFAULT_RENDERER_TYPES);
     }
@@ -1483,14 +1483,14 @@ ol.Map.createOptionsInternal = function(options) {
 
   var i, ii;
   for (i = 0, ii = rendererTypes.length; i < ii; ++i) {
-    /** @type {ol.RendererType} */
+    /** @type {ol.renderer.Type} */
     var rendererType = rendererTypes[i];
-    if (ol.ENABLE_CANVAS && rendererType == ol.RendererType.CANVAS) {
+    if (ol.ENABLE_CANVAS && rendererType == ol.renderer.Type.CANVAS) {
       if (ol.has.CANVAS) {
         rendererConstructor = ol.renderer.canvas.Map;
         break;
       }
-    } else if (ol.ENABLE_WEBGL && rendererType == ol.RendererType.WEBGL) {
+    } else if (ol.ENABLE_WEBGL && rendererType == ol.renderer.Type.WEBGL) {
       if (ol.has.WEBGL) {
         rendererConstructor = ol.renderer.webgl.Map;
         break;

src/ol/renderer/canvas/map.js

@@ -4,7 +4,6 @@ goog.provide('ol.renderer.canvas.Map');
 
 goog.require('ol.transform');
 goog.require('ol');
-goog.require('ol.RendererType');
 goog.require('ol.array');
 goog.require('ol.css');
 goog.require('ol.dom');
@@ -18,6 +17,7 @@ goog.require('ol.render.EventType');
 goog.require('ol.render.canvas');
 goog.require('ol.render.canvas.Immediate');
 goog.require('ol.renderer.Map');
+goog.require('ol.renderer.Type');
 goog.require('ol.renderer.canvas.ImageLayer');
 goog.require('ol.renderer.canvas.TileLayer');
 goog.require('ol.renderer.canvas.VectorLayer');
@@ -134,7 +134,7 @@ ol.renderer.canvas.Map.prototype.getTransform = function(frameState) {
  * @inheritDoc
  */
 ol.renderer.canvas.Map.prototype.getType = function() {
-  return ol.RendererType.CANVAS;
+  return ol.renderer.Type.CANVAS;
 };
 
 

src/ol/renderer/index.jsdoc

@@ -0,0 +1,3 @@
+/**
+ * @namespace ol.renderer
+ */

src/ol/renderer/map.js

@@ -1,5 +1,4 @@
 goog.provide('ol.renderer.Map');
-goog.provide('ol.RendererType');
 
 goog.require('ol');
 goog.require('ol.Disposable');
@@ -12,16 +11,6 @@ goog.require('ol.style');
 goog.require('ol.transform');
 
 
-/**
- * Available renderers: `'canvas'` or `'webgl'`.
- * @enum {string}
- */
-ol.RendererType = {
-  CANVAS: 'canvas',
-  WEBGL: 'webgl'
-};
-
-
 /**
  * @constructor
  * @extends {ol.Disposable}

src/ol/renderer/type.js

@@ -0,0 +1,11 @@
+goog.provide('ol.renderer.Type');
+
+
+/**
+ * Available renderers: `'canvas'` or `'webgl'`.
+ * @enum {string}
+ */
+ol.renderer.Type = {
+  CANVAS: 'canvas',
+  WEBGL: 'webgl'
+};

src/ol/renderer/webgl/map.js

@@ -3,7 +3,6 @@
 goog.provide('ol.renderer.webgl.Map');
 
 goog.require('ol');
-goog.require('ol.RendererType');
 goog.require('ol.array');
 goog.require('ol.css');
 goog.require('ol.dom');
@@ -16,6 +15,7 @@ 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');
 goog.require('ol.renderer.webgl.ImageLayer');
 goog.require('ol.renderer.webgl.TileLayer');
 goog.require('ol.renderer.webgl.VectorLayer');
@@ -353,7 +353,7 @@ ol.renderer.webgl.Map.prototype.getTileTextureQueue = function() {
  * @inheritDoc
  */
 ol.renderer.webgl.Map.prototype.getType = function() {
-  return ol.RendererType.WEBGL;
+  return ol.renderer.Type.WEBGL;
 };