Module types for ol/geom

2018-03-11 23:08:50 -06:00
parent 41d9a84a8f
commit ef70d71636
60 changed files with 482 additions and 482 deletions
@@ -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) {
@@ -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;
@@ -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) {
@@ -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) {