HP/util/HP/include/vtk/vtkKochanekSpline.h

   1 /*=========================================================================
   2
   3   Program:   Visualization Toolkit
   4   Module:    $RCSfile: vtkKochanekSpline.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002/02/01 06:33:18 $
   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 vtkKochanekSpline - computes an interpolating spline using a Kochanek basis.
  42 // .SECTION Description
  43 // Implements the Kochenek interpolating spline described in: Kochanek,
  44 // D., Bartels, R., "Interpolating Splines with Local Tension,
  45 // Continuity, and Bias Control," Computer Graphics, vol. 18, no. 3,
  46 // pp. 33-41, July 1984.
  47 // These splines give the user more control over the shape of the curve
  48 // than the cardinal splines implemented in vtkCardinalSpline. Three
  49 // parameters can be specified. All have a range from -1 to 1.
  50 //
  51 // Tension controls how sharply the curve bends at an input point. A
  52 // value of -1 produices more slack in the curve. A value of 1 tightens
  53 // the curve.
  54 //
  55 // Continuity controls the continuity of the first derivative at input
  56 // points.
  57 //
  58 // Bias controls the direction os the curve at it passes through an input
  59 // point. A value of -1 undershoots the point while a value of 1
  60 // overshoots the point.
  61 //
  62 // These three parameters give the user broad control over the shape of
  63 // the interpolating spline. The original Kochanek paper describes the
  64 // effects nicely and is recommened reading.
  65 // .SECTION See Also
  66 // vtkSpline
  67
  68
  69 #ifndef __vtkKochanekSpline_h
  70 #define __vtkKochanekSpline_h
  71
  72 #include <stdio.h>
  73 #include "vtkSpline.h"
  74
  75 class VTK_EXPORT vtkKochanekSpline : public vtkSpline
  76 {
  77 public:
  78   vtkKochanekSpline();
  79   static vtkKochanekSpline *New() {return new vtkKochanekSpline;};
  80   const char *GetClassName() {return "vtkKochanekSpline";};
  81   void PrintSelf(ostream& os, vtkIndent indent);
  82
  83   void Compute ();
  84
  85   // Description:
  86   // Evaluate a 1D Kochanek spline.
  87   float Evaluate (float t);
  88
  89   // Description:
  90   // Set the bias for all points. Default is 0.
  91   vtkSetMacro(DefaultBias,float);
  92   vtkGetMacro(DefaultBias,float);
  93
  94   // Description:
  95   // Set the tension for all points. Default is 0.
  96   vtkSetMacro(DefaultTension,float);
  97   vtkGetMacro(DefaultTension,float);
  98
  99   // Description:
 100   // Set the continuity for all points. Default is 0.
 101   vtkSetMacro(DefaultContinuity,float);
 102   vtkGetMacro(DefaultContinuity,float);
 103
 104 protected:
 105   void Fit1D (int n, float *x, float *y,
 106               float tension, float bias, float continuity,
 107               float coefficients[][4],
 108               int leftConstraint, float leftValue, int rightConstraint, float rightValue);
 109   float DefaultBias;
 110   float DefaultTension;
 111   float DefaultContinuity;
 112 };
 113
 114 #endif
 115