@here/harp-mapview/lib/ElevationProvider.d.ts

Functionality needed to render a map.

import { GeoCoordinates, TileKey, TilingScheme } from "@here/harp-geoutils";
import * as THREE from "three";
import { TileDisplacementMap } from "./DisplacementMap";
export interface ElevationProvider {
    /**
     * Get elevation for a given geo point.
     *
     * @param geoPoint - geo position to query height for.
     * @param level - Optional data level that should be used for getting the elevation.
     *              If undefined, the view's visible tile containing the point will be used.
     * @returns The height at geoPoint or undefined if no tile was found that covers the geoPoint.
     */
    getHeight(geoPoint: GeoCoordinates, level?: number): number | undefined;
    /**
     * Samples elevation for a given geo point from the specified displacement map.
     *
     * @param geoPoint - geo position to query height for.
     * @param tileDisplacementMap - Displacement map where the height will be sampled.
     * @returns The height at geoPoint.
     */
    sampleHeight(geoPoint: GeoCoordinates, tileDisplacementMap: TileDisplacementMap): number;
    /**
     * Cast a ray through the given screen position x, y.
     *
     * @param x - The X position in css/client coordinates (without applied display ratio).
     * @param y - The Y position in css/client coordinates (without applied display ratio).
     * @returns World coordinate of the intersection or undefined if no intersection detected.
     */
    rayCast(x: number, y: number): THREE.Vector3 | undefined;
    /**
     * Get the displacement map for a given tile key. If the displacement map for the given tileKey
     * is not in the cache a lower level tile will be returned.
     *
     * @param tileKey - The tile to get the displacement map for.
     * @returns Returns the DisplacementMap for the given tileKey or a lower level tile. Undefined
     *          if the tile or no parent is in the cache.
     */
    getDisplacementMap(tileKey: TileKey): TileDisplacementMap | undefined;
    /**
     * @returns the TilingScheme used for the DisplacementMaps returned by [[getDisplacementMap]]
     * or undefined if there is no elevation {@link DataSource} attached to the {@link MapView}.
     */
    getTilingScheme(): TilingScheme | undefined;
    /**
     * Clears the internal cache.
     */
    clearCache(): void;
}
//# sourceMappingURL=ElevationProvider.d.ts.map