Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## sim.field.grid
Class ObjectGrid2D

    java.lang.Object
      sim.field.grid.AbstractGrid2D
          sim.field.grid.ObjectGrid2D

All Implemented Interfaces:
  java.io.Serializable, Grid2D

    public class ObjectGrid2D

extends AbstractGrid2D

A wrapper for 2D arrays of Objects.

This object expects that the 2D arrays are rectangular. You are encouraged to access the array directly. The object implements all of the Grid2D interface. See Grid2D for rules on how to properly implement toroidal or hexagonal grids.

The width and height of the object are provided to avoid having to say field[x].length, etc.

We very strongly encourage you to examine SparseGrid2D first to see if it's more appropriate to your task. If you need arbitrary numbers of Objects to be able to occupy the same location in the grid, or if you have very few Objects and a very large grid, or if your space is unbounded, you should probably use SparseGrid2D instead.

See Also:
  Serialized Form

Field Summary
`java.lang.Object[][]` | `field`

Fields inherited from class sim.field.grid.AbstractGrid2D
`height, width`

Constructor Summary
`ObjectGrid2D(int width, int height)`
`ObjectGrid2D(int width, int height, java.lang.Object initialValue)`
`ObjectGrid2D(ObjectGrid2D values)`

Method Summary
`Bag` | `clear()` Sets all the locations in the grid to null, and returns in a Bag all stored objects (including duplicates but not null values).
`java.lang.Object` | `get(int x, int y)` Returns the element at location (x,y)
`Bag` | `getNeighborsHamiltonianDistance(int x, int y, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos)` Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= dist.
`Bag` | `getNeighborsHexagonalDistance(int x, int y, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos)` Gets all neighbors located within the hexagon centered at (X,Y) and 2*dist+1 cells from point to opposite point inclusive.
`Bag` | `getNeighborsMaxDistance(int x, int y, int dist, boolean toroidal, Bag result, IntBag xPos, IntBag yPos)` Gets all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y) ) <= dist.
`void` | `set(int x, int y, java.lang.Object val)` Sets location (x,y) to val
`ObjectGrid2D` | `setTo(java.lang.Object thisObj)` Sets all the locations in the grid the provided element
`ObjectGrid2D` | `setTo(ObjectGrid2D values)` Changes the dimensions of the grid to be the same as the one provided, then sets all the locations in the grid to the elements at the quivalent locations in the provided grid.

Methods inherited from class sim.field.grid.AbstractGrid2D
`dlx, dly, downx, downy, drx, dry, getHeight, getNeighborsHamiltonianDistance, getNeighborsHexagonalDistance, getNeighborsMaxDistance, getWidth, stx, sty, trb, trt, tx, ty, ulx, uly, upx, upy, urx, ury`

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

Field Detail

### field

    public java.lang.Object[][] field

Constructor Detail

### ObjectGrid2D

    public ObjectGrid2D(int width,
                        int height)

### ObjectGrid2D

    public ObjectGrid2D(int width,
                        int height,
                        java.lang.Object initialValue)

### ObjectGrid2D

    public ObjectGrid2D(ObjectGrid2D values)

Method Detail

### set

    public final void set(int x,
                          int y,
                          java.lang.Object val)

  Sets location (x,y) to val

### get

    public final java.lang.Object get(int x,
                                      int y)

  Returns the element at location (x,y)

### setTo

    public final ObjectGrid2D setTo(java.lang.Object thisObj)

  Sets all the locations in the grid the provided element

### clear

    public final Bag clear()

  Sets all the locations in the grid to null, and returns in a Bag all stored objects (including duplicates but not null values). You are free to modify the Bag.

### setTo

    public final ObjectGrid2D setTo(ObjectGrid2D values)

  Changes the dimensions of the grid to be the same as the one provided, then sets all the locations in the grid to the elements at the quivalent locations in the provided grid.

### getNeighborsMaxDistance

    public final Bag getNeighborsMaxDistance(int x,
                                             int y,
                                             int dist,
                                             boolean toroidal,
                                             Bag result,
                                             IntBag xPos,
                                             IntBag yPos)

  Gets all neighbors of a location that satisfy max( abs(x-X) , abs(y-Y) ) <= dist. This region forms a square 2*dist+1 cells across, centered at (X,Y). If dist==1, this is equivalent to the so-called "Moore Neighborhood" (the eight neighbors surrounding (X,Y)), plus (X,Y) itself. Places each x and y value of these locations in the provided IntBags xPos and yPos, clearing the bags first. Then places into the result Bag the objects at each of those locations clearning it first. Returns the result Bag (constructing one if null had been passed in). null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.

### getNeighborsHamiltonianDistance

    public final Bag getNeighborsHamiltonianDistance(int x,
                                                     int y,
                                                     int dist,
                                                     boolean toroidal,
                                                     Bag result,
                                                     IntBag xPos,
                                                     IntBag yPos)

  Gets all neighbors of a location that satisfy abs(x-X) + abs(y-Y) <= dist. This region forms a diamond 2*dist+1 cells from point to opposite point inclusive, centered at (X,Y). If dist==1 this is equivalent to the so-called "Von-Neumann Neighborhood" (the four neighbors above, below, left, and right of (X,Y)), plus (X,Y) itself. Places each x and y value of these locations in the provided IntBags xPos and yPos, clearing the bags first. Then places into the result Bag the objects at each of those locations, clearning it first. Returns the result Bag (constructing one if null had been passed in). null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.

### getNeighborsHexagonalDistance

    public final Bag getNeighborsHexagonalDistance(int x,
                                                   int y,
                                                   int dist,
                                                   boolean toroidal,
                                                   Bag result,
                                                   IntBag xPos,
                                                   IntBag yPos)

  Gets all neighbors located within the hexagon centered at (X,Y) and 2*dist+1 cells from point to opposite point inclusive. If dist==1, this is equivalent to the six neighbors immediately surrounding (X,Y), plus (X,Y) itself. Places each x and y value of these locations in the provided IntBags xPos and yPos, clearing the bags first. Then places into the result Bag the objects at each of those locations clearning it first. Returns the result Bag (constructing one if null had been passed in). null may be passed in for the various bags, though it is more efficient to pass in a 'scratch bag' for each one.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD