Class DemoHelper

constructor

• new DemoHelper(cfg?: DemoHelperConfig): DemoHelper

  Creates a DemoHelper instance.

  Parameters

  • cfg: DemoHelperConfig = {}

  Returns DemoHelper

data

maxViews

modelsDir

renderer

scene

stats

viewer

views

aabb3Index

• get aabb3Index(): SceneAABB3Index

  Gets the SceneAABB3Index for the Scene, which dynamically tracks the 3D boundaries of the objects in the Scene.

  Returns SceneAABB3Index

createView

• createView(viewParams?: ViewParams): View

  Creates a new View in the Viewer.

  When viewParams.elementId and viewParams.htmlElement are omitted, this method auto-creates a canvas element, passes it to viewer.createView, and lays it out snugly with other auto-created canvases inside the window.

  Auto-created canvases are given z-index: 100000.

  The first View created becomes the DemoHelper's primary view, and gets a CameraFlightAnimation and ViewController.

  Parameters

  • viewParams: ViewParams = {}

    Parameters for the View.

  Returns View

  The created View.

destroyView

• destroyView(view: View): void

  Destroys a View created by createView(), removing its canvas if it was auto-created.

  Parameters

  • view: View

  Returns void

finished

• finished(): void

  Finalizes the demo setup, gathering statistics and signaling completion.

  Returns void

init

• init(cfg?: DemoHelperConfig): Promise<any>

  Initializes the DemoHelper by creating the Scene, Data, Viewer, WebGLRenderer, and optional initial View.

  Parameters

  • cfg: DemoHelperConfig = {}

    Configuration options for initialization.

  Returns Promise<any>

  A promise that resolves when initialization is complete.

loadModel

• loadModel(
      params: {
          dataModel?: DataModel;
          format: string;
          modelId?: string;
          sceneModel?: SceneModel;
          src?: string;
      },
      options: any,
  ): Promise<SDKResult<any>>

  Loads a model into the Scene and/or Data layers using a format-specific loader.

  This method:

  • Resolves or creates SceneModel and DataModel instances when not provided
  • Fetches model data from params.src or a default path derived from modelId
  • Selects the appropriate loader based on params.format
  • Delegates parsing and population to the corresponding loader implementation

  Supported formats:

  • "xgf" → XGFLoader (binary)
  • "ifc" → IFCLoader (binary)
  • "gltf" → GLTFLoader (binary, .glb)
  • "metamodel" → MetaModelLoader (JSON, data-only)
  • "datamodel" → DataModelParamsLoader (JSON, data-only)
  • "scenemodel" → SceneModelParamsLoader (JSON, scene-only)

  Default source resolution: If params.src is not provided, the source path is inferred as: ../../models/{modelId}/{format}/model.{ext}

  Model creation behavior:

  • If sceneModel is not provided, a new one is created via this.scene.createModel()
  • If dataModel is not provided, a new one is created via this.data.createModel()
  • Created model IDs are derived from modelId when available

  Parameters

  • params: {
        dataModel?: DataModel;
        format: string;
        modelId?: string;
        sceneModel?: SceneModel;
        src?: string;
    }

    Configuration for loading the model

    • OptionaldataModel?: DataModel

      Optional existing DataModel to populate

    • format: string

      Model format determining which loader to use

    • OptionalmodelId?: string

      Optional identifier used for default paths and generated model IDs

    • OptionalsceneModel?: SceneModel

      Optional existing SceneModel to populate

    • Optionalsrc?: string

      Optional explicit source URL/path for the model file
  • options: any

    Loader-specific options passed through to the underlying loader

  Returns Promise<SDKResult<any>>

  A promise resolving to an SDKResult containing the loader result

  Throws

  Error

  • If model creation fails
  • If the format is unsupported
  • If fetching or parsing the model data fails

toggleInspector

• toggleInspector(): void

  Toggles the visibility of the floating inspector panels.

  Returns void