Source/System/Image/FileIO/OSGTGAImageFileType.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 _OSGTGAIMAGEFILETYPE_H_
  40 #define _OSGTGAIMAGEFILETYPE_H_
  41
  42 #ifdef  __sgi
  43 #pragma  once
  44 #endif
  45
  46 #include "OSGImageFileIODef.h"
  47 #include "OSGImageFileType.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief TGA File Handler. Used to read/write TGA files.
  52     See \ref PageSystemImage for a detailed description.
  53
  54     \ingroup GrpImageFileIOTGA
  55     \ingroup GrpLibOSGImageFileIO
  56  */
  57
  58 class OSG_IMGFILEIO_DLLMAPPING TGAImageFileType : public ImageFileType
  59 {
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     /*---------------------------------------------------------------------*/
  65     /*! \name                   Destructor                                 */
  66     /*! \{                                                                 */
  67
  68     virtual ~TGAImageFileType(void);
  69
  70     /*! \}                                                                 */
  71     /*---------------------------------------------------------------------*/
  72     /*! \name                   Read/Write                                 */
  73     /*! \{                                                                 */
  74
  75     virtual bool read (      Image            *pImage,
  76                              std::istream     &is,
  77                        const std::string      &mimetype);
  78
  79     virtual bool write(const Image            *pImage,
  80                              std::ostream     &os,
  81                        const std::string      &mimetype);
  82
  83     /*! \}                                                                 */
  84     /*=========================  PROTECTED  ===============================*/
  85
  86   protected:
  87
  88     /*---------------------------------------------------------------------*/
  89     /*! \name               Default Constructor                            */
  90     /*! \{                                                                 */
  91
  92     TGAImageFileType(const Char8  *mimeType,
  93                      const Char8  *suffixArray[],
  94                            UInt16  suffixByteCount);
  95
  96     /*! \}                                                                 */
  97     /*---------------------------------------------------------------------*/
  98     /*! \name                     Copy Op                                  */
  99     /*! \{                                                                 */
 100
 101           TGAImageFileType            (const TGAImageFileType &obj);
 102     const TGAImageFileType &operator =(const TGAImageFileType &obj);
 103
 104     /*! \}                                                                 */
 105     /*==========================  PRIVATE  ================================*/
 106
 107   private:
 108
 109     // header struct
 110
 111     /*! \nohierarchy
 112      */
 113
 114     struct TGAHeader
 115     {
 116         UInt8   idLength;
 117         UInt8   colorMapType;
 118         UInt8   imageType;
 119         UInt16  cmapFirst;
 120         UInt16  cmapLength;
 121         UInt8   cmapEntrySize;
 122         UInt16  xOrigin;
 123         UInt16  yOrigin;
 124         UInt16  width;
 125         UInt16  height;
 126         UInt8   depth;
 127         UInt8   descriptor;
 128     };
 129
 130     bool readHeader             (std::istream &is, TGAHeader   &header);
 131     bool readCompressedImageData(std::istream &is, Image       *pImage);
 132
 133     typedef ImageFileType Inherited;
 134
 135     static TGAImageFileType _the;
 136 };
 137
 138 typedef TGAImageFileType *TGAImageFileTypeP;
 139
 140 OSG_END_NAMESPACE
 141
 142 #endif // _OSGTGAIMAGEFILETYPE_H_