@relu-interactives/spatial-ecs 0.2.2

package/dist/docs/api/types/type-aliases/EcsEntityKind.md

@@ -0,0 +1,35 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / EcsEntityKind
+
+# Type Alias: EcsEntityKind
+
+```ts
+type EcsEntityKind = 
+  | "cube"
+  | "sphere"
+  | "plane"
+  | "capsule"
+  | "cylinder"
+  | "empty"
+  | "model"
+  | "image"
+  | "imageTarget"
+  | "sprite"
+  | "audio"
+  | "camera"
+  | "video"
+  | "ambientLight"
+  | "directionalLight"
+  | "pointLight"
+  | "spotLight"
+  | "areaLight";
+```
+
+Defined in: [types.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L19)
+
+Built-in entity kinds recognized by the ECS factory registry. Each kind
+maps to an object factory in `core/factories/objects/*` that creates the
+baseline component set.

package/dist/docs/api/types/type-aliases/EntityId.md

@@ -0,0 +1,16 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / EntityId
+
+# Type Alias: EntityId
+
+```ts
+type EntityId = number;
+```
+
+Defined in: [types.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L12)
+
+Numeric identifier for an entity. Entities are pure ids — all data lives in
+components attached to the entity.

package/dist/docs/api/types/type-aliases/EntityInput.md

@@ -0,0 +1,23 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / EntityInput
+
+# Type Alias: EntityInput
+
+```ts
+type EntityInput = {
+  type: "entity";
+  value: EntityId | null;
+};
+```
+
+Defined in: [types.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L64)
+
+## Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="type"></a> `type` | `"entity"` | [types.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L64) |
+| <a id="value"></a> `value` | [`EntityId`](EntityId.md) \| `null` | [types.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L64) |

package/dist/docs/api/types/type-aliases/FloatInput.md

@@ -0,0 +1,13 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / FloatInput
+
+# Type Alias: FloatInput
+
+```ts
+type FloatInput = number;
+```
+
+Defined in: [types.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L49)

package/dist/docs/api/types/type-aliases/IntersectionResult.md

@@ -0,0 +1,29 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / IntersectionResult
+
+# Type Alias: IntersectionResult
+
+```ts
+type IntersectionResult = {
+  entityId: EntityId | null;
+  threeResult: THREE.Intersection;
+};
+```
+
+Defined in: [types.ts:151](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L151)
+
+Single hit returned by `World.raycast` / `World.raycastFrom`. Pairs the
+standard `THREE.Intersection` (`threeResult`) with the owning entity id
+(when the hit traces back to a registered ECS entity). `entityId` is
+`null` if the hit object is not part of any tracked entity (e.g. an
+editor helper).
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="entityid"></a> `entityId` | [`EntityId`](EntityId.md) \| `null` | The entity that owns the hit object, or `null` if untracked. | [types.ts:153](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L153) |
+| <a id="threeresult"></a> `threeResult` | `THREE.Intersection` | The underlying three.js intersection record. | [types.ts:155](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L155) |

package/dist/docs/api/types/type-aliases/ParentLookup.md

@@ -0,0 +1,26 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / ParentLookup
+
+# Type Alias: ParentLookup
+
+```ts
+type ParentLookup = {
+  parentIdComponent: ParentId | null;
+  parent: WorldEntityView | null;
+};
+```
+
+Defined in: [types.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L128)
+
+Result of a parent lookup. `parent` is `null` for entities at the root or
+for entities without a [ParentId](../../components/classes/ParentId.md) component.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="parentidcomponent"></a> `parentIdComponent` | [`ParentId`](../../components/classes/ParentId.md) \| `null` | The entity's `ParentId` component, or `null` if it has none. | [types.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L130) |
+| <a id="parent"></a> `parent` | [`WorldEntityView`](WorldEntityView.md) \| `null` | The resolved parent entity view, or `null` if the entity is at the root. | [types.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L132) |

package/dist/docs/api/types/type-aliases/SelectionListener.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / SelectionListener
+
+# Type Alias: SelectionListener
+
+```ts
+type SelectionListener = (entityId) => void;
+```
+
+Defined in: [types.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L43)
+
+Callback invoked when the selected entity changes. `null` indicates a deselection.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `entityId` | [`EntityId`](EntityId.md) \| `null` |
+
+## Returns
+
+`void`

package/dist/docs/api/types/type-aliases/SliderInput.md

@@ -0,0 +1,27 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / SliderInput
+
+# Type Alias: SliderInput
+
+```ts
+type SliderInput = {
+  min: number;
+  max: number;
+  step: number;
+  value: number;
+};
+```
+
+Defined in: [types.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L53)
+
+## Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="min"></a> `min` | `number` | [types.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L54) |
+| <a id="max"></a> `max` | `number` | [types.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L55) |
+| <a id="step"></a> `step` | `number` | [types.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L56) |
+| <a id="value"></a> `value` | `number` | [types.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L57) |

package/dist/docs/api/types/type-aliases/TextInput.md

@@ -0,0 +1,13 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / TextInput
+
+# Type Alias: TextInput
+
+```ts
+type TextInput = string;
+```
+
+Defined in: [types.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L48)

package/dist/docs/api/types/type-aliases/ToggleInput.md

@@ -0,0 +1,13 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / ToggleInput
+
+# Type Alias: ToggleInput
+
+```ts
+type ToggleInput = boolean;
+```
+
+Defined in: [types.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L62)

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

@@ -0,0 +1,23 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / Vec3
+
+# Type Alias: Vec3
+
+```ts
+type Vec3 = 
+  | THREE.Vector3
+  | {
+  x: number;
+  y: number;
+  z: number;
+};
+```
+
+Defined in: [types.ts:140](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L140)
+
+Loose 3D vector accepted by raycast and other spatial helpers. Either a
+live `THREE.Vector3` or a plain `{ x, y, z }` object — both are normalized
+internally before use.

package/dist/docs/api/types/type-aliases/Vector2Input.md

@@ -0,0 +1,23 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / Vector2Input
+
+# Type Alias: Vector2Input
+
+```ts
+type Vector2Input = {
+  x: number;
+  y: number;
+};
+```
+
+Defined in: [types.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L51)
+
+## Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="x"></a> `x` | `number` | [types.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L51) |
+| <a id="y"></a> `y` | `number` | [types.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L51) |

package/dist/docs/api/types/type-aliases/Vector3Input.md

@@ -0,0 +1,25 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / Vector3Input
+
+# Type Alias: Vector3Input
+
+```ts
+type Vector3Input = {
+  x: number;
+  y: number;
+  z: number;
+};
+```
+
+Defined in: [types.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L52)
+
+## Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="x"></a> `x` | `number` | [types.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L52) |
+| <a id="y"></a> `y` | `number` | [types.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L52) |
+| <a id="z"></a> `z` | `number` | [types.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L52) |

package/dist/docs/api/types/type-aliases/WorldEntityView.md

@@ -0,0 +1,17 @@
+[**@relu-interactives/spatial-ecs**](../../index.md)
+
+***
+
+[@relu-interactives/spatial-ecs](../../index.md) / [types](../index.md) / WorldEntityView
+
+# Type Alias: WorldEntityView
+
+```ts
+type WorldEntityView = NonNullable<ReturnType<World["getEntityById"]>>;
+```
+
+Defined in: [types.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/types.ts#L122)
+
+Lightweight, read-only view of an entity returned by `World.getEntityById`.
+Contains the entity id and its current component list at the moment of the
+lookup. Re-query each frame rather than caching across ticks.