vtkParametricSpline.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkParametricSpline.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkParametricSpline_h
#define vtkParametricSpline_h
 
class vtkSpline;
class vtkPoints;
 
#include "vtkCommonComputationalGeometryModule.h" // For export macro
#include "vtkParametricFunction.h"
 
class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT vtkParametricSpline : public vtkParametricFunction
{
public:
  vtkTypeMacro(vtkParametricSpline, vtkParametricFunction);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkParametricSpline* New();
 
  int GetDimension() override { return 1; }
 
  void Evaluate(double u[3], double Pt[3], double Du[9]) override;
 
  double EvaluateScalar(double u[3], double Pt[3], double Du[9]) override;
 
 
  void SetXSpline(vtkSpline*);
  void SetYSpline(vtkSpline*);
  void SetZSpline(vtkSpline*);
  vtkGetObjectMacro(XSpline, vtkSpline);
  vtkGetObjectMacro(YSpline, vtkSpline);
  vtkGetObjectMacro(ZSpline, vtkSpline);
 
 
  void SetPoints(vtkPoints*);
  vtkGetObjectMacro(Points, vtkPoints);
 
 
  void SetNumberOfPoints(vtkIdType numPts);
  void SetPoint(vtkIdType index, double x, double y, double z);
 
 
  vtkSetMacro(Closed, vtkTypeBool);
  vtkGetMacro(Closed, vtkTypeBool);
  vtkBooleanMacro(Closed, vtkTypeBool);
 
 
  vtkSetMacro(ParameterizeByLength, vtkTypeBool);
  vtkGetMacro(ParameterizeByLength, vtkTypeBool);
  vtkBooleanMacro(ParameterizeByLength, vtkTypeBool);
 
 
  vtkSetClampMacro(LeftConstraint, int, 0, 3);
  vtkGetMacro(LeftConstraint, int);
  vtkSetClampMacro(RightConstraint, int, 0, 3);
  vtkGetMacro(RightConstraint, int);
 
 
  vtkSetMacro(LeftValue, double);
  vtkGetMacro(LeftValue, double);
  vtkSetMacro(RightValue, double);
  vtkGetMacro(RightValue, double);
 
protected:
  vtkParametricSpline();
  ~vtkParametricSpline() override;
 
  // Points definition
  vtkPoints* Points;
 
  // The interpolating splines for each of the x-y-z coordinates
  vtkSpline* XSpline;
  vtkSpline* YSpline;
  vtkSpline* ZSpline;
 
  // Supplemental variables
  vtkTypeBool Closed;
  int LeftConstraint;
  int RightConstraint;
  double LeftValue;
  double RightValue;
  vtkTypeBool ParameterizeByLength;
 
  // Initializing the spline
  vtkMTimeType InitializeTime;
  int Initialize();
 
  // Internal variable for managing parametric coordinates
  double Length;
  double ClosedLength;
 
private:
  vtkParametricSpline(const vtkParametricSpline&) = delete;
  void operator=(const vtkParametricSpline&) = delete;
};
 
#endif