Class Vector2i

Inheritance
System.Object
Vector2i
Implements
System.IEquatable<Vector2i>
Namespace: Eco.Shared.Math
Assembly: Eco.Shared.dll
Syntax
[ForceAotHint]
public sealed class Vector2i : ValueType, IEquatable<Vector2i>

Constructors

Vector2i(Int32)

Declaration
public Vector2i(int xy)
Parameters
Type Name Description
System.Int32 xy

Vector2i(Int32, Int32)

Declaration
public Vector2i(int x, int y)
Parameters
Type Name Description
System.Int32 x
System.Int32 y

Fields

Directions

Declaration
public static readonly Vector2i[] Directions
Field Value
Type Description
Vector2i[]

Down

Declaration
public static readonly Vector2i Down
Field Value
Type Description
Vector2i

Left

Declaration
public static readonly Vector2i Left
Field Value
Type Description
Vector2i

MinVal

Declaration
public static readonly Vector2i MinVal
Field Value
Type Description
Vector2i

NegOne

Declaration
public static readonly Vector2i NegOne
Field Value
Type Description
Vector2i

One

Declaration
public static readonly Vector2i One
Field Value
Type Description
Vector2i

Right

Declaration
public static readonly Vector2i Right
Field Value
Type Description
Vector2i

Up

Declaration
public static readonly Vector2i Up
Field Value
Type Description
Vector2i

x

Declaration
public int x
Field Value
Type Description
System.Int32

y

Declaration
public int y
Field Value
Type Description
System.Int32

Zero

Declaration
public static readonly Vector2i Zero
Field Value
Type Description
Vector2i

Properties

Area

Declaration
public int Area { get; }
Property Value
Type Description
System.Int32

Length

Declaration
public float Length { get; }
Property Value
Type Description
System.Single

Magnitude

Declaration
public float Magnitude { get; }
Property Value
Type Description
System.Single

MagnitudeSq

Declaration
public float MagnitudeSq { get; }
Property Value
Type Description
System.Single

NeighborsAdjacent

Declaration
public IEnumerable<Vector2i> NeighborsAdjacent { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

NeighborsDiagonal

Declaration
public IEnumerable<Vector2i> NeighborsDiagonal { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

NeighborsDiagonalAndSelf

Declaration
public IEnumerable<Vector2i> NeighborsDiagonalAndSelf { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

X

Declaration
[JsonIgnore]
public int X { get; set; }
Property Value
Type Description
System.Int32

Y

Declaration
[JsonIgnore]
public int Y { get; set; }
Property Value
Type Description
System.Int32

Methods

Deconstruct(out Int32, out Int32)

Declaration
public void Deconstruct(out int x, out int y)
Parameters
Type Name Description
System.Int32 x
System.Int32 y

Distance(Vector2i)

Declaration
public float Distance(Vector2i pos)
Parameters
Type Name Description
Vector2i pos
Returns
Type Description
System.Single

DistanceSq(Vector2i, Vector2i)

Declaration
public static int DistanceSq(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
System.Int32

Equals(Vector2i)

Declaration
public bool Equals(Vector2i other)
Parameters
Type Name Description
Vector2i other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Max(Vector2i, Vector2i)

Declaration
public static Vector2i Max(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
Vector2i

Min(Vector2i, Vector2i)

Declaration
public static Vector2i Min(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
Vector2i

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Wrap(Vector2i)

Declaration
public Vector2i Wrap(Vector2i wrapSize)
Parameters
Type Name Description
Vector2i wrapSize
Returns
Type Description
Vector2i

Wrap(Int32)

Declaration
public Vector2i Wrap(int wrapSize)
Parameters
Type Name Description
System.Int32 wrapSize
Returns
Type Description
Vector2i

WrappedDistance(Vector2i)

Declaration
public float WrappedDistance(Vector2i pos)
Parameters
Type Name Description
Vector2i pos
Returns
Type Description
System.Single

WrappedDistance(Vector2i, Vector2i)

Declaration
public static float WrappedDistance(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
System.Single

X_Z(Int32)

Declaration
public Vector3i X_Z(int newy = 0)
Parameters
Type Name Description
System.Int32 newy
Returns
Type Description
Vector3i

XY_(Int32)

Declaration
public Vector3i XY_(int newz = 0)
Parameters
Type Name Description
System.Int32 newz
Returns
Type Description
Vector3i

XYIter()

Declaration
public IEnumerable<Vector2i> XYIter()
Returns
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

XYIter(Vector2i, Int32)

Emits all integer two-component vectors with offset in range from 0 to size for each component and with the specified origin.

Declaration
public static IEnumerable<Vector2i> XYIter(Vector2i origin, int size)
Parameters
Type Name Description
Vector2i origin
System.Int32 size
Returns
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

XYIter(Int32)

Iterates all X,Z pairs from 0,0 to size,size (exclusive).

Declaration
public static IEnumerable<Vector2i> XYIter(int size)
Parameters
Type Name Description
System.Int32 size
Returns
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

XYIterInclusive(Int32, Int32)

Declaration
public static IEnumerable<Vector2i> XYIterInclusive(int min, int max)
Parameters
Type Name Description
System.Int32 min
System.Int32 max
Returns
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

XYIterMinMax(Vector2i, Vector2i)

Emits all integer two-component vectors from min (inclusive) to max (exclusive).

Declaration
public static IEnumerable<Vector2i> XYIterMinMax(Vector2i min, Vector2i max)
Parameters
Type Name Description
Vector2i min
Vector2i max
Returns
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

XYIterMinMax(Int32, Int32, Int32, Int32)

Emits all integer two-component vectors from min (inclusive) to max (exclusive).

Declaration
public static IEnumerable<Vector2i> XYIterMinMax(int minX, int minY, int maxX, int maxY)
Parameters
Type Name Description
System.Int32 minX
System.Int32 minY
System.Int32 maxX
System.Int32 maxY
Returns
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

YXIter()

Declaration
public IEnumerable<Vector2i> YXIter()
Returns
Type Description
System.Collections.Generic.IEnumerable<Vector2i>

Operators

Addition(Vector2i, Vector2i)

Declaration
public static Vector2i operator +(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
Vector2i

Addition(Vector2i, Int32)

Declaration
public static Vector2i operator +(Vector2i v, int t)
Parameters
Type Name Description
Vector2i v
System.Int32 t
Returns
Type Description
Vector2i

Division(Vector2i, Vector2i)

Declaration
public static Vector2i operator /(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
Vector2i

Division(Vector2i, Int32)

Declaration
public static Vector2i operator /(Vector2i v, int val)
Parameters
Type Name Description
Vector2i v
System.Int32 val
Returns
Type Description
Vector2i

Equality(Vector2i, Vector2i)

Declaration
public static bool operator ==(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
System.Boolean

GreaterThan(Vector2i, Vector2i)

Declaration
public static bool operator>(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
System.Boolean

Implicit(Vector2i to Vector2)

Declaration
public static implicit operator Vector2(Vector2i v)
Parameters
Type Name Description
Vector2i v
Returns
Type Description
Vector2

Inequality(Vector2i, Vector2i)

Declaration
public static bool operator !=(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
System.Boolean

LessThan(Vector2i, Vector2i)

Declaration
public static bool operator <(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
System.Boolean

Modulus(Vector2i, Vector2i)

Declaration
public static Vector2i operator %(Vector2i v1, Vector2i v2)
Parameters
Type Name Description
Vector2i v1
Vector2i v2
Returns
Type Description
Vector2i

Multiply(Vector2i, Vector2i)

Declaration
public static Vector2i operator *(Vector2i v1, Vector2i v2)
Parameters
Type Name Description
Vector2i v1
Vector2i v2
Returns
Type Description
Vector2i

Multiply(Vector2i, Int32)

Declaration
public static Vector2i operator *(Vector2i v, int t)
Parameters
Type Name Description
Vector2i v
System.Int32 t
Returns
Type Description
Vector2i

Multiply(Vector2i, Single)

Declaration
public static Vector2i operator *(Vector2i v, float val)
Parameters
Type Name Description
Vector2i v
System.Single val
Returns
Type Description
Vector2i

Subtraction(Vector2i, Vector2i)

Declaration
public static Vector2i operator -(Vector2i a, Vector2i b)
Parameters
Type Name Description
Vector2i a
Vector2i b
Returns
Type Description
Vector2i

Subtraction(Vector2i, Int32)

Declaration
public static Vector2i operator -(Vector2i v, int t)
Parameters
Type Name Description
Vector2i v
System.Int32 t
Returns
Type Description
Vector2i

UnaryNegation(Vector2i)

Declaration
public static Vector2i operator -(Vector2i a)
Parameters
Type Name Description
Vector2i a
Returns
Type Description
Vector2i

Implements

System.IEquatable<>

Extension Methods