Struct Vector4I
- Namespace
- Godot
- Assembly
- GodotSharp.dll
4-element structure that can be used to represent 4D grid coordinates or sets of integers.
public struct Vector4I : IEquatable<Vector4I>- Implements
- Inherited Members
Constructors
Vector4I(int, int, int, int)
Constructs a new Vector4I with the given components.
public Vector4I(int x, int y, int z, int w)Parameters
xintThe vector's X component.
yintThe vector's Y component.
zintThe vector's Z component.
wintThe vector's W component.
Fields
W
The vector's W component. Also accessible by using the index position [3].
public int WField Value
X
The vector's X component. Also accessible by using the index position [0].
public int XField Value
Y
The vector's Y component. Also accessible by using the index position [1].
public int YField Value
Z
The vector's Z component. Also accessible by using the index position [2].
public int ZField Value
Properties
this[int]
Access vector components using their index.
public int this[int index] { readonly get; set; }Parameters
indexint
Property Value
Exceptions
- ArgumentOutOfRangeException
indexis not 0, 1, 2 or 3.
MaxValue
Max vector, a vector with all components equal to MaxValue. Can be used as an integer equivalent of Inf.
public static Vector4I MaxValue { get; }Property Value
- Vector4I
Equivalent to
new Vector4I(int.MaxValue, int.MaxValue, int.MaxValue, int.MaxValue).
MinValue
Min vector, a vector with all components equal to MinValue. Can be used as a negative integer equivalent of Inf.
public static Vector4I MinValue { get; }Property Value
- Vector4I
Equivalent to
new Vector4I(int.MinValue, int.MinValue, int.MinValue, int.MinValue).
One
One vector, a vector with all components set to 1.
public static Vector4I One { get; }Property Value
- Vector4I
Equivalent to
new Vector4I(1, 1, 1, 1).
Zero
Zero vector, a vector with all components set to 0.
public static Vector4I Zero { get; }Property Value
- Vector4I
Equivalent to
new Vector4I(0, 0, 0, 0).
Methods
Abs()
Returns a new vector with all components in absolute values (i.e. positive).
public readonly Vector4I Abs()Returns
Clamp(Vector4I, Vector4I)
Returns a new vector with all components clamped between the
components of min and max using
Clamp(int, int, int).
public readonly Vector4I Clamp(Vector4I min, Vector4I max)Parameters
minVector4IThe vector with minimum allowed values.
maxVector4IThe vector with maximum allowed values.
Returns
- Vector4I
The vector with all components clamped.
Deconstruct(out int, out int, out int, out int)
Helper method for deconstruction into a tuple.
public readonly void Deconstruct(out int x, out int y, out int z, out int w)Parameters
Equals(Vector4I)
Returns true if the vectors are equal.
public readonly bool Equals(Vector4I other)Parameters
otherVector4IThe other vector.
Returns
- bool
Whether or not the vectors are equal.
Equals(object)
Returns true if the vector is equal
to the given object (obj).
public override readonly bool Equals(object obj)Parameters
objobjectThe object to compare with.
Returns
- bool
Whether or not the vector and the object are equal.
GetHashCode()
Serves as the hash function for Vector4I.
public override readonly int GetHashCode()Returns
- int
A hash code for this vector.
Length()
Returns the length (magnitude) of this vector.
public readonly float Length()Returns
- float
The length of this vector.
- See Also
LengthSquared()
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 length for some formula.
public readonly int LengthSquared()Returns
- int
The squared length of this vector.
MaxAxisIndex()
Returns the axis of the vector's highest value. See Vector4I.Axis. If all components are equal, this method returns X.
public readonly Vector4I.Axis MaxAxisIndex()Returns
MinAxisIndex()
Returns the axis of the vector's lowest value. See Vector4I.Axis. If all components are equal, this method returns W.
public readonly Vector4I.Axis MinAxisIndex()Returns
Sign()
Returns a vector with each component set to one or negative one, depending on the signs of this vector's components, or zero if the component is zero, by calling Sign(int) on each component.
public readonly Vector4I Sign()Returns
- Vector4I
A vector with all components as either
1,-1, or0.
ToString()
Converts this Vector4I to a string.
public override readonly string ToString()Returns
- string
A string representation of this vector.
ToString(string)
Converts this Vector4I to a string with the given format.
public readonly string ToString(string format)Parameters
formatstring
Returns
- string
A string representation of this vector.
Operators
operator +(Vector4I, Vector4I)
public static Vector4I operator +(Vector4I left, Vector4I right)Parameters
Returns
- Vector4I
The added vector.
operator /(Vector4I, Vector4I)
public static Vector4I operator /(Vector4I vec, Vector4I divisorv)Parameters
Returns
- Vector4I
The divided vector.
operator /(Vector4I, int)
public static Vector4I operator /(Vector4I vec, int divisor)Parameters
Returns
- Vector4I
The divided vector.
operator ==(Vector4I, Vector4I)
Returns true if the vectors are equal.
public static bool operator ==(Vector4I left, Vector4I right)Parameters
Returns
- bool
Whether or not the vectors are equal.
explicit operator Vector4I(Vector4)
Converts a Vector4 to a Vector4I by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of Ceil(), Floor() or Round() to this conversion operator instead.
public static explicit operator Vector4I(Vector4 value)Parameters
valueVector4The vector to convert.
Returns
operator >(Vector4I, Vector4I)
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, Z and finally W values of the two vectors.
This operator is useful for sorting vectors.
public static bool operator >(Vector4I left, Vector4I right)Parameters
Returns
- bool
Whether or not the left is greater than the right.
operator >=(Vector4I, Vector4I)
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, Z and finally W values of the two vectors.
This operator is useful for sorting vectors.
public static bool operator >=(Vector4I left, Vector4I right)Parameters
Returns
- bool
Whether or not the left is greater than or equal to the right.
implicit operator Vector4(Vector4I)
public static implicit operator Vector4(Vector4I value)Parameters
valueVector4IThe vector to convert.
Returns
operator !=(Vector4I, Vector4I)
Returns true if the vectors are not equal.
public static bool operator !=(Vector4I left, Vector4I right)Parameters
Returns
- bool
Whether or not the vectors are not equal.
operator <(Vector4I, Vector4I)
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, Z and finally W values of the two vectors.
This operator is useful for sorting vectors.
public static bool operator <(Vector4I left, Vector4I right)Parameters
Returns
- bool
Whether or not the left is less than the right.
operator <=(Vector4I, Vector4I)
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, Z and finally W values of the two vectors.
This operator is useful for sorting vectors.
public static bool operator <=(Vector4I left, Vector4I right)Parameters
Returns
- bool
Whether or not the left is less than or equal to the right.
operator %(Vector4I, Vector4I)
Gets the remainder of each component of the Vector4I with the components of the given Vector4I. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using PosMod(int, int) instead if you want to handle negative numbers.
public static Vector4I operator %(Vector4I vec, Vector4I divisorv)Parameters
Returns
- Vector4I
The remainder vector.
Examples
GD.Print(new Vector4I(10, -20, 30, -40) % new Vector4I(6, 7, 8, 9)); // Prints "(4, -6, 6, -4)"operator %(Vector4I, int)
Gets the remainder of each component of the Vector4I with the components of the given int. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using PosMod(int, int) instead if you want to handle negative numbers.
public static Vector4I operator %(Vector4I vec, int divisor)Parameters
Returns
- Vector4I
The remainder vector.
Examples
GD.Print(new Vector4I(10, -20, 30, -40) % 7); // Prints "(3, -6, 2, -5)"operator *(Vector4I, Vector4I)
public static Vector4I operator *(Vector4I left, Vector4I right)Parameters
Returns
- Vector4I
The multiplied vector.
operator *(Vector4I, int)
public static Vector4I operator *(Vector4I vec, int scale)Parameters
Returns
- Vector4I
The multiplied vector.
operator *(int, Vector4I)
public static Vector4I operator *(int scale, Vector4I vec)Parameters
Returns
- Vector4I
The multiplied vector.
operator -(Vector4I, Vector4I)
public static Vector4I operator -(Vector4I left, Vector4I right)Parameters
Returns
- Vector4I
The subtracted vector.
operator -(Vector4I)
Returns the negative value of the Vector4I.
This is the same as writing new Vector4I(-v.X, -v.Y, -v.Z, -v.W).
This operation flips the direction of the vector while
keeping the same magnitude.
public static Vector4I operator -(Vector4I vec)Parameters
vecVector4IThe vector to negate/flip.
Returns
- Vector4I
The negated/flipped vector.