Struct: RT.Coordinates.Square

Assembly: RT.Coordinates, Version=3.0.0.0, Culture=neutral, PublicKeyToken=null
Namespace: RT.Coordinates
Show inherited types...
Inherits from:
- System.ValueType
  - object
Show implemented interfaces...
Implements:
- System.IEquatable<RT.Coordinates.Square> (directly)
- RT.Coordinates.IHasDirection<RT.Coordinates.Square, RT.Coordinates.Square.Direction> (directly)
- RT.Coordinates.IHasSvgGeometry (directly)
- RT.Coordinates.INeighbor<RT.Coordinates.Square> (directly)
- RT.Coordinates.INeighbor<object> (directly)

Summary

Represents a square cell in a 2D rectilinear grid.

Constructors

Square(int x, int y)

Constructs a Square from an X and Y coordinate.

Instance methods

bool	Equals(Square other) Implements: IEquatable<Square>.Equals(Square)	Compares this cell to another for equality.
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.
int	GetIndex(int width)	Returns the index that this coordinate would have in a rectangle of width width in which the cells are numbered from 0 in reading order.
IEnumerable<Square>	GetNeighbors(bool includeDiagonal = false)	Returns a collection of all of this cell’s neighbors.
bool	InRange(int width, int height, int left = 0, int top = 0)	Tests whether this coordinate is within a given rectangular range.
bool	IsAdjacentTo(Square other, bool includeDiagonal = false)	Determines whether two cells are orthogonally adjacent (not including diagonals).
int	ManhattanDistance(Square other)	Calculates the Manhattan distance between this coordinate and other. This is the number of orthogonal steps required to reach one from the other.
Square	Move(int dx, int dy)	Moves the current cell dx number of spaces to the right and dy number of spaces down.
Square	Move(Square.Direction dir, int amount = 1) Implements: IHasDirection<Square, Square.Direction>.Move(Square.Direction, int)	Moves the current cell a number of spaces in the specified direction.
Square	MoveX(int dx)	Moves the current cell dx number of spaces to the right.
Square	MoveY(int dy)	Moves the current cell dy number of spaces down.
string	ToString() Overrides: object.ToString()	Refer to the documentation for object.ToString.

Static methods

IEnumerable<Square>

Rectangle(int width, int height, int dx = 0, int dy = 0)

Returns a collection of all cells in a grid of the specified size.

Operators

Square	operator+(Square one, Square two)	Addition operator.
bool	operator==(Square one, Square two)	Compares two Square values for equality.
bool	operator!=(Square one, Square two)	Compares two Square values for inequality.
Square	operator-(Square one, Square two)	Subtraction operator.

Instance properties

PointD	Center Implements: IHasSvgGeometry.Center	Returns the center point of this cell.
IEnumerable<Link<Vertex>>	Edges Implements: IHasSvgGeometry.Edges	Refer to the documentation for IHasSvgGeometry.Edges.
IEnumerable<Square>	KnightsMoves	Returns the set of chess knight’s moves from the current cell.
IEnumerable<Square>	Neighbors Implements: INeighbor<Square>.Neighbors	Returns a collection of all of this cell’s orthogonal neighbors (no diagonals).
Vertex[]	Vertices	Returns the vertices along the perimeter of this Square, going clockwise from the top-left.
int	X	Returns the X coordinate of the cell.
int	Y	Returns the Y coordinate of the cell.

Static fields

IEnumerable<Square.Direction>	AllDirections	Provides a collection of all directions.
IEnumerable<Square.Direction>	DiagonalDirections	Provides a collection of all diagonal directions.
IEnumerable<Square.Direction>	OrthogonalDirections	Provides a collection of all orthogonal directions.

Nested types

Direction	Identifies a direction within a 2D rectilinear grid.
Grid	Describes a 2D grid of square cells.
Vertex	Describes a vertex (gridline intersection) in a rectilinear grid (Square.Grid).