Class: CustomBumpMapPlugin

Plugins.CustomBumpMapPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ CustomBumpMapPlugin

Implements

• IViewerPlugin

Properties

PluginType

▪ Static Readonly PluginType: "CustomBumpMapPlugin"

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:22

---

CUSTOM_BUMP_MAP_GLTF_EXTENSION

▪ Static Readonly CUSTOM_BUMP_MAP_GLTF_EXTENSION: "WEBGI_materials_custom_bump_map"

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:249

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:25

---

dependencies

• dependencies: typeof AssetManagerPlugin[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:27

---

bicubicFiltering

• bicubicFiltering: boolean = true

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:31

---

materialExtension

• Readonly materialExtension: MaterialExtension

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:72

---

_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

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | CustomBumpMapPlugin | Promise<null | CustomBumpMapPlugin>

Implementation of

IViewerPlugin.fromJSON

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

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Implementation of

IViewerPlugin.storeState

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Implementation of

IViewerPlugin.loadState

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84

---

enableCustomBump

▸ enableCustomBump(material, map?, scale?): boolean

Parameters

Name	Type
material	IMaterial<any>
map?	ITexture<any>
scale?	number

Returns

boolean

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:45

---

setDirty

▸ setDirty(): void

Returns

void

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:209

---

onAdded

▸ onAdded(v): Promise<void>

Parameters

Name	Type
v	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:224

---

onRemove

▸ onRemove(v): Promise<void>

Parameters

Name	Type
v	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:234

---

enableCustomBumpSelected

▸ enableCustomBumpSelected(): boolean

Returns

boolean

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:243

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

• new CustomBumpMapPlugin()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:219