SGI/util/SGI/include/imaging/vtkBMPReader.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkBMPReader.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:30:49 $
   7   Version:   $Revision: 1.1.1.1 $
   8
   9
  10 Copyright (c) 1993-1998 Ken Martin, Will Schroeder, Bill Lorensen.
  11
  12 This software is copyrighted by Ken Martin, Will Schroeder and Bill Lorensen.
  13 The following terms apply to all files associated with the software unless
  14 explicitly disclaimed in individual files. This copyright specifically does
  15 not apply to the related textbook "The Visualization Toolkit" ISBN
  16 013199837-4 published by Prentice Hall which is covered by its own copyright.
  17
  18 The authors hereby grant permission to use, copy, and distribute this
  19 software and its documentation for any purpose, provided that existing
  20 copyright notices are retained in all copies and that this notice is included
  21 verbatim in any distributions. Additionally, the authors grant permission to
  22 modify this software and its documentation for any purpose, provided that
  23 such modifications are not distributed without the explicit consent of the
  24 authors and that existing copyright notices are retained in all copies. Some
  25 of the algorithms implemented by this software are patented, observe all
  26 applicable patent law.
  27
  28 IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR
  29 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
  30 OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY DERIVATIVES THEREOF,
  31 EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32
  33 THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
  34 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  35 PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN
  36 "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
  37 MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  38
  39
  40 =========================================================================*/
  41 // .NAME vtkBMPReader - read Windows BMP files
  42 // .SECTION Description
  43 // vtkBMPReader is a source object that reads Windows BMP files.
  44 // This includes indexed and 24bit bitmaps
  45 //
  46 // BMPReader creates structured point datasets. The dimension of the
  47 // dataset depends upon the number of files read. Reading a single file
  48 // results in a 2D image, while reading more than one file results in a
  49 // 3D volume.
  50 //
  51 // To read a volume, files must be of the form "FileName.<number>"
  52 // (e.g., foo.ppm.0, foo.ppm.1, ...). You must also specify the image
  53 // range. This range specifies the beginning and ending files to read (range
  54 // can be any pair of non-negative numbers).
  55 //
  56 // The default behavior is to read a single file. In this case, the form
  57 // of the file is simply "FileName" (e.g., foo.bar, foo.ppm, foo.BMP).
  58
  59 #ifndef __vtkBMPReader_h
  60 #define __vtkBMPReader_h
  61
  62 #include <stdio.h>
  63 #include "vtkImageReader.h"
  64
  65 class VTK_EXPORT vtkBMPReader : public vtkImageReader
  66 {
  67 public:
  68   static vtkBMPReader *New() {return new vtkBMPReader;};
  69   const char *GetClassName() {return "vtkBMPReader";};
  70   vtkBMPReader();
  71   ~vtkBMPReader();
  72
  73   vtkGetMacro(Depth,int);
  74
  75   unsigned char *Colors;
  76   short Depth;
  77
  78 protected:
  79   virtual void ComputeDataIncrements();
  80   virtual void UpdateImageInformation();
  81   virtual void Execute(vtkImageData *out);
  82
  83 };
  84
  85 #endif
  86
  87