Class OverlayPlugin

Base class for plugins that render overlay UI on top of the editor viewport.

Hierarchy (View Summary)

IPlugin
- OverlayPlugin

Index

Constructors

Properties

id pluginSystem

Methods

createWidget deinit getTypeName isOfType isSame requestHide requestShow

Constructors

constructor

new OverlayPlugin(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): OverlayPlugin
Constructs an OverlayPlugin instance with the given plugin system and optional descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns OverlayPlugin
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The plugin system instance this plugin is registered with.

Methods

createWidget

createWidget(parent: Widget): Widget
Creates and returns the overlay widget attached to the given parent widget.
Parameters
- parent: Widget
Returns Widget

deinit

deinit(): void
Cleans up and releases resources held by the overlay plugin.

Returns void

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame

requestHide

requestHide(): void
Requests that the overlay be hidden.

Returns void

requestShow

requestShow(): void
Requests that the overlay be shown.

Returns void