@d3p1/img2pxl 1.21.3 → 1.22.0

package/dist/core/app/image.d.ts

@@ -1,5 +1,11 @@
-import { Pane } from 'tweakpane';
 import { default as RendererManager } from '../lib/renderer-manager.js';
+import { default as DebugManager } from '../lib/debug-manager.js';
+/**
+ * @description Image
+ * @author      C. M. de Picciotto <d3p1@d3p1.dev> (https://d3p1.dev/)
+ * @note        This class handles the logic related to the
+ *              transformation of the image into vertices/points/pixels
+ */
 import * as THREE from 'three';
 export default class Image {
     #private;
@@ -11,14 +17,14 @@ export default class Image {
      * Constructor
      *
      * @param {RendererManager} rendererManager
-     * @param {Pane}            debugManager
+     * @param {DebugManager}    debugManager
      * @param {string}          imageSrc
      * @param {number}          resolutionWidth
      * @param {number}          resolutionHeight
      * @param {number}          pointSize
      * @param {number}          alphaTest
      */
-    constructor(rendererManager: RendererManager, debugManager: Pane, imageSrc: string, resolutionWidth: number, resolutionHeight: number, pointSize?: number, alphaTest?: number);
+    constructor(rendererManager: RendererManager, debugManager: DebugManager, imageSrc: string, resolutionWidth: number, resolutionHeight: number, pointSize?: number, alphaTest?: number);
     /**
      * Enable debug mode
      *

package/dist/core/app/pointer/canvas.d.ts

@@ -1,4 +1,13 @@
-import { Pane } from 'tweakpane';
+import { default as DebugManager } from '../../lib/debug-manager.js';
+/**
+ * @description Pointer canvas
+ * @author      C. M. de Picciotto <d3p1@d3p1.dev> (https://d3p1.dev/)
+ * @note        This canvas will be used as a texture that will be sent
+ *              to the vertex shader. This texture will be updated
+ *              to mark where the pointer is in relation with the image.
+ *              In that way, it allows selecting which vertices/points/pixels
+ *              should be displaced
+ */
 import * as THREE from 'three';
 export default class Canvas {
     #private;
@@ -13,14 +22,14 @@ export default class Canvas {
     /**
      * Constructor
      *
-     * @param {Pane}   debugManager
-     * @param {number} resolutionWidth
-     * @param {number} resolutionHeight
-     * @param {string} pointerImageSrc
-     * @param {number} pointerImageSize
-     * @param {number} pointerTrailingFactor
+     * @param {DebugManager} debugManager
+     * @param {number}       resolutionWidth
+     * @param {number}       resolutionHeight
+     * @param {string}       pointerImageSrc
+     * @param {number}       pointerImageSize
+     * @param {number}       pointerTrailingFactor
      */
-    constructor(debugManager: Pane, resolutionWidth: number, resolutionHeight: number, pointerImageSrc: string, pointerImageSize?: number, pointerTrailingFactor?: number);
+    constructor(debugManager: DebugManager, resolutionWidth: number, resolutionHeight: number, pointerImageSrc: string, pointerImageSize?: number, pointerTrailingFactor?: number);
     /**
      * Update
      *

package/dist/core/app.d.ts

@@ -1,5 +1,5 @@
-import { Pane } from 'tweakpane';
 import { default as RendererManager } from './lib/renderer-manager.js';
+import { default as DebugManager } from './lib/debug-manager.js';
 import { default as Image } from './app/image.js';
 import { default as Pointer } from './app/pointer.js';
 export default class App {
@@ -10,14 +10,14 @@ export default class App {
      * @param {Image}           image
      * @param {Pointer}         pointer
      * @param {RendererManager} rendererManager
-     * @param {Pane}            debugManager
+     * @param {DebugManager}    debugManager
      * @param {string}          noiseImageSrc
      * @param {number}          noiseFrequency
      * @param {number}          noiseAmplitude
      * @param {number}          displacementFrequency
      * @param {number}          displacementAmplitude
      */
-    constructor(image: Image, pointer: Pointer, rendererManager: RendererManager, debugManager: Pane, noiseImageSrc: string, noiseFrequency?: number, noiseAmplitude?: number, displacementFrequency?: number, displacementAmplitude?: number);
+    constructor(image: Image, pointer: Pointer, rendererManager: RendererManager, debugManager: DebugManager, noiseImageSrc: string, noiseFrequency?: number, noiseAmplitude?: number, displacementFrequency?: number, displacementAmplitude?: number);
     /**
      * Update
      *

package/dist/core/lib/debug-manager/copy/settings.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @description Debug manager raw settings
+ * @author      C. M. de Picciotto <d3p1@d3p1.dev> (https://d3p1.dev/)
+ * @note        It is returned a plain text of the settings that
+ *              should be used to instance current effect.
+ *              This plain text is used by the copy button of the
+ *              debug manager
+ */
+export declare const getSettings: (imageResolutionWidth: string, imageResolutionHeight: string, imagePixelSize: string, imagePixelMotionFrequency: string, imagePixelMotionAmplitude: string, imageMotionFrequency: string, imageMotionAmplitude: string, pointerSize: string, pointerTrailing: string) => string;

package/dist/core/lib/debug-manager.d.ts

@@ -0,0 +1,61 @@
+import { BindingParams, FolderApi, FolderParams, Pane } from 'tweakpane';
+import { BindingApi } from '@tweakpane/core';
+export default class DebugManager {
+    #private;
+    /**
+     * @type {Pane}
+     */
+    debugger: Pane;
+    /**
+     * Constructor
+     */
+    constructor();
+    /**
+     * Enable. Show debugger
+     *
+     * @returns {void}
+     */
+    enable(): void;
+    /**
+     * Disable. Hide debugger
+     *
+     * @returns {void}
+     */
+    disable(): void;
+    /**
+     * Dispose
+     *
+     * @returns {void}
+     */
+    dispose(): void;
+    /**
+     * Add folder
+     *
+     * @param   {{title: string; expanded?: boolean;}} config
+     * @returns {object}
+     */
+    addFolder(config: FolderParams): FolderApi;
+    /**
+     * Add binding with on change handler
+     *
+     * @param   {object}             object
+     * @param   {string}             property
+     * @param   {string}             label
+     * @param   {object | undefined} config
+     * @param   {object | undefined} folder
+     * @returns {object}
+     */
+    addBindingWithOnChange<K extends string, V>(object: {
+        [key in K]: V;
+    }, property: K, label: string, config: BindingParams | undefined, folder?: FolderApi | undefined): BindingApi<unknown, V>;
+    /**
+     * Add binding
+     *
+     * @param   {string}             label
+     * @param   {string | number}    value
+     * @param   {object | undefined} config
+     * @param   {object | undefined} folder
+     * @returns {object}
+     */
+    addBinding<V>(label: string, value: V, config: BindingParams | undefined, folder?: FolderApi | undefined): BindingApi<unknown, V>;
+}

package/dist/img2pxl.d.ts

@@ -1,5 +1,5 @@
-import { Pane } from 'tweakpane';
 import { default as RendererManager } from './core/lib/renderer-manager.js';
+import { default as DebugManager } from './core/lib/debug-manager.js';
 import { Config } from './types';
 export default class Img2Pxl {
     #private;
@@ -8,9 +8,9 @@ export default class Img2Pxl {
      */
     rendererManager: RendererManager;
     /**
-     * @type {Pane}
+     * @type {DebugManager}
      */
-    debugManager: Pane;
+    debugManager: DebugManager;
     /**
      * Constructor
      *