@baku89/pave v0.6.2
@baku89/pave v0.6.2
Modules
Types
Circle
Circle:
object
Defined in: Circle.ts:7
A circle represented as a tuple of a center and a radius.
Type declaration
Name | Type |
---|---|
center | vec2 |
radius | number |
CommandArgsA
CommandArgsA: readonly [
vec2
,number
,boolean
,boolean
]
Defined in: Path.ts:32
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:25
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
Defined in: Curve.ts:28
CurveC
Defined in: Curve.ts:25
CurveL
Defined in: Curve.ts:22
MultiSegment<V>
MultiSegment<
V
>:object
Defined in: MultiSegment.ts:8
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:93
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
Defined in: Path.ts:116
A path that only consists of arc (A
) commands.
See
https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#curve_commands
PathC
Defined in: Path.ts:109
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
Defined in: Path.ts:102
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
Rect
Rect: readonly [
vec2
,vec2
]
Defined in: Rect.ts:7
A 2D rect represented as a tuple of two diagonal points. It must be guaranteed that the first point is the minimum and the second one is the maximum in the x and y axes.
Segment<V>
Segment<
V
>:V
extendsVertexL
?SegmentL
:V
extendsVertexC
?SegmentC
:V
extendsVertexA
?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
Defined in: Path.ts:55
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.
VertexA
VertexA:
object
Defined in: Path.ts:83
A vertex representing an arc (A
) command.
Type declaration
Name | Type |
---|---|
args | CommandArgsA |
command | "A" |
point | vec2 |
See
https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#arcs
VertexC
VertexC:
object
Defined in: Path.ts:72
A vertex representing a cubic Bézier curve (C
) command.
Type declaration
Name | Type |
---|---|
args | CommandArgsC |
command | "C" |
point | vec2 |
VertexL
VertexL:
object
Defined in: Path.ts:62
A vertex representing a line (L
) command.
Type declaration
Name | Type |
---|---|
args ? | undefined |
command | "L" |
point | vec2 |
See
https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths#Line_commands