Documentation
    Preparing search index...

    Class AssetPanoramicsRenderPlugin

    A renderer plugin for managing panoramic imagery layers associated with an asset. When panoramic data is present for the asset, this plugin initializes and controls panoramic views, allowing users to seamlessly enter and exit panoramic mode.

    This plugin interacts with PanoramaSupport to handle panoramic mode, including start-up, camera synchronization, and entering the closest panoramic position to the current camera viewpoint. It also coordinates with the LuciadRIA controller stack to manage a dedicated panoramic controller.

    Hierarchy

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

    Implements

    • AssetRendererPlugin
    Index

    Constructors

    Methods

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

      Parameters

      • disposable: Disposable

      Returns void

    • Adds an event listener to the plugin's panoramic event context. This method delegates to the internal PanoramicEventContext, allowing external components to listen for panoramic lifecycle events.

      Type Parameters

      • K extends keyof Events

      Parameters

      • event: K

        The event type to listen for (e.g., 'onEnterPanorama', 'onExitPanorama').

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

        A callback function to invoke when the specified event occurs.

      Returns { remove: () => void }

      A function to remove the listener (if supported).

    • Counts panorama points located within the given oriented box.

      Parameters

      • orientedBox: OrientedBox

        The oriented box geometry to test against.

      • withSlicingEffect: boolean = false

        If true, counts only points that are visible in oriented box and in the limit box. If false, counts all points inside the oriented box regardless of limit box. Usage:

        • Pass false when you want the total number of points inside the given level-oriented box without considering limit box visibility. Example: find how many points exist in total within this oriented box.

        • Pass true when you want to count only points visible with respect to limit box. Example: check if a given limit box contains any visible points to decide whether switching to a certain level in panorama mode is possible.

      Returns number

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

      Type Parameters

      • K extends keyof Events

      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.

      Parameters

      • _context: AssetRendererPluginContext

      Returns void

    • Called when the scene is considered "ready," i.e., sufficiently loaded. Starts entering the panoramic mode if the asset supports panoramic data and panoramic-only mode is detected.

      Parameters

      • context: AssetRendererPluginContext

      Returns void

    • Determines if the plugin should be registered based on the asset's artifact categories. This method checks if the asset has a panoramic category, indicating that panoramic data is present and the plugin should be enabled.

      Parameters

      • context: AssetRendererPluginContext

        The renderer plugin context providing access to the asset.

      Returns boolean

      true if the asset has a panoramic category, otherwise false.

    • 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.

    • Toggles enabled-state of pano points. This is for application decisions to show/hide pano points dependent on UI state (e.g. whether a certain tool is active). To hide pano points based on user preference, use setVisualizationSettings.

      Parameters

      • state: boolean

      Returns void