Class: TransformingPathStreamStack
A stack of TransformingPathStreams. Inputs are passed through the entire stack from top to bottom before the final transformed output is sent to a consuming stream.
Hierarchy
AbstractTransformingPathStream↳
TransformingPathStreamStack
Constructors
constructor
• new TransformingPathStreamStack(consumer): TransformingPathStreamStack
Constructor.
Parameters
| Name | Type | Description |
|---|---|---|
consumer | PathStream | The path stream that consumes this stream's transformed output. |
Returns
Inherited from
AbstractTransformingPathStream.constructor
Defined in
src/sdk/graphics/path/PathStream.ts:144
Properties
consumer
• Protected consumer: PathStream
The path stream that consumes this stream's transformed output.
Inherited from
AbstractTransformingPathStream.consumer
Defined in
src/sdk/graphics/path/PathStream.ts:144
Methods
arc
▸ arc(x, y, radius, startAngle, endAngle, counterClockwise?): void
Paths an arc.
Parameters
| Name | Type | Description |
|---|---|---|
x | number | The x-coordinate of the center of the circle containing the arc. |
y | number | The y-coordinate of the center of the circle containing the arc. |
radius | number | The radius of the arc. |
startAngle | number | The angle of the start of the arc, in radians. |
endAngle | number | The angle of the end of the arc, in radians. |
counterClockwise? | boolean | Whether the arc should be drawn counterclockwise. False by default. |
Returns
void
Overrides
AbstractTransformingPathStream.arc
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:86
beginPath
▸ beginPath(): void
Begins a path. Erases all previous path state.
Returns
void
Overrides
AbstractTransformingPathStream.beginPath
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:61
bezierCurveTo
▸ bezierCurveTo(cp1x, cp1y, cp2x, cp2y, x, y): void
Paths a cubic Bezier curve from the current point to a specified point.
Parameters
| Name | Type | Description |
|---|---|---|
cp1x | number | The x-coordinate of the first control point. |
cp1y | number | The y-coordinate of the first control point. |
cp2x | number | The x-coordinate of the second control point. |
cp2y | number | The y-coordinate of the second control point. |
x | number | The x-coordinate of the end point. |
y | number | The y-coordinate of the end point. |
Returns
void
Overrides
AbstractTransformingPathStream.bezierCurveTo
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:76
closePath
▸ closePath(): void
Paths a line from the current point to the first point defined by the current path.
Returns
void
Overrides
AbstractTransformingPathStream.closePath
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:91
getConsumer
▸ getConsumer(): PathStream
Gets the path stream that is consuming this stream's transformed output.
Returns
The path stream that is consuming this stream's transformed output.
Inherited from
AbstractTransformingPathStream.getConsumer
Defined in
src/sdk/graphics/path/PathStream.ts:148
lineTo
▸ lineTo(x, y): void
Paths a straight line from the current point to a specified point.
Parameters
| Name | Type | Description |
|---|---|---|
x | number | The x-coordinate of the end point. |
y | number | The y-coordinate of the end point. |
Returns
void
Overrides
AbstractTransformingPathStream.lineTo
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:71
moveTo
▸ moveTo(x, y): void
Moves to a specified point.
Parameters
| Name | Type | Description |
|---|---|---|
x | number | The x-coordinate of the point to which to move. |
y | number | The y-coordinate of the point to which to move. |
Returns
void
Overrides
AbstractTransformingPathStream.moveTo
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:66
pop
▸ pop(): undefined | TransformingPathStream
Removes the top-most path stream from this stack. The removed stream will have its consumer set to NullPathStream.INSTANCE.
Returns
undefined | TransformingPathStream
The removed path stream, or undefined if this stack was empty.
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:24
push
▸ push(stream): void
Adds a transforming path stream to the top of this stack.
Parameters
| Name | Type | Description |
|---|---|---|
stream | TransformingPathStream | A transforming path stream. |
Returns
void
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:14
quadraticCurveTo
▸ quadraticCurveTo(cpx, cpy, x, y): void
Paths a quadrative Bezier curve from the current point to a specified point.
Parameters
| Name | Type | Description |
|---|---|---|
cpx | number | The x-coordinate of the control point. |
cpy | number | The y-coordinate of the control point. |
x | number | The x-coordinate of the end point. |
y | number | The y-coordinate of the end point. |
Returns
void
Overrides
AbstractTransformingPathStream.quadraticCurveTo
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:81
setConsumer
▸ setConsumer(consumer): void
Sets the path stream that consumes this stream's transformed output.
Parameters
| Name | Type | Description |
|---|---|---|
consumer | PathStream | The new consuming path stream. |
Returns
void
Overrides
AbstractTransformingPathStream.setConsumer
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:54
shift
▸ shift(): undefined | TransformingPathStream
Removes the bottom-most path stream from this stack. The removed stream will have its consumer set to NullPathStream.INSTANCE.
Returns
undefined | TransformingPathStream
The removed path stream, or undefined if this stack was empty.
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:46
unshift
▸ unshift(stream): void
Adds a transforming path stream to the bottom of this stack.
Parameters
| Name | Type | Description |
|---|---|---|
stream | TransformingPathStream | A transforming path stream. |
Returns
void
Defined in
src/sdk/graphics/path/TransformingPathStreamStack.ts:34