@types/viewport-mercator-project/index.d.ts

TypeScript definitions for viewport-mercator-project

import { mat4 } from "gl-matrix";

export interface ProjectOptions {
    topLeft?: boolean | undefined;
}

export interface UnprojectOptions extends ProjectOptions {
    targetZ?: number | undefined;
}

export type Coordinates = [number, number];

export type CoordinatesZ = [number, number, number];

export type ViewMatrix = number[];

export interface ViewportOptions {
    width?: number | undefined;
    height?: number | undefined;
    viewMatrix?: ViewMatrix | undefined;
    projectionMatrix?: ViewMatrix | undefined;
}

export class Viewport {
    width: number;
    height: number;
    scale: number;
    viewMatrix: ViewMatrix;
    projectionMatrix: ViewMatrix;

    constructor(opts?: ViewportOptions);

    equals(viewport: Viewport): boolean;
    project(lngLat: Coordinates, opts?: ProjectOptions): Coordinates;
    project(lngLatZ: CoordinatesZ, opts?: ProjectOptions): CoordinatesZ;
    unproject(xy: Coordinates, opts?: UnprojectOptions): Coordinates;
    unproject(xyz: CoordinatesZ, opts?: UnprojectOptions): CoordinatesZ;
}

export type Padding = number | { top: number; right: number; bottom: number; left: number };

export type Bounds = [Coordinates, Coordinates];

export interface WebMercatorViewportOptions {
    width?: number | undefined;
    height?: number | undefined;
    longitude?: number | undefined;
    latitude?: number | undefined;
    zoom?: number | undefined;
    pitch?: number | undefined;
    bearing?: number | undefined;
    altitude?: number | undefined;
    nearZMultiplier?: number | undefined;
    farZMultiplier?: number | undefined;
}

export class WebMercatorViewport extends Viewport {
    latitude: number;
    longitude: number;
    zoom: number;
    pitch: number;
    bearing: number;
    altitude: number;
    center: CoordinatesZ;

    constructor(opts?: WebMercatorViewportOptions);

    projectFlat(lngLat: Coordinates, scale?: number): Coordinates;
    unprojectFlat(xy: Coordinates, scale?: number): Coordinates;
    getMapCenterByLngLatPosition(opts: { lngLat: Coordinates; pos: Coordinates }): Coordinates;
    fitBounds(
        bounds: Bounds,
        opts?: { padding?: Padding | undefined; offset?: Coordinates | undefined },
    ): WebMercatorViewport;
}

export default WebMercatorViewport;

export interface FittedBounds {
    latitude: number;
    longitude: number;
    zoom: number;
}

export function fitBounds(
    options: {
        width: number;
        height: number;
        bounds: Bounds;
        padding?: Padding | undefined;
        offset?: Coordinates | undefined;
    },
): FittedBounds;

export interface TransitionViewport {
    longitude: number;
    latitude: number;
    zoom: number;
}

export interface FlyToViewportProps extends TransitionViewport {
    width: number;
    height: number;
}

export interface ViewportProps extends FlyToViewportProps {
    pitch?: number | undefined;
    bearing?: number | undefined;
}

export interface NormalizedViewportProps extends FlyToViewportProps {
    pitch: number;
    bearing: number;
}

export function normalizeViewportProps(props: ViewportProps): NormalizedViewportProps;

export function flyToViewport(
    startProps: FlyToViewportProps,
    endProps: FlyToViewportProps,
    t: number,
): TransitionViewport;

export function lngLatToWorld(lngLat: Coordinates, scale: number): Coordinates;

export function worldToLngLat(point: Coordinates, scale: number): Coordinates;

export function worldToPixels(coordinates: Coordinates | CoordinatesZ, pixelProjectionMatrix: mat4): CoordinatesZ;

export function pixelsToWorld(
    pixels: Coordinates | CoordinatesZ,
    pixelUnprojectionMatrix: mat4,
    targetZ?: number,
): CoordinatesZ;

export function getMeterZoom(input: { latitude: number }): number;

export interface DistanceScales {
    pixelsPerMeter: [number, number, number];
    metersPerPixel: [number, number, number];
    pixelsPerDegree: [number, number, number];
    degreesPerPixel: [number, number, number];
}

export interface HighPrecisionDistanceScales extends DistanceScales {
    pixelsPerDegree2: [number, number, number];
    pixelsPerMeter2: [number, number, number];
}

export interface BaseDistanceScalesInput {
    longitude: number;
    latitude: number;
}

export type DistanceScalesInput =
    | BaseDistanceScalesInput & { zoom: number }
    | BaseDistanceScalesInput & { scale: number };

export interface BaseHighPrecisionDistanceScalesInput extends BaseDistanceScalesInput {
    highPrecision: true;
}

export type HighPrecisionDistanceScalesInput =
    | BaseHighPrecisionDistanceScalesInput & { zoom: number }
    | BaseHighPrecisionDistanceScalesInput & { scale: number };

export function getDistanceScales(input: DistanceScalesInput): DistanceScales;
export function getDistanceScales(input: HighPrecisionDistanceScalesInput): HighPrecisionDistanceScales;

export function addMetersToLngLat(lngLat: Coordinates, xy: Coordinates): Coordinates;
export function addMetersToLngLat(lngLatZ: CoordinatesZ, xyz: CoordinatesZ): CoordinatesZ;

export function getViewMatrix(
    input: {
        height: number;
        pitch: number;
        bearing: number;
        altitude: number;
        center?: CoordinatesZ | undefined;
        flipY?: boolean | undefined;
    },
): ViewMatrix;

export interface ProjectionParametersInput {
    width: number;
    height: number;
    pitch?: number | undefined;
    altitude?: number | undefined;
    nearZMultiplier?: number | undefined;
    farZMultiplier?: number | undefined;
}

export interface ProjectionParameters {
    fov: number;
    aspect: number;
    focalDistance: number;
    near: number;
    far: number;
}

export function getProjectionParameters(input: ProjectionParametersInput): ProjectionParameters;

export function getProjectionMatrix(input: ProjectionParametersInput): mat4;