@kitware/vtk.js 23.0.1 → 23.1.0

package/Rendering/Core/Property2D.d.ts

@@ -1,5 +1,5 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import { RGBColor } from '@kitware/vtk.js/types';
+import { vtkObject } from '../../interfaces';
+import { RGBColor } from '../../types';
 
 interface IProperty2DInitialValues{
 	color?: RGBColor;

package/Rendering/Core/RenderWindow.d.ts

@@ -1,7 +1,7 @@
-import { vtkObject, vtkSubscription } from '@kitware/vtk.js/interfaces';
-import vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
-import vtkRenderWindowInteractor from '@kitware/vtk.js/Rendering/Core/RenderWindowInteractor';
-// import vtkOpenGLRenderWindow from '@kitware/vtk.js/OpenGL/RenderWindow';
+import { vtkObject, vtkSubscription } from '../../interfaces';
+import vtkRenderer from './Renderer';
+import vtkRenderWindowInteractor from './RenderWindowInteractor';
+// import vtkOpenGLRenderWindow from '../../OpenGL/RenderWindow';
 
 export interface IRenderWindowInitialValues {	
 	renderers?: vtkRenderer[],

package/Rendering/Core/RenderWindowInteractor.d.ts

@@ -1,5 +1,5 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
+import { vtkObject } from '../../interfaces';
+import vtkRenderer from './Renderer';
 
 export enum Device {
 	Unknown,

package/Rendering/Core/Renderer.d.ts

@@ -1,13 +1,13 @@
-import { Bounds } from '@kitware/vtk.js/types';
+import { Bounds, Nullable } from '../../types';
 
-import vtkCamera from '@kitware/vtk.js/Rendering/Core/Camera';
-import vtkLight from '@kitware/vtk.js/Rendering/Core/Light';
-import vtkRenderWindow from '@kitware/vtk.js/Rendering/Core/RenderWindow';
-import vtkProp3D from '@kitware/vtk.js/Rendering/Core/Prop3D';
-import vtkViewport, { IViewportInitialValues } from '@kitware/vtk.js/Rendering/Core/Viewport';
-import vtkVolume from '@kitware/vtk.js/Rendering/Core/Volume';
-import vtkTexture from '@kitware/vtk.js/Rendering/Core/Texture';
-import vtkActor from '@kitware/vtk.js/Rendering/Core/Actor';
+import vtkCamera from './Camera';
+import vtkLight from './Light';
+import vtkRenderWindow from './RenderWindow';
+import vtkProp3D from './Prop3D';
+import vtkViewport, { IViewportInitialValues } from './Viewport';
+import vtkVolume from './Volume';
+import vtkTexture from './Texture';
+import vtkActor from './Actor';
 
 
 export interface IRendererInitialValues extends IViewportInitialValues {
@@ -128,6 +128,7 @@ export interface vtkRenderer extends vtkViewport {
 	 * 
 	 */
 	getClippingRangeExpansion(): number;
+
 	/**
 	 * 
 	 * @default null
@@ -226,7 +227,7 @@ export interface vtkRenderer extends vtkViewport {
 	 * 
 	 * @default null
 	 */
-	getRenderWindow(): vtkRenderWindow | null;
+	getRenderWindow(): Nullable<vtkRenderWindow>;
 
 	/**
 	 * 
@@ -337,7 +338,7 @@ export interface vtkRenderer extends vtkViewport {
 	 * Specify the camera to use for this renderer.
 	 * @param {vtkCamera} camera The camera object to use.
 	 */
-	setActiveCamera(camera: vtkCamera | null): boolean;
+	setActiveCamera(camera: vtkCamera): boolean;
 
 	/**
 	 * 

package/Rendering/Core/ScalarBarActor.d.ts

@@ -1,6 +1,6 @@
-import vtkScalarsToColors from '@kitware/vtk.js/Common/Core/ScalarsToColors';
-import { Size, Vector2, Vector3 } from '@kitware/vtk.js/types';
-import vtkActor, { IActorInitialValues } from '@kitware/vtk.js/Rendering/Core/Actor';
+import vtkScalarsToColors from '../../Common/Core/ScalarsToColors';
+import { Size, Vector2, Vector3 } from '../../types';
+import vtkActor, { IActorInitialValues } from './Actor';
 
 
 export interface ITextSizes {

package/Rendering/Core/Skybox.d.ts

@@ -1,4 +1,4 @@
-import vtkActor, { IActorInitialValues } from '@kitware/vtk.js/Rendering/Core/Actor';
+import vtkActor, { IActorInitialValues } from './Actor';
 
 export interface ISkyboxInitialValues extends IActorInitialValues {
 	format?: string;

package/Rendering/Core/SphereMapper.d.ts

@@ -1,4 +1,4 @@
-import vtkMapper, { IMapperInitialValues } from '@kitware/vtk.js/Rendering/Core/Mapper';
+import vtkMapper, { IMapperInitialValues } from './Mapper';
 
 export interface ISphereInitialValues extends IMapperInitialValues {
 	radius?: number;

package/Rendering/Core/StickMapper.d.ts

@@ -1,4 +1,4 @@
-import vtkMapper, { IMapperInitialValues } from '@kitware/vtk.js/Rendering/Core/Mapper';
+import vtkMapper, { IMapperInitialValues } from './Mapper';
 
 interface IStickMappereInitialValues extends IMapperInitialValues{
 	radius?: number;

package/Rendering/Core/Texture.d.ts

@@ -1,4 +1,4 @@
-import { vtkAlgorithm } from '@kitware/vtk.js/interfaces';
+import { vtkAlgorithm } from '../../interfaces';
 
 export interface ITextureInitialValues {
 	repeat?: boolean;

package/Rendering/Core/Viewport.d.ts

@@ -1,8 +1,8 @@
 
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import { RGBColor } from '@kitware/vtk.js/types';
-import vtkActor2D from '@kitware/vtk.js/Rendering/Core/Actor2D';
-import vtkProp from '@kitware/vtk.js/Rendering/Core/Prop';
+import { vtkObject } from '../../interfaces';
+import { RGBColor } from '../../types';
+import vtkActor2D from './Actor2D';
+import vtkProp from './Prop';
 
 export interface IViewportInitialValues {
     background?: RGBColor;

package/Rendering/Core/Volume.d.ts

@@ -1,7 +1,7 @@
-import { Bounds } from '@kitware/vtk.js/types';
-import vtkProp3D, { IProp3DInitialValues } from '@kitware/vtk.js/Rendering/Core/Prop3D';
-import vtkVolumeMapper from '@kitware/vtk.js/Rendering/Core/VolumeMapper';
-import vtkVolumeProperty from '@kitware/vtk.js/Rendering/Core/VolumeProperty';
+import { Bounds } from '../../types';
+import vtkProp3D, { IProp3DInitialValues } from './Prop3D';
+import vtkVolumeMapper from './VolumeMapper';
+import vtkVolumeProperty from './VolumeProperty';
 
 /**
  * 

package/Rendering/Core/VolumeMapper.d.ts

@@ -1,5 +1,5 @@
-import { Bounds, Range } from '@kitware/vtk.js/types';
-import vtkAbstractMapper, { IAbstractMapperInitialValues } from '@kitware/vtk.js/Rendering/Core/AbstractMapper';
+import { Bounds, Range } from '../../types';
+import vtkAbstractMapper, { IAbstractMapperInitialValues } from './AbstractMapper';
 
 export enum BlendMode {
 	COMPOSITE_BLEND,

package/Rendering/Core/VolumeProperty.d.ts

@@ -1,4 +1,4 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
+import { vtkObject } from '../../interfaces';
 
 export enum InterpolationType {
 	NEAREST,

package/Rendering/Misc/CanvasView.d.ts

@@ -1,5 +1,5 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import { Size } from '@kitware/vtk.js/types';
+import { vtkObject } from '../../interfaces';
+import { Size } from '../../types';
 
 
 /**

package/Rendering/Misc/FullScreenRenderWindow.d.ts

@@ -1,11 +1,11 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import { RGBColor } from '@kitware/vtk.js/types';
-import vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
-import vtkRenderWindow from '@kitware/vtk.js/Rendering/Core/RenderWindow';
-import vtkRenderWindowInteractor from '@kitware/vtk.js/Rendering/Core/RenderWindowInteractor';
-
-// import vtkOpenGLRenderWindow from '@kitware/vtk.js/OpenGL/RenderWindow';
-// import vtkWebGPURenderWindow from '@kitware/vtk.js/WebGPU/RenderWindow';
+import { vtkObject } from '../../interfaces';
+import { RGBColor } from '../../types';
+import vtkRenderer from '../Core/Renderer';
+import vtkRenderWindow from '../Core/RenderWindow';
+import vtkRenderWindowInteractor from '../Core/RenderWindowInteractor';
+
+// import vtkOpenGLRenderWindow from '../../OpenGL/RenderWindow';
+// import vtkWebGPURenderWindow from '../../WebGPU/RenderWindow';
 
 
 /**

package/Rendering/Misc/GenericRenderWindow.d.ts

@@ -1,9 +1,9 @@
-import { vtkObject, vtkSubscription } from '@kitware/vtk.js/interfaces';
-import { RGBColor } from '@kitware/vtk.js/types';
-import vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
-import vtkRenderWindow from '@kitware/vtk.js/Rendering/Core/RenderWindow';
-import vtkRenderWindowInteractor from '@kitware/vtk.js/Rendering/Core/RenderWindowInteractor';
-import vtkOpenGLRenderWindow from '@kitware/vtk.js/Rendering/OpenGL/RenderWindow';
+import { vtkObject, vtkSubscription } from '../../interfaces';
+import { RGBColor } from '../../types';
+import vtkRenderer from '../Core/Renderer';
+import vtkRenderWindow from '../Core/RenderWindow';
+import vtkRenderWindowInteractor from '../Core/RenderWindowInteractor';
+import vtkOpenGLRenderWindow from '../OpenGL/RenderWindow';
 
 
 /**

package/Rendering/Misc/RemoteView.d.ts

@@ -1,6 +1,6 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import vtkCanvasView from '@kitware/vtk.js/Rendering/Misc/CanvasView';
-import vtkViewStream from '@kitware/vtk.js/IO/Core/ImageStream/ViewStream';
+import { vtkObject } from '../../interfaces';
+import vtkCanvasView from './CanvasView';
+import vtkViewStream from '../../IO/Core/ImageStream/ViewStream';
 
 interface IRemoteViewInitialValues {
   viewId?: string;

package/Rendering/Misc/RenderWindowWithControlBar.d.ts

@@ -1,6 +1,6 @@
 
-import { Placement } from '@kitware/vtk.js/types';
-import vtkGenericRenderWindow, { IGenericRenderWindowInitialValues } from '@kitware/vtk.js/Rendering/Misc/GenericRenderWindow';
+import { Placement } from '../../types';
+import vtkGenericRenderWindow, { IGenericRenderWindowInitialValues } from './GenericRenderWindow';
 
 /**
  *

package/Rendering/Misc/SynchronizableRenderWindow.d.ts

@@ -1,4 +1,5 @@
-import vtkRenderWindow, { IRenderWindowInitialValues } from '@kitware/vtk.js/Rendering/Core/RenderWindow';
+import { Nullable } from '../../types';
+import vtkRenderWindow, { IRenderWindowInitialValues } from '../Core/RenderWindow';
 
 // Keeps state for client / server scene synchronization.
 export interface ISynchronizerContext {
@@ -27,8 +28,8 @@ export interface ISynchronizerContext {
 
 export interface ISynchronizableRenderWindowInitialValues extends IRenderWindowInitialValues {
   synchronizerContextName?: string; // default: 'default':
-  synchronizerContext?: ISynchronizerContext | null;
-  synchronizedViewId?: string | null;
+  synchronizerContext?: Nullable<ISynchronizerContext>;
+  synchronizedViewId?: Nullable<string>;
 }
 
 // Server-side view state.

package/Rendering/Misc/TextureLODsDownloader.d.ts

@@ -1,6 +1,6 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import { CrossOrigin } from '@kitware/vtk.js/types';
-import vtkTexture from '@kitware/vtk.js/Rendering/Core/Texture';
+import { vtkObject } from '../../interfaces';
+import { CrossOrigin, Nullable } from '../../types';
+import vtkTexture from '../Core/Texture';
 
 /**
  *
@@ -27,7 +27,7 @@ export interface vtkTextureLODsDownloader extends vtkObject {
 	/**
 	 * Get the crossorigin attribute
 	 */
-	getCrossOrigin(): CrossOrigin | null;
+	getCrossOrigin(): Nullable<CrossOrigin>;
 
 	/**
 	 * Get the list of files to download

package/Rendering/OpenGL/RenderWindow.d.ts

@@ -1,9 +1,9 @@
-import { vtkAlgorithm, vtkObject } from '@kitware/vtk.js/interfaces';
-import { Size, Vector2, Vector3 } from '@kitware/vtk.js/types';
-import { vtkRenderer } from '@kitware/vtk.js/Rendering/Core/Renderer';
-import { VtkDataTypes } from '@kitware/vtk.js/Common/Core/DataArray';
-import vtkTexture from '@kitware/vtk.js/Rendering/Core/Texture';
-import vtkViewStream from '@kitware/vtk.js/IO/Core/ImageStream/ViewStream';
+import { vtkAlgorithm, vtkObject } from '../../interfaces';
+import { Nullable, Size, Vector2, Vector3 } from '../../types';
+import { vtkRenderer } from '../../Rendering/Core/Renderer';
+import { VtkDataTypes } from '../../Common/Core/DataArray';
+import vtkTexture from '../Core/Texture';
+import vtkViewStream from '../../IO/Core/ImageStream/ViewStream';
 
 /**
  *
@@ -199,7 +199,7 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 	 *
 	 * @param options
 	 */
-	get3DContext(options: object): WebGLRenderingContext | null;
+	get3DContext(options: object): Nullable<WebGLRenderingContext>;
 
 	/**
 	 *
@@ -241,20 +241,20 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 
 	/**
 	 *
-	 * @param vtktype
-	 * @param numComps
-	 * @param useFloat
+	 * @param {VtkDataTypes} vtktype 
+	 * @param {Number} numComps 
+	 * @param {Boolean} useFloat 
 	 */
 	getDefaultTextureInternalFormat(vtktype: VtkDataTypes, numComps: number, useFloat: boolean): void;
 
 	/**
-	 *
-	 * @param {HTMLImageElement} img
+	 * 
+	 * @param {HTMLImageElement} img The background image.
 	 */
 	setBackgroundImage(img: HTMLImageElement): void;
 
 	/**
-	 *
+	 * 
 	 * @param {Boolean} value
 	 */
 	setUseBackgroundImage(value: boolean): void;
@@ -273,7 +273,7 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 	 * @param {String} format
 	 * @param {IOptions} options
 	 */
-	captureNextImage(format: string, options: IOptions): Promise<string> | null;
+	captureNextImage(format: string, options: IOptions): Nullable<Promise<string>>;
 
 	/**
 	 *
@@ -297,20 +297,20 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
 
 	/**
 	 *
-	 * @param stream
+	 * @param {vtkViewStream} stream The vtkViewStream instance.
 	 */
 	setViewStream(stream: vtkViewStream): boolean;
 
 	/**
 	 *
-	 * @param {Vector2} size
+	 * @param {Vector2} size 
 	 */
 	setSize(size: Vector2): void;
 
 	/**
 	 *
-	 * @param {Number} x
-	 * @param {Number} y
+	 * @param {Number} x 
+	 * @param {Number} y 
 	 */
 	setSize(x: number, y: number): void;
 

package/Rendering/SceneGraph/RenderPass.d.ts

@@ -1,5 +1,5 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import vtkViewNode from '@kitware/vtk.js/Rendering/SceneGraph/ViewNode';
+import { vtkObject } from '../../interfaces';
+import vtkViewNode from './ViewNode';
 
 /**
  * 

package/Rendering/SceneGraph/ViewNode.d.ts

@@ -1,5 +1,5 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
-import vtkRenderPass from '@kitware/vtk.js/Rendering/SceneGraph/RenderPass';
+import { vtkObject } from '../../interfaces';
+import vtkRenderPass from './RenderPass';
 
 export enum PASS_TYPES {
 	'Build',

package/Rendering/SceneGraph/ViewNodeFactory.d.ts

@@ -1,4 +1,4 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
+import { vtkObject } from '../../interfaces';
 
 /**
  * 

package/Widgets/Manipulators/LineManipulator.d.ts

@@ -1,4 +1,4 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
+import { vtkObject } from '../../interfaces';
 
 /**
  *

package/Widgets/Manipulators/PlaneManipulator.d.ts

@@ -1,4 +1,4 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
+import { vtkObject } from '../../interfaces';
 
 /**
  *

package/Widgets/Manipulators/TrackballManipulator.d.ts

@@ -1,4 +1,4 @@
-import { vtkObject } from '@kitware/vtk.js/interfaces';
+import { vtkObject } from '../../interfaces';
 
 /**
  *

package/Widgets/Representations/ResliceCursorContextRepresentation.d.ts

@@ -1,4 +1,4 @@
-import {vtkWidgetRepresentation, IWidgetRepresentationInitialValues} from '@kitware/vtk.js/Widgets/Representations/WidgetRepresentation';
+import {vtkWidgetRepresentation, IWidgetRepresentationInitialValues} from './WidgetRepresentation';
 
 export interface IResliceCursorContextRepresentationInitialValues extends IWidgetRepresentationInitialValues {
 	axis1Name?: string,

package/Widgets/Representations/WidgetRepresentation.d.ts

@@ -1,4 +1,4 @@
-import vtkProp from '@kitware/vtk.js/Rendering/Core/Prop';
+import vtkProp from '../../Rendering/Core/Prop';
 
 export interface IWidgetRepresentationInitialValues {
     labels?: Array<any>,

package/interfaces.d.ts

@@ -1,7 +1,7 @@
-import vtkDataArray from '@kitware/vtk.js/Common/Core/DataArray';
-import vtkImageData from '@kitware/vtk.js/Common/DataModel/ImageData';
-import vtkPolyData from '@kitware/vtk.js/Common/DataModel/PolyData';
-import { vtkPipelineConnection } from '@kitware/vtk.js/types';
+import vtkDataArray from '././Common/Core/DataArray';
+import vtkImageData from '././Common/DataModel/ImageData';
+import vtkPolyData from '././Common/DataModel/PolyData';
+import { vtkPipelineConnection } from '././types';
 
 /**
  * Object returned on any subscription call

package/macros.d.ts

@@ -1,4 +1,4 @@
-import { vtkSubscription, vtkDebouncedFunction, vtkProperty, vtkPropertyDomain } from '@kitware/vtk.js/interfaces';
+import { vtkSubscription, vtkDebouncedFunction, vtkProperty, vtkPropertyDomain } from '././interfaces';
 
 /**
  * Allow user to redefine vtkXXXMacro method call.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitware/vtk.js",
-  "version": "23.0.1",
+  "version": "23.1.0",
   "description": "Visualization Toolkit for the Web",
   "keywords": [
     "3d",

package/types.d.ts

@@ -1,4 +1,25 @@
-import { vtkOutputPort } from '@kitware/vtk.js/interfaces';
+import { vtkOutputPort } from '././interfaces';
+
+/** Alias type for value that can be null */
+declare type Nullable<T> = T | null;
+
+/**
+ * Alias type for number that are floats
+ * @ignorenaming
+ */
+declare type float = number;
+
+/**
+ * Alias type for number that are doubles.
+ * @ignorenaming
+ */
+declare type double = number;
+
+/**
+ * Alias type for number that are integer
+ * @ignorenaming
+ */
+declare type int = number;
 
 declare type TypedArray =
     | number[]

package/vtk.d.ts

@@ -1,15 +1,20 @@
+interface IvtkObject {
+    vtkClass: string;
+    [attrName: string]: unknown;
+}
+
 /**
  * 
  * @param obj 
  * @return  
  */
-declare function vtk(obj: object): any;
+declare function vtk(obj: IvtkObject): unknown;
 
 /**
  * Nest register method under the vtk function
  * @param vtkClassName 
  * @param constructor 
  */
-declare function register(vtkClassName: string, constructor: any): void;
+declare function register(vtkClassName: string, constructor: unknown): void;
 
 export default vtk;