@kitware/vtk.js 30.6.0 → 30.6.2

package/Rendering/Misc/CanvasView.d.ts

@@ -1,153 +1,150 @@
 import { vtkObject } from './../../interfaces';
 import { Size } from './../../types';
 
-
 /**
  *
  */
 export interface ICanvasViewInitialValues {
-	canvas?: HTMLCanvasElement;
-	size?: Size;
-	cursorVisibility?: boolean;
-	cursor?: string;
-	useOffScreen?: boolean;
-	useBackgroundImage?: boolean;
+  canvas?: HTMLCanvasElement;
+  size?: Size;
+  cursorVisibility?: boolean;
+  cursor?: string;
+  useOffScreen?: boolean;
+  useBackgroundImage?: boolean;
 }
 
-
 export interface vtkCanvasView extends vtkObject {
-
-	/**
-	 * Get the canvas element
-	 */
-	getCanvas(): HTMLCanvasElement;
-
-	/**
-	 * Get the used cursor
-	 */
-	getCursor(): string;
-
-	/**
-	 * 
-	 */
-	getInteractive(): boolean;
-
-	/**
-	 * Get the interactor
-	 */
-	getInteractor(): any;
-
-	/**
-	 * 
-	 */
-	getRenderable(): any;
-
-	/**
-	 * 
-	 */
-	getRenderers(): any[];
-
-	/**
-	 * 
-	 */
-	getRenderersByReference(): any[];
-
-	/**
-	 * Get the size of the canvas view
-	 */
-	getSize(): Size;
-
-	/**
-	 * Get the size of the canvas view
-	 */
-	getSizeByReference(): boolean;
-
-	/**
-	 * 
-	 */
-	getUseBackgroundImage(): boolean;
-
-	/**
-	 * 
-	 */
-	getUseOffScreen(): boolean;
-
-	/**
-	 * 
-	 */
-	isInViewport(): boolean;
-
-	/**
-	 * 
-	 * @param {HTMLImageElement} backgroundImage The background image HTML element.
-	 */
-	setBackgroundImage(backgroundImage: HTMLImageElement): boolean;
-
-	/**
-	 * 
-	 * @param {HTMLCanvasElement} canvas The canvas HTML element.
-	 */
-	setCanvas(canvas: HTMLCanvasElement): boolean;
-
-	/**
-	 * 
-	 * @param {HTMLElement} container The container HTML element.
-	 */
-	setContainer(container: HTMLElement): boolean;
-
-	/**
-	 * 
-	 * @param {String} cursor The used cursor.
-	 */
-	setCursor(cursor: string): boolean;
-
-	/**
-	 * 
-	 * @param interactor 
-	 */
-	setInteractor(interactor: any): boolean;
-
-	/**
-	 * Set the size of the canvas view.
-	 * @param {Size} size The size of the canvas view.
-	 */
-	setSize(size: Size): boolean;
-
-	/**
-	 * Set the size of the canvas view.
-	 * @param {Number} width The width of the canvas view.
-	 * @param {Number} height The height of the canvas view.
-	 */
-	setSize(width: number, height: number): boolean;
-
-	/**
-	 * Set the size of the canvas view.
-	 * @param {Size} size The size of the canvas view.
-	 */
-	setSizeFrom(size: Size): boolean;
-
-	/**
-	 * 
-	 * @param useBackgroundImage 
-	 */
-	setUseBackgroundImage(useBackgroundImage: boolean): void;
-
-	/**
-	 * 
-	 * @param useOffScreen 
-	 */
-	setUseOffScreen(useOffScreen: boolean): boolean;
-
-	/**
-	 * 
-	 * @param viewStream 
-	 */
-	setViewStream(viewStream: any): boolean; // viewStream is vtkViewStream
-
-	/**
-	 * 
-	 */
-	traverseAllPasses(): void;
+  /**
+   * Get the canvas element
+   */
+  getCanvas(): HTMLCanvasElement;
+
+  /**
+   * Get the used cursor
+   */
+  getCursor(): string;
+
+  /**
+   *
+   */
+  getInteractive(): boolean;
+
+  /**
+   * Get the interactor
+   */
+  getInteractor(): any;
+
+  /**
+   *
+   */
+  getRenderable(): any;
+
+  /**
+   *
+   */
+  getRenderers(): any[];
+
+  /**
+   *
+   */
+  getRenderersByReference(): any[];
+
+  /**
+   * Get the size of the canvas view
+   */
+  getSize(): Size;
+
+  /**
+   * Get the size of the canvas view
+   */
+  getSizeByReference(): boolean;
+
+  /**
+   *
+   */
+  getUseBackgroundImage(): boolean;
+
+  /**
+   *
+   */
+  getUseOffScreen(): boolean;
+
+  /**
+   *
+   */
+  isInViewport(): boolean;
+
+  /**
+   *
+   * @param {HTMLImageElement} backgroundImage The background image HTML element.
+   */
+  setBackgroundImage(backgroundImage: HTMLImageElement): boolean;
+
+  /**
+   *
+   * @param {HTMLCanvasElement} canvas The canvas HTML element.
+   */
+  setCanvas(canvas: HTMLCanvasElement): boolean;
+
+  /**
+   *
+   * @param {HTMLElement} container The container HTML element.
+   */
+  setContainer(container: HTMLElement): boolean;
+
+  /**
+   *
+   * @param {String} cursor The used cursor.
+   */
+  setCursor(cursor: string): boolean;
+
+  /**
+   *
+   * @param interactor
+   */
+  setInteractor(interactor: any): boolean;
+
+  /**
+   * Set the size of the canvas view.
+   * @param {Size} size The size of the canvas view.
+   */
+  setSize(size: Size): boolean;
+
+  /**
+   * Set the size of the canvas view.
+   * @param {Number} width The width of the canvas view.
+   * @param {Number} height The height of the canvas view.
+   */
+  setSize(width: number, height: number): boolean;
+
+  /**
+   * Set the size of the canvas view.
+   * @param {Size} size The size of the canvas view.
+   */
+  setSizeFrom(size: Size): boolean;
+
+  /**
+   *
+   * @param useBackgroundImage
+   */
+  setUseBackgroundImage(useBackgroundImage: boolean): void;
+
+  /**
+   *
+   * @param useOffScreen
+   */
+  setUseOffScreen(useOffScreen: boolean): boolean;
+
+  /**
+   *
+   * @param viewStream
+   */
+  setViewStream(viewStream: any): boolean; // viewStream is vtkViewStream
+
+  /**
+   *
+   */
+  traverseAllPasses(): void;
 }
 
 /**
@@ -157,19 +154,25 @@ export interface vtkCanvasView extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {ICanvasViewInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: ICanvasViewInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: ICanvasViewInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkCanvasView
  * @param {ICanvasViewInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: ICanvasViewInitialValues): vtkCanvasView;
+export function newInstance(
+  initialValues?: ICanvasViewInitialValues
+): vtkCanvasView;
 
 /**
  * vtkCanvasView provides a way to create a canvas view.
  */
 export declare const vtkCanvasView: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-}
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
 export default vtkCanvasView;

package/Rendering/Misc/FullScreenRenderWindow.d.ts

@@ -7,116 +7,113 @@ import vtkRenderWindowInteractor from './../Core/RenderWindowInteractor';
 // import vtkOpenGLRenderWindow from './../../OpenGL/RenderWindow';
 // import vtkWebGPURenderWindow from './../../WebGPU/RenderWindow';
 
-
 /**
  *
  */
 export interface IFullScreenRenderWindowInitialValues {
-	background?: RGBColor | RGBAColor;
-	container?: HTMLElement
-	containerStyle?: object;
-	controlPanelStyle?: object;
-	controllerVisibility?: boolean;
-	defaultViewAPI?: boolean;
-	listenWindowResize?: boolean;
-	resizeCallback?: any;
+  background?: RGBColor | RGBAColor;
+  container?: HTMLElement;
+  containerStyle?: object;
+  controlPanelStyle?: object;
+  controllerVisibility?: boolean;
+  defaultViewAPI?: boolean;
+  listenWindowResize?: boolean;
+  resizeCallback?: any;
 }
 
-
 export interface vtkFullScreenRenderWindow extends vtkObject {
-
-	/**
-	 * 
-	 * @param {HTMLElement} html 
-	 */
-	addController(html : HTMLElement): void;
-		
-	/**
-	 * Representation API
-	 * @param representation 
-	 */
-	addRepresentation(representation : any): void;
-
-	/**
-	 * Release GL context
-	 */
-	delete(): void;
-
-	/**
-	 * Returns vtkWebGPURenderWindow if ?viewAPI='WebGPU' is in URL, or if
-	 * vtkFullScreenRenderWindow has been created with "defaultViewAPI: 'WebGPU",
-	 * otherwise vtkOpenGLRenderWindow is returned.
-	 */
-	getApiSpecificRenderWindow(): any; // vtkOpenGLRenderWindow || vtkWebGPURenderWindow
-
-	/**
-	 * Get container element
-	 */
-	getContainer(): HTMLElement;
-
-	/**
-	 * Get control container element
-	 */
-	getControlContainer(): HTMLElement;
-
-	/**
-	 * Get interactor object
-	 */
-	getInteractor(): vtkRenderWindowInteractor;
-
-	/**
-	 * Get Render windows object
-	 */
-	getRenderWindow(): vtkRenderWindow;
-
-	/**
-	 * Get Renderer object
-	 */
-	getRenderer(): vtkRenderer;
-
-	/**
-	 * Get root container element
-	 */
-	getRootContainer(): HTMLElement;
-
-	/**
-	 * Remove controller
-	 */
-	removeController(): void;
-
-	/**
-	 * Remove representation
-	 * @param representation 
-	 */
-	removeRepresentation(representation : any): void;
-
-	/**
-	 * Handle window resize
-	 */
-	resize(): void;
-
-	/**
-	 * Set background color
-	 * @param {RGBColor | RGBAColor} background The background color.
-	 */
-	setBackground(background: RGBColor | RGBAColor): boolean;
-
-	/**
-	 * Hide or show controller
-	 * @param {Boolean} visible 
-	 */
-	setControllerVisibility(visible : boolean): void;
-
-	/**
-	 * 
-	 * @param cb 
-	 */
-	setResizeCallback(cb : any): void;
-
-	/**
-	 * Toggle controller visibility
-	 */
-	toggleControllerVisibility(): void;
+  /**
+   *
+   * @param {HTMLElement} html
+   */
+  addController(html: HTMLElement): void;
+
+  /**
+   * Representation API
+   * @param representation
+   */
+  addRepresentation(representation: any): void;
+
+  /**
+   * Release GL context
+   */
+  delete(): void;
+
+  /**
+   * Returns vtkWebGPURenderWindow if ?viewAPI='WebGPU' is in URL, or if
+   * vtkFullScreenRenderWindow has been created with "defaultViewAPI: 'WebGPU",
+   * otherwise vtkOpenGLRenderWindow is returned.
+   */
+  getApiSpecificRenderWindow(): any; // vtkOpenGLRenderWindow || vtkWebGPURenderWindow
+
+  /**
+   * Get container element
+   */
+  getContainer(): HTMLElement;
+
+  /**
+   * Get control container element
+   */
+  getControlContainer(): HTMLElement;
+
+  /**
+   * Get interactor object
+   */
+  getInteractor(): vtkRenderWindowInteractor;
+
+  /**
+   * Get Render windows object
+   */
+  getRenderWindow(): vtkRenderWindow;
+
+  /**
+   * Get Renderer object
+   */
+  getRenderer(): vtkRenderer;
+
+  /**
+   * Get root container element
+   */
+  getRootContainer(): HTMLElement;
+
+  /**
+   * Remove controller
+   */
+  removeController(): void;
+
+  /**
+   * Remove representation
+   * @param representation
+   */
+  removeRepresentation(representation: any): void;
+
+  /**
+   * Handle window resize
+   */
+  resize(): void;
+
+  /**
+   * Set background color
+   * @param {RGBColor | RGBAColor} background The background color.
+   */
+  setBackground(background: RGBColor | RGBAColor): boolean;
+
+  /**
+   * Hide or show controller
+   * @param {Boolean} visible
+   */
+  setControllerVisibility(visible: boolean): void;
+
+  /**
+   *
+   * @param cb
+   */
+  setResizeCallback(cb: any): void;
+
+  /**
+   * Toggle controller visibility
+   */
+  toggleControllerVisibility(): void;
 }
 
 /**
@@ -126,20 +123,26 @@ export interface vtkFullScreenRenderWindow extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IFullScreenRenderWindowInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IFullScreenRenderWindowInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IFullScreenRenderWindowInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkFullScreenRenderWindow
  * @param {IFullScreenRenderWindowInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IFullScreenRenderWindowInitialValues): vtkFullScreenRenderWindow;
+export function newInstance(
+  initialValues?: IFullScreenRenderWindowInitialValues
+): vtkFullScreenRenderWindow;
 
 /**
  * vtkFullScreenRenderWindow provides a skeleton for implementing a fullscreen
  * render window.
  */
 export declare const vtkFullScreenRenderWindow: {
-	newInstance: typeof newInstance;
-	extend: typeof extend;
-}
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
 export default vtkFullScreenRenderWindow;