@snaptrude/plugin-core 0.10.0 → 1.0.0

package/dist/api/analysis/daylight.d.ts

@@ -149,8 +149,8 @@ export type PluginDaylightMetric = z.infer<typeof PluginDaylightMetric>;
 export declare const PluginDaylightRunStatus: z.ZodEnum<{
     complete: "complete";
     failed: "failed";
-    running: "running";
     cancelled: "cancelled";
+    running: "running";
 }>;
 export type PluginDaylightRunStatus = z.infer<typeof PluginDaylightRunStatus>;
 /**
@@ -419,8 +419,8 @@ export type PluginDaylightSensorRecord = z.infer<typeof PluginDaylightSensorReco
  */
 export declare const PluginDaylightAggregateScope: z.ZodEnum<{
     storey: "storey";
-    space: "space";
     project: "project";
+    space: "space";
 }>;
 export type PluginDaylightAggregateScope = z.infer<typeof PluginDaylightAggregateScope>;
 /**
@@ -438,8 +438,8 @@ export type PluginDaylightAggregateScope = z.infer<typeof PluginDaylightAggregat
 export declare const PluginDaylightAggregate: z.ZodObject<{
     scope: z.ZodEnum<{
         storey: "storey";
-        space: "space";
         project: "project";
+        space: "space";
     }>;
     id: z.ZodNullable<z.ZodString>;
     analysisAreaM2: z.ZodNumber;
@@ -521,8 +521,8 @@ export declare const PluginDaylightResults: z.ZodObject<{
     status: z.ZodEnum<{
         complete: "complete";
         failed: "failed";
-        running: "running";
         cancelled: "cancelled";
+        running: "running";
     }>;
     runId: z.ZodOptional<z.ZodString>;
     sensors: z.ZodArray<z.ZodObject<{
@@ -540,8 +540,8 @@ export declare const PluginDaylightResults: z.ZodObject<{
     aggregates: z.ZodArray<z.ZodObject<{
         scope: z.ZodEnum<{
             storey: "storey";
-            space: "space";
             project: "project";
+            space: "space";
         }>;
         id: z.ZodNullable<z.ZodString>;
         analysisAreaM2: z.ZodNumber;

package/dist/api/analysis/solar.d.ts

@@ -70,8 +70,8 @@ export declare abstract class PluginAnalysisSolarApi {
 export declare const PluginSolarRunStatus: z.ZodEnum<{
     complete: "complete";
     failed: "failed";
-    running: "running";
     cancelled: "cancelled";
+    running: "running";
 }>;
 export type PluginSolarRunStatus = z.infer<typeof PluginSolarRunStatus>;
 /**
@@ -198,8 +198,8 @@ export declare const PluginSolarSampleGridResult: z.ZodObject<{
     status: z.ZodEnum<{
         complete: "complete";
         failed: "failed";
-        running: "running";
         cancelled: "cancelled";
+        running: "running";
     }>;
     mode: z.ZodEnum<{
         range: "range";

package/dist/api/core/camera/index.d.ts

@@ -9,6 +9,18 @@ import { Vec3Handle } from "../../../handles";
  * canvas view menu and the 2D/3D toggle. Like {@linkcode PluginZoomApi}, these
  * are transient VIEW-STATE changes: they are not model edits, so they are not
  * write-gated and are not undoable. Accessed via `snaptrude.core.camera`.
+ *
+ * Read and set the full camera pose (`getPose`/`setPose`), walk and turn it the
+ * way the arrow keys do (`move`/`rotate`), and read or change the arrow-key
+ * navigation settings (`getNavigationSettings`/`updateNavigationSettings`).
+ * Positions are world coordinates in internal `babylon` units (1 unit =
+ * 0.254 m, Y up); yaw is degrees clockwise from +z seen from above, pitch is
+ * degrees above level.
+ *
+ * While Present mode is open these calls set the Design frame a view saved in
+ * Present (`presentation.views.create`) is taken from; they never move the
+ * Present sheet canvas. To pan, zoom or screenshot the Present canvas, use
+ * {@linkcode PluginPresentationCameraApi} (`presentation.camera`).
  */
 export declare abstract class PluginCameraApi {
     constructor();
@@ -16,6 +28,10 @@ export declare abstract class PluginCameraApi {
      * Point the camera: place its eye at `eye` looking toward `target` (world
      * coordinates, internal `babylon` units). View-state only — not undoable.
      *
+     * While Present is open this sets the Design frame a view saved in Present
+     * is taken from; it never moves the Present sheet canvas; use
+     * `presentation.camera` for that.
+     *
      * @param eye - Camera position as a {@linkcode Vec3Handle}
      * @param target - Point the camera looks at as a {@linkcode Vec3Handle}
      * @returns `true` once the camera has been positioned.
@@ -38,6 +54,10 @@ export declare abstract class PluginCameraApi {
      * perspective) view. Mirrors the canvas view menu. View-state only — not
      * undoable. The orthographic presets exit 2D mode first if needed.
      *
+     * While Present is open this sets the Design frame a view saved in Present
+     * is taken from; it never moves the Present sheet canvas; use
+     * `presentation.camera` for that.
+     *
      * @param view - The standard view to snap to ({@linkcode PluginStandardView})
      * @returns `true` once the view has been applied.
      *
@@ -53,11 +73,31 @@ export declare abstract class PluginCameraApi {
      * ```
      */
     abstract setStandardView(view: PluginStandardView): PluginApiReturn<boolean>;
+    /**
+     * Get the current camera mode. Paired with {@linkcode PluginCameraApi.setMode}.
+     *
+     * @returns `"2d"` when the editor is in plan view, `"3d"` otherwise.
+     *
+     * @examplePrompt Am I in 2D or 3D?
+     * @examplePrompt What view mode is the editor in?
+     *
+     * # Example
+     * ```ts
+     * if ((await snaptrude.core.camera.getMode()) === "2d") {
+     *   await snaptrude.core.camera.setMode("3d")
+     * }
+     * ```
+     */
+    abstract getMode(): PluginApiReturn<PluginCameraMode>;
     /**
      * Toggle the modelling mode between `2d` (plan) and `3d`. Mirrors the canvas
      * 2D/3D toggle: `3d` enters the isometric perspective view, `2d` drops to the
      * orthographic plan of the active storey. View-state only — not undoable.
      *
+     * While Present is open this sets the Design frame a view saved in Present
+     * is taken from; it never moves the Present sheet canvas; use
+     * `presentation.camera` for that.
+     *
      * @param mode - `"2d"` or `"3d"` ({@linkcode PluginCameraMode})
      * @returns `true` once the mode switch has been requested.
      *
@@ -100,6 +140,10 @@ export declare abstract class PluginCameraApi {
      * `"orthographic"` is accepted as a no-op, while `"perspective"` is
      * rejected — switch to 3D first via `setMode("3d")`.
      *
+     * While Present is open this sets the Design frame a view saved in Present
+     * is taken from; it never moves the Present sheet canvas; use
+     * `presentation.camera` for that.
+     *
      * @param projection - `"perspective"` or `"orthographic"` ({@linkcode PluginCameraProjection})
      * @returns `true` once the projection has been applied.
      *
@@ -120,6 +164,10 @@ export declare abstract class PluginCameraApi {
      * action. View-state only — not undoable. Canonical home of the zoom-extents
      * read (the deprecated `core.zoom.extents`).
      *
+     * While Present is open this sets the Design frame a view saved in Present
+     * is taken from; it never moves the Present sheet canvas; use
+     * `presentation.camera` for that.
+     *
      * @returns `true` once the camera has been framed to the scene.
      *
      * @examplePrompt Zoom out so I can see the whole model
@@ -138,6 +186,10 @@ export declare abstract class PluginCameraApi {
      * undoable. Canonical home of the zoom-to-selection read (the deprecated
      * `core.zoom.selection`).
      *
+     * While Present is open this sets the Design frame a view saved in Present
+     * is taken from; it never moves the Present sheet canvas; use
+     * `presentation.camera` for that.
+     *
      * @returns `true` if there was a selection to frame; `false` if nothing is
      *   selected (no-op).
      *
@@ -152,6 +204,162 @@ export declare abstract class PluginCameraApi {
      * ```
      */
     abstract zoomSelection(): PluginApiReturn<boolean>;
+    /**
+     * Read where the camera is and where it looks: the eye and target positions
+     * (world coordinates, internal `babylon` units), the view direction as yaw
+     * and pitch, the vertical field of view, the projection and the 2D/3D mode.
+     * Paired with {@linkcode PluginCameraApi.setPose}.
+     *
+     * @returns The current {@linkcode PluginCameraPose}.
+     * @throws PRECONDITION_FAILED when there is no active camera.
+     *
+     * @examplePrompt Where is the camera right now?
+     * @examplePrompt Remember this viewpoint so we can come back to it
+     * @examplePrompt Which way is the camera facing?
+     * @examplePrompt How high above the ground is the camera?
+     *
+     * # Example
+     * ```ts
+     * const pose = await snaptrude.core.camera.getPose()
+     * console.log(pose.eye, pose.yawInDegrees, pose.pitchInDegrees)
+     * ```
+     */
+    abstract getPose(): PluginApiReturn<PluginCameraPose>;
+    /**
+     * Place the camera, optionally easing there over `options.durationInSeconds`,
+     * and resolve once the new view has been drawn, so a capture that follows sees
+     * it without a fixed wait. `pose` is one of:
+     *
+     * - `{ eye, target }`: stand at `eye` looking at `target`, as
+     *   {@linkcode PluginCameraApi.lookFrom} does with handles;
+     * - `{ eye, yawInDegrees, pitchInDegrees }`: stand at `eye` looking along a
+     *   direction;
+     * - `{ standAt, yawInDegrees? }`: stand on the floor, stair, terrain or
+     *   ground at or below `standAt`, at the user's eye height above it (the `I`
+     *   key), facing `yawInDegrees` (the current yaw when omitted).
+     *
+     * Stops a playing walkthrough and switches from 2D plan view to 3D first.
+     * View-state only: not write-gated, not undoable.
+     *
+     * @param pose - Where to put the camera ({@linkcode PluginCameraPoseInput})
+     * @param options - `durationInSeconds`: ease over this long (0 to 10, default 0 jumps)
+     * @returns The camera's {@linkcode PluginCameraPose} once it has arrived.
+     * @throws PRECONDITION_FAILED when there is no active camera, while a
+     *   walkthrough export is recording, or when `standAt` lies below the ground
+     *   with nothing under it. VALIDATION when `eye` and `target` coincide or a
+     *   pitch is beyond ±89°.
+     *
+     * @examplePrompt Stand in the living room at eye level facing the window
+     * @examplePrompt Move the camera to (40, 12, 30) looking at the entrance
+     * @examplePrompt Fly the camera smoothly over to the courtyard
+     * @examplePrompt Put me back at the viewpoint we saved earlier
+     *
+     * # Example
+     * ```ts
+     * const { camera } = snaptrude.core
+     * await camera.setPose({ standAt: { x: 20, y: 0, z: 35 }, yawInDegrees: 90 })
+     * await camera.setPose(
+     *   { eye: { x: 60, y: 25, z: 60 }, target: { x: 0, y: 5, z: 0 } },
+     *   { durationInSeconds: 1.5 },
+     * )
+     * ```
+     */
+    abstract setPose(pose: PluginCameraPoseInput, options?: PluginCameraSetPoseOptions): PluginApiReturn<PluginCameraPose>;
+    /**
+     * Walk or fly the camera by a displacement in its own frame: `forward` along
+     * the level view direction, `right` to its side and `up` vertically, in
+     * internal `babylon` units. The view direction does not change. With
+     * `options.followsFloor` the camera keeps its height above the floor as it
+     * goes, climbing and descending stairs and ramps the way the arrow keys do.
+     * Stops a playing walkthrough and switches from 2D plan view to 3D first.
+     * View-state only: not write-gated, not undoable.
+     *
+     * @param displacement - {@linkcode PluginCameraMoveDisplacement}; omitted components are 0
+     * @param options - `followsFloor` (default `false`) and `durationInSeconds` (0 to 10, default 0)
+     * @returns The camera's {@linkcode PluginCameraPose} after the move.
+     * @throws PRECONDITION_FAILED when there is no active camera, or while a
+     *   walkthrough export is recording.
+     *
+     * @examplePrompt Walk forward 3 metres
+     * @examplePrompt Step to the right a little
+     * @examplePrompt Walk up the stairs ahead
+     * @examplePrompt Raise the camera by 2 metres
+     *
+     * # Example
+     * ```ts
+     * const metre = 1 / 0.254
+     * await snaptrude.core.camera.move(
+     *   { forward: 3 * metre },
+     *   { followsFloor: true, durationInSeconds: 2 },
+     * )
+     * ```
+     */
+    abstract move(displacement: PluginCameraMoveDisplacement, options?: PluginCameraMoveOptions): PluginApiReturn<PluginCameraPose>;
+    /**
+     * Turn the camera in place by signed angles: `yawInDegrees` to the right
+     * (clockwise seen from above) and `pitchInDegrees` up. The eye does not move;
+     * the resulting pitch is kept within ±89°. Stops a playing walkthrough and
+     * switches from 2D plan view to 3D first. View-state only: not write-gated,
+     * not undoable.
+     *
+     * @param yawInDegrees - Turn to the right by this much (negative turns left)
+     * @param pitchInDegrees - Tilt up by this much (negative tilts down; default 0)
+     * @param options - `durationInSeconds` (0 to 10, default 0)
+     * @returns The camera's {@linkcode PluginCameraPose} after turning.
+     * @throws PRECONDITION_FAILED when there is no active camera, or while a
+     *   walkthrough export is recording.
+     *
+     * @examplePrompt Turn around
+     * @examplePrompt Look 45 degrees to the left
+     * @examplePrompt Tilt the camera down a bit
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.camera.rotate(180, 0, { durationInSeconds: 1 })
+     * ```
+     */
+    abstract rotate(yawInDegrees: number, pitchInDegrees?: number, options?: PluginCameraRotateOptions): PluginApiReturn<PluginCameraPose>;
+    /**
+     * Read the arrow-key navigation settings: whether the arrow keys walk the
+     * camera, the eye height used by `setPose`'s `standAt` and by walkthroughs
+     * that follow the floor, the walking speed, and whether walking stops at
+     * walls. Paired with {@linkcode PluginCameraApi.updateNavigationSettings}.
+     *
+     * @returns The current {@linkcode PluginCameraNavigationSettings}.
+     *
+     * @examplePrompt Is arrow-key navigation on?
+     * @examplePrompt What eye height does the camera use?
+     *
+     * # Example
+     * ```ts
+     * const { isKeyboardNavigationEnabled } =
+     *   await snaptrude.core.camera.getNavigationSettings()
+     * ```
+     */
+    abstract getNavigationSettings(): PluginApiReturn<PluginCameraNavigationSettings>;
+    /**
+     * Change arrow-key navigation settings; only the fields given change.
+     * `isKeyboardNavigationEnabled` is the user's Project Settings switch and is
+     * saved on this device; the other settings last for the session.
+     * Write-gated: this changes the user's preferences, not just the view.
+     *
+     * @param patch - The settings to change ({@linkcode PluginCameraNavigationSettingsPatch})
+     * @returns The {@linkcode PluginCameraNavigationSettings} after the change.
+     * @throws METHOD_NOT_PERMITTED when plugin writes are disabled.
+     *
+     * @examplePrompt Turn off arrow-key navigation
+     * @examplePrompt Use a 1.6 m eye height
+     * @examplePrompt Make walking stop at walls
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.camera.updateNavigationSettings({
+     *   eyeHeight: 1.6 / 0.254,
+     *   isCollisionEnabled: true,
+     * })
+     * ```
+     */
+    abstract updateNavigationSettings(patch: PluginCameraNavigationSettingsPatch): PluginApiReturn<PluginCameraNavigationSettings>;
 }
 /**
  * A standard camera view: the five orthographic elevations (`top`/`front`/
@@ -242,4 +450,259 @@ export declare const PluginCameraSetProjectionArgs: z.ZodObject<{
     }>;
 }, z.core.$strip>;
 export type PluginCameraSetProjectionArgs = z.infer<typeof PluginCameraSetProjectionArgs>;
+/**
+ * The camera's pose — result of {@linkcode PluginCameraApi.getPose},
+ * {@linkcode PluginCameraApi.setPose}, {@linkcode PluginCameraApi.move} and
+ * {@linkcode PluginCameraApi.rotate}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `eye` | `{ x, y, z }` | Camera position (world, `babylon` units) |
+ * | `target` | `{ x, y, z }` | Point the camera looks at |
+ * | `yawInDegrees` | `number` | View direction, degrees clockwise from +z seen from above (-180 to 180) |
+ * | `pitchInDegrees` | `number` | View direction, degrees above level (negative looks down) |
+ * | `fieldOfViewInDegrees` | `number` | Vertical field of view |
+ * | `projection` | {@linkcode PluginCameraProjection} | `"perspective"` or `"orthographic"` |
+ * | `mode` | {@linkcode PluginCameraMode} | `"2d"` or `"3d"` |
+ */
+export declare const PluginCameraPose: z.ZodObject<{
+    eye: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    target: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    yawInDegrees: z.ZodNumber;
+    pitchInDegrees: z.ZodNumber;
+    fieldOfViewInDegrees: z.ZodNumber;
+    projection: z.ZodEnum<{
+        perspective: "perspective";
+        orthographic: "orthographic";
+    }>;
+    mode: z.ZodEnum<{
+        "2d": "2d";
+        "3d": "3d";
+    }>;
+}, z.core.$strip>;
+export type PluginCameraPose = z.infer<typeof PluginCameraPose>;
+/**
+ * Where {@linkcode PluginCameraApi.setPose} puts the camera — exactly one of:
+ *
+ * | Shape | Meaning |
+ * |---|---|
+ * | `{ eye, target }` | Stand at `eye` looking at `target` |
+ * | `{ eye, yawInDegrees, pitchInDegrees }` | Stand at `eye` looking along a direction (pitch within ±89°) |
+ * | `{ standAt, yawInDegrees? }` | Stand at eye height on the floor, stair, terrain or ground at or below `standAt`, facing `yawInDegrees` (default: current yaw) |
+ *
+ * Points are plain `{ x, y, z }` world coordinates in `babylon` units.
+ */
+export declare const PluginCameraPoseInput: z.ZodUnion<readonly [z.ZodObject<{
+    eye: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    target: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strict>, z.ZodObject<{
+    eye: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    yawInDegrees: z.ZodNumber;
+    pitchInDegrees: z.ZodNumber;
+}, z.core.$strict>, z.ZodObject<{
+    standAt: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    yawInDegrees: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>]>;
+export type PluginCameraPoseInput = z.infer<typeof PluginCameraPoseInput>;
+/**
+ * Options for {@linkcode PluginCameraApi.setPose}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `durationInSeconds` | `number \| undefined` | Ease to the pose over this long (0 to 10; default 0 jumps) |
+ */
+export declare const PluginCameraSetPoseOptions: z.ZodObject<{
+    durationInSeconds: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type PluginCameraSetPoseOptions = z.infer<typeof PluginCameraSetPoseOptions>;
+/**
+ * Arguments for {@linkcode PluginCameraApi.setPose}.
+ */
+export declare const PluginCameraSetPoseArgs: z.ZodObject<{
+    pose: z.ZodUnion<readonly [z.ZodObject<{
+        eye: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        target: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strict>, z.ZodObject<{
+        eye: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        yawInDegrees: z.ZodNumber;
+        pitchInDegrees: z.ZodNumber;
+    }, z.core.$strict>, z.ZodObject<{
+        standAt: z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        yawInDegrees: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>]>;
+    options: z.ZodOptional<z.ZodObject<{
+        durationInSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strip>;
+export type PluginCameraSetPoseArgs = z.infer<typeof PluginCameraSetPoseArgs>;
+/**
+ * A displacement in the camera's own frame, for {@linkcode PluginCameraApi.move}
+ * (`babylon` units; omitted components are 0).
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `forward` | `number \| undefined` | Along the level view direction (negative walks back) |
+ * | `right` | `number \| undefined` | To the camera's right (negative steps left) |
+ * | `up` | `number \| undefined` | Vertically (negative descends) |
+ */
+export declare const PluginCameraMoveDisplacement: z.ZodObject<{
+    forward: z.ZodOptional<z.ZodNumber>;
+    right: z.ZodOptional<z.ZodNumber>;
+    up: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type PluginCameraMoveDisplacement = z.infer<typeof PluginCameraMoveDisplacement>;
+/**
+ * Options for {@linkcode PluginCameraApi.move}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `followsFloor` | `boolean \| undefined` | Keep the height above the floor, climbing stairs and ramps (default `false`) |
+ * | `durationInSeconds` | `number \| undefined` | Walk over this long (0 to 10; default 0 jumps) |
+ */
+export declare const PluginCameraMoveOptions: z.ZodObject<{
+    followsFloor: z.ZodOptional<z.ZodBoolean>;
+    durationInSeconds: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type PluginCameraMoveOptions = z.infer<typeof PluginCameraMoveOptions>;
+/**
+ * Arguments for {@linkcode PluginCameraApi.move}.
+ */
+export declare const PluginCameraMoveArgs: z.ZodObject<{
+    displacement: z.ZodObject<{
+        forward: z.ZodOptional<z.ZodNumber>;
+        right: z.ZodOptional<z.ZodNumber>;
+        up: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>;
+    options: z.ZodOptional<z.ZodObject<{
+        followsFloor: z.ZodOptional<z.ZodBoolean>;
+        durationInSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strip>;
+export type PluginCameraMoveArgs = z.infer<typeof PluginCameraMoveArgs>;
+/**
+ * Options for {@linkcode PluginCameraApi.rotate}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `durationInSeconds` | `number \| undefined` | Turn over this long (0 to 10; default 0 jumps) |
+ */
+export declare const PluginCameraRotateOptions: z.ZodObject<{
+    durationInSeconds: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type PluginCameraRotateOptions = z.infer<typeof PluginCameraRotateOptions>;
+/**
+ * Arguments for {@linkcode PluginCameraApi.rotate}.
+ */
+export declare const PluginCameraRotateArgs: z.ZodObject<{
+    yawInDegrees: z.ZodNumber;
+    pitchInDegrees: z.ZodOptional<z.ZodNumber>;
+    options: z.ZodOptional<z.ZodObject<{
+        durationInSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+}, z.core.$strip>;
+export type PluginCameraRotateArgs = z.infer<typeof PluginCameraRotateArgs>;
+/**
+ * How fast the arrow keys walk: the Slow / Normal / Fast navigation setting.
+ */
+export declare const PluginCameraWalkSpeed: z.ZodEnum<{
+    normal: "normal";
+    slow: "slow";
+    fast: "fast";
+}>;
+export type PluginCameraWalkSpeed = z.infer<typeof PluginCameraWalkSpeed>;
+/**
+ * The arrow-key navigation settings — result of
+ * {@linkcode PluginCameraApi.getNavigationSettings} and
+ * {@linkcode PluginCameraApi.updateNavigationSettings}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `isKeyboardNavigationEnabled` | `boolean` | Whether the arrow keys walk the camera (Project Settings) |
+ * | `eyeHeight` | `number` | Eye height above the floor, `babylon` units |
+ * | `walkSpeed` | {@linkcode PluginCameraWalkSpeed} | Arrow-key walking speed |
+ * | `isCollisionEnabled` | `boolean` | Whether walking stops at walls |
+ */
+export declare const PluginCameraNavigationSettings: z.ZodObject<{
+    isKeyboardNavigationEnabled: z.ZodBoolean;
+    eyeHeight: z.ZodNumber;
+    walkSpeed: z.ZodEnum<{
+        normal: "normal";
+        slow: "slow";
+        fast: "fast";
+    }>;
+    isCollisionEnabled: z.ZodBoolean;
+}, z.core.$strip>;
+export type PluginCameraNavigationSettings = z.infer<typeof PluginCameraNavigationSettings>;
+/**
+ * The settings to change in {@linkcode PluginCameraApi.updateNavigationSettings};
+ * omitted fields keep their value. `eyeHeight` is in `babylon` units, between
+ * 0.8 m and 2.5 m (3.15 to 9.84 units).
+ */
+export declare const PluginCameraNavigationSettingsPatch: z.ZodObject<{
+    isKeyboardNavigationEnabled: z.ZodOptional<z.ZodBoolean>;
+    eyeHeight: z.ZodOptional<z.ZodNumber>;
+    walkSpeed: z.ZodOptional<z.ZodEnum<{
+        normal: "normal";
+        slow: "slow";
+        fast: "fast";
+    }>>;
+    isCollisionEnabled: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type PluginCameraNavigationSettingsPatch = z.infer<typeof PluginCameraNavigationSettingsPatch>;
+/**
+ * Arguments for {@linkcode PluginCameraApi.updateNavigationSettings}.
+ */
+export declare const PluginCameraUpdateNavigationSettingsArgs: z.ZodObject<{
+    patch: z.ZodObject<{
+        isKeyboardNavigationEnabled: z.ZodOptional<z.ZodBoolean>;
+        eyeHeight: z.ZodOptional<z.ZodNumber>;
+        walkSpeed: z.ZodOptional<z.ZodEnum<{
+            normal: "normal";
+            slow: "slow";
+            fast: "fast";
+        }>>;
+        isCollisionEnabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>;
+}, z.core.$strip>;
+export type PluginCameraUpdateNavigationSettingsArgs = z.infer<typeof PluginCameraUpdateNavigationSettingsArgs>;
 //# sourceMappingURL=index.d.ts.map

package/dist/api/core/camera/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/camera/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C;;;;;;;;GAQG;AACH,8BAAsB,eAAe;;IAGnC;;;;;;;;;;;;;;;;;;OAkBG;aACa,QAAQ,CACtB,GAAG,EAAE,UAAU,EACf,MAAM,EAAE,UAAU,GACjB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;OAmBG;aACa,eAAe,CAC7B,IAAI,EAAE,kBAAkB,GACvB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;OAiBG;aACa,OAAO,CAAC,IAAI,EAAE,gBAAgB,GAAG,eAAe,CAAC,OAAO,CAAC;IAEzE;;;;;;;;;;;;;;;;OAgBG;aACa,aAAa,IAAI,eAAe,CAAC,sBAAsB,CAAC;IAExE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,aAAa,CAC3B,UAAU,EAAE,sBAAsB,GACjC,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,IAAI,eAAe,CAAC,OAAO,CAAC;IAEvD;;;;;;;;;;;;;;;;;OAiBG;aACa,aAAa,IAAI,eAAe,CAAC,OAAO,CAAC;CAC1D;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;EAO7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;EAAuB,CAAA;AACpD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;EAA0C,CAAA;AAC7E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;iBAElC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/camera/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAkB,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,eAAe;;IAGnC;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,QAAQ,CACtB,GAAG,EAAE,UAAU,EACf,MAAM,EAAE,UAAU,GACjB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,eAAe,CAC7B,IAAI,EAAE,kBAAkB,GACvB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;OAcG;aACa,OAAO,IAAI,eAAe,CAAC,gBAAgB,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,OAAO,CAAC,IAAI,EAAE,gBAAgB,GAAG,eAAe,CAAC,OAAO,CAAC;IAEzE;;;;;;;;;;;;;;;;OAgBG;aACa,aAAa,IAAI,eAAe,CAAC,sBAAsB,CAAC;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,aAAa,CAC3B,UAAU,EAAE,sBAAsB,GACjC,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,WAAW,IAAI,eAAe,CAAC,OAAO,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,aAAa,IAAI,eAAe,CAAC,OAAO,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,OAAO,IAAI,eAAe,CAAC,gBAAgB,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;aACa,OAAO,CACrB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,0BAA0B,GACnC,eAAe,CAAC,gBAAgB,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,IAAI,CAClB,YAAY,EAAE,4BAA4B,EAC1C,OAAO,CAAC,EAAE,uBAAuB,GAChC,eAAe,CAAC,gBAAgB,CAAC;IAEpC;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,YAAY,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,yBAAyB,GAClC,eAAe,CAAC,gBAAgB,CAAC;IAEpC;;;;;;;;;;;;;;;;OAgBG;aACa,qBAAqB,IAAI,eAAe,CAAC,8BAA8B,CAAC;IAExF;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,wBAAwB,CACtC,KAAK,EAAE,mCAAmC,GACzC,eAAe,CAAC,8BAA8B,CAAC;CACnD;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;EAO7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;EAAuB,CAAA;AACpD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;EAA0C,CAAA;AAC7E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;iBAElC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAeD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;iBAQ3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;oBAiBhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;kBAE5B,CAAA;AACX,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B;;;;kBAM9B,CAAA;AACX,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;kBAKzB,CAAA;AACX,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;iBAG/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;kBAE3B,CAAA;AACX,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;iBAIjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;EAAqC,CAAA;AACvE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;iBAKzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;kBAOrC,CAAA;AACX,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;iBAEnD,CAAA;AACF,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA"}