@tomtom-org/maps-sdk-plugin-landmarks-3d 0.2.1 → 0.3.0

package/dist/surfacesKnobCatalogue-B1prY4bG.d.ts

@@ -0,0 +1,1201 @@
+import { KnobEntry, KnobKind, KnobRange, KnobValueOf, MapColorName } from "@tomtom-org/maps-sdk/map";
+//#region src/paletteOptions.d.ts
+/**
+ * How a building or a landmark takes its colour from a palette:
+ *
+ * - `pick`: one of the palette's colours.
+ * - `blend`: a mix of two neighbouring colours, anywhere along the palette, so a palette of a few
+ *   shades gives a gradient of them.
+ *
+ * @group Buildings 3D
+ */
+declare const paletteModes: readonly ["pick", "blend"];
+/**
+ * One of {@link paletteModes}.
+ *
+ * @group Buildings 3D
+ */
+type PaletteMode = (typeof paletteModes)[number];
+/**
+ * The map colours a palette can name in place of a CSS colour, by their knob id: `colors.artificial`,
+ * `colors.accent`. They follow the map colours as a theme or `setMapColors` changes them.
+ *
+ * @group Buildings 3D
+ */
+declare const paletteMapColors: readonly `colors.${MapColorName}`[];
+//#endregion
+//#region src/buildings/buildingsKnobCatalogue.d.ts
+/**
+ * How the windows of a facade are laid out. `mixed` picks one per building, by its height: punched
+ * windows on low ones, office bands from about five storeys, and glass curtain walls on towers and on
+ * some of the buildings between.
+ *
+ * @group Buildings 3D
+ */
+declare const facadePatterns: readonly ["mixed", "residential", "office", "glass", "plain"];
+/**
+ * One of {@link facadePatterns}.
+ *
+ * @group Buildings 3D
+ */
+type FacadePattern = (typeof facadePatterns)[number];
+/**
+ * The looks the unset knobs take: one per standard style, or `auto`, which follows the map's style.
+ *
+ * @group Buildings 3D
+ */
+declare const buildingsPresets: readonly ["auto", "streetLight", "streetDark", "streetLightDriving", "streetDarkDriving", "monoLight", "monoDark", "streetSatellite"];
+/**
+ * One of {@link buildingsPresets}.
+ *
+ * @group Buildings 3D
+ */
+type BuildingsPreset = (typeof buildingsPresets)[number];
+declare const buildingsKnobDefinitions: {
+  readonly visible: {
+    readonly kind: "toggle";
+    readonly description: "The 3D buildings.";
+    readonly default: true;
+  };
+  readonly preset: {
+    readonly kind: "enum";
+    readonly description: "Look every unset knob takes: a standard style's, or auto, which follows the map's standard style.";
+    readonly options: readonly ["auto", "streetLight", "streetDark", "streetLightDriving", "streetDarkDriving", "monoLight", "monoDark", "streetSatellite"];
+    readonly default: "auto";
+  };
+  readonly opacity: {
+    readonly kind: "number";
+    readonly description: "Opacity of the buildings, and of the landmarks left unset among them, 0 to 1.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly minZoom: {
+    readonly kind: "number";
+    readonly description: "Lowest zoom the buildings are drawn at, and the landmarks left unset among them.";
+    readonly range: {
+      readonly min: 13;
+      readonly max: 22;
+      readonly step: 1;
+      readonly bounds: "hard";
+    };
+  };
+  readonly 'facade.pattern': {
+    readonly kind: "enum";
+    readonly description: "How windows are laid out: mixed (by building height), residential, office, glass (curtain walls) or plain (no windows).";
+    readonly options: readonly ["mixed", "residential", "office", "glass", "plain"];
+  };
+  readonly 'facade.intensity': {
+    readonly kind: "number";
+    readonly description: "How strongly the windows show on the walls, and the landmarks' own texture among the buildings while their texture is detail, 0 (plain walls) to 1.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'facade.floorHeightMeters': {
+    readonly kind: "number";
+    readonly description: "Height of one storey, which spaces the rows of windows. The ground floor is a third taller.";
+    readonly range: {
+      readonly min: 2.5;
+      readonly max: 6;
+      readonly step: 0.1;
+      readonly bounds: "hard-min";
+    };
+  };
+  readonly 'walls.color': {
+    readonly kind: "color";
+    readonly description: "Colour of the walls. Unset: the map style's 3D building colour of each kind of building, following the map colours that restyle them, and the colour of the buildings of no named kind is the one reported. Landmarks left unset among the buildings take it too.";
+  };
+  readonly 'walls.palette': {
+    readonly kind: "colors";
+    readonly description: "Colours the walls take, one per building: CSS colours, or map colours by knob id (colors.accent), which follow the map. Empty: none. Unset landmarks among the buildings take it too.";
+    readonly options: readonly ("colors.water" | "colors.land" | "colors.vegetation" | "colors.park" | "colors.artificial" | "colors.roadMajor" | "colors.road" | "colors.roadOutline" | "colors.label" | "colors.labelHalo" | "colors.accent")[];
+  };
+  readonly 'walls.paletteMode': {
+    readonly kind: "enum";
+    readonly description: "pick: each building takes one palette colour; blend: a mix of two neighbouring ones, a gradient along the palette.";
+    readonly options: readonly ["pick", "blend"];
+  };
+  readonly 'walls.paletteIntensity': {
+    readonly kind: "number";
+    readonly description: "How far the walls move from their colour to their palette colour, 0 to 1. Lower it for a hint of the palette.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'walls.variation': {
+    readonly kind: "number";
+    readonly description: "How much each building differs from the next in shade and warmth, 0 (all alike) to 1.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'hover.color': {
+    readonly kind: "color";
+    readonly description: "Colour the hovered building turns towards, while a handler listens to the buildings' events. Unset: the map's accent, else blue.";
+  };
+  readonly 'hover.intensity': {
+    readonly kind: "number";
+    readonly description: "How far the hovered building turns towards its hover colour, 0 to 1.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'click.color': {
+    readonly kind: "color";
+    readonly description: "Colour the clicked building turns towards, until the next click lands elsewhere. Unset: the map's accent, else blue.";
+  };
+  readonly 'click.intensity': {
+    readonly kind: "number";
+    readonly description: "How far the clicked building turns towards its click colour, 0 to 1.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'roofs.color': {
+    readonly kind: "color";
+    readonly description: "Colour of the roofs. Unset: a shade darker than each building's walls, reported as the walls' colour; `streetSatellite` sets its own.";
+  };
+  readonly 'roofs.palette': {
+    readonly kind: "colors";
+    readonly description: "Colours the roofs take, one per building, as walls.palette does. Empty: none, and with roofs.color unset too, the roofs follow the walls, their palette included.";
+    readonly options: readonly ("colors.water" | "colors.land" | "colors.vegetation" | "colors.park" | "colors.artificial" | "colors.roadMajor" | "colors.road" | "colors.roadOutline" | "colors.label" | "colors.labelHalo" | "colors.accent")[];
+  };
+  readonly 'roofs.paletteMode': {
+    readonly kind: "enum";
+    readonly description: "pick: each roof takes one palette colour; blend: a mix of two neighbouring ones.";
+    readonly options: readonly ["pick", "blend"];
+  };
+  readonly 'roofs.paletteIntensity': {
+    readonly kind: "number";
+    readonly description: "How far the roofs move from their colour to their palette colour, 0 to 1.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'windows.color': {
+    readonly kind: "color";
+    readonly description: "Colour of the window glass.";
+  };
+  readonly 'reflections.intensity': {
+    readonly kind: "number";
+    readonly description: "How much the window glass mirrors the street, the facades across it and the sky, and catches the sun, 0 (matte) to 1. Glass curtain walls reflect the most, landmarks a little; the sky's colour is the ambient light's.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'litWindows.color': {
+    readonly kind: "color";
+    readonly description: "Colour of the windows lit from inside.";
+  };
+  readonly 'litWindows.fraction': {
+    readonly kind: "number";
+    readonly description: "Share of the windows lit from inside, 0 to 1. The dark presets light some.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'litWindows.intensity': {
+    readonly kind: "number";
+    readonly description: "Brightness of the lit windows, 0 to 1. Pair it with the map effects bloom for a night glow.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'light.direction': {
+    readonly kind: "number";
+    readonly description: "Direction the light comes from, in degrees clockwise from north. Shadows fall the opposite way. Unset: the map's light where one is placed, as the styling module's `view.light` knobs do, else the preset's.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'light.altitude': {
+    readonly kind: "number";
+    readonly description: "Height of the light above the horizon, in degrees (90 = overhead); lower casts longer shadows. Unset: the map's light, as for `light.direction`.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'light.color': {
+    readonly kind: "color";
+    readonly description: "Colour of the light: the sun on light presets, the moon on dark ones.";
+  };
+  readonly 'light.intensity': {
+    readonly kind: "number";
+    readonly description: "Strength of the light, 0 to 1.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'ambientLight.color': {
+    readonly kind: "color";
+    readonly description: "Colour of the light from the sky, which also tints the reflections in the glass.";
+  };
+  readonly 'ambientLight.intensity': {
+    readonly kind: "number";
+    readonly description: "Strength of the light from the sky, 0 to 1, which lights the walls in shade.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'shadows.visible': {
+    readonly kind: "toggle";
+    readonly description: "Shadows the buildings and the landmarks among them cast, on each other and on the ground.";
+  };
+  readonly 'shadows.intensity': {
+    readonly kind: "number";
+    readonly description: "Darkness of the shadows, 0 to 1.";
+    readonly range: import("@tomtom-org/maps-sdk/map").KnobRange;
+  };
+  readonly 'roadLabels.occluded': {
+    readonly kind: "toggle";
+    readonly description: "Road names draw under the buildings: hidden wherever a building covers them, they give way to the labels above them.";
+  };
+  readonly 'pois.occluded': {
+    readonly kind: "toggle";
+    readonly description: "The style's POIs draw under the buildings: hidden wherever a building covers them, still keeping other labels off, they give way to the labels above them.";
+  };
+};
+/**
+ * The id of a buildings knob, as accepted by the SDK's `setKnob` and as a path into {@link Buildings3DConfig}.
+ *
+ * @group Buildings 3D
+ */
+type Buildings3DKnobId = keyof typeof buildingsKnobDefinitions;
+type KindOf$1<ID extends Buildings3DKnobId> = (typeof buildingsKnobDefinitions)[ID]['kind'];
+/**
+ * The value type a buildings knob takes.
+ *
+ * @group Buildings 3D
+ */
+type Buildings3DKnobValueOf<ID extends Buildings3DKnobId> = ID extends 'preset' ? BuildingsPreset : ID extends 'facade.pattern' ? FacadePattern : ID extends 'walls.paletteMode' | 'roofs.paletteMode' ? PaletteMode : KnobValueOf<KindOf$1<ID>>;
+/**
+ * One entry of {@link buildings3DKnobCatalogue}, with what a UI or a coding agent needs to offer the
+ * knob and validate a value for it. The SDK's `getKnob` reads the value in force.
+ *
+ * @group Buildings 3D
+ */
+type Buildings3DKnob = KnobEntry<Buildings3DKnobId>;
+/**
+ * Every buildings knob with its kind, description, range or options and, for `visible` and `preset`,
+ * its default. It's static data, readable without a map.
+ *
+ * @remarks
+ * A knob is a plain value in {@link Buildings3DConfig}, at its id's path. Every knob but `visible` and
+ * `preset` takes the preset's value while unset, which the SDK's `getKnob` reports. The exceptions:
+ * - `hover.color` and `click.color` take the map's accent, else blue.
+ * - `light.direction` and `light.altitude` follow the map's light once one is placed, and `getKnob`
+ *   reports that light, its direction rounded to whole degrees.
+ *
+ * @group Buildings 3D
+ */
+declare const buildings3DKnobCatalogue: readonly Buildings3DKnob[];
+/**
+ * Every buildings knob id, in catalogue order.
+ *
+ * @group Buildings 3D
+ */
+declare const buildings3DKnobIds: readonly Buildings3DKnobId[];
+//#endregion
+//#region src/knobCatalogue.d.ts
+/**
+ * What a landmark's own texture gives its look, besides carving its silhouette:
+ *
+ * - `mask`: nothing more; the landmark is shaded in its `color`.
+ * - `detail`: its light and shade, over the `color`, as facade detail.
+ * - `color`: its colours, in place of the `color`.
+ *
+ * Whatever the use, the map's light shades the landmark.
+ *
+ * @group Landmarks 3D
+ */
+declare const landmarkTextureUses: readonly ["mask", "detail", "color"];
+/**
+ * One of {@link landmarkTextureUses}.
+ *
+ * @group Landmarks 3D
+ */
+type LandmarkTextureUse = (typeof landmarkTextureUses)[number];
+declare const landmarks3DKnobDefinitions: {
+  readonly visible: {
+    readonly kind: "toggle";
+    readonly description: "The landmark models.";
+    readonly default: true;
+  };
+  readonly color: {
+    readonly kind: "color";
+    readonly description: "Colour the landmarks are shaded in. Unset: the base map's 3D buildings' colour, following the map colours that restyle them.";
+  };
+  readonly palette: {
+    readonly kind: "colors";
+    readonly description: "Colours the landmarks take, one per landmark: CSS colours, or map colours by knob id (colors.accent), which follow the map. Unset: none, or the walls' palette under a Buildings3D while color is unset.";
+    readonly options: readonly ("colors.water" | "colors.land" | "colors.vegetation" | "colors.park" | "colors.artificial" | "colors.roadMajor" | "colors.road" | "colors.roadOutline" | "colors.label" | "colors.labelHalo" | "colors.accent")[];
+  };
+  readonly paletteMode: {
+    readonly kind: "enum";
+    readonly description: "pick: each landmark takes one palette colour; blend: a mix of two neighbouring ones. Unset: pick, or the walls' one under a Buildings3D.";
+    readonly options: readonly ["pick", "blend"];
+  };
+  readonly paletteIntensity: {
+    readonly kind: "number";
+    readonly description: "How far a landmark moves from its color to its palette colour, 0 to 1. Unset: 1, or the walls' one under a Buildings3D.";
+    readonly range: KnobRange;
+  };
+  readonly variation: {
+    readonly kind: "number";
+    readonly description: "How much each landmark differs from the next in shade and warmth, 0 to 1. Unset: 0, or the walls' one under a Buildings3D.";
+    readonly range: KnobRange;
+  };
+  readonly 'hover.color': {
+    readonly kind: "color";
+    readonly description: "Colour the hovered landmark turns towards, while a handler listens to the landmarks' events. Unset: the map's accent, else blue, or the buildings' one under a Buildings3D.";
+  };
+  readonly 'hover.intensity': {
+    readonly kind: "number";
+    readonly description: "How far the hovered landmark turns towards its hover colour, 0 to 1. Unset: 0.35, or the buildings' one under a Buildings3D.";
+    readonly range: KnobRange;
+  };
+  readonly 'click.color': {
+    readonly kind: "color";
+    readonly description: "Colour the clicked landmark turns towards, until the next click lands elsewhere. Unset: the map's accent, else blue, or the buildings' one under a Buildings3D.";
+  };
+  readonly 'click.intensity': {
+    readonly kind: "number";
+    readonly description: "How far the clicked landmark turns towards its click colour, 0 to 1. Unset: 0.7, or the buildings' one under a Buildings3D.";
+    readonly range: KnobRange;
+  };
+  readonly texture: {
+    readonly kind: "enum";
+    readonly description: "What the landmarks' textures add to their silhouette: mask (nothing), detail (their shading over the color) or color (their own colours instead). Unset: mask; detail under a Buildings3D; color on streetSatellite.";
+    readonly options: readonly ["mask", "detail", "color"];
+  };
+  readonly opacity: {
+    readonly kind: "number";
+    readonly description: "Opacity of the landmarks, 0 to 1. Unset: the base map's 3D buildings' opacity.";
+    readonly range: KnobRange;
+  };
+  readonly verticalGradient: {
+    readonly kind: "toggle";
+    readonly description: "Whether the landmarks' walls darken towards the ground. Unset: as the base map's 3D buildings do. No effect while a Buildings3D draws, whose walls have no gradient.";
+  };
+  readonly minZoom: {
+    readonly kind: "number";
+    readonly description: "Lowest zoom the landmarks are drawn at, 15 at the earliest, where their tiles start. Unset: the base map's 3D buildings' one.";
+    readonly range: KnobRange;
+  };
+  readonly maxZoom: {
+    readonly kind: "number";
+    readonly description: "Highest whole zoom level the landmarks are drawn at, up to the next one. Unset: the base map's 3D buildings' one, or 22 while a Buildings3D draws.";
+    readonly range: KnobRange;
+  };
+};
+/**
+ * The id of a landmarks knob, as accepted by the SDK's `setKnob` and as a key of {@link Landmarks3DConfig}.
+ *
+ * @group Landmarks 3D
+ */
+type Landmarks3DKnobId = keyof typeof landmarks3DKnobDefinitions;
+/**
+ * The value type a landmarks knob takes.
+ *
+ * @group Landmarks 3D
+ */
+type Landmarks3DKnobValueOf<ID extends Landmarks3DKnobId> = ID extends 'texture' ? LandmarkTextureUse : ID extends 'paletteMode' ? PaletteMode : KnobValueOf<(typeof landmarks3DKnobDefinitions)[ID]['kind']>;
+/**
+ * One entry of {@link landmarks3DKnobCatalogue}, with what a UI or a coding agent needs to offer the knob
+ * and validate a value for it. The SDK's `getKnob` reads the value in force.
+ *
+ * @group Landmarks 3D
+ */
+type Landmarks3DKnob = KnobEntry<Landmarks3DKnobId>;
+/**
+ * Every landmarks knob with its kind, description, range or options and, for `visible`, its default.
+ * It's static data, readable without a map.
+ *
+ * @remarks
+ * A knob is a plain value in {@link Landmarks3DConfig}, at its id's path. While unset, the colour,
+ * opacity, gradient and zoom range follow the base map's 3D buildings, and the hover and click colours
+ * the map's accent, which the SDK's `getKnob` reports.
+ *
+ * @group Landmarks 3D
+ */
+declare const landmarks3DKnobCatalogue: readonly Landmarks3DKnob[];
+/**
+ * Every landmarks knob id, in catalogue order.
+ *
+ * @group Landmarks 3D
+ */
+declare const landmarks3DKnobIds: readonly Landmarks3DKnobId[];
+//#endregion
+//#region src/surfaces/surfaceSeasons.d.ts
+/**
+ * The seasons the surfaces and the trees can be coloured for, each from the style's own colours: a
+ * season tints them, and mixes some towards colours of its own, such as snow.
+ *
+ * @group GL Surfaces
+ */
+declare const surfaceSeasons: readonly ["spring", "summer", "autumn", "winter", "snow"];
+/**
+ * One of {@link surfaceSeasons}.
+ *
+ * @group GL Surfaces
+ */
+type SurfaceSeason = (typeof surfaceSeasons)[number];
+//#endregion
+//#region src/surfaces/surfacesKnobCatalogue.d.ts
+declare const surfacesKnobDefinitions: {
+  readonly visible: {
+    readonly kind: "toggle";
+    readonly description: "The textured surfaces.";
+    readonly default: true;
+  };
+  readonly season: {
+    readonly kind: "enum";
+    readonly description: "The season every surface and the trees are coloured for, each from the style's own colours, which a map's colour knobs set. A part's own `season` takes over from it.";
+    readonly default: "spring" | "summer" | "autumn" | "winter" | "snow";
+    readonly options: readonly ["spring", "summer", "autumn", "winter", "snow"];
+  };
+  readonly 'surfaces.water.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.water.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.water.colors.shallow': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.water.colors.foam': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.water.waves.heightFactor': {
+    readonly kind: "factor";
+    readonly description: "How steep the wind waves on open water stand, times their usual, 0 leaving the water a mirror. Seen from afar, they smooth into a glitter of the sun.";
+    readonly default: 1;
+    readonly range: {
+      readonly min: 0;
+      readonly max: 3;
+      readonly step: 0.05;
+      readonly bounds: "hard-min";
+    };
+  };
+  readonly 'surfaces.water.enclosed.waves.heightFactor': {
+    readonly kind: "factor";
+    readonly description: "How steep the ripples on enclosed water stand, such as canals, ponds and harbours, times the open water's waves.";
+    readonly default: 0.3;
+    readonly range: KnobRange;
+  };
+  readonly 'surfaces.water.shore.intensity': {
+    readonly kind: "number";
+    readonly description: "How strongly an open shore shows: its shallows, the waves rolling in onto it, the breakers and their foam, 0 (none) to 1.";
+    readonly default: 1;
+    readonly range: KnobRange;
+  };
+  readonly 'surfaces.water.shore.reachMeters': {
+    readonly kind: "number";
+    readonly description: "How far out from an open shore, such as a lake or the sea, the waves turn to roll in onto it, in metres.";
+    readonly default: 160;
+    readonly range: {
+      readonly min: 0;
+      readonly max: 400;
+      readonly step: 10;
+      readonly bounds: "hard";
+    };
+  };
+  readonly 'surfaces.water.reflection.intensity': {
+    readonly kind: "number";
+    readonly description: "How much the water mirrors the sky, which grows towards the horizon as on real water, 0 (none) to 1.";
+    readonly default: 1;
+    readonly range: KnobRange;
+  };
+  readonly 'surfaces.water.glint.intensity': {
+    readonly kind: "number";
+    readonly description: "How brightly the waves catch the sun, or the moon on dark styles, 0 (none) to 1.";
+    readonly default: 1;
+    readonly range: KnobRange;
+  };
+  readonly 'surfaces.water.glint.color': {
+    readonly kind: "color";
+    readonly description: "Colour of the water's glint. Unset: sunlight on light styles and streetSatellite, a dimmer moonlight on dark ones.";
+  };
+  readonly 'surfaces.ice.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.ice.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.ice.colors.crevasses': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.ice.crevasses.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.forest.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.forest.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.forest.colors.broadleaf': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.forest.colors.conifer': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.forest.crowns.sizeFactor': {
+    readonly kind: "factor";
+    readonly description: "How wide the crowns of the forest stand, times their usual 8 m or so.";
+    readonly default: 1;
+    readonly range: KnobRange;
+  };
+  readonly 'surfaces.forest.conifer.fraction': {
+    readonly kind: "number";
+    readonly description: "The share of the forest's crowns that are conifers, 0 to 1.";
+    readonly default: 0.38;
+    readonly range: KnobRange;
+  };
+  readonly 'surfaces.grass.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.grass.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.grass.colors.lush': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.grass.colors.dry': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.grass.colors.flowers': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.grass.mown.fraction': {
+    readonly kind: "number";
+    readonly description: "The share of lawns that are mown, in stripes, rather than left long with flowers, 0 to 1.";
+    readonly default: 0.5;
+    readonly range: KnobRange;
+  };
+  readonly 'surfaces.grass.stripes.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.grass.flowers.fraction': {
+    readonly kind: "number";
+    readonly description: "How many flowers dot the unmown grass: the share of its half-metre squares holding one, 0 to 0.2.";
+    readonly default: 0.02;
+    readonly range: {
+      readonly min: 0;
+      readonly max: 0.2;
+      readonly step: 0.005;
+      readonly bounds: "hard";
+    };
+  };
+  readonly 'surfaces.scrub.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.scrub.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.scrub.colors.bushes': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.scrub.bushes.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.farmland.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.farmland.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.farmland.colors.young': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.farmland.colors.cereal': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.farmland.colors.soil': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.farmland.colors.pasture': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.farmland.colors.rapeseed': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.farmland.colors.stubble': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.farmland.colors.hedges': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.farmland.parcels.sizeFactor': {
+    readonly kind: "factor";
+    readonly description: "How large the field parcels are, times their usual 35 to 125 m across.";
+    readonly default: 1;
+    readonly range: {
+      readonly min: 0.5;
+      readonly max: 3;
+      readonly step: 0.05;
+      readonly bounds: "hard";
+    };
+  };
+  readonly 'surfaces.farmland.rows.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.farmland.hedges.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.sand.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.sand.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.sand.colors.wet': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.sand.dunes.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.sand.ripples.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.sand.wet.widthMeters': {
+    readonly kind: "number";
+    readonly description: "How far up from the water the sand is wet, in metres, about as far as the waves run.";
+    readonly default: 4;
+    readonly range: {
+      readonly min: 0;
+      readonly max: 12;
+      readonly step: 0.5;
+      readonly bounds: "hard";
+    };
+  };
+  readonly 'surfaces.mud.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.mud.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.mud.colors.wet': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.mud.puddles.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.gravel.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.gravel.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.gravel.stones.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.rock.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.rock.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.rock.ridges.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.paving.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.paving.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.paving.colors.joints': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'surfaces.paving.joints.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.urban.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.urban.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.urban.wear.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.roads.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'surfaces.roads.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'surfaces.roads.wear.intensity': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "number";
+  };
+  readonly 'trees.visible': {
+    readonly kind: "toggle";
+    readonly description: "The 3D trees standing on woods, parks, gardens, meadows, scrub, heaths, orchards, cemeteries and playgrounds, each as densely as its kind of ground grows them.";
+    readonly default: true;
+  };
+  readonly 'trees.densityFactor': {
+    readonly kind: "factor";
+    readonly description: "How many trees stand on each kind of ground, times its own density: wild woods stay the densest, parks and meadows open.";
+    readonly default: 1;
+    readonly range: KnobRange;
+  };
+  readonly 'trees.sizeFactor': {
+    readonly kind: "factor";
+    readonly description: "How tall the trees and bushes stand, times their usual height.";
+    readonly default: 1;
+    readonly range: KnobRange;
+  };
+  readonly 'trees.species.broadleaf.shareFactor': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "factor";
+  };
+  readonly 'trees.species.conifer.shareFactor': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "factor";
+  };
+  readonly 'trees.species.columnar.shareFactor': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "factor";
+  };
+  readonly 'trees.species.umbrella.shareFactor': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "factor";
+  };
+  readonly 'trees.species.bush.shareFactor': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "number" | "factor">;
+    default?: number;
+    range: KnobRange;
+  } & {
+    kind: "factor";
+  };
+  readonly 'trees.tracks.intensity': {
+    readonly kind: "number";
+    readonly description: "How strongly the roads, paths, railways and streams through a wood show over the crowns standing in front of them, 0 (hidden behind them) to 1.";
+    readonly default: 0.6;
+    readonly range: KnobRange;
+  };
+  readonly 'trees.minZoom': {
+    readonly kind: "number";
+    readonly description: "The zoom from which the trees grow in, reaching their full height three quarters of a zoom later.";
+    readonly default: 15;
+    readonly range: {
+      readonly min: 13;
+      readonly max: 19;
+      readonly step: 0.25;
+      readonly bounds: "hard";
+    };
+  };
+  readonly 'trees.season': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "enum">;
+    options: readonly string[];
+    default?: string;
+  } & {
+    kind: "enum";
+  };
+  readonly 'trees.colors.broadleaf': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'trees.colors.conifer': {
+    description: string;
+  } & {
+    kind: Extract<KnobKind, "color">;
+  } & {
+    kind: "color";
+  };
+  readonly 'trees.shadows.intensity': {
+    readonly kind: "number";
+    readonly description: "How dark the shadows the trees cast on the ground are, away from the sun, 0 (none) to 1.";
+    readonly default: 0.55;
+    readonly range: KnobRange;
+  };
+  readonly 'light.direction': {
+    readonly kind: "number";
+    readonly description: "Direction the sun comes from, in degrees clockwise from north. It lights the trees and dunes, casts the trees' shadows, and sets where the water glints. Unset: the map's light where one is placed, as the styling module's `view.light` knobs do, else a day sun on light styles and satellite imagery, and a night one on dark styles.";
+    readonly range: KnobRange;
+  };
+  readonly 'light.altitude': {
+    readonly kind: "number";
+    readonly description: "Height of the sun above the horizon, in degrees (90 = overhead). Unset: the map's light, as for `light.direction`.";
+    readonly range: KnobRange;
+  };
+  readonly 'sky.color': {
+    readonly kind: "color";
+    readonly description: "Colour of the sky overhead, which the water mirrors where it faces up. Unset: the map's sky colour where the style sets one, else a day sky on light styles and satellite imagery, and a night sky on dark styles.";
+  };
+  readonly 'sky.horizonColor': {
+    readonly kind: "color";
+    readonly description: "Colour of the sky at the horizon, which the far water mirrors. Unset: the map's horizon colour where the style sets one, else a day or a night horizon, as for `sky.color`.";
+  };
+  readonly 'wind.direction': {
+    readonly kind: "number";
+    readonly description: "Direction the wind blows from, in degrees clockwise from north. The waves and the sand ripples lie across it.";
+    readonly default: 225;
+    readonly range: KnobRange;
+  };
+  readonly 'wind.speedFactor': {
+    readonly kind: "factor";
+    readonly description: "How fast the waves, the grass and the trees move, 0 holding them still. While nothing moves, the map draws no frames for them.";
+    readonly default: 1;
+    readonly range: {
+      readonly min: 0;
+      readonly max: 4;
+      readonly step: 0.1;
+      readonly bounds: "hard-min";
+    };
+  };
+};
+/**
+ * The id of a surfaces knob, as accepted by the SDK's `setKnob` and as a path into {@link GLSurfacesConfig}.
+ *
+ * @group GL Surfaces
+ */
+type GLSurfacesKnobId = keyof typeof surfacesKnobDefinitions;
+type KindOf<ID extends GLSurfacesKnobId> = (typeof surfacesKnobDefinitions)[ID]['kind'];
+/**
+ * The value type a surfaces knob takes.
+ *
+ * @group GL Surfaces
+ */
+type GLSurfacesKnobValueOf<ID extends GLSurfacesKnobId> = ID extends 'season' | `${string}.season` ? SurfaceSeason : KnobValueOf<KindOf<ID>>;
+/**
+ * One entry of {@link glSurfacesKnobCatalogue}, with what a UI or a coding agent needs to offer the
+ * knob and validate a value for it. The SDK's `getKnob` reads the value in force.
+ *
+ * @group GL Surfaces
+ */
+type GLSurfacesKnob = KnobEntry<GLSurfacesKnobId>;
+/**
+ * Every surfaces knob id, in catalogue order.
+ *
+ * @group GL Surfaces
+ */
+declare const glSurfacesKnobIds: GLSurfacesKnobId[];
+/**
+ * Every surfaces knob with its kind, description, range and default. It's static data, readable
+ * without a map.
+ *
+ * @remarks
+ * A knob is a plain value in {@link GLSurfacesConfig}, at its id's path. Some knobs have no default,
+ * and take a value of their own while unset, which the SDK's `getKnob` reports:
+ * - A part's season, such as `surfaces.water.season`, takes `season`.
+ * - A role colour, such as `surfaces.farmland.colors.cereal`, takes the style's colour as the season
+ *   shades it.
+ * - The light, sky and glint knobs take the map's light and sky, or the style's light or dark theme.
+ *
+ * @group GL Surfaces
+ */
+declare const glSurfacesKnobCatalogue: readonly GLSurfacesKnob[];
+//#endregion
+export { facadePatterns as C, paletteModes as E, buildingsPresets as S, paletteMapColors as T, Buildings3DKnobValueOf as _, glSurfacesKnobIds as a, buildings3DKnobCatalogue as b, LandmarkTextureUse as c, Landmarks3DKnobValueOf as d, landmarkTextureUses as f, Buildings3DKnobId as g, Buildings3DKnob as h, glSurfacesKnobCatalogue as i, Landmarks3DKnob as l, landmarks3DKnobIds as m, GLSurfacesKnobId as n, SurfaceSeason as o, landmarks3DKnobCatalogue as p, GLSurfacesKnobValueOf as r, surfaceSeasons as s, GLSurfacesKnob as t, Landmarks3DKnobId as u, BuildingsPreset as v, PaletteMode as w, buildings3DKnobIds as x, FacadePattern as y };