C

VsdxPath

Show Usages

A class that models a path defining the geometry of a Shape.

Inheritance Hierarchy

Members

Show:

Properties

parent

: VsdxObject

Methods

arcTo

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: number | Value<number>
): VsdxPath

Draws a circular arc from the current end point to the given position.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of the arc's end point

y: ValueConvertible<number> | Value<number>

The y-coordinate of the arc's end point

a: number | Value<number>

The distance between the arc's midpoint to the midpoint of its chord

Return Value

close

(): VsdxPath

Closes the current sub-path by drawing a straight line back to the coordinates of the last moveTo.

If the path is already closed then, this method has no effect.

Return Value

ellipse

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
c: ValueConvertible<number> | Value<number>
d: ValueConvertible<number> | Value<number>
): VsdxPath

Draws an ellipse based on the given center point and major/minor axis.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of the center

y: ValueConvertible<number> | Value<number>

The y-coordinate of the center

a: ValueConvertible<number> | Value<number>

The x-coordinate of the first point on the ellipse

b: ValueConvertible<number> | Value<number>

The y-coordinate of the first point on the ellipse

c: ValueConvertible<number> | Value<number>

The x-coordinate of the second point on the ellipse

d: ValueConvertible<number> | Value<number>

The y-coordinate of the second point on the ellipse

Return Value

ellipticalArcTo

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
c: ValueConvertible<number> | Value<number>
d: ValueConvertible<number> | Value<number>
): VsdxPath

Draws an elliptical arc from the current end point to the given position.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of the arc's end point

y: ValueConvertible<number> | Value<number>

The y-coordinate of the arc's end point

a: ValueConvertible<number> | Value<number>

The x-coordinate of the arc's control point

b: ValueConvertible<number> | Value<number>

The y-coordinate of an arc's control point

c: ValueConvertible<number> | Value<number>

The angle of the major axis relative to the x-axis of its parent

d: ValueConvertible<number> | Value<number>

The ratio of the major axis to its minor axis

Return Value

equals

(other: VsdxPath): boolean

Checks whether this path is equal to another path.

Parameters

other: VsdxPath

Return Value

infiniteLine

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
): VsdxPath

Draws an infinite line between the given positions.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of a first point

y: ValueConvertible<number> | Value<number>

The y-coordinate of a first point

a: ValueConvertible<number> | Value<number>

The x-coordinate of a second point

b: ValueConvertible<number> | Value<number>

The y-coordinate of a second point

Return Value

lineTo

(x: ValueConvertible<number> | Value<number>, y: ValueConvertible<number> | Value<number>): VsdxPath

Draws a line from the current end point to the given position.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of the line's end point

y: ValueConvertible<number> | Value<number>

The y-coordinate of the line's end point

Return Value

moveTo

(x: ValueConvertible<number> | Value<number>, y: ValueConvertible<number> | Value<number>): VsdxPath

Moves the path to a given coordinate.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate

y: ValueConvertible<number> | Value<number>

The y-coordinate

Return Value

nurbsTo

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
c: ValueConvertible<number> | Value<number>
d: ValueConvertible<number> | Value<number>
e: ValueConvertible<number> | Value<number>
): VsdxPath

Draws a non-uniform rational B-spline (NURBS) from the current end point to the given position.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of the last control point

y: ValueConvertible<number> | Value<number>

The y-coordinate of the last control point

a: ValueConvertible<number> | Value<number>

The second to last knot

b: ValueConvertible<number> | Value<number>

The last weight

c: ValueConvertible<number> | Value<number>

The first knot

d: ValueConvertible<number> | Value<number>

The first weight

e: ValueConvertible<number> | Value<number>

A NURBS formula

Return Value

polylineTo

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: string | Value<string>
): VsdxPath

Draws a polyline, or consecutive lines from the current end point to the given position.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of the end point

y: ValueConvertible<number> | Value<number>

The y-coordinate of the end point

a: string | Value<string>

The polyline formula

Return Value

relCubBezTo

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
c: ValueConvertible<number> | Value<number>
d: ValueConvertible<number> | Value<number>
): VsdxPath

Draws a cubic Bézier curve from the current end point to the given position relative to the width and height of the Shape, using the two given control points.

Parameters

Return Value

relEllipticalArcTo

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
c: ValueConvertible<number> | Value<number>
d: ValueConvertible<number> | Value<number>
): VsdxPath

Draws an elliptical arc from the current end point to the given position relative to the height and width of the Shape.

Parameters

x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
c: ValueConvertible<number> | Value<number>

The angle of the major axis relative to the x-axis of its parent

d: ValueConvertible<number> | Value<number>

The ratio of the major axis to its minor axis

Return Value

relLineTo

(x: ValueConvertible<number> | Value<number>, y: ValueConvertible<number> | Value<number>): VsdxPath

Draws a line from the current end point to the given position relative the height/width of a Shape.

Parameters

Return Value

relMoveTo

(x: ValueConvertible<number> | Value<number>, y: ValueConvertible<number> | Value<number>): VsdxPath

Moves the path to a given coordinate that is relative to the width/height of the Shape.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate

y: ValueConvertible<number> | Value<number>

The y-coordinate

Return Value

relQuadBezTo

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
): VsdxPath

Draws a quadratic Bezier curve from the current end point to the given position relative to the width and height of the Shape using one control point.

Parameters

Return Value

splineKnot

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
): VsdxPath

Draws a spline segment from the current end point to a given knot position.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of a control point

y: ValueConvertible<number> | Value<number>

The y-coordinate of a control point

a: ValueConvertible<number> | Value<number>

A spline knot

Return Value

splineStart

(
x: ValueConvertible<number> | Value<number>
y: ValueConvertible<number> | Value<number>
a: ValueConvertible<number> | Value<number>
b: ValueConvertible<number> | Value<number>
c: ValueConvertible<number> | Value<number>
d: ValueConvertible<number> | Value<number>
): VsdxPath

Starts a spline from the current end point to the given position.

Parameters

x: ValueConvertible<number> | Value<number>

The x-coordinate of the second control point

y: ValueConvertible<number> | Value<number>

The y-coordinate of the second control point

a: ValueConvertible<number> | Value<number>

The second knot

b: ValueConvertible<number> | Value<number>

The first knot

c: ValueConvertible<number> | Value<number>

The last knot

d: ValueConvertible<number> | Value<number>

The degree of a spline

Return Value