Vector2i

使用整数坐标的 2D 向量。

描述

包含两个元素的结构体，可用于代表 2D 坐标或任何整数的二元组。

使用整数坐标，因此需要绝对精确时应比 Vector2 优先使用。请注意，取值范围有 32 位的限制，与 Vector2 不同，这个类型的精度无法使用引擎的构建参数进行配置。如果需要 64 位的值，请使用 int 或 PackedInt64Array。

注意：在布尔语境中，如果 Vector2i 等于 Vector2i(0, 0) 则求值结果为 false。否则 Vector2i 的求值结果始终为 true。

教程

• 数学文档索引

• 向量数学

• 3Blue1Brown《线性代数的本质》

属性

构造函数

方法

运算符

常量

AXIS_X = 0 🔗

X 轴的枚举值。由 max_axis_index 和 min_axis_index 返回。

AXIS_Y = 1 🔗

Y 轴的枚举值。由 max_axis_index 和 min_axis_index 返回。

ZERO = Vector2i(0, 0) 🔗

零向量，所有分量都设置为 0 的向量。

ONE = Vector2i(1, 1) 🔗

一向量，所有分量都设置为 1 的向量。

MIN = Vector2i(-2147483648, -2147483648) 🔗

最小向量，所有分量等于 INT32_MIN 的向量。可用作 Vector2.INF 的负整数等价物。

MAX = Vector2i(2147483647, 2147483647) 🔗

最大向量，所有分量等于 INT32_MAX 的向量。可用作 Vector2.INF 的整数等价物。

LEFT = Vector2i(-1, 0) 🔗

左单位向量。代表左的方向。

RIGHT = Vector2i(1, 0) 🔗

右单位向量。代表右的方向。

UP = Vector2i(0, -1) 🔗

上单位向量。在 2D 中 Y 是向下的，所以这个向量指向 -Y。

DOWN = Vector2i(0, 1) 🔗

下单位向量。在 2D 中 Y 是向下的，所以这个向量指向 +Y。

属性说明

int x = 0 🔗

向量的 X 分量。也可以通过使用索引位置 [0] 访问。

int y = 0 🔗

向量的 Y 分量。也可以通过使用索引位置 [1] 访问。

构造函数说明

Vector2i Vector2i() 🔗

构造默认初始化的 Vector2i，所有分量都为 0。

Vector2i Vector2i(from: Vector2i)

构造给定 Vector2i 的副本。

Vector2i Vector2i(from: Vector2)

根据给定的 Vector2 构造 Vector2i，会将各个分量的小数部分截断（向 0 取整）。要使用不同的行为，请考虑改为传入 Vector2.ceil、Vector2.floor 或 Vector2.round 的结果。

Vector2i Vector2i(x: int, y: int)

从给定的 x 和 y 构造新的 Vector2i。

方法说明

Vector2i abs() const 🔗

返回一个新向量，其所有分量都是绝对值，即正值。

float aspect() const 🔗

返回该向量的长宽比，即 x 与 y 的比例。

Vector2i clamp(min: Vector2i, max: Vector2i) const 🔗

返回一个新向量，每个分量都使用 @GlobalScope.clamp 限制在 min 和 max 之间。

Vector2i clampi(min: int, max: int) const 🔗

返回一个新向量，每个分量都使用 @GlobalScope.clamp 限制在 min 和 max 之间。

int distance_squared_to(to: Vector2i) const 🔗

返回该向量与 to 之间的距离的平方。

该方法比 distance_to 运行得更快，因此请在需要比较向量或者用于某些公式的平方距离时，优先使用这个方法。

float distance_to(to: Vector2i) const 🔗

返回该向量与 to 之间的距离。

float length() const 🔗

返回这个向量的长度，即大小。

int length_squared() const 🔗

返回这个向量的平方长度，即平方大小。

这个方法比 length 运行得更快，所以如果你需要比较向量或需要一些公式的平方距离时，更喜欢用它。

Vector2i max(with: Vector2i) const 🔗

返回自身与 with 各分量的最大值，等价于 Vector2i(maxi(x, with.x), maxi(y, with.y))。

int max_axis_index() const 🔗

返回该向量中最大值的轴。见 AXIS_* 常量。如果所有分量相等，则该方法返回 AXIS_X。

Vector2i maxi(with: int) const 🔗

返回自身与 with 各分量的最大值，等价于 Vector2i(maxi(x, with), maxi(y, with))。

Vector2i min(with: Vector2i) const 🔗

返回自身与 with 各分量的最小值，等价于 Vector2i(mini(x, with.x), mini(y, with.y))。

int min_axis_index() const 🔗

返回该向量中最小值的轴。见 AXIS_* 常量。如果所有分量相等，则该方法返回 AXIS_Y。

Vector2i mini(with: int) const 🔗

返回自身与 with 各分量的最小值，等价于 Vector2i(mini(x, with), mini(y, with))。

Vector2i sign() const 🔗

返回一个新的向量，如果是正数，每个分量被设置为1 ，如果是负数，-1 ，如果是零，0 。其结果与对每个分量调用@GlobalScope.sign相同。

Vector2i snapped(step: Vector2i) const 🔗

返回新的向量，每个分量都吸附到了与 step 中对应分量最接近的倍数。

Vector2i snappedi(step: int) const 🔗

返回一个新向量，其中每个分量都吸附到了 step 的最接近倍数。

运算符说明

bool operator !=(right: Vector2i) 🔗

如果向量不相等，则返回 true。

Vector2i operator %(right: Vector2i) 🔗

获取该 Vector2i 的每个分量与给定 Vector2i 中分量的余数。这个运算使用的是截断式除法，因为对负数不友好，所以通常不会想要使用。如果你想要处理负数，请考虑改用 @GlobalScope.posmod。

print(Vector2i(10, -20) % Vector2i(7, 8)) # 输出 "(3, -4)"

Vector2i operator %(right: int) 🔗

获取该 Vector2i 的每个分量与给定的 int 的余数。这个运算使用的是截断式除法，因为对负数不友好，所以通常不会想要使用。如果你想要处理负数，请考虑改用 @GlobalScope.posmod。

print(Vector2i(10, -20) % 7) # 输出 "(3, -6)"

Vector2i operator *(right: Vector2i) 🔗

将该 Vector2i 的每个分量乘以给定 Vector2i 的对应分量。

print(Vector2i(10, 20) * Vector2i(3, 4)) # 输出 "(30, 80)"

Vector2 operator *(right: float) 🔗

将该 Vector2i 的每个分量乘以给定的 float。返回的是 Vector2。

print(Vector2i(10, 15) * 0.9) # 输出 "(9, 13.5)"

Vector2i operator *(right: int) 🔗

将该 Vector2i 的每个分量乘以给定的 int。

Vector2i operator +(right: Vector2i) 🔗

将该 Vector2i 的每个分量加上给定 Vector2i 的对应分量。

print(Vector2i(10, 20) + Vector2i(3, 4)) # 输出 "(13, 24)"

Vector2i operator -(right: Vector2i) 🔗

将该 Vector2i 的每个分量减去给定 Vector2i 的对应分量。

print(Vector2i(10, 20) - Vector2i(3, 4)) # 输出 "(7, 16)"

Vector2i operator /(right: Vector2i) 🔗

将该 Vector2i 的每个分量除以给定 Vector2i 的对应分量。

print(Vector2i(10, 20) / Vector2i(2, 5)) # 输出 "(5, 4)"

Vector2 operator /(right: float) 🔗

将该 Vector2i 的每个分量除以给定的 float。返回的是 Vector2。

print(Vector2i(10, 20) / 2.9) # 输出 "(5, 10)"

Vector2i operator /(right: int) 🔗

将该 Vector2i 的每个分量除以给定的 int。

bool operator <(right: Vector2i) 🔗

比较两个 Vector2i 向量，首先检查左向量的 X 值是否小于 right 向量的 X 值。如果 X 值完全相等，则用相同的方法检查两个向量的 Y 值。该运算符可用于向量排序。

bool operator <=(right: Vector2i) 🔗

比较两个 Vector2i 向量，首先检查左向量的 X 值是否小于等于 right 向量的 X 值。如果 X 值完全相等，则用相同的方法检查两个向量的 Y 值。该运算符可用于向量排序。

bool operator ==(right: Vector2i) 🔗

如果向量相等，则返回 true。

bool operator >(right: Vector2i) 🔗

比较两个 Vector2i 向量，首先检查左向量的 X 值是否大于 right 向量的 X 值。如果 X 值完全相等，则用相同的方法检查两个向量的 Y 值。该运算符可用于向量排序。

bool operator >=(right: Vector2i) 🔗

比较两个 Vector2i 向量，首先检查左向量的 X 值是否大于等于 right 向量的 X 值。如果 X 值完全相等，则用相同的方法检查两个向量的 Y 值。该运算符可用于向量排序。

int operator [](index: int) 🔗

使用向量分量的 index 来访问向量分量。v[0] 等价于 v.x、v[1] 等价于 v.y。

Vector2i operator unary+() 🔗

返回与 + 不存在时相同的值。单目 + 没有作用，但有时可以使你的代码更具可读性。

Vector2i operator unary-() 🔗

返回该 Vector2i 的负值。和写 Vector2i(-v.x, -v.y) 是一样的。该操作在保持相同幅度的同时，翻转向量的方向。