@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
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Component
|
|
8
8
|
|
|
9
|
-
Defined in: [Component.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [Component.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/Component.ts#L12)
|
|
10
10
|
|
|
11
11
|
Marker base class for every ECS component. Subclass `Component` to declare
|
|
12
12
|
a typed data container that systems can query.
|
|
@@ -19,6 +19,7 @@ asset URLs).
|
|
|
19
19
|
|
|
20
20
|
## Extended by
|
|
21
21
|
|
|
22
|
+
- [`XRHandPoseComponent`](../../components/classes/XRHandPoseComponent.md)
|
|
22
23
|
- [`AnimationComponent`](../../components/classes/AnimationComponent.md)
|
|
23
24
|
- [`CameraComponent`](../../components/classes/CameraComponent.md)
|
|
24
25
|
- [`AudioComponent`](../../components/classes/AudioComponent.md)
|
|
@@ -48,6 +49,18 @@ asset URLs).
|
|
|
48
49
|
- [`SelectionTransformState`](../../components/classes/SelectionTransformState.md)
|
|
49
50
|
- [`TransformComponent`](../../components/classes/TransformComponent.md)
|
|
50
51
|
- [`VideoComponent`](../../components/classes/VideoComponent.md)
|
|
52
|
+
- [`VRTeleportAreaComponent`](../../components/classes/VRTeleportAreaComponent.md)
|
|
53
|
+
- [`XRInteractableComponent`](../../components/classes/XRInteractableComponent.md)
|
|
54
|
+
- [`XRRigComponent`](../../components/classes/XRRigComponent.md)
|
|
55
|
+
- [`XREnvironmentComponent`](../../components/classes/XREnvironmentComponent.md)
|
|
56
|
+
- [`XRAnchorComponent`](../../components/classes/XRAnchorComponent.md)
|
|
57
|
+
- [`UIPanelComponent`](../../components/classes/UIPanelComponent.md)
|
|
58
|
+
- [`UITextComponent`](../../components/classes/UITextComponent.md)
|
|
59
|
+
- [`UIButtonComponent`](../../components/classes/UIButtonComponent.md)
|
|
60
|
+
- [`UIToggleComponent`](../../components/classes/UIToggleComponent.md)
|
|
61
|
+
- [`UISliderComponent`](../../components/classes/UISliderComponent.md)
|
|
62
|
+
- [`XRInteractorComponent`](../../components/classes/XRInteractorComponent.md)
|
|
63
|
+
- [`XRInteractorSideComponent`](../../components/classes/XRInteractorSideComponent.md)
|
|
51
64
|
|
|
52
65
|
## Constructors
|
|
53
66
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: AnimationComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Animation.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Animation.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L71)
|
|
10
10
|
|
|
11
11
|
Animation catalog and runtime state for an entity. Combines clips imported
|
|
12
12
|
from a model with externally added clips, exposes a state machine for
|
|
@@ -30,7 +30,7 @@ machine directly so the animation system observes transitions.
|
|
|
30
30
|
new AnimationComponent(options?): AnimationComponent;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [components/Animation.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
33
|
+
Defined in: [components/Animation.ts:102](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L102)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -50,18 +50,18 @@ Defined in: [components/Animation.ts:102](https://github.com/Relu-Interactives/r
|
|
|
50
50
|
|
|
51
51
|
| Property | Type | Description | Defined in |
|
|
52
52
|
| ------ | ------ | ------ | ------ |
|
|
53
|
-
| <a id="clips"></a> `clips` | `AnimationClip`[] | Combined ordered list of clips (model + external) currently loaded. | [components/Animation.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="clipcatalog"></a> `clipCatalog` | `AnimationClipCatalogEntry`[] | Per-clip metadata used by the inspector. | [components/Animation.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| <a id="availableclips"></a> `availableClips` | `string`[] | Display names of clips available for state-machine bindings. | [components/Animation.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
-
| <a id="externalclipsources"></a> `externalClipSources` | `string`[] | URLs/paths of external clip sources (saved with the project). | [components/Animation.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
-
| <a id="paused"></a> `paused` | `boolean` | Whether playback is currently paused. | [components/Animation.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
58
|
-
| <a id="reverse"></a> `reverse` | `boolean` | Play the active clip in reverse. | [components/Animation.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
-
| <a id="timescale"></a> `timeScale` | `number` | Playback speed multiplier (`1` = real-time). | [components/Animation.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
-
| <a id="crossfadeduration"></a> `crossFadeDuration` | `number` | Default cross-fade duration in seconds when switching states. | [components/Animation.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
61
|
-
| <a id="states"></a> `states` | [`AnimationStateMachine`](../../index/classes/AnimationStateMachine.md)[] | All state-machine entries authored on this entity. | [components/Animation.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
62
|
-
| <a id="active"></a> `active` | \| [`AnimationStateMachine`](../../index/classes/AnimationStateMachine.md) \| `null` | State currently being played, or `null` if none. | [components/Animation.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
63
|
-
| <a id="activestatename"></a> `activeStateName` | `string` \| `null` | Name of the [active](#active) state, or `null` if none. | [components/Animation.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
64
|
-
| <a id="statemanager"></a> `stateManager` | [`AnimationStateManager`](../../index/classes/AnimationStateManager.md) | Manager that drives state transitions; mutate via [addState](#addstate)/[switchState](#switchstate). | [components/Animation.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
+
| <a id="clips"></a> `clips` | `AnimationClip`[] | Combined ordered list of clips (model + external) currently loaded. | [components/Animation.ts:78](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L78) |
|
|
54
|
+
| <a id="clipcatalog"></a> `clipCatalog` | `AnimationClipCatalogEntry`[] | Per-clip metadata used by the inspector. | [components/Animation.ts:80](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L80) |
|
|
55
|
+
| <a id="availableclips"></a> `availableClips` | `string`[] | Display names of clips available for state-machine bindings. | [components/Animation.ts:82](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L82) |
|
|
56
|
+
| <a id="externalclipsources"></a> `externalClipSources` | `string`[] | URLs/paths of external clip sources (saved with the project). | [components/Animation.ts:84](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L84) |
|
|
57
|
+
| <a id="paused"></a> `paused` | `boolean` | Whether playback is currently paused. | [components/Animation.ts:86](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L86) |
|
|
58
|
+
| <a id="reverse"></a> `reverse` | `boolean` | Play the active clip in reverse. | [components/Animation.ts:88](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L88) |
|
|
59
|
+
| <a id="timescale"></a> `timeScale` | `number` | Playback speed multiplier (`1` = real-time). | [components/Animation.ts:90](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L90) |
|
|
60
|
+
| <a id="crossfadeduration"></a> `crossFadeDuration` | `number` | Default cross-fade duration in seconds when switching states. | [components/Animation.ts:92](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L92) |
|
|
61
|
+
| <a id="states"></a> `states` | [`AnimationStateMachine`](../../index/classes/AnimationStateMachine.md)[] | All state-machine entries authored on this entity. | [components/Animation.ts:94](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L94) |
|
|
62
|
+
| <a id="active"></a> `active` | \| [`AnimationStateMachine`](../../index/classes/AnimationStateMachine.md) \| `null` | State currently being played, or `null` if none. | [components/Animation.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L96) |
|
|
63
|
+
| <a id="activestatename"></a> `activeStateName` | `string` \| `null` | Name of the [active](#active) state, or `null` if none. | [components/Animation.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L98) |
|
|
64
|
+
| <a id="statemanager"></a> `stateManager` | [`AnimationStateManager`](../../index/classes/AnimationStateManager.md) | Manager that drives state transitions; mutate via [addState](#addstate)/[switchState](#switchstate). | [components/Animation.ts:100](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L100) |
|
|
65
65
|
|
|
66
66
|
## Methods
|
|
67
67
|
|
|
@@ -71,7 +71,7 @@ Defined in: [components/Animation.ts:102](https://github.com/Relu-Interactives/r
|
|
|
71
71
|
setModelClips(clips): void;
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
Defined in: [components/Animation.ts:234](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
74
|
+
Defined in: [components/Animation.ts:234](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L234)
|
|
75
75
|
|
|
76
76
|
#### Parameters
|
|
77
77
|
|
|
@@ -91,7 +91,7 @@ Defined in: [components/Animation.ts:234](https://github.com/Relu-Interactives/r
|
|
|
91
91
|
setImportedClips(clips): void;
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
-
Defined in: [components/Animation.ts:239](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
94
|
+
Defined in: [components/Animation.ts:239](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L239)
|
|
95
95
|
|
|
96
96
|
#### Parameters
|
|
97
97
|
|
|
@@ -111,7 +111,7 @@ Defined in: [components/Animation.ts:239](https://github.com/Relu-Interactives/r
|
|
|
111
111
|
setExternalClipSources(sources): void;
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
-
Defined in: [components/Animation.ts:276](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
114
|
+
Defined in: [components/Animation.ts:276](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L276)
|
|
115
115
|
|
|
116
116
|
#### Parameters
|
|
117
117
|
|
|
@@ -136,7 +136,7 @@ addState(
|
|
|
136
136
|
| null;
|
|
137
137
|
```
|
|
138
138
|
|
|
139
|
-
Defined in: [components/Animation.ts:301](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
139
|
+
Defined in: [components/Animation.ts:301](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L301)
|
|
140
140
|
|
|
141
141
|
#### Parameters
|
|
142
142
|
|
|
@@ -159,7 +159,7 @@ Defined in: [components/Animation.ts:301](https://github.com/Relu-Interactives/r
|
|
|
159
159
|
setStates(states): void;
|
|
160
160
|
```
|
|
161
161
|
|
|
162
|
-
Defined in: [components/Animation.ts:316](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
162
|
+
Defined in: [components/Animation.ts:316](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L316)
|
|
163
163
|
|
|
164
164
|
#### Parameters
|
|
165
165
|
|
|
@@ -184,7 +184,7 @@ getStateConfigs(): {
|
|
|
184
184
|
}[];
|
|
185
185
|
```
|
|
186
186
|
|
|
187
|
-
Defined in: [components/Animation.ts:343](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
187
|
+
Defined in: [components/Animation.ts:343](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L343)
|
|
188
188
|
|
|
189
189
|
#### Returns
|
|
190
190
|
|
|
@@ -203,7 +203,7 @@ Defined in: [components/Animation.ts:343](https://github.com/Relu-Interactives/r
|
|
|
203
203
|
setActiveState(name, autoPlay?): boolean;
|
|
204
204
|
```
|
|
205
205
|
|
|
206
|
-
Defined in: [components/Animation.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
206
|
+
Defined in: [components/Animation.ts:352](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L352)
|
|
207
207
|
|
|
208
208
|
#### Parameters
|
|
209
209
|
|
|
@@ -224,7 +224,7 @@ Defined in: [components/Animation.ts:352](https://github.com/Relu-Interactives/r
|
|
|
224
224
|
removeState(name): boolean;
|
|
225
225
|
```
|
|
226
226
|
|
|
227
|
-
Defined in: [components/Animation.ts:363](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
227
|
+
Defined in: [components/Animation.ts:363](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L363)
|
|
228
228
|
|
|
229
229
|
#### Parameters
|
|
230
230
|
|
|
@@ -244,7 +244,7 @@ Defined in: [components/Animation.ts:363](https://github.com/Relu-Interactives/r
|
|
|
244
244
|
switchState(name, autoPlay?): boolean;
|
|
245
245
|
```
|
|
246
246
|
|
|
247
|
-
Defined in: [components/Animation.ts:371](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
247
|
+
Defined in: [components/Animation.ts:371](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L371)
|
|
248
248
|
|
|
249
249
|
#### Parameters
|
|
250
250
|
|
|
@@ -265,7 +265,7 @@ Defined in: [components/Animation.ts:371](https://github.com/Relu-Interactives/r
|
|
|
265
265
|
playState(name?): boolean;
|
|
266
266
|
```
|
|
267
267
|
|
|
268
|
-
Defined in: [components/Animation.ts:382](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
268
|
+
Defined in: [components/Animation.ts:382](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L382)
|
|
269
269
|
|
|
270
270
|
#### Parameters
|
|
271
271
|
|
|
@@ -285,7 +285,7 @@ Defined in: [components/Animation.ts:382](https://github.com/Relu-Interactives/r
|
|
|
285
285
|
pauseState(name?): boolean;
|
|
286
286
|
```
|
|
287
287
|
|
|
288
|
-
Defined in: [components/Animation.ts:393](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
288
|
+
Defined in: [components/Animation.ts:393](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L393)
|
|
289
289
|
|
|
290
290
|
#### Parameters
|
|
291
291
|
|
|
@@ -305,7 +305,7 @@ Defined in: [components/Animation.ts:393](https://github.com/Relu-Interactives/r
|
|
|
305
305
|
stopState(name?): boolean;
|
|
306
306
|
```
|
|
307
307
|
|
|
308
|
-
Defined in: [components/Animation.ts:404](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
308
|
+
Defined in: [components/Animation.ts:404](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Animation.ts#L404)
|
|
309
309
|
|
|
310
310
|
#### Parameters
|
|
311
311
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: AudioComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Audio.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Audio.ts:27](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L27)
|
|
10
10
|
|
|
11
11
|
Plays an audio clip from `path`. Supports both global stereo (`positional:
|
|
12
12
|
false`) and 3D positional audio with the configured distance model.
|
|
@@ -25,7 +25,7 @@ when the project loads and are never persisted to saved snapshots.
|
|
|
25
25
|
new AudioComponent(path, options?): AudioComponent;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [components/Audio.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
+
Defined in: [components/Audio.ts:64](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L64)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -46,20 +46,20 @@ Defined in: [components/Audio.ts:64](https://github.com/Relu-Interactives/relu-s
|
|
|
46
46
|
|
|
47
47
|
| Property | Type | Description | Defined in |
|
|
48
48
|
| ------ | ------ | ------ | ------ |
|
|
49
|
-
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the audio file. | [components/Audio.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
50
|
-
| <a id="options"></a> `options` | \{ `autoplay`: `boolean`; `loop`: `boolean`; `pitch`: `number`; `volume`: `number`; `positional`: `boolean`; `refDistance`: `number`; `distanceModel`: `string`; `rolloffFactor`: `number`; \} | Playback options. | Field | Default | Description | |---|---|---| | `autoplay` | `false` | Start playback as soon as the clip is loaded. | | `loop` | `false` | Loop playback indefinitely. | | `pitch` | `1` | Playback rate multiplier (`1` = normal speed/pitch). | | `volume` | `1` | Linear gain in `[0, 1]`. | | `positional` | `false` | When `true`, audio is spatialized using the entity's transform. | | `refDistance` | `1` | Distance at which volume is unattenuated (positional only). | | `distanceModel` | `"inverse"` | WebAudio distance model (`linear`, `inverse`, `exponential`). | | `rolloffFactor` | `1` | How quickly volume falls off past `refDistance`. | | [components/Audio.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
-
| `options.autoplay` | `boolean` | - | [components/Audio.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| `options.loop` | `boolean` | - | [components/Audio.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
-
| `options.pitch` | `number` | - | [components/Audio.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| `options.volume` | `number` | - | [components/Audio.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| `options.positional` | `boolean` | - | [components/Audio.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
-
| `options.refDistance` | `number` | - | [components/Audio.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
-
| `options.distanceModel` | `string` | - | [components/Audio.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
58
|
-
| `options.rolloffFactor` | `number` | - | [components/Audio.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
-
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object hosting the audio (a parented `Audio`/`PositionalAudio`). `null` until built. | [components/Audio.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
-
| <a id="audio"></a> `audio` | `Audio`\<`GainNode`\> \| `PositionalAudio` \| `null` | Live three.js audio source. `null` until built. Recreated when the project loads. | [components/Audio.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
61
|
-
| <a id="isplaying"></a> `isPlaying` | `boolean` | Whether the audio should be playing. Managed by `AudioSystem` in preview. Non-enumerable — not persisted to snapshots or save data. Set via [play](#play) / [stop](#stop). | [components/Audio.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
62
|
-
| <a id="ispaused"></a> `isPaused` | `boolean` | Whether the audio is paused mid-playback (position is preserved). Non-enumerable — not persisted to snapshots or save data. Set via [pause](#pause) / [play](#play) / [stop](#stop). | [components/Audio.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
49
|
+
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the audio file. | [components/Audio.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L29) |
|
|
50
|
+
| <a id="options"></a> `options` | \{ `autoplay`: `boolean`; `loop`: `boolean`; `pitch`: `number`; `volume`: `number`; `positional`: `boolean`; `refDistance`: `number`; `distanceModel`: `string`; `rolloffFactor`: `number`; \} | Playback options. | Field | Default | Description | |---|---|---| | `autoplay` | `false` | Start playback as soon as the clip is loaded. | | `loop` | `false` | Loop playback indefinitely. | | `pitch` | `1` | Playback rate multiplier (`1` = normal speed/pitch). | | `volume` | `1` | Linear gain in `[0, 1]`. | | `positional` | `false` | When `true`, audio is spatialized using the entity's transform. | | `refDistance` | `1` | Distance at which volume is unattenuated (positional only). | | `distanceModel` | `"inverse"` | WebAudio distance model (`linear`, `inverse`, `exponential`). | | `rolloffFactor` | `1` | How quickly volume falls off past `refDistance`. | | [components/Audio.ts:44](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L44) |
|
|
51
|
+
| `options.autoplay` | `boolean` | - | [components/Audio.ts:9](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L9) |
|
|
52
|
+
| `options.loop` | `boolean` | - | [components/Audio.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L10) |
|
|
53
|
+
| `options.pitch` | `number` | - | [components/Audio.ts:11](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L11) |
|
|
54
|
+
| `options.volume` | `number` | - | [components/Audio.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L12) |
|
|
55
|
+
| `options.positional` | `boolean` | - | [components/Audio.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L13) |
|
|
56
|
+
| `options.refDistance` | `number` | - | [components/Audio.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L14) |
|
|
57
|
+
| `options.distanceModel` | `string` | - | [components/Audio.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L15) |
|
|
58
|
+
| `options.rolloffFactor` | `number` | - | [components/Audio.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L16) |
|
|
59
|
+
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object hosting the audio (a parented `Audio`/`PositionalAudio`). `null` until built. | [components/Audio.ts:46](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L46) |
|
|
60
|
+
| <a id="audio"></a> `audio` | `Audio`\<`GainNode`\> \| `PositionalAudio` \| `null` | Live three.js audio source. `null` until built. Recreated when the project loads. | [components/Audio.ts:48](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L48) |
|
|
61
|
+
| <a id="isplaying"></a> `isPlaying` | `boolean` | Whether the audio should be playing. Managed by `AudioSystem` in preview. Non-enumerable — not persisted to snapshots or save data. Set via [play](#play) / [stop](#stop). | [components/Audio.ts:55](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L55) |
|
|
62
|
+
| <a id="ispaused"></a> `isPaused` | `boolean` | Whether the audio is paused mid-playback (position is preserved). Non-enumerable — not persisted to snapshots or save data. Set via [pause](#pause) / [play](#play) / [stop](#stop). | [components/Audio.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L62) |
|
|
63
63
|
|
|
64
64
|
## Methods
|
|
65
65
|
|
|
@@ -69,7 +69,7 @@ Defined in: [components/Audio.ts:64](https://github.com/Relu-Interactives/relu-s
|
|
|
69
69
|
play(): void;
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Defined in: [components/Audio.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
72
|
+
Defined in: [components/Audio.ts:98](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L98)
|
|
73
73
|
|
|
74
74
|
Signals `AudioSystem` to start (or resume) playback.
|
|
75
75
|
Has no direct effect in the editor — `AudioSystem` drives the actual
|
|
@@ -87,7 +87,7 @@ THREE.js call in preview.
|
|
|
87
87
|
pause(): void;
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
-
Defined in: [components/Audio.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
90
|
+
Defined in: [components/Audio.ts:108](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L108)
|
|
91
91
|
|
|
92
92
|
Signals `AudioSystem` to pause playback, preserving the current position.
|
|
93
93
|
Calling [play](#play) afterwards resumes from where it paused.
|
|
@@ -105,7 +105,7 @@ No-op if not currently playing.
|
|
|
105
105
|
stop(): void;
|
|
106
106
|
```
|
|
107
107
|
|
|
108
|
-
Defined in: [components/Audio.ts:117](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
108
|
+
Defined in: [components/Audio.ts:117](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Audio.ts#L117)
|
|
109
109
|
|
|
110
110
|
Signals `AudioSystem` to stop playback and reset the playback position.
|
|
111
111
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: CameraComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Camera.ts:
|
|
9
|
+
Defined in: [components/Camera.ts:164](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L164)
|
|
10
10
|
|
|
11
11
|
Camera entity state. Supports perspective and orthographic projections, a
|
|
12
12
|
`3d` or `ar` runtime type, and an `isDefault` flag for the camera that the
|
|
@@ -25,7 +25,7 @@ zoom are persisted; the live `THREE.Camera` is recreated when the project loads.
|
|
|
25
25
|
new CameraComponent(payload?): CameraComponent;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [components/Camera.ts:
|
|
28
|
+
Defined in: [components/Camera.ts:190](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L190)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -45,15 +45,15 @@ Defined in: [components/Camera.ts:186](https://github.com/Relu-Interactives/relu
|
|
|
45
45
|
|
|
46
46
|
| Property | Type | Description | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="camera"></a> `camera` | `Camera` | Live three.js camera. Recreated when the project loads to match [projection](#projection). | [components/Camera.ts:
|
|
49
|
-
| <a id="type"></a> `type` | [`CameraRuntimeType`](../type-aliases/CameraRuntimeType.md) | Runtime camera mode (`3d` or `ar`). | [components/Camera.ts:
|
|
50
|
-
| <a id="isdefault"></a> `isDefault` | `boolean` | When `true`, this is the active rendering camera. Only one camera per scene should be the default. | [components/Camera.ts:
|
|
51
|
-
| <a id="projection"></a> `projection` | [`CameraProjection`](../type-aliases/CameraProjection.md) | Active projection model (`perspective` or `orthographic`). | [components/Camera.ts:
|
|
52
|
-
| <a id="fov"></a> `fov` | `number` | Vertical field of view in **degrees**. Used when [projection](#projection) is `perspective`. | [components/Camera.ts:
|
|
53
|
-
| <a id="near"></a> `near` | `number` | Near clip plane in world units. | [components/Camera.ts:
|
|
54
|
-
| <a id="far"></a> `far` | `number` | Far clip plane in world units. | [components/Camera.ts:
|
|
55
|
-
| <a id="left"></a> `left` | `number` | Left edge of the orthographic frustum (orthographic only). | [components/Camera.ts:
|
|
56
|
-
| <a id="right"></a> `right` | `number` | Right edge of the orthographic frustum (orthographic only). | [components/Camera.ts:
|
|
57
|
-
| <a id="top"></a> `top` | `number` | Top edge of the orthographic frustum (orthographic only). | [components/Camera.ts:
|
|
58
|
-
| <a id="bottom"></a> `bottom` | `number` | Bottom edge of the orthographic frustum (orthographic only). | [components/Camera.ts:
|
|
59
|
-
| <a id="zoom"></a> `zoom` | `number` | Zoom multiplier applied to the projection. | [components/Camera.ts:
|
|
48
|
+
| <a id="camera"></a> `camera` | `Camera` | Live three.js camera. Recreated when the project loads to match [projection](#projection). | [components/Camera.ts:166](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L166) |
|
|
49
|
+
| <a id="type"></a> `type` | [`CameraRuntimeType`](../type-aliases/CameraRuntimeType.md) | Runtime camera mode (`3d` or `ar`). | [components/Camera.ts:168](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L168) |
|
|
50
|
+
| <a id="isdefault"></a> `isDefault` | `boolean` | When `true`, this is the active rendering camera. Only one camera per scene should be the default. | [components/Camera.ts:170](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L170) |
|
|
51
|
+
| <a id="projection"></a> `projection` | [`CameraProjection`](../type-aliases/CameraProjection.md) | Active projection model (`perspective` or `orthographic`). | [components/Camera.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L172) |
|
|
52
|
+
| <a id="fov"></a> `fov` | `number` | Vertical field of view in **degrees**. Used when [projection](#projection) is `perspective`. | [components/Camera.ts:174](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L174) |
|
|
53
|
+
| <a id="near"></a> `near` | `number` | Near clip plane in world units. | [components/Camera.ts:176](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L176) |
|
|
54
|
+
| <a id="far"></a> `far` | `number` | Far clip plane in world units. | [components/Camera.ts:178](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L178) |
|
|
55
|
+
| <a id="left"></a> `left` | `number` | Left edge of the orthographic frustum (orthographic only). | [components/Camera.ts:180](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L180) |
|
|
56
|
+
| <a id="right"></a> `right` | `number` | Right edge of the orthographic frustum (orthographic only). | [components/Camera.ts:182](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L182) |
|
|
57
|
+
| <a id="top"></a> `top` | `number` | Top edge of the orthographic frustum (orthographic only). | [components/Camera.ts:184](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L184) |
|
|
58
|
+
| <a id="bottom"></a> `bottom` | `number` | Bottom edge of the orthographic frustum (orthographic only). | [components/Camera.ts:186](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L186) |
|
|
59
|
+
| <a id="zoom"></a> `zoom` | `number` | Zoom multiplier applied to the projection. | [components/Camera.ts:188](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Camera.ts#L188) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: EntityType
|
|
8
8
|
|
|
9
|
-
Defined in: [components/EntityType.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/EntityType.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/EntityType.ts#L12)
|
|
10
10
|
|
|
11
11
|
Tags an entity with the kind it was created from (`cube`, `sphere`,
|
|
12
12
|
`model`, `directionalLight`, etc.). Factories use this to drive
|
|
@@ -25,13 +25,13 @@ editors.
|
|
|
25
25
|
new EntityType(value): EntityType;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [components/EntityType.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
28
|
+
Defined in: [components/EntityType.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/EntityType.ts#L16)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
32
32
|
| Parameter | Type |
|
|
33
33
|
| ------ | ------ |
|
|
34
|
-
| `value` | \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"scriptObject"` \| `"editorUtility"` |
|
|
34
|
+
| `value` | \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"scriptObject"` \| `"xrRig"` \| `"xrInteractor"` \| `"teleportArea"` \| `"uiPanel"` \| `"uiText"` \| `"uiButton"` \| `"uiToggle"` \| `"uiSlider"` \| `"editorUtility"` |
|
|
35
35
|
|
|
36
36
|
#### Returns
|
|
37
37
|
|
|
@@ -45,4 +45,4 @@ Defined in: [components/EntityType.ts:16](https://github.com/Relu-Interactives/r
|
|
|
45
45
|
|
|
46
46
|
| Property | Type | Description | Defined in |
|
|
47
47
|
| ------ | ------ | ------ | ------ |
|
|
48
|
-
| <a id="value"></a> `value` | \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"scriptObject"` \| `"editorUtility"` | Kind tag identifying which factory created this entity (e.g. `cube`, `directionalLight`, `model`). | [components/EntityType.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
+
| <a id="value"></a> `value` | \| `"model"` \| `"image"` \| `"capsule"` \| `"cube"` \| `"cylinder"` \| `"plane"` \| `"sphere"` \| `"empty"` \| `"imageTarget"` \| `"sprite"` \| `"audio"` \| `"camera"` \| `"video"` \| `"ambientLight"` \| `"directionalLight"` \| `"pointLight"` \| `"spotLight"` \| `"areaLight"` \| `"instancedMesh"` \| `"instanceSlot"` \| `"scriptObject"` \| `"xrRig"` \| `"xrInteractor"` \| `"teleportArea"` \| `"uiPanel"` \| `"uiText"` \| `"uiButton"` \| `"uiToggle"` \| `"uiSlider"` \| `"editorUtility"` | Kind tag identifying which factory created this entity (e.g. `cube`, `directionalLight`, `model`). | [components/EntityType.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/EntityType.ts#L14) |
|
|
@@ -6,10 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: Environment
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Environment.ts:
|
|
9
|
+
Defined in: [components/Environment.ts:283](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L283)
|
|
10
10
|
|
|
11
11
|
Scene environment settings: skybox (gradient/color/image), fog
|
|
12
|
-
(linear/exponential),
|
|
12
|
+
(linear/exponential), gravity vector for the physics world, and optional
|
|
13
|
+
image-based lighting / tone mapping (`values.lighting`).
|
|
13
14
|
Singleton-style — attached to one environment entity per scene.
|
|
14
15
|
|
|
15
16
|
Use `world.getEnvironmentComponent()` to access this component directly
|
|
@@ -28,7 +29,7 @@ from a Behaviour script. Mutate `values` to change settings at runtime;
|
|
|
28
29
|
new Environment(values?): Environment;
|
|
29
30
|
```
|
|
30
31
|
|
|
31
|
-
Defined in: [components/Environment.ts:
|
|
32
|
+
Defined in: [components/Environment.ts:287](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L287)
|
|
32
33
|
|
|
33
34
|
#### Parameters
|
|
34
35
|
|
|
@@ -48,4 +49,4 @@ Defined in: [components/Environment.ts:168](https://github.com/Relu-Interactives
|
|
|
48
49
|
|
|
49
50
|
| Property | Type | Description | Defined in |
|
|
50
51
|
| ------ | ------ | ------ | ------ |
|
|
51
|
-
| <a id="values"></a> `values` | [`EnvironmentState`](../type-aliases/EnvironmentState.md) | Aggregated environment authoring state (skybox, fog, gravity). Saved with the project. | [components/Environment.ts:
|
|
52
|
+
| <a id="values"></a> `values` | [`EnvironmentState`](../type-aliases/EnvironmentState.md) | Aggregated environment authoring state (skybox, fog, gravity, lighting). Saved with the project. | [components/Environment.ts:285](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Environment.ts#L285) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ImageComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/Image.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/Image.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Image.ts#L13)
|
|
10
10
|
|
|
11
11
|
Renders a 2D image as a textured quad in the scene. Width/height are in
|
|
12
12
|
world units. Texture loading is handled by the image system, which
|
|
@@ -28,7 +28,7 @@ new ImageComponent(
|
|
|
28
28
|
height?): ImageComponent;
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Defined in: [components/Image.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
+
Defined in: [components/Image.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Image.ts#L25)
|
|
32
32
|
|
|
33
33
|
#### Parameters
|
|
34
34
|
|
|
@@ -50,8 +50,8 @@ Defined in: [components/Image.ts:25](https://github.com/Relu-Interactives/relu-s
|
|
|
50
50
|
|
|
51
51
|
| Property | Type | Description | Defined in |
|
|
52
52
|
| ------ | ------ | ------ | ------ |
|
|
53
|
-
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the image file. | [components/Image.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
54
|
-
| <a id="width"></a> `width` | `number` | Width of the rendered quad in world units. | [components/Image.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
55
|
-
| <a id="height"></a> `height` | `number` | Height of the rendered quad in world units. | [components/Image.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
-
| <a id="texture"></a> `texture` | `Texture` \| `null` | Loaded texture, populated asynchronously by the image system. `null` until loaded. | [components/Image.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
-
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object representing the textured quad. `null` until built. | [components/Image.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
53
|
+
| <a id="path"></a> `path` | `string` | Source URL or `localasset://` path of the image file. | [components/Image.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Image.ts#L15) |
|
|
54
|
+
| <a id="width"></a> `width` | `number` | Width of the rendered quad in world units. | [components/Image.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Image.ts#L17) |
|
|
55
|
+
| <a id="height"></a> `height` | `number` | Height of the rendered quad in world units. | [components/Image.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Image.ts#L19) |
|
|
56
|
+
| <a id="texture"></a> `texture` | `Texture`\<`unknown`, `TextureEventMap`\> \| `null` | Loaded texture, populated asynchronously by the image system. `null` until loaded. | [components/Image.ts:21](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Image.ts#L21) |
|
|
57
|
+
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Live three.js object representing the textured quad. `null` until built. | [components/Image.ts:23](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/Image.ts#L23) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ImageTarget
|
|
8
8
|
|
|
9
|
-
Defined in: [components/ImageTarget.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/ImageTarget.ts:29](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTarget.ts#L29)
|
|
10
10
|
|
|
11
11
|
Image-tracking target metadata used by AR projects. Holds the source images
|
|
12
12
|
users uploaded plus the URL of the compiled `.mind` target file produced by
|
|
@@ -28,7 +28,7 @@ new ImageTarget(
|
|
|
28
28
|
object?): ImageTarget;
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Defined in: [components/ImageTarget.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
31
|
+
Defined in: [components/ImageTarget.ts:41](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTarget.ts#L41)
|
|
32
32
|
|
|
33
33
|
#### Parameters
|
|
34
34
|
|
|
@@ -38,7 +38,7 @@ Defined in: [components/ImageTarget.ts:41](https://github.com/Relu-Interactives/
|
|
|
38
38
|
| `options.targets?` | [`ImageTargetReference`](../type-aliases/ImageTargetReference.md)[] |
|
|
39
39
|
| `options.compiledTargetUrl?` | `string` |
|
|
40
40
|
| `options.compiledTargetDir?` | `string` |
|
|
41
|
-
| `texture?` | `Texture` |
|
|
41
|
+
| `texture?` | `Texture`\<`unknown`, `TextureEventMap`\> |
|
|
42
42
|
| `object?` | `Object3D`\<`Object3DEventMap`\> |
|
|
43
43
|
|
|
44
44
|
#### Returns
|
|
@@ -53,8 +53,8 @@ Defined in: [components/ImageTarget.ts:41](https://github.com/Relu-Interactives/
|
|
|
53
53
|
|
|
54
54
|
| Property | Type | Description | Defined in |
|
|
55
55
|
| ------ | ------ | ------ | ------ |
|
|
56
|
-
| <a id="targets"></a> `targets` | [`ImageTargetReference`](../type-aliases/ImageTargetReference.md)[] | Source images that were combined into the compiled `.mind` target. | [components/ImageTarget.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
57
|
-
| <a id="compiledtargeturl"></a> `compiledTargetUrl?` | `string` | URL of the compiled `.mind` target file. Set after the image-target compiler finishes. | [components/ImageTarget.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
58
|
-
| <a id="compiledtargetdir"></a> `compiledTargetDir?` | `string` | Directory containing the compiled `.mind` file (desktop projects). | [components/ImageTarget.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
59
|
-
| <a id="texture"></a> `texture` | `Texture` \| `null` | Optional preview texture used in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
60
|
-
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Optional preview object placed in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
56
|
+
| <a id="targets"></a> `targets` | [`ImageTargetReference`](../type-aliases/ImageTargetReference.md)[] | Source images that were combined into the compiled `.mind` target. | [components/ImageTarget.ts:31](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTarget.ts#L31) |
|
|
57
|
+
| <a id="compiledtargeturl"></a> `compiledTargetUrl?` | `string` | URL of the compiled `.mind` target file. Set after the image-target compiler finishes. | [components/ImageTarget.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTarget.ts#L33) |
|
|
58
|
+
| <a id="compiledtargetdir"></a> `compiledTargetDir?` | `string` | Directory containing the compiled `.mind` file (desktop projects). | [components/ImageTarget.ts:35](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTarget.ts#L35) |
|
|
59
|
+
| <a id="texture"></a> `texture` | `Texture`\<`unknown`, `TextureEventMap`\> \| `null` | Optional preview texture used in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:37](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTarget.ts#L37) |
|
|
60
|
+
| <a id="object"></a> `object` | `Object3D`\<`Object3DEventMap`\> \| `null` | Optional preview object placed in the editor viewport. `null` when not assigned. | [components/ImageTarget.ts:39](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTarget.ts#L39) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ImageTargetAnchor
|
|
8
8
|
|
|
9
|
-
Defined in: [components/ImageTargetAnchor.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/ImageTargetAnchor.ts:18](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTargetAnchor.ts#L18)
|
|
10
10
|
|
|
11
11
|
Marks an entity as an anchor for an image-tracking target. The image
|
|
12
12
|
tracking system reveals the entity when the referenced target is found and
|
|
@@ -24,7 +24,7 @@ hides it when the target is lost.
|
|
|
24
24
|
new ImageTargetAnchor(options?): ImageTargetAnchor;
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Defined in: [components/ImageTargetAnchor.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
27
|
+
Defined in: [components/ImageTargetAnchor.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTargetAnchor.ts#L24)
|
|
28
28
|
|
|
29
29
|
#### Parameters
|
|
30
30
|
|
|
@@ -44,5 +44,5 @@ Defined in: [components/ImageTargetAnchor.ts:24](https://github.com/Relu-Interac
|
|
|
44
44
|
|
|
45
45
|
| Property | Type | Description | Defined in |
|
|
46
46
|
| ------ | ------ | ------ | ------ |
|
|
47
|
-
| <a id="targetid"></a> `targetId` | `number` \| `null` | Tracked target id this anchor follows. `null` when unbound. | [components/ImageTargetAnchor.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
48
|
-
| <a id="targeturl"></a> `targetUrl?` | `string` | Canonical target image URL, retained as a fallback identifier. | [components/ImageTargetAnchor.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
47
|
+
| <a id="targetid"></a> `targetId` | `number` \| `null` | Tracked target id this anchor follows. `null` when unbound. | [components/ImageTargetAnchor.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTargetAnchor.ts#L20) |
|
|
48
|
+
| <a id="targeturl"></a> `targetUrl?` | `string` | Canonical target image URL, retained as a fallback identifier. | [components/ImageTargetAnchor.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/ImageTargetAnchor.ts#L22) |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: InstanceSlotComponent
|
|
8
8
|
|
|
9
|
-
Defined in: [components/InstanceSlotComponent.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
9
|
+
Defined in: [components/InstanceSlotComponent.ts:13](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstanceSlotComponent.ts#L13)
|
|
10
10
|
|
|
11
11
|
Marks an entity as an instance slot owned by an [InstancedMeshComponent](InstancedMeshComponent.md) group entity.
|
|
12
12
|
|
|
@@ -27,7 +27,7 @@ frame by `InstancedMeshSystem` to compose the instance matrix.
|
|
|
27
27
|
new InstanceSlotComponent(groupEntityId, slotIndex): InstanceSlotComponent;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: [components/InstanceSlotComponent.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
30
|
+
Defined in: [components/InstanceSlotComponent.ts:19](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstanceSlotComponent.ts#L19)
|
|
31
31
|
|
|
32
32
|
#### Parameters
|
|
33
33
|
|
|
@@ -48,5 +48,5 @@ Defined in: [components/InstanceSlotComponent.ts:19](https://github.com/Relu-Int
|
|
|
48
48
|
|
|
49
49
|
| Property | Type | Description | Defined in |
|
|
50
50
|
| ------ | ------ | ------ | ------ |
|
|
51
|
-
| <a id="groupentityid"></a> `groupEntityId` | `number` | Entity ID of the owning `instancedMesh` group entity. | [components/InstanceSlotComponent.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
52
|
-
| <a id="slotindex"></a> `slotIndex` | `number` | Zero-based index of this slot within the group's `instanceEntityIds` array. | [components/InstanceSlotComponent.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/
|
|
51
|
+
| <a id="groupentityid"></a> `groupEntityId` | `number` | Entity ID of the owning `instancedMesh` group entity. | [components/InstanceSlotComponent.ts:15](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstanceSlotComponent.ts#L15) |
|
|
52
|
+
| <a id="slotindex"></a> `slotIndex` | `number` | Zero-based index of this slot within the group's `instanceEntityIds` array. | [components/InstanceSlotComponent.ts:17](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/72f129a02ec4b2f93ff337d16361a731efd8cc5d/core/components/InstanceSlotComponent.ts#L17) |
|