Vector2

Category: Built-In Types

Brief Description

Vector used for 2D math.

Properties

float x
float y

Constants

  • ZERO = Vector2( 0, 0 ) — Null vector.
  • INF = Vector2( inf, inf ) — Infinite vector.
  • LEFT = Vector2( -1, 0 ) — Left unit vector.
  • RIGHT = Vector2( 1, 0 ) — Right unit vector.
  • UP = Vector2( 0, -1 ) — Up unit vector.
  • DOWN = Vector2( 0, 1 ) — Down unit vector.

Description

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

Tutorials

Property Descriptions

The vector’s x component.

The vector’s y component.

Method Descriptions

Constructs a new Vector2 from the given x and y.

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

Returns the vector’s angle in radians with respect to the x-axis, or (1, 0) vector.

Equivalent to the result of atan2 when called with the vector’s x and y as parameters: atan2(x, y).

Returns the angle in radians between the two vectors.

Returns the angle in radians between the line connecting the two points and the x coordinate.

Returns the ratio of x to y.

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

Returns the vector with all components rounded up.

Returns the vector with a maximum length.

Returns the 2 dimensional analog of the cross product with the given vector.

Cubicly interpolates between this vector and b using pre_a and post_b as handles, and returns the result at position t. t is in the range of 0.0 - 1.0, representing the amount of interpolation.

Returns the squared distance to vector 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 vector b.

Returns the dot product with vector b.

Returns the vector with all components rounded down.

  • bool is_normalized ( )

Returns true if the vector is normalized.

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. t is in the range of 0.0 - 1.0, representing the amount of interpolation.

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

Returns the vector projected onto the vector b.

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

Returns the vector rotated by phi radians.

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

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

Both vectors need to be normalized.

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

Returns the vector snapped to a grid with the given size.

Returns a perpendicular vector.