Interface: IScene<TScene, TCamera, TE>

Core-API.IScene

Type parameters

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

Hierarchy

• IModel<TScene, TE>

• IUiConfigContainer

• IShaderPropertiesUpdater

  ↳ IScene

Implemented by

• RootScene

Properties

name

• name: string

Overrides

IModel.name

---

uuid

• Readonly uuid: string

Overrides

IModel.uuid

---

visible

• Readonly visible: boolean

Overrides

IModel.visible

---

assetType

• assetType: "model"

Overrides

IModel.assetType

---

modelObject

• modelObject: TScene

Internal three.js Object3D instance (like Mesh, Group, etc)

Overrides

IModel.modelObject

---

activeCamera

• activeCamera: TCamera

---

renderCamera

• renderCamera: ICamera<ICameraOptions, any, any>

---

modelRoot

• modelRoot: IModel<any, IObject3DEventMap>

---

envMapIntensity

• envMapIntensity: number

---

defaultCamera

• defaultCamera: TCamera

---

userData

• userData: any

Overrides

IModel.userData

---

material

• Optional Readonly material: IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Use setMaterial to change the material Get one or more materials applied to an object

Inherited from

IModel.material

---

geometry

• Optional Readonly geometry: any

Inherited from

IModel.geometry

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IUiConfigContainer.uiConfig

Methods

addModel

▸ addModel(model, options?): void

Parameters

Name	Type
model	IModel<any, IObject3DEventMap>
options?	AddModelOptions

Returns

void

---

addLight

▸ addLight(light, options?): void

Parameters

Name	Type
light	ILight<any>
options?	AnyOptions

Returns

void

---

addSceneObject

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

Type parameters

Name	Type
T	extends ISceneObject<any>

Parameters

Name	Type
imported	T
options?	AnyOptions

Returns

T

---

setDirty

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

Parameters

Name	Type
options?	AnyOptions

Returns

IScene<TScene, TCamera, TE>

Overrides

IModel.setDirty

---

getBounds

▸ getBounds(precise?, ignoreInvisible?): Box3B

Parameters

Name	Type
precise?	boolean
ignoreInvisible?	boolean

Returns

Box3B

---

findObjectsByName

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

Parameters

Name	Type
name	string
parent?	any

Returns

any[]

---

setEnvironment

▸ setEnvironment(asset): void

Parameters

Name	Type
asset	undefined | null | ITexture<any>

Returns

void

---

getEnvironment

▸ getEnvironment(): ITexture<any>

Returns

ITexture<any>

---

setBackground

▸ setBackground(asset): void

Parameters

Name	Type
asset	any

Returns

void

---

getBackground

▸ getBackground(): any

Returns

any

---

addWidget

▸ addWidget(widget, options?): void

Parameters

Name	Type
widget	IWidget<any, IObject3DEventMap>
options?	AnyOptions

Returns

void

---

updateShaderProperties

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

Parameters

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

Returns

IScene<TScene, TCamera, TE>

Inherited from

IShaderPropertiesUpdater.updateShaderProperties

---

setMaterial

▸ Optional setMaterial(material): IMaterial<any, IMaterialEventMap>[]

Parameters

Name	Type
material	undefined | IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Returns

IMaterial<any, IMaterialEventMap>[]

Inherited from

IModel.setMaterial

---

setGeometry

▸ Optional setGeometry(geometry, force?): any

returns the old geometry.

Parameters

Name	Type
geometry	any
force?	boolean

Returns

any

Inherited from

IModel.setGeometry