godot-docs/classes/class_visualshadernodetransformop.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformOp.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_VisualShaderNodeTransformOp:

VisualShaderNodeTransformOp
===========================

**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A :ref:`Transform3D<class_Transform3D>` operator to be used within the visual shader graph.

Description
-----------

Applies :ref:`operator<class_VisualShaderNodeTransformOp_property_operator>` to two transform (4x4 matrices) inputs.

Properties
----------

+------------------------------------------------------------+----------------------------------------------------------------------+-------+
| :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` | :ref:`operator<class_VisualShaderNodeTransformOp_property_operator>` | ``0`` |
+------------------------------------------------------------+----------------------------------------------------------------------+-------+

Enumerations
------------

.. _enum_VisualShaderNodeTransformOp_Operator:

.. _class_VisualShaderNodeTransformOp_constant_OP_AxB:

.. _class_VisualShaderNodeTransformOp_constant_OP_BxA:

.. _class_VisualShaderNodeTransformOp_constant_OP_AxB_COMP:

.. _class_VisualShaderNodeTransformOp_constant_OP_BxA_COMP:

.. _class_VisualShaderNodeTransformOp_constant_OP_ADD:

.. _class_VisualShaderNodeTransformOp_constant_OP_A_MINUS_B:

.. _class_VisualShaderNodeTransformOp_constant_OP_B_MINUS_A:

.. _class_VisualShaderNodeTransformOp_constant_OP_A_DIV_B:

.. _class_VisualShaderNodeTransformOp_constant_OP_B_DIV_A:

.. _class_VisualShaderNodeTransformOp_constant_OP_MAX:

enum **Operator**:

- **OP_AxB** = **0** --- Multiplies transform ``a`` by the transform ``b``.

- **OP_BxA** = **1** --- Multiplies transform ``b`` by the transform ``a``.

- **OP_AxB_COMP** = **2** --- Performs a component-wise multiplication of transform ``a`` by the transform ``b``.

- **OP_BxA_COMP** = **3** --- Performs a component-wise multiplication of transform ``b`` by the transform ``a``.

- **OP_ADD** = **4** --- Adds two transforms.

- **OP_A_MINUS_B** = **5** --- Subtracts the transform ``a`` from the transform ``b``.

- **OP_B_MINUS_A** = **6** --- Subtracts the transform ``b`` from the transform ``a``.

- **OP_A_DIV_B** = **7** --- Divides the transform ``a`` by the transform ``b``.

- **OP_B_DIV_A** = **8** --- Divides the transform ``b`` by the transform ``a``.

- **OP_MAX** = **9** --- Represents the size of the :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` enum.

Property Descriptions
---------------------

.. _class_VisualShaderNodeTransformOp_property_operator:

- :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **operator**

+-----------+---------------------+
| *Default* | ``0``               |
+-----------+---------------------+
| *Setter*  | set_operator(value) |
+-----------+---------------------+
| *Getter*  | get_operator()      |
+-----------+---------------------+

The type of the operation to be performed on the transforms. See :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` for options.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`