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
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:9
toJSON
• toJSON: any
= undefined
Overrides
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:11
bgUIConfig
• bgUIConfig: UiObjectConfig
<any
, string
>
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:13
lastBgVal
• lastBgVal: any
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:76
uiConfig
• uiConfig: UiObjectConfig
<any
, string
>
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:85
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:25
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:29
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:18
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:22
sceneBackground
• get
sceneBackground(): any
Returns
any
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:27
• set
sceneBackground(v
): void
Parameters
Name | Type |
---|---|
v | any |
Returns
void
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:31
sceneEnvironment
• get
sceneEnvironment(): undefined
| ITexture
<Texture
>
Returns
undefined
| ITexture
<Texture
>
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:37
• set
sceneEnvironment(v
): void
Parameters
Name | Type |
---|---|
v | undefined | ITexture <Texture > |
Returns
void
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:40
sceneEnvironmentRotation
• get
sceneEnvironmentRotation(): number
Returns
number
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:43
• set
sceneEnvironmentRotation(v
): void
Parameters
Name | Type |
---|---|
v | number |
Returns
void
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:46
sceneEnvironmentIntensity
• get
sceneEnvironmentIntensity(): number
Returns
number
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:53
• set
sceneEnvironmentIntensity(v
): void
Parameters
Name | Type |
---|---|
v | number |
Returns
void
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:56
envmapBg
• get
envmapBg(): boolean
Returns
boolean
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:61
• set
envmapBg(v
): void
Parameters
Name | Type |
---|---|
v | boolean |
Returns
void
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:64
Methods
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:38
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:42
fromJSON
▸ fromJSON(data
, meta?
): null
| SimpleBackgroundEnvUiPlugin
| Promise
<null
| SimpleBackgroundEnvUiPlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| SimpleBackgroundEnvUiPlugin
| Promise
<null
| SimpleBackgroundEnvUiPlugin
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:54
addEventListener
▸ addEventListener(type
, listener
): void
Adds a listener to an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
void
Inherited from
AViewerPlugin.addEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:48
hasEventListener
▸ hasEventListener(type
, listener
): boolean
Checks if listener is added to an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
boolean
Inherited from
AViewerPlugin.hasEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:56
removeEventListener
▸ removeEventListener(type
, listener
): void
Removes a listener from an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
void
Inherited from
AViewerPlugin.removeEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:63
dispatchEvent
▸ dispatchEvent(event
): void
Fire an event type.
Parameters
Name | Type |
---|---|
event | IEvent <"" | "serialize" | "deserialize" > |
Returns
void
Inherited from
Defined in
webgi/src/helpers/EventDispatcher.ts:74
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Overrides
Defined in
webgi/src/ui/simpleBackgroundEnvUiPlugin.ts:78
Constructors
constructor
• new SimpleBackgroundEnvUiPlugin()