SGI/util/SGI/include/graphics/vtkImplicitWindowFunction.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkImplicitWindowFunction.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:30:46 $
   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 vtkImplicitWindowFunction - implicit function maps another implicit function to lie within a specified range
  42 // .SECTION Description
  43 // vtkImplicitWindowFunction is used to modify the output of another
  44 // implicit function to lie within a specified "window", or function
  45 // range. This can be used to add "thickness" to cutting or clipping
  46 // functions.
  47 //
  48 // This class works as follows. First, it evaluates the function value of the
  49 // user-specified implicit function. Then, based on the window range specified,
  50 // it maps the function value into the window values specified.
  51 //
  52
  53 // .SECTION See Also
  54 // vtkImplicitFunction
  55
  56 #ifndef __vtkImplicitWindowFunction_h
  57 #define __vtkImplicitWindowFunction_h
  58
  59 #include <math.h>
  60 #include "vtkImplicitFunction.h"
  61
  62 class VTK_EXPORT vtkImplicitWindowFunction : public vtkImplicitFunction
  63 {
  64 public:
  65   vtkImplicitWindowFunction();
  66   ~vtkImplicitWindowFunction();
  67   static vtkImplicitWindowFunction *New() {return new vtkImplicitWindowFunction;};
  68   const char *GetClassName() {return "vtkImplicitWindowFunction";};
  69   void PrintSelf(ostream& os, vtkIndent indent);
  70
  71   // implicit function interface
  72   float EvaluateFunction(float x[3]);
  73   void EvaluateGradient(float x[3], float n[3]);
  74
  75   // Description:
  76   // Specify an implicit function to operate on.
  77   vtkSetObjectMacro(ImplicitFunction,vtkImplicitFunction);
  78   vtkGetObjectMacro(ImplicitFunction,vtkImplicitFunction);
  79
  80   // Description:
  81   // Specify the range of function values which are considered to lie within
  82   // the window. WindowRange[0] is assumed to be less than WindowRange[1].
  83   vtkSetVector2Macro(WindowRange,float);
  84   vtkGetVectorMacro(WindowRange,float,2);
  85
  86   // Description:
  87   // Specify the range of output values that the window range is mapped into. This
  88   // is effectively a scaling and shifting of the original function values.
  89   vtkSetVector2Macro(WindowValues,float);
  90   vtkGetVectorMacro(WindowValues,float,2);
  91
  92   // Override modified time retrieval because of object dependencies.
  93   unsigned long int GetMTime();
  94
  95 protected:
  96   vtkImplicitFunction *ImplicitFunction;
  97   float WindowRange[2];
  98   float WindowValues[2];
  99
 100 };
 101
 102 #endif
 103
 104