@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
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRAnchorSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRAnchorSystem.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XRAnchorSystem.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRAnchorSystem.ts#L55)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ new XRAnchorSystem(): XRAnchorSystem;
|
|
|
32
32
|
update(world, deltaTime?): void;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [systems/XRAnchorSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
+
Defined in: [systems/XRAnchorSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRAnchorSystem.ts#L65)
|
|
36
36
|
|
|
37
37
|
#### Parameters
|
|
38
38
|
|
|
@@ -57,7 +57,7 @@ Defined in: [systems/XRAnchorSystem.ts:65](https://github.com/Relu-Interactives/
|
|
|
57
57
|
isAnchored(entityId): boolean;
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Defined in: [systems/XRAnchorSystem.ts:158](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
+
Defined in: [systems/XRAnchorSystem.ts:158](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRAnchorSystem.ts#L158)
|
|
61
61
|
|
|
62
62
|
Whether this entity's pose is currently being driven by an anchor.
|
|
63
63
|
|
|
@@ -79,7 +79,7 @@ Whether this entity's pose is currently being driven by an anchor.
|
|
|
79
79
|
dispose(): void;
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Defined in: [systems/XRAnchorSystem.ts:224](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
82
|
+
Defined in: [systems/XRAnchorSystem.ts:224](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRAnchorSystem.ts#L224)
|
|
83
83
|
|
|
84
84
|
#### Returns
|
|
85
85
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRControllerVisualSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRControllerVisualSystem.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XRControllerVisualSystem.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRControllerVisualSystem.ts#L53)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [systems/XRControllerVisualSystem.ts:53](https://github.com/Relu-Int
|
|
|
20
20
|
new XRControllerVisualSystem(options?): XRControllerVisualSystem;
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
Defined in: [systems/XRControllerVisualSystem.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
Defined in: [systems/XRControllerVisualSystem.ts:68](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRControllerVisualSystem.ts#L68)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -42,7 +42,7 @@ Defined in: [systems/XRControllerVisualSystem.ts:68](https://github.com/Relu-Int
|
|
|
42
42
|
update(world): void;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [systems/XRControllerVisualSystem.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
45
|
+
Defined in: [systems/XRControllerVisualSystem.ts:79](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRControllerVisualSystem.ts#L79)
|
|
46
46
|
|
|
47
47
|
#### Parameters
|
|
48
48
|
|
|
@@ -66,7 +66,7 @@ Defined in: [systems/XRControllerVisualSystem.ts:79](https://github.com/Relu-Int
|
|
|
66
66
|
dispose(): void;
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [systems/XRControllerVisualSystem.ts:341](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
69
|
+
Defined in: [systems/XRControllerVisualSystem.ts:341](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRControllerVisualSystem.ts#L341)
|
|
70
70
|
|
|
71
71
|
#### Returns
|
|
72
72
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XREnvironmentSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XREnvironmentSystem.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XREnvironmentSystem.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XREnvironmentSystem.ts#L172)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ new XREnvironmentSystem(): XREnvironmentSystem;
|
|
|
32
32
|
update(world, deltaTime?): void;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [systems/XREnvironmentSystem.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
+
Defined in: [systems/XREnvironmentSystem.ts:201](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XREnvironmentSystem.ts#L201)
|
|
36
36
|
|
|
37
37
|
#### Parameters
|
|
38
38
|
|
|
@@ -60,7 +60,7 @@ getDetectedCount(): {
|
|
|
60
60
|
};
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
63
|
+
Defined in: [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XREnvironmentSystem.ts#L329)
|
|
64
64
|
|
|
65
65
|
How many pieces of real geometry are currently colliding. Script-facing.
|
|
66
66
|
|
|
@@ -75,8 +75,8 @@ How many pieces of real geometry are currently colliding. Script-facing.
|
|
|
75
75
|
|
|
76
76
|
| Name | Type | Defined in |
|
|
77
77
|
| ------ | ------ | ------ |
|
|
78
|
-
| `planes` | `number` | [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
79
|
-
| `meshes` | `number` | [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
78
|
+
| `planes` | `number` | [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XREnvironmentSystem.ts#L329) |
|
|
79
|
+
| `meshes` | `number` | [systems/XREnvironmentSystem.ts:329](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XREnvironmentSystem.ts#L329) |
|
|
80
80
|
|
|
81
81
|
***
|
|
82
82
|
|
|
@@ -96,7 +96,7 @@ getDebugSnapshot(world): {
|
|
|
96
96
|
}[];
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Defined in: [systems/XREnvironmentSystem.ts:340](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
99
|
+
Defined in: [systems/XREnvironmentSystem.ts:340](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XREnvironmentSystem.ts#L340)
|
|
100
100
|
|
|
101
101
|
A census of every surface currently spawned: what it is, where it sits and
|
|
102
102
|
roughly how big it is. Built for the template's post-session readout, so a
|
|
@@ -120,7 +120,7 @@ a clean list means whatever was seen did not come from this system.
|
|
|
120
120
|
dispose(world): void;
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
Defined in: [systems/XREnvironmentSystem.ts:911](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
123
|
+
Defined in: [systems/XREnvironmentSystem.ts:911](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XREnvironmentSystem.ts#L911)
|
|
124
124
|
|
|
125
125
|
#### Parameters
|
|
126
126
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRHandPoseSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRHandPoseSystem.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XRHandPoseSystem.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L46)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [systems/XRHandPoseSystem.ts:46](https://github.com/Relu-Interactive
|
|
|
20
20
|
new XRHandPoseSystem(inputSystem): XRHandPoseSystem;
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
Defined in: [systems/XRHandPoseSystem.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
Defined in: [systems/XRHandPoseSystem.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L56)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -40,7 +40,7 @@ Defined in: [systems/XRHandPoseSystem.ts:56](https://github.com/Relu-Interactive
|
|
|
40
40
|
update(world, deltaTime): void;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [systems/XRHandPoseSystem.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
+
Defined in: [systems/XRHandPoseSystem.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L60)
|
|
44
44
|
|
|
45
45
|
#### Parameters
|
|
46
46
|
|
|
@@ -65,7 +65,7 @@ Defined in: [systems/XRHandPoseSystem.ts:60](https://github.com/Relu-Interactive
|
|
|
65
65
|
getHandShape(handedness): XrHandShape | null;
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Defined in: [systems/XRHandPoseSystem.ts:224](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
68
|
+
Defined in: [systems/XRHandPoseSystem.ts:224](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L224)
|
|
69
69
|
|
|
70
70
|
Live shape for a hand — powers the editor's pose readout.
|
|
71
71
|
|
|
@@ -90,7 +90,7 @@ isPoseActive(
|
|
|
90
90
|
handedness): boolean;
|
|
91
91
|
```
|
|
92
92
|
|
|
93
|
-
Defined in: [systems/XRHandPoseSystem.ts:229](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
93
|
+
Defined in: [systems/XRHandPoseSystem.ts:229](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHandPoseSystem.ts#L229)
|
|
94
94
|
|
|
95
95
|
Whether a given entity's pose is currently held.
|
|
96
96
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRHitTestSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRHitTestSystem.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XRHitTestSystem.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHitTestSystem.ts#L57)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ new XRHitTestSystem(): XRHitTestSystem;
|
|
|
32
32
|
update(world): void;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [systems/XRHitTestSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
+
Defined in: [systems/XRHitTestSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHitTestSystem.ts#L65)
|
|
36
36
|
|
|
37
37
|
#### Parameters
|
|
38
38
|
|
|
@@ -56,7 +56,7 @@ Defined in: [systems/XRHitTestSystem.ts:65](https://github.com/Relu-Interactives
|
|
|
56
56
|
getHitResult(target?): XrHitResult | null;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: [systems/XRHitTestSystem.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
+
Defined in: [systems/XRHitTestSystem.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHitTestSystem.ts#L120)
|
|
60
60
|
|
|
61
61
|
Where the given ray meets the real world this frame, or null.
|
|
62
62
|
|
|
@@ -82,7 +82,7 @@ have granted `hit-test` at all.
|
|
|
82
82
|
dispose(): void;
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
Defined in: [systems/XRHitTestSystem.ts:187](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
85
|
+
Defined in: [systems/XRHitTestSystem.ts:187](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHitTestSystem.ts#L187)
|
|
86
86
|
|
|
87
87
|
#### Returns
|
|
88
88
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRHoverVisualSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRHoverVisualSystem.ts:
|
|
9
|
+
Defined in: [systems/XRHoverVisualSystem.ts:49](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHoverVisualSystem.ts#L49)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [systems/XRHoverVisualSystem.ts:48](https://github.com/Relu-Interact
|
|
|
20
20
|
new XRHoverVisualSystem(interactionSystem): XRHoverVisualSystem;
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
Defined in: [systems/XRHoverVisualSystem.ts:
|
|
23
|
+
Defined in: [systems/XRHoverVisualSystem.ts:53](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHoverVisualSystem.ts#L53)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -40,7 +40,7 @@ Defined in: [systems/XRHoverVisualSystem.ts:52](https://github.com/Relu-Interact
|
|
|
40
40
|
update(world, deltaTime): void;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [systems/XRHoverVisualSystem.ts:
|
|
43
|
+
Defined in: [systems/XRHoverVisualSystem.ts:57](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHoverVisualSystem.ts#L57)
|
|
44
44
|
|
|
45
45
|
#### Parameters
|
|
46
46
|
|
|
@@ -65,7 +65,7 @@ Defined in: [systems/XRHoverVisualSystem.ts:56](https://github.com/Relu-Interact
|
|
|
65
65
|
dispose(): void;
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Defined in: [systems/XRHoverVisualSystem.ts:
|
|
68
|
+
Defined in: [systems/XRHoverVisualSystem.ts:250](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRHoverVisualSystem.ts#L250)
|
|
69
69
|
|
|
70
70
|
#### Returns
|
|
71
71
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRInputSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRInputSystem.ts:161](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XRInputSystem.ts:161](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L161)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ new XRInputSystem(): XRInputSystem;
|
|
|
32
32
|
attachSession(session): void;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [systems/XRInputSystem.ts:199](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
+
Defined in: [systems/XRInputSystem.ts:199](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L199)
|
|
36
36
|
|
|
37
37
|
Bind to a session. Called by [XRSessionSystem](XRSessionSystem.md) on session start.
|
|
38
38
|
|
|
@@ -54,7 +54,7 @@ Bind to a session. Called by [XRSessionSystem](XRSessionSystem.md) on session st
|
|
|
54
54
|
detachSession(): void;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [systems/XRInputSystem.ts:212](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
+
Defined in: [systems/XRInputSystem.ts:212](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L212)
|
|
58
58
|
|
|
59
59
|
Unbind and drop all per-source state.
|
|
60
60
|
|
|
@@ -70,7 +70,7 @@ Unbind and drop all per-source state.
|
|
|
70
70
|
update(world): void;
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
Defined in: [systems/XRInputSystem.ts:236](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
73
|
+
Defined in: [systems/XRInputSystem.ts:236](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L236)
|
|
74
74
|
|
|
75
75
|
#### Parameters
|
|
76
76
|
|
|
@@ -94,7 +94,7 @@ Defined in: [systems/XRInputSystem.ts:236](https://github.com/Relu-Interactives/
|
|
|
94
94
|
getInputs(): XrInputState[];
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
-
Defined in: [systems/XRInputSystem.ts:384](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
97
|
+
Defined in: [systems/XRInputSystem.ts:384](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L384)
|
|
98
98
|
|
|
99
99
|
Every input source active this frame.
|
|
100
100
|
|
|
@@ -110,7 +110,7 @@ Every input source active this frame.
|
|
|
110
110
|
getInput(handedness): XrInputState | null;
|
|
111
111
|
```
|
|
112
112
|
|
|
113
|
-
Defined in: [systems/XRInputSystem.ts:389](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
113
|
+
Defined in: [systems/XRInputSystem.ts:389](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L389)
|
|
114
114
|
|
|
115
115
|
The first source for a hand, or null. Prefer this for hand-specific logic.
|
|
116
116
|
|
|
@@ -132,7 +132,7 @@ The first source for a hand, or null. Prefer this for hand-specific logic.
|
|
|
132
132
|
getHandInput(handedness): XrInputState | null;
|
|
133
133
|
```
|
|
134
134
|
|
|
135
|
-
Defined in: [systems/XRInputSystem.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
135
|
+
Defined in: [systems/XRInputSystem.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L407)
|
|
136
136
|
|
|
137
137
|
The ARTICULATED source for a hand — the one carrying joint poses.
|
|
138
138
|
|
|
@@ -162,7 +162,7 @@ ever fired.
|
|
|
162
162
|
isSelecting(): boolean;
|
|
163
163
|
```
|
|
164
164
|
|
|
165
|
-
Defined in: [systems/XRInputSystem.ts:417](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
165
|
+
Defined in: [systems/XRInputSystem.ts:417](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L417)
|
|
166
166
|
|
|
167
167
|
True while ANY source is selecting — the portable "is the user acting" check.
|
|
168
168
|
|
|
@@ -178,7 +178,7 @@ True while ANY source is selecting — the portable "is the user acting" check.
|
|
|
178
178
|
dispose(): void;
|
|
179
179
|
```
|
|
180
180
|
|
|
181
|
-
Defined in: [systems/XRInputSystem.ts:424](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
181
|
+
Defined in: [systems/XRInputSystem.ts:424](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInputSystem.ts#L424)
|
|
182
182
|
|
|
183
183
|
#### Returns
|
|
184
184
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRInteractionSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
9
|
+
Defined in: [systems/XRInteractionSystem.ts:106](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L106)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [systems/XRInteractionSystem.ts:105](https://github.com/Relu-Interac
|
|
|
20
20
|
new XRInteractionSystem(inputSystem): XRInteractionSystem;
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
23
|
+
Defined in: [systems/XRInteractionSystem.ts:122](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L122)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -40,7 +40,7 @@ Defined in: [systems/XRInteractionSystem.ts:121](https://github.com/Relu-Interac
|
|
|
40
40
|
update(world, deltaTime): void;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
43
|
+
Defined in: [systems/XRInteractionSystem.ts:126](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L126)
|
|
44
44
|
|
|
45
45
|
#### Parameters
|
|
46
46
|
|
|
@@ -65,7 +65,7 @@ Defined in: [systems/XRInteractionSystem.ts:125](https://github.com/Relu-Interac
|
|
|
65
65
|
getHoveredEntityId(): number | null;
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
68
|
+
Defined in: [systems/XRInteractionSystem.ts:957](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L957)
|
|
69
69
|
|
|
70
70
|
Entity currently under a pointer this frame, or null.
|
|
71
71
|
|
|
@@ -86,7 +86,7 @@ getHoverFor(handedness):
|
|
|
86
86
|
| null;
|
|
87
87
|
```
|
|
88
88
|
|
|
89
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
89
|
+
Defined in: [systems/XRInteractionSystem.ts:967](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L967)
|
|
90
90
|
|
|
91
91
|
What this hand is pointing at, with the distance to it.
|
|
92
92
|
|
|
@@ -115,7 +115,7 @@ passing through the object.
|
|
|
115
115
|
getHoveredEntityIds(): Set<number>;
|
|
116
116
|
```
|
|
117
117
|
|
|
118
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
118
|
+
Defined in: [systems/XRInteractionSystem.ts:977](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L977)
|
|
119
119
|
|
|
120
120
|
Every entity under a pointer this frame — drives hover feedback.
|
|
121
121
|
|
|
@@ -131,7 +131,7 @@ Every entity under a pointer this frame — drives hover feedback.
|
|
|
131
131
|
getHeldEntityIds(): Set<number>;
|
|
132
132
|
```
|
|
133
133
|
|
|
134
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
134
|
+
Defined in: [systems/XRInteractionSystem.ts:984](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L984)
|
|
135
135
|
|
|
136
136
|
Entities currently held, so hover feedback can skip them.
|
|
137
137
|
|
|
@@ -147,7 +147,7 @@ Entities currently held, so hover feedback can skip them.
|
|
|
147
147
|
isGrabbing(): boolean;
|
|
148
148
|
```
|
|
149
149
|
|
|
150
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
150
|
+
Defined in: [systems/XRInteractionSystem.ts:991](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L991)
|
|
151
151
|
|
|
152
152
|
True when any source is holding something.
|
|
153
153
|
|
|
@@ -163,7 +163,7 @@ True when any source is holding something.
|
|
|
163
163
|
isSourceBusy(world, input): boolean;
|
|
164
164
|
```
|
|
165
165
|
|
|
166
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
166
|
+
Defined in: [systems/XRInteractionSystem.ts:1009](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1009)
|
|
167
167
|
|
|
168
168
|
Whether this input's primary action is committed to interaction.
|
|
169
169
|
|
|
@@ -197,7 +197,7 @@ grabbed and teleported.
|
|
|
197
197
|
registerBusyContributor(contributor): void;
|
|
198
198
|
```
|
|
199
199
|
|
|
200
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
200
|
+
Defined in: [systems/XRInteractionSystem.ts:1040](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1040)
|
|
201
201
|
|
|
202
202
|
OR-ed into isSourceBusy; see the comment there.
|
|
203
203
|
|
|
@@ -224,7 +224,7 @@ getHoverForInput(input):
|
|
|
224
224
|
| null;
|
|
225
225
|
```
|
|
226
226
|
|
|
227
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
227
|
+
Defined in: [systems/XRInteractionSystem.ts:1048](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1048)
|
|
228
228
|
|
|
229
229
|
Hover for a specific input source (handedness-free — Vision Pro's
|
|
230
230
|
transient pointers all report handedness "none").
|
|
@@ -251,7 +251,7 @@ transient pointers all report handedness "none").
|
|
|
251
251
|
isGrabbingWith(handedness): boolean;
|
|
252
252
|
```
|
|
253
253
|
|
|
254
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
254
|
+
Defined in: [systems/XRInteractionSystem.ts:1055](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1055)
|
|
255
255
|
|
|
256
256
|
True when THIS hand is holding something.
|
|
257
257
|
|
|
@@ -281,7 +281,7 @@ getGrabInfo(entityId):
|
|
|
281
281
|
| null;
|
|
282
282
|
```
|
|
283
283
|
|
|
284
|
-
Defined in: [systems/XRInteractionSystem.ts:
|
|
284
|
+
Defined in: [systems/XRInteractionSystem.ts:1070](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1070)
|
|
285
285
|
|
|
286
286
|
How an entity is currently held.
|
|
287
287
|
|
|
@@ -312,11 +312,11 @@ the scale a pull-apart produced. Returns null when nothing holds it.
|
|
|
312
312
|
|
|
313
313
|
| Name | Type | Description | Defined in |
|
|
314
314
|
| ------ | ------ | ------ | ------ |
|
|
315
|
-
| `hands` | `number` | - | [systems/XRInteractionSystem.ts:
|
|
316
|
-
| `primaryHandedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) \| `null` | - | [systems/XRInteractionSystem.ts:
|
|
317
|
-
| `secondaryHandedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) \| `null` | - | [systems/XRInteractionSystem.ts:
|
|
318
|
-
| `handSeparation` | `number` \| `null` | Metres between the hands, or null unless two hands are on it. | [systems/XRInteractionSystem.ts:
|
|
319
|
-
| `attachPointIds` | (`string` \| `null`)[] | The attach point ids in use, in holder order. | [systems/XRInteractionSystem.ts:
|
|
315
|
+
| `hands` | `number` | - | [systems/XRInteractionSystem.ts:1071](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1071) |
|
|
316
|
+
| `primaryHandedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) \| `null` | - | [systems/XRInteractionSystem.ts:1072](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1072) |
|
|
317
|
+
| `secondaryHandedness` | [`XrHandedness`](../type-aliases/XrHandedness.md) \| `null` | - | [systems/XRInteractionSystem.ts:1073](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1073) |
|
|
318
|
+
| `handSeparation` | `number` \| `null` | Metres between the hands, or null unless two hands are on it. | [systems/XRInteractionSystem.ts:1075](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1075) |
|
|
319
|
+
| `attachPointIds` | (`string` \| `null`)[] | The attach point ids in use, in holder order. | [systems/XRInteractionSystem.ts:1077](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRInteractionSystem.ts#L1077) |
|
|
320
320
|
|
|
321
321
|
***
|
|
322
322
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRLocomotionSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRLocomotionSystem.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XRLocomotionSystem.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRLocomotionSystem.ts#L34)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [systems/XRLocomotionSystem.ts:34](https://github.com/Relu-Interacti
|
|
|
20
20
|
new XRLocomotionSystem(inputSystem): XRLocomotionSystem;
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
Defined in: [systems/XRLocomotionSystem.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
Defined in: [systems/XRLocomotionSystem.ts:69](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRLocomotionSystem.ts#L69)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -40,7 +40,7 @@ Defined in: [systems/XRLocomotionSystem.ts:69](https://github.com/Relu-Interacti
|
|
|
40
40
|
setInteractionSystem(interactionSystem): void;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [systems/XRLocomotionSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
+
Defined in: [systems/XRLocomotionSystem.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRLocomotionSystem.ts#L65)
|
|
44
44
|
|
|
45
45
|
Wire the interaction system so grabs suppress teleport on that hand.
|
|
46
46
|
|
|
@@ -62,7 +62,7 @@ Wire the interaction system so grabs suppress teleport on that hand.
|
|
|
62
62
|
update(world, deltaTime): void;
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
Defined in: [systems/XRLocomotionSystem.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
65
|
+
Defined in: [systems/XRLocomotionSystem.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRLocomotionSystem.ts#L73)
|
|
66
66
|
|
|
67
67
|
#### Parameters
|
|
68
68
|
|
|
@@ -87,7 +87,7 @@ Defined in: [systems/XRLocomotionSystem.ts:73](https://github.com/Relu-Interacti
|
|
|
87
87
|
getAimCurve(): Vector3[];
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
-
Defined in: [systems/XRLocomotionSystem.ts:397](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
90
|
+
Defined in: [systems/XRLocomotionSystem.ts:397](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRLocomotionSystem.ts#L397)
|
|
91
91
|
|
|
92
92
|
Arc points up to the landing spot this frame; empty when not aiming.
|
|
93
93
|
|
|
@@ -103,7 +103,7 @@ Arc points up to the landing spot this frame; empty when not aiming.
|
|
|
103
103
|
isAimValid(): boolean;
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
Defined in: [systems/XRLocomotionSystem.ts:402](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
106
|
+
Defined in: [systems/XRLocomotionSystem.ts:402](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRLocomotionSystem.ts#L402)
|
|
107
107
|
|
|
108
108
|
True when the aim lands on a valid teleport area.
|
|
109
109
|
|
|
@@ -119,7 +119,7 @@ True when the aim lands on a valid teleport area.
|
|
|
119
119
|
getLandingPoint(): Vector3 | null;
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
Defined in: [systems/XRLocomotionSystem.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
122
|
+
Defined in: [systems/XRLocomotionSystem.ts:407](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRLocomotionSystem.ts#L407)
|
|
123
123
|
|
|
124
124
|
Where the arc currently lands, or null when not aiming at a valid area.
|
|
125
125
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRSessionSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRSessionSystem.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XRSessionSystem.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRSessionSystem.ts#L28)
|
|
10
10
|
|
|
11
11
|
Owns the immersive-session lifecycle and fans XR events out to Behaviours.
|
|
12
12
|
|
|
@@ -31,7 +31,7 @@ AR extend `Behaviour` the same way.
|
|
|
31
31
|
new XRSessionSystem(inputSystem?): XRSessionSystem;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [systems/XRSessionSystem.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
34
|
+
Defined in: [systems/XRSessionSystem.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRSessionSystem.ts#L37)
|
|
35
35
|
|
|
36
36
|
#### Parameters
|
|
37
37
|
|
|
@@ -51,7 +51,7 @@ Defined in: [systems/XRSessionSystem.ts:37](https://github.com/Relu-Interactives
|
|
|
51
51
|
update(world): void;
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Defined in: [systems/XRSessionSystem.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
+
Defined in: [systems/XRSessionSystem.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRSessionSystem.ts#L41)
|
|
55
55
|
|
|
56
56
|
#### Parameters
|
|
57
57
|
|
|
@@ -75,7 +75,7 @@ Defined in: [systems/XRSessionSystem.ts:41](https://github.com/Relu-Interactives
|
|
|
75
75
|
getCapabilities(): XrCapabilities;
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Defined in: [systems/XRSessionSystem.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
78
|
+
Defined in: [systems/XRSessionSystem.ts:246](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRSessionSystem.ts#L246)
|
|
79
79
|
|
|
80
80
|
What the active session granted. `NO_XR_CAPABILITIES` when not presenting.
|
|
81
81
|
|
|
@@ -91,7 +91,7 @@ What the active session granted. `NO_XR_CAPABILITIES` when not presenting.
|
|
|
91
91
|
isPresenting(): boolean;
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
-
Defined in: [systems/XRSessionSystem.ts:251](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
94
|
+
Defined in: [systems/XRSessionSystem.ts:251](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRSessionSystem.ts#L251)
|
|
95
95
|
|
|
96
96
|
True while an immersive session is presenting.
|
|
97
97
|
|
|
@@ -107,7 +107,7 @@ True while an immersive session is presenting.
|
|
|
107
107
|
getInputs(): XrInputState[];
|
|
108
108
|
```
|
|
109
109
|
|
|
110
|
-
Defined in: [systems/XRSessionSystem.ts:256](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
110
|
+
Defined in: [systems/XRSessionSystem.ts:256](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRSessionSystem.ts#L256)
|
|
111
111
|
|
|
112
112
|
Convenience passthrough so consumers need only hold this system.
|
|
113
113
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: XRTeleportVisualSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/XRTeleportVisualSystem.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/XRTeleportVisualSystem.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRTeleportVisualSystem.ts#L37)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ Defined in: [systems/XRTeleportVisualSystem.ts:37](https://github.com/Relu-Inter
|
|
|
20
20
|
new XRTeleportVisualSystem(locomotionSystem): XRTeleportVisualSystem;
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
Defined in: [systems/XRTeleportVisualSystem.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
23
|
+
Defined in: [systems/XRTeleportVisualSystem.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRTeleportVisualSystem.ts#L59)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -40,7 +40,7 @@ Defined in: [systems/XRTeleportVisualSystem.ts:59](https://github.com/Relu-Inter
|
|
|
40
40
|
update(world): void;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [systems/XRTeleportVisualSystem.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
43
|
+
Defined in: [systems/XRTeleportVisualSystem.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRTeleportVisualSystem.ts#L75)
|
|
44
44
|
|
|
45
45
|
#### Parameters
|
|
46
46
|
|
|
@@ -64,7 +64,7 @@ Defined in: [systems/XRTeleportVisualSystem.ts:75](https://github.com/Relu-Inter
|
|
|
64
64
|
dispose(): void;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [systems/XRTeleportVisualSystem.ts:264](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
67
|
+
Defined in: [systems/XRTeleportVisualSystem.ts:264](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/XRTeleportVisualSystem.ts#L264)
|
|
68
68
|
|
|
69
69
|
#### Returns
|
|
70
70
|
|
|
@@ -13,7 +13,7 @@ function angularVelocityFrom(
|
|
|
13
13
|
deltaTime): Vector3;
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Defined in: [xr/throwVelocity.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
16
|
+
Defined in: [xr/throwVelocity.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/throwVelocity.ts#L116)
|
|
17
17
|
|
|
18
18
|
Angular velocity from a rotation delta, as an axis-angle vector (rad/s).
|
|
19
19
|
|