SimpleScene

A basic 3D scene to add objects hierarchically, and easily dispose them when you are finished with it.

Extends

• BaseScene

Extended by

• ShadowedScene

Implements

• Configurable<SimpleSceneConfigManager, SimpleSceneConfig>

Properties

ambientLights

ambientLights: Map<string, AmbientLight>

The set of ambient lights managed by this scene component.

Inherited from

BaseScene . ambientLights

---

config

config: SimpleSceneConfigManager

Configurable.config

Implementation of

Configurable . config

---

currentWorld

currentWorld: null | World = null

The current world this item is associated with. It can be null if no world is currently active.

Inherited from

BaseScene . currentWorld

---

directionalLights

directionalLights: Map<string, DirectionalLight>

The set of directional lights managed by this scene component.

Inherited from

BaseScene . directionalLights

---

isSetup

isSetup: boolean = false

Configurable.isSetup

Implementation of

Configurable . isSetup

---

onDisposed

readonly onDisposed: Event<unknown>

Disposable.onDisposed

Inherited from

BaseScene . onDisposed

---

onSetup

readonly onSetup: Event<unknown>

Configurable.onSetup

Implementation of

Configurable . onSetup

---

onWorldChanged

readonly onWorldChanged: Event<object>

Event that is triggered when a world is added or removed from the worlds map. The event payload contains the world instance and the action ("added" or "removed").

Type declaration

action

action: "added" | "removed"

world

world: World

Inherited from

BaseScene . onWorldChanged

---

three

three: Scene

The underlying Three.js scene object. It is used to define the 3D space containing objects, lights, and cameras.

Overrides

BaseScene . three

Methods

isConfigurable()

isConfigurable(): this is Configurable<any, any>

Whether is component is Configurable.

Returns

this is Configurable<any, any>

Inherited from

BaseScene . isConfigurable

---

isDisposeable()

isDisposeable(): this is Disposable

Whether is component is Disposable.

Returns

this is Disposable

Inherited from

BaseScene . isDisposeable

---

isHideable()

isHideable(): this is Hideable

Whether is component is Hideable.

Returns

this is Hideable

Inherited from

BaseScene . isHideable

---

isResizeable()

isResizeable(): this is Resizeable

Whether is component is Resizeable.

Returns

this is Resizeable

Inherited from

BaseScene . isResizeable

---

isUpdateable()

isUpdateable(): this is Updateable

Whether is component is Updateable.

Returns

this is Updateable

Inherited from

BaseScene . isUpdateable

---

setup()

setup(config?): void

Configurable.setup

Parameters

Parameter	Type
config?	Partial <SimpleSceneConfig>

Returns

void

Implementation of

Configurable . setup