spacemap 0.1.12 → 0.1.14

package/index.d.ts

@@ -237,14 +237,15 @@ declare interface CommonOptions {
     locale?: string;
     /** Replaces the English wording the map renders itself, one key at a time. */
     messages?: Partial<CoreMessages>;
-    /** Draw the imagery whose licence forbids commercial reuse — off by
-     *  default, because only the page knows whether it is a commercial one.
-     *  Turning it on covers the Uranus map, which otherwise renders in its
-     *  fallback colour, and the Huygens descent panorama of Titan, which is
-     *  otherwise a place on the map with no sphere to open; the page accepts
-     *  each one's terms by asking for it, and the credit line naming its
-     *  author is a condition of them, not a courtesy. Some maps are ours for
-     *  spacemap.co alone and this does not reach them. */
+    /** Draw the imagery and models whose licence forbids commercial reuse —
+     *  off by default, because only the page knows whether it is a commercial
+     *  one. Turning it on covers the Uranus map, which otherwise renders in
+     *  its fallback colour, the Huygens descent panorama of Titan, which is
+     *  otherwise a place on the map with no sphere to open, and the models of
+     *  a few craft (Buran, Vostok, Lunokhod), which otherwise stay markers;
+     *  the page accepts each one's terms by asking for it, and the credit line
+     *  naming its author is a condition of them, not a courtesy. Some maps are
+     *  ours for spacemap.co alone and this does not reach them. */
     includeNonCommercial?: boolean;
 }
 
@@ -478,6 +479,8 @@ export declare class FlatMap {
     private projectionOptions;
     private view;
     private limits;
+    /** True when the host gave no `maxZoom`. The map then sets its own limit. */
+    private ownMaxZoom;
     /** The reader has moved the view since the last programmatic one, so the
      *  limits apply to it. A {@link setView} lands where it was told. */
     private limitsArmed;
@@ -493,6 +496,10 @@ export declare class FlatMap {
     /** Pictures the export does not have. Remembered, or every pan would ask
      *  for them again and report the same failure. */
     private readonly missing;
+    /** The tile windows of each picture layer that has a pyramid. */
+    private readonly tiles;
+    /** `performance.now()` of the last tile plan. */
+    private plannedAt;
     /** Bumped whenever the map moves to another body, so work started for the
      *  one being left can tell that it is no longer wanted. */
     private generation;
@@ -598,13 +605,15 @@ export declare class FlatMap {
     setView(view: Partial<FlatViewState>): void;
     /**
      * Replace the reader's limits, whole. What the new set leaves out is
-     * unrestricted again, except `maxZoom`, which goes back to 16.
+     * unrestricted again, except `maxZoom`, which goes back to the map's own:
+     * 16, or more where the surface has tiles.
      *
      * Limits gate reader input only: {@link setView} lands where it was told,
      * and the reader's next gesture brings the view back inside.
      */
     setLimits(limits: FlatMapLimits): this;
-    /** The limits as they stand. */
+    /** The limits as they stand. Where the host gave no `maxZoom`, it is the
+     *  map's own for the place in the middle of the frame. */
     getLimits(): FlatMapLimits;
     /** The moment the map is of. Moves the clouds and, on Earth, the season. */
     setTime(jd: number): void;
@@ -660,6 +669,33 @@ export declare class FlatMap {
     private rasterFor;
     /** Release every claim this map holds on the shared pictures. */
     private dropTextures;
+    /** The tiles of a layer, where this host draws them and the pyramid holds
+     *  more than the picture under it. */
+    private tilesOf;
+    /** The first level that holds more than the picture under the tiles. An
+     *  equirectangular map draws that picture whole, and the others sample a
+     *  copy of a limited width. */
+    private firstTileLevel;
+    /** What the tile plan reads of a frame. `density` is the number of drawn
+     *  pixels for each pixel of `viewport`. Undefined when the middle of the
+     *  frame is off the world. */
+    private frameSample;
+    /** Ask for the tile windows of the frame, layer by layer. */
+    private planTiles;
+    /** Whether the reader can move the map. */
+    private moves;
+    private dropTiles;
+    /**
+     * How far in the reader can go when the host gives no limit. Where tiles
+     * serve, it is the zoom that draws the finest tiles under the middle of the
+     * frame at `MAX_TILE_STRETCH`.
+     */
+    private pictureMaxZoom;
+    /** The limits that hold the view. Where tiles serve, the map's own zoom
+     *  limit changes from place to place. It then only stops the way in, and
+     *  does not pull back a view that is past it. */
+    private heldLimits;
+    /* Excluded from this release type: tileStepDeg */
     private viewport;
     /** Draw on the next frame. Repeated calls in one frame draw once. */
     render(): void;
@@ -735,6 +771,7 @@ export declare type FlatMapGesture = 'dragPan' | 'scrollZoom';
 export declare interface FlatMapLimits {
     /** 1 is the whole world; the reader may not go under it either way. */
     minZoom?: number;
+    /** Left out, the map sets its own: 16, or more where the surface has tiles. */
     maxZoom?: number;
     /** The band of the surface the middle of the frame may sit in. A longitude
      *  band may run through the antimeridian: 170 to −170 is the twenty degrees
@@ -907,11 +944,12 @@ export declare interface Host {
     messages: CoreMessages;
     /** Link target of a body's scene label. */
     bodyHref: (id: string, name: string) => string;
-    /** How far down the `distribution` ladder this embed may draw surface maps
-     *  (docs/export-format/textures.md). `open` is the maps anyone may serve,
-     *  `non-commercial` adds those whose licence bars commercial reuse, and
-     *  `site-only` adds those cleared for spacemap.co alone. A bare embed gets
-     *  `open`: it cannot accept a licence for the page it sits on. */
+    /** How far down the `distribution` ladder this embed may draw surface maps,
+     *  panoramas and craft models (docs/export-format/textures.md). `open` is
+     *  what anyone may serve, `non-commercial` adds works whose licence bars
+     *  commercial reuse, and `site-only` adds those cleared for spacemap.co
+     *  alone. A bare embed gets `open`: it cannot accept a licence for the page
+     *  it sits on. */
     textures: TextureDistribution;
 }
 
@@ -972,8 +1010,8 @@ export declare type Interpolation =
 *  track means by a straight line. */
 | 'geodesic';
 
-/** Whether a stop has a sphere to open, as against a place on the traverse:
- *  one exists, and this host's terms reach it. */
+/** True when the terms of this host allow the sphere of the stop, so the view
+ *  can open it. */
 export declare function isViewable(entry: PanoramaEntry): boolean;
 
 /** Convert a Julian Date to a JS Date. */
@@ -1317,9 +1355,8 @@ export declare interface PanoramaEntry {
     altitude_m?: number;
     title?: string;
     /** Image azimuth of true north, degrees clockwise from the left edge.
-     *  Zero, and meaningless, where `orientation` is `unknown`; absent with
-     *  the rest of the sphere's geometry where the imagery is withheld. */
-    north_offset_deg?: number;
+     *  Zero, and meaningless, where `orientation` is `unknown`. */
+    north_offset_deg: number;
     /** How north was established, absent where the archive itself states it.
      *  `unknown` means the sphere sits at an arbitrary azimuth, so nothing
      *  may be drawn or written as a heading. The full set `export/panoramas.py`
@@ -1342,9 +1379,6 @@ export declare interface PanoramaEntry {
     credit?: string;
     credit_url?: string;
     source_url?: string;
-    /** `withheld` where the release's reuse terms are unsettled: the stop is
-     *  published as a place and a date, and no texture exists to fetch. */
-    imagery?: 'withheld';
     /** How far down the host's texture ladder this sphere may be drawn; absent
      *  where its terms allow any use. */
     distribution?: TextureDistribution;
@@ -1359,9 +1393,6 @@ export declare interface PanoramaMissionSummary {
     count: number;
     first_time: string;
     last_time: string;
-    /** False where no stop on the traverse publishes a sphere: the places are
-     *  on the map, and there is nothing to open. */
-    imagery?: boolean;
 }
 
 export declare class PanoramaView {
@@ -2360,8 +2391,9 @@ export declare type SystemMapView = {
 /** Small bodies inside Jupiter's orbit, or from it outward. */
 export declare type SystemMapZone = 'inner' | 'outer';
 
-/** Who may serve a surface map, widest first. A body whose map this embed may
- *  not draw renders in its fallback colour, as an untextured body does. */
+/** Who may serve a work, widest first. A body whose map this embed may not
+ *  draw renders in its fallback colour, as an untextured body does; a craft
+ *  whose model it may not draw stays a marker. */
 declare type TextureDistribution = 'open' | 'non-commercial' | 'site-only';
 
 /**