Class: DebugPlugin

Plugins.DebugPlugin

Hierarchy

• SimpleEventDispatcher<"">

  ↳ DebugPlugin

Implements

• IViewerPlugin

Properties

PluginType

▪ Static Readonly PluginType: "debug"

Defined in

webgi/src/plugins/DebugPlugin.ts:9

---

dirty

• dirty: boolean = false

Implementation of

IViewerPlugin.dirty

Defined in

webgi/src/plugins/DebugPlugin.ts:8

---

counters

• counters: Record<string, number> = {}

Defined in

webgi/src/plugins/DebugPlugin.ts:11

Constructors

constructor

• new DebugPlugin()

Inherited from

SimpleEventDispatcher.constructor

Defined in

webgi/src/helpers/EventDispatcher.ts:39

Methods

addEventListener

▸ addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

Name	Type
type	""
listener	(event: IEvent<"">) => void

Returns

void

Implementation of

IViewerPlugin.addEventListener

Inherited from

SimpleEventDispatcher.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	""
listener	(event: IEvent<"">) => void

Returns

boolean

Implementation of

IViewerPlugin.hasEventListener

Inherited from

SimpleEventDispatcher.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	""
listener	(event: IEvent<"">) => void

Returns

void

Implementation of

IViewerPlugin.removeEventListener

Inherited from

SimpleEventDispatcher.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63

---

dispatchEvent

▸ dispatchEvent(event): void

Fire an event type.

Parameters

Name	Type
event	IEvent<"">

Returns

void

Implementation of

IViewerPlugin.dispatchEvent

Inherited from

SimpleEventDispatcher.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Defined in

webgi/src/plugins/DebugPlugin.ts:13

---

addTexture

▸ addTexture(key, generator, rect?, texelModifier?, fragmentShader?, event?, isCubeTexture?): void

Parameters

Name	Type	Default value
key	string	undefined
generator	() => undefined | ITexture<any>	undefined
rect?	Vector4Tuple	undefined
texelModifier?	string	undefined
fragmentShader?	string	undefined
event	string	'postRender'
isCubeTexture	boolean	false

Returns

void

Defined in

webgi/src/plugins/DebugPlugin.ts:21

---

removeTexture

▸ removeTexture(key, event?): void

Parameters

Name	Type	Default value
key	string	undefined
event	string	'postRender'

Returns

void

Defined in

webgi/src/plugins/DebugPlugin.ts:43

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Defined in

webgi/src/plugins/DebugPlugin.ts:50

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Defined in

webgi/src/plugins/DebugPlugin.ts:54