PackedVector3Array

A packed Array of Vector3s.

Description

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

Constructors

PackedVector3Array	PackedVector3Array ( )
PackedVector3Array	PackedVector3Array ( PackedVector3Array from )
PackedVector3Array	PackedVector3Array ( Array from )

Methods

bool	append ( Vector3 value )
void	append_array ( PackedVector3Array array )
int	bsearch ( Vector3 value, bool before=true )
PackedVector3Array	duplicate ( )
void	fill ( Vector3 value )
bool	has ( Vector3 value ) const
int	insert ( int at_index, Vector3 value )
bool	is_empty ( ) const
bool	push_back ( Vector3 value )
void	remove ( int index )
int	resize ( int new_size )
void	reverse ( )
void	set ( int index, Vector3 value )
int	size ( ) const
void	sort ( )
PackedVector3Array	subarray ( int from, int to ) const
PackedByteArray	to_byte_array ( ) const

Operators

bool	operator != ( )
bool	operator != ( PackedVector3Array right )
PackedVector3Array	operator * ( Transform3D right )
PackedVector3Array	operator + ( PackedVector3Array right )
bool	operator == ( )
bool	operator == ( PackedVector3Array right )
Vector3	operator [] ( int index )

Constructor Descriptions

• PackedVector3Array PackedVector3Array ( )

Constructs an empty PackedVector3Array.

---

• PackedVector3Array PackedVector3Array ( PackedVector3Array from )

Constructs a PackedVector3Array as a copy of the given PackedVector3Array.

---

• PackedVector3Array PackedVector3Array ( Array from )

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

Method Descriptions

• bool append ( Vector3 value )

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

---

• void append_array ( PackedVector3Array array )

Appends a PackedVector3Array at the end of this array.

---

• int bsearch ( Vector3 value, bool before=true )

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 bsearch on an unsorted array results in unexpected behavior.

---

• PackedVector3Array duplicate ( )

Creates a copy of the array, and returns it.

---

• void fill ( Vector3 value )

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.

---

• bool has ( Vector3 value ) const

Returns true if the array contains value.

---

• int insert ( int at_index, Vector3 value )

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

---

• bool is_empty ( ) const

Returns true if the array is empty.

---

• bool push_back ( Vector3 value )

Inserts a Vector3 at the end.

---

• void remove ( int index )

Removes an element from the array by index.

---

• int resize ( int new_size )

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.

---

• void reverse ( )

Reverses the order of the elements in the array.

---

• void set ( int index, Vector3 value )

Changes the Vector3 at the given index.

---

• int size ( ) const

Returns the size of the array.

---

• void sort ( )

Sorts the elements of the array in ascending order.

---

• PackedVector3Array subarray ( int from, int to ) const

---

• PackedByteArray to_byte_array ( ) const

Operator Descriptions

• bool operator != ( )

---

• bool operator != ( PackedVector3Array right )

---

• PackedVector3Array operator * ( Transform3D right )

---

• PackedVector3Array operator + ( PackedVector3Array right )

---

• bool operator == ( )

---

• bool operator == ( PackedVector3Array right )

---

• Vector3 operator [] ( int index )