Interface: IScene<TScene, TCamera>

Core-API.IScene

Type parameters

Name	Type
TScene	any
TCamera	extends ICamera<ICameraOptions> = ICamera<ICameraOptions>

Hierarchy

• IEventDispatcher<TSceneEvents>

• IDisposable

• IUiConfigContainer

• IShaderPropertiesUpdater

  ↳ IScene

Implemented by

• RootScene

Properties

name

• name: string

Defined in

webgi/src/interfaces.ts:70

---

uuid

• Readonly uuid: string

Defined in

webgi/src/interfaces.ts:71

---

visible

• Readonly visible: boolean

Defined in

webgi/src/interfaces.ts:72

---

assetType

• assetType: "model"

Defined in

webgi/src/interfaces.ts:73

---

modelObject

• modelObject: TScene

Defined in

webgi/src/interfaces.ts:74

---

activeCamera

• activeCamera: TCamera

Defined in

webgi/src/interfaces.ts:75

---

renderCamera

• renderCamera: ICamera<ICameraOptions, any, any>

Defined in

webgi/src/interfaces.ts:76

---

modelRoot

• modelRoot: IModel<any>

Defined in

webgi/src/interfaces.ts:77

---

envMapIntensity

• envMapIntensity: number

Defined in

webgi/src/interfaces.ts:101

---

defaultCamera

• defaultCamera: TCamera

Defined in

webgi/src/interfaces.ts:105

---

userData

• userData: any

Defined in

webgi/src/interfaces.ts:106

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IUiConfigContainer.uiConfig

Defined in

webgi/src/interfaces.ts:586

Methods

addModel

▸ addModel(model, options?): void

Parameters

Name	Type
model	IModel<any>
options?	AddModelOptions

Returns

void

Defined in

webgi/src/interfaces.ts:82

---

addLight

▸ addLight(light, options?): void

Parameters

Name	Type
light	ILight<any>
options?	AnyOptions

Returns

void

Defined in

webgi/src/interfaces.ts:84

---

addSceneObject

▸ addSceneObject<T>(imported, options?): T

Type parameters

Name	Type
T	extends ISceneObject<any>

Parameters

Name	Type
imported	T
options?	AnyOptions

Returns

T

Defined in

webgi/src/interfaces.ts:86

---

setDirty

▸ setDirty(options?): IScene<TScene, TCamera>

Parameters

Name	Type
options?	AnyOptions

Returns

IScene<TScene, TCamera>

Defined in

webgi/src/interfaces.ts:88

---

getBounds

▸ getBounds(precise?, ignoreInvisible?): Box3B

Parameters

Name	Type
precise?	boolean
ignoreInvisible?	boolean

Returns

Box3B

Defined in

webgi/src/interfaces.ts:91

---

findObjectsByName

▸ findObjectsByName(name, parent?): any[]

Parameters

Name	Type
name	string
parent?	any

Returns

any[]

Defined in

webgi/src/interfaces.ts:93

---

setEnvironment

▸ setEnvironment(asset): void

Parameters

Name	Type
asset	undefined | null | ITexture<any>

Returns

void

Defined in

webgi/src/interfaces.ts:95

---

getEnvironment

▸ getEnvironment(): ITexture<any>

Returns

ITexture<any>

Defined in

webgi/src/interfaces.ts:96

---

setBackground

▸ setBackground(asset): void

Parameters

Name	Type
asset	any

Returns

void

Defined in

webgi/src/interfaces.ts:98

---

getBackground

▸ getBackground(): any

Returns

any

Defined in

webgi/src/interfaces.ts:99

---

addWidget

▸ addWidget(widget, options?): void

Parameters

Name	Type
widget	IWidget<any>
options?	AnyOptions

Returns

void

Defined in

webgi/src/interfaces.ts:103

---

updateShaderProperties

▸ updateShaderProperties(material): IScene<TScene, TCamera>

Parameters

Name	Type
material	Object
material.defines	Record<string, undefined | string | number>
material.uniforms	Object

Returns

IScene<TScene, TCamera>

Inherited from

IShaderPropertiesUpdater.updateShaderProperties

Defined in

webgi/src/interfaces.ts:122