IMG_FileFilter Class Reference
#include <IMG_FileFilter.h>
Public Member Functions | |
| IMG_FileFilter (IMG_File *file_to_filter) | |
| virtual | ~IMG_FileFilter () |
| virtual bool | isPassThrough () const |
| virtual int | isTopFirst () const |
| virtual int | isLeftFirst () const |
| If 0, scanlines are right-to-left. Default is 1 (left-to-right). | |
| virtual IMG_File * | getBaseFile () const |
| virtual void | randomReadAccessRequired () |
| void | setFileToFilter (IMG_File *file) |
| virtual void | computeCommonData () |
Protected Member Functions | |
| virtual int | finishFilter () |
| virtual int | readScanline (int scanline, void *data) |
| virtual int | writeScanline (int scanline, const void *data) |
| virtual void | checkpoint () |
| virtual int | closeFile () |
| const IMG_Stat & | getInputStat () const |
| IMG_Stat & | getInputStat () |
| const void * | fetchScanline (int y, const IMG_Plane &pi) |
| bool | writeToScanline (int y, const void *data, const IMG_Plane &pi) |
| void * | fetchWriteScanline (int y, const IMG_Plane &pi) |
| virtual void | getAdditionalInfo (UT_String &text) |
Detailed Description
Definition at line 29 of file IMG_FileFilter.h.
Constructor & Destructor Documentation
| IMG_FileFilter::IMG_FileFilter | ( | IMG_File * | file_to_filter | ) |
| virtual IMG_FileFilter::~IMG_FileFilter | ( | ) | [virtual] |
Member Function Documentation
| virtual void IMG_FileFilter::checkpoint | ( | ) | [protected, virtual] |
When writing an image, the checkpoint() method can be used to checkpoint data (see TIFFCheckpointDirectory() for an example). Generally, this writes the image data currently passed and this results in a usable, partially written file. By default, nothing is done.
Reimplemented from IMG_File.
| virtual int IMG_FileFilter::closeFile | ( | ) | [protected, virtual] |
Implements IMG_File.
| virtual void IMG_FileFilter::computeCommonData | ( | ) | [inline, virtual] |
Reimplemented from IMG_File.
Reimplemented in IMG_FileFilterFlip, IMG_FileFilterLUT, IMG_FileFilterTile, and IMG_FileFilterWindow.
Definition at line 47 of file IMG_FileFilter.h.
| const void* IMG_FileFilter::fetchScanline | ( | int | y, | |
| const IMG_Plane & | pi | |||
| ) | [protected] |
| void* IMG_FileFilter::fetchWriteScanline | ( | int | y, | |
| const IMG_Plane & | pi | |||
| ) | [protected] |
| virtual int IMG_FileFilter::finishFilter | ( | ) | [inline, protected, virtual] |
Definition at line 53 of file IMG_FileFilter.h.
| virtual void IMG_FileFilter::getAdditionalInfo | ( | UT_String & | text | ) | [inline, protected, virtual] |
Get additional image information about the file that is specific to a particular format. Some formats do not have additional information. The information returned is human-readable in 'text'.
Reimplemented from IMG_File.
Definition at line 74 of file IMG_FileFilter.h.
| virtual IMG_File* IMG_FileFilter::getBaseFile | ( | ) | const [inline, virtual] |
| IMG_Stat& IMG_FileFilter::getInputStat | ( | ) | [inline, protected] |
Definition at line 66 of file IMG_FileFilter.h.
| const IMG_Stat& IMG_FileFilter::getInputStat | ( | ) | const [inline, protected] |
Definition at line 65 of file IMG_FileFilter.h.
| virtual int IMG_FileFilter::isLeftFirst | ( | ) | const [inline, virtual] |
If 0, scanlines are right-to-left. Default is 1 (left-to-right).
Reimplemented from IMG_File.
Definition at line 39 of file IMG_FileFilter.h.
| virtual bool IMG_FileFilter::isPassThrough | ( | ) | const [inline, virtual] |
| virtual int IMG_FileFilter::isTopFirst | ( | ) | const [inline, virtual] |
orientation of the current file or format. Some formats support multiple orientations specified in the image files themselves, others simply have a fixed orientation. Call these methods rather than querying the orientation from the format, in case the format supports multiple orientations.
Reimplemented from IMG_File.
Reimplemented in IMG_FileFilterFlip.
Definition at line 38 of file IMG_FileFilter.h.
| virtual void IMG_FileFilter::randomReadAccessRequired | ( | ) | [virtual] |
call this if you won't be reading the scanlines in order, or if you'll be reading all the scanlines for a single plane first.
Reimplemented from IMG_File.
| virtual int IMG_FileFilter::readScanline | ( | int | scanline, | |
| void * | data | |||
| ) | [protected, virtual] |
Implements IMG_File.
| void IMG_FileFilter::setFileToFilter | ( | IMG_File * | file | ) | [inline] |
Definition at line 45 of file IMG_FileFilter.h.
| virtual int IMG_FileFilter::writeScanline | ( | int | scanline, | |
| const void * | data | |||
| ) | [protected, virtual] |
Implements IMG_File.
| bool IMG_FileFilter::writeToScanline | ( | int | y, | |
| const void * | data, | |||
| const IMG_Plane & | pi | |||
| ) | [protected] |
The documentation for this class was generated from the following file:
- IMG/IMG_FileFilter.h
