class_visualshadernodetransformvecmult.rst 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformVecMult.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualShaderNodeTransformVecMult:
  6. VisualShaderNodeTransformVecMult
  7. ================================
  8. **Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Multiplies a :ref:`Transform<class_Transform>` and a :ref:`Vector3<class_Vector3>` within the visual shader graph.
  10. Description
  11. -----------
  12. A multiplication operation on a transform (4x4 matrix) and a vector, with support for different multiplication operators.
  13. Properties
  14. ----------
  15. +-----------------------------------------------------------------+---------------------------------------------------------------------------+-------+
  16. | :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` | :ref:`operator<class_VisualShaderNodeTransformVecMult_property_operator>` | ``0`` |
  17. +-----------------------------------------------------------------+---------------------------------------------------------------------------+-------+
  18. Enumerations
  19. ------------
  20. .. _enum_VisualShaderNodeTransformVecMult_Operator:
  21. .. _class_VisualShaderNodeTransformVecMult_constant_OP_AxB:
  22. .. _class_VisualShaderNodeTransformVecMult_constant_OP_BxA:
  23. .. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_AxB:
  24. .. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_BxA:
  25. enum **Operator**:
  26. - **OP_AxB** = **0** --- Multiplies transform ``a`` by the vector ``b``.
  27. - **OP_BxA** = **1** --- Multiplies vector ``b`` by the transform ``a``.
  28. - **OP_3x3_AxB** = **2** --- Multiplies transform ``a`` by the vector ``b``, skipping the last row and column of the transform.
  29. - **OP_3x3_BxA** = **3** --- Multiplies vector ``b`` by the transform ``a``, skipping the last row and column of the transform.
  30. Property Descriptions
  31. ---------------------
  32. .. _class_VisualShaderNodeTransformVecMult_property_operator:
  33. - :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **operator**
  34. +-----------+---------------------+
  35. | *Default* | ``0`` |
  36. +-----------+---------------------+
  37. | *Setter* | set_operator(value) |
  38. +-----------+---------------------+
  39. | *Getter* | get_operator() |
  40. +-----------+---------------------+
  41. The multiplication type to be performed. See :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` for options.
  42. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  43. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  44. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`