SGI/util/SGI/include/graphics/vtkProgrammableSource.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkProgrammableSource.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:30:47 $
   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 vtkProgrammableSource - generate source data via a user-specified function
  42 // .SECTION Description
  43 // vtkProgrammableSource is a source object that is programmable by the
  44 // user. To use this object, you must specify a function that creates the
  45 // output.  It is possible to generate output of any type; it is up to the
  46 // function to properly initialize and define the output. Typically, you use
  47 // one of the methods to get a concrete output type (e.g.,
  48 // GetPolyDataOutput() or GetStructuredPointsOutput()), and then manipulate
  49 // the output in the user-specified function.
  50 //
  51 // Example use of this include writing a function to read a data file or
  52 // interface to another system. (You might want to do this in favor of
  53 // deriving a new class.) Another important use of this class is that it
  54 // allows users of interpreters (e.g., Tcl or Java) the ability to write
  55 // source objects without having to recompile C++ code or generate new
  56 // libraries.
  57 // .SECTION See Also
  58 // vtkProgrammableFilter vtkProgrammablePointDataFilter
  59
  60 #ifndef __vtkProgrammableSource_h
  61 #define __vtkProgrammableSource_h
  62
  63 #include "vtkSource.h"
  64
  65 class vtkPolyData;
  66 class vtkStructuredPoints;
  67 class vtkStructuredGrid;
  68 class vtkUnstructuredGrid;
  69 class vtkRectilinearGrid;
  70
  71 class VTK_EXPORT vtkProgrammableSource : public vtkSource
  72 {
  73 public:
  74   vtkProgrammableSource();
  75   ~vtkProgrammableSource();
  76   static vtkProgrammableSource *New() {return new vtkProgrammableSource;};
  77   const char *GetClassName() {return "vtkProgrammableSource";};
  78   void PrintSelf(ostream& os, vtkIndent indent);
  79
  80   // methods used to define user function
  81   void SetExecuteMethod(void (*f)(void *), void *arg);
  82   void SetExecuteMethodArgDelete(void (*f)(void *));
  83
  84   // methods used to get the output data - user of this source can get
  85   // different output types - the execute method must manipulate the correct
  86   // type.
  87   vtkPolyData *GetPolyDataOutput();
  88   vtkStructuredPoints *GetStructuredPointsOutput();
  89   vtkStructuredGrid *GetStructuredGridOutput();
  90   vtkUnstructuredGrid *GetUnstructuredGridOutput();
  91   vtkRectilinearGrid *GetRectilinearGridOutput();
  92
  93 protected:
  94   void Execute();
  95
  96   void (*ExecuteMethod)(void *); //function to invoke
  97   void (*ExecuteMethodArgDelete)(void *);
  98   void *ExecuteMethodArg;
  99
 100   // objects used to support the retrieval of output
 101   vtkPolyData *PolyData;
 102   vtkStructuredPoints *StructuredPoints;
 103   vtkStructuredGrid *StructuredGrid;
 104   vtkUnstructuredGrid *UnstructuredGrid;
 105   vtkRectilinearGrid *RectilinearGrid;
 106 };
 107
 108 #endif
 109