Interface: IViewerApp

Core-API.IViewerApp

Hierarchy

• IEventDispatcher<"update" | "preRender" | "postRender" | "preFrame" | "postFrame" | "dispose" | "addPlugin" | "renderEnabled" | "renderDisabled">

• IJSONSerializable

  ↳ IViewerApp

Implemented by

• ViewerApp

Properties

state

• state: ViewerState

Defined in

webgi/src/interfaces.ts:464

---

renderer

• renderer: IRenderer

Defined in

webgi/src/interfaces.ts:465

---

scene

• scene: IScene<any, ICamera<ICameraOptions, any, any>>

Defined in

webgi/src/interfaces.ts:466

---

plugins

• Readonly plugins: Record<string, IViewerPlugin<IViewerApp, boolean>>

Defined in

webgi/src/interfaces.ts:467

---

container

• container: HTMLElement

Defined in

webgi/src/interfaces.ts:468

---

canvas

• canvas: HTMLCanvasElement

Defined in

webgi/src/interfaces.ts:469

---

useRgbm

• useRgbm: boolean

Defined in

webgi/src/interfaces.ts:471

---

useGBufferDepth

• useGBufferDepth: boolean

Defined in

webgi/src/interfaces.ts:472

---

isAntialiased

• isAntialiased: boolean

Defined in

webgi/src/interfaces.ts:473

---

console

• console: Console

Defined in

webgi/src/interfaces.ts:500

Methods

addPlugin

▸ addPlugin<T>(plugin): Promise<T>

Type parameters

Name	Type
T	extends IViewerPlugin<IViewerApp, boolean, T>

Parameters

Name	Type
plugin	T

Returns

Promise<T>

Defined in

webgi/src/interfaces.ts:475

▸ addPlugin<T>(plugin, ...args): Promise<T>

Type parameters

Name	Type
T	extends IViewerPlugin<IViewerApp, boolean, T>

Parameters

Name	Type
plugin	Class<T>
...args	any[]

Returns

Promise<T>

Defined in

webgi/src/interfaces.ts:476

---

removePlugin

▸ removePlugin(plugin): Promise<void>

Parameters

Name	Type
plugin	IViewerPlugin<IViewerApp, boolean>

Returns

Promise<void>

Defined in

webgi/src/interfaces.ts:479

---

getPlugin

▸ getPlugin<T>(type): undefined | T

Type parameters

Name	Type
T	extends IViewerPlugin<IViewerApp, boolean, T>

Parameters

Name	Type
type	Class<T>

Returns

undefined | T

Defined in

webgi/src/interfaces.ts:482

---

getPluginByType

▸ getPluginByType<T>(type): undefined | T

Type parameters

Name	Type
T	extends IViewerPlugin<IViewerApp, boolean, T>

Parameters

Name	Type
type	string

Returns

undefined | T

Defined in

webgi/src/interfaces.ts:483

---

getOrAddPlugin

▸ getOrAddPlugin<T>(type, ...args): Promise<T>

Type parameters

Name	Type
T	extends IViewerPlugin<IViewerApp, boolean, T>

Parameters

Name	Type
type	Class<T>
...args	any[]

Returns

Promise<T>

Defined in

webgi/src/interfaces.ts:484

---

setDirty

▸ setDirty(): void

Returns

void

Defined in

webgi/src/interfaces.ts:486

---

createCamera

▸ createCamera(cameraObject): ICamera<ICameraOptions, any, any>

Parameters

Name	Type
cameraObject	any

Returns

ICamera<ICameraOptions, any, any>

Defined in

webgi/src/interfaces.ts:488

---

setBackgroundColor

▸ setBackgroundColor(color): void

Parameters

Name	Type
color	any

Returns

void

Defined in

webgi/src/interfaces.ts:490

---

setBackground

▸ setBackground(asset): void

Parameters

Name	Type
asset	null | string | number | ITexture<any>

Returns

void

Defined in

webgi/src/interfaces.ts:491

---

getBackground

▸ getBackground(raw?): null | string | number | ITexture<any>

Parameters

Name	Type
raw?	boolean

Returns

null | string | number | ITexture<any>

Defined in

webgi/src/interfaces.ts:492

---

resetCamera

▸ resetCamera(options?): void

Parameters

Name	Type
options?	AnyOptions

Returns

void

Defined in

webgi/src/interfaces.ts:494

---

alert

▸ alert(message?): Promise<void>

Parameters

Name	Type
message?	string

Returns

Promise<void>

Defined in

webgi/src/interfaces.ts:496

---

confirm

▸ confirm(message?): Promise<boolean>

Parameters

Name	Type
message?	string

Returns

Promise<boolean>

Defined in

webgi/src/interfaces.ts:497

---

prompt

▸ prompt(message?, _default?, cancel?): Promise<null | string>

Parameters

Name	Type
message?	string
_default?	string
cancel?	boolean

Returns

Promise<null | string>

Defined in

webgi/src/interfaces.ts:498