mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with current master branch (f87858a8f)
This commit is contained in:
@@ -14,91 +14,163 @@ VisualShaderNodeVectorOp
|
||||
|
||||
A vector operator to be used within the visual shader graph.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
A visual shader node for use of vector operators. Operates on vector ``a`` and vector ``b``.
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------------------------+-------------------------------------------------------------------+-------+
|
||||
| :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` | :ref:`operator<class_VisualShaderNodeVectorOp_property_operator>` | ``0`` |
|
||||
+---------------------------------------------------------+-------------------------------------------------------------------+-------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------------------------------------+-------------------------------------------------------------------+-------+
|
||||
| :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` | :ref:`operator<class_VisualShaderNodeVectorOp_property_operator>` | ``0`` |
|
||||
+---------------------------------------------------------+-------------------------------------------------------------------+-------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
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:
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_ENUM_SIZE:
|
||||
.. rst-class:: classref-enumeration
|
||||
|
||||
enum **Operator**:
|
||||
|
||||
- **OP_ADD** = **0** --- Adds two vectors.
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_ADD:
|
||||
|
||||
- **OP_SUB** = **1** --- Subtracts a vector from a vector.
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
- **OP_MUL** = **2** --- Multiplies two vectors.
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_ADD** = ``0``
|
||||
|
||||
- **OP_DIV** = **3** --- Divides vector by vector.
|
||||
Adds two vectors.
|
||||
|
||||
- **OP_MOD** = **4** --- Returns the remainder of the two vectors.
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_SUB:
|
||||
|
||||
- **OP_POW** = **5** --- Returns the value of the first parameter raised to the power of the second, for each component of the vectors.
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
- **OP_MAX** = **6** --- Returns the greater of two values, for each component of the vectors.
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_SUB** = ``1``
|
||||
|
||||
- **OP_MIN** = **7** --- Returns the lesser of two values, for each component of the vectors.
|
||||
Subtracts a vector from a vector.
|
||||
|
||||
- **OP_CROSS** = **8** --- Calculates the cross product of two vectors.
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_MUL:
|
||||
|
||||
- **OP_ATAN2** = **9** --- Returns the arc-tangent of the parameters.
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
- **OP_REFLECT** = **10** --- Returns the vector that points in the direction of reflection. ``a`` is incident vector and ``b`` is the normal vector.
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_MUL** = ``2``
|
||||
|
||||
- **OP_STEP** = **11** --- Vector step operator. Returns ``0.0`` if ``a`` is smaller than ``b`` and ``1.0`` otherwise.
|
||||
Multiplies two vectors.
|
||||
|
||||
- **OP_ENUM_SIZE** = **12** --- Represents the size of the :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` enum.
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_DIV:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_DIV** = ``3``
|
||||
|
||||
Divides vector by vector.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_MOD:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_MOD** = ``4``
|
||||
|
||||
Returns the remainder of the two vectors.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_POW:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_POW** = ``5``
|
||||
|
||||
Returns the value of the first parameter raised to the power of the second, for each component of the vectors.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_MAX:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_MAX** = ``6``
|
||||
|
||||
Returns the greater of two values, for each component of the vectors.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_MIN:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_MIN** = ``7``
|
||||
|
||||
Returns the lesser of two values, for each component of the vectors.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_CROSS:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_CROSS** = ``8``
|
||||
|
||||
Calculates the cross product of two vectors.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_ATAN2:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_ATAN2** = ``9``
|
||||
|
||||
Returns the arc-tangent of the parameters.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_REFLECT:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_REFLECT** = ``10``
|
||||
|
||||
Returns the vector that points in the direction of reflection. ``a`` is incident vector and ``b`` is the normal vector.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_STEP:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_STEP** = ``11``
|
||||
|
||||
Vector step operator. Returns ``0.0`` if ``a`` is smaller than ``b`` and ``1.0`` otherwise.
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_constant_OP_ENUM_SIZE:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **OP_ENUM_SIZE** = ``12``
|
||||
|
||||
Represents the size of the :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` enum.
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_VisualShaderNodeVectorOp_property_operator:
|
||||
|
||||
- :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **operator**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_operator(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | get_operator() |
|
||||
+-----------+---------------------+
|
||||
:ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **operator** = ``0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_operator** **(** :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` value **)**
|
||||
- :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` **get_operator** **(** **)**
|
||||
|
||||
The operator to be used. See :ref:`Operator<enum_VisualShaderNodeVectorOp_Operator>` for options.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user