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

Merge pull request #13905 from MoonE/replace-enums

Browse Source 
Replace enums with typedefs
This commit is contained in:
MoonE
2022-07-30 18:12:34 +02:00
committed by GitHub
parent b10dc3bf83 14c2c31d4c
commit e17640c95a
24 changed files with 83 additions and 177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/ol/View.js
View File

@@ -2,7 +2,6 @@
* @module ol/View
*/
import BaseObject from './Object.js';
import Units from './proj/Units.js';
import ViewHint from './ViewHint.js';
import ViewProperty from './ViewProperty.js';
import {DEFAULT_TILE_SIZE} from './tilegrid/common.js';
@@ -2008,7 +2007,7 @@ export function createResolutionConstraint(options) {
// calculate the default min and max resolution
const size = !projExtent
? // use an extent that can fit the whole world if need be
(360 * METERS_PER_UNIT[Units.DEGREES]) / projection.getMetersPerUnit()
(360 * METERS_PER_UNIT.degrees) / projection.getMetersPerUnit()
: Math.max(getWidth(projExtent), getHeight(projExtent));
const defaultMaxResolution =

8
src/ol/control/ScaleLine.js
View File

@@ -2,7 +2,6 @@
* @module ol/control/ScaleLine
*/
import Control from './Control.js';
import ProjUnits from '../proj/Units.js';
import {CLASS_UNSELECTABLE} from '../css.js';
import {METERS_PER_UNIT, getPointResolution} from '../proj.js';
import {assert} from '../asserts.js';
@@ -237,8 +236,7 @@ class ScaleLine extends Control {
const center = viewState.center;
const projection = viewState.projection;
const units = this.getUnits();
const pointResolutionUnits =
units == 'degrees' ? ProjUnits.DEGREES : ProjUnits.METERS;
const pointResolutionUnits = units == 'degrees' ? 'degrees' : 'm';
let pointResolution = getPointResolution(
projection,
viewState.resolution,
@@ -257,7 +255,7 @@ class ScaleLine extends Control {
let nominalCount = minWidth * pointResolution;
let suffix = '';
if (units == 'degrees') {
const metersPerDegree = METERS_PER_UNIT[ProjUnits.DEGREES];
const metersPerDegree = METERS_PER_UNIT.degrees;
nominalCount *= metersPerDegree;
if (nominalCount < metersPerDegree / 60) {
suffix = '\u2033'; // seconds
@@ -498,7 +496,7 @@ class ScaleLine extends Control {
this.viewState_.projection,
this.viewState_.resolution,
this.viewState_.center,
ProjUnits.METERS
'm'
);
const dpi = this.dpi_ || DEFAULT_DPI;
const inchesPerMeter = 1000 / 25.4;

3
src/ol/format/Feature.js
View File

@@ -1,7 +1,6 @@
/**
* @module ol/format/Feature
*/
import Units from '../proj/Units.js';
import {abstract} from '../util.js';
import {
equivalent as equivalentProjection,
@@ -103,7 +102,7 @@ class FeatureFormat {
if (
opt_options.extent &&
dataProjection &&
dataProjection.getUnits() === Units.TILE_PIXELS
dataProjection.getUnits() === 'tile-pixels'
) {
dataProjection = getProjection(dataProjection);
dataProjection.setWorldExtent(opt_options.extent);

3
src/ol/format/MVT.js
View File

@@ -13,7 +13,6 @@ import Point from '../geom/Point.js';
import Polygon from '../geom/Polygon.js';
import Projection from '../proj/Projection.js';
import RenderFeature from '../render/Feature.js';
import Units from '../proj/Units.js';
import {assert} from '../asserts.js';
import {get} from '../proj.js';
import {inflateEnds} from '../geom/flat/orient.js';
@@ -52,7 +51,7 @@ class MVT extends FeatureFormat {
*/
this.dataProjection = new Projection({
code: '',
units: Units.TILE_PIXELS,
units: 'tile-pixels',
});
/**

3
src/ol/geom/Geometry.js
View File

@@ -2,7 +2,6 @@
* @module ol/geom/Geometry
*/
import BaseObject from '../Object.js';
import Units from '../proj/Units.js';
import {abstract} from '../util.js';
import {
compose as composeTransform,
@@ -310,7 +309,7 @@ class Geometry extends BaseObject {
/** @type {import("../proj/Projection.js").default} */
const sourceProj = getProjection(source);
const transformFn =
sourceProj.getUnits() == Units.TILE_PIXELS
sourceProj.getUnits() == 'tile-pixels'
? function (inCoordinates, outCoordinates, stride) {
const pixelExtent = sourceProj.getExtent();
const projectedExtent = sourceProj.getWorldExtent();

10
src/ol/interaction/MouseWheelZoom.js
View File

@@ -8,12 +8,8 @@ import {all, always, focusWithTabindex} from '../events/condition.js';
import {clamp} from '../math.js';
/**
* @enum {string}
* @typedef {'trackpad' | 'wheel'} Mode
*/
export const Mode = {
TRACKPAD: 'trackpad',
WHEEL: 'wheel',
};
/**
* @typedef {Object} Options
@@ -218,12 +214,12 @@ class MouseWheelZoom extends Interaction {
}
if (!this.mode_ || now - this.startTime_ > this.trackpadEventGap_) {
this.mode_ = Math.abs(delta) < 4 ? Mode.TRACKPAD : Mode.WHEEL;
this.mode_ = Math.abs(delta) < 4 ? 'trackpad' : 'wheel';
}
const view = map.getView();
if (
this.mode_ === Mode.TRACKPAD &&
this.mode_ === 'trackpad' &&
!(view.getConstrainResolution() || this.constrainResolution_)
) {
if (this.trackpadTimeoutId_) {

2
src/ol/layer/MapboxVector.js
View File

@@ -81,7 +81,7 @@ class ErrorEvent extends BaseEvent {
* Recommended value: Vector tiles are usually generated with a buffer, so this value should match
* the largest possible buffer of the used tiles. It should be at least the size of the largest
* point symbol or line width.
* @property {import("./VectorTileRenderType.js").default|string} [renderMode='hybrid'] Render mode for vector tiles:
* @property {import("./VectorTile.js").VectorTileRenderType} [renderMode='hybrid'] Render mode for vector tiles:
* * `'hybrid'`: Polygon and line elements are rendered as images, so pixels are scaled during zoom
* animations. Point symbols and texts are accurately rendered as vectors and can stay upright on
* rotated views.

26
src/ol/layer/VectorTile.js
View File

@@ -4,7 +4,6 @@
import BaseVectorLayer from './BaseVector.js';
import CanvasVectorTileLayerRenderer from '../renderer/canvas/VectorTileLayer.js';
import TileProperty from './TileProperty.js';
import VectorTileRenderType from './VectorTileRenderType.js';
import {assert} from '../asserts.js';
/***
@@ -17,6 +16,10 @@ import {assert} from '../asserts.js';
* 'change:source'|'change:preload'|'change:useInterimTilesOnError'|import("../render/EventType").LayerRenderEventTypes, Return>} VectorTileLayerOnSignature
*/
/**
* @typedef {'hybrid' | 'vector'} VectorTileRenderType
*/
/**
* @typedef {Object} Options
* @property {string} [className='ol-layer'] A CSS class name to set to the layer element.
@@ -44,7 +47,7 @@ import {assert} from '../asserts.js';
* Recommended value: Vector tiles are usually generated with a buffer, so this value should match
* the largest possible buffer of the used tiles. It should be at least the size of the largest
* point symbol or line width.
* @property {import("./VectorTileRenderType.js").default|string} [renderMode='hybrid'] Render mode for vector tiles:
* @property {VectorTileRenderType} [renderMode='hybrid'] Render mode for vector tiles:
* * `'hybrid'`: Polygon and line elements are rendered as images, so pixels are scaled during zoom
* animations. Point symbols and texts are accurately rendered as vectors and can stay upright on
* rotated views.
@@ -126,22 +129,13 @@ class VectorTileLayer extends BaseVectorLayer {
*/
this.un;
if (options.renderMode === VectorTileRenderType.IMAGE) {
//FIXME deprecated - remove this check in v7.
//eslint-disable-next-line
console.warn('renderMode: "image" is deprecated. Option ignored.')
options.renderMode = undefined;
}
const renderMode = options.renderMode || VectorTileRenderType.HYBRID;
assert(
renderMode == VectorTileRenderType.HYBRID ||
renderMode == VectorTileRenderType.VECTOR,
28
); // `renderMode` must be `'hybrid'` or `'vector'`.
const renderMode = options.renderMode || 'hybrid';
// `renderMode` must be `'hybrid'` or `'vector'`.
assert(renderMode == 'hybrid' || renderMode == 'vector', 28);
/**
* @private
* @type {import("./VectorTileRenderType.js").default}
* @type {VectorTileRenderType}
*/
this.renderMode_ = renderMode;
@@ -190,7 +184,7 @@ class VectorTileLayer extends BaseVectorLayer {
}
/**
* @return {import("./VectorTileRenderType.js").default} The render mode.
* @return {VectorTileRenderType} The render mode.
*/
getRenderMode() {
return this.renderMode_;

34
src/ol/layer/VectorTileRenderType.js
View File

@@ -1,34 +0,0 @@
/**
* @module ol/layer/VectorTileRenderType
*/
/**
* @enum {string}
* Render mode for vector tiles:
* @api
*/
export default {
/**
* Vector tiles are rendered as images. Great performance, but
* point symbols and texts are always rotated with the view and pixels are
* scaled during zoom animations
* @api
* @deprecated
*/
IMAGE: 'image',
/**
* Polygon and line elements are rendered as images, so pixels
* are scaled during zoom animations. Point symbols and texts are accurately
* rendered as vectors and can stay upright on rotated views.
* @api
*/
HYBRID: 'hybrid',
/**
* Everything is rendered as vectors. Use this mode for improved
* performance on vector tile layers with only a few rendered features (e.g.
* for highlighting a subset of features of another layer with the same
* source).
* @api
*/
VECTOR: 'vector',
};

8
src/ol/proj.js
View File

@@ -54,13 +54,13 @@
* this.
*/
import Projection from './proj/Projection.js';
import Units, {METERS_PER_UNIT} from './proj/Units.js';
import {
PROJECTIONS as EPSG3857_PROJECTIONS,
fromEPSG4326,
toEPSG4326,
} from './proj/epsg3857.js';
import {PROJECTIONS as EPSG4326_PROJECTIONS} from './proj/epsg4326.js';
import {METERS_PER_UNIT} from './proj/Units.js';
import {
add as addProj,
clear as clearProj,
@@ -192,7 +192,7 @@ export function get(projectionLike) {
* @param {ProjectionLike} projection The projection.
* @param {number} resolution Nominal resolution in projection units.
* @param {import("./coordinate.js").Coordinate} point Point to find adjusted resolution at.
* @param {import("./proj/Units.js").default} [opt_units] Units to get the point resolution in.
* @param {import("./proj/Units.js").Units} [opt_units] Units to get the point resolution in.
* Default is the projection's units.
* @return {number} Point resolution.
* @api
@@ -212,7 +212,7 @@ export function getPointResolution(projection, resolution, point, opt_units) {
}
} else {
const units = projection.getUnits();
if ((units == Units.DEGREES && !opt_units) || opt_units == Units.DEGREES) {
if ((units == 'degrees' && !opt_units) || opt_units == 'degrees') {
pointResolution = resolution;
} else {
// Estimate point resolution by transforming the center pixel to EPSG:4326,
@@ -222,7 +222,7 @@ export function getPointResolution(projection, resolution, point, opt_units) {
projection,
get('EPSG:4326')
);
if (toEPSG4326 === identityTransform && units !== Units.DEGREES) {
if (toEPSG4326 === identityTransform && units !== 'degrees') {
// no transform is available
pointResolution = resolution * projection.getMetersPerUnit();
} else {

10
src/ol/proj/Projection.js
View File

@@ -6,13 +6,13 @@ import {METERS_PER_UNIT} from './Units.js';
/**
* @typedef {Object} Options
* @property {string} code The SRS identifier code, e.g. `EPSG:4326`.
* @property {import("./Units.js").default|string} [units] Units. Required unless a
* @property {import("./Units.js").Units} [units] Units. Required unless a
* proj4 projection is defined for `code`.
* @property {import("../extent.js").Extent} [extent] The validity extent for the SRS.
* @property {string} [axisOrientation='enu'] The axis orientation as specified in Proj4.
* @property {boolean} [global=false] Whether the projection is valid for the whole globe.
* @property {number} [metersPerUnit] The meters per unit for the SRS.
* If not provided, the `units` are used to get the meters per unit from the {@link module:ol/proj/Units~METERS_PER_UNIT}
* If not provided, the `units` are used to get the meters per unit from the {@link METERS_PER_UNIT}
* lookup table.
* @property {import("../extent.js").Extent} [worldExtent] The world extent for the SRS.
* @property {function(number, import("../coordinate.js").Coordinate):number} [getPointResolution]
@@ -65,9 +65,9 @@ class Projection {
* `this.extent_` and `this.worldExtent_` must be configured properly for each
* tile.
* @private
* @type {import("./Units.js").default}
* @type {import("./Units.js").Units}
*/
this.units_ = /** @type {import("./Units.js").default} */ (options.units);
this.units_ = /** @type {import("./Units.js").Units} */ (options.units);
/**
* Validity extent of the projection in projected coordinates. For projections
@@ -153,7 +153,7 @@ class Projection {
/**
* Get the units of this projection.
* @return {import("./Units.js").default} Units.
* @return {import("./Units.js").Units} Units.
* @api
*/
getUnits() {

80
src/ol/proj/Units.js
View File

@@ -3,58 +3,20 @@
*/
/**
* Projection units: `'degrees'`, `'ft'`, `'m'`, `'pixels'`, `'tile-pixels'` or
* `'us-ft'`.
* @enum {string}
* @typedef {'radians' | 'degrees' | 'ft' | 'm' | 'pixels' | 'tile-pixels' | 'us-ft'} Units
* Projection units.
*/
const Units = {
/**
* Radians
* @api
*/
RADIANS: 'radians',
/**
* Degrees
* @api
*/
DEGREES: 'degrees',
/**
* Feet
* @api
*/
FEET: 'ft',
/**
* Meters
* @api
*/
METERS: 'm',
/**
* Pixels
* @api
*/
PIXELS: 'pixels',
/**
* Tile Pixels
* @api
*/
TILE_PIXELS: 'tile-pixels',
/**
* US Feet
* @api
*/
USFEET: 'us-ft',
};
/**
* See http://duff.ess.washington.edu/data/raster/drg/docs/geotiff.txt
* @type {Object<number, Units>}
*/
const unitByCode = {
'9001': Units.METERS,
'9002': Units.FEET,
'9003': Units.USFEET,
'9101': Units.RADIANS,
'9102': Units.DEGREES,
'9001': 'm',
'9002': 'ft',
'9003': 'us-ft',
'9101': 'radians',
'9102': 'degrees',
};
/**
@@ -65,18 +27,26 @@ export function fromCode(code) {
return unitByCode[code];
}
/**
* @typedef {Object} MetersPerUnitLookup
* @property {number} radians Radians
* @property {number} degrees Degrees
* @property {number} ft Feet
* @property {number} m Meters
* @property {number} us-ft US feet
*/
/**
* Meters per unit lookup table.
* @const
* @type {Object<Units, number>}
* @type {MetersPerUnitLookup}
* @api
*/
export const METERS_PER_UNIT = {};
// use the radius of the Normal sphere
METERS_PER_UNIT[Units.RADIANS] = 6370997 / (2 * Math.PI);
METERS_PER_UNIT[Units.DEGREES] = (2 * Math.PI * 6370997) / 360;
METERS_PER_UNIT[Units.FEET] = 0.3048;
METERS_PER_UNIT[Units.METERS] = 1;
METERS_PER_UNIT[Units.USFEET] = 1200 / 3937;
export default Units;
export const METERS_PER_UNIT = {
// use the radius of the Normal sphere
'radians': 6370997 / (2 * Math.PI),
'degrees': (2 * Math.PI * 6370997) / 360,
'ft': 0.3048,
'm': 1,
'us-ft': 1200 / 3937,
};

3
src/ol/proj/epsg3857.js
View File

@@ -2,7 +2,6 @@
* @module ol/proj/epsg3857
*/
import Projection from './Projection.js';
import Units from './Units.js';
/**
* Radius of WGS84 sphere
@@ -48,7 +47,7 @@ class EPSG3857Projection extends Projection {
constructor(code) {
super({
code: code,
units: Units.METERS,
units: 'm',
extent: EXTENT,
global: true,
worldExtent: WORLD_EXTENT,

3
src/ol/proj/epsg4326.js
View File

@@ -2,7 +2,6 @@
* @module ol/proj/epsg4326
*/
import Projection from './Projection.js';
import Units from './Units.js';
/**
* Semi-major radius of the WGS84 ellipsoid.
@@ -42,7 +41,7 @@ class EPSG4326Projection extends Projection {
constructor(code, opt_axisOrientation) {
super({
code: code,
units: Units.DEGREES,
units: 'degrees',
extent: EXTENT,
axisOrientation: opt_axisOrientation,
global: true,

3
src/ol/proj/proj4.js
View File

@@ -2,7 +2,6 @@
* @module ol/proj/proj4
*/
import Projection from './Projection.js';
import Units from './Units.js';
import {
addCoordinateTransforms,
addEquivalentProjections,
@@ -33,7 +32,7 @@ export function register(proj4) {
const def = proj4.defs(code);
let units = def.units;
if (!units && def.projName === 'longlat') {
units = Units.DEGREES;
units = 'degrees';
}
addProjection(
new Projection({

9
src/ol/renderer/canvas/VectorTileLayer.js
View File

@@ -5,7 +5,6 @@ import CanvasBuilderGroup from '../../render/canvas/BuilderGroup.js';
import CanvasExecutorGroup from '../../render/canvas/ExecutorGroup.js';
import CanvasTileLayerRenderer from './TileLayer.js';
import TileState from '../../TileState.js';
import VectorTileRenderType from '../../layer/VectorTileRenderType.js';
import ViewHint from '../../ViewHint.js';
import {
HIT_DETECT_RESOLUTION,
@@ -139,7 +138,7 @@ class CanvasVectorTileLayerRenderer extends CanvasTileLayerRenderer {
if (
render &&
(hifi || Date.now() - frameState.time < 8) &&
layer.getRenderMode() !== VectorTileRenderType.VECTOR
layer.getRenderMode() !== 'vector'
) {
this.renderTileImage_(tile, frameState);
}
@@ -154,7 +153,7 @@ class CanvasVectorTileLayerRenderer extends CanvasTileLayerRenderer {
const layer = this.getLayer();
return (
super.isDrawableTile(tile) &&
(layer.getRenderMode() === VectorTileRenderType.VECTOR
(layer.getRenderMode() === 'vector'
? getUid(layer) in tile.executorGroups
: tile.hasContext(layer))
);
@@ -289,7 +288,7 @@ class CanvasVectorTileLayerRenderer extends CanvasTileLayerRenderer {
const executorGroupInstructions = builderGroup.finish();
// no need to clip when the render tile is covered by a single source tile
const replayExtent =
layer.getRenderMode() !== VectorTileRenderType.VECTOR &&
layer.getRenderMode() !== 'vector' &&
declutter &&
sourceTiles.length === 1
? null
@@ -784,7 +783,7 @@ class CanvasVectorTileLayerRenderer extends CanvasTileLayerRenderer {
const layer = /** @type {import("../../layer/VectorTile.js").default} */ (
this.getLayer()
);
if (layer.getRenderMode() === VectorTileRenderType.VECTOR) {
if (layer.getRenderMode() === 'vector') {
return false;
}
const replayState = tile.getReplayState(layer);

12
src/ol/source/Raster.js
View File

@@ -450,13 +450,9 @@ const RasterEventType = {
};
/**
* @typedef {'pixel' | 'image'} RasterOperationType
* Raster operation type. Supported values are `'pixel'` and `'image'`.
* @enum {string}
*/
const RasterOperationType = {
PIXEL: 'pixel',
IMAGE: 'image',
};
/**
* @typedef {import("./Image.js").ImageSourceEventTypes|'beforeoperations'|'afteroperations'} RasterSourceEventTypes
@@ -575,9 +571,7 @@ class RasterSource extends ImageSource {
* @type {RasterOperationType}
*/
this.operationType_ =
options.operationType !== undefined
? options.operationType
: RasterOperationType.PIXEL;
options.operationType !== undefined ? options.operationType : 'pixel';
/**
* @private
@@ -692,7 +686,7 @@ class RasterSource extends ImageSource {
this.processor_ = new Processor({
operation: operation,
imageOps: this.operationType_ === RasterOperationType.IMAGE,
imageOps: this.operationType_ === 'image',
queue: 1,
lib: opt_lib,
threads: this.threads_,

3
src/ol/tilegrid.js
View File

@@ -2,7 +2,6 @@
* @module ol/tilegrid
*/
import TileGrid from './tilegrid/TileGrid.js';
import Units from './proj/Units.js';
import {DEFAULT_MAX_ZOOM, DEFAULT_TILE_SIZE} from './tilegrid/common.js';
import {METERS_PER_UNIT, get as getProjection} from './proj.js';
import {
@@ -176,7 +175,7 @@ export function extentFromProjection(projection) {
let extent = projection.getExtent();
if (!extent) {
const half =
(180 * METERS_PER_UNIT[Units.DEGREES]) / projection.getMetersPerUnit();
(180 * METERS_PER_UNIT.degrees) / projection.getMetersPerUnit();
extent = createOrUpdate(-half, -half, half, half);
}
return extent;