Class PackedVector3Array

A packed array of Vector3s.

PackedVector3Array

Remarks

An array specifically designed to hold Vector3. Packs data tightly, so it saves memory for large array sizes.

Differences between packed arrays, typed arrays, and untyped arrays: Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. PackedVector3Array versus Array[Vector3]). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as Array.map. Typed arrays are in turn faster to iterate on and modify than untyped arrays.

Note: Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use duplicate. This is not the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will not affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again.

Constructors

PackedVector3Array

Constructs an empty PackedVector3Array.

PackedVector3Array PackedVector3Array

PackedVector3Array(PackedVector3Array)

Constructs a PackedVector3Array as a copy of the given PackedVector3Array.

PackedVector3Array PackedVector3Array(PackedVector3Array from)

Parameters

from PackedVector3Array

PackedVector3Array(Array)

Constructs a new PackedVector3Array. Optionally, you can pass in a generic Array that will be converted.

Note: When initializing a PackedVector3Array with elements, it must be initialized with an Array of Vector3 values:

var array = PackedVector3Array([Vector3(12, 34, 56), Vector3(78, 90, 12)])

PackedVector3Array PackedVector3Array(Array from)

Parameters

from Array

Methods

append(Vector3)

Appends an element at the end of the array (alias of PackedVector3Array.push_back).

bool append(Vector3 value)

Parameters

value Vector3

append_array(PackedVector3Array)

Appends a PackedVector3Array at the end of this array.

void append_array(PackedVector3Array array)

Parameters

array PackedVector3Array

bsearch(Vector3, bool)

Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array.

Note: Calling PackedVector3Array.bsearch on an unsorted array results in unexpected behavior.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

int bsearch(Vector3 value, bool before)

Parameters

value Vector3

before bool

clear

Clears the array. This is equivalent to using PackedVector3Array.resize with a size of 0.

void clear

count(Vector3)

Qualifiers: const

Returns the number of times an element is in the array.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

int count(Vector3 value)

Parameters

value Vector3

duplicate

Creates a copy of the array, and returns it.

PackedVector3Array duplicate

fill(Vector3)

Assigns the given value to all elements in the array. This can typically be used together with PackedVector3Array.resize to create an array with a given size and initialized elements.

void fill(Vector3 value)

Parameters

value Vector3

find(Vector3, int)

Qualifiers: const

Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

int find(Vector3 value, int from)

Parameters

value Vector3

from int

get(int)

Qualifiers: const

Returns the Vector3 at the given index in the array. This is the same as using the [] operator (array[index]).

Vector3 get(int index)

Parameters

index int

has(Vector3)

Qualifiers: const

Returns true if the array contains value.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

bool has(Vector3 value)

Parameters

value Vector3

insert(int, Vector3)

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (idx == size()).

int insert(int at_index, Vector3 value)

Parameters

at_index int

value Vector3

is_empty

Qualifiers: const

Returns true if the array is empty.

bool is_empty

push_back(Vector3)

Inserts a Vector3 at the end.

bool push_back(Vector3 value)

Parameters

value Vector3

remove_at(int)

Removes an element from the array by index.

void remove_at(int index)

Parameters

index int

resize(int)

Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling PackedVector3Array.resize once and assigning the new values is faster than adding new elements one by one.

int resize(int new_size)

Parameters

new_size int

reverse

Reverses the order of the elements in the array.

void reverse

rfind(Vector3, int)

Qualifiers: const

Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

int rfind(Vector3 value, int from)

Parameters

value Vector3

from int

set(int, Vector3)

Changes the Vector3 at the given index.

void set(int index, Vector3 value)

Parameters

index int

value Vector3

size

Qualifiers: const

Returns the number of elements in the array.

int size

slice(int, int)

Qualifiers: const

Returns the slice of the PackedVector3Array, from begin (inclusive) to end (exclusive), as a new PackedVector3Array.

The absolute value of begin and end will be clamped to the array size, so the default value for end makes it slice to the size of the array by default (i.e. arr.slice(1) is a shorthand for arr.slice(1, arr.size())).

If either begin or end are negative, they will be relative to the end of the array (i.e. arr.slice(0, -2) is a shorthand for arr.slice(0, arr.size() - 2)).

PackedVector3Array slice(int begin, int end)

Parameters

begin int

end int

sort

Sorts the elements of the array in ascending order.

Note: Vectors with NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.

void sort

to_byte_array

Qualifiers: const

Returns a PackedByteArray with each vector encoded as bytes.

PackedByteArray to_byte_array

Operators

!= (PackedVector3Array)

Returns true if contents of the arrays differ.

bool != (PackedVector3Array right)

Parameters

right PackedVector3Array

* (Transform3D)

Returns a new PackedVector3Array with all vectors in this array inversely transformed (multiplied) by the given Transform3D transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).

array * transform is equivalent to transform.inverse() * array. See inverse.

For transforming by inverse of an affine transformation (e.g. with scaling) transform.affine_inverse() * array can be used instead. See affine_inverse.

PackedVector3Array * (Transform3D right)

Parameters

right Transform3D

+ (PackedVector3Array)

Returns a new PackedVector3Array with contents of right added at the end of this array. For better performance, consider using PackedVector3Array.append_array instead.

PackedVector3Array + (PackedVector3Array right)

Parameters

right PackedVector3Array

== (PackedVector3Array)

Returns true if contents of both arrays are the same, i.e. they have all equal Vector3s at the corresponding indices.

bool == (PackedVector3Array right)

Parameters

right PackedVector3Array

[] (int)

Returns the Vector3 at index index. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error.

Vector3 [] (int index)

Parameters

index int