@relu-interactives/spatial-ecs 0.2.2
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/README.md +125 -0
- package/dist/System-rXAmagXA.d.cts +659 -0
- package/dist/System-rXAmagXA.d.ts +659 -0
- package/dist/Video-CDemv74U.d.cts +1261 -0
- package/dist/Video-ChKV1UI7.d.ts +1261 -0
- package/dist/assets/draco/draco_decoder.js +34 -0
- package/dist/assets/draco/draco_decoder.wasm +0 -0
- package/dist/assets/draco/draco_wasm_wrapper.js +117 -0
- package/dist/chunk-AYEF3X2P.js +223 -0
- package/dist/chunk-AYEF3X2P.js.map +1 -0
- package/dist/chunk-MAWBTMCG.js +1722 -0
- package/dist/chunk-MAWBTMCG.js.map +1 -0
- package/dist/chunk-NFDTIYR4.js +248 -0
- package/dist/chunk-NFDTIYR4.js.map +1 -0
- package/dist/chunk-OY7ZODZP.js +16 -0
- package/dist/chunk-OY7ZODZP.js.map +1 -0
- package/dist/chunk-P2YDX5DB.js +3304 -0
- package/dist/chunk-P2YDX5DB.js.map +1 -0
- package/dist/chunk-QHILSPT4.js +3 -0
- package/dist/chunk-QHILSPT4.js.map +1 -0
- package/dist/chunk-XWIEEJ7Z.js +1315 -0
- package/dist/chunk-XWIEEJ7Z.js.map +1 -0
- package/dist/components/index.cjs +1745 -0
- package/dist/components/index.cjs.map +1 -0
- package/dist/components/index.d.cts +4 -0
- package/dist/components/index.d.ts +4 -0
- package/dist/components/index.js +4 -0
- package/dist/components/index.js.map +1 -0
- package/dist/docs/api/Behaviour/classes/Behaviour.md +554 -0
- package/dist/docs/api/Behaviour/index.md +15 -0
- package/dist/docs/api/Component/classes/Component.md +57 -0
- package/dist/docs/api/Component/index.md +15 -0
- package/dist/docs/api/components/classes/AnimationComponent.md +318 -0
- package/dist/docs/api/components/classes/AudioComponent.md +114 -0
- package/dist/docs/api/components/classes/CameraComponent.md +59 -0
- package/dist/docs/api/components/classes/EntityType.md +48 -0
- package/dist/docs/api/components/classes/Environment.md +47 -0
- package/dist/docs/api/components/classes/ImageComponent.md +57 -0
- package/dist/docs/api/components/classes/ImageTarget.md +60 -0
- package/dist/docs/api/components/classes/ImageTargetAnchor.md +48 -0
- package/dist/docs/api/components/classes/LightComponent.md +70 -0
- package/dist/docs/api/components/classes/MaterialComponent.md +181 -0
- package/dist/docs/api/components/classes/MeshComponent.md +48 -0
- package/dist/docs/api/components/classes/MeshGeometryComponent.md +64 -0
- package/dist/docs/api/components/classes/ModelComponent.md +49 -0
- package/dist/docs/api/components/classes/Name.md +46 -0
- package/dist/docs/api/components/classes/Object3DRef.md +54 -0
- package/dist/docs/api/components/classes/ParentId.md +47 -0
- package/dist/docs/api/components/classes/PhysicsComponent.md +82 -0
- package/dist/docs/api/components/classes/Postprocessing.md +49 -0
- package/dist/docs/api/components/classes/ScriptComponent.md +54 -0
- package/dist/docs/api/components/classes/Selectable.md +46 -0
- package/dist/docs/api/components/classes/SelectionTransformState.md +54 -0
- package/dist/docs/api/components/classes/SpriteComponent.md +55 -0
- package/dist/docs/api/components/classes/TransformComponent.md +197 -0
- package/dist/docs/api/components/classes/VideoComponent.md +123 -0
- package/dist/docs/api/components/functions/normalizePhysicsState.md +23 -0
- package/dist/docs/api/components/index.md +94 -0
- package/dist/docs/api/components/type-aliases/AnimationComponentOptions.md +42 -0
- package/dist/docs/api/components/type-aliases/CameraComponentOptions.md +45 -0
- package/dist/docs/api/components/type-aliases/CameraProjection.md +15 -0
- package/dist/docs/api/components/type-aliases/CameraRuntimeType.md +15 -0
- package/dist/docs/api/components/type-aliases/ColliderShape.md +15 -0
- package/dist/docs/api/components/type-aliases/ColliderState.md +62 -0
- package/dist/docs/api/components/type-aliases/CubeMeshParameters.md +27 -0
- package/dist/docs/api/components/type-aliases/EditableMeshObjectKind.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentFogState.md +37 -0
- package/dist/docs/api/components/type-aliases/EnvironmentFogType.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentGradientEffect.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxState.md +34 -0
- package/dist/docs/api/components/type-aliases/EnvironmentSkyboxType.md +15 -0
- package/dist/docs/api/components/type-aliases/EnvironmentState.md +29 -0
- package/dist/docs/api/components/type-aliases/ImageTargetAnchorOptions.md +25 -0
- package/dist/docs/api/components/type-aliases/ImageTargetReference.md +33 -0
- package/dist/docs/api/components/type-aliases/LightValueState.md +41 -0
- package/dist/docs/api/components/type-aliases/MaterialTypeValue.md +15 -0
- package/dist/docs/api/components/type-aliases/MaterialValueState.md +75 -0
- package/dist/docs/api/components/type-aliases/MeshGeometryParameters.md +13 -0
- package/dist/docs/api/components/type-aliases/MeshGeometryParametersByKind.md +33 -0
- package/dist/docs/api/components/type-aliases/PhysicsState.md +25 -0
- package/dist/docs/api/components/type-aliases/PlaneMeshParameters.md +25 -0
- package/dist/docs/api/components/type-aliases/PostprocessingState.md +164 -0
- package/dist/docs/api/components/type-aliases/RadiusHeightMeshParameters.md +25 -0
- package/dist/docs/api/components/type-aliases/RadiusMeshParameters.md +23 -0
- package/dist/docs/api/components/type-aliases/RigidbodyState.md +53 -0
- package/dist/docs/api/components/type-aliases/RigidbodyType.md +19 -0
- package/dist/docs/api/components/type-aliases/ScriptEntry.md +38 -0
- package/dist/docs/api/components/type-aliases/TextureFilteringValue.md +15 -0
- package/dist/docs/api/components/type-aliases/TransformData.md +27 -0
- package/dist/docs/api/components/type-aliases/TransformModeValue.md +15 -0
- package/dist/docs/api/components/type-aliases/TransformSpaceValue.md +15 -0
- package/dist/docs/api/components/type-aliases/Vec3.md +27 -0
- package/dist/docs/api/components/variables/DEFAULT_COLLIDER_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_ENVIRONMENT_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_MESH_GEOMETRY_PARAMETERS.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_PHYSICS_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_POSTPROCESSING_STATE.md +13 -0
- package/dist/docs/api/components/variables/DEFAULT_RIGIDBODY_STATE.md +13 -0
- package/dist/docs/api/index/classes/AnimationStateMachine.md +201 -0
- package/dist/docs/api/index/classes/AnimationStateManager.md +253 -0
- package/dist/docs/api/index/classes/AnimationSystem.md +68 -0
- package/dist/docs/api/index/classes/AudioSystem.md +98 -0
- package/dist/docs/api/index/classes/CameraSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/EnvironmentSyncSystem.md +75 -0
- package/dist/docs/api/index/classes/InputSystem.md +449 -0
- package/dist/docs/api/index/classes/LightSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/MaterialSyncSystem.md +67 -0
- package/dist/docs/api/index/classes/MeshGeometrySystem.md +49 -0
- package/dist/docs/api/index/classes/ObjectManagementSystem.md +298 -0
- package/dist/docs/api/index/classes/ObjectVisibilitySystem.md +49 -0
- package/dist/docs/api/index/classes/PhysicsSyncSystem.md +83 -0
- package/dist/docs/api/index/classes/PostprocessingSyncSystem.md +80 -0
- package/dist/docs/api/index/classes/RenderSystem.md +64 -0
- package/dist/docs/api/index/classes/ScriptBehaviourSystem.md +83 -0
- package/dist/docs/api/index/classes/TransformSyncSystem.md +49 -0
- package/dist/docs/api/index/classes/VideoSystem.md +97 -0
- package/dist/docs/api/index/classes/World.md +1405 -0
- package/dist/docs/api/index/functions/createAnimationComponent.md +28 -0
- package/dist/docs/api/index/functions/createAudioComponent.md +32 -0
- package/dist/docs/api/index/functions/createCameraComponent.md +28 -0
- package/dist/docs/api/index/functions/createEntityTypeComponent.md +28 -0
- package/dist/docs/api/index/functions/createEnvironmentComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageTargetAnchorComponent.md +28 -0
- package/dist/docs/api/index/functions/createImageTargetComponent.md +28 -0
- package/dist/docs/api/index/functions/createLightComponent.md +28 -0
- package/dist/docs/api/index/functions/createMaterialComponent.md +28 -0
- package/dist/docs/api/index/functions/createMeshComponent.md +28 -0
- package/dist/docs/api/index/functions/createMeshGeometryComponent.md +28 -0
- package/dist/docs/api/index/functions/createModelComponent.md +28 -0
- package/dist/docs/api/index/functions/createNameComponent.md +28 -0
- package/dist/docs/api/index/functions/createObject3DRefComponent.md +28 -0
- package/dist/docs/api/index/functions/createParentIdComponent.md +28 -0
- package/dist/docs/api/index/functions/createPhysicsComponent.md +30 -0
- package/dist/docs/api/index/functions/createPostprocessingComponent.md +28 -0
- package/dist/docs/api/index/functions/createScriptComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectableComponent.md +28 -0
- package/dist/docs/api/index/functions/createSelectionTransformStateComponent.md +28 -0
- package/dist/docs/api/index/functions/createSpriteComponent.md +28 -0
- package/dist/docs/api/index/functions/createTransformComponent.md +28 -0
- package/dist/docs/api/index/functions/createVideoComponent.md +28 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshot.md +28 -0
- package/dist/docs/api/index/functions/hydrateWorldFromSnapshotDetailed.md +28 -0
- package/dist/docs/api/index/functions/registerDefaultComponentFactories.md +23 -0
- package/dist/docs/api/index/functions/registerDefaultFactories.md +23 -0
- package/dist/docs/api/index/index.md +249 -0
- package/dist/docs/api/index/interfaces/EcsSystem.md +50 -0
- package/dist/docs/api/index/interfaces/StateMachine.md +26 -0
- package/dist/docs/api/index/type-aliases/AnimationStateCallbacks.md +25 -0
- package/dist/docs/api/index/type-aliases/ComponentFactory.md +25 -0
- package/dist/docs/api/index/type-aliases/EcsComponentFactoryKind.md +37 -0
- package/dist/docs/api/index/type-aliases/EcsWorldComponentSnapshot.md +26 -0
- package/dist/docs/api/index/type-aliases/EcsWorldStateSnapshotLike.md +25 -0
- package/dist/docs/api/index/type-aliases/HydrateWorldFromSnapshotResult.md +23 -0
- package/dist/docs/api/index/type-aliases/KeyboardKey.md +13 -0
- package/dist/docs/api/index/type-aliases/MouseButton.md +13 -0
- package/dist/docs/api/index/type-aliases/SelectionContext.md +31 -0
- package/dist/docs/api/index/variables/HYDRATABLE_ENTITY_KINDS.md +13 -0
- package/dist/docs/api/index/variables/KeyboardKeys.md +195 -0
- package/dist/docs/api/index.md +15 -0
- package/dist/docs/api/typedoc-sidebar.json +1 -0
- package/dist/docs/api/types/index.md +34 -0
- package/dist/docs/api/types/type-aliases/AssetInput.md +23 -0
- package/dist/docs/api/types/type-aliases/CheckboxInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ColorInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ComponentInput.md +52 -0
- package/dist/docs/api/types/type-aliases/ComponentKind.md +37 -0
- package/dist/docs/api/types/type-aliases/DropdownInput.md +23 -0
- package/dist/docs/api/types/type-aliases/DropdownOption.md +23 -0
- package/dist/docs/api/types/type-aliases/EcsEntityEditorKind.md +15 -0
- package/dist/docs/api/types/type-aliases/EcsEntityKind.md +35 -0
- package/dist/docs/api/types/type-aliases/EntityId.md +16 -0
- package/dist/docs/api/types/type-aliases/EntityInput.md +23 -0
- package/dist/docs/api/types/type-aliases/FloatInput.md +13 -0
- package/dist/docs/api/types/type-aliases/IntersectionResult.md +29 -0
- package/dist/docs/api/types/type-aliases/ParentLookup.md +26 -0
- package/dist/docs/api/types/type-aliases/SelectionListener.md +25 -0
- package/dist/docs/api/types/type-aliases/SliderInput.md +27 -0
- package/dist/docs/api/types/type-aliases/TextInput.md +13 -0
- package/dist/docs/api/types/type-aliases/ToggleInput.md +13 -0
- package/dist/docs/api/types/type-aliases/Vec3.md +23 -0
- package/dist/docs/api/types/type-aliases/Vector2Input.md +23 -0
- package/dist/docs/api/types/type-aliases/Vector3Input.md +25 -0
- package/dist/docs/api/types/type-aliases/WorldEntityView.md +17 -0
- package/dist/docs/guide/accessing-components.md +399 -0
- package/dist/docs/guide/authoring-a-behaviour.md +166 -0
- package/dist/docs/guide/behaviour-lifecycle.md +43 -0
- package/dist/docs/guide/component-catalog.md +59 -0
- package/dist/docs/guide/components/_sidebar.json +78 -0
- package/dist/docs/guide/components/animation.md +171 -0
- package/dist/docs/guide/components/audio.md +181 -0
- package/dist/docs/guide/components/camera.md +179 -0
- package/dist/docs/guide/components/entity-type.md +141 -0
- package/dist/docs/guide/components/image-target-anchor.md +103 -0
- package/dist/docs/guide/components/image-target.md +122 -0
- package/dist/docs/guide/components/image.md +146 -0
- package/dist/docs/guide/components/light.md +157 -0
- package/dist/docs/guide/components/material.md +161 -0
- package/dist/docs/guide/components/mesh-geometry.md +153 -0
- package/dist/docs/guide/components/mesh.md +151 -0
- package/dist/docs/guide/components/model.md +96 -0
- package/dist/docs/guide/components/name.md +121 -0
- package/dist/docs/guide/components/object3d-ref.md +115 -0
- package/dist/docs/guide/components/parent-id.md +108 -0
- package/dist/docs/guide/components/physics.md +163 -0
- package/dist/docs/guide/components/script.md +142 -0
- package/dist/docs/guide/components/sprite.md +155 -0
- package/dist/docs/guide/components/transform.md +155 -0
- package/dist/docs/guide/components/video.md +153 -0
- package/dist/docs/guide/concepts.md +34 -0
- package/dist/docs/guide/getting-started/creating-objects.md +50 -0
- package/dist/docs/guide/getting-started/editing-objects.md +62 -0
- package/dist/docs/guide/getting-started/editor/assets-browser.md +55 -0
- package/dist/docs/guide/getting-started/editor/hierarchy.md +47 -0
- package/dist/docs/guide/getting-started/editor/index.md +16 -0
- package/dist/docs/guide/getting-started/editor/inspector.md +36 -0
- package/dist/docs/guide/getting-started/editor/modules.md +35 -0
- package/dist/docs/guide/getting-started/editor/scene-inspector.md +64 -0
- package/dist/docs/guide/getting-started/editor/toolbar.md +39 -0
- package/dist/docs/guide/getting-started/editor/viewport.md +43 -0
- package/dist/docs/guide/getting-started/first-launch.md +17 -0
- package/dist/docs/guide/getting-started/index.md +37 -0
- package/dist/docs/guide/getting-started/installation.md +59 -0
- package/dist/docs/guide/getting-started/preview-and-test.md +55 -0
- package/dist/docs/guide/getting-started/project-types/3d.md +30 -0
- package/dist/docs/guide/getting-started/project-types/ar.md +6 -0
- package/dist/docs/guide/getting-started/project-types/face-tracking.md +6 -0
- package/dist/docs/guide/getting-started/project-types/image-tracking.md +42 -0
- package/dist/docs/guide/getting-started/project-types/index.md +25 -0
- package/dist/docs/guide/getting-started/project-types/vr.md +6 -0
- package/dist/docs/guide/getting-started/projects.md +53 -0
- package/dist/docs/guide/getting-started/shortcuts.md +43 -0
- package/dist/docs/guide/inspector-data-binding.md +367 -0
- package/dist/docs/guide/reading-input.md +202 -0
- package/dist/docs/guide/scene/environment.md +101 -0
- package/dist/docs/guide/scene/index.md +36 -0
- package/dist/docs/guide/scene/postprocessing.md +108 -0
- package/dist/docs/guide/spawning/ambient-light.md +28 -0
- package/dist/docs/guide/spawning/area-light.md +32 -0
- package/dist/docs/guide/spawning/audio.md +42 -0
- package/dist/docs/guide/spawning/camera.md +50 -0
- package/dist/docs/guide/spawning/capsule.md +29 -0
- package/dist/docs/guide/spawning/cube.md +31 -0
- package/dist/docs/guide/spawning/cylinder.md +29 -0
- package/dist/docs/guide/spawning/directional-light.md +32 -0
- package/dist/docs/guide/spawning/empty.md +31 -0
- package/dist/docs/guide/spawning/image-target.md +48 -0
- package/dist/docs/guide/spawning/image.md +33 -0
- package/dist/docs/guide/spawning/index.md +79 -0
- package/dist/docs/guide/spawning/model.md +31 -0
- package/dist/docs/guide/spawning/plane.md +31 -0
- package/dist/docs/guide/spawning/point-light.md +32 -0
- package/dist/docs/guide/spawning/sphere.md +29 -0
- package/dist/docs/guide/spawning/spot-light.md +32 -0
- package/dist/docs/guide/spawning/sprite.md +31 -0
- package/dist/docs/guide/spawning/video.md +53 -0
- package/dist/docs/guide/system-overview.md +73 -0
- package/dist/docs/guide/systems/_sidebar.json +66 -0
- package/dist/docs/guide/systems/animation-system.md +32 -0
- package/dist/docs/guide/systems/audio-system.md +28 -0
- package/dist/docs/guide/systems/camera-sync-system.md +31 -0
- package/dist/docs/guide/systems/environment-sync-system.md +31 -0
- package/dist/docs/guide/systems/input-system.md +217 -0
- package/dist/docs/guide/systems/light-sync-system.md +29 -0
- package/dist/docs/guide/systems/material-sync-system.md +32 -0
- package/dist/docs/guide/systems/mesh-geometry-system.md +40 -0
- package/dist/docs/guide/systems/object-management-system.md +38 -0
- package/dist/docs/guide/systems/object-visibility-system.md +26 -0
- package/dist/docs/guide/systems/physics-sync-system.md +56 -0
- package/dist/docs/guide/systems/postprocessing-sync-system.md +43 -0
- package/dist/docs/guide/systems/render-system.md +22 -0
- package/dist/docs/guide/systems/script-behaviour-system.md +59 -0
- package/dist/docs/guide/systems/transform-sync-system.md +29 -0
- package/dist/docs/guide/systems/video-system.md +30 -0
- package/dist/docs/guide/world-api.md +405 -0
- package/dist/factories/index.cjs +3077 -0
- package/dist/factories/index.cjs.map +1 -0
- package/dist/factories/index.d.cts +69 -0
- package/dist/factories/index.d.ts +69 -0
- package/dist/factories/index.js +6 -0
- package/dist/factories/index.js.map +1 -0
- package/dist/index-B4-YyUNR.d.cts +73 -0
- package/dist/index-BZUOKeTO.d.ts +73 -0
- package/dist/index.cjs +8584 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +283 -0
- package/dist/index.d.ts +283 -0
- package/dist/index.js +1729 -0
- package/dist/index.js.map +1 -0
- package/dist/systems/index.cjs +5119 -0
- package/dist/systems/index.cjs.map +1 -0
- package/dist/systems/index.d.cts +200 -0
- package/dist/systems/index.d.ts +200 -0
- package/dist/systems/index.js +6 -0
- package/dist/systems/index.js.map +1 -0
- package/dist/types.cjs +4 -0
- package/dist/types.cjs.map +1 -0
- package/dist/types.d.cts +3 -0
- package/dist/types.d.ts +3 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/dist/worldSnapshotUtils.cjs +259 -0
- package/dist/worldSnapshotUtils.cjs.map +1 -0
- package/dist/worldSnapshotUtils.d.cts +3 -0
- package/dist/worldSnapshotUtils.d.ts +3 -0
- package/dist/worldSnapshotUtils.js +4 -0
- package/dist/worldSnapshotUtils.js.map +1 -0
- package/package.json +80 -0
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / TransformData
|
|
6
|
+
|
|
7
|
+
# Type Alias: TransformData
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type TransformData = {
|
|
11
|
+
position?: Partial<Vec3>;
|
|
12
|
+
rotation?: Partial<Vec3>;
|
|
13
|
+
scale?: Partial<Vec3>;
|
|
14
|
+
};
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [components/Transform.ts:20](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L20)
|
|
18
|
+
|
|
19
|
+
Optional initial values passed to [TransformComponent](../classes/TransformComponent.md). Missing axes default to `0` for position/rotation and `1` for scale.
|
|
20
|
+
|
|
21
|
+
## Properties
|
|
22
|
+
|
|
23
|
+
| Property | Type | Description | Defined in |
|
|
24
|
+
| ------ | ------ | ------ | ------ |
|
|
25
|
+
| <a id="position"></a> `position?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial position (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:22](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L22) |
|
|
26
|
+
| <a id="rotation"></a> `rotation?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial rotation in **radians** (defaults to `{ 0, 0, 0 }`). | [components/Transform.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L24) |
|
|
27
|
+
| <a id="scale"></a> `scale?` | `Partial`\<[`Vec3`](Vec3.md)\> | Initial scale (defaults to `{ 1, 1, 1 }`). | [components/Transform.ts:26](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L26) |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / TransformModeValue
|
|
6
|
+
|
|
7
|
+
# Type Alias: TransformModeValue
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type TransformModeValue = "translate" | "rotate" | "scale";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/SelectionTransformState.ts:5](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/SelectionTransformState.ts#L5)
|
|
14
|
+
|
|
15
|
+
Active gizmo mode in the editor.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / TransformSpaceValue
|
|
6
|
+
|
|
7
|
+
# Type Alias: TransformSpaceValue
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type TransformSpaceValue = "world" | "local";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/SelectionTransformState.ts:7](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/SelectionTransformState.ts#L7)
|
|
14
|
+
|
|
15
|
+
Reference frame for the active gizmo.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [components](../index.md) / Vec3
|
|
6
|
+
|
|
7
|
+
# Type Alias: Vec3
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type Vec3 = {
|
|
11
|
+
x: number;
|
|
12
|
+
y: number;
|
|
13
|
+
z: number;
|
|
14
|
+
};
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [components/Transform.ts:10](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L10)
|
|
18
|
+
|
|
19
|
+
Plain XYZ vector. All ECS transform fields use this shape rather than `THREE.Vector3` so they save cleanly with the project.
|
|
20
|
+
|
|
21
|
+
## Properties
|
|
22
|
+
|
|
23
|
+
| Property | Type | Description | Defined in |
|
|
24
|
+
| ------ | ------ | ------ | ------ |
|
|
25
|
+
| <a id="x"></a> `x` | `number` | X component. | [components/Transform.ts:12](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L12) |
|
|
26
|
+
| <a id="y"></a> `y` | `number` | Y component. | [components/Transform.ts:14](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L14) |
|
|
27
|
+
| <a id="z"></a> `z` | `number` | Z component. | [components/Transform.ts:16](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Transform.ts#L16) |
|
|
@@ -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\_COLLIDER\_STATE
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_COLLIDER\_STATE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_COLLIDER_STATE: ColliderState;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Physics.ts:135](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L135)
|
|
@@ -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\_ENVIRONMENT\_STATE
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_ENVIRONMENT\_STATE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_ENVIRONMENT_STATE: EnvironmentState;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Environment.ts:73](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Environment.ts#L73)
|
|
@@ -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\_MESH\_GEOMETRY\_PARAMETERS
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_MESH\_GEOMETRY\_PARAMETERS
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_MESH_GEOMETRY_PARAMETERS: MeshGeometryParametersByKind;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/MeshGeometry.ts:62](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/MeshGeometry.ts#L62)
|
|
@@ -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\_PHYSICS\_STATE
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_PHYSICS\_STATE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_PHYSICS_STATE: PhysicsState;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Physics.ts:172](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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\_POSTPROCESSING\_STATE
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_POSTPROCESSING\_STATE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_POSTPROCESSING_STATE: PostprocessingState;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Postprocessing.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Postprocessing.ts#L142)
|
|
@@ -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\_RIGIDBODY\_STATE
|
|
6
|
+
|
|
7
|
+
# Variable: DEFAULT\_RIGIDBODY\_STATE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const DEFAULT_RIGIDBODY_STATE: RigidbodyState;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [components/Physics.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/components/Physics.ts#L59)
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / AnimationStateMachine
|
|
6
|
+
|
|
7
|
+
# Class: AnimationStateMachine
|
|
8
|
+
|
|
9
|
+
Defined in: [AnimationStateMachine.ts:24](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L24)
|
|
10
|
+
|
|
11
|
+
## Implements
|
|
12
|
+
|
|
13
|
+
- [`StateMachine`](../interfaces/StateMachine.md)
|
|
14
|
+
|
|
15
|
+
## Constructors
|
|
16
|
+
|
|
17
|
+
### Constructor
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
new AnimationStateMachine(
|
|
21
|
+
name,
|
|
22
|
+
clip,
|
|
23
|
+
callbacks?,
|
|
24
|
+
loop?,
|
|
25
|
+
clipId?): AnimationStateMachine;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Defined in: [AnimationStateMachine.ts:33](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L33)
|
|
29
|
+
|
|
30
|
+
#### Parameters
|
|
31
|
+
|
|
32
|
+
| Parameter | Type | Default value |
|
|
33
|
+
| ------ | ------ | ------ |
|
|
34
|
+
| `name` | `string` | `undefined` |
|
|
35
|
+
| `clip` | `AnimationClip` | `undefined` |
|
|
36
|
+
| `callbacks` | [`AnimationStateCallbacks`](../type-aliases/AnimationStateCallbacks.md) | `{}` |
|
|
37
|
+
| `loop` | `boolean` | `false` |
|
|
38
|
+
| `clipId` | `string` \| `null` | `null` |
|
|
39
|
+
|
|
40
|
+
#### Returns
|
|
41
|
+
|
|
42
|
+
`AnimationStateMachine`
|
|
43
|
+
|
|
44
|
+
## Properties
|
|
45
|
+
|
|
46
|
+
| Property | Type | Default value | Defined in |
|
|
47
|
+
| ------ | ------ | ------ | ------ |
|
|
48
|
+
| <a id="name"></a> `name` | `string` | `undefined` | [AnimationStateMachine.ts:25](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/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/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L30) |
|
|
54
|
+
|
|
55
|
+
## Methods
|
|
56
|
+
|
|
57
|
+
### setCallbacks()
|
|
58
|
+
|
|
59
|
+
```ts
|
|
60
|
+
setCallbacks(callbacks): void;
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Defined in: [AnimationStateMachine.ts:51](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L51)
|
|
64
|
+
|
|
65
|
+
#### Parameters
|
|
66
|
+
|
|
67
|
+
| Parameter | Type |
|
|
68
|
+
| ------ | ------ |
|
|
69
|
+
| `callbacks` | [`AnimationStateCallbacks`](../type-aliases/AnimationStateCallbacks.md) |
|
|
70
|
+
|
|
71
|
+
#### Returns
|
|
72
|
+
|
|
73
|
+
`void`
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### setLoop()
|
|
78
|
+
|
|
79
|
+
```ts
|
|
80
|
+
setLoop(loop): void;
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Defined in: [AnimationStateMachine.ts:59](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L59)
|
|
84
|
+
|
|
85
|
+
#### Parameters
|
|
86
|
+
|
|
87
|
+
| Parameter | Type |
|
|
88
|
+
| ------ | ------ |
|
|
89
|
+
| `loop` | `boolean` |
|
|
90
|
+
|
|
91
|
+
#### Returns
|
|
92
|
+
|
|
93
|
+
`void`
|
|
94
|
+
|
|
95
|
+
***
|
|
96
|
+
|
|
97
|
+
### onStart()
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
onStart(): void;
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Defined in: [AnimationStateMachine.ts:63](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L63)
|
|
104
|
+
|
|
105
|
+
#### Returns
|
|
106
|
+
|
|
107
|
+
`void`
|
|
108
|
+
|
|
109
|
+
#### Implementation of
|
|
110
|
+
|
|
111
|
+
[`StateMachine`](../interfaces/StateMachine.md).[`onStart`](../interfaces/StateMachine.md#onstart)
|
|
112
|
+
|
|
113
|
+
***
|
|
114
|
+
|
|
115
|
+
### onPlaying()
|
|
116
|
+
|
|
117
|
+
```ts
|
|
118
|
+
onPlaying(): void;
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Defined in: [AnimationStateMachine.ts:67](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L67)
|
|
122
|
+
|
|
123
|
+
#### Returns
|
|
124
|
+
|
|
125
|
+
`void`
|
|
126
|
+
|
|
127
|
+
#### Implementation of
|
|
128
|
+
|
|
129
|
+
[`StateMachine`](../interfaces/StateMachine.md).[`onPlaying`](../interfaces/StateMachine.md#onplaying)
|
|
130
|
+
|
|
131
|
+
***
|
|
132
|
+
|
|
133
|
+
### onEnd()
|
|
134
|
+
|
|
135
|
+
```ts
|
|
136
|
+
onEnd(): void;
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Defined in: [AnimationStateMachine.ts:71](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L71)
|
|
140
|
+
|
|
141
|
+
#### Returns
|
|
142
|
+
|
|
143
|
+
`void`
|
|
144
|
+
|
|
145
|
+
#### Implementation of
|
|
146
|
+
|
|
147
|
+
[`StateMachine`](../interfaces/StateMachine.md).[`onEnd`](../interfaces/StateMachine.md#onend)
|
|
148
|
+
|
|
149
|
+
***
|
|
150
|
+
|
|
151
|
+
### play()
|
|
152
|
+
|
|
153
|
+
```ts
|
|
154
|
+
play(): void;
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Defined in: [AnimationStateMachine.ts:75](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L75)
|
|
158
|
+
|
|
159
|
+
#### Returns
|
|
160
|
+
|
|
161
|
+
`void`
|
|
162
|
+
|
|
163
|
+
#### Implementation of
|
|
164
|
+
|
|
165
|
+
[`StateMachine`](../interfaces/StateMachine.md).[`play`](../interfaces/StateMachine.md#play)
|
|
166
|
+
|
|
167
|
+
***
|
|
168
|
+
|
|
169
|
+
### pause()
|
|
170
|
+
|
|
171
|
+
```ts
|
|
172
|
+
pause(): void;
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Defined in: [AnimationStateMachine.ts:87](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L87)
|
|
176
|
+
|
|
177
|
+
#### Returns
|
|
178
|
+
|
|
179
|
+
`void`
|
|
180
|
+
|
|
181
|
+
#### Implementation of
|
|
182
|
+
|
|
183
|
+
[`StateMachine`](../interfaces/StateMachine.md).[`pause`](../interfaces/StateMachine.md#pause)
|
|
184
|
+
|
|
185
|
+
***
|
|
186
|
+
|
|
187
|
+
### stop()
|
|
188
|
+
|
|
189
|
+
```ts
|
|
190
|
+
stop(): void;
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
Defined in: [AnimationStateMachine.ts:96](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L96)
|
|
194
|
+
|
|
195
|
+
#### Returns
|
|
196
|
+
|
|
197
|
+
`void`
|
|
198
|
+
|
|
199
|
+
#### Implementation of
|
|
200
|
+
|
|
201
|
+
[`StateMachine`](../interfaces/StateMachine.md).[`stop`](../interfaces/StateMachine.md#stop)
|
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / AnimationStateManager
|
|
6
|
+
|
|
7
|
+
# Class: AnimationStateManager
|
|
8
|
+
|
|
9
|
+
Defined in: [AnimationStateMachine.ts:107](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L107)
|
|
10
|
+
|
|
11
|
+
## Constructors
|
|
12
|
+
|
|
13
|
+
### Constructor
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
new AnimationStateManager(): AnimationStateManager;
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
#### Returns
|
|
20
|
+
|
|
21
|
+
`AnimationStateManager`
|
|
22
|
+
|
|
23
|
+
## Methods
|
|
24
|
+
|
|
25
|
+
### addState()
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
addState(state): AnimationStateMachine;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Defined in: [AnimationStateMachine.ts:111](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L111)
|
|
32
|
+
|
|
33
|
+
#### Parameters
|
|
34
|
+
|
|
35
|
+
| Parameter | Type |
|
|
36
|
+
| ------ | ------ |
|
|
37
|
+
| `state` | [`AnimationStateMachine`](AnimationStateMachine.md) |
|
|
38
|
+
|
|
39
|
+
#### Returns
|
|
40
|
+
|
|
41
|
+
[`AnimationStateMachine`](AnimationStateMachine.md)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### createState()
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
createState(
|
|
49
|
+
name,
|
|
50
|
+
clip,
|
|
51
|
+
callbacks?,
|
|
52
|
+
loop?,
|
|
53
|
+
clipId?): AnimationStateMachine;
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: [AnimationStateMachine.ts:116](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L116)
|
|
57
|
+
|
|
58
|
+
#### Parameters
|
|
59
|
+
|
|
60
|
+
| Parameter | Type | Default value |
|
|
61
|
+
| ------ | ------ | ------ |
|
|
62
|
+
| `name` | `string` | `undefined` |
|
|
63
|
+
| `clip` | `AnimationClip` | `undefined` |
|
|
64
|
+
| `callbacks` | [`AnimationStateCallbacks`](../type-aliases/AnimationStateCallbacks.md) | `{}` |
|
|
65
|
+
| `loop` | `boolean` | `false` |
|
|
66
|
+
| `clipId` | `string` \| `null` | `null` |
|
|
67
|
+
|
|
68
|
+
#### Returns
|
|
69
|
+
|
|
70
|
+
[`AnimationStateMachine`](AnimationStateMachine.md)
|
|
71
|
+
|
|
72
|
+
***
|
|
73
|
+
|
|
74
|
+
### removeState()
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
removeState(name): boolean;
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Defined in: [AnimationStateMachine.ts:128](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L128)
|
|
81
|
+
|
|
82
|
+
#### Parameters
|
|
83
|
+
|
|
84
|
+
| Parameter | Type |
|
|
85
|
+
| ------ | ------ |
|
|
86
|
+
| `name` | `string` |
|
|
87
|
+
|
|
88
|
+
#### Returns
|
|
89
|
+
|
|
90
|
+
`boolean`
|
|
91
|
+
|
|
92
|
+
***
|
|
93
|
+
|
|
94
|
+
### getState()
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
getState(name): AnimationStateMachine | null;
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Defined in: [AnimationStateMachine.ts:142](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L142)
|
|
101
|
+
|
|
102
|
+
#### Parameters
|
|
103
|
+
|
|
104
|
+
| Parameter | Type |
|
|
105
|
+
| ------ | ------ |
|
|
106
|
+
| `name` | `string` |
|
|
107
|
+
|
|
108
|
+
#### Returns
|
|
109
|
+
|
|
110
|
+
[`AnimationStateMachine`](AnimationStateMachine.md) \| `null`
|
|
111
|
+
|
|
112
|
+
***
|
|
113
|
+
|
|
114
|
+
### hasState()
|
|
115
|
+
|
|
116
|
+
```ts
|
|
117
|
+
hasState(name): boolean;
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Defined in: [AnimationStateMachine.ts:146](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L146)
|
|
121
|
+
|
|
122
|
+
#### Parameters
|
|
123
|
+
|
|
124
|
+
| Parameter | Type |
|
|
125
|
+
| ------ | ------ |
|
|
126
|
+
| `name` | `string` |
|
|
127
|
+
|
|
128
|
+
#### Returns
|
|
129
|
+
|
|
130
|
+
`boolean`
|
|
131
|
+
|
|
132
|
+
***
|
|
133
|
+
|
|
134
|
+
### listStates()
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
listStates(): AnimationStateMachine[];
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Defined in: [AnimationStateMachine.ts:150](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L150)
|
|
141
|
+
|
|
142
|
+
#### Returns
|
|
143
|
+
|
|
144
|
+
[`AnimationStateMachine`](AnimationStateMachine.md)[]
|
|
145
|
+
|
|
146
|
+
***
|
|
147
|
+
|
|
148
|
+
### getActiveState()
|
|
149
|
+
|
|
150
|
+
```ts
|
|
151
|
+
getActiveState(): AnimationStateMachine | null;
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Defined in: [AnimationStateMachine.ts:154](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L154)
|
|
155
|
+
|
|
156
|
+
#### Returns
|
|
157
|
+
|
|
158
|
+
[`AnimationStateMachine`](AnimationStateMachine.md) \| `null`
|
|
159
|
+
|
|
160
|
+
***
|
|
161
|
+
|
|
162
|
+
### switchState()
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
switchState(name, autoPlay?): AnimationStateMachine | null;
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Defined in: [AnimationStateMachine.ts:158](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L158)
|
|
169
|
+
|
|
170
|
+
#### Parameters
|
|
171
|
+
|
|
172
|
+
| Parameter | Type | Default value |
|
|
173
|
+
| ------ | ------ | ------ |
|
|
174
|
+
| `name` | `string` | `undefined` |
|
|
175
|
+
| `autoPlay` | `boolean` | `true` |
|
|
176
|
+
|
|
177
|
+
#### Returns
|
|
178
|
+
|
|
179
|
+
[`AnimationStateMachine`](AnimationStateMachine.md) \| `null`
|
|
180
|
+
|
|
181
|
+
***
|
|
182
|
+
|
|
183
|
+
### playState()
|
|
184
|
+
|
|
185
|
+
```ts
|
|
186
|
+
playState(name?): boolean;
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
Defined in: [AnimationStateMachine.ts:176](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L176)
|
|
190
|
+
|
|
191
|
+
#### Parameters
|
|
192
|
+
|
|
193
|
+
| Parameter | Type |
|
|
194
|
+
| ------ | ------ |
|
|
195
|
+
| `name?` | `string` |
|
|
196
|
+
|
|
197
|
+
#### Returns
|
|
198
|
+
|
|
199
|
+
`boolean`
|
|
200
|
+
|
|
201
|
+
***
|
|
202
|
+
|
|
203
|
+
### pauseState()
|
|
204
|
+
|
|
205
|
+
```ts
|
|
206
|
+
pauseState(name?): boolean;
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
Defined in: [AnimationStateMachine.ts:187](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L187)
|
|
210
|
+
|
|
211
|
+
#### Parameters
|
|
212
|
+
|
|
213
|
+
| Parameter | Type |
|
|
214
|
+
| ------ | ------ |
|
|
215
|
+
| `name?` | `string` |
|
|
216
|
+
|
|
217
|
+
#### Returns
|
|
218
|
+
|
|
219
|
+
`boolean`
|
|
220
|
+
|
|
221
|
+
***
|
|
222
|
+
|
|
223
|
+
### stopState()
|
|
224
|
+
|
|
225
|
+
```ts
|
|
226
|
+
stopState(name?): boolean;
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
Defined in: [AnimationStateMachine.ts:197](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L197)
|
|
230
|
+
|
|
231
|
+
#### Parameters
|
|
232
|
+
|
|
233
|
+
| Parameter | Type |
|
|
234
|
+
| ------ | ------ |
|
|
235
|
+
| `name?` | `string` |
|
|
236
|
+
|
|
237
|
+
#### Returns
|
|
238
|
+
|
|
239
|
+
`boolean`
|
|
240
|
+
|
|
241
|
+
***
|
|
242
|
+
|
|
243
|
+
### clear()
|
|
244
|
+
|
|
245
|
+
```ts
|
|
246
|
+
clear(): void;
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
Defined in: [AnimationStateMachine.ts:210](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/AnimationStateMachine.ts#L210)
|
|
250
|
+
|
|
251
|
+
#### Returns
|
|
252
|
+
|
|
253
|
+
`void`
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
[**@relu-interactives/spatial-ecs**](../../index.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@relu-interactives/spatial-ecs](../../index.md) / [index](../index.md) / AnimationSystem
|
|
6
|
+
|
|
7
|
+
# Class: AnimationSystem
|
|
8
|
+
|
|
9
|
+
Defined in: [systems/AnimationSystem.ts:295](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/AnimationSystem.ts#L295)
|
|
10
|
+
|
|
11
|
+
## Implements
|
|
12
|
+
|
|
13
|
+
- [`EcsSystem`](../interfaces/EcsSystem.md)
|
|
14
|
+
|
|
15
|
+
## Constructors
|
|
16
|
+
|
|
17
|
+
### Constructor
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
new AnimationSystem(): AnimationSystem;
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
#### Returns
|
|
24
|
+
|
|
25
|
+
`AnimationSystem`
|
|
26
|
+
|
|
27
|
+
## Methods
|
|
28
|
+
|
|
29
|
+
### update()
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
update(world, deltaTime): void;
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Defined in: [systems/AnimationSystem.ts:422](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/AnimationSystem.ts#L422)
|
|
36
|
+
|
|
37
|
+
#### Parameters
|
|
38
|
+
|
|
39
|
+
| Parameter | Type |
|
|
40
|
+
| ------ | ------ |
|
|
41
|
+
| `world` | [`World`](World.md) |
|
|
42
|
+
| `deltaTime` | `number` |
|
|
43
|
+
|
|
44
|
+
#### Returns
|
|
45
|
+
|
|
46
|
+
`void`
|
|
47
|
+
|
|
48
|
+
#### Implementation of
|
|
49
|
+
|
|
50
|
+
[`EcsSystem`](../interfaces/EcsSystem.md).[`update`](../interfaces/EcsSystem.md#update)
|
|
51
|
+
|
|
52
|
+
***
|
|
53
|
+
|
|
54
|
+
### dispose()
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
dispose(): void;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Defined in: [systems/AnimationSystem.ts:549](https://github.com/Relu-Interactives/relu-spatial-ecs-engine/blob/d7abe871a8dd71d2e6e1dff3235da21d5376bd8f/core/systems/AnimationSystem.ts#L549)
|
|
61
|
+
|
|
62
|
+
#### Returns
|
|
63
|
+
|
|
64
|
+
`void`
|
|
65
|
+
|
|
66
|
+
#### Implementation of
|
|
67
|
+
|
|
68
|
+
[`EcsSystem`](../interfaces/EcsSystem.md).[`dispose`](../interfaces/EcsSystem.md#dispose)
|