SoPNMImageRW Class Reference
[Image]
Class for encoding and decoding a PNM raster image
More...
#include <Inventor/image/SoPNMImageRW.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoPNMImageRW () | |
| virtual | ~SoPNMImageRW () |
| virtual SbBool | open (SoRasterImageIO *rasterImageIO, OpenMode openMode) |
| virtual SbBool | write (SbRasterImage *rasterImage, unsigned int xPos=0, unsigned int yPos=0) |
| virtual SbBool | read (SbRasterImage *rasterImage, SbBool infoOnly=FALSE) |
| virtual SbBool | isMultipleBufferInverted () const |
| virtual SoRasterImageRW::WriteCapability | getWriteCapability () const |
| virtual SoRasterImageRW::ReadCapability | getReadCapability () const |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Detailed Description
Class for encoding and decoding a PNM raster image
This class is used for encoding and decoding a PNM raster image.
The writeCapability is WRITE_FULL_IMAGE and isMultipleBufferInverted is FALSE.
See SoRasterImageRW for more information and code examples.
SEE ALSO
SoRasterImageFile, SoRasterImageRW, SbRasterImage
- See related examples:
Constructor & Destructor Documentation
| SoPNMImageRW::SoPNMImageRW | ( | ) |
Constructor.
| virtual SoPNMImageRW::~SoPNMImageRW | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| static SoType SoPNMImageRW::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoRasterImageRW.
| virtual SoRasterImageRW::ReadCapability SoPNMImageRW::getReadCapability | ( | ) | const [virtual] |
Returns if the class can read the specific raster format.
Reimplemented from SoRasterImageRW.
| virtual SoType SoPNMImageRW::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoRasterImageRW.
| virtual SoRasterImageRW::WriteCapability SoPNMImageRW::getWriteCapability | ( | ) | const [virtual] |
Returns if the class can write in the specific raster format.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoPNMImageRW::isMultipleBufferInverted | ( | ) | const [virtual] |
Specifies the write way when using multiple buffers.
Returns FALSE if buffers are written from top to bottom. Returns TRUE if buffers are written from bottom to top.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoPNMImageRW::open | ( | SoRasterImageIO * | rasterImageIO, | |
| OpenMode | openMode | |||
| ) | [virtual] |
Opens the reader/writer in the specified open mode.
Returns true if successful.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoPNMImageRW::read | ( | SbRasterImage * | rasterImage, | |
| SbBool | infoOnly = FALSE | |||
| ) | [virtual] |
Reads, decodes, and fills the rasterImage parameter.
If infoOnly is TRUE, then the buffer will not be read, the parameter rasterImage will be set with raster size and raster number of components, the buffer will be NULL.
Implements SoRasterImageRW.
| virtual SbBool SoPNMImageRW::write | ( | SbRasterImage * | rasterImage, | |
| unsigned int | xPos = 0, |
|||
| unsigned int | yPos = 0 | |||
| ) | [virtual] |
Writes and encodes the given data in the specific format.
Returns true if successful. If you are using the multiple writing mode, then you can give the offset with (xPos,yPos) you want to write to.
Implements SoRasterImageRW.
The documentation for this class was generated from the following file:
- Inventor/image/SoPNMImageRW.h