Whether this event target has any children that need UI events. This can be used optimize event propagation.
Options for this layer instance.
StaticTOGGLE_The shared palette tool.
Is this layer currently active
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.
StaticinstanceReturn a reference to the active instance of this canvas layer
StaticlayerCustomize behaviors of this CanvasLayer by modifying some behaviors at a class level.
Activate the InteractionLayer, deactivating other layers and marking this layer's children as interactive.
Optionaloptions: { tool?: string } = {}Options which configure layer activation
Optionaltool?: stringA specific tool in the control palette to set as active
The layer instance, now activated
Deactivate the InteractionLayer, removing interactivity from its children.
The layer instance, now inactive
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.
Optionaloptions: object = {}Options which configure how the layer is drawn
Get the zIndex that should be used for ordering this layer vertically relative to others in the same Container.
Deconstruct data used in the current layer in preparation to re-draw the canvas
Optionaloptions: object = {}Options which configure how the layer is deconstructed
Protected_ProtectedThe inner _activate method which may be defined by each InteractionLayer subclass.
Protected_ProtectedDoes the User have permission to left-click drag on the Canvas?
The User performing the action.
The event object.
Protected_ProtectedThe inner _deactivate method which may be defined by each InteractionLayer subclass.
Protected_ProtectedThe inner _draw method which must be defined by each CanvasLayer subclass.
Options which configure how the layer is drawn
Protected_ProtectedHighlight the objects of this layer.
Should the objects of this layer be highlighted?
Protected_ProtectedHandle left mouse-click events which originate from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedHandle double left-click events which originate from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedHandle right mouse-click events which originate from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedHandle double right mouse-click events which originate from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedHandle a Copy keypress while this layer is active.
The copy key press event
Was the event handled?
Protected_ProtectedHandle a Cut keypress while this layer is active.
The cut key press event
Was the event handled?
Protected_ProtectedHandle a Cycle View keypress while this layer is active.
The cycle-view key press event
Was the event handled?
Protected_ProtectedHandle a Delete keypress while this layer is active.
The delete key press event
Was the event handled?
Protected_ProtectedHandle a Dismiss keypress while this layer is active.
The dismiss key press event
Was the event handled?
Protected_ProtectedCancel a left-click drag workflow originating from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedConclude a left-click drag workflow originating from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedContinue a left-click drag workflow originating from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedStart a left-click drag workflow originating from the Canvas stage.
The PIXI InteractionEvent which wraps a PointerEvent
Protected_ProtectedHandle mouse-wheel events which occur for this active layer.
The WheelEvent initiated on the document
Protected_ProtectedHandle a Paste keypress while this layer is active.
The paste key press event
Was the event handled?
Protected_ProtectedHandle a Select All keypress while this layer is active.
The select-all key press event
Was the event handled?
Protected_ProtectedHandle a Undo keypress while this layer is active.
The undo key press event
Was the event handled?
Protected_ProtectedThe inner _tearDown method which may be customized by each CanvasLayer subclass.
Options which configure how the layer is deconstructed
StaticpreparePrepare data used by SceneControls to register tools used by this layer.
A subclass of CanvasLayer which provides support for user interaction with its contained objects.