SoBMPImageRW Class Reference

Class for encoding and decoding a BMP raster image More...

#include <Inventor/image/SoBMPImageRW.h>

Inheritance diagram for SoBMPImageRW:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoBMPImageRW ()
	Constructor.
virtual	~SoBMPImageRW ()
	Destructor.
virtual SbBool	open (SoRasterImageIO *rasterImageIO, OpenMode openMode)
	Opens the reader/writer in the specified open mode.
virtual void	close ()
	Closes the reader/writer.
virtual SbBool	write (SbRasterImage *rasterImage, unsigned int xPos=0, unsigned int yPos=0)
	Writes the given data in this specific format.
virtual SbBool	writeFooter ()
	Writes and encodes the footer of this specific format.
virtual SbBool	read (SbRasterImage *rasterImage, SbBool infoOnly=FALSE)
	Reads, decodes, and fills the rasterImage parameter.
virtual SbBool	isMultipleBufferInverted () const
	Returns the write direction when using multiple buffers.
virtual SoRasterImageRW::WriteCapability	getWriteCapability () const
	Returns the write capability of the raster format.
virtual SoRasterImageRW::ReadCapability	getReadCapability () const
	Returns the read capability of the raster format.
Public Member Functions inherited from SoRasterImageRW
virtual	~SoRasterImageRW ()
	Destructor.
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	readRegion (SbRasterImage *rasterImage, const SbBox2i32 &region)
	Read the specified region of current open image into rasterImage.
virtual SbString *	getSuffixes (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

Class for encoding and decoding a BMP raster image

This class is used for encoding and decoding a BMP 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 50 of file SoBMPImageRW.h.

Constructor & Destructor Documentation

SoBMPImageRW()

SoBMPImageRW::SoBMPImageRW

(

)

Constructor.

~SoBMPImageRW()

virtual SoBMPImageRW::~SoBMPImageRW ( )

virtual

Destructor.

Member Function Documentation

close()

virtual void SoBMPImageRW::close ( )

virtual

Closes the reader/writer.

Reimplemented from SoRasterImageRW.

getClassTypeId()

static SoType SoBMPImageRW::getClassTypeId ( )

static

Returns the type identifier for this class.

getReadCapability()

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

virtual

Returns the read capability of the raster format.

Reimplemented from SoRasterImageRW.

getTypeId()

virtual SoType SoBMPImageRW::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoRasterImageRW.

getWriteCapability()

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

virtual

Returns the write capability of the raster format.

Reimplemented from SoRasterImageRW.

isMultipleBufferInverted()

virtual SbBool SoBMPImageRW::isMultipleBufferInverted ( ) const

virtual

Returns 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.

open()

virtual SbBool SoBMPImageRW::open ( SoRasterImageIO *  rasterImageIO, OpenMode  openMode  )

virtual

Opens the reader/writer in the specified open mode.

Reimplemented from SoRasterImageRW.

read()

virtual SbBool SoBMPImageRW::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 SoBMPImageRW::write ( SbRasterImage *  rasterImage, unsigned int  xPos = 0, unsigned int  yPos = 0  )

virtual

Writes the given data in this specific format.

Implements SoRasterImageRW.

writeFooter()

virtual SbBool SoBMPImageRW::writeFooter ( )

virtual

Writes and encodes the footer of this specific format.

Reimplemented from SoRasterImageRW.

---

The documentation for this class was generated from the following file:

• Inventor/image/SoBMPImageRW.h