@kitware/vtk.js 22.6.0 → 22.6.1

package/Common/Core/MatrixBuilder.d.ts

@@ -1,5 +1,5 @@
 import { mat4 } from 'gl-matrix';
-import { TypedArray } from '@kitware/vtk.js/types';
+import { TypedArray, Vector3 } from '@kitware/vtk.js/types';
 
 declare interface Transform {
 
@@ -22,9 +22,9 @@ declare interface Transform {
 	 * Normalizes the axis of rotation then rotates the current matrix `angle`
 	 * degrees/radians around the provided axis.
 	 * @param {Number} angle 
-	 * @param {Number} axis 
+	 * @param {Vector3} axis 
 	 */
-	rotate(angle: number, axis: number): Transform
+	rotate(angle: number, axis: Vector3): Transform
 
 	/**
 	 * Rotates `angle` degrees/radians around the X axis.

package/Common/DataModel/ImageData.d.ts

@@ -201,17 +201,18 @@ export interface vtkImageData extends vtkDataSet {
 	/**
 	 * this is the fast version, requires vec3 arguments
 	 * @param {ReadonlyVec3} vin 
-	 * @param {vec3} vout 
+	 * @param {vec3} [vout] 
 	 */
-	indexToWorldVec3(vin: ReadonlyVec3, vout: vec3): vec3;
+	indexToWorldVec3(vin: ReadonlyVec3, vout?: vec3): vec3;
 
 	/**
-	 * Converts the input index vector `[i,j,k]` to world values `[x,y,z]`.
-	 * Modifies the out vector array in place, but also returns it.
+	 * Converts the input index vector `[i,j,k]` to world values `[x,y,z]`. 
+	 * If an out vector is not provided, a new one is created. If provided, it
+	 * modifies the out vector array in place, but also returns it.
 	 * @param {ReadonlyVec3} ain 
-	 * @param {vec3} aout 
+	 * @param {vec3} [aout] 
 	 */
-	indexToWorld(ain: ReadonlyVec3, aout: vec3): vec3;
+	indexToWorld(ain: ReadonlyVec3, aout?: vec3): vec3;
 
 	/**
 	 * Calculate the corresponding world bounds for the given index bounds
@@ -308,18 +309,19 @@ export interface vtkImageData extends vtkDataSet {
 	/**
 	 * this is the fast version, requires vec3 arguments
 	 * @param vin 
-	 * @param vout 
+	 * @param [vout] 
 	 */
-	worldToIndexVec3(vin: ReadonlyVec3, vout: vec3): vec3;
+	worldToIndexVec3(vin: ReadonlyVec3, vout?: vec3): vec3;
 
 	/**
 	 * Converts the input world vector `[x,y,z]` to approximate index values
 	 * `[i,j,k]`. Should be rounded to integers before attempting to access the
-	 * index. Modifies the out vector array in place, but also returns it.
+	 * index. If an out vector is not provided, a new one is created. If provided, it
+	 * modifies the out vector array in place, but also returns it.
 	 * @param ain 
-	 * @param aout 
+	 * @param [aout] 
 	 */
-	worldToIndex(ain: ReadonlyVec3, aout: vec3): vec3;
+	worldToIndex(ain: ReadonlyVec3, aout?: vec3): vec3;
 
 	/**
 	 * Calculate the corresponding index bounds for the given world bounds

package/LICENSE

@@ -3,22 +3,25 @@ All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of the <organization> nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+- Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+- Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/Rendering/Core/RenderWindowInteractor.js

@@ -325,7 +325,21 @@ function vtkRenderWindowInteractor(publicAPI, model) {
 
     animationRequesters.add(requestor);
 
-    if (animationRequesters.size === 1 && !model.xrAnimation) {
+    if (!model.animationRequest && animationRequesters.size === 1 && !model.xrAnimation) {
+      model._animationStartTime = Date.now();
+      model._animationFrameCount = 0;
+      model.animationRequest = requestAnimationFrame(publicAPI.handleAnimation);
+      publicAPI.startAnimationEvent();
+    }
+  }; // continue animating for at least the specified duration of
+  // milliseconds.
+
+
+  publicAPI.extendAnimation = function (duration) {
+    var newEnd = Date.now() + duration;
+    model._animationExtendedEnd = Math.max(model._animationExtendedEnd, newEnd);
+
+    if (!model.animationRequest && animationRequesters.size === 0 && !model.xrAnimation) {
       model._animationStartTime = Date.now();
       model._animationFrameCount = 0;
       model.animationRequest = requestAnimationFrame(publicAPI.handleAnimation);
@@ -351,7 +365,7 @@ function vtkRenderWindowInteractor(publicAPI, model) {
 
     animationRequesters.delete(requestor);
 
-    if (model.animationRequest && animationRequesters.size === 0) {
+    if (model.animationRequest && animationRequesters.size === 0 && Date.now() > model._animationExtendedEnd) {
       cancelAnimationFrame(model.animationRequest);
       model.animationRequest = null;
       publicAPI.endAnimationEvent();
@@ -462,7 +476,15 @@ function vtkRenderWindowInteractor(publicAPI, model) {
 
     publicAPI.animationEvent();
     forceRender();
-    model.animationRequest = requestAnimationFrame(publicAPI.handleAnimation);
+
+    if (animationRequesters.size > 0 || Date.now() < model._animationExtendedEnd) {
+      model.animationRequest = requestAnimationFrame(publicAPI.handleAnimation);
+    } else {
+      cancelAnimationFrame(model.animationRequest);
+      model.animationRequest = null;
+      publicAPI.endAnimationEvent();
+      publicAPI.render();
+    }
   };
 
   publicAPI.handleWheel = function (event) {
@@ -497,9 +519,10 @@ function vtkRenderWindowInteractor(publicAPI, model) {
 
 
     model.wheelTimeoutID = setTimeout(function () {
+      publicAPI.extendAnimation(600);
       publicAPI.endMouseWheelEvent();
       model.wheelTimeoutID = 0;
-    }, 800);
+    }, 200);
   };
 
   publicAPI.handleMouseEnter = function (event) {
@@ -987,7 +1010,9 @@ function extend(publicAPI, model) {
   var initialValues = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   Object.assign(model, DEFAULT_VALUES, initialValues); // Object methods
 
-  macro.obj(publicAPI, model);
+  macro.obj(publicAPI, model); // run animation at least until this time
+
+  model._animationExtendedEnd = 0;
   macro.event(publicAPI, model, 'RenderEvent');
   handledEvents.forEach(function (eventName) {
     return macro.event(publicAPI, model, eventName);

package/index.d.ts

@@ -0,0 +1,139 @@
+/// <reference path="./types.d.ts" />
+/// <reference path="./interfaces.d.ts" />
+/// <reference path="./macros.d.ts" />
+/// <reference path="./vtk.d.ts" />
+/// <reference path="./Common/Core/Base64.d.ts" />
+/// <reference path="./Common/Core/CellArray.d.ts" />
+/// <reference path="./Common/Core/DataArray.d.ts" />
+/// <reference path="./Common/Core/Endian.d.ts" />
+/// <reference path="./Common/Core/HalfFloat.d.ts" />
+/// <reference path="./Common/Core/ImageHelper.d.ts" />
+/// <reference path="./Common/Core/LookupTable.d.ts" />
+/// <reference path="./Common/Core/MatrixBuilder.d.ts" />
+/// <reference path="./Common/Core/Points.d.ts" />
+/// <reference path="./Common/Core/PriorityQueue.d.ts" />
+/// <reference path="./Common/Core/ProgressHandler.d.ts" />
+/// <reference path="./Common/Core/ScalarsToColors.d.ts" />
+/// <reference path="./Common/Core/StringArray.d.ts" />
+/// <reference path="./Common/Core/URLExtract.d.ts" />
+/// <reference path="./Common/Core/VariantArray.d.ts" />
+/// <reference path="./Common/DataModel/Box.d.ts" />
+/// <reference path="./Common/DataModel/CardinalSpline1D.d.ts" />
+/// <reference path="./Common/DataModel/Cell.d.ts" />
+/// <reference path="./Common/DataModel/Cone.d.ts" />
+/// <reference path="./Common/DataModel/Cylinder.d.ts" />
+/// <reference path="./Common/DataModel/DataSet.d.ts" />
+/// <reference path="./Common/DataModel/DataSetAttributes/FieldData.d.ts" />
+/// <reference path="./Common/DataModel/DataSetAttributes.d.ts" />
+/// <reference path="./Common/DataModel/ImageData.d.ts" />
+/// <reference path="./Common/DataModel/KochanekSpline1D.d.ts" />
+/// <reference path="./Common/DataModel/Line.d.ts" />
+/// <reference path="./Common/DataModel/PiecewiseFunction.d.ts" />
+/// <reference path="./Common/DataModel/Plane.d.ts" />
+/// <reference path="./Common/DataModel/PointSet.d.ts" />
+/// <reference path="./Common/DataModel/PolyData.d.ts" />
+/// <reference path="./Common/DataModel/Polygon.d.ts" />
+/// <reference path="./Common/DataModel/SelectionNode.d.ts" />
+/// <reference path="./Common/DataModel/Sphere.d.ts" />
+/// <reference path="./Common/DataModel/Spline1D.d.ts" />
+/// <reference path="./Common/DataModel/Spline3D.d.ts" />
+/// <reference path="./Common/DataModel/Triangle.d.ts" />
+/// <reference path="./Common/Transform/LandmarkTransform.d.ts" />
+/// <reference path="./Filters/General/AppendPolyData.d.ts" />
+/// <reference path="./Filters/General/ImageCropFilter.d.ts" />
+/// <reference path="./Filters/General/ImageOutlineFilter.d.ts" />
+/// <reference path="./Filters/General/ImageSliceFilter.d.ts" />
+/// <reference path="./Filters/General/LineFilter.d.ts" />
+/// <reference path="./Filters/General/OutlineFilter.d.ts" />
+/// <reference path="./Filters/General/TriangleFilter.d.ts" />
+/// <reference path="./Filters/General/TubeFilter.d.ts" />
+/// <reference path="./Filters/Sources/Arrow2DSource.d.ts" />
+/// <reference path="./Filters/Sources/ArrowSource.d.ts" />
+/// <reference path="./Filters/Sources/CircleSource.d.ts" />
+/// <reference path="./Filters/Sources/ConeSource.d.ts" />
+/// <reference path="./Filters/Sources/CubeSource.d.ts" />
+/// <reference path="./Filters/Sources/Cursor3D.d.ts" />
+/// <reference path="./Filters/Sources/CylinderSource.d.ts" />
+/// <reference path="./Filters/Sources/LineSource.d.ts" />
+/// <reference path="./Filters/Sources/PlaneSource.d.ts" />
+/// <reference path="./Filters/Sources/PointSource.d.ts" />
+/// <reference path="./Filters/Sources/SphereSource.d.ts" />
+/// <reference path="./Filters/Texture/TextureMapToPlane.d.ts" />
+/// <reference path="./Filters/Texture/TextureMapToSphere.d.ts" />
+/// <reference path="./Interaction/Widgets/OrientationMarkerWidget.d.ts" />
+/// <reference path="./IO/Core/HttpSceneLoader.d.ts" />
+/// <reference path="./IO/Core/ImageStream/DefaultProtocol.d.ts" />
+/// <reference path="./IO/Core/ImageStream.d.ts" />
+/// <reference path="./IO/Core/ImageStream/ViewStream.d.ts" />
+/// <reference path="./IO/Core/WSLinkClient.d.ts" />
+/// <reference path="./IO/Geometry/DracoReader.d.ts" />
+/// <reference path="./IO/Geometry/PLYReader.d.ts" />
+/// <reference path="./IO/Geometry/PLYWriter.d.ts" />
+/// <reference path="./IO/Geometry/STLReader.d.ts" />
+/// <reference path="./IO/Geometry/STLWriter.d.ts" />
+/// <reference path="./IO/Misc/ElevationReader.d.ts" />
+/// <reference path="./IO/Misc/ITKImageReader.d.ts" />
+/// <reference path="./IO/Misc/ITKPolyDataReader.d.ts" />
+/// <reference path="./IO/Misc/JSONNucleoReader.d.ts" />
+/// <reference path="./IO/Misc/JSONReader.d.ts" />
+/// <reference path="./IO/Misc/MTLReader.d.ts" />
+/// <reference path="./IO/Misc/OBJReader.d.ts" />
+/// <reference path="./IO/Misc/PDBReader.d.ts" />
+/// <reference path="./IO/XML/XMLImageDataReader.d.ts" />
+/// <reference path="./IO/XML/XMLPolyDataReader.d.ts" />
+/// <reference path="./IO/XML/XMLReader.d.ts" />
+/// <reference path="./Rendering/Core/AbstractMapper.d.ts" />
+/// <reference path="./Rendering/Core/AbstractMapper3D.d.ts" />
+/// <reference path="./Rendering/Core/AbstractPicker.d.ts" />
+/// <reference path="./Rendering/Core/Actor.d.ts" />
+/// <reference path="./Rendering/Core/Actor2D.d.ts" />
+/// <reference path="./Rendering/Core/AnnotatedCubeActor.d.ts" />
+/// <reference path="./Rendering/Core/AxesActor.d.ts" />
+/// <reference path="./Rendering/Core/Camera.d.ts" />
+/// <reference path="./Rendering/Core/CellPicker.d.ts" />
+/// <reference path="./Rendering/Core/ColorTransferFunction.d.ts" />
+/// <reference path="./Rendering/Core/Coordinate.d.ts" />
+/// <reference path="./Rendering/Core/Follower.d.ts" />
+/// <reference path="./Rendering/Core/Glyph3DMapper.d.ts" />
+/// <reference path="./Rendering/Core/ImageMapper.d.ts" />
+/// <reference path="./Rendering/Core/ImageProperty.d.ts" />
+/// <reference path="./Rendering/Core/ImageSlice.d.ts" />
+/// <reference path="./Rendering/Core/Light.d.ts" />
+/// <reference path="./Rendering/Core/Mapper.d.ts" />
+/// <reference path="./Rendering/Core/Mapper2D.d.ts" />
+/// <reference path="./Rendering/Core/Picker.d.ts" />
+/// <reference path="./Rendering/Core/PixelSpaceCallbackMapper.d.ts" />
+/// <reference path="./Rendering/Core/PointPicker.d.ts" />
+/// <reference path="./Rendering/Core/Prop.d.ts" />
+/// <reference path="./Rendering/Core/Prop3D.d.ts" />
+/// <reference path="./Rendering/Core/Property.d.ts" />
+/// <reference path="./Rendering/Core/Property2D.d.ts" />
+/// <reference path="./Rendering/Core/Renderer.d.ts" />
+/// <reference path="./Rendering/Core/RenderWindow.d.ts" />
+/// <reference path="./Rendering/Core/RenderWindowInteractor.d.ts" />
+/// <reference path="./Rendering/Core/ScalarBarActor.d.ts" />
+/// <reference path="./Rendering/Core/Skybox.d.ts" />
+/// <reference path="./Rendering/Core/SphereMapper.d.ts" />
+/// <reference path="./Rendering/Core/StickMapper.d.ts" />
+/// <reference path="./Rendering/Core/Texture.d.ts" />
+/// <reference path="./Rendering/Core/Viewport.d.ts" />
+/// <reference path="./Rendering/Core/Volume.d.ts" />
+/// <reference path="./Rendering/Core/VolumeMapper.d.ts" />
+/// <reference path="./Rendering/Core/VolumeProperty.d.ts" />
+/// <reference path="./Rendering/Misc/CanvasView.d.ts" />
+/// <reference path="./Rendering/Misc/FullScreenRenderWindow.d.ts" />
+/// <reference path="./Rendering/Misc/GenericRenderWindow.d.ts" />
+/// <reference path="./Rendering/Misc/RemoteView.d.ts" />
+/// <reference path="./Rendering/Misc/RenderWindowWithControlBar.d.ts" />
+/// <reference path="./Rendering/Misc/SynchronizableRenderWindow.d.ts" />
+/// <reference path="./Rendering/Misc/TextureLODsDownloader.d.ts" />
+/// <reference path="./Rendering/OpenGL/RenderWindow.d.ts" />
+/// <reference path="./Rendering/SceneGraph/RenderPass.d.ts" />
+/// <reference path="./Rendering/SceneGraph/ViewNode.d.ts" />
+/// <reference path="./Rendering/SceneGraph/ViewNodeFactory.d.ts" />
+/// <reference path="./Widgets/Manipulators/LineManipulator.d.ts" />
+/// <reference path="./Widgets/Manipulators/PlaneManipulator.d.ts" />
+/// <reference path="./Widgets/Manipulators/TrackballManipulator.d.ts" />
+/// <reference path="./Widgets/Representations/ResliceCursorContextRepresentation.d.ts" />
+/// <reference path="./Widgets/Representations/WidgetRepresentation.d.ts" />
+/// <reference path="./Common/Core/Math.d.ts" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitware/vtk.js",
-  "version": "22.6.0",
+  "version": "22.6.1",
   "description": "Visualization Toolkit for the Web",
   "keywords": [
     "3d",
@@ -223,5 +223,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "types": "./index.d.ts"
 }

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "include": ["Sources/**/*"],
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true
+  }
+}

package/vtk.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 
+ * @param obj 
+ * @return  
+ */
+declare function vtk(obj: object): any;
+
+/**
+ * Nest register method under the vtk function
+ * @param vtkClassName 
+ * @param constructor 
+ */
+declare function register(vtkClassName: string, constructor: any): void;
+
+export default vtk;