Merge pull request #535 from twpayne/renderer-clean-ups

Renderer clean-ups
This commit is contained in:
Tom Payne
2013-04-12 02:49:56 -07:00
12 changed files with 78 additions and 55 deletions

View File

@@ -48,6 +48,7 @@ ol.renderer.canvas.ImageLayer.prototype.getImage = function() {
/**
* @protected
* @return {ol.layer.ImageLayer} Single image layer.
*/
ol.renderer.canvas.ImageLayer.prototype.getImageLayer = function() {

View File

@@ -86,6 +86,7 @@ ol.renderer.canvas.TileLayer.prototype.getImage = function() {
/**
* @protected
* @return {ol.layer.TileLayer} Tile layer.
*/
ol.renderer.canvas.TileLayer.prototype.getTileLayer = function() {

View File

@@ -45,6 +45,7 @@ goog.inherits(ol.renderer.dom.ImageLayer, ol.renderer.dom.Layer);
/**
* @protected
* @return {ol.layer.ImageLayer} Image layer.
*/
ol.renderer.dom.ImageLayer.prototype.getImageLayer = function() {
@@ -109,7 +110,7 @@ ol.renderer.dom.ImageLayer.prototype.renderFrame =
goog.dom.appendChild(this.target, imageElement);
this.image_ = image;
}
this.setTransform(transform);
this.setTransform_(transform);
this.updateAttributions(frameState.attributions, image.getAttributions());
this.updateLogos(frameState, imageSource);
@@ -120,8 +121,9 @@ ol.renderer.dom.ImageLayer.prototype.renderFrame =
/**
* @param {goog.vec.Mat4.AnyType} transform Transform.
* @private
*/
ol.renderer.dom.ImageLayer.prototype.setTransform = function(transform) {
ol.renderer.dom.ImageLayer.prototype.setTransform_ = function(transform) {
if (!goog.vec.Mat4.equals(transform, this.transform_)) {
ol.dom.transformElement2D(this.target, transform, 6);
goog.vec.Mat4.setFromArray(this.transform_, transform);

View File

@@ -37,6 +37,7 @@ ol.renderer.dom.Layer.prototype.disposeInternal = function() {
/**
* @protected
* @return {!Element} Target.
*/
ol.renderer.dom.Layer.prototype.getTarget = function() {

View File

@@ -56,8 +56,10 @@ ol.renderer.dom.Map.prototype.createLayerRenderer = function(layer) {
layerRenderer = new ol.renderer.dom.TileLayer(this, layer);
} else if (layer instanceof ol.layer.ImageLayer) {
layerRenderer = new ol.renderer.dom.ImageLayer(this, layer);
} else {
goog.asserts.fail();
return null;
}
goog.asserts.assert(goog.isDef(layerRenderer));
goog.dom.appendChild(this.layersPane_, layerRenderer.getTarget());
return layerRenderer;
};

View File

@@ -61,6 +61,7 @@ goog.inherits(ol.renderer.dom.TileLayer, ol.renderer.dom.Layer);
/**
* @protected
* @return {ol.layer.TileLayer} Tile layer.
*/
ol.renderer.dom.TileLayer.prototype.getTileLayer = function() {

View File

@@ -81,6 +81,7 @@ ol.renderer.Layer.prototype.dispatchChangeEvent = function() {
/**
* @protected
* @return {ol.layer.Layer} Layer.
*/
ol.renderer.Layer.prototype.getLayer = function() {
@@ -89,6 +90,7 @@ ol.renderer.Layer.prototype.getLayer = function() {
/**
* @protected
* @return {ol.Map} Map.
*/
ol.renderer.Layer.prototype.getMap = function() {
@@ -97,6 +99,7 @@ ol.renderer.Layer.prototype.getMap = function() {
/**
* @protected
* @return {ol.renderer.Map} Map renderer.
*/
ol.renderer.Layer.prototype.getMapRenderer = function() {
@@ -186,9 +189,9 @@ ol.renderer.Layer.prototype.renderFrame = goog.abstractMethod;
/**
* @protected
* @param {ol.FrameState} frameState Frame state.
* @param {ol.source.TileSource} tileSource Tile source.
* @protected
*/
ol.renderer.Layer.prototype.scheduleExpireCache =
function(frameState, tileSource) {
@@ -203,10 +206,10 @@ ol.renderer.Layer.prototype.scheduleExpireCache =
/**
* @protected
* @param {Object.<string, ol.Attribution>} attributionsSet Attributions
* set (target).
* @param {Array.<ol.Attribution>} attributions Attributions (source).
* @protected
*/
ol.renderer.Layer.prototype.updateAttributions =
function(attributionsSet, attributions) {
@@ -222,9 +225,9 @@ ol.renderer.Layer.prototype.updateAttributions =
/**
* @protected
* @param {ol.FrameState} frameState Frame state.
* @param {ol.source.Source} source Source.
* @protected
*/
ol.renderer.Layer.prototype.updateLogos = function(frameState, source) {
var logo = source.getLogo();
@@ -235,11 +238,11 @@ ol.renderer.Layer.prototype.updateLogos = function(frameState, source) {
/**
* @protected
* @param {Object.<string, Object.<string, ol.TileRange>>} usedTiles Used tiles.
* @param {ol.source.TileSource} tileSource Tile source.
* @param {number} z Z.
* @param {ol.TileRange} tileRange Tile range.
* @protected
*/
ol.renderer.Layer.prototype.updateUsedTiles =
function(usedTiles, tileSource, z, tileRange) {
@@ -264,6 +267,7 @@ ol.renderer.Layer.prototype.updateUsedTiles =
* determine if the tile is loaded.
* @param {ol.source.TileSource} tileSource Tile source.
* @param {ol.Projection} projection Projection.
* @protected
* @return {function(number, number, number): ol.Tile} Returns a tile if it is
* loaded.
*/
@@ -280,8 +284,8 @@ ol.renderer.Layer.prototype.createGetTileIfLoadedFunction =
* @param {ol.Coordinate} center Center.
* @param {number} resolution Resolution.
* @param {ol.Size} size Size.
* @return {ol.Coordinate} Snapped center.
* @protected
* @return {ol.Coordinate} Snapped center.
*/
ol.renderer.Layer.prototype.snapCenterToPixel =
function(center, resolution, size) {

View File

@@ -35,16 +35,16 @@ ol.renderer.Map = function(container, map) {
this.container_ = container;
/**
* @protected
* @private
* @type {ol.Map}
*/
this.map = map;
this.map_ = map;
/**
* @protected
* @private
* @type {Object.<number, ol.renderer.Layer>}
*/
this.layerRenderers = {};
this.layerRenderers_ = {};
//
// We listen to layer add/remove to add/remove layer renderers.
@@ -57,7 +57,7 @@ ol.renderer.Map = function(container, map) {
this.mapLayersChangedListenerKey_ =
goog.events.listen(
map, ol.Object.getChangedEventType(ol.MapProperty.LAYERS),
this.handleLayersChanged, false, this);
this.handleLayersChanged_, false, this);
/**
* @private
@@ -77,11 +77,11 @@ goog.inherits(ol.renderer.Map, goog.Disposable);
/**
* @param {ol.layer.Layer} layer Layer.
* @protected
* @private
*/
ol.renderer.Map.prototype.addLayer = function(layer) {
ol.renderer.Map.prototype.addLayer_ = function(layer) {
var layerRenderer = this.createLayerRenderer(layer);
this.setLayerRenderer(layer, layerRenderer);
this.setLayerRenderer_(layer, layerRenderer);
this.getMap().render();
};
@@ -132,7 +132,7 @@ ol.renderer.Map.prototype.createLayerRenderer = function(layer) {
* @inheritDoc
*/
ol.renderer.Map.prototype.disposeInternal = function() {
goog.object.forEach(this.layerRenderers, function(layerRenderer) {
goog.object.forEach(this.layerRenderers_, function(layerRenderer) {
goog.dispose(layerRenderer);
});
goog.events.unlistenByKey(this.mapLayersChangedListenerKey_);
@@ -156,57 +156,66 @@ ol.renderer.Map.prototype.getCanvas = goog.functions.NULL;
*/
ol.renderer.Map.prototype.getLayerRenderer = function(layer) {
var layerKey = goog.getUid(layer);
var layerRenderer = this.layerRenderers[layerKey];
var layerRenderer = this.layerRenderers_[layerKey];
goog.asserts.assert(goog.isDef(layerRenderer));
return layerRenderer;
};
/**
* @protected
* @return {Object.<number, ol.renderer.Layer>} Layer renderers.
*/
ol.renderer.Map.prototype.getLayerRenderers = function() {
return this.layerRenderers_;
};
/**
* @return {ol.Map} Map.
*/
ol.renderer.Map.prototype.getMap = function() {
return this.map;
return this.map_;
};
/**
* @param {goog.events.Event} event Event.
* @protected
* @private
*/
ol.renderer.Map.prototype.handleLayerRendererChange = function(event) {
ol.renderer.Map.prototype.handleLayerRendererChange_ = function(event) {
this.getMap().render();
};
/**
* @param {ol.CollectionEvent} collectionEvent Collection event.
* @protected
* @private
*/
ol.renderer.Map.prototype.handleLayersAdd = function(collectionEvent) {
ol.renderer.Map.prototype.handleLayersAdd_ = function(collectionEvent) {
var layer = /** @type {ol.layer.Layer} */ (collectionEvent.elem);
this.addLayer(layer);
this.addLayer_(layer);
};
/**
* @protected
* @private
*/
ol.renderer.Map.prototype.handleLayersChanged = function() {
goog.disposeAll(goog.object.getValues(this.layerRenderers));
this.layerRenderers = {};
ol.renderer.Map.prototype.handleLayersChanged_ = function() {
goog.disposeAll(goog.object.getValues(this.layerRenderers_));
this.layerRenderers_ = {};
if (!goog.isNull(this.layersListenerKeys_)) {
goog.array.forEach(this.layersListenerKeys_, goog.events.unlistenByKey);
this.layersListenerKeys_ = null;
}
var layers = this.map.getLayers();
var layers = this.getMap().getLayers();
if (goog.isDefAndNotNull(layers)) {
layers.forEach(this.addLayer, this);
layers.forEach(this.addLayer_, this);
this.layersListenerKeys_ = [
goog.events.listen(layers, ol.CollectionEventType.ADD,
this.handleLayersAdd, false, this),
this.handleLayersAdd_, false, this),
goog.events.listen(layers, ol.CollectionEventType.REMOVE,
this.handleLayersRemove, false, this)
this.handleLayersRemove_, false, this)
];
}
};
@@ -214,20 +223,20 @@ ol.renderer.Map.prototype.handleLayersChanged = function() {
/**
* @param {ol.CollectionEvent} collectionEvent Collection event.
* @protected
* @private
*/
ol.renderer.Map.prototype.handleLayersRemove = function(collectionEvent) {
ol.renderer.Map.prototype.handleLayersRemove_ = function(collectionEvent) {
var layer = /** @type {ol.layer.Layer} */ (collectionEvent.elem);
this.removeLayer(layer);
this.removeLayer_(layer);
};
/**
* @param {ol.layer.Layer} layer Layer.
* @protected
* @private
*/
ol.renderer.Map.prototype.removeLayer = function(layer) {
goog.dispose(this.removeLayerRenderer(layer));
ol.renderer.Map.prototype.removeLayer_ = function(layer) {
goog.dispose(this.removeLayerRenderer_(layer));
this.getMap().render();
};
@@ -235,13 +244,13 @@ ol.renderer.Map.prototype.removeLayer = function(layer) {
/**
* @param {ol.layer.Layer} layer Layer.
* @return {ol.renderer.Layer} Layer renderer.
* @protected
* @private
*/
ol.renderer.Map.prototype.removeLayerRenderer = function(layer) {
ol.renderer.Map.prototype.removeLayerRenderer_ = function(layer) {
var layerKey = goog.getUid(layer);
if (layerKey in this.layerRenderers) {
var layerRenderer = this.layerRenderers[layerKey];
delete this.layerRenderers[layerKey];
if (layerKey in this.layerRenderers_) {
var layerRenderer = this.layerRenderers_[layerKey];
delete this.layerRenderers_[layerKey];
goog.events.unlistenByKey(this.layerRendererChangeListenKeys_[layerKey]);
delete this.layerRendererChangeListenKeys_[layerKey];
return layerRenderer;
@@ -261,14 +270,14 @@ ol.renderer.Map.prototype.renderFrame = goog.nullFunction;
/**
* @param {ol.layer.Layer} layer Layer.
* @param {ol.renderer.Layer} layerRenderer Layer renderer.
* @protected
* @private
*/
ol.renderer.Map.prototype.setLayerRenderer = function(layer, layerRenderer) {
ol.renderer.Map.prototype.setLayerRenderer_ = function(layer, layerRenderer) {
var layerKey = goog.getUid(layer);
goog.asserts.assert(!(layerKey in this.layerRenderers));
this.layerRenderers[layerKey] = layerRenderer;
goog.asserts.assert(!(layerKey in this.layerRenderers_));
this.layerRenderers_[layerKey] = layerRenderer;
goog.asserts.assert(!(layerKey in this.layerRendererChangeListenKeys_));
this.layerRendererChangeListenKeys_[layerKey] = goog.events.listen(
layerRenderer, goog.events.EventType.CHANGE,
this.handleLayerRendererChange, false, this);
this.handleLayerRendererChange_, false, this);
};

View File

@@ -37,8 +37,8 @@ goog.inherits(ol.renderer.webgl.ImageLayer, ol.renderer.webgl.Layer);
/**
* @private
* @param {ol.Image} image Image.
* @private
* @return {WebGLTexture} Texture.
*/
ol.renderer.webgl.ImageLayer.prototype.createTexture_ = function(image) {
@@ -72,6 +72,7 @@ ol.renderer.webgl.ImageLayer.prototype.createTexture_ = function(image) {
/**
* @protected
* @return {ol.layer.ImageLayer} Tile layer.
*/
ol.renderer.webgl.ImageLayer.prototype.getImageLayer = function() {
@@ -147,13 +148,13 @@ ol.renderer.webgl.ImageLayer.prototype.renderFrame =
/**
* @private
* @param {number} canvasWidth Canvas width.
* @param {number} canvasHeight Canvas height.
* @param {ol.Coordinate} viewCenter View center.
* @param {number} viewResolution View resolution.
* @param {number} viewRotation View rotation.
* @param {ol.Extent} imageExtent Image extent.
* @private
*/
ol.renderer.webgl.ImageLayer.prototype.updateProjectionMatrix_ =
function(canvasWidth, canvasHeight, viewCenter,

View File

@@ -157,6 +157,7 @@ ol.renderer.webgl.Layer.prototype.getColorMatrix = function() {
/**
* @protected
* @return {ol.renderer.webgl.Map} MapRenderer.
*/
ol.renderer.webgl.Layer.prototype.getWebGLMapRenderer = function() {

View File

@@ -296,15 +296,14 @@ ol.renderer.webgl.Map.prototype.bindTileTexture =
* @inheritDoc
*/
ol.renderer.webgl.Map.prototype.createLayerRenderer = function(layer) {
var layerRenderer = null;
if (layer instanceof ol.layer.TileLayer) {
layerRenderer = new ol.renderer.webgl.TileLayer(this, layer);
return new ol.renderer.webgl.TileLayer(this, layer);
} else if (layer instanceof ol.layer.ImageLayer) {
layerRenderer = new ol.renderer.webgl.ImageLayer(this, layer);
return new ol.renderer.webgl.ImageLayer(this, layer);
} else {
goog.asserts.fail();
return null;
}
return layerRenderer;
};
@@ -464,7 +463,7 @@ ol.renderer.webgl.Map.prototype.handleWebGLContextLost = function(event) {
this.programCache_ = {};
this.textureCache_.clear();
this.textureCacheFrameMarkerCount_ = 0;
goog.object.forEach(this.layerRenderers, function(layerRenderer) {
goog.object.forEach(this.getLayerRenderers(), function(layerRenderer) {
layerRenderer.handleWebGLContextLost();
});
};

View File

@@ -88,6 +88,7 @@ ol.renderer.webgl.TileLayer.prototype.disposeInternal = function() {
/**
* @protected
* @return {ol.layer.TileLayer} Tile layer.
*/
ol.renderer.webgl.TileLayer.prototype.getTileLayer = function() {