@relu-interactives/spatial-ecs 0.2.25 → 0.3.1
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/dist/{System-CYWZ_Zx5.d.cts → System-vrU46Vuw.d.cts} +16 -2
- package/dist/{System-CYWZ_Zx5.d.ts → System-vrU46Vuw.d.ts} +16 -2
- package/dist/{Video-AIQYTAAr.d.cts → XRRig-CAmf04NX.d.ts} +131 -4
- package/dist/{Video-DlZ4G9ig.d.ts → XRRig-Cu-EyliG.d.cts} +131 -4
- package/dist/{chunk-XFD74BQL.js → chunk-67WGASUJ.js} +3 -3
- package/dist/{chunk-XFD74BQL.js.map → chunk-67WGASUJ.js.map} +1 -1
- package/dist/{chunk-RJ4J5UEX.js → chunk-PCOZLCXS.js} +160 -83
- package/dist/chunk-PCOZLCXS.js.map +1 -0
- package/dist/{chunk-J6736FFO.js → chunk-U3MDYKPV.js} +90 -14
- package/dist/chunk-U3MDYKPV.js.map +1 -0
- package/dist/{chunk-3P3ZBP7K.js → chunk-VXUVNC7S.js} +634 -6
- package/dist/chunk-VXUVNC7S.js.map +1 -0
- package/dist/components/index.cjs +87 -11
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +3 -3
- package/dist/components/index.d.ts +3 -3
- package/dist/components/index.js +1 -1
- package/dist/docs/api/Behaviour/classes/Behaviour.md +98 -51
- package/dist/docs/api/Component/classes/Component.md +4 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +19 -19
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +4 -4
- package/dist/docs/api/components/classes/Environment.md +3 -3
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +7 -7
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +4 -4
- package/dist/docs/api/components/classes/InstanceSlotComponent.md +4 -4
- package/dist/docs/api/components/classes/InstancedMeshComponent.md +10 -10
- package/dist/docs/api/components/classes/LightComponent.md +6 -6
- package/dist/docs/api/components/classes/MaterialComponent.md +57 -11
- package/dist/docs/api/components/classes/MeshComponent.md +3 -3
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +9 -9
- package/dist/docs/api/components/classes/ModelComponent.md +4 -4
- package/dist/docs/api/components/classes/Name.md +3 -3
- package/dist/docs/api/components/classes/Object3DRef.md +4 -4
- package/dist/docs/api/components/classes/ParentId.md +3 -3
- package/dist/docs/api/components/classes/PhysicsComponent.md +12 -13
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/PrefabInstance.md +80 -0
- package/dist/docs/api/components/classes/PrefabNode.md +54 -0
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- package/dist/docs/api/components/classes/ScriptObjectComponent.md +55 -0
- package/dist/docs/api/components/classes/Selectable.md +3 -3
- package/dist/docs/api/components/classes/SelectionTransformState.md +5 -5
- package/dist/docs/api/components/classes/SpriteComponent.md +7 -7
- package/dist/docs/api/components/classes/TransformComponent.md +12 -12
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/functions/defaultMaterialValue.md +17 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +34 -0
- package/dist/docs/api/components/index.md +8 -1
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +13 -13
- package/dist/docs/api/components/type-aliases/CameraProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderShape.md +1 -1
- package/dist/docs/api/components/type-aliases/ColliderState.md +20 -20
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +4 -4
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +7 -7
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +5 -5
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +7 -7
- package/dist/docs/api/components/type-aliases/InstanceTransform.md +13 -13
- package/dist/docs/api/components/type-aliases/InstancedMeshKind.md +1 -1
- package/dist/docs/api/components/type-aliases/LightValueState.md +11 -11
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +28 -28
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +1 -1
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +7 -7
- package/dist/docs/api/components/type-aliases/PhysicsState.md +3 -3
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +62 -62
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +3 -3
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +2 -2
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +17 -17
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +8 -10
- package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +20 -0
- package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +13 -0
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformData.md +4 -4
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +1 -1
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +1 -1
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCED_MESH_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_INSTANCE_TRANSFORM.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +1 -1
- package/dist/docs/api/index/classes/AnimationStateMachine.md +16 -16
- package/dist/docs/api/index/classes/AnimationStateManager.md +13 -13
- package/dist/docs/api/index/classes/AnimationSystem.md +3 -3
- package/dist/docs/api/index/classes/AudioSystem.md +4 -4
- package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/InputSystem.md +33 -33
- package/dist/docs/api/index/classes/InstancedMeshSystem.md +2 -2
- package/dist/docs/api/index/classes/LightSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +3 -3
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +2 -2
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +14 -14
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +2 -2
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +4 -4
- package/dist/docs/api/index/classes/RenderSystem.md +3 -3
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +5 -5
- package/dist/docs/api/index/classes/ScriptObject.md +156 -0
- package/dist/docs/api/index/classes/ScriptObjectSystem.md +129 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +183 -86
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +32 -0
- package/dist/docs/api/index/functions/buildComponentValueMaps.md +23 -0
- package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +25 -0
- package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +23 -0
- package/dist/docs/api/index/functions/canonicalizeComponentValue.md +38 -0
- package/dist/docs/api/index/functions/clearModelCache.md +26 -0
- package/dist/docs/api/index/functions/clearPrefabCache.md +25 -0
- package/dist/docs/api/index/functions/collectDiffPaths.md +38 -0
- package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +27 -0
- package/dist/docs/api/index/functions/collectEntitySubtree.md +29 -0
- package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +26 -0
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +44 -0
- package/dist/docs/api/index/functions/createAnimationComponent.md +1 -1
- package/dist/docs/api/index/functions/createAudioComponent.md +1 -1
- package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +2 -2
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createImageTargetComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstanceSlotComponent.md +1 -1
- package/dist/docs/api/index/functions/createInstancedMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createLightComponent.md +1 -1
- package/dist/docs/api/index/functions/createMaterialComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshComponent.md +1 -1
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +1 -1
- package/dist/docs/api/index/functions/createModelComponent.md +1 -1
- package/dist/docs/api/index/functions/createNameComponent.md +1 -1
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +1 -1
- package/dist/docs/api/index/functions/createParentIdComponent.md +1 -1
- package/dist/docs/api/index/functions/createPhysicsComponent.md +2 -4
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptComponent.md +1 -1
- package/dist/docs/api/index/functions/createScriptObjectComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectableComponent.md +1 -1
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +1 -1
- package/dist/docs/api/index/functions/createSpriteComponent.md +1 -1
- package/dist/docs/api/index/functions/createTransformComponent.md +1 -1
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +28 -0
- package/dist/docs/api/index/functions/despawnPrefab.md +32 -0
- package/dist/docs/api/index/functions/encodeOverride.md +28 -0
- package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +25 -0
- package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +28 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +25 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +4 -2
- package/dist/docs/api/index/functions/indexSnapshotByEntity.md +25 -0
- package/dist/docs/api/index/functions/instantiateSubtree.md +32 -0
- package/dist/docs/api/index/functions/loadPrefab.md +28 -0
- package/dist/docs/api/index/functions/loadSharedGltf.md +29 -0
- package/dist/docs/api/index/functions/mergeComponentValue.md +32 -0
- package/dist/docs/api/index/functions/parseOverride.md +34 -0
- package/dist/docs/api/index/functions/parsePrefabAsset.md +25 -0
- package/dist/docs/api/index/functions/prefabFileVersionFor.md +25 -0
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +1 -1
- package/dist/docs/api/index/functions/registerDefaultFactories.md +1 -1
- package/dist/docs/api/index/functions/remapSnapshotEntityIds.md +46 -0
- package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +17 -0
- package/dist/docs/api/index/functions/restoreComponentState.md +34 -0
- package/dist/docs/api/index/functions/restorePostCreateComponents.md +36 -0
- package/dist/docs/api/index/functions/serializeEntitySubtree.md +35 -0
- package/dist/docs/api/index/functions/setDracoDecoderPath.md +30 -0
- package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +30 -0
- package/dist/docs/api/index/functions/spawnPrefab.md +36 -0
- package/dist/docs/api/index/index.md +65 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/StateMachine.md +13 -13
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +4 -4
- package/dist/docs/api/index/type-aliases/ApplyPrefabToSnapshotResult.md +23 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +69 -0
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +2 -1
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +3 -3
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +4 -4
- package/dist/docs/api/index/type-aliases/ExternalRefWarning.md +27 -0
- package/dist/docs/api/index/type-aliases/HydrateOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +7 -5
- package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +23 -0
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/ModuleLoader.md +25 -0
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/NestedRegion.md +27 -0
- package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +30 -0
- package/dist/docs/api/index/type-aliases/NodeMaps.md +25 -0
- package/dist/docs/api/index/type-aliases/PrefabAsset.md +32 -0
- package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +21 -0
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +25 -0
- package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +19 -0
- package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +43 -0
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +19 -0
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +1 -1
- package/dist/docs/api/index/variables/KeyboardKeys.md +89 -89
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +13 -0
- package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +15 -0
- package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +16 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +13 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +15 -0
- package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +15 -0
- package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +17 -0
- package/dist/docs/api/typedoc-sidebar.json +1 -1
- package/dist/docs/api/types/type-aliases/AssetInput.md +3 -3
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +3 -3
- package/dist/docs/api/types/type-aliases/ColorInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ComponentInput.md +4 -4
- package/dist/docs/api/types/type-aliases/ComponentKind.md +2 -1
- package/dist/docs/api/types/type-aliases/DropdownInput.md +3 -3
- package/dist/docs/api/types/type-aliases/DropdownOption.md +3 -3
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +1 -1
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +3 -2
- package/dist/docs/api/types/type-aliases/EntityId.md +1 -1
- package/dist/docs/api/types/type-aliases/EntityInput.md +3 -3
- package/dist/docs/api/types/type-aliases/FloatInput.md +1 -1
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +3 -3
- package/dist/docs/api/types/type-aliases/ParentLookup.md +3 -3
- package/dist/docs/api/types/type-aliases/SelectionListener.md +1 -1
- package/dist/docs/api/types/type-aliases/SliderInput.md +5 -5
- package/dist/docs/api/types/type-aliases/TextInput.md +1 -1
- package/dist/docs/api/types/type-aliases/ToggleInput.md +1 -1
- package/dist/docs/api/types/type-aliases/Vec3.md +1 -1
- package/dist/docs/api/types/type-aliases/Vector2Input.md +3 -3
- package/dist/docs/api/types/type-aliases/Vector3Input.md +4 -4
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +1 -1
- package/dist/docs/guide/components/_sidebar.json +4 -0
- package/dist/docs/guide/components/material.md +1 -0
- package/dist/docs/guide/components/script-object.md +32 -0
- package/dist/factories/index.cjs +271 -118
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +9 -3
- package/dist/factories/index.d.ts +9 -3
- package/dist/factories/index.js +3 -3
- package/dist/{index-Gr8aCPRM.d.cts → index-CUFd71ri.d.cts} +12 -3
- package/dist/index-D84o_UA6.d.ts +488 -0
- package/dist/index-YYypJaVw.d.cts +488 -0
- package/dist/{index-BwiRJNIT.d.ts → index-w1oqWl_M.d.ts} +12 -3
- package/dist/index.cjs +1014 -208
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +42 -8
- package/dist/index.d.ts +42 -8
- package/dist/index.js +24 -8
- package/dist/index.js.map +1 -1
- package/dist/systems/index.cjs +717 -12
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +3 -278
- package/dist/systems/index.d.ts +3 -278
- package/dist/systems/index.js +3 -3
- package/dist/types.d.cts +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/worldSnapshotUtils.d.cts +1 -1
- package/dist/worldSnapshotUtils.d.ts +1 -1
- package/package.json +4 -4
- package/dist/chunk-3P3ZBP7K.js.map +0 -1
- package/dist/chunk-J6736FFO.js.map +0 -1
- package/dist/chunk-RJ4J5UEX.js.map +0 -1
|
@@ -18,7 +18,7 @@ type EnvironmentSkyboxState = {
|
|
|
18
18
|
};
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [components/Environment.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
21
|
+
Defined in: [components/Environment.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Environment.ts#L11)
|
|
22
22
|
|
|
23
23
|
Skybox configuration. Only the fields relevant to [type](#type) are read at render time.
|
|
24
24
|
|
|
@@ -26,9 +26,9 @@ Skybox configuration. Only the fields relevant to [type](#type) are read at rend
|
|
|
26
26
|
|
|
27
27
|
| Property | Type | Description | Defined in |
|
|
28
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
34
|
-
| `gradient.effect` | [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md) | Gradient distribution. | [components/Environment.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/core/components/Environment.ts#L23) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type EnvironmentSkyboxType = "gradient" | "color" | "image" | "none";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Environment.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Environment.ts#L4)
|
|
14
14
|
|
|
15
15
|
Skybox rendering modes. `none` disables skybox rendering entirely.
|
|
@@ -15,7 +15,7 @@ type EnvironmentState = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [components/Environment.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
+
Defined in: [components/Environment.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Environment.ts#L58)
|
|
19
19
|
|
|
20
20
|
Aggregated authoring state owned by [Environment](../classes/Environment.md).
|
|
21
21
|
|
|
@@ -23,7 +23,7 @@ Aggregated authoring state owned by [Environment](../classes/Environment.md).
|
|
|
23
23
|
|
|
24
24
|
| Property | Type | Description | Defined in |
|
|
25
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/
|
|
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/
|
|
28
|
-
| <a id="gravity"></a> `gravity` | `EnvironmentGravityState` | World gravity. | [components/Environment.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
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/
|
|
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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/core/components/Environment.ts#L70) |
|
|
@@ -13,7 +13,7 @@ type ImageTargetAnchorOptions = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [components/ImageTargetAnchor.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [components/ImageTargetAnchor.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ImageTargetAnchor.ts#L4)
|
|
17
17
|
|
|
18
18
|
Optional initializer for [ImageTargetAnchor](../classes/ImageTargetAnchor.md).
|
|
19
19
|
|
|
@@ -21,5 +21,5 @@ Optional initializer for [ImageTargetAnchor](../classes/ImageTargetAnchor.md).
|
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
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/
|
|
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/
|
|
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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/core/components/ImageTargetAnchor.ts#L8) |
|
|
@@ -17,7 +17,7 @@ type ImageTargetReference = {
|
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [components/ImageTarget.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
20
|
+
Defined in: [components/ImageTarget.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/ImageTarget.ts#L6)
|
|
21
21
|
|
|
22
22
|
Single uploaded image used as input to the image-target compiler.
|
|
23
23
|
|
|
@@ -25,9 +25,9 @@ Single uploaded image used as input to the image-target compiler.
|
|
|
25
25
|
|
|
26
26
|
| Property | Type | Description | Defined in |
|
|
27
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/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/020795472520adb990c488982ca8572cbf8580db/core/components/ImageTarget.ts#L18) |
|
|
@@ -26,7 +26,7 @@ type InstanceTransform = {
|
|
|
26
26
|
};
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [components/InstancedMesh.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
+
Defined in: [components/InstancedMesh.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L17)
|
|
30
30
|
|
|
31
31
|
Per-instance transform stored inside [InstancedMeshComponent](../classes/InstancedMeshComponent.md).
|
|
32
32
|
All rotations are in radians.
|
|
@@ -35,15 +35,15 @@ All rotations are in radians.
|
|
|
35
35
|
|
|
36
36
|
| Property | Type | Description | Defined in |
|
|
37
37
|
| ------ | ------ | ------ | ------ |
|
|
38
|
-
| <a id="position"></a> `position` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
-
| `position.x` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| `position.y` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| `position.z` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
42
|
-
| <a id="rotation"></a> `rotation` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Euler rotation in radians (XYZ order). | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
-
| `rotation.x` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
-
| `rotation.y` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| `rotation.z` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| <a id="scale"></a> `scale` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
-
| `scale.x` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
-
| `scale.y` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| `scale.z` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
+
| <a id="position"></a> `position` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L18) |
|
|
39
|
+
| `position.x` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L18) |
|
|
40
|
+
| `position.y` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L18) |
|
|
41
|
+
| `position.z` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L18) |
|
|
42
|
+
| <a id="rotation"></a> `rotation` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Euler rotation in radians (XYZ order). | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L20) |
|
|
43
|
+
| `rotation.x` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L20) |
|
|
44
|
+
| `rotation.y` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L20) |
|
|
45
|
+
| `rotation.z` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L20) |
|
|
46
|
+
| <a id="scale"></a> `scale` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L21) |
|
|
47
|
+
| `scale.x` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L21) |
|
|
48
|
+
| `scale.y` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L21) |
|
|
49
|
+
| `scale.z` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L21) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type InstancedMeshKind = "capsule" | "cube" | "cylinder" | "model" | "plane" | "sphere";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/InstancedMesh.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/InstancedMesh.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/InstancedMesh.ts#L25)
|
|
14
14
|
|
|
15
15
|
Primitive geometry kinds and custom 3D model kind supported by instanced mesh rendering.
|
|
@@ -21,7 +21,7 @@ type LightValueState = {
|
|
|
21
21
|
};
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [components/Light.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
Defined in: [components/Light.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L6)
|
|
25
25
|
|
|
26
26
|
Authoring state for [LightComponent](../classes/LightComponent.md). Common fields apply to every light kind; the optional fields are only meaningful for specific kinds.
|
|
27
27
|
|
|
@@ -29,13 +29,13 @@ Authoring state for [LightComponent](../classes/LightComponent.md). Common field
|
|
|
29
29
|
|
|
30
30
|
| Property | Type | Description | Defined in |
|
|
31
31
|
| ------ | ------ | ------ | ------ |
|
|
32
|
-
| <a id="color"></a> `color` | `string` | Light color as `#rrggbb` hex string. | [components/Light.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
33
|
-
| <a id="intensity"></a> `intensity` | `number` | Light intensity multiplier (units depend on three.js physically-correct mode). | [components/Light.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
34
|
-
| <a id="castshadow"></a> `castShadow` | `boolean` | Whether the light casts shadows. | [components/Light.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
-
| <a id="frustumculling"></a> `frustumCulling` | `boolean` | Whether the light is frustum-culled when off-screen. | [components/Light.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
36
|
-
| <a id="distance"></a> `distance?` | `number` | Maximum range; `0` means infinite. (PointLight, SpotLight) | [components/Light.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
37
|
-
| <a id="decay"></a> `decay?` | `number` | Falloff exponent for distance attenuation. (PointLight, SpotLight) | [components/Light.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
-
| <a id="angle"></a> `angle?` | `number` | Cone half-angle in **radians**. (SpotLight) | [components/Light.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
-
| <a id="penumbra"></a> `penumbra?` | `number` | Soft-edge factor in `[0, 1]`; `0` is a hard edge. (SpotLight) | [components/Light.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| <a id="width"></a> `width?` | `number` | Rectangle width in world units. (RectAreaLight) | [components/Light.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| <a id="height"></a> `height?` | `number` | Rectangle height in world units. (RectAreaLight) | [components/Light.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
+
| <a id="color"></a> `color` | `string` | Light color as `#rrggbb` hex string. | [components/Light.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L8) |
|
|
33
|
+
| <a id="intensity"></a> `intensity` | `number` | Light intensity multiplier (units depend on three.js physically-correct mode). | [components/Light.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L10) |
|
|
34
|
+
| <a id="castshadow"></a> `castShadow` | `boolean` | Whether the light casts shadows. | [components/Light.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L12) |
|
|
35
|
+
| <a id="frustumculling"></a> `frustumCulling` | `boolean` | Whether the light is frustum-culled when off-screen. | [components/Light.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L14) |
|
|
36
|
+
| <a id="distance"></a> `distance?` | `number` | Maximum range; `0` means infinite. (PointLight, SpotLight) | [components/Light.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L16) |
|
|
37
|
+
| <a id="decay"></a> `decay?` | `number` | Falloff exponent for distance attenuation. (PointLight, SpotLight) | [components/Light.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L18) |
|
|
38
|
+
| <a id="angle"></a> `angle?` | `number` | Cone half-angle in **radians**. (SpotLight) | [components/Light.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L20) |
|
|
39
|
+
| <a id="penumbra"></a> `penumbra?` | `number` | Soft-edge factor in `[0, 1]`; `0` is a hard edge. (SpotLight) | [components/Light.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L22) |
|
|
40
|
+
| <a id="width"></a> `width?` | `number` | Rectangle width in world units. (RectAreaLight) | [components/Light.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L24) |
|
|
41
|
+
| <a id="height"></a> `height?` | `number` | Rectangle height in world units. (RectAreaLight) | [components/Light.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Light.ts#L26) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type MaterialTypeValue = "standard" | "basic" | "phong" | "physical";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Material.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Material.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L6)
|
|
14
14
|
|
|
15
15
|
Supported material classes. Each maps to a three.js `Mesh*Material` type.
|
|
@@ -38,7 +38,7 @@ type MaterialValueState = {
|
|
|
38
38
|
};
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
Defined in: [components/Material.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
+
Defined in: [components/Material.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L11)
|
|
42
42
|
|
|
43
43
|
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.
|
|
44
44
|
|
|
@@ -46,30 +46,30 @@ Authoring state for a single slot in [MaterialComponent.values](../classes/Mater
|
|
|
46
46
|
|
|
47
47
|
| Property | Type | Description | Defined in |
|
|
48
48
|
| ------ | ------ | ------ | ------ |
|
|
49
|
-
| <a id="type"></a> `type` | [`MaterialTypeValue`](MaterialTypeValue.md) | Underlying material class. | [components/Material.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="color"></a> `color` | `string` | Base color as `#rrggbb` hex string. | [components/Material.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| <a id="roughness"></a> `roughness` | `number` | PBR roughness in `[0, 1]`. | [components/Material.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="metalness"></a> `metalness` | `number` | PBR metalness in `[0, 1]`. | [components/Material.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="normalscale"></a> `normalScale` | `number` | Multiplier applied to the normal map (uniform on both axes). | [components/Material.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="opacity"></a> `opacity` | `number` | Surface opacity in `[0, 1]`. Combine with [transparent](#transparent) to enable alpha. | [components/Material.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| <a id="emissive"></a> `emissive` | `string` | Emissive color as `#rrggbb` hex string. | [components/Material.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
-
| <a id="emissiveintensity"></a> `emissiveIntensity` | `number` | Emissive intensity multiplier. | [components/Material.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
-
| <a id="side"></a> `side` | `number` | Three.js `Side` enum value (`FrontSide`, `BackSide`, or `DoubleSide`). | [components/Material.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
58
|
-
| <a id="blending"></a> `blending` | `number` | Three.js `Blending` enum value. | [components/Material.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
-
| <a id="depthtest"></a> `depthTest` | `boolean` | Whether depth testing is enabled. | [components/Material.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
-
| <a id="depthwrite"></a> `depthWrite` | `boolean` | Whether depth writes are enabled. | [components/Material.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
61
|
-
| <a id="wireframe"></a> `wireframe` | `boolean` | Render as wireframe. | [components/Material.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
62
|
-
| <a id="transparent"></a> `transparent` | `boolean` | Enable transparency (must be `true` for [opacity](#opacity) < 1 to render correctly). | [components/Material.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
63
|
-
| <a id="texturemap"></a> `textureMap?` | `string` | Color/diffuse texture URL. | [components/Material.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
64
|
-
| <a id="alphatexturemap"></a> `alphaTextureMap?` | `string` | Alpha (transparency) texture URL. | [components/Material.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
65
|
-
| <a id="normalmap"></a> `normalMap?` | `string` | Tangent-space normal map URL. | [components/Material.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
66
|
-
| <a id="roughnessmap"></a> `roughnessMap?` | `string` | Roughness map URL (red channel). | [components/Material.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
67
|
-
| <a id="metalnessmap"></a> `metalnessMap?` | `string` | Metalness map URL (red channel). | [components/Material.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
68
|
-
| <a id="aomap"></a> `aoMap?` | `string` | Ambient occlusion map URL. | [components/Material.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
69
|
-
| <a id="emissivemap"></a> `emissiveMap?` | `string` | Emissive color map URL. | [components/Material.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
70
|
-
| <a id="bumpmap"></a> `bumpMap?` | `string` | Bump map URL (height-based shading approximation). | [components/Material.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
71
|
-
| <a id="displacementmap"></a> `displacementMap?` | `string` | Displacement map URL (geometric vertex offset). | [components/Material.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
72
|
-
| <a id="lightmap"></a> `lightMap?` | `string` | Pre-baked light map URL. | [components/Material.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
73
|
-
| <a id="envmap"></a> `envMap?` | `string` | Environment reflection map URL. | [components/Material.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
74
|
-
| <a id="texturefiltering"></a> `textureFiltering` | [`TextureFilteringValue`](TextureFilteringValue.md) | Texture sampling mode applied to the color map. | [components/Material.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
75
|
-
| <a id="usemipmaps"></a> `useMipmaps` | `boolean` | Whether mipmaps are generated for texture maps. | [components/Material.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
+
| <a id="type"></a> `type` | [`MaterialTypeValue`](MaterialTypeValue.md) | Underlying material class. | [components/Material.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L13) |
|
|
50
|
+
| <a id="color"></a> `color` | `string` | Base color as `#rrggbb` hex string. | [components/Material.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L15) |
|
|
51
|
+
| <a id="roughness"></a> `roughness` | `number` | PBR roughness in `[0, 1]`. | [components/Material.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L17) |
|
|
52
|
+
| <a id="metalness"></a> `metalness` | `number` | PBR metalness in `[0, 1]`. | [components/Material.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L19) |
|
|
53
|
+
| <a id="normalscale"></a> `normalScale` | `number` | Multiplier applied to the normal map (uniform on both axes). | [components/Material.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L21) |
|
|
54
|
+
| <a id="opacity"></a> `opacity` | `number` | Surface opacity in `[0, 1]`. Combine with [transparent](#transparent) to enable alpha. | [components/Material.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L23) |
|
|
55
|
+
| <a id="emissive"></a> `emissive` | `string` | Emissive color as `#rrggbb` hex string. | [components/Material.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L25) |
|
|
56
|
+
| <a id="emissiveintensity"></a> `emissiveIntensity` | `number` | Emissive intensity multiplier. | [components/Material.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L27) |
|
|
57
|
+
| <a id="side"></a> `side` | `number` | Three.js `Side` enum value (`FrontSide`, `BackSide`, or `DoubleSide`). | [components/Material.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L29) |
|
|
58
|
+
| <a id="blending"></a> `blending` | `number` | Three.js `Blending` enum value. | [components/Material.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L31) |
|
|
59
|
+
| <a id="depthtest"></a> `depthTest` | `boolean` | Whether depth testing is enabled. | [components/Material.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L33) |
|
|
60
|
+
| <a id="depthwrite"></a> `depthWrite` | `boolean` | Whether depth writes are enabled. | [components/Material.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L35) |
|
|
61
|
+
| <a id="wireframe"></a> `wireframe` | `boolean` | Render as wireframe. | [components/Material.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L37) |
|
|
62
|
+
| <a id="transparent"></a> `transparent` | `boolean` | Enable transparency (must be `true` for [opacity](#opacity) < 1 to render correctly). | [components/Material.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L39) |
|
|
63
|
+
| <a id="texturemap"></a> `textureMap?` | `string` | Color/diffuse texture URL. | [components/Material.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L41) |
|
|
64
|
+
| <a id="alphatexturemap"></a> `alphaTextureMap?` | `string` | Alpha (transparency) texture URL. | [components/Material.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L43) |
|
|
65
|
+
| <a id="normalmap"></a> `normalMap?` | `string` | Tangent-space normal map URL. | [components/Material.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L45) |
|
|
66
|
+
| <a id="roughnessmap"></a> `roughnessMap?` | `string` | Roughness map URL (red channel). | [components/Material.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L47) |
|
|
67
|
+
| <a id="metalnessmap"></a> `metalnessMap?` | `string` | Metalness map URL (red channel). | [components/Material.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L49) |
|
|
68
|
+
| <a id="aomap"></a> `aoMap?` | `string` | Ambient occlusion map URL. | [components/Material.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L51) |
|
|
69
|
+
| <a id="emissivemap"></a> `emissiveMap?` | `string` | Emissive color map URL. | [components/Material.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L53) |
|
|
70
|
+
| <a id="bumpmap"></a> `bumpMap?` | `string` | Bump map URL (height-based shading approximation). | [components/Material.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L55) |
|
|
71
|
+
| <a id="displacementmap"></a> `displacementMap?` | `string` | Displacement map URL (geometric vertex offset). | [components/Material.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L57) |
|
|
72
|
+
| <a id="lightmap"></a> `lightMap?` | `string` | Pre-baked light map URL. | [components/Material.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L59) |
|
|
73
|
+
| <a id="envmap"></a> `envMap?` | `string` | Environment reflection map URL. | [components/Material.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L61) |
|
|
74
|
+
| <a id="texturefiltering"></a> `textureFiltering` | [`TextureFilteringValue`](TextureFilteringValue.md) | Texture sampling mode applied to the color map. | [components/Material.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L63) |
|
|
75
|
+
| <a id="usemipmaps"></a> `useMipmaps` | `boolean` | Whether mipmaps are generated for texture maps. | [components/Material.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Material.ts#L65) |
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type MeshGeometryParameters = MeshGeometryParametersByKind[EditableMeshObjectKind];
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/MeshGeometry.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/MeshGeometry.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L59)
|
|
@@ -17,7 +17,7 @@ type MeshGeometryParametersByKind = {
|
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [components/MeshGeometry.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
20
|
+
Defined in: [components/MeshGeometry.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L50)
|
|
21
21
|
|
|
22
22
|
Map from [EditableMeshObjectKind](EditableMeshObjectKind.md) to its parameter shape.
|
|
23
23
|
|
|
@@ -25,9 +25,9 @@ Map from [EditableMeshObjectKind](EditableMeshObjectKind.md) to its parameter sh
|
|
|
25
25
|
|
|
26
26
|
| Property | Type | Defined in |
|
|
27
27
|
| ------ | ------ | ------ |
|
|
28
|
-
| <a id="capsule"></a> `capsule` | [`RadiusHeightMeshParameters`](RadiusHeightMeshParameters.md) | [components/MeshGeometry.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
-
| <a id="cube"></a> `cube` | [`CubeMeshParameters`](CubeMeshParameters.md) | [components/MeshGeometry.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
-
| <a id="cylinder"></a> `cylinder` | [`RadiusHeightMeshParameters`](RadiusHeightMeshParameters.md) | [components/MeshGeometry.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
-
| <a id="model"></a> `model` | `ModelMeshParameters` | [components/MeshGeometry.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
-
| <a id="plane"></a> `plane` | [`PlaneMeshParameters`](PlaneMeshParameters.md) | [components/MeshGeometry.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
33
|
-
| <a id="sphere"></a> `sphere` | [`RadiusMeshParameters`](RadiusMeshParameters.md) | [components/MeshGeometry.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
+
| <a id="capsule"></a> `capsule` | [`RadiusHeightMeshParameters`](RadiusHeightMeshParameters.md) | [components/MeshGeometry.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L51) |
|
|
29
|
+
| <a id="cube"></a> `cube` | [`CubeMeshParameters`](CubeMeshParameters.md) | [components/MeshGeometry.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L52) |
|
|
30
|
+
| <a id="cylinder"></a> `cylinder` | [`RadiusHeightMeshParameters`](RadiusHeightMeshParameters.md) | [components/MeshGeometry.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L53) |
|
|
31
|
+
| <a id="model"></a> `model` | `ModelMeshParameters` | [components/MeshGeometry.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L54) |
|
|
32
|
+
| <a id="plane"></a> `plane` | [`PlaneMeshParameters`](PlaneMeshParameters.md) | [components/MeshGeometry.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L55) |
|
|
33
|
+
| <a id="sphere"></a> `sphere` | [`RadiusMeshParameters`](RadiusMeshParameters.md) | [components/MeshGeometry.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L56) |
|
|
@@ -13,7 +13,7 @@ type PhysicsState = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [components/Physics.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [components/Physics.ts:165](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L165)
|
|
17
17
|
|
|
18
18
|
Combined authoring state for [PhysicsComponent](../classes/PhysicsComponent.md). Saved with the project.
|
|
19
19
|
|
|
@@ -21,5 +21,5 @@ Combined authoring state for [PhysicsComponent](../classes/PhysicsComponent.md).
|
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="rigidbody"></a> `rigidbody` | [`RigidbodyState`](RigidbodyState.md) | Rigid body settings. | [components/Physics.ts:167](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="collider"></a> `collider` | [`ColliderState`](ColliderState.md) | Collider settings. | [components/Physics.ts:169](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="rigidbody"></a> `rigidbody` | [`RigidbodyState`](RigidbodyState.md) | Rigid body settings. | [components/Physics.ts:167](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L167) |
|
|
25
|
+
| <a id="collider"></a> `collider` | [`ColliderState`](ColliderState.md) | Collider settings. | [components/Physics.ts:169](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/Physics.ts#L169) |
|
|
@@ -13,7 +13,7 @@ type PlaneMeshParameters = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [components/MeshGeometry.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [components/MeshGeometry.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L25)
|
|
17
17
|
|
|
18
18
|
Plane geometry parameters in world units.
|
|
19
19
|
|
|
@@ -21,5 +21,5 @@ Plane geometry parameters in world units.
|
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="width"></a> `width` | `number` | Plane width along X. | [components/MeshGeometry.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="height"></a> `height` | `number` | Plane height along Y. | [components/MeshGeometry.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="width"></a> `width` | `number` | Plane width along X. | [components/MeshGeometry.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L27) |
|
|
25
|
+
| <a id="height"></a> `height` | `number` | Plane height along Y. | [components/MeshGeometry.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/020795472520adb990c488982ca8572cbf8580db/core/components/MeshGeometry.ts#L29) |
|