Class ModelViewController

The controller for managing the model views of a scene view.

Hierarchy

ModelViewController

Index

Constructors

constructor

Methods

Constructors

constructor

new ModelViewController(client: SceneViewAPIClient, stream: StreamApi, jwtProvider: JwtProvider, deviceIdProvider: (() => undefined | string)): ModelViewController

- Defined in packages/viewer/src/lib/model-views/controller.ts:29
Parameters
- client: SceneViewAPIClient
- stream: StreamApi
- jwtProvider: JwtProvider
- deviceIdProvider: (() => undefined | string)
  - - (): undefined | string
    - Returns undefined | string
Returns ModelViewController

Methods

listByItem

listByItem(itemId: string, options?: ListByItemOptions): Promise<ModelViewListResponse>

- Defined in packages/viewer/src/lib/model-views/controller.ts:44
Fetches a page of model views for a given item. The result includes a cursor that can be used to fetch the next page of results.

Parameters
- itemId: string
  
  The ID of the scene item to retrieve model views for.
- options: ListByItemOptions = {}
  
  Options to configure fetching of items.
Returns Promise<ModelViewListResponse>
A page of model views.

load

load(sceneItemId: string, modelViewId: string): Promise<void>

- Defined in packages/viewer/src/lib/model-views/controller.ts:86
Loads the provided model view within the current scene view.

Parameters
- sceneItemId: string
  
  The ID of the scene item this model view is being loaded for.
- modelViewId: string
  
  The ID of the model view to load.
Returns Promise<void>

unload

unload(): Promise<void>

- Defined in packages/viewer/src/lib/model-views/controller.ts:99
Unloads any previously loaded model view within the current scene view, then performs a reset on the scene to return to the initial state for the scene view.

Returns Promise<void>