Module types for ol/geom

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

View File

@@ -15,7 +15,7 @@ import Polygon from '../geom/Polygon.js';
const RenderBox = function(className) {
/**
* @type {ol.geom.Polygon}
* @type {module:ol/geom/Polygon~Polygon}
* @private
*/
this.geometry_ = null;
@@ -126,7 +126,7 @@ RenderBox.prototype.createOrUpdateGeometry = function() {
/**
* @return {ol.geom.Polygon} Geometry.
* @return {module:ol/geom/Polygon~Polygon} Geometry.
*/
RenderBox.prototype.getGeometry = function() {
return this.geometry_;

View File

@@ -12,12 +12,12 @@ import {transform2D} from '../geom/flat/transform.js';
import {create as createTransform, compose as composeTransform} from '../transform.js';
/**
* Lightweight, read-only, {@link ol.Feature} and {@link ol.geom.Geometry} like
* Lightweight, read-only, {@link ol.Feature} and {@link module:ol/geom/Geometry~Geometry} like
* structure, optimized for vector tile rendering and styling. Geometry access
* through the API is limited to getting the type and extent of the geometry.
*
* @constructor
* @param {ol.geom.GeometryType} type Geometry type.
* @param {module:ol/geom/GeometryType~GeometryType} type Geometry type.
* @param {Array.<number>} flatCoordinates Flat coordinates. These always need
* to be right-handed for polygons.
* @param {Array.<number>|Array.<Array.<number>>} ends Ends or Endss.
@@ -39,7 +39,7 @@ const RenderFeature = function(type, flatCoordinates, ends, properties, id) {
/**
* @private
* @type {ol.geom.GeometryType}
* @type {module:ol/geom/GeometryType~GeometryType}
*/
this.type_ = type;
@@ -249,7 +249,7 @@ RenderFeature.prototype.getStyleFunction = UNDEFINED;
/**
* Get the type of this feature's geometry.
* @return {ol.geom.GeometryType} Geometry type.
* @return {module:ol/geom/GeometryType~GeometryType} Geometry type.
* @api
*/
RenderFeature.prototype.getType = function() {

View File

@@ -16,7 +16,7 @@ const VectorContext = function() {
/**
* Render a geometry with a custom renderer.
*
* @param {ol.geom.SimpleGeometry} geometry Geometry.
* @param {module:ol/geom/SimpleGeometry~SimpleGeometry} geometry Geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
* @param {Function} renderer Renderer.
*/
@@ -26,7 +26,7 @@ VectorContext.prototype.drawCustom = function(geometry, feature, renderer) {};
/**
* Render a geometry.
*
* @param {ol.geom.Geometry} geometry The geometry to render.
* @param {module:ol/geom/Geometry~Geometry} geometry The geometry to render.
*/
VectorContext.prototype.drawGeometry = function(geometry) {};
@@ -40,7 +40,7 @@ VectorContext.prototype.setStyle = function(style) {};
/**
* @param {ol.geom.Circle} circleGeometry Circle geometry.
* @param {module:ol/geom/Circle~Circle} circleGeometry Circle geometry.
* @param {ol.Feature} feature Feature.
*/
VectorContext.prototype.drawCircle = function(circleGeometry, feature) {};
@@ -54,7 +54,7 @@ VectorContext.prototype.drawFeature = function(feature, style) {};
/**
* @param {ol.geom.GeometryCollection} geometryCollectionGeometry Geometry
* @param {module:ol/geom/GeometryCollection~GeometryCollection} geometryCollectionGeometry Geometry
* collection.
* @param {ol.Feature} feature Feature.
*/
@@ -62,7 +62,7 @@ VectorContext.prototype.drawGeometryCollection = function(geometryCollectionGeom
/**
* @param {ol.geom.LineString|ol.render.Feature} lineStringGeometry Line
* @param {module:ol/geom/LineString~LineString|ol.render.Feature} lineStringGeometry Line
* string geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
@@ -70,7 +70,7 @@ VectorContext.prototype.drawLineString = function(lineStringGeometry, feature) {
/**
* @param {ol.geom.MultiLineString|ol.render.Feature} multiLineStringGeometry
* @param {module:ol/geom/MultiLineString~MultiLineString|ol.render.Feature} multiLineStringGeometry
* MultiLineString geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
@@ -78,7 +78,7 @@ VectorContext.prototype.drawMultiLineString = function(multiLineStringGeometry,
/**
* @param {ol.geom.MultiPoint|ol.render.Feature} multiPointGeometry MultiPoint
* @param {module:ol/geom/MultiPoint~MultiPoint|ol.render.Feature} multiPointGeometry MultiPoint
* geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
@@ -86,21 +86,21 @@ VectorContext.prototype.drawMultiPoint = function(multiPointGeometry, feature) {
/**
* @param {ol.geom.MultiPolygon} multiPolygonGeometry MultiPolygon geometry.
* @param {module:ol/geom/MultiPolygon~MultiPolygon} multiPolygonGeometry MultiPolygon geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
VectorContext.prototype.drawMultiPolygon = function(multiPolygonGeometry, feature) {};
/**
* @param {ol.geom.Point|ol.render.Feature} pointGeometry Point geometry.
* @param {module:ol/geom/Point~Point|ol.render.Feature} pointGeometry Point geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
VectorContext.prototype.drawPoint = function(pointGeometry, feature) {};
/**
* @param {ol.geom.Polygon|ol.render.Feature} polygonGeometry Polygon
* @param {module:ol/geom/Polygon~Polygon|ol.render.Feature} polygonGeometry Polygon
* geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
@@ -108,7 +108,7 @@ VectorContext.prototype.drawPolygon = function(polygonGeometry, feature) {};
/**
* @param {ol.geom.Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
VectorContext.prototype.drawText = function(geometry, feature) {};

View File

@@ -394,7 +394,7 @@ CanvasImmediateRenderer.prototype.drawRings_ = function(flatCoordinates, offset,
* Render a circle geometry into the canvas. Rendering is immediate and uses
* the current fill and stroke styles.
*
* @param {ol.geom.Circle} geometry Circle geometry.
* @param {module:ol/geom/Circle~Circle} geometry Circle geometry.
* @override
* @api
*/
@@ -450,7 +450,7 @@ CanvasImmediateRenderer.prototype.setStyle = function(style) {
* Render a geometry into the canvas. Call
* {@link ol.render.canvas.Immediate#setStyle} first to set the rendering style.
*
* @param {ol.geom.Geometry|ol.render.Feature} geometry The geometry to render.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry The geometry to render.
* @override
* @api
*/
@@ -458,28 +458,28 @@ CanvasImmediateRenderer.prototype.drawGeometry = function(geometry) {
const type = geometry.getType();
switch (type) {
case GeometryType.POINT:
this.drawPoint(/** @type {ol.geom.Point} */ (geometry));
this.drawPoint(/** @type {module:ol/geom/Point~Point} */ (geometry));
break;
case GeometryType.LINE_STRING:
this.drawLineString(/** @type {ol.geom.LineString} */ (geometry));
this.drawLineString(/** @type {module:ol/geom/LineString~LineString} */ (geometry));
break;
case GeometryType.POLYGON:
this.drawPolygon(/** @type {ol.geom.Polygon} */ (geometry));
this.drawPolygon(/** @type {module:ol/geom/Polygon~Polygon} */ (geometry));
break;
case GeometryType.MULTI_POINT:
this.drawMultiPoint(/** @type {ol.geom.MultiPoint} */ (geometry));
this.drawMultiPoint(/** @type {module:ol/geom/MultiPoint~MultiPoint} */ (geometry));
break;
case GeometryType.MULTI_LINE_STRING:
this.drawMultiLineString(/** @type {ol.geom.MultiLineString} */ (geometry));
this.drawMultiLineString(/** @type {module:ol/geom/MultiLineString~MultiLineString} */ (geometry));
break;
case GeometryType.MULTI_POLYGON:
this.drawMultiPolygon(/** @type {ol.geom.MultiPolygon} */ (geometry));
this.drawMultiPolygon(/** @type {module:ol/geom/MultiPolygon~MultiPolygon} */ (geometry));
break;
case GeometryType.GEOMETRY_COLLECTION:
this.drawGeometryCollection(/** @type {ol.geom.GeometryCollection} */ (geometry));
this.drawGeometryCollection(/** @type {module:ol/geom/GeometryCollection~GeometryCollection} */ (geometry));
break;
case GeometryType.CIRCLE:
this.drawCircle(/** @type {ol.geom.Circle} */ (geometry));
this.drawCircle(/** @type {module:ol/geom/Circle~Circle} */ (geometry));
break;
default:
}
@@ -511,7 +511,7 @@ CanvasImmediateRenderer.prototype.drawFeature = function(feature, style) {
* Render a GeometryCollection to the canvas. Rendering is immediate and
* uses the current styles appropriate for each geometry in the collection.
*
* @param {ol.geom.GeometryCollection} geometry Geometry collection.
* @param {module:ol/geom/GeometryCollection~GeometryCollection} geometry Geometry collection.
* @override
*/
CanvasImmediateRenderer.prototype.drawGeometryCollection = function(geometry) {
@@ -526,7 +526,7 @@ CanvasImmediateRenderer.prototype.drawGeometryCollection = function(geometry) {
* Render a Point geometry into the canvas. Rendering is immediate and uses
* the current style.
*
* @param {ol.geom.Point|ol.render.Feature} geometry Point geometry.
* @param {module:ol/geom/Point~Point|ol.render.Feature} geometry Point geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawPoint = function(geometry) {
@@ -545,7 +545,7 @@ CanvasImmediateRenderer.prototype.drawPoint = function(geometry) {
* Render a MultiPoint geometry into the canvas. Rendering is immediate and
* uses the current style.
*
* @param {ol.geom.MultiPoint|ol.render.Feature} geometry MultiPoint geometry.
* @param {module:ol/geom/MultiPoint~MultiPoint|ol.render.Feature} geometry MultiPoint geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawMultiPoint = function(geometry) {
@@ -564,7 +564,7 @@ CanvasImmediateRenderer.prototype.drawMultiPoint = function(geometry) {
* Render a LineString into the canvas. Rendering is immediate and uses
* the current style.
*
* @param {ol.geom.LineString|ol.render.Feature} geometry LineString geometry.
* @param {module:ol/geom/LineString~LineString|ol.render.Feature} geometry LineString geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawLineString = function(geometry) {
@@ -591,7 +591,7 @@ CanvasImmediateRenderer.prototype.drawLineString = function(geometry) {
* Render a MultiLineString geometry into the canvas. Rendering is immediate
* and uses the current style.
*
* @param {ol.geom.MultiLineString|ol.render.Feature} geometry MultiLineString
* @param {module:ol/geom/MultiLineString~MultiLineString|ol.render.Feature} geometry MultiLineString
* geometry.
* @override
*/
@@ -624,7 +624,7 @@ CanvasImmediateRenderer.prototype.drawMultiLineString = function(geometry) {
* Render a Polygon geometry into the canvas. Rendering is immediate and uses
* the current style.
*
* @param {ol.geom.Polygon|ol.render.Feature} geometry Polygon geometry.
* @param {module:ol/geom/Polygon~Polygon|ol.render.Feature} geometry Polygon geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawPolygon = function(geometry) {
@@ -659,7 +659,7 @@ CanvasImmediateRenderer.prototype.drawPolygon = function(geometry) {
/**
* Render MultiPolygon geometry into the canvas. Rendering is immediate and
* uses the current style.
* @param {ol.geom.MultiPolygon} geometry MultiPolygon geometry.
* @param {module:ol/geom/MultiPolygon~MultiPolygon} geometry MultiPolygon geometry.
* @override
*/
CanvasImmediateRenderer.prototype.drawMultiPolygon = function(geometry) {

View File

@@ -201,7 +201,7 @@ CanvasPolygonReplay.prototype.finish = function() {
/**
* @private
* @param {ol.geom.Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
*/
CanvasPolygonReplay.prototype.setFillStrokeStyles_ = function(geometry) {
const state = this.state;

View File

@@ -407,7 +407,7 @@ CanvasReplay.prototype.drawCustom = function(geometry, feature, renderer) {
let flatCoordinates, replayEnd, replayEnds, replayEndss;
let offset;
if (type == GeometryType.MULTI_POLYGON) {
geometry = /** @type {ol.geom.MultiPolygon} */ (geometry);
geometry = /** @type {module:ol/geom/MultiPolygon~MultiPolygon} */ (geometry);
flatCoordinates = geometry.getOrientedFlatCoordinates();
replayEndss = [];
const endss = geometry.getEndss();
@@ -422,10 +422,10 @@ CanvasReplay.prototype.drawCustom = function(geometry, feature, renderer) {
} else if (type == GeometryType.POLYGON || type == GeometryType.MULTI_LINE_STRING) {
replayEnds = [];
flatCoordinates = (type == GeometryType.POLYGON) ?
/** @type {ol.geom.Polygon} */ (geometry).getOrientedFlatCoordinates() :
/** @type {module:ol/geom/Polygon~Polygon} */ (geometry).getOrientedFlatCoordinates() :
geometry.getFlatCoordinates();
offset = this.drawCustomCoordinates_(flatCoordinates, 0,
/** @type {ol.geom.Polygon|ol.geom.MultiLineString} */ (geometry).getEnds(),
/** @type {module:ol/geom/Polygon~Polygon|module:ol/geom/MultiLineString~MultiLineString} */ (geometry).getEnds(),
stride, replayEnds);
this.instructions.push([CanvasInstruction.CUSTOM,
replayBegin, replayEnds, geometry, renderer, inflateCoordinatesArray]);
@@ -448,7 +448,7 @@ CanvasReplay.prototype.drawCustom = function(geometry, feature, renderer) {
/**
* @protected
* @param {ol.geom.Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
CanvasReplay.prototype.beginGeometry = function(geometry, feature) {
@@ -638,7 +638,7 @@ CanvasReplay.prototype.replay_ = function(
case CanvasInstruction.CUSTOM:
d = /** @type {number} */ (instruction[1]);
dd = instruction[2];
const geometry = /** @type {ol.geom.SimpleGeometry} */ (instruction[3]);
const geometry = /** @type {module:ol/geom/SimpleGeometry~SimpleGeometry} */ (instruction[3]);
const renderer = instruction[4];
const fn = instruction.length == 6 ? instruction[5] : undefined;
state.geometry = geometry;
@@ -967,7 +967,7 @@ CanvasReplay.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) {
/**
* @param {ol.CanvasFillStrokeState} state State.
* @param {ol.geom.Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @return {Array.<*>} Fill instruction.
*/
CanvasReplay.prototype.createFill = function(state, geometry) {
@@ -1005,8 +1005,8 @@ CanvasReplay.prototype.createStroke = function(state) {
/**
* @param {ol.CanvasFillStrokeState} state State.
* @param {function(this:ol.render.canvas.Replay, ol.CanvasFillStrokeState, (ol.geom.Geometry|ol.render.Feature)):Array.<*>} createFill Create fill.
* @param {ol.geom.Geometry|ol.render.Feature} geometry Geometry.
* @param {function(this:ol.render.canvas.Replay, ol.CanvasFillStrokeState, (module:ol/geom/Geometry~Geometry|ol.render.Feature)):Array.<*>} createFill Create fill.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
*/
CanvasReplay.prototype.updateFillStyle = function(state, createFill, geometry) {
const fillStyle = state.fillStyle;
@@ -1053,7 +1053,7 @@ CanvasReplay.prototype.updateStrokeStyle = function(state, applyStroke) {
/**
* @param {ol.geom.Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature.
*/
CanvasReplay.prototype.endGeometry = function(geometry, feature) {

View File

@@ -226,24 +226,24 @@ CanvasTextReplay.prototype.drawText = function(geometry, feature) {
end = flatCoordinates.length;
break;
case GeometryType.LINE_STRING:
flatCoordinates = /** @type {ol.geom.LineString} */ (geometry).getFlatMidpoint();
flatCoordinates = /** @type {module:ol/geom/LineString~LineString} */ (geometry).getFlatMidpoint();
break;
case GeometryType.CIRCLE:
flatCoordinates = /** @type {ol.geom.Circle} */ (geometry).getCenter();
flatCoordinates = /** @type {module:ol/geom/Circle~Circle} */ (geometry).getCenter();
break;
case GeometryType.MULTI_LINE_STRING:
flatCoordinates = /** @type {ol.geom.MultiLineString} */ (geometry).getFlatMidpoints();
flatCoordinates = /** @type {module:ol/geom/MultiLineString~MultiLineString} */ (geometry).getFlatMidpoints();
end = flatCoordinates.length;
break;
case GeometryType.POLYGON:
flatCoordinates = /** @type {ol.geom.Polygon} */ (geometry).getFlatInteriorPoint();
flatCoordinates = /** @type {module:ol/geom/Polygon~Polygon} */ (geometry).getFlatInteriorPoint();
if (!textState.overflow && flatCoordinates[2] / this.resolution < width) {
return;
}
stride = 3;
break;
case GeometryType.MULTI_POLYGON:
const interiorPoints = /** @type {ol.geom.MultiPolygon} */ (geometry).getFlatInteriorPoints();
const interiorPoints = /** @type {module:ol/geom/MultiPolygon~MultiPolygon} */ (geometry).getFlatInteriorPoints();
flatCoordinates = [];
for (i = 0, ii = interiorPoints.length; i < ii; i += 3) {
if (textState.overflow || interiorPoints[i + 2] / this.resolution >= width) {

View File

@@ -89,7 +89,7 @@ inherits(WebGLImmediateRenderer, VectorContext);
/**
* @param {ol.render.webgl.ReplayGroup} replayGroup Replay group.
* @param {ol.geom.Geometry|ol.render.Feature} geometry Geometry.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry Geometry.
* @private
*/
WebGLImmediateRenderer.prototype.drawText_ = function(replayGroup, geometry) {
@@ -130,7 +130,7 @@ WebGLImmediateRenderer.prototype.setStyle = function(style) {
* Render a geometry into the canvas. Call
* {@link ol.render.webgl.Immediate#setStyle} first to set the rendering style.
*
* @param {ol.geom.Geometry|ol.render.Feature} geometry The geometry to render.
* @param {module:ol/geom/Geometry~Geometry|ol.render.Feature} geometry The geometry to render.
* @override
* @api
*/
@@ -138,28 +138,28 @@ WebGLImmediateRenderer.prototype.drawGeometry = function(geometry) {
const type = geometry.getType();
switch (type) {
case GeometryType.POINT:
this.drawPoint(/** @type {ol.geom.Point} */ (geometry), null);
this.drawPoint(/** @type {module:ol/geom/Point~Point} */ (geometry), null);
break;
case GeometryType.LINE_STRING:
this.drawLineString(/** @type {ol.geom.LineString} */ (geometry), null);
this.drawLineString(/** @type {module:ol/geom/LineString~LineString} */ (geometry), null);
break;
case GeometryType.POLYGON:
this.drawPolygon(/** @type {ol.geom.Polygon} */ (geometry), null);
this.drawPolygon(/** @type {module:ol/geom/Polygon~Polygon} */ (geometry), null);
break;
case GeometryType.MULTI_POINT:
this.drawMultiPoint(/** @type {ol.geom.MultiPoint} */ (geometry), null);
this.drawMultiPoint(/** @type {module:ol/geom/MultiPoint~MultiPoint} */ (geometry), null);
break;
case GeometryType.MULTI_LINE_STRING:
this.drawMultiLineString(/** @type {ol.geom.MultiLineString} */ (geometry), null);
this.drawMultiLineString(/** @type {module:ol/geom/MultiLineString~MultiLineString} */ (geometry), null);
break;
case GeometryType.MULTI_POLYGON:
this.drawMultiPolygon(/** @type {ol.geom.MultiPolygon} */ (geometry), null);
this.drawMultiPolygon(/** @type {module:ol/geom/MultiPolygon~MultiPolygon} */ (geometry), null);
break;
case GeometryType.GEOMETRY_COLLECTION:
this.drawGeometryCollection(/** @type {ol.geom.GeometryCollection} */ (geometry), null);
this.drawGeometryCollection(/** @type {module:ol/geom/GeometryCollection~GeometryCollection} */ (geometry), null);
break;
case GeometryType.CIRCLE:
this.drawCircle(/** @type {ol.geom.Circle} */ (geometry), null);
this.drawCircle(/** @type {module:ol/geom/Circle~Circle} */ (geometry), null);
break;
default:
// pass

View File

@@ -136,20 +136,20 @@ WebGLTextReplay.prototype.drawText = function(geometry, feature) {
stride = geometry.getStride();
break;
case GeometryType.CIRCLE:
flatCoordinates = /** @type {ol.geom.Circle} */ (geometry).getCenter();
flatCoordinates = /** @type {module:ol/geom/Circle~Circle} */ (geometry).getCenter();
break;
case GeometryType.LINE_STRING:
flatCoordinates = /** @type {ol.geom.LineString} */ (geometry).getFlatMidpoint();
flatCoordinates = /** @type {module:ol/geom/LineString~LineString} */ (geometry).getFlatMidpoint();
break;
case GeometryType.MULTI_LINE_STRING:
flatCoordinates = /** @type {ol.geom.MultiLineString} */ (geometry).getFlatMidpoints();
flatCoordinates = /** @type {module:ol/geom/MultiLineString~MultiLineString} */ (geometry).getFlatMidpoints();
end = flatCoordinates.length;
break;
case GeometryType.POLYGON:
flatCoordinates = /** @type {ol.geom.Polygon} */ (geometry).getFlatInteriorPoint();
flatCoordinates = /** @type {module:ol/geom/Polygon~Polygon} */ (geometry).getFlatInteriorPoint();
break;
case GeometryType.MULTI_POLYGON:
flatCoordinates = /** @type {ol.geom.MultiPolygon} */ (geometry).getFlatInteriorPoints();
flatCoordinates = /** @type {module:ol/geom/MultiPolygon~MultiPolygon} */ (geometry).getFlatInteriorPoints();
end = flatCoordinates.length;
break;
default: