ML Reference
|
A ProcessAllPages handler that offers ordered tile delivery on a single input image. More...
#include <mlProcessAllPagesHandler.h>
Public Member Functions | |
OrderedSingleInputProcessAllPagesHandler (int inputIndex=0) | |
void | calculateOutputImageProperties (PagedImage *image) override |
Reimplement this method to specify the virtual output image's data type/size/page extent. More... | |
virtual MLErrorCode | processTile (const SubImage &image)=0 |
Reimplement this method to perform the processing, return ML_RESULT_OK if processing should go on; otherwise, return the appropriate error code. More... | |
virtual SubImageBox | calculateInputSubImageBox (const SubImageBox &outputSubImageBox) |
Reimplement this method to specify the input image box for the input image with index == _inputIndex. More... | |
SubImageBox | calculateInputSubImageBox (int inputIndex, const SubImageBox &outputSubImageBox) override |
Internal method, do not reimplement! More... | |
void | calculateOutputSubImage (SubImage *outputSubImage, SubImage *inputSubImages, UserThreadData *) override |
Internal method, do not reimplement! More... | |
![]() | |
virtual bool | wantsProgressUpdates () |
Returns whether the handler wants to receive progress updates via updateProgress(). More... | |
virtual void | updateProgress (double) |
Called in regular intervals if wantsProgressUpdates() == true. More... | |
void | install (PagedImage *outImg) |
Installs the handler on the PagedImage, which is typically called by the ML Host; do not call it yourself! More... | |
virtual const char * | getName () |
Returns the name of the handler. More... | |
![]() | |
virtual | ~CalculateOutputImageHandler () |
Destructor. More... | |
virtual UserThreadData * | createUserThreadData () |
Creates the thread local user data for a thread. More... | |
Protected Attributes | |
PagedImage * | _image |
A ProcessAllPages handler that offers ordered tile delivery on a single input image.
Definition at line 72 of file mlProcessAllPagesHandler.h.
ml::OrderedSingleInputProcessAllPagesHandler::OrderedSingleInputProcessAllPagesHandler | ( | int | inputIndex = 0 | ) |
|
inlinevirtual |
Reimplement this method to specify the input image box for the input image with index == _inputIndex.
By default, it returns outputSubImageBox.
Definition at line 88 of file mlProcessAllPagesHandler.h.
|
overridevirtual |
Internal method, do not reimplement!
Reimplemented from ml::CalculateOutputImageHandler.
|
overridevirtual |
Reimplement this method to specify the virtual output image's data type/size/page extent.
Make sure to call the base class method at the beginning of your method.
Reimplemented from ml::ProcessAllPagesHandler.
|
overridevirtual |
Internal method, do not reimplement!
Implements ml::CalculateOutputImageHandler.
|
pure virtual |
Reimplement this method to perform the processing, return ML_RESULT_OK if processing should go on; otherwise, return the appropriate error code.
|
protected |
Definition at line 97 of file mlProcessAllPagesHandler.h.