SoRasterImageFile Class Reference
[Image]
Class for raster image file input and output.
More...
#include <Inventor/image/SoRasterImageFile.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoRasterImageFile () | |
| SoNONUNICODE | SoRasterImageFile (const char *fileName) |
| SoRasterImageFile (const SbString &fileName) | |
| SoRasterImageFile (const FILE *fp) | |
| virtual | ~SoRasterImageFile () |
| virtual SoNONUNICODE const char * | getFileName () const |
| virtual SbString | getStringFileName () const |
| virtual SoNONUNICODE const char * | getFullPathFileName () const |
| virtual SbString | getStringFullPathFileName () const |
| virtual SoNONUNICODE void | setFileName (const char *fileName) |
| virtual void | setFileName (const SbString &fileName) |
| virtual void | setFilePointer (const FILE *fp) |
| virtual FILE * | getFilePointer () const |
| virtual SbBool | openRead (const SbStringList *directoryList) |
| virtual SbBool | checkRead (const SbStringList *directoryList) |
| virtual SbBool | openWrite (void) |
| virtual void | closeFile () |
| virtual void | nullFilePtr () |
| virtual void | setBinary (SbBool isBinary) |
| virtual SbBool | isBinary () const |
| virtual SbString | getFileSuffix () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Deprecated | |
|
| |
| virtual SoDEPRECATED SbBool | openFile (SoRasterImageRW::OpenMode openMode) |
Detailed Description
Class for raster image file input and output.
Class for raster image file input and output.
SEE ALSO
SoRasterImageIO, SoRasterImageRW, SbRasterImage
- See related examples:
Constructor & Destructor Documentation
| SoRasterImageFile::SoRasterImageFile | ( | ) |
Constructor.
| SoNONUNICODE SoRasterImageFile::SoRasterImageFile | ( | const char * | fileName | ) |
Constructor that takes a file name.
- Non Unicode List:
- This function should not be used in a Unicode application.
| SoRasterImageFile::SoRasterImageFile | ( | const SbString & | fileName | ) |
Constructor that takes a file name.
| SoRasterImageFile::SoRasterImageFile | ( | const FILE * | fp | ) |
Constructor that takes a file pointer.
| virtual SoRasterImageFile::~SoRasterImageFile | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual SbBool SoRasterImageFile::checkRead | ( | const SbStringList * | directoryList | ) | [virtual] |
Try to access the file for reading.
(See "openRead") Returns TRUE if the file can be opened. The file remains closed.
Note: SbStringList is a list of pointers, not a list of objects, so the destructor for this class does not free the memory associated with the SbString objects. The application is responsible for deleting each object in the list.
| virtual void SoRasterImageFile::closeFile | ( | ) | [virtual] |
Close the file.
| static SoType SoRasterImageFile::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoRasterImageIO.
| virtual SoNONUNICODE const char* SoRasterImageFile::getFileName | ( | ) | const [virtual] |
Returns the file name that was given in the filename constructor.
If the filename constructor was not used, this method returns an empty string. To get the file name as a full path, the methods getFullPathFileName() or getStringFullPathFileName() should be used.
- Non Unicode List:
- This function should not be used in a Unicode application.
| virtual FILE* SoRasterImageFile::getFilePointer | ( | ) | const [virtual] |
Returns the file pointer.
| virtual SbString SoRasterImageFile::getFileSuffix | ( | ) | const [virtual] |
Returns the file suffix.
| virtual SoNONUNICODE const char* SoRasterImageFile::getFullPathFileName | ( | ) | const [virtual] |
Returns the file name as a full path.
If the filename constructor was not used, this method returns an empty string.
This method should be called after openRead() or openWrite(), or else it will return an empty string. To get the file name as it was passed to the constructor, the methods getFileName() or getStringFileName() should be used.
- Non Unicode List:
- This function should not be used in a Unicode application.
| virtual SbString SoRasterImageFile::getStringFileName | ( | ) | const [virtual] |
Returns the file name that was given in the filename constructor.
If the filename constructor was not used, this method returns an empty string. To get the file name as a full path, the methods getFullPathFileName() or getStringFullPathFileName() should be used.
| virtual SbString SoRasterImageFile::getStringFullPathFileName | ( | ) | const [virtual] |
Returns the file name as a full path.
If the filename constructor was not used, this method returns an empty string. This method should be called after openRead() or openWrite(), or else it will return an empty string. To get the file name as it was passed to the constructor, the methods getFileName() or getStringFileName() should be used.
| virtual SoType SoRasterImageFile::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoRasterImageIO.
| virtual SbBool SoRasterImageFile::isBinary | ( | ) | const [virtual] |
Returns the file open binary mode.
| virtual void SoRasterImageFile::nullFilePtr | ( | ) | [virtual] |
Sets the filePointer to NULL for files closed internally such as RGB files.
| virtual SoDEPRECATED SbBool SoRasterImageFile::openFile | ( | SoRasterImageRW::OpenMode | openMode | ) | [virtual] |
Opens the file with the specified open mode.
- Deprecated:
-
Deprecated since Open Inventor 9000
Use openRead() or openWrite() instead.
| virtual SbBool SoRasterImageFile::openRead | ( | const SbStringList * | directoryList | ) | [virtual] |
Opens the file (specified with setFileName) for reading.
It first tries to open the specified filename. If that doesn't work, it tries opening the filename appended to each of the directory paths specified in directoryList . Returns TRUE if successful. Note: directoryList can be NULL.
Note: SbStringList is a list of pointers, not a list of objects, so the destructor for this class does not free the memory associated with the SbString objects. The application is responsible for deleting each object in the list.
| virtual SbBool SoRasterImageFile::openWrite | ( | void | ) | [virtual] |
Open the file (specified with setFileName) for writing.
The filename should be a full path. Returns TRUE if successful.
| virtual void SoRasterImageFile::setBinary | ( | SbBool | isBinary | ) | [virtual] |
Sets the file open binary mode.
| virtual void SoRasterImageFile::setFileName | ( | const SbString & | fileName | ) | [virtual] |
Sets the file name.
| virtual SoNONUNICODE void SoRasterImageFile::setFileName | ( | const char * | fileName | ) | [virtual] |
Sets the file name.
- Non Unicode List:
- This function should not be used in a Unicode application.
| virtual void SoRasterImageFile::setFilePointer | ( | const FILE * | fp | ) | [virtual] |
Sets the file pointer.
The documentation for this class was generated from the following file:
- Inventor/image/SoRasterImageFile.h