class_transform2d.rst 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686
  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/Transform2D.xml.
  6. .. _class_Transform2D:
  7. Transform2D
  8. ===========
  9. A 2×3 matrix representing a 2D transformation.
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. A 2×3 matrix (2 rows, 3 columns) used for 2D linear transformations. It can represent transformations such as translation, rotation, and scaling. It consists of three :ref:`Vector2<class_Vector2>` values: :ref:`x<class_Transform2D_property_x>`, :ref:`y<class_Transform2D_property_y>`, and the :ref:`origin<class_Transform2D_property_origin>`.
  14. For more information, read the "Matrices and transforms" documentation article.
  15. .. note::
  16. There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.
  17. .. rst-class:: classref-introduction-group
  18. Tutorials
  19. ---------
  20. - :doc:`Math documentation index <../tutorials/math/index>`
  21. - :doc:`Matrices and transforms <../tutorials/math/matrices_and_transforms>`
  22. - `Matrix Transform Demo <https://godotengine.org/asset-library/asset/584>`__
  23. - `2.5D Demo <https://godotengine.org/asset-library/asset/583>`__
  24. .. rst-class:: classref-reftable-group
  25. Properties
  26. ----------
  27. .. table::
  28. :widths: auto
  29. +-------------------------------+--------------------------------------------------+-------------------+
  30. | :ref:`Vector2<class_Vector2>` | :ref:`origin<class_Transform2D_property_origin>` | ``Vector2(0, 0)`` |
  31. +-------------------------------+--------------------------------------------------+-------------------+
  32. | :ref:`Vector2<class_Vector2>` | :ref:`x<class_Transform2D_property_x>` | ``Vector2(1, 0)`` |
  33. +-------------------------------+--------------------------------------------------+-------------------+
  34. | :ref:`Vector2<class_Vector2>` | :ref:`y<class_Transform2D_property_y>` | ``Vector2(0, 1)`` |
  35. +-------------------------------+--------------------------------------------------+-------------------+
  36. .. rst-class:: classref-reftable-group
  37. Constructors
  38. ------------
  39. .. table::
  40. :widths: auto
  41. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`Transform2D<class_Transform2D>` | :ref:`Transform2D<class_Transform2D_constructor_Transform2D>` **(** **)** |
  43. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`Transform2D<class_Transform2D>` | :ref:`Transform2D<class_Transform2D_constructor_Transform2D>` **(** :ref:`Transform2D<class_Transform2D>` from **)** |
  45. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`Transform2D<class_Transform2D>` | :ref:`Transform2D<class_Transform2D_constructor_Transform2D>` **(** :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` position **)** |
  47. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`Transform2D<class_Transform2D>` | :ref:`Transform2D<class_Transform2D_constructor_Transform2D>` **(** :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` scale, :ref:`float<class_float>` skew, :ref:`Vector2<class_Vector2>` position **)** |
  49. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`Transform2D<class_Transform2D>` | :ref:`Transform2D<class_Transform2D_constructor_Transform2D>` **(** :ref:`Vector2<class_Vector2>` x_axis, :ref:`Vector2<class_Vector2>` y_axis, :ref:`Vector2<class_Vector2>` origin **)** |
  51. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. .. rst-class:: classref-reftable-group
  53. Methods
  54. -------
  55. .. table::
  56. :widths: auto
  57. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`Transform2D<class_Transform2D>` | :ref:`affine_inverse<class_Transform2D_method_affine_inverse>` **(** **)** |const| |
  59. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`Vector2<class_Vector2>` | :ref:`basis_xform<class_Transform2D_method_basis_xform>` **(** :ref:`Vector2<class_Vector2>` v **)** |const| |
  61. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`Vector2<class_Vector2>` | :ref:`basis_xform_inv<class_Transform2D_method_basis_xform_inv>` **(** :ref:`Vector2<class_Vector2>` v **)** |const| |
  63. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`float<class_float>` | :ref:`determinant<class_Transform2D_method_determinant>` **(** **)** |const| |
  65. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Vector2<class_Vector2>` | :ref:`get_origin<class_Transform2D_method_get_origin>` **(** **)** |const| |
  67. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`float<class_float>` | :ref:`get_rotation<class_Transform2D_method_get_rotation>` **(** **)** |const| |
  69. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`Vector2<class_Vector2>` | :ref:`get_scale<class_Transform2D_method_get_scale>` **(** **)** |const| |
  71. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`float<class_float>` | :ref:`get_skew<class_Transform2D_method_get_skew>` **(** **)** |const| |
  73. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`Transform2D<class_Transform2D>` | :ref:`interpolate_with<class_Transform2D_method_interpolate_with>` **(** :ref:`Transform2D<class_Transform2D>` xform, :ref:`float<class_float>` weight **)** |const| |
  75. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`Transform2D<class_Transform2D>` | :ref:`inverse<class_Transform2D_method_inverse>` **(** **)** |const| |
  77. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Transform2D_method_is_equal_approx>` **(** :ref:`Transform2D<class_Transform2D>` xform **)** |const| |
  79. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`bool<class_bool>` | :ref:`is_finite<class_Transform2D_method_is_finite>` **(** **)** |const| |
  81. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`Transform2D<class_Transform2D>` | :ref:`looking_at<class_Transform2D_method_looking_at>` **(** :ref:`Vector2<class_Vector2>` target=Vector2(0, 0) **)** |const| |
  83. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`Transform2D<class_Transform2D>` | :ref:`orthonormalized<class_Transform2D_method_orthonormalized>` **(** **)** |const| |
  85. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`Transform2D<class_Transform2D>` | :ref:`rotated<class_Transform2D_method_rotated>` **(** :ref:`float<class_float>` angle **)** |const| |
  87. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`Transform2D<class_Transform2D>` | :ref:`rotated_local<class_Transform2D_method_rotated_local>` **(** :ref:`float<class_float>` angle **)** |const| |
  89. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`Transform2D<class_Transform2D>` | :ref:`scaled<class_Transform2D_method_scaled>` **(** :ref:`Vector2<class_Vector2>` scale **)** |const| |
  91. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`Transform2D<class_Transform2D>` | :ref:`scaled_local<class_Transform2D_method_scaled_local>` **(** :ref:`Vector2<class_Vector2>` scale **)** |const| |
  93. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`Transform2D<class_Transform2D>` | :ref:`translated<class_Transform2D_method_translated>` **(** :ref:`Vector2<class_Vector2>` offset **)** |const| |
  95. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`Transform2D<class_Transform2D>` | :ref:`translated_local<class_Transform2D_method_translated_local>` **(** :ref:`Vector2<class_Vector2>` offset **)** |const| |
  97. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. .. rst-class:: classref-reftable-group
  99. Operators
  100. ---------
  101. .. table::
  102. :widths: auto
  103. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`bool<class_bool>` | :ref:`operator !=<class_Transform2D_operator_neq_Transform2D>` **(** :ref:`Transform2D<class_Transform2D>` right **)** |
  105. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`operator *<class_Transform2D_operator_mul_PackedVector2Array>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` right **)** |
  107. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`Rect2<class_Rect2>` | :ref:`operator *<class_Transform2D_operator_mul_Rect2>` **(** :ref:`Rect2<class_Rect2>` right **)** |
  109. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`Transform2D<class_Transform2D>` | :ref:`operator *<class_Transform2D_operator_mul_Transform2D>` **(** :ref:`Transform2D<class_Transform2D>` right **)** |
  111. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :ref:`Vector2<class_Vector2>` | :ref:`operator *<class_Transform2D_operator_mul_Vector2>` **(** :ref:`Vector2<class_Vector2>` right **)** |
  113. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`Transform2D<class_Transform2D>` | :ref:`operator *<class_Transform2D_operator_mul_float>` **(** :ref:`float<class_float>` right **)** |
  115. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`Transform2D<class_Transform2D>` | :ref:`operator *<class_Transform2D_operator_mul_int>` **(** :ref:`int<class_int>` right **)** |
  117. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`bool<class_bool>` | :ref:`operator ==<class_Transform2D_operator_eq_Transform2D>` **(** :ref:`Transform2D<class_Transform2D>` right **)** |
  119. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`Vector2<class_Vector2>` | :ref:`operator []<class_Transform2D_operator_idx_int>` **(** :ref:`int<class_int>` index **)** |
  121. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  122. .. rst-class:: classref-section-separator
  123. ----
  124. .. rst-class:: classref-descriptions-group
  125. Constants
  126. ---------
  127. .. _class_Transform2D_constant_IDENTITY:
  128. .. rst-class:: classref-constant
  129. **IDENTITY** = ``Transform2D(1, 0, 0, 1, 0, 0)``
  130. The identity **Transform2D** with no translation, rotation or scaling applied. When applied to other data structures, :ref:`IDENTITY<class_Transform2D_constant_IDENTITY>` performs no transformation.
  131. .. _class_Transform2D_constant_FLIP_X:
  132. .. rst-class:: classref-constant
  133. **FLIP_X** = ``Transform2D(-1, 0, 0, 1, 0, 0)``
  134. The **Transform2D** that will flip something along the X axis.
  135. .. _class_Transform2D_constant_FLIP_Y:
  136. .. rst-class:: classref-constant
  137. **FLIP_Y** = ``Transform2D(1, 0, 0, -1, 0, 0)``
  138. The **Transform2D** that will flip something along the Y axis.
  139. .. rst-class:: classref-section-separator
  140. ----
  141. .. rst-class:: classref-descriptions-group
  142. Property Descriptions
  143. ---------------------
  144. .. _class_Transform2D_property_origin:
  145. .. rst-class:: classref-property
  146. :ref:`Vector2<class_Vector2>` **origin** = ``Vector2(0, 0)``
  147. The origin vector (column 2, the third column). Equivalent to array index ``2``. The origin vector represents translation.
  148. .. rst-class:: classref-item-separator
  149. ----
  150. .. _class_Transform2D_property_x:
  151. .. rst-class:: classref-property
  152. :ref:`Vector2<class_Vector2>` **x** = ``Vector2(1, 0)``
  153. The basis matrix's X vector (column 0). Equivalent to array index ``0``.
  154. .. rst-class:: classref-item-separator
  155. ----
  156. .. _class_Transform2D_property_y:
  157. .. rst-class:: classref-property
  158. :ref:`Vector2<class_Vector2>` **y** = ``Vector2(0, 1)``
  159. The basis matrix's Y vector (column 1). Equivalent to array index ``1``.
  160. .. rst-class:: classref-section-separator
  161. ----
  162. .. rst-class:: classref-descriptions-group
  163. Constructor Descriptions
  164. ------------------------
  165. .. _class_Transform2D_constructor_Transform2D:
  166. .. rst-class:: classref-constructor
  167. :ref:`Transform2D<class_Transform2D>` **Transform2D** **(** **)**
  168. Constructs a default-initialized **Transform2D** set to :ref:`IDENTITY<class_Transform2D_constant_IDENTITY>`.
  169. .. rst-class:: classref-item-separator
  170. ----
  171. .. rst-class:: classref-constructor
  172. :ref:`Transform2D<class_Transform2D>` **Transform2D** **(** :ref:`Transform2D<class_Transform2D>` from **)**
  173. Constructs a **Transform2D** as a copy of the given **Transform2D**.
  174. .. rst-class:: classref-item-separator
  175. ----
  176. .. rst-class:: classref-constructor
  177. :ref:`Transform2D<class_Transform2D>` **Transform2D** **(** :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` position **)**
  178. Constructs the transform from a given angle (in radians) and position.
  179. .. rst-class:: classref-item-separator
  180. ----
  181. .. rst-class:: classref-constructor
  182. :ref:`Transform2D<class_Transform2D>` **Transform2D** **(** :ref:`float<class_float>` rotation, :ref:`Vector2<class_Vector2>` scale, :ref:`float<class_float>` skew, :ref:`Vector2<class_Vector2>` position **)**
  183. Constructs the transform from a given angle (in radians), scale, skew (in radians) and position.
  184. .. rst-class:: classref-item-separator
  185. ----
  186. .. rst-class:: classref-constructor
  187. :ref:`Transform2D<class_Transform2D>` **Transform2D** **(** :ref:`Vector2<class_Vector2>` x_axis, :ref:`Vector2<class_Vector2>` y_axis, :ref:`Vector2<class_Vector2>` origin **)**
  188. Constructs the transform from 3 :ref:`Vector2<class_Vector2>` values representing :ref:`x<class_Transform2D_property_x>`, :ref:`y<class_Transform2D_property_y>`, and the :ref:`origin<class_Transform2D_property_origin>` (the three column vectors).
  189. .. rst-class:: classref-section-separator
  190. ----
  191. .. rst-class:: classref-descriptions-group
  192. Method Descriptions
  193. -------------------
  194. .. _class_Transform2D_method_affine_inverse:
  195. .. rst-class:: classref-method
  196. :ref:`Transform2D<class_Transform2D>` **affine_inverse** **(** **)** |const|
  197. Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.
  198. .. rst-class:: classref-item-separator
  199. ----
  200. .. _class_Transform2D_method_basis_xform:
  201. .. rst-class:: classref-method
  202. :ref:`Vector2<class_Vector2>` **basis_xform** **(** :ref:`Vector2<class_Vector2>` v **)** |const|
  203. Returns a vector transformed (multiplied) by the basis matrix.
  204. This method does not account for translation (the origin vector).
  205. .. rst-class:: classref-item-separator
  206. ----
  207. .. _class_Transform2D_method_basis_xform_inv:
  208. .. rst-class:: classref-method
  209. :ref:`Vector2<class_Vector2>` **basis_xform_inv** **(** :ref:`Vector2<class_Vector2>` v **)** |const|
  210. Returns a vector transformed (multiplied) by the inverse basis matrix.
  211. This method does not account for translation (the origin vector).
  212. .. rst-class:: classref-item-separator
  213. ----
  214. .. _class_Transform2D_method_determinant:
  215. .. rst-class:: classref-method
  216. :ref:`float<class_float>` **determinant** **(** **)** |const|
  217. Returns the determinant of the basis matrix. If the basis is uniformly scaled, then its determinant equals the square of the scale factor.
  218. A negative determinant means the basis was flipped, so one part of the scale is negative. A zero determinant means the basis isn't invertible, and is usually considered invalid.
  219. .. rst-class:: classref-item-separator
  220. ----
  221. .. _class_Transform2D_method_get_origin:
  222. .. rst-class:: classref-method
  223. :ref:`Vector2<class_Vector2>` **get_origin** **(** **)** |const|
  224. Returns the transform's origin (translation).
  225. .. rst-class:: classref-item-separator
  226. ----
  227. .. _class_Transform2D_method_get_rotation:
  228. .. rst-class:: classref-method
  229. :ref:`float<class_float>` **get_rotation** **(** **)** |const|
  230. Returns the transform's rotation (in radians).
  231. .. rst-class:: classref-item-separator
  232. ----
  233. .. _class_Transform2D_method_get_scale:
  234. .. rst-class:: classref-method
  235. :ref:`Vector2<class_Vector2>` **get_scale** **(** **)** |const|
  236. Returns the scale.
  237. .. rst-class:: classref-item-separator
  238. ----
  239. .. _class_Transform2D_method_get_skew:
  240. .. rst-class:: classref-method
  241. :ref:`float<class_float>` **get_skew** **(** **)** |const|
  242. Returns the transform's skew (in radians).
  243. .. rst-class:: classref-item-separator
  244. ----
  245. .. _class_Transform2D_method_interpolate_with:
  246. .. rst-class:: classref-method
  247. :ref:`Transform2D<class_Transform2D>` **interpolate_with** **(** :ref:`Transform2D<class_Transform2D>` xform, :ref:`float<class_float>` weight **)** |const|
  248. Returns a transform interpolated between this transform and another by a given ``weight`` (on the range of 0.0 to 1.0).
  249. .. rst-class:: classref-item-separator
  250. ----
  251. .. _class_Transform2D_method_inverse:
  252. .. rst-class:: classref-method
  253. :ref:`Transform2D<class_Transform2D>` **inverse** **(** **)** |const|
  254. Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use :ref:`affine_inverse<class_Transform2D_method_affine_inverse>` for transforms with scaling).
  255. .. rst-class:: classref-item-separator
  256. ----
  257. .. _class_Transform2D_method_is_equal_approx:
  258. .. rst-class:: classref-method
  259. :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Transform2D<class_Transform2D>` xform **)** |const|
  260. Returns ``true`` if this transform and ``xform`` are approximately equal, by calling ``is_equal_approx`` on each component.
  261. .. rst-class:: classref-item-separator
  262. ----
  263. .. _class_Transform2D_method_is_finite:
  264. .. rst-class:: classref-method
  265. :ref:`bool<class_bool>` **is_finite** **(** **)** |const|
  266. Returns ``true`` if this transform is finite, by calling :ref:`@GlobalScope.is_finite<class_@GlobalScope_method_is_finite>` on each component.
  267. .. rst-class:: classref-item-separator
  268. ----
  269. .. _class_Transform2D_method_looking_at:
  270. .. rst-class:: classref-method
  271. :ref:`Transform2D<class_Transform2D>` **looking_at** **(** :ref:`Vector2<class_Vector2>` target=Vector2(0, 0) **)** |const|
  272. Returns a copy of the transform rotated such that the rotated X-axis points towards the ``target`` position.
  273. Operations take place in global space.
  274. .. rst-class:: classref-item-separator
  275. ----
  276. .. _class_Transform2D_method_orthonormalized:
  277. .. rst-class:: classref-method
  278. :ref:`Transform2D<class_Transform2D>` **orthonormalized** **(** **)** |const|
  279. Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1).
  280. .. rst-class:: classref-item-separator
  281. ----
  282. .. _class_Transform2D_method_rotated:
  283. .. rst-class:: classref-method
  284. :ref:`Transform2D<class_Transform2D>` **rotated** **(** :ref:`float<class_float>` angle **)** |const|
  285. Returns a copy of the transform rotated by the given ``angle`` (in radians).
  286. This method is an optimized version of multiplying the given transform ``X`` with a corresponding rotation transform ``R`` from the left, i.e., ``R * X``.
  287. This can be seen as transforming with respect to the global/parent frame.
  288. .. rst-class:: classref-item-separator
  289. ----
  290. .. _class_Transform2D_method_rotated_local:
  291. .. rst-class:: classref-method
  292. :ref:`Transform2D<class_Transform2D>` **rotated_local** **(** :ref:`float<class_float>` angle **)** |const|
  293. Returns a copy of the transform rotated by the given ``angle`` (in radians).
  294. This method is an optimized version of multiplying the given transform ``X`` with a corresponding rotation transform ``R`` from the right, i.e., ``X * R``.
  295. This can be seen as transforming with respect to the local frame.
  296. .. rst-class:: classref-item-separator
  297. ----
  298. .. _class_Transform2D_method_scaled:
  299. .. rst-class:: classref-method
  300. :ref:`Transform2D<class_Transform2D>` **scaled** **(** :ref:`Vector2<class_Vector2>` scale **)** |const|
  301. Returns a copy of the transform scaled by the given ``scale`` factor.
  302. This method is an optimized version of multiplying the given transform ``X`` with a corresponding scaling transform ``S`` from the left, i.e., ``S * X``.
  303. This can be seen as transforming with respect to the global/parent frame.
  304. .. rst-class:: classref-item-separator
  305. ----
  306. .. _class_Transform2D_method_scaled_local:
  307. .. rst-class:: classref-method
  308. :ref:`Transform2D<class_Transform2D>` **scaled_local** **(** :ref:`Vector2<class_Vector2>` scale **)** |const|
  309. Returns a copy of the transform scaled by the given ``scale`` factor.
  310. This method is an optimized version of multiplying the given transform ``X`` with a corresponding scaling transform ``S`` from the right, i.e., ``X * S``.
  311. This can be seen as transforming with respect to the local frame.
  312. .. rst-class:: classref-item-separator
  313. ----
  314. .. _class_Transform2D_method_translated:
  315. .. rst-class:: classref-method
  316. :ref:`Transform2D<class_Transform2D>` **translated** **(** :ref:`Vector2<class_Vector2>` offset **)** |const|
  317. Returns a copy of the transform translated by the given ``offset``.
  318. This method is an optimized version of multiplying the given transform ``X`` with a corresponding translation transform ``T`` from the left, i.e., ``T * X``.
  319. This can be seen as transforming with respect to the global/parent frame.
  320. .. rst-class:: classref-item-separator
  321. ----
  322. .. _class_Transform2D_method_translated_local:
  323. .. rst-class:: classref-method
  324. :ref:`Transform2D<class_Transform2D>` **translated_local** **(** :ref:`Vector2<class_Vector2>` offset **)** |const|
  325. Returns a copy of the transform translated by the given ``offset``.
  326. This method is an optimized version of multiplying the given transform ``X`` with a corresponding translation transform ``T`` from the right, i.e., ``X * T``.
  327. This can be seen as transforming with respect to the local frame.
  328. .. rst-class:: classref-section-separator
  329. ----
  330. .. rst-class:: classref-descriptions-group
  331. Operator Descriptions
  332. ---------------------
  333. .. _class_Transform2D_operator_neq_Transform2D:
  334. .. rst-class:: classref-operator
  335. :ref:`bool<class_bool>` **operator !=** **(** :ref:`Transform2D<class_Transform2D>` right **)**
  336. Returns ``true`` if the transforms are not equal.
  337. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Transform2D_method_is_equal_approx>` instead, which is more reliable.
  338. .. rst-class:: classref-item-separator
  339. ----
  340. .. _class_Transform2D_operator_mul_PackedVector2Array:
  341. .. rst-class:: classref-operator
  342. :ref:`PackedVector2Array<class_PackedVector2Array>` **operator *** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` right **)**
  343. Transforms (multiplies) each element of the :ref:`Vector2<class_Vector2>` array by the given **Transform2D** matrix.
  344. .. rst-class:: classref-item-separator
  345. ----
  346. .. _class_Transform2D_operator_mul_Rect2:
  347. .. rst-class:: classref-operator
  348. :ref:`Rect2<class_Rect2>` **operator *** **(** :ref:`Rect2<class_Rect2>` right **)**
  349. Transforms (multiplies) the :ref:`Rect2<class_Rect2>` by the given **Transform2D** matrix.
  350. .. rst-class:: classref-item-separator
  351. ----
  352. .. _class_Transform2D_operator_mul_Transform2D:
  353. .. rst-class:: classref-operator
  354. :ref:`Transform2D<class_Transform2D>` **operator *** **(** :ref:`Transform2D<class_Transform2D>` right **)**
  355. Composes these two transformation matrices by multiplying them together. This has the effect of transforming the second transform (the child) by the first transform (the parent).
  356. .. rst-class:: classref-item-separator
  357. ----
  358. .. _class_Transform2D_operator_mul_Vector2:
  359. .. rst-class:: classref-operator
  360. :ref:`Vector2<class_Vector2>` **operator *** **(** :ref:`Vector2<class_Vector2>` right **)**
  361. Transforms (multiplies) the :ref:`Vector2<class_Vector2>` by the given **Transform2D** matrix.
  362. .. rst-class:: classref-item-separator
  363. ----
  364. .. _class_Transform2D_operator_mul_float:
  365. .. rst-class:: classref-operator
  366. :ref:`Transform2D<class_Transform2D>` **operator *** **(** :ref:`float<class_float>` right **)**
  367. This operator multiplies all components of the **Transform2D**, including the origin vector, which scales it uniformly.
  368. .. rst-class:: classref-item-separator
  369. ----
  370. .. _class_Transform2D_operator_mul_int:
  371. .. rst-class:: classref-operator
  372. :ref:`Transform2D<class_Transform2D>` **operator *** **(** :ref:`int<class_int>` right **)**
  373. This operator multiplies all components of the **Transform2D**, including the origin vector, which scales it uniformly.
  374. .. rst-class:: classref-item-separator
  375. ----
  376. .. _class_Transform2D_operator_eq_Transform2D:
  377. .. rst-class:: classref-operator
  378. :ref:`bool<class_bool>` **operator ==** **(** :ref:`Transform2D<class_Transform2D>` right **)**
  379. Returns ``true`` if the transforms are exactly equal.
  380. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Transform2D_method_is_equal_approx>` instead, which is more reliable.
  381. .. rst-class:: classref-item-separator
  382. ----
  383. .. _class_Transform2D_operator_idx_int:
  384. .. rst-class:: classref-operator
  385. :ref:`Vector2<class_Vector2>` **operator []** **(** :ref:`int<class_int>` index **)**
  386. Access transform components using their index. ``t[0]`` is equivalent to ``t.x``, ``t[1]`` is equivalent to ``t.y``, and ``t[2]`` is equivalent to ``t.origin``.
  387. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  388. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  389. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  390. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  391. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  392. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  393. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`