Grid (sim-math 1.6.0 API)

java.lang.Object
- com.simsilica.mathd.Grid

All Implemented Interfaces:

java.io.Serializable
```
public class Grid
extends java.lang.Object
implements java.io.Serializable
```
Represents a 3D partitioning of space into discrete evenly spaced cells along some fixed integer boundary. The grid spacing may be different along each of the axes but is most often the same along the x,z plane. Using the Grid, raw world space coordinates can be converted to/from grid cell coordinates, cell-relative positions determined, and so on.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Grid(int spacing)` Creates a grid with the same cell size along each coordinate axis.
`Grid(int xSpacing, int zSpacing)` Creates a grid with the specified cell size for the x and z axes and 0 for the y axis, indicating that there is no partitioning in the y axis.
`Grid(int xSpacing, int ySpacing, int zSpacing)` Creates a grid with the specified spacing along the x, y, and z axes.
`Grid(int xSpacing, int ySpacing, int zSpacing, Vec3i gridBits)` Creates a grid with the specified spacing alon the x, y, and z axes using the specified bit sizes for each when doing ID encoding.
`Grid(Vec3i gridSpacing)` Creates a grid with the specified spacing along the x, y, and z axes.
`Grid(Vec3i gridSpacing, Vec3i gridBits)` Creates a grid with the specified spacing alon the x, y, and z axes using the specified bit sizes for each when doing ID encoding.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`cellToId(int xCell, int yCell, int zCell)` Converts the x, y, z cell location into a single composite long value.
`long`	`cellToId(Vec3i cell)` Converts the x, y, z cell location into a single composite long value.
`Vec3i`	`cellToWorld(int xCell, int yCell, int zCell)` Returns the world location of the origin of the specified grid cell location as a Vec3i.
`Vec3d`	`cellToWorld(int xCell, int yCell, int zCell, Vec3d store)` Returns the world location of the origin of the specified grid cell location as a Vec3d, storing it in the specified 'store' argument.
`Vec3i`	`cellToWorld(int xCell, int yCell, int zCell, Vec3i store)` Returns the world location of the origin of the specified grid cell location as a Vec3i, storing it in the specified 'store' argument.
`Vec3i`	`cellToWorld(Vec3i cell)` Returns the world location of the origin of the specified grid cell location as a Vec3i, storing it in the specified 'store' argument.
`Vec3d`	`cellToWorld(Vec3i cell, Vec3d store)` Returns the world location of the origin of the specified grid cell location as a Vec3d, storing it in the specified 'store' argument.
`Vec3i`	`cellToWorld(Vec3i cell, Vec3i store)` Returns the world location of the origin of the specified grid cell location as a Vec3i, storing it in the specified 'store' argument.
`GridCell`	`getContainingCell(double xWorld, double yWorld, double zWorld)` Returns a GridCell object that represents the section of space that contains the specified world location.
`GridCell`	`getContainingCell(Vec3d world)` Returns a GridCell object that represents the section of space that contains the specified world location.
`GridCell`	`getContainingCell(Vec3i world)` Returns a GridCell object that represents the section of space that contains the specified world location.
`int`	`getDimensions()`
`GridCell`	`getGridCell(int xCell, int yCell, int zCell)` Returns a GridCell object the represents the section of space for the specified grid cell coordinate.
`GridCell`	`getGridCell(Vec3i cell)` Returns a GridCell object the represents the section of space for the specified grid cell coordinate.
`Vec3i`	`getIdBits()`
`Vec3i`	`getSpacing()`
`Vec3i`	`idToCell(long id)`
`Vec3i`	`idToCell(long id, Vec3i store)`
`java.lang.String`	`toString()`
`Vec3i`	`worldToCell(double xWorld, double yWorld, double zWorld)` Returns the grid cell coordinate that contains the specified world space coordinate.
`Vec3i`	`worldToCell(double xWorld, double yWorld, double zWorld, Vec3i store)` Returns the grid cell coordinate that contains the specified world space coordinate, storing it in the specified store argument.
`Vec3i`	`worldToCell(Vec3d world)` Returns the grid cell coordinate that contains the specified world space coordinate.
`Vec3i`	`worldToCell(Vec3d world, Vec3i store)` Returns the grid cell coordinate that contains the specified world space coordinate, storing it in the specified store argument.
`long`	`worldToId(double xWorld, double yWorld, double zWorld)` Converts the world location to a cell location and then to a cell ID.
`long`	`worldToId(Vec3d world)` Converts the world location to a cell location and then to a cell ID.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Grid
```
public Grid(int spacing)
```
    Creates a grid with the same cell size along each coordinate axis.
  - Grid
```
public Grid(int xSpacing,
            int zSpacing)
```
    Creates a grid with the specified cell size for the x and z axes and 0 for the y axis, indicating that there is no partitioning in the y axis. ie: it's an essentially 2D grid.
  - Grid
```
public Grid(int xSpacing,
            int ySpacing,
            int zSpacing)
```
    Creates a grid with the specified spacing along the x, y, and z axes.
  - Grid
```
public Grid(int xSpacing,
            int ySpacing,
            int zSpacing,
            Vec3i gridBits)
```
    Creates a grid with the specified spacing alon the x, y, and z axes using the specified bit sizes for each when doing ID encoding.
  - Grid
```
public Grid(Vec3i gridSpacing)
```
    Creates a grid with the specified spacing along the x, y, and z axes.
  - Grid
```
public Grid(Vec3i gridSpacing,
            Vec3i gridBits)
```
    Creates a grid with the specified spacing alon the x, y, and z axes using the specified bit sizes for each when doing ID encoding.
- Method Detail
  - getSpacing
```
public final Vec3i getSpacing()
```
  - getDimensions
```
public final int getDimensions()
```
  - getIdBits
```
public final Vec3i getIdBits()
```
  - getContainingCell
```
public final GridCell getContainingCell(double xWorld,
                                        double yWorld,
                                        double zWorld)
```
    Returns a GridCell object that represents the section of space that contains the specified world location. The Cell object can be used to query additional values about the enclosing subspace such as performing worldToLocal/localToWorld conversions, obtaining the world origin, checking containment, etc.
  - getContainingCell
```
public final GridCell getContainingCell(Vec3d world)
```
    Returns a GridCell object that represents the section of space that contains the specified world location. The Cell object can be used to query additional values about the enclosing subspace such as performing worldToLocal/localToWorld conversions, obtaining the world origin, checking containment, etc.
  - getContainingCell
```
public final GridCell getContainingCell(Vec3i world)
```
    Returns a GridCell object that represents the section of space that contains the specified world location. The Cell object can be used to query additional values about the enclosing subspace such as performing worldToLocal/localToWorld conversions, obtaining the world origin, checking containment, etc.
  - getGridCell
```
public final GridCell getGridCell(Vec3i cell)
```
    Returns a GridCell object the represents the section of space for the specified grid cell coordinate.
  - getGridCell
```
public final GridCell getGridCell(int xCell,
                                  int yCell,
                                  int zCell)
```
    Returns a GridCell object the represents the section of space for the specified grid cell coordinate.
  - worldToCell
```
public final Vec3i worldToCell(double xWorld,
                               double yWorld,
                               double zWorld)
```
    Returns the grid cell coordinate that contains the specified world space coordinate.
  - worldToCell
```
public final Vec3i worldToCell(double xWorld,
                               double yWorld,
                               double zWorld,
                               Vec3i store)
```
    Returns the grid cell coordinate that contains the specified world space coordinate, storing it in the specified store argument. If the store argument is null then one is created.
  - worldToCell
```
public final Vec3i worldToCell(Vec3d world)
```
    Returns the grid cell coordinate that contains the specified world space coordinate.
  - worldToCell
```
public final Vec3i worldToCell(Vec3d world,
                               Vec3i store)
```
    Returns the grid cell coordinate that contains the specified world space coordinate, storing it in the specified store argument. If the store argument is null then one is created.
  - cellToWorld
```
public final Vec3i cellToWorld(int xCell,
                               int yCell,
                               int zCell)
```
    Returns the world location of the origin of the specified grid cell location as a Vec3i.
  - cellToWorld
```
public final Vec3i cellToWorld(int xCell,
                               int yCell,
                               int zCell,
                               Vec3i store)
```
    Returns the world location of the origin of the specified grid cell location as a Vec3i, storing it in the specified 'store' argument. If the store argument is null then one is created.
  - cellToWorld
```
public final Vec3d cellToWorld(int xCell,
                               int yCell,
                               int zCell,
                               Vec3d store)
```
    Returns the world location of the origin of the specified grid cell location as a Vec3d, storing it in the specified 'store' argument. If the store argument is null then one is created.
  - cellToWorld
```
public final Vec3i cellToWorld(Vec3i cell)
```
    Returns the world location of the origin of the specified grid cell location as a Vec3i, storing it in the specified 'store' argument. If the store argument is null then one is created.
  - cellToWorld
```
public final Vec3i cellToWorld(Vec3i cell,
                               Vec3i store)
```
    Returns the world location of the origin of the specified grid cell location as a Vec3i, storing it in the specified 'store' argument. If the store argument is null then one is created.
  - cellToWorld
```
public final Vec3d cellToWorld(Vec3i cell,
                               Vec3d store)
```
    Returns the world location of the origin of the specified grid cell location as a Vec3d, storing it in the specified 'store' argument. If the store argument is null then one is created.
  - worldToId
```
public final long worldToId(Vec3d world)
```
    Converts the world location to a cell location and then to a cell ID. This is the equivalent of using cellToId(worldToCell(worldLoc)).
  - worldToId
```
public final long worldToId(double xWorld,
                            double yWorld,
                            double zWorld)
```
    Converts the world location to a cell location and then to a cell ID. This is the equivalent of using cellToId(worldToCell(worldLoc)) but without the intermediate garbage.
  - cellToId
```
public final long cellToId(Vec3i cell)
```
    Converts the x, y, z cell location into a single composite long value. This is done using masking and bitshifting to pack the individual values together. Any of the axes that are 'flat' or using 0 spacing are skipped giving more overhead to the other dimensions. Even with three dimensions present, that leaves 2^21 bits (represents +/- 2^20) which is over one million cells in each direction (+ and -). That seems pretty reasonable for a grid that is already reducing space into discrete subspaces. And if it's not then calling code should just avoid using composite IDs.
  - cellToId
```
public final long cellToId(int xCell,
                           int yCell,
                           int zCell)
```
    Converts the x, y, z cell location into a single composite long value. This is done using masking and bitshifting to pack the individual values together. Any of the axes that are 'flat' or using 0 spacing are skipped giving more overhead to the other dimensions. Even with three dimensions present, that leaves 2^21 bits (represents +/- 2^20) which is over one million cells in each direction (+ and -). That seems pretty reasonable for a grid that is already reducing space into discrete subspaces. And if it's not then calling code should just avoid using composite IDs.
  - idToCell
```
public final Vec3i idToCell(long id,
                            Vec3i store)
```
  - idToCell
```
public final Vec3i idToCell(long id)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Grid

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Grid

Grid

Grid

Grid

Grid

Grid

Method Detail

getSpacing

getDimensions

getIdBits

getContainingCell

getContainingCell

getContainingCell

getGridCell

getGridCell

worldToCell

worldToCell

worldToCell

worldToCell

cellToWorld

cellToWorld

cellToWorld

cellToWorld

cellToWorld

cellToWorld

worldToId

worldToId

cellToId

cellToId

idToCell

idToCell

toString