Grid System

Several classes in GoRogue, as an aggregate, act to represent and assist with operations on a grid.

Grid Positions

The Coord class represents a point on a 2D grid. It provides the capability to efficiently storing and retrieving these values, as well as various operators and utility functions to assist with position-related math/operations.

Dealing with Directions

The Direction class provides a convenient representation of "directions" on a grid; up, down, left, right, up_right, etc. It defines the "coordinate plane", provides operators that allow Directions to interact with Coords in convenient ways, and as well offers various utility functions that assist with direction-related math/operations.

Getting Neighbors

GoRogue provides convenient methods to get the neighboring grid locations of a given location, via the AdjacencyRule class. This class also provides methods to get the Direction instances that lead to neighbors.

Line Creation

GoRogue also offers implementations of common grid-based line-drawing/line-creation algorithms, such as Bresenham's, Digital Differential Analyzer line-drawing, and an orthogonal-direction based line drawing algorithm.

Measuring Distance

The Distance class provides a way to represent various possible methods of calculating distance. It provides instances for manhattan, chebyshev, and euclidean distance. Each instance has functions that allow using the represented distance calculation to calculate the distance between two points.

Radius Shapes

The Radius class allows defining a "shape" that constitutes a radius (circle, square, diamond, etc). Radius instances interact with both Distance and AdjacencyRule instances to provide a convenient way to specify shapes for algorithms like FOV.

Representing Rectangles

The Rectangle class provides an efficient way to represent a rectangular portion of a grid. It provides many different ways to create such a rectangle, as well as helpful operations that can prove useful in bounds checking and even map generation.

Retrieving Locations in a Radius

The RadiusAreaProvider class provides a convenient way to all retrieve locations inside a radius of a given size and shape.