@relu-interactives/spatial-ecs 0.2.15 → 0.2.17

package/dist/index.d.cts

@@ -6,6 +6,7 @@ export { a2 as AnimationStateCallbacks, a3 as AnimationStateMachine, a4 as Anima
 export { i as CoreComponents } from './index-BfoOC2CG.cjs';
 export { AnimationSystem, AudioSystem, CameraSyncSystem, EnvironmentSyncSystem, InstancedMeshSystem, LightSyncSystem, MaterialSyncSystem, MeshGeometrySystem, ObjectVisibilitySystem, PhysicsSyncSystem, PostprocessingSyncSystem, ScriptBehaviourSystem, SelectionContext, VideoSystem } from './systems/index.cjs';
 export { createAnimationComponent, createAudioComponent, createCameraComponent, createEntityTypeComponent, createEnvironmentComponent, createImageComponent, createImageTargetAnchorComponent, createImageTargetComponent, createInstanceSlotComponent, createInstancedMeshComponent, createLightComponent, createMaterialComponent, createMeshComponent, createMeshGeometryComponent, createModelComponent, createNameComponent, createObject3DRefComponent, createParentIdComponent, createPhysicsComponent, createPostprocessingComponent, createScriptComponent, createSelectableComponent, createSelectionTransformStateComponent, createSpriteComponent, createTransformComponent, createVideoComponent, registerDefaultComponentFactories, registerDefaultFactories } from './factories/index.cjs';
+import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader.js';
 import '@dimforge/rapier3d-compat';
 
 interface CustomEcsSystem extends EcsSystem {
@@ -280,4 +281,34 @@ declare const HYDRATABLE_ENTITY_KINDS: Set<EcsEntityKind>;
 declare function hydrateWorldFromSnapshotDetailed(snapshot: EcsWorldStateSnapshotLike | null | undefined, world: World, objectManagementSystem: ObjectManagementSystem): HydrateWorldFromSnapshotResult;
 declare function hydrateWorldFromSnapshot(snapshot: EcsWorldStateSnapshotLike | null | undefined, world: World, objectManagementSystem: ObjectManagementSystem): number;
 
-export { Behaviour, Component, EcsEntityKind, EcsSystem, type EcsWorldComponentSnapshot, type EcsWorldStateSnapshotLike, HYDRATABLE_ENTITY_KINDS, type HydrateWorldFromSnapshotResult, ObjectManagementSystem, ParentLookup, World, WorldEntityView, hydrateWorldFromSnapshot, hydrateWorldFromSnapshotDetailed };
+/**
+ * Override where the DRACO decoder files (draco_wasm_wrapper.js,
+ * draco_decoder.wasm, draco_decoder.js) are fetched from. Embedding apps
+ * whose bundlers relocate this package's chunks — making the default
+ * import.meta.url resolution point at a location that is never populated —
+ * should call this before any model loads. The path must end with "/".
+ * Pass null to restore the default resolution.
+ */
+declare function setDracoDecoderPath(path: string | null): void;
+declare function resolveDracoDecoderPath(): string;
+
+/**
+ * userData flag set on geometries/materials that back shared (cached) model
+ * scenes. Entity disposal must skip these — other live clones and future
+ * spawns reference the same GPU resources.
+ */
+declare const SHARED_MODEL_RESOURCE_FLAG = "spatialEcsSharedModelResource";
+/**
+ * Load a GLTF once per URL and share the parsed result, so repeated spawns of
+ * the same model skip both the fetch and the parse. The cached scene must
+ * never be mounted directly (an Object3D has a single parent) — mount a
+ * cloneModelScene() of it. Failed loads are evicted so a retry re-fetches.
+ */
+declare function loadSharedGltf(url: string, load: () => Promise<GLTF>): Promise<GLTF>;
+/**
+ * Forget cached models (one URL, or everything). Subsequent loads fetch and
+ * parse anew. Does not dispose GPU resources — live clones may still use them.
+ */
+declare function clearModelCache(url?: string): void;
+
+export { Behaviour, Component, EcsEntityKind, EcsSystem, type EcsWorldComponentSnapshot, type EcsWorldStateSnapshotLike, HYDRATABLE_ENTITY_KINDS, type HydrateWorldFromSnapshotResult, ObjectManagementSystem, ParentLookup, SHARED_MODEL_RESOURCE_FLAG, World, WorldEntityView, clearModelCache, hydrateWorldFromSnapshot, hydrateWorldFromSnapshotDetailed, loadSharedGltf, resolveDracoDecoderPath, setDracoDecoderPath };

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export { a2 as AnimationStateCallbacks, a3 as AnimationStateMachine, a4 as Anima
 export { i as CoreComponents } from './index-BoJ3_6a3.js';
 export { AnimationSystem, AudioSystem, CameraSyncSystem, EnvironmentSyncSystem, InstancedMeshSystem, LightSyncSystem, MaterialSyncSystem, MeshGeometrySystem, ObjectVisibilitySystem, PhysicsSyncSystem, PostprocessingSyncSystem, ScriptBehaviourSystem, SelectionContext, VideoSystem } from './systems/index.js';
 export { createAnimationComponent, createAudioComponent, createCameraComponent, createEntityTypeComponent, createEnvironmentComponent, createImageComponent, createImageTargetAnchorComponent, createImageTargetComponent, createInstanceSlotComponent, createInstancedMeshComponent, createLightComponent, createMaterialComponent, createMeshComponent, createMeshGeometryComponent, createModelComponent, createNameComponent, createObject3DRefComponent, createParentIdComponent, createPhysicsComponent, createPostprocessingComponent, createScriptComponent, createSelectableComponent, createSelectionTransformStateComponent, createSpriteComponent, createTransformComponent, createVideoComponent, registerDefaultComponentFactories, registerDefaultFactories } from './factories/index.js';
+import { GLTF } from 'three/examples/jsm/loaders/GLTFLoader.js';
 import '@dimforge/rapier3d-compat';
 
 interface CustomEcsSystem extends EcsSystem {
@@ -280,4 +281,34 @@ declare const HYDRATABLE_ENTITY_KINDS: Set<EcsEntityKind>;
 declare function hydrateWorldFromSnapshotDetailed(snapshot: EcsWorldStateSnapshotLike | null | undefined, world: World, objectManagementSystem: ObjectManagementSystem): HydrateWorldFromSnapshotResult;
 declare function hydrateWorldFromSnapshot(snapshot: EcsWorldStateSnapshotLike | null | undefined, world: World, objectManagementSystem: ObjectManagementSystem): number;
 
-export { Behaviour, Component, EcsEntityKind, EcsSystem, type EcsWorldComponentSnapshot, type EcsWorldStateSnapshotLike, HYDRATABLE_ENTITY_KINDS, type HydrateWorldFromSnapshotResult, ObjectManagementSystem, ParentLookup, World, WorldEntityView, hydrateWorldFromSnapshot, hydrateWorldFromSnapshotDetailed };
+/**
+ * Override where the DRACO decoder files (draco_wasm_wrapper.js,
+ * draco_decoder.wasm, draco_decoder.js) are fetched from. Embedding apps
+ * whose bundlers relocate this package's chunks — making the default
+ * import.meta.url resolution point at a location that is never populated —
+ * should call this before any model loads. The path must end with "/".
+ * Pass null to restore the default resolution.
+ */
+declare function setDracoDecoderPath(path: string | null): void;
+declare function resolveDracoDecoderPath(): string;
+
+/**
+ * userData flag set on geometries/materials that back shared (cached) model
+ * scenes. Entity disposal must skip these — other live clones and future
+ * spawns reference the same GPU resources.
+ */
+declare const SHARED_MODEL_RESOURCE_FLAG = "spatialEcsSharedModelResource";
+/**
+ * Load a GLTF once per URL and share the parsed result, so repeated spawns of
+ * the same model skip both the fetch and the parse. The cached scene must
+ * never be mounted directly (an Object3D has a single parent) — mount a
+ * cloneModelScene() of it. Failed loads are evicted so a retry re-fetches.
+ */
+declare function loadSharedGltf(url: string, load: () => Promise<GLTF>): Promise<GLTF>;
+/**
+ * Forget cached models (one URL, or everything). Subsequent loads fetch and
+ * parse anew. Does not dispose GPU resources — live clones may still use them.
+ */
+declare function clearModelCache(url?: string): void;
+
+export { Behaviour, Component, EcsEntityKind, EcsSystem, type EcsWorldComponentSnapshot, type EcsWorldStateSnapshotLike, HYDRATABLE_ENTITY_KINDS, type HydrateWorldFromSnapshotResult, ObjectManagementSystem, ParentLookup, SHARED_MODEL_RESOURCE_FLAG, World, WorldEntityView, clearModelCache, hydrateWorldFromSnapshot, hydrateWorldFromSnapshotDetailed, loadSharedGltf, resolveDracoDecoderPath, setDracoDecoderPath };

package/dist/index.js

@@ -1,9 +1,9 @@
-import { MeshGeometrySystem, InstancedMeshSystem, EnvironmentSyncSystem, PostprocessingSyncSystem, LightSyncSystem, MaterialSyncSystem, PhysicsSyncSystem, AnimationSystem, AudioSystem, VideoSystem, CameraSyncSystem, TransformSyncSystem, ObjectVisibilitySystem, RenderSystem } from './chunk-D3AKP6QQ.js';
-export { AnimationSystem, AudioSystem, Behaviour, CameraSyncSystem, EnvironmentSyncSystem, InputSystem, InstancedMeshSystem, KeyboardKeys, LightSyncSystem, MaterialSyncSystem, MeshGeometrySystem, ObjectVisibilitySystem, PhysicsSyncSystem, PostprocessingSyncSystem, RenderSystem, ScriptBehaviourSystem, TransformSyncSystem, VideoSystem } from './chunk-D3AKP6QQ.js';
-import { registerDefaultFactories } from './chunk-7QBONTBW.js';
-export { createAnimationComponent, createAudioComponent, createCameraComponent, createEntityTypeComponent, createEnvironmentComponent, createImageComponent, createImageTargetAnchorComponent, createImageTargetComponent, createInstanceSlotComponent, createInstancedMeshComponent, createLightComponent, createMaterialComponent, createMeshComponent, createMeshGeometryComponent, createModelComponent, createNameComponent, createObject3DRefComponent, createParentIdComponent, createPhysicsComponent, createPostprocessingComponent, createScriptComponent, createSelectableComponent, createSelectionTransformStateComponent, createSpriteComponent, createTransformComponent, createVideoComponent, registerDefaultComponentFactories, registerDefaultFactories } from './chunk-7QBONTBW.js';
-import { ObjectManagementSystem, applyTransform } from './chunk-27RBPOVO.js';
-export { ObjectManagementSystem } from './chunk-27RBPOVO.js';
+import { MeshGeometrySystem, InstancedMeshSystem, EnvironmentSyncSystem, PostprocessingSyncSystem, LightSyncSystem, MaterialSyncSystem, PhysicsSyncSystem, AnimationSystem, AudioSystem, VideoSystem, CameraSyncSystem, TransformSyncSystem, ObjectVisibilitySystem, RenderSystem } from './chunk-EPK6MA7X.js';
+export { AnimationSystem, AudioSystem, Behaviour, CameraSyncSystem, EnvironmentSyncSystem, InputSystem, InstancedMeshSystem, KeyboardKeys, LightSyncSystem, MaterialSyncSystem, MeshGeometrySystem, ObjectVisibilitySystem, PhysicsSyncSystem, PostprocessingSyncSystem, RenderSystem, ScriptBehaviourSystem, TransformSyncSystem, VideoSystem } from './chunk-EPK6MA7X.js';
+import { registerDefaultFactories } from './chunk-CJW6K3CL.js';
+export { createAnimationComponent, createAudioComponent, createCameraComponent, createEntityTypeComponent, createEnvironmentComponent, createImageComponent, createImageTargetAnchorComponent, createImageTargetComponent, createInstanceSlotComponent, createInstancedMeshComponent, createLightComponent, createMaterialComponent, createMeshComponent, createMeshGeometryComponent, createModelComponent, createNameComponent, createObject3DRefComponent, createParentIdComponent, createPhysicsComponent, createPostprocessingComponent, createScriptComponent, createSelectableComponent, createSelectionTransformStateComponent, createSpriteComponent, createTransformComponent, createVideoComponent, registerDefaultComponentFactories, registerDefaultFactories } from './chunk-CJW6K3CL.js';
+import { ObjectManagementSystem, applyTransform } from './chunk-GRUK5TNL.js';
+export { ObjectManagementSystem, SHARED_MODEL_RESOURCE_FLAG, clearModelCache, loadSharedGltf, resolveDracoDecoderPath, setDracoDecoderPath } from './chunk-GRUK5TNL.js';
 import { SelectionTransformState, Object3DRef, Name, EntityType, ParentId, Environment, Postprocessing, ScriptComponent, InstancedMeshComponent, InstanceSlotComponent, AnimationComponent, TransformComponent, ModelComponent, ImageComponent, SpriteComponent, VideoComponent, AudioComponent, CameraComponent, ImageTarget, LightComponent, MaterialComponent, MeshGeometryComponent, Selectable, PhysicsComponent } from './chunk-FTIQQK62.js';
 export { AnimationStateMachine, AnimationStateManager, components_exports as CoreComponents } from './chunk-FTIQQK62.js';
 import './chunk-QHILSPT4.js';