@relu-interactives/spatial-ecs 0.5.3 → 0.9.0
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-V_mv07le.d.cts → System-8D-XBDKZ.d.cts} +734 -8
- package/dist/{System-V_mv07le.d.ts → System-DPMAW30g.d.ts} +734 -8
- package/dist/{XRHandPose-CU3vNFuS.d.ts → XRHandPose-CWSrsnYN.d.ts} +236 -3
- package/dist/{XRHandPose-CQTLGxFC.d.cts → XRHandPose-Dn2yiALk.d.cts} +236 -3
- package/dist/animation/index.cjs +252 -0
- package/dist/animation/index.cjs.map +1 -0
- package/dist/animation/index.d.cts +100 -0
- package/dist/animation/index.d.ts +100 -0
- package/dist/animation/index.js +4 -0
- package/dist/animation/index.js.map +1 -0
- package/dist/chunk-CKTHDXPS.js +11 -0
- package/dist/chunk-CKTHDXPS.js.map +1 -0
- package/dist/chunk-GSWC6LLD.js +241 -0
- package/dist/chunk-GSWC6LLD.js.map +1 -0
- package/dist/chunk-JEPUCLZX.js +1237 -0
- package/dist/chunk-JEPUCLZX.js.map +1 -0
- package/dist/{chunk-BUEKOSR5.js → chunk-JNYPJB55.js} +435 -14
- package/dist/chunk-JNYPJB55.js.map +1 -0
- package/dist/{chunk-RXBLOO5B.js → chunk-NXASMBDS.js} +105 -715
- package/dist/chunk-NXASMBDS.js.map +1 -0
- package/dist/chunk-OHCNPPMX.js +334 -0
- package/dist/chunk-OHCNPPMX.js.map +1 -0
- package/dist/{chunk-DF5SSRN6.js → chunk-VYIWOXAY.js} +2574 -3381
- package/dist/chunk-VYIWOXAY.js.map +1 -0
- package/dist/chunk-WWP46AEF.js +2878 -0
- package/dist/chunk-WWP46AEF.js.map +1 -0
- package/dist/{chunk-OY7ZODZP.js → chunk-XE4OXN2W.js} +3 -9
- package/dist/chunk-XE4OXN2W.js.map +1 -0
- package/dist/{chunk-OWQSESTO.js → chunk-XU2DVWCP.js} +4 -3
- package/dist/chunk-XU2DVWCP.js.map +1 -0
- package/dist/components/index.cjs +334 -10
- package/dist/components/index.cjs.map +1 -1
- package/dist/components/index.d.cts +5 -3
- package/dist/components/index.d.ts +5 -3
- package/dist/components/index.js +3 -2
- package/dist/docs/api/Behaviour/classes/Behaviour.md +366 -79
- package/dist/docs/api/Behaviour/index.md +7 -3
- package/dist/docs/api/Behaviour/type-aliases/UiInteractionEvent.md +35 -0
- package/dist/docs/api/Component/classes/Component.md +14 -1
- package/dist/docs/api/components/classes/AnimationComponent.md +26 -26
- package/dist/docs/api/components/classes/AudioComponent.md +19 -19
- package/dist/docs/api/components/classes/CameraComponent.md +14 -14
- package/dist/docs/api/components/classes/EntityType.md +4 -4
- package/dist/docs/api/components/classes/Environment.md +5 -4
- package/dist/docs/api/components/classes/ImageComponent.md +7 -7
- package/dist/docs/api/components/classes/ImageTarget.md +8 -8
- 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 +16 -16
- 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 +8 -5
- package/dist/docs/api/components/classes/Name.md +3 -3
- 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 -6
- 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 +63 -0
- package/dist/docs/api/components/classes/UIPanelComponent.md +62 -0
- package/dist/docs/api/components/classes/UISliderComponent.md +59 -0
- package/dist/docs/api/components/classes/UITextComponent.md +59 -0
- package/dist/docs/api/components/classes/UIToggleComponent.md +56 -0
- package/dist/docs/api/components/classes/VRTeleportAreaComponent.md +53 -0
- package/dist/docs/api/components/classes/VideoComponent.md +28 -28
- package/dist/docs/api/components/classes/XRAnchorComponent.md +64 -0
- package/dist/docs/api/components/classes/XREnvironmentComponent.md +64 -0
- package/dist/docs/api/components/classes/XRHandPoseComponent.md +50 -0
- package/dist/docs/api/components/classes/XRInteractableComponent.md +74 -0
- package/dist/docs/api/components/classes/XRInteractorComponent.md +57 -0
- package/dist/docs/api/components/classes/XRInteractorSideComponent.md +50 -0
- package/dist/docs/api/components/classes/XRRigComponent.md +68 -0
- package/dist/docs/api/components/functions/createAttachPoint.md +25 -0
- package/dist/docs/api/components/functions/createHandPoseEntry.md +25 -0
- package/dist/docs/api/components/functions/defaultMaterialValue.md +1 -1
- package/dist/docs/api/components/functions/handPoseDefinitionFor.md +33 -0
- package/dist/docs/api/components/functions/normalizeEnvironmentLighting.md +30 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +1 -1
- package/dist/docs/api/components/functions/setModelLoadState.md +33 -0
- package/dist/docs/api/components/functions/setPhysicsLiveRef.md +3 -9
- package/dist/docs/api/components/index.md +61 -4
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +9 -9
- 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 +5 -3
- 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 +40 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxImageProjection.md +22 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +9 -7
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +1 -1
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +7 -5
- package/dist/docs/api/components/type-aliases/EnvironmentToneMapping.md +16 -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 +37 -0
- package/dist/docs/api/components/type-aliases/LightValueState.md +13 -11
- 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 +15 -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 +45 -0
- package/dist/docs/api/components/type-aliases/UIPanelOptions.md +39 -0
- package/dist/docs/api/components/type-aliases/UISliderOptions.md +39 -0
- package/dist/docs/api/components/type-aliases/UITextOptions.md +41 -0
- package/dist/docs/api/components/type-aliases/UIToggleOptions.md +35 -0
- package/dist/docs/api/components/type-aliases/UiFollowMode.md +15 -0
- package/dist/docs/api/components/type-aliases/UiTextAlign.md +13 -0
- package/dist/docs/api/components/type-aliases/UiTextVAlign.md +13 -0
- package/dist/docs/api/components/type-aliases/VRTeleportAreaOptions.md +29 -0
- package/dist/docs/api/components/type-aliases/Vec3.md +4 -4
- package/dist/docs/api/components/type-aliases/VrTeleportShape.md +15 -0
- package/dist/docs/api/components/type-aliases/XRAnchorOptions.md +23 -0
- package/dist/docs/api/components/type-aliases/XRHandPoseOptions.md +23 -0
- package/dist/docs/api/components/type-aliases/XRInteractableOptions.md +75 -0
- package/dist/docs/api/components/type-aliases/XRInteractorOptions.md +37 -0
- package/dist/docs/api/components/type-aliases/XRRigOptions.md +51 -0
- package/dist/docs/api/components/type-aliases/XrAttachPoint.md +53 -0
- package/dist/docs/api/components/type-aliases/XrDistanceGrabBehavior.md +19 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentKind.md +15 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentOrientation.md +15 -0
- package/dist/docs/api/components/type-aliases/XrEnvironmentPhysics.md +25 -0
- package/dist/docs/api/components/type-aliases/XrGrabGesture.md +19 -0
- package/dist/docs/api/components/type-aliases/XrGrabHands.md +20 -0
- package/dist/docs/api/components/type-aliases/XrGrabReach.md +20 -0
- package/dist/docs/api/components/type-aliases/XrHandPoseEntry.md +49 -0
- package/dist/docs/api/components/type-aliases/XrHandPreset.md +19 -0
- package/dist/docs/api/components/type-aliases/XrInteractorSide.md +15 -0
- package/dist/docs/api/components/type-aliases/XrInteractorType.md +13 -0
- package/dist/docs/api/components/type-aliases/XrLocomotionMode.md +15 -0
- package/dist/docs/api/components/type-aliases/XrTrackingOrigin.md +24 -0
- package/dist/docs/api/components/type-aliases/XrTwoHandRotation.md +15 -0
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +1 -1
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_LIGHTING.md +15 -0
- 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 +13 -0
- package/dist/docs/api/components/variables/DEFAULT_POSE_DIRECTIONS.md +13 -0
- 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 +15 -0
- 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/AudioSystem.md +4 -4
- package/dist/docs/api/index/classes/CameraSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +19 -4
- package/dist/docs/api/index/classes/HandPoseTracker.md +114 -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 +14 -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 +34 -10
- package/dist/docs/api/index/classes/RenderSystem.md +13 -4
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +9 -5
- 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/TeleportAimGate.md +114 -0
- package/dist/docs/api/index/classes/ThrowVelocityTracker.md +89 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +2 -2
- package/dist/docs/api/index/classes/UIInteractionSystem.md +60 -0
- package/dist/docs/api/index/classes/UIPanelSystem.md +79 -0
- package/dist/docs/api/index/classes/VRTeleportAreaSystem.md +49 -0
- package/dist/docs/api/index/classes/VideoSystem.md +8 -6
- package/dist/docs/api/index/classes/World.md +282 -100
- package/dist/docs/api/index/classes/XRAnchorSystem.md +90 -0
- package/dist/docs/api/index/classes/XRControllerVisualSystem.md +77 -0
- package/dist/docs/api/index/classes/XREnvironmentSystem.md +137 -0
- package/dist/docs/api/index/classes/XRHandPoseSystem.md +107 -0
- package/dist/docs/api/index/classes/XRHitTestSystem.md +93 -0
- package/dist/docs/api/index/classes/XRHoverVisualSystem.md +76 -0
- package/dist/docs/api/index/classes/XRInputSystem.md +189 -0
- package/dist/docs/api/index/classes/XRInteractionSystem.md +323 -0
- package/dist/docs/api/index/classes/XRLocomotionSystem.md +128 -0
- package/dist/docs/api/index/classes/XRSessionSystem.md +116 -0
- package/dist/docs/api/index/classes/XRTeleportVisualSystem.md +75 -0
- package/dist/docs/api/index/functions/angularVelocityFrom.md +33 -0
- package/dist/docs/api/index/functions/applyHandMaterial.md +26 -0
- package/dist/docs/api/index/functions/applyPrefabToSnapshotInstances.md +1 -1
- package/dist/docs/api/index/functions/arcGroundCrossing.md +30 -0
- 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 +23 -0
- 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 +29 -0
- package/dist/docs/api/index/functions/computeHandShape.md +29 -0
- package/dist/docs/api/index/functions/computeInstanceOverrides.md +1 -1
- package/dist/docs/api/index/functions/computePalmPose.md +30 -0
- package/dist/docs/api/index/functions/computePalmWidth.md +25 -0
- package/dist/docs/api/index/functions/computePinch.md +29 -0
- package/dist/docs/api/index/functions/computeSpread.md +33 -0
- 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/createCameraComponent.md +1 -1
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +2 -2
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +1 -1
- package/dist/docs/api/index/functions/createHandMaterial.md +30 -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 +2 -2
- 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 +2 -2
- package/dist/docs/api/index/functions/createMaterialComponent.md +2 -2
- 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/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 +28 -0
- package/dist/docs/api/index/functions/createUIPanelComponent.md +28 -0
- package/dist/docs/api/index/functions/createUISliderComponent.md +28 -0
- package/dist/docs/api/index/functions/createUITextComponent.md +28 -0
- package/dist/docs/api/index/functions/createUIToggleComponent.md +28 -0
- package/dist/docs/api/index/functions/createVRTeleportAreaComponent.md +28 -0
- package/dist/docs/api/index/functions/createVideoComponent.md +1 -1
- package/dist/docs/api/index/functions/createXRAnchorComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRHandPoseComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractableComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractorComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRInteractorSideComponent.md +28 -0
- package/dist/docs/api/index/functions/createXRRigComponent.md +28 -0
- 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 +28 -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 +31 -0
- package/dist/docs/api/index/functions/groupOverridePaths.md +1 -1
- package/dist/docs/api/index/functions/handPoseFromCurls.md +42 -0
- 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/loadPrefab.md +1 -1
- package/dist/docs/api/index/functions/loadSharedGltf.md +1 -1
- package/dist/docs/api/index/functions/matchHandPose.md +34 -0
- 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 +30 -0
- 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 +40 -0
- 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/spawnPrefab.md +1 -1
- package/dist/docs/api/index/index.md +116 -4
- package/dist/docs/api/index/interfaces/ChromaKeyOptions.md +20 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +3 -3
- package/dist/docs/api/index/interfaces/PostprocessingBuildContext.md +21 -0
- package/dist/docs/api/index/interfaces/PostprocessingPipeline.md +84 -0
- package/dist/docs/api/index/interfaces/RenderBackend.md +168 -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/ComponentFactory.md +1 -1
- package/dist/docs/api/index/type-aliases/ComponentValueMaps.md +50 -26
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +14 -2
- package/dist/docs/api/index/type-aliases/EcsRenderer.md +17 -0
- 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 +32 -0
- package/dist/docs/api/index/type-aliases/HandPoseTrackerOptions.md +27 -0
- 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/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/NodeKeyMaps.md +5 -5
- package/dist/docs/api/index/type-aliases/NodeMaps.md +4 -4
- 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 +15 -0
- package/dist/docs/api/index/type-aliases/ScriptBehaviourSystemOptions.md +23 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorEvent.md +39 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorListener.md +25 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorPhase.md +28 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorReport.md +31 -0
- package/dist/docs/api/index/type-aliases/ScriptErrorSource.md +15 -0
- 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 +3 -3
- package/dist/docs/api/index/type-aliases/UiCanvasLike.md +46 -0
- package/dist/docs/api/index/type-aliases/VelocitySample.md +23 -0
- package/dist/docs/api/index/type-aliases/XrCapabilities.md +41 -0
- package/dist/docs/api/index/type-aliases/XrFinger.md +13 -0
- package/dist/docs/api/index/type-aliases/XrFingerCurl.md +27 -0
- package/dist/docs/api/index/type-aliases/XrFingerTarget.md +31 -0
- package/dist/docs/api/index/type-aliases/XrHandJointName.md +40 -0
- package/dist/docs/api/index/type-aliases/XrHandJoints.md +18 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseAxis.md +15 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseContext.md +23 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseDefinition.md +47 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseDirection.md +21 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseEvent.md +13 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseEventDetail.md +27 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseMatch.md +25 -0
- package/dist/docs/api/index/type-aliases/XrHandPoseOrientation.md +25 -0
- package/dist/docs/api/index/type-aliases/XrHandShape.md +46 -0
- package/dist/docs/api/index/type-aliases/XrHandedness.md +15 -0
- package/dist/docs/api/index/type-aliases/XrHitResult.md +25 -0
- package/dist/docs/api/index/type-aliases/XrInputKind.md +19 -0
- package/dist/docs/api/index/type-aliases/XrInputState.md +60 -0
- package/dist/docs/api/index/type-aliases/XrPalmPose.md +31 -0
- package/dist/docs/api/index/variables/ADDED_NODE_MARKER_COMPONENT.md +2 -2
- package/dist/docs/api/index/variables/ARC_GRAVITY.md +15 -0
- package/dist/docs/api/index/variables/ARC_MAX_TIME.md +15 -0
- package/dist/docs/api/index/variables/ARC_SPEED.md +15 -0
- package/dist/docs/api/index/variables/ARC_STEPS.md +15 -0
- package/dist/docs/api/index/variables/CURLED_COS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_DIRECTION_TOLERANCE.md +15 -0
- package/dist/docs/api/index/variables/DEFAULT_ENTER_CONFIDENCE.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_EXIT_CONFIDENCE.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_LOST_GRACE_SECONDS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_MIN_HOLD_SECONDS.md +13 -0
- package/dist/docs/api/index/variables/DEFAULT_SCRIPT_ERROR_RETRY_DELAY.md +17 -0
- package/dist/docs/api/index/variables/FALLBACK_HAND_SCALE.md +15 -0
- package/dist/docs/api/index/variables/HAND_POSE_PRESETS.md +19 -0
- package/dist/docs/api/index/variables/HAND_POSE_PRESET_IDS.md +15 -0
- 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 +15 -0
- package/dist/docs/api/index/variables/MAX_PLAUSIBLE_SPEED.md +25 -0
- package/dist/docs/api/index/variables/MAX_SAMPLE_AGE_SECONDS.md +18 -0
- package/dist/docs/api/index/variables/NODE_KEY_SEPARATOR.md +1 -1
- package/dist/docs/api/index/variables/NO_XR_CAPABILITIES.md +15 -0
- 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 +15 -0
- 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 +19 -0
- package/dist/docs/api/index/variables/VELOCITY_SAMPLES.md +15 -0
- package/dist/docs/api/index/variables/XR_FINGERS.md +13 -0
- package/dist/docs/api/index/variables/XR_HOVER_SHELL_FLAG.md +15 -0
- package/dist/docs/api/index/variables/webglBackend.md +16 -0
- 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 +10 -2
- 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/audio-mixing-and-sound-banks.md +71 -0
- package/dist/docs/guide/authoring-a-behaviour.md +3 -3
- package/dist/docs/guide/authoring-a-script-object.md +12 -9
- package/dist/docs/guide/behaviour-data-binding/index.md +11 -11
- package/dist/docs/guide/behaviour-lifecycle.md +9 -0
- package/dist/docs/guide/bone-attachments-and-ik.md +128 -0
- package/dist/docs/guide/component-catalog.md +10 -2
- package/dist/docs/guide/components/light.md +42 -0
- package/dist/docs/guide/components/model.md +32 -3
- package/dist/docs/guide/concepts.md +2 -2
- package/dist/docs/guide/getting-started/creating-objects.md +2 -2
- package/dist/docs/guide/getting-started/editing-objects.md +2 -2
- package/dist/docs/guide/getting-started/editor/ai-agent.md +227 -0
- package/dist/docs/guide/getting-started/editor/hierarchy.md +2 -2
- package/dist/docs/guide/getting-started/editor/index.md +3 -2
- package/dist/docs/guide/getting-started/editor/inspector.md +2 -2
- package/dist/docs/guide/getting-started/editor/scene-inspector.md +3 -3
- package/dist/docs/guide/getting-started/editor/toolbar.md +11 -11
- package/dist/docs/guide/getting-started/editor/viewport.md +17 -9
- package/dist/docs/guide/getting-started/index.md +1 -1
- package/dist/docs/guide/getting-started/installation.md +1 -1
- package/dist/docs/guide/getting-started/preview-and-test.md +7 -7
- package/dist/docs/guide/getting-started/project-types/image-tracking.md +23 -11
- package/dist/docs/guide/getting-started/project-types/index.md +4 -4
- package/dist/docs/guide/getting-started/project-types/vr.md +270 -2
- package/dist/docs/guide/getting-started/projects.md +4 -5
- package/dist/docs/guide/getting-started/shortcuts.md +5 -4
- package/dist/docs/guide/multiplayer.md +92 -0
- package/dist/docs/guide/scene/environment.md +101 -4
- package/dist/docs/guide/scene/index.md +4 -4
- package/dist/docs/guide/scene/postprocessing.md +67 -5
- package/dist/docs/guide/spatial-ui.md +83 -7
- package/dist/docs/guide/spawning/area-light.md +2 -0
- package/dist/docs/guide/systems/environment-sync-system.md +11 -6
- package/dist/docs/guide/systems/light-sync-system.md +5 -3
- package/dist/docs/guide/systems/postprocessing-sync-system.md +16 -6
- package/dist/docs/guide/systems/render-system.md +7 -6
- package/dist/docs/guide/systems/script-behaviour-system.md +7 -5
- package/dist/docs/guide/systems/script-object-system.md +3 -1
- package/dist/docs/guide/systems/video-system.md +1 -1
- package/dist/docs/guide/webgpu-and-tsl.md +415 -0
- package/dist/docs/guide/world-api.md +52 -2
- package/dist/factories/index.cjs +921 -283
- package/dist/factories/index.cjs.map +1 -1
- package/dist/factories/index.d.cts +14 -3
- package/dist/factories/index.d.ts +14 -3
- package/dist/factories/index.js +7 -4
- package/dist/{index-C3ik3sA1.d.ts → index-CAZHrh0q.d.cts} +28 -3
- package/dist/{index-Dlr-7-4m.d.cts → index-CLtSMf2M.d.ts} +28 -3
- package/dist/{index-D2Jt_JzH.d.ts → index-D5MmJNyj.d.ts} +161 -43
- package/dist/{index-DaG03vyN.d.cts → index-DiIjV2lm.d.cts} +161 -43
- package/dist/index.cjs +4959 -1414
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +113 -11
- package/dist/index.d.ts +113 -11
- package/dist/index.js +187 -12
- package/dist/index.js.map +1 -1
- package/dist/network/index.cjs +5069 -0
- package/dist/network/index.cjs.map +1 -0
- package/dist/network/index.d.cts +98 -0
- package/dist/network/index.d.ts +98 -0
- package/dist/network/index.js +493 -0
- package/dist/network/index.js.map +1 -0
- package/dist/systems/index.cjs +5319 -1957
- package/dist/systems/index.cjs.map +1 -1
- package/dist/systems/index.d.cts +4 -2
- package/dist/systems/index.d.ts +4 -2
- package/dist/systems/index.js +8 -4
- package/dist/types.d.cts +3 -1
- package/dist/types.d.ts +3 -1
- package/dist/webgpu/index.d.ts +113 -0
- package/dist/webgpu/index.js +302 -0
- package/dist/webgpu/index.js.map +1 -0
- package/dist/worldSnapshotUtils.d.cts +3 -1
- package/dist/worldSnapshotUtils.d.ts +3 -1
- package/dist/worldSnapshotUtils.js +3 -2
- package/package.json +19 -3
- package/dist/chunk-BUEKOSR5.js.map +0 -1
- package/dist/chunk-DF5SSRN6.js.map +0 -1
- package/dist/chunk-OWQSESTO.js.map +0 -1
- package/dist/chunk-OY7ZODZP.js.map +0 -1
- package/dist/chunk-RXBLOO5B.js.map +0 -1
- package/dist/chunk-WJD2VKEH.js +0 -315
- package/dist/chunk-WJD2VKEH.js.map +0 -1
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrHandPoseEntry
|
|
6
|
+
|
|
7
|
+
# Type Alias: XrHandPoseEntry
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type XrHandPoseEntry = {
|
|
11
|
+
id: string;
|
|
12
|
+
name: string;
|
|
13
|
+
preset: string | null;
|
|
14
|
+
curls: Record<XrFinger, number>;
|
|
15
|
+
tolerance: number;
|
|
16
|
+
directions: Record<XrFinger, XrHandPoseDirection[]>;
|
|
17
|
+
directionTolerance: number;
|
|
18
|
+
hand: "left" | "right" | null;
|
|
19
|
+
orientation: | XrHandPoseOrientation
|
|
20
|
+
| null;
|
|
21
|
+
minHoldSeconds: number;
|
|
22
|
+
enabled: boolean;
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defined in: [components/XRHandPose.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L18)
|
|
27
|
+
|
|
28
|
+
One pose an entity listens for.
|
|
29
|
+
|
|
30
|
+
A pose is either a named PRESET or a CUSTOM set of finger curls. Storing the
|
|
31
|
+
preset id rather than a copy of its numbers means a preset improved in a later
|
|
32
|
+
release reaches existing scenes, while custom poses stay pinned to exactly
|
|
33
|
+
what the author dialled in.
|
|
34
|
+
|
|
35
|
+
## Properties
|
|
36
|
+
|
|
37
|
+
| Property | Type | Description | Defined in |
|
|
38
|
+
| ------ | ------ | ------ | ------ |
|
|
39
|
+
| <a id="id"></a> `id` | `string` | Stable id, unique within the component. Used in Behaviour hooks. | [components/XRHandPose.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L20) |
|
|
40
|
+
| <a id="name"></a> `name` | `string` | Shown in the inspector and passed to scripts. | [components/XRHandPose.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L22) |
|
|
41
|
+
| <a id="preset"></a> `preset` | `string` \| `null` | Preset id, or null for a custom pose. | [components/XRHandPose.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L24) |
|
|
42
|
+
| <a id="curls"></a> `curls` | `Record`\<[`XrFinger`](../../index/type-aliases/XrFinger.md), `number`\> | Per-finger curl targets, 0 extended → 1 curled. Custom poses only. | [components/XRHandPose.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L26) |
|
|
43
|
+
| <a id="tolerance"></a> `tolerance` | `number` | Slack around each curl target. Larger is easier to perform. | [components/XRHandPose.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L28) |
|
|
44
|
+
| <a id="directions"></a> `directions` | `Record`\<[`XrFinger`](../../index/type-aliases/XrFinger.md), [`XrHandPoseDirection`](../../index/type-aliases/XrHandPoseDirection.md)[]\> | Directions each finger may point. Empty means the finger may point anywhere. Any ONE listed direction satisfies the finger, mirroring fingerpose's `addDirection` — "thumb up OR diagonally up" is one pose, not two. | [components/XRHandPose.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L35) |
|
|
45
|
+
| <a id="directiontolerance"></a> `directionTolerance` | `number` | How far a finger may point from an accepted direction, in degrees. | [components/XRHandPose.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L37) |
|
|
46
|
+
| <a id="hand"></a> `hand` | `"left"` \| `"right"` \| `null` | Which hand may trigger it; null for either. | [components/XRHandPose.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L39) |
|
|
47
|
+
| <a id="orientation"></a> `orientation` | \| [`XrHandPoseOrientation`](../../index/type-aliases/XrHandPoseOrientation.md) \| `null` | Optional direction requirement. | [components/XRHandPose.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L41) |
|
|
48
|
+
| <a id="minholdseconds"></a> `minHoldSeconds` | `number` | Seconds the pose must be held before it fires. | [components/XRHandPose.ts:43](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L43) |
|
|
49
|
+
| <a id="enabled"></a> `enabled` | `boolean` | - | [components/XRHandPose.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L44) |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrHandPreset
|
|
6
|
+
|
|
7
|
+
# Type Alias: XrHandPreset
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type XrHandPreset = "default" | "ghost" | "neon" | "skeleton" | "custom";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/XRInteractor.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L30)
|
|
14
|
+
|
|
15
|
+
Look applied to tracked-hand meshes.
|
|
16
|
+
|
|
17
|
+
Presets exist because hand rendering is the single most visible surface of a
|
|
18
|
+
VR experience and hand-authoring a shader for it is a big ask — but `custom`
|
|
19
|
+
is always available for authors who want full control.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrInteractorSide
|
|
6
|
+
|
|
7
|
+
# Type Alias: XrInteractorSide
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type XrInteractorSide = "left" | "right";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/XRInteractor.ts:38](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L38)
|
|
14
|
+
|
|
15
|
+
Which hand a child interactor entity follows.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrInteractorType
|
|
6
|
+
|
|
7
|
+
# Type Alias: XrInteractorType
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type XrInteractorType = "hands" | "controllers" | "both" | "none";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/XRInteractor.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractor.ts#L21)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrLocomotionMode
|
|
6
|
+
|
|
7
|
+
# Type Alias: XrLocomotionMode
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type XrLocomotionMode = "teleport" | "smooth" | "none";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/XRRig.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L18)
|
|
14
|
+
|
|
15
|
+
How the player moves through the scene in an immersive session.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrTrackingOrigin
|
|
6
|
+
|
|
7
|
+
# Type Alias: XrTrackingOrigin
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type XrTrackingOrigin = "floor" | "eye";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/XRRig.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRRig.ts#L15)
|
|
14
|
+
|
|
15
|
+
Where the headset's origin sits in the scene.
|
|
16
|
+
|
|
17
|
+
`floor` maps to the WebXR `local-floor` reference space: Y=0 is the user's
|
|
18
|
+
real floor, so content authored standing on the ground lines up naturally.
|
|
19
|
+
`eye` maps to `local`: Y=0 is wherever the headset was when the session
|
|
20
|
+
started, which suits seated/cockpit experiences.
|
|
21
|
+
|
|
22
|
+
Getting this wrong is the classic "I spawned inside/under the geometry" bug —
|
|
23
|
+
with `eye`, a scene authored floor-relative places the user's eyes at ground
|
|
24
|
+
level, sinking them through the floor.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / XrTwoHandRotation
|
|
6
|
+
|
|
7
|
+
# Type Alias: XrTwoHandRotation
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type XrTwoHandRotation = "align" | "primary";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/XRInteractable.ts:65](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRInteractable.ts#L65)
|
|
14
|
+
|
|
15
|
+
How the second hand affects orientation. See `solveTwoHandTransform`.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_COLLIDER_STATE: ColliderState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L135)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / DEFAULT\_ENVIRONMENT\_LIGHTING
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_ENVIRONMENT\_LIGHTING
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_ENVIRONMENT_LIGHTING: Required<EnvironmentLightingState>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Environment.ts:109](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L109)
|
|
14
|
+
|
|
15
|
+
Defaults for every [EnvironmentLightingState](../type-aliases/EnvironmentLightingState.md) field.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_ENVIRONMENT_STATE: EnvironmentState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Environment.ts:
|
|
13
|
+
Defined in: [components/Environment.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L142)
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const DEFAULT_INSTANCED_MESH_PARAMETERS: Record<InstancedMeshKind, MeshGeometryParameters>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/InstancedMesh.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/InstancedMesh.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L41)
|
|
14
14
|
|
|
15
15
|
Default geometry parameters per instanced mesh kind. For "model" kind, cube params are stored as a placeholder (unused).
|
|
@@ -10,6 +10,6 @@
|
|
|
10
10
|
const DEFAULT_INSTANCE_TRANSFORM: InstanceTransform;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/InstancedMesh.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/InstancedMesh.ts:34](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstancedMesh.ts#L34)
|
|
14
14
|
|
|
15
15
|
Default identity instance transform.
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_MESH_GEOMETRY_PARAMETERS: MeshGeometryParametersByKind;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/MeshGeometry.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/MeshGeometry.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/MeshGeometry.ts#L62)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_PHYSICS_STATE: PhysicsState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L172)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / DEFAULT\_POSE\_CURLS
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_POSE\_CURLS
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_POSE_CURLS: Record<XrFinger, number>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/XRHandPose.ts:52](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L52)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / DEFAULT\_POSE\_DIRECTIONS
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_POSE\_DIRECTIONS
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_POSE_DIRECTIONS: Record<XrFinger, XrHandPoseDirection[]>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/XRHandPose.ts:60](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/XRHandPose.ts#L60)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_POSTPROCESSING_STATE: PostprocessingState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Postprocessing.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Postprocessing.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Postprocessing.ts#L142)
|
|
@@ -10,4 +10,4 @@
|
|
|
10
10
|
const DEFAULT_RIGIDBODY_STATE: RigidbodyState;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [components/Physics.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
13
|
+
Defined in: [components/Physics.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Physics.ts#L59)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / MODEL\_NO\_PATH\_MESSAGE
|
|
6
|
+
|
|
7
|
+
# Variable: MODEL\_NO\_PATH\_MESSAGE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MODEL_NO_PATH_MESSAGE: "No model path set." = "No model path set.";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Model.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Model.ts#L9)
|
|
14
|
+
|
|
15
|
+
Message used when a model entity has no asset path to load.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: AnimationStateMachine
|
|
8
8
|
|
|
9
|
-
Defined in: [AnimationStateMachine.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [AnimationStateMachine.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L24)
|
|
10
10
|
|
|
11
11
|
## Implements
|
|
12
12
|
|
|
@@ -25,7 +25,7 @@ new AnimationStateMachine(
|
|
|
25
25
|
clipId?): AnimationStateMachine;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
+
Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L33)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -45,12 +45,12 @@ Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/r
|
|
|
45
45
|
|
|
46
46
|
| Property | Type | Default value | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="name"></a> `name` | `string` | `undefined` | [AnimationStateMachine.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
-
| <a id="clip"></a> `clip` | `AnimationClip` | `undefined` | [AnimationStateMachine.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="clipid"></a> `clipId` | `string` \| `null` | `undefined` | [AnimationStateMachine.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| <a id="loop"></a> `loop` | `boolean` | `undefined` | [AnimationStateMachine.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="isplaying"></a> `isPlaying` | `boolean` | `false` | [AnimationStateMachine.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| <a id="ispaused"></a> `isPaused` | `boolean` | `false` | [AnimationStateMachine.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
+
| <a id="name"></a> `name` | `string` | `undefined` | [AnimationStateMachine.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L25) |
|
|
49
|
+
| <a id="clip"></a> `clip` | `AnimationClip` | `undefined` | [AnimationStateMachine.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L26) |
|
|
50
|
+
| <a id="clipid"></a> `clipId` | `string` \| `null` | `undefined` | [AnimationStateMachine.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L27) |
|
|
51
|
+
| <a id="loop"></a> `loop` | `boolean` | `undefined` | [AnimationStateMachine.ts:28](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L28) |
|
|
52
|
+
| <a id="isplaying"></a> `isPlaying` | `boolean` | `false` | [AnimationStateMachine.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L29) |
|
|
53
|
+
| <a id="ispaused"></a> `isPaused` | `boolean` | `false` | [AnimationStateMachine.ts:30](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L30) |
|
|
54
54
|
|
|
55
55
|
## Methods
|
|
56
56
|
|
|
@@ -60,7 +60,7 @@ Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/r
|
|
|
60
60
|
setCallbacks(callbacks): void;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: [AnimationStateMachine.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
63
|
+
Defined in: [AnimationStateMachine.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L51)
|
|
64
64
|
|
|
65
65
|
#### Parameters
|
|
66
66
|
|
|
@@ -80,7 +80,7 @@ Defined in: [AnimationStateMachine.ts:51](https://github.com/Relu-Interactives/r
|
|
|
80
80
|
setLoop(loop): void;
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
Defined in: [AnimationStateMachine.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
83
|
+
Defined in: [AnimationStateMachine.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L59)
|
|
84
84
|
|
|
85
85
|
#### Parameters
|
|
86
86
|
|
|
@@ -100,7 +100,7 @@ Defined in: [AnimationStateMachine.ts:59](https://github.com/Relu-Interactives/r
|
|
|
100
100
|
onStart(): void;
|
|
101
101
|
```
|
|
102
102
|
|
|
103
|
-
Defined in: [AnimationStateMachine.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
103
|
+
Defined in: [AnimationStateMachine.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L63)
|
|
104
104
|
|
|
105
105
|
#### Returns
|
|
106
106
|
|
|
@@ -118,7 +118,7 @@ Defined in: [AnimationStateMachine.ts:63](https://github.com/Relu-Interactives/r
|
|
|
118
118
|
onPlaying(): void;
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
Defined in: [AnimationStateMachine.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
121
|
+
Defined in: [AnimationStateMachine.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L67)
|
|
122
122
|
|
|
123
123
|
#### Returns
|
|
124
124
|
|
|
@@ -136,7 +136,7 @@ Defined in: [AnimationStateMachine.ts:67](https://github.com/Relu-Interactives/r
|
|
|
136
136
|
onEnd(): void;
|
|
137
137
|
```
|
|
138
138
|
|
|
139
|
-
Defined in: [AnimationStateMachine.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
139
|
+
Defined in: [AnimationStateMachine.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L71)
|
|
140
140
|
|
|
141
141
|
#### Returns
|
|
142
142
|
|
|
@@ -154,7 +154,7 @@ Defined in: [AnimationStateMachine.ts:71](https://github.com/Relu-Interactives/r
|
|
|
154
154
|
play(): void;
|
|
155
155
|
```
|
|
156
156
|
|
|
157
|
-
Defined in: [AnimationStateMachine.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
157
|
+
Defined in: [AnimationStateMachine.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L75)
|
|
158
158
|
|
|
159
159
|
#### Returns
|
|
160
160
|
|
|
@@ -172,7 +172,7 @@ Defined in: [AnimationStateMachine.ts:75](https://github.com/Relu-Interactives/r
|
|
|
172
172
|
pause(): void;
|
|
173
173
|
```
|
|
174
174
|
|
|
175
|
-
Defined in: [AnimationStateMachine.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
175
|
+
Defined in: [AnimationStateMachine.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L87)
|
|
176
176
|
|
|
177
177
|
#### Returns
|
|
178
178
|
|
|
@@ -190,7 +190,7 @@ Defined in: [AnimationStateMachine.ts:87](https://github.com/Relu-Interactives/r
|
|
|
190
190
|
stop(): void;
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
Defined in: [AnimationStateMachine.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
193
|
+
Defined in: [AnimationStateMachine.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/AnimationStateMachine.ts#L96)
|
|
194
194
|
|
|
195
195
|
#### Returns
|
|
196
196
|
|
|
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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:295](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/AnimationSystem.ts:295](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/AnimationSystem.ts#L295)
|
|
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:422](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
35
|
+
Defined in: [systems/AnimationSystem.ts:422](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/AnimationSystem.ts#L422)
|
|
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:549](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
+
Defined in: [systems/AnimationSystem.ts:549](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/AnimationSystem.ts#L549)
|
|
61
61
|
|
|
62
62
|
#### Returns
|
|
63
63
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: AudioSystem
|
|
8
8
|
|
|
9
|
-
Defined in: [systems/AudioSystem.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [systems/AudioSystem.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/AudioSystem.ts#L46)
|
|
10
10
|
|
|
11
11
|
Reconciles `AudioComponent` state with the underlying THREE.js audio objects
|
|
12
12
|
each frame.
|
|
@@ -35,7 +35,7 @@ no-op so the editor is unaffected).
|
|
|
35
35
|
new AudioSystem(__namedParameters?): AudioSystem;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [systems/AudioSystem.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
38
|
+
Defined in: [systems/AudioSystem.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/AudioSystem.ts#L55)
|
|
39
39
|
|
|
40
40
|
#### Parameters
|
|
41
41
|
|
|
@@ -56,7 +56,7 @@ Defined in: [systems/AudioSystem.ts:55](https://github.com/Relu-Interactives/rel
|
|
|
56
56
|
update(world, _deltaTime): void;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: [systems/AudioSystem.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
+
Defined in: [systems/AudioSystem.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/AudioSystem.ts#L59)
|
|
60
60
|
|
|
61
61
|
#### Parameters
|
|
62
62
|
|
|
@@ -81,7 +81,7 @@ Defined in: [systems/AudioSystem.ts:59](https://github.com/Relu-Interactives/rel
|
|
|
81
81
|
dispose(_world): void;
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
Defined in: [systems/AudioSystem.ts:180](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
84
|
+
Defined in: [systems/AudioSystem.ts:180](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/AudioSystem.ts#L180)
|
|
85
85
|
|
|
86
86
|
#### Parameters
|
|
87
87
|
|
|
@@ -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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/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/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/systems/CameraSyncSystem.ts#L118)
|
|
36
36
|
|
|
37
37
|
#### Parameters
|
|
38
38
|
|