@relu-interactives/spatial-ecs 0.10.0 → 0.11.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-BldSHxZV.d.cts → System-D8vm-Jvv.d.cts} +110 -3
- package/dist/{System-CADhPyQs.d.ts → System-ttkDQCrj.d.ts} +110 -3
- package/dist/{XRHandPose-D3Ab1Dfs.d.cts → XRHandPose-C97XVW2R.d.cts} +2 -41
- package/dist/{XRHandPose-BNSwd1y9.d.ts → XRHandPose-CxXtWF1y.d.ts} +2 -41
- package/dist/animation/index.cjs +33 -1
- package/dist/animation/index.cjs.map +1 -1
- package/dist/animation/index.js +1 -1
- package/dist/{chunk-TY3XCHOR.js → chunk-2DJBNWBB.js} +56 -15
- package/dist/chunk-2DJBNWBB.js.map +1 -0
- package/dist/{chunk-WWP46AEF.js → chunk-4FHJA6U4.js} +8 -4
- package/dist/chunk-4FHJA6U4.js.map +1 -0
- package/dist/{chunk-GSWC6LLD.js → chunk-GMSFEXUZ.js} +35 -3
- package/dist/chunk-GMSFEXUZ.js.map +1 -0
- package/dist/{chunk-JEPUCLZX.js → chunk-QAZCVCMP.js} +88 -27
- package/dist/chunk-QAZCVCMP.js.map +1 -0
- package/dist/{chunk-NXASMBDS.js → chunk-SM5KGNYX.js} +4 -4
- package/dist/{chunk-NXASMBDS.js.map → chunk-SM5KGNYX.js.map} +1 -1
- package/dist/{chunk-JNYPJB55.js → chunk-T7SRBLPJ.js} +24 -4
- package/dist/chunk-T7SRBLPJ.js.map +1 -0
- package/dist/components/index.cjs +21 -1
- 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 +187 -46
- package/dist/docs/api/Behaviour/type-aliases/UiInteractionEvent.md +5 -5
- package/dist/docs/api/Component/classes/Component.md +7 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +20 -19
- package/dist/docs/api/components/classes/BoneAttachmentComponent.md +65 -0
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +3 -3
- package/dist/docs/api/components/classes/Environment.md +3 -3
- package/dist/docs/api/components/classes/IKComponent.md +59 -0
- 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 +14 -14
- 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 +6 -6
- package/dist/docs/api/components/classes/Name.md +3 -3
- package/dist/docs/api/components/classes/NetworkIdentityComponent.md +42 -0
- package/dist/docs/api/components/classes/NetworkSpawnerComponent.md +48 -0
- package/dist/docs/api/components/classes/NetworkTransformComponent.md +51 -0
- package/dist/docs/api/components/classes/NetworkedPropsComponent.md +47 -0
- 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 -7
- 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 +18 -14
- package/dist/docs/api/components/classes/UIPanelComponent.md +13 -11
- package/dist/docs/api/components/classes/UISliderComponent.md +16 -11
- package/dist/docs/api/components/classes/UITextComponent.md +14 -12
- package/dist/docs/api/components/classes/UIToggleComponent.md +12 -9
- package/dist/docs/api/components/classes/VRTeleportAreaComponent.md +6 -6
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/classes/XRAnchorComponent.md +3 -3
- package/dist/docs/api/components/classes/XREnvironmentComponent.md +5 -5
- package/dist/docs/api/components/classes/XRHandPoseComponent.md +4 -4
- package/dist/docs/api/components/classes/XRInteractableComponent.md +28 -28
- package/dist/docs/api/components/classes/XRInteractorComponent.md +10 -10
- package/dist/docs/api/components/classes/XRInteractorSideComponent.md +3 -3
- package/dist/docs/api/components/classes/XRRigComponent.md +17 -17
- package/dist/docs/api/components/functions/createAttachPoint.md +1 -1
- package/dist/docs/api/components/functions/createHandPoseEntry.md +1 -1
- package/dist/docs/api/components/functions/defaultMaterialValue.md +1 -1
- package/dist/docs/api/components/functions/handPoseDefinitionFor.md +1 -1
- package/dist/docs/api/components/functions/normalizeBoneHold.md +25 -0
- package/dist/docs/api/components/functions/normalizeEnvironmentLighting.md +1 -1
- package/dist/docs/api/components/functions/normalizeIKChain.md +25 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setModelLoadState.md +1 -1
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +1 -1
- package/dist/docs/api/components/index.md +18 -0
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/BoneAttachmentOptions.md +35 -0
- package/dist/docs/api/components/type-aliases/BoneHold.md +34 -0
- 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/EnvironmentLightingState.md +9 -9
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxImageProjection.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +8 -8
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +6 -6
- package/dist/docs/api/components/type-aliases/EnvironmentToneMapping.md +1 -1
- package/dist/docs/api/components/type-aliases/IKChain.md +37 -0
- package/dist/docs/api/components/type-aliases/IKLimb.md +15 -0
- package/dist/docs/api/components/type-aliases/IKOptions.md +27 -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 +8 -8
- package/dist/docs/api/components/type-aliases/LightValueState.md +12 -12
- 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 +1 -1
- package/dist/docs/api/components/type-aliases/NetValue.md +23 -0
- package/dist/docs/api/components/type-aliases/NetworkTransformOptions.md +18 -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 +21 -13
- package/dist/docs/api/components/type-aliases/UIPanelOptions.md +14 -10
- package/dist/docs/api/components/type-aliases/UISliderOptions.md +20 -10
- package/dist/docs/api/components/type-aliases/UITextOptions.md +15 -11
- package/dist/docs/api/components/type-aliases/UIToggleOptions.md +14 -8
- package/dist/docs/api/components/type-aliases/UiFollowMode.md +1 -1
- package/dist/docs/api/components/type-aliases/UiIconPosition.md +13 -0
- package/dist/docs/api/components/type-aliases/UiSliderVariant.md +13 -0
- package/dist/docs/api/components/type-aliases/UiTextAlign.md +1 -1
- package/dist/docs/api/components/type-aliases/UiTextVAlign.md +1 -1
- package/dist/docs/api/components/type-aliases/UiToggleVariant.md +13 -0
- package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md +5 -5
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/type-aliases/VrTeleportShape.md +1 -1
- package/dist/docs/api/components/type-aliases/XRAnchorOptions.md +2 -2
- package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md +3 -3
- package/dist/docs/api/components/type-aliases/XRInteractableOptions.md +27 -27
- package/dist/docs/api/components/type-aliases/XRInteractorOptions.md +9 -9
- package/dist/docs/api/components/type-aliases/XRRigOptions.md +16 -16
- package/dist/docs/api/components/type-aliases/XrAttachPoint.md +13 -13
- package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md +1 -1
- package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabGesture.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabHands.md +1 -1
- package/dist/docs/api/components/type-aliases/XrGrabReach.md +1 -1
- package/dist/docs/api/components/type-aliases/XrHandPoseEntry.md +12 -12
- package/dist/docs/api/components/type-aliases/XrHandPreset.md +1 -1
- package/dist/docs/api/components/type-aliases/XrInteractorSide.md +1 -1
- package/dist/docs/api/components/type-aliases/XrInteractorType.md +1 -1
- package/dist/docs/api/components/type-aliases/XrLocomotionMode.md +1 -1
- package/dist/docs/api/components/type-aliases/XrTrackingOrigin.md +1 -1
- package/dist/docs/api/components/type-aliases/XrTwoHandRotation.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_LIGHTING.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_POSE_CURLS.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_POSE_DIRECTIONS.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/components/variables/MODEL_NO_PATH_MESSAGE.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/AudioMixer.md +161 -0
- package/dist/docs/api/index/classes/AudioSystem.md +138 -4
- package/dist/docs/api/index/classes/BoneHoldSystem.md +54 -0
- 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/HandPoseTracker.md +6 -6
- package/dist/docs/api/index/classes/IKSystem.md +98 -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 +269 -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 +4 -4
- 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/SlotChooser.md +59 -0
- package/dist/docs/api/index/classes/TeleportAimGate.md +4 -4
- package/dist/docs/api/index/classes/ThrowVelocityTracker.md +4 -4
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/UIInteractionSystem.md +3 -3
- package/dist/docs/api/index/classes/UIPanelSystem.md +4 -4
- package/dist/docs/api/index/classes/VRTeleportAreaSystem.md +2 -2
- package/dist/docs/api/index/classes/VideoSystem.md +4 -4
- package/dist/docs/api/index/classes/World.md +168 -98
- package/dist/docs/api/index/classes/XRAnchorSystem.md +4 -4
- package/dist/docs/api/index/classes/XRControllerVisualSystem.md +4 -4
- package/dist/docs/api/index/classes/XREnvironmentSystem.md +7 -7
- package/dist/docs/api/index/classes/XRHandPoseSystem.md +5 -5
- package/dist/docs/api/index/classes/XRHitTestSystem.md +4 -4
- package/dist/docs/api/index/classes/XRHoverVisualSystem.md +4 -4
- package/dist/docs/api/index/classes/XRInputSystem.md +9 -9
- package/dist/docs/api/index/classes/XRInteractionSystem.md +18 -18
- package/dist/docs/api/index/classes/XRLocomotionSystem.md +7 -7
- package/dist/docs/api/index/classes/XRSessionSystem.md +6 -6
- package/dist/docs/api/index/classes/XRTeleportVisualSystem.md +4 -4
- package/dist/docs/api/index/functions/angularVelocityFrom.md +1 -1
- package/dist/docs/api/index/functions/applyHandMaterial.md +1 -1
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +1 -1
- package/dist/docs/api/index/functions/arcGroundCrossing.md +1 -1
- 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 +1 -1
- 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 +1 -1
- package/dist/docs/api/index/functions/computeHandShape.md +1 -1
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +1 -1
- package/dist/docs/api/index/functions/computePalmPose.md +1 -1
- package/dist/docs/api/index/functions/computePalmWidth.md +1 -1
- package/dist/docs/api/index/functions/computePinch.md +1 -1
- package/dist/docs/api/index/functions/computeSpread.md +1 -1
- 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/createBoneAttachmentComponent.md +28 -0
- package/dist/docs/api/index/functions/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +1 -1
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createGLTFLoader.md +30 -0
- package/dist/docs/api/index/functions/createHandMaterial.md +1 -1
- package/dist/docs/api/index/functions/createIKComponent.md +28 -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 +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/createNetworkIdentityComponent.md +24 -0
- package/dist/docs/api/index/functions/createNetworkSpawnerComponent.md +28 -0
- package/dist/docs/api/index/functions/createNetworkTransformComponent.md +28 -0
- package/dist/docs/api/index/functions/createNetworkedPropsComponent.md +28 -0
- 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 +1 -1
- package/dist/docs/api/index/functions/createUIPanelComponent.md +1 -1
- package/dist/docs/api/index/functions/createUISliderComponent.md +1 -1
- package/dist/docs/api/index/functions/createUITextComponent.md +1 -1
- package/dist/docs/api/index/functions/createUIToggleComponent.md +1 -1
- package/dist/docs/api/index/functions/createVRTeleportAreaComponent.md +1 -1
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRAnchorComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRHandPoseComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractableComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractorComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRInteractorSideComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRRigComponent.md +1 -1
- 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 +1 -1
- package/dist/docs/api/index/functions/findModelBone.md +30 -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 +1 -1
- package/dist/docs/api/index/functions/gripQuaternion.md +36 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +1 -1
- package/dist/docs/api/index/functions/handPoseFromCurls.md +1 -1
- 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/listModelBones.md +25 -0
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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/setWorldQuaternion.md +26 -0
- package/dist/docs/api/index/functions/soundBankFiles.md +25 -0
- package/dist/docs/api/index/functions/spawnPrefab.md +1 -1
- package/dist/docs/api/index/functions/twoBoneIK.md +41 -0
- package/dist/docs/api/index/index.md +31 -0
- package/dist/docs/api/index/interfaces/ChromaKeyOptions.md +5 -5
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/NetworkHandle.md +180 -0
- package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md +6 -6
- package/dist/docs/api/index/interfaces/PostprocessingPipeline.md +5 -5
- package/dist/docs/api/index/interfaces/RenderBackend.md +8 -8
- package/dist/docs/api/index/interfaces/SoundBankAsset.md +18 -0
- package/dist/docs/api/index/interfaces/SoundSlot.md +31 -0
- package/dist/docs/api/index/interfaces/SoundTake.md +18 -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/AudioBus.md +15 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +50 -38
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +7 -1
- package/dist/docs/api/index/type-aliases/EcsRenderer.md +1 -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 +5 -5
- package/dist/docs/api/index/type-aliases/HandMaterialOptions.md +4 -4
- package/dist/docs/api/index/type-aliases/HandPoseTrackerOptions.md +5 -5
- 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/ModelBoneInfo.md +29 -0
- 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/NetSpawnOptions.md +41 -0
- 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/PlaySlotOptions.md +32 -0
- 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 +1 -1
- package/dist/docs/api/index/type-aliases/ScriptBehaviourSystemOptions.md +2 -2
- package/dist/docs/api/index/type-aliases/ScriptErrorEvent.md +9 -9
- package/dist/docs/api/index/type-aliases/ScriptErrorListener.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptErrorPhase.md +1 -1
- package/dist/docs/api/index/type-aliases/ScriptErrorReport.md +6 -6
- package/dist/docs/api/index/type-aliases/ScriptErrorSource.md +1 -1
- 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 +4 -3
- package/dist/docs/api/index/type-aliases/UiCanvasLike.md +4 -4
- package/dist/docs/api/index/type-aliases/UiColorStop.md +37 -0
- package/dist/docs/api/index/type-aliases/UiPaint.md +81 -0
- package/dist/docs/api/index/type-aliases/UiShadow.md +27 -0
- package/dist/docs/api/index/type-aliases/UiStyle.md +43 -0
- package/dist/docs/api/index/type-aliases/UiTextStyle.md +33 -0
- package/dist/docs/api/index/type-aliases/UiTokens.md +13 -0
- package/dist/docs/api/index/type-aliases/VelocitySample.md +3 -3
- package/dist/docs/api/index/type-aliases/XrCapabilities.md +9 -9
- package/dist/docs/api/index/type-aliases/XrFinger.md +1 -1
- package/dist/docs/api/index/type-aliases/XrFingerCurl.md +4 -4
- package/dist/docs/api/index/type-aliases/XrFingerTarget.md +6 -6
- package/dist/docs/api/index/type-aliases/XrHandJointName.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandJoints.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseAxis.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseContext.md +2 -2
- package/dist/docs/api/index/type-aliases/XrHandPoseDefinition.md +11 -11
- package/dist/docs/api/index/type-aliases/XrHandPoseDirection.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseEvent.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHandPoseEventDetail.md +5 -5
- package/dist/docs/api/index/type-aliases/XrHandPoseMatch.md +4 -4
- package/dist/docs/api/index/type-aliases/XrHandPoseOrientation.md +4 -4
- package/dist/docs/api/index/type-aliases/XrHandShape.md +13 -13
- package/dist/docs/api/index/type-aliases/XrHandedness.md +1 -1
- package/dist/docs/api/index/type-aliases/XrHitResult.md +3 -3
- package/dist/docs/api/index/type-aliases/XrInputKind.md +1 -1
- package/dist/docs/api/index/type-aliases/XrInputState.md +18 -18
- package/dist/docs/api/index/type-aliases/XrPalmPose.md +6 -6
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +1 -1
- package/dist/docs/api/index/variables/ARC_GRAVITY.md +1 -1
- package/dist/docs/api/index/variables/ARC_MAX_TIME.md +1 -1
- package/dist/docs/api/index/variables/ARC_SPEED.md +1 -1
- package/dist/docs/api/index/variables/ARC_STEPS.md +1 -1
- package/dist/docs/api/index/variables/CURLED_COS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_DIRECTION_TOLERANCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_ENTER_CONFIDENCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_EXIT_CONFIDENCE.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_LOST_GRACE_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_MIN_HOLD_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md +1 -1
- package/dist/docs/api/index/variables/FALLBACK_HAND_SCALE.md +1 -1
- package/dist/docs/api/index/variables/HAND_POSE_PRESETS.md +1 -1
- package/dist/docs/api/index/variables/HAND_POSE_PRESET_IDS.md +1 -1
- 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 +1 -1
- package/dist/docs/api/index/variables/MAX_PLAUSIBLE_SPEED.md +1 -1
- package/dist/docs/api/index/variables/MAX_SAMPLE_AGE_SECONDS.md +1 -1
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +1 -1
- package/dist/docs/api/index/variables/NO_XR_CAPABILITIES.md +1 -1
- 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 +1 -1
- 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 +1 -1
- package/dist/docs/api/index/variables/VELOCITY_SAMPLES.md +1 -1
- package/dist/docs/api/index/variables/XR_FINGERS.md +1 -1
- package/dist/docs/api/index/variables/XR_HOVER_SHELL_FLAG.md +1 -1
- package/dist/docs/api/index/variables/webglBackend.md +1 -1
- 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 +1 -1
- 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/bone-attachments-and-ik.md +51 -0
- package/dist/docs/guide/components/audio.md +1 -1
- package/dist/factories/index.cjs +29 -1
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +2 -2
- package/dist/factories/index.d.ts +2 -2
- package/dist/factories/index.js +4 -4
- package/dist/{index-BXjwEdNq.d.cts → index-BbrnjNXy.d.ts} +5 -3
- package/dist/{index-CVG-hREM.d.ts → index-DD7aHv0p.d.cts} +5 -3
- package/dist/{index-6pZO_gV7.d.ts → index-OgOoIpEI.d.ts} +14 -2
- package/dist/{index-BdghvXKE.d.cts → index-xyqzT0PQ.d.cts} +14 -2
- package/dist/index.cjs +174 -13
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -9
- package/dist/index.d.ts +10 -9
- package/dist/index.js +13 -11
- package/dist/index.js.map +1 -1
- package/dist/network/index.cjs +70 -38
- package/dist/network/index.cjs.map +1 -1
- package/dist/network/index.d.cts +2 -2
- package/dist/network/index.d.ts +2 -2
- package/dist/network/index.js +4 -4
- package/dist/systems/index.cjs +171 -13
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +2 -2
- package/dist/systems/index.d.ts +2 -2
- package/dist/systems/index.js +5 -5
- package/dist/types.d.cts +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/webgpu/index.d.ts +2 -2
- package/dist/worldSnapshotUtils.d.cts +1 -1
- package/dist/worldSnapshotUtils.d.ts +1 -1
- package/package.json +2 -1
- package/dist/chunk-GSWC6LLD.js.map +0 -1
- package/dist/chunk-JEPUCLZX.js.map +0 -1
- package/dist/chunk-JNYPJB55.js.map +0 -1
- package/dist/chunk-TY3XCHOR.js.map +0 -1
- package/dist/chunk-WWP46AEF.js.map +0 -1
|
@@ -20,7 +20,7 @@ type EnvironmentFogState = {
|
|
|
20
20
|
};
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
Defined in: [components/Environment.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
Defined in: [components/Environment.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L49)
|
|
24
24
|
|
|
25
25
|
Fog configuration. Mirrors three.js `Fog` / `FogExp2`.
|
|
26
26
|
|
|
@@ -28,10 +28,10 @@ Fog configuration. Mirrors three.js `Fog` / `FogExp2`.
|
|
|
28
28
|
|
|
29
29
|
| Property | Type | Description | Defined in |
|
|
30
30
|
| ------ | ------ | ------ | ------ |
|
|
31
|
-
| <a id="type"></a> `type` | [`EnvironmentFogType`](EnvironmentFogType.md) | Active fog model. | [components/Environment.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
32
|
-
| <a id="color"></a> `color` | `string` | Fog color as `#rrggbb`. | [components/Environment.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
33
|
-
| <a id="linear"></a> `linear` | \{ `near`: `number`; `far`: `number`; \} | Linear-fog parameters used when [type](#type) is `"linear"`. | [components/Environment.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
34
|
-
| `linear.near` | `number` | Distance at which fog begins to take effect. | [components/Environment.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
-
| `linear.far` | `number` | Distance at which fog reaches full opacity. | [components/Environment.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
36
|
-
| <a id="exponential"></a> `exponential` | \{ `density`: `number`; \} | Exponential-fog parameters used when [type](#type) is `"exponential"`. | [components/Environment.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
37
|
-
| `exponential.density` | `number` | Density coefficient. Higher values produce thicker fog. | [components/Environment.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
+
| <a id="type"></a> `type` | [`EnvironmentFogType`](EnvironmentFogType.md) | Active fog model. | [components/Environment.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L51) |
|
|
32
|
+
| <a id="color"></a> `color` | `string` | Fog color as `#rrggbb`. | [components/Environment.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L53) |
|
|
33
|
+
| <a id="linear"></a> `linear` | \{ `near`: `number`; `far`: `number`; \} | Linear-fog parameters used when [type](#type) is `"linear"`. | [components/Environment.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L55) |
|
|
34
|
+
| `linear.near` | `number` | Distance at which fog begins to take effect. | [components/Environment.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L57) |
|
|
35
|
+
| `linear.far` | `number` | Distance at which fog reaches full opacity. | [components/Environment.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L59) |
|
|
36
|
+
| <a id="exponential"></a> `exponential` | \{ `density`: `number`; \} | Exponential-fog parameters used when [type](#type) is `"exponential"`. | [components/Environment.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L62) |
|
|
37
|
+
| `exponential.density` | `number` | Density coefficient. Higher values produce thicker fog. | [components/Environment.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L64) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type EnvironmentFogType = "linear" | "exponential" | "none";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Environment.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L8)
|
|
14
14
|
|
|
15
15
|
Fog distance models. `none` disables fog.
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type EnvironmentGradientEffect = "radial" | "linear" | "angular";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Environment.ts:6](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L6)
|
|
14
14
|
|
|
15
15
|
Gradient distribution applied when [EnvironmentSkyboxState.type](EnvironmentSkyboxState.md#type) is `"gradient"`.
|
|
@@ -19,7 +19,7 @@ type EnvironmentLightingState = {
|
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: [components/Environment.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
+
Defined in: [components/Environment.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L84)
|
|
23
23
|
|
|
24
24
|
Image-based lighting and renderer colour settings. Every field is optional;
|
|
25
25
|
the defaults below apply when a field is missing. When the whole block is
|
|
@@ -30,11 +30,11 @@ untouched.
|
|
|
30
30
|
|
|
31
31
|
| Property | Type | Description | Defined in |
|
|
32
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L105) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type EnvironmentSkyboxImageProjection = "screen" | "equirect";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Environment.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L19)
|
|
14
14
|
|
|
15
15
|
How an `"image"` skybox is projected.
|
|
16
16
|
|
|
@@ -19,7 +19,7 @@ type EnvironmentSkyboxState = {
|
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: [components/Environment.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
+
Defined in: [components/Environment.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L27)
|
|
23
23
|
|
|
24
24
|
Skybox configuration. Only the fields relevant to [type](#type) are read at render time.
|
|
25
25
|
|
|
@@ -27,10 +27,10 @@ Skybox configuration. Only the fields relevant to [type](#type) are read at rend
|
|
|
27
27
|
|
|
28
28
|
| Property | Type | Description | Defined in |
|
|
29
29
|
| ------ | ------ | ------ | ------ |
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
36
|
-
| `gradient.effect` | [`EnvironmentGradientEffect`](EnvironmentGradientEffect.md) | Gradient distribution. | [components/Environment.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L4)
|
|
14
14
|
|
|
15
15
|
Skybox rendering modes. `none` disables skybox rendering entirely.
|
|
@@ -16,7 +16,7 @@ type EnvironmentState = {
|
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [components/Environment.ts:121](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
19
|
+
Defined in: [components/Environment.ts:121](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L121)
|
|
20
20
|
|
|
21
21
|
Aggregated authoring state owned by [Environment](../classes/Environment.md).
|
|
22
22
|
|
|
@@ -24,8 +24,8 @@ Aggregated authoring state owned by [Environment](../classes/Environment.md).
|
|
|
24
24
|
|
|
25
25
|
| Property | Type | Description | Defined in |
|
|
26
26
|
| ------ | ------ | ------ | ------ |
|
|
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/
|
|
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/
|
|
29
|
-
| <a id="gravity"></a> `gravity` | `EnvironmentGravityState` | World gravity. | [components/Environment.ts:127](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
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/
|
|
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/
|
|
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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L139) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type EnvironmentToneMapping = "none" | "aces" | "agx" | "neutral";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Environment.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L24)
|
|
14
14
|
|
|
15
15
|
Tone-mapping operator applied by the renderer. `"none"` leaves colours
|
|
16
16
|
linear-clamped (three's `NoToneMapping`).
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / IKChain
|
|
6
|
+
|
|
7
|
+
# Type Alias: IKChain
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type IKChain = {
|
|
11
|
+
limb: IKLimb;
|
|
12
|
+
target: EntityId | null;
|
|
13
|
+
pole: EntityId | null;
|
|
14
|
+
weight: number;
|
|
15
|
+
matchRotation: boolean;
|
|
16
|
+
enabled: boolean;
|
|
17
|
+
clips: string[] | null;
|
|
18
|
+
fade: number | null;
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Defined in: [components/IK.ts:8](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L8)
|
|
23
|
+
|
|
24
|
+
One limb reaching for an entity.
|
|
25
|
+
|
|
26
|
+
## Properties
|
|
27
|
+
|
|
28
|
+
| Property | Type | Description | Defined in |
|
|
29
|
+
| ------ | ------ | ------ | ------ |
|
|
30
|
+
| <a id="limb"></a> `limb` | [`IKLimb`](IKLimb.md) | The hand or foot that reaches. | [components/IK.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L10) |
|
|
31
|
+
| <a id="target"></a> `target` | [`EntityId`](../../types/type-aliases/EntityId.md) \| `null` | Entity whose world position the hand/foot reaches (a weapon's grip, a door handle, a step). | [components/IK.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L12) |
|
|
32
|
+
| <a id="pole"></a> `pole` | [`EntityId`](../../types/type-aliases/EntityId.md) \| `null` | Entity the elbow/knee bends toward; `null` keeps the animation's own bend. | [components/IK.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L14) |
|
|
33
|
+
| <a id="weight"></a> `weight` | `number` | 0 = the animation, 1 = the target; in between blends. | [components/IK.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L16) |
|
|
34
|
+
| <a id="matchrotation"></a> `matchRotation` | `boolean` | Also turn the hand/foot to the target's rotation. | [components/IK.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L18) |
|
|
35
|
+
| <a id="enabled"></a> `enabled` | `boolean` | Whether this chain runs. | [components/IK.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L20) |
|
|
36
|
+
| <a id="clips"></a> `clips` | `string`[] \| `null` | Only while one of these clips plays (`null` = whatever plays). | [components/IK.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L22) |
|
|
37
|
+
| <a id="fade"></a> `fade` | `number` \| `null` | Seconds a chain with `clips` takes to fade in or out when the clip changes; `null` follows the Animation component's cross-fade, so the IK and the clip change together. | [components/IK.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L28) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / IKLimb
|
|
6
|
+
|
|
7
|
+
# Type Alias: IKLimb
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type IKLimb = "leftHand" | "rightHand" | "leftFoot" | "rightFoot";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/IK.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L5)
|
|
14
|
+
|
|
15
|
+
The limb a chain moves: its end bone, by humanoid name.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / IKOptions
|
|
6
|
+
|
|
7
|
+
# Type Alias: IKOptions
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type IKOptions = {
|
|
11
|
+
chains?: Partial<IKChain> & {
|
|
12
|
+
limb: IKLimb;
|
|
13
|
+
}[];
|
|
14
|
+
enabled?: boolean;
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [components/IK.ts:32](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L32)
|
|
19
|
+
|
|
20
|
+
Optional initializer for [IKComponent](../classes/IKComponent.md).
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
| Property | Type | Defined in |
|
|
25
|
+
| ------ | ------ | ------ |
|
|
26
|
+
| <a id="chains"></a> `chains?` | `Partial`\<[`IKChain`](IKChain.md)\> & \{ `limb`: [`IKLimb`](IKLimb.md); \}[] | [components/IK.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L33) |
|
|
27
|
+
| <a id="enabled"></a> `enabled?` | `boolean` | [components/IK.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/IK.ts#L34) |
|
|
@@ -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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L18) |
|
|
39
|
+
| `position.x` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L18) |
|
|
40
|
+
| `position.y` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L18) |
|
|
41
|
+
| `position.z` | `number` | - | [components/InstancedMesh.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L20) |
|
|
43
|
+
| `rotation.x` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L20) |
|
|
44
|
+
| `rotation.y` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L20) |
|
|
45
|
+
| `rotation.z` | `number` | - | [components/InstancedMesh.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L21) |
|
|
47
|
+
| `scale.x` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L21) |
|
|
48
|
+
| `scale.y` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L21) |
|
|
49
|
+
| `scale.z` | `number` | - | [components/InstancedMesh.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L25)
|
|
14
14
|
|
|
15
15
|
Primitive geometry kinds and custom 3D model kind supported by instanced mesh rendering.
|
|
@@ -18,7 +18,7 @@ type LightShadowState = {
|
|
|
18
18
|
};
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [components/Light.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
21
|
+
Defined in: [components/Light.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Light.ts#L10)
|
|
22
22
|
|
|
23
23
|
Optional shadow tuning for a shadow-casting light (directional, spot,
|
|
24
24
|
point). Only the fields present are applied; a missing field keeps three's
|
|
@@ -28,10 +28,10 @@ default, and a light without a `shadow` block is never touched.
|
|
|
28
28
|
|
|
29
29
|
| Property | Type | Description | Defined in |
|
|
30
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Light.ts#L29) |
|
|
@@ -22,7 +22,7 @@ type LightValueState = {
|
|
|
22
22
|
};
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [components/Light.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
+
Defined in: [components/Light.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Light.ts#L33)
|
|
26
26
|
|
|
27
27
|
Authoring state for [LightComponent](../classes/LightComponent.md). Common fields apply to every light kind; the optional fields are only meaningful for specific kinds.
|
|
28
28
|
|
|
@@ -30,14 +30,14 @@ Authoring state for [LightComponent](../classes/LightComponent.md). Common field
|
|
|
30
30
|
|
|
31
31
|
| Property | Type | Description | Defined in |
|
|
32
32
|
| ------ | ------ | ------ | ------ |
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/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/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/MeshGeometry.ts#L59)
|