godot-docs/classes/class_visualshadernodevectorop.rst

:github_url: hide

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

.. _class_VisualShaderNodeVectorOp:

VisualShaderNodeVectorOp
========================

**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

A vector operator to be used within the visual shader graph.

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

A visual shader node for use of vector operators. Operates on vector ``a`` and vector ``b``.

Properties
----------

+---------------------------------------------------------+-------------------------------------------------------------------+-------+
| :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` | :ref:`operator<class_VisualShaderNodeVectorOp_property_operator>` | ``0`` |
+---------------------------------------------------------+-------------------------------------------------------------------+-------+

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

.. _enum_VisualShaderNodeVectorOp_Operator:

.. _class_VisualShaderNodeVectorOp_constant_OP_ADD:

.. _class_VisualShaderNodeVectorOp_constant_OP_SUB:

.. _class_VisualShaderNodeVectorOp_constant_OP_MUL:

.. _class_VisualShaderNodeVectorOp_constant_OP_DIV:

.. _class_VisualShaderNodeVectorOp_constant_OP_MOD:

.. _class_VisualShaderNodeVectorOp_constant_OP_POW:

.. _class_VisualShaderNodeVectorOp_constant_OP_MAX:

.. _class_VisualShaderNodeVectorOp_constant_OP_MIN:

.. _class_VisualShaderNodeVectorOp_constant_OP_CROSS:

.. _class_VisualShaderNodeVectorOp_constant_OP_ATAN2:

.. _class_VisualShaderNodeVectorOp_constant_OP_REFLECT:

.. _class_VisualShaderNodeVectorOp_constant_OP_STEP:

enum **Operator**:

- **OP_ADD** = **0** --- Adds two vectors.

- **OP_SUB** = **1** --- Subtracts a vector from a vector.

- **OP_MUL** = **2** --- Multiplies two vectors.

- **OP_DIV** = **3** --- Divides vector by vector.

- **OP_MOD** = **4** --- Returns the remainder of the two vectors.

- **OP_POW** = **5** --- Returns the value of the first parameter raised to the power of the second, for each component of the vectors.

- **OP_MAX** = **6** --- Returns the greater of two values, for each component of the vectors.

- **OP_MIN** = **7** --- Returns the lesser of two values, for each component of the vectors.

- **OP_CROSS** = **8** --- Calculates the cross product of two vectors.

- **OP_ATAN2** = **9** --- Returns the arc-tangent of the parameters.

- **OP_REFLECT** = **10** --- Returns the vector that points in the direction of reflection. ``a`` is incident vector and ``b`` is the normal vector.

- **OP_STEP** = **11** --- Vector step operator. Returns ``0.0`` if ``a`` is smaller than ``b`` and ``1.0`` otherwise.

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

.. _class_VisualShaderNodeVectorOp_property_operator:

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

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

The operator to be used. See :ref:`Operator<enum_VisualShaderNodeVectorOp_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.)`