Class PanelPlugin

Base class for plugins that create persistent UI panels; extend this and implement createWidget() to build panel UI.

Hierarchy (View Summary)

IPanelPlugin
- PanelPlugin

Index

Constructors

Properties

id pluginSystem title widget

Methods

createWidget deinit getTypeName isOfType isSame

Constructors

constructor

new PanelPlugin(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): PanelPlugin
Constructs a new PanelPlugin instance that registers a persistent UI panel within Lens Studio.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns PanelPlugin
Overrides IPanelPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The plugin system instance used to resolve interface dependencies.

`Readonly`title

title: string

Read-only string displayed as the panel's title.

`Readonly`widget

widget: Widget

Read-only UI widget rendered inside the panel.

Methods

createWidget

createWidget(parent: Widget): Widget
Creates and returns the root widget for the panel, parented to the given widget.
Parameters
- parent: Widget
Returns Widget

deinit

deinit(): void
Tears down the plugin and releases any resources it holds.

Returns void

getTypeName

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

Returns string
Inherited from IPanelPlugin.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPanelPlugin.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 IPanelPlugin.isSame