HP/util/HP/include/vtk/vtkImager.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkImager.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:33:24 $
   7   Version:   $Revision: 1.1.1.1 $
   8   Thanks:    Thanks to Matt Turek who developed this class.
   9
  10 Copyright (c) 1993-1995 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 vtkImager - Renders into part of a ImageWindow
  42 // .SECTION Description
  43 // vtkImager is the 2D counterpart to vtkRenderer. An Imager renders
  44 // 2D actors into a viewport of a window.
  45
  46 // .SECTION See Also
  47 //  vtkImageWindow vtkViewport
  48
  49
  50 #ifndef __vtkImager_h
  51 #define __vtkImager_h
  52
  53 #include "vtkReferenceCount.h"
  54 #include "vtkActor2DCollection.h"
  55 #include "vtkActor2D.h"
  56 #include "vtkViewport.h"
  57
  58
  59 class vtkImageWindow;
  60
  61 class VTK_EXPORT vtkImager : public vtkViewport
  62 {
  63 public:
  64
  65   vtkImager();
  66   static vtkImager *New() {return new vtkImager;};
  67   const char *GetClassName() {return "vtkImager";};
  68
  69   // Description:
  70   // Renders an imager.  Passes Render message on the
  71   // the imager's actor2D collection.
  72   void Render();
  73
  74   // Description:
  75   // Set/Get the image window that an imager is attached to.
  76   void SetImageWindow (vtkImageWindow* win)
  77   {this->VTKWindow = (vtkWindow*) win;};
  78   vtkImageWindow* GetImageWindow () {return (vtkImageWindow*) this->VTKWindow;};
  79   void SetVTKWindow (vtkWindow* win) {this->VTKWindow = (vtkWindow*) win;};
  80   vtkWindow *GetVTKWindow() {return (vtkWindow*) this->VTKWindow;};
  81
  82   // Description:
  83   // Erase the contents of the imager in the window.
  84   void Erase(){vtkErrorMacro(<<"vtkImager::Erase - Not implemented!");};
  85
  86 protected:
  87
  88
  89 };
  90
  91
  92 #endif
  93
  94
  95
  96