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

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

188 lines
4.8 KiB
TypeScript

/**
* @packageDocumentation
* @module geometry
*/
import { Vec3 } from '../math';
import enums from './enums';
/**
* @en
* Basic Geometry: triangle.
* @zh
* 基础几何 三角形。
*/
export default class triangle {
/**
* @en
* create a new triangle
* @zh
* 创建一个新的 triangle。
* @param {number} ax a 点的 x 部分。
* @param {number} ay a 点的 y 部分。
* @param {number} az a 点的 z 部分。
* @param {number} bx b 点的 x 部分。
* @param {number} by b 点的 y 部分。
* @param {number} bz b 点的 z 部分。
* @param {number} cx c 点的 x 部分。
* @param {number} cy c 点的 y 部分。
* @param {number} cz c 点的 z 部分。
* @return {triangle} 一个新的 triangle。
*/
public static create (ax = 1, ay = 0, az = 0,
bx = 0, by = 0, bz = 0,
cx = 0, cy = 0, cz = 1): triangle {
return new triangle(ax, ay, az, bx, by, bz, cx, cy, cz);
}
/**
* @en
* clone a new triangle
* @zh
* 克隆一个新的 triangle。
* @param {triangle} t 克隆的目标。
* @return {triangle} 克隆出的新对象。
*/
public static clone (t: triangle): triangle {
return new triangle(
t.a.x, t.a.y, t.a.z,
t.b.x, t.b.y, t.b.z,
t.c.x, t.c.y, t.c.z,
);
}
/**
* @en
* copy the values from one triangle to another
* @zh
* 将一个 triangle 的值复制到另一个 triangle。
* @param {triangle} out 接受操作的 triangle。
* @param {triangle} t 被复制的 triangle。
* @return {triangle} out 接受操作的 triangle。
*/
public static copy (out: triangle, t: triangle): triangle {
Vec3.copy(out.a, t.a);
Vec3.copy(out.b, t.b);
Vec3.copy(out.c, t.c);
return out;
}
/**
* @en
* Create a triangle from three points
* @zh
* 用三个点创建一个 triangle。
* @param {triangle} out 接受操作的 triangle。
* @param {Vec3} a a 点。
* @param {Vec3} b b 点。
* @param {Vec3} c c 点。
* @return {triangle} out 接受操作的 triangle。
*/
public static fromPoints (out: triangle, a: Vec3, b: Vec3, c: Vec3): triangle {
Vec3.copy(out.a, a);
Vec3.copy(out.b, b);
Vec3.copy(out.c, c);
return out;
}
/**
* @en
* Set the components of a triangle to the given values
* @zh
* 将给定三角形的属性设置为给定值。
* @param {triangle} out 给定的三角形。
* @param {number} ax a 点的 x 部分。
* @param {number} ay a 点的 y 部分。
* @param {number} az a 点的 z 部分。
* @param {number} bx b 点的 x 部分。
* @param {number} by b 点的 y 部分。
* @param {number} bz b 点的 z 部分。
* @param {number} cx c 点的 x 部分。
* @param {number} cy c 点的 y 部分。
* @param {number} cz c 点的 z 部分。
* @return {triangle}
* @function
*/
public static set (out: triangle,
ax: number, ay: number, az: number,
bx: number, by: number, bz: number,
cx: number, cy: number, cz: number): triangle {
out.a.x = ax;
out.a.y = ay;
out.a.z = az;
out.b.x = bx;
out.b.y = by;
out.b.z = bz;
out.c.x = cx;
out.c.y = cy;
out.c.z = cz;
return out;
}
/**
* @en
* Point a.
* @zh
* 点 a。
*/
public a: Vec3;
/**
* @en
* Point b.
* @zh
* 点 b。
*/
public b: Vec3;
/**
* @en
* Point c.
* @zh
* 点 c。
*/
public c: Vec3;
/**
* @en
* Gets the type of the shape.
* @zh
* 获取形状的类型。
*/
get type () {
return this._type;
}
protected readonly _type: number;
/**
* @en
* Construct a triangle.
* @zh
* 构造一个三角形。
* @param {number} ax a 点的 x 部分。
* @param {number} ay a 点的 y 部分。
* @param {number} az a 点的 z 部分。
* @param {number} bx b 点的 x 部分。
* @param {number} by b 点的 y 部分。
* @param {number} bz b 点的 z 部分。
* @param {number} cx c 点的 x 部分。
* @param {number} cy c 点的 y 部分。
* @param {number} cz c 点的 z 部分。
*/
constructor (ax = 0, ay = 0, az = 0,
bx = 1, by = 0, bz = 0,
cx = 0, cy = 1, cz = 0) {
this._type = enums.SHAPE_TRIANGLE;
this.a = new Vec3(ax, ay, az);
this.b = new Vec3(bx, by, bz);
this.c = new Vec3(cx, cy, cz);
}
}