openrv-web / PluginContext

Interface: PluginContext

Defined in: plugin/types.ts:59

Context object passed to plugin lifecycle hooks. Provides access to the host application's registries and API.

Properties

api

readonly api: OpenRVAPI

Defined in: plugin/types.ts:76

Access the public OpenRV API (late-bound via closure over PluginRegistry)

---

events

readonly events: PluginEventSubscription

Defined in: plugin/types.ts:78

Event subscription system (app events + plugin-to-plugin custom events)

---

log

readonly log: object

Defined in: plugin/types.ts:82

Logger scoped to this plugin

error()

error(msg, ...args): void

Parameters

msg

string

args

...unknown[]

Returns

void

info()

info(msg, ...args): void

Parameters

msg

string

args

...unknown[]

Returns

void

warn()

warn(msg, ...args): void

Parameters

msg

string

args

...unknown[]

Returns

void

---

manifest

readonly manifest: PluginManifest

Defined in: plugin/types.ts:61

The plugin's own manifest

---

settings

readonly settings: PluginSettingsAccessor

Defined in: plugin/types.ts:80

Settings accessor (requires settingsSchema in manifest)

Methods

registerBlendMode()

registerBlendMode(name, blendFn): void

Defined in: plugin/types.ts:72

Register a blend mode

Parameters

name

string

blendFn

BlendModeContribution

Returns

void

---

registerDecoder()

registerDecoder(decoder): void

Defined in: plugin/types.ts:64

Register a format decoder

Parameters

decoder

FormatDecoder<any>

Returns

void

---

registerExporter()

registerExporter(name, exporter): void

Defined in: plugin/types.ts:70

Register an exporter (delegates to standalone ExporterRegistry)

Parameters

name

string

exporter

ExporterContribution

Returns

void

---

registerNode()

registerNode(type, creator): void

Defined in: plugin/types.ts:66

Register a node type

Parameters

type

string

creator

() => IPNode

Returns

void

---

registerTool()

registerTool(name, factory): void

Defined in: plugin/types.ts:68

Register a paint tool (delegates to PaintEngine.registerAdvancedTool)

Parameters

name

string

factory

() => PaintToolInterface

Returns

void

---

registerUIPanel()

registerUIPanel(panel): void

Defined in: plugin/types.ts:74

Register a UI panel

Parameters

panel

UIPanelContribution

Returns

void