Source/System/Image/FileIO/OSGBMPImageFileType.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGBMPIMAGEFILETYPE_H_
  40 #define _OSGBMPIMAGEFILETYPE_H_
  41 #ifdef  __sgi
  42 #pragma  once
  43 #endif
  44
  45 #include "OSGImageFileIODef.h"
  46 #include "OSGImageFileType.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 /*! \brief BMP File Handler. Used to read/write BMP files.
  51     See \ref PageSystemImage for a detailed description.
  52
  53     \ingroup GrpImageFileIOBMP
  54     \ingroup GrpLibOSGImageFileIO
  55 */
  56
  57 class OSG_IMGFILEIO_DLLMAPPING BMPImageFileType : public ImageFileType
  58 {
  59     /*==========================  PUBLIC  =================================*/
  60
  61   public:
  62
  63     /*---------------------------------------------------------------------*/
  64     /*! \name                   Destructor                                 */
  65     /*! \{                                                                 */
  66
  67     virtual ~BMPImageFileType(void);
  68
  69     /*! \}                                                                 */
  70     /*---------------------------------------------------------------------*/
  71     /*! \name                   Read/Write                                 */
  72     /*! \{                                                                 */
  73
  74     virtual bool read          (      Image            *pImage,
  75                                       std::istream     &is,
  76                                 const std::string      &mimetype   );
  77
  78     virtual bool write         (const Image            *pImage,
  79                                       std::ostream     &os,
  80                                 const std::string      &mimetype   );
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name                        Type                                  */
  85     /*! \{                                                                 */
  86
  87     virtual std::string determineMimetypeFromStream(std::istream &is);
  88
  89     /*! \}                                                                 */
  90     /*=========================  PROTECTED  ===============================*/
  91
  92   protected:
  93
  94     /*---------------------------------------------------------------------*/
  95     /*! \name               Default Constructor                            */
  96     /*! \{                                                                 */
  97
  98     BMPImageFileType (const Char8  *mimeType,
  99                       const Char8  *suffixArray[],
 100                             UInt16  suffixByteCount,
 101                             UInt32  flags );
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                      Copy Op                                 */
 106     /*! \{                                                                 */
 107
 108           BMPImageFileType            (const BMPImageFileType &obj);
 109     const BMPImageFileType &operator =(const BMPImageFileType &obj);
 110
 111     /*! \}                                                                 */
 112     /*==========================  PRIVATE  ================================*/
 113
 114   private:
 115
 116     typedef ImageFileType Inherited;
 117
 118     static BMPImageFileType _the;
 119 };
 120
 121 typedef BMPImageFileType *BMPImageFileTypeP;
 122
 123 OSG_END_NAMESPACE
 124
 125 #endif // _OSGBMPIMAGEFILETYPE_H_