@kitware/vtk.js 30.6.0 → 30.6.2

package/Rendering/OpenGL/Texture.d.ts

@@ -3,7 +3,7 @@ import vtkOpenGLRenderWindow from './RenderWindow';
 import { Nullable } from './../../types';
 import { VtkDataTypes } from './../../Common/Core/DataArray';
 import { vtkViewNode } from './../SceneGraph/ViewNode';
-import { vtkObject } from './../../interfaces' ;
+import { vtkObject } from './../../interfaces';
 
 /**
  * Initial values for creating a new instance of vtkOpenGLTexture.
@@ -185,7 +185,14 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param flip Whether to flip the texture vertically.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create2DFromRaw(width: number, height: number, numComps: number, dataType: VtkDataTypes, data: any, flip: boolean): boolean;
+  create2DFromRaw(
+    width: number,
+    height: number,
+    numComps: number,
+    dataType: VtkDataTypes,
+    data: any,
+    flip: boolean
+  ): boolean;
 
   /**
    * Creates a cube texture from raw data.
@@ -197,7 +204,14 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param flip Whether to flip the texture vertically.
    * @returns {boolean} True if the cube texture was successfully created, false otherwise.
    */
-  createCubeFromRaw(width: number, height: number, numComps: number, dataType: VtkDataTypes, data: any, flip: boolean): boolean;
+  createCubeFromRaw(
+    width: number,
+    height: number,
+    numComps: number,
+    dataType: VtkDataTypes,
+    data: any,
+    flip: boolean
+  ): boolean;
 
   /**
    * Creates a 2D texture from an image.
@@ -216,7 +230,14 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param preferSizeOverAccuracy Whether to prefer texture size over accuracy.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create2DFilterableFromRaw(width: number, height: number, numComps: number, dataType: VtkDataTypes, data: any, preferSizeOverAccuracy: boolean): boolean;
+  create2DFilterableFromRaw(
+    width: number,
+    height: number,
+    numComps: number,
+    dataType: VtkDataTypes,
+    data: any,
+    preferSizeOverAccuracy: boolean
+  ): boolean;
 
   /**
    * Creates a 2D filterable texture from a data array, with a preference for size over accuracy if necessary.
@@ -226,7 +247,12 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param preferSizeOverAccuracy Whether to prefer texture size over accuracy.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create2DFilterableFromDataArray(width: number, height: number, dataArray: any, preferSizeOverAccuracy: boolean): boolean;
+  create2DFilterableFromDataArray(
+    width: number,
+    height: number,
+    dataArray: any,
+    preferSizeOverAccuracy: boolean
+  ): boolean;
 
   /**
    * Creates a 3D texture from raw data.
@@ -238,7 +264,14 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param data The raw data for the texture.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create3DFromRaw(width: number, height: number, depth: number, numComps: number, dataType: VtkDataTypes, data: any): boolean;
+  create3DFromRaw(
+    width: number,
+    height: number,
+    depth: number,
+    numComps: number,
+    dataType: VtkDataTypes,
+    data: any
+  ): boolean;
 
   /**
    * Creates a 3D filterable texture from raw data, with a preference for size over accuracy if necessary.
@@ -251,7 +284,15 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param preferSizeOverAccuracy Whether to prefer texture size over accuracy.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create3DFilterableFromRaw(width: number, height: number, depth: number, numComps: number, dataType: VtkDataTypes, values: any, preferSizeOverAccuracy: boolean): boolean;
+  create3DFilterableFromRaw(
+    width: number,
+    height: number,
+    depth: number,
+    numComps: number,
+    dataType: VtkDataTypes,
+    values: any,
+    preferSizeOverAccuracy: boolean
+  ): boolean;
 
   /**
    * Creates a 3D filterable texture from a data array, with a preference for size over accuracy if necessary.
@@ -262,7 +303,13 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @param preferSizeOverAccuracy Whether to prefer texture size over accuracy.
    * @returns {boolean} True if the texture was successfully created, false otherwise.
    */
-  create3DFilterableFromDataArray(width: number, height: number, depth: number, dataArray: any, preferSizeOverAccuracy: boolean): boolean;
+  create3DFilterableFromDataArray(
+    width: number,
+    height: number,
+    depth: number,
+    dataArray: any,
+    preferSizeOverAccuracy: boolean
+  ): boolean;
 
   /**
    * Sets the OpenGL render window in which the texture will be used.
@@ -276,7 +323,6 @@ export interface vtkOpenGLTexture extends vtkViewNode {
    * @returns {number} The maximum texture size.
    */
   getMaximumTextureSize(ctx: any): number;
-
 }
 
 /**
@@ -285,21 +331,27 @@ export interface vtkOpenGLTexture extends vtkViewNode {
  * @param model The model to use.
  * @param initialValues The initial values to apply.
  */
-export function extend(publicAPI: object, model: object, initialValues?: ITextureInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: ITextureInitialValues
+): void;
 
 /**
  * Creates a new instance of vtkOpenGLTexture with the given initial values.
  * @param initialValues The initial values to use.
  * @returns The new instance.
  */
-export function newInstance(initialValues?: ITextureInitialValues): vtkOpenGLTexture;
+export function newInstance(
+  initialValues?: ITextureInitialValues
+): vtkOpenGLTexture;
 
 /**
  * vtkOpenGLTexture static API.
  */
 export declare const vtkOpenGLTexture: {
-  newInstance: typeof newInstance,
-  extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 
-export default vtkOpenGLTexture;
+export default vtkOpenGLTexture;

package/Rendering/SceneGraph/RenderPass.d.ts

@@ -2,90 +2,89 @@ import { vtkObject } from './../../interfaces';
 import vtkViewNode from './ViewNode';
 
 /**
- * 
+ *
  */
 export interface IRenderPassInitialValues {
-	delegates: Array<any>;
-	preDelegateOperations: Array<any>;
-	postDelegateOperations: Array<any>;
+  delegates: Array<any>;
+  preDelegateOperations: Array<any>;
+  postDelegateOperations: Array<any>;
 }
 
 export interface vtkRenderPass extends vtkObject {
-
-	/**
-	 * 
-	 */
-	getCurrentOperation(): string;
-
-	/**
-	 * 
-	 */
-	getCurrentParent(): any;
-
-	/**
-	 * 
-	 */
-	getDelegates(): any;
-
-	/**
-	 * 
-	 */
-	getOperation(): void;
-
-	/**
-	 * 
-	 */
-	getPostDelegateOperations(): any;
-
-	/**
-	 * 
-	 */
-	getPreDelegateOperations(): any;
-
-	/**
-	 * 
-	 */
-	getTraverseOperation(): string;
-
-	/**
-	 * 
-	 * @param {String} val 
-	 */
-	setCurrentOperation(val: string): void;
-
-	/**
-	 * 
-	 * @param currentParent 
-	 */
-	setCurrentParent(currentParent: any): boolean;
-
-	/**
-	 * 
-	 * @param delegates 
-	 */
-	setDelegates(delegates: any): boolean;
-
-	/**
-	 * 
-	 * @param postDelegateOperations 
-	 */
-	setPostDelegateOperations(postDelegateOperations: any): boolean;
-
-	/**
-	 * 
-	 * @param preDelegateOperations 
-	 */
-	setPreDelegateOperations(preDelegateOperations: any): boolean;
-
-	/**
-	 * by default this class will traverse all of its
-	 * preDelegateOperations, then call its delegate render passes
-	 * the traverse all of its postDelegateOperations
-	 * any of those three arrays can be empty
-	 * @param viewNode 
-	 * @param parent 
-	 */
-	traverse(viewNode: vtkViewNode, parent: any): void;
+  /**
+   *
+   */
+  getCurrentOperation(): string;
+
+  /**
+   *
+   */
+  getCurrentParent(): any;
+
+  /**
+   *
+   */
+  getDelegates(): any;
+
+  /**
+   *
+   */
+  getOperation(): void;
+
+  /**
+   *
+   */
+  getPostDelegateOperations(): any;
+
+  /**
+   *
+   */
+  getPreDelegateOperations(): any;
+
+  /**
+   *
+   */
+  getTraverseOperation(): string;
+
+  /**
+   *
+   * @param {String} val
+   */
+  setCurrentOperation(val: string): void;
+
+  /**
+   *
+   * @param currentParent
+   */
+  setCurrentParent(currentParent: any): boolean;
+
+  /**
+   *
+   * @param delegates
+   */
+  setDelegates(delegates: any): boolean;
+
+  /**
+   *
+   * @param postDelegateOperations
+   */
+  setPostDelegateOperations(postDelegateOperations: any): boolean;
+
+  /**
+   *
+   * @param preDelegateOperations
+   */
+  setPreDelegateOperations(preDelegateOperations: any): boolean;
+
+  /**
+   * by default this class will traverse all of its
+   * preDelegateOperations, then call its delegate render passes
+   * the traverse all of its postDelegateOperations
+   * any of those three arrays can be empty
+   * @param viewNode
+   * @param parent
+   */
+  traverse(viewNode: vtkViewNode, parent: any): void;
 }
 
 /**
@@ -95,19 +94,25 @@ export interface vtkRenderPass extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IRenderPassInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IRenderPassInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IRenderPassInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkRenderPass.
  * @param {IRenderPassInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IRenderPassInitialValues): vtkRenderPass;
+export function newInstance(
+  initialValues?: IRenderPassInitialValues
+): vtkRenderPass;
 
 /**
  * vtkRenderPass is a deferred class with a simple deferred method Render.
  */
 export declare const vtkRenderPass: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkRenderPass;

package/Rendering/SceneGraph/ViewNode.d.ts

@@ -2,155 +2,153 @@ import { vtkObject } from './../../interfaces';
 import vtkRenderPass from './RenderPass';
 
 export enum PASS_TYPES {
-	'Build',
-	'Render'
+  'Build',
+  'Render',
 }
 
 /**
- * 
+ *
  */
 export interface IViewNodeInitialValues {
-	parent?: null,
-	renderable?: null,
-	myFactory?: null,
-	children?: Array<any>;
-	visited?: boolean;
+  parent?: null;
+  renderable?: null;
+  myFactory?: null;
+  children?: Array<any>;
+  visited?: boolean;
 }
 
 export interface vtkViewNode extends vtkObject {
-
-	/**
-	 * Add a child view node to this node, created from the renderable given as argument
-	 * If the node creation fails or the argument is falsy, returns undefined
-	 * Otherwise, returns the newly created node or the existing node
-	 * @param dobj 
-	 */
-	addMissingNode(dobj: any): vtkViewNode | undefined;
-
-	/**
-	 * 
-	 * @param dataObjs 
-	 */
-	addMissingNodes(dataObjs: any): void;
-
-	/**
-	 * 
-	 * @param {vtkRenderPass} renderPass 
-	 * @param prepass 
-	 */
-	apply(renderPass: vtkRenderPass, prepass: boolean): void;
-
-	/**
-	 * Builds myself.
-	 * @param prepass 
-	 */
-	build(prepass: any): void;
-
-	/**
-	 * 
-	 * @param dataObj 
-	 */
-	createViewNode(dataObj: any): void;
-
-	/**
-	 * 
-	 */
-	getChildren(): any;
-
-	/**
-	 * 
-	 */
-	getChildrenByReference(): any;
-
-	/**
-	 * Find the first parent/grandparent of the desired type
-	 * @param type 
-	 */
-	getFirstAncestorOfType(type: any): void;
-
-	/**
-	 * Find the last parent/grandparent of the desired type
-	 * @param type 
-	 */
-	getLastAncestorOfType(type: any): void;
-
-	/**
-	 * 
-	 */
-	getMyFactory(): any;
-
-	/**
-	 * 
-	 */
-	getParent(): any;
-
-	/**
-	 * Get The data object (thing to be rendered).
-	 */
-	getRenderable(): any;
-
-	/**
-	 * Returns the view node that corresponding to the provided object
-	 * Will return NULL if a match is not found in self or descendents
-	 * @param dataObject 
-	 */
-	getViewNodeFor(dataObject: any): any;
-
-	/**
-	 * 
-	 */
-	getVisited(): boolean;
-
-
-	//invokeEvent
-	//onEvent(callback: (instance: vtkObject) => any): vtkSubscription;
-
-	/**
-	 * 
-	 */
-	prepareNodes(): void;
-
-	/**
-	 * 
-	 */
-	removeUnusedNodes(): void;
-
-	/**
-	 * Makes calls to make self visible.
-	 * @param prepass 
-	 */
-	render(prepass: any): void;
-
-	/**
-	 * 
-	 * @param myFactory 
-	 */
-	setMyFactory(myFactory: any): boolean;
-
-	/**
-	 * 
-	 * @param parent 
-	 */
-	setParent(parent: any): boolean;
-
-	/**
-	 * 
-	 * @param renderable 
-	 */
-	setRenderable(renderable: any): boolean;
-
-	/**
-	 * 
-	 * @param val 
-	 */
-	setVisited(val: boolean): void;
-
-	/**
-	 * Traverse this node with the specified pass. If you want to traverse your
-	 * children in a specific order or way override this method
-	 * @param {vtkRenderPass} renderPass 
-	 */
-	traverse(renderPass: vtkRenderPass): void;
+  /**
+   * Add a child view node to this node, created from the renderable given as argument
+   * If the node creation fails or the argument is falsy, returns undefined
+   * Otherwise, returns the newly created node or the existing node
+   * @param dobj
+   */
+  addMissingNode(dobj: any): vtkViewNode | undefined;
+
+  /**
+   *
+   * @param dataObjs
+   */
+  addMissingNodes(dataObjs: any): void;
+
+  /**
+   *
+   * @param {vtkRenderPass} renderPass
+   * @param prepass
+   */
+  apply(renderPass: vtkRenderPass, prepass: boolean): void;
+
+  /**
+   * Builds myself.
+   * @param prepass
+   */
+  build(prepass: any): void;
+
+  /**
+   *
+   * @param dataObj
+   */
+  createViewNode(dataObj: any): void;
+
+  /**
+   *
+   */
+  getChildren(): any;
+
+  /**
+   *
+   */
+  getChildrenByReference(): any;
+
+  /**
+   * Find the first parent/grandparent of the desired type
+   * @param type
+   */
+  getFirstAncestorOfType(type: any): void;
+
+  /**
+   * Find the last parent/grandparent of the desired type
+   * @param type
+   */
+  getLastAncestorOfType(type: any): void;
+
+  /**
+   *
+   */
+  getMyFactory(): any;
+
+  /**
+   *
+   */
+  getParent(): any;
+
+  /**
+   * Get The data object (thing to be rendered).
+   */
+  getRenderable(): any;
+
+  /**
+   * Returns the view node that corresponding to the provided object
+   * Will return NULL if a match is not found in self or descendents
+   * @param dataObject
+   */
+  getViewNodeFor(dataObject: any): any;
+
+  /**
+   *
+   */
+  getVisited(): boolean;
+
+  //invokeEvent
+  //onEvent(callback: (instance: vtkObject) => any): vtkSubscription;
+
+  /**
+   *
+   */
+  prepareNodes(): void;
+
+  /**
+   *
+   */
+  removeUnusedNodes(): void;
+
+  /**
+   * Makes calls to make self visible.
+   * @param prepass
+   */
+  render(prepass: any): void;
+
+  /**
+   *
+   * @param myFactory
+   */
+  setMyFactory(myFactory: any): boolean;
+
+  /**
+   *
+   * @param parent
+   */
+  setParent(parent: any): boolean;
+
+  /**
+   *
+   * @param renderable
+   */
+  setRenderable(renderable: any): boolean;
+
+  /**
+   *
+   * @param val
+   */
+  setVisited(val: boolean): void;
+
+  /**
+   * Traverse this node with the specified pass. If you want to traverse your
+   * children in a specific order or way override this method
+   * @param {vtkRenderPass} renderPass
+   */
+  traverse(renderPass: vtkRenderPass): void;
 }
 
 /**
@@ -160,17 +158,23 @@ export interface vtkViewNode extends vtkObject {
  * @param model object on which data structure will be bounds (protected)
  * @param {IViewNodeInitialValues} [initialValues] (default: {})
  */
-export function extend(publicAPI: object, model: object, initialValues?: IViewNodeInitialValues): void;
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IViewNodeInitialValues
+): void;
 
 /**
  * Method used to create a new instance of vtkViewNode.
  * @param {IViewNodeInitialValues} [initialValues] for pre-setting some of its content
  */
-export function newInstance(initialValues?: IViewNodeInitialValues): vtkViewNode;
+export function newInstance(
+  initialValues?: IViewNodeInitialValues
+): vtkViewNode;
 
 /**
  * a node within a VTK scene graph
- * 
+ *
  * This is the superclass for all nodes within a VTK scene graph. It contains
  * the API for a node. It supports the essential operations such as graph
  * creation, state storage and traversal. Child classes adapt this to VTK's
@@ -178,7 +182,7 @@ export function newInstance(initialValues?: IViewNodeInitialValues): vtkViewNode
  * different rendering libraries.
  */
 export declare const vtkViewNode: {
-	newInstance: typeof newInstance,
-	extend: typeof extend,
+  newInstance: typeof newInstance;
+  extend: typeof extend;
 };
 export default vtkViewNode;