Struct Vector4I

Namespace: Elegy.Common.Maths

Assembly: Elegy.Common.dll

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

[Serializable]
public struct Vector4I : IEquatable<Vector4I>

Implements: IEquatable<Vector4I>

Inherited Members: object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

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

x int: The vector's X component.
y int: The vector's Y component.
z int: The vector's Z component.
w int: The vector's W component.

Fields

W

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

public int W

Field Value

int

X

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

public int X

Field Value

int

Y

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

public int Y

Field Value

int

Z

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

public int Z

Field Value

int

Properties

this[int]

Access vector components using their index.

public int this[int index] { readonly get; set; }

Parameters

index int

Property Value

int: [0] is equivalent to X, [1] is equivalent to Y, [2] is equivalent to Z. [3] is equivalent to W.

Exceptions

ArgumentOutOfRangeException: index is not 0, 1, 2 or 3.

MaxValue

Max vector, a vector with all components equal to MaxValue.

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.

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

UnitW

W-facing unit vector. (0 0 0 1)

public static Vector4I UnitW { get; }

Property Value

Vector4I

UnitX

X-facing unit vector. (1 0 0 0)

public static Vector4I UnitX { get; }

Property Value

Vector4I

UnitY

Y-facing unit vector. (0 1 0 0)

public static Vector4I UnitY { get; }

Property Value

Vector4I

UnitZ

Z-facing unit vector. (0 0 1 0)

public static Vector4I UnitZ { get; }

Property Value

Vector4I

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

Vector4I: A vector with Abs(int) called on each component.

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

min Vector4I: The vector with minimum allowed values.
max Vector4I: The 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

x int
y int
z int
w int

DistanceSquaredTo(Vector4I)

Returns the squared distance between this vector and to. This method runs faster than DistanceTo(Vector4I), so prefer it if you need to compare vectors or need the squared distance for some formula.

public readonly int DistanceSquaredTo(Vector4I to)

Parameters

to Vector4I: The other vector to use.

Returns

int: The squared distance between the two vectors.

DistanceTo(Vector4I)

Returns the distance between this vector and to.

public readonly float DistanceTo(Vector4I to)

Parameters

to Vector4I: The other vector to use.

Returns

float: The distance between the two vectors.

See Also: DistanceSquaredTo(Vector4I)

Equals(Vector4I)

Returns true if the vectors are equal.

public readonly bool Equals(Vector4I other)

Parameters

other Vector4I: The 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

obj object: The 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()

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 Vector4I Sign()

Returns

Vector4I: A vector with all components as either 1, -1, or 0.

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

format string

Returns

string: A string representation of this vector.

Operators

operator +(Vector4I, Vector4I)

Adds each component of the Vector4I with the components of the given Vector4I.

public static Vector4I operator +(Vector4I left, Vector4I right)

Parameters

left Vector4I: The left vector.
right Vector4I: The right vector.

Returns

Vector4I: The added vector.

operator /(Vector4I, Vector4I)

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

public static Vector4I operator /(Vector4I vec, Vector4I divisorv)

Parameters

vec Vector4I: The dividend vector.
divisorv Vector4I: The divisor vector.

Returns

Vector4I: The divided vector.

operator /(Vector4I, int)

Divides each component of the Vector4I by the given int.

public static Vector4I operator /(Vector4I vec, int divisor)

Parameters

vec Vector4I: The dividend vector.
divisor int: The divisor value.

Returns

Vector4I: The divided vector.

operator ==(Vector4I, Vector4I)

Returns true if the vectors are equal.

public static bool operator ==(Vector4I left, Vector4I right)

Parameters

left Vector4I: The left vector.
right Vector4I: The right vector.

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

public static explicit operator Vector4I(Vector4 value)

Parameters

value Vector4: The vector to convert.

Returns

Vector4I

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

left Vector4I: The left vector.
right Vector4I: The right vector.

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

left Vector4I: The left vector.
right Vector4I: The right vector.

Returns

bool: Whether or not the left is greater than or equal to the right.

implicit operator Vector4(Vector4I)

Converts this Vector4I to a Vector4.

public static implicit operator Vector4(Vector4I value)

Parameters

value Vector4I: The vector to convert.

Returns

Vector4

operator !=(Vector4I, Vector4I)

Returns true if the vectors are not equal.

public static bool operator !=(Vector4I left, Vector4I right)

Parameters

left Vector4I: The left vector.
right Vector4I: The right vector.

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

left Vector4I: The left vector.
right Vector4I: The right vector.

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

left Vector4I: The left vector.
right Vector4I: The right vector.

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.

public static Vector4I operator %(Vector4I vec, Vector4I divisorv)

Parameters

vec Vector4I: The dividend vector.
divisorv Vector4I: The divisor vector.

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.

public static Vector4I operator %(Vector4I vec, int divisor)

Parameters

vec Vector4I: The dividend vector.
divisor int: The divisor value.

Returns

Vector4I: The remainder vector.

Examples

GD.Print(new Vector4I(10, -20, 30, -40) % 7); // Prints "(3, -6, 2, -5)"

operator *(Vector4I, Vector4I)

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

public static Vector4I operator *(Vector4I left, Vector4I right)

Parameters

left Vector4I: The left vector.
right Vector4I: The right vector.

Returns

Vector4I: The multiplied vector.

operator *(Vector4I, int)

Multiplies each component of the Vector4I by the given int.

public static Vector4I operator *(Vector4I vec, int scale)

Parameters

vec Vector4I: The vector to multiply.
scale int: The scale to multiply by.

Returns

Vector4I: The multiplied vector.

operator *(int, Vector4I)

Multiplies each component of the Vector4I by the given int.

public static Vector4I operator *(int scale, Vector4I vec)

Parameters

scale int: The scale to multiply by.
vec Vector4I: The vector to multiply.

Returns

Vector4I: The multiplied vector.

operator -(Vector4I, Vector4I)

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

public static Vector4I operator -(Vector4I left, Vector4I right)

Parameters

left Vector4I: The left vector.
right Vector4I: The right vector.

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

vec Vector4I: The vector to negate/flip.

Returns

Vector4I: The negated/flipped vector.