@polarfront-lab/ionian 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -4,18 +4,75 @@ import * as THREE from 'three';
  * Represents an entry for an asset, pairing an ID with the asset itself.
  * @template T The type of the asset.
  */
-declare type AssetEntry<T> = {
+export declare type AssetEntry<T> = {
     id: string;
     item: T;
 };
 
+/**
+ * Represents a collection of assets, organized by asset ID and further
+ * categorized by numerical keys (e.g., texture size).
+ * @template T The type of the asset.
+ */
+export declare type Assets<T> = Map<string, Map<number, T>>;
+
+export declare type Callback = () => void;
+
+export declare type DataTextureEntry = {
+    textureSize: number;
+    dataTexture: THREE.DataTexture;
+};
+
+declare type DataTextureEvents = {
+    meshRegistered: {
+        id: string;
+    };
+};
+
 /**
  * Represents an easing function.
  */
-declare interface EasingFunction {
+export declare interface EasingFunction {
     (n: number): number;
 }
 
+export declare type Events = GlobalEvents & SimulationEvents & DataTextureEvents & MatcapEvents & TransitionEvents;
+
+declare type GlobalEvents = {
+    serviceStateUpdated: {
+        type: ServiceType;
+        state: ServiceState;
+    };
+    interactionPositionUpdated: {
+        position: THREE.Vector4Like;
+    };
+    invalidRequest: {
+        message: string;
+    };
+};
+
+declare type MatcapEvents = {
+    matcapRegistered: {
+        id: string;
+    };
+    matcapReplaced: {
+        id: string;
+    };
+};
+
+/**
+ * Represents the data of a mesh, including its position, normal, and scale.
+ */
+export declare type MeshData = {
+    position: ArrayLike<number>;
+    normal?: ArrayLike<number>;
+    scale: {
+        x: number;
+        y: number;
+        z: number;
+    };
+};
+
 /**
  * The main class for the particle engine.
  */
@@ -81,8 +138,46 @@ declare type ParticlesEngineParameters = {
     camera?: THREE.Camera;
 };
 
-declare type ServiceState = 'created' | 'initializing' | 'ready' | 'disposed' | 'error' | 'loading';
+export declare type ServiceState = 'created' | 'initializing' | 'ready' | 'disposed' | 'error' | 'loading';
+
+export declare type ServiceType = 'data-texture' | 'matcap' | 'instanced-mesh' | 'simulation';
+
+declare type SimulationEvents = {};
+
+export declare type TransitionCallback = (progress: number) => void;
+
+export declare interface TransitionDetail {
+    duration: number;
+    easing: EasingFunction;
+}
+
+declare type TransitionEvents = {
+    /** transition started */
+    transitionStarted: {
+        type: TransitionType;
+    };
+    /** transition progressed */
+    transitionProgressed: {
+        type: TransitionType;
+        progress: number;
+    };
+    /** transition finished */
+    transitionFinished: {
+        type: TransitionType;
+    };
+    /** transition cancelled */
+    transitionCancelled: {
+        type: TransitionType;
+    };
+};
+
+export declare type TransitionOptions = {
+    onTransitionBegin?: Callback;
+    onTransitionProgress?: TransitionCallback;
+    onTransitionFinished?: Callback;
+    onTransitionCancelled?: Callback;
+};
 
-declare type ServiceType = 'data-texture' | 'matcap' | 'instanced-mesh' | 'simulation';
+export declare type TransitionType = 'data-texture' | 'matcap';
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polarfront-lab/ionian",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "ThreeJS Collection Set",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",