Class: default
Defined in: src/lib/transform/Transformer/index.ts:141
Moves, scales and rotates a layer's pixels (or only the masked part).
prepare finds the area to transform and shows its box. The first change lifts the pixels off the layer, and preview then shows the
layer with them transformed. commit writes them back transformed; cancel puts the original pixels back.
float shows pasted pixels over a layer instead, ready to transform; commit writes them into the layer and cancel discards them.
Dispatches a change event whenever the box or preview changes.
Example
transformer.prepare(layer, selection.mask);
transformer.setBox(moveBox(transformer.box, 20, 0, false));
transformer.commit(); // or transformer.cancel()
Extends
EventTarget
Constructors
Constructor
new default(
width,height,createCanvas?):Transformer
Defined in: src/lib/transform/Transformer/index.ts:165
Parameters
width
number
height
number
createCanvas?
CanvasFactory = createOffscreenCanvas
Returns
Transformer
Overrides
EventTarget.constructor
Properties
box?
optionalbox?:TransformBox
Defined in: src/lib/transform/Transformer/index.ts:155
Where the pixels are placed now
height
readonlyheight:number
Defined in: src/lib/transform/Transformer/index.ts:146
Canvas height in pixels
layer?
optionallayer?:default
Defined in: src/lib/transform/Transformer/index.ts:149
Layer being transformed
source?
optionalsource?:Rect
Defined in: src/lib/transform/Transformer/index.ts:152
Area of the original pixels
width
readonlywidth:number
Defined in: src/lib/transform/Transformer/index.ts:143
Canvas width in pixels
Accessors
active
Get Signature
get active():
boolean
Defined in: src/lib/transform/Transformer/index.ts:177
Whether there is something to transform (its box is shown)
Returns
boolean
aspect
Get Signature
get aspect():
number
Defined in: src/lib/transform/Transformer/index.ts:192
Width ÷ height of the original area, kept when scaling proportionally
Returns
number
pasting
Get Signature
get pasting():
boolean
Defined in: src/lib/transform/Transformer/index.ts:187
Whether the pending pixels were pasted (rather than lifted off the layer)
Returns
boolean
pending
Get Signature
get pending():
boolean
Defined in: src/lib/transform/Transformer/index.ts:182
Whether pixels have been lifted and changed (or pasted) but not yet committed
Returns
boolean
preview
Get Signature
get preview():
LayerOverride|undefined
Defined in: src/lib/transform/Transformer/index.ts:197
The layer with the lifted pixels transformed, to draw in its place; undefined until something changes
Returns
LayerOverride | undefined
Methods
addEventListener()
addEventListener(
type,callback,options?):void
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14380
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Parameters
type
string
callback
EventListenerOrEventListenerObject | null
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
EventTarget.addEventListener
cancel()
cancel():
void
Defined in: src/lib/transform/Transformer/index.ts:291
Put the original pixels back and return the box to where it started (Escape). Pasted pixels are discarded.
Returns
void
commit()
commit(): {
area:Rect;before:OffscreenCanvas;box:TransformBox;maskPiece?:OffscreenCanvas;source:Rect; } |undefined
Defined in: src/lib/transform/Transformer/index.ts:256
Write the transformed pixels into the layer. Returns the mask piece and source area so the mask can be moved too, and the
changed area with a copy of its pixels from before the transform (for undo), or undefined if nothing changed. Afterwards
the transformer is empty; call prepare again to keep transforming.
Returns
{ area: Rect; before: OffscreenCanvas; box: TransformBox; maskPiece?: OffscreenCanvas; source: Rect; } | undefined
dispatchEvent()
dispatchEvent(
event):boolean
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14386
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
Parameters
event
Event
Returns
boolean
Inherited from
EventTarget.dispatchEvent
float()
float(
layer,image,area):void
Defined in: src/lib/transform/Transformer/index.ts:230
Show pasted pixels over a layer, in an area, ready to transform. They are only written into the layer on commit.
Parameters
layer
image
OffscreenCanvas
area
Returns
void
prepare()
prepare(
layer,mask?):void
Defined in: src/lib/transform/Transformer/index.ts:206
Find what to transform on a layer: all its visible pixels, or only those inside the mask. Shows nothing if there are none.
Parameters
layer
mask?
OffscreenCanvas
Returns
void
removeEventListener()
removeEventListener(
type,callback,options?):void
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14392
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Parameters
type
string
callback
EventListenerOrEventListenerObject | null
options?
boolean | EventListenerOptions
Returns
void
Inherited from
EventTarget.removeEventListener
reset()
reset():
void
Defined in: src/lib/transform/Transformer/index.ts:311
Forget the current transform without changing the layer.
Returns
void
setBox()
setBox(
box):void
Defined in: src/lib/transform/Transformer/index.ts:243
Place the pixels in a new box, lifting them off the layer first if needed.
Parameters
box
Returns
void