SoRasterImageFile.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : C. OGNIER (Jun 2003)
**=======================================================================*/
 
 
#ifndef _SORASTERIMAGEFILE_
#define _SORASTERIMAGEFILE_
 
 
#include <Inventor/image/SoRasterImageIO.h>
#include <Inventor/image/SoRasterImageRW.h>
 
class  SoRasterImageFile : public SoRasterImageIO 
{
  SO_IMAGE_RASTER_RW_HEADER()
 
public:
  SoRasterImageFile();
  
  SoNONUNICODE SoRasterImageFile(const char* fileName);
 
  SoRasterImageFile( const SbString& fileName );
 
  SoRasterImageFile(const FILE* fp);
 
 
  virtual ~SoRasterImageFile();
 
 
  SoNONUNICODE virtual const char* getFileName() const;
 
  virtual SbString getStringFileName() const;
 
  SoNONUNICODE virtual const char* getFullPathFileName() const;
 
  virtual SbString getStringFullPathFileName() const;
 
  SoNONUNICODE virtual void setFileName(const char* fileName);  
  
  virtual void setFileName( const SbString& fileName );  
 
  virtual void setFilePointer(const FILE* fp);
 
  virtual FILE* getFilePointer() const;
 
  virtual SbBool openRead( const SbStringList * directoryList );
 
  virtual SbBool checkRead( const SbStringList * directoryList ); 
 
  virtual SbBool openWrite( void );
 
  virtual void closeFile();
 
  virtual void nullFilePtr();
  
  virtual void setBinary(SbBool isBinary);
 
 
  virtual SbBool isBinary() const;
 
 
  virtual SbString getFileSuffix() const;
 
#if 1             SoDEPRECATED
  virtual SbBool openFile(SoRasterImageRW::OpenMode openMode);
 
#endif
private:
 
  virtual void setFileSuffix( const SbString& suffix);
 
private:
  void constructorCommon();
 
  SbString m_fileName;
  SbString m_fullPath;   // full path, after a successful openRead
  SbString m_fileSuffix;
  FILE*  m_fp;
  SbBool m_isBinary;
  SoRasterImageRW::OpenMode m_openMode;
};
 
#endif