Class ProjectSettingsPlugin

Example

// ProjectSettingsPlugin (the same class exported at the module root) is the
// base class to extend for a custom Project Settings panel. The descriptor
// names the panel and assigns it a section + icon; createWidget builds the
// panel body; deinit() releases any retained widgets/connections.
import { ProjectSettingsPlugin, Descriptor } from 'LensStudio:ProjectSettingsPlugin';
import * as Ui from 'LensStudio:Ui';

export class ProjectSettingsPluginOverviewExampleSettings extends ProjectSettingsPlugin {
  connections: any[];
  root: Ui.Widget | null;
  static descriptor(): Descriptor {
    const d = new Descriptor();
    d.id = 'com.docs.ProjectSettingsPluginOverviewExample';
    d.name = 'Settings Class Example';
    d.description = 'Demonstrates ProjectSettingsPlugin class lifecycle';
    d.title = 'Class Example';
    d.section = 'General Settings';
    d.icon = Editor.Icon.fromFile(new Editor.Path(import.meta.resolve('icon.svg')));
    d.dependencies = [Ui.IGui, Editor.Model.IModel];
    return d;
  }
  constructor(pluginSystem: Editor.PluginSystem, descriptor?: Descriptor) {
    super(pluginSystem, descriptor);
    this.connections = [];
    this.root = null;
  }
  createWidget(parent: Ui.Widget): Ui.Widget {
    this.root = new Ui.Widget(parent);
    const layout = new Ui.BoxLayout();
    layout.setDirection(Ui.Direction.TopToBottom);

    const model = this.pluginSystem.findInterface(Editor.Model.IModel) as unknown as Editor.Model.IModel;
    const assetCount = model.project.assetManager.assets.length;

    const info = new Ui.Label(this.root);
    info.text = `Project has ${assetCount} asset(s)`;
    info.wordWrap = true;
    layout.addWidget(info);
    layout.addStretch(1);

    this.root.layout = layout;
    return this.root;
  }
  deinit(): void {
    this.connections.forEach((c: any) => c?.disconnect());
    this.connections = [];
    if (this.root) { this.root.deleteLater(); this.root = null; }
  }
}
Copy