Scene | Vertex Viewer SDK

A class that represents the Scene that has been loaded into the viewer. On it, you can retrieve attributes of the scene, such as the camera. It also contains methods for updating the scene and performing requests to rerender the scene.

Hierarchy

Scene

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Scene(stream: StreamApi, frame: ReceivedFrame, decodeFrame: FrameDecoder, imageScaleProvider: ImageScaleProvider, dimensions: Dimensions, sceneId: string, sceneViewId: string): Scene

- Defined in packages/viewer/src/lib/scenes/scene.ts:613
Parameters
- stream: StreamApi
- frame: ReceivedFrame
- decodeFrame: FrameDecoder
- imageScaleProvider: ImageScaleProvider
- dimensions: Dimensions
- sceneId: string
- sceneViewId: string
Returns Scene

Properties

Readonly sceneId

sceneId: string

Readonly sceneViewId

sceneViewId: string

Methods

applyPartialSceneViewState

applyPartialSceneViewState(sceneViewStateId: string | SceneViewStateIdentifier, featuresToApply: SceneViewStateFeature[], opts?: ApplySceneViewStateOptions): Promise<undefined | ILoadSceneViewStateResult>

- Defined in packages/viewer/src/lib/scenes/scene.ts:648
Applies the specified features of the provided scene view state to the scene.

Parameters
- sceneViewStateId: string | SceneViewStateIdentifier
- featuresToApply: SceneViewStateFeature[]
- opts: ApplySceneViewStateOptions = {}
Returns Promise<undefined | ILoadSceneViewStateResult>

applySceneViewState

applySceneViewState(sceneViewStateId: string | SceneViewStateIdentifier, opts?: ApplySceneViewStateOptions): Promise<undefined | ILoadSceneViewStateResult>

- Defined in packages/viewer/src/lib/scenes/scene.ts:633
Applies the provided scene view state to the scene.

Parameters
- sceneViewStateId: string | SceneViewStateIdentifier
- opts: ApplySceneViewStateOptions = {}
Returns Promise<undefined | ILoadSceneViewStateResult>

boundingBox

boundingBox(): BoundingBox

- Defined in packages/viewer/src/lib/scenes/scene.ts:784
Returns the current visible BoundingBox for the scene.

Returns BoundingBox

camera

camera(): Camera

- Defined in packages/viewer/src/lib/scenes/scene.ts:738
An instance of the current camera of the scene. The camera provides a number of methods that can be used in combination with the render method to make programmatic updates to the scene's camera.
example
```
const viewer = document.querySelector('vertex-viewer');
const scene = await viewer.scene();
const camera = scene.camera();

// Fit the camera to the visible bounding box of the scene with a 1 second animation
await camera.viewAll().render({ animation: { milliseconds: 1000 } });
```
see
Camera for more information on available camera operations.
Returns Camera

crossSectioning

crossSectioning(): CrossSectioner

- Defined in packages/viewer/src/lib/scenes/scene.ts:791
CrossSectioner to update cross sectioning planes and get current configuration.

Returns CrossSectioner

isOrthographic

isOrthographic(): boolean

- Defined in packages/viewer/src/lib/scenes/scene.ts:775
Returns boolean

items

items(operations: ((q: SceneItemQueryExecutor) => TerminalItemOperationBuilder)): ItemsOperationExecutor

- Defined in packages/viewer/src/lib/scenes/scene.ts:701
Returns an executor that accepts a function as a parameter that contains one or many operations to apply to the scene view. The operations will be applied transactionally.
example
```
const viewer = document.querySelector('vertex-viewer');
const scene = await viewer.scene();

// Deselect everything, then select a specific item by ID
await scene.items(op => [
  op.where(q => q.all()).deselect(),
  op.where(q => q.withItemId('item-id')).select(),
]).execute();
```
see
RootQuery for more information on available queries.

see
SceneItemOperationsBuilder for more information on available operations.
Parameters
- operations: ((q: SceneItemQueryExecutor) => TerminalItemOperationBuilder)
  - - (q: SceneItemQueryExecutor): TerminalItemOperationBuilder
    - Parameters
      - q: SceneItemQueryExecutor
      Returns TerminalItemOperationBuilder
Returns ItemsOperationExecutor

raycaster

raycaster(): Raycaster

- Defined in packages/viewer/src/lib/scenes/scene.ts:798
Raycaster to request items that intersect a point.

Returns Raycaster

reset

reset(opts?: ResetViewOptions): Promise<undefined | IResetViewResult>

- Defined in packages/viewer/src/lib/scenes/scene.ts:665
Resets the view to its default state, with the ability to reset the camera to that of the base scene.

Parameters
- opts: ResetViewOptions = {}
Returns Promise<undefined | IResetViewResult>

scale

scale(): Point

- Defined in packages/viewer/src/lib/scenes/scene.ts:812
The current x and y scale of the rendered image.

Returns Point

viewport

viewport(): Dimensions

- Defined in packages/viewer/src/lib/scenes/scene.ts:805
The current viewport of the scene, in pixels.

Returns Dimensions

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stream: StreamApi

frame: ReceivedFrame

decodeFrame: FrameDecoder

imageScaleProvider: ImageScaleProvider

dimensions: Dimensions

sceneId: string

sceneViewId: string

Returns Scene

Properties

Readonly sceneId

Readonly sceneViewId

Methods

applyPartialSceneViewState

Parameters

sceneViewStateId: string | SceneViewStateIdentifier

featuresToApply: SceneViewStateFeature[]

opts: ApplySceneViewStateOptions = {}

Returns Promise<undefined | ILoadSceneViewStateResult>

applySceneViewState

Parameters

sceneViewStateId: string | SceneViewStateIdentifier

opts: ApplySceneViewStateOptions = {}

Returns Promise<undefined | ILoadSceneViewStateResult>

boundingBox

Returns BoundingBox

camera

Returns Camera

crossSectioning

Returns CrossSectioner

isOrthographic

Returns boolean

items

Parameters

operations: ((q: SceneItemQueryExecutor) => TerminalItemOperationBuilder)

Parameters

q: SceneItemQueryExecutor

Returns TerminalItemOperationBuilder

Returns ItemsOperationExecutor

raycaster

Returns Raycaster

reset

Parameters

opts: ResetViewOptions = {}

Returns Promise<undefined | IResetViewResult>

scale

Returns Point

viewport

Returns Dimensions