Class GuiService

Example

// GuiService is the base class for GUI-aware editor plugins.
// It extends Editor.IPlugin with start()/stop() lifecycle methods.
//
// Members:
//   start(): void           — initialize GUI components
//   stop(): void            — tear down GUI components
//   pluginSystem (readonly) — access to the plugin system

export class GuiServiceClassExampleService extends GuiService {
  connections: any[];
  static descriptor() {
    const d = new Descriptor();
    d.id = 'com.docs.GuiServiceClassExample';
    d.name = 'GuiService Class Example';
    d.description = 'Demonstrates GuiService class with start/stop lifecycle';
    d.dependencies = [Editor.Model.IModel];
    return d;
  }
  constructor(pluginSystem: Editor.PluginSystem, descriptor?: Descriptor) {
    super(pluginSystem, descriptor);
    this.connections = [];
  }
  start(): void {
    const model = this.pluginSystem.findInterface(Editor.Model.IModel) as unknown as Editor.Model.IModel;
    const scene = model.project.scene;
    console.log('GuiService started');
    console.log(`Scene has ${scene.rootSceneObjects.length} root object(s)`);
  }
  stop(): void {
    this.connections.forEach((c: any) => c?.disconnect());
    this.connections = [];
  }
}
Copy