@kitware/vtk.js 21.3.1 → 21.5.1

package/Common/DataModel/ITKHelper.js

@@ -2,9 +2,9 @@ import macro from '../../macros.js';
 import vtkImageData from './ImageData.js';
 import vtkDataArray from '../Core/DataArray.js';
 
-var vtkErrorMacro = macro.vtkErrorMacro; // see itk.js/PixelTypes.js
+var vtkErrorMacro = macro.vtkErrorMacro; // see itk.js PixelTypes.js
 
-var ITKPixelTypes = {
+var ITKJSPixelTypes = {
   Unknown: 0,
   Scalar: 1,
   RGB: 2,
@@ -21,6 +21,25 @@ var ITKPixelTypes = {
   Matrix: 13,
   VariableLengthVector: 14,
   VariableSizeMatrix: 15
+}; // itk-wasm pixel types from https://github.com/InsightSoftwareConsortium/itk-wasm/blob/master/src/core/PixelTypes.ts
+
+var ITKWASMPixelTypes = {
+  Unknown: 'Unknown',
+  Scalar: 'Scalar',
+  RGB: 'RGB',
+  RGBA: 'RGBA',
+  Offset: 'Offset',
+  Vector: 'Vector',
+  Point: 'Point',
+  CovariantVector: 'CovariantVector',
+  SymmetricSecondRankTensor: 'SymmetricSecondRankTensor',
+  DiffusionTensor3D: 'DiffusionTensor3D',
+  Complex: 'Complex',
+  FixedArray: 'FixedArray',
+  Array: 'Array',
+  Matrix: 'Matrix',
+  VariableLengthVector: 'VariableLengthVector',
+  VariableSizeMatrix: 'VariableSizeMatrix'
 };
 /**
  * Converts an itk.js image to a vtk.js image.
@@ -35,7 +54,10 @@ function convertItkToVtkImage(itkImage) {
     spacing: [1, 1, 1]
   };
   var dimensions = [1, 1, 1];
-  var direction = [1, 0, 0, 0, 1, 0, 0, 0, 1];
+  var direction = [1, 0, 0, 0, 1, 0, 0, 0, 1]; // Check whether itkImage is an itk.js Image or an itk-wasm Image?
+
+  var isITKWasm = itkImage.direction.data === undefined;
+  var ITKPixelTypes = isITKWasm ? ITKWASMPixelTypes : ITKJSPixelTypes;
 
   for (var idx = 0; idx < itkImage.imageType.dimension; ++idx) {
     vtkImage.origin[idx] = itkImage.origin[idx];
@@ -47,7 +69,11 @@ function convertItkToVtkImage(itkImage) {
       // matrix on the vtkImageData is a webGL matrix, which uses a
       // column-major data layout. Transpose the direction matrix from
       // itkImage when instantiating that vtkImageData direction matrix.
-      direction[col + idx * 3] = itkImage.direction.data[idx + col * itkImage.imageType.dimension];
+      if (isITKWasm) {
+        direction[col + idx * 3] = itkImage.direction[idx + col * itkImage.imageType.dimension];
+      } else {
+        direction[col + idx * 3] = itkImage.direction.data[idx + col * itkImage.imageType.dimension];
+      }
     }
   } // Create VTK Image Data
 
@@ -66,7 +92,7 @@ function convertItkToVtkImage(itkImage) {
   imageData.getPointData().setScalars(pointData); // Associate the point data that are 3D vectors / tensors
   // Refer to itk-js/src/PixelTypes.js for numerical values
 
-  switch (itkImage.imageType.pixelType) {
+  switch (ITKPixelTypes[itkImage.imageType.pixelType]) {
     case ITKPixelTypes.Scalar:
       break;
 
@@ -148,7 +174,7 @@ function convertVtkToItkImage(vtkImage) {
   var itkImage = {
     imageType: {
       dimension: 3,
-      pixelType: ITKPixelTypes.Scalar,
+      pixelType: ITKJSPixelTypes.Scalar,
       componentType: '',
       components: 1
     },
@@ -176,10 +202,10 @@ function convertVtkToItkImage(vtkImage) {
   var vtkArray;
 
   if (pointData.getTensors() !== null) {
-    itkImage.imageType.pixelType = ITKPixelTypes.DiffusionTensor3D;
+    itkImage.imageType.pixelType = ITKJSPixelTypes.DiffusionTensor3D;
     vtkArray = pointData.getTensors();
   } else if (pointData.getVectors() != null) {
-    itkImage.imageType.pixelType = ITKPixelTypes.Vector;
+    itkImage.imageType.pixelType = ITKJSPixelTypes.Vector;
     vtkArray = pointData.getVectors();
   } else {
     vtkArray = pointData.getScalars();

package/Interaction/Style/InteractorStyleTrackballCamera.js

@@ -53,12 +53,12 @@ function vtkInteractorStyleTrackballCamera(publicAPI, model) {
 
 
   publicAPI.handleButton3D = function (ed) {
-    if (ed && ed.pressed && ed.device === Device.RightController && ed.input === Input.TrackPad) {
+    if (ed && ed.pressed && ed.device === Device.RightController && (ed.input === Input.Trigger || ed.input === Input.TrackPad)) {
       publicAPI.startCameraPose();
       return;
     }
 
-    if (ed && !ed.pressed && ed.device === Device.RightController && ed.input === Input.TrackPad && model.state === States.IS_CAMERA_POSE) {
+    if (ed && !ed.pressed && ed.device === Device.RightController && (ed.input === Input.Trigger || ed.input === Input.TrackPad) && model.state === States.IS_CAMERA_POSE) {
       publicAPI.endCameraPose(); // return;
     }
   };
@@ -77,11 +77,12 @@ function vtkInteractorStyleTrackballCamera(publicAPI, model) {
     var camera = ed.pokedRenderer.getActiveCamera();
     var oldTrans = camera.getPhysicalTranslation(); // look at the y axis to determine how fast / what direction to move
 
-    var speed = ed.gamepad.axes[1]; // 0.05 meters / frame movement
+    var speed = 0.5; // ed.gamepad.axes[1];
+    // 0.05 meters / frame movement
 
     var pscale = speed * 0.05 * camera.getPhysicalScale(); // convert orientation to world coordinate direction
 
-    var dir = camera.physicalOrientationToWorldDirection(ed.orientation);
+    var dir = camera.physicalOrientationToWorldDirection([ed.orientation.x, ed.orientation.y, ed.orientation.z, ed.orientation.w]);
     camera.setPhysicalTranslation(oldTrans[0] + dir[0] * pscale, oldTrans[1] + dir[1] * pscale, oldTrans[2] + dir[2] * pscale);
   }; //----------------------------------------------------------------------------
 

package/Rendering/Core/ColorTransferFunction.js

@@ -221,23 +221,32 @@ function vtkColorTransferFunction(publicAPI, model) {
 
   publicAPI.setNodes = function (nodes) {
     if (model.nodes !== nodes) {
+      var before = JSON.stringify(model.nodes);
       model.nodes = nodes;
-      publicAPI.sortAndUpdateRange();
+      var after = JSON.stringify(model.nodes);
+      return publicAPI.sortAndUpdateRange() || before !== after;
     }
+
+    return false;
   }; //----------------------------------------------------------------------------
   // Sort the vector in increasing order, then fill in
   // the Range
 
 
   publicAPI.sortAndUpdateRange = function () {
+    var before = JSON.stringify(model.nodes);
     model.nodes.sort(function (a, b) {
       return a.x - b.x;
     });
+    var after = JSON.stringify(model.nodes);
     var modifiedInvoked = publicAPI.updateRange(); // If range is updated, Modified() has been called, don't call it again.
 
-    if (!modifiedInvoked) {
+    if (!modifiedInvoked && before !== after) {
       publicAPI.modified();
+      return true;
     }
+
+    return modifiedInvoked;
   }; //----------------------------------------------------------------------------
 
 

package/Rendering/Core/RenderWindowInteractor/Constants.js

@@ -8,11 +8,23 @@ var Input = {
   Trigger: 1,
   TrackPad: 2,
   Grip: 3,
-  ApplicationMenu: 4
+  Thumbstick: 4,
+  A: 5,
+  B: 6,
+  ApplicationMenu: 7 // Not exposed in WebXR API
+
+};
+var Axis = {
+  Unknown: 0,
+  TouchpadX: 1,
+  TouchpadY: 2,
+  ThumbstickX: 3,
+  ThumbstickY: 4
 };
 var Constants = {
   Device: Device,
-  Input: Input
+  Input: Input,
+  Axis: Axis
 };
 
-export { Device, Input, Constants as default };
+export { Axis, Device, Input, Constants as default };

package/Rendering/Core/RenderWindowInteractor.js

@@ -16,7 +16,7 @@ var vtkWarningMacro = macro.vtkWarningMacro,
 // ----------------------------------------------------------------------------
 
 var deviceInputMap = {
-  'OpenVR Gamepad': [Input.TrackPad, Input.Trigger, Input.Grip, Input.ApplicationMenu]
+  'xr-standard': [Input.Trigger, Input.Grip, Input.TrackPad, Input.Thumbstick, Input.A, Input.B]
 };
 var handledEvents = ['StartAnimation', 'Animation', 'EndAnimation', 'MouseEnter', 'MouseLeave', 'StartMouseMove', 'MouseMove', 'EndMouseMove', 'LeftButtonPress', 'LeftButtonRelease', 'MiddleButtonPress', 'MiddleButtonRelease', 'RightButtonPress', 'RightButtonRelease', 'KeyPress', 'KeyDown', 'KeyUp', 'StartMouseWheel', 'MouseWheel', 'EndMouseWheel', 'StartPinch', 'Pinch', 'EndPinch', 'StartPan', 'Pan', 'EndPan', 'StartRotate', 'Rotate', 'EndRotate', 'Button3D', 'Move3D', 'StartPointerLock', 'EndPointerLock', 'StartInteraction', 'Interaction', 'EndInteraction'];
 
@@ -378,47 +378,53 @@ function vtkRenderWindowInteractor(publicAPI, model) {
     }
   };
 
-  publicAPI.updateGamepads = function (displayId) {
-    var gamepads = navigator.getGamepads(); // watch for when buttons change state and fire events
+  publicAPI.updateXRGamepads = function (xrSession, xrFrame, xrRefSpace) {
+    // watch for when buttons change state and fire events
+    xrSession.inputSources.forEach(function (inputSource) {
+      var pose = xrFrame.getPose(inputSource.gripSpace, xrRefSpace);
+      var gp = inputSource.gamepad;
+      var hand = inputSource.handedness;
 
-    for (var i = 0; i < gamepads.length; ++i) {
-      var gp = gamepads[i];
-
-      if (gp && gp.displayId === displayId) {
+      if (gp) {
         if (!(gp.index in model.lastGamepadValues)) {
           model.lastGamepadValues[gp.index] = {
-            buttons: {}
+            left: {
+              buttons: {}
+            },
+            right: {
+              buttons: {}
+            }
           };
         }
 
         for (var b = 0; b < gp.buttons.length; ++b) {
-          if (!(b in model.lastGamepadValues[gp.index].buttons)) {
-            model.lastGamepadValues[gp.index].buttons[b] = false;
+          if (!(b in model.lastGamepadValues[gp.index][hand].buttons)) {
+            model.lastGamepadValues[gp.index][hand].buttons[b] = false;
           }
 
-          if (model.lastGamepadValues[gp.index].buttons[b] !== gp.buttons[b].pressed) {
+          if (model.lastGamepadValues[gp.index][hand].buttons[b] !== gp.buttons[b].pressed) {
             publicAPI.button3DEvent({
               gamepad: gp,
-              position: gp.pose.position,
-              orientation: gp.pose.orientation,
+              position: pose.transform.position,
+              orientation: pose.transform.orientation,
               pressed: gp.buttons[b].pressed,
-              device: gp.hand === 'left' ? Device.LeftController : Device.RightController,
-              input: deviceInputMap[gp.id] && deviceInputMap[gp.id][b] ? deviceInputMap[gp.id][b] : Input.Trigger
+              device: inputSource.handedness === 'left' ? Device.LeftController : Device.RightController,
+              input: deviceInputMap[gp.mapping] && deviceInputMap[gp.mapping][b] ? deviceInputMap[gp.mapping][b] : Input.Trigger
             });
-            model.lastGamepadValues[gp.index].buttons[b] = gp.buttons[b].pressed;
+            model.lastGamepadValues[gp.index][hand].buttons[b] = gp.buttons[b].pressed;
           }
 
-          if (model.lastGamepadValues[gp.index].buttons[b]) {
+          if (model.lastGamepadValues[gp.index][hand].buttons[b]) {
             publicAPI.move3DEvent({
               gamepad: gp,
-              position: gp.pose.position,
-              orientation: gp.pose.orientation,
-              device: gp.hand === 'left' ? Device.LeftController : Device.RightController
+              position: pose.transform.position,
+              orientation: pose.transform.orientation,
+              device: inputSource.handedness === 'left' ? Device.LeftController : Device.RightController
             });
           }
         }
       }
-    }
+    });
   };
 
   publicAPI.handleMouseMove = function (event) {

package/Rendering/Misc/SynchronizableRenderWindow/vtkObjectManager.js

@@ -102,12 +102,29 @@ function bindArrays(arraysToBind) {
 
 function createNewArrayHandler(instance, arrayMetadata, arraysToBind) {
   return function (values) {
+    var regMethod = arrayMetadata.registration ? arrayMetadata.registration : 'addArray';
+    var location = arrayMetadata.location ? instance.getReferenceByName(arrayMetadata.location) : instance; // Try to prevent unncessary modified
+
+    var previousArray = null;
+
+    if (arrayMetadata.location) {
+      previousArray = instance.getReferenceByName(arrayMetadata.location).getArray(arrayMetadata.name);
+    } else {
+      previousArray = instance["get".concat(regMethod.substring(3))]();
+    }
+
+    if (previousArray) {
+      if (previousArray.getData() !== values) {
+        arraysToBind.push([previousArray.setData, [values, arrayMetadata.numberOfComponents]]);
+      }
+
+      return previousArray;
+    }
+
     var vtkClass = arrayMetadata.vtkClass ? arrayMetadata.vtkClass : 'vtkDataArray';
     var array = DATA_ARRAY_MAPPER[vtkClass].newInstance(_objectSpread(_objectSpread({}, arrayMetadata), {}, {
       values: values
     }));
-    var regMethod = arrayMetadata.registration ? arrayMetadata.registration : 'addArray';
-    var location = arrayMetadata.location ? instance.getReferenceByName(arrayMetadata.location) : instance;
     arraysToBind.push([location[regMethod], [array]]);
     return array;
   };
@@ -273,6 +290,11 @@ function genericUpdater(instance, state, context) {
     context.start(); // -> start(arraysToBind)
 
     dependencies.push(Promise.all(promises).then(function () {
+      // Since some arrays are getting updated, we should modify our dataset
+      if (arraysToBind.length) {
+        instance.modified();
+      }
+
       bindArrays(arraysToBind);
       return true;
     }).catch(function (error) {
@@ -429,8 +451,6 @@ function colorTransferFunctionUpdater(instance, state, context) {
   instance.set(_objectSpread(_objectSpread({}, state.properties), {}, {
     nodes: nodes
   }), true);
-  instance.sortAndUpdateRange();
-  instance.modified();
   context.end(); // -> end(colorTransferFunctionUpdater)
 }
 
@@ -454,12 +474,30 @@ function piecewiseFunctionUpdater(instance, state, context) {
   instance.set(_objectSpread(_objectSpread({}, state.properties), {}, {
     nodes: nodes
   }), true);
-  instance.sortAndUpdateRange();
-  instance.modified();
+  instance.sortAndUpdateRange(); // instance.modified();
+
   context.end(); // -> end(piecewiseFunctionUpdater)
 } // ----------------------------------------------------------------------------
 
 
+function removeUnavailableArrays(fields, availableNames) {
+  var namesToDelete = [];
+  var size = fields.getNumberOfArrays();
+
+  for (var i = 0; i < size; i++) {
+    var array = fields.getArray(i);
+    var name = array.getName();
+
+    if (!availableNames.has(name)) {
+      namesToDelete.push(name);
+    }
+  }
+
+  for (var _i = 0; _i < namesToDelete.length; _i++) {
+    fields.removeArray(namesToDelete[_i]);
+  }
+}
+
 function createDataSetUpdate() {
   var piecesToFetch = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
   return function (instance, state, context) {
@@ -489,8 +527,18 @@ function createDataSetUpdate() {
 
     delete state.properties.fields; // Reset any pre-existing fields array
 
-    instance.getPointData().removeAllArrays();
-    instance.getCellData().removeAllArrays(); // Generic handling
+    var arrayToKeep = {
+      pointData: new Set(),
+      cellData: new Set(),
+      fieldData: new Set()
+    };
+    fieldsArrays.forEach(function (_ref5) {
+      var location = _ref5.location,
+          name = _ref5.name;
+      arrayToKeep[location].add(name);
+    });
+    removeUnavailableArrays(instance.getPointData(), arrayToKeep.pointData);
+    removeUnavailableArrays(instance.getCellData(), arrayToKeep.cellData); // Generic handling
 
     var res = genericUpdater(instance, state, context); // Finish what we started
 

package/Rendering/OpenGL/RenderWindow.js

@@ -245,21 +245,28 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
   // typically in response to a user request such as a button press
 
 
-  publicAPI.startXR = function () {
+  publicAPI.startXR = function (isAR) {
     if (navigator.xr === undefined) {
       throw new Error('WebXR is not available');
     }
 
-    if (!navigator.xr.isSessionSupported('immersive-vr')) {
-      throw new Error('VR display is not available');
+    model.xrSessionIsAR = isAR;
+    var sessionType = isAR ? 'immersive-ar' : 'immersive-vr';
+
+    if (!navigator.xr.isSessionSupported(sessionType)) {
+      if (isAR) {
+        throw new Error('Device does not support AR session');
+      } else {
+        throw new Error('VR display is not available');
+      }
     }
 
     if (model.xrSession === null) {
-      navigator.xr.requestSession('immersive-vr').then(publicAPI.enterXR, function () {
-        throw new Error('Failed to create VR session!');
+      navigator.xr.requestSession(sessionType).then(publicAPI.enterXR, function () {
+        throw new Error('Failed to create XR session!');
       });
     } else {
-      throw new Error('VR Session already exists!');
+      throw new Error('XR Session already exists!');
     }
   }; // When an XR session is available, set up the XRWebGLLayer
   // and request the first animation frame for the device
@@ -348,7 +355,10 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
             model.xrSession = null;
 
           case 10:
-            publicAPI.setSize.apply(publicAPI, _toConsumableArray(model.oldCanvasSize)); // Reset to default canvas
+            if (model.oldCanvasSize !== undefined) {
+              publicAPI.setSize.apply(publicAPI, _toConsumableArray(model.oldCanvasSize));
+            } // Reset to default canvas
+
 
             ren = model.renderable.getRenderers()[0];
             ren.getActiveCamera().setProjectionMatrix(null);
@@ -372,11 +382,18 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
           switch (_context3.prev = _context3.next) {
             case 0:
               xrSession = frame.session;
+              model.renderable.getInteractor().updateXRGamepads(xrSession, frame, model.xrReferenceSpace);
               model.xrSceneFrame = model.xrSession.requestAnimationFrame(publicAPI.xrRender);
               xrPose = frame.getViewerPose(model.xrReferenceSpace);
 
               if (xrPose) {
                 gl = publicAPI.get3DContext();
+
+                if (model.xrSessionIsAR && model.oldCanvasSize !== undefined) {
+                  gl.canvas.width = model.oldCanvasSize[0];
+                  gl.canvas.height = model.oldCanvasSize[1];
+                }
+
                 glLayer = xrSession.renderState.baseLayer;
                 gl.bindFramebuffer(gl.FRAMEBUFFER, glLayer.framebuffer);
                 gl.clear(gl.COLOR_BUFFER_BIT);
@@ -386,15 +403,18 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
 
                 xrPose.views.forEach(function (view) {
                   var viewport = glLayer.getViewport(view);
-                  gl.viewport(viewport.x, viewport.y, viewport.width, viewport.height);
-
-                  if (view.eye === 'left') {
-                    ren.setViewport(0, 0, 0.5, 1.0);
-                  } else if (view.eye === 'right') {
-                    ren.setViewport(0.5, 0, 1.0, 1.0);
-                  } else {
-                    // No handling for non-eye viewport
-                    return;
+                  gl.viewport(viewport.x, viewport.y, viewport.width, viewport.height); // TODO: Appropriate handling for AR passthrough on HMDs
+                  // with two eyes will require further investigation.
+
+                  if (!model.xrSessionIsAR) {
+                    if (view.eye === 'left') {
+                      ren.setViewport(0, 0, 0.5, 1.0);
+                    } else if (view.eye === 'right') {
+                      ren.setViewport(0.5, 0, 1.0, 1.0);
+                    } else {
+                      // No handling for non-eye viewport
+                      return;
+                    }
                   }
 
                   ren.getActiveCamera().computeViewParametersFromPhysicalMatrix(view.transform.inverse.matrix);
@@ -403,7 +423,7 @@ function vtkOpenGLRenderWindow(publicAPI, model) {
                 });
               }
 
-            case 4:
+            case 5:
             case "end":
               return _context3.stop();
           }
@@ -776,7 +796,9 @@ var DEFAULT_VALUES = {
   // attempt webgl2 on by default
   activeFramebuffer: null,
   xrSession: null,
+  xrSessionIsAR: false,
   xrReferenceSpace: null,
+  xrSupported: true,
   imageFormat: 'image/png',
   useOffScreen: false,
   useBackgroundImage: false
@@ -819,7 +841,7 @@ function extend(publicAPI, model) {
   macro.event(publicAPI, model, 'imageReady');
   macro.event(publicAPI, model, 'haveVRDisplay'); // Build VTK API
 
-  macro.get(publicAPI, model, ['shaderCache', 'textureUnitManager', 'webgl2', 'vrDisplay', 'useBackgroundImage']);
+  macro.get(publicAPI, model, ['shaderCache', 'textureUnitManager', 'webgl2', 'vrDisplay', 'useBackgroundImage', 'xrSupported']);
   macro.setGet(publicAPI, model, ['initialized', 'context', 'canvas', 'renderPasses', 'notifyStartCaptureImage', 'defaultToWebgl2', 'cursor', 'useOffScreen', // might want to make this not call modified as
   // we change the active framebuffer a lot. Or maybe
   // only mark modified if the size or depth

package/Rendering/WebGPU/RenderWindow.js

@@ -616,7 +616,8 @@ var DEFAULT_VALUES = {
   imageFormat: 'image/png',
   useOffScreen: false,
   useBackgroundImage: false,
-  nextPropID: 1
+  nextPropID: 1,
+  xrSupported: false
 }; // ----------------------------------------------------------------------------
 
 function extend(publicAPI, model) {
@@ -652,7 +653,7 @@ function extend(publicAPI, model) {
   macro.event(publicAPI, model, 'imageReady');
   macro.event(publicAPI, model, 'initialized'); // Build VTK API
 
-  macro.get(publicAPI, model, ['commandEncoder', 'device', 'useBackgroundImage']);
+  macro.get(publicAPI, model, ['commandEncoder', 'device', 'useBackgroundImage', 'xrSupported']);
   macro.setGet(publicAPI, model, ['initialized', 'context', 'canvas', 'device', 'renderPasses', 'notifyStartCaptureImage', 'cursor', 'useOffScreen']);
   macro.setGetArray(publicAPI, model, ['size'], 2); // Object methods
 

package/macros.js

@@ -304,8 +304,8 @@ function obj() {
           vtkWarningMacro("Warning: Set value to model directly ".concat(name, ", ").concat(map[name]));
         }
 
+        ret = model[name] !== map[name] || ret;
         model[name] = map[name];
-        ret = true;
       }
     });
     return ret;

package/package.json

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

package/types.d.ts

@@ -19,6 +19,11 @@ declare type Size = [number, number];
 declare type Range = [number, number];
 declare type Vector2 = [number, number];
 declare type Vector3 = [number, number, number];
+declare type Vector4 = [number, number, number, number];
+
+declare type Matrix = number[][];
+declare type Matrix2x2 = [Vector2, Vector2];
+declare type Matrix3x3 = [Vector3, Vector3, Vector3];
 /**
  * @deprecated The `Point` type is depracted, please use `Vector3` instead.
  */