Class Descriptor

Example

// EditorPlugin Descriptor extends EditorDescriptor (from PanelPlugin) with:
//
//   canEdit: (entity: Editor.Model.Entity) => boolean
//     Callback that determines whether this plugin can edit a given entity.
//     The Inspector uses this to select which EditorPlugin to activate.
//
// Inherited from PanelDescriptor: defaultDockState, defaultSize, isUnique, menuActionHierarchy
// Inherited from BaseDescriptor: id, name, description, dependencies

export class EditorPluginDescriptorExampleEditor extends EditorPlugin {
  connections: any[];
  root: Widget | null;
  static descriptor() {
    const d = new Descriptor();
    d.id = 'com.docs.EditorPluginDescriptorExample';
    d.name = 'Descriptor Example Editor';
    d.description = 'Shows EditorPlugin Descriptor with canEdit callback';
    // canEdit receives a single entity and returns whether this plugin handles it
    d.canEdit = (entity: Editor.Model.Entity) => {
      if (Editor.isNull(entity)) return false;
      return entity.isOfType('SceneObject');
    };
    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);
    this.root.layout = layout;

    const label = new Label(this.root);
    label.text = 'canEdit matched this entity';
    layout.addWidget(label);

    return this.root;
  }
  edit(entities: Editor.Model.Entity[]): boolean {
    return true;
  }
  deinit(): void {
    this.connections.forEach((c: any) => c?.disconnect());
    this.connections = [];
    if (this.root) { this.root.deleteLater(); this.root = null; }
  }
}
Copy