Documentation
    Preparing search index...

    Class AssetSnapshotRenderPlugin

    Hierarchy

    • RendererPlugin & DisposableManaged & EventBus<Events, this> & Stateful<
          StoreApi<RemoveUnderscoredProperties<Store>>,
          this,
      >
      • AssetSnapshotRenderPlugin

    Implements

    • AssetRendererPlugin
    Index

    Constructors

    constructor

    Methods

    addDisposable addEventListener dispatchEvent getStore hookInitialize hookRegister? hookTeardown isTornDown takeSnapshot

    Constructors

    Methods

    • Adds the given Disposable to be owned by this plugin.

      Parameters

      • disposable: Disposable

      Returns void

    • Adds an event listener for a specific event.

      Type Parameters

      • K extends "onActiveChanged"

        The type of the event key.

      Parameters

      • event: K

        The event to listen to.

      • listener: (eventData: Events[K]) => void

        The callback function to be invoked when the event is emitted.

      Returns EventHandle

      An EventHandle with a remove method to unsubscribe the listener.

    • Dispatches the given event with given payload on the plugin.

      Type Parameters

      • K extends "onActiveChanged"

      Parameters

      Returns void

    • The store used by the plugin.

      Returns StoreApi

      Do not use this directly in user-land code. Either:

      • In React code, use the useRendererPluginStore or useRendererPluginStoreLazy hook.
      • In non-React code, add methods to mutate the store to the plugin's API instead.

    • Called by the plugin system is initialized.

      Returns void

    • Called when the plugin is registered in the system. The result of this hook determines whether the plugin is enabled.

      Parameters

      • context: unknown

        The context provided to the plugin.

      Returns boolean

      Whether the plugin should be enabled.

    • Called when the plugin system is manually torn down. This should be used to clean up resources.

      Parameters

      • context: unknown

        The context provided to the plugin.

      Returns void

    • Checks if the plugin has been torn down.

      Returns boolean

      true if the plugin has been torn down, otherwise false.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods