API
Return to top
Vector2
编辑

基础类型 / Vector2

Vector2 Class
​

二维向量

线性代数非常适用于游戏开发，这里会有一些简短而实用的介绍。如果已经很熟悉可以直接跳过。

这不是一个关于线性代数的正式教科书。我们会只看它如何应用于游戏开发。如果想更广泛地了解数学，请参阅 https://www.khanacademy.org/math/linear-algebra

🌵 坐标系 （2D）

在二维空间中，坐标是使用水平轴（x） 和 垂直轴（y）。2D 空间中的特定位置被写成一对值，例如 (9, 5)

注意：如果您不熟悉计算机图形学，那么 y正轴指向下方而不是上方。因为您可能是在数学课上学到的是指向上方。然而，这在大多数计算机图形学应用时 y 正轴指向下方。

这样，二维平面上的任意位置都可以用一对数字来标识。 然而，我们也可以将位置 (9, 5) 视为距 (0, 0) 点或原点的偏移量。 绘制一个从原点指向该点的箭头：

这是一个向量。 向量代表了很多有用的信息。 除了告诉我们该点位于 (9, 5) 之外，我们还可以将其视为角度 θ (theta) 和长度（或大小）m。 在这种情况下，箭头是一个位置向量 - 它表示空间中相对于原点的位置。

关于向量需要考虑的一个非常重要的一点是它们仅表示相对方向和大小。没有向量位置的概念。以下两个向量是相同的：

两个向量都表示某个起点右侧 9 个单位和下方 5 个单位的点。 无论您在平面上的哪个位置绘制矢量，它始终表示相对方向和大小。

🌵 向量运算

您可以使用任一方法（x 和 y 坐标或角度和大小）来引用向量，但为了方便起见，程序员通常使用坐标表示法。 例如，

使用示例: 创建一个名为 NewExample 的脚本，放置在对象栏中，打开脚本，将原本内容修改为如下内容，按键“F”，按钮会移动到（900,500）的位置。
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
         if (!SystemUtil.isClient()) return;
         this.test();
     }

     private async test(): Promise<void> {
         let btn = new ButtonUI();

         InputUtil.onKeyDown(Keys.F, async () => {
             let result = new Vector2(900,500)
             if (result) {
                 btn.button.position = result;
             }
         })
     }

 }

 class ButtonUI {
     public button: StaleButton;

     constructor(fun: Function = null) {
         this.creatUI(fun);
     }

     private creatUI(fun: Function = null) {
         // 创建一个UI对象
         let ui = UserWidget.newObject();
         // 将UI添加到屏幕上
         ui.addToViewport(1);
         // 创建一个画布组件
         let rootCanvas = Canvas.newObject();
         rootCanvas.size = new Vector2(1920, 1080);
         rootCanvas.position = Vector2.zero;
         // 将Ui的根画布设置为rootCanvas
         ui.rootContent = rootCanvas;
         // 在（0,0）点创建一个按钮
         this.button = StaleButton.newObject(rootCanvas);
         this.button.position = new Vector2(0, 0);
         this.button.size = new Vector2(100, 100);
         this.button.setNormalImageColorDecimal(0,255,0,255)
         this.button.text = "btn";
         this.button.transitionEnable = true;
         this.button.pressedImagColor = LinearColor.red;
         this.button.visibility = SlateVisibility.Visible;

         this.button.onClicked.add(() => {
             if (fun) {
                 fun();
             }
         })
     }
 }
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
         if (!SystemUtil.isClient()) return;
         this.test();
     }

     private async test(): Promise<void> {
         let btn = new ButtonUI();

         InputUtil.onKeyDown(Keys.F, async () => {
             let result = new Vector2(900,500)
             if (result) {
                 btn.button.position = result;
             }
         })
     }

 }

 class ButtonUI {
     public button: StaleButton;

     constructor(fun: Function = null) {
         this.creatUI(fun);
     }

     private creatUI(fun: Function = null) {
         // 创建一个UI对象
         let ui = UserWidget.newObject();
         // 将UI添加到屏幕上
         ui.addToViewport(1);
         // 创建一个画布组件
         let rootCanvas = Canvas.newObject();
         rootCanvas.size = new Vector2(1920, 1080);
         rootCanvas.position = Vector2.zero;
         // 将Ui的根画布设置为rootCanvas
         ui.rootContent = rootCanvas;
         // 在（0,0）点创建一个按钮
         this.button = StaleButton.newObject(rootCanvas);
         this.button.position = new Vector2(0, 0);
         this.button.size = new Vector2(100, 100);
         this.button.setNormalImageColorDecimal(0,255,0,255)
         this.button.text = "btn";
         this.button.transitionEnable = true;
         this.button.pressedImagColor = LinearColor.red;
         this.button.visibility = SlateVisibility.Visible;

         this.button.onClicked.add(() => {
             if (fun) {
                 fun();
             }
         })
     }
 }
  1. 向量成员

向量的各个组成部分可以通过名称直接访问。

使用示例: 访问向量
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(9, 5);
        console.log("x:" +a.x+ "  y:"+a.y);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(9, 5);
        console.log("x:" +a.x+ "  y:"+a.y);
     }
}
  1. 添加向量

当两个向量相加或相减时，相应的分量相加或相减：

使用示例: 两向量相加
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,3);
        let result = Vector2.add(a,b);
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,3);
        let result = Vector2.add(a,b);
        console.log(result);
     }
}

注意，添加 a + b 会得到与 b + a 相同的结果。

  1. 标量乘法

向量表示方向和大小。 仅代表大小的值称为标量。 标量在编辑器中使用 float 类型。

向量可以乘以标量：

使用示例: a * b
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let result = Vector2.multiply(a,3);
        // X=24, Y=6
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let result = Vector2.multiply(a,3);
        // X=24, Y=6
        console.log(result);
     }
}

将向量乘以正标量不会改变其方向，只会改变其大小。 与负标量相乘会产生相反方向的向量。 这就是缩放向量的方法。

  1. 单位向量

大小为 1 的向量称为单位向量。 它们有时也称为方向向量或法线。 当您需要跟踪方向时，单位向量很有用。

  1. 归一化

向量归一化意味着将其长度减小到 1，同时保留其方向。 这是通过将其每个分量除以其大小来完成的。 这是一个常见的操作，为此提供了一个专用的 normalized() 方法：

使用示例: 对 a 向量实现归一化。
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let result = Vector2.normalize(a);
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let result = Vector2.normalize(a);
        console.log(result);
     }
}

由于归一化涉及除以向量的长度，因此无法对长度为 0 的向量进行归一化。尝试这样做通常会导致错误。

  1. 反射

单位向量的常见用途是表示法线。 法向量是垂直于表面排列的单位向量，定义其方向。 它们通常用于照明、碰撞和其他涉及表面的操作。

使用示例: 求反射向量。
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(1,0);
        let result = Vector2.reflect(a,b);
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(1,0);
        let result = Vector2.reflect(a,b);
        console.log(result);
     }
}
  1. 点积

点积是向量数学中最重要的概念之一，但经常被误解。 点积是对两个向量进行的运算，返回一个标量。 与同时包含大小和方向的矢量不同，标量值仅具有大小。

点积的公式有两种常见形式：

数学符号 ||A|| 表示向量A的大小，Ax表示向量A的x分量。

在大多数情况下，使用内置的 dot 方法是最简单的。 请注意，两个向量的顺序并不重要：

使用示例: 求点积。
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(1,0);
        let result = Vector2.dot(a,b);
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(1,0);
        let result = Vector2.dot(a,b);
        console.log(result);
     }
}

点积在与单位向量一起使用时最有用，使第一个公式简化为 cos(θ)。 这意味着我们可以使用点积来告诉我们有关两个向量之间的角度的信息：

使用单位向量时，结果将始终介于 -1 (180°) 和 1 (0°) 之间。

  1. 叉积

与点积一样，叉积是对两个向量的运算。 然而，叉积的结果是一个方向垂直于两者的向量。 其大小取决于它们的相对角度。 如果两个向量平行，则它们的叉积的结果将是零向量。

叉积计算如下：

使用示例: 求叉积。
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(1,0);
        let result1 = Vector2.cross(a,b);
        let result2 = Vector2.cross(b,a);
        console.log(result1);
        console.log(result2);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(1,0);
        let result1 = Vector2.cross(a,b);
        let result2 = Vector2.cross(b,a);
        console.log(result1);
        console.log(result2);
     }
}

顺序很重要。 cross(a,b) 不会给出与 cross(b,a) 相同的结果。 所得向量指向相反的方向。

Table of contents ​

Properties
​

x: number
向量的 x 分量
y: number
向量的 y 分量

Accessors
​

length(): number
计算向量的长度
magnitude(a: Vector2): number
向量长度
negative(): Vector2
返回各个分量取反的新 Vector2 对象
normalized(): Vector2
返回一个新的 Vector2 对象
sqrLength(): number
向量长度的平方
sqrMagnitude(a: Vector2): number
向量长度平方
negOne(): Vector2
(-1, -1)
one(): Vector2
(1, 1)
unitX(): Vector2
(1, 0)
unitY(): Vector2
(0, 1)
zero(): Vector2
(0, 0)

Methods
​

向量相加
outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）
clone(a: Vector2): Vector2
克隆向量 a 得到新的 Vector2 向量
divide(a: Vector2, b: Vector2, outer?: Vector2): Vector2
向量 a 的每个分量除以标量 b
equals(a: Vector2, b: Vector2, epsilon?: number): boolean
判断两向量排除浮点数误差是否近似等价
fromString(str: string, outer?: Vector2): Vector2
通过一个字符串创建 Vector2 对象
multiply(a: Vector2, b: Vector2, outer?: Vector2): Vector2
向量 a 的每个分量乘以标量 b
normalize(a: Vector2, outer?: Vector2): Vector2
向量归一化
set(a: Vector2, x: number, y: number): Vector2
设置向量 a 的值
strictEquals(a: Vector2, b: Vector2): boolean
判断两向量是否相等
subtract(a: Vector2, b: Vector2, outer?: Vector2): Vector2
向量 a 减去向量 b
toString(): string
向量相加
outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）
angle(a: Vector2, b: Vector2): number
两向量夹角角度
ceil(a: Vector2, outer?: Vector2): Vector2
向量 a 每个元素向上取整
clamp(v: Vector2, min: Vector2, max: Vector2): Vector2
设置当前向量的值, 使其各个分量都处于指定的范围内
clone(a: Vector2): Vector2
克隆向量 a 得到新的 Vector2 向量
copy(a: Vector2, outer?: Vector2): Vector2
获得指定向量的拷贝
cross(a: Vector2, b: Vector2): number
叉积
distance(a: Vector2, b: Vector2): number
两向量的欧氏距离
divide(a: Vector2, b: Vector2, outer?: Vector2): Vector2
向量 a 的每个分量除以标量 b
dot(a: Vector2, b: Vector2): number
点积
equals(a: Vector2, b: Vector2, epsilon?: number): boolean
判断两向量排除浮点数误差是否近似等价
floor(a: Vector2, outer?: Vector2): Vector2
向量 a 每个元素向下取整
fromString(str: string, outer?: Vector2): Vector2
通过一个字符串创建 Vector2 对象
invert(a: Vector2, outer?: Vector2): Vector2
每个元素向量取倒数
invertSafe(a: Vector2, outer?: Vector2, epsilon?: number): Vector2
每个元素向量取倒数
lerp(a: Vector2, b: Vector2, t: number, outer?: Vector2): Vector2
向量 a 每个元素线性插值： a + t * (b - a)
magnitude(a: Vector2): number
向量长度
max(a: Vector2, b: Vector2, outer?: Vector2): Vector2
取两个向量对应x、y元素最小值最大值
min(a: Vector2, b: Vector2, outer?: Vector2): Vector2
取两个向量对应x、y元素最小值
moveTowards(current: Vector2, target: Vector2, maxDistanceDelta: number, outer?: Vector2): Vector2
向目标移动
multiply(a: Vector2, b: Vector2, outer?: Vector2): Vector2
向量 a 的每个分量乘以标量 b
negate(a: Vector2, outer?: Vector2): Vector2
每个元素向量取负
normalize(a: Vector2, outer?: Vector2): Vector2
向量归一化
project(a: Vector2, b: Vector2, outer?: Vector2): Vector2
向量 a 在向量 b 上的投影
random(range?: number): Vector2
生成一个在单位圆上均匀分布的随机 Vector2 对象
reflect(inDirection: Vector2, inNormal: Vector2, outer?: Vector2): Vector2
反射
rotate(v: Vector2, radians: number, outer?: Vector2): Vector2
向量 a 旋转某度后的向量
round(a: Vector2, outer?: Vector2): Vector2
每个元素四舍五入取整
set(a: Vector2, x: number, y: number): Vector2
设置向量 a 的值
signAngle(a: Vector2, b: Vector2): number
向量 a 和向量 b 之间的有符号角度
sqrMagnitude(a: Vector2): number
向量长度平方
squaredDistance(a: Vector2, b: Vector2): number
两向量的欧氏距离平方
strictEquals(a: Vector2, b: Vector2): boolean
判断两向量是否相等
subtract(a: Vector2, b: Vector2, outer?: Vector2): Vector2
向量 a 减去向量 b

用给定的 x, y 分量构建一个新的 Vector2

Parameters ​

x? numberx分量 default:0 range: 不做限制 type: 浮点数
y? numbery分量 default:0 range: 不做限制 type: 浮点数

• new Vector2(f)

用给定的 f 值设定给 x, y

Parameters ​

f number给定的 f 值 range: 不做限制 type: 浮点数

Properties ​

x
​

• x: number

向量的 x 分量

y
​

• y: number

向量的 y 分量

Accessors ​

length
​

• get length(): number

计算向量的长度

Returns ​

number向量的长度

magnitude
​

• get magnitude(): number

计算向量的长度

Parameters ​

a Vector2向量 a

Returns ​

number向量长度

negative
​

• get negative(): Vector2

返回各个分量取反的新 Vector2 对象

Returns ​

Vector2各个分量取反的新 Vector2 对象

normalized
​

• get normalized(): Vector2

返回一个新的 Vector2 对象

其大小为1, 但仍指向相同的方向 如果向量太小而无法归一化, 则返回 (0, 0)

Returns ​

Vector2返回一个新的 Vector2 对象

sqrLength
​

• get sqrLength(): number

向量长度的平方

Returns ​

number向量长度的平方

sqrMagnitude
​

• get sqrMagnitude(): number

计算向量的长度平方

Parameters ​

a Vector2向量 a

Returns ​

number向量长度平方

negOne
​

• Static get negOne(): Vector2

(-1, -1)

Returns ​

Vector2

one
​

• Static get one(): Vector2

(1, 1)

Returns ​

Vector2

unitX
​

• Static get unitX(): Vector2

(1, 0)

Returns ​

Vector2

unitY
​

• Static get unitY(): Vector2

(0, 1)

Returns ​

Vector2

zero
​

• Static get zero(): Vector2

(0, 0)

Returns ​

Vector2

Methods ​

add
​

• add(v): Vector2

加一个向量

Parameters ​

a Vector2向量 a
b Vector2向量 b
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相加的结果 Vector2 对象

Parameters ​

v Vector2相加的向量对象

Returns ​

Vector2修改后的自身对象

clone
​

• clone(): Vector2

Parameters ​

a Vector2向量 a

Returns ​

Vector2克隆得到的新 Vector2 向量

divide
​

v number相除的向量对象 range: 不做限制 type:浮点值

Returns ​

Vector2修改后的自身对象

• divide(v): Vector2

除以一个向量

Parameters ​

a Vector2向量 a
b number向量 b
range: 不限制 type:浮点数
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相除的结果 Vector2 对象

• Static divide(a, b, outer?): Vector2

向量 a 除以向量 b

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: a / b
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,4);
        let result = Vector2.multiply(a,4);
        // X=4, Y=0.5
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,4);
        let result = Vector2.multiply(a,4);
        // X=4, Y=0.5
        console.log(result);
     }
}

Parameters ​

a Vector2向量 a
b Vector2向量 b
range: 不限制 type:浮点数
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相除的结果 Vector2 对象

Parameters ​

v Vector2每个分量除以的参数

Returns ​

Vector2修改后的自身对象

乘以一个向量

Parameters ​

v Vector2相乘的向量对象

Returns ​

Vector2修改后的自身对象

• multiply(v): Vector2

乘以一个标量

Parameters ​

v number每个分量乘以的参数 range:不做限制 type:浮点数

Returns ​

Vector2修改后的自身对象

normalize
​

• normalize(): Vector2

将当前向量归一化

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2归一化后得到的 Vector2 对象

Returns ​

Vector2归一化后的自身对象

设置当前向量，使其与指定向量相等

Parameters ​

other Vector2指定的向量

Returns ​

Vector2this

• set(x?, y?): Vector2

设置当前向量的具体分量值

Parameters ​

x? numberx 分量 default:0.0 range: 不做限制 type: 浮点数
y? numbery 分量 default:0.0 range: 不做限制 type: 浮点数

Returns ​

Vector2this

strictEquals
​

• strictEquals(other): boolean

判断当前向量是否与指定向量相等

Parameters ​

a Vector2向量 a
b Vector2向量 b

Returns ​

boolean是否相等

subtract
​

• subtract(v): Vector2

减去一个向量

Parameters ​

a Vector2向量 a
b Vector2向量 b
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相减的结果 Vector2 对象

Parameters ​

v Vector2相减的向量对象

Returns ​

Vector2修改后的自身对象

toString
​

• toString(): string

Returns ​

string向量值字符串

add
​

两个向量相加

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: a + b
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,3);
        let result = Vector2.add(a,b);
        // X=11, Y=5
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,3);
        let result = Vector2.add(a,b);
        // X=11, Y=5
        console.log(result);
     }
}

Parameters ​

a Vector2向量 a
b Vector2向量 b
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相加的结果 Vector2 对象

angle
​

• Static angle(a, b): number

两向量夹角角度

Parameters ​

a Vector2向量 a
b Vector2向量 b

Returns ​

number向量a与向量b的夹角角度

ceil
​

• Static ceil(a, outer?): Vector2

向量 a 每个元素向上取整

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2逐元素向上取整后的 Vector2 对象

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: 向上取整示例
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8.22, 2.69);
        let result = Vector2.ceil(a);
        // X=9, Y=3
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8.22, 2.69);
        let result = Vector2.ceil(a);
        // X=9, Y=3
        console.log(result);
     }
}

clamp
​

• Static clamp(v, min, max): Vector2

设置当前向量的值, 使其各个分量都处于指定的范围内

Parameters ​

v Vector2向量 v
min Vector2最小值
max Vector2最大值

Returns ​

Vector2修改后的向量v

clone
​

• Static clone(a): Vector2

克隆向量 a 得到新的 Vector2 向量

Parameters ​

a Vector2向量 a

Returns ​

Vector2克隆得到的新 Vector2 向量

copy
​

• Static copy(a, outer?): Vector2

获得指定向量的拷贝

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2拷贝得到的 Vector2 向量

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

cross
​

• Static cross(a, b): number

叉积

Parameters ​

a Vector2向量 a
b Vector2向量 b

Returns ​

number叉积

Precautions

注意二维向量的叉积为与 Z 轴平行的三维向量, 此处以向量的模长表示

distance
​

• Static distance(a, b): number

两向量的欧氏距离

Parameters ​

a Vector2向量 a
b Vector2向量 b

Returns ​

number两向量的欧氏距离

divide
​

• Static divide(a, b, outer?): Vector2

向量 a 的每个分量除以标量 b

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: a / b
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let result = Vector2.multiply(a,4);
        // X=2, Y=0.5
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let result = Vector2.multiply(a,4);
        // X=2, Y=0.5
        console.log(result);
     }
}

Parameters ​

a Vector2向量 a
b number向量 b
range: 不限制 type:浮点数
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相除的结果 Vector2 对象

• Static divide(a, b, outer?): Vector2

向量 a 除以向量 b

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: a / b
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,4);
        let result = Vector2.multiply(a,4);
        // X=4, Y=0.5
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,4);
        let result = Vector2.multiply(a,4);
        // X=4, Y=0.5
        console.log(result);
     }
}

Parameters ​

a Vector2向量 a
b Vector2向量 b
range: 不限制 type:浮点数
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相除的结果 Vector2 对象

dot
​

• Static dot(a, b): number

点积

Parameters ​

a Vector2向量 a
b Vector2向量 b

Returns ​

number点积

equals
​

• Static equals(a, b, epsilon?): boolean

判断两向量排除浮点数误差是否近似等价

Parameters ​

a Vector2向量 a
b Vector2向量 b
epsilon? number最小误差数 default:MathUtil.EPSILON
range: 建议传入小于 1 的值。 type:浮点数

Returns ​

boolean是否相等

floor
​

• Static floor(a, outer?): Vector2

向量 a 每个元素向下取整

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2逐元素向下取整后的 Vector2 对象

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

fromString
​

• Static fromString(str, outer?): Vector2

通过一个字符串创建 Vector2 对象

Parameters ​

str string传入的字符串 range:"0.000000,0.000000"
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2创建的 Vector2 对象

字符串格式举例："X=2,Y=3"

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: 使用字符串创建一个向量
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let result = Vector2.fromString("X=2,Y=3");
        // X=2, Y=3
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let result = Vector2.fromString("X=2,Y=3");
        // X=2, Y=3
        console.log(result);
     }
}

invert
​

• Static invert(a, outer?): Vector2

每个元素向量取倒数

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2逐元素取倒数得到的 Vector2 对象

接近 0 时返回 Infinity。

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

invertSafe
​

• Static invertSafe(a, outer?, epsilon?): Vector2

每个元素向量取倒数

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null
epsilon? number最小误差数 default:MathUtil.EPSILON
range: 建议传入小于 1 的值。 type:浮点数

Returns ​

Vector2逐元素取倒数得到的 Vector2 对象

接近 0 时返回 0

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

lerp
​

• Static lerp(a, b, t, outer?): Vector2

向量 a 每个元素线性插值： a + t * (b - a)

Parameters ​

a Vector2向量 a
b Vector2向量 b
t number插值
range: [0, 1] type:浮点数
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2线性插值得到的 Vector2 对象

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

magnitude
​

• Static magnitude(a): number

向量长度

Parameters ​

a Vector2向量 a

Returns ​

number向量长度

max
​

• Static max(a, b, outer?): Vector2

取两个向量对应x、y元素最小值最大值

Parameters ​

a Vector2向量 a
b Vector2向量 b
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2逐元素取最大值后的 Vector2 对象

min
​

• Static min(a, b, outer?): Vector2

取两个向量对应x、y元素最小值

Parameters ​

a Vector2向量 a
b Vector2向量 b
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2逐元素取最小值后的 Vector2 对象

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

moveTowards
​

• Static moveTowards(current, target, maxDistanceDelta, outer?): Vector2

向目标移动

Parameters ​

current Vector2当前向量
target Vector2目标向量
maxDistanceDelta number最大移动距离
range: 不限制 type:浮点数
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2移动后的得到的 Vector2 对象

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

multiply
​

• Static multiply(a, b, outer?): Vector2

向量 a 的每个分量乘以标量 b

Parameters ​

a Vector2向量 a
b number数值 b
range: 不限制 type:浮点数
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相乘的结果 Vector2 对象

• Static multiply(a, b, outer?): Vector2

向量 a 乘以向量 b

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: a * b
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,4);
        let result = Vector2.multiply(a,b);
        // X=24, Y=8
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,4);
        let result = Vector2.multiply(a,b);
        // X=24, Y=8
        console.log(result);
     }
}

Parameters ​

a Vector2向量 a
b Vector2向量 b
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相乘的结果 Vector2 对象

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: a * b
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let result = Vector2.multiply(a,3);
        // X=24, Y=6
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let result = Vector2.multiply(a,3);
        // X=24, Y=6
        console.log(result);
     }
}

negate
​

• Static negate(a, outer?): Vector2

每个元素向量取负

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2逐元素向量取负得到的 Vector2 对象

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

normalize
​

• Static normalize(a, outer?): Vector2

向量归一化

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2归一化后得到的 Vector2 对象

project
​

• Static project(a, b, outer?): Vector2

向量 a 在向量 b 上的投影

Parameters ​

a Vector2向量 a
b Vector2向量 b
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2投影向量

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

random
​

• Static random(range?): Vector2

生成一个在单位圆上均匀分布的随机 Vector2 对象

Parameters ​

range? number范围 default:1.0
range: 不限制 type:浮点数

Returns ​

Vector2得到的随机 Vector2 对象

reflect
​

• Static reflect(inDirection, inNormal, outer?): Vector2

反射

Parameters ​

inDirection Vector2入射向量
inNormal Vector2法线向量
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2反射向量

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

rotate
​

• Static rotate(v, radians, outer?): Vector2

向量 a 旋转某度后的向量

Parameters ​

v Vector2向量v
radians number旋转角度
range: 无限制 type:浮点数
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2旋转后的 Vector2 对象

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

round
​

• Static round(a, outer?): Vector2

每个元素四舍五入取整

Parameters ​

a Vector2向量 a
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2逐逐元素向量四舍五入取整后的 Vector2 对象

set
​

• Static set(a, x, y): Vector2

设置向量 a 的值

Parameters ​

a Vector2向量 a
x number修改的 x 值
range: 不限制 type:浮点数
y number修改的 y 值
range: 不限制 type:浮点数

Returns ​

Vector2修改后的 Vector2 对象

Precautions

向量 a 不能为空对象

signAngle
​

• Static signAngle(a, b): number

向量 a 和向量 b 之间的有符号角度

Parameters ​

a Vector2向量 a
b Vector2向量 b

Returns ​

number向量 a 和向量 b 之间的有符号角度

Precautions

有符号角度的取值范围为 (-180, 180], 当前向量可以通过逆时针旋转有符号角度与指定向量同向

sqrMagnitude
​

• Static sqrMagnitude(a): number

向量长度平方

Parameters ​

a Vector2向量 a

Returns ​

number向量长度平方

squaredDistance
​

• Static squaredDistance(a, b): number

两向量的欧氏距离平方

Parameters ​

a Vector2向量 a
b Vector2向量 b

Returns ​

number两向量的欧氏距离平方

strictEquals
​

• Static strictEquals(a, b): boolean

判断两向量是否相等

Parameters ​

a Vector2向量 a
b Vector2向量 b

Returns ​

boolean是否相等

subtract
​

• Static subtract(a, b, outer?): Vector2

向量 a 减去向量 b

outer 为可选参数。作用是：当传入 outer，计算结果会赋值给 outer。（传入的 outer 向量不能为 null/undefined）

使用示例: a - b
ts
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,3);
        let result = Vector2.subtract(a,b);
        // X=5, Y=-1
        console.log(result);
     }
}
@Component
 export default class NewExample extends Script {

     protected onStart(): void {
        let a = new Vector2(8,2);
        let b = new Vector2(3,3);
        let result = Vector2.subtract(a,b);
        // X=5, Y=-1
        console.log(result);
     }
}

Parameters ​

a Vector2向量 a
b Vector2向量 b
outer? Vector2接收结果的 Vector2 对象 default:null

Returns ​

Vector2相减的结果 Vector2 对象