github_url:	hide

Vector3

Vector used for 3D math using floating point coordinates.

Description

3-element structure that can be used to represent positions in 3D space or any other pair of numeric values.

It uses floating point coordinates.

Tutorials

• :doc:`../tutorials/math/index`

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:`Vector3i<class_Vector3i>` from )
: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>` t )
: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:`linear_interpolate<class_Vector3_method_linear_interpolate>` ( :ref:`Vector3<class_Vector3>` b, :ref:`float<class_float>` t )
: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>` phi )
:ref:`Vector3<class_Vector3>`	:ref:`round<class_Vector3_method_round>` ( )
:ref:`Vector3<class_Vector3>`	:ref:`sign<class_Vector3_method_sign>` ( )
:ref:`Vector3<class_Vector3>`	:ref:`slerp<class_Vector3_method_slerp>` ( :ref:`Vector3<class_Vector3>` b, :ref:`float<class_float>` t )
: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

• 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.
• ONE = Vector3( 1, 1, 1 ) --- One vector.
• INF = Vector3( inf, inf, inf ) --- Infinity vector.
• LEFT = Vector3( -1, 0, 0 ) --- Left unit vector.
• RIGHT = Vector3( 1, 0, 0 ) --- Right unit vector.
• UP = Vector3( 0, 1, 0 ) --- Up unit vector.
• DOWN = Vector3( 0, -1, 0 ) --- Down unit vector.
• FORWARD = Vector3( 0, 0, -1 ) --- Forward unit vector.
• BACK = Vector3( 0, 0, 1 ) --- Back unit vector.

Property Descriptions

• :ref:`float<class_float>` x

Default

0.0

The vector's X component. Also accessible by using the index position [0].

---

• :ref:`float<class_float>` y

Default

0.0

The vector's Y component. Also accessible by using the index position [1].

---

• :ref:`float<class_float>` z

Default

0.0

The vector's Z component. Also accessible by using the index position [2].

Method Descriptions

• :ref:`Vector3<class_Vector3>` Vector3 ( :ref:`Vector3i<class_Vector3i>` from )

Constructs a new Vector3 from :ref:`Vector3i<class_Vector3i>`.

---

• :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.

---

• :ref:`Vector3<class_Vector3>` abs ( )

Returns a new vector with all components in absolute values (i.e. positive).

---

• :ref:`float<class_float>` angle_to ( :ref:`Vector3<class_Vector3>` to )

Returns the minimum angle to the given vector.

---

• :ref:`Vector3<class_Vector3>` bounce ( :ref:`Vector3<class_Vector3>` n )

Returns the vector "bounced off" from a plane defined by the given normal.

---

• :ref:`Vector3<class_Vector3>` ceil ( )

Returns a new vector with all components rounded up.

---

• :ref:`Vector3<class_Vector3>` cross ( :ref:`Vector3<class_Vector3>` b )

Returns the cross product with b.

---

• :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>` t )

Performs a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount t. t is in the range of 0.0 - 1.0, representing the amount of interpolation.

---

• :ref:`Vector3<class_Vector3>` direction_to ( :ref:`Vector3<class_Vector3>` b )

Returns the normalized vector pointing from this vector to b.

---

• :ref:`float<class_float>` distance_squared_to ( :ref:`Vector3<class_Vector3>` b )

Returns the squared distance to b. Prefer this function over :ref:`distance_to<class_Vector3_method_distance_to>` if you need to sort vectors or need the squared distance for some formula.

---

• :ref:`float<class_float>` distance_to ( :ref:`Vector3<class_Vector3>` b )

Returns the distance to b.

---

• :ref:`float<class_float>` dot ( :ref:`Vector3<class_Vector3>` b )

Returns the dot product with b.

---

• :ref:`Vector3<class_Vector3>` floor ( )

Returns a new vector with all components rounded down.

---

• :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 ).

---

• :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.

---

• :ref:`bool<class_bool>` is_normalized ( )

Returns true if the vector is normalized.

---

• :ref:`float<class_float>` length ( )

Returns the vector's length.

---

• :ref:`float<class_float>` length_squared ( )

Returns the vector's length squared. Prefer this function over :ref:`length<class_Vector3_method_length>` if you need to sort vectors or need the squared length for some formula.

---

• :ref:`Vector3<class_Vector3>` linear_interpolate ( :ref:`Vector3<class_Vector3>` b, :ref:`float<class_float>` t )

Returns the result of the linear interpolation between this vector and b by amount t. t is in the range of 0.0 - 1.0, representing the amount of interpolation..

---

• :ref:`int<class_int>` max_axis ( )

Returns the axis of the vector's largest value. See AXIS_* constants.

---

• :ref:`int<class_int>` min_axis ( )

Returns the axis of the vector's smallest value. See AXIS_* constants.

---

• :ref:`Vector3<class_Vector3>` move_toward ( :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` delta )

Moves the vector toward to by the fixed delta amount.

---

• :ref:`Vector3<class_Vector3>` normalized ( )

Returns the vector scaled to unit length. Equivalent to v / v.length().

---

• :ref:`Basis<class_Basis>` outer ( :ref:`Vector3<class_Vector3>` b )

Returns the outer product with b.

---

• :ref:`Vector3<class_Vector3>` posmod ( :ref:`float<class_float>` mod )

Returns a vector composed of the fposmod of this vector's components and mod.

---

• :ref:`Vector3<class_Vector3>` posmodv ( :ref:`Vector3<class_Vector3>` modv )

Returns a vector composed of the fposmod of this vector's components and modv's components.

---

• :ref:`Vector3<class_Vector3>` project ( :ref:`Vector3<class_Vector3>` b )

Returns the vector projected onto the vector b.

---

• :ref:`Vector3<class_Vector3>` reflect ( :ref:`Vector3<class_Vector3>` n )

Returns the vector reflected from a plane defined by the given normal.

---

• :ref:`Vector3<class_Vector3>` rotated ( :ref:`Vector3<class_Vector3>` axis, :ref:`float<class_float>` phi )

Rotates the vector around a given axis by phi radians. The axis must be a normalized vector.

---

• :ref:`Vector3<class_Vector3>` round ( )

Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.

---

• :ref:`Vector3<class_Vector3>` sign ( )

Returns the vector with each component set to one or negative one, depending on the signs of the components.

---

• :ref:`Vector3<class_Vector3>` slerp ( :ref:`Vector3<class_Vector3>` b, :ref:`float<class_float>` t )

Returns the result of spherical linear interpolation between this vector and b, by amount t. t is in the range of 0.0 - 1.0, representing the amount of interpolation.

Note: Both vectors must be normalized.

---

• :ref:`Vector3<class_Vector3>` slide ( :ref:`Vector3<class_Vector3>` n )

Returns the component of the vector along a plane defined by the given normal.

---

• :ref:`Vector3<class_Vector3>` snapped ( :ref:`Vector3<class_Vector3>` by )

Returns a copy of the vector snapped to the lowest neared multiple.

---

• :ref:`Basis<class_Basis>` to_diagonal_matrix ( )

Returns a diagonal matrix with the vector as main diagonal.