@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
|
@@ -26,7 +26,7 @@ type XRRigOptions = {
|
|
|
26
26
|
};
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [components/XRRig.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
29
|
+
Defined in: [components/XRRig.ts:36](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L36)
|
|
30
30
|
|
|
31
31
|
Optional initializer for [XRRigComponent](../classes/XRRigComponent.md).
|
|
32
32
|
|
|
@@ -34,18 +34,18 @@ Optional initializer for [XRRigComponent](../classes/XRRigComponent.md).
|
|
|
34
34
|
|
|
35
35
|
| Property | Type | Description | Defined in |
|
|
36
36
|
| ------ | ------ | ------ | ------ |
|
|
37
|
-
| <a id="trackingorigin"></a> `trackingOrigin?` | [`XrTrackingOrigin`](XrTrackingOrigin.md) | Where the headset origin sits. Defaults to `floor`. | [components/XRRig.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
-
| <a id="locomotion"></a> `locomotion?` | [`XrLocomotionMode`](XrLocomotionMode.md) | Movement style. Defaults to `teleport` — the most comfort-safe option. | [components/XRRig.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
-
| <a id="movespeed"></a> `moveSpeed?` | `number` | Metres/second for `smooth` locomotion. | [components/XRRig.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| <a id="snapturn"></a> `snapTurn?` | `boolean` | Rotate in fixed steps instead of continuously (greatly reduces nausea). | [components/XRRig.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| <a id="snapturndegrees"></a> `snapTurnDegrees?` | `number` | Degrees per snap-turn step. | [components/XRRig.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
42
|
-
| <a id="fallbackeyeheight"></a> `fallbackEyeHeight?` | `number` | Height in metres used when the device reports no floor-relative space. | [components/XRRig.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
-
| <a id="teleportarccolor"></a> `teleportArcColor?` | `string` | Teleport arc colour when it lands somewhere valid. | [components/XRRig.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
-
| <a id="teleportarcinvalidcolor"></a> `teleportArcInvalidColor?` | `string` | Teleport arc colour when it lands nowhere teleportable. | [components/XRRig.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| <a id="teleportarcthickness"></a> `teleportArcThickness?` | `number` | Teleport arc thickness (diameter), metres. | [components/XRRig.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| <a id="passthrough"></a> `passthrough?` | `boolean` | Run the session in passthrough (`immersive-ar`) instead of VR. | [components/XRRig.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
-
| <a id="depthocclusion"></a> `depthOcclusion?` | `boolean` | Let real objects occlude virtual ones, via WebXR depth sensing. | [components/XRRig.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
-
| <a id="environmentphysics"></a> `environmentPhysics?` | [`XrEnvironmentPhysics`](XrEnvironmentPhysics.md) | Which detected real-world geometry becomes physics colliders. | [components/XRRig.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| <a id="environmentdebug"></a> `environmentDebug?` | `boolean` | Draw the detected room geometry on-device, for checking a scan. | [components/XRRig.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="hittest"></a> `hitTest?` | `boolean` | Allow scripts to raycast against the real room (`hit-test`). | [components/XRRig.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| <a id="anchors"></a> `anchors?` | `boolean` | Allow content to be pinned to real-world features (`anchors`). | [components/XRRig.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
37
|
+
| <a id="trackingorigin"></a> `trackingOrigin?` | [`XrTrackingOrigin`](XrTrackingOrigin.md) | Where the headset origin sits. Defaults to `floor`. | [components/XRRig.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L38) |
|
|
38
|
+
| <a id="locomotion"></a> `locomotion?` | [`XrLocomotionMode`](XrLocomotionMode.md) | Movement style. Defaults to `teleport` — the most comfort-safe option. | [components/XRRig.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L40) |
|
|
39
|
+
| <a id="movespeed"></a> `moveSpeed?` | `number` | Metres/second for `smooth` locomotion. | [components/XRRig.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L42) |
|
|
40
|
+
| <a id="snapturn"></a> `snapTurn?` | `boolean` | Rotate in fixed steps instead of continuously (greatly reduces nausea). | [components/XRRig.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L44) |
|
|
41
|
+
| <a id="snapturndegrees"></a> `snapTurnDegrees?` | `number` | Degrees per snap-turn step. | [components/XRRig.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L46) |
|
|
42
|
+
| <a id="fallbackeyeheight"></a> `fallbackEyeHeight?` | `number` | Height in metres used when the device reports no floor-relative space. | [components/XRRig.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L48) |
|
|
43
|
+
| <a id="teleportarccolor"></a> `teleportArcColor?` | `string` | Teleport arc colour when it lands somewhere valid. | [components/XRRig.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L50) |
|
|
44
|
+
| <a id="teleportarcinvalidcolor"></a> `teleportArcInvalidColor?` | `string` | Teleport arc colour when it lands nowhere teleportable. | [components/XRRig.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L52) |
|
|
45
|
+
| <a id="teleportarcthickness"></a> `teleportArcThickness?` | `number` | Teleport arc thickness (diameter), metres. | [components/XRRig.ts:54](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L54) |
|
|
46
|
+
| <a id="passthrough"></a> `passthrough?` | `boolean` | Run the session in passthrough (`immersive-ar`) instead of VR. | [components/XRRig.ts:58](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L58) |
|
|
47
|
+
| <a id="depthocclusion"></a> `depthOcclusion?` | `boolean` | Let real objects occlude virtual ones, via WebXR depth sensing. | [components/XRRig.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L60) |
|
|
48
|
+
| <a id="environmentphysics"></a> `environmentPhysics?` | [`XrEnvironmentPhysics`](XrEnvironmentPhysics.md) | Which detected real-world geometry becomes physics colliders. | [components/XRRig.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L62) |
|
|
49
|
+
| <a id="environmentdebug"></a> `environmentDebug?` | `boolean` | Draw the detected room geometry on-device, for checking a scan. | [components/XRRig.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L64) |
|
|
50
|
+
| <a id="hittest"></a> `hitTest?` | `boolean` | Allow scripts to raycast against the real room (`hit-test`). | [components/XRRig.ts:66](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L66) |
|
|
51
|
+
| <a id="anchors"></a> `anchors?` | `boolean` | Allow content to be pinned to real-world features (`anchors`). | [components/XRRig.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L68) |
|
|
@@ -25,7 +25,7 @@ type XrAttachPoint = {
|
|
|
25
25
|
};
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [components/XRInteractable.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
+
Defined in: [components/XRInteractable.ts:40](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L40)
|
|
29
29
|
|
|
30
30
|
A hand-hold authored on the object.
|
|
31
31
|
|
|
@@ -39,15 +39,15 @@ matter which hand arrives first.
|
|
|
39
39
|
|
|
40
40
|
| Property | Type | Description | Defined in |
|
|
41
41
|
| ------ | ------ | ------ | ------ |
|
|
42
|
-
| <a id="id"></a> `id` | `string` | Stable id; referenced by scripts and by the inspector list. | [components/XRInteractable.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
-
| <a id="name"></a> `name` | `string` | - | [components/XRInteractable.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
-
| <a id="position"></a> `position` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Object-local position of the hold (unscaled). | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| `position.x` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| `position.y` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
-
| `position.z` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
-
| <a id="rotation"></a> `rotation` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Object-local orientation of the hold, radians. | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| `rotation.x` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| `rotation.y` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| `rotation.z` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="hand"></a> `hand` | `"left"` \| `"right"` \| `"any"` | Restrict to one hand, or `any`. | [components/XRInteractable.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="role"></a> `role` | `"primary"` \| `"secondary"` \| `"any"` | Whether this hold is the anchoring hand, the steering hand, or either. | [components/XRInteractable.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
42
|
+
| <a id="id"></a> `id` | `string` | Stable id; referenced by scripts and by the inspector list. | [components/XRInteractable.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L42) |
|
|
43
|
+
| <a id="name"></a> `name` | `string` | - | [components/XRInteractable.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L43) |
|
|
44
|
+
| <a id="position"></a> `position` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Object-local position of the hold (unscaled). | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L45) |
|
|
45
|
+
| `position.x` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L45) |
|
|
46
|
+
| `position.y` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L45) |
|
|
47
|
+
| `position.z` | `number` | - | [components/XRInteractable.ts:45](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L45) |
|
|
48
|
+
| <a id="rotation"></a> `rotation` | \{ `x`: `number`; `y`: `number`; `z`: `number`; \} | Object-local orientation of the hold, radians. | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L47) |
|
|
49
|
+
| `rotation.x` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L47) |
|
|
50
|
+
| `rotation.y` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L47) |
|
|
51
|
+
| `rotation.z` | `number` | - | [components/XRInteractable.ts:47](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L47) |
|
|
52
|
+
| <a id="hand"></a> `hand` | `"left"` \| `"right"` \| `"any"` | Restrict to one hand, or `any`. | [components/XRInteractable.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L49) |
|
|
53
|
+
| <a id="role"></a> `role` | `"primary"` \| `"secondary"` \| `"any"` | Whether this hold is the anchoring hand, the steering hand, or either. | [components/XRInteractable.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L51) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrDistanceGrabBehavior = "snap" | "remote";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRInteractable.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRInteractable.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L20)
|
|
14
14
|
|
|
15
15
|
What a distance grab does to the object.
|
|
16
16
|
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type XrEnvironmentKind = "plane" | "mesh";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XREnvironment.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XREnvironment.ts:4](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XREnvironment.ts#L4)
|
|
14
14
|
|
|
15
15
|
Which WebXR module reported this piece of the room.
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type XrEnvironmentOrientation = "horizontal" | "vertical";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XREnvironment.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XREnvironment.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XREnvironment.ts#L7)
|
|
14
14
|
|
|
15
15
|
How a detected plane sits in the world, when the runtime says.
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrEnvironmentPhysics = "none" | "planes" | "mesh" | "auto";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRRig.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRRig.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L33)
|
|
14
14
|
|
|
15
15
|
Which real-world geometry becomes physics colliders in a passthrough session.
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrGrabGesture = "any" | "pinch" | "full";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRInteractable.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRInteractable.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L29)
|
|
14
14
|
|
|
15
15
|
Which gesture grabs the object.
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrGrabHands = "single" | "handOff" | "two";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRInteractable.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRInteractable.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L62)
|
|
14
14
|
|
|
15
15
|
How many hands may hold the object at once, and what a second grab does.
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrGrabReach = "physical" | "distance" | "both";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRInteractable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRInteractable.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L11)
|
|
14
14
|
|
|
15
15
|
How close the user must be to grab.
|
|
16
16
|
|
|
@@ -23,7 +23,7 @@ type XrHandPoseEntry = {
|
|
|
23
23
|
};
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [components/XRHandPose.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
26
|
+
Defined in: [components/XRHandPose.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L18)
|
|
27
27
|
|
|
28
28
|
One pose an entity listens for.
|
|
29
29
|
|
|
@@ -36,14 +36,14 @@ what the author dialled in.
|
|
|
36
36
|
|
|
37
37
|
| Property | Type | Description | Defined in |
|
|
38
38
|
| ------ | ------ | ------ | ------ |
|
|
39
|
-
| <a id="id"></a> `id` | `string` | Stable id, unique within the component. Used in Behaviour hooks. | [components/XRHandPose.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
40
|
-
| <a id="name"></a> `name` | `string` | Shown in the inspector and passed to scripts. | [components/XRHandPose.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
41
|
-
| <a id="preset"></a> `preset` | `string` \| `null` | Preset id, or null for a custom pose. | [components/XRHandPose.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
42
|
-
| <a id="curls"></a> `curls` | `Record`\<[`XrFinger`](../../index/type-aliases/XrFinger.md), `number`\> | Per-finger curl targets, 0 extended → 1 curled. Custom poses only. | [components/XRHandPose.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
-
| <a id="tolerance"></a> `tolerance` | `number` | Slack around each curl target. Larger is easier to perform. | [components/XRHandPose.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
44
|
-
| <a id="directions"></a> `directions` | `Record`\<[`XrFinger`](../../index/type-aliases/XrFinger.md), [`XrHandPoseDirection`](../../index/type-aliases/XrHandPoseDirection.md)[]\> | Directions each finger may point. Empty means the finger may point anywhere. Any ONE listed direction satisfies the finger, mirroring fingerpose's `addDirection` — "thumb up OR diagonally up" is one pose, not two. | [components/XRHandPose.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
-
| <a id="directiontolerance"></a> `directionTolerance` | `number` | How far a finger may point from an accepted direction, in degrees. | [components/XRHandPose.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
46
|
-
| <a id="hand"></a> `hand` | `"left"` \| `"right"` \| `null` | Which hand may trigger it; null for either. | [components/XRHandPose.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
-
| <a id="orientation"></a> `orientation` | \| [`XrHandPoseOrientation`](../../index/type-aliases/XrHandPoseOrientation.md) \| `null` | Optional direction requirement. | [components/XRHandPose.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
-
| <a id="minholdseconds"></a> `minHoldSeconds` | `number` | Seconds the pose must be held before it fires. | [components/XRHandPose.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| <a id="enabled"></a> `enabled` | `boolean` | - | [components/XRHandPose.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
39
|
+
| <a id="id"></a> `id` | `string` | Stable id, unique within the component. Used in Behaviour hooks. | [components/XRHandPose.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L20) |
|
|
40
|
+
| <a id="name"></a> `name` | `string` | Shown in the inspector and passed to scripts. | [components/XRHandPose.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L22) |
|
|
41
|
+
| <a id="preset"></a> `preset` | `string` \| `null` | Preset id, or null for a custom pose. | [components/XRHandPose.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L24) |
|
|
42
|
+
| <a id="curls"></a> `curls` | `Record`\<[`XrFinger`](../../index/type-aliases/XrFinger.md), `number`\> | Per-finger curl targets, 0 extended → 1 curled. Custom poses only. | [components/XRHandPose.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L26) |
|
|
43
|
+
| <a id="tolerance"></a> `tolerance` | `number` | Slack around each curl target. Larger is easier to perform. | [components/XRHandPose.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L28) |
|
|
44
|
+
| <a id="directions"></a> `directions` | `Record`\<[`XrFinger`](../../index/type-aliases/XrFinger.md), [`XrHandPoseDirection`](../../index/type-aliases/XrHandPoseDirection.md)[]\> | Directions each finger may point. Empty means the finger may point anywhere. Any ONE listed direction satisfies the finger, mirroring fingerpose's `addDirection` — "thumb up OR diagonally up" is one pose, not two. | [components/XRHandPose.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L35) |
|
|
45
|
+
| <a id="directiontolerance"></a> `directionTolerance` | `number` | How far a finger may point from an accepted direction, in degrees. | [components/XRHandPose.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L37) |
|
|
46
|
+
| <a id="hand"></a> `hand` | `"left"` \| `"right"` \| `null` | Which hand may trigger it; null for either. | [components/XRHandPose.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L39) |
|
|
47
|
+
| <a id="orientation"></a> `orientation` | \| [`XrHandPoseOrientation`](../../index/type-aliases/XrHandPoseOrientation.md) \| `null` | Optional direction requirement. | [components/XRHandPose.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L41) |
|
|
48
|
+
| <a id="minholdseconds"></a> `minHoldSeconds` | `number` | Seconds the pose must be held before it fires. | [components/XRHandPose.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L43) |
|
|
49
|
+
| <a id="enabled"></a> `enabled` | `boolean` | - | [components/XRHandPose.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L44) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrHandPreset = "default" | "ghost" | "neon" | "skeleton" | "custom";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRInteractor.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRInteractor.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L30)
|
|
14
14
|
|
|
15
15
|
Look applied to tracked-hand meshes.
|
|
16
16
|
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type XrInteractorSide = "left" | "right";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRInteractor.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRInteractor.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L38)
|
|
14
14
|
|
|
15
15
|
Which hand a child interactor entity follows.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
type XrInteractorType = "hands" | "controllers" | "both" | "none";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRInteractor.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRInteractor.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractor.ts#L21)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type XrLocomotionMode = "teleport" | "smooth" | "none";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRRig.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRRig.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L18)
|
|
14
14
|
|
|
15
15
|
How the player moves through the scene in an immersive session.
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
type XrTrackingOrigin = "floor" | "eye";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRRig.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRRig.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRRig.ts#L15)
|
|
14
14
|
|
|
15
15
|
Where the headset's origin sits in the scene.
|
|
16
16
|
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
type XrTwoHandRotation = "align" | "primary";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRInteractable.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRInteractable.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRInteractable.ts#L65)
|
|
14
14
|
|
|
15
15
|
How the second hand affects orientation. See `solveTwoHandTransform`.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_COLLIDER_STATE: ColliderState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L135)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const DEFAULT_ENVIRONMENT_LIGHTING: Required<EnvironmentLightingState>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Environment.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L109)
|
|
14
14
|
|
|
15
15
|
Defaults for every [EnvironmentLightingState](../type-aliases/EnvironmentLightingState.md) field.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_ENVIRONMENT_STATE: EnvironmentState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Environment.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Environment.ts#L142)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const DEFAULT_INSTANCED_MESH_PARAMETERS: Record<InstancedMeshKind, MeshGeometryParameters>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/InstancedMesh.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/InstancedMesh.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L41)
|
|
14
14
|
|
|
15
15
|
Default geometry parameters per instanced mesh kind. For "model" kind, cube params are stored as a placeholder (unused).
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const DEFAULT_INSTANCE_TRANSFORM: InstanceTransform;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/InstancedMesh.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/InstancedMesh.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/InstancedMesh.ts#L34)
|
|
14
14
|
|
|
15
15
|
Default identity instance transform.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_MESH_GEOMETRY_PARAMETERS: MeshGeometryParametersByKind;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/MeshGeometry.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/MeshGeometry.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/MeshGeometry.ts#L62)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_PHYSICS_STATE: PhysicsState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L172)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_POSE_CURLS: Record<XrFinger, number>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRHandPose.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRHandPose.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L52)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_POSE_DIRECTIONS: Record<XrFinger, XrHandPoseDirection[]>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/XRHandPose.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/XRHandPose.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/XRHandPose.ts#L60)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_POSTPROCESSING_STATE: PostprocessingState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Postprocessing.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Postprocessing.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Postprocessing.ts#L142)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_RIGIDBODY_STATE: RigidbodyState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Physics.ts#L59)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const MODEL_NO_PATH_MESSAGE: "No model path set." = "No model path set.";
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Model.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Model.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/components/Model.ts#L9)
|
|
14
14
|
|
|
15
15
|
Message used when a model entity has no asset path to load.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: AnimationStateMachine
|
|
8
8
|
|
|
9
|
-
Defined in: [AnimationStateMachine.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [AnimationStateMachine.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L24)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -25,7 +25,7 @@ new AnimationStateMachine(
|
|
|
25
25
|
clipId?): AnimationStateMachine;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
+
Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L33)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -45,12 +45,12 @@ Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/r
|
|
|
45
45
|
|
|
46
46
|
| Property | Type | Default value | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="name"></a> `name` | `string` | `undefined` | [AnimationStateMachine.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| <a id="clip"></a> `clip` | `AnimationClip` | `undefined` | [AnimationStateMachine.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="clipid"></a> `clipId` | `string` \| `null` | `undefined` | [AnimationStateMachine.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| <a id="loop"></a> `loop` | `boolean` | `undefined` | [AnimationStateMachine.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="isplaying"></a> `isPlaying` | `boolean` | `false` | [AnimationStateMachine.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="ispaused"></a> `isPaused` | `boolean` | `false` | [AnimationStateMachine.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
+
| <a id="name"></a> `name` | `string` | `undefined` | [AnimationStateMachine.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L25) |
|
|
49
|
+
| <a id="clip"></a> `clip` | `AnimationClip` | `undefined` | [AnimationStateMachine.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L26) |
|
|
50
|
+
| <a id="clipid"></a> `clipId` | `string` \| `null` | `undefined` | [AnimationStateMachine.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L27) |
|
|
51
|
+
| <a id="loop"></a> `loop` | `boolean` | `undefined` | [AnimationStateMachine.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L28) |
|
|
52
|
+
| <a id="isplaying"></a> `isPlaying` | `boolean` | `false` | [AnimationStateMachine.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L29) |
|
|
53
|
+
| <a id="ispaused"></a> `isPaused` | `boolean` | `false` | [AnimationStateMachine.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L30) |
|
|
54
54
|
|
|
55
55
|
## Methods
|
|
56
56
|
|
|
@@ -60,7 +60,7 @@ Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/r
|
|
|
60
60
|
setCallbacks(callbacks): void;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: [AnimationStateMachine.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
63
|
+
Defined in: [AnimationStateMachine.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L51)
|
|
64
64
|
|
|
65
65
|
#### Parameters
|
|
66
66
|
|
|
@@ -80,7 +80,7 @@ Defined in: [AnimationStateMachine.ts:51](https://github.com/Relu-Interactives/r
|
|
|
80
80
|
setLoop(loop): void;
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
Defined in: [AnimationStateMachine.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
83
|
+
Defined in: [AnimationStateMachine.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L59)
|
|
84
84
|
|
|
85
85
|
#### Parameters
|
|
86
86
|
|
|
@@ -100,7 +100,7 @@ Defined in: [AnimationStateMachine.ts:59](https://github.com/Relu-Interactives/r
|
|
|
100
100
|
onStart(): void;
|
|
101
101
|
```
|
|
102
102
|
|
|
103
|
-
Defined in: [AnimationStateMachine.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
103
|
+
Defined in: [AnimationStateMachine.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L63)
|
|
104
104
|
|
|
105
105
|
#### Returns
|
|
106
106
|
|
|
@@ -118,7 +118,7 @@ Defined in: [AnimationStateMachine.ts:63](https://github.com/Relu-Interactives/r
|
|
|
118
118
|
onPlaying(): void;
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
Defined in: [AnimationStateMachine.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
121
|
+
Defined in: [AnimationStateMachine.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L67)
|
|
122
122
|
|
|
123
123
|
#### Returns
|
|
124
124
|
|
|
@@ -136,7 +136,7 @@ Defined in: [AnimationStateMachine.ts:67](https://github.com/Relu-Interactives/r
|
|
|
136
136
|
onEnd(): void;
|
|
137
137
|
```
|
|
138
138
|
|
|
139
|
-
Defined in: [AnimationStateMachine.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
139
|
+
Defined in: [AnimationStateMachine.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L71)
|
|
140
140
|
|
|
141
141
|
#### Returns
|
|
142
142
|
|
|
@@ -154,7 +154,7 @@ Defined in: [AnimationStateMachine.ts:71](https://github.com/Relu-Interactives/r
|
|
|
154
154
|
play(): void;
|
|
155
155
|
```
|
|
156
156
|
|
|
157
|
-
Defined in: [AnimationStateMachine.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
157
|
+
Defined in: [AnimationStateMachine.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L75)
|
|
158
158
|
|
|
159
159
|
#### Returns
|
|
160
160
|
|
|
@@ -172,7 +172,7 @@ Defined in: [AnimationStateMachine.ts:75](https://github.com/Relu-Interactives/r
|
|
|
172
172
|
pause(): void;
|
|
173
173
|
```
|
|
174
174
|
|
|
175
|
-
Defined in: [AnimationStateMachine.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
175
|
+
Defined in: [AnimationStateMachine.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L87)
|
|
176
176
|
|
|
177
177
|
#### Returns
|
|
178
178
|
|
|
@@ -190,7 +190,7 @@ Defined in: [AnimationStateMachine.ts:87](https://github.com/Relu-Interactives/r
|
|
|
190
190
|
stop(): void;
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
Defined in: [AnimationStateMachine.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
193
|
+
Defined in: [AnimationStateMachine.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L96)
|
|
194
194
|
|
|
195
195
|
#### Returns
|
|
196
196
|
|