Struct: RT.Coordinates.CellWithDistance<TCell>

• Assembly: RT.Coordinates, Version=3.7.0.0, Culture=neutral, PublicKeyToken=null
• Namespace: RT.Coordinates
• Show inherited types...
  Inherits from:

  • System.ValueType
    • object

Summary

Encapsulates a cell and its distance from an origin cell within a structure.

Generic type parameters

TCell

Type of cell (e.g., Square, Hex or Tri).

Remarks

Used in the return value of Structure<TCell>.FindPaths(TCell).

Constructors

CellWithDistance<TCell>(TCell cell, TCell parent, int distance)

Encapsulates a cell and its distance from an origin cell within a structure. (see also remarks)

Instance methods

void	Deconstruct(out TCell parent, out int distance)	Deconstructor.
bool	Equals(object obj) Overrides: object.Equals(object)	Refer to the documentation for object.Equals.
int	GetHashCode() Overrides: object.GetHashCode()	Refer to the documentation for object.GetHashCode.

Instance properties

TCell	Cell	The relevant cell.
int	Distance	The amount of steps required to reach this cell from the origin cell. If this is 0, this cell is the origin cell.
TCell	Parent	The previous cell in the path from the origin cell to this cell. (see also remarks)