Vector3
Vector class, which performs basic 3D vector math operations.
Properties
Vector3 ( x, float y, z ) | |
Vector3 | ( ) |
float | ( Vector3 to ) |
bounce ( n ) | |
Vector3 | ( ) |
Vector3 | ( Vector3 b ) |
cubic_interpolate ( b, Vector3 pre_a, post_b, float t ) | |
direction_to ( b ) | |
float | ( Vector3 b ) |
distance_to ( b ) | |
float | ( Vector3 b ) |
floor ( ) | |
inverse ( ) | |
is_normalized ( ) | |
length ( ) | |
length_squared ( ) | |
linear_interpolate ( b, float t ) | |
max_axis ( ) | |
min_axis ( ) | |
normalized ( ) | |
outer ( b ) | |
Vector3 | ( Vector3 b ) |
reflect ( n ) | |
Vector3 | ( Vector3 axis, phi ) |
Vector3 | ( ) |
Vector3 | ( Vector3 b, t ) |
Vector3 | ( Vector3 n ) |
snapped ( by ) | |
Basis | ( ) |
Constants
- AXIS_X = 0 — Enumerated value for the X axis. Returned by max_axis and .
- AXIS_Y = 1 — Enumerated value for the Y axis.
- AXIS_Z = 2 — Enumerated value for the Z axis.
- ZERO = Vector3( 0, 0, 0 ) — Zero vector.
- ONE = Vector3( 1, 1, 1 ) — One vector.
- INF = Vector3( inf, inf, inf ) — Infinite 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.
- FORWARD = Vector3( 0, 0, -1 ) — Forward unit vector.
- BACK = Vector3( 0, 0, 1 ) — Back unit vector.
Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations.
Tutorials
- x
The vector’s x component. Also accessible by using the index position .
- float y
The vector’s y component. Also accessible by using the index position [1]
.
- z
The vector’s z component. Also accessible by using the index position [2]
.
Method Descriptions
Returns a Vector3 with the given components.
- Vector3 abs ( )
Returns a new vector with all components in absolute values (i.e. positive).
- angle_to ( Vector3 to )
Returns the minimum angle to the given vector.
- bounce ( Vector3 n )
Returns the vector “bounced off” from a plane defined by the given normal.
- ceil ( )
Returns a new vector with all components rounded up.
- Vector3 cross ( b )
Returns the cross product with b
.
- direction_to ( Vector3 b )
Returns the normalized vector pointing from this vector to b
.
- distance_squared_to ( Vector3 b )
Returns the squared distance to b
. Prefer this function over if you need to sort vectors or need the squared distance for some formula.
- float distance_to ( b )
Returns the distance to b
.
- float dot ( b )
Returns the dot product with b
.
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 )
.
- is_normalized ( )
Returns true
if the vector is normalized.
- float length ( )
Returns the vector’s length.
- 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.
- linear_interpolate ( Vector3 b, t )
Returns the result of the linear interpolation between this vector and b
by amount t
. is in the range of 0.0 - 1.0
, representing the amount of interpolation..
- int max_axis ( )
Returns the axis of the vector’s largest value. See AXIS_*
constants.
- min_axis ( )
- Vector3 normalized ( )
Returns the vector scaled to unit length. Equivalent to v / v.length()
.
- outer ( Vector3 b )
Returns the outer product with b
.
- project ( Vector3 b )
Returns the vector projected onto the vector b
.
- reflect ( Vector3 n )
Returns the vector reflected from a plane defined by the given normal.
- rotated ( Vector3 axis, phi )
Rotates the vector around a given axis by phi
radians. The axis must be a normalized vector.
- Vector3 round ( )
Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
- slerp ( Vector3 b, t )
Returns the result of SLERP between this vector and b
, by amount t
. is in the range of 0.0 - 1.0
, representing the amount of interpolation.
Both vectors need to be normalized.
- Vector3 slide ( n )
Returns the component of the vector along a plane defined by the given normal.
- Vector3 snapped ( by )
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.