253 lines
7.3 KiB
JavaScript
253 lines
7.3 KiB
JavaScript
// FIXME factor out key precondition (shift et. al)
|
|
|
|
goog.provide('ol.interaction.Interaction');
|
|
goog.provide('ol.interaction.InteractionProperty');
|
|
|
|
goog.require('goog.asserts');
|
|
goog.require('ol.MapBrowserEvent');
|
|
goog.require('ol.Object');
|
|
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
|
|
* instantiated in apps.
|
|
* User actions that change the state of the map. Some are similar to controls,
|
|
* but are not associated with a DOM element.
|
|
* For example, {@link ol.interaction.KeyboardZoom} is functionally the same as
|
|
* {@link ol.control.Zoom}, but triggered by a keyboard event not a button
|
|
* element event.
|
|
* Although interactions do not have a DOM element, some of them do render
|
|
* vectors and so are visible on the screen.
|
|
*
|
|
* @constructor
|
|
* @param {olx.interaction.InteractionOptions} options Options.
|
|
* @extends {ol.Object}
|
|
* @api
|
|
*/
|
|
ol.interaction.Interaction = function(options) {
|
|
|
|
goog.base(this);
|
|
|
|
/**
|
|
* @private
|
|
* @type {ol.Map}
|
|
*/
|
|
this.map_ = null;
|
|
|
|
this.setActive(true);
|
|
|
|
/**
|
|
* @type {function(ol.MapBrowserEvent):boolean}
|
|
*/
|
|
this.handleEvent = options.handleEvent;
|
|
|
|
};
|
|
goog.inherits(ol.interaction.Interaction, ol.Object);
|
|
|
|
|
|
/**
|
|
* @return {boolean} `true` if the interaction is active, `false` otherwise.
|
|
* @observable
|
|
* @api
|
|
*/
|
|
ol.interaction.Interaction.prototype.getActive = function() {
|
|
return /** @type {boolean} */ (
|
|
this.get(ol.interaction.InteractionProperty.ACTIVE));
|
|
};
|
|
goog.exportProperty(
|
|
ol.interaction.Interaction.prototype,
|
|
'getActive',
|
|
ol.interaction.Interaction.prototype.getActive);
|
|
|
|
|
|
/**
|
|
* Get the map associated with this interaction.
|
|
* @return {ol.Map} Map.
|
|
*/
|
|
ol.interaction.Interaction.prototype.getMap = function() {
|
|
return this.map_;
|
|
};
|
|
|
|
|
|
/**
|
|
* Activate or deactivate the interaction.
|
|
* @param {boolean} active Active.
|
|
* @observable
|
|
* @api
|
|
*/
|
|
ol.interaction.Interaction.prototype.setActive = function(active) {
|
|
this.set(ol.interaction.InteractionProperty.ACTIVE, active);
|
|
};
|
|
goog.exportProperty(
|
|
ol.interaction.Interaction.prototype,
|
|
'setActive',
|
|
ol.interaction.Interaction.prototype.setActive);
|
|
|
|
|
|
/**
|
|
* Remove the interaction from its current map and attach it to the new map.
|
|
* Subclasses may set up event handlers to get notified about changes to
|
|
* the map here.
|
|
* @param {ol.Map} map Map.
|
|
*/
|
|
ol.interaction.Interaction.prototype.setMap = function(map) {
|
|
this.map_ = map;
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.Map} map Map.
|
|
* @param {ol.View} view View.
|
|
* @param {ol.Coordinate} delta Delta.
|
|
* @param {number=} opt_duration Duration.
|
|
*/
|
|
ol.interaction.Interaction.pan = function(map, view, delta, opt_duration) {
|
|
var currentCenter = view.getCenter();
|
|
if (goog.isDef(currentCenter)) {
|
|
if (goog.isDef(opt_duration) && opt_duration > 0) {
|
|
map.beforeRender(ol.animation.pan({
|
|
source: currentCenter,
|
|
duration: opt_duration,
|
|
easing: ol.easing.linear
|
|
}));
|
|
}
|
|
var center = view.constrainCenter(
|
|
[currentCenter[0] + delta[0], currentCenter[1] + delta[1]]);
|
|
view.setCenter(center);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.Map} map Map.
|
|
* @param {ol.View} view View.
|
|
* @param {number|undefined} rotation Rotation.
|
|
* @param {ol.Coordinate=} opt_anchor Anchor coordinate.
|
|
* @param {number=} opt_duration Duration.
|
|
*/
|
|
ol.interaction.Interaction.rotate =
|
|
function(map, view, rotation, opt_anchor, opt_duration) {
|
|
rotation = view.constrainRotation(rotation, 0);
|
|
ol.interaction.Interaction.rotateWithoutConstraints(
|
|
map, view, rotation, opt_anchor, opt_duration);
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.Map} map Map.
|
|
* @param {ol.View} view View.
|
|
* @param {number|undefined} rotation Rotation.
|
|
* @param {ol.Coordinate=} opt_anchor Anchor coordinate.
|
|
* @param {number=} opt_duration Duration.
|
|
*/
|
|
ol.interaction.Interaction.rotateWithoutConstraints =
|
|
function(map, view, rotation, opt_anchor, opt_duration) {
|
|
if (goog.isDefAndNotNull(rotation)) {
|
|
var currentRotation = view.getRotation();
|
|
var currentCenter = view.getCenter();
|
|
if (goog.isDef(currentRotation) && goog.isDef(currentCenter) &&
|
|
goog.isDef(opt_duration) && opt_duration > 0) {
|
|
map.beforeRender(ol.animation.rotate({
|
|
rotation: currentRotation,
|
|
duration: opt_duration,
|
|
easing: ol.easing.easeOut
|
|
}));
|
|
if (goog.isDef(opt_anchor)) {
|
|
map.beforeRender(ol.animation.pan({
|
|
source: currentCenter,
|
|
duration: opt_duration,
|
|
easing: ol.easing.easeOut
|
|
}));
|
|
}
|
|
}
|
|
view.rotate(rotation, opt_anchor);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.Map} map Map.
|
|
* @param {ol.View} view View.
|
|
* @param {number|undefined} resolution Resolution to go to.
|
|
* @param {ol.Coordinate=} opt_anchor Anchor coordinate.
|
|
* @param {number=} opt_duration Duration.
|
|
* @param {number=} opt_direction Zooming direction; > 0 indicates
|
|
* zooming out, in which case the constraints system will select
|
|
* the largest nearest resolution; < 0 indicates zooming in, in
|
|
* which case the constraints system will select the smallest
|
|
* nearest resolution; == 0 indicates that the zooming direction
|
|
* is unknown/not relevant, in which case the constraints system
|
|
* will select the nearest resolution. If not defined 0 is
|
|
* assumed.
|
|
*/
|
|
ol.interaction.Interaction.zoom =
|
|
function(map, view, resolution, opt_anchor, opt_duration, opt_direction) {
|
|
resolution = view.constrainResolution(resolution, 0, opt_direction);
|
|
ol.interaction.Interaction.zoomWithoutConstraints(
|
|
map, view, resolution, opt_anchor, opt_duration);
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.Map} map Map.
|
|
* @param {ol.View} view View.
|
|
* @param {number} delta Delta from previous zoom level.
|
|
* @param {ol.Coordinate=} opt_anchor Anchor coordinate.
|
|
* @param {number=} opt_duration Duration.
|
|
*/
|
|
ol.interaction.Interaction.zoomByDelta =
|
|
function(map, view, delta, opt_anchor, opt_duration) {
|
|
var currentResolution = view.getResolution();
|
|
var resolution = view.constrainResolution(currentResolution, delta, 0);
|
|
ol.interaction.Interaction.zoomWithoutConstraints(
|
|
map, view, resolution, opt_anchor, opt_duration);
|
|
};
|
|
|
|
|
|
/**
|
|
* @param {ol.Map} map Map.
|
|
* @param {ol.View} view View.
|
|
* @param {number|undefined} resolution Resolution to go to.
|
|
* @param {ol.Coordinate=} opt_anchor Anchor coordinate.
|
|
* @param {number=} opt_duration Duration.
|
|
*/
|
|
ol.interaction.Interaction.zoomWithoutConstraints =
|
|
function(map, view, resolution, opt_anchor, opt_duration) {
|
|
if (goog.isDefAndNotNull(resolution)) {
|
|
var currentResolution = view.getResolution();
|
|
var currentCenter = view.getCenter();
|
|
if (goog.isDef(currentResolution) && goog.isDef(currentCenter) &&
|
|
goog.isDef(opt_duration) && opt_duration > 0) {
|
|
map.beforeRender(ol.animation.zoom({
|
|
resolution: currentResolution,
|
|
duration: opt_duration,
|
|
easing: ol.easing.easeOut
|
|
}));
|
|
if (goog.isDef(opt_anchor)) {
|
|
map.beforeRender(ol.animation.pan({
|
|
source: currentCenter,
|
|
duration: opt_duration,
|
|
easing: ol.easing.easeOut
|
|
}));
|
|
}
|
|
}
|
|
if (goog.isDefAndNotNull(opt_anchor)) {
|
|
var center = view.calculateCenterZoom(resolution, opt_anchor);
|
|
view.setCenter(center);
|
|
}
|
|
view.setResolution(resolution);
|
|
}
|
|
};
|