Class EntityGenerator

Example

// The EntityGenerator class (from LensStudio:EntityGenerator) is the base class
// for plugins that add new entity creation options to the editor.
//
// Members:
//   generate(): Promise<Entity> — override to create and return a new entity
//   pluginSystem (readonly)     — access to the plugin system

export class EntityGeneratorEntityGeneratorExampleGenerator extends EntityGenerator {
  connections: any[];
  static descriptor() {
    const d = new Descriptor();
    d.id = 'com.docs.EntityGeneratorEntityGeneratorExample';
    d.name = 'Named Object Generator';
    d.description = 'Demonstrates EntityGenerator with generate() override';
    d.entityType = 'SceneObject';
    d.displayOrder = 10;
    d.dependencies = [Editor.Model.IModel];
    return d;
  }
  constructor(pluginSystem: Editor.PluginSystem, descriptor?: Descriptor) {
    super(pluginSystem, descriptor);
    this.connections = [];
  }
  async generate(): Promise<Editor.Model.Entity> {
    const model = this.pluginSystem.findInterface(Editor.Model.IModel) as unknown as Editor.Model.IModel;
    const scene = model.project.scene;
    const obj = scene.addSceneObject(null as unknown as Editor.Model.SceneObject);
    obj.name = `Generated_${Date.now()}`;
    console.log(`Created scene object: ${obj.name}`);
    return obj;
  }
}
Copy