Line

line.ts#L14

Class Line

An infinite straight line that goes through two points.

Implements GeoShape

constructor (p1: Point, p2: Point): Line

Name	Type	Default	Description
p1	Point
p2	Point

line.ts#L16

Property .flag

readonly Property .p1 : Point

readonly Property .p2 : Point

line.ts#L15

readonly Property .type : string

Default value: 'line'

line.ts#L46

Accessor .angle : number

The angle formed between this line and the x-axis.

line.ts#L41

Accessor .intercept : number

The y-axis intercept of this line.

line.ts#L21

Accessor .length : number

line.ts#L26

Accessor .lengthSquared : number

line.ts#L83

Accessor .line : Line

line.ts#L31

Accessor .midpoint : Point

The midpoint of this line.

line.ts#L73

Accessor .perpendicularBisector : Line

The perpendicular bisector of this line.

line.ts#L56

Accessor .perpendicularVector : Point

The point representing the perpendicular vector of this line.

line.ts#L87

Accessor .ray : Ray

line.ts#L91

Accessor .segment : Segment

line.ts#L36

Accessor .slope : number

The slope of this line.

line.ts#L51

Accessor .unitVector : Point

The point representing a unit vector along this line.

line.ts#L123

Method .at (t: number): Point

Gets the point at a specific offset along the line (opposite of .offset()).

Name	Type	Default	Description
t	number

line.ts#L118

Method .contains (p: SimplePoint, tolerance: number): boolean

Checks if a point p lies on this line.

Name	Type	Default	Description
p	SimplePoint
tolerance	number

line.ts#L78

Method .distanceSquared (p: Point): number

Squared distance between a point and a line.

Name	Type	Default	Description
p	Point

line.ts#L155

Method .equals (other: Line, tolerance: number): boolean

Name	Type	Default	Description
other	Line
tolerance	number

line.ts#L98

Method .offset (p: SimplePoint): number

Signed distance along the line (opposite of .at()).

Name	Type	Default	Description
p	SimplePoint

line.ts#L61

Method .parallel (p: Point): Line

Finds the line parallel to this one, going through point p.

Name	Type	Default	Description
p	Point

line.ts#L66

Method .perpendicular (p: Point): Line

Finds the line perpendicular to this one, going through point p.

Name	Type	Default	Description
p	Point

line.ts#L105

Method .project (p: SimplePoint): Point

Projects a point p onto this line.

Name	Type	Default	Description
p	SimplePoint

line.ts#L139

Method .reflect (l: Line): Line

Name	Type	Default	Description
l	Line

line.ts#L134

Method .rotate (a: number, c: Point): Line

Rotates this line by a given angle (in radians), optionally around point c.

Name	Type	Default	Description
a	number
c	Point	…

line.ts#L143

Method .scale (sx: number, sy: number): any

Name	Type	Default	Description
sx	number
sy	number	…

line.ts#L147

Method .shift (x: number, y: number): any

Name	Type	Default	Description
x	number
y	number	…

line.ts#L110

Method .side (p: SimplePoint, tolerance: number): number

Returns which side of this line a point p is on (or 0 on the line).

Name	Type	Default	Description
p	SimplePoint
tolerance	number

line.ts#L161

Method .toString (): string

line.ts#L129

Method .transform (m: TransformMatrix): Line

Name	Type	Default	Description
m	TransformMatrix

line.ts#L151

Method .translate (p: SimplePoint): any

Name	Type	Default	Description
p	SimplePoint

line.ts#L168

Class Ray

An infinite ray defined by an endpoint and another point on the ray.

Extends Line

line.ts#L169

readonly Property .type

Default value: 'ray'

line.ts#L178

Method .contains (p: Point, tolerance: number): boolean

Name	Type	Default	Description
p	Point
tolerance	number

line.ts#L171

Method .equals (other: Ray, tolerance: number): boolean

Name	Type	Default	Description
other	Ray
tolerance	number

line.ts#L184

Method .toString (): string

line.ts#L191

Class Segment

A finite line segment defined by its two endpoints.

Extends Line

line.ts#L192

readonly Property .type

Default value: 'segment'

line.ts#L194

Method .contains (p: Point, tolerance: number): boolean

Name	Type	Default	Description
p	Point
tolerance	number

line.ts#L213

Method .contract (x: number): Segment

Contracts (or expands) a line by a specific ratio.

Name	Type	Default	Description
x	number

line.ts#L217

Method .equals (other: Segment, tolerance: number, oriented: boolean): boolean

Name	Type	Default	Description
other	Segment
tolerance	number
oriented	boolean	false

line.ts#L204

Method .project (p: SimplePoint): Point

Name	Type	Default	Description
p	SimplePoint

line.ts#L224

Method .toString (): string