itowns 2.45.1 → 2.45.2-next.0

package/lib/Source/OrientedImageSource.d.ts

@@ -0,0 +1,48 @@
+export default OrientedImageSource;
+/**
+ * OrientedImageSource is a specific source used to load oriented images.
+ * @extends Source
+ */
+declare class OrientedImageSource extends Source {
+    /**
+     * @param { Object } source - Configuration object
+     * @param { string } source.url - Url for all the textures.
+     * @param { string } source.orientationsUrl - Json Url, using GeoJSon format to represent points,
+     * it's a set of panoramic position and orientation.
+     * @param { string } source.calibrationUrl - Json url, representing a set of camera.
+     * see {@link CameraCalibrationParser}
+     * This Url must contains {sensorId} and {cameraId}, and these pattern will be replaced to build the Url,
+     * to find the good texture for each camera for each panoramic.
+     */
+    constructor(source: {
+        url: string;
+        orientationsUrl: string;
+        calibrationUrl: string;
+    });
+    isOrientedImageSource: boolean;
+    whenReady: Promise<{
+        orientation: void | Object;
+        calibration: void | Object;
+    }>;
+    /**
+     * Build the url of the texture, but not from extent.
+     *
+     * @param      {Object}  imageInfo - Information about the texture
+     * @param      {string}  imageInfo.camera - Id of the camera
+     * @param      {string}  imageInfo.pano - Id of the panoramic
+     * @return     {string}  Url of the image
+     */
+    urlFromExtent(imageInfo: {
+        camera: string;
+        pano: string;
+    }): string;
+    /**
+     * Build the url of the image, for a given panoramic id, and a given camera id.
+     *
+     * @param      {string}  cameraId  Id of the camera
+     * @param      {string}  panoId   Id of the panoramic
+     * @return     {string}  Url of the image
+     */
+    imageUrl(cameraId: string, panoId: string): string;
+}
+import Source from '../Source/Source';

package/lib/Source/Potree2Source.d.ts

@@ -0,0 +1,157 @@
+export default Potree2Source;
+/**
+ * Potree2Source are object containing informations on how to fetch potree 2.0 points cloud resources.
+ */
+declare class Potree2Source extends Source {
+    /**
+     * @param {Object} source - An object that can contain all properties of a
+     * Potree2Source
+     * @param {string} source.url - folder url.
+     * @param {string} source.file - metadata file name.
+     *
+     * This `metadata` file stores information about the potree cloud 2.0 in JSON format. the structure is :
+     *
+     * * __`version`__ - The metadata.json format may change over time. The version number is
+     * necessary so that parsers know how to interpret the data.
+     * * __`name`__ - Point cloud name.
+     * * __`description`__ - Point cloud description.
+     * * __`points`__ - Total number of points.
+     * * __`projection`__ - Point cloud geographic projection system.
+     * * __`hierarchy`__ - Information about point cloud hierarchy (first chunk size, step size, octree depth).
+     * * __`offset`__ - Position offset used to determine the global point position.
+     * * __`scale`__ - Point cloud scale.
+     * * __`spacing`__ - The minimum distance between points at root level.
+     * * __`boundingBox`__ - Contains the minimum and maximum of the axis aligned bounding box. This bounding box is cubic and aligned to fit to the octree root.
+     * * __`encoding`__ - Encoding type: BROTLI or DEFAULT (uncompressed).
+     * * __`attributes`__ - Array of attributes (position,  intensity, return number, number of returns, classification, scan angle rank, user data, point source id, gps-time, rgb).
+     * ```
+     * {
+     *     version: '2.0',
+     *     name: "sample",
+     *     description: "",
+     *     points: 534909153,
+     *     projection: "",
+     *     hierarchy: {
+     *         firstChunkSize: 1276,
+     *         stepSize: 4,
+     *         depth: 16
+     *     },
+     *     offset: [1339072.07, 7238866.339, 85.281],
+     *     scale: [0.001, 0.001, 0.002],
+     *     spacing: 24.476062500005355,
+     *     boundingBox: {
+     *         min: [1339072.07, 7238866.339, 85.281],
+     *         max: [1342205.0060000008, 7241999.275, 3218.2170000006854]
+     *     },
+     *     encoding: "BROTLI",
+     *     attributes: [
+     *          {
+     *              name: "position",
+     *              description: "",
+     *              size: 12,
+     *              numElements: 3,
+     *              elementSize: 4,
+     *              type: "int32",
+     *              min: [-0.74821299314498901, -2.7804059982299805, 2.5478212833404541],
+     *              max: [2.4514148223438199, 1.4893437627414672, 7.1957106576508663]
+     *          },
+     *          {
+     *              name: "intensity",
+     *              description: "",
+     *              size: 2,
+     *              numElements: 1,
+     *              elementSize: 2,
+     *              type: "uint16",
+     *              min: [0],
+     *              max: [0]
+     *          },{
+     *              name: "return number",
+     *              description: "",
+     *              size: 1,
+     *              numElements: 1,
+     *              elementSize: 1,
+     *              type: "uint8",
+     *              min: [0],
+     *              max: [0]
+     *          },{
+     *              name: "number of returns",
+     *              description: "",
+     *              size: 1,
+     *              numElements: 1,
+     *              elementSize: 1,
+     *              type: "uint8",
+     *              min: [0],
+     *              max: [0]
+     *          },{
+     *              name: "classification",
+     *              description: "",
+     *              size: 1,
+     *              numElements: 1,
+     *              elementSize: 1,
+     *              type: "uint8",
+     *              min: [0],
+     *              max: [0]
+     *          },{
+     *              name: "scan angle rank",
+     *              description: "",
+     *              size: 1,
+     *              numElements: 1,
+     *              elementSize: 1,
+     *              type: "uint8",
+     *              min: [0],
+     *              max: [0]
+     *          },{
+     *              name: "user data",
+     *              description: "",
+     *              size: 1,
+     *              numElements: 1,
+     *              elementSize: 1,
+     *              type: "uint8",
+     *              min: [0],
+     *              max: [0]
+     *          },{
+     *              name: "point source id",
+     *              description: "",
+     *              size: 2,
+     *              numElements: 1,
+     *              elementSize: 2,
+     *              type: "uint16",
+     *              min: [0],
+     *              max: [0]
+     *          },{
+     *              name: "gps-time",
+     *              description: "",
+     *              size: 8,
+     *              numElements: 1,
+     *              elementSize: 8,
+     *              type: "double",
+     *              min: [0],
+     *              max: [0]
+     *          },{
+     *              name: "rgb",
+     *              description: "",
+     *              size: 6,
+     *              numElements: 3,
+     *              elementSize: 2,
+     *              type: "uint16",
+     *              min: [5632, 5376, 4864],
+     *              max: [65280, 65280, 65280]
+     *          }
+     *     ]
+     * }
+     * ```
+     *
+     * @extends Source
+     */
+    constructor(source: {
+        url: string;
+        file: string;
+    });
+    file: string;
+    fetcher: (url: any, options?: {}) => Promise<ArrayBuffer>;
+    metadata: any;
+    pointAttributes: any;
+    baseurl: string;
+    extension: string;
+}
+import Source from '../Source/Source';

package/lib/Source/PotreeSource.d.ts

@@ -0,0 +1,69 @@
+export default PotreeSource;
+/**
+ * PotreeSource are object containing informations on how to fetch points cloud resources.
+ */
+declare class PotreeSource extends Source {
+    /**
+     * @param {Object} source - An object that can contain all properties of a
+     * PotreeSource
+     * @param {string} source.url - folder url.
+     * @param {string} source.file - cloud file name.
+     *
+     * This `cloud` file stores information about the potree cloud in JSON format. the structure is :
+     *
+     * * __`version`__ - The cloud.js format may change over time. The version number is
+     * necessary so that parsers know how to interpret the data.
+     * * __`octreeDir`__ - Directory or URL where node data is stored. Usually points to
+     * "data".
+     * * __`boundingBox`__ - Contains the minimum and maximum of the axis aligned bounding box. This bounding box is cubic and aligned to fit to the octree root.
+     * * __`tightBoundingBox`__ - This bounding box thightly fits the point data.
+     * * __`pointAttributes`__ - Declares the point data format. May be 'LAS', 'LAZ' or in case if the BINARY format an array of attributes like
+     * `['POSITION_CARTESIAN', 'COLOR_PACKED', 'INTENSITY']`
+     * * __`POSITION_CARTESIAN`__ - 3 x 32bit signed integers for x/y/z coordinates
+     * * __`COLOR_PACKED`__ - 4 x unsigned byte for r,g,b,a colors.
+     * * __`spacing`__ - The minimum distance between points at root level.
+     * ```
+     * {
+     *     version: '1.6',
+     *     octreeDir: 'data',
+     *     boundingBox: {
+     *         lx: -4.9854,
+     *         ly: 1.0366,
+     *         lz: -3.4494,
+     *         ux: 0.702300000000001,
+     *         uy: 6.7243,
+     *         uz: 2.2383
+     *     },
+     *     tightBoundingBox: {
+     *         lx: -4.9854,
+     *         ly: 1.0375,
+     *         lz: -3.4494,
+     *         ux: -0.7889,
+     *         uy: 6.7243,
+     *         uz: 1.1245
+     *     },
+     *     pointAttributes: [
+     *         'POSITION_CARTESIAN',
+     *         'COLOR_PACKED'
+     *     ],
+     *     spacing: 0.03,
+     *     scale: 0.001,
+     *     hierarchyStepSize: 5
+     * }
+     * ```
+     *
+     * @extends Source
+     */
+    constructor(source: {
+        url: string;
+        file: string;
+    });
+    file: string;
+    fetcher: (url: any, options?: {}) => Promise<ArrayBuffer>;
+    extensionOctree: string;
+    pointAttributes: any;
+    baseurl: string;
+    extension: string;
+    parse: (buffer: ArrayBuffer, options: Object) => Promise<any>;
+}
+import Source from '../Source/Source';

package/lib/Source/Source.d.ts

@@ -0,0 +1,122 @@
+/** @private */
+export const supportedParsers: Map<string, (json: string, options?: ParsingOptions) => Promise<any>>;
+export default Source;
+/**
+ * This interface describes parsing options.
+ */
+export type ParsingOptions = {
+    /**
+     * - data informations contained in the file.
+     */
+    in: Source;
+    /**
+     * - options indicates how the features should be built.
+     */
+    out: FeatureBuildingOptions | Layer;
+};
+/**
+ * Sources are object containing informations on how to fetch resources, from a
+ * set source.
+ *
+ * To extend a Source, it is necessary to implement two functions:
+ * `urlFromExtent` and `extentInsideLimit`.
+ *
+ * @extends InformationsData
+ *
+ * @property {boolean} isSource - Used to checkout whether this source is a
+ * Source. Default is true. You should not change this, as it is used internally
+ * for optimisation.
+ * @property {number} uid - Unique uid mainly used to store data linked to this
+ * source into Cache.
+ * @property {string} url - The url of the resources that are fetched.
+ * @property {string} format - The format of the resources that are fetched.
+ * @property {function} fetcher - The method used to fetch the resources from
+ * the source. iTowns provides some methods in {@link Fetcher}, but it can be
+ * specified a custom one. This method should return a `Promise` containing the
+ * fetched resource. If this property is set, it overrides the chosen fetcher
+ * method with `format`.
+ * @property {Object} networkOptions - Fetch options (passed directly to
+ * `fetch()`), see [the syntax for more information](
+ * https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Syntax).
+ * By default, set to `{ crossOrigin: 'anonymous' }`.
+ * @property {string} crs - The crs projection of the resources.
+ * @property {string} attribution - The intellectual property rights for the
+ * resources.
+ * @property {Extent} extent - The extent of the resources.
+ * @property {function} parser - The method used to parse the resources attached
+ * to the layer. iTowns provides some parsers, visible in the `Parser/` folder.
+ * If the method is custom, it should return a `Promise` containing the parsed
+ * resource. If this property is set, it overrides the default selected parser
+ * method with `source.format`. If `source.format` is also empty, no parsing
+ * action is done.
+ * <br><br>
+ * When calling this method, two parameters are passed:
+ * <ul>
+ *  <li>the fetched data, i.e. the data to parse</li>
+ *  <li>an {@link ParsingOptions}  containing severals properties, set when this method is
+ *  called: it is specific to each call, so the value of each property can vary
+ *  depending on the current fetched tile for example</li>
+ * </ul>
+ */
+declare class Source {
+    /**
+     * @param {Object} source - An object that can contain all properties of a
+     * Source. Only the `url` property is mandatory.
+     */
+    constructor(source: Object);
+    crs: any;
+    isSource: boolean;
+    uid: number;
+    url: any;
+    format: any;
+    fetcher: any;
+    parser: any;
+    isVectorSource: boolean;
+    networkOptions: any;
+    attribution: any;
+    /** @type {Promise<any>} */
+    whenReady: Promise<any>;
+    _featuresCaches: {};
+    extent: any;
+    handlingError(err: any): void;
+    /**
+     * Generates an url from an extent. This url is a link to fetch the
+     * resources inside the extent.
+     *
+     * @param {Extent} extent - Extent to convert in url.
+
+     * @return {string} The URL constructed from the extent.
+     */
+    urlFromExtent(extent: Extent): string;
+    getDataKey(extent: any): string;
+    /**
+     * Load  data from cache or Fetch/Parse data.
+     * The loaded data is a Feature or Texture.
+     *
+     * @param      {Extent}  extent   extent requested parsed data.
+     * @param      {FeatureBuildingOptions|Layer}  out     The feature returned options
+     * @return     {FeatureCollection|Texture}  The parsed data.
+     */
+    loadData(extent: Extent, out: FeatureBuildingOptions | Layer): FeatureCollection | Texture;
+    /**
+     * Called when layer added.
+     *
+     * @param {object} options
+     */
+    onLayerAdded(options: object): void;
+    /**
+     * Called when layer removed.
+     *
+     * @param {options}  [options={}] options
+     */
+    onLayerRemoved(options?: any): void;
+    /**
+     * Tests if an extent is inside the source limits.
+     *
+     * @param {Extent} extent - Extent to test.
+
+     * @return {boolean} True if the extent is inside the limit, false otherwise.
+     */
+    extentInsideLimit(extent: Extent): boolean;
+}
+import { Extent } from '@itowns/geographic';

package/lib/Source/TMSSource.d.ts

@@ -0,0 +1,77 @@
+export default TMSSource;
+/**
+ * An object defining the source of resources to get from a
+ * [TMS](https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification) server.
+ * It inherits from {@link Source}.
+ *
+ * @extends Source
+ *
+ * @property {boolean} isTMSSource - Used to checkout whether this source is a
+ * TMSSource. Default is true. You should not change this, as it is used
+ * internally for optimisation.
+ * @property {boolean} isInverted - The isInverted property is to be set to the
+ * correct value, true or false (default being false) if the computation of the
+ * coordinates needs to be inverted to match the same scheme as OSM, Google Maps
+ * or other system. See [this link](
+ * https://alastaira.wordpress.com/2011/07/06/converting-tms-tile-coordinates-to-googlebingosm-tile-coordinates/)
+ * for more information.
+ * @property {Object} tileMatrixSetLimits - it describes the available tile for this layer
+ * @property {Object} extentSetlimits - these are the extents of the set of identical zoom tiles.
+ * @property {Object} zoom - Object containing the minimum and maximum values of
+ * the level, to zoom in the source.
+ * @property {number} zoom.min - The minimum level of the source. Default value
+ * is 0.
+ * @property {number} zoom.max - The maximum level of the source. Default value
+ * is 20.
+ * @property {function} tileMatrixCallback - a method that create a TileMatrix
+ * identifier from the zoom level. For example, if set to `(zoomLevel) => 'EPSG:4326:' + zoomLevel`,
+ * the TileMatrix that will be fetched at zoom level 5 will be the one with identifier `EPSG:4326:5`.
+ * By default, the method returns the input zoom level.
+ *
+ * @example <caption><b>Source from OpenStreetMap server :</b></caption>
+ * // Create the source
+ * const tmsSource = new itowns.TMSSource({
+ *     format: 'image/png',
+ *     url: 'http://osm.io/styles/${z}/${x}/${y}.png',
+ *     attribution: {
+ *         name: 'OpenStreetMap',
+ *         url: 'http://www.openstreetmap.org/',
+ *     },
+ *     crs: 'EPSG:3857',
+ * });
+ *
+ * // Create the layer
+ * const colorLayer = new itowns.ColorLayer('OPENSM', {
+ *     source: tmsSource,
+ * });
+ *
+ * // Add the layer
+ * view.addLayer(colorLayer);
+ *
+ * @example <caption><b>Source from Mapbox server :</b></caption>
+ * // Create the source
+ * const orthoSource = new itowns.TMSSource({
+ *     url: 'https://api.mapbox.com/v4/mapbox.satellite/${z}/${x}/${y}.jpg?access_token=' + accessToken,
+ *     crs: 'EPSG:3857',
+ * };
+ *
+ * // Create the layer
+ * const imageryLayer = new itowns.ColorLayer("Ortho", {
+ *     source: orthoSource,
+ * };
+ *
+ * // Add the layer to the view
+ * view.addLayer(imageryLayer);
+ */
+declare class TMSSource extends Source {
+    isTMSSource: boolean;
+    zoom: any;
+    isInverted: any;
+    tileMatrixSetLimits: any;
+    extentSetlimits: {};
+    tileMatrixCallback: any;
+    urlFromExtent(tile: any): string;
+    onLayerAdded(options: any): void;
+    extentInsideLimit(extent: any, zoom: any): any;
+}
+import Source from '../Source/Source';

package/lib/Source/VectorTilesSource.d.ts

@@ -0,0 +1,56 @@
+export default VectorTilesSource;
+/**
+ * VectorTilesSource are object containing informations on how to fetch vector
+ * tiles resources.
+ *
+ * @property {function} filter - function to filter vector tiles layers, the
+ * parameter function is a layer.
+ * @property {boolean} [symbolToCircle=false] - If true, all symbols from a tile
+ * will be considered as circle, and render as circles.
+ */
+declare class VectorTilesSource extends TMSSource {
+    /**
+     * @param {Object} source - An object that can contain all properties of a
+     * VectorTilesSource and {@link Source}.
+     * @param {string|Object} source.style - The URL of the JSON style, of the
+     * JSON style directly.
+     * @param {string} [source.sprite] - The base URL to load informations about
+     * the sprite of the style. If this is set, it overrides the `sprite` value
+     * of the `source.style`. A style's sprite property supplies a URL template
+     * for loading small images.
+     * ```js
+     * {
+     *      sprite: 'http//:xxxxx/maps/sprites/'
+     * }
+     * ```
+     * A valid sprite source must supply two types of files:
+     * * An index file, which is a JSON document containing a description of each image contained in the sprite.
+     * * Image files, which are PNG images containing the sprite data.
+     *
+     * For more specification : [the Mapbox sprite Specification](https://docs.mapbox.com/mapbox-gl-js/style-spec/sprite/)
+     *
+     * @param {string} [source.url] - The base URL to load the tiles. If no url
+     * is specified, it reads it from the loaded style. Read [the Mapbox Style
+     * Specification](https://docs.mapbox.com/mapbox-gl-js/style-spec/sources/)
+     * for more informations.
+     * @param {string} [source.accessToken] - Mapbox access token
+     */
+    constructor(source: {
+        style: string | Object;
+        sprite?: string | undefined;
+        url?: string | undefined;
+        accessToken?: string | undefined;
+    });
+    urls: any[];
+    layers: {};
+    styles: {};
+    isVectorTileSource: boolean;
+    accessToken: string | undefined;
+    whenReady: Promise<void>;
+    jsonStyle: Object;
+    sprites: Object;
+    backgroundLayer: any;
+    urlFromExtent(tile: any, url: any): string;
+    loadData(extent: any, out: any): any;
+}
+import TMSSource from '../Source/TMSSource';

package/lib/Source/WFSSource.d.ts

@@ -0,0 +1,110 @@
+export default WFSSource;
+/**
+ * An object defining the source of resources to get from a
+ * [WFS](http://www.opengeospatial.org/standards/wfs) server. It inherits
+ * from {@link Source}.
+ *
+ * @extends Source
+ *
+ * @property {boolean} isWFSSource - Used to checkout whether this source is a
+ * WFSSource. Default is true. You should not change this, as it is used
+ * internally for optimisation.
+ * @property {string} typeName - The name of the feature to get, used in the
+ * generation of the url.
+ * @property {string} version - The version of the WFS server to request on.
+ * Default value is '2.0.2'.
+ * @property {Object} zoom - Object containing the minimum and maximum values of
+ * the level, to zoom in the source.
+ * @property {number} zoom.min - The minimum level of the source. Default value
+ * is 0.
+ * @property {number} zoom.max - The maximum level of the source. Default value
+ * is 21.
+ * @property {string} bboxDigits - The bbox digits precision used in URL
+ * @property {Object} vendorSpecific - An object containing vendor specific
+ * parameters. See for example a [list of these parameters for GeoServer]{@link
+ * https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html}. This
+ * object is read simply with the `key` being the name of the parameter and
+ * `value` being the value of the parameter. If used, this property should be
+ * set in the constructor parameters.
+ *
+ * @example
+ * // Add color layer with WFS source
+ * // Create the source
+ * const wfsSource = new itowns.WFSSource({
+ *     url: 'https://data.geopf.fr/wfs/ows?',
+ *     version: '2.0.0',
+ *     typeName: 'BDTOPO_BDD_WLD_WGS84G:bati_remarquable',
+ *     crs: 'EPSG:4326',
+ *     extent: {
+ *         west: 4.568,
+ *         east: 5.18,
+ *         south: 45.437,
+ *         north: 46.03,
+ *     },
+ *     zoom: { min: 14, max: 14 },
+ *     format: 'application/json',
+ * });
+ *
+ * // Create the layer
+ * const colorlayer = new itowns.ColorLayer('color_build', {
+ *     style: {
+ *         fill: 'red',
+ *         fillOpacity: 0.5,
+ *         stroke: 'white',
+ *     },
+ *     source: wfsSource,
+ * });
+ *
+ * // Add the layer
+ * view.addLayer(colorlayer);
+ *
+ * @example
+ * // Add geometry layer with WFS source
+ * // Create the source
+ * const wfsSource = new itowns.WFSSource({
+ *     url: 'https://data.geopf.fr/wfs/ows?',
+ *     version: '2.0.0',
+ *     typeName: 'BDTOPO_BDD_WLD_WGS84G:bati_remarquable',
+ *     crs: 'EPSG:4326',
+ *     extent: {
+ *         west: 4.568,
+ *         east: 5.18,
+ *         south: 45.437,
+ *         north: 46.03,
+ *     },
+ *     zoom: { min: 14, max: 14 },
+ *     format: 'application/json',
+ * });
+ *
+ * // Create the layer
+ * const geometryLayer = new itowns.FeatureGeometryLayer('mesh_build', {
+ *     style: {
+ *         fill: {
+ *             color: new itowns.THREE.Color(0xffcc00),
+ *             base_altitude: (p) => p.altitude,
+ *             extrusion_height: (p) => p.height,
+ *         }
+ *     },
+ *     source: wfsSource,
+ *     zoom: { min: 14 },
+ * };
+ *
+ * // Add the layer
+ * view.addLayer(geometryLayer);
+ */
+declare class WFSSource extends Source {
+    isWFSSource: boolean;
+    typeName: any;
+    version: any;
+    bboxDigits: any;
+    zoom: {
+        min: number;
+        max: number;
+    };
+    vendorSpecific: any;
+    url: string;
+    handlingError(err: any): any;
+    urlFromExtent(extentOrTile: any): string;
+    extentInsideLimit(extent: any): any;
+}
+import Source from '../Source/Source';