• Preparing search index...
  • The search index is not available
@xeokit/sdk - v0.1.0
  • @xeokit/sdk
  • inspect
  • sceneModel
  • inspectSceneModelAsync

Function inspectSceneModelAsync

  • inspectSceneModelAsync(
        params: InspectSceneModelParams,
    ): Promise<inspect.sceneModel.InspectionReport>

    Async sibling of inspectSceneModel. Same orchestration — walk every registered Inspection and concatenate issues — but yields to the main thread between each inspection so the UI can repaint, and honours InspectSceneModelParams.signal

    • InspectSceneModelParams.onProgress for cancel and progress UX.

    Returns the same InspectionReport shape as the synchronous version. On cancel, throws an AbortError (a DOMException with name === "AbortError"); issues collected before the abort are discarded.

    Yield granularity is per inspection — within one inspection's run the main thread is still blocked. Most built-in inspections finish in < 100 ms even on large models; the heavy ones (duplicateGeometries, similarGeometries, geometryQuality) can take longer, but progress fires before each begins so the user at least knows what step is in flight.

    Parameters

    • params: InspectSceneModelParams

    Returns Promise<inspect.sceneModel.InspectionReport>

    • Defined in packages/sdk/src/inspect/sceneModel/async/inspectSceneModelAsync.ts:29

Settings

Member Visibility
@xeokit/sdk - v0.1.0
  • Loading...

Generated using TypeDoc