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

Module types for ol/geom

Browse Source
This commit is contained in:
Tim Schaub
2018-03-11 23:08:50 -06:00
parent 41d9a84a8f
commit ef70d71636
60 changed files with 482 additions and 482 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/ol/interaction/DragBox.js
View File

@@ -169,7 +169,7 @@ function handleDragEvent(mapBrowserEvent) {
/**
* Returns geometry of last drawn box.
* @return {ol.geom.Polygon} Geometry.
* @return {module:ol/geom/Polygon~Polygon} Geometry.
* @api
*/
DragBox.prototype.getGeometry = function() {

40
src/ol/interaction/Draw.js
View File

@@ -159,10 +159,10 @@ const Draw = function(options) {
/**
* Geometry type.
* @type {ol.geom.GeometryType}
* @type {module:ol/geom/GeometryType~GeometryType}
* @private
*/
this.type_ = /** @type {ol.geom.GeometryType} */ (options.type);
this.type_ = /** @type {module:ol/geom/GeometryType~GeometryType} */ (options.type);
/**
* Drawing mode (derived from geometry type.
@@ -211,11 +211,11 @@ const Draw = function(options) {
/**
* @param {!Array.<module:ol/coordinate~Coordinate>} coordinates
* The coordinates.
* @param {ol.geom.SimpleGeometry=} opt_geometry Optional geometry.
* @return {ol.geom.SimpleGeometry} A geometry.
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry=} opt_geometry Optional geometry.
* @return {module:ol/geom/SimpleGeometry~SimpleGeometry} A geometry.
*/
geometryFunction = function(coordinates, opt_geometry) {
const circle = opt_geometry ? /** @type {ol.geom.Circle} */ (opt_geometry) :
const circle = opt_geometry ? /** @type {module:ol/geom/Circle~Circle} */ (opt_geometry) :
new Circle([NaN, NaN]);
const squaredLength = squaredCoordinateDistance(
coordinates[0], coordinates[1]);
@@ -235,8 +235,8 @@ const Draw = function(options) {
/**
* @param {!Array.<module:ol/coordinate~Coordinate>} coordinates
* The coordinates.
* @param {ol.geom.SimpleGeometry=} opt_geometry Optional geometry.
* @return {ol.geom.SimpleGeometry} A geometry.
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry=} opt_geometry Optional geometry.
* @return {module:ol/geom/SimpleGeometry~SimpleGeometry} A geometry.
*/
geometryFunction = function(coordinates, opt_geometry) {
let geometry = opt_geometry;
@@ -601,7 +601,7 @@ Draw.prototype.createOrUpdateSketchPoint_ = function(event) {
this.sketchPoint_ = new Feature(new Point(coordinates));
this.updateSketchFeatures_();
} else {
const sketchPointGeom = /** @type {ol.geom.Point} */ (this.sketchPoint_.getGeometry());
const sketchPointGeom = /** @type {module:ol/geom/Point~Point} */ (this.sketchPoint_.getGeometry());
sketchPointGeom.setCoordinates(coordinates);
}
};
@@ -645,7 +645,7 @@ Draw.prototype.startDrawing_ = function(event) {
*/
Draw.prototype.modifyDrawing_ = function(event) {
let coordinate = event.coordinate;
const geometry = /** @type {ol.geom.SimpleGeometry} */ (this.sketchFeature_.getGeometry());
const geometry = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let coordinates, last;
if (this.mode_ === Mode.POINT) {
last = this.sketchCoords_;
@@ -664,7 +664,7 @@ Draw.prototype.modifyDrawing_ = function(event) {
last[1] = coordinate[1];
this.geometryFunction_(/** @type {!Array.<module:ol/coordinate~Coordinate>} */ (this.sketchCoords_), geometry);
if (this.sketchPoint_) {
const sketchPointGeom = /** @type {ol.geom.Point} */ (this.sketchPoint_.getGeometry());
const sketchPointGeom = /** @type {module:ol/geom/Point~Point} */ (this.sketchPoint_.getGeometry());
sketchPointGeom.setCoordinates(coordinate);
}
let sketchLineGeom;
@@ -674,11 +674,11 @@ Draw.prototype.modifyDrawing_ = function(event) {
this.sketchLine_ = new Feature(new LineString(null));
}
const ring = geometry.getLinearRing(0);
sketchLineGeom = /** @type {ol.geom.LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom = /** @type {module:ol/geom/LineString~LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom.setFlatCoordinates(
ring.getLayout(), ring.getFlatCoordinates());
} else if (this.sketchLineCoords_) {
sketchLineGeom = /** @type {ol.geom.LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom = /** @type {module:ol/geom/LineString~LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom.setCoordinates(this.sketchLineCoords_);
}
this.updateSketchFeatures_();
@@ -692,7 +692,7 @@ Draw.prototype.modifyDrawing_ = function(event) {
*/
Draw.prototype.addToDrawing_ = function(event) {
const coordinate = event.coordinate;
const geometry = /** @type {ol.geom.SimpleGeometry} */ (this.sketchFeature_.getGeometry());
const geometry = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let done;
let coordinates;
if (this.mode_ === Mode.LINE_STRING) {
@@ -737,7 +737,7 @@ Draw.prototype.removeLastPoint = function() {
if (!this.sketchFeature_) {
return;
}
const geometry = /** @type {ol.geom.SimpleGeometry} */ (this.sketchFeature_.getGeometry());
const geometry = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (this.sketchFeature_.getGeometry());
let coordinates, sketchLineGeom;
if (this.mode_ === Mode.LINE_STRING) {
coordinates = this.sketchCoords_;
@@ -749,7 +749,7 @@ Draw.prototype.removeLastPoint = function() {
} else if (this.mode_ === Mode.POLYGON) {
coordinates = this.sketchCoords_[0];
coordinates.splice(-2, 1);
sketchLineGeom = /** @type {ol.geom.LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom = /** @type {module:ol/geom/LineString~LineString} */ (this.sketchLine_.getGeometry());
sketchLineGeom.setCoordinates(coordinates);
this.geometryFunction_(this.sketchCoords_, geometry);
}
@@ -774,7 +774,7 @@ Draw.prototype.finishDrawing = function() {
return;
}
let coordinates = this.sketchCoords_;
const geometry = /** @type {ol.geom.SimpleGeometry} */ (sketchFeature.getGeometry());
const geometry = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (sketchFeature.getGeometry());
if (this.mode_ === Mode.LINE_STRING) {
// remove the redundant last point
coordinates.pop();
@@ -835,7 +835,7 @@ Draw.prototype.abortDrawing_ = function() {
*/
Draw.prototype.extend = function(feature) {
const geometry = feature.getGeometry();
const lineString = /** @type {ol.geom.LineString} */ (geometry);
const lineString = /** @type {module:ol/geom/LineString~LineString} */ (geometry);
this.sketchFeature_ = feature;
this.sketchCoords_ = lineString.getCoordinates();
const last = this.sketchCoords_[this.sketchCoords_.length - 1];
@@ -889,7 +889,7 @@ Draw.prototype.updateState_ = function() {
/**
* 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
* `ol.geom.Circle` geometry.
* `module:ol/geom/Circle~Circle` geometry.
* @param {number=} opt_sides Number of sides of the regular polygon. Default is
* 32.
* @param {number=} opt_angle Angle of the first point in radians. 0 means East.
@@ -906,7 +906,7 @@ export function createRegularPolygon(opt_sides, opt_angle) {
const end = coordinates[1];
const radius = Math.sqrt(
squaredCoordinateDistance(center, end));
const geometry = opt_geometry ? /** @type {ol.geom.Polygon} */ (opt_geometry) :
const geometry = opt_geometry ? /** @type {module:ol/geom/Polygon~Polygon} */ (opt_geometry) :
fromCircle(new Circle(center), opt_sides);
const angle = opt_angle ? opt_angle :
Math.atan((end[1] - center[1]) / (end[0] - center[0]));
@@ -945,7 +945,7 @@ export function createBox() {
/**
* Get the drawing mode. The mode for mult-part geometries is the same as for
* their single-part cousins.
* @param {ol.geom.GeometryType} type Geometry type.
* @param {module:ol/geom/GeometryType~GeometryType} type Geometry type.
* @return {ol.interaction.Mode} Drawing mode.
*/
function getMode(type) {

2
src/ol/interaction/Extent.js
View File

@@ -419,7 +419,7 @@ ExtentInteraction.prototype.createOrUpdatePointerFeature_ = function(vertex) {
this.vertexFeature_ = vertexFeature;
this.vertexOverlay_.getSource().addFeature(vertexFeature);
} else {
const geometry = /** @type {ol.geom.Point} */ (vertexFeature.getGeometry());
const geometry = /** @type {module:ol/geom/Point~Point} */ (vertexFeature.getGeometry());
geometry.setCoordinates(vertex);
}
return vertexFeature;

28
src/ol/interaction/Modify.js
View File

@@ -223,7 +223,7 @@ const Modify = function(options) {
/**
* @const
* @private
* @type {!Object.<string, function(ol.Feature, ol.geom.Geometry)>}
* @type {!Object.<string, function(ol.Feature, module:ol/geom/Geometry~Geometry)>}
*/
this.SEGMENT_WRITERS_ = {
'Point': this.writePointGeometry_,
@@ -444,7 +444,7 @@ Modify.prototype.handleFeatureRemove_ = function(evt) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.Point} geometry Geometry.
* @param {module:ol/geom/Point~Point} geometry Geometry.
* @private
*/
Modify.prototype.writePointGeometry_ = function(feature, geometry) {
@@ -460,7 +460,7 @@ Modify.prototype.writePointGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.MultiPoint} geometry Geometry.
* @param {module:ol/geom/MultiPoint~MultiPoint} geometry Geometry.
* @private
*/
Modify.prototype.writeMultiPointGeometry_ = function(feature, geometry) {
@@ -481,7 +481,7 @@ Modify.prototype.writeMultiPointGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.LineString} geometry Geometry.
* @param {module:ol/geom/LineString~LineString} geometry Geometry.
* @private
*/
Modify.prototype.writeLineStringGeometry_ = function(feature, geometry) {
@@ -501,7 +501,7 @@ Modify.prototype.writeLineStringGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.MultiLineString} geometry Geometry.
* @param {module:ol/geom/MultiLineString~MultiLineString} geometry Geometry.
* @private
*/
Modify.prototype.writeMultiLineStringGeometry_ = function(feature, geometry) {
@@ -525,7 +525,7 @@ Modify.prototype.writeMultiLineStringGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.Polygon} geometry Geometry.
* @param {module:ol/geom/Polygon~Polygon} geometry Geometry.
* @private
*/
Modify.prototype.writePolygonGeometry_ = function(feature, geometry) {
@@ -549,7 +549,7 @@ Modify.prototype.writePolygonGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.MultiPolygon} geometry Geometry.
* @param {module:ol/geom/MultiPolygon~MultiPolygon} geometry Geometry.
* @private
*/
Modify.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
@@ -582,7 +582,7 @@ Modify.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
* the circumference, and is not a line segment.
*
* @param {ol.Feature} feature Feature.
* @param {ol.geom.Circle} geometry Geometry.
* @param {module:ol/geom/Circle~Circle} geometry Geometry.
* @private
*/
Modify.prototype.writeCircleGeometry_ = function(feature, geometry) {
@@ -608,7 +608,7 @@ Modify.prototype.writeCircleGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.GeometryCollection} geometry Geometry.
* @param {module:ol/geom/GeometryCollection~GeometryCollection} geometry Geometry.
* @private
*/
Modify.prototype.writeGeometryCollectionGeometry_ = function(feature, geometry) {
@@ -631,7 +631,7 @@ Modify.prototype.createOrUpdateVertexFeature_ = function(coordinates) {
this.vertexFeature_ = vertexFeature;
this.overlay_.getSource().addFeature(vertexFeature);
} else {
const geometry = /** @type {ol.geom.Point} */ (vertexFeature.getGeometry());
const geometry = /** @type {module:ol/geom/Point~Point} */ (vertexFeature.getGeometry());
geometry.setCoordinates(coordinates);
}
return vertexFeature;
@@ -664,7 +664,7 @@ function handleDownEvent(evt) {
const vertexFeature = this.vertexFeature_;
if (vertexFeature) {
const insertVertices = [];
const geometry = /** @type {ol.geom.Point} */ (vertexFeature.getGeometry());
const geometry = /** @type {module:ol/geom/Point~Point} */ (vertexFeature.getGeometry());
const vertex = geometry.getCoordinates();
const vertexExtent = boundingExtent([vertex]);
const segmentDataMatches = this.rBush_.getInExtent(vertexExtent);
@@ -956,7 +956,7 @@ function pointDistanceToSegmentDataSquared(pointCoordinates, segmentData) {
const geometry = segmentData.geometry;
if (geometry.getType() === GeometryType.CIRCLE) {
const circleGeometry = /** @type {ol.geom.Circle} */ (geometry);
const circleGeometry = /** @type {module:ol/geom/Circle~Circle} */ (geometry);
if (segmentData.index === CIRCLE_CIRCUMFERENCE_INDEX) {
const distanceToCenterSquared =
@@ -1191,7 +1191,7 @@ Modify.prototype.removeVertex_ = function() {
/**
* @param {ol.geom.SimpleGeometry} geometry Geometry.
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry} geometry Geometry.
* @param {Array} coordinates Coordinates.
* @private
*/
@@ -1203,7 +1203,7 @@ Modify.prototype.setGeometryCoordinates_ = function(geometry, coordinates) {
/**
* @param {ol.geom.SimpleGeometry} geometry Geometry.
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry} geometry Geometry.
* @param {number} index Index.
* @param {Array.<number>|undefined} depth Depth.
* @param {number} delta Delta (1 or -1).

20
src/ol/interaction/Snap.js
View File

@@ -134,7 +134,7 @@ const Snap = function(opt_options) {
/**
* @const
* @private
* @type {Object.<string, function(ol.Feature, ol.geom.Geometry)>}
* @type {Object.<string, function(ol.Feature, module:ol/geom/Geometry~Geometry)>}
*/
this.SEGMENT_WRITERS_ = {
'Point': this.writePointGeometry_,
@@ -383,7 +383,7 @@ Snap.prototype.snapTo = function(pixel, pixelCoordinate, map) {
} else if (this.edge_) {
if (isCircle) {
vertex = closestOnCircle(pixelCoordinate,
/** @type {ol.geom.Circle} */ (segments[0].feature.getGeometry()));
/** @type {module:ol/geom/Circle~Circle} */ (segments[0].feature.getGeometry()));
} else {
vertex = closestOnSegment(pixelCoordinate, closestSegment);
}
@@ -428,7 +428,7 @@ Snap.prototype.updateFeature_ = function(feature) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.Circle} geometry Geometry.
* @param {module:ol/geom/Circle~Circle} geometry Geometry.
* @private
*/
Snap.prototype.writeCircleGeometry_ = function(feature, geometry) {
@@ -447,7 +447,7 @@ Snap.prototype.writeCircleGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.GeometryCollection} geometry Geometry.
* @param {module:ol/geom/GeometryCollection~GeometryCollection} geometry Geometry.
* @private
*/
Snap.prototype.writeGeometryCollectionGeometry_ = function(feature, geometry) {
@@ -463,7 +463,7 @@ Snap.prototype.writeGeometryCollectionGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.LineString} geometry Geometry.
* @param {module:ol/geom/LineString~LineString} geometry Geometry.
* @private
*/
Snap.prototype.writeLineStringGeometry_ = function(feature, geometry) {
@@ -481,7 +481,7 @@ Snap.prototype.writeLineStringGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.MultiLineString} geometry Geometry.
* @param {module:ol/geom/MultiLineString~MultiLineString} geometry Geometry.
* @private
*/
Snap.prototype.writeMultiLineStringGeometry_ = function(feature, geometry) {
@@ -502,7 +502,7 @@ Snap.prototype.writeMultiLineStringGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.MultiPoint} geometry Geometry.
* @param {module:ol/geom/MultiPoint~MultiPoint} geometry Geometry.
* @private
*/
Snap.prototype.writeMultiPointGeometry_ = function(feature, geometry) {
@@ -520,7 +520,7 @@ Snap.prototype.writeMultiPointGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.MultiPolygon} geometry Geometry.
* @param {module:ol/geom/MultiPolygon~MultiPolygon} geometry Geometry.
* @private
*/
Snap.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
@@ -544,7 +544,7 @@ Snap.prototype.writeMultiPolygonGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.Point} geometry Geometry.
* @param {module:ol/geom/Point~Point} geometry Geometry.
* @private
*/
Snap.prototype.writePointGeometry_ = function(feature, geometry) {
@@ -559,7 +559,7 @@ Snap.prototype.writePointGeometry_ = function(feature, geometry) {
/**
* @param {ol.Feature} feature Feature
* @param {ol.geom.Polygon} geometry Geometry.
* @param {module:ol/geom/Polygon~Polygon} geometry Geometry.
* @private
*/
Snap.prototype.writePolygonGeometry_ = function(feature, geometry) {