Interface IGridPoint<TPoint>

Namespace

Gamelogic.Grids

Assembly

Assembly-CSharp.dll

Represents a "point" that is used to access a cell in a Grid.

For built-in 2D grids, these points are often 2D integer vectors, or spliced vectors, and hence they implement additional interfaces such as IVectorPoint, ISplicedPoint, andISplicedVectorPoint.These points supports arithmetic, colorings, and some other geometric operations.

In general, points do not "know" their neighbors.Use the grid methods IGrid<TCell, TPoint>.GetNeighbors and IGrid<TCell, TPoint>.GetAllNeighbors to make queries about a point's neighbors.

GridPoint base classes must be immutable for many of the algorithms to work correctly.In particular, GridPoints are used as keys in dictionaries and sets.

It is also a good idea to overload the == and != operators.

[Version(1, 0, 0)]
public interface IGridPoint<TPoint> : IEquatable<TPoint>, IGridPoint where TPoint : IGridPoint<TPoint>

Type Parameters

TPoint

Inherited Members

IEquatable<TPoint>.Equals(TPoint)

Extension Methods

GridUtils.RenderIndex<TPoint>(TPoint)

ObjectExtensions.ThrowIfNull(object, string)

GridUtils.GetColor(object, int, int, int)

GridUtils.ToGizmoString(object)

Properties

SpliceCount

For spliced grids, this is the number of slices for all points.

For Uniform grids, this is always 1.

int SpliceCount { get; }

Property Value

int

SpliceIndex

For spliced grids, this is the index of the splice.

For Uniform grids, this is always 0.

int SpliceIndex { get; }

Property Value

int

Methods

DistanceFrom(TPoint)

The lattice distance between two points.

Two points should have a distance of 1 if and only if they are neighbors.

int DistanceFrom(TPoint other)

Parameters

other TPoint

Returns

int