Interface PathSegment

A common interface for different kinds of path segments.

interface PathSegment {
    clone: (() => PathSegment);
    reverse: (() => PathSegment);
    getEndPoint(): Vertex;
    getEndTangent(): Vertex;
    getStartPoint(): Vertex;
    getStartTangent(): Vertex;
}

Hierarchy (view full)

PathSegment
- Path

Implemented by

Index

Properties

Methods

getEndPoint getEndTangent getStartPoint getStartTangent

Properties

clone

clone: (() => PathSegment)

Create a deep clone of this path segment.

Type declaration

- (): PathSegment
- Returns PathSegment

Method

clone

Memberof

PathSegment

Returns

A deep clone/copy of this path segment.

reverse

reverse: (() => PathSegment)

Revserse this path segment (in-place) and return this same instance (useful for chaining). The new path segment has start and end point swapped.

Type declaration

- (): PathSegment
- Returns PathSegment

Method

reverse

Memberof

PathSegment

Returns

This path segment instance (for chaining).

Methods

getEndPoint

getEndPoint(): Vertex
Get the end point of this path segment.

Returns Vertex
The end point of this path segment.

Method
getEndPoint

Memberof
PathSegment
- Defined in plotboilerplate/src/ts/interfaces/additionals.ts:26

getEndTangent

getEndTangent(): Vertex
Get the tangent's end point at the end point of this segment.

Returns Vertex
The end point of the ending point's tangent.

Method
getEndTangent

Memberof
PathSegment
- Defined in plotboilerplate/src/ts/interfaces/additionals.ts:44

getStartPoint

getStartPoint(): Vertex
Get the start point of this path segment.

Returns Vertex
The start point of this path segment.

Method
getStartPoint

Memberof
PathSegment
- Defined in plotboilerplate/src/ts/interfaces/additionals.ts:17

getStartTangent

getStartTangent(): Vertex
Get the tangent's end point at the start point of this segment.

Returns Vertex
The end point of the starting point's tangent.

Method
getStartTangent

Memberof
PathSegment
- Defined in plotboilerplate/src/ts/interfaces/additionals.ts:35