@relu-interactives/spatial-ecs 0.5.2 → 0.8.0

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

@@ -0,0 +1,90 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRAnchorSystem
+
+# Class: XRAnchorSystem
+
+Defined in: [systems/XRAnchorSystem.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRAnchorSystem.ts#L55)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRAnchorSystem(): XRAnchorSystem;
+```
+
+#### Returns
+
+`XRAnchorSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world, deltaTime?): void;
+```
+
+Defined in: [systems/XRAnchorSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRAnchorSystem.ts#L65)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `world` | [`World`](World.md) | `undefined` |
+| `deltaTime` | `number` | `0` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### isAnchored()
+
+```ts
+isAnchored(entityId): boolean;
+```
+
+Defined in: [systems/XRAnchorSystem.ts:158](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRAnchorSystem.ts#L158)
+
+Whether this entity's pose is currently being driven by an anchor.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+
+#### Returns
+
+`boolean`
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [systems/XRAnchorSystem.ts:224](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRAnchorSystem.ts#L224)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

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

@@ -0,0 +1,77 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRControllerVisualSystem
+
+# Class: XRControllerVisualSystem
+
+Defined in: [systems/XRControllerVisualSystem.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRControllerVisualSystem.ts#L53)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRControllerVisualSystem(options?): XRControllerVisualSystem;
+```
+
+Defined in: [systems/XRControllerVisualSystem.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRControllerVisualSystem.ts#L68)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | \{ `interactionSystem?`: [`XRInteractionSystem`](XRInteractionSystem.md); `inputSystem?`: [`XRInputSystem`](XRInputSystem.md); \} |
+| `options.interactionSystem?` | [`XRInteractionSystem`](XRInteractionSystem.md) |
+| `options.inputSystem?` | [`XRInputSystem`](XRInputSystem.md) |
+
+#### Returns
+
+`XRControllerVisualSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/XRControllerVisualSystem.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRControllerVisualSystem.ts#L79)
+
+#### 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/XRControllerVisualSystem.ts:341](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRControllerVisualSystem.ts#L341)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

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

@@ -0,0 +1,137 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XREnvironmentSystem
+
+# Class: XREnvironmentSystem
+
+Defined in: [systems/XREnvironmentSystem.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XREnvironmentSystem.ts#L172)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XREnvironmentSystem(): XREnvironmentSystem;
+```
+
+#### Returns
+
+`XREnvironmentSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world, deltaTime?): void;
+```
+
+Defined in: [systems/XREnvironmentSystem.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XREnvironmentSystem.ts#L201)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `world` | [`World`](World.md) | `undefined` |
+| `deltaTime` | `number` | `0` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### getDetectedCount()
+
+```ts
+getDetectedCount(): {
+  planes: number;
+  meshes: number;
+};
+```
+
+Defined in: [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XREnvironmentSystem.ts#L329)
+
+How many pieces of real geometry are currently colliding. Script-facing.
+
+#### Returns
+
+```ts
+{
+  planes: number;
+  meshes: number;
+}
+```
+
+| Name | Type | Defined in |
+| ------ | ------ | ------ |
+| `planes` | `number` | [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XREnvironmentSystem.ts#L329) |
+| `meshes` | `number` | [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XREnvironmentSystem.ts#L329) |
+
+***
+
+### getDebugSnapshot()
+
+```ts
+getDebugSnapshot(world): {
+  kind: "plane" | "mesh";
+  label: string | null;
+  position: {
+     x: number;
+     y: number;
+     z: number;
+  };
+  radius: number;
+  emulated: boolean;
+}[];
+```
+
+Defined in: [systems/XREnvironmentSystem.ts:340](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XREnvironmentSystem.ts#L340)
+
+A census of every surface currently spawned: what it is, where it sits and
+roughly how big it is. Built for the template's post-session readout, so a
+mystery shape on the headset can be looked up by its label instead of
+guessed at — a small-radius entry at head height IS the mystery shape, and
+a clean list means whatever was seen did not come from this system.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+***
+
+### dispose()
+
+```ts
+dispose(world): void;
+```
+
+Defined in: [systems/XREnvironmentSystem.ts:911](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XREnvironmentSystem.ts#L911)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

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

@@ -0,0 +1,107 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRHandPoseSystem
+
+# Class: XRHandPoseSystem
+
+Defined in: [systems/XRHandPoseSystem.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHandPoseSystem.ts#L46)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRHandPoseSystem(inputSystem): XRHandPoseSystem;
+```
+
+Defined in: [systems/XRHandPoseSystem.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHandPoseSystem.ts#L56)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `inputSystem` | [`XRInputSystem`](XRInputSystem.md) |
+
+#### Returns
+
+`XRHandPoseSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world, deltaTime): void;
+```
+
+Defined in: [systems/XRHandPoseSystem.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHandPoseSystem.ts#L60)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `deltaTime` | `number` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### getHandShape()
+
+```ts
+getHandShape(handedness): XrHandShape | null;
+```
+
+Defined in: [systems/XRHandPoseSystem.ts:224](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHandPoseSystem.ts#L224)
+
+Live shape for a hand — powers the editor's pose readout.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `handedness` | `"left"` \| `"right"` |
+
+#### Returns
+
+[`XrHandShape`](../type-aliases/XrHandShape.md) \| `null`
+
+***
+
+### isPoseActive()
+
+```ts
+isPoseActive(
+   entityId, 
+   poseId, 
+   handedness): boolean;
+```
+
+Defined in: [systems/XRHandPoseSystem.ts:229](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHandPoseSystem.ts#L229)
+
+Whether a given entity's pose is currently held.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | `number` |
+| `poseId` | `string` |
+| `handedness` | `"left"` \| `"right"` |
+
+#### Returns
+
+`boolean`

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

@@ -0,0 +1,93 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRHitTestSystem
+
+# Class: XRHitTestSystem
+
+Defined in: [systems/XRHitTestSystem.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHitTestSystem.ts#L57)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRHitTestSystem(): XRHitTestSystem;
+```
+
+#### Returns
+
+`XRHitTestSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world): void;
+```
+
+Defined in: [systems/XRHitTestSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHitTestSystem.ts#L65)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### getHitResult()
+
+```ts
+getHitResult(target?): XrHitResult | null;
+```
+
+Defined in: [systems/XRHitTestSystem.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHitTestSystem.ts#L120)
+
+Where the given ray meets the real world this frame, or null.
+
+Null is the normal case, not an error: the source may still be being
+requested, the ray may point at nothing recognised, or the runtime may not
+have granted `hit-test` at all.
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `target` | `TargetKey` | `"viewer"` |
+
+#### Returns
+
+[`XrHitResult`](../type-aliases/XrHitResult.md) \| `null`
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [systems/XRHitTestSystem.ts:187](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHitTestSystem.ts#L187)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)

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

@@ -0,0 +1,76 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / XRHoverVisualSystem
+
+# Class: XRHoverVisualSystem
+
+Defined in: [systems/XRHoverVisualSystem.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHoverVisualSystem.ts#L48)
+
+## Implements
+
+- [`EcsSystem`](../interfaces/EcsSystem.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new XRHoverVisualSystem(interactionSystem): XRHoverVisualSystem;
+```
+
+Defined in: [systems/XRHoverVisualSystem.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHoverVisualSystem.ts#L52)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `interactionSystem` | [`XRInteractionSystem`](XRInteractionSystem.md) |
+
+#### Returns
+
+`XRHoverVisualSystem`
+
+## Methods
+
+### update()
+
+```ts
+update(world, deltaTime): void;
+```
+
+Defined in: [systems/XRHoverVisualSystem.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHoverVisualSystem.ts#L56)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `world` | [`World`](World.md) |
+| `deltaTime` | `number` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [systems/XRHoverVisualSystem.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/XRHoverVisualSystem.ts#L246)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)