Vector2i

Vector used for 2D math using integer coordinates.

Description

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

It uses integer coordinates and is therefore preferable to Vector2 when exact precision is required.

Note: In a boolean context, a Vector2i will evaluate to false if it's equal to Vector2i(0, 0). Otherwise, a Vector2i will always evaluate to true.

Tutorials

Properties

int

x

0

int

y

0

Constructors

Vector2i

Vector2i ( )

Vector2i

Vector2i ( Vector2i from )

Vector2i

Vector2i ( Vector2 from )

Vector2i

Vector2i ( int x, int y )

Methods

Vector2i

abs ( ) const

float

aspect ( ) const

Vector2i

clamp ( Vector2i min, Vector2i max ) const

float

length ( ) const

int

length_squared ( ) const

int

max_axis_index ( ) const

int

min_axis_index ( ) const

Vector2i

sign ( ) const

Operators

bool

operator != ( )

bool

operator != ( Vector2i right )

Vector2i

operator % ( Vector2i right )

Vector2i

operator % ( int right )

Vector2i

operator * ( Vector2i right )

Vector2

operator * ( float right )

Vector2i

operator * ( int right )

Vector2i

operator + ( Vector2i right )

Vector2i

operator - ( Vector2i right )

Vector2i

operator / ( Vector2i right )

Vector2

operator / ( float right )

Vector2i

operator / ( int right )

bool

operator ( Vector2i right )

bool

operator ( Vector2i right )

bool

operator == ( )

bool

operator == ( Vector2i right )

bool

operator > ( Vector2i right )

bool

operator >= ( Vector2i right )

int

operator [] ( int index )

Vector2i

operator unary+ ( )

Vector2i

operator unary- ( )

Constants

  • AXIS_X = 0 --- Enumerated value for the X axis. Returned by max_axis_index and min_axis_index.

  • AXIS_Y = 1 --- Enumerated value for the Y axis. Returned by max_axis_index and min_axis_index.

  • ZERO = Vector2i(0, 0) --- Zero vector, a vector with all components set to 0.

  • ONE = Vector2i(1, 1) --- One vector, a vector with all components set to 1.

  • LEFT = Vector2i(-1, 0) --- Left unit vector. Represents the direction of left.

  • RIGHT = Vector2i(1, 0) --- Right unit vector. Represents the direction of right.

  • UP = Vector2i(0, -1) --- Up unit vector. Y is down in 2D, so this vector points -Y.

  • DOWN = Vector2i(0, 1) --- Down unit vector. Y is down in 2D, so this vector points +Y.

Property Descriptions

Default

0

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


Default

0

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

Constructor Descriptions

Constructs a default-initialized Vector2i with all components set to 0.


Constructs a Vector2i as a copy of the given Vector2i.


Constructs a new Vector2i from Vector2. The floating point coordinates will be truncated.


Constructs a new Vector2i from the given x and y.

Method Descriptions

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


Returns the aspect ratio of this vector, the ratio of x to y.


Returns a new vector with all components clamped between the components of min and max, by running @GlobalScope.clamp on each component.


Returns the length (magnitude) of this vector.


  • int length_squared ( ) const

Returns the squared length (squared magnitude) of this vector.

This method runs faster than length, so prefer it if you need to compare vectors or need the squared distance for some formula.


  • int max_axis_index ( ) const

Returns the axis of the vector's highest value. See AXIS_* constants. If all components are equal, this method returns AXIS_X.


  • int min_axis_index ( ) const

Returns the axis of the vector's lowest value. See AXIS_* constants. If all components are equal, this method returns AXIS_Y.


Returns a new vector with each component set to one or negative one, depending on the signs of the components, or zero if the component is zero, by calling @GlobalScope.sign on each component.

Operator Descriptions

  • bool operator != ( )


Returns true if the vectors are not equal.


Gets the remainder of each component of the Vector2i with the components of the given Vector2i. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using @GlobalScope.posmod instead if you want to handle negative numbers.

print(Vector2i(10, -20) % Vector2i(7, 8)) # Prints "(3, -4)"

Gets the remainder of each component of the Vector2i with the the given int. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using @GlobalScope.posmod instead if you want to handle negative numbers.

print(Vector2i(10, -20) % 7) # Prints "(3, -6)"

Multiplies each component of the Vector2i by the components of the given Vector2i.

print(Vector2i(10, 20) * Vector2i(3, 4)) # Prints "(30, 80)"

Multiplies each component of the Vector2i by the given float. Returns a Vector2.

print(Vector2i(10, 15) * 0.9) # Prints "(9, 13.5)"

Multiplies each component of the Vector2i by the given int.


Adds each component of the Vector2i by the components of the given Vector2i.

print(Vector2i(10, 20) + Vector2i(3, 4)) # Prints "(13, 24)"

Subtracts each component of the Vector2i by the components of the given Vector2i.

print(Vector2i(10, 20) - Vector2i(3, 4)) # Prints "(7, 16)"

Divides each component of the Vector2i by the components of the given Vector2i.

print(Vector2i(10, 20) / Vector2i(2, 5)) # Prints "(5, 4)"

Divides each component of the Vector2i by the given float. Returns a Vector2.

print(Vector2i(10, 20) / 2.9) # Prints "(5, 10)"

Divides each component of the Vector2i by the given int.


Compares two Vector2i vectors by first checking if the X value of the left vector is less than the X value of the right vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors.


Compares two Vector2i vectors by first checking if the X value of the left vector is less than or equal to the X value of the right vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors.


  • bool operator == ( )


Returns true if the vectors are equal.


Compares two Vector2i vectors by first checking if the X value of the left vector is greater than the X value of the right vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors.


Compares two Vector2i vectors by first checking if the X value of the left vector is greater than or equal to the X value of the right vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors. This operator is useful for sorting vectors.


  • int operator [] ( int index )

Access vector components using their index. v[0] is equivalent to v.x, and v[1] is equivalent to v.y.


Returns the same value as if the + was not there. Unary + does nothing, but sometimes it can make your code more readable.


Returns the negative value of the Vector2i. This is the same as writing Vector2i(-v.x, -v.y). This operation flips the direction of the vector while keeping the same magnitude.