Skip to main content

Plugins

Plugin types (editor, panel, dialog, project settings, URI handler, background services, presets), the plugin system and its interfaces, and plugin verification.

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:CoreServiceBase class and module for creating background plugin services in Lens Studio.
LensStudio:DialogPluginModule providing base classes for building dialog-style plugins in Lens Studio.
LensStudio:EditorPluginModule providing base classes for building editor plugins that integrate custom editing behavior into Lens Studio.
LensStudio:GuiServiceModule providing GUI service plugin infrastructure for Lens Studio.
LensStudio:PanelPluginModule providing base classes for creating panel-based plugins in Lens Studio.
LensStudio:PluginVerifierModule providing base classes for writing plugin verifiers that validate plugin behavior in Lens Studio.
LensStudio:PresetModule providing the base Preset class and Descriptor for creating editor presets that add objects, assets, or components to a Lens Studio scene.
LensStudio:ProjectSettingsPluginModule for registering and managing project settings panels in Lens Studio.
LensStudio:UriHandlerPluginModule providing URI handling plugin infrastructure for extending Lens Studio with custom URI scheme handlers.

Editor services

APIDescription
Editor.IAuthorizationComponent that allows you to check whether Lens Studio is authorized, as well as get authorization.
Editor.IContextActionRegistryA registry of Editor.ContextAction which will be shown in a contextual menu (i.e. right click).
Editor.IPackageActionsInterface for package-level actions.
Editor.IPackageRegistryInterface for package discovery and registration.

Objects and data

APIDescription
BaseDescriptorBase class for plugin descriptors containing metadata and interface requirements.
EditorNamespace that provides access to the components of Lens Studio.
Editor.ContextActionAn action in a Editor.IContextActionRegistry.
Editor.IContextEditor context passed to context action callbacks when a right-click menu is triggered.
Editor.IGuardRepresents ownership of a resource.
Editor.IInterfaceBase interface type for Editor plugin system objects.
Editor.InterfaceIdUnique identifier for plugin interfaces.
Editor.IPluginInterface representing a plugin.
Editor.IPluginComponentInterface for plugin component registration.
Editor.PackageMetadataMetadata information about a package.
Editor.PluginSystemProvides access to the Lens Studio editor plugins, components, and interfaces
IPanelPluginPlugin base class for plugins that contribute a titled UI panel widget to the editor.
IPluginDescriptorDescriptor exposing a plugin's id, name, description, dependencies, and exported interfaces.

Enums

APIDescription
Editor.TargetPlatformEnum of platforms a Lens Studio plugin or project can target.