Engine API Reference - v2.6.1
    Preparing search index...

    Class Ray

    An infinite ray.

    Index

    Constructors

    Properties

    Methods

    Constructors

    • 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 pc.Ray(this.entity.getPosition(), this.entity.forward);

    Properties

    direction: Vec3 = ...

    The direction of the ray.

    origin: Vec3 = ...

    The starting point of the ray.

    Methods

    • 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.