pandemonium_engine_docs/classes/class_visualshadernodetransformmult.rst

71 lines
2.8 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformMult.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_VisualShaderNodeTransformMult:
VisualShaderNodeTransformMult
=============================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Multiplies :ref:`Transform<class_Transform>` by :ref:`Transform<class_Transform>` within the visual shader graph.
Description
-----------
A multiplication operation on two transforms (4x4 matrices), with support for different multiplication operators.
Properties
----------
+--------------------------------------------------------------+------------------------------------------------------------------------+-------+
| :ref:`Operator<enum_VisualShaderNodeTransformMult_Operator>` | :ref:`operator<class_VisualShaderNodeTransformMult_property_operator>` | ``0`` |
+--------------------------------------------------------------+------------------------------------------------------------------------+-------+
Enumerations
------------
.. _enum_VisualShaderNodeTransformMult_Operator:
.. _class_VisualShaderNodeTransformMult_constant_OP_AxB:
.. _class_VisualShaderNodeTransformMult_constant_OP_BxA:
.. _class_VisualShaderNodeTransformMult_constant_OP_AxB_COMP:
.. _class_VisualShaderNodeTransformMult_constant_OP_BxA_COMP:
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``.
Property Descriptions
---------------------
.. _class_VisualShaderNodeTransformMult_property_operator:
- :ref:`Operator<enum_VisualShaderNodeTransformMult_Operator>` **operator**
+-----------+---------------------+
| *Default* | ``0`` |
+-----------+---------------------+
| *Setter* | set_operator(value) |
+-----------+---------------------+
| *Getter* | get_operator() |
+-----------+---------------------+
The multiplication type to be performed on the transforms. See :ref:`Operator<enum_VisualShaderNodeTransformMult_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.)`