@kitware/vtk.js 22.5.5 → 22.5.6

package/Rendering/Misc/SynchronizableRenderWindow.d.ts

@@ -1,13 +1,13 @@
 import vtkRenderWindow, { IRenderWindowInitialValues } from '@kitware/vtk.js/Rendering/Core/RenderWindow';
 
 // Keeps state for client / server scene synchronization.
-export interface SynchContext {
+export interface ISynchronizerContext {
     // Set a function that fetches the data array for the given object.
     setFetchArrayFunction(fetcher: (hash: string, dataType: any) => Promise<ArrayBuffer>): void;
     // Invokes the fetcher registered by setFetchArrayFunction.
-    getArray(sha: string, dataType: any, context: SynchContext): Promise<ArrayBuffer>;
+    getArray(sha: string, dataType: any, context: ISynchronizerContext): Promise<ArrayBuffer>;
     emptyCachedArrays(): void;
-    freeOldArrays(threshold: number, context: SynchContext): void;
+    freeOldArrays(threshold: number, context: ISynchronizerContext): void;
 
     // instanceMap
     getInstance(id: any): any;
@@ -25,14 +25,14 @@ export interface SynchContext {
     // TODO: fill progresshandler
 }
 
-export interface IInitialValues extends IRenderWindowInitialValues {
+export interface ISynchronizableRenderWindowInitialValues extends IRenderWindowInitialValues {
   synchronizerContextName?: string; // default: 'default':
-  synchronizerContext?: SynchContext | null;
+  synchronizerContext?: ISynchronizerContext | null;
   synchronizedViewId?: string | null;
 }
 
 // Server-side view state.
-export interface ViewState {
+export interface IViewState {
   id: string;
   // vtk object type.
   type: string;
@@ -42,7 +42,7 @@ export interface ViewState {
   parent?: string | null;
   properties?: {[key: string]: any};
   // Child objects.
-  dependencies?: ViewState[];
+  dependencies?: IViewState[];
   extra?: any;
   // List of [methodName, args] to be invoked on the object.
   calls?: [string, string[]][];
@@ -50,24 +50,116 @@ export interface ViewState {
   [key: string]: any;
 }
 
-export interface vtkSynchronizableRenderWindowInstance extends vtkRenderWindow {
-  getSynchronizerContext(): SynchContext;
+export interface vtkSynchronizableRenderWindow extends vtkRenderWindow {
+
+  /**
+   * 
+   */
+  getSynchronizerContext(): ISynchronizerContext;
 
   // methods added by createSyncFunction
-  synchronize(state: ViewState): Promise<boolean>;
+
+  /**
+   * 
+   * @param {IViewState} state 
+   */
+  synchronize(state: IViewState): Promise<boolean>;
+
+  /**
+   * 
+   * @param {String} viewId 
+   */
   setSynchronizedViewId(viewId: string): void;
+
+  /**
+   * 
+   */
   getSynchronizedViewId(): string;
+
+  /**
+   * 
+   * @param {Number} v 
+   */
   updateGarbageCollectorThreshold(v: number): void;
-  getManagedInstanceIds(): Array<string>;
+
+  /**
+   * 
+   */
+  getManagedInstanceIds(): string[];
+
+  /**
+   * 
+   */
   clearOneTimeUpdaters(): void;
 }
 
-export function newInstance(props: IInitialValues): vtkSynchronizableRenderWindowInstance;
-export function getSynchronizerContext(name?: string): SynchContext;
+/**
+ * Method used to decorate a given object (publicAPI+model) with vtkCellArray characteristics.
+ *
+ * @param publicAPI object on which methods will be bounds (public)
+ * @param model object on which data structure will be bounds (protected)
+ * @param {ISynchronizableRenderWindowInitialValues} [initialValues] (default: {})
+ */
+export function extend(publicAPI: object, model: object, initialValues?: ISynchronizableRenderWindowInitialValues): void;
+
+/**
+ * Method used to create a new instance of vtkSynchronizableRenderWindow
+ * @param {ISynchronizableRenderWindowInitialValues} [initialValues] for pre-setting some of its content
+ */
+export function newInstance(initialValues?: ISynchronizableRenderWindowInitialValues): vtkSynchronizableRenderWindow;
 
-export const vtkSynchronizableRenderWindow: {
+/**
+ * 
+ * @param {String} [name] 
+ */
+export function getSynchronizerContext(name?: string): ISynchronizerContext;
+
+/**
+ * 
+ * @param {String} name 
+ * @param {ISynchronizerContext} ctx 
+ */
+export function setSynchronizerContext(name: string, ctx: ISynchronizerContext): ISynchronizerContext;
+
+/**
+ * 
+ * @param {vtkRenderWindow} renderWindow 
+ * @param {String} [name] 
+ */
+export function decorate(renderWindow: vtkRenderWindow, name?: string): object;
+
+/**
+ * 
+ */
+export function createInstanceMap(): object;
+
+/**
+ * 
+ */
+export function createArrayHandler(): object;
+
+/**
+ * 
+ */
+export function createProgressHandler(): object;
+
+/**
+ * 
+ */
+export function createSceneMtimeHandler(): object;
+
+/**
+ * 
+ */
+export declare const vtkSynchronizableRenderWindow: {
   newInstance: typeof newInstance;
   getSynchronizerContext: typeof getSynchronizerContext;
+  setSynchronizerContext: typeof setSynchronizerContext;
+  decorate: typeof decorate,
+  createInstanceMap: typeof createInstanceMap,
+  createArrayHandler: typeof createArrayHandler,
+  createProgressHandler: typeof createProgressHandler,
+  createSceneMtimeHandler: typeof createSceneMtimeHandler,
+  vtkObjectManager: object
 };
-
 export default vtkSynchronizableRenderWindow;

package/Rendering/OpenGL/ShaderCache.js

@@ -1,4 +1,4 @@
-import md5 from 'blueimp-md5';
+import Md5 from 'spark-md5';
 import macro from '../../macros.js';
 import vtkShaderProgram from './ShaderProgram.js';
 
@@ -88,7 +88,7 @@ function vtkShaderCache(publicAPI, model) {
   publicAPI.getShaderProgram = function (vertexCode, fragmentCode, geometryCode) {
     // compute the MD5 and the check the map
     var hashInput = "".concat(vertexCode).concat(fragmentCode).concat(geometryCode);
-    var result = md5(hashInput); // does it already exist?
+    var result = Md5.hash(hashInput); // does it already exist?
 
     var loc = Object.keys(model.shaderPrograms).indexOf(result);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitware/vtk.js",
-  "version": "22.5.5",
+  "version": "22.5.6",
   "description": "Visualization Toolkit for the Web",
   "keywords": [
     "3d",
@@ -31,7 +31,6 @@
   "module": "./index.js",
   "dependencies": {
     "@babel/runtime": "7.16.7",
-    "blueimp-md5": "2.19.0",
     "commander": "8.3.0",
     "d3-scale": "4.0.2",
     "gl-matrix": "3.4.3",
@@ -41,6 +40,7 @@
     "seedrandom": "3.0.5",
     "shader-loader": "1.3.1",
     "shelljs": "0.8.5",
+    "spark-md5": "^3.0.2",
     "stream-browserify": "3.0.0",
     "webworker-promise": "0.4.4",
     "worker-loader": "3.0.8",