Vector2i¶
使用整数坐标的2D向量。
描述¶
可用于表示2D网格坐标或任何其他整数对的2元素结构。
它使用整数坐标,因此在需要精确精度时比Vector2更可取。请注意,值限制为32位,与Vector2不同,这不能配置为引擎构建选项。如果需要64位值,请使用int或PackedInt64Array。
注意:在布尔上下文中,如果Vector2i等于Vector2i(0,0),则Vector2i将评估为false。否则,Vector2i将始终评估为true。
属性¶
构造函数¶
方法¶
abs() const |
|
aspect() const |
|
distance_squared_to(to: Vector2i) const |
|
distance_to(to: Vector2i) const |
|
length() const |
|
length_squared() const |
|
max_axis_index() const |
|
min_axis_index() const |
|
sign() const |
|
运算符¶
operator !=(right: Vector2i) |
|
operator %(right: Vector2i) |
|
operator %(right: int) |
|
operator *(right: Vector2i) |
|
operator *(right: float) |
|
operator *(right: int) |
|
operator +(right: Vector2i) |
|
operator -(right: Vector2i) |
|
operator /(right: Vector2i) |
|
operator /(right: float) |
|
operator /(right: int) |
|
operator <(right: Vector2i) |
|
operator <=(right: Vector2i) |
|
operator ==(right: Vector2i) |
|
operator >(right: Vector2i) |
|
operator >=(right: Vector2i) |
|
operator [](index: int) |
|
枚举¶
enum Axis: 🔗
Axis AXIS_X = 0
X轴的枚举值。由max_axis_index()和min_axis_index()返回。
Axis AXIS_Y = 1
Y轴的枚举值。由max_axis_index()和min_axis_index()返回。
常量¶
ZERO = Vector2i(0, 0) 🔗
零向量,所有分量都设置为0的向量。
ONE = Vector2i(1, 1) 🔗
一个向量,所有分量都设置为1的向量。
MIN = Vector2i(-2147483648, -2147483648) 🔗
min向量,所有分量等于INT32_MIN的向量。可以用作Vector2.INF的负整数等价物。
MAX = Vector2i(2147483647, 2147483647) 🔗
最大向量,所有分量等于INT32_MAX的向量。可以用作Vector2.INF的整数等价物。
LEFT = Vector2i(-1, 0) 🔗
左单位向量。表示左的方向。
RIGHT = Vector2i(1, 0) 🔗
右单位向量。表示右方向。
UP = Vector2i(0, -1) 🔗
向上单位向量。Y在2D中向下,所以这个向量指向-Y。
DOWN = Vector2i(0, 1) 🔗
向下单位向量。Y在2D中向下,所以这个向量指向+Y。
属性说明¶
向量的X分量。也可以使用索引位置[0]访问。
向量的Y分量。也可以使用索引位置[1]访问。
构造函数说明¶
构造一个默认初始化的Vector2i,所有组件都设置为0。
Vector2i Vector2i(from: Vector2i)
构造一个Vector2i作为给定Vector2i的副本。
Vector2i Vector2i(from: Vector2)
通过截断组件的小数部分(四舍五入为零)从给定的Vector2构造一个新的Vector2i。对于不同的行为,请考虑将Vector2.ceil()、Vector2.floor()或Vector2.round()的结果传递给此构造函数。
Vector2i Vector2i(x: int, y: int)
根据给定的x和y构造一个新的Vector2i。
方法说明¶
返回一个新向量,其中所有分量都为绝对值(即正)。
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之间的距离。
返回此向量的长度(大小)。
返回此向量的平方长度(平方幅度)。
此方法比length()运行得更快,因此如果您需要比较向量或需要某些公式的平方距离,则更喜欢它。
Vector2i max(with: Vector2i) const 🔗
返回this和with的组件最大值,相当于Vector2i(maxi(x, with.x),maxi(y,with.y))。
返回向量最高值的轴。请参见AXIS_*常量。如果所有分量相等,则此方法返回AXIS_X。
Vector2i maxi(with: int) const 🔗
返回this和with的组件最大值,相当于Vector2i(maxi(x, with),maxi(y,with))。
Vector2i min(with: Vector2i) const 🔗
返回this和with的组件最小值,相当于Vector2i(mini(x, with.x),mini(y,with.y))。
返回向量最低值的轴。请参见AXIS_*常量。如果所有分量相等,则此方法返回AXIS_Y。
Vector2i mini(with: int) const 🔗
返回this和with的组件最小值,相当于Vector2i(mini(x, with),mini(y,with))。
返回一个新向量,如果每个组件为正,则将每个组件设置为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)) # Prints (3, -4)
Vector2i operator %(right: int) 🔗
获取 Vector2i 的每个分量与给定 int 的余数。此操作使用截断除法,这通常不是理想的选择,因为它对负数处理不佳。如果你想处理负数,考虑使用 @GlobalScope.posmod() 代替。
print(Vector2i(10, -20) % 7) # Prints (3, -6)
Vector2i operator *(right: Vector2i) 🔗
将 Vector2i 的每个分量与给定的 Vector2i 的分量相乘。
print(Vector2i(10, 20) * Vector2i(3, 4)) # Prints (30, 80)
Vector2 operator *(right: float) 🔗
将 Vector2i 的每个分量与给定的 float 相乘。返回一个 Vector2。
print(Vector2i(10, 15) * 0.9) # Prints (9.0, 13.5)
Vector2i operator *(right: int) 🔗
将Vector2i的每个组件乘以给定的int。
Vector2i operator +(right: Vector2i) 🔗
将 Vector2i 的每个分量与给定的 Vector2i 的分量相加。
print(Vector2i(10, 20) + Vector2i(3, 4)) # Prints (13, 24)
Vector2i operator -(right: Vector2i) 🔗
从 Vector2i 的每个分量中减去给定 Vector2i 的分量。
print(Vector2i(10, 20) - Vector2i(3, 4)) # Prints (7, 16)
Vector2i operator /(right: Vector2i) 🔗
将 Vector2i 的每个分量除以给定 Vector2i 的分量。
print(Vector2i(10, 20) / Vector2i(2, 5)) # Prints (5, 4)
Vector2 operator /(right: float) 🔗
将 Vector2i 的每个分量除以给定的 float。返回一个 Vector2。
print(Vector2i(10, 20) / 2.9) # Prints (5.0, 10.0)
Vector2i operator /(right: int) 🔗
将Vector2i的每个组件除以给定的int。
bool operator <(right: Vector2i) 🔗
通过首先检查左向量的X值是否小于right向量的X值来比较两个Vector2i向量。如果X值完全相等,则它使用两个向量的Y值重复此检查。此运算符对于排序向量很有用。
bool operator <=(right: Vector2i) 🔗
通过首先检查左向量的X值是否小于或等于right向量的X值来比较两个Vector2i向量。如果X值完全相等,则它使用两个向量的Y值重复此检查。此运算符对于排序向量很有用。
bool operator ==(right: Vector2i) 🔗
如果向量相等,则返回true。
bool operator >(right: Vector2i) 🔗
通过首先检查左向量的X值是否大于right向量的X值来比较两个Vector2i向量。如果X值完全相等,则它使用两个向量的Y值重复此检查。此运算符对于排序向量很有用。
bool operator >=(right: Vector2i) 🔗
通过首先检查左向量的X值是否大于或等于right向量的X值来比较两个Vector2i向量。如果X值完全相等,则它使用两个向量的Y值重复此检查。此运算符对于排序向量很有用。
使用它们的index访问向量组件。v[0]等价于v. x,v[1]等价于v.y。
返回与+不存在相同的值。一元+什么也不做,但有时它可以使您的代码更具可读性。
返回Vector2i的负值。这与编写Vector2i(-v. x,-v.y)相同。此操作在保持相同大小的同时翻转向量的方向。