Files
godot-docs/classes/class_visualshadernodetransformop.rst
2023-05-19 13:35:34 +00:00

159 lines
5.3 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/VisualShaderNodeTransformOp.xml.
.. _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.
.. rst-class:: classref-introduction-group
Description
-----------
Applies :ref:`operator<class_VisualShaderNodeTransformOp_property_operator>` to two transform (4x4 matrices) inputs.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+------------------------------------------------------------+----------------------------------------------------------------------+-------+
| :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` | :ref:`operator<class_VisualShaderNodeTransformOp_property_operator>` | ``0`` |
+------------------------------------------------------------+----------------------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_VisualShaderNodeTransformOp_Operator:
.. rst-class:: classref-enumeration
enum **Operator**:
.. _class_VisualShaderNodeTransformOp_constant_OP_AxB:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_AxB** = ``0``
Multiplies transform ``a`` by the transform ``b``.
.. _class_VisualShaderNodeTransformOp_constant_OP_BxA:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_BxA** = ``1``
Multiplies transform ``b`` by the transform ``a``.
.. _class_VisualShaderNodeTransformOp_constant_OP_AxB_COMP:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_AxB_COMP** = ``2``
Performs a component-wise multiplication of transform ``a`` by the transform ``b``.
.. _class_VisualShaderNodeTransformOp_constant_OP_BxA_COMP:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_BxA_COMP** = ``3``
Performs a component-wise multiplication of transform ``b`` by the transform ``a``.
.. _class_VisualShaderNodeTransformOp_constant_OP_ADD:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_ADD** = ``4``
Adds two transforms.
.. _class_VisualShaderNodeTransformOp_constant_OP_A_MINUS_B:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_A_MINUS_B** = ``5``
Subtracts the transform ``a`` from the transform ``b``.
.. _class_VisualShaderNodeTransformOp_constant_OP_B_MINUS_A:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_B_MINUS_A** = ``6``
Subtracts the transform ``b`` from the transform ``a``.
.. _class_VisualShaderNodeTransformOp_constant_OP_A_DIV_B:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_A_DIV_B** = ``7``
Divides the transform ``a`` by the transform ``b``.
.. _class_VisualShaderNodeTransformOp_constant_OP_B_DIV_A:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_B_DIV_A** = ``8``
Divides the transform ``b`` by the transform ``a``.
.. _class_VisualShaderNodeTransformOp_constant_OP_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **OP_MAX** = ``9``
Represents the size of the :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` enum.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualShaderNodeTransformOp_property_operator:
.. rst-class:: classref-property
:ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **operator** = ``0``
.. rst-class:: classref-property-setget
- void **set_operator** **(** :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` value **)**
- :ref:`Operator<enum_VisualShaderNodeTransformOp_Operator>` **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.)`