Class Viewer

constructor

• new Viewer(params?: { id?: string; logging?: boolean; scene?: Scene }): Viewer

  Creates a Viewer.

  Parameters

  • Optionalparams: { id?: string; logging?: boolean; scene?: Scene }

    Viewer configuration.

    • Optionalid?: string

      ID for this Viewer, automatically generated by default.

    • Optionallogging?: boolean

      Enables or disables error logging to the console for this Viewer. Default value is false.

    • Optionalscene?: Scene

      Contains model representations. The same Scene can be attached to any number of Viewers.

  Returns Viewer

destroyed

Readonlyevents

id

logging

numViews

scene

Readonly InternalviewList

Readonlyviews

attachScene

• attachScene(scene: Scene): SDKResult<Viewer>

  Attaches a Scene to this Viewer.

  • Creates ViewObjects in each existing View for all SceneObjects in the attached Scene.
  • Subscribes to Scene.events.onSceneObjectCreated | Scene.events.onSceneObjectCreated and Scene.events.onSceneObjectDestroyed | Scene.events.onSceneObjectDestroyed events to create and destroy ViewObjects in each existing View as SceneObjects are created and destroyed in the attached Scene.

  Parameters

  • scene: Scene

    The Scene to attach.

  Returns SDKResult<Viewer>

clear

• clear(): SDKResult<void>

  Clears this Viewer.

  Destroys all existing Views and resets all properties to their default values.

  Returns SDKResult<void>

createView

• createView(viewParams: ViewParams): SDKResult<View>

  Creates a new View within this Viewer.

  • To destroy the View after use, call View.destroy.

  Usage

  const viewResult = myViewer.createView({
       id: "myView",
       elementId: "myView1"
  });
  
  if (!viewResult.ok) {
       console.error(viewResult.error);
  } else {
       const view = viewResult.value;
       view.camera.eye = [-3.933, 2.855, 27.018];
       view.camera.look = [4.400, 3.724, 8.899];
       view.camera.up = [-0.018, 0.999, 0.039];
  
       //...
  }
  Copy

  Parameters

  • viewParams: ViewParams

    View configuration.

  Returns SDKResult<View>

  A result containing the created View on success, or an error message on failure.

destroy

• destroy(): void

  Destroys this Viewer.

  Returns void

detachScene

• detachScene(): SDKResult<Viewer>

  Detaches the currently attached Scene from this Viewer.

  • Destroys all ViewObjects in each existing View that were created for SceneObjects in the detached Scene.
  • Unsubscribes from Scene.events.onSceneObjectCreated | Scene.events.onSceneObjectCreated and Scene.events.onSceneObjectDestroyed | Scene.events.onSceneObjectDestroyed events of the detached Scene.

  Returns SDKResult<Viewer>

fromParams

• fromParams(viewerParams: ViewerParams): SDKResult<void>

  Configures this Viewer.

  Parameters

  • viewerParams: ViewerParams

  Returns SDKResult<void>

toParams

• toParams(): SDKResult<any>

  Gets the current configuration of this Viewer.

  Returns SDKResult<any>