@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,60 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ImageTarget
|
|
6
|
+
|
|
7
|
+
# Class: ImageTarget
|
|
8
|
+
|
|
9
|
+
Defined in: [components/ImageTarget.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L29)
|
|
10
|
+
|
|
11
|
+
Image-tracking target metadata used by AR projects. Holds the source images
|
|
12
|
+
users uploaded plus the URL of the compiled `.mind` target file produced by
|
|
13
|
+
the image-target compiler. Pair with [ImageTargetAnchor](ImageTargetAnchor.md) on child
|
|
14
|
+
entities that should appear when the target is detected.
|
|
15
|
+
|
|
16
|
+
## Extends
|
|
17
|
+
|
|
18
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
19
|
+
|
|
20
|
+
## Constructors
|
|
21
|
+
|
|
22
|
+
### Constructor
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
new ImageTarget(
|
|
26
|
+
options?,
|
|
27
|
+
texture?,
|
|
28
|
+
object?): ImageTarget;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Defined in: [components/ImageTarget.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L41)
|
|
32
|
+
|
|
33
|
+
#### Parameters
|
|
34
|
+
|
|
35
|
+
| Parameter | Type |
|
|
36
|
+
| ------ | ------ |
|
|
37
|
+
| `options?` | \{ `targets?`: [`ImageTargetReference`](../type-aliases/ImageTargetReference.md)[]; `compiledTargetUrl?`: `string`; `compiledTargetDir?`: `string`; \} |
|
|
38
|
+
| `options.targets?` | [`ImageTargetReference`](../type-aliases/ImageTargetReference.md)[] |
|
|
39
|
+
| `options.compiledTargetUrl?` | `string` |
|
|
40
|
+
| `options.compiledTargetDir?` | `string` |
|
|
41
|
+
| `texture?` | `Texture` |
|
|
42
|
+
| `object?` | `Object3D`\<`Object3DEventMap`\> |
|
|
43
|
+
|
|
44
|
+
#### Returns
|
|
45
|
+
|
|
46
|
+
`ImageTarget`
|
|
47
|
+
|
|
48
|
+
#### Overrides
|
|
49
|
+
|
|
50
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
51
|
+
|
|
52
|
+
## Properties
|
|
53
|
+
|
|
54
|
+
| Property | Type | Description | Defined in |
|
|
55
|
+
| ------ | ------ | ------ | ------ |
|
|
56
|
+
| <a id="targets"></a> `targets` | [`ImageTargetReference`](../type-aliases/ImageTargetReference.md)[] | Source images that were combined into the compiled `.mind` target. | [components/ImageTarget.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L31) |
|
|
57
|
+
| <a id="compiledtargeturl"></a> `compiledTargetUrl?` | `string` | URL of the compiled `.mind` target file. Set after the image-target compiler finishes. | [components/ImageTarget.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L33) |
|
|
58
|
+
| <a id="compiledtargetdir"></a> `compiledTargetDir?` | `string` | Directory containing the compiled `.mind` file (desktop projects). | [components/ImageTarget.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L35) |
|
|
59
|
+
| <a id="texture"></a> `texture` | `Texture` \| `null` | Optional preview texture used in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L37) |
|
|
60
|
+
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Optional preview object placed in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTarget.ts#L39) |
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ImageTargetAnchor
|
|
6
|
+
|
|
7
|
+
# Class: ImageTargetAnchor
|
|
8
|
+
|
|
9
|
+
Defined in: [components/ImageTargetAnchor.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L18)
|
|
10
|
+
|
|
11
|
+
Marks an entity as an anchor for an image-tracking target. The image
|
|
12
|
+
tracking system reveals the entity when the referenced target is found and
|
|
13
|
+
hides it when the target is lost.
|
|
14
|
+
|
|
15
|
+
## Extends
|
|
16
|
+
|
|
17
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
18
|
+
|
|
19
|
+
## Constructors
|
|
20
|
+
|
|
21
|
+
### Constructor
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
new ImageTargetAnchor(options?): ImageTargetAnchor;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [components/ImageTargetAnchor.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L24)
|
|
28
|
+
|
|
29
|
+
#### Parameters
|
|
30
|
+
|
|
31
|
+
| Parameter | Type |
|
|
32
|
+
| ------ | ------ |
|
|
33
|
+
| `options?` | [`ImageTargetAnchorOptions`](../type-aliases/ImageTargetAnchorOptions.md) |
|
|
34
|
+
|
|
35
|
+
#### Returns
|
|
36
|
+
|
|
37
|
+
`ImageTargetAnchor`
|
|
38
|
+
|
|
39
|
+
#### Overrides
|
|
40
|
+
|
|
41
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
42
|
+
|
|
43
|
+
## Properties
|
|
44
|
+
|
|
45
|
+
| Property | Type | Description | Defined in |
|
|
46
|
+
| ------ | ------ | ------ | ------ |
|
|
47
|
+
| <a id="targetid"></a> `targetId` | `number` \| `null` | Tracked target id this anchor follows. `null` when unbound. | [components/ImageTargetAnchor.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L20) |
|
|
48
|
+
| <a id="targeturl"></a> `targetUrl?` | `string` | Canonical target image URL, retained as a fallback identifier. | [components/ImageTargetAnchor.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ImageTargetAnchor.ts#L22) |
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / LightComponent
|
|
6
|
+
|
|
7
|
+
# Class: LightComponent
|
|
8
|
+
|
|
9
|
+
Defined in: [components/Light.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L65)
|
|
10
|
+
|
|
11
|
+
Light source attached to an entity. `type` selects the underlying three.js
|
|
12
|
+
light class (directional, point, spot, ambient, hemisphere, rect-area).
|
|
13
|
+
`values` carries authoring state including color, intensity, and
|
|
14
|
+
type-specific fields (distance, decay, angle, penumbra, width, height).
|
|
15
|
+
|
|
16
|
+
## Extends
|
|
17
|
+
|
|
18
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
19
|
+
|
|
20
|
+
## Constructors
|
|
21
|
+
|
|
22
|
+
### Constructor
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
new LightComponent(light): LightComponent;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Defined in: [components/Light.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L73)
|
|
29
|
+
|
|
30
|
+
#### Parameters
|
|
31
|
+
|
|
32
|
+
| Parameter | Type |
|
|
33
|
+
| ------ | ------ |
|
|
34
|
+
| `light` | `Light` |
|
|
35
|
+
|
|
36
|
+
#### Returns
|
|
37
|
+
|
|
38
|
+
`LightComponent`
|
|
39
|
+
|
|
40
|
+
#### Overrides
|
|
41
|
+
|
|
42
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
43
|
+
|
|
44
|
+
## Properties
|
|
45
|
+
|
|
46
|
+
| Property | Type | Description | Defined in |
|
|
47
|
+
| ------ | ------ | ------ | ------ |
|
|
48
|
+
| <a id="light"></a> `light` | `Light` | Live three.js light placed in the scene. Recreated when the project loads. | [components/Light.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L67) |
|
|
49
|
+
| <a id="type"></a> `type` | `string` | Three.js class name of the light (e.g. `"DirectionalLight"`, `"PointLight"`, `"SpotLight"`). | [components/Light.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L69) |
|
|
50
|
+
| <a id="values"></a> `values` | [`LightValueState`](../type-aliases/LightValueState.md) | Serialized authoring state. Saved with the project. | [components/Light.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L71) |
|
|
51
|
+
|
|
52
|
+
## Methods
|
|
53
|
+
|
|
54
|
+
### setValues()
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
setValues(patch): void;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Defined in: [components/Light.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Light.ts#L80)
|
|
61
|
+
|
|
62
|
+
#### Parameters
|
|
63
|
+
|
|
64
|
+
| Parameter | Type |
|
|
65
|
+
| ------ | ------ |
|
|
66
|
+
| `patch` | `Partial`\<[`LightValueState`](../type-aliases/LightValueState.md)\> |
|
|
67
|
+
|
|
68
|
+
#### Returns
|
|
69
|
+
|
|
70
|
+
`void`
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / MaterialComponent
|
|
6
|
+
|
|
7
|
+
# Class: MaterialComponent
|
|
8
|
+
|
|
9
|
+
Defined in: [components/Material.ts:190](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L190)
|
|
10
|
+
|
|
11
|
+
Material catalog for an entity. Tracks the live three.js materials
|
|
12
|
+
(`materials`, `material`) plus serialized authoring state (`values[]`)
|
|
13
|
+
mirrored from the inspector. Supports `standard`, `basic`, `phong`, and
|
|
14
|
+
`physical` PBR types with optional texture map slots.
|
|
15
|
+
|
|
16
|
+
## Remarks
|
|
17
|
+
|
|
18
|
+
Use `setMaterials`, `updateValue`, `setMaterialType`, `setTextureFiltering`,
|
|
19
|
+
and `setUseMipmaps` to mutate state — these keep `values[]` and the live
|
|
20
|
+
three.js materials in sync. Texture URLs use the `localasset://` protocol
|
|
21
|
+
inside the editor.
|
|
22
|
+
|
|
23
|
+
## Extends
|
|
24
|
+
|
|
25
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
26
|
+
|
|
27
|
+
## Constructors
|
|
28
|
+
|
|
29
|
+
### Constructor
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
new MaterialComponent(materialOrMaterials?): MaterialComponent;
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Defined in: [components/Material.ts:198](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L198)
|
|
36
|
+
|
|
37
|
+
#### Parameters
|
|
38
|
+
|
|
39
|
+
| Parameter | Type | Default value |
|
|
40
|
+
| ------ | ------ | ------ |
|
|
41
|
+
| `materialOrMaterials` | `Material` \| `Material`[] | `[]` |
|
|
42
|
+
|
|
43
|
+
#### Returns
|
|
44
|
+
|
|
45
|
+
`MaterialComponent`
|
|
46
|
+
|
|
47
|
+
#### Overrides
|
|
48
|
+
|
|
49
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
50
|
+
|
|
51
|
+
## Properties
|
|
52
|
+
|
|
53
|
+
| Property | Type | Description | Defined in |
|
|
54
|
+
| ------ | ------ | ------ | ------ |
|
|
55
|
+
| <a id="materials"></a> `materials` | `Material`[] | Live three.js materials currently bound to the entity's mesh (one per submesh). | [components/Material.ts:192](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L192) |
|
|
56
|
+
| <a id="material"></a> `material` | `Material` \| `null` | Convenience reference to `materials[0]`. `null` when no material is assigned. | [components/Material.ts:194](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L194) |
|
|
57
|
+
| <a id="values"></a> `values` | [`MaterialValueState`](../type-aliases/MaterialValueState.md)[] | Serialized authoring state (one entry per material in [materials](#materials)). Saved with the project. | [components/Material.ts:196](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L196) |
|
|
58
|
+
|
|
59
|
+
## Methods
|
|
60
|
+
|
|
61
|
+
### setMaterials()
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
setMaterials(materialOrMaterials?): void;
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Defined in: [components/Material.ts:207](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L207)
|
|
68
|
+
|
|
69
|
+
#### Parameters
|
|
70
|
+
|
|
71
|
+
| Parameter | Type | Default value |
|
|
72
|
+
| ------ | ------ | ------ |
|
|
73
|
+
| `materialOrMaterials` | `Material` \| `Material`[] | `[]` |
|
|
74
|
+
|
|
75
|
+
#### Returns
|
|
76
|
+
|
|
77
|
+
`void`
|
|
78
|
+
|
|
79
|
+
***
|
|
80
|
+
|
|
81
|
+
### updateValue()
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
updateValue(index, patch): void;
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Defined in: [components/Material.ts:223](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L223)
|
|
88
|
+
|
|
89
|
+
#### Parameters
|
|
90
|
+
|
|
91
|
+
| Parameter | Type |
|
|
92
|
+
| ------ | ------ |
|
|
93
|
+
| `index` | `number` |
|
|
94
|
+
| `patch` | `Partial`\<[`MaterialValueState`](../type-aliases/MaterialValueState.md)\> |
|
|
95
|
+
|
|
96
|
+
#### Returns
|
|
97
|
+
|
|
98
|
+
`void`
|
|
99
|
+
|
|
100
|
+
***
|
|
101
|
+
|
|
102
|
+
### resetValue()
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
resetValue(index): void;
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Defined in: [components/Material.ts:238](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L238)
|
|
109
|
+
|
|
110
|
+
#### Parameters
|
|
111
|
+
|
|
112
|
+
| Parameter | Type |
|
|
113
|
+
| ------ | ------ |
|
|
114
|
+
| `index` | `number` |
|
|
115
|
+
|
|
116
|
+
#### Returns
|
|
117
|
+
|
|
118
|
+
`void`
|
|
119
|
+
|
|
120
|
+
***
|
|
121
|
+
|
|
122
|
+
### setMaterialType()
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
setMaterialType(index, type): void;
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Defined in: [components/Material.ts:254](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L254)
|
|
129
|
+
|
|
130
|
+
#### Parameters
|
|
131
|
+
|
|
132
|
+
| Parameter | Type |
|
|
133
|
+
| ------ | ------ |
|
|
134
|
+
| `index` | `number` |
|
|
135
|
+
| `type` | [`MaterialTypeValue`](../type-aliases/MaterialTypeValue.md) |
|
|
136
|
+
|
|
137
|
+
#### Returns
|
|
138
|
+
|
|
139
|
+
`void`
|
|
140
|
+
|
|
141
|
+
***
|
|
142
|
+
|
|
143
|
+
### setTextureFiltering()
|
|
144
|
+
|
|
145
|
+
```ts
|
|
146
|
+
setTextureFiltering(index, filtering): void;
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
Defined in: [components/Material.ts:258](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L258)
|
|
150
|
+
|
|
151
|
+
#### Parameters
|
|
152
|
+
|
|
153
|
+
| Parameter | Type |
|
|
154
|
+
| ------ | ------ |
|
|
155
|
+
| `index` | `number` |
|
|
156
|
+
| `filtering` | [`TextureFilteringValue`](../type-aliases/TextureFilteringValue.md) |
|
|
157
|
+
|
|
158
|
+
#### Returns
|
|
159
|
+
|
|
160
|
+
`void`
|
|
161
|
+
|
|
162
|
+
***
|
|
163
|
+
|
|
164
|
+
### setUseMipmaps()
|
|
165
|
+
|
|
166
|
+
```ts
|
|
167
|
+
setUseMipmaps(index, enabled): void;
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
Defined in: [components/Material.ts:262](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Material.ts#L262)
|
|
171
|
+
|
|
172
|
+
#### Parameters
|
|
173
|
+
|
|
174
|
+
| Parameter | Type |
|
|
175
|
+
| ------ | ------ |
|
|
176
|
+
| `index` | `number` |
|
|
177
|
+
| `enabled` | `boolean` |
|
|
178
|
+
|
|
179
|
+
#### Returns
|
|
180
|
+
|
|
181
|
+
`void`
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / MeshComponent
|
|
6
|
+
|
|
7
|
+
# Class: MeshComponent
|
|
8
|
+
|
|
9
|
+
Defined in: [components/Mesh.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Mesh.ts#L13)
|
|
10
|
+
|
|
11
|
+
Holds the live three.js `Object3D` for an entity that renders as a primitive
|
|
12
|
+
mesh (cube, sphere, plane, capsule, cylinder). For loaded GLTF/GLB models
|
|
13
|
+
see [ModelComponent](ModelComponent.md); for the editable geometry parameters see
|
|
14
|
+
[MeshGeometryComponent](MeshGeometryComponent.md).
|
|
15
|
+
|
|
16
|
+
## Extends
|
|
17
|
+
|
|
18
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
19
|
+
|
|
20
|
+
## Constructors
|
|
21
|
+
|
|
22
|
+
### Constructor
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
new MeshComponent(mesh): MeshComponent;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Defined in: [components/Mesh.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Mesh.ts#L17)
|
|
29
|
+
|
|
30
|
+
#### Parameters
|
|
31
|
+
|
|
32
|
+
| Parameter | Type |
|
|
33
|
+
| ------ | ------ |
|
|
34
|
+
| `mesh` | `Object3D` |
|
|
35
|
+
|
|
36
|
+
#### Returns
|
|
37
|
+
|
|
38
|
+
`MeshComponent`
|
|
39
|
+
|
|
40
|
+
#### Overrides
|
|
41
|
+
|
|
42
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
43
|
+
|
|
44
|
+
## Properties
|
|
45
|
+
|
|
46
|
+
| Property | Type | Description | Defined in |
|
|
47
|
+
| ------ | ------ | ------ | ------ |
|
|
48
|
+
| <a id="mesh"></a> `mesh` | `Object3D` | Underlying three.js mesh placed in the scene graph. | [components/Mesh.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Mesh.ts#L15) |
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / MeshGeometryComponent
|
|
6
|
+
|
|
7
|
+
# Class: MeshGeometryComponent
|
|
8
|
+
|
|
9
|
+
Defined in: [components/MeshGeometry.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L88)
|
|
10
|
+
|
|
11
|
+
Editable geometry parameters for primitive meshes (cube, sphere, plane,
|
|
12
|
+
capsule, cylinder) and the placeholder for `model` entities. Holds the
|
|
13
|
+
authoring values plus shadow casting/receiving flags. The mesh-geometry
|
|
14
|
+
system rebuilds the underlying `BufferGeometry` when parameters change.
|
|
15
|
+
|
|
16
|
+
## Extends
|
|
17
|
+
|
|
18
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
19
|
+
|
|
20
|
+
## Constructors
|
|
21
|
+
|
|
22
|
+
### Constructor
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
new MeshGeometryComponent(
|
|
26
|
+
kind,
|
|
27
|
+
object,
|
|
28
|
+
parameters?,
|
|
29
|
+
options?): MeshGeometryComponent;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [components/MeshGeometry.ts:104](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L104)
|
|
33
|
+
|
|
34
|
+
#### Parameters
|
|
35
|
+
|
|
36
|
+
| Parameter | Type |
|
|
37
|
+
| ------ | ------ |
|
|
38
|
+
| `kind` | [`EditableMeshObjectKind`](../type-aliases/EditableMeshObjectKind.md) |
|
|
39
|
+
| `object` | `Object3D`\<`Object3DEventMap`\> \| `null` |
|
|
40
|
+
| `parameters?` | `Partial`\<[`MeshGeometryParameters`](../type-aliases/MeshGeometryParameters.md)\> |
|
|
41
|
+
| `options?` | \{ `modelName?`: `string`; `castShadow?`: `boolean`; `receiveShadow?`: `boolean`; \} |
|
|
42
|
+
| `options.modelName?` | `string` |
|
|
43
|
+
| `options.castShadow?` | `boolean` |
|
|
44
|
+
| `options.receiveShadow?` | `boolean` |
|
|
45
|
+
|
|
46
|
+
#### Returns
|
|
47
|
+
|
|
48
|
+
`MeshGeometryComponent`
|
|
49
|
+
|
|
50
|
+
#### Overrides
|
|
51
|
+
|
|
52
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
53
|
+
|
|
54
|
+
## Properties
|
|
55
|
+
|
|
56
|
+
| Property | Modifier | Type | Description | Defined in |
|
|
57
|
+
| ------ | ------ | ------ | ------ | ------ |
|
|
58
|
+
| <a id="kind"></a> `kind` | `readonly` | [`EditableMeshObjectKind`](../type-aliases/EditableMeshObjectKind.md) | Primitive kind (`cube`, `sphere`, `plane`, `capsule`, `cylinder`) or `model` for loaded assets. | [components/MeshGeometry.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L90) |
|
|
59
|
+
| <a id="geometrytype"></a> `geometryType` | `readonly` | `string` | Three.js geometry class name (e.g. `"BoxGeometry"`, `"SphereGeometry"`). Derived from [kind](#kind). | [components/MeshGeometry.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L92) |
|
|
60
|
+
| <a id="parameters"></a> `parameters` | `public` | [`MeshGeometryParameters`](../type-aliases/MeshGeometryParameters.md) | Editable parameters whose shape depends on [kind](#kind). The mesh-geometry system rebuilds geometry when these change. | [components/MeshGeometry.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L94) |
|
|
61
|
+
| <a id="object"></a> `object` | `public` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object whose geometry is being managed. `null` until the object is built. | [components/MeshGeometry.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L96) |
|
|
62
|
+
| <a id="modelname"></a> `modelName` | `public` | `string` | Human-readable model name shown in the inspector for `model` entities; empty for primitives. | [components/MeshGeometry.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L98) |
|
|
63
|
+
| <a id="castshadow"></a> `castShadow` | `public` | `boolean` | Whether the mesh casts shadows in the renderer. | [components/MeshGeometry.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L100) |
|
|
64
|
+
| <a id="receiveshadow"></a> `receiveShadow` | `public` | `boolean` | Whether the mesh receives shadows in the renderer. | [components/MeshGeometry.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L102) |
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ModelComponent
|
|
6
|
+
|
|
7
|
+
# Class: ModelComponent
|
|
8
|
+
|
|
9
|
+
Defined in: [components/Model.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Model.ts#L13)
|
|
10
|
+
|
|
11
|
+
References a GLTF/GLB asset loaded from `path`. The model loading system
|
|
12
|
+
resolves the asset asynchronously and populates [ModelComponent.object](#object)
|
|
13
|
+
once available; loading is deferred-tolerant so the entity exists before
|
|
14
|
+
the model finishes loading.
|
|
15
|
+
|
|
16
|
+
## Extends
|
|
17
|
+
|
|
18
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
19
|
+
|
|
20
|
+
## Constructors
|
|
21
|
+
|
|
22
|
+
### Constructor
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
new ModelComponent(path): ModelComponent;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Defined in: [components/Model.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Model.ts#L19)
|
|
29
|
+
|
|
30
|
+
#### Parameters
|
|
31
|
+
|
|
32
|
+
| Parameter | Type |
|
|
33
|
+
| ------ | ------ |
|
|
34
|
+
| `path` | `string` |
|
|
35
|
+
|
|
36
|
+
#### Returns
|
|
37
|
+
|
|
38
|
+
`ModelComponent`
|
|
39
|
+
|
|
40
|
+
#### Overrides
|
|
41
|
+
|
|
42
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
43
|
+
|
|
44
|
+
## Properties
|
|
45
|
+
|
|
46
|
+
| Property | Type | Description | Defined in |
|
|
47
|
+
| ------ | ------ | ------ | ------ |
|
|
48
|
+
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the GLTF/GLB asset. | [components/Model.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Model.ts#L15) |
|
|
49
|
+
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Loaded model object, populated asynchronously by the model loader. `null` until loaded. | [components/Model.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Model.ts#L17) |
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / Name
|
|
6
|
+
|
|
7
|
+
# Class: Name
|
|
8
|
+
|
|
9
|
+
Defined in: [components/Name.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Name.ts#L9)
|
|
10
|
+
|
|
11
|
+
Human-readable name for an entity. Shown in the editor hierarchy panel and
|
|
12
|
+
preserved across save/reload.
|
|
13
|
+
|
|
14
|
+
## Extends
|
|
15
|
+
|
|
16
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
17
|
+
|
|
18
|
+
## Constructors
|
|
19
|
+
|
|
20
|
+
### Constructor
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
new Name(value): Name;
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defined in: [components/Name.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Name.ts#L13)
|
|
27
|
+
|
|
28
|
+
#### Parameters
|
|
29
|
+
|
|
30
|
+
| Parameter | Type |
|
|
31
|
+
| ------ | ------ |
|
|
32
|
+
| `value` | `string` |
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
`Name`
|
|
37
|
+
|
|
38
|
+
#### Overrides
|
|
39
|
+
|
|
40
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
41
|
+
|
|
42
|
+
## Properties
|
|
43
|
+
|
|
44
|
+
| Property | Type | Description | Defined in |
|
|
45
|
+
| ------ | ------ | ------ | ------ |
|
|
46
|
+
| <a id="value"></a> `value` | `string` | Display name for the entity. Shown in the editor hierarchy. | [components/Name.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Name.ts#L11) |
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / Object3DRef
|
|
6
|
+
|
|
7
|
+
# Class: Object3DRef
|
|
8
|
+
|
|
9
|
+
Defined in: [components/Object3DRef.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Object3DRef.ts#L16)
|
|
10
|
+
|
|
11
|
+
Wraps the live `THREE.Object3D` for an entity. Almost every entity that
|
|
12
|
+
renders to the scene carries an `Object3DRef` so transform sync, selection,
|
|
13
|
+
and parenting systems can manipulate the underlying object.
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
The `object` reference may be replaced when assets finish loading. Read it
|
|
18
|
+
fresh inside system/script hooks rather than caching it across frames.
|
|
19
|
+
|
|
20
|
+
## Extends
|
|
21
|
+
|
|
22
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
23
|
+
|
|
24
|
+
## Constructors
|
|
25
|
+
|
|
26
|
+
### Constructor
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
new Object3DRef(object, visibility?): Object3DRef;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [components/Object3DRef.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Object3DRef.ts#L22)
|
|
33
|
+
|
|
34
|
+
#### Parameters
|
|
35
|
+
|
|
36
|
+
| Parameter | Type |
|
|
37
|
+
| ------ | ------ |
|
|
38
|
+
| `object` | `Object3D` |
|
|
39
|
+
| `visibility?` | `boolean` |
|
|
40
|
+
|
|
41
|
+
#### Returns
|
|
42
|
+
|
|
43
|
+
`Object3DRef`
|
|
44
|
+
|
|
45
|
+
#### Overrides
|
|
46
|
+
|
|
47
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
48
|
+
|
|
49
|
+
## Properties
|
|
50
|
+
|
|
51
|
+
| Property | Type | Description | Defined in |
|
|
52
|
+
| ------ | ------ | ------ | ------ |
|
|
53
|
+
| <a id="object"></a> `object` | `Object3D` | Live three.js object placed in the scene graph. May be replaced when assets finish loading. | [components/Object3DRef.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Object3DRef.ts#L18) |
|
|
54
|
+
| <a id="visibility"></a> `visibility` | `boolean` | Whether the object is currently visible. Mirrors `object.visible` and is preserved across reloads. | [components/Object3DRef.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Object3DRef.ts#L20) |
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ParentId
|
|
6
|
+
|
|
7
|
+
# Class: ParentId
|
|
8
|
+
|
|
9
|
+
Defined in: [components/ParentId.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ParentId.ts#L11)
|
|
10
|
+
|
|
11
|
+
Records the parent entity id for hierarchical scene graphs. `null` means
|
|
12
|
+
the entity is at the world root. The `ObjectManagementSystem` reconciles
|
|
13
|
+
scene-graph parenting from this component each frame.
|
|
14
|
+
|
|
15
|
+
## Extends
|
|
16
|
+
|
|
17
|
+
- [`Component`](../../Component/classes/Component.md)
|
|
18
|
+
|
|
19
|
+
## Constructors
|
|
20
|
+
|
|
21
|
+
### Constructor
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
new ParentId(value?): ParentId;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [components/ParentId.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ParentId.ts#L15)
|
|
28
|
+
|
|
29
|
+
#### Parameters
|
|
30
|
+
|
|
31
|
+
| Parameter | Type | Default value |
|
|
32
|
+
| ------ | ------ | ------ |
|
|
33
|
+
| `value` | `number` \| `null` | `null` |
|
|
34
|
+
|
|
35
|
+
#### Returns
|
|
36
|
+
|
|
37
|
+
`ParentId`
|
|
38
|
+
|
|
39
|
+
#### Overrides
|
|
40
|
+
|
|
41
|
+
[`Component`](../../Component/classes/Component.md).[`constructor`](../../Component/classes/Component.md#constructor)
|
|
42
|
+
|
|
43
|
+
## Properties
|
|
44
|
+
|
|
45
|
+
| Property | Type | Description | Defined in |
|
|
46
|
+
| ------ | ------ | ------ | ------ |
|
|
47
|
+
| <a id="value"></a> `value` | `number` \| `null` | Parent entity id, or `null` for root-level entities. | [components/ParentId.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/ParentId.ts#L13) |
|