feat(Rendering): report missing view node profile imports

fixes #3343

Author: daker

Sources/Rendering/SceneGraph/ViewNodeFactory/index.js

@@ -1,5 +1,67 @@
 import macro from 'vtk.js/Sources/macros';
 
+const { vtkOnceErrorMacro } = macro;
+
+const PROFILE_BY_CLASS = {
+  vtkActor: 'Geometry',
+  vtkActor2D: 'Geometry',
+  vtkCamera: 'Geometry',
+  vtkCubeAxesActor: 'Geometry',
+  vtkMapper: 'Geometry',
+  vtkMapper2D: 'Geometry',
+  vtkPixelSpaceCallbackMapper: 'Geometry',
+  vtkRenderWindow: 'Geometry',
+  vtkRenderer: 'Geometry',
+  vtkScalarBarActor: 'Geometry',
+  vtkSkybox: 'Geometry',
+  vtkTexture: 'Geometry',
+  vtkGlyph3DMapper: 'Glyph',
+  vtkImageCPRMapper: 'Volume',
+  vtkImageMapper: 'Volume',
+  vtkImageResliceMapper: 'Volume',
+  vtkImageSlice: 'Volume',
+  vtkAbstractImageMapper: 'Volume',
+  vtkVolume: 'Volume',
+  vtkVolumeMapper: 'Volume',
+  vtkSphereMapper: 'Molecule',
+  vtkStickMapper: 'Molecule',
+  vtkSurfaceLICMapper: 'LIC',
+};
+
+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 profile = classNames.find((className) => PROFILE_BY_CLASS[className]);
+  const suggestedProfile = profile && PROFILE_BY_CLASS[profile];
+  const classList = classNames.join(' → ');
+
+  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.',
+    'If this is a custom renderable, register a matching override with the view node factory.',
+  ].join('\n');
+}
+
 // ----------------------------------------------------------------------------
 // vtkViewNodeFactory methods
 // ----------------------------------------------------------------------------
@@ -18,8 +80,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 +94,9 @@ function vtkViewNodeFactory(publicAPI, model) {
     }
 
     if (!isObject) {
+      vtkOnceErrorMacro(
+        buildMissingImplementationMessage(publicAPI.getClassName(), classNames)
+      );
       return null;
     }
     const vn = model.overrides[className]();