Class: SvgPathStream

A path stream which builds SVG path strings from its input path commands.

Implements

• PathStream

Constructors

constructor

• new SvgPathStream(precision?): SvgPathStream

Constructor.

Parameters

Name	Type	Default value	Description
precision	number	0	The precision of this stream. All coordinates will be rounded to this stream's precision when building the SVG path string. A value of 0 indicates infinite precision. Defaults to 0.

Returns

SvgPathStream

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:24

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

Implementation of

PathStream.arc

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:123

---

beginPath

▸ beginPath(): void

Begins a path. Erases all previous path state.

Returns

void

Implementation of

PathStream.beginPath

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:59

---

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

Implementation of

PathStream.bezierCurveTo

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:93

---

closePath

▸ closePath(): void

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

Returns

void

Implementation of

PathStream.closePath

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:172

---

getPrecision

▸ getPrecision(): number

Gets the precision of this stream. All coordinates will be rounded to this stream's precision when building the SVG path string. A value of 0 indicates infinite precision.

Returns

number

The precision of this stream.

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:44

---

getSvgPath

▸ getSvgPath(): string

Gets the SVG path string describing all path commands consumed by this stream since the last call to beginPath().

Returns

string

The SVG path string describing all path commands consumed by this stream since the last call to beginPath().

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:35

---

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

Implementation of

PathStream.lineTo

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:78

---

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

Implementation of

PathStream.moveTo

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:64

---

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

Implementation of

PathStream.quadraticCurveTo

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:108

---

setPrecision

▸ setPrecision(precision): void

Sets the precision of this stream. All coordinates will be rounded to this stream's precision when building the SVG path string. A value of 0 indicates infinite precision.

Parameters

Name	Type	Description
precision	number	The precision of this stream. Negative numbers will be converted to their absolute values.

Returns

void

Defined in

src/sdk/graphics/svg/SvgPathStream.ts:53