feat(mapper): allow control over coordinate precision shifting and scaling

Introduces the `(set|get)CoordinateShiftScaleEnabled` property to
`vtkMapper` and its subclasses. This new property provides an API to
explicitly enable/disable the automatic coordinate shifting and scaling
mechanism within polydata mappers, which is typically used to improve
rendering precision for geometry with large coordinate values.

fix #3330

Author: sankhesh

Sources/Rendering/Core/Mapper/index.d.ts

@@ -35,6 +35,7 @@ export interface IMapperInitialValues extends IAbstractMapper3DInitialValues {
   interpolateScalarsBeforeMapping?: boolean;
   forceCompileOnly?: number;
   useInvertibleColors?: boolean;
+  coordShiftScaleEnabled?: boolean;
   customShaderAttributes?: any;
 }
 
@@ -467,6 +468,17 @@ export interface vtkMapper
   setInterpolateScalarsBeforeMapping(
     interpolateScalarsBeforeMapping: boolean
   ): boolean;
+
+  /**
+   * Control whether the mapper should automatically shift and scale
+   * the coordinates to improve precision. This is enabled by default.
+   *
+   * @param {Boolean} coordShiftScaleEnabled
+   * @default true
+   */
+  setCoordShiftScaleEnabled(
+    coordShiftScaleEnabled: boolean
+  ): boolean;
 }
 
 /**

Sources/Rendering/Core/Mapper/index.js

@@ -794,6 +794,8 @@ const DEFAULT_VALUES = {
   invertibleScalars: null,
 
   customShaderAttributes: [],
+
+  coordShiftScaleEnabled: true,
 };
 
 // ----------------------------------------------------------------------------
@@ -825,6 +827,7 @@ export function extend(publicAPI, model, initialValues = {}) {
     'scalarVisibility',
     'static',
     'useLookupTableScalarRange',
+    'coordShiftScaleEnabled',
     'customShaderAttributes', // point data array names that will be transferred to the VBO
   ]);
   macro.setGetArray(publicAPI, model, ['scalarRange'], 2);

Sources/Rendering/OpenGL/Glyph3DMapper/index.js

@@ -694,8 +694,14 @@ function vtkOpenGLGlyph3DMapper(publicAPI, model) {
     const garray = model.renderable.getMatrixArray();
 
     const pts = model.renderable.getInputData(0).getPoints();
-    const { useShiftAndScale, coordShift, coordScale } =
-      computeCoordShiftAndScale(pts);
+    let useShiftAndScale = false;
+    let coordShift = 0.0;
+    let coordScale = 1.0;
+
+    if (model.coordShiftAndScaleEnabled && pts) {
+      ({ useShiftAndScale, coordShift, coordScale } =
+        computeCoordShiftAndScale(pts));
+    }
 
     if (model.hardwareSupport) {
       // update the buffer objects if needed

Sources/Rendering/OpenGL/PolyDataMapper/index.js

@@ -1258,7 +1258,9 @@ function vtkOpenGLPolyDataMapper(publicAPI, model) {
       const numClipPlanes = model.renderable.getNumberOfClippingPlanes();
       const planeEquations = [];
 
-      const shiftScaleEnabled = cellBO.getCABO().getCoordShiftAndScaleEnabled();
+      const shiftScaleEnabled =
+        model.renderable.coordShiftScaleEnabled &&
+        cellBO.getCABO().getCoordShiftAndScaleEnabled();
       const inverseShiftScaleMatrix = shiftScaleEnabled
         ? cellBO.getCABO().getInverseShiftAndScaleMatrix()
         : null;
@@ -1460,7 +1462,9 @@ function vtkOpenGLPolyDataMapper(publicAPI, model) {
     const camm = model.openGLCamera.getKeyMatrixTime().getMTime();
     const progm = program.getLastCameraMTime();
 
-    const shiftScaleEnabled = cellBO.getCABO().getCoordShiftAndScaleEnabled();
+    const shiftScaleEnabled =
+      model.renderable.coordShiftScaleEnabled &&
+      cellBO.getCABO().getCoordShiftAndScaleEnabled();
     const inverseShiftScaleMatrix = shiftScaleEnabled
       ? cellBO.getCABO().getInverseShiftAndScaleMatrix()
       : null;
@@ -2018,7 +2022,7 @@ export function extend(publicAPI, model, initialValues = {}) {
   }
 
   // Build VTK API
-  macro.setGet(publicAPI, model, ['context']);
+  macro.setGet(publicAPI, model, ['context', 'coordShiftScaleEnabled']);
 
   model.VBOBuildTime = {};
   macro.obj(model.VBOBuildTime, { mtime: 0 });