fix(ImJoyAPI): Tweak setVolumeScatteringBlend naming

- Consistent `Image` prefix for image-related parameters - Shorter, more consistent `Volume` over `Volumetric`
Kitware · Oct 5, 2022 · c691805 · c691805
1 parent 90220ad
commit c691805
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/src/ImJoyPluginAPI.js b/src/ImJoyPluginAPI.js
@@ -354,12 +354,12 @@ class ImJoyPluginAPI {
     return this.viewer.getCroppingPlanes()
   }
 
-  setVolumetricScatteringBlend(scatteringBlend, name) {
-    this.viewer.setVolumetricScatteringBlend(scatteringBlend, name)
+  setImageVolumeScatteringBlend(scatteringBlend, name) {
+    this.viewer.setImageVolumeScatteringBlend(scatteringBlend, name)
   }
 
-  getVolumetricScatteringBlend(name) {
-    return this.viewer.getVolumetricScatteringBlend(name)
+  getImageVolumeScatteringBlend(name) {
+    return this.viewer.getImageVolumeScatteringBlend(name)
   }
 }
 

diff --git a/src/createViewer.js b/src/createViewer.js
@@ -1175,7 +1175,7 @@ const createViewer = async (
     return store.itkVtkView
   }
 
-  publicAPI.setVolumetricScatteringBlend = (scatteringBlend, name) => {
+  publicAPI.setImageVolumeScatteringBlend = (scatteringBlend, name) => {
     if (typeof name === 'undefined') {
       name = context.images.selectedName
     }
@@ -1189,7 +1189,7 @@ const createViewer = async (
     })
   }
 
-  publicAPI.getVolumetricScatteringBlend = name => {
+  publicAPI.getImageVolumeScatteringBlend = name => {
     if (typeof name === 'undefined') {
       name = context.images.selectedName
     }

diff --git a/test/createViewerTest.js b/test/createViewerTest.js
@@ -117,11 +117,11 @@ test('Test createViewer', async t => {
   viewer.setBackgroundColor(TEST_VIEWER_STYLE.backgroundColor)
 
   const VALUE = 0.3
-  viewer.setVolumetricScatteringBlend(VALUE)
+  viewer.setImageVolumeScatteringBlend(VALUE)
   t.equal(
-    viewer.getVolumetricScatteringBlend(),
+    viewer.getImageVolumeScatteringBlend(),
     VALUE,
-    'getVolumetricScatteringBlend matches setVolumetricScatteringBlend'
+    'getImageVolumeScatteringBlend matches setImageVolumeScatteringBlend'
   )
 
   viewer.setUICollapsed(false)