c17ac0cae3
This commit simplifies the exports.js plugin so it only relies on the stability notes to generate the documentation, which completely decouples it from the exportable API. As a rule of thumb, whenever something has an 'api' annotation, it should also have a 'stability' annotation. A more verbose documentation of ol3 specific annotation usage is available in the new 'apidoc/readme.md' file. This commit also modifies all source files to implement these usage suggestions.
122 lines
3.0 KiB
JavaScript
122 lines
3.0 KiB
JavaScript
goog.provide('ol.interaction.DragRotate');
|
|
|
|
goog.require('goog.asserts');
|
|
goog.require('ol.ViewHint');
|
|
goog.require('ol.events.ConditionType');
|
|
goog.require('ol.events.condition');
|
|
goog.require('ol.interaction.Interaction');
|
|
goog.require('ol.interaction.Pointer');
|
|
|
|
|
|
/**
|
|
* @define {number} Animation duration.
|
|
*/
|
|
ol.interaction.DRAGROTATE_ANIMATION_DURATION = 250;
|
|
|
|
|
|
|
|
/**
|
|
* Allows the user to rotate the map by clicking and dragging on the map,
|
|
* normally combined with an {@link ol.events.condition} that limits
|
|
* it to when the alt and shift keys are held down.
|
|
*
|
|
* This interaction is only supported for mouse devices.
|
|
*
|
|
* @constructor
|
|
* @extends {ol.interaction.Pointer}
|
|
* @param {olx.interaction.DragRotateOptions=} opt_options Options.
|
|
* @todo stability experimental
|
|
* @todo api
|
|
*/
|
|
ol.interaction.DragRotate = function(opt_options) {
|
|
|
|
var options = goog.isDef(opt_options) ? opt_options : {};
|
|
|
|
goog.base(this);
|
|
|
|
/**
|
|
* @private
|
|
* @type {ol.events.ConditionType}
|
|
*/
|
|
this.condition_ = goog.isDef(options.condition) ?
|
|
options.condition : ol.events.condition.altShiftKeysOnly;
|
|
|
|
/**
|
|
* @private
|
|
* @type {number|undefined}
|
|
*/
|
|
this.lastAngle_ = undefined;
|
|
|
|
};
|
|
goog.inherits(ol.interaction.DragRotate, ol.interaction.Pointer);
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.interaction.DragRotate.prototype.handlePointerDrag =
|
|
function(mapBrowserEvent) {
|
|
if (!ol.events.condition.mouseOnly(mapBrowserEvent)) {
|
|
return;
|
|
}
|
|
|
|
var map = mapBrowserEvent.map;
|
|
var size = map.getSize();
|
|
var offset = mapBrowserEvent.pixel;
|
|
var theta =
|
|
Math.atan2(size[1] / 2 - offset[1], offset[0] - size[0] / 2);
|
|
if (goog.isDef(this.lastAngle_)) {
|
|
var delta = theta - this.lastAngle_;
|
|
// FIXME works for View2D only
|
|
var view = map.getView().getView2D();
|
|
var view2DState = view.getView2DState();
|
|
map.render();
|
|
ol.interaction.Interaction.rotateWithoutConstraints(
|
|
map, view, view2DState.rotation - delta);
|
|
}
|
|
this.lastAngle_ = theta;
|
|
};
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.interaction.DragRotate.prototype.handlePointerUp =
|
|
function(mapBrowserEvent) {
|
|
if (!ol.events.condition.mouseOnly(mapBrowserEvent)) {
|
|
return true;
|
|
}
|
|
|
|
var map = mapBrowserEvent.map;
|
|
// FIXME works for View2D only
|
|
var view = map.getView();
|
|
view.setHint(ol.ViewHint.INTERACTING, -1);
|
|
var view2D = view.getView2D();
|
|
var view2DState = view2D.getView2DState();
|
|
ol.interaction.Interaction.rotate(map, view2D, view2DState.rotation,
|
|
undefined, ol.interaction.DRAGROTATE_ANIMATION_DURATION);
|
|
return false;
|
|
};
|
|
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
ol.interaction.DragRotate.prototype.handlePointerDown =
|
|
function(mapBrowserEvent) {
|
|
if (!ol.events.condition.mouseOnly(mapBrowserEvent)) {
|
|
return false;
|
|
}
|
|
|
|
var browserEvent = mapBrowserEvent.browserEvent;
|
|
if (browserEvent.isMouseActionButton() && this.condition_(mapBrowserEvent)) {
|
|
var map = mapBrowserEvent.map;
|
|
map.getView().setHint(ol.ViewHint.INTERACTING, 1);
|
|
map.render();
|
|
this.lastAngle_ = undefined;
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
};
|