@relu-interactives/spatial-ecs 0.3.20 → 0.4.0

package/dist/{System-BhnLw0fZ.d.cts → System-QjjSc6LZ.d.cts}

@@ -973,6 +973,20 @@ declare class World {
      * the head pose as `parent.matrixWorld × headPose`.
      */
     isXrPresenting(): boolean;
+    /**
+     * `true` while the session is compositing over the real world (passthrough).
+     *
+     * Read from the session's `environmentBlendMode` rather than from what the app
+     * ASKED for: a request for `immersive-ar` can be granted as a plain opaque
+     * session, and the blend mode is the only thing that says what the user is
+     * actually looking at. `additive` (optical see-through) and `alpha-blend`
+     * (video passthrough) both mean the real world is visible behind the render.
+     *
+     * The load-bearing consequence is that nothing may paint an opaque background:
+     * a skybox drawn over the whole framebuffer hides the room completely, which
+     * looks exactly like passthrough having failed.
+     */
+    isXrPassthrough(): boolean;
     /**
      * Pauses world simulation. While paused, `update()` skips all system ticks so
      * physics, animation, scripts, and rendering stop advancing. The last rendered

package/dist/{System-BhnLw0fZ.d.ts → System-QjjSc6LZ.d.ts}

@@ -973,6 +973,20 @@ declare class World {
      * the head pose as `parent.matrixWorld × headPose`.
      */
     isXrPresenting(): boolean;
+    /**
+     * `true` while the session is compositing over the real world (passthrough).
+     *
+     * Read from the session's `environmentBlendMode` rather than from what the app
+     * ASKED for: a request for `immersive-ar` can be granted as a plain opaque
+     * session, and the blend mode is the only thing that says what the user is
+     * actually looking at. `additive` (optical see-through) and `alpha-blend`
+     * (video passthrough) both mean the real world is visible behind the render.
+     *
+     * The load-bearing consequence is that nothing may paint an opaque background:
+     * a skybox drawn over the whole framebuffer hides the room completely, which
+     * looks exactly like passthrough having failed.
+     */
+    isXrPassthrough(): boolean;
     /**
      * Pauses world simulation. While paused, `update()` skips all system ticks so
      * physics, animation, scripts, and rendering stop advancing. The last rendered

package/dist/{XRHandPose-CLl4MiHx.d.cts → XRHandPose-Capx-RTD.d.cts}

@@ -1,5 +1,5 @@
 import * as THREE from 'three';
-import { C as Component, p as EcsEntityKind, F as EcsEntityEditorKind, r as EntityId } from './System-BhnLw0fZ.cjs';
+import { C as Component, p as EcsEntityKind, F as EcsEntityEditorKind, r as EntityId } from './System-QjjSc6LZ.cjs';
 import * as RAPIER from '@dimforge/rapier3d-compat';
 import { a as XrFinger, c as XrHandPoseDirection, b as XrHandPoseOrientation, X as XrHandPoseDefinition } from './handPose-DlcTtqgx.cjs';
 
@@ -1436,6 +1436,20 @@ declare function createAttachPoint(partial: Partial<XrAttachPoint> & {
 type XrTrackingOrigin = "floor" | "eye";
 /** How the player moves through the scene in an immersive session. */
 type XrLocomotionMode = "teleport" | "smooth" | "none";
+/**
+ * Which real-world geometry becomes physics colliders in a passthrough session.
+ *
+ * `planes` uses the flat surfaces the headset detects (floor, walls, desks) —
+ * cheap, and available on more devices. `mesh` uses the full room scan, which is
+ * far more faithful (chair legs, clutter) but only exists where the runtime
+ * grants `mesh-detection`. `auto` takes the mesh when it is granted and quietly
+ * falls back to planes.
+ *
+ * `none` is the default because BOTH options make the headset ask the user for
+ * permission to share a scan of their room — a prompt no project should trigger
+ * unless it actually uses the result.
+ */
+type XrEnvironmentPhysics = "none" | "planes" | "mesh" | "auto";
 /** Optional initializer for {@link XRRigComponent}. */
 type XRRigOptions = {
     /** Where the headset origin sits. Defaults to `floor`. */
@@ -1456,6 +1470,18 @@ type XRRigOptions = {
     teleportArcInvalidColor?: string;
     /** Teleport arc thickness (diameter), metres. */
     teleportArcThickness?: number;
+    /** Run the session in passthrough (`immersive-ar`) instead of VR. */
+    passthrough?: boolean;
+    /** Let real objects occlude virtual ones, via WebXR depth sensing. */
+    depthOcclusion?: boolean;
+    /** Which detected real-world geometry becomes physics colliders. */
+    environmentPhysics?: XrEnvironmentPhysics;
+    /** Draw the detected room geometry on-device, for checking a scan. */
+    environmentDebug?: boolean;
+    /** Allow scripts to raycast against the real room (`hit-test`). */
+    hitTest?: boolean;
+    /** Allow content to be pinned to real-world features (`anchors`). */
+    anchors?: boolean;
 };
 /**
  * Marks an entity as the XR rig — the player's movable origin.
@@ -1490,6 +1516,25 @@ declare class XRRigComponent extends Component {
     teleportArcInvalidColor: string;
     /** Teleport arc thickness (diameter), metres. */
     teleportArcThickness: number;
+    /**
+     * Run the session in passthrough — the real room shows through.
+     *
+     * This is the VR/MR switch for the whole project: the entry button requests
+     * `immersive-ar` instead of `immersive-vr`. Blend mode is fixed for the life
+     * of a session, so this cannot be flipped mid-session — ending and re-entering
+     * is the only way to change it.
+     */
+    passthrough: boolean;
+    /** Let real objects occlude virtual ones, via WebXR depth sensing. */
+    depthOcclusion: boolean;
+    /** Which detected real-world geometry becomes physics colliders. */
+    environmentPhysics: XrEnvironmentPhysics;
+    /** Draw the detected room geometry on-device, for checking a scan. */
+    environmentDebug: boolean;
+    /** Allow scripts to raycast against the real room (`hit-test`). */
+    hitTest: boolean;
+    /** Allow content to be pinned to real-world features (`anchors`). */
+    anchors: boolean;
     constructor(options?: XRRigOptions);
 }
 
@@ -1657,4 +1702,4 @@ declare class XRHandPoseComponent extends Component {
     constructor(options?: XRHandPoseOptions);
 }
 
-export { Selectable as $, AnimationComponent as A, type MaterialValueState as B, CameraComponent as C, DEFAULT_COLLIDER_STATE as D, type EditableMeshObjectKind as E, MeshComponent as F, MeshGeometryComponent as G, type MeshGeometryParameters as H, ImageComponent as I, type MeshGeometryParametersByKind as J, ModelComponent as K, LightComponent as L, MaterialComponent as M, Name as N, Object3DRef as O, PhysicsComponent as P, type PhysicsState as Q, type PlaneMeshParameters as R, type RadiusHeightMeshParameters as S, type RadiusMeshParameters as T, type RigidbodyState as U, type RigidbodyType as V, ScriptComponent as W, type ScriptEntry as X, ScriptObjectComponent as Y, type ScriptObjectComponentInput as Z, type ScriptObjectRuntimeState as _, type AnimationComponentOptions as a, SelectionTransformState as a0, SpriteComponent as a1, type TextureFilteringValue as a2, type TransformModeValue as a3, type TransformSpaceValue as a4, VRTeleportAreaComponent as a5, type VRTeleportAreaOptions as a6, VideoComponent as a7, type VrTeleportShape as a8, XRHandPoseComponent as a9, type AnimationStateCallbacks as aA, AnimationStateMachine as aB, AnimationStateManager as aC, type StateMachine as aD, type XRHandPoseOptions as aa, XRInteractableComponent as ab, type XRInteractableOptions as ac, XRInteractorComponent as ad, type XRInteractorOptions as ae, XRInteractorSideComponent as af, XRRigComponent as ag, type XRRigOptions as ah, type XrAttachPoint as ai, type XrDistanceGrabBehavior as aj, type XrGrabGesture as ak, type XrGrabHands as al, type XrGrabReach as am, type XrHandPoseEntry as an, type XrHandPreset as ao, type XrInteractorSide as ap, type XrInteractorType as aq, type XrLocomotionMode as ar, type XrTrackingOrigin as as, type XrTwoHandRotation as at, createAttachPoint as au, createHandPoseEntry as av, defaultMaterialValue as aw, handPoseDefinitionFor as ax, normalizePhysicsState as ay, setPhysicsLiveRef as az, AudioComponent as b, type CameraComponentOptions as c, type CameraProjection as d, type CameraRuntimeType as e, type ColliderShape as f, type ColliderState as g, type CubeMeshParameters as h, DEFAULT_INSTANCED_MESH_PARAMETERS as i, DEFAULT_INSTANCE_TRANSFORM as j, DEFAULT_MESH_GEOMETRY_PARAMETERS as k, DEFAULT_PHYSICS_STATE as l, DEFAULT_POSE_CURLS as m, DEFAULT_POSE_DIRECTIONS as n, DEFAULT_RIGIDBODY_STATE as o, EntityType as p, ImageTarget as q, ImageTargetAnchor as r, type ImageTargetAnchorOptions as s, type ImageTargetReference as t, InstanceSlotComponent as u, type InstanceTransform as v, InstancedMeshComponent as w, type InstancedMeshKind as x, type LightValueState as y, type MaterialTypeValue as z };
+export { Selectable as $, AnimationComponent as A, type MaterialValueState as B, CameraComponent as C, DEFAULT_COLLIDER_STATE as D, type EditableMeshObjectKind as E, MeshComponent as F, MeshGeometryComponent as G, type MeshGeometryParameters as H, ImageComponent as I, type MeshGeometryParametersByKind as J, ModelComponent as K, LightComponent as L, MaterialComponent as M, Name as N, Object3DRef as O, PhysicsComponent as P, type PhysicsState as Q, type PlaneMeshParameters as R, type RadiusHeightMeshParameters as S, type RadiusMeshParameters as T, type RigidbodyState as U, type RigidbodyType as V, ScriptComponent as W, type ScriptEntry as X, ScriptObjectComponent as Y, type ScriptObjectComponentInput as Z, type ScriptObjectRuntimeState as _, type AnimationComponentOptions as a, SelectionTransformState as a0, SpriteComponent as a1, type TextureFilteringValue as a2, type TransformModeValue as a3, type TransformSpaceValue as a4, VRTeleportAreaComponent as a5, type VRTeleportAreaOptions as a6, VideoComponent as a7, type VrTeleportShape as a8, XRHandPoseComponent as a9, setPhysicsLiveRef as aA, type AnimationStateCallbacks as aB, AnimationStateMachine as aC, AnimationStateManager as aD, type StateMachine as aE, type XRHandPoseOptions as aa, XRInteractableComponent as ab, type XRInteractableOptions as ac, XRInteractorComponent as ad, type XRInteractorOptions as ae, XRInteractorSideComponent as af, XRRigComponent as ag, type XRRigOptions as ah, type XrAttachPoint as ai, type XrDistanceGrabBehavior as aj, type XrEnvironmentPhysics as ak, type XrGrabGesture as al, type XrGrabHands as am, type XrGrabReach as an, type XrHandPoseEntry as ao, type XrHandPreset as ap, type XrInteractorSide as aq, type XrInteractorType as ar, type XrLocomotionMode as as, type XrTrackingOrigin as at, type XrTwoHandRotation as au, createAttachPoint as av, createHandPoseEntry as aw, defaultMaterialValue as ax, handPoseDefinitionFor as ay, normalizePhysicsState as az, AudioComponent as b, type CameraComponentOptions as c, type CameraProjection as d, type CameraRuntimeType as e, type ColliderShape as f, type ColliderState as g, type CubeMeshParameters as h, DEFAULT_INSTANCED_MESH_PARAMETERS as i, DEFAULT_INSTANCE_TRANSFORM as j, DEFAULT_MESH_GEOMETRY_PARAMETERS as k, DEFAULT_PHYSICS_STATE as l, DEFAULT_POSE_CURLS as m, DEFAULT_POSE_DIRECTIONS as n, DEFAULT_RIGIDBODY_STATE as o, EntityType as p, ImageTarget as q, ImageTargetAnchor as r, type ImageTargetAnchorOptions as s, type ImageTargetReference as t, InstanceSlotComponent as u, type InstanceTransform as v, InstancedMeshComponent as w, type InstancedMeshKind as x, type LightValueState as y, type MaterialTypeValue as z };

package/dist/{XRHandPose-CrzI57JA.d.ts → XRHandPose-Csd3QGkj.d.ts}

@@ -1,5 +1,5 @@
 import * as THREE from 'three';
-import { C as Component, p as EcsEntityKind, F as EcsEntityEditorKind, r as EntityId } from './System-BhnLw0fZ.js';
+import { C as Component, p as EcsEntityKind, F as EcsEntityEditorKind, r as EntityId } from './System-QjjSc6LZ.js';
 import * as RAPIER from '@dimforge/rapier3d-compat';
 import { a as XrFinger, c as XrHandPoseDirection, b as XrHandPoseOrientation, X as XrHandPoseDefinition } from './handPose-DlcTtqgx.js';
 
@@ -1436,6 +1436,20 @@ declare function createAttachPoint(partial: Partial<XrAttachPoint> & {
 type XrTrackingOrigin = "floor" | "eye";
 /** How the player moves through the scene in an immersive session. */
 type XrLocomotionMode = "teleport" | "smooth" | "none";
+/**
+ * Which real-world geometry becomes physics colliders in a passthrough session.
+ *
+ * `planes` uses the flat surfaces the headset detects (floor, walls, desks) —
+ * cheap, and available on more devices. `mesh` uses the full room scan, which is
+ * far more faithful (chair legs, clutter) but only exists where the runtime
+ * grants `mesh-detection`. `auto` takes the mesh when it is granted and quietly
+ * falls back to planes.
+ *
+ * `none` is the default because BOTH options make the headset ask the user for
+ * permission to share a scan of their room — a prompt no project should trigger
+ * unless it actually uses the result.
+ */
+type XrEnvironmentPhysics = "none" | "planes" | "mesh" | "auto";
 /** Optional initializer for {@link XRRigComponent}. */
 type XRRigOptions = {
     /** Where the headset origin sits. Defaults to `floor`. */
@@ -1456,6 +1470,18 @@ type XRRigOptions = {
     teleportArcInvalidColor?: string;
     /** Teleport arc thickness (diameter), metres. */
     teleportArcThickness?: number;
+    /** Run the session in passthrough (`immersive-ar`) instead of VR. */
+    passthrough?: boolean;
+    /** Let real objects occlude virtual ones, via WebXR depth sensing. */
+    depthOcclusion?: boolean;
+    /** Which detected real-world geometry becomes physics colliders. */
+    environmentPhysics?: XrEnvironmentPhysics;
+    /** Draw the detected room geometry on-device, for checking a scan. */
+    environmentDebug?: boolean;
+    /** Allow scripts to raycast against the real room (`hit-test`). */
+    hitTest?: boolean;
+    /** Allow content to be pinned to real-world features (`anchors`). */
+    anchors?: boolean;
 };
 /**
  * Marks an entity as the XR rig — the player's movable origin.
@@ -1490,6 +1516,25 @@ declare class XRRigComponent extends Component {
     teleportArcInvalidColor: string;
     /** Teleport arc thickness (diameter), metres. */
     teleportArcThickness: number;
+    /**
+     * Run the session in passthrough — the real room shows through.
+     *
+     * This is the VR/MR switch for the whole project: the entry button requests
+     * `immersive-ar` instead of `immersive-vr`. Blend mode is fixed for the life
+     * of a session, so this cannot be flipped mid-session — ending and re-entering
+     * is the only way to change it.
+     */
+    passthrough: boolean;
+    /** Let real objects occlude virtual ones, via WebXR depth sensing. */
+    depthOcclusion: boolean;
+    /** Which detected real-world geometry becomes physics colliders. */
+    environmentPhysics: XrEnvironmentPhysics;
+    /** Draw the detected room geometry on-device, for checking a scan. */
+    environmentDebug: boolean;
+    /** Allow scripts to raycast against the real room (`hit-test`). */
+    hitTest: boolean;
+    /** Allow content to be pinned to real-world features (`anchors`). */
+    anchors: boolean;
     constructor(options?: XRRigOptions);
 }
 
@@ -1657,4 +1702,4 @@ declare class XRHandPoseComponent extends Component {
     constructor(options?: XRHandPoseOptions);
 }
 
-export { Selectable as $, AnimationComponent as A, type MaterialValueState as B, CameraComponent as C, DEFAULT_COLLIDER_STATE as D, type EditableMeshObjectKind as E, MeshComponent as F, MeshGeometryComponent as G, type MeshGeometryParameters as H, ImageComponent as I, type MeshGeometryParametersByKind as J, ModelComponent as K, LightComponent as L, MaterialComponent as M, Name as N, Object3DRef as O, PhysicsComponent as P, type PhysicsState as Q, type PlaneMeshParameters as R, type RadiusHeightMeshParameters as S, type RadiusMeshParameters as T, type RigidbodyState as U, type RigidbodyType as V, ScriptComponent as W, type ScriptEntry as X, ScriptObjectComponent as Y, type ScriptObjectComponentInput as Z, type ScriptObjectRuntimeState as _, type AnimationComponentOptions as a, SelectionTransformState as a0, SpriteComponent as a1, type TextureFilteringValue as a2, type TransformModeValue as a3, type TransformSpaceValue as a4, VRTeleportAreaComponent as a5, type VRTeleportAreaOptions as a6, VideoComponent as a7, type VrTeleportShape as a8, XRHandPoseComponent as a9, type AnimationStateCallbacks as aA, AnimationStateMachine as aB, AnimationStateManager as aC, type StateMachine as aD, type XRHandPoseOptions as aa, XRInteractableComponent as ab, type XRInteractableOptions as ac, XRInteractorComponent as ad, type XRInteractorOptions as ae, XRInteractorSideComponent as af, XRRigComponent as ag, type XRRigOptions as ah, type XrAttachPoint as ai, type XrDistanceGrabBehavior as aj, type XrGrabGesture as ak, type XrGrabHands as al, type XrGrabReach as am, type XrHandPoseEntry as an, type XrHandPreset as ao, type XrInteractorSide as ap, type XrInteractorType as aq, type XrLocomotionMode as ar, type XrTrackingOrigin as as, type XrTwoHandRotation as at, createAttachPoint as au, createHandPoseEntry as av, defaultMaterialValue as aw, handPoseDefinitionFor as ax, normalizePhysicsState as ay, setPhysicsLiveRef as az, AudioComponent as b, type CameraComponentOptions as c, type CameraProjection as d, type CameraRuntimeType as e, type ColliderShape as f, type ColliderState as g, type CubeMeshParameters as h, DEFAULT_INSTANCED_MESH_PARAMETERS as i, DEFAULT_INSTANCE_TRANSFORM as j, DEFAULT_MESH_GEOMETRY_PARAMETERS as k, DEFAULT_PHYSICS_STATE as l, DEFAULT_POSE_CURLS as m, DEFAULT_POSE_DIRECTIONS as n, DEFAULT_RIGIDBODY_STATE as o, EntityType as p, ImageTarget as q, ImageTargetAnchor as r, type ImageTargetAnchorOptions as s, type ImageTargetReference as t, InstanceSlotComponent as u, type InstanceTransform as v, InstancedMeshComponent as w, type InstancedMeshKind as x, type LightValueState as y, type MaterialTypeValue as z };
+export { Selectable as $, AnimationComponent as A, type MaterialValueState as B, CameraComponent as C, DEFAULT_COLLIDER_STATE as D, type EditableMeshObjectKind as E, MeshComponent as F, MeshGeometryComponent as G, type MeshGeometryParameters as H, ImageComponent as I, type MeshGeometryParametersByKind as J, ModelComponent as K, LightComponent as L, MaterialComponent as M, Name as N, Object3DRef as O, PhysicsComponent as P, type PhysicsState as Q, type PlaneMeshParameters as R, type RadiusHeightMeshParameters as S, type RadiusMeshParameters as T, type RigidbodyState as U, type RigidbodyType as V, ScriptComponent as W, type ScriptEntry as X, ScriptObjectComponent as Y, type ScriptObjectComponentInput as Z, type ScriptObjectRuntimeState as _, type AnimationComponentOptions as a, SelectionTransformState as a0, SpriteComponent as a1, type TextureFilteringValue as a2, type TransformModeValue as a3, type TransformSpaceValue as a4, VRTeleportAreaComponent as a5, type VRTeleportAreaOptions as a6, VideoComponent as a7, type VrTeleportShape as a8, XRHandPoseComponent as a9, setPhysicsLiveRef as aA, type AnimationStateCallbacks as aB, AnimationStateMachine as aC, AnimationStateManager as aD, type StateMachine as aE, type XRHandPoseOptions as aa, XRInteractableComponent as ab, type XRInteractableOptions as ac, XRInteractorComponent as ad, type XRInteractorOptions as ae, XRInteractorSideComponent as af, XRRigComponent as ag, type XRRigOptions as ah, type XrAttachPoint as ai, type XrDistanceGrabBehavior as aj, type XrEnvironmentPhysics as ak, type XrGrabGesture as al, type XrGrabHands as am, type XrGrabReach as an, type XrHandPoseEntry as ao, type XrHandPreset as ap, type XrInteractorSide as aq, type XrInteractorType as ar, type XrLocomotionMode as as, type XrTrackingOrigin as at, type XrTwoHandRotation as au, createAttachPoint as av, createHandPoseEntry as aw, defaultMaterialValue as ax, handPoseDefinitionFor as ay, normalizePhysicsState as az, AudioComponent as b, type CameraComponentOptions as c, type CameraProjection as d, type CameraRuntimeType as e, type ColliderShape as f, type ColliderState as g, type CubeMeshParameters as h, DEFAULT_INSTANCED_MESH_PARAMETERS as i, DEFAULT_INSTANCE_TRANSFORM as j, DEFAULT_MESH_GEOMETRY_PARAMETERS as k, DEFAULT_PHYSICS_STATE as l, DEFAULT_POSE_CURLS as m, DEFAULT_POSE_DIRECTIONS as n, DEFAULT_RIGIDBODY_STATE as o, EntityType as p, ImageTarget as q, ImageTargetAnchor as r, type ImageTargetAnchorOptions as s, type ImageTargetReference as t, InstanceSlotComponent as u, type InstanceTransform as v, InstancedMeshComponent as w, type InstancedMeshKind as x, type LightValueState as y, type MaterialTypeValue as z };