User Interface
Widgets, layouts, and dialogs for plugin panels; docking, icons, entity pickers, and editor views.
Commonly used
LensStudio:UiEditor.IconAn icon to be used in the Editor UI.Editor.DockContainer for dock panel management functionality.LensStudio:LensBasedEditorViewModule providing a live lens preview widget for use inside panel plugins.LensStudio:ModelUiEditor.IEntityPickerPopup window that allows the user to choose specific objects in the Scene hierarchy, or assets in the Asset Browser.
Guides
Basic StructuresThe following examples will guide you through the essential steps of plugin creation.Common TasksBelow are some common tasks you might need to do while creating your plugins.
All APIs in this topic
Get editor services with this.pluginSystem.findInterface(Editor.Model.IModel) and import modules with import * as Ui from 'LensStudio:Ui'.
Components, assets, and modules
| API | Description |
|---|---|
| LensStudio:LensBasedEditorView | Module providing a live lens preview widget for use inside panel plugins. |
| LensStudio:ModelUi | |
| LensStudio:MultimediaWidgets | Module providing multimedia playback widgets, including media player controls for use in Lens Studio editor UI. |
| LensStudio:ScriptEditor | Module for script editing capabilities in Lens Studio. |
| LensStudio:Ui | |
| LensStudio:UiTest | Module providing synthetic input and widget inspection utilities for driving the Lens Studio UI in integration tests. |
| LensStudio:Workspaces | Module for inspecting Lens Studio workspaces and installing custom workspace presets. |
Editor services
| API | Description |
|---|---|
| Editor.IEntityPicker | Popup window that allows the user to choose specific objects in the Scene hierarchy, or assets in the Asset Browser. |
Objects and data
| API | Description |
|---|---|
| Editor.Alignment | |
| Editor.Dock | Container for dock panel management functionality. |
| Editor.Icon | An icon to be used in the Editor UI. |
| Editor.Point | Represents a 2D point with x and y coordinates. |
| Editor.Rect | Represents a 2D rectangle with position and dimensions. |
| Editor.Size | Used with Editor.Assets.RenderTarget. |
Related topics
PluginsPlugin types (editor, panel, dialog, project settings, URI handler, background services, presets), the plugin system and its interfaces, and plugin verification.Project & SceneThe open project and its scene: scene objects, entities, layers, the asset manager, and import and export.NetworkingHTTP requests, sockets and servers, WebSockets, and remote services.