SGI/util/SGI/include/graphics/vtkStructuredGridReader.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkStructuredGridReader.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:30:48 $
   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 vtkStructuredGridReader - read vtk structured grid data file
  42 // .SECTION Description
  43 // vtkStructuredGridReader is a source object that reads ASCII or binary
  44 // structured grid data files in vtk format. See text for format details.
  45 // .SECTION Caveats
  46 // Binary files written on one system may not be readable on other systems.
  47
  48 #ifndef __vtkStructuredGridReader_h
  49 #define __vtkStructuredGridReader_h
  50
  51 #include "vtkStructuredGridSource.h"
  52 #include "vtkDataReader.h"
  53
  54 class VTK_EXPORT vtkStructuredGridReader : public vtkStructuredGridSource
  55 {
  56 public:
  57   vtkStructuredGridReader();
  58   static vtkStructuredGridReader *New() {return new vtkStructuredGridReader;};
  59   const char *GetClassName() {return "vtkStructuredGridReader";};
  60   void PrintSelf(ostream& os, vtkIndent indent);
  61
  62   // overload because of vtkDataReader ivar
  63   unsigned long int GetMTime();
  64
  65   void SetFileName(char *name);
  66   char *GetFileName();
  67
  68   // Description:
  69   // Specify the InputString for use when reading from a character array.
  70   void SetInputString(char *in) {this->Reader.SetInputString(in);};
  71   void SetInputString(char *in,int len) {this->Reader.SetInputString(in,len);};
  72   char *GetInputString() { return this->Reader.GetInputString();};
  73
  74   // Description:
  75   // Set/Get reading from an InputString instead of the default, a file.
  76   void SetReadFromInputString(int i) {this->Reader.SetReadFromInputString(i);};
  77   int GetReadFromInputString() {return this->Reader.GetReadFromInputString();};
  78   vtkBooleanMacro(ReadFromInputString,int);
  79
  80   int GetFileType();
  81
  82   void SetScalarsName(char *name);
  83   char *GetScalarsName();
  84
  85   void SetVectorsName(char *name);
  86   char *GetVectorsName();
  87
  88   void SetTensorsName(char *name);
  89   char *GetTensorsName();
  90
  91   void SetNormalsName(char *name);
  92   char *GetNormalsName();
  93
  94   void SetTCoordsName(char *name);
  95   char *GetTCoordsName();
  96
  97   void SetLookupTableName(char *name);
  98   char *GetLookupTableName();
  99
 100   void SetFieldDataName(char *name);
 101   char *GetFieldDataName();
 102
 103 protected:
 104   void Execute();
 105   vtkDataReader Reader;
 106
 107 };
 108
 109 #endif
 110
 111