Struct Vector2SB
4-element structure that can be used to represent 4D grid coordinates or sets of integers.
[Serializable]
public struct Vector2SB : IEquatable<Vector2SB>- Implements
- Inherited Members
Constructors
Vector2SB(sbyte, sbyte)
Constructs a new Vector2SB with the given components.
public Vector2SB(sbyte x, sbyte y)Parameters
Fields
X
The vector's X component. Also accessible by using the index position [0].
public sbyte XField Value
Y
The vector's Y component. Also accessible by using the index position [1].
public sbyte YField Value
Properties
this[int]
Access vector components using their index.
public sbyte this[int index] { readonly get; set; }Parameters
indexint
Property Value
Exceptions
- ArgumentOutOfRangeException
indexis not 0, 1.
MaxValue
Max vector, a vector with all components equal to MaxValue.
public static Vector2SB MaxValue { get; }Property Value
- Vector2SB
Equivalent to
new Vector2SB(sbyte.MaxValue, sbyte.MaxValue, sbyte.MaxValue, sbyte.MaxValue).
MinValue
Min vector, a vector with all components equal to MinValue.
public static Vector2SB MinValue { get; }Property Value
- Vector2SB
Equivalent to
new Vector2SB(sbyte.MinValue, sbyte.MinValue, sbyte.MinValue, sbyte.MinValue).
One
One vector, a vector with all components set to 1.
public static Vector2SB One { get; }Property Value
- Vector2SB
Equivalent to
new Vector2SB(1, 1, 1, 1).
UnitW
W-facing unit vector. (0 0 0 1)
public static Vector2SB UnitW { get; }Property Value
UnitX
X-facing unit vector. (1 0 0 0)
public static Vector2SB UnitX { get; }Property Value
UnitY
Y-facing unit vector. (0 1 0 0)
public static Vector2SB UnitY { get; }Property Value
UnitZ
Z-facing unit vector. (0 0 1 0)
public static Vector2SB UnitZ { get; }Property Value
Zero
Zero vector, a vector with all components set to 0.
public static Vector2SB Zero { get; }Property Value
- Vector2SB
Equivalent to
new Vector2SB(0, 0, 0, 0).
Methods
Abs()
Returns a new vector with all components in absolute values (i.e. positive).
public readonly Vector2SB Abs()Returns
Clamp(Vector2SB, Vector2SB)
Returns a new vector with all components clamped between the
components of min and max using
Clamp(int, int, int).
public readonly Vector2SB Clamp(Vector2SB min, Vector2SB max)Parameters
minVector2SBThe vector with minimum allowed values.
maxVector2SBThe vector with maximum allowed values.
Returns
- Vector2SB
The vector with all components clamped.
Deconstruct(out int, out int)
Helper method for deconstruction into a tuple.
public readonly void Deconstruct(out int x, out int y)Parameters
DistanceSquaredTo(Vector2SB)
Returns the squared distance between this vector and to.
This method runs faster than DistanceTo(Vector2SB), so prefer it if
you need to compare vectors or need the squared distance for some formula.
public readonly int DistanceSquaredTo(Vector2SB to)Parameters
toVector2SBThe other vector to use.
Returns
- int
The squared distance between the two vectors.
DistanceTo(Vector2SB)
Returns the distance between this vector and to.
public readonly float DistanceTo(Vector2SB to)Parameters
toVector2SBThe other vector to use.
Returns
- float
The distance between the two vectors.
- See Also
Equals(Vector2SB)
Returns true if the vectors are equal.
public readonly bool Equals(Vector2SB other)Parameters
otherVector2SBThe 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 Vector2SB.
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 W.
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 Vector2SB Sign()Returns
- Vector2SB
A vector with all components as either
1,-1, or0.
ToString()
Converts this Vector2SB to a string.
public override readonly string ToString()Returns
- string
A string representation of this vector.
ToString(string?)
Converts this Vector2SB 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 +(Vector2SB, Vector2SB)
public static Vector2SB operator +(Vector2SB left, Vector2SB right)Parameters
Returns
- Vector2SB
The added vector.
operator /(Vector2SB, Vector2SB)
public static Vector2SB operator /(Vector2SB vec, Vector2SB divisorv)Parameters
Returns
- Vector2SB
The divided vector.
operator /(Vector2SB, int)
public static Vector2SB operator /(Vector2SB vec, int divisor)Parameters
Returns
- Vector2SB
The divided vector.
operator ==(Vector2SB, Vector2SB)
Returns true if the vectors are equal.
public static bool operator ==(Vector2SB left, Vector2SB right)Parameters
Returns
- bool
Whether or not the vectors are equal.
explicit operator Vector2SB(Vector2)
Converts a Vector4 to a Vector2SB by truncating components' fractional parts (rounding towards zero).
public static explicit operator Vector2SB(Vector2 value)Parameters
valueVector2The vector to convert.
Returns
operator >(Vector2SB, Vector2SB)
Compares two Vector2SB 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 >(Vector2SB left, Vector2SB right)Parameters
Returns
- bool
Whether or not the left is greater than the right.
operator >=(Vector2SB, Vector2SB)
Compares two Vector2SB 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 >=(Vector2SB left, Vector2SB right)Parameters
Returns
- bool
Whether or not the left is greater than or equal to the right.
implicit operator Vector2(Vector2SB)
public static implicit operator Vector2(Vector2SB value)Parameters
valueVector2SBThe vector to convert.
Returns
operator !=(Vector2SB, Vector2SB)
Returns true if the vectors are not equal.
public static bool operator !=(Vector2SB left, Vector2SB right)Parameters
Returns
- bool
Whether or not the vectors are not equal.
operator <(Vector2SB, Vector2SB)
Compares two Vector2SB 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 <(Vector2SB left, Vector2SB right)Parameters
Returns
- bool
Whether or not the left is less than the right.
operator <=(Vector2SB, Vector2SB)
Compares two Vector2SB 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 <=(Vector2SB left, Vector2SB right)Parameters
Returns
- bool
Whether or not the left is less than or equal to the right.
operator %(Vector2SB, Vector2SB)
Gets the remainder of each component of the Vector2SB with the components of the given Vector2SB. This operation uses truncated division, which is often not desired as it does not work well with negative numbers.
public static Vector2SB operator %(Vector2SB vec, Vector2SB divisorv)Parameters
Returns
- Vector2SB
The remainder vector.
Examples
GD.Print(new Vector4UB(10, -20, 30, -40) % new Vector4UB(6, 7, 8, 9)); // Prints "(4, -6, 6, -4)"operator %(Vector2SB, int)
Gets the remainder of each component of the Vector2SB 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 Vector2SB operator %(Vector2SB vec, int divisor)Parameters
Returns
- Vector2SB
The remainder vector.
Examples
GD.Print(new Vector4UB(10, -20, 30, -40) % 7); // Prints "(3, -6, 2, -5)"operator *(Vector2SB, Vector2SB)
public static Vector2SB operator *(Vector2SB left, Vector2SB right)Parameters
Returns
- Vector2SB
The multiplied vector.
operator *(Vector2SB, int)
public static Vector2SB operator *(Vector2SB vec, int scale)Parameters
Returns
- Vector2SB
The multiplied vector.
operator *(int, Vector2SB)
public static Vector2SB operator *(int scale, Vector2SB vec)Parameters
Returns
- Vector2SB
The multiplied vector.
operator -(Vector2SB, Vector2SB)
public static Vector2SB operator -(Vector2SB left, Vector2SB right)Parameters
Returns
- Vector2SB
The subtracted vector.
operator -(Vector2SB)
Returns the negative value of the Vector2SB.
This is the same as writing new Vector4UB(-v.X, -v.Y, -v.Z, -v.W).
This operation flips the direction of the vector while
keeping the same magnitude.
public static Vector2SB operator -(Vector2SB vec)Parameters
vecVector2SBThe vector to negate/flip.
Returns
- Vector2SB
The negated/flipped vector.