Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoPNMImageRW Class Reference

VSG extension Class for encoding and decoding a PNM raster image More...

#include <Inventor/image/SoPNMImageRW.h>

+ Inheritance diagram for SoPNMImageRW:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoPNMImageRW ()
 Constructor.
 
virtual ~SoPNMImageRW ()
 Destructor.
 
virtual SbBool open (SoRasterImageIO *rasterImageIO, OpenMode openMode)
 Opens the reader/writer in the specified open mode.
 
virtual SbBool write (SbRasterImage *rasterImage, unsigned int xPos=0, unsigned int yPos=0)
 Writes and encodes the given data in the specific format.
 
virtual SbBool read (SbRasterImage *rasterImage, SbBool infoOnly=FALSE)
 Reads, decodes, and fills the rasterImage parameter.
 
virtual SbBool isMultipleBufferInverted () const
 Specifies the write way when using multiple buffers.
 
virtual SoRasterImageRW::WriteCapability getWriteCapability () const
 Returns if the class can write in the specific raster format.
 
virtual SoRasterImageRW::ReadCapability getReadCapability () const
 Returns if the class can read the specific raster format.
 
- Public Member Functions inherited from SoRasterImageRW
virtual ~SoRasterImageRW ()
 Destructor.
 
virtual void close ()
 Closes the reader/writer.
 
virtual SbBool checkRead (SoRasterImageFile *imageFile)
 Checks if the specified file can be read.
 
virtual SbBool writeHeader (const SbVec2i32 &size)
 Writes and encodes the header for this specific format.
 
virtual SbBool writeFooter ()
 Writes and encodes the footer for this specific format.
 
virtual SbBool readRegion (SbRasterImage *rasterImage, const SbBox2i32 &region)
 Read the specified region of current open image into rasterImage.
 
virtual SbStringgetSuffixes (int &numSuffixes) const
 Returns the list of file suffixes supported.
 
virtual void enableMultipleWriting (SbBool state)
 Enable writing image with multiple calls to write method.
 
virtual SbBool isMultipleWritingEnabled () const
 Returns TRUE if multiple buffer writing is enabled.
 
virtual SoDEPRECATED SbBool writeHeader (SbVec2i32 &size)
 Writes and encodes the header for this specific format.
 
virtual SoDEPRECATED SbBool writeHeader (SbVec2s &size)
 Writes and encodes the header for this specific format.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoRasterImageRW
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Additional Inherited Members

- Public Types inherited from SoRasterImageRW
enum  WriteCapability {
  WRITE_SCANLINES ,
  WRITE_FULL_IMAGE ,
  WRITE_UNAVAILABLE
}
 Write Capability enumeration values. More...
 
enum  ReadCapability {
  READ_AVAILABLE ,
  READ_UNAVAILABLE
}
 Read Capability enumeration values. More...
 
enum  OpenMode {
  OPEN_READ ,
  OPEN_WRITE
}
 open Mode enumeration values. More...
 

Detailed Description

VSG extension 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

Definition at line 55 of file SoPNMImageRW.h.

Constructor & Destructor Documentation

◆ SoPNMImageRW()

SoPNMImageRW::SoPNMImageRW ( )

Constructor.

◆ ~SoPNMImageRW()

virtual SoPNMImageRW::~SoPNMImageRW ( )
virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoPNMImageRW::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getReadCapability()

virtual SoRasterImageRW::ReadCapability SoPNMImageRW::getReadCapability ( ) const
virtual

Returns if the class can read the specific raster format.

Reimplemented from SoRasterImageRW.

◆ getTypeId()

virtual SoType SoPNMImageRW::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoRasterImageRW.

◆ getWriteCapability()

virtual SoRasterImageRW::WriteCapability SoPNMImageRW::getWriteCapability ( ) const
virtual

Returns if the class can write in the specific raster format.

Reimplemented from SoRasterImageRW.

◆ isMultipleBufferInverted()

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.

◆ open()

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.

◆ read()

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.

◆ write()

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: