Files
cocos4/cocos/core/geometry/ray.ts
T
Yun Hsiao Wu 32598c25cb switch to eslint (#7727)
* switch to eslint

* eslint: extends airbnb
2020-11-09 10:19:12 +08:00

168 lines
4.2 KiB
TypeScript

/**
* @packageDocumentation
* @module geometry
*/
import { Vec3 } from '../math';
import enums from './enums';
import { IVec3Like } from '../math/type-define';
/**
* @en
* Basic Geometry: ray.
* @zh
* 基础几何 射线。
*/
export default class ray {
/**
* @en
* create a new ray
* @zh
* 创建一条射线。
* @param {number} ox 起点的 x 部分。
* @param {number} oy 起点的 y 部分。
* @param {number} oz 起点的 z 部分。
* @param {number} dx 方向的 x 部分。
* @param {number} dy 方向的 y 部分。
* @param {number} dz 方向的 z 部分。
* @return {ray} 射线。
*/
public static create (ox = 0, oy = 0, oz = 0, dx = 0, dy = 0, dz = 1): ray {
return new ray(ox, oy, oz, dx, dy, dz);
}
/**
* @en
* Creates a new ray initialized with values from an existing ray
* @zh
* 从一条射线克隆出一条新的射线。
* @param {ray} a 克隆的目标。
* @return {ray} 克隆出的新对象。
*/
public static clone (a: ray): ray {
return new ray(
a.o.x, a.o.y, a.o.z,
a.d.x, a.d.y, a.d.z,
);
}
/**
* @en
* Copy the values from one ray to another
* @zh
* 将从一个 ray 的值复制到另一个 ray。
* @param {ray} out 接受操作的 ray。
* @param {ray} a 被复制的 ray。
* @return {ray} out 接受操作的 ray。
*/
public static copy (out: ray, a: ray): ray {
Vec3.copy(out.o, a.o);
Vec3.copy(out.d, a.d);
return out;
}
/**
* @en
* create a ray from two points
* @zh
* 用两个点创建一条射线。
* @param {ray} out 接受操作的射线。
* @param {Vec3} origin 射线的起点。
* @param {Vec3} target 射线上的一点。
* @return {ray} out 接受操作的射线。
*/
public static fromPoints (out: ray, origin: Vec3, target: Vec3): ray {
Vec3.copy(out.o, origin);
Vec3.normalize(out.d, Vec3.subtract(out.d, target, origin));
return out;
}
/**
* @en
* Set the components of a ray to the given values
* @zh
* 将给定射线的属性设置为给定的值。
* @param {ray} out 接受操作的射线。
* @param {number} ox 起点的 x 部分。
* @param {number} oy 起点的 y 部分。
* @param {number} oz 起点的 z 部分。
* @param {number} dx 方向的 x 部分。
* @param {number} dy 方向的 y 部分。
* @param {number} dz 方向的 z 部分。
* @return {ray} out 接受操作的射线。
*/
public static set (out: ray, ox: number, oy: number, oz: number, dx: number, dy: number, dz: number): ray {
out.o.x = ox;
out.o.y = oy;
out.o.z = oz;
out.d.x = dx;
out.d.y = dy;
out.d.z = dz;
return out;
}
/**
* @en
* The origin of the ray.
* @zh
* 起点。
*/
public o: Vec3;
/**
* @en
* The direction of the ray.
* @zh
* 方向。
*/
public d: Vec3;
/**
* @en
* Gets the type of the shape.
* @zh
* 获取形状的类型。
*/
get type () {
return this._type;
}
protected readonly _type: number;
/**
* @en
* Construct a ray;
* @zh
* 构造一条射线。
* @param {number} ox 起点的 x 部分。
* @param {number} oy 起点的 y 部分。
* @param {number} oz 起点的 z 部分。
* @param {number} dx 方向的 x 部分。
* @param {number} dy 方向的 y 部分。
* @param {number} dz 方向的 z 部分。
*/
constructor (ox = 0, oy = 0, oz = 0,
dx = 0, dy = 0, dz = -1) {
this._type = enums.SHAPE_RAY;
this.o = new Vec3(ox, oy, oz);
this.d = new Vec3(dx, dy, dz);
}
/**
* @en
* Compute a point with the distance between the origin.
* @zh
* 根据给定距离计算出射线上的一点。
* @param out 射线上的另一点。
* @param distance 给定距离。
*/
public computeHit (out: IVec3Like, distance: number) {
Vec3.normalize(out, this.d)
Vec3.scaleAndAdd(out, this.o, out, distance);
}
}