@relu-interactives/spatial-ecs 0.5.2 → 0.8.0
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-V_mv07le.d.cts → System-8D-XBDKZ.d.cts} +734 -8
- package/dist/{System-V_mv07le.d.ts → System-DPMAW30g.d.ts} +734 -8
- package/dist/{XRHandPose-CU3vNFuS.d.ts → XRHandPose-G0Dl-F0w.d.ts} +93 -3
- package/dist/{XRHandPose-CQTLGxFC.d.cts → XRHandPose-VQMT1WXj.d.cts} +93 -3
- package/dist/animation/index.cjs +252 -0
- package/dist/animation/index.cjs.map +1 -0
- package/dist/animation/index.d.cts +100 -0
- package/dist/animation/index.d.ts +100 -0
- package/dist/animation/index.js +4 -0
- package/dist/animation/index.js.map +1 -0
- package/dist/chunk-CKTHDXPS.js +11 -0
- package/dist/chunk-CKTHDXPS.js.map +1 -0
- package/dist/chunk-G4XJ53LS.js +1237 -0
- package/dist/chunk-G4XJ53LS.js.map +1 -0
- package/dist/chunk-GSWC6LLD.js +241 -0
- package/dist/chunk-GSWC6LLD.js.map +1 -0
- package/dist/{chunk-DF5SSRN6.js → chunk-JIJQFW6P.js} +1216 -2920
- package/dist/chunk-JIJQFW6P.js.map +1 -0
- package/dist/{chunk-BUEKOSR5.js → chunk-NNDUOQ7O.js} +188 -14
- package/dist/chunk-NNDUOQ7O.js.map +1 -0
- package/dist/chunk-OHCNPPMX.js +334 -0
- package/dist/chunk-OHCNPPMX.js.map +1 -0
- package/dist/{chunk-RXBLOO5B.js → chunk-SGF73YTF.js} +105 -715
- package/dist/chunk-SGF73YTF.js.map +1 -0
- package/dist/chunk-U727NTWQ.js +2856 -0
- package/dist/chunk-U727NTWQ.js.map +1 -0
- package/dist/{chunk-OY7ZODZP.js → chunk-XE4OXN2W.js} +3 -9
- package/dist/chunk-XE4OXN2W.js.map +1 -0
- package/dist/{chunk-OWQSESTO.js → chunk-XU2DVWCP.js} +4 -3
- package/dist/chunk-XU2DVWCP.js.map +1 -0
- package/dist/components/index.cjs +183 -10
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +5 -3
- package/dist/components/index.d.ts +5 -3
- package/dist/components/index.js +3 -2
- package/dist/docs/api/Behaviour/classes/Behaviour.md +366 -79
- package/dist/docs/api/Behaviour/index.md +7 -3
- package/dist/docs/api/Behaviour/type-aliases/UiInteractionEvent.md +35 -0
- package/dist/docs/api/Component/classes/Component.md +14 -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 +5 -4
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +8 -8
- 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 +16 -16
- 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 +8 -5
- 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 +7 -6
- package/dist/docs/api/components/classes/Postprocessing.md +3 -3
- package/dist/docs/api/components/classes/PrefabInstance.md +5 -5
- package/dist/docs/api/components/classes/PrefabNode.md +3 -3
- package/dist/docs/api/components/classes/ScriptComponent.md +5 -5
- package/dist/docs/api/components/classes/ScriptObjectComponent.md +9 -9
- 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/UIButtonComponent.md +63 -0
- package/dist/docs/api/components/classes/UIPanelComponent.md +62 -0
- package/dist/docs/api/components/classes/UISliderComponent.md +59 -0
- package/dist/docs/api/components/classes/UITextComponent.md +59 -0
- package/dist/docs/api/components/classes/UIToggleComponent.md +56 -0
- package/dist/docs/api/components/classes/VRTeleportAreaComponent.md +53 -0
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/classes/XRAnchorComponent.md +64 -0
- package/dist/docs/api/components/classes/XREnvironmentComponent.md +64 -0
- package/dist/docs/api/components/classes/XRHandPoseComponent.md +50 -0
- package/dist/docs/api/components/classes/XRInteractableComponent.md +74 -0
- package/dist/docs/api/components/classes/XRInteractorComponent.md +57 -0
- package/dist/docs/api/components/classes/XRInteractorSideComponent.md +50 -0
- package/dist/docs/api/components/classes/XRRigComponent.md +68 -0
- package/dist/docs/api/components/functions/createAttachPoint.md +25 -0
- package/dist/docs/api/components/functions/createHandPoseEntry.md +25 -0
- package/dist/docs/api/components/functions/defaultMaterialValue.md +1 -1
- package/dist/docs/api/components/functions/handPoseDefinitionFor.md +33 -0
- package/dist/docs/api/components/functions/normalizeEnvironmentLighting.md +30 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setModelLoadState.md +33 -0
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +3 -9
- package/dist/docs/api/components/index.md +61 -4
- 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 +5 -3
- 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/EnvironmentLightingState.md +40 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxImageProjection.md +22 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +9 -7
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +7 -5
- package/dist/docs/api/components/type-aliases/EnvironmentToneMapping.md +16 -0
- 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/LightShadowState.md +37 -0
- package/dist/docs/api/components/type-aliases/LightValueState.md +13 -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/ModelLoadState.md +15 -0
- 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 -8
- package/dist/docs/api/components/type-aliases/ScriptObjectComponentInput.md +1 -1
- package/dist/docs/api/components/type-aliases/ScriptObjectRuntimeState.md +1 -1
- 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/UIButtonOptions.md +45 -0
- package/dist/docs/api/components/type-aliases/UIPanelOptions.md +39 -0
- package/dist/docs/api/components/type-aliases/UISliderOptions.md +39 -0
- package/dist/docs/api/components/type-aliases/UITextOptions.md +41 -0
- package/dist/docs/api/components/type-aliases/UIToggleOptions.md +35 -0
- package/dist/docs/api/components/type-aliases/UiFollowMode.md +15 -0
- package/dist/docs/api/components/type-aliases/UiTextAlign.md +13 -0
- package/dist/docs/api/components/type-aliases/UiTextVAlign.md +13 -0
- package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md +29 -0
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/type-aliases/VrTeleportShape.md +15 -0
- package/dist/docs/api/components/type-aliases/XRAnchorOptions.md +23 -0
- package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md +23 -0
- package/dist/docs/api/components/type-aliases/XRInteractableOptions.md +75 -0
- package/dist/docs/api/components/type-aliases/XRInteractorOptions.md +37 -0
- package/dist/docs/api/components/type-aliases/XRRigOptions.md +51 -0
- package/dist/docs/api/components/type-aliases/XrAttachPoint.md +53 -0
- package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md +19 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md +15 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md +15 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md +25 -0
- package/dist/docs/api/components/type-aliases/XrGrabGesture.md +19 -0
- package/dist/docs/api/components/type-aliases/XrGrabHands.md +20 -0
- package/dist/docs/api/components/type-aliases/XrGrabReach.md +20 -0
- package/dist/docs/api/components/type-aliases/XrHandPoseEntry.md +49 -0
- package/dist/docs/api/components/type-aliases/XrHandPreset.md +19 -0
- package/dist/docs/api/components/type-aliases/XrInteractorSide.md +15 -0
- package/dist/docs/api/components/type-aliases/XrInteractorType.md +13 -0
- package/dist/docs/api/components/type-aliases/XrLocomotionMode.md +15 -0
- package/dist/docs/api/components/type-aliases/XrTrackingOrigin.md +24 -0
- package/dist/docs/api/components/type-aliases/XrTwoHandRotation.md +15 -0
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_LIGHTING.md +15 -0
- 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_POSE_CURLS.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_POSE_DIRECTIONS.md +13 -0
- 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/components/variables/MODEL_NO_PATH_MESSAGE.md +15 -0
- 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 +19 -4
- package/dist/docs/api/index/classes/HandPoseTracker.md +114 -0
- 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 +34 -10
- package/dist/docs/api/index/classes/RenderSystem.md +13 -4
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +9 -5
- package/dist/docs/api/index/classes/ScriptObject.md +10 -10
- package/dist/docs/api/index/classes/ScriptObjectSystem.md +6 -6
- package/dist/docs/api/index/classes/TeleportAimGate.md +114 -0
- package/dist/docs/api/index/classes/ThrowVelocityTracker.md +89 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/UIInteractionSystem.md +60 -0
- package/dist/docs/api/index/classes/UIPanelSystem.md +79 -0
- package/dist/docs/api/index/classes/VRTeleportAreaSystem.md +49 -0
- package/dist/docs/api/index/classes/VideoSystem.md +8 -6
- package/dist/docs/api/index/classes/World.md +282 -100
- package/dist/docs/api/index/classes/XRAnchorSystem.md +90 -0
- package/dist/docs/api/index/classes/XRControllerVisualSystem.md +77 -0
- package/dist/docs/api/index/classes/XREnvironmentSystem.md +137 -0
- package/dist/docs/api/index/classes/XRHandPoseSystem.md +107 -0
- package/dist/docs/api/index/classes/XRHitTestSystem.md +93 -0
- package/dist/docs/api/index/classes/XRHoverVisualSystem.md +76 -0
- package/dist/docs/api/index/classes/XRInputSystem.md +189 -0
- package/dist/docs/api/index/classes/XRInteractionSystem.md +323 -0
- package/dist/docs/api/index/classes/XRLocomotionSystem.md +128 -0
- package/dist/docs/api/index/classes/XRSessionSystem.md +116 -0
- package/dist/docs/api/index/classes/XRTeleportVisualSystem.md +75 -0
- package/dist/docs/api/index/functions/angularVelocityFrom.md +33 -0
- package/dist/docs/api/index/functions/applyHandMaterial.md +26 -0
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +1 -1
- package/dist/docs/api/index/functions/arcGroundCrossing.md +30 -0
- package/dist/docs/api/index/functions/buildComponentValueMaps.md +1 -1
- package/dist/docs/api/index/functions/buildNodeKeyMapsFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/buildNodeMapsFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/canonicalizeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/clearModelCache.md +1 -1
- package/dist/docs/api/index/functions/clearPrefabCache.md +1 -1
- package/dist/docs/api/index/functions/cloneHandPose.md +23 -0
- package/dist/docs/api/index/functions/collectDiffPaths.md +1 -1
- package/dist/docs/api/index/functions/collectDirectPrefabDependencies.md +1 -1
- package/dist/docs/api/index/functions/collectEntitySubtree.md +1 -1
- package/dist/docs/api/index/functions/collectSnapshotSubtreeIds.md +1 -1
- package/dist/docs/api/index/functions/computeFingerCurl.md +29 -0
- package/dist/docs/api/index/functions/computeHandShape.md +29 -0
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +1 -1
- package/dist/docs/api/index/functions/computePalmPose.md +30 -0
- package/dist/docs/api/index/functions/computePalmWidth.md +25 -0
- package/dist/docs/api/index/functions/computePinch.md +29 -0
- package/dist/docs/api/index/functions/computeSpread.md +33 -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/createHandMaterial.md +30 -0
- 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 +2 -2
- 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 +2 -2
- package/dist/docs/api/index/functions/createMaterialComponent.md +2 -2
- 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 +1 -1
- 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 +1 -1
- 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/createUIButtonComponent.md +28 -0
- package/dist/docs/api/index/functions/createUIPanelComponent.md +28 -0
- package/dist/docs/api/index/functions/createUISliderComponent.md +28 -0
- package/dist/docs/api/index/functions/createUITextComponent.md +28 -0
- package/dist/docs/api/index/functions/createUIToggleComponent.md +28 -0
- package/dist/docs/api/index/functions/createVRTeleportAreaComponent.md +28 -0
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRAnchorComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRHandPoseComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractableComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractorComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractorSideComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRRigComponent.md +28 -0
- package/dist/docs/api/index/functions/decanonicalizeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/despawnPrefab.md +1 -1
- package/dist/docs/api/index/functions/encodeOverride.md +1 -1
- package/dist/docs/api/index/functions/estimateHandScale.md +28 -0
- package/dist/docs/api/index/functions/findSnapshotRootEntityIds.md +1 -1
- package/dist/docs/api/index/functions/findTopLevelNestedRegions.md +1 -1
- package/dist/docs/api/index/functions/getHandPosePreset.md +31 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +1 -1
- package/dist/docs/api/index/functions/handPoseFromCurls.md +42 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +1 -1
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +1 -1
- package/dist/docs/api/index/functions/indexSnapshotByEntity.md +1 -1
- package/dist/docs/api/index/functions/instantiateSubtree.md +1 -1
- package/dist/docs/api/index/functions/loadPrefab.md +1 -1
- package/dist/docs/api/index/functions/loadSharedGltf.md +1 -1
- package/dist/docs/api/index/functions/matchHandPose.md +34 -0
- package/dist/docs/api/index/functions/mergeComponentValue.md +1 -1
- package/dist/docs/api/index/functions/parseOverride.md +1 -1
- package/dist/docs/api/index/functions/parsePrefabAsset.md +1 -1
- package/dist/docs/api/index/functions/prefabFileVersionFor.md +1 -1
- package/dist/docs/api/index/functions/readXrCapabilities.md +30 -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 +3 -3
- package/dist/docs/api/index/functions/resolveDracoDecoderPath.md +1 -1
- package/dist/docs/api/index/functions/restoreComponentState.md +1 -1
- package/dist/docs/api/index/functions/restorePostCreateComponents.md +1 -1
- package/dist/docs/api/index/functions/sampleTeleportArc.md +40 -0
- package/dist/docs/api/index/functions/serializeEntitySubtree.md +1 -1
- package/dist/docs/api/index/functions/setDracoDecoderPath.md +1 -1
- package/dist/docs/api/index/functions/setPrefabAssetUrlResolver.md +1 -1
- package/dist/docs/api/index/functions/spawnPrefab.md +1 -1
- package/dist/docs/api/index/index.md +116 -4
- package/dist/docs/api/index/interfaces/ChromaKeyOptions.md +20 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md +21 -0
- package/dist/docs/api/index/interfaces/PostprocessingPipeline.md +84 -0
- package/dist/docs/api/index/interfaces/RenderBackend.md +168 -0
- 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 +3 -3
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +50 -26
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +14 -2
- package/dist/docs/api/index/type-aliases/EcsRenderer.md +17 -0
- 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 +5 -5
- package/dist/docs/api/index/type-aliases/HandMaterialOptions.md +32 -0
- package/dist/docs/api/index/type-aliases/HandPoseTrackerOptions.md +27 -0
- package/dist/docs/api/index/type-aliases/HydrateOptions.md +3 -3
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +4 -4
- package/dist/docs/api/index/type-aliases/InstantiateSubtreeResult.md +3 -3
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +1 -1
- package/dist/docs/api/index/type-aliases/ModuleLoader.md +1 -1
- package/dist/docs/api/index/type-aliases/MouseButton.md +1 -1
- package/dist/docs/api/index/type-aliases/NestedRegion.md +5 -5
- package/dist/docs/api/index/type-aliases/NodeKeyMaps.md +5 -5
- package/dist/docs/api/index/type-aliases/NodeMaps.md +4 -4
- package/dist/docs/api/index/type-aliases/PrefabAsset.md +5 -5
- package/dist/docs/api/index/type-aliases/RemapSnapshotOptions.md +2 -2
- package/dist/docs/api/index/type-aliases/RendererKind.md +15 -0
- package/dist/docs/api/index/type-aliases/ScriptBehaviourSystemOptions.md +23 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorEvent.md +39 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorListener.md +25 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorPhase.md +28 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorReport.md +31 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorSource.md +15 -0
- package/dist/docs/api/index/type-aliases/SelectionContext.md +4 -4
- package/dist/docs/api/index/type-aliases/SerializeEntitySubtreeResult.md +4 -4
- package/dist/docs/api/index/type-aliases/SpawnPrefabOptions.md +5 -5
- package/dist/docs/api/index/type-aliases/SpawnPrefabSource.md +1 -1
- package/dist/docs/api/index/type-aliases/SubtreeSnapshot.md +3 -3
- package/dist/docs/api/index/type-aliases/UiCanvasLike.md +46 -0
- package/dist/docs/api/index/type-aliases/VelocitySample.md +23 -0
- package/dist/docs/api/index/type-aliases/XrCapabilities.md +41 -0
- package/dist/docs/api/index/type-aliases/XrFinger.md +13 -0
- package/dist/docs/api/index/type-aliases/XrFingerCurl.md +27 -0
- package/dist/docs/api/index/type-aliases/XrFingerTarget.md +31 -0
- package/dist/docs/api/index/type-aliases/XrHandJointName.md +40 -0
- package/dist/docs/api/index/type-aliases/XrHandJoints.md +18 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseAxis.md +15 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseContext.md +23 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseDefinition.md +47 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseDirection.md +21 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseEvent.md +13 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseEventDetail.md +27 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseMatch.md +25 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseOrientation.md +25 -0
- package/dist/docs/api/index/type-aliases/XrHandShape.md +46 -0
- package/dist/docs/api/index/type-aliases/XrHandedness.md +15 -0
- package/dist/docs/api/index/type-aliases/XrHitResult.md +25 -0
- package/dist/docs/api/index/type-aliases/XrInputKind.md +19 -0
- package/dist/docs/api/index/type-aliases/XrInputState.md +60 -0
- package/dist/docs/api/index/type-aliases/XrPalmPose.md +31 -0
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +2 -2
- package/dist/docs/api/index/variables/ARC_GRAVITY.md +15 -0
- package/dist/docs/api/index/variables/ARC_MAX_TIME.md +15 -0
- package/dist/docs/api/index/variables/ARC_SPEED.md +15 -0
- package/dist/docs/api/index/variables/ARC_STEPS.md +15 -0
- package/dist/docs/api/index/variables/CURLED_COS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_DIRECTION_TOLERANCE.md +15 -0
- package/dist/docs/api/index/variables/DEFAULT_ENTER_CONFIDENCE.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_EXIT_CONFIDENCE.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_LOST_GRACE_SECONDS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_MIN_HOLD_SECONDS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md +17 -0
- package/dist/docs/api/index/variables/FALLBACK_HAND_SCALE.md +15 -0
- package/dist/docs/api/index/variables/HAND_POSE_PRESETS.md +19 -0
- package/dist/docs/api/index/variables/HAND_POSE_PRESET_IDS.md +15 -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/MATCH_FALLOFF.md +15 -0
- package/dist/docs/api/index/variables/MAX_PLAUSIBLE_SPEED.md +25 -0
- package/dist/docs/api/index/variables/MAX_SAMPLE_AGE_SECONDS.md +18 -0
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +1 -1
- package/dist/docs/api/index/variables/NO_XR_CAPABILITIES.md +15 -0
- package/dist/docs/api/index/variables/OVERRIDE_DIFF_EXCLUDED_COMPONENTS.md +1 -1
- package/dist/docs/api/index/variables/OVERRIDE_ROOT_EXCLUDED_COMPONENTS.md +1 -1
- package/dist/docs/api/index/variables/PINCH_FINGERS.md +15 -0
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION.md +1 -1
- package/dist/docs/api/index/variables/PREFAB_FILE_VERSION_NESTED.md +1 -1
- package/dist/docs/api/index/variables/SCRIPT_OBJECT_ROOT_FLAG.md +1 -1
- package/dist/docs/api/index/variables/SHARED_MODEL_RESOURCE_FLAG.md +1 -1
- package/dist/docs/api/index/variables/STRAIGHT_COS.md +19 -0
- package/dist/docs/api/index/variables/VELOCITY_SAMPLES.md +15 -0
- package/dist/docs/api/index/variables/XR_FINGERS.md +13 -0
- package/dist/docs/api/index/variables/XR_HOVER_SHELL_FLAG.md +15 -0
- package/dist/docs/api/index/variables/webglBackend.md +16 -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 +1 -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 +10 -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/audio-mixing-and-sound-banks.md +71 -0
- package/dist/docs/guide/authoring-a-behaviour.md +3 -3
- package/dist/docs/guide/authoring-a-script-object.md +12 -9
- package/dist/docs/guide/behaviour-data-binding/index.md +11 -11
- package/dist/docs/guide/behaviour-lifecycle.md +9 -0
- package/dist/docs/guide/bone-attachments-and-ik.md +128 -0
- package/dist/docs/guide/component-catalog.md +10 -2
- package/dist/docs/guide/components/light.md +42 -0
- package/dist/docs/guide/components/model.md +32 -3
- package/dist/docs/guide/concepts.md +2 -2
- package/dist/docs/guide/getting-started/creating-objects.md +2 -2
- package/dist/docs/guide/getting-started/editing-objects.md +2 -2
- package/dist/docs/guide/getting-started/editor/ai-agent.md +227 -0
- package/dist/docs/guide/getting-started/editor/hierarchy.md +2 -2
- package/dist/docs/guide/getting-started/editor/index.md +3 -2
- package/dist/docs/guide/getting-started/editor/inspector.md +2 -2
- package/dist/docs/guide/getting-started/editor/scene-inspector.md +3 -3
- package/dist/docs/guide/getting-started/editor/toolbar.md +11 -11
- package/dist/docs/guide/getting-started/editor/viewport.md +17 -9
- package/dist/docs/guide/getting-started/index.md +1 -1
- package/dist/docs/guide/getting-started/installation.md +1 -1
- package/dist/docs/guide/getting-started/preview-and-test.md +7 -7
- package/dist/docs/guide/getting-started/project-types/image-tracking.md +23 -11
- package/dist/docs/guide/getting-started/project-types/index.md +4 -4
- package/dist/docs/guide/getting-started/project-types/vr.md +270 -2
- package/dist/docs/guide/getting-started/projects.md +4 -5
- package/dist/docs/guide/getting-started/shortcuts.md +5 -4
- package/dist/docs/guide/multiplayer.md +92 -0
- package/dist/docs/guide/scene/environment.md +101 -4
- package/dist/docs/guide/scene/index.md +4 -4
- package/dist/docs/guide/scene/postprocessing.md +67 -5
- package/dist/docs/guide/spawning/area-light.md +2 -0
- package/dist/docs/guide/systems/environment-sync-system.md +11 -6
- package/dist/docs/guide/systems/light-sync-system.md +5 -3
- package/dist/docs/guide/systems/postprocessing-sync-system.md +16 -6
- package/dist/docs/guide/systems/render-system.md +7 -6
- package/dist/docs/guide/systems/script-behaviour-system.md +7 -5
- package/dist/docs/guide/systems/script-object-system.md +3 -1
- package/dist/docs/guide/systems/video-system.md +1 -1
- package/dist/docs/guide/webgpu-and-tsl.md +415 -0
- package/dist/docs/guide/world-api.md +52 -2
- package/dist/factories/index.cjs +770 -283
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +14 -3
- package/dist/factories/index.d.ts +14 -3
- package/dist/factories/index.js +7 -4
- package/dist/{index-D2Jt_JzH.d.ts → index-C61n65PE.d.ts} +135 -42
- package/dist/{index-DaG03vyN.d.cts → index-C70N4BYG.d.cts} +135 -42
- package/dist/{index-C3ik3sA1.d.ts → index-D9DjrUn3.d.cts} +25 -3
- package/dist/{index-Dlr-7-4m.d.cts → index-DppafVu4.d.ts} +25 -3
- package/dist/index.cjs +3642 -1263
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +113 -11
- package/dist/index.d.ts +113 -11
- package/dist/index.js +187 -12
- package/dist/index.js.map +1 -1
- package/dist/network/index.cjs +4896 -0
- package/dist/network/index.cjs.map +1 -0
- package/dist/network/index.d.cts +98 -0
- package/dist/network/index.d.ts +98 -0
- package/dist/network/index.js +493 -0
- package/dist/network/index.js.map +1 -0
- package/dist/systems/index.cjs +3958 -1762
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +4 -2
- package/dist/systems/index.d.ts +4 -2
- package/dist/systems/index.js +8 -4
- package/dist/types.d.cts +3 -1
- package/dist/types.d.ts +3 -1
- package/dist/webgpu/index.d.ts +113 -0
- package/dist/webgpu/index.js +302 -0
- package/dist/webgpu/index.js.map +1 -0
- package/dist/worldSnapshotUtils.d.cts +3 -1
- package/dist/worldSnapshotUtils.d.ts +3 -1
- package/dist/worldSnapshotUtils.js +3 -2
- package/package.json +19 -3
- package/dist/chunk-BUEKOSR5.js.map +0 -1
- package/dist/chunk-DF5SSRN6.js.map +0 -1
- package/dist/chunk-OWQSESTO.js.map +0 -1
- package/dist/chunk-OY7ZODZP.js.map +0 -1
- package/dist/chunk-RXBLOO5B.js.map +0 -1
- package/dist/chunk-WJD2VKEH.js +0 -315
- package/dist/chunk-WJD2VKEH.js.map +0 -1
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentLightingState
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentLightingState
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentLightingState = {
|
|
11
|
+
envMapUrl?: string;
|
|
12
|
+
envIntensity?: number;
|
|
13
|
+
envRotationY?: number;
|
|
14
|
+
useAsBackground?: boolean;
|
|
15
|
+
backgroundBlurriness?: number;
|
|
16
|
+
backgroundIntensity?: number;
|
|
17
|
+
toneMapping?: EnvironmentToneMapping;
|
|
18
|
+
exposure?: number;
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Defined in: [components/Environment.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L84)
|
|
23
|
+
|
|
24
|
+
Image-based lighting and renderer colour settings. Every field is optional;
|
|
25
|
+
the defaults below apply when a field is missing. When the whole block is
|
|
26
|
+
absent the scene's environment map and the renderer's tone mapping are left
|
|
27
|
+
untouched.
|
|
28
|
+
|
|
29
|
+
## Properties
|
|
30
|
+
|
|
31
|
+
| Property | Type | Description | Defined in |
|
|
32
|
+
| ------ | ------ | ------ | ------ |
|
|
33
|
+
| <a id="envmapurl"></a> `envMapUrl?` | `string` | URL or `localasset://` path of an equirectangular environment map used for image-based lighting (reflections and ambient light on PBR materials). `.hdr` and `.exr` load as HDR; any other extension loads as an sRGB image. Empty = no environment map. | [components/Environment.ts:91](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L91) |
|
|
34
|
+
| <a id="envintensity"></a> `envIntensity?` | `number` | Strength of the environment lighting (`scene.environmentIntensity`). Default `1`. | [components/Environment.ts:93](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L93) |
|
|
35
|
+
| <a id="envrotationy"></a> `envRotationY?` | `number` | Rotation of the environment map around world Y, in radians. Default `0`. | [components/Environment.ts:95](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L95) |
|
|
36
|
+
| <a id="useasbackground"></a> `useAsBackground?` | `boolean` | Also show the environment map as the background. Overrides the skybox. Default `false`. | [components/Environment.ts:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L97) |
|
|
37
|
+
| <a id="backgroundblurriness"></a> `backgroundBlurriness?` | `number` | Background blur in `[0, 1]` when [useAsBackground](#useasbackground) is on. Default `0`. | [components/Environment.ts:99](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L99) |
|
|
38
|
+
| <a id="backgroundintensity"></a> `backgroundIntensity?` | `number` | Background brightness multiplier when [useAsBackground](#useasbackground) is on. Default `1`. | [components/Environment.ts:101](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L101) |
|
|
39
|
+
| <a id="tonemapping"></a> `toneMapping?` | [`EnvironmentToneMapping`](EnvironmentToneMapping.md) | Renderer tone-mapping operator. Default `"none"`. | [components/Environment.ts:103](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L103) |
|
|
40
|
+
| <a id="exposure"></a> `exposure?` | `number` | Renderer exposure (`toneMappingExposure`). Only has an effect when tone mapping is on. Default `1`. | [components/Environment.ts:105](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L105) |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentSkyboxImageProjection
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentSkyboxImageProjection
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentSkyboxImageProjection = "screen" | "equirect";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Environment.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L19)
|
|
14
|
+
|
|
15
|
+
How an `"image"` skybox is projected.
|
|
16
|
+
|
|
17
|
+
- `"screen"` (the behaviour when the field is absent): the image is drawn as
|
|
18
|
+
a flat backdrop stretched over the viewport. It does not rotate with the
|
|
19
|
+
camera.
|
|
20
|
+
- `"equirect"`: the image is an equirectangular panorama wrapped around the
|
|
21
|
+
scene, so it turns with the camera like a real sky. `.hdr` and `.exr`
|
|
22
|
+
files load in this mode.
|
|
@@ -11,6 +11,7 @@ type EnvironmentSkyboxState = {
|
|
|
11
11
|
type: EnvironmentSkyboxType;
|
|
12
12
|
color: string;
|
|
13
13
|
imageUrl?: string;
|
|
14
|
+
imageProjection?: EnvironmentSkyboxImageProjection;
|
|
14
15
|
gradient: {
|
|
15
16
|
colors: string[];
|
|
16
17
|
effect: EnvironmentGradientEffect;
|
|
@@ -18,7 +19,7 @@ type EnvironmentSkyboxState = {
|
|
|
18
19
|
};
|
|
19
20
|
```
|
|
20
21
|
|
|
21
|
-
Defined in: [components/Environment.ts:
|
|
22
|
+
Defined in: [components/Environment.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L27)
|
|
22
23
|
|
|
23
24
|
Skybox configuration. Only the fields relevant to [type](#type) are read at render time.
|
|
24
25
|
|
|
@@ -26,9 +27,10 @@ Skybox configuration. Only the fields relevant to [type](#type) are read at rend
|
|
|
26
27
|
|
|
27
28
|
| Property | Type | Description | Defined in |
|
|
28
29
|
| ------ | ------ | ------ | ------ |
|
|
29
|
-
| <a id="type"></a> `type` | [`EnvironmentSkyboxType`](EnvironmentSkyboxType.md) | Active skybox mode. | [components/Environment.ts:
|
|
30
|
-
| <a id="color"></a> `color` | `string` | Solid color used when [type](#type) is `"color"`. `#rrggbb`. | [components/Environment.ts:
|
|
31
|
-
| <a id="imageurl"></a> `imageUrl?` | `string` | URL or `localasset://` path of the
|
|
32
|
-
| <a id="
|
|
33
|
-
| `gradient
|
|
34
|
-
| `gradient.
|
|
30
|
+
| <a id="type"></a> `type` | [`EnvironmentSkyboxType`](EnvironmentSkyboxType.md) | Active skybox mode. | [components/Environment.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L29) |
|
|
31
|
+
| <a id="color"></a> `color` | `string` | Solid color used when [type](#type) is `"color"`. `#rrggbb`. | [components/Environment.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L31) |
|
|
32
|
+
| <a id="imageurl"></a> `imageUrl?` | `string` | URL or `localasset://` path of the image used when [type](#type) is `"image"`. | [components/Environment.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L33) |
|
|
33
|
+
| <a id="imageprojection"></a> `imageProjection?` | [`EnvironmentSkyboxImageProjection`](EnvironmentSkyboxImageProjection.md) | Projection for an `"image"` skybox. Absent means `"screen"` (a flat backdrop, the original behaviour). Set `"equirect"` for a 360° panorama. | [components/Environment.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L38) |
|
|
34
|
+
| <a id="gradient"></a> `gradient` | \{ `colors`: `string`[]; `effect`: [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md); \} | Gradient parameters used when [type](#type) is `"gradient"`. | [components/Environment.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L40) |
|
|
35
|
+
| `gradient.colors` | `string`[] | Ordered list of color stops as `#rrggbb` strings. | [components/Environment.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L42) |
|
|
36
|
+
| `gradient.effect` | [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md) | Gradient distribution. | [components/Environment.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L44) |
|
|
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L4)
|
|
14
14
|
|
|
15
15
|
Skybox rendering modes. `none` disables skybox rendering entirely.
|
|
@@ -12,10 +12,11 @@ type EnvironmentState = {
|
|
|
12
12
|
fog: EnvironmentFogState;
|
|
13
13
|
gravity: EnvironmentGravityState;
|
|
14
14
|
fixedTimeStep: number;
|
|
15
|
+
lighting?: EnvironmentLightingState;
|
|
15
16
|
};
|
|
16
17
|
```
|
|
17
18
|
|
|
18
|
-
Defined in: [components/Environment.ts:
|
|
19
|
+
Defined in: [components/Environment.ts:121](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L121)
|
|
19
20
|
|
|
20
21
|
Aggregated authoring state owned by [Environment](../classes/Environment.md).
|
|
21
22
|
|
|
@@ -23,7 +24,8 @@ Aggregated authoring state owned by [Environment](../classes/Environment.md).
|
|
|
23
24
|
|
|
24
25
|
| Property | Type | Description | Defined in |
|
|
25
26
|
| ------ | ------ | ------ | ------ |
|
|
26
|
-
| <a id="skybox"></a> `skybox` | [`EnvironmentSkyboxState`](EnvironmentSkyboxState.md) | Skybox configuration. | [components/Environment.ts:
|
|
27
|
-
| <a id="fog"></a> `fog` | [`EnvironmentFogState`](EnvironmentFogState.md) | Fog configuration. | [components/Environment.ts:
|
|
28
|
-
| <a id="gravity"></a> `gravity` | `EnvironmentGravityState` | World gravity. | [components/Environment.ts:
|
|
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:
|
|
27
|
+
| <a id="skybox"></a> `skybox` | [`EnvironmentSkyboxState`](EnvironmentSkyboxState.md) | Skybox configuration. | [components/Environment.ts:123](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L123) |
|
|
28
|
+
| <a id="fog"></a> `fog` | [`EnvironmentFogState`](EnvironmentFogState.md) | Fog configuration. | [components/Environment.ts:125](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L125) |
|
|
29
|
+
| <a id="gravity"></a> `gravity` | `EnvironmentGravityState` | World gravity. | [components/Environment.ts:127](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L127) |
|
|
30
|
+
| <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:133](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L133) |
|
|
31
|
+
| <a id="lighting"></a> `lighting?` | [`EnvironmentLightingState`](EnvironmentLightingState.md) | Image-based lighting, tone mapping and exposure. Optional: absent means the scene's environment map and the renderer's tone mapping stay untouched, which is how every scene saved before 0.5.4 renders. | [components/Environment.ts:139](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L139) |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / EnvironmentToneMapping
|
|
6
|
+
|
|
7
|
+
# Type Alias: EnvironmentToneMapping
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type EnvironmentToneMapping = "none" | "aces" | "agx" | "neutral";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Environment.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L24)
|
|
14
|
+
|
|
15
|
+
Tone-mapping operator applied by the renderer. `"none"` leaves colours
|
|
16
|
+
linear-clamped (three's `NoToneMapping`).
|
|
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L18) |
|
|
39
|
+
| `position.x` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L18) |
|
|
40
|
+
| `position.y` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L18) |
|
|
41
|
+
| `position.z` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L20) |
|
|
43
|
+
| `rotation.x` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L20) |
|
|
44
|
+
| `rotation.y` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L20) |
|
|
45
|
+
| `rotation.z` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L21) |
|
|
47
|
+
| `scale.x` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L21) |
|
|
48
|
+
| `scale.y` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L21) |
|
|
49
|
+
| `scale.z` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L25)
|
|
14
14
|
|
|
15
15
|
Primitive geometry kinds and custom 3D model kind supported by instanced mesh rendering.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / LightShadowState
|
|
6
|
+
|
|
7
|
+
# Type Alias: LightShadowState
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type LightShadowState = {
|
|
11
|
+
mapSize?: number;
|
|
12
|
+
bias?: number;
|
|
13
|
+
normalBias?: number;
|
|
14
|
+
radius?: number;
|
|
15
|
+
cameraSize?: number;
|
|
16
|
+
near?: number;
|
|
17
|
+
far?: number;
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [components/Light.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L10)
|
|
22
|
+
|
|
23
|
+
Optional shadow tuning for a shadow-casting light (directional, spot,
|
|
24
|
+
point). Only the fields present are applied; a missing field keeps three's
|
|
25
|
+
default, and a light without a `shadow` block is never touched.
|
|
26
|
+
|
|
27
|
+
## Properties
|
|
28
|
+
|
|
29
|
+
| Property | Type | Description | Defined in |
|
|
30
|
+
| ------ | ------ | ------ | ------ |
|
|
31
|
+
| <a id="mapsize"></a> `mapSize?` | `number` | Shadow map resolution in texels (square). three's default is `512`. Clamped to `[16, 8192]`. | [components/Light.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L12) |
|
|
32
|
+
| <a id="bias"></a> `bias?` | `number` | Depth bias to fight shadow acne. Small negatives such as `-0.0005` are typical. | [components/Light.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L14) |
|
|
33
|
+
| <a id="normalbias"></a> `normalBias?` | `number` | Bias along the surface normal; `0.02`-`0.05` removes acne on large flat surfaces. | [components/Light.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L16) |
|
|
34
|
+
| <a id="radius"></a> `radius?` | `number` | Blur radius of the shadow edge (PCF shadow maps). | [components/Light.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L18) |
|
|
35
|
+
| <a id="camerasize"></a> `cameraSize?` | `number` | Half-extent, in world units, of a DIRECTIONAL light's orthographic shadow camera (`left = bottom = -cameraSize`, `right = top = cameraSize`). three's default is `5`, which only covers a 10 m square. Ignored for spot and point lights. | [components/Light.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L25) |
|
|
36
|
+
| <a id="near"></a> `near?` | `number` | Near plane of the shadow camera. | [components/Light.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L27) |
|
|
37
|
+
| <a id="far"></a> `far?` | `number` | Far plane of the shadow camera. Spot lights with a `distance` use that instead. | [components/Light.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L29) |
|
|
@@ -18,10 +18,11 @@ type LightValueState = {
|
|
|
18
18
|
penumbra?: number;
|
|
19
19
|
width?: number;
|
|
20
20
|
height?: number;
|
|
21
|
+
shadow?: LightShadowState;
|
|
21
22
|
};
|
|
22
23
|
```
|
|
23
24
|
|
|
24
|
-
Defined in: [components/Light.ts:
|
|
25
|
+
Defined in: [components/Light.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L33)
|
|
25
26
|
|
|
26
27
|
Authoring state for [LightComponent](../classes/LightComponent.md). Common fields apply to every light kind; the optional fields are only meaningful for specific kinds.
|
|
27
28
|
|
|
@@ -29,13 +30,14 @@ Authoring state for [LightComponent](../classes/LightComponent.md). Common field
|
|
|
29
30
|
|
|
30
31
|
| Property | Type | Description | Defined in |
|
|
31
32
|
| ------ | ------ | ------ | ------ |
|
|
32
|
-
| <a id="color"></a> `color` | `string` | Light color as `#rrggbb` hex string. | [components/Light.ts:
|
|
33
|
-
| <a id="intensity"></a> `intensity` | `number` | Light intensity multiplier (units depend on three.js physically-correct mode). | [components/Light.ts:
|
|
34
|
-
| <a id="castshadow"></a> `castShadow` | `boolean` | Whether the light casts shadows. | [components/Light.ts:
|
|
35
|
-
| <a id="frustumculling"></a> `frustumCulling` | `boolean` | Whether the light is frustum-culled when off-screen. | [components/Light.ts:
|
|
36
|
-
| <a id="distance"></a> `distance?` | `number` | Maximum range; `0` means infinite. (PointLight, SpotLight) | [components/Light.ts:
|
|
37
|
-
| <a id="decay"></a> `decay?` | `number` | Falloff exponent for distance attenuation. (PointLight, SpotLight) | [components/Light.ts:
|
|
38
|
-
| <a id="angle"></a> `angle?` | `number` | Cone half-angle in **radians**. (SpotLight) | [components/Light.ts:
|
|
39
|
-
| <a id="penumbra"></a> `penumbra?` | `number` | Soft-edge factor in `[0, 1]`; `0` is a hard edge. (SpotLight) | [components/Light.ts:
|
|
40
|
-
| <a id="width"></a> `width?` | `number` | Rectangle width in world units. (RectAreaLight) | [components/Light.ts:
|
|
41
|
-
| <a id="height"></a> `height?` | `number` | Rectangle height in world units. (RectAreaLight) | [components/Light.ts:
|
|
33
|
+
| <a id="color"></a> `color` | `string` | Light color as `#rrggbb` hex string. | [components/Light.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L35) |
|
|
34
|
+
| <a id="intensity"></a> `intensity` | `number` | Light intensity multiplier (units depend on three.js physically-correct mode). | [components/Light.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L37) |
|
|
35
|
+
| <a id="castshadow"></a> `castShadow` | `boolean` | Whether the light casts shadows. | [components/Light.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L39) |
|
|
36
|
+
| <a id="frustumculling"></a> `frustumCulling` | `boolean` | Whether the light is frustum-culled when off-screen. | [components/Light.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L41) |
|
|
37
|
+
| <a id="distance"></a> `distance?` | `number` | Maximum range; `0` means infinite. (PointLight, SpotLight) | [components/Light.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L43) |
|
|
38
|
+
| <a id="decay"></a> `decay?` | `number` | Falloff exponent for distance attenuation. (PointLight, SpotLight) | [components/Light.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L45) |
|
|
39
|
+
| <a id="angle"></a> `angle?` | `number` | Cone half-angle in **radians**. (SpotLight) | [components/Light.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L47) |
|
|
40
|
+
| <a id="penumbra"></a> `penumbra?` | `number` | Soft-edge factor in `[0, 1]`; `0` is a hard edge. (SpotLight) | [components/Light.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L49) |
|
|
41
|
+
| <a id="width"></a> `width?` | `number` | Rectangle width in world units. (RectAreaLight) | [components/Light.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L51) |
|
|
42
|
+
| <a id="height"></a> `height?` | `number` | Rectangle height in world units. (RectAreaLight) | [components/Light.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L53) |
|
|
43
|
+
| <a id="shadow"></a> `shadow?` | [`LightShadowState`](LightShadowState.md) | Optional shadow tuning. Absent = three's shadow defaults. (DirectionalLight, SpotLight, PointLight) | [components/Light.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Light.ts#L55) |
|
|
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/MeshGeometry.ts#L56) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / ModelLoadState
|
|
6
|
+
|
|
7
|
+
# Type Alias: ModelLoadState
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ModelLoadState = "loading" | "loaded" | "error";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Model.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Model.ts#L6)
|
|
14
|
+
|
|
15
|
+
Load progress of a [ModelComponent](../classes/ModelComponent.md)'s asset.
|
|
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/MeshGeometry.ts#L29) |
|