Struct Vector3I
3-element structure that can be used to represent 3D grid coordinates or sets of integers.
[Serializable]
public struct Vector3I : IEquatable<Vector3I>- Implements
- Inherited Members
Constructors
Vector3I(int, int, int)
Constructs a new Vector3I with the given components.
public Vector3I(int x, int y, int z)Parameters
Fields
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 or 2.
MaxValue
Max vector, a vector with all components equal to MaxValue.
public static Vector3I MaxValue { get; }Property Value
- Vector3I
Equivalent to
new Vector3I(int.MaxValue, int.MaxValue, int.MaxValue).
MinValue
Min vector, a vector with all components equal to MinValue.
public static Vector3I MinValue { get; }Property Value
- Vector3I
Equivalent to
new Vector3I(int.MinValue, int.MinValue, int.MinValue).
One
One vector, a vector with all components set to 1.
public static Vector3I One { get; }Property Value
- Vector3I
Equivalent to
new Vector3I(1, 1, 1).
UnitX
X-facing unit vector. (1 0 0)
public static Vector3I UnitX { get; }Property Value
UnitY
Y-facing unit vector. (0 1 0)
public static Vector3I UnitY { get; }Property Value
UnitZ
Z-facing unit vector. (0 0 1)
public static Vector3I UnitZ { get; }Property Value
Zero
Zero vector, a vector with all components set to 0.
public static Vector3I Zero { get; }Property Value
- Vector3I
Equivalent to
new Vector3I(0, 0, 0).
Methods
Abs()
Returns a new vector with all components in absolute values (i.e. positive).
public readonly Vector3I Abs()Returns
Clamp(Vector3I, Vector3I)
Returns a new vector with all components clamped between the
components of min and max using
Clamp(int, int, int).
public readonly Vector3I Clamp(Vector3I min, Vector3I max)Parameters
minVector3IThe vector with minimum allowed values.
maxVector3IThe vector with maximum allowed values.
Returns
- Vector3I
The vector with all components clamped.
Deconstruct(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)Parameters
DistanceSquaredTo(Vector3I)
Returns the squared distance between this vector and to.
This method runs faster than DistanceTo(Vector3I), so prefer it if
you need to compare vectors or need the squared distance for some formula.
public readonly int DistanceSquaredTo(Vector3I to)Parameters
toVector3IThe other vector to use.
Returns
- int
The squared distance between the two vectors.
DistanceTo(Vector3I)
Returns the distance between this vector and to.
public readonly float DistanceTo(Vector3I to)Parameters
toVector3IThe other vector to use.
Returns
- float
The distance between the two vectors.
- See Also
Equals(Vector3I)
Returns true if the vectors are equal.
public readonly bool Equals(Vector3I other)Parameters
otherVector3IThe 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 Vector3I.
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 Axis. If all components are equal, this method returns X.
public readonly Axis MaxAxisIndex()Returns
- Axis
The index of the highest axis.
MinAxisIndex()
Returns the axis of the vector's lowest value. See Axis. If all components are equal, this method returns Z.
public readonly Axis MinAxisIndex()Returns
- Axis
The index of the lowest axis.
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 Vector3I Sign()Returns
- Vector3I
A vector with all components as either
1,-1, or0.
ToString()
Converts this Vector3I to a string.
public override readonly string ToString()Returns
- string
A string representation of this vector.
ToString(string?)
Converts this Vector3I 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 +(Vector3I, Vector3I)
public static Vector3I operator +(Vector3I left, Vector3I right)Parameters
Returns
- Vector3I
The added vector.
operator /(Vector3I, Vector3I)
public static Vector3I operator /(Vector3I vec, Vector3I divisorv)Parameters
Returns
- Vector3I
The divided vector.
operator /(Vector3I, int)
public static Vector3I operator /(Vector3I vec, int divisor)Parameters
Returns
- Vector3I
The divided vector.
operator ==(Vector3I, Vector3I)
Returns true if the vectors are equal.
public static bool operator ==(Vector3I left, Vector3I right)Parameters
Returns
- bool
Whether or not the vectors are equal.
explicit operator Vector3I(Vector3)
Converts a Vector3 to a Vector3I by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of Ceil(Vector3) or Round(Vector3) to this conversion operator instead.
public static explicit operator Vector3I(Vector3 value)Parameters
valueVector3The vector to convert.
Returns
operator >(Vector3I, Vector3I)
Compares two Vector3I 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, and then with the Z values.
This operator is useful for sorting vectors.
public static bool operator >(Vector3I left, Vector3I right)Parameters
Returns
- bool
Whether or not the left is greater than the right.
operator >=(Vector3I, Vector3I)
Compares two Vector3I 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, and then with the Z values.
This operator is useful for sorting vectors.
public static bool operator >=(Vector3I left, Vector3I right)Parameters
Returns
- bool
Whether or not the left is greater than or equal to the right.
implicit operator Vector3(Vector3I)
public static implicit operator Vector3(Vector3I value)Parameters
valueVector3IThe vector to convert.
Returns
operator !=(Vector3I, Vector3I)
Returns true if the vectors are not equal.
public static bool operator !=(Vector3I left, Vector3I right)Parameters
Returns
- bool
Whether or not the vectors are not equal.
operator <(Vector3I, Vector3I)
Compares two Vector3I 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, and then with the Z values.
This operator is useful for sorting vectors.
public static bool operator <(Vector3I left, Vector3I right)Parameters
Returns
- bool
Whether or not the left is less than the right.
operator <=(Vector3I, Vector3I)
Compares two Vector3I 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, and then with the Z values.
This operator is useful for sorting vectors.
public static bool operator <=(Vector3I left, Vector3I right)Parameters
Returns
- bool
Whether or not the left is less than or equal to the right.
operator %(Vector3I, Vector3I)
Gets the remainder of each component of the Vector3I with the components of the given Vector3I. This operation uses truncated division, which is often not desired as it does not work well with negative numbers.
public static Vector3I operator %(Vector3I vec, Vector3I divisorv)Parameters
Returns
- Vector3I
The remainder vector.
Examples
GD.Print(new Vector3I(10, -20, 30) % new Vector3I(7, 8, 9)); // Prints "(3, -4, 3)"operator %(Vector3I, int)
Gets the remainder of each component of the Vector3I 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.
public static Vector3I operator %(Vector3I vec, int divisor)Parameters
Returns
- Vector3I
The remainder vector.
Examples
GD.Print(new Vector3I(10, -20, 30) % 7); // Prints "(3, -6, 2)"operator *(Vector3I, Vector3I)
public static Vector3I operator *(Vector3I left, Vector3I right)Parameters
Returns
- Vector3I
The multiplied vector.
operator *(Vector3I, int)
public static Vector3I operator *(Vector3I vec, int scale)Parameters
Returns
- Vector3I
The multiplied vector.
operator *(int, Vector3I)
public static Vector3I operator *(int scale, Vector3I vec)Parameters
Returns
- Vector3I
The multiplied vector.
operator -(Vector3I, Vector3I)
public static Vector3I operator -(Vector3I left, Vector3I right)Parameters
Returns
- Vector3I
The subtracted vector.
operator -(Vector3I)
Returns the negative value of the Vector3I.
This is the same as writing new Vector3I(-v.X, -v.Y, -v.Z).
This operation flips the direction of the vector while
keeping the same magnitude.
public static Vector3I operator -(Vector3I vec)Parameters
vecVector3IThe vector to negate/flip.
Returns
- Vector3I
The negated/flipped vector.