An implementation of the PlaceableHUD base class which renders a heads-up-display interface for Tile objects. The TileHUD implementation can be configured and replaced via CONFIG.Tile.hudClass.

Hierarchy (view full)

Properties

object: Tile

Reference a PlaceableObject this HUD is currently bound to.

_element: jQuery

An internal reference to the HTML element this application renders

options: object

The options provided to this application upon initialization

position: object

Track the current position and dimensions of the Application UI

_dragDrop: DragDrop[]

DragDrop workflow handlers which are active for this Application

_tabs: Tabs[]

Tab navigation handlers which are active for this Application

_searchFilters: SearchFilter[]

SearchFilter handlers which are active for this Application

_minimized: boolean

Track whether the Application is currently minimized

_scrollPositions: object

Track the most recent scroll positions for any vertically scrolling containers

appId: number

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

_state: number

The current render state of the Application

See

_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

#hoverControlIcon: boolean = false

Track whether a control icon is hovered or not

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

  • get layer(): ActiveHUDLayer
  • Convenience access for the canvas layer which this HUD modifies

    Returns ActiveHUDLayer

  • get id(): string
  • Return the CSS application ID which uniquely references this UI element

    Returns string

  • get element(): jQuery
  • Return the active application element, if it currently exists in the DOM

    Returns jQuery

  • get template(): string
  • The path to the HTML template file which should be used to render the inner content of the app

    Returns string

  • 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

  • get rendered(): boolean
  • Return a flag for whether the Application instance is currently rendered

    Returns boolean

  • get closing(): boolean
  • Whether the Application is currently closing.

    Returns boolean

  • get title(): string
  • An Application window should define its own title definition logic which may be dynamic depending on its data

    Returns string

  • 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

  • Handle mouse clicks to control a HUD control button

    Parameters

    • event: any

      The originating click event

    Returns any

  • Bind the HUD to a new PlaceableObject and display it

    Parameters

    • object: PlaceableObject

      A PlaceableObject instance to which the HUD should be bound

    Returns void

  • Clear the HUD by fading out it's active HTML and recording the new display state

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns Promise<void>

  • Handle attribute updates

    Parameters

    • event: FocusEvent

      The originating focusout event

    Returns void

  • 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: boolean = false

      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.

    • options: {
          left: number;
          top: number;
          width: number;
          height: number;
          scale: number;
          focus: boolean;
          renderContext: string;
          renderData: object;
      } = {}

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

      • left: number

        The left positioning attribute

      • top: number

        The top positioning attribute

      • width: number

        The rendered width

      • height: number

        The rendered height

      • scale: number

        The rendered transformation scale

      • focus: boolean

        Apply focus to the application, maximizing it and bringing it to the top of the vertical stack.

      • renderContext: string

        A context-providing string which suggests what event triggered the render

      • renderData: object

        The data change which motivated the render request

    Returns Application

    The rendered Application instance

  • 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

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

  • Protected

    Handle initial click to focus an attribute update field

    Parameters

    • event: MouseEvent

      The mouse click event

    Returns void

  • Protected

    Force field handling on an Enter keypress even if the value of the field did not change. This is important to suppose use cases with negative number values.

    Parameters

    • event: KeyboardEvent

      The originating keydown event

    Returns void

  • Protected

    Handle attribute bar update

    Parameters

    • name: string

      The name of the attribute

    • input: string

      The raw string input value for the update

    Returns Promise<void>

  • Protected

    Parse an attribute bar input string into a new value for the attribute field.

    Parameters

    • name: string

      The name of the attribute

    • attr: number | object

      The current value of the attribute

    • input: string

      The raw string input value

    Returns {
        value: number;
        isDelta: boolean;
        isBar: boolean;
    }

    The parsed input value

    • value: number
    • isDelta: boolean
    • isBar: boolean
  • Protected

    Handle sorting the z-order of the object

    Parameters

    • event: PointerEvent

      The originating mouse click event

    • up: boolean

      Move the object upwards in the vertical stack? If false, the object is moved downwards.

    Returns Promise<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

    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

    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

    Render the outer application wrapper

    Returns Promise<jQuery>

    A promise resolving to the constructed jQuery object

  • 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

    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

    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

    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

    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

    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

    Callback actions which occur at the beginning of a drag start workflow.

    Parameters

    • event: DragEvent

      The originating DragEvent

    Returns void

  • Protected

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

    Parameters

    • event: DragEvent

      The originating DragEvent

    Returns void

  • Protected

    Callback actions which occur when a dragged element is dropped on a target.

    Parameters

    • event: DragEvent

      The originating DragEvent

    Returns void

  • Protected

    Wait for any images present in the Application to load.

    Returns Promise<void>

    A Promise that resolves when all images have loaded.

  • Control video playback by toggling play or paused state for a video Tile.

    Parameters

    • event: PointerEvent

    Returns any