feat(Rendering): report missing view node profile imports

fixes #3343

Author: daker

Sources/Rendering/OpenGL/Profiles/profileHintManifest.js

@@ -0,0 +1,36 @@
+import { registerProfileHints } from 'vtk.js/Sources/Rendering/SceneGraph/ViewNodeFactory/profileHints';
+
+registerProfileHints(
+  [
+    'vtkActor',
+    'vtkActor2D',
+    'vtkCamera',
+    'vtkCubeAxesActor',
+    'vtkMapper',
+    'vtkMapper2D',
+    'vtkPixelSpaceCallbackMapper',
+    'vtkRenderWindow',
+    'vtkRenderer',
+    'vtkScalarBarActor',
+    'vtkSkybox',
+    'vtkTexture',
+  ],
+  'Geometry'
+);
+
+registerProfileHints(
+  [
+    'vtkAbstractImageMapper',
+    'vtkImageCPRMapper',
+    'vtkImageMapper',
+    'vtkImageResliceMapper',
+    'vtkImageSlice',
+    'vtkVolume',
+    'vtkVolumeMapper',
+  ],
+  'Volume'
+);
+
+registerProfileHints(['vtkGlyph3DMapper'], 'Glyph');
+registerProfileHints(['vtkSphereMapper', 'vtkStickMapper'], 'Molecule');
+registerProfileHints(['vtkSurfaceLICMapper'], 'LIC');

Sources/Rendering/SceneGraph/ViewNodeFactory/index.js

@@ -1,4 +1,46 @@
 import macro from 'vtk.js/Sources/macros';
+import { getProfileForClass, getSuggestedProfile } from './profileHints';
+import 'vtk.js/Sources/Rendering/OpenGL/Profiles/profileHintManifest';
+import 'vtk.js/Sources/Rendering/WebGPU/Profiles/profileHintManifest';
+
+const { vtkOnceErrorMacro } = macro;
+
+function listClassHierarchy(dataObject) {
+  const classNames = [];
+  let depth = 0;
+  let className = dataObject.getClassName(depth++);
+  while (className) {
+    classNames.push(className);
+    className = dataObject.getClassName(depth++);
+  }
+  return classNames;
+}
+
+function buildMissingImplementationMessage(factoryName, classNames) {
+  const classList = classNames.join(' → ');
+  const suggestedClass = getSuggestedProfile(classNames);
+  const suggestedProfile =
+    suggestedClass && getProfileForClass(suggestedClass);
+
+  if (suggestedProfile) {
+    return [
+      `No ${factoryName} implementation found for ${classNames[0]}.`,
+      `Class hierarchy: ${classList}.`,
+      'This usually means the rendering profile import is missing.',
+      `Try importing '@kitware/vtk.js/Rendering/Profiles/${suggestedProfile}' or 'vtk.js/Sources/Rendering/Profiles/${suggestedProfile}'.`,
+      "You can also use the full profile imports '@kitware/vtk.js/Rendering/Profiles/All' or 'vtk.js/Sources/Rendering/Profiles/All'.",
+    ].join('\n');
+  }
+
+  return [
+    `No ${factoryName} implementation found for ${classNames[0]}.`,
+    `Class hierarchy: ${classList}.`,
+    'If this is a built-in renderable, a rendering profile import may be missing.',
+    "Try importing '@kitware/vtk.js/Rendering/Profiles/All' or 'vtk.js/Sources/Rendering/Profiles/All',",
+    'or import the specific rendering profile needed by this renderable.',
+    'If this is a custom renderable, register a matching override with the view node factory.',
+  ].join('\n');
+}
 
 // ----------------------------------------------------------------------------
 // vtkViewNodeFactory methods
@@ -18,8 +60,9 @@ function vtkViewNodeFactory(publicAPI, model) {
       return null;
     }
 
+    const classNames = listClassHierarchy(dataObject);
     let cpt = 0;
-    let className = dataObject.getClassName(cpt++);
+    let className = classNames[cpt++];
     let isObject = false;
     const keys = Object.keys(model.overrides);
     while (className && !isObject) {
@@ -31,6 +74,9 @@ function vtkViewNodeFactory(publicAPI, model) {
     }
 
     if (!isObject) {
+      vtkOnceErrorMacro(
+        buildMissingImplementationMessage(publicAPI.getClassName(), classNames)
+      );
       return null;
     }
     const vn = model.overrides[className]();

Sources/Rendering/SceneGraph/ViewNodeFactory/profileHints.js

@@ -0,0 +1,26 @@
+const PROFILE_HINTS = Object.create(null);
+
+export function registerProfileHint(className, profile) {
+  PROFILE_HINTS[className] = profile;
+}
+
+export function registerProfileHints(classNames, profile) {
+  classNames.forEach((className) => {
+    registerProfileHint(className, profile);
+  });
+}
+
+export function getSuggestedProfile(classNames) {
+  return classNames.find((className) => PROFILE_HINTS[className]);
+}
+
+export function getProfileForClass(className) {
+  return PROFILE_HINTS[className];
+}
+
+export default {
+  registerProfileHint,
+  registerProfileHints,
+  getSuggestedProfile,
+  getProfileForClass,
+};

Sources/Rendering/WebGPU/Profiles/profileHintManifest.js

@@ -0,0 +1,23 @@
+import { registerProfileHints } from 'vtk.js/Sources/Rendering/SceneGraph/ViewNodeFactory/profileHints';
+
+registerProfileHints(
+  [
+    'vtkActor',
+    'vtkActor2D',
+    'vtkCamera',
+    'vtkCubeAxesActor',
+    'vtkMapper',
+    'vtkMapper2D',
+    'vtkPixelSpaceCallbackMapper',
+    'vtkRenderWindow',
+    'vtkRenderer',
+    'vtkScalarBarActor',
+    'vtkTexture',
+  ],
+  'Geometry'
+);
+
+registerProfileHints(['vtkImageMapper', 'vtkImageSlice', 'vtkVolume'], 'Volume');
+registerProfileHints(['vtkGlyph3DMapper'], 'Glyph');
+registerProfileHints(['vtkSphereMapper', 'vtkStickMapper'], 'Molecule');
+registerProfileHints(['vtkSurfaceLICMapper'], 'LIC');