spacemap 0.1.22 → 0.1.25

package/index.d.ts

@@ -180,6 +180,8 @@ export declare interface CameraPose {
 /** The camera as it stands. `body` is what it orbits, which is also what the
  *  map draws in most detail. */
 export declare interface CameraState extends Required<CameraAngles> {
+    /** What `lat`, `lon` and `distanceKm` are measured from: the focused body,
+     *  or the one a landed probe in focus stands on. */
     body: string;
     lat: number;
     lon: number;
@@ -189,7 +191,7 @@ export declare interface CameraState extends Required<CameraAngles> {
 /** Somewhere to move the camera to. What is left out is left as it is. */
 export declare interface CameraTarget extends CameraOptions {
     /** A feature on `body` to look at, rather than the body as a whole. Its
-     *  size frames the view, so `distanceKm` is not needed. */
+     *  size frames the view: `lat`, `lon` and `distanceKm` are not read. */
     feature?: FeatureRef;
 }
 
@@ -238,6 +240,15 @@ export declare interface ClockState {
     live: boolean;
 }
 
+/** The nearest the camera comes to a body, in km. Both change as the body's
+ *  relief and finer imagery load. */
+export declare interface ClosestApproach {
+    /** From the body's centre to its ground under the camera. */
+    groundKm: number;
+    /** How far over that ground the camera stops. */
+    clearanceKm: number;
+}
+
 /** What both maps take: where to put it, where its data comes from, and what
  *  language to read it in. */
 declare interface CommonOptions {
@@ -931,7 +942,7 @@ export declare interface FocusChange {
     body: Body_2 | undefined;
     /** The first settle after boot. */
     initial: boolean;
-    /** The camera orbits a surface feature; `body` is its host. */
+    /** The camera moved onto a surface feature of `body`. */
     feature: boolean;
 }
 
@@ -1994,6 +2005,10 @@ export declare class SpaceMap {
     /* Excluded from this release type: webglError */
     /* Excluded from this release type: contextLost */
     /* Excluded from this release type: focusedBody */
+    /* Excluded from this release type: cameraBody */
+    /** A move onto a surface feature is under way: the focus it hands the
+     *  host is that move's. */
+    private movingToFeature;
     /* Excluded from this release type: attribution */
     /** Objects of the host's own: a spacecraft, a station, a body the export
      *  has never heard of. */
@@ -2050,7 +2065,8 @@ export declare class SpaceMap {
     /** What the map knows about an object it has loaded; undefined for one it
      *  has not, which for a small body may simply mean not yet. */
     getBody(id: string): Body_2 | undefined;
-    /** The object the camera orbits. A surface feature reports its host body. */
+    /** The object in view. For a landed probe this is the probe, and the
+     *  camera orbits the body it stands on. */
     getFocusedBody(): Body_2 | undefined;
     /** Ids of the objects orbiting `id` that this map has loaded. Loading is
      *  driven by focus and by the clock, so the list grows as the reader moves. */
@@ -2123,9 +2139,10 @@ export declare class SpaceMap {
     private placedAncestor;
     /** The renderer, once the map draws. Null when it never will. */
     private rendering;
-    /** Turn to a feature on the body already framed, without travelling to it —
-     *  the move a click on its label makes. Resolves when the camera comes
-     *  round. */
+    /** Turn to a feature on the body already framed, without travelling to it.
+     *  This is the move a click on its label makes. On another body the camera
+     *  flies to the feature, as {@link SpaceMap.flyTo} does. Resolves when the
+     *  camera comes round. */
     panTo(target: FeatureTarget): Promise<void>;
     /**
      * Put the camera at a place at once, with no flight. Use it to restore a
@@ -2168,6 +2185,10 @@ export declare class SpaceMap {
     setLimits(limits: CameraLimits): this;
     /** The limits as they stand. */
     getLimits(): CameraLimits;
+    /** How near the map lets the camera come to what it orbits, where the
+     *  camera is now, whatever {@link SpaceMap.setLimits} adds. Null while
+     *  nothing is focused. */
+    getClosestApproach(): ClosestApproach | null;
     private applyLimits;
     private applyGestures;
     /* Excluded from this release type: setStarSelectEnabled */