@relu-interactives/spatial-ecs 0.5.3 → 0.9.0

package/dist/docs/api/index/classes/XRSessionSystem.md

@@ -0,0 +1,116 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRSessionSystem
+
+# Class: XRSessionSystem
+
+Defined in: [systems/XRSessionSystem.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRSessionSystem.ts#L28)
+
+Owns the immersive-session lifecycle and fans XR events out to Behaviours.
+
+Detects session start/end by polling `renderer.xr.isPresenting` rather than
+binding to `sessionstart`/`sessionend`: the session may already be running
+before this system is registered (the consumer owns the entry button), and
+polling a boolean makes the system correct regardless of construction order.
+
+Hook dispatch mirrors `ImageTargetAnchorSystem`'s AR precedent — walk live
+`ScriptComponent.scriptInstances` and call the public no-op hook — so XR and
+AR extend `Behaviour` the same way.
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRSessionSystem(inputSystem?): XRSessionSystem;
+```
+
+Defined in: [systems/XRSessionSystem.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRSessionSystem.ts#L37)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `inputSystem?` | [`XRInputSystem`](XRInputSystem.md) |
+
+#### Returns
+
+`XRSessionSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/XRSessionSystem.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRSessionSystem.ts#L41)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### getCapabilities()
+
+```ts
+getCapabilities(): XrCapabilities;
+```
+
+Defined in: [systems/XRSessionSystem.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRSessionSystem.ts#L246)
+
+What the active session granted. `NO_XR_CAPABILITIES` when not presenting.
+
+#### Returns
+
+[`XrCapabilities`](../type-aliases/XrCapabilities.md)
+
+***
+
+### isPresenting()
+
+```ts
+isPresenting(): boolean;
+```
+
+Defined in: [systems/XRSessionSystem.ts:251](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRSessionSystem.ts#L251)
+
+True while an immersive session is presenting.
+
+#### Returns
+
+`boolean`
+
+***
+
+### getInputs()
+
+```ts
+getInputs(): XrInputState[];
+```
+
+Defined in: [systems/XRSessionSystem.ts:256](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRSessionSystem.ts#L256)
+
+Convenience passthrough so consumers need only hold this system.
+
+#### Returns
+
+[`XrInputState`](../type-aliases/XrInputState.md)[]

package/dist/docs/api/index/classes/XRTeleportVisualSystem.md

@@ -0,0 +1,75 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRTeleportVisualSystem
+
+# Class: XRTeleportVisualSystem
+
+Defined in: [systems/XRTeleportVisualSystem.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRTeleportVisualSystem.ts#L37)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRTeleportVisualSystem(locomotionSystem): XRTeleportVisualSystem;
+```
+
+Defined in: [systems/XRTeleportVisualSystem.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRTeleportVisualSystem.ts#L59)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `locomotionSystem` | [`XRLocomotionSystem`](XRLocomotionSystem.md) |
+
+#### Returns
+
+`XRTeleportVisualSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/XRTeleportVisualSystem.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRTeleportVisualSystem.ts#L75)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [systems/XRTeleportVisualSystem.ts:264](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRTeleportVisualSystem.ts#L264)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

package/dist/docs/api/index/functions/angularVelocityFrom.md

@@ -0,0 +1,33 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / angularVelocityFrom
+
+# Function: angularVelocityFrom()
+
+```ts
+function angularVelocityFrom(
+   previous, 
+   current, 
+   deltaTime): Vector3;
+```
+
+Defined in: [xr/throwVelocity.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/throwVelocity.ts#L116)
+
+Angular velocity from a rotation delta, as an axis-angle vector (rad/s).
+
+Spin makes a thrown ball read as thrown rather than launched, and it is what
+lets a scene do curve shots or spinning props.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `previous` | `Quaternion` |
+| `current` | `Quaternion` |
+| `deltaTime` | `number` |
+
+## Returns
+
+`Vector3`

package/dist/docs/api/index/functions/applyHandMaterial.md

@@ -0,0 +1,26 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / applyHandMaterial
+
+# Function: applyHandMaterial()
+
+```ts
+function applyHandMaterial(root, material): void;
+```
+
+Defined in: [xr/handPresets.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPresets.ts#L90)
+
+Apply a preset material to every mesh under a hand model.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `root` | `Object3D` |
+| `material` | `Material` |
+
+## Returns
+
+`void`

package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md

@@ -13,7 +13,7 @@ function applyPrefabToSnapshotInstances(
    newNestedSnapshot): ApplyPrefabToSnapshotResult;
 ```
 
-Defined in: [prefab/applyPrefabToSnapshot.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/applyPrefabToSnapshot.ts#L122)
+Defined in: [prefab/applyPrefabToSnapshot.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/applyPrefabToSnapshot.ts#L122)
 
 Patch every top-level-relative nested instance of `nestedUrl` inside
 `hostSnapshot` with `newNestedSnapshot`. Deeper nesting (B inside C inside

package/dist/docs/api/index/functions/arcGroundCrossing.md

@@ -0,0 +1,30 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / arcGroundCrossing
+
+# Function: arcGroundCrossing()
+
+```ts
+function arcGroundCrossing(points, groundY): Vector3 | null;
+```
+
+Defined in: [xr/teleportArc.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/teleportArc.ts#L66)
+
+Where a sampled arc first crosses `groundY` going downward, or null.
+
+Used as a cheap pre-check before raycasting: if the curve never descends to
+the floor plane there is nothing to hit, so we can skip the per-segment
+intersection work entirely.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `points` | `Vector3`[] |
+| `groundY` | `number` |
+
+## Returns
+
+`Vector3` \| `null`

package/dist/docs/api/index/functions/buildComponentValueMaps.md

@@ -10,7 +10,7 @@
 function buildComponentValueMaps(snapshot): ComponentValueMaps;
 ```
 
-Defined in: [hydration/componentValues.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/hydration/componentValues.ts#L4)
+Defined in: [hydration/componentValues.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/hydration/componentValues.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md

@@ -10,7 +10,7 @@
 function buildNodeKeyMapsFromSnapshot(snapshot, options?): NodeKeyMaps;
 ```
 
-Defined in: [prefab/nodeKeys.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/nodeKeys.ts#L70)
+Defined in: [prefab/nodeKeys.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/nodeKeys.ts#L70)
 
 ## Parameters
 

package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md

@@ -10,7 +10,7 @@
 function buildNodeMapsFromSnapshot(snapshot): NodeMaps;
 ```
 
-Defined in: [prefab/overrides.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L86)
+Defined in: [prefab/overrides.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/overrides.ts#L86)
 
 ## Parameters
 

package/dist/docs/api/index/functions/canonicalizeComponentValue.md

@@ -13,7 +13,7 @@ function canonicalizeComponentValue(
    idToNode): unknown;
 ```
 
-Defined in: [prefab/overrides.ts:177](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L177)
+Defined in: [prefab/overrides.ts:177](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/overrides.ts#L177)
 
 Canonicalize a serialized component value into nodeId-space:
 - entity-id fields → `{$node}` (internal) or raw id (external)

package/dist/docs/api/index/functions/clearModelCache.md

@@ -10,7 +10,7 @@
 function clearModelCache(url?): void;
 ```
 
-Defined in: [utils/modelCache.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/utils/modelCache.ts#L71)
+Defined in: [utils/modelCache.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/utils/modelCache.ts#L71)
 
 Forget cached models (one URL, or everything). Subsequent loads fetch and
 parse anew. Does not dispose GPU resources — live clones may still use them.

package/dist/docs/api/index/functions/clearPrefabCache.md

@@ -10,7 +10,7 @@
 function clearPrefabCache(url?): void;
 ```
 
-Defined in: [prefab/spawnPrefab.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/spawnPrefab.ts#L98)
+Defined in: [prefab/spawnPrefab.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/spawnPrefab.ts#L98)
 
 Drop one cached prefab (or all when no url is given).
 

package/dist/docs/api/index/functions/cloneHandPose.md

@@ -0,0 +1,23 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / cloneHandPose
+
+# Function: cloneHandPose()
+
+```ts
+function cloneHandPose(definition): XrHandPoseDefinition;
+```
+
+Defined in: [xr/handPosePresets.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPosePresets.ts#L186)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `definition` | [`XrHandPoseDefinition`](../type-aliases/XrHandPoseDefinition.md) |
+
+## Returns
+
+[`XrHandPoseDefinition`](../type-aliases/XrHandPoseDefinition.md)

package/dist/docs/api/index/functions/collectDiffPaths.md

@@ -14,7 +14,7 @@ function collectDiffPaths(
    out?): string[];
 ```
 
-Defined in: [prefab/overrides.ts:338](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L338)
+Defined in: [prefab/overrides.ts:338](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/overrides.ts#L338)
 
 Collect leaf paths where two canonical values differ. Semantics:
 - `{$node}` refs compare atomically by nodeId

package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md

@@ -10,7 +10,7 @@
 function collectDirectPrefabDependencies(snapshot): string[];
 ```
 
-Defined in: [prefab/dependencies.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/dependencies.ts#L9)
+Defined in: [prefab/dependencies.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/dependencies.ts#L9)
 
 Direct (top-level-relative) prefab urls a document depends on — the edges
 of the nesting graph. Deeper nesting is reached transitively through each

package/dist/docs/api/index/functions/collectEntitySubtree.md

@@ -10,7 +10,7 @@
 function collectEntitySubtree(world, rootIds): number[];
 ```
 
-Defined in: [prefab/collectEntitySubtree.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/collectEntitySubtree.ts#L11)
+Defined in: [prefab/collectEntitySubtree.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/collectEntitySubtree.ts#L11)
 
 Collect the given roots plus every descendant, BFS parent-first, using the
 `ParentId` component edges. Parent-first ordering matters: serialization

package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md

@@ -10,7 +10,7 @@
 function collectSnapshotSubtreeIds(snapshot, rootEntityId): number[];
 ```
 
-Defined in: [prefab/nodeKeys.ts:166](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/nodeKeys.ts#L166)
+Defined in: [prefab/nodeKeys.ts:166](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/nodeKeys.ts#L166)
 
 JSON-space subtree ids (root first, BFS) via ParentId edges.
 

package/dist/docs/api/index/functions/computeFingerCurl.md

@@ -0,0 +1,29 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / computeFingerCurl
+
+# Function: computeFingerCurl()
+
+```ts
+function computeFingerCurl(joints, finger): XrFingerCurl | null;
+```
+
+Defined in: [xr/handPose.ts:212](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L212)
+
+Curl for one finger, or null when the finger isn't tracked well enough.
+
+The thumb yields only two bend angles to the fingers' three, so `baseCurl` and
+`tipCurl` are its first and second bends respectively.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `joints` | [`XrHandJoints`](../type-aliases/XrHandJoints.md) |
+| `finger` | [`XrFinger`](../type-aliases/XrFinger.md) |
+
+## Returns
+
+[`XrFingerCurl`](../type-aliases/XrFingerCurl.md) \| `null`

package/dist/docs/api/index/functions/computeHandShape.md

@@ -0,0 +1,29 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / computeHandShape
+
+# Function: computeHandShape()
+
+```ts
+function computeHandShape(joints, handedness): XrHandShape | null;
+```
+
+Defined in: [xr/handPose.ts:395](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L395)
+
+Reduce tracked joints to the matchable shape.
+
+Returns null when the hand is too poorly tracked for ANY finger to be
+measured — better to report "no pose" than to match against garbage.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `joints` | [`XrHandJoints`](../type-aliases/XrHandJoints.md) |
+| `handedness` | `"left"` \| `"right"` |
+
+## Returns
+
+[`XrHandShape`](../type-aliases/XrHandShape.md) \| `null`

package/dist/docs/api/index/functions/computeInstanceOverrides.md

@@ -13,7 +13,7 @@ function computeInstanceOverrides(
    options?): string[];
 ```
 
-Defined in: [prefab/overrides.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/prefab/overrides.ts#L416)
+Defined in: [prefab/overrides.ts:416](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/prefab/overrides.ts#L416)
 
 Diff a live instance subtree against its prefab base (both as serialized
 subtree snapshots carrying PrefabNode identity) and return the encoded

package/dist/docs/api/index/functions/computePalmPose.md

@@ -0,0 +1,30 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / computePalmPose
+
+# Function: computePalmPose()
+
+```ts
+function computePalmPose(joints, handedness): XrPalmPose | null;
+```
+
+Defined in: [xr/handPose.ts:325](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L325)
+
+Palm frame, used for orientation conditions ("palm up", "thumb toward face").
+
+Handedness matters: the same cross product points opposite ways on left and
+right hands, so the left is mirrored to keep `normal` meaning "out of the
+front of the palm" on both.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `joints` | [`XrHandJoints`](../type-aliases/XrHandJoints.md) |
+| `handedness` | `"left"` \| `"right"` |
+
+## Returns
+
+[`XrPalmPose`](../type-aliases/XrPalmPose.md) \| `null`

package/dist/docs/api/index/functions/computePalmWidth.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / computePalmWidth
+
+# Function: computePalmWidth()
+
+```ts
+function computePalmWidth(joints): number | null;
+```
+
+Defined in: [xr/handPose.ts:230](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L230)
+
+Distance across the knuckles — our unit of hand size.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `joints` | [`XrHandJoints`](../type-aliases/XrHandJoints.md) |
+
+## Returns
+
+`number` \| `null`

package/dist/docs/api/index/functions/computePinch.md

@@ -0,0 +1,29 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / computePinch
+
+# Function: computePinch()
+
+```ts
+function computePinch(joints, finger): number | null;
+```
+
+Defined in: [xr/handPose.ts:269](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L269)
+
+How close a fingertip is to the thumb tip. 1 = touching, 0 = far apart.
+
+Scaled by hand size, so "pinching" means the same gesture on every hand
+rather than the same number of millimetres.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `joints` | [`XrHandJoints`](../type-aliases/XrHandJoints.md) |
+| `finger` | `"index"` \| `"middle"` \| `"ring"` \| `"pinky"` |
+
+## Returns
+
+`number` \| `null`

package/dist/docs/api/index/functions/computeSpread.md

@@ -0,0 +1,33 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / computeSpread
+
+# Function: computeSpread()
+
+```ts
+function computeSpread(
+   joints, 
+   a, 
+   b): number | null;
+```
+
+Defined in: [xr/handPose.ts:288](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/xr/handPose.ts#L288)
+
+Angular separation between two fingers. 0 = parallel, 1 = splayed wide.
+
+Measured on metacarpal→tip direction, which stays meaningful even when the
+fingers are partly curled.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `joints` | [`XrHandJoints`](../type-aliases/XrHandJoints.md) |
+| `a` | [`XrFinger`](../type-aliases/XrFinger.md) |
+| `b` | [`XrFinger`](../type-aliases/XrFinger.md) |
+
+## Returns
+
+`number` \| `null`

package/dist/docs/api/index/functions/createAnimationComponent.md

@@ -13,7 +13,7 @@ function createAnimationComponent(
    args): AnimationComponent;
 ```
 
-Defined in: [factories/components/AnimationFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/AnimationFactory.ts#L4)
+Defined in: [factories/components/AnimationFactory.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/factories/components/AnimationFactory.ts#L4)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createAudioComponent.md

@@ -15,7 +15,7 @@ function createAudioComponent(
    context?): AudioComponent;
 ```
 
-Defined in: [factories/components/AudioComponentFactory.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/AudioComponentFactory.ts#L126)
+Defined in: [factories/components/AudioComponentFactory.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/factories/components/AudioComponentFactory.ts#L126)
 
 ## Parameters
 

package/dist/docs/api/index/functions/createCameraComponent.md

@@ -13,7 +13,7 @@ function createCameraComponent(
    payload?): CameraComponent;
 ```
 
-Defined in: [factories/components/CameraFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/factories/components/CameraFactory.ts#L7)
+Defined in: [factories/components/CameraFactory.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/factories/components/CameraFactory.ts#L7)
 
 ## Parameters