Class: ClippedPathStream

A path stream which performs clipping to an axis-aligned rectangular bounding box before sending the clipped path to another stream. Clipping is only supported for path segments added via the lineTo() and arc() methods. Path segments added via bezierCurveTo() and quadraticCurveTo() will be passed to the consumer stream unclipped.

Hierarchy

• AbstractTransformingPathStream

  ↳ ClippedPathStream

Constructors

constructor

• new ClippedPathStream(consumer, bounds): ClippedPathStream

Constructor.

Parameters

Name	Type	Description
consumer	PathStream	The path stream that consumes this stream's transformed output.
bounds	Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>	A subscribable which provides the clipping bounds for this stream, as [left, top, right, bottom]. Whenever the clipping bounds change, the state of this stream will be reset, as if beginPath() were called.

Returns

ClippedPathStream

Overrides

AbstractTransformingPathStream.constructor

Defined in

src/sdk/graphics/path/ClippedPathStream.ts:65

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	Default value	Description
x	number	undefined	The x-coordinate of the center of the circle containing the arc.
y	number	undefined	The y-coordinate of the center of the circle containing the arc.
radius	number	undefined	The radius of the arc.
startAngle	number	undefined	The angle of the start of the arc, in radians.
endAngle	number	undefined	The angle of the end of the arc, in radians.
counterClockwise	boolean	false	Whether the arc should be drawn counterclockwise. False by default.

Returns

void

Overrides

AbstractTransformingPathStream.arc

Defined in

src/sdk/graphics/path/ClippedPathStream.ts:249

---

beginPath

▸ beginPath(): void

Begins a path. Erases all previous path state.

Returns

void

Overrides

AbstractTransformingPathStream.beginPath

Defined in

src/sdk/graphics/path/ClippedPathStream.ts:72

---

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/ClippedPathStream.ts:199

---

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/ClippedPathStream.ts:415

---

destroy

▸ destroy(): void

Destroys this stream.

Returns

void

Defined in

src/sdk/graphics/path/ClippedPathStream.ts:474

---

getConsumer

▸ getConsumer(): PathStream

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.

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/ClippedPathStream.ts:103

---

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/ClippedPathStream.ts:78

---

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/ClippedPathStream.ts:224

---

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

Inherited from

AbstractTransformingPathStream.setConsumer

Defined in

src/sdk/graphics/path/PathStream.ts:153