Class InteractionLayer

A subclass of CanvasLayer which provides support for user interaction with its contained objects.

Hierarchy (view full)

Properties

eventMode options #drawing #drawn

Accessors

active name hookName layerOptions instance

Methods

activate deactivate _draw getZIndex draw tearDown _activate _deactivate _onClickLeft _onClickLeft2 _canDragLeftStart _onDragLeftStart _onDragLeftMove _onDragLeftDrop _onDragLeftCancel _onClickRight _onMouseWheel _onDeleteKey _tearDown

Properties

eventMode

eventMode: string = "passive"

options

options: {
    name: string;
} = ...

Options for this layer instance.

Type declaration

  • name: string

Private #drawing

#drawing: Promise<CanvasLayer> = ...

An internal reference to a Promise in-progress to draw the CanvasLayer.

Private #drawn

#drawn: boolean = false

Is the layer drawn?

Accessors

active

  • get active(): boolean

  • Is this layer currently active

    Returns boolean

name

  • get name(): string

  • The canonical name of the CanvasLayer is the name of the constructor that is the immediate child of the defined baseClass for the layer type.

    Returns string

    Example

    canvas.lighting.name -> "LightingLayer"

hookName

  • get hookName(): string

  • The name used by hooks to construct their hook string. Note: You should override this getter if hookName should not return the class constructor name.

    Returns string

Static layerOptions

  • get layerOptions(): {
        name: string;
        zIndex: number;
    }

  • Customize behaviors of this CanvasLayer by modifying some behaviors at a class level.

    Returns {
        name: string;
        zIndex: number;
    }

    • name: string
    • zIndex: number

Static instance

  • get instance(): CanvasLayer

  • Return a reference to the active instance of this canvas layer

    Returns CanvasLayer

Methods

activate

  • activate(options?): InteractionLayer

  • Activate the InteractionLayer, deactivating other layers and marking this layer's children as interactive.

    Parameters

    • Optional options: {
          tool: string;
      } = {}

      Options which configure layer activation

      • tool: string

        A specific tool in the control palette to set as active

    Returns InteractionLayer

    The layer instance, now activated

deactivate

  • deactivate(): InteractionLayer

  • Deactivate the InteractionLayer, removing interactivity from its children.

    Returns InteractionLayer

    The layer instance, now inactive

_draw

  • _draw(options): Promise<void>

  • Parameters

    • options: any

    Returns Promise<void>

getZIndex

  • getZIndex(): number

  • Get the zIndex that should be used for ordering this layer vertically relative to others in the same Container.

    Returns number

draw

  • draw(options?): Promise<CanvasLayer>

  • Draw the canvas layer, rendering its internal components and returning a Promise. The Promise resolves to the drawn layer once its contents are successfully rendered.

    Parameters

    • Optional options: object = {}

      Options which configure how the layer is drawn

    Returns Promise<CanvasLayer>

tearDown

  • tearDown(options?): Promise<CanvasLayer>

  • Deconstruct data used in the current layer in preparation to re-draw the canvas

    Parameters

    • Optional options: object = {}

      Options which configure how the layer is deconstructed

    Returns Promise<CanvasLayer>

Protected _activate

  • _activate(): void
  • Protected

    The inner _activate method which may be defined by each InteractionLayer subclass.

    Returns void

Protected _deactivate

  • _deactivate(): void
  • Protected

    The inner _deactivate method which may be defined by each InteractionLayer subclass.

    Returns void

Protected _onClickLeft

  • _onClickLeft(event): void
  • Protected

    Handle left mouse-click events which originate from the Canvas stage.

    Parameters

    • event: FederatedEvent

      The PIXI InteractionEvent which wraps a PointerEvent

    Returns void

    See

    Canvas._onClickLeft

Protected _onClickLeft2

  • _onClickLeft2(event): void
  • Protected

    Handle double left-click events which originate from the Canvas stage.

    Parameters

    • event: FederatedEvent

      The PIXI InteractionEvent which wraps a PointerEvent

    Returns void

    See

    Canvas.#onClickLeft2

Protected _canDragLeftStart

  • _canDragLeftStart(user, event): boolean
  • Protected

    Does the User have permission to left-click drag on the Canvas?

    Parameters

    • user: User

      The User performing the action.

    • event: FederatedEvent

      The event object.

    Returns boolean

Protected _onDragLeftStart

  • _onDragLeftStart(event): void
  • Protected

    Start a left-click drag workflow originating from the Canvas stage.

    Parameters

    • event: FederatedEvent

      The PIXI InteractionEvent which wraps a PointerEvent

    Returns void

    See

    Canvas.#onDragLeftStart

Protected _onDragLeftMove

  • _onDragLeftMove(event): void
  • Protected

    Continue a left-click drag workflow originating from the Canvas stage.

    Parameters

    • event: FederatedEvent

      The PIXI InteractionEvent which wraps a PointerEvent

    Returns void

    See

    Canvas.#onDragLeftMove

Protected _onDragLeftDrop

  • _onDragLeftDrop(event): void
  • Protected

    Conclude a left-click drag workflow originating from the Canvas stage.

    Parameters

    • event: FederatedEvent

      The PIXI InteractionEvent which wraps a PointerEvent

    Returns void

    See

    Canvas.#onDragLeftDrop

Protected _onDragLeftCancel

  • _onDragLeftCancel(event): void
  • Protected

    Cancel a left-click drag workflow originating from the Canvas stage.

    Parameters

    • event: PointerEvent

      A right-click pointer event on the document.

    Returns void

    See

    Canvas.#onDragLeftDrop

Protected _onClickRight

  • _onClickRight(event): void
  • Protected

    Handle right mouse-click events which originate from the Canvas stage.

    Parameters

    • event: FederatedEvent

      The PIXI InteractionEvent which wraps a PointerEvent

    Returns void

    See

    Canvas._onClickRight

Protected _onMouseWheel

  • _onMouseWheel(event): void
  • Protected

    Handle mouse-wheel events which occur for this active layer.

    Parameters

    • event: WheelEvent

      The WheelEvent initiated on the document

    Returns void

    See

    MouseManager._onWheel

Protected _onDeleteKey

  • _onDeleteKey(event): Promise<void>
  • Protected

    Handle a DELETE keypress while this layer is active.

    Parameters

    • event: KeyboardEvent

      The delete key press event

    Returns Promise<void>

    See

    ClientKeybindings._onDelete

Protected _tearDown

  • _tearDown(options): Promise<void>
  • Protected

    The inner _tearDown method which may be customized by each CanvasLayer subclass.

    Parameters

    • options: object

      Options which configure how the layer is deconstructed

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

eventModeoptions#drawing#drawnactivenamehookNamelayerOptionsinstanceactivatedeactivate_drawgetZIndexdrawtearDown_activate_deactivate_onClickLeft_onClickLeft2_canDragLeftStart_onDragLeftStart_onDragLeftMove_onDragLeftDrop_onDragLeftCancel_onClickRight_onMouseWheel_onDeleteKey_tearDown