Files
godot-docs/classes/class_visualshadernodetransformvecmult.rst
2025-06-07 03:33:02 +00:00

122 lines
4.7 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformVecMult.xml.
.. _class_VisualShaderNodeTransformVecMult:
VisualShaderNodeTransformVecMult
================================
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Multiplies a :ref:`Transform3D<class_Transform3D>` and a :ref:`Vector3<class_Vector3>` within the visual shader graph.
.. rst-class:: classref-introduction-group
Description
-----------
A multiplication operation on a transform (4×4 matrix) and a vector, with support for different multiplication operators.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-----------------------------------------------------------------+---------------------------------------------------------------------------+-------+
| :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` | :ref:`operator<class_VisualShaderNodeTransformVecMult_property_operator>` | ``0`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_VisualShaderNodeTransformVecMult_Operator:
.. rst-class:: classref-enumeration
enum **Operator**: :ref:`🔗<enum_VisualShaderNodeTransformVecMult_Operator>`
.. _class_VisualShaderNodeTransformVecMult_constant_OP_AxB:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_AxB** = ``0``
Multiplies transform ``a`` by the vector ``b``.
.. _class_VisualShaderNodeTransformVecMult_constant_OP_BxA:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_BxA** = ``1``
Multiplies vector ``b`` by the transform ``a``.
.. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_AxB:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_3x3_AxB** = ``2``
Multiplies transform ``a`` by the vector ``b``, skipping the last row and column of the transform.
.. _class_VisualShaderNodeTransformVecMult_constant_OP_3x3_BxA:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_3x3_BxA** = ``3``
Multiplies vector ``b`` by the transform ``a``, skipping the last row and column of the transform.
.. _class_VisualShaderNodeTransformVecMult_constant_OP_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **OP_MAX** = ``4``
Represents the size of the :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` enum.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualShaderNodeTransformVecMult_property_operator:
.. rst-class:: classref-property
:ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **operator** = ``0`` :ref:`🔗<class_VisualShaderNodeTransformVecMult_property_operator>`
.. rst-class:: classref-property-setget
- |void| **set_operator**\ (\ value\: :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>`\ )
- :ref:`Operator<enum_VisualShaderNodeTransformVecMult_Operator>` **get_operator**\ (\ )
The multiplication type to be performed.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |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.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`