Class ProjectSettingsPlugin

Example

// ProjectSettingsPlugin is the class you extend to add a custom settings panel
// to the Lens Studio Project Settings dialog.
//
// Members:
//   createWidget(parent: Widget): Widget — build your settings UI
//   deinit(): void                       — release resources
//   setIssues(issues): void              — report Error/Warning/NoIssue
//   pluginSystem (readonly)              — resolve interface dependencies

export class ProjectSettingsPluginOverviewExampleSettings extends ProjectSettingsPlugin {
  connections: any[];
  root: Widget | null;
  static descriptor() {
    const d = new Descriptor();
    d.id = 'com.docs.ProjectSettingsPluginOverviewExample';
    d.name = 'Settings Class Example';
    d.description = 'Demonstrates ProjectSettingsPlugin class lifecycle';
    d.section = 'Examples';
    d.dependencies = [Editor.Model.IModel];
    return d;
  }
  constructor(pluginSystem: Editor.PluginSystem, descriptor?: Descriptor) {
    super(pluginSystem, descriptor);
    this.connections = [];
    this.root = null;
  }
  createWidget(parent: Widget): Widget {
    this.root = new Widget(parent);
    const layout = new BoxLayout();
    layout.setDirection(Direction.TopToBottom);
    layout.spacing = 8;
    this.root.layout = layout;

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

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

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