class_packedvector3array.rst 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedVector3Array.xml.
  6. .. _class_PackedVector3Array:
  7. PackedVector3Array
  8. ==================
  9. A packed array of :ref:`Vector3<class_Vector3>`\ s.
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. An array specifically designed to hold :ref:`Vector3<class_Vector3>`. Packs data tightly, so it saves memory for large array sizes.
  14. \ **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 :ref:`Array.map()<class_Array_method_map>`. Typed arrays are in turn faster to iterate on and modify than untyped arrays.
  15. \ **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 :ref:`duplicate()<class_PackedVector3Array_method_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.
  16. .. note::
  17. There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.
  18. .. rst-class:: classref-reftable-group
  19. Constructors
  20. ------------
  21. .. table::
  22. :widths: auto
  23. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_constructor_PackedVector3Array>`\ (\ ) |
  25. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_constructor_PackedVector3Array>`\ (\ from\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) |
  27. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_constructor_PackedVector3Array>`\ (\ from\: :ref:`Array<class_Array>`\ ) |
  29. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. .. rst-class:: classref-reftable-group
  31. Methods
  32. -------
  33. .. table::
  34. :widths: auto
  35. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`append<class_PackedVector3Array_method_append>`\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) |
  37. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  38. | |void| | :ref:`append_array<class_PackedVector3Array_method_append_array>`\ (\ array\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) |
  39. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`int<class_int>` | :ref:`bsearch<class_PackedVector3Array_method_bsearch>`\ (\ value\: :ref:`Vector3<class_Vector3>`, before\: :ref:`bool<class_bool>` = true\ ) |
  41. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  42. | |void| | :ref:`clear<class_PackedVector3Array_method_clear>`\ (\ ) |
  43. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`int<class_int>` | :ref:`count<class_PackedVector3Array_method_count>`\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  45. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`duplicate<class_PackedVector3Array_method_duplicate>`\ (\ ) |
  47. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  48. | |void| | :ref:`fill<class_PackedVector3Array_method_fill>`\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) |
  49. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`int<class_int>` | :ref:`find<class_PackedVector3Array_method_find>`\ (\ value\: :ref:`Vector3<class_Vector3>`, from\: :ref:`int<class_int>` = 0\ ) |const| |
  51. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`Vector3<class_Vector3>` | :ref:`get<class_PackedVector3Array_method_get>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  53. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`bool<class_bool>` | :ref:`has<class_PackedVector3Array_method_has>`\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  55. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`int<class_int>` | :ref:`insert<class_PackedVector3Array_method_insert>`\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`Vector3<class_Vector3>`\ ) |
  57. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedVector3Array_method_is_empty>`\ (\ ) |const| |
  59. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`bool<class_bool>` | :ref:`push_back<class_PackedVector3Array_method_push_back>`\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) |
  61. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  62. | |void| | :ref:`remove_at<class_PackedVector3Array_method_remove_at>`\ (\ index\: :ref:`int<class_int>`\ ) |
  63. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`int<class_int>` | :ref:`resize<class_PackedVector3Array_method_resize>`\ (\ new_size\: :ref:`int<class_int>`\ ) |
  65. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  66. | |void| | :ref:`reverse<class_PackedVector3Array_method_reverse>`\ (\ ) |
  67. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`rfind<class_PackedVector3Array_method_rfind>`\ (\ value\: :ref:`Vector3<class_Vector3>`, from\: :ref:`int<class_int>` = -1\ ) |const| |
  69. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  70. | |void| | :ref:`set<class_PackedVector3Array_method_set>`\ (\ index\: :ref:`int<class_int>`, value\: :ref:`Vector3<class_Vector3>`\ ) |
  71. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`size<class_PackedVector3Array_method_size>`\ (\ ) |const| |
  73. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`slice<class_PackedVector3Array_method_slice>`\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| |
  75. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  76. | |void| | :ref:`sort<class_PackedVector3Array_method_sort>`\ (\ ) |
  77. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedVector3Array_method_to_byte_array>`\ (\ ) |const| |
  79. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  80. .. rst-class:: classref-reftable-group
  81. Operators
  82. ---------
  83. .. table::
  84. :widths: auto
  85. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedVector3Array_operator_neq_PackedVector3Array>`\ (\ right\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) |
  87. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`operator *<class_PackedVector3Array_operator_mul_Transform3D>`\ (\ right\: :ref:`Transform3D<class_Transform3D>`\ ) |
  89. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`operator +<class_PackedVector3Array_operator_sum_PackedVector3Array>`\ (\ right\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) |
  91. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedVector3Array_operator_eq_PackedVector3Array>`\ (\ right\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) |
  93. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`Vector3<class_Vector3>` | :ref:`operator []<class_PackedVector3Array_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
  95. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  96. .. rst-class:: classref-section-separator
  97. ----
  98. .. rst-class:: classref-descriptions-group
  99. Constructor Descriptions
  100. ------------------------
  101. .. _class_PackedVector3Array_constructor_PackedVector3Array:
  102. .. rst-class:: classref-constructor
  103. :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array**\ (\ ) :ref:`🔗<class_PackedVector3Array_constructor_PackedVector3Array>`
  104. Constructs an empty **PackedVector3Array**.
  105. .. rst-class:: classref-item-separator
  106. ----
  107. .. rst-class:: classref-constructor
  108. :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array**\ (\ from\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ )
  109. Constructs a **PackedVector3Array** as a copy of the given **PackedVector3Array**.
  110. .. rst-class:: classref-item-separator
  111. ----
  112. .. rst-class:: classref-constructor
  113. :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array**\ (\ from\: :ref:`Array<class_Array>`\ )
  114. Constructs a new **PackedVector3Array**. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
  115. \ **Note:** When initializing a **PackedVector3Array** with elements, it must be initialized with an :ref:`Array<class_Array>` of :ref:`Vector3<class_Vector3>` values:
  116. ::
  117. var array = PackedVector3Array([Vector3(12, 34, 56), Vector3(78, 90, 12)])
  118. .. rst-class:: classref-section-separator
  119. ----
  120. .. rst-class:: classref-descriptions-group
  121. Method Descriptions
  122. -------------------
  123. .. _class_PackedVector3Array_method_append:
  124. .. rst-class:: classref-method
  125. :ref:`bool<class_bool>` **append**\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PackedVector3Array_method_append>`
  126. Appends an element at the end of the array (alias of :ref:`push_back()<class_PackedVector3Array_method_push_back>`).
  127. .. rst-class:: classref-item-separator
  128. ----
  129. .. _class_PackedVector3Array_method_append_array:
  130. .. rst-class:: classref-method
  131. |void| **append_array**\ (\ array\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) :ref:`🔗<class_PackedVector3Array_method_append_array>`
  132. Appends a **PackedVector3Array** at the end of this array.
  133. .. rst-class:: classref-item-separator
  134. ----
  135. .. _class_PackedVector3Array_method_bsearch:
  136. .. rst-class:: classref-method
  137. :ref:`int<class_int>` **bsearch**\ (\ value\: :ref:`Vector3<class_Vector3>`, before\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_PackedVector3Array_method_bsearch>`
  138. 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.
  139. \ **Note:** Calling :ref:`bsearch()<class_PackedVector3Array_method_bsearch>` on an unsorted array results in unexpected behavior.
  140. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
  141. .. rst-class:: classref-item-separator
  142. ----
  143. .. _class_PackedVector3Array_method_clear:
  144. .. rst-class:: classref-method
  145. |void| **clear**\ (\ ) :ref:`🔗<class_PackedVector3Array_method_clear>`
  146. Clears the array. This is equivalent to using :ref:`resize()<class_PackedVector3Array_method_resize>` with a size of ``0``.
  147. .. rst-class:: classref-item-separator
  148. ----
  149. .. _class_PackedVector3Array_method_count:
  150. .. rst-class:: classref-method
  151. :ref:`int<class_int>` **count**\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`🔗<class_PackedVector3Array_method_count>`
  152. Returns the number of times an element is in the array.
  153. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
  154. .. rst-class:: classref-item-separator
  155. ----
  156. .. _class_PackedVector3Array_method_duplicate:
  157. .. rst-class:: classref-method
  158. :ref:`PackedVector3Array<class_PackedVector3Array>` **duplicate**\ (\ ) :ref:`🔗<class_PackedVector3Array_method_duplicate>`
  159. Creates a copy of the array, and returns it.
  160. .. rst-class:: classref-item-separator
  161. ----
  162. .. _class_PackedVector3Array_method_fill:
  163. .. rst-class:: classref-method
  164. |void| **fill**\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PackedVector3Array_method_fill>`
  165. Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize()<class_PackedVector3Array_method_resize>` to create an array with a given size and initialized elements.
  166. .. rst-class:: classref-item-separator
  167. ----
  168. .. _class_PackedVector3Array_method_find:
  169. .. rst-class:: classref-method
  170. :ref:`int<class_int>` **find**\ (\ value\: :ref:`Vector3<class_Vector3>`, from\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_PackedVector3Array_method_find>`
  171. Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed.
  172. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
  173. .. rst-class:: classref-item-separator
  174. ----
  175. .. _class_PackedVector3Array_method_get:
  176. .. rst-class:: classref-method
  177. :ref:`Vector3<class_Vector3>` **get**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PackedVector3Array_method_get>`
  178. Returns the :ref:`Vector3<class_Vector3>` at the given ``index`` in the array. This is the same as using the ``[]`` operator (``array[index]``).
  179. .. rst-class:: classref-item-separator
  180. ----
  181. .. _class_PackedVector3Array_method_has:
  182. .. rst-class:: classref-method
  183. :ref:`bool<class_bool>` **has**\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`🔗<class_PackedVector3Array_method_has>`
  184. Returns ``true`` if the array contains ``value``.
  185. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
  186. .. rst-class:: classref-item-separator
  187. ----
  188. .. _class_PackedVector3Array_method_insert:
  189. .. rst-class:: classref-method
  190. :ref:`int<class_int>` **insert**\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PackedVector3Array_method_insert>`
  191. 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()``).
  192. .. rst-class:: classref-item-separator
  193. ----
  194. .. _class_PackedVector3Array_method_is_empty:
  195. .. rst-class:: classref-method
  196. :ref:`bool<class_bool>` **is_empty**\ (\ ) |const| :ref:`🔗<class_PackedVector3Array_method_is_empty>`
  197. Returns ``true`` if the array is empty.
  198. .. rst-class:: classref-item-separator
  199. ----
  200. .. _class_PackedVector3Array_method_push_back:
  201. .. rst-class:: classref-method
  202. :ref:`bool<class_bool>` **push_back**\ (\ value\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PackedVector3Array_method_push_back>`
  203. Inserts a :ref:`Vector3<class_Vector3>` at the end.
  204. .. rst-class:: classref-item-separator
  205. ----
  206. .. _class_PackedVector3Array_method_remove_at:
  207. .. rst-class:: classref-method
  208. |void| **remove_at**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedVector3Array_method_remove_at>`
  209. Removes an element from the array by index.
  210. .. rst-class:: classref-item-separator
  211. ----
  212. .. _class_PackedVector3Array_method_resize:
  213. .. rst-class:: classref-method
  214. :ref:`int<class_int>` **resize**\ (\ new_size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedVector3Array_method_resize>`
  215. 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 :ref:`resize()<class_PackedVector3Array_method_resize>` once and assigning the new values is faster than adding new elements one by one.
  216. .. rst-class:: classref-item-separator
  217. ----
  218. .. _class_PackedVector3Array_method_reverse:
  219. .. rst-class:: classref-method
  220. |void| **reverse**\ (\ ) :ref:`🔗<class_PackedVector3Array_method_reverse>`
  221. Reverses the order of the elements in the array.
  222. .. rst-class:: classref-item-separator
  223. ----
  224. .. _class_PackedVector3Array_method_rfind:
  225. .. rst-class:: classref-method
  226. :ref:`int<class_int>` **rfind**\ (\ value\: :ref:`Vector3<class_Vector3>`, from\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_PackedVector3Array_method_rfind>`
  227. 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.
  228. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
  229. .. rst-class:: classref-item-separator
  230. ----
  231. .. _class_PackedVector3Array_method_set:
  232. .. rst-class:: classref-method
  233. |void| **set**\ (\ index\: :ref:`int<class_int>`, value\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_PackedVector3Array_method_set>`
  234. Changes the :ref:`Vector3<class_Vector3>` at the given index.
  235. .. rst-class:: classref-item-separator
  236. ----
  237. .. _class_PackedVector3Array_method_size:
  238. .. rst-class:: classref-method
  239. :ref:`int<class_int>` **size**\ (\ ) |const| :ref:`🔗<class_PackedVector3Array_method_size>`
  240. Returns the number of elements in the array.
  241. .. rst-class:: classref-item-separator
  242. ----
  243. .. _class_PackedVector3Array_method_slice:
  244. .. rst-class:: classref-method
  245. :ref:`PackedVector3Array<class_PackedVector3Array>` **slice**\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| :ref:`🔗<class_PackedVector3Array_method_slice>`
  246. Returns the slice of the **PackedVector3Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedVector3Array**.
  247. 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())``).
  248. 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)``).
  249. .. rst-class:: classref-item-separator
  250. ----
  251. .. _class_PackedVector3Array_method_sort:
  252. .. rst-class:: classref-method
  253. |void| **sort**\ (\ ) :ref:`🔗<class_PackedVector3Array_method_sort>`
  254. Sorts the elements of the array in ascending order.
  255. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
  256. .. rst-class:: classref-item-separator
  257. ----
  258. .. _class_PackedVector3Array_method_to_byte_array:
  259. .. rst-class:: classref-method
  260. :ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array**\ (\ ) |const| :ref:`🔗<class_PackedVector3Array_method_to_byte_array>`
  261. Returns a :ref:`PackedByteArray<class_PackedByteArray>` with each vector encoded as bytes.
  262. .. rst-class:: classref-section-separator
  263. ----
  264. .. rst-class:: classref-descriptions-group
  265. Operator Descriptions
  266. ---------------------
  267. .. _class_PackedVector3Array_operator_neq_PackedVector3Array:
  268. .. rst-class:: classref-operator
  269. :ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) :ref:`🔗<class_PackedVector3Array_operator_neq_PackedVector3Array>`
  270. Returns ``true`` if contents of the arrays differ.
  271. .. rst-class:: classref-item-separator
  272. ----
  273. .. _class_PackedVector3Array_operator_mul_Transform3D:
  274. .. rst-class:: classref-operator
  275. :ref:`PackedVector3Array<class_PackedVector3Array>` **operator ***\ (\ right\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_PackedVector3Array_operator_mul_Transform3D>`
  276. Returns a new **PackedVector3Array** with all vectors in this array inversely transformed (multiplied) by the given :ref:`Transform3D<class_Transform3D>` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).
  277. \ ``array * transform`` is equivalent to ``transform.inverse() * array``. See :ref:`Transform3D.inverse()<class_Transform3D_method_inverse>`.
  278. For transforming by inverse of an affine transformation (e.g. with scaling) ``transform.affine_inverse() * array`` can be used instead. See :ref:`Transform3D.affine_inverse()<class_Transform3D_method_affine_inverse>`.
  279. .. rst-class:: classref-item-separator
  280. ----
  281. .. _class_PackedVector3Array_operator_sum_PackedVector3Array:
  282. .. rst-class:: classref-operator
  283. :ref:`PackedVector3Array<class_PackedVector3Array>` **operator +**\ (\ right\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) :ref:`🔗<class_PackedVector3Array_operator_sum_PackedVector3Array>`
  284. Returns a new **PackedVector3Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array()<class_PackedVector3Array_method_append_array>` instead.
  285. .. rst-class:: classref-item-separator
  286. ----
  287. .. _class_PackedVector3Array_operator_eq_PackedVector3Array:
  288. .. rst-class:: classref-operator
  289. :ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) :ref:`🔗<class_PackedVector3Array_operator_eq_PackedVector3Array>`
  290. Returns ``true`` if contents of both arrays are the same, i.e. they have all equal :ref:`Vector3<class_Vector3>`\ s at the corresponding indices.
  291. .. rst-class:: classref-item-separator
  292. ----
  293. .. _class_PackedVector3Array_operator_idx_int:
  294. .. rst-class:: classref-operator
  295. :ref:`Vector3<class_Vector3>` **operator []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedVector3Array_operator_idx_int>`
  296. Returns the :ref:`Vector3<class_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.
  297. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  298. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  299. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  300. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  301. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  302. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  303. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  304. .. |void| replace:: :abbr:`void (No return value.)`