@layoutit/polycss 0.0.1 → 0.2.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { P as PolySceneHandle, a as PolyMeshHandle } from './PolySelectElement-DCuYJb5J.cjs';
-export { b as PolyCameraOptions, c as PolyMapControlsElement, d as PolyMeshElement, e as PolyMeshTransform, f as PolyOrbitControlsElement, g as PolyOrthographicCameraElement, h as PolyOrthographicCameraHandle, i as PolyOrthographicCameraOptions, j as PolyPerspectiveCameraElement, k as PolyPerspectiveCameraHandle, l as PolyPerspectiveCameraOptions, m as PolyPolygonElement, n as PolySceneElement, o as PolySceneOptions, p as PolySelectElement, q as PolyTransformControlsElement, r as createPolyOrthographicCamera, s as createPolyPerspectiveCamera, t as createPolyScene } from './PolySelectElement-DCuYJb5J.cjs';
+import { P as PolySceneHandle, a as PolyMeshHandle } from './PolySelectElement-Tvsmhx2m.cjs';
+export { b as PolyCameraOptions, c as PolyMapControlsElement, d as PolyMeshElement, e as PolyMeshTransform, f as PolyOrbitControlsElement, g as PolyOrthographicCameraElement, h as PolyOrthographicCameraHandle, i as PolyOrthographicCameraOptions, j as PolyPerspectiveCameraElement, k as PolyPerspectiveCameraHandle, l as PolyPerspectiveCameraOptions, m as PolyPolygonElement, n as PolyRenderStrategiesOption, o as PolyRenderStrategy, p as PolySceneElement, q as PolySceneOptions, r as PolySelectElement, s as PolyTransformControlsElement, T as TextureQuality, t as createPolyOrthographicCamera, u as createPolyPerspectiveCamera, v as createPolyScene } from './PolySelectElement-Tvsmhx2m.cjs';
 import { Vec3 } from '@layoutit/polycss-core';
 export * from '@layoutit/polycss-core';
 
@@ -110,6 +110,86 @@ type PolyMapControlsOptions = PolyControlsBaseOptions;
 type PolyMapControlsHandle = PolyControlsHandle;
 declare function createPolyMapControls(scene: PolySceneHandle, options?: PolyMapControlsOptions): PolyMapControlsHandle;
 
+/**
+ * createPolyFirstPersonControls — first-person camera input for a PolyScene.
+ *
+ * Mouselook on pointer-lock, WASD/arrow planar move in the yaw-aligned XY
+ * plane, Space jump (parametric arc, no collision), Ctrl crouch. Each input
+ * axis is independently toggleable so callers can mix-and-match (e.g.
+ * mouselook-only on a model viewer, or move-only on a tour rail).
+ *
+ * For orbit semantics use `createPolyOrbitControls`. For pan/orbit map
+ * semantics use `createPolyMapControls`.
+ */
+
+interface PolyFirstPersonControlsOptions {
+    /** Master switch. When `false`, all sub-controls are inert. Default: `true`. */
+    enabled?: boolean;
+    /** Pointer-lock mouselook (rotX = pitch, rotY = yaw). Default: `true`. */
+    lookEnabled?: boolean;
+    /** WASD / arrow-key planar movement on world XY. Default: `true`. */
+    moveEnabled?: boolean;
+    /** Space-bar parametric jump arc on world Z. Default: `true`. */
+    jumpEnabled?: boolean;
+    /** Ctrl crouch (lowers eye height while held). Default: `true`. */
+    crouchEnabled?: boolean;
+    /** Mouselook sensitivity in degrees per pixel. Default: `0.15`. */
+    lookSensitivity?: number;
+    /** Invert vertical mouselook. Default: `false`. */
+    invertY?: boolean;
+    /** Movement speed in world units per second. Default: `5`. */
+    moveSpeed?: number;
+    /** Initial vertical velocity for a jump, world units per second. Default: `7`. */
+    jumpVelocity?: number;
+    /** Gravity acceleration in world units per second squared. Default: `18`. */
+    gravity?: number;
+    /** Standing eye height above the ground plane (target.z). Default: `1.7`. */
+    eyeHeight?: number;
+    /** Eye height while crouching. Default: `1`. */
+    crouchHeight?: number;
+    /** World Z of the ground plane the player walks on. Default: `0`. */
+    groundZ?: number;
+    /** Min pitch (rotX) angle. Default: `5`. */
+    minPitch?: number;
+    /** Max pitch (rotX) angle. Default: `175`. */
+    maxPitch?: number;
+}
+interface PolyFirstPersonControlsHandle {
+    update(partial: PolyFirstPersonControlsOptions): void;
+    resume(): void;
+    pause(): void;
+    destroy(): void;
+    /** Request pointer-lock now. Call from a user gesture (click). */
+    lock(): void;
+    /** Release pointer-lock. */
+    unlock(): void;
+    /** Whether pointer-lock is currently held. */
+    isLocked(): boolean;
+    /**
+     * The camera's WORLD position (the eye). FPV maintains this separately
+     * from the scene's `target` so mouselook rotates around it (in-place)
+     * instead of orbiting around target. Snapshot — mutate via WASD / jump /
+     * crouch, or by calling `setOrigin`.
+     */
+    getOrigin(): [number, number, number];
+    /**
+     * Move the camera origin to a specific world position. Re-derives the
+     * scene's target so the perspective viewer follows. Use this to teleport,
+     * spawn at a chosen spot, etc.
+     */
+    setOrigin(origin: [number, number, number]): void;
+    addEventListener<T extends PolyControlsEvent["type"]>(type: T, listener: PolyControlsListener<Extract<PolyControlsEvent, {
+        type: T;
+    }>>): void;
+    removeEventListener<T extends PolyControlsEvent["type"]>(type: T, listener: PolyControlsListener<Extract<PolyControlsEvent, {
+        type: T;
+    }>>): void;
+    hasEventListener<T extends PolyControlsEvent["type"]>(type: T, listener: PolyControlsListener<Extract<PolyControlsEvent, {
+        type: T;
+    }>>): boolean;
+}
+declare function createPolyFirstPersonControls(scene: PolySceneHandle, options?: PolyFirstPersonControlsOptions): PolyFirstPersonControlsHandle;
+
 /**
  * createSelect — additive selection layer for vanilla polycss scenes.
  * Mirrors the React `<Select>` API: tracks one or more selected
@@ -217,4 +297,4 @@ declare function createTransformControls(scene: PolySceneHandle, options?: PolyT
 
 declare function injectPolyBaseStyles(doc?: Document): void;
 
-export { type PolyControlsAnimateOptions, type PolyControlsBaseOptions, type PolyControlsCamera, type PolyControlsChangeEvent, type PolyControlsEvent, type PolyControlsHandle, type PolyControlsInteractionEvent, type PolyControlsListener, type PolyMapControlsHandle, type PolyMapControlsOptions, PolyMeshHandle, type PolyOrbitControlsHandle, type PolyOrbitControlsOptions, PolySceneHandle, type PolySelectOptions, type PolySelectionHandle, type PolyTransformControlsHandle, type PolyTransformControlsObjectChangeEvent, type PolyTransformControlsOptions, createPolyMapControls, createPolyOrbitControls, createSelect, createTransformControls, injectPolyBaseStyles };
+export { type PolyControlsAnimateOptions, type PolyControlsBaseOptions, type PolyControlsCamera, type PolyControlsChangeEvent, type PolyControlsEvent, type PolyControlsHandle, type PolyControlsInteractionEvent, type PolyControlsListener, type PolyFirstPersonControlsHandle, type PolyFirstPersonControlsOptions, type PolyMapControlsHandle, type PolyMapControlsOptions, PolyMeshHandle, type PolyOrbitControlsHandle, type PolyOrbitControlsOptions, PolySceneHandle, type PolySelectOptions, type PolySelectionHandle, type PolyTransformControlsHandle, type PolyTransformControlsObjectChangeEvent, type PolyTransformControlsOptions, createPolyFirstPersonControls, createPolyMapControls, createPolyOrbitControls, createSelect, createTransformControls, injectPolyBaseStyles };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { P as PolySceneHandle, a as PolyMeshHandle } from './PolySelectElement-DCuYJb5J.js';
-export { b as PolyCameraOptions, c as PolyMapControlsElement, d as PolyMeshElement, e as PolyMeshTransform, f as PolyOrbitControlsElement, g as PolyOrthographicCameraElement, h as PolyOrthographicCameraHandle, i as PolyOrthographicCameraOptions, j as PolyPerspectiveCameraElement, k as PolyPerspectiveCameraHandle, l as PolyPerspectiveCameraOptions, m as PolyPolygonElement, n as PolySceneElement, o as PolySceneOptions, p as PolySelectElement, q as PolyTransformControlsElement, r as createPolyOrthographicCamera, s as createPolyPerspectiveCamera, t as createPolyScene } from './PolySelectElement-DCuYJb5J.js';
+import { P as PolySceneHandle, a as PolyMeshHandle } from './PolySelectElement-Tvsmhx2m.js';
+export { b as PolyCameraOptions, c as PolyMapControlsElement, d as PolyMeshElement, e as PolyMeshTransform, f as PolyOrbitControlsElement, g as PolyOrthographicCameraElement, h as PolyOrthographicCameraHandle, i as PolyOrthographicCameraOptions, j as PolyPerspectiveCameraElement, k as PolyPerspectiveCameraHandle, l as PolyPerspectiveCameraOptions, m as PolyPolygonElement, n as PolyRenderStrategiesOption, o as PolyRenderStrategy, p as PolySceneElement, q as PolySceneOptions, r as PolySelectElement, s as PolyTransformControlsElement, T as TextureQuality, t as createPolyOrthographicCamera, u as createPolyPerspectiveCamera, v as createPolyScene } from './PolySelectElement-Tvsmhx2m.js';
 import { Vec3 } from '@layoutit/polycss-core';
 export * from '@layoutit/polycss-core';
 
@@ -110,6 +110,86 @@ type PolyMapControlsOptions = PolyControlsBaseOptions;
 type PolyMapControlsHandle = PolyControlsHandle;
 declare function createPolyMapControls(scene: PolySceneHandle, options?: PolyMapControlsOptions): PolyMapControlsHandle;
 
+/**
+ * createPolyFirstPersonControls — first-person camera input for a PolyScene.
+ *
+ * Mouselook on pointer-lock, WASD/arrow planar move in the yaw-aligned XY
+ * plane, Space jump (parametric arc, no collision), Ctrl crouch. Each input
+ * axis is independently toggleable so callers can mix-and-match (e.g.
+ * mouselook-only on a model viewer, or move-only on a tour rail).
+ *
+ * For orbit semantics use `createPolyOrbitControls`. For pan/orbit map
+ * semantics use `createPolyMapControls`.
+ */
+
+interface PolyFirstPersonControlsOptions {
+    /** Master switch. When `false`, all sub-controls are inert. Default: `true`. */
+    enabled?: boolean;
+    /** Pointer-lock mouselook (rotX = pitch, rotY = yaw). Default: `true`. */
+    lookEnabled?: boolean;
+    /** WASD / arrow-key planar movement on world XY. Default: `true`. */
+    moveEnabled?: boolean;
+    /** Space-bar parametric jump arc on world Z. Default: `true`. */
+    jumpEnabled?: boolean;
+    /** Ctrl crouch (lowers eye height while held). Default: `true`. */
+    crouchEnabled?: boolean;
+    /** Mouselook sensitivity in degrees per pixel. Default: `0.15`. */
+    lookSensitivity?: number;
+    /** Invert vertical mouselook. Default: `false`. */
+    invertY?: boolean;
+    /** Movement speed in world units per second. Default: `5`. */
+    moveSpeed?: number;
+    /** Initial vertical velocity for a jump, world units per second. Default: `7`. */
+    jumpVelocity?: number;
+    /** Gravity acceleration in world units per second squared. Default: `18`. */
+    gravity?: number;
+    /** Standing eye height above the ground plane (target.z). Default: `1.7`. */
+    eyeHeight?: number;
+    /** Eye height while crouching. Default: `1`. */
+    crouchHeight?: number;
+    /** World Z of the ground plane the player walks on. Default: `0`. */
+    groundZ?: number;
+    /** Min pitch (rotX) angle. Default: `5`. */
+    minPitch?: number;
+    /** Max pitch (rotX) angle. Default: `175`. */
+    maxPitch?: number;
+}
+interface PolyFirstPersonControlsHandle {
+    update(partial: PolyFirstPersonControlsOptions): void;
+    resume(): void;
+    pause(): void;
+    destroy(): void;
+    /** Request pointer-lock now. Call from a user gesture (click). */
+    lock(): void;
+    /** Release pointer-lock. */
+    unlock(): void;
+    /** Whether pointer-lock is currently held. */
+    isLocked(): boolean;
+    /**
+     * The camera's WORLD position (the eye). FPV maintains this separately
+     * from the scene's `target` so mouselook rotates around it (in-place)
+     * instead of orbiting around target. Snapshot — mutate via WASD / jump /
+     * crouch, or by calling `setOrigin`.
+     */
+    getOrigin(): [number, number, number];
+    /**
+     * Move the camera origin to a specific world position. Re-derives the
+     * scene's target so the perspective viewer follows. Use this to teleport,
+     * spawn at a chosen spot, etc.
+     */
+    setOrigin(origin: [number, number, number]): void;
+    addEventListener<T extends PolyControlsEvent["type"]>(type: T, listener: PolyControlsListener<Extract<PolyControlsEvent, {
+        type: T;
+    }>>): void;
+    removeEventListener<T extends PolyControlsEvent["type"]>(type: T, listener: PolyControlsListener<Extract<PolyControlsEvent, {
+        type: T;
+    }>>): void;
+    hasEventListener<T extends PolyControlsEvent["type"]>(type: T, listener: PolyControlsListener<Extract<PolyControlsEvent, {
+        type: T;
+    }>>): boolean;
+}
+declare function createPolyFirstPersonControls(scene: PolySceneHandle, options?: PolyFirstPersonControlsOptions): PolyFirstPersonControlsHandle;
+
 /**
  * createSelect — additive selection layer for vanilla polycss scenes.
  * Mirrors the React `<Select>` API: tracks one or more selected
@@ -217,4 +297,4 @@ declare function createTransformControls(scene: PolySceneHandle, options?: PolyT
 
 declare function injectPolyBaseStyles(doc?: Document): void;
 
-export { type PolyControlsAnimateOptions, type PolyControlsBaseOptions, type PolyControlsCamera, type PolyControlsChangeEvent, type PolyControlsEvent, type PolyControlsHandle, type PolyControlsInteractionEvent, type PolyControlsListener, type PolyMapControlsHandle, type PolyMapControlsOptions, PolyMeshHandle, type PolyOrbitControlsHandle, type PolyOrbitControlsOptions, PolySceneHandle, type PolySelectOptions, type PolySelectionHandle, type PolyTransformControlsHandle, type PolyTransformControlsObjectChangeEvent, type PolyTransformControlsOptions, createPolyMapControls, createPolyOrbitControls, createSelect, createTransformControls, injectPolyBaseStyles };
+export { type PolyControlsAnimateOptions, type PolyControlsBaseOptions, type PolyControlsCamera, type PolyControlsChangeEvent, type PolyControlsEvent, type PolyControlsHandle, type PolyControlsInteractionEvent, type PolyControlsListener, type PolyFirstPersonControlsHandle, type PolyFirstPersonControlsOptions, type PolyMapControlsHandle, type PolyMapControlsOptions, PolyMeshHandle, type PolyOrbitControlsHandle, type PolyOrbitControlsOptions, PolySceneHandle, type PolySelectOptions, type PolySelectionHandle, type PolyTransformControlsHandle, type PolyTransformControlsObjectChangeEvent, type PolyTransformControlsOptions, createPolyFirstPersonControls, createPolyMapControls, createPolyOrbitControls, createSelect, createTransformControls, injectPolyBaseStyles };