Engine API Reference - v2.23.0-beta.17
    Preparing search index...

    Class Ray

    An infinite ray. Rays are commonly used for picking, raycasting and intersection tests.

    A ray is an origin and a direction. It performs no intersection itself: pass it to the intersectsRay method of a BoundingBox, BoundingSphere, OrientedBox, Plane or Tri. Keep the direction normalized, as those tests require it. The constructor copies the vectors it is given, and set updates both in place.

    // A ray from the camera through a screen position
    const ray = new Ray();
    entity.camera.screenToWorld(x, y, entity.camera.nearClip, ray.origin);
    entity.camera.screenToWorld(x, y, entity.camera.farClip, ray.direction);
    ray.direction.sub(ray.origin).normalize();
    Index
    constructor
    direction origin
    clone copy set

    • Creates a new Ray instance. The ray is infinite, starting at a given origin and pointing in a given direction.

      Parameters

      • Optionalorigin: Vec3

        The starting point of the ray. The constructor copies this parameter. Defaults to the origin (0, 0, 0).

      • Optionaldirection: Vec3

        The direction of the ray. The constructor copies this parameter. Defaults to a direction down the world negative Z axis (0, 0, -1).

      Returns Ray

      // Create a new ray starting at the position of this entity and pointing down
      // the entity's negative Z axis
      const ray = new Ray(this.entity.getPosition(), this.entity.forward);
    direction: Vec3 = ...

    The direction of the ray.

    origin: Vec3 = ...

    The starting point of the ray.

    • Copies the contents of a source Ray.

      Parameters

      • src: Ray

        The Ray to copy from.

      Returns Ray

      Self for chaining.

    • Sets origin and direction to the supplied vector values.

      Parameters

      • origin: Vec3

        The starting point of the ray.

      • direction: Vec3

        The direction of the ray.

      Returns Ray

      Self for chaining.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods