VTK  9.0.1
vtkParametricSpline.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkParametricSpline.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
38 #ifndef vtkParametricSpline_h
39 #define vtkParametricSpline_h
40 
41 class vtkSpline;
42 class vtkPoints;
43 
44 #include "vtkCommonComputationalGeometryModule.h" // For export macro
45 #include "vtkParametricFunction.h"
46 
47 class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT vtkParametricSpline : public vtkParametricFunction
48 {
49 public:
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
59  static vtkParametricSpline* New();
60 
64  int GetDimension() override { return 1; }
65 
70  void Evaluate(double u[3], double Pt[3], double Du[9]) override;
71 
76  double EvaluateScalar(double u[3], double Pt[3], double Du[9]) override;
77 
79 
84  void SetXSpline(vtkSpline*);
85  void SetYSpline(vtkSpline*);
86  void SetZSpline(vtkSpline*);
87  vtkGetObjectMacro(XSpline, vtkSpline);
88  vtkGetObjectMacro(YSpline, vtkSpline);
89  vtkGetObjectMacro(ZSpline, vtkSpline);
91 
93 
99  void SetPoints(vtkPoints*);
100  vtkGetObjectMacro(Points, vtkPoints);
102 
104 
108  void SetNumberOfPoints(vtkIdType numPts);
109  void SetPoint(vtkIdType index, double x, double y, double z);
111 
113 
118  vtkSetMacro(Closed, vtkTypeBool);
119  vtkGetMacro(Closed, vtkTypeBool);
120  vtkBooleanMacro(Closed, vtkTypeBool);
122 
124 
128  vtkSetMacro(ParameterizeByLength, vtkTypeBool);
129  vtkGetMacro(ParameterizeByLength, vtkTypeBool);
130  vtkBooleanMacro(ParameterizeByLength, vtkTypeBool);
132 
134 
150  vtkSetClampMacro(LeftConstraint, int, 0, 3);
151  vtkGetMacro(LeftConstraint, int);
152  vtkSetClampMacro(RightConstraint, int, 0, 3);
153  vtkGetMacro(RightConstraint, int);
155 
157 
161  vtkSetMacro(LeftValue, double);
162  vtkGetMacro(LeftValue, double);
163  vtkSetMacro(RightValue, double);
164  vtkGetMacro(RightValue, double);
166 
167 protected:
169  ~vtkParametricSpline() override;
170 
171  // Points definition
173 
174  // The interpolating splines for each of the x-y-z coordinates
178 
179  // Supplemental variables
183  double LeftValue;
184  double RightValue;
186 
187  // Initializing the spline
189  int Initialize();
190 
191  // Internal variable for managing parametric coordinates
192  double Length;
193  double ClosedLength;
194 
195 private:
196  vtkParametricSpline(const vtkParametricSpline&) = delete;
197  void operator=(const vtkParametricSpline&) = delete;
198 };
199 
200 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkParametricSpline::LeftConstraint
int LeftConstraint
Definition: vtkParametricSpline.h:181
vtkParametricSpline::YSpline
vtkSpline * YSpline
Definition: vtkParametricSpline.h:176
vtkParametricFunction::Evaluate
virtual void Evaluate(double uvw[3], double Pt[3], double Duvw[9])=0
Performs the mapping $f(uvw)->(Pt,Duvw)$f.
vtkParametricFunction::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkParametricSpline::Closed
vtkTypeBool Closed
Definition: vtkParametricSpline.h:180
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkParametricSpline::ClosedLength
double ClosedLength
Definition: vtkParametricSpline.h:193
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkParametricSpline::ZSpline
vtkSpline * ZSpline
Definition: vtkParametricSpline.h:177
vtkParametricSpline::GetDimension
int GetDimension() override
Return the parametric dimension of the class.
Definition: vtkParametricSpline.h:64
vtkParametricSpline::RightValue
double RightValue
Definition: vtkParametricSpline.h:184
vtkParametricSpline
parametric function for 1D interpolating splines
Definition: vtkParametricSpline.h:47
vtkParametricFunction
abstract interface for parametric functions
Definition: vtkParametricFunction.h:62
vtkParametricSpline::LeftValue
double LeftValue
Definition: vtkParametricSpline.h:183
vtkParametricSpline::XSpline
vtkSpline * XSpline
Definition: vtkParametricSpline.h:175
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkParametricSpline::RightConstraint
int RightConstraint
Definition: vtkParametricSpline.h:182
vtkSpline
spline abstract class for interpolating splines
Definition: vtkSpline.h:62
vtkParametricFunction.h
vtkParametricFunction::EvaluateScalar
virtual double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9])=0
Calculate a user defined scalar using one or all of uvw, Pt, Duvw.
vtkParametricSpline::InitializeTime
vtkMTimeType InitializeTime
Definition: vtkParametricSpline.h:188
vtkParametricSpline::ParameterizeByLength
vtkTypeBool ParameterizeByLength
Definition: vtkParametricSpline.h:185
vtkParametricSpline::Length
double Length
Definition: vtkParametricSpline.h:192
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293
vtkParametricSpline::Points
vtkPoints * Points
Definition: vtkParametricSpline.h:172