mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
519 lines
32 KiB
ReStructuredText
519 lines
32 KiB
ReStructuredText
: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/Vector3.xml.
|
|
|
|
.. _class_Vector3:
|
|
|
|
Vector3
|
|
=======
|
|
|
|
Vector used for 3D math.
|
|
|
|
Description
|
|
-----------
|
|
|
|
3-element structure that can be used to represent positions in 3D space or any other triplet of numeric values.
|
|
|
|
\ **Note:** In a boolean context, a Vector3 will evaluate to ``false`` if it's equal to ``Vector3(0, 0, 0)``. Otherwise, a Vector3 will always evaluate to ``true``.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`Math tutorial index <../tutorials/math/index>`
|
|
|
|
- :doc:`Vector math <../tutorials/math/vector_math>`
|
|
|
|
- :doc:`Advanced vector math <../tutorials/math/vectors_advanced>`
|
|
|
|
- `3Blue1Brown Essence of Linear Algebra <https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab>`__
|
|
|
|
- `Matrix Transform Demo <https://godotengine.org/asset-library/asset/584>`__
|
|
|
|
- `All 3D Demos <https://github.com/godotengine/godot-demo-projects/tree/master/3d>`__
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------+------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`x<class_Vector3_property_x>` | ``0.0`` |
|
|
+---------------------------+------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`y<class_Vector3_property_y>` | ``0.0`` |
|
|
+---------------------------+------------------------------------+---------+
|
|
| :ref:`float<class_float>` | :ref:`z<class_Vector3_property_z>` | ``0.0`` |
|
|
+---------------------------+------------------------------------+---------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`Vector3<class_Vector3_method_Vector3>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`abs<class_Vector3_method_abs>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`angle_to<class_Vector3_method_angle_to>` **(** :ref:`Vector3<class_Vector3>` to **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`bounce<class_Vector3_method_bounce>` **(** :ref:`Vector3<class_Vector3>` n **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`ceil<class_Vector3_method_ceil>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`cross<class_Vector3_method_cross>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`cubic_interpolate<class_Vector3_method_cubic_interpolate>` **(** :ref:`Vector3<class_Vector3>` b, :ref:`Vector3<class_Vector3>` pre_a, :ref:`Vector3<class_Vector3>` post_b, :ref:`float<class_float>` weight **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`direction_to<class_Vector3_method_direction_to>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`distance_squared_to<class_Vector3_method_distance_squared_to>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`distance_to<class_Vector3_method_distance_to>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`dot<class_Vector3_method_dot>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`floor<class_Vector3_method_floor>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`inverse<class_Vector3_method_inverse>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Vector3_method_is_equal_approx>` **(** :ref:`Vector3<class_Vector3>` v **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_normalized<class_Vector3_method_is_normalized>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`length<class_Vector3_method_length>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`length_squared<class_Vector3_method_length_squared>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`limit_length<class_Vector3_method_limit_length>` **(** :ref:`float<class_float>` length=1.0 **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`linear_interpolate<class_Vector3_method_linear_interpolate>` **(** :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` weight **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`max_axis<class_Vector3_method_max_axis>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`min_axis<class_Vector3_method_min_axis>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`move_toward<class_Vector3_method_move_toward>` **(** :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` delta **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`normalized<class_Vector3_method_normalized>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Basis<class_Basis>` | :ref:`outer<class_Vector3_method_outer>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`posmod<class_Vector3_method_posmod>` **(** :ref:`float<class_float>` mod **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`posmodv<class_Vector3_method_posmodv>` **(** :ref:`Vector3<class_Vector3>` modv **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`project<class_Vector3_method_project>` **(** :ref:`Vector3<class_Vector3>` b **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`reflect<class_Vector3_method_reflect>` **(** :ref:`Vector3<class_Vector3>` n **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`rotated<class_Vector3_method_rotated>` **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`round<class_Vector3_method_round>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`sign<class_Vector3_method_sign>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`signed_angle_to<class_Vector3_method_signed_angle_to>` **(** :ref:`Vector3<class_Vector3>` to, :ref:`Vector3<class_Vector3>` axis **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`slerp<class_Vector3_method_slerp>` **(** :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` weight **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`slide<class_Vector3_method_slide>` **(** :ref:`Vector3<class_Vector3>` n **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`snapped<class_Vector3_method_snapped>` **(** :ref:`Vector3<class_Vector3>` by **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Basis<class_Basis>` | :ref:`to_diagonal_matrix<class_Vector3_method_to_diagonal_matrix>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Constants
|
|
---------
|
|
|
|
.. _class_Vector3_constant_AXIS_X:
|
|
|
|
.. _class_Vector3_constant_AXIS_Y:
|
|
|
|
.. _class_Vector3_constant_AXIS_Z:
|
|
|
|
.. _class_Vector3_constant_ZERO:
|
|
|
|
.. _class_Vector3_constant_ONE:
|
|
|
|
.. _class_Vector3_constant_INF:
|
|
|
|
.. _class_Vector3_constant_LEFT:
|
|
|
|
.. _class_Vector3_constant_RIGHT:
|
|
|
|
.. _class_Vector3_constant_UP:
|
|
|
|
.. _class_Vector3_constant_DOWN:
|
|
|
|
.. _class_Vector3_constant_FORWARD:
|
|
|
|
.. _class_Vector3_constant_BACK:
|
|
|
|
- **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis<class_Vector3_method_max_axis>` and :ref:`min_axis<class_Vector3_method_min_axis>`.
|
|
|
|
- **AXIS_Y** = **1** --- Enumerated value for the Y axis. Returned by :ref:`max_axis<class_Vector3_method_max_axis>` and :ref:`min_axis<class_Vector3_method_min_axis>`.
|
|
|
|
- **AXIS_Z** = **2** --- Enumerated value for the Z axis. Returned by :ref:`max_axis<class_Vector3_method_max_axis>` and :ref:`min_axis<class_Vector3_method_min_axis>`.
|
|
|
|
- **ZERO** = **Vector3( 0, 0, 0 )** --- Zero vector, a vector with all components set to ``0``.
|
|
|
|
- **ONE** = **Vector3( 1, 1, 1 )** --- One vector, a vector with all components set to ``1``.
|
|
|
|
- **INF** = **Vector3( inf, inf, inf )** --- Infinity vector, a vector with all components set to :ref:`@GDScript.INF<class_@GDScript_constant_INF>`.
|
|
|
|
- **LEFT** = **Vector3( -1, 0, 0 )** --- Left unit vector. Represents the local direction of left, and the global direction of west.
|
|
|
|
- **RIGHT** = **Vector3( 1, 0, 0 )** --- Right unit vector. Represents the local direction of right, and the global direction of east.
|
|
|
|
- **UP** = **Vector3( 0, 1, 0 )** --- Up unit vector.
|
|
|
|
- **DOWN** = **Vector3( 0, -1, 0 )** --- Down unit vector.
|
|
|
|
- **FORWARD** = **Vector3( 0, 0, -1 )** --- Forward unit vector. Represents the local direction of forward, and the global direction of north.
|
|
|
|
- **BACK** = **Vector3( 0, 0, 1 )** --- Back unit vector. Represents the local direction of back, and the global direction of south.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_Vector3_property_x:
|
|
|
|
- :ref:`float<class_float>` **x**
|
|
|
|
+-----------+---------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+---------+
|
|
|
|
The vector's X component. Also accessible by using the index position ``[0]``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_property_y:
|
|
|
|
- :ref:`float<class_float>` **y**
|
|
|
|
+-----------+---------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+---------+
|
|
|
|
The vector's Y component. Also accessible by using the index position ``[1]``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_property_z:
|
|
|
|
- :ref:`float<class_float>` **z**
|
|
|
|
+-----------+---------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+---------+
|
|
|
|
The vector's Z component. Also accessible by using the index position ``[2]``.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_Vector3_method_Vector3:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **Vector3** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z **)**
|
|
|
|
Returns a Vector3 with the given components.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_abs:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **abs** **(** **)**
|
|
|
|
Returns a new vector with all components in absolute values (i.e. positive).
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_angle_to:
|
|
|
|
- :ref:`float<class_float>` **angle_to** **(** :ref:`Vector3<class_Vector3>` to **)**
|
|
|
|
Returns the unsigned minimum angle to the given vector, in radians.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_bounce:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **bounce** **(** :ref:`Vector3<class_Vector3>` n **)**
|
|
|
|
Returns the vector "bounced off" from a plane defined by the given normal.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_ceil:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **ceil** **(** **)**
|
|
|
|
Returns a new vector with all components rounded up (towards positive infinity).
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_cross:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **cross** **(** :ref:`Vector3<class_Vector3>` b **)**
|
|
|
|
Returns the cross product of this vector and ``b``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_cubic_interpolate:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **cubic_interpolate** **(** :ref:`Vector3<class_Vector3>` b, :ref:`Vector3<class_Vector3>` pre_a, :ref:`Vector3<class_Vector3>` post_b, :ref:`float<class_float>` weight **)**
|
|
|
|
Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_direction_to:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **direction_to** **(** :ref:`Vector3<class_Vector3>` b **)**
|
|
|
|
Returns the normalized vector pointing from this vector to ``b``. This is equivalent to using ``(b - a).normalized()``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_distance_squared_to:
|
|
|
|
- :ref:`float<class_float>` **distance_squared_to** **(** :ref:`Vector3<class_Vector3>` b **)**
|
|
|
|
Returns the squared distance between this vector and ``b``.
|
|
|
|
This method runs faster than :ref:`distance_to<class_Vector3_method_distance_to>`, so prefer it if you need to compare vectors or need the squared distance for some formula.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_distance_to:
|
|
|
|
- :ref:`float<class_float>` **distance_to** **(** :ref:`Vector3<class_Vector3>` b **)**
|
|
|
|
Returns the distance between this vector and ``b``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_dot:
|
|
|
|
- :ref:`float<class_float>` **dot** **(** :ref:`Vector3<class_Vector3>` b **)**
|
|
|
|
Returns the dot product of this vector and ``b``. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player.
|
|
|
|
The dot product will be ``0`` for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees.
|
|
|
|
When using unit (normalized) vectors, the result will always be between ``-1.0`` (180 degree angle) when the vectors are facing opposite directions, and ``1.0`` (0 degree angle) when the vectors are aligned.
|
|
|
|
\ **Note:** ``a.dot(b)`` is equivalent to ``b.dot(a)``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_floor:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **floor** **(** **)**
|
|
|
|
Returns a new vector with all components rounded down (towards negative infinity).
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_inverse:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **inverse** **(** **)**
|
|
|
|
Returns the inverse of the vector. This is the same as ``Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_is_equal_approx:
|
|
|
|
- :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Vector3<class_Vector3>` v **)**
|
|
|
|
Returns ``true`` if this vector and ``v`` are approximately equal, by running :ref:`@GDScript.is_equal_approx<class_@GDScript_method_is_equal_approx>` on each component.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_is_normalized:
|
|
|
|
- :ref:`bool<class_bool>` **is_normalized** **(** **)**
|
|
|
|
Returns ``true`` if the vector is normalized, ``false`` otherwise.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_length:
|
|
|
|
- :ref:`float<class_float>` **length** **(** **)**
|
|
|
|
Returns the length (magnitude) of this vector.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_length_squared:
|
|
|
|
- :ref:`float<class_float>` **length_squared** **(** **)**
|
|
|
|
Returns the squared length (squared magnitude) of this vector.
|
|
|
|
This method runs faster than :ref:`length<class_Vector3_method_length>`, so prefer it if you need to compare vectors or need the squared distance for some formula.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_limit_length:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **limit_length** **(** :ref:`float<class_float>` length=1.0 **)**
|
|
|
|
Returns the vector with a maximum length by limiting its length to ``length``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_linear_interpolate:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **linear_interpolate** **(** :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` weight **)**
|
|
|
|
Returns the result of the linear interpolation between this vector and ``to`` by amount ``t``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_max_axis:
|
|
|
|
- :ref:`int<class_int>` **max_axis** **(** **)**
|
|
|
|
Returns the axis of the vector's largest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X<class_Vector3_constant_AXIS_X>`.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_min_axis:
|
|
|
|
- :ref:`int<class_int>` **min_axis** **(** **)**
|
|
|
|
Returns the axis of the vector's smallest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_Z<class_Vector3_constant_AXIS_Z>`.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_move_toward:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **move_toward** **(** :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` delta **)**
|
|
|
|
Returns a new vector moved toward ``to`` by the fixed ``delta`` amount. Will not go past the final value.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_normalized:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **normalized** **(** **)**
|
|
|
|
Returns the vector scaled to unit length. Equivalent to ``v / v.length()``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_outer:
|
|
|
|
- :ref:`Basis<class_Basis>` **outer** **(** :ref:`Vector3<class_Vector3>` b **)**
|
|
|
|
Returns the outer product with ``b``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_posmod:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **posmod** **(** :ref:`float<class_float>` mod **)**
|
|
|
|
Returns a vector composed of the :ref:`@GDScript.fposmod<class_@GDScript_method_fposmod>` of this vector's components and ``mod``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_posmodv:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **posmodv** **(** :ref:`Vector3<class_Vector3>` modv **)**
|
|
|
|
Returns a vector composed of the :ref:`@GDScript.fposmod<class_@GDScript_method_fposmod>` of this vector's components and ``modv``'s components.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_project:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **project** **(** :ref:`Vector3<class_Vector3>` b **)**
|
|
|
|
Returns this vector projected onto the vector ``b``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_reflect:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **reflect** **(** :ref:`Vector3<class_Vector3>` n **)**
|
|
|
|
Returns this vector reflected from a plane defined by the given normal.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_rotated:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **rotated** **(** :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` angle **)**
|
|
|
|
Rotates this vector around a given axis by ``angle`` (in radians). The axis must be a normalized vector.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_round:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **round** **(** **)**
|
|
|
|
Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_sign:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **sign** **(** **)**
|
|
|
|
Returns a new vector with each component set to one or negative one, depending on the signs of the components. If a component is zero, it returns positive one.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_signed_angle_to:
|
|
|
|
- :ref:`float<class_float>` **signed_angle_to** **(** :ref:`Vector3<class_Vector3>` to, :ref:`Vector3<class_Vector3>` axis **)**
|
|
|
|
Returns the signed angle to the given vector, in radians. The sign of the angle is positive in a counter-clockwise direction and negative in a clockwise direction when viewed from the side specified by the ``axis``.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_slerp:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **slerp** **(** :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` weight **)**
|
|
|
|
Returns the result of spherical 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.
|
|
|
|
\ **Note:** Both vectors must be normalized.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_slide:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **slide** **(** :ref:`Vector3<class_Vector3>` n **)**
|
|
|
|
Returns this vector slid along a plane defined by the given normal.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_snapped:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **snapped** **(** :ref:`Vector3<class_Vector3>` by **)**
|
|
|
|
Returns this vector with each component snapped to the nearest multiple of ``step``. This can also be used to round to an arbitrary number of decimals.
|
|
|
|
----
|
|
|
|
.. _class_Vector3_method_to_diagonal_matrix:
|
|
|
|
- :ref:`Basis<class_Basis>` **to_diagonal_matrix** **(** **)**
|
|
|
|
Returns a diagonal matrix with the vector as main diagonal.
|
|
|
|
This is equivalent to a Basis with no rotation or shearing and this vector's components set as the scale.
|
|
|
|
.. |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.)`
|