@kalyptos/narcissus 0.1.2 → 0.2.0

package/README.md

@@ -43,6 +43,7 @@ npx @kalyptos/narcissus publish ./world remote:bucket/world
 
 - [docs/format.md](docs/format.md): the specification of Guldmund Trees
 - [docs/hosting.md](docs/hosting.md): how to serve, publish and show a world
+- [docs/embedding.md](docs/embedding.md): the hooks for a page that embeds the viewer: layers, masks, picking, graphics and the camera
 - [docs/architecture.md](docs/architecture.md): how the code is built, and how to add a source or a plugin
 - [CONTRIBUTING.md](CONTRIBUTING.md)
 

package/dist/cli/main.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { t as e } from "../ports-DZRKjdYD.js";
 import { t } from "../http-DL7R39Nc.js";
-import { a as n, r, t as i } from "../tools-NykPVccD.js";
+import { a as n, r, t as i } from "../tools-DnfuHeoO.js";
 import { createWriteStream as a, statSync as o } from "node:fs";
 import { pipeline as s } from "node:stream/promises";
 import { parseArgs as c } from "node:util";

package/dist/controls/controls.d.ts

@@ -10,13 +10,21 @@ export declare function smooth(shown: Pose, target: Pose, dt: number, ground: Gr
 /** map camera: left drag orbits, right/middle/shift drag pans the ground, wheel zooms, f flies */
 export declare class Controls {
     #private;
+    /** false ignores pointer, wheel and key input; flights still run */
+    enabled: boolean;
     constructor(canvas: HTMLCanvasElement, engine: Engine, ground: Ground, pose: Pose, limits?: Limits);
     /** the pose the camera shows now */
     get pose(): Pose;
-    /** fires on every frame the user moves the camera */
-    onChange(fn: () => void): () => void;
+    /** fires with the shown pose each time it changes, from input, flights and jumps */
+    onChange(fn: (pose: Pose) => void): () => void;
     /** puts the focus on a ground point; heading and tilt stay, a far view closes in */
     moveTo(e: number, n: number): void;
+    /** shows the pose at once; fields left out stay */
+    jump(pose: Partial<Pose>): void;
+    /** flies to the pose, fields left out staying; false when input, another move, the signal or destroy cuts it short */
+    flyTo(pose: Partial<Pose>, options?: {
+        signal?: AbortSignal;
+    }): Promise<boolean>;
     destroy(): void;
 }
 export {};

package/dist/controls/pose.d.ts

@@ -1,4 +1,4 @@
-import type { Camera, World } from '../engine/index.ts';
+import type { Box, Camera, World } from '../engine/index.ts';
 /** easting, northing and height in world coordinates, metres */
 export interface Point {
     e: number;
@@ -61,5 +61,12 @@ export declare function fly(p: Pose, right: number, forward: number, up: number)
 export declare function pan(p: Pose, right: number, forward: number): Pose;
 /** moves a toward b by fraction t: focus linearly, yaw the short way round, dist in log space */
 export declare function blend(a: Pose, b: Pose, t: number): Pose;
+/** a pose that shows all of box: focus at its centre, heading and tilt from pose */
+export declare function fit(box: Box, pose: Pose): Pose;
+/** an eased path from one pose to another over ms; a long hop rises so the view keeps its bearings */
+export declare function flight(from: Pose, to: Pose): {
+    ms: number;
+    at(t: number): Pose;
+};
 /** close enough that the rest of the way is not visible */
 export declare function settled(a: Pose, b: Pose): boolean;