@relu-interactives/spatial-ecs 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +125 -0
- package/dist/System-rXAmagXA.d.cts +659 -0
- package/dist/System-rXAmagXA.d.ts +659 -0
- package/dist/Video-CDemv74U.d.cts +1261 -0
- package/dist/Video-ChKV1UI7.d.ts +1261 -0
- package/dist/assets/draco/draco_decoder.js +34 -0
- package/dist/assets/draco/draco_decoder.wasm +0 -0
- package/dist/assets/draco/draco_wasm_wrapper.js +117 -0
- package/dist/chunk-AYEF3X2P.js +223 -0
- package/dist/chunk-AYEF3X2P.js.map +1 -0
- package/dist/chunk-MAWBTMCG.js +1722 -0
- package/dist/chunk-MAWBTMCG.js.map +1 -0
- package/dist/chunk-NFDTIYR4.js +248 -0
- package/dist/chunk-NFDTIYR4.js.map +1 -0
- package/dist/chunk-OY7ZODZP.js +16 -0
- package/dist/chunk-OY7ZODZP.js.map +1 -0
- package/dist/chunk-P2YDX5DB.js +3304 -0
- package/dist/chunk-P2YDX5DB.js.map +1 -0
- package/dist/chunk-QHILSPT4.js +3 -0
- package/dist/chunk-QHILSPT4.js.map +1 -0
- package/dist/chunk-XWIEEJ7Z.js +1315 -0
- package/dist/chunk-XWIEEJ7Z.js.map +1 -0
- package/dist/components/index.cjs +1745 -0
- package/dist/components/index.cjs.map +1 -0
- package/dist/components/index.d.cts +4 -0
- package/dist/components/index.d.ts +4 -0
- package/dist/components/index.js +4 -0
- package/dist/components/index.js.map +1 -0
- package/dist/docs/api/Behaviour/classes/Behaviour.md +554 -0
- package/dist/docs/api/Behaviour/index.md +15 -0
- package/dist/docs/api/Component/classes/Component.md +57 -0
- package/dist/docs/api/Component/index.md +15 -0
- package/dist/docs/api/components/classes/AnimationComponent.md +318 -0
- package/dist/docs/api/components/classes/AudioComponent.md +114 -0
- package/dist/docs/api/components/classes/CameraComponent.md +59 -0
- package/dist/docs/api/components/classes/EntityType.md +48 -0
- package/dist/docs/api/components/classes/Environment.md +47 -0
- package/dist/docs/api/components/classes/ImageComponent.md +57 -0
- package/dist/docs/api/components/classes/ImageTarget.md +60 -0
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +48 -0
- package/dist/docs/api/components/classes/LightComponent.md +70 -0
- package/dist/docs/api/components/classes/MaterialComponent.md +181 -0
- package/dist/docs/api/components/classes/MeshComponent.md +48 -0
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +64 -0
- package/dist/docs/api/components/classes/ModelComponent.md +49 -0
- package/dist/docs/api/components/classes/Name.md +46 -0
- package/dist/docs/api/components/classes/Object3DRef.md +54 -0
- package/dist/docs/api/components/classes/ParentId.md +47 -0
- package/dist/docs/api/components/classes/PhysicsComponent.md +82 -0
- package/dist/docs/api/components/classes/Postprocessing.md +49 -0
- package/dist/docs/api/components/classes/ScriptComponent.md +54 -0
- package/dist/docs/api/components/classes/Selectable.md +46 -0
- package/dist/docs/api/components/classes/SelectionTransformState.md +54 -0
- package/dist/docs/api/components/classes/SpriteComponent.md +55 -0
- package/dist/docs/api/components/classes/TransformComponent.md +197 -0
- package/dist/docs/api/components/classes/VideoComponent.md +123 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +23 -0
- package/dist/docs/api/components/index.md +94 -0
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +42 -0
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +45 -0
- package/dist/docs/api/components/type-aliases/CameraProjection.md +15 -0
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +15 -0
- package/dist/docs/api/components/type-aliases/ColliderShape.md +15 -0
- package/dist/docs/api/components/type-aliases/ColliderState.md +62 -0
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +27 -0
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +37 -0
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +34 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +29 -0
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +25 -0
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +33 -0
- package/dist/docs/api/components/type-aliases/LightValueState.md +41 -0
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +15 -0
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +75 -0
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +13 -0
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +33 -0
- package/dist/docs/api/components/type-aliases/PhysicsState.md +25 -0
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +25 -0
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +164 -0
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +25 -0
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +23 -0
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +53 -0
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +19 -0
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +38 -0
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +15 -0
- package/dist/docs/api/components/type-aliases/TransformData.md +27 -0
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +15 -0
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +15 -0
- package/dist/docs/api/components/type-aliases/Vec3.md +27 -0
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +13 -0
- package/dist/docs/api/index/classes/AnimationStateMachine.md +201 -0
- package/dist/docs/api/index/classes/AnimationStateManager.md +253 -0
- package/dist/docs/api/index/classes/AnimationSystem.md +68 -0
- package/dist/docs/api/index/classes/AudioSystem.md +98 -0
- package/dist/docs/api/index/classes/CameraSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +75 -0
- package/dist/docs/api/index/classes/InputSystem.md +449 -0
- package/dist/docs/api/index/classes/LightSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +67 -0
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +49 -0
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +298 -0
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +49 -0
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +83 -0
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +80 -0
- package/dist/docs/api/index/classes/RenderSystem.md +64 -0
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +83 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/VideoSystem.md +97 -0
- package/dist/docs/api/index/classes/World.md +1405 -0
- package/dist/docs/api/index/functions/createAnimationComponent.md +28 -0
- package/dist/docs/api/index/functions/createAudioComponent.md +32 -0
- package/dist/docs/api/index/functions/createCameraComponent.md +28 -0
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +28 -0
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageTargetComponent.md +28 -0
- package/dist/docs/api/index/functions/createLightComponent.md +28 -0
- package/dist/docs/api/index/functions/createMaterialComponent.md +28 -0
- package/dist/docs/api/index/functions/createMeshComponent.md +28 -0
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +28 -0
- package/dist/docs/api/index/functions/createModelComponent.md +28 -0
- package/dist/docs/api/index/functions/createNameComponent.md +28 -0
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +28 -0
- package/dist/docs/api/index/functions/createParentIdComponent.md +28 -0
- package/dist/docs/api/index/functions/createPhysicsComponent.md +30 -0
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +28 -0
- package/dist/docs/api/index/functions/createScriptComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectableComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +28 -0
- package/dist/docs/api/index/functions/createSpriteComponent.md +28 -0
- package/dist/docs/api/index/functions/createTransformComponent.md +28 -0
- package/dist/docs/api/index/functions/createVideoComponent.md +28 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +28 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +28 -0
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +23 -0
- package/dist/docs/api/index/functions/registerDefaultFactories.md +23 -0
- package/dist/docs/api/index/index.md +249 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +50 -0
- package/dist/docs/api/index/interfaces/StateMachine.md +26 -0
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +25 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +25 -0
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +37 -0
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +26 -0
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +25 -0
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +23 -0
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +13 -0
- package/dist/docs/api/index/type-aliases/MouseButton.md +13 -0
- package/dist/docs/api/index/type-aliases/SelectionContext.md +31 -0
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +13 -0
- package/dist/docs/api/index/variables/KeyboardKeys.md +195 -0
- package/dist/docs/api/index.md +15 -0
- package/dist/docs/api/typedoc-sidebar.json +1 -0
- package/dist/docs/api/types/index.md +34 -0
- package/dist/docs/api/types/type-aliases/AssetInput.md +23 -0
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ColorInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ComponentInput.md +52 -0
- package/dist/docs/api/types/type-aliases/ComponentKind.md +37 -0
- package/dist/docs/api/types/type-aliases/DropdownInput.md +23 -0
- package/dist/docs/api/types/type-aliases/DropdownOption.md +23 -0
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +15 -0
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +35 -0
- package/dist/docs/api/types/type-aliases/EntityId.md +16 -0
- package/dist/docs/api/types/type-aliases/EntityInput.md +23 -0
- package/dist/docs/api/types/type-aliases/FloatInput.md +13 -0
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +29 -0
- package/dist/docs/api/types/type-aliases/ParentLookup.md +26 -0
- package/dist/docs/api/types/type-aliases/SelectionListener.md +25 -0
- package/dist/docs/api/types/type-aliases/SliderInput.md +27 -0
- package/dist/docs/api/types/type-aliases/TextInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ToggleInput.md +13 -0
- package/dist/docs/api/types/type-aliases/Vec3.md +23 -0
- package/dist/docs/api/types/type-aliases/Vector2Input.md +23 -0
- package/dist/docs/api/types/type-aliases/Vector3Input.md +25 -0
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +17 -0
- package/dist/docs/guide/accessing-components.md +399 -0
- package/dist/docs/guide/authoring-a-behaviour.md +166 -0
- package/dist/docs/guide/behaviour-lifecycle.md +43 -0
- package/dist/docs/guide/component-catalog.md +59 -0
- package/dist/docs/guide/components/_sidebar.json +78 -0
- package/dist/docs/guide/components/animation.md +171 -0
- package/dist/docs/guide/components/audio.md +181 -0
- package/dist/docs/guide/components/camera.md +179 -0
- package/dist/docs/guide/components/entity-type.md +141 -0
- package/dist/docs/guide/components/image-target-anchor.md +103 -0
- package/dist/docs/guide/components/image-target.md +122 -0
- package/dist/docs/guide/components/image.md +146 -0
- package/dist/docs/guide/components/light.md +157 -0
- package/dist/docs/guide/components/material.md +161 -0
- package/dist/docs/guide/components/mesh-geometry.md +153 -0
- package/dist/docs/guide/components/mesh.md +151 -0
- package/dist/docs/guide/components/model.md +96 -0
- package/dist/docs/guide/components/name.md +121 -0
- package/dist/docs/guide/components/object3d-ref.md +115 -0
- package/dist/docs/guide/components/parent-id.md +108 -0
- package/dist/docs/guide/components/physics.md +163 -0
- package/dist/docs/guide/components/script.md +142 -0
- package/dist/docs/guide/components/sprite.md +155 -0
- package/dist/docs/guide/components/transform.md +155 -0
- package/dist/docs/guide/components/video.md +153 -0
- package/dist/docs/guide/concepts.md +34 -0
- package/dist/docs/guide/getting-started/creating-objects.md +50 -0
- package/dist/docs/guide/getting-started/editing-objects.md +62 -0
- package/dist/docs/guide/getting-started/editor/assets-browser.md +55 -0
- package/dist/docs/guide/getting-started/editor/hierarchy.md +47 -0
- package/dist/docs/guide/getting-started/editor/index.md +16 -0
- package/dist/docs/guide/getting-started/editor/inspector.md +36 -0
- package/dist/docs/guide/getting-started/editor/modules.md +35 -0
- package/dist/docs/guide/getting-started/editor/scene-inspector.md +64 -0
- package/dist/docs/guide/getting-started/editor/toolbar.md +39 -0
- package/dist/docs/guide/getting-started/editor/viewport.md +43 -0
- package/dist/docs/guide/getting-started/first-launch.md +17 -0
- package/dist/docs/guide/getting-started/index.md +37 -0
- package/dist/docs/guide/getting-started/installation.md +59 -0
- package/dist/docs/guide/getting-started/preview-and-test.md +55 -0
- package/dist/docs/guide/getting-started/project-types/3d.md +30 -0
- package/dist/docs/guide/getting-started/project-types/ar.md +6 -0
- package/dist/docs/guide/getting-started/project-types/face-tracking.md +6 -0
- package/dist/docs/guide/getting-started/project-types/image-tracking.md +42 -0
- package/dist/docs/guide/getting-started/project-types/index.md +25 -0
- package/dist/docs/guide/getting-started/project-types/vr.md +6 -0
- package/dist/docs/guide/getting-started/projects.md +53 -0
- package/dist/docs/guide/getting-started/shortcuts.md +43 -0
- package/dist/docs/guide/inspector-data-binding.md +367 -0
- package/dist/docs/guide/reading-input.md +202 -0
- package/dist/docs/guide/scene/environment.md +101 -0
- package/dist/docs/guide/scene/index.md +36 -0
- package/dist/docs/guide/scene/postprocessing.md +108 -0
- package/dist/docs/guide/spawning/ambient-light.md +28 -0
- package/dist/docs/guide/spawning/area-light.md +32 -0
- package/dist/docs/guide/spawning/audio.md +42 -0
- package/dist/docs/guide/spawning/camera.md +50 -0
- package/dist/docs/guide/spawning/capsule.md +29 -0
- package/dist/docs/guide/spawning/cube.md +31 -0
- package/dist/docs/guide/spawning/cylinder.md +29 -0
- package/dist/docs/guide/spawning/directional-light.md +32 -0
- package/dist/docs/guide/spawning/empty.md +31 -0
- package/dist/docs/guide/spawning/image-target.md +48 -0
- package/dist/docs/guide/spawning/image.md +33 -0
- package/dist/docs/guide/spawning/index.md +79 -0
- package/dist/docs/guide/spawning/model.md +31 -0
- package/dist/docs/guide/spawning/plane.md +31 -0
- package/dist/docs/guide/spawning/point-light.md +32 -0
- package/dist/docs/guide/spawning/sphere.md +29 -0
- package/dist/docs/guide/spawning/spot-light.md +32 -0
- package/dist/docs/guide/spawning/sprite.md +31 -0
- package/dist/docs/guide/spawning/video.md +53 -0
- package/dist/docs/guide/system-overview.md +73 -0
- package/dist/docs/guide/systems/_sidebar.json +66 -0
- package/dist/docs/guide/systems/animation-system.md +32 -0
- package/dist/docs/guide/systems/audio-system.md +28 -0
- package/dist/docs/guide/systems/camera-sync-system.md +31 -0
- package/dist/docs/guide/systems/environment-sync-system.md +31 -0
- package/dist/docs/guide/systems/input-system.md +217 -0
- package/dist/docs/guide/systems/light-sync-system.md +29 -0
- package/dist/docs/guide/systems/material-sync-system.md +32 -0
- package/dist/docs/guide/systems/mesh-geometry-system.md +40 -0
- package/dist/docs/guide/systems/object-management-system.md +38 -0
- package/dist/docs/guide/systems/object-visibility-system.md +26 -0
- package/dist/docs/guide/systems/physics-sync-system.md +56 -0
- package/dist/docs/guide/systems/postprocessing-sync-system.md +43 -0
- package/dist/docs/guide/systems/render-system.md +22 -0
- package/dist/docs/guide/systems/script-behaviour-system.md +59 -0
- package/dist/docs/guide/systems/transform-sync-system.md +29 -0
- package/dist/docs/guide/systems/video-system.md +30 -0
- package/dist/docs/guide/world-api.md +405 -0
- package/dist/factories/index.cjs +3077 -0
- package/dist/factories/index.cjs.map +1 -0
- package/dist/factories/index.d.cts +69 -0
- package/dist/factories/index.d.ts +69 -0
- package/dist/factories/index.js +6 -0
- package/dist/factories/index.js.map +1 -0
- package/dist/index-B4-YyUNR.d.cts +73 -0
- package/dist/index-BZUOKeTO.d.ts +73 -0
- package/dist/index.cjs +8584 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +283 -0
- package/dist/index.d.ts +283 -0
- package/dist/index.js +1729 -0
- package/dist/index.js.map +1 -0
- package/dist/systems/index.cjs +5119 -0
- package/dist/systems/index.cjs.map +1 -0
- package/dist/systems/index.d.cts +200 -0
- package/dist/systems/index.d.ts +200 -0
- package/dist/systems/index.js +6 -0
- package/dist/systems/index.js.map +1 -0
- package/dist/types.cjs +4 -0
- package/dist/types.cjs.map +1 -0
- package/dist/types.d.cts +3 -0
- package/dist/types.d.ts +3 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/dist/worldSnapshotUtils.cjs +259 -0
- package/dist/worldSnapshotUtils.cjs.map +1 -0
- package/dist/worldSnapshotUtils.d.cts +3 -0
- package/dist/worldSnapshotUtils.d.ts +3 -0
- package/dist/worldSnapshotUtils.js +4 -0
- package/dist/worldSnapshotUtils.js.map +1 -0
- package/package.json +80 -0
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / normalizePhysicsState
|
|
6
|
+
|
|
7
|
+
# Function: normalizePhysicsState()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function normalizePhysicsState(value): PhysicsState;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Physics.ts:319](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L319)
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type |
|
|
18
|
+
| ------ | ------ |
|
|
19
|
+
| `value` | \| \{ `rigidbody?`: `Partial`\<[`RigidbodyState`](../type-aliases/RigidbodyState.md)\>; `collider?`: `Partial`\<[`ColliderState`](../type-aliases/ColliderState.md)\>; \} \| `undefined` |
|
|
20
|
+
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
[`PhysicsState`](../type-aliases/PhysicsState.md)
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../index.md) / components
|
|
6
|
+
|
|
7
|
+
# components
|
|
8
|
+
|
|
9
|
+
## Classes
|
|
10
|
+
|
|
11
|
+
### Components
|
|
12
|
+
|
|
13
|
+
| Class | Description |
|
|
14
|
+
| ------ | ------ |
|
|
15
|
+
| [AnimationComponent](classes/AnimationComponent.md) | Animation catalog and runtime state for an entity. Combines clips imported from a model with externally added clips, exposes a state machine for named transitions, and is queried each frame by the animation system to advance mixer time. |
|
|
16
|
+
| [AudioComponent](classes/AudioComponent.md) | Plays an audio clip from `path`. Supports both global stereo (`positional: false`) and 3D positional audio with the configured distance model. Runtime fields (`object`, `audio`, `isPlaying`, `isPaused`) are recreated when the project loads and are never persisted to saved snapshots. |
|
|
17
|
+
| [CameraComponent](classes/CameraComponent.md) | Camera entity state. Supports perspective and orthographic projections, a `3d` or `ar` runtime type, and an `isDefault` flag for the camera that the preview/editor renders through. Field-of-view, near/far, ortho frustum, and zoom are persisted; the live `THREE.Camera` is recreated when the project loads. |
|
|
18
|
+
| [EntityType](classes/EntityType.md) | Tags an entity with the kind it was created from (`cube`, `sphere`, `model`, `directionalLight`, etc.). Factories use this to drive kind-specific behavior; the editor inspector uses it to select component editors. |
|
|
19
|
+
| [Environment](classes/Environment.md) | Scene environment settings: skybox (gradient/color/image), fog (linear/exponential), and gravity vector for the physics world. Singleton-style — attached to one environment entity per scene. |
|
|
20
|
+
| [ImageComponent](classes/ImageComponent.md) | Renders a 2D image as a textured quad in the scene. Width/height are in world units. Texture loading is handled by the image system, which populates [ImageComponent.texture](classes/ImageComponent.md#texture) and [ImageComponent.object](classes/ImageComponent.md#object) asynchronously. |
|
|
21
|
+
| [ImageTarget](classes/ImageTarget.md) | Image-tracking target metadata used by AR projects. Holds the source images users uploaded plus the URL of the compiled `.mind` target file produced by the image-target compiler. Pair with [ImageTargetAnchor](classes/ImageTargetAnchor.md) on child entities that should appear when the target is detected. |
|
|
22
|
+
| [ImageTargetAnchor](classes/ImageTargetAnchor.md) | Marks an entity as an anchor for an image-tracking target. The image tracking system reveals the entity when the referenced target is found and hides it when the target is lost. |
|
|
23
|
+
| [LightComponent](classes/LightComponent.md) | Light source attached to an entity. `type` selects the underlying three.js light class (directional, point, spot, ambient, hemisphere, rect-area). `values` carries authoring state including color, intensity, and type-specific fields (distance, decay, angle, penumbra, width, height). |
|
|
24
|
+
| [MaterialComponent](classes/MaterialComponent.md) | Material catalog for an entity. Tracks the live three.js materials (`materials`, `material`) plus serialized authoring state (`values[]`) mirrored from the inspector. Supports `standard`, `basic`, `phong`, and `physical` PBR types with optional texture map slots. |
|
|
25
|
+
| [MeshComponent](classes/MeshComponent.md) | Holds the live three.js `Object3D` for an entity that renders as a primitive mesh (cube, sphere, plane, capsule, cylinder). For loaded GLTF/GLB models see [ModelComponent](classes/ModelComponent.md); for the editable geometry parameters see [MeshGeometryComponent](classes/MeshGeometryComponent.md). |
|
|
26
|
+
| [MeshGeometryComponent](classes/MeshGeometryComponent.md) | Editable geometry parameters for primitive meshes (cube, sphere, plane, capsule, cylinder) and the placeholder for `model` entities. Holds the authoring values plus shadow casting/receiving flags. The mesh-geometry system rebuilds the underlying `BufferGeometry` when parameters change. |
|
|
27
|
+
| [ModelComponent](classes/ModelComponent.md) | References a GLTF/GLB asset loaded from `path`. The model loading system resolves the asset asynchronously and populates [ModelComponent.object](classes/ModelComponent.md#object) once available; loading is deferred-tolerant so the entity exists before the model finishes loading. |
|
|
28
|
+
| [Name](classes/Name.md) | Human-readable name for an entity. Shown in the editor hierarchy panel and preserved across save/reload. |
|
|
29
|
+
| [Object3DRef](classes/Object3DRef.md) | Wraps the live `THREE.Object3D` for an entity. Almost every entity that renders to the scene carries an `Object3DRef` so transform sync, selection, and parenting systems can manipulate the underlying object. |
|
|
30
|
+
| [ParentId](classes/ParentId.md) | Records the parent entity id for hierarchical scene graphs. `null` means the entity is at the world root. The `ObjectManagementSystem` reconciles scene-graph parenting from this component each frame. |
|
|
31
|
+
| [PhysicsComponent](classes/PhysicsComponent.md) | Unified physics component combining a Rapier rigid body and a Rapier collider into a single authoring and runtime container. |
|
|
32
|
+
| [Postprocessing](classes/Postprocessing.md) | Postprocessing stack settings (depth-of-field, bloom, vignette, chromatic aberration, noise, pixelation, tone mapping, hue/saturation, sepia, SMAA, SSAO, dot-screen, glitch). The render system applies enabled effects in a `postprocessing`-library composer when `postEnabled` is `true`. Singleton- style — attached to one entity per scene. |
|
|
33
|
+
| [ScriptComponent](classes/ScriptComponent.md) | Component holding the list of [scripts](type-aliases/ScriptEntry.md) attached to an entity. Loaded from the saved project; the runtime-side fields (`scriptInstance`, `scriptInstances`) are non-enumerable so they never leak into save data or undo history. |
|
|
34
|
+
| [Selectable](classes/Selectable.md) | Toggles whether the editor selection system can pick this entity. When `enabled` is `false`, the entity is excluded from raycast hit tests. |
|
|
35
|
+
| [SelectionTransformState](classes/SelectionTransformState.md) | Singleton-style component (attached once to a system entity) that mirrors the editor's current transform-gizmo state into the ECS world. Persisted in snapshots so undo/redo restores the exact gizmo configuration. |
|
|
36
|
+
| [SpriteComponent](classes/SpriteComponent.md) | Camera-facing 2D sprite. Unlike [ImageComponent](classes/ImageComponent.md), sprites use `THREE.Sprite` and always render as billboards. |
|
|
37
|
+
| [TransformComponent](classes/TransformComponent.md) | Position, rotation, and scale of an entity in its parent's local space. |
|
|
38
|
+
| [VideoComponent](classes/VideoComponent.md) | Plays a video file as a texture on a quad. Supports green-screen keying (`isGreenScreen`, `backgroundColor`, `similarity`, `smoothness`, `spill`). The video element, texture, and material are runtime-only and re-created when the project loads. |
|
|
39
|
+
|
|
40
|
+
## Type Aliases
|
|
41
|
+
|
|
42
|
+
| Type Alias | Description |
|
|
43
|
+
| ------ | ------ |
|
|
44
|
+
| [AnimationComponentOptions](type-aliases/AnimationComponentOptions.md) | Initializer for [AnimationComponent](classes/AnimationComponent.md). |
|
|
45
|
+
| [CameraRuntimeType](type-aliases/CameraRuntimeType.md) | Runtime camera mode. `3d` is a free camera; `ar` is composited over a tracked image/face feed. |
|
|
46
|
+
| [CameraProjection](type-aliases/CameraProjection.md) | Projection model. |
|
|
47
|
+
| [CameraComponentOptions](type-aliases/CameraComponentOptions.md) | Optional initializer for [CameraComponent](classes/CameraComponent.md). Any field omitted falls back to the defaults documented on the component. |
|
|
48
|
+
| [EnvironmentSkyboxType](type-aliases/EnvironmentSkyboxType.md) | Skybox rendering modes. `none` disables skybox rendering entirely. |
|
|
49
|
+
| [EnvironmentGradientEffect](type-aliases/EnvironmentGradientEffect.md) | Gradient distribution applied when [EnvironmentSkyboxState.type](type-aliases/EnvironmentSkyboxState.md#type) is `"gradient"`. |
|
|
50
|
+
| [EnvironmentFogType](type-aliases/EnvironmentFogType.md) | Fog distance models. `none` disables fog. |
|
|
51
|
+
| [EnvironmentSkyboxState](type-aliases/EnvironmentSkyboxState.md) | Skybox configuration. Only the fields relevant to [type](type-aliases/EnvironmentSkyboxState.md#type) are read at render time. |
|
|
52
|
+
| [EnvironmentFogState](type-aliases/EnvironmentFogState.md) | Fog configuration. Mirrors three.js `Fog` / `FogExp2`. |
|
|
53
|
+
| [EnvironmentState](type-aliases/EnvironmentState.md) | Aggregated authoring state owned by [Environment](classes/Environment.md). |
|
|
54
|
+
| [ImageTargetReference](type-aliases/ImageTargetReference.md) | Single uploaded image used as input to the image-target compiler. |
|
|
55
|
+
| [ImageTargetAnchorOptions](type-aliases/ImageTargetAnchorOptions.md) | Optional initializer for [ImageTargetAnchor](classes/ImageTargetAnchor.md). |
|
|
56
|
+
| [LightValueState](type-aliases/LightValueState.md) | Authoring state for [LightComponent](classes/LightComponent.md). Common fields apply to every light kind; the optional fields are only meaningful for specific kinds. |
|
|
57
|
+
| [MaterialTypeValue](type-aliases/MaterialTypeValue.md) | Supported material classes. Each maps to a three.js `Mesh*Material` type. |
|
|
58
|
+
| [TextureFilteringValue](type-aliases/TextureFilteringValue.md) | Texture sampling mode. `smooth` uses linear filtering; `sharp` uses nearest filtering for pixel-art look. |
|
|
59
|
+
| [MaterialValueState](type-aliases/MaterialValueState.md) | Authoring state for a single slot in [MaterialComponent.values](classes/MaterialComponent.md#values). Mirrors the live three.js material so it can be re-applied when the project loads. |
|
|
60
|
+
| [EditableMeshObjectKind](type-aliases/EditableMeshObjectKind.md) | Editable primitive kinds the mesh-geometry system can rebuild on the fly. `model` is a passthrough placeholder for entities that own a loaded GLTF/GLB instead. |
|
|
61
|
+
| [CubeMeshParameters](type-aliases/CubeMeshParameters.md) | Box geometry parameters in world units. |
|
|
62
|
+
| [PlaneMeshParameters](type-aliases/PlaneMeshParameters.md) | Plane geometry parameters in world units. |
|
|
63
|
+
| [RadiusMeshParameters](type-aliases/RadiusMeshParameters.md) | Radius-only primitive parameters (sphere). |
|
|
64
|
+
| [RadiusHeightMeshParameters](type-aliases/RadiusHeightMeshParameters.md) | Radius + height primitive parameters (capsule, cylinder). |
|
|
65
|
+
| [MeshGeometryParametersByKind](type-aliases/MeshGeometryParametersByKind.md) | Map from [EditableMeshObjectKind](type-aliases/EditableMeshObjectKind.md) to its parameter shape. |
|
|
66
|
+
| [MeshGeometryParameters](type-aliases/MeshGeometryParameters.md) | - |
|
|
67
|
+
| [RigidbodyType](type-aliases/RigidbodyType.md) | Rigidbody body type: - `dynamic`: simulated by physics; affected by forces and gravity. - `fixed`: immovable static body. - `kinematicPosition`: moved by setting next position; ignores forces. - `kinematicVelocity`: moved by setting velocity; ignores forces. |
|
|
68
|
+
| [RigidbodyState](type-aliases/RigidbodyState.md) | Authoring state for the rigidbody half of [PhysicsComponent](classes/PhysicsComponent.md). Saved with the project. |
|
|
69
|
+
| [ColliderShape](type-aliases/ColliderShape.md) | Collider primitive shape. `trimesh` derives geometry from the entity's mesh. |
|
|
70
|
+
| [ColliderState](type-aliases/ColliderState.md) | Authoring state for the collider half of [PhysicsComponent](classes/PhysicsComponent.md). Only the size fields relevant to [ColliderState.shape](type-aliases/ColliderState.md#shape) are read at simulation time. |
|
|
71
|
+
| [PhysicsState](type-aliases/PhysicsState.md) | Combined authoring state for [PhysicsComponent](classes/PhysicsComponent.md). Saved with the project. |
|
|
72
|
+
| [PostprocessingState](type-aliases/PostprocessingState.md) | Aggregated post-processing effect chain authored on the scene environment. Each sub-effect has its own `enabled` flag plus per-effect parameters. |
|
|
73
|
+
| [ScriptEntry](type-aliases/ScriptEntry.md) | One script attached to an entity. Multiple entries may target a single entity (different classes from the same or different files). |
|
|
74
|
+
| [TransformModeValue](type-aliases/TransformModeValue.md) | Active gizmo mode in the editor. |
|
|
75
|
+
| [TransformSpaceValue](type-aliases/TransformSpaceValue.md) | Reference frame for the active gizmo. |
|
|
76
|
+
| [Vec3](type-aliases/Vec3.md) | Plain XYZ vector. All ECS transform fields use this shape rather than `THREE.Vector3` so they save cleanly with the project. |
|
|
77
|
+
| [TransformData](type-aliases/TransformData.md) | Optional initial values passed to [TransformComponent](classes/TransformComponent.md). Missing axes default to `0` for position/rotation and `1` for scale. |
|
|
78
|
+
|
|
79
|
+
## Variables
|
|
80
|
+
|
|
81
|
+
| Variable | Description |
|
|
82
|
+
| ------ | ------ |
|
|
83
|
+
| [DEFAULT\_ENVIRONMENT\_STATE](variables/DEFAULT_ENVIRONMENT_STATE.md) | - |
|
|
84
|
+
| [DEFAULT\_MESH\_GEOMETRY\_PARAMETERS](variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md) | - |
|
|
85
|
+
| [DEFAULT\_RIGIDBODY\_STATE](variables/DEFAULT_RIGIDBODY_STATE.md) | - |
|
|
86
|
+
| [DEFAULT\_COLLIDER\_STATE](variables/DEFAULT_COLLIDER_STATE.md) | - |
|
|
87
|
+
| [DEFAULT\_PHYSICS\_STATE](variables/DEFAULT_PHYSICS_STATE.md) | - |
|
|
88
|
+
| [DEFAULT\_POSTPROCESSING\_STATE](variables/DEFAULT_POSTPROCESSING_STATE.md) | - |
|
|
89
|
+
|
|
90
|
+
## Functions
|
|
91
|
+
|
|
92
|
+
| Function | Description |
|
|
93
|
+
| ------ | ------ |
|
|
94
|
+
| [normalizePhysicsState](functions/normalizePhysicsState.md) | - |
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / AnimationComponentOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: AnimationComponentOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type AnimationComponentOptions = {
|
|
11
|
+
clips?: THREE.AnimationClip[];
|
|
12
|
+
externalClipSources?: string[];
|
|
13
|
+
activeState?: string | null;
|
|
14
|
+
paused?: boolean;
|
|
15
|
+
reverse?: boolean;
|
|
16
|
+
timeScale?: number;
|
|
17
|
+
crossFadeDuration?: number;
|
|
18
|
+
states?: {
|
|
19
|
+
name: string;
|
|
20
|
+
clip: string;
|
|
21
|
+
clipId?: string;
|
|
22
|
+
loop?: boolean;
|
|
23
|
+
}[];
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [components/Animation.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L10)
|
|
28
|
+
|
|
29
|
+
Initializer for [AnimationComponent](../classes/AnimationComponent.md).
|
|
30
|
+
|
|
31
|
+
## Properties
|
|
32
|
+
|
|
33
|
+
| Property | Type | Description | Defined in |
|
|
34
|
+
| ------ | ------ | ------ | ------ |
|
|
35
|
+
| <a id="clips"></a> `clips?` | `THREE.AnimationClip`[] | Initial set of clips imported from the entity's model. | [components/Animation.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L12) |
|
|
36
|
+
| <a id="externalclipsources"></a> `externalClipSources?` | `string`[] | URLs (or `localasset://` paths) of clips to load asynchronously and merge into the catalog. | [components/Animation.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L14) |
|
|
37
|
+
| <a id="activestate"></a> `activeState?` | `string` \| `null` | Name of the state to activate after construction. | [components/Animation.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L16) |
|
|
38
|
+
| <a id="paused"></a> `paused?` | `boolean` | Whether playback starts paused. | [components/Animation.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L18) |
|
|
39
|
+
| <a id="reverse"></a> `reverse?` | `boolean` | Play the active clip in reverse. | [components/Animation.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L20) |
|
|
40
|
+
| <a id="timescale"></a> `timeScale?` | `number` | Time-scale multiplier (`1` = real-time). | [components/Animation.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L22) |
|
|
41
|
+
| <a id="crossfadeduration"></a> `crossFadeDuration?` | `number` | Default cross-fade duration in seconds when switching states. | [components/Animation.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L24) |
|
|
42
|
+
| <a id="states"></a> `states?` | \{ `name`: `string`; `clip`: `string`; `clipId?`: `string`; `loop?`: `boolean`; \}[] | Predefined state machine entries (`name` -> clip binding). | [components/Animation.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Animation.ts#L26) |
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / CameraComponentOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: CameraComponentOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type CameraComponentOptions = {
|
|
11
|
+
camera?: THREE.Camera;
|
|
12
|
+
type?: CameraRuntimeType;
|
|
13
|
+
isDefault?: boolean;
|
|
14
|
+
projection?: CameraProjection;
|
|
15
|
+
fov?: number;
|
|
16
|
+
near?: number;
|
|
17
|
+
far?: number;
|
|
18
|
+
left?: number;
|
|
19
|
+
right?: number;
|
|
20
|
+
top?: number;
|
|
21
|
+
bottom?: number;
|
|
22
|
+
zoom?: number;
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defined in: [components/Camera.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L11)
|
|
27
|
+
|
|
28
|
+
Optional initializer for [CameraComponent](../classes/CameraComponent.md). Any field omitted falls back to the defaults documented on the component.
|
|
29
|
+
|
|
30
|
+
## Properties
|
|
31
|
+
|
|
32
|
+
| Property | Type | Description | Defined in |
|
|
33
|
+
| ------ | ------ | ------ | ------ |
|
|
34
|
+
| <a id="camera"></a> `camera?` | `THREE.Camera` | Pre-built three.js camera. When omitted the component creates one from [projection](#projection). | [components/Camera.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L13) |
|
|
35
|
+
| <a id="type"></a> `type?` | [`CameraRuntimeType`](CameraRuntimeType.md) | Runtime camera mode. | [components/Camera.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L15) |
|
|
36
|
+
| <a id="isdefault"></a> `isDefault?` | `boolean` | Mark this camera as the default camera the renderer uses. | [components/Camera.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L17) |
|
|
37
|
+
| <a id="projection"></a> `projection?` | [`CameraProjection`](CameraProjection.md) | Projection model. | [components/Camera.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L19) |
|
|
38
|
+
| <a id="fov"></a> `fov?` | `number` | Vertical field of view in **degrees** (perspective only). | [components/Camera.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L21) |
|
|
39
|
+
| <a id="near"></a> `near?` | `number` | Near clip plane in world units. | [components/Camera.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L23) |
|
|
40
|
+
| <a id="far"></a> `far?` | `number` | Far clip plane in world units. | [components/Camera.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L25) |
|
|
41
|
+
| <a id="left"></a> `left?` | `number` | Left edge of the orthographic frustum in world units. | [components/Camera.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L27) |
|
|
42
|
+
| <a id="right"></a> `right?` | `number` | Right edge of the orthographic frustum in world units. | [components/Camera.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L29) |
|
|
43
|
+
| <a id="top"></a> `top?` | `number` | Top edge of the orthographic frustum in world units. | [components/Camera.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L31) |
|
|
44
|
+
| <a id="bottom"></a> `bottom?` | `number` | Bottom edge of the orthographic frustum in world units. | [components/Camera.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L33) |
|
|
45
|
+
| <a id="zoom"></a> `zoom?` | `number` | Zoom multiplier (`1` = no zoom). | [components/Camera.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L35) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / CameraProjection
|
|
6
|
+
|
|
7
|
+
# Type Alias: CameraProjection
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type CameraProjection = "perspective" | "orthographic";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Camera.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L8)
|
|
14
|
+
|
|
15
|
+
Projection model.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / CameraRuntimeType
|
|
6
|
+
|
|
7
|
+
# Type Alias: CameraRuntimeType
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type CameraRuntimeType = "3d" | "ar";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Camera.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Camera.ts#L6)
|
|
14
|
+
|
|
15
|
+
Runtime camera mode. `3d` is a free camera; `ar` is composited over a tracked image/face feed.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ColliderShape
|
|
6
|
+
|
|
7
|
+
# Type Alias: ColliderShape
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ColliderShape = "cuboid" | "ball" | "capsule" | "cylinder" | "trimesh";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Physics.ts:83](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L83)
|
|
14
|
+
|
|
15
|
+
Collider primitive shape. `trimesh` derives geometry from the entity's mesh.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ColliderState
|
|
6
|
+
|
|
7
|
+
# Type Alias: ColliderState
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ColliderState = {
|
|
11
|
+
enabled: boolean;
|
|
12
|
+
shape: ColliderShape;
|
|
13
|
+
offsetPosition: {
|
|
14
|
+
x: number;
|
|
15
|
+
y: number;
|
|
16
|
+
z: number;
|
|
17
|
+
};
|
|
18
|
+
offsetRotation: {
|
|
19
|
+
x: number;
|
|
20
|
+
y: number;
|
|
21
|
+
z: number;
|
|
22
|
+
};
|
|
23
|
+
size: {
|
|
24
|
+
x: number;
|
|
25
|
+
y: number;
|
|
26
|
+
z: number;
|
|
27
|
+
};
|
|
28
|
+
radius: number;
|
|
29
|
+
height: number;
|
|
30
|
+
restitution: number;
|
|
31
|
+
friction: number;
|
|
32
|
+
isSensor: boolean;
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Defined in: [components/Physics.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L91)
|
|
37
|
+
|
|
38
|
+
Authoring state for the collider half of [PhysicsComponent](../classes/PhysicsComponent.md). Only the size fields relevant to [ColliderState.shape](#shape) are read at simulation time.
|
|
39
|
+
|
|
40
|
+
## Properties
|
|
41
|
+
|
|
42
|
+
| Property | Type | Description | Defined in |
|
|
43
|
+
| ------ | ------ | ------ | ------ |
|
|
44
|
+
| <a id="enabled"></a> `enabled` | `boolean` | When `false`, the collider is removed from physics simulation but kept in state. | [components/Physics.ts:93](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L93) |
|
|
45
|
+
| <a id="shape"></a> `shape` | [`ColliderShape`](ColliderShape.md) | Collider primitive shape. | [components/Physics.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L95) |
|
|
46
|
+
| <a id="offsetposition"></a> `offsetPosition` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Local offset of the collider relative to the entity's transform, in world units. | [components/Physics.ts:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L97) |
|
|
47
|
+
| `offsetPosition.x` | `number` | Offset along local X. | [components/Physics.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L99) |
|
|
48
|
+
| `offsetPosition.y` | `number` | Offset along local Y. | [components/Physics.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L101) |
|
|
49
|
+
| `offsetPosition.z` | `number` | Offset along local Z. | [components/Physics.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L103) |
|
|
50
|
+
| <a id="offsetrotation"></a> `offsetRotation` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Local rotation offset in **radians** (Euler XYZ). | [components/Physics.ts:106](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L106) |
|
|
51
|
+
| `offsetRotation.x` | `number` | Rotation around local X (radians). | [components/Physics.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L108) |
|
|
52
|
+
| `offsetRotation.y` | `number` | Rotation around local Y (radians). | [components/Physics.ts:110](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L110) |
|
|
53
|
+
| `offsetRotation.z` | `number` | Rotation around local Z (radians). | [components/Physics.ts:112](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L112) |
|
|
54
|
+
| <a id="size"></a> `size` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Half-extents for `cuboid` shape, in world units. | [components/Physics.ts:115](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L115) |
|
|
55
|
+
| `size.x` | `number` | Half-extent along X. | [components/Physics.ts:117](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L117) |
|
|
56
|
+
| `size.y` | `number` | Half-extent along Y. | [components/Physics.ts:119](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L119) |
|
|
57
|
+
| `size.z` | `number` | Half-extent along Z. | [components/Physics.ts:121](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L121) |
|
|
58
|
+
| <a id="radius"></a> `radius` | `number` | Radius for `ball`, `capsule`, and `cylinder` shapes. | [components/Physics.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L124) |
|
|
59
|
+
| <a id="height"></a> `height` | `number` | Height for `capsule` (segment length between caps) and `cylinder`. | [components/Physics.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L126) |
|
|
60
|
+
| <a id="restitution"></a> `restitution` | `number` | Bounciness in `[0, 1]`. `0` is no bounce; `1` is perfectly elastic. | [components/Physics.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L128) |
|
|
61
|
+
| <a id="friction"></a> `friction` | `number` | Surface friction coefficient. `0` is frictionless. | [components/Physics.ts:130](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L130) |
|
|
62
|
+
| <a id="issensor"></a> `isSensor` | `boolean` | When `true`, the collider reports overlaps but does not generate contact responses. | [components/Physics.ts:132](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L132) |
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / CubeMeshParameters
|
|
6
|
+
|
|
7
|
+
# Type Alias: CubeMeshParameters
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type CubeMeshParameters = {
|
|
11
|
+
width: number;
|
|
12
|
+
height: number;
|
|
13
|
+
depth: number;
|
|
14
|
+
};
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [components/MeshGeometry.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L15)
|
|
18
|
+
|
|
19
|
+
Box geometry parameters in world units.
|
|
20
|
+
|
|
21
|
+
## Properties
|
|
22
|
+
|
|
23
|
+
| Property | Type | Description | Defined in |
|
|
24
|
+
| ------ | ------ | ------ | ------ |
|
|
25
|
+
| <a id="width"></a> `width` | `number` | Box width along X. | [components/MeshGeometry.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L17) |
|
|
26
|
+
| <a id="height"></a> `height` | `number` | Box height along Y. | [components/MeshGeometry.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L19) |
|
|
27
|
+
| <a id="depth"></a> `depth` | `number` | Box depth along Z. | [components/MeshGeometry.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L21) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EditableMeshObjectKind
|
|
6
|
+
|
|
7
|
+
# Type Alias: EditableMeshObjectKind
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EditableMeshObjectKind = "capsule" | "cube" | "cylinder" | "model" | "plane" | "sphere";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/MeshGeometry.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L6)
|
|
14
|
+
|
|
15
|
+
Editable primitive kinds the mesh-geometry system can rebuild on the fly. `model` is a passthrough placeholder for entities that own a loaded GLTF/GLB instead.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentFogState
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentFogState
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentFogState = {
|
|
11
|
+
type: EnvironmentFogType;
|
|
12
|
+
color: string;
|
|
13
|
+
linear: {
|
|
14
|
+
near: number;
|
|
15
|
+
far: number;
|
|
16
|
+
};
|
|
17
|
+
exponential: {
|
|
18
|
+
density: number;
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Defined in: [components/Environment.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L28)
|
|
24
|
+
|
|
25
|
+
Fog configuration. Mirrors three.js `Fog` / `FogExp2`.
|
|
26
|
+
|
|
27
|
+
## Properties
|
|
28
|
+
|
|
29
|
+
| Property | Type | Description | Defined in |
|
|
30
|
+
| ------ | ------ | ------ | ------ |
|
|
31
|
+
| <a id="type"></a> `type` | [`EnvironmentFogType`](EnvironmentFogType.md) | Active fog model. | [components/Environment.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L30) |
|
|
32
|
+
| <a id="color"></a> `color` | `string` | Fog color as `#rrggbb`. | [components/Environment.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L32) |
|
|
33
|
+
| <a id="linear"></a> `linear` | \{ `near`: `number`; `far`: `number`; \} | Linear-fog parameters used when [type](#type) is `"linear"`. | [components/Environment.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L34) |
|
|
34
|
+
| `linear.near` | `number` | Distance at which fog begins to take effect. | [components/Environment.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L36) |
|
|
35
|
+
| `linear.far` | `number` | Distance at which fog reaches full opacity. | [components/Environment.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L38) |
|
|
36
|
+
| <a id="exponential"></a> `exponential` | \{ `density`: `number`; \} | Exponential-fog parameters used when [type](#type) is `"exponential"`. | [components/Environment.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L41) |
|
|
37
|
+
| `exponential.density` | `number` | Density coefficient. Higher values produce thicker fog. | [components/Environment.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L43) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentFogType
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentFogType
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentFogType = "linear" | "exponential" | "none";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Environment.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L8)
|
|
14
|
+
|
|
15
|
+
Fog distance models. `none` disables fog.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentGradientEffect
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentGradientEffect
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentGradientEffect = "radial" | "linear" | "angular";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Environment.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L6)
|
|
14
|
+
|
|
15
|
+
Gradient distribution applied when [EnvironmentSkyboxState.type](EnvironmentSkyboxState.md#type) is `"gradient"`.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentSkyboxState
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentSkyboxState
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentSkyboxState = {
|
|
11
|
+
type: EnvironmentSkyboxType;
|
|
12
|
+
color: string;
|
|
13
|
+
imageUrl?: string;
|
|
14
|
+
gradient: {
|
|
15
|
+
colors: string[];
|
|
16
|
+
effect: EnvironmentGradientEffect;
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [components/Environment.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L11)
|
|
22
|
+
|
|
23
|
+
Skybox configuration. Only the fields relevant to [type](#type) are read at render time.
|
|
24
|
+
|
|
25
|
+
## Properties
|
|
26
|
+
|
|
27
|
+
| Property | Type | Description | Defined in |
|
|
28
|
+
| ------ | ------ | ------ | ------ |
|
|
29
|
+
| <a id="type"></a> `type` | [`EnvironmentSkyboxType`](EnvironmentSkyboxType.md) | Active skybox mode. | [components/Environment.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L13) |
|
|
30
|
+
| <a id="color"></a> `color` | `string` | Solid color used when [type](#type) is `"color"`. `#rrggbb`. | [components/Environment.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L15) |
|
|
31
|
+
| <a id="imageurl"></a> `imageUrl?` | `string` | URL or `localasset://` path of the equirectangular image used when [type](#type) is `"image"`. | [components/Environment.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L17) |
|
|
32
|
+
| <a id="gradient"></a> `gradient` | \{ `colors`: `string`[]; `effect`: [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md); \} | Gradient parameters used when [type](#type) is `"gradient"`. | [components/Environment.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L19) |
|
|
33
|
+
| `gradient.colors` | `string`[] | Ordered list of color stops as `#rrggbb` strings. | [components/Environment.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L21) |
|
|
34
|
+
| `gradient.effect` | [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md) | Gradient distribution. | [components/Environment.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L23) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentSkyboxType
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentSkyboxType
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentSkyboxType = "gradient" | "color" | "image" | "none";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Environment.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L4)
|
|
14
|
+
|
|
15
|
+
Skybox rendering modes. `none` disables skybox rendering entirely.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentState
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentState
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentState = {
|
|
11
|
+
skybox: EnvironmentSkyboxState;
|
|
12
|
+
fog: EnvironmentFogState;
|
|
13
|
+
gravity: EnvironmentGravityState;
|
|
14
|
+
fixedTimeStep: number;
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [components/Environment.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L58)
|
|
19
|
+
|
|
20
|
+
Aggregated authoring state owned by [Environment](../classes/Environment.md).
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
| Property | Type | Description | Defined in |
|
|
25
|
+
| ------ | ------ | ------ | ------ |
|
|
26
|
+
| <a id="skybox"></a> `skybox` | [`EnvironmentSkyboxState`](EnvironmentSkyboxState.md) | Skybox configuration. | [components/Environment.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L60) |
|
|
27
|
+
| <a id="fog"></a> `fog` | [`EnvironmentFogState`](EnvironmentFogState.md) | Fog configuration. | [components/Environment.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L62) |
|
|
28
|
+
| <a id="gravity"></a> `gravity` | `EnvironmentGravityState` | World gravity. | [components/Environment.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L64) |
|
|
29
|
+
| <a id="fixedtimestep"></a> `fixedTimeStep` | `number` | Fixed timestep (seconds) used by the physics accumulator loop. Physics is stepped in fixed increments of this size each frame. Default is `0.02` (50 Hz). | [components/Environment.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L70) |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ImageTargetAnchorOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: ImageTargetAnchorOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ImageTargetAnchorOptions = {
|
|
11
|
+
targetId?: number | null;
|
|
12
|
+
targetUrl?: string;
|
|
13
|
+
};
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Defined in: [components/ImageTargetAnchor.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L4)
|
|
17
|
+
|
|
18
|
+
Optional initializer for [ImageTargetAnchor](../classes/ImageTargetAnchor.md).
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
| Property | Type | Description | Defined in |
|
|
23
|
+
| ------ | ------ | ------ | ------ |
|
|
24
|
+
| <a id="targetid"></a> `targetId?` | `number` \| `null` | Id of the tracked target this anchor follows (matches `ImageTargetReference.id`). | [components/ImageTargetAnchor.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L6) |
|
|
25
|
+
| <a id="targeturl"></a> `targetUrl?` | `string` | Optional canonical URL of the target image, used as a fallback identifier. | [components/ImageTargetAnchor.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L8) |
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ImageTargetReference
|
|
6
|
+
|
|
7
|
+
# Type Alias: ImageTargetReference
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ImageTargetReference = {
|
|
11
|
+
id: number;
|
|
12
|
+
url: string;
|
|
13
|
+
width: number;
|
|
14
|
+
height: number;
|
|
15
|
+
storageDir?: string;
|
|
16
|
+
fileName?: string;
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [components/ImageTarget.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L6)
|
|
21
|
+
|
|
22
|
+
Single uploaded image used as input to the image-target compiler.
|
|
23
|
+
|
|
24
|
+
## Properties
|
|
25
|
+
|
|
26
|
+
| Property | Type | Description | Defined in |
|
|
27
|
+
| ------ | ------ | ------ | ------ |
|
|
28
|
+
| <a id="id"></a> `id` | `number` | Stable target id assigned at compile time. Referenced by [ImageTargetAnchor.targetId](../classes/ImageTargetAnchor.md#targetid). | [components/ImageTarget.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L8) |
|
|
29
|
+
| <a id="url"></a> `url` | `string` | Source image URL or `localasset://` path. | [components/ImageTarget.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L10) |
|
|
30
|
+
| <a id="width"></a> `width` | `number` | Image width in pixels. | [components/ImageTarget.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L12) |
|
|
31
|
+
| <a id="height"></a> `height` | `number` | Image height in pixels. | [components/ImageTarget.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L14) |
|
|
32
|
+
| <a id="storagedir"></a> `storageDir?` | `string` | Local directory the source image is stored in (desktop projects). | [components/ImageTarget.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L16) |
|
|
33
|
+
| <a id="filename"></a> `fileName?` | `string` | Local file name for the source image (desktop projects). | [components/ImageTarget.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L18) |
|