spacemap 0.1.19 → 0.1.21

package/index.d.ts

@@ -291,6 +291,7 @@ export declare interface CoreMessages {
     attribution_orbits: () => string;
     attribution_imagery: () => string;
     attribution_stars: () => string;
+    attribution_constellations: () => string;
     credits_see_all: () => string;
     layer_surface: () => string;
     layer_clouds: () => string;
@@ -953,6 +954,9 @@ export declare interface Host {
     messages: CoreMessages;
     /** Link target of a body's scene label. */
     bodyHref: (id: string, name: string) => string;
+    /** Link target of a collection page's scene label, or of a figure of the
+     *  sky culture `slug`. */
+    groupHref: (slug: string, name: string, figure?: string | null) => string;
     /** How far down the `distribution` ladder this embed may draw surface maps,
      *  panoramas, craft models and stars (docs/export-format/textures.md). `open` is
      *  what anyone may serve, `non-commercial` adds works whose licence bars
@@ -1101,6 +1105,12 @@ export declare interface MapEvents {
     camera: (view: CameraState) => void;
     /** A nomenclature label was clicked; carries what a fly-to needs. */
     featureselect: (e: FeatureSelect) => void;
+    /** A constellation's name was clicked; `slug` is its collection page. */
+    constellationselect: (e: {
+        slug: string;
+        figure: string;
+        name: string;
+    }) => void;
     /** User-promoted bodies that can be cleared (the focused one excluded). */
     userpromoted: (count: number) => void;
     contextlost: () => void;
@@ -1323,6 +1333,18 @@ export declare interface OutOfRangeNotice {
     } | null;
 }
 
+/** The sky of a page. It leaves the reader's own layer settings alone. */
+export declare interface PageSky {
+    /** The culture to draw. */
+    culture: string;
+    /** The figure to aim at, by its `slug`. */
+    figure: string | null;
+    /** Aim at once: the page opened the map. */
+    opening: boolean;
+    /** The reader turned the layer off on this page. */
+    hidden: boolean;
+}
+
 /** The product id, which names one panorama and no other. A stop held for
  *  days leaves several mosaics sharing a time and a place, so the time and
  *  place together do not. */
@@ -1785,11 +1807,22 @@ export declare interface SamplesOptions {
  * this structurally; an embed passes its own or takes the default. One per
  * page, registered through {@link setSceneSettings}: the tier and quality
  * helpers run deep in material code with no map instance at hand.
+ *
+ * A field added after a release is optional, so a host's own object stays
+ * valid. {@link defaultSceneSettings} shows the default of each.
  */
 export declare interface SceneSettings {
     resolvedReducedMotion: boolean;
     viewMode: 'map' | 'immersive';
     showClouds: boolean;
+    showConstellations?: boolean;
+    /** Key of the sky culture the constellation layer draws. */
+    constellationCulture?: string;
+    /** What a constellation or culture page shows of the sky, for that view. */
+    pageSky?: PageSky | null;
+    /** The constellation layer hides the asteroids, comets and probes, and the
+     *  cloud of Earth satellites, which bury its faint figures. */
+    clearSky?: boolean;
     showAtmospheres: boolean;
     atmosphereQuality: AtmosphereQualityTier;
     atmosphereAutoTier: ResolvedAtmosphereTier | null;
@@ -1844,9 +1877,13 @@ export declare interface ShapeStyle {
 /**
  * Simulation clock. Advances Julian Date by real elapsed time × timeScale;
  * timeScale === 0 means paused. `play()` re-resumes the previous non-zero scale.
+ *
+ * The clock holds only dates that a `Date` holds. A seek past them stops it at
+ * the end of that range.
  */
 export declare class SimClock {
     jd: number;
+    /* Excluded from this release type: askedJd */
     timeScale: number;
     direction: 1 | -1;
     /* Excluded from this release type: seeked */
@@ -1865,6 +1902,8 @@ export declare class SimClock {
     private arrivals;
     constructor(initialJd: number, live?: boolean);
     /* Excluded from this release type: tick */
+    /** Put the clock on `jd`, or on the nearest date it can hold. */
+    private move;
     /* Excluded from this release type: setBoundaryStops */
     /** Caller passes the unsigned magnitude; direction is applied here. */
     setTimeScale(magnitude: number): void;
@@ -1883,6 +1922,7 @@ export declare class SimClock {
     private settleAfterPause;
     /* Excluded from this release type: sweepTo */
     pause(): void;
+    /* Excluded from this release type: hold */
     play(): void;
     /** Back to wall-clock time; live again only if playback is at 1×, since a
      *  paused or fast clock drifts off it at once. */
@@ -1943,6 +1983,7 @@ export declare class SpaceMap {
     /** Whether a click on a star takes the focus. A host's map has no page to
      *  open for a star, so it is off unless the app turns it on. */
     private starSelectEnabled;
+    private tripPins;
     private limits;
     private initialFocusPending;
     private pendingFocusId;
@@ -1976,7 +2017,8 @@ export declare class SpaceMap {
     /** Kilometres between two places, as the last frame drew them: a body's
      *  centre, a point on its surface, anything an anchor names. Null while
      *  either end is on a body this map has not loaded, or one that is nowhere
-     *  at that date. */
+     *  at that date, and while a point on a surface is on a body that may yet
+     *  turn (see {@link getSubsolarPoint}). */
     distanceKm(from: Anchor, to: Anchor): number | null;
     /** The same measure with its direction kept: from one place to the other,
      *  in kilometres on ecliptic J2000 axes. What a held camera's `up` is made
@@ -1985,7 +2027,10 @@ export declare class SpaceMap {
     /** Where on `id` the Sun is overhead, as the last frame drew it: the middle
      *  of the lit half, in the frame a surface anchor is placed in. Null for a
      *  body not loaded, and until the map has read how it spins, which it does
-     *  once the camera is on the body or its system. */
+     *  once the camera is on the body or its system. On a bad line that can
+     *  take longer: a moon's spin can come before the file of the terms that
+     *  sway it, and the map asks for that file again until it has it, or the
+     *  data host says it has none. */
     getSubsolarPoint(id: string): LonLat | null;
     /** Whether this map draws surface tiles at all. False where no tile host is
      *  set, and on a device short of memory: every body then shows its
@@ -2043,6 +2088,7 @@ export declare class SpaceMap {
      * data of the body does not load. A later move stops this move.
      */
     jumpTo(target: JumpTarget): Promise<void>;
+    /* Excluded from this release type: haloOnScreen */
     /** Whether `id` is in the scene, with a place at the date it shows. */
     private placedNow;
     /** The placement of {@link jumpTo}, on a body in the scene. */
@@ -2079,6 +2125,7 @@ export declare class SpaceMap {
     private applyLimits;
     private applyGestures;
     /* Excluded from this release type: setStarSelectEnabled */
+    /* Excluded from this release type: setTripPins */
     /** A wheel the page is to keep never reaches the orbit controls. It is not
      *  cancelled, so the page scrolls as it would over any other element. */
     private readonly onWheelCapture;
@@ -2101,6 +2148,9 @@ export declare class SpaceMap {
     /* Excluded from this release type: snapToBody */
     /* Excluded from this release type: snapToBodyFrom */
     /* Excluded from this release type: snapToBodyFacing */
+    /* Excluded from this release type: tripView */
+    /* Excluded from this release type: tripBallView */
+    private vantageView;
     /* Excluded from this release type: focusOnFeature */
     /* Excluded from this release type: setFocusTarget */
     /** Where the camera is and what it orbits, as anchors a host can store,