@relu-interactives/spatial-ecs 0.5.2 → 0.8.0

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

@@ -0,0 +1,189 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRInputSystem
+
+# Class: XRInputSystem
+
+Defined in: [systems/XRInputSystem.ts:161](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L161)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRInputSystem(): XRInputSystem;
+```
+
+#### Returns
+
+`XRInputSystem`
+
+## Methods
+
+### attachSession()
+
+```ts
+attachSession(session): void;
+```
+
+Defined in: [systems/XRInputSystem.ts:199](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L199)
+
+Bind to a session. Called by [XRSessionSystem](XRSessionSystem.md) on session start.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `session` | `XRSession` |
+
+#### Returns
+
+`void`
+
+***
+
+### detachSession()
+
+```ts
+detachSession(): void;
+```
+
+Defined in: [systems/XRInputSystem.ts:212](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L212)
+
+Unbind and drop all per-source state.
+
+#### Returns
+
+`void`
+
+***
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/XRInputSystem.ts:236](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L236)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### getInputs()
+
+```ts
+getInputs(): XrInputState[];
+```
+
+Defined in: [systems/XRInputSystem.ts:384](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L384)
+
+Every input source active this frame.
+
+#### Returns
+
+[`XrInputState`](../type-aliases/XrInputState.md)[]
+
+***
+
+### getInput()
+
+```ts
+getInput(handedness): XrInputState | null;
+```
+
+Defined in: [systems/XRInputSystem.ts:389](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L389)
+
+The first source for a hand, or null. Prefer this for hand-specific logic.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `handedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) |
+
+#### Returns
+
+[`XrInputState`](../type-aliases/XrInputState.md) \| `null`
+
+***
+
+### getHandInput()
+
+```ts
+getHandInput(handedness): XrInputState | null;
+```
+
+Defined in: [systems/XRInputSystem.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L407)
+
+The ARTICULATED source for a hand — the one carrying joint poses.
+
+Distinct from [getInput](#getinput) because a hand can be backed by several
+sources at once: a Quest reports a controller AND a tracked hand for the
+same handedness, and Vision Pro adds a transient pinch alongside its two
+persistent hands. `getInput` returns whichever was seen first, so anything
+needing JOINTS has to ask for them specifically — taking the first match
+silently handed pose detection a controller with no joints, and no pose
+ever fired.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `handedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) |
+
+#### Returns
+
+[`XrInputState`](../type-aliases/XrInputState.md) \| `null`
+
+***
+
+### isSelecting()
+
+```ts
+isSelecting(): boolean;
+```
+
+Defined in: [systems/XRInputSystem.ts:417](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L417)
+
+True while ANY source is selecting — the portable "is the user acting" check.
+
+#### Returns
+
+`boolean`
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [systems/XRInputSystem.ts:424](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInputSystem.ts#L424)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

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

@@ -0,0 +1,323 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRInteractionSystem
+
+# Class: XRInteractionSystem
+
+Defined in: [systems/XRInteractionSystem.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L105)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRInteractionSystem(inputSystem): XRInteractionSystem;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:121](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L121)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `inputSystem` | [`XRInputSystem`](XRInputSystem.md) |
+
+#### Returns
+
+`XRInteractionSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world, deltaTime): void;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:125](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L125)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `deltaTime` | `number` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### getHoveredEntityId()
+
+```ts
+getHoveredEntityId(): number | null;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:955](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L955)
+
+Entity currently under a pointer this frame, or null.
+
+#### Returns
+
+`number` \| `null`
+
+***
+
+### getHoverFor()
+
+```ts
+getHoverFor(handedness): 
+  | {
+  entityId: number;
+  distance: number;
+}
+  | null;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:965](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L965)
+
+What this hand is pointing at, with the distance to it.
+
+The distance is what lets the pointer ray stop at the surface instead of
+passing through the object.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `handedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) |
+
+#### Returns
+
+  \| \{
+  `entityId`: `number`;
+  `distance`: `number`;
+\}
+  \| `null`
+
+***
+
+### getHoveredEntityIds()
+
+```ts
+getHoveredEntityIds(): Set<number>;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:975](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L975)
+
+Every entity under a pointer this frame — drives hover feedback.
+
+#### Returns
+
+`Set`\<`number`\>
+
+***
+
+### getHeldEntityIds()
+
+```ts
+getHeldEntityIds(): Set<number>;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:982](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L982)
+
+Entities currently held, so hover feedback can skip them.
+
+#### Returns
+
+`Set`\<`number`\>
+
+***
+
+### isGrabbing()
+
+```ts
+isGrabbing(): boolean;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:989](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L989)
+
+True when any source is holding something.
+
+#### Returns
+
+`boolean`
+
+***
+
+### isSourceBusy()
+
+```ts
+isSourceBusy(world, input): boolean;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:1007](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1007)
+
+Whether this input's primary action is committed to interaction.
+
+True while the source holds something, and also while it merely HOVERS a
+grabbable — because the pinch that is about to grab must not be read as a
+teleport by the locomotion system. Without the hover half, the first pinch
+of a grab teleports the player, and so does the pinch that takes an object
+from the other hand.
+
+Keyed on the INPUT SOURCE rather than handedness. Vision Pro reports
+`handedness: "none"` for every gaze-pinch (it is hard-coded in WebKit), so a
+handedness-keyed check silently never matched there and each pinch both
+grabbed and teleported.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `input` | [`XrInputState`](../type-aliases/XrInputState.md) |
+
+#### Returns
+
+`boolean`
+
+***
+
+### registerBusyContributor()
+
+```ts
+registerBusyContributor(contributor): void;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:1038](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1038)
+
+OR-ed into isSourceBusy; see the comment there.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `contributor` | (`world`, `input`) => `boolean` |
+
+#### Returns
+
+`void`
+
+***
+
+### getHoverForInput()
+
+```ts
+getHoverForInput(input): 
+  | {
+  entityId: number;
+  distance: number;
+}
+  | null;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:1046](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1046)
+
+Hover for a specific input source (handedness-free — Vision Pro's
+transient pointers all report handedness "none").
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `input` | [`XrInputState`](../type-aliases/XrInputState.md) |
+
+#### Returns
+
+  \| \{
+  `entityId`: `number`;
+  `distance`: `number`;
+\}
+  \| `null`
+
+***
+
+### isGrabbingWith()
+
+```ts
+isGrabbingWith(handedness): boolean;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:1053](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1053)
+
+True when THIS hand is holding something.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `handedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) |
+
+#### Returns
+
+`boolean`
+
+***
+
+### getGrabInfo()
+
+```ts
+getGrabInfo(entityId): 
+  | {
+  hands: number;
+  primaryHandedness: XrHandedness | null;
+  secondaryHandedness: XrHandedness | null;
+  handSeparation: number | null;
+  attachPointIds: (string | null)[];
+}
+  | null;
+```
+
+Defined in: [systems/XRInteractionSystem.ts:1068](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1068)
+
+How an entity is currently held.
+
+Exposed for scripts: a Behaviour can poll this in `onUpdate` to drive
+two-hand-specific behaviour — showing a bipod when both hands are on a
+weapon, reading the live hand separation to gate a gesture, or reacting to
+the scale a pull-apart produced. Returns null when nothing holds it.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+##### Type Literal
+
+```ts
+{
+  hands: number;
+  primaryHandedness: XrHandedness | null;
+  secondaryHandedness: XrHandedness | null;
+  handSeparation: number | null;
+  attachPointIds: (string | null)[];
+}
+```
+
+| Name | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| `hands` | `number` | - | [systems/XRInteractionSystem.ts:1069](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1069) |
+| `primaryHandedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) \| `null` | - | [systems/XRInteractionSystem.ts:1070](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1070) |
+| `secondaryHandedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) \| `null` | - | [systems/XRInteractionSystem.ts:1071](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1071) |
+| `handSeparation` | `number` \| `null` | Metres between the hands, or null unless two hands are on it. | [systems/XRInteractionSystem.ts:1073](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1073) |
+| `attachPointIds` | (`string` \| `null`)[] | The attach point ids in use, in holder order. | [systems/XRInteractionSystem.ts:1075](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRInteractionSystem.ts#L1075) |
+
+***
+
+`null`

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

@@ -0,0 +1,128 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRLocomotionSystem
+
+# Class: XRLocomotionSystem
+
+Defined in: [systems/XRLocomotionSystem.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRLocomotionSystem.ts#L34)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRLocomotionSystem(inputSystem): XRLocomotionSystem;
+```
+
+Defined in: [systems/XRLocomotionSystem.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRLocomotionSystem.ts#L69)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `inputSystem` | [`XRInputSystem`](XRInputSystem.md) |
+
+#### Returns
+
+`XRLocomotionSystem`
+
+## Methods
+
+### setInteractionSystem()
+
+```ts
+setInteractionSystem(interactionSystem): void;
+```
+
+Defined in: [systems/XRLocomotionSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRLocomotionSystem.ts#L65)
+
+Wire the interaction system so grabs suppress teleport on that hand.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `interactionSystem` | [`XRInteractionSystem`](XRInteractionSystem.md) \| `null` |
+
+#### Returns
+
+`void`
+
+***
+
+### update()
+
+```ts
+update(world, deltaTime): void;
+```
+
+Defined in: [systems/XRLocomotionSystem.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRLocomotionSystem.ts#L73)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `deltaTime` | `number` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### getAimCurve()
+
+```ts
+getAimCurve(): Vector3[];
+```
+
+Defined in: [systems/XRLocomotionSystem.ts:397](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRLocomotionSystem.ts#L397)
+
+Arc points up to the landing spot this frame; empty when not aiming.
+
+#### Returns
+
+`Vector3`[]
+
+***
+
+### isAimValid()
+
+```ts
+isAimValid(): boolean;
+```
+
+Defined in: [systems/XRLocomotionSystem.ts:402](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRLocomotionSystem.ts#L402)
+
+True when the aim lands on a valid teleport area.
+
+#### Returns
+
+`boolean`
+
+***
+
+### getLandingPoint()
+
+```ts
+getLandingPoint(): Vector3 | null;
+```
+
+Defined in: [systems/XRLocomotionSystem.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRLocomotionSystem.ts#L407)
+
+Where the arc currently lands, or null when not aiming at a valid area.
+
+#### Returns
+
+`Vector3` \| `null`