SoRasterImageRW.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2022 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : C. OGNIER (Jun 2003)
**=======================================================================*/
 
 
 
#ifndef _SORASTERIMAGERW_
#define _SORASTERIMAGERW_
 
#include <Inventor/nodes/SoNode.h>
#include <Inventor/image/SoRasterImageIO.h>
#include <Inventor/image/SbRasterImage.h>
#include <Inventor/errors/SoDebugError.h>
#include <Inventor/image/SoSubRasterImageRW.h>
#include <Inventor/SbPImpl.h>
 
class SoRasterImageFile; // FORWARD
 
SO_PIMPL_BASE_PUBLIC_DECLARATION(SoRasterImageRW);
 
class  SoRasterImageRW 
{
 
  SO_IMAGE_RASTER_RW_ABSTRACT_HEADER()
  SO_PIMPL_BASE_PUBLIC_HEADER(SoRasterImageRW);
 
public:
 
  enum WriteCapability {
    WRITE_SCANLINES,
    WRITE_FULL_IMAGE,
    WRITE_UNAVAILABLE
  };
 
  enum ReadCapability {
    READ_AVAILABLE,
    READ_UNAVAILABLE
  };
 
  enum OpenMode {
    OPEN_READ,
    OPEN_WRITE
  };
 
  virtual ~SoRasterImageRW();
 
  virtual SbBool open(SoRasterImageIO* rasterImageIO, OpenMode openMode);
 
  virtual void close();
 
  virtual SbBool checkRead( SoRasterImageFile* imageFile );
 
 
  virtual SbBool write(SbRasterImage* rasterImage, unsigned int xPos = 0, unsigned int yPos = 0) = 0;
 
  virtual SbBool writeHeader( const SbVec2i32& size );
 
#if 1             SoDEPRECATED
  virtual SbBool writeHeader( SbVec2i32& size );
#endif 
  virtual SbBool writeFooter();
 
 
  virtual SbBool read(SbRasterImage* rasterImage, SbBool infoOnly = FALSE) = 0;
 
 
  virtual SbBool readRegion(SbRasterImage* rasterImage, const SbBox2i32& region);
 
 
  virtual SbString* getSuffixes(int& numSuffixes) const;
 
 
  virtual SbBool isMultipleBufferInverted() const;
 
 
  virtual SoRasterImageRW::WriteCapability getWriteCapability() const;
 
 
  virtual SoRasterImageRW::ReadCapability getReadCapability() const;
 
 
  virtual void enableMultipleWriting(SbBool state);
 
 
  virtual SbBool isMultipleWritingEnabled() const;
 
#if 1             SoDEPRECATED
  virtual SbBool writeHeader(SbVec2s& size);
 
#endif 
private:
 
  virtual SbBool getImagesNumber(size_t& imagesNumber);
 
 
  virtual SbBool read(SbRasterImage* rasterImage, size_t imageIndex, SbBool infoOnly = FALSE);
 
 
  virtual SbBool readRegion(SbRasterImage* rasterImage, size_t imageIndex, const SbBox2i32& region);
 
  virtual SbVec3f getOrigin(const size_t& imageId);
 
  virtual SbVec2f getPixelSize(const size_t& imageId);
 
  virtual float getThickness(const size_t& imageId);
 
  virtual SbVec3f getX(const size_t& imageId);
 
  virtual SbVec3f getY(const size_t& imageId);
 
  virtual SbVec3f getZ(const size_t& imageId);
 
  virtual bool supportsAlpha() const;
 
  static bool write(const SbString& filename, const SbRasterImage& rasterImage);
 
private:
 
  // This method must fill m_suffixes and update m_numSuffixes
  virtual void createSuffixList() = 0;
  SoRasterImageRW();
 
  SoRasterImageIO* m_rasterImageIO;
  SbBool           m_multipleWriting;
  SbVec2i32        m_rasterSize;
  unsigned int     m_multipleWritingNumComponents;
  SbBool           m_firstMultipleImages;
 
  SbString*        m_suffixes;
  int              m_numSuffixes;
};
 
#endif