SceneModel Inspector

Runs inspections on a SceneModel and returns a structured InspectionReport.

applyFixes applies registered fixes for supported issue codes. The module also exports registries, async variants, and optimizeSceneModel.

Shape

classDiagram
    direction TB
    class inspectSceneModel {
      +(params) InspectionReport
    }
    class applyFixes {
      +(params) SDKResult~ApplyFixesResult~
    }
    class InspectionReport {
      +issues   : Issue[]
      +errors / warnings / info : Issue[]
      +byCode   : Map~code, Issue[]~
    }
    class Issue {
      +code      : string
      +severity  : error | warning | info
      +message   : string
      +resourceId? / context?
    }
    class ApplyFixesResult {
      +fixed    : Issue[]
      +skipped  : Issue[]
      +errors   : Issue[]
    }
    class Inspection {
      +codes    : string[]
      +run(sceneModel, push)
    }
    class Fix {
      +codes    : string[]
      +apply(issue, sceneModel)
    }
    class InspectionRegistry {
      +register(inspection)
    }
    class FixRegistry {
      +register(fix)
      +unregister(code)
    }
    inspectSceneModel ..> InspectionRegistry : walks
    inspectSceneModel ..> InspectionReport : produces
    InspectionRegistry "1" *-- "*" Inspection
    InspectionReport "1" *-- "*" Issue
    applyFixes ..> InspectionReport : consumes
    applyFixes ..> FixRegistry : dispatches
    applyFixes ..> ApplyFixesResult : returns
    FixRegistry "1" *-- "*" Fix

Pipeline

flowchart LR
    A[SceneModel] --> B[inspectSceneModel]
    B --> C[InspectionReport]
    C --> D[applyFixes]
    D --> E[ApplyFixesResult]
    E -- re-inspect --> B

Installation

npm install @xeokit/sdk
Copy

Core Types

• Issue: one finding with severity, code, message, optional resource id, and optional context.
• InspectionReport: issue list plus severity and code groupings.
• Inspection: {codes[], description, run}. Walks a SceneModel and returns issues.
• Fix: {codes[], description, apply}. Handles one or more issue codes.

Registries

Inspections and fixes are stored in separate registries:

• InspectionRegistry: inspections run by inspectSceneModel. DEFAULT_INSPECTION_REGISTRY contains the built-in inspections.
• FixRegistry: issue-code dispatch table used by applyFixes. DEFAULT_FIX_REGISTRY contains the built-in fixes. Registering a fix for an existing code replaces the previous mapping.

Tests and one-off pipelines can create fresh registries and pass them through the matching registry field on the params object.

// Register a fix in the default registry.
import * as sceneModelInspector from "@xeokit/sdk/inspect/sceneModel";

sceneModelInspector.DEFAULT_FIX_REGISTRY.register({
  codes: ["MyApp/STALE_PROPERTY_SET"],
  description: "Prune deprecated property sets",
  apply(issue, sceneModel) {
    return {ok: true, value: {fixed: true}};
  },
});
Copy

// Build a one-off registry.
import {
  FixRegistry,
  mergeDuplicateGeometries,
  applyFixes,
} from "@xeokit/sdk/inspect/sceneModel";

const registry = new FixRegistry([
  mergeDuplicateGeometries,
  myFix,
]);
applyFixes({sceneModel, report, registry});
Copy

Use unregister(code) to remove a fix mapping.

Built-in inspections

Built-in inspections are registered in DEFAULT_INSPECTION_REGISTRY.

Built-in fixes

Built-in fixes are registered in DEFAULT_FIX_REGISTRY.

Codes without a built-in fix include MESH_DANGLING_*, MESH_NONFINITE_MATRIX, malformed GEOMETRY_* issues, and TRANSFORM_CYCLE.

Typical pipeline: load -> inspect -> applyFixes -> re-inspect -> render.

Example

import * as sceneModelInspector from "@xeokit/sdk/inspect/sceneModel";

const report = sceneModelInspector.inspectSceneModel({
  sceneModel,
  checkDuplicateGeometries: true,   // opt-in: byte-identical detection
  checkSimilarGeometries:   true,   // opt-in: pose-invariant shape match
});

if (report.errors.length > 0) {
  for (const e of report.errors) {
    console.error(`[${e.code}] ${e.message}`);
  }
  return;
}

const fixResult = sceneModelInspector.applyFixes({sceneModel, report});
if (!fixResult.ok) throw new Error(fixResult.error);

const {fixed, skipped, errors} = fixResult.value;
console.log(
  `fixed ${fixed.length}, skipped ${skipped.length}, ` +
  `errors ${errors.length}`,
);

// Re-inspect after applying fixes.
const after = sceneModelInspector.inspectSceneModel({sceneModel});
Copy

optimizeSceneModel runs inspection first, stops on errors, splits oversized geometries, and prunes orphan resources. Use inspectSceneModel and applyFixes directly when you need per-rule control.