Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Class DrawingShapeControls

    Controls for a Drawing shape.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    editable renderFlags RENDER_FLAG_PRIORITY RENDER_FLAGS

    Accessors

    border dashed document handles layer object shape tint

    Methods

    _drawShape _onClick2 _onDragDrop _onDragMove _prepareDragDropUpdate _updateDragPreview applyRenderFlags destroy draw refresh _canDragStart _clear _draw _onDragCancel _onDragStart _refresh _createDragPreview

    Constructors

    Properties

    editable: boolean = true

    Are the controls editable?

    true
    renderFlags: RenderFlags

    Status flags which are applied at render-time to update the PlaceableObject. If an object defines RenderFlags, it should at least include flags for "redraw" and "refresh".

    RENDER_FLAG_PRIORITY: string = "INTERFACE"
    RENDER_FLAGS: { redraw: { propagate: string[] }; refresh: {} } = ...

    Accessors

    • get border(): Graphics

      The border of the shape.

      Returns Graphics

    • get dashed(): boolean

      Is the border dashed?

      Returns boolean

      false
    • get layer(): LayerClass

      The PlaceableLayer of this shape.

      Returns LayerClass

    • get object(): ObjectClass

      The PlaceableObject of this shape.

      Returns ObjectClass

    • get tint(): number

      The tint applied to these controls.

      Returns number

      0xFFFFFF

    Methods

    _drawShape

    _onClick2

    _onDragDrop

    _onDragMove

    • _onDragMove(event: any): void

      Handle the drag move event of a handle.

      Parameters

      • event: any

        The pointer event.

      Returns void

    _prepareDragDropUpdate

    • _prepareDragDropUpdate(
          event: any,
      ): {
          rotation: any;
          shape: { height: any; points: any; width: any };
          x: any;
          y: any;
      }

      Parameters

      • event: any

      Returns {
          rotation: any;
          shape: { height: any; points: any; width: any };
          x: any;
          y: any;
      }

    _updateDragPreview

    • Parameters

      • options: any

      Returns void

    • Refresh the visualization of these controls.

      Returns void

    Protected_canDragStart

    • _canDragStart(
          event: FederatedEvent<UIEvent | PixiTouch>,
          options?: { notify: boolean },
      ): boolean
      Protected

      Can the handle be dragged?

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The pointer event

      • Optionaloptions: { notify: boolean }

        Options, used internally

      Returns boolean

    Protected_clear

    Protected_draw

    • _draw(): Promise<void>
      Protected

      Draw these controls.

      Returns Promise<void>

    Protected_onDragCancel

    • _onDragCancel(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Handle the drag cancel event of a handle.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The pointer event.

      Returns void

    Protected_onDragStart

    • _onDragStart(event: FederatedEvent<UIEvent | PixiTouch>): void
      Protected

      Handle the drag start event of a handle.

      Parameters

      • event: FederatedEvent<UIEvent | PixiTouch>

        The pointer event.

      Returns void

    Protected_refresh

    • _refresh(): void
      Protected

      Refresh the visualization of these controls.

      Returns void

    Static_createDragPreview

    • _createDragPreview(object: ObjectClass): ObjectClass
      Internal

      Create and draw the drag preview for a placeable object.

      Parameters

      • object: ObjectClass

        The original placeable object

      Returns ObjectClass

      The preview of the placeable object.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods