Vector4i

Vector used for 4D math using integer coordinates.

Description

4-element structure that can be used to represent 4D grid coordinates or sets of integers.

It uses integer coordinates. See Vector4 for its floating-point counterpart.

Properties

int

w

0

int

x

0

int

y

0

int

z

0

Constructors

Vector4i

Vector4i ( )

Vector4i

Vector4i ( Vector4i from )

Vector4i

Vector4i ( Vector4 from )

Vector4i

Vector4i ( int x, int y, int z, int w )

Methods

Vector4i

abs ( ) const

Vector4i

clamp ( Vector4i min, Vector4i max ) const

float

length ( ) const

int

length_squared ( ) const

int

max_axis_index ( ) const

int

min_axis_index ( ) const

Vector4i

sign ( ) const

Operators

bool

operator != ( Vector4i right )

Vector4i

operator % ( Vector4i right )

Vector4i

operator % ( int right )

Vector4i

operator * ( Vector4i right )

Vector4

operator * ( float right )

Vector4i

operator * ( int right )

Vector4i

operator + ( Vector4i right )

Vector4i

operator - ( Vector4i right )

Vector4i

operator / ( Vector4i right )

Vector4

operator / ( float right )

Vector4i

operator / ( int right )

bool

operator < ( Vector4i right )

bool

operator <= ( Vector4i right )

bool

operator == ( Vector4i right )

bool

operator > ( Vector4i right )

bool

operator >= ( Vector4i right )

int

operator [] ( int index )

Vector4i

operator unary+ ( )

Vector4i

operator unary- ( )

Constants

Property Descriptions

Default

0

The vector's W component. Also accessible by using the index position [3].


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].


Default

0

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

Constructor Descriptions

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


Constructs a Vector4i as a copy of the given Vector4i.


Constructs a new Vector4i from the given Vector4.


Returns a Vector4i with the given components.

Method Descriptions

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


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.


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


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

Returns true if the vectors are not equal.




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

print(Vector4i(10, 20, 30, 40) * Vector4i(3, 4, 5, 6)) # Prints "(30, 80, 150, 240)"

Multiplies each component of the Vector4i by the given float.

Returns a Vector4 value due to floating-point operations.

print(Vector4i(10, 20, 30, 40) * 2) # Prints "(20, 40, 60, 80)"

Multiplies each component of the Vector4i by the given int.


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

print(Vector4i(10, 20, 30, 40) + Vector4i(3, 4, 5, 6)) # Prints "(13, 24, 35, 46)"

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

print(Vector4i(10, 20, 30, 40) - Vector4i(3, 4, 5, 6)) # Prints "(7, 16, 25, 34)"

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

print(Vector4i(10, 20, 30, 40) / Vector4i(2, 5, 3, 4)) # Prints "(5, 4, 10, 10)"

Divides each component of the Vector4i by the given float.

Returns a Vector4 value due to floating-point operations.

print(Vector4i(10, 20, 30, 40) / 2 # Prints "(5, 10, 15, 20)"

Divides each component of the Vector4i by the given int.


Compares two Vector4i 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, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.


Compares two Vector4i 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, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.


Returns true if the vectors are exactly equal.


Compares two Vector4i 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, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.


Compares two Vector4i 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, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.


  • int operator [] ( int index )

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


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 Vector4i. This is the same as writing Vector4i(-v.x, -v.y, -v.z, -v.w). This operation flips the direction of the vector while keeping the same magnitude.