@polarfront-lab/ionian 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+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> = {
+    id: string;
+    item: T;
+};
+
+/**
+ * Represents an easing function.
+ */
+declare interface EasingFunction {
+    (n: number): number;
+}
+
+/**
+ * The main class for the particle engine.
+ */
+export declare class ParticlesEngine {
+    private simulationRendererService;
+    private eventEmitter;
+    private renderer;
+    private scene;
+    private serviceStates;
+    private dataTextureManager;
+    private matcapService;
+    private instancedMeshManager;
+    private transitionService;
+    private engineState;
+    private intersectionService;
+    /**
+     * Creates a new ParticlesEngine instance.
+     * @param params The parameters for creating the instance.
+     */
+    constructor(params: ParticlesEngineParameters);
+    /**
+     * Renders the scene.
+     * @param elapsedTime The elapsed time since the last frame.
+     */
+    render(elapsedTime: number): void;
+    setOriginDataTexture(meshID: string, override?: boolean): void;
+    setDestinationDataTexture(meshID: string, override?: boolean): void;
+    setDataTextureTransitionProgress(progress: number, override?: boolean): void;
+    setOriginMatcap(matcapID: string, override?: boolean): void;
+    setDestinationMatcap(matcapID: string, override?: boolean): void;
+    setMatcapProgress(progress: number, override?: boolean): void;
+    setTextureSize(size: number): Promise<void>;
+    setPointerPosition(position: THREE.Vector2Like): void;
+    setGeometrySize(geometrySize: THREE.Vector3Like): void;
+    setVelocityTractionForce(force: number): void;
+    setPositionalTractionForce(force: number): void;
+    setMaxRepelDistance(distance: number): void;
+    scheduleMeshTransition(originMeshID: string, destinationMeshID: string, easing?: EasingFunction, duration?: number, override?: boolean): void;
+    scheduleMatcapTransition(originMatcapID: string, destinationMatcapID: string, easing?: EasingFunction, duration?: number, override?: boolean): void;
+    handleServiceStateUpdated({ type, state }: {
+        type: ServiceType;
+        state: ServiceState;
+    }): void;
+    /**
+     * Disposes the resources used by the engine.
+     */
+    dispose(): void;
+    private initialEngineState;
+    private initialServiceStates;
+    private handleTransitionProgress;
+    private handleInteractionPositionUpdated;
+}
+
+/**
+ * Parameters for creating a ParticlesEngine instance.
+ */
+declare type ParticlesEngineParameters = {
+    textureSize: number;
+    scene: THREE.Scene;
+    renderer: THREE.WebGLRenderer;
+    meshes?: AssetEntry<THREE.Mesh>[];
+    matcaps?: AssetEntry<THREE.Texture>[];
+    camera?: THREE.Camera;
+};
+
+declare type ServiceState = 'created' | 'initializing' | 'ready' | 'disposed' | 'error' | 'loading';
+
+declare type ServiceType = 'data-texture' | 'matcap' | 'instanced-mesh' | 'simulation';
+
+export { }