Class: Path

PhotoEditorSDK.Operations~SpriteOperation~BrushSprite~ Path

new Path(operation, options, canvas)

sdk/operations/shared/sprites/brush/path.js, line 33

Creates a Path

Name Type Description
operation PhotoEditorSDK.Operations.SpriteOperation.BrushSprite
options Object
canvas HTMLCanvasElement

Extends

Methods

addControlPoint(position)

sdk/operations/shared/sprites/brush/path.js, line 166

Adds a control point at the given position to this path

Name Type Description
position PhotoEditorSDK.Math.Vector2

forEachControlPoint(iterator)

sdk/operations/shared/sprites/brush/path.js, line 204

Calls iterator for each control point

Name Type Description
iterator function

getCanvas(){Canvas}

sdk/operations/shared/sprites/brush/path.js, line 176

Returns this path's canvas

Returns:
Type Description
Canvas

getCanvasDimensions(){PhotoEditorSDK.Math.Vector2}

sdk/operations/shared/sprites/brush/path.js, line 224

Returns the canvas dimension for this path

Returns:
Type Description
PhotoEditorSDK.Math.Vector2

render(inputDimensions)

sdk/operations/shared/sprites/brush/path.js, line 84

Draws this path onto its canvas

Name Type Description
inputDimensions PhotoEditorSDK.Math.Vector2

renderToCanvas(canvas)

sdk/operations/shared/sprites/brush/path.js, line 212

Renders this path to the given canvas with the right opacity

Name Type Description
canvas Canvas

serializeOption(optionName, toObject){*}

sdk/operations/shared/sprites/brush/path.js, line 48

Returns a serialized version of the given option

Name Type Default Description
optionName String
toObject Boolean false

= false

Returns:
Type Description
*

setCanvas(canvas)

sdk/operations/shared/sprites/brush/path.js, line 184

Sets the given canvas

Name Type Description
canvas HTMLCanvasElement

setDirty()

sdk/operations/shared/sprites/brush/path.js, line 192

Sets this path to dirty