@relu-interactives/spatial-ecs 0.5.2 → 0.8.0

package/dist/docs/api/components/type-aliases/UIToggleOptions.md

@@ -0,0 +1,35 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UIToggleOptions
+
+# Type Alias: UIToggleOptions
+
+```ts
+type UIToggleOptions = {
+  value?: boolean;
+  actionId?: string;
+  width?: number;
+  height?: number;
+  trackColor?: string;
+  accentColor?: string;
+  knobColor?: string;
+};
+```
+
+Defined in: [components/UIToggle.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L4)
+
+Optional initializer for [UIToggleComponent](../classes/UIToggleComponent.md).
+
+## Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="value"></a> `value?` | `boolean` | [components/UIToggle.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L5) |
+| <a id="actionid"></a> `actionId?` | `string` | [components/UIToggle.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L6) |
+| <a id="width"></a> `width?` | `number` | [components/UIToggle.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L7) |
+| <a id="height"></a> `height?` | `number` | [components/UIToggle.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L8) |
+| <a id="trackcolor"></a> `trackColor?` | `string` | [components/UIToggle.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L9) |
+| <a id="accentcolor"></a> `accentColor?` | `string` | [components/UIToggle.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L10) |
+| <a id="knobcolor"></a> `knobColor?` | `string` | [components/UIToggle.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIToggle.ts#L11) |

package/dist/docs/api/components/type-aliases/UiFollowMode.md

@@ -0,0 +1,15 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UiFollowMode
+
+# Type Alias: UiFollowMode
+
+```ts
+type UiFollowMode = "world" | "billboard";
+```
+
+Defined in: [components/UIPanel.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIPanel.ts#L4)
+
+How a panel orients itself while the experience runs.

package/dist/docs/api/components/type-aliases/UiTextAlign.md

@@ -0,0 +1,13 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UiTextAlign
+
+# Type Alias: UiTextAlign
+
+```ts
+type UiTextAlign = "left" | "center" | "right";
+```
+
+Defined in: [components/UIText.ts:3](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L3)

package/dist/docs/api/components/type-aliases/UiTextVAlign.md

@@ -0,0 +1,13 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / UiTextVAlign
+
+# Type Alias: UiTextVAlign
+
+```ts
+type UiTextVAlign = "top" | "middle" | "bottom";
+```
+
+Defined in: [components/UIText.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/UIText.ts#L4)

package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md

@@ -0,0 +1,29 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / VRTeleportAreaOptions
+
+# Type Alias: VRTeleportAreaOptions
+
+```ts
+type VRTeleportAreaOptions = {
+  enabled?: boolean;
+  shape?: VrTeleportShape;
+  width?: number;
+  depth?: number;
+};
+```
+
+Defined in: [components/VRTeleportArea.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L7)
+
+Optional initializer for [VRTeleportAreaComponent](../classes/VRTeleportAreaComponent.md).
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="enabled"></a> `enabled?` | `boolean` | Disable to keep the area authored but inert. | [components/VRTeleportArea.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L9) |
+| <a id="shape"></a> `shape?` | [`VrTeleportShape`](VrTeleportShape.md) | Footprint shape. | [components/VRTeleportArea.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L11) |
+| <a id="width"></a> `width?` | `number` | Full width in metres (`plane`), or diameter (`circle`). | [components/VRTeleportArea.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L13) |
+| <a id="depth"></a> `depth?` | `number` | Full depth in metres. Ignored for `circle`, which uses `width`. | [components/VRTeleportArea.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L15) |

package/dist/docs/api/components/type-aliases/Vec3.md

@@ -14,7 +14,7 @@ type Vec3 = {
 };
 ```
 
-Defined in: [components/Transform.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L10)
+Defined in: [components/Transform.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L10)
 
 Plain XYZ vector. All ECS transform fields use this shape rather than `THREE.Vector3` so they save cleanly with the project.
 
@@ -22,6 +22,6 @@ Plain XYZ vector. All ECS transform fields use this shape rather than `THREE.Vec
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="x"></a> `x` | `number` | X component. | [components/Transform.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L12) |
-| <a id="y"></a> `y` | `number` | Y component. | [components/Transform.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L14) |
-| <a id="z"></a> `z` | `number` | Z component. | [components/Transform.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Transform.ts#L16) |
+| <a id="x"></a> `x` | `number` | X component. | [components/Transform.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L12) |
+| <a id="y"></a> `y` | `number` | Y component. | [components/Transform.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L14) |
+| <a id="z"></a> `z` | `number` | Z component. | [components/Transform.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Transform.ts#L16) |

package/dist/docs/api/components/type-aliases/VrTeleportShape.md

@@ -0,0 +1,15 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / VrTeleportShape
+
+# Type Alias: VrTeleportShape
+
+```ts
+type VrTeleportShape = "plane" | "circle";
+```
+
+Defined in: [components/VRTeleportArea.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/VRTeleportArea.ts#L4)
+
+Footprint of a teleport destination.

package/dist/docs/api/components/type-aliases/XRAnchorOptions.md

@@ -0,0 +1,23 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRAnchorOptions
+
+# Type Alias: XRAnchorOptions
+
+```ts
+type XRAnchorOptions = {
+  enabled?: boolean;
+};
+```
+
+Defined in: [components/XRAnchor.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRAnchor.ts#L4)
+
+Optional initializer for [XRAnchorComponent](../classes/XRAnchorComponent.md).
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="enabled"></a> `enabled?` | `boolean` | Whether the entity should anchor at all. Defaults to `true`. | [components/XRAnchor.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRAnchor.ts#L6) |

package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md

@@ -0,0 +1,23 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRHandPoseOptions
+
+# Type Alias: XRHandPoseOptions
+
+```ts
+type XRHandPoseOptions = {
+  enabled?: boolean;
+  poses?: XrHandPoseEntry[];
+};
+```
+
+Defined in: [components/XRHandPose.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L47)
+
+## Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="enabled"></a> `enabled?` | `boolean` | [components/XRHandPose.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L48) |
+| <a id="poses"></a> `poses?` | [`XrHandPoseEntry`](XrHandPoseEntry.md)[] | [components/XRHandPose.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L49) |

package/dist/docs/api/components/type-aliases/XRInteractableOptions.md

@@ -0,0 +1,75 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRInteractableOptions
+
+# Type Alias: XRInteractableOptions
+
+```ts
+type XRInteractableOptions = {
+  enabled?: boolean;
+  grabbable?: boolean;
+  pointable?: boolean;
+  grabReach?: XrGrabReach;
+  distanceBehavior?: XrDistanceGrabBehavior;
+  grabGesture?: XrGrabGesture;
+  grabRadius?: number;
+  grabOffsetPosition?: {
+     x: number;
+     y: number;
+     z: number;
+  };
+  grabOffsetRotation?: {
+     x: number;
+     y: number;
+     z: number;
+  };
+  grabHands?: XrGrabHands;
+  twoHandRotation?: XrTwoHandRotation;
+  allowTwoHandScale?: boolean;
+  minScale?: number;
+  maxScale?: number;
+  attachPoints?: XrAttachPoint[];
+  applyVelocityOnRelease?: boolean;
+  velocityScale?: number;
+  hoverBehavior?: XrHoverBehavior;
+  hoverColor?: string;
+  hoverScale?: number;
+};
+```
+
+Defined in: [components/XRInteractable.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L77)
+
+Optional initializer for [XRInteractableComponent](../classes/XRInteractableComponent.md).
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="enabled"></a> `enabled?` | `boolean` | - | [components/XRInteractable.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L78) |
+| <a id="grabbable"></a> `grabbable?` | `boolean` | - | [components/XRInteractable.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L79) |
+| <a id="pointable"></a> `pointable?` | `boolean` | - | [components/XRInteractable.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L80) |
+| <a id="grabreach"></a> `grabReach?` | [`XrGrabReach`](XrGrabReach.md) | - | [components/XRInteractable.ts:81](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L81) |
+| <a id="distancebehavior"></a> `distanceBehavior?` | [`XrDistanceGrabBehavior`](XrDistanceGrabBehavior.md) | - | [components/XRInteractable.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L82) |
+| <a id="grabgesture"></a> `grabGesture?` | [`XrGrabGesture`](XrGrabGesture.md) | - | [components/XRInteractable.ts:83](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L83) |
+| <a id="grabradius"></a> `grabRadius?` | `number` | Metres within which a `physical` grab registers. | [components/XRInteractable.ts:85](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L85) |
+| <a id="graboffsetposition"></a> `grabOffsetPosition?` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Where the object sits relative to the hand once held. | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L87) |
+| `grabOffsetPosition.x` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L87) |
+| `grabOffsetPosition.y` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L87) |
+| `grabOffsetPosition.z` | `number` | - | [components/XRInteractable.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L87) |
+| <a id="graboffsetrotation"></a> `grabOffsetRotation?` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Orientation offset, in radians. | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L89) |
+| `grabOffsetRotation.x` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L89) |
+| `grabOffsetRotation.y` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L89) |
+| `grabOffsetRotation.z` | `number` | - | [components/XRInteractable.ts:89](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L89) |
+| <a id="grabhands"></a> `grabHands?` | [`XrGrabHands`](XrGrabHands.md) | How many hands may hold it, and whether a second grab transfers it. | [components/XRInteractable.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L91) |
+| <a id="twohandrotation"></a> `twoHandRotation?` | [`XrTwoHandRotation`](XrTwoHandRotation.md) | Whether the second hand aims the object or only scales it. | [components/XRInteractable.ts:93](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L93) |
+| <a id="allowtwohandscale"></a> `allowTwoHandScale?` | `boolean` | Let a two-hand grab resize the object by moving the hands apart. | [components/XRInteractable.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L95) |
+| <a id="minscale"></a> `minScale?` | `number` | Smallest fraction of its size a single scaling gesture may reach. | [components/XRInteractable.ts:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L97) |
+| <a id="maxscale"></a> `maxScale?` | `number` | Largest multiple of its size a single scaling gesture may reach. | [components/XRInteractable.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L99) |
+| <a id="attachpoints"></a> `attachPoints?` | [`XrAttachPoint`](XrAttachPoint.md)[] | Authored hand-holds. Empty means grab anywhere. | [components/XRInteractable.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L101) |
+| <a id="applyvelocityonrelease"></a> `applyVelocityOnRelease?` | `boolean` | Hand the object the velocity it was moving with when released. | [components/XRInteractable.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L103) |
+| <a id="velocityscale"></a> `velocityScale?` | `number` | Scales released velocity; >1 makes throws feel stronger than real life. | [components/XRInteractable.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L105) |
+| <a id="hoverbehavior"></a> `hoverBehavior?` | `XrHoverBehavior` | Feedback shown while a pointer is on the object. | [components/XRInteractable.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L107) |
+| <a id="hovercolor"></a> `hoverColor?` | `string` | Outline colour used by the `color` and `both` behaviours. | [components/XRInteractable.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L109) |
+| <a id="hoverscale"></a> `hoverScale?` | `number` | Size multiplier used by the `scale` and `both` behaviours. | [components/XRInteractable.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L111) |

package/dist/docs/api/components/type-aliases/XRInteractorOptions.md

@@ -0,0 +1,37 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRInteractorOptions
+
+# Type Alias: XRInteractorOptions
+
+```ts
+type XRInteractorOptions = {
+  interactorType?: XrInteractorType;
+  handPreset?: XrHandPreset;
+  handColor?: string;
+  handOpacity?: number;
+  handEmissiveIntensity?: number;
+  rayVisibility?: XrRayVisibility;
+  rayColor?: string;
+  rayThickness?: number;
+};
+```
+
+Defined in: [components/XRInteractor.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L41)
+
+Optional initializer for [XRInteractorComponent](../classes/XRInteractorComponent.md).
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="interactortype"></a> `interactorType?` | [`XrInteractorType`](XrInteractorType.md) | What to render at the hands. | [components/XRInteractor.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L43) |
+| <a id="handpreset"></a> `handPreset?` | [`XrHandPreset`](XrHandPreset.md) | Look for tracked-hand meshes. | [components/XRInteractor.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L45) |
+| <a id="handcolor"></a> `handColor?` | `string` | Tint applied by the preset (and by `custom`). | [components/XRInteractor.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L47) |
+| <a id="handopacity"></a> `handOpacity?` | `number` | 0-1; `ghost` leans on this. | [components/XRInteractor.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L49) |
+| <a id="handemissiveintensity"></a> `handEmissiveIntensity?` | `number` | Emissive strength, used by `neon`. | [components/XRInteractor.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L51) |
+| <a id="rayvisibility"></a> `rayVisibility?` | `XrRayVisibility` | When the pointer ray is drawn. | [components/XRInteractor.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L54) |
+| <a id="raycolor"></a> `rayColor?` | `string` | Pointer ray colour. | [components/XRInteractor.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L56) |
+| <a id="raythickness"></a> `rayThickness?` | `number` | Pointer ray thickness (diameter), metres. | [components/XRInteractor.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L58) |

package/dist/docs/api/components/type-aliases/XRRigOptions.md

@@ -0,0 +1,51 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XRRigOptions
+
+# Type Alias: XRRigOptions
+
+```ts
+type XRRigOptions = {
+  trackingOrigin?: XrTrackingOrigin;
+  locomotion?: XrLocomotionMode;
+  moveSpeed?: number;
+  snapTurn?: boolean;
+  snapTurnDegrees?: number;
+  fallbackEyeHeight?: number;
+  teleportArcColor?: string;
+  teleportArcInvalidColor?: string;
+  teleportArcThickness?: number;
+  passthrough?: boolean;
+  depthOcclusion?: boolean;
+  environmentPhysics?: XrEnvironmentPhysics;
+  environmentDebug?: boolean;
+  hitTest?: boolean;
+  anchors?: boolean;
+};
+```
+
+Defined in: [components/XRRig.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L36)
+
+Optional initializer for [XRRigComponent](../classes/XRRigComponent.md).
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="trackingorigin"></a> `trackingOrigin?` | [`XrTrackingOrigin`](XrTrackingOrigin.md) | Where the headset origin sits. Defaults to `floor`. | [components/XRRig.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L38) |
+| <a id="locomotion"></a> `locomotion?` | [`XrLocomotionMode`](XrLocomotionMode.md) | Movement style. Defaults to `teleport` — the most comfort-safe option. | [components/XRRig.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L40) |
+| <a id="movespeed"></a> `moveSpeed?` | `number` | Metres/second for `smooth` locomotion. | [components/XRRig.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L42) |
+| <a id="snapturn"></a> `snapTurn?` | `boolean` | Rotate in fixed steps instead of continuously (greatly reduces nausea). | [components/XRRig.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L44) |
+| <a id="snapturndegrees"></a> `snapTurnDegrees?` | `number` | Degrees per snap-turn step. | [components/XRRig.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L46) |
+| <a id="fallbackeyeheight"></a> `fallbackEyeHeight?` | `number` | Height in metres used when the device reports no floor-relative space. | [components/XRRig.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L48) |
+| <a id="teleportarccolor"></a> `teleportArcColor?` | `string` | Teleport arc colour when it lands somewhere valid. | [components/XRRig.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L50) |
+| <a id="teleportarcinvalidcolor"></a> `teleportArcInvalidColor?` | `string` | Teleport arc colour when it lands nowhere teleportable. | [components/XRRig.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L52) |
+| <a id="teleportarcthickness"></a> `teleportArcThickness?` | `number` | Teleport arc thickness (diameter), metres. | [components/XRRig.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L54) |
+| <a id="passthrough"></a> `passthrough?` | `boolean` | Run the session in passthrough (`immersive-ar`) instead of VR. | [components/XRRig.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L58) |
+| <a id="depthocclusion"></a> `depthOcclusion?` | `boolean` | Let real objects occlude virtual ones, via WebXR depth sensing. | [components/XRRig.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L60) |
+| <a id="environmentphysics"></a> `environmentPhysics?` | [`XrEnvironmentPhysics`](XrEnvironmentPhysics.md) | Which detected real-world geometry becomes physics colliders. | [components/XRRig.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L62) |
+| <a id="environmentdebug"></a> `environmentDebug?` | `boolean` | Draw the detected room geometry on-device, for checking a scan. | [components/XRRig.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L64) |
+| <a id="hittest"></a> `hitTest?` | `boolean` | Allow scripts to raycast against the real room (`hit-test`). | [components/XRRig.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L66) |
+| <a id="anchors"></a> `anchors?` | `boolean` | Allow content to be pinned to real-world features (`anchors`). | [components/XRRig.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L68) |

package/dist/docs/api/components/type-aliases/XrAttachPoint.md

@@ -0,0 +1,53 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrAttachPoint
+
+# Type Alias: XrAttachPoint
+
+```ts
+type XrAttachPoint = {
+  id: string;
+  name: string;
+  position: {
+     x: number;
+     y: number;
+     z: number;
+  };
+  rotation: {
+     x: number;
+     y: number;
+     z: number;
+  };
+  hand: "left" | "right" | "any";
+  role: "primary" | "secondary" | "any";
+};
+```
+
+Defined in: [components/XRInteractable.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L40)
+
+A hand-hold authored on the object.
+
+Without attach points a hand grabs wherever it happens to touch, which is
+right for a ball and wrong for a rifle — a weapon has a grip and a foregrip,
+and the hands belong on those exact spots. `role` is what lets an author say
+"this is the trigger hand's hold" so a two-hand grab assembles correctly no
+matter which hand arrives first.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | Stable id; referenced by scripts and by the inspector list. | [components/XRInteractable.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L42) |
+| <a id="name"></a> `name` | `string` | - | [components/XRInteractable.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L43) |
+| <a id="position"></a> `position` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Object-local position of the hold (unscaled). | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L45) |
+| `position.x` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L45) |
+| `position.y` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L45) |
+| `position.z` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L45) |
+| <a id="rotation"></a> `rotation` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Object-local orientation of the hold, radians. | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L47) |
+| `rotation.x` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L47) |
+| `rotation.y` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L47) |
+| `rotation.z` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L47) |
+| <a id="hand"></a> `hand` | `"left"` \| `"right"` \| `"any"` | Restrict to one hand, or `any`. | [components/XRInteractable.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L49) |
+| <a id="role"></a> `role` | `"primary"` \| `"secondary"` \| `"any"` | Whether this hold is the anchoring hand, the steering hand, or either. | [components/XRInteractable.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L51) |

package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md

@@ -0,0 +1,19 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrDistanceGrabBehavior
+
+# Type Alias: XrDistanceGrabBehavior
+
+```ts
+type XrDistanceGrabBehavior = "snap" | "remote";
+```
+
+Defined in: [components/XRInteractable.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L20)
+
+What a distance grab does to the object.
+
+`snap` brings it to the hand (Half-Life: Alyx style — good for picking things
+up). `remote` leaves it where it is and manipulates it at range, which suits
+large or anchored objects that would look absurd flying into your palm.

package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md

@@ -0,0 +1,15 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrEnvironmentKind
+
+# Type Alias: XrEnvironmentKind
+
+```ts
+type XrEnvironmentKind = "plane" | "mesh";
+```
+
+Defined in: [components/XREnvironment.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XREnvironment.ts#L4)
+
+Which WebXR module reported this piece of the room.

package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md

@@ -0,0 +1,15 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrEnvironmentOrientation
+
+# Type Alias: XrEnvironmentOrientation
+
+```ts
+type XrEnvironmentOrientation = "horizontal" | "vertical";
+```
+
+Defined in: [components/XREnvironment.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XREnvironment.ts#L7)
+
+How a detected plane sits in the world, when the runtime says.

package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrEnvironmentPhysics
+
+# Type Alias: XrEnvironmentPhysics
+
+```ts
+type XrEnvironmentPhysics = "none" | "planes" | "mesh" | "auto";
+```
+
+Defined in: [components/XRRig.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L33)
+
+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.

package/dist/docs/api/components/type-aliases/XrGrabGesture.md

@@ -0,0 +1,19 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrGrabGesture
+
+# Type Alias: XrGrabGesture
+
+```ts
+type XrGrabGesture = "any" | "pinch" | "full";
+```
+
+Defined in: [components/XRInteractable.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L29)
+
+Which gesture grabs the object.
+
+`pinch` maps to the primary action (trigger / finger pinch), `full` to the
+grip squeeze (whole-hand close). Distinguishing them lets a scene mix
+precise pickups with firm grabs — a chess piece versus a suitcase handle.

package/dist/docs/api/components/type-aliases/XrGrabHands.md

@@ -0,0 +1,20 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrGrabHands
+
+# Type Alias: XrGrabHands
+
+```ts
+type XrGrabHands = "single" | "handOff" | "two";
+```
+
+Defined in: [components/XRInteractable.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L62)
+
+How many hands may hold the object at once, and what a second grab does.
+
+`single` is a plain pickup. `handOff` lets the other hand TAKE it — the
+everyday gesture of passing something between your hands. `two` keeps both
+hands on it, which is what enables aiming a two-handed weapon and
+pull-apart scaling.

package/dist/docs/api/components/type-aliases/XrGrabReach.md

@@ -0,0 +1,20 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrGrabReach
+
+# Type Alias: XrGrabReach
+
+```ts
+type XrGrabReach = "physical" | "distance" | "both";
+```
+
+Defined in: [components/XRInteractable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L11)
+
+How close the user must be to grab.
+
+`physical` requires the hand to actually reach the object — the honest,
+embodied interaction. `distance` allows grabbing across the room along the
+pointer ray, which is what makes seated and room-scale play comfortable.
+`both` accepts either, and is the friendliest default.