Class: SimpleBackgroundEnvUiPlugin

UI-Plugins.SimpleBackgroundEnvUiPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ SimpleBackgroundEnvUiPlugin

Properties

PluginType

▪ Static Readonly PluginType: "SimpleBackgroundEnvUiPlugin1"

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:8

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:9

---

toJSON

• toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:11

---

lastBgVal

• lastBgVal: any = null

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:93

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:107

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Constructors

constructor

• new SimpleBackgroundEnvUiPlugin()

Inherited from

AViewerPlugin.constructor

Defined in

webgi/node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:41

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

---

viewer

• get viewer(): undefined | TViewer

Returns

undefined | TViewer

Inherited from

AViewerPlugin.viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

---

sceneBackgroundColor

• get sceneBackgroundColor(): number

Returns

number

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:26

• set sceneBackgroundColor(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:31

---

sceneBackground

• get sceneBackground(): any

Returns

any

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:38

• set sceneBackground(v): void

Parameters

Name	Type
v	any

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:42

---

sceneEnvironment

• get sceneEnvironment(): null | Texture

Returns

null | Texture

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:46

• set sceneEnvironment(v): void

Parameters

Name	Type
v	null | Texture

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:50

---

sceneEnvironmentRotation

• get sceneEnvironmentRotation(): number

Returns

number

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:53

• set sceneEnvironmentRotation(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:56

---

sceneEnvironmentIntensity

• get sceneEnvironmentIntensity(): number

Returns

number

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:63

• set sceneEnvironmentIntensity(v): void

Parameters

Name	Type
v	number

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:66

---

sceneEnvironmentFixedDirection

• get sceneEnvironmentFixedDirection(): boolean

Returns

boolean

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:70

• set sceneEnvironmentFixedDirection(v): void

Parameters

Name	Type
v	boolean

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:73

---

envmapBg

• get envmapBg(): boolean

Returns

boolean

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:78

• set envmapBg(v): void

Parameters

Name	Type
v	boolean

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:81

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:44

---

fromJSON

▸ fromJSON(data, meta?): null | SimpleBackgroundEnvUiPlugin | Promise<null | SimpleBackgroundEnvUiPlugin>

Parameters

Name	Type
data	any
meta?	any

Returns

null | SimpleBackgroundEnvUiPlugin | Promise<null | SimpleBackgroundEnvUiPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:56

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:68

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:71

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:78

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:95

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:64