feat(mappers): set opacity/color/label tex widths

Author: floryst

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

@@ -122,6 +122,54 @@ export interface vtkAbstractImageMapper extends vtkAbstractMapper3D {
    * @param customDisplayExtent
    */
   setCustomDisplayExtentFrom(customDisplayExtent: number[]): boolean;
+
+  /**
+   * Set the opacity texture width.
+   *
+   * The default width (1024) should be fine in most instances.
+   * Only set this property if your opacity function range width is
+   * larger than 1024.
+   *
+   * @param {Number} width the texture width (defaults to 1024)
+   */
+  setOpacityTextureWidth(width: number): boolean;
+
+  /**
+   * Get the opacity texture width.
+   */
+  getOpacityTextureWidth(): number;
+
+  /**
+   * Set the color texture width.
+   *
+   * The default width (1024) should be fine in most instances.
+   * Only set this property if your color transfer function range width is
+   * larger than 1024.
+   *
+   * @param {Number} width the texture width (defaults to 1024)
+   */
+  setColorTextureWidth(width: number): boolean;
+
+  /**
+   * Get the color texture width.
+   */
+  getColorTextureWidth(): number;
+
+  /**
+   * Set the label outline texture width.
+   *
+   * The default width (1024) should be fine in most instances.
+   * Only set this property if you have more than 1024 labels
+   * that you want to render with thickness.
+   *
+   * @param {Number} width the texture width (defaults to 1024)
+   */
+  setLabelOutlineTextureWidth(width: number): boolean;
+
+  /**
+   * Get the label outline texture width.
+   */
+  getLabelOutlineTextureWidth(): number;
 }
 
 /**

Sources/Rendering/Core/AbstractImageMapper/index.js

@@ -30,6 +30,9 @@ const DEFAULT_VALUES = {
   customDisplayExtent: [0, 0, 0, 0, 0, 0],
   useCustomExtents: false,
   backgroundColor: [0, 0, 0, 1],
+  colorTextureWidth: 1024,
+  opacityTextureWidth: 1024,
+  labelOutlineTextureWidth: 1024,
 };
 
 // ----------------------------------------------------------------------------
@@ -40,7 +43,13 @@ export function extend(publicAPI, model, initialValues = {}) {
   // Build VTK API
   vtkAbstractMapper3D.extend(publicAPI, model, initialValues);
 
-  macro.setGet(publicAPI, model, ['slice', 'useCustomExtents']);
+  macro.setGet(publicAPI, model, [
+    'slice',
+    'useCustomExtents',
+    'colorTextureWidth',
+    'opacityTextureWidth',
+    'labelOutlineTextureWidth',
+  ]);
   macro.setGetArray(publicAPI, model, ['customDisplayExtent'], 6);
   macro.setGetArray(publicAPI, model, ['backgroundColor'], 4);
 

Sources/Rendering/Core/CellPicker/index.js

@@ -277,7 +277,7 @@ function vtkCellPicker(publicAPI, model) {
 
     // calculate opacity table
     const numIComps = 1;
-    const oWidth = 1024;
+    const oWidth = mapper.getOpacityTextureWidth();
     const tmpTable = new Float32Array(oWidth);
     const opacityArray = new Float32Array(oWidth);
     let ofun;

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

@@ -318,6 +318,54 @@ export interface vtkVolumeMapper extends vtkAbstractMapper3D {
    *
    */
   update(): void;
+
+  /**
+   * Set the opacity texture width.
+   *
+   * The default width (1024) should be fine in most instances.
+   * Only set this property if your opacity function range width is
+   * larger than 1024.
+   *
+   * @param {Number} width the texture width (defaults to 1024)
+   */
+  setOpacityTextureWidth(width: number): boolean;
+
+  /**
+   * Get the opacity texture width.
+   */
+  getOpacityTextureWidth(): number;
+
+  /**
+   * Set the color texture width.
+   *
+   * The default width (1024) should be fine in most instances.
+   * Only set this property if your color transfer function range width is
+   * larger than 1024.
+   *
+   * @param {Number} width the texture width (defaults to 1024)
+   */
+  setColorTextureWidth(width: number): boolean;
+
+  /**
+   * Get the color texture width.
+   */
+  getColorTextureWidth(): number;
+
+  /**
+   * Set the label outline texture width.
+   *
+   * The default width (1024) should be fine in most instances.
+   * Only set this property if you have more than 1024 labels
+   * that you want to render with thickness.
+   *
+   * @param {Number} width the texture width (defaults to 1024)
+   */
+  setLabelOutlineTextureWidth(width: number): boolean;
+
+  /**
+   * Get the label outline texture width.
+   */
+  getLabelOutlineTextureWidth(): number;
 }
 
 /**

Sources/Rendering/Core/VolumeMapper/index.js

@@ -164,6 +164,9 @@ const defaultValues = (initialValues) => ({
   LAOKernelSize: 15,
   LAOKernelRadius: 7,
   updatedExtents: [],
+  colorTextureWidth: 1024,
+  opacityTextureWidth: 1024,
+  labelOutlineTextureWidth: 1024,
   ...initialValues,
 });
 
@@ -193,6 +196,9 @@ export function extend(publicAPI, model, initialValues = {}) {
     'LAOKernelSize',
     'LAOKernelRadius',
     'updatedExtents',
+    'colorTextureWidth',
+    'opacityTextureWidth',
+    'labelOutlineTextureWidth',
   ]);
 
   macro.setGetArray(publicAPI, model, ['ipScalarRange'], 2);

Sources/Rendering/OpenGL/ImageCPRMapper/index.js

@@ -275,7 +275,7 @@ function vtkOpenGLImageCPRMapper(publicAPI, model) {
       !cachedColorEntry?.oglObject?.getHandle() ||
       cachedColorEntry?.hash !== colorTextureHash;
     if (reBuildColorTexture) {
-      const cWidth = 1024;
+      const cWidth = model.renderable.getColorTextureWidth();
       const cSize = cWidth * textureHeight * 3;
       const cTable = new Uint8ClampedArray(cSize);
       model.colorTexture = vtkOpenGLTexture.newInstance();
@@ -355,7 +355,7 @@ function vtkOpenGLImageCPRMapper(publicAPI, model) {
       !cachedPwfEntry?.oglObject?.getHandle() ||
       cachedPwfEntry?.hash !== pwfTextureHash;
     if (reBuildPwf) {
-      const pwfWidth = 1024;
+      const pwfWidth = model.renderable.getOpacityTextureWidth();
       const pwfSize = pwfWidth * textureHeight;
       const pwfTable = new Uint8ClampedArray(pwfSize);
       model.pwfTexture = vtkOpenGLTexture.newInstance();

Sources/Rendering/OpenGL/ImageMapper/index.js

@@ -969,7 +969,7 @@ function vtkOpenGLImageMapper(publicAPI, model) {
         resizable: true,
       });
       model.colorTexture.setOpenGLRenderWindow(model._openGLRenderWindow);
-      const cWidth = 1024;
+      const cWidth = model.renderable.getColorTextureWidth();
       const cSize = cWidth * textureHeight * 3;
       const cTable = new Uint8ClampedArray(cSize);
       // set interpolation on the texture based on property setting
@@ -1055,7 +1055,7 @@ function vtkOpenGLImageMapper(publicAPI, model) {
     const reBuildPwf =
       !pwfTex?.oglObject?.getHandle() || pwfTex?.hash !== pwfunToString;
     if (reBuildPwf) {
-      const pwfWidth = 1024;
+      const pwfWidth = model.renderable.getOpacityTextureWidth();
       const pwfSize = pwfWidth * textureHeight;
       const pwfTable = new Uint8ClampedArray(pwfSize);
       model.pwfTexture = vtkOpenGLTexture.newInstance({
@@ -1397,7 +1397,7 @@ function vtkOpenGLImageMapper(publicAPI, model) {
     const reBuildL = !lTex?.oglObject?.getHandle() || lTex?.hash !== toString;
 
     if (reBuildL) {
-      const lWidth = 1024;
+      const lWidth = model.renderable.getLabelOutlineTextureWidth();
       const lHeight = 1;
       const lSize = lWidth * lHeight;
       const lTable = new Uint8Array(lSize);

Sources/Rendering/OpenGL/ImageResliceMapper/index.js

@@ -302,7 +302,7 @@ function vtkOpenGLImageResliceMapper(publicAPI, model) {
       model._openGLRenderWindow.getGraphicsResourceForObject(colorTransferFunc);
     const reBuildC = !cTex?.oglObject?.getHandle() || cTex?.hash !== toString;
     if (reBuildC) {
-      const cWidth = 1024;
+      const cWidth = model.renderable.getColorTextureWidth();
       const cSize = cWidth * textureHeight * 3;
       const cTable = new Uint8ClampedArray(cSize);
       model.colorTexture = vtkOpenGLTexture.newInstance();
@@ -382,7 +382,7 @@ function vtkOpenGLImageResliceMapper(publicAPI, model) {
     const reBuildPwf =
       !pwfTex?.oglObject?.getHandle() || pwfTex?.hash !== toString;
     if (reBuildPwf) {
-      const pwfWidth = 1024;
+      const pwfWidth = model.renderable.getOpacityTextureWidth();
       const pwfSize = pwfWidth * textureHeight;
       const pwfTable = new Uint8ClampedArray(pwfSize);
       model.pwfTexture = vtkOpenGLTexture.newInstance();

Sources/Rendering/OpenGL/VolumeMapper/index.js

@@ -1570,7 +1570,7 @@ function vtkOpenGLVolumeMapper(publicAPI, model) {
       model.opacityTexture = vtkOpenGLTexture.newInstance();
       model.opacityTexture.setOpenGLRenderWindow(model._openGLRenderWindow);
       // rebuild opacity tfun?
-      const oWidth = 1024;
+      const oWidth = model.renderable.getOpacityTextureWidth();
       const oSize = oWidth * 2 * numIComps;
       const ofTable = new Float32Array(oSize);
       const tmpTable = new Float32Array(oWidth);
@@ -1659,7 +1659,7 @@ function vtkOpenGLVolumeMapper(publicAPI, model) {
     if (reBuildC) {
       model.colorTexture = vtkOpenGLTexture.newInstance();
       model.colorTexture.setOpenGLRenderWindow(model._openGLRenderWindow);
-      const cWidth = 1024;
+      const cWidth = model.renderable.getColorTextureWidth();
       const cSize = cWidth * 2 * numIComps * 3;
       const cTable = new Uint8ClampedArray(cSize);
       const tmpTable = new Float32Array(cWidth * 3);
@@ -1856,7 +1856,7 @@ function vtkOpenGLVolumeMapper(publicAPI, model) {
       model.labelOutlineThicknessTexture.setOpenGLRenderWindow(
         model._openGLRenderWindow
       );
-      const lWidth = 1024;
+      const lWidth = model.renderable.getLabelOutlineTextureWidth();
       const lHeight = 1;
       const lSize = lWidth * lHeight;
       const lTable = new Uint8Array(lSize);