API Reference

Class List

pc.Ray

An infinite ray

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

Summary

Details

Constructor

Ray([origin], [direction])

Creates a new infinite ray starting at a given origin and pointing in a given direction.

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

Parameters

originpc.Vec3The starting point of the ray. The constructor takes a reference of this parameter. Defaults to the origin (0, 0, 0).
directionpc.Vec3The direction of the ray. The constructor takes a reference of this parameter. Defaults to a direction down the world negative Z axis (0, 0, -1).