Category: Built-In Types
Vector class, which performs basic 3D vector math operations.
|Vector3||Vector3 ( float x, float y, float z )|
|Vector3||abs ( )|
|float||angle_to ( Vector3 to )|
|Vector3||bounce ( Vector3 n )|
|Vector3||ceil ( )|
|Vector3||cross ( Vector3 b )|
|Vector3||cubic_interpolate ( Vector3 b, Vector3 pre_a, Vector3 post_b, float t )|
|float||distance_squared_to ( Vector3 b )|
|float||distance_to ( Vector3 b )|
|float||dot ( Vector3 b )|
|Vector3||floor ( )|
|Vector3||inverse ( )|
|bool||is_normalized ( )|
|float||length ( )|
|float||length_squared ( )|
|Vector3||linear_interpolate ( Vector3 b, float t )|
|int||max_axis ( )|
|int||min_axis ( )|
|Vector3||normalized ( )|
|Basis||outer ( Vector3 b )|
|Vector3||reflect ( Vector3 n )|
|Vector3||rotated ( Vector3 axis, float phi )|
|Vector3||round ( )|
|Vector3||slerp ( Vector3 b, float t )|
|Vector3||slide ( Vector3 n )|
|Vector3||snapped ( Vector3 by )|
|Basis||to_diagonal_matrix ( )|
Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations.
Member Function Description¶
Returns a Vector3 with the given components.
- Vector3 abs ( )
Returns a new vector with all components in absolute values (i.e. positive).
Returns the minimum angle to the given vector.
Returns the vector “bounced off” from a plane defined by the given normal.
- Vector3 ceil ( )
Returns a new vector with all components rounded up.
Returns the cross product with
Performs a cubic interpolation between vectors
a is current), by the given amount (t). (t) should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
Returns the squared distance to
b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula.
Returns the distance to
Returns the dot product with
- Vector3 floor ( )
Returns a new vector with all components rounded down.
- 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 ).
- bool is_normalized ( )
true if the vector is normalized.
- float length ( )
Returns the vector’s length.
- float length_squared ( )
Returns the vector’s length squared. Prefer this function over length if you need to sort vectors or need the squared length for some formula.
Returns the result of the linear interpolation between this vector and
b by amount
t is in the range of
0.0 - 1.0, a percentage of how far along the interpolation is.
- int max_axis ( )
Returns the axis of the vector’s largest value. See
- int min_axis ( )
Returns the axis of the vector’s smallest value. See
- Vector3 normalized ( )
Returns the vector scaled to unit length. Equivalent to
v / v.length().
Returns the outer product with
Returns the vector reflected from a plane defined by the given normal.
Rotates the vector around a given axis by
phi radians. The axis must be a normalized vector.
- Vector3 round ( )
Returns the result of SLERP between this vector and “b”, by amount “t”. “t” should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
Both vectors need to be normalized.
Returns the component of the vector along a plane defined by the given normal.
Returns a copy of the vector, snapped to the lowest neared multiple.
- Basis to_diagonal_matrix ( )
Returns a diagonal matrix with the vector as main diagonal.