ML Reference
|
A class that allows to incrementally iterate over all ids of pages have an intersection with a given box on a given PagedImage. More...
#include <mlPageIDIterator.h>
Public Member Functions | |
MLEXPORT | PageIDIterator () |
Default Constructor. | |
MLEXPORT | PageIDIterator (PagedImage &image, const SubImageBox &box) |
Constructor which calls setup() with given parameters. | |
MLEXPORT | ~PageIDIterator () |
Destructor. | |
MLEXPORT void | setup (PagedImage &image, const SubImageBox &box) |
Sets up the iterator from the given image and box . | |
MLint | getNextPageID () |
Returns the next page id, may only be called as often as getNumPages() returns. | |
MLint | getNumPages () const |
Returns the number of pages that are part of the box. |
A class that allows to incrementally iterate over all ids of pages have an intersection with a given box on a given PagedImage.
Definition at line 26 of file mlPageIDIterator.h.
MLEXPORT ml::PageIDIterator::PageIDIterator | ( | ) |
Default Constructor.
MLEXPORT ml::PageIDIterator::PageIDIterator | ( | PagedImage & | image, |
const SubImageBox & | box | ||
) |
Constructor which calls setup() with given parameters.
MLEXPORT ml::PageIDIterator::~PageIDIterator | ( | ) |
Destructor.
MLint ml::PageIDIterator::getNextPageID | ( | ) | [inline] |
Returns the next page id, may only be called as often as getNumPages() returns.
Definition at line 44 of file mlPageIDIterator.h.
MLint ml::PageIDIterator::getNumPages | ( | ) | const [inline] |
Returns the number of pages that are part of the box.
Definition at line 94 of file mlPageIDIterator.h.
MLEXPORT void ml::PageIDIterator::setup | ( | PagedImage & | image, |
const SubImageBox & | box | ||
) |
Sets up the iterator from the given image
and box
.