Class: RandomizedDirectionalLightPlugin

Plugins.RandomizedDirectionalLightPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ RandomizedDirectionalLightPlugin

Implements

• IViewerPluginAsync

Properties

PluginType

▪ Static Readonly PluginType: "RandomizedDirectionalLight"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

light

• Readonly light: RandomizedDirectionalLight

---

lightLayers

• lightLayers: number = 1

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPluginAsync.dirty

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPluginAsync.dirty

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

---

cameraHelper

• get cameraHelper(): undefined | CameraHelper

Returns

undefined | CameraHelper

---

uiConfig

• get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPluginAsync.uiConfig

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onDispose

Inherited from

AViewerPlugin.onDispose

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPluginAsync.toJSON

Inherited from

AViewerPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | RandomizedDirectionalLightPlugin | Promise<null | RandomizedDirectionalLightPlugin>

Implementation of

IViewerPluginAsync.fromJSON

Inherited from

AViewerPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPluginAsync.storeState

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPluginAsync.loadState

Inherited from

AViewerPlugin.loadState

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onAdded

Overrides

AViewerPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPluginAsync.onRemove

Overrides

AViewerPlugin.onRemove

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

• new RandomizedDirectionalLightPlugin(enable?)

Parameters

Name	Type	Default value
enable	boolean	true

Overrides

AViewerPlugin.constructor