@giro3d/giro3d/core/ElevationProvider.d.ts

A JS/WebGL framework for 3D geospatial data visualization

import type ElevationSample from './ElevationSample';
import type GetElevationOptions from './GetElevationOptions';
import type GetElevationResult from './GetElevationResult';
/**
 * Represents an object that can provide elevations at given coordinates.
 *
 * Note: to combine multiple providers into one, you can use the {@link aggregateElevationProviders} function.
 */
export interface ElevationProvider {
    /**
     * Returns the elevation at the specified coordinates, without any coordinate conversion.
     * @param x - The X coordinate of the location to sample, in the same coordinate system as this elevation provider.
     * @param y - The Y coordinate of the location to sample, in the same coordinate system as this elevation provider.
     */
    getElevationFast(x: number, y: number): ElevationSample | undefined;
    /**
     * Sample the elevation at the specified coordinate.
     *
     * Note: sampling might return more than one sample for any given coordinate. You can sort them
     * by {@link core.ElevationSample.resolution | resolution} to select the best sample for your needs.
     * @param options - The options.
     * @param result - The result object to populate with the samples. If none is provided, a new
     * empty result is created. The existing samples in the array are not removed. Useful to
     * cumulate samples across different providers.
     * @returns The {@link GetElevationResult} containing the updated sample array.
     */
    getElevation(options: GetElevationOptions, result?: GetElevationResult): GetElevationResult;
}
/**
 * Returns an {@link ElevationProvider} that aggregates multiple providers into one.
 * The {@link ElevationProvider.getElevation | getElevation} method will then sample
 * all underlying providers and return a single {@link GetElevationResult} containing
 * samples from all providers.
 *
 * This can be useful if a scene contains multiple overlapping terrains for example.
 *
 * @param providers - The providers to aggregate.
 */
export declare function aggregateElevationProviders(...providers: ElevationProvider[]): ElevationProvider;
export default ElevationProvider;
//# sourceMappingURL=ElevationProvider.d.ts.map