itowns 2.45.1 → 2.45.2-next.0

package/lib/Utils/DEMUtils.d.ts

@@ -0,0 +1,84 @@
+export function readTextureValueWithBilinearFiltering(metadata: any, texture: any, vertexU: any, vertexV: any): any;
+declare namespace _default {
+    /**
+     * Gives the elevation value of a {@link TiledGeometryLayer}, at a specific
+     * {@link Coordinates}.
+     *
+     * @param {TiledGeometryLayer} layer - The tile layer owning the elevation
+     * textures we're going to query. This is typically a `GlobeLayer` or
+     * `PlanarLayer` (accessible through `view.tileLayer`).
+     * @param {Coordinates} coord - The coordinates that we're interested in.
+     * @param {number} [method=FAST_READ_Z] - There are two available methods:
+     * `FAST_READ_Z` (default) or `PRECISE_READ_Z`. The first one is faster,
+     * while the second one is slower but gives better precision.
+     * @param {TileMesh[]} [tileHint] - Optional array of tiles to speed up the
+     * process. You can give candidates tiles likely to contain `coord`.
+     * Otherwise the lookup process starts from the root of `layer`.
+     *
+     * @return {number} If found, a value in meters is returned; otherwise
+     * `undefined`.
+     */
+    export function getElevationValueAt(layer: TiledGeometryLayer, coord: Coordinates, method?: number, tileHint?: TileMesh[]): number;
+    /**
+     * @typedef Terrain
+     * @type {Object}
+     *
+     * @property {Coordinates} coord - Pick coordinate with the elevation in coord.z.
+     * @property {THREE.Texture} texture - the picked elevation texture.
+     * The texture where the `z` value has been read from
+     * @property {TileMesh} tile - the picked tile and the tile containing the texture
+     */
+    /**
+     * Gives a {@link Terrain} object, at a specific {@link Coordinates}. The returned
+     * object is as follow:
+     * - `coord`, Coordinate, coord.z is the value in meters of the elevation at the coordinates
+     * - `texture`, the texture where the `z` value has been read from
+     * - `tile`, the tile containing the texture
+     * @example
+     * // place mesh on the ground
+     * const coord = new Coordinates('EPSG:4326', 6, 45);
+     * const result = DEMUtils.getTerrainObjectAt(view.tileLayer, coord)
+     * mesh.position.copy(result.coord.as(view.referenceCrs));
+     * view.scene.add(mesh);
+     * mesh.updateMatrixWorld();
+     *
+     *
+     * @param {TiledGeometryLayer} layer - The tile layer owning the elevation
+     * textures we're going to query. This is typically a `GlobeLayer` or
+     * `PlanarLayer` (accessible through `view.tileLayer`).
+     * @param {Coordinates} coord - The coordinates that we're interested in.
+     * @param {number} [method=FAST_READ_Z] - There are two available methods:
+     * `FAST_READ_Z` (default) or `PRECISE_READ_Z`. The first one is faster,
+     * while the second one is slower but gives better precision.
+     * @param {TileMesh[]} [tileHint] - Optional array of tiles to speed up the
+     * process. You can give candidates tiles likely to contain `coord`.
+     * Otherwise the lookup process starts from the root of `layer`.
+     * @param {Object} [cache] - Object to cache previous result and speed up the next `getTerrainObjectAt`` use.
+     *
+     * @return {Terrain} - The {@link Terrain} object.
+     */
+    export function getTerrainObjectAt(layer: TiledGeometryLayer, coord: Coordinates, method?: number, tileHint?: TileMesh[], cache?: Object): {
+        /**
+         * - Pick coordinate with the elevation in coord.z.
+         */
+        coord: Coordinates;
+        /**
+         * - the picked elevation texture.
+         * The texture where the `z` value has been read from
+         */
+        texture: THREE.Texture;
+        /**
+         * - the picked tile and the tile containing the texture
+         */
+        tile: TileMesh;
+    };
+    export { FAST_READ_Z };
+    export { PRECISE_READ_Z };
+    export { placeObjectOnGround };
+}
+export default _default;
+import { Coordinates } from '@itowns/geographic';
+import * as THREE from 'three';
+declare const FAST_READ_Z: 0;
+declare const PRECISE_READ_Z: 1;
+import placeObjectOnGround from '../Utils/placeObjectOnGround';

package/lib/Utils/DEMUtils.js

@@ -98,7 +98,7 @@ function tileAt(pt, tile) {
         return t;
       }
     }
-    const tileLayer = tile.material.getElevationLayer();
+    const tileLayer = tile.material.getElevationTile();
     if (tileLayer && tileLayer.level >= 0) {
       return tile;
     }
@@ -302,7 +302,7 @@ function _readZ(layer, method, coord, nodes, cache) {
     return;
   }
   const tile = tileWithValidElevationTexture;
-  const tileLayer = tile.material.getElevationLayer();
+  const tileLayer = tile.material.getElevationTile();
   const src = tileLayer.textures[0];
 
   // check cache value if existing

package/lib/Utils/FeaturesUtils.d.ts

@@ -0,0 +1,17 @@
+declare namespace _default {
+    /**
+     * Filter from a list of features, features that are under a coordinate.
+     *
+     * @param {Coordinates} coordinate - The coordinate for the filter
+     * condition.
+     * @param {Feature|FeatureCollection} collection - A single feature or a
+     * collection of them, to filter given the previous coordinate.
+     * @param {number} [epsilon=0.1] Tolerance around the coordinate (in
+     * coordinate's unit).
+     *
+     * @return {Feature[]} Array of filtered features.
+     */
+    function filterFeaturesUnderCoordinate(coordinate: Coordinates, collection: Feature | FeatureCollection, epsilon?: number): Feature[];
+}
+export default _default;
+import { Coordinates } from '@itowns/geographic';

package/lib/Utils/Gradients.d.ts

@@ -0,0 +1,13 @@
+declare namespace _default {
+    let SPECTRAL: (number | THREE.Color)[][];
+    let PLASMA: (number | THREE.Color)[][];
+    let YELLOW_GREEN: (number | THREE.Color)[][];
+    let VIRIDIS: (number | THREE.Color)[][];
+    let INFERNO: (number | THREE.Color)[][];
+    let GRAYSCALE: (number | THREE.Color)[][];
+    let TURBO: (number | THREE.Color)[][];
+    let RAINBOW: (number | THREE.Color)[][];
+    let CONTOUR: (number | THREE.Color)[][];
+}
+export default _default;
+import * as THREE from 'three';

package/lib/Utils/ThreeUtils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Removes a material and its textures, memory will be freed.
+ * IMPORTANT NOTE: the material and the texture must not be referenced by other threejs objects, otherwise the memory
+ * won't be freed.
+ * @param {Material} material the material to remove
+ */
+export default function disposeThreeMaterial(material: Material): void;
+/**
+ * Merge groups of an object3D when it can to reduce number of them + remove unused materials
+ * Reduce draw call https://threejs.org/docs/index.html?q=geometry#api/en/core/BufferGeometry.groups
+ *
+ * @param {THREE.Object3D} object3D - object to get optimize
+ */
+export function optimizeGeometryGroups(object3D: THREE.Object3D): void;

package/lib/Utils/placeObjectOnGround.d.ts

@@ -0,0 +1,28 @@
+export default placeObjectOnGround;
+/**
+ * @deprecated
+ * Helper method that will position an object directly on the ground.
+ *
+ * @param {TiledGeometryLayer} layer - The tile layer owning the elevation
+ * textures we're going to query. This is typically a `GlobeLayer` or
+ * `PlanarLayer` (accessible through `view.tileLayer`).
+ * @param {string} crs - The CRS used by the object coordinates. You
+ * probably want to use `view.referenceCRS` here.
+ * @param {Object3D} obj - the object we want to modify.
+ * @param {Object} options
+ * @param {number} [options.method=FAST_READ_Z] - There are two available methods:
+ * `FAST_READ_Z` (default) or `PRECISE_READ_Z`. The first one is faster,
+ * while the second one is slower but gives better precision.
+ * @param {boolean} options.modifyGeometry - if unset/false, this function
+ * will modify object.position. If true, it will modify
+ * `obj.geometry.vertices` or `obj.geometry.attributes.position`.
+ * @param {TileMesh[]} [tileHint] - Optional array of tiles to speed up the
+ * process. You can give candidates tiles likely to contain `coord`.
+ * Otherwise the lookup process starts from the root of `layer`.
+ *
+ * @return {boolean} true if successful, false if we couldn't lookup the elevation at the given coords
+ */
+declare function placeObjectOnGround(layer: TiledGeometryLayer, crs: string, obj: Object3D, options?: {
+    method?: number | undefined;
+    modifyGeometry: boolean;
+}, tileHint?: TileMesh[]): boolean;

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "itowns",
-  "version": "2.45.1",
+  "version": "2.45.2-next.0",
   "description": "A JS/WebGL framework for 3D geospatial data visualization",
   "type": "module",
   "main": "lib/Main.js",
   "exports": {
-    ".": "./lib/Main.js",
+    ".": {
+      "types": "./lib/Main.d.ts",
+      "default": "./lib/Main.js"
+    },
     "./widgets": "./lib/Utils/gui/Main.js"
   },
   "scripts": {
     "lint": "eslint \"src/**/*.{js,ts,tsx}\" \"test/**/*.js\"",
-    "transpile": "cross-env BABEL_DISABLE_CACHE=1 babel src --out-dir lib --extensions .js,.ts",
+    "types": "tsc && tsc-alias",
+    "transpile": "npm run types && cross-env BABEL_DISABLE_CACHE=1 babel src --out-dir lib --extensions .js,.ts",
     "test-unit": "npm run base-test-unit test/unit",
     "base-test-unit": "cross-env BABEL_DISABLE_CACHE=1 mocha --timeout 5000 --file test/unit/bootstrap.js --import=../../config/babel-register/register.mjs",
     "test-with-coverage": "c8 -n src -r html cross-env npm run test-unit",
@@ -19,9 +23,8 @@
     "prepublishOnly": "npx copyfiles -u 1 \"../../examples/**/*\" ./examples/ && npx copyfiles -u 1 \"../../docs/**/*\" ./docs/ && npx copyfiles -u 1 \"../../dist/**/*\" ./dist/ ",
     "postpublish": "node clean.cjs",
     "publish-latest": "npm publish --access public --tag=latest --provenance",
-    "prerelease-next": "npm version prerelease --preid next",
     "publish-next": "npm publish --access public --tag=next --provenance",
-    "update-package": "npm remove @itowns/geographic && npm install @itowns/geographic@$npm_package_version --save"
+    "version": "cross-env-shell npm install @itowns/geographic@$npm_package_version && node scripts/version.mjs"
   },
   "c8": {
     "exclude": [
@@ -48,27 +51,27 @@
     "url": "https://github.com/iTowns/itowns/issues"
   },
   "dependencies": {
-    "@itowns/geographic": "^2.45.1",
+    "@itowns/geographic": "^2.45.2-next.0",
     "@mapbox/vector-tile": "^2.0.3",
-    "@maplibre/maplibre-gl-style-spec": "^22.0.0",
-    "@tmcw/togeojson": "^5.8.1",
+    "@maplibre/maplibre-gl-style-spec": "^23.1.0",
+    "@tmcw/togeojson": "^7.0.0",
     "@tweenjs/tween.js": "^25.0.0",
-    "3d-tiles-renderer": "^0.4.4",
+    "3d-tiles-renderer": "^0.4.7",
     "brotli-compress": "^1.3.3",
-    "copc": "^0.0.6",
-    "earcut": "^3.0.0",
+    "copc": "^0.0.8",
+    "earcut": "^3.0.1",
     "js-priority-queue": "^0.1.5",
-    "lru-cache": "^11.0.1",
+    "lru-cache": "^11.0.2",
     "pbf": "^4.0.1",
     "shpjs": "^6.1.0",
     "threads": "^1.7.0"
   },
   "peerDependencies": {
-    "proj4": "^2.12.1",
-    "three": "^0.170.0"
+    "proj4": "^2.19.3",
+    "three": "^0.174.0"
   },
   "devDependencies": {
-    "chalk": "^5.3.0",
+    "chalk": "^5.4.1",
     "copyfiles": "^2.4.1"
   },
   "homepage": "https://itowns.github.io/"