Class Ray3

A 3D ray.

Hierarchy

Ray3

Index

Constructors

constructor

Properties

Accessors

raw

Methods

Constructors

constructor

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

- Defined in math/ray3/Ray3.ts:23
Parameters
- start: Vector3 = Vector3.zero
- end: Vector3 = Vector3.pz
Returns Ray3

Properties

direction

direction: Vector3

The direction of the ray. Make sure the direction is normalized.

origin

origin: Vector3

The origin of the ray.

Accessors

raw

get raw(): RawRay3

- Defined in math/ray3/Ray3.ts:31
Itself but RawRay3 form.

Returns RawRay3

Methods

distanceToSphere

distanceToSphere(sphere: Sphere3): null | [number, number]

- Defined in math/ray3/Ray3.ts:45
Return distances from given ray to sphere.

The returning distance can be negative.

The first returning value will be the distance of the incident point. If the ray does not intersect with sphere, it will return null.

Parameters
- sphere: Sphere3
  
  A target sphere
Returns null | [number, number]

Static fromLine3

fromLine3(line: Line3): Ray3

- Defined in math/ray3/Ray3.ts:62
Create a ray out of a line.

Parameters
- line: Line3
  
  A Line3
Returns Ray3

Static fromRaw

fromRaw(ray: RawRay3): Ray3

- Defined in math/ray3/Ray3.ts:53
Convert RawRay3 to class form.

Parameters
- ray: RawRay3
  
  A RawRay3
Returns Ray3

Generated using TypeDoc