Class ModelViewController

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

Index

Constructors

Methods

listByItem load unload

Constructors

constructor

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

Methods

listByItem

listByItem(
itemId: string,
options?: ListByItemOptions,
): Promise<ModelViewListResponse>
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.
- Defined in packages/viewer/src/lib/model-views/controller.ts:44

load

load(sceneItemId: string, modelViewId: string): Promise<void>
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>
- Defined in packages/viewer/src/lib/model-views/controller.ts:83

unload

unload(): Promise<void>
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>
- Defined in packages/viewer/src/lib/model-views/controller.ts:96