: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/Vector4.xml. .. _class_Vector4: Vector4 ======= Vector used for 4D math using floating point coordinates. Description ----------- 4-element structure that can be used to represent any quadruplet of numeric values. It uses floating-point coordinates. See :ref:`Vector4i` for its integer counterpart. \ **Note:** In a boolean context, a Vector4 will evaluate to ``false`` if it's equal to ``Vector4(0, 0, 0, 0)``. Otherwise, a Vector4 will always evaluate to ``true``. Properties ---------- +---------------------------+------------------------------------+---------+ | :ref:`float` | :ref:`w` | ``0.0`` | +---------------------------+------------------------------------+---------+ | :ref:`float` | :ref:`x` | ``0.0`` | +---------------------------+------------------------------------+---------+ | :ref:`float` | :ref:`y` | ``0.0`` | +---------------------------+------------------------------------+---------+ | :ref:`float` | :ref:`z` | ``0.0`` | +---------------------------+------------------------------------+---------+ Constructors ------------ +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`Vector4` **(** **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`Vector4` from **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`Vector4i` from **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Methods ------- +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`abs` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`ceil` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`clamp` **(** :ref:`Vector4` min, :ref:`Vector4` max **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`dot` **(** :ref:`Vector4` with **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`floor` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`inverse` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Vector4` with **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`lerp` **(** :ref:`Vector4` to, :ref:`float` weight **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`normalized` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`round` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`sign` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ Operators --------- +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Projection` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator *` **(** :ref:`float` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator *` **(** :ref:`int` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator +` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator -` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator /` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator /` **(** :ref:`float` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator /` **(** :ref:`int` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator <` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator <=` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector4` right **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator unary+` **(** **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator unary-` **(** **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------+ Constants --------- .. _class_Vector4_constant_AXIS_X: .. _class_Vector4_constant_AXIS_Y: .. _class_Vector4_constant_AXIS_Z: .. _class_Vector4_constant_AXIS_W: .. _class_Vector4_constant_ZERO: .. _class_Vector4_constant_ONE: .. _class_Vector4_constant_INF: - **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. - **AXIS_Y** = **1** --- Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. - **AXIS_Z** = **2** --- Enumerated value for the Z axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. - **AXIS_W** = **3** --- Enumerated value for the W axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. - **ZERO** = **Vector4(0, 0, 0)** --- Zero vector, a vector with all components set to ``0``. - **ONE** = **Vector4(1, 1, 1)** --- One vector, a vector with all components set to ``1``. - **INF** = **Vector4(inf, inf, inf)** --- Infinity vector, a vector with all components set to :ref:`@GDScript.INF`. Property Descriptions --------------------- .. _class_Vector4_property_w: - :ref:`float` **w** +-----------+---------+ | *Default* | ``0.0`` | +-----------+---------+ The vector's W component. Also accessible by using the index position ``[3]``. ---- .. _class_Vector4_property_x: - :ref:`float` **x** +-----------+---------+ | *Default* | ``0.0`` | +-----------+---------+ The vector's X component. Also accessible by using the index position ``[0]``. ---- .. _class_Vector4_property_y: - :ref:`float` **y** +-----------+---------+ | *Default* | ``0.0`` | +-----------+---------+ The vector's Y component. Also accessible by using the index position ``[1]``. ---- .. _class_Vector4_property_z: - :ref:`float` **z** +-----------+---------+ | *Default* | ``0.0`` | +-----------+---------+ The vector's Z component. Also accessible by using the index position ``[2]``. Constructor Descriptions ------------------------ .. _class_Vector4_constructor_Vector4: - :ref:`Vector4` **Vector4** **(** **)** Constructs a default-initialized ``Vector4`` with all components set to ``0``. ---- - :ref:`Vector4` **Vector4** **(** :ref:`Vector4` from **)** Constructs a ``Vector4`` as a copy of the given ``Vector4``. ---- - :ref:`Vector4` **Vector4** **(** :ref:`Vector4i` from **)** Constructs a new ``Vector4`` from :ref:`Vector4i`. ---- - :ref:`Vector4` **Vector4** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** Returns a ``Vector4`` with the given components. Method Descriptions ------------------- .. _class_Vector4_method_abs: - :ref:`Vector4` **abs** **(** **)** |const| Returns a new vector with all components in absolute values (i.e. positive). ---- .. _class_Vector4_method_ceil: - :ref:`Vector4` **ceil** **(** **)** |const| Returns a new vector with all components rounded up (towards positive infinity). ---- .. _class_Vector4_method_clamp: - :ref:`Vector4` **clamp** **(** :ref:`Vector4` min, :ref:`Vector4` max **)** |const| Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. ---- .. _class_Vector4_method_dot: - :ref:`float` **dot** **(** :ref:`Vector4` with **)** |const| Returns the dot product of this vector and ``with``. ---- .. _class_Vector4_method_floor: - :ref:`Vector4` **floor** **(** **)** |const| Returns a new vector with all components rounded down (towards negative infinity). ---- .. _class_Vector4_method_inverse: - :ref:`Vector4` **inverse** **(** **)** |const| Returns the inverse of the vector. This is the same as ``Vector4(1.0 / v.x, 1.0 / v.y, 1.0 / v.z, 1.0 / v.w)``. ---- .. _class_Vector4_method_is_equal_approx: - :ref:`bool` **is_equal_approx** **(** :ref:`Vector4` with **)** |const| Returns ``true`` if this vector and ``v`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. ---- .. _class_Vector4_method_is_normalized: - :ref:`bool` **is_normalized** **(** **)** |const| Returns ``true`` if the vector is normalized, i.e. its length is equal to 1. ---- .. _class_Vector4_method_length: - :ref:`float` **length** **(** **)** |const| Returns the length (magnitude) of this vector. ---- .. _class_Vector4_method_length_squared: - :ref:`float` **length_squared** **(** **)** |const| Returns the squared length (squared magnitude) of this vector. This method runs faster than :ref:`length`. ---- .. _class_Vector4_method_lerp: - :ref:`Vector4` **lerp** **(** :ref:`Vector4` to, :ref:`float` weight **)** |const| Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. ---- .. _class_Vector4_method_max_axis_index: - :ref:`int` **max_axis_index** **(** **)** |const| Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. ---- .. _class_Vector4_method_min_axis_index: - :ref:`int` **min_axis_index** **(** **)** |const| Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_W`. ---- .. _class_Vector4_method_normalized: - :ref:`Vector4` **normalized** **(** **)** |const| Returns the vector scaled to unit length. Equivalent to ``v / v.length()``. ---- .. _class_Vector4_method_round: - :ref:`Vector4` **round** **(** **)** |const| Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. ---- .. _class_Vector4_method_sign: - :ref:`Vector4` **sign** **(** **)** |const| Returns a new vector with each component set to one or negative one, depending on the signs of the components, or zero if the component is zero, by calling :ref:`@GlobalScope.sign` on each component. Operator Descriptions --------------------- .. _class_Vector4_operator_neq_bool: - :ref:`bool` **operator !=** **(** :ref:`Vector4` right **)** Returns ``true`` if the vectors are not equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. ---- .. _class_Vector4_operator_mul_Vector4: - :ref:`Vector4` **operator *** **(** :ref:`Projection` right **)** Inversely transforms (multiplies) the ``Vector4`` by the given :ref:`Projection` matrix. ---- - :ref:`Vector4` **operator *** **(** :ref:`Vector4` right **)** Multiplies each component of the ``Vector4`` by the components of the given ``Vector4``. :: print(Vector4(10, 20, 30, 40) * Vector4(3, 4, 5, 6)) # Prints "(30, 80, 150, 240)" ---- - :ref:`Vector4` **operator *** **(** :ref:`float` right **)** Multiplies each component of the ``Vector4`` by the given :ref:`float`. :: print(Vector4(10, 20, 30, 40) * 2) # Prints "(20, 40, 60, 80)" ---- - :ref:`Vector4` **operator *** **(** :ref:`int` right **)** Multiplies each component of the ``Vector4`` by the given :ref:`int`. ---- .. _class_Vector4_operator_sum_Vector4: - :ref:`Vector4` **operator +** **(** :ref:`Vector4` right **)** Adds each component of the ``Vector4`` by the components of the given ``Vector4``. :: print(Vector4(10, 20, 30, 40) + Vector4(3, 4, 5, 6)) # Prints "(13, 24, 35, 46)" ---- .. _class_Vector4_operator_dif_Vector4: - :ref:`Vector4` **operator -** **(** :ref:`Vector4` right **)** Subtracts each component of the ``Vector4`` by the components of the given ``Vector4``. :: print(Vector4(10, 20, 30, 40) - Vector4(3, 4, 5, 6)) # Prints "(7, 16, 25, 34)" ---- .. _class_Vector4_operator_div_Vector4: - :ref:`Vector4` **operator /** **(** :ref:`Vector4` right **)** Divides each component of the ``Vector4`` by the components of the given ``Vector4``. :: print(Vector4(10, 20, 30, 40) / Vector4(2, 5, 3, 4)) # Prints "(5, 4, 10, 10)" ---- - :ref:`Vector4` **operator /** **(** :ref:`float` right **)** Divides each component of the ``Vector4`` by the given :ref:`float`. :: print(Vector4(10, 20, 30, 40) / 2 # Prints "(5, 10, 15, 20)" ---- - :ref:`Vector4` **operator /** **(** :ref:`int` right **)** Divides each component of the ``Vector4`` by the given :ref:`int`. ---- .. _class_Vector4_operator_lt_bool: - :ref:`bool` **operator <** **(** :ref:`Vector4` right **)** Compares two ``Vector4`` vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. ---- .. _class_Vector4_operator_lte_bool: - :ref:`bool` **operator <=** **(** :ref:`Vector4` right **)** Compares two ``Vector4`` vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. ---- .. _class_Vector4_operator_eq_bool: - :ref:`bool` **operator ==** **(** :ref:`Vector4` right **)** Returns ``true`` if the vectors are exactly equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. ---- .. _class_Vector4_operator_gt_bool: - :ref:`bool` **operator >** **(** :ref:`Vector4` right **)** Compares two ``Vector4`` vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. ---- .. _class_Vector4_operator_gte_bool: - :ref:`bool` **operator >=** **(** :ref:`Vector4` right **)** Access vector components using their index. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, and ``v[2]`` is equivalent to ``v.z``. ---- .. _class_Vector4_operator_idx_float: - :ref:`float` **operator []** **(** :ref:`int` index **)** Access vector components using their index. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, ``v[2]`` is equivalent to ``v.z``, and ``v[3]`` is equivalent to ``v.w``. ---- .. _class_Vector4_operator_unplus_Vector4: - :ref:`Vector4` **operator unary+** **(** **)** Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. ---- .. _class_Vector4_operator_unminus_Vector4: - :ref:`Vector4` **operator unary-** **(** **)** Returns the negative value of the ``Vector4``. This is the same as writing ``Vector4(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. .. |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.)` .. |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.)`