ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Automated class transform

Browse Source 
npx lebab --replace src --transform class
This commit is contained in:
Tim Schaub
2018-07-16 16:18:16 -06:00
parent 60e85e7d89
commit 7b4a73f3b9
145 changed files with 32887 additions and 33714 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/Collection.js
+35 -46
View File
@@ -65,7 +65,8 @@ inherits(CollectionEvent, Event);
* @template T
* @api
*/
const Collection = function(opt_array, opt_options) {
class Collection {
constructor(opt_array, opt_options) {
BaseObject.call(this);
@@ -91,21 +92,17 @@ const Collection = function(opt_array, opt_options) {
this.updateLength_();
};
inherits(Collection, BaseObject);
}
/**
* Remove all elements from the collection.
* @api
*/
Collection.prototype.clear = function() {
clear() {
while (this.getLength() > 0) {
this.pop();
}
};
}
/**
* Add elements to the collection. This pushes each item in the provided array
@@ -114,13 +111,12 @@ Collection.prototype.clear = function() {
* @return {module:ol/Collection.<T>} This collection.
* @api
*/
Collection.prototype.extend = function(arr) {
extend(arr) {
for (let i = 0, ii = arr.length; i < ii; ++i) {
this.push(arr[i]);
}
return this;
};
}
/**
* Iterate over each element, calling the provided callback.
@@ -129,13 +125,12 @@ Collection.prototype.extend = function(arr) {
* index and the array). The return value is ignored.
* @api
*/
Collection.prototype.forEach = function(f) {
forEach(f) {
const array = this.array_;
for (let i = 0, ii = array.length; i < ii; ++i) {
f(array[i], i, array);
}
};
}
/**
* Get a reference to the underlying Array object. Warning: if the array
@@ -145,10 +140,9 @@ Collection.prototype.forEach = function(f) {
* @return {!Array.<T>} Array.
* @api
*/
Collection.prototype.getArray = function() {
getArray() {
return this.array_;
};
}
/**
* Get the element at the provided index.
@@ -156,10 +150,9 @@ Collection.prototype.getArray = function() {
* @return {T} Element.
* @api
*/
Collection.prototype.item = function(index) {
item(index) {
return this.array_[index];
};
}
/**
* Get the length of this collection.
@@ -167,10 +160,9 @@ Collection.prototype.item = function(index) {
* @observable
* @api
*/
Collection.prototype.getLength = function() {
getLength() {
return /** @type {number} */ (this.get(Property.LENGTH));
};
}
/**
* Insert an element at the provided index.
@@ -178,7 +170,7 @@ Collection.prototype.getLength = function() {
* @param {T} elem Element.
* @api
*/
Collection.prototype.insertAt = function(index, elem) {
insertAt(index, elem) {
if (this.unique_) {
this.assertUnique_(elem);
}
@@ -186,8 +178,7 @@ Collection.prototype.insertAt = function(index, elem) {
this.updateLength_();
this.dispatchEvent(
new CollectionEvent(CollectionEventType.ADD, elem));
};
}
/**
* Remove the last element of the collection and return it.
@@ -195,10 +186,9 @@ Collection.prototype.insertAt = function(index, elem) {
* @return {T|undefined} Element.
* @api
*/
Collection.prototype.pop = function() {
pop() {
return this.removeAt(this.getLength() - 1);
};
}
/**
* Insert the provided element at the end of the collection.
@@ -206,15 +196,14 @@ Collection.prototype.pop = function() {
* @return {number} New length of the collection.
* @api
*/
Collection.prototype.push = function(elem) {
push(elem) {
if (this.unique_) {
this.assertUnique_(elem);
}
const n = this.getLength();
this.insertAt(n, elem);
return this.getLength();
};
}
/**
* Remove the first occurrence of an element from the collection.
@@ -222,7 +211,7 @@ Collection.prototype.push = function(elem) {
* @return {T|undefined} The removed element or undefined if none found.
* @api
*/
Collection.prototype.remove = function(elem) {
remove(elem) {
const arr = this.array_;
for (let i = 0, ii = arr.length; i < ii; ++i) {
if (arr[i] === elem) {
@@ -230,8 +219,7 @@ Collection.prototype.remove = function(elem) {
}
}
return undefined;
};
}
/**
* Remove the element at the provided index and return it.
@@ -240,14 +228,13 @@ Collection.prototype.remove = function(elem) {
* @return {T|undefined} Value.
* @api
*/
Collection.prototype.removeAt = function(index) {
removeAt(index) {
const prev = this.array_[index];
this.array_.splice(index, 1);
this.updateLength_();
this.dispatchEvent(new CollectionEvent(CollectionEventType.REMOVE, prev));
return prev;
};
}
/**
* Set the element at the provided index.
@@ -255,7 +242,7 @@ Collection.prototype.removeAt = function(index) {
* @param {T} elem Element.
* @api
*/
Collection.prototype.setAt = function(index, elem) {
setAt(index, elem) {
const n = this.getLength();
if (index < n) {
if (this.unique_) {
@@ -273,28 +260,30 @@ Collection.prototype.setAt = function(index, elem) {
}
this.insertAt(index, elem);
}
};
}
/**
* @private
*/
Collection.prototype.updateLength_ = function() {
updateLength_() {
this.set(Property.LENGTH, this.array_.length);
};
}
/**
* @private
* @param {T} elem Element.
* @param {number=} opt_except Optional index to ignore.
*/
Collection.prototype.assertUnique_ = function(elem, opt_except) {
assertUnique_(elem, opt_except) {
for (let i = 0, ii = this.array_.length; i < ii; ++i) {
if (this.array_[i] === elem && i !== opt_except) {
throw new AssertionError(58);
}
}
};
}
}
inherits(Collection, BaseObject);
export default Collection;
src/ol/Disposable.js
+11 -11
View File
@@ -7,7 +7,17 @@ import {UNDEFINED} from './functions.js';
* Objects that need to clean up after themselves.
* @constructor
*/
const Disposable = function() {};
class Disposable {
/**
* Clean up.
*/
dispose() {
if (!this.disposed_) {
this.disposed_ = true;
this.disposeInternal();
}
}
}
/**
* The object has already been disposed.
@@ -16,16 +26,6 @@ const Disposable = function() {};
*/
Disposable.prototype.disposed_ = false;
/**
* Clean up.
*/
Disposable.prototype.dispose = function() {
if (!this.disposed_) {
this.disposed_ = true;
this.disposeInternal();
}
};
/**
* Extension point for disposable objects.
* @protected
src/ol/Feature.js
+30 -40
View File
@@ -59,7 +59,8 @@ import Style from './style/Style.js';
* associated with a `geometry` key.
* @api
*/
const Feature = function(opt_geometryOrProperties) {
class Feature {
constructor(opt_geometryOrProperties) {
BaseObject.call(this);
@@ -109,10 +110,7 @@ const Feature = function(opt_geometryOrProperties) {
this.setProperties(properties);
}
}
};
inherits(Feature, BaseObject);
}
/**
* Clone this feature. If the original feature has a geometry it
@@ -120,7 +118,7 @@ inherits(Feature, BaseObject);
* @return {module:ol/Feature} The clone.
* @api
*/
Feature.prototype.clone = function() {
clone() {
const clone = new Feature(this.getProperties());
clone.setGeometryName(this.getGeometryName());
const geometry = this.getGeometry();
@@ -132,8 +130,7 @@ Feature.prototype.clone = function() {
clone.setStyle(style);
}
return clone;
};
}
/**
* Get the feature's default geometry. A feature may have any number of named
@@ -143,12 +140,11 @@ Feature.prototype.clone = function() {
* @api
* @observable
*/
Feature.prototype.getGeometry = function() {
getGeometry() {
return (
/** @type {module:ol/geom/Geometry|undefined} */ (this.get(this.geometryName_))
);
};
}
/**
* Get the feature identifier. This is a stable identifier for the feature and
@@ -157,10 +153,9 @@ Feature.prototype.getGeometry = function() {
* @return {number|string|undefined} Id.
* @api
*/
Feature.prototype.getId = function() {
getId() {
return this.id_;
};
}
/**
* Get the name of the feature's default geometry. By default, the default
@@ -169,10 +164,9 @@ Feature.prototype.getId = function() {
* for this feature.
* @api
*/
Feature.prototype.getGeometryName = function() {
getGeometryName() {
return this.geometryName_;
};
}
/**
* Get the feature's style. Will return what was provided to the
@@ -180,10 +174,9 @@ Feature.prototype.getGeometryName = function() {
* @return {module:ol/style/Style|Array.<module:ol/style/Style>|module:ol/style/Style~StyleFunction} The feature style.
* @api
*/
Feature.prototype.getStyle = function() {
getStyle() {
return this.style_;
};
}
/**
* Get the feature's style function.
@@ -191,23 +184,21 @@ Feature.prototype.getStyle = function() {
* representing the current style of this feature.
* @api
*/
Feature.prototype.getStyleFunction = function() {
getStyleFunction() {
return this.styleFunction_;
};
}
/**
* @private
*/
Feature.prototype.handleGeometryChange_ = function() {
handleGeometryChange_() {
this.changed();
};
}
/**
* @private
*/
Feature.prototype.handleGeometryChanged_ = function() {
handleGeometryChanged_() {
if (this.geometryChangeKey_) {
unlistenByKey(this.geometryChangeKey_);
this.geometryChangeKey_ = null;
@@ -218,8 +209,7 @@ Feature.prototype.handleGeometryChanged_ = function() {
EventType.CHANGE, this.handleGeometryChange_, this);
}
this.changed();
};
}
/**
* Set the default geometry for the feature. This will update the property
@@ -228,10 +218,9 @@ Feature.prototype.handleGeometryChanged_ = function() {
* @api
* @observable
*/
Feature.prototype.setGeometry = function(geometry) {
setGeometry(geometry) {
this.set(this.geometryName_, geometry);
};
}
/**
* Set the style for the feature. This can be a single style object, an array
@@ -241,12 +230,11 @@ Feature.prototype.setGeometry = function(geometry) {
* @api
* @fires module:ol/events/Event~Event#event:change
*/
Feature.prototype.setStyle = function(style) {
setStyle(style) {
this.style_ = style;
this.styleFunction_ = !style ? undefined : createStyleFunction(style);
this.changed();
};
}
/**
* Set the feature id. The feature id is considered stable and may be used when
@@ -257,11 +245,10 @@ Feature.prototype.setStyle = function(style) {
* @api
* @fires module:ol/events/Event~Event#event:change
*/
Feature.prototype.setId = function(id) {
setId(id) {
this.id_ = id;
this.changed();
};
}
/**
* Set the property name to be used when getting the feature's default geometry.
@@ -270,7 +257,7 @@ Feature.prototype.setId = function(id) {
* @param {string} name The property name of the default geometry.
* @api
*/
Feature.prototype.setGeometryName = function(name) {
setGeometryName(name) {
unlisten(
this, getChangeEventType(this.geometryName_),
this.handleGeometryChanged_, this);
@@ -279,7 +266,10 @@ Feature.prototype.setGeometryName = function(name) {
this, getChangeEventType(this.geometryName_),
this.handleGeometryChanged_, this);
this.handleGeometryChanged_();
};
}
}
inherits(Feature, BaseObject);
/**
src/ol/Geolocation.js
+44 -57
View File
@@ -49,7 +49,8 @@ import {get as getProjection, getTransformFromProjections, identityTransform} fr
* @param {module:ol/Geolocation~Options=} opt_options Options.
* @api
*/
const Geolocation = function(opt_options) {
class Geolocation {
constructor(opt_options) {
BaseObject.call(this);
@@ -90,24 +91,20 @@ const Geolocation = function(opt_options) {
this.setTracking(options.tracking !== undefined ? options.tracking : false);
};
inherits(Geolocation, BaseObject);
}
/**
* @inheritDoc
*/
Geolocation.prototype.disposeInternal = function() {
disposeInternal() {
this.setTracking(false);
BaseObject.prototype.disposeInternal.call(this);
};
}
/**
* @private
*/
Geolocation.prototype.handleProjectionChanged_ = function() {
handleProjectionChanged_() {
const projection = this.getProjection();
if (projection) {
this.transform_ = getTransformFromProjections(
@@ -116,13 +113,12 @@ Geolocation.prototype.handleProjectionChanged_ = function() {
this.set(GeolocationProperty.POSITION, this.transform_(this.position_));
}
}
};
}
/**
* @private
*/
Geolocation.prototype.handleTrackingChanged_ = function() {
handleTrackingChanged_() {
if (GEOLOCATION) {
const tracking = this.getTracking();
if (tracking && this.watchId_ === undefined) {
@@ -135,14 +131,13 @@ Geolocation.prototype.handleTrackingChanged_ = function() {
this.watchId_ = undefined;
}
}
};
}
/**
* @private
* @param {GeolocationPosition} position position event.
*/
Geolocation.prototype.positionChange_ = function(position) {
positionChange_(position) {
const coords = position.coords;
this.set(GeolocationProperty.ACCURACY, coords.accuracy);
this.set(GeolocationProperty.ALTITUDE,
@@ -166,7 +161,7 @@ Geolocation.prototype.positionChange_ = function(position) {
geometry.applyTransform(this.transform_);
this.set(GeolocationProperty.ACCURACY_GEOMETRY, geometry);
this.changed();
};
}
/**
* Triggered when the Geolocation returns an error.
@@ -178,12 +173,11 @@ Geolocation.prototype.positionChange_ = function(position) {
* @private
* @param {GeolocationPositionError} error error object.
*/
Geolocation.prototype.positionError_ = function(error) {
positionError_(error) {
error.type = EventType.ERROR;
this.setTracking(false);
this.dispatchEvent(/** @type {{type: string, target: undefined}} */ (error));
};
}
/**
* Get the accuracy of the position in meters.
@@ -192,10 +186,9 @@ Geolocation.prototype.positionError_ = function(error) {
* @observable
* @api
*/
Geolocation.prototype.getAccuracy = function() {
getAccuracy() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.ACCURACY));
};
}
/**
* Get a geometry of the position accuracy.
@@ -203,12 +196,11 @@ Geolocation.prototype.getAccuracy = function() {
* @observable
* @api
*/
Geolocation.prototype.getAccuracyGeometry = function() {
getAccuracyGeometry() {
return (
/** @type {?module:ol/geom/Polygon} */ (this.get(GeolocationProperty.ACCURACY_GEOMETRY) || null)
);
};
}
/**
* Get the altitude associated with the position.
@@ -217,10 +209,9 @@ Geolocation.prototype.getAccuracyGeometry = function() {
* @observable
* @api
*/
Geolocation.prototype.getAltitude = function() {
getAltitude() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.ALTITUDE));
};
}
/**
* Get the altitude accuracy of the position.
@@ -229,10 +220,9 @@ Geolocation.prototype.getAltitude = function() {
* @observable
* @api
*/
Geolocation.prototype.getAltitudeAccuracy = function() {
getAltitudeAccuracy() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.ALTITUDE_ACCURACY));
};
}
/**
* Get the heading as radians clockwise from North.
@@ -242,10 +232,9 @@ Geolocation.prototype.getAltitudeAccuracy = function() {
* @observable
* @api
*/
Geolocation.prototype.getHeading = function() {
getHeading() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.HEADING));
};
}
/**
* Get the position of the device.
@@ -254,12 +243,11 @@ Geolocation.prototype.getHeading = function() {
* @observable
* @api
*/
Geolocation.prototype.getPosition = function() {
getPosition() {
return (
/** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(GeolocationProperty.POSITION))
);
};
}
/**
* Get the projection associated with the position.
@@ -268,12 +256,11 @@ Geolocation.prototype.getPosition = function() {
* @observable
* @api
*/
Geolocation.prototype.getProjection = function() {
getProjection() {
return (
/** @type {module:ol/proj/Projection|undefined} */ (this.get(GeolocationProperty.PROJECTION))
);
};
}
/**
* Get the speed in meters per second.
@@ -282,10 +269,9 @@ Geolocation.prototype.getProjection = function() {
* @observable
* @api
*/
Geolocation.prototype.getSpeed = function() {
getSpeed() {
return /** @type {number|undefined} */ (this.get(GeolocationProperty.SPEED));
};
}
/**
* Determine if the device location is being tracked.
@@ -293,10 +279,9 @@ Geolocation.prototype.getSpeed = function() {
* @observable
* @api
*/
Geolocation.prototype.getTracking = function() {
getTracking() {
return /** @type {boolean} */ (this.get(GeolocationProperty.TRACKING));
};
}
/**
* Get the tracking options.
@@ -307,10 +292,9 @@ Geolocation.prototype.getTracking = function() {
* @observable
* @api
*/
Geolocation.prototype.getTrackingOptions = function() {
getTrackingOptions() {
return /** @type {GeolocationPositionOptions|undefined} */ (this.get(GeolocationProperty.TRACKING_OPTIONS));
};
}
/**
* Set the projection to use for transforming the coordinates.
@@ -319,10 +303,9 @@ Geolocation.prototype.getTrackingOptions = function() {
* @observable
* @api
*/
Geolocation.prototype.setProjection = function(projection) {
setProjection(projection) {
this.set(GeolocationProperty.PROJECTION, getProjection(projection));
};
}
/**
* Enable or disable tracking.
@@ -330,10 +313,9 @@ Geolocation.prototype.setProjection = function(projection) {
* @observable
* @api
*/
Geolocation.prototype.setTracking = function(tracking) {
setTracking(tracking) {
this.set(GeolocationProperty.TRACKING, tracking);
};
}
/**
* Set the tracking options.
@@ -344,7 +326,12 @@ Geolocation.prototype.setTracking = function(tracking) {
* @observable
* @api
*/
Geolocation.prototype.setTrackingOptions = function(options) {
setTrackingOptions(options) {
this.set(GeolocationProperty.TRACKING_OPTIONS, options);
};
}
}
inherits(Geolocation, BaseObject);
export default Geolocation;
src/ol/Graticule.js
+33 -43
View File
@@ -116,7 +116,8 @@ const INTERVALS = [
* @param {module:ol/Graticule~Options=} opt_options Options.
* @api
*/
const Graticule = function(opt_options) {
class Graticule {
constructor(opt_options) {
const options = opt_options || {};
/**
@@ -317,8 +318,7 @@ const Graticule = function(opt_options) {
}
this.setMap(options.map !== undefined ? options.map : null);
};
}
/**
* @param {number} lon Longitude.
@@ -330,7 +330,7 @@ const Graticule = function(opt_options) {
* @return {number} Index.
* @private
*/
Graticule.prototype.addMeridian_ = function(lon, minLat, maxLat, squaredTolerance, extent, index) {
addMeridian_(lon, minLat, maxLat, squaredTolerance, extent, index) {
const lineString = this.getMeridian_(lon, minLat, maxLat, squaredTolerance, index);
if (intersects(lineString.getExtent(), extent)) {
if (this.meridiansLabels_) {
@@ -343,7 +343,7 @@ Graticule.prototype.addMeridian_ = function(lon, minLat, maxLat, squaredToleranc
this.meridians_[index++] = lineString;
}
return index;
};
}
/**
* @param {module:ol/geom/LineString} lineString Meridian
@@ -352,7 +352,7 @@ Graticule.prototype.addMeridian_ = function(lon, minLat, maxLat, squaredToleranc
* @return {module:ol/geom/Point} Meridian point.
* @private
*/
Graticule.prototype.getMeridianPoint_ = function(lineString, extent, index) {
getMeridianPoint_(lineString, extent, index) {
const flatCoordinates = lineString.getFlatCoordinates();
const clampedBottom = Math.max(extent[1], flatCoordinates[1]);
const clampedTop = Math.min(extent[3], flatCoordinates[flatCoordinates.length - 1]);
@@ -368,8 +368,7 @@ Graticule.prototype.getMeridianPoint_ = function(lineString, extent, index) {
point = new Point(coordinate);
}
return point;
};
}
/**
* @param {number} lat Latitude.
@@ -381,7 +380,7 @@ Graticule.prototype.getMeridianPoint_ = function(lineString, extent, index) {
* @return {number} Index.
* @private
*/
Graticule.prototype.addParallel_ = function(lat, minLon, maxLon, squaredTolerance, extent, index) {
addParallel_(lat, minLon, maxLon, squaredTolerance, extent, index) {
const lineString = this.getParallel_(lat, minLon, maxLon, squaredTolerance, index);
if (intersects(lineString.getExtent(), extent)) {
if (this.parallelsLabels_) {
@@ -394,8 +393,7 @@ Graticule.prototype.addParallel_ = function(lat, minLon, maxLon, squaredToleranc
this.parallels_[index++] = lineString;
}
return index;
};
}
/**
* @param {module:ol/geom/LineString} lineString Parallels.
@@ -404,7 +402,7 @@ Graticule.prototype.addParallel_ = function(lat, minLon, maxLon, squaredToleranc
* @return {module:ol/geom/Point} Parallel point.
* @private
*/
Graticule.prototype.getParallelPoint_ = function(lineString, extent, index) {
getParallelPoint_(lineString, extent, index) {
const flatCoordinates = lineString.getFlatCoordinates();
const clampedLeft = Math.max(extent[0], flatCoordinates[0]);
const clampedRight = Math.min(extent[2], flatCoordinates[flatCoordinates.length - 2]);
@@ -420,8 +418,7 @@ Graticule.prototype.getParallelPoint_ = function(lineString, extent, index) {
point = new Point(coordinate);
}
return point;
};
}
/**
* @param {module:ol/extent~Extent} extent Extent.
@@ -430,7 +427,7 @@ Graticule.prototype.getParallelPoint_ = function(lineString, extent, index) {
* @param {number} squaredTolerance Squared tolerance.
* @private
*/
Graticule.prototype.createGraticule_ = function(extent, center, resolution, squaredTolerance) {
createGraticule_(extent, center, resolution, squaredTolerance) {
const interval = this.getInterval_(resolution);
if (interval == -1) {
@@ -515,15 +512,14 @@ Graticule.prototype.createGraticule_ = function(extent, center, resolution, squa
this.parallelsLabels_.length = idx;
}
};
}
/**
* @param {number} resolution Resolution.
* @return {number} The interval in degrees.
* @private
*/
Graticule.prototype.getInterval_ = function(resolution) {
getInterval_(resolution) {
const centerLon = this.projectionCenterLonLat_[0];
const centerLat = this.projectionCenterLonLat_[1];
let interval = -1;
@@ -547,18 +543,16 @@ Graticule.prototype.getInterval_ = function(resolution) {
interval = INTERVALS[i];
}
return interval;
};
}
/**
* Get the map associated with this graticule.
* @return {module:ol/PluggableMap} The map.
* @api
*/
Graticule.prototype.getMap = function() {
getMap() {
return this.map_;
};
}
/**
* @param {number} lon Longitude.
@@ -569,7 +563,7 @@ Graticule.prototype.getMap = function() {
* @param {number} index Index.
* @private
*/
Graticule.prototype.getMeridian_ = function(lon, minLat, maxLat, squaredTolerance, index) {
getMeridian_(lon, minLat, maxLat, squaredTolerance, index) {
const flatCoordinates = meridian(lon, minLat, maxLat, this.projection_, squaredTolerance);
let lineString = this.meridians_[index];
if (!lineString) {
@@ -579,18 +573,16 @@ Graticule.prototype.getMeridian_ = function(lon, minLat, maxLat, squaredToleranc
lineString.changed();
}
return lineString;
};
}
/**
* Get the list of meridians. Meridians are lines of equal longitude.
* @return {Array.<module:ol/geom/LineString>} The meridians.
* @api
*/
Graticule.prototype.getMeridians = function() {
getMeridians() {
return this.meridians_;
};
}
/**
* @param {number} lat Latitude.
@@ -601,7 +593,7 @@ Graticule.prototype.getMeridians = function() {
* @param {number} index Index.
* @private
*/
Graticule.prototype.getParallel_ = function(lat, minLon, maxLon, squaredTolerance, index) {
getParallel_(lat, minLon, maxLon, squaredTolerance, index) {
const flatCoordinates = parallel(lat, minLon, maxLon, this.projection_, squaredTolerance);
let lineString = this.parallels_[index];
if (!lineString) {
@@ -611,24 +603,22 @@ Graticule.prototype.getParallel_ = function(lat, minLon, maxLon, squaredToleranc
lineString.changed();
}
return lineString;
};
}
/**
* Get the list of parallels. Parallels are lines of equal latitude.
* @return {Array.<module:ol/geom/LineString>} The parallels.
* @api
*/
Graticule.prototype.getParallels = function() {
getParallels() {
return this.parallels_;
};
}
/**
* @param {module:ol/render/Event} e Event.
* @private
*/
Graticule.prototype.handlePostCompose_ = function(e) {
handlePostCompose_(e) {
const vectorContext = e.vectorContext;
const frameState = e.frameState;
const extent = frameState.extent;
@@ -677,14 +667,13 @@ Graticule.prototype.handlePostCompose_ = function(e) {
vectorContext.drawGeometry(labelData.geom);
}
}
};
}
/**
* @param {module:ol/proj/Projection} projection Projection.
* @private
*/
Graticule.prototype.updateProjectionInfo_ = function(projection) {
updateProjectionInfo_(projection) {
const epsg4326Projection = getProjection('EPSG:4326');
const worldExtent = projection.getWorldExtent();
@@ -707,8 +696,7 @@ Graticule.prototype.updateProjectionInfo_ = function(projection) {
this.projectionCenterLonLat_ = this.toLonLatTransform_(getCenter(projection.getExtent()));
this.projection_ = projection;
};
}
/**
* Set the map for this graticule. The graticule will be rendered on the
@@ -716,7 +704,7 @@ Graticule.prototype.updateProjectionInfo_ = function(projection) {
* @param {module:ol/PluggableMap} map Map.
* @api
*/
Graticule.prototype.setMap = function(map) {
setMap(map) {
if (this.map_) {
unlistenByKey(this.postcomposeListenerKey_);
this.postcomposeListenerKey_ = null;
@@ -727,5 +715,7 @@ Graticule.prototype.setMap = function(map) {
map.render();
}
this.map_ = map;
};
}
}
export default Graticule;
src/ol/Image.js
+19 -22
View File
@@ -38,7 +38,8 @@ import {getHeight} from './extent.js';
* @param {?string} crossOrigin Cross origin.
* @param {module:ol/Image~LoadFunction} imageLoadFunction Image load function.
*/
const ImageWrapper = function(extent, resolution, pixelRatio, src, crossOrigin, imageLoadFunction) {
class ImageWrapper {
constructor(extent, resolution, pixelRatio, src, crossOrigin, imageLoadFunction) {
ImageBase.call(this, extent, resolution, pixelRatio, ImageState.IDLE);
@@ -75,46 +76,40 @@ const ImageWrapper = function(extent, resolution, pixelRatio, src, crossOrigin,
*/
this.imageLoadFunction_ = imageLoadFunction;
};
inherits(ImageWrapper, ImageBase);
}
/**
* @inheritDoc
* @api
*/
ImageWrapper.prototype.getImage = function() {
getImage() {
return this.image_;
};
}
/**
* Tracks loading or read errors.
*
* @private
*/
ImageWrapper.prototype.handleImageError_ = function() {
handleImageError_() {
this.state = ImageState.ERROR;
this.unlistenImage_();
this.changed();
};
}
/**
* Tracks successful image load.
*
* @private
*/
ImageWrapper.prototype.handleImageLoad_ = function() {
handleImageLoad_() {
if (this.resolution === undefined) {
this.resolution = getHeight(this.extent) / this.image_.height;
}
this.state = ImageState.LOADED;
this.unlistenImage_();
this.changed();
};
}
/**
* Load the image or retry if loading previously failed.
@@ -123,7 +118,7 @@ ImageWrapper.prototype.handleImageLoad_ = function() {
* @override
* @api
*/
ImageWrapper.prototype.load = function() {
load() {
if (this.state == ImageState.IDLE || this.state == ImageState.ERROR) {
this.state = ImageState.LOADING;
this.changed();
@@ -135,25 +130,27 @@ ImageWrapper.prototype.load = function() {
];
this.imageLoadFunction_(this, this.src_);
}
};
}
/**
* @param {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} image Image.
*/
ImageWrapper.prototype.setImage = function(image) {
setImage(image) {
this.image_ = image;
};
}
/**
* Discards event handlers which listen for load completion or errors.
*
* @private
*/
ImageWrapper.prototype.unlistenImage_ = function() {
unlistenImage_() {
this.imageListenerKeys_.forEach(unlistenByKey);
this.imageListenerKeys_ = null;
};
}
}
inherits(ImageWrapper, ImageBase);
export default ImageWrapper;
src/ol/ImageBase.js
+19 -23
View File
@@ -14,7 +14,8 @@ import EventType from './events/EventType.js';
* @param {number} pixelRatio Pixel ratio.
* @param {module:ol/ImageState} state State.
*/
const ImageBase = function(extent, resolution, pixelRatio, state) {
class ImageBase {
constructor(extent, resolution, pixelRatio, state) {
EventTarget.call(this);
@@ -42,62 +43,57 @@ const ImageBase = function(extent, resolution, pixelRatio, state) {
*/
this.state = state;
};
inherits(ImageBase, EventTarget);
}
/**
* @protected
*/
ImageBase.prototype.changed = function() {
changed() {
this.dispatchEvent(EventType.CHANGE);
};
}
/**
* @return {module:ol/extent~Extent} Extent.
*/
ImageBase.prototype.getExtent = function() {
getExtent() {
return this.extent;
};
}
/**
* @abstract
* @return {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} Image.
*/
ImageBase.prototype.getImage = function() {};
getImage() {}
/**
* @return {number} PixelRatio.
*/
ImageBase.prototype.getPixelRatio = function() {
getPixelRatio() {
return this.pixelRatio_;
};
}
/**
* @return {number} Resolution.
*/
ImageBase.prototype.getResolution = function() {
getResolution() {
return /** @type {number} */ (this.resolution);
};
}
/**
* @return {module:ol/ImageState} State.
*/
ImageBase.prototype.getState = function() {
getState() {
return this.state;
};
}
/**
* Load not yet loaded URI.
* @abstract
*/
ImageBase.prototype.load = function() {};
load() {}
}
inherits(ImageBase, EventTarget);
export default ImageBase;
src/ol/ImageCanvas.js
+16 -16
View File
@@ -26,7 +26,8 @@ import ImageState from './ImageState.js';
* @param {module:ol/ImageCanvas~Loader=} opt_loader Optional loader function to
* support asynchronous canvas drawing.
*/
const ImageCanvas = function(extent, resolution, pixelRatio, canvas, opt_loader) {
class ImageCanvas {
constructor(extent, resolution, pixelRatio, canvas, opt_loader) {
/**
* Optional canvas loader function.
@@ -51,26 +52,22 @@ const ImageCanvas = function(extent, resolution, pixelRatio, canvas, opt_loader)
*/
this.error_ = null;
};
inherits(ImageCanvas, ImageBase);
}
/**
* Get any error associated with asynchronous rendering.
* @return {Error} Any error that occurred during rendering.
*/
ImageCanvas.prototype.getError = function() {
getError() {
return this.error_;
};
}
/**
* Handle async drawing complete.
* @param {Error} err Any error during drawing.
* @private
*/
ImageCanvas.prototype.handleLoad_ = function(err) {
handleLoad_(err) {
if (err) {
this.error_ = err;
this.state = ImageState.ERROR;
@@ -78,25 +75,28 @@ ImageCanvas.prototype.handleLoad_ = function(err) {
this.state = ImageState.LOADED;
}
this.changed();
};
}
/**
* @inheritDoc
*/
ImageCanvas.prototype.load = function() {
load() {
if (this.state == ImageState.IDLE) {
this.state = ImageState.LOADING;
this.changed();
this.loader_(this.handleLoad_.bind(this));
}
};
}
/**
* @return {HTMLCanvasElement} Canvas element.
*/
ImageCanvas.prototype.getImage = function() {
getImage() {
return this.canvas_;
};
}
}
inherits(ImageCanvas, ImageBase);
export default ImageCanvas;
src/ol/ImageTile.js
+20 -25
View File
@@ -24,7 +24,8 @@ import EventType from './events/EventType.js';
* @param {module:ol/Tile~LoadFunction} tileLoadFunction Tile load function.
* @param {module:ol/Tile~Options=} opt_options Tile options.
*/
const ImageTile = function(tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options) {
class ImageTile {
constructor(tileCoord, state, src, crossOrigin, tileLoadFunction, opt_options) {
Tile.call(this, tileCoord, state, opt_options);
@@ -63,15 +64,12 @@ const ImageTile = function(tileCoord, state, src, crossOrigin, tileLoadFunction,
*/
this.tileLoadFunction_ = tileLoadFunction;
};
inherits(ImageTile, Tile);
}
/**
* @inheritDoc
*/
ImageTile.prototype.disposeInternal = function() {
disposeInternal() {
if (this.state == TileState.LOADING) {
this.unlistenImage_();
this.image_ = getBlankImage();
@@ -82,46 +80,42 @@ ImageTile.prototype.disposeInternal = function() {
this.state = TileState.ABORT;
this.changed();
Tile.prototype.disposeInternal.call(this);
};
}
/**
* Get the HTML image element for this tile (may be a Canvas, Image, or Video).
* @return {HTMLCanvasElement|HTMLImageElement|HTMLVideoElement} Image.
* @api
*/
ImageTile.prototype.getImage = function() {
getImage() {
return this.image_;
};
}
/**
* @inheritDoc
*/
ImageTile.prototype.getKey = function() {
getKey() {
return this.src_;
};
}
/**
* Tracks loading or read errors.
*
* @private
*/
ImageTile.prototype.handleImageError_ = function() {
handleImageError_() {
this.state = TileState.ERROR;
this.unlistenImage_();
this.image_ = getBlankImage();
this.changed();
};
}
/**
* Tracks successful image load.
*
* @private
*/
ImageTile.prototype.handleImageLoad_ = function() {
handleImageLoad_() {
if (this.image_.naturalWidth && this.image_.naturalHeight) {
this.state = TileState.LOADED;
} else {
@@ -129,14 +123,13 @@ ImageTile.prototype.handleImageLoad_ = function() {
}
this.unlistenImage_();
this.changed();
};
}
/**
* @inheritDoc
* @api
*/
ImageTile.prototype.load = function() {
load() {
if (this.state == TileState.ERROR) {
this.state = TileState.IDLE;
this.image_ = new Image();
@@ -155,18 +148,20 @@ ImageTile.prototype.load = function() {
];
this.tileLoadFunction_(this, this.src_);
}
};
}
/**
* Discards event handlers which listen for load completion or errors.
*
* @private
*/
ImageTile.prototype.unlistenImage_ = function() {
unlistenImage_() {
this.imageListenerKeys_.forEach(unlistenByKey);
this.imageListenerKeys_ = null;
};
}
}
inherits(ImageTile, Tile);
/**
src/ol/Kinetic.js
+15 -17
View File
@@ -14,7 +14,8 @@
* @struct
* @api
*/
const Kinetic = function(decay, minVelocity, delay) {
class Kinetic {
constructor(decay, minVelocity, delay) {
/**
* @private
@@ -51,32 +52,29 @@ const Kinetic = function(decay, minVelocity, delay) {
* @type {number}
*/
this.initialVelocity_ = 0;
};
}
/**
* FIXME empty description for jsdoc
*/
Kinetic.prototype.begin = function() {
begin() {
this.points_.length = 0;
this.angle_ = 0;
this.initialVelocity_ = 0;
};
}
/**
* @param {number} x X.
* @param {number} y Y.
*/
Kinetic.prototype.update = function(x, y) {
update(x, y) {
this.points_.push(x, y, Date.now());
};
}
/**
* @return {boolean} Whether we should do kinetic animation.
*/
Kinetic.prototype.end = function() {
end() {
if (this.points_.length < 6) {
// at least 2 points are required (i.e. there must be at least 6 elements
// in the array)
@@ -109,21 +107,21 @@ Kinetic.prototype.end = function() {
this.angle_ = Math.atan2(dy, dx);
this.initialVelocity_ = Math.sqrt(dx * dx + dy * dy) / duration;
return this.initialVelocity_ > this.minVelocity_;
};
}
/**
* @return {number} Total distance travelled (pixels).
*/
Kinetic.prototype.getDistance = function() {
getDistance() {
return (this.minVelocity_ - this.initialVelocity_) / this.decay_;
};
}
/**
* @return {number} Angle of the kinetic panning animation (radians).
*/
Kinetic.prototype.getAngle = function() {
getAngle() {
return this.angle_;
};
}
}
export default Kinetic;
src/ol/Map.js
+8 -6
View File
@@ -66,7 +66,8 @@ import CanvasVectorTileLayerRenderer from './renderer/canvas/VectorTileLayer.js'
* @fires module:ol/render/Event~RenderEvent#precompose
* @api
*/
const Map = function(options) {
class Map {
constructor(options) {
options = assign({}, options);
if (!options.controls) {
options.controls = defaultControls();
@@ -76,11 +77,9 @@ const Map = function(options) {
}
PluggableMap.call(this, options);
};
}
inherits(Map, PluggableMap);
Map.prototype.createRenderer = function() {
createRenderer() {
const renderer = new CanvasMapRenderer(this);
renderer.registerLayerRenderers([
CanvasImageLayerRenderer,
@@ -89,6 +88,9 @@ Map.prototype.createRenderer = function() {
CanvasVectorTileLayerRenderer
]);
return renderer;
};
}
}
inherits(Map, PluggableMap);
export default Map;
src/ol/MapBrowserEvent.js
+12 -10
View File
@@ -17,7 +17,8 @@ import MapEvent from './MapEvent.js';
* @param {boolean=} opt_dragging Is the map currently being dragged?
* @param {?module:ol/PluggableMap~FrameState=} opt_frameState Frame state.
*/
const MapBrowserEvent = function(type, map, browserEvent, opt_dragging, opt_frameState) {
class MapBrowserEvent {
constructor(type, map, browserEvent, opt_dragging, opt_frameState) {
MapEvent.call(this, type, map, opt_frameState);
@@ -52,10 +53,7 @@ const MapBrowserEvent = function(type, map, browserEvent, opt_dragging, opt_fram
*/
this.dragging = opt_dragging !== undefined ? opt_dragging : false;
};
inherits(MapBrowserEvent, MapEvent);
}
/**
* Prevents the default browser action.
@@ -63,11 +61,10 @@ inherits(MapBrowserEvent, MapEvent);
* @override
* @api
*/
MapBrowserEvent.prototype.preventDefault = function() {
preventDefault() {
MapEvent.prototype.preventDefault.call(this);
this.originalEvent.preventDefault();
};
}
/**
* Prevents further propagation of the current event.
@@ -75,8 +72,13 @@ MapBrowserEvent.prototype.preventDefault = function() {
* @override
* @api
*/
MapBrowserEvent.prototype.stopPropagation = function() {
stopPropagation() {
MapEvent.prototype.stopPropagation.call(this);
this.originalEvent.stopPropagation();
};
}
}
inherits(MapBrowserEvent, MapEvent);
export default MapBrowserEvent;
src/ol/MapBrowserEventHandler.js
+26 -31
View File
@@ -18,7 +18,8 @@ import PointerEventHandler from './pointer/PointerEventHandler.js';
* @constructor
* @extends {module:ol/events/EventTarget}
*/
const MapBrowserEventHandler = function(map, moveTolerance) {
class MapBrowserEventHandler {
constructor(map, moveTolerance) {
EventTarget.call(this);
@@ -110,17 +111,14 @@ const MapBrowserEventHandler = function(map, moveTolerance) {
PointerEventType.POINTERMOVE,
this.relayEvent_, this);
};
inherits(MapBrowserEventHandler, EventTarget);
}
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.emulateClick_ = function(pointerEvent) {
emulateClick_(pointerEvent) {
let newEvent = new MapBrowserPointerEvent(
MapBrowserEventType.CLICK, this.map_, pointerEvent);
this.dispatchEvent(newEvent);
@@ -140,8 +138,7 @@ MapBrowserEventHandler.prototype.emulateClick_ = function(pointerEvent) {
this.dispatchEvent(newEvent);
}.bind(this), 250);
}
};
}
/**
* Keeps track on how many pointers are currently active.
@@ -150,7 +147,7 @@ MapBrowserEventHandler.prototype.emulateClick_ = function(pointerEvent) {
* event.
* @private
*/
MapBrowserEventHandler.prototype.updateActivePointers_ = function(pointerEvent) {
updateActivePointers_(pointerEvent) {
const event = pointerEvent;
if (event.type == MapBrowserEventType.POINTERUP ||
@@ -160,15 +157,14 @@ MapBrowserEventHandler.prototype.updateActivePointers_ = function(pointerEvent)
this.trackedTouches_[event.pointerId] = true;
}
this.activePointers_ = Object.keys(this.trackedTouches_).length;
};
}
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.handlePointerUp_ = function(pointerEvent) {
handlePointerUp_(pointerEvent) {
this.updateActivePointers_(pointerEvent);
const newEvent = new MapBrowserPointerEvent(
MapBrowserEventType.POINTERUP, this.map_, pointerEvent);
@@ -192,8 +188,7 @@ MapBrowserEventHandler.prototype.handlePointerUp_ = function(pointerEvent) {
this.documentPointerEventHandler_.dispose();
this.documentPointerEventHandler_ = null;
}
};
}
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
@@ -201,17 +196,16 @@ MapBrowserEventHandler.prototype.handlePointerUp_ = function(pointerEvent) {
* @return {boolean} If the left mouse button was pressed.
* @private
*/
MapBrowserEventHandler.prototype.isMouseActionButton_ = function(pointerEvent) {
isMouseActionButton_(pointerEvent) {
return pointerEvent.button === 0;
};
}
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.handlePointerDown_ = function(pointerEvent) {
handlePointerDown_(pointerEvent) {
this.updateActivePointers_(pointerEvent);
const newEvent = new MapBrowserPointerEvent(
MapBrowserEventType.POINTERDOWN, this.map_, pointerEvent);
@@ -252,15 +246,14 @@ MapBrowserEventHandler.prototype.handlePointerDown_ = function(pointerEvent) {
this.handlePointerUp_, this)
);
}
};
}
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
* event.
* @private
*/
MapBrowserEventHandler.prototype.handlePointerMove_ = function(pointerEvent) {
handlePointerMove_(pointerEvent) {
// Between pointerdown and pointerup, pointermove events are triggered.
// To avoid a 'false' touchmove event to be dispatched, we test if the pointer
// moved a significant distance.
@@ -277,8 +270,7 @@ MapBrowserEventHandler.prototype.handlePointerMove_ = function(pointerEvent) {
// https://code.google.com/p/android/issues/detail?id=19827
// ex: Galaxy Tab P3110 + Android 4.1.1
pointerEvent.preventDefault();
};
}
/**
* Wrap and relay a pointer event. Note that this requires that the type
@@ -287,12 +279,11 @@ MapBrowserEventHandler.prototype.handlePointerMove_ = function(pointerEvent) {
* event.
* @private
*/
MapBrowserEventHandler.prototype.relayEvent_ = function(pointerEvent) {
relayEvent_(pointerEvent) {
const dragging = !!(this.down_ && this.isMoving_(pointerEvent));
this.dispatchEvent(new MapBrowserPointerEvent(
pointerEvent.type, this.map_, pointerEvent, dragging));
};
}
/**
* @param {module:ol/pointer/PointerEvent} pointerEvent Pointer
@@ -300,17 +291,16 @@ MapBrowserEventHandler.prototype.relayEvent_ = function(pointerEvent) {
* @return {boolean} Is moving.
* @private
*/
MapBrowserEventHandler.prototype.isMoving_ = function(pointerEvent) {
isMoving_(pointerEvent) {
return this.dragging_ ||
Math.abs(pointerEvent.clientX - this.down_.clientX) > this.moveTolerance_ ||
Math.abs(pointerEvent.clientY - this.down_.clientY) > this.moveTolerance_;
};
}
/**
* @inheritDoc
*/
MapBrowserEventHandler.prototype.disposeInternal = function() {
disposeInternal() {
if (this.relayedListenerKey_) {
unlistenByKey(this.relayedListenerKey_);
this.relayedListenerKey_ = null;
@@ -332,5 +322,10 @@ MapBrowserEventHandler.prototype.disposeInternal = function() {
this.pointerEventHandler_ = null;
}
EventTarget.prototype.disposeInternal.call(this);
};
}
}
inherits(MapBrowserEventHandler, EventTarget);
export default MapBrowserEventHandler;
src/ol/Object.js
+96 -101
View File
@@ -87,7 +87,8 @@ inherits(ObjectEvent, Event);
* @fires module:ol/Object~ObjectEvent
* @api
*/
const BaseObject = function(opt_values) {
class BaseObject {
constructor(opt_values) {
Observable.call(this);
// Call {@link module:ol~getUid} to ensure that the order of objects' ids is
@@ -105,7 +106,100 @@ const BaseObject = function(opt_values) {
if (opt_values !== undefined) {
this.setProperties(opt_values);
}
};
}
/**
* Gets a value.
* @param {string} key Key name.
* @return {*} Value.
* @api
*/
get(key) {
let value;
if (this.values_.hasOwnProperty(key)) {
value = this.values_[key];
}
return value;
}
/**
* Get a list of object property names.
* @return {Array.<string>} List of property names.
* @api
*/
getKeys() {
return Object.keys(this.values_);
}
/**
* Get an object of all property names and values.
* @return {Object.<string, *>} Object.
* @api
*/
getProperties() {
return assign({}, this.values_);
}
/**
* @param {string} key Key name.
* @param {*} oldValue Old value.
*/
notify(key, oldValue) {
let eventType;
eventType = getChangeEventType(key);
this.dispatchEvent(new ObjectEvent(eventType, key, oldValue));
eventType = ObjectEventType.PROPERTYCHANGE;
this.dispatchEvent(new ObjectEvent(eventType, key, oldValue));
}
/**
* Sets a value.
* @param {string} key Key name.
* @param {*} value Value.
* @param {boolean=} opt_silent Update without triggering an event.
* @api
*/
set(key, value, opt_silent) {
if (opt_silent) {
this.values_[key] = value;
} else {
const oldValue = this.values_[key];
this.values_[key] = value;
if (oldValue !== value) {
this.notify(key, oldValue);
}
}
}
/**
* Sets a collection of key-value pairs. Note that this changes any existing
* properties and adds new ones (it does not remove any existing properties).
* @param {Object.<string, *>} values Values.
* @param {boolean=} opt_silent Update without triggering an event.
* @api
*/
setProperties(values, opt_silent) {
for (const key in values) {
this.set(key, values[key], opt_silent);
}
}
/**
* Unsets a property.
* @param {string} key Key name.
* @param {boolean=} opt_silent Unset without triggering an event.
* @api
*/
unset(key, opt_silent) {
if (key in this.values_) {
const oldValue = this.values_[key];
delete this.values_[key];
if (!opt_silent) {
this.notify(key, oldValue);
}
}
}
}
inherits(BaseObject, Observable);
@@ -127,103 +221,4 @@ export function getChangeEventType(key) {
}
/**
* Gets a value.
* @param {string} key Key name.
* @return {*} Value.
* @api
*/
BaseObject.prototype.get = function(key) {
let value;
if (this.values_.hasOwnProperty(key)) {
value = this.values_[key];
}
return value;
};
/**
* Get a list of object property names.
* @return {Array.<string>} List of property names.
* @api
*/
BaseObject.prototype.getKeys = function() {
return Object.keys(this.values_);
};
/**
* Get an object of all property names and values.
* @return {Object.<string, *>} Object.
* @api
*/
BaseObject.prototype.getProperties = function() {
return assign({}, this.values_);
};
/**
* @param {string} key Key name.
* @param {*} oldValue Old value.
*/
BaseObject.prototype.notify = function(key, oldValue) {
let eventType;
eventType = getChangeEventType(key);
this.dispatchEvent(new ObjectEvent(eventType, key, oldValue));
eventType = ObjectEventType.PROPERTYCHANGE;
this.dispatchEvent(new ObjectEvent(eventType, key, oldValue));
};
/**
* Sets a value.
* @param {string} key Key name.
* @param {*} value Value.
* @param {boolean=} opt_silent Update without triggering an event.
* @api
*/
BaseObject.prototype.set = function(key, value, opt_silent) {
if (opt_silent) {
this.values_[key] = value;
} else {
const oldValue = this.values_[key];
this.values_[key] = value;
if (oldValue !== value) {
this.notify(key, oldValue);
}
}
};
/**
* Sets a collection of key-value pairs. Note that this changes any existing
* properties and adds new ones (it does not remove any existing properties).
* @param {Object.<string, *>} values Values.
* @param {boolean=} opt_silent Update without triggering an event.
* @api
*/
BaseObject.prototype.setProperties = function(values, opt_silent) {
for (const key in values) {
this.set(key, values[key], opt_silent);
}
};
/**
* Unsets a property.
* @param {string} key Key name.
* @param {boolean=} opt_silent Unset without triggering an event.
* @api
*/
BaseObject.prototype.unset = function(key, opt_silent) {
if (key in this.values_) {
const oldValue = this.values_[key];
delete this.values_[key];
if (!opt_silent) {
this.notify(key, oldValue);
}
}
};
export default BaseObject;
src/ol/Observable.js
+84 -85
View File
@@ -20,7 +20,8 @@ import EventType from './events/EventType.js';
* @struct
* @api
*/
const Observable = function() {
class Observable {
constructor() {
EventTarget.call(this);
@@ -30,7 +31,88 @@ const Observable = function() {
*/
this.revision_ = 0;
};
}
/**
* Increases the revision counter and dispatches a 'change' event.
* @api
*/
changed() {
++this.revision_;
this.dispatchEvent(EventType.CHANGE);
}
/**
* Get the version number for this object. Each time the object is modified,
* its version number will be incremented.
* @return {number} Revision.
* @api
*/
getRevision() {
return this.revision_;
}
/**
* Listen for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
on(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; ++i) {
keys[i] = listen(this, type[i], listener);
}
return keys;
} else {
return listen(this, /** @type {string} */ (type), listener);
}
}
/**
* Listen once for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
once(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; ++i) {
keys[i] = listenOnce(this, type[i], listener);
}
return keys;
} else {
return listenOnce(this, /** @type {string} */ (type), listener);
}
}
/**
* Unlisten for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @api
*/
un(type, listener) {
if (Array.isArray(type)) {
for (let i = 0, ii = type.length; i < ii; ++i) {
unlisten(this, type[i], listener);
}
return;
} else {
unlisten(this, /** @type {string} */ (type), listener);
}
}
}
inherits(Observable, EventTarget);
@@ -52,16 +134,6 @@ export function unByKey(key) {
}
/**
* Increases the revision counter and dispatches a 'change' event.
* @api
*/
Observable.prototype.changed = function() {
++this.revision_;
this.dispatchEvent(EventType.CHANGE);
};
/**
* Dispatches an event and calls all listeners listening for events
* of this type. The event parameter can either be a string or an
@@ -76,77 +148,4 @@ Observable.prototype.changed = function() {
Observable.prototype.dispatchEvent;
/**
* Get the version number for this object. Each time the object is modified,
* its version number will be incremented.
* @return {number} Revision.
* @api
*/
Observable.prototype.getRevision = function() {
return this.revision_;
};
/**
* Listen for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
Observable.prototype.on = function(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; ++i) {
keys[i] = listen(this, type[i], listener);
}
return keys;
} else {
return listen(this, /** @type {string} */ (type), listener);
}
};
/**
* Listen once for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
Observable.prototype.once = function(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; ++i) {
keys[i] = listenOnce(this, type[i], listener);
}
return keys;
} else {
return listenOnce(this, /** @type {string} */ (type), listener);
}
};
/**
* Unlisten for a certain type of event.
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @api
*/
Observable.prototype.un = function(type, listener) {
if (Array.isArray(type)) {
for (let i = 0, ii = type.length; i < ii; ++i) {
unlisten(this, type[i], listener);
}
return;
} else {
unlisten(this, /** @type {string} */ (type), listener);
}
};
export default Observable;
src/ol/Overlay.js
+53 -73
View File
@@ -98,7 +98,8 @@ const Property = {
* @param {module:ol/Overlay~Options} options Overlay options.
* @api
*/
const Overlay = function(options) {
class Overlay {
constructor(options) {
BaseObject.call(this);
@@ -211,10 +212,7 @@ const Overlay = function(options) {
this.setPosition(options.position);
}
};
inherits(Overlay, BaseObject);
}
/**
* Get the DOM element of this overlay.
@@ -222,20 +220,18 @@ inherits(Overlay, BaseObject);
* @observable
* @api
*/
Overlay.prototype.getElement = function() {
getElement() {
return /** @type {HTMLElement|undefined} */ (this.get(Property.ELEMENT));
};
}
/**
* Get the overlay identifier which is set on constructor.
* @return {number|string|undefined} Id.
* @api
*/
Overlay.prototype.getId = function() {
getId() {
return this.id;
};
}
/**
* Get the map associated with this overlay.
@@ -244,12 +240,11 @@ Overlay.prototype.getId = function() {
* @observable
* @api
*/
Overlay.prototype.getMap = function() {
getMap() {
return (
/** @type {module:ol/PluggableMap|undefined} */ (this.get(Property.MAP))
);
};
}
/**
* Get the offset of this overlay.
@@ -257,10 +252,9 @@ Overlay.prototype.getMap = function() {
* @observable
* @api
*/
Overlay.prototype.getOffset = function() {
getOffset() {
return /** @type {Array.<number>} */ (this.get(Property.OFFSET));
};
}
/**
* Get the current position of this overlay.
@@ -269,12 +263,11 @@ Overlay.prototype.getOffset = function() {
* @observable
* @api
*/
Overlay.prototype.getPosition = function() {
getPosition() {
return (
/** @type {module:ol/coordinate~Coordinate|undefined} */ (this.get(Property.POSITION))
);
};
}
/**
* Get the current positioning of this overlay.
@@ -283,29 +276,27 @@ Overlay.prototype.getPosition = function() {
* @observable
* @api
*/
Overlay.prototype.getPositioning = function() {
getPositioning() {
return (
/** @type {module:ol/OverlayPositioning} */ (this.get(Property.POSITIONING))
);
};
}
/**
* @protected
*/
Overlay.prototype.handleElementChanged = function() {
handleElementChanged() {
removeChildren(this.element);
const element = this.getElement();
if (element) {
this.element.appendChild(element);
}
};
}
/**
* @protected
*/
Overlay.prototype.handleMapChanged = function() {
handleMapChanged() {
if (this.mapPostrenderListenerKey) {
removeNode(this.element);
unlistenByKey(this.mapPostrenderListenerKey);
@@ -324,43 +315,38 @@ Overlay.prototype.handleMapChanged = function() {
container.appendChild(this.element);
}
}
};
}
/**
* @protected
*/
Overlay.prototype.render = function() {
render() {
this.updatePixelPosition();
};
}
/**
* @protected
*/
Overlay.prototype.handleOffsetChanged = function() {
handleOffsetChanged() {
this.updatePixelPosition();
};
}
/**
* @protected
*/
Overlay.prototype.handlePositionChanged = function() {
handlePositionChanged() {
this.updatePixelPosition();
if (this.get(Property.POSITION) && this.autoPan) {
this.panIntoView();
}
};
}
/**
* @protected
*/
Overlay.prototype.handlePositioningChanged = function() {
handlePositioningChanged() {
this.updatePixelPosition();
};
}
/**
* Set the DOM element to be associated with this overlay.
@@ -368,10 +354,9 @@ Overlay.prototype.handlePositioningChanged = function() {
* @observable
* @api
*/
Overlay.prototype.setElement = function(element) {
setElement(element) {
this.set(Property.ELEMENT, element);
};
}
/**
* Set the map to be associated with this overlay.
@@ -380,10 +365,9 @@ Overlay.prototype.setElement = function(element) {
* @observable
* @api
*/
Overlay.prototype.setMap = function(map) {
setMap(map) {
this.set(Property.MAP, map);
};
}
/**
* Set the offset for this overlay.
@@ -391,10 +375,9 @@ Overlay.prototype.setMap = function(map) {
* @observable
* @api
*/
Overlay.prototype.setOffset = function(offset) {
setOffset(offset) {
this.set(Property.OFFSET, offset);
};
}
/**
* Set the position for this overlay. If the position is `undefined` the
@@ -404,17 +387,16 @@ Overlay.prototype.setOffset = function(offset) {
* @observable
* @api
*/
Overlay.prototype.setPosition = function(position) {
setPosition(position) {
this.set(Property.POSITION, position);
};
}
/**
* Pan the map so that the overlay is entirely visible in the current viewport
* (if necessary).
* @protected
*/
Overlay.prototype.panIntoView = function() {
panIntoView() {
const map = this.getMap();
if (!map || !map.getTargetElement()) {
@@ -464,8 +446,7 @@ Overlay.prototype.panIntoView = function() {
});
}
}
};
}
/**
* Get the extent of an element relative to the document
@@ -474,7 +455,7 @@ Overlay.prototype.panIntoView = function() {
* @return {module:ol/extent~Extent} The extent.
* @protected
*/
Overlay.prototype.getRect = function(element, size) {
getRect(element, size) {
const box = element.getBoundingClientRect();
const offsetX = box.left + window.pageXOffset;
const offsetY = box.top + window.pageYOffset;
@@ -484,8 +465,7 @@ Overlay.prototype.getRect = function(element, size) {
offsetX + size[0],
offsetY + size[1]
];
};
}
/**
* Set the positioning for this overlay.
@@ -494,29 +474,27 @@ Overlay.prototype.getRect = function(element, size) {
* @observable
* @api
*/
Overlay.prototype.setPositioning = function(positioning) {
setPositioning(positioning) {
this.set(Property.POSITIONING, positioning);
};
}
/**
* Modify the visibility of the element.
* @param {boolean} visible Element visibility.
* @protected
*/
Overlay.prototype.setVisible = function(visible) {
setVisible(visible) {
if (this.rendered.visible !== visible) {
this.element.style.display = visible ? '' : 'none';
this.rendered.visible = visible;
}
};
}
/**
* Update pixel position.
* @protected
*/
Overlay.prototype.updatePixelPosition = function() {
updatePixelPosition() {
const map = this.getMap();
const position = this.getPosition();
if (!map || !map.isRendered() || !position) {
@@ -527,15 +505,14 @@ Overlay.prototype.updatePixelPosition = function() {
const pixel = map.getPixelFromCoordinate(position);
const mapSize = map.getSize();
this.updateRenderedPosition(pixel, mapSize);
};
}
/**
* @param {module:ol~Pixel} pixel The pixel location.
* @param {module:ol/size~Size|undefined} mapSize The map size.
* @protected
*/
Overlay.prototype.updateRenderedPosition = function(pixel, mapSize) {
updateRenderedPosition(pixel, mapSize) {
const style = this.element.style;
const offset = this.getOffset();
@@ -593,15 +570,18 @@ Overlay.prototype.updateRenderedPosition = function(pixel, mapSize) {
this.rendered.top_ = style.top = top;
}
}
};
}
/**
* returns the options this Overlay has been created with
* @return {module:ol/Overlay~Options} overlay options
*/
Overlay.prototype.getOptions = function() {
getOptions() {
return this.options;
};
}
}
inherits(Overlay, BaseObject);
export default Overlay;
src/ol/PluggableMap.js
+114 -165
View File
@@ -140,7 +140,8 @@ import {create as createTransform, apply as applyTransform} from './transform.js
* @fires module:ol/render/Event~RenderEvent#precompose
* @api
*/
const PluggableMap = function(options) {
class PluggableMap {
constructor(options) {
BaseObject.call(this);
@@ -458,35 +459,29 @@ const PluggableMap = function(options) {
event.element.setMap(null);
}, this);
};
}
inherits(PluggableMap, BaseObject);
PluggableMap.prototype.createRenderer = function() {
createRenderer() {
throw new Error('Use a map type that has a createRenderer method');
};
}
/**
* Add the given control to the map.
* @param {module:ol/control/Control} control Control.
* @api
*/
PluggableMap.prototype.addControl = function(control) {
addControl(control) {
this.getControls().push(control);
};
}
/**
* Add the given interaction to the map.
* @param {module:ol/interaction/Interaction} interaction Interaction to add.
* @api
*/
PluggableMap.prototype.addInteraction = function(interaction) {
addInteraction(interaction) {
this.getInteractions().push(interaction);
};
}
/**
* Adds the given layer to the top of this map. If you want to add a layer
@@ -495,41 +490,38 @@ PluggableMap.prototype.addInteraction = function(interaction) {
* @param {module:ol/layer/Base} layer Layer.
* @api
*/
PluggableMap.prototype.addLayer = function(layer) {
addLayer(layer) {
const layers = this.getLayerGroup().getLayers();
layers.push(layer);
};
}
/**
* Add the given overlay to the map.
* @param {module:ol/Overlay} overlay Overlay.
* @api
*/
PluggableMap.prototype.addOverlay = function(overlay) {
addOverlay(overlay) {
this.getOverlays().push(overlay);
};
}
/**
* This deals with map's overlay collection changes.
* @param {module:ol/Overlay} overlay Overlay.
* @private
*/
PluggableMap.prototype.addOverlayInternal_ = function(overlay) {
addOverlayInternal_(overlay) {
const id = overlay.getId();
if (id !== undefined) {
this.overlayIdIndex_[id.toString()] = overlay;
}
overlay.setMap(this);
};
}
/**
*
* @inheritDoc
*/
PluggableMap.prototype.disposeInternal = function() {
disposeInternal() {
this.mapBrowserEventHandler_.dispose();
unlisten(this.viewport_, EventType.CONTEXTMENU, this.handleBrowserEvent, this);
unlisten(this.viewport_, EventType.WHEEL, this.handleBrowserEvent, this);
@@ -544,8 +536,7 @@ PluggableMap.prototype.disposeInternal = function() {
}
this.setTarget(null);
BaseObject.prototype.disposeInternal.call(this);
};
}
/**
* Detect features that intersect a pixel on the viewport, and execute a
@@ -566,7 +557,7 @@ PluggableMap.prototype.disposeInternal = function() {
* @template S,T
* @api
*/
PluggableMap.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_options) {
forEachFeatureAtPixel(pixel, callback, opt_options) {
if (!this.frameState_) {
return;
}
@@ -579,8 +570,7 @@ PluggableMap.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_opt
return this.renderer_.forEachFeatureAtCoordinate(
coordinate, this.frameState_, hitTolerance, callback, null,
layerFilter, null);
};
}
/**
* Get all features that intersect a pixel on the viewport.
@@ -590,7 +580,7 @@ PluggableMap.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_opt
* `null` if none were found.
* @api
*/
PluggableMap.prototype.getFeaturesAtPixel = function(pixel, opt_options) {
getFeaturesAtPixel(pixel, opt_options) {
let features = null;
this.forEachFeatureAtPixel(pixel, function(feature) {
if (!features) {
@@ -599,7 +589,7 @@ PluggableMap.prototype.getFeaturesAtPixel = function(pixel, opt_options) {
features.push(feature);
}, opt_options);
return features;
};
}
/**
* Detect layers that have a color value at a pixel on the viewport, and
@@ -618,7 +608,7 @@ PluggableMap.prototype.getFeaturesAtPixel = function(pixel, opt_options) {
* @template S,T
* @api
*/
PluggableMap.prototype.forEachLayerAtPixel = function(pixel, callback, opt_options) {
forEachLayerAtPixel(pixel, callback, opt_options) {
if (!this.frameState_) {
return;
}
@@ -628,8 +618,7 @@ PluggableMap.prototype.forEachLayerAtPixel = function(pixel, callback, opt_optio
const layerFilter = options.layerFilter || TRUE;
return this.renderer_.forEachLayerAtPixel(
pixel, this.frameState_, hitTolerance, callback, null, layerFilter, null);
};
}
/**
* Detect if features intersect a pixel on the viewport. Layers included in the
@@ -640,7 +629,7 @@ PluggableMap.prototype.forEachLayerAtPixel = function(pixel, callback, opt_optio
* @template U
* @api
*/
PluggableMap.prototype.hasFeatureAtPixel = function(pixel, opt_options) {
hasFeatureAtPixel(pixel, opt_options) {
if (!this.frameState_) {
return false;
}
@@ -651,8 +640,7 @@ PluggableMap.prototype.hasFeatureAtPixel = function(pixel, opt_options) {
opt_options.hitTolerance * this.frameState_.pixelRatio : 0;
return this.renderer_.hasFeatureAtCoordinate(
coordinate, this.frameState_, hitTolerance, layerFilter, null);
};
}
/**
* Returns the coordinate in view projection for a browser event.
@@ -660,10 +648,9 @@ PluggableMap.prototype.hasFeatureAtPixel = function(pixel, opt_options) {
* @return {module:ol/coordinate~Coordinate} Coordinate.
* @api
*/
PluggableMap.prototype.getEventCoordinate = function(event) {
getEventCoordinate(event) {
return this.getCoordinateFromPixel(this.getEventPixel(event));
};
}
/**
* Returns the map pixel position for a browser event relative to the viewport.
@@ -671,15 +658,14 @@ PluggableMap.prototype.getEventCoordinate = function(event) {
* @return {module:ol~Pixel} Pixel.
* @api
*/
PluggableMap.prototype.getEventPixel = function(event) {
getEventPixel(event) {
const viewportPosition = this.viewport_.getBoundingClientRect();
const eventPosition = event.changedTouches ? event.changedTouches[0] : event;
return [
eventPosition.clientX - viewportPosition.left,
eventPosition.clientY - viewportPosition.top
];
};
}
/**
* Get the target in which this map is rendered.
@@ -690,10 +676,9 @@ PluggableMap.prototype.getEventPixel = function(event) {
* @observable
* @api
*/
PluggableMap.prototype.getTarget = function() {
getTarget() {
return /** @type {HTMLElement|string|undefined} */ (this.get(MapProperty.TARGET));
};
}
/**
* Get the DOM element into which this map is rendered. In contrast to
@@ -702,15 +687,14 @@ PluggableMap.prototype.getTarget = function() {
* @return {HTMLElement} The element that the map is rendered in.
* @api
*/
PluggableMap.prototype.getTargetElement = function() {
getTargetElement() {
const target = this.getTarget();
if (target !== undefined) {
return typeof target === 'string' ? document.getElementById(target) : target;
} else {
return null;
}
};
}
/**
* Get the coordinate for a given pixel. This returns a coordinate in the
@@ -719,15 +703,14 @@ PluggableMap.prototype.getTargetElement = function() {
* @return {module:ol/coordinate~Coordinate} The coordinate for the pixel position.
* @api
*/
PluggableMap.prototype.getCoordinateFromPixel = function(pixel) {
getCoordinateFromPixel(pixel) {
const frameState = this.frameState_;
if (!frameState) {
return null;
} else {
return applyTransform(frameState.pixelToCoordinateTransform, pixel.slice());
}
};
}
/**
* Get the map controls. Modifying this collection changes the controls
@@ -735,10 +718,9 @@ PluggableMap.prototype.getCoordinateFromPixel = function(pixel) {
* @return {module:ol/Collection.<module:ol/control/Control>} Controls.
* @api
*/
PluggableMap.prototype.getControls = function() {
getControls() {
return this.controls;
};
}
/**
* Get the map overlays. Modifying this collection changes the overlays
@@ -746,10 +728,9 @@ PluggableMap.prototype.getControls = function() {
* @return {module:ol/Collection.<module:ol/Overlay>} Overlays.
* @api
*/
PluggableMap.prototype.getOverlays = function() {
getOverlays() {
return this.overlays_;
};
}
/**
* Get an overlay by its identifier (the value returned by overlay.getId()).
@@ -759,11 +740,10 @@ PluggableMap.prototype.getOverlays = function() {
* @return {module:ol/Overlay} Overlay.
* @api
*/
PluggableMap.prototype.getOverlayById = function(id) {
getOverlayById(id) {
const overlay = this.overlayIdIndex_[id.toString()];
return overlay !== undefined ? overlay : null;
};
}
/**
* Get the map interactions. Modifying this collection changes the interactions
@@ -773,10 +753,9 @@ PluggableMap.prototype.getOverlayById = function(id) {
* @return {module:ol/Collection.<module:ol/interaction/Interaction>} Interactions.
* @api
*/
PluggableMap.prototype.getInteractions = function() {
getInteractions() {
return this.interactions;
};
}
/**
* Get the layergroup associated with this map.
@@ -784,23 +763,21 @@ PluggableMap.prototype.getInteractions = function() {
* @observable
* @api
*/
PluggableMap.prototype.getLayerGroup = function() {
getLayerGroup() {
return (
/** @type {module:ol/layer/Group} */ (this.get(MapProperty.LAYERGROUP))
);
};
}
/**
* Get the collection of layers associated with this map.
* @return {!module:ol/Collection.<module:ol/layer/Base>} Layers.
* @api
*/
PluggableMap.prototype.getLayers = function() {
getLayers() {
const layers = this.getLayerGroup().getLayers();
return layers;
};
}
/**
* Get the pixel for a coordinate. This takes a coordinate in the map view
@@ -809,24 +786,22 @@ PluggableMap.prototype.getLayers = function() {
* @return {module:ol~Pixel} A pixel position in the map viewport.
* @api
*/
PluggableMap.prototype.getPixelFromCoordinate = function(coordinate) {
getPixelFromCoordinate(coordinate) {
const frameState = this.frameState_;
if (!frameState) {
return null;
} else {
return applyTransform(frameState.coordinateToPixelTransform, coordinate.slice(0, 2));
}
};
}
/**
* Get the map renderer.
* @return {module:ol/renderer/Map} Renderer
*/
PluggableMap.prototype.getRenderer = function() {
getRenderer() {
return this.renderer_;
};
}
/**
* Get the size of this map.
@@ -834,12 +809,11 @@ PluggableMap.prototype.getRenderer = function() {
* @observable
* @api
*/
PluggableMap.prototype.getSize = function() {
getSize() {
return (
/** @type {module:ol/size~Size|undefined} */ (this.get(MapProperty.SIZE))
);
};
}
/**
* Get the view associated with this map. A view manages properties such as
@@ -848,22 +822,20 @@ PluggableMap.prototype.getSize = function() {
* @observable
* @api
*/
PluggableMap.prototype.getView = function() {
getView() {
return (
/** @type {module:ol/View} */ (this.get(MapProperty.VIEW))
);
};
}
/**
* Get the element that serves as the map viewport.
* @return {HTMLElement} Viewport.
* @api
*/
PluggableMap.prototype.getViewport = function() {
getViewport() {
return this.viewport_;
};
}
/**
* Get the element that serves as the container for overlays. Elements added to
@@ -872,10 +844,9 @@ PluggableMap.prototype.getViewport = function() {
* events.
* @return {!HTMLElement} The map's overlay container.
*/
PluggableMap.prototype.getOverlayContainer = function() {
getOverlayContainer() {
return this.overlayContainer_;
};
}
/**
* Get the element that serves as a container for overlays that don't allow
@@ -884,10 +855,9 @@ PluggableMap.prototype.getOverlayContainer = function() {
* don't trigger any {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
* @return {!HTMLElement} The map's overlay container that stops events.
*/
PluggableMap.prototype.getOverlayContainerStopEvent = function() {
getOverlayContainerStopEvent() {
return this.overlayContainerStopEvent_;
};
}
/**
* @param {module:ol/Tile} tile Tile.
@@ -896,7 +866,7 @@ PluggableMap.prototype.getOverlayContainerStopEvent = function() {
* @param {number} tileResolution Tile resolution.
* @return {number} Tile priority.
*/
PluggableMap.prototype.getTilePriority = function(tile, tileSourceKey, tileCenter, tileResolution) {
getTilePriority(tile, tileSourceKey, tileCenter, tileResolution) {
// Filter out tiles at higher zoom levels than the current zoom level, or that
// are outside the visible extent.
const frameState = this.frameState_;
@@ -916,24 +886,22 @@ PluggableMap.prototype.getTilePriority = function(tile, tileSourceKey, tileCente
const deltaY = tileCenter[1] - frameState.focus[1];
return 65536 * Math.log(tileResolution) +
Math.sqrt(deltaX * deltaX + deltaY * deltaY) / tileResolution;
};
}
/**
* @param {Event} browserEvent Browser event.
* @param {string=} opt_type Type.
*/
PluggableMap.prototype.handleBrowserEvent = function(browserEvent, opt_type) {
handleBrowserEvent(browserEvent, opt_type) {
const type = opt_type || browserEvent.type;
const mapBrowserEvent = new MapBrowserEvent(type, this, browserEvent);
this.handleMapBrowserEvent(mapBrowserEvent);
};
}
/**
* @param {module:ol/MapBrowserEvent} mapBrowserEvent The event to handle.
*/
PluggableMap.prototype.handleMapBrowserEvent = function(mapBrowserEvent) {
handleMapBrowserEvent(mapBrowserEvent) {
if (!this.frameState_) {
// With no view defined, we cannot translate pixels into geographical
// coordinates so interactions cannot be used.
@@ -954,13 +922,12 @@ PluggableMap.prototype.handleMapBrowserEvent = function(mapBrowserEvent) {
}
}
}
};
}
/**
* @protected
*/
PluggableMap.prototype.handlePostRender = function() {
handlePostRender() {
const frameState = this.frameState_;
@@ -999,21 +966,19 @@ PluggableMap.prototype.handlePostRender = function() {
postRenderFunctions[i](this, frameState);
}
postRenderFunctions.length = 0;
};
}
/**
* @private
*/
PluggableMap.prototype.handleSizeChanged_ = function() {
handleSizeChanged_() {
this.render();
};
}
/**
* @private
*/
PluggableMap.prototype.handleTargetChanged_ = function() {
handleTargetChanged_() {
// target may be undefined, null, a string or an Element.
// If it's a string we convert it to an Element before proceeding.
// If it's not now an Element we remove the viewport from the DOM.
@@ -1057,29 +1022,26 @@ PluggableMap.prototype.handleTargetChanged_ = function() {
this.updateSize();
// updateSize calls setSize, so no need to call this.render
// ourselves here.
};
}
/**
* @private
*/
PluggableMap.prototype.handleTileChange_ = function() {
handleTileChange_() {
this.render();
};
}
/**
* @private
*/
PluggableMap.prototype.handleViewPropertyChanged_ = function() {
handleViewPropertyChanged_() {
this.render();
};
}
/**
* @private
*/
PluggableMap.prototype.handleViewChanged_ = function() {
handleViewChanged_() {
if (this.viewPropertyListenerKey_) {
unlistenByKey(this.viewPropertyListenerKey_);
this.viewPropertyListenerKey_ = null;
@@ -1099,13 +1061,12 @@ PluggableMap.prototype.handleViewChanged_ = function() {
this.handleViewPropertyChanged_, this);
}
this.render();
};
}
/**
* @private
*/
PluggableMap.prototype.handleLayerGroupChanged_ = function() {
handleLayerGroupChanged_() {
if (this.layerGroupPropertyListenerKeys_) {
this.layerGroupPropertyListenerKeys_.forEach(unlistenByKey);
this.layerGroupPropertyListenerKeys_ = null;
@@ -1122,39 +1083,35 @@ PluggableMap.prototype.handleLayerGroupChanged_ = function() {
];
}
this.render();
};
}
/**
* @return {boolean} Is rendered.
*/
PluggableMap.prototype.isRendered = function() {
isRendered() {
return !!this.frameState_;
};
}
/**
* Requests an immediate render in a synchronous manner.
* @api
*/
PluggableMap.prototype.renderSync = function() {
renderSync() {
if (this.animationDelayKey_) {
cancelAnimationFrame(this.animationDelayKey_);
}
this.animationDelay_();
};
}
/**
* Request a map rendering (at the next animation frame).
* @api
*/
PluggableMap.prototype.render = function() {
render() {
if (this.animationDelayKey_ === undefined) {
this.animationDelayKey_ = requestAnimationFrame(this.animationDelay_);
}
};
}
/**
* Remove the given control from the map.
@@ -1163,10 +1120,9 @@ PluggableMap.prototype.render = function() {
* if the control was not found).
* @api
*/
PluggableMap.prototype.removeControl = function(control) {
removeControl(control) {
return this.getControls().remove(control);
};
}
/**
* Remove the given interaction from the map.
@@ -1175,10 +1131,9 @@ PluggableMap.prototype.removeControl = function(control) {
* undefined if the interaction was not found).
* @api
*/
PluggableMap.prototype.removeInteraction = function(interaction) {
removeInteraction(interaction) {
return this.getInteractions().remove(interaction);
};
}
/**
* Removes the given layer from the map.
@@ -1187,11 +1142,10 @@ PluggableMap.prototype.removeInteraction = function(interaction) {
* layer was not found).
* @api
*/
PluggableMap.prototype.removeLayer = function(layer) {
removeLayer(layer) {
const layers = this.getLayerGroup().getLayers();
return layers.remove(layer);
};
}
/**
* Remove the given overlay from the map.
@@ -1200,16 +1154,15 @@ PluggableMap.prototype.removeLayer = function(layer) {
* if the overlay was not found).
* @api
*/
PluggableMap.prototype.removeOverlay = function(overlay) {
removeOverlay(overlay) {
return this.getOverlays().remove(overlay);
};
}
/**
* @param {number} time Time.
* @private
*/
PluggableMap.prototype.renderFrame_ = function(time) {
renderFrame_(time) {
let viewState;
const size = this.getSize();
@@ -1295,8 +1248,7 @@ PluggableMap.prototype.renderFrame_ = function(time) {
setTimeout(this.handlePostRender.bind(this), 0);
};
}
/**
* Sets the layergroup of this map.
@@ -1304,10 +1256,9 @@ PluggableMap.prototype.renderFrame_ = function(time) {
* @observable
* @api
*/
PluggableMap.prototype.setLayerGroup = function(layerGroup) {
setLayerGroup(layerGroup) {
this.set(MapProperty.LAYERGROUP, layerGroup);
};
}
/**
* Set the size of this map.
@@ -1315,10 +1266,9 @@ PluggableMap.prototype.setLayerGroup = function(layerGroup) {
* @observable
* @api
*/
PluggableMap.prototype.setSize = function(size) {
setSize(size) {
this.set(MapProperty.SIZE, size);
};
}
/**
* Set the target element to render this map into.
@@ -1327,10 +1277,9 @@ PluggableMap.prototype.setSize = function(size) {
* @observable
* @api
*/
PluggableMap.prototype.setTarget = function(target) {
setTarget(target) {
this.set(MapProperty.TARGET, target);
};
}
/**
* Set the view for this map.
@@ -1338,27 +1287,25 @@ PluggableMap.prototype.setTarget = function(target) {
* @observable
* @api
*/
PluggableMap.prototype.setView = function(view) {
setView(view) {
this.set(MapProperty.VIEW, view);
};
}
/**
* @param {module:ol/Feature} feature Feature.
*/
PluggableMap.prototype.skipFeature = function(feature) {
skipFeature(feature) {
const featureUid = getUid(feature).toString();
this.skippedFeatureUids_[featureUid] = true;
this.render();
};
}
/**
* Force a recalculation of the map viewport size. This should be called when
* third-party code changes the size of the map viewport.
* @api
*/
PluggableMap.prototype.updateSize = function() {
updateSize() {
const targetElement = this.getTargetElement();
if (!targetElement) {
@@ -1378,17 +1325,19 @@ PluggableMap.prototype.updateSize = function() {
parseFloat(computedStyle['borderBottomWidth'])
]);
}
};
}
/**
* @param {module:ol/Feature} feature Feature.
*/
PluggableMap.prototype.unskipFeature = function(feature) {
unskipFeature(feature) {
const featureUid = getUid(feature).toString();
delete this.skippedFeatureUids_[featureUid];
this.render();
};
}
}
inherits(PluggableMap, BaseObject);
/**
src/ol/control/Attribution.js
+34 -38
View File
@@ -47,7 +47,8 @@ import {visibleAtResolution} from '../layer/Layer.js';
* @param {module:ol/control/Attribution~Options=} opt_options Attribution options.
* @api
*/
const Attribution = function(opt_options) {
class Attribution {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -141,10 +142,7 @@ const Attribution = function(opt_options) {
*/
this.renderedVisible_ = true;
};
inherits(Attribution, Control);
}
/**
* Get a list of visible attributions.
@@ -152,7 +150,7 @@ inherits(Attribution, Control);
* @return {Array.<string>} Attributions.
* @private
*/
Attribution.prototype.getSourceAttributions_ = function(frameState) {
getSourceAttributions_(frameState) {
/**
* Used to determine if an attribution already exists.
* @type {!Object.<string, boolean>}
@@ -203,25 +201,13 @@ Attribution.prototype.getSourceAttributions_ = function(frameState) {
}
}
return visibleAttributions;
};
/**
* Update the attribution element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/Attribution}
* @api
*/
export function render(mapEvent) {
this.updateElement_(mapEvent.frameState);
}
/**
* @private
* @param {?module:ol/PluggableMap~FrameState} frameState Frame state.
*/
Attribution.prototype.updateElement_ = function(frameState) {
updateElement_(frameState) {
if (!frameState) {
if (this.renderedVisible_) {
this.element.style.display = 'none';
@@ -252,23 +238,21 @@ Attribution.prototype.updateElement_ = function(frameState) {
}
this.renderedAttributions_ = attributions;
};
}
/**
* @param {MouseEvent} event The event to handle
* @private
*/
Attribution.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
this.handleToggle_();
};
}
/**
* @private
*/
Attribution.prototype.handleToggle_ = function() {
handleToggle_() {
this.element.classList.toggle(CLASS_COLLAPSED);
if (this.collapsed_) {
replaceNode(this.collapseLabel_, this.label_);
@@ -276,25 +260,23 @@ Attribution.prototype.handleToggle_ = function() {
replaceNode(this.label_, this.collapseLabel_);
}
this.collapsed_ = !this.collapsed_;
};
}
/**
* Return `true` if the attribution is collapsible, `false` otherwise.
* @return {boolean} True if the widget is collapsible.
* @api
*/
Attribution.prototype.getCollapsible = function() {
getCollapsible() {
return this.collapsible_;
};
}
/**
* Set whether the attribution should be collapsible.
* @param {boolean} collapsible True if the widget is collapsible.
* @api
*/
Attribution.prototype.setCollapsible = function(collapsible) {
setCollapsible(collapsible) {
if (this.collapsible_ === collapsible) {
return;
}
@@ -303,8 +285,7 @@ Attribution.prototype.setCollapsible = function(collapsible) {
if (!collapsible && this.collapsed_) {
this.handleToggle_();
}
};
}
/**
* Collapse or expand the attribution according to the passed parameter. Will
@@ -313,13 +294,12 @@ Attribution.prototype.setCollapsible = function(collapsible) {
* @param {boolean} collapsed True if the widget is collapsed.
* @api
*/
Attribution.prototype.setCollapsed = function(collapsed) {
setCollapsed(collapsed) {
if (!this.collapsible_ || this.collapsed_ === collapsed) {
return;
}
this.handleToggle_();
};
}
/**
* Return `true` when the attribution is currently collapsed or `false`
@@ -327,7 +307,23 @@ Attribution.prototype.setCollapsed = function(collapsed) {
* @return {boolean} True if the widget is collapsed.
* @api
*/
Attribution.prototype.getCollapsed = function() {
getCollapsed() {
return this.collapsed_;
};
}
}
inherits(Attribution, Control);
/**
* Update the attribution element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/Attribution}
* @api
*/
export function render(mapEvent) {
this.updateElement_(mapEvent.frameState);
}
export default Attribution;
src/ol/control/Control.js
+16 -16
View File
@@ -49,7 +49,8 @@ import {listen, unlistenByKey} from '../events.js';
* @param {module:ol/control/Control~Options} options Control options.
* @api
*/
const Control = function(options) {
class Control {
constructor(options) {
BaseObject.call(this);
@@ -86,29 +87,24 @@ const Control = function(options) {
this.setTarget(options.target);
}
};
inherits(Control, BaseObject);
}
/**
* @inheritDoc
*/
Control.prototype.disposeInternal = function() {
disposeInternal() {
removeNode(this.element);
BaseObject.prototype.disposeInternal.call(this);
};
}
/**
* Get the map associated with this control.
* @return {module:ol/PluggableMap} Map.
* @api
*/
Control.prototype.getMap = function() {
getMap() {
return this.map_;
};
}
/**
* Remove the control from its current map and attach it to the new map.
@@ -117,7 +113,7 @@ Control.prototype.getMap = function() {
* @param {module:ol/PluggableMap} map Map.
* @api
*/
Control.prototype.setMap = function(map) {
setMap(map) {
if (this.map_) {
removeNode(this.element);
}
@@ -136,8 +132,7 @@ Control.prototype.setMap = function(map) {
}
map.render();
}
};
}
/**
* This function is used to set a target element for the control. It has no
@@ -148,9 +143,14 @@ Control.prototype.setMap = function(map) {
* @param {Element|string} target Target.
* @api
*/
Control.prototype.setTarget = function(target) {
setTarget(target) {
this.target_ = typeof target === 'string' ?
document.getElementById(target) :
target;
};
}
}
inherits(Control, BaseObject);
export default Control;
src/ol/control/FullScreen.js
+15 -16
View File
@@ -67,7 +67,8 @@ const getChangeType = (function() {
* @param {module:ol/control/FullScreen~Options=} opt_options Options.
* @api
*/
const FullScreen = function(opt_options) {
class FullScreen {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -130,25 +131,21 @@ const FullScreen = function(opt_options) {
*/
this.source_ = options.source;
};
inherits(FullScreen, Control);
}
/**
* @param {MouseEvent} event The event to handle
* @private
*/
FullScreen.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
this.handleFullScreen_();
};
}
/**
* @private
*/
FullScreen.prototype.handleFullScreen_ = function() {
handleFullScreen_() {
if (!isFullScreenSupported()) {
return;
}
@@ -174,13 +171,12 @@ FullScreen.prototype.handleFullScreen_ = function() {
requestFullScreen(element);
}
}
};
}
/**
* @private
*/
FullScreen.prototype.handleFullScreenChange_ = function() {
handleFullScreenChange_() {
const button = this.element.firstElementChild;
const map = this.getMap();
if (isFullScreen()) {
@@ -193,14 +189,13 @@ FullScreen.prototype.handleFullScreenChange_ = function() {
if (map) {
map.updateSize();
}
};
}
/**
* @inheritDoc
* @api
*/
FullScreen.prototype.setMap = function(map) {
setMap(map) {
Control.prototype.setMap.call(this, map);
if (map) {
this.listenerKeys.push(listen(document,
@@ -208,7 +203,11 @@ FullScreen.prototype.setMap = function(map) {
this.handleFullScreenChange_, this)
);
}
};
}
}
inherits(FullScreen, Control);
/**
* @return {boolean} Fullscreen is supported by the current platform.
src/ol/control/MousePosition.js
+43 -50
View File
@@ -52,7 +52,8 @@ const COORDINATE_FORMAT = 'coordinateFormat';
* options.
* @api
*/
const MousePosition = function(opt_options) {
class MousePosition {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -112,38 +113,14 @@ const MousePosition = function(opt_options) {
*/
this.lastMouseMovePixel_ = null;
};
inherits(MousePosition, Control);
/**
* Update the mouseposition element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/MousePosition}
* @api
*/
export function render(mapEvent) {
const frameState = mapEvent.frameState;
if (!frameState) {
this.mapProjection_ = null;
} else {
if (this.mapProjection_ != frameState.viewState.projection) {
this.mapProjection_ = frameState.viewState.projection;
this.transform_ = null;
}
}
this.updateHTML_(this.lastMouseMovePixel_);
}
/**
* @private
*/
MousePosition.prototype.handleProjectionChanged_ = function() {
handleProjectionChanged_() {
this.transform_ = null;
};
}
/**
* Return the coordinate format type used to render the current position or
@@ -153,12 +130,11 @@ MousePosition.prototype.handleProjectionChanged_ = function() {
* @observable
* @api
*/
MousePosition.prototype.getCoordinateFormat = function() {
getCoordinateFormat() {
return (
/** @type {module:ol/coordinate~CoordinateFormat|undefined} */ (this.get(COORDINATE_FORMAT))
);
};
}
/**
* Return the projection that is used to report the mouse position.
@@ -167,39 +143,36 @@ MousePosition.prototype.getCoordinateFormat = function() {
* @observable
* @api
*/
MousePosition.prototype.getProjection = function() {
getProjection() {
return (
/** @type {module:ol/proj/Projection|undefined} */ (this.get(PROJECTION))
);
};
}
/**
* @param {Event} event Browser event.
* @protected
*/
MousePosition.prototype.handleMouseMove = function(event) {
handleMouseMove(event) {
const map = this.getMap();
this.lastMouseMovePixel_ = map.getEventPixel(event);
this.updateHTML_(this.lastMouseMovePixel_);
};
}
/**
* @param {Event} event Browser event.
* @protected
*/
MousePosition.prototype.handleMouseOut = function(event) {
handleMouseOut(event) {
this.updateHTML_(null);
this.lastMouseMovePixel_ = null;
};
}
/**
* @inheritDoc
* @api
*/
MousePosition.prototype.setMap = function(map) {
setMap(map) {
Control.prototype.setMap.call(this, map);
if (map) {
const viewport = map.getViewport();
@@ -212,8 +185,7 @@ MousePosition.prototype.setMap = function(map) {
);
}
}
};
}
/**
* Set the coordinate format type used to render the current position.
@@ -222,10 +194,9 @@ MousePosition.prototype.setMap = function(map) {
* @observable
* @api
*/
MousePosition.prototype.setCoordinateFormat = function(format) {
setCoordinateFormat(format) {
this.set(COORDINATE_FORMAT, format);
};
}
/**
* Set the projection that is used to report the mouse position.
@@ -234,16 +205,15 @@ MousePosition.prototype.setCoordinateFormat = function(format) {
* @observable
* @api
*/
MousePosition.prototype.setProjection = function(projection) {
setProjection(projection) {
this.set(PROJECTION, getProjection(projection));
};
}
/**
* @param {?module:ol~Pixel} pixel Pixel.
* @private
*/
MousePosition.prototype.updateHTML_ = function(pixel) {
updateHTML_(pixel) {
let html = this.undefinedHTML_;
if (pixel && this.mapProjection_) {
if (!this.transform_) {
@@ -271,7 +241,30 @@ MousePosition.prototype.updateHTML_ = function(pixel) {
this.element.innerHTML = html;
this.renderedHTML_ = html;
}
};
}
}
inherits(MousePosition, Control);
/**
* Update the mouseposition element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/MousePosition}
* @api
*/
export function render(mapEvent) {
const frameState = mapEvent.frameState;
if (!frameState) {
this.mapProjection_ = null;
} else {
if (this.mapProjection_ != frameState.viewState.projection) {
this.mapProjection_ = frameState.viewState.projection;
this.transform_ = null;
}
}
this.updateHTML_(this.lastMouseMovePixel_);
}
export default MousePosition;
src/ol/control/OverviewMap.js
+53 -67
View File
@@ -66,7 +66,8 @@ const MIN_RATIO = 0.1;
* @param {module:ol/control/OverviewMap~Options=} opt_options OverviewMap options.
* @api
*/
const OverviewMap = function(opt_options) {
class OverviewMap {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -222,16 +223,13 @@ const OverviewMap = function(opt_options) {
window.addEventListener('mousemove', move);
window.addEventListener('mouseup', endMoving);
});
};
inherits(OverviewMap, Control);
}
/**
* @inheritDoc
* @api
*/
OverviewMap.prototype.setMap = function(map) {
setMap(map) {
const oldMap = this.getMap();
if (map === oldMap) {
return;
@@ -265,15 +263,14 @@ OverviewMap.prototype.setMap = function(map) {
}
}
}
};
}
/**
* Handle map property changes. This only deals with changes to the map's view.
* @param {module:ol/Object~ObjectEvent} event The propertychange event.
* @private
*/
OverviewMap.prototype.handleMapPropertyChange_ = function(event) {
handleMapPropertyChange_(event) {
if (event.key === MapProperty.VIEW) {
const oldView = /** @type {module:ol/View} */ (event.oldValue);
if (oldView) {
@@ -282,32 +279,29 @@ OverviewMap.prototype.handleMapPropertyChange_ = function(event) {
const newView = this.getMap().getView();
this.bindView_(newView);
}
};
}
/**
* Register listeners for view property changes.
* @param {module:ol/View} view The view.
* @private
*/
OverviewMap.prototype.bindView_ = function(view) {
bindView_(view) {
listen(view,
getChangeEventType(ViewProperty.ROTATION),
this.handleRotationChanged_, this);
};
}
/**
* Unregister listeners for view property changes.
* @param {module:ol/View} view The view.
* @private
*/
OverviewMap.prototype.unbindView_ = function(view) {
unbindView_(view) {
unlisten(view,
getChangeEventType(ViewProperty.ROTATION),
this.handleRotationChanged_, this);
};
}
/**
* Handle rotation changes to the main map.
@@ -315,23 +309,10 @@ OverviewMap.prototype.unbindView_ = function(view) {
* overview map's view.
* @private
*/
OverviewMap.prototype.handleRotationChanged_ = function() {
handleRotationChanged_() {
this.ovmap_.getView().setRotation(this.getMap().getView().getRotation());
};
/**
* Update the overview map element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/OverviewMap}
* @api
*/
export function render(mapEvent) {
this.validateExtent_();
this.updateBox_();
}
/**
* Reset the overview map extent if the box size (width or
* height) is less than the size of the overview map size times minRatio
@@ -343,7 +324,7 @@ export function render(mapEvent) {
* main map center location.
* @private
*/
OverviewMap.prototype.validateExtent_ = function() {
validateExtent_() {
const map = this.getMap();
const ovmap = this.ovmap_;
@@ -380,15 +361,14 @@ OverviewMap.prototype.validateExtent_ = function() {
} else if (!containsExtent(ovextent, extent)) {
this.recenter_();
}
};
}
/**
* Reset the overview map extent to half calculated min and max ratio times
* the extent of the main map.
* @private
*/
OverviewMap.prototype.resetExtent_ = function() {
resetExtent_() {
if (MAX_RATIO === 0 || MIN_RATIO === 0) {
return;
}
@@ -411,15 +391,14 @@ OverviewMap.prototype.resetExtent_ = function() {
const ratio = 1 / (Math.pow(2, steps / 2) * MIN_RATIO);
scaleFromCenter(extent, ratio);
ovview.fit(extent);
};
}
/**
* Set the center of the overview map to the map center without changing its
* resolution.
* @private
*/
OverviewMap.prototype.recenter_ = function() {
recenter_() {
const map = this.getMap();
const ovmap = this.ovmap_;
@@ -428,14 +407,13 @@ OverviewMap.prototype.recenter_ = function() {
const ovview = ovmap.getView();
ovview.setCenter(view.getCenter());
};
}
/**
* Update the box using the main map extent
* @private
*/
OverviewMap.prototype.updateBox_ = function() {
updateBox_() {
const map = this.getMap();
const ovmap = this.ovmap_;
@@ -467,8 +445,7 @@ OverviewMap.prototype.updateBox_ = function() {
box.style.width = Math.abs((bottomLeft[0] - topRight[0]) / ovresolution) + 'px';
box.style.height = Math.abs((topRight[1] - bottomLeft[1]) / ovresolution) + 'px';
}
};
}
/**
* @param {number} rotation Target rotation.
@@ -476,8 +453,7 @@ OverviewMap.prototype.updateBox_ = function() {
* @return {module:ol/coordinate~Coordinate|undefined} Coordinate for rotation and center anchor.
* @private
*/
OverviewMap.prototype.calculateCoordinateRotate_ = function(
rotation, coordinate) {
calculateCoordinateRotate_(rotation, coordinate) {
let coordinateRotate;
const map = this.getMap();
@@ -494,23 +470,21 @@ OverviewMap.prototype.calculateCoordinateRotate_ = function(
addCoordinate(coordinateRotate, currentCenter);
}
return coordinateRotate;
};
}
/**
* @param {MouseEvent} event The event to handle
* @private
*/
OverviewMap.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
this.handleToggle_();
};
}
/**
* @private
*/
OverviewMap.prototype.handleToggle_ = function() {
handleToggle_() {
this.element.classList.toggle(CLASS_COLLAPSED);
if (this.collapsed_) {
replaceNode(this.collapseLabel_, this.label_);
@@ -531,25 +505,23 @@ OverviewMap.prototype.handleToggle_ = function() {
},
this);
}
};
}
/**
* Return `true` if the overview map is collapsible, `false` otherwise.
* @return {boolean} True if the widget is collapsible.
* @api
*/
OverviewMap.prototype.getCollapsible = function() {
getCollapsible() {
return this.collapsible_;
};
}
/**
* Set whether the overview map should be collapsible.
* @param {boolean} collapsible True if the widget is collapsible.
* @api
*/
OverviewMap.prototype.setCollapsible = function(collapsible) {
setCollapsible(collapsible) {
if (this.collapsible_ === collapsible) {
return;
}
@@ -558,8 +530,7 @@ OverviewMap.prototype.setCollapsible = function(collapsible) {
if (!collapsible && this.collapsed_) {
this.handleToggle_();
}
};
}
/**
* Collapse or expand the overview map according to the passed parameter. Will
@@ -568,30 +539,45 @@ OverviewMap.prototype.setCollapsible = function(collapsible) {
* @param {boolean} collapsed True if the widget is collapsed.
* @api
*/
OverviewMap.prototype.setCollapsed = function(collapsed) {
setCollapsed(collapsed) {
if (!this.collapsible_ || this.collapsed_ === collapsed) {
return;
}
this.handleToggle_();
};
}
/**
* Determine if the overview map is collapsed.
* @return {boolean} The overview map is collapsed.
* @api
*/
OverviewMap.prototype.getCollapsed = function() {
getCollapsed() {
return this.collapsed_;
};
}
/**
* Return the overview map.
* @return {module:ol/PluggableMap} Overview map.
* @api
*/
OverviewMap.prototype.getOverviewMap = function() {
getOverviewMap() {
return this.ovmap_;
};
}
}
inherits(OverviewMap, Control);
/**
* Update the overview map element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/OverviewMap}
* @api
*/
export function render(mapEvent) {
this.validateExtent_();
this.updateBox_();
}
export default OverviewMap;
src/ol/control/Rotate.js
+10 -10
View File
@@ -38,7 +38,8 @@ import {inherits} from '../util.js';
* @param {module:ol/control/Rotate~Options=} opt_options Rotate options.
* @api
*/
const Rotate = function(opt_options) {
class Rotate {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -107,29 +108,25 @@ const Rotate = function(opt_options) {
this.element.classList.add(CLASS_HIDDEN);
}
};
inherits(Rotate, Control);
}
/**
* @param {MouseEvent} event The event to handle
* @private
*/
Rotate.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
if (this.callResetNorth_ !== undefined) {
this.callResetNorth_();
} else {
this.resetNorth_();
}
};
}
/**
* @private
*/
Rotate.prototype.resetNorth_ = function() {
resetNorth_() {
const map = this.getMap();
const view = map.getView();
if (!view) {
@@ -148,7 +145,10 @@ Rotate.prototype.resetNorth_ = function() {
view.setRotation(0);
}
}
};
}
}
inherits(Rotate, Control);
/**
src/ol/control/ScaleLine.js
+31 -32
View File
@@ -64,7 +64,8 @@ const LEADING_DIGITS = [1, 2, 5];
* @param {module:ol/control/ScaleLine~Options=} opt_options Scale line options.
* @api
*/
const ScaleLine = function(opt_options) {
class ScaleLine {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -128,10 +129,7 @@ const ScaleLine = function(opt_options) {
this.setUnits(/** @type {module:ol/control/ScaleLine~Units} */ (options.units) ||
Units.METRIC);
};
inherits(ScaleLine, Control);
}
/**
* Return the units to use in the scale line.
@@ -140,37 +138,18 @@ inherits(ScaleLine, Control);
* @observable
* @api
*/
ScaleLine.prototype.getUnits = function() {
getUnits() {
return (
/** @type {module:ol/control/ScaleLine~Units|undefined} */ (this.get(UNITS_PROP))
);
};
/**
* Update the scale line element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/ScaleLine}
* @api
*/
export function render(mapEvent) {
const frameState = mapEvent.frameState;
if (!frameState) {
this.viewState_ = null;
} else {
this.viewState_ = frameState.viewState;
}
this.updateElement_();
}
/**
* @private
*/
ScaleLine.prototype.handleUnitsChanged_ = function() {
handleUnitsChanged_() {
this.updateElement_();
};
}
/**
* Set the units to use in the scale line.
@@ -178,15 +157,14 @@ ScaleLine.prototype.handleUnitsChanged_ = function() {
* @observable
* @api
*/
ScaleLine.prototype.setUnits = function(units) {
setUnits(units) {
this.set(UNITS_PROP, units);
};
}
/**
* @private
*/
ScaleLine.prototype.updateElement_ = function() {
updateElement_() {
const viewState = this.viewState_;
if (!viewState) {
@@ -303,6 +281,27 @@ ScaleLine.prototype.updateElement_ = function() {
this.renderedVisible_ = true;
}
};
}
}
inherits(ScaleLine, Control);
/**
* Update the scale line element.
* @param {module:ol/MapEvent} mapEvent Map event.
* @this {module:ol/control/ScaleLine}
* @api
*/
export function render(mapEvent) {
const frameState = mapEvent.frameState;
if (!frameState) {
this.viewState_ = null;
} else {
this.viewState_ = frameState.viewState;
}
this.updateElement_();
}
export default ScaleLine;
src/ol/control/Zoom.js
+12 -10
View File
@@ -36,7 +36,8 @@ import {easeOut} from '../easing.js';
* @param {module:ol/control/Zoom~Options=} opt_options Zoom options.
* @api
*/
const Zoom = function(opt_options) {
class Zoom {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -91,27 +92,23 @@ const Zoom = function(opt_options) {
*/
this.duration_ = options.duration !== undefined ? options.duration : 250;
};
inherits(Zoom, Control);
}
/**
* @param {number} delta Zoom delta.
* @param {MouseEvent} event The event to handle
* @private
*/
Zoom.prototype.handleClick_ = function(delta, event) {
handleClick_(delta, event) {
event.preventDefault();
this.zoomByDelta_(delta);
};
}
/**
* @param {number} delta Zoom delta.
* @private
*/
Zoom.prototype.zoomByDelta_ = function(delta) {
zoomByDelta_(delta) {
const map = this.getMap();
const view = map.getView();
if (!view) {
@@ -135,5 +132,10 @@ Zoom.prototype.zoomByDelta_ = function(delta) {
view.setResolution(newResolution);
}
}
};
}
}
inherits(Zoom, Control);
export default Zoom;
src/ol/control/ZoomSlider.js
+152 -160
View File
@@ -47,7 +47,8 @@ const Direction = {
* @param {module:ol/control/ZoomSlider~Options=} opt_options Zoom slider options.
* @api
*/
const ZoomSlider = function(opt_options) {
class ZoomSlider {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -146,30 +147,25 @@ const ZoomSlider = function(opt_options) {
element: containerElement,
render: options.render || render
});
};
inherits(ZoomSlider, Control);
}
/**
* @inheritDoc
*/
ZoomSlider.prototype.disposeInternal = function() {
disposeInternal() {
this.dragger_.dispose();
Control.prototype.disposeInternal.call(this);
};
}
/**
* @inheritDoc
*/
ZoomSlider.prototype.setMap = function(map) {
setMap(map) {
Control.prototype.setMap.call(this, map);
if (map) {
map.render();
}
};
}
/**
* Initializes the slider element. This will determine and set this controls
@@ -178,7 +174,7 @@ ZoomSlider.prototype.setMap = function(map) {
*
* @private
*/
ZoomSlider.prototype.initSlider_ = function() {
initSlider_() {
const container = this.element;
const containerSize = {
width: container.offsetWidth, height: container.offsetHeight
@@ -202,7 +198,150 @@ ZoomSlider.prototype.initSlider_ = function() {
this.heightLimit_ = containerSize.height - thumbHeight;
}
this.sliderInitialized_ = true;
};
}
/**
* @param {MouseEvent} event The browser event to handle.
* @private
*/
handleContainerClick_(event) {
const view = this.getMap().getView();
const relativePosition = this.getRelativePosition_(
event.offsetX - this.thumbSize_[0] / 2,
event.offsetY - this.thumbSize_[1] / 2);
const resolution = this.getResolutionForPosition_(relativePosition);
view.animate({
resolution: view.constrainResolution(resolution),
duration: this.duration_,
easing: easeOut
});
}
/**
* Handle dragger start events.
* @param {module:ol/pointer/PointerEvent} event The drag event.
* @private
*/
handleDraggerStart_(event) {
if (!this.dragging_ && event.originalEvent.target === this.element.firstElementChild) {
this.getMap().getView().setHint(ViewHint.INTERACTING, 1);
this.previousX_ = event.clientX;
this.previousY_ = event.clientY;
this.dragging_ = true;
}
}
/**
* Handle dragger drag events.
*
* @param {module:ol/pointer/PointerEvent|Event} event The drag event.
* @private
*/
handleDraggerDrag_(event) {
if (this.dragging_) {
const element = this.element.firstElementChild;
const deltaX = event.clientX - this.previousX_ + parseInt(element.style.left, 10);
const deltaY = event.clientY - this.previousY_ + parseInt(element.style.top, 10);
const relativePosition = this.getRelativePosition_(deltaX, deltaY);
this.currentResolution_ = this.getResolutionForPosition_(relativePosition);
this.getMap().getView().setResolution(this.currentResolution_);
this.setThumbPosition_(this.currentResolution_);
this.previousX_ = event.clientX;
this.previousY_ = event.clientY;
}
}
/**
* Handle dragger end events.
* @param {module:ol/pointer/PointerEvent|Event} event The drag event.
* @private
*/
handleDraggerEnd_(event) {
if (this.dragging_) {
const view = this.getMap().getView();
view.setHint(ViewHint.INTERACTING, -1);
view.animate({
resolution: view.constrainResolution(this.currentResolution_),
duration: this.duration_,
easing: easeOut
});
this.dragging_ = false;
this.previousX_ = undefined;
this.previousY_ = undefined;
}
}
/**
* Positions the thumb inside its container according to the given resolution.
*
* @param {number} res The res.
* @private
*/
setThumbPosition_(res) {
const position = this.getPositionForResolution_(res);
const thumb = this.element.firstElementChild;
if (this.direction_ == Direction.HORIZONTAL) {
thumb.style.left = this.widthLimit_ * position + 'px';
} else {
thumb.style.top = this.heightLimit_ * position + 'px';
}
}
/**
* Calculates the relative position of the thumb given x and y offsets. The
* relative position scales from 0 to 1. The x and y offsets are assumed to be
* in pixel units within the dragger limits.
*
* @param {number} x Pixel position relative to the left of the slider.
* @param {number} y Pixel position relative to the top of the slider.
* @return {number} The relative position of the thumb.
* @private
*/
getRelativePosition_(x, y) {
let amount;
if (this.direction_ === Direction.HORIZONTAL) {
amount = x / this.widthLimit_;
} else {
amount = y / this.heightLimit_;
}
return clamp(amount, 0, 1);
}
/**
* Calculates the corresponding resolution of the thumb given its relative
* position (where 0 is the minimum and 1 is the maximum).
*
* @param {number} position The relative position of the thumb.
* @return {number} The corresponding resolution.
* @private
*/
getResolutionForPosition_(position) {
const fn = this.getMap().getView().getResolutionForValueFunction();
return fn(1 - position);
}
/**
* Determines the relative position of the slider for the given resolution. A
* relative position of 0 corresponds to the minimum view resolution. A
* relative position of 1 corresponds to the maximum view resolution.
*
* @param {number} res The resolution.
* @return {number} The relative position value (between 0 and 1).
* @private
*/
getPositionForResolution_(res) {
const fn = this.getMap().getView().getValueForResolutionFunction();
return 1 - fn(res);
}
}
inherits(ZoomSlider, Control);
/**
@@ -226,151 +365,4 @@ export function render(mapEvent) {
}
/**
* @param {MouseEvent} event The browser event to handle.
* @private
*/
ZoomSlider.prototype.handleContainerClick_ = function(event) {
const view = this.getMap().getView();
const relativePosition = this.getRelativePosition_(
event.offsetX - this.thumbSize_[0] / 2,
event.offsetY - this.thumbSize_[1] / 2);
const resolution = this.getResolutionForPosition_(relativePosition);
view.animate({
resolution: view.constrainResolution(resolution),
duration: this.duration_,
easing: easeOut
});
};
/**
* Handle dragger start events.
* @param {module:ol/pointer/PointerEvent} event The drag event.
* @private
*/
ZoomSlider.prototype.handleDraggerStart_ = function(event) {
if (!this.dragging_ && event.originalEvent.target === this.element.firstElementChild) {
this.getMap().getView().setHint(ViewHint.INTERACTING, 1);
this.previousX_ = event.clientX;
this.previousY_ = event.clientY;
this.dragging_ = true;
}
};
/**
* Handle dragger drag events.
*
* @param {module:ol/pointer/PointerEvent|Event} event The drag event.
* @private
*/
ZoomSlider.prototype.handleDraggerDrag_ = function(event) {
if (this.dragging_) {
const element = this.element.firstElementChild;
const deltaX = event.clientX - this.previousX_ + parseInt(element.style.left, 10);
const deltaY = event.clientY - this.previousY_ + parseInt(element.style.top, 10);
const relativePosition = this.getRelativePosition_(deltaX, deltaY);
this.currentResolution_ = this.getResolutionForPosition_(relativePosition);
this.getMap().getView().setResolution(this.currentResolution_);
this.setThumbPosition_(this.currentResolution_);
this.previousX_ = event.clientX;
this.previousY_ = event.clientY;
}
};
/**
* Handle dragger end events.
* @param {module:ol/pointer/PointerEvent|Event} event The drag event.
* @private
*/
ZoomSlider.prototype.handleDraggerEnd_ = function(event) {
if (this.dragging_) {
const view = this.getMap().getView();
view.setHint(ViewHint.INTERACTING, -1);
view.animate({
resolution: view.constrainResolution(this.currentResolution_),
duration: this.duration_,
easing: easeOut
});
this.dragging_ = false;
this.previousX_ = undefined;
this.previousY_ = undefined;
}
};
/**
* Positions the thumb inside its container according to the given resolution.
*
* @param {number} res The res.
* @private
*/
ZoomSlider.prototype.setThumbPosition_ = function(res) {
const position = this.getPositionForResolution_(res);
const thumb = this.element.firstElementChild;
if (this.direction_ == Direction.HORIZONTAL) {
thumb.style.left = this.widthLimit_ * position + 'px';
} else {
thumb.style.top = this.heightLimit_ * position + 'px';
}
};
/**
* Calculates the relative position of the thumb given x and y offsets. The
* relative position scales from 0 to 1. The x and y offsets are assumed to be
* in pixel units within the dragger limits.
*
* @param {number} x Pixel position relative to the left of the slider.
* @param {number} y Pixel position relative to the top of the slider.
* @return {number} The relative position of the thumb.
* @private
*/
ZoomSlider.prototype.getRelativePosition_ = function(x, y) {
let amount;
if (this.direction_ === Direction.HORIZONTAL) {
amount = x / this.widthLimit_;
} else {
amount = y / this.heightLimit_;
}
return clamp(amount, 0, 1);
};
/**
* Calculates the corresponding resolution of the thumb given its relative
* position (where 0 is the minimum and 1 is the maximum).
*
* @param {number} position The relative position of the thumb.
* @return {number} The corresponding resolution.
* @private
*/
ZoomSlider.prototype.getResolutionForPosition_ = function(position) {
const fn = this.getMap().getView().getResolutionForValueFunction();
return fn(1 - position);
};
/**
* Determines the relative position of the slider for the given resolution. A
* relative position of 0 corresponds to the minimum view resolution. A
* relative position of 1 corresponds to the maximum view resolution.
*
* @param {number} res The resolution.
* @return {number} The relative position value (between 0 and 1).
* @private
*/
ZoomSlider.prototype.getPositionForResolution_ = function(res) {
const fn = this.getMap().getView().getValueForResolutionFunction();
return 1 - fn(res);
};
export default ZoomSlider;
src/ol/control/ZoomToExtent.js
+12 -10
View File
@@ -31,7 +31,8 @@ import {CLASS_CONTROL, CLASS_UNSELECTABLE} from '../css.js';
* @param {module:ol/control/ZoomToExtent~Options=} opt_options Options.
* @api
*/
const ZoomToExtent = function(opt_options) {
class ZoomToExtent {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
/**
@@ -62,28 +63,29 @@ const ZoomToExtent = function(opt_options) {
element: element,
target: options.target
});
};
inherits(ZoomToExtent, Control);
}
/**
* @param {MouseEvent} event The event to handle
* @private
*/
ZoomToExtent.prototype.handleClick_ = function(event) {
handleClick_(event) {
event.preventDefault();
this.handleZoomToExtent();
};
}
/**
* @protected
*/
ZoomToExtent.prototype.handleZoomToExtent = function() {
handleZoomToExtent() {
const map = this.getMap();
const view = map.getView();
const extent = !this.extent ? view.getProjection().getExtent() : this.extent;
view.fit(extent);
};
}
}
inherits(ZoomToExtent, Control);
export default ZoomToExtent;
src/ol/events/EventTarget.js
+20 -22
View File
@@ -31,7 +31,8 @@ import Event from '../events/Event.js';
* @constructor
* @extends {module:ol/Disposable}
*/
const EventTarget = function() {
class EventTarget {
constructor() {
Disposable.call(this);
@@ -53,16 +54,13 @@ const EventTarget = function() {
*/
this.listeners_ = {};
};
inherits(EventTarget, Disposable);
}
/**
* @param {string} type Type.
* @param {module:ol/events~ListenerFunction} listener Listener.
*/
EventTarget.prototype.addEventListener = function(type, listener) {
addEventListener(type, listener) {
let listeners = this.listeners_[type];
if (!listeners) {
listeners = this.listeners_[type] = [];
@@ -70,8 +68,7 @@ EventTarget.prototype.addEventListener = function(type, listener) {
if (listeners.indexOf(listener) === -1) {
listeners.push(listener);
}
};
}
/**
* @param {{type: string,
@@ -80,7 +77,7 @@ EventTarget.prototype.addEventListener = function(type, listener) {
* @return {boolean|undefined} `false` if anyone called preventDefault on the
* event object or if any of the listeners returned false.
*/
EventTarget.prototype.dispatchEvent = function(event) {
dispatchEvent(event) {
const evt = typeof event === 'string' ? new Event(event) : event;
const type = evt.type;
evt.target = this;
@@ -109,16 +106,14 @@ EventTarget.prototype.dispatchEvent = function(event) {
}
return propagate;
}
};
}
/**
* @inheritDoc
*/
EventTarget.prototype.disposeInternal = function() {
disposeInternal() {
unlistenAll(this);
};
}
/**
* Get the listeners for a specified event type. Listeners are returned in the
@@ -127,28 +122,26 @@ EventTarget.prototype.disposeInternal = function() {
* @param {string} type Type.
* @return {Array.<module:ol/events~ListenerFunction>} Listeners.
*/
EventTarget.prototype.getListeners = function(type) {
getListeners(type) {
return this.listeners_[type];
};
}
/**
* @param {string=} opt_type Type. If not provided,
* `true` will be returned if this EventTarget has any listeners.
* @return {boolean} Has listeners.
*/
EventTarget.prototype.hasListener = function(opt_type) {
hasListener(opt_type) {
return opt_type ?
opt_type in this.listeners_ :
Object.keys(this.listeners_).length > 0;
};
}
/**
* @param {string} type Type.
* @param {module:ol/events~ListenerFunction} listener Listener.
*/
EventTarget.prototype.removeEventListener = function(type, listener) {
removeEventListener(type, listener) {
const listeners = this.listeners_[type];
if (listeners) {
const index = listeners.indexOf(listener);
@@ -163,5 +156,10 @@ EventTarget.prototype.removeEventListener = function(type, listener) {
}
}
}
};
}
}
inherits(EventTarget, Disposable);
export default EventTarget;
src/ol/format/EsriJSON.js
+130 -134
View File
@@ -63,7 +63,8 @@ GEOMETRY_WRITERS[GeometryType.MULTI_POLYGON] = writeMultiPolygonGeometry;
* @param {module:ol/format/EsriJSON~Options=} opt_options Options.
* @api
*/
const EsriJSON = function(opt_options) {
class EsriJSON {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -76,7 +77,134 @@ const EsriJSON = function(opt_options) {
*/
this.geometryName_ = options.geometryName;
};
}
/**
* @inheritDoc
*/
readFeatureFromObject(object, opt_options) {
const esriJSONFeature = /** @type {EsriJSONFeature} */ (object);
const geometry = readGeometry(esriJSONFeature.geometry, opt_options);
const feature = new Feature();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
}
feature.setGeometry(geometry);
if (opt_options && opt_options.idField &&
esriJSONFeature.attributes[opt_options.idField]) {
feature.setId(/** @type {number} */(esriJSONFeature.attributes[opt_options.idField]));
}
if (esriJSONFeature.attributes) {
feature.setProperties(esriJSONFeature.attributes);
}
return feature;
}
/**
* @inheritDoc
*/
readFeaturesFromObject(object, opt_options) {
const esriJSONObject = /** @type {EsriJSONObject} */ (object);
const options = opt_options ? opt_options : {};
if (esriJSONObject.features) {
const esriJSONFeatureCollection = /** @type {EsriJSONFeatureCollection} */ (object);
/** @type {Array.<module:ol/Feature>} */
const features = [];
const esriJSONFeatures = esriJSONFeatureCollection.features;
options.idField = object.objectIdFieldName;
for (let i = 0, ii = esriJSONFeatures.length; i < ii; ++i) {
features.push(this.readFeatureFromObject(esriJSONFeatures[i], options));
}
return features;
} else {
return [this.readFeatureFromObject(object, options)];
}
}
/**
* @inheritDoc
*/
readGeometryFromObject(object, opt_options) {
return readGeometry(/** @type {EsriJSONGeometry} */(object), opt_options);
}
/**
* @inheritDoc
*/
readProjectionFromObject(object) {
const esriJSONObject = /** @type {EsriJSONObject} */ (object);
if (esriJSONObject.spatialReference && esriJSONObject.spatialReference.wkid) {
const crs = esriJSONObject.spatialReference.wkid;
return getProjection('EPSG:' + crs);
} else {
return null;
}
}
/**
* Encode a geometry as a EsriJSON object.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} Object.
* @override
* @api
*/
writeGeometryObject(geometry, opt_options) {
return writeGeometry(geometry, this.adaptOptions(opt_options));
}
/**
* Encode a feature as a esriJSON Feature object.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
* @override
* @api
*/
writeFeatureObject(feature, opt_options) {
opt_options = this.adaptOptions(opt_options);
const object = {};
const geometry = feature.getGeometry();
if (geometry) {
object['geometry'] = writeGeometry(geometry, opt_options);
if (opt_options && opt_options.featureProjection) {
object['geometry']['spatialReference'] = /** @type {EsriJSONCRS} */({
wkid: getProjection(opt_options.featureProjection).getCode().split(':').pop()
});
}
}
const properties = feature.getProperties();
delete properties[feature.getGeometryName()];
if (!isEmpty(properties)) {
object['attributes'] = properties;
} else {
object['attributes'] = {};
}
return object;
}
/**
* Encode an array of features as a EsriJSON object.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} EsriJSON Object.
* @override
* @api
*/
writeFeaturesObject(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const objects = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
objects.push(this.writeFeatureObject(features[i], opt_options));
}
return /** @type {EsriJSONFeatureCollection} */ ({
'features': objects
});
}
}
inherits(EsriJSON, JSONFeature);
@@ -439,50 +567,6 @@ EsriJSON.prototype.readFeature;
EsriJSON.prototype.readFeatures;
/**
* @inheritDoc
*/
EsriJSON.prototype.readFeatureFromObject = function(object, opt_options) {
const esriJSONFeature = /** @type {EsriJSONFeature} */ (object);
const geometry = readGeometry(esriJSONFeature.geometry, opt_options);
const feature = new Feature();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
}
feature.setGeometry(geometry);
if (opt_options && opt_options.idField &&
esriJSONFeature.attributes[opt_options.idField]) {
feature.setId(/** @type {number} */(esriJSONFeature.attributes[opt_options.idField]));
}
if (esriJSONFeature.attributes) {
feature.setProperties(esriJSONFeature.attributes);
}
return feature;
};
/**
* @inheritDoc
*/
EsriJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
const esriJSONObject = /** @type {EsriJSONObject} */ (object);
const options = opt_options ? opt_options : {};
if (esriJSONObject.features) {
const esriJSONFeatureCollection = /** @type {EsriJSONFeatureCollection} */ (object);
/** @type {Array.<module:ol/Feature>} */
const features = [];
const esriJSONFeatures = esriJSONFeatureCollection.features;
options.idField = object.objectIdFieldName;
for (let i = 0, ii = esriJSONFeatures.length; i < ii; ++i) {
features.push(this.readFeatureFromObject(esriJSONFeatures[i], options));
}
return features;
} else {
return [this.readFeatureFromObject(object, options)];
}
};
/**
* Read a geometry from a EsriJSON source.
*
@@ -495,14 +579,6 @@ EsriJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
EsriJSON.prototype.readGeometry;
/**
* @inheritDoc
*/
EsriJSON.prototype.readGeometryFromObject = function(object, opt_options) {
return readGeometry(/** @type {EsriJSONGeometry} */(object), opt_options);
};
/**
* Read the projection from a EsriJSON source.
*
@@ -514,20 +590,6 @@ EsriJSON.prototype.readGeometryFromObject = function(object, opt_options) {
EsriJSON.prototype.readProjection;
/**
* @inheritDoc
*/
EsriJSON.prototype.readProjectionFromObject = function(object) {
const esriJSONObject = /** @type {EsriJSONObject} */ (object);
if (esriJSONObject.spatialReference && esriJSONObject.spatialReference.wkid) {
const crs = esriJSONObject.spatialReference.wkid;
return getProjection('EPSG:' + crs);
} else {
return null;
}
};
/**
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
@@ -552,20 +614,6 @@ function writeGeometry(geometry, opt_options) {
EsriJSON.prototype.writeGeometry;
/**
* Encode a geometry as a EsriJSON object.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {EsriJSONGeometry} Object.
* @override
* @api
*/
EsriJSON.prototype.writeGeometryObject = function(geometry, opt_options) {
return writeGeometry(geometry, this.adaptOptions(opt_options));
};
/**
* Encode a feature as a EsriJSON Feature string.
*
@@ -578,38 +626,6 @@ EsriJSON.prototype.writeGeometryObject = function(geometry, opt_options) {
EsriJSON.prototype.writeFeature;
/**
* Encode a feature as a esriJSON Feature object.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
* @override
* @api
*/
EsriJSON.prototype.writeFeatureObject = function(feature, opt_options) {
opt_options = this.adaptOptions(opt_options);
const object = {};
const geometry = feature.getGeometry();
if (geometry) {
object['geometry'] = writeGeometry(geometry, opt_options);
if (opt_options && opt_options.featureProjection) {
object['geometry']['spatialReference'] = /** @type {EsriJSONCRS} */({
wkid: getProjection(opt_options.featureProjection).getCode().split(':').pop()
});
}
}
const properties = feature.getProperties();
delete properties[feature.getGeometryName()];
if (!isEmpty(properties)) {
object['attributes'] = properties;
} else {
object['attributes'] = {};
}
return object;
};
/**
* Encode an array of features as EsriJSON.
*
@@ -622,24 +638,4 @@ EsriJSON.prototype.writeFeatureObject = function(feature, opt_options) {
EsriJSON.prototype.writeFeatures;
/**
* Encode an array of features as a EsriJSON object.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} EsriJSON Object.
* @override
* @api
*/
EsriJSON.prototype.writeFeaturesObject = function(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const objects = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
objects.push(this.writeFeatureObject(features[i], opt_options));
}
return /** @type {EsriJSONFeatureCollection} */ ({
'features': objects
});
};
export default EsriJSON;
src/ol/format/Feature.js
+18 -27
View File
@@ -60,7 +60,8 @@ import {get as getProjection, equivalent as equivalentProjection, transformExten
* @abstract
* @api
*/
const FeatureFormat = function() {
class FeatureFormat {
constructor() {
/**
* @protected
@@ -74,8 +75,7 @@ const FeatureFormat = function() {
*/
this.defaultFeatureProjection = null;
};
}
/**
* Adds the data projection to the read options.
@@ -84,7 +84,7 @@ const FeatureFormat = function() {
* @return {module:ol/format/Feature~ReadOptions|undefined} Options.
* @protected
*/
FeatureFormat.prototype.getReadOptions = function(source, opt_options) {
getReadOptions(source, opt_options) {
let options;
if (opt_options) {
options = {
@@ -94,8 +94,7 @@ FeatureFormat.prototype.getReadOptions = function(source, opt_options) {
};
}
return this.adaptOptions(options);
};
}
/**
* Sets the `dataProjection` on the options, if no `dataProjection`
@@ -106,29 +105,26 @@ FeatureFormat.prototype.getReadOptions = function(source, opt_options) {
* @return {module:ol/format/Feature~WriteOptions|module:ol/format/Feature~ReadOptions|undefined}
* Updated options.
*/
FeatureFormat.prototype.adaptOptions = function(options) {
adaptOptions(options) {
return assign({
dataProjection: this.dataProjection,
featureProjection: this.defaultFeatureProjection
}, options);
};
}
/**
* Get the extent from the source of the last {@link readFeatures} call.
* @return {module:ol/extent~Extent} Tile extent.
*/
FeatureFormat.prototype.getLastExtent = function() {
getLastExtent() {
return null;
};
}
/**
* @abstract
* @return {module:ol/format/FormatType} Format.
*/
FeatureFormat.prototype.getType = function() {};
getType() {}
/**
* Read a single feature from a source.
@@ -138,8 +134,7 @@ FeatureFormat.prototype.getType = function() {};
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
*/
FeatureFormat.prototype.readFeature = function(source, opt_options) {};
readFeature(source, opt_options) {}
/**
* Read all features from a source.
@@ -149,8 +144,7 @@ FeatureFormat.prototype.readFeature = function(source, opt_options) {};
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
*/
FeatureFormat.prototype.readFeatures = function(source, opt_options) {};
readFeatures(source, opt_options) {}
/**
* Read a single geometry from a source.
@@ -160,8 +154,7 @@ FeatureFormat.prototype.readFeatures = function(source, opt_options) {};
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/geom/Geometry} Geometry.
*/
FeatureFormat.prototype.readGeometry = function(source, opt_options) {};
readGeometry(source, opt_options) {}
/**
* Read the projection from a source.
@@ -170,8 +163,7 @@ FeatureFormat.prototype.readGeometry = function(source, opt_options) {};
* @param {Document|Node|Object|string} source Source.
* @return {module:ol/proj/Projection} Projection.
*/
FeatureFormat.prototype.readProjection = function(source) {};
readProjection(source) {}
/**
* Encode a feature in this format.
@@ -181,8 +173,7 @@ FeatureFormat.prototype.readProjection = function(source) {};
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
FeatureFormat.prototype.writeFeature = function(feature, opt_options) {};
writeFeature(feature, opt_options) {}
/**
* Encode an array of features in this format.
@@ -192,8 +183,7 @@ FeatureFormat.prototype.writeFeature = function(feature, opt_options) {};
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
FeatureFormat.prototype.writeFeatures = function(features, opt_options) {};
writeFeatures(features, opt_options) {}
/**
* Write a single geometry in this format.
@@ -203,7 +193,8 @@ FeatureFormat.prototype.writeFeatures = function(features, opt_options) {};
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {string} Result.
*/
FeatureFormat.prototype.writeGeometry = function(geometry, opt_options) {};
writeGeometry(geometry, opt_options) {}
}
export default FeatureFormat;
src/ol/format/GML2.js
+70 -94
View File
@@ -30,7 +30,8 @@ const schemaLocation = GMLNS + ' http://schemas.opengis.net/gml/2.1.2/feature.xs
* @extends {module:ol/format/GMLBase}
* @api
*/
const GML2 = function(opt_options) {
class GML2 {
constructor(opt_options) {
const options = /** @type {module:ol/format/GMLBase~Options} */
(opt_options ? opt_options : {});
@@ -46,10 +47,7 @@ const GML2 = function(opt_options) {
this.schemaLocation = options.schemaLocation ?
options.schemaLocation : schemaLocation;
};
inherits(GML2, GMLBase);
}
/**
* @param {Node} node Node.
@@ -57,7 +55,7 @@ inherits(GML2, GMLBase);
* @private
* @return {Array.<number>|undefined} Flat coordinates.
*/
GML2.prototype.readFlatCoordinates_ = function(node, objectStack) {
readFlatCoordinates_(node, objectStack) {
const s = getAllTextContent(node, false).replace(/^\s*|\s*$/g, '');
const context = /** @type {module:ol/xml~NodeStackItem} */ (objectStack[0]);
const containerSrs = context['srsName'];
@@ -82,8 +80,7 @@ GML2.prototype.readFlatCoordinates_ = function(node, objectStack) {
}
}
return flatCoordinates;
};
}
/**
* @param {Node} node Node.
@@ -91,22 +88,21 @@ GML2.prototype.readFlatCoordinates_ = function(node, objectStack) {
* @private
* @return {module:ol/extent~Extent|undefined} Envelope.
*/
GML2.prototype.readBox_ = function(node, objectStack) {
readBox_(node, objectStack) {
/** @type {Array.<number>} */
const flatCoordinates = pushParseAndPop([null],
this.BOX_PARSERS_, node, objectStack, this);
return createOrUpdate(flatCoordinates[1][0],
flatCoordinates[1][1], flatCoordinates[1][3],
flatCoordinates[1][4]);
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GML2.prototype.innerBoundaryIsParser_ = function(node, objectStack) {
innerBoundaryIsParser_(node, objectStack) {
/** @type {Array.<number>|undefined} */
const flatLinearRing = pushParseAndPop(undefined,
this.RING_PARSERS, node, objectStack, this);
@@ -115,15 +111,14 @@ GML2.prototype.innerBoundaryIsParser_ = function(node, objectStack) {
(objectStack[objectStack.length - 1]);
flatLinearRings.push(flatLinearRing);
}
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GML2.prototype.outerBoundaryIsParser_ = function(node, objectStack) {
outerBoundaryIsParser_(node, objectStack) {
/** @type {Array.<number>|undefined} */
const flatLinearRing = pushParseAndPop(undefined,
this.RING_PARSERS, node, objectStack, this);
@@ -132,8 +127,7 @@ GML2.prototype.outerBoundaryIsParser_ = function(node, objectStack) {
(objectStack[objectStack.length - 1]);
flatLinearRings[0] = flatLinearRing;
}
};
}
/**
* @const
@@ -143,7 +137,7 @@ GML2.prototype.outerBoundaryIsParser_ = function(node, objectStack) {
* @return {Node|undefined} Node.
* @private
*/
GML2.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
GEOMETRY_NODE_FACTORY_(value, objectStack, opt_nodeName) {
const context = objectStack[objectStack.length - 1];
const multiSurface = context['multiSurface'];
const surface = context['surface'];
@@ -163,15 +157,14 @@ GML2.prototype.GEOMETRY_NODE_FACTORY_ = function(value, objectStack, opt_nodeNam
}
return createElementNS('http://www.opengis.net/gml',
nodeName);
};
}
/**
* @param {Node} node Node.
* @param {module:ol/Feature} feature Feature.
* @param {Array.<*>} objectStack Node stack.
*/
GML2.prototype.writeFeatureElement = function(node, feature, objectStack) {
writeFeatureElement(node, feature, objectStack) {
const fid = feature.getId();
if (fid) {
node.setAttribute('fid', fid);
@@ -210,8 +203,7 @@ GML2.prototype.writeFeatureElement = function(node, feature, objectStack) {
makeSimpleNodeFactory(undefined, featureNS),
values,
objectStack, keys);
};
}
/**
* @param {Node} node Node.
@@ -219,7 +211,7 @@ GML2.prototype.writeFeatureElement = function(node, feature, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeCurveOrLineString_ = function(node, geometry, objectStack) {
writeCurveOrLineString_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const srsName = context['srsName'];
if (node.nodeName !== 'LineStringSegment' && srsName) {
@@ -236,8 +228,7 @@ GML2.prototype.writeCurveOrLineString_ = function(node, geometry, objectStack) {
this.writeCurveSegments_(segments,
geometry, objectStack);
}
};
}
/**
* @param {Node} node Node.
@@ -245,14 +236,13 @@ GML2.prototype.writeCurveOrLineString_ = function(node, geometry, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeLineStringOrCurveMember_ = function(node, line, objectStack) {
writeLineStringOrCurveMember_(node, line, objectStack) {
const child = this.GEOMETRY_NODE_FACTORY_(line, objectStack);
if (child) {
node.appendChild(child);
this.writeCurveOrLineString_(child, line, objectStack);
}
};
}
/**
* @param {Node} node Node.
@@ -260,7 +250,7 @@ GML2.prototype.writeLineStringOrCurveMember_ = function(node, line, objectStack)
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeMultiCurveOrLineString_ = function(node, geometry, objectStack) {
writeMultiCurveOrLineString_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -273,15 +263,14 @@ GML2.prototype.writeMultiCurveOrLineString_ = function(node, geometry, objectSta
this.LINESTRINGORCURVEMEMBER_SERIALIZERS_,
this.MULTIGEOMETRY_MEMBER_NODE_FACTORY_, lines,
objectStack, undefined, this);
};
}
/**
* @param {Node} node Node.
* @param {module:ol/geom/Geometry|module:ol/extent~Extent} geometry Geometry.
* @param {Array.<*>} objectStack Node stack.
*/
GML2.prototype.writeGeometryElement = function(node, geometry, objectStack) {
writeGeometryElement(node, geometry, objectStack) {
const context = /** @type {module:ol/format/Feature~WriteOptions} */ (objectStack[objectStack.length - 1]);
const item = assign({}, context);
item.node = node;
@@ -300,23 +289,21 @@ GML2.prototype.writeGeometryElement = function(node, geometry, objectStack) {
(item), this.GEOMETRY_SERIALIZERS_,
this.GEOMETRY_NODE_FACTORY_, [value],
objectStack, undefined, this);
};
}
/**
* @param {string} namespaceURI XML namespace.
* @returns {Node} coordinates node.
* @private
*/
GML2.prototype.createCoordinatesNode_ = function(namespaceURI) {
createCoordinatesNode_(namespaceURI) {
const coordinates = createElementNS(namespaceURI, 'coordinates');
coordinates.setAttribute('decimal', '.');
coordinates.setAttribute('cs', ',');
coordinates.setAttribute('ts', ' ');
return coordinates;
};
}
/**
* @param {Node} node Node.
@@ -324,7 +311,7 @@ GML2.prototype.createCoordinatesNode_ = function(namespaceURI) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeCoordinates_ = function(node, value, objectStack) {
writeCoordinates_(node, value, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -337,8 +324,7 @@ GML2.prototype.writeCoordinates_ = function(node, value, objectStack) {
parts[i] = this.getCoords_(point, srsName, hasZ);
}
writeStringTextNode(node, parts.join(' '));
};
}
/**
* @param {Node} node Node.
@@ -346,12 +332,11 @@ GML2.prototype.writeCoordinates_ = function(node, value, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeCurveSegments_ = function(node, line, objectStack) {
writeCurveSegments_(node, line, objectStack) {
const child = createElementNS(node.namespaceURI, 'LineStringSegment');
node.appendChild(child);
this.writeCurveOrLineString_(child, line, objectStack);
};
}
/**
* @param {Node} node Node.
@@ -359,7 +344,7 @@ GML2.prototype.writeCurveSegments_ = function(node, line, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeSurfaceOrPolygon_ = function(node, geometry, objectStack) {
writeSurfaceOrPolygon_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -379,8 +364,7 @@ GML2.prototype.writeSurfaceOrPolygon_ = function(node, geometry, objectStack) {
this.writeSurfacePatches_(
patches, geometry, objectStack);
}
};
}
/**
* @param {*} value Value.
@@ -389,7 +373,7 @@ GML2.prototype.writeSurfaceOrPolygon_ = function(node, geometry, objectStack) {
* @return {Node} Node.
* @private
*/
GML2.prototype.RING_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
RING_NODE_FACTORY_(value, objectStack, opt_nodeName) {
const context = objectStack[objectStack.length - 1];
const parentNode = context.node;
const exteriorWritten = context['exteriorWritten'];
@@ -398,8 +382,7 @@ GML2.prototype.RING_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
}
return createElementNS(parentNode.namespaceURI,
exteriorWritten !== undefined ? 'innerBoundaryIs' : 'outerBoundaryIs');
};
}
/**
* @param {Node} node Node.
@@ -407,12 +390,11 @@ GML2.prototype.RING_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeSurfacePatches_ = function(node, polygon, objectStack) {
writeSurfacePatches_(node, polygon, objectStack) {
const child = createElementNS(node.namespaceURI, 'PolygonPatch');
node.appendChild(child);
this.writeSurfaceOrPolygon_(child, polygon, objectStack);
};
}
/**
* @param {Node} node Node.
@@ -420,12 +402,11 @@ GML2.prototype.writeSurfacePatches_ = function(node, polygon, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeRing_ = function(node, ring, objectStack) {
writeRing_(node, ring, objectStack) {
const linearRing = createElementNS(node.namespaceURI, 'LinearRing');
node.appendChild(linearRing);
this.writeLinearRing_(linearRing, ring, objectStack);
};
}
/**
* @param {Array.<number>} point Point geometry.
@@ -434,7 +415,7 @@ GML2.prototype.writeRing_ = function(node, ring, objectStack) {
* @return {string} The coords string.
* @private
*/
GML2.prototype.getCoords_ = function(point, opt_srsName, opt_hasZ) {
getCoords_(point, opt_srsName, opt_hasZ) {
let axisOrientation = 'enu';
if (opt_srsName) {
axisOrientation = getProjection(opt_srsName).getAxisOrientation();
@@ -449,8 +430,7 @@ GML2.prototype.getCoords_ = function(point, opt_srsName, opt_hasZ) {
}
return coords;
};
}
/**
* @param {Node} node Node.
@@ -458,7 +438,7 @@ GML2.prototype.getCoords_ = function(point, opt_srsName, opt_hasZ) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writePoint_ = function(node, geometry, objectStack) {
writePoint_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -470,8 +450,7 @@ GML2.prototype.writePoint_ = function(node, geometry, objectStack) {
const point = geometry.getCoordinates();
const coord = this.getCoords_(point, srsName, hasZ);
writeStringTextNode(coordinates, coord);
};
}
/**
* @param {Node} node Node.
@@ -479,7 +458,7 @@ GML2.prototype.writePoint_ = function(node, geometry, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeMultiPoint_ = function(node, geometry, objectStack) {
writeMultiPoint_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -491,8 +470,7 @@ GML2.prototype.writeMultiPoint_ = function(node, geometry, objectStack) {
this.POINTMEMBER_SERIALIZERS_,
makeSimpleNodeFactory('pointMember'), points,
objectStack, undefined, this);
};
}
/**
* @param {Node} node Node.
@@ -500,12 +478,11 @@ GML2.prototype.writeMultiPoint_ = function(node, geometry, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writePointMember_ = function(node, point, objectStack) {
writePointMember_(node, point, objectStack) {
const child = createElementNS(node.namespaceURI, 'Point');
node.appendChild(child);
this.writePoint_(child, point, objectStack);
};
}
/**
* @param {Node} node Node.
@@ -513,7 +490,7 @@ GML2.prototype.writePointMember_ = function(node, point, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeLinearRing_ = function(node, geometry, objectStack) {
writeLinearRing_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const srsName = context['srsName'];
if (srsName) {
@@ -522,8 +499,7 @@ GML2.prototype.writeLinearRing_ = function(node, geometry, objectStack) {
const coordinates = this.createCoordinatesNode_(node.namespaceURI);
node.appendChild(coordinates);
this.writeCoordinates_(coordinates, geometry, objectStack);
};
}
/**
* @param {Node} node Node.
@@ -531,7 +507,7 @@ GML2.prototype.writeLinearRing_ = function(node, geometry, objectStack) {
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeMultiSurfaceOrPolygon_ = function(node, geometry, objectStack) {
writeMultiSurfaceOrPolygon_(node, geometry, objectStack) {
const context = objectStack[objectStack.length - 1];
const hasZ = context['hasZ'];
const srsName = context['srsName'];
@@ -544,8 +520,7 @@ GML2.prototype.writeMultiSurfaceOrPolygon_ = function(node, geometry, objectStac
this.SURFACEORPOLYGONMEMBER_SERIALIZERS_,
this.MULTIGEOMETRY_MEMBER_NODE_FACTORY_, polygons,
objectStack, undefined, this);
};
}
/**
* @param {Node} node Node.
@@ -553,15 +528,14 @@ GML2.prototype.writeMultiSurfaceOrPolygon_ = function(node, geometry, objectStac
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeSurfaceOrPolygonMember_ = function(node, polygon, objectStack) {
writeSurfaceOrPolygonMember_(node, polygon, objectStack) {
const child = this.GEOMETRY_NODE_FACTORY_(
polygon, objectStack);
if (child) {
node.appendChild(child);
this.writeSurfaceOrPolygon_(child, polygon, objectStack);
}
};
}
/**
* @param {Node} node Node.
@@ -569,7 +543,7 @@ GML2.prototype.writeSurfaceOrPolygonMember_ = function(node, polygon, objectStac
* @param {Array.<*>} objectStack Node stack.
* @private
*/
GML2.prototype.writeEnvelope = function(node, extent, objectStack) {
writeEnvelope(node, extent, objectStack) {
const context = objectStack[objectStack.length - 1];
const srsName = context['srsName'];
if (srsName) {
@@ -582,7 +556,24 @@ GML2.prototype.writeEnvelope = function(node, extent, objectStack) {
OBJECT_PROPERTY_NODE_FACTORY,
values,
objectStack, keys, this);
};
}
/**
* @const
* @param {*} value Value.
* @param {Array.<*>} objectStack Object stack.
* @param {string=} opt_nodeName Node name.
* @return {Node|undefined} Node.
* @private
*/
MULTIGEOMETRY_MEMBER_NODE_FACTORY_(value, objectStack, opt_nodeName) {
const parentNode = objectStack[objectStack.length - 1].node;
return createElementNS('http://www.opengis.net/gml',
MULTIGEOMETRY_TO_MEMBER_NODENAME[parentNode.nodeName]);
}
}
inherits(GML2, GMLBase);
/**
@@ -597,21 +588,6 @@ const MULTIGEOMETRY_TO_MEMBER_NODENAME = {
};
/**
* @const
* @param {*} value Value.
* @param {Array.<*>} objectStack Object stack.
* @param {string=} opt_nodeName Node name.
* @return {Node|undefined} Node.
* @private
*/
GML2.prototype.MULTIGEOMETRY_MEMBER_NODE_FACTORY_ = function(value, objectStack, opt_nodeName) {
const parentNode = objectStack[objectStack.length - 1].node;
return createElementNS('http://www.opengis.net/gml',
MULTIGEOMETRY_TO_MEMBER_NODENAME[parentNode.nodeName]);
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
src/ol/format/GML3.js
+574 -612
View File
File diff suppressed because it is too large Load Diff
src/ol/format/GMLBase.js
+80 -94
View File
@@ -75,7 +75,8 @@ export const GMLNS = 'http://www.opengis.net/gml';
* Optional configuration object.
* @extends {module:ol/format/XMLFeature}
*/
const GMLBase = function(opt_options) {
class GMLBase {
constructor(opt_options) {
const options = /** @type {module:ol/format/GMLBase~Options} */ (opt_options ? opt_options : {});
/**
@@ -112,31 +113,14 @@ const GMLBase = function(opt_options) {
};
XMLFeature.call(this);
};
inherits(GMLBase, XMLFeature);
/**
* A regular expression that matches if a string only contains whitespace
* characters. It will e.g. match `''`, `' '`, `'\n'` etc. The non-breaking
* space (0xa0) is explicitly included as IE doesn't include it in its
* definition of `\s`.
*
* Information from `goog.string.isEmptyOrWhitespace`: https://github.com/google/closure-library/blob/e877b1e/closure/goog/string/string.js#L156-L160
*
* @const
* @type {RegExp}
*/
const ONLY_WHITESPACE_RE = /^[\s\xa0]*$/;
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {Array.<module:ol/Feature> | undefined} Features.
*/
GMLBase.prototype.readFeaturesInternal = function(node, objectStack) {
readFeaturesInternal(node, objectStack) {
const localName = node.localName;
let features = null;
if (localName == 'FeatureCollection') {
@@ -217,15 +201,14 @@ GMLBase.prototype.readFeaturesInternal = function(node, objectStack) {
features = [];
}
return features;
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Geometry|undefined} Geometry.
*/
GMLBase.prototype.readGeometryElement = function(node, objectStack) {
readGeometryElement(node, objectStack) {
const context = /** @type {Object} */ (objectStack[0]);
context['srsName'] = node.firstElementChild.getAttribute('srsName');
context['srsDimension'] = node.firstElementChild.getAttribute('srsDimension');
@@ -238,15 +221,14 @@ GMLBase.prototype.readGeometryElement = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/Feature} Feature.
*/
GMLBase.prototype.readFeatureElement = function(node, objectStack) {
readFeatureElement(node, objectStack) {
let n;
const fid = node.getAttribute('fid') || getAttributeNS(node, GMLNS, 'id');
const values = {};
@@ -280,28 +262,26 @@ GMLBase.prototype.readFeatureElement = function(node, objectStack) {
feature.setId(fid);
}
return feature;
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Point|undefined} Point.
*/
GMLBase.prototype.readPoint = function(node, objectStack) {
readPoint(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
if (flatCoordinates) {
return new Point(flatCoordinates, GeometryLayout.XYZ);
}
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiPoint|undefined} MultiPoint.
*/
GMLBase.prototype.readMultiPoint = function(node, objectStack) {
readMultiPoint(node, objectStack) {
/** @type {Array.<Array.<number>>} */
const coordinates = pushParseAndPop([],
this.MULTIPOINT_PARSERS_, node, objectStack, this);
@@ -310,74 +290,68 @@ GMLBase.prototype.readMultiPoint = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiLineString|undefined} MultiLineString.
*/
GMLBase.prototype.readMultiLineString = function(node, objectStack) {
readMultiLineString(node, objectStack) {
/** @type {Array.<module:ol/geom/LineString>} */
const lineStrings = pushParseAndPop([],
this.MULTILINESTRING_PARSERS_, node, objectStack, this);
if (lineStrings) {
return new MultiLineString(lineStrings);
}
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/MultiPolygon|undefined} MultiPolygon.
*/
GMLBase.prototype.readMultiPolygon = function(node, objectStack) {
readMultiPolygon(node, objectStack) {
/** @type {Array.<module:ol/geom/Polygon>} */
const polygons = pushParseAndPop([], this.MULTIPOLYGON_PARSERS_, node, objectStack, this);
if (polygons) {
return new MultiPolygon(polygons);
}
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GMLBase.prototype.pointMemberParser_ = function(node, objectStack) {
pointMemberParser_(node, objectStack) {
parseNode(this.POINTMEMBER_PARSERS_, node, objectStack, this);
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GMLBase.prototype.lineStringMemberParser_ = function(node, objectStack) {
lineStringMemberParser_(node, objectStack) {
parseNode(this.LINESTRINGMEMBER_PARSERS_, node, objectStack, this);
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
GMLBase.prototype.polygonMemberParser_ = function(node, objectStack) {
polygonMemberParser_(node, objectStack) {
parseNode(this.POLYGONMEMBER_PARSERS_, node, objectStack, this);
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/LineString|undefined} LineString.
*/
GMLBase.prototype.readLineString = function(node, objectStack) {
readLineString(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
if (flatCoordinates) {
const lineString = new LineString(flatCoordinates, GeometryLayout.XYZ);
@@ -385,8 +359,7 @@ GMLBase.prototype.readLineString = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
* @param {Node} node Node.
@@ -394,7 +367,7 @@ GMLBase.prototype.readLineString = function(node, objectStack) {
* @private
* @return {Array.<number>|undefined} LinearRing flat coordinates.
*/
GMLBase.prototype.readFlatLinearRing_ = function(node, objectStack) {
readFlatLinearRing_(node, objectStack) {
const ring = pushParseAndPop(null,
this.GEOMETRY_FLAT_COORDINATES_PARSERS_, node,
objectStack, this);
@@ -403,28 +376,26 @@ GMLBase.prototype.readFlatLinearRing_ = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/LinearRing|undefined} LinearRing.
*/
GMLBase.prototype.readLinearRing = function(node, objectStack) {
readLinearRing(node, objectStack) {
const flatCoordinates = this.readFlatCoordinatesFromNode_(node, objectStack);
if (flatCoordinates) {
return new LinearRing(flatCoordinates, GeometryLayout.XYZ);
}
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @return {module:ol/geom/Polygon|undefined} Polygon.
*/
GMLBase.prototype.readPolygon = function(node, objectStack) {
readPolygon(node, objectStack) {
/** @type {Array.<Array.<number>>} */
const flatLinearRings = pushParseAndPop([null],
this.FLAT_LINEAR_RINGS_PARSERS_, node, objectStack, this);
@@ -440,8 +411,7 @@ GMLBase.prototype.readPolygon = function(node, objectStack) {
} else {
return undefined;
}
};
}
/**
* @param {Node} node Node.
@@ -449,9 +419,57 @@ GMLBase.prototype.readPolygon = function(node, objectStack) {
* @private
* @return {Array.<number>} Flat coordinates.
*/
GMLBase.prototype.readFlatCoordinatesFromNode_ = function(node, objectStack) {
readFlatCoordinatesFromNode_(node, objectStack) {
return pushParseAndPop(null, this.GEOMETRY_FLAT_COORDINATES_PARSERS_, node, objectStack, this);
}
/**
* @inheritDoc
*/
readGeometryFromNode(node, opt_options) {
const geometry = this.readGeometryElement(node,
[this.getReadOptions(node, opt_options ? opt_options : {})]);
return geometry ? geometry : null;
}
/**
* @inheritDoc
*/
readFeaturesFromNode(node, opt_options) {
const options = {
featureType: this.featureType,
featureNS: this.featureNS
};
if (opt_options) {
assign(options, this.getReadOptions(node, opt_options));
}
const features = this.readFeaturesInternal(node, [options]);
return features || [];
}
/**
* @inheritDoc
*/
readProjectionFromNode(node) {
return getProjection(this.srsName ? this.srsName : node.firstElementChild.getAttribute('srsName'));
}
}
inherits(GMLBase, XMLFeature);
/**
* A regular expression that matches if a string only contains whitespace
* characters. It will e.g. match `''`, `' '`, `'\n'` etc. The non-breaking
* space (0xa0) is explicitly included as IE doesn't include it in its
* definition of `\s`.
*
* Information from `goog.string.isEmptyOrWhitespace`: https://github.com/google/closure-library/blob/e877b1e/closure/goog/string/string.js#L156-L160
*
* @const
* @type {RegExp}
*/
const ONLY_WHITESPACE_RE = /^[\s\xa0]*$/;
/**
@@ -541,16 +559,6 @@ GMLBase.prototype.RING_PARSERS = {
};
/**
* @inheritDoc
*/
GMLBase.prototype.readGeometryFromNode = function(node, opt_options) {
const geometry = this.readGeometryElement(node,
[this.getReadOptions(node, opt_options ? opt_options : {})]);
return geometry ? geometry : null;
};
/**
* Read all features from a GML FeatureCollection.
*
@@ -563,26 +571,4 @@ GMLBase.prototype.readGeometryFromNode = function(node, opt_options) {
GMLBase.prototype.readFeatures;
/**
* @inheritDoc
*/
GMLBase.prototype.readFeaturesFromNode = function(node, opt_options) {
const options = {
featureType: this.featureType,
featureNS: this.featureNS
};
if (opt_options) {
assign(options, this.getReadOptions(node, opt_options));
}
const features = this.readFeaturesInternal(node, [options]);
return features || [];
};
/**
* @inheritDoc
*/
GMLBase.prototype.readProjectionFromNode = function(node) {
return getProjection(this.srsName ? this.srsName : node.firstElementChild.getAttribute('srsName'));
};
export default GMLBase;
src/ol/format/GPX.js
+88 -88
View File
@@ -43,7 +43,8 @@ import {createElementNS, makeArrayPusher, makeArraySerializer, makeChildAppender
* @param {module:ol/format/GPX~Options=} opt_options Options.
* @api
*/
const GPX = function(opt_options) {
class GPX {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -59,7 +60,92 @@ const GPX = function(opt_options) {
* @private
*/
this.readExtensions_ = options.readExtensions;
};
}
/**
* @param {Array.<module:ol/Feature>} features List of features.
* @private
*/
handleReadExtensions_(features) {
if (!features) {
features = [];
}
for (let i = 0, ii = features.length; i < ii; ++i) {
const feature = features[i];
if (this.readExtensions_) {
const extensionsNode = feature.get('extensionsNode_') || null;
this.readExtensions_(feature, extensionsNode);
}
feature.set('extensionsNode_', undefined);
}
}
/**
* @inheritDoc
*/
readFeatureFromNode(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return null;
}
const featureReader = FEATURE_READER[node.localName];
if (!featureReader) {
return null;
}
const feature = featureReader(node, [this.getReadOptions(node, opt_options)]);
if (!feature) {
return null;
}
this.handleReadExtensions_([feature]);
return feature;
}
/**
* @inheritDoc
*/
readFeaturesFromNode(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return [];
}
if (node.localName == 'gpx') {
/** @type {Array.<module:ol/Feature>} */
const features = pushParseAndPop([], GPX_PARSERS,
node, [this.getReadOptions(node, opt_options)]);
if (features) {
this.handleReadExtensions_(features);
return features;
} else {
return [];
}
}
return [];
}
/**
* Encode an array of features in the GPX format as an XML node.
* LineString geometries are output as routes (`<rte>`), and MultiLineString
* as tracks (`<trk>`).
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
writeFeaturesNode(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
//FIXME Serialize metadata
const gpx = createElementNS('http://www.topografix.com/GPX/1/1', 'gpx');
const xmlnsUri = 'http://www.w3.org/2000/xmlns/';
gpx.setAttributeNS(xmlnsUri, 'xmlns:xsi', XML_SCHEMA_INSTANCE_URI);
gpx.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', SCHEMA_LOCATION);
gpx.setAttribute('version', '1.1');
gpx.setAttribute('creator', 'OpenLayers');
pushSerializeAndPop(/** @type {module:ol/xml~NodeStackItem} */
({node: gpx}), GPX_SERIALIZERS, GPX_NODE_FACTORY, features, [opt_options]);
return gpx;
}
}
inherits(GPX, XMLFeature);
@@ -614,25 +700,6 @@ function readWpt(node, objectStack) {
}
/**
* @param {Array.<module:ol/Feature>} features List of features.
* @private
*/
GPX.prototype.handleReadExtensions_ = function(features) {
if (!features) {
features = [];
}
for (let i = 0, ii = features.length; i < ii; ++i) {
const feature = features[i];
if (this.readExtensions_) {
const extensionsNode = feature.get('extensionsNode_') || null;
this.readExtensions_(feature, extensionsNode);
}
feature.set('extensionsNode_', undefined);
}
};
/**
* Read the first feature from a GPX source.
* Routes (`<rte>`) are converted into LineString geometries, and tracks (`<trk>`)
@@ -647,26 +714,6 @@ GPX.prototype.handleReadExtensions_ = function(features) {
GPX.prototype.readFeature;
/**
* @inheritDoc
*/
GPX.prototype.readFeatureFromNode = function(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return null;
}
const featureReader = FEATURE_READER[node.localName];
if (!featureReader) {
return null;
}
const feature = featureReader(node, [this.getReadOptions(node, opt_options)]);
if (!feature) {
return null;
}
this.handleReadExtensions_([feature]);
return feature;
};
/**
* Read all features from a GPX source.
* Routes (`<rte>`) are converted into LineString geometries, and tracks (`<trk>`)
@@ -681,28 +728,6 @@ GPX.prototype.readFeatureFromNode = function(node, opt_options) {
GPX.prototype.readFeatures;
/**
* @inheritDoc
*/
GPX.prototype.readFeaturesFromNode = function(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return [];
}
if (node.localName == 'gpx') {
/** @type {Array.<module:ol/Feature>} */
const features = pushParseAndPop([], GPX_PARSERS,
node, [this.getReadOptions(node, opt_options)]);
if (features) {
this.handleReadExtensions_(features);
return features;
} else {
return [];
}
}
return [];
};
/**
* Read the projection from a GPX source.
*
@@ -874,29 +899,4 @@ function writeWpt(node, feature, objectStack) {
GPX.prototype.writeFeatures;
/**
* Encode an array of features in the GPX format as an XML node.
* LineString geometries are output as routes (`<rte>`), and MultiLineString
* as tracks (`<trk>`).
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
GPX.prototype.writeFeaturesNode = function(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
//FIXME Serialize metadata
const gpx = createElementNS('http://www.topografix.com/GPX/1/1', 'gpx');
const xmlnsUri = 'http://www.w3.org/2000/xmlns/';
gpx.setAttributeNS(xmlnsUri, 'xmlns:xsi', XML_SCHEMA_INSTANCE_URI);
gpx.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', SCHEMA_LOCATION);
gpx.setAttribute('version', '1.1');
gpx.setAttribute('creator', 'OpenLayers');
pushSerializeAndPop(/** @type {module:ol/xml~NodeStackItem} */
({node: gpx}), GPX_SERIALIZERS, GPX_NODE_FACTORY, features, [opt_options]);
return gpx;
};
export default GPX;
src/ol/format/GeoJSON.js
+155 -158
View File
@@ -42,7 +42,8 @@ import {get as getProjection} from '../proj.js';
* @param {module:ol/format/GeoJSON~Options=} opt_options Options.
* @api
*/
const GeoJSON = function(opt_options) {
class GeoJSON {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -73,7 +74,159 @@ const GeoJSON = function(opt_options) {
*/
this.extractGeometryName_ = options.extractGeometryName;
};
}
/**
* @inheritDoc
*/
readFeatureFromObject(object, opt_options) {
/**
* @type {GeoJSONFeature}
*/
let geoJSONFeature = null;
if (object.type === 'Feature') {
geoJSONFeature = /** @type {GeoJSONFeature} */ (object);
} else {
geoJSONFeature = /** @type {GeoJSONFeature} */ ({
type: 'Feature',
geometry: /** @type {GeoJSONGeometry|GeoJSONGeometryCollection} */ (object)
});
}
const geometry = readGeometry(geoJSONFeature.geometry, opt_options);
const feature = new Feature();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
} else if (this.extractGeometryName_ && geoJSONFeature.geometry_name !== undefined) {
feature.setGeometryName(geoJSONFeature.geometry_name);
}
feature.setGeometry(geometry);
if (geoJSONFeature.id !== undefined) {
feature.setId(geoJSONFeature.id);
}
if (geoJSONFeature.properties) {
feature.setProperties(geoJSONFeature.properties);
}
return feature;
}
/**
* @inheritDoc
*/
readFeaturesFromObject(object, opt_options) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
/** @type {Array.<module:ol/Feature>} */
let features = null;
if (geoJSONObject.type === 'FeatureCollection') {
const geoJSONFeatureCollection = /** @type {GeoJSONFeatureCollection} */ (object);
features = [];
const geoJSONFeatures = geoJSONFeatureCollection.features;
for (let i = 0, ii = geoJSONFeatures.length; i < ii; ++i) {
features.push(this.readFeatureFromObject(geoJSONFeatures[i], opt_options));
}
} else {
features = [this.readFeatureFromObject(object, opt_options)];
}
return features;
}
/**
* @inheritDoc
*/
readGeometryFromObject(object, opt_options) {
return readGeometry(/** @type {GeoJSONGeometry} */ (object), opt_options);
}
/**
* @inheritDoc
*/
readProjectionFromObject(object) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
const crs = geoJSONObject.crs;
let projection;
if (crs) {
if (crs.type == 'name') {
projection = getProjection(crs.properties.name);
} else {
assert(false, 36); // Unknown SRS type
}
} else {
projection = this.dataProjection;
}
return (
/** @type {module:ol/proj/Projection} */ (projection)
);
}
/**
* Encode a feature as a GeoJSON Feature object.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeature} Object.
* @override
* @api
*/
writeFeatureObject(feature, opt_options) {
opt_options = this.adaptOptions(opt_options);
const object = /** @type {GeoJSONFeature} */ ({
'type': 'Feature'
});
const id = feature.getId();
if (id !== undefined) {
object.id = id;
}
const geometry = feature.getGeometry();
if (geometry) {
object.geometry = writeGeometry(geometry, opt_options);
} else {
object.geometry = null;
}
const properties = feature.getProperties();
delete properties[feature.getGeometryName()];
if (!isEmpty(properties)) {
object.properties = properties;
} else {
object.properties = null;
}
return object;
}
/**
* Encode an array of features as a GeoJSON object.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeatureCollection} GeoJSON Object.
* @override
* @api
*/
writeFeaturesObject(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const objects = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
objects.push(this.writeFeatureObject(features[i], opt_options));
}
return /** @type {GeoJSONFeatureCollection} */ ({
type: 'FeatureCollection',
features: objects
});
}
/**
* Encode a geometry as a GeoJSON object.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object.
* @override
* @api
*/
writeGeometryObject(geometry, opt_options) {
return writeGeometry(geometry, this.adaptOptions(opt_options));
}
}
inherits(GeoJSON, JSONFeature);
@@ -354,62 +507,6 @@ GeoJSON.prototype.readFeature;
GeoJSON.prototype.readFeatures;
/**
* @inheritDoc
*/
GeoJSON.prototype.readFeatureFromObject = function(object, opt_options) {
/**
* @type {GeoJSONFeature}
*/
let geoJSONFeature = null;
if (object.type === 'Feature') {
geoJSONFeature = /** @type {GeoJSONFeature} */ (object);
} else {
geoJSONFeature = /** @type {GeoJSONFeature} */ ({
type: 'Feature',
geometry: /** @type {GeoJSONGeometry|GeoJSONGeometryCollection} */ (object)
});
}
const geometry = readGeometry(geoJSONFeature.geometry, opt_options);
const feature = new Feature();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
} else if (this.extractGeometryName_ && geoJSONFeature.geometry_name !== undefined) {
feature.setGeometryName(geoJSONFeature.geometry_name);
}
feature.setGeometry(geometry);
if (geoJSONFeature.id !== undefined) {
feature.setId(geoJSONFeature.id);
}
if (geoJSONFeature.properties) {
feature.setProperties(geoJSONFeature.properties);
}
return feature;
};
/**
* @inheritDoc
*/
GeoJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
/** @type {Array.<module:ol/Feature>} */
let features = null;
if (geoJSONObject.type === 'FeatureCollection') {
const geoJSONFeatureCollection = /** @type {GeoJSONFeatureCollection} */ (object);
features = [];
const geoJSONFeatures = geoJSONFeatureCollection.features;
for (let i = 0, ii = geoJSONFeatures.length; i < ii; ++i) {
features.push(this.readFeatureFromObject(geoJSONFeatures[i], opt_options));
}
} else {
features = [this.readFeatureFromObject(object, opt_options)];
}
return features;
};
/**
* Read a geometry from a GeoJSON source.
*
@@ -422,14 +519,6 @@ GeoJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
GeoJSON.prototype.readGeometry;
/**
* @inheritDoc
*/
GeoJSON.prototype.readGeometryFromObject = function(object, opt_options) {
return readGeometry(/** @type {GeoJSONGeometry} */ (object), opt_options);
};
/**
* Read the projection from a GeoJSON source.
*
@@ -441,28 +530,6 @@ GeoJSON.prototype.readGeometryFromObject = function(object, opt_options) {
GeoJSON.prototype.readProjection;
/**
* @inheritDoc
*/
GeoJSON.prototype.readProjectionFromObject = function(object) {
const geoJSONObject = /** @type {GeoJSONObject} */ (object);
const crs = geoJSONObject.crs;
let projection;
if (crs) {
if (crs.type == 'name') {
projection = getProjection(crs.properties.name);
} else {
assert(false, 36); // Unknown SRS type
}
} else {
projection = this.dataProjection;
}
return (
/** @type {module:ol/proj/Projection} */ (projection)
);
};
/**
* Encode a feature as a GeoJSON Feature string.
*
@@ -476,42 +543,6 @@ GeoJSON.prototype.readProjectionFromObject = function(object) {
GeoJSON.prototype.writeFeature;
/**
* Encode a feature as a GeoJSON Feature object.
*
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeature} Object.
* @override
* @api
*/
GeoJSON.prototype.writeFeatureObject = function(feature, opt_options) {
opt_options = this.adaptOptions(opt_options);
const object = /** @type {GeoJSONFeature} */ ({
'type': 'Feature'
});
const id = feature.getId();
if (id !== undefined) {
object.id = id;
}
const geometry = feature.getGeometry();
if (geometry) {
object.geometry = writeGeometry(geometry, opt_options);
} else {
object.geometry = null;
}
const properties = feature.getProperties();
delete properties[feature.getGeometryName()];
if (!isEmpty(properties)) {
object.properties = properties;
} else {
object.properties = null;
}
return object;
};
/**
* Encode an array of features as GeoJSON.
*
@@ -524,28 +555,6 @@ GeoJSON.prototype.writeFeatureObject = function(feature, opt_options) {
GeoJSON.prototype.writeFeatures;
/**
* Encode an array of features as a GeoJSON object.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONFeatureCollection} GeoJSON Object.
* @override
* @api
*/
GeoJSON.prototype.writeFeaturesObject = function(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const objects = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
objects.push(this.writeFeatureObject(features[i], opt_options));
}
return /** @type {GeoJSONFeatureCollection} */ ({
type: 'FeatureCollection',
features: objects
});
};
/**
* Encode a geometry as a GeoJSON string.
*
@@ -558,16 +567,4 @@ GeoJSON.prototype.writeFeaturesObject = function(features, opt_options) {
GeoJSON.prototype.writeGeometry;
/**
* Encode a geometry as a GeoJSON object.
*
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {GeoJSONGeometry|GeoJSONGeometryCollection} Object.
* @override
* @api
*/
GeoJSON.prototype.writeGeometryObject = function(geometry, opt_options) {
return writeGeometry(geometry, this.adaptOptions(opt_options));
};
export default GeoJSON;
src/ol/format/IGC.js
+87 -89
View File
@@ -36,7 +36,8 @@ const IGCZ = {
* @param {module:ol/format/IGC~Options=} opt_options Options.
* @api
*/
const IGC = function(opt_options) {
class IGC {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -52,58 +53,12 @@ const IGC = function(opt_options) {
* @type {IGCZ}
*/
this.altitudeMode_ = options.altitudeMode ? options.altitudeMode : IGCZ.NONE;
};
inherits(IGC, TextFeature);
/**
* @const
* @type {RegExp}
*/
const B_RECORD_RE =
/^B(\d{2})(\d{2})(\d{2})(\d{2})(\d{5})([NS])(\d{3})(\d{5})([EW])([AV])(\d{5})(\d{5})/;
/**
* @const
* @type {RegExp}
*/
const H_RECORD_RE = /^H.([A-Z]{3}).*?:(.*)/;
/**
* @const
* @type {RegExp}
*/
const HFDTE_RECORD_RE = /^HFDTE(\d{2})(\d{2})(\d{2})/;
/**
* A regular expression matching the newline characters `\r\n`, `\r` and `\n`.
*
* @const
* @type {RegExp}
*/
const NEWLINE_RE = /\r\n|\r|\n/;
/**
* Read the feature from the IGC source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
IGC.prototype.readFeature;
}
/**
* @inheritDoc
*/
IGC.prototype.readFeatureFromText = function(text, opt_options) {
readFeatureFromText(text, opt_options) {
const altitudeMode = this.altitudeMode_;
const lines = text.split(NEWLINE_RE);
/** @type {Object.<string, string>} */
@@ -173,7 +128,89 @@ IGC.prototype.readFeatureFromText = function(text, opt_options) {
const feature = new Feature(transformWithOptions(lineString, false, opt_options));
feature.setProperties(properties);
return feature;
};
}
/**
* @inheritDoc
*/
readFeaturesFromText(text, opt_options) {
const feature = this.readFeatureFromText(text, opt_options);
if (feature) {
return [feature];
} else {
return [];
}
}
/**
* Not implemented.
* @inheritDoc
*/
writeFeatureText(feature, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeFeaturesText(features, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeGeometryText(geometry, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
readGeometryFromText(text, opt_options) {}
}
inherits(IGC, TextFeature);
/**
* @const
* @type {RegExp}
*/
const B_RECORD_RE =
/^B(\d{2})(\d{2})(\d{2})(\d{2})(\d{5})([NS])(\d{3})(\d{5})([EW])([AV])(\d{5})(\d{5})/;
/**
* @const
* @type {RegExp}
*/
const H_RECORD_RE = /^H.([A-Z]{3}).*?:(.*)/;
/**
* @const
* @type {RegExp}
*/
const HFDTE_RECORD_RE = /^HFDTE(\d{2})(\d{2})(\d{2})/;
/**
* A regular expression matching the newline characters `\r\n`, `\r` and `\n`.
*
* @const
* @type {RegExp}
*/
const NEWLINE_RE = /\r\n|\r|\n/;
/**
* Read the feature from the IGC source.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature} Feature.
* @api
*/
IGC.prototype.readFeature;
/**
@@ -189,19 +226,6 @@ IGC.prototype.readFeatureFromText = function(text, opt_options) {
IGC.prototype.readFeatures;
/**
* @inheritDoc
*/
IGC.prototype.readFeaturesFromText = function(text, opt_options) {
const feature = this.readFeatureFromText(text, opt_options);
if (feature) {
return [feature];
} else {
return [];
}
};
/**
* Read the projection from the IGC source.
*
@@ -213,30 +237,4 @@ IGC.prototype.readFeaturesFromText = function(text, opt_options) {
IGC.prototype.readProjection;
/**
* Not implemented.
* @inheritDoc
*/
IGC.prototype.writeFeatureText = function(feature, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
IGC.prototype.writeFeaturesText = function(features, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
IGC.prototype.writeGeometryText = function(geometry, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
IGC.prototype.readGeometryFromText = function(text, opt_options) {};
export default IGC;
src/ol/format/JSONFeature.js
+122 -133
View File
@@ -15,9 +15,129 @@ import FormatType from '../format/FormatType.js';
* @abstract
* @extends {module:ol/format/Feature}
*/
const JSONFeature = function() {
class JSONFeature {
constructor() {
FeatureFormat.call(this);
};
}
/**
* @inheritDoc
*/
getType() {
return FormatType.JSON;
}
/**
* @inheritDoc
*/
readFeature(source, opt_options) {
return this.readFeatureFromObject(
getObject(source), this.getReadOptions(source, opt_options));
}
/**
* @inheritDoc
*/
readFeatures(source, opt_options) {
return this.readFeaturesFromObject(
getObject(source), this.getReadOptions(source, opt_options));
}
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature} Feature.
*/
readFeatureFromObject(object, opt_options) {}
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
readFeaturesFromObject(object, opt_options) {}
/**
* @inheritDoc
*/
readGeometry(source, opt_options) {
return this.readGeometryFromObject(
getObject(source), this.getReadOptions(source, opt_options));
}
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
readGeometryFromObject(object, opt_options) {}
/**
* @inheritDoc
*/
readProjection(source) {
return this.readProjectionFromObject(getObject(source));
}
/**
* @abstract
* @param {Object} object Object.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
readProjectionFromObject(object) {}
/**
* @inheritDoc
*/
writeFeature(feature, opt_options) {
return JSON.stringify(this.writeFeatureObject(feature, opt_options));
}
/**
* @abstract
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
writeFeatureObject(feature, opt_options) {}
/**
* @inheritDoc
*/
writeFeatures(features, opt_options) {
return JSON.stringify(this.writeFeaturesObject(features, opt_options));
}
/**
* @abstract
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
writeFeaturesObject(features, opt_options) {}
/**
* @inheritDoc
*/
writeGeometry(geometry, opt_options) {
return JSON.stringify(this.writeGeometryObject(geometry, opt_options));
}
/**
* @abstract
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
writeGeometryObject(geometry, opt_options) {}
}
inherits(JSONFeature, FeatureFormat);
@@ -38,135 +158,4 @@ function getObject(source) {
}
/**
* @inheritDoc
*/
JSONFeature.prototype.getType = function() {
return FormatType.JSON;
};
/**
* @inheritDoc
*/
JSONFeature.prototype.readFeature = function(source, opt_options) {
return this.readFeatureFromObject(
getObject(source), this.getReadOptions(source, opt_options));
};
/**
* @inheritDoc
*/
JSONFeature.prototype.readFeatures = function(source, opt_options) {
return this.readFeaturesFromObject(
getObject(source), this.getReadOptions(source, opt_options));
};
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature} Feature.
*/
JSONFeature.prototype.readFeatureFromObject = function(object, opt_options) {};
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
JSONFeature.prototype.readFeaturesFromObject = function(object, opt_options) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.readGeometry = function(source, opt_options) {
return this.readGeometryFromObject(
getObject(source), this.getReadOptions(source, opt_options));
};
/**
* @abstract
* @param {Object} object Object.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
JSONFeature.prototype.readGeometryFromObject = function(object, opt_options) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.readProjection = function(source) {
return this.readProjectionFromObject(getObject(source));
};
/**
* @abstract
* @param {Object} object Object.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
JSONFeature.prototype.readProjectionFromObject = function(object) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.writeFeature = function(feature, opt_options) {
return JSON.stringify(this.writeFeatureObject(feature, opt_options));
};
/**
* @abstract
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
JSONFeature.prototype.writeFeatureObject = function(feature, opt_options) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.writeFeatures = function(features, opt_options) {
return JSON.stringify(this.writeFeaturesObject(features, opt_options));
};
/**
* @abstract
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
JSONFeature.prototype.writeFeaturesObject = function(features, opt_options) {};
/**
* @inheritDoc
*/
JSONFeature.prototype.writeGeometry = function(geometry, opt_options) {
return JSON.stringify(this.writeGeometryObject(geometry, opt_options));
};
/**
* @abstract
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @return {Object} Object.
*/
JSONFeature.prototype.writeGeometryObject = function(geometry, opt_options) {};
export default JSONFeature;
src/ol/format/KML.js
+402 -415
View File
@@ -259,7 +259,8 @@ function createStyleDefaults() {
* @param {module:ol/format/KML~Options=} opt_options Options.
* @api
*/
const KML = function(opt_options) {
class KML {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -308,7 +309,406 @@ const KML = function(opt_options) {
this.showPointNames_ = options.showPointNames !== undefined ?
options.showPointNames : true;
};
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {Array.<module:ol/Feature>|undefined} Features.
*/
readDocumentOrFolder_(node, objectStack) {
// FIXME use scope somehow
const parsersNS = makeStructureNS(
NAMESPACE_URIS, {
'Document': makeArrayExtender(this.readDocumentOrFolder_, this),
'Folder': makeArrayExtender(this.readDocumentOrFolder_, this),
'Placemark': makeArrayPusher(this.readPlacemark_, this),
'Style': this.readSharedStyle_.bind(this),
'StyleMap': this.readSharedStyleMap_.bind(this)
});
/** @type {Array.<module:ol/Feature>} */
const features = pushParseAndPop([], parsersNS, node, objectStack, this);
if (features) {
return features;
} else {
return undefined;
}
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {module:ol/Feature|undefined} Feature.
*/
readPlacemark_(node, objectStack) {
const object = pushParseAndPop({'geometry': null},
PLACEMARK_PARSERS, node, objectStack);
if (!object) {
return undefined;
}
const feature = new Feature();
const id = node.getAttribute('id');
if (id !== null) {
feature.setId(id);
}
const options = /** @type {module:ol/format/Feature~ReadOptions} */ (objectStack[0]);
const geometry = object['geometry'];
if (geometry) {
transformWithOptions(geometry, false, options);
}
feature.setGeometry(geometry);
delete object['geometry'];
if (this.extractStyles_) {
const style = object['Style'];
const styleUrl = object['styleUrl'];
const styleFunction = createFeatureStyleFunction(
style, styleUrl, this.defaultStyle_, this.sharedStyles_,
this.showPointNames_);
feature.setStyle(styleFunction);
}
delete object['Style'];
// we do not remove the styleUrl property from the object, so it
// gets stored on feature when setProperties is called
feature.setProperties(object);
return feature;
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
readSharedStyle_(node, objectStack) {
const id = node.getAttribute('id');
if (id !== null) {
const style = readStyle(node, objectStack);
if (style) {
let styleUri;
let baseURI = node.baseURI;
if (!baseURI || baseURI == 'about:blank') {
baseURI = window.location.href;
}
if (baseURI) {
const url = new URL('#' + id, baseURI);
styleUri = url.href;
} else {
styleUri = '#' + id;
}
this.sharedStyles_[styleUri] = style;
}
}
}
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
readSharedStyleMap_(node, objectStack) {
const id = node.getAttribute('id');
if (id === null) {
return;
}
const styleMapValue = readStyleMapValue(node, objectStack);
if (!styleMapValue) {
return;
}
let styleUri;
let baseURI = node.baseURI;
if (!baseURI || baseURI == 'about:blank') {
baseURI = window.location.href;
}
if (baseURI) {
const url = new URL('#' + id, baseURI);
styleUri = url.href;
} else {
styleUri = '#' + id;
}
this.sharedStyles_[styleUri] = styleMapValue;
}
/**
* @inheritDoc
*/
readFeatureFromNode(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return null;
}
const feature = this.readPlacemark_(
node, [this.getReadOptions(node, opt_options)]);
if (feature) {
return feature;
} else {
return null;
}
}
/**
* @inheritDoc
*/
readFeaturesFromNode(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return [];
}
let features;
const localName = node.localName;
if (localName == 'Document' || localName == 'Folder') {
features = this.readDocumentOrFolder_(
node, [this.getReadOptions(node, opt_options)]);
if (features) {
return features;
} else {
return [];
}
} else if (localName == 'Placemark') {
const feature = this.readPlacemark_(
node, [this.getReadOptions(node, opt_options)]);
if (feature) {
return [feature];
} else {
return [];
}
} else if (localName == 'kml') {
features = [];
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
const fs = this.readFeaturesFromNode(n, opt_options);
if (fs) {
extend(features, fs);
}
}
return features;
} else {
return [];
}
}
/**
* Read the name of the KML.
*
* @param {Document|Node|string} source Source.
* @return {string|undefined} Name.
* @api
*/
readName(source) {
if (isDocument(source)) {
return this.readNameFromDocument(/** @type {Document} */ (source));
} else if (isNode(source)) {
return this.readNameFromNode(/** @type {Node} */ (source));
} else if (typeof source === 'string') {
const doc = parse(source);
return this.readNameFromDocument(doc);
} else {
return undefined;
}
}
/**
* @param {Document} doc Document.
* @return {string|undefined} Name.
*/
readNameFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
const name = this.readNameFromNode(n);
if (name) {
return name;
}
}
}
return undefined;
}
/**
* @param {Node} node Node.
* @return {string|undefined} Name.
*/
readNameFromNode(node) {
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
n.localName == 'name') {
return readString(n);
}
}
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
const localName = n.localName;
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
(localName == 'Document' ||
localName == 'Folder' ||
localName == 'Placemark' ||
localName == 'kml')) {
const name = this.readNameFromNode(n);
if (name) {
return name;
}
}
}
return undefined;
}
/**
* Read the network links of the KML.
*
* @param {Document|Node|string} source Source.
* @return {Array.<Object>} Network links.
* @api
*/
readNetworkLinks(source) {
const networkLinks = [];
if (isDocument(source)) {
extend(networkLinks, this.readNetworkLinksFromDocument(
/** @type {Document} */ (source)));
} else if (isNode(source)) {
extend(networkLinks, this.readNetworkLinksFromNode(
/** @type {Node} */ (source)));
} else if (typeof source === 'string') {
const doc = parse(source);
extend(networkLinks, this.readNetworkLinksFromDocument(doc));
}
return networkLinks;
}
/**
* @param {Document} doc Document.
* @return {Array.<Object>} Network links.
*/
readNetworkLinksFromDocument(doc) {
const networkLinks = [];
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
extend(networkLinks, this.readNetworkLinksFromNode(n));
}
}
return networkLinks;
}
/**
* @param {Node} node Node.
* @return {Array.<Object>} Network links.
*/
readNetworkLinksFromNode(node) {
const networkLinks = [];
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
n.localName == 'NetworkLink') {
const obj = pushParseAndPop({}, NETWORK_LINK_PARSERS,
n, []);
networkLinks.push(obj);
}
}
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
const localName = n.localName;
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
(localName == 'Document' ||
localName == 'Folder' ||
localName == 'kml')) {
extend(networkLinks, this.readNetworkLinksFromNode(n));
}
}
return networkLinks;
}
/**
* Read the regions of the KML.
*
* @param {Document|Node|string} source Source.
* @return {Array.<Object>} Regions.
* @api
*/
readRegion(source) {
const regions = [];
if (isDocument(source)) {
extend(regions, this.readRegionFromDocument(
/** @type {Document} */ (source)));
} else if (isNode(source)) {
extend(regions, this.readRegionFromNode(
/** @type {Node} */ (source)));
} else if (typeof source === 'string') {
const doc = parse(source);
extend(regions, this.readRegionFromDocument(doc));
}
return regions;
}
/**
* @param {Document} doc Document.
* @return {Array.<Object>} Region.
*/
readRegionFromDocument(doc) {
const regions = [];
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
extend(regions, this.readRegionFromNode(n));
}
}
return regions;
}
/**
* @param {Node} node Node.
* @return {Array.<Object>} Region.
* @api
*/
readRegionFromNode(node) {
const regions = [];
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
n.localName == 'Region') {
const obj = pushParseAndPop({}, REGION_PARSERS,
n, []);
regions.push(obj);
}
}
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
const localName = n.localName;
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
(localName == 'Document' ||
localName == 'Folder' ||
localName == 'kml')) {
extend(regions, this.readRegionFromNode(n));
}
}
return regions;
}
/**
* Encode an array of features in the KML format as an XML node. GeometryCollections,
* MultiPoints, MultiLineStrings, and MultiPolygons are output as MultiGeometries.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
writeFeaturesNode(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const kml = createElementNS(NAMESPACE_URIS[4], 'kml');
const xmlnsUri = 'http://www.w3.org/2000/xmlns/';
kml.setAttributeNS(xmlnsUri, 'xmlns:gx', GX_NAMESPACE_URIS[0]);
kml.setAttributeNS(xmlnsUri, 'xmlns:xsi', XML_SCHEMA_INSTANCE_URI);
kml.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', SCHEMA_LOCATION);
const /** @type {module:ol/xml~NodeStackItem} */ context = {node: kml};
const properties = {};
if (features.length > 1) {
properties['Document'] = features;
} else if (features.length == 1) {
properties['Placemark'] = features[0];
}
const orderedKeys = KML_SEQUENCE[kml.namespaceURI];
const values = makeSequence(properties, orderedKeys);
pushSerializeAndPop(context, KML_SERIALIZERS,
OBJECT_PROPERTY_NODE_FACTORY, values, [opt_options], orderedKeys,
this);
return kml;
}
}
inherits(KML, XMLFeature);
@@ -1643,132 +2043,6 @@ const PLACEMARK_PARSERS = makeStructureNS(
));
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {Array.<module:ol/Feature>|undefined} Features.
*/
KML.prototype.readDocumentOrFolder_ = function(node, objectStack) {
// FIXME use scope somehow
const parsersNS = makeStructureNS(
NAMESPACE_URIS, {
'Document': makeArrayExtender(this.readDocumentOrFolder_, this),
'Folder': makeArrayExtender(this.readDocumentOrFolder_, this),
'Placemark': makeArrayPusher(this.readPlacemark_, this),
'Style': this.readSharedStyle_.bind(this),
'StyleMap': this.readSharedStyleMap_.bind(this)
});
/** @type {Array.<module:ol/Feature>} */
const features = pushParseAndPop([], parsersNS, node, objectStack, this);
if (features) {
return features;
} else {
return undefined;
}
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
* @return {module:ol/Feature|undefined} Feature.
*/
KML.prototype.readPlacemark_ = function(node, objectStack) {
const object = pushParseAndPop({'geometry': null},
PLACEMARK_PARSERS, node, objectStack);
if (!object) {
return undefined;
}
const feature = new Feature();
const id = node.getAttribute('id');
if (id !== null) {
feature.setId(id);
}
const options = /** @type {module:ol/format/Feature~ReadOptions} */ (objectStack[0]);
const geometry = object['geometry'];
if (geometry) {
transformWithOptions(geometry, false, options);
}
feature.setGeometry(geometry);
delete object['geometry'];
if (this.extractStyles_) {
const style = object['Style'];
const styleUrl = object['styleUrl'];
const styleFunction = createFeatureStyleFunction(
style, styleUrl, this.defaultStyle_, this.sharedStyles_,
this.showPointNames_);
feature.setStyle(styleFunction);
}
delete object['Style'];
// we do not remove the styleUrl property from the object, so it
// gets stored on feature when setProperties is called
feature.setProperties(object);
return feature;
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
KML.prototype.readSharedStyle_ = function(node, objectStack) {
const id = node.getAttribute('id');
if (id !== null) {
const style = readStyle(node, objectStack);
if (style) {
let styleUri;
let baseURI = node.baseURI;
if (!baseURI || baseURI == 'about:blank') {
baseURI = window.location.href;
}
if (baseURI) {
const url = new URL('#' + id, baseURI);
styleUri = url.href;
} else {
styleUri = '#' + id;
}
this.sharedStyles_[styleUri] = style;
}
}
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
* @private
*/
KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
const id = node.getAttribute('id');
if (id === null) {
return;
}
const styleMapValue = readStyleMapValue(node, objectStack);
if (!styleMapValue) {
return;
}
let styleUri;
let baseURI = node.baseURI;
if (!baseURI || baseURI == 'about:blank') {
baseURI = window.location.href;
}
if (baseURI) {
const url = new URL('#' + id, baseURI);
styleUri = url.href;
} else {
styleUri = '#' + id;
}
this.sharedStyles_[styleUri] = styleMapValue;
};
/**
* Read the first feature from a KML source. MultiGeometries are converted into
* GeometryCollections if they are a mix of geometry types, and into MultiPoint/
@@ -1783,23 +2057,6 @@ KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
KML.prototype.readFeature;
/**
* @inheritDoc
*/
KML.prototype.readFeatureFromNode = function(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return null;
}
const feature = this.readPlacemark_(
node, [this.getReadOptions(node, opt_options)]);
if (feature) {
return feature;
} else {
return null;
}
};
/**
* Read all features from a KML source. MultiGeometries are converted into
* GeometryCollections if they are a mix of geometry types, and into MultiPoint/
@@ -1814,243 +2071,6 @@ KML.prototype.readFeatureFromNode = function(node, opt_options) {
KML.prototype.readFeatures;
/**
* @inheritDoc
*/
KML.prototype.readFeaturesFromNode = function(node, opt_options) {
if (!includes(NAMESPACE_URIS, node.namespaceURI)) {
return [];
}
let features;
const localName = node.localName;
if (localName == 'Document' || localName == 'Folder') {
features = this.readDocumentOrFolder_(
node, [this.getReadOptions(node, opt_options)]);
if (features) {
return features;
} else {
return [];
}
} else if (localName == 'Placemark') {
const feature = this.readPlacemark_(
node, [this.getReadOptions(node, opt_options)]);
if (feature) {
return [feature];
} else {
return [];
}
} else if (localName == 'kml') {
features = [];
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
const fs = this.readFeaturesFromNode(n, opt_options);
if (fs) {
extend(features, fs);
}
}
return features;
} else {
return [];
}
};
/**
* Read the name of the KML.
*
* @param {Document|Node|string} source Source.
* @return {string|undefined} Name.
* @api
*/
KML.prototype.readName = function(source) {
if (isDocument(source)) {
return this.readNameFromDocument(/** @type {Document} */ (source));
} else if (isNode(source)) {
return this.readNameFromNode(/** @type {Node} */ (source));
} else if (typeof source === 'string') {
const doc = parse(source);
return this.readNameFromDocument(doc);
} else {
return undefined;
}
};
/**
* @param {Document} doc Document.
* @return {string|undefined} Name.
*/
KML.prototype.readNameFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
const name = this.readNameFromNode(n);
if (name) {
return name;
}
}
}
return undefined;
};
/**
* @param {Node} node Node.
* @return {string|undefined} Name.
*/
KML.prototype.readNameFromNode = function(node) {
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
n.localName == 'name') {
return readString(n);
}
}
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
const localName = n.localName;
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
(localName == 'Document' ||
localName == 'Folder' ||
localName == 'Placemark' ||
localName == 'kml')) {
const name = this.readNameFromNode(n);
if (name) {
return name;
}
}
}
return undefined;
};
/**
* Read the network links of the KML.
*
* @param {Document|Node|string} source Source.
* @return {Array.<Object>} Network links.
* @api
*/
KML.prototype.readNetworkLinks = function(source) {
const networkLinks = [];
if (isDocument(source)) {
extend(networkLinks, this.readNetworkLinksFromDocument(
/** @type {Document} */ (source)));
} else if (isNode(source)) {
extend(networkLinks, this.readNetworkLinksFromNode(
/** @type {Node} */ (source)));
} else if (typeof source === 'string') {
const doc = parse(source);
extend(networkLinks, this.readNetworkLinksFromDocument(doc));
}
return networkLinks;
};
/**
* @param {Document} doc Document.
* @return {Array.<Object>} Network links.
*/
KML.prototype.readNetworkLinksFromDocument = function(doc) {
const networkLinks = [];
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
extend(networkLinks, this.readNetworkLinksFromNode(n));
}
}
return networkLinks;
};
/**
* @param {Node} node Node.
* @return {Array.<Object>} Network links.
*/
KML.prototype.readNetworkLinksFromNode = function(node) {
const networkLinks = [];
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
n.localName == 'NetworkLink') {
const obj = pushParseAndPop({}, NETWORK_LINK_PARSERS,
n, []);
networkLinks.push(obj);
}
}
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
const localName = n.localName;
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
(localName == 'Document' ||
localName == 'Folder' ||
localName == 'kml')) {
extend(networkLinks, this.readNetworkLinksFromNode(n));
}
}
return networkLinks;
};
/**
* Read the regions of the KML.
*
* @param {Document|Node|string} source Source.
* @return {Array.<Object>} Regions.
* @api
*/
KML.prototype.readRegion = function(source) {
const regions = [];
if (isDocument(source)) {
extend(regions, this.readRegionFromDocument(
/** @type {Document} */ (source)));
} else if (isNode(source)) {
extend(regions, this.readRegionFromNode(
/** @type {Node} */ (source)));
} else if (typeof source === 'string') {
const doc = parse(source);
extend(regions, this.readRegionFromDocument(doc));
}
return regions;
};
/**
* @param {Document} doc Document.
* @return {Array.<Object>} Region.
*/
KML.prototype.readRegionFromDocument = function(doc) {
const regions = [];
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
extend(regions, this.readRegionFromNode(n));
}
}
return regions;
};
/**
* @param {Node} node Node.
* @return {Array.<Object>} Region.
* @api
*/
KML.prototype.readRegionFromNode = function(node) {
const regions = [];
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
n.localName == 'Region') {
const obj = pushParseAndPop({}, REGION_PARSERS,
n, []);
regions.push(obj);
}
}
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
const localName = n.localName;
if (includes(NAMESPACE_URIS, n.namespaceURI) &&
(localName == 'Document' ||
localName == 'Folder' ||
localName == 'kml')) {
extend(regions, this.readRegionFromNode(n));
}
}
return regions;
};
/**
* Read the projection from a KML source.
*
@@ -2955,37 +2975,4 @@ const KML_SERIALIZERS = makeStructureNS(
KML.prototype.writeFeatures;
/**
* Encode an array of features in the KML format as an XML node. GeometryCollections,
* MultiPoints, MultiLineStrings, and MultiPolygons are output as MultiGeometries.
*
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
* @override
* @api
*/
KML.prototype.writeFeaturesNode = function(features, opt_options) {
opt_options = this.adaptOptions(opt_options);
const kml = createElementNS(NAMESPACE_URIS[4], 'kml');
const xmlnsUri = 'http://www.w3.org/2000/xmlns/';
kml.setAttributeNS(xmlnsUri, 'xmlns:gx', GX_NAMESPACE_URIS[0]);
kml.setAttributeNS(xmlnsUri, 'xmlns:xsi', XML_SCHEMA_INSTANCE_URI);
kml.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', SCHEMA_LOCATION);
const /** @type {module:ol/xml~NodeStackItem} */ context = {node: kml};
const properties = {};
if (features.length > 1) {
properties['Document'] = features;
} else if (features.length == 1) {
properties['Placemark'] = features[0];
}
const orderedKeys = KML_SEQUENCE[kml.namespaceURI];
const values = makeSequence(properties, orderedKeys);
pushSerializeAndPop(context, KML_SERIALIZERS,
OBJECT_PROPERTY_NODE_FACTORY, values, [opt_options], orderedKeys,
this);
return kml;
};
export default KML;
src/ol/format/MVT.js
+224 -232
View File
@@ -47,7 +47,8 @@ import RenderFeature from '../render/Feature.js';
* @param {module:ol/format/MVT~Options=} opt_options Options.
* @api
*/
const MVT = function(opt_options) {
class MVT {
constructor(opt_options) {
FeatureFormat.call(this);
@@ -94,7 +95,228 @@ const MVT = function(opt_options) {
*/
this.extent_ = null;
};
}
/**
* Read the raw geometry from the pbf offset stored in a raw feature's geometry
* property.
* @suppress {missingProperties}
* @param {Object} pbf PBF.
* @param {Object} feature Raw feature.
* @param {Array.<number>} flatCoordinates Array to store flat coordinates in.
* @param {Array.<number>} ends Array to store ends in.
* @private
*/
readRawGeometry_(pbf, feature, flatCoordinates, ends) {
pbf.pos = feature.geometry;
const end = pbf.readVarint() + pbf.pos;
let cmd = 1;
let length = 0;
let x = 0;
let y = 0;
let coordsLen = 0;
let currentEnd = 0;
while (pbf.pos < end) {
if (!length) {
const cmdLen = pbf.readVarint();
cmd = cmdLen & 0x7;
length = cmdLen >> 3;
}
length--;
if (cmd === 1 || cmd === 2) {
x += pbf.readSVarint();
y += pbf.readSVarint();
if (cmd === 1) { // moveTo
if (coordsLen > currentEnd) {
ends.push(coordsLen);
currentEnd = coordsLen;
}
}
flatCoordinates.push(x, y);
coordsLen += 2;
} else if (cmd === 7) {
if (coordsLen > currentEnd) {
// close polygon
flatCoordinates.push(
flatCoordinates[currentEnd], flatCoordinates[currentEnd + 1]);
coordsLen += 2;
}
} else {
assert(false, 59); // Invalid command found in the PBF
}
}
if (coordsLen > currentEnd) {
ends.push(coordsLen);
currentEnd = coordsLen;
}
}
/**
* @private
* @param {Object} pbf PBF
* @param {Object} rawFeature Raw Mapbox feature.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature|module:ol/render/Feature} Feature.
*/
createFeature_(pbf, rawFeature, opt_options) {
const type = rawFeature.type;
if (type === 0) {
return null;
}
let feature;
const id = rawFeature.id;
const values = rawFeature.properties;
values[this.layerName_] = rawFeature.layer.name;
const flatCoordinates = [];
const ends = [];
this.readRawGeometry_(pbf, rawFeature, flatCoordinates, ends);
const geometryType = getGeometryType(type, ends.length);
if (this.featureClass_ === RenderFeature) {
feature = new this.featureClass_(geometryType, flatCoordinates, ends, values, id);
} else {
let geom;
if (geometryType == GeometryType.POLYGON) {
const endss = [];
let offset = 0;
let prevEndIndex = 0;
for (let i = 0, ii = ends.length; i < ii; ++i) {
const end = ends[i];
if (!linearRingIsClockwise(flatCoordinates, offset, end, 2)) {
endss.push(ends.slice(prevEndIndex, i));
prevEndIndex = i;
}
offset = end;
}
if (endss.length > 1) {
geom = new MultiPolygon(flatCoordinates, GeometryLayout.XY, endss);
} else {
geom = new Polygon(flatCoordinates, GeometryLayout.XY, ends);
}
} else {
geom = geometryType === GeometryType.POINT ? new Point(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.LINE_STRING ? new LineString(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.POLYGON ? new Polygon(flatCoordinates, GeometryLayout.XY, ends) :
geometryType === GeometryType.MULTI_POINT ? new MultiPoint(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.MULTI_LINE_STRING ? new MultiLineString(flatCoordinates, GeometryLayout.XY, ends) :
null;
}
feature = new this.featureClass_();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
}
const geometry = transformWithOptions(geom, false, this.adaptOptions(opt_options));
feature.setGeometry(geometry);
feature.setId(id);
feature.setProperties(values);
}
return feature;
}
/**
* @inheritDoc
* @api
*/
getLastExtent() {
return this.extent_;
}
/**
* @inheritDoc
*/
getType() {
return FormatType.ARRAY_BUFFER;
}
/**
* @inheritDoc
* @api
*/
readFeatures(source, opt_options) {
const layers = this.layers_;
const pbf = new PBF(/** @type {ArrayBuffer} */ (source));
const pbfLayers = pbf.readFields(layersPBFReader, {});
/** @type {Array.<module:ol/Feature|module:ol/render/Feature>} */
const features = [];
for (const name in pbfLayers) {
if (layers && layers.indexOf(name) == -1) {
continue;
}
const pbfLayer = pbfLayers[name];
for (let i = 0, ii = pbfLayer.length; i < ii; ++i) {
const rawFeature = readRawFeature(pbf, pbfLayer, i);
features.push(this.createFeature_(pbf, rawFeature));
}
this.extent_ = pbfLayer ? [0, 0, pbfLayer.extent, pbfLayer.extent] : null;
}
return features;
}
/**
* @inheritDoc
* @api
*/
readProjection(source) {
return this.dataProjection;
}
/**
* Sets the layers that features will be read from.
* @param {Array.<string>} layers Layers.
* @api
*/
setLayers(layers) {
this.layers_ = layers;
}
/**
* Not implemented.
* @override
*/
readFeature() {}
/**
* Not implemented.
* @override
*/
readGeometry() {}
/**
* Not implemented.
* @override
*/
writeFeature() {}
/**
* Not implemented.
* @override
*/
writeGeometry() {}
/**
* Not implemented.
* @override
*/
writeFeatures() {}
}
inherits(MVT, FeatureFormat);
@@ -201,72 +423,6 @@ function readRawFeature(pbf, layer, i) {
}
/**
* Read the raw geometry from the pbf offset stored in a raw feature's geometry
* property.
* @suppress {missingProperties}
* @param {Object} pbf PBF.
* @param {Object} feature Raw feature.
* @param {Array.<number>} flatCoordinates Array to store flat coordinates in.
* @param {Array.<number>} ends Array to store ends in.
* @private
*/
MVT.prototype.readRawGeometry_ = function(pbf, feature, flatCoordinates, ends) {
pbf.pos = feature.geometry;
const end = pbf.readVarint() + pbf.pos;
let cmd = 1;
let length = 0;
let x = 0;
let y = 0;
let coordsLen = 0;
let currentEnd = 0;
while (pbf.pos < end) {
if (!length) {
const cmdLen = pbf.readVarint();
cmd = cmdLen & 0x7;
length = cmdLen >> 3;
}
length--;
if (cmd === 1 || cmd === 2) {
x += pbf.readSVarint();
y += pbf.readSVarint();
if (cmd === 1) { // moveTo
if (coordsLen > currentEnd) {
ends.push(coordsLen);
currentEnd = coordsLen;
}
}
flatCoordinates.push(x, y);
coordsLen += 2;
} else if (cmd === 7) {
if (coordsLen > currentEnd) {
// close polygon
flatCoordinates.push(
flatCoordinates[currentEnd], flatCoordinates[currentEnd + 1]);
coordsLen += 2;
}
} else {
assert(false, 59); // Invalid command found in the PBF
}
}
if (coordsLen > currentEnd) {
ends.push(coordsLen);
currentEnd = coordsLen;
}
};
/**
* @suppress {missingProperties}
* @param {number} type The raw feature's geometry type
@@ -292,168 +448,4 @@ function getGeometryType(type, numEnds) {
return geometryType;
}
/**
* @private
* @param {Object} pbf PBF
* @param {Object} rawFeature Raw Mapbox feature.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {module:ol/Feature|module:ol/render/Feature} Feature.
*/
MVT.prototype.createFeature_ = function(pbf, rawFeature, opt_options) {
const type = rawFeature.type;
if (type === 0) {
return null;
}
let feature;
const id = rawFeature.id;
const values = rawFeature.properties;
values[this.layerName_] = rawFeature.layer.name;
const flatCoordinates = [];
const ends = [];
this.readRawGeometry_(pbf, rawFeature, flatCoordinates, ends);
const geometryType = getGeometryType(type, ends.length);
if (this.featureClass_ === RenderFeature) {
feature = new this.featureClass_(geometryType, flatCoordinates, ends, values, id);
} else {
let geom;
if (geometryType == GeometryType.POLYGON) {
const endss = [];
let offset = 0;
let prevEndIndex = 0;
for (let i = 0, ii = ends.length; i < ii; ++i) {
const end = ends[i];
if (!linearRingIsClockwise(flatCoordinates, offset, end, 2)) {
endss.push(ends.slice(prevEndIndex, i));
prevEndIndex = i;
}
offset = end;
}
if (endss.length > 1) {
geom = new MultiPolygon(flatCoordinates, GeometryLayout.XY, endss);
} else {
geom = new Polygon(flatCoordinates, GeometryLayout.XY, ends);
}
} else {
geom = geometryType === GeometryType.POINT ? new Point(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.LINE_STRING ? new LineString(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.POLYGON ? new Polygon(flatCoordinates, GeometryLayout.XY, ends) :
geometryType === GeometryType.MULTI_POINT ? new MultiPoint(flatCoordinates, GeometryLayout.XY) :
geometryType === GeometryType.MULTI_LINE_STRING ? new MultiLineString(flatCoordinates, GeometryLayout.XY, ends) :
null;
}
feature = new this.featureClass_();
if (this.geometryName_) {
feature.setGeometryName(this.geometryName_);
}
const geometry = transformWithOptions(geom, false, this.adaptOptions(opt_options));
feature.setGeometry(geometry);
feature.setId(id);
feature.setProperties(values);
}
return feature;
};
/**
* @inheritDoc
* @api
*/
MVT.prototype.getLastExtent = function() {
return this.extent_;
};
/**
* @inheritDoc
*/
MVT.prototype.getType = function() {
return FormatType.ARRAY_BUFFER;
};
/**
* @inheritDoc
* @api
*/
MVT.prototype.readFeatures = function(source, opt_options) {
const layers = this.layers_;
const pbf = new PBF(/** @type {ArrayBuffer} */ (source));
const pbfLayers = pbf.readFields(layersPBFReader, {});
/** @type {Array.<module:ol/Feature|module:ol/render/Feature>} */
const features = [];
for (const name in pbfLayers) {
if (layers && layers.indexOf(name) == -1) {
continue;
}
const pbfLayer = pbfLayers[name];
for (let i = 0, ii = pbfLayer.length; i < ii; ++i) {
const rawFeature = readRawFeature(pbf, pbfLayer, i);
features.push(this.createFeature_(pbf, rawFeature));
}
this.extent_ = pbfLayer ? [0, 0, pbfLayer.extent, pbfLayer.extent] : null;
}
return features;
};
/**
* @inheritDoc
* @api
*/
MVT.prototype.readProjection = function(source) {
return this.dataProjection;
};
/**
* Sets the layers that features will be read from.
* @param {Array.<string>} layers Layers.
* @api
*/
MVT.prototype.setLayers = function(layers) {
this.layers_ = layers;
};
/**
* Not implemented.
* @override
*/
MVT.prototype.readFeature = function() {};
/**
* Not implemented.
* @override
*/
MVT.prototype.readGeometry = function() {};
/**
* Not implemented.
* @override
*/
MVT.prototype.writeFeature = function() {};
/**
* Not implemented.
* @override
*/
MVT.prototype.writeGeometry = function() {};
/**
* Not implemented.
* @override
*/
MVT.prototype.writeFeatures = function() {};
export default MVT;
src/ol/format/OSMXML.js
+62 -62
View File
@@ -24,14 +24,74 @@ import {pushParseAndPop, makeStructureNS} from '../xml.js';
* @extends {module:ol/format/XMLFeature}
* @api
*/
const OSMXML = function() {
class OSMXML {
constructor() {
XMLFeature.call(this);
/**
* @inheritDoc
*/
this.dataProjection = getProjection('EPSG:4326');
};
}
/**
* @inheritDoc
*/
readFeaturesFromNode(node, opt_options) {
const options = this.getReadOptions(node, opt_options);
if (node.localName == 'osm') {
const state = pushParseAndPop({
nodes: {},
ways: [],
features: []
}, PARSERS, node, [options]);
// parse nodes in ways
for (let j = 0; j < state.ways.length; j++) {
const values = /** @type {Object} */ (state.ways[j]);
/** @type {Array.<number>} */
const flatCoordinates = [];
for (let i = 0, ii = values.ndrefs.length; i < ii; i++) {
const point = state.nodes[values.ndrefs[i]];
extend(flatCoordinates, point);
}
let geometry;
if (values.ndrefs[0] == values.ndrefs[values.ndrefs.length - 1]) {
// closed way
geometry = new Polygon(flatCoordinates, GeometryLayout.XY, [flatCoordinates.length]);
} else {
geometry = new LineString(flatCoordinates, GeometryLayout.XY);
}
transformWithOptions(geometry, false, options);
const feature = new Feature(geometry);
feature.setId(values.id);
feature.setProperties(values.tags);
state.features.push(feature);
}
if (state.features) {
return state.features;
}
}
return [];
}
/**
* Not implemented.
* @inheritDoc
*/
writeFeatureNode(feature, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeFeaturesNode(features, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeGeometryNode(geometry, opt_options) {}
}
inherits(OSMXML, XMLFeature);
@@ -152,47 +212,6 @@ function readTag(node, objectStack) {
OSMXML.prototype.readFeatures;
/**
* @inheritDoc
*/
OSMXML.prototype.readFeaturesFromNode = function(node, opt_options) {
const options = this.getReadOptions(node, opt_options);
if (node.localName == 'osm') {
const state = pushParseAndPop({
nodes: {},
ways: [],
features: []
}, PARSERS, node, [options]);
// parse nodes in ways
for (let j = 0; j < state.ways.length; j++) {
const values = /** @type {Object} */ (state.ways[j]);
/** @type {Array.<number>} */
const flatCoordinates = [];
for (let i = 0, ii = values.ndrefs.length; i < ii; i++) {
const point = state.nodes[values.ndrefs[i]];
extend(flatCoordinates, point);
}
let geometry;
if (values.ndrefs[0] == values.ndrefs[values.ndrefs.length - 1]) {
// closed way
geometry = new Polygon(flatCoordinates, GeometryLayout.XY, [flatCoordinates.length]);
} else {
geometry = new LineString(flatCoordinates, GeometryLayout.XY);
}
transformWithOptions(geometry, false, options);
const feature = new Feature(geometry);
feature.setId(values.id);
feature.setProperties(values.tags);
state.features.push(feature);
}
if (state.features) {
return state.features;
}
}
return [];
};
/**
* Read the projection from an OSM source.
*
@@ -204,23 +223,4 @@ OSMXML.prototype.readFeaturesFromNode = function(node, opt_options) {
OSMXML.prototype.readProjection;
/**
* Not implemented.
* @inheritDoc
*/
OSMXML.prototype.writeFeatureNode = function(feature, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
OSMXML.prototype.writeFeaturesNode = function(features, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
OSMXML.prototype.writeGeometryNode = function(geometry, opt_options) {};
export default OSMXML;
src/ol/format/OWS.js
+25 -25
View File
@@ -11,9 +11,32 @@ import {makeObjectPropertyPusher, makeObjectPropertySetter, makeStructureNS, pus
* @constructor
* @extends {module:ol/format/XML}
*/
const OWS = function() {
class OWS {
constructor() {
XML.call(this);
};
}
/**
* @inheritDoc
*/
readFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
}
/**
* @inheritDoc
*/
readFromNode(node) {
const owsObject = pushParseAndPop({},
PARSERS, node, []);
return owsObject ? owsObject : null;
}
}
inherits(OWS, XML);
@@ -187,29 +210,6 @@ const SERVICE_PROVIDER_PARSERS =
});
/**
* @inheritDoc
*/
OWS.prototype.readFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
};
/**
* @inheritDoc
*/
OWS.prototype.readFromNode = function(node) {
const owsObject = pushParseAndPop({},
PARSERS, node, []);
return owsObject ? owsObject : null;
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
src/ol/format/Polyline.js
+70 -72
View File
@@ -32,7 +32,8 @@ import {get as getProjection} from '../proj.js';
* @param {module:ol/format/Polyline~Options=} opt_options Optional configuration object.
* @api
*/
const Polyline = function(opt_options) {
class Polyline {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -55,7 +56,74 @@ const Polyline = function(opt_options) {
*/
this.geometryLayout_ = options.geometryLayout ?
options.geometryLayout : GeometryLayout.XY;
};
}
/**
* @inheritDoc
*/
readFeatureFromText(text, opt_options) {
const geometry = this.readGeometryFromText(text, opt_options);
return new Feature(geometry);
}
/**
* @inheritDoc
*/
readFeaturesFromText(text, opt_options) {
const feature = this.readFeatureFromText(text, opt_options);
return [feature];
}
/**
* @inheritDoc
*/
readGeometryFromText(text, opt_options) {
const stride = getStrideForLayout(this.geometryLayout_);
const flatCoordinates = decodeDeltas(text, stride, this.factor_);
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
const coordinates = inflateCoordinates(flatCoordinates, 0, flatCoordinates.length, stride);
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(
new LineString(coordinates, this.geometryLayout_),
false,
this.adaptOptions(opt_options)
))
);
}
/**
* @inheritDoc
*/
writeFeatureText(feature, opt_options) {
const geometry = feature.getGeometry();
if (geometry) {
return this.writeGeometryText(geometry, opt_options);
} else {
assert(false, 40); // Expected `feature` to have a geometry
return '';
}
}
/**
* @inheritDoc
*/
writeFeaturesText(features, opt_options) {
return this.writeFeatureText(features[0], opt_options);
}
/**
* @inheritDoc
*/
writeGeometryText(geometry, opt_options) {
geometry = /** @type {module:ol/geom/LineString} */
(transformWithOptions(geometry, true, this.adaptOptions(opt_options)));
const flatCoordinates = geometry.getFlatCoordinates();
const stride = geometry.getStride();
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
return encodeDeltas(flatCoordinates, stride, this.factor_);
}
}
inherits(Polyline, TextFeature);
@@ -277,15 +345,6 @@ export function encodeUnsignedInteger(num) {
Polyline.prototype.readFeature;
/**
* @inheritDoc
*/
Polyline.prototype.readFeatureFromText = function(text, opt_options) {
const geometry = this.readGeometryFromText(text, opt_options);
return new Feature(geometry);
};
/**
* Read the feature from the source. As Polyline sources contain a single
* feature, this will return the feature in an array.
@@ -299,15 +358,6 @@ Polyline.prototype.readFeatureFromText = function(text, opt_options) {
Polyline.prototype.readFeatures;
/**
* @inheritDoc
*/
Polyline.prototype.readFeaturesFromText = function(text, opt_options) {
const feature = this.readFeatureFromText(text, opt_options);
return [feature];
};
/**
* Read the geometry from the source.
*
@@ -320,25 +370,6 @@ Polyline.prototype.readFeaturesFromText = function(text, opt_options) {
Polyline.prototype.readGeometry;
/**
* @inheritDoc
*/
Polyline.prototype.readGeometryFromText = function(text, opt_options) {
const stride = getStrideForLayout(this.geometryLayout_);
const flatCoordinates = decodeDeltas(text, stride, this.factor_);
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
const coordinates = inflateCoordinates(flatCoordinates, 0, flatCoordinates.length, stride);
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(
new LineString(coordinates, this.geometryLayout_),
false,
this.adaptOptions(opt_options)
))
);
};
/**
* Read the projection from a Polyline source.
*
@@ -350,28 +381,6 @@ Polyline.prototype.readGeometryFromText = function(text, opt_options) {
Polyline.prototype.readProjection;
/**
* @inheritDoc
*/
Polyline.prototype.writeFeatureText = function(feature, opt_options) {
const geometry = feature.getGeometry();
if (geometry) {
return this.writeGeometryText(geometry, opt_options);
} else {
assert(false, 40); // Expected `feature` to have a geometry
return '';
}
};
/**
* @inheritDoc
*/
Polyline.prototype.writeFeaturesText = function(features, opt_options) {
return this.writeFeatureText(features[0], opt_options);
};
/**
* Write a single geometry in Polyline format.
*
@@ -384,15 +393,4 @@ Polyline.prototype.writeFeaturesText = function(features, opt_options) {
Polyline.prototype.writeGeometry;
/**
* @inheritDoc
*/
Polyline.prototype.writeGeometryText = function(geometry, opt_options) {
geometry = /** @type {module:ol/geom/LineString} */
(transformWithOptions(geometry, true, this.adaptOptions(opt_options)));
const flatCoordinates = geometry.getFlatCoordinates();
const stride = geometry.getStride();
flipXY(flatCoordinates, 0, flatCoordinates.length, stride, flatCoordinates);
return encodeDeltas(flatCoordinates, stride, this.factor_);
};
export default Polyline;
src/ol/format/TextFeature.js
+123 -134
View File
@@ -15,9 +15,130 @@ import FormatType from '../format/FormatType.js';
* @abstract
* @extends {module:ol/format/Feature}
*/
const TextFeature = function() {
class TextFeature {
constructor() {
FeatureFormat.call(this);
};
}
/**
* @inheritDoc
*/
getType() {
return FormatType.TEXT;
}
/**
* @inheritDoc
*/
readFeature(source, opt_options) {
return this.readFeatureFromText(getText(source), this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature} Feature.
*/
readFeatureFromText(text, opt_options) {}
/**
* @inheritDoc
*/
readFeatures(source, opt_options) {
return this.readFeaturesFromText(getText(source), this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
readFeaturesFromText(text, opt_options) {}
/**
* @inheritDoc
*/
readGeometry(source, opt_options) {
return this.readGeometryFromText(getText(source), this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
readGeometryFromText(text, opt_options) {}
/**
* @inheritDoc
*/
readProjection(source) {
return this.readProjectionFromText(getText(source));
}
/**
* @param {string} text Text.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
readProjectionFromText(text) {
return this.dataProjection;
}
/**
* @inheritDoc
*/
writeFeature(feature, opt_options) {
return this.writeFeatureText(feature, this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {module:ol/Feature} feature Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
writeFeatureText(feature, opt_options) {}
/**
* @inheritDoc
*/
writeFeatures(features, opt_options) {
return this.writeFeaturesText(features, this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
writeFeaturesText(features, opt_options) {}
/**
* @inheritDoc
*/
writeGeometry(geometry, opt_options) {
return this.writeGeometryText(geometry, this.adaptOptions(opt_options));
}
/**
* @abstract
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
writeGeometryText(geometry, opt_options) {}
}
inherits(TextFeature, FeatureFormat);
@@ -35,136 +156,4 @@ function getText(source) {
}
/**
* @inheritDoc
*/
TextFeature.prototype.getType = function() {
return FormatType.TEXT;
};
/**
* @inheritDoc
*/
TextFeature.prototype.readFeature = function(source, opt_options) {
return this.readFeatureFromText(getText(source), this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/Feature} Feature.
*/
TextFeature.prototype.readFeatureFromText = function(text, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.readFeatures = function(source, opt_options) {
return this.readFeaturesFromText(getText(source), this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
TextFeature.prototype.readFeaturesFromText = function(text, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.readGeometry = function(source, opt_options) {
return this.readGeometryFromText(getText(source), this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {string} text Text.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
TextFeature.prototype.readGeometryFromText = function(text, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.readProjection = function(source) {
return this.readProjectionFromText(getText(source));
};
/**
* @param {string} text Text.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
TextFeature.prototype.readProjectionFromText = function(text) {
return this.dataProjection;
};
/**
* @inheritDoc
*/
TextFeature.prototype.writeFeature = function(feature, opt_options) {
return this.writeFeatureText(feature, this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {module:ol/Feature} feature Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
TextFeature.prototype.writeFeatureText = function(feature, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.writeFeatures = function(features, opt_options) {
return this.writeFeaturesText(features, this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
TextFeature.prototype.writeFeaturesText = function(features, opt_options) {};
/**
* @inheritDoc
*/
TextFeature.prototype.writeGeometry = function(geometry, opt_options) {
return this.writeGeometryText(geometry, this.adaptOptions(opt_options));
};
/**
* @abstract
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Write options.
* @protected
* @return {string} Text.
*/
TextFeature.prototype.writeGeometryText = function(geometry, opt_options) {};
export default TextFeature;
src/ol/format/TopoJSON.js
+82 -85
View File
@@ -48,7 +48,8 @@ import {get as getProjection} from '../proj.js';
* @param {module:ol/format/TopoJSON~Options=} opt_options Options.
* @api
*/
const TopoJSON = function(opt_options) {
class TopoJSON {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -73,7 +74,86 @@ const TopoJSON = function(opt_options) {
options.dataProjection ?
options.dataProjection : 'EPSG:4326');
};
}
/**
* @inheritDoc
*/
readFeaturesFromObject(object, opt_options) {
if (object.type == 'Topology') {
const topoJSONTopology = /** @type {TopoJSONTopology} */ (object);
let transform, scale = null, translate = null;
if (topoJSONTopology.transform) {
transform = topoJSONTopology.transform;
scale = transform.scale;
translate = transform.translate;
}
const arcs = topoJSONTopology.arcs;
if (transform) {
transformArcs(arcs, scale, translate);
}
/** @type {Array.<module:ol/Feature>} */
const features = [];
const topoJSONFeatures = topoJSONTopology.objects;
const property = this.layerName_;
let feature;
for (const objectName in topoJSONFeatures) {
if (this.layers_ && this.layers_.indexOf(objectName) == -1) {
continue;
}
if (topoJSONFeatures[objectName].type === 'GeometryCollection') {
feature = /** @type {TopoJSONGeometryCollection} */ (topoJSONFeatures[objectName]);
features.push.apply(features, readFeaturesFromGeometryCollection(
feature, arcs, scale, translate, property, objectName, opt_options));
} else {
feature = /** @type {TopoJSONGeometry} */ (topoJSONFeatures[objectName]);
features.push(readFeatureFromGeometry(
feature, arcs, scale, translate, property, objectName, opt_options));
}
}
return features;
} else {
return [];
}
}
/**
* @inheritDoc
*/
readProjectionFromObject(object) {
return this.dataProjection;
}
/**
* Not implemented.
* @inheritDoc
*/
writeFeatureObject(feature, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeFeaturesObject(features, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeGeometryObject(geometry, opt_options) {}
/**
* Not implemented.
* @override
*/
readGeometryFromObject() {}
/**
* Not implemented.
* @override
*/
readFeatureFromObject() {}
}
inherits(TopoJSON, JSONFeature);
@@ -309,48 +389,6 @@ function readFeatureFromGeometry(object, arcs, scale, translate, property, name,
TopoJSON.prototype.readFeatures;
/**
* @inheritDoc
*/
TopoJSON.prototype.readFeaturesFromObject = function(object, opt_options) {
if (object.type == 'Topology') {
const topoJSONTopology = /** @type {TopoJSONTopology} */ (object);
let transform, scale = null, translate = null;
if (topoJSONTopology.transform) {
transform = topoJSONTopology.transform;
scale = transform.scale;
translate = transform.translate;
}
const arcs = topoJSONTopology.arcs;
if (transform) {
transformArcs(arcs, scale, translate);
}
/** @type {Array.<module:ol/Feature>} */
const features = [];
const topoJSONFeatures = topoJSONTopology.objects;
const property = this.layerName_;
let feature;
for (const objectName in topoJSONFeatures) {
if (this.layers_ && this.layers_.indexOf(objectName) == -1) {
continue;
}
if (topoJSONFeatures[objectName].type === 'GeometryCollection') {
feature = /** @type {TopoJSONGeometryCollection} */ (topoJSONFeatures[objectName]);
features.push.apply(features, readFeaturesFromGeometryCollection(
feature, arcs, scale, translate, property, objectName, opt_options));
} else {
feature = /** @type {TopoJSONGeometry} */ (topoJSONFeatures[objectName]);
features.push(readFeatureFromGeometry(
feature, arcs, scale, translate, property, objectName, opt_options));
}
}
return features;
} else {
return [];
}
};
/**
* Apply a linear transform to array of arcs. The provided array of arcs is
* modified in place.
@@ -412,45 +450,4 @@ function transformVertex(vertex, scale, translate) {
TopoJSON.prototype.readProjection;
/**
* @inheritDoc
*/
TopoJSON.prototype.readProjectionFromObject = function(object) {
return this.dataProjection;
};
/**
* Not implemented.
* @inheritDoc
*/
TopoJSON.prototype.writeFeatureObject = function(feature, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
TopoJSON.prototype.writeFeaturesObject = function(features, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
TopoJSON.prototype.writeGeometryObject = function(geometry, opt_options) {};
/**
* Not implemented.
* @override
*/
TopoJSON.prototype.readGeometryFromObject = function() {};
/**
* Not implemented.
* @override
*/
TopoJSON.prototype.readFeatureFromObject = function() {};
export default TopoJSON;
src/ol/format/WFS.js
+230 -239
View File
@@ -143,7 +143,8 @@ const DEFAULT_VERSION = '1.1.0';
* @extends {module:ol/format/XMLFeature}
* @api
*/
const WFS = function(opt_options) {
class WFS {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
/**
@@ -173,43 +174,26 @@ const WFS = function(opt_options) {
options.schemaLocation : SCHEMA_LOCATIONS[DEFAULT_VERSION];
XMLFeature.call(this);
};
inherits(WFS, XMLFeature);
}
/**
* @return {Array.<string>|string|undefined} featureType
*/
WFS.prototype.getFeatureType = function() {
getFeatureType() {
return this.featureType_;
};
}
/**
* @param {Array.<string>|string|undefined} featureType Feature type(s) to parse.
*/
WFS.prototype.setFeatureType = function(featureType) {
setFeatureType(featureType) {
this.featureType_ = featureType;
};
/**
* Read all features from a WFS FeatureCollection.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
WFS.prototype.readFeatures;
}
/**
* @inheritDoc
*/
WFS.prototype.readFeaturesFromNode = function(node, opt_options) {
readFeaturesFromNode(node, opt_options) {
const context = /** @type {module:ol/xml~NodeStackItem} */ ({
'featureType': this.featureType_,
'featureNS': this.featureNS_
@@ -226,8 +210,7 @@ WFS.prototype.readFeaturesFromNode = function(node, opt_options) {
features = [];
}
return features;
};
}
/**
* Read transaction response of the source.
@@ -236,7 +219,7 @@ WFS.prototype.readFeaturesFromNode = function(node, opt_options) {
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
* @api
*/
WFS.prototype.readTransactionResponse = function(source) {
readTransactionResponse(source) {
if (isDocument(source)) {
return this.readTransactionResponseFromDocument(
/** @type {Document} */ (source));
@@ -248,8 +231,7 @@ WFS.prototype.readTransactionResponse = function(source) {
} else {
return undefined;
}
};
}
/**
* Read feature collection metadata of the source.
@@ -259,7 +241,7 @@ WFS.prototype.readTransactionResponse = function(source) {
* FeatureCollection metadata.
* @api
*/
WFS.prototype.readFeatureCollectionMetadata = function(source) {
readFeatureCollectionMetadata(source) {
if (isDocument(source)) {
return this.readFeatureCollectionMetadataFromDocument(
/** @type {Document} */ (source));
@@ -272,22 +254,237 @@ WFS.prototype.readFeatureCollectionMetadata = function(source) {
} else {
return undefined;
}
};
}
/**
* @param {Document} doc Document.
* @return {module:ol/format/WFS~FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
*/
WFS.prototype.readFeatureCollectionMetadataFromDocument = function(doc) {
readFeatureCollectionMetadataFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFeatureCollectionMetadataFromNode(n);
}
}
return undefined;
}
/**
* @param {Node} node Node.
* @return {module:ol/format/WFS~FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
*/
readFeatureCollectionMetadataFromNode(node) {
const result = {};
const value = readNonNegativeIntegerString(
node.getAttribute('numberOfFeatures'));
result['numberOfFeatures'] = value;
return pushParseAndPop(
/** @type {module:ol/format/WFS~FeatureCollectionMetadata} */ (result),
FEATURE_COLLECTION_PARSERS, node, [], this.gmlFormat_);
}
/**
* @param {Document} doc Document.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
*/
readTransactionResponseFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readTransactionResponseFromNode(n);
}
}
return undefined;
}
/**
* @param {Node} node Node.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
*/
readTransactionResponseFromNode(node) {
return pushParseAndPop(
/** @type {module:ol/format/WFS~TransactionResponse} */({}),
TRANSACTION_RESPONSE_PARSERS, node, []);
}
/**
* Encode format as WFS `GetFeature` and return the Node.
*
* @param {module:ol/format/WFS~WriteGetFeatureOptions} options Options.
* @return {Node} Result.
* @api
*/
writeGetFeature(options) {
const node = createElementNS(WFSNS, 'GetFeature');
node.setAttribute('service', 'WFS');
node.setAttribute('version', '1.1.0');
let filter;
if (options) {
if (options.handle) {
node.setAttribute('handle', options.handle);
}
if (options.outputFormat) {
node.setAttribute('outputFormat', options.outputFormat);
}
if (options.maxFeatures !== undefined) {
node.setAttribute('maxFeatures', options.maxFeatures);
}
if (options.resultType) {
node.setAttribute('resultType', options.resultType);
}
if (options.startIndex !== undefined) {
node.setAttribute('startIndex', options.startIndex);
}
if (options.count !== undefined) {
node.setAttribute('count', options.count);
}
filter = options.filter;
if (options.bbox) {
assert(options.geometryName,
12); // `options.geometryName` must also be provided when `options.bbox` is set
const bbox = bboxFilter(
/** @type {string} */ (options.geometryName), options.bbox, options.srsName);
if (filter) {
// if bbox and filter are both set, combine the two into a single filter
filter = andFilter(filter, bbox);
} else {
filter = bbox;
}
}
}
node.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', this.schemaLocation_);
/** @type {module:ol/xml~NodeStackItem} */
const context = {
node: node,
'srsName': options.srsName,
'featureNS': options.featureNS ? options.featureNS : this.featureNS_,
'featurePrefix': options.featurePrefix,
'geometryName': options.geometryName,
'filter': filter,
'propertyNames': options.propertyNames ? options.propertyNames : []
};
assert(Array.isArray(options.featureTypes),
11); // `options.featureTypes` should be an Array
writeGetFeature(node, /** @type {!Array.<string>} */ (options.featureTypes), [context]);
return node;
}
/**
* Encode format as WFS `Transaction` and return the Node.
*
* @param {Array.<module:ol/Feature>} inserts The features to insert.
* @param {Array.<module:ol/Feature>} updates The features to update.
* @param {Array.<module:ol/Feature>} deletes The features to delete.
* @param {module:ol/format/WFS~WriteTransactionOptions} options Write options.
* @return {Node} Result.
* @api
*/
writeTransaction(inserts, updates, deletes, options) {
const objectStack = [];
const node = createElementNS(WFSNS, 'Transaction');
const version = options.version ? options.version : DEFAULT_VERSION;
const gmlVersion = version === '1.0.0' ? 2 : 3;
node.setAttribute('service', 'WFS');
node.setAttribute('version', version);
let baseObj;
/** @type {module:ol/xml~NodeStackItem} */
let obj;
if (options) {
baseObj = options.gmlOptions ? options.gmlOptions : {};
if (options.handle) {
node.setAttribute('handle', options.handle);
}
}
const schemaLocation = SCHEMA_LOCATIONS[version];
node.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', schemaLocation);
const featurePrefix = options.featurePrefix ? options.featurePrefix : FEATURE_PREFIX;
if (inserts) {
obj = {node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'hasZ': options.hasZ, 'srsName': options.srsName};
assign(obj, baseObj);
pushSerializeAndPop(obj,
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Insert'), inserts,
objectStack);
}
if (updates) {
obj = {node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'hasZ': options.hasZ, 'srsName': options.srsName};
assign(obj, baseObj);
pushSerializeAndPop(obj,
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Update'), updates,
objectStack);
}
if (deletes) {
pushSerializeAndPop({node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'srsName': options.srsName},
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Delete'), deletes,
objectStack);
}
if (options.nativeElements) {
pushSerializeAndPop({node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'srsName': options.srsName},
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Native'), options.nativeElements,
objectStack);
}
return node;
}
/**
* @inheritDoc
*/
readProjectionFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readProjectionFromNode(n);
}
}
return null;
}
/**
* @inheritDoc
*/
readProjectionFromNode(node) {
if (node.firstElementChild &&
node.firstElementChild.firstElementChild) {
node = node.firstElementChild.firstElementChild;
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (!(n.childNodes.length === 0 ||
(n.childNodes.length === 1 &&
n.firstChild.nodeType === 3))) {
const objectStack = [{}];
this.gmlFormat_.readGeometryElement(n, objectStack);
return getProjection(objectStack.pop().srsName);
}
}
}
return null;
}
}
inherits(WFS, XMLFeature);
/**
* Read all features from a WFS FeatureCollection.
*
* @function
* @param {Document|Node|Object|string} source Source.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Read options.
* @return {Array.<module:ol/Feature>} Features.
* @api
*/
WFS.prototype.readFeatures;
/**
@@ -302,22 +499,6 @@ const FEATURE_COLLECTION_PARSERS = {
};
/**
* @param {Node} node Node.
* @return {module:ol/format/WFS~FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
*/
WFS.prototype.readFeatureCollectionMetadataFromNode = function(node) {
const result = {};
const value = readNonNegativeIntegerString(
node.getAttribute('numberOfFeatures'));
result['numberOfFeatures'] = value;
return pushParseAndPop(
/** @type {module:ol/format/WFS~FeatureCollectionMetadata} */ (result),
FEATURE_COLLECTION_PARSERS, node, [], this.gmlFormat_);
};
/**
* @const
* @type {Object.<string, Object.<string, module:ol/xml~Parser>>}
@@ -400,31 +581,6 @@ const TRANSACTION_RESPONSE_PARSERS = {
};
/**
* @param {Document} doc Document.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
*/
WFS.prototype.readTransactionResponseFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readTransactionResponseFromNode(n);
}
}
return undefined;
};
/**
* @param {Node} node Node.
* @return {module:ol/format/WFS~TransactionResponse|undefined} Transaction response.
*/
WFS.prototype.readTransactionResponseFromNode = function(node) {
return pushParseAndPop(
/** @type {module:ol/format/WFS~TransactionResponse} */({}),
TRANSACTION_RESPONSE_PARSERS, node, []);
};
/**
* @type {Object.<string, Object.<string, module:ol/xml~Serializer>>}
*/
@@ -942,138 +1098,6 @@ function writeGetFeature(node, featureTypes, objectStack) {
}
/**
* Encode format as WFS `GetFeature` and return the Node.
*
* @param {module:ol/format/WFS~WriteGetFeatureOptions} options Options.
* @return {Node} Result.
* @api
*/
WFS.prototype.writeGetFeature = function(options) {
const node = createElementNS(WFSNS, 'GetFeature');
node.setAttribute('service', 'WFS');
node.setAttribute('version', '1.1.0');
let filter;
if (options) {
if (options.handle) {
node.setAttribute('handle', options.handle);
}
if (options.outputFormat) {
node.setAttribute('outputFormat', options.outputFormat);
}
if (options.maxFeatures !== undefined) {
node.setAttribute('maxFeatures', options.maxFeatures);
}
if (options.resultType) {
node.setAttribute('resultType', options.resultType);
}
if (options.startIndex !== undefined) {
node.setAttribute('startIndex', options.startIndex);
}
if (options.count !== undefined) {
node.setAttribute('count', options.count);
}
filter = options.filter;
if (options.bbox) {
assert(options.geometryName,
12); // `options.geometryName` must also be provided when `options.bbox` is set
const bbox = bboxFilter(
/** @type {string} */ (options.geometryName), options.bbox, options.srsName);
if (filter) {
// if bbox and filter are both set, combine the two into a single filter
filter = andFilter(filter, bbox);
} else {
filter = bbox;
}
}
}
node.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', this.schemaLocation_);
/** @type {module:ol/xml~NodeStackItem} */
const context = {
node: node,
'srsName': options.srsName,
'featureNS': options.featureNS ? options.featureNS : this.featureNS_,
'featurePrefix': options.featurePrefix,
'geometryName': options.geometryName,
'filter': filter,
'propertyNames': options.propertyNames ? options.propertyNames : []
};
assert(Array.isArray(options.featureTypes),
11); // `options.featureTypes` should be an Array
writeGetFeature(node, /** @type {!Array.<string>} */ (options.featureTypes), [context]);
return node;
};
/**
* Encode format as WFS `Transaction` and return the Node.
*
* @param {Array.<module:ol/Feature>} inserts The features to insert.
* @param {Array.<module:ol/Feature>} updates The features to update.
* @param {Array.<module:ol/Feature>} deletes The features to delete.
* @param {module:ol/format/WFS~WriteTransactionOptions} options Write options.
* @return {Node} Result.
* @api
*/
WFS.prototype.writeTransaction = function(inserts, updates, deletes, options) {
const objectStack = [];
const node = createElementNS(WFSNS, 'Transaction');
const version = options.version ? options.version : DEFAULT_VERSION;
const gmlVersion = version === '1.0.0' ? 2 : 3;
node.setAttribute('service', 'WFS');
node.setAttribute('version', version);
let baseObj;
/** @type {module:ol/xml~NodeStackItem} */
let obj;
if (options) {
baseObj = options.gmlOptions ? options.gmlOptions : {};
if (options.handle) {
node.setAttribute('handle', options.handle);
}
}
const schemaLocation = SCHEMA_LOCATIONS[version];
node.setAttributeNS(XML_SCHEMA_INSTANCE_URI, 'xsi:schemaLocation', schemaLocation);
const featurePrefix = options.featurePrefix ? options.featurePrefix : FEATURE_PREFIX;
if (inserts) {
obj = {node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'hasZ': options.hasZ, 'srsName': options.srsName};
assign(obj, baseObj);
pushSerializeAndPop(obj,
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Insert'), inserts,
objectStack);
}
if (updates) {
obj = {node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'hasZ': options.hasZ, 'srsName': options.srsName};
assign(obj, baseObj);
pushSerializeAndPop(obj,
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Update'), updates,
objectStack);
}
if (deletes) {
pushSerializeAndPop({node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'srsName': options.srsName},
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Delete'), deletes,
objectStack);
}
if (options.nativeElements) {
pushSerializeAndPop({node: node, 'featureNS': options.featureNS,
'featureType': options.featureType, 'featurePrefix': featurePrefix,
'gmlVersion': gmlVersion, 'srsName': options.srsName},
TRANSACTION_SERIALIZERS,
makeSimpleNodeFactory('Native'), options.nativeElements,
objectStack);
}
return node;
};
/**
* Read the projection from a WFS source.
*
@@ -1085,37 +1109,4 @@ WFS.prototype.writeTransaction = function(inserts, updates, deletes, options) {
WFS.prototype.readProjection;
/**
* @inheritDoc
*/
WFS.prototype.readProjectionFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readProjectionFromNode(n);
}
}
return null;
};
/**
* @inheritDoc
*/
WFS.prototype.readProjectionFromNode = function(node) {
if (node.firstElementChild &&
node.firstElementChild.firstElementChild) {
node = node.firstElementChild.firstElementChild;
for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
if (!(n.childNodes.length === 0 ||
(n.childNodes.length === 1 &&
n.firstChild.nodeType === 3))) {
const objectStack = [{}];
this.gmlFormat_.readGeometryElement(n, objectStack);
return getProjection(objectStack.pop().srsName);
}
}
}
return null;
};
export default WFS;
src/ol/format/WKT.js
+191 -220
View File
@@ -77,7 +77,8 @@ const TokenType = {
* @param {string} wkt WKT string.
* @constructor
*/
const Lexer = function(wkt) {
class Lexer {
constructor(wkt) {
/**
* @type {string}
@@ -89,18 +90,16 @@ const Lexer = function(wkt) {
* @private
*/
this.index_ = -1;
};
}
/**
* @param {string} c Character.
* @return {boolean} Whether the character is alphabetic.
* @private
*/
Lexer.prototype.isAlpha_ = function(c) {
isAlpha_(c) {
return c >= 'a' && c <= 'z' || c >= 'A' && c <= 'Z';
};
}
/**
* @param {string} c Character.
@@ -109,36 +108,33 @@ Lexer.prototype.isAlpha_ = function(c) {
* @return {boolean} Whether the character is numeric.
* @private
*/
Lexer.prototype.isNumeric_ = function(c, opt_decimal) {
isNumeric_(c, opt_decimal) {
const decimal = opt_decimal !== undefined ? opt_decimal : false;
return c >= '0' && c <= '9' || c == '.' && !decimal;
};
}
/**
* @param {string} c Character.
* @return {boolean} Whether the character is whitespace.
* @private
*/
Lexer.prototype.isWhiteSpace_ = function(c) {
isWhiteSpace_(c) {
return c == ' ' || c == '\t' || c == '\r' || c == '\n';
};
}
/**
* @return {string} Next string character.
* @private
*/
Lexer.prototype.nextChar_ = function() {
nextChar_() {
return this.wkt.charAt(++this.index_);
};
}
/**
* Fetch and return the next token.
* @return {!module:ol/format/WKT~Token} Next string token.
*/
Lexer.prototype.nextToken = function() {
nextToken() {
const c = this.nextChar_();
const token = {position: this.index_, value: c};
@@ -163,14 +159,13 @@ Lexer.prototype.nextToken = function() {
}
return token;
};
}
/**
* @return {number} Numeric token value.
* @private
*/
Lexer.prototype.readNumber_ = function() {
readNumber_() {
let c;
const index = this.index_;
let decimal = false;
@@ -192,29 +187,29 @@ Lexer.prototype.readNumber_ = function() {
scientificNotation && (c == '-' || c == '+')
);
return parseFloat(this.wkt.substring(index, this.index_--));
};
}
/**
* @return {string} String token value.
* @private
*/
Lexer.prototype.readText_ = function() {
readText_() {
let c;
const index = this.index_;
do {
c = this.nextChar_();
} while (this.isAlpha_(c));
return this.wkt.substring(index, this.index_--).toUpperCase();
};
}
}
/**
* Class to parse the tokens from the WKT string.
* @param {module:ol/format/WKT~Lexer} lexer The lexer.
* @constructor
*/
const Parser = function(lexer) {
class Parser {
constructor(lexer) {
/**
* @type {module:ol/format/WKT~Lexer}
@@ -233,59 +228,55 @@ const Parser = function(lexer) {
* @private
*/
this.layout_ = GeometryLayout.XY;
};
}
/**
* Fetch the next token form the lexer and replace the active token.
* @private
*/
Parser.prototype.consume_ = function() {
consume_() {
this.token_ = this.lexer_.nextToken();
};
}
/**
* Tests if the given type matches the type of the current token.
* @param {module:ol/format/WKT~TokenType} type Token type.
* @return {boolean} Whether the token matches the given type.
*/
Parser.prototype.isTokenType = function(type) {
isTokenType(type) {
const isMatch = this.token_.type == type;
return isMatch;
};
}
/**
* If the given type matches the current token, consume it.
* @param {module:ol/format/WKT~TokenType} type Token type.
* @return {boolean} Whether the token matches the given type.
*/
Parser.prototype.match = function(type) {
match(type) {
const isMatch = this.isTokenType(type);
if (isMatch) {
this.consume_();
}
return isMatch;
};
}
/**
* Try to parse the tokens provided by the lexer.
* @return {module:ol/geom/Geometry} The geometry.
*/
Parser.prototype.parse = function() {
parse() {
this.consume_();
const geometry = this.parseGeometry_();
return geometry;
};
}
/**
* Try to parse the dimensional info.
* @return {module:ol/geom/GeometryLayout} The layout.
* @private
*/
Parser.prototype.parseGeometryLayout_ = function() {
parseGeometryLayout_() {
let layout = GeometryLayout.XY;
const dimToken = this.token_;
if (this.isTokenType(TokenType.TEXT)) {
@@ -302,14 +293,13 @@ Parser.prototype.parseGeometryLayout_ = function() {
}
}
return layout;
};
}
/**
* @return {!Array.<module:ol/geom/Geometry>} A collection of geometries.
* @private
*/
Parser.prototype.parseGeometryCollectionText_ = function() {
parseGeometryCollectionText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const geometries = [];
do {
@@ -322,14 +312,13 @@ Parser.prototype.parseGeometryCollectionText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
* @return {Array.<number>} All values in a point.
* @private
*/
Parser.prototype.parsePointText_ = function() {
parsePointText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parsePoint_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -339,14 +328,13 @@ Parser.prototype.parsePointText_ = function() {
return null;
}
throw new Error(this.formatErrorMessage_());
};
}
/**
* @return {!Array.<!Array.<number>>} All points in a linestring.
* @private
*/
Parser.prototype.parseLineStringText_ = function() {
parseLineStringText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parsePointList_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -356,14 +344,13 @@ Parser.prototype.parseLineStringText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
* @return {!Array.<!Array.<number>>} All points in a polygon.
* @private
*/
Parser.prototype.parsePolygonText_ = function() {
parsePolygonText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parseLineStringTextList_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -373,14 +360,13 @@ Parser.prototype.parsePolygonText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
* @return {!Array.<!Array.<number>>} All points in a multipoint.
* @private
*/
Parser.prototype.parseMultiPointText_ = function() {
parseMultiPointText_() {
if (this.match(TokenType.LEFT_PAREN)) {
let coordinates;
if (this.token_.type == TokenType.LEFT_PAREN) {
@@ -395,15 +381,14 @@ Parser.prototype.parseMultiPointText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
* @return {!Array.<!Array.<number>>} All linestring points
* in a multilinestring.
* @private
*/
Parser.prototype.parseMultiLineStringText_ = function() {
parseMultiLineStringText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parseLineStringTextList_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -413,14 +398,13 @@ Parser.prototype.parseMultiLineStringText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
* @return {!Array.<!Array.<number>>} All polygon points in a multipolygon.
* @private
*/
Parser.prototype.parseMultiPolygonText_ = function() {
parseMultiPolygonText_() {
if (this.match(TokenType.LEFT_PAREN)) {
const coordinates = this.parsePolygonTextList_();
if (this.match(TokenType.RIGHT_PAREN)) {
@@ -430,14 +414,13 @@ Parser.prototype.parseMultiPolygonText_ = function() {
return [];
}
throw new Error(this.formatErrorMessage_());
};
}
/**
* @return {!Array.<number>} A point.
* @private
*/
Parser.prototype.parsePoint_ = function() {
parsePoint_() {
const coordinates = [];
const dimensions = this.layout_.length;
for (let i = 0; i < dimensions; ++i) {
@@ -452,85 +435,111 @@ Parser.prototype.parsePoint_ = function() {
return coordinates;
}
throw new Error(this.formatErrorMessage_());
};
}
/**
* @return {!Array.<!Array.<number>>} An array of points.
* @private
*/
Parser.prototype.parsePointList_ = function() {
parsePointList_() {
const coordinates = [this.parsePoint_()];
while (this.match(TokenType.COMMA)) {
coordinates.push(this.parsePoint_());
}
return coordinates;
};
}
/**
* @return {!Array.<!Array.<number>>} An array of points.
* @private
*/
Parser.prototype.parsePointTextList_ = function() {
parsePointTextList_() {
const coordinates = [this.parsePointText_()];
while (this.match(TokenType.COMMA)) {
coordinates.push(this.parsePointText_());
}
return coordinates;
};
}
/**
* @return {!Array.<!Array.<number>>} An array of points.
* @private
*/
Parser.prototype.parseLineStringTextList_ = function() {
parseLineStringTextList_() {
const coordinates = [this.parseLineStringText_()];
while (this.match(TokenType.COMMA)) {
coordinates.push(this.parseLineStringText_());
}
return coordinates;
};
}
/**
* @return {!Array.<!Array.<number>>} An array of points.
* @private
*/
Parser.prototype.parsePolygonTextList_ = function() {
parsePolygonTextList_() {
const coordinates = [this.parsePolygonText_()];
while (this.match(TokenType.COMMA)) {
coordinates.push(this.parsePolygonText_());
}
return coordinates;
};
}
/**
* @return {boolean} Whether the token implies an empty geometry.
* @private
*/
Parser.prototype.isEmptyGeometry_ = function() {
isEmptyGeometry_() {
const isEmpty = this.isTokenType(TokenType.TEXT) &&
this.token_.value == EMPTY;
if (isEmpty) {
this.consume_();
}
return isEmpty;
};
}
/**
* Create an error message for an unexpected token error.
* @return {string} Error message.
* @private
*/
Parser.prototype.formatErrorMessage_ = function() {
formatErrorMessage_() {
return 'Unexpected `' + this.token_.value + '` at position ' +
this.token_.position + ' in `' + this.lexer_.wkt + '`';
};
}
/**
* @return {!module:ol/geom/Geometry} The geometry.
* @private
*/
parseGeometry_() {
const token = this.token_;
if (this.match(TokenType.TEXT)) {
const geomType = token.value;
this.layout_ = this.parseGeometryLayout_();
if (geomType == GeometryType.GEOMETRY_COLLECTION.toUpperCase()) {
const geometries = this.parseGeometryCollectionText_();
return new GeometryCollection(geometries);
} else {
const parser = GeometryParser[geomType];
const ctor = GeometryConstructor[geomType];
if (!parser || !ctor) {
throw new Error('Invalid geometry type: ' + geomType);
}
let coordinates = parser.call(this);
if (!coordinates) {
if (ctor === GeometryConstructor[GeometryType.POINT]) {
coordinates = [NaN, NaN];
} else {
coordinates = [];
}
}
return new ctor(coordinates, this.layout_);
}
}
throw new Error(this.formatErrorMessage_());
}
}
/**
* @classdesc
@@ -542,7 +551,8 @@ Parser.prototype.formatErrorMessage_ = function() {
* @param {module:ol/format/WKT~Options=} opt_options Options.
* @api
*/
const WKT = function(opt_options) {
class WKT {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -556,7 +566,104 @@ const WKT = function(opt_options) {
this.splitCollection_ = options.splitCollection !== undefined ?
options.splitCollection : false;
};
}
/**
* Parse a WKT string.
* @param {string} wkt WKT string.
* @return {module:ol/geom/Geometry|undefined}
* The geometry created.
* @private
*/
parse_(wkt) {
const lexer = new Lexer(wkt);
const parser = new Parser(lexer);
return parser.parse();
}
/**
* @inheritDoc
*/
readFeatureFromText(text, opt_options) {
const geom = this.readGeometryFromText(text, opt_options);
if (geom) {
const feature = new Feature();
feature.setGeometry(geom);
return feature;
}
return null;
}
/**
* @inheritDoc
*/
readFeaturesFromText(text, opt_options) {
let geometries = [];
const geometry = this.readGeometryFromText(text, opt_options);
if (this.splitCollection_ &&
geometry.getType() == GeometryType.GEOMETRY_COLLECTION) {
geometries = (/** @type {module:ol/geom/GeometryCollection} */ (geometry))
.getGeometriesArray();
} else {
geometries = [geometry];
}
const features = [];
for (let i = 0, ii = geometries.length; i < ii; ++i) {
const feature = new Feature();
feature.setGeometry(geometries[i]);
features.push(feature);
}
return features;
}
/**
* @inheritDoc
*/
readGeometryFromText(text, opt_options) {
const geometry = this.parse_(text);
if (geometry) {
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(geometry, false, opt_options))
);
} else {
return null;
}
}
/**
* @inheritDoc
*/
writeFeatureText(feature, opt_options) {
const geometry = feature.getGeometry();
if (geometry) {
return this.writeGeometryText(geometry, opt_options);
}
return '';
}
/**
* @inheritDoc
*/
writeFeaturesText(features, opt_options) {
if (features.length == 1) {
return this.writeFeatureText(features[0], opt_options);
}
const geometries = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
geometries.push(features[i].getGeometry());
}
const collection = new GeometryCollection(geometries);
return this.writeGeometryText(collection, opt_options);
}
/**
* @inheritDoc
*/
writeGeometryText(geometry, opt_options) {
return encode(/** @type {module:ol/geom/Geometry} */ (
transformWithOptions(geometry, true, opt_options)));
}
}
inherits(WKT, TextFeature);
@@ -712,20 +819,6 @@ function encode(geom) {
}
/**
* Parse a WKT string.
* @param {string} wkt WKT string.
* @return {module:ol/geom/Geometry|undefined}
* The geometry created.
* @private
*/
WKT.prototype.parse_ = function(wkt) {
const lexer = new Lexer(wkt);
const parser = new Parser(lexer);
return parser.parse();
};
/**
* Read a feature from a WKT source.
*
@@ -738,20 +831,6 @@ WKT.prototype.parse_ = function(wkt) {
WKT.prototype.readFeature;
/**
* @inheritDoc
*/
WKT.prototype.readFeatureFromText = function(text, opt_options) {
const geom = this.readGeometryFromText(text, opt_options);
if (geom) {
const feature = new Feature();
feature.setGeometry(geom);
return feature;
}
return null;
};
/**
* Read all features from a WKT source.
*
@@ -764,29 +843,6 @@ WKT.prototype.readFeatureFromText = function(text, opt_options) {
WKT.prototype.readFeatures;
/**
* @inheritDoc
*/
WKT.prototype.readFeaturesFromText = function(text, opt_options) {
let geometries = [];
const geometry = this.readGeometryFromText(text, opt_options);
if (this.splitCollection_ &&
geometry.getType() == GeometryType.GEOMETRY_COLLECTION) {
geometries = (/** @type {module:ol/geom/GeometryCollection} */ (geometry))
.getGeometriesArray();
} else {
geometries = [geometry];
}
const features = [];
for (let i = 0, ii = geometries.length; i < ii; ++i) {
const feature = new Feature();
feature.setGeometry(geometries[i]);
features.push(feature);
}
return features;
};
/**
* Read a single geometry from a WKT source.
*
@@ -799,21 +855,6 @@ WKT.prototype.readFeaturesFromText = function(text, opt_options) {
WKT.prototype.readGeometry;
/**
* @inheritDoc
*/
WKT.prototype.readGeometryFromText = function(text, opt_options) {
const geometry = this.parse_(text);
if (geometry) {
return (
/** @type {module:ol/geom/Geometry} */ (transformWithOptions(geometry, false, opt_options))
);
} else {
return null;
}
};
/**
* @enum {function (new:module:ol/geom/Geometry, Array, module:ol/geom/GeometryLayout)}
*/
@@ -840,39 +881,6 @@ const GeometryParser = {
};
/**
* @return {!module:ol/geom/Geometry} The geometry.
* @private
*/
Parser.prototype.parseGeometry_ = function() {
const token = this.token_;
if (this.match(TokenType.TEXT)) {
const geomType = token.value;
this.layout_ = this.parseGeometryLayout_();
if (geomType == GeometryType.GEOMETRY_COLLECTION.toUpperCase()) {
const geometries = this.parseGeometryCollectionText_();
return new GeometryCollection(geometries);
} else {
const parser = GeometryParser[geomType];
const ctor = GeometryConstructor[geomType];
if (!parser || !ctor) {
throw new Error('Invalid geometry type: ' + geomType);
}
let coordinates = parser.call(this);
if (!coordinates) {
if (ctor === GeometryConstructor[GeometryType.POINT]) {
coordinates = [NaN, NaN];
} else {
coordinates = [];
}
}
return new ctor(coordinates, this.layout_);
}
}
throw new Error(this.formatErrorMessage_());
};
/**
* Encode a feature as a WKT string.
*
@@ -885,18 +893,6 @@ Parser.prototype.parseGeometry_ = function() {
WKT.prototype.writeFeature;
/**
* @inheritDoc
*/
WKT.prototype.writeFeatureText = function(feature, opt_options) {
const geometry = feature.getGeometry();
if (geometry) {
return this.writeGeometryText(geometry, opt_options);
}
return '';
};
/**
* Encode an array of features as a WKT string.
*
@@ -909,22 +905,6 @@ WKT.prototype.writeFeatureText = function(feature, opt_options) {
WKT.prototype.writeFeatures;
/**
* @inheritDoc
*/
WKT.prototype.writeFeaturesText = function(features, opt_options) {
if (features.length == 1) {
return this.writeFeatureText(features[0], opt_options);
}
const geometries = [];
for (let i = 0, ii = features.length; i < ii; ++i) {
geometries.push(features[i].getGeometry());
}
const collection = new GeometryCollection(geometries);
return this.writeGeometryText(collection, opt_options);
};
/**
* Write a single geometry as a WKT string.
*
@@ -937,13 +917,4 @@ WKT.prototype.writeFeaturesText = function(features, opt_options) {
WKT.prototype.writeGeometry;
/**
* @inheritDoc
*/
WKT.prototype.writeGeometryText = function(geometry, opt_options) {
return encode(/** @type {module:ol/geom/Geometry} */ (
transformWithOptions(geometry, true, opt_options)));
};
export default WKT;
src/ol/format/WMSCapabilities.js
+27 -27
View File
@@ -17,7 +17,8 @@ import {makeArrayPusher, makeObjectPropertyPusher, makeObjectPropertySetter,
* @extends {module:ol/format/XML}
* @api
*/
const WMSCapabilities = function() {
class WMSCapabilities {
constructor() {
XML.call(this);
@@ -25,7 +26,31 @@ const WMSCapabilities = function() {
* @type {string|undefined}
*/
this.version = undefined;
};
}
/**
* @inheritDoc
*/
readFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
}
/**
* @inheritDoc
*/
readFromNode(node) {
this.version = node.getAttribute('version').trim();
const wmsCapabilityObject = pushParseAndPop({
'version': this.version
}, PARSERS, node, []);
return wmsCapabilityObject ? wmsCapabilityObject : null;
}
}
inherits(WMSCapabilities, XML);
@@ -277,31 +302,6 @@ const KEYWORDLIST_PARSERS = makeStructureNS(
WMSCapabilities.prototype.read;
/**
* @inheritDoc
*/
WMSCapabilities.prototype.readFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
};
/**
* @inheritDoc
*/
WMSCapabilities.prototype.readFromNode = function(node) {
this.version = node.getAttribute('version').trim();
const wmsCapabilityObject = pushParseAndPop({
'version': this.version
}, PARSERS, node, []);
return wmsCapabilityObject ? wmsCapabilityObject : null;
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
src/ol/format/WMSGetFeatureInfo.js
+55 -58
View File
@@ -25,7 +25,8 @@ import {makeArrayPusher, makeStructureNS, pushParseAndPop} from '../xml.js';
* @param {module:ol/format/WMSGetFeatureInfo~Options=} opt_options Options.
* @api
*/
const WMSGetFeatureInfo = function(opt_options) {
class WMSGetFeatureInfo {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -50,40 +51,21 @@ const WMSGetFeatureInfo = function(opt_options) {
this.layers_ = options.layers ? options.layers : null;
XMLFeature.call(this);
};
inherits(WMSGetFeatureInfo, XMLFeature);
/**
* @const
* @type {string}
*/
const featureIdentifier = '_feature';
/**
* @const
* @type {string}
*/
const layerIdentifier = '_layer';
}
/**
* @return {Array.<string>} layers
*/
WMSGetFeatureInfo.prototype.getLayers = function() {
getLayers() {
return this.layers_;
};
}
/**
* @param {Array.<string>} layers Layers to parse.
*/
WMSGetFeatureInfo.prototype.setLayers = function(layers) {
setLayers(layers) {
this.layers_ = layers;
};
}
/**
* @param {Node} node Node.
@@ -91,7 +73,7 @@ WMSGetFeatureInfo.prototype.setLayers = function(layers) {
* @return {Array.<module:ol/Feature>} Features.
* @private
*/
WMSGetFeatureInfo.prototype.readFeatures_ = function(node, objectStack) {
readFeatures_(node, objectStack) {
node.setAttribute('namespaceURI', this.featureNS_);
const localName = node.localName;
/** @type {Array.<module:ol/Feature>} */
@@ -142,7 +124,53 @@ WMSGetFeatureInfo.prototype.readFeatures_ = function(node, objectStack) {
}
}
return features;
};
}
/**
* @inheritDoc
*/
readFeaturesFromNode(node, opt_options) {
const options = {};
if (opt_options) {
assign(options, this.getReadOptions(node, opt_options));
}
return this.readFeatures_(node, [options]);
}
/**
* Not implemented.
* @inheritDoc
*/
writeFeatureNode(feature, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeFeaturesNode(features, opt_options) {}
/**
* Not implemented.
* @inheritDoc
*/
writeGeometryNode(geometry, opt_options) {}
}
inherits(WMSGetFeatureInfo, XMLFeature);
/**
* @const
* @type {string}
*/
const featureIdentifier = '_feature';
/**
* @const
* @type {string}
*/
const layerIdentifier = '_layer';
/**
@@ -157,35 +185,4 @@ WMSGetFeatureInfo.prototype.readFeatures_ = function(node, objectStack) {
WMSGetFeatureInfo.prototype.readFeatures;
/**
* @inheritDoc
*/
WMSGetFeatureInfo.prototype.readFeaturesFromNode = function(node, opt_options) {
const options = {};
if (opt_options) {
assign(options, this.getReadOptions(node, opt_options));
}
return this.readFeatures_(node, [options]);
};
/**
* Not implemented.
* @inheritDoc
*/
WMSGetFeatureInfo.prototype.writeFeatureNode = function(feature, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
WMSGetFeatureInfo.prototype.writeFeaturesNode = function(features, opt_options) {};
/**
* Not implemented.
* @inheritDoc
*/
WMSGetFeatureInfo.prototype.writeGeometryNode = function(geometry, opt_options) {};
export default WMSGetFeatureInfo;
src/ol/format/WMTSCapabilities.js
+30 -30
View File
@@ -18,7 +18,8 @@ import {pushParseAndPop, makeStructureNS,
* @extends {module:ol/format/XML}
* @api
*/
const WMTSCapabilities = function() {
class WMTSCapabilities {
constructor() {
XML.call(this);
/**
@@ -26,7 +27,34 @@ const WMTSCapabilities = function() {
* @private
*/
this.owsParser_ = new OWS();
};
}
/**
* @inheritDoc
*/
readFromDocument(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
}
/**
* @inheritDoc
*/
readFromNode(node) {
const version = node.getAttribute('version').trim();
let WMTSCapabilityObject = this.owsParser_.readFromNode(node);
if (!WMTSCapabilityObject) {
return null;
}
WMTSCapabilityObject['version'] = version;
WMTSCapabilityObject = pushParseAndPop(WMTSCapabilityObject, PARSERS, node, []);
return WMTSCapabilityObject ? WMTSCapabilityObject : null;
}
}
inherits(WMTSCapabilities, XML);
@@ -204,34 +232,6 @@ const TM_PARSERS = makeStructureNS(
WMTSCapabilities.prototype.read;
/**
* @inheritDoc
*/
WMTSCapabilities.prototype.readFromDocument = function(doc) {
for (let n = doc.firstChild; n; n = n.nextSibling) {
if (n.nodeType == Node.ELEMENT_NODE) {
return this.readFromNode(n);
}
}
return null;
};
/**
* @inheritDoc
*/
WMTSCapabilities.prototype.readFromNode = function(node) {
const version = node.getAttribute('version').trim();
let WMTSCapabilityObject = this.owsParser_.readFromNode(node);
if (!WMTSCapabilityObject) {
return null;
}
WMTSCapabilityObject['version'] = version;
WMTSCapabilityObject = pushParseAndPop(WMTSCapabilityObject, PARSERS, node, []);
return WMTSCapabilityObject ? WMTSCapabilityObject : null;
};
/**
* @param {Node} node Node.
* @param {Array.<*>} objectStack Object stack.
src/ol/format/XML.js
+7 -10
View File
@@ -11,15 +11,12 @@ import {isDocument, isNode, parse} from '../xml.js';
* @abstract
* @struct
*/
const XML = function() {
};
class XML {
/**
* @param {Document|Node|string} source Source.
* @return {Object} The parsed result.
*/
XML.prototype.read = function(source) {
read(source) {
if (isDocument(source)) {
return this.readFromDocument(/** @type {Document} */ (source));
} else if (isNode(source)) {
@@ -30,21 +27,21 @@ XML.prototype.read = function(source) {
} else {
return null;
}
};
}
/**
* @abstract
* @param {Document} doc Document.
* @return {Object} Object
*/
XML.prototype.readFromDocument = function(doc) {};
readFromDocument(doc) {}
/**
* @abstract
* @param {Node} node Node.
* @return {Object} Object
*/
XML.prototype.readFromNode = function(node) {};
readFromNode(node) {}
}
export default XML;
src/ol/format/XMLFeature.js
+45 -60
View File
@@ -17,7 +17,8 @@ import {isDocument, isNode, parse} from '../xml.js';
* @abstract
* @extends {module:ol/format/Feature}
*/
const XMLFeature = function() {
class XMLFeature {
constructor() {
/**
* @type {XMLSerializer}
@@ -26,23 +27,19 @@ const XMLFeature = function() {
this.xmlSerializer_ = new XMLSerializer();
FeatureFormat.call(this);
};
inherits(XMLFeature, FeatureFormat);
}
/**
* @inheritDoc
*/
XMLFeature.prototype.getType = function() {
getType() {
return FormatType.XML;
};
}
/**
* @inheritDoc
*/
XMLFeature.prototype.readFeature = function(source, opt_options) {
readFeature(source, opt_options) {
if (isDocument(source)) {
return this.readFeatureFromDocument(/** @type {Document} */ (source), opt_options);
} else if (isNode(source)) {
@@ -53,38 +50,35 @@ XMLFeature.prototype.readFeature = function(source, opt_options) {
} else {
return null;
}
};
}
/**
* @param {Document} doc Document.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {module:ol/Feature} Feature.
*/
XMLFeature.prototype.readFeatureFromDocument = function(doc, opt_options) {
readFeatureFromDocument(doc, opt_options) {
const features = this.readFeaturesFromDocument(doc, opt_options);
if (features.length > 0) {
return features[0];
} else {
return null;
}
};
}
/**
* @param {Node} node Node.
* @param {module:ol/format/Feature~ReadOptions=} opt_options Options.
* @return {module:ol/Feature} Feature.
*/
XMLFeature.prototype.readFeatureFromNode = function(node, opt_options) {
readFeatureFromNode(node, opt_options) {
return null; // not implemented
};
}
/**
* @inheritDoc
*/
XMLFeature.prototype.readFeatures = function(source, opt_options) {
readFeatures(source, opt_options) {
if (isDocument(source)) {
return this.readFeaturesFromDocument(
/** @type {Document} */ (source), opt_options);
@@ -96,8 +90,7 @@ XMLFeature.prototype.readFeatures = function(source, opt_options) {
} else {
return [];
}
};
}
/**
* @param {Document} doc Document.
@@ -105,7 +98,7 @@ XMLFeature.prototype.readFeatures = function(source, opt_options) {
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
XMLFeature.prototype.readFeaturesFromDocument = function(doc, opt_options) {
readFeaturesFromDocument(doc, opt_options) {
/** @type {Array.<module:ol/Feature>} */
const features = [];
for (let n = doc.firstChild; n; n = n.nextSibling) {
@@ -114,8 +107,7 @@ XMLFeature.prototype.readFeaturesFromDocument = function(doc, opt_options) {
}
}
return features;
};
}
/**
* @abstract
@@ -124,13 +116,12 @@ XMLFeature.prototype.readFeaturesFromDocument = function(doc, opt_options) {
* @protected
* @return {Array.<module:ol/Feature>} Features.
*/
XMLFeature.prototype.readFeaturesFromNode = function(node, opt_options) {};
readFeaturesFromNode(node, opt_options) {}
/**
* @inheritDoc
*/
XMLFeature.prototype.readGeometry = function(source, opt_options) {
readGeometry(source, opt_options) {
if (isDocument(source)) {
return this.readGeometryFromDocument(
/** @type {Document} */ (source), opt_options);
@@ -142,8 +133,7 @@ XMLFeature.prototype.readGeometry = function(source, opt_options) {
} else {
return null;
}
};
}
/**
* @param {Document} doc Document.
@@ -151,10 +141,9 @@ XMLFeature.prototype.readGeometry = function(source, opt_options) {
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
XMLFeature.prototype.readGeometryFromDocument = function(doc, opt_options) {
readGeometryFromDocument(doc, opt_options) {
return null; // not implemented
};
}
/**
* @param {Node} node Node.
@@ -162,15 +151,14 @@ XMLFeature.prototype.readGeometryFromDocument = function(doc, opt_options) {
* @protected
* @return {module:ol/geom/Geometry} Geometry.
*/
XMLFeature.prototype.readGeometryFromNode = function(node, opt_options) {
readGeometryFromNode(node, opt_options) {
return null; // not implemented
};
}
/**
* @inheritDoc
*/
XMLFeature.prototype.readProjection = function(source) {
readProjection(source) {
if (isDocument(source)) {
return this.readProjectionFromDocument(/** @type {Document} */ (source));
} else if (isNode(source)) {
@@ -181,37 +169,33 @@ XMLFeature.prototype.readProjection = function(source) {
} else {
return null;
}
};
}
/**
* @param {Document} doc Document.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
XMLFeature.prototype.readProjectionFromDocument = function(doc) {
readProjectionFromDocument(doc) {
return this.dataProjection;
};
}
/**
* @param {Node} node Node.
* @protected
* @return {module:ol/proj/Projection} Projection.
*/
XMLFeature.prototype.readProjectionFromNode = function(node) {
readProjectionFromNode(node) {
return this.dataProjection;
};
}
/**
* @inheritDoc
*/
XMLFeature.prototype.writeFeature = function(feature, opt_options) {
writeFeature(feature, opt_options) {
const node = this.writeFeatureNode(feature, opt_options);
return this.xmlSerializer_.serializeToString(node);
};
}
/**
* @param {module:ol/Feature} feature Feature.
@@ -219,45 +203,46 @@ XMLFeature.prototype.writeFeature = function(feature, opt_options) {
* @protected
* @return {Node} Node.
*/
XMLFeature.prototype.writeFeatureNode = function(feature, opt_options) {
writeFeatureNode(feature, opt_options) {
return null; // not implemented
};
}
/**
* @inheritDoc
*/
XMLFeature.prototype.writeFeatures = function(features, opt_options) {
writeFeatures(features, opt_options) {
const node = this.writeFeaturesNode(features, opt_options);
return this.xmlSerializer_.serializeToString(node);
};
}
/**
* @param {Array.<module:ol/Feature>} features Features.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
*/
XMLFeature.prototype.writeFeaturesNode = function(features, opt_options) {
writeFeaturesNode(features, opt_options) {
return null; // not implemented
};
}
/**
* @inheritDoc
*/
XMLFeature.prototype.writeGeometry = function(geometry, opt_options) {
writeGeometry(geometry, opt_options) {
const node = this.writeGeometryNode(geometry, opt_options);
return this.xmlSerializer_.serializeToString(node);
};
}
/**
* @param {module:ol/geom/Geometry} geometry Geometry.
* @param {module:ol/format/Feature~WriteOptions=} opt_options Options.
* @return {Node} Node.
*/
XMLFeature.prototype.writeGeometryNode = function(geometry, opt_options) {
writeGeometryNode(geometry, opt_options) {
return null; // not implemented
};
}
}
inherits(XMLFeature, FeatureFormat);
export default XMLFeature;
src/ol/format/filter/Filter.js
+6 -4
View File
@@ -13,21 +13,23 @@
* @param {!string} tagName The XML tag name for this filter.
* @struct
*/
const Filter = function(tagName) {
class Filter {
constructor(tagName) {
/**
* @private
* @type {!string}
*/
this.tagName_ = tagName;
};
}
/**
* The XML tag name for a filter.
* @returns {!string} Name.
*/
Filter.prototype.getTagName = function() {
getTagName() {
return this.tagName_;
};
}
}
export default Filter;
src/ol/geom/Circle.js
+32 -44
View File
@@ -20,7 +20,8 @@ import {deflateCoordinate} from '../geom/flat/deflate.js';
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const Circle = function(center, opt_radius, opt_layout) {
class Circle {
constructor(center, opt_radius, opt_layout) {
SimpleGeometry.call(this);
if (opt_layout !== undefined && opt_radius === undefined) {
this.setFlatCoordinates(opt_layout, center);
@@ -28,10 +29,7 @@ const Circle = function(center, opt_radius, opt_layout) {
const radius = opt_radius ? opt_radius : 0;
this.setCenterAndRadius(center, radius, opt_layout);
}
};
inherits(Circle, SimpleGeometry);
}
/**
* Make a complete copy of the geometry.
@@ -39,15 +37,14 @@ inherits(Circle, SimpleGeometry);
* @override
* @api
*/
Circle.prototype.clone = function() {
clone() {
return new Circle(this.flatCoordinates.slice(), undefined, this.layout);
};
}
/**
* @inheritDoc
*/
Circle.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
const flatCoordinates = this.flatCoordinates;
const dx = x - flatCoordinates[0];
const dy = y - flatCoordinates[1];
@@ -70,78 +67,71 @@ Circle.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistanc
} else {
return minSquaredDistance;
}
};
}
/**
* @inheritDoc
*/
Circle.prototype.containsXY = function(x, y) {
containsXY(x, y) {
const flatCoordinates = this.flatCoordinates;
const dx = x - flatCoordinates[0];
const dy = y - flatCoordinates[1];
return dx * dx + dy * dy <= this.getRadiusSquared_();
};
}
/**
* Return the center of the circle as {@link module:ol/coordinate~Coordinate coordinate}.
* @return {module:ol/coordinate~Coordinate} Center.
* @api
*/
Circle.prototype.getCenter = function() {
getCenter() {
return this.flatCoordinates.slice(0, this.stride);
};
}
/**
* @inheritDoc
*/
Circle.prototype.computeExtent = function(extent) {
computeExtent(extent) {
const flatCoordinates = this.flatCoordinates;
const radius = flatCoordinates[this.stride] - flatCoordinates[0];
return createOrUpdate(
flatCoordinates[0] - radius, flatCoordinates[1] - radius,
flatCoordinates[0] + radius, flatCoordinates[1] + radius,
extent);
};
}
/**
* Return the radius of the circle.
* @return {number} Radius.
* @api
*/
Circle.prototype.getRadius = function() {
getRadius() {
return Math.sqrt(this.getRadiusSquared_());
};
}
/**
* @private
* @return {number} Radius squared.
*/
Circle.prototype.getRadiusSquared_ = function() {
getRadiusSquared_() {
const dx = this.flatCoordinates[this.stride] - this.flatCoordinates[0];
const dy = this.flatCoordinates[this.stride + 1] - this.flatCoordinates[1];
return dx * dx + dy * dy;
};
}
/**
* @inheritDoc
* @api
*/
Circle.prototype.getType = function() {
getType() {
return GeometryType.CIRCLE;
};
}
/**
* @inheritDoc
* @api
*/
Circle.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
const circleExtent = this.getExtent();
if (intersects(extent, circleExtent)) {
const center = this.getCenter();
@@ -157,15 +147,14 @@ Circle.prototype.intersectsExtent = function(extent) {
}
return false;
};
}
/**
* Set the center of the circle as {@link module:ol/coordinate~Coordinate coordinate}.
* @param {module:ol/coordinate~Coordinate} center Center.
* @api
*/
Circle.prototype.setCenter = function(center) {
setCenter(center) {
const stride = this.stride;
const radius = this.flatCoordinates[stride] - this.flatCoordinates[0];
const flatCoordinates = center.slice();
@@ -175,8 +164,7 @@ Circle.prototype.setCenter = function(center) {
}
this.setFlatCoordinates(this.layout, flatCoordinates);
this.changed();
};
}
/**
* Set the center (as {@link module:ol/coordinate~Coordinate coordinate}) and the radius (as
@@ -186,7 +174,7 @@ Circle.prototype.setCenter = function(center) {
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
Circle.prototype.setCenterAndRadius = function(center, radius, opt_layout) {
setCenterAndRadius(center, radius, opt_layout) {
this.setLayout(opt_layout, center, 0);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -201,30 +189,30 @@ Circle.prototype.setCenterAndRadius = function(center, radius, opt_layout) {
}
flatCoordinates.length = offset;
this.changed();
};
}
/**
* @inheritDoc
*/
Circle.prototype.getCoordinates = function() {};
getCoordinates() {}
/**
* @inheritDoc
*/
Circle.prototype.setCoordinates = function(coordinates, opt_layout) {};
setCoordinates(coordinates, opt_layout) {}
/**
* Set the radius of the circle. The radius is in the units of the projection.
* @param {number} radius Radius.
* @api
*/
Circle.prototype.setRadius = function(radius) {
setRadius(radius) {
this.flatCoordinates[this.stride] = this.flatCoordinates[0] + radius;
this.changed();
};
}
}
inherits(Circle, SimpleGeometry);
/**
src/ol/geom/Geometry.js
+42 -53
View File
@@ -25,7 +25,8 @@ import {create as createTransform, compose as composeTransform} from '../transfo
* @extends {module:ol/Object}
* @api
*/
const Geometry = function() {
class Geometry {
constructor() {
BaseObject.call(this);
@@ -59,24 +60,14 @@ const Geometry = function() {
*/
this.simplifiedGeometryRevision = 0;
};
inherits(Geometry, BaseObject);
/**
* @type {module:ol/transform~Transform}
*/
const tmpTransform = createTransform();
}
/**
* Make a complete copy of the geometry.
* @abstract
* @return {!module:ol/geom/Geometry} Clone.
*/
Geometry.prototype.clone = function() {};
clone() {}
/**
* @abstract
@@ -86,8 +77,7 @@ Geometry.prototype.clone = function() {};
* @param {number} minSquaredDistance Minimum squared distance.
* @return {number} Minimum squared distance.
*/
Geometry.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {};
closestPointXY(x, y, closestPoint, minSquaredDistance) {}
/**
* Return the closest point of the geometry to the passed point as
@@ -97,12 +87,11 @@ Geometry.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDista
* @return {module:ol/coordinate~Coordinate} Closest point.
* @api
*/
Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
getClosestPoint(point, opt_closestPoint) {
const closestPoint = opt_closestPoint ? opt_closestPoint : [NaN, NaN];
this.closestPointXY(point[0], point[1], closestPoint, Infinity);
return closestPoint;
};
}
/**
* Returns true if this geometry includes the specified coordinate. If the
@@ -111,10 +100,9 @@ Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
* @return {boolean} Contains coordinate.
* @api
*/
Geometry.prototype.intersectsCoordinate = function(coordinate) {
intersectsCoordinate(coordinate) {
return this.containsXY(coordinate[0], coordinate[1]);
};
}
/**
* @abstract
@@ -122,16 +110,7 @@ Geometry.prototype.intersectsCoordinate = function(coordinate) {
* @protected
* @return {module:ol/extent~Extent} extent Extent.
*/
Geometry.prototype.computeExtent = function(extent) {};
/**
* @param {number} x X.
* @param {number} y Y.
* @return {boolean} Contains (x, y).
*/
Geometry.prototype.containsXY = FALSE;
computeExtent(extent) {}
/**
* Get the extent of the geometry.
@@ -139,14 +118,13 @@ Geometry.prototype.containsXY = FALSE;
* @return {module:ol/extent~Extent} extent Extent.
* @api
*/
Geometry.prototype.getExtent = function(opt_extent) {
getExtent(opt_extent) {
if (this.extentRevision_ != this.getRevision()) {
this.extent_ = this.computeExtent(this.extent_);
this.extentRevision_ = this.getRevision();
}
return returnOrUpdate(this.extent_, opt_extent);
};
}
/**
* Rotate the geometry around a given coordinate. This modifies the geometry
@@ -156,8 +134,7 @@ Geometry.prototype.getExtent = function(opt_extent) {
* @param {module:ol/coordinate~Coordinate} anchor The rotation center.
* @api
*/
Geometry.prototype.rotate = function(angle, anchor) {};
rotate(angle, anchor) {}
/**
* Scale the geometry (with an optional origin). This modifies the geometry
@@ -170,8 +147,7 @@ Geometry.prototype.rotate = function(angle, anchor) {};
* of the geometry extent).
* @api
*/
Geometry.prototype.scale = function(sx, opt_sy, opt_anchor) {};
scale(sx, opt_sy, opt_anchor) {}
/**
* Create a simplified version of this geometry. For linestrings, this uses
@@ -185,10 +161,9 @@ Geometry.prototype.scale = function(sx, opt_sy, opt_anchor) {};
* geometry.
* @api
*/
Geometry.prototype.simplify = function(tolerance) {
simplify(tolerance) {
return this.getSimplifiedGeometry(tolerance * tolerance);
};
}
/**
* Create a simplified version of this geometry using the Douglas Peucker
@@ -198,16 +173,14 @@ Geometry.prototype.simplify = function(tolerance) {
* @param {number} squaredTolerance Squared tolerance.
* @return {module:ol/geom/Geometry} Simplified geometry.
*/
Geometry.prototype.getSimplifiedGeometry = function(squaredTolerance) {};
getSimplifiedGeometry(squaredTolerance) {}
/**
* Get the type of this geometry.
* @abstract
* @return {module:ol/geom/GeometryType} Geometry type.
*/
Geometry.prototype.getType = function() {};
getType() {}
/**
* Apply a transform function to each coordinate of the geometry.
@@ -217,8 +190,7 @@ Geometry.prototype.getType = function() {};
* @abstract
* @param {module:ol/proj~TransformFunction} transformFn Transform.
*/
Geometry.prototype.applyTransform = function(transformFn) {};
applyTransform(transformFn) {}
/**
* Test if the geometry and the passed extent intersect.
@@ -226,8 +198,7 @@ Geometry.prototype.applyTransform = function(transformFn) {};
* @param {module:ol/extent~Extent} extent Extent.
* @return {boolean} `true` if the geometry and the extent intersect.
*/
Geometry.prototype.intersectsExtent = function(extent) {};
intersectsExtent(extent) {}
/**
* Translate the geometry. This modifies the geometry coordinates in place. If
@@ -236,8 +207,7 @@ Geometry.prototype.intersectsExtent = function(extent) {};
* @param {number} deltaX Delta X.
* @param {number} deltaY Delta Y.
*/
Geometry.prototype.translate = function(deltaX, deltaY) {};
translate(deltaX, deltaY) {}
/**
* Transform each coordinate of the geometry from one coordinate reference
@@ -254,7 +224,7 @@ Geometry.prototype.translate = function(deltaX, deltaY) {};
* modified in place.
* @api
*/
Geometry.prototype.transform = function(source, destination) {
transform(source, destination) {
source = getProjection(source);
const transformFn = source.getUnits() == Units.TILE_PIXELS ?
function(inCoordinates, outCoordinates, stride) {
@@ -272,5 +242,24 @@ Geometry.prototype.transform = function(source, destination) {
getTransform(source, destination);
this.applyTransform(transformFn);
return this;
};
}
}
inherits(Geometry, BaseObject);
/**
* @type {module:ol/transform~Transform}
*/
const tmpTransform = createTransform();
/**
* @param {number} x X.
* @param {number} y Y.
* @return {boolean} Contains (x, y).
*/
Geometry.prototype.containsXY = FALSE;
export default Geometry;
src/ol/geom/GeometryCollection.js
+58 -73
View File
@@ -18,7 +18,8 @@ import {clear} from '../obj.js';
* @param {Array.<module:ol/geom/Geometry>=} opt_geometries Geometries.
* @api
*/
const GeometryCollection = function(opt_geometries) {
class GeometryCollection {
constructor(opt_geometries) {
Geometry.call(this);
@@ -29,28 +30,12 @@ const GeometryCollection = function(opt_geometries) {
this.geometries_ = opt_geometries ? opt_geometries : null;
this.listenGeometriesChange_();
};
inherits(GeometryCollection, Geometry);
/**
* @param {Array.<module:ol/geom/Geometry>} geometries Geometries.
* @return {Array.<module:ol/geom/Geometry>} Cloned geometries.
*/
function cloneGeometries(geometries) {
const clonedGeometries = [];
for (let i = 0, ii = geometries.length; i < ii; ++i) {
clonedGeometries.push(geometries[i].clone());
}
return clonedGeometries;
}
/**
* @private
*/
GeometryCollection.prototype.unlistenGeometriesChange_ = function() {
unlistenGeometriesChange_() {
if (!this.geometries_) {
return;
}
@@ -59,13 +44,12 @@ GeometryCollection.prototype.unlistenGeometriesChange_ = function() {
this.geometries_[i], EventType.CHANGE,
this.changed, this);
}
};
}
/**
* @private
*/
GeometryCollection.prototype.listenGeometriesChange_ = function() {
listenGeometriesChange_() {
if (!this.geometries_) {
return;
}
@@ -74,8 +58,7 @@ GeometryCollection.prototype.listenGeometriesChange_ = function() {
this.geometries_[i], EventType.CHANGE,
this.changed, this);
}
};
}
/**
* Make a complete copy of the geometry.
@@ -83,17 +66,16 @@ GeometryCollection.prototype.listenGeometriesChange_ = function() {
* @override
* @api
*/
GeometryCollection.prototype.clone = function() {
clone() {
const geometryCollection = new GeometryCollection(null);
geometryCollection.setGeometries(this.geometries_);
return geometryCollection;
};
}
/**
* @inheritDoc
*/
GeometryCollection.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -103,13 +85,12 @@ GeometryCollection.prototype.closestPointXY = function(x, y, closestPoint, minSq
x, y, closestPoint, minSquaredDistance);
}
return minSquaredDistance;
};
}
/**
* @inheritDoc
*/
GeometryCollection.prototype.containsXY = function(x, y) {
containsXY(x, y) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
if (geometries[i].containsXY(x, y)) {
@@ -117,44 +98,40 @@ GeometryCollection.prototype.containsXY = function(x, y) {
}
}
return false;
};
}
/**
* @inheritDoc
*/
GeometryCollection.prototype.computeExtent = function(extent) {
computeExtent(extent) {
createOrUpdateEmpty(extent);
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
extend(extent, geometries[i].getExtent());
}
return extent;
};
}
/**
* Return the geometries that make up this geometry collection.
* @return {Array.<module:ol/geom/Geometry>} Geometries.
* @api
*/
GeometryCollection.prototype.getGeometries = function() {
getGeometries() {
return cloneGeometries(this.geometries_);
};
}
/**
* @return {Array.<module:ol/geom/Geometry>} Geometries.
*/
GeometryCollection.prototype.getGeometriesArray = function() {
getGeometriesArray() {
return this.geometries_;
};
}
/**
* @inheritDoc
*/
GeometryCollection.prototype.getSimplifiedGeometry = function(squaredTolerance) {
getSimplifiedGeometry(squaredTolerance) {
if (this.simplifiedGeometryRevision != this.getRevision()) {
clear(this.simplifiedGeometryCache);
this.simplifiedGeometryMaxMinSquaredTolerance = 0;
@@ -190,23 +167,21 @@ GeometryCollection.prototype.getSimplifiedGeometry = function(squaredTolerance)
return this;
}
}
};
}
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.getType = function() {
getType() {
return GeometryType.GEOMETRY_COLLECTION;
};
}
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
if (geometries[i].intersectsExtent(extent)) {
@@ -214,35 +189,32 @@ GeometryCollection.prototype.intersectsExtent = function(extent) {
}
}
return false;
};
}
/**
* @return {boolean} Is empty.
*/
GeometryCollection.prototype.isEmpty = function() {
isEmpty() {
return this.geometries_.length === 0;
};
}
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.rotate = function(angle, anchor) {
rotate(angle, anchor) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
geometries[i].rotate(angle, anchor);
}
this.changed();
};
}
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.scale = function(sx, opt_sy, opt_anchor) {
scale(sx, opt_sy, opt_anchor) {
let anchor = opt_anchor;
if (!anchor) {
anchor = getCenter(this.getExtent());
@@ -252,42 +224,38 @@ GeometryCollection.prototype.scale = function(sx, opt_sy, opt_anchor) {
geometries[i].scale(sx, opt_sy, anchor);
}
this.changed();
};
}
/**
* Set the geometries that make up this geometry collection.
* @param {Array.<module:ol/geom/Geometry>} geometries Geometries.
* @api
*/
GeometryCollection.prototype.setGeometries = function(geometries) {
setGeometries(geometries) {
this.setGeometriesArray(cloneGeometries(geometries));
};
}
/**
* @param {Array.<module:ol/geom/Geometry>} geometries Geometries.
*/
GeometryCollection.prototype.setGeometriesArray = function(geometries) {
setGeometriesArray(geometries) {
this.unlistenGeometriesChange_();
this.geometries_ = geometries;
this.listenGeometriesChange_();
this.changed();
};
}
/**
* @inheritDoc
* @api
*/
GeometryCollection.prototype.applyTransform = function(transformFn) {
applyTransform(transformFn) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
geometries[i].applyTransform(transformFn);
}
this.changed();
};
}
/**
* Translate the geometry.
@@ -296,20 +264,37 @@ GeometryCollection.prototype.applyTransform = function(transformFn) {
* @override
* @api
*/
GeometryCollection.prototype.translate = function(deltaX, deltaY) {
translate(deltaX, deltaY) {
const geometries = this.geometries_;
for (let i = 0, ii = geometries.length; i < ii; ++i) {
geometries[i].translate(deltaX, deltaY);
}
this.changed();
};
}
/**
* @inheritDoc
*/
GeometryCollection.prototype.disposeInternal = function() {
disposeInternal() {
this.unlistenGeometriesChange_();
Geometry.prototype.disposeInternal.call(this);
};
}
}
inherits(GeometryCollection, Geometry);
/**
* @param {Array.<module:ol/geom/Geometry>} geometries Geometries.
* @return {Array.<module:ol/geom/Geometry>} Cloned geometries.
*/
function cloneGeometries(geometries) {
const clonedGeometries = [];
for (let i = 0, ii = geometries.length; i < ii; ++i) {
clonedGeometries.push(geometries[i].clone());
}
return clonedGeometries;
}
export default GeometryCollection;
src/ol/geom/LineString.js
+33 -43
View File
@@ -28,7 +28,8 @@ import {douglasPeucker} from '../geom/flat/simplify.js';
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const LineString = function(coordinates, opt_layout) {
class LineString {
constructor(coordinates, opt_layout) {
SimpleGeometry.call(this);
@@ -62,25 +63,21 @@ const LineString = function(coordinates, opt_layout) {
this.setCoordinates(coordinates, opt_layout);
}
};
inherits(LineString, SimpleGeometry);
}
/**
* Append the passed coordinate to the coordinates of the linestring.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @api
*/
LineString.prototype.appendCoordinate = function(coordinate) {
appendCoordinate(coordinate) {
if (!this.flatCoordinates) {
this.flatCoordinates = coordinate.slice();
} else {
extend(this.flatCoordinates, coordinate);
}
this.changed();
};
}
/**
* Make a complete copy of the geometry.
@@ -88,15 +85,14 @@ LineString.prototype.appendCoordinate = function(coordinate) {
* @override
* @api
*/
LineString.prototype.clone = function() {
clone() {
return new LineString(this.flatCoordinates.slice(), this.layout);
};
}
/**
* @inheritDoc
*/
LineString.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -108,8 +104,7 @@ LineString.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
return assignClosestPoint(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
this.maxDelta_, false, x, y, closestPoint, minSquaredDistance);
};
}
/**
* Iterate over each segment, calling the provided callback.
@@ -122,10 +117,9 @@ LineString.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
* @template T,S
* @api
*/
LineString.prototype.forEachSegment = function(callback) {
forEachSegment(callback) {
return forEachSegment(this.flatCoordinates, 0, this.flatCoordinates.length, this.stride, callback);
};
}
/**
* Returns the coordinate at `m` using linear interpolation, or `null` if no
@@ -141,7 +135,7 @@ LineString.prototype.forEachSegment = function(callback) {
* @return {module:ol/coordinate~Coordinate} Coordinate.
* @api
*/
LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
getCoordinateAtM(m, opt_extrapolate) {
if (this.layout != GeometryLayout.XYM &&
this.layout != GeometryLayout.XYZM) {
return null;
@@ -149,8 +143,7 @@ LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
const extrapolate = opt_extrapolate !== undefined ? opt_extrapolate : false;
return lineStringCoordinateAtM(this.flatCoordinates, 0,
this.flatCoordinates.length, this.stride, m, extrapolate);
};
}
/**
* Return the coordinates of the linestring.
@@ -158,11 +151,10 @@ LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
* @override
* @api
*/
LineString.prototype.getCoordinates = function() {
getCoordinates() {
return inflateCoordinates(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
* Return the coordinate at the provided fraction along the linestring.
@@ -174,67 +166,61 @@ LineString.prototype.getCoordinates = function() {
* @return {module:ol/coordinate~Coordinate} Coordinate of the interpolated point.
* @api
*/
LineString.prototype.getCoordinateAt = function(fraction, opt_dest) {
getCoordinateAt(fraction, opt_dest) {
return interpolatePoint(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
fraction, opt_dest);
};
}
/**
* Return the length of the linestring on projected plane.
* @return {number} Length (on projected plane).
* @api
*/
LineString.prototype.getLength = function() {
getLength() {
return lineStringLength(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
* @return {Array.<number>} Flat midpoint.
*/
LineString.prototype.getFlatMidpoint = function() {
getFlatMidpoint() {
if (this.flatMidpointRevision_ != this.getRevision()) {
this.flatMidpoint_ = this.getCoordinateAt(0.5, this.flatMidpoint_);
this.flatMidpointRevision_ = this.getRevision();
}
return this.flatMidpoint_;
};
}
/**
* @inheritDoc
*/
LineString.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
simplifiedFlatCoordinates.length = douglasPeucker(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
squaredTolerance, simplifiedFlatCoordinates, 0);
return new LineString(simplifiedFlatCoordinates, GeometryLayout.XY);
};
}
/**
* @inheritDoc
* @api
*/
LineString.prototype.getType = function() {
getType() {
return GeometryType.LINE_STRING;
};
}
/**
* @inheritDoc
* @api
*/
LineString.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return intersectsLineString(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
extent);
};
}
/**
* Set the coordinates of the linestring.
@@ -243,7 +229,7 @@ LineString.prototype.intersectsExtent = function(extent) {
* @override
* @api
*/
LineString.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 1);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -251,6 +237,10 @@ LineString.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates.length = deflateCoordinates(
this.flatCoordinates, 0, coordinates, this.stride);
this.changed();
};
}
}
inherits(LineString, SimpleGeometry);
export default LineString;
src/ol/geom/LinearRing.js
+23 -27
View File
@@ -25,7 +25,8 @@ import {douglasPeucker} from '../geom/flat/simplify.js';
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const LinearRing = function(coordinates, opt_layout) {
class LinearRing {
constructor(coordinates, opt_layout) {
SimpleGeometry.call(this);
@@ -47,10 +48,7 @@ const LinearRing = function(coordinates, opt_layout) {
this.setCoordinates(coordinates, opt_layout);
}
};
inherits(LinearRing, SimpleGeometry);
}
/**
* Make a complete copy of the geometry.
@@ -58,15 +56,14 @@ inherits(LinearRing, SimpleGeometry);
* @override
* @api
*/
LinearRing.prototype.clone = function() {
clone() {
return new LinearRing(this.flatCoordinates.slice(), this.layout);
};
}
/**
* @inheritDoc
*/
LinearRing.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -78,18 +75,16 @@ LinearRing.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
return assignClosestPoint(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
this.maxDelta_, true, x, y, closestPoint, minSquaredDistance);
};
}
/**
* Return the area of the linear ring on projected plane.
* @return {number} Area (on projected plane).
* @api
*/
LinearRing.prototype.getArea = function() {
getArea() {
return linearRingArea(this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
* Return the coordinates of the linear ring.
@@ -97,38 +92,34 @@ LinearRing.prototype.getArea = function() {
* @override
* @api
*/
LinearRing.prototype.getCoordinates = function() {
getCoordinates() {
return inflateCoordinates(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
* @inheritDoc
*/
LinearRing.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
simplifiedFlatCoordinates.length = douglasPeucker(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride,
squaredTolerance, simplifiedFlatCoordinates, 0);
return new LinearRing(simplifiedFlatCoordinates, GeometryLayout.XY);
};
}
/**
* @inheritDoc
* @api
*/
LinearRing.prototype.getType = function() {
getType() {
return GeometryType.LINEAR_RING;
};
}
/**
* @inheritDoc
*/
LinearRing.prototype.intersectsExtent = function(extent) {};
intersectsExtent(extent) {}
/**
* Set the coordinates of the linear ring.
@@ -137,7 +128,7 @@ LinearRing.prototype.intersectsExtent = function(extent) {};
* @override
* @api
*/
LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 1);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -145,5 +136,10 @@ LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates.length = deflateCoordinates(
this.flatCoordinates, 0, coordinates, this.stride);
this.changed();
};
}
}
inherits(LinearRing, SimpleGeometry);
export default LinearRing;
src/ol/geom/MultiLineString.js
+34 -43
View File
@@ -28,7 +28,8 @@ import {douglasPeuckerArray} from '../geom/flat/simplify.js';
* @param {Array.<number>} opt_ends Flat coordinate ends for internal use.
* @api
*/
const MultiLineString = function(coordinates, opt_layout, opt_ends) {
class MultiLineString {
constructor(coordinates, opt_layout, opt_ends) {
SimpleGeometry.call(this);
@@ -71,17 +72,14 @@ const MultiLineString = function(coordinates, opt_layout, opt_ends) {
this.ends_ = ends;
}
};
inherits(MultiLineString, SimpleGeometry);
}
/**
* Append the passed linestring to the multilinestring.
* @param {module:ol/geom/LineString} lineString LineString.
* @api
*/
MultiLineString.prototype.appendLineString = function(lineString) {
appendLineString(lineString) {
if (!this.flatCoordinates) {
this.flatCoordinates = lineString.getFlatCoordinates().slice();
} else {
@@ -89,8 +87,7 @@ MultiLineString.prototype.appendLineString = function(lineString) {
}
this.ends_.push(this.flatCoordinates.length);
this.changed();
};
}
/**
* Make a complete copy of the geometry.
@@ -98,15 +95,14 @@ MultiLineString.prototype.appendLineString = function(lineString) {
* @override
* @api
*/
MultiLineString.prototype.clone = function() {
clone() {
return new MultiLineString(this.flatCoordinates.slice(), this.layout, this.ends_.slice());
};
}
/**
* @inheritDoc
*/
MultiLineString.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -118,8 +114,7 @@ MultiLineString.prototype.closestPointXY = function(x, y, closestPoint, minSquar
return assignClosestArrayPoint(
this.flatCoordinates, 0, this.ends_, this.stride,
this.maxDelta_, false, x, y, closestPoint, minSquaredDistance);
};
}
/**
* Returns the coordinate at `m` using linear interpolation, or `null` if no
@@ -143,7 +138,7 @@ MultiLineString.prototype.closestPointXY = function(x, y, closestPoint, minSquar
* @return {module:ol/coordinate~Coordinate} Coordinate.
* @api
*/
MultiLineString.prototype.getCoordinateAtM = function(m, opt_extrapolate, opt_interpolate) {
getCoordinateAtM(m, opt_extrapolate, opt_interpolate) {
if ((this.layout != GeometryLayout.XYM &&
this.layout != GeometryLayout.XYZM) ||
this.flatCoordinates.length === 0) {
@@ -153,8 +148,7 @@ MultiLineString.prototype.getCoordinateAtM = function(m, opt_extrapolate, opt_in
const interpolate = opt_interpolate !== undefined ? opt_interpolate : false;
return lineStringsCoordinateAtM(this.flatCoordinates, 0,
this.ends_, this.stride, m, extrapolate, interpolate);
};
}
/**
* Return the coordinates of the multilinestring.
@@ -162,19 +156,17 @@ MultiLineString.prototype.getCoordinateAtM = function(m, opt_extrapolate, opt_in
* @override
* @api
*/
MultiLineString.prototype.getCoordinates = function() {
getCoordinates() {
return inflateCoordinatesArray(
this.flatCoordinates, 0, this.ends_, this.stride);
};
}
/**
* @return {Array.<number>} Ends.
*/
MultiLineString.prototype.getEnds = function() {
getEnds() {
return this.ends_;
};
}
/**
* Return the linestring at the specified index.
@@ -182,21 +174,20 @@ MultiLineString.prototype.getEnds = function() {
* @return {module:ol/geom/LineString} LineString.
* @api
*/
MultiLineString.prototype.getLineString = function(index) {
getLineString(index) {
if (index < 0 || this.ends_.length <= index) {
return null;
}
return new LineString(this.flatCoordinates.slice(
index === 0 ? 0 : this.ends_[index - 1], this.ends_[index]), this.layout);
};
}
/**
* Return the linestrings of this multilinestring.
* @return {Array.<module:ol/geom/LineString>} LineStrings.
* @api
*/
MultiLineString.prototype.getLineStrings = function() {
getLineStrings() {
const flatCoordinates = this.flatCoordinates;
const ends = this.ends_;
const layout = this.layout;
@@ -210,13 +201,12 @@ MultiLineString.prototype.getLineStrings = function() {
offset = end;
}
return lineStrings;
};
}
/**
* @return {Array.<number>} Flat midpoints.
*/
MultiLineString.prototype.getFlatMidpoints = function() {
getFlatMidpoints() {
const midpoints = [];
const flatCoordinates = this.flatCoordinates;
let offset = 0;
@@ -230,40 +220,36 @@ MultiLineString.prototype.getFlatMidpoints = function() {
offset = end;
}
return midpoints;
};
}
/**
* @inheritDoc
*/
MultiLineString.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
const simplifiedEnds = [];
simplifiedFlatCoordinates.length = douglasPeuckerArray(
this.flatCoordinates, 0, this.ends_, this.stride, squaredTolerance,
simplifiedFlatCoordinates, 0, simplifiedEnds);
return new MultiLineString(simplifiedFlatCoordinates, GeometryLayout.XY, simplifiedEnds);
};
}
/**
* @inheritDoc
* @api
*/
MultiLineString.prototype.getType = function() {
getType() {
return GeometryType.MULTI_LINE_STRING;
};
}
/**
* @inheritDoc
* @api
*/
MultiLineString.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return intersectsLineStringArray(
this.flatCoordinates, 0, this.ends_, this.stride, extent);
};
}
/**
* Set the coordinates of the multilinestring.
@@ -272,7 +258,7 @@ MultiLineString.prototype.intersectsExtent = function(extent) {
* @override
* @api
*/
MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 2);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -281,5 +267,10 @@ MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates, 0, coordinates, this.stride, this.ends_);
this.flatCoordinates.length = ends.length === 0 ? 0 : ends[ends.length - 1];
this.changed();
};
}
}
inherits(MultiLineString, SimpleGeometry);
export default MultiLineString;
src/ol/geom/MultiPoint.js
+26 -31
View File
@@ -23,32 +23,29 @@ import {squaredDistance as squaredDx} from '../math.js';
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const MultiPoint = function(coordinates, opt_layout) {
class MultiPoint {
constructor(coordinates, opt_layout) {
SimpleGeometry.call(this);
if (opt_layout && !Array.isArray(coordinates[0])) {
this.setFlatCoordinates(opt_layout, coordinates);
} else {
this.setCoordinates(coordinates, opt_layout);
}
};
inherits(MultiPoint, SimpleGeometry);
}
/**
* Append the passed point to this multipoint.
* @param {module:ol/geom/Point} point Point.
* @api
*/
MultiPoint.prototype.appendPoint = function(point) {
appendPoint(point) {
if (!this.flatCoordinates) {
this.flatCoordinates = point.getFlatCoordinates().slice();
} else {
extend(this.flatCoordinates, point.getFlatCoordinates());
}
this.changed();
};
}
/**
* Make a complete copy of the geometry.
@@ -56,16 +53,15 @@ MultiPoint.prototype.appendPoint = function(point) {
* @override
* @api
*/
MultiPoint.prototype.clone = function() {
clone() {
const multiPoint = new MultiPoint(this.flatCoordinates.slice(), this.layout);
return multiPoint;
};
}
/**
* @inheritDoc
*/
MultiPoint.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -83,8 +79,7 @@ MultiPoint.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
}
}
return minSquaredDistance;
};
}
/**
* Return the coordinates of the multipoint.
@@ -92,11 +87,10 @@ MultiPoint.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDis
* @override
* @api
*/
MultiPoint.prototype.getCoordinates = function() {
getCoordinates() {
return inflateCoordinates(
this.flatCoordinates, 0, this.flatCoordinates.length, this.stride);
};
}
/**
* Return the point at the specified index.
@@ -104,22 +98,21 @@ MultiPoint.prototype.getCoordinates = function() {
* @return {module:ol/geom/Point} Point.
* @api
*/
MultiPoint.prototype.getPoint = function(index) {
getPoint(index) {
const n = !this.flatCoordinates ? 0 : this.flatCoordinates.length / this.stride;
if (index < 0 || n <= index) {
return null;
}
return new Point(this.flatCoordinates.slice(
index * this.stride, (index + 1) * this.stride), this.layout);
};
}
/**
* Return the points of this multipoint.
* @return {Array.<module:ol/geom/Point>} Points.
* @api
*/
MultiPoint.prototype.getPoints = function() {
getPoints() {
const flatCoordinates = this.flatCoordinates;
const layout = this.layout;
const stride = this.stride;
@@ -130,23 +123,21 @@ MultiPoint.prototype.getPoints = function() {
points.push(point);
}
return points;
};
}
/**
* @inheritDoc
* @api
*/
MultiPoint.prototype.getType = function() {
getType() {
return GeometryType.MULTI_POINT;
};
}
/**
* @inheritDoc
* @api
*/
MultiPoint.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
const flatCoordinates = this.flatCoordinates;
const stride = this.stride;
for (let i = 0, ii = flatCoordinates.length; i < ii; i += stride) {
@@ -157,8 +148,7 @@ MultiPoint.prototype.intersectsExtent = function(extent) {
}
}
return false;
};
}
/**
* Set the coordinates of the multipoint.
@@ -167,7 +157,7 @@ MultiPoint.prototype.intersectsExtent = function(extent) {
* @override
* @api
*/
MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 1);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -175,5 +165,10 @@ MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates.length = deflateCoordinates(
this.flatCoordinates, 0, coordinates, this.stride);
this.changed();
};
}
}
inherits(MultiPoint, SimpleGeometry);
export default MultiPoint;
src/ol/geom/MultiPolygon.js
+38 -52
View File
@@ -34,7 +34,8 @@ import {quantizeMultiArray} from '../geom/flat/simplify.js';
* coordinates.
* @api
*/
const MultiPolygon = function(coordinates, opt_layout, opt_endss) {
class MultiPolygon {
constructor(coordinates, opt_layout, opt_endss) {
SimpleGeometry.call(this);
@@ -108,17 +109,14 @@ const MultiPolygon = function(coordinates, opt_layout, opt_endss) {
this.setCoordinates(coordinates, opt_layout);
}
};
inherits(MultiPolygon, SimpleGeometry);
}
/**
* Append the passed polygon to this multipolygon.
* @param {module:ol/geom/Polygon} polygon Polygon.
* @api
*/
MultiPolygon.prototype.appendPolygon = function(polygon) {
appendPolygon(polygon) {
/** @type {Array.<number>} */
let ends;
if (!this.flatCoordinates) {
@@ -135,8 +133,7 @@ MultiPolygon.prototype.appendPolygon = function(polygon) {
}
this.endss_.push(ends);
this.changed();
};
}
/**
* Make a complete copy of the geometry.
@@ -144,7 +141,7 @@ MultiPolygon.prototype.appendPolygon = function(polygon) {
* @override
* @api
*/
MultiPolygon.prototype.clone = function() {
clone() {
const len = this.endss_.length;
const newEndss = new Array(len);
for (let i = 0; i < len; ++i) {
@@ -153,13 +150,12 @@ MultiPolygon.prototype.clone = function() {
return new MultiPolygon(
this.flatCoordinates.slice(), this.layout, newEndss);
};
}
/**
* @inheritDoc
*/
MultiPolygon.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -171,26 +167,23 @@ MultiPolygon.prototype.closestPointXY = function(x, y, closestPoint, minSquaredD
return assignClosestMultiArrayPoint(
this.getOrientedFlatCoordinates(), 0, this.endss_, this.stride,
this.maxDelta_, true, x, y, closestPoint, minSquaredDistance);
};
}
/**
* @inheritDoc
*/
MultiPolygon.prototype.containsXY = function(x, y) {
containsXY(x, y) {
return linearRingssContainsXY(this.getOrientedFlatCoordinates(), 0, this.endss_, this.stride, x, y);
};
}
/**
* Return the area of the multipolygon on projected plane.
* @return {number} Area (on projected plane).
* @api
*/
MultiPolygon.prototype.getArea = function() {
getArea() {
return linearRingssArea(this.getOrientedFlatCoordinates(), 0, this.endss_, this.stride);
};
}
/**
* Get the coordinate array for this geometry. This array has the structure
@@ -206,7 +199,7 @@ MultiPolygon.prototype.getArea = function() {
* @override
* @api
*/
MultiPolygon.prototype.getCoordinates = function(opt_right) {
getCoordinates(opt_right) {
let flatCoordinates;
if (opt_right !== undefined) {
flatCoordinates = this.getOrientedFlatCoordinates().slice();
@@ -218,21 +211,19 @@ MultiPolygon.prototype.getCoordinates = function(opt_right) {
return inflateMultiCoordinatesArray(
flatCoordinates, 0, this.endss_, this.stride);
};
}
/**
* @return {Array.<Array.<number>>} Endss.
*/
MultiPolygon.prototype.getEndss = function() {
getEndss() {
return this.endss_;
};
}
/**
* @return {Array.<number>} Flat interior points.
*/
MultiPolygon.prototype.getFlatInteriorPoints = function() {
getFlatInteriorPoints() {
if (this.flatInteriorPointsRevision_ != this.getRevision()) {
const flatCenters = linearRingssCenter(
this.flatCoordinates, 0, this.endss_, this.stride);
@@ -242,8 +233,7 @@ MultiPolygon.prototype.getFlatInteriorPoints = function() {
this.flatInteriorPointsRevision_ = this.getRevision();
}
return this.flatInteriorPoints_;
};
}
/**
* Return the interior points as {@link module:ol/geom/MultiPoint multipoint}.
@@ -251,15 +241,14 @@ MultiPolygon.prototype.getFlatInteriorPoints = function() {
* the length of the horizontal intersection that the point belongs to.
* @api
*/
MultiPolygon.prototype.getInteriorPoints = function() {
getInteriorPoints() {
return new MultiPoint(this.getFlatInteriorPoints().slice(), GeometryLayout.XYM);
};
}
/**
* @return {Array.<number>} Oriented flat coordinates.
*/
MultiPolygon.prototype.getOrientedFlatCoordinates = function() {
getOrientedFlatCoordinates() {
if (this.orientedRevision_ != this.getRevision()) {
const flatCoordinates = this.flatCoordinates;
if (linearRingsAreOriented(
@@ -274,13 +263,12 @@ MultiPolygon.prototype.getOrientedFlatCoordinates = function() {
this.orientedRevision_ = this.getRevision();
}
return this.orientedFlatCoordinates_;
};
}
/**
* @inheritDoc
*/
MultiPolygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
const simplifiedEndss = [];
simplifiedFlatCoordinates.length = quantizeMultiArray(
@@ -288,8 +276,7 @@ MultiPolygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance
Math.sqrt(squaredTolerance),
simplifiedFlatCoordinates, 0, simplifiedEndss);
return new MultiPolygon(simplifiedFlatCoordinates, GeometryLayout.XY, simplifiedEndss);
};
}
/**
* Return the polygon at the specified index.
@@ -297,7 +284,7 @@ MultiPolygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance
* @return {module:ol/geom/Polygon} Polygon.
* @api
*/
MultiPolygon.prototype.getPolygon = function(index) {
getPolygon(index) {
if (index < 0 || this.endss_.length <= index) {
return null;
}
@@ -316,15 +303,14 @@ MultiPolygon.prototype.getPolygon = function(index) {
}
}
return new Polygon(this.flatCoordinates.slice(offset, end), this.layout, ends);
};
}
/**
* Return the polygons of this multipolygon.
* @return {Array.<module:ol/geom/Polygon>} Polygons.
* @api
*/
MultiPolygon.prototype.getPolygons = function() {
getPolygons() {
const layout = this.layout;
const flatCoordinates = this.flatCoordinates;
const endss = this.endss_;
@@ -343,27 +329,24 @@ MultiPolygon.prototype.getPolygons = function() {
offset = end;
}
return polygons;
};
}
/**
* @inheritDoc
* @api
*/
MultiPolygon.prototype.getType = function() {
getType() {
return GeometryType.MULTI_POLYGON;
};
}
/**
* @inheritDoc
* @api
*/
MultiPolygon.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return intersectsLinearRingMultiArray(
this.getOrientedFlatCoordinates(), 0, this.endss_, this.stride, extent);
};
}
/**
* Set the coordinates of the multipolygon.
@@ -372,7 +355,7 @@ MultiPolygon.prototype.intersectsExtent = function(extent) {
* @override
* @api
*/
MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 3);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -387,7 +370,10 @@ MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) {
0 : lastEnds[lastEnds.length - 1];
}
this.changed();
};
}
}
inherits(MultiPolygon, SimpleGeometry);
export default MultiPolygon;
src/ol/geom/Point.js
+21 -25
View File
@@ -18,13 +18,11 @@ import {squaredDistance as squaredDx} from '../math.js';
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
* @api
*/
const Point = function(coordinates, opt_layout) {
class Point {
constructor(coordinates, opt_layout) {
SimpleGeometry.call(this);
this.setCoordinates(coordinates, opt_layout);
};
inherits(Point, SimpleGeometry);
}
/**
* Make a complete copy of the geometry.
@@ -32,16 +30,15 @@ inherits(Point, SimpleGeometry);
* @override
* @api
*/
Point.prototype.clone = function() {
clone() {
const point = new Point(this.flatCoordinates.slice(), this.layout);
return point;
};
}
/**
* @inheritDoc
*/
Point.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
const flatCoordinates = this.flatCoordinates;
const squaredDistance = squaredDx(x, y, flatCoordinates[0], flatCoordinates[1]);
if (squaredDistance < minSquaredDistance) {
@@ -54,8 +51,7 @@ Point.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance
} else {
return minSquaredDistance;
}
};
}
/**
* Return the coordinate of the point.
@@ -63,42 +59,38 @@ Point.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance
* @override
* @api
*/
Point.prototype.getCoordinates = function() {
getCoordinates() {
return !this.flatCoordinates ? [] : this.flatCoordinates.slice();
};
}
/**
* @inheritDoc
*/
Point.prototype.computeExtent = function(extent) {
computeExtent(extent) {
return createOrUpdateFromCoordinate(this.flatCoordinates, extent);
};
}
/**
* @inheritDoc
* @api
*/
Point.prototype.getType = function() {
getType() {
return GeometryType.POINT;
};
}
/**
* @inheritDoc
* @api
*/
Point.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return containsXY(extent, this.flatCoordinates[0], this.flatCoordinates[1]);
};
}
/**
* @inheritDoc
* @api
*/
Point.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 0);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -106,6 +98,10 @@ Point.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates.length = deflateCoordinate(
this.flatCoordinates, 0, coordinates, this.stride);
this.changed();
};
}
}
inherits(Point, SimpleGeometry);
export default Point;
src/ol/geom/Polygon.js
+41 -55
View File
@@ -39,7 +39,8 @@ import {modulo} from '../math.js';
* coordinates).
* @api
*/
const Polygon = function(coordinates, opt_layout, opt_ends) {
class Polygon {
constructor(coordinates, opt_layout, opt_ends) {
SimpleGeometry.call(this);
@@ -92,17 +93,14 @@ const Polygon = function(coordinates, opt_layout, opt_ends) {
this.setCoordinates(coordinates, opt_layout);
}
};
inherits(Polygon, SimpleGeometry);
}
/**
* Append the passed linear ring to this polygon.
* @param {module:ol/geom/LinearRing} linearRing Linear ring.
* @api
*/
Polygon.prototype.appendLinearRing = function(linearRing) {
appendLinearRing(linearRing) {
if (!this.flatCoordinates) {
this.flatCoordinates = linearRing.getFlatCoordinates().slice();
} else {
@@ -110,8 +108,7 @@ Polygon.prototype.appendLinearRing = function(linearRing) {
}
this.ends_.push(this.flatCoordinates.length);
this.changed();
};
}
/**
* Make a complete copy of the geometry.
@@ -119,15 +116,14 @@ Polygon.prototype.appendLinearRing = function(linearRing) {
* @override
* @api
*/
Polygon.prototype.clone = function() {
clone() {
return new Polygon(this.flatCoordinates.slice(), this.layout, this.ends_.slice());
};
}
/**
* @inheritDoc
*/
Polygon.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistance) {
closestPointXY(x, y, closestPoint, minSquaredDistance) {
if (minSquaredDistance < closestSquaredDistanceXY(this.getExtent(), x, y)) {
return minSquaredDistance;
}
@@ -139,26 +135,23 @@ Polygon.prototype.closestPointXY = function(x, y, closestPoint, minSquaredDistan
return assignClosestArrayPoint(
this.flatCoordinates, 0, this.ends_, this.stride,
this.maxDelta_, true, x, y, closestPoint, minSquaredDistance);
};
}
/**
* @inheritDoc
*/
Polygon.prototype.containsXY = function(x, y) {
containsXY(x, y) {
return linearRingsContainsXY(this.getOrientedFlatCoordinates(), 0, this.ends_, this.stride, x, y);
};
}
/**
* Return the area of the polygon on projected plane.
* @return {number} Area (on projected plane).
* @api
*/
Polygon.prototype.getArea = function() {
getArea() {
return linearRingsArea(this.getOrientedFlatCoordinates(), 0, this.ends_, this.stride);
};
}
/**
* Get the coordinate array for this geometry. This array has the structure
@@ -174,7 +167,7 @@ Polygon.prototype.getArea = function() {
* @override
* @api
*/
Polygon.prototype.getCoordinates = function(opt_right) {
getCoordinates(opt_right) {
let flatCoordinates;
if (opt_right !== undefined) {
flatCoordinates = this.getOrientedFlatCoordinates().slice();
@@ -186,21 +179,19 @@ Polygon.prototype.getCoordinates = function(opt_right) {
return inflateCoordinatesArray(
flatCoordinates, 0, this.ends_, this.stride);
};
}
/**
* @return {Array.<number>} Ends.
*/
Polygon.prototype.getEnds = function() {
getEnds() {
return this.ends_;
};
}
/**
* @return {Array.<number>} Interior point.
*/
Polygon.prototype.getFlatInteriorPoint = function() {
getFlatInteriorPoint() {
if (this.flatInteriorPointRevision_ != this.getRevision()) {
const flatCenter = getCenter(this.getExtent());
this.flatInteriorPoint_ = getInteriorPointOfArray(
@@ -209,8 +200,7 @@ Polygon.prototype.getFlatInteriorPoint = function() {
this.flatInteriorPointRevision_ = this.getRevision();
}
return this.flatInteriorPoint_;
};
}
/**
* Return an interior point of the polygon.
@@ -218,10 +208,9 @@ Polygon.prototype.getFlatInteriorPoint = function() {
* length of the horizontal intersection that the point belongs to.
* @api
*/
Polygon.prototype.getInteriorPoint = function() {
getInteriorPoint() {
return new Point(this.getFlatInteriorPoint(), GeometryLayout.XYM);
};
}
/**
* Return the number of rings of the polygon, this includes the exterior
@@ -230,10 +219,9 @@ Polygon.prototype.getInteriorPoint = function() {
* @return {number} Number of rings.
* @api
*/
Polygon.prototype.getLinearRingCount = function() {
getLinearRingCount() {
return this.ends_.length;
};
}
/**
* Return the Nth linear ring of the polygon geometry. Return `null` if the
@@ -245,21 +233,20 @@ Polygon.prototype.getLinearRingCount = function() {
* @return {module:ol/geom/LinearRing} Linear ring.
* @api
*/
Polygon.prototype.getLinearRing = function(index) {
getLinearRing(index) {
if (index < 0 || this.ends_.length <= index) {
return null;
}
return new LinearRing(this.flatCoordinates.slice(
index === 0 ? 0 : this.ends_[index - 1], this.ends_[index]), this.layout);
};
}
/**
* Return the linear rings of the polygon.
* @return {Array.<module:ol/geom/LinearRing>} Linear rings.
* @api
*/
Polygon.prototype.getLinearRings = function() {
getLinearRings() {
const layout = this.layout;
const flatCoordinates = this.flatCoordinates;
const ends = this.ends_;
@@ -272,13 +259,12 @@ Polygon.prototype.getLinearRings = function() {
offset = end;
}
return linearRings;
};
}
/**
* @return {Array.<number>} Oriented flat coordinates.
*/
Polygon.prototype.getOrientedFlatCoordinates = function() {
getOrientedFlatCoordinates() {
if (this.orientedRevision_ != this.getRevision()) {
const flatCoordinates = this.flatCoordinates;
if (linearRingIsOriented(
@@ -293,13 +279,12 @@ Polygon.prototype.getOrientedFlatCoordinates = function() {
this.orientedRevision_ = this.getRevision();
}
return this.orientedFlatCoordinates_;
};
}
/**
* @inheritDoc
*/
Polygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
getSimplifiedGeometryInternal(squaredTolerance) {
const simplifiedFlatCoordinates = [];
const simplifiedEnds = [];
simplifiedFlatCoordinates.length = quantizeArray(
@@ -307,27 +292,24 @@ Polygon.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
Math.sqrt(squaredTolerance),
simplifiedFlatCoordinates, 0, simplifiedEnds);
return new Polygon(simplifiedFlatCoordinates, GeometryLayout.XY, simplifiedEnds);
};
}
/**
* @inheritDoc
* @api
*/
Polygon.prototype.getType = function() {
getType() {
return GeometryType.POLYGON;
};
}
/**
* @inheritDoc
* @api
*/
Polygon.prototype.intersectsExtent = function(extent) {
intersectsExtent(extent) {
return intersectsLinearRingArray(
this.getOrientedFlatCoordinates(), 0, this.ends_, this.stride, extent);
};
}
/**
* Set the coordinates of the polygon.
@@ -336,7 +318,7 @@ Polygon.prototype.intersectsExtent = function(extent) {
* @override
* @api
*/
Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
setCoordinates(coordinates, opt_layout) {
this.setLayout(opt_layout, coordinates, 2);
if (!this.flatCoordinates) {
this.flatCoordinates = [];
@@ -345,7 +327,11 @@ Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
this.flatCoordinates, 0, coordinates, this.stride, this.ends_);
this.flatCoordinates.length = ends.length === 0 ? 0 : ends[ends.length - 1];
this.changed();
};
}
}
inherits(Polygon, SimpleGeometry);
export default Polygon;
src/ol/geom/SimpleGeometry.js
+216 -230
View File
@@ -19,7 +19,8 @@ import {clear} from '../obj.js';
* @extends {module:ol/geom/Geometry}
* @api
*/
const SimpleGeometry = function() {
class SimpleGeometry {
constructor() {
Geometry.call(this);
@@ -41,7 +42,220 @@ const SimpleGeometry = function() {
*/
this.flatCoordinates = null;
};
}
/**
* @inheritDoc
*/
computeExtent(extent) {
return createOrUpdateFromFlatCoordinates(this.flatCoordinates,
0, this.flatCoordinates.length, this.stride, extent);
}
/**
* @abstract
* @return {Array} Coordinates.
*/
getCoordinates() {}
/**
* Return the first coordinate of the geometry.
* @return {module:ol/coordinate~Coordinate} First coordinate.
* @api
*/
getFirstCoordinate() {
return this.flatCoordinates.slice(0, this.stride);
}
/**
* @return {Array.<number>} Flat coordinates.
*/
getFlatCoordinates() {
return this.flatCoordinates;
}
/**
* Return the last coordinate of the geometry.
* @return {module:ol/coordinate~Coordinate} Last point.
* @api
*/
getLastCoordinate() {
return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride);
}
/**
* Return the {@link module:ol/geom/GeometryLayout~GeometryLayout layout} of the geometry.
* @return {module:ol/geom/GeometryLayout} Layout.
* @api
*/
getLayout() {
return this.layout;
}
/**
* @inheritDoc
*/
getSimplifiedGeometry(squaredTolerance) {
if (this.simplifiedGeometryRevision != this.getRevision()) {
clear(this.simplifiedGeometryCache);
this.simplifiedGeometryMaxMinSquaredTolerance = 0;
this.simplifiedGeometryRevision = this.getRevision();
}
// If squaredTolerance is negative or if we know that simplification will not
// have any effect then just return this.
if (squaredTolerance < 0 ||
(this.simplifiedGeometryMaxMinSquaredTolerance !== 0 &&
squaredTolerance <= this.simplifiedGeometryMaxMinSquaredTolerance)) {
return this;
}
const key = squaredTolerance.toString();
if (this.simplifiedGeometryCache.hasOwnProperty(key)) {
return this.simplifiedGeometryCache[key];
} else {
const simplifiedGeometry =
this.getSimplifiedGeometryInternal(squaredTolerance);
const simplifiedFlatCoordinates = simplifiedGeometry.getFlatCoordinates();
if (simplifiedFlatCoordinates.length < this.flatCoordinates.length) {
this.simplifiedGeometryCache[key] = simplifiedGeometry;
return simplifiedGeometry;
} else {
// Simplification did not actually remove any coordinates. We now know
// that any calls to getSimplifiedGeometry with a squaredTolerance less
// than or equal to the current squaredTolerance will also not have any
// effect. This allows us to short circuit simplification (saving CPU
// cycles) and prevents the cache of simplified geometries from filling
// up with useless identical copies of this geometry (saving memory).
this.simplifiedGeometryMaxMinSquaredTolerance = squaredTolerance;
return this;
}
}
}
/**
* @param {number} squaredTolerance Squared tolerance.
* @return {module:ol/geom/SimpleGeometry} Simplified geometry.
* @protected
*/
getSimplifiedGeometryInternal(squaredTolerance) {
return this;
}
/**
* @return {number} Stride.
*/
getStride() {
return this.stride;
}
/**
* @param {module:ol/geom/GeometryLayout} layout Layout.
* @param {Array.<number>} flatCoordinates Flat coordinates.
*/
setFlatCoordinates(layout, flatCoordinates) {
this.stride = getStrideForLayout(layout);
this.layout = layout;
this.flatCoordinates = flatCoordinates;
}
/**
* @abstract
* @param {!Array} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
setCoordinates(coordinates, opt_layout) {}
/**
* @param {module:ol/geom/GeometryLayout|undefined} layout Layout.
* @param {Array} coordinates Coordinates.
* @param {number} nesting Nesting.
* @protected
*/
setLayout(layout, coordinates, nesting) {
/** @type {number} */
let stride;
if (layout) {
stride = getStrideForLayout(layout);
} else {
for (let i = 0; i < nesting; ++i) {
if (coordinates.length === 0) {
this.layout = GeometryLayout.XY;
this.stride = 2;
return;
} else {
coordinates = /** @type {Array} */ (coordinates[0]);
}
}
stride = coordinates.length;
layout = getLayoutForStride(stride);
}
this.layout = layout;
this.stride = stride;
}
/**
* @inheritDoc
* @api
*/
applyTransform(transformFn) {
if (this.flatCoordinates) {
transformFn(this.flatCoordinates, this.flatCoordinates, this.stride);
this.changed();
}
}
/**
* @inheritDoc
* @api
*/
rotate(angle, anchor) {
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
rotate(
flatCoordinates, 0, flatCoordinates.length,
stride, angle, anchor, flatCoordinates);
this.changed();
}
}
/**
* @inheritDoc
* @api
*/
scale(sx, opt_sy, opt_anchor) {
let sy = opt_sy;
if (sy === undefined) {
sy = sx;
}
let anchor = opt_anchor;
if (!anchor) {
anchor = getCenter(this.getExtent());
}
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
scale(
flatCoordinates, 0, flatCoordinates.length,
stride, sx, sy, anchor, flatCoordinates);
this.changed();
}
}
/**
* @inheritDoc
* @api
*/
translate(deltaX, deltaY) {
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
translate(
flatCoordinates, 0, flatCoordinates.length, stride,
deltaX, deltaY, flatCoordinates);
this.changed();
}
}
}
inherits(SimpleGeometry, Geometry);
@@ -88,234 +302,6 @@ export function getStrideForLayout(layout) {
SimpleGeometry.prototype.containsXY = FALSE;
/**
* @inheritDoc
*/
SimpleGeometry.prototype.computeExtent = function(extent) {
return createOrUpdateFromFlatCoordinates(this.flatCoordinates,
0, this.flatCoordinates.length, this.stride, extent);
};
/**
* @abstract
* @return {Array} Coordinates.
*/
SimpleGeometry.prototype.getCoordinates = function() {};
/**
* Return the first coordinate of the geometry.
* @return {module:ol/coordinate~Coordinate} First coordinate.
* @api
*/
SimpleGeometry.prototype.getFirstCoordinate = function() {
return this.flatCoordinates.slice(0, this.stride);
};
/**
* @return {Array.<number>} Flat coordinates.
*/
SimpleGeometry.prototype.getFlatCoordinates = function() {
return this.flatCoordinates;
};
/**
* Return the last coordinate of the geometry.
* @return {module:ol/coordinate~Coordinate} Last point.
* @api
*/
SimpleGeometry.prototype.getLastCoordinate = function() {
return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride);
};
/**
* Return the {@link module:ol/geom/GeometryLayout~GeometryLayout layout} of the geometry.
* @return {module:ol/geom/GeometryLayout} Layout.
* @api
*/
SimpleGeometry.prototype.getLayout = function() {
return this.layout;
};
/**
* @inheritDoc
*/
SimpleGeometry.prototype.getSimplifiedGeometry = function(squaredTolerance) {
if (this.simplifiedGeometryRevision != this.getRevision()) {
clear(this.simplifiedGeometryCache);
this.simplifiedGeometryMaxMinSquaredTolerance = 0;
this.simplifiedGeometryRevision = this.getRevision();
}
// If squaredTolerance is negative or if we know that simplification will not
// have any effect then just return this.
if (squaredTolerance < 0 ||
(this.simplifiedGeometryMaxMinSquaredTolerance !== 0 &&
squaredTolerance <= this.simplifiedGeometryMaxMinSquaredTolerance)) {
return this;
}
const key = squaredTolerance.toString();
if (this.simplifiedGeometryCache.hasOwnProperty(key)) {
return this.simplifiedGeometryCache[key];
} else {
const simplifiedGeometry =
this.getSimplifiedGeometryInternal(squaredTolerance);
const simplifiedFlatCoordinates = simplifiedGeometry.getFlatCoordinates();
if (simplifiedFlatCoordinates.length < this.flatCoordinates.length) {
this.simplifiedGeometryCache[key] = simplifiedGeometry;
return simplifiedGeometry;
} else {
// Simplification did not actually remove any coordinates. We now know
// that any calls to getSimplifiedGeometry with a squaredTolerance less
// than or equal to the current squaredTolerance will also not have any
// effect. This allows us to short circuit simplification (saving CPU
// cycles) and prevents the cache of simplified geometries from filling
// up with useless identical copies of this geometry (saving memory).
this.simplifiedGeometryMaxMinSquaredTolerance = squaredTolerance;
return this;
}
}
};
/**
* @param {number} squaredTolerance Squared tolerance.
* @return {module:ol/geom/SimpleGeometry} Simplified geometry.
* @protected
*/
SimpleGeometry.prototype.getSimplifiedGeometryInternal = function(squaredTolerance) {
return this;
};
/**
* @return {number} Stride.
*/
SimpleGeometry.prototype.getStride = function() {
return this.stride;
};
/**
* @param {module:ol/geom/GeometryLayout} layout Layout.
* @param {Array.<number>} flatCoordinates Flat coordinates.
*/
SimpleGeometry.prototype.setFlatCoordinates = function(layout, flatCoordinates) {
this.stride = getStrideForLayout(layout);
this.layout = layout;
this.flatCoordinates = flatCoordinates;
};
/**
* @abstract
* @param {!Array} coordinates Coordinates.
* @param {module:ol/geom/GeometryLayout=} opt_layout Layout.
*/
SimpleGeometry.prototype.setCoordinates = function(coordinates, opt_layout) {};
/**
* @param {module:ol/geom/GeometryLayout|undefined} layout Layout.
* @param {Array} coordinates Coordinates.
* @param {number} nesting Nesting.
* @protected
*/
SimpleGeometry.prototype.setLayout = function(layout, coordinates, nesting) {
/** @type {number} */
let stride;
if (layout) {
stride = getStrideForLayout(layout);
} else {
for (let i = 0; i < nesting; ++i) {
if (coordinates.length === 0) {
this.layout = GeometryLayout.XY;
this.stride = 2;
return;
} else {
coordinates = /** @type {Array} */ (coordinates[0]);
}
}
stride = coordinates.length;
layout = getLayoutForStride(stride);
}
this.layout = layout;
this.stride = stride;
};
/**
* @inheritDoc
* @api
*/
SimpleGeometry.prototype.applyTransform = function(transformFn) {
if (this.flatCoordinates) {
transformFn(this.flatCoordinates, this.flatCoordinates, this.stride);
this.changed();
}
};
/**
* @inheritDoc
* @api
*/
SimpleGeometry.prototype.rotate = function(angle, anchor) {
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
rotate(
flatCoordinates, 0, flatCoordinates.length,
stride, angle, anchor, flatCoordinates);
this.changed();
}
};
/**
* @inheritDoc
* @api
*/
SimpleGeometry.prototype.scale = function(sx, opt_sy, opt_anchor) {
let sy = opt_sy;
if (sy === undefined) {
sy = sx;
}
let anchor = opt_anchor;
if (!anchor) {
anchor = getCenter(this.getExtent());
}
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
scale(
flatCoordinates, 0, flatCoordinates.length,
stride, sx, sy, anchor, flatCoordinates);
this.changed();
}
};
/**
* @inheritDoc
* @api
*/
SimpleGeometry.prototype.translate = function(deltaX, deltaY) {
const flatCoordinates = this.getFlatCoordinates();
if (flatCoordinates) {
const stride = this.getStride();
translate(
flatCoordinates, 0, flatCoordinates.length, stride,
deltaX, deltaY, flatCoordinates);
this.changed();
}
};
/**
* @param {module:ol/geom/SimpleGeometry} simpleGeometry Simple geometry.
* @param {module:ol/transform~Transform} transform Transform.
src/ol/interaction/DragAndDrop.js
+42 -46
View File
@@ -89,7 +89,8 @@ inherits(DragAndDropEvent, Event);
* @param {module:ol/interaction/DragAndDrop~Options=} opt_options Options.
* @api
*/
const DragAndDrop = function(opt_options) {
class DragAndDrop {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -129,42 +130,14 @@ const DragAndDrop = function(opt_options) {
*/
this.target = options.target ? options.target : null;
};
inherits(DragAndDrop, Interaction);
/**
* @param {DragEvent} event Event.
* @this {module:ol/interaction/DragAndDrop}
*/
function handleDrop(event) {
const files = event.dataTransfer.files;
for (let i = 0, ii = files.length; i < ii; ++i) {
const file = files.item(i);
const reader = new FileReader();
reader.addEventListener(EventType.LOAD, this.handleResult_.bind(this, file));
reader.readAsText(file);
}
}
/**
* @param {DragEvent} event Event.
*/
function handleStop(event) {
event.stopPropagation();
event.preventDefault();
event.dataTransfer.dropEffect = 'copy';
}
/**
* @param {File} file File.
* @param {Event} event Load event.
* @private
*/
DragAndDrop.prototype.handleResult_ = function(file, event) {
handleResult_(file, event) {
const result = event.target.result;
const map = this.getMap();
let projection = this.projection_;
@@ -200,13 +173,12 @@ DragAndDrop.prototype.handleResult_ = function(file, event) {
new DragAndDropEvent(
DragAndDropEventType.ADD_FEATURES, file,
features, projection));
};
}
/**
* @private
*/
DragAndDrop.prototype.registerListeners_ = function() {
registerListeners_() {
const map = this.getMap();
if (map) {
const dropArea = this.target ? this.target : map.getViewport();
@@ -217,33 +189,30 @@ DragAndDrop.prototype.registerListeners_ = function() {
listen(dropArea, EventType.DROP, handleStop, this)
];
}
};
}
/**
* @inheritDoc
*/
DragAndDrop.prototype.setActive = function(active) {
setActive(active) {
Interaction.prototype.setActive.call(this, active);
if (active) {
this.registerListeners_();
} else {
this.unregisterListeners_();
}
};
}
/**
* @inheritDoc
*/
DragAndDrop.prototype.setMap = function(map) {
setMap(map) {
this.unregisterListeners_();
Interaction.prototype.setMap.call(this, map);
if (this.getActive()) {
this.registerListeners_();
}
};
}
/**
* @param {module:ol/format/Feature} format Format.
@@ -252,24 +221,51 @@ DragAndDrop.prototype.setMap = function(map) {
* @private
* @return {Array.<module:ol/Feature>} Features.
*/
DragAndDrop.prototype.tryReadFeatures_ = function(format, text, options) {
tryReadFeatures_(format, text, options) {
try {
return format.readFeatures(text, options);
} catch (e) {
return null;
}
};
}
/**
* @private
*/
DragAndDrop.prototype.unregisterListeners_ = function() {
unregisterListeners_() {
if (this.dropListenKeys_) {
this.dropListenKeys_.forEach(unlistenByKey);
this.dropListenKeys_ = null;
}
};
}
}
inherits(DragAndDrop, Interaction);
/**
* @param {DragEvent} event Event.
* @this {module:ol/interaction/DragAndDrop}
*/
function handleDrop(event) {
const files = event.dataTransfer.files;
for (let i = 0, ii = files.length; i < ii; ++i) {
const file = files.item(i);
const reader = new FileReader();
reader.addEventListener(EventType.LOAD, this.handleResult_.bind(this, file));
reader.readAsText(file);
}
}
/**
* @param {DragEvent} event Event.
*/
function handleStop(event) {
event.stopPropagation();
event.preventDefault();
event.dataTransfer.dropEffect = 'copy';
}
export default DragAndDrop;
src/ol/interaction/DragBox.js
+13 -12
View File
@@ -110,7 +110,8 @@ inherits(DragBoxEvent, Event);
* @param {module:ol/interaction/DragBox~Options=} opt_options Options.
* @api
*/
const DragBox = function(opt_options) {
class DragBox {
constructor(opt_options) {
PointerInteraction.call(this, {
handleDownEvent: handleDownEvent,
@@ -150,7 +151,17 @@ const DragBox = function(opt_options) {
*/
this.boxEndCondition_ = options.boxEndCondition ?
options.boxEndCondition : defaultBoxEndCondition;
};
}
/**
* Returns geometry of last drawn box.
* @return {module:ol/geom/Polygon} Geometry.
* @api
*/
getGeometry() {
return this.box_.getGeometry();
}
}
inherits(DragBox, PointerInteraction);
@@ -188,16 +199,6 @@ function handleDragEvent(mapBrowserEvent) {
}
/**
* Returns geometry of last drawn box.
* @return {module:ol/geom/Polygon} Geometry.
* @api
*/
DragBox.prototype.getGeometry = function() {
return this.box_.getGeometry();
};
/**
* To be overridden by child classes.
* FIXME: use constructor option instead of relying on overriding.
src/ol/interaction/DragZoom.js
+10 -7
View File
@@ -35,7 +35,8 @@ import DragBox from '../interaction/DragBox.js';
* @param {module:ol/interaction/DragZoom~Options=} opt_options Options.
* @api
*/
const DragZoom = function(opt_options) {
class DragZoom {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
const condition = options.condition ? options.condition : shiftKeyOnly;
@@ -57,15 +58,12 @@ const DragZoom = function(opt_options) {
className: options.className || 'ol-dragzoom'
});
};
inherits(DragZoom, DragBox);
}
/**
* @inheritDoc
*/
DragZoom.prototype.onBoxEnd = function() {
onBoxEnd() {
const map = this.getMap();
const view = /** @type {!module:ol/View} */ (map.getView());
@@ -98,5 +96,10 @@ DragZoom.prototype.onBoxEnd = function() {
easing: easeOut
});
};
}
}
inherits(DragZoom, DragBox);
export default DragZoom;
src/ol/interaction/Draw.js
+367 -378
View File
@@ -160,7 +160,8 @@ inherits(DrawEvent, Event);
* @param {module:ol/interaction/Draw~Options} options Options.
* @api
*/
const Draw = function(options) {
class Draw {
constructor(options) {
PointerInteraction.call(this, {
handleDownEvent: handleDownEvent,
@@ -430,7 +431,371 @@ const Draw = function(options) {
getChangeEventType(InteractionProperty.ACTIVE),
this.updateState_, this);
};
}
/**
* @inheritDoc
*/
setMap(map) {
PointerInteraction.prototype.setMap.call(this, map);
this.updateState_();
}
/**
* Handle move events.
* @param {module:ol/MapBrowserEvent} event A move event.
* @return {boolean} Pass the event to other interactions.
* @private
*/
handlePointerMove_(event) {
if (this.downPx_ &&
((!this.freehand_ && this.shouldHandle_) ||
(this.freehand_ && !this.shouldHandle_))) {
const downPx = this.downPx_;
const clickPx = event.pixel;
const dx = downPx[0] - clickPx[0];
const dy = downPx[1] - clickPx[1];
const squaredDistance = dx * dx + dy * dy;
this.shouldHandle_ = this.freehand_ ?
squaredDistance > this.squaredClickTolerance_ :
squaredDistance <= this.squaredClickTolerance_;
if (!this.shouldHandle_) {
return true;
}
}
if (this.finishCoordinate_) {
this.modifyDrawing_(event);
} else {
this.createOrUpdateSketchPoint_(event);
}
return true;
}
/**
* Determine if an event is within the snapping tolerance of the start coord.
* @param {module:ol/MapBrowserEvent} event Event.
* @return {boolean} The event is within the snapping tolerance of the start.
* @private
*/
atFinish_(event) {
let at = false;
if (this.sketchFeature_) {
let potentiallyDone = false;
let potentiallyFinishCoordinates = [this.finishCoordinate_];
if (this.mode_ === Mode.LINE_STRING) {
potentiallyDone = this.sketchCoords_.length > this.minPoints_;
} else if (this.mode_ === Mode.POLYGON) {
potentiallyDone = this.sketchCoords_[0].length >
this.minPoints_;
potentiallyFinishCoordinates = [this.sketchCoords_[0][0],
this.sketchCoords_[0][this.sketchCoords_[0].length - 2]];
}
if (potentiallyDone) {
const map = event.map;
for (let i = 0, ii = potentiallyFinishCoordinates.length; i < ii; i++) {
const finishCoordinate = potentiallyFinishCoordinates[i];
const finishPixel = map.getPixelFromCoordinate(finishCoordinate);
const pixel = event.pixel;
const dx = pixel[0] - finishPixel[0];
const dy = pixel[1] - finishPixel[1];
const snapTolerance = this.freehand_ ? 1 : this.snapTolerance_;
at = Math.sqrt(dx * dx + dy * dy) <= snapTolerance;
if (at) {
this.finishCoordinate_ = finishCoordinate;
break;
}
}
}
}
return at;
}
/**
* @param {module:ol/MapBrowserEvent} event Event.
* @private
*/
createOrUpdateSketchPoint_(event) {
const coordinates = event.coordinate.slice();
if (!this.sketchPoint_) {
this.sketchPoint_ = new Feature(new Point(coordinates));
this.updateSketchFeatures_();
} else {
const sketchPointGeom = /** @type {module:ol/geom/Point} */ (this.sketchPoint_.getGeometry());
sketchPointGeom.setCoordinates(coordinates);
}
}
/**
* Start the drawing.
* @param {module:ol/MapBrowserEvent} event Event.
* @private
*/
startDrawing_(event) {
const start = event.coordinate;
this.finishCoordinate_ = start;
if (this.mode_ === Mode.POINT) {
this.sketchCoords_ = start.slice();
} else if (this.mode_ === Mode.POLYGON) {
this.sketchCoords_ = [[start.slice(), start.slice()]];
this.sketchLineCoords_ = this.sketchCoords_[0];
} else {
this.sketchCoords_ = [start.slice(), start.slice()];
}
if (this.sketchLineCoords_) {
this.sketchLine_ = new Feature(
new LineString(this.sketchLineCoords_));
}
const geometry = this.geometryFunction_(this.sketchCoords_);
this.sketchFeature_ = new Feature();
if (this.geometryName_) {
this.sketchFeature_.setGeometryName(this.geometryName_);
}
this.sketchFeature_.setGeometry(geometry);
this.updateSketchFeatures_();
this.dispatchEvent(new DrawEvent(DrawEventType.DRAWSTART, this.sketchFeature_));
}
/**
* Modify the drawing.
* @param {module:ol/MapBrowserEvent} event Event.
* @private
*/
modifyDrawing_(event) {
let coordinate = event.coordinate;
const geometry = /** @type {module:ol/geom/SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let coordinates, last;
if (this.mode_ === Mode.POINT) {
last = this.sketchCoords_;
} else if (this.mode_ === Mode.POLYGON) {
coordinates = this.sketchCoords_[0];
last = coordinates[coordinates.length - 1];
if (this.atFinish_(event)) {
// snap to finish
coordinate = this.finishCoordinate_.slice();
}
} else {
coordinates = this.sketchCoords_;
last = coordinates[coordinates.length - 1];
}
last[0] = coordinate[0];
last[1] = coordinate[1];
this.geometryFunction_(/** @type {!Array.<module:ol/coordinate~Coordinate>} */ (this.sketchCoords_), geometry);
if (this.sketchPoint_) {
const sketchPointGeom = /** @type {module:ol/geom/Point} */ (this.sketchPoint_.getGeometry());
sketchPointGeom.setCoordinates(coordinate);
}
let sketchLineGeom;
if (geometry instanceof Polygon &&
this.mode_ !== Mode.POLYGON) {
if (!this.sketchLine_) {
this.sketchLine_ = new Feature();
}
const ring = geometry.getLinearRing(0);
sketchLineGeom = /** @type {module:ol/geom/LineString} */ (this.sketchLine_.getGeometry());
if (!sketchLineGeom) {
sketchLineGeom = new LineString(ring.getFlatCoordinates(), ring.getLayout());
this.sketchLine_.setGeometry(sketchLineGeom);
} else {
sketchLineGeom.setFlatCoordinates(
ring.getLayout(), ring.getFlatCoordinates());
sketchLineGeom.changed();
}
} else if (this.sketchLineCoords_) {
sketchLineGeom = /** @type {module:ol/geom/LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom.setCoordinates(this.sketchLineCoords_);
}
this.updateSketchFeatures_();
}
/**
* Add a new coordinate to the drawing.
* @param {module:ol/MapBrowserEvent} event Event.
* @private
*/
addToDrawing_(event) {
const coordinate = event.coordinate;
const geometry = /** @type {module:ol/geom/SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let done;
let coordinates;
if (this.mode_ === Mode.LINE_STRING) {
this.finishCoordinate_ = coordinate.slice();
coordinates = this.sketchCoords_;
if (coordinates.length >= this.maxPoints_) {
if (this.freehand_) {
coordinates.pop();
} else {
done = true;
}
}
coordinates.push(coordinate.slice());
this.geometryFunction_(coordinates, geometry);
} else if (this.mode_ === Mode.POLYGON) {
coordinates = this.sketchCoords_[0];
if (coordinates.length >= this.maxPoints_) {
if (this.freehand_) {
coordinates.pop();
} else {
done = true;
}
}
coordinates.push(coordinate.slice());
if (done) {
this.finishCoordinate_ = coordinates[0];
}
this.geometryFunction_(this.sketchCoords_, geometry);
}
this.updateSketchFeatures_();
if (done) {
this.finishDrawing();
}
}
/**
* Remove last point of the feature currently being drawn.
* @api
*/
removeLastPoint() {
if (!this.sketchFeature_) {
return;
}
const geometry = /** @type {module:ol/geom/SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let coordinates, sketchLineGeom;
if (this.mode_ === Mode.LINE_STRING) {
coordinates = this.sketchCoords_;
coordinates.splice(-2, 1);
this.geometryFunction_(coordinates, geometry);
if (coordinates.length >= 2) {
this.finishCoordinate_ = coordinates[coordinates.length - 2].slice();
}
} else if (this.mode_ === Mode.POLYGON) {
coordinates = this.sketchCoords_[0];
coordinates.splice(-2, 1);
sketchLineGeom = /** @type {module:ol/geom/LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom.setCoordinates(coordinates);
this.geometryFunction_(this.sketchCoords_, geometry);
}
if (coordinates.length === 0) {
this.finishCoordinate_ = null;
}
this.updateSketchFeatures_();
}
/**
* Stop drawing and add the sketch feature to the target layer.
* The {@link module:ol/interaction/Draw~DrawEventType.DRAWEND} event is
* dispatched before inserting the feature.
* @api
*/
finishDrawing() {
const sketchFeature = this.abortDrawing_();
if (!sketchFeature) {
return;
}
let coordinates = this.sketchCoords_;
const geometry = /** @type {module:ol/geom/SimpleGeometry} */ (sketchFeature.getGeometry());
if (this.mode_ === Mode.LINE_STRING) {
// remove the redundant last point
coordinates.pop();
this.geometryFunction_(coordinates, geometry);
} else if (this.mode_ === Mode.POLYGON) {
// remove the redundant last point in ring
coordinates[0].pop();
this.geometryFunction_(coordinates, geometry);
coordinates = geometry.getCoordinates();
}
// cast multi-part geometries
if (this.type_ === GeometryType.MULTI_POINT) {
sketchFeature.setGeometry(new MultiPoint([coordinates]));
} else if (this.type_ === GeometryType.MULTI_LINE_STRING) {
sketchFeature.setGeometry(new MultiLineString([coordinates]));
} else if (this.type_ === GeometryType.MULTI_POLYGON) {
sketchFeature.setGeometry(new MultiPolygon([coordinates]));
}
// First dispatch event to allow full set up of feature
this.dispatchEvent(new DrawEvent(DrawEventType.DRAWEND, sketchFeature));
// Then insert feature
if (this.features_) {
this.features_.push(sketchFeature);
}
if (this.source_) {
this.source_.addFeature(sketchFeature);
}
}
/**
* Stop drawing without adding the sketch feature to the target layer.
* @return {module:ol/Feature} The sketch feature (or null if none).
* @private
*/
abortDrawing_() {
this.finishCoordinate_ = null;
const sketchFeature = this.sketchFeature_;
if (sketchFeature) {
this.sketchFeature_ = null;
this.sketchPoint_ = null;
this.sketchLine_ = null;
this.overlay_.getSource().clear(true);
}
return sketchFeature;
}
/**
* Extend an existing geometry by adding additional points. This only works
* on features with `LineString` geometries, where the interaction will
* extend lines by adding points to the end of the coordinates array.
* @param {!module:ol/Feature} feature Feature to be extended.
* @api
*/
extend(feature) {
const geometry = feature.getGeometry();
const lineString = /** @type {module:ol/geom/LineString} */ (geometry);
this.sketchFeature_ = feature;
this.sketchCoords_ = lineString.getCoordinates();
const last = this.sketchCoords_[this.sketchCoords_.length - 1];
this.finishCoordinate_ = last.slice();
this.sketchCoords_.push(last.slice());
this.updateSketchFeatures_();
this.dispatchEvent(new DrawEvent(DrawEventType.DRAWSTART, this.sketchFeature_));
}
/**
* Redraw the sketch features.
* @private
*/
updateSketchFeatures_() {
const sketchFeatures = [];
if (this.sketchFeature_) {
sketchFeatures.push(this.sketchFeature_);
}
if (this.sketchLine_) {
sketchFeatures.push(this.sketchLine_);
}
if (this.sketchPoint_) {
sketchFeatures.push(this.sketchPoint_);
}
const overlaySource = this.overlay_.getSource();
overlaySource.clear(true);
overlaySource.addFeatures(sketchFeatures);
}
/**
* @private
*/
updateState_() {
const map = this.getMap();
const active = this.getActive();
if (!map || !active) {
this.abortDrawing_();
}
this.overlay_.setMap(active ? map : null);
}
}
inherits(Draw, PointerInteraction);
@@ -446,15 +811,6 @@ function getDefaultStyleFunction() {
}
/**
* @inheritDoc
*/
Draw.prototype.setMap = function(map) {
PointerInteraction.prototype.setMap.call(this, map);
this.updateState_();
};
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may actually
* draw or finish the drawing.
@@ -581,379 +937,12 @@ function handleUpEvent(event) {
}
/**
* Handle move events.
* @param {module:ol/MapBrowserEvent} event A move event.
* @return {boolean} Pass the event to other interactions.
* @private
*/
Draw.prototype.handlePointerMove_ = function(event) {
if (this.downPx_ &&
((!this.freehand_ && this.shouldHandle_) ||
(this.freehand_ && !this.shouldHandle_))) {
const downPx = this.downPx_;
const clickPx = event.pixel;
const dx = downPx[0] - clickPx[0];
const dy = downPx[1] - clickPx[1];
const squaredDistance = dx * dx + dy * dy;
this.shouldHandle_ = this.freehand_ ?
squaredDistance > this.squaredClickTolerance_ :
squaredDistance <= this.squaredClickTolerance_;
if (!this.shouldHandle_) {
return true;
}
}
if (this.finishCoordinate_) {
this.modifyDrawing_(event);
} else {
this.createOrUpdateSketchPoint_(event);
}
return true;
};
/**
* Determine if an event is within the snapping tolerance of the start coord.
* @param {module:ol/MapBrowserEvent} event Event.
* @return {boolean} The event is within the snapping tolerance of the start.
* @private
*/
Draw.prototype.atFinish_ = function(event) {
let at = false;
if (this.sketchFeature_) {
let potentiallyDone = false;
let potentiallyFinishCoordinates = [this.finishCoordinate_];
if (this.mode_ === Mode.LINE_STRING) {
potentiallyDone = this.sketchCoords_.length > this.minPoints_;
} else if (this.mode_ === Mode.POLYGON) {
potentiallyDone = this.sketchCoords_[0].length >
this.minPoints_;
potentiallyFinishCoordinates = [this.sketchCoords_[0][0],
this.sketchCoords_[0][this.sketchCoords_[0].length - 2]];
}
if (potentiallyDone) {
const map = event.map;
for (let i = 0, ii = potentiallyFinishCoordinates.length; i < ii; i++) {
const finishCoordinate = potentiallyFinishCoordinates[i];
const finishPixel = map.getPixelFromCoordinate(finishCoordinate);
const pixel = event.pixel;
const dx = pixel[0] - finishPixel[0];
const dy = pixel[1] - finishPixel[1];
const snapTolerance = this.freehand_ ? 1 : this.snapTolerance_;
at = Math.sqrt(dx * dx + dy * dy) <= snapTolerance;
if (at) {
this.finishCoordinate_ = finishCoordinate;
break;
}
}
}
}
return at;
};
/**
* @param {module:ol/MapBrowserEvent} event Event.
* @private
*/
Draw.prototype.createOrUpdateSketchPoint_ = function(event) {
const coordinates = event.coordinate.slice();
if (!this.sketchPoint_) {
this.sketchPoint_ = new Feature(new Point(coordinates));
this.updateSketchFeatures_();
} else {
const sketchPointGeom = /** @type {module:ol/geom/Point} */ (this.sketchPoint_.getGeometry());
sketchPointGeom.setCoordinates(coordinates);
}
};
/**
* Start the drawing.
* @param {module:ol/MapBrowserEvent} event Event.
* @private
*/
Draw.prototype.startDrawing_ = function(event) {
const start = event.coordinate;
this.finishCoordinate_ = start;
if (this.mode_ === Mode.POINT) {
this.sketchCoords_ = start.slice();
} else if (this.mode_ === Mode.POLYGON) {
this.sketchCoords_ = [[start.slice(), start.slice()]];
this.sketchLineCoords_ = this.sketchCoords_[0];
} else {
this.sketchCoords_ = [start.slice(), start.slice()];
}
if (this.sketchLineCoords_) {
this.sketchLine_ = new Feature(
new LineString(this.sketchLineCoords_));
}
const geometry = this.geometryFunction_(this.sketchCoords_);
this.sketchFeature_ = new Feature();
if (this.geometryName_) {
this.sketchFeature_.setGeometryName(this.geometryName_);
}
this.sketchFeature_.setGeometry(geometry);
this.updateSketchFeatures_();
this.dispatchEvent(new DrawEvent(DrawEventType.DRAWSTART, this.sketchFeature_));
};
/**
* Modify the drawing.
* @param {module:ol/MapBrowserEvent} event Event.
* @private
*/
Draw.prototype.modifyDrawing_ = function(event) {
let coordinate = event.coordinate;
const geometry = /** @type {module:ol/geom/SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let coordinates, last;
if (this.mode_ === Mode.POINT) {
last = this.sketchCoords_;
} else if (this.mode_ === Mode.POLYGON) {
coordinates = this.sketchCoords_[0];
last = coordinates[coordinates.length - 1];
if (this.atFinish_(event)) {
// snap to finish
coordinate = this.finishCoordinate_.slice();
}
} else {
coordinates = this.sketchCoords_;
last = coordinates[coordinates.length - 1];
}
last[0] = coordinate[0];
last[1] = coordinate[1];
this.geometryFunction_(/** @type {!Array.<module:ol/coordinate~Coordinate>} */ (this.sketchCoords_), geometry);
if (this.sketchPoint_) {
const sketchPointGeom = /** @type {module:ol/geom/Point} */ (this.sketchPoint_.getGeometry());
sketchPointGeom.setCoordinates(coordinate);
}
let sketchLineGeom;
if (geometry instanceof Polygon &&
this.mode_ !== Mode.POLYGON) {
if (!this.sketchLine_) {
this.sketchLine_ = new Feature();
}
const ring = geometry.getLinearRing(0);
sketchLineGeom = /** @type {module:ol/geom/LineString} */ (this.sketchLine_.getGeometry());
if (!sketchLineGeom) {
sketchLineGeom = new LineString(ring.getFlatCoordinates(), ring.getLayout());
this.sketchLine_.setGeometry(sketchLineGeom);
} else {
sketchLineGeom.setFlatCoordinates(
ring.getLayout(), ring.getFlatCoordinates());
sketchLineGeom.changed();
}
} else if (this.sketchLineCoords_) {
sketchLineGeom = /** @type {module:ol/geom/LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom.setCoordinates(this.sketchLineCoords_);
}
this.updateSketchFeatures_();
};
/**
* Add a new coordinate to the drawing.
* @param {module:ol/MapBrowserEvent} event Event.
* @private
*/
Draw.prototype.addToDrawing_ = function(event) {
const coordinate = event.coordinate;
const geometry = /** @type {module:ol/geom/SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let done;
let coordinates;
if (this.mode_ === Mode.LINE_STRING) {
this.finishCoordinate_ = coordinate.slice();
coordinates = this.sketchCoords_;
if (coordinates.length >= this.maxPoints_) {
if (this.freehand_) {
coordinates.pop();
} else {
done = true;
}
}
coordinates.push(coordinate.slice());
this.geometryFunction_(coordinates, geometry);
} else if (this.mode_ === Mode.POLYGON) {
coordinates = this.sketchCoords_[0];
if (coordinates.length >= this.maxPoints_) {
if (this.freehand_) {
coordinates.pop();
} else {
done = true;
}
}
coordinates.push(coordinate.slice());
if (done) {
this.finishCoordinate_ = coordinates[0];
}
this.geometryFunction_(this.sketchCoords_, geometry);
}
this.updateSketchFeatures_();
if (done) {
this.finishDrawing();
}
};
/**
* Remove last point of the feature currently being drawn.
* @api
*/
Draw.prototype.removeLastPoint = function() {
if (!this.sketchFeature_) {
return;
}
const geometry = /** @type {module:ol/geom/SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let coordinates, sketchLineGeom;
if (this.mode_ === Mode.LINE_STRING) {
coordinates = this.sketchCoords_;
coordinates.splice(-2, 1);
this.geometryFunction_(coordinates, geometry);
if (coordinates.length >= 2) {
this.finishCoordinate_ = coordinates[coordinates.length - 2].slice();
}
} else if (this.mode_ === Mode.POLYGON) {
coordinates = this.sketchCoords_[0];
coordinates.splice(-2, 1);
sketchLineGeom = /** @type {module:ol/geom/LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom.setCoordinates(coordinates);
this.geometryFunction_(this.sketchCoords_, geometry);
}
if (coordinates.length === 0) {
this.finishCoordinate_ = null;
}
this.updateSketchFeatures_();
};
/**
* Stop drawing and add the sketch feature to the target layer.
* The {@link module:ol/interaction/Draw~DrawEventType.DRAWEND} event is
* dispatched before inserting the feature.
* @api
*/
Draw.prototype.finishDrawing = function() {
const sketchFeature = this.abortDrawing_();
if (!sketchFeature) {
return;
}
let coordinates = this.sketchCoords_;
const geometry = /** @type {module:ol/geom/SimpleGeometry} */ (sketchFeature.getGeometry());
if (this.mode_ === Mode.LINE_STRING) {
// remove the redundant last point
coordinates.pop();
this.geometryFunction_(coordinates, geometry);
} else if (this.mode_ === Mode.POLYGON) {
// remove the redundant last point in ring
coordinates[0].pop();
this.geometryFunction_(coordinates, geometry);
coordinates = geometry.getCoordinates();
}
// cast multi-part geometries
if (this.type_ === GeometryType.MULTI_POINT) {
sketchFeature.setGeometry(new MultiPoint([coordinates]));
} else if (this.type_ === GeometryType.MULTI_LINE_STRING) {
sketchFeature.setGeometry(new MultiLineString([coordinates]));
} else if (this.type_ === GeometryType.MULTI_POLYGON) {
sketchFeature.setGeometry(new MultiPolygon([coordinates]));
}
// First dispatch event to allow full set up of feature
this.dispatchEvent(new DrawEvent(DrawEventType.DRAWEND, sketchFeature));
// Then insert feature
if (this.features_) {
this.features_.push(sketchFeature);
}
if (this.source_) {
this.source_.addFeature(sketchFeature);
}
};
/**
* Stop drawing without adding the sketch feature to the target layer.
* @return {module:ol/Feature} The sketch feature (or null if none).
* @private
*/
Draw.prototype.abortDrawing_ = function() {
this.finishCoordinate_ = null;
const sketchFeature = this.sketchFeature_;
if (sketchFeature) {
this.sketchFeature_ = null;
this.sketchPoint_ = null;
this.sketchLine_ = null;
this.overlay_.getSource().clear(true);
}
return sketchFeature;
};
/**
* Extend an existing geometry by adding additional points. This only works
* on features with `LineString` geometries, where the interaction will
* extend lines by adding points to the end of the coordinates array.
* @param {!module:ol/Feature} feature Feature to be extended.
* @api
*/
Draw.prototype.extend = function(feature) {
const geometry = feature.getGeometry();
const lineString = /** @type {module:ol/geom/LineString} */ (geometry);
this.sketchFeature_ = feature;
this.sketchCoords_ = lineString.getCoordinates();
const last = this.sketchCoords_[this.sketchCoords_.length - 1];
this.finishCoordinate_ = last.slice();
this.sketchCoords_.push(last.slice());
this.updateSketchFeatures_();
this.dispatchEvent(new DrawEvent(DrawEventType.DRAWSTART, this.sketchFeature_));
};
/**
* @inheritDoc
*/
Draw.prototype.shouldStopEvent = FALSE;
/**
* Redraw the sketch features.
* @private
*/
Draw.prototype.updateSketchFeatures_ = function() {
const sketchFeatures = [];
if (this.sketchFeature_) {
sketchFeatures.push(this.sketchFeature_);
}
if (this.sketchLine_) {
sketchFeatures.push(this.sketchLine_);
}
if (this.sketchPoint_) {
sketchFeatures.push(this.sketchPoint_);
}
const overlaySource = this.overlay_.getSource();
overlaySource.clear(true);
overlaySource.addFeatures(sketchFeatures);
};
/**
* @private
*/
Draw.prototype.updateState_ = function() {
const map = this.getMap();
const active = this.getActive();
if (!map || !active) {
this.abortDrawing_();
}
this.overlay_.setMap(active ? map : null);
};
/**
* Create a `geometryFunction` for `type: 'Circle'` that will create a regular
* polygon with a user specified number of sides and start angle instead of an
src/ol/interaction/Extent.js
+136 -136
View File
@@ -82,7 +82,8 @@ inherits(ExtentInteractionEvent, Event);
* @param {module:ol/interaction/Extent~Options=} opt_options Options.
* @api
*/
const ExtentInteraction = function(opt_options) {
class ExtentInteraction {
constructor(opt_options) {
const options = opt_options || {};
@@ -173,7 +174,141 @@ const ExtentInteraction = function(opt_options) {
if (opt_options.extent) {
this.setExtent(opt_options.extent);
}
}
/**
* @param {module:ol~Pixel} pixel cursor location
* @param {module:ol/PluggableMap} map map
* @returns {module:ol/coordinate~Coordinate|null} snapped vertex on extent
* @private
*/
snapToVertex_(pixel, map) {
const pixelCoordinate = map.getCoordinateFromPixel(pixel);
const sortByDistance = function(a, b) {
return squaredDistanceToSegment(pixelCoordinate, a) -
squaredDistanceToSegment(pixelCoordinate, b);
};
const extent = this.getExtent();
if (extent) {
//convert extents to line segments and find the segment closest to pixelCoordinate
const segments = getSegments(extent);
segments.sort(sortByDistance);
const closestSegment = segments[0];
let vertex = (closestOnSegment(pixelCoordinate,
closestSegment));
const vertexPixel = map.getPixelFromCoordinate(vertex);
//if the distance is within tolerance, snap to the segment
if (coordinateDistance(pixel, vertexPixel) <= this.pixelTolerance_) {
//test if we should further snap to a vertex
const pixel1 = map.getPixelFromCoordinate(closestSegment[0]);
const pixel2 = map.getPixelFromCoordinate(closestSegment[1]);
const squaredDist1 = squaredCoordinateDistance(vertexPixel, pixel1);
const squaredDist2 = squaredCoordinateDistance(vertexPixel, pixel2);
const dist = Math.sqrt(Math.min(squaredDist1, squaredDist2));
this.snappedToVertex_ = dist <= this.pixelTolerance_;
if (this.snappedToVertex_) {
vertex = squaredDist1 > squaredDist2 ?
closestSegment[1] : closestSegment[0];
}
return vertex;
}
}
return null;
}
/**
* @param {module:ol/MapBrowserEvent} mapBrowserEvent pointer move event
* @private
*/
handlePointerMove_(mapBrowserEvent) {
const pixel = mapBrowserEvent.pixel;
const map = mapBrowserEvent.map;
let vertex = this.snapToVertex_(pixel, map);
if (!vertex) {
vertex = map.getCoordinateFromPixel(pixel);
}
this.createOrUpdatePointerFeature_(vertex);
}
/**
* @param {module:ol/extent~Extent} extent extent
* @returns {module:ol/Feature} extent as featrue
* @private
*/
createOrUpdateExtentFeature_(extent) {
let extentFeature = this.extentFeature_;
if (!extentFeature) {
if (!extent) {
extentFeature = new Feature({});
} else {
extentFeature = new Feature(polygonFromExtent(extent));
}
this.extentFeature_ = extentFeature;
this.extentOverlay_.getSource().addFeature(extentFeature);
} else {
if (!extent) {
extentFeature.setGeometry(undefined);
} else {
extentFeature.setGeometry(polygonFromExtent(extent));
}
}
return extentFeature;
}
/**
* @param {module:ol/coordinate~Coordinate} vertex location of feature
* @returns {module:ol/Feature} vertex as feature
* @private
*/
createOrUpdatePointerFeature_(vertex) {
let vertexFeature = this.vertexFeature_;
if (!vertexFeature) {
vertexFeature = new Feature(new Point(vertex));
this.vertexFeature_ = vertexFeature;
this.vertexOverlay_.getSource().addFeature(vertexFeature);
} else {
const geometry = /** @type {module:ol/geom/Point} */ (vertexFeature.getGeometry());
geometry.setCoordinates(vertex);
}
return vertexFeature;
}
/**
* @inheritDoc
*/
setMap(map) {
this.extentOverlay_.setMap(map);
this.vertexOverlay_.setMap(map);
PointerInteraction.prototype.setMap.call(this, map);
}
/**
* Returns the current drawn extent in the view projection
*
* @return {module:ol/extent~Extent} Drawn extent in the view projection.
* @api
*/
getExtent() {
return this.extent_;
}
/**
* Manually sets the drawn extent, using the view projection.
*
* @param {module:ol/extent~Extent} extent Extent
* @api
*/
setExtent(extent) {
//Null extent means no bbox
this.extent_ = extent ? extent : null;
this.createOrUpdateExtentFeature_(extent);
this.dispatchEvent(new ExtentInteractionEvent(this.extent_));
}
}
inherits(ExtentInteraction, PointerInteraction);
@@ -350,140 +485,5 @@ function getSegments(extent) {
];
}
/**
* @param {module:ol~Pixel} pixel cursor location
* @param {module:ol/PluggableMap} map map
* @returns {module:ol/coordinate~Coordinate|null} snapped vertex on extent
* @private
*/
ExtentInteraction.prototype.snapToVertex_ = function(pixel, map) {
const pixelCoordinate = map.getCoordinateFromPixel(pixel);
const sortByDistance = function(a, b) {
return squaredDistanceToSegment(pixelCoordinate, a) -
squaredDistanceToSegment(pixelCoordinate, b);
};
const extent = this.getExtent();
if (extent) {
//convert extents to line segments and find the segment closest to pixelCoordinate
const segments = getSegments(extent);
segments.sort(sortByDistance);
const closestSegment = segments[0];
let vertex = (closestOnSegment(pixelCoordinate,
closestSegment));
const vertexPixel = map.getPixelFromCoordinate(vertex);
//if the distance is within tolerance, snap to the segment
if (coordinateDistance(pixel, vertexPixel) <= this.pixelTolerance_) {
//test if we should further snap to a vertex
const pixel1 = map.getPixelFromCoordinate(closestSegment[0]);
const pixel2 = map.getPixelFromCoordinate(closestSegment[1]);
const squaredDist1 = squaredCoordinateDistance(vertexPixel, pixel1);
const squaredDist2 = squaredCoordinateDistance(vertexPixel, pixel2);
const dist = Math.sqrt(Math.min(squaredDist1, squaredDist2));
this.snappedToVertex_ = dist <= this.pixelTolerance_;
if (this.snappedToVertex_) {
vertex = squaredDist1 > squaredDist2 ?
closestSegment[1] : closestSegment[0];
}
return vertex;
}
}
return null;
};
/**
* @param {module:ol/MapBrowserEvent} mapBrowserEvent pointer move event
* @private
*/
ExtentInteraction.prototype.handlePointerMove_ = function(mapBrowserEvent) {
const pixel = mapBrowserEvent.pixel;
const map = mapBrowserEvent.map;
let vertex = this.snapToVertex_(pixel, map);
if (!vertex) {
vertex = map.getCoordinateFromPixel(pixel);
}
this.createOrUpdatePointerFeature_(vertex);
};
/**
* @param {module:ol/extent~Extent} extent extent
* @returns {module:ol/Feature} extent as featrue
* @private
*/
ExtentInteraction.prototype.createOrUpdateExtentFeature_ = function(extent) {
let extentFeature = this.extentFeature_;
if (!extentFeature) {
if (!extent) {
extentFeature = new Feature({});
} else {
extentFeature = new Feature(polygonFromExtent(extent));
}
this.extentFeature_ = extentFeature;
this.extentOverlay_.getSource().addFeature(extentFeature);
} else {
if (!extent) {
extentFeature.setGeometry(undefined);
} else {
extentFeature.setGeometry(polygonFromExtent(extent));
}
}
return extentFeature;
};
/**
* @param {module:ol/coordinate~Coordinate} vertex location of feature
* @returns {module:ol/Feature} vertex as feature
* @private
*/
ExtentInteraction.prototype.createOrUpdatePointerFeature_ = function(vertex) {
let vertexFeature = this.vertexFeature_;
if (!vertexFeature) {
vertexFeature = new Feature(new Point(vertex));
this.vertexFeature_ = vertexFeature;
this.vertexOverlay_.getSource().addFeature(vertexFeature);
} else {
const geometry = /** @type {module:ol/geom/Point} */ (vertexFeature.getGeometry());
geometry.setCoordinates(vertex);
}
return vertexFeature;
};
/**
* @inheritDoc
*/
ExtentInteraction.prototype.setMap = function(map) {
this.extentOverlay_.setMap(map);
this.vertexOverlay_.setMap(map);
PointerInteraction.prototype.setMap.call(this, map);
};
/**
* Returns the current drawn extent in the view projection
*
* @return {module:ol/extent~Extent} Drawn extent in the view projection.
* @api
*/
ExtentInteraction.prototype.getExtent = function() {
return this.extent_;
};
/**
* Manually sets the drawn extent, using the view projection.
*
* @param {module:ol/extent~Extent} extent Extent
* @api
*/
ExtentInteraction.prototype.setExtent = function(extent) {
//Null extent means no bbox
this.extent_ = extent ? extent : null;
this.createOrUpdateExtentFeature_(extent);
this.dispatchEvent(new ExtentInteractionEvent(this.extent_));
};
export default ExtentInteraction;
src/ol/interaction/Interaction.js
+14 -16
View File
@@ -36,7 +36,8 @@ import {clamp} from '../math.js';
* @extends {module:ol/Object}
* @api
*/
const Interaction = function(options) {
class Interaction {
constructor(options) {
BaseObject.call(this);
@@ -53,10 +54,7 @@ const Interaction = function(options) {
*/
this.handleEvent = options.handleEvent;
};
inherits(Interaction, BaseObject);
}
/**
* Return whether the interaction is currently active.
@@ -64,20 +62,18 @@ inherits(Interaction, BaseObject);
* @observable
* @api
*/
Interaction.prototype.getActive = function() {
getActive() {
return /** @type {boolean} */ (this.get(InteractionProperty.ACTIVE));
};
}
/**
* Get the map associated with this interaction.
* @return {module:ol/PluggableMap} Map.
* @api
*/
Interaction.prototype.getMap = function() {
getMap() {
return this.map_;
};
}
/**
* Activate or deactivate the interaction.
@@ -85,10 +81,9 @@ Interaction.prototype.getMap = function() {
* @observable
* @api
*/
Interaction.prototype.setActive = function(active) {
setActive(active) {
this.set(InteractionProperty.ACTIVE, active);
};
}
/**
* Remove the interaction from its current map and attach it to the new map.
@@ -96,9 +91,12 @@ Interaction.prototype.setActive = function(active) {
* the map here.
* @param {module:ol/PluggableMap} map Map.
*/
Interaction.prototype.setMap = function(map) {
setMap(map) {
this.map_ = map;
};
}
}
inherits(Interaction, BaseObject);
/**
src/ol/interaction/Modify.js
+365 -389
View File
@@ -140,7 +140,8 @@ inherits(ModifyEvent, Event);
* @fires module:ol/interaction/Modify~ModifyEvent
* @api
*/
const Modify = function(options) {
class Modify {
constructor(options) {
PointerInteraction.call(this, {
handleDownEvent: handleDownEvent,
@@ -320,31 +321,13 @@ const Modify = function(options) {
*/
this.lastPointerEvent_ = null;
};
inherits(Modify, PointerInteraction);
/**
* The segment index assigned to a circle's center when
* breaking up a circle into ModifySegmentDataType segments.
* @type {number}
*/
const CIRCLE_CENTER_INDEX = 0;
/**
* The segment index assigned to a circle's circumference when
* breaking up a circle into ModifySegmentDataType segments.
* @type {number}
*/
const CIRCLE_CIRCUMFERENCE_INDEX = 1;
}
/**
* @param {module:ol/Feature} feature Feature.
* @private
*/
Modify.prototype.addFeature_ = function(feature) {
addFeature_(feature) {
const geometry = feature.getGeometry();
if (geometry && geometry.getType() in this.SEGMENT_WRITERS_) {
this.SEGMENT_WRITERS_[geometry.getType()].call(this, feature, geometry);
@@ -355,27 +338,25 @@ Modify.prototype.addFeature_ = function(feature) {
}
listen(feature, EventType.CHANGE,
this.handleFeatureChange_, this);
};
}
/**
* @param {module:ol/MapBrowserPointerEvent} evt Map browser event
* @private
*/
Modify.prototype.willModifyFeatures_ = function(evt) {
willModifyFeatures_(evt) {
if (!this.modified_) {
this.modified_ = true;
this.dispatchEvent(new ModifyEvent(
ModifyEventType.MODIFYSTART, this.features_, evt));
}
};
}
/**
* @param {module:ol/Feature} feature Feature.
* @private
*/
Modify.prototype.removeFeature_ = function(feature) {
removeFeature_(feature) {
this.removeFeatureSegmentData_(feature);
// Remove the vertex feature if the collection of canditate features
// is empty.
@@ -385,14 +366,13 @@ Modify.prototype.removeFeature_ = function(feature) {
}
unlisten(feature, EventType.CHANGE,
this.handleFeatureChange_, this);
};
}
/**
* @param {module:ol/Feature} feature Feature.
* @private
*/
Modify.prototype.removeFeatureSegmentData_ = function(feature) {
removeFeatureSegmentData_(feature) {
const rBush = this.rBush_;
const /** @type {Array.<module:ol/interaction/Modify~SegmentData>} */ nodesToRemove = [];
rBush.forEach(
@@ -407,90 +387,82 @@ Modify.prototype.removeFeatureSegmentData_ = function(feature) {
for (let i = nodesToRemove.length - 1; i >= 0; --i) {
rBush.remove(nodesToRemove[i]);
}
};
}
/**
* @inheritDoc
*/
Modify.prototype.setActive = function(active) {
setActive(active) {
if (this.vertexFeature_ && !active) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
PointerInteraction.prototype.setActive.call(this, active);
};
}
/**
* @inheritDoc
*/
Modify.prototype.setMap = function(map) {
setMap(map) {
this.overlay_.setMap(map);
PointerInteraction.prototype.setMap.call(this, map);
};
}
/**
* @param {module:ol/source/Vector~VectorSourceEvent} event Event.
* @private
*/
Modify.prototype.handleSourceAdd_ = function(event) {
handleSourceAdd_(event) {
if (event.feature) {
this.features_.push(event.feature);
}
};
}
/**
* @param {module:ol/source/Vector~VectorSourceEvent} event Event.
* @private
*/
Modify.prototype.handleSourceRemove_ = function(event) {
handleSourceRemove_(event) {
if (event.feature) {
this.features_.remove(event.feature);
}
};
}
/**
* @param {module:ol/Collection~CollectionEvent} evt Event.
* @private
*/
Modify.prototype.handleFeatureAdd_ = function(evt) {
handleFeatureAdd_(evt) {
this.addFeature_(/** @type {module:ol/Feature} */ (evt.element));
};
}
/**
* @param {module:ol/events/Event} evt Event.
* @private
*/
Modify.prototype.handleFeatureChange_ = function(evt) {
handleFeatureChange_(evt) {
if (!this.changingFeature_) {
const feature = /** @type {module:ol/Feature} */ (evt.target);
this.removeFeature_(feature);
this.addFeature_(feature);
}
};
}
/**
* @param {module:ol/Collection~CollectionEvent} evt Event.
* @private
*/
Modify.prototype.handleFeatureRemove_ = function(evt) {
handleFeatureRemove_(evt) {
const feature = /** @type {module:ol/Feature} */ (evt.element);
this.removeFeature_(feature);
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/Point} geometry Geometry.
* @private
*/
Modify.prototype.writePointGeometry_ = function(feature, geometry) {
writePointGeometry_(feature, geometry) {
const coordinates = geometry.getCoordinates();
const segmentData = /** @type {module:ol/interaction/Modify~SegmentData} */ ({
feature: feature,
@@ -498,15 +470,14 @@ Modify.prototype.writePointGeometry_ = function(feature, geometry) {
segment: [coordinates, coordinates]
});
this.rBush_.insert(geometry.getExtent(), segmentData);
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/MultiPoint} geometry Geometry.
* @private
*/
Modify.prototype.writeMultiPointGeometry_ = function(feature, geometry) {
writeMultiPointGeometry_(feature, geometry) {
const points = geometry.getCoordinates();
for (let i = 0, ii = points.length; i < ii; ++i) {
const coordinates = points[i];
@@ -519,15 +490,14 @@ Modify.prototype.writeMultiPointGeometry_ = function(feature, geometry) {
});
this.rBush_.insert(geometry.getExtent(), segmentData);
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/LineString} geometry Geometry.
* @private
*/
Modify.prototype.writeLineStringGeometry_ = function(feature, geometry) {
writeLineStringGeometry_(feature, geometry) {
const coordinates = geometry.getCoordinates();
for (let i = 0, ii = coordinates.length - 1; i < ii; ++i) {
const segment = coordinates.slice(i, i + 2);
@@ -539,15 +509,14 @@ Modify.prototype.writeLineStringGeometry_ = function(feature, geometry) {
});
this.rBush_.insert(boundingExtent(segment), segmentData);
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/MultiLineString} geometry Geometry.
* @private
*/
Modify.prototype.writeMultiLineStringGeometry_ = function(feature, geometry) {
writeMultiLineStringGeometry_(feature, geometry) {
const lines = geometry.getCoordinates();
for (let j = 0, jj = lines.length; j < jj; ++j) {
const coordinates = lines[j];
@@ -563,15 +532,14 @@ Modify.prototype.writeMultiLineStringGeometry_ = function(feature, geometry) {
this.rBush_.insert(boundingExtent(segment), segmentData);
}
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/Polygon} geometry Geometry.
* @private
*/
Modify.prototype.writePolygonGeometry_ = function(feature, geometry) {
writePolygonGeometry_(feature, geometry) {
const rings = geometry.getCoordinates();
for (let j = 0, jj = rings.length; j < jj; ++j) {
const coordinates = rings[j];
@@ -587,15 +555,14 @@ Modify.prototype.writePolygonGeometry_ = function(feature, geometry) {
this.rBush_.insert(boundingExtent(segment), segmentData);
}
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/MultiPolygon} geometry Geometry.
* @private
*/
Modify.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
writeMultiPolygonGeometry_(feature, geometry) {
const polygons = geometry.getCoordinates();
for (let k = 0, kk = polygons.length; k < kk; ++k) {
const rings = polygons[k];
@@ -614,8 +581,7 @@ Modify.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
}
}
}
};
}
/**
* We convert a circle into two segments. The segment at index
@@ -628,7 +594,7 @@ Modify.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
* @param {module:ol/geom/Circle} geometry Geometry.
* @private
*/
Modify.prototype.writeCircleGeometry_ = function(feature, geometry) {
writeCircleGeometry_(feature, geometry) {
const coordinates = geometry.getCenter();
const centerSegmentData = /** @type {module:ol/interaction/Modify~SegmentData} */ ({
feature: feature,
@@ -646,28 +612,26 @@ Modify.prototype.writeCircleGeometry_ = function(feature, geometry) {
centerSegmentData.featureSegments = circumferenceSegmentData.featureSegments = featureSegments;
this.rBush_.insert(createOrUpdateFromCoordinate(coordinates), centerSegmentData);
this.rBush_.insert(geometry.getExtent(), circumferenceSegmentData);
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/GeometryCollection} geometry Geometry.
* @private
*/
Modify.prototype.writeGeometryCollectionGeometry_ = function(feature, geometry) {
writeGeometryCollectionGeometry_(feature, geometry) {
const geometries = geometry.getGeometriesArray();
for (let i = 0; i < geometries.length; ++i) {
this.SEGMENT_WRITERS_[geometries[i].getType()].call(this, feature, geometries[i]);
}
};
}
/**
* @param {module:ol/coordinate~Coordinate} coordinates Coordinates.
* @return {module:ol/Feature} Vertex feature.
* @private
*/
Modify.prototype.createOrUpdateVertexFeature_ = function(coordinates) {
createOrUpdateVertexFeature_(coordinates) {
let vertexFeature = this.vertexFeature_;
if (!vertexFeature) {
vertexFeature = new Feature(new Point(coordinates));
@@ -678,8 +642,331 @@ Modify.prototype.createOrUpdateVertexFeature_ = function(coordinates) {
geometry.setCoordinates(coordinates);
}
return vertexFeature;
}
/**
* @param {module:ol/MapBrowserEvent} evt Event.
* @private
*/
handlePointerMove_(evt) {
this.lastPixel_ = evt.pixel;
this.handlePointerAtPixel_(evt.pixel, evt.map);
}
/**
* @param {module:ol~Pixel} pixel Pixel
* @param {module:ol/PluggableMap} map Map.
* @private
*/
handlePointerAtPixel_(pixel, map) {
const pixelCoordinate = map.getCoordinateFromPixel(pixel);
const sortByDistance = function(a, b) {
return pointDistanceToSegmentDataSquared(pixelCoordinate, a) -
pointDistanceToSegmentDataSquared(pixelCoordinate, b);
};
const box = buffer(createOrUpdateFromCoordinate(pixelCoordinate),
map.getView().getResolution() * this.pixelTolerance_);
const rBush = this.rBush_;
const nodes = rBush.getInExtent(box);
if (nodes.length > 0) {
nodes.sort(sortByDistance);
const node = nodes[0];
const closestSegment = node.segment;
let vertex = closestOnSegmentData(pixelCoordinate, node);
const vertexPixel = map.getPixelFromCoordinate(vertex);
let dist = coordinateDistance(pixel, vertexPixel);
if (dist <= this.pixelTolerance_) {
const vertexSegments = {};
if (node.geometry.getType() === GeometryType.CIRCLE &&
node.index === CIRCLE_CIRCUMFERENCE_INDEX) {
this.snappedToVertex_ = true;
this.createOrUpdateVertexFeature_(vertex);
} else {
const pixel1 = map.getPixelFromCoordinate(closestSegment[0]);
const pixel2 = map.getPixelFromCoordinate(closestSegment[1]);
const squaredDist1 = squaredCoordinateDistance(vertexPixel, pixel1);
const squaredDist2 = squaredCoordinateDistance(vertexPixel, pixel2);
dist = Math.sqrt(Math.min(squaredDist1, squaredDist2));
this.snappedToVertex_ = dist <= this.pixelTolerance_;
if (this.snappedToVertex_) {
vertex = squaredDist1 > squaredDist2 ? closestSegment[1] : closestSegment[0];
}
this.createOrUpdateVertexFeature_(vertex);
for (let i = 1, ii = nodes.length; i < ii; ++i) {
const segment = nodes[i].segment;
if ((coordinatesEqual(closestSegment[0], segment[0]) &&
coordinatesEqual(closestSegment[1], segment[1]) ||
(coordinatesEqual(closestSegment[0], segment[1]) &&
coordinatesEqual(closestSegment[1], segment[0])))) {
vertexSegments[getUid(segment)] = true;
} else {
break;
}
}
}
vertexSegments[getUid(closestSegment)] = true;
this.vertexSegments_ = vertexSegments;
return;
}
}
if (this.vertexFeature_) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
}
/**
* @param {module:ol/interaction/Modify~SegmentData} segmentData Segment data.
* @param {module:ol/coordinate~Coordinate} vertex Vertex.
* @private
*/
insertVertex_(segmentData, vertex) {
const segment = segmentData.segment;
const feature = segmentData.feature;
const geometry = segmentData.geometry;
const depth = segmentData.depth;
const index = /** @type {number} */ (segmentData.index);
let coordinates;
while (vertex.length < geometry.getStride()) {
vertex.push(0);
}
switch (geometry.getType()) {
case GeometryType.MULTI_LINE_STRING:
coordinates = geometry.getCoordinates();
coordinates[depth[0]].splice(index + 1, 0, vertex);
break;
case GeometryType.POLYGON:
coordinates = geometry.getCoordinates();
coordinates[depth[0]].splice(index + 1, 0, vertex);
break;
case GeometryType.MULTI_POLYGON:
coordinates = geometry.getCoordinates();
coordinates[depth[1]][depth[0]].splice(index + 1, 0, vertex);
break;
case GeometryType.LINE_STRING:
coordinates = geometry.getCoordinates();
coordinates.splice(index + 1, 0, vertex);
break;
default:
return;
}
this.setGeometryCoordinates_(geometry, coordinates);
const rTree = this.rBush_;
rTree.remove(segmentData);
this.updateSegmentIndices_(geometry, index, depth, 1);
const newSegmentData = /** @type {module:ol/interaction/Modify~SegmentData} */ ({
segment: [segment[0], vertex],
feature: feature,
geometry: geometry,
depth: depth,
index: index
});
rTree.insert(boundingExtent(newSegmentData.segment),
newSegmentData);
this.dragSegments_.push([newSegmentData, 1]);
const newSegmentData2 = /** @type {module:ol/interaction/Modify~SegmentData} */ ({
segment: [vertex, segment[1]],
feature: feature,
geometry: geometry,
depth: depth,
index: index + 1
});
rTree.insert(boundingExtent(newSegmentData2.segment), newSegmentData2);
this.dragSegments_.push([newSegmentData2, 0]);
this.ignoreNextSingleClick_ = true;
}
/**
* Removes the vertex currently being pointed.
* @return {boolean} True when a vertex was removed.
* @api
*/
removePoint() {
if (this.lastPointerEvent_ && this.lastPointerEvent_.type != MapBrowserEventType.POINTERDRAG) {
const evt = this.lastPointerEvent_;
this.willModifyFeatures_(evt);
this.removeVertex_();
this.dispatchEvent(new ModifyEvent(ModifyEventType.MODIFYEND, this.features_, evt));
this.modified_ = false;
return true;
}
return false;
}
/**
* Removes a vertex from all matching features.
* @return {boolean} True when a vertex was removed.
* @private
*/
removeVertex_() {
const dragSegments = this.dragSegments_;
const segmentsByFeature = {};
let deleted = false;
let component, coordinates, dragSegment, geometry, i, index, left;
let newIndex, right, segmentData, uid;
for (i = dragSegments.length - 1; i >= 0; --i) {
dragSegment = dragSegments[i];
segmentData = dragSegment[0];
uid = getUid(segmentData.feature);
if (segmentData.depth) {
// separate feature components
uid += '-' + segmentData.depth.join('-');
}
if (!(uid in segmentsByFeature)) {
segmentsByFeature[uid] = {};
}
if (dragSegment[1] === 0) {
segmentsByFeature[uid].right = segmentData;
segmentsByFeature[uid].index = segmentData.index;
} else if (dragSegment[1] == 1) {
segmentsByFeature[uid].left = segmentData;
segmentsByFeature[uid].index = segmentData.index + 1;
}
}
for (uid in segmentsByFeature) {
right = segmentsByFeature[uid].right;
left = segmentsByFeature[uid].left;
index = segmentsByFeature[uid].index;
newIndex = index - 1;
if (left !== undefined) {
segmentData = left;
} else {
segmentData = right;
}
if (newIndex < 0) {
newIndex = 0;
}
geometry = segmentData.geometry;
coordinates = geometry.getCoordinates();
component = coordinates;
deleted = false;
switch (geometry.getType()) {
case GeometryType.MULTI_LINE_STRING:
if (coordinates[segmentData.depth[0]].length > 2) {
coordinates[segmentData.depth[0]].splice(index, 1);
deleted = true;
}
break;
case GeometryType.LINE_STRING:
if (coordinates.length > 2) {
coordinates.splice(index, 1);
deleted = true;
}
break;
case GeometryType.MULTI_POLYGON:
component = component[segmentData.depth[1]];
/* falls through */
case GeometryType.POLYGON:
component = component[segmentData.depth[0]];
if (component.length > 4) {
if (index == component.length - 1) {
index = 0;
}
component.splice(index, 1);
deleted = true;
if (index === 0) {
// close the ring again
component.pop();
component.push(component[0]);
newIndex = component.length - 1;
}
}
break;
default:
// pass
}
if (deleted) {
this.setGeometryCoordinates_(geometry, coordinates);
const segments = [];
if (left !== undefined) {
this.rBush_.remove(left);
segments.push(left.segment[0]);
}
if (right !== undefined) {
this.rBush_.remove(right);
segments.push(right.segment[1]);
}
if (left !== undefined && right !== undefined) {
const newSegmentData = /** @type {module:ol/interaction/Modify~SegmentData} */ ({
depth: segmentData.depth,
feature: segmentData.feature,
geometry: segmentData.geometry,
index: newIndex,
segment: segments
});
this.rBush_.insert(boundingExtent(newSegmentData.segment),
newSegmentData);
}
this.updateSegmentIndices_(geometry, index, segmentData.depth, -1);
if (this.vertexFeature_) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
dragSegments.length = 0;
}
}
return deleted;
}
/**
* @param {module:ol/geom/SimpleGeometry} geometry Geometry.
* @param {Array} coordinates Coordinates.
* @private
*/
setGeometryCoordinates_(geometry, coordinates) {
this.changingFeature_ = true;
geometry.setCoordinates(coordinates);
this.changingFeature_ = false;
}
/**
* @param {module:ol/geom/SimpleGeometry} geometry Geometry.
* @param {number} index Index.
* @param {Array.<number>|undefined} depth Depth.
* @param {number} delta Delta (1 or -1).
* @private
*/
updateSegmentIndices_(geometry, index, depth, delta) {
this.rBush_.forEachInExtent(geometry.getExtent(), function(segmentDataMatch) {
if (segmentDataMatch.geometry === geometry &&
(depth === undefined || segmentDataMatch.depth === undefined ||
equals(segmentDataMatch.depth, depth)) &&
segmentDataMatch.index > index) {
segmentDataMatch.index += delta;
}
});
}
}
inherits(Modify, PointerInteraction);
/**
* The segment index assigned to a circle's center when
* breaking up a circle into ModifySegmentDataType segments.
* @type {number}
*/
const CIRCLE_CENTER_INDEX = 0;
/**
* The segment index assigned to a circle's circumference when
* breaking up a circle into ModifySegmentDataType segments.
* @type {number}
*/
const CIRCLE_CIRCUMFERENCE_INDEX = 1;
/**
* @param {module:ol/interaction/Modify~SegmentData} a The first segment data.
@@ -908,84 +1195,6 @@ function handleEvent(mapBrowserEvent) {
}
/**
* @param {module:ol/MapBrowserEvent} evt Event.
* @private
*/
Modify.prototype.handlePointerMove_ = function(evt) {
this.lastPixel_ = evt.pixel;
this.handlePointerAtPixel_(evt.pixel, evt.map);
};
/**
* @param {module:ol~Pixel} pixel Pixel
* @param {module:ol/PluggableMap} map Map.
* @private
*/
Modify.prototype.handlePointerAtPixel_ = function(pixel, map) {
const pixelCoordinate = map.getCoordinateFromPixel(pixel);
const sortByDistance = function(a, b) {
return pointDistanceToSegmentDataSquared(pixelCoordinate, a) -
pointDistanceToSegmentDataSquared(pixelCoordinate, b);
};
const box = buffer(createOrUpdateFromCoordinate(pixelCoordinate),
map.getView().getResolution() * this.pixelTolerance_);
const rBush = this.rBush_;
const nodes = rBush.getInExtent(box);
if (nodes.length > 0) {
nodes.sort(sortByDistance);
const node = nodes[0];
const closestSegment = node.segment;
let vertex = closestOnSegmentData(pixelCoordinate, node);
const vertexPixel = map.getPixelFromCoordinate(vertex);
let dist = coordinateDistance(pixel, vertexPixel);
if (dist <= this.pixelTolerance_) {
const vertexSegments = {};
if (node.geometry.getType() === GeometryType.CIRCLE &&
node.index === CIRCLE_CIRCUMFERENCE_INDEX) {
this.snappedToVertex_ = true;
this.createOrUpdateVertexFeature_(vertex);
} else {
const pixel1 = map.getPixelFromCoordinate(closestSegment[0]);
const pixel2 = map.getPixelFromCoordinate(closestSegment[1]);
const squaredDist1 = squaredCoordinateDistance(vertexPixel, pixel1);
const squaredDist2 = squaredCoordinateDistance(vertexPixel, pixel2);
dist = Math.sqrt(Math.min(squaredDist1, squaredDist2));
this.snappedToVertex_ = dist <= this.pixelTolerance_;
if (this.snappedToVertex_) {
vertex = squaredDist1 > squaredDist2 ? closestSegment[1] : closestSegment[0];
}
this.createOrUpdateVertexFeature_(vertex);
for (let i = 1, ii = nodes.length; i < ii; ++i) {
const segment = nodes[i].segment;
if ((coordinatesEqual(closestSegment[0], segment[0]) &&
coordinatesEqual(closestSegment[1], segment[1]) ||
(coordinatesEqual(closestSegment[0], segment[1]) &&
coordinatesEqual(closestSegment[1], segment[0])))) {
vertexSegments[getUid(segment)] = true;
} else {
break;
}
}
}
vertexSegments[getUid(closestSegment)] = true;
this.vertexSegments_ = vertexSegments;
return;
}
}
if (this.vertexFeature_) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
};
/**
* Returns the distance from a point to a line segment.
*
@@ -1032,239 +1241,6 @@ function closestOnSegmentData(pointCoordinates, segmentData) {
}
/**
* @param {module:ol/interaction/Modify~SegmentData} segmentData Segment data.
* @param {module:ol/coordinate~Coordinate} vertex Vertex.
* @private
*/
Modify.prototype.insertVertex_ = function(segmentData, vertex) {
const segment = segmentData.segment;
const feature = segmentData.feature;
const geometry = segmentData.geometry;
const depth = segmentData.depth;
const index = /** @type {number} */ (segmentData.index);
let coordinates;
while (vertex.length < geometry.getStride()) {
vertex.push(0);
}
switch (geometry.getType()) {
case GeometryType.MULTI_LINE_STRING:
coordinates = geometry.getCoordinates();
coordinates[depth[0]].splice(index + 1, 0, vertex);
break;
case GeometryType.POLYGON:
coordinates = geometry.getCoordinates();
coordinates[depth[0]].splice(index + 1, 0, vertex);
break;
case GeometryType.MULTI_POLYGON:
coordinates = geometry.getCoordinates();
coordinates[depth[1]][depth[0]].splice(index + 1, 0, vertex);
break;
case GeometryType.LINE_STRING:
coordinates = geometry.getCoordinates();
coordinates.splice(index + 1, 0, vertex);
break;
default:
return;
}
this.setGeometryCoordinates_(geometry, coordinates);
const rTree = this.rBush_;
rTree.remove(segmentData);
this.updateSegmentIndices_(geometry, index, depth, 1);
const newSegmentData = /** @type {module:ol/interaction/Modify~SegmentData} */ ({
segment: [segment[0], vertex],
feature: feature,
geometry: geometry,
depth: depth,
index: index
});
rTree.insert(boundingExtent(newSegmentData.segment),
newSegmentData);
this.dragSegments_.push([newSegmentData, 1]);
const newSegmentData2 = /** @type {module:ol/interaction/Modify~SegmentData} */ ({
segment: [vertex, segment[1]],
feature: feature,
geometry: geometry,
depth: depth,
index: index + 1
});
rTree.insert(boundingExtent(newSegmentData2.segment), newSegmentData2);
this.dragSegments_.push([newSegmentData2, 0]);
this.ignoreNextSingleClick_ = true;
};
/**
* Removes the vertex currently being pointed.
* @return {boolean} True when a vertex was removed.
* @api
*/
Modify.prototype.removePoint = function() {
if (this.lastPointerEvent_ && this.lastPointerEvent_.type != MapBrowserEventType.POINTERDRAG) {
const evt = this.lastPointerEvent_;
this.willModifyFeatures_(evt);
this.removeVertex_();
this.dispatchEvent(new ModifyEvent(ModifyEventType.MODIFYEND, this.features_, evt));
this.modified_ = false;
return true;
}
return false;
};
/**
* Removes a vertex from all matching features.
* @return {boolean} True when a vertex was removed.
* @private
*/
Modify.prototype.removeVertex_ = function() {
const dragSegments = this.dragSegments_;
const segmentsByFeature = {};
let deleted = false;
let component, coordinates, dragSegment, geometry, i, index, left;
let newIndex, right, segmentData, uid;
for (i = dragSegments.length - 1; i >= 0; --i) {
dragSegment = dragSegments[i];
segmentData = dragSegment[0];
uid = getUid(segmentData.feature);
if (segmentData.depth) {
// separate feature components
uid += '-' + segmentData.depth.join('-');
}
if (!(uid in segmentsByFeature)) {
segmentsByFeature[uid] = {};
}
if (dragSegment[1] === 0) {
segmentsByFeature[uid].right = segmentData;
segmentsByFeature[uid].index = segmentData.index;
} else if (dragSegment[1] == 1) {
segmentsByFeature[uid].left = segmentData;
segmentsByFeature[uid].index = segmentData.index + 1;
}
}
for (uid in segmentsByFeature) {
right = segmentsByFeature[uid].right;
left = segmentsByFeature[uid].left;
index = segmentsByFeature[uid].index;
newIndex = index - 1;
if (left !== undefined) {
segmentData = left;
} else {
segmentData = right;
}
if (newIndex < 0) {
newIndex = 0;
}
geometry = segmentData.geometry;
coordinates = geometry.getCoordinates();
component = coordinates;
deleted = false;
switch (geometry.getType()) {
case GeometryType.MULTI_LINE_STRING:
if (coordinates[segmentData.depth[0]].length > 2) {
coordinates[segmentData.depth[0]].splice(index, 1);
deleted = true;
}
break;
case GeometryType.LINE_STRING:
if (coordinates.length > 2) {
coordinates.splice(index, 1);
deleted = true;
}
break;
case GeometryType.MULTI_POLYGON:
component = component[segmentData.depth[1]];
/* falls through */
case GeometryType.POLYGON:
component = component[segmentData.depth[0]];
if (component.length > 4) {
if (index == component.length - 1) {
index = 0;
}
component.splice(index, 1);
deleted = true;
if (index === 0) {
// close the ring again
component.pop();
component.push(component[0]);
newIndex = component.length - 1;
}
}
break;
default:
// pass
}
if (deleted) {
this.setGeometryCoordinates_(geometry, coordinates);
const segments = [];
if (left !== undefined) {
this.rBush_.remove(left);
segments.push(left.segment[0]);
}
if (right !== undefined) {
this.rBush_.remove(right);
segments.push(right.segment[1]);
}
if (left !== undefined && right !== undefined) {
const newSegmentData = /** @type {module:ol/interaction/Modify~SegmentData} */ ({
depth: segmentData.depth,
feature: segmentData.feature,
geometry: segmentData.geometry,
index: newIndex,
segment: segments
});
this.rBush_.insert(boundingExtent(newSegmentData.segment),
newSegmentData);
}
this.updateSegmentIndices_(geometry, index, segmentData.depth, -1);
if (this.vertexFeature_) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
dragSegments.length = 0;
}
}
return deleted;
};
/**
* @param {module:ol/geom/SimpleGeometry} geometry Geometry.
* @param {Array} coordinates Coordinates.
* @private
*/
Modify.prototype.setGeometryCoordinates_ = function(geometry, coordinates) {
this.changingFeature_ = true;
geometry.setCoordinates(coordinates);
this.changingFeature_ = false;
};
/**
* @param {module:ol/geom/SimpleGeometry} geometry Geometry.
* @param {number} index Index.
* @param {Array.<number>|undefined} depth Depth.
* @param {number} delta Delta (1 or -1).
* @private
*/
Modify.prototype.updateSegmentIndices_ = function(
geometry, index, depth, delta) {
this.rBush_.forEachInExtent(geometry.getExtent(), function(segmentDataMatch) {
if (segmentDataMatch.geometry === geometry &&
(depth === undefined || segmentDataMatch.depth === undefined ||
equals(segmentDataMatch.depth, depth)) &&
segmentDataMatch.index > index) {
segmentDataMatch.index += delta;
}
});
};
/**
* @return {module:ol/style/Style~StyleFunction} Styles.
*/
src/ol/interaction/MouseWheelZoom.js
+45 -46
View File
@@ -53,7 +53,8 @@ export const Mode = {
* @param {module:ol/interaction/MouseWheelZoom~Options=} opt_options Options.
* @api
*/
const MouseWheelZoom = function(opt_options) {
class MouseWheelZoom {
constructor(opt_options) {
Interaction.call(this, {
handleEvent: handleEvent
@@ -147,7 +148,49 @@ const MouseWheelZoom = function(opt_options) {
*/
this.trackpadZoomBuffer_ = 1.5;
};
}
/**
* @private
*/
decrementInteractingHint_() {
this.trackpadTimeoutId_ = undefined;
const view = this.getMap().getView();
view.setHint(ViewHint.INTERACTING, -1);
}
/**
* @private
* @param {module:ol/PluggableMap} map Map.
*/
handleWheelZoom_(map) {
const view = map.getView();
if (view.getAnimating()) {
view.cancelAnimations();
}
const maxDelta = MAX_DELTA;
const delta = clamp(this.delta_, -maxDelta, maxDelta);
zoomByDelta(view, -delta, this.lastAnchor_, this.duration_);
this.mode_ = undefined;
this.delta_ = 0;
this.lastAnchor_ = null;
this.startTime_ = undefined;
this.timeoutId_ = undefined;
}
/**
* Enable or disable using the mouse's location as an anchor when zooming
* @param {boolean} useAnchor true to zoom to the mouse's location, false
* to zoom to the center of the map
* @api
*/
setMouseAnchor(useAnchor) {
this.useAnchor_ = useAnchor;
if (!useAnchor) {
this.lastAnchor_ = null;
}
}
}
inherits(MouseWheelZoom, Interaction);
@@ -276,48 +319,4 @@ function handleEvent(mapBrowserEvent) {
}
/**
* @private
*/
MouseWheelZoom.prototype.decrementInteractingHint_ = function() {
this.trackpadTimeoutId_ = undefined;
const view = this.getMap().getView();
view.setHint(ViewHint.INTERACTING, -1);
};
/**
* @private
* @param {module:ol/PluggableMap} map Map.
*/
MouseWheelZoom.prototype.handleWheelZoom_ = function(map) {
const view = map.getView();
if (view.getAnimating()) {
view.cancelAnimations();
}
const maxDelta = MAX_DELTA;
const delta = clamp(this.delta_, -maxDelta, maxDelta);
zoomByDelta(view, -delta, this.lastAnchor_, this.duration_);
this.mode_ = undefined;
this.delta_ = 0;
this.lastAnchor_ = null;
this.startTime_ = undefined;
this.timeoutId_ = undefined;
};
/**
* Enable or disable using the mouse's location as an anchor when zooming
* @param {boolean} useAnchor true to zoom to the mouse's location, false
* to zoom to the center of the map
* @api
*/
MouseWheelZoom.prototype.setMouseAnchor = function(useAnchor) {
this.useAnchor_ = useAnchor;
if (!useAnchor) {
this.lastAnchor_ = null;
}
};
export default MouseWheelZoom;
src/ol/interaction/Pointer.js
+43 -42
View File
@@ -77,7 +77,8 @@ const handleMoveEvent = UNDEFINED;
* @extends {module:ol/interaction/Interaction}
* @api
*/
const PointerInteraction = function(opt_options) {
class PointerInteraction {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
@@ -131,7 +132,47 @@ const PointerInteraction = function(opt_options) {
*/
this.targetPointers = [];
};
}
/**
* @param {module:ol/MapBrowserPointerEvent} mapBrowserEvent Event.
* @private
*/
updateTrackedPointers_(mapBrowserEvent) {
if (isPointerDraggingEvent(mapBrowserEvent)) {
const event = mapBrowserEvent.pointerEvent;
const id = event.pointerId.toString();
if (mapBrowserEvent.type == MapBrowserEventType.POINTERUP) {
delete this.trackedPointers_[id];
} else if (mapBrowserEvent.type ==
MapBrowserEventType.POINTERDOWN) {
this.trackedPointers_[id] = event;
} else if (id in this.trackedPointers_) {
// update only when there was a pointerdown event for this pointer
this.trackedPointers_[id] = event;
}
this.targetPointers = getValues(this.trackedPointers_);
}
}
/**
* This method is used to determine if "down" events should be propagated to
* other interactions or should be stopped.
*
* The method receives the return code of the "handleDownEvent" function.
*
* By default this function is the "identity" function. It's overridden in
* child classes.
*
* @param {boolean} handled Was the event handled by the interaction?
* @return {boolean} Should the event be stopped?
* @protected
*/
shouldStopEvent(handled) {
return handled;
}
}
inherits(PointerInteraction, Interaction);
@@ -165,29 +206,6 @@ function isPointerDraggingEvent(mapBrowserEvent) {
}
/**
* @param {module:ol/MapBrowserPointerEvent} mapBrowserEvent Event.
* @private
*/
PointerInteraction.prototype.updateTrackedPointers_ = function(mapBrowserEvent) {
if (isPointerDraggingEvent(mapBrowserEvent)) {
const event = mapBrowserEvent.pointerEvent;
const id = event.pointerId.toString();
if (mapBrowserEvent.type == MapBrowserEventType.POINTERUP) {
delete this.trackedPointers_[id];
} else if (mapBrowserEvent.type ==
MapBrowserEventType.POINTERDOWN) {
this.trackedPointers_[id] = event;
} else if (id in this.trackedPointers_) {
// update only when there was a pointerdown event for this pointer
this.trackedPointers_[id] = event;
}
this.targetPointers = getValues(this.trackedPointers_);
}
};
/**
* Handles the {@link module:ol/MapBrowserEvent map browser event} and may call into
* other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are
@@ -224,21 +242,4 @@ export function handleEvent(mapBrowserEvent) {
}
/**
* This method is used to determine if "down" events should be propagated to
* other interactions or should be stopped.
*
* The method receives the return code of the "handleDownEvent" function.
*
* By default this function is the "identity" function. It's overridden in
* child classes.
*
* @param {boolean} handled Was the event handled by the interaction?
* @return {boolean} Should the event be stopped?
* @protected
*/
PointerInteraction.prototype.shouldStopEvent = function(handled) {
return handled;
};
export default PointerInteraction;
src/ol/interaction/Select.js
+77 -84
View File
@@ -156,7 +156,8 @@ inherits(SelectEvent, Event);
* @fires SelectEvent
* @api
*/
const Select = function(opt_options) {
class Select {
constructor(opt_options) {
Interaction.call(this, {
handleEvent: handleEvent
@@ -259,41 +260,35 @@ const Select = function(opt_options) {
listen(features, CollectionEventType.REMOVE,
this.removeFeature_, this);
};
inherits(Select, Interaction);
}
/**
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
* @param {module:ol/layer/Layer} layer Layer.
* @private
*/
Select.prototype.addFeatureLayerAssociation_ = function(feature, layer) {
addFeatureLayerAssociation_(feature, layer) {
const key = getUid(feature);
this.featureLayerAssociation_[key] = layer;
};
}
/**
* Get the selected features.
* @return {module:ol/Collection.<module:ol/Feature>} Features collection.
* @api
*/
Select.prototype.getFeatures = function() {
getFeatures() {
return this.featureOverlay_.getSource().getFeaturesCollection();
};
}
/**
* Returns the Hit-detection tolerance.
* @returns {number} Hit tolerance in pixels.
* @api
*/
Select.prototype.getHitTolerance = function() {
getHitTolerance() {
return this.hitTolerance_;
};
}
/**
* Returns the associated {@link module:ol/layer/Vector~Vector vectorlayer} of
@@ -304,12 +299,78 @@ Select.prototype.getHitTolerance = function() {
* @return {module:ol/layer/Vector} Layer.
* @api
*/
Select.prototype.getLayer = function(feature) {
getLayer(feature) {
const key = getUid(feature);
return (
/** @type {module:ol/layer/Vector} */ (this.featureLayerAssociation_[key])
);
};
}
/**
* Hit-detection tolerance. Pixels inside the radius around the given position
* will be checked for features. This only works for the canvas renderer and
* not for WebGL.
* @param {number} hitTolerance Hit tolerance in pixels.
* @api
*/
setHitTolerance(hitTolerance) {
this.hitTolerance_ = hitTolerance;
}
/**
* Remove the interaction from its current map, if any, and attach it to a new
* map, if any. Pass `null` to just remove the interaction from the current map.
* @param {module:ol/PluggableMap} map Map.
* @override
* @api
*/
setMap(map) {
const currentMap = this.getMap();
const selectedFeatures =
this.featureOverlay_.getSource().getFeaturesCollection();
if (currentMap) {
selectedFeatures.forEach(currentMap.unskipFeature.bind(currentMap));
}
Interaction.prototype.setMap.call(this, map);
this.featureOverlay_.setMap(map);
if (map) {
selectedFeatures.forEach(map.skipFeature.bind(map));
}
}
/**
* @param {module:ol/Collection~CollectionEvent} evt Event.
* @private
*/
addFeature_(evt) {
const map = this.getMap();
if (map) {
map.skipFeature(/** @type {module:ol/Feature} */ (evt.element));
}
}
/**
* @param {module:ol/Collection~CollectionEvent} evt Event.
* @private
*/
removeFeature_(evt) {
const map = this.getMap();
if (map) {
map.unskipFeature(/** @type {module:ol/Feature} */ (evt.element));
}
}
/**
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
* @private
*/
removeFeatureLayerAssociation_(feature) {
const key = getUid(feature);
delete this.featureLayerAssociation_[key];
}
}
inherits(Select, Interaction);
/**
@@ -405,40 +466,6 @@ function handleEvent(mapBrowserEvent) {
}
/**
* Hit-detection tolerance. Pixels inside the radius around the given position
* will be checked for features. This only works for the canvas renderer and
* not for WebGL.
* @param {number} hitTolerance Hit tolerance in pixels.
* @api
*/
Select.prototype.setHitTolerance = function(hitTolerance) {
this.hitTolerance_ = hitTolerance;
};
/**
* Remove the interaction from its current map, if any, and attach it to a new
* map, if any. Pass `null` to just remove the interaction from the current map.
* @param {module:ol/PluggableMap} map Map.
* @override
* @api
*/
Select.prototype.setMap = function(map) {
const currentMap = this.getMap();
const selectedFeatures =
this.featureOverlay_.getSource().getFeaturesCollection();
if (currentMap) {
selectedFeatures.forEach(currentMap.unskipFeature.bind(currentMap));
}
Interaction.prototype.setMap.call(this, map);
this.featureOverlay_.setMap(map);
if (map) {
selectedFeatures.forEach(map.skipFeature.bind(map));
}
};
/**
* @return {module:ol/style/Style~StyleFunction} Styles.
*/
@@ -456,38 +483,4 @@ function getDefaultStyleFunction() {
}
/**
* @param {module:ol/Collection~CollectionEvent} evt Event.
* @private
*/
Select.prototype.addFeature_ = function(evt) {
const map = this.getMap();
if (map) {
map.skipFeature(/** @type {module:ol/Feature} */ (evt.element));
}
};
/**
* @param {module:ol/Collection~CollectionEvent} evt Event.
* @private
*/
Select.prototype.removeFeature_ = function(evt) {
const map = this.getMap();
if (map) {
map.unskipFeature(/** @type {module:ol/Feature} */ (evt.element));
}
};
/**
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
* @private
*/
Select.prototype.removeFeatureLayerAssociation_ = function(feature) {
const key = getUid(feature);
delete this.featureLayerAssociation_[key];
};
export default Select;
src/ol/interaction/Snap.js
+50 -67
View File
@@ -68,7 +68,8 @@ import RBush from '../structs/RBush.js';
* @param {module:ol/interaction/Snap~Options=} opt_options Options.
* @api
*/
const Snap = function(opt_options) {
class Snap {
constructor(opt_options) {
PointerInteraction.call(this, {
handleEvent: handleEvent,
@@ -176,10 +177,7 @@ const Snap = function(opt_options) {
'GeometryCollection': this.writeGeometryCollectionGeometry_,
'Circle': this.writeCircleGeometry_
};
};
inherits(Snap, PointerInteraction);
}
/**
* Add a feature to the collection of features that we may snap to.
@@ -188,7 +186,7 @@ inherits(Snap, PointerInteraction);
* Defaults to `true`.
* @api
*/
Snap.prototype.addFeature = function(feature, opt_listen) {
addFeature(feature, opt_listen) {
const register = opt_listen !== undefined ? opt_listen : true;
const feature_uid = getUid(feature);
const geometry = feature.getGeometry();
@@ -206,32 +204,29 @@ Snap.prototype.addFeature = function(feature, opt_listen) {
EventType.CHANGE,
this.handleFeatureChange_, this);
}
};
}
/**
* @param {module:ol/Feature} feature Feature.
* @private
*/
Snap.prototype.forEachFeatureAdd_ = function(feature) {
forEachFeatureAdd_(feature) {
this.addFeature(feature);
};
}
/**
* @param {module:ol/Feature} feature Feature.
* @private
*/
Snap.prototype.forEachFeatureRemove_ = function(feature) {
forEachFeatureRemove_(feature) {
this.removeFeature(feature);
};
}
/**
* @return {module:ol/Collection.<module:ol/Feature>|Array.<module:ol/Feature>} Features.
* @private
*/
Snap.prototype.getFeatures_ = function() {
getFeatures_() {
let features;
if (this.features_) {
features = this.features_;
@@ -241,14 +236,13 @@ Snap.prototype.getFeatures_ = function() {
return (
/** @type {!Array.<module:ol/Feature>|!module:ol/Collection.<module:ol/Feature>} */ (features)
);
};
}
/**
* @param {module:ol/source/Vector|module:ol/Collection~CollectionEvent} evt Event.
* @private
*/
Snap.prototype.handleFeatureAdd_ = function(evt) {
handleFeatureAdd_(evt) {
let feature;
if (evt instanceof VectorSourceEvent) {
feature = evt.feature;
@@ -256,14 +250,13 @@ Snap.prototype.handleFeatureAdd_ = function(evt) {
feature = evt.element;
}
this.addFeature(/** @type {module:ol/Feature} */ (feature));
};
}
/**
* @param {module:ol/source/Vector|module:ol/Collection~CollectionEvent} evt Event.
* @private
*/
Snap.prototype.handleFeatureRemove_ = function(evt) {
handleFeatureRemove_(evt) {
let feature;
if (evt instanceof VectorSourceEvent) {
feature = evt.feature;
@@ -271,14 +264,13 @@ Snap.prototype.handleFeatureRemove_ = function(evt) {
feature = evt.element;
}
this.removeFeature(/** @type {module:ol/Feature} */ (feature));
};
}
/**
* @param {module:ol/events/Event} evt Event.
* @private
*/
Snap.prototype.handleFeatureChange_ = function(evt) {
handleFeatureChange_(evt) {
const feature = /** @type {module:ol/Feature} */ (evt.target);
if (this.handlingDownUpSequence) {
const uid = getUid(feature);
@@ -288,8 +280,7 @@ Snap.prototype.handleFeatureChange_ = function(evt) {
} else {
this.updateFeature_(feature);
}
};
}
/**
* Remove a feature from the collection of features that we may snap to.
@@ -298,7 +289,7 @@ Snap.prototype.handleFeatureChange_ = function(evt) {
* or not. Defaults to `true`.
* @api
*/
Snap.prototype.removeFeature = function(feature, opt_unlisten) {
removeFeature(feature, opt_unlisten) {
const unregister = opt_unlisten !== undefined ? opt_unlisten : true;
const feature_uid = getUid(feature);
const extent = this.indexedFeaturesExtents_[feature_uid];
@@ -319,13 +310,12 @@ Snap.prototype.removeFeature = function(feature, opt_unlisten) {
unlistenByKey(this.featureChangeListenerKeys_[feature_uid]);
delete this.featureChangeListenerKeys_[feature_uid];
}
};
}
/**
* @inheritDoc
*/
Snap.prototype.setMap = function(map) {
setMap(map) {
const currentMap = this.getMap();
const keys = this.featuresListenerKeys_;
const features = this.getFeatures_();
@@ -355,14 +345,7 @@ Snap.prototype.setMap = function(map) {
}
features.forEach(this.forEachFeatureAdd_.bind(this));
}
};
/**
* @inheritDoc
*/
Snap.prototype.shouldStopEvent = FALSE;
}
/**
* @param {module:ol~Pixel} pixel Pixel
@@ -370,7 +353,7 @@ Snap.prototype.shouldStopEvent = FALSE;
* @param {module:ol/PluggableMap} map Map.
* @return {module:ol/interaction/Snap~Result} Snap result
*/
Snap.prototype.snapTo = function(pixel, pixelCoordinate, map) {
snapTo(pixel, pixelCoordinate, map) {
const lowerLeft = map.getCoordinateFromPixel(
[pixel[0] - this.pixelTolerance_, pixel[1] + this.pixelTolerance_]);
@@ -446,25 +429,23 @@ Snap.prototype.snapTo = function(pixel, pixelCoordinate, map) {
vertexPixel: vertexPixel
})
);
};
}
/**
* @param {module:ol/Feature} feature Feature
* @private
*/
Snap.prototype.updateFeature_ = function(feature) {
updateFeature_(feature) {
this.removeFeature(feature, false);
this.addFeature(feature, false);
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/Circle} geometry Geometry.
* @private
*/
Snap.prototype.writeCircleGeometry_ = function(feature, geometry) {
writeCircleGeometry_(feature, geometry) {
const polygon = fromCircle(geometry);
const coordinates = polygon.getCoordinates()[0];
for (let i = 0, ii = coordinates.length - 1; i < ii; ++i) {
@@ -475,15 +456,14 @@ Snap.prototype.writeCircleGeometry_ = function(feature, geometry) {
});
this.rBush_.insert(boundingExtent(segment), segmentData);
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/GeometryCollection} geometry Geometry.
* @private
*/
Snap.prototype.writeGeometryCollectionGeometry_ = function(feature, geometry) {
writeGeometryCollectionGeometry_(feature, geometry) {
const geometries = geometry.getGeometriesArray();
for (let i = 0; i < geometries.length; ++i) {
const segmentWriter = this.SEGMENT_WRITERS_[geometries[i].getType()];
@@ -491,15 +471,14 @@ Snap.prototype.writeGeometryCollectionGeometry_ = function(feature, geometry) {
segmentWriter.call(this, feature, geometries[i]);
}
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/LineString} geometry Geometry.
* @private
*/
Snap.prototype.writeLineStringGeometry_ = function(feature, geometry) {
writeLineStringGeometry_(feature, geometry) {
const coordinates = geometry.getCoordinates();
for (let i = 0, ii = coordinates.length - 1; i < ii; ++i) {
const segment = coordinates.slice(i, i + 2);
@@ -509,15 +488,14 @@ Snap.prototype.writeLineStringGeometry_ = function(feature, geometry) {
});
this.rBush_.insert(boundingExtent(segment), segmentData);
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/MultiLineString} geometry Geometry.
* @private
*/
Snap.prototype.writeMultiLineStringGeometry_ = function(feature, geometry) {
writeMultiLineStringGeometry_(feature, geometry) {
const lines = geometry.getCoordinates();
for (let j = 0, jj = lines.length; j < jj; ++j) {
const coordinates = lines[j];
@@ -530,15 +508,14 @@ Snap.prototype.writeMultiLineStringGeometry_ = function(feature, geometry) {
this.rBush_.insert(boundingExtent(segment), segmentData);
}
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/MultiPoint} geometry Geometry.
* @private
*/
Snap.prototype.writeMultiPointGeometry_ = function(feature, geometry) {
writeMultiPointGeometry_(feature, geometry) {
const points = geometry.getCoordinates();
for (let i = 0, ii = points.length; i < ii; ++i) {
const coordinates = points[i];
@@ -548,15 +525,14 @@ Snap.prototype.writeMultiPointGeometry_ = function(feature, geometry) {
});
this.rBush_.insert(geometry.getExtent(), segmentData);
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/MultiPolygon} geometry Geometry.
* @private
*/
Snap.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
writeMultiPolygonGeometry_(feature, geometry) {
const polygons = geometry.getCoordinates();
for (let k = 0, kk = polygons.length; k < kk; ++k) {
const rings = polygons[k];
@@ -572,30 +548,28 @@ Snap.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
}
}
}
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/Point} geometry Geometry.
* @private
*/
Snap.prototype.writePointGeometry_ = function(feature, geometry) {
writePointGeometry_(feature, geometry) {
const coordinates = geometry.getCoordinates();
const segmentData = /** @type {module:ol/interaction/Snap~SegmentData} */ ({
feature: feature,
segment: [coordinates, coordinates]
});
this.rBush_.insert(geometry.getExtent(), segmentData);
};
}
/**
* @param {module:ol/Feature} feature Feature
* @param {module:ol/geom/Polygon} geometry Geometry.
* @private
*/
Snap.prototype.writePolygonGeometry_ = function(feature, geometry) {
writePolygonGeometry_(feature, geometry) {
const rings = geometry.getCoordinates();
for (let j = 0, jj = rings.length; j < jj; ++j) {
const coordinates = rings[j];
@@ -608,7 +582,16 @@ Snap.prototype.writePolygonGeometry_ = function(feature, geometry) {
this.rBush_.insert(boundingExtent(segment), segmentData);
}
}
};
}
}
inherits(Snap, PointerInteraction);
/**
* @inheritDoc
*/
Snap.prototype.shouldStopEvent = FALSE;
/**
src/ol/interaction/Translate.js
+77 -81
View File
@@ -96,7 +96,8 @@ inherits(TranslateEvent, Event);
* @param {module:ol/interaction/Translate~Options=} opt_options Options.
* @api
*/
const Translate = function(opt_options) {
class Translate {
constructor(opt_options) {
PointerInteraction.call(this, {
handleDownEvent: handleDownEvent,
handleDragEvent: handleDragEvent,
@@ -157,7 +158,81 @@ const Translate = function(opt_options) {
getChangeEventType(InteractionProperty.ACTIVE),
this.handleActiveChanged_, this);
};
}
/**
* Tests to see if the given coordinates intersects any of our selected
* features.
* @param {module:ol~Pixel} pixel Pixel coordinate to test for intersection.
* @param {module:ol/PluggableMap} map Map to test the intersection on.
* @return {module:ol/Feature} Returns the feature found at the specified pixel
* coordinates.
* @private
*/
featuresAtPixel_(pixel, map) {
return map.forEachFeatureAtPixel(pixel,
function(feature) {
if (!this.features_ || includes(this.features_.getArray(), feature)) {
return feature;
}
}.bind(this), {
layerFilter: this.layerFilter_,
hitTolerance: this.hitTolerance_
});
}
/**
* Returns the Hit-detection tolerance.
* @returns {number} Hit tolerance in pixels.
* @api
*/
getHitTolerance() {
return this.hitTolerance_;
}
/**
* Hit-detection tolerance. Pixels inside the radius around the given position
* will be checked for features. This only works for the canvas renderer and
* not for WebGL.
* @param {number} hitTolerance Hit tolerance in pixels.
* @api
*/
setHitTolerance(hitTolerance) {
this.hitTolerance_ = hitTolerance;
}
/**
* @inheritDoc
*/
setMap(map) {
const oldMap = this.getMap();
PointerInteraction.prototype.setMap.call(this, map);
this.updateState_(oldMap);
}
/**
* @private
*/
handleActiveChanged_() {
this.updateState_(null);
}
/**
* @param {module:ol/PluggableMap} oldMap Old map.
* @private
*/
updateState_(oldMap) {
let map = this.getMap();
const active = this.getActive();
if (!map || !active) {
map = map || oldMap;
if (map) {
const elem = map.getViewport();
elem.classList.remove('ol-grab', 'ol-grabbing');
}
}
}
}
inherits(Translate, PointerInteraction);
@@ -252,83 +327,4 @@ function handleMoveEvent(event) {
}
/**
* Tests to see if the given coordinates intersects any of our selected
* features.
* @param {module:ol~Pixel} pixel Pixel coordinate to test for intersection.
* @param {module:ol/PluggableMap} map Map to test the intersection on.
* @return {module:ol/Feature} Returns the feature found at the specified pixel
* coordinates.
* @private
*/
Translate.prototype.featuresAtPixel_ = function(pixel, map) {
return map.forEachFeatureAtPixel(pixel,
function(feature) {
if (!this.features_ || includes(this.features_.getArray(), feature)) {
return feature;
}
}.bind(this), {
layerFilter: this.layerFilter_,
hitTolerance: this.hitTolerance_
});
};
/**
* Returns the Hit-detection tolerance.
* @returns {number} Hit tolerance in pixels.
* @api
*/
Translate.prototype.getHitTolerance = function() {
return this.hitTolerance_;
};
/**
* Hit-detection tolerance. Pixels inside the radius around the given position
* will be checked for features. This only works for the canvas renderer and
* not for WebGL.
* @param {number} hitTolerance Hit tolerance in pixels.
* @api
*/
Translate.prototype.setHitTolerance = function(hitTolerance) {
this.hitTolerance_ = hitTolerance;
};
/**
* @inheritDoc
*/
Translate.prototype.setMap = function(map) {
const oldMap = this.getMap();
PointerInteraction.prototype.setMap.call(this, map);
this.updateState_(oldMap);
};
/**
* @private
*/
Translate.prototype.handleActiveChanged_ = function() {
this.updateState_(null);
};
/**
* @param {module:ol/PluggableMap} oldMap Old map.
* @private
*/
Translate.prototype.updateState_ = function(oldMap) {
let map = this.getMap();
const active = this.getActive();
if (!map || !active) {
map = map || oldMap;
if (map) {
const elem = map.getViewport();
elem.classList.remove('ol-grab', 'ol-grabbing');
}
}
};
export default Translate;
src/ol/layer/Base.js
+39 -52
View File
@@ -37,7 +37,8 @@ import {assign} from '../obj.js';
* @param {module:ol/layer/Base~Options} options Layer options.
* @api
*/
const BaseLayer = function(options) {
class BaseLayer {
constructor(options) {
BaseObject.call(this);
@@ -74,24 +75,20 @@ const BaseLayer = function(options) {
*/
this.type;
};
inherits(BaseLayer, BaseObject);
}
/**
* Get the layer type (used when creating a layer renderer).
* @return {module:ol/LayerType} The layer type.
*/
BaseLayer.prototype.getType = function() {
getType() {
return this.type;
};
}
/**
* @return {module:ol/layer/Layer~State} Layer state.
*/
BaseLayer.prototype.getLayerState = function() {
getLayerState() {
this.state_.opacity = clamp(this.getOpacity(), 0, 1);
this.state_.sourceState = this.getSourceState();
this.state_.visible = this.getVisible();
@@ -101,8 +98,7 @@ BaseLayer.prototype.getLayerState = function() {
this.state_.minResolution = Math.max(this.getMinResolution(), 0);
return this.state_;
};
}
/**
* @abstract
@@ -110,8 +106,7 @@ BaseLayer.prototype.getLayerState = function() {
* modified in place).
* @return {Array.<module:ol/layer/Layer>} Array of layers.
*/
BaseLayer.prototype.getLayersArray = function(opt_array) {};
getLayersArray(opt_array) {}
/**
* @abstract
@@ -119,8 +114,7 @@ BaseLayer.prototype.getLayersArray = function(opt_array) {};
* states (to be modified in place).
* @return {Array.<module:ol/layer/Layer~State>} List of layer states.
*/
BaseLayer.prototype.getLayerStatesArray = function(opt_states) {};
getLayerStatesArray(opt_states) {}
/**
* Return the {@link module:ol/extent~Extent extent} of the layer or `undefined` if it
@@ -129,12 +123,11 @@ BaseLayer.prototype.getLayerStatesArray = function(opt_states) {};
* @observable
* @api
*/
BaseLayer.prototype.getExtent = function() {
getExtent() {
return (
/** @type {module:ol/extent~Extent|undefined} */ (this.get(LayerProperty.EXTENT))
);
};
}
/**
* Return the maximum resolution of the layer.
@@ -142,10 +135,9 @@ BaseLayer.prototype.getExtent = function() {
* @observable
* @api
*/
BaseLayer.prototype.getMaxResolution = function() {
getMaxResolution() {
return /** @type {number} */ (this.get(LayerProperty.MAX_RESOLUTION));
};
}
/**
* Return the minimum resolution of the layer.
@@ -153,10 +145,9 @@ BaseLayer.prototype.getMaxResolution = function() {
* @observable
* @api
*/
BaseLayer.prototype.getMinResolution = function() {
getMinResolution() {
return /** @type {number} */ (this.get(LayerProperty.MIN_RESOLUTION));
};
}
/**
* Return the opacity of the layer (between 0 and 1).
@@ -164,17 +155,15 @@ BaseLayer.prototype.getMinResolution = function() {
* @observable
* @api
*/
BaseLayer.prototype.getOpacity = function() {
getOpacity() {
return /** @type {number} */ (this.get(LayerProperty.OPACITY));
};
}
/**
* @abstract
* @return {module:ol/source/State} Source state.
*/
BaseLayer.prototype.getSourceState = function() {};
getSourceState() {}
/**
* Return the visibility of the layer (`true` or `false`).
@@ -182,10 +171,9 @@ BaseLayer.prototype.getSourceState = function() {};
* @observable
* @api
*/
BaseLayer.prototype.getVisible = function() {
getVisible() {
return /** @type {boolean} */ (this.get(LayerProperty.VISIBLE));
};
}
/**
* Return the Z-index of the layer, which is used to order layers before
@@ -194,10 +182,9 @@ BaseLayer.prototype.getVisible = function() {
* @observable
* @api
*/
BaseLayer.prototype.getZIndex = function() {
getZIndex() {
return /** @type {number} */ (this.get(LayerProperty.Z_INDEX));
};
}
/**
* Set the extent at which the layer is visible. If `undefined`, the layer
@@ -206,10 +193,9 @@ BaseLayer.prototype.getZIndex = function() {
* @observable
* @api
*/
BaseLayer.prototype.setExtent = function(extent) {
setExtent(extent) {
this.set(LayerProperty.EXTENT, extent);
};
}
/**
* Set the maximum resolution at which the layer is visible.
@@ -217,10 +203,9 @@ BaseLayer.prototype.setExtent = function(extent) {
* @observable
* @api
*/
BaseLayer.prototype.setMaxResolution = function(maxResolution) {
setMaxResolution(maxResolution) {
this.set(LayerProperty.MAX_RESOLUTION, maxResolution);
};
}
/**
* Set the minimum resolution at which the layer is visible.
@@ -228,10 +213,9 @@ BaseLayer.prototype.setMaxResolution = function(maxResolution) {
* @observable
* @api
*/
BaseLayer.prototype.setMinResolution = function(minResolution) {
setMinResolution(minResolution) {
this.set(LayerProperty.MIN_RESOLUTION, minResolution);
};
}
/**
* Set the opacity of the layer, allowed values range from 0 to 1.
@@ -239,10 +223,9 @@ BaseLayer.prototype.setMinResolution = function(minResolution) {
* @observable
* @api
*/
BaseLayer.prototype.setOpacity = function(opacity) {
setOpacity(opacity) {
this.set(LayerProperty.OPACITY, opacity);
};
}
/**
* Set the visibility of the layer (`true` or `false`).
@@ -250,10 +233,9 @@ BaseLayer.prototype.setOpacity = function(opacity) {
* @observable
* @api
*/
BaseLayer.prototype.setVisible = function(visible) {
setVisible(visible) {
this.set(LayerProperty.VISIBLE, visible);
};
}
/**
* Set Z-index of the layer, which is used to order layers before rendering.
@@ -262,7 +244,12 @@ BaseLayer.prototype.setVisible = function(visible) {
* @observable
* @api
*/
BaseLayer.prototype.setZIndex = function(zindex) {
setZIndex(zindex) {
this.set(LayerProperty.Z_INDEX, zindex);
};
}
}
inherits(BaseLayer, BaseObject);
export default BaseLayer;
src/ol/layer/Group.js
+25 -31
View File
@@ -51,7 +51,8 @@ const Property = {
* @param {module:ol/layer/Group~Options=} opt_options Layer options.
* @api
*/
const LayerGroup = function(opt_options) {
class LayerGroup {
constructor(opt_options) {
const options = opt_options || {};
const baseOptions = /** @type {module:ol/layer/Group~Options} */ (assign({}, options));
@@ -91,24 +92,20 @@ const LayerGroup = function(opt_options) {
this.setLayers(layers);
};
inherits(LayerGroup, BaseLayer);
}
/**
* @private
*/
LayerGroup.prototype.handleLayerChange_ = function() {
handleLayerChange_() {
this.changed();
};
}
/**
* @param {module:ol/events/Event} event Event.
* @private
*/
LayerGroup.prototype.handleLayersChanged_ = function(event) {
handleLayersChanged_(event) {
this.layersListenerKeys_.forEach(unlistenByKey);
this.layersListenerKeys_.length = 0;
@@ -133,14 +130,13 @@ LayerGroup.prototype.handleLayersChanged_ = function(event) {
}
this.changed();
};
}
/**
* @param {module:ol/Collection~CollectionEvent} collectionEvent CollectionEvent.
* @private
*/
LayerGroup.prototype.handleLayersAdd_ = function(collectionEvent) {
handleLayersAdd_(collectionEvent) {
const layer = /** @type {module:ol/layer/Base} */ (collectionEvent.element);
const key = getUid(layer).toString();
this.listenerKeys_[key] = [
@@ -148,21 +144,19 @@ LayerGroup.prototype.handleLayersAdd_ = function(collectionEvent) {
listen(layer, EventType.CHANGE, this.handleLayerChange_, this)
];
this.changed();
};
}
/**
* @param {module:ol/Collection~CollectionEvent} collectionEvent CollectionEvent.
* @private
*/
LayerGroup.prototype.handleLayersRemove_ = function(collectionEvent) {
handleLayersRemove_(collectionEvent) {
const layer = /** @type {module:ol/layer/Base} */ (collectionEvent.element);
const key = getUid(layer).toString();
this.listenerKeys_[key].forEach(unlistenByKey);
delete this.listenerKeys_[key];
this.changed();
};
}
/**
* Returns the {@link module:ol/Collection collection} of {@link module:ol/layer/Layer~Layer layers}
@@ -172,12 +166,11 @@ LayerGroup.prototype.handleLayersRemove_ = function(collectionEvent) {
* @observable
* @api
*/
LayerGroup.prototype.getLayers = function() {
getLayers() {
return (
/** @type {!module:ol/Collection.<module:ol/layer/Base>} */ (this.get(Property.LAYERS))
);
};
}
/**
* Set the {@link module:ol/Collection collection} of {@link module:ol/layer/Layer~Layer layers}
@@ -187,27 +180,25 @@ LayerGroup.prototype.getLayers = function() {
* @observable
* @api
*/
LayerGroup.prototype.setLayers = function(layers) {
setLayers(layers) {
this.set(Property.LAYERS, layers);
};
}
/**
* @inheritDoc
*/
LayerGroup.prototype.getLayersArray = function(opt_array) {
getLayersArray(opt_array) {
const array = opt_array !== undefined ? opt_array : [];
this.getLayers().forEach(function(layer) {
layer.getLayersArray(array);
});
return array;
};
}
/**
* @inheritDoc
*/
LayerGroup.prototype.getLayerStatesArray = function(opt_states) {
getLayerStatesArray(opt_states) {
const states = opt_states !== undefined ? opt_states : [];
const pos = states.length;
@@ -235,14 +226,17 @@ LayerGroup.prototype.getLayerStatesArray = function(opt_states) {
}
return states;
};
}
/**
* @inheritDoc
*/
LayerGroup.prototype.getSourceState = function() {
getSourceState() {
return SourceState.READY;
};
}
}
inherits(LayerGroup, BaseLayer);
export default LayerGroup;
src/ol/layer/Heatmap.js
+120 -127
View File
@@ -73,7 +73,8 @@ const DEFAULT_GRADIENT = ['#00f', '#0ff', '#0f0', '#ff0', '#f00'];
* @param {module:ol/layer/Heatmap~Options=} opt_options Options.
* @api
*/
const Heatmap = function(opt_options) {
class Heatmap {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
const baseOptions = assign({}, options);
@@ -163,7 +164,124 @@ const Heatmap = function(opt_options) {
this.setRenderOrder(null);
listen(this, RenderEventType.RENDER, this.handleRender_, this);
};
}
/**
* @return {string} Data URL for a circle.
* @private
*/
createCircle_() {
const radius = this.getRadius();
const blur = this.getBlur();
const halfSize = radius + blur + 1;
const size = 2 * halfSize;
const context = createCanvasContext2D(size, size);
context.shadowOffsetX = context.shadowOffsetY = this.shadow_;
context.shadowBlur = blur;
context.shadowColor = '#000';
context.beginPath();
const center = halfSize - this.shadow_;
context.arc(center, center, radius, 0, Math.PI * 2, true);
context.fill();
return context.canvas.toDataURL();
}
/**
* Return the blur size in pixels.
* @return {number} Blur size in pixels.
* @api
* @observable
*/
getBlur() {
return /** @type {number} */ (this.get(Property.BLUR));
}
/**
* Return the gradient colors as array of strings.
* @return {Array.<string>} Colors.
* @api
* @observable
*/
getGradient() {
return /** @type {Array.<string>} */ (this.get(Property.GRADIENT));
}
/**
* Return the size of the radius in pixels.
* @return {number} Radius size in pixel.
* @api
* @observable
*/
getRadius() {
return /** @type {number} */ (this.get(Property.RADIUS));
}
/**
* @private
*/
handleGradientChanged_() {
this.gradient_ = createGradient(this.getGradient());
}
/**
* @private
*/
handleStyleChanged_() {
this.circleImage_ = this.createCircle_();
this.styleCache_ = new Array(256);
this.changed();
}
/**
* @param {module:ol/render/Event} event Post compose event
* @private
*/
handleRender_(event) {
const context = event.context;
const canvas = context.canvas;
const image = context.getImageData(0, 0, canvas.width, canvas.height);
const view8 = image.data;
for (let i = 0, ii = view8.length; i < ii; i += 4) {
const alpha = view8[i + 3] * 4;
if (alpha) {
view8[i] = this.gradient_[alpha];
view8[i + 1] = this.gradient_[alpha + 1];
view8[i + 2] = this.gradient_[alpha + 2];
}
}
context.putImageData(image, 0, 0);
}
/**
* Set the blur size in pixels.
* @param {number} blur Blur size in pixels.
* @api
* @observable
*/
setBlur(blur) {
this.set(Property.BLUR, blur);
}
/**
* Set the gradient colors as array of strings.
* @param {Array.<string>} colors Gradient.
* @api
* @observable
*/
setGradient(colors) {
this.set(Property.GRADIENT, colors);
}
/**
* Set the size of the radius in pixels.
* @param {number} radius Radius size in pixel.
* @api
* @observable
*/
setRadius(radius) {
this.set(Property.RADIUS, radius);
}
}
inherits(Heatmap, VectorLayer);
@@ -191,129 +309,4 @@ const createGradient = function(colors) {
};
/**
* @return {string} Data URL for a circle.
* @private
*/
Heatmap.prototype.createCircle_ = function() {
const radius = this.getRadius();
const blur = this.getBlur();
const halfSize = radius + blur + 1;
const size = 2 * halfSize;
const context = createCanvasContext2D(size, size);
context.shadowOffsetX = context.shadowOffsetY = this.shadow_;
context.shadowBlur = blur;
context.shadowColor = '#000';
context.beginPath();
const center = halfSize - this.shadow_;
context.arc(center, center, radius, 0, Math.PI * 2, true);
context.fill();
return context.canvas.toDataURL();
};
/**
* Return the blur size in pixels.
* @return {number} Blur size in pixels.
* @api
* @observable
*/
Heatmap.prototype.getBlur = function() {
return /** @type {number} */ (this.get(Property.BLUR));
};
/**
* Return the gradient colors as array of strings.
* @return {Array.<string>} Colors.
* @api
* @observable
*/
Heatmap.prototype.getGradient = function() {
return /** @type {Array.<string>} */ (this.get(Property.GRADIENT));
};
/**
* Return the size of the radius in pixels.
* @return {number} Radius size in pixel.
* @api
* @observable
*/
Heatmap.prototype.getRadius = function() {
return /** @type {number} */ (this.get(Property.RADIUS));
};
/**
* @private
*/
Heatmap.prototype.handleGradientChanged_ = function() {
this.gradient_ = createGradient(this.getGradient());
};
/**
* @private
*/
Heatmap.prototype.handleStyleChanged_ = function() {
this.circleImage_ = this.createCircle_();
this.styleCache_ = new Array(256);
this.changed();
};
/**
* @param {module:ol/render/Event} event Post compose event
* @private
*/
Heatmap.prototype.handleRender_ = function(event) {
const context = event.context;
const canvas = context.canvas;
const image = context.getImageData(0, 0, canvas.width, canvas.height);
const view8 = image.data;
for (let i = 0, ii = view8.length; i < ii; i += 4) {
const alpha = view8[i + 3] * 4;
if (alpha) {
view8[i] = this.gradient_[alpha];
view8[i + 1] = this.gradient_[alpha + 1];
view8[i + 2] = this.gradient_[alpha + 2];
}
}
context.putImageData(image, 0, 0);
};
/**
* Set the blur size in pixels.
* @param {number} blur Blur size in pixels.
* @api
* @observable
*/
Heatmap.prototype.setBlur = function(blur) {
this.set(Property.BLUR, blur);
};
/**
* Set the gradient colors as array of strings.
* @param {Array.<string>} colors Gradient.
* @api
* @observable
*/
Heatmap.prototype.setGradient = function(colors) {
this.set(Property.GRADIENT, colors);
};
/**
* Set the size of the radius in pixels.
* @param {number} radius Radius size in pixel.
* @api
* @observable
*/
Heatmap.prototype.setRadius = function(radius) {
this.set(Property.RADIUS, radius);
};
export default Heatmap;
src/ol/layer/Layer.js
+37 -41
View File
@@ -66,7 +66,8 @@ import SourceState from '../source/State.js';
* @param {module:ol/layer/Layer~Options} options Layer options.
* @api
*/
const Layer = function(options) {
class Layer {
constructor(options) {
const baseOptions = assign({}, options);
delete baseOptions.source;
@@ -101,44 +102,25 @@ const Layer = function(options) {
const source = options.source ? options.source : null;
this.setSource(source);
};
inherits(Layer, BaseLayer);
/**
* Return `true` if the layer is visible, and if the passed resolution is
* between the layer's minResolution and maxResolution. The comparison is
* inclusive for `minResolution` and exclusive for `maxResolution`.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @param {number} resolution Resolution.
* @return {boolean} The layer is visible at the given resolution.
*/
export function visibleAtResolution(layerState, resolution) {
return layerState.visible && resolution >= layerState.minResolution &&
resolution < layerState.maxResolution;
}
/**
* @inheritDoc
*/
Layer.prototype.getLayersArray = function(opt_array) {
getLayersArray(opt_array) {
const array = opt_array ? opt_array : [];
array.push(this);
return array;
};
}
/**
* @inheritDoc
*/
Layer.prototype.getLayerStatesArray = function(opt_states) {
getLayerStatesArray(opt_states) {
const states = opt_states ? opt_states : [];
states.push(this.getLayerState());
return states;
};
}
/**
* Get the layer source.
@@ -146,35 +128,32 @@ Layer.prototype.getLayerStatesArray = function(opt_states) {
* @observable
* @api
*/
Layer.prototype.getSource = function() {
getSource() {
const source = this.get(LayerProperty.SOURCE);
return (
/** @type {module:ol/source/Source} */ (source) || null
);
};
}
/**
* @inheritDoc
*/
Layer.prototype.getSourceState = function() {
getSourceState() {
const source = this.getSource();
return !source ? SourceState.UNDEFINED : source.getState();
};
}
/**
* @private
*/
Layer.prototype.handleSourceChange_ = function() {
handleSourceChange_() {
this.changed();
};
}
/**
* @private
*/
Layer.prototype.handleSourcePropertyChange_ = function() {
handleSourcePropertyChange_() {
if (this.sourceChangeKey_) {
unlistenByKey(this.sourceChangeKey_);
this.sourceChangeKey_ = null;
@@ -185,8 +164,7 @@ Layer.prototype.handleSourcePropertyChange_ = function() {
EventType.CHANGE, this.handleSourceChange_, this);
}
this.changed();
};
}
/**
* Sets the layer to be rendered on top of other layers on a map. The map will
@@ -200,7 +178,7 @@ Layer.prototype.handleSourcePropertyChange_ = function() {
* @param {module:ol/PluggableMap} map Map.
* @api
*/
Layer.prototype.setMap = function(map) {
setMap(map) {
if (this.mapPrecomposeKey_) {
unlistenByKey(this.mapPrecomposeKey_);
this.mapPrecomposeKey_ = null;
@@ -223,8 +201,7 @@ Layer.prototype.setMap = function(map) {
this.mapRenderKey_ = listen(this, EventType.CHANGE, map.render, map);
this.changed();
}
};
}
/**
* Set the layer source.
@@ -232,7 +209,26 @@ Layer.prototype.setMap = function(map) {
* @observable
* @api
*/
Layer.prototype.setSource = function(source) {
setSource(source) {
this.set(LayerProperty.SOURCE, source);
};
}
}
inherits(Layer, BaseLayer);
/**
* Return `true` if the layer is visible, and if the passed resolution is
* between the layer's minResolution and maxResolution. The comparison is
* inclusive for `minResolution` and exclusive for `maxResolution`.
* @param {module:ol/layer/Layer~State} layerState Layer state.
* @param {number} resolution Resolution.
* @return {boolean} The layer is visible at the given resolution.
*/
export function visibleAtResolution(layerState, resolution) {
return layerState.visible && resolution >= layerState.minResolution &&
resolution < layerState.maxResolution;
}
export default Layer;
src/ol/layer/Tile.js
+38 -38
View File
@@ -45,7 +45,8 @@ import {assign} from '../obj.js';
* @param {module:ol/layer/Tile~Options=} opt_options Tile layer options.
* @api
*/
const TileLayer = function(opt_options) {
class TileLayer {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
const baseOptions = assign({}, options);
@@ -65,10 +66,7 @@ const TileLayer = function(opt_options) {
*/
this.type = LayerType.TILE;
};
inherits(TileLayer, Layer);
}
/**
* Return the level as number to which we will preload tiles up to.
@@ -76,9 +74,42 @@ inherits(TileLayer, Layer);
* @observable
* @api
*/
TileLayer.prototype.getPreload = function() {
getPreload() {
return /** @type {number} */ (this.get(TileProperty.PRELOAD));
};
}
/**
* Set the level as number to which we will preload tiles up to.
* @param {number} preload The level to preload tiles up to.
* @observable
* @api
*/
setPreload(preload) {
this.set(TileProperty.PRELOAD, preload);
}
/**
* Whether we use interim tiles on error.
* @return {boolean} Use interim tiles on error.
* @observable
* @api
*/
getUseInterimTilesOnError() {
return /** @type {boolean} */ (this.get(TileProperty.USE_INTERIM_TILES_ON_ERROR));
}
/**
* Set whether we use interim tiles on error.
* @param {boolean} useInterimTilesOnError Use interim tiles on error.
* @observable
* @api
*/
setUseInterimTilesOnError(useInterimTilesOnError) {
this.set(TileProperty.USE_INTERIM_TILES_ON_ERROR, useInterimTilesOnError);
}
}
inherits(TileLayer, Layer);
/**
@@ -90,35 +121,4 @@ TileLayer.prototype.getPreload = function() {
TileLayer.prototype.getSource;
/**
* Set the level as number to which we will preload tiles up to.
* @param {number} preload The level to preload tiles up to.
* @observable
* @api
*/
TileLayer.prototype.setPreload = function(preload) {
this.set(TileProperty.PRELOAD, preload);
};
/**
* Whether we use interim tiles on error.
* @return {boolean} Use interim tiles on error.
* @observable
* @api
*/
TileLayer.prototype.getUseInterimTilesOnError = function() {
return /** @type {boolean} */ (this.get(TileProperty.USE_INTERIM_TILES_ON_ERROR));
};
/**
* Set whether we use interim tiles on error.
* @param {boolean} useInterimTilesOnError Use interim tiles on error.
* @observable
* @api
*/
TileLayer.prototype.setUseInterimTilesOnError = function(useInterimTilesOnError) {
this.set(TileProperty.USE_INTERIM_TILES_ON_ERROR, useInterimTilesOnError);
};
export default TileLayer;
src/ol/layer/Vector.js
+37 -46
View File
@@ -91,7 +91,8 @@ const Property = {
* @param {module:ol/layer/Vector~Options=} opt_options Options.
* @api
*/
const VectorLayer = function(opt_options) {
class VectorLayer {
constructor(opt_options) {
const options = opt_options ?
opt_options : /** @type {module:ol/layer/Vector~Options} */ ({});
@@ -159,54 +160,38 @@ const VectorLayer = function(opt_options) {
*/
this.type = LayerType.VECTOR;
};
inherits(VectorLayer, Layer);
}
/**
* @return {boolean} Declutter.
*/
VectorLayer.prototype.getDeclutter = function() {
getDeclutter() {
return this.declutter_;
};
}
/**
* @param {boolean} declutter Declutter.
*/
VectorLayer.prototype.setDeclutter = function(declutter) {
setDeclutter(declutter) {
this.declutter_ = declutter;
};
}
/**
* @return {number|undefined} Render buffer.
*/
VectorLayer.prototype.getRenderBuffer = function() {
getRenderBuffer() {
return this.renderBuffer_;
};
}
/**
* @return {function(module:ol/Feature, module:ol/Feature): number|null|undefined} Render
* order.
*/
VectorLayer.prototype.getRenderOrder = function() {
getRenderOrder() {
return (
/** @type {module:ol/render~OrderFunction|null|undefined} */ (this.get(Property.RENDER_ORDER))
);
};
/**
* Return the associated {@link module:ol/source/Vector vectorsource} of the layer.
* @function
* @return {module:ol/source/Vector} Source.
* @api
*/
VectorLayer.prototype.getSource;
}
/**
* Get the style for features. This returns whatever was passed to the `style`
@@ -215,47 +200,42 @@ VectorLayer.prototype.getSource;
* Layer style.
* @api
*/
VectorLayer.prototype.getStyle = function() {
getStyle() {
return this.style_;
};
}
/**
* Get the style function.
* @return {module:ol/style/Style~StyleFunction|undefined} Layer style function.
* @api
*/
VectorLayer.prototype.getStyleFunction = function() {
getStyleFunction() {
return this.styleFunction_;
};
}
/**
* @return {boolean} Whether the rendered layer should be updated while
* animating.
*/
VectorLayer.prototype.getUpdateWhileAnimating = function() {
getUpdateWhileAnimating() {
return this.updateWhileAnimating_;
};
}
/**
* @return {boolean} Whether the rendered layer should be updated while
* interacting.
*/
VectorLayer.prototype.getUpdateWhileInteracting = function() {
getUpdateWhileInteracting() {
return this.updateWhileInteracting_;
};
}
/**
* @param {module:ol/render~OrderFunction|null|undefined} renderOrder
* Render order.
*/
VectorLayer.prototype.setRenderOrder = function(renderOrder) {
setRenderOrder(renderOrder) {
this.set(Property.RENDER_ORDER, renderOrder);
};
}
/**
* Set the style for features. This can be a single style object, an array
@@ -268,20 +248,31 @@ VectorLayer.prototype.setRenderOrder = function(renderOrder) {
* style Layer style.
* @api
*/
VectorLayer.prototype.setStyle = function(style) {
setStyle(style) {
this.style_ = style !== undefined ? style : createDefaultStyle;
this.styleFunction_ = style === null ?
undefined : toStyleFunction(this.style_);
this.changed();
};
}
/**
* @return {module:ol/layer/VectorRenderType|string} The render mode.
*/
VectorLayer.prototype.getRenderMode = function() {
getRenderMode() {
return this.renderMode_;
};
}
}
inherits(VectorLayer, Layer);
/**
* Return the associated {@link module:ol/source/Vector vectorsource} of the layer.
* @function
* @return {module:ol/source/Vector} Source.
* @api
*/
VectorLayer.prototype.getSource;
export default VectorLayer;
src/ol/layer/VectorTile.js
+14 -16
View File
@@ -99,7 +99,8 @@ export const RenderType = {
* @param {module:ol/layer/VectorTile~Options=} opt_options Options.
* @api
*/
const VectorTileLayer = function(opt_options) {
class VectorTileLayer {
constructor(opt_options) {
const options = opt_options ? opt_options : {};
let renderMode = options.renderMode || VectorTileRenderType.HYBRID;
@@ -130,10 +131,7 @@ const VectorTileLayer = function(opt_options) {
*/
this.type = LayerType.VECTOR_TILE;
};
inherits(VectorTileLayer, VectorLayer);
}
/**
* Return the level as number to which we will preload tiles up to.
@@ -141,10 +139,9 @@ inherits(VectorTileLayer, VectorLayer);
* @observable
* @api
*/
VectorTileLayer.prototype.getPreload = function() {
getPreload() {
return /** @type {number} */ (this.get(TileProperty.PRELOAD));
};
}
/**
* Whether we use interim tiles on error.
@@ -152,10 +149,9 @@ VectorTileLayer.prototype.getPreload = function() {
* @observable
* @api
*/
VectorTileLayer.prototype.getUseInterimTilesOnError = function() {
getUseInterimTilesOnError() {
return /** @type {boolean} */ (this.get(TileProperty.USE_INTERIM_TILES_ON_ERROR));
};
}
/**
* Set the level as number to which we will preload tiles up to.
@@ -163,10 +159,9 @@ VectorTileLayer.prototype.getUseInterimTilesOnError = function() {
* @observable
* @api
*/
VectorTileLayer.prototype.setPreload = function(preload) {
setPreload(preload) {
this.set(TileProperty.PRELOAD, preload);
};
}
/**
* Set whether we use interim tiles on error.
@@ -174,9 +169,12 @@ VectorTileLayer.prototype.setPreload = function(preload) {
* @observable
* @api
*/
VectorTileLayer.prototype.setUseInterimTilesOnError = function(useInterimTilesOnError) {
setUseInterimTilesOnError(useInterimTilesOnError) {
this.set(TileProperty.USE_INTERIM_TILES_ON_ERROR, useInterimTilesOnError);
};
}
}
inherits(VectorTileLayer, VectorLayer);
/**
src/ol/pointer/EventSource.js
+9 -8
View File
@@ -6,7 +6,8 @@
* @param {!Object.<string, function(Event)>} mapping Event mapping.
* @constructor
*/
const EventSource = function(dispatcher, mapping) {
class EventSource {
constructor(dispatcher, mapping) {
/**
* @type {module:ol/pointer/PointerEventHandler}
*/
@@ -18,24 +19,24 @@ const EventSource = function(dispatcher, mapping) {
* @type {!Object.<string, function(Event)>}
*/
this.mapping_ = mapping;
};
}
/**
* List of events supported by this source.
* @return {Array.<string>} Event names
*/
EventSource.prototype.getEvents = function() {
getEvents() {
return Object.keys(this.mapping_);
};
}
/**
* Returns the handler that should handle a given event type.
* @param {string} eventType The event type.
* @return {function(Event)} Handler
*/
EventSource.prototype.getHandlerForEvent = function(eventType) {
getHandlerForEvent(eventType) {
return this.mapping_[eventType];
};
}
}
export default EventSource;
src/ol/pointer/MouseSource.js
+117 -121
View File
@@ -39,7 +39,8 @@ import EventSource from '../pointer/EventSource.js';
* @constructor
* @extends {module:ol/pointer/EventSource}
*/
const MouseSource = function(dispatcher) {
class MouseSource {
constructor(dispatcher) {
const mapping = {
'mousedown': this.mousedown,
'mousemove': this.mousemove,
@@ -60,30 +61,7 @@ const MouseSource = function(dispatcher) {
* @type {Array.<module:ol~Pixel>}
*/
this.lastTouches = [];
};
inherits(MouseSource, EventSource);
/**
* @type {number}
*/
export const POINTER_ID = 1;
/**
* @type {string}
*/
export const POINTER_TYPE = 'mouse';
/**
* Radius around touchend that swallows mouse events.
*
* @type {number}
*/
const DEDUP_DIST = 25;
}
/**
* Detect if a mouse event was simulated from a touch by
@@ -109,7 +87,7 @@ const DEDUP_DIST = 25;
* @param {MouseEvent} inEvent The in event.
* @return {boolean} True, if the event was generated by a touch.
*/
MouseSource.prototype.isEventSimulatedFromTouch_ = function(inEvent) {
isEventSimulatedFromTouch_(inEvent) {
const lts = this.lastTouches;
const x = inEvent.clientX;
const y = inEvent.clientY;
@@ -122,7 +100,119 @@ MouseSource.prototype.isEventSimulatedFromTouch_ = function(inEvent) {
}
}
return false;
};
}
/**
* Handler for `mousedown`.
*
* @param {MouseEvent} inEvent The in event.
*/
mousedown(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
// TODO(dfreedman) workaround for some elements not sending mouseup
// http://crbug/149091
if (POINTER_ID.toString() in this.pointerMap) {
this.cancel(inEvent);
}
const e = prepareEvent(inEvent, this.dispatcher);
this.pointerMap[POINTER_ID.toString()] = inEvent;
this.dispatcher.down(e, inEvent);
}
}
/**
* Handler for `mousemove`.
*
* @param {MouseEvent} inEvent The in event.
*/
mousemove(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.move(e, inEvent);
}
}
/**
* Handler for `mouseup`.
*
* @param {MouseEvent} inEvent The in event.
*/
mouseup(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
const p = this.pointerMap[POINTER_ID.toString()];
if (p && p.button === inEvent.button) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.up(e, inEvent);
this.cleanupMouse();
}
}
}
/**
* Handler for `mouseover`.
*
* @param {MouseEvent} inEvent The in event.
*/
mouseover(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.enterOver(e, inEvent);
}
}
/**
* Handler for `mouseout`.
*
* @param {MouseEvent} inEvent The in event.
*/
mouseout(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.leaveOut(e, inEvent);
}
}
/**
* Dispatches a `pointercancel` event.
*
* @param {Event} inEvent The in event.
*/
cancel(inEvent) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.cancel(e, inEvent);
this.cleanupMouse();
}
/**
* Remove the mouse from the list of active pointers.
*/
cleanupMouse() {
delete this.pointerMap[POINTER_ID.toString()];
}
}
inherits(MouseSource, EventSource);
/**
* @type {number}
*/
export const POINTER_ID = 1;
/**
* @type {string}
*/
export const POINTER_TYPE = 'mouse';
/**
* Radius around touchend that swallows mouse events.
*
* @type {number}
*/
const DEDUP_DIST = 25;
/**
@@ -151,98 +241,4 @@ function prepareEvent(inEvent, dispatcher) {
}
/**
* Handler for `mousedown`.
*
* @param {MouseEvent} inEvent The in event.
*/
MouseSource.prototype.mousedown = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
// TODO(dfreedman) workaround for some elements not sending mouseup
// http://crbug/149091
if (POINTER_ID.toString() in this.pointerMap) {
this.cancel(inEvent);
}
const e = prepareEvent(inEvent, this.dispatcher);
this.pointerMap[POINTER_ID.toString()] = inEvent;
this.dispatcher.down(e, inEvent);
}
};
/**
* Handler for `mousemove`.
*
* @param {MouseEvent} inEvent The in event.
*/
MouseSource.prototype.mousemove = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.move(e, inEvent);
}
};
/**
* Handler for `mouseup`.
*
* @param {MouseEvent} inEvent The in event.
*/
MouseSource.prototype.mouseup = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
const p = this.pointerMap[POINTER_ID.toString()];
if (p && p.button === inEvent.button) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.up(e, inEvent);
this.cleanupMouse();
}
}
};
/**
* Handler for `mouseover`.
*
* @param {MouseEvent} inEvent The in event.
*/
MouseSource.prototype.mouseover = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.enterOver(e, inEvent);
}
};
/**
* Handler for `mouseout`.
*
* @param {MouseEvent} inEvent The in event.
*/
MouseSource.prototype.mouseout = function(inEvent) {
if (!this.isEventSimulatedFromTouch_(inEvent)) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.leaveOut(e, inEvent);
}
};
/**
* Dispatches a `pointercancel` event.
*
* @param {Event} inEvent The in event.
*/
MouseSource.prototype.cancel = function(inEvent) {
const e = prepareEvent(inEvent, this.dispatcher);
this.dispatcher.cancel(e, inEvent);
this.cleanupMouse();
};
/**
* Remove the mouse from the list of active pointers.
*/
MouseSource.prototype.cleanupMouse = function() {
delete this.pointerMap[POINTER_ID.toString()];
};
export default MouseSource;
src/ol/pointer/MsSource.js
+113 -119
View File
@@ -39,7 +39,8 @@ import EventSource from '../pointer/EventSource.js';
* @constructor
* @extends {module:ol/pointer/EventSource}
*/
const MsSource = function(dispatcher) {
class MsSource {
constructor(dispatcher) {
const mapping = {
'MSPointerDown': this.msPointerDown,
'MSPointerMove': this.msPointerMove,
@@ -57,7 +58,117 @@ const MsSource = function(dispatcher) {
* @type {!Object.<string, MSPointerEvent|Object>}
*/
this.pointerMap = dispatcher.pointerMap;
};
}
/**
* Creates a copy of the original event that will be used
* for the fake pointer event.
*
* @private
* @param {MSPointerEvent} inEvent The in event.
* @return {Object} The copied event.
*/
prepareEvent_(inEvent) {
let e = inEvent;
if (typeof inEvent.pointerType === 'number') {
e = this.dispatcher.cloneEvent(inEvent, inEvent);
e.pointerType = POINTER_TYPES[inEvent.pointerType];
}
return e;
}
/**
* Remove this pointer from the list of active pointers.
* @param {number} pointerId Pointer identifier.
*/
cleanup(pointerId) {
delete this.pointerMap[pointerId.toString()];
}
/**
* Handler for `msPointerDown`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
msPointerDown(inEvent) {
this.pointerMap[inEvent.pointerId.toString()] = inEvent;
const e = this.prepareEvent_(inEvent);
this.dispatcher.down(e, inEvent);
}
/**
* Handler for `msPointerMove`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
msPointerMove(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.move(e, inEvent);
}
/**
* Handler for `msPointerUp`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
msPointerUp(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.up(e, inEvent);
this.cleanup(inEvent.pointerId);
}
/**
* Handler for `msPointerOut`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
msPointerOut(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.leaveOut(e, inEvent);
}
/**
* Handler for `msPointerOver`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
msPointerOver(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.enterOver(e, inEvent);
}
/**
* Handler for `msPointerCancel`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
msPointerCancel(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.cancel(e, inEvent);
this.cleanup(inEvent.pointerId);
}
/**
* Handler for `msLostPointerCapture`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
msLostPointerCapture(inEvent) {
const e = this.dispatcher.makeEvent('lostpointercapture', inEvent, inEvent);
this.dispatcher.dispatchEvent(e);
}
/**
* Handler for `msGotPointerCapture`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
msGotPointerCapture(inEvent) {
const e = this.dispatcher.makeEvent('gotpointercapture', inEvent, inEvent);
this.dispatcher.dispatchEvent(e);
}
}
inherits(MsSource, EventSource);
@@ -74,121 +185,4 @@ const POINTER_TYPES = [
];
/**
* Creates a copy of the original event that will be used
* for the fake pointer event.
*
* @private
* @param {MSPointerEvent} inEvent The in event.
* @return {Object} The copied event.
*/
MsSource.prototype.prepareEvent_ = function(inEvent) {
let e = inEvent;
if (typeof inEvent.pointerType === 'number') {
e = this.dispatcher.cloneEvent(inEvent, inEvent);
e.pointerType = POINTER_TYPES[inEvent.pointerType];
}
return e;
};
/**
* Remove this pointer from the list of active pointers.
* @param {number} pointerId Pointer identifier.
*/
MsSource.prototype.cleanup = function(pointerId) {
delete this.pointerMap[pointerId.toString()];
};
/**
* Handler for `msPointerDown`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
MsSource.prototype.msPointerDown = function(inEvent) {
this.pointerMap[inEvent.pointerId.toString()] = inEvent;
const e = this.prepareEvent_(inEvent);
this.dispatcher.down(e, inEvent);
};
/**
* Handler for `msPointerMove`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
MsSource.prototype.msPointerMove = function(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.move(e, inEvent);
};
/**
* Handler for `msPointerUp`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
MsSource.prototype.msPointerUp = function(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.up(e, inEvent);
this.cleanup(inEvent.pointerId);
};
/**
* Handler for `msPointerOut`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
MsSource.prototype.msPointerOut = function(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.leaveOut(e, inEvent);
};
/**
* Handler for `msPointerOver`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
MsSource.prototype.msPointerOver = function(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.enterOver(e, inEvent);
};
/**
* Handler for `msPointerCancel`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
MsSource.prototype.msPointerCancel = function(inEvent) {
const e = this.prepareEvent_(inEvent);
this.dispatcher.cancel(e, inEvent);
this.cleanup(inEvent.pointerId);
};
/**
* Handler for `msLostPointerCapture`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
MsSource.prototype.msLostPointerCapture = function(inEvent) {
const e = this.dispatcher.makeEvent('lostpointercapture', inEvent, inEvent);
this.dispatcher.dispatchEvent(e);
};
/**
* Handler for `msGotPointerCapture`.
*
* @param {MSPointerEvent} inEvent The in event.
*/
MsSource.prototype.msGotPointerCapture = function(inEvent) {
const e = this.dispatcher.makeEvent('gotpointercapture', inEvent, inEvent);
this.dispatcher.dispatchEvent(e);
};
export default MsSource;
src/ol/pointer/NativeSource.js
+24 -28
View File
@@ -39,7 +39,8 @@ import EventSource from '../pointer/EventSource.js';
* @constructor
* @extends {module:ol/pointer/EventSource}
*/
const NativeSource = function(dispatcher) {
class NativeSource {
constructor(dispatcher) {
const mapping = {
'pointerdown': this.pointerDown,
'pointermove': this.pointerMove,
@@ -51,87 +52,82 @@ const NativeSource = function(dispatcher) {
'lostpointercapture': this.lostPointerCapture
};
EventSource.call(this, dispatcher, mapping);
};
inherits(NativeSource, EventSource);
}
/**
* Handler for `pointerdown`.
*
* @param {Event} inEvent The in event.
*/
NativeSource.prototype.pointerDown = function(inEvent) {
pointerDown(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
};
}
/**
* Handler for `pointermove`.
*
* @param {Event} inEvent The in event.
*/
NativeSource.prototype.pointerMove = function(inEvent) {
pointerMove(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
};
}
/**
* Handler for `pointerup`.
*
* @param {Event} inEvent The in event.
*/
NativeSource.prototype.pointerUp = function(inEvent) {
pointerUp(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
};
}
/**
* Handler for `pointerout`.
*
* @param {Event} inEvent The in event.
*/
NativeSource.prototype.pointerOut = function(inEvent) {
pointerOut(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
};
}
/**
* Handler for `pointerover`.
*
* @param {Event} inEvent The in event.
*/
NativeSource.prototype.pointerOver = function(inEvent) {
pointerOver(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
};
}
/**
* Handler for `pointercancel`.
*
* @param {Event} inEvent The in event.
*/
NativeSource.prototype.pointerCancel = function(inEvent) {
pointerCancel(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
};
}
/**
* Handler for `lostpointercapture`.
*
* @param {Event} inEvent The in event.
*/
NativeSource.prototype.lostPointerCapture = function(inEvent) {
lostPointerCapture(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
};
}
/**
* Handler for `gotpointercapture`.
*
* @param {Event} inEvent The in event.
*/
NativeSource.prototype.gotPointerCapture = function(inEvent) {
gotPointerCapture(inEvent) {
this.dispatcher.fireNativeEvent(inEvent);
};
}
}
inherits(NativeSource, EventSource);
export default NativeSource;
src/ol/pointer/PointerEvent.js
+17 -17
View File
@@ -47,7 +47,8 @@ import Event from '../events/Event.js';
* @param {Object.<string, ?>=} opt_eventDict An optional dictionary of
* initial event properties.
*/
const PointerEvent = function(type, originalEvent, opt_eventDict) {
class PointerEvent {
constructor(type, originalEvent, opt_eventDict) {
Event.call(this, type);
/**
@@ -190,24 +191,14 @@ const PointerEvent = function(type, originalEvent, opt_eventDict) {
originalEvent.preventDefault();
};
}
};
inherits(PointerEvent, Event);
/**
* Is the `buttons` property supported?
* @type {boolean}
*/
let HAS_BUTTONS = false;
}
/**
* @private
* @param {Object.<string, ?>} eventDict The event dictionary.
* @return {number} Button indicator.
*/
PointerEvent.prototype.getButtons_ = function(eventDict) {
getButtons_(eventDict) {
// According to the w3c spec,
// http://www.w3.org/TR/DOM-Level-3-Events/#events-MouseEvent-button
// MouseEvent.button == 0 can mean either no mouse button depressed, or the
@@ -241,8 +232,7 @@ PointerEvent.prototype.getButtons_ = function(eventDict) {
}
}
return buttons;
};
}
/**
* @private
@@ -250,7 +240,7 @@ PointerEvent.prototype.getButtons_ = function(eventDict) {
* @param {number} buttons Button indicator.
* @return {number} The pressure.
*/
PointerEvent.prototype.getPressure_ = function(eventDict, buttons) {
getPressure_(eventDict, buttons) {
// Spec requires that pointers without pressure specified use 0.5 for down
// state and 0 for up state.
let pressure = 0;
@@ -260,7 +250,17 @@ PointerEvent.prototype.getPressure_ = function(eventDict, buttons) {
pressure = buttons ? 0.5 : 0;
}
return pressure;
};
}
}
inherits(PointerEvent, Event);
/**
* Is the `buttons` property supported?
* @type {boolean}
*/
let HAS_BUTTONS = false;
/**
src/ol/pointer/PointerEventHandler.js
+299 -321
View File
@@ -47,7 +47,8 @@ import TouchSource from '../pointer/TouchSource.js';
* @extends {module:ol/events/EventTarget}
* @param {Element|HTMLDocument} element Viewport element.
*/
const PointerEventHandler = function(element) {
class PointerEventHandler {
constructor(element) {
EventTarget.call(this);
/**
@@ -76,7 +77,303 @@ const PointerEventHandler = function(element) {
this.eventSourceList_ = [];
this.registerSources();
};
}
/**
* Set up the event sources (mouse, touch and native pointers)
* that generate pointer events.
*/
registerSources() {
if (POINTER) {
this.registerSource('native', new NativeSource(this));
} else if (MSPOINTER) {
this.registerSource('ms', new MsSource(this));
} else {
const mouseSource = new MouseSource(this);
this.registerSource('mouse', mouseSource);
if (TOUCH) {
this.registerSource('touch', new TouchSource(this, mouseSource));
}
}
// register events on the viewport element
this.register_();
}
/**
* Add a new event source that will generate pointer events.
*
* @param {string} name A name for the event source
* @param {module:ol/pointer/EventSource} source The source event.
*/
registerSource(name, source) {
const s = source;
const newEvents = s.getEvents();
if (newEvents) {
newEvents.forEach(function(e) {
const handler = s.getHandlerForEvent(e);
if (handler) {
this.eventMap_[e] = handler.bind(s);
}
}.bind(this));
this.eventSourceList_.push(s);
}
}
/**
* Set up the events for all registered event sources.
* @private
*/
register_() {
const l = this.eventSourceList_.length;
for (let i = 0; i < l; i++) {
const eventSource = this.eventSourceList_[i];
this.addEvents_(eventSource.getEvents());
}
}
/**
* Remove all registered events.
* @private
*/
unregister_() {
const l = this.eventSourceList_.length;
for (let i = 0; i < l; i++) {
const eventSource = this.eventSourceList_[i];
this.removeEvents_(eventSource.getEvents());
}
}
/**
* Calls the right handler for a new event.
* @private
* @param {Event} inEvent Browser event.
*/
eventHandler_(inEvent) {
const type = inEvent.type;
const handler = this.eventMap_[type];
if (handler) {
handler(inEvent);
}
}
/**
* Setup listeners for the given events.
* @private
* @param {Array.<string>} events List of events.
*/
addEvents_(events) {
events.forEach(function(eventName) {
listen(this.element_, eventName, this.eventHandler_, this);
}.bind(this));
}
/**
* Unregister listeners for the given events.
* @private
* @param {Array.<string>} events List of events.
*/
removeEvents_(events) {
events.forEach(function(e) {
unlisten(this.element_, e, this.eventHandler_, this);
}.bind(this));
}
/**
* Returns a snapshot of inEvent, with writable properties.
*
* @param {Event} event Browser event.
* @param {Event|Touch} inEvent An event that contains
* properties to copy.
* @return {Object} An object containing shallow copies of
* `inEvent`'s properties.
*/
cloneEvent(event, inEvent) {
const eventCopy = {};
for (let i = 0, ii = CLONE_PROPS.length; i < ii; i++) {
const p = CLONE_PROPS[i][0];
eventCopy[p] = event[p] || inEvent[p] || CLONE_PROPS[i][1];
}
return eventCopy;
}
// EVENTS
/**
* Triggers a 'pointerdown' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
down(data, event) {
this.fireEvent(PointerEventType.POINTERDOWN, data, event);
}
/**
* Triggers a 'pointermove' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
move(data, event) {
this.fireEvent(PointerEventType.POINTERMOVE, data, event);
}
/**
* Triggers a 'pointerup' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
up(data, event) {
this.fireEvent(PointerEventType.POINTERUP, data, event);
}
/**
* Triggers a 'pointerenter' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
enter(data, event) {
data.bubbles = false;
this.fireEvent(PointerEventType.POINTERENTER, data, event);
}
/**
* Triggers a 'pointerleave' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
leave(data, event) {
data.bubbles = false;
this.fireEvent(PointerEventType.POINTERLEAVE, data, event);
}
/**
* Triggers a 'pointerover' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
over(data, event) {
data.bubbles = true;
this.fireEvent(PointerEventType.POINTEROVER, data, event);
}
/**
* Triggers a 'pointerout' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
out(data, event) {
data.bubbles = true;
this.fireEvent(PointerEventType.POINTEROUT, data, event);
}
/**
* Triggers a 'pointercancel' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
cancel(data, event) {
this.fireEvent(PointerEventType.POINTERCANCEL, data, event);
}
/**
* Triggers a combination of 'pointerout' and 'pointerleave' events.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
leaveOut(data, event) {
this.out(data, event);
if (!this.contains_(data.target, data.relatedTarget)) {
this.leave(data, event);
}
}
/**
* Triggers a combination of 'pointerover' and 'pointerevents' events.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
enterOver(data, event) {
this.over(data, event);
if (!this.contains_(data.target, data.relatedTarget)) {
this.enter(data, event);
}
}
/**
* @private
* @param {Element} container The container element.
* @param {Element} contained The contained element.
* @return {boolean} Returns true if the container element
* contains the other element.
*/
contains_(container, contained) {
if (!container || !contained) {
return false;
}
return container.contains(contained);
}
// EVENT CREATION AND TRACKING
/**
* Creates a new Event of type `inType`, based on the information in
* `data`.
*
* @param {string} inType A string representing the type of event to create.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
* @return {module:ol/pointer/PointerEvent} A PointerEvent of type `inType`.
*/
makeEvent(inType, data, event) {
return new PointerEvent(inType, event, data);
}
/**
* Make and dispatch an event in one call.
* @param {string} inType A string representing the type of event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
fireEvent(inType, data, event) {
const e = this.makeEvent(inType, data, event);
this.dispatchEvent(e);
}
/**
* Creates a pointer event from a native pointer event
* and dispatches this event.
* @param {Event} event A platform event with a target.
*/
fireNativeEvent(event) {
const e = this.makeEvent(event.type, event, event);
this.dispatchEvent(e);
}
/**
* Wrap a native mouse event into a pointer event.
* This proxy method is required for the legacy IE support.
* @param {string} eventType The pointer event type.
* @param {Event} event The event.
* @return {module:ol/pointer/PointerEvent} The wrapped event.
*/
wrapMouseEvent(eventType, event) {
const pointerEvent = this.makeEvent(
eventType, MouseSource.prepareEvent(event, this), event);
return pointerEvent;
}
/**
* @inheritDoc
*/
disposeInternal() {
this.unregister_();
EventTarget.prototype.disposeInternal.call(this);
}
}
inherits(PointerEventHandler, EventTarget);
@@ -120,323 +417,4 @@ const CLONE_PROPS = [
];
/**
* Set up the event sources (mouse, touch and native pointers)
* that generate pointer events.
*/
PointerEventHandler.prototype.registerSources = function() {
if (POINTER) {
this.registerSource('native', new NativeSource(this));
} else if (MSPOINTER) {
this.registerSource('ms', new MsSource(this));
} else {
const mouseSource = new MouseSource(this);
this.registerSource('mouse', mouseSource);
if (TOUCH) {
this.registerSource('touch', new TouchSource(this, mouseSource));
}
}
// register events on the viewport element
this.register_();
};
/**
* Add a new event source that will generate pointer events.
*
* @param {string} name A name for the event source
* @param {module:ol/pointer/EventSource} source The source event.
*/
PointerEventHandler.prototype.registerSource = function(name, source) {
const s = source;
const newEvents = s.getEvents();
if (newEvents) {
newEvents.forEach(function(e) {
const handler = s.getHandlerForEvent(e);
if (handler) {
this.eventMap_[e] = handler.bind(s);
}
}.bind(this));
this.eventSourceList_.push(s);
}
};
/**
* Set up the events for all registered event sources.
* @private
*/
PointerEventHandler.prototype.register_ = function() {
const l = this.eventSourceList_.length;
for (let i = 0; i < l; i++) {
const eventSource = this.eventSourceList_[i];
this.addEvents_(eventSource.getEvents());
}
};
/**
* Remove all registered events.
* @private
*/
PointerEventHandler.prototype.unregister_ = function() {
const l = this.eventSourceList_.length;
for (let i = 0; i < l; i++) {
const eventSource = this.eventSourceList_[i];
this.removeEvents_(eventSource.getEvents());
}
};
/**
* Calls the right handler for a new event.
* @private
* @param {Event} inEvent Browser event.
*/
PointerEventHandler.prototype.eventHandler_ = function(inEvent) {
const type = inEvent.type;
const handler = this.eventMap_[type];
if (handler) {
handler(inEvent);
}
};
/**
* Setup listeners for the given events.
* @private
* @param {Array.<string>} events List of events.
*/
PointerEventHandler.prototype.addEvents_ = function(events) {
events.forEach(function(eventName) {
listen(this.element_, eventName, this.eventHandler_, this);
}.bind(this));
};
/**
* Unregister listeners for the given events.
* @private
* @param {Array.<string>} events List of events.
*/
PointerEventHandler.prototype.removeEvents_ = function(events) {
events.forEach(function(e) {
unlisten(this.element_, e, this.eventHandler_, this);
}.bind(this));
};
/**
* Returns a snapshot of inEvent, with writable properties.
*
* @param {Event} event Browser event.
* @param {Event|Touch} inEvent An event that contains
* properties to copy.
* @return {Object} An object containing shallow copies of
* `inEvent`'s properties.
*/
PointerEventHandler.prototype.cloneEvent = function(event, inEvent) {
const eventCopy = {};
for (let i = 0, ii = CLONE_PROPS.length; i < ii; i++) {
const p = CLONE_PROPS[i][0];
eventCopy[p] = event[p] || inEvent[p] || CLONE_PROPS[i][1];
}
return eventCopy;
};
// EVENTS
/**
* Triggers a 'pointerdown' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.down = function(data, event) {
this.fireEvent(PointerEventType.POINTERDOWN, data, event);
};
/**
* Triggers a 'pointermove' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.move = function(data, event) {
this.fireEvent(PointerEventType.POINTERMOVE, data, event);
};
/**
* Triggers a 'pointerup' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.up = function(data, event) {
this.fireEvent(PointerEventType.POINTERUP, data, event);
};
/**
* Triggers a 'pointerenter' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.enter = function(data, event) {
data.bubbles = false;
this.fireEvent(PointerEventType.POINTERENTER, data, event);
};
/**
* Triggers a 'pointerleave' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.leave = function(data, event) {
data.bubbles = false;
this.fireEvent(PointerEventType.POINTERLEAVE, data, event);
};
/**
* Triggers a 'pointerover' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.over = function(data, event) {
data.bubbles = true;
this.fireEvent(PointerEventType.POINTEROVER, data, event);
};
/**
* Triggers a 'pointerout' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.out = function(data, event) {
data.bubbles = true;
this.fireEvent(PointerEventType.POINTEROUT, data, event);
};
/**
* Triggers a 'pointercancel' event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.cancel = function(data, event) {
this.fireEvent(PointerEventType.POINTERCANCEL, data, event);
};
/**
* Triggers a combination of 'pointerout' and 'pointerleave' events.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.leaveOut = function(data, event) {
this.out(data, event);
if (!this.contains_(data.target, data.relatedTarget)) {
this.leave(data, event);
}
};
/**
* Triggers a combination of 'pointerover' and 'pointerevents' events.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.enterOver = function(data, event) {
this.over(data, event);
if (!this.contains_(data.target, data.relatedTarget)) {
this.enter(data, event);
}
};
/**
* @private
* @param {Element} container The container element.
* @param {Element} contained The contained element.
* @return {boolean} Returns true if the container element
* contains the other element.
*/
PointerEventHandler.prototype.contains_ = function(container, contained) {
if (!container || !contained) {
return false;
}
return container.contains(contained);
};
// EVENT CREATION AND TRACKING
/**
* Creates a new Event of type `inType`, based on the information in
* `data`.
*
* @param {string} inType A string representing the type of event to create.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
* @return {module:ol/pointer/PointerEvent} A PointerEvent of type `inType`.
*/
PointerEventHandler.prototype.makeEvent = function(inType, data, event) {
return new PointerEvent(inType, event, data);
};
/**
* Make and dispatch an event in one call.
* @param {string} inType A string representing the type of event.
* @param {Object} data Pointer event data.
* @param {Event} event The event.
*/
PointerEventHandler.prototype.fireEvent = function(inType, data, event) {
const e = this.makeEvent(inType, data, event);
this.dispatchEvent(e);
};
/**
* Creates a pointer event from a native pointer event
* and dispatches this event.
* @param {Event} event A platform event with a target.
*/
PointerEventHandler.prototype.fireNativeEvent = function(event) {
const e = this.makeEvent(event.type, event, event);
this.dispatchEvent(e);
};
/**
* Wrap a native mouse event into a pointer event.
* This proxy method is required for the legacy IE support.
* @param {string} eventType The pointer event type.
* @param {Event} event The event.
* @return {module:ol/pointer/PointerEvent} The wrapped event.
*/
PointerEventHandler.prototype.wrapMouseEvent = function(eventType, event) {
const pointerEvent = this.makeEvent(
eventType, MouseSource.prepareEvent(event, this), event);
return pointerEvent;
};
/**
* @inheritDoc
*/
PointerEventHandler.prototype.disposeInternal = function() {
this.unregister_();
EventTarget.prototype.disposeInternal.call(this);
};
export default PointerEventHandler;
src/ol/pointer/TouchSource.js
+59 -75
View File
@@ -43,7 +43,8 @@ import {POINTER_ID} from '../pointer/MouseSource.js';
* @param {module:ol/pointer/MouseSource} mouseSource Mouse source.
* @extends {module:ol/pointer/EventSource}
*/
const TouchSource = function(dispatcher, mouseSource) {
class TouchSource {
constructor(dispatcher, mouseSource) {
const mapping = {
'touchstart': this.touchstart,
'touchmove': this.touchmove,
@@ -89,86 +90,66 @@ const TouchSource = function(dispatcher, mouseSource) {
* @type {number}
*/
this.dedupTimeout_ = 2500;
};
inherits(TouchSource, EventSource);
/**
* @type {number}
*/
const CLICK_COUNT_TIMEOUT = 200;
/**
* @type {string}
*/
const POINTER_TYPE = 'touch';
}
/**
* @private
* @param {Touch} inTouch The in touch.
* @return {boolean} True, if this is the primary touch.
*/
TouchSource.prototype.isPrimaryTouch_ = function(inTouch) {
isPrimaryTouch_(inTouch) {
return this.firstTouchId_ === inTouch.identifier;
};
}
/**
* Set primary touch if there are no pointers, or the only pointer is the mouse.
* @param {Touch} inTouch The in touch.
* @private
*/
TouchSource.prototype.setPrimaryTouch_ = function(inTouch) {
setPrimaryTouch_(inTouch) {
const count = Object.keys(this.pointerMap).length;
if (count === 0 || (count === 1 && POINTER_ID.toString() in this.pointerMap)) {
this.firstTouchId_ = inTouch.identifier;
this.cancelResetClickCount_();
}
};
}
/**
* @private
* @param {PointerEvent} inPointer The in pointer object.
*/
TouchSource.prototype.removePrimaryPointer_ = function(inPointer) {
removePrimaryPointer_(inPointer) {
if (inPointer.isPrimary) {
this.firstTouchId_ = undefined;
this.resetClickCount_();
}
};
}
/**
* @private
*/
TouchSource.prototype.resetClickCount_ = function() {
resetClickCount_() {
this.resetId_ = setTimeout(
this.resetClickCountHandler_.bind(this),
CLICK_COUNT_TIMEOUT);
};
}
/**
* @private
*/
TouchSource.prototype.resetClickCountHandler_ = function() {
resetClickCountHandler_() {
this.clickCount_ = 0;
this.resetId_ = undefined;
};
}
/**
* @private
*/
TouchSource.prototype.cancelResetClickCount_ = function() {
cancelResetClickCount_() {
if (this.resetId_ !== undefined) {
clearTimeout(this.resetId_);
}
};
}
/**
* @private
@@ -176,7 +157,7 @@ TouchSource.prototype.cancelResetClickCount_ = function() {
* @param {Touch} inTouch Touch event
* @return {PointerEvent} A pointer object.
*/
TouchSource.prototype.touchToPointer_ = function(browserEvent, inTouch) {
touchToPointer_(browserEvent, inTouch) {
const e = this.dispatcher.cloneEvent(browserEvent, inTouch);
// Spec specifies that pointerId 1 is reserved for Mouse.
// Touch identifiers can start at 0.
@@ -203,15 +184,14 @@ TouchSource.prototype.touchToPointer_ = function(browserEvent, inTouch) {
e.screenY = inTouch.screenY;
return e;
};
}
/**
* @private
* @param {TouchEvent} inEvent Touch event
* @param {function(TouchEvent, PointerEvent)} inFunction In function.
*/
TouchSource.prototype.processTouches_ = function(inEvent, inFunction) {
processTouches_(inEvent, inFunction) {
const touches = Array.prototype.slice.call(inEvent.changedTouches);
const count = touches.length;
function preventDefault() {
@@ -223,8 +203,7 @@ TouchSource.prototype.processTouches_ = function(inEvent, inFunction) {
pointer.preventDefault = preventDefault;
inFunction.call(this, inEvent, pointer);
}
};
}
/**
* @private
@@ -232,7 +211,7 @@ TouchSource.prototype.processTouches_ = function(inEvent, inFunction) {
* @param {number} searchId Search identifier.
* @return {boolean} True, if the `Touch` with the given id is in the list.
*/
TouchSource.prototype.findTouch_ = function(touchList, searchId) {
findTouch_(touchList, searchId) {
const l = touchList.length;
for (let i = 0; i < l; i++) {
const touch = touchList[i];
@@ -241,8 +220,7 @@ TouchSource.prototype.findTouch_ = function(touchList, searchId) {
}
}
return false;
};
}
/**
* In some instances, a touchstart can happen without a touchend. This
@@ -255,7 +233,7 @@ TouchSource.prototype.findTouch_ = function(touchList, searchId) {
* @private
* @param {TouchEvent} inEvent The in event.
*/
TouchSource.prototype.vacuumTouches_ = function(inEvent) {
vacuumTouches_(inEvent) {
const touchList = inEvent.touches;
// pointerMap.getCount() should be < touchList.length here,
// as the touchstart has not been processed yet.
@@ -277,8 +255,7 @@ TouchSource.prototype.vacuumTouches_ = function(inEvent) {
this.cancelOut_(inEvent, d[i]);
}
}
};
}
/**
* Handler for `touchstart`, triggers `pointerover`,
@@ -286,21 +263,20 @@ TouchSource.prototype.vacuumTouches_ = function(inEvent) {
*
* @param {TouchEvent} inEvent The in event.
*/
TouchSource.prototype.touchstart = function(inEvent) {
touchstart(inEvent) {
this.vacuumTouches_(inEvent);
this.setPrimaryTouch_(inEvent.changedTouches[0]);
this.dedupSynthMouse_(inEvent);
this.clickCount_++;
this.processTouches_(inEvent, this.overDown_);
};
}
/**
* @private
* @param {TouchEvent} browserEvent The event.
* @param {PointerEvent} inPointer The in pointer object.
*/
TouchSource.prototype.overDown_ = function(browserEvent, inPointer) {
overDown_(browserEvent, inPointer) {
this.pointerMap[inPointer.pointerId] = {
target: inPointer.target,
out: inPointer,
@@ -309,26 +285,24 @@ TouchSource.prototype.overDown_ = function(browserEvent, inPointer) {
this.dispatcher.over(inPointer, browserEvent);
this.dispatcher.enter(inPointer, browserEvent);
this.dispatcher.down(inPointer, browserEvent);
};
}
/**
* Handler for `touchmove`.
*
* @param {TouchEvent} inEvent The in event.
*/
TouchSource.prototype.touchmove = function(inEvent) {
touchmove(inEvent) {
inEvent.preventDefault();
this.processTouches_(inEvent, this.moveOverOut_);
};
}
/**
* @private
* @param {TouchEvent} browserEvent The event.
* @param {PointerEvent} inPointer The in pointer.
*/
TouchSource.prototype.moveOverOut_ = function(browserEvent, inPointer) {
moveOverOut_(browserEvent, inPointer) {
const event = inPointer;
const pointer = this.pointerMap[event.pointerId];
// a finger drifted off the screen, ignore it
@@ -355,8 +329,7 @@ TouchSource.prototype.moveOverOut_ = function(browserEvent, inPointer) {
}
pointer.out = event;
pointer.outTarget = event.target;
};
}
/**
* Handler for `touchend`, triggers `pointerup`,
@@ -364,24 +337,22 @@ TouchSource.prototype.moveOverOut_ = function(browserEvent, inPointer) {
*
* @param {TouchEvent} inEvent The event.
*/
TouchSource.prototype.touchend = function(inEvent) {
touchend(inEvent) {
this.dedupSynthMouse_(inEvent);
this.processTouches_(inEvent, this.upOut_);
};
}
/**
* @private
* @param {TouchEvent} browserEvent An event.
* @param {PointerEvent} inPointer The inPointer object.
*/
TouchSource.prototype.upOut_ = function(browserEvent, inPointer) {
upOut_(browserEvent, inPointer) {
this.dispatcher.up(inPointer, browserEvent);
this.dispatcher.out(inPointer, browserEvent);
this.dispatcher.leave(inPointer, browserEvent);
this.cleanUpPointer_(inPointer);
};
}
/**
* Handler for `touchcancel`, triggers `pointercancel`,
@@ -389,33 +360,30 @@ TouchSource.prototype.upOut_ = function(browserEvent, inPointer) {
*
* @param {TouchEvent} inEvent The in event.
*/
TouchSource.prototype.touchcancel = function(inEvent) {
touchcancel(inEvent) {
this.processTouches_(inEvent, this.cancelOut_);
};
}
/**
* @private
* @param {TouchEvent} browserEvent The event.
* @param {PointerEvent} inPointer The in pointer.
*/
TouchSource.prototype.cancelOut_ = function(browserEvent, inPointer) {
cancelOut_(browserEvent, inPointer) {
this.dispatcher.cancel(inPointer, browserEvent);
this.dispatcher.out(inPointer, browserEvent);
this.dispatcher.leave(inPointer, browserEvent);
this.cleanUpPointer_(inPointer);
};
}
/**
* @private
* @param {PointerEvent} inPointer The inPointer object.
*/
TouchSource.prototype.cleanUpPointer_ = function(inPointer) {
cleanUpPointer_(inPointer) {
delete this.pointerMap[inPointer.pointerId];
this.removePrimaryPointer_(inPointer);
};
}
/**
* Prevent synth mouse events from creating pointer events.
@@ -423,7 +391,7 @@ TouchSource.prototype.cleanUpPointer_ = function(inPointer) {
* @private
* @param {TouchEvent} inEvent The in event.
*/
TouchSource.prototype.dedupSynthMouse_ = function(inEvent) {
dedupSynthMouse_(inEvent) {
const lts = this.mouseSource.lastTouches;
const t = inEvent.changedTouches[0];
// only the primary finger will synth mouse events
@@ -437,5 +405,21 @@ TouchSource.prototype.dedupSynthMouse_ = function(inEvent) {
remove(lts, lt);
}, this.dedupTimeout_);
}
};
}
}
inherits(TouchSource, EventSource);
/**
* @type {number}
*/
const CLICK_COUNT_TIMEOUT = 200;
/**
* @type {string}
*/
const POINTER_TYPE = 'touch';
export default TouchSource;
src/ol/proj/Projection.js
+35 -47
View File
@@ -54,7 +54,8 @@ import {METERS_PER_UNIT} from '../proj/Units.js';
* @struct
* @api
*/
const Projection = function(options) {
class Projection {
constructor(options) {
/**
* @private
* @type {string}
@@ -125,46 +126,41 @@ const Projection = function(options) {
* @type {number|undefined}
*/
this.metersPerUnit_ = options.metersPerUnit;
};
}
/**
* @return {boolean} The projection is suitable for wrapping the x-axis
*/
Projection.prototype.canWrapX = function() {
canWrapX() {
return this.canWrapX_;
};
}
/**
* Get the code for this projection, e.g. 'EPSG:4326'.
* @return {string} Code.
* @api
*/
Projection.prototype.getCode = function() {
getCode() {
return this.code_;
};
}
/**
* Get the validity extent for this projection.
* @return {module:ol/extent~Extent} Extent.
* @api
*/
Projection.prototype.getExtent = function() {
getExtent() {
return this.extent_;
};
}
/**
* Get the units of this projection.
* @return {module:ol/proj/Units} Units.
* @api
*/
Projection.prototype.getUnits = function() {
getUnits() {
return this.units_;
};
}
/**
* Get the amount of meters per unit of this projection. If the projection is
@@ -173,20 +169,18 @@ Projection.prototype.getUnits = function() {
* @return {number|undefined} Meters.
* @api
*/
Projection.prototype.getMetersPerUnit = function() {
getMetersPerUnit() {
return this.metersPerUnit_ || METERS_PER_UNIT[this.units_];
};
}
/**
* Get the world extent for this projection.
* @return {module:ol/extent~Extent} Extent.
* @api
*/
Projection.prototype.getWorldExtent = function() {
getWorldExtent() {
return this.worldExtent_;
};
}
/**
* Get the axis orientation of this projection.
@@ -199,58 +193,52 @@ Projection.prototype.getWorldExtent = function() {
* @return {string} Axis orientation.
* @api
*/
Projection.prototype.getAxisOrientation = function() {
getAxisOrientation() {
return this.axisOrientation_;
};
}
/**
* Is this projection a global projection which spans the whole world?
* @return {boolean} Whether the projection is global.
* @api
*/
Projection.prototype.isGlobal = function() {
isGlobal() {
return this.global_;
};
}
/**
* Set if the projection is a global projection which spans the whole world
* @param {boolean} global Whether the projection is global.
* @api
*/
Projection.prototype.setGlobal = function(global) {
setGlobal(global) {
this.global_ = global;
this.canWrapX_ = !!(global && this.extent_);
};
}
/**
* @return {module:ol/tilegrid/TileGrid} The default tile grid.
*/
Projection.prototype.getDefaultTileGrid = function() {
getDefaultTileGrid() {
return this.defaultTileGrid_;
};
}
/**
* @param {module:ol/tilegrid/TileGrid} tileGrid The default tile grid.
*/
Projection.prototype.setDefaultTileGrid = function(tileGrid) {
setDefaultTileGrid(tileGrid) {
this.defaultTileGrid_ = tileGrid;
};
}
/**
* Set the validity extent for this projection.
* @param {module:ol/extent~Extent} extent Extent.
* @api
*/
Projection.prototype.setExtent = function(extent) {
setExtent(extent) {
this.extent_ = extent;
this.canWrapX_ = !!(this.global_ && extent);
};
}
/**
* Set the world extent for this projection.
@@ -258,10 +246,9 @@ Projection.prototype.setExtent = function(extent) {
* [minlon, minlat, maxlon, maxlat].
* @api
*/
Projection.prototype.setWorldExtent = function(worldExtent) {
setWorldExtent(worldExtent) {
this.worldExtent_ = worldExtent;
};
}
/**
* Set the getPointResolution function (see {@link module:ol/proj~getPointResolution}
@@ -269,17 +256,18 @@ Projection.prototype.setWorldExtent = function(worldExtent) {
* @param {function(number, module:ol/coordinate~Coordinate):number} func Function
* @api
*/
Projection.prototype.setGetPointResolution = function(func) {
setGetPointResolution(func) {
this.getPointResolutionFunc_ = func;
};
}
/**
* Get the custom point resolution function for this projection (if set).
* @return {function(number, module:ol/coordinate~Coordinate):number|undefined} The custom point
* resolution function (if set).
*/
Projection.prototype.getPointResolutionFunc = function() {
getPointResolutionFunc() {
return this.getPointResolutionFunc_;
};
}
}
export default Projection;
src/ol/render/Box.js
+20 -22
View File
@@ -12,7 +12,8 @@ import Polygon from '../geom/Polygon.js';
* @extends {module:ol/Disposable}
* @param {string} className CSS class name.
*/
const RenderBox = function(className) {
class RenderBox {
constructor(className) {
/**
* @type {module:ol/geom/Polygon}
@@ -46,23 +47,19 @@ const RenderBox = function(className) {
*/
this.endPixel_ = null;
};
inherits(RenderBox, Disposable);
}
/**
* @inheritDoc
*/
RenderBox.prototype.disposeInternal = function() {
disposeInternal() {
this.setMap(null);
};
}
/**
* @private
*/
RenderBox.prototype.render_ = function() {
render_() {
const startPixel = this.startPixel_;
const endPixel = this.endPixel_;
const px = 'px';
@@ -71,13 +68,12 @@ RenderBox.prototype.render_ = function() {
style.top = Math.min(startPixel[1], endPixel[1]) + px;
style.width = Math.abs(endPixel[0] - startPixel[0]) + px;
style.height = Math.abs(endPixel[1] - startPixel[1]) + px;
};
}
/**
* @param {module:ol/PluggableMap} map Map.
*/
RenderBox.prototype.setMap = function(map) {
setMap(map) {
if (this.map_) {
this.map_.getOverlayContainer().removeChild(this.element_);
const style = this.element_.style;
@@ -87,25 +83,23 @@ RenderBox.prototype.setMap = function(map) {
if (this.map_) {
this.map_.getOverlayContainer().appendChild(this.element_);
}
};
}
/**
* @param {module:ol~Pixel} startPixel Start pixel.
* @param {module:ol~Pixel} endPixel End pixel.
*/
RenderBox.prototype.setPixels = function(startPixel, endPixel) {
setPixels(startPixel, endPixel) {
this.startPixel_ = startPixel;
this.endPixel_ = endPixel;
this.createOrUpdateGeometry();
this.render_();
};
}
/**
* Creates or updates the cached geometry.
*/
RenderBox.prototype.createOrUpdateGeometry = function() {
createOrUpdateGeometry() {
const startPixel = this.startPixel_;
const endPixel = this.endPixel_;
const pixels = [
@@ -122,13 +116,17 @@ RenderBox.prototype.createOrUpdateGeometry = function() {
} else {
this.geometry_.setCoordinates([coordinates]);
}
};
}
/**
* @return {module:ol/geom/Polygon} Geometry.
*/
RenderBox.prototype.getGeometry = function() {
getGeometry() {
return this.geometry_;
};
}
}
inherits(RenderBox, Disposable);
export default RenderBox;
src/ol/render/Feature.js
+89 -96
View File
@@ -25,7 +25,8 @@ import {create as createTransform, compose as composeTransform} from '../transfo
* @param {Object.<string, *>} properties Properties.
* @param {number|string|undefined} id Feature id.
*/
const RenderFeature = function(type, flatCoordinates, ends, properties, id) {
class RenderFeature {
constructor(type, flatCoordinates, ends, properties, id) {
/**
* @private
* @type {module:ol/extent~Extent|undefined}
@@ -74,14 +75,7 @@ const RenderFeature = function(type, flatCoordinates, ends, properties, id) {
*/
this.properties_ = properties;
};
/**
* @type {module:ol/transform~Transform}
*/
const tmpTransform = createTransform();
}
/**
* Get a feature property by its key.
@@ -89,26 +83,16 @@ const tmpTransform = createTransform();
* @return {*} Value for the requested key.
* @api
*/
RenderFeature.prototype.get = function(key) {
get(key) {
return this.properties_[key];
};
/**
* @return {Array.<number>|Array.<Array.<number>>} Ends or endss.
*/
RenderFeature.prototype.getEnds =
RenderFeature.prototype.getEndss = function() {
return this.ends_;
};
}
/**
* Get the extent of this feature's geometry.
* @return {module:ol/extent~Extent} Extent.
* @api
*/
RenderFeature.prototype.getExtent = function() {
getExtent() {
if (!this.extent_) {
this.extent_ = this.type_ === GeometryType.POINT ?
createOrUpdateFromCoordinate(this.flatCoordinates_) :
@@ -117,26 +101,24 @@ RenderFeature.prototype.getExtent = function() {
}
return this.extent_;
};
}
/**
* @return {Array.<number>} Flat interior points.
*/
RenderFeature.prototype.getFlatInteriorPoint = function() {
getFlatInteriorPoint() {
if (!this.flatInteriorPoints_) {
const flatCenter = getCenter(this.getExtent());
this.flatInteriorPoints_ = getInteriorPointOfArray(
this.flatCoordinates_, 0, this.ends_, 2, flatCenter, 0);
}
return this.flatInteriorPoints_;
};
}
/**
* @return {Array.<number>} Flat interior points.
*/
RenderFeature.prototype.getFlatInteriorPoints = function() {
getFlatInteriorPoints() {
if (!this.flatInteriorPoints_) {
const flatCenters = linearRingssCenter(
this.flatCoordinates_, 0, this.ends_, 2);
@@ -144,25 +126,23 @@ RenderFeature.prototype.getFlatInteriorPoints = function() {
this.flatCoordinates_, 0, this.ends_, 2, flatCenters);
}
return this.flatInteriorPoints_;
};
}
/**
* @return {Array.<number>} Flat midpoint.
*/
RenderFeature.prototype.getFlatMidpoint = function() {
getFlatMidpoint() {
if (!this.flatMidpoints_) {
this.flatMidpoints_ = interpolatePoint(
this.flatCoordinates_, 0, this.flatCoordinates_.length, 2, 0.5);
}
return this.flatMidpoints_;
};
}
/**
* @return {Array.<number>} Flat midpoints.
*/
RenderFeature.prototype.getFlatMidpoints = function() {
getFlatMidpoints() {
if (!this.flatMidpoints_) {
this.flatMidpoints_ = [];
const flatCoordinates = this.flatCoordinates_;
@@ -177,7 +157,7 @@ RenderFeature.prototype.getFlatMidpoints = function() {
}
}
return this.flatMidpoints_;
};
}
/**
* Get the feature identifier. This is a stable identifier for the feature and
@@ -185,16 +165,86 @@ RenderFeature.prototype.getFlatMidpoints = function() {
* @return {number|string|undefined} Id.
* @api
*/
RenderFeature.prototype.getId = function() {
getId() {
return this.id_;
};
}
/**
* @return {Array.<number>} Flat coordinates.
*/
RenderFeature.prototype.getOrientedFlatCoordinates = function() {
getOrientedFlatCoordinates() {
return this.flatCoordinates_;
}
/**
* For API compatibility with {@link module:ol/Feature~Feature}, this method is useful when
* determining the geometry type in style function (see {@link #getType}).
* @return {module:ol/render/Feature} Feature.
* @api
*/
getGeometry() {
return this;
}
/**
* Get the feature properties.
* @return {Object.<string, *>} Feature properties.
* @api
*/
getProperties() {
return this.properties_;
}
/**
* @return {number} Stride.
*/
getStride() {
return 2;
}
/**
* Get the type of this feature's geometry.
* @return {module:ol/geom/GeometryType} Geometry type.
* @api
*/
getType() {
return this.type_;
}
/**
* Transform geometry coordinates from tile pixel space to projected.
* The SRS of the source and destination are expected to be the same.
*
* @param {module:ol/proj~ProjectionLike} source The current projection
* @param {module:ol/proj~ProjectionLike} destination The desired projection.
*/
transform(source, destination) {
source = getProjection(source);
const pixelExtent = source.getExtent();
const projectedExtent = source.getWorldExtent();
const scale = getHeight(projectedExtent) / getHeight(pixelExtent);
composeTransform(tmpTransform,
projectedExtent[0], projectedExtent[3],
scale, -scale, 0,
0, 0);
transform2D(this.flatCoordinates_, 0, this.flatCoordinates_.length, 2,
tmpTransform, this.flatCoordinates_);
}
}
/**
* @type {module:ol/transform~Transform}
*/
const tmpTransform = createTransform();
/**
* @return {Array.<number>|Array.<Array.<number>>} Ends or endss.
*/
RenderFeature.prototype.getEnds =
RenderFeature.prototype.getEndss = function() {
return this.ends_;
};
@@ -205,27 +255,6 @@ RenderFeature.prototype.getFlatCoordinates =
RenderFeature.prototype.getOrientedFlatCoordinates;
/**
* For API compatibility with {@link module:ol/Feature~Feature}, this method is useful when
* determining the geometry type in style function (see {@link #getType}).
* @return {module:ol/render/Feature} Feature.
* @api
*/
RenderFeature.prototype.getGeometry = function() {
return this;
};
/**
* Get the feature properties.
* @return {Object.<string, *>} Feature properties.
* @api
*/
RenderFeature.prototype.getProperties = function() {
return this.properties_;
};
/**
* Get the feature for working with its geometry.
* @return {module:ol/render/Feature} Feature.
@@ -234,46 +263,10 @@ RenderFeature.prototype.getSimplifiedGeometry =
RenderFeature.prototype.getGeometry;
/**
* @return {number} Stride.
*/
RenderFeature.prototype.getStride = function() {
return 2;
};
/**
* @return {undefined}
*/
RenderFeature.prototype.getStyleFunction = UNDEFINED;
/**
* Get the type of this feature's geometry.
* @return {module:ol/geom/GeometryType} Geometry type.
* @api
*/
RenderFeature.prototype.getType = function() {
return this.type_;
};
/**
* Transform geometry coordinates from tile pixel space to projected.
* The SRS of the source and destination are expected to be the same.
*
* @param {module:ol/proj~ProjectionLike} source The current projection
* @param {module:ol/proj~ProjectionLike} destination The desired projection.
*/
RenderFeature.prototype.transform = function(source, destination) {
source = getProjection(source);
const pixelExtent = source.getExtent();
const projectedExtent = source.getWorldExtent();
const scale = getHeight(projectedExtent) / getHeight(pixelExtent);
composeTransform(tmpTransform,
projectedExtent[0], projectedExtent[3],
scale, -scale, 0,
0, 0);
transform2D(this.flatCoordinates_, 0, this.flatCoordinates_.length, 2,
tmpTransform, this.flatCoordinates_);
};
export default RenderFeature;
src/ol/render/ReplayGroup.js
+5 -6
View File
@@ -6,21 +6,20 @@
* @constructor
* @abstract
*/
const ReplayGroup = function() {};
class ReplayGroup {
/**
* @abstract
* @param {number|undefined} zIndex Z index.
* @param {module:ol/render/ReplayType} replayType Replay type.
* @return {module:ol/render/VectorContext} Replay.
*/
ReplayGroup.prototype.getReplay = function(zIndex, replayType) {};
getReplay(zIndex, replayType) {}
/**
* @abstract
* @return {boolean} Is empty.
*/
ReplayGroup.prototype.isEmpty = function() {};
isEmpty() {}
}
export default ReplayGroup;
src/ol/render/VectorContext.js
+19 -35
View File
@@ -9,10 +9,7 @@
* @struct
* @api
*/
const VectorContext = function() {
};
class VectorContext {
/**
* Render a geometry with a custom renderer.
*
@@ -20,113 +17,100 @@ const VectorContext = function() {
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
* @param {Function} renderer Renderer.
*/
VectorContext.prototype.drawCustom = function(geometry, feature, renderer) {};
drawCustom(geometry, feature, renderer) {}
/**
* Render a geometry.
*
* @param {module:ol/geom/Geometry} geometry The geometry to render.
*/
VectorContext.prototype.drawGeometry = function(geometry) {};
drawGeometry(geometry) {}
/**
* Set the rendering style.
*
* @param {module:ol/style/Style} style The rendering style.
*/
VectorContext.prototype.setStyle = function(style) {};
setStyle(style) {}
/**
* @param {module:ol/geom/Circle} circleGeometry Circle geometry.
* @param {module:ol/Feature} feature Feature.
*/
VectorContext.prototype.drawCircle = function(circleGeometry, feature) {};
drawCircle(circleGeometry, feature) {}
/**
* @param {module:ol/Feature} feature Feature.
* @param {module:ol/style/Style} style Style.
*/
VectorContext.prototype.drawFeature = function(feature, style) {};
drawFeature(feature, style) {}
/**
* @param {module:ol/geom/GeometryCollection} geometryCollectionGeometry Geometry
* collection.
* @param {module:ol/Feature} feature Feature.
*/
VectorContext.prototype.drawGeometryCollection = function(geometryCollectionGeometry, feature) {};
drawGeometryCollection(geometryCollectionGeometry, feature) {}
/**
* @param {module:ol/geom/LineString|module:ol/render/Feature} lineStringGeometry Line string geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
VectorContext.prototype.drawLineString = function(lineStringGeometry, feature) {};
drawLineString(lineStringGeometry, feature) {}
/**
* @param {module:ol/geom/MultiLineString|module:ol/render/Feature} multiLineStringGeometry MultiLineString geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
VectorContext.prototype.drawMultiLineString = function(multiLineStringGeometry, feature) {};
drawMultiLineString(multiLineStringGeometry, feature) {}
/**
* @param {module:ol/geom/MultiPoint|module:ol/render/Feature} multiPointGeometry MultiPoint geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
VectorContext.prototype.drawMultiPoint = function(multiPointGeometry, feature) {};
drawMultiPoint(multiPointGeometry, feature) {}
/**
* @param {module:ol/geom/MultiPolygon} multiPolygonGeometry MultiPolygon geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
VectorContext.prototype.drawMultiPolygon = function(multiPolygonGeometry, feature) {};
drawMultiPolygon(multiPolygonGeometry, feature) {}
/**
* @param {module:ol/geom/Point|module:ol/render/Feature} pointGeometry Point geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
VectorContext.prototype.drawPoint = function(pointGeometry, feature) {};
drawPoint(pointGeometry, feature) {}
/**
* @param {module:ol/geom/Polygon|module:ol/render/Feature} polygonGeometry Polygon geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
VectorContext.prototype.drawPolygon = function(polygonGeometry, feature) {};
drawPolygon(polygonGeometry, feature) {}
/**
* @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
VectorContext.prototype.drawText = function(geometry, feature) {};
drawText(geometry, feature) {}
/**
* @param {module:ol/style/Fill} fillStyle Fill style.
* @param {module:ol/style/Stroke} strokeStyle Stroke style.
*/
VectorContext.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) {};
setFillStrokeStyle(fillStyle, strokeStyle) {}
/**
* @param {module:ol/style/Image} imageStyle Image style.
* @param {module:ol/render/canvas~DeclutterGroup=} opt_declutterGroup Declutter.
*/
VectorContext.prototype.setImageStyle = function(imageStyle, opt_declutterGroup) {};
setImageStyle(imageStyle, opt_declutterGroup) {}
/**
* @param {module:ol/style/Text} textStyle Text style.
* @param {module:ol/render/canvas~DeclutterGroup=} opt_declutterGroup Declutter.
*/
VectorContext.prototype.setTextStyle = function(textStyle, opt_declutterGroup) {};
setTextStyle(textStyle, opt_declutterGroup) {}
}
export default VectorContext;
src/ol/render/canvas/ImageReplay.js
+18 -20
View File
@@ -16,8 +16,8 @@ import CanvasReplay from '../canvas/Replay.js';
* @param {?} declutterTree Declutter tree.
* @struct
*/
const CanvasImageReplay = function(
tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
class CanvasImageReplay {
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
CanvasReplay.call(this,
tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree);
@@ -105,10 +105,7 @@ const CanvasImageReplay = function(
*/
this.width_ = undefined;
};
inherits(CanvasImageReplay, CanvasReplay);
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -118,15 +115,14 @@ inherits(CanvasImageReplay, CanvasReplay);
* @private
* @return {number} My end.
*/
CanvasImageReplay.prototype.drawCoordinates_ = function(flatCoordinates, offset, end, stride) {
drawCoordinates_(flatCoordinates, offset, end, stride) {
return this.appendFlatCoordinates(flatCoordinates, offset, end, stride, false, false);
};
}
/**
* @inheritDoc
*/
CanvasImageReplay.prototype.drawPoint = function(pointGeometry, feature) {
drawPoint(pointGeometry, feature) {
if (!this.image_) {
return;
}
@@ -150,13 +146,12 @@ CanvasImageReplay.prototype.drawPoint = function(pointGeometry, feature) {
this.scale_, this.snapToPixel_, this.width_
]);
this.endGeometry(pointGeometry, feature);
};
}
/**
* @inheritDoc
*/
CanvasImageReplay.prototype.drawMultiPoint = function(multiPointGeometry, feature) {
drawMultiPoint(multiPointGeometry, feature) {
if (!this.image_) {
return;
}
@@ -181,13 +176,12 @@ CanvasImageReplay.prototype.drawMultiPoint = function(multiPointGeometry, featur
this.scale_, this.snapToPixel_, this.width_
]);
this.endGeometry(multiPointGeometry, feature);
};
}
/**
* @inheritDoc
*/
CanvasImageReplay.prototype.finish = function() {
finish() {
this.reverseHitDetectionInstructions();
// FIXME this doesn't really protect us against further calls to draw*Geometry
this.anchorX_ = undefined;
@@ -203,13 +197,12 @@ CanvasImageReplay.prototype.finish = function() {
this.rotation_ = undefined;
this.snapToPixel_ = undefined;
this.width_ = undefined;
};
}
/**
* @inheritDoc
*/
CanvasImageReplay.prototype.setImageStyle = function(imageStyle, declutterGroup) {
setImageStyle(imageStyle, declutterGroup) {
const anchor = imageStyle.getAnchor();
const size = imageStyle.getSize();
const hitDetectionImage = imageStyle.getHitDetectionImage(1);
@@ -229,5 +222,10 @@ CanvasImageReplay.prototype.setImageStyle = function(imageStyle, declutterGroup)
this.scale_ = imageStyle.getScale();
this.snapToPixel_ = imageStyle.getSnapToPixel();
this.width_ = size[0];
};
}
}
inherits(CanvasImageReplay, CanvasReplay);
export default CanvasImageReplay;
src/ol/render/canvas/Immediate.js
+50 -67
View File
@@ -35,7 +35,8 @@ import {create as createTransform, compose as composeTransform} from '../../tran
* @param {number} viewRotation View rotation.
* @struct
*/
const CanvasImmediateRenderer = function(context, pixelRatio, extent, transform, viewRotation) {
class CanvasImmediateRenderer {
constructor(context, pixelRatio, extent, transform, viewRotation) {
VectorContext.call(this);
/**
@@ -236,10 +237,7 @@ const CanvasImmediateRenderer = function(context, pixelRatio, extent, transform,
*/
this.tmpLocalTransform_ = createTransform();
};
inherits(CanvasImmediateRenderer, VectorContext);
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -248,7 +246,7 @@ inherits(CanvasImmediateRenderer, VectorContext);
* @param {number} stride Stride.
* @private
*/
CanvasImmediateRenderer.prototype.drawImages_ = function(flatCoordinates, offset, end, stride) {
drawImages_(flatCoordinates, offset, end, stride) {
if (!this.image_) {
return;
}
@@ -292,8 +290,7 @@ CanvasImmediateRenderer.prototype.drawImages_ = function(flatCoordinates, offset
if (this.imageOpacity_ != 1) {
context.globalAlpha = alpha;
}
};
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -302,7 +299,7 @@ CanvasImmediateRenderer.prototype.drawImages_ = function(flatCoordinates, offset
* @param {number} stride Stride.
* @private
*/
CanvasImmediateRenderer.prototype.drawText_ = function(flatCoordinates, offset, end, stride) {
drawText_(flatCoordinates, offset, end, stride) {
if (!this.textState_ || this.text_ === '') {
return;
}
@@ -342,8 +339,7 @@ CanvasImmediateRenderer.prototype.drawText_ = function(flatCoordinates, offset,
if (rotation !== 0 || this.textScale_ != 1) {
context.setTransform(1, 0, 0, 1, 0, 0);
}
};
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -354,7 +350,7 @@ CanvasImmediateRenderer.prototype.drawText_ = function(flatCoordinates, offset,
* @private
* @return {number} end End.
*/
CanvasImmediateRenderer.prototype.moveToLineTo_ = function(flatCoordinates, offset, end, stride, close) {
moveToLineTo_(flatCoordinates, offset, end, stride, close) {
const context = this.context_;
const pixelCoordinates = transform2D(
flatCoordinates, offset, end, stride, this.transform_,
@@ -371,8 +367,7 @@ CanvasImmediateRenderer.prototype.moveToLineTo_ = function(flatCoordinates, offs
context.closePath();
}
return end;
};
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -382,13 +377,12 @@ CanvasImmediateRenderer.prototype.moveToLineTo_ = function(flatCoordinates, offs
* @private
* @return {number} End.
*/
CanvasImmediateRenderer.prototype.drawRings_ = function(flatCoordinates, offset, ends, stride) {
drawRings_(flatCoordinates, offset, ends, stride) {
for (let i = 0, ii = ends.length; i < ii; ++i) {
offset = this.moveToLineTo_(flatCoordinates, offset, ends[i], stride, true);
}
return offset;
};
}
/**
* Render a circle geometry into the canvas. Rendering is immediate and uses
@@ -398,7 +392,7 @@ CanvasImmediateRenderer.prototype.drawRings_ = function(flatCoordinates, offset,
* @override
* @api
*/
CanvasImmediateRenderer.prototype.drawCircle = function(geometry) {
drawCircle(geometry) {
if (!intersects(this.extent_, geometry.getExtent())) {
return;
}
@@ -428,8 +422,7 @@ CanvasImmediateRenderer.prototype.drawCircle = function(geometry) {
if (this.text_ !== '') {
this.drawText_(geometry.getCenter(), 0, 2, 2);
}
};
}
/**
* Set the rendering style. Note that since this is an immediate rendering API,
@@ -439,12 +432,11 @@ CanvasImmediateRenderer.prototype.drawCircle = function(geometry) {
* @override
* @api
*/
CanvasImmediateRenderer.prototype.setStyle = function(style) {
setStyle(style) {
this.setFillStrokeStyle(style.getFill(), style.getStroke());
this.setImageStyle(style.getImage());
this.setTextStyle(style.getText());
};
}
/**
* Render a geometry into the canvas. Call
@@ -454,7 +446,7 @@ CanvasImmediateRenderer.prototype.setStyle = function(style) {
* @override
* @api
*/
CanvasImmediateRenderer.prototype.drawGeometry = function(geometry) {
drawGeometry(geometry) {
const type = geometry.getType();
switch (type) {
case GeometryType.POINT:
@@ -483,8 +475,7 @@ CanvasImmediateRenderer.prototype.drawGeometry = function(geometry) {
break;
default:
}
};
}
/**
* Render a feature into the canvas. Note that any `zIndex` on the provided
@@ -497,15 +488,14 @@ CanvasImmediateRenderer.prototype.drawGeometry = function(geometry) {
* @override
* @api
*/
CanvasImmediateRenderer.prototype.drawFeature = function(feature, style) {
drawFeature(feature, style) {
const geometry = style.getGeometryFunction()(feature);
if (!geometry || !intersects(this.extent_, geometry.getExtent())) {
return;
}
this.setStyle(style);
this.drawGeometry(geometry);
};
}
/**
* Render a GeometryCollection to the canvas. Rendering is immediate and
@@ -514,13 +504,12 @@ CanvasImmediateRenderer.prototype.drawFeature = function(feature, style) {
* @param {module:ol/geom/GeometryCollection} geometry Geometry collection.
* @override
*/
CanvasImmediateRenderer.prototype.drawGeometryCollection = function(geometry) {
drawGeometryCollection(geometry) {
const geometries = geometry.getGeometriesArray();
for (let i = 0, ii = geometries.length; i < ii; ++i) {
this.drawGeometry(geometries[i]);
}
};
}
/**
* Render a Point geometry into the canvas. Rendering is immediate and uses
@@ -529,7 +518,7 @@ CanvasImmediateRenderer.prototype.drawGeometryCollection = function(geometry) {
* @param {module:ol/geom/Point|module:ol/render/Feature} geometry Point geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawPoint = function(geometry) {
drawPoint(geometry) {
const flatCoordinates = geometry.getFlatCoordinates();
const stride = geometry.getStride();
if (this.image_) {
@@ -538,8 +527,7 @@ CanvasImmediateRenderer.prototype.drawPoint = function(geometry) {
if (this.text_ !== '') {
this.drawText_(flatCoordinates, 0, flatCoordinates.length, stride);
}
};
}
/**
* Render a MultiPoint geometry into the canvas. Rendering is immediate and
@@ -548,7 +536,7 @@ CanvasImmediateRenderer.prototype.drawPoint = function(geometry) {
* @param {module:ol/geom/MultiPoint|module:ol/render/Feature} geometry MultiPoint geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawMultiPoint = function(geometry) {
drawMultiPoint(geometry) {
const flatCoordinates = geometry.getFlatCoordinates();
const stride = geometry.getStride();
if (this.image_) {
@@ -557,8 +545,7 @@ CanvasImmediateRenderer.prototype.drawMultiPoint = function(geometry) {
if (this.text_ !== '') {
this.drawText_(flatCoordinates, 0, flatCoordinates.length, stride);
}
};
}
/**
* Render a LineString into the canvas. Rendering is immediate and uses
@@ -567,7 +554,7 @@ CanvasImmediateRenderer.prototype.drawMultiPoint = function(geometry) {
* @param {module:ol/geom/LineString|module:ol/render/Feature} geometry LineString geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawLineString = function(geometry) {
drawLineString(geometry) {
if (!intersects(this.extent_, geometry.getExtent())) {
return;
}
@@ -584,8 +571,7 @@ CanvasImmediateRenderer.prototype.drawLineString = function(geometry) {
const flatMidpoint = geometry.getFlatMidpoint();
this.drawText_(flatMidpoint, 0, 2, 2);
}
};
}
/**
* Render a MultiLineString geometry into the canvas. Rendering is immediate
@@ -594,7 +580,7 @@ CanvasImmediateRenderer.prototype.drawLineString = function(geometry) {
* @param {module:ol/geom/MultiLineString|module:ol/render/Feature} geometry MultiLineString geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawMultiLineString = function(geometry) {
drawMultiLineString(geometry) {
const geometryExtent = geometry.getExtent();
if (!intersects(this.extent_, geometryExtent)) {
return;
@@ -616,8 +602,7 @@ CanvasImmediateRenderer.prototype.drawMultiLineString = function(geometry) {
const flatMidpoints = geometry.getFlatMidpoints();
this.drawText_(flatMidpoints, 0, flatMidpoints.length, 2);
}
};
}
/**
* Render a Polygon geometry into the canvas. Rendering is immediate and uses
@@ -626,7 +611,7 @@ CanvasImmediateRenderer.prototype.drawMultiLineString = function(geometry) {
* @param {module:ol/geom/Polygon|module:ol/render/Feature} geometry Polygon geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawPolygon = function(geometry) {
drawPolygon(geometry) {
if (!intersects(this.extent_, geometry.getExtent())) {
return;
}
@@ -652,8 +637,7 @@ CanvasImmediateRenderer.prototype.drawPolygon = function(geometry) {
const flatInteriorPoint = geometry.getFlatInteriorPoint();
this.drawText_(flatInteriorPoint, 0, 2, 2);
}
};
}
/**
* Render MultiPolygon geometry into the canvas. Rendering is immediate and
@@ -661,7 +645,7 @@ CanvasImmediateRenderer.prototype.drawPolygon = function(geometry) {
* @param {module:ol/geom/MultiPolygon} geometry MultiPolygon geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawMultiPolygon = function(geometry) {
drawMultiPolygon(geometry) {
if (!intersects(this.extent_, geometry.getExtent())) {
return;
}
@@ -693,14 +677,13 @@ CanvasImmediateRenderer.prototype.drawMultiPolygon = function(geometry) {
const flatInteriorPoints = geometry.getFlatInteriorPoints();
this.drawText_(flatInteriorPoints, 0, flatInteriorPoints.length, 2);
}
};
}
/**
* @param {module:ol/render/canvas~FillState} fillState Fill state.
* @private
*/
CanvasImmediateRenderer.prototype.setContextFillState_ = function(fillState) {
setContextFillState_(fillState) {
const context = this.context_;
const contextFillState = this.contextFillState_;
if (!contextFillState) {
@@ -713,14 +696,13 @@ CanvasImmediateRenderer.prototype.setContextFillState_ = function(fillState) {
contextFillState.fillStyle = context.fillStyle = fillState.fillStyle;
}
}
};
}
/**
* @param {module:ol/render/canvas~StrokeState} strokeState Stroke state.
* @private
*/
CanvasImmediateRenderer.prototype.setContextStrokeState_ = function(strokeState) {
setContextStrokeState_(strokeState) {
const context = this.context_;
const contextStrokeState = this.contextStrokeState_;
if (!contextStrokeState) {
@@ -770,14 +752,13 @@ CanvasImmediateRenderer.prototype.setContextStrokeState_ = function(strokeState)
strokeState.strokeStyle;
}
}
};
}
/**
* @param {module:ol/render/canvas~TextState} textState Text state.
* @private
*/
CanvasImmediateRenderer.prototype.setContextTextState_ = function(textState) {
setContextTextState_(textState) {
const context = this.context_;
const contextTextState = this.contextTextState_;
const textAlign = textState.textAlign ?
@@ -803,8 +784,7 @@ CanvasImmediateRenderer.prototype.setContextTextState_ = function(textState) {
textState.textBaseline;
}
}
};
}
/**
* Set the fill and stroke style for subsequent draw operations. To clear
@@ -814,7 +794,7 @@ CanvasImmediateRenderer.prototype.setContextTextState_ = function(textState) {
* @param {module:ol/style/Stroke} strokeStyle Stroke style.
* @override
*/
CanvasImmediateRenderer.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) {
setFillStrokeStyle(fillStyle, strokeStyle) {
if (!fillStyle) {
this.fillState_ = null;
} else {
@@ -851,8 +831,7 @@ CanvasImmediateRenderer.prototype.setFillStrokeStyle = function(fillStyle, strok
strokeStyleColor : defaultStrokeStyle)
};
}
};
}
/**
* Set the image style for subsequent draw operations. Pass null to remove
@@ -861,7 +840,7 @@ CanvasImmediateRenderer.prototype.setFillStrokeStyle = function(fillStyle, strok
* @param {module:ol/style/Image} imageStyle Image style.
* @override
*/
CanvasImmediateRenderer.prototype.setImageStyle = function(imageStyle) {
setImageStyle(imageStyle) {
if (!imageStyle) {
this.image_ = null;
} else {
@@ -883,8 +862,7 @@ CanvasImmediateRenderer.prototype.setImageStyle = function(imageStyle) {
this.imageSnapToPixel_ = imageStyle.getSnapToPixel();
this.imageWidth_ = imageSize[0];
}
};
}
/**
* Set the text style for subsequent draw operations. Pass null to
@@ -893,7 +871,7 @@ CanvasImmediateRenderer.prototype.setImageStyle = function(imageStyle) {
* @param {module:ol/style/Text} textStyle Text style.
* @override
*/
CanvasImmediateRenderer.prototype.setTextStyle = function(textStyle) {
setTextStyle(textStyle) {
if (!textStyle) {
this.text_ = '';
} else {
@@ -962,5 +940,10 @@ CanvasImmediateRenderer.prototype.setTextStyle = function(textStyle) {
this.textScale_ = this.pixelRatio_ * (textScale !== undefined ?
textScale : 1);
}
};
}
}
inherits(CanvasImmediateRenderer, VectorContext);
export default CanvasImmediateRenderer;
src/ol/render/canvas/LineStringReplay.js
+18 -20
View File
@@ -16,14 +16,11 @@ import CanvasReplay from '../canvas/Replay.js';
* @param {?} declutterTree Declutter tree.
* @struct
*/
const CanvasLineStringReplay = function(
tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
class CanvasLineStringReplay {
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
CanvasReplay.call(this,
tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree);
};
inherits(CanvasLineStringReplay, CanvasReplay);
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -33,7 +30,7 @@ inherits(CanvasLineStringReplay, CanvasReplay);
* @private
* @return {number} end.
*/
CanvasLineStringReplay.prototype.drawFlatCoordinates_ = function(flatCoordinates, offset, end, stride) {
drawFlatCoordinates_(flatCoordinates, offset, end, stride) {
const myBegin = this.coordinates.length;
const myEnd = this.appendFlatCoordinates(
flatCoordinates, offset, end, stride, false, false);
@@ -41,13 +38,12 @@ CanvasLineStringReplay.prototype.drawFlatCoordinates_ = function(flatCoordinates
this.instructions.push(moveToLineToInstruction);
this.hitDetectionInstructions.push(moveToLineToInstruction);
return end;
};
}
/**
* @inheritDoc
*/
CanvasLineStringReplay.prototype.drawLineString = function(lineStringGeometry, feature) {
drawLineString(lineStringGeometry, feature) {
const state = this.state;
const strokeStyle = state.strokeStyle;
const lineWidth = state.lineWidth;
@@ -66,13 +62,12 @@ CanvasLineStringReplay.prototype.drawLineString = function(lineStringGeometry, f
this.drawFlatCoordinates_(flatCoordinates, 0, flatCoordinates.length, stride);
this.hitDetectionInstructions.push(strokeInstruction);
this.endGeometry(lineStringGeometry, feature);
};
}
/**
* @inheritDoc
*/
CanvasLineStringReplay.prototype.drawMultiLineString = function(multiLineStringGeometry, feature) {
drawMultiLineString(multiLineStringGeometry, feature) {
const state = this.state;
const strokeStyle = state.strokeStyle;
const lineWidth = state.lineWidth;
@@ -95,26 +90,24 @@ CanvasLineStringReplay.prototype.drawMultiLineString = function(multiLineStringG
}
this.hitDetectionInstructions.push(strokeInstruction);
this.endGeometry(multiLineStringGeometry, feature);
};
}
/**
* @inheritDoc
*/
CanvasLineStringReplay.prototype.finish = function() {
finish() {
const state = this.state;
if (state.lastStroke != undefined && state.lastStroke != this.coordinates.length) {
this.instructions.push(strokeInstruction);
}
this.reverseHitDetectionInstructions();
this.state = null;
};
}
/**
* @inheritDoc.
*/
CanvasLineStringReplay.prototype.applyStroke = function(state) {
applyStroke(state) {
if (state.lastStroke != undefined && state.lastStroke != this.coordinates.length) {
this.instructions.push(strokeInstruction);
state.lastStroke = this.coordinates.length;
@@ -122,5 +115,10 @@ CanvasLineStringReplay.prototype.applyStroke = function(state) {
state.lastStroke = 0;
CanvasReplay.prototype.applyStroke.call(this, state);
this.instructions.push(beginPathInstruction);
};
}
}
inherits(CanvasLineStringReplay, CanvasReplay);
export default CanvasLineStringReplay;
src/ol/render/canvas/PolygonReplay.js
+20 -23
View File
@@ -22,14 +22,11 @@ import CanvasReplay from '../canvas/Replay.js';
* @param {?} declutterTree Declutter tree.
* @struct
*/
const CanvasPolygonReplay = function(
tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
class CanvasPolygonReplay {
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
CanvasReplay.call(this,
tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree);
};
inherits(CanvasPolygonReplay, CanvasReplay);
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -39,7 +36,7 @@ inherits(CanvasPolygonReplay, CanvasReplay);
* @private
* @return {number} End.
*/
CanvasPolygonReplay.prototype.drawFlatCoordinatess_ = function(flatCoordinates, offset, ends, stride) {
drawFlatCoordinatess_(flatCoordinates, offset, ends, stride) {
const state = this.state;
const fill = state.fillStyle !== undefined;
const stroke = state.strokeStyle != undefined;
@@ -70,13 +67,12 @@ CanvasPolygonReplay.prototype.drawFlatCoordinatess_ = function(flatCoordinates,
this.hitDetectionInstructions.push(strokeInstruction);
}
return offset;
};
}
/**
* @inheritDoc
*/
CanvasPolygonReplay.prototype.drawCircle = function(circleGeometry, feature) {
drawCircle(circleGeometry, feature) {
const state = this.state;
const fillStyle = state.fillStyle;
const strokeStyle = state.strokeStyle;
@@ -115,13 +111,12 @@ CanvasPolygonReplay.prototype.drawCircle = function(circleGeometry, feature) {
this.hitDetectionInstructions.push(strokeInstruction);
}
this.endGeometry(circleGeometry, feature);
};
}
/**
* @inheritDoc
*/
CanvasPolygonReplay.prototype.drawPolygon = function(polygonGeometry, feature) {
drawPolygon(polygonGeometry, feature) {
const state = this.state;
const fillStyle = state.fillStyle;
const strokeStyle = state.strokeStyle;
@@ -148,13 +143,12 @@ CanvasPolygonReplay.prototype.drawPolygon = function(polygonGeometry, feature) {
const stride = polygonGeometry.getStride();
this.drawFlatCoordinatess_(flatCoordinates, 0, ends, stride);
this.endGeometry(polygonGeometry, feature);
};
}
/**
* @inheritDoc
*/
CanvasPolygonReplay.prototype.drawMultiPolygon = function(multiPolygonGeometry, feature) {
drawMultiPolygon(multiPolygonGeometry, feature) {
const state = this.state;
const fillStyle = state.fillStyle;
const strokeStyle = state.strokeStyle;
@@ -184,13 +178,12 @@ CanvasPolygonReplay.prototype.drawMultiPolygon = function(multiPolygonGeometry,
offset = this.drawFlatCoordinatess_(flatCoordinates, offset, endss[i], stride);
}
this.endGeometry(multiPolygonGeometry, feature);
};
}
/**
* @inheritDoc
*/
CanvasPolygonReplay.prototype.finish = function() {
finish() {
this.reverseHitDetectionInstructions();
this.state = null;
// We want to preserve topology when drawing polygons. Polygons are
@@ -204,14 +197,13 @@ CanvasPolygonReplay.prototype.finish = function() {
coordinates[i] = snap(coordinates[i], tolerance);
}
}
};
}
/**
* @private
* @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry.
*/
CanvasPolygonReplay.prototype.setFillStrokeStyles_ = function(geometry) {
setFillStrokeStyles_(geometry) {
const state = this.state;
const fillStyle = state.fillStyle;
if (fillStyle !== undefined) {
@@ -220,5 +212,10 @@ CanvasPolygonReplay.prototype.setFillStrokeStyles_ = function(geometry) {
if (state.strokeStyle !== undefined) {
this.updateStrokeStyle(state, this.applyStroke);
}
};
}
}
inherits(CanvasPolygonReplay, CanvasReplay);
export default CanvasPolygonReplay;
src/ol/render/canvas/Replay.js
+103 -95
View File
@@ -39,7 +39,8 @@ import {
* @param {?} declutterTree Declutter tree.
* @struct
*/
const CanvasReplay = function(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
class CanvasReplay {
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
VectorContext.call(this);
/**
@@ -157,21 +158,7 @@ const CanvasReplay = function(tolerance, maxExtent, resolution, pixelRatio, over
*/
this.viewRotation_ = 0;
};
inherits(CanvasReplay, VectorContext);
/**
* @type {module:ol/extent~Extent}
*/
const tmpExtent = createEmpty();
/**
* @type {!module:ol/transform~Transform}
*/
const tmpTransform = createTransform();
}
/**
* @param {CanvasRenderingContext2D} context Context.
@@ -182,8 +169,7 @@ const tmpTransform = createTransform();
* @param {Array.<*>} fillInstruction Fill instruction.
* @param {Array.<*>} strokeInstruction Stroke instruction.
*/
CanvasReplay.prototype.replayTextBackground_ = function(context, p1, p2, p3, p4,
fillInstruction, strokeInstruction) {
replayTextBackground_(context, p1, p2, p3, p4, fillInstruction, strokeInstruction) {
context.beginPath();
context.moveTo.apply(context, p1);
context.lineTo.apply(context, p2);
@@ -198,8 +184,7 @@ CanvasReplay.prototype.replayTextBackground_ = function(context, p1, p2, p3, p4,
this.setStrokeStyle_(context, /** @type {Array.<*>} */ (strokeInstruction));
context.stroke();
}
};
}
/**
* @param {CanvasRenderingContext2D} context Context.
@@ -221,9 +206,26 @@ CanvasReplay.prototype.replayTextBackground_ = function(context, p1, p2, p3, p4,
* @param {Array.<*>} fillInstruction Fill instruction.
* @param {Array.<*>} strokeInstruction Stroke instruction.
*/
CanvasReplay.prototype.replayImage_ = function(context, x, y, image,
anchorX, anchorY, declutterGroup, height, opacity, originX, originY,
rotation, scale, snapToPixel, width, padding, fillInstruction, strokeInstruction) {
replayImage_(
context,
x,
y,
image,
anchorX,
anchorY,
declutterGroup,
height,
opacity,
originX,
originY,
rotation,
scale,
snapToPixel,
width,
padding,
fillInstruction,
strokeInstruction
) {
const fillStroke = fillInstruction || strokeInstruction;
anchorX *= scale;
anchorY *= scale;
@@ -297,21 +299,19 @@ CanvasReplay.prototype.replayImage_ = function(context, x, y, image,
}
drawImage(context, transform, opacity, image, originX, originY, w, h, x, y, scale);
}
};
}
/**
* @protected
* @param {Array.<number>} dashArray Dash array.
* @return {Array.<number>} Dash array with pixel ratio applied
*/
CanvasReplay.prototype.applyPixelRatio = function(dashArray) {
applyPixelRatio(dashArray) {
const pixelRatio = this.pixelRatio;
return pixelRatio == 1 ? dashArray : dashArray.map(function(dash) {
return dash * pixelRatio;
});
};
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -323,7 +323,7 @@ CanvasReplay.prototype.applyPixelRatio = function(dashArray) {
* @protected
* @return {number} My end.
*/
CanvasReplay.prototype.appendFlatCoordinates = function(flatCoordinates, offset, end, stride, closed, skipFirst) {
appendFlatCoordinates(flatCoordinates, offset, end, stride, closed, skipFirst) {
let myEnd = this.coordinates.length;
const extent = this.getBufferedMaxExtent();
@@ -365,8 +365,7 @@ CanvasReplay.prototype.appendFlatCoordinates = function(flatCoordinates, offset,
this.coordinates[myEnd++] = lastCoord[1];
}
return myEnd;
};
}
/**
* @param {Array.<number>} flatCoordinates Flat coordinates.
@@ -376,7 +375,7 @@ CanvasReplay.prototype.appendFlatCoordinates = function(flatCoordinates, offset,
* @param {Array.<number>} replayEnds Replay ends.
* @return {number} Offset.
*/
CanvasReplay.prototype.drawCustomCoordinates_ = function(flatCoordinates, offset, ends, stride, replayEnds) {
drawCustomCoordinates_(flatCoordinates, offset, ends, stride, replayEnds) {
for (let i = 0, ii = ends.length; i < ii; ++i) {
const end = ends[i];
const replayEnd = this.appendFlatCoordinates(flatCoordinates, offset, end, stride, false, false);
@@ -384,13 +383,12 @@ CanvasReplay.prototype.drawCustomCoordinates_ = function(flatCoordinates, offset
offset = end;
}
return offset;
};
}
/**
* @inheritDoc.
*/
CanvasReplay.prototype.drawCustom = function(geometry, feature, renderer) {
drawCustom(geometry, feature, renderer) {
this.beginGeometry(geometry, feature);
const type = geometry.getType();
const stride = geometry.getStride();
@@ -434,27 +432,25 @@ CanvasReplay.prototype.drawCustom = function(geometry, feature, renderer) {
replayBegin, replayEnd, geometry, renderer]);
}
this.endGeometry(geometry, feature);
};
}
/**
* @protected
* @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
CanvasReplay.prototype.beginGeometry = function(geometry, feature) {
beginGeometry(geometry, feature) {
this.beginGeometryInstruction1_ = [CanvasInstruction.BEGIN_GEOMETRY, feature, 0];
this.instructions.push(this.beginGeometryInstruction1_);
this.beginGeometryInstruction2_ = [CanvasInstruction.BEGIN_GEOMETRY, feature, 0];
this.hitDetectionInstructions.push(this.beginGeometryInstruction2_);
};
}
/**
* @private
* @param {CanvasRenderingContext2D} context Context.
*/
CanvasReplay.prototype.fill_ = function(context) {
fill_(context) {
if (this.alignFill_) {
const origin = applyTransform(this.renderedTransform_, [0, 0]);
const repeatSize = 512 * this.pixelRatio;
@@ -465,15 +461,14 @@ CanvasReplay.prototype.fill_ = function(context) {
if (this.alignFill_) {
context.setTransform.apply(context, resetTransform);
}
};
}
/**
* @private
* @param {CanvasRenderingContext2D} context Context.
* @param {Array.<*>} instruction Instruction.
*/
CanvasReplay.prototype.setStrokeStyle_ = function(context, instruction) {
setStrokeStyle_(context, instruction) {
context.strokeStyle = /** @type {module:ol/colorlike~ColorLike} */ (instruction[1]);
context.lineWidth = /** @type {number} */ (instruction[2]);
context.lineCap = /** @type {string} */ (instruction[3]);
@@ -483,14 +478,13 @@ CanvasReplay.prototype.setStrokeStyle_ = function(context, instruction) {
context.lineDashOffset = /** @type {number} */ (instruction[7]);
context.setLineDash(/** @type {Array.<number>} */ (instruction[6]));
}
};
}
/**
* @param {module:ol/render/canvas~DeclutterGroup} declutterGroup Declutter group.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
CanvasReplay.prototype.renderDeclutter_ = function(declutterGroup, feature) {
renderDeclutter_(declutterGroup, feature) {
if (declutterGroup && declutterGroup.length > 5) {
const groupCount = declutterGroup[4];
if (groupCount == 1 || groupCount == declutterGroup.length - 5) {
@@ -520,8 +514,7 @@ CanvasReplay.prototype.renderDeclutter_ = function(declutterGroup, feature) {
createOrUpdateEmpty(declutterGroup);
}
}
};
}
/**
* @private
@@ -537,9 +530,14 @@ CanvasReplay.prototype.renderDeclutter_ = function(declutterGroup, feature) {
* @return {T|undefined} Callback result.
* @template T
*/
CanvasReplay.prototype.replay_ = function(
context, transform, skippedFeaturesHash,
instructions, featureCallback, opt_hitExtent) {
replay_(
context,
transform,
skippedFeaturesHash,
instructions,
featureCallback,
opt_hitExtent
) {
/** @type {Array.<number>} */
let pixelCoordinates;
if (this.pixelCoordinates_ && equals(transform, this.renderedTransform_)) {
@@ -838,8 +836,7 @@ CanvasReplay.prototype.replay_ = function(
context.stroke();
}
return undefined;
};
}
/**
* @param {CanvasRenderingContext2D} context Context.
@@ -848,13 +845,11 @@ CanvasReplay.prototype.replay_ = function(
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip.
*/
CanvasReplay.prototype.replay = function(
context, transform, viewRotation, skippedFeaturesHash) {
replay(context, transform, viewRotation, skippedFeaturesHash) {
this.viewRotation_ = viewRotation;
this.replay_(context, transform,
skippedFeaturesHash, this.instructions, undefined, undefined);
};
}
/**
* @param {CanvasRenderingContext2D} context Context.
@@ -869,19 +864,23 @@ CanvasReplay.prototype.replay = function(
* @return {T|undefined} Callback result.
* @template T
*/
CanvasReplay.prototype.replayHitDetection = function(
context, transform, viewRotation, skippedFeaturesHash,
opt_featureCallback, opt_hitExtent) {
replayHitDetection(
context,
transform,
viewRotation,
skippedFeaturesHash,
opt_featureCallback,
opt_hitExtent
) {
this.viewRotation_ = viewRotation;
return this.replay_(context, transform, skippedFeaturesHash,
this.hitDetectionInstructions, opt_featureCallback, opt_hitExtent);
};
}
/**
* Reverse the hit detection instructions.
*/
CanvasReplay.prototype.reverseHitDetectionInstructions = function() {
reverseHitDetectionInstructions() {
const hitDetectionInstructions = this.hitDetectionInstructions;
// step 1 - reverse array
hitDetectionInstructions.reverse();
@@ -902,13 +901,12 @@ CanvasReplay.prototype.reverseHitDetectionInstructions = function() {
begin = -1;
}
}
};
}
/**
* @inheritDoc
*/
CanvasReplay.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) {
setFillStrokeStyle(fillStyle, strokeStyle) {
const state = this.state;
if (fillStyle) {
const fillStyleColor = fillStyle.getColor();
@@ -954,15 +952,14 @@ CanvasReplay.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) {
state.lineWidth = undefined;
state.miterLimit = undefined;
}
};
}
/**
* @param {module:ol/render/canvas~FillStrokeState} state State.
* @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry.
* @return {Array.<*>} Fill instruction.
*/
CanvasReplay.prototype.createFill = function(state, geometry) {
createFill(state, geometry) {
const fillStyle = state.fillStyle;
const fillInstruction = [CanvasInstruction.SET_FILL_STYLE, fillStyle];
if (typeof fillStyle !== 'string') {
@@ -970,37 +967,34 @@ CanvasReplay.prototype.createFill = function(state, geometry) {
fillInstruction.push(true);
}
return fillInstruction;
};
}
/**
* @param {module:ol/render/canvas~FillStrokeState} state State.
*/
CanvasReplay.prototype.applyStroke = function(state) {
applyStroke(state) {
this.instructions.push(this.createStroke(state));
};
}
/**
* @param {module:ol/render/canvas~FillStrokeState} state State.
* @return {Array.<*>} Stroke instruction.
*/
CanvasReplay.prototype.createStroke = function(state) {
createStroke(state) {
return [
CanvasInstruction.SET_STROKE_STYLE,
state.strokeStyle, state.lineWidth * this.pixelRatio, state.lineCap,
state.lineJoin, state.miterLimit,
this.applyPixelRatio(state.lineDash), state.lineDashOffset * this.pixelRatio
];
};
}
/**
* @param {module:ol/render/canvas~FillStrokeState} state State.
* @param {function(this:module:ol/render/canvas/Replay, module:ol/render/canvas~FillStrokeState, (module:ol/geom/Geometry|module:ol/render/Feature)):Array.<*>} createFill Create fill.
* @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry.
*/
CanvasReplay.prototype.updateFillStyle = function(state, createFill, geometry) {
updateFillStyle(state, createFill, geometry) {
const fillStyle = state.fillStyle;
if (typeof fillStyle !== 'string' || state.currentFillStyle != fillStyle) {
if (fillStyle !== undefined) {
@@ -1008,14 +1002,13 @@ CanvasReplay.prototype.updateFillStyle = function(state, createFill, geometry) {
}
state.currentFillStyle = fillStyle;
}
};
}
/**
* @param {module:ol/render/canvas~FillStrokeState} state State.
* @param {function(this:module:ol/render/canvas/Replay, module:ol/render/canvas~FillStrokeState)} applyStroke Apply stroke.
*/
CanvasReplay.prototype.updateStrokeStyle = function(state, applyStroke) {
updateStrokeStyle(state, applyStroke) {
const strokeStyle = state.strokeStyle;
const lineCap = state.lineCap;
const lineDash = state.lineDash;
@@ -1041,14 +1034,13 @@ CanvasReplay.prototype.updateStrokeStyle = function(state, applyStroke) {
state.currentLineWidth = lineWidth;
state.currentMiterLimit = miterLimit;
}
};
}
/**
* @param {module:ol/geom/Geometry|module:ol/render/Feature} geometry Geometry.
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
*/
CanvasReplay.prototype.endGeometry = function(geometry, feature) {
endGeometry(geometry, feature) {
this.beginGeometryInstruction1_[2] = this.instructions.length;
this.beginGeometryInstruction1_ = null;
this.beginGeometryInstruction2_[2] = this.hitDetectionInstructions.length;
@@ -1056,14 +1048,7 @@ CanvasReplay.prototype.endGeometry = function(geometry, feature) {
const endGeometryInstruction = [CanvasInstruction.END_GEOMETRY, feature];
this.instructions.push(endGeometryInstruction);
this.hitDetectionInstructions.push(endGeometryInstruction);
};
/**
* FIXME empty description for jsdoc
*/
CanvasReplay.prototype.finish = UNDEFINED;
}
/**
* Get the buffered rendering extent. Rendering will be clipped to the extent
@@ -1072,7 +1057,7 @@ CanvasReplay.prototype.finish = UNDEFINED;
* @return {module:ol/extent~Extent} The buffered rendering extent.
* @protected
*/
CanvasReplay.prototype.getBufferedMaxExtent = function() {
getBufferedMaxExtent() {
if (!this.bufferedMaxExtent_) {
this.bufferedMaxExtent_ = clone(this.maxExtent);
if (this.maxLineWidth > 0) {
@@ -1081,5 +1066,28 @@ CanvasReplay.prototype.getBufferedMaxExtent = function() {
}
}
return this.bufferedMaxExtent_;
};
}
}
inherits(CanvasReplay, VectorContext);
/**
* @type {module:ol/extent~Extent}
*/
const tmpExtent = createEmpty();
/**
* @type {!module:ol/transform~Transform}
*/
const tmpTransform = createTransform();
/**
* FIXME empty description for jsdoc
*/
CanvasReplay.prototype.finish = UNDEFINED;
export default CanvasReplay;
src/ol/render/canvas/ReplayGroup.js
+293 -280
View File
@@ -46,8 +46,16 @@ const BATCH_CONSTRUCTORS = {
* @param {number=} opt_renderBuffer Optional rendering buffer.
* @struct
*/
const CanvasReplayGroup = function(
tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree, opt_renderBuffer) {
class CanvasReplayGroup {
constructor(
tolerance,
maxExtent,
resolution,
pixelRatio,
overlaps,
declutterTree,
opt_renderBuffer
) {
ReplayGroup.call(this);
/**
@@ -115,7 +123,289 @@ const CanvasReplayGroup = function(
* @type {module:ol/transform~Transform}
*/
this.hitDetectionTransform_ = createTransform();
};
}
/**
* @param {boolean} group Group with previous replay.
* @return {module:ol/render/canvas~DeclutterGroup} Declutter instruction group.
*/
addDeclutter(group) {
let declutter = null;
if (this.declutterTree_) {
if (group) {
declutter = this.declutterGroup_;
/** @type {number} */ (declutter[4])++;
} else {
declutter = this.declutterGroup_ = createEmpty();
declutter.push(1);
}
}
return declutter;
}
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {module:ol/transform~Transform} transform Transform.
*/
clip(context, transform) {
const flatClipCoords = this.getClipCoords(transform);
context.beginPath();
context.moveTo(flatClipCoords[0], flatClipCoords[1]);
context.lineTo(flatClipCoords[2], flatClipCoords[3]);
context.lineTo(flatClipCoords[4], flatClipCoords[5]);
context.lineTo(flatClipCoords[6], flatClipCoords[7]);
context.clip();
}
/**
* @param {Array.<module:ol/render/ReplayType>} replays Replays.
* @return {boolean} Has replays of the provided types.
*/
hasReplays(replays) {
for (const zIndex in this.replaysByZIndex_) {
const candidates = this.replaysByZIndex_[zIndex];
for (let i = 0, ii = replays.length; i < ii; ++i) {
if (replays[i] in candidates) {
return true;
}
}
}
return false;
}
/**
* FIXME empty description for jsdoc
*/
finish() {
for (const zKey in this.replaysByZIndex_) {
const replays = this.replaysByZIndex_[zKey];
for (const replayKey in replays) {
replays[replayKey].finish();
}
}
}
/**
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution.
* @param {number} rotation Rotation.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature|module:ol/render/Feature)): T} callback Feature callback.
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>} declutterReplays Declutter replays.
* @return {T|undefined} Callback result.
* @template T
*/
forEachFeatureAtCoordinate(
coordinate,
resolution,
rotation,
hitTolerance,
skippedFeaturesHash,
callback,
declutterReplays
) {
hitTolerance = Math.round(hitTolerance);
const contextSize = hitTolerance * 2 + 1;
const transform = composeTransform(this.hitDetectionTransform_,
hitTolerance + 0.5, hitTolerance + 0.5,
1 / resolution, -1 / resolution,
-rotation,
-coordinate[0], -coordinate[1]);
const context = this.hitDetectionContext_;
if (context.canvas.width !== contextSize || context.canvas.height !== contextSize) {
context.canvas.width = contextSize;
context.canvas.height = contextSize;
} else {
context.clearRect(0, 0, contextSize, contextSize);
}
/**
* @type {module:ol/extent~Extent}
*/
let hitExtent;
if (this.renderBuffer_ !== undefined) {
hitExtent = createEmpty();
extendCoordinate(hitExtent, coordinate);
buffer(hitExtent, resolution * (this.renderBuffer_ + hitTolerance), hitExtent);
}
const mask = getCircleArray(hitTolerance);
let declutteredFeatures;
if (this.declutterTree_) {
declutteredFeatures = this.declutterTree_.all().map(function(entry) {
return entry.value;
});
}
let replayType;
/**
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
* @return {?} Callback result.
*/
function featureCallback(feature) {
const imageData = context.getImageData(0, 0, contextSize, contextSize).data;
for (let i = 0; i < contextSize; i++) {
for (let j = 0; j < contextSize; j++) {
if (mask[i][j]) {
if (imageData[(j * contextSize + i) * 4 + 3] > 0) {
let result;
if (!(declutteredFeatures && (replayType == ReplayType.IMAGE || replayType == ReplayType.TEXT)) ||
declutteredFeatures.indexOf(feature) !== -1) {
result = callback(feature);
}
if (result) {
return result;
} else {
context.clearRect(0, 0, contextSize, contextSize);
return undefined;
}
}
}
}
}
}
/** @type {Array.<number>} */
const zs = Object.keys(this.replaysByZIndex_).map(Number);
zs.sort(numberSafeCompareFunction);
let i, j, replays, replay, result;
for (i = zs.length - 1; i >= 0; --i) {
const zIndexKey = zs[i].toString();
replays = this.replaysByZIndex_[zIndexKey];
for (j = ORDER.length - 1; j >= 0; --j) {
replayType = ORDER[j];
replay = replays[replayType];
if (replay !== undefined) {
if (declutterReplays &&
(replayType == ReplayType.IMAGE || replayType == ReplayType.TEXT)) {
const declutter = declutterReplays[zIndexKey];
if (!declutter) {
declutterReplays[zIndexKey] = [replay, transform.slice(0)];
} else {
declutter.push(replay, transform.slice(0));
}
} else {
result = replay.replayHitDetection(context, transform, rotation,
skippedFeaturesHash, featureCallback, hitExtent);
if (result) {
return result;
}
}
}
}
}
return undefined;
}
/**
* @param {module:ol/transform~Transform} transform Transform.
* @return {Array.<number>} Clip coordinates.
*/
getClipCoords(transform) {
const maxExtent = this.maxExtent_;
const minX = maxExtent[0];
const minY = maxExtent[1];
const maxX = maxExtent[2];
const maxY = maxExtent[3];
const flatClipCoords = [minX, minY, minX, maxY, maxX, maxY, maxX, minY];
transform2D(
flatClipCoords, 0, 8, 2, transform, flatClipCoords);
return flatClipCoords;
}
/**
* @inheritDoc
*/
getReplay(zIndex, replayType) {
const zIndexKey = zIndex !== undefined ? zIndex.toString() : '0';
let replays = this.replaysByZIndex_[zIndexKey];
if (replays === undefined) {
replays = {};
this.replaysByZIndex_[zIndexKey] = replays;
}
let replay = replays[replayType];
if (replay === undefined) {
const Constructor = BATCH_CONSTRUCTORS[replayType];
replay = new Constructor(this.tolerance_, this.maxExtent_,
this.resolution_, this.pixelRatio_, this.overlaps_, this.declutterTree_);
replays[replayType] = replay;
}
return replay;
}
/**
* @return {Object.<string, Object.<module:ol/render/ReplayType, module:ol/render/canvas/Replay>>} Replays.
*/
getReplays() {
return this.replaysByZIndex_;
}
/**
* @inheritDoc
*/
isEmpty() {
return isEmpty(this.replaysByZIndex_);
}
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {module:ol/transform~Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {Array.<module:ol/render/ReplayType>=} opt_replayTypes Ordered replay types to replay.
* Default is {@link module:ol/render/replay~ORDER}
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>=} opt_declutterReplays Declutter replays.
*/
replay(
context,
transform,
viewRotation,
skippedFeaturesHash,
opt_replayTypes,
opt_declutterReplays
) {
/** @type {Array.<number>} */
const zs = Object.keys(this.replaysByZIndex_).map(Number);
zs.sort(numberSafeCompareFunction);
// setup clipping so that the parts of over-simplified geometries are not
// visible outside the current extent when panning
context.save();
this.clip(context, transform);
const replayTypes = opt_replayTypes ? opt_replayTypes : ORDER;
let i, ii, j, jj, replays, replay;
for (i = 0, ii = zs.length; i < ii; ++i) {
const zIndexKey = zs[i].toString();
replays = this.replaysByZIndex_[zIndexKey];
for (j = 0, jj = replayTypes.length; j < jj; ++j) {
const replayType = replayTypes[j];
replay = replays[replayType];
if (replay !== undefined) {
if (opt_declutterReplays &&
(replayType == ReplayType.IMAGE || replayType == ReplayType.TEXT)) {
const declutter = opt_declutterReplays[zIndexKey];
if (!declutter) {
opt_declutterReplays[zIndexKey] = [replay, transform.slice(0)];
} else {
declutter.push(replay, transform.slice(0));
}
} else {
replay.replay(context, transform, viewRotation, skippedFeaturesHash);
}
}
}
}
context.restore();
}
}
inherits(CanvasReplayGroup, ReplayGroup);
@@ -217,281 +507,4 @@ export function replayDeclutter(declutterReplays, context, rotation) {
}
/**
* @param {boolean} group Group with previous replay.
* @return {module:ol/render/canvas~DeclutterGroup} Declutter instruction group.
*/
CanvasReplayGroup.prototype.addDeclutter = function(group) {
let declutter = null;
if (this.declutterTree_) {
if (group) {
declutter = this.declutterGroup_;
/** @type {number} */ (declutter[4])++;
} else {
declutter = this.declutterGroup_ = createEmpty();
declutter.push(1);
}
}
return declutter;
};
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {module:ol/transform~Transform} transform Transform.
*/
CanvasReplayGroup.prototype.clip = function(context, transform) {
const flatClipCoords = this.getClipCoords(transform);
context.beginPath();
context.moveTo(flatClipCoords[0], flatClipCoords[1]);
context.lineTo(flatClipCoords[2], flatClipCoords[3]);
context.lineTo(flatClipCoords[4], flatClipCoords[5]);
context.lineTo(flatClipCoords[6], flatClipCoords[7]);
context.clip();
};
/**
* @param {Array.<module:ol/render/ReplayType>} replays Replays.
* @return {boolean} Has replays of the provided types.
*/
CanvasReplayGroup.prototype.hasReplays = function(replays) {
for (const zIndex in this.replaysByZIndex_) {
const candidates = this.replaysByZIndex_[zIndex];
for (let i = 0, ii = replays.length; i < ii; ++i) {
if (replays[i] in candidates) {
return true;
}
}
}
return false;
};
/**
* FIXME empty description for jsdoc
*/
CanvasReplayGroup.prototype.finish = function() {
for (const zKey in this.replaysByZIndex_) {
const replays = this.replaysByZIndex_[zKey];
for (const replayKey in replays) {
replays[replayKey].finish();
}
}
};
/**
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution.
* @param {number} rotation Rotation.
* @param {number} hitTolerance Hit tolerance in pixels.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature|module:ol/render/Feature)): T} callback Feature callback.
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>} declutterReplays Declutter replays.
* @return {T|undefined} Callback result.
* @template T
*/
CanvasReplayGroup.prototype.forEachFeatureAtCoordinate = function(
coordinate, resolution, rotation, hitTolerance, skippedFeaturesHash, callback, declutterReplays) {
hitTolerance = Math.round(hitTolerance);
const contextSize = hitTolerance * 2 + 1;
const transform = composeTransform(this.hitDetectionTransform_,
hitTolerance + 0.5, hitTolerance + 0.5,
1 / resolution, -1 / resolution,
-rotation,
-coordinate[0], -coordinate[1]);
const context = this.hitDetectionContext_;
if (context.canvas.width !== contextSize || context.canvas.height !== contextSize) {
context.canvas.width = contextSize;
context.canvas.height = contextSize;
} else {
context.clearRect(0, 0, contextSize, contextSize);
}
/**
* @type {module:ol/extent~Extent}
*/
let hitExtent;
if (this.renderBuffer_ !== undefined) {
hitExtent = createEmpty();
extendCoordinate(hitExtent, coordinate);
buffer(hitExtent, resolution * (this.renderBuffer_ + hitTolerance), hitExtent);
}
const mask = getCircleArray(hitTolerance);
let declutteredFeatures;
if (this.declutterTree_) {
declutteredFeatures = this.declutterTree_.all().map(function(entry) {
return entry.value;
});
}
let replayType;
/**
* @param {module:ol/Feature|module:ol/render/Feature} feature Feature.
* @return {?} Callback result.
*/
function featureCallback(feature) {
const imageData = context.getImageData(0, 0, contextSize, contextSize).data;
for (let i = 0; i < contextSize; i++) {
for (let j = 0; j < contextSize; j++) {
if (mask[i][j]) {
if (imageData[(j * contextSize + i) * 4 + 3] > 0) {
let result;
if (!(declutteredFeatures && (replayType == ReplayType.IMAGE || replayType == ReplayType.TEXT)) ||
declutteredFeatures.indexOf(feature) !== -1) {
result = callback(feature);
}
if (result) {
return result;
} else {
context.clearRect(0, 0, contextSize, contextSize);
return undefined;
}
}
}
}
}
}
/** @type {Array.<number>} */
const zs = Object.keys(this.replaysByZIndex_).map(Number);
zs.sort(numberSafeCompareFunction);
let i, j, replays, replay, result;
for (i = zs.length - 1; i >= 0; --i) {
const zIndexKey = zs[i].toString();
replays = this.replaysByZIndex_[zIndexKey];
for (j = ORDER.length - 1; j >= 0; --j) {
replayType = ORDER[j];
replay = replays[replayType];
if (replay !== undefined) {
if (declutterReplays &&
(replayType == ReplayType.IMAGE || replayType == ReplayType.TEXT)) {
const declutter = declutterReplays[zIndexKey];
if (!declutter) {
declutterReplays[zIndexKey] = [replay, transform.slice(0)];
} else {
declutter.push(replay, transform.slice(0));
}
} else {
result = replay.replayHitDetection(context, transform, rotation,
skippedFeaturesHash, featureCallback, hitExtent);
if (result) {
return result;
}
}
}
}
}
return undefined;
};
/**
* @param {module:ol/transform~Transform} transform Transform.
* @return {Array.<number>} Clip coordinates.
*/
CanvasReplayGroup.prototype.getClipCoords = function(transform) {
const maxExtent = this.maxExtent_;
const minX = maxExtent[0];
const minY = maxExtent[1];
const maxX = maxExtent[2];
const maxY = maxExtent[3];
const flatClipCoords = [minX, minY, minX, maxY, maxX, maxY, maxX, minY];
transform2D(
flatClipCoords, 0, 8, 2, transform, flatClipCoords);
return flatClipCoords;
};
/**
* @inheritDoc
*/
CanvasReplayGroup.prototype.getReplay = function(zIndex, replayType) {
const zIndexKey = zIndex !== undefined ? zIndex.toString() : '0';
let replays = this.replaysByZIndex_[zIndexKey];
if (replays === undefined) {
replays = {};
this.replaysByZIndex_[zIndexKey] = replays;
}
let replay = replays[replayType];
if (replay === undefined) {
const Constructor = BATCH_CONSTRUCTORS[replayType];
replay = new Constructor(this.tolerance_, this.maxExtent_,
this.resolution_, this.pixelRatio_, this.overlaps_, this.declutterTree_);
replays[replayType] = replay;
}
return replay;
};
/**
* @return {Object.<string, Object.<module:ol/render/ReplayType, module:ol/render/canvas/Replay>>} Replays.
*/
CanvasReplayGroup.prototype.getReplays = function() {
return this.replaysByZIndex_;
};
/**
* @inheritDoc
*/
CanvasReplayGroup.prototype.isEmpty = function() {
return isEmpty(this.replaysByZIndex_);
};
/**
* @param {CanvasRenderingContext2D} context Context.
* @param {module:ol/transform~Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {Array.<module:ol/render/ReplayType>=} opt_replayTypes Ordered replay types to replay.
* Default is {@link module:ol/render/replay~ORDER}
* @param {Object.<string, module:ol/render/canvas~DeclutterGroup>=} opt_declutterReplays Declutter replays.
*/
CanvasReplayGroup.prototype.replay = function(context,
transform, viewRotation, skippedFeaturesHash, opt_replayTypes, opt_declutterReplays) {
/** @type {Array.<number>} */
const zs = Object.keys(this.replaysByZIndex_).map(Number);
zs.sort(numberSafeCompareFunction);
// setup clipping so that the parts of over-simplified geometries are not
// visible outside the current extent when panning
context.save();
this.clip(context, transform);
const replayTypes = opt_replayTypes ? opt_replayTypes : ORDER;
let i, ii, j, jj, replays, replay;
for (i = 0, ii = zs.length; i < ii; ++i) {
const zIndexKey = zs[i].toString();
replays = this.replaysByZIndex_[zIndexKey];
for (j = 0, jj = replayTypes.length; j < jj; ++j) {
const replayType = replayTypes[j];
replay = replays[replayType];
if (replay !== undefined) {
if (opt_declutterReplays &&
(replayType == ReplayType.IMAGE || replayType == ReplayType.TEXT)) {
const declutter = opt_declutterReplays[zIndexKey];
if (!declutter) {
opt_declutterReplays[zIndexKey] = [replay, transform.slice(0)];
} else {
declutter.push(replay, transform.slice(0));
}
} else {
replay.replay(context, transform, viewRotation, skippedFeaturesHash);
}
}
}
}
context.restore();
};
export default CanvasReplayGroup;

Some files were not shown because too many files have changed in this diff Show More