Class SceneNavigation

The UI element which displays the Scene documents which are currently enabled for quick navigation.

Hierarchy (view full)

Properties

_collapsed options _element position _dragDrop _tabs _searchFilters _minimized _scrollPositions appId _state _priorState RENDER_STATES

Accessors

scenes id element template popOut rendered closing title defaultOptions

Methods

render _render getData expand collapse activateListeners _onDragStart _onDrop activateTab bringToTop close minimize maximize setPosition _callHooks _saveScrollPositions _restoreScrollPositions _renderOuter _getHeaderButtons _activateCoreListeners _onChangeTab _onSearchFilter _canDragStart _canDragDrop _onDragOver _waitForImages _getContextMenuOptions _onClickScene _onToggleNav displayProgressBar

Properties

_collapsed

_collapsed: boolean

Navigation collapsed state

options

options: object

The options provided to this application upon initialization

_element

_element: jQuery

An internal reference to the HTML element this application renders

position

position: object

Track the current position and dimensions of the Application UI

_dragDrop

_dragDrop: DragDrop[]

DragDrop workflow handlers which are active for this Application

_tabs

_tabs: Tabs[]

Tab navigation handlers which are active for this Application

_searchFilters

_searchFilters: SearchFilter[]

SearchFilter handlers which are active for this Application

_minimized

_minimized: boolean

Track whether the Application is currently minimized

_scrollPositions

_scrollPositions: object

Track the most recent scroll positions for any vertically scrolling containers

appId

appId: number

The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT

Protected _state

_state: number

The current render state of the Application

See

Protected _priorState

_priorState: number

The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.

See

Static RENDER_STATES

RENDER_STATES: Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}> = ...

The sequence of rendering states that track the Application life-cycle.

Type declaration

  • ERROR: -3
  • CLOSING: -2
  • CLOSED: -1
  • NONE: 0
  • RENDERING: 1
  • RENDERED: 2

Accessors

scenes

  • get scenes(): Scene[]

  • Return an Array of Scenes which are displayed in the Navigation bar

    Returns Scene[]

id

  • get id(): string

  • Return the CSS application ID which uniquely references this UI element

    Returns string

element

  • get element(): jQuery

  • Return the active application element, if it currently exists in the DOM

    Returns jQuery

template

  • get template(): string

  • The path to the HTML template file which should be used to render the inner content of the app

    Returns string

popOut

  • get popOut(): boolean

  • Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered

    Returns boolean

rendered

  • get rendered(): boolean

  • Return a flag for whether the Application instance is currently rendered

    Returns boolean

closing

  • get closing(): boolean

  • Whether the Application is currently closing.

    Returns boolean

title

  • get title(): string

  • An Application window should define its own title definition logic which may be dynamic depending on its data

    Returns string

Static defaultOptions

  • get defaultOptions(): object

  • Assign the default options configuration which is used by this Application class. The options and values defined in this object are merged with any provided option values which are passed to the constructor upon initialization. Application subclasses may include additional options which are specific to their usage.

    Returns object

Methods

render

  • render(force, context?): any

  • Render the Application by evaluating it's HTML template against the object of data provided by the getData method If the Application is rendered as a pop-out window, wrap the contained HTML in an outer frame with window controls

    Parameters

    • force: any

      Add the rendered application to the DOM if it is not already present. If false, the Application will only be re-rendered if it is already present.

    • context: {} = {}

      Additional rendering options which are applied to customize the way that the Application is rendered in the DOM.

      Returns any

      The rendered Application instance

    _render

    • _render(force, options): Promise<void>

    • An asynchronous inner function which handles the rendering of the Application

      Parameters

      • force: any

        Render and display the application even if it is not currently displayed.

      • options: any

        Additional options which update the current values of the Application#options object

      Returns Promise<void>

      A Promise that resolves to the Application once rendering is complete

      Fires

      renderApplication

    getData

    • getData(options?): {
          collapsed: boolean;
          scenes: {
              id: string;
              active: any;
              name: string;
              tooltip: any;
              users: any;
              visible: any;
              css: any;
          }[];
      }

    • An application should define the data object used to render its template. This function may either return an Object directly, or a Promise which resolves to an Object If undefined, the default implementation will return an empty object allowing only for rendering of static HTML

      Parameters

      • options: {} = {}

        Returns {
            collapsed: boolean;
            scenes: {
                id: string;
                active: any;
                name: string;
                tooltip: any;
                users: any;
                visible: any;
                css: any;
            }[];
        }

        • collapsed: boolean
        • scenes: {
              id: string;
              active: any;
              name: string;
              tooltip: any;
              users: any;
              visible: any;
              css: any;
          }[]

      expand

      • expand(): true | Promise<any>

      • Expand the SceneNavigation menu, sliding it down if it is currently collapsed

        Returns true | Promise<any>

      collapse

      • collapse(): Promise<boolean>

      • Collapse the SceneNavigation menu, sliding it up if it is currently expanded

        Returns Promise<boolean>

      activateListeners

      • activateListeners(html): void

      • After rendering, activate event listeners which provide interactivity for the Application. This is where user-defined Application subclasses should attach their event-handling logic.

        Parameters

        • html: any

        Returns void

      _onDragStart

      _onDrop

      • _onDrop(event): Promise<any>

      • Parameters

        • event: any

        Returns Promise<any>

      activateTab

      • activateTab(tabName, options?): void

      • Change the currently active tab

        Parameters

        • tabName: string

          The target tab name to switch to

        • options: {
              group: string;
              triggerCallback: boolean;
          } = {}

          Options which configure changing the tab

          • group: string

            A specific named tab group, useful if multiple sets of tabs are present

          • triggerCallback: boolean

            Whether to trigger tab-change callback functions

        Returns void

      bringToTop

      • bringToTop(): void

      • Bring the application to the top of the rendering stack

        Returns void

      close

      • close(options?): Promise<void>

      • Close the application and un-register references to it within UI mappings This function returns a Promise which resolves once the window closing animation concludes

        Parameters

        • Optional options: object = {}

          Options which affect how the Application is closed

        Returns Promise<void>

        A Promise which resolves once the application is closed

        Fires

        closeApplication

      minimize

      • minimize(): Promise<void>

      • Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized

        Returns Promise<void>

        A Promise which resolves once the minimization action has completed

      maximize

      • maximize(): Promise<void>

      • Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized

        Returns Promise<void>

        A Promise which resolves once the maximization action has completed

      setPosition

      • setPosition(position?): void | {
            left: number;
            top: number;
            width: number;
            height: number;
            scale: number;
        }

      • Set the application position and store its new location. Returns the updated position object for the application containing the new values.

        Parameters

        • position: {
              left: number;
              top: number;
              width: number;
              height: string | number;
              scale: number;
          } = {}

          Positional data

          • left: number

            The left offset position in pixels

          • top: number

            The top offset position in pixels

          • width: number

            The application width in pixels

          • height: string | number

            The application height in pixels

          • scale: number

            The application scale as a numeric factor where 1.0 is default

        Returns void | {
            left: number;
            top: number;
            width: number;
            height: number;
            scale: number;
        }

      Protected _callHooks

      • _callHooks(hookName, ...hookArgs): void
      • Protected Internal

        Call all hooks for all applications in the inheritance chain.

        Parameters

        • hookName: string | ((className) => string)

          The hook being triggered, which formatted with the Application class name

        • Rest ...hookArgs: any[]

          The arguments passed to the hook calls

        Returns void

      Protected _saveScrollPositions

      • _saveScrollPositions(html): void
      • Protected

        Persist the scroll positions of containers within the app before re-rendering the content

        Parameters

        • html: jQuery

          The HTML object being traversed

        Returns void

      Protected _restoreScrollPositions

      • _restoreScrollPositions(html): void
      • Protected

        Restore the scroll positions of containers within the app after re-rendering the content

        Parameters

        • html: jQuery

          The HTML object being traversed

        Returns void

      Protected _renderOuter

      • _renderOuter(): Promise<jQuery>
      • Protected

        Render the outer application wrapper

        Returns Promise<jQuery>

        A promise resolving to the constructed jQuery object

      Protected _getHeaderButtons

      • _getHeaderButtons(): ApplicationHeaderButton[]
      • Protected

        Specify the set of config buttons which should appear in the Application header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.

        Returns ApplicationHeaderButton[]

        Fires

        getApplicationHeaderButtons

      Protected _activateCoreListeners

      • _activateCoreListeners(html): void
      • Protected

        Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.

        Parameters

        • html: jQuery

        Returns void

      Protected _onChangeTab

      • _onChangeTab(event, tabs, active): void
      • Protected

        Handle changes to the active tab in a configured Tabs controller

        Parameters

        • event: MouseEvent

          A left click event

        • tabs: Tabs

          The Tabs controller

        • active: string

          The new active tab name

        Returns void

      Protected _onSearchFilter

      • _onSearchFilter(event, query, rgx, html): void
      • Protected

        Handle changes to search filtering controllers which are bound to the Application

        Parameters

        • event: KeyboardEvent

          The key-up event from keyboard input

        • query: string

          The raw string input to the search field

        • rgx: RegExp

          The regular expression to test against

        • html: HTMLElement

          The HTML element which should be filtered

        Returns void

      Protected _canDragStart

      • _canDragStart(selector): boolean
      • Protected

        Define whether a user is able to begin a dragstart workflow for a given drag selector

        Parameters

        • selector: string

          The candidate HTML selector for dragging

        Returns boolean

        Can the current user drag this selector?

      Protected _canDragDrop

      • _canDragDrop(selector): boolean
      • Protected

        Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector

        Parameters

        • selector: string

          The candidate HTML selector for the drop target

        Returns boolean

        Can the current user drop on this selector?

      Protected _onDragOver

      • _onDragOver(event): void
      • Protected

        Callback actions which occur when a dragged element is over a drop target.

        Parameters

        • event: DragEvent

          The originating DragEvent

        Returns void

      Protected _waitForImages

      • _waitForImages(): Promise<void>
      • Protected

        Wait for any images present in the Application to load.

        Returns Promise<void>

        A Promise that resolves when all images have loaded.

      Private _getContextMenuOptions

      • _getContextMenuOptions(): object[]
      • Private

        Get the set of ContextMenu options which should be applied for Scenes in the menu

        Returns object[]

        The Array of context options passed to the ContextMenu instance

      Private _onClickScene

      • _onClickScene(event): void
      • Private

        Handle left-click events on the scenes in the navigation menu

        Parameters

        • event: PointerEvent

        Returns void

      Private _onToggleNav

      • _onToggleNav(event): true | Promise<any>
      • Private

        Handle navigation menu toggle click events

        Parameters

        • event: Event

        Returns true | Promise<any>

      Static displayProgressBar

      • displayProgressBar(options?): void

      • Display progress of some major operation like loading Scene textures.

        Parameters

        • options: {
              label: string;
              pct: number;
          } = {}

          Options for how the progress bar is displayed

          • label: string

            A text label to display

          • pct: number

            A percentage of progress between 0 and 100

        Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      _collapsedoptions_elementposition_dragDrop_tabs_searchFilters_minimized_scrollPositionsappId_state_priorStateRENDER_STATESscenesidelementtemplatepopOutrenderedclosingtitledefaultOptionsrender_rendergetDataexpandcollapseactivateListeners_onDragStart_onDropactivateTabbringToTopcloseminimizemaximizesetPosition_callHooks_saveScrollPositions_restoreScrollPositions_renderOuter_getHeaderButtons_activateCoreListeners_onChangeTab_onSearchFilter_canDragStart_canDragDrop_onDragOver_waitForImages_getContextMenuOptions_onClickScene_onToggleNavdisplayProgressBar