TileCursor (Groovy Documentation)

geoscript.layer.TileCursor

All Implemented Interfaces and Traits:

java.util.Iterator
```
class TileCursor<T extends Tile>
extends java.lang.Object
implements java.util.Iterator
```
A TileCursor provides an easy way to iterate through Tiles.
Authors:
Jared Erickson

Constructor Summary

Constructors
Constructor and description
`TileCursor (TileLayer layer, long z)` Create a TileCursor that iterates over every Tile in a given zoom level
`TileCursor (TileLayer layer, long z, long minX, long minY, long maxX, long maxY)` Create TileCursor that iterates over every Tile in a given zoom level between the given columns and rows
`TileCursor (TileLayer layer, Bounds b, long z)` Create TileCursor that iterates over every Tile in a given zoom level and within the given Bounds
`TileCursor (TileLayer layer, Bounds b, double resX, double resY)` Create TileCursor that iterates over every Tile within the given Bounds and for the x and y resolutions
`TileCursor (TileLayer layer, Bounds b, int w, int h)` Create TileCursor that iterates over every Tile within the Bounds for the image size
`TileCursor (TileLayer layer, java.awt.Point p, long z, int w, int h)` Create a TileCursor for all Tiles centered on a Point for a given zoom level that fill an image of a certain width and height

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Bounds`	`getBounds()` Get the Bounds of tiles in this TileCursor
	`boolean`	`getEmpty()` Whether the TileCursor is empty or not @return
	`long`	`getHeight()` Get the height or number of rows
	`long`	`getMaxX()` Get the max x or column
	`long`	`getMaxY()` Get the max y or row
	`long`	`getMinX()` Get the min x or column
	`long`	`getMinY()` Get the min y or row
	`long`	`getSize()` Get the number of tiles
	`TileLayer`	`getTileLayer()` Get the TileLayer
	`long`	`getWidth()` Get the width or number of columns
	`long`	`getZ()` Get the zoom level
	`boolean`	`hasNext()` Whether there are Tiles remaining
	`Tile`	`next()` Get the next Tile
	`void`	`remove()` This method is unsupported and throws an UnsupportedOperationException
	`void`	`reset()` Reset and read the Tiles again.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - TileCursor(TileLayer layer, long z)
    
    Create a TileCursor that iterates over every Tile in a given zoom level
    Parameters:
    layer - The TileLayer
    z - The zoom level
  - TileCursor(TileLayer layer, long z, long minX, long minY, long maxX, long maxY)
    
    Create TileCursor that iterates over every Tile in a given zoom level between the given columns and rows
    Parameters:
    layer - The TileLayer
    z - The zoom level
    minX - The min x or column
    minY - The min y or row
    maxX - The max x or column
    maxY - The max y or row
  - TileCursor(TileLayer layer, Bounds b, long z)
    
    Create TileCursor that iterates over every Tile in a given zoom level and within the given Bounds
    Parameters:
    layer - The TileLayer
    b - The Bounds
    z - The zoom level
  - TileCursor(TileLayer layer, Bounds b, double resX, double resY)
    
    Create TileCursor that iterates over every Tile within the given Bounds and for the x and y resolutions
    Parameters:
    layer - The TileLayer
    b - The Bounds
    resX - The x resolution
    resY - The y resolution
  - TileCursor(TileLayer layer, Bounds b, int w, int h)
    
    Create TileCursor that iterates over every Tile within the Bounds for the image size
    Parameters:
    layer - The TileLayer
    b - The Bounds
    w - The image width
    h - The image height
  - TileCursor(TileLayer layer, java.awt.Point p, long z, int w, int h)
    
    Create a TileCursor for all Tiles centered on a Point for a given zoom level that fill an image of a certain width and height
    Parameters:
    layer - The TileLayer
    p - The Point (in the TileLayer's Projection)
    z - The zoom level
    w - The image width
    h - The image height
    Returns:
    A TileCursor
- Method Detail
  - Bounds getBounds()
    
    Get the Bounds of tiles in this TileCursor
    Returns:
    The Bounds
  - boolean getEmpty()
    
    Whether the TileCursor is empty or not @return
  - long getHeight()
    
    Get the height or number of rows
    Returns:
    The height or number of rows
  - long getMaxX()
    
    Get the max x or column
    Returns:
    The max x or column
  - long getMaxY()
    
    Get the max y or row
    Returns:
    The max y or row
  - long getMinX()
    
    Get the min x or column
    Returns:
    The min x or column
  - long getMinY()
    
    Get the min y or row
    Returns:
    The min y or row
  - long getSize()
    
    Get the number of tiles
    Returns:
    The number of tiles
  - TileLayer getTileLayer()
    
    Get the TileLayer
    Returns:
    The TileLayer
  - long getWidth()
    
    Get the width or number of columns
    Returns:
    The width or number of columns
  - long getZ()
    
    Get the zoom level
    Returns:
    The zoom level
  - @java.lang.Override boolean hasNext()
    
    Whether there are Tiles remaining
    Returns:
    Whether there are Tiles remaining
  - @java.lang.Override Tile next()
    
    Get the next Tile
    Returns:
    The next Tile
  - @java.lang.Override void remove()
    
    This method is unsupported and throws an UnsupportedOperationException
  - void reset()
    
    Reset and read the Tiles again.
  - @java.lang.Override java.lang.String toString()

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class TileCursor<T extends Tile>

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

TileCursor(TileLayer layer, long z)

TileCursor(TileLayer layer, long z, long minX, long minY, long maxX, long maxY)

TileCursor(TileLayer layer, Bounds b, long z)

TileCursor(TileLayer layer, Bounds b, double resX, double resY)

TileCursor(TileLayer layer, Bounds b, int w, int h)

TileCursor(TileLayer layer, java.awt.Point p, long z, int w, int h)

Method Detail

Bounds getBounds()

boolean getEmpty()

long getHeight()

long getMaxX()

long getMaxY()

long getMinX()

long getMinY()

long getSize()

TileLayer getTileLayer()

long getWidth()

long getZ()

@java.lang.Override boolean hasNext()

@java.lang.Override Tile next()

@java.lang.Override void remove()

void reset()

@java.lang.Override java.lang.String toString()