Class Web3DViewer

Hierarchy

HTMLElement
- Web3DViewer

Index

Constructors

Accessors

activeTool camera plugins renderingEnabled selection settings tools xr

Methods

addPlugin applyQualityPreset dispose getModel getModels isCubeBackground load screenshot unload waitForRender

Constructors

constructor

new Web3DViewer(settings?): Web3DViewer
Parameters
- Optional settings: Settings
Returns Web3DViewer
Overrides HTMLElement.constructor
- Defined in packages/web3d/src/Web3DViewer.ts:42

Accessors

activeTool

get activeTool(): string
Returns string
- Defined in packages/web3d/src/Web3DViewer.ts:305
set activeTool(tool): void
Parameters
- tool: string
Returns void
- Defined in packages/web3d/src/Web3DViewer.ts:301

camera

get camera(): PublicCamera
Returns PublicCamera
- Defined in packages/web3d/src/Web3DViewer.ts:325

plugins

get plugins(): ApiContainer<Web3DPlugin>
Returns ApiContainer<Web3DPlugin>
- Defined in packages/web3d/src/Web3DViewer.ts:313

renderingEnabled

get renderingEnabled(): boolean
Returns boolean
- Defined in packages/web3d/src/Web3DViewer.ts:151
set renderingEnabled(enabled): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/web3d/src/Web3DViewer.ts:147

selection

get selection(): Selection
Returns Selection
- Defined in packages/web3d/src/Web3DViewer.ts:321

settings

get settings(): Settings
Returns Settings
- Defined in packages/web3d/src/Web3DViewer.ts:90

tools

get tools(): ApiContainer<Tool>
Returns ApiContainer<Tool>
- Defined in packages/web3d/src/Web3DViewer.ts:309

xr

get xr(): XRManager
Returns XRManager
- Defined in packages/web3d/src/Web3DViewer.ts:329

Methods

addPlugin

addPlugin(p): Web3DViewer
Parameters
- p: Web3DPlugin
Returns Web3DViewer
- Defined in packages/web3d/src/Web3DViewer.ts:155

applyQualityPreset

applyQualityPreset(quality): void
Parameters
- quality: QualityPreset
Returns void
- Defined in packages/web3d/src/Web3DViewer.ts:94

dispose

dispose(): void
Returns void
- Defined in packages/web3d/src/Web3DViewer.ts:338

getModel

getModel<T>(modelId, type?): T
Type Parameters
- T extends Model
Parameters
- modelId: string
- Optional type: (new (...params) => T)
  - - new (...params): T
    - Parameters
      Rest ...params: any
      Returns T
Returns T
- Defined in packages/web3d/src/Web3DViewer.ts:197

getModels

getModels<TT>(type?): TT[]
Type Parameters
- TT extends Model
Parameters
- Optional type: (new (...params) => TT)
  - - new (...params): TT
    - Parameters
      Rest ...params: any
      Returns TT
Returns TT[]
- Defined in packages/web3d/src/Web3DViewer.ts:202

isCubeBackground

isCubeBackground(): boolean
Returns boolean
- Defined in packages/web3d/src/Web3DViewer.ts:143

load

load(ref, options?): Promise<Model>
Parameters
- ref: any
- options: LoadOptions = {}
Returns Promise<Model>
- Defined in packages/web3d/src/Web3DViewer.ts:166

screenshot

screenshot(size?, type?, quality?): Promise<Blob>
Parameters
- Optional size: Vector2
- Optional type: ImageMimeType
- Optional quality: number
Returns Promise<Blob>
- Defined in packages/web3d/src/Web3DViewer.ts:317

unload

unload(modelId, options?): Promise<void>
Parameters
- modelId: string
- Optional options: LoadOptions
Returns Promise<void>
- Defined in packages/web3d/src/Web3DViewer.ts:186

waitForRender

waitForRender(): Promise<void>
Returns Promise<void>
- Defined in packages/web3d/src/Web3DViewer.ts:333