@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: AnimationStateManager
|
|
8
8
|
|
|
9
|
-
Defined in: [AnimationStateMachine.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [AnimationStateMachine.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L107)
|
|
10
10
|
|
|
11
11
|
## Constructors
|
|
12
12
|
|
|
@@ -28,7 +28,7 @@ new AnimationStateManager(): AnimationStateManager;
|
|
|
28
28
|
addState(state): AnimationStateMachine;
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Defined in: [AnimationStateMachine.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
+
Defined in: [AnimationStateMachine.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L111)
|
|
32
32
|
|
|
33
33
|
#### Parameters
|
|
34
34
|
|
|
@@ -53,7 +53,7 @@ createState(
|
|
|
53
53
|
clipId?): AnimationStateMachine;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [AnimationStateMachine.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
+
Defined in: [AnimationStateMachine.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L116)
|
|
57
57
|
|
|
58
58
|
#### Parameters
|
|
59
59
|
|
|
@@ -77,7 +77,7 @@ Defined in: [AnimationStateMachine.ts:116](https://github.com/Relu-Interactives/
|
|
|
77
77
|
removeState(name): boolean;
|
|
78
78
|
```
|
|
79
79
|
|
|
80
|
-
Defined in: [AnimationStateMachine.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
80
|
+
Defined in: [AnimationStateMachine.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L128)
|
|
81
81
|
|
|
82
82
|
#### Parameters
|
|
83
83
|
|
|
@@ -97,7 +97,7 @@ Defined in: [AnimationStateMachine.ts:128](https://github.com/Relu-Interactives/
|
|
|
97
97
|
getState(name): AnimationStateMachine | null;
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
-
Defined in: [AnimationStateMachine.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
100
|
+
Defined in: [AnimationStateMachine.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L142)
|
|
101
101
|
|
|
102
102
|
#### Parameters
|
|
103
103
|
|
|
@@ -117,7 +117,7 @@ Defined in: [AnimationStateMachine.ts:142](https://github.com/Relu-Interactives/
|
|
|
117
117
|
hasState(name): boolean;
|
|
118
118
|
```
|
|
119
119
|
|
|
120
|
-
Defined in: [AnimationStateMachine.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
120
|
+
Defined in: [AnimationStateMachine.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L146)
|
|
121
121
|
|
|
122
122
|
#### Parameters
|
|
123
123
|
|
|
@@ -137,7 +137,7 @@ Defined in: [AnimationStateMachine.ts:146](https://github.com/Relu-Interactives/
|
|
|
137
137
|
listStates(): AnimationStateMachine[];
|
|
138
138
|
```
|
|
139
139
|
|
|
140
|
-
Defined in: [AnimationStateMachine.ts:150](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
140
|
+
Defined in: [AnimationStateMachine.ts:150](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L150)
|
|
141
141
|
|
|
142
142
|
#### Returns
|
|
143
143
|
|
|
@@ -151,7 +151,7 @@ Defined in: [AnimationStateMachine.ts:150](https://github.com/Relu-Interactives/
|
|
|
151
151
|
getActiveState(): AnimationStateMachine | null;
|
|
152
152
|
```
|
|
153
153
|
|
|
154
|
-
Defined in: [AnimationStateMachine.ts:154](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
154
|
+
Defined in: [AnimationStateMachine.ts:154](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L154)
|
|
155
155
|
|
|
156
156
|
#### Returns
|
|
157
157
|
|
|
@@ -165,7 +165,7 @@ Defined in: [AnimationStateMachine.ts:154](https://github.com/Relu-Interactives/
|
|
|
165
165
|
switchState(name, autoPlay?): AnimationStateMachine | null;
|
|
166
166
|
```
|
|
167
167
|
|
|
168
|
-
Defined in: [AnimationStateMachine.ts:158](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
168
|
+
Defined in: [AnimationStateMachine.ts:158](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L158)
|
|
169
169
|
|
|
170
170
|
#### Parameters
|
|
171
171
|
|
|
@@ -186,7 +186,7 @@ Defined in: [AnimationStateMachine.ts:158](https://github.com/Relu-Interactives/
|
|
|
186
186
|
playState(name?): boolean;
|
|
187
187
|
```
|
|
188
188
|
|
|
189
|
-
Defined in: [AnimationStateMachine.ts:176](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
189
|
+
Defined in: [AnimationStateMachine.ts:176](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L176)
|
|
190
190
|
|
|
191
191
|
#### Parameters
|
|
192
192
|
|
|
@@ -206,7 +206,7 @@ Defined in: [AnimationStateMachine.ts:176](https://github.com/Relu-Interactives/
|
|
|
206
206
|
pauseState(name?): boolean;
|
|
207
207
|
```
|
|
208
208
|
|
|
209
|
-
Defined in: [AnimationStateMachine.ts:187](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
209
|
+
Defined in: [AnimationStateMachine.ts:187](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L187)
|
|
210
210
|
|
|
211
211
|
#### Parameters
|
|
212
212
|
|
|
@@ -226,7 +226,7 @@ Defined in: [AnimationStateMachine.ts:187](https://github.com/Relu-Interactives/
|
|
|
226
226
|
stopState(name?): boolean;
|
|
227
227
|
```
|
|
228
228
|
|
|
229
|
-
Defined in: [AnimationStateMachine.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
229
|
+
Defined in: [AnimationStateMachine.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L197)
|
|
230
230
|
|
|
231
231
|
#### Parameters
|
|
232
232
|
|
|
@@ -246,7 +246,7 @@ Defined in: [AnimationStateMachine.ts:197](https://github.com/Relu-Interactives/
|
|
|
246
246
|
clear(): void;
|
|
247
247
|
```
|
|
248
248
|
|
|
249
|
-
Defined in: [AnimationStateMachine.ts:210](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
249
|
+
Defined in: [AnimationStateMachine.ts:210](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/AnimationStateMachine.ts#L210)
|
|
250
250
|
|
|
251
251
|
#### Returns
|
|
252
252
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: AnimationSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/AnimationSystem.ts:
|
|
9
|
+
Defined in: [systems/AnimationSystem.ts:284](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AnimationSystem.ts#L284)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ new AnimationSystem(): AnimationSystem;
|
|
|
32
32
|
update(world, deltaTime): void;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [systems/AnimationSystem.ts:
|
|
35
|
+
Defined in: [systems/AnimationSystem.ts:411](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AnimationSystem.ts#L411)
|
|
36
36
|
|
|
37
37
|
#### Parameters
|
|
38
38
|
|
|
@@ -57,7 +57,7 @@ Defined in: [systems/AnimationSystem.ts:422](https://github.com/Relu-Interactive
|
|
|
57
57
|
dispose(): void;
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Defined in: [systems/AnimationSystem.ts:
|
|
60
|
+
Defined in: [systems/AnimationSystem.ts:538](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AnimationSystem.ts#L538)
|
|
61
61
|
|
|
62
62
|
#### Returns
|
|
63
63
|
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / AudioMixer
|
|
6
|
+
|
|
7
|
+
# Class: AudioMixer
|
|
8
|
+
|
|
9
|
+
Defined in: [audio/AudioMixer.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L17)
|
|
10
|
+
|
|
11
|
+
The volume groups every sound plays through: each sound's output goes to its
|
|
12
|
+
bus instead of straight to the listener, so a game can turn music down
|
|
13
|
+
without touching a single sound, and music dips while a voice plays.
|
|
14
|
+
|
|
15
|
+
## Constructors
|
|
16
|
+
|
|
17
|
+
### Constructor
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
new AudioMixer(listener): AudioMixer;
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Defined in: [audio/AudioMixer.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L26)
|
|
24
|
+
|
|
25
|
+
#### Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type |
|
|
28
|
+
| ------ | ------ |
|
|
29
|
+
| `listener` | `AudioListener` |
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
`AudioMixer`
|
|
34
|
+
|
|
35
|
+
## Properties
|
|
36
|
+
|
|
37
|
+
| Property | Modifier | Type | Defined in |
|
|
38
|
+
| ------ | ------ | ------ | ------ |
|
|
39
|
+
| <a id="listener"></a> `listener` | `readonly` | `AudioListener` | [audio/AudioMixer.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L26) |
|
|
40
|
+
|
|
41
|
+
## Methods
|
|
42
|
+
|
|
43
|
+
### input()
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
input(bus): GainNode;
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Defined in: [audio/AudioMixer.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L37)
|
|
50
|
+
|
|
51
|
+
The node a sound connects to for this bus.
|
|
52
|
+
|
|
53
|
+
#### Parameters
|
|
54
|
+
|
|
55
|
+
| Parameter | Type |
|
|
56
|
+
| ------ | ------ |
|
|
57
|
+
| `bus` | [`AudioBus`](../type-aliases/AudioBus.md) |
|
|
58
|
+
|
|
59
|
+
#### Returns
|
|
60
|
+
|
|
61
|
+
`GainNode`
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
65
|
+
### route()
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
route(sound, bus): void;
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Defined in: [audio/AudioMixer.ts:42](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L42)
|
|
72
|
+
|
|
73
|
+
Send a three.js sound through a bus. Does nothing when it's already there.
|
|
74
|
+
|
|
75
|
+
#### Parameters
|
|
76
|
+
|
|
77
|
+
| Parameter | Type |
|
|
78
|
+
| ------ | ------ |
|
|
79
|
+
| `sound` | `Audio`\<`GainNode`\> \| `PositionalAudio` |
|
|
80
|
+
| `bus` | [`AudioBus`](../type-aliases/AudioBus.md) |
|
|
81
|
+
|
|
82
|
+
#### Returns
|
|
83
|
+
|
|
84
|
+
`void`
|
|
85
|
+
|
|
86
|
+
***
|
|
87
|
+
|
|
88
|
+
### setVolume()
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
setVolume(bus, volume): void;
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Defined in: [audio/AudioMixer.ts:50](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L50)
|
|
95
|
+
|
|
96
|
+
#### Parameters
|
|
97
|
+
|
|
98
|
+
| Parameter | Type |
|
|
99
|
+
| ------ | ------ |
|
|
100
|
+
| `bus` | [`AudioBus`](../type-aliases/AudioBus.md) |
|
|
101
|
+
| `volume` | `number` |
|
|
102
|
+
|
|
103
|
+
#### Returns
|
|
104
|
+
|
|
105
|
+
`void`
|
|
106
|
+
|
|
107
|
+
***
|
|
108
|
+
|
|
109
|
+
### getVolume()
|
|
110
|
+
|
|
111
|
+
```ts
|
|
112
|
+
getVolume(bus): number;
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Defined in: [audio/AudioMixer.ts:56](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L56)
|
|
116
|
+
|
|
117
|
+
#### Parameters
|
|
118
|
+
|
|
119
|
+
| Parameter | Type |
|
|
120
|
+
| ------ | ------ |
|
|
121
|
+
| `bus` | [`AudioBus`](../type-aliases/AudioBus.md) |
|
|
122
|
+
|
|
123
|
+
#### Returns
|
|
124
|
+
|
|
125
|
+
`number`
|
|
126
|
+
|
|
127
|
+
***
|
|
128
|
+
|
|
129
|
+
### duckMusic()
|
|
130
|
+
|
|
131
|
+
```ts
|
|
132
|
+
duckMusic(seconds): void;
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Defined in: [audio/AudioMixer.ts:61](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L61)
|
|
136
|
+
|
|
137
|
+
Dip the music for `seconds`, then bring it back. A later duck replaces this one.
|
|
138
|
+
|
|
139
|
+
#### Parameters
|
|
140
|
+
|
|
141
|
+
| Parameter | Type |
|
|
142
|
+
| ------ | ------ |
|
|
143
|
+
| `seconds` | `number` |
|
|
144
|
+
|
|
145
|
+
#### Returns
|
|
146
|
+
|
|
147
|
+
`void`
|
|
148
|
+
|
|
149
|
+
***
|
|
150
|
+
|
|
151
|
+
### dispose()
|
|
152
|
+
|
|
153
|
+
```ts
|
|
154
|
+
dispose(): void;
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Defined in: [audio/AudioMixer.ts:70](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/audio/AudioMixer.ts#L70)
|
|
158
|
+
|
|
159
|
+
#### Returns
|
|
160
|
+
|
|
161
|
+
`void`
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: AudioSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/AudioSystem.ts:
|
|
9
|
+
Defined in: [systems/AudioSystem.ts:77](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L77)
|
|
10
10
|
|
|
11
11
|
Reconciles `AudioComponent` state with the underlying THREE.js audio objects
|
|
12
12
|
each frame.
|
|
@@ -20,6 +20,12 @@ audio node based on the `isPlaying` / `isPaused` flags set by
|
|
|
20
20
|
Changes take effect on the next frame, so scripts and inspector edits during
|
|
21
21
|
runtime are reflected without reloading the scene.
|
|
22
22
|
|
|
23
|
+
**Mixing** — every sound plays through a bus (`sfx`, `voice`, `music`) with
|
|
24
|
+
its own volume, and music dips while a voice plays.
|
|
25
|
+
|
|
26
|
+
**Sound banks** — [loadSoundBank](#loadsoundbank) and [playSlot](#playslot) play named
|
|
27
|
+
sounds from a `.soundbank.json` asset, as a random take.
|
|
28
|
+
|
|
23
29
|
Only active in **preview** mode (`isEditor: true` makes every update a
|
|
24
30
|
no-op so the editor is unaffected).
|
|
25
31
|
|
|
@@ -35,7 +41,7 @@ no-op so the editor is unaffected).
|
|
|
35
41
|
new AudioSystem(__namedParameters?): AudioSystem;
|
|
36
42
|
```
|
|
37
43
|
|
|
38
|
-
Defined in: [systems/AudioSystem.ts:
|
|
44
|
+
Defined in: [systems/AudioSystem.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L92)
|
|
39
45
|
|
|
40
46
|
#### Parameters
|
|
41
47
|
|
|
@@ -50,13 +56,141 @@ Defined in: [systems/AudioSystem.ts:55](https://github.com/Relu-Interactives/rel
|
|
|
50
56
|
|
|
51
57
|
## Methods
|
|
52
58
|
|
|
59
|
+
### attachWorld()
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
attachWorld(world): void;
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Defined in: [systems/AudioSystem.ts:97](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L97)
|
|
66
|
+
|
|
67
|
+
Scripts can load a bank in `init`, before this system's first update.
|
|
68
|
+
|
|
69
|
+
#### Parameters
|
|
70
|
+
|
|
71
|
+
| Parameter | Type |
|
|
72
|
+
| ------ | ------ |
|
|
73
|
+
| `world` | [`World`](World.md) |
|
|
74
|
+
|
|
75
|
+
#### Returns
|
|
76
|
+
|
|
77
|
+
`void`
|
|
78
|
+
|
|
79
|
+
***
|
|
80
|
+
|
|
81
|
+
### getMixer()
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
getMixer(): AudioMixer | null;
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Defined in: [systems/AudioSystem.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L102)
|
|
88
|
+
|
|
89
|
+
The mixer, made with the listener on first use.
|
|
90
|
+
|
|
91
|
+
#### Returns
|
|
92
|
+
|
|
93
|
+
[`AudioMixer`](AudioMixer.md) \| `null`
|
|
94
|
+
|
|
95
|
+
***
|
|
96
|
+
|
|
97
|
+
### setBusVolume()
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
setBusVolume(bus, volume): void;
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Defined in: [systems/AudioSystem.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L111)
|
|
104
|
+
|
|
105
|
+
Set a bus's volume (`0` silent, `1` as mixed).
|
|
106
|
+
|
|
107
|
+
#### Parameters
|
|
108
|
+
|
|
109
|
+
| Parameter | Type |
|
|
110
|
+
| ------ | ------ |
|
|
111
|
+
| `bus` | [`AudioBus`](../type-aliases/AudioBus.md) |
|
|
112
|
+
| `volume` | `number` |
|
|
113
|
+
|
|
114
|
+
#### Returns
|
|
115
|
+
|
|
116
|
+
`void`
|
|
117
|
+
|
|
118
|
+
***
|
|
119
|
+
|
|
120
|
+
### getBusVolume()
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
getBusVolume(bus): number;
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Defined in: [systems/AudioSystem.ts:115](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L115)
|
|
127
|
+
|
|
128
|
+
#### Parameters
|
|
129
|
+
|
|
130
|
+
| Parameter | Type |
|
|
131
|
+
| ------ | ------ |
|
|
132
|
+
| `bus` | [`AudioBus`](../type-aliases/AudioBus.md) |
|
|
133
|
+
|
|
134
|
+
#### Returns
|
|
135
|
+
|
|
136
|
+
`number`
|
|
137
|
+
|
|
138
|
+
***
|
|
139
|
+
|
|
140
|
+
### loadSoundBank()
|
|
141
|
+
|
|
142
|
+
```ts
|
|
143
|
+
loadSoundBank(source): Promise<void>;
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Defined in: [systems/AudioSystem.ts:124](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L124)
|
|
147
|
+
|
|
148
|
+
Fetch a `.soundbank.json` and decode its recordings. Its slots add to any
|
|
149
|
+
loaded before, and a slot id used twice takes the later one.
|
|
150
|
+
|
|
151
|
+
#### Parameters
|
|
152
|
+
|
|
153
|
+
| Parameter | Type | Description |
|
|
154
|
+
| ------ | ------ | ------ |
|
|
155
|
+
| `source` | \| `string` \| \{ `path`: `string`; \} | an asset path, or a script's `AssetInput` field |
|
|
156
|
+
|
|
157
|
+
#### Returns
|
|
158
|
+
|
|
159
|
+
`Promise`\<`void`\>
|
|
160
|
+
|
|
161
|
+
***
|
|
162
|
+
|
|
163
|
+
### playSlot()
|
|
164
|
+
|
|
165
|
+
```ts
|
|
166
|
+
playSlot(id, options?): boolean;
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
Defined in: [systems/AudioSystem.ts:148](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L148)
|
|
170
|
+
|
|
171
|
+
Play a named sound from a loaded bank. Returns whether it sounded: a slot's
|
|
172
|
+
chance, cooldown and priority can each keep it quiet, and that's normal.
|
|
173
|
+
|
|
174
|
+
#### Parameters
|
|
175
|
+
|
|
176
|
+
| Parameter | Type |
|
|
177
|
+
| ------ | ------ |
|
|
178
|
+
| `id` | `string` |
|
|
179
|
+
| `options` | [`PlaySlotOptions`](../type-aliases/PlaySlotOptions.md) |
|
|
180
|
+
|
|
181
|
+
#### Returns
|
|
182
|
+
|
|
183
|
+
`boolean`
|
|
184
|
+
|
|
185
|
+
***
|
|
186
|
+
|
|
53
187
|
### update()
|
|
54
188
|
|
|
55
189
|
```ts
|
|
56
190
|
update(world, _deltaTime): void;
|
|
57
191
|
```
|
|
58
192
|
|
|
59
|
-
Defined in: [systems/AudioSystem.ts:
|
|
193
|
+
Defined in: [systems/AudioSystem.ts:193](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L193)
|
|
60
194
|
|
|
61
195
|
#### Parameters
|
|
62
196
|
|
|
@@ -81,7 +215,7 @@ Defined in: [systems/AudioSystem.ts:59](https://github.com/Relu-Interactives/rel
|
|
|
81
215
|
dispose(_world): void;
|
|
82
216
|
```
|
|
83
217
|
|
|
84
|
-
Defined in: [systems/AudioSystem.ts:
|
|
218
|
+
Defined in: [systems/AudioSystem.ts:320](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/AudioSystem.ts#L320)
|
|
85
219
|
|
|
86
220
|
#### Parameters
|
|
87
221
|
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / BoneHoldSystem
|
|
6
|
+
|
|
7
|
+
# Class: BoneHoldSystem
|
|
8
|
+
|
|
9
|
+
Defined in: [systems/BoneHoldSystem.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/BoneHoldSystem.ts#L15)
|
|
10
|
+
|
|
11
|
+
Applies each [BoneAttachmentComponent](../../components/classes/BoneAttachmentComponent.md)'s `holds` for the clip its
|
|
12
|
+
character is playing: which bone it rides, where, and whether it shows.
|
|
13
|
+
Runs after the animation and before IK, so a hand can reach for something
|
|
14
|
+
that just moved to a new hold.
|
|
15
|
+
|
|
16
|
+
## Implements
|
|
17
|
+
|
|
18
|
+
- [`EcsSystem`](../interfaces/EcsSystem.md)
|
|
19
|
+
|
|
20
|
+
## Constructors
|
|
21
|
+
|
|
22
|
+
### Constructor
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
new BoneHoldSystem(): BoneHoldSystem;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
#### Returns
|
|
29
|
+
|
|
30
|
+
`BoneHoldSystem`
|
|
31
|
+
|
|
32
|
+
## Methods
|
|
33
|
+
|
|
34
|
+
### update()
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
update(world): void;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: [systems/BoneHoldSystem.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/BoneHoldSystem.ts#L16)
|
|
41
|
+
|
|
42
|
+
#### Parameters
|
|
43
|
+
|
|
44
|
+
| Parameter | Type |
|
|
45
|
+
| ------ | ------ |
|
|
46
|
+
| `world` | [`World`](World.md) |
|
|
47
|
+
|
|
48
|
+
#### Returns
|
|
49
|
+
|
|
50
|
+
`void`
|
|
51
|
+
|
|
52
|
+
#### Implementation of
|
|
53
|
+
|
|
54
|
+
[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: CameraSyncSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/CameraSyncSystem.ts:115](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/CameraSyncSystem.ts:115](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/CameraSyncSystem.ts#L115)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ new CameraSyncSystem(): CameraSyncSystem;
|
|
|
32
32
|
update(world): void;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [systems/CameraSyncSystem.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
+
Defined in: [systems/CameraSyncSystem.ts:118](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/CameraSyncSystem.ts#L118)
|
|
36
36
|
|
|
37
37
|
#### Parameters
|
|
38
38
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: EnvironmentSyncSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/EnvironmentSyncSystem.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/EnvironmentSyncSystem.ts:120](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/EnvironmentSyncSystem.ts#L120)
|
|
10
10
|
|
|
11
11
|
Applies the scene's [Environment](../../components/classes/Environment.md) component to the three.js scene:
|
|
12
12
|
skybox, fog, and (when `values.lighting` is present) image-based lighting,
|
|
@@ -35,7 +35,7 @@ to `scene.environment` as is and the renderer prefilters it.
|
|
|
35
35
|
new EnvironmentSyncSystem(scene): EnvironmentSyncSystem;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [systems/EnvironmentSyncSystem.ts:154](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
+
Defined in: [systems/EnvironmentSyncSystem.ts:154](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/EnvironmentSyncSystem.ts#L154)
|
|
39
39
|
|
|
40
40
|
#### Parameters
|
|
41
41
|
|
|
@@ -55,7 +55,7 @@ Defined in: [systems/EnvironmentSyncSystem.ts:154](https://github.com/Relu-Inter
|
|
|
55
55
|
update(world): void;
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
Defined in: [systems/EnvironmentSyncSystem.ts:481](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
58
|
+
Defined in: [systems/EnvironmentSyncSystem.ts:481](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/EnvironmentSyncSystem.ts#L481)
|
|
59
59
|
|
|
60
60
|
#### Parameters
|
|
61
61
|
|
|
@@ -79,7 +79,7 @@ Defined in: [systems/EnvironmentSyncSystem.ts:481](https://github.com/Relu-Inter
|
|
|
79
79
|
dispose(): void;
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Defined in: [systems/EnvironmentSyncSystem.ts:539](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
82
|
+
Defined in: [systems/EnvironmentSyncSystem.ts:539](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/systems/EnvironmentSyncSystem.ts#L539)
|
|
83
83
|
|
|
84
84
|
#### Returns
|
|
85
85
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: HandPoseTracker
|
|
8
8
|
|
|
9
|
-
Defined in: [xr/handPose.ts:771](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [xr/handPose.ts:771](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L771)
|
|
10
10
|
|
|
11
11
|
Turns a stream of per-frame confidences into clean start/end events.
|
|
12
12
|
|
|
@@ -28,7 +28,7 @@ hands drop out for a frame or two constantly at the edge of the camera FOV.
|
|
|
28
28
|
new HandPoseTracker(options?): HandPoseTracker;
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Defined in: [xr/handPose.ts:781](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
+
Defined in: [xr/handPose.ts:781](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L781)
|
|
32
32
|
|
|
33
33
|
#### Parameters
|
|
34
34
|
|
|
@@ -48,7 +48,7 @@ Defined in: [xr/handPose.ts:781](https://github.com/Relu-Interactives/relu-spati
|
|
|
48
48
|
isActive(): boolean;
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
Defined in: [xr/handPose.ts:792](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
+
Defined in: [xr/handPose.ts:792](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L792)
|
|
52
52
|
|
|
53
53
|
#### Returns
|
|
54
54
|
|
|
@@ -62,7 +62,7 @@ Defined in: [xr/handPose.ts:792](https://github.com/Relu-Interactives/relu-spati
|
|
|
62
62
|
update(confidence, now): XrHandPoseEvent;
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
Defined in: [xr/handPose.ts:797](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
65
|
+
Defined in: [xr/handPose.ts:797](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L797)
|
|
66
66
|
|
|
67
67
|
Feed this frame's confidence. Returns an event on a transition.
|
|
68
68
|
|
|
@@ -85,7 +85,7 @@ Feed this frame's confidence. Returns an event on a transition.
|
|
|
85
85
|
miss(now): XrHandPoseEvent;
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
-
Defined in: [xr/handPose.ts:823](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
88
|
+
Defined in: [xr/handPose.ts:823](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L823)
|
|
89
89
|
|
|
90
90
|
Feed a frame where the hand isn't tracked at all.
|
|
91
91
|
|
|
@@ -107,7 +107,7 @@ Feed a frame where the hand isn't tracked at all.
|
|
|
107
107
|
reset(): void;
|
|
108
108
|
```
|
|
109
109
|
|
|
110
|
-
Defined in: [xr/handPose.ts:835](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
110
|
+
Defined in: [xr/handPose.ts:835](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/1f58a477b3cb6564276f2cb1b267d20fd5344345/core/xr/handPose.ts#L835)
|
|
111
111
|
|
|
112
112
|
#### Returns
|
|
113
113
|
|