Skip to main content

Interface: TransformingPathStream

Defined in: src/sdk/graphics/path/PathStream.ts:121

A path stream which sends a transformed version of its input to be consumed by another stream.

Extends

Methods

arc()

arc(x, y, radius, startAngle, endAngle, counterClockwise?): void

Defined in: src/sdk/graphics/path/PathStream.ts:53

Paths an arc.

Parameters

ParameterTypeDescription
xnumberThe x-coordinate of the center of the circle containing the arc.
ynumberThe y-coordinate of the center of the circle containing the arc.
radiusnumberThe radius of the arc.
startAnglenumberThe angle of the start of the arc, in radians.
endAnglenumberThe angle of the end of the arc, in radians.
counterClockwise?booleanWhether the arc should be drawn counterclockwise. False by default.

Returns

void

Inherited from

PathStream.arc


beginPath()

beginPath(): void

Defined in: src/sdk/graphics/path/PathStream.ts:8

Begins a path. Erases all previous path state.

Returns

void

Inherited from

PathStream.beginPath


bezierCurveTo()

bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y): void

Defined in: src/sdk/graphics/path/PathStream.ts:33

Paths a cubic Bezier curve from the current point to a specified point.

Parameters

ParameterTypeDescription
cp1xnumberThe x-coordinate of the first control point.
cp1ynumberThe y-coordinate of the first control point.
cp2xnumberThe x-coordinate of the second control point.
cp2ynumberThe y-coordinate of the second control point.
xnumberThe x-coordinate of the end point.
ynumberThe y-coordinate of the end point.

Returns

void

Inherited from

PathStream.bezierCurveTo


closePath()

closePath(): void

Defined in: src/sdk/graphics/path/PathStream.ts:58

Paths a line from the current point to the first point defined by the current path.

Returns

void

Inherited from

PathStream.closePath


getConsumer()

getConsumer(): PathStream

Defined in: src/sdk/graphics/path/PathStream.ts:126

Gets the path stream that is consuming this stream's transformed output.

Returns

PathStream

The path stream that is consuming this stream's transformed output.


lineTo()

lineTo(x, y): void

Defined in: src/sdk/graphics/path/PathStream.ts:22

Paths a straight line from the current point to a specified point.

Parameters

ParameterTypeDescription
xnumberThe x-coordinate of the end point.
ynumberThe y-coordinate of the end point.

Returns

void

Inherited from

PathStream.lineTo


moveTo()

moveTo(x, y): void

Defined in: src/sdk/graphics/path/PathStream.ts:15

Moves to a specified point.

Parameters

ParameterTypeDescription
xnumberThe x-coordinate of the point to which to move.
ynumberThe y-coordinate of the point to which to move.

Returns

void

Inherited from

PathStream.moveTo


quadraticCurveTo()

quadraticCurveTo(cpx, cpy, x, y): void

Defined in: src/sdk/graphics/path/PathStream.ts:42

Paths a quadrative Bezier curve from the current point to a specified point.

Parameters

ParameterTypeDescription
cpxnumberThe x-coordinate of the control point.
cpynumberThe y-coordinate of the control point.
xnumberThe x-coordinate of the end point.
ynumberThe y-coordinate of the end point.

Returns

void

Inherited from

PathStream.quadraticCurveTo


setConsumer()

setConsumer(consumer): void

Defined in: src/sdk/graphics/path/PathStream.ts:132

Sets the path stream that consumes this stream's transformed output.

Parameters

ParameterTypeDescription
consumerPathStreamThe new consuming path stream.

Returns

void