@kitware/vtk.js 30.6.0 → 30.6.2

package/Rendering/Misc/GenericRenderWindow.d.ts

@@ -6,73 +6,71 @@ import vtkRenderWindowInteractor from './../Core/RenderWindowInteractor';
 import vtkOpenGLRenderWindow from './../OpenGL/RenderWindow';
 import vtkWebGPURenderWindow from './../WebGPU/RenderWindow';
 
-
 /**
  *
  */
 export interface IGenericRenderWindowInitialValues {
-	background?: RGBColor|RGBAColor;
-	listenWindowResize?: boolean;
-	container?: HTMLElement,
+  background?: RGBColor | RGBAColor;
+  listenWindowResize?: boolean;
+  container?: HTMLElement;
 }
 
 export interface vtkGenericRenderWindow extends vtkObject {
-
-	/**
-	 * Release GL context
-	 */
-	delete(): void;
-
-	/**
-	 * Get container element
-	 */
-	getContainer(): HTMLElement;
-
-	/**
-	 * Get interactor object
-	 */
-	getInteractor(): vtkRenderWindowInteractor;
-
-	/**
-	 * Get the render back-end specific render window.
-	 */
-	getApiSpecificRenderWindow(): vtkOpenGLRenderWindow|vtkWebGPURenderWindow;
-
-	/**
-	 * 
-	 */
-	getRenderWindow(): vtkRenderWindow;
-
-	/**
-	 * 
-	 */
-	getRenderer(): vtkRenderer;
-
-	/**
-	 * Method to register callback when the object is resize().
-	 *
-	 * @param callback function
-	 * @returns subscription object so you can easily unsubscribe later on
-	 */
-	onResize(callback: (instance: vtkObject) => any): vtkSubscription;
-
-	/**
-	 * Handle window resize
-	 */
-	resize(): void;
-
-	/**
-	 * Set background color
-	 * @param {RGBColor|RGBAColor} background The background color.
-	 * @returns true if the background color actually changed, false otherwise
-	 */
-	setBackground(background: RGBColor|RGBAColor): boolean;
-
-	/**
-	 * Set thecontainer element
-	 * @param {HTMLElement} el The container element.
-	 */
-	setContainer(el: HTMLElement): void;
+  /**
+   * Release GL context
+   */
+  delete(): void;
+
+  /**
+   * Get container element
+   */
+  getContainer(): HTMLElement;
+
+  /**
+   * Get interactor object
+   */
+  getInteractor(): vtkRenderWindowInteractor;
+
+  /**
+   * Get the render back-end specific render window.
+   */
+  getApiSpecificRenderWindow(): vtkOpenGLRenderWindow | vtkWebGPURenderWindow;
+
+  /**
+   *
+   */
+  getRenderWindow(): vtkRenderWindow;
+
+  /**
+   *
+   */
+  getRenderer(): vtkRenderer;
+
+  /**
+   * Method to register callback when the object is resize().
+   *
+   * @param callback function
+   * @returns subscription object so you can easily unsubscribe later on
+   */
+  onResize(callback: (instance: vtkObject) => any): vtkSubscription;
+
+  /**
+   * Handle window resize
+   */
+  resize(): void;
+
+  /**
+   * Set background color
+   * @param {RGBColor|RGBAColor} background The background color.
+   * @returns true if the background color actually changed, false otherwise
+   */
+  setBackground(background: RGBColor | RGBAColor): boolean;
+
+  /**
+   * Set thecontainer element
+   * @param {HTMLElement} el The container element.
+   */
+  setContainer(el: HTMLElement): void;
 }
 
 /**
@@ -82,20 +80,26 @@ export interface vtkGenericRenderWindow extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IGenericRenderWindowInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IGenericRenderWindowInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IGenericRenderWindowInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkGenericRenderWindow
  * @param {IGenericRenderWindowInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IGenericRenderWindowInitialValues): vtkGenericRenderWindow;
+export function newInstance(
+  initialValues?: IGenericRenderWindowInitialValues
+): vtkGenericRenderWindow;
 
 /**
  * vtkGenericRenderWindow provides a skeleton for implementing a render window
  * using one's own OpenGL context and drawable.
  */
 export declare const vtkGenericRenderWindow: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-}
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
 export default vtkGenericRenderWindow;

package/Rendering/Misc/RenderWindowWithControlBar.d.ts

@@ -1,50 +1,51 @@
-
 import { Placement } from './../../types';
-import vtkGenericRenderWindow, { IGenericRenderWindowInitialValues } from './GenericRenderWindow';
+import vtkGenericRenderWindow, {
+  IGenericRenderWindowInitialValues,
+} from './GenericRenderWindow';
 
 /**
  *
  */
-export interface IRenderWindowWithControlBarInitialValues extends IGenericRenderWindowInitialValues{
-	rootContainer?: HTMLElement,
-	controlPosition?: Placement;
-	controlSize?: number;
+export interface IRenderWindowWithControlBarInitialValues
+  extends IGenericRenderWindowInitialValues {
+  rootContainer?: HTMLElement;
+  controlPosition?: Placement;
+  controlSize?: number;
 }
 
 export interface vtkRenderWindowWithControlBar extends vtkGenericRenderWindow {
+  /**
+   * Get control bar container element
+   */
+  getControlContainer(): HTMLElement;
 
-	/**
-	 * Get control bar container element
-	 */
-	getControlContainer(): HTMLElement;
-
-	/**
-	 * Get RenderWindow container element
-	 */
-	getRenderWindowContainer(): HTMLElement;
+  /**
+   * Get RenderWindow container element
+   */
+  getRenderWindowContainer(): HTMLElement;
 
-	/**
-	 * Get root container element
-	 */
-	getRootContainer(): HTMLElement;
+  /**
+   * Get root container element
+   */
+  getRootContainer(): HTMLElement;
 
-	/**
-	 * Set control container element
-	 * @param {HTMLElement} el 
-	 */
-	setContainer(el: HTMLElement): void;
+  /**
+   * Set control container element
+   * @param {HTMLElement} el
+   */
+  setContainer(el: HTMLElement): void;
 
-	/**
-	 * Set control container element
-	 * @param {Number} size Size of the control bar.
-	 */
-	setControlSize(size: number): void;
+  /**
+   * Set control container element
+   * @param {Number} size Size of the control bar.
+   */
+  setControlSize(size: number): void;
 
-	/**
-	 * Set control container element
-	 * @param {Placement} position Position of the control bar.
-	 */
-	setControlPosition(position: Placement): void;
+  /**
+   * Set control container element
+   * @param {Placement} position Position of the control bar.
+   */
+  setControlPosition(position: Placement): void;
 }
 
 /**
@@ -54,20 +55,26 @@ export interface vtkRenderWindowWithControlBar extends vtkGenericRenderWindow {
  * @param model object on which data structure will be bounds (protected)
  * @param {IRenderWindowWithControlBarInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IRenderWindowWithControlBarInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IRenderWindowWithControlBarInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkRenderWindowWithControlBar
  * @param {IRenderWindowWithControlBarInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IRenderWindowWithControlBarInitialValues): vtkRenderWindowWithControlBar;
+export function newInstance(
+  initialValues?: IRenderWindowWithControlBarInitialValues
+): vtkRenderWindowWithControlBar;
 
 /**
  * vtkRenderWindowWithControlBar provides a skeleton for implementing a render window
  * with a control bar.
  */
 export declare const vtkRenderWindowWithControlBar: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-}
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
 export default vtkRenderWindowWithControlBar;

package/Rendering/Misc/SynchronizableRenderWindow/ObjectManager.d.ts

@@ -1,9 +1,16 @@
-import { vtkObject } from './../../../interfaces' ;
-import { Nullable } from './../../../types' ;
-import { ISynchronizerContext, IViewState } from "..";
+import { vtkObject } from './../../../interfaces';
+import { Nullable } from './../../../types';
+import { ISynchronizerContext, IViewState } from '..';
 
-export type BuilderFunction = <T extends vtkObject>(type: string, initialProps?: Record<string, unknown>) => Nullable<T>;
-export type UpdaterFunction = (instance: vtkObject, state: IViewState, context: ISynchronizerContext) => void;
+export type BuilderFunction = <T extends vtkObject>(
+  type: string,
+  initialProps?: Record<string, unknown>
+) => Nullable<T>;
+export type UpdaterFunction = (
+  instance: vtkObject,
+  state: IViewState,
+  context: ISynchronizerContext
+) => void;
 
 export interface IObjectManager {
   /**
@@ -12,65 +19,78 @@ export interface IObjectManager {
   build: BuilderFunction;
 
   /**
-   * @param {String} type The type to update 
-   * @param {vtkObject} instance The specific instance 
-   * @param {IViewState} props 
-   * @param {ISynchronizerContext} context 
+   * @param {String} type The type to update
+   * @param {vtkObject} instance The specific instance
+   * @param {IViewState} props
+   * @param {ISynchronizerContext} context
    */
-  update(type: string, instance: vtkObject, props: IViewState, context: ISynchronizerContext): Promise<Error | void>;
+  update(
+    type: string,
+    instance: vtkObject,
+    props: IViewState,
+    context: ISynchronizerContext
+  ): Promise<Error | void>;
 
   /**
    * Defines a new type handler with the specified builder and updater functions
-   * 
+   *
    * @param {String} type The type you wish to register
-   * @param {BuilderFunction} [buildFn] The builder function to associate with the type 
-   * @param {UpdaterFunction} [updateFn] The updater function to associate with the type 
+   * @param {BuilderFunction} [buildFn] The builder function to associate with the type
+   * @param {UpdaterFunction} [updateFn] The updater function to associate with the type
    */
-  setTypeMapping(type: string, buildFn?: BuilderFunction, updateFn?: UpdaterFunction): void;
-  
+  setTypeMapping(
+    type: string,
+    buildFn?: BuilderFunction,
+    updateFn?: UpdaterFunction
+  ): void;
+
   /**
    * Clear all type mappings
    */
   clearTypeMapping(): void;
- 
+
   /**
    * Get a list of all supported types
-   * 
+   *
    * @returns {string[]}
    */
   getSupportedTypes(): string[];
- 
+
   /**
    * Clear all one time updaters
    */
   clearOneTimeUpdaters(): void;
- 
+
   /**
    * Update the associated render window
    */
   updateRenderWindow(): void;
- 
+
   /**
    * Register a new type to exclude
-   * 
-   * @param {string} type The type to exclude 
+   *
+   * @param {string} type The type to exclude
    * @param {string} propertyName The property name to exclude
-   * @param {unknown} propertyValue The property value to exclude 
+   * @param {unknown} propertyValue The property value to exclude
    */
-  excludeInstance(type: string, propertyName: string, propertyValue: unknown): void;
- 
+  excludeInstance(
+    type: string,
+    propertyName: string,
+    propertyValue: unknown
+  ): void;
+
   /**
    * Set the default types mapping
-   * 
-   * @param {boolean} [reset] Clear all existing type mappings, defaults to true 
+   *
+   * @param {boolean} [reset] Clear all existing type mappings, defaults to true
    */
   setDefaultMapping(reset?: boolean): void;
- 
+
   /**
    * Apply the default aliases
    */
   applyDefaultAliases(): void;
- 
+
   /**
    * Always update the camera
    */

package/Rendering/Misc/SynchronizableRenderWindow.d.ts

@@ -1,32 +1,41 @@
 import { Nullable } from './../../types';
-import vtkRenderWindow, { IRenderWindowInitialValues } from './../Core/RenderWindow';
+import vtkRenderWindow, {
+  IRenderWindowInitialValues,
+} from './../Core/RenderWindow';
 
 // Keeps state for client / server scene synchronization.
 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: ISynchronizerContext): Promise<ArrayBuffer>;
-    emptyCachedArrays(): void;
-    freeOldArrays(threshold: number, context: ISynchronizerContext): void;
-
-    // instanceMap
-    getInstance(id: any): any;
-    getInstanceId(instance: any): any | null;
-    registerInstance(id: any, instance: any): void;
-    unregister(id: any): void;
-    emptyCachedInstances(): void;
-
-    // sceneMtimeHandler
-    getMtime(): number;
-    incrementMtime(viewId: string): number;
-    setActiveViewId(viewId: string): void;
-    getActiveViewId(): string;
-
-    // TODO: fill progresshandler
+  // 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: ISynchronizerContext
+  ): Promise<ArrayBuffer>;
+  emptyCachedArrays(): void;
+  freeOldArrays(threshold: number, context: ISynchronizerContext): void;
+
+  // instanceMap
+  getInstance(id: any): any;
+  getInstanceId(instance: any): any | null;
+  registerInstance(id: any, instance: any): void;
+  unregister(id: any): void;
+  emptyCachedInstances(): void;
+
+  // sceneMtimeHandler
+  getMtime(): number;
+  incrementMtime(viewId: string): number;
+  setActiveViewId(viewId: string): void;
+  getActiveViewId(): string;
+
+  // TODO: fill progresshandler
 }
 
-export interface ISynchronizableRenderWindowInitialValues extends IRenderWindowInitialValues {
+export interface ISynchronizableRenderWindowInitialValues
+  extends IRenderWindowInitialValues {
   synchronizerContextName?: string; // default: 'default':
   synchronizerContext?: Nullable<ISynchronizerContext>;
   synchronizedViewId?: Nullable<string>;
@@ -41,7 +50,7 @@ export interface IViewState {
   mtime: number;
   // ID of the parent. Null for the root.
   parent?: Nullable<string>;
-  properties?: {[key: string]: any};
+  properties?: { [key: string]: any };
   // Child objects.
   dependencies?: IViewState[];
   extra?: any;
@@ -52,7 +61,6 @@ export interface IViewState {
 }
 
 export interface vtkSynchronizableRenderWindow extends vtkRenderWindow {
-
   /**
    *
    */
@@ -101,13 +109,19 @@ export interface vtkSynchronizableRenderWindow extends vtkRenderWindow {
  * @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;
+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 function newInstance(
+  initialValues?: ISynchronizableRenderWindowInitialValues
+): vtkSynchronizableRenderWindow;
 
 /**
  *
@@ -120,8 +134,10 @@ export function getSynchronizerContext(name?: string): ISynchronizerContext;
  * @param {String} name
  * @param {Nullable<ISynchronizerContext>} ctx
  */
-export function setSynchronizerContext(name: string, ctx: Nullable<ISynchronizerContext>);
-
+export function setSynchronizerContext(
+  name: string,
+  ctx: Nullable<ISynchronizerContext>
+);
 
 /**
  *
@@ -164,11 +180,11 @@ export declare const vtkSynchronizableRenderWindow: {
   getSynchronizerContext: typeof getSynchronizerContext;
   setSynchronizerContext: typeof setSynchronizerContext;
   clearSynchronizerContext: typeof clearSynchronizerContext;
-  decorate: typeof decorate,
-  createInstanceMap: typeof createInstanceMap,
-  createArrayHandler: typeof createArrayHandler,
-  createProgressHandler: typeof createProgressHandler,
-  createSceneMtimeHandler: typeof createSceneMtimeHandler,
-  vtkObjectManager: object
+  decorate: typeof decorate;
+  createInstanceMap: typeof createInstanceMap;
+  createArrayHandler: typeof createArrayHandler;
+  createProgressHandler: typeof createProgressHandler;
+  createSceneMtimeHandler: typeof createSceneMtimeHandler;
+  vtkObjectManager: object;
 };
 export default vtkSynchronizableRenderWindow;