Module "line"

Index

Interfaces

Line

Constructor Functions

Length Functions

Other Functions

Constructor Functions

from

from(x1: number, y1: number, x2: number, y2: number): Line

- Defined in line.ts:48
Creates a line from the coordinates of its start and end.

Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns Line

fromPoints

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

- Defined in line.ts:57
Creates a line from start and end points.

Parameters
- p1: Point
- p2: Point
Returns Line

Length Functions

chebyshev

chebyshev(line: Line): number

- Defined in line.ts:113
Calculates the Chebyshev distance between the end points of line.

Parameters
- line: Line
Returns number

length

length(line: Line): number

- Defined in line.ts:93
Calculates the Euclidean distance between the end points of line.

Parameters
- line: Line
Returns number

manhattan

manhattan(line: Line): number

- Defined in line.ts:103
Calculates the Manhattan distance between the end points of line.

Parameters
- line: Line
Returns number

Other Functions

center

center(line: Line): Point

- Defined in line.ts:130
Gets the center point of line.

Parameters
- line: Line
Returns Point

clone

clone(line: Line): Line

- Defined in line.ts:69
Creates a copy of line.

Parameters
- line: Line
Returns Line

end

end(line: Line): Point

- Defined in line.ts:140
Get the end point of line.

Parameters
- line: Line
Returns Point

equals

equals(l1: Line, l2: Line): boolean

- Defined in line.ts:78
Determines whether l1 and l2 are equal.

Lines are considered equal if they have the same start and end points.

Parameters
- l1: Line
- l2: Line
Returns boolean

is

is(value: any): value is Line

- Defined in line.ts:32
Determines whether value is a Line.

Parameters
- value: any
Returns value is Line

start

start(line: Line): Point

- Defined in line.ts:123
Gets the start point of line.

Parameters
- line: Line
Returns Point

translate

translate(line: Line, vector: Vector): void

- Defined in line.ts:150
Translates line by vector.

This modifies line. Use translated if you want to create a new line instead.

Parameters
- line: Line
- vector: Vector
Returns void

translated

translated(line: Line, vector: Vector): Line

- Defined in line.ts:163
Translates line by vector.

This creates a new line. Use translate if you want to modify line instead.

Parameters
- line: Line
- vector: Vector
Returns Line

Generated using TypeDoc