SoSUNImageRW Class Reference
[Image]
Class for encoding and decoding a SUN raster image
More...
#include <Inventor/image/SoSUNImageRW.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoSUNImageRW () | |
| virtual | ~SoSUNImageRW () |
| 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 SUN raster image
This class is used for encoding and decoding a SUN (.ras) 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
| SoSUNImageRW::SoSUNImageRW | ( | ) |
Constructor.
| virtual SoSUNImageRW::~SoSUNImageRW | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| static SoType SoSUNImageRW::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoRasterImageRW.
| virtual SoRasterImageRW::ReadCapability SoSUNImageRW::getReadCapability | ( | ) | const [virtual] |
Returns the read capability of the raster format.
Reimplemented from SoRasterImageRW.
| virtual SoType SoSUNImageRW::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Implements SoRasterImageRW.
| virtual SoRasterImageRW::WriteCapability SoSUNImageRW::getWriteCapability | ( | ) | const [virtual] |
Returns the write capability of the raster format.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoSUNImageRW::isMultipleBufferInverted | ( | ) | const [virtual] |
Specifies the write direction 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 SoSUNImageRW::open | ( | SoRasterImageIO * | rasterImageIO, | |
| OpenMode | openMode | |||
| ) | [virtual] |
Opens the reader/writer in the specified open mode.
Returns true if successful.
Reimplemented from SoRasterImageRW.
| virtual SbBool SoSUNImageRW::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 SoSUNImageRW::write | ( | SbRasterImage * | rasterImage, | |
| unsigned int | xPos = 0, |
|||
| unsigned int | yPos = 0 | |||
| ) | [virtual] |
Writes and encodes the given data in the specific format.
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/SoSUNImageRW.h