The texture that is used to fill this Drawing, if any.
The border frame and resizing handles for the drawing.
A text label that may be displayed as part of the interface layer for the Drawing.
The drawing shape which is rendered as a PIXI.Graphics in the interface or a PrimaryGraphics in the Primary Group.
Internal _pendingThe pending text.
Internal _onkeydownThe registered keydown listener.
Retain a reference to the Scene within which this Placeable Object resides
Each Drawing object provides an interface for a DrawingDocument
A control icon for interacting with the object
A mouse interaction manager instance which handles mouse workflows related to this object.
Private #drawAn internal timestamp for the previous freehand draw time, to limit sampling.
Private #fixedAn internal flag for the permanent points of the polygon.
Private #deleteDelete the Drawing if the text is empty once text editing ends?
Private #originalThe object that this object is a preview of if this object is a preview.
Private #lastThe bounds that the placeable was added to the quadtree with.
Private #drawingAn internal reference to a Promise in-progress to draw the Placeable Object.
Private #drawnHas this Placeable Object been drawn and is there no drawing in progress?
Static embeddedIdentify the official Document name for this PlaceableObject class
Static RENDER_since v12
Static FREEHAND_The rate at which points are sampled (in milliseconds) during a freehand drawing workflow
Static SHAPE_A convenience reference to the possible shape types.
A convenient reference for whether the current User is the author of the Drawing document.
Is this Drawing currently visible on the Canvas?
A Boolean flag for whether the Drawing utilizes a tiled texture background?
A Boolean flag for whether the Drawing is a Polygon type (either linear or freehand)?
Does the Drawing have text that is displayed?
The shape type that this Drawing represents. A value in Drawing.SHAPE_TYPES.
The object that this object is a preview of if this object is a preview.
A convenient reference for whether the current User has full control over the document.
The mouse interaction state of this placeable.
The id of the corresponding Document which this PlaceableObject represents.
A unique identifier which is used to uniquely identify elements on the canvas related to this object.
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.
Is this placeable object a temporary preview?
Does there exist a temporary preview of this placeable object?
Provide a reference to the CanvasLayer which contains this PlaceableObject.
A Form Application which is used to configure the properties of this Placeable Object or the Document it represents.
An indicator for whether the object is currently controlled
An indicator for whether the object is currently a hover target
Is the HUD display active for this Placeable?
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.
A new object with identical data
Internal Add a new polygon point to the drawing, ensuring it differs from the last one
The drawing point to add
Optional options: { Options which configure how the point is added
Should the point be rounded to integer coordinates?
Should the point be snapped to grid precision?
Is this a temporary control point?
Clear the display of the existing object.
The cleared object
Draw the placeable object into its parent container
Optional options: object = {}Options which may modify the draw and refresh workflow
The drawn object
Internal Execute a partial draw.
The draw function
The drawn object
Refresh all incremental render flags for the PlaceableObject. This method is no longer used by the core software but provided for backwards compatibility.
Optional options: object = {}Options which may modify the refresh workflow
The refreshed object
Assume control over a PlaceableObject, flagging it as controlled and enabling downstream behaviors
Additional options which modify the control request
Release any other controlled objects first
A flag denoting whether control was successful
Rotate the PlaceableObject to a certain angle of facing
The desired angle of rotation
Snap the angle of rotation to a certain target degree increment
The rotated object
Internal Determine a new angle of rotation for a PlaceableObject either from an explicit angle or from a delta offset.
An object which defines the rotation update parameters
An explicit angle, either this or delta must be provided
A relative angle delta, either this or the angle must be provided
A precision (in degrees) to which the resulting angle should snap. Default is 0.
The new rotation angle for the object
Test whether a user can perform a certain interaction regarding a Placeable Object
The User performing the action
The named action being attempted
Does the User have rights to perform the action?
Protected _getProtected _getProtected _getProtected _refreshProtected _refreshProtected _refreshProtected _refreshProtected _refreshProtected _refreshProtected _refreshProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _getProtected _onProtected _createProtected Create a standard MouseInteractionManager for the PlaceableObject
Protected _canHUDProtected Can the User access the HUD for this Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to view details of the Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to create the underlying Document?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to drag this Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to left-click drag this Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to hover on this Placeable Object?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to update the underlying Document?
The User performing the action.
The event object.
The returned status.
Protected _canProtected Does the User have permission to delete the underlying Document?
The User performing the action.
The event object.
The returned status.
Protected _onProtected Actions that should be taken for this Placeable Object when a mouseover event occurs. Hover events on PlaceableObject instances allow event propagation by default.
The triggering canvas interaction event
Options which customize event handling
Trigger hover-out behavior on sibling objects
MouseInteractionManager##handlePointerOver
Protected _onProtected _propagateProtected _onProtected _onProtected _propagateProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onProtected _onPrivate #addAdd a drawing object according to interface configuration.
Private #removePrivate #drawPrivate #drawCreate a PreciseText element to be displayed as part of this drawing.
Private #onPrivate #commitStatic rescaleGet a vectorized rescaling transformation for drawing data and dimensions passed in parameter
The original drawing data
The pixel distance dragged in the horizontal direction
The pixel distance dragged in the vertical direction
The adjusted shape data
Static normalize
The Drawing object is an implementation of the PlaceableObject container. Each Drawing is a placeable object in the DrawingsLayer.