Class MeasuredTemplate

controlIcon

scene

document

mouseInteractionManager

_original

• get _original(): PlaceableObject

• The object that this object is a preview of if this object is a preview.

  Returns PlaceableObject

isOwner

• get isOwner(): boolean

• A convenient reference for whether the current User has full control over the document.

  Returns boolean

interactionState

• get interactionState(): {
      NONE: number;
      HOVER: number;
      CLICKED: number;
      GRABBED: number;
      DRAG: number;
      DROP: number;
  }

• The mouse interaction state of this placeable.

  Returns {
      NONE: number;
      HOVER: number;
      CLICKED: number;
      GRABBED: number;
      DRAG: number;
      DROP: number;
  }

  • NONE: number

  • HOVER: number

  • CLICKED: number

  • GRABBED: number

  • DRAG: number

  • DROP: number

center

• get center(): Point

• The central coordinate pair of the placeable object based on it's own width and height

  Returns Point

id

• get id(): string

• The id of the corresponding Document which this PlaceableObject represents.

  Returns string

objectId

• get objectId(): string

• A unique identifier which is used to uniquely identify elements on the canvas related to this object.

  Returns string

sourceId

• get sourceId(): string

• The named identified for the source object associated with this PlaceableObject. This differs from the objectId because the sourceId is the same for preview objects as for the original.

  Returns string

isPreview

• get isPreview(): boolean

• Is this placeable object a temporary preview?

  Returns boolean

hasPreview

• get hasPreview(): boolean

• Does there exist a temporary preview of this placeable object?

  Returns boolean

layer

• get layer(): PlaceablesLayer

• Provide a reference to the CanvasLayer which contains this PlaceableObject.

  Returns PlaceablesLayer

sheet

• get sheet(): FormApplication

• A Form Application which is used to configure the properties of this Placeable Object or the Document it represents.

  Returns FormApplication

controlled

• get controlled(): boolean

• An indicator for whether the object is currently controlled

  Returns boolean

hover

• get hover(): boolean

• An indicator for whether the object is currently a hover target

  Returns boolean

hasActiveHUD

• get hasActiveHUD(): boolean

• Is the HUD display active for this Placeable?

  Returns boolean

getSnappedPosition

• getSnappedPosition(position?): Point

• Get the snapped position for a given position or the current position.

  Parameters

  • Optional position: Point

    The position to be used instead of the current position

  Returns Point

  The snapped position

applyRenderFlags

• applyRenderFlags(): void

• Returns void

clear

• clear(): PlaceableObject

• Clear the display of the existing object.

  Returns PlaceableObject

  The cleared object

destroy

• destroy(options): any

• Parameters

  • options: any

  Returns any

  Inherit Doc

draw

• draw(options?): Promise<PlaceableObject>

• Draw the placeable object into its parent container

  Parameters

  • Optional options: object = {}

    Options which may modify the draw and refresh workflow

  Returns Promise<PlaceableObject>

  The drawn object

_partialDraw

• _partialDraw(fn): Promise<PlaceableObject>
• Internal

  Execute a partial draw.

  Parameters

  • fn: (() => Promise<void>)

    The draw function

    • • (): Promise<void>

      • Returns Promise<void>

  Returns Promise<PlaceableObject>

  The drawn object

refresh

• refresh(options?): PlaceableObject

• Refresh all incremental render flags for the PlaceableObject. This method is no longer used by the core software but provided for backwards compatibility.

  Parameters

  • Optional options: object = {}

    Options which may modify the refresh workflow

  Returns PlaceableObject

  The refreshed object

_updateQuadtree

• _updateQuadtree(): void
• Internal

  Update the quadtree.

  Returns void

control

• control(options?): boolean

• Assume control over a PlaceableObject, flagging it as controlled and enabling downstream behaviors

  Parameters

  • options: {
        releaseOthers: boolean;
    } = {}

    Additional options which modify the control request

    • releaseOthers: boolean

      Release any other controlled objects first

  Returns boolean

  A flag denoting whether control was successful

release

• release(options?): boolean

• Release control over a PlaceableObject, removing it from the controlled set

  Parameters

  • options: object = {}

    Options which modify the releasing workflow

  Returns boolean

  A Boolean flag confirming the object was released.

clone

• clone(): PlaceableObject

• Clone the placeable object, returning a new object with identical attributes. The returned object is non-interactive, and has no assigned ID. If you plan to use it permanently you should call the create method.

  Returns PlaceableObject

  A new object with identical data

_updateRotation

• _updateRotation(options?): number
• Internal

  Determine a new angle of rotation for a PlaceableObject either from an explicit angle or from a delta offset.

  Parameters

  • options: {
        angle: number;
        delta: number;
        snap: number;
    } = {}

    An object which defines the rotation update parameters

    • angle: number

      An explicit angle, either this or delta must be provided

    • delta: number

      A relative angle delta, either this or the angle must be provided

    • snap: number

      A precision (in degrees) to which the resulting angle should snap. Default is 0.

  Returns number

  The new rotation angle for the object

_getShiftedPosition

• _getShiftedPosition(dx, dy): Point
• Internal

  Obtain a shifted position for the Placeable Object

  Parameters

  • dx: -1 | 0 | 1

    The number of grid units to shift along the X-axis
  • dy: -1 | 0 | 1

    The number of grid units to shift along the Y-axis

  Returns Point

  The shifted target coordinates

activateListeners

• activateListeners(): void

• Activate interactivity for the Placeable Object

  Returns void

can

• can(user, action): boolean

• Test whether a user can perform a certain interaction regarding a Placeable Object

  Parameters

  • user: User

    The User performing the action
  • action: string

    The named action being attempted

  Returns boolean

  Does the User have rights to perform the action?

_prepareDragLeftDropUpdates

• _prepareDragLeftDropUpdates(event): object[]

• Perform the database updates that should occur as the result of a drag-left-drop operation.

  Parameters

  • event: FederatedEvent

    The triggering canvas interaction event

  Returns object[]

  An array of database updates to perform for documents in this collection