Class Line3

A 3D line.

Hierarchy

Line3

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Line3(start?: Vector3, end?: Vector3): Line3

- Defined in math/line3/Line3.ts:18
Parameters
- start: Vector3 = Vector3.zero
- end: Vector3 = Vector3.zero
Returns Line3

Properties

end

start

start: Vector3

Accessors

raw

get raw(): RawLine3

- Defined in math/line3/Line3.ts:26
Itself but RawLine3 form.

Returns RawLine3

ray

get ray(): Ray3

- Defined in math/line3/Line3.ts:33
Itself but a ray.

Returns Ray3

Methods

applyMatrix4

applyMatrix4(matrix: Matrix4): Line3

- Defined in math/line3/Line3.ts:66
Apply given matrix4 to the line.

Parameters
- matrix: Matrix4
  
  A matrix4 which will be applied to the line
Returns Line3

at

at(t: number): Vector3

- Defined in math/line3/Line3.ts:57
Return a vector that represents a certain point of the line. Same as start at t = 0, same as end at t = 1.

Parameters
- t: number
  
  A parameter t
Returns Vector3

closestPointToPoint

closestPointToPoint(point: Vector3, segment: boolean): Vector3

- Defined in math/line3/Line3.ts:84
Return a point that is on the line which is closest to the given point.

If segment is true, it will treat the line as a segment which has start and end. Otherwise it will treat the line is infinite.

Parameters
- point: Vector3
  
  A point
- segment: boolean
  
  Is the line a segment?
Returns Vector3

delta

delta(): Vector3

- Defined in math/line3/Line3.ts:40
A vector that represents delta of the line.

Returns Vector3

distanceToPoint

distanceToPoint(point: Vector3, segment: boolean): number

- Defined in math/line3/Line3.ts:97
Return a distance from the line to the given point.

If segment is true, it will treat the line as a segment which has start and end. Otherwise it will treat the line is infinite.

Parameters
- point: Vector3
  
  A point
- segment: boolean
  
  Is the line a segment?
Returns number

length

length(): number

- Defined in math/line3/Line3.ts:47
Its length.

Returns number

Static fromRaw

fromRaw(line: RawLine3): Line3

- Defined in math/line3/Line3.ts:105
Convert RawLine3 to class form.

Parameters
- line: RawLine3
  
  A RawLine3
Returns Line3

Generated using TypeDoc