pandemonium_engine_docs/classes/class_visualshadernodetransformvecmult.rst

72 lines
2.9 KiB
ReStructuredText
Raw Normal View History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualShaderNodeTransformVecMult.xml.
.. _class_VisualShaderNodeTransformVecMult:
VisualShaderNodeTransformVecMult
================================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Multiplies a :ref:`Transform<class_Transform>` and a :ref:`Vector3<class_Vector3>` within the visual shader graph.
Description
-----------
A multiplication operation on a transform (4x4 matrix) and a vector, with support for different multiplication operators.
Properties
----------
+-----------------------------------------------------------------+---------------------------------------------------------------------------+-------+
| :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` | :ref:`operator<class_VisualShaderNodeTransformVecMult_property_operator>` | ``0`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------+-------+
Enumerations
------------
.. _enum_VisualShaderNodeTransformVecMult_Operator:
.. _class_VisualShaderNodeTransformVecMult_constant_OP_AxB:
.. _class_VisualShaderNodeTransformVecMult_constant_OP_BxA:
.. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_AxB:
.. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_BxA:
enum **Operator**:
- **OP_AxB** = **0** --- Multiplies transform ``a`` by the vector ``b``.
- **OP_BxA** = **1** --- Multiplies vector ``b`` by the transform ``a``.
- **OP_3x3_AxB** = **2** --- Multiplies transform ``a`` by the vector ``b``, skipping the last row and column of the transform.
- **OP_3x3_BxA** = **3** --- Multiplies vector ``b`` by the transform ``a``, skipping the last row and column of the transform.
Property Descriptions
---------------------
.. _class_VisualShaderNodeTransformVecMult_property_operator:
- :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **operator**
+-----------+---------------------+
| *Default* | ``0`` |
+-----------+---------------------+
| *Setter* | set_operator(value) |
+-----------+---------------------+
| *Getter* | get_operator() |
+-----------+---------------------+
The multiplication type to be performed. See :ref:`Operator<enum_VisualShaderNodeTransformVecMult_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.)`