Files
openlayers/src/ol/map.js
2012-07-14 18:34:39 +02:00

373 lines
8.5 KiB
JavaScript

goog.provide('ol.Map');
goog.provide('ol.MapProperty');
goog.require('goog.array');
goog.require('goog.events');
goog.require('goog.events.Event');
goog.require('goog.events.EventType');
goog.require('goog.math.Coordinate');
goog.require('goog.object');
goog.require('ol.Array');
goog.require('ol.Extent');
goog.require('ol.LayerRenderer');
goog.require('ol.Object');
goog.require('ol.Projection');
/**
* @enum {string}
*/
ol.MapProperty = {
CENTER: 'center',
EXTENT: 'extent',
LAYERS: 'layers',
PROJECTION: 'projection',
RESOLUTION: 'resolution'
};
/**
* @constructor
* @extends {ol.Object}
* @param {HTMLDivElement} target Target.
* @param {Object=} opt_values Values.
*/
ol.Map = function(target, opt_values) {
goog.base(this);
/**
* @private
* @type {HTMLDivElement}
*/
this.target_ = target;
/**
* @private
* @type {goog.math.Size}
*/
this.size_ = new goog.math.Size(target.clientWidth, target.clientHeight);
/**
* @private
* @type {Array.<number>}
*/
this.layersListenerKeys_ = null;
/**
* @private
* @type {Object.<number, ol.LayerRenderer>}
*/
this.layerRenderers_ = {};
goog.events.listen(target, goog.events.EventType.RESIZE,
this.handleTargetResize, false, this);
goog.events.listen(
this, ol.Object.getChangedEventType(ol.MapProperty.CENTER),
this.handleCenterChanged, false, this);
goog.events.listen(
this, ol.Object.getChangedEventType(ol.MapProperty.LAYERS),
this.handleLayersChanged, false, this);
goog.events.listen(
this, ol.Object.getChangedEventType(ol.MapProperty.RESOLUTION),
this.handleResolutionChanged, false, this);
if (goog.isDef(opt_values)) {
this.setValues(opt_values);
}
};
goog.inherits(ol.Map, ol.Object);
/**
* @param {ol.Layer} layer Layer.
* @protected
* @return {ol.LayerRenderer} layerRenderer Layer renderer.
*/
ol.Map.prototype.createLayerRenderer = goog.abstractMethod;
/**
* @protected
* @param {function(this: T, ol.LayerRenderer)} f Function.
* @param {T=} opt_obj The object to be used for the value of 'this' within f.
* @template T
*/
ol.Map.prototype.forEachLayerRenderer = function(f, opt_obj) {
var layers = this.getLayers();
if (goog.isDefAndNotNull(layers)) {
layers.forEach(function(layer) {
var key = goog.getUid(layer);
var layerRenderer = this.layerRenderers_[key];
f.call(opt_obj, layerRenderer);
}, this);
}
};
/**
* @return {goog.math.Coordinate|undefined} Center.
*/
ol.Map.prototype.getCenter = function() {
var center = /** @type {goog.math.Coordinate} */ (
this.get(ol.MapProperty.CENTER));
return goog.isDef(center) ? center.clone() : undefined;
};
/**
* @return {ol.Extent|undefined} Extent.
*/
ol.Map.prototype.getExtent = function() {
var extent = /** @type {ol.Extent} */ (this.get(ol.MapProperty.EXTENT));
return goog.isDef(extent) ? extent.clone() : undefined;
};
/**
* @return {ol.Array} Layers.
*/
ol.Map.prototype.getLayers = function() {
return /** @type {ol.Array} */ (this.get(ol.MapProperty.LAYERS));
};
/**
* @return {ol.Projection} Projection.
*/
ol.Map.prototype.getProjection = function() {
return /** @type {ol.Projection} */ (this.get(ol.MapProperty.PROJECTION));
};
/**
* @return {number|undefined} Resolution.
*/
ol.Map.prototype.getResolution = function() {
return /** @type {number} */ (this.get(ol.MapProperty.RESOLUTION));
};
/**
* @param {ol.Extent} extent Extent.
* @return {number} Resolution.
*/
ol.Map.prototype.getResolutionForExtent = function(extent) {
var size = this.size_;
var xResolution = (extent.right - extent.left) / size.width;
var yResolution = (extent.top - extent.bottom) / size.height;
return Math.max(xResolution, yResolution);
};
/**
* @protected
* @return {goog.math.Size} Size.
*/
ol.Map.prototype.getSize = function() {
return this.size_;
};
/**
* @return {HTMLDivElement} Target.
*/
ol.Map.prototype.getTarget = function() {
return this.target_;
};
/**
* @protected
*/
ol.Map.prototype.handleCenterChanged = function() {
this.recalculateExtent_();
};
/**
* @param {ol.Layer} layer Layer.
* @protected
*/
ol.Map.prototype.handleLayerAdd = function(layer) {
var projection = this.getProjection();
var storeProjection = layer.getStore().getProjection();
goog.asserts.assert(ol.Projection.equivalent(projection, storeProjection));
var key = goog.getUid(layer);
var layerRenderer = this.createLayerRenderer(layer);
this.layerRenderers_[key] = layerRenderer;
};
/**
* @param {ol.Layer} layer Layer.
* @protected
*/
ol.Map.prototype.handleLayerRemove = function(layer) {
var key = goog.getUid(layer);
goog.asserts.assert(key in this.layerRenderers_);
var layerRenderer = this.layerRenderers_[key];
delete this.layerRenderers_[key];
goog.dispose(layerRenderer);
};
/**
* @param {ol.ArrayEvent} event Event.
* @protected
*/
ol.Map.prototype.handleLayersInsertAt = function(event) {
var layers = /** @type {ol.Array} */ (event.target);
var layer = /** @type {ol.Layer} */ layers.getAt(event.index);
this.handleLayerAdd(layer);
this.setDefaultCenterAndResolution_();
};
/**
* @param {ol.ArrayEvent} event Event.
* @protected
*/
ol.Map.prototype.handleLayersRemoveAt = function(event) {
var layer = /** @type {ol.Layer} */ (event.prev);
this.handleLayerRemove(layer);
};
/**
* @param {ol.ArrayEvent} event Event.
* @protected
*/
ol.Map.prototype.handleLayersSetAt = function(event) {
var prevLayer = /** @type {ol.Layer} */ (event.prev);
this.handleLayerRemove(prevLayer);
var layers = /** @type {ol.Array} */ (event.target);
var layer = /** @type {ol.Layer} */ layers.getAt(event.index);
this.handleLayerAdd(layer);
};
/**
*/
ol.Map.prototype.handleLayersChanged = function() {
if (!goog.isNull(this.layersListenerKeys_)) {
goog.array.forEach(this.layersListenerKeys_, goog.events.unlistenByKey);
this.layersListenerKeys_ = null;
}
var layers = this.getLayers();
if (goog.isDefAndNotNull(layers)) {
this.layersListenerKeys_ = [
goog.events.listen(layers, ol.ArrayEventType.INSERT_AT,
this.handleLayersInsertAt, false, this),
goog.events.listen(layers, ol.ArrayEventType.REMOVE_AT,
this.handleLayersRemoveAt, false, this),
goog.events.listen(layers, ol.ArrayEventType.SET_AT,
this.handleLayersSetAt, false, this)
];
this.setDefaultCenterAndResolution_();
}
};
/**
* @protected
*/
ol.Map.prototype.handleResolutionChanged = function() {
this.recalculateExtent_();
};
/**
* @param {goog.events.Event} event Event.
* @protected
*/
ol.Map.prototype.handleTargetResize = function(event) {
goog.asserts.assert(event.target == this.target_);
this.size_.width = this.target_.clientWidth;
this.size_.height = this.target_.clientHeight;
this.recalculateExtent_();
};
/**
* @private
*/
ol.Map.prototype.recalculateExtent_ = function() {
var center = this.getCenter();
var resolution = this.getResolution();
if (!goog.isDef(center) || !goog.isDef(resolution)) {
return;
}
var size = this.size_;
var left = center.x - resolution * size.width / 2;
var right = center.x + resolution * size.width / 2;
var bottom = center.y - resolution * size.height / 2;
var top = center.y + resolution * size.height / 2;
var extent = new ol.Extent(top, right, bottom, left);
this.set(ol.MapProperty.EXTENT, extent);
};
/**
* @param {goog.math.Coordinate} center Center.
*/
ol.Map.prototype.setCenter = function(center) {
this.set(ol.MapProperty.CENTER, center);
};
/**
* @private
*/
ol.Map.prototype.setDefaultCenterAndResolution_ = function() {
if (goog.isDef(this.getCenter()) && goog.isDef(this.getResolution())) {
return;
}
var layers = this.getLayers();
if (layers.getLength() < 1) {
return;
}
var layer = /** @type {ol.Layer} */ (layers.getAt(0));
var storeExtent = layer.getStore().getExtent();
this.setExtent(storeExtent);
};
/**
* @param {ol.Extent} extent Extent.
*/
ol.Map.prototype.setExtent = function(extent) {
this.setCenter(extent.getCenter());
this.setResolution(this.getResolutionForExtent(extent));
};
/**
* @param {ol.Array} layers Layers.
*/
ol.Map.prototype.setLayers = function(layers) {
this.set(ol.MapProperty.LAYERS, layers);
};
/**
* @param {number} resolution Resolution.
*/
ol.Map.prototype.setResolution = function(resolution) {
// FIXME support discrete resolutions
this.set(ol.MapProperty.RESOLUTION, resolution);
};
/**
* @param {ol.Projection} projection Projection.
*/
ol.Map.prototype.setProjection = function(projection) {
this.set(ol.MapProperty.PROJECTION, projection);
};