Class: WaveGroundPlugin

Plugins.WaveGroundPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ WaveGroundPlugin

Properties

PluginType

▪ Static Readonly PluginType: "WaveGroundPlugin"

---

enabled

• enabled: boolean = false

Overrides

AViewerPlugin.enabled

---

planeMesh

• planeMesh: Mesh<PlaneGeometry, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>

---

noiseScale

• noiseScale: number = 1.8

---

amplitude

• amplitude: number = 0.5

---

paused

• paused: boolean = false

---

_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

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | WaveGroundPlugin | Promise<null | WaveGroundPlugin>

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

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

onEnable

▸ onEnable(): Promise<void>

Returns

Promise<void>

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

---

_makeRoughGround

▸ Protected _makeRoughGround(geometry, scl?, amp?): void

Parameters

Name	Type	Default value
geometry	BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>	undefined
scl	number	1
amp	number	1

Returns

void

Constructors

constructor

• new WaveGroundPlugin()

Overrides

AViewerPlugin.constructor