Ray

Show Deprecated

The Ray data type represents a half-line, finite in one direction but infinite in the other. It can be defined by a 3D point, where the line originates from, and a direction vector, which is the direction it goes in.

Summary

Constructors

Properties

Methods

Constructors

new

Parameters

Origin: Vector3
Direction: Vector3

Properties

Unit

Ray

The Ray with a normalized direction (the direction has a magnitude of 1).

Origin

Vector3

The position of the origin.

Direction

Vector3

The direction vector of the Ray.

Methods

ClosestPoint

Vector3

Returns a Vector3 projected onto the ray so that it is within the Ray line of sight.

Note: the Ray must be a unit ray for this method to behave as expected!

Parameters

point: Vector3

Returns

Vector3

Distance

number

Returns the distance between the given point and the point on the ray nearest to the given point (Ray.ClosestPoint(point)).

Parameters

point: Vector3

Returns

number