Skip to main content

User Interface

Widgets, layouts, and dialogs for plugin panels; docking, icons, entity pickers, and editor views.

Commonly used

Guides

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

APIDescription
LensStudio:LensBasedEditorViewModule providing a live lens preview widget for use inside panel plugins.
LensStudio:ModelUi
LensStudio:MultimediaWidgetsModule providing multimedia playback widgets, including media player controls for use in Lens Studio editor UI.
LensStudio:ScriptEditorModule for script editing capabilities in Lens Studio.
LensStudio:Ui
LensStudio:UiTestModule providing synthetic input and widget inspection utilities for driving the Lens Studio UI in integration tests.
LensStudio:WorkspacesModule for inspecting Lens Studio workspaces and installing custom workspace presets.

Editor services

APIDescription
Editor.IEntityPickerPopup window that allows the user to choose specific objects in the Scene hierarchy, or assets in the Asset Browser.

Objects and data

APIDescription
Editor.Alignment
Editor.DockContainer for dock panel management functionality.
Editor.IconAn icon to be used in the Editor UI.
Editor.PointRepresents a 2D point with x and y coordinates.
Editor.RectRepresents a 2D rectangle with position and dimensions.
Editor.SizeUsed with Editor.Assets.RenderTarget.