class_vector4.rst 62 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019
  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/Vector4.xml.
  6. .. _class_Vector4:
  7. Vector4
  8. =======
  9. A 4D vector using floating-point coordinates.
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. A 4-element structure that can be used to represent 4D coordinates or any other quadruplet of numeric values.
  14. It uses floating-point coordinates. By default, these floating-point values use 32-bit precision, unlike :ref:`float<class_float>` which is always 64-bit. If double precision is needed, compile the engine with the option ``precision=double``.
  15. See :ref:`Vector4i<class_Vector4i>` for its integer counterpart.
  16. \ **Note:** In a boolean context, a Vector4 will evaluate to ``false`` if it's equal to ``Vector4(0, 0, 0, 0)``. Otherwise, a Vector4 will always evaluate to ``true``.
  17. .. rst-class:: classref-reftable-group
  18. Properties
  19. ----------
  20. .. table::
  21. :widths: auto
  22. +---------------------------+------------------------------------+---------+
  23. | :ref:`float<class_float>` | :ref:`w<class_Vector4_property_w>` | ``0.0`` |
  24. +---------------------------+------------------------------------+---------+
  25. | :ref:`float<class_float>` | :ref:`x<class_Vector4_property_x>` | ``0.0`` |
  26. +---------------------------+------------------------------------+---------+
  27. | :ref:`float<class_float>` | :ref:`y<class_Vector4_property_y>` | ``0.0`` |
  28. +---------------------------+------------------------------------+---------+
  29. | :ref:`float<class_float>` | :ref:`z<class_Vector4_property_z>` | ``0.0`` |
  30. +---------------------------+------------------------------------+---------+
  31. .. rst-class:: classref-reftable-group
  32. Constructors
  33. ------------
  34. .. table::
  35. :widths: auto
  36. +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`Vector4<class_Vector4>` | :ref:`Vector4<class_Vector4_constructor_Vector4>`\ (\ ) |
  38. +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`Vector4<class_Vector4>` | :ref:`Vector4<class_Vector4_constructor_Vector4>`\ (\ from\: :ref:`Vector4<class_Vector4>`\ ) |
  40. +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`Vector4<class_Vector4>` | :ref:`Vector4<class_Vector4_constructor_Vector4>`\ (\ from\: :ref:`Vector4i<class_Vector4i>`\ ) |
  42. +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`Vector4<class_Vector4>` | :ref:`Vector4<class_Vector4_constructor_Vector4>`\ (\ x\: :ref:`float<class_float>`, y\: :ref:`float<class_float>`, z\: :ref:`float<class_float>`, w\: :ref:`float<class_float>`\ ) |
  44. +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. .. rst-class:: classref-reftable-group
  46. Methods
  47. -------
  48. .. table::
  49. :widths: auto
  50. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`Vector4<class_Vector4>` | :ref:`abs<class_Vector4_method_abs>`\ (\ ) |const| |
  52. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`Vector4<class_Vector4>` | :ref:`ceil<class_Vector4_method_ceil>`\ (\ ) |const| |
  54. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`Vector4<class_Vector4>` | :ref:`clamp<class_Vector4_method_clamp>`\ (\ min\: :ref:`Vector4<class_Vector4>`, max\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  56. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`Vector4<class_Vector4>` | :ref:`clampf<class_Vector4_method_clampf>`\ (\ min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) |const| |
  58. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`Vector4<class_Vector4>` | :ref:`cubic_interpolate<class_Vector4_method_cubic_interpolate>`\ (\ b\: :ref:`Vector4<class_Vector4>`, pre_a\: :ref:`Vector4<class_Vector4>`, post_b\: :ref:`Vector4<class_Vector4>`, weight\: :ref:`float<class_float>`\ ) |const| |
  60. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`Vector4<class_Vector4>` | :ref:`cubic_interpolate_in_time<class_Vector4_method_cubic_interpolate_in_time>`\ (\ b\: :ref:`Vector4<class_Vector4>`, pre_a\: :ref:`Vector4<class_Vector4>`, post_b\: :ref:`Vector4<class_Vector4>`, weight\: :ref:`float<class_float>`, b_t\: :ref:`float<class_float>`, pre_a_t\: :ref:`float<class_float>`, post_b_t\: :ref:`float<class_float>`\ ) |const| |
  62. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`Vector4<class_Vector4>` | :ref:`direction_to<class_Vector4_method_direction_to>`\ (\ to\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  64. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`float<class_float>` | :ref:`distance_squared_to<class_Vector4_method_distance_squared_to>`\ (\ to\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  66. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`float<class_float>` | :ref:`distance_to<class_Vector4_method_distance_to>`\ (\ to\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  68. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`float<class_float>` | :ref:`dot<class_Vector4_method_dot>`\ (\ with\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  70. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`Vector4<class_Vector4>` | :ref:`floor<class_Vector4_method_floor>`\ (\ ) |const| |
  72. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`Vector4<class_Vector4>` | :ref:`inverse<class_Vector4_method_inverse>`\ (\ ) |const| |
  74. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Vector4_method_is_equal_approx>`\ (\ to\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  76. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`bool<class_bool>` | :ref:`is_finite<class_Vector4_method_is_finite>`\ (\ ) |const| |
  78. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`bool<class_bool>` | :ref:`is_normalized<class_Vector4_method_is_normalized>`\ (\ ) |const| |
  80. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`bool<class_bool>` | :ref:`is_zero_approx<class_Vector4_method_is_zero_approx>`\ (\ ) |const| |
  82. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`float<class_float>` | :ref:`length<class_Vector4_method_length>`\ (\ ) |const| |
  84. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`float<class_float>` | :ref:`length_squared<class_Vector4_method_length_squared>`\ (\ ) |const| |
  86. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`Vector4<class_Vector4>` | :ref:`lerp<class_Vector4_method_lerp>`\ (\ to\: :ref:`Vector4<class_Vector4>`, weight\: :ref:`float<class_float>`\ ) |const| |
  88. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`Vector4<class_Vector4>` | :ref:`max<class_Vector4_method_max>`\ (\ with\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  90. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`int<class_int>` | :ref:`max_axis_index<class_Vector4_method_max_axis_index>`\ (\ ) |const| |
  92. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`Vector4<class_Vector4>` | :ref:`maxf<class_Vector4_method_maxf>`\ (\ with\: :ref:`float<class_float>`\ ) |const| |
  94. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`Vector4<class_Vector4>` | :ref:`min<class_Vector4_method_min>`\ (\ with\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  96. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`int<class_int>` | :ref:`min_axis_index<class_Vector4_method_min_axis_index>`\ (\ ) |const| |
  98. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`Vector4<class_Vector4>` | :ref:`minf<class_Vector4_method_minf>`\ (\ with\: :ref:`float<class_float>`\ ) |const| |
  100. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`Vector4<class_Vector4>` | :ref:`normalized<class_Vector4_method_normalized>`\ (\ ) |const| |
  102. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`Vector4<class_Vector4>` | :ref:`posmod<class_Vector4_method_posmod>`\ (\ mod\: :ref:`float<class_float>`\ ) |const| |
  104. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`Vector4<class_Vector4>` | :ref:`posmodv<class_Vector4_method_posmodv>`\ (\ modv\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  106. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`Vector4<class_Vector4>` | :ref:`round<class_Vector4_method_round>`\ (\ ) |const| |
  108. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`Vector4<class_Vector4>` | :ref:`sign<class_Vector4_method_sign>`\ (\ ) |const| |
  110. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`Vector4<class_Vector4>` | :ref:`snapped<class_Vector4_method_snapped>`\ (\ step\: :ref:`Vector4<class_Vector4>`\ ) |const| |
  112. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`Vector4<class_Vector4>` | :ref:`snappedf<class_Vector4_method_snappedf>`\ (\ step\: :ref:`float<class_float>`\ ) |const| |
  114. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. .. rst-class:: classref-reftable-group
  116. Operators
  117. ---------
  118. .. table::
  119. :widths: auto
  120. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  121. | :ref:`bool<class_bool>` | :ref:`operator !=<class_Vector4_operator_neq_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  122. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  123. | :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_Vector4_operator_mul_Projection>`\ (\ right\: :ref:`Projection<class_Projection>`\ ) |
  124. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  125. | :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_Vector4_operator_mul_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  126. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_Vector4_operator_mul_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
  128. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  129. | :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_Vector4_operator_mul_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
  130. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  131. | :ref:`Vector4<class_Vector4>` | :ref:`operator +<class_Vector4_operator_sum_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  132. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  133. | :ref:`Vector4<class_Vector4>` | :ref:`operator -<class_Vector4_operator_dif_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  134. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  135. | :ref:`Vector4<class_Vector4>` | :ref:`operator /<class_Vector4_operator_div_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  136. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  137. | :ref:`Vector4<class_Vector4>` | :ref:`operator /<class_Vector4_operator_div_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
  138. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  139. | :ref:`Vector4<class_Vector4>` | :ref:`operator /<class_Vector4_operator_div_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
  140. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  141. | :ref:`bool<class_bool>` | :ref:`operator \<<class_Vector4_operator_lt_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  142. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  143. | :ref:`bool<class_bool>` | :ref:`operator \<=<class_Vector4_operator_lte_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  144. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  145. | :ref:`bool<class_bool>` | :ref:`operator ==<class_Vector4_operator_eq_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  146. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  147. | :ref:`bool<class_bool>` | :ref:`operator ><class_Vector4_operator_gt_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  148. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  149. | :ref:`bool<class_bool>` | :ref:`operator >=<class_Vector4_operator_gte_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
  150. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  151. | :ref:`float<class_float>` | :ref:`operator []<class_Vector4_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
  152. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  153. | :ref:`Vector4<class_Vector4>` | :ref:`operator unary+<class_Vector4_operator_unplus>`\ (\ ) |
  154. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  155. | :ref:`Vector4<class_Vector4>` | :ref:`operator unary-<class_Vector4_operator_unminus>`\ (\ ) |
  156. +-------------------------------+-------------------------------------------------------------------------------------------------------------+
  157. .. rst-class:: classref-section-separator
  158. ----
  159. .. rst-class:: classref-descriptions-group
  160. Constants
  161. ---------
  162. .. _class_Vector4_constant_AXIS_X:
  163. .. rst-class:: classref-constant
  164. **AXIS_X** = ``0`` :ref:`🔗<class_Vector4_constant_AXIS_X>`
  165. Enumerated value for the X axis. Returned by :ref:`max_axis_index<class_Vector4_method_max_axis_index>` and :ref:`min_axis_index<class_Vector4_method_min_axis_index>`.
  166. .. _class_Vector4_constant_AXIS_Y:
  167. .. rst-class:: classref-constant
  168. **AXIS_Y** = ``1`` :ref:`🔗<class_Vector4_constant_AXIS_Y>`
  169. Enumerated value for the Y axis. Returned by :ref:`max_axis_index<class_Vector4_method_max_axis_index>` and :ref:`min_axis_index<class_Vector4_method_min_axis_index>`.
  170. .. _class_Vector4_constant_AXIS_Z:
  171. .. rst-class:: classref-constant
  172. **AXIS_Z** = ``2`` :ref:`🔗<class_Vector4_constant_AXIS_Z>`
  173. Enumerated value for the Z axis. Returned by :ref:`max_axis_index<class_Vector4_method_max_axis_index>` and :ref:`min_axis_index<class_Vector4_method_min_axis_index>`.
  174. .. _class_Vector4_constant_AXIS_W:
  175. .. rst-class:: classref-constant
  176. **AXIS_W** = ``3`` :ref:`🔗<class_Vector4_constant_AXIS_W>`
  177. Enumerated value for the W axis. Returned by :ref:`max_axis_index<class_Vector4_method_max_axis_index>` and :ref:`min_axis_index<class_Vector4_method_min_axis_index>`.
  178. .. _class_Vector4_constant_ZERO:
  179. .. rst-class:: classref-constant
  180. **ZERO** = ``Vector4(0, 0, 0, 0)`` :ref:`🔗<class_Vector4_constant_ZERO>`
  181. Zero vector, a vector with all components set to ``0``.
  182. .. _class_Vector4_constant_ONE:
  183. .. rst-class:: classref-constant
  184. **ONE** = ``Vector4(1, 1, 1, 1)`` :ref:`🔗<class_Vector4_constant_ONE>`
  185. One vector, a vector with all components set to ``1``.
  186. .. _class_Vector4_constant_INF:
  187. .. rst-class:: classref-constant
  188. **INF** = ``Vector4(inf, inf, inf, inf)`` :ref:`🔗<class_Vector4_constant_INF>`
  189. Infinity vector, a vector with all components set to :ref:`@GDScript.INF<class_@GDScript_constant_INF>`.
  190. .. rst-class:: classref-section-separator
  191. ----
  192. .. rst-class:: classref-descriptions-group
  193. Property Descriptions
  194. ---------------------
  195. .. _class_Vector4_property_w:
  196. .. rst-class:: classref-property
  197. :ref:`float<class_float>` **w** = ``0.0`` :ref:`🔗<class_Vector4_property_w>`
  198. The vector's W component. Also accessible by using the index position ``[3]``.
  199. .. rst-class:: classref-item-separator
  200. ----
  201. .. _class_Vector4_property_x:
  202. .. rst-class:: classref-property
  203. :ref:`float<class_float>` **x** = ``0.0`` :ref:`🔗<class_Vector4_property_x>`
  204. The vector's X component. Also accessible by using the index position ``[0]``.
  205. .. rst-class:: classref-item-separator
  206. ----
  207. .. _class_Vector4_property_y:
  208. .. rst-class:: classref-property
  209. :ref:`float<class_float>` **y** = ``0.0`` :ref:`🔗<class_Vector4_property_y>`
  210. The vector's Y component. Also accessible by using the index position ``[1]``.
  211. .. rst-class:: classref-item-separator
  212. ----
  213. .. _class_Vector4_property_z:
  214. .. rst-class:: classref-property
  215. :ref:`float<class_float>` **z** = ``0.0`` :ref:`🔗<class_Vector4_property_z>`
  216. The vector's Z component. Also accessible by using the index position ``[2]``.
  217. .. rst-class:: classref-section-separator
  218. ----
  219. .. rst-class:: classref-descriptions-group
  220. Constructor Descriptions
  221. ------------------------
  222. .. _class_Vector4_constructor_Vector4:
  223. .. rst-class:: classref-constructor
  224. :ref:`Vector4<class_Vector4>` **Vector4**\ (\ ) :ref:`🔗<class_Vector4_constructor_Vector4>`
  225. Constructs a default-initialized **Vector4** with all components set to ``0``.
  226. .. rst-class:: classref-item-separator
  227. ----
  228. .. rst-class:: classref-constructor
  229. :ref:`Vector4<class_Vector4>` **Vector4**\ (\ from\: :ref:`Vector4<class_Vector4>`\ )
  230. Constructs a **Vector4** as a copy of the given **Vector4**.
  231. .. rst-class:: classref-item-separator
  232. ----
  233. .. rst-class:: classref-constructor
  234. :ref:`Vector4<class_Vector4>` **Vector4**\ (\ from\: :ref:`Vector4i<class_Vector4i>`\ )
  235. Constructs a new **Vector4** from the given :ref:`Vector4i<class_Vector4i>`.
  236. .. rst-class:: classref-item-separator
  237. ----
  238. .. rst-class:: classref-constructor
  239. :ref:`Vector4<class_Vector4>` **Vector4**\ (\ x\: :ref:`float<class_float>`, y\: :ref:`float<class_float>`, z\: :ref:`float<class_float>`, w\: :ref:`float<class_float>`\ )
  240. Returns a **Vector4** with the given components.
  241. .. rst-class:: classref-section-separator
  242. ----
  243. .. rst-class:: classref-descriptions-group
  244. Method Descriptions
  245. -------------------
  246. .. _class_Vector4_method_abs:
  247. .. rst-class:: classref-method
  248. :ref:`Vector4<class_Vector4>` **abs**\ (\ ) |const| :ref:`🔗<class_Vector4_method_abs>`
  249. Returns a new vector with all components in absolute values (i.e. positive).
  250. .. rst-class:: classref-item-separator
  251. ----
  252. .. _class_Vector4_method_ceil:
  253. .. rst-class:: classref-method
  254. :ref:`Vector4<class_Vector4>` **ceil**\ (\ ) |const| :ref:`🔗<class_Vector4_method_ceil>`
  255. Returns a new vector with all components rounded up (towards positive infinity).
  256. .. rst-class:: classref-item-separator
  257. ----
  258. .. _class_Vector4_method_clamp:
  259. .. rst-class:: classref-method
  260. :ref:`Vector4<class_Vector4>` **clamp**\ (\ min\: :ref:`Vector4<class_Vector4>`, max\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_clamp>`
  261. Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp<class_@GlobalScope_method_clamp>` on each component.
  262. .. rst-class:: classref-item-separator
  263. ----
  264. .. _class_Vector4_method_clampf:
  265. .. rst-class:: classref-method
  266. :ref:`Vector4<class_Vector4>` **clampf**\ (\ min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Vector4_method_clampf>`
  267. Returns a new vector with all components clamped between ``min`` and ``max``, by running :ref:`@GlobalScope.clamp<class_@GlobalScope_method_clamp>` on each component.
  268. .. rst-class:: classref-item-separator
  269. ----
  270. .. _class_Vector4_method_cubic_interpolate:
  271. .. rst-class:: classref-method
  272. :ref:`Vector4<class_Vector4>` **cubic_interpolate**\ (\ b\: :ref:`Vector4<class_Vector4>`, pre_a\: :ref:`Vector4<class_Vector4>`, post_b\: :ref:`Vector4<class_Vector4>`, weight\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Vector4_method_cubic_interpolate>`
  273. Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation.
  274. .. rst-class:: classref-item-separator
  275. ----
  276. .. _class_Vector4_method_cubic_interpolate_in_time:
  277. .. rst-class:: classref-method
  278. :ref:`Vector4<class_Vector4>` **cubic_interpolate_in_time**\ (\ b\: :ref:`Vector4<class_Vector4>`, pre_a\: :ref:`Vector4<class_Vector4>`, post_b\: :ref:`Vector4<class_Vector4>`, weight\: :ref:`float<class_float>`, b_t\: :ref:`float<class_float>`, pre_a_t\: :ref:`float<class_float>`, post_b_t\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Vector4_method_cubic_interpolate_in_time>`
  279. Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation.
  280. It can perform smoother interpolation than :ref:`cubic_interpolate<class_Vector4_method_cubic_interpolate>` by the time values.
  281. .. rst-class:: classref-item-separator
  282. ----
  283. .. _class_Vector4_method_direction_to:
  284. .. rst-class:: classref-method
  285. :ref:`Vector4<class_Vector4>` **direction_to**\ (\ to\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_direction_to>`
  286. Returns the normalized vector pointing from this vector to ``to``. This is equivalent to using ``(b - a).normalized()``.
  287. .. rst-class:: classref-item-separator
  288. ----
  289. .. _class_Vector4_method_distance_squared_to:
  290. .. rst-class:: classref-method
  291. :ref:`float<class_float>` **distance_squared_to**\ (\ to\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_distance_squared_to>`
  292. Returns the squared distance between this vector and ``to``.
  293. This method runs faster than :ref:`distance_to<class_Vector4_method_distance_to>`, so prefer it if you need to compare vectors or need the squared distance for some formula.
  294. .. rst-class:: classref-item-separator
  295. ----
  296. .. _class_Vector4_method_distance_to:
  297. .. rst-class:: classref-method
  298. :ref:`float<class_float>` **distance_to**\ (\ to\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_distance_to>`
  299. Returns the distance between this vector and ``to``.
  300. .. rst-class:: classref-item-separator
  301. ----
  302. .. _class_Vector4_method_dot:
  303. .. rst-class:: classref-method
  304. :ref:`float<class_float>` **dot**\ (\ with\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_dot>`
  305. Returns the dot product of this vector and ``with``.
  306. .. rst-class:: classref-item-separator
  307. ----
  308. .. _class_Vector4_method_floor:
  309. .. rst-class:: classref-method
  310. :ref:`Vector4<class_Vector4>` **floor**\ (\ ) |const| :ref:`🔗<class_Vector4_method_floor>`
  311. Returns a new vector with all components rounded down (towards negative infinity).
  312. .. rst-class:: classref-item-separator
  313. ----
  314. .. _class_Vector4_method_inverse:
  315. .. rst-class:: classref-method
  316. :ref:`Vector4<class_Vector4>` **inverse**\ (\ ) |const| :ref:`🔗<class_Vector4_method_inverse>`
  317. Returns the inverse of the vector. This is the same as ``Vector4(1.0 / v.x, 1.0 / v.y, 1.0 / v.z, 1.0 / v.w)``.
  318. .. rst-class:: classref-item-separator
  319. ----
  320. .. _class_Vector4_method_is_equal_approx:
  321. .. rst-class:: classref-method
  322. :ref:`bool<class_bool>` **is_equal_approx**\ (\ to\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_is_equal_approx>`
  323. Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx<class_@GlobalScope_method_is_equal_approx>` on each component.
  324. .. rst-class:: classref-item-separator
  325. ----
  326. .. _class_Vector4_method_is_finite:
  327. .. rst-class:: classref-method
  328. :ref:`bool<class_bool>` **is_finite**\ (\ ) |const| :ref:`🔗<class_Vector4_method_is_finite>`
  329. Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_finite<class_@GlobalScope_method_is_finite>` on each component.
  330. .. rst-class:: classref-item-separator
  331. ----
  332. .. _class_Vector4_method_is_normalized:
  333. .. rst-class:: classref-method
  334. :ref:`bool<class_bool>` **is_normalized**\ (\ ) |const| :ref:`🔗<class_Vector4_method_is_normalized>`
  335. Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1.
  336. .. rst-class:: classref-item-separator
  337. ----
  338. .. _class_Vector4_method_is_zero_approx:
  339. .. rst-class:: classref-method
  340. :ref:`bool<class_bool>` **is_zero_approx**\ (\ ) |const| :ref:`🔗<class_Vector4_method_is_zero_approx>`
  341. Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx<class_@GlobalScope_method_is_zero_approx>` on each component.
  342. This method is faster than using :ref:`is_equal_approx<class_Vector4_method_is_equal_approx>` with one value as a zero vector.
  343. .. rst-class:: classref-item-separator
  344. ----
  345. .. _class_Vector4_method_length:
  346. .. rst-class:: classref-method
  347. :ref:`float<class_float>` **length**\ (\ ) |const| :ref:`🔗<class_Vector4_method_length>`
  348. Returns the length (magnitude) of this vector.
  349. .. rst-class:: classref-item-separator
  350. ----
  351. .. _class_Vector4_method_length_squared:
  352. .. rst-class:: classref-method
  353. :ref:`float<class_float>` **length_squared**\ (\ ) |const| :ref:`🔗<class_Vector4_method_length_squared>`
  354. Returns the squared length (squared magnitude) of this vector.
  355. This method runs faster than :ref:`length<class_Vector4_method_length>`, so prefer it if you need to compare vectors or need the squared distance for some formula.
  356. .. rst-class:: classref-item-separator
  357. ----
  358. .. _class_Vector4_method_lerp:
  359. .. rst-class:: classref-method
  360. :ref:`Vector4<class_Vector4>` **lerp**\ (\ to\: :ref:`Vector4<class_Vector4>`, weight\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Vector4_method_lerp>`
  361. Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation.
  362. .. rst-class:: classref-item-separator
  363. ----
  364. .. _class_Vector4_method_max:
  365. .. rst-class:: classref-method
  366. :ref:`Vector4<class_Vector4>` **max**\ (\ with\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_max>`
  367. Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4(maxf(x, with.x), maxf(y, with.y), maxf(z, with.z), maxf(w, with.w))``.
  368. .. rst-class:: classref-item-separator
  369. ----
  370. .. _class_Vector4_method_max_axis_index:
  371. .. rst-class:: classref-method
  372. :ref:`int<class_int>` **max_axis_index**\ (\ ) |const| :ref:`🔗<class_Vector4_method_max_axis_index>`
  373. Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X<class_Vector4_constant_AXIS_X>`.
  374. .. rst-class:: classref-item-separator
  375. ----
  376. .. _class_Vector4_method_maxf:
  377. .. rst-class:: classref-method
  378. :ref:`Vector4<class_Vector4>` **maxf**\ (\ with\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Vector4_method_maxf>`
  379. Returns the component-wise maximum of this and ``with``, equivalent to ``Vector4(maxf(x, with), maxf(y, with), maxf(z, with), maxf(w, with))``.
  380. .. rst-class:: classref-item-separator
  381. ----
  382. .. _class_Vector4_method_min:
  383. .. rst-class:: classref-method
  384. :ref:`Vector4<class_Vector4>` **min**\ (\ with\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_min>`
  385. Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4(minf(x, with.x), minf(y, with.y), minf(z, with.z), minf(w, with.w))``.
  386. .. rst-class:: classref-item-separator
  387. ----
  388. .. _class_Vector4_method_min_axis_index:
  389. .. rst-class:: classref-method
  390. :ref:`int<class_int>` **min_axis_index**\ (\ ) |const| :ref:`🔗<class_Vector4_method_min_axis_index>`
  391. Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_W<class_Vector4_constant_AXIS_W>`.
  392. .. rst-class:: classref-item-separator
  393. ----
  394. .. _class_Vector4_method_minf:
  395. .. rst-class:: classref-method
  396. :ref:`Vector4<class_Vector4>` **minf**\ (\ with\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Vector4_method_minf>`
  397. Returns the component-wise minimum of this and ``with``, equivalent to ``Vector4(minf(x, with), minf(y, with), minf(z, with), minf(w, with))``.
  398. .. rst-class:: classref-item-separator
  399. ----
  400. .. _class_Vector4_method_normalized:
  401. .. rst-class:: classref-method
  402. :ref:`Vector4<class_Vector4>` **normalized**\ (\ ) |const| :ref:`🔗<class_Vector4_method_normalized>`
  403. Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. Returns ``(0, 0, 0, 0)`` if ``v.length() == 0``. See also :ref:`is_normalized<class_Vector4_method_is_normalized>`.
  404. \ **Note:** This function may return incorrect values if the input vector length is near zero.
  405. .. rst-class:: classref-item-separator
  406. ----
  407. .. _class_Vector4_method_posmod:
  408. .. rst-class:: classref-method
  409. :ref:`Vector4<class_Vector4>` **posmod**\ (\ mod\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Vector4_method_posmod>`
  410. Returns a vector composed of the :ref:`@GlobalScope.fposmod<class_@GlobalScope_method_fposmod>` of this vector's components and ``mod``.
  411. .. rst-class:: classref-item-separator
  412. ----
  413. .. _class_Vector4_method_posmodv:
  414. .. rst-class:: classref-method
  415. :ref:`Vector4<class_Vector4>` **posmodv**\ (\ modv\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_posmodv>`
  416. Returns a vector composed of the :ref:`@GlobalScope.fposmod<class_@GlobalScope_method_fposmod>` of this vector's components and ``modv``'s components.
  417. .. rst-class:: classref-item-separator
  418. ----
  419. .. _class_Vector4_method_round:
  420. .. rst-class:: classref-method
  421. :ref:`Vector4<class_Vector4>` **round**\ (\ ) |const| :ref:`🔗<class_Vector4_method_round>`
  422. Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
  423. .. rst-class:: classref-item-separator
  424. ----
  425. .. _class_Vector4_method_sign:
  426. .. rst-class:: classref-method
  427. :ref:`Vector4<class_Vector4>` **sign**\ (\ ) |const| :ref:`🔗<class_Vector4_method_sign>`
  428. Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0`` if it's negative, and ``0.0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign<class_@GlobalScope_method_sign>` on each component.
  429. .. rst-class:: classref-item-separator
  430. ----
  431. .. _class_Vector4_method_snapped:
  432. .. rst-class:: classref-method
  433. :ref:`Vector4<class_Vector4>` **snapped**\ (\ step\: :ref:`Vector4<class_Vector4>`\ ) |const| :ref:`🔗<class_Vector4_method_snapped>`
  434. Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals.
  435. .. rst-class:: classref-item-separator
  436. ----
  437. .. _class_Vector4_method_snappedf:
  438. .. rst-class:: classref-method
  439. :ref:`Vector4<class_Vector4>` **snappedf**\ (\ step\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Vector4_method_snappedf>`
  440. Returns a new vector with each component snapped to the nearest multiple of ``step``. This can also be used to round the components to an arbitrary number of decimals.
  441. .. rst-class:: classref-section-separator
  442. ----
  443. .. rst-class:: classref-descriptions-group
  444. Operator Descriptions
  445. ---------------------
  446. .. _class_Vector4_operator_neq_Vector4:
  447. .. rst-class:: classref-operator
  448. :ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_neq_Vector4>`
  449. Returns ``true`` if the vectors are not equal.
  450. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Vector4_method_is_equal_approx>` instead, which is more reliable.
  451. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included.
  452. .. rst-class:: classref-item-separator
  453. ----
  454. .. _class_Vector4_operator_mul_Projection:
  455. .. rst-class:: classref-operator
  456. :ref:`Vector4<class_Vector4>` **operator ***\ (\ right\: :ref:`Projection<class_Projection>`\ ) :ref:`🔗<class_Vector4_operator_mul_Projection>`
  457. Transforms (multiplies) the **Vector4** by the transpose of the given :ref:`Projection<class_Projection>` matrix.
  458. For transforming by inverse of a projection ``projection.inverse() * vector`` can be used instead. See :ref:`Projection.inverse<class_Projection_method_inverse>`.
  459. .. rst-class:: classref-item-separator
  460. ----
  461. .. _class_Vector4_operator_mul_Vector4:
  462. .. rst-class:: classref-operator
  463. :ref:`Vector4<class_Vector4>` **operator ***\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_mul_Vector4>`
  464. Multiplies each component of the **Vector4** by the components of the given **Vector4**.
  465. ::
  466. print(Vector4(10, 20, 30, 40) * Vector4(3, 4, 5, 6)) # Prints "(30, 80, 150, 240)"
  467. .. rst-class:: classref-item-separator
  468. ----
  469. .. _class_Vector4_operator_mul_float:
  470. .. rst-class:: classref-operator
  471. :ref:`Vector4<class_Vector4>` **operator ***\ (\ right\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Vector4_operator_mul_float>`
  472. Multiplies each component of the **Vector4** by the given :ref:`float<class_float>`.
  473. ::
  474. print(Vector4(10, 20, 30, 40) * 2) # Prints "(20, 40, 60, 80)"
  475. .. rst-class:: classref-item-separator
  476. ----
  477. .. _class_Vector4_operator_mul_int:
  478. .. rst-class:: classref-operator
  479. :ref:`Vector4<class_Vector4>` **operator ***\ (\ right\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Vector4_operator_mul_int>`
  480. Multiplies each component of the **Vector4** by the given :ref:`int<class_int>`.
  481. .. rst-class:: classref-item-separator
  482. ----
  483. .. _class_Vector4_operator_sum_Vector4:
  484. .. rst-class:: classref-operator
  485. :ref:`Vector4<class_Vector4>` **operator +**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_sum_Vector4>`
  486. Adds each component of the **Vector4** by the components of the given **Vector4**.
  487. ::
  488. print(Vector4(10, 20, 30, 40) + Vector4(3, 4, 5, 6)) # Prints "(13, 24, 35, 46)"
  489. .. rst-class:: classref-item-separator
  490. ----
  491. .. _class_Vector4_operator_dif_Vector4:
  492. .. rst-class:: classref-operator
  493. :ref:`Vector4<class_Vector4>` **operator -**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_dif_Vector4>`
  494. Subtracts each component of the **Vector4** by the components of the given **Vector4**.
  495. ::
  496. print(Vector4(10, 20, 30, 40) - Vector4(3, 4, 5, 6)) # Prints "(7, 16, 25, 34)"
  497. .. rst-class:: classref-item-separator
  498. ----
  499. .. _class_Vector4_operator_div_Vector4:
  500. .. rst-class:: classref-operator
  501. :ref:`Vector4<class_Vector4>` **operator /**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_div_Vector4>`
  502. Divides each component of the **Vector4** by the components of the given **Vector4**.
  503. ::
  504. print(Vector4(10, 20, 30, 40) / Vector4(2, 5, 3, 4)) # Prints "(5, 4, 10, 10)"
  505. .. rst-class:: classref-item-separator
  506. ----
  507. .. _class_Vector4_operator_div_float:
  508. .. rst-class:: classref-operator
  509. :ref:`Vector4<class_Vector4>` **operator /**\ (\ right\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Vector4_operator_div_float>`
  510. Divides each component of the **Vector4** by the given :ref:`float<class_float>`.
  511. ::
  512. print(Vector4(10, 20, 30, 40) / 2 # Prints "(5, 10, 15, 20)"
  513. .. rst-class:: classref-item-separator
  514. ----
  515. .. _class_Vector4_operator_div_int:
  516. .. rst-class:: classref-operator
  517. :ref:`Vector4<class_Vector4>` **operator /**\ (\ right\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Vector4_operator_div_int>`
  518. Divides each component of the **Vector4** by the given :ref:`int<class_int>`.
  519. .. rst-class:: classref-item-separator
  520. ----
  521. .. _class_Vector4_operator_lt_Vector4:
  522. .. rst-class:: classref-operator
  523. :ref:`bool<class_bool>` **operator <**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_lt_Vector4>`
  524. Compares two **Vector4** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
  525. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included.
  526. .. rst-class:: classref-item-separator
  527. ----
  528. .. _class_Vector4_operator_lte_Vector4:
  529. .. rst-class:: classref-operator
  530. :ref:`bool<class_bool>` **operator <=**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_lte_Vector4>`
  531. Compares two **Vector4** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
  532. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included.
  533. .. rst-class:: classref-item-separator
  534. ----
  535. .. _class_Vector4_operator_eq_Vector4:
  536. .. rst-class:: classref-operator
  537. :ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_eq_Vector4>`
  538. Returns ``true`` if the vectors are exactly equal.
  539. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Vector4_method_is_equal_approx>` instead, which is more reliable.
  540. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included.
  541. .. rst-class:: classref-item-separator
  542. ----
  543. .. _class_Vector4_operator_gt_Vector4:
  544. .. rst-class:: classref-operator
  545. :ref:`bool<class_bool>` **operator >**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_gt_Vector4>`
  546. Compares two **Vector4** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
  547. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included.
  548. .. rst-class:: classref-item-separator
  549. ----
  550. .. _class_Vector4_operator_gte_Vector4:
  551. .. rst-class:: classref-operator
  552. :ref:`bool<class_bool>` **operator >=**\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) :ref:`🔗<class_Vector4_operator_gte_Vector4>`
  553. Compares two **Vector4** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
  554. \ **Note:** Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included.
  555. .. rst-class:: classref-item-separator
  556. ----
  557. .. _class_Vector4_operator_idx_int:
  558. .. rst-class:: classref-operator
  559. :ref:`float<class_float>` **operator []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Vector4_operator_idx_int>`
  560. Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, ``v[2]`` is equivalent to ``v.z``, and ``v[3]`` is equivalent to ``v.w``.
  561. .. rst-class:: classref-item-separator
  562. ----
  563. .. _class_Vector4_operator_unplus:
  564. .. rst-class:: classref-operator
  565. :ref:`Vector4<class_Vector4>` **operator unary+**\ (\ ) :ref:`🔗<class_Vector4_operator_unplus>`
  566. Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable.
  567. .. rst-class:: classref-item-separator
  568. ----
  569. .. _class_Vector4_operator_unminus:
  570. .. rst-class:: classref-operator
  571. :ref:`Vector4<class_Vector4>` **operator unary-**\ (\ ) :ref:`🔗<class_Vector4_operator_unminus>`
  572. Returns the negative value of the **Vector4**. This is the same as writing ``Vector4(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative.
  573. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  574. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  575. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  576. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  577. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  578. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  579. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  580. .. |void| replace:: :abbr:`void (No return value.)`