@baku89/pave v0.7.1

@baku89/pave v0.7.1

Types

CommandArgsA

CommandArgsA: readonly [vec2, number, boolean, boolean]

Defined in: Path.ts:31

Arguments for arc (A) command

See

https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#arcs

CommandArgsC

CommandArgsC: readonly [vec2, vec2]

Defined in: Path.ts:24

Arguments for cubic Bézier curve (C) command.

See

https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#curve_commands

Curve<V>

Curve<V>: object

Defined in: Curve.ts:16

A single open or closed stroke represented as an array of vertices. All of the points are represented as tuple [x: number, y: number] and the commands are represented in absolute form.

Type Parameters

Type Parameter	Default type
`V` extends `Vertex`	`Vertex`

Type declaration

Name	Type
`closed`	`boolean`
`vertices`	`V`[]

CurveA

CurveA: Curve<VertexA>

Defined in: Curve.ts:28

CurveC

CurveC: Curve<VertexC>

Defined in: Curve.ts:25

CurveL

CurveL: Curve<VertexL>

Defined in: Curve.ts:22

MultiSegment<V>

MultiSegment<V>: object

Defined in: MultiSegment.ts:9

Represents a part of curve that spans multiple vertices.

Type Parameters

Type Parameter	Default type
`V` extends `Vertex`	`Vertex`

Type declaration

Name	Type
`start`	`vec2`
`vertices`	`V`[]

Path<V>

Path<V>: object

Defined in: Path.ts:92

A path that consists of multiple curves.

Type Parameters

Type Parameter	Default type
`V` extends `Vertex`	`Vertex`

Type declaration

Name	Type
`curves`	`Curve`<`V`>[]

PathA

PathA: Path<VertexA>

Defined in: Path.ts:115

A path that only consists of arc (A) commands.

See

https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#curve_commands

PathC

PathC: Path<VertexC>

Defined in: Path.ts:108

A path that only consists of cubic Bézier curve (C) commands.

See

https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#curve_commands

PathL

PathL: Path<VertexL>

Defined in: Path.ts:101

A path that only consists of line (L) commands, which is a simple polygon or polyline.

See

https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#Line_commands

Segment<V>

Segment<V>: V extends VertexL ? SegmentL : V extends VertexC ? SegmentC : V extends VertexA ? SegmentA : SegmentL | SegmentC | SegmentA

Defined in: Segment.ts:15

A segment of a path, which consists of a starting point, end point, and an interpolation command.

Type Parameters

Type Parameter	Default type
`V` extends `Vertex`	`Vertex`

SegmentA

SegmentA: VertexA & object

Defined in: Segment.ts:30

Type declaration

Name	Type
`start`	`vec2`

SegmentC

SegmentC: VertexC & object

Defined in: Segment.ts:27

Type declaration

Name	Type
`start`	`vec2`

SegmentL

SegmentL: VertexL & object

Defined in: Segment.ts:24

Type declaration

Name	Type
`start`	`vec2`

Vertex

Vertex: VertexL | VertexC | VertexA

Defined in: Path.ts:54

A vertex of a path. It consists of a end point and an interpolation command from the previous vertex, which is either a line (L) command, a cubic Bézier curve (C) command, or an arc (A) command.