@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
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / UiTextStyle
|
|
6
|
+
|
|
7
|
+
# Type Alias: UiTextStyle
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UiTextStyle = {
|
|
11
|
+
font?: string;
|
|
12
|
+
weight?: number;
|
|
13
|
+
tracking?: number;
|
|
14
|
+
transform?: "upper" | "lower";
|
|
15
|
+
paint?: UiPaint;
|
|
16
|
+
maxLines?: number;
|
|
17
|
+
shadow?: UiShadow;
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [ui/uiStyle.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L33)
|
|
22
|
+
|
|
23
|
+
## Properties
|
|
24
|
+
|
|
25
|
+
| Property | Type | Description | Defined in |
|
|
26
|
+
| ------ | ------ | ------ | ------ |
|
|
27
|
+
| <a id="font"></a> `font?` | `string` | A font file in the project, such as one `add_font` bundled. | [ui/uiStyle.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L35) |
|
|
28
|
+
| <a id="weight"></a> `weight?` | `number` | - | [ui/uiStyle.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L36) |
|
|
29
|
+
| <a id="tracking"></a> `tracking?` | `number` | Letter spacing in metres. | [ui/uiStyle.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L38) |
|
|
30
|
+
| <a id="transform"></a> `transform?` | `"upper"` \| `"lower"` | - | [ui/uiStyle.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L39) |
|
|
31
|
+
| <a id="paint"></a> `paint?` | [`UiPaint`](UiPaint.md) | - | [ui/uiStyle.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L40) |
|
|
32
|
+
| <a id="maxlines"></a> `maxLines?` | `number` | - | [ui/uiStyle.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L41) |
|
|
33
|
+
| <a id="shadow"></a> `shadow?` | [`UiShadow`](UiShadow.md) | - | [ui/uiStyle.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L42) |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / UiTokens
|
|
6
|
+
|
|
7
|
+
# Type Alias: UiTokens
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type UiTokens = Record<string, string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [ui/uiStyle.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/ui/uiStyle.ts#L58)
|
|
@@ -13,11 +13,11 @@ type VelocitySample = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [xr/throwVelocity.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [xr/throwVelocity.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/throwVelocity.ts#L41)
|
|
17
17
|
|
|
18
18
|
## Properties
|
|
19
19
|
|
|
20
20
|
| Property | Type | Description | Defined in |
|
|
21
21
|
| ------ | ------ | ------ | ------ |
|
|
22
|
-
| <a id="position"></a> `position` | `THREE.Vector3` | - | [xr/throwVelocity.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
-
| <a id="time"></a> `time` | `number` | Seconds, monotonically increasing. | [xr/throwVelocity.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
+
| <a id="position"></a> `position` | `THREE.Vector3` | - | [xr/throwVelocity.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/throwVelocity.ts#L42) |
|
|
23
|
+
| <a id="time"></a> `time` | `number` | Seconds, monotonically increasing. | [xr/throwVelocity.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/throwVelocity.ts#L44) |
|
|
@@ -19,7 +19,7 @@ type XrCapabilities = {
|
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: [xr/types.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
22
|
+
Defined in: [xr/types.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L86)
|
|
23
23
|
|
|
24
24
|
What the ACTIVE session actually granted us.
|
|
25
25
|
|
|
@@ -31,11 +31,11 @@ sharply per platform (e.g. Vision Pro grants no `immersive-ar` at all today).
|
|
|
31
31
|
|
|
32
32
|
| Property | Type | Description | Defined in |
|
|
33
33
|
| ------ | ------ | ------ | ------ |
|
|
34
|
-
| <a id="mode"></a> `mode` | `"immersive-vr"` \| `"immersive-ar"` \| `"inline"` | The session's mode. `immersive-ar` implies passthrough / mixed reality. | [xr/types.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
-
| <a id="handtracking"></a> `handTracking` | `boolean` | Tracked-hand joint data is available. | [xr/types.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
36
|
-
| <a id="planedetection"></a> `planeDetection` | `boolean` | Real-world plane detection (incubating; effectively Quest-only today). | [xr/types.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
37
|
-
| <a id="meshdetection"></a> `meshDetection` | `boolean` | Real-world mesh detection (draft spec; Quest-only today). | [xr/types.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
-
| <a id="depthsensing"></a> `depthSensing` | `boolean` | Per-frame depth buffer (Android XR stereo, Quest experimental). | [xr/types.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
-
| <a id="anchors"></a> `anchors` | `boolean` | Spatial anchors. | [xr/types.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| <a id="hittest"></a> `hitTest` | `boolean` | Ray-against-real-world hit testing. | [xr/types.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| <a id="enabledfeatures"></a> `enabledFeatures` | `string`[] | Everything the UA reported, verbatim, for diagnostics. | [xr/types.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
34
|
+
| <a id="mode"></a> `mode` | `"immersive-vr"` \| `"immersive-ar"` \| `"inline"` | The session's mode. `immersive-ar` implies passthrough / mixed reality. | [xr/types.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L88) |
|
|
35
|
+
| <a id="handtracking"></a> `handTracking` | `boolean` | Tracked-hand joint data is available. | [xr/types.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L90) |
|
|
36
|
+
| <a id="planedetection"></a> `planeDetection` | `boolean` | Real-world plane detection (incubating; effectively Quest-only today). | [xr/types.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L92) |
|
|
37
|
+
| <a id="meshdetection"></a> `meshDetection` | `boolean` | Real-world mesh detection (draft spec; Quest-only today). | [xr/types.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L94) |
|
|
38
|
+
| <a id="depthsensing"></a> `depthSensing` | `boolean` | Per-frame depth buffer (Android XR stereo, Quest experimental). | [xr/types.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L96) |
|
|
39
|
+
| <a id="anchors"></a> `anchors` | `boolean` | Spatial anchors. | [xr/types.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L98) |
|
|
40
|
+
| <a id="hittest"></a> `hitTest` | `boolean` | Ray-against-real-world hit testing. | [xr/types.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L100) |
|
|
41
|
+
| <a id="enabledfeatures"></a> `enabledFeatures` | `string`[] | Everything the UA reported, verbatim, for diagnostics. | [xr/types.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L102) |
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type XrFinger = "thumb" | "index" | "middle" | "ring" | "pinky";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/handPose.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/handPose.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L52)
|
|
@@ -14,7 +14,7 @@ type XrFingerCurl = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [xr/handPose.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [xr/handPose.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L197)
|
|
18
18
|
|
|
19
19
|
How curled one finger is.
|
|
20
20
|
|
|
@@ -22,6 +22,6 @@ How curled one finger is.
|
|
|
22
22
|
|
|
23
23
|
| Property | Type | Description | Defined in |
|
|
24
24
|
| ------ | ------ | ------ | ------ |
|
|
25
|
-
| <a id="basecurl"></a> `baseCurl` | `number` | Knuckle bend alone — 0 straight, 1 bent square to the palm. | [xr/handPose.ts:199](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="tipcurl"></a> `tipCurl` | `number` | The outer joints — distinguishes a hook from a fist. | [xr/handPose.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="curl"></a> `curl` | `number` | Whole-finger curl. The value a simple pose editor exposes. | [xr/handPose.ts:203](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
+
| <a id="basecurl"></a> `baseCurl` | `number` | Knuckle bend alone — 0 straight, 1 bent square to the palm. | [xr/handPose.ts:199](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L199) |
|
|
26
|
+
| <a id="tipcurl"></a> `tipCurl` | `number` | The outer joints — distinguishes a hook from a fist. | [xr/handPose.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L201) |
|
|
27
|
+
| <a id="curl"></a> `curl` | `number` | Whole-finger curl. The value a simple pose editor exposes. | [xr/handPose.ts:203](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L203) |
|
|
@@ -16,7 +16,7 @@ type XrFingerTarget = {
|
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [xr/handPose.ts:464](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
19
|
+
Defined in: [xr/handPose.ts:464](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L464)
|
|
20
20
|
|
|
21
21
|
Target curl for one finger, with the slack allowed around it.
|
|
22
22
|
|
|
@@ -24,8 +24,8 @@ Target curl for one finger, with the slack allowed around it.
|
|
|
24
24
|
|
|
25
25
|
| Property | Type | Description | Defined in |
|
|
26
26
|
| ------ | ------ | ------ | ------ |
|
|
27
|
-
| <a id="curl"></a> `curl` | `number` | 0 = extended, 1 = fully curled. | [xr/handPose.ts:466](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
-
| <a id="tolerance"></a> `tolerance` | `number` | Half-width of the accepted band. Larger = easier to perform. | [xr/handPose.ts:468](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
-
| <a id="basecurl"></a> `baseCurl?` | `number` | Optional knuckle constraint, for poses where whole-finger curl is ambiguous. | [xr/handPose.ts:470](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
-
| <a id="tipcurl"></a> `tipCurl?` | `number` | Optional outer-joint constraint. | [xr/handPose.ts:472](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
-
| <a id="directions"></a> `directions?` | [`XrHandPoseDirection`](XrHandPoseDirection.md)[] | Directions this finger may point, world space. Any ONE of them satisfies the constraint, mirroring fingerpose's `addDirection` — a thumb that may point up OR diagonally up is one pose, not two. Empty or omitted leaves the finger free to point anywhere. | [xr/handPose.ts:480](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
+
| <a id="curl"></a> `curl` | `number` | 0 = extended, 1 = fully curled. | [xr/handPose.ts:466](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L466) |
|
|
28
|
+
| <a id="tolerance"></a> `tolerance` | `number` | Half-width of the accepted band. Larger = easier to perform. | [xr/handPose.ts:468](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L468) |
|
|
29
|
+
| <a id="basecurl"></a> `baseCurl?` | `number` | Optional knuckle constraint, for poses where whole-finger curl is ambiguous. | [xr/handPose.ts:470](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L470) |
|
|
30
|
+
| <a id="tipcurl"></a> `tipCurl?` | `number` | Optional outer-joint constraint. | [xr/handPose.ts:472](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L472) |
|
|
31
|
+
| <a id="directions"></a> `directions?` | [`XrHandPoseDirection`](XrHandPoseDirection.md)[] | Directions this finger may point, world space. Any ONE of them satisfies the constraint, mirroring fingerpose's `addDirection` — a thumb that may point up OR diagonally up is one pose, not two. Empty or omitted leaves the finger free to point anywhere. | [xr/handPose.ts:480](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L480) |
|
|
@@ -35,6 +35,6 @@ type XrHandJointName =
|
|
|
35
35
|
| "pinky-finger-tip";
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [xr/handPose.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
+
Defined in: [xr/handPose.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L25)
|
|
39
39
|
|
|
40
40
|
The 25 joints of the WebXR hand skeleton.
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrHandJoints = Partial<Record<XrHandJointName, THREE.Vector3>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/handPose.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/handPose.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L76)
|
|
14
14
|
|
|
15
15
|
Joint positions, in world space.
|
|
16
16
|
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type XrHandPoseAxis = "palm-normal" | "fingers" | "thumb";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/handPose.ts:484](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/handPose.ts:484](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L484)
|
|
14
14
|
|
|
15
15
|
Which way something on the hand must point for the pose to count.
|
|
@@ -12,7 +12,7 @@ type XrHandPoseContext = {
|
|
|
12
12
|
};
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Defined in: [xr/handPose.ts:579](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
15
|
+
Defined in: [xr/handPose.ts:579](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L579)
|
|
16
16
|
|
|
17
17
|
Extra world context needed only by head-relative orientation conditions.
|
|
18
18
|
|
|
@@ -20,4 +20,4 @@ Extra world context needed only by head-relative orientation conditions.
|
|
|
20
20
|
|
|
21
21
|
| Property | Type | Defined in |
|
|
22
22
|
| ------ | ------ | ------ |
|
|
23
|
-
| <a id="headposition"></a> `headPosition?` | `THREE.Vector3` | [xr/handPose.ts:580](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="headposition"></a> `headPosition?` | `THREE.Vector3` | [xr/handPose.ts:580](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L580) |
|
|
@@ -22,7 +22,7 @@ type XrHandPoseDefinition = {
|
|
|
22
22
|
};
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [xr/handPose.ts:511](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
+
Defined in: [xr/handPose.ts:511](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L511)
|
|
26
26
|
|
|
27
27
|
A matchable hand pose.
|
|
28
28
|
|
|
@@ -35,13 +35,13 @@ duplicate definitions and make neither editable in isolation.
|
|
|
35
35
|
|
|
36
36
|
| Property | Type | Description | Defined in |
|
|
37
37
|
| ------ | ------ | ------ | ------ |
|
|
38
|
-
| <a id="id"></a> `id` | `string` | - | [xr/handPose.ts:512](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
-
| <a id="name"></a> `name` | `string` | - | [xr/handPose.ts:513](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| <a id="fingers"></a> `fingers` | `Record`\<[`XrFinger`](XrFinger.md), [`XrFingerTarget`](XrFingerTarget.md)\> | - | [xr/handPose.ts:514](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| <a id="pinch"></a> `pinch?` | \{ `finger`: `Exclude`\<[`XrFinger`](XrFinger.md), `"thumb"`\>; `target`: `number`; `tolerance`: `number`; \} | Optional thumb-to-finger contact requirement. | [xr/handPose.ts:516](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
42
|
-
| `pinch.finger` | `Exclude`\<[`XrFinger`](XrFinger.md), `"thumb"`\> | - | [xr/handPose.ts:517](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
-
| `pinch.target` | `number` | 1 = touching. | [xr/handPose.ts:519](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
-
| `pinch.tolerance` | `number` | - | [xr/handPose.ts:520](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| <a id="orientation"></a> `orientation?` | [`XrHandPoseOrientation`](XrHandPoseOrientation.md) | - | [xr/handPose.ts:522](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| <a id="directiontolerancedegrees"></a> `directionToleranceDegrees?` | `number` | How far a finger may point from an accepted direction, in degrees. Generous by default: finger direction is a coarse signal, and a tight cone makes a pose that reads correctly to the user fail to register. | [xr/handPose.ts:529](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
-
| <a id="hand"></a> `hand?` | `"left"` \| `"right"` | Restrict to one hand; omit to match either. | [xr/handPose.ts:531](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
+
| <a id="id"></a> `id` | `string` | - | [xr/handPose.ts:512](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L512) |
|
|
39
|
+
| <a id="name"></a> `name` | `string` | - | [xr/handPose.ts:513](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L513) |
|
|
40
|
+
| <a id="fingers"></a> `fingers` | `Record`\<[`XrFinger`](XrFinger.md), [`XrFingerTarget`](XrFingerTarget.md)\> | - | [xr/handPose.ts:514](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L514) |
|
|
41
|
+
| <a id="pinch"></a> `pinch?` | \{ `finger`: `Exclude`\<[`XrFinger`](XrFinger.md), `"thumb"`\>; `target`: `number`; `tolerance`: `number`; \} | Optional thumb-to-finger contact requirement. | [xr/handPose.ts:516](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L516) |
|
|
42
|
+
| `pinch.finger` | `Exclude`\<[`XrFinger`](XrFinger.md), `"thumb"`\> | - | [xr/handPose.ts:517](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L517) |
|
|
43
|
+
| `pinch.target` | `number` | 1 = touching. | [xr/handPose.ts:519](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L519) |
|
|
44
|
+
| `pinch.tolerance` | `number` | - | [xr/handPose.ts:520](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L520) |
|
|
45
|
+
| <a id="orientation"></a> `orientation?` | [`XrHandPoseOrientation`](XrHandPoseOrientation.md) | - | [xr/handPose.ts:522](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L522) |
|
|
46
|
+
| <a id="directiontolerancedegrees"></a> `directionToleranceDegrees?` | `number` | How far a finger may point from an accepted direction, in degrees. Generous by default: finger direction is a coarse signal, and a tight cone makes a pose that reads correctly to the user fail to register. | [xr/handPose.ts:529](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L529) |
|
|
47
|
+
| <a id="hand"></a> `hand?` | `"left"` \| `"right"` | Restrict to one hand; omit to match either. | [xr/handPose.ts:531](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L531) |
|
|
@@ -18,4 +18,4 @@ type XrHandPoseDirection =
|
|
|
18
18
|
| "away-from-head";
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [xr/handPose.ts:486](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
21
|
+
Defined in: [xr/handPose.ts:486](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L486)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type XrHandPoseEvent = "start" | "end" | null;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/handPose.ts:740](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/handPose.ts:740](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L740)
|
|
@@ -15,13 +15,13 @@ type XrHandPoseEventDetail = {
|
|
|
15
15
|
};
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Defined in: [systems/XRHandPoseSystem.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
18
|
+
Defined in: [systems/XRHandPoseSystem.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L37)
|
|
19
19
|
|
|
20
20
|
## Properties
|
|
21
21
|
|
|
22
22
|
| Property | Type | Description | Defined in |
|
|
23
23
|
| ------ | ------ | ------ | ------ |
|
|
24
|
-
| <a id="poseid"></a> `poseId` | `string` | The entry's id. | [systems/XRHandPoseSystem.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="posename"></a> `poseName` | `string` | - | [systems/XRHandPoseSystem.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
-
| <a id="handedness"></a> `handedness` | `"left"` \| `"right"` | - | [systems/XRHandPoseSystem.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
-
| <a id="confidence"></a> `confidence` | `number` | 0..1 at the moment of the transition. | [systems/XRHandPoseSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="poseid"></a> `poseId` | `string` | The entry's id. | [systems/XRHandPoseSystem.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L39) |
|
|
25
|
+
| <a id="posename"></a> `poseName` | `string` | - | [systems/XRHandPoseSystem.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L40) |
|
|
26
|
+
| <a id="handedness"></a> `handedness` | `"left"` \| `"right"` | - | [systems/XRHandPoseSystem.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L41) |
|
|
27
|
+
| <a id="confidence"></a> `confidence` | `number` | 0..1 at the moment of the transition. | [systems/XRHandPoseSystem.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L43) |
|
|
@@ -14,12 +14,12 @@ type XrHandPoseMatch = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [xr/handPose.ts:537](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [xr/handPose.ts:537](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L537)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="matched"></a> `matched` | `boolean` | Every constraint inside its tolerance. | [xr/handPose.ts:539](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
-
| <a id="confidence"></a> `confidence` | `number` | 0..1. Degrades smoothly outside tolerance, for live editor feedback. | [xr/handPose.ts:541](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="worstconstraint"></a> `worstConstraint` | `string` \| `null` | The constraint furthest out of range — what to show the user when it fails. | [xr/handPose.ts:543](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="matched"></a> `matched` | `boolean` | Every constraint inside its tolerance. | [xr/handPose.ts:539](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L539) |
|
|
24
|
+
| <a id="confidence"></a> `confidence` | `number` | 0..1. Degrades smoothly outside tolerance, for live editor feedback. | [xr/handPose.ts:541](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L541) |
|
|
25
|
+
| <a id="worstconstraint"></a> `worstConstraint` | `string` \| `null` | The constraint furthest out of range — what to show the user when it fails. | [xr/handPose.ts:543](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L543) |
|
|
@@ -14,12 +14,12 @@ type XrHandPoseOrientation = {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [xr/handPose.ts:496](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
17
|
+
Defined in: [xr/handPose.ts:496](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L496)
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
21
|
| Property | Type | Description | Defined in |
|
|
22
22
|
| ------ | ------ | ------ | ------ |
|
|
23
|
-
| <a id="axis"></a> `axis` | [`XrHandPoseAxis`](XrHandPoseAxis.md) | - | [xr/handPose.ts:497](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
-
| <a id="direction"></a> `direction` | [`XrHandPoseDirection`](XrHandPoseDirection.md) | - | [xr/handPose.ts:498](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="tolerancedegrees"></a> `toleranceDegrees` | `number` | How far off it may point and still match. | [xr/handPose.ts:500](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
| <a id="axis"></a> `axis` | [`XrHandPoseAxis`](XrHandPoseAxis.md) | - | [xr/handPose.ts:497](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L497) |
|
|
24
|
+
| <a id="direction"></a> `direction` | [`XrHandPoseDirection`](XrHandPoseDirection.md) | - | [xr/handPose.ts:498](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L498) |
|
|
25
|
+
| <a id="tolerancedegrees"></a> `toleranceDegrees` | `number` | How far off it may point and still match. | [xr/handPose.ts:500](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L500) |
|
|
@@ -24,7 +24,7 @@ type XrHandShape = {
|
|
|
24
24
|
};
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Defined in: [xr/handPose.ts:363](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
+
Defined in: [xr/handPose.ts:363](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L363)
|
|
28
28
|
|
|
29
29
|
Everything a pose is matched against, derived once per hand per frame.
|
|
30
30
|
|
|
@@ -32,15 +32,15 @@ Everything a pose is matched against, derived once per hand per frame.
|
|
|
32
32
|
|
|
33
33
|
| Property | Type | Description | Defined in |
|
|
34
34
|
| ------ | ------ | ------ | ------ |
|
|
35
|
-
| <a id="handedness"></a> `handedness` | `"left"` \| `"right"` | - | [xr/handPose.ts:364](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
36
|
-
| <a id="fingers"></a> `fingers` | `Record`\<[`XrFinger`](XrFinger.md), [`XrFingerCurl`](XrFingerCurl.md)\> | - | [xr/handPose.ts:365](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
37
|
-
| <a id="pinch"></a> `pinch` | `Record`\<`Exclude`\<[`XrFinger`](XrFinger.md), `"thumb"`\>, `number`\> | Thumb-opposition per finger. | [xr/handPose.ts:367](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
-
| <a id="spread"></a> `spread` | \{ `thumbIndex`: `number`; `indexMiddle`: `number`; `middleRing`: `number`; `ringPinky`: `number`; \} | - | [xr/handPose.ts:368](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
-
| `spread.thumbIndex` | `number` | - | [xr/handPose.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| `spread.indexMiddle` | `number` | - | [xr/handPose.ts:370](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| `spread.middleRing` | `number` | - | [xr/handPose.ts:371](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
42
|
-
| `spread.ringPinky` | `number` | - | [xr/handPose.ts:372](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
-
| <a id="palm"></a> `palm` | [`XrPalmPose`](XrPalmPose.md) \| `null` | - | [xr/handPose.ts:374](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
-
| <a id="scale"></a> `scale` | `number` | Characteristic hand size, metres. | [xr/handPose.ts:376](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| <a id="thumbdirection"></a> `thumbDirection` | `THREE.Vector3` \| `null` | Direction the thumb points, world space. | [xr/handPose.ts:378](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| <a id="fingerdirections"></a> `fingerDirections` | `Record`\<[`XrFinger`](XrFinger.md), `THREE.Vector3` \| `null`\> | Direction each finger points, world space (metacarpal → tip). Separate from curl: a finger can be straight while pointing anywhere, and "index extended, pointing up" is a different pose from "index extended, pointing at the user". | [xr/handPose.ts:386](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
+
| <a id="handedness"></a> `handedness` | `"left"` \| `"right"` | - | [xr/handPose.ts:364](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L364) |
|
|
36
|
+
| <a id="fingers"></a> `fingers` | `Record`\<[`XrFinger`](XrFinger.md), [`XrFingerCurl`](XrFingerCurl.md)\> | - | [xr/handPose.ts:365](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L365) |
|
|
37
|
+
| <a id="pinch"></a> `pinch` | `Record`\<`Exclude`\<[`XrFinger`](XrFinger.md), `"thumb"`\>, `number`\> | Thumb-opposition per finger. | [xr/handPose.ts:367](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L367) |
|
|
38
|
+
| <a id="spread"></a> `spread` | \{ `thumbIndex`: `number`; `indexMiddle`: `number`; `middleRing`: `number`; `ringPinky`: `number`; \} | - | [xr/handPose.ts:368](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L368) |
|
|
39
|
+
| `spread.thumbIndex` | `number` | - | [xr/handPose.ts:369](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L369) |
|
|
40
|
+
| `spread.indexMiddle` | `number` | - | [xr/handPose.ts:370](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L370) |
|
|
41
|
+
| `spread.middleRing` | `number` | - | [xr/handPose.ts:371](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L371) |
|
|
42
|
+
| `spread.ringPinky` | `number` | - | [xr/handPose.ts:372](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L372) |
|
|
43
|
+
| <a id="palm"></a> `palm` | [`XrPalmPose`](XrPalmPose.md) \| `null` | - | [xr/handPose.ts:374](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L374) |
|
|
44
|
+
| <a id="scale"></a> `scale` | `number` | Characteristic hand size, metres. | [xr/handPose.ts:376](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L376) |
|
|
45
|
+
| <a id="thumbdirection"></a> `thumbDirection` | `THREE.Vector3` \| `null` | Direction the thumb points, world space. | [xr/handPose.ts:378](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L378) |
|
|
46
|
+
| <a id="fingerdirections"></a> `fingerDirections` | `Record`\<[`XrFinger`](XrFinger.md), `THREE.Vector3` \| `null`\> | Direction each finger points, world space (metacarpal → tip). Separate from curl: a finger can be straight while pointing anywhere, and "index extended, pointing up" is a different pose from "index extended, pointing at the user". | [xr/handPose.ts:386](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L386) |
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type XrHandedness = "left" | "right" | "none";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/types.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/types.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L25)
|
|
14
14
|
|
|
15
15
|
Which hand an input source belongs to (`none` for gaze / single-source devices).
|
|
@@ -13,7 +13,7 @@ type XrHitResult = {
|
|
|
13
13
|
};
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [systems/XRHitTestSystem.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [systems/XRHitTestSystem.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHitTestSystem.ts#L29)
|
|
17
17
|
|
|
18
18
|
Where a ray met the real world.
|
|
19
19
|
|
|
@@ -21,5 +21,5 @@ Where a ray met the real world.
|
|
|
21
21
|
|
|
22
22
|
| Property | Type | Defined in |
|
|
23
23
|
| ------ | ------ | ------ |
|
|
24
|
-
| <a id="position"></a> `position` | `THREE.Vector3` | [systems/XRHitTestSystem.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
25
|
-
| <a id="quaternion"></a> `quaternion` | `THREE.Quaternion` | [systems/XRHitTestSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
24
|
+
| <a id="position"></a> `position` | `THREE.Vector3` | [systems/XRHitTestSystem.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHitTestSystem.ts#L30) |
|
|
25
|
+
| <a id="quaternion"></a> `quaternion` | `THREE.Quaternion` | [systems/XRHitTestSystem.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHitTestSystem.ts#L31) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrInputKind = "controller" | "hand" | "transient-pointer" | "gaze";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/types.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/types.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L34)
|
|
14
14
|
|
|
15
15
|
How an input source is physically driven.
|
|
16
16
|
|
|
@@ -28,7 +28,7 @@ type XrInputState = {
|
|
|
28
28
|
};
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Defined in: [xr/types.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
+
Defined in: [xr/types.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L44)
|
|
32
32
|
|
|
33
33
|
One frame of normalized input for a single source.
|
|
34
34
|
|
|
@@ -41,20 +41,20 @@ edge-detect (`if (selectStart)`) without subscribing to events.
|
|
|
41
41
|
|
|
42
42
|
| Property | Type | Description | Defined in |
|
|
43
43
|
| ------ | ------ | ------ | ------ |
|
|
44
|
-
| <a id="handedness"></a> `handedness` | [`XrHandedness`](XrHandedness.md) | - | [xr/types.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| <a id="kind"></a> `kind` | [`XrInputKind`](XrInputKind.md) | - | [xr/types.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| <a id="connected"></a> `connected` | `boolean` | False once the source disconnects (a released pinch on Vision Pro). | [xr/types.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
-
| <a id="rayorigin"></a> `rayOrigin` | `THREE.Vector3` | Pointing ray in WORLD space, from the source's `targetRaySpace`. | [xr/types.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
-
| <a id="raydirection"></a> `rayDirection` | `THREE.Vector3` | - | [xr/types.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| <a id="gripposition"></a> `gripPosition` | `THREE.Vector3` \| `null` | Physical grip pose. Null for gaze and transient-pointer, which have no grip. | [xr/types.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="gripquaternion"></a> `gripQuaternion` | `THREE.Quaternion` \| `null` | - | [xr/types.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| <a id="select"></a> `select` | `boolean` | Primary action: controller trigger, hand pinch, or Vision Pro gaze-pinch. | [xr/types.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="selectstart"></a> `selectStart` | `boolean` | - | [xr/types.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="selectend"></a> `selectEnd` | `boolean` | - | [xr/types.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="squeeze"></a> `squeeze` | `boolean` | Secondary action: controller grip squeeze. Never fires for hands/gaze. | [xr/types.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| <a id="squeezestart"></a> `squeezeStart` | `boolean` | - | [xr/types.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
-
| <a id="squeezeend"></a> `squeezeEnd` | `boolean` | - | [xr/types.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
-
| <a id="axes"></a> `axes` | `number`[] | Thumbstick / trackpad axes in [-1, 1]. Empty when [hasAxes](#hasaxes) is false. | [xr/types.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
58
|
-
| <a id="hasaxes"></a> `hasAxes` | `boolean` | True only for sources with a physical stick — gates stick-driven locomotion. | [xr/types.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
-
| <a id="buttons"></a> `buttons` | `boolean`[] | Raw gamepad button pressed-states, when the source exposes a gamepad. | [xr/types.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
-
| <a id="joints"></a> `joints` | [`XrHandJoints`](XrHandJoints.md) \| `null` | Tracked hand joint positions, world space, or null for controllers. Positions only — pose matching is position-based so it works identically against WebXR, a simulator, or a recorded hand. | [xr/types.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
+
| <a id="handedness"></a> `handedness` | [`XrHandedness`](XrHandedness.md) | - | [xr/types.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L45) |
|
|
45
|
+
| <a id="kind"></a> `kind` | [`XrInputKind`](XrInputKind.md) | - | [xr/types.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L46) |
|
|
46
|
+
| <a id="connected"></a> `connected` | `boolean` | False once the source disconnects (a released pinch on Vision Pro). | [xr/types.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L48) |
|
|
47
|
+
| <a id="rayorigin"></a> `rayOrigin` | `THREE.Vector3` | Pointing ray in WORLD space, from the source's `targetRaySpace`. | [xr/types.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L50) |
|
|
48
|
+
| <a id="raydirection"></a> `rayDirection` | `THREE.Vector3` | - | [xr/types.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L51) |
|
|
49
|
+
| <a id="gripposition"></a> `gripPosition` | `THREE.Vector3` \| `null` | Physical grip pose. Null for gaze and transient-pointer, which have no grip. | [xr/types.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L53) |
|
|
50
|
+
| <a id="gripquaternion"></a> `gripQuaternion` | `THREE.Quaternion` \| `null` | - | [xr/types.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L54) |
|
|
51
|
+
| <a id="select"></a> `select` | `boolean` | Primary action: controller trigger, hand pinch, or Vision Pro gaze-pinch. | [xr/types.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L56) |
|
|
52
|
+
| <a id="selectstart"></a> `selectStart` | `boolean` | - | [xr/types.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L57) |
|
|
53
|
+
| <a id="selectend"></a> `selectEnd` | `boolean` | - | [xr/types.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L58) |
|
|
54
|
+
| <a id="squeeze"></a> `squeeze` | `boolean` | Secondary action: controller grip squeeze. Never fires for hands/gaze. | [xr/types.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L60) |
|
|
55
|
+
| <a id="squeezestart"></a> `squeezeStart` | `boolean` | - | [xr/types.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L61) |
|
|
56
|
+
| <a id="squeezeend"></a> `squeezeEnd` | `boolean` | - | [xr/types.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L62) |
|
|
57
|
+
| <a id="axes"></a> `axes` | `number`[] | Thumbstick / trackpad axes in [-1, 1]. Empty when [hasAxes](#hasaxes) is false. | [xr/types.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L64) |
|
|
58
|
+
| <a id="hasaxes"></a> `hasAxes` | `boolean` | True only for sources with a physical stick — gates stick-driven locomotion. | [xr/types.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L66) |
|
|
59
|
+
| <a id="buttons"></a> `buttons` | `boolean`[] | Raw gamepad button pressed-states, when the source exposes a gamepad. | [xr/types.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L68) |
|
|
60
|
+
| <a id="joints"></a> `joints` | [`XrHandJoints`](XrHandJoints.md) \| `null` | Tracked hand joint positions, world space, or null for controllers. Positions only — pose matching is position-based so it works identically against WebXR, a simulator, or a recorded hand. | [xr/types.ts:76](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/types.ts#L76) |
|
|
@@ -16,7 +16,7 @@ type XrPalmPose = {
|
|
|
16
16
|
};
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [xr/handPose.ts:307](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
19
|
+
Defined in: [xr/handPose.ts:307](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L307)
|
|
20
20
|
|
|
21
21
|
An orthonormal frame attached to the palm.
|
|
22
22
|
|
|
@@ -24,8 +24,8 @@ An orthonormal frame attached to the palm.
|
|
|
24
24
|
|
|
25
25
|
| Property | Type | Description | Defined in |
|
|
26
26
|
| ------ | ------ | ------ | ------ |
|
|
27
|
-
| <a id="center"></a> `center` | `THREE.Vector3` | - | [xr/handPose.ts:308](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
-
| <a id="normal"></a> `normal` | `THREE.Vector3` | Outward from the front of the palm. | [xr/handPose.ts:310](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
-
| <a id="right"></a> `right` | `THREE.Vector3` | Across the palm, thumb-ward. | [xr/handPose.ts:312](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
-
| <a id="up"></a> `up` | `THREE.Vector3` | Along the fingers. | [xr/handPose.ts:314](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
-
| <a id="width"></a> `width` | `number` | - | [xr/handPose.ts:315](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
+
| <a id="center"></a> `center` | `THREE.Vector3` | - | [xr/handPose.ts:308](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L308) |
|
|
28
|
+
| <a id="normal"></a> `normal` | `THREE.Vector3` | Outward from the front of the palm. | [xr/handPose.ts:310](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L310) |
|
|
29
|
+
| <a id="right"></a> `right` | `THREE.Vector3` | Across the palm, thumb-ward. | [xr/handPose.ts:312](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L312) |
|
|
30
|
+
| <a id="up"></a> `up` | `THREE.Vector3` | Along the fingers. | [xr/handPose.ts:314](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L314) |
|
|
31
|
+
| <a id="width"></a> `width` | `number` | - | [xr/handPose.ts:315](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L315) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
const ADDED_NODE_MARKER_COMPONENT: "+node" = "+node";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [prefab/nodeKeys.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [prefab/nodeKeys.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/prefab/nodeKeys.ts#L31)
|
|
14
14
|
|
|
15
15
|
Reserved override "component" marking a node ADDED by the host document
|
|
16
16
|
inside a nested instance region (`"<nodeKey>|+node|"`). File patching
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const ARC_GRAVITY: 9.8 = 9.8;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/teleportArc.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/teleportArc.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportArc.ts#L16)
|
|
14
14
|
|
|
15
15
|
Downward acceleration applied to the aim curve, m/s².
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const ARC_MAX_TIME: 2 = 2;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/teleportArc.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/teleportArc.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportArc.ts#L22)
|
|
14
14
|
|
|
15
15
|
Seconds of flight to simulate before giving up on finding ground.
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const ARC_SPEED: 7 = 7;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/teleportArc.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/teleportArc.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportArc.ts#L18)
|
|
14
14
|
|
|
15
15
|
Launch speed of the virtual projectile, m/s. Tuned for ~5-8m reach.
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const ARC_STEPS: 24 = 24;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/teleportArc.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/teleportArc.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/teleportArc.ts#L20)
|
|
14
14
|
|
|
15
15
|
Samples along the curve. Enough to look smooth without wasting raycasts.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const CURLED_COS: 0.55 = 0.55;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/handPose.ts:149](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/handPose.ts:149](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L149)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const DEFAULT_DIRECTION_TOLERANCE: 45 = 45;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/handPose.ts:564](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/handPose.ts:564](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L564)
|
|
14
14
|
|
|
15
15
|
Default cone for per-finger direction constraints.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_ENTER_CONFIDENCE: 0.8 = 0.8;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [xr/handPose.ts:753](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [xr/handPose.ts:753](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L753)
|