class_visualshadernodetransformvecmult.rst 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  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/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualShaderNodeTransformVecMult.xml.
  6. .. _class_VisualShaderNodeTransformVecMult:
  7. VisualShaderNodeTransformVecMult
  8. ================================
  9. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. Multiplies a :ref:`Transform<class_Transform>` and a :ref:`Vector3<class_Vector3>` within the visual shader graph.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. A multiplication operation on a transform (4x4 matrix) and a vector, with support for different multiplication operators.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +-----------------------------------------------------------------+---------------------------------------------------------------------------+-------+
  21. | :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` | :ref:`operator<class_VisualShaderNodeTransformVecMult_property_operator>` | ``0`` |
  22. +-----------------------------------------------------------------+---------------------------------------------------------------------------+-------+
  23. .. rst-class:: classref-section-separator
  24. ----
  25. .. rst-class:: classref-descriptions-group
  26. Enumerations
  27. ------------
  28. .. _enum_VisualShaderNodeTransformVecMult_Operator:
  29. .. rst-class:: classref-enumeration
  30. enum **Operator**:
  31. .. _class_VisualShaderNodeTransformVecMult_constant_OP_AxB:
  32. .. rst-class:: classref-enumeration-constant
  33. :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_AxB** = ``0``
  34. Multiplies transform ``a`` by the vector ``b``.
  35. .. _class_VisualShaderNodeTransformVecMult_constant_OP_BxA:
  36. .. rst-class:: classref-enumeration-constant
  37. :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_BxA** = ``1``
  38. Multiplies vector ``b`` by the transform ``a``.
  39. .. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_AxB:
  40. .. rst-class:: classref-enumeration-constant
  41. :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_3x3_AxB** = ``2``
  42. Multiplies transform ``a`` by the vector ``b``, skipping the last row and column of the transform.
  43. .. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_BxA:
  44. .. rst-class:: classref-enumeration-constant
  45. :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_3x3_BxA** = ``3``
  46. Multiplies vector ``b`` by the transform ``a``, skipping the last row and column of the transform.
  47. .. rst-class:: classref-section-separator
  48. ----
  49. .. rst-class:: classref-descriptions-group
  50. Property Descriptions
  51. ---------------------
  52. .. _class_VisualShaderNodeTransformVecMult_property_operator:
  53. .. rst-class:: classref-property
  54. :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **operator** = ``0``
  55. .. rst-class:: classref-property-setget
  56. - void **set_operator** **(** :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` value **)**
  57. - :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **get_operator** **(** **)**
  58. The multiplication type to be performed. See :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` for options.
  59. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  60. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  61. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  62. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`