Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
PackedVector3Array¶
Vector3 紧缩数组。
描述¶
专门设计用于存放 Vector3 的数组。数据是紧密存放的,因此能够在数组较大时节省内存。
备注
通过 C# 使用这个 API 时有显著的不同。详见 C# API 与 GDScript 的差异。
构造函数¶
PackedVector3Array ( PackedVector3Array from ) |
|
PackedVector3Array ( Array from ) |
方法¶
void |
append_array ( PackedVector3Array array ) |
void |
clear ( ) |
duplicate ( ) |
|
void |
|
is_empty ( ) const |
|
void |
|
void |
reverse ( ) |
void |
|
size ( ) const |
|
void |
sort ( ) |
to_byte_array ( ) const |
操作符¶
operator != ( PackedVector3Array right ) |
|
operator * ( Transform3D right ) |
|
operator + ( PackedVector3Array right ) |
|
operator == ( PackedVector3Array right ) |
|
operator [] ( int index ) |
构造函数说明¶
PackedVector3Array PackedVector3Array ( )
构造空的 PackedVector3Array。
PackedVector3Array PackedVector3Array ( PackedVector3Array from )
构造给定 PackedVector3Array 的副本。
PackedVector3Array PackedVector3Array ( Array from )
构造新的 PackedVector3Array。也可以传入需要转换的通用 Array。
注意:使用元素初始化 PackedVector3Array 时,必须使用元素为 Vector3 的 Array 进行初始化:
var array = PackedVector3Array([Vector3(12, 34, 56), Vector3(78, 90, 12)])
方法说明¶
向数组末尾追加一个元素(push_back 的别名)。
void append_array ( PackedVector3Array array )
在该数组的末尾追加一个 PackedVector3Array。
int bsearch ( Vector3 value, bool before=true )
使用二分法查找已有值的索引(如果该值尚未存在于数组中,则为保持排序顺序的插入索引)。传递 before
说明符是可选的。如果该参数为 false
,则返回的索引位于数组中该值的所有已有的条目之后。
注意:在未排序的数组上调用 bsearch 会产生预料之外的行为。
注意:包含 @GDScript.NAN 元素的向量的行为与其他向量不同。因此,如果包含 NaN,则这个方法的结果可能不准确。
void clear ( )
清空数组。相当于调用 resize 时指定大小为 0
。
int count ( Vector3 value ) const
返回数组中某个元素出现的次数。
注意:包含 @GDScript.NAN 元素的向量的行为与其他向量不同。因此,如果包含 NaN,则这个方法的结果可能不准确。
PackedVector3Array duplicate ( )
创建该数组的副本,并将该副本返回。
void fill ( Vector3 value )
将数组中的所有元素都设为给定的值。通常与 resize 一起使用,创建给定大小的数组并初始化元素。
int find ( Vector3 value, int from=0 ) const
在数组中搜索值并返回其索引,如果未找到则返回 -1
。可选地,可以传递起始搜索索引。
注意:包含 @GDScript.NAN 元素的向量的行为与其他向量不同。因此,如果包含 NaN,则这个方法的结果可能不准确。
bool has ( Vector3 value ) const
如果数组中包含 value
,则返回 true
。
注意:包含 @GDScript.NAN 元素的向量的行为与其他向量不同。因此,如果包含 NaN,则这个方法的结果可能不准确。
int insert ( int at_index, Vector3 value )
在数组中给定的位置插入一个新元素。这个位置必须是有效的,或者是在数组的末端(idx == size()
)。
bool is_empty ( ) const
该数组为空时,返回 true
。
bool push_back ( Vector3 value )
在末尾插入一个 Vector3。
void remove_at ( int index )
从数组中删除位于索引的元素。
设置数组的大小。如果数组被增大,则保留数组末端的元素。如果数组被缩小,则将数组截断到新的大小。
void reverse ( )
将数组中的元素逆序排列。
int rfind ( Vector3 value, int from=-1 ) const
逆序搜索数组。还可以传递起始搜索位置索引。如果为负,则起始索引被视为相对于数组的结尾。
注意:包含 @GDScript.NAN 元素的向量的行为与其他向量不同。因此,如果包含 NaN,则这个方法的结果可能不准确。
void set ( int index, Vector3 value )
更改给定索引处的 Vector3。
int size ( ) const
返回数组中元素的个数。
PackedVector3Array slice ( int begin, int end=2147483647 ) const
返回该 PackedVector3Array 的切片,是从 begin
(含)到 end
(不含)的全新 PackedVector3Array。
begin
和 end
的绝对值会按数组大小进行限制,所以 end
的默认值会切到数组大小为止(即 arr.slice(1)
是 arr.slice(1, arr.size())
的简写)。
如果 begin
或 end
为负,则表示相对于数组的末尾(即 arr.slice(0, -2)
是 arr.slice(0, arr.size() - 2)
的简写)。
void sort ( )
升序排列数组中的元素。
注意:包含 @GDScript.NAN 元素的向量的行为与其他向量不同。因此,如果包含 NaN,则这个方法的结果可能不准确。
PackedByteArray to_byte_array ( ) const
返回 PackedByteArray,每个向量都被编码为字节。
操作符说明¶
bool operator != ( PackedVector3Array right )
如果数组内容不同,则返回 true
。
PackedVector3Array operator * ( Transform3D right )
返回一个新的 PackedVector3Array,该数组中的所有向量都通过给定的 Transform3D 变换矩阵进行逆变换(乘以),假设该变换的基是正交的(即旋转/反射可以,缩放/倾斜则不然)。
array * transform
相当于 transform.inverse() * array
。请参阅 Transform3D.inverse。
对于通过仿射变换的逆进行变换(例如缩放),可以使用 transform.affine_inverse() * array
代替。请参阅 Transform3D.affine_inverse。
PackedVector3Array operator + ( PackedVector3Array right )
返回新的 PackedVector3Array,新数组的内容为此数组在末尾加上 right
。为了提高性能,请考虑改用 append_array。
bool operator == ( PackedVector3Array right )
如果两个数组的内容相同,即对应索引号的 Vector3 相等,则返回 true
。
Vector3 operator [] ( int index )
返回索引为 index
的 Vector3。负数索引能从末尾开始访问元素。使用数组范围外的索引会导致出错。