class_visualshadernodetransformop.rst 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  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/VisualShaderNodeTransformOp.xml.
  6. .. _class_VisualShaderNodeTransformOp:
  7. VisualShaderNodeTransformOp
  8. ===========================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A :ref:`Transform3D<class_Transform3D>` operator to be used within the visual shader graph.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Applies :ref:`operator<class_VisualShaderNodeTransformOp_property_operator>` to two transform (4×4 matrices) inputs.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +------------------------------------------------------------+----------------------------------------------------------------------+-------+
  21. | :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` | :ref:`operator<class_VisualShaderNodeTransformOp_property_operator>` | ``0`` |
  22. +------------------------------------------------------------+----------------------------------------------------------------------+-------+
  23. .. rst-class:: classref-section-separator
  24. ----
  25. .. rst-class:: classref-descriptions-group
  26. Enumerations
  27. ------------
  28. .. _enum_VisualShaderNodeTransformOp_Operator:
  29. .. rst-class:: classref-enumeration
  30. enum **Operator**: :ref:`🔗<enum_VisualShaderNodeTransformOp_Operator>`
  31. .. _class_VisualShaderNodeTransformOp_constant_OP_AxB:
  32. .. rst-class:: classref-enumeration-constant
  33. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_AxB** = ``0``
  34. Multiplies transform ``a`` by the transform ``b``.
  35. .. _class_VisualShaderNodeTransformOp_constant_OP_BxA:
  36. .. rst-class:: classref-enumeration-constant
  37. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_BxA** = ``1``
  38. Multiplies transform ``b`` by the transform ``a``.
  39. .. _class_VisualShaderNodeTransformOp_constant_OP_AxB_COMP:
  40. .. rst-class:: classref-enumeration-constant
  41. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_AxB_COMP** = ``2``
  42. Performs a component-wise multiplication of transform ``a`` by the transform ``b``.
  43. .. _class_VisualShaderNodeTransformOp_constant_OP_BxA_COMP:
  44. .. rst-class:: classref-enumeration-constant
  45. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_BxA_COMP** = ``3``
  46. Performs a component-wise multiplication of transform ``b`` by the transform ``a``.
  47. .. _class_VisualShaderNodeTransformOp_constant_OP_ADD:
  48. .. rst-class:: classref-enumeration-constant
  49. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_ADD** = ``4``
  50. Adds two transforms.
  51. .. _class_VisualShaderNodeTransformOp_constant_OP_A_MINUS_B:
  52. .. rst-class:: classref-enumeration-constant
  53. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_A_MINUS_B** = ``5``
  54. Subtracts the transform ``a`` from the transform ``b``.
  55. .. _class_VisualShaderNodeTransformOp_constant_OP_B_MINUS_A:
  56. .. rst-class:: classref-enumeration-constant
  57. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_B_MINUS_A** = ``6``
  58. Subtracts the transform ``b`` from the transform ``a``.
  59. .. _class_VisualShaderNodeTransformOp_constant_OP_A_DIV_B:
  60. .. rst-class:: classref-enumeration-constant
  61. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_A_DIV_B** = ``7``
  62. Divides the transform ``a`` by the transform ``b``.
  63. .. _class_VisualShaderNodeTransformOp_constant_OP_B_DIV_A:
  64. .. rst-class:: classref-enumeration-constant
  65. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_B_DIV_A** = ``8``
  66. Divides the transform ``b`` by the transform ``a``.
  67. .. _class_VisualShaderNodeTransformOp_constant_OP_MAX:
  68. .. rst-class:: classref-enumeration-constant
  69. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_MAX** = ``9``
  70. Represents the size of the :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` enum.
  71. .. rst-class:: classref-section-separator
  72. ----
  73. .. rst-class:: classref-descriptions-group
  74. Property Descriptions
  75. ---------------------
  76. .. _class_VisualShaderNodeTransformOp_property_operator:
  77. .. rst-class:: classref-property
  78. :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **operator** = ``0`` :ref:`🔗<class_VisualShaderNodeTransformOp_property_operator>`
  79. .. rst-class:: classref-property-setget
  80. - |void| **set_operator**\ (\ value\: :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>`\ )
  81. - :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **get_operator**\ (\ )
  82. The type of the operation to be performed on the transforms. See :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` for options.
  83. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  84. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  85. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  86. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  87. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  88. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  89. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  90. .. |void| replace:: :abbr:`void (No return value.)`