Shapemetry

Appearance

Shapemetry API

Shapemetry API / Line

Class: Line ​

Defined in: core/Line.ts:7

An infinite 3D line (point + direction), not a bounded segment.

Constructors ​

Constructor ​

new Line(point, direction): Line

Defined in: core/Line.ts:11

Parameters ​

point ​
x ​

number

y ​

number

z ​

number

direction ​
x ​

number

y ​

number

z ​

number

Returns ​

Line

Properties ​

point ​

point: Point

Defined in: core/Line.ts:8

direction ​

direction: Vector

Defined in: core/Line.ts:9

Methods ​

toJSON() ​

toJSON(): LineJSON

Defined in: core/Line.ts:23

Returns ​

LineJSON

fromJSON() ​

static fromJSON(d): Line

Defined in: core/Line.ts:24

Parameters ​

d ​

LineJSON

Returns ​

Line

closestPoint() ​

closestPoint(p): Point

Defined in: core/Line.ts:26

Parameters ​

p ​
x ​

number

y ​

number

z ​

number

Returns ​

Point

distanceToPoint() ​

distanceToPoint(p): number

Defined in: core/Line.ts:31

Parameters ​

p ​
x ​

number

y ​

number

z ​

number

Returns ​

number

equals() ​

equals(other): boolean

Defined in: core/Line.ts:37

Parameters ​

other ​

Line

Returns ​

boolean

shortestSegment() ​

shortestSegment(other): [Point, Point] | null

Defined in: core/Line.ts:44

Shortest segment between two lines. Returns [pointOnThis, pointOnOther] or null if parallel.

Parameters ​

other ​

Line

Returns ​

[Point, Point] | null