import Collection from '../../../../../src/ol/Collection.js'; import Feature from '../../../../../src/ol/Feature.js'; import Interaction from '../../../../../src/ol/interaction/Interaction.js'; import Map from '../../../../../src/ol/Map.js'; import MapBrowserEvent from '../../../../../src/ol/MapBrowserEvent.js'; import Point from '../../../../../src/ol/geom/Point.js'; import Translate, { TranslateEvent, } from '../../../../../src/ol/interaction/Translate.js'; import VectorLayer from '../../../../../src/ol/layer/Vector.js'; import VectorSource from '../../../../../src/ol/source/Vector.js'; import View from '../../../../../src/ol/View.js'; import {shiftKeyOnly} from '../../../../../src/ol/events/condition.js'; describe('ol.interaction.Translate', function () { let target, map, source, features; const width = 360; const height = 180; beforeEach(function (done) { target = document.createElement('div'); const style = target.style; style.position = 'absolute'; style.left = '-1000px'; style.top = '-1000px'; style.width = width + 'px'; style.height = height + 'px'; document.body.appendChild(target); source = new VectorSource(); features = [ new Feature({ geometry: new Point([10, -20]), }), new Feature({ geometry: new Point([20, -30]), }), ]; source.addFeatures(features); const layer = new VectorLayer({source: source}); map = new Map({ target: target, layers: [layer], view: new View({ projection: 'EPSG:4326', center: [0, 0], resolution: 1, }), }); map.once('postrender', function () { done(); }); }); afterEach(function () { map.dispose(); document.body.removeChild(target); }); /** * Simulates a browser event on the map viewport. The client x/y location * will be adjusted as if the map were centered at 0,0. * @param {string} type Event type. * @param {number} x Horizontal offset from map center. * @param {number} y Vertical offset from map center. * @param {boolean} [opt_shiftKey] Shift key is pressed. */ function simulateEvent(type, x, y, opt_shiftKey) { const viewport = map.getViewport(); // calculated in case body has top < 0 (test runner with small window) const position = viewport.getBoundingClientRect(); const shiftKey = opt_shiftKey !== undefined ? opt_shiftKey : false; const event = new MapBrowserEvent(type, map, { type: type, target: viewport.firstChild, pointerId: 0, clientX: position.left + x + width / 2, clientY: position.top + y + height / 2, shiftKey: shiftKey, preventDefault: function () {}, }); map.handleMapBrowserEvent(event); } /** * Tracks events triggered by the interaction as well as feature * modifications. Helper function to * @param {ol.Feature} feature Translated feature. * @param {ol.interaction.Translate} interaction The interaction. * @return {Array} events */ function trackEvents(feature, interaction) { const events = []; feature.on('change', function (event) { events.push('change'); }); interaction.on('translatestart', function (event) { events.push(event); }); interaction.on('translateend', function (event) { events.push(event); }); return events; } /** * Validates the event array to verify proper event sequence. Checks * that first and last event are correct TranslateEvents and that feature * modifications event are in between. * @param {Array} events The events. * @param {Array} features The features. */ function validateEvents(events, features) { const startevent = events[0]; const endevent = events[events.length - 1]; // first event should be translatestart expect(startevent).to.be.an(TranslateEvent); expect(startevent.type).to.eql('translatestart'); // last event should be translateend expect(endevent).to.be.an(TranslateEvent); expect(endevent.type).to.eql('translateend'); // make sure we get change events to events array expect(events.length > 2).to.be(true); // middle events should be feature modification events for (let i = 1; i < events.length - 1; i++) { expect(events[i]).to.equal('change'); } // TranslateEvents should include the expected features expect(startevent.features.getArray()).to.eql(features); expect(endevent.features.getArray()).to.eql(features); } describe('constructor', function () { it('creates a new interaction', function () { const translate = new Translate({ features: features, }); expect(translate).to.be.a(Translate); expect(translate).to.be.a(Interaction); }); }); describe('setActive', function () { it('works when the map is not set', function () { const translate = new Translate({ features: features, }); expect(translate.getActive()).to.be(true); translate.setActive(false); expect(translate.getActive()).to.be(false); }); }); describe('moving features, with features option', function () { let translate; beforeEach(function () { translate = new Translate({ features: new Collection([features[0]]), }); map.addInteraction(translate); }); it('moves a selected feature', function () { const events = trackEvents(features[0], translate); simulateEvent('pointermove', 10, 20); simulateEvent('pointerdown', 10, 20); simulateEvent('pointerdrag', 50, -40); simulateEvent('pointerup', 50, -40); const geometry = features[0].getGeometry(); expect(geometry).to.be.a(Point); expect(geometry.getCoordinates()).to.eql([50, 40]); validateEvents(events, [features[0]]); }); it('does not move an unselected feature', function () { const events = trackEvents(features[0], translate); simulateEvent('pointermove', 20, 30); simulateEvent('pointerdown', 20, 30); simulateEvent('pointerdrag', 50, -40); simulateEvent('pointerup', 50, -40); const geometry = features[1].getGeometry(); expect(geometry).to.be.a(Point); expect(geometry.getCoordinates()).to.eql([20, -30]); expect(events).to.be.empty(); }); }); describe('moving features, without features option', function () { let translate; beforeEach(function () { translate = new Translate(); map.addInteraction(translate); }); it('moves only targeted feature', function () { const events = trackEvents(features[0], translate); simulateEvent('pointermove', 10, 20); simulateEvent('pointerdown', 10, 20); simulateEvent('pointerdrag', 50, -40); simulateEvent('pointerup', 50, -40); expect(features[0].getGeometry().getCoordinates()).to.eql([50, 40]); expect(features[1].getGeometry().getCoordinates()).to.eql([20, -30]); validateEvents(events, [features[0]]); }); }); describe('moving features, with filter option', function () { let translate; beforeEach(function () { translate = new Translate({ filter: function (feature, layer) { return feature == features[0]; }, }); map.addInteraction(translate); }); it('moves a filter-passing feature', function () { const events = trackEvents(features[0], translate); simulateEvent('pointermove', 10, 20); simulateEvent('pointerdown', 10, 20); simulateEvent('pointerdrag', 50, -40); simulateEvent('pointerup', 50, -40); const geometry = features[0].getGeometry(); expect(geometry).to.be.a(Point); expect(geometry.getCoordinates()).to.eql([50, 40]); validateEvents(events, [features[0]]); }); it('does not move a filter-discarded feature', function () { const events = trackEvents(features[0], translate); simulateEvent('pointermove', 20, 30); simulateEvent('pointerdown', 20, 30); simulateEvent('pointerdrag', 50, -40); simulateEvent('pointerup', 50, -40); const geometry = features[1].getGeometry(); expect(geometry).to.be.a(Point); expect(geometry.getCoordinates()).to.eql([20, -30]); expect(events).to.be.empty(); }); }); describe('moving features, with condition option', function () { let translate; beforeEach(function () { translate = new Translate({condition: shiftKeyOnly}); map.addInteraction(translate); }); it('moves targeted feature when condition is met', function () { const events = trackEvents(features[0], translate); simulateEvent('pointermove', 10, 20); simulateEvent('pointerdown', 10, 20, true); simulateEvent('pointerdrag', 50, -40); simulateEvent('pointerup', 50, -40); expect(features[0].getGeometry().getCoordinates()).to.eql([50, 40]); validateEvents(events, [features[0]]); }); it('does not move feature when condition is not met', function () { const events = trackEvents(features[0], translate); simulateEvent('pointermove', 20, 30); simulateEvent('pointerdown', 20, 30); simulateEvent('pointerdrag', 50, -40); simulateEvent('pointerup', 50, -40); expect(features[1].getGeometry().getCoordinates()).to.eql([20, -30]); expect(events).to.be.empty(); }); }); describe('changes css cursor', function () { let element, translate; beforeEach(function () { translate = new Translate(); map.addInteraction(translate); element = map.getViewport(); }); it('changes css cursor', function () { expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(false); simulateEvent('pointermove', 10, 20); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(true); simulateEvent('pointerdown', 10, 20); expect(element.classList.contains('ol-grabbing')).to.be(true); expect(element.classList.contains('ol-grab')).to.be(false); simulateEvent('pointerup', 10, 20); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(true); simulateEvent('pointermove', 0, 0); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(false); }); it('resets css cursor when interaction is deactivated while pointer is on feature', function () { simulateEvent('pointermove', 10, 20); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(true); translate.setActive(false); simulateEvent('pointermove', 0, 0); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(false); }); it('resets css cursor interaction is removed while pointer is on feature', function () { simulateEvent('pointermove', 10, 20); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(true); map.removeInteraction(translate); simulateEvent('pointermove', 0, 0); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(false); }); it('resets css cursor to existing cursor interaction is removed while pointer is on feature', function () { element.style.cursor = 'pointer'; simulateEvent('pointermove', 10, 20); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(true); map.removeInteraction(translate); simulateEvent('pointermove', 0, 0); expect(element.classList.contains('ol-grabbing')).to.be(false); expect(element.classList.contains('ol-grab')).to.be(false); }); }); });