Interface Path

A common interface for general path representations.

interface Path {
    clone: (() => Path);
    getSegmentAt: ((index) => PathSegment);
    getSegmentCount: (() => number);
    reverse: (() => Path);
    getEndPoint(): Vertex;
    getEndTangent(): Vertex;
    getStartPoint(): Vertex;
    getStartTangent(): Vertex;
}

Hierarchy (view full)

Implemented by

Properties

clone getSegmentAt getSegmentCount reverse

Methods

getEndPoint getEndTangent getStartPoint getStartTangent

Properties

clone

clone: (() => Path)

Create a deep clone of this path.

Type declaration

Method

clone

Memberof

Path

Returns

A deep clone/copy of this path.

getSegmentAt

getSegmentAt: ((index) => PathSegment)

Get the path segment at the given index.

Type declaration

Method

getSegmentAt

Memberof

Path

Returns

The paths segment at the given index.

getSegmentCount

getSegmentCount: (() => number)

Get the number of segments in this path.

Type declaration

    • (): number

    • Returns number

Method

getSegmentCount

Memberof

Path

Returns

The number (integer) of path segments.

reverse

reverse: (() => Path)

Reverse this path (swap start and end and thus – the direction) in-place.

Type declaration

Method

revert

Memberof

Path

Returns

This path instance.

Methods

getEndPoint

getEndTangent

getStartPoint

getStartTangent

On This Page