PoolVector3Array

A pooled array of Vector3.

Description

An array specifically designed to hold Vector3. Optimized for memory usage, does not fragment the memory.

Note: This type is passed by value and not by reference. This means that when mutating a class property of type PoolVector3Array or mutating a PoolVector3Array within an Array or Dictionary, changes will be lost:

var array = [PoolVector3Array()]
array[0].push_back(Vector3(12, 34, 56))
print(array)  # [[]] (empty PoolVector3Array within an Array)

Instead, the entire PoolVector3Array property must be reassigned with = for it to be changed:

var array = [PoolVector3Array()]
var pool_array = array[0]
pool_array.push_back(Vector3(12, 34, 56))
array[0] = pool_array
print(array)  # [[(12, 34, 56)]] (PoolVector3Array with 1 element inside an Array)

Methods

PoolVector3Array

PoolVector3Array ( Array from )

void

append ( Vector3 vector3 )

void

append_array ( PoolVector3Array array )

int

count ( Vector3 value )

bool

empty ( )

void

fill ( Vector3 vector3 )

int

find ( Vector3 value, int from=0 )

bool

has ( Vector3 value )

int

insert ( int idx, Vector3 vector3 )

void

invert ( )

void

push_back ( Vector3 vector3 )

void

remove ( int idx )

void

resize ( int idx )

int

rfind ( Vector3 value, int from=-1 )

void

set ( int idx, Vector3 vector3 )

int

size ( )

Method Descriptions

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


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


Appends a PoolVector3Array at the end of this array.


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


Returns true if the array is empty.


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


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


Returns true if the array contains the given value.

Note: This is equivalent to using the in operator.


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()).


  • void invert ( )

Reverses the order of the elements in the array.


  • void push_back ( Vector3 vector3 )

Inserts a Vector3 at the end.


  • void remove ( int idx )

Removes an element from the array by index.


  • void resize ( int idx )

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.


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. If the adjusted start index is out of bounds, this method searches from the end of the array.


Changes the Vector3 at the given index.


Returns the number of elements in the array.