Skip to main content

Class: SimpleBackgroundEnvUiPlugin

UI-Plugins.SimpleBackgroundEnvUiPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "SimpleBackgroundEnvUiPlugin1"

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:9


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:10


toJSON

toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:12


lastBgVal

lastBgVal: any = null

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:94


uiConfig

uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:108


_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

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20


sceneBackgroundColor

get sceneBackgroundColor(): number

Returns

number

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:27

set sceneBackgroundColor(v): void

Parameters

NameType
vnumber

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:32


sceneBackground

get sceneBackground(): any

Returns

any

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:39

set sceneBackground(v): void

Parameters

NameType
vany

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:43


sceneEnvironment

get sceneEnvironment(): null | Texture

Returns

null | Texture

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:47

set sceneEnvironment(v): void

Parameters

NameType
vnull | Texture

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:51


sceneEnvironmentRotation

get sceneEnvironmentRotation(): number

Returns

number

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:54

set sceneEnvironmentRotation(v): void

Parameters

NameType
vnumber

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:57


sceneEnvironmentIntensity

get sceneEnvironmentIntensity(): number

Returns

number

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:64

set sceneEnvironmentIntensity(v): void

Parameters

NameType
vnumber

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:67


sceneEnvironmentFixedDirection

get sceneEnvironmentFixedDirection(): boolean

Returns

boolean

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:71

set sceneEnvironmentFixedDirection(v): void

Parameters

NameType
vboolean

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:74


envmapBg

get envmapBg(): boolean

Returns

boolean

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:79

set envmapBg(v): void

Parameters

NameType
vboolean

Returns

void

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:82

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | SimpleBackgroundEnvUiPlugin | Promise<null | SimpleBackgroundEnvUiPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

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

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

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

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:96


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60