SGI/util/SGI/include/graphics/vtkFieldDataSource.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkFieldDataSource.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:30:45 $
   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 vtkFieldDataSource - abstract class specifies interface for field source (or objects that generate field output)
  42 // .SECTION Description
  43 // vtkFieldDataSource is an abstract object that specifies behavior and interface
  44 // of field source objects. Field source objects are source objects that create
  45 // vtkFieldData (field data) on output.
  46 //
  47 // Concrete subclasses of vtkFieldDataSource must define Update() and Execute()
  48 // methods. The public method Update() invokes network execution and will
  49 // bring the network up-to-date. The protected Execute() method actually
  50 // does the work of data creation/generation. The difference between the two
  51 // methods is that Update() implements input consistency checks and modified
  52 // time comparisons and then invokes the Execute() which is an implementation
  53 // of a particular algorithm.
  54 //
  55 // vtkFieldDataSource provides a mechanism for invoking the methods StartMethod() and
  56 // EndMethod() before and after object execution (via Execute()). These are
  57 // convenience methods you can use for any purpose (e.g., debugging info,
  58 // highlighting/notifying user interface, etc.) These methods accept a single
  59 // void* pointer that can be used to send data to the methods. It is also
  60 // possible to specify a function to delete the argument via
  61 // StartMethodArgDelete and EndMethodArgDelete.
  62 //
  63 // Another method, ProgressMethod() can be specified. Some filters invoke this
  64 // method periodically during their execution. The use is similar to that of
  65 // StartMethod() and EndMethod().
  66 //
  67 // An important feature of subclasses of vtkFieldDataSource is that it is possible
  68 // to control the memory-management model (i.e., retain output versus delete
  69 // output data). If enabled the ReleaseDataFlag enables the deletion of the
  70 // output data once the downstream process object finishes processing the
  71 // data (please see text).
  72
  73 // .SECTION See Also
  74 // vtkSource vtkFilter vtkFieldDataFilter
  75
  76 #ifndef __vtkFieldDataSource_h
  77 #define __vtkFieldDataSource_h
  78
  79 #include "vtkSource.h"
  80 #include "vtkFieldData.h"
  81
  82 class VTK_EXPORT vtkFieldDataSource : public vtkSource
  83 {
  84 public:
  85   vtkFieldDataSource();
  86   ~vtkFieldDataSource();
  87   static vtkFieldDataSource *New() {return new vtkFieldDataSource;};
  88   const char *GetClassName() {return "vtkFieldDataSource";};
  89   void PrintSelf(ostream& os, vtkIndent indent);
  90
  91   // Description:
  92   // Get the output field of this source.
  93   vtkDataObject *GetOutput() {return this->Output;};
  94
  95 };
  96
  97 #endif
  98