Skip to main content

Class: CustomBumpMapPlugin

Plugins.CustomBumpMapPlugin

Hierarchy

Implements

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:246


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:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:47


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | CustomBumpMapPlugin | Promise<null | CustomBumpMapPlugin>

Implementation of

IViewerPlugin.fromJSON

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:54


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Implementation of

IViewerPlugin.addEventListener

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

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

boolean

Implementation of

IViewerPlugin.hasEventListener

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

NameType
type"" | "serialize" | "deserialize"
listener(event: IEvent<"" | "serialize" | "deserialize">) => void

Returns

void

Implementation of

IViewerPlugin.removeEventListener

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Implementation of

IViewerPlugin.dispatchEvent

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


enableCustomBump

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

Parameters

NameType
materialIMaterial<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:208


onAdded

onAdded(v): Promise<void>

Parameters

NameType
vViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:223


onRemove

onRemove(v): Promise<void>

Parameters

NameType
vViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:233


enableCustomBumpSelected

enableCustomBumpSelected(): boolean

Returns

boolean

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:240

Constructors

constructor

new CustomBumpMapPlugin()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/CustomBumpMapPlugin.ts:218