javax.media.jai.iterator
Interface RookIter

All Superinterfaces:
RectIter
All Known Subinterfaces:
WritableRookIter

public interface RookIter
extends RectIter

An iterator for traversing a read-only image using arbitrary up-down and left-right moves. This will generally be somewhat slower than a corresponding instance of RectIter, since it must perform bounds checks against the top and left edges of tiles in addition to their bottom and right edges.

The iterator is initialized with a particular rectangle as its bounds, which it is illegal to exceed. This initialization takes place in a factory method and is not a part of the iterator interface itself. Once initialized, the iterator may be reset to its initial state by means of the startLine(), startPixels(), and startBands() methods. As with RectIter, its position may be advanced using the nextLine(), jumpLines(), nextPixel(), jumpPixels(), and nextBand() methods.

In addition, prevLine(), prevPixel(), and prevBand() methods exist to move in the upwards and leftwards directions and to access smaller band indices. The iterator may be set to the far edges of the bounding rectangle by means of the endLines(), endPixels(), and endBands() methods.

The iterator's position may be tested against the bounding rectangle by means of the finishedLines(), finishedPixels(), and finishedBands() methods, as well as the hybrid methods nextLineDone(), prevLineDone(), nextPixelDone(), prevPixelDone(), nextBandDone(), and prevBandDone().

The getSample(), getSampleFloat(), and getSampleDouble() methods are provided to allow read-only access to the source data. The various source bands may also be accessed in random fashion using the variants that accept a band index. The getPixel() methods allow retrieval of all bands simultaneously.

An instance of RookIter may be obtained by means of the RookIterFactory.create() method, which returns an opaque object implementing this interface.

See Also:
RectIter, RookIterFactory

Method Summary
 void endBands()
          Sets the iterator to the last band of the image.
 void endLines()
          Sets the iterator to the last line of its bounding rectangle.
 void endPixels()
          Sets the iterator to the rightmost pixel of its bounding rectangle.
 void prevBand()
          Sets the iterator to the previous band in the image.
 boolean prevBandDone()
          Sets the iterator to the previous band in the image, and returns true if the min band has been exceeded.
 void prevLine()
          Sets the iterator to the previous line of the image.
 boolean prevLineDone()
          Sets the iterator to the previous line in the image, and returns true if the top row of the bounding rectangle has been passed.
 void prevPixel()
          Sets the iterator to the previous pixel in the image (that is, move leftward).
 boolean prevPixelDone()
          Sets the iterator to the previous pixel in the image (that is, move leftward).
 
Methods inherited from interface javax.media.jai.iterator.RectIter
finishedBands, finishedLines, finishedPixels, getPixel, getPixel, getPixel, getSample, getSample, getSampleDouble, getSampleDouble, getSampleFloat, getSampleFloat, jumpLines, jumpPixels, nextBand, nextBandDone, nextLine, nextLineDone, nextPixel, nextPixelDone, startBands, startLines, startPixels
 

Method Detail

prevLine

public void prevLine()
Sets the iterator to the previous line of the image. The pixel and band offsets are unchanged. If the iterator passes the top line of the rectangle, calls to get() methods are not valid.


prevLineDone

public boolean prevLineDone()
Sets the iterator to the previous line in the image, and returns true if the top row of the bounding rectangle has been passed.


endLines

public void endLines()
Sets the iterator to the last line of its bounding rectangle. The pixel and band offsets are unchanged.


prevPixel

public void prevPixel()
Sets the iterator to the previous pixel in the image (that is, move leftward). The line and band offsets are unchanged.


prevPixelDone

public boolean prevPixelDone()
Sets the iterator to the previous pixel in the image (that is, move leftward). Returns true if the left edge of the bounding rectangle has been passed. The line and band offsets are unchanged.


endPixels

public void endPixels()
Sets the iterator to the rightmost pixel of its bounding rectangle. The line and band offsets are unchanged.


prevBand

public void prevBand()
Sets the iterator to the previous band in the image. The pixel column and line are unchanged.


prevBandDone

public boolean prevBandDone()
Sets the iterator to the previous band in the image, and returns true if the min band has been exceeded. The pixel column and line are unchanged.


endBands

public void endBands()
Sets the iterator to the last band of the image. The pixel column and line are unchanged.