class_matrix32.rst 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_Matrix32:
  4. Matrix32
  5. ========
  6. **Category:** Built-In Types
  7. Brief Description
  8. -----------------
  9. 3x2 Matrix for 2D transforms.
  10. Member Functions
  11. ----------------
  12. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`Matrix32<class_matrix32>` | :ref:`Matrix32<class_Matrix32_Matrix32>` **(** :ref:`Transform<class_transform>` from **)** |
  14. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Matrix32<class_matrix32>` | :ref:`Matrix32<class_Matrix32_Matrix32>` **(** :ref:`Vector2<class_vector2>` x_axis, :ref:`Vector2<class_vector2>` y_axis, :ref:`Vector2<class_vector2>` origin **)** |
  16. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Matrix32<class_matrix32>` | :ref:`Matrix32<class_Matrix32_Matrix32>` **(** :ref:`float<class_float>` rot, :ref:`Vector2<class_vector2>` pos **)** |
  18. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`Matrix32<class_matrix32>` | :ref:`affine_inverse<class_Matrix32_affine_inverse>` **(** **)** |
  20. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`Matrix32<class_matrix32>` | :ref:`basis_xform<class_Matrix32_basis_xform>` **(** var v **)** |
  22. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Matrix32<class_matrix32>` | :ref:`basis_xform_inv<class_Matrix32_basis_xform_inv>` **(** var v **)** |
  24. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`Vector2<class_vector2>` | :ref:`get_origin<class_Matrix32_get_origin>` **(** **)** |
  26. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`float<class_float>` | :ref:`get_rotation<class_Matrix32_get_rotation>` **(** **)** |
  28. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_Matrix32_get_scale>` **(** **)** |
  30. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Matrix32<class_matrix32>` | :ref:`interpolate_with<class_Matrix32_interpolate_with>` **(** :ref:`Matrix32<class_matrix32>` m, :ref:`float<class_float>` c **)** |
  32. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`Matrix32<class_matrix32>` | :ref:`inverse<class_Matrix32_inverse>` **(** **)** |
  34. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`Matrix32<class_matrix32>` | :ref:`orthonormalized<class_Matrix32_orthonormalized>` **(** **)** |
  36. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`Matrix32<class_matrix32>` | :ref:`rotated<class_Matrix32_rotated>` **(** :ref:`float<class_float>` phi **)** |
  38. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`Matrix32<class_matrix32>` | :ref:`scaled<class_Matrix32_scaled>` **(** :ref:`Vector2<class_vector2>` scale **)** |
  40. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`Matrix32<class_matrix32>` | :ref:`translated<class_Matrix32_translated>` **(** :ref:`Vector2<class_vector2>` offset **)** |
  42. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`Matrix32<class_matrix32>` | :ref:`xform<class_Matrix32_xform>` **(** var v **)** |
  44. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`Matrix32<class_matrix32>` | :ref:`xform_inv<class_Matrix32_xform_inv>` **(** var v **)** |
  46. +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. Member Variables
  48. ----------------
  49. - :ref:`Vector2<class_vector2>` **o**
  50. - :ref:`Vector2<class_vector2>` **x**
  51. - :ref:`Vector2<class_vector2>` **y**
  52. Description
  53. -----------
  54. 3x2 Matrix for 2D transforms.
  55. Member Function Description
  56. ---------------------------
  57. .. _class_Matrix32_Matrix32:
  58. - :ref:`Matrix32<class_matrix32>` **Matrix32** **(** :ref:`Transform<class_transform>` from **)**
  59. .. _class_Matrix32_Matrix32:
  60. - :ref:`Matrix32<class_matrix32>` **Matrix32** **(** :ref:`Vector2<class_vector2>` x_axis, :ref:`Vector2<class_vector2>` y_axis, :ref:`Vector2<class_vector2>` origin **)**
  61. .. _class_Matrix32_Matrix32:
  62. - :ref:`Matrix32<class_matrix32>` **Matrix32** **(** :ref:`float<class_float>` rot, :ref:`Vector2<class_vector2>` pos **)**
  63. .. _class_Matrix32_affine_inverse:
  64. - :ref:`Matrix32<class_matrix32>` **affine_inverse** **(** **)**
  65. .. _class_Matrix32_basis_xform:
  66. - :ref:`Matrix32<class_matrix32>` **basis_xform** **(** var v **)**
  67. .. _class_Matrix32_basis_xform_inv:
  68. - :ref:`Matrix32<class_matrix32>` **basis_xform_inv** **(** var v **)**
  69. .. _class_Matrix32_get_origin:
  70. - :ref:`Vector2<class_vector2>` **get_origin** **(** **)**
  71. .. _class_Matrix32_get_rotation:
  72. - :ref:`float<class_float>` **get_rotation** **(** **)**
  73. .. _class_Matrix32_get_scale:
  74. - :ref:`Vector2<class_vector2>` **get_scale** **(** **)**
  75. .. _class_Matrix32_interpolate_with:
  76. - :ref:`Matrix32<class_matrix32>` **interpolate_with** **(** :ref:`Matrix32<class_matrix32>` m, :ref:`float<class_float>` c **)**
  77. .. _class_Matrix32_inverse:
  78. - :ref:`Matrix32<class_matrix32>` **inverse** **(** **)**
  79. .. _class_Matrix32_orthonormalized:
  80. - :ref:`Matrix32<class_matrix32>` **orthonormalized** **(** **)**
  81. .. _class_Matrix32_rotated:
  82. - :ref:`Matrix32<class_matrix32>` **rotated** **(** :ref:`float<class_float>` phi **)**
  83. .. _class_Matrix32_scaled:
  84. - :ref:`Matrix32<class_matrix32>` **scaled** **(** :ref:`Vector2<class_vector2>` scale **)**
  85. .. _class_Matrix32_translated:
  86. - :ref:`Matrix32<class_matrix32>` **translated** **(** :ref:`Vector2<class_vector2>` offset **)**
  87. .. _class_Matrix32_xform:
  88. - :ref:`Matrix32<class_matrix32>` **xform** **(** var v **)**
  89. .. _class_Matrix32_xform_inv:
  90. - :ref:`Matrix32<class_matrix32>` **xform_inv** **(** var v **)**